-/* $Id: mdoc.h,v 1.1 2008/12/15 01:54:58 kristaps Exp $ */
+/* $Id: mdoc.h,v 1.37 2009/03/06 14:13:47 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
#ifndef MDOC_H
#define MDOC_H
-#define MDOC_LINEARG_MAX 9
+/*
+ * 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_Dd 1
#define MDOC_Hf 103
#define MDOC_Fr 104
#define MDOC_Ud 105
-#define MDOC_MAX 106
+#define MDOC_Lb 106
+#define MDOC_MAX 107
+
+/* What follows is a list of ALL possible macro arguments. */
#define MDOC_Split 0
#define MDOC_Nosplit 1
#define MDOC_Width 18
#define MDOC_Compact 19
#define MDOC_Std 20
-#define MDOC_p1003_1_88 21
-#define MDOC_p1003_1_90 22
-#define MDOC_p1003_1_96 23
-#define MDOC_p1003_1_2001 24
-#define MDOC_p1003_1_2004 25
-#define MDOC_p1003_1 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 {
- ERR_SYNTAX_QUOTE,
- ERR_SYNTAX_WS,
- ERR_MACRO_NOTSUP,
- ERR_MACRO_NOTCALL,
- ERR_SCOPE_BREAK,
- ERR_ARGS_GE1
-};
+#define MDOC_Filled 21
+#define MDOC_Words 22
+#define MDOC_Emphasis 23
+#define MDOC_Symbolic 24
+#define MDOC_ARG_MAX 25
+/* Warnings are either syntax or groff-compatibility. */
enum mdoc_warn {
- WARN_SYNTAX_WS_EOLN,
- WARN_SYNTAX_MACLIKE,
- WARN_ARGS_GE1
+ WARN_SYNTAX,
+ WARN_COMPAT
};
+/* An argument to a macro (multiple values = `It -column'). */
struct mdoc_arg {
int arg;
+ int line;
+ int pos;
size_t sz;
char **value;
};
+/* Type of a syntax node. */
enum mdoc_type {
MDOC_TEXT,
MDOC_ELEM,
MDOC_HEAD,
+ MDOC_TAIL,
MDOC_BODY,
- MDOC_BLOCK
+ MDOC_BLOCK,
+ MDOC_ROOT
+};
+
+/* Section (named/unnamed) of `Sh'. */
+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
};
+/* Information from prologue. */
+struct mdoc_meta {
+ int msec;
+ char *vol;
+ char *arch;
+ time_t date;
+ char *title;
+ char *os;
+ char *name;
+};
+
+/* Text-only node. */
struct mdoc_text {
char *string;
};
+/* Block (scoped) node. */
struct mdoc_block {
- int tok;
size_t argc;
struct mdoc_arg *argv;
+ struct mdoc_node *head;
+ struct mdoc_node *body;
+ struct mdoc_node *tail;
};
-struct mdoc_head {
- size_t sz;
- char **args;
- int tok;
-};
-
-struct mdoc_body {
- int tok;
-};
-
+/* In-line element node. */
struct mdoc_elem {
- size_t sz;
- char **args;
- int tok;
size_t argc;
struct mdoc_arg *argv;
};
+/* Typed nodes of an AST node. */
union mdoc_data {
struct mdoc_text text;
struct mdoc_elem elem;
- struct mdoc_body body;
- struct mdoc_head head;
struct mdoc_block block;
};
+/* Node in AST. */
struct mdoc_node {
struct mdoc_node *parent;
struct mdoc_node *child;
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;
union mdoc_data data;
+ enum mdoc_sec sec;
};
+/* Call-backs for parse messages. */
struct mdoc_cb {
- int (*mdoc_err)(void *, int, int, enum mdoc_err);
- int (*mdoc_warn)(void *, int, int, enum mdoc_warn);
- void (*mdoc_msg)(void *, int, const char *);
+ void (*mdoc_msg)(void *, int, int, const char *);
+ int (*mdoc_err)(void *, int, 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;
+
+/* Global table of argument names (`column', `tag', etc.). */
extern const char *const *mdoc_argnames;
__BEGIN_DECLS
struct mdoc;
+/* Free memory allocated with mdoc_alloc. */
void mdoc_free(struct mdoc *);
+
+/* Allocate a new parser instance. */
struct mdoc *mdoc_alloc(void *data, const struct mdoc_cb *);
-int mdoc_parseln(struct mdoc *, char *buf);
-const struct mdoc_node
- *mdoc_result(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 *);
+
+int mdoc_isdelim(const char *);
__END_DECLS
git.ckatri.com / mandoc.git / blobdiff