version 1.31, 2009/02/22 14:31:08 |
version 1.33, 2009/02/23 09:33:34 |
|
|
#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 |
Line 413 struct mdoc *mdoc_alloc(void *data, const struct mdoc |
|
Line 421 struct mdoc *mdoc_alloc(void *data, const struct mdoc |
|
int mdoc_parseln(struct mdoc *, int, char *buf); |
int mdoc_parseln(struct mdoc *, int, char *buf); |
|
|
/* Get result first node (after mdoc_endparse!). */ |
/* 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 (after mdoc_endparse!). */ |
/* 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_arch2a(enum mdoc_arch); |
|
|
const char *mdoc_vol2a(enum mdoc_vol); |
const char *mdoc_vol2a(enum mdoc_vol); |
|
|
const char *mdoc_msec2a(enum mdoc_msec); |
const char *mdoc_msec2a(enum mdoc_msec); |
|
|
int mdoc_isdelim(const char *); |
int mdoc_isdelim(const char *); |
|
|
__END_DECLS |
__END_DECLS |