mandoc/mdoc.h - diff

Return to mdoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.h between version 1.30 and 1.34

version 1.30, 2009/02/21 21:00:06

version 1.34, 2009/02/24 12:20:52

Line 19

#ifndef 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. */

#define MDOC___ 0

Line 355 struct mdoc_block {

Line 363 struct mdoc_block {

/* In-line element node. */

struct mdoc_elem {

size_t sz;

char **args;

size_t argc;

struct mdoc_arg *argv;

};

Line 382 struct mdoc_node {

Line 388 struct mdoc_node {

#define MDOC_ACTED (1 << 1)

enum mdoc_type type;

union mdoc_data data;

/* FIXME: have an enum mdoc_sec. */

enum mdoc_sec sec;

};

/* Call-backs for parse messages. */

Line 413 struct mdoc *mdoc_alloc(void *data, const struct mdoc

Line 419 struct mdoc *mdoc_alloc(void *data, const struct mdoc

int mdoc_parseln(struct mdoc *, int, char *buf);

/* 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!). */

const struct mdoc_meta *mdoc_meta(struct mdoc *);

const struct mdoc_meta *mdoc_meta(const struct mdoc *);

/* Signal end of parse sequence (boolean retval). */

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

CVSweb