Annotation of texi2mdoc/extern.h, Revision 1.21
1.21 ! kristaps 1: /* $Id: extern.h,v 1.20 2015/02/28 13:16:44 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
1.17 kristaps 19:
20: #if !defined(__BEGIN_DECLS)
21: # ifdef __cplusplus
22: # define __BEGIN_DECLS extern "C" {
23: # else
24: # define __BEGIN_DECLS
25: # endif
26: #endif
27: #if !defined(__END_DECLS)
28: # ifdef __cplusplus
29: # define __END_DECLS }
30: # else
31: # define __END_DECLS
32: # endif
33: #endif
1.1 kristaps 34:
35: /*
36: * This defines each one of the Texinfo commands that we understand.
37: * Obviously this only refers to native commands; overriden names are a
38: * different story.
39: */
40: enum texicmd {
1.12 kristaps 41: TEXICMD_A4PAPER,
42: TEXICMD_AA,
43: TEXICMD_AASMALL,
1.1 kristaps 44: TEXICMD_ACRONYM,
45: TEXICMD_ACUTE,
1.12 kristaps 46: TEXICMD_AE,
47: TEXICMD_AESMALL,
1.1 kristaps 48: TEXICMD_ANCHOR,
49: TEXICMD_APPENDIX,
50: TEXICMD_APPENDIXSEC,
51: TEXICMD_APPENDIXSUBSEC,
52: TEXICMD_APPENDIXSUBSUBSEC,
1.2 kristaps 53: TEXICMD_ASIS,
1.1 kristaps 54: TEXICMD_ASTERISK,
55: TEXICMD_AT,
56: TEXICMD_AUTHOR,
57: TEXICMD_B,
58: TEXICMD_BANG,
59: TEXICMD_BULLET,
60: TEXICMD_BYE,
1.9 kristaps 61: TEXICMD_CARTOUCHE,
62: TEXICMD_CEDILLA,
1.1 kristaps 63: TEXICMD_CENTER,
64: TEXICMD_CHAPTER,
65: TEXICMD_CINDEX,
66: TEXICMD_CIRCUMFLEX,
67: TEXICMD_CITE,
68: TEXICMD_CLEAR,
69: TEXICMD_CODE,
70: TEXICMD_COLON,
71: TEXICMD_COLUMNFRACTIONS,
1.10 kristaps 72: TEXICMD_COMMA,
1.1 kristaps 73: TEXICMD_COMMAND,
74: TEXICMD_COMMENT,
75: TEXICMD_COMMENT_LONG,
76: TEXICMD_CONTENTS,
77: TEXICMD_COPYING,
78: TEXICMD_COPYRIGHT,
1.3 kristaps 79: TEXICMD_DEFCODEINDEX,
1.1 kristaps 80: TEXICMD_DEFFN,
81: TEXICMD_DEFFNX,
1.3 kristaps 82: TEXICMD_DEFINDEX,
1.1 kristaps 83: TEXICMD_DEFMAC,
84: TEXICMD_DEFMACX,
85: TEXICMD_DEFTP,
86: TEXICMD_DEFTPX,
87: TEXICMD_DEFTYPEFN,
88: TEXICMD_DEFTYPEFNX,
89: TEXICMD_DEFTYPEFUN,
90: TEXICMD_DEFTYPEFUNX,
1.9 kristaps 91: TEXICMD_DEFTYPEMETHOD,
92: TEXICMD_DEFTYPEMETHODX,
1.1 kristaps 93: TEXICMD_DEFTYPEVAR,
94: TEXICMD_DEFTYPEVARX,
95: TEXICMD_DEFTYPEVR,
96: TEXICMD_DEFTYPEVRX,
97: TEXICMD_DEFUN,
98: TEXICMD_DEFUNX,
99: TEXICMD_DEFVAR,
100: TEXICMD_DEFVARX,
101: TEXICMD_DEFVR,
102: TEXICMD_DEFVRX,
103: TEXICMD_DETAILMENU,
104: TEXICMD_DFN,
1.12 kristaps 105: TEXICMD_DH,
106: TEXICMD_DHSMALL,
1.1 kristaps 107: TEXICMD_DIRCATEGORY,
108: TEXICMD_DIRENTRY,
109: TEXICMD_DISPLAY,
1.4 kristaps 110: TEXICMD_DMN,
1.11 kristaps 111: TEXICMD_DOCUMENTDESCRPITION,
112: TEXICMD_DOCUMENTENCODING,
1.14 kristaps 113: TEXICMD_DOCUMENTLANGUAGE,
1.12 kristaps 114: TEXICMD_DOTACCENT,
115: TEXICMD_DOTLESS,
1.1 kristaps 116: TEXICMD_DOTS,
117: TEXICMD_EMAIL,
118: TEXICMD_EMPH,
119: TEXICMD_END,
1.9 kristaps 120: TEXICMD_ENDDOTS,
1.1 kristaps 121: TEXICMD_ENUMERATE,
122: TEXICMD_ENV,
1.4 kristaps 123: TEXICMD_EQUIV,
1.1 kristaps 124: TEXICMD_ERROR,
1.13 kristaps 125: TEXICMD_EURO,
1.1 kristaps 126: TEXICMD_EXAMPLE,
1.12 kristaps 127: TEXICMD_EXCLAMDOWN,
1.2 kristaps 128: TEXICMD_EXDENT,
1.1 kristaps 129: TEXICMD_EXPANSION,
130: TEXICMD_FILE,
131: TEXICMD_FINALOUT,
132: TEXICMD_FINDEX,
1.14 kristaps 133: TEXICMD_FLUSHLEFT,
134: TEXICMD_FLUSHRIGHT,
135: TEXICMD_FIRSTPARAGRAPHINDENT,
1.7 kristaps 136: TEXICMD_FOOTNOTE,
1.14 kristaps 137: TEXICMD_FOOTNOTESTYLE,
1.1 kristaps 138: TEXICMD_FTABLE,
139: TEXICMD_FORMAT,
1.13 kristaps 140: TEXICMD_GEQ,
1.1 kristaps 141: TEXICMD_GRAVE,
142: TEXICMD_GROUP,
1.13 kristaps 143: TEXICMD_GUILLEMETLEFT,
144: TEXICMD_GUILLEMETRIGHT,
145: TEXICMD_GUILLEMOTLEFT,
146: TEXICMD_GUILLEMOTRIGHT,
147: TEXICMD_GUILSINGLLEFT,
148: TEXICMD_GUILSINGLRIGHT,
1.12 kristaps 149: TEXICMD_H,
1.1 kristaps 150: TEXICMD_HEADING,
151: TEXICMD_HEADINGS,
152: TEXICMD_HEADITEM,
1.2 kristaps 153: TEXICMD_HTML,
1.1 kristaps 154: TEXICMD_HYPHEN,
155: TEXICMD_I,
156: TEXICMD_IFCLEAR,
157: TEXICMD_IFDOCBOOK,
158: TEXICMD_IFHTML,
159: TEXICMD_IFINFO,
160: TEXICMD_IFNOTDOCBOOK,
161: TEXICMD_IFNOTHTML,
162: TEXICMD_IFNOTINFO,
163: TEXICMD_IFNOTPLAINTEXT,
164: TEXICMD_IFNOTTEX,
165: TEXICMD_IFNOTXML,
166: TEXICMD_IFPLAINTEXT,
167: TEXICMD_IFTEX,
168: TEXICMD_IFSET,
169: TEXICMD_IFXML,
170: TEXICMD_IGNORE,
171: TEXICMD_IMAGE,
172: TEXICMD_INCLUDE,
173: TEXICMD_INDENTBLOCK,
1.14 kristaps 174: TEXICMD_INDICATEURL,
1.9 kristaps 175: TEXICMD_INFOREF,
1.1 kristaps 176: TEXICMD_INSERTCOPYING,
177: TEXICMD_ITEM,
178: TEXICMD_ITEMIZE,
179: TEXICMD_ITEMX,
180: TEXICMD_KBD,
181: TEXICMD_KEY,
182: TEXICMD_KINDEX,
1.12 kristaps 183: TEXICMD_L,
1.1 kristaps 184: TEXICMD_LATEX,
1.13 kristaps 185: TEXICMD_LEQ,
1.1 kristaps 186: TEXICMD_LOWERSECTIONS,
1.12 kristaps 187: TEXICMD_LSMALL,
1.5 kristaps 188: TEXICMD_MACRO,
1.12 kristaps 189: TEXICMD_MACRON,
1.1 kristaps 190: TEXICMD_MATH,
191: TEXICMD_MENU,
1.2 kristaps 192: TEXICMD_MINUS,
1.1 kristaps 193: TEXICMD_MULTITABLE,
194: TEXICMD_NEED,
195: TEXICMD_NEWLINE,
196: TEXICMD_NODE,
197: TEXICMD_NOINDENT,
1.12 kristaps 198: TEXICMD_O,
199: TEXICMD_OE,
200: TEXICMD_OESMALL,
201: TEXICMD_OGONEK,
1.1 kristaps 202: TEXICMD_OPTION,
1.12 kristaps 203: TEXICMD_ORDF,
204: TEXICMD_ORDM,
205: TEXICMD_OSMALL,
1.1 kristaps 206: TEXICMD_PAGE,
207: TEXICMD_PARINDENT,
1.2 kristaps 208: TEXICMD_PERIOD,
1.4 kristaps 209: TEXICMD_PINDEX,
1.13 kristaps 210: TEXICMD_POUNDS,
1.1 kristaps 211: TEXICMD_PRINTINDEX,
1.12 kristaps 212: TEXICMD_PXREF,
213: TEXICMD_QUESTIONDOWN,
214: TEXICMD_QUESTIONMARK,
215: TEXICMD_QUOTATION,
1.13 kristaps 216: TEXICMD_QUOTEDBLBASE,
217: TEXICMD_QUOTEDBLLEFT,
218: TEXICMD_QUOTEDBLRIGHT,
219: TEXICMD_QUOTESINGLBASE,
220: TEXICMD_QUOTELEFT,
221: TEXICMD_QUOTERIGHT,
1.1 kristaps 222: TEXICMD_R,
223: TEXICMD_RAISESECTIONS,
224: TEXICMD_REF,
1.4 kristaps 225: TEXICMD_REFILL,
1.13 kristaps 226: TEXICMD_REGISTEREDSYMBOL,
1.1 kristaps 227: TEXICMD_RESULT,
1.12 kristaps 228: TEXICMD_RINGACCENT,
1.1 kristaps 229: TEXICMD_SAMP,
230: TEXICMD_SANSSERIF,
231: TEXICMD_SC,
232: TEXICMD_SECTION,
233: TEXICMD_SET,
234: TEXICMD_SETCHAPNEWPAGE,
1.10 kristaps 235: TEXICMD_SETCONTENTSAFTER,
1.1 kristaps 236: TEXICMD_SETFILENAME,
237: TEXICMD_SETTITLE,
1.2 kristaps 238: TEXICMD_SHORTCONTENTS,
1.1 kristaps 239: TEXICMD_SLANTED,
1.9 kristaps 240: TEXICMD_SLASH,
1.1 kristaps 241: TEXICMD_SP,
242: TEXICMD_SPACE,
243: TEXICMD_SMALLBOOK,
244: TEXICMD_SMALLDISPLAY,
245: TEXICMD_SMALLEXAMPLE,
246: TEXICMD_SMALLFORMAT,
247: TEXICMD_SMALLINDENTBLOCK,
248: TEXICMD_SQUIGGLE_LEFT,
249: TEXICMD_SQUIGGLE_RIGHT,
1.10 kristaps 250: TEXICMD_SS,
1.1 kristaps 251: TEXICMD_STRONG,
252: TEXICMD_SUBHEADING,
253: TEXICMD_SUBSECTION,
1.4 kristaps 254: TEXICMD_SUBSUBHEADING,
1.1 kristaps 255: TEXICMD_SUBSUBSECTION,
256: TEXICMD_SUBTITLE,
1.2 kristaps 257: TEXICMD_SUMMARYCONTENTS,
1.3 kristaps 258: TEXICMD_SYNINDEX,
1.1 kristaps 259: TEXICMD_SYNCODEINDEX,
260: TEXICMD_T,
261: TEXICMD_TAB,
262: TEXICMD_TABSYM,
263: TEXICMD_TABLE,
264: TEXICMD_TEX,
265: TEXICMD_TEXSYM,
1.13 kristaps 266: TEXICMD_TEXTDEGREE,
1.12 kristaps 267: TEXICMD_TH,
268: TEXICMD_THSMALL,
1.10 kristaps 269: TEXICMD_TIE,
1.12 kristaps 270: TEXICMD_TIEACCENT,
1.1 kristaps 271: TEXICMD_TILDE,
1.2 kristaps 272: TEXICMD_TINDEX,
1.1 kristaps 273: TEXICMD_TITLE,
274: TEXICMD_TITLEFONT,
275: TEXICMD_TITLEPAGE,
276: TEXICMD_TOP,
1.12 kristaps 277: TEXICMD_U,
278: TEXICMD_UBARACCENT,
279: TEXICMD_UDOTACCENT,
1.1 kristaps 280: TEXICMD_UMLAUT,
281: TEXICMD_UNNUMBERED,
282: TEXICMD_UNNUMBEREDSEC,
283: TEXICMD_UNNUMBEREDSUBSEC,
284: TEXICMD_UNNUMBEREDSUBSUBSEC,
285: TEXICMD_UREF,
286: TEXICMD_URL,
1.9 kristaps 287: TEXICMD_USER_INDEX,
1.12 kristaps 288: TEXICMD_V,
1.1 kristaps 289: TEXICMD_VALUE,
290: TEXICMD_VAR,
1.8 kristaps 291: TEXICMD_VERB,
1.2 kristaps 292: TEXICMD_VERBATIM,
1.1 kristaps 293: TEXICMD_VERBATIMINCLUDE,
294: TEXICMD_VINDEX,
295: TEXICMD_VSKIP,
296: TEXICMD_VTABLE,
297: TEXICMD_W,
298: TEXICMD_XREF,
299: TEXICMD__MAX
300: };
301:
1.11 kristaps 302: enum texisrc {
303: TEXISRC_FILE,
304: TEXISRC_STDIN
305: };
306:
1.1 kristaps 307: /*
308: * The file currently being parsed.
309: * This keeps track of our location within that file.
310: */
311: struct texifile {
1.11 kristaps 312: enum texisrc type; /* type of file */
1.1 kristaps 313: const char *name; /* name of the file */
314: size_t line; /* current line (from zero) */
315: size_t col; /* current column in line (from zero) */
1.15 kristaps 316: char *map; /* allocated file buffer */
317: size_t mapsz; /* size of map */
318: size_t mapmaxsz; /* full size of map */
1.16 kristaps 319: size_t insplice; /* how many bytes left in splice */
1.18 kristaps 320: size_t depth; /* pasted macro recursive depth */
1.1 kristaps 321: };
322:
323: struct texi;
324:
325: /*
326: * Callback for functions implementing texi commands.
327: */
1.15 kristaps 328: typedef void (*texicmdfp)(struct texi *, enum texicmd, size_t *);
1.1 kristaps 329:
330: /*
331: * Describes Texinfo commands, whether native or overriden.
332: */
333: struct texitok {
334: texicmdfp fp; /* callback (or NULL if none) */
335: const char *tok; /* name of the token */
336: size_t len; /* strlen(tok) */
337: };
338:
1.11 kristaps 339: /*
340: * These values instruct us on whether a list (or table) of some type is
341: * currently being parsed.
342: */
1.1 kristaps 343: enum texilist {
344: TEXILIST_NONE = 0,
345: TEXILIST_ITEM,
346: TEXILIST_NOITEM,
347: TEXILIST_TABLE
348: };
349:
1.11 kristaps 350: /*
351: * Hold values assigned with @set and retrieved with @value.
352: * These values can contain arbitrary Texinfo.
353: */
1.1 kristaps 354: struct texivalue {
1.11 kristaps 355: char *key; /* the nil-terminated value name */
356: char *value; /* the nil-terminated value */
1.1 kristaps 357: };
358:
1.11 kristaps 359: /*
360: * Macros are (possibly-recursive) Texinfo sequences created with @macro
361: * and filled in by arguments when invoked.
362: */
1.5 kristaps 363: struct teximacro {
1.11 kristaps 364: char *key; /* nil-terminated macro name */
365: char *value; /* nil-terminated value */
366: char **args; /* array of argument names (or NULL) */
367: size_t argsz; /* array size */
1.5 kristaps 368: };
369:
1.1 kristaps 370: /*
371: * The main parse structure.
372: * This keeps any necessary information handy.
373: */
374: struct texi {
1.21 ! kristaps 375: const char *chapters; /* are we splitting chapters */
! 376: size_t chapnum;
! 377: char **dirs; /* texi directories */
! 378: size_t dirsz; /* number of texi directories */
! 379: FILE *outfile;
! 380: /*
! 381: * Run-time parameters.
! 382: */
1.1 kristaps 383: struct texifile files[64]; /* stack of open files */
384: size_t filepos; /* number of open files */
1.4 kristaps 385: const char *valstack[64]; /* stack of opened values */
386: size_t valstackpos; /* position in valstack */
1.1 kristaps 387: char *title; /* title of document */
388: char *subtitle; /* subtitle of document */
389: int secoffs; /* see sectioner() */
1.3 kristaps 390: char **indexs; /* @defindex indices */
391: size_t indexsz; /* entries in indexs */
392: struct texivalue *vals; /* @value entries */
393: size_t valsz; /* entries in vals */
1.11 kristaps 394: struct teximacro *macros; /* @macro entries */
395: size_t macrosz; /* entries in macros */
1.1 kristaps 396: /*
397: * The following control what we output to the screen.
398: * The complexity is required to accomodate for mdoc(7).
399: */
400: enum texilist list; /* current list (set recursively) */
401: int outmacro; /* if >0, output is in line macro */
1.21 ! kristaps 402: size_t outcol; /* column in output line */
1.1 kristaps 403: int seenws; /* ws has been seen (and ignored) */
404: int seenvs; /* newline has been Pp'd */
405: int ign; /* if >0, don't print anything */
406: int literal; /* if >0, literal context */
407: };
408:
1.15 kristaps 409: #define BUF(_p) ((_p)->files[(_p)->filepos - 1].map)
410: #define BUFSZ(_p) ((_p)->files[(_p)->filepos - 1].mapsz)
411:
1.1 kristaps 412: #define isws(_x) \
413: (' ' == (_x) || '\t' == (_x))
414: #define ismspace(_x) \
415: (isws((_x)) || '\n' == (_x))
416:
417: __BEGIN_DECLS
418:
1.15 kristaps 419: void advance(struct texi *, size_t *);
420: size_t advanceeoln(struct texi *, size_t *, int);
421: void advanceto(struct texi *, size_t *, size_t);
1.1 kristaps 422:
1.15 kristaps 423: char **argparse(struct texi *, size_t *, size_t *, size_t);
1.5 kristaps 424:
1.15 kristaps 425: int parsearg(struct texi *, size_t *, size_t);
1.19 kristaps 426: void parsebracket(struct texi *, size_t *, int);
1.11 kristaps 427: void parsestdin(struct texi *);
1.1 kristaps 428: void parsefile(struct texi *, const char *, int);
1.15 kristaps 429: int parselinearg(struct texi *, size_t *);
430: void parseeoln(struct texi *, size_t *);
431: void parseto(struct texi *, size_t *, const char *);
1.1 kristaps 432:
1.3 kristaps 433: void texiabort(struct texi *, const char *)
434: __attribute__((noreturn));
1.1 kristaps 435: enum texicmd
1.20 kristaps 436: texicmd(const struct texi *, size_t, size_t *, struct teximacro **);
437: enum texicmd
438: peekcmd(const struct texi *, size_t);
1.1 kristaps 439: void texierr(struct texi *, const char *, ...)
1.3 kristaps 440: __attribute__((format(printf, 2, 3)))
441: __attribute__((noreturn));
1.1 kristaps 442: void texiexit(struct texi *p);
443: void texifilepop(struct texi *);
444: void teximacro(struct texi *, const char *);
445: void teximacroclose(struct texi *);
446: void teximacroopen(struct texi *, const char *);
1.21 ! kristaps 447: void teximdocopen(struct texi *);
! 448: void teximdocclose(struct texi *, int);
1.15 kristaps 449: void texipunctuate(struct texi *, size_t *);
450: void texiputbuf(struct texi *p, size_t, size_t);
1.1 kristaps 451: void texiputchar(struct texi *p, char);
452: void texiputchars(struct texi *, const char *);
453: void texivspace(struct texi *);
454: void texiwarn(const struct texi *, const char *, ...)
455: __attribute__((format(printf, 2, 3)));
1.15 kristaps 456: void texisplice(struct texi *, const char *, size_t, size_t *);
1.2 kristaps 457:
458: void valueadd(struct texi *, char *, char *);
459: const char *
1.15 kristaps 460: valueblookup(struct texi *, size_t *);
461: void valuelclear(struct texi *, size_t *);
1.2 kristaps 462: const char *
1.15 kristaps 463: valuellookup(struct texi *, size_t *);
1.1 kristaps 464:
465: extern const struct texitok *const texitoks;
466:
467: __END_DECLS
468:
469: #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