mdw@git.distorted.org.uk Git - sgt/halibut/blob - halibut.h

   1 #ifndef HALIBUT_HALIBUT_H
   2 #define HALIBUT_HALIBUT_H
   3
   4 #include <stdio.h>
   5 #include <wchar.h>
   6 #include <time.h>
   7 #include <string.h>
   8
   9 #include "charset.h"
  10
  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;
  38 typedef struct userstyle_Tag userstyle;
  39 typedef struct numberstate_Tag numberstate;
  40 typedef struct indexdata_Tag indexdata;
  41 typedef struct indextag_Tag indextag;
  42 typedef struct indexentry_Tag indexentry;
  43 typedef struct macrostack_Tag macrostack;
  44
  45 /*
  46  * Data structure to hold a file name and index, a line and a
  47  * column number, for reporting errors
  48  */
  49 struct filepos_Tag {
  50     char *filename;
  51     int line, col;
  52 };
  53
  54 /*
  55  * Data structure to hold all the file names etc for input
  56  */
  57 typedef struct pushback_Tag {
  58     int chr;
  59     filepos pos;
  60 } pushback;
  61 struct input_Tag {
  62     char **filenames;                  /* complete list of input files */
  63     int nfiles;                        /* how many in the list */
  64     FILE *currfp;                      /* the currently open one */
  65     int currindex;                     /* which one is that in the list */
  66     pushback *pushback;                /* pushed-back input characters */
  67     int npushback, pushbacksize;
  68     filepos pos;
  69     int reportcols;                    /* report column numbers in errors */
  70     macrostack *stack;                 /* macro expansions in force */
  71     int defcharset, charset;           /* character sets for input files */
  72     charset_state csstate;
  73     wchar_t wc[16];                    /* wide chars from input conversion */
  74     int nwc, wcpos;                    /* size of, and position in, wc[] */
  75     char *pushback_chars;              /* used to save input-encoding data */
  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 */
  86     char *origkeyword;                 /* same again in original charset */
  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,
 113     para_DescribedThing,
 114     para_Description,
 115     para_Code,
 116     para_Copyright,
 117     para_NoCite,
 118     para_Title,
 119     para_VersionID,
 120     para_Config,                       /* configuration directive */
 121     para_LcontPush,                    /* begin continuation of list item */
 122     para_LcontPop,                     /* end continuation of list item */
 123     para_QuotePush,                    /* begin block quote */
 124     para_QuotePop,                     /* end block quote */
 125     /*
 126      * Back ends may define their own paragraph types beyond here,
 127      * in case they need to use them internally.
 128      */
 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;
 142
 143     void *private_data;                /* for temp use in backends */
 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) */
 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 */
 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 */
 181     attr_mask   = 0x0003,
 182 };
 183 /* aux values for quote-type words */
 184 enum {
 185     quote_Open  = 0x0010,
 186     quote_Close = 0x0020,
 187     quote_mask  = 0x0030,
 188 };
 189 #define isattr(x) ( ( (x) > word_Normal && (x) < word_WhiteSpace ) || \
 190                     ( (x) > word_WhiteSpace && (x) < word_internal_endattrs ) )
 191 #define sameattr(x,y) ( (((x)-(y)) & 3) == 0 )
 192 #define towordstyle(x) ( word_Normal + ((x) & 3) )
 193 #define tospacestyle(x) ( word_WhiteSpace + ((x) & 3) )
 194 #define toquotestyle(x) ( word_Quote + ((x) & 3) )
 195 #define removeattr(x) ( word_Normal + ((x) &~ 3) )
 196
 197 #define attraux(x) ( (x) & attr_mask )
 198 #define quoteaux(x) ( (x) & quote_mask )
 199
 200 /*
 201  * error.c
 202  */
 203 void fatal(int code, ...) NORETURN;
 204 void error(int code, ...);
 205 enum {
 206     err_nomemory,                      /* out of memory */
 207     err_optnoarg,                      /* option `-%s' requires an argument */
 208     err_nosuchopt,                     /* unrecognised option `-%s' */
 209     err_noinput,                       /* no input files */
 210     err_cantopen,                      /* unable to open input file `%s' */
 211     err_nodata,                        /* no data in input files */
 212     err_brokencodepara,                /* line in codepara didn't begin `\c' */
 213     err_kwunclosed,                    /* expected `}' after keyword */
 214     err_kwillegal,                     /* paragraph type expects no keyword */
 215     err_kwexpected,                    /* paragraph type expects a keyword */
 216     err_kwtoomany,                     /* paragraph type expects only 1 */
 217     err_bodyillegal,                   /* paragraph type expects only kws! */
 218     err_badparatype,                   /* invalid command at start of para */
 219     err_badmidcmd,                     /* invalid command in mid-para */
 220     err_unexbrace,                     /* unexpected brace */
 221     err_explbr,                        /* expected `{' after command */
 222     err_commenteof,                    /* EOF inside braced comment */
 223     err_kwexprbr,                      /* expected `}' after cross-ref */
 224     err_missingrbrace,                 /* unclosed braces at end of para */
 225     err_missingrbrace2,                /* unclosed braces at end of file */
 226     err_nestedstyles,                  /* unable to nest text styles */
 227     err_nestedindex,                   /* unable to nest `\i' thingys */
 228     err_nosuchkw,                      /* unresolved cross-reference */
 229     err_multiBR,                       /* multiple \BRs on same keyword */
 230     err_nosuchidxtag,                  /* \IM on unknown index tag (warning) */
 231     err_cantopenw,                     /* can't open output file for write */
 232     err_macroexists,                   /* this macro already exists */
 233     err_sectjump,                      /* jump a heading level, eg \C -> \S */
 234     err_winhelp_ctxclash,              /* WinHelp context ID hash clash */
 235     err_multikw,                       /* keyword clash in sections */
 236     err_misplacedlcont,                /* \lcont not after a list item */
 237     err_sectmarkerinblock,             /* section marker appeared in block */
 238     err_infodirentry,                  /* \cfg{info-dir-entry} missing param */
 239     err_infonodechar,                  /* colon/comma in node name in info */
 240     err_text_codeline,                 /* \c line too long in text backend */
 241     err_whatever                       /* random error of another type */
 242 };
 243
 244 /*
 245  * malloc.c
 246  */
 247 #ifdef LOGALLOC
 248 void *smalloc(char *file, int line, int size);
 249 void *srealloc(char *file, int line, void *p, int size);
 250 void sfree(char *file, int line, void *p);
 251 #define smalloc(x) smalloc(__FILE__, __LINE__, x)
 252 #define srealloc(x, y) srealloc(__FILE__, __LINE__, x, y)
 253 #define sfree(x) sfree(__FILE__, __LINE__, x)
 254 #else
 255 void *smalloc(int size);
 256 void *srealloc(void *p, int size);
 257 void sfree(void *p);
 258 #endif
 259 void free_word_list(word *w);
 260 void free_para_list(paragraph *p);
 261 word *dup_word_list(word *w);
 262 char *dupstr(char *s);
 263
 264 #define snew(type) ( (type *) smalloc (sizeof (type)) )
 265 #define snewn(number, type) ( (type *) smalloc ((number) * sizeof (type)) )
 266 #define sresize(array, number, type) \
 267         ( (type *) srealloc ((array), (number) * sizeof (type)) )
 268 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
 269
 270 /*
 271  * ustring.c
 272  */
 273 wchar_t *ustrdup(wchar_t const *s);
 274 char *ustrtoa(wchar_t const *s, char *outbuf, int size, int charset);
 275 char *ustrtoa_careful(wchar_t const *s, char *outbuf, int size, int charset);
 276 wchar_t *ustrfroma(char const *s, wchar_t *outbuf, int size, int charset);
 277 char *utoa_dup(wchar_t const *s, int charset);
 278 char *utoa_dup_len(wchar_t const *s, int charset, int *len);
 279 char *utoa_careful_dup(wchar_t const *s, int charset);
 280 wchar_t *ufroma_dup(char const *s, int charset);
 281 char *utoa_locale_dup(wchar_t const *s);
 282 wchar_t *ufroma_locale_dup(char const *s);
 283 int ustrlen(wchar_t const *s);
 284 wchar_t *uadv(wchar_t *s);
 285 wchar_t *ustrcpy(wchar_t *dest, wchar_t const *source);
 286 wchar_t *ustrncpy(wchar_t *dest, wchar_t const *source, int n);
 287 wchar_t utolower(wchar_t);
 288 int uisalpha(wchar_t);
 289 int ustrcmp(wchar_t *lhs, wchar_t *rhs);
 290 int ustricmp(wchar_t const *lhs, wchar_t const *rhs);
 291 int ustrnicmp(wchar_t const *lhs, wchar_t const *rhs, int maxlen);
 292 int utoi(wchar_t const *);
 293 double utof(wchar_t const *);
 294 int utob(wchar_t const *);
 295 int uisdigit(wchar_t);
 296 wchar_t *ustrlow(wchar_t *s);
 297 wchar_t *ustrftime(const wchar_t *wfmt, const struct tm *timespec);
 298 int cvt_ok(int charset, const wchar_t *s);
 299
 300 /*
 301  * wcwidth.c
 302  */
 303 int strwid(char const *s, int charset);
 304 int ustrwid(wchar_t const *s, int charset);
 305
 306 /*
 307  * help.c
 308  */
 309 void help(void);
 310 void usage(void);
 311 void showversion(void);
 312
 313 /*
 314  * licence.c
 315  */
 316 void licence(void);
 317
 318 /*
 319  * version.c
 320  */
 321 const char *const version;
 322
 323 /*
 324  * misc.c
 325  */
 326 char *adv(char *s);
 327
 328 typedef struct stackTag *stack;
 329 stack stk_new(void);
 330 void stk_free(stack);
 331 void stk_push(stack, void *);
 332 void *stk_pop(stack);
 333 void *stk_top(stack);
 334
 335 typedef struct tagRdstring rdstring;
 336 struct tagRdstring {
 337     int pos, size;
 338     wchar_t *text;
 339 };
 340 typedef struct tagRdstringc rdstringc;
 341 struct tagRdstringc {
 342     int pos, size;
 343     char *text;
 344 };
 345 extern const rdstring empty_rdstring;
 346 extern const rdstringc empty_rdstringc;
 347 void rdadd(rdstring *rs, wchar_t c);
 348 void rdadds(rdstring *rs, wchar_t const *p);
 349 wchar_t *rdtrim(rdstring *rs);
 350 void rdaddc(rdstringc *rs, char c);
 351 void rdaddsc(rdstringc *rs, char const *p);
 352 char *rdtrimc(rdstringc *rs);
 353
 354 int compare_wordlists(word *a, word *b);
 355
 356 void mark_attr_ends(word *words);
 357
 358 typedef struct tagWrappedLine wrappedline;
 359 struct tagWrappedLine {
 360     wrappedline *next;
 361     word *begin, *end;                 /* first & last words of line */
 362     int nspaces;                       /* number of whitespaces in line */
 363     int shortfall;                     /* how much shorter than max width */
 364 };
 365 wrappedline *wrap_para(word *, int, int, int (*)(void *, word *), void *, int);
 366 void wrap_free(wrappedline *);
 367 void cmdline_cfg_add(paragraph *cfg, char *string);
 368 paragraph *cmdline_cfg_new(void);
 369 paragraph *cmdline_cfg_simple(char *string, ...);
 370
 371 /*
 372  * input.c
 373  */
 374 paragraph *read_input(input *in, indexdata *idx);
 375
 376 /*
 377  * keywords.c
 378  */
 379 struct keywordlist_Tag {
 380     int nkeywords;
 381     int size;
 382     tree234 *keys;                     /* sorted by `key' field */
 383     word **looseends;                  /* non-keyword list element numbers */
 384     int nlooseends;
 385     int looseendssize;
 386 };
 387 struct keyword_Tag {
 388     wchar_t *key;                      /* the keyword itself */
 389     word *text;                        /* "Chapter 2", "Appendix Q"... */
 390                                        /* (NB: filepos are not set) */
 391     paragraph *para;                   /* the paragraph referenced */
 392 };
 393 keyword *kw_lookup(keywordlist *, wchar_t *);
 394 keywordlist *get_keywords(paragraph *);
 395 void free_keywords(keywordlist *);
 396 void subst_keywords(paragraph *, keywordlist *);
 397
 398 /*
 399  * index.c
 400  */
 401
 402 /*
 403  * Data structure to hold both sides of the index.
 404  */
 405 struct indexdata_Tag {
 406     tree234 *tags;                     /* holds type `indextag' */
 407     tree234 *entries;                  /* holds type `indexentry' */
 408 };
 409
 410 /*
 411  * Data structure to hold an index tag (LHS of index).
 412  */
 413 struct indextag_Tag {
 414     wchar_t *name;
 415     word *implicit_text;
 416     filepos implicit_fpos;
 417     word **explicit_texts;
 418     filepos *explicit_fpos;
 419     int nexplicit, explicit_size;
 420     int nrefs;
 421     indexentry **refs;                 /* array of entries referenced by tag */
 422 };
 423
 424 /*
 425  * Data structure to hold an index entry (RHS of index).
 426  */
 427 struct indexentry_Tag {
 428     word *text;
 429     void *backend_data;                /* private to back end */
 430     filepos fpos;
 431 };
 432
 433 indexdata *make_index(void);
 434 void cleanup_index(indexdata *);
 435 /* index_merge takes responsibility for freeing arg 3 iff implicit; never
 436  * takes responsibility for arg 2 */
 437 void index_merge(indexdata *, int is_explicit, wchar_t *, word *, filepos *);
 438 void build_index(indexdata *);
 439 void index_debug(indexdata *);
 440 indextag *index_findtag(indexdata *idx, wchar_t *name);
 441
 442 /*
 443  * contents.c
 444  */
 445 numberstate *number_init(void);
 446 void number_cfg(numberstate *, paragraph *);
 447 word *number_mktext(numberstate *, paragraph *, wchar_t *, int *, int *);
 448 void number_free(numberstate *);
 449
 450 /*
 451  * biblio.c
 452  */
 453 void gen_citations(paragraph *, keywordlist *);
 454
 455 /*
 456  * style.c
 457  */
 458 struct userstyle_Tag {
 459 };
 460
 461 /*
 462  * bk_text.c
 463  */
 464 void text_backend(paragraph *, keywordlist *, indexdata *, void *);
 465 paragraph *text_config_filename(char *filename);
 466
 467 /*
 468  * bk_html.c
 469  */
 470 void html_backend(paragraph *, keywordlist *, indexdata *, void *);
 471 paragraph *html_config_filename(char *filename);
 472
 473 /*
 474  * bk_whlp.c
 475  */
 476 void whlp_backend(paragraph *, keywordlist *, indexdata *, void *);
 477 paragraph *whlp_config_filename(char *filename);
 478
 479 /*
 480  * bk_man.c
 481  */
 482 void man_backend(paragraph *, keywordlist *, indexdata *, void *);
 483 paragraph *man_config_filename(char *filename);
 484
 485 /*
 486  * bk_info.c
 487  */
 488 void info_backend(paragraph *, keywordlist *, indexdata *, void *);
 489 paragraph *info_config_filename(char *filename);
 490
 491 /*
 492  * bk_paper.c
 493  */
 494 void *paper_pre_backend(paragraph *, keywordlist *, indexdata *);
 495
 496 /*
 497  * bk_ps.c
 498  */
 499 void ps_backend(paragraph *, keywordlist *, indexdata *, void *);
 500 paragraph *ps_config_filename(char *filename);
 501
 502 /*
 503  * bk_pdf.c
 504  */
 505 void pdf_backend(paragraph *, keywordlist *, indexdata *, void *);
 506 paragraph *pdf_config_filename(char *filename);
 507
 508 #endif