ct.c, ct.h: New constant-time operations.
[u/mdw/catacomb] / mptext.h
index db4e591..dade3cf 100644 (file)
--- a/mptext.h
+++ b/mptext.h
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: mptext.h,v 1.5 2000/10/08 12:04:58 mdw Exp $
+ * $Id$
  *
  * Textual representation of multiprecision numbers
  *
  * (c) 1999 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Catacomb.
  *
  * 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.5  2000/10/08 12:04:58  mdw
- * (MP_DOFPRINTFR): cope with null pointers.
- *
- * Revision 1.4  2000/06/17 11:46:58  mdw
- * Convenience macros for producing debugging output containing MP
- * integers.
- *
- * Revision 1.3  1999/12/22 15:56:30  mdw
- * Make the buffer passed to `put' op constant.
- *
- * Revision 1.2  1999/12/10 23:29:48  mdw
- * Change header file guard names.
- *
- * Revision 1.1  1999/11/17 18:02:16  mdw
- * New multiprecision integer arithmetic suite.
- *
- */
-
 #ifndef CATACOMB_MPTEXT_H
 #define CATACOMB_MPTEXT_H
 
@@ -107,6 +86,20 @@ extern mp *mp_read(mp */*m*/, int /*radix*/,
 extern int mp_write(mp */*m*/, int /*radix*/,
                    const mptext_ops */*ops*/, void */*p*/);
 
+/* --- @mptext_len@ --- *
+ *
+ * Arguments:  @mp *x@ = number to work on
+ *             @int r@ = radix the number will be expressed in
+ *
+ * Returns:    The number of digits needed to represent the number in the
+ *             given base.  This will not include space for a leading sign
+ *             (use @MP_NEGP@ to check that, or just add one on for luck);
+ *             neither will it add space for a terminating null.  In general
+ *             the answer will be an overestimate.
+ */
+
+extern size_t mptext_len(mp */*x*/, int /*r*/);
+
 /*----- File I/O ----------------------------------------------------------*/
 
 #include <stdio.h>
@@ -132,7 +125,7 @@ extern int mp_writefile(mp */*m*/, FILE */*fp*/, int /*radix*/);
   fputc('\n', fp);                                                     \
 } while (0)
 
-#define MP_DOFPRINTR(fp, name, m, r)                                   \
+#define MP_DOFPRINTR(fp, name, m, r)                                   \
   MP_DOFPRINTFR(fp, (fp, "%s = ", name), m, r)
 
 #define MP_PRINT(name, m) MP_DOFPRINTR(stdout, name, m, 10)