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? */
132 /* ORDERING CONSTRAINT: these normal-word types ... */
135 word_Code
, /* monospaced; `quoted' in text */
136 word_WeakCode
, /* monospaced, normal in text */
137 /* ... must be in the same order as these space types ... */
138 word_WhiteSpace
, /* text is NULL or ignorable */
139 word_EmphSpace
, /* WhiteSpace when emphasised */
140 word_CodeSpace
, /* WhiteSpace when code */
141 word_WkCodeSpace
, /* WhiteSpace when weak code */
142 /* ... and must be in the same order as these quote types ... */
143 word_Quote
, /* text is NULL or ignorable */
144 word_EmphQuote
, /* Quote when emphasised */
145 word_CodeQuote
, /* (can't happen) */
146 word_WkCodeQuote
, /* (can't happen) */
147 /* END ORDERING CONSTRAINT */
148 word_internal_endattrs
,
149 word_UpperXref
, /* \K */
150 word_LowerXref
, /* \k */
151 word_XrefEnd
, /* (invisible; no text) */
152 word_IndexRef
, /* (always an invisible one) */
153 word_HyperLink
, /* (invisible) */
154 word_HyperEnd
/* (also invisible; no text) */
156 /* aux values for attributed words */
158 attr_Only
= 0x0000, /* a lone word with the attribute */
159 attr_First
= 0x0001, /* the first of a series */
160 attr_Last
= 0x0002, /* the last of a series */
161 attr_Always
= 0x0003, /* any other part of a series */
164 /* aux values for quote-type words */
167 quote_Close
= 0x0020,
170 #define isattr(x) ( ( (x) > word_Normal && (x) < word_WhiteSpace ) || \
171 ( (x) > word_WhiteSpace && (x) < word_internal_endattrs ) )
172 #define sameattr(x,y) ( (((x)-(y)) & 3) == 0 )
173 #define towordstyle(x) ( word_Normal + ((x) & 3) )
174 #define tospacestyle(x) ( word_WhiteSpace + ((x) & 3) )
175 #define toquotestyle(x) ( word_Quote + ((x) & 3) )
176 #define removeattr(x) ( word_Normal + ((x) &~ 3) )
178 #define attraux(x) ( (x) & attr_mask )
179 #define quoteaux(x) ( (x) & quote_mask )
184 void fatal(int code
, ...) NORETURN
;
185 void error(int code
, ...);
187 err_nomemory
, /* out of memory */
188 err_optnoarg
, /* option `-%s' requires an argument */
189 err_nosuchopt
, /* unrecognised option `-%s' */
190 err_noinput
, /* no input files */
191 err_cantopen
, /* unable to open input file `%s' */
192 err_nodata
, /* no data in input files */
193 err_brokencodepara
, /* line in codepara didn't begin `\c' */
194 err_kwunclosed
, /* expected `}' after keyword */
195 err_kwillegal
, /* paragraph type expects no keyword */
196 err_kwexpected
, /* paragraph type expects a keyword */
197 err_kwtoomany
, /* paragraph type expects only 1 */
198 err_bodyillegal
, /* paragraph type expects only kws! */
199 err_badparatype
, /* invalid command at start of para */
200 err_badmidcmd
, /* invalid command in mid-para */
201 err_unexbrace
, /* unexpected brace */
202 err_explbr
, /* expected `{' after command */
203 err_commenteof
, /* EOF inside braced comment */
204 err_kwexprbr
, /* expected `}' after cross-ref */
205 err_missingrbrace
, /* unclosed braces at end of para */
206 err_missingrbrace2
, /* unclosed braces at end of file */
207 err_nestedstyles
, /* unable to nest text styles */
208 err_nestedindex
, /* unable to nest `\i' thingys */
209 err_nosuchkw
, /* unresolved cross-reference */
210 err_multiBR
, /* multiple \BRs on same keyword */
211 err_nosuchidxtag
, /* \IM on unknown index tag (warning) */
212 err_cantopenw
, /* can't open output file for write */
213 err_macroexists
, /* this macro already exists */
214 err_sectjump
, /* jump a heading level, eg \C -> \S */
215 err_winhelp_ctxclash
, /* WinHelp context ID hash clash */
216 err_multikw
, /* keyword clash in sections */
217 err_misplacedlcont
, /* \lcont not after a list item */
218 err_sectmarkerinblock
, /* section marker appeared in block */
219 err_whatever
/* random error of another type */
226 void *smalloc(char *file
, int line
, int size
);
227 void *srealloc(char *file
, int line
, void *p
, int size
);
228 void sfree(char *file
, int line
, void *p
);
229 #define smalloc(x) smalloc(__FILE__, __LINE__, x)
230 #define srealloc(x, y) srealloc(__FILE__, __LINE__, x, y)
231 #define sfree(x) sfree(__FILE__, __LINE__, x)
233 void *smalloc(int size
);
234 void *srealloc(void *p
, int size
);
237 void free_word_list(word
*w
);
238 void free_para_list(paragraph
*p
);
239 word
*dup_word_list(word
*w
);
240 char *dupstr(char *s
);
242 #define mknew(type) ( (type *) smalloc (sizeof (type)) )
243 #define mknewa(type, number) ( (type *) smalloc ((number) * sizeof (type)) )
244 #define resize(array, len) ( srealloc ((array), (len) * sizeof (*(array))) )
245 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
250 wchar_t *ustrdup(wchar_t *s
);
251 char *ustrtoa(wchar_t *s
, char *outbuf
, int size
);
252 wchar_t *ustrfroma(char *s
, wchar_t *outbuf
, int size
);
253 char *utoa_dup(wchar_t *s
);
254 wchar_t *ufroma_dup(char *s
);
255 int ustrlen(wchar_t *s
);
256 wchar_t *uadv(wchar_t *s
);
257 wchar_t *ustrcpy(wchar_t *dest
, wchar_t *source
);
258 wchar_t utolower(wchar_t);
259 int uisalpha(wchar_t);
260 int ustrcmp(wchar_t *lhs
, wchar_t *rhs
);
261 int ustricmp(wchar_t *lhs
, wchar_t *rhs
);
264 int uisdigit(wchar_t);
265 wchar_t *ustrlow(wchar_t *s
);
266 wchar_t *ustrftime(wchar_t *fmt
, struct tm
*timespec
);
273 void showversion(void);
283 const char *const version
;
288 typedef struct stackTag
*stack
;
290 void stk_free(stack
);
291 void stk_push(stack
, void *);
292 void *stk_pop(stack
);
293 void *stk_top(stack
);
295 typedef struct tagRdstring rdstring
;
300 typedef struct tagRdstringc rdstringc
;
301 struct tagRdstringc
{
305 extern const rdstring empty_rdstring
;
306 extern const rdstringc empty_rdstringc
;
307 void rdadd(rdstring
*rs
, wchar_t c
);
308 void rdadds(rdstring
*rs
, wchar_t *p
);
309 wchar_t *rdtrim(rdstring
*rs
);
310 void rdaddc(rdstringc
*rs
, char c
);
311 void rdaddsc(rdstringc
*rs
, char *p
);
312 char *rdtrimc(rdstringc
*rs
);
314 int compare_wordlists(word
*a
, word
*b
);
316 void mark_attr_ends(paragraph
*sourceform
);
318 typedef struct tagWrappedLine wrappedline
;
319 struct tagWrappedLine
{
321 word
*begin
, *end
; /* first & last words of line */
322 int nspaces
; /* number of whitespaces in line */
323 int shortfall
; /* how much shorter than max width */
325 wrappedline
*wrap_para(word
*, int, int, int (*)(word
*));
326 void wrap_free(wrappedline
*);
331 paragraph
*read_input(input
*in
, indexdata
*idx
);
336 struct keywordlist_Tag
{
339 tree234
*keys
; /* sorted by `key' field */
340 word
**looseends
; /* non-keyword list element numbers */
345 wchar_t *key
; /* the keyword itself */
346 word
*text
; /* "Chapter 2", "Appendix Q"... */
347 /* (NB: filepos are not set) */
348 paragraph
*para
; /* the paragraph referenced */
350 keyword
*kw_lookup(keywordlist
*, wchar_t *);
351 keywordlist
*get_keywords(paragraph
*);
352 void free_keywords(keywordlist
*);
353 void subst_keywords(paragraph
*, keywordlist
*);
360 * Data structure to hold both sides of the index.
362 struct indexdata_Tag
{
363 tree234
*tags
; /* holds type `indextag' */
364 tree234
*entries
; /* holds type `indexentry' */
368 * Data structure to hold an index tag (LHS of index).
370 struct indextag_Tag
{
373 word
**explicit_texts
;
374 int nexplicit
, explicit_size
;
376 indexentry
**refs
; /* array of entries referenced by tag */
380 * Data structure to hold an index entry (RHS of index).
382 struct indexentry_Tag
{
384 void *backend_data
; /* private to back end */
387 indexdata
*make_index(void);
388 void cleanup_index(indexdata
*);
389 /* index_merge takes responsibility for freeing arg 3 iff implicit; never
390 * takes responsibility for arg 2 */
391 void index_merge(indexdata
*, int is_explicit
, wchar_t *, word
*);
392 void build_index(indexdata
*);
393 void index_debug(indexdata
*);
394 indextag
*index_findtag(indexdata
*idx
, wchar_t *name
);
399 numberstate
*number_init(void);
400 void number_cfg(numberstate
*, paragraph
*);
401 word
*number_mktext(numberstate
*, paragraph
*, wchar_t *, int *, int *);
402 void number_free(numberstate
*);
407 void gen_citations(paragraph
*, keywordlist
*);
412 struct userstyle_Tag
{
418 void text_backend(paragraph
*, keywordlist
*, indexdata
*);
419 paragraph
*text_config_filename(char *filename
);
424 void xhtml_backend(paragraph
*, keywordlist
*, indexdata
*);
425 paragraph
*xhtml_config_filename(char *filename
);
430 void whlp_backend(paragraph
*, keywordlist
*, indexdata
*);
431 paragraph
*whlp_config_filename(char *filename
);
436 void man_backend(paragraph
*, keywordlist
*, indexdata
*);
437 paragraph
*man_config_filename(char *filename
);