97c4bef9e8e81a84e74673d16671da4cf0563a95
3 * $Id: anag.h,v 1.2 2002/08/11 12:58:09 mdw Exp $
5 * External definitions for Anag
7 * (c) 2001 Mark Wooding
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Anag: a simple wordgame helper.
14 * Anag is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * Anag 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 General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with Anag; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 /*----- Revision history --------------------------------------------------*
32 * Revision 1.2 2002/08/11 12:58:09 mdw
33 * Added support for regular expression matching, if supported by the C
36 * Revision 1.1 2001/02/04 17:14:42 mdw
48 /*----- Header files ------------------------------------------------------*/
61 /*----- Data structures ---------------------------------------------------*/
64 int (*func
)(struct node */
*n*/
, const char */
*p*/
, size_t /*sz*/);
73 #define DSTR_INIT { 0, 0, 0 }
75 /*----- Node types --------------------------------------------------------*/
77 extern node
*anagram(const char *const */
*av*/
);
78 extern node
*subgram(const char *const */
*av*/
);
79 extern node
*wildcard(const char *const */
*av*/
);
80 extern node
*trackword(const char *const */
*av*/
);
81 extern node
*regexp(const char *const */
*av*/
);
83 /*----- Error reporting ---------------------------------------------------*/
87 * Arguments: @const char *p@ = pointer to program name
91 * Use: Stores what the program's name is.
94 extern void ego(const char */
*p*/
);
98 * Arguments: @FILE *fp@ = output stream to write on
99 * @const char *p@ = pointer to string to write
101 * Returns: Zero if everything worked, EOF if not.
103 * Use: Writes the string @p@ to the output stream @fp@. Occurrences
104 * of the character `$' in @p@ are replaced by the program name
105 * as reported by @quis@. A `$$' is replaced by a single `$'
109 extern int pquis(FILE */
*fp*/
, const char */
*p*/
);
113 * Arguments: @const char *f@ = a @printf@-style format string
114 * @...@ = other arguments
118 * Use: Reports an error and exits.
121 extern void die(const char */
*f*/
, ...);
123 /*----- Memory allocation -------------------------------------------------*/
125 /* --- @xmalloc@ --- *
127 * Arguments: @size_t sz@ = size of block to allocate
129 * Returns: Pointer to allocated block.
131 * Use: Allocates memory. If there's not enough memory, the
135 extern void *xmalloc(size_t /*sz*/);
137 /* --- @xrealloc@ --- *
139 * Arguments: @void *p@ = a pointer to allocated memory
140 * @size_t sz@ = new size of block wanted
142 * Returns: Pointer to resized block.
144 * Use: Resizes an allocated block. If there's not enough memory,
148 extern void *xrealloc(void */
*p*/
, size_t /*sz*/);
150 /*----- Dynamic string handling -------------------------------------------*/
152 /* --- @dstr_destroy@ --- *
154 * Arguments: @dstr *d@ = pointer to a dynamic string block
158 * Use: Reclaims the space used by a dynamic string.
161 extern void dstr_destroy(dstr */
*d*/
);
163 /* --- @dstr_reset@ --- *
165 * Arguments: @dstr *d@ = pointer to a dynamic string block
169 * Use: Resets a string so that new data gets put at the beginning.
172 extern void dstr_reset(dstr */
*d*/
);
174 /* --- @dstr_ensure@ --- *
176 * Arguments: @dstr *d@ = pointer to a dynamic string block
177 * @size_t sz@ = amount of free space to ensure
181 * Use: Ensures that at least @sz@ bytes are available in the
185 extern void dstr_ensure(dstr */
*d*/
, size_t /*sz*/);
187 /* --- @dstr_putline@ --- *
189 * Arguments: @dstr *d@ = pointer to a dynamic string block
190 * @FILE *fp@ = a stream to read from
192 * Returns: The number of characters read into the buffer, or @EOF@ if
193 * end-of-file was reached before any characters were read.
195 * Use: Appends the next line from the given input stream to the
196 * string. A trailing newline is not added; a trailing null
197 * byte is appended, as for @dstr_putz@.
200 extern int dstr_putline(dstr */
*d*/
, FILE */
*fp*/
);
202 /*----- That's all, folks -------------------------------------------------*/