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

Annotation of mandoc/libman.h, Revision 1.33

1.33    ! kristaps    1: /*     $Id: libman.h,v 1.32 2010/05/15 15:54:39 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.29      kristaps   30:        int              pflags; /* parse flags (see man.h) */
                     31:        int              flags; /* parse flags */
                     32: #define        MAN_HALT        (1 << 0) /* badness happened: die */
1.24      kristaps   33: #define        MAN_ELINE       (1 << 1) /* Next-line element scope. */
                     34: #define        MAN_BLINE       (1 << 2) /* Next-line block scope. */
                     35: #define        MAN_ILINE       (1 << 3) /* Ignored in next-line scope. */
                     36: #define        MAN_LITERAL     (1 << 4) /* Literal input. */
1.29      kristaps   37: #define        MAN_BPLINE      (1 << 5)
1.1       kristaps   38:        enum man_next    next;
                     39:        struct man_node *last;
                     40:        struct man_node *first;
                     41:        struct man_meta  meta;
                     42: };
                     43:
1.10      kristaps   44: enum   merr {
1.14      kristaps   45:        WNPRINT = 0,
1.10      kristaps   46:        WDATE,
                     47:        WLNSCOPE,
1.25      kristaps   48:        WLNSCOPE2,
1.10      kristaps   49:        WTSPACE,
1.11      kristaps   50:        WTQUOTE,
                     51:        WNODATA,
1.12      kristaps   52:        WNOTITLE,
1.14      kristaps   53:        WESCAPE,
1.15      kristaps   54:        WNUMFMT,
1.16      kristaps   55:        WHEADARGS,
                     56:        WBODYARGS,
                     57:        WNHEADARGS,
                     58:        WMACROFORM,
                     59:        WEXITSCOPE,
1.17      kristaps   60:        WNOSCOPE,
1.19      kristaps   61:        WOLITERAL,
                     62:        WNLITERAL,
1.28      kristaps   63:        WTITLECASE,
1.31      kristaps   64:        WBADCOMMENT,
1.14      kristaps   65:        WERRMAX
1.10      kristaps   66: };
                     67:
1.26      kristaps   68: #define        MACRO_PROT_ARGS   struct man *m, enum mant tok, int line, \
1.16      kristaps   69:                          int ppos, int *pos, char *buf
                     70:
                     71: struct man_macro {
                     72:        int             (*fp)(MACRO_PROT_ARGS);
                     73:        int               flags;
                     74: #define        MAN_SCOPED       (1 << 0)
1.20      kristaps   75: #define        MAN_EXPLICIT     (1 << 1)       /* See blk_imp(). */
                     76: #define        MAN_FSCOPED      (1 << 2)       /* See blk_imp(). */
1.24      kristaps   77: #define        MAN_NSCOPED      (1 << 3)       /* See in_line_eoln(). */
1.27      kristaps   78: #define        MAN_NOCLOSE      (1 << 4)       /* See blk_exp(). */
1.16      kristaps   79: };
                     80:
                     81: extern const struct man_macro *const man_macros;
                     82:
1.1       kristaps   83: __BEGIN_DECLS
                     84:
1.10      kristaps   85: #define                  man_perr(m, l, p, t) \
1.13      kristaps   86:                  man_err((m), (l), (p), 1, (t))
1.10      kristaps   87: #define                  man_pwarn(m, l, p, t) \
1.13      kristaps   88:                  man_err((m), (l), (p), 0, (t))
1.10      kristaps   89: #define                  man_nerr(m, n, t) \
                     90:                  man_err((m), (n)->line, (n)->pos, 1, (t))
                     91: #define                  man_nwarn(m, n, t) \
                     92:                  man_err((m), (n)->line, (n)->pos, 0, (t))
                     93:
1.1       kristaps   94: int              man_word_alloc(struct man *, int, int, const char *);
1.26      kristaps   95: int              man_block_alloc(struct man *, int, int, enum mant);
                     96: int              man_head_alloc(struct man *, int, int, enum mant);
                     97: int              man_body_alloc(struct man *, int, int, enum mant);
                     98: int              man_elem_alloc(struct man *, int, int, enum mant);
1.27      kristaps   99: void             man_node_delete(struct man *, struct man_node *);
1.21      kristaps  100: void             man_hash_init(void);
1.26      kristaps  101: enum   mant      man_hash_find(const char *);
1.3       kristaps  102: int              man_macroend(struct man *);
1.16      kristaps  103: int              man_args(struct man *, int, int *, char *, char **);
                    104: #define        ARGS_ERROR      (-1)
                    105: #define        ARGS_EOLN       (0)
                    106: #define        ARGS_WORD       (1)
                    107: #define        ARGS_QWORD      (1)
                    108: int              man_err(struct man *, int, int, int, enum merr);
1.4       kristaps  109: int              man_vwarn(struct man *, int, int, const char *, ...);
                    110: int              man_verr(struct man *, int, int, const char *, ...);
1.5       kristaps  111: int              man_valid_post(struct man *);
1.16      kristaps  112: int              man_valid_pre(struct man *, const struct man_node *);
1.5       kristaps  113: int              man_action_post(struct man *);
1.19      kristaps  114: int              man_action_pre(struct man *, struct man_node *);
1.28      kristaps  115: int              man_unscope(struct man *,
                    116:                        const struct man_node *, enum merr);
1.1       kristaps  117:
                    118: __END_DECLS
                    119:
                    120: #endif /*!LIBMAN_H*/

CVSweb