Return to man.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man.h, Revision 1.19

1.19    ! kristaps    1: /*     $Id: man.h,v 1.18 2009/08/19 09:14:50 kristaps Exp $ */
1.1       kristaps    2: /*
1.12      kristaps    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.11      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.11      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 MAN_H
                     18: #define MAN_H
                     19:
                     20: #include <time.h>
                     21:
1.13      kristaps   22: #define        MAN_br           0
1.1       kristaps   23: #define        MAN_TH           1
                     24: #define        MAN_SH           2
                     25: #define        MAN_SS           3
                     26: #define        MAN_TP           4
                     27: #define        MAN_LP           5
                     28: #define        MAN_PP           6
                     29: #define        MAN_P            7
                     30: #define        MAN_IP           8
                     31: #define        MAN_HP           9
                     32: #define        MAN_SM           10
                     33: #define        MAN_SB           11
                     34: #define        MAN_BI           12
                     35: #define        MAN_IB           13
                     36: #define        MAN_BR           14
                     37: #define        MAN_RB           15
                     38: #define        MAN_R            16
                     39: #define        MAN_B            17
                     40: #define        MAN_I            18
1.2       kristaps   41: #define        MAN_IR           19
1.6       kristaps   42: #define        MAN_RI           20
1.13      kristaps   43: #define        MAN_na           21
                     44: #define        MAN_i            22
1.16      kristaps   45: #define        MAN_sp           23
1.17      kristaps   46: #define        MAN_nf           24
                     47: #define        MAN_fi           25
                     48: #define        MAN_r            26
1.18      kristaps   49: #define        MAN_RE           27
                     50: #define        MAN_RS           28
1.19    ! kristaps   51: #define        MAN_DT           29
        !            52: #define        MAN_MAX          30
1.1       kristaps   53:
                     54: enum   man_type {
                     55:        MAN_TEXT,
                     56:        MAN_ELEM,
1.17      kristaps   57:        MAN_ROOT,
                     58:        MAN_BLOCK,
                     59:        MAN_HEAD,
                     60:        MAN_BODY
1.1       kristaps   61: };
                     62:
                     63: struct man_meta {
                     64:        int              msec;
1.4       kristaps   65:        time_t           date;
1.1       kristaps   66:        char            *vol;
                     67:        char            *title;
1.4       kristaps   68:        char            *source;
1.1       kristaps   69: };
                     70:
                     71: struct man_node {
                     72:        struct man_node *parent;
                     73:        struct man_node *child;
                     74:        struct man_node *next;
                     75:        struct man_node *prev;
1.14      kristaps   76:        int              nchild;
1.1       kristaps   77:        int              line;
                     78:        int              pos;
                     79:        int              tok;
                     80:        int              flags;
                     81: #define        MAN_VALID       (1 << 0)
                     82: #define        MAN_ACTED       (1 << 1)
                     83:        enum man_type    type;
                     84:        char            *string;
1.17      kristaps   85:        struct man_node *head;
                     86:        struct man_node *body;
1.1       kristaps   87: };
                     88:
1.14      kristaps   89: #define        MAN_IGN_MACRO    (1 << 0)
                     90: #define        MAN_IGN_CHARS    (1 << 1)
1.15      kristaps   91: #define        MAN_IGN_ESCAPE   (1 << 2)
1.5       kristaps   92:
1.1       kristaps   93: extern const char *const *man_macronames;
                     94:
1.3       kristaps   95: struct man_cb {
                     96:        int     (*man_warn)(void *, int, int, const char *);
                     97:        int     (*man_err)(void *, int, int, const char *);
                     98: };
                     99:
1.1       kristaps  100: __BEGIN_DECLS
                    101:
                    102: struct man;
                    103:
                    104: void             man_free(struct man *);
1.5       kristaps  105: struct man      *man_alloc(void *, int, const struct man_cb *);
1.9       kristaps  106: int              man_reset(struct man *);
1.1       kristaps  107: int              man_parseln(struct man *, int, char *buf);
                    108: int              man_endparse(struct man *);
1.3       kristaps  109: int              man_valid_post(struct man *);
1.1       kristaps  110:
                    111: const struct man_node *man_node(const struct man *);
                    112: const struct man_meta *man_meta(const struct man *);
                    113:
                    114: __END_DECLS
                    115:
                    116: #endif /*!MAN_H*/