mandoc/mandoc.h - diff

Return to mandoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.h between version 1.216 and 1.263

-version 1.216, 2017/05/16 19:06:30
+version 1.263, 2019/07/10 19:39:01
 Line 1
 Line 1
 Line 1
  /*      $Id$ */
  /*
   * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
-  * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
+  * Copyright (c) 2012-2019 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
 Line 14
 Line 14
 Line 14
   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+  *
+  * Error handling, escape sequence, and character utilities.
   */
  #define ASCII_NBRSP      31  /* non-breaking space */
-Line 44  enum mandoclevel {
+Line 46  enum mandoclevel {
 Line 44  enum mandoclevel {
 Line 46  enum mandoclevel {
  enum    mandocerr {
          MANDOCERR_OK,
+         MANDOCERR_BASE, /* ===== start of base system conventions ===== */
+         MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
+         MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */
+         MANDOCERR_ARCH_BAD,  /* unknown architecture: Dt ... arch */
+         MANDOCERR_OS_ARG,  /* operating system explicitly specified: Os ... */
+         MANDOCERR_RCS_MISSING, /* RCS id missing */
+         MANDOCERR_XR_BAD,  /* referenced manual not found: Xr name sec */
          MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
+         MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
+         MANDOCERR_DATE_NORM, /* normalizing date format to: ... */
+         MANDOCERR_TITLE_CASE, /* lower case character in document title */
+         MANDOCERR_RCS_REP, /* duplicate RCS id: ... */
+         MANDOCERR_SEC_TYPO,  /* possible typo in section name: Sh ... */
+         MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
+         MANDOCERR_MACRO_USELESS, /* useless macro: macro */
+         MANDOCERR_BX, /* consider using OS macro: macro */
+         MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */
+         MANDOCERR_ER_REP, /* duplicate errno: Er ... */
+         MANDOCERR_DELIM, /* trailing delimiter: macro ... */
+         MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */
+         MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
+         MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
+         MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */
+         MANDOCERR_FUNC, /* function name without markup: name() */
+         MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
+         MANDOCERR_COMMENT_BAD, /* bad comment style */
          MANDOCERR_WARNING, /* ===== start of warnings ===== */
          /* related to the prologue */
          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_DATE_MISSING, /* missing date, using today's date */
          MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
+         MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */
          MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
-         MANDOCERR_PROLOG_REP, /* duplicate prologue macro: 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 */
-Line 77  enum mandocerr {
+Line 105  enum mandocerr {
 Line 77  enum mandocerr {
 Line 105  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_SELF,  /* cross reference to self: Xr name sec */
          MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
          MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
          MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
-Line 90  enum mandocerr {
+Line 119  enum mandocerr {
 Line 90  enum mandocerr {
 Line 119  enum mandocerr {
          MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
          MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
          MANDOCERR_BL_MOVE, /* moving content out of list: macro */
-         MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
+         MANDOCERR_TA_LINE, /* first macro on line: Ta */
-         MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
          MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
+         MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
          /* related to missing arguments */
          MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
-Line 107  enum mandocerr {
+Line 136  enum mandocerr {
 Line 107  enum mandocerr {
 Line 136  enum mandocerr {
          MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
          MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
          MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
+         MANDOCERR_IT_NOARG, /* missing argument, using next line: Bl -c 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 */
-Line 118  enum mandocerr {
+Line 148  enum mandocerr {
 Line 118  enum mandocerr {
 Line 148  enum mandocerr {
          MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
          /* related to bad arguments */
-         MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
          MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
          MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
          MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
-Line 128  enum mandocerr {
+Line 157  enum mandocerr {
 Line 128  enum mandocerr {
 Line 157  enum mandocerr {
          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_LB_BAD, /* unknown library name: Lb ... */
          MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
          MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
+         MANDOCERR_CHAR_FONT, /* argument contains two font escapes */
          MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
          MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
          /* related to plain text */
          MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
          MANDOCERR_FI_TAB, /* tab in filled text */
-         MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
          MANDOCERR_EOS, /* new sentence, new line */
-         MANDOCERR_COMMENT_BAD, /* bad comment style */
          MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
+         MANDOCERR_ESC_UNDEF, /* undefined escape, printing literally: char */
          MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
          /* related to tables */
-Line 163  enum mandocerr {
+Line 193  enum mandocerr {
 Line 163  enum mandocerr {
 Line 193  enum mandocerr {
          MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
          /* related to document structure and macros */
-         MANDOCERR_FILE, /* cannot open file */
+         MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
+         MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
          MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
          MANDOCERR_CHAR_BAD, /* skipping bad character: number */
          MANDOCERR_MACRO, /* skipping unknown macro: macro */
+         MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */
          MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
          MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
          MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
-Line 177  enum mandocerr {
+Line 209  enum mandocerr {
 Line 177  enum mandocerr {
 Line 209  enum mandocerr {
          /* related to request and macro arguments */
          MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
+         MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */
+         MANDOCERR_ARG_NONUM, /* argument number is not numeric */
          MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
          MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
          MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
+         MANDOCERR_CE_NONUM, /* argument is not numeric, using 1: ce ... */
+         MANDOCERR_CHAR_ARG, /* argument is not a character: char ... */
          MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
          MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
          MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
          MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
+         MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */
          MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
          MANDOCERR_SO_FAIL, /* .so request failed */
          MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
-Line 194  enum mandocerr {
+Line 231  enum mandocerr {
 Line 194  enum mandocerr {
 Line 231  enum mandocerr {
          MANDOCERR_TOOLARGE, /* input too large */
          MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
+         MANDOCERR_ESC_UNSUPP, /* unsupported escape sequence: escape */
          MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
+         MANDOCERR_WHILE_NEST, /* nested .while loops */
+         MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */
+         MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */
+         MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */
          MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
          MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
          MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
-         MANDOCERR_MAX
+         MANDOCERR_BADARG, /* ===== start of bad invocations ===== */
- };
- struct  tbl_opts {
+         MANDOCERR_BADARG_BAD, /* bad argument */
-         char              tab; /* cell-separator */
+         MANDOCERR_BADARG_DUPE, /* duplicate argument */
-         char              decimal; /* decimal point */
+         MANDOCERR_BADVAL, /* does not take a value */
-         int               opts;
+         MANDOCERR_BADVAL_MISS, /* missing argument value */
- #define TBL_OPT_CENTRE   (1 << 0)
+         MANDOCERR_BADVAL_BAD, /* bad argument value */
- #define TBL_OPT_EXPAND   (1 << 1)
+         MANDOCERR_BADVAL_DUPE, /* duplicate argument value */
- #define TBL_OPT_BOX      (1 << 2)
+         MANDOCERR_TAG, /* no such tag */
- #define TBL_OPT_DBOX     (1 << 3)
- #define TBL_OPT_ALLBOX   (1 << 4)
- #define TBL_OPT_NOKEEP   (1 << 5)
- #define TBL_OPT_NOSPACE  (1 << 6)
- #define TBL_OPT_NOWARN   (1 << 7)
-         int               cols; /* number of columns */
-         int               lvert; /* width of left vertical line */
-         int               rvert; /* width of right vertical line */
- };
- enum    tbl_cellt {
+         MANDOCERR_SYSERR, /* ===== start of system errors ===== */
-         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_MAX
- };
- /*
+         MANDOCERR_DUP,
-  * A cell in a layout row.
+         MANDOCERR_EXEC,
-  */
+         MANDOCERR_FDOPEN,
- struct  tbl_cell {
+         MANDOCERR_FFLUSH,
-         struct tbl_cell  *next;
+         MANDOCERR_FORK,
-         int               vert; /* width of subsequent vertical line */
+         MANDOCERR_FSTAT,
-         enum tbl_cellt    pos;
+         MANDOCERR_GETLINE,
-         size_t            spacing;
+         MANDOCERR_GLOB,
-         int               col; /* column number, starting from 0 */
+         MANDOCERR_GZCLOSE,
-         int               flags;
+         MANDOCERR_GZDOPEN,
- #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
+         MANDOCERR_MKSTEMP,
- #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
+         MANDOCERR_OPEN,
- #define TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
+         MANDOCERR_PLEDGE,
- #define TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
+         MANDOCERR_READ,
- #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
+         MANDOCERR_WAIT,
- #define TBL_CELL_UP      (1 << 5) /* u, U */
+         MANDOCERR_WRITE,
- #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
- #define TBL_CELL_WMAX    (1 << 7) /* x, X */
- };
- /*
+         MANDOCERR_MAX
-  * A layout row.
-  */
- struct  tbl_row {
-         struct tbl_row   *next;
-         struct tbl_cell  *first;
-         struct tbl_cell  *last;
-         int               vert; /* width of left vertical line */
  };
- 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_opts  *opts;
-         struct tbl_row   *layout; /* layout row */
-         struct tbl_dat   *first;
-         struct tbl_dat   *last;
-         struct tbl_span  *prev;
-         struct tbl_span  *next;
-         int               line; /* parse line */
-         enum tbl_spant    pos;
- };
- enum    eqn_boxt {
-         EQN_ROOT, /* root of parse tree */
-         EQN_TEXT, /* text (number, variable, whatever) */
-         EQN_SUBEXPR, /* nested `eqn' subexpression */
-         EQN_LIST, /* list (braces, etc.) */
-         EQN_LISTONE, /* singleton list */
-         EQN_PILE, /* vertical pile */
-         EQN_MATRIX /* pile of piles */
- };
- enum    eqn_fontt {
-         EQNFONT_NONE = 0,
-         EQNFONT_ROMAN,
-         EQNFONT_BOLD,
-         EQNFONT_FAT,
-         EQNFONT_ITALIC,
-         EQNFONT__MAX
- };
- enum    eqn_post {
-         EQNPOS_NONE = 0,
-         EQNPOS_SUP,
-         EQNPOS_SUBSUP,
-         EQNPOS_SUB,
-         EQNPOS_TO,
-         EQNPOS_FROM,
-         EQNPOS_FROMTO,
-         EQNPOS_OVER,
-         EQNPOS_SQRT,
-         EQNPOS__MAX
- };
- enum    eqn_pilet {
-         EQNPILE_NONE = 0,
-         EQNPILE_PILE,
-         EQNPILE_CPILE,
-         EQNPILE_RPILE,
-         EQNPILE_LPILE,
-         EQNPILE_COL,
-         EQNPILE_CCOL,
-         EQNPILE_RCOL,
-         EQNPILE_LCOL,
-         EQNPILE__MAX
- };
-  /*
-  * A "box" is a parsed mathematical expression as defined by the eqn.7
-  * grammar.
-  */
- struct  eqn_box {
-         int               size; /* font size of expression */
- #define EQN_DEFSIZE       INT_MIN
-         enum eqn_boxt     type; /* type of node */
-         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; /* 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_fontt    font; /* font of box */
-         enum eqn_pilet    pile; /* equation piling */
- };
- /*
-  * An equation consists of a tree of expressions starting at a given
-  * line and position.
-  */
- struct  eqn {
-         char             *name; /* identifier (or NULL) */
-         struct eqn_box   *root; /* root mathematical expression */
-         int               ln; /* invocation line */
-         int               pos; /* invocation position */
- };
- /*
-  * Parse options.
-  */
- #define MPARSE_MDOC     1  /* assume -mdoc */
- #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 */
+         ESCAPE_UNSUPP, /* unsupported escape; ignore it */
          ESCAPE_IGNORE, /* escape to be ignored */
+         ESCAPE_UNDEF, /* undefined escape; print literal character */
          ESCAPE_SPECIAL, /* a regular special character */
          ESCAPE_FONT, /* a generic font mode */
          ESCAPE_FONTBOLD, /* bold font mode */
          ESCAPE_FONTITALIC, /* italic font mode */
          ESCAPE_FONTBI, /* bold italic font mode */
          ESCAPE_FONTROMAN, /* roman font mode */
+         ESCAPE_FONTCW, /* constant width font mode */
          ESCAPE_FONTPREV, /* previous font mode */
          ESCAPE_NUMBERED, /* a numbered glyph */
          ESCAPE_UNICODE, /* a unicode codepoint */
+         ESCAPE_DEVICE, /* print the output device name */
+         ESCAPE_BREAK, /* break the output line */
          ESCAPE_NOSPACE, /* suppress space if the last on a line */
+         ESCAPE_HORIZ, /* horizontal movement */
+         ESCAPE_HLINE, /* horizontal line drawing */
          ESCAPE_SKIPCHAR, /* skip the next character */
          ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */
  };
- typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
-                         const char *, int, int, const char *);
+ enum mandoc_esc   mandoc_font(const char *, int sz);
- struct  mparse;
- struct  roff_man;
  enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
+ void              mandoc_msg_setoutfile(FILE *);
+ const char       *mandoc_msg_getinfilename(void);
+ void              mandoc_msg_setinfilename(const char *);
+ enum mandocerr    mandoc_msg_getmin(void);
+ void              mandoc_msg_setmin(enum mandocerr);
+ enum mandoclevel  mandoc_msg_getrc(void);
+ void              mandoc_msg_setrc(enum mandoclevel);
+ void              mandoc_msg(enum mandocerr, int, int, const char *, ...)
+                         __attribute__((__format__ (__printf__, 4, 5)));
  void              mchars_alloc(void);
  void              mchars_free(void);
  int               mchars_num2char(const char *, size_t);
-Line 426  const char  *mchars_uc2str(int);
+Line 316  const char  *mchars_uc2str(int);
 Line 426  const char  *mchars_uc2str(int);
 Line 316  const char  *mchars_uc2str(int);
  int               mchars_num2uc(const char *, size_t);
  int               mchars_spec2cp(const char *, size_t);
  const char       *mchars_spec2str(const char *, size_t, size_t *);
- struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg, const char *);
- void              mparse_free(struct mparse *);
- void              mparse_keep(struct mparse *);
- int               mparse_open(struct mparse *, const char *);
- enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
- enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
-                         const char *);
- void              mparse_reset(struct mparse *);
- void              mparse_result(struct mparse *,
-                         struct roff_man **, char **);
- const char       *mparse_getkeep(const struct mparse *);
- const char       *mparse_strerror(enum mandocerr);
- const char       *mparse_strlevel(enum mandoclevel);
- void              mparse_updaterc(struct mparse *, enum mandoclevel *);

CVSweb