Return to libman.h CVS log

Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/libman.h, Revision 1.37

1.37    ! schwarze    1: /*     $Id: libman.h,v 1.36 2014/08/08 15:32:17 schwarze Exp $ */
1.1       kristaps    2: /*
1.29      schwarze    3:  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.2       schwarze    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.2       schwarze    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: enum   man_next {
                     21:        MAN_NEXT_SIBLING = 0,
                     22:        MAN_NEXT_CHILD
                     23: };
                     24:
                     25: struct man {
1.29      schwarze   26:        struct mparse   *parse; /* parse pointer */
1.33      schwarze   27:        int              quick; /* abort parse early */
1.15      schwarze   28:        int              flags; /* parse flags */
1.12      schwarze   29: #define        MAN_ELINE       (1 << 1) /* Next-line element scope. */
                     30: #define        MAN_BLINE       (1 << 2) /* Next-line block scope. */
                     31: #define        MAN_LITERAL     (1 << 4) /* Literal input. */
1.27      schwarze   32: #define        MAN_NEWLINE     (1 << 6) /* first macro/text in a line */
1.23      schwarze   33:        enum man_next    next; /* where to put the next node */
                     34:        struct man_node *last; /* the last parsed node */
                     35:        struct man_node *first; /* the first parsed node */
                     36:        struct man_meta  meta; /* document meta-data */
1.30      schwarze   37:        struct roff     *roff;
1.1       kristaps   38: };
                     39:
1.32      schwarze   40: #define        MACRO_PROT_ARGS   struct man *man, \
1.23      schwarze   41:                          enum mant tok, \
                     42:                          int line, \
                     43:                          int ppos, \
                     44:                          int *pos, \
                     45:                          char *buf
1.7       schwarze   46:
                     47: struct man_macro {
                     48:        int             (*fp)(MACRO_PROT_ARGS);
                     49:        int               flags;
                     50: #define        MAN_SCOPED       (1 << 0)
1.8       schwarze   51: #define        MAN_EXPLICIT     (1 << 1)       /* See blk_imp(). */
                     52: #define        MAN_FSCOPED      (1 << 2)       /* See blk_imp(). */
1.12      schwarze   53: #define        MAN_NSCOPED      (1 << 3)       /* See in_line_eoln(). */
1.13      schwarze   54: #define        MAN_NOCLOSE      (1 << 4)       /* See blk_exp(). */
1.31      schwarze   55: #define        MAN_BSCOPE       (1 << 5)       /* Break BLINE scope. */
1.7       schwarze   56: };
                     57:
                     58: extern const struct man_macro *const man_macros;
                     59:
1.1       kristaps   60: __BEGIN_DECLS
                     61:
                     62: int              man_word_alloc(struct man *, int, int, const char *);
1.13      schwarze   63: int              man_block_alloc(struct man *, int, int, enum mant);
                     64: int              man_head_alloc(struct man *, int, int, enum mant);
1.29      schwarze   65: int              man_tail_alloc(struct man *, int, int, enum mant);
1.13      schwarze   66: int              man_body_alloc(struct man *, int, int, enum mant);
                     67: int              man_elem_alloc(struct man *, int, int, enum mant);
                     68: void             man_node_delete(struct man *, struct man_node *);
1.9       schwarze   69: void             man_hash_init(void);
1.29      schwarze   70: enum mant        man_hash_find(const char *);
1.1       kristaps   71: int              man_macroend(struct man *);
                     72: int              man_valid_post(struct man *);
1.22      schwarze   73: int              man_valid_pre(struct man *, struct man_node *);
1.35      schwarze   74: int              man_unscope(struct man *, const struct man_node *);
1.1       kristaps   75:
                     76: __END_DECLS
                     77:
                     78: #endif /*!LIBMAN_H*/