1 #ifndef HALIBUT_HALIBUT_H
2 #define HALIBUT_HALIBUT_H
10 #define NORETURN __attribute__((__noreturn__))
12 #define NORETURN /* nothing */
22 /* For suppressing unused-parameter warnings */
23 #define IGNORE(x) ( (x) = (x) )
30 typedef struct input_Tag input
;
31 typedef struct filepos_Tag filepos
;
32 typedef struct paragraph_Tag paragraph
;
33 typedef struct word_Tag word
;
34 typedef struct keywordlist_Tag keywordlist
;
35 typedef struct keyword_Tag keyword
;
36 typedef struct userstyle_Tag userstyle
;
37 typedef struct numberstate_Tag numberstate
;
38 typedef struct indexdata_Tag indexdata
;
39 typedef struct indextag_Tag indextag
;
40 typedef struct indexentry_Tag indexentry
;
41 typedef struct macrostack_Tag macrostack
;
44 * Data structure to hold a file name and index, a line and a
45 * column number, for reporting errors
53 * Data structure to hold all the file names etc for input
55 typedef struct pushback_Tag
{
60 char **filenames
; /* complete list of input files */
61 int nfiles
; /* how many in the list */
62 FILE *currfp
; /* the currently open one */
63 int currindex
; /* which one is that in the list */
64 pushback
*pushback
; /* pushed-back input characters */
65 int npushback
, pushbacksize
;
67 int reportcols
; /* report column numbers in errors */
68 macrostack
*stack
; /* macro expansions in force */
72 * Data structure to hold the input form of the source, ie a linked
75 struct paragraph_Tag
{
78 wchar_t *keyword
; /* for most special paragraphs */
79 word
*words
; /* list of words in paragraph */
80 int aux
; /* number, in a numbered paragraph
83 word
*kwtext
; /* chapter/section indication */
84 word
*kwtext2
; /* numeric-only form of kwtext */
87 paragraph
*parent
, *child
, *sibling
; /* for hierarchy navigation */
89 void *private_data
; /* for temp use in backends */
92 para_IM
, /* index merge */
93 para_BR
, /* bibliography rewrite */
94 para_Rule
, /* random horizontal rule */
97 para_UnnumberedChapter
,
101 para_Biblio
, /* causes no output unless turned ... */
102 para_BiblioCited
, /* ... into this paragraph type */
112 para_Config
, /* configuration directive */
113 para_LcontPush
, /* begin continuation of list item */
114 para_LcontPop
, /* end continuation of list item */
115 para_QuotePush
, /* begin block quote */
116 para_QuotePop
, /* end block quote */
117 para_NotParaType
/* placeholder value */
121 * Data structure to hold an individual word
127 int breaks
; /* can a line break after it? */
131 void *private_data
; /* for temp use in backends */
134 /* ORDERING CONSTRAINT: these normal-word types ... */
137 word_Code
, /* monospaced; `quoted' in text */
138 word_WeakCode
, /* monospaced, normal in text */
139 /* ... must be in the same order as these space types ... */
140 word_WhiteSpace
, /* text is NULL or ignorable */
141 word_EmphSpace
, /* WhiteSpace when emphasised */
142 word_CodeSpace
, /* WhiteSpace when code */
143 word_WkCodeSpace
, /* WhiteSpace when weak code */
144 /* ... and must be in the same order as these quote types ... */
145 word_Quote
, /* text is NULL or ignorable */
146 word_EmphQuote
, /* Quote when emphasised */
147 word_CodeQuote
, /* (can't happen) */
148 word_WkCodeQuote
, /* (can't happen) */
149 /* END ORDERING CONSTRAINT */
150 word_internal_endattrs
,
151 word_UpperXref
, /* \K */
152 word_LowerXref
, /* \k */
153 word_XrefEnd
, /* (invisible; no text) */
154 word_IndexRef
, /* (always an invisible one) */
155 word_HyperLink
, /* (invisible) */
156 word_HyperEnd
/* (also invisible; no text) */
158 /* aux values for attributed words */
160 attr_Only
= 0x0000, /* a lone word with the attribute */
161 attr_First
= 0x0001, /* the first of a series */
162 attr_Last
= 0x0002, /* the last of a series */
163 attr_Always
= 0x0003, /* any other part of a series */
166 /* aux values for quote-type words */
169 quote_Close
= 0x0020,
172 #define isattr(x) ( ( (x) > word_Normal && (x) < word_WhiteSpace ) || \
173 ( (x) > word_WhiteSpace && (x) < word_internal_endattrs ) )
174 #define sameattr(x,y) ( (((x)-(y)) & 3) == 0 )
175 #define towordstyle(x) ( word_Normal + ((x) & 3) )
176 #define tospacestyle(x) ( word_WhiteSpace + ((x) & 3) )
177 #define toquotestyle(x) ( word_Quote + ((x) & 3) )
178 #define removeattr(x) ( word_Normal + ((x) &~ 3) )
180 #define attraux(x) ( (x) & attr_mask )
181 #define quoteaux(x) ( (x) & quote_mask )
186 void fatal(int code
, ...) NORETURN
;
187 void error(int code
, ...);
189 err_nomemory
, /* out of memory */
190 err_optnoarg
, /* option `-%s' requires an argument */
191 err_nosuchopt
, /* unrecognised option `-%s' */
192 err_noinput
, /* no input files */
193 err_cantopen
, /* unable to open input file `%s' */
194 err_nodata
, /* no data in input files */
195 err_brokencodepara
, /* line in codepara didn't begin `\c' */
196 err_kwunclosed
, /* expected `}' after keyword */
197 err_kwillegal
, /* paragraph type expects no keyword */
198 err_kwexpected
, /* paragraph type expects a keyword */
199 err_kwtoomany
, /* paragraph type expects only 1 */
200 err_bodyillegal
, /* paragraph type expects only kws! */
201 err_badparatype
, /* invalid command at start of para */
202 err_badmidcmd
, /* invalid command in mid-para */
203 err_unexbrace
, /* unexpected brace */
204 err_explbr
, /* expected `{' after command */
205 err_commenteof
, /* EOF inside braced comment */
206 err_kwexprbr
, /* expected `}' after cross-ref */
207 err_missingrbrace
, /* unclosed braces at end of para */
208 err_missingrbrace2
, /* unclosed braces at end of file */
209 err_nestedstyles
, /* unable to nest text styles */
210 err_nestedindex
, /* unable to nest `\i' thingys */
211 err_nosuchkw
, /* unresolved cross-reference */
212 err_multiBR
, /* multiple \BRs on same keyword */
213 err_nosuchidxtag
, /* \IM on unknown index tag (warning) */
214 err_cantopenw
, /* can't open output file for write */
215 err_macroexists
, /* this macro already exists */
216 err_sectjump
, /* jump a heading level, eg \C -> \S */
217 err_winhelp_ctxclash
, /* WinHelp context ID hash clash */
218 err_multikw
, /* keyword clash in sections */
219 err_misplacedlcont
, /* \lcont not after a list item */
220 err_sectmarkerinblock
, /* section marker appeared in block */
221 err_infodirentry
, /* \cfg{info-dir-entry} missing param */
222 err_whatever
/* random error of another type */
229 void *smalloc(char *file
, int line
, int size
);
230 void *srealloc(char *file
, int line
, void *p
, int size
);
231 void sfree(char *file
, int line
, void *p
);
232 #define smalloc(x) smalloc(__FILE__, __LINE__, x)
233 #define srealloc(x, y) srealloc(__FILE__, __LINE__, x, y)
234 #define sfree(x) sfree(__FILE__, __LINE__, x)
236 void *smalloc(int size
);
237 void *srealloc(void *p
, int size
);
240 void free_word_list(word
*w
);
241 void free_para_list(paragraph
*p
);
242 word
*dup_word_list(word
*w
);
243 char *dupstr(char *s
);
245 #define mknew(type) ( (type *) smalloc (sizeof (type)) )
246 #define mknewa(type, number) ( (type *) smalloc ((number) * sizeof (type)) )
247 #define resize(array, len) ( srealloc ((array), (len) * sizeof (*(array))) )
248 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
253 wchar_t *ustrdup(wchar_t *s
);
254 char *ustrtoa(wchar_t *s
, char *outbuf
, int size
);
255 wchar_t *ustrfroma(char *s
, wchar_t *outbuf
, int size
);
256 char *utoa_dup(wchar_t *s
);
257 wchar_t *ufroma_dup(char *s
);
258 int ustrlen(wchar_t const *s
);
259 wchar_t *uadv(wchar_t *s
);
260 wchar_t *ustrcpy(wchar_t *dest
, wchar_t const *source
);
261 wchar_t utolower(wchar_t);
262 int uisalpha(wchar_t);
263 int ustrcmp(wchar_t *lhs
, wchar_t *rhs
);
264 int ustricmp(wchar_t *lhs
, wchar_t *rhs
);
267 int uisdigit(wchar_t);
268 wchar_t *ustrlow(wchar_t *s
);
269 wchar_t *ustrftime(wchar_t *fmt
, struct tm
*timespec
);
276 void showversion(void);
286 const char *const version
;
291 typedef struct stackTag
*stack
;
293 void stk_free(stack
);
294 void stk_push(stack
, void *);
295 void *stk_pop(stack
);
296 void *stk_top(stack
);
298 typedef struct tagRdstring rdstring
;
303 typedef struct tagRdstringc rdstringc
;
304 struct tagRdstringc
{
308 extern const rdstring empty_rdstring
;
309 extern const rdstringc empty_rdstringc
;
310 void rdadd(rdstring
*rs
, wchar_t c
);
311 void rdadds(rdstring
*rs
, wchar_t const *p
);
312 wchar_t *rdtrim(rdstring
*rs
);
313 void rdaddc(rdstringc
*rs
, char c
);
314 void rdaddsc(rdstringc
*rs
, char const *p
);
315 char *rdtrimc(rdstringc
*rs
);
317 int compare_wordlists(word
*a
, word
*b
);
319 void mark_attr_ends(paragraph
*sourceform
);
321 typedef struct tagWrappedLine wrappedline
;
322 struct tagWrappedLine
{
324 word
*begin
, *end
; /* first & last words of line */
325 int nspaces
; /* number of whitespaces in line */
326 int shortfall
; /* how much shorter than max width */
328 wrappedline
*wrap_para(word
*, int, int, int (*)(word
*));
329 void wrap_free(wrappedline
*);
334 paragraph
*read_input(input
*in
, indexdata
*idx
);
339 struct keywordlist_Tag
{
342 tree234
*keys
; /* sorted by `key' field */
343 word
**looseends
; /* non-keyword list element numbers */
348 wchar_t *key
; /* the keyword itself */
349 word
*text
; /* "Chapter 2", "Appendix Q"... */
350 /* (NB: filepos are not set) */
351 paragraph
*para
; /* the paragraph referenced */
353 keyword
*kw_lookup(keywordlist
*, wchar_t *);
354 keywordlist
*get_keywords(paragraph
*);
355 void free_keywords(keywordlist
*);
356 void subst_keywords(paragraph
*, keywordlist
*);
363 * Data structure to hold both sides of the index.
365 struct indexdata_Tag
{
366 tree234
*tags
; /* holds type `indextag' */
367 tree234
*entries
; /* holds type `indexentry' */
371 * Data structure to hold an index tag (LHS of index).
373 struct indextag_Tag
{
376 word
**explicit_texts
;
377 int nexplicit
, explicit_size
;
379 indexentry
**refs
; /* array of entries referenced by tag */
383 * Data structure to hold an index entry (RHS of index).
385 struct indexentry_Tag
{
387 void *backend_data
; /* private to back end */
390 indexdata
*make_index(void);
391 void cleanup_index(indexdata
*);
392 /* index_merge takes responsibility for freeing arg 3 iff implicit; never
393 * takes responsibility for arg 2 */
394 void index_merge(indexdata
*, int is_explicit
, wchar_t *, word
*);
395 void build_index(indexdata
*);
396 void index_debug(indexdata
*);
397 indextag
*index_findtag(indexdata
*idx
, wchar_t *name
);
402 numberstate
*number_init(void);
403 void number_cfg(numberstate
*, paragraph
*);
404 word
*number_mktext(numberstate
*, paragraph
*, wchar_t *, int *, int *);
405 void number_free(numberstate
*);
410 void gen_citations(paragraph
*, keywordlist
*);
415 struct userstyle_Tag
{
421 void text_backend(paragraph
*, keywordlist
*, indexdata
*);
422 paragraph
*text_config_filename(char *filename
);
427 void xhtml_backend(paragraph
*, keywordlist
*, indexdata
*);
428 paragraph
*xhtml_config_filename(char *filename
);
433 void whlp_backend(paragraph
*, keywordlist
*, indexdata
*);
434 paragraph
*whlp_config_filename(char *filename
);
439 void man_backend(paragraph
*, keywordlist
*, indexdata
*);
440 paragraph
*man_config_filename(char *filename
);
445 void info_backend(paragraph
*, keywordlist
*, indexdata
*);
446 paragraph
*info_config_filename(char *filename
);