Annotation of mandoc/libmdoc.h, Revision 1.109
1.109 ! schwarze 1: /* $Id: libmdoc.h,v 1.108 2015/11/07 14:01:16 schwarze Exp $ */
1.1 kristaps 2: /*
1.77 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.98 schwarze 4: * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.6 kristaps 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.98 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.6 kristaps 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.98 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.6 kristaps 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.
1.1 kristaps 17: */
18:
1.100 schwarze 19: #define MACRO_PROT_ARGS struct roff_man *mdoc, \
1.98 schwarze 20: int tok, \
1.55 kristaps 21: int line, \
22: int ppos, \
23: int *pos, \
24: char *buf
1.1 kristaps 25:
26: struct mdoc_macro {
1.92 schwarze 27: void (*fp)(MACRO_PROT_ARGS);
1.1 kristaps 28: int flags;
29: #define MDOC_CALLABLE (1 << 0)
30: #define MDOC_PARSED (1 << 1)
31: #define MDOC_EXPLICIT (1 << 2)
32: #define MDOC_PROLOGUE (1 << 3)
1.82 schwarze 33: #define MDOC_IGNDELIM (1 << 4)
34: #define MDOC_JOIN (1 << 5)
1.1 kristaps 35: };
36:
1.36 kristaps 37: enum margserr {
1.35 kristaps 38: ARGS_ERROR,
1.73 kristaps 39: ARGS_EOLN, /* end-of-line */
40: ARGS_WORD, /* normal word */
41: ARGS_PUNCT, /* series of punctuation */
42: ARGS_QWORD, /* quoted word */
1.106 schwarze 43: ARGS_PHRASE /* Bl -column phrase */
1.35 kristaps 44: };
45:
1.70 kristaps 46: /*
47: * A punctuation delimiter is opening, closing, or "middle mark"
48: * punctuation. These govern spacing.
49: * Opening punctuation (e.g., the opening parenthesis) suppresses the
50: * following space; closing punctuation (e.g., the closing parenthesis)
51: * suppresses the leading space; middle punctuation (e.g., the vertical
52: * bar) can do either. The middle punctuation delimiter bends the rules
53: * depending on usage.
54: */
55: enum mdelim {
56: DELIM_NONE = 0,
57: DELIM_OPEN,
58: DELIM_MIDDLE,
59: DELIM_CLOSE,
60: DELIM_MAX
61: };
62:
1.1 kristaps 63: extern const struct mdoc_macro *const mdoc_macros;
64:
65:
1.92 schwarze 66: void mdoc_macro(MACRO_PROT_ARGS);
1.100 schwarze 67: void mdoc_elem_alloc(struct roff_man *, int, int,
1.98 schwarze 68: int, struct mdoc_arg *);
1.100 schwarze 69: struct roff_node *mdoc_block_alloc(struct roff_man *, int, int,
1.98 schwarze 70: int, struct mdoc_arg *);
1.100 schwarze 71: void mdoc_tail_alloc(struct roff_man *, int, int, int);
72: struct roff_node *mdoc_endbody_alloc(struct roff_man *, int, int, int,
1.109 ! schwarze 73: struct roff_node *);
1.100 schwarze 74: void mdoc_node_relink(struct roff_man *, struct roff_node *);
1.107 schwarze 75: void mdoc_node_validate(struct roff_man *);
76: void mdoc_state(struct roff_man *, struct roff_node *);
77: void mdoc_state_reset(struct roff_man *);
1.98 schwarze 78: int mdoc_hash_find(const char *);
1.107 schwarze 79: const char *mdoc_a2arch(const char *);
1.16 kristaps 80: const char *mdoc_a2att(const char *);
1.18 kristaps 81: const char *mdoc_a2lib(const char *);
1.107 schwarze 82: enum roff_sec mdoc_a2sec(const char *);
1.17 kristaps 83: const char *mdoc_a2st(const char *);
1.100 schwarze 84: void mdoc_argv(struct roff_man *, int, int,
1.1 kristaps 85: struct mdoc_arg **, int *, char *);
1.100 schwarze 86: enum margserr mdoc_args(struct roff_man *, int,
1.98 schwarze 87: int *, char *, int, char **);
1.70 kristaps 88: enum mdelim mdoc_isdelim(const char *);
CVSweb