3 * $Id: mptext.h,v 1.1 1999/11/17 18:02:16 mdw Exp $
5 * Textual representation of multiprecision numbers
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.1 1999/11/17 18:02:16 mdw
34 * New multiprecision integer arithmetic suite.
45 /*----- Header files ------------------------------------------------------*/
51 /*----- Data structures ---------------------------------------------------*/
53 typedef struct mptext_ops
{
54 int (*get
)(void */
*p*/
);
55 void (*unget
)(int /*ch*/, void */
*p*/
);
56 int (*put
)(char */
*s*/
, size_t /*len*/, void */
*p*/
);
59 /*----- Functions provided ------------------------------------------------*/
61 /* --- @mp_read@ --- *
63 * Arguments: @mp *m@ = destination multiprecision number
64 * @int radix@ = base to assume for data (or zero to guess)
65 * @const mptext_ops *ops@ = pointer to operations block
66 * @void *p@ = data for the operations block
68 * Returns: The integer read, or zero if it didn't work.
70 * Use: Reads an integer from some source. If the @radix@ is
71 * specified, the number is assumed to be given in that radix,
72 * with the letters `a' (either upper- or lower-case) upwards
73 * standing for digits greater than 9. Otherwise, base 10 is
74 * assumed unless the number starts with `0' (octal), `0x' (hex)
75 * or `nnn_' (base `nnn'). An arbitrary amount of whitespace
76 * before the number is ignored.
79 extern mp
*mp_read(mp */
*m*/
, int /*radix*/,
80 const mptext_ops */
*ops*/
, void */
*p*/
);
82 /* --- @mp_write@ --- *
84 * Arguments: @mp *m@ = pointer to a multi-precision integer
85 * @int radix@ = radix to use when writing the number out
86 * @const mptext_ops *ops@ = pointer to an operations block
87 * @void *p@ = data for the operations block
89 * Returns: Zero if it worked, nonzero otherwise.
91 * Use: Writes a large integer in textual form.
94 extern int mp_write(mp */
*m*/
, int /*radix*/,
95 const mptext_ops */
*ops*/
, void */
*p*/
);
97 /*----- File I/O ----------------------------------------------------------*/
101 /* --- Operations table --- *
103 * The @mptext_fileops@ expect the pointer argument to be a @FILE *@.
106 extern const mptext_ops mptext_fileops
;
108 /* --- Convenience functions --- */
110 extern mp
*mp_readfile(mp */
*m*/
, FILE */
*fp*/
, int /*radix*/);
111 extern int mp_writefile(mp */
*m*/
, FILE */
*fp*/
, int /*radix*/);
113 /*----- String I/O --------------------------------------------------------*/
115 /* --- Context format --- */
117 typedef struct mptext_stringctx
{
122 /* --- Operations table --- */
124 extern const mptext_ops mptext_stringops
;
126 /* --- Convenience functions --- */
128 extern mp
*mp_readstring(mp */
*m*/
, const char */
*p*/
, char **/
*end*/
,
130 extern int mp_writestring(mp */
*m*/
, char */
*p*/
, size_t /*sz*/,
133 /*----- Dynamic string I/O ------------------------------------------------*/
135 #include <mLib/dstr.h>
137 /* --- Context format --- */
139 typedef struct mptext_dstrctx
{
144 /* --- Operations table --- */
146 extern const mptext_ops mptext_dstrops
;
148 /* --- Convenience functions --- */
150 extern mp
*mp_readdstr(mp */
*m*/
, dstr */
*d*/
, size_t */
*off*/
,
152 extern int mp_writedstr(mp */
*m*/
, dstr */
*d*/
, int /*radix*/);
154 /*----- That's all, folks -------------------------------------------------*/