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

Diff for /mandoc/mandoc.h between version 1.6 and 1.22

version 1.6, 2010/05/24 01:41:31 version 1.22, 2010/10/04 07:01:02
Line 17 
Line 17 
 #ifndef MANDOC_H  #ifndef MANDOC_H
 #define MANDOC_H  #define MANDOC_H
   
 __BEGIN_DECLS  #define ASCII_NBRSP      31  /* non-breaking space */
   #define ASCII_HYPH       30  /* breakable hyphen */
   
   /*
    * 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 {
           MANDOCLEVEL_OK = 0,
           MANDOCLEVEL_RESERVED,
           MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
           MANDOCLEVEL_ERROR, /* input has been thrown away */
           MANDOCLEVEL_FATAL, /* input is borked */
           MANDOCLEVEL_BADARG, /* bad argument in invocation */
           MANDOCLEVEL_SYSERR, /* system error */
           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_UPPERCASE, /* text should be uppercase */          MANDOCERR_UPPERCASE, /* text should be uppercase */
         MANDOCERR_SECOOO, /* sections out of conentional order */          MANDOCERR_SECOOO, /* sections out of conventional order */
         MANDOCERR_SECREP, /* section name repeats */          MANDOCERR_SECREP, /* section name repeats */
         MANDOCERR_PROLOGOOO, /* out of order prologue */          MANDOCERR_PROLOGOOO, /* out of order prologue */
         MANDOCERR_PROLOGREP, /* repeated prologue entry */          MANDOCERR_PROLOGREP, /* repeated prologue entry */
         MANDOCERR_LISTFIRST, /* list type must come first */          MANDOCERR_LISTFIRST, /* list type must come first */
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */  
         MANDOCERR_BADSTANDARD, /* bad standard */          MANDOCERR_BADSTANDARD, /* bad standard */
         MANDOCERR_BADLIB, /* bad library */          MANDOCERR_BADLIB, /* bad library */
           MANDOCERR_BADTAB, /* tab in non-literal context */
         MANDOCERR_BADESCAPE, /* bad escape sequence */          MANDOCERR_BADESCAPE, /* bad escape sequence */
         MANDOCERR_BADQUOTE, /* unterminated quoted string */          MANDOCERR_BADQUOTE, /* unterminated quoted string */
         MANDOCERR_NOWIDTHARG, /* argument requires the width argument */          MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
           /* FIXME: merge with MANDOCERR_IGNARGV. */
         MANDOCERR_WIDTHARG, /* superfluous width argument */          MANDOCERR_WIDTHARG, /* superfluous width argument */
           MANDOCERR_IGNARGV, /* ignoring argument */
         MANDOCERR_BADDATE, /* bad date argument */          MANDOCERR_BADDATE, /* bad date argument */
         MANDOCERR_BADWIDTH, /* bad width argument */          MANDOCERR_BADWIDTH, /* bad width argument */
         MANDOCERR_BADMSEC, /* unknown manual sction */          MANDOCERR_BADMSEC, /* unknown manual section */
         MANDOCERR_SECMSEC, /* section not in conventional manual section */          MANDOCERR_SECMSEC, /* section not in conventional manual section */
         MANDOCERR_EOLNSPACE, /* end of line whitespace */          MANDOCERR_EOLNSPACE, /* end of line whitespace */
         MANDOCERR_SCOPEEXIT, /* scope open on exit */          MANDOCERR_SCOPENEST, /* blocks badly nested */
 #define MANDOCERR_WARNING       MANDOCERR_SCOPEEXIT  
   
           MANDOCERR_ERROR, /* ===== start of errors ===== */
         MANDOCERR_NAMESECFIRST, /* NAME section must come first */          MANDOCERR_NAMESECFIRST, /* NAME section must come first */
         MANDOCERR_BADBOOL, /* bad Boolean value */          MANDOCERR_BADBOOL, /* bad Boolean value */
         MANDOCERR_CHILD, /* child violates parent syntax */          MANDOCERR_CHILD, /* child violates parent syntax */
Line 61  enum mandocerr {
Line 87  enum mandocerr {
         MANDOCERR_BADCOMMENT, /* bad comment style */          MANDOCERR_BADCOMMENT, /* bad comment style */
         MANDOCERR_MACRO, /* unknown macro will be lost */          MANDOCERR_MACRO, /* unknown macro will be lost */
         MANDOCERR_LINESCOPE, /* line scope broken */          MANDOCERR_LINESCOPE, /* line scope broken */
         MANDOCERR_SCOPE, /* scope broken */  
         MANDOCERR_ARGCOUNT, /* argument count wrong */          MANDOCERR_ARGCOUNT, /* argument count wrong */
         MANDOCERR_NOSCOPE, /* request scope close w/none open */          MANDOCERR_NOSCOPE, /* no such block is open */
         MANDOCERR_SCOPEREP, /* scope already open */          MANDOCERR_SCOPEREP, /* scope already open */
           MANDOCERR_SCOPEEXIT, /* scope open on exit */
         /* 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_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_ARGSLOST, /* line argument(s) will be lost */
         MANDOCERR_BODYLOST, /* body argument(s) will be lost */          MANDOCERR_BODYLOST, /* body argument(s) will be lost */
 #define MANDOCERR_ERROR         MANDOCERR_BODYLOST          MANDOCERR_IGNPAR, /* paragraph macro ignored */
   
           MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
           MANDOCERR_COLUMNS, /* column syntax is inconsistent */
         /* FIXME: this should be a MANDOCERR_ERROR */          /* FIXME: this should be a MANDOCERR_ERROR */
         MANDOCERR_FONTTYPE, /* missing font type */  
         /* FIXME: this should be a MANDOCERR_ERROR */  
         MANDOCERR_DISPTYPE, /* missing display type */  
         /* FIXME: this should be a MANDOCERR_ERROR */  
         MANDOCERR_LISTTYPE, /* missing list type */  
         /* FIXME: this should be a MANDOCERR_ERROR */  
         MANDOCERR_NESTEDDISP, /* displays may not be nested */          MANDOCERR_NESTEDDISP, /* displays may not be nested */
         MANDOCERR_SYNTNOSCOPE, /* request scope close w/none open */          MANDOCERR_BADDISP, /* unsupported display type */
         MANDOCERR_SYNTSCOPE, /* scope broken, syntax violated */          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_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_UTSNAME, /* utsname system call failed */
         MANDOCERR_MEM, /* memory exhausted */          MANDOCERR_MEM, /* static buffer exhausted */
 #define MANDOCERR_FATAL         MANDOCERR_MEM  
   
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
   
 typedef int     (*mandocmsg)(enum mandocerr,  /*
                         void *, int, int, const char *);   * Available registers (set in libroff, accessed elsewhere).
    */
   enum    regs {
           REG_nS = 0,
           REG__MAX
   };
   
   /*
    * A register (struct reg) can consist of many types: this consists of
    * normalised types from the original string form.
    */
   union   regval {
           unsigned  u; /* unsigned integer */
   };
   
   /*
    * A single register entity.  If "set" is zero, the value of the
    * register should be the default one, which is per-register.  It's
    * assumed that callers know which type in "v" corresponds to which
    * register value.
    */
   struct  reg {
           int               set; /* whether set or not */
           union regval      v; /* parsed data */
   };
   
   /*
    * The primary interface to setting register values is in libroff,
    * although libmdoc and libman from time to time will manipulate
    * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
    */
   struct  regset {
           struct reg        regs[REG__MAX];
   };
   
   __BEGIN_DECLS
   
   /*
    * Callback function for warnings, errors, and fatal errors as they
    * occur in the compilers libroff, libmdoc, and libman.
    */
   typedef int             (*mandocmsg)(enum mandocerr, void *,
                                   int, int, const char *);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.22
CVSweb