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

Annotation of mandoc/libmdoc.h, Revision 1.21

1.21    ! kristaps    1: /*     $Id: libmdoc.h,v 1.20 2009/07/19 21:26:27 kristaps Exp $ */
1.1       kristaps    2: /*
1.7       kristaps    3:  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
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 {
                     28:        void             *data;
                     29:        struct mdoc_cb    cb;
                     30:        void             *htab;
                     31:        int               flags;
1.11      kristaps   32: #define        MDOC_HALT        (1 << 0)       /* Error in parse. Halt. */
                     33: #define        MDOC_LITERAL     (1 << 1)       /* In a literal scope. */
                     34: #define        MDOC_PBODY       (1 << 2)       /* In the document body. */
1.1       kristaps   35:        int               pflags;
                     36:        enum mdoc_next    next;
                     37:        struct mdoc_node *last;
                     38:        struct mdoc_node *first;
                     39:        struct mdoc_meta  meta;
                     40:        enum mdoc_sec     lastnamed;
                     41:        enum mdoc_sec     lastsec;
                     42: };
                     43:
1.13      kristaps   44: enum   merr {
1.14      kristaps   45:        ETAILWS = 0,
1.13      kristaps   46:        EQUOTPARM,
                     47:        EQUOTTERM,
                     48:        EMALLOC,
                     49:        EARGVAL,
                     50:        ENOCALL,
                     51:        EBODYPROL,
                     52:        EPROLBODY,
                     53:        ETEXTPROL,
                     54:        ENOBLANK,
                     55:        ETOOLONG,
                     56:        EESCAPE,
                     57:        EPRINT,
                     58:        ENODAT,
                     59:        ENOPROLOGUE,
                     60:        ELINE,
                     61:        EATT,
                     62:        ENAME,
                     63:        ELISTTYPE,
                     64:        EDISPTYPE,
                     65:        EMULTIDISP,
1.14      kristaps   66:        EMULTILIST,
1.13      kristaps   67:        ESECNAME,
1.14      kristaps   68:        ENAMESECINC,
1.13      kristaps   69:        EARGREP,
                     70:        EBOOL,
                     71:        ECOLMIS,
                     72:        ENESTDISP,
                     73:        EMISSWIDTH,
                     74:        EWRONGMSEC,
                     75:        ESECOOO,
                     76:        ESECREP,
                     77:        EBADSTAND,
                     78:        ENOMULTILINE,
                     79:        EMULTILINE,
                     80:        ENOLINE,
                     81:        EPROLOOO,
                     82:        EPROLREP,
                     83:        EBADMSEC,
1.14      kristaps   84:        EBADSEC,
1.13      kristaps   85:        EFONT,
                     86:        EBADDATE,
1.14      kristaps   87:        ENUMFMT,
1.13      kristaps   88:        ENOWIDTH,
                     89:        EUTSNAME,
                     90:        EOBS,
                     91:        EMACPARM,
                     92:        EIMPBRK,
                     93:        EIGNE,
                     94:        EOPEN,
1.14      kristaps   95:        EQUOTPHR,
1.13      kristaps   96:        ENOCTX,
1.14      kristaps   97:        ESPACE,
1.18      kristaps   98:        ELIB,
1.14      kristaps   99:        MERRMAX
1.13      kristaps  100: };
1.1       kristaps  101:
                    102: #define        MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
                    103:                        int ppos, int *pos, char *buf
                    104:
                    105: struct mdoc_macro {
                    106:        int             (*fp)(MACRO_PROT_ARGS);
                    107:        int               flags;
                    108: #define        MDOC_CALLABLE    (1 << 0)
                    109: #define        MDOC_PARSED      (1 << 1)
                    110: #define        MDOC_EXPLICIT    (1 << 2)
                    111: #define        MDOC_PROLOGUE    (1 << 3)
                    112: #define        MDOC_IGNDELIM    (1 << 4)
                    113:        /* Reserved words in arguments treated as text. */
                    114: };
                    115:
                    116: extern const struct mdoc_macro *const mdoc_macros;
                    117:
                    118: __BEGIN_DECLS
                    119:
1.13      kristaps  120: #define                  mdoc_perr(m, l, p, t) \
                    121:                  mdoc_err((m), (l), (p), 1, (t))
                    122: #define                  mdoc_pwarn(m, l, p, t) \
                    123:                  mdoc_err((m), (l), (p), 0, (t))
                    124: #define                  mdoc_nerr(m, n, t) \
1.15      kristaps  125:                  mdoc_err((m), (n)->line, (n)->pos, 1, (t))
                    126: #define                  mdoc_nwarn(m, n, t) \
1.13      kristaps  127:                  mdoc_err((m), (n)->line, (n)->pos, 0, (t))
                    128:
                    129: int              mdoc_err(struct mdoc *, int, int, int, enum merr);
                    130: int              mdoc_verr(struct mdoc *, int, int, const char *, ...);
1.12      kristaps  131: int              mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
1.13      kristaps  132:
1.1       kristaps  133: int              mdoc_macro(MACRO_PROT_ARGS);
                    134: int              mdoc_word_alloc(struct mdoc *,
                    135:                        int, int, const char *);
                    136: int              mdoc_elem_alloc(struct mdoc *, int, int,
                    137:                        int, struct mdoc_arg *);
                    138: int              mdoc_block_alloc(struct mdoc *, int, int,
                    139:                        int, struct mdoc_arg *);
                    140: int              mdoc_head_alloc(struct mdoc *, int, int, int);
                    141: int              mdoc_tail_alloc(struct mdoc *, int, int, int);
                    142: int              mdoc_body_alloc(struct mdoc *, int, int, int);
                    143: void             mdoc_node_free(struct mdoc_node *);
                    144: void             mdoc_node_freelist(struct mdoc_node *);
1.4       kristaps  145: void            *mdoc_hash_alloc(void);
                    146: int              mdoc_hash_find(const void *, const char *);
                    147: void             mdoc_hash_free(void *);
1.1       kristaps  148: int              mdoc_iscdelim(char);
                    149: int              mdoc_isdelim(const char *);
                    150: size_t           mdoc_isescape(const char *);
                    151: enum   mdoc_sec  mdoc_atosec(const char *);
                    152: time_t           mdoc_atotime(const char *);
                    153:
                    154: size_t           mdoc_macro2len(int);
1.16      kristaps  155: const char      *mdoc_a2att(const char *);
1.18      kristaps  156: const char      *mdoc_a2lib(const char *);
1.17      kristaps  157: const char      *mdoc_a2st(const char *);
1.1       kristaps  158: const char      *mdoc_a2arch(const char *);
                    159: const char      *mdoc_a2vol(const char *);
                    160: const char      *mdoc_a2msec(const char *);
                    161: int              mdoc_valid_pre(struct mdoc *,
                    162:                        const struct mdoc_node *);
                    163: int              mdoc_valid_post(struct mdoc *);
                    164: int              mdoc_action_pre(struct mdoc *,
                    165:                        const struct mdoc_node *);
                    166: int              mdoc_action_post(struct mdoc *);
                    167: int              mdoc_argv(struct mdoc *, int, int,
                    168:                        struct mdoc_arg **, int *, char *);
                    169: #define        ARGV_ERROR      (-1)
                    170: #define        ARGV_EOLN       (0)
                    171: #define        ARGV_ARG        (1)
                    172: #define        ARGV_WORD       (2)
                    173: void             mdoc_argv_free(struct mdoc_arg *);
                    174: int              mdoc_args(struct mdoc *, int,
                    175:                        int *, char *, int, char **);
1.20      kristaps  176: int              mdoc_zargs(struct mdoc *, int,
                    177:                        int *, char *, char **);
1.1       kristaps  178: #define        ARGS_ERROR      (-1)
                    179: #define        ARGS_EOLN       (0)
                    180: #define        ARGS_WORD       (1)
                    181: #define        ARGS_PUNCT      (2)
                    182: #define        ARGS_QWORD      (3)
                    183: #define        ARGS_PHRASE     (4)
                    184:
1.2       kristaps  185: int              mdoc_macroend(struct mdoc *);
1.1       kristaps  186:
                    187: __END_DECLS
                    188:
                    189: #endif /*!LIBMDOC_H*/

CVSweb