[sgt/halibut] / halibut.h

#ifndef HALIBUT_HALIBUT_H
#define HALIBUT_HALIBUT_H

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

#include "charset.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 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 */
    int wantclose;		       /* does the current file want closing */
    pushback *pushback;		       /* pushed-back input characters */
    int npushback, pushbacksize;
    filepos pos;
    int reportcols;		       /* report column numbers in errors */
    macrostack *stack;		       /* macro expansions in force */
    int defcharset, charset;	       /* character sets for input files */
    charset_state csstate;
    wchar_t wc[16];		       /* wide chars from input conversion */
    int nwc, wcpos;		       /* size of, and position in, wc[] */
    char *pushback_chars;	       /* used to save input-encoding data */
};

/*
 * 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 */
    char *origkeyword;		       /* same again in original charset */
    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 isvis(x) ( ( (x) >= word_Normal && (x) <= word_LowerXref ) )
#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
 */
/* out of memory */
void fatalerr_nomemory(void) NORETURN;
/* option `-%s' requires an argument */
void err_optnoarg(const char *sp);
/* unrecognised option `-%s' */
void err_nosuchopt(const char *sp);
/* unrecognised charset %s (cmdline) */
void err_cmdcharset(const char *sp);
/* futile option `-%s'%s */
void err_futileopt(const char *sp, const char *sp2);
/* no input files */
void err_noinput(void);
/* unable to open input file `%s' */
void err_cantopen(const char *sp);
/* no data in input files */
void err_nodata(void);
/* line in codepara didn't begin `\c' */
void err_brokencodepara(const filepos *fpos);
/* expected `}' after keyword */
void err_kwunclosed(const filepos *fpos);
/* paragraph type expects no keyword */
void err_kwexpected(const filepos *fpos);
/* paragraph type expects a keyword */
void err_kwillegal(const filepos *fpos);
/* paragraph type expects only 1 */
void err_kwtoomany(const filepos *fpos);
/* paragraph type expects only kws! */
void err_bodyillegal(const filepos *fpos);
/* invalid command at start of para */
void err_badparatype(const wchar_t *wsp, const filepos *fpos);
/* invalid command in mid-para */
void err_badmidcmd(const wchar_t *wsp, const filepos *fpos);
/* unexpected brace */
void err_unexbrace(const filepos *fpos);
/* expected `{' after command */
void err_explbr(const filepos *fpos);
/* EOF inside braced comment */
void err_commenteof(const filepos *fpos);
/* expected `}' after cross-ref */
void err_kwexprbr(const filepos *fpos);
/* \q within \c is not supported */
void err_codequote(const filepos *fpos);
/* unclosed braces at end of para */
void err_missingrbrace(const filepos *fpos);
/* unclosed braces at end of file */
void err_missingrbrace2(const filepos *fpos);
/* unable to nest text styles */
void err_nestedstyles(const filepos *fpos);
/* unable to nest `\i' thingys */
void err_nestedindex(const filepos *fpos);
/* two \i differing only in case */
void err_indexcase(const filepos *fpos, const wchar_t *wsp,
                   const filepos *fpos2, const wchar_t *wsp2);
/* unresolved cross-reference */
void err_nosuchkw(const filepos *fpos, const wchar_t *wsp);
/* multiple \BRs on same keyword */
void err_multiBR(const filepos *fpos, const wchar_t *wsp);
/* \IM on unknown index tag (warning) */
void err_nosuchidxtag(const filepos *fpos, const wchar_t *wsp);
/* can't open output file for write */
void err_cantopenw(const char *sp);
/* this macro already exists */
void err_macroexists(const filepos *fpos, const wchar_t *wsp);
/* jump a heading level, eg \C -> \S */
void err_sectjump(const filepos *fpos);
/* WinHelp context ID hash clash */
void err_winhelp_ctxclash(const filepos *fpos, const char *sp, const char *sp2);
/* keyword clash in sections */
void err_multikw(const filepos *fpos, const filepos *fpos2, const wchar_t *wsp);
/* \lcont not after a list item */
void err_misplacedlcont(const filepos *fpos);
/* section marker appeared in block */
void err_sectmarkerinblock(const filepos *fpos, const char *sp);
/* \cfg{%s} insufficient args (<%d) */
void err_cfginsufarg(const filepos *fpos, const char *sp, int i);
/* colon/comma in node name in info */
void err_infonodechar(const filepos *fpos, char c) /* fpos might be NULL */;
/* \c line too long in text backend */
void err_text_codeline(const filepos *fpos, int i, int j);
/* unrecognised HTML version keyword */
void err_htmlver(const filepos *fpos, const wchar_t *wsp);
/* unrecognised character set name */
void err_charset(const filepos *fpos, const wchar_t *wsp);
/* unrecognised font name */
void err_nofont(const filepos *fpos, const wchar_t *wsp);
/* eof in AFM file */
void err_afmeof(const filepos *fpos);
/* missing expected keyword in AFM */
void err_afmkey(const filepos *fpos, const char *sp);
/* unsupported AFM version */
void err_afmvers(const filepos *fpos);
/* missing value(s) for AFM key */
void err_afmval(const filepos *fpos, const char *sp, int i);
/* eof in Type 1 font file */
void err_pfeof(const filepos *fpos);
/* bad Type 1 header line */
void err_pfhead(const filepos *fpos);
/* otherwise invalide Type 1 font */
void err_pfbad(const filepos *fpos);
/* Type 1 font but no AFM */
void err_pfnoafm(const filepos *fpos, const char *sp);
/* need both or neither of hhp+chm */
void err_chmnames(void);
/* required sfnt table missing */
void err_sfntnotable(const filepos *fpos, const char *sp);
/* sfnt has no PostScript name */
void err_sfntnopsname(const filepos *fpos);
/* sfnt table not valid */
void err_sfntbadtable(const filepos *fpos, const char *sp);
/* sfnt has no UCS-2 cmap */
void err_sfntnounicmap(const filepos *fpos);
/* sfnt table version unknown */
void err_sfnttablevers(const filepos *fpos, const char *sp);
/* sfnt has bad header */
void err_sfntbadhdr(const filepos *fpos);
/* sfnt cmap references bad glyph */
void err_sfntbadglyph(const filepos *fpos, unsigned wc);

/*
 * 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 const *s);

#define snew(type) ( (type *) smalloc (sizeof (type)) )
#define snewn(number, type) ( (type *) smalloc ((number) * sizeof (type)) )
#define sresize(array, number, type) \
	( (type *) srealloc ((array), (number) * sizeof (type)) )
#define lenof(array) ( sizeof(array) / sizeof(*(array)) )

/*
 * ustring.c
 */
wchar_t *ustrdup(wchar_t const *s);
char *ustrtoa(wchar_t const *s, char *outbuf, int size, int charset);
char *ustrtoa_careful(wchar_t const *s, char *outbuf, int size, int charset);
wchar_t *ustrfroma(char const *s, wchar_t *outbuf, int size, int charset);
char *utoa_dup(wchar_t const *s, int charset);
char *utoa_dup_len(wchar_t const *s, int charset, int *len);
char *utoa_careful_dup(wchar_t const *s, int charset);
wchar_t *ufroma_dup(char const *s, int charset);
char *utoa_locale_dup(wchar_t const *s);
wchar_t *ufroma_locale_dup(char const *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 *ustrncpy(wchar_t *dest, wchar_t const *source, int n);
wchar_t utolower(wchar_t);
int uisalpha(wchar_t);
int ustrcmp(wchar_t *lhs, wchar_t *rhs);
int ustricmp(wchar_t const *lhs, wchar_t const *rhs);
int ustrnicmp(wchar_t const *lhs, wchar_t const *rhs, int maxlen);
int utoi(wchar_t const *);
double utof(wchar_t const *);
int utob(wchar_t const *);
int uisdigit(wchar_t);
wchar_t *ustrlow(wchar_t *s);
wchar_t *ustrftime(const wchar_t *wfmt, const struct tm *timespec);
int cvt_ok(int charset, const wchar_t *s);
int charset_from_ustr(filepos *fpos, const wchar_t *name);

/*
 * wcwidth.c
 */
int strwid(char const *s, int charset);
int ustrwid(wchar_t const *s, int charset);

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

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

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

/*
 * misc.c
 */
char *adv(char *s);

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);
void rdaddsn(rdstringc *rc, char const *p, int len);
char *rdtrimc(rdstringc *rs);

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

void mark_attr_ends(word *words);

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 *);
void cmdline_cfg_add(paragraph *cfg, char *string);
paragraph *cmdline_cfg_new(void);
paragraph *cmdline_cfg_simple(char *string, ...);

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

/*
 * in_afm.c
 */
void read_afm_file(input *in);

/*
 * in_pf.c
 */
void read_pfa_file(input *in);
void read_pfb_file(input *in);

/*
 * in_sfnt.c
 */
void read_sfnt_file(input *in);

/*
 * 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 *);

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

/*
 * bk_html.c
 */
void html_backend(paragraph *, keywordlist *, indexdata *, void *);
paragraph *html_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 *);
void listfonts(void);

/*
 * 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
e34ba5c3	9	#include "charset.h"
e34ba5c3	10
d7482997	11	#ifdef __GNUC__
	12	#define NORETURN __attribute__((__noreturn__))
	13	#else
	14	#define NORETURN /* nothing */
	15	#endif
	16
	17	#ifndef TRUE
	18	#define TRUE 1
	19	#endif
	20	#ifndef FALSE
	21	#define FALSE 0
	22	#endif
	23
	24	/* For suppressing unused-parameter warnings */
	25	#define IGNORE(x) ( (x) = (x) )
	26
	27	#include "tree234.h"
	28
	29	/*
	30	* Structure tags
	31	*/
	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;
d7482997	38	typedef struct numberstate_Tag numberstate;
	39	typedef struct indexdata_Tag indexdata;
	40	typedef struct indextag_Tag indextag;
	41	typedef struct indexentry_Tag indexentry;
	42	typedef struct macrostack_Tag macrostack;
	43
	44	/*
	45	* Data structure to hold a file name and index, a line and a
	46	* column number, for reporting errors
	47	*/
	48	struct filepos_Tag {
	49	char *filename;
	50	int line, col;
	51	};
	52
	53	/*
	54	* Data structure to hold all the file names etc for input
	55	*/
	56	typedef struct pushback_Tag {
	57	int chr;
	58	filepos pos;
	59	} pushback;
	60	struct input_Tag {
	61	char *filenames; / complete list of input files */
	62	int nfiles; /* how many in the list */
	63	FILE currfp; / the currently open one */
	64	int currindex; /* which one is that in the list */
d26171a6	65	int wantclose; /* does the current file want closing */
d7482997	66	pushback pushback; / pushed-back input characters */
	67	int npushback, pushbacksize;
	68	filepos pos;
	69	int reportcols; /* report column numbers in errors */
	70	macrostack stack; / macro expansions in force */
e34ba5c3	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[] */
e4ea58f8	75	char pushback_chars; / used to save input-encoding data */
d7482997	76	};
	77
	78	/*
	79	* Data structure to hold the input form of the source, ie a linked
	80	* list of paragraphs
	81	*/
	82	struct paragraph_Tag {
	83	paragraph *next;
	84	int type;
	85	wchar_t keyword; / for most special paragraphs */
e4ea58f8	86	char origkeyword; / same again in original charset */
d7482997	87	word words; / list of words in paragraph */
	88	int aux; /* number, in a numbered paragraph
	89	* or subsection level
	90	*/
	91	word kwtext; / chapter/section indication */
	92	word kwtext2; / numeric-only form of kwtext */
	93	filepos fpos;
	94
	95	paragraph parent, child, sibling; / for hierarchy navigation */
	96
	97	void private_data; / for temp use in backends */
	98	};
	99	enum {
	100	para_IM, /* index merge */
	101	para_BR, /* bibliography rewrite */
	102	para_Rule, /* random horizontal rule */
	103	para_Chapter,
	104	para_Appendix,
	105	para_UnnumberedChapter,
	106	para_Heading,
	107	para_Subsect,
	108	para_Normal,
	109	para_Biblio, /* causes no output unless turned ... */
	110	para_BiblioCited, /* ... into this paragraph type */
	111	para_Bullet,
	112	para_NumberedList,
7136a6c7	113	para_DescribedThing,
7136a6c7	114	para_Description,
d7482997	115	para_Code,
d7482997	116	para_Copyright,
d7482997	117	para_NoCite,
	118	para_Title,
	119	para_VersionID,
	120	para_Config, /* configuration directive */
7136a6c7	121	para_LcontPush, /* begin continuation of list item */
7136a6c7	122	para_LcontPop, /* end continuation of list item */
2614b01d	123	para_QuotePush, /* begin block quote */
2614b01d	124	para_QuotePop, /* end block quote */
3f3d1acc	125	/*
	126	* Back ends may define their own paragraph types beyond here,
	127	* in case they need to use them internally.
	128	*/
d7482997	129	para_NotParaType /* placeholder value */
	130	};
	131
	132	/*
	133	* Data structure to hold an individual word
	134	*/
	135	struct word_Tag {
	136	word next, alt;
	137	int type;
	138	int aux;
	139	int breaks; /* can a line break after it? */
	140	wchar_t *text;
	141	filepos fpos;
5dd44dce	142
5dd44dce	143	void private_data; / for temp use in backends */
d7482997	144	};
	145	enum {
	146	/* ORDERING CONSTRAINT: these normal-word types ... */
	147	word_Normal,
	148	word_Emph,
	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) */
3f3d1acc	168	word_HyperEnd, /* (also invisible; no text) */
	169	/*
	170	* Back ends may define their own word types beyond here, in
	171	* case they need to use them internally.
	172	*/
	173	word_NotWordType /* placeholder value */
d7482997	174	};
	175	/* aux values for attributed words */
	176	enum {
	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 */
ee90d1f0	181	attr_mask = 0x0003
d7482997	182	};
	183	/* aux values for quote-type words */
	184	enum {
	185	quote_Open = 0x0010,
	186	quote_Close = 0x0020,
ee90d1f0	187	quote_mask = 0x0030
d7482997	188	};
b9e27ab6	189	#define isvis(x) ( ( (x) >= word_Normal && (x) <= word_LowerXref ) )
d7482997	190	#define isattr(x) ( ( (x) > word_Normal && (x) < word_WhiteSpace ) \|\| \
	191	( (x) > word_WhiteSpace && (x) < word_internal_endattrs ) )
	192	#define sameattr(x,y) ( (((x)-(y)) & 3) == 0 )
	193	#define towordstyle(x) ( word_Normal + ((x) & 3) )
	194	#define tospacestyle(x) ( word_WhiteSpace + ((x) & 3) )
	195	#define toquotestyle(x) ( word_Quote + ((x) & 3) )
	196	#define removeattr(x) ( word_Normal + ((x) &~ 3) )
	197
	198	#define attraux(x) ( (x) & attr_mask )
	199	#define quoteaux(x) ( (x) & quote_mask )
	200
	201	/*
	202	* error.c
	203	*/
05e9c3c2	204	/* out of memory */
	205	void fatalerr_nomemory(void) NORETURN;
	206	/* option `-%s' requires an argument */
	207	void err_optnoarg(const char *sp);
	208	/* unrecognised option `-%s' */
	209	void err_nosuchopt(const char *sp);
	210	/* unrecognised charset %s (cmdline) */
	211	void err_cmdcharset(const char *sp);
	212	/* futile option `-%s'%s */
	213	void err_futileopt(const char sp, const char sp2);
	214	/* no input files */
	215	void err_noinput(void);
	216	/* unable to open input file `%s' */
	217	void err_cantopen(const char *sp);
	218	/* no data in input files */
	219	void err_nodata(void);
	220	/* line in codepara didn't begin `\c' */
	221	void err_brokencodepara(const filepos *fpos);
	222	/* expected `}' after keyword */
	223	void err_kwunclosed(const filepos *fpos);
	224	/* paragraph type expects no keyword */
	225	void err_kwexpected(const filepos *fpos);
	226	/* paragraph type expects a keyword */
	227	void err_kwillegal(const filepos *fpos);
	228	/* paragraph type expects only 1 */
	229	void err_kwtoomany(const filepos *fpos);
	230	/* paragraph type expects only kws! */
	231	void err_bodyillegal(const filepos *fpos);
	232	/* invalid command at start of para */
	233	void err_badparatype(const wchar_t wsp, const filepos fpos);
	234	/* invalid command in mid-para */
	235	void err_badmidcmd(const wchar_t wsp, const filepos fpos);
	236	/* unexpected brace */
	237	void err_unexbrace(const filepos *fpos);
	238	/* expected `{' after command */
	239	void err_explbr(const filepos *fpos);
	240	/* EOF inside braced comment */
	241	void err_commenteof(const filepos *fpos);
	242	/* expected `}' after cross-ref */
	243	void err_kwexprbr(const filepos *fpos);
	244	/* \q within \c is not supported */
	245	void err_codequote(const filepos *fpos);
	246	/* unclosed braces at end of para */
	247	void err_missingrbrace(const filepos *fpos);
	248	/* unclosed braces at end of file */
	249	void err_missingrbrace2(const filepos *fpos);
	250	/* unable to nest text styles */
	251	void err_nestedstyles(const filepos *fpos);
	252	/* unable to nest `\i' thingys */
	253	void err_nestedindex(const filepos *fpos);
	254	/* two \i differing only in case */
	255	void err_indexcase(const filepos fpos, const wchar_t wsp,
	256	const filepos fpos2, const wchar_t wsp2);
	257	/* unresolved cross-reference */
	258	void err_nosuchkw(const filepos fpos, const wchar_t wsp);
	259	/* multiple \BRs on same keyword */
	260	void err_multiBR(const filepos fpos, const wchar_t wsp);
	261	/* \IM on unknown index tag (warning) */
	262	void err_nosuchidxtag(const filepos fpos, const wchar_t wsp);
	263	/* can't open output file for write */
	264	void err_cantopenw(const char *sp);
	265	/* this macro already exists */
	266	void err_macroexists(const filepos fpos, const wchar_t wsp);
	267	/* jump a heading level, eg \C -> \S */
268	void err_sectjump(const filepos *fpos);
269	/* WinHelp context ID hash clash */
270	void err_winhelp_ctxclash(const filepos fpos, const char sp, const char *sp2);
271	/* keyword clash in sections */
272	void err_multikw(const filepos fpos, const filepos fpos2, const wchar_t *wsp);
273	/* \lcont not after a list item */
274	void err_misplacedlcont(const filepos *fpos);
275	/* section marker appeared in block */
276	void err_sectmarkerinblock(const filepos fpos, const char sp);
277	/* \cfg{%s} insufficient args (<%d) */
278	void err_cfginsufarg(const filepos fpos, const char sp, int i);
279	/* colon/comma in node name in info */
280	void err_infonodechar(const filepos fpos, char c) / fpos might be NULL */;
281	/* \c line too long in text backend */
282	void err_text_codeline(const filepos *fpos, int i, int j);
283	/* unrecognised HTML version keyword */
284	void err_htmlver(const filepos fpos, const wchar_t wsp);
285	/* unrecognised character set name */
286	void err_charset(const filepos fpos, const wchar_t wsp);
287	/* unrecognised font name */
288	void err_nofont(const filepos fpos, const wchar_t wsp);
289	/* eof in AFM file */
290	void err_afmeof(const filepos *fpos);
291	/* missing expected keyword in AFM */
292	void err_afmkey(const filepos fpos, const char sp);
293	/* unsupported AFM version */
294	void err_afmvers(const filepos *fpos);
295	/* missing value(s) for AFM key */
296	void err_afmval(const filepos fpos, const char sp, int i);
297	/* eof in Type 1 font file */
298	void err_pfeof(const filepos *fpos);
299	/* bad Type 1 header line */
300	void err_pfhead(const filepos *fpos);
301	/* otherwise invalide Type 1 font */
302	void err_pfbad(const filepos *fpos);
303	/* Type 1 font but no AFM */
304	void err_pfnoafm(const filepos fpos, const char sp);
305	/* need both or neither of hhp+chm */
306	void err_chmnames(void);
307	/* required sfnt table missing */
308	void err_sfntnotable(const filepos fpos, const char sp);
309	/* sfnt has no PostScript name */
310	void err_sfntnopsname(const filepos *fpos);
311	/* sfnt table not valid */
312	void err_sfntbadtable(const filepos fpos, const char sp);
313	/* sfnt has no UCS-2 cmap */
314	void err_sfntnounicmap(const filepos *fpos);
315	/* sfnt table version unknown */
316	void err_sfnttablevers(const filepos fpos, const char sp);
317	/* sfnt has bad header */
318	void err_sfntbadhdr(const filepos *fpos);
319	/* sfnt cmap references bad glyph */
320	void err_sfntbadglyph(const filepos *fpos, unsigned wc);
d7482997	321
	322	/*
	323	* malloc.c
	324	*/
	325	#ifdef LOGALLOC
	326	void smalloc(char file, int line, int size);
	327	void srealloc(char file, int line, void *p, int size);
	328	void sfree(char file, int line, void p);
	329	#define smalloc(x) smalloc(__FILE__, __LINE__, x)
	330	#define srealloc(x, y) srealloc(__FILE__, __LINE__, x, y)
	331	#define sfree(x) sfree(__FILE__, __LINE__, x)
	332	#else
	333	void *smalloc(int size);
	334	void srealloc(void p, int size);
	335	void sfree(void *p);
	336	#endif
	337	void free_word_list(word *w);
	338	void free_para_list(paragraph *p);
	339	word dup_word_list(word w);
8333e399	340	char dupstr(char const s);
d7482997	341
f1530049	342	#define snew(type) ( (type *) smalloc (sizeof (type)) )
	343	#define snewn(number, type) ( (type ) smalloc ((number) sizeof (type)) )
	344	#define sresize(array, number, type) \
	345	( (type ) srealloc ((array), (number) sizeof (type)) )
d7482997	346	#define lenof(array) ( sizeof(array) / sizeof(*(array)) )
	347
	348	/*
	349	* ustring.c
	350	*/
e4ea58f8	351	wchar_t ustrdup(wchar_t const s);
	352	char ustrtoa(wchar_t const s, char *outbuf, int size, int charset);
	353	char ustrtoa_careful(wchar_t const s, char *outbuf, int size, int charset);
	354	wchar_t ustrfroma(char const s, wchar_t *outbuf, int size, int charset);
	355	char utoa_dup(wchar_t const s, int charset);
	356	char utoa_dup_len(wchar_t const s, int charset, int *len);
	357	char utoa_careful_dup(wchar_t const s, int charset);
	358	wchar_t ufroma_dup(char const s, int charset);
7e976207	359	char utoa_locale_dup(wchar_t const s);
7e976207	360	wchar_t ufroma_locale_dup(char const s);
5dd44dce	361	int ustrlen(wchar_t const *s);
d7482997	362	wchar_t uadv(wchar_t s);
5dd44dce	363	wchar_t ustrcpy(wchar_t dest, wchar_t const *source);
08e78486	364	wchar_t ustrncpy(wchar_t dest, wchar_t const *source, int n);
d7482997	365	wchar_t utolower(wchar_t);
831da32e	366	int uisalpha(wchar_t);
d7482997	367	int ustrcmp(wchar_t lhs, wchar_t rhs);
78c73085	368	int ustricmp(wchar_t const lhs, wchar_t const rhs);
78c73085	369	int ustrnicmp(wchar_t const lhs, wchar_t const rhs, int maxlen);
dd567011	370	int utoi(wchar_t const *);
	371	double utof(wchar_t const *);
	372	int utob(wchar_t const *);
d7482997	373	int uisdigit(wchar_t);
d7482997	374	wchar_t ustrlow(wchar_t s);
c8422236	375	wchar_t ustrftime(const wchar_t wfmt, const struct tm *timespec);
91f93b94	376	int cvt_ok(int charset, const wchar_t *s);
0960a3d8	377	int charset_from_ustr(filepos fpos, const wchar_t name);
d7482997	378
d7482997	379	/*
e5cd393f	380	* wcwidth.c
	381	*/
	382	int strwid(char const *s, int charset);
	383	int ustrwid(wchar_t const *s, int charset);
	384
	385	/*
d7482997	386	* help.c
	387	*/
	388	void help(void);
	389	void usage(void);
	390	void showversion(void);
f336fa9a	391	void listcharsets(void);
d7482997	392
	393	/*
	394	* licence.c
	395	*/
	396	void licence(void);
	397
	398	/*
	399	* version.c
	400	*/
961ee75b	401	extern const char *const version;
d7482997	402
	403	/*
	404	* misc.c
	405	*/
e4ea58f8	406	char adv(char s);
e4ea58f8	407
d7482997	408	typedef struct stackTag *stack;
	409	stack stk_new(void);
	410	void stk_free(stack);
	411	void stk_push(stack, void *);
	412	void *stk_pop(stack);
7136a6c7	413	void *stk_top(stack);
d7482997	414
	415	typedef struct tagRdstring rdstring;
	416	struct tagRdstring {
	417	int pos, size;
	418	wchar_t *text;
	419	};
	420	typedef struct tagRdstringc rdstringc;
	421	struct tagRdstringc {
	422	int pos, size;
	423	char *text;
	424	};
	425	extern const rdstring empty_rdstring;
	426	extern const rdstringc empty_rdstringc;
	427	void rdadd(rdstring *rs, wchar_t c);
5dd44dce	428	void rdadds(rdstring rs, wchar_t const p);
d7482997	429	wchar_t rdtrim(rdstring rs);
d7482997	430	void rdaddc(rdstringc *rs, char c);
5dd44dce	431	void rdaddsc(rdstringc rs, char const p);
7e2417cc	432	void rdaddsn(rdstringc rc, char const p, int len);
d7482997	433	char rdtrimc(rdstringc rs);
	434
	435	int compare_wordlists(word a, word b);
	436
bb9e7835	437	void mark_attr_ends(word *words);
d7482997	438
	439	typedef struct tagWrappedLine wrappedline;
	440	struct tagWrappedLine {
	441	wrappedline *next;
	442	word begin, end; /* first & last words of line */
	443	int nspaces; /* number of whitespaces in line */
	444	int shortfall; /* how much shorter than max width */
	445	};
43341922	446	wrappedline wrap_para(word , int, int, int ()(void , word ), void , int);
d7482997	447	void wrap_free(wrappedline *);
e4ea58f8	448	void cmdline_cfg_add(paragraph cfg, char string);
	449	paragraph *cmdline_cfg_new(void);
	450	paragraph cmdline_cfg_simple(char string, ...);
d7482997	451
	452	/*
	453	* input.c
	454	*/
	455	paragraph read_input(input in, indexdata *idx);
	456
	457	/*
ba0fe3ec	458	* in_afm.c
	459	*/
	460	void read_afm_file(input *in);
	461
	462	/*
44407fea	463	* in_pf.c
	464	*/
	465	void read_pfa_file(input *in);
3e2dd889	466	void read_pfb_file(input *in);
44407fea	467
44407fea	468	/*
babfe3e2	469	* in_sfnt.c
	470	*/
	471	void read_sfnt_file(input *in);
	472
	473	/*
d7482997	474	* keywords.c
	475	*/
	476	struct keywordlist_Tag {
	477	int nkeywords;
	478	int size;
	479	tree234 keys; / sorted by `key' field */
	480	word *looseends; / non-keyword list element numbers */
	481	int nlooseends;
	482	int looseendssize;
	483	};
	484	struct keyword_Tag {
	485	wchar_t key; / the keyword itself */
	486	word text; / "Chapter 2", "Appendix Q"... */
	487	/* (NB: filepos are not set) */
	488	paragraph para; / the paragraph referenced */
	489	};
	490	keyword kw_lookup(keywordlist , wchar_t *);
	491	keywordlist get_keywords(paragraph );
	492	void free_keywords(keywordlist *);
	493	void subst_keywords(paragraph , keywordlist );
	494
	495	/*
	496	* index.c
	497	*/
	498
	499	/*
	500	* Data structure to hold both sides of the index.
	501	*/
	502	struct indexdata_Tag {
	503	tree234 tags; / holds type `indextag' */
	504	tree234 entries; / holds type `indexentry' */
	505	};
	506
	507	/*
	508	* Data structure to hold an index tag (LHS of index).
	509	*/
	510	struct indextag_Tag {
	511	wchar_t *name;
	512	word *implicit_text;
f4551933	513	filepos implicit_fpos;
d7482997	514	word **explicit_texts;
f4551933	515	filepos *explicit_fpos;
d7482997	516	int nexplicit, explicit_size;
	517	int nrefs;
	518	indexentry *refs; / array of entries referenced by tag */
	519	};
	520
	521	/*
	522	* Data structure to hold an index entry (RHS of index).
	523	*/
	524	struct indexentry_Tag {
	525	word *text;
	526	void backend_data; / private to back end */
f4551933	527	filepos fpos;
d7482997	528	};
	529
	530	indexdata *make_index(void);
	531	void cleanup_index(indexdata *);
	532	/* index_merge takes responsibility for freeing arg 3 iff implicit; never
	533	* takes responsibility for arg 2 */
f4551933	534	void index_merge(indexdata , int is_explicit, wchar_t , word , filepos );
d7482997	535	void build_index(indexdata *);
	536	void index_debug(indexdata *);
	537	indextag index_findtag(indexdata idx, wchar_t *name);
	538
	539	/*
	540	* contents.c
	541	*/
	542	numberstate *number_init(void);
	543	void number_cfg(numberstate , paragraph );
96f3af16	544	word number_mktext(numberstate , paragraph , wchar_t , int , int );
d7482997	545	void number_free(numberstate *);
	546
	547	/*
	548	* biblio.c
	549	*/
	550	void gen_citations(paragraph , keywordlist );
	551
	552	/*
d7482997	553	* bk_text.c
d7482997	554	*/
43341922	555	void text_backend(paragraph , keywordlist , indexdata , void );
ba9c1487	556	paragraph text_config_filename(char filename);
d7482997	557
d7482997	558	/*
78c73085	559	* bk_html.c
d7482997	560	*/
78c73085	561	void html_backend(paragraph , keywordlist , indexdata , void );
78c73085	562	paragraph html_config_filename(char filename);
d7482997	563
	564	/*
	565	* bk_whlp.c
	566	*/
43341922	567	void whlp_backend(paragraph , keywordlist , indexdata , void );
ba9c1487	568	paragraph whlp_config_filename(char filename);
d7482997	569
7136a6c7	570	/*
	571	* bk_man.c
	572	*/
43341922	573	void man_backend(paragraph , keywordlist , indexdata , void );
ba9c1487	574	paragraph man_config_filename(char filename);
7136a6c7	575
5dd44dce	576	/*
	577	* bk_info.c
	578	*/
43341922	579	void info_backend(paragraph , keywordlist , indexdata , void );
5dd44dce	580	paragraph info_config_filename(char filename);
5dd44dce	581
43341922	582	/*
	583	* bk_paper.c
	584	*/
	585	void paper_pre_backend(paragraph , keywordlist , indexdata );
62a4b06b	586	void listfonts(void);
43341922	587
	588	/*
	589	* bk_ps.c
	590	*/
	591	void ps_backend(paragraph , keywordlist , indexdata , void );
	592	paragraph ps_config_filename(char filename);
	593
	594	/*
	595	* bk_pdf.c
	596	*/
	597	void pdf_backend(paragraph , keywordlist , indexdata , void );
	598	paragraph pdf_config_filename(char filename);
	599
d7482997	600	#endif