]>
git.cameronkatri.com Git - mandoc.git/blob - libmdoc.h
1 /* $Id: libmdoc.h,v 1.98 2015/04/02 22:48:17 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 MDOC_NEXT_SIBLING
= 0,
25 struct mparse
*parse
; /* parse pointer */
26 const char *defos
; /* default argument for .Os */
27 int quick
; /* abort parse early */
28 int flags
; /* parse flags */
29 #define MDOC_LITERAL (1 << 1) /* in a literal scope */
30 #define MDOC_PBODY (1 << 2) /* in the document body */
31 #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
32 #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */
33 #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */
34 #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */
35 #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */
36 #define MDOC_KEEP (1 << 8) /* in a word keep */
37 #define MDOC_SMOFF (1 << 9) /* spacing is off */
38 #define MDOC_NODELIMC (1 << 10) /* disable closing delimiter handling */
39 enum mdoc_next next
; /* where to put the next node */
40 struct roff_node
*last
; /* the last node parsed */
41 struct roff_node
*first
; /* the first node parsed */
42 struct roff_node
*last_es
; /* the most recent Es node */
43 struct mdoc_meta meta
; /* document meta-data */
44 enum roff_sec lastnamed
;
45 enum roff_sec lastsec
;
49 #define MACRO_PROT_ARGS struct mdoc *mdoc, \
57 void (*fp
)(MACRO_PROT_ARGS
);
59 #define MDOC_CALLABLE (1 << 0)
60 #define MDOC_PARSED (1 << 1)
61 #define MDOC_EXPLICIT (1 << 2)
62 #define MDOC_PROLOGUE (1 << 3)
63 #define MDOC_IGNDELIM (1 << 4)
64 #define MDOC_JOIN (1 << 5)
69 ARGS_EOLN
, /* end-of-line */
70 ARGS_WORD
, /* normal word */
71 ARGS_PUNCT
, /* series of punctuation */
72 ARGS_QWORD
, /* quoted word */
73 ARGS_PHRASE
, /* Ta'd phrase (-column) */
74 ARGS_PPHRASE
, /* tabbed phrase (-column) */
75 ARGS_PEND
/* last phrase (-column) */
79 * A punctuation delimiter is opening, closing, or "middle mark"
80 * punctuation. These govern spacing.
81 * Opening punctuation (e.g., the opening parenthesis) suppresses the
82 * following space; closing punctuation (e.g., the closing parenthesis)
83 * suppresses the leading space; middle punctuation (e.g., the vertical
84 * bar) can do either. The middle punctuation delimiter bends the rules
95 extern const struct mdoc_macro
*const mdoc_macros
;
99 void mdoc_macro(MACRO_PROT_ARGS
);
100 void mdoc_word_alloc(struct mdoc
*, int, int, const char *);
101 void mdoc_word_append(struct mdoc
*, const char *);
102 void mdoc_elem_alloc(struct mdoc
*, int, int,
103 int, struct mdoc_arg
*);
104 struct roff_node
*mdoc_block_alloc(struct mdoc
*, int, int,
105 int, struct mdoc_arg
*);
106 struct roff_node
*mdoc_head_alloc(struct mdoc
*, int, int, int);
107 void mdoc_tail_alloc(struct mdoc
*, int, int, int);
108 struct roff_node
*mdoc_body_alloc(struct mdoc
*, int, int, int);
109 struct roff_node
*mdoc_endbody_alloc(struct mdoc
*, int, int, int,
110 struct roff_node
*, enum mdoc_endbody
);
111 void mdoc_node_delete(struct mdoc
*, struct roff_node
*);
112 void mdoc_node_relink(struct mdoc
*, struct roff_node
*);
113 void mdoc_hash_init(void);
114 int mdoc_hash_find(const char *);
115 const char *mdoc_a2att(const char *);
116 const char *mdoc_a2lib(const char *);
117 const char *mdoc_a2st(const char *);
118 const char *mdoc_a2arch(const char *);
119 void mdoc_valid_pre(struct mdoc
*, struct roff_node
*);
120 void mdoc_valid_post(struct mdoc
*);
121 void mdoc_argv(struct mdoc
*, int, int,
122 struct mdoc_arg
**, int *, char *);
123 void mdoc_argv_free(struct mdoc_arg
*);
124 enum margserr
mdoc_args(struct mdoc
*, int,
125 int *, char *, int, char **);
126 void mdoc_macroend(struct mdoc
*);
127 enum mdelim
mdoc_isdelim(const char *);