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

Annotation of mandoc/mdoc.h, Revision 1.60

1.60    ! kristaps    1: /*     $Id: mdoc.h,v 1.59 2009/06/16 19:45:51 kristaps Exp $ */
1.1       kristaps    2: /*
1.57      kristaps    3:  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.56      kristaps    6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    8:  *
1.56      kristaps    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.
1.1       kristaps   16:  */
                     17: #ifndef MDOC_H
                     18: #define MDOC_H
                     19:
1.44      kristaps   20: #include <time.h>
                     21:
1.33      kristaps   22: /*
                     23:  * This library implements a validating scanner/parser for ``mdoc'' roff
                     24:  * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file
                     25:  * drives the parser, while macro.c describes the macro ontologies.
                     26:  * validate.c pre- and post-validates parsed macros, and action.c
                     27:  * performs actions on parsed and validated macros.
                     28:  */
                     29:
1.22      kristaps   30: /* What follows is a list of ALL possible macros. */
                     31:
1.59      kristaps   32: #define        MDOC_Ap          0
1.1       kristaps   33: #define        MDOC_Dd          1
                     34: #define        MDOC_Dt          2
                     35: #define        MDOC_Os          3
                     36: #define        MDOC_Sh          4
                     37: #define        MDOC_Ss          5
                     38: #define        MDOC_Pp          6
                     39: #define        MDOC_D1          7
                     40: #define        MDOC_Dl          8
                     41: #define        MDOC_Bd          9
                     42: #define        MDOC_Ed          10
                     43: #define        MDOC_Bl          11
                     44: #define        MDOC_El          12
                     45: #define        MDOC_It          13
                     46: #define        MDOC_Ad          14
                     47: #define        MDOC_An          15
                     48: #define        MDOC_Ar          16
                     49: #define        MDOC_Cd          17
                     50: #define        MDOC_Cm          18
                     51: #define        MDOC_Dv          19
                     52: #define        MDOC_Er          20
                     53: #define        MDOC_Ev          21
                     54: #define        MDOC_Ex          22
                     55: #define        MDOC_Fa          23
                     56: #define        MDOC_Fd          24
                     57: #define        MDOC_Fl          25
                     58: #define        MDOC_Fn          26
                     59: #define        MDOC_Ft          27
                     60: #define        MDOC_Ic          28
                     61: #define        MDOC_In          29
                     62: #define        MDOC_Li          30
                     63: #define        MDOC_Nd          31
                     64: #define        MDOC_Nm          32
                     65: #define        MDOC_Op          33
                     66: #define        MDOC_Ot          34
                     67: #define        MDOC_Pa          35
                     68: #define        MDOC_Rv          36
                     69: #define        MDOC_St          37
                     70: #define        MDOC_Va          38
                     71: #define        MDOC_Vt          39
                     72: #define        MDOC_Xr          40
                     73: #define        MDOC__A          41
                     74: #define        MDOC__B          42
                     75: #define        MDOC__D          43
                     76: #define        MDOC__I          44
                     77: #define        MDOC__J          45
                     78: #define        MDOC__N          46
                     79: #define        MDOC__O          47
                     80: #define        MDOC__P          48
                     81: #define        MDOC__R          49
                     82: #define        MDOC__T          50
                     83: #define        MDOC__V          51
                     84: #define MDOC_Ac                 52
                     85: #define MDOC_Ao                 53
                     86: #define MDOC_Aq                 54
                     87: #define MDOC_At                 55
                     88: #define MDOC_Bc                 56
                     89: #define MDOC_Bf                 57
                     90: #define MDOC_Bo                 58
                     91: #define MDOC_Bq                 59
                     92: #define MDOC_Bsx        60
                     93: #define MDOC_Bx                 61
                     94: #define MDOC_Db                 62
                     95: #define MDOC_Dc                 63
                     96: #define MDOC_Do                 64
                     97: #define MDOC_Dq                 65
                     98: #define MDOC_Ec                 66
                     99: #define MDOC_Ef                 67
                    100: #define MDOC_Em                 68
                    101: #define MDOC_Eo                 69
                    102: #define MDOC_Fx                 70
                    103: #define MDOC_Ms                 71
                    104: #define MDOC_No                 72
                    105: #define MDOC_Ns                 73
                    106: #define MDOC_Nx                 74
                    107: #define MDOC_Ox                 75
                    108: #define MDOC_Pc                 76
                    109: #define MDOC_Pf                 77
                    110: #define MDOC_Po                 78
                    111: #define MDOC_Pq                 79
                    112: #define MDOC_Qc                 80
                    113: #define MDOC_Ql                 81
                    114: #define MDOC_Qo                 82
                    115: #define MDOC_Qq                 83
                    116: #define MDOC_Re                 84
                    117: #define MDOC_Rs                 85
                    118: #define MDOC_Sc                 86
                    119: #define MDOC_So                 87
                    120: #define MDOC_Sq                 88
                    121: #define MDOC_Sm                 89
                    122: #define MDOC_Sx                 90
                    123: #define MDOC_Sy                 91
                    124: #define MDOC_Tn                 92
                    125: #define MDOC_Ux                 93
                    126: #define MDOC_Xc                 94
                    127: #define MDOC_Xo                 95
                    128: #define        MDOC_Fo          96
                    129: #define        MDOC_Fc          97
                    130: #define        MDOC_Oo          98
                    131: #define        MDOC_Oc          99
                    132: #define        MDOC_Bk          100
                    133: #define        MDOC_Ek          101
                    134: #define        MDOC_Bt          102
                    135: #define        MDOC_Hf          103
                    136: #define        MDOC_Fr          104
                    137: #define        MDOC_Ud          105
1.37      kristaps  138: #define        MDOC_Lb          106
1.59      kristaps  139: #define        MDOC_Lp          107
                    140: #define        MDOC_Lk          108
                    141: #define        MDOC_Mt          109
                    142: #define        MDOC_Brq         110
                    143: #define        MDOC_Bro         111
                    144: #define        MDOC_Brc         112
                    145: #define        MDOC__C          113
                    146: #define        MDOC_Es          114
                    147: #define        MDOC_En          115
                    148: #define        MDOC_Dx          116
                    149: #define        MDOC__Q          117
                    150: #define        MDOC_MAX         118
1.1       kristaps  151:
1.22      kristaps  152: /* What follows is a list of ALL possible macro arguments. */
                    153:
1.1       kristaps  154: #define        MDOC_Split       0
                    155: #define        MDOC_Nosplit     1
                    156: #define        MDOC_Ragged      2
                    157: #define        MDOC_Unfilled    3
                    158: #define        MDOC_Literal     4
                    159: #define        MDOC_File        5
                    160: #define        MDOC_Offset      6
                    161: #define        MDOC_Bullet      7
                    162: #define        MDOC_Dash        8
                    163: #define        MDOC_Hyphen      9
                    164: #define        MDOC_Item        10
                    165: #define        MDOC_Enum        11
                    166: #define        MDOC_Tag         12
                    167: #define        MDOC_Diag        13
                    168: #define        MDOC_Hang        14
                    169: #define        MDOC_Ohang       15
                    170: #define        MDOC_Inset       16
                    171: #define        MDOC_Column      17
                    172: #define        MDOC_Width       18
                    173: #define        MDOC_Compact     19
                    174: #define        MDOC_Std         20
1.37      kristaps  175: #define        MDOC_Filled      21
                    176: #define        MDOC_Words       22
                    177: #define        MDOC_Emphasis    23
                    178: #define        MDOC_Symbolic    24
1.47      kristaps  179: #define        MDOC_Nested      25
                    180: #define        MDOC_ARG_MAX     26
1.1       kristaps  181:
1.29      kristaps  182: /* Warnings are either syntax or groff-compatibility. */
1.22      kristaps  183: enum   mdoc_warn {
1.29      kristaps  184:        WARN_SYNTAX,
                    185:        WARN_COMPAT
1.1       kristaps  186: };
                    187:
1.23      kristaps  188: /* Type of a syntax node. */
1.1       kristaps  189: enum   mdoc_type {
                    190:        MDOC_TEXT,
                    191:        MDOC_ELEM,
                    192:        MDOC_HEAD,
1.14      kristaps  193:        MDOC_TAIL,
1.1       kristaps  194:        MDOC_BODY,
1.18      kristaps  195:        MDOC_BLOCK,
                    196:        MDOC_ROOT
1.1       kristaps  197: };
                    198:
1.37      kristaps  199: /* Section (named/unnamed) of `Sh'. */
1.2       kristaps  200: enum   mdoc_sec {
1.60    ! kristaps  201:        SEC_NONE,               /* No section, yet. */
        !           202:        SEC_NAME,
        !           203:        SEC_LIBRARY,
        !           204:        SEC_SYNOPSIS,
        !           205:        SEC_DESCRIPTION,
        !           206:        SEC_IMPLEMENTATION,
        !           207:        SEC_RETURN_VALUES,
        !           208:        SEC_ENVIRONMENT,
        !           209:        SEC_FILES,
        !           210:        SEC_EXAMPLES,
        !           211:        SEC_DIAGNOSTICS,
        !           212:        SEC_COMPATIBILITY,
        !           213:        SEC_ERRORS,
        !           214:        SEC_SEE_ALSO,
        !           215:        SEC_STANDARDS,
        !           216:        SEC_HISTORY,
        !           217:        SEC_AUTHORS,
        !           218:        SEC_CAVEATS,
        !           219:        SEC_BUGS,
        !           220:        SEC_CUSTOM              /* User-defined. */
1.2       kristaps  221: };
                    222:
1.29      kristaps  223: /* Information from prologue. */
1.2       kristaps  224: struct mdoc_meta {
1.37      kristaps  225:        int               msec;
                    226:        char             *vol;
                    227:        char             *arch;
1.3       kristaps  228:        time_t            date;
1.25      kristaps  229:        char             *title;
                    230:        char             *os;
                    231:        char             *name;
1.2       kristaps  232: };
                    233:
1.38      kristaps  234: /* An argument to a macro (multiple values = `It -column'). */
                    235: struct mdoc_argv {
                    236:        int               arg;
                    237:        int               line;
                    238:        int               pos;
                    239:        size_t            sz;
                    240:        char            **value;
1.1       kristaps  241: };
                    242:
1.38      kristaps  243: struct         mdoc_arg {
1.1       kristaps  244:        size_t            argc;
1.38      kristaps  245:        struct mdoc_argv *argv;
                    246:        unsigned int      refcnt;
1.1       kristaps  247: };
                    248:
1.29      kristaps  249: /* Node in AST. */
1.1       kristaps  250: struct mdoc_node {
                    251:        struct mdoc_node *parent;
                    252:        struct mdoc_node *child;
                    253:        struct mdoc_node *next;
1.5       kristaps  254:        struct mdoc_node *prev;
1.16      kristaps  255:        int               line;
                    256:        int               pos;
1.20      kristaps  257:        int               tok;
1.26      kristaps  258:        int               flags;
                    259: #define        MDOC_VALID       (1 << 0)
                    260: #define        MDOC_ACTED       (1 << 1)
1.1       kristaps  261:        enum mdoc_type    type;
1.31      kristaps  262:        enum mdoc_sec     sec;
1.40      kristaps  263:
                    264:        /* FIXME: union/struct this with #defines. */
1.38      kristaps  265:        struct mdoc_arg  *args;         /* BLOCK/ELEM */
                    266:        struct mdoc_node *head;         /* BLOCK */
                    267:        struct mdoc_node *body;         /* BLOCK */
                    268:        struct mdoc_node *tail;         /* BLOCK */
                    269:        char             *string;       /* TEXT */
1.1       kristaps  270: };
                    271:
1.40      kristaps  272: #define        MDOC_IGN_SCOPE   (1 << 0) /* Ignore scope violations. */
                    273: #define        MDOC_IGN_ESCAPE  (1 << 1) /* Ignore bad escape sequences. */
1.43      kristaps  274: #define        MDOC_IGN_MACRO   (1 << 2) /* Ignore unknown macros. */
1.55      kristaps  275: #define        MDOC_IGN_CHARS   (1 << 3) /* Ignore disallowed chars. */
1.38      kristaps  276:
1.23      kristaps  277: /* Call-backs for parse messages. */
1.60    ! kristaps  278: /* FIXME: unify somehow with man_cb. */
1.1       kristaps  279: struct mdoc_cb {
1.22      kristaps  280:        int     (*mdoc_err)(void *, int, int, const char *);
                    281:        int     (*mdoc_warn)(void *, int, int,
                    282:                        enum mdoc_warn, const char *);
1.1       kristaps  283: };
                    284:
1.60    ! kristaps  285: /* See mdoc.3 for documentation. */
        !           286:
1.1       kristaps  287: extern const char *const *mdoc_macronames;
                    288: extern const char *const *mdoc_argnames;
                    289:
                    290: __BEGIN_DECLS
                    291:
                    292: struct mdoc;
                    293:
1.60    ! kristaps  294: /* See mdoc.3 for documentation. */
        !           295:
1.1       kristaps  296: void             mdoc_free(struct mdoc *);
1.40      kristaps  297: struct mdoc     *mdoc_alloc(void *, int, const struct mdoc_cb *);
1.54      kristaps  298: int              mdoc_reset(struct mdoc *);
1.16      kristaps  299: int              mdoc_parseln(struct mdoc *, int, char *buf);
1.32      kristaps  300: const struct mdoc_node *mdoc_node(const struct mdoc *);
                    301: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
1.16      kristaps  302: int              mdoc_endparse(struct mdoc *);
1.1       kristaps  303:
1.37      kristaps  304: const char      *mdoc_a2att(const char *);
                    305: const char      *mdoc_a2lib(const char *);
                    306: const char      *mdoc_a2st(const char *);
                    307:
1.1       kristaps  308: __END_DECLS
                    309:
                    310: #endif /*!MDOC_H*/

CVSweb