[sgt/halibut] / halibut.h

#ifndef HALIBUT_HALIBUT_H
#define HALIBUT_HALIBUT_H

#include <stdio.h>
#include <wchar.h>
#include <time.h>

#ifdef __GNUC__
#define NORETURN __attribute__((__noreturn__))
#else
#define NORETURN /* nothing */
#endif

#ifndef TRUE
#define TRUE 1
#endif
#ifndef FALSE
#define FALSE 0
#endif

/* For suppressing unused-parameter warnings */
#define IGNORE(x) ( (x) = (x) )

#include "tree234.h"

/*
 * Structure tags
 */
typedef struct input_Tag input;
typedef struct filepos_Tag filepos;
typedef struct paragraph_Tag paragraph;
typedef struct word_Tag word;
typedef struct keywordlist_Tag keywordlist;
typedef struct keyword_Tag keyword;
typedef struct userstyle_Tag userstyle;
typedef struct numberstate_Tag numberstate;
typedef struct indexdata_Tag indexdata;
typedef struct indextag_Tag indextag;
typedef struct indexentry_Tag indexentry;
typedef struct macrostack_Tag macrostack;

/*
 * Data structure to hold a file name and index, a line and a
 * column number, for reporting errors
 */
struct filepos_Tag {
    char *filename;
    int line, col;
};

/*
 * Data structure to hold all the file names etc for input
 */
typedef struct pushback_Tag {
    int chr;
    filepos pos;
} pushback;
struct input_Tag {
    char **filenames;		       /* complete list of input files */
    int nfiles;			       /* how many in the list */
    FILE *currfp;		       /* the currently open one */
    int currindex;		       /* which one is that in the list */
    pushback *pushback;		       /* pushed-back input characters */
    int npushback, pushbacksize;
    filepos pos;
    int reportcols;		       /* report column numbers in errors */
    macrostack *stack;		       /* macro expansions in force */
};

/*
 * Data structure to hold the input form of the source, ie a linked
 * list of paragraphs
 */
struct paragraph_Tag {
    paragraph *next;
    int type;
    wchar_t *keyword;		       /* for most special paragraphs */
    word *words;		       /* list of words in paragraph */
    int aux;			       /* number, in a numbered paragraph
                                        * or subsection level
                                        */
    word *kwtext;		       /* chapter/section indication */
    word *kwtext2;		       /* numeric-only form of kwtext */
    filepos fpos;

    paragraph *parent, *child, *sibling;   /* for hierarchy navigation */

    void *private_data; 	       /* for temp use in backends */
};
enum {
    para_IM,			       /* index merge */
    para_BR,			       /* bibliography rewrite */
    para_Rule,			       /* random horizontal rule */
    para_Chapter,
    para_Appendix,
    para_UnnumberedChapter,
    para_Heading,
    para_Subsect,
    para_Normal,
    para_Biblio,		       /* causes no output unless turned ... */
    para_BiblioCited,		       /*  ... into this paragraph type */
    para_Bullet,
    para_NumberedList,
    para_Code,
    para_Copyright,
    para_Preamble,
    para_NoCite,
    para_Title,
    para_VersionID,
    para_Config,		       /* configuration directive */
    para_NotParaType		       /* placeholder value */
};

/*
 * Data structure to hold an individual word
 */
struct word_Tag {
    word *next, *alt;
    int type;
    int aux;
    int breaks;			       /* can a line break after it? */
    wchar_t *text;
    filepos fpos;
};
enum {
    /* ORDERING CONSTRAINT: these normal-word types ... */
    word_Normal,
    word_Emph,
    word_Code,			       /* monospaced; `quoted' in text */
    word_WeakCode,		       /* monospaced, normal in text */
    /* ... must be in the same order as these space types ... */
    word_WhiteSpace,		       /* text is NULL or ignorable */
    word_EmphSpace,		       /* WhiteSpace when emphasised */
    word_CodeSpace,		       /* WhiteSpace when code */
    word_WkCodeSpace,		       /* WhiteSpace when weak code */
    /* ... and must be in the same order as these quote types ... */
    word_Quote,			       /* text is NULL or ignorable */
    word_EmphQuote,		       /* Quote when emphasised */
    word_CodeQuote,		       /* (can't happen) */
    word_WkCodeQuote,		       /* (can't happen) */
    /* END ORDERING CONSTRAINT */
    word_internal_endattrs,
    word_UpperXref,		       /* \K */
    word_LowerXref,		       /* \k */
    word_XrefEnd,		       /* (invisible; no text) */
    word_IndexRef,		       /* (always an invisible one) */
    word_HyperLink,		       /* (invisible) */
    word_HyperEnd		       /* (also invisible; no text) */
};
/* aux values for attributed words */
enum {
    attr_Only   = 0x0000,	       /* a lone word with the attribute */
    attr_First  = 0x0001,	       /* the first of a series */
    attr_Last   = 0x0002,	       /* the last of a series */
    attr_Always	= 0x0003,	       /* any other part of a series */
    attr_mask   = 0x0003,
};
/* aux values for quote-type words */
enum {
    quote_Open  = 0x0010,
    quote_Close = 0x0020,
    quote_mask  = 0x0030,
};
#define isattr(x) ( ( (x) > word_Normal && (x) < word_WhiteSpace ) || \
                    ( (x) > word_WhiteSpace && (x) < word_internal_endattrs ) )
#define sameattr(x,y) ( (((x)-(y)) & 3) == 0 )
#define towordstyle(x) ( word_Normal + ((x) & 3) )
#define tospacestyle(x) ( word_WhiteSpace + ((x) & 3) )
#define toquotestyle(x) ( word_Quote + ((x) & 3) )
#define removeattr(x) ( word_Normal + ((x) &~ 3) )

#define attraux(x) ( (x) & attr_mask )
#define quoteaux(x) ( (x) & quote_mask )

/*
 * error.c
 */
void fatal(int code, ...) NORETURN;
void error(int code, ...);
enum {
    err_nomemory,		       /* out of memory */
    err_optnoarg,		       /* option `-%s' requires an argument */
    err_nosuchopt,		       /* unrecognised option `-%s' */
    err_noinput,		       /* no input files */
    err_cantopen,		       /* unable to open input file `%s' */
    err_nodata,			       /* no data in input files */
    err_brokencodepara,		       /* line in codepara didn't begin `\c' */
    err_kwunclosed,		       /* expected `}' after keyword */
    err_kwillegal,		       /* paragraph type expects no keyword */
    err_kwexpected,		       /* paragraph type expects a keyword */
    err_kwtoomany,		       /* paragraph type expects only 1 */
    err_bodyillegal,		       /* paragraph type expects only kws! */
    err_badparatype,		       /* invalid command at start of para */
    err_badmidcmd,		       /* invalid command in mid-para */
    err_unexbrace,		       /* unexpected brace */
    err_explbr,			       /* expected `{' after command */
    err_commenteof,		       /* EOF inside braced comment */
    err_kwexprbr,		       /* expected `}' after cross-ref */
    err_missingrbrace,		       /* unclosed braces at end of para */
    err_nestedstyles,		       /* unable to nest text styles */
    err_nestedindex,		       /* unable to nest `\i' thingys */
    err_nosuchkw,		       /* unresolved cross-reference */
    err_multiBR,		       /* multiple \BRs on same keyword */
    err_nosuchidxtag,		       /* \IM on unknown index tag (warning) */
    err_cantopenw,		       /* can't open output file for write */
    err_macroexists,		       /* this macro already exists */
    err_sectjump,		       /* jump a heading level, eg \C -> \S */
    err_winhelp_ctxclash,	       /* WinHelp context ID hash clash */
    err_multikw,		       /* keyword clash in sections */
    err_whatever                       /* random error of another type */
};

/*
 * malloc.c
 */
#ifdef LOGALLOC
void *smalloc(char *file, int line, int size);
void *srealloc(char *file, int line, void *p, int size);
void sfree(char *file, int line, void *p);
#define smalloc(x) smalloc(__FILE__, __LINE__, x)
#define srealloc(x, y) srealloc(__FILE__, __LINE__, x, y)
#define sfree(x) sfree(__FILE__, __LINE__, x)
#else
void *smalloc(int size);
void *srealloc(void *p, int size);
void sfree(void *p);
#endif
void free_word_list(word *w);
void free_para_list(paragraph *p);
word *dup_word_list(word *w);
char *dupstr(char *s);

#define mknew(type) ( (type *) smalloc (sizeof (type)) )
#define mknewa(type, number) ( (type *) smalloc ((number) * sizeof (type)) )
#define resize(array, len) ( srealloc ((array), (len) * sizeof (*(array))) )
#define lenof(array) ( sizeof(array) / sizeof(*(array)) )

/*
 * ustring.c
 */
wchar_t *ustrdup(wchar_t *s);
char *ustrtoa(wchar_t *s, char *outbuf, int size);
int ustrlen(wchar_t *s);
wchar_t *uadv(wchar_t *s);
wchar_t *ustrcpy(wchar_t *dest, wchar_t *source);
wchar_t utolower(wchar_t);
int ustrcmp(wchar_t *lhs, wchar_t *rhs);
int ustricmp(wchar_t *lhs, wchar_t *rhs);
int utoi(wchar_t *);
int utob(wchar_t *);
int uisdigit(wchar_t);
wchar_t *ustrlow(wchar_t *s);
wchar_t *ustrftime(wchar_t *fmt, struct tm *timespec);

/*
 * help.c
 */
void help(void);
void usage(void);
void showversion(void);

/*
 * licence.c
 */
void licence(void);

/*
 * version.c
 */
const char *const version;

/*
 * misc.c
 */
typedef struct stackTag *stack;
stack stk_new(void);
void stk_free(stack);
void stk_push(stack, void *);
void *stk_pop(stack);

typedef struct tagRdstring rdstring;
struct tagRdstring {
    int pos, size;
    wchar_t *text;
};
typedef struct tagRdstringc rdstringc;
struct tagRdstringc {
    int pos, size;
    char *text;
};
extern const rdstring empty_rdstring;
extern const rdstringc empty_rdstringc;
void rdadd(rdstring *rs, wchar_t c);
void rdadds(rdstring *rs, wchar_t *p);
wchar_t *rdtrim(rdstring *rs);
void rdaddc(rdstringc *rs, char c);
void rdaddsc(rdstringc *rs, char *p);
char *rdtrimc(rdstringc *rs);

int compare_wordlists(word *a, word *b);

void mark_attr_ends(paragraph *sourceform);

typedef struct tagWrappedLine wrappedline;
struct tagWrappedLine {
    wrappedline *next;
    word *begin, *end;		       /* first & last words of line */
    int nspaces;		       /* number of whitespaces in line */
    int shortfall;		       /* how much shorter than max width */
};
wrappedline *wrap_para(word *, int, int, int (*)(word *));
void wrap_free(wrappedline *);

/*
 * input.c
 */
paragraph *read_input(input *in, indexdata *idx);

/*
 * keywords.c
 */
struct keywordlist_Tag {
    int nkeywords;
    int size;
    tree234 *keys;		       /* sorted by `key' field */
    word **looseends;		       /* non-keyword list element numbers */
    int nlooseends;
    int looseendssize;
};
struct keyword_Tag {
    wchar_t *key;		       /* the keyword itself */
    word *text;			       /* "Chapter 2", "Appendix Q"... */
    				       /* (NB: filepos are not set) */
    paragraph *para;		       /* the paragraph referenced */
};
keyword *kw_lookup(keywordlist *, wchar_t *);
keywordlist *get_keywords(paragraph *);
void free_keywords(keywordlist *);
void subst_keywords(paragraph *, keywordlist *);

/*
 * index.c
 */

/*
 * Data structure to hold both sides of the index.
 */
struct indexdata_Tag {
    tree234 *tags;		       /* holds type `indextag' */
    tree234 *entries;		       /* holds type `indexentry' */
};

/*
 * Data structure to hold an index tag (LHS of index).
 */
struct indextag_Tag {
    wchar_t *name;
    word *implicit_text;
    word **explicit_texts;
    int nexplicit, explicit_size;
    int nrefs;
    indexentry **refs;		       /* array of entries referenced by tag */
};

/*
 * Data structure to hold an index entry (RHS of index).
 */
struct indexentry_Tag {
    word *text;
    void *backend_data;		       /* private to back end */
};

indexdata *make_index(void);
void cleanup_index(indexdata *);
/* index_merge takes responsibility for freeing arg 3 iff implicit; never
 * takes responsibility for arg 2 */
void index_merge(indexdata *, int is_explicit, wchar_t *, word *);
void build_index(indexdata *);
void index_debug(indexdata *);
indextag *index_findtag(indexdata *idx, wchar_t *name);

/*
 * contents.c
 */
numberstate *number_init(void);
void number_cfg(numberstate *, paragraph *);
word *number_mktext(numberstate *, paragraph *, wchar_t *, int , int *);
void number_free(numberstate *);

/*
 * biblio.c
 */
void gen_citations(paragraph *, keywordlist *);

/*
 * style.c
 */
struct userstyle_Tag {
};

/*
 * bk_text.c
 */
void text_backend(paragraph *, keywordlist *, indexdata *);

/*
 * bk_xhtml.c
 */
void xhtml_backend(paragraph *, keywordlist *, indexdata *);

/*
 * bk_whlp.c
 */
void whlp_backend(paragraph *, keywordlist *, indexdata *);

#endif
Commit	Line	Data
d7482997	1	#ifndef HALIBUT_HALIBUT_H
	2	#define HALIBUT_HALIBUT_H
	3
	4	#include <stdio.h>
	5	#include <wchar.h>
	6	#include <time.h>
	7
	8	#ifdef __GNUC__
	9	#define NORETURN __attribute__((__noreturn__))
	10	#else
	11	#define NORETURN /* nothing */
	12	#endif
	13
	14	#ifndef TRUE
	15	#define TRUE 1
	16	#endif
	17	#ifndef FALSE
	18	#define FALSE 0
	19	#endif
	20
	21	/* For suppressing unused-parameter warnings */
	22	#define IGNORE(x) ( (x) = (x) )
	23
	24	#include "tree234.h"
	25
	26	/*
	27	* Structure tags
	28	*/
	29	typedef struct input_Tag input;
	30	typedef struct filepos_Tag filepos;
	31	typedef struct paragraph_Tag paragraph;
	32	typedef struct word_Tag word;
	33	typedef struct keywordlist_Tag keywordlist;
	34	typedef struct keyword_Tag keyword;
	35	typedef struct userstyle_Tag userstyle;
	36	typedef struct numberstate_Tag numberstate;
	37	typedef struct indexdata_Tag indexdata;
	38	typedef struct indextag_Tag indextag;
	39	typedef struct indexentry_Tag indexentry;
	40	typedef struct macrostack_Tag macrostack;
	41
	42	/*
	43	* Data structure to hold a file name and index, a line and a
	44	* column number, for reporting errors
	45	*/
	46	struct filepos_Tag {
	47	char *filename;
	48	int line, col;
	49	};
	50
	51	/*
	52	* Data structure to hold all the file names etc for input
	53	*/
	54	typedef struct pushback_Tag {
	55	int chr;
	56	filepos pos;
	57	} pushback;
	58	struct input_Tag {
	59	char *filenames; / complete list of input files */
	60	int nfiles; /* how many in the list */
	61	FILE currfp; / the currently open one */
	62	int currindex; /* which one is that in the list */
	63	pushback pushback; / pushed-back input characters */
	64	int npushback, pushbacksize;
65	filepos pos;
66	int reportcols; /* report column numbers in errors */
67	macrostack stack; / macro expansions in force */
68	};
69
70	/*
71	* Data structure to hold the input form of the source, ie a linked
72	* list of paragraphs
73	*/
74	struct paragraph_Tag {
75	paragraph *next;
76	int type;
77	wchar_t keyword; / for most special paragraphs */
78	word words; / list of words in paragraph */
79	int aux; /* number, in a numbered paragraph
80	* or subsection level
81	*/
82	word kwtext; / chapter/section indication */
83	word kwtext2; / numeric-only form of kwtext */
84	filepos fpos;
85
86	paragraph parent, child, sibling; / for hierarchy navigation */
87
88	void private_data; / for temp use in backends */
89	};
90	enum {
91	para_IM, /* index merge */
92	para_BR, /* bibliography rewrite */
93	para_Rule, /* random horizontal rule */
94	para_Chapter,
95	para_Appendix,
96	para_UnnumberedChapter,
97	para_Heading,
98	para_Subsect,
99	para_Normal,
100	para_Biblio, /* causes no output unless turned ... */
101	para_BiblioCited, /* ... into this paragraph type */
102	para_Bullet,
103	para_NumberedList,
104	para_Code,
105	para_Copyright,
106	para_Preamble,
107	para_NoCite,
108	para_Title,
109	para_VersionID,
110	para_Config, /* configuration directive */
111	para_NotParaType /* placeholder value */
112	};
113
114	/*
115	* Data structure to hold an individual word
116	*/
117	struct word_Tag {
118	word next, alt;
119	int type;
120	int aux;
121	int breaks; /* can a line break after it? */
122	wchar_t *text;
123	filepos fpos;
124	};
125	enum {
126	/* ORDERING CONSTRAINT: these normal-word types ... */
127	word_Normal,
128	word_Emph,
129	word_Code, /* monospaced; `quoted' in text */
130	word_WeakCode, /* monospaced, normal in text */
131	/* ... must be in the same order as these space types ... */
132	word_WhiteSpace, /* text is NULL or ignorable */
133	word_EmphSpace, /* WhiteSpace when emphasised */
134	word_CodeSpace, /* WhiteSpace when code */
135	word_WkCodeSpace, /* WhiteSpace when weak code */
136	/* ... and must be in the same order as these quote types ... */
137	word_Quote, /* text is NULL or ignorable */
138	word_EmphQuote, /* Quote when emphasised */
139	word_CodeQuote, /* (can't happen) */
140	word_WkCodeQuote, /* (can't happen) */
141	/* END ORDERING CONSTRAINT */
142	word_internal_endattrs,
143	word_UpperXref, /* \K */
144	word_LowerXref, /* \k */
145	word_XrefEnd, /* (invisible; no text) */
146	word_IndexRef, /* (always an invisible one) */
147	word_HyperLink, /* (invisible) */
148	word_HyperEnd /* (also invisible; no text) */
149	};
150	/* aux values for attributed words */
151	enum {
152	attr_Only = 0x0000, /* a lone word with the attribute */
153	attr_First = 0x0001, /* the first of a series */
154	attr_Last = 0x0002, /* the last of a series */
155	attr_Always = 0x0003, /* any other part of a series */
156	attr_mask = 0x0003,
157	};
158	/* aux values for quote-type words */
159	enum {
160	quote_Open = 0x0010,
161	quote_Close = 0x0020,
162	quote_mask = 0x0030,
163	};
164	#define isattr(x) ( ( (x) > word_Normal && (x) < word_WhiteSpace ) \|\| \
165	( (x) > word_WhiteSpace && (x) < word_internal_endattrs ) )
166	#define sameattr(x,y) ( (((x)-(y)) & 3) == 0 )
167	#define towordstyle(x) ( word_Normal + ((x) & 3) )
168	#define tospacestyle(x) ( word_WhiteSpace + ((x) & 3) )
169	#define toquotestyle(x) ( word_Quote + ((x) & 3) )
170	#define removeattr(x) ( word_Normal + ((x) &~ 3) )
171
172	#define attraux(x) ( (x) & attr_mask )
173	#define quoteaux(x) ( (x) & quote_mask )
174
175	/*
176	* error.c
177	*/
178	void fatal(int code, ...) NORETURN;
179	void error(int code, ...);
180	enum {
181	err_nomemory, /* out of memory */
182	err_optnoarg, /* option `-%s' requires an argument */
183	err_nosuchopt, /* unrecognised option `-%s' */
184	err_noinput, /* no input files */
185	err_cantopen, /* unable to open input file `%s' */
186	err_nodata, /* no data in input files */
187	err_brokencodepara, /* line in codepara didn't begin `\c' */
188	err_kwunclosed, /* expected `}' after keyword */
189	err_kwillegal, /* paragraph type expects no keyword */
190	err_kwexpected, /* paragraph type expects a keyword */
191	err_kwtoomany, /* paragraph type expects only 1 */
192	err_bodyillegal, /* paragraph type expects only kws! */
193	err_badparatype, /* invalid command at start of para */
194	err_badmidcmd, /* invalid command in mid-para */
195	err_unexbrace, /* unexpected brace */
196	err_explbr, /* expected `{' after command */
197	err_commenteof, /* EOF inside braced comment */
198	err_kwexprbr, /* expected `}' after cross-ref */
199	err_missingrbrace, /* unclosed braces at end of para */
200	err_nestedstyles, /* unable to nest text styles */
201	err_nestedindex, /* unable to nest `\i' thingys */
202	err_nosuchkw, /* unresolved cross-reference */
203	err_multiBR, /* multiple \BRs on same keyword */
204	err_nosuchidxtag, /* \IM on unknown index tag (warning) */
205	err_cantopenw, /* can't open output file for write */
206	err_macroexists, /* this macro already exists */
207	err_sectjump, /* jump a heading level, eg \C -> \S */
208	err_winhelp_ctxclash, /* WinHelp context ID hash clash */
209	err_multikw, /* keyword clash in sections */
210	err_whatever /* random error of another type */
211	};
212
213	/*
214	* malloc.c
215	*/
216	#ifdef LOGALLOC
217	void smalloc(char file, int line, int size);
218	void srealloc(char file, int line, void *p, int size);
219	void sfree(char file, int line, void p);
220	#define smalloc(x) smalloc(__FILE__, __LINE__, x)
221	#define srealloc(x, y) srealloc(__FILE__, __LINE__, x, y)
222	#define sfree(x) sfree(__FILE__, __LINE__, x)
223	#else
224	void *smalloc(int size);
225	void srealloc(void p, int size);
226	void sfree(void *p);
227	#endif
228	void free_word_list(word *w);
229	void free_para_list(paragraph *p);
230	word dup_word_list(word w);
231	char dupstr(char s);
232
233	#define mknew(type) ( (type *) smalloc (sizeof (type)) )
234	#define mknewa(type, number) ( (type ) smalloc ((number) sizeof (type)) )
235	#define resize(array, len) ( srealloc ((array), (len) * sizeof (*(array))) )
236	#define lenof(array) ( sizeof(array) / sizeof(*(array)) )
237
238	/*
239	* ustring.c
240	*/
241	wchar_t ustrdup(wchar_t s);
242	char ustrtoa(wchar_t s, char *outbuf, int size);
243	int ustrlen(wchar_t *s);
244	wchar_t uadv(wchar_t s);
245	wchar_t ustrcpy(wchar_t dest, wchar_t *source);
246	wchar_t utolower(wchar_t);
247	int ustrcmp(wchar_t lhs, wchar_t rhs);
248	int ustricmp(wchar_t lhs, wchar_t rhs);
249	int utoi(wchar_t *);
250	int utob(wchar_t *);
251	int uisdigit(wchar_t);
252	wchar_t ustrlow(wchar_t s);
253	wchar_t ustrftime(wchar_t fmt, struct tm *timespec);
254
255	/*
256	* help.c
257	*/
258	void help(void);
259	void usage(void);
260	void showversion(void);
261
262	/*
263	* licence.c
264	*/
265	void licence(void);
266
267	/*
268	* version.c
269	*/
270	const char *const version;
271
272	/*
273	* misc.c
274	*/
275	typedef struct stackTag *stack;
276	stack stk_new(void);
277	void stk_free(stack);
278	void stk_push(stack, void *);
279	void *stk_pop(stack);
280
281	typedef struct tagRdstring rdstring;
282	struct tagRdstring {
283	int pos, size;
284	wchar_t *text;
285	};
286	typedef struct tagRdstringc rdstringc;
287	struct tagRdstringc {
288	int pos, size;
289	char *text;
290	};
291	extern const rdstring empty_rdstring;
292	extern const rdstringc empty_rdstringc;
293	void rdadd(rdstring *rs, wchar_t c);
294	void rdadds(rdstring rs, wchar_t p);
295	wchar_t rdtrim(rdstring rs);
296	void rdaddc(rdstringc *rs, char c);
297	void rdaddsc(rdstringc rs, char p);
298	char rdtrimc(rdstringc rs);
299
300	int compare_wordlists(word a, word b);
301
302	void mark_attr_ends(paragraph *sourceform);
303
304	typedef struct tagWrappedLine wrappedline;
305	struct tagWrappedLine {
306	wrappedline *next;
307	word begin, end; /* first & last words of line */
308	int nspaces; /* number of whitespaces in line */
309	int shortfall; /* how much shorter than max width */
310	};
311	wrappedline wrap_para(word , int, int, int ()(word ));
312	void wrap_free(wrappedline *);
313
314	/*
315	* input.c
316	*/
317	paragraph read_input(input in, indexdata *idx);
318
319	/*
320	* keywords.c
321	*/
322	struct keywordlist_Tag {
323	int nkeywords;
324	int size;
325	tree234 keys; / sorted by `key' field */
326	word *looseends; / non-keyword list element numbers */
327	int nlooseends;
328	int looseendssize;
329	};
330	struct keyword_Tag {
331	wchar_t key; / the keyword itself */
332	word text; / "Chapter 2", "Appendix Q"... */
333	/* (NB: filepos are not set) */
334	paragraph para; / the paragraph referenced */
335	};
336	keyword kw_lookup(keywordlist , wchar_t *);
337	keywordlist get_keywords(paragraph );
338	void free_keywords(keywordlist *);
339	void subst_keywords(paragraph , keywordlist );
340
341	/*
342	* index.c
343	*/
344
345	/*
346	* Data structure to hold both sides of the index.
347	*/
348	struct indexdata_Tag {
349	tree234 tags; / holds type `indextag' */
350	tree234 entries; / holds type `indexentry' */
351	};
352
353	/*
354	* Data structure to hold an index tag (LHS of index).
355	*/
356	struct indextag_Tag {
357	wchar_t *name;
358	word *implicit_text;
359	word **explicit_texts;
360	int nexplicit, explicit_size;
361	int nrefs;
362	indexentry *refs; / array of entries referenced by tag */
363	};
364
365	/*
366	* Data structure to hold an index entry (RHS of index).
367	*/
368	struct indexentry_Tag {
369	word *text;
370	void backend_data; / private to back end */
371	};
372
373	indexdata *make_index(void);
374	void cleanup_index(indexdata *);
375	/* index_merge takes responsibility for freeing arg 3 iff implicit; never
376	* takes responsibility for arg 2 */
377	void index_merge(indexdata , int is_explicit, wchar_t , word *);
378	void build_index(indexdata *);
379	void index_debug(indexdata *);
380	indextag index_findtag(indexdata idx, wchar_t *name);
381
382	/*
383	* contents.c
384	*/
385	numberstate *number_init(void);
386	void number_cfg(numberstate , paragraph );
387	word number_mktext(numberstate , paragraph , wchar_t , int , int *);
388	void number_free(numberstate *);
389
390	/*
391	* biblio.c
392	*/
393	void gen_citations(paragraph , keywordlist );
394
395	/*
396	* style.c
397	*/
398	struct userstyle_Tag {
399	};
400
401	/*
402	* bk_text.c
403	*/
404	void text_backend(paragraph , keywordlist , indexdata *);
405
406	/*
407	* bk_xhtml.c
408	*/
409	void xhtml_backend(paragraph , keywordlist , indexdata *);
410
411	/*
412	* bk_whlp.c
413	*/
414	void whlp_backend(paragraph , keywordlist , indexdata *);
415
416	#endif