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

Annotation of mandoc/libmdoc.h, Revision 1.74

1.74    ! kristaps    1: /*     $Id: libmdoc.h,v 1.73 2011/04/17 09:08:19 kristaps Exp $ */
1.1       kristaps    2: /*
1.61      schwarze    3:  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.6       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.6       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 LIBMDOC_H
                     18: #define LIBMDOC_H
                     19:
                     20: enum   mdoc_next {
                     21:        MDOC_NEXT_SIBLING = 0,
                     22:        MDOC_NEXT_CHILD
                     23: };
                     24:
                     25: struct mdoc {
1.69      kristaps   26:        struct mparse    *parse; /* parse pointer */
                     27:        int               flags; /* parse flags */
1.42      kristaps   28: #define        MDOC_HALT        (1 << 0) /* error in parse: halt */
                     29: #define        MDOC_LITERAL     (1 << 1) /* in a literal scope */
                     30: #define        MDOC_PBODY       (1 << 2) /* in the document body */
                     31: #define        MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
1.45      kristaps   32: #define        MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
                     33: #define        MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
1.51      kristaps   34: #define        MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
1.59      schwarze   35: #define        MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */
1.56      kristaps   36:        enum mdoc_next    next; /* where to put the next node */
                     37:        struct mdoc_node *last; /* the last node parsed */
                     38:        struct mdoc_node *first; /* the first node parsed */
                     39:        struct mdoc_meta  meta; /* document meta-data */
1.1       kristaps   40:        enum mdoc_sec     lastnamed;
                     41:        enum mdoc_sec     lastsec;
1.57      kristaps   42:        struct regset    *regs; /* registers */
1.13      kristaps   43: };
1.1       kristaps   44:
1.55      kristaps   45: #define        MACRO_PROT_ARGS struct mdoc *m, \
                     46:                        enum mdoct tok, \
                     47:                        int line, \
                     48:                        int ppos, \
                     49:                        int *pos, \
                     50:                        char *buf
1.1       kristaps   51:
                     52: struct mdoc_macro {
                     53:        int             (*fp)(MACRO_PROT_ARGS);
                     54:        int               flags;
                     55: #define        MDOC_CALLABLE    (1 << 0)
                     56: #define        MDOC_PARSED      (1 << 1)
                     57: #define        MDOC_EXPLICIT    (1 << 2)
                     58: #define        MDOC_PROLOGUE    (1 << 3)
                     59: #define        MDOC_IGNDELIM    (1 << 4)
                     60:        /* Reserved words in arguments treated as text. */
                     61: };
                     62:
1.36      kristaps   63: enum   margserr {
1.35      kristaps   64:        ARGS_ERROR,
1.73      kristaps   65:        ARGS_EOLN, /* end-of-line */
                     66:        ARGS_WORD, /* normal word */
                     67:        ARGS_PUNCT, /* series of punctuation */
                     68:        ARGS_QWORD, /* quoted word */
                     69:        ARGS_PHRASE, /* Ta'd phrase (-column) */
                     70:        ARGS_PPHRASE, /* tabbed phrase (-column) */
                     71:        ARGS_PEND /* last phrase (-column) */
1.35      kristaps   72: };
                     73:
1.37      kristaps   74: enum   margverr {
                     75:        ARGV_ERROR,
1.73      kristaps   76:        ARGV_EOLN, /* end of line */
                     77:        ARGV_ARG, /* valid argument */
                     78:        ARGV_WORD /* normal word (or bad argument---same thing) */
1.37      kristaps   79: };
                     80:
1.70      kristaps   81: /*
                     82:  * A punctuation delimiter is opening, closing, or "middle mark"
                     83:  * punctuation.  These govern spacing.
                     84:  * Opening punctuation (e.g., the opening parenthesis) suppresses the
                     85:  * following space; closing punctuation (e.g., the closing parenthesis)
                     86:  * suppresses the leading space; middle punctuation (e.g., the vertical
                     87:  * bar) can do either.  The middle punctuation delimiter bends the rules
                     88:  * depending on usage.
                     89:  */
                     90: enum   mdelim {
                     91:        DELIM_NONE = 0,
                     92:        DELIM_OPEN,
                     93:        DELIM_MIDDLE,
                     94:        DELIM_CLOSE,
                     95:        DELIM_MAX
                     96: };
                     97:
1.1       kristaps   98: extern const struct mdoc_macro *const mdoc_macros;
                     99:
                    100: __BEGIN_DECLS
                    101:
1.48      kristaps  102: #define                  mdoc_pmsg(m, l, p, t) \
1.69      kristaps  103:                  mandoc_msg((t), (m)->parse, (l), (p), NULL)
1.48      kristaps  104: #define                  mdoc_nmsg(m, n, t) \
1.69      kristaps  105:                  mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL)
1.1       kristaps  106: int              mdoc_macro(MACRO_PROT_ARGS);
                    107: int              mdoc_word_alloc(struct mdoc *,
                    108:                        int, int, const char *);
                    109: int              mdoc_elem_alloc(struct mdoc *, int, int,
1.31      kristaps  110:                        enum mdoct, struct mdoc_arg *);
1.1       kristaps  111: int              mdoc_block_alloc(struct mdoc *, int, int,
1.31      kristaps  112:                        enum mdoct, struct mdoc_arg *);
                    113: int              mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
                    114: int              mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
                    115: int              mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.58      schwarze  116: int              mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
                    117:                        enum mdoct tok, struct mdoc_node *body,
                    118:                        enum mdoc_endbody end);
1.33      kristaps  119: void             mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.27      kristaps  120: void             mdoc_hash_init(void);
1.31      kristaps  121: enum mdoct       mdoc_hash_find(const char *);
1.16      kristaps  122: const char      *mdoc_a2att(const char *);
1.18      kristaps  123: const char      *mdoc_a2lib(const char *);
1.17      kristaps  124: const char      *mdoc_a2st(const char *);
1.1       kristaps  125: const char      *mdoc_a2arch(const char *);
                    126: const char      *mdoc_a2vol(const char *);
                    127: const char      *mdoc_a2msec(const char *);
1.52      kristaps  128: int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
1.1       kristaps  129: int              mdoc_valid_post(struct mdoc *);
1.37      kristaps  130: enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
1.1       kristaps  131:                        struct mdoc_arg **, int *, char *);
                    132: void             mdoc_argv_free(struct mdoc_arg *);
1.36      kristaps  133: enum margserr    mdoc_args(struct mdoc *, int,
1.31      kristaps  134:                        int *, char *, enum mdoct, char **);
1.36      kristaps  135: enum margserr    mdoc_zargs(struct mdoc *, int,
1.74    ! kristaps  136:                        int *, char *, char **);
1.2       kristaps  137: int              mdoc_macroend(struct mdoc *);
1.70      kristaps  138: enum mdelim      mdoc_isdelim(const char *);
1.1       kristaps  139:
                    140: __END_DECLS
                    141:
                    142: #endif /*!LIBMDOC_H*/

CVSweb