summaryrefslogtreecommitdiff
path: root/buttress.h
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2002-08-05 10:31:35 +0000
committerSimon Tatham <anakin@pobox.com>2002-08-05 10:31:35 +0000
commitc478f3d9469c09773097eba89342c311ee70a319 (patch)
treef7b1e1d1ac577b5571bf14fe70af1dced325dccc /buttress.h
parent6758ed90d7c0015752894202138ecbcef35b80a0 (diff)
downloadhalibut-c478f3d9469c09773097eba89342c311ee70a319.zip
halibut-c478f3d9469c09773097eba89342c311ee70a319.tar.gz
halibut-c478f3d9469c09773097eba89342c311ee70a319.tar.bz2
halibut-c478f3d9469c09773097eba89342c311ee70a319.tar.xz
Rename Buttress to Halibut. I _think_ I've caught everything in this pass.
[originally from svn r1800]
Diffstat (limited to 'buttress.h')
-rw-r--r--buttress.h416
1 files changed, 0 insertions, 416 deletions
diff --git a/buttress.h b/buttress.h
deleted file mode 100644
index 6646a81..0000000
--- a/buttress.h
+++ /dev/null
@@ -1,416 +0,0 @@
-#ifndef BUTTRESS_BUTTRESS_H
-#define BUTTRESS_BUTTRESS_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