New multiprecision integer arithmetic suite.

[u/mdw/catacomb] / mptext.h

diff --git a/mptext.h b/mptext.h
new file mode 100644 (file)
index 0000000..667c098
--- /dev/null
+++ b/mptext.h
@@ -0,0 +1,160 @@
+/* -*-c-*-
+ *
+ * $Id: mptext.h,v 1.1 1999/11/17 18:02:16 mdw Exp $
+ *
+ * Textual representation of multiprecision numbers
+ *
+ * (c) 1999 Straylight/Edgeware
+ */
+
+/*----- Licensing notice --------------------------------------------------* 
+ *
+ * This file is part of Catacomb.
+ *
+ * Catacomb is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Library General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ * 
+ * Catacomb is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Library General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Library General Public
+ * License along with Catacomb; if not, write to the Free
+ * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA 02111-1307, USA.
+ */
+
+/*----- Revision history --------------------------------------------------* 
+ *
+ * $Log: mptext.h,v $
+ * Revision 1.1  1999/11/17 18:02:16  mdw
+ * New multiprecision integer arithmetic suite.
+ *
+ */
+
+#ifndef MPTEXT_H
+#define MPTEXT_H
+
+#ifdef __cplusplus
+  extern "C" {
+#endif
+
+/*----- Header files ------------------------------------------------------*/
+
+#ifndef MP_H
+#  include "mp.h"
+#endif
+
+/*----- Data structures ---------------------------------------------------*/
+
+typedef struct mptext_ops {
+  int (*get)(void */*p*/);
+  void (*unget)(int /*ch*/, void */*p*/);
+  int (*put)(char */*s*/, size_t /*len*/, void */*p*/);
+} mptext_ops;
+
+/*----- Functions provided ------------------------------------------------*/
+
+/* --- @mp_read@ --- *
+ *
+ * Arguments:  @mp *m@ = destination multiprecision number
+ *             @int radix@ = base to assume for data (or zero to guess)
+ *             @const mptext_ops *ops@ = pointer to operations block
+ *             @void *p@ = data for the operations block
+ *
+ * Returns:    The integer read, or zero if it didn't work.
+ *
+ * Use:                Reads an integer from some source.  If the @radix@ is
+ *             specified, the number is assumed to be given in that radix,
+ *             with the letters `a' (either upper- or lower-case) upwards
+ *             standing for digits greater than 9.  Otherwise, base 10 is
+ *             assumed unless the number starts with `0' (octal), `0x' (hex)
+ *             or `nnn_' (base `nnn').  An arbitrary amount of whitespace
+ *             before the number is ignored.
+ */
+
+extern mp *mp_read(mp */*m*/, int /*radix*/,
+                  const mptext_ops */*ops*/, void */*p*/);
+
+/* --- @mp_write@ --- *
+ *
+ * Arguments:  @mp *m@ = pointer to a multi-precision integer
+ *             @int radix@ = radix to use when writing the number out
+ *             @const mptext_ops *ops@ = pointer to an operations block
+ *             @void *p@ = data for the operations block
+ *
+ * Returns:    Zero if it worked, nonzero otherwise.
+ *
+ * Use:                Writes a large integer in textual form.
+ */
+
+extern int mp_write(mp */*m*/, int /*radix*/,
+                   const mptext_ops */*ops*/, void */*p*/);
+
+/*----- File I/O ----------------------------------------------------------*/
+
+#include <stdio.h>
+
+/* --- Operations table --- *
+ *
+ * The @mptext_fileops@ expect the pointer argument to be a @FILE *@.
+ */
+
+extern const mptext_ops mptext_fileops;
+
+/* --- Convenience functions --- */
+
+extern mp *mp_readfile(mp */*m*/, FILE */*fp*/, int /*radix*/);
+extern int mp_writefile(mp */*m*/, FILE */*fp*/, int /*radix*/);
+
+/*----- String I/O --------------------------------------------------------*/
+
+/* --- Context format --- */
+
+typedef struct mptext_stringctx {
+  char *buf;
+  char *lim;
+} mptext_stringctx;
+
+/* --- Operations table --- */
+
+extern const mptext_ops mptext_stringops;
+
+/* --- Convenience functions --- */
+
+extern mp *mp_readstring(mp */*m*/, const char */*p*/, char **/*end*/,
+                        int /*radix*/);
+extern int mp_writestring(mp */*m*/, char */*p*/, size_t /*sz*/,
+                         int /*radix*/);
+
+/*----- Dynamic string I/O ------------------------------------------------*/
+
+#include <mLib/dstr.h>
+
+/* --- Context format --- */
+
+typedef struct mptext_dstrctx {
+  dstr *d;
+  size_t i;
+} mptext_dstrctx;
+
+/* --- Operations table --- */
+
+extern const mptext_ops mptext_dstrops;
+
+/* --- Convenience functions --- */
+
+extern mp *mp_readdstr(mp */*m*/, dstr */*d*/, size_t */*off*/,
+                      int /*radix*/);
+extern int mp_writedstr(mp */*m*/, dstr */*d*/, int /*radix*/);
+
+/*----- That's all, folks -------------------------------------------------*/
+
+#ifdef __cplusplus
+  }
+#endif
+
+#endif