mandoc/mandoc.h - diff

Return to mandoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.h between version 1.198 and 1.246

version 1.198, 2015/02/06 07:13:14

version 1.246, 2017/11/10 23:32:40

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

* purpose with or without fee is hereby granted, provided that the above

* 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

* 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

* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

Line 28

enum mandoclevel {

MANDOCLEVEL_OK = 0,

MANDOCLEVEL_RESERVED,

MANDOCLEVEL_STYLE, /* style suggestions */

MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */

MANDOCLEVEL_ERROR, /* input has been thrown away */

MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */

Line 44 enum mandoclevel {

enum mandocerr {

MANDOCERR_OK,

MANDOCERR_BASE, /* ===== start of base system conventions ===== */

MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */

MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */

MANDOCERR_ARCH_BAD, /* unknown architecture: Dt ... arch */

MANDOCERR_OS_ARG, /* operating system explicitly specified: Os ... */

MANDOCERR_RCS_MISSING, /* RCS id missing */

MANDOCERR_XR_BAD, /* referenced manual not found: Xr name sec */

MANDOCERR_STYLE, /* ===== start of style suggestions ===== */

MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */

MANDOCERR_TITLE_CASE, /* lower case character in document title */

MANDOCERR_RCS_REP, /* duplicate RCS id: ... */

MANDOCERR_SEC_TYPO, /* possible typo in section name: Sh ... */

MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */

MANDOCERR_MACRO_USELESS, /* useless macro: macro */

MANDOCERR_BX, /* consider using OS macro: macro */

MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */

MANDOCERR_ER_REP, /* duplicate errno: Er ... */

MANDOCERR_DELIM, /* trailing delimiter: macro ... */

MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */

MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */

MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */

MANDOCERR_FUNC, /* function name without markup: name() */

MANDOCERR_SPACE_EOL, /* whitespace at end of input line */

MANDOCERR_COMMENT_BAD, /* bad comment style */

MANDOCERR_WARNING, /* ===== start of warnings ===== */

/* related to the prologue */

MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */

MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */

MANDOCERR_TITLE_CASE, /* lower case character in document title */

MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */

MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */

MANDOCERR_DATE_MISSING, /* missing date, using today's date */

MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */

MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */

MANDOCERR_OS_MISSING, /* missing Os macro, using "" */

MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */

MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */

MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */

MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */

/* related to document structure */

Line 65 enum mandocerr {

Line 91 enum mandocerr {

MANDOCERR_DOC_EMPTY, /* no document body */

MANDOCERR_SEC_BEFORE, /* content before first section header: macro */

MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */

MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */

MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */

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_NAMESEC_PUNCT, /* missing comma before name: Nm name */

MANDOCERR_ND_EMPTY, /* missing description line, using "" */

MANDOCERR_ND_LATE, /* description line outside NAME section */

MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */

MANDOCERR_SEC_REP, /* duplicate section title: Sh title */

MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */

MANDOCERR_XR_SELF, /* cross reference to self: Xr name sec */

MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */

MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */

MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */

Line 83 enum mandocerr {

Line 115 enum mandocerr {

MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */

MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */

MANDOCERR_BL_MOVE, /* moving content out of list: macro */

MANDOCERR_VT_CHILD, /* .Vt block has child macro: macro */

MANDOCERR_TA_LINE, /* first macro on line: Ta */

MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */

MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */

MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */

MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */

/* related to missing arguments */

MANDOCERR_REQ_EMPTY, /* skipping empty request: request */

Line 96 enum mandocerr {

Line 127 enum mandocerr {

MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */

MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */

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 6n */

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_NOBODY, /* empty list item: Bl -type It */

MANDOCERR_IT_NOARG, /* missing argument, using next line: Bl -c It */

MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */

MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */

MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */

MANDOCERR_RS_EMPTY, /* empty reference block: Rs */

MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */

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 */

/* related to bad arguments */

MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */

MANDOCERR_ARG_REP, /* duplicate argument: macro arg */

MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */

MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */

MANDOCERR_BL_REP, /* skipping duplicate list type: 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_FA_COMMA, /* comma in function argument: arg */

MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */

MANDOCERR_LB_BAD, /* unknown library name: Lb ... */

MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */

MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */

MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */

MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */

/* related to plain text */

MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */

MANDOCERR_FI_TAB, /* tab in filled text */

MANDOCERR_SPACE_EOL, /* whitespace at end of input line */

MANDOCERR_EOS, /* new sentence, new line */

MANDOCERR_COMMENT_BAD, /* bad comment style */

MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */

MANDOCERR_STR_UNDEF, /* undefined string, using "": name */

Line 152 enum mandocerr {

Line 188 enum mandocerr {

/* related to document structure and macros */

MANDOCERR_FILE, /* cannot open file */

MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */

MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */

MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */

MANDOCERR_CHAR_BAD, /* skipping bad character: number */

MANDOCERR_MACRO, /* skipping unknown macro: macro */

Line 165 enum mandocerr {

Line 203 enum mandocerr {

/* related to request and macro arguments */

MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */

MANDOCERR_ARGCOUNT, /* argument count wrong */

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_CE_NONUM, /* argument is not numeric, using 1: ce ... */

MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */

MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */

MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */

Line 225 enum tbl_cellt {

Line 264 enum tbl_cellt {

struct tbl_cell {

struct tbl_cell *next;

char *wstr; /* min width represented as a string */

size_t width; /* minimum column width */

size_t spacing; /* to the right of the column */

int vert; /* width of subsequent vertical line */

enum tbl_cellt pos;

size_t spacing;

int col; /* column number, starting from 0 */

int flags;

#define TBL_CELL_TALIGN (1 << 0) /* t, T */

Line 238 struct tbl_cell {

Line 278 struct tbl_cell {

#define TBL_CELL_UP (1 << 5) /* u, U */

#define TBL_CELL_WIGN (1 << 6) /* z, Z */

#define TBL_CELL_WMAX (1 << 7) /* x, X */

enum tbl_cellt pos;

};

Line 265 enum tbl_datt {

Line 306 enum tbl_datt {

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) */

int spans; /* how many spans follow */

int block; /* T{ text block T} */

enum tbl_datt pos;

};

Line 292 struct tbl_span {

Line 334 struct tbl_span {

};

enum eqn_boxt {

EQN_ROOT, /* root of parse tree */

EQN_TEXT, /* text (number, variable, whatever) */

EQN_SUBEXPR, /* nested `eqn' subexpression */

EQN_LIST, /* list (braces, etc.) */

EQN_LISTONE, /* singleton list */

EQN_PILE, /* vertical pile */

EQN_MATRIX /* pile of piles */

};

Line 362 struct eqn_box {

Line 402 struct eqn_box {

};

* An equation consists of a tree of expressions starting at a given

* line and position.

struct eqn {

char *name; /* identifier (or NULL) */

struct eqn_box *root; /* root mathematical expression */

int ln; /* invocation line */

int pos; /* invocation position */

};

* Parse options.

#define MPARSE_MDOC 1 /* assume -mdoc */

Line 382 struct eqn {

Line 411 struct eqn {

#define MPARSE_UTF8 16 /* accept UTF-8 input */

#define MPARSE_LATIN1 32 /* accept ISO-LATIN-1 input */

enum mandoc_os {

MANDOC_OS_OTHER = 0,

MANDOC_OS_NETBSD,

MANDOC_OS_OPENBSD

};

enum mandoc_esc {

ESCAPE_ERROR = 0, /* bail! unparsable escape */

ESCAPE_IGNORE, /* escape to be ignored */

Line 394 enum mandoc_esc {

Line 429 enum mandoc_esc {

ESCAPE_FONTPREV, /* previous font mode */

ESCAPE_NUMBERED, /* a numbered glyph */

ESCAPE_UNICODE, /* a unicode codepoint */

ESCAPE_BREAK, /* break the output line */

ESCAPE_NOSPACE, /* suppress space if the last on a line */

ESCAPE_HORIZ, /* horizontal movement */

ESCAPE_HLINE, /* horizontal line drawing */

ESCAPE_SKIPCHAR, /* skip the next character */

ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */

};

Line 402 enum mandoc_esc {

Line 440 enum mandoc_esc {

typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel,

const char *, int, int, const char *);

__BEGIN_DECLS

struct mparse;

struct mchars;

struct roff_man;

struct mdoc;

struct man;

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);

const char *mchars_uc2str(int);

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 mandocerr, mandocmsg,

const char *, size_t, size_t *);

enum mandoc_os, const char *);

struct mparse *mparse_alloc(int, enum mandoclevel, mandocmsg,

const struct mchars *, const char *);

void mparse_free(struct mparse *);

void mparse_keep(struct mparse *);

enum mandoclevel mparse_open(struct mparse *, int *, const char *);

int mparse_open(struct mparse *, const char *);

enum mandoclevel mparse_readfd(struct mparse *, int, const char *);

enum mandoclevel mparse_readmem(struct mparse *, void *, size_t,

const char *);

void mparse_reset(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_strerror(enum mandocerr);

const char *mparse_strlevel(enum mandoclevel);

enum mandoclevel mparse_wait(struct mparse *);

void mparse_updaterc(struct mparse *, enum mandoclevel *);

__END_DECLS

CVSweb