mandoc.h

   1 /*      $Id: mandoc.h,v 1.7 2010/05/25 12:37:20 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17 #ifndef MANDOC_H
  18 #define MANDOC_H
  19
  20 #define ASCII_NBRSP      31  /* non-breaking space */
  21 #define ASCII_HYPH       30  /* breakable hyphen */
  22
  23
  24 __BEGIN_DECLS
  25
  26 enum    mandocerr {
  27         MANDOCERR_OK,
  28         MANDOCERR_UPPERCASE, /* text should be uppercase */
  29         MANDOCERR_SECOOO, /* sections out of conentional order */
  30         MANDOCERR_SECREP, /* section name repeats */
  31         MANDOCERR_PROLOGOOO, /* out of order prologue */
  32         MANDOCERR_PROLOGREP, /* repeated prologue entry */
  33         MANDOCERR_LISTFIRST, /* list type must come first */
  34         MANDOCERR_COLUMNS, /* column syntax is inconsistent */
  35         MANDOCERR_BADSTANDARD, /* bad standard */
  36         MANDOCERR_BADLIB, /* bad library */
  37         MANDOCERR_BADESCAPE, /* bad escape sequence */
  38         MANDOCERR_BADQUOTE, /* unterminated quoted string */
  39         MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
  40         MANDOCERR_WIDTHARG, /* superfluous width argument */
  41         MANDOCERR_BADDATE, /* bad date argument */
  42         MANDOCERR_BADWIDTH, /* bad width argument */
  43         MANDOCERR_BADMSEC, /* unknown manual sction */
  44         MANDOCERR_SECMSEC, /* section not in conventional manual section */
  45         MANDOCERR_EOLNSPACE, /* end of line whitespace */
  46         MANDOCERR_SCOPEEXIT, /* scope open on exit */
  47 #define MANDOCERR_WARNING       MANDOCERR_SCOPEEXIT
  48
  49         MANDOCERR_NAMESECFIRST, /* NAME section must come first */
  50         MANDOCERR_BADBOOL, /* bad Boolean value */
  51         MANDOCERR_CHILD, /* child violates parent syntax */
  52         MANDOCERR_BADATT, /* bad AT&T symbol */
  53         MANDOCERR_LISTREP, /* list type repeated */
  54         MANDOCERR_DISPREP, /* display type repeated */
  55         MANDOCERR_ARGVREP, /* argument repeated */
  56         MANDOCERR_NONAME, /* manual name not yet set */
  57         MANDOCERR_MACROOBS, /* obsolete macro ignored */
  58         MANDOCERR_MACROEMPTY, /* empty macro ignored */
  59         MANDOCERR_BADBODY, /* macro not allowed in body */
  60         MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
  61         MANDOCERR_BADCHAR, /* bad character */
  62         MANDOCERR_BADNAMESEC, /* bad NAME section contents */
  63         MANDOCERR_NOBLANKLN, /* no blank lines */
  64         MANDOCERR_NOTEXT, /* no text in this context */
  65         MANDOCERR_BADCOMMENT, /* bad comment style */
  66         MANDOCERR_MACRO, /* unknown macro will be lost */
  67         MANDOCERR_LINESCOPE, /* line scope broken */
  68         MANDOCERR_SCOPE, /* scope broken */
  69         MANDOCERR_ARGCOUNT, /* argument count wrong */
  70         MANDOCERR_NOSCOPE, /* request scope close w/none open */
  71         MANDOCERR_SCOPEREP, /* scope already open */
  72         /* FIXME: merge following with MANDOCERR_ARGCOUNT */
  73         MANDOCERR_NOARGS, /* macro requires line argument(s) */
  74         MANDOCERR_NOBODY, /* macro requires body argument(s) */
  75         MANDOCERR_NOARGV, /* macro requires argument(s) */
  76         MANDOCERR_NOTITLE, /* no title in document */
  77         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
  78         MANDOCERR_BODYLOST, /* body argument(s) will be lost */
  79 #define MANDOCERR_ERROR         MANDOCERR_BODYLOST
  80
  81         /* FIXME: this should be a MANDOCERR_ERROR */
  82         MANDOCERR_FONTTYPE, /* missing font type */
  83         /* FIXME: this should be a MANDOCERR_ERROR */
  84         MANDOCERR_DISPTYPE, /* missing display type */
  85         /* FIXME: this should be a MANDOCERR_ERROR */
  86         MANDOCERR_LISTTYPE, /* missing list type */
  87         /* FIXME: this should be a MANDOCERR_ERROR */
  88         MANDOCERR_NESTEDDISP, /* displays may not be nested */
  89         MANDOCERR_SYNTNOSCOPE, /* request scope close w/none open */
  90         MANDOCERR_SYNTSCOPE, /* scope broken, syntax violated */
  91         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
  92         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
  93         MANDOCERR_SYNTCHILD, /* child violates parent syntax */
  94         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
  95         MANDOCERR_NODOCBODY, /* no document body */
  96         MANDOCERR_NODOCPROLOG, /* no document prologue */
  97         MANDOCERR_UTSNAME, /* utsname() system call failed */
  98         MANDOCERR_MEM, /* memory exhausted */
  99 #define MANDOCERR_FATAL         MANDOCERR_MEM
 100
 101         MANDOCERR_MAX
 102 };
 103
 104 typedef int     (*mandocmsg)(enum mandocerr,
 105                         void *, int, int, const char *);
 106
 107 __END_DECLS
 108
 109 #endif /*!MANDOC_H*/