Annotation of mandoc/man.h, Revision 1.15
1.15 ! kristaps 1: /* $Id: man.h,v 1.14 2009/06/18 10:32:00 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.13 kristaps 22: #define MAN_br 0
1.1 kristaps 23: #define MAN_TH 1
24: #define MAN_SH 2
25: #define MAN_SS 3
26: #define MAN_TP 4
27: #define MAN_LP 5
28: #define MAN_PP 6
29: #define MAN_P 7
30: #define MAN_IP 8
31: #define MAN_HP 9
32: #define MAN_SM 10
33: #define MAN_SB 11
34: #define MAN_BI 12
35: #define MAN_IB 13
36: #define MAN_BR 14
37: #define MAN_RB 15
38: #define MAN_R 16
39: #define MAN_B 17
40: #define MAN_I 18
1.2 kristaps 41: #define MAN_IR 19
1.6 kristaps 42: #define MAN_RI 20
1.13 kristaps 43: #define MAN_na 21
44: #define MAN_i 22
45: #define MAN_MAX 23
1.1 kristaps 46:
47: enum man_type {
48: MAN_TEXT,
49: MAN_ELEM,
50: MAN_ROOT
51: };
52:
53: struct man_meta {
54: int msec;
1.4 kristaps 55: time_t date;
1.1 kristaps 56: char *vol;
57: char *title;
1.4 kristaps 58: char *source;
1.1 kristaps 59: };
60:
61: struct man_node {
62: struct man_node *parent;
63: struct man_node *child;
64: struct man_node *next;
65: struct man_node *prev;
1.14 kristaps 66: int nchild;
1.1 kristaps 67: int line;
68: int pos;
69: int tok;
70: int flags;
71: #define MAN_VALID (1 << 0)
72: #define MAN_ACTED (1 << 1)
73: enum man_type type;
74: char *string;
75: };
76:
1.14 kristaps 77: #define MAN_IGN_MACRO (1 << 0)
78: #define MAN_IGN_CHARS (1 << 1)
1.15 ! kristaps 79: #define MAN_IGN_ESCAPE (1 << 2)
1.5 kristaps 80:
1.1 kristaps 81: extern const char *const *man_macronames;
82:
1.3 kristaps 83: struct man_cb {
84: int (*man_warn)(void *, int, int, const char *);
85: int (*man_err)(void *, int, int, const char *);
86: };
87:
1.1 kristaps 88: __BEGIN_DECLS
89:
90: struct man;
91:
92: void man_free(struct man *);
1.5 kristaps 93: struct man *man_alloc(void *, int, const struct man_cb *);
1.9 kristaps 94: int man_reset(struct man *);
1.1 kristaps 95: int man_parseln(struct man *, int, char *buf);
96: int man_endparse(struct man *);
1.3 kristaps 97: int man_valid_post(struct man *);
1.1 kristaps 98:
99: const struct man_node *man_node(const struct man *);
100: const struct man_meta *man_meta(const struct man *);
101:
102: __END_DECLS
103:
104: #endif /*!MAN_H*/
CVSweb