Return to man.h CVS log

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

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

1.27    ! schwarze    1: /*     $Id: man.h,v 1.26 2010/08/20 00:53:35 schwarze 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:
                     20: #include <time.h>
                     21:
1.14      schwarze   22: enum   mant {
                     23:        MAN_br = 0,
                     24:        MAN_TH,
                     25:        MAN_SH,
                     26:        MAN_SS,
                     27:        MAN_TP,
                     28:        MAN_LP,
                     29:        MAN_PP,
                     30:        MAN_P,
                     31:        MAN_IP,
                     32:        MAN_HP,
                     33:        MAN_SM,
                     34:        MAN_SB,
                     35:        MAN_BI,
                     36:        MAN_IB,
                     37:        MAN_BR,
                     38:        MAN_RB,
                     39:        MAN_R,
                     40:        MAN_B,
                     41:        MAN_I,
                     42:        MAN_IR,
                     43:        MAN_RI,
                     44:        MAN_na,
                     45:        MAN_i,
                     46:        MAN_sp,
                     47:        MAN_nf,
                     48:        MAN_fi,
                     49:        MAN_r,
                     50:        MAN_RE,
                     51:        MAN_RS,
                     52:        MAN_DT,
                     53:        MAN_UC,
                     54:        MAN_PD,
                     55:        MAN_Sp,
                     56:        MAN_Vb,
                     57:        MAN_Ve,
1.21      schwarze   58:        MAN_AT,
1.25      schwarze   59:        MAN_in,
1.27    ! schwarze   60:        MAN_TS,
        !            61:        MAN_TE,
1.21      schwarze   62:        MAN_MAX
1.14      schwarze   63: };
1.1       kristaps   64:
                     65: enum   man_type {
                     66:        MAN_TEXT,
                     67:        MAN_ELEM,
1.7       schwarze   68:        MAN_ROOT,
                     69:        MAN_BLOCK,
                     70:        MAN_HEAD,
                     71:        MAN_BODY
1.1       kristaps   72: };
                     73:
                     74: struct man_meta {
1.18      schwarze   75:        char            *msec;
1.1       kristaps   76:        time_t           date;
1.23      schwarze   77:        char            *rawdate;
1.1       kristaps   78:        char            *vol;
                     79:        char            *title;
                     80:        char            *source;
                     81: };
                     82:
                     83: struct man_node {
                     84:        struct man_node *parent;
                     85:        struct man_node *child;
                     86:        struct man_node *next;
                     87:        struct man_node *prev;
1.4       schwarze   88:        int              nchild;
1.1       kristaps   89:        int              line;
                     90:        int              pos;
1.14      schwarze   91:        enum mant        tok;
1.1       kristaps   92:        int              flags;
                     93: #define        MAN_VALID       (1 << 0)
                     94: #define        MAN_ACTED       (1 << 1)
1.17      schwarze   95: #define        MAN_EOS         (1 << 2)
1.1       kristaps   96:        enum man_type    type;
                     97:        char            *string;
1.7       schwarze   98:        struct man_node *head;
                     99:        struct man_node *body;
1.27    ! schwarze  100:        union {
        !           101:                struct tbl *TS;
        !           102:        } data;
1.1       kristaps  103: };
                    104:
                    105: extern const char *const *man_macronames;
                    106:
                    107: __BEGIN_DECLS
                    108:
                    109: struct man;
                    110:
                    111: void             man_free(struct man *);
1.26      schwarze  112: struct man      *man_alloc(struct regset *, void *, mandocmsg);
1.12      schwarze  113: void             man_reset(struct man *);
1.20      schwarze  114: int              man_parseln(struct man *, int, char *, int);
1.1       kristaps  115: int              man_endparse(struct man *);
                    116:
                    117: const struct man_node *man_node(const struct man *);
                    118: const struct man_meta *man_meta(const struct man *);
                    119:
                    120: __END_DECLS
                    121:
                    122: #endif /*!MAN_H*/