Annotation of mandoc/man.h, Revision 1.39
1.39 ! kristaps 1: /* $Id: man.h,v 1.38 2010/06/26 15:36:37 kristaps Exp $ */
1.1 kristaps 2: /*
1.37 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.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.34 joerg 58: MAN_AT,
1.27 kristaps 59: MAN_MAX
1.25 kristaps 60: };
1.1 kristaps 61:
62: enum man_type {
63: MAN_TEXT,
64: MAN_ELEM,
1.17 kristaps 65: MAN_ROOT,
66: MAN_BLOCK,
67: MAN_HEAD,
68: MAN_BODY
1.1 kristaps 69: };
70:
71: struct man_meta {
1.30 kristaps 72: char *msec;
1.4 kristaps 73: time_t date;
1.36 kristaps 74: char *rawdate;
1.1 kristaps 75: char *vol;
76: char *title;
1.4 kristaps 77: char *source;
1.1 kristaps 78: };
79:
80: struct man_node {
81: struct man_node *parent;
82: struct man_node *child;
83: struct man_node *next;
84: struct man_node *prev;
1.14 kristaps 85: int nchild;
1.1 kristaps 86: int line;
87: int pos;
1.25 kristaps 88: enum mant tok;
1.1 kristaps 89: int flags;
90: #define MAN_VALID (1 << 0)
91: #define MAN_ACTED (1 << 1)
1.29 kristaps 92: #define MAN_EOS (1 << 2)
1.1 kristaps 93: enum man_type type;
94: char *string;
1.17 kristaps 95: struct man_node *head;
96: struct man_node *body;
1.1 kristaps 97: };
98:
1.14 kristaps 99: #define MAN_IGN_MACRO (1 << 0)
1.15 kristaps 100: #define MAN_IGN_ESCAPE (1 << 2)
1.5 kristaps 101:
1.1 kristaps 102: extern const char *const *man_macronames;
103:
104: __BEGIN_DECLS
105:
106: struct man;
107:
108: void man_free(struct man *);
1.39 ! kristaps 109: struct man *man_alloc(const struct regset *, void *, int, mandocmsg);
1.23 kristaps 110: void man_reset(struct man *);
1.39 ! kristaps 111: int man_parseln(struct man *, int, char *, int);
1.1 kristaps 112: int man_endparse(struct man *);
113:
114: const struct man_node *man_node(const struct man *);
115: const struct man_meta *man_meta(const struct man *);
116:
117: __END_DECLS
118:
119: #endif /*!MAN_H*/
CVSweb