[sgt/halibut] / halibut.h

#ifndef HALIBUT_HALIBUT_H
#define HALIBUT_HALIBUT_H

#include <stdio.h>
#include <wchar.h>
#include <time.h>
#include <string.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_DescribedThing,
    para_Description,
    para_Code,
    para_Copyright,
    para_NoCite,
    para_Title,
    para_VersionID,
    para_Config,		       /* configuration directive */
    para_LcontPush,		       /* begin continuation of list item */
    para_LcontPop,		       /* end continuation of list item */
    para_QuotePush,		       /* begin block quote */
    para_QuotePop,		       /* end block quote */
    /*
     * Back ends may define their own paragraph types beyond here,
     * in case they need to use them internally.
     */
    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;

    void *private_data; 	       /* for temp use in backends */
};
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) */
    /*
     * Back ends may define their own word types beyond here, in
     * case they need to use them internally.
     */
    word_NotWordType		       /* placeholder value */
};
/* 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_missingrbrace2,		       /* unclosed braces at end of file */
    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_misplacedlcont,		       /* \lcont not after a list item */
    err_sectmarkerinblock,	       /* section marker appeared in block */
    err_infodirentry,		       /* \cfg{info-dir-entry} missing param */
    err_infonodechar,		       /* colon/comma in node name in info */
    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);
wchar_t *ustrfroma(char *s, wchar_t *outbuf, int size);
char *utoa_dup(wchar_t *s);
wchar_t *ufroma_dup(char *s);
int ustrlen(wchar_t const *s);
wchar_t *uadv(wchar_t *s);
wchar_t *ustrcpy(wchar_t *dest, wchar_t const *source);
wchar_t utolower(wchar_t);
int uisalpha(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);
void *stk_top(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 const *p);
wchar_t *rdtrim(rdstring *rs);
void rdaddc(rdstringc *rs, char c);
void rdaddsc(rdstringc *rs, char const *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 (*)(void *, word *), void *, int);
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;
    filepos implicit_fpos;
    word **explicit_texts;
    filepos *explicit_fpos;
    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 */
    filepos fpos;
};

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 *, filepos *);
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 *, void *);
paragraph *text_config_filename(char *filename);

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

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

/*
 * bk_man.c
 */
void man_backend(paragraph *, keywordlist *, indexdata *, void *);
paragraph *man_config_filename(char *filename);

/*
 * bk_info.c
 */
void info_backend(paragraph *, keywordlist *, indexdata *, void *);
paragraph *info_config_filename(char *filename);

/*
 * bk_paper.c
 */
void *paper_pre_backend(paragraph *, keywordlist *, indexdata *);

/*
 * bk_ps.c
 */
void ps_backend(paragraph *, keywordlist *, indexdata *, void *);
paragraph *ps_config_filename(char *filename);

/*
 * bk_pdf.c
 */
void pdf_backend(paragraph *, keywordlist *, indexdata *, void *);
paragraph *pdf_config_filename(char *filename);

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