version 1.2, 2008/12/15 03:13:01 |
version 1.139, 2015/04/02 23:48:19 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the |
* purpose with or without fee is hereby granted, provided that the above |
* above copyright notice and this permission notice appear in all |
* copyright notice and this permission notice appear in all copies. |
* copies. |
|
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* PERFORMANCE OF THIS SOFTWARE. |
|
*/ |
*/ |
#ifndef MDOC_H |
|
#define MDOC_H |
|
|
|
#define MDOC_LINEARG_MAX 9 |
#define MDOC_Ap 0 |
|
#define MDOC_Dd 1 |
|
#define MDOC_Dt 2 |
|
#define MDOC_Os 3 |
|
#define MDOC_Sh 4 |
|
#define MDOC_Ss 5 |
|
#define MDOC_Pp 6 |
|
#define MDOC_D1 7 |
|
#define MDOC_Dl 8 |
|
#define MDOC_Bd 9 |
|
#define MDOC_Ed 10 |
|
#define MDOC_Bl 11 |
|
#define MDOC_El 12 |
|
#define MDOC_It 13 |
|
#define MDOC_Ad 14 |
|
#define MDOC_An 15 |
|
#define MDOC_Ar 16 |
|
#define MDOC_Cd 17 |
|
#define MDOC_Cm 18 |
|
#define MDOC_Dv 19 |
|
#define MDOC_Er 20 |
|
#define MDOC_Ev 21 |
|
#define MDOC_Ex 22 |
|
#define MDOC_Fa 23 |
|
#define MDOC_Fd 24 |
|
#define MDOC_Fl 25 |
|
#define MDOC_Fn 26 |
|
#define MDOC_Ft 27 |
|
#define MDOC_Ic 28 |
|
#define MDOC_In 29 |
|
#define MDOC_Li 30 |
|
#define MDOC_Nd 31 |
|
#define MDOC_Nm 32 |
|
#define MDOC_Op 33 |
|
#define MDOC_Ot 34 |
|
#define MDOC_Pa 35 |
|
#define MDOC_Rv 36 |
|
#define MDOC_St 37 |
|
#define MDOC_Va 38 |
|
#define MDOC_Vt 39 |
|
#define MDOC_Xr 40 |
|
#define MDOC__A 41 |
|
#define MDOC__B 42 |
|
#define MDOC__D 43 |
|
#define MDOC__I 44 |
|
#define MDOC__J 45 |
|
#define MDOC__N 46 |
|
#define MDOC__O 47 |
|
#define MDOC__P 48 |
|
#define MDOC__R 49 |
|
#define MDOC__T 50 |
|
#define MDOC__V 51 |
|
#define MDOC_Ac 52 |
|
#define MDOC_Ao 53 |
|
#define MDOC_Aq 54 |
|
#define MDOC_At 55 |
|
#define MDOC_Bc 56 |
|
#define MDOC_Bf 57 |
|
#define MDOC_Bo 58 |
|
#define MDOC_Bq 59 |
|
#define MDOC_Bsx 60 |
|
#define MDOC_Bx 61 |
|
#define MDOC_Db 62 |
|
#define MDOC_Dc 63 |
|
#define MDOC_Do 64 |
|
#define MDOC_Dq 65 |
|
#define MDOC_Ec 66 |
|
#define MDOC_Ef 67 |
|
#define MDOC_Em 68 |
|
#define MDOC_Eo 69 |
|
#define MDOC_Fx 70 |
|
#define MDOC_Ms 71 |
|
#define MDOC_No 72 |
|
#define MDOC_Ns 73 |
|
#define MDOC_Nx 74 |
|
#define MDOC_Ox 75 |
|
#define MDOC_Pc 76 |
|
#define MDOC_Pf 77 |
|
#define MDOC_Po 78 |
|
#define MDOC_Pq 79 |
|
#define MDOC_Qc 80 |
|
#define MDOC_Ql 81 |
|
#define MDOC_Qo 82 |
|
#define MDOC_Qq 83 |
|
#define MDOC_Re 84 |
|
#define MDOC_Rs 85 |
|
#define MDOC_Sc 86 |
|
#define MDOC_So 87 |
|
#define MDOC_Sq 88 |
|
#define MDOC_Sm 89 |
|
#define MDOC_Sx 90 |
|
#define MDOC_Sy 91 |
|
#define MDOC_Tn 92 |
|
#define MDOC_Ux 93 |
|
#define MDOC_Xc 94 |
|
#define MDOC_Xo 95 |
|
#define MDOC_Fo 96 |
|
#define MDOC_Fc 97 |
|
#define MDOC_Oo 98 |
|
#define MDOC_Oc 99 |
|
#define MDOC_Bk 100 |
|
#define MDOC_Ek 101 |
|
#define MDOC_Bt 102 |
|
#define MDOC_Hf 103 |
|
#define MDOC_Fr 104 |
|
#define MDOC_Ud 105 |
|
#define MDOC_Lb 106 |
|
#define MDOC_Lp 107 |
|
#define MDOC_Lk 108 |
|
#define MDOC_Mt 109 |
|
#define MDOC_Brq 110 |
|
#define MDOC_Bro 111 |
|
#define MDOC_Brc 112 |
|
#define MDOC__C 113 |
|
#define MDOC_Es 114 |
|
#define MDOC_En 115 |
|
#define MDOC_Dx 116 |
|
#define MDOC__Q 117 |
|
#define MDOC_br 118 |
|
#define MDOC_sp 119 |
|
#define MDOC__U 120 |
|
#define MDOC_Ta 121 |
|
#define MDOC_ll 122 |
|
#define MDOC_MAX 123 |
|
|
#define MDOC___ 0 |
enum mdocargt { |
#define MDOC_Dd 1 |
MDOC_Split, /* -split */ |
#define MDOC_Dt 2 |
MDOC_Nosplit, /* -nospli */ |
#define MDOC_Os 3 |
MDOC_Ragged, /* -ragged */ |
#define MDOC_Sh 4 |
MDOC_Unfilled, /* -unfilled */ |
#define MDOC_Ss 5 |
MDOC_Literal, /* -literal */ |
#define MDOC_Pp 6 |
MDOC_File, /* -file */ |
#define MDOC_D1 7 |
MDOC_Offset, /* -offset */ |
#define MDOC_Dl 8 |
MDOC_Bullet, /* -bullet */ |
#define MDOC_Bd 9 |
MDOC_Dash, /* -dash */ |
#define MDOC_Ed 10 |
MDOC_Hyphen, /* -hyphen */ |
#define MDOC_Bl 11 |
MDOC_Item, /* -item */ |
#define MDOC_El 12 |
MDOC_Enum, /* -enum */ |
#define MDOC_It 13 |
MDOC_Tag, /* -tag */ |
#define MDOC_Ad 14 |
MDOC_Diag, /* -diag */ |
#define MDOC_An 15 |
MDOC_Hang, /* -hang */ |
#define MDOC_Ar 16 |
MDOC_Ohang, /* -ohang */ |
#define MDOC_Cd 17 |
MDOC_Inset, /* -inset */ |
#define MDOC_Cm 18 |
MDOC_Column, /* -column */ |
#define MDOC_Dv 19 |
MDOC_Width, /* -width */ |
#define MDOC_Er 20 |
MDOC_Compact, /* -compact */ |
#define MDOC_Ev 21 |
MDOC_Std, /* -std */ |
#define MDOC_Ex 22 |
MDOC_Filled, /* -filled */ |
#define MDOC_Fa 23 |
MDOC_Words, /* -words */ |
#define MDOC_Fd 24 |
MDOC_Emphasis, /* -emphasis */ |
#define MDOC_Fl 25 |
MDOC_Symbolic, /* -symbolic */ |
#define MDOC_Fn 26 |
MDOC_Nested, /* -nested */ |
#define MDOC_Ft 27 |
MDOC_Centred, /* -centered */ |
#define MDOC_Ic 28 |
MDOC_ARG_MAX |
#define MDOC_In 29 |
|
#define MDOC_Li 30 |
|
#define MDOC_Nd 31 |
|
#define MDOC_Nm 32 |
|
#define MDOC_Op 33 |
|
#define MDOC_Ot 34 |
|
#define MDOC_Pa 35 |
|
#define MDOC_Rv 36 |
|
#define MDOC_St 37 |
|
#define MDOC_Va 38 |
|
#define MDOC_Vt 39 |
|
#define MDOC_Xr 40 |
|
#define MDOC__A 41 |
|
#define MDOC__B 42 |
|
#define MDOC__D 43 |
|
#define MDOC__I 44 |
|
#define MDOC__J 45 |
|
#define MDOC__N 46 |
|
#define MDOC__O 47 |
|
#define MDOC__P 48 |
|
#define MDOC__R 49 |
|
#define MDOC__T 50 |
|
#define MDOC__V 51 |
|
#define MDOC_Ac 52 |
|
#define MDOC_Ao 53 |
|
#define MDOC_Aq 54 |
|
#define MDOC_At 55 |
|
#define MDOC_Bc 56 |
|
#define MDOC_Bf 57 |
|
#define MDOC_Bo 58 |
|
#define MDOC_Bq 59 |
|
#define MDOC_Bsx 60 |
|
#define MDOC_Bx 61 |
|
#define MDOC_Db 62 |
|
#define MDOC_Dc 63 |
|
#define MDOC_Do 64 |
|
#define MDOC_Dq 65 |
|
#define MDOC_Ec 66 |
|
#define MDOC_Ef 67 |
|
#define MDOC_Em 68 |
|
#define MDOC_Eo 69 |
|
#define MDOC_Fx 70 |
|
#define MDOC_Ms 71 |
|
#define MDOC_No 72 |
|
#define MDOC_Ns 73 |
|
#define MDOC_Nx 74 |
|
#define MDOC_Ox 75 |
|
#define MDOC_Pc 76 |
|
#define MDOC_Pf 77 |
|
#define MDOC_Po 78 |
|
#define MDOC_Pq 79 |
|
#define MDOC_Qc 80 |
|
#define MDOC_Ql 81 |
|
#define MDOC_Qo 82 |
|
#define MDOC_Qq 83 |
|
#define MDOC_Re 84 |
|
#define MDOC_Rs 85 |
|
#define MDOC_Sc 86 |
|
#define MDOC_So 87 |
|
#define MDOC_Sq 88 |
|
#define MDOC_Sm 89 |
|
#define MDOC_Sx 90 |
|
#define MDOC_Sy 91 |
|
#define MDOC_Tn 92 |
|
#define MDOC_Ux 93 |
|
#define MDOC_Xc 94 |
|
#define MDOC_Xo 95 |
|
#define MDOC_Fo 96 |
|
#define MDOC_Fc 97 |
|
#define MDOC_Oo 98 |
|
#define MDOC_Oc 99 |
|
#define MDOC_Bk 100 |
|
#define MDOC_Ek 101 |
|
#define MDOC_Bt 102 |
|
#define MDOC_Hf 103 |
|
#define MDOC_Fr 104 |
|
#define MDOC_Ud 105 |
|
#define MDOC_MAX 106 |
|
|
|
#define MDOC_Split 0 |
|
#define MDOC_Nosplit 1 |
|
#define MDOC_Ragged 2 |
|
#define MDOC_Unfilled 3 |
|
#define MDOC_Literal 4 |
|
#define MDOC_File 5 |
|
#define MDOC_Offset 6 |
|
#define MDOC_Bullet 7 |
|
#define MDOC_Dash 8 |
|
#define MDOC_Hyphen 9 |
|
#define MDOC_Item 10 |
|
#define MDOC_Enum 11 |
|
#define MDOC_Tag 12 |
|
#define MDOC_Diag 13 |
|
#define MDOC_Hang 14 |
|
#define MDOC_Ohang 15 |
|
#define MDOC_Inset 16 |
|
#define MDOC_Column 17 |
|
#define MDOC_Width 18 |
|
#define MDOC_Compact 19 |
|
#define MDOC_Std 20 |
|
#define MDOC_p1003_1_88 21 |
|
#define MDOC_p1003_1_90 22 |
|
#define MDOC_p1003_1_96 23 |
|
#define MDOC_p1003_1_2001 24 |
|
#define MDOC_p1003_1_2004 25 |
|
#define MDOC_p1003_1 26 |
|
#define MDOC_p1003_1b 27 |
|
#define MDOC_p1003_1b_93 28 |
|
#define MDOC_p1003_1c_95 29 |
|
#define MDOC_p1003_1g_2000 30 |
|
#define MDOC_p1003_2_92 31 |
|
#define MDOC_p1387_2_95 32 |
|
#define MDOC_p1003_2 33 |
|
#define MDOC_p1387_2 34 |
|
#define MDOC_isoC_90 35 |
|
#define MDOC_isoC_amd1 36 |
|
#define MDOC_isoC_tcor1 37 |
|
#define MDOC_isoC_tcor2 38 |
|
#define MDOC_isoC_99 39 |
|
#define MDOC_ansiC 40 |
|
#define MDOC_ansiC_89 41 |
|
#define MDOC_ansiC_99 42 |
|
#define MDOC_ieee754 43 |
|
#define MDOC_iso8802_3 44 |
|
#define MDOC_xpg3 45 |
|
#define MDOC_xpg4 46 |
|
#define MDOC_xpg4_2 47 |
|
#define MDOC_xpg4_3 48 |
|
#define MDOC_xbd5 49 |
|
#define MDOC_xcu5 50 |
|
#define MDOC_xsh5 51 |
|
#define MDOC_xns5 52 |
|
#define MDOC_xns5_2d2_0 53 |
|
#define MDOC_xcurses4_2 54 |
|
#define MDOC_susv2 55 |
|
#define MDOC_susv3 56 |
|
#define MDOC_svid4 57 |
|
#define MDOC_Filled 58 |
|
#define MDOC_Words 59 |
|
#define MDOC_ARG_MAX 60 |
|
|
|
enum mdoc_err { |
|
ERR_SYNTAX_QUOTE, |
|
ERR_SYNTAX_WS, |
|
ERR_MACRO_NOTSUP, |
|
ERR_MACRO_NOTCALL, |
|
ERR_SCOPE_BREAK, |
|
ERR_ARGS_GE1 |
|
}; |
}; |
|
|
enum mdoc_warn { |
/* |
WARN_SYNTAX_WS_EOLN, |
* An argument to a macro (multiple values = `-column xxx yyy'). |
WARN_SYNTAX_MACLIKE, |
*/ |
WARN_ARGS_GE1 |
struct mdoc_argv { |
|
enum mdocargt arg; /* type of argument */ |
|
int line; |
|
int pos; |
|
size_t sz; /* elements in "value" */ |
|
char **value; /* argument strings */ |
}; |
}; |
|
|
|
/* |
|
* Reference-counted macro arguments. These are refcounted because |
|
* blocks have multiple instances of the same arguments spread across |
|
* the HEAD, BODY, TAIL, and BLOCK node types. |
|
*/ |
struct mdoc_arg { |
struct mdoc_arg { |
int arg; |
size_t argc; |
size_t sz; |
struct mdoc_argv *argv; |
char **value; |
unsigned int refcnt; |
}; |
}; |
|
|
enum mdoc_type { |
enum mdoc_list { |
MDOC_TEXT, |
LIST__NONE = 0, |
MDOC_ELEM, |
LIST_bullet, /* -bullet */ |
MDOC_HEAD, |
LIST_column, /* -column */ |
MDOC_BODY, |
LIST_dash, /* -dash */ |
MDOC_BLOCK |
LIST_diag, /* -diag */ |
|
LIST_enum, /* -enum */ |
|
LIST_hang, /* -hang */ |
|
LIST_hyphen, /* -hyphen */ |
|
LIST_inset, /* -inset */ |
|
LIST_item, /* -item */ |
|
LIST_ohang, /* -ohang */ |
|
LIST_tag, /* -tag */ |
|
LIST_MAX |
}; |
}; |
|
|
enum mdoc_msec { |
enum mdoc_disp { |
MSEC_1, |
DISP__NONE = 0, |
MSEC_2, |
DISP_centered, /* -centered */ |
MSEC_3, |
DISP_ragged, /* -ragged */ |
MSEC_3f, |
DISP_unfilled, /* -unfilled */ |
MSEC_3p, |
DISP_filled, /* -filled */ |
MSEC_4, |
DISP_literal /* -literal */ |
MSEC_5, |
|
MSEC_6, |
|
MSEC_7, |
|
MSEC_8, |
|
MSEC_9, |
|
MSEC_X11, |
|
MSEC_X11R6, |
|
MSEC_local, |
|
MSEC_n, |
|
MSEC_unass, |
|
MSEC_draft, |
|
MSEC_paper, |
|
MSEC_NONE |
|
}; |
}; |
|
|
enum mdoc_sec { |
enum mdoc_auth { |
SEC_PROLOGUE, |
AUTH__NONE = 0, |
SEC_NAME, |
AUTH_split, /* -split */ |
SEC_SYNOPSIS, |
AUTH_nosplit /* -nosplit */ |
SEC_DESCRIPTION, |
|
SEC_RETURN_VALUES, |
|
SEC_ENVIRONMENT, |
|
SEC_FILES, |
|
SEC_EXAMPLES, |
|
SEC_DIAGNOSTICS, |
|
SEC_ERRORS, |
|
SEC_SEE_ALSO, |
|
SEC_STANDARDS, |
|
SEC_HISTORY, |
|
SEC_AUTHORS, |
|
SEC_CAVEATS, |
|
SEC_BUGS, |
|
SEC_CUSTOM |
|
}; |
}; |
|
|
enum mdoc_vol { |
enum mdoc_font { |
VOL_AMD, |
FONT__NONE = 0, |
VOL_IND, |
FONT_Em, /* Em, -emphasis */ |
VOL_KM, |
FONT_Li, /* Li, -literal */ |
VOL_LOCAL, |
FONT_Sy /* Sy, -symbolic */ |
VOL_PRM, |
|
VOL_PS1, |
|
VOL_SMM, |
|
VOL_URM, |
|
VOL_USD, |
|
VOL_DEFAULT |
|
}; |
}; |
|
|
enum mdoc_arch { |
struct mdoc_bd { |
ARCH_alpha, |
const char *offs; /* -offset */ |
ARCH_amd64, |
enum mdoc_disp type; /* -ragged, etc. */ |
ARCH_amiga, |
int comp; /* -compact */ |
ARCH_arc, |
|
ARCH_armish, |
|
ARCH_aviion, |
|
ARCH_hp300, |
|
ARCH_hppa, |
|
ARCH_hppa64, |
|
ARCH_i386, |
|
ARCH_landisk, |
|
ARCH_luna88k, |
|
ARCH_mac68k, |
|
ARCH_macppc, |
|
ARCH_mvme68k, |
|
ARCH_mvme88k, |
|
ARCH_mvmeppc, |
|
ARCH_pmax, |
|
ARCH_sgi, |
|
ARCH_socppc, |
|
ARCH_sparc, |
|
ARCH_sparc64, |
|
ARCH_sun3, |
|
ARCH_vax, |
|
ARCH_zaurus, |
|
ARCH_DEFAULT |
|
}; |
}; |
|
|
struct mdoc_meta { |
struct mdoc_bl { |
enum mdoc_msec msec; |
const char *width; /* -width */ |
enum mdoc_vol vol; |
const char *offs; /* -offset */ |
enum mdoc_arch arch; |
enum mdoc_list type; /* -tag, -enum, etc. */ |
struct tm tm; |
int comp; /* -compact */ |
|
size_t ncols; /* -column arg count */ |
|
const char **cols; /* -column val ptr */ |
|
int count; /* -enum counter */ |
}; |
}; |
|
|
struct mdoc_text { |
struct mdoc_bf { |
char *string; |
enum mdoc_font font; /* font */ |
}; |
}; |
|
|
struct mdoc_block { |
struct mdoc_an { |
int tok; |
enum mdoc_auth auth; /* -split, etc. */ |
size_t argc; |
|
struct mdoc_arg *argv; |
|
}; |
}; |
|
|
struct mdoc_head { |
struct mdoc_rs { |
size_t sz; |
int quote_T; /* whether to quote %T */ |
char **args; |
|
int tok; |
|
}; |
}; |
|
|
struct mdoc_body { |
/* |
int tok; |
* Consists of normalised node arguments. These should be used instead |
}; |
* of iterating through the mdoc_arg pointers of a node: defaults are |
|
* provided, etc. |
struct mdoc_elem { |
*/ |
size_t sz; |
|
char **args; |
|
int tok; |
|
size_t argc; |
|
struct mdoc_arg *argv; |
|
}; |
|
|
|
union mdoc_data { |
union mdoc_data { |
struct mdoc_text text; |
struct mdoc_an An; |
struct mdoc_elem elem; |
struct mdoc_bd Bd; |
struct mdoc_body body; |
struct mdoc_bf Bf; |
struct mdoc_head head; |
struct mdoc_bl Bl; |
struct mdoc_block block; |
struct roff_node *Es; |
|
struct mdoc_rs Rs; |
}; |
}; |
|
|
struct mdoc_node { |
/* Names of macros. */ |
struct mdoc_node *parent; |
|
struct mdoc_node *child; |
|
struct mdoc_node *next; |
|
enum mdoc_type type; |
|
union mdoc_data data; |
|
}; |
|
|
|
struct mdoc_cb { |
|
int (*mdoc_err)(void *, int, int, enum mdoc_err); |
|
int (*mdoc_warn)(void *, int, int, enum mdoc_warn); |
|
void (*mdoc_msg)(void *, int, const char *); |
|
}; |
|
|
|
extern const char *const *mdoc_macronames; |
extern const char *const *mdoc_macronames; |
|
|
|
/* Names of macro args. Index is enum mdocargt. */ |
extern const char *const *mdoc_argnames; |
extern const char *const *mdoc_argnames; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
struct mdoc; |
struct mdoc; |
|
|
void mdoc_free(struct mdoc *); |
const struct roff_node *mdoc_node(const struct mdoc *); |
struct mdoc *mdoc_alloc(void *data, const struct mdoc_cb *); |
const struct roff_meta *mdoc_meta(const struct mdoc *); |
int mdoc_parseln(struct mdoc *, char *buf); |
void mdoc_deroff(char **, const struct roff_node *); |
const struct mdoc_node |
|
*mdoc_result(struct mdoc *); |
|
|
|
__END_DECLS |
__END_DECLS |
|
|
#endif /*!MDOC_H*/ |
|