version 1.1, 2008/12/15 01:54:58 |
version 1.55, 2009/04/12 19:19:57 |
|
|
/* $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 |
|
|
#define MDOC_LINEARG_MAX 9 |
#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. */ |
|
|
#define MDOC___ 0 |
#define MDOC___ 0 |
#define MDOC_Dd 1 |
#define MDOC_Dd 1 |
#define MDOC_Dt 2 |
#define MDOC_Dt 2 |
|
|
#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. */ |
|
|
#define MDOC_Split 0 |
#define MDOC_Split 0 |
#define MDOC_Nosplit 1 |
#define MDOC_Nosplit 1 |
#define MDOC_Ragged 2 |
#define MDOC_Ragged 2 |
|
|
#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_ARG_MAX 60 |
|
|
|
enum mdoc_err { |
/* Warnings are either syntax or groff-compatibility. */ |
ERR_SYNTAX_QUOTE, |
|
ERR_SYNTAX_WS, |
|
ERR_MACRO_NOTSUP, |
|
ERR_MACRO_NOTCALL, |
|
ERR_SCOPE_BREAK, |
|
ERR_ARGS_GE1 |
|
}; |
|
|
|
enum mdoc_warn { |
enum mdoc_warn { |
WARN_SYNTAX_WS_EOLN, |
WARN_SYNTAX, |
WARN_SYNTAX_MACLIKE, |
WARN_COMPAT |
WARN_ARGS_GE1 |
|
}; |
}; |
|
|
struct mdoc_arg { |
/* Type of a syntax node. */ |
int arg; |
|
size_t sz; |
|
char **value; |
|
}; |
|
|
|
enum mdoc_type { |
enum mdoc_type { |
MDOC_TEXT, |
MDOC_TEXT, |
MDOC_ELEM, |
MDOC_ELEM, |
MDOC_HEAD, |
MDOC_HEAD, |
|
MDOC_TAIL, |
MDOC_BODY, |
MDOC_BODY, |
MDOC_BLOCK |
MDOC_BLOCK, |
|
MDOC_ROOT |
}; |
}; |
|
|
struct mdoc_text { |
/* Section (named/unnamed) of `Sh'. */ |
char *string; |
enum mdoc_sec { |
|
SEC_PROLOGUE = 0, |
|
SEC_BODY = 1, |
|
SEC_NAME = 2, |
|
SEC_LIBRARY = 3, |
|
SEC_SYNOPSIS = 4, |
|
SEC_DESCRIPTION = 5, |
|
SEC_IMPLEMENTATION = 6, |
|
SEC_RETURN_VALUES = 7, |
|
SEC_ENVIRONMENT = 8, |
|
SEC_FILES = 9, |
|
SEC_EXAMPLES = 10, |
|
SEC_DIAGNOSTICS = 11, |
|
SEC_COMPATIBILITY = 12, |
|
SEC_ERRORS = 13, |
|
SEC_SEE_ALSO = 14, |
|
SEC_STANDARDS = 15, |
|
SEC_HISTORY = 16, |
|
SEC_AUTHORS = 17, |
|
SEC_CAVEATS = 18, |
|
SEC_BUGS = 19, |
|
SEC_CUSTOM |
}; |
}; |
|
|
struct mdoc_block { |
/* Information from prologue. */ |
int tok; |
struct mdoc_meta { |
size_t argc; |
int msec; |
struct mdoc_arg *argv; |
char *vol; |
|
char *arch; |
|
time_t date; |
|
char *title; |
|
char *os; |
|
char *name; |
}; |
}; |
|
|
struct mdoc_head { |
/* An argument to a macro (multiple values = `It -column'). */ |
|
struct mdoc_argv { |
|
int arg; |
|
int line; |
|
int pos; |
size_t sz; |
size_t sz; |
char **args; |
char **value; |
int tok; |
|
}; |
}; |
|
|
struct mdoc_body { |
struct mdoc_arg { |
int tok; |
|
}; |
|
|
|
struct mdoc_elem { |
|
size_t sz; |
|
char **args; |
|
int tok; |
|
size_t argc; |
size_t argc; |
struct mdoc_arg *argv; |
struct mdoc_argv *argv; |
|
unsigned int refcnt; |
}; |
}; |
|
|
union mdoc_data { |
/* Node in AST. */ |
struct mdoc_text text; |
|
struct mdoc_elem elem; |
|
struct mdoc_body body; |
|
struct mdoc_head head; |
|
struct mdoc_block block; |
|
}; |
|
|
|
struct mdoc_node { |
struct mdoc_node { |
struct mdoc_node *parent; |
struct mdoc_node *parent; |
struct mdoc_node *child; |
struct mdoc_node *child; |
struct mdoc_node *next; |
struct mdoc_node *next; |
|
struct mdoc_node *prev; |
|
int line; |
|
int pos; |
|
int tok; |
|
int flags; |
|
#define MDOC_VALID (1 << 0) |
|
#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. */ |
|
#define MDOC_IGN_CHARS (1 << 3) /* Ignore disallowed chars. */ |
|
|
|
/* Call-backs for parse messages. */ |
struct mdoc_cb { |
struct mdoc_cb { |
int (*mdoc_err)(void *, int, int, enum mdoc_err); |
void (*mdoc_msg)(void *, int, int, const char *); |
int (*mdoc_warn)(void *, int, int, enum mdoc_warn); |
int (*mdoc_err)(void *, int, int, const char *); |
void (*mdoc_msg)(void *, int, const char *); |
int (*mdoc_warn)(void *, int, int, |
|
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 |
|
|
struct mdoc; |
struct mdoc; |
|
|
|
/* Free memory allocated with mdoc_alloc. */ |
void mdoc_free(struct mdoc *); |
void mdoc_free(struct mdoc *); |
struct mdoc *mdoc_alloc(void *data, const struct mdoc_cb *); |
|
int mdoc_parseln(struct mdoc *, char *buf); |
|
|
|
const struct mdoc_node |
/* Allocate a new parser instance. */ |
*mdoc_result(struct mdoc *); |
struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *); |
|
|
|
/* Gets system ready for another parse. */ |
|
int mdoc_reset(struct mdoc *); |
|
|
|
/* Parse a single line in a stream (boolean retval). */ |
|
int mdoc_parseln(struct mdoc *, int, char *buf); |
|
|
|
/* Get result first node (after mdoc_endparse!). */ |
|
const struct mdoc_node *mdoc_node(const struct mdoc *); |
|
|
|
/* Get result meta-information (after mdoc_endparse!). */ |
|
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_a2att(const char *); |
|
const char *mdoc_a2lib(const char *); |
|
const char *mdoc_a2st(const char *); |
|
|
__END_DECLS |
__END_DECLS |
|
|