version 1.27, 2009/01/19 17:51:33 |
version 1.53, 2009/03/23 14:22:11 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@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 |
|
|
#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 |
|
* macro documents, a.k.a. BSD manual page documents. The mdoc.c file |
|
* drives the parser, while macro.c describes the macro ontologies. |
|
* validate.c pre- and post-validates parsed macros, and action.c |
|
* performs actions on parsed and validated macros. |
|
*/ |
|
|
/* What follows is a list of ALL possible macros. */ |
/* What follows is a list of ALL possible macros. */ |
|
|
#define MDOC___ 0 |
#define MDOC___ 0 |
|
|
#define MDOC_Hf 103 |
#define MDOC_Hf 103 |
#define MDOC_Fr 104 |
#define MDOC_Fr 104 |
#define MDOC_Ud 105 |
#define MDOC_Ud 105 |
#define MDOC_MAX 106 |
#define MDOC_Lb 106 |
|
#define MDOC_Ap 107 |
|
#define MDOC_Lp 108 |
|
#define MDOC_Lk 109 |
|
#define MDOC_Mt 110 |
|
#define MDOC_Brq 111 |
|
#define MDOC_Bro 112 |
|
#define MDOC_Brc 113 |
|
#define MDOC__C 114 |
|
#define MDOC_Es 115 |
|
#define MDOC_En 116 |
|
#define MDOC_Dx 117 |
|
#define MDOC__Q 118 |
|
#define MDOC_MAX 119 |
|
|
/* What follows is a list of ALL possible macro arguments. */ |
/* What follows is a list of ALL possible macro arguments. */ |
|
|
|
|
#define MDOC_Width 18 |
#define MDOC_Width 18 |
#define MDOC_Compact 19 |
#define MDOC_Compact 19 |
#define MDOC_Std 20 |
#define MDOC_Std 20 |
#define MDOC_p1003_1_88 21 |
#define MDOC_Filled 21 |
#define MDOC_p1003_1_90 22 |
#define MDOC_Words 22 |
#define MDOC_p1003_1_96 23 |
#define MDOC_Emphasis 23 |
#define MDOC_p1003_1_2001 24 |
#define MDOC_Symbolic 24 |
#define MDOC_p1003_1_2004 25 |
#define MDOC_Nested 25 |
#define MDOC_p1003_1 26 |
#define MDOC_ARG_MAX 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_Emphasis 60 |
|
#define MDOC_Symbolic 61 |
|
#define MDOC_ARG_MAX 62 |
|
|
|
|
/* Warnings are either syntax or groff-compatibility. */ |
enum mdoc_warn { |
enum mdoc_warn { |
WARN_SYNTAX, /* Syntax warn (at line/col). */ |
WARN_SYNTAX, |
WARN_COMPAT /* Groff compat warn (at line/col). */ |
WARN_COMPAT |
}; |
}; |
|
|
/* Possible values for the `At' macro. */ |
|
enum mdoc_att { |
|
ATT_DEFAULT = 0, |
|
ATT_v1, |
|
ATT_v2, |
|
ATT_v3, |
|
ATT_v4, |
|
ATT_v5, |
|
ATT_v6, |
|
ATT_v7, |
|
ATT_32v, |
|
ATT_V1, |
|
ATT_V2, |
|
ATT_V3, |
|
ATT_V4 |
|
}; |
|
|
|
/* An argument to a macro (multiple values = `It -column'). */ |
|
struct mdoc_arg { |
|
int arg; |
|
int line; |
|
int pos; |
|
size_t sz; |
|
char **value; |
|
}; |
|
|
|
/* |
|
* Simplified grammar of syntax tree: |
|
* |
|
* MDOC_ROOT: root of tree |
|
* MDOC_TEXT: free-form text |
|
* MDOC_ELEM: elem [args] MDOC_TEXT... |
|
* MDOC_BLOCK, MDOC_HEAD, MDOC_BODY, MDOC_TAIL: |
|
* MDOC_BLOCK: |
|
* MDOC_HEAD [args] (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)... |
|
* MDOC_BODY (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)... |
|
* MDOC_TAIL (optional) (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)... |
|
*/ |
|
|
|
/* Type of a syntax node. */ |
/* Type of a syntax node. */ |
enum mdoc_type { |
enum mdoc_type { |
MDOC_TEXT, |
MDOC_TEXT, |
Line 250 enum mdoc_type { |
|
Line 199 enum mdoc_type { |
|
MDOC_ROOT |
MDOC_ROOT |
}; |
}; |
|
|
/* Manual section. */ |
/* Section (named/unnamed) of `Sh'. */ |
enum mdoc_msec { |
|
MSEC_DEFAULT = 0, |
|
MSEC_1, |
|
MSEC_2, |
|
MSEC_3, |
|
MSEC_3f, |
|
MSEC_3p, |
|
MSEC_4, |
|
MSEC_5, |
|
MSEC_6, |
|
MSEC_7, |
|
MSEC_8, |
|
MSEC_9, |
|
MSEC_X11, |
|
MSEC_X11R6, |
|
MSEC_local, |
|
MSEC_n, |
|
MSEC_unass, |
|
MSEC_draft, |
|
MSEC_paper |
|
}; |
|
|
|
/* Section (named/unnamed) of `Ss'. */ |
|
enum mdoc_sec { |
enum mdoc_sec { |
SEC_PROLOGUE = 0, |
SEC_PROLOGUE = 0, |
SEC_BODY, |
SEC_BODY = 1, |
SEC_NAME, |
SEC_NAME = 2, |
SEC_SYNOPSIS, |
SEC_LIBRARY = 3, |
SEC_DESCRIPTION, |
SEC_SYNOPSIS = 4, |
SEC_RETURN_VALUES, |
SEC_DESCRIPTION = 5, |
SEC_ENVIRONMENT, |
SEC_IMPLEMENTATION = 6, |
SEC_FILES, |
SEC_RETURN_VALUES = 7, |
SEC_EXAMPLES, |
SEC_ENVIRONMENT = 8, |
SEC_DIAGNOSTICS, |
SEC_FILES = 9, |
SEC_ERRORS, |
SEC_EXAMPLES = 10, |
SEC_SEE_ALSO, |
SEC_DIAGNOSTICS = 11, |
SEC_STANDARDS, |
SEC_COMPATIBILITY = 12, |
SEC_HISTORY, |
SEC_ERRORS = 13, |
SEC_AUTHORS, |
SEC_SEE_ALSO = 14, |
SEC_CAVEATS, |
SEC_STANDARDS = 15, |
SEC_BUGS, |
SEC_HISTORY = 16, |
|
SEC_AUTHORS = 17, |
|
SEC_CAVEATS = 18, |
|
SEC_BUGS = 19, |
SEC_CUSTOM |
SEC_CUSTOM |
}; |
}; |
|
|
/* Volume of `Dt'. */ |
/* Information from prologue. */ |
enum mdoc_vol { |
|
VOL_DEFAULT = 0, |
|
VOL_AMD, |
|
VOL_IND, |
|
VOL_KM, |
|
VOL_LOCAL, |
|
VOL_PRM, |
|
VOL_PS1, |
|
VOL_SMM, |
|
VOL_URM, |
|
VOL_USD |
|
}; |
|
|
|
/* Architecture of `Dt'. */ |
|
enum mdoc_arch { |
|
ARCH_DEFAULT = 0, |
|
ARCH_alpha, |
|
ARCH_amd64, |
|
ARCH_amiga, |
|
ARCH_arc, |
|
ARCH_arm, |
|
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 |
|
}; |
|
|
|
/* Meta-information from prologue. */ |
|
struct mdoc_meta { |
struct mdoc_meta { |
enum mdoc_msec msec; |
int msec; |
enum mdoc_vol vol; |
char *vol; |
enum mdoc_arch arch; |
char *arch; |
time_t date; |
time_t date; |
char *title; |
char *title; |
char *os; |
char *os; |
char *name; |
char *name; |
}; |
}; |
|
|
struct mdoc_text { |
/* An argument to a macro (multiple values = `It -column'). */ |
char *string; |
struct mdoc_argv { |
|
int arg; |
|
int line; |
|
int pos; |
|
size_t sz; |
|
char **value; |
}; |
}; |
|
|
struct mdoc_block { |
struct mdoc_arg { |
size_t argc; |
size_t argc; |
struct mdoc_arg *argv; |
struct mdoc_argv *argv; |
struct mdoc_node *head; |
unsigned int refcnt; |
struct mdoc_node *body; |
|
struct mdoc_node *tail; |
|
}; |
}; |
|
|
struct mdoc_elem { |
/* Node in AST. */ |
size_t sz; |
|
char **args; |
|
size_t argc; |
|
struct mdoc_arg *argv; |
|
}; |
|
|
|
union mdoc_data { |
|
struct mdoc_text text; |
|
struct mdoc_elem elem; |
|
struct mdoc_block block; |
|
}; |
|
|
|
/* Syntax node in parse tree. */ |
|
struct mdoc_node { |
struct mdoc_node { |
struct mdoc_node *parent; |
struct mdoc_node *parent; |
struct mdoc_node *child; |
struct mdoc_node *child; |
Line 389 struct mdoc_node { |
|
Line 263 struct mdoc_node { |
|
#define MDOC_VALID (1 << 0) |
#define MDOC_VALID (1 << 0) |
#define MDOC_ACTED (1 << 1) |
#define MDOC_ACTED (1 << 1) |
enum mdoc_type type; |
enum mdoc_type type; |
union mdoc_data data; |
enum mdoc_sec sec; |
|
|
|
/* FIXME: union/struct this with #defines. */ |
|
struct mdoc_arg *args; /* BLOCK/ELEM */ |
|
struct mdoc_node *head; /* BLOCK */ |
|
struct mdoc_node *body; /* BLOCK */ |
|
struct mdoc_node *tail; /* BLOCK */ |
|
char *string; /* TEXT */ |
}; |
}; |
|
|
|
#define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */ |
|
#define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */ |
|
#define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */ |
|
|
/* Call-backs for parse messages. */ |
/* Call-backs for parse messages. */ |
struct mdoc_cb { |
struct mdoc_cb { |
void (*mdoc_msg)(void *, int, int, const char *); |
void (*mdoc_msg)(void *, int, int, const char *); |
Line 400 struct mdoc_cb { |
|
Line 285 struct mdoc_cb { |
|
enum mdoc_warn, const char *); |
enum mdoc_warn, const char *); |
}; |
}; |
|
|
|
/* Global table of macro names (`Bd', `Ed', etc.). */ |
extern const char *const *mdoc_macronames; |
extern const char *const *mdoc_macronames; |
|
|
|
/* Global table of argument names (`column', `tag', etc.). */ |
extern const char *const *mdoc_argnames; |
extern const char *const *mdoc_argnames; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
void mdoc_free(struct mdoc *); |
void mdoc_free(struct mdoc *); |
|
|
/* Allocate a new parser instance. */ |
/* Allocate a new parser instance. */ |
struct mdoc *mdoc_alloc(void *data, const struct mdoc_cb *); |
struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *); |
|
|
/* Parse a single line (boolean retval). */ |
/* Gets system ready for another parse. */ |
|
void mdoc_reset(struct mdoc *); |
|
|
|
/* Parse a single line in a stream (boolean retval). */ |
int mdoc_parseln(struct mdoc *, int, char *buf); |
int mdoc_parseln(struct mdoc *, int, char *buf); |
|
|
/* Get result first node. */ |
/* Get result first node (after mdoc_endparse!). */ |
const struct mdoc_node *mdoc_node(struct mdoc *); |
const struct mdoc_node *mdoc_node(const struct mdoc *); |
|
|
/* Get result meta-information. */ |
/* Get result meta-information (after mdoc_endparse!). */ |
const struct mdoc_meta *mdoc_meta(struct mdoc *); |
const struct mdoc_meta *mdoc_meta(const struct mdoc *); |
|
|
/* Signal end of parse sequence (boolean retval). */ |
/* Signal end of parse sequence (boolean retval). */ |
int mdoc_endparse(struct mdoc *); |
int mdoc_endparse(struct mdoc *); |
|
|
|
/* The following are utility functions. */ |
|
|
|
const char *mdoc_a2att(const char *); |
|
const char *mdoc_a2lib(const char *); |
|
const char *mdoc_a2st(const char *); |
|
|
__END_DECLS |
__END_DECLS |
|
|