1 #ifndef HALIBUT_HALIBUT_H
2 #define HALIBUT_HALIBUT_H
12 #define NORETURN __attribute__((__noreturn__))
14 #define NORETURN /* nothing */
24 /* For suppressing unused-parameter warnings */
25 #define IGNORE(x) ( (x) = (x) )
32 typedef struct input_Tag input
;
33 typedef struct filepos_Tag filepos
;
34 typedef struct paragraph_Tag paragraph
;
35 typedef struct word_Tag word
;
36 typedef struct keywordlist_Tag keywordlist
;
37 typedef struct keyword_Tag keyword
;
38 typedef struct userstyle_Tag userstyle
;
39 typedef struct numberstate_Tag numberstate
;
40 typedef struct indexdata_Tag indexdata
;
41 typedef struct indextag_Tag indextag
;
42 typedef struct indexentry_Tag indexentry
;
43 typedef struct macrostack_Tag macrostack
;
46 * Data structure to hold a file name and index, a line and a
47 * column number, for reporting errors
55 * Data structure to hold all the file names etc for input
57 typedef struct pushback_Tag
{
62 char **filenames
; /* complete list of input files */
63 int nfiles
; /* how many in the list */
64 FILE *currfp
; /* the currently open one */
65 int currindex
; /* which one is that in the list */
66 pushback
*pushback
; /* pushed-back input characters */
67 int npushback
, pushbacksize
;
69 int reportcols
; /* report column numbers in errors */
70 macrostack
*stack
; /* macro expansions in force */
71 int defcharset
, charset
; /* character sets for input files */
72 charset_state csstate
;
73 wchar_t wc
[16]; /* wide chars from input conversion */
74 int nwc
, wcpos
; /* size of, and position in, wc[] */
75 char *pushback_chars
; /* used to save input-encoding data */
79 * Data structure to hold the input form of the source, ie a linked
82 struct paragraph_Tag
{
85 wchar_t *keyword
; /* for most special paragraphs */
86 char *origkeyword
; /* same again in original charset */
87 word
*words
; /* list of words in paragraph */
88 int aux
; /* number, in a numbered paragraph
91 word
*kwtext
; /* chapter/section indication */
92 word
*kwtext2
; /* numeric-only form of kwtext */
95 paragraph
*parent
, *child
, *sibling
; /* for hierarchy navigation */
97 void *private_data
; /* for temp use in backends */
100 para_IM
, /* index merge */
101 para_BR
, /* bibliography rewrite */
102 para_Rule
, /* random horizontal rule */
105 para_UnnumberedChapter
,
109 para_Biblio
, /* causes no output unless turned ... */
110 para_BiblioCited
, /* ... into this paragraph type */
120 para_Config
, /* configuration directive */
121 para_LcontPush
, /* begin continuation of list item */
122 para_LcontPop
, /* end continuation of list item */
123 para_QuotePush
, /* begin block quote */
124 para_QuotePop
, /* end block quote */
126 * Back ends may define their own paragraph types beyond here,
127 * in case they need to use them internally.
129 para_NotParaType
/* placeholder value */
133 * Data structure to hold an individual word
139 int breaks
; /* can a line break after it? */
143 void *private_data
; /* for temp use in backends */
146 /* ORDERING CONSTRAINT: these normal-word types ... */
149 word_Code
, /* monospaced; `quoted' in text */
150 word_WeakCode
, /* monospaced, normal in text */
151 /* ... must be in the same order as these space types ... */
152 word_WhiteSpace
, /* text is NULL or ignorable */
153 word_EmphSpace
, /* WhiteSpace when emphasised */
154 word_CodeSpace
, /* WhiteSpace when code */
155 word_WkCodeSpace
, /* WhiteSpace when weak code */
156 /* ... and must be in the same order as these quote types ... */
157 word_Quote
, /* text is NULL or ignorable */
158 word_EmphQuote
, /* Quote when emphasised */
159 word_CodeQuote
, /* (can't happen) */
160 word_WkCodeQuote
, /* (can't happen) */
161 /* END ORDERING CONSTRAINT */
162 word_internal_endattrs
,
163 word_UpperXref
, /* \K */
164 word_LowerXref
, /* \k */
165 word_XrefEnd
, /* (invisible; no text) */
166 word_IndexRef
, /* (always an invisible one) */
167 word_HyperLink
, /* (invisible) */
168 word_HyperEnd
, /* (also invisible; no text) */
170 * Back ends may define their own word types beyond here, in
171 * case they need to use them internally.
173 word_NotWordType
/* placeholder value */
175 /* aux values for attributed words */
177 attr_Only
= 0x0000, /* a lone word with the attribute */
178 attr_First
= 0x0001, /* the first of a series */
179 attr_Last
= 0x0002, /* the last of a series */
180 attr_Always
= 0x0003, /* any other part of a series */
183 /* aux values for quote-type words */
186 quote_Close
= 0x0020,
189 #define isattr(x) ( ( (x) > word_Normal && (x) < word_WhiteSpace ) || \
190 ( (x) > word_WhiteSpace && (x) < word_internal_endattrs ) )
191 #define sameattr(x,y) ( (((x)-(y)) & 3) == 0 )
192 #define towordstyle(x) ( word_Normal + ((x) & 3) )
193 #define tospacestyle(x) ( word_WhiteSpace + ((x) & 3) )
194 #define toquotestyle(x) ( word_Quote + ((x) & 3) )
195 #define removeattr(x) ( word_Normal + ((x) &~ 3) )
197 #define attraux(x) ( (x) & attr_mask )
198 #define quoteaux(x) ( (x) & quote_mask )
203 void fatal(int code
, ...) NORETURN
;
204 void error(int code
, ...);
206 err_nomemory
, /* out of memory */
207 err_optnoarg
, /* option `-%s' requires an argument */
208 err_nosuchopt
, /* unrecognised option `-%s' */
209 err_noinput
, /* no input files */
210 err_cantopen
, /* unable to open input file `%s' */
211 err_nodata
, /* no data in input files */
212 err_brokencodepara
, /* line in codepara didn't begin `\c' */
213 err_kwunclosed
, /* expected `}' after keyword */
214 err_kwillegal
, /* paragraph type expects no keyword */
215 err_kwexpected
, /* paragraph type expects a keyword */
216 err_kwtoomany
, /* paragraph type expects only 1 */
217 err_bodyillegal
, /* paragraph type expects only kws! */
218 err_badparatype
, /* invalid command at start of para */
219 err_badmidcmd
, /* invalid command in mid-para */
220 err_unexbrace
, /* unexpected brace */
221 err_explbr
, /* expected `{' after command */
222 err_commenteof
, /* EOF inside braced comment */
223 err_kwexprbr
, /* expected `}' after cross-ref */
224 err_missingrbrace
, /* unclosed braces at end of para */
225 err_missingrbrace2
, /* unclosed braces at end of file */
226 err_nestedstyles
, /* unable to nest text styles */
227 err_nestedindex
, /* unable to nest `\i' thingys */
228 err_nosuchkw
, /* unresolved cross-reference */
229 err_multiBR
, /* multiple \BRs on same keyword */
230 err_nosuchidxtag
, /* \IM on unknown index tag (warning) */
231 err_cantopenw
, /* can't open output file for write */
232 err_macroexists
, /* this macro already exists */
233 err_sectjump
, /* jump a heading level, eg \C -> \S */
234 err_winhelp_ctxclash
, /* WinHelp context ID hash clash */
235 err_multikw
, /* keyword clash in sections */
236 err_misplacedlcont
, /* \lcont not after a list item */
237 err_sectmarkerinblock
, /* section marker appeared in block */
238 err_infodirentry
, /* \cfg{info-dir-entry} missing param */
239 err_infonodechar
, /* colon/comma in node name in info */
240 err_text_codeline
, /* \c line too long in text backend */
241 err_whatever
/* random error of another type */
248 void *smalloc(char *file
, int line
, int size
);
249 void *srealloc(char *file
, int line
, void *p
, int size
);
250 void sfree(char *file
, int line
, void *p
);
251 #define smalloc(x) smalloc(__FILE__, __LINE__, x)
252 #define srealloc(x, y) srealloc(__FILE__, __LINE__, x, y)
253 #define sfree(x) sfree(__FILE__, __LINE__, x)
255 void *smalloc(int size
);
256 void *srealloc(void *p
, int size
);
259 void free_word_list(word
*w
);
260 void free_para_list(paragraph
*p
);
261 word
*dup_word_list(word
*w
);
262 char *dupstr(char *s
);
264 #define mknew(type) ( (type *) smalloc (sizeof (type)) )
265 #define mknewa(type, number) ( (type *) smalloc ((number) * sizeof (type)) )
266 #define resize(array, len) ( srealloc ((array), (len) * sizeof (*(array))) )
267 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
272 wchar_t *ustrdup(wchar_t const *s
);
273 char *ustrtoa(wchar_t const *s
, char *outbuf
, int size
, int charset
);
274 char *ustrtoa_careful(wchar_t const *s
, char *outbuf
, int size
, int charset
);
275 wchar_t *ustrfroma(char const *s
, wchar_t *outbuf
, int size
, int charset
);
276 char *utoa_dup(wchar_t const *s
, int charset
);
277 char *utoa_dup_len(wchar_t const *s
, int charset
, int *len
);
278 char *utoa_careful_dup(wchar_t const *s
, int charset
);
279 wchar_t *ufroma_dup(char const *s
, int charset
);
280 char *utoa_locale_dup(wchar_t const *s
);
281 wchar_t *ufroma_locale_dup(char const *s
);
282 int ustrlen(wchar_t const *s
);
283 wchar_t *uadv(wchar_t *s
);
284 wchar_t *ustrcpy(wchar_t *dest
, wchar_t const *source
);
285 wchar_t utolower(wchar_t);
286 int uisalpha(wchar_t);
287 int ustrcmp(wchar_t *lhs
, wchar_t *rhs
);
288 int ustricmp(wchar_t *lhs
, wchar_t *rhs
);
291 int uisdigit(wchar_t);
292 wchar_t *ustrlow(wchar_t *s
);
293 wchar_t *ustrftime(const wchar_t *wfmt
, const struct tm
*timespec
);
294 int cvt_ok(int charset
, const wchar_t *s
);
299 int strwid(char const *s
, int charset
);
300 int ustrwid(wchar_t const *s
, int charset
);
307 void showversion(void);
317 const char *const version
;
324 typedef struct stackTag
*stack
;
326 void stk_free(stack
);
327 void stk_push(stack
, void *);
328 void *stk_pop(stack
);
329 void *stk_top(stack
);
331 typedef struct tagRdstring rdstring
;
336 typedef struct tagRdstringc rdstringc
;
337 struct tagRdstringc
{
341 extern const rdstring empty_rdstring
;
342 extern const rdstringc empty_rdstringc
;
343 void rdadd(rdstring
*rs
, wchar_t c
);
344 void rdadds(rdstring
*rs
, wchar_t const *p
);
345 wchar_t *rdtrim(rdstring
*rs
);
346 void rdaddc(rdstringc
*rs
, char c
);
347 void rdaddsc(rdstringc
*rs
, char const *p
);
348 char *rdtrimc(rdstringc
*rs
);
350 int compare_wordlists(word
*a
, word
*b
);
352 void mark_attr_ends(word
*words
);
354 typedef struct tagWrappedLine wrappedline
;
355 struct tagWrappedLine
{
357 word
*begin
, *end
; /* first & last words of line */
358 int nspaces
; /* number of whitespaces in line */
359 int shortfall
; /* how much shorter than max width */
361 wrappedline
*wrap_para(word
*, int, int, int (*)(void *, word
*), void *, int);
362 void wrap_free(wrappedline
*);
363 void cmdline_cfg_add(paragraph
*cfg
, char *string
);
364 paragraph
*cmdline_cfg_new(void);
365 paragraph
*cmdline_cfg_simple(char *string
, ...);
370 paragraph
*read_input(input
*in
, indexdata
*idx
);
375 struct keywordlist_Tag
{
378 tree234
*keys
; /* sorted by `key' field */
379 word
**looseends
; /* non-keyword list element numbers */
384 wchar_t *key
; /* the keyword itself */
385 word
*text
; /* "Chapter 2", "Appendix Q"... */
386 /* (NB: filepos are not set) */
387 paragraph
*para
; /* the paragraph referenced */
389 keyword
*kw_lookup(keywordlist
*, wchar_t *);
390 keywordlist
*get_keywords(paragraph
*);
391 void free_keywords(keywordlist
*);
392 void subst_keywords(paragraph
*, keywordlist
*);
399 * Data structure to hold both sides of the index.
401 struct indexdata_Tag
{
402 tree234
*tags
; /* holds type `indextag' */
403 tree234
*entries
; /* holds type `indexentry' */
407 * Data structure to hold an index tag (LHS of index).
409 struct indextag_Tag
{
412 filepos implicit_fpos
;
413 word
**explicit_texts
;
414 filepos
*explicit_fpos
;
415 int nexplicit
, explicit_size
;
417 indexentry
**refs
; /* array of entries referenced by tag */
421 * Data structure to hold an index entry (RHS of index).
423 struct indexentry_Tag
{
425 void *backend_data
; /* private to back end */
429 indexdata
*make_index(void);
430 void cleanup_index(indexdata
*);
431 /* index_merge takes responsibility for freeing arg 3 iff implicit; never
432 * takes responsibility for arg 2 */
433 void index_merge(indexdata
*, int is_explicit
, wchar_t *, word
*, filepos
*);
434 void build_index(indexdata
*);
435 void index_debug(indexdata
*);
436 indextag
*index_findtag(indexdata
*idx
, wchar_t *name
);
441 numberstate
*number_init(void);
442 void number_cfg(numberstate
*, paragraph
*);
443 word
*number_mktext(numberstate
*, paragraph
*, wchar_t *, int *, int *);
444 void number_free(numberstate
*);
449 void gen_citations(paragraph
*, keywordlist
*);
454 struct userstyle_Tag
{
460 void text_backend(paragraph
*, keywordlist
*, indexdata
*, void *);
461 paragraph
*text_config_filename(char *filename
);
466 void xhtml_backend(paragraph
*, keywordlist
*, indexdata
*, void *);
467 paragraph
*xhtml_config_filename(char *filename
);
472 void whlp_backend(paragraph
*, keywordlist
*, indexdata
*, void *);
473 paragraph
*whlp_config_filename(char *filename
);
478 void man_backend(paragraph
*, keywordlist
*, indexdata
*, void *);
479 paragraph
*man_config_filename(char *filename
);
484 void info_backend(paragraph
*, keywordlist
*, indexdata
*, void *);
485 paragraph
*info_config_filename(char *filename
);
490 void *paper_pre_backend(paragraph
*, keywordlist
*, indexdata
*);
495 void ps_backend(paragraph
*, keywordlist
*, indexdata
*, void *);
496 paragraph
*ps_config_filename(char *filename
);
501 void pdf_backend(paragraph
*, keywordlist
*, indexdata
*, void *);
502 paragraph
*pdf_config_filename(char *filename
);