[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.62

version 1.21, 2010/10/02 10:14:37 version 1.62, 2011/03/20 11:41:24
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * 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   * 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 20 
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 */
   
 __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 */          /* related to the prologue */
         MANDOCERR_SECREP, /* section name repeats */          MANDOCERR_NOTITLE, /* no title in document */
         MANDOCERR_PROLOGOOO, /* out of order prologue */          MANDOCERR_UPPERCASE, /* document title should be all caps */
         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_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_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_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 */          MANDOCERR_SECMSEC, /* section not in conventional manual section */
         MANDOCERR_EOLNSPACE, /* end of line whitespace */  
           /* 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_SCOPENEST, /* blocks badly nested */
           MANDOCERR_CHILD, /* child violates parent syntax */
           MANDOCERR_NESTEDDISP, /* nested displays are not portable */
           MANDOCERR_SCOPEREP, /* already in literal mode */
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          /* related to missing macro arguments */
         MANDOCERR_NAMESECFIRST, /* NAME section must come first */          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_BADBOOL, /* bad Boolean value */
         MANDOCERR_CHILD, /* child violates parent syntax */          MANDOCERR_BADFONT, /* unknown font */
         MANDOCERR_BADATT, /* bad AT&T symbol */          MANDOCERR_BADSTANDARD, /* unknown standard specifier */
         MANDOCERR_LISTREP, /* list type repeated */          MANDOCERR_BADWIDTH, /* bad width argument */
         MANDOCERR_DISPREP, /* display type repeated */  
         MANDOCERR_ARGVREP, /* argument repeated */          /* related to plain text */
         MANDOCERR_NONAME, /* manual name not yet set */          MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
         MANDOCERR_MACROOBS, /* obsolete macro ignored */          MANDOCERR_BADTAB, /* tab in non-literal context */
         MANDOCERR_MACROEMPTY, /* empty macro ignored */          MANDOCERR_EOLNSPACE, /* end of line whitespace */
         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_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_LINESCOPE, /* line scope broken */
         MANDOCERR_ARGCOUNT, /* argument count wrong */          MANDOCERR_ARGCOUNT, /* argument count wrong */
         MANDOCERR_NOSCOPE, /* no such block is open */          MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
         MANDOCERR_SCOPEREP, /* scope already open */          MANDOCERR_SCOPEBROKEN, /* missing end of block */
         MANDOCERR_SCOPEEXIT, /* scope open on exit */          MANDOCERR_SCOPEEXIT, /* scope open on exit */
           MANDOCERR_UNAME, /* uname(3) system call failed */
         /* FIXME: merge following with MANDOCERR_ARGCOUNT */          /* FIXME: merge following with MANDOCERR_ARGCOUNT */
         MANDOCERR_NOARGS, /* macro requires line argument(s) */          MANDOCERR_NOARGS, /* macro requires line argument(s) */
         MANDOCERR_NOBODY, /* macro requires body argument(s) */          MANDOCERR_NOBODY, /* macro requires body argument(s) */
         MANDOCERR_NOARGV, /* macro requires argument(s) */          MANDOCERR_NOARGV, /* macro requires argument(s) */
         MANDOCERR_NOTITLE, /* no title in document */  
         MANDOCERR_LISTTYPE, /* missing list type */          MANDOCERR_LISTTYPE, /* missing list type */
         MANDOCERR_DISPTYPE, /* missing display type */  
         MANDOCERR_FONTTYPE, /* missing font type */  
         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */          MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
         MANDOCERR_BODYLOST, /* body argument(s) will be lost */          MANDOCERR_BODYLOST, /* body argument(s) will be lost */
         MANDOCERR_IGNPAR, /* paragraph macro ignored */  
   
         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */          MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
   
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */          MANDOCERR_COLUMNS, /* column syntax is inconsistent */
         /* FIXME: this should be a MANDOCERR_ERROR */          MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
         MANDOCERR_NESTEDDISP, /* displays may not be nested */  
         MANDOCERR_BADDISP, /* unsupported display type */  
         MANDOCERR_SCOPEFATAL, /* blocks badly nested */  
         MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */  
         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */          MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
         MANDOCERR_SYNTCHILD, /* child violates parent syntax */          MANDOCERR_SYNTCHILD, /* child violates parent syntax */
         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
           MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
         MANDOCERR_NODOCBODY, /* no document body */          MANDOCERR_NODOCBODY, /* no document body */
         MANDOCERR_NODOCPROLOG, /* no document prologue */          MANDOCERR_NODOCPROLOG, /* no document prologue */
         MANDOCERR_UTSNAME, /* utsname system call failed */  
         MANDOCERR_MEM, /* static buffer exhausted */          MANDOCERR_MEM, /* static buffer exhausted */
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
   
 enum    regs {  struct  tbl {
         REG_nS = 0,     /* register: nS */          char              tab; /* cell-separator */
         REG__MAX          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    mant {  enum    tbl_headt {
         MAN_br = 0,          TBL_HEAD_DATA, /* plug in data from tbl_dat */
         MAN_TH,          TBL_HEAD_VERT, /* vertical spacer */
         MAN_SH,          TBL_HEAD_DVERT  /* double-vertical spacer */
         MAN_SS,  
         MAN_TP,  
         MAN_LP,  
         MAN_PP,  
         MAN_P,  
         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 {  /*
         MAN_TEXT,   * The head of a table specifies all of its columns.  When formatting a
         MAN_ELEM,   * tbl_span, iterate over these and plug in data from the tbl_span when
         MAN_ROOT,   * appropriate, using tbl_cell as a guide to placement.
         MAN_BLOCK,   */
         MAN_HEAD,  struct  tbl_head {
         MAN_BODY          enum tbl_headt    pos;
           int               ident; /* 0 <= unique id < cols */
           struct tbl_head  *next;
           struct tbl_head  *prev;
 };  };
   
 enum    mdoct {  enum    tbl_cellt {
         MDOC_Ap = 0,          TBL_CELL_CENTRE, /* c, C */
         MDOC_Dd,          TBL_CELL_RIGHT, /* r, R */
         MDOC_Dt,          TBL_CELL_LEFT, /* l, L */
         MDOC_Os,          TBL_CELL_NUMBER, /* n, N */
         MDOC_Sh,          TBL_CELL_SPAN, /* s, S */
         MDOC_Ss,          TBL_CELL_LONG, /* a, A */
         MDOC_Pp,          TBL_CELL_DOWN, /* ^ */
         MDOC_D1,          TBL_CELL_HORIZ, /* _, - */
         MDOC_Dl,          TBL_CELL_DHORIZ, /* = */
         MDOC_Bd,          TBL_CELL_VERT, /* | */
         MDOC_Ed,          TBL_CELL_DVERT, /* || */
         MDOC_Bl,          TBL_CELL_MAX
         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 {  /*
         MDOC_Split,   * A cell in a layout row.
         MDOC_Nosplit,   */
         MDOC_Ragged,  struct  tbl_cell {
         MDOC_Unfilled,          struct tbl_cell  *next;
         MDOC_Literal,          enum tbl_cellt    pos;
         MDOC_File,          size_t            spacing;
         MDOC_Offset,          int               flags;
         MDOC_Bullet,  #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
         MDOC_Dash,  #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
         MDOC_Hyphen,  #define TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
         MDOC_Item,  #define TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
         MDOC_Enum,  #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
         MDOC_Tag,  #define TBL_CELL_UP      (1 << 5) /* u, U */
         MDOC_Diag,  #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
         MDOC_Hang,          struct tbl_head  *head;
         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 {  /*
         MDOC_TEXT,   * A layout row.
         MDOC_ELEM,   */
         MDOC_HEAD,  struct  tbl_row {
         MDOC_TAIL,          struct tbl_row   *next;
         MDOC_BODY,          struct tbl_cell  *first;
         MDOC_BLOCK,          struct tbl_cell  *last;
         MDOC_ROOT  
 };  };
   
 enum    mdoc_sec {  enum    tbl_datt {
         SEC_NONE,          TBL_DATA_NONE, /* has no data */
         SEC_NAME,          TBL_DATA_DATA, /* consists of data/string */
         SEC_LIBRARY,          TBL_DATA_HORIZ, /* horizontal line */
         SEC_SYNOPSIS,          TBL_DATA_DHORIZ, /* double-horizontal line */
         SEC_DESCRIPTION,          TBL_DATA_NHORIZ, /* squeezed horizontal line */
         SEC_IMPLEMENTATION,          TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
         SEC_RETURN_VALUES,  
         SEC_ENVIRONMENT,  
         SEC_FILES,  
         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 {  /*
         ENDBODY_NOT = 0,   * A cell within a row of data.  The "string" field contains the actual
         ENDBODY_SPACE,   * string value that's in the cell.  The rest is layout.
         ENDBODY_NOSPACE   */
   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    mdoc_list {  enum    tbl_spant {
         LIST__NONE = 0,          TBL_SPAN_DATA, /* span consists of data */
         LIST_bullet,          TBL_SPAN_HORIZ, /* span is horizontal line */
         LIST_column,          TBL_SPAN_DHORIZ /* span is double horizontal line */
         LIST_dash,  
         LIST_diag,  
         LIST_enum,  
         LIST_hang,  
         LIST_hyphen,  
         LIST_inset,  
         LIST_item,  
         LIST_ohang,  
         LIST_tag  
 };  };
   
 enum    mdoc_disp {  /*
         DISP__NONE = 0,   * A row of data in a table.
         DISP_centred,   */
         DISP_ragged,  struct  tbl_span {
         DISP_unfilled,          struct tbl       *tbl;
         DISP_filled,          struct tbl_head  *head;
         DISP_literal          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    mdoc_auth {  struct  eqn {
         AUTH__NONE = 0,  
         AUTH_split,  
         AUTH_nosplit  
 };  
   
 enum    mdoc_font {  
         FONT__NONE = 0,  
         FONT_Em,  
         FONT_Li,  
         FONT_Sy  
 };  
   
 struct  man_meta {  
         char            *msec; /* `TH' section (e.g., 1--9) */  
         time_t           date; /* parsed `TH' date */  
         char            *rawdate; /* raw `TH' date */  
         char            *vol; /* `TH' volume (e.g., KM) */  
         char            *title; /* `TH' title (e.g., LS, CAT) */  
         char            *source; /* `TH' source (e.g., GNU) */  
 };  
   
 struct  man_node {  
         struct man_node *parent;  
         struct man_node *child;  
         struct man_node *next;  
         struct man_node *prev;  
         int              nchild;  
         int              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) */  
         char             *vol; /* `Dt' volume (e.g., LOCAL) */  
         char             *arch; /* `Dt' architecture (e.g., i386) */  
         time_t            date; /* `Dd' date */  
         char             *title; /* `Dt' title (e.g., LS, CAT) */  
         char             *os; /* `Os' system (e.g., OpenBSD) */  
         char             *name; /* leading `Nm' (e.g., ls, cat) */  
 };  
   
 struct  mdoc_argv {  
         enum mdocargt     arg;  
         int               line;  
         int               pos;  
         size_t            sz;          size_t            sz;
         char            **value;          char             *data;
           int               line; /* invocation line */
           int               pos; /* invocation position */
 };  };
   
 struct  mdoc_arg {  /*
         size_t            argc;   * Available registers (set in libroff, accessed elsewhere).
         struct mdoc_argv *argv;   */
         unsigned int      refcnt;  enum    regs {
           REG_nS = 0,
           REG__MAX
 };  };
   
   /*
 struct  mdoc_bd {   * A register (struct reg) can consist of many types: this consists of
         const char       *offs; /* -offset */   * normalised types from the original string form.
         enum mdoc_disp    type; /* -ragged, etc. */   */
         int               comp; /* -compact */  union   regval {
           unsigned  u; /* unsigned integer */
 };  };
   
 struct  mdoc_bl {  
         const char       *width; /* -width */  
         const char       *offs; /* -offset */  
         enum mdoc_list    type; /* -tag, -enum, etc. */  
         int               comp; /* -compact */  
         size_t            ncols; /* -column arg count */  
         const char      **cols; /* -column val ptr */  
 };  
   
 struct  mdoc_bf {  
         enum mdoc_font    font; /* font */  
 };  
   
 struct  mdoc_an {  
         enum mdoc_auth    auth; /* -split, etc. */  
 };  
   
 struct  mdoc_node {  
         struct mdoc_node *parent; /* parent AST node */  
         struct mdoc_node *child; /* first child AST node */  
         struct mdoc_node *next; /* sibling AST node */  
         struct mdoc_node *prev; /* prior sibling AST node */  
         int               nchild; /* number children */  
         int               line; /* parse line */  
         int               pos; /* parse column */  
         enum mdoct        tok; /* tok or MDOC__MAX if none */  
         int               flags;  
 #define MDOC_VALID       (1 << 0) /* has been validated */  
 #define MDOC_ACTED       (1 << 1) /* has been acted upon */  
 #define MDOC_EOS         (1 << 2) /* at sentence boundary */  
 #define MDOC_LINE        (1 << 3) /* first macro/text on line */  
 #define MDOC_SYNPRETTY   (1 << 4) /* SYNOPSIS-style formatting */  
 #define MDOC_ENDED       (1 << 5) /* rendering has been ended */  
         enum mdoc_type    type; /* AST node type */  
         enum mdoc_sec     sec; /* current named section */  
         /* XXX: these can be union'd to shave a few bytes. */  
         struct mdoc_arg  *args;         /* BLOCK/ELEM */  
         struct mdoc_node *pending;      /* BLOCK */  
         struct mdoc_node *head;         /* BLOCK */  
         struct mdoc_node *body;         /* BLOCK */  
         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   * A single register entity.  If "set" is zero, the value of the
  * register should be the default one, which is per-register.  It's   * register should be the default one, which is per-register.  It's
Line 523  struct mdoc_node {
Line 300  struct mdoc_node {
  */   */
 struct  reg {  struct  reg {
         int               set; /* whether set or not */          int               set; /* whether set or not */
         union {          union regval      v; /* parsed data */
                 unsigned  u; /* unsigned integer */  
         } v;  
 };  };
   
 /*  /*
Line 538  struct regset {
Line 313  struct regset {
 };  };
   
 /*  /*
  * Callback function for warnings, errors, and fatal errors as they   * A punctuation delimiter, used only in mdoc(7) documents, is opening,
  * occur in the compilers libroff, libmdoc, and libman.   * 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.
  */   */
 typedef int             (*mandocmsg)(enum mandocerr, void *,  enum    mdelim {
                                 int, int, const char *);          DELIM_NONE = 0,
           DELIM_OPEN,
           DELIM_MIDDLE,
           DELIM_CLOSE
   };
   
   /*
    * The type of parse sequence.  This value is usually passed via the
    * mandoc(1) command line of -man and -mdoc.  It's almost exclusively
    * -mandoc but the others have been retained for compatibility.
    */
   enum    mparset {
           MPARSE_AUTO, /* magically determine the document type */
           MPARSE_MDOC, /* assume -mdoc */
           MPARSE_MAN /* assume -man */
   };
   
   typedef void    (*mandocmsg)(enum mandocerr, void *,
                           int, int, const char *);
   typedef int     (*mevt_open)(void *, const char *);
   typedef void    (*mevt_close)(void *, const char *);
   
   struct  mparse;
   struct  mdoc;
   struct  man;
   
   __BEGIN_DECLS
   
   void              mparse_free(struct mparse *);
   void              mparse_reset(struct mparse *);
   struct mparse    *mparse_alloc(enum mparset, mevt_open,
                           mevt_close, mandocmsg, void *);
   void              mparse_setstatus(struct mparse *, enum mandoclevel);
   enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
   void              mparse_result(struct mparse *, struct mdoc **, struct man **);
   
   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  __END_DECLS
   
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.62
CVSweb