[BACK]Return to libman.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/libman.h, Revision 1.23

1.23    ! kristaps    1: /*     $Id: libman.h,v 1.22 2009/10/26 07:11:06 kristaps Exp $ */
1.1       kristaps    2: /*
1.9       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.8       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.8       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 LIBMAN_H
                     18: #define LIBMAN_H
                     19:
                     20: #include "man.h"
                     21:
                     22: enum   man_next {
                     23:        MAN_NEXT_SIBLING = 0,
                     24:        MAN_NEXT_CHILD
                     25: };
                     26:
                     27: struct man {
1.4       kristaps   28:        void            *data;
                     29:        struct man_cb    cb;
1.6       kristaps   30:        int              pflags;
1.1       kristaps   31:        int              flags;
1.2       kristaps   32: #define        MAN_HALT        (1 << 0)
1.16      kristaps   33: #define        MAN_ELINE       (1 << 1)        /* Next-line element scope. */
                     34: #define        MAN_BLINE       (1 << 2)        /* Next-line block scope. */
1.19      kristaps   35: #define        MAN_LITERAL     (1 << 3)        /* Literal input. */
1.1       kristaps   36:        enum man_next    next;
                     37:        struct man_node *last;
                     38:        struct man_node *first;
                     39:        struct man_meta  meta;
                     40: };
                     41:
1.10      kristaps   42: enum   merr {
1.14      kristaps   43:        WNPRINT = 0,
1.10      kristaps   44:        WMSEC,
                     45:        WDATE,
                     46:        WLNSCOPE,
                     47:        WTSPACE,
1.11      kristaps   48:        WTQUOTE,
                     49:        WNODATA,
1.12      kristaps   50:        WNOTITLE,
1.14      kristaps   51:        WESCAPE,
1.15      kristaps   52:        WNUMFMT,
1.16      kristaps   53:        WHEADARGS,
                     54:        WBODYARGS,
                     55:        WNHEADARGS,
                     56:        WMACROFORM,
                     57:        WEXITSCOPE,
1.17      kristaps   58:        WNOSCOPE,
1.19      kristaps   59:        WOLITERAL,
                     60:        WNLITERAL,
1.14      kristaps   61:        WERRMAX
1.10      kristaps   62: };
                     63:
1.16      kristaps   64: #define        MACRO_PROT_ARGS   struct man *m, int tok, int line, \
                     65:                          int ppos, int *pos, char *buf
                     66:
                     67: struct man_macro {
                     68:        int             (*fp)(MACRO_PROT_ARGS);
                     69:        int               flags;
                     70: #define        MAN_SCOPED       (1 << 0)
1.20      kristaps   71: #define        MAN_EXPLICIT     (1 << 1)       /* See blk_imp(). */
                     72: #define        MAN_FSCOPED      (1 << 2)       /* See blk_imp(). */
1.16      kristaps   73: };
                     74:
                     75: extern const struct man_macro *const man_macros;
                     76:
1.1       kristaps   77: __BEGIN_DECLS
                     78:
1.10      kristaps   79: #define                  man_perr(m, l, p, t) \
1.13      kristaps   80:                  man_err((m), (l), (p), 1, (t))
1.10      kristaps   81: #define                  man_pwarn(m, l, p, t) \
1.13      kristaps   82:                  man_err((m), (l), (p), 0, (t))
1.10      kristaps   83: #define                  man_nerr(m, n, t) \
                     84:                  man_err((m), (n)->line, (n)->pos, 1, (t))
                     85: #define                  man_nwarn(m, n, t) \
                     86:                  man_err((m), (n)->line, (n)->pos, 0, (t))
                     87:
1.1       kristaps   88: int              man_word_alloc(struct man *, int, int, const char *);
1.16      kristaps   89: int              man_block_alloc(struct man *, int, int, int);
                     90: int              man_head_alloc(struct man *, int, int, int);
                     91: int              man_body_alloc(struct man *, int, int, int);
1.1       kristaps   92: int              man_elem_alloc(struct man *, int, int, int);
                     93: void             man_node_free(struct man_node *);
                     94: void             man_node_freelist(struct man_node *);
1.21      kristaps   95: void             man_hash_init(void);
                     96: int              man_hash_find(const char *);
1.3       kristaps   97: int              man_macroend(struct man *);
1.16      kristaps   98: int              man_args(struct man *, int, int *, char *, char **);
                     99: #define        ARGS_ERROR      (-1)
                    100: #define        ARGS_EOLN       (0)
                    101: #define        ARGS_WORD       (1)
                    102: #define        ARGS_QWORD      (1)
                    103: int              man_err(struct man *, int, int, int, enum merr);
1.4       kristaps  104: int              man_vwarn(struct man *, int, int, const char *, ...);
                    105: int              man_verr(struct man *, int, int, const char *, ...);
1.5       kristaps  106: int              man_valid_post(struct man *);
1.16      kristaps  107: int              man_valid_pre(struct man *, const struct man_node *);
1.5       kristaps  108: int              man_action_post(struct man *);
1.19      kristaps  109: int              man_action_pre(struct man *, struct man_node *);
1.16      kristaps  110: int              man_unscope(struct man *, const struct man_node *);
1.1       kristaps  111:
                    112: __END_DECLS
                    113:
                    114: #endif /*!LIBMAN_H*/

CVSweb