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

Annotation of mandoc/libman.h, Revision 1.29

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

CVSweb