]> git.cameronkatri.com Git - mandoc.git/blobdiff - mandoc.h
When a man(7) document contains unreasonably large numbers for
[mandoc.git] / mandoc.h
index 2192fd2c9220ee6f483b4d5a498541f29eb22a15..a25163add17e4bb5b21d9e20e36203b622968a6e 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,6 +1,6 @@
-/*     $Id: mandoc.h,v 1.151 2014/08/01 17:27:44 schwarze Exp $ */
+/*     $Id: mandoc.h,v 1.177 2014/12/16 23:44:41 schwarze Exp $ */
 /*
- * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
@@ -15,8 +15,6 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifndef MANDOC_H
-#define MANDOC_H
 
 #define ASCII_NBRSP     31  /* non-breaking space */
 #define        ASCII_HYPH       30  /* breakable hyphen */
@@ -49,16 +47,18 @@ enum        mandocerr {
        MANDOCERR_WARNING, /* ===== start of warnings ===== */
 
        /* related to the prologue */
-       MANDOCERR_TH_MISSING, /* missing .TH macro, using "unknown 1" */
+       MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
+       MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
        MANDOCERR_TITLE_CASE, /* lower case character in document title */
+       MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
        MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
-       MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: Dt ... volume */
        MANDOCERR_DATE_MISSING, /* missing date, using today's date */
        MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
-       MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macro */
+       MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
        MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
-       MANDOCERR_PROLOG_BAD, /* incomplete prologue, terminated by: macro */
-       MANDOCERR_PROLOG_ONLY, /* skipping prologue macro in body: macro */
+       MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
+       MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
+       MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
 
        /* related to document structure */
        MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
@@ -69,9 +69,13 @@ enum mandocerr {
        MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
        MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
        MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
+       MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
+       MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
+       MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
 
        /* related to macros and nesting */
        MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
+       MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
        MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
        MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
        MANDOCERR_NS_SKIP, /* skipping no-space macro */
@@ -97,7 +101,9 @@ enum mandocerr {
        MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
        MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
        MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
+       MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
        MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
+       MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
 
        /* related to bad arguments */
        MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
@@ -107,6 +113,8 @@ enum        mandocerr {
        MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
        MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
        MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
+       MANDOCERR_FA_COMMA, /* comma in function argument: arg */
+       MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
        MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
        MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
        MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
@@ -126,7 +134,6 @@ enum        mandocerr {
        MANDOCERR_EQNSCOPE, /* equation scope open on exit */
        MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
        MANDOCERR_EQNEOF, /* unexpected end of equation */
-       MANDOCERR_EQNSYNT, /* equation syntax error */
 
        /* related to tables */
        MANDOCERR_TBL, /* bad table syntax */
@@ -137,6 +144,7 @@ enum        mandocerr {
        MANDOCERR_TBLIGNDATA, /* ignore data in cell */
        MANDOCERR_TBLBLOCK, /* data block still open */
        MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
+       MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
 
        /* related to document structure and macros */
        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
@@ -151,6 +159,7 @@ enum        mandocerr {
        /* related to request and macro arguments */
        MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
        MANDOCERR_ARGCOUNT, /* argument count wrong */
+       MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
        MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
        MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
        MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
@@ -158,19 +167,26 @@ enum      mandocerr {
        MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
        MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
        MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
+       MANDOCERR_DIVZERO, /* divide by zero */
 
        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
 
        MANDOCERR_TOOLARGE, /* input too large */
-       MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
        MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
        MANDOCERR_SO_FAIL, /* .so request failed */
 
        /* ===== system errors ===== */
 
+       MANDOCERR_SYSDUP, /* cannot dup file descriptor */
+       MANDOCERR_SYSEXEC, /* cannot exec */
+       MANDOCERR_SYSEXIT, /* gunzip failed with code */
+       MANDOCERR_SYSFORK, /* cannot fork */
        MANDOCERR_SYSOPEN, /* cannot open file */
-       MANDOCERR_SYSSTAT, /* cannot stat file */
+       MANDOCERR_SYSPIPE, /* cannot open pipe */
        MANDOCERR_SYSREAD, /* cannot read file */
+       MANDOCERR_SYSSIG, /* gunzip died from signal */
+       MANDOCERR_SYSSTAT, /* cannot stat file */
+       MANDOCERR_SYSWAIT, /* wait failed */
 
        MANDOCERR_MAX
 };
@@ -231,6 +247,7 @@ struct      tbl_cell {
 #define        TBL_CELL_EQUAL   (1 << 4) /* e, E */
 #define        TBL_CELL_UP      (1 << 5) /* u, U */
 #define        TBL_CELL_WIGN    (1 << 6) /* z, Z */
+#define        TBL_CELL_WMAX    (1 << 7) /* x, X */
        struct tbl_head  *head;
 };
 
@@ -292,21 +309,10 @@ enum      eqn_boxt {
        EQN_ROOT, /* root of parse tree */
        EQN_TEXT, /* text (number, variable, whatever) */
        EQN_SUBEXPR, /* nested `eqn' subexpression */
-       EQN_LIST, /* subexpressions list */
-       EQN_MATRIX /* matrix subexpression */
-};
-
-enum   eqn_markt {
-       EQNMARK_NONE = 0,
-       EQNMARK_DOT,
-       EQNMARK_DOTDOT,
-       EQNMARK_HAT,
-       EQNMARK_TILDE,
-       EQNMARK_VEC,
-       EQNMARK_DYAD,
-       EQNMARK_BAR,
-       EQNMARK_UNDER,
-       EQNMARK__MAX
+       EQN_LIST, /* list (braces, etc.) */
+       EQN_LISTONE, /* singleton list */
+       EQN_PILE, /* vertical pile */
+       EQN_MATRIX /* pile of piles */
 };
 
 enum   eqn_fontt {
@@ -320,11 +326,14 @@ enum      eqn_fontt {
 
 enum   eqn_post {
        EQNPOS_NONE = 0,
-       EQNPOS_OVER,
        EQNPOS_SUP,
+       EQNPOS_SUBSUP,
        EQNPOS_SUB,
        EQNPOS_TO,
        EQNPOS_FROM,
+       EQNPOS_FROMTO,
+       EQNPOS_OVER,
+       EQNPOS_SQRT,
        EQNPOS__MAX
 };
 
@@ -352,12 +361,16 @@ struct    eqn_box {
        struct eqn_box   *first; /* first child node */
        struct eqn_box   *last; /* last child node */
        struct eqn_box   *next; /* node sibling */
+       struct eqn_box   *prev; /* node sibling */
        struct eqn_box   *parent; /* node sibling */
        char             *text; /* text (or NULL) */
-       char             *left;
-       char             *right;
+       char             *left; /* fence left-hand */
+       char             *right; /* fence right-hand */
+       char             *top; /* expression over-symbol */
+       char             *bottom; /* expression under-symbol */
+       size_t            args; /* arguments in parent */
+       size_t            expectargs; /* max arguments in parent */
        enum eqn_post     pos; /* position of next box */
-       enum eqn_markt    mark; /* a mark about the box */
        enum eqn_fontt    font; /* font of box */
        enum eqn_pilet    pile; /* equation piling */
 };
@@ -380,6 +393,8 @@ struct      eqn {
 #define        MPARSE_MAN      2  /* assume -man */
 #define        MPARSE_SO       4  /* honour .so requests */
 #define        MPARSE_QUICK    8  /* abort the parse early */
+#define        MPARSE_UTF8     16 /* accept UTF-8 input */
+#define        MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
 
 enum   mandoc_esc {
        ESCAPE_ERROR = 0, /* bail! unparsable escape */
@@ -400,28 +415,30 @@ enum      mandoc_esc {
 typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                        const char *, int, int, const char *);
 
+__BEGIN_DECLS
+
 struct mparse;
 struct mchars;
 struct mdoc;
 struct man;
 
-__BEGIN_DECLS
-
 enum mandoc_esc          mandoc_escape(const char **, const char **, int *);
 struct mchars   *mchars_alloc(void);
 void             mchars_free(struct mchars *);
-char             mchars_num2char(const char *, size_t);
+int              mchars_num2char(const char *, size_t);
+const char      *mchars_uc2str(int);
 int              mchars_num2uc(const char *, size_t);
 int              mchars_spec2cp(const struct mchars *,
                        const char *, size_t);
 const char      *mchars_spec2str(const struct mchars *,
                        const char *, size_t, size_t *);
 struct mparse   *mparse_alloc(int, enum mandoclevel, mandocmsg,
-                       const char *);
+                       const struct mchars *, const char *);
 void             mparse_free(struct mparse *);
 void             mparse_keep(struct mparse *);
+enum mandoclevel  mparse_open(struct mparse *, int *, const char *);
 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
-enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
+enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
                        const char *);
 void             mparse_reset(struct mparse *);
 void             mparse_result(struct mparse *,
@@ -429,7 +446,6 @@ void                  mparse_result(struct mparse *,
 const char      *mparse_getkeep(const struct mparse *);
 const char      *mparse_strerror(enum mandocerr);
 const char      *mparse_strlevel(enum mandoclevel);
+enum mandoclevel  mparse_wait(struct mparse *);
 
 __END_DECLS
-
-#endif /*!MANDOC_H*/