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