Return to man.h CVS log

Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/man.h, Revision 1.28

1.28    ! schwarze    1: /*     $Id: man.h,v 1.45 2010/10/04 07:01:02 kristaps Exp $ */
1.1       kristaps    2: /*
1.25      schwarze    3:  * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.2       schwarze    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.2       schwarze    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 MAN_H
                     18: #define MAN_H
                     19:
1.28    ! schwarze   20: /*
        !            21:  * What follows is a list of ALL possible macros.
        !            22:  */
1.14      schwarze   23: enum   mant {
                     24:        MAN_br = 0,
                     25:        MAN_TH,
                     26:        MAN_SH,
                     27:        MAN_SS,
                     28:        MAN_TP,
                     29:        MAN_LP,
                     30:        MAN_PP,
                     31:        MAN_P,
                     32:        MAN_IP,
                     33:        MAN_HP,
                     34:        MAN_SM,
                     35:        MAN_SB,
                     36:        MAN_BI,
                     37:        MAN_IB,
                     38:        MAN_BR,
                     39:        MAN_RB,
                     40:        MAN_R,
                     41:        MAN_B,
                     42:        MAN_I,
                     43:        MAN_IR,
                     44:        MAN_RI,
                     45:        MAN_na,
                     46:        MAN_i,
                     47:        MAN_sp,
                     48:        MAN_nf,
                     49:        MAN_fi,
                     50:        MAN_r,
                     51:        MAN_RE,
                     52:        MAN_RS,
                     53:        MAN_DT,
                     54:        MAN_UC,
                     55:        MAN_PD,
                     56:        MAN_Sp,
                     57:        MAN_Vb,
                     58:        MAN_Ve,
1.21      schwarze   59:        MAN_AT,
1.25      schwarze   60:        MAN_in,
1.27      schwarze   61:        MAN_TS,
                     62:        MAN_TE,
1.21      schwarze   63:        MAN_MAX
1.14      schwarze   64: };
1.1       kristaps   65:
1.28    ! schwarze   66: /*
        !            67:  * Type of a syntax node.
        !            68:  */
1.1       kristaps   69: enum   man_type {
                     70:        MAN_TEXT,
                     71:        MAN_ELEM,
1.7       schwarze   72:        MAN_ROOT,
                     73:        MAN_BLOCK,
                     74:        MAN_HEAD,
                     75:        MAN_BODY
1.1       kristaps   76: };
                     77:
1.28    ! schwarze   78: /*
        !            79:  * Information from prologue.
        !            80:  */
1.1       kristaps   81: struct man_meta {
1.28    ! schwarze   82:        char            *msec; /* `TH' section (1, 3p, etc.) */
        !            83:        time_t           date; /* `TH' normalised date */
        !            84:        char            *rawdate; /* raw `TH' date */
        !            85:        char            *vol; /* `TH' volume */
        !            86:        char            *title; /* `TH' title (e.g., FOO) */
        !            87:        char            *source; /* `TH' source (e.g., GNU) */
1.1       kristaps   88: };
                     89:
1.28    ! schwarze   90: union man_data {
        !            91:        struct tbl      *TS;
        !            92: };
        !            93:
        !            94: /*
        !            95:  * Single node in tree-linked AST.
        !            96:  */
1.1       kristaps   97: struct man_node {
1.28    ! schwarze   98:        struct man_node *parent; /* parent AST node */
        !            99:        struct man_node *child; /* first child AST node */
        !           100:        struct man_node *next; /* sibling AST node */
        !           101:        struct man_node *prev; /* prior sibling AST node */
        !           102:        int              nchild; /* number children */
1.1       kristaps  103:        int              line;
                    104:        int              pos;
1.28    ! schwarze  105:        enum mant        tok; /* tok or MAN__MAX if none */
1.1       kristaps  106:        int              flags;
1.28    ! schwarze  107: #define        MAN_VALID       (1 << 0) /* has been validated */
        !           108: #define        MAN_ACTED       (1 << 1) /* has been acted upon */
        !           109: #define        MAN_EOS         (1 << 2) /* at sentence boundary */
        !           110:        enum man_type    type; /* AST node type */
        !           111:        char            *string; /* TEXT node argument */
        !           112:        struct man_node *head; /* BLOCK node HEAD ptr */
        !           113:        struct man_node *body; /* BLOCK node BODY ptr */
        !           114:        union man_data   data;
1.1       kristaps  115: };
                    116:
1.28    ! schwarze  117: /*
        !           118:  * Names of macros.  Index is enum mant.  Indexing into this returns
        !           119:  * the normalised name, e.g., man_macronames[MAN_SH] -> "SH".
        !           120:  */
1.1       kristaps  121: extern const char *const *man_macronames;
                    122:
                    123: __BEGIN_DECLS
                    124:
                    125: struct man;
                    126:
                    127: void             man_free(struct man *);
1.26      schwarze  128: struct man      *man_alloc(struct regset *, void *, mandocmsg);
1.12      schwarze  129: void             man_reset(struct man *);
1.20      schwarze  130: int              man_parseln(struct man *, int, char *, int);
1.1       kristaps  131: int              man_endparse(struct man *);
                    132:
                    133: const struct man_node *man_node(const struct man *);
                    134: const struct man_meta *man_meta(const struct man *);
                    135:
                    136: __END_DECLS
                    137:
                    138: #endif /*!MAN_H*/