Return to man.h CVS log

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

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

1.44    ! schwarze    1: /*     $Id: man.h,v 1.43 2014/03/30 19:47:32 schwarze Exp $ */
1.1       kristaps    2: /*
1.33      schwarze    3:  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.42      schwarze    4:  * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.2       schwarze    7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    9:  *
1.2       schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   17:  */
                     18: #ifndef MAN_H
                     19: #define MAN_H
                     20:
1.14      schwarze   21: enum   mant {
                     22:        MAN_br = 0,
                     23:        MAN_TH,
                     24:        MAN_SH,
                     25:        MAN_SS,
                     26:        MAN_TP,
                     27:        MAN_LP,
                     28:        MAN_PP,
                     29:        MAN_P,
                     30:        MAN_IP,
                     31:        MAN_HP,
                     32:        MAN_SM,
                     33:        MAN_SB,
                     34:        MAN_BI,
                     35:        MAN_IB,
                     36:        MAN_BR,
                     37:        MAN_RB,
                     38:        MAN_R,
                     39:        MAN_B,
                     40:        MAN_I,
                     41:        MAN_IR,
                     42:        MAN_RI,
                     43:        MAN_na,
                     44:        MAN_sp,
                     45:        MAN_nf,
                     46:        MAN_fi,
                     47:        MAN_RE,
                     48:        MAN_RS,
                     49:        MAN_DT,
                     50:        MAN_UC,
                     51:        MAN_PD,
1.21      schwarze   52:        MAN_AT,
1.25      schwarze   53:        MAN_in,
1.29      schwarze   54:        MAN_ft,
1.39      schwarze   55:        MAN_OP,
1.40      schwarze   56:        MAN_EX,
                     57:        MAN_EE,
1.41      schwarze   58:        MAN_UR,
                     59:        MAN_UE,
1.43      schwarze   60:        MAN_ll,
1.21      schwarze   61:        MAN_MAX
1.14      schwarze   62: };
1.1       kristaps   63:
                     64: enum   man_type {
                     65:        MAN_TEXT,
                     66:        MAN_ELEM,
1.7       schwarze   67:        MAN_ROOT,
                     68:        MAN_BLOCK,
                     69:        MAN_HEAD,
1.33      schwarze   70:        MAN_BODY,
1.37      schwarze   71:        MAN_TAIL,
1.36      schwarze   72:        MAN_TBL,
                     73:        MAN_EQN
1.1       kristaps   74: };
                     75:
                     76: struct man_meta {
1.28      schwarze   77:        char            *msec; /* `TH' section (1, 3p, etc.) */
1.35      schwarze   78:        char            *date; /* `TH' normalised date */
1.28      schwarze   79:        char            *vol; /* `TH' volume */
                     80:        char            *title; /* `TH' title (e.g., FOO) */
                     81:        char            *source; /* `TH' source (e.g., GNU) */
1.44    ! schwarze   82:        int              hasbody; /* document is not empty */
1.1       kristaps   83: };
                     84:
                     85: struct man_node {
1.28      schwarze   86:        struct man_node *parent; /* parent AST node */
                     87:        struct man_node *child; /* first child AST node */
                     88:        struct man_node *next; /* sibling AST node */
                     89:        struct man_node *prev; /* prior sibling AST node */
                     90:        int              nchild; /* number children */
1.1       kristaps   91:        int              line;
                     92:        int              pos;
1.28      schwarze   93:        enum mant        tok; /* tok or MAN__MAX if none */
1.1       kristaps   94:        int              flags;
1.28      schwarze   95: #define        MAN_VALID       (1 << 0) /* has been validated */
                     96: #define        MAN_EOS         (1 << 2) /* at sentence boundary */
1.34      schwarze   97: #define        MAN_LINE        (1 << 3) /* first macro/text on line */
1.28      schwarze   98:        enum man_type    type; /* AST node type */
                     99:        char            *string; /* TEXT node argument */
                    100:        struct man_node *head; /* BLOCK node HEAD ptr */
1.37      schwarze  101:        struct man_node *tail; /* BLOCK node TAIL ptr */
1.28      schwarze  102:        struct man_node *body; /* BLOCK node BODY ptr */
1.33      schwarze  103:        const struct tbl_span *span; /* TBL */
1.36      schwarze  104:        const struct eqn *eqn; /* EQN */
1.1       kristaps  105: };
                    106:
1.37      schwarze  107: /* Names of macros.  Index is enum mant. */
1.1       kristaps  108: extern const char *const *man_macronames;
                    109:
                    110: __BEGIN_DECLS
                    111:
                    112: struct man;
                    113:
                    114: const struct man_node *man_node(const struct man *);
                    115: const struct man_meta *man_meta(const struct man *);
1.38      schwarze  116: const struct mparse   *man_mparse(const struct man *);
1.42      schwarze  117: void man_deroff(char **, const struct man_node *);
1.1       kristaps  118:
                    119: __END_DECLS
                    120:
                    121: #endif /*!MAN_H*/