The name "struct tbl" was badly misleading for two reasons:

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index d80098e3cca5dae4b395b43cd9fc4ed053c11b89..c86530c4f8f156f0638f33f6c772df3e55caf698 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,6 +1,7 @@
-/*     $Id: mandoc.h,v 1.96 2011/10/06 22:29:12 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.107 2013/05/31 21:37:17 schwarze Exp $ */
 /*
  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2012 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -50,6 +51,7 @@ enum  mandocerr {
        MANDOCERR_NOTITLE, /* no title in document */
        MANDOCERR_UPPERCASE, /* document title should be all caps */
        MANDOCERR_BADMSEC, /* unknown manual section */
+       MANDOCERR_BADVOLARCH, /* unknown manual volume or arch */
        MANDOCERR_NODATE, /* date missing, using today's date */
        MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */
        MANDOCERR_PROLOGOOO, /* prologue macros out of order */
@@ -61,7 +63,6 @@ enum  mandocerr {
        MANDOCERR_SO, /* .so is fragile, better use ln(1) */
        MANDOCERR_NAMESECFIRST, /* NAME section must come first */
        MANDOCERR_BADNAMESEC, /* bad NAME section contents */
-       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 */
@@ -69,6 +70,7 @@ enum  mandocerr {
        /* related to macros and nesting */
        MANDOCERR_MACROOBS, /* skipping obsolete macro */
        MANDOCERR_IGNPAR, /* skipping paragraph macro */
+       MANDOCERR_MOVEPAR, /* moving paragraph macro out of list */
        MANDOCERR_IGNNS, /* skipping no-space macro */
        MANDOCERR_SCOPENEST, /* blocks badly nested */
        MANDOCERR_CHILD, /* child violates parent syntax */
@@ -129,10 +131,12 @@ enum      mandocerr {
        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
        MANDOCERR_BADCHAR, /* skipping bad character */
        MANDOCERR_NAMESC, /* escaped character not allowed in a name */
+       MANDOCERR_NONAME, /* manual name not yet set */
        MANDOCERR_NOTEXT, /* skipping text before the first section header */
        MANDOCERR_MACRO, /* skipping unknown macro */
        MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
        MANDOCERR_ARGCOUNT, /* argument count wrong */
+       MANDOCERR_STRAYTA, /* skipping column outside column list */
        MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
        MANDOCERR_SCOPEBROKEN, /* missing end of block */
        MANDOCERR_SCOPEEXIT, /* scope open on exit */
@@ -150,7 +154,6 @@ enum        mandocerr {
        MANDOCERR_NOTMANUAL, /* manual isn't really a manual */
        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 */
@@ -161,7 +164,7 @@ enum        mandocerr {
        MANDOCERR_MAX
 };
 
-struct tbl {
+struct tbl_opts {
        char              tab; /* cell-separator */
        char              decimal; /* decimal point */
        int               linesize;
@@ -176,20 +179,14 @@ struct    tbl {
        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 */
+       int               vert; /* width of preceding vertical line */
        struct tbl_head  *next;
        struct tbl_head  *prev;
 };
@@ -204,8 +201,6 @@ enum        tbl_cellt {
        TBL_CELL_DOWN, /* ^ */
        TBL_CELL_HORIZ, /* _, - */
        TBL_CELL_DHORIZ, /* = */
-       TBL_CELL_VERT, /* | */
-       TBL_CELL_DVERT, /* || */
        TBL_CELL_MAX
 };
 
@@ -214,6 +209,7 @@ enum        tbl_cellt {
  */
 struct tbl_cell {
        struct tbl_cell  *next;
+       int               vert; /* width of preceding vertical line */
        enum tbl_cellt    pos;
        size_t            spacing;
        int               flags;
@@ -267,7 +263,7 @@ enum        tbl_spant {
  * A row of data in a table.
  */
 struct tbl_span {
-       struct tbl       *tbl;
+       struct tbl_opts  *opts;
        struct tbl_head  *head;
        struct tbl_row   *layout; /* layout row */
        struct tbl_dat   *first;
@@ -387,7 +383,8 @@ enum        mandoc_esc {
        ESCAPE_FONTPREV, /* previous font mode */
        ESCAPE_NUMBERED, /* a numbered glyph */
        ESCAPE_UNICODE, /* a unicode codepoint */
-       ESCAPE_NOSPACE /* suppress space if the last on a line */
+       ESCAPE_NOSPACE, /* suppress space if the last on a line */
+       ESCAPE_SKIPCHAR /* skip the next character */
 };
 
 typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
@@ -410,15 +407,17 @@ struct mchars      *mchars_alloc(void);
 void             mchars_free(struct mchars *);
 char             mchars_num2char(const char *, size_t);
 int              mchars_num2uc(const char *, size_t);
-int              mchars_spec2cp(struct mchars *, 
+int              mchars_spec2cp(const struct mchars *, 
                        const char *, size_t);
-const char      *mchars_spec2str(struct mchars *, 
+const char      *mchars_spec2str(const struct mchars *, 
                        const char *, size_t, size_t *);
-struct mparse   *mparse_alloc(enum mparset, 
-                       enum mandoclevel, mandocmsg, void *);
+struct mparse   *mparse_alloc(enum mparset, enum mandoclevel,
+                       mandocmsg, void *, char *);
 void             mparse_free(struct mparse *);
 void             mparse_keep(struct mparse *);
 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
+enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
+                       const char *);
 void             mparse_reset(struct mparse *);
 void             mparse_result(struct mparse *, 
                        struct mdoc **, struct man **);