Return to libmdoc.h CVS log

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

Annotation of src/usr.bin/mandoc/libmdoc.h, Revision 1.87

1.87    ! schwarze    1: /*     $OpenBSD: libmdoc.h,v 1.86 2018/12/21 16:58:49 schwarze Exp $ */
1.1       kristaps    2: /*
1.45      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.84      schwarze    4:  * Copyright (c) 2013,2014,2015,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.3       schwarze    7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    9:  *
1.69      schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.3       schwarze   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.69      schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.3       schwarze   13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   17:  */
1.87    ! schwarze   18:
        !            19: struct roff_node;
        !            20: struct roff_man;
        !            21: struct mdoc_arg;
1.1       kristaps   22:
1.71      schwarze   23: #define        MACRO_PROT_ARGS struct roff_man *mdoc, \
1.81      schwarze   24:                        enum roff_tok tok, \
1.38      schwarze   25:                        int line, \
                     26:                        int ppos, \
                     27:                        int *pos, \
                     28:                        char *buf
1.1       kristaps   29:
                     30: struct mdoc_macro {
1.63      schwarze   31:        void            (*fp)(MACRO_PROT_ARGS);
1.1       kristaps   32:        int               flags;
                     33: #define        MDOC_CALLABLE    (1 << 0)
                     34: #define        MDOC_PARSED      (1 << 1)
                     35: #define        MDOC_EXPLICIT    (1 << 2)
                     36: #define        MDOC_PROLOGUE    (1 << 3)
1.52      schwarze   37: #define        MDOC_IGNDELIM    (1 << 4)
                     38: #define        MDOC_JOIN        (1 << 5)
1.1       kristaps   39: };
                     40:
1.29      schwarze   41: enum   margserr {
                     42:        ARGS_ERROR,
1.46      schwarze   43:        ARGS_EOLN, /* end-of-line */
                     44:        ARGS_WORD, /* normal word */
1.86      schwarze   45:        ARGS_ALLOC, /* normal word from roff_getarg() */
1.46      schwarze   46:        ARGS_PUNCT, /* series of punctuation */
1.77      schwarze   47:        ARGS_PHRASE /* Bl -column phrase */
1.29      schwarze   48: };
                     49:
1.45      schwarze   50: /*
                     51:  * A punctuation delimiter is opening, closing, or "middle mark"
                     52:  * punctuation.  These govern spacing.
                     53:  * Opening punctuation (e.g., the opening parenthesis) suppresses the
                     54:  * following space; closing punctuation (e.g., the closing parenthesis)
                     55:  * suppresses the leading space; middle punctuation (e.g., the vertical
                     56:  * bar) can do either.  The middle punctuation delimiter bends the rules
                     57:  * depending on usage.
                     58:  */
                     59: enum   mdelim {
                     60:        DELIM_NONE = 0,
                     61:        DELIM_OPEN,
                     62:        DELIM_MIDDLE,
                     63:        DELIM_CLOSE,
                     64:        DELIM_MAX
                     65: };
                     66:
1.84      schwarze   67: const struct mdoc_macro *mdoc_macro(enum roff_tok);
1.1       kristaps   68:
1.71      schwarze   69: void             mdoc_elem_alloc(struct roff_man *, int, int,
1.81      schwarze   70:                        enum roff_tok, struct mdoc_arg *);
1.71      schwarze   71: struct roff_node *mdoc_block_alloc(struct roff_man *, int, int,
1.81      schwarze   72:                        enum roff_tok, struct mdoc_arg *);
                     73: void             mdoc_tail_alloc(struct roff_man *, int, int,
                     74:                        enum roff_tok);
                     75: struct roff_node *mdoc_endbody_alloc(struct roff_man *, int, int,
                     76:                        enum roff_tok, struct roff_node *);
1.78      schwarze   77: void             mdoc_node_validate(struct roff_man *);
                     78: void             mdoc_state(struct roff_man *, struct roff_node *);
                     79: void             mdoc_state_reset(struct roff_man *);
                     80: const char      *mdoc_a2arch(const char *);
1.15      schwarze   81: const char      *mdoc_a2att(const char *);
1.78      schwarze   82: enum roff_sec    mdoc_a2sec(const char *);
1.15      schwarze   83: const char      *mdoc_a2st(const char *);
1.81      schwarze   84: void             mdoc_argv(struct roff_man *, int, enum roff_tok,
1.1       kristaps   85:                        struct mdoc_arg **, int *, char *);
1.71      schwarze   86: enum margserr    mdoc_args(struct roff_man *, int,
1.81      schwarze   87:                        int *, char *, enum roff_tok, char **);
1.45      schwarze   88: enum mdelim      mdoc_isdelim(const char *);