Return to man.h CVS log

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

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

1.19    ! schwarze    1: /*     $Id: man.h,v 1.18 2010/05/15 18:06:02 schwarze Exp $ */
1.1       kristaps    2: /*
1.2       schwarze    3:  * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
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.15      schwarze   58:        MAN_if,
                     59:        MAN_ie,
                     60:        MAN_el,
1.14      schwarze   61:        MAN_MAX,
                     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,
                     70:        MAN_BODY
1.1       kristaps   71: };
                     72:
                     73: struct man_meta {
1.18      schwarze   74:        char            *msec;
1.1       kristaps   75:        time_t           date;
                     76:        char            *vol;
                     77:        char            *title;
                     78:        char            *source;
                     79: };
                     80:
                     81: struct man_node {
                     82:        struct man_node *parent;
                     83:        struct man_node *child;
                     84:        struct man_node *next;
                     85:        struct man_node *prev;
1.4       schwarze   86:        int              nchild;
1.1       kristaps   87:        int              line;
                     88:        int              pos;
1.14      schwarze   89:        enum mant        tok;
1.1       kristaps   90:        int              flags;
                     91: #define        MAN_VALID       (1 << 0)
                     92: #define        MAN_ACTED       (1 << 1)
1.17      schwarze   93: #define        MAN_EOS         (1 << 2)
                     94: #define        MAN_USE         (1 << 3)
1.1       kristaps   95:        enum man_type    type;
                     96:        char            *string;
1.7       schwarze   97:        struct man_node *head;
                     98:        struct man_node *body;
1.1       kristaps   99: };
                    100:
1.4       schwarze  101: #define        MAN_IGN_MACRO    (1 << 0)
1.5       schwarze  102: #define        MAN_IGN_ESCAPE   (1 << 2)
1.1       kristaps  103:
                    104: extern const char *const *man_macronames;
                    105:
                    106: struct man_cb {
                    107:        int     (*man_warn)(void *, int, int, const char *);
                    108:        int     (*man_err)(void *, int, int, const char *);
                    109: };
                    110:
                    111: __BEGIN_DECLS
                    112:
                    113: struct man;
                    114:
                    115: void             man_free(struct man *);
                    116: struct man      *man_alloc(void *, int, const struct man_cb *);
1.12      schwarze  117: void             man_reset(struct man *);
1.1       kristaps  118: int              man_parseln(struct man *, int, char *buf);
                    119: int              man_endparse(struct man *);
                    120:
                    121: const struct man_node *man_node(const struct man *);
                    122: const struct man_meta *man_meta(const struct man *);
                    123:
                    124: __END_DECLS
                    125:
                    126: #endif /*!MAN_H*/