version 1.16, 2010/07/05 20:10:22 |
version 1.25, 2010/12/01 10:31:35 |
|
|
#ifndef MANDOC_H |
#ifndef MANDOC_H |
#define MANDOC_H |
#define MANDOC_H |
|
|
/* |
|
* This contains declarations that are available system-wide. |
|
*/ |
|
|
|
#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 { |
|
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, /* ===== end of warnings ===== */ |
MANDOCERR_WARNING, /* ===== start of warnings ===== */ |
|
|
MANDOCERR_UPPERCASE, /* text should be uppercase */ |
MANDOCERR_UPPERCASE, /* text should be uppercase */ |
MANDOCERR_SECOOO, /* sections out of conventional 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_BADSTANDARD, /* bad standard */ |
MANDOCERR_BADTAB, /* tab in non-literal context */ |
MANDOCERR_BADLIB, /* bad library */ |
|
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. */ |
/* 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 section */ |
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_SCOPENEST, /* blocks badly nested */ |
MANDOCERR_SCOPENEST, /* blocks badly nested */ |
MANDOCERR_SCOPEEXIT, /* scope open on exit */ |
|
|
|
MANDOCERR_ERROR, /* ===== end of errors ===== */ |
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 */ |
MANDOCERR_BADATT, /* bad AT&T symbol */ |
MANDOCERR_BADATT, /* bad AT&T symbol */ |
|
MANDOCERR_BADSTANDARD, /* bad standard */ |
MANDOCERR_LISTREP, /* list type repeated */ |
MANDOCERR_LISTREP, /* list type repeated */ |
MANDOCERR_DISPREP, /* display type repeated */ |
MANDOCERR_DISPREP, /* display type repeated */ |
MANDOCERR_ARGVREP, /* argument repeated */ |
MANDOCERR_ARGVREP, /* argument repeated */ |
|
MANDOCERR_IGNARGV, /* ignoring argument */ |
MANDOCERR_NONAME, /* manual name not yet set */ |
MANDOCERR_NONAME, /* manual name not yet set */ |
MANDOCERR_MACROOBS, /* obsolete macro ignored */ |
MANDOCERR_MACROOBS, /* obsolete macro ignored */ |
MANDOCERR_MACROEMPTY, /* empty macro ignored */ |
MANDOCERR_MACROEMPTY, /* empty macro ignored */ |
|
|
MANDOCERR_NOTEXT, /* no text in this context */ |
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_MACRO, /* unknown macro will be lost */ |
|
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, /* 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) */ |
|
Line 101 enum mandocerr { |
|
MANDOCERR_FONTTYPE, /* missing font 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, /* ===== end 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 */ |
/* FIXME: this should be a MANDOCERR_ERROR */ |
MANDOCERR_NESTEDDISP, /* displays may not be nested */ |
MANDOCERR_NESTEDDISP, /* displays may not be nested */ |
MANDOCERR_BADDISP, /* unsupported display type */ |
MANDOCERR_BADDISP, /* unsupported display type */ |
MANDOCERR_SCOPEFATAL, /* blocks badly nested */ |
MANDOCERR_SCOPEFATAL, /* blocks badly nested */ |
MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */ |
MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */ |
MANDOCERR_SYNTSCOPE, /* scope broken, 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 */ |
Line 104 enum mandocerr { |
|
Line 117 enum mandocerr { |
|
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 */ |
|
|
MANDOCERR_MAX |
MANDOCERR_MAX |
}; |
}; |
|
|
|
/* |
|
* Available registers (set in libroff, accessed elsewhere). |
|
*/ |
enum regs { |
enum regs { |
REG_nS = 0, /* register: nS */ |
REG_nS = 0, |
REG__MAX |
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 |
* 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 |
* assumed that callers know which type in "v" corresponds to which |
* assumed that callers know which type in "v" corresponds to which |
|
|
*/ |
*/ |
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; |
|
}; |
}; |
|
|
/* |
/* |
|
|
struct regset { |
struct regset { |
struct reg regs[REG__MAX]; |
struct reg regs[REG__MAX]; |
}; |
}; |
|
|
|
__BEGIN_DECLS |
|
|
/* |
/* |
* Callback function for warnings, errors, and fatal errors as they |
* Callback function for warnings, errors, and fatal errors as they |