Annotation of mandoc/private.h, Revision 1.34
1.34 ! kristaps 1: /* $Id: private.h,v 1.33 2008/12/08 12:46:28 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #ifndef PRIVATE_H
20: #define PRIVATE_H
21:
1.34 ! kristaps 22: #include <stdio.h>
1.27 kristaps 23: #include <time.h>
24:
1.1 kristaps 25: struct md_rbuf {
1.7 kristaps 26: int fd; /* Open descriptor. */
27: char *name; /* Name of file. */
28: char *buf; /* Buffer. */
29: size_t bufsz; /* Size of buffer. */
30: size_t line; /* Current line number. */
1.34 ! kristaps 31: #define MD_LINE (BUFSIZ)
! 32: char linebuf[MD_LINE];
1.1 kristaps 33: };
34:
35: struct md_mbuf {
1.7 kristaps 36: int fd; /* Open descriptor. */
37: char *name; /* Name of file. */
38: char *buf; /* Buffer. */
39: size_t bufsz; /* Size of buffer. */
40: size_t pos; /* Position in buffer. */
1.1 kristaps 41: };
42:
1.27 kristaps 43: #define ROFFTok_Sp_A 0
44: #define ROFFTok_Sp_B 1
45: #define ROFFTok_Sp_F 2
46: #define ROFFTok_Sp_N 3
47: #define ROFFTok_Sp_R 4
48: #define ROFFTok_Sp_T 5
49: #define ROFFTok_Sp_V 6
50: #define ROFFTok_Space 7
51: #define ROFFTok_Null 8
52: #define ROFFTok_Hyphen 9
53: #define ROFFTok_Em 10
54: #define ROFFTok_En 11
55: #define ROFFTok_Ge 12
56: #define ROFFTok_Le 13
57: #define ROFFTok_Rquote 14
58: #define ROFFTok_Lquote 15
59: #define ROFFTok_Uparrow 16
60: #define ROFFTok_Acute 17
61: #define ROFFTok_Grave 18
62: #define ROFFTok_Pi 19
63: #define ROFFTok_Ne 20
64: #define ROFFTok_Lt 21
65: #define ROFFTok_Gt 22
66: #define ROFFTok_Plusmin 23
67: #define ROFFTok_Infty 24
68: #define ROFFTok_Bar 25
69: #define ROFFTok_Nan 26
1.28 kristaps 70: #define ROFFTok_Quote 27
1.29 kristaps 71: #define ROFFTok_Sp_0 28
72: #define ROFFTok_Slash 29
73: #define ROFFTok_MAX 30
1.27 kristaps 74:
1.5 kristaps 75: #define ROFF___ 0
76: #define ROFF_Dd 1
77: #define ROFF_Dt 2
78: #define ROFF_Os 3
79: #define ROFF_Sh 4
1.6 kristaps 80: #define ROFF_Ss 5
81: #define ROFF_Pp 6
82: #define ROFF_D1 7
83: #define ROFF_Dl 8
84: #define ROFF_Bd 9
85: #define ROFF_Ed 10
86: #define ROFF_Bl 11
87: #define ROFF_El 12
88: #define ROFF_It 13
1.9 kristaps 89: #define ROFF_Ad 14
90: #define ROFF_An 15
91: #define ROFF_Ar 16
92: #define ROFF_Cd 17
93: #define ROFF_Cm 18
94: #define ROFF_Dv 19
95: #define ROFF_Er 20
96: #define ROFF_Ev 21
97: #define ROFF_Ex 22
98: #define ROFF_Fa 23
99: #define ROFF_Fd 24
100: #define ROFF_Fl 25
101: #define ROFF_Fn 26
102: #define ROFF_Ft 27
103: #define ROFF_Ic 28
104: #define ROFF_In 29
105: #define ROFF_Li 30
106: #define ROFF_Nd 31
107: #define ROFF_Nm 32
108: #define ROFF_Op 33
109: #define ROFF_Ot 34
110: #define ROFF_Pa 35
111: #define ROFF_Rv 36
112: #define ROFF_St 37
113: #define ROFF_Va 38
114: #define ROFF_Vt 39
115: #define ROFF_Xr 40
116: #define ROFF__A 41
117: #define ROFF__B 42
118: #define ROFF__D 43
119: #define ROFF__I 44
120: #define ROFF__J 45
121: #define ROFF__N 46
122: #define ROFF__O 47
123: #define ROFF__P 48
124: #define ROFF__R 49
125: #define ROFF__T 50
126: #define ROFF__V 51
127: #define ROFF_Ac 52
128: #define ROFF_Ao 53
129: #define ROFF_Aq 54
130: #define ROFF_At 55
131: #define ROFF_Bc 56
132: #define ROFF_Bf 57
133: #define ROFF_Bo 58
134: #define ROFF_Bq 59
135: #define ROFF_Bsx 60
136: #define ROFF_Bx 61
137: #define ROFF_Db 62
138: #define ROFF_Dc 63
139: #define ROFF_Do 64
140: #define ROFF_Dq 65
141: #define ROFF_Ec 66
142: #define ROFF_Ef 67
143: #define ROFF_Em 68
144: #define ROFF_Eo 69
145: #define ROFF_Fx 70
146: #define ROFF_Ms 71
147: #define ROFF_No 72
148: #define ROFF_Ns 73
149: #define ROFF_Nx 74
150: #define ROFF_Ox 75
151: #define ROFF_Pc 76
152: #define ROFF_Pf 77
153: #define ROFF_Po 78
154: #define ROFF_Pq 79
155: #define ROFF_Qc 80
156: #define ROFF_Ql 81
157: #define ROFF_Qo 82
158: #define ROFF_Qq 83
159: #define ROFF_Re 84
160: #define ROFF_Rs 85
161: #define ROFF_Sc 86
162: #define ROFF_So 87
163: #define ROFF_Sq 88
164: #define ROFF_Sm 89
165: #define ROFF_Sx 90
166: #define ROFF_Sy 91
167: #define ROFF_Tn 92
168: #define ROFF_Ux 93
169: #define ROFF_Xc 94
170: #define ROFF_Xo 95
171: #define ROFF_Fo 96
172: #define ROFF_Fc 97
173: #define ROFF_Oo 98
174: #define ROFF_Oc 99
1.10 kristaps 175: #define ROFF_Bk 100
176: #define ROFF_Ek 101
1.21 kristaps 177: #define ROFF_Bt 102
178: #define ROFF_Hf 103
179: #define ROFF_Fr 104
180: #define ROFF_Ud 105
181: #define ROFF_MAX 106
1.5 kristaps 182:
183: #define ROFF_Split 0
184: #define ROFF_Nosplit 1
1.6 kristaps 185: #define ROFF_Ragged 2
186: #define ROFF_Unfilled 3
187: #define ROFF_Literal 4
188: #define ROFF_File 5
189: #define ROFF_Offset 6
190: #define ROFF_Bullet 7
191: #define ROFF_Dash 8
192: #define ROFF_Hyphen 9
193: #define ROFF_Item 10
194: #define ROFF_Enum 11
195: #define ROFF_Tag 12
196: #define ROFF_Diag 13
197: #define ROFF_Hang 14
198: #define ROFF_Ohang 15
199: #define ROFF_Inset 16
200: #define ROFF_Column 17
1.7 kristaps 201: #define ROFF_Width 18
202: #define ROFF_Compact 19
1.9 kristaps 203: #define ROFF_Std 20
204: #define ROFF_p1003_1_88 21
205: #define ROFF_p1003_1_90 22
206: #define ROFF_p1003_1_96 23
207: #define ROFF_p1003_1_2001 24
208: #define ROFF_p1003_1_2004 25
209: #define ROFF_p1003_1 26
210: #define ROFF_p1003_1b 27
211: #define ROFF_p1003_1b_93 28
212: #define ROFF_p1003_1c_95 29
213: #define ROFF_p1003_1g_2000 30
214: #define ROFF_p1003_2_92 31
215: #define ROFF_p1387_2_95 32
216: #define ROFF_p1003_2 33
217: #define ROFF_p1387_2 34
218: #define ROFF_isoC_90 35
219: #define ROFF_isoC_amd1 36
220: #define ROFF_isoC_tcor1 37
221: #define ROFF_isoC_tcor2 38
222: #define ROFF_isoC_99 39
223: #define ROFF_ansiC 40
224: #define ROFF_ansiC_89 41
225: #define ROFF_ansiC_99 42
226: #define ROFF_ieee754 43
227: #define ROFF_iso8802_3 44
228: #define ROFF_xpg3 45
229: #define ROFF_xpg4 46
230: #define ROFF_xpg4_2 47
231: #define ROFF_xpg4_3 48
232: #define ROFF_xbd5 49
233: #define ROFF_xcu5 50
234: #define ROFF_xsh5 51
235: #define ROFF_xns5 52
236: #define ROFF_xns5_2d2_0 53
237: #define ROFF_xcurses4_2 54
238: #define ROFF_susv2 55
239: #define ROFF_susv3 56
240: #define ROFF_svid4 57
1.12 kristaps 241: #define ROFF_Filled 58
242: #define ROFF_Words 59
243: #define ROFF_ARGMAX 60
1.6 kristaps 244:
1.27 kristaps 245: #define ROFF_MAXLINEARG 32
246:
1.7 kristaps 247: extern const char *const *toknames;
248: extern const char *const *tokargnames;
1.5 kristaps 249:
1.33 kristaps 250: enum roffmsg {
251: ROFF_WARN,
252: ROFF_ERROR
253: };
254:
255: enum roffmsec {
256: ROFF_MSEC_1,
257: ROFF_MSEC_2,
258: ROFF_MSEC_3,
259: ROFF_MSEC_3p,
260: ROFF_MSEC_4,
261: ROFF_MSEC_5,
262: ROFF_MSEC_6,
263: ROFF_MSEC_7,
264: ROFF_MSEC_8,
265: ROFF_MSEC_9,
266: ROFF_MSEC_UNASS,
267: ROFF_MSEC_DRAFT,
268: ROFF_MSEC_PAPER,
269: ROFF_MSEC_MAX
270: };
1.8 kristaps 271:
1.34 ! kristaps 272: #define ROFFSec_NMASK (0x07)
! 273:
! 274: #define ROFFSec_NAME (1 << 0)
! 275: #define ROFFSec_SYNOP (1 << 1)
! 276: #define ROFFSec_DESC (1 << 2)
! 277: #define ROFFSec_RETVAL (1 << 3)
! 278: #define ROFFSec_ENV (1 << 4)
! 279: #define ROFFSec_FILES (1 << 5)
! 280: #define ROFFSec_EX (1 << 6)
! 281: #define ROFFSec_DIAG (1 << 7)
! 282: #define ROFFSec_ERRS (1 << 8)
! 283: #define ROFFSec_SEEALSO (1 << 9)
! 284: #define ROFFSec_STAND (1 << 10)
! 285: #define ROFFSec_HIST (1 << 11)
! 286: #define ROFFSec_AUTH (1 << 12)
! 287: #define ROFFSec_CAVEATS (1 << 13)
! 288: #define ROFFSec_BUGS (1 << 14)
! 289: #define ROFFSec_OTHER (1 << 15)
! 290:
1.8 kristaps 291: struct roffcb {
1.15 kristaps 292: void (*roffmsg)(void *, enum roffmsg,
1.32 kristaps 293: const char *, const char *, const char *);
1.26 kristaps 294: int (*roffhead)(void *, const struct tm *, const char *,
1.33 kristaps 295: const char *, enum roffmsec, const char *);
1.15 kristaps 296: int (*rofftail)(void *);
1.32 kristaps 297: int (*roffdata)(void *, int, const char *, const char *);
298: int (*roffin)(void *, int, int *, const char **);
1.15 kristaps 299: int (*roffout)(void *, int);
1.32 kristaps 300: int (*roffblkin)(void *, int, int *, const char **);
1.15 kristaps 301: int (*roffblkout)(void *, int);
1.32 kristaps 302: int (*roffblkheadin)(void *, int, int *, const char **);
1.25 kristaps 303: int (*roffblkheadout)(void *, int);
1.32 kristaps 304: int (*roffblkbodyin)(void *, int, int *, const char **);
1.25 kristaps 305: int (*roffblkbodyout)(void *, int);
1.31 kristaps 306: int (*roffspecial)(void *, int, const char *,
1.32 kristaps 307: const int *, const char **, const char **);
1.8 kristaps 308: };
1.5 kristaps 309:
1.24 kristaps 310: struct rofftree;
311:
1.1 kristaps 312: __BEGIN_DECLS
313:
1.4 kristaps 314: typedef void (*(*md_init)(const struct md_args *,
315: struct md_mbuf *, const struct md_rbuf *));
1.16 kristaps 316: typedef int (*md_line)(void *, char *);
1.4 kristaps 317: typedef int (*md_exit)(void *, int);
318:
1.24 kristaps 319: void *md_init_html(const struct md_args *,
1.4 kristaps 320: struct md_mbuf *, const struct md_rbuf *);
1.24 kristaps 321: int md_line_html(void *, char *);
322: int md_exit_html(void *, int);
1.4 kristaps 323:
1.20 kristaps 324: void *md_init_xml(const struct md_args *,
1.4 kristaps 325: struct md_mbuf *, const struct md_rbuf *);
1.20 kristaps 326: int md_line_xml(void *, char *);
327: int md_exit_xml(void *, int);
1.1 kristaps 328:
329: int md_buf_puts(struct md_mbuf *, const char *, size_t);
330: int md_buf_putchar(struct md_mbuf *, char);
331: int md_buf_putstring(struct md_mbuf *, const char *);
332:
1.15 kristaps 333: struct rofftree *roff_alloc(const struct roffcb *, void *);
1.16 kristaps 334: int roff_engine(struct rofftree *, char *);
1.4 kristaps 335: int roff_free(struct rofftree *, int);
336:
1.29 kristaps 337: int rofftok_scan(const char *, int *);
1.27 kristaps 338:
1.1 kristaps 339: __END_DECLS
340:
341: #endif /*!PRIVATE_H*/
CVSweb