Return to man.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man.h, Revision 1.24

1.24    ! kristaps    1: /*     $Id: man.h,v 1.23 2009/10/30 05:58:37 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
1.20      kristaps   52: #define        MAN_UC           30
1.22      kristaps   53: #define        MAN_PD           31
1.24    ! kristaps   54: #define        MAN_Sp           32
        !            55: #define        MAN_Vb           33
        !            56: #define        MAN_Ve           34
        !            57: #define        MAN_MAX          35
1.1       kristaps   58:
                     59: enum   man_type {
                     60:        MAN_TEXT,
                     61:        MAN_ELEM,
1.17      kristaps   62:        MAN_ROOT,
                     63:        MAN_BLOCK,
                     64:        MAN_HEAD,
                     65:        MAN_BODY
1.1       kristaps   66: };
                     67:
                     68: struct man_meta {
                     69:        int              msec;
1.4       kristaps   70:        time_t           date;
1.1       kristaps   71:        char            *vol;
                     72:        char            *title;
1.4       kristaps   73:        char            *source;
1.1       kristaps   74: };
                     75:
                     76: struct man_node {
                     77:        struct man_node *parent;
                     78:        struct man_node *child;
                     79:        struct man_node *next;
                     80:        struct man_node *prev;
1.14      kristaps   81:        int              nchild;
1.1       kristaps   82:        int              line;
                     83:        int              pos;
                     84:        int              tok;
                     85:        int              flags;
                     86: #define        MAN_VALID       (1 << 0)
                     87: #define        MAN_ACTED       (1 << 1)
                     88:        enum man_type    type;
                     89:        char            *string;
1.17      kristaps   90:        struct man_node *head;
                     91:        struct man_node *body;
1.1       kristaps   92: };
                     93:
1.14      kristaps   94: #define        MAN_IGN_MACRO    (1 << 0)
                     95: #define        MAN_IGN_CHARS    (1 << 1)
1.15      kristaps   96: #define        MAN_IGN_ESCAPE   (1 << 2)
1.5       kristaps   97:
1.1       kristaps   98: extern const char *const *man_macronames;
                     99:
1.3       kristaps  100: struct man_cb {
                    101:        int     (*man_warn)(void *, int, int, const char *);
                    102:        int     (*man_err)(void *, int, int, const char *);
                    103: };
                    104:
1.1       kristaps  105: __BEGIN_DECLS
                    106:
                    107: struct man;
                    108:
                    109: void             man_free(struct man *);
1.5       kristaps  110: struct man      *man_alloc(void *, int, const struct man_cb *);
1.23      kristaps  111: void             man_reset(struct man *);
1.1       kristaps  112: int              man_parseln(struct man *, int, char *buf);
                    113: int              man_endparse(struct man *);
                    114:
                    115: const struct man_node *man_node(const struct man *);
                    116: const struct man_meta *man_meta(const struct man *);
                    117:
                    118: __END_DECLS
                    119:
                    120: #endif /*!MAN_H*/