version 1.28, 2009/01/20 13:44:05 |
version 1.34, 2009/02/24 12:20:52 |
|
|
#ifndef MDOC_H |
#ifndef MDOC_H |
#define MDOC_H |
#define MDOC_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_Symbolic 61 |
#define MDOC_Symbolic 61 |
#define MDOC_ARG_MAX 62 |
#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. */ |
/* Possible values for the `At' macro. */ |
Line 226 struct mdoc_arg { |
|
Line 235 struct mdoc_arg { |
|
char **value; |
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 340 enum mdoc_arch { |
|
Line 336 enum mdoc_arch { |
|
ARCH_zaurus |
ARCH_zaurus |
}; |
}; |
|
|
/* Meta-information from prologue. */ |
/* Information from prologue. */ |
struct mdoc_meta { |
struct mdoc_meta { |
enum mdoc_msec msec; |
enum mdoc_msec msec; |
enum mdoc_vol vol; |
enum mdoc_vol vol; |
Line 351 struct mdoc_meta { |
|
Line 347 struct mdoc_meta { |
|
char *name; |
char *name; |
}; |
}; |
|
|
|
/* Text-only node. */ |
struct mdoc_text { |
struct mdoc_text { |
char *string; |
char *string; |
}; |
}; |
|
|
|
/* Block (scoped) node. */ |
struct mdoc_block { |
struct mdoc_block { |
size_t argc; |
size_t argc; |
struct mdoc_arg *argv; |
struct mdoc_arg *argv; |
Line 363 struct mdoc_block { |
|
Line 361 struct mdoc_block { |
|
struct mdoc_node *tail; |
struct mdoc_node *tail; |
}; |
}; |
|
|
|
/* In-line element node. */ |
struct mdoc_elem { |
struct mdoc_elem { |
size_t sz; |
|
char **args; |
|
size_t argc; |
size_t argc; |
struct mdoc_arg *argv; |
struct mdoc_arg *argv; |
}; |
}; |
|
|
|
/* Typed nodes of an AST node. */ |
union mdoc_data { |
union mdoc_data { |
struct mdoc_text text; |
struct mdoc_text text; |
struct mdoc_elem elem; |
struct mdoc_elem elem; |
struct mdoc_block block; |
struct mdoc_block block; |
}; |
}; |
|
|
/* Syntax node in parse tree. */ |
/* Node in AST. */ |
struct mdoc_node { |
struct mdoc_node { |
struct mdoc_node *parent; |
struct mdoc_node *parent; |
struct mdoc_node *child; |
struct mdoc_node *child; |
Line 390 struct mdoc_node { |
|
Line 388 struct mdoc_node { |
|
#define MDOC_ACTED (1 << 1) |
#define MDOC_ACTED (1 << 1) |
enum mdoc_type type; |
enum mdoc_type type; |
union mdoc_data data; |
union mdoc_data data; |
/* FIXME: have an enum mdoc_sec. */ |
enum mdoc_sec sec; |
}; |
}; |
|
|
/* Call-backs for parse messages. */ |
/* Call-backs for parse messages. */ |
Line 401 struct mdoc_cb { |
|
Line 399 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 |
Line 414 void mdoc_free(struct mdoc *); |
|
Line 415 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 *data, const struct mdoc_cb *); |
|
|
/* Parse a single line (boolean retval). */ |
/* 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_arch2a(enum mdoc_arch); |
|
const char *mdoc_vol2a(enum mdoc_vol); |
|
const char *mdoc_msec2a(enum mdoc_msec); |
|
int mdoc_isdelim(const char *); |
|
|
__END_DECLS |
__END_DECLS |
|
|