[BACK]Return to mdoc.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdoc.h, Revision 1.31

1.31    ! kristaps    1: /* $Id: mdoc.h,v 1.30 2009/02/21 21:00:06 kristaps Exp $ */
1.1       kristaps    2: /*
                      3:  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
                      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
                      7:  * above copyright notice and this permission notice appear in all
                      8:  * copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
                     11:  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
                     12:  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
                     13:  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
                     14:  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
                     15:  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
                     16:  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
                     17:  * PERFORMANCE OF THIS SOFTWARE.
                     18:  */
                     19: #ifndef MDOC_H
                     20: #define MDOC_H
                     21:
1.22      kristaps   22: /* What follows is a list of ALL possible macros. */
                     23:
1.1       kristaps   24: #define        MDOC___          0
                     25: #define        MDOC_Dd          1
                     26: #define        MDOC_Dt          2
                     27: #define        MDOC_Os          3
                     28: #define        MDOC_Sh          4
                     29: #define        MDOC_Ss          5
                     30: #define        MDOC_Pp          6
                     31: #define        MDOC_D1          7
                     32: #define        MDOC_Dl          8
                     33: #define        MDOC_Bd          9
                     34: #define        MDOC_Ed          10
                     35: #define        MDOC_Bl          11
                     36: #define        MDOC_El          12
                     37: #define        MDOC_It          13
                     38: #define        MDOC_Ad          14
                     39: #define        MDOC_An          15
                     40: #define        MDOC_Ar          16
                     41: #define        MDOC_Cd          17
                     42: #define        MDOC_Cm          18
                     43: #define        MDOC_Dv          19
                     44: #define        MDOC_Er          20
                     45: #define        MDOC_Ev          21
                     46: #define        MDOC_Ex          22
                     47: #define        MDOC_Fa          23
                     48: #define        MDOC_Fd          24
                     49: #define        MDOC_Fl          25
                     50: #define        MDOC_Fn          26
                     51: #define        MDOC_Ft          27
                     52: #define        MDOC_Ic          28
                     53: #define        MDOC_In          29
                     54: #define        MDOC_Li          30
                     55: #define        MDOC_Nd          31
                     56: #define        MDOC_Nm          32
                     57: #define        MDOC_Op          33
                     58: #define        MDOC_Ot          34
                     59: #define        MDOC_Pa          35
                     60: #define        MDOC_Rv          36
                     61: #define        MDOC_St          37
                     62: #define        MDOC_Va          38
                     63: #define        MDOC_Vt          39
                     64: #define        MDOC_Xr          40
                     65: #define        MDOC__A          41
                     66: #define        MDOC__B          42
                     67: #define        MDOC__D          43
                     68: #define        MDOC__I          44
                     69: #define        MDOC__J          45
                     70: #define        MDOC__N          46
                     71: #define        MDOC__O          47
                     72: #define        MDOC__P          48
                     73: #define        MDOC__R          49
                     74: #define        MDOC__T          50
                     75: #define        MDOC__V          51
                     76: #define MDOC_Ac                 52
                     77: #define MDOC_Ao                 53
                     78: #define MDOC_Aq                 54
                     79: #define MDOC_At                 55
                     80: #define MDOC_Bc                 56
                     81: #define MDOC_Bf                 57
                     82: #define MDOC_Bo                 58
                     83: #define MDOC_Bq                 59
                     84: #define MDOC_Bsx        60
                     85: #define MDOC_Bx                 61
                     86: #define MDOC_Db                 62
                     87: #define MDOC_Dc                 63
                     88: #define MDOC_Do                 64
                     89: #define MDOC_Dq                 65
                     90: #define MDOC_Ec                 66
                     91: #define MDOC_Ef                 67
                     92: #define MDOC_Em                 68
                     93: #define MDOC_Eo                 69
                     94: #define MDOC_Fx                 70
                     95: #define MDOC_Ms                 71
                     96: #define MDOC_No                 72
                     97: #define MDOC_Ns                 73
                     98: #define MDOC_Nx                 74
                     99: #define MDOC_Ox                 75
                    100: #define MDOC_Pc                 76
                    101: #define MDOC_Pf                 77
                    102: #define MDOC_Po                 78
                    103: #define MDOC_Pq                 79
                    104: #define MDOC_Qc                 80
                    105: #define MDOC_Ql                 81
                    106: #define MDOC_Qo                 82
                    107: #define MDOC_Qq                 83
                    108: #define MDOC_Re                 84
                    109: #define MDOC_Rs                 85
                    110: #define MDOC_Sc                 86
                    111: #define MDOC_So                 87
                    112: #define MDOC_Sq                 88
                    113: #define MDOC_Sm                 89
                    114: #define MDOC_Sx                 90
                    115: #define MDOC_Sy                 91
                    116: #define MDOC_Tn                 92
                    117: #define MDOC_Ux                 93
                    118: #define MDOC_Xc                 94
                    119: #define MDOC_Xo                 95
                    120: #define        MDOC_Fo          96
                    121: #define        MDOC_Fc          97
                    122: #define        MDOC_Oo          98
                    123: #define        MDOC_Oc          99
                    124: #define        MDOC_Bk          100
                    125: #define        MDOC_Ek          101
                    126: #define        MDOC_Bt          102
                    127: #define        MDOC_Hf          103
                    128: #define        MDOC_Fr          104
                    129: #define        MDOC_Ud          105
                    130: #define        MDOC_MAX         106
                    131:
1.22      kristaps  132: /* What follows is a list of ALL possible macro arguments. */
                    133:
1.1       kristaps  134: #define        MDOC_Split       0
                    135: #define        MDOC_Nosplit     1
                    136: #define        MDOC_Ragged      2
                    137: #define        MDOC_Unfilled    3
                    138: #define        MDOC_Literal     4
                    139: #define        MDOC_File        5
                    140: #define        MDOC_Offset      6
                    141: #define        MDOC_Bullet      7
                    142: #define        MDOC_Dash        8
                    143: #define        MDOC_Hyphen      9
                    144: #define        MDOC_Item        10
                    145: #define        MDOC_Enum        11
                    146: #define        MDOC_Tag         12
                    147: #define        MDOC_Diag        13
                    148: #define        MDOC_Hang        14
                    149: #define        MDOC_Ohang       15
                    150: #define        MDOC_Inset       16
                    151: #define        MDOC_Column      17
                    152: #define        MDOC_Width       18
                    153: #define        MDOC_Compact     19
                    154: #define        MDOC_Std         20
                    155: #define MDOC_p1003_1_88         21
                    156: #define MDOC_p1003_1_90         22
                    157: #define MDOC_p1003_1_96         23
                    158: #define MDOC_p1003_1_2001 24
                    159: #define MDOC_p1003_1_2004 25
                    160: #define MDOC_p1003_1    26
                    161: #define MDOC_p1003_1b   27
                    162: #define MDOC_p1003_1b_93 28
                    163: #define MDOC_p1003_1c_95 29
                    164: #define MDOC_p1003_1g_2000 30
                    165: #define MDOC_p1003_2_92         31
                    166: #define MDOC_p1387_2_95         32
                    167: #define MDOC_p1003_2    33
                    168: #define MDOC_p1387_2    34
                    169: #define MDOC_isoC_90    35
                    170: #define MDOC_isoC_amd1  36
                    171: #define MDOC_isoC_tcor1         37
                    172: #define MDOC_isoC_tcor2         38
                    173: #define MDOC_isoC_99    39
                    174: #define MDOC_ansiC      40
                    175: #define MDOC_ansiC_89   41
                    176: #define MDOC_ansiC_99   42
                    177: #define MDOC_ieee754    43
                    178: #define MDOC_iso8802_3  44
                    179: #define MDOC_xpg3       45
                    180: #define MDOC_xpg4       46
                    181: #define MDOC_xpg4_2     47
                    182: #define MDOC_xpg4_3     48
                    183: #define MDOC_xbd5       49
                    184: #define MDOC_xcu5       50
                    185: #define MDOC_xsh5       51
                    186: #define MDOC_xns5       52
                    187: #define MDOC_xns5_2d2_0         53
                    188: #define MDOC_xcurses4_2         54
                    189: #define MDOC_susv2      55
                    190: #define MDOC_susv3      56
                    191: #define MDOC_svid4      57
                    192: #define        MDOC_Filled      58
                    193: #define        MDOC_Words       59
1.12      kristaps  194: #define        MDOC_Emphasis    60
                    195: #define        MDOC_Symbolic    61
                    196: #define        MDOC_ARG_MAX     62
1.1       kristaps  197:
1.29      kristaps  198: /* Warnings are either syntax or groff-compatibility. */
1.22      kristaps  199: enum   mdoc_warn {
1.29      kristaps  200:        WARN_SYNTAX,
                    201:        WARN_COMPAT
1.1       kristaps  202: };
                    203:
1.23      kristaps  204: /* Possible values for the `At' macro. */
1.8       kristaps  205: enum   mdoc_att {
                    206:        ATT_DEFAULT = 0,
                    207:        ATT_v1,
                    208:        ATT_v2,
                    209:        ATT_v3,
                    210:        ATT_v4,
                    211:        ATT_v5,
                    212:        ATT_v6,
                    213:        ATT_v7,
                    214:        ATT_32v,
                    215:        ATT_V1,
                    216:        ATT_V2,
                    217:        ATT_V3,
                    218:        ATT_V4
                    219: };
                    220:
1.23      kristaps  221: /* An argument to a macro (multiple values = `It -column'). */
1.1       kristaps  222: struct mdoc_arg {
                    223:        int               arg;
1.19      kristaps  224:        int               line;
                    225:        int               pos;
1.1       kristaps  226:        size_t            sz;
                    227:        char            **value;
                    228: };
                    229:
1.23      kristaps  230: /* Type of a syntax node. */
1.1       kristaps  231: enum   mdoc_type {
                    232:        MDOC_TEXT,
                    233:        MDOC_ELEM,
                    234:        MDOC_HEAD,
1.14      kristaps  235:        MDOC_TAIL,
1.1       kristaps  236:        MDOC_BODY,
1.18      kristaps  237:        MDOC_BLOCK,
                    238:        MDOC_ROOT
1.1       kristaps  239: };
                    240:
1.23      kristaps  241: /* Manual section. */
1.2       kristaps  242: enum   mdoc_msec {
1.3       kristaps  243:        MSEC_DEFAULT = 0,
1.2       kristaps  244:        MSEC_1,
                    245:        MSEC_2,
                    246:        MSEC_3,
                    247:        MSEC_3f,
                    248:        MSEC_3p,
                    249:        MSEC_4,
                    250:        MSEC_5,
                    251:        MSEC_6,
                    252:        MSEC_7,
                    253:        MSEC_8,
                    254:        MSEC_9,
                    255:        MSEC_X11,
                    256:        MSEC_X11R6,
                    257:        MSEC_local,
                    258:        MSEC_n,
                    259:        MSEC_unass,
                    260:        MSEC_draft,
1.3       kristaps  261:        MSEC_paper
1.2       kristaps  262: };
                    263:
1.23      kristaps  264: /* Section (named/unnamed) of `Ss'. */
1.2       kristaps  265: enum   mdoc_sec {
1.3       kristaps  266:        SEC_PROLOGUE = 0,
                    267:        SEC_BODY,
1.2       kristaps  268:        SEC_NAME,
                    269:        SEC_SYNOPSIS,
                    270:        SEC_DESCRIPTION,
                    271:        SEC_RETURN_VALUES,
                    272:        SEC_ENVIRONMENT,
                    273:        SEC_FILES,
                    274:        SEC_EXAMPLES,
                    275:        SEC_DIAGNOSTICS,
                    276:        SEC_ERRORS,
                    277:        SEC_SEE_ALSO,
                    278:        SEC_STANDARDS,
                    279:        SEC_HISTORY,
                    280:        SEC_AUTHORS,
                    281:        SEC_CAVEATS,
                    282:        SEC_BUGS,
                    283:        SEC_CUSTOM
                    284: };
                    285:
1.23      kristaps  286: /* Volume of `Dt'. */
1.2       kristaps  287: enum   mdoc_vol {
1.3       kristaps  288:        VOL_DEFAULT = 0,
1.2       kristaps  289:        VOL_AMD,
                    290:        VOL_IND,
                    291:        VOL_KM,
                    292:        VOL_LOCAL,
                    293:        VOL_PRM,
                    294:        VOL_PS1,
                    295:        VOL_SMM,
                    296:        VOL_URM,
1.3       kristaps  297:        VOL_USD
1.2       kristaps  298: };
                    299:
1.23      kristaps  300: /* Architecture of `Dt'. */
1.2       kristaps  301: enum   mdoc_arch {
1.3       kristaps  302:        ARCH_DEFAULT = 0,
1.2       kristaps  303:        ARCH_alpha,
                    304:        ARCH_amd64,
                    305:        ARCH_amiga,
                    306:        ARCH_arc,
1.23      kristaps  307:        ARCH_arm,
1.2       kristaps  308:        ARCH_armish,
                    309:        ARCH_aviion,
                    310:        ARCH_hp300,
                    311:        ARCH_hppa,
                    312:        ARCH_hppa64,
                    313:        ARCH_i386,
                    314:        ARCH_landisk,
                    315:        ARCH_luna88k,
                    316:        ARCH_mac68k,
                    317:        ARCH_macppc,
                    318:        ARCH_mvme68k,
                    319:        ARCH_mvme88k,
                    320:        ARCH_mvmeppc,
                    321:        ARCH_pmax,
                    322:        ARCH_sgi,
                    323:        ARCH_socppc,
                    324:        ARCH_sparc,
                    325:        ARCH_sparc64,
                    326:        ARCH_sun3,
                    327:        ARCH_vax,
1.3       kristaps  328:        ARCH_zaurus
1.2       kristaps  329: };
                    330:
1.29      kristaps  331: /* Information from prologue. */
1.2       kristaps  332: struct mdoc_meta {
                    333:        enum mdoc_msec    msec;
                    334:        enum mdoc_vol     vol;
                    335:        enum mdoc_arch    arch;
1.3       kristaps  336:        time_t            date;
1.25      kristaps  337:        char             *title;
                    338:        char             *os;
                    339:        char             *name;
1.2       kristaps  340: };
                    341:
1.29      kristaps  342: /* Text-only node. */
1.1       kristaps  343: struct mdoc_text {
                    344:        char             *string;
                    345: };
                    346:
1.29      kristaps  347: /* Block (scoped) node. */
1.1       kristaps  348: struct mdoc_block {
                    349:        size_t            argc;
                    350:        struct mdoc_arg  *argv;
1.20      kristaps  351:        struct mdoc_node *head;
                    352:        struct mdoc_node *body;
                    353:        struct mdoc_node *tail;
1.1       kristaps  354: };
                    355:
1.29      kristaps  356: /* In-line element node. */
1.1       kristaps  357: struct mdoc_elem {
                    358:        size_t            sz;
                    359:        char            **args;
                    360:        size_t            argc;
                    361:        struct mdoc_arg  *argv;
                    362: };
                    363:
1.29      kristaps  364: /* Typed nodes of an AST node. */
1.1       kristaps  365: union  mdoc_data {
                    366:        struct mdoc_text  text;
                    367:        struct mdoc_elem  elem;
                    368:        struct mdoc_block block;
                    369: };
                    370:
1.29      kristaps  371: /* Node in AST. */
1.1       kristaps  372: struct mdoc_node {
                    373:        struct mdoc_node *parent;
                    374:        struct mdoc_node *child;
                    375:        struct mdoc_node *next;
1.5       kristaps  376:        struct mdoc_node *prev;
1.16      kristaps  377:        int               line;
                    378:        int               pos;
1.20      kristaps  379:        int               tok;
1.26      kristaps  380:        int               flags;
                    381: #define        MDOC_VALID       (1 << 0)
                    382: #define        MDOC_ACTED       (1 << 1)
1.1       kristaps  383:        enum mdoc_type    type;
                    384:        union mdoc_data   data;
1.31    ! kristaps  385:        enum mdoc_sec     sec;
1.1       kristaps  386: };
                    387:
1.23      kristaps  388: /* Call-backs for parse messages. */
1.1       kristaps  389: struct mdoc_cb {
1.17      kristaps  390:        void    (*mdoc_msg)(void *, int, int, const char *);
1.22      kristaps  391:        int     (*mdoc_err)(void *, int, int, const char *);
                    392:        int     (*mdoc_warn)(void *, int, int,
                    393:                        enum mdoc_warn, const char *);
1.1       kristaps  394: };
                    395:
1.29      kristaps  396: /* Global table of macro names (`Bd', `Ed', etc.). */
1.1       kristaps  397: extern const char *const *mdoc_macronames;
1.29      kristaps  398:
                    399: /* Global table of argument names (`column', `tag', etc.). */
1.1       kristaps  400: extern const char *const *mdoc_argnames;
                    401:
                    402: __BEGIN_DECLS
                    403:
                    404: struct mdoc;
                    405:
1.23      kristaps  406: /* Free memory allocated with mdoc_alloc. */
1.1       kristaps  407: void             mdoc_free(struct mdoc *);
1.23      kristaps  408:
                    409: /* Allocate a new parser instance. */
1.1       kristaps  410: struct mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);
1.23      kristaps  411:
1.29      kristaps  412: /* Parse a single line in a stream (boolean retval). */
1.16      kristaps  413: int              mdoc_parseln(struct mdoc *, int, char *buf);
1.23      kristaps  414:
1.29      kristaps  415: /* Get result first node (after mdoc_endparse!). */
1.27      kristaps  416: const struct mdoc_node *mdoc_node(struct mdoc *);
                    417:
1.29      kristaps  418: /* Get result meta-information (after mdoc_endparse!). */
1.27      kristaps  419: const struct mdoc_meta *mdoc_meta(struct mdoc *);
1.23      kristaps  420:
                    421: /* Signal end of parse sequence (boolean retval). */
1.16      kristaps  422: int              mdoc_endparse(struct mdoc *);
1.1       kristaps  423:
1.30      kristaps  424: const char      *mdoc_arch2a(enum mdoc_arch);
                    425:
                    426: const char      *mdoc_vol2a(enum mdoc_vol);
                    427:
                    428: const char      *mdoc_msec2a(enum mdoc_msec);
                    429:
                    430: int              mdoc_isdelim(const char *);
                    431:
1.1       kristaps  432: __END_DECLS
                    433:
                    434: #endif /*!MDOC_H*/

CVSweb