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.
36 /*----- Header files ------------------------------------------------------*/
49 /*----- Data structures ---------------------------------------------------*/
52 int (*func)(struct node */*n*/, const char */*p*/, size_t /*sz*/);
61 #define DSTR_INIT { 0, 0, 0 }
63 /*----- Node types --------------------------------------------------------*/
65 extern node *anagram(const char *const */*av*/);
66 extern node *subgram(const char *const */*av*/);
67 extern node *wildcard(const char *const */*av*/);
68 extern node *trackword(const char *const */*av*/);
69 extern node *mono(const char *const */*av*/);
70 extern node *regexp(const char *const */*av*/);
71 extern node *pcrenode(const char *const */*av*/);
72 extern node *longest(const char *const */*av*/);
73 extern node *shortest(const char *const */*av*/);
75 /*----- Exit codes --------------------------------------------------------*/
81 /*----- Error reporting ---------------------------------------------------*/
85 * Arguments: @const char *p@ = pointer to program name
89 * Use: Stores what the program's name is.
92 extern void ego(const char */*p*/);
96 * Arguments: @FILE *fp@ = output stream to write on
97 * @const char *p@ = pointer to string to write
99 * Returns: Zero if everything worked, EOF if not.
101 * Use: Writes the string @p@ to the output stream @fp@. Occurrences
102 * of the character `$' in @p@ are replaced by the program name
103 * as reported by @quis@. A `$$' is replaced by a single `$'
107 extern int pquis(FILE */*fp*/, const char */*p*/);
111 * Arguments: @const char *f@ = a @printf@-style format string
112 * @...@ = other arguments
116 * Use: Reports an error and exits.
119 extern void die(const char */*f*/, ...);
121 /*----- Memory allocation -------------------------------------------------*/
123 /* --- @xmalloc@ --- *
125 * Arguments: @size_t sz@ = size of block to allocate
127 * Returns: Pointer to allocated block.
129 * Use: Allocates memory. If there's not enough memory, the
133 extern void *xmalloc(size_t /*sz*/);
135 /* --- @xrealloc@ --- *
137 * Arguments: @void *p@ = a pointer to allocated memory
138 * @size_t sz@ = new size of block wanted
140 * Returns: Pointer to resized block.
142 * Use: Resizes an allocated block. If there's not enough memory,
146 extern void *xrealloc(void */*p*/, size_t /*sz*/);
148 /*----- Dynamic string handling -------------------------------------------*/
150 /* --- @dstr_destroy@ --- *
152 * Arguments: @dstr *d@ = pointer to a dynamic string block
156 * Use: Reclaims the space used by a dynamic string.
159 extern void dstr_destroy(dstr */*d*/);
161 /* --- @dstr_reset@ --- *
163 * Arguments: @dstr *d@ = pointer to a dynamic string block
167 * Use: Resets a string so that new data gets put at the beginning.
170 extern void dstr_reset(dstr */*d*/);
172 /* --- @dstr_ensure@ --- *
174 * Arguments: @dstr *d@ = pointer to a dynamic string block
175 * @size_t sz@ = amount of free space to ensure
179 * Use: Ensures that at least @sz@ bytes are available in the
183 extern void dstr_ensure(dstr */*d*/, size_t /*sz*/);
185 /* --- @dstr_putline@ --- *
187 * Arguments: @dstr *d@ = pointer to a dynamic string block
188 * @FILE *fp@ = a stream to read from
190 * Returns: The number of characters read into the buffer, or @EOF@ if
191 * end-of-file was reached before any characters were read.
193 * Use: Appends the next line from the given input stream to the
194 * string. A trailing newline is not added; a trailing null
195 * byte is appended, as for @dstr_putz@.
198 extern int dstr_putline(dstr */*d*/, FILE */*fp*/);
200 /*----- Infrastructure ----------------------------------------------------*/
202 /* --- @atend_register@ --- *
204 * Arguments: @int (*func)(void *)@ = function to call
205 * @void *p@ = handle to pass to it
209 * Use: Adds a function to the list of things to do at the end of the
210 * program. The function should return nonzero if it produced
214 extern void atend_register(int (*/*func*/)(void */*p*/), void */*p*/);
216 /*----- That's all, folks -------------------------------------------------*/