Annotation of texi2mdoc/extern.h, Revision 1.4
1.4 ! kristaps 1: /* $Id: extern.h,v 1.3 2015/02/21 17:00:33 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2015 Kristaps Dzonsons <kristaps@bsd.lv>
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 above
7: * copyright notice and this permission notice appear in all copies.
8: *
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.
16: */
17: #ifndef EXTERN_H
18: #define EXTERN_H
19:
20: /*
21: * This defines each one of the Texinfo commands that we understand.
22: * Obviously this only refers to native commands; overriden names are a
23: * different story.
24: */
25: enum texicmd {
26: TEXICMD_ACRONYM,
27: TEXICMD_ACUTE,
28: TEXICMD_A4PAPER,
29: TEXICMD_ANCHOR,
30: TEXICMD_APPENDIX,
31: TEXICMD_APPENDIXSEC,
32: TEXICMD_APPENDIXSUBSEC,
33: TEXICMD_APPENDIXSUBSUBSEC,
1.2 kristaps 34: TEXICMD_ASIS,
1.1 kristaps 35: TEXICMD_ASTERISK,
36: TEXICMD_AT,
37: TEXICMD_AUTHOR,
38: TEXICMD_B,
39: TEXICMD_BANG,
40: TEXICMD_BULLET,
41: TEXICMD_BYE,
42: TEXICMD_CENTER,
43: TEXICMD_CHAPTER,
44: TEXICMD_CINDEX,
45: TEXICMD_CIRCUMFLEX,
46: TEXICMD_CITE,
47: TEXICMD_CLEAR,
48: TEXICMD_CODE,
49: TEXICMD_COLON,
50: TEXICMD_COLUMNFRACTIONS,
51: TEXICMD_COMMAND,
52: TEXICMD_COMMENT,
53: TEXICMD_COMMENT_LONG,
54: TEXICMD_CONTENTS,
55: TEXICMD_COPYING,
56: TEXICMD_COPYRIGHT,
1.3 kristaps 57: TEXICMD_DEFCODEINDEX,
1.1 kristaps 58: TEXICMD_DEFFN,
59: TEXICMD_DEFFNX,
1.3 kristaps 60: TEXICMD_DEFINDEX,
1.1 kristaps 61: TEXICMD_DEFMAC,
62: TEXICMD_DEFMACX,
63: TEXICMD_DEFTP,
64: TEXICMD_DEFTPX,
65: TEXICMD_DEFTYPEFN,
66: TEXICMD_DEFTYPEFNX,
67: TEXICMD_DEFTYPEFUN,
68: TEXICMD_DEFTYPEFUNX,
69: TEXICMD_DEFTYPEVAR,
70: TEXICMD_DEFTYPEVARX,
71: TEXICMD_DEFTYPEVR,
72: TEXICMD_DEFTYPEVRX,
73: TEXICMD_DEFUN,
74: TEXICMD_DEFUNX,
75: TEXICMD_DEFVAR,
76: TEXICMD_DEFVARX,
77: TEXICMD_DEFVR,
78: TEXICMD_DEFVRX,
79: TEXICMD_DETAILMENU,
80: TEXICMD_DFN,
81: TEXICMD_DIRCATEGORY,
82: TEXICMD_DIRENTRY,
83: TEXICMD_DISPLAY,
1.4 ! kristaps 84: TEXICMD_DMN,
1.1 kristaps 85: TEXICMD_DOTS,
86: TEXICMD_EMAIL,
87: TEXICMD_EMPH,
88: TEXICMD_END,
89: TEXICMD_ENUMERATE,
90: TEXICMD_ENV,
1.4 ! kristaps 91: TEXICMD_EQUIV,
1.1 kristaps 92: TEXICMD_ERROR,
93: TEXICMD_EXAMPLE,
1.2 kristaps 94: TEXICMD_EXDENT,
1.1 kristaps 95: TEXICMD_EXPANSION,
96: TEXICMD_FILE,
97: TEXICMD_FINALOUT,
98: TEXICMD_FINDEX,
99: TEXICMD_FTABLE,
100: TEXICMD_FORMAT,
101: TEXICMD_GRAVE,
102: TEXICMD_GROUP,
103: TEXICMD_HEADING,
104: TEXICMD_HEADINGS,
105: TEXICMD_HEADITEM,
1.2 kristaps 106: TEXICMD_HTML,
1.1 kristaps 107: TEXICMD_HYPHEN,
108: TEXICMD_I,
109: TEXICMD_IFCLEAR,
110: TEXICMD_IFDOCBOOK,
111: TEXICMD_IFHTML,
112: TEXICMD_IFINFO,
113: TEXICMD_IFNOTDOCBOOK,
114: TEXICMD_IFNOTHTML,
115: TEXICMD_IFNOTINFO,
116: TEXICMD_IFNOTPLAINTEXT,
117: TEXICMD_IFNOTTEX,
118: TEXICMD_IFNOTXML,
119: TEXICMD_IFPLAINTEXT,
120: TEXICMD_IFTEX,
121: TEXICMD_IFSET,
122: TEXICMD_IFXML,
123: TEXICMD_IGNORE,
124: TEXICMD_IMAGE,
125: TEXICMD_INCLUDE,
126: TEXICMD_INDENTBLOCK,
1.3 kristaps 127: TEXICMD_INDEX,
1.1 kristaps 128: TEXICMD_INSERTCOPYING,
129: TEXICMD_ITEM,
130: TEXICMD_ITEMIZE,
131: TEXICMD_ITEMX,
132: TEXICMD_KBD,
133: TEXICMD_KEY,
134: TEXICMD_KINDEX,
135: TEXICMD_LATEX,
136: TEXICMD_LOWERSECTIONS,
137: TEXICMD_MATH,
138: TEXICMD_MENU,
1.2 kristaps 139: TEXICMD_MINUS,
1.1 kristaps 140: TEXICMD_MULTITABLE,
141: TEXICMD_NEED,
142: TEXICMD_NEWLINE,
143: TEXICMD_NODE,
144: TEXICMD_NOINDENT,
145: TEXICMD_OPTION,
146: TEXICMD_PXREF,
147: TEXICMD_QUESTIONMARK,
148: TEXICMD_QUOTATION,
149: TEXICMD_PAGE,
150: TEXICMD_PARINDENT,
1.2 kristaps 151: TEXICMD_PERIOD,
1.4 ! kristaps 152: TEXICMD_PINDEX,
1.1 kristaps 153: TEXICMD_PRINTINDEX,
154: TEXICMD_R,
155: TEXICMD_RAISESECTIONS,
156: TEXICMD_REF,
1.4 ! kristaps 157: TEXICMD_REFILL,
1.1 kristaps 158: TEXICMD_RESULT,
159: TEXICMD_SAMP,
160: TEXICMD_SANSSERIF,
161: TEXICMD_SC,
162: TEXICMD_SECTION,
163: TEXICMD_SET,
164: TEXICMD_SETCHAPNEWPAGE,
165: TEXICMD_SETFILENAME,
166: TEXICMD_SETTITLE,
1.2 kristaps 167: TEXICMD_SHORTCONTENTS,
1.1 kristaps 168: TEXICMD_SLANTED,
169: TEXICMD_SP,
170: TEXICMD_SPACE,
171: TEXICMD_SMALLBOOK,
172: TEXICMD_SMALLDISPLAY,
173: TEXICMD_SMALLEXAMPLE,
174: TEXICMD_SMALLFORMAT,
175: TEXICMD_SMALLINDENTBLOCK,
176: TEXICMD_SQUIGGLE_LEFT,
177: TEXICMD_SQUIGGLE_RIGHT,
178: TEXICMD_STRONG,
179: TEXICMD_SUBHEADING,
180: TEXICMD_SUBSECTION,
1.4 ! kristaps 181: TEXICMD_SUBSUBHEADING,
1.1 kristaps 182: TEXICMD_SUBSUBSECTION,
183: TEXICMD_SUBTITLE,
1.2 kristaps 184: TEXICMD_SUMMARYCONTENTS,
1.3 kristaps 185: TEXICMD_SYNINDEX,
1.1 kristaps 186: TEXICMD_SYNCODEINDEX,
187: TEXICMD_T,
188: TEXICMD_TAB,
189: TEXICMD_TABSYM,
190: TEXICMD_TABLE,
191: TEXICMD_TEX,
192: TEXICMD_TEXSYM,
193: TEXICMD_TILDE,
1.2 kristaps 194: TEXICMD_TINDEX,
1.1 kristaps 195: TEXICMD_TITLE,
196: TEXICMD_TITLEFONT,
197: TEXICMD_TITLEPAGE,
198: TEXICMD_TOP,
199: TEXICMD_UMLAUT,
200: TEXICMD_UNNUMBERED,
201: TEXICMD_UNNUMBEREDSEC,
202: TEXICMD_UNNUMBEREDSUBSEC,
203: TEXICMD_UNNUMBEREDSUBSUBSEC,
204: TEXICMD_UREF,
205: TEXICMD_URL,
206: TEXICMD_VALUE,
207: TEXICMD_VAR,
1.2 kristaps 208: TEXICMD_VERBATIM,
1.1 kristaps 209: TEXICMD_VERBATIMINCLUDE,
210: TEXICMD_VINDEX,
211: TEXICMD_VSKIP,
212: TEXICMD_VTABLE,
213: TEXICMD_W,
214: TEXICMD_XREF,
215: TEXICMD__MAX
216: };
217:
218: /*
219: * The file currently being parsed.
220: * This keeps track of our location within that file.
221: */
222: struct texifile {
223: const char *name; /* name of the file */
224: size_t line; /* current line (from zero) */
225: size_t col; /* current column in line (from zero) */
226: char *map; /* mmap'd file */
227: size_t mapsz; /* size of mmap */
228: };
229:
230: struct texi;
231:
232: /*
233: * Callback for functions implementing texi commands.
234: */
235: typedef void (*texicmdfp)(struct texi *,
236: enum texicmd, const char *, size_t, size_t *);
237:
238: /*
239: * Describes Texinfo commands, whether native or overriden.
240: */
241: struct texitok {
242: texicmdfp fp; /* callback (or NULL if none) */
243: const char *tok; /* name of the token */
244: size_t len; /* strlen(tok) */
245: };
246:
247: enum texilist {
248: TEXILIST_NONE = 0,
249: TEXILIST_ITEM,
250: TEXILIST_NOITEM,
251: TEXILIST_TABLE
252: };
253:
254: struct texivalue {
255: char *key;
256: char *value;
257: };
258:
259: /*
260: * The main parse structure.
261: * This keeps any necessary information handy.
262: */
263: struct texi {
264: struct texifile files[64]; /* stack of open files */
265: size_t filepos; /* number of open files */
1.4 ! kristaps 266: const char *valstack[64]; /* stack of opened values */
! 267: size_t valstackpos; /* position in valstack */
1.1 kristaps 268: size_t outcol; /* column in output line */
269: char **dirs; /* texi directories */
270: size_t dirsz; /* number of texi directories */
271: char *title; /* title of document */
272: char *subtitle; /* subtitle of document */
273: int secoffs; /* see sectioner() */
1.3 kristaps 274: char **indexs; /* @defindex indices */
275: size_t indexsz; /* entries in indexs */
276: struct texivalue *vals; /* @value entries */
277: size_t valsz; /* entries in vals */
1.1 kristaps 278: /*
279: * The following control what we output to the screen.
280: * The complexity is required to accomodate for mdoc(7).
281: */
282: enum texilist list; /* current list (set recursively) */
283: int outmacro; /* if >0, output is in line macro */
284: int seenws; /* ws has been seen (and ignored) */
285: int seenvs; /* newline has been Pp'd */
286: int ign; /* if >0, don't print anything */
287: int literal; /* if >0, literal context */
288: };
289:
290: #define isws(_x) \
291: (' ' == (_x) || '\t' == (_x))
292: #define ismspace(_x) \
293: (isws((_x)) || '\n' == (_x))
294:
295: __BEGIN_DECLS
296:
297: void advance(struct texi *, const char *, size_t *);
298: size_t advanceeoln(struct texi *, const char *, size_t, size_t *, int);
299: void advanceto(struct texi *, const char *, size_t *, size_t);
300:
301: int parsearg(struct texi *, const char *, size_t, size_t *, size_t);
302: void parsebracket(struct texi *, const char *, size_t, size_t *);
303: void parsefile(struct texi *, const char *, int);
304: int parselinearg(struct texi *, const char *, size_t, size_t *);
305: void parseeof(struct texi *, const char *, size_t);
306: void parseeoln(struct texi *, const char *, size_t, size_t *);
307: void parsesingle(struct texi *, const char *, size_t, size_t *);
308: void parseto(struct texi *, const char *, size_t, size_t *, const char *);
309:
1.3 kristaps 310: void texiabort(struct texi *, const char *)
311: __attribute__((noreturn));
1.1 kristaps 312: enum texicmd
313: texicmd(struct texi *, const char *, size_t, size_t, size_t *);
314: void texierr(struct texi *, const char *, ...)
1.3 kristaps 315: __attribute__((format(printf, 2, 3)))
316: __attribute__((noreturn));
1.1 kristaps 317: void texiexit(struct texi *p);
318: void texifilepop(struct texi *);
319: void teximacro(struct texi *, const char *);
320: void teximacroclose(struct texi *);
321: void teximacroopen(struct texi *, const char *);
322: void texipunctuate(struct texi *, const char *, size_t, size_t *);
323: void texiputchar(struct texi *p, char);
324: void texiputchars(struct texi *, const char *);
325: void texivspace(struct texi *);
326: void texiwarn(const struct texi *, const char *, ...)
327: __attribute__((format(printf, 2, 3)));
1.2 kristaps 328:
329: void valueadd(struct texi *, char *, char *);
330: const char *
331: valueblookup(struct texi *, const char *, size_t, size_t *);
332: void valuelclear(struct texi *, const char *, size_t, size_t *);
333: const char *
334: valuellookup(struct texi *, const char *, size_t, size_t *);
1.1 kristaps 335:
336: extern const struct texitok *const texitoks;
337:
338: __END_DECLS
339:
340: #endif
CVSweb