Annotation of mandoc/man.h, Revision 1.31
1.31 ! kristaps 1: /* $Id: man.h,v 1.30 2010/05/15 15:54:39 kristaps Exp $ */
1.1 kristaps 2: /*
1.12 kristaps 3: * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.11 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.11 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 MAN_H
18: #define MAN_H
19:
20: #include <time.h>
21:
1.25 kristaps 22: enum mant {
23: MAN_br = 0,
24: MAN_TH,
25: MAN_SH,
26: MAN_SS,
27: MAN_TP,
28: MAN_LP,
29: MAN_PP,
30: MAN_P,
31: MAN_IP,
32: MAN_HP,
33: MAN_SM,
34: MAN_SB,
35: MAN_BI,
36: MAN_IB,
37: MAN_BR,
38: MAN_RB,
39: MAN_R,
40: MAN_B,
41: MAN_I,
42: MAN_IR,
43: MAN_RI,
44: MAN_na,
45: MAN_i,
46: MAN_sp,
47: MAN_nf,
48: MAN_fi,
49: MAN_r,
50: MAN_RE,
51: MAN_RS,
52: MAN_DT,
53: MAN_UC,
54: MAN_PD,
55: MAN_Sp,
56: MAN_Vb,
57: MAN_Ve,
1.26 kristaps 58: MAN_de,
59: MAN_dei,
60: MAN_am,
61: MAN_ami,
62: MAN_dot,
1.27 kristaps 63: MAN_MAX
1.25 kristaps 64: };
1.1 kristaps 65:
66: enum man_type {
67: MAN_TEXT,
68: MAN_ELEM,
1.17 kristaps 69: MAN_ROOT,
70: MAN_BLOCK,
71: MAN_HEAD,
72: MAN_BODY
1.1 kristaps 73: };
74:
75: struct man_meta {
1.30 kristaps 76: char *msec;
1.4 kristaps 77: time_t date;
1.1 kristaps 78: char *vol;
79: char *title;
1.4 kristaps 80: char *source;
1.1 kristaps 81: };
82:
83: struct man_node {
84: struct man_node *parent;
85: struct man_node *child;
86: struct man_node *next;
87: struct man_node *prev;
1.14 kristaps 88: int nchild;
1.1 kristaps 89: int line;
90: int pos;
1.25 kristaps 91: enum mant tok;
1.1 kristaps 92: int flags;
93: #define MAN_VALID (1 << 0)
94: #define MAN_ACTED (1 << 1)
1.29 kristaps 95: #define MAN_EOS (1 << 2)
1.1 kristaps 96: enum man_type type;
97: char *string;
1.17 kristaps 98: struct man_node *head;
99: struct man_node *body;
1.1 kristaps 100: };
101:
1.14 kristaps 102: #define MAN_IGN_MACRO (1 << 0)
1.15 kristaps 103: #define MAN_IGN_ESCAPE (1 << 2)
1.5 kristaps 104:
1.1 kristaps 105: extern const char *const *man_macronames;
106:
1.3 kristaps 107: struct man_cb {
108: int (*man_warn)(void *, int, int, const char *);
109: int (*man_err)(void *, int, int, const char *);
110: };
111:
1.1 kristaps 112: __BEGIN_DECLS
113:
114: struct man;
115:
116: void man_free(struct man *);
1.5 kristaps 117: struct man *man_alloc(void *, int, const struct man_cb *);
1.23 kristaps 118: void man_reset(struct man *);
1.1 kristaps 119: int man_parseln(struct man *, int, char *buf);
120: int man_endparse(struct man *);
121:
122: const struct man_node *man_node(const struct man *);
123: const struct man_meta *man_meta(const struct man *);
124:
125: __END_DECLS
126:
127: #endif /*!MAN_H*/
CVSweb