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

Annotation of mandoc/libman.h, Revision 1.42

1.42    ! schwarze    1: /*     $Id: libman.h,v 1.41 2010/07/07 15:04:54 kristaps Exp $ */
1.1       kristaps    2: /*
1.42    ! schwarze    3:  * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
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.39      kristaps   28:        void            *data; /* private application data */
                     29:        mandocmsg        msg; /* output message handler */
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.39      kristaps   38:        enum man_next    next; /* where to put the next node */
                     39:        struct man_node *last; /* the last parsed node */
                     40:        struct man_node *first; /* the first parsed node */
                     41:        struct man_meta  meta; /* document meta-data */
1.40      kristaps   42:        struct regset   *regs; /* registers */
1.1       kristaps   43: };
                     44:
1.38      kristaps   45: #define        MACRO_PROT_ARGS   struct man *m, \
                     46:                          enum mant tok, \
                     47:                          int line, \
                     48:                          int ppos, \
                     49:                          int *pos, \
                     50:                          char *buf
1.16      kristaps   51:
                     52: struct man_macro {
                     53:        int             (*fp)(MACRO_PROT_ARGS);
                     54:        int               flags;
                     55: #define        MAN_SCOPED       (1 << 0)
1.20      kristaps   56: #define        MAN_EXPLICIT     (1 << 1)       /* See blk_imp(). */
                     57: #define        MAN_FSCOPED      (1 << 2)       /* See blk_imp(). */
1.24      kristaps   58: #define        MAN_NSCOPED      (1 << 3)       /* See in_line_eoln(). */
1.27      kristaps   59: #define        MAN_NOCLOSE      (1 << 4)       /* See blk_exp(). */
1.16      kristaps   60: };
                     61:
                     62: extern const struct man_macro *const man_macros;
                     63:
1.1       kristaps   64: __BEGIN_DECLS
                     65:
1.34      kristaps   66: #define                  man_pmsg(m, l, p, t) \
                     67:                  (*(m)->msg)((t), (m)->data, (l), (p), NULL)
                     68: #define                  man_nmsg(m, n, t) \
                     69:                  (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
1.1       kristaps   70: int              man_word_alloc(struct man *, int, int, const char *);
1.26      kristaps   71: int              man_block_alloc(struct man *, int, int, enum mant);
                     72: int              man_head_alloc(struct man *, int, int, enum mant);
                     73: int              man_body_alloc(struct man *, int, int, enum mant);
                     74: int              man_elem_alloc(struct man *, int, int, enum mant);
1.27      kristaps   75: void             man_node_delete(struct man *, struct man_node *);
1.21      kristaps   76: void             man_hash_init(void);
1.26      kristaps   77: enum   mant      man_hash_find(const char *);
1.3       kristaps   78: int              man_macroend(struct man *);
1.16      kristaps   79: int              man_args(struct man *, int, int *, char *, char **);
                     80: #define        ARGS_ERROR      (-1)
                     81: #define        ARGS_EOLN       (0)
                     82: #define        ARGS_WORD       (1)
                     83: #define        ARGS_QWORD      (1)
1.34      kristaps   84: int              man_vmsg(struct man *, enum mandocerr,
                     85:                        int, int, const char *, ...);
1.5       kristaps   86: int              man_valid_post(struct man *);
1.35      kristaps   87: int              man_valid_pre(struct man *, struct man_node *);
1.5       kristaps   88: int              man_action_post(struct man *);
1.19      kristaps   89: int              man_action_pre(struct man *, struct man_node *);
1.28      kristaps   90: int              man_unscope(struct man *,
1.34      kristaps   91:                        const struct man_node *, enum mandocerr);
1.1       kristaps   92:
                     93: __END_DECLS
                     94:
                     95: #endif /*!LIBMAN_H*/

CVSweb