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