Annotation of texi2mdoc/extern.h, Revision 1.5
1.5 ! kristaps 1: /* $Id: extern.h,v 1.4 2015/02/21 21:49:18 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.5 ! kristaps 127: TEXICMD_USER_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,
1.5 ! kristaps 137: TEXICMD_MACRO,
1.1 kristaps 138: TEXICMD_MATH,
139: TEXICMD_MENU,
1.2 kristaps 140: TEXICMD_MINUS,
1.1 kristaps 141: TEXICMD_MULTITABLE,
142: TEXICMD_NEED,
143: TEXICMD_NEWLINE,
144: TEXICMD_NODE,
145: TEXICMD_NOINDENT,
146: TEXICMD_OPTION,
147: TEXICMD_PXREF,
148: TEXICMD_QUESTIONMARK,
149: TEXICMD_QUOTATION,
150: TEXICMD_PAGE,
151: TEXICMD_PARINDENT,
1.2 kristaps 152: TEXICMD_PERIOD,
1.4 kristaps 153: TEXICMD_PINDEX,
1.1 kristaps 154: TEXICMD_PRINTINDEX,
155: TEXICMD_R,
156: TEXICMD_RAISESECTIONS,
157: TEXICMD_REF,
1.4 kristaps 158: TEXICMD_REFILL,
1.1 kristaps 159: TEXICMD_RESULT,
160: TEXICMD_SAMP,
161: TEXICMD_SANSSERIF,
162: TEXICMD_SC,
163: TEXICMD_SECTION,
164: TEXICMD_SET,
165: TEXICMD_SETCHAPNEWPAGE,
166: TEXICMD_SETFILENAME,
167: TEXICMD_SETTITLE,
1.2 kristaps 168: TEXICMD_SHORTCONTENTS,
1.1 kristaps 169: TEXICMD_SLANTED,
170: TEXICMD_SP,
171: TEXICMD_SPACE,
172: TEXICMD_SMALLBOOK,
173: TEXICMD_SMALLDISPLAY,
174: TEXICMD_SMALLEXAMPLE,
175: TEXICMD_SMALLFORMAT,
176: TEXICMD_SMALLINDENTBLOCK,
177: TEXICMD_SQUIGGLE_LEFT,
178: TEXICMD_SQUIGGLE_RIGHT,
179: TEXICMD_STRONG,
180: TEXICMD_SUBHEADING,
181: TEXICMD_SUBSECTION,
1.4 kristaps 182: TEXICMD_SUBSUBHEADING,
1.1 kristaps 183: TEXICMD_SUBSUBSECTION,
184: TEXICMD_SUBTITLE,
1.2 kristaps 185: TEXICMD_SUMMARYCONTENTS,
1.3 kristaps 186: TEXICMD_SYNINDEX,
1.1 kristaps 187: TEXICMD_SYNCODEINDEX,
188: TEXICMD_T,
189: TEXICMD_TAB,
190: TEXICMD_TABSYM,
191: TEXICMD_TABLE,
192: TEXICMD_TEX,
193: TEXICMD_TEXSYM,
194: TEXICMD_TILDE,
1.2 kristaps 195: TEXICMD_TINDEX,
1.1 kristaps 196: TEXICMD_TITLE,
197: TEXICMD_TITLEFONT,
198: TEXICMD_TITLEPAGE,
199: TEXICMD_TOP,
200: TEXICMD_UMLAUT,
201: TEXICMD_UNNUMBERED,
202: TEXICMD_UNNUMBEREDSEC,
203: TEXICMD_UNNUMBEREDSUBSEC,
204: TEXICMD_UNNUMBEREDSUBSUBSEC,
205: TEXICMD_UREF,
206: TEXICMD_URL,
207: TEXICMD_VALUE,
208: TEXICMD_VAR,
1.2 kristaps 209: TEXICMD_VERBATIM,
1.1 kristaps 210: TEXICMD_VERBATIMINCLUDE,
211: TEXICMD_VINDEX,
212: TEXICMD_VSKIP,
213: TEXICMD_VTABLE,
214: TEXICMD_W,
215: TEXICMD_XREF,
216: TEXICMD__MAX
217: };
218:
219: /*
220: * The file currently being parsed.
221: * This keeps track of our location within that file.
222: */
223: struct texifile {
224: const char *name; /* name of the file */
225: size_t line; /* current line (from zero) */
226: size_t col; /* current column in line (from zero) */
227: char *map; /* mmap'd file */
228: size_t mapsz; /* size of mmap */
229: };
230:
231: struct texi;
232:
233: /*
234: * Callback for functions implementing texi commands.
235: */
236: typedef void (*texicmdfp)(struct texi *,
237: enum texicmd, const char *, size_t, size_t *);
238:
239: /*
240: * Describes Texinfo commands, whether native or overriden.
241: */
242: struct texitok {
243: texicmdfp fp; /* callback (or NULL if none) */
244: const char *tok; /* name of the token */
245: size_t len; /* strlen(tok) */
246: };
247:
248: enum texilist {
249: TEXILIST_NONE = 0,
250: TEXILIST_ITEM,
251: TEXILIST_NOITEM,
252: TEXILIST_TABLE
253: };
254:
255: struct texivalue {
256: char *key;
257: char *value;
258: };
259:
1.5 ! kristaps 260: struct teximacro {
! 261: char *key;
! 262: char *value;
! 263: char **args;
! 264: size_t argsz;
! 265: };
! 266:
1.1 kristaps 267: /*
268: * The main parse structure.
269: * This keeps any necessary information handy.
270: */
271: struct texi {
272: struct texifile files[64]; /* stack of open files */
273: size_t filepos; /* number of open files */
1.4 kristaps 274: const char *valstack[64]; /* stack of opened values */
275: size_t valstackpos; /* position in valstack */
1.1 kristaps 276: size_t outcol; /* column in output line */
277: char **dirs; /* texi directories */
278: size_t dirsz; /* number of texi directories */
279: char *title; /* title of document */
280: char *subtitle; /* subtitle of document */
281: int secoffs; /* see sectioner() */
1.3 kristaps 282: char **indexs; /* @defindex indices */
283: size_t indexsz; /* entries in indexs */
284: struct texivalue *vals; /* @value entries */
285: size_t valsz; /* entries in vals */
1.5 ! kristaps 286: struct teximacro *macros;
! 287: size_t macrosz;
1.1 kristaps 288: /*
289: * The following control what we output to the screen.
290: * The complexity is required to accomodate for mdoc(7).
291: */
292: enum texilist list; /* current list (set recursively) */
293: int outmacro; /* if >0, output is in line macro */
294: int seenws; /* ws has been seen (and ignored) */
295: int seenvs; /* newline has been Pp'd */
296: int ign; /* if >0, don't print anything */
297: int literal; /* if >0, literal context */
298: };
299:
300: #define isws(_x) \
301: (' ' == (_x) || '\t' == (_x))
302: #define ismspace(_x) \
303: (isws((_x)) || '\n' == (_x))
304:
305: __BEGIN_DECLS
306:
307: void advance(struct texi *, const char *, size_t *);
308: size_t advanceeoln(struct texi *, const char *, size_t, size_t *, int);
309: void advanceto(struct texi *, const char *, size_t *, size_t);
310:
1.5 ! kristaps 311: char **argparse(struct texi *, const char *, size_t, size_t *, size_t *);
! 312:
1.1 kristaps 313: int parsearg(struct texi *, const char *, size_t, size_t *, size_t);
314: void parsebracket(struct texi *, const char *, size_t, size_t *);
315: void parsefile(struct texi *, const char *, int);
316: int parselinearg(struct texi *, const char *, size_t, size_t *);
317: void parseeof(struct texi *, const char *, size_t);
318: void parseeoln(struct texi *, const char *, size_t, size_t *);
319: void parsesingle(struct texi *, const char *, size_t, size_t *);
320: void parseto(struct texi *, const char *, size_t, size_t *, const char *);
321:
1.3 kristaps 322: void texiabort(struct texi *, const char *)
323: __attribute__((noreturn));
1.1 kristaps 324: enum texicmd
1.5 ! kristaps 325: texicmd(struct texi *, const char *, size_t, size_t,
! 326: size_t *, struct teximacro **);
1.1 kristaps 327: void texierr(struct texi *, const char *, ...)
1.3 kristaps 328: __attribute__((format(printf, 2, 3)))
329: __attribute__((noreturn));
1.1 kristaps 330: void texiexit(struct texi *p);
331: void texifilepop(struct texi *);
332: void teximacro(struct texi *, const char *);
333: void teximacroclose(struct texi *);
334: void teximacroopen(struct texi *, const char *);
335: void texipunctuate(struct texi *, const char *, size_t, size_t *);
336: void texiputchar(struct texi *p, char);
337: void texiputchars(struct texi *, const char *);
338: void texivspace(struct texi *);
339: void texiwarn(const struct texi *, const char *, ...)
340: __attribute__((format(printf, 2, 3)));
1.2 kristaps 341:
342: void valueadd(struct texi *, char *, char *);
343: const char *
344: valueblookup(struct texi *, const char *, size_t, size_t *);
345: void valuelclear(struct texi *, const char *, size_t, size_t *);
346: const char *
347: valuellookup(struct texi *, const char *, size_t, size_t *);
1.1 kristaps 348:
349: extern const struct texitok *const texitoks;
350:
351: __END_DECLS
352:
353: #endif
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to extern.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / texi2mdoc