1 /* $Id: mdoc.h,v 1.15 2009/10/27 21:40:07 schwarze Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 * This library implements a validating scanner/parser for ``mdoc'' roff
22 * macro documents, a.k.a. BSD manual page documents. The mdoc.c file
23 * drives the parser, while macro.c describes the macro ontologies.
24 * validate.c pre- and post-validates parsed macros, and action.c
25 * performs actions on parsed and validated macros.
28 /* What follows is a list of ALL possible macros. */
153 /* What follows is a list of ALL possible macro arguments. */
156 #define MDOC_Nosplit 1
157 #define MDOC_Ragged 2
158 #define MDOC_Unfilled 3
159 #define MDOC_Literal 4
161 #define MDOC_Offset 6
162 #define MDOC_Bullet 7
164 #define MDOC_Hyphen 9
170 #define MDOC_Ohang 15
171 #define MDOC_Inset 16
172 #define MDOC_Column 17
173 #define MDOC_Width 18
174 #define MDOC_Compact 19
176 #define MDOC_Filled 21
177 #define MDOC_Words 22
178 #define MDOC_Emphasis 23
179 #define MDOC_Symbolic 24
180 #define MDOC_Nested 25
181 #define MDOC_Centred 26
182 #define MDOC_ARG_MAX 27
184 /* Type of a syntax node. */
195 /* Section (named/unnamed) of `Sh'. */
197 SEC_NONE
, /* No section, yet. */
218 SEC_CUSTOM
/* User-defined. */
221 /* Information from prologue. */
232 /* An argument to a macro (multiple values = `It -column'). */
243 struct mdoc_argv
*argv
;
249 struct mdoc_node
*parent
;
250 struct mdoc_node
*child
;
251 struct mdoc_node
*next
;
252 struct mdoc_node
*prev
;
258 #define MDOC_VALID (1 << 0)
259 #define MDOC_ACTED (1 << 1)
263 struct mdoc_arg
*args
; /* BLOCK/ELEM */
264 struct mdoc_node
*head
; /* BLOCK */
265 struct mdoc_node
*body
; /* BLOCK */
266 struct mdoc_node
*tail
; /* BLOCK */
267 char *string
; /* TEXT */
270 #define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */
271 #define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */
272 #define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */
273 #define MDOC_IGN_CHARS (1 << 3) /* Ignore disallowed chars. */
275 /* Call-backs for parse messages. */
278 int (*mdoc_err
)(void *, int, int, const char *);
279 int (*mdoc_warn
)(void *, int, int, const char *);
282 /* See mdoc.3 for documentation. */
284 extern const char *const *mdoc_macronames
;
285 extern const char *const *mdoc_argnames
;
291 /* See mdoc.3 for documentation. */
293 void mdoc_free(struct mdoc
*);
294 struct mdoc
*mdoc_alloc(void *, int, const struct mdoc_cb
*);
295 int mdoc_reset(struct mdoc
*);
296 int mdoc_parseln(struct mdoc
*, int, char *buf
);
297 const struct mdoc_node
*mdoc_node(const struct mdoc
*);
298 const struct mdoc_meta
*mdoc_meta(const struct mdoc
*);
299 int mdoc_endparse(struct mdoc
*);