[BACK]Return to mandoc.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.h between version 1.21 and 1.161

version 1.21, 2010/10/02 10:14:37 version 1.161, 2014/10/11 21:14:16
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2010 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   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 19 
Line 20 
   
 #define ASCII_NBRSP      31  /* non-breaking space */  #define ASCII_NBRSP      31  /* non-breaking space */
 #define ASCII_HYPH       30  /* breakable hyphen */  #define ASCII_HYPH       30  /* breakable hyphen */
   #define ASCII_BREAK      29  /* breakable zero-width space */
   
 __BEGIN_DECLS  /*
    * 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 {  enum    mandoclevel {
         MANDOCLEVEL_OK = 0,          MANDOCLEVEL_OK = 0,
         MANDOCLEVEL_RESERVED,          MANDOCLEVEL_RESERVED,
         MANDOCLEVEL_WARNING,          MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
         MANDOCLEVEL_ERROR,          MANDOCLEVEL_ERROR, /* input has been thrown away */
         MANDOCLEVEL_FATAL,          MANDOCLEVEL_FATAL, /* input is borked */
         MANDOCLEVEL_BADARG,          MANDOCLEVEL_BADARG, /* bad argument in invocation */
         MANDOCLEVEL_SYSERR,          MANDOCLEVEL_SYSERR, /* system error */
         MANDOCLEVEL_MAX          MANDOCLEVEL_MAX
 };  };
   
   /*
    * All possible things that can go wrong within a parse, be it libroff,
    * libmdoc, or libman.
    */
 enum    mandocerr {  enum    mandocerr {
         MANDOCERR_OK,          MANDOCERR_OK,
   
         MANDOCERR_WARNING, /* ===== start of warnings ===== */          MANDOCERR_WARNING, /* ===== start of warnings ===== */
         MANDOCERR_UPPERCASE, /* text should be uppercase */  
         MANDOCERR_SECOOO, /* sections out of conventional 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_BADSTANDARD, /* bad standard */  
         MANDOCERR_BADLIB, /* bad library */  
         MANDOCERR_BADTAB, /* tab in non-literal context */  
         MANDOCERR_BADESCAPE, /* bad escape sequence */  
         MANDOCERR_BADQUOTE, /* unterminated quoted string */  
         MANDOCERR_NOWIDTHARG, /* argument requires the width argument */  
         /* FIXME: merge with MANDOCERR_IGNARGV. */  
         MANDOCERR_WIDTHARG, /* superfluous width argument */  
         MANDOCERR_IGNARGV, /* ignoring argument */  
         MANDOCERR_BADDATE, /* bad date argument */  
         MANDOCERR_BADWIDTH, /* bad width argument */  
         MANDOCERR_BADMSEC, /* unknown manual section */  
         MANDOCERR_SECMSEC, /* section not in conventional manual section */  
         MANDOCERR_EOLNSPACE, /* end of line whitespace */  
         MANDOCERR_SCOPENEST, /* blocks badly nested */  
   
           /* 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_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_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 */
           MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
           MANDOCERR_DOC_EMPTY, /* no document body */
           MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
           MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
           MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */
           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_PAR_SKIP, /* skipping paragraph macro: macro ... */
           MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
           MANDOCERR_NS_SKIP, /* skipping no-space macro */
           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_VT_CHILD, /* .Vt block has child macro: macro */
           MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
           MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
           MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
   
           /* related to missing arguments */
           MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
           MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
           MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
           MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
           MANDOCERR_ARGCWARN, /* argument count wrong */
           MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
           MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
           MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
           MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
           MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
           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_ARG_STD, /* missing -std argument, adding it: macro */
   
           /* 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 */
           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 */
   
           /* 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_COMMENT_BAD, /* bad comment style */
           MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
           MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          MANDOCERR_ERROR, /* ===== start of errors ===== */
         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_BADPROLOG, /* macro not allowed in prologue */  
         MANDOCERR_BADCHAR, /* bad character */  
         MANDOCERR_BADNAMESEC, /* bad NAME section contents */  
         MANDOCERR_NOBLANKLN, /* no blank lines */  
         MANDOCERR_NOTEXT, /* no text in this context */  
         MANDOCERR_BADCOMMENT, /* bad comment style */  
         MANDOCERR_MACRO, /* unknown macro will be lost */  
         MANDOCERR_LINESCOPE, /* line scope broken */  
         MANDOCERR_ARGCOUNT, /* argument count wrong */  
         MANDOCERR_NOSCOPE, /* no such block is open */  
         MANDOCERR_SCOPEREP, /* scope already open */  
         MANDOCERR_SCOPEEXIT, /* scope open on exit */  
         /* 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_DISPTYPE, /* missing display type */  
         MANDOCERR_FONTTYPE, /* missing font type */  
         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */  
         MANDOCERR_BODYLOST, /* body argument(s) will be lost */  
         MANDOCERR_IGNPAR, /* paragraph macro ignored */  
   
         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */          /* related to equations */
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */          MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
         /* FIXME: this should be a MANDOCERR_ERROR */          MANDOCERR_EQNSCOPE, /* equation scope open on exit */
         MANDOCERR_NESTEDDISP, /* displays may not be nested */          MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
         MANDOCERR_BADDISP, /* unsupported display type */          MANDOCERR_EQNEOF, /* unexpected end of equation */
         MANDOCERR_SCOPEFATAL, /* blocks badly nested */          MANDOCERR_EQNSYNT, /* equation syntax error */
         MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */  
         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_NODOCBODY, /* no document body */  
         MANDOCERR_NODOCPROLOG, /* no document prologue */  
         MANDOCERR_UTSNAME, /* utsname system call failed */  
         MANDOCERR_MEM, /* static buffer exhausted */  
         MANDOCERR_MAX  
 };  
   
 enum    regs {          /* related to tables */
         REG_nS = 0,     /* register: nS */          MANDOCERR_TBL, /* bad table syntax */
         REG__MAX          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 */
   
 enum    mant {          /* related to document structure and macros */
         MAN_br = 0,          MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
         MAN_TH,          MANDOCERR_BADCHAR, /* skipping bad character: number */
         MAN_SH,          MANDOCERR_MACRO, /* skipping unknown macro: macro */
         MAN_SS,          MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
         MAN_TP,          MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
         MAN_LP,          MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
         MAN_PP,          MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
         MAN_P,          MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
         MAN_IP,  
         MAN_HP,  
         MAN_SM,  
         MAN_SB,  
         MAN_BI,  
         MAN_IB,  
         MAN_BR,  
         MAN_RB,  
         MAN_R,  
         MAN_B,  
         MAN_I,  
         MAN_IR,  
         MAN_RI,  
         MAN_na,  
         MAN_i,  
         MAN_sp,  
         MAN_nf,  
         MAN_fi,  
         MAN_r,  
         MAN_RE,  
         MAN_RS,  
         MAN_DT,  
         MAN_UC,  
         MAN_PD,  
         MAN_Sp,  
         MAN_Vb,  
         MAN_Ve,  
         MAN_AT,  
         MAN_in,  
         MAN_MAX  
 };  
   
 enum    man_type {          /* related to request and macro arguments */
         MAN_TEXT,          MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
         MAN_ELEM,          MANDOCERR_ARGCOUNT, /* argument count wrong */
         MAN_ROOT,          MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
         MAN_BLOCK,          MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
         MAN_HEAD,          MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
         MAN_BODY          MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
 };          MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
           MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
           MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
   
 enum    mdoct {          MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
         MDOC_Ap = 0,  
         MDOC_Dd,  
         MDOC_Dt,  
         MDOC_Os,  
         MDOC_Sh,  
         MDOC_Ss,  
         MDOC_Pp,  
         MDOC_D1,  
         MDOC_Dl,  
         MDOC_Bd,  
         MDOC_Ed,  
         MDOC_Bl,  
         MDOC_El,  
         MDOC_It,  
         MDOC_Ad,  
         MDOC_An,  
         MDOC_Ar,  
         MDOC_Cd,  
         MDOC_Cm,  
         MDOC_Dv,  
         MDOC_Er,  
         MDOC_Ev,  
         MDOC_Ex,  
         MDOC_Fa,  
         MDOC_Fd,  
         MDOC_Fl,  
         MDOC_Fn,  
         MDOC_Ft,  
         MDOC_Ic,  
         MDOC_In,  
         MDOC_Li,  
         MDOC_Nd,  
         MDOC_Nm,  
         MDOC_Op,  
         MDOC_Ot,  
         MDOC_Pa,  
         MDOC_Rv,  
         MDOC_St,  
         MDOC_Va,  
         MDOC_Vt,  
         MDOC_Xr,  
         MDOC__A,  
         MDOC__B,  
         MDOC__D,  
         MDOC__I,  
         MDOC__J,  
         MDOC__N,  
         MDOC__O,  
         MDOC__P,  
         MDOC__R,  
         MDOC__T,  
         MDOC__V,  
         MDOC_Ac,  
         MDOC_Ao,  
         MDOC_Aq,  
         MDOC_At,  
         MDOC_Bc,  
         MDOC_Bf,  
         MDOC_Bo,  
         MDOC_Bq,  
         MDOC_Bsx,  
         MDOC_Bx,  
         MDOC_Db,  
         MDOC_Dc,  
         MDOC_Do,  
         MDOC_Dq,  
         MDOC_Ec,  
         MDOC_Ef,  
         MDOC_Em,  
         MDOC_Eo,  
         MDOC_Fx,  
         MDOC_Ms,  
         MDOC_No,  
         MDOC_Ns,  
         MDOC_Nx,  
         MDOC_Ox,  
         MDOC_Pc,  
         MDOC_Pf,  
         MDOC_Po,  
         MDOC_Pq,  
         MDOC_Qc,  
         MDOC_Ql,  
         MDOC_Qo,  
         MDOC_Qq,  
         MDOC_Re,  
         MDOC_Rs,  
         MDOC_Sc,  
         MDOC_So,  
         MDOC_Sq,  
         MDOC_Sm,  
         MDOC_Sx,  
         MDOC_Sy,  
         MDOC_Tn,  
         MDOC_Ux,  
         MDOC_Xc,  
         MDOC_Xo,  
         MDOC_Fo,  
         MDOC_Fc,  
         MDOC_Oo,  
         MDOC_Oc,  
         MDOC_Bk,  
         MDOC_Ek,  
         MDOC_Bt,  
         MDOC_Hf,  
         MDOC_Fr,  
         MDOC_Ud,  
         MDOC_Lb,  
         MDOC_Lp,  
         MDOC_Lk,  
         MDOC_Mt,  
         MDOC_Brq,  
         MDOC_Bro,  
         MDOC_Brc,  
         MDOC__C,  
         MDOC_Es,  
         MDOC_En,  
         MDOC_Dx,  
         MDOC__Q,  
         MDOC_br,  
         MDOC_sp,  
         MDOC__U,  
         MDOC_Ta,  
         MDOC_MAX  
 };  
   
 enum    mdocargt {          MANDOCERR_TOOLARGE, /* input too large */
         MDOC_Split,          MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
         MDOC_Nosplit,          MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
         MDOC_Ragged,          MANDOCERR_SO_FAIL, /* .so request failed */
         MDOC_Unfilled,  
         MDOC_Literal,  
         MDOC_File,  
         MDOC_Offset,  
         MDOC_Bullet,  
         MDOC_Dash,  
         MDOC_Hyphen,  
         MDOC_Item,  
         MDOC_Enum,  
         MDOC_Tag,  
         MDOC_Diag,  
         MDOC_Hang,  
         MDOC_Ohang,  
         MDOC_Inset,  
         MDOC_Column,  
         MDOC_Width,  
         MDOC_Compact,  
         MDOC_Std,  
         MDOC_Filled,  
         MDOC_Words,  
         MDOC_Emphasis,  
         MDOC_Symbolic,  
         MDOC_Nested,  
         MDOC_Centred,  
         MDOC_ARG_MAX  
 };  
   
 enum    mdoc_type {          /* ===== system errors ===== */
         MDOC_TEXT,  
         MDOC_ELEM,  
         MDOC_HEAD,  
         MDOC_TAIL,  
         MDOC_BODY,  
         MDOC_BLOCK,  
         MDOC_ROOT  
 };  
   
 enum    mdoc_sec {          MANDOCERR_SYSDUP, /* cannot dup file descriptor */
         SEC_NONE,          MANDOCERR_SYSEXEC, /* cannot exec */
         SEC_NAME,          MANDOCERR_SYSEXIT, /* gunzip failed with code */
         SEC_LIBRARY,          MANDOCERR_SYSFORK, /* cannot fork */
         SEC_SYNOPSIS,          MANDOCERR_SYSOPEN, /* cannot open file */
         SEC_DESCRIPTION,          MANDOCERR_SYSPIPE, /* cannot open pipe */
         SEC_IMPLEMENTATION,          MANDOCERR_SYSREAD, /* cannot read file */
         SEC_RETURN_VALUES,          MANDOCERR_SYSSIG, /* gunzip died from signal */
         SEC_ENVIRONMENT,          MANDOCERR_SYSSTAT, /* cannot stat file */
         SEC_FILES,          MANDOCERR_SYSWAIT, /* wait failed */
         SEC_EXIT_STATUS,  
         SEC_EXAMPLES,  
         SEC_DIAGNOSTICS,  
         SEC_COMPATIBILITY,  
         SEC_ERRORS,  
         SEC_SEE_ALSO,  
         SEC_STANDARDS,  
         SEC_HISTORY,  
         SEC_AUTHORS,  
         SEC_CAVEATS,  
         SEC_BUGS,  
         SEC_SECURITY,  
         SEC_CUSTOM,  
         SEC__MAX  
 };  
   
 enum    mdoc_endbody {          MANDOCERR_MAX
         ENDBODY_NOT = 0,  
         ENDBODY_SPACE,  
         ENDBODY_NOSPACE  
 };  };
   
 enum    mdoc_list {  struct  tbl_opts {
         LIST__NONE = 0,          char              tab; /* cell-separator */
         LIST_bullet,          char              decimal; /* decimal point */
         LIST_column,          int               linesize;
         LIST_dash,          int               opts;
         LIST_diag,  #define TBL_OPT_CENTRE   (1 << 0)
         LIST_enum,  #define TBL_OPT_EXPAND   (1 << 1)
         LIST_hang,  #define TBL_OPT_BOX      (1 << 2)
         LIST_hyphen,  #define TBL_OPT_DBOX     (1 << 3)
         LIST_inset,  #define TBL_OPT_ALLBOX   (1 << 4)
         LIST_item,  #define TBL_OPT_NOKEEP   (1 << 5)
         LIST_ohang,  #define TBL_OPT_NOSPACE  (1 << 6)
         LIST_tag          int               cols; /* number of columns */
 };  };
   
 enum    mdoc_disp {  /*
         DISP__NONE = 0,   * The head of a table specifies all of its columns.  When formatting a
         DISP_centred,   * tbl_span, iterate over these and plug in data from the tbl_span when
         DISP_ragged,   * appropriate, using tbl_cell as a guide to placement.
         DISP_unfilled,   */
         DISP_filled,  struct  tbl_head {
         DISP_literal          int               ident; /* 0 <= unique id < cols */
           int               vert; /* width of preceding vertical line */
           struct tbl_head  *next;
           struct tbl_head  *prev;
 };  };
   
 enum    mdoc_auth {  enum    tbl_cellt {
         AUTH__NONE = 0,          TBL_CELL_CENTRE, /* c, C */
         AUTH_split,          TBL_CELL_RIGHT, /* r, R */
         AUTH_nosplit          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
 };  };
   
 enum    mdoc_font {  /*
         FONT__NONE = 0,   * A cell in a layout row.
         FONT_Em,   */
         FONT_Li,  struct  tbl_cell {
         FONT_Sy          struct tbl_cell  *next;
           int               vert; /* width of preceding vertical line */
           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;
 };  };
   
 struct  man_meta {  /*
         char            *msec; /* `TH' section (e.g., 1--9) */   * A layout row.
         time_t           date; /* parsed `TH' date */   */
         char            *rawdate; /* raw `TH' date */  struct  tbl_row {
         char            *vol; /* `TH' volume (e.g., KM) */          struct tbl_row   *next;
         char            *title; /* `TH' title (e.g., LS, CAT) */          struct tbl_cell  *first;
         char            *source; /* `TH' source (e.g., GNU) */          struct tbl_cell  *last;
           int               vert; /* trailing vertical line */
 };  };
   
 struct  man_node {  enum    tbl_datt {
         struct man_node *parent;          TBL_DATA_NONE, /* has no data */
         struct man_node *child;          TBL_DATA_DATA, /* consists of data/string */
         struct man_node *next;          TBL_DATA_HORIZ, /* horizontal line */
         struct man_node *prev;          TBL_DATA_DHORIZ, /* double-horizontal line */
         int              nchild;          TBL_DATA_NHORIZ, /* squeezed horizontal line */
         int              line;          TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
         int              pos;  
         enum mant        tok;  
         int              flags;  
 #define MAN_VALID       (1 << 0)  
 #define MAN_ACTED       (1 << 1)  
 #define MAN_EOS         (1 << 2)  
         enum man_type    type;  
         char            *string;  
         struct man_node *head;  
         struct man_node *body;  
 };  };
   
 struct  mdoc_meta {  /*
         char             *msec; /* `Dt' section (e.g., 1--9) */   * A cell within a row of data.  The "string" field contains the actual
         char             *vol; /* `Dt' volume (e.g., LOCAL) */   * string value that's in the cell.  The rest is layout.
         char             *arch; /* `Dt' architecture (e.g., i386) */   */
         time_t            date; /* `Dd' date */  struct  tbl_dat {
         char             *title; /* `Dt' title (e.g., LS, CAT) */          struct tbl_cell  *layout; /* layout cell */
         char             *os; /* `Os' system (e.g., OpenBSD) */          int               spans; /* how many spans follow */
         char             *name; /* leading `Nm' (e.g., ls, cat) */          struct tbl_dat   *next;
           char             *string; /* data (NULL if not TBL_DATA_DATA) */
           enum tbl_datt     pos;
 };  };
   
 struct  mdoc_argv {  enum    tbl_spant {
         enum mdocargt     arg;          TBL_SPAN_DATA, /* span consists of data */
         int               line;          TBL_SPAN_HORIZ, /* span is horizontal line */
         int               pos;          TBL_SPAN_DHORIZ /* span is double horizontal line */
         size_t            sz;  
         char            **value;  
 };  };
   
 struct  mdoc_arg {  /*
         size_t            argc;   * A row of data in a table.
         struct mdoc_argv *argv;   */
         unsigned int      refcnt;  struct  tbl_span {
           struct tbl_opts  *opts;
           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;
 };  };
   
   enum    eqn_boxt {
 struct  mdoc_bd {          EQN_ROOT, /* root of parse tree */
         const char       *offs; /* -offset */          EQN_TEXT, /* text (number, variable, whatever) */
         enum mdoc_disp    type; /* -ragged, etc. */          EQN_SUBEXPR, /* nested `eqn' subexpression */
         int               comp; /* -compact */          EQN_LIST, /* list (braces, etc.) */
           EQN_LISTONE, /* singleton list */
           EQN_PILE, /* vertical pile */
           EQN_MATRIX /* pile of piles */
 };  };
   
 struct  mdoc_bl {  enum    eqn_fontt {
         const char       *width; /* -width */          EQNFONT_NONE = 0,
         const char       *offs; /* -offset */          EQNFONT_ROMAN,
         enum mdoc_list    type; /* -tag, -enum, etc. */          EQNFONT_BOLD,
         int               comp; /* -compact */          EQNFONT_FAT,
         size_t            ncols; /* -column arg count */          EQNFONT_ITALIC,
         const char      **cols; /* -column val ptr */          EQNFONT__MAX
 };  };
   
 struct  mdoc_bf {  enum    eqn_post {
         enum mdoc_font    font; /* font */          EQNPOS_NONE = 0,
           EQNPOS_SUP,
           EQNPOS_SUBSUP,
           EQNPOS_SUB,
           EQNPOS_TO,
           EQNPOS_FROM,
           EQNPOS_FROMTO,
           EQNPOS_OVER,
           EQNPOS_SQRT,
           EQNPOS__MAX
 };  };
   
 struct  mdoc_an {  enum    eqn_pilet {
         enum mdoc_auth    auth; /* -split, etc. */          EQNPILE_NONE = 0,
           EQNPILE_PILE,
           EQNPILE_CPILE,
           EQNPILE_RPILE,
           EQNPILE_LPILE,
           EQNPILE_COL,
           EQNPILE_CCOL,
           EQNPILE_RCOL,
           EQNPILE_LCOL,
           EQNPILE__MAX
 };  };
   
 struct  mdoc_node {   /*
         struct mdoc_node *parent; /* parent AST node */   * A "box" is a parsed mathematical expression as defined by the eqn.7
         struct mdoc_node *child; /* first child AST node */   * grammar.
         struct mdoc_node *next; /* sibling AST node */   */
         struct mdoc_node *prev; /* prior sibling AST node */  struct  eqn_box {
         int               nchild; /* number children */          int               size; /* font size of expression */
         int               line; /* parse line */  #define EQN_DEFSIZE       INT_MIN
         int               pos; /* parse column */          enum eqn_boxt     type; /* type of node */
         enum mdoct        tok; /* tok or MDOC__MAX if none */          struct eqn_box   *first; /* first child node */
         int               flags;          struct eqn_box   *last; /* last child node */
 #define MDOC_VALID       (1 << 0) /* has been validated */          struct eqn_box   *next; /* node sibling */
 #define MDOC_ACTED       (1 << 1) /* has been acted upon */          struct eqn_box   *prev; /* node sibling */
 #define MDOC_EOS         (1 << 2) /* at sentence boundary */          struct eqn_box   *parent; /* node sibling */
 #define MDOC_LINE        (1 << 3) /* first macro/text on line */          char             *text; /* text (or NULL) */
 #define MDOC_SYNPRETTY   (1 << 4) /* SYNOPSIS-style formatting */          char             *left; /* fence left-hand */
 #define MDOC_ENDED       (1 << 5) /* rendering has been ended */          char             *right; /* fence right-hand */
         enum mdoc_type    type; /* AST node type */          char             *top; /* expression over-symbol */
         enum mdoc_sec     sec; /* current named section */          char             *bottom; /* expression under-symbol */
         /* XXX: these can be union'd to shave a few bytes. */          size_t            args; /* arguments in parent */
         struct mdoc_arg  *args;         /* BLOCK/ELEM */          size_t            expectargs; /* max arguments in parent */
         struct mdoc_node *pending;      /* BLOCK */          enum eqn_post     pos; /* position of next box */
         struct mdoc_node *head;         /* BLOCK */          enum eqn_fontt    font; /* font of box */
         struct mdoc_node *body;         /* BLOCK */          enum eqn_pilet    pile; /* equation piling */
         struct mdoc_node *tail;         /* BLOCK */  
         char             *string;       /* TEXT */  
         enum mdoc_endbody end;          /* BODY */  
   
         union {  
                 struct mdoc_an  An;  
                 struct mdoc_bd *Bd;  
                 struct mdoc_bf *Bf;  
                 struct mdoc_bl *Bl;  
         } data;  
 };  };
   
 /*  /*
  * A single register entity.  If "set" is zero, the value of the   * An equation consists of a tree of expressions starting at a given
  * register should be the default one, which is per-register.  It's   * line and position.
  * assumed that callers know which type in "v" corresponds to which  
  * register value.  
  */   */
 struct  reg {  struct  eqn {
         int               set; /* whether set or not */          char             *name; /* identifier (or NULL) */
         union {          struct eqn_box   *root; /* root mathematical expression */
                 unsigned  u; /* unsigned integer */          int               ln; /* invocation line */
         } v;          int               pos; /* invocation position */
 };  };
   
 /*  /*
  * The primary interface to setting register values is in libroff,   * Parse options.
  * although libmdoc and libman from time to time will manipulate  
  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).  
  */   */
 struct  regset {  #define MPARSE_MDOC     1  /* assume -mdoc */
         struct reg        regs[REG__MAX];  #define MPARSE_MAN      2  /* assume -man */
   #define MPARSE_SO       4  /* honour .so requests */
   #define MPARSE_QUICK    8  /* abort the parse early */
   
   enum    mandoc_esc {
           ESCAPE_ERROR = 0, /* bail! unparsable escape */
           ESCAPE_IGNORE, /* escape to be ignored */
           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_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_SKIPCHAR /* skip the next character */
 };  };
   
 /*  typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
  * Callback function for warnings, errors, and fatal errors as they                          const char *, int, int, const char *);
  * occur in the compilers libroff, libmdoc, and libman.  
  */  struct  mparse;
 typedef int             (*mandocmsg)(enum mandocerr, void *,  struct  mchars;
                                 int, int, const char *);  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_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 *);
   void              mparse_free(struct mparse *);
   void              mparse_keep(struct mparse *);
   enum mandoclevel  mparse_open(struct mparse *, int *, const char *,
                           pid_t *);
   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 **, char **);
   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 *, pid_t);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.161
CVSweb