version 1.68, 2009/08/20 13:22:48 |
version 1.86, 2010/06/12 11:58:22 |
|
|
#ifndef MDOC_H |
#ifndef MDOC_H |
#define MDOC_H |
#define MDOC_H |
|
|
#include <time.h> |
|
|
|
/* |
/* |
* This library implements a validating scanner/parser for ``mdoc'' roff |
* This library implements a validating scanner/parser for ``mdoc'' roff |
* macro documents, a.k.a. BSD manual page documents. The mdoc.c file |
* macro documents, a.k.a. BSD manual page documents. The mdoc.c file |
|
|
|
|
/* What follows is a list of ALL possible macros. */ |
/* What follows is a list of ALL possible macros. */ |
|
|
#define MDOC_Ap 0 |
enum mdoct { |
#define MDOC_Dd 1 |
MDOC_Ap = 0, |
#define MDOC_Dt 2 |
MDOC_Dd, |
#define MDOC_Os 3 |
MDOC_Dt, |
#define MDOC_Sh 4 |
MDOC_Os, |
#define MDOC_Ss 5 |
MDOC_Sh, |
#define MDOC_Pp 6 |
MDOC_Ss, |
#define MDOC_D1 7 |
MDOC_Pp, |
#define MDOC_Dl 8 |
MDOC_D1, |
#define MDOC_Bd 9 |
MDOC_Dl, |
#define MDOC_Ed 10 |
MDOC_Bd, |
#define MDOC_Bl 11 |
MDOC_Ed, |
#define MDOC_El 12 |
MDOC_Bl, |
#define MDOC_It 13 |
MDOC_El, |
#define MDOC_Ad 14 |
MDOC_It, |
#define MDOC_An 15 |
MDOC_Ad, |
#define MDOC_Ar 16 |
MDOC_An, |
#define MDOC_Cd 17 |
MDOC_Ar, |
#define MDOC_Cm 18 |
MDOC_Cd, |
#define MDOC_Dv 19 |
MDOC_Cm, |
#define MDOC_Er 20 |
MDOC_Dv, |
#define MDOC_Ev 21 |
MDOC_Er, |
#define MDOC_Ex 22 |
MDOC_Ev, |
#define MDOC_Fa 23 |
MDOC_Ex, |
#define MDOC_Fd 24 |
MDOC_Fa, |
#define MDOC_Fl 25 |
MDOC_Fd, |
#define MDOC_Fn 26 |
MDOC_Fl, |
#define MDOC_Ft 27 |
MDOC_Fn, |
#define MDOC_Ic 28 |
MDOC_Ft, |
#define MDOC_In 29 |
MDOC_Ic, |
#define MDOC_Li 30 |
MDOC_In, |
#define MDOC_Nd 31 |
MDOC_Li, |
#define MDOC_Nm 32 |
MDOC_Nd, |
#define MDOC_Op 33 |
MDOC_Nm, |
#define MDOC_Ot 34 |
MDOC_Op, |
#define MDOC_Pa 35 |
MDOC_Ot, |
#define MDOC_Rv 36 |
MDOC_Pa, |
#define MDOC_St 37 |
MDOC_Rv, |
#define MDOC_Va 38 |
MDOC_St, |
#define MDOC_Vt 39 |
MDOC_Va, |
#define MDOC_Xr 40 |
MDOC_Vt, |
#define MDOC__A 41 |
MDOC_Xr, |
#define MDOC__B 42 |
MDOC__A, |
#define MDOC__D 43 |
MDOC__B, |
#define MDOC__I 44 |
MDOC__D, |
#define MDOC__J 45 |
MDOC__I, |
#define MDOC__N 46 |
MDOC__J, |
#define MDOC__O 47 |
MDOC__N, |
#define MDOC__P 48 |
MDOC__O, |
#define MDOC__R 49 |
MDOC__P, |
#define MDOC__T 50 |
MDOC__R, |
#define MDOC__V 51 |
MDOC__T, |
#define MDOC_Ac 52 |
MDOC__V, |
#define MDOC_Ao 53 |
MDOC_Ac, |
#define MDOC_Aq 54 |
MDOC_Ao, |
#define MDOC_At 55 |
MDOC_Aq, |
#define MDOC_Bc 56 |
MDOC_At, |
#define MDOC_Bf 57 |
MDOC_Bc, |
#define MDOC_Bo 58 |
MDOC_Bf, |
#define MDOC_Bq 59 |
MDOC_Bo, |
#define MDOC_Bsx 60 |
MDOC_Bq, |
#define MDOC_Bx 61 |
MDOC_Bsx, |
#define MDOC_Db 62 |
MDOC_Bx, |
#define MDOC_Dc 63 |
MDOC_Db, |
#define MDOC_Do 64 |
MDOC_Dc, |
#define MDOC_Dq 65 |
MDOC_Do, |
#define MDOC_Ec 66 |
MDOC_Dq, |
#define MDOC_Ef 67 |
MDOC_Ec, |
#define MDOC_Em 68 |
MDOC_Ef, |
#define MDOC_Eo 69 |
MDOC_Em, |
#define MDOC_Fx 70 |
MDOC_Eo, |
#define MDOC_Ms 71 |
MDOC_Fx, |
#define MDOC_No 72 |
MDOC_Ms, |
#define MDOC_Ns 73 |
MDOC_No, |
#define MDOC_Nx 74 |
MDOC_Ns, |
#define MDOC_Ox 75 |
MDOC_Nx, |
#define MDOC_Pc 76 |
MDOC_Ox, |
#define MDOC_Pf 77 |
MDOC_Pc, |
#define MDOC_Po 78 |
MDOC_Pf, |
#define MDOC_Pq 79 |
MDOC_Po, |
#define MDOC_Qc 80 |
MDOC_Pq, |
#define MDOC_Ql 81 |
MDOC_Qc, |
#define MDOC_Qo 82 |
MDOC_Ql, |
#define MDOC_Qq 83 |
MDOC_Qo, |
#define MDOC_Re 84 |
MDOC_Qq, |
#define MDOC_Rs 85 |
MDOC_Re, |
#define MDOC_Sc 86 |
MDOC_Rs, |
#define MDOC_So 87 |
MDOC_Sc, |
#define MDOC_Sq 88 |
MDOC_So, |
#define MDOC_Sm 89 |
MDOC_Sq, |
#define MDOC_Sx 90 |
MDOC_Sm, |
#define MDOC_Sy 91 |
MDOC_Sx, |
#define MDOC_Tn 92 |
MDOC_Sy, |
#define MDOC_Ux 93 |
MDOC_Tn, |
#define MDOC_Xc 94 |
MDOC_Ux, |
#define MDOC_Xo 95 |
MDOC_Xc, |
#define MDOC_Fo 96 |
MDOC_Xo, |
#define MDOC_Fc 97 |
MDOC_Fo, |
#define MDOC_Oo 98 |
MDOC_Fc, |
#define MDOC_Oc 99 |
MDOC_Oo, |
#define MDOC_Bk 100 |
MDOC_Oc, |
#define MDOC_Ek 101 |
MDOC_Bk, |
#define MDOC_Bt 102 |
MDOC_Ek, |
#define MDOC_Hf 103 |
MDOC_Bt, |
#define MDOC_Fr 104 |
MDOC_Hf, |
#define MDOC_Ud 105 |
MDOC_Fr, |
#define MDOC_Lb 106 |
MDOC_Ud, |
#define MDOC_Lp 107 |
MDOC_Lb, |
#define MDOC_Lk 108 |
MDOC_Lp, |
#define MDOC_Mt 109 |
MDOC_Lk, |
#define MDOC_Brq 110 |
MDOC_Mt, |
#define MDOC_Bro 111 |
MDOC_Brq, |
#define MDOC_Brc 112 |
MDOC_Bro, |
#define MDOC__C 113 |
MDOC_Brc, |
#define MDOC_Es 114 |
MDOC__C, |
#define MDOC_En 115 |
MDOC_Es, |
#define MDOC_Dx 116 |
MDOC_En, |
#define MDOC__Q 117 |
MDOC_Dx, |
#define MDOC_br 118 |
MDOC__Q, |
#define MDOC_sp 119 |
MDOC_br, |
#define MDOC_MAX 120 |
MDOC_sp, |
|
MDOC__U, |
|
MDOC_Ta, |
|
MDOC_MAX |
|
}; |
|
|
/* What follows is a list of ALL possible macro arguments. */ |
/* What follows is a list of ALL possible macro arguments. */ |
|
|
|
|
#define MDOC_Emphasis 23 |
#define MDOC_Emphasis 23 |
#define MDOC_Symbolic 24 |
#define MDOC_Symbolic 24 |
#define MDOC_Nested 25 |
#define MDOC_Nested 25 |
#define MDOC_ARG_MAX 26 |
#define MDOC_Centred 26 |
|
#define MDOC_ARG_MAX 27 |
|
|
/* Type of a syntax node. */ |
/* Type of a syntax node. */ |
enum mdoc_type { |
enum mdoc_type { |
|
|
SEC_SYNOPSIS, |
SEC_SYNOPSIS, |
SEC_DESCRIPTION, |
SEC_DESCRIPTION, |
SEC_IMPLEMENTATION, |
SEC_IMPLEMENTATION, |
/* FIXME: EXIT STATUS */ |
|
SEC_RETURN_VALUES, |
SEC_RETURN_VALUES, |
SEC_ENVIRONMENT, |
SEC_ENVIRONMENT, |
SEC_FILES, |
SEC_FILES, |
|
SEC_EXIT_STATUS, |
SEC_EXAMPLES, |
SEC_EXAMPLES, |
SEC_DIAGNOSTICS, |
SEC_DIAGNOSTICS, |
SEC_COMPATIBILITY, |
SEC_COMPATIBILITY, |
|
|
SEC_AUTHORS, |
SEC_AUTHORS, |
SEC_CAVEATS, |
SEC_CAVEATS, |
SEC_BUGS, |
SEC_BUGS, |
/* FIXME: SECURITY CONSIDERATIONS */ |
SEC_SECURITY, |
SEC_CUSTOM /* User-defined. */ |
SEC_CUSTOM, /* User-defined. */ |
|
SEC__MAX |
}; |
}; |
|
|
/* Information from prologue. */ |
/* Information from prologue. */ |
struct mdoc_meta { |
struct mdoc_meta { |
int msec; |
char *msec; |
char *vol; |
char *vol; |
char *arch; |
char *arch; |
time_t date; |
time_t date; |
Line 244 struct mdoc_arg { |
|
Line 248 struct mdoc_arg { |
|
unsigned int refcnt; |
unsigned int refcnt; |
}; |
}; |
|
|
|
enum mdoc_list { |
|
LIST__NONE = 0, |
|
LIST_bullet, |
|
LIST_column, |
|
LIST_dash, |
|
LIST_diag, |
|
LIST_enum, |
|
LIST_hang, |
|
LIST_hyphen, |
|
LIST_inset, |
|
LIST_item, |
|
LIST_ohang, |
|
LIST_tag |
|
}; |
|
|
|
enum mdoc_disp { |
|
DISP__NONE = 0, |
|
DISP_centred, |
|
DISP_ragged, |
|
DISP_unfilled, |
|
DISP_filled, |
|
DISP_literal |
|
}; |
|
|
|
struct mdoc_bd { |
|
const char *offs; |
|
enum mdoc_disp type; |
|
int comp; |
|
}; |
|
|
|
struct mdoc_bl { |
|
enum mdoc_list type; |
|
}; |
|
|
/* Node in AST. */ |
/* Node in AST. */ |
struct mdoc_node { |
struct mdoc_node { |
struct mdoc_node *parent; |
struct mdoc_node *parent; /* parent AST node */ |
struct mdoc_node *child; |
struct mdoc_node *child; /* first child AST node */ |
struct mdoc_node *next; |
struct mdoc_node *next; /* sibling AST node */ |
struct mdoc_node *prev; |
struct mdoc_node *prev; /* prior sibling AST node */ |
int nchild; |
int nchild; /* number children */ |
int line; |
int line; /* parse line */ |
int pos; |
int pos; /* parse column */ |
int tok; |
enum mdoct tok; /* tok or MDOC__MAX if none */ |
int flags; |
int flags; |
#define MDOC_VALID (1 << 0) |
#define MDOC_VALID (1 << 0) /* has been validated */ |
#define MDOC_ACTED (1 << 1) |
#define MDOC_ACTED (1 << 1) /* has been acted upon */ |
enum mdoc_type type; |
#define MDOC_EOS (1 << 2) /* at sentence boundary */ |
enum mdoc_sec sec; |
#define MDOC_LINE (1 << 3) /* first macro/text on line */ |
|
enum mdoc_type type; /* AST node type */ |
|
enum mdoc_sec sec; /* current named section */ |
struct mdoc_arg *args; /* BLOCK/ELEM */ |
struct mdoc_arg *args; /* BLOCK/ELEM */ |
|
#ifdef UGLY |
|
struct mdoc_node *pending; /* BLOCK */ |
|
#endif |
struct mdoc_node *head; /* BLOCK */ |
struct mdoc_node *head; /* BLOCK */ |
struct mdoc_node *body; /* BLOCK */ |
struct mdoc_node *body; /* BLOCK */ |
struct mdoc_node *tail; /* BLOCK */ |
struct mdoc_node *tail; /* BLOCK */ |
char *string; /* TEXT */ |
char *string; /* TEXT */ |
|
|
|
union { |
|
struct mdoc_bl Bl; |
|
struct mdoc_bd Bd; |
|
} data; |
}; |
}; |
|
|
#define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */ |
#define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */ |
#define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */ |
#define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */ |
#define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */ |
#define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */ |
#define MDOC_IGN_CHARS (1 << 3) /* Ignore disallowed chars. */ |
|
|
|
/* Call-backs for parse messages. */ |
|
|
|
struct mdoc_cb { |
|
int (*mdoc_err)(void *, int, int, const char *); |
|
int (*mdoc_warn)(void *, int, int, const char *); |
|
}; |
|
|
|
/* See mdoc.3 for documentation. */ |
/* See mdoc.3 for documentation. */ |
|
|
extern const char *const *mdoc_macronames; |
extern const char *const *mdoc_macronames; |
|
|
/* See mdoc.3 for documentation. */ |
/* See mdoc.3 for documentation. */ |
|
|
void mdoc_free(struct mdoc *); |
void mdoc_free(struct mdoc *); |
struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *); |
struct mdoc *mdoc_alloc(void *, int, mandocmsg); |
int mdoc_reset(struct mdoc *); |
void mdoc_reset(struct mdoc *); |
int mdoc_parseln(struct mdoc *, int, char *buf); |
int mdoc_parseln(struct mdoc *, int, char *, int); |
const struct mdoc_node *mdoc_node(const struct mdoc *); |
const struct mdoc_node *mdoc_node(const struct mdoc *); |
const struct mdoc_meta *mdoc_meta(const struct mdoc *); |
const struct mdoc_meta *mdoc_meta(const struct mdoc *); |
int mdoc_endparse(struct mdoc *); |
int mdoc_endparse(struct mdoc *); |