-/* $Id: mandoc.h,v 1.6 2010/05/24 01:41:31 schwarze Exp $ */
+/* $Id: mandoc.h,v 1.60 2011/03/17 09:16:38 kristaps Exp $ */
/*
- * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
#ifndef MANDOC_H
#define MANDOC_H
-__BEGIN_DECLS
+#define ASCII_NBRSP 31 /* non-breaking space */
+#define ASCII_HYPH 30 /* breakable hyphen */
+/*
+ * Status level. This refers to both internal status (i.e., whilst
+ * running, when warnings/errors are reported) and an indicator of a
+ * threshold of when to halt (when said internal state exceeds the
+ * threshold).
+ */
+enum mandoclevel {
+ MANDOCLEVEL_OK = 0,
+ MANDOCLEVEL_RESERVED,
+ MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
+ MANDOCLEVEL_ERROR, /* input has been thrown away */
+ MANDOCLEVEL_FATAL, /* input is borked */
+ MANDOCLEVEL_BADARG, /* bad argument in invocation */
+ MANDOCLEVEL_SYSERR, /* system error */
+ MANDOCLEVEL_MAX
+};
+
+/*
+ * All possible things that can go wrong within a parse, be it libroff,
+ * libmdoc, or libman.
+ */
enum mandocerr {
MANDOCERR_OK,
- MANDOCERR_UPPERCASE, /* text should be uppercase */
- MANDOCERR_SECOOO, /* sections out of conentional order */
- MANDOCERR_SECREP, /* section name repeats */
- MANDOCERR_PROLOGOOO, /* out of order prologue */
- MANDOCERR_PROLOGREP, /* repeated prologue entry */
- MANDOCERR_LISTFIRST, /* list type must come first */
- MANDOCERR_COLUMNS, /* column syntax is inconsistent */
- MANDOCERR_BADSTANDARD, /* bad standard */
- MANDOCERR_BADLIB, /* bad library */
- MANDOCERR_BADESCAPE, /* bad escape sequence */
- MANDOCERR_BADQUOTE, /* unterminated quoted string */
- MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
- MANDOCERR_WIDTHARG, /* superfluous width argument */
- MANDOCERR_BADDATE, /* bad date argument */
- MANDOCERR_BADWIDTH, /* bad width argument */
- MANDOCERR_BADMSEC, /* unknown manual sction */
- MANDOCERR_SECMSEC, /* section not in conventional manual section */
- MANDOCERR_EOLNSPACE, /* end of line whitespace */
- MANDOCERR_SCOPEEXIT, /* scope open on exit */
-#define MANDOCERR_WARNING MANDOCERR_SCOPEEXIT
- MANDOCERR_NAMESECFIRST, /* NAME section must come first */
- MANDOCERR_BADBOOL, /* bad Boolean value */
- MANDOCERR_CHILD, /* child violates parent syntax */
- MANDOCERR_BADATT, /* bad AT&T symbol */
- MANDOCERR_LISTREP, /* list type repeated */
- MANDOCERR_DISPREP, /* display type repeated */
- MANDOCERR_ARGVREP, /* argument repeated */
- MANDOCERR_NONAME, /* manual name not yet set */
- MANDOCERR_MACROOBS, /* obsolete macro ignored */
- MANDOCERR_MACROEMPTY, /* empty macro ignored */
- MANDOCERR_BADBODY, /* macro not allowed in body */
+ MANDOCERR_WARNING, /* ===== start of warnings ===== */
+
+ /* related to the prologue */
+ MANDOCERR_NOTITLE, /* no title in document */
+ MANDOCERR_UPPERCASE, /* document title should be all caps */
+ MANDOCERR_BADMSEC, /* unknown manual section */
+ MANDOCERR_NODATE, /* date missing, using today's date */
+ MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */
+ MANDOCERR_PROLOGOOO, /* prologue macros out of order */
+ MANDOCERR_PROLOGREP, /* duplicate prologue macro */
MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
- MANDOCERR_BADCHAR, /* bad character */
+ MANDOCERR_BADBODY, /* macro not allowed in body */
+
+ /* related to document structure */
+ MANDOCERR_SO, /* .so is fragile, better use ln(1) */
+ MANDOCERR_NAMESECFIRST, /* NAME section must come first */
MANDOCERR_BADNAMESEC, /* bad NAME section contents */
- MANDOCERR_NOBLANKLN, /* no blank lines */
- MANDOCERR_NOTEXT, /* no text in this context */
+ MANDOCERR_NONAME, /* manual name not yet set */
+ MANDOCERR_SECOOO, /* sections out of conventional order */
+ MANDOCERR_SECREP, /* duplicate section name */
+ MANDOCERR_SECMSEC, /* section not in conventional manual section */
+
+ /* related to macros and nesting */
+ MANDOCERR_MACROOBS, /* skipping obsolete macro */
+ MANDOCERR_IGNPAR, /* skipping paragraph macro */
+ MANDOCERR_IGNNS, /* skipping no-space macro */
+ MANDOCERR_SCOPENEST, /* blocks badly nested */
+ MANDOCERR_CHILD, /* child violates parent syntax */
+ MANDOCERR_NESTEDDISP, /* nested displays are not portable */
+ MANDOCERR_SCOPEREP, /* already in literal mode */
+
+ /* related to missing macro arguments */
+ MANDOCERR_MACROEMPTY, /* skipping empty macro */
+ MANDOCERR_ARGCWARN, /* argument count wrong */
+ MANDOCERR_DISPTYPE, /* missing display type */
+ MANDOCERR_LISTFIRST, /* list type must come first */
+ MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
+ MANDOCERR_FONTTYPE, /* missing font type */
+ MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */
+
+ /* related to bad macro arguments */
+ MANDOCERR_IGNARGV, /* skipping argument */
+ MANDOCERR_ARGVREP, /* duplicate argument */
+ MANDOCERR_DISPREP, /* duplicate display type */
+ MANDOCERR_LISTREP, /* duplicate list type */
+ MANDOCERR_BADATT, /* unknown AT&T UNIX version */
+ MANDOCERR_BADBOOL, /* bad Boolean value */
+ MANDOCERR_BADFONT, /* unknown font */
+ MANDOCERR_BADSTANDARD, /* unknown standard specifier */
+ MANDOCERR_BADWIDTH, /* bad width argument */
+
+ /* related to plain text */
+ MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
+ MANDOCERR_BADTAB, /* tab in non-literal context */
+ MANDOCERR_EOLNSPACE, /* end of line whitespace */
MANDOCERR_BADCOMMENT, /* bad comment style */
- MANDOCERR_MACRO, /* unknown macro will be lost */
+ MANDOCERR_BADESCAPE, /* unknown escape sequence */
+ MANDOCERR_BADQUOTE, /* unterminated quoted string */
+
+ MANDOCERR_ERROR, /* ===== start of errors ===== */
+
+ /* related to tables */
+ MANDOCERR_TBL, /* bad table syntax */
+ MANDOCERR_TBLOPT, /* bad table option */
+ MANDOCERR_TBLLAYOUT, /* bad table layout */
+ MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
+ MANDOCERR_TBLNODATA, /* no table data cells specified */
+ MANDOCERR_TBLIGNDATA, /* ignore data in cell */
+ MANDOCERR_TBLBLOCK, /* data block still open */
+ MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
+
+ MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
+ MANDOCERR_BADCHAR, /* skipping bad character */
+ MANDOCERR_NAMESC, /* escaped character not allowed in a name */
+ MANDOCERR_NOTEXT, /* skipping text before the first section header */
+ MANDOCERR_MACRO, /* skipping unknown macro */
+ MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
MANDOCERR_LINESCOPE, /* line scope broken */
- MANDOCERR_SCOPE, /* scope broken */
MANDOCERR_ARGCOUNT, /* argument count wrong */
- MANDOCERR_NOSCOPE, /* request scope close w/none open */
- MANDOCERR_SCOPEREP, /* scope already open */
+ MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
+ MANDOCERR_SCOPEBROKEN, /* missing end of block */
+ MANDOCERR_SCOPEEXIT, /* scope open on exit */
+ MANDOCERR_UNAME, /* uname(3) system call failed */
/* FIXME: merge following with MANDOCERR_ARGCOUNT */
MANDOCERR_NOARGS, /* macro requires line argument(s) */
MANDOCERR_NOBODY, /* macro requires body argument(s) */
MANDOCERR_NOARGV, /* macro requires argument(s) */
- MANDOCERR_NOTITLE, /* no title in document */
+ MANDOCERR_LISTTYPE, /* missing list type */
MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
MANDOCERR_BODYLOST, /* body argument(s) will be lost */
-#define MANDOCERR_ERROR MANDOCERR_BODYLOST
- /* FIXME: this should be a MANDOCERR_ERROR */
- MANDOCERR_FONTTYPE, /* missing font type */
- /* FIXME: this should be a MANDOCERR_ERROR */
- MANDOCERR_DISPTYPE, /* missing display type */
- /* FIXME: this should be a MANDOCERR_ERROR */
- MANDOCERR_LISTTYPE, /* missing list type */
- /* FIXME: this should be a MANDOCERR_ERROR */
- MANDOCERR_NESTEDDISP, /* displays may not be nested */
- MANDOCERR_SYNTNOSCOPE, /* request scope close w/none open */
- MANDOCERR_SYNTSCOPE, /* scope broken, syntax violated */
+ MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
+
+ MANDOCERR_COLUMNS, /* column syntax is inconsistent */
+ MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
MANDOCERR_SYNTCHILD, /* child violates parent syntax */
MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
+ MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
MANDOCERR_NODOCBODY, /* no document body */
MANDOCERR_NODOCPROLOG, /* no document prologue */
- MANDOCERR_UTSNAME, /* utsname() system call failed */
- MANDOCERR_MEM, /* memory exhausted */
-#define MANDOCERR_FATAL MANDOCERR_MEM
-
+ MANDOCERR_MEM, /* static buffer exhausted */
MANDOCERR_MAX
};
-typedef int (*mandocmsg)(enum mandocerr,
- void *, int, int, const char *);
+struct tbl {
+ char tab; /* cell-separator */
+ char decimal; /* decimal point */
+ int linesize;
+ int opts;
+#define TBL_OPT_CENTRE (1 << 0)
+#define TBL_OPT_EXPAND (1 << 1)
+#define TBL_OPT_BOX (1 << 2)
+#define TBL_OPT_DBOX (1 << 3)
+#define TBL_OPT_ALLBOX (1 << 4)
+#define TBL_OPT_NOKEEP (1 << 5)
+#define TBL_OPT_NOSPACE (1 << 6)
+ int cols; /* number of columns */
+};
+
+enum tbl_headt {
+ TBL_HEAD_DATA, /* plug in data from tbl_dat */
+ TBL_HEAD_VERT, /* vertical spacer */
+ TBL_HEAD_DVERT /* double-vertical spacer */
+};
+
+/*
+ * The head of a table specifies all of its columns. When formatting a
+ * tbl_span, iterate over these and plug in data from the tbl_span when
+ * appropriate, using tbl_cell as a guide to placement.
+ */
+struct tbl_head {
+ enum tbl_headt pos;
+ int ident; /* 0 <= unique id < cols */
+ struct tbl_head *next;
+ struct tbl_head *prev;
+};
+
+enum tbl_cellt {
+ TBL_CELL_CENTRE, /* c, C */
+ TBL_CELL_RIGHT, /* r, R */
+ TBL_CELL_LEFT, /* l, L */
+ TBL_CELL_NUMBER, /* n, N */
+ TBL_CELL_SPAN, /* s, S */
+ TBL_CELL_LONG, /* a, A */
+ TBL_CELL_DOWN, /* ^ */
+ TBL_CELL_HORIZ, /* _, - */
+ TBL_CELL_DHORIZ, /* = */
+ TBL_CELL_VERT, /* | */
+ TBL_CELL_DVERT, /* || */
+ TBL_CELL_MAX
+};
+
+/*
+ * A cell in a layout row.
+ */
+struct tbl_cell {
+ struct tbl_cell *next;
+ enum tbl_cellt pos;
+ size_t spacing;
+ int flags;
+#define TBL_CELL_TALIGN (1 << 0) /* t, T */
+#define TBL_CELL_BALIGN (1 << 1) /* d, D */
+#define TBL_CELL_BOLD (1 << 2) /* fB, B, b */
+#define TBL_CELL_ITALIC (1 << 3) /* fI, I, i */
+#define TBL_CELL_EQUAL (1 << 4) /* e, E */
+#define TBL_CELL_UP (1 << 5) /* u, U */
+#define TBL_CELL_WIGN (1 << 6) /* z, Z */
+ struct tbl_head *head;
+};
+
+/*
+ * A layout row.
+ */
+struct tbl_row {
+ struct tbl_row *next;
+ struct tbl_cell *first;
+ struct tbl_cell *last;
+};
+
+enum tbl_datt {
+ TBL_DATA_NONE, /* has no data */
+ TBL_DATA_DATA, /* consists of data/string */
+ TBL_DATA_HORIZ, /* horizontal line */
+ TBL_DATA_DHORIZ, /* double-horizontal line */
+ TBL_DATA_NHORIZ, /* squeezed horizontal line */
+ TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
+};
+
+/*
+ * A cell within a row of data. The "string" field contains the actual
+ * string value that's in the cell. The rest is layout.
+ */
+struct tbl_dat {
+ struct tbl_cell *layout; /* layout cell */
+ int spans; /* how many spans follow */
+ struct tbl_dat *next;
+ char *string; /* data (NULL if not TBL_DATA_DATA) */
+ enum tbl_datt pos;
+};
+
+enum tbl_spant {
+ TBL_SPAN_DATA, /* span consists of data */
+ TBL_SPAN_HORIZ, /* span is horizontal line */
+ TBL_SPAN_DHORIZ /* span is double horizontal line */
+};
+
+/*
+ * A row of data in a table.
+ */
+struct tbl_span {
+ struct tbl *tbl;
+ struct tbl_head *head;
+ struct tbl_row *layout; /* layout row */
+ struct tbl_dat *first;
+ struct tbl_dat *last;
+ int line; /* parse line */
+ int flags;
+#define TBL_SPAN_FIRST (1 << 0)
+#define TBL_SPAN_LAST (1 << 1)
+ enum tbl_spant pos;
+ struct tbl_span *next;
+};
+
+struct eqn {
+ size_t sz;
+ char *data;
+ int line; /* invocation line */
+ int pos; /* invocation position */
+};
+
+/*
+ * Available registers (set in libroff, accessed elsewhere).
+ */
+enum regs {
+ REG_nS = 0,
+ REG__MAX
+};
+
+/*
+ * A register (struct reg) can consist of many types: this consists of
+ * normalised types from the original string form.
+ */
+union regval {
+ unsigned u; /* unsigned integer */
+};
+
+/*
+ * A single register entity. If "set" is zero, the value of the
+ * register should be the default one, which is per-register. It's
+ * assumed that callers know which type in "v" corresponds to which
+ * register value.
+ */
+struct reg {
+ int set; /* whether set or not */
+ union regval v; /* parsed data */
+};
+
+/*
+ * The primary interface to setting register values is in libroff,
+ * although libmdoc and libman from time to time will manipulate
+ * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
+ */
+struct regset {
+ struct reg regs[REG__MAX];
+};
+
+/*
+ * A punctuation delimiter, used only in mdoc(7) documents, is opening,
+ * closing, or "middle mark" punctuation. These govern spacing.
+ * Opening punctuation (e.g., the opening parenthesis) suppresses the
+ * following space; closing punctuation (e.g., the closing parenthesis)
+ * suppresses the leading space; middle punctuation (e.g., the vertical
+ * bar) can do either. The middle punctuation delimiter bends the rules
+ * depending on usage.
+ */
+enum mdelim {
+ DELIM_NONE = 0,
+ DELIM_OPEN,
+ DELIM_MIDDLE,
+ DELIM_CLOSE
+};
+
+typedef int (*mandocmsg)(enum mandocerr, void *,
+ int, int, const char *);
+
+__BEGIN_DECLS
+
+void *mandoc_calloc(size_t, size_t);
+void *mandoc_malloc(size_t);
+void *mandoc_realloc(void *, size_t);
+#define DELIMSZ 6 /* hint: max possible size of a delimiter */
+enum mdelim mandoc_isdelim(const char *);
__END_DECLS
git.ckatri.com / mandoc.git / blobdiff