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

Annotation of mandoc/libmdoc.h, Revision 1.62

1.62    ! schwarze    1: /*     $Id: libmdoc.h,v 1.61 2010/07/13 23:53:20 schwarze 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: #include "mdoc.h"
                     21:
                     22: enum   mdoc_next {
                     23:        MDOC_NEXT_SIBLING = 0,
                     24:        MDOC_NEXT_CHILD
                     25: };
                     26:
                     27: struct mdoc {
1.56      kristaps   28:        void             *data; /* private application data */
                     29:        mandocmsg         msg; /* message callback */
1.1       kristaps   30:        int               flags;
1.42      kristaps   31: #define        MDOC_HALT        (1 << 0) /* error in parse: halt */
                     32: #define        MDOC_LITERAL     (1 << 1) /* in a literal scope */
                     33: #define        MDOC_PBODY       (1 << 2) /* in the document body */
                     34: #define        MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
1.45      kristaps   35: #define        MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
                     36: #define        MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
1.51      kristaps   37: #define        MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
1.59      schwarze   38: #define        MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */
1.56      kristaps   39:        enum mdoc_next    next; /* where to put the next node */
                     40:        struct mdoc_node *last; /* the last node parsed */
                     41:        struct mdoc_node *first; /* the first node parsed */
                     42:        struct mdoc_meta  meta; /* document meta-data */
1.1       kristaps   43:        enum mdoc_sec     lastnamed;
                     44:        enum mdoc_sec     lastsec;
1.57      kristaps   45:        struct regset    *regs; /* registers */
1.13      kristaps   46: };
1.1       kristaps   47:
1.55      kristaps   48: #define        MACRO_PROT_ARGS struct mdoc *m, \
                     49:                        enum mdoct tok, \
                     50:                        int line, \
                     51:                        int ppos, \
                     52:                        int *pos, \
                     53:                        char *buf
1.1       kristaps   54:
                     55: struct mdoc_macro {
                     56:        int             (*fp)(MACRO_PROT_ARGS);
                     57:        int               flags;
                     58: #define        MDOC_CALLABLE    (1 << 0)
                     59: #define        MDOC_PARSED      (1 << 1)
                     60: #define        MDOC_EXPLICIT    (1 << 2)
                     61: #define        MDOC_PROLOGUE    (1 << 3)
                     62: #define        MDOC_IGNDELIM    (1 << 4)
                     63:        /* Reserved words in arguments treated as text. */
                     64: };
                     65:
1.36      kristaps   66: enum   margserr {
1.35      kristaps   67:        ARGS_ERROR,
                     68:        ARGS_EOLN,
                     69:        ARGS_WORD,
                     70:        ARGS_PUNCT,
                     71:        ARGS_QWORD,
1.38      kristaps   72:        ARGS_PHRASE,
1.40      kristaps   73:        ARGS_PPHRASE,
                     74:        ARGS_PEND
1.35      kristaps   75: };
                     76:
1.37      kristaps   77: enum   margverr {
                     78:        ARGV_ERROR,
                     79:        ARGV_EOLN,
                     80:        ARGV_ARG,
                     81:        ARGV_WORD
                     82: };
                     83:
1.46      schwarze   84: enum   mdelim {
                     85:        DELIM_NONE = 0,
                     86:        DELIM_OPEN,
                     87:        DELIM_MIDDLE,
                     88:        DELIM_CLOSE
                     89: };
                     90:
1.1       kristaps   91: extern const struct mdoc_macro *const mdoc_macros;
                     92:
                     93: __BEGIN_DECLS
                     94:
1.48      kristaps   95: #define                  mdoc_pmsg(m, l, p, t) \
                     96:                  (*(m)->msg)((t), (m)->data, (l), (p), NULL)
                     97: #define                  mdoc_nmsg(m, n, t) \
                     98:                  (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
                     99: int              mdoc_vmsg(struct mdoc *, enum mandocerr,
                    100:                        int, int, const char *, ...);
1.1       kristaps  101: int              mdoc_macro(MACRO_PROT_ARGS);
                    102: int              mdoc_word_alloc(struct mdoc *,
                    103:                        int, int, const char *);
                    104: int              mdoc_elem_alloc(struct mdoc *, int, int,
1.31      kristaps  105:                        enum mdoct, struct mdoc_arg *);
1.1       kristaps  106: int              mdoc_block_alloc(struct mdoc *, int, int,
1.31      kristaps  107:                        enum mdoct, struct mdoc_arg *);
                    108: int              mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
                    109: int              mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
                    110: int              mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.58      schwarze  111: int              mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
                    112:                        enum mdoct tok, struct mdoc_node *body,
                    113:                        enum mdoc_endbody end);
1.33      kristaps  114: void             mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.27      kristaps  115: void             mdoc_hash_init(void);
1.31      kristaps  116: enum mdoct       mdoc_hash_find(const char *);
1.46      schwarze  117: enum mdelim      mdoc_iscdelim(char);
                    118: enum mdelim      mdoc_isdelim(const char *);
1.1       kristaps  119: size_t           mdoc_isescape(const char *);
1.41      kristaps  120: enum   mdoc_sec  mdoc_str2sec(const char *);
1.1       kristaps  121: time_t           mdoc_atotime(const char *);
1.39      kristaps  122: size_t           mdoc_macro2len(enum mdoct);
1.16      kristaps  123: const char      *mdoc_a2att(const char *);
1.18      kristaps  124: const char      *mdoc_a2lib(const char *);
1.17      kristaps  125: const char      *mdoc_a2st(const char *);
1.1       kristaps  126: const char      *mdoc_a2arch(const char *);
                    127: const char      *mdoc_a2vol(const char *);
                    128: const char      *mdoc_a2msec(const char *);
1.52      kristaps  129: int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
1.1       kristaps  130: int              mdoc_valid_post(struct mdoc *);
                    131: int              mdoc_action_pre(struct mdoc *,
1.49      kristaps  132:                        struct mdoc_node *);
1.1       kristaps  133: int              mdoc_action_post(struct mdoc *);
1.37      kristaps  134: enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
1.1       kristaps  135:                        struct mdoc_arg **, int *, char *);
                    136: void             mdoc_argv_free(struct mdoc_arg *);
1.32      kristaps  137: void             mdoc_argn_free(struct mdoc_arg *, int);
1.36      kristaps  138: enum margserr    mdoc_args(struct mdoc *, int,
1.31      kristaps  139:                        int *, char *, enum mdoct, char **);
1.36      kristaps  140: enum margserr    mdoc_zargs(struct mdoc *, int,
1.25      kristaps  141:                        int *, char *, int, char **);
1.43      kristaps  142: #define        ARGS_DELIM      (1 << 1)
                    143: #define        ARGS_TABSEP     (1 << 2)
                    144: #define        ARGS_NOWARN     (1 << 3)
1.35      kristaps  145:
1.2       kristaps  146: int              mdoc_macroend(struct mdoc *);
1.1       kristaps  147:
                    148: __END_DECLS
                    149:
                    150: #endif /*!LIBMDOC_H*/

CVSweb