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

Diff for /mandoc/mandoc.h between version 1.190 and 1.208

version 1.190, 2015/01/27 05:21:44 version 1.208, 2015/11/07 14:01:16
Line 7 
Line 7 
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
Line 65  enum mandocerr {
Line 65  enum mandocerr {
         MANDOCERR_DOC_EMPTY, /* no document body */          MANDOCERR_DOC_EMPTY, /* no document body */
         MANDOCERR_SEC_BEFORE, /* content before first section header: macro */          MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
         MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */          MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
         MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */          MANDOCERR_NAMESEC_NONM, /* NAME section without name */
           MANDOCERR_NAMESEC_NOND, /* NAME section without description */
           MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
           MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
           MANDOCERR_ND_EMPTY, /* missing description line, using "" */
         MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */          MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
         MANDOCERR_SEC_REP, /* duplicate section title: Sh title */          MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
         MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */          MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
Line 82  enum mandocerr {
Line 86  enum mandocerr {
         MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */          MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
         MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */          MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
         MANDOCERR_BL_MOVE, /* moving content out of list: 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_FI_SKIP, /* fill mode already enabled, skipping: fi */
         MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */          MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
         MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */          MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
Line 91  enum mandocerr {
Line 94  enum mandocerr {
         MANDOCERR_REQ_EMPTY, /* skipping empty request: request */          MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
         MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */          MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
         MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */          MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
           MANDOCERR_BLK_EMPTY, /* empty block: macro */
         MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */          MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
         MANDOCERR_ARGCWARN, /* argument count wrong */  
         MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */          MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
         MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */          MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
         MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */          MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
         MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */          MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
           MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
         MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */          MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
         MANDOCERR_IT_NOBODY, /* empty 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_NOFONT, /* missing font type, using \fR: Bf */
         MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */          MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
         MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */          MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
           MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
         MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */          MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
           MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
           MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
         MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */          MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
   
         /* related to bad arguments */          /* related to bad arguments */
Line 112  enum mandocerr {
Line 119  enum mandocerr {
         MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */          MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
         MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */          MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
         MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */          MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
           MANDOCERR_BL_COL, /* wrong number of cells */
         MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */          MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
         MANDOCERR_FA_COMMA, /* comma in function argument: arg */          MANDOCERR_FA_COMMA, /* comma in function argument: arg */
         MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */          MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
         MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */          MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
         MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */          MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
         MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */          MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
           MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
   
         /* related to plain text */          /* related to plain text */
         MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */          MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
Line 134  enum mandocerr {
Line 143  enum mandocerr {
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          MANDOCERR_ERROR, /* ===== start of errors ===== */
   
         /* related to equations */  
         MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/  
         MANDOCERR_EQNSCOPE, /* equation scope open on exit */  
         MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */  
         MANDOCERR_EQNEOF, /* unexpected end of equation */  
   
         /* related to tables */          /* related to tables */
         MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */          MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
         MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */          MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
         MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument */          MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
         MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size */          MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
         MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */          MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
         MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */          MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
         MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */          MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
         MANDOCERR_TBLNODATA, /* no table data cells specified */          MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
         MANDOCERR_TBLIGNDATA, /* ignore data in cell */          MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
         MANDOCERR_TBLBLOCK, /* data block still open */          MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
         MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */          MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
   
         /* related to document structure and macros */          /* related to document structure and macros */
         MANDOCERR_FILE, /* cannot open file */          MANDOCERR_FILE, /* cannot open file */
Line 168  enum mandocerr {
Line 171  enum mandocerr {
   
         /* related to request and macro arguments */          /* related to request and macro arguments */
         MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */          MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
         MANDOCERR_ARGCOUNT, /* argument count wrong */  
         MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */          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_BL_NOTYPE, /* missing list type, using -item: Bl */
         MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */          MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
         MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */          MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
Line 186  enum mandocerr {
Line 189  enum mandocerr {
         MANDOCERR_TOOLARGE, /* input too large */          MANDOCERR_TOOLARGE, /* input too large */
         MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */          MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
         MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */          MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
           MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
         MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */          MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
         MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */          MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
         MANDOCERR_TBLEQN, /* eqn in tbl */  
   
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
Line 210  struct tbl_opts {
Line 213  struct tbl_opts {
         int               rvert; /* width of right vertical line */          int               rvert; /* width of right vertical line */
 };  };
   
 /*  
  * 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 {  
         int               ident; /* 0 <= unique id < cols */  
         struct tbl_head  *next;  
         struct tbl_head  *prev;  
 };  
   
 enum    tbl_cellt {  enum    tbl_cellt {
         TBL_CELL_CENTRE, /* c, C */          TBL_CELL_CENTRE, /* c, C */
         TBL_CELL_RIGHT, /* r, R */          TBL_CELL_RIGHT, /* r, R */
Line 242  struct tbl_cell {
Line 234  struct tbl_cell {
         int               vert; /* width of subsequent vertical line */          int               vert; /* width of subsequent vertical line */
         enum tbl_cellt    pos;          enum tbl_cellt    pos;
         size_t            spacing;          size_t            spacing;
           int               col; /* column number, starting from 0 */
         int               flags;          int               flags;
 #define TBL_CELL_TALIGN  (1 << 0) /* t, T */  #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
 #define TBL_CELL_BALIGN  (1 << 1) /* d, D */  #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
Line 251  struct tbl_cell {
Line 244  struct tbl_cell {
 #define TBL_CELL_UP      (1 << 5) /* u, U */  #define TBL_CELL_UP      (1 << 5) /* u, U */
 #define TBL_CELL_WIGN    (1 << 6) /* z, Z */  #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
 #define TBL_CELL_WMAX    (1 << 7) /* x, X */  #define TBL_CELL_WMAX    (1 << 7) /* x, X */
         struct tbl_head  *head;  
 };  };
   
 /*  /*
Line 296  enum tbl_spant {
Line 288  enum tbl_spant {
  */   */
 struct  tbl_span {  struct  tbl_span {
         struct tbl_opts  *opts;          struct tbl_opts  *opts;
         struct tbl_head  *head;  
         struct tbl_row   *layout; /* layout row */          struct tbl_row   *layout; /* layout row */
         struct tbl_dat   *first;          struct tbl_dat   *first;
         struct tbl_dat   *last;          struct tbl_dat   *last;
         struct tbl_span  *prev;          struct tbl_span  *prev;
         struct tbl_span  *next;          struct tbl_span  *next;
         int               line; /* parse line */          int               line; /* parse line */
         int               flags;  
 #define TBL_SPAN_FIRST   (1 << 0)  
 #define TBL_SPAN_LAST    (1 << 1)  
         enum tbl_spant    pos;          enum tbl_spant    pos;
 };  };
   
Line 420  enum mandoc_esc {
Line 408  enum mandoc_esc {
 typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,  typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                         const char *, int, int, const char *);                          const char *, int, int, const char *);
   
 __BEGIN_DECLS  
   
 struct  mparse;  struct  mparse;
 struct  mchars;  struct  roff_man;
 struct  mdoc;  
 struct  man;  
   
 enum mandoc_esc   mandoc_escape(const char **, const char **, int *);  enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
 struct mchars    *mchars_alloc(void);  void              mchars_alloc(void);
 void              mchars_free(struct mchars *);  void              mchars_free(void);
 int               mchars_num2char(const char *, size_t);  int               mchars_num2char(const char *, size_t);
 const char       *mchars_uc2str(int);  const char       *mchars_uc2str(int);
 int               mchars_num2uc(const char *, size_t);  int               mchars_num2uc(const char *, size_t);
 int               mchars_spec2cp(const struct mchars *,  int               mchars_spec2cp(const char *, size_t);
                         const char *, size_t);  const char       *mchars_spec2str(const char *, size_t, size_t *);
 const char       *mchars_spec2str(const struct mchars *,  struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg, const char *);
                         const char *, size_t, size_t *);  
 struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg,  
                         const struct mchars *, const char *);  
 void              mparse_free(struct mparse *);  void              mparse_free(struct mparse *);
 void              mparse_keep(struct mparse *);  void              mparse_keep(struct mparse *);
 enum mandoclevel  mparse_open(struct mparse *, int *, const char *);  enum mandoclevel  mparse_open(struct mparse *, int *, const char *);
Line 447  enum mandoclevel  mparse_readmem(struct mparse *, void
Line 429  enum mandoclevel  mparse_readmem(struct mparse *, void
                         const char *);                          const char *);
 void              mparse_reset(struct mparse *);  void              mparse_reset(struct mparse *);
 void              mparse_result(struct mparse *,  void              mparse_result(struct mparse *,
                         struct mdoc **, struct man **, char **);                          struct roff_man **, char **);
 const char       *mparse_getkeep(const struct mparse *);  const char       *mparse_getkeep(const struct mparse *);
 const char       *mparse_strerror(enum mandocerr);  const char       *mparse_strerror(enum mandocerr);
 const char       *mparse_strlevel(enum mandoclevel);  const char       *mparse_strlevel(enum mandoclevel);
 enum mandoclevel  mparse_wait(struct mparse *);  
   
 __END_DECLS  
Legend:
Removed from v.1.190  
changed lines
  Added in v.1.208
CVSweb