Annotation of mandoc/libman.h, Revision 1.37
1.37 ! kristaps 1: /* $Id: libman.h,v 1.36 2010/06/19 20:46:27 kristaps Exp $ */
1.1 kristaps 2: /*
1.36 kristaps 3: * Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.8 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.8 kristaps 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.
1.1 kristaps 16: */
17: #ifndef LIBMAN_H
18: #define LIBMAN_H
19:
1.37 ! kristaps 20: #include "regs.h"
1.1 kristaps 21: #include "man.h"
22:
23: enum man_next {
24: MAN_NEXT_SIBLING = 0,
25: MAN_NEXT_CHILD
26: };
27:
28: struct man {
1.4 kristaps 29: void *data;
1.34 kristaps 30: mandocmsg msg;
1.29 kristaps 31: int pflags; /* parse flags (see man.h) */
32: int flags; /* parse flags */
33: #define MAN_HALT (1 << 0) /* badness happened: die */
1.24 kristaps 34: #define MAN_ELINE (1 << 1) /* Next-line element scope. */
35: #define MAN_BLINE (1 << 2) /* Next-line block scope. */
36: #define MAN_ILINE (1 << 3) /* Ignored in next-line scope. */
37: #define MAN_LITERAL (1 << 4) /* Literal input. */
1.29 kristaps 38: #define MAN_BPLINE (1 << 5)
1.1 kristaps 39: enum man_next next;
40: struct man_node *last;
41: struct man_node *first;
42: struct man_meta meta;
43: };
44:
1.26 kristaps 45: #define MACRO_PROT_ARGS struct man *m, enum mant tok, int line, \
1.16 kristaps 46: int ppos, int *pos, char *buf
47:
48: struct man_macro {
49: int (*fp)(MACRO_PROT_ARGS);
50: int flags;
51: #define MAN_SCOPED (1 << 0)
1.20 kristaps 52: #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */
53: #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */
1.24 kristaps 54: #define MAN_NSCOPED (1 << 3) /* See in_line_eoln(). */
1.27 kristaps 55: #define MAN_NOCLOSE (1 << 4) /* See blk_exp(). */
1.16 kristaps 56: };
57:
58: extern const struct man_macro *const man_macros;
59:
1.1 kristaps 60: __BEGIN_DECLS
61:
1.34 kristaps 62: #define man_pmsg(m, l, p, t) \
63: (*(m)->msg)((t), (m)->data, (l), (p), NULL)
64: #define man_nmsg(m, n, t) \
65: (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
1.1 kristaps 66: int man_word_alloc(struct man *, int, int, const char *);
1.26 kristaps 67: int man_block_alloc(struct man *, int, int, enum mant);
68: int man_head_alloc(struct man *, int, int, enum mant);
69: int man_body_alloc(struct man *, int, int, enum mant);
70: int man_elem_alloc(struct man *, int, int, enum mant);
1.27 kristaps 71: void man_node_delete(struct man *, struct man_node *);
1.21 kristaps 72: void man_hash_init(void);
1.26 kristaps 73: enum mant man_hash_find(const char *);
1.3 kristaps 74: int man_macroend(struct man *);
1.16 kristaps 75: int man_args(struct man *, int, int *, char *, char **);
76: #define ARGS_ERROR (-1)
77: #define ARGS_EOLN (0)
78: #define ARGS_WORD (1)
79: #define ARGS_QWORD (1)
1.34 kristaps 80: int man_vmsg(struct man *, enum mandocerr,
81: int, int, const char *, ...);
1.5 kristaps 82: int man_valid_post(struct man *);
1.35 kristaps 83: int man_valid_pre(struct man *, struct man_node *);
1.5 kristaps 84: int man_action_post(struct man *);
1.19 kristaps 85: int man_action_pre(struct man *, struct man_node *);
1.28 kristaps 86: int man_unscope(struct man *,
1.34 kristaps 87: const struct man_node *, enum mandocerr);
1.1 kristaps 88:
89: __END_DECLS
90:
91: #endif /*!LIBMAN_H*/
CVSweb