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

Annotation of mandoc/libmdoc.h, Revision 1.14

1.14    ! kristaps    1: /*     $Id: libmdoc.h,v 1.13 2009/07/06 13:04:52 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:        ECOLEMPTY,
                     47:        EARGVPARM,
                     48:        EQUOTPARM,
                     49:        EQUOTTERM,
                     50:        EMALLOC,
                     51:        EARGVAL,
                     52:        ENOCALL,
                     53:        EBODYPROL,
                     54:        EPROLBODY,
                     55:        ETEXTPROL,
                     56:        ENOBLANK,
                     57:        ETOOLONG,
                     58:        EESCAPE,
                     59:        EPRINT,
                     60:        ENODAT,
                     61:        ENOPROLOGUE,
                     62:        ELINE,
                     63:        EATT,
                     64:        ENAME,
                     65:        ELISTTYPE,
                     66:        EDISPTYPE,
                     67:        EMULTIDISP,
1.14    ! kristaps   68:        EMULTILIST,
1.13      kristaps   69:        ESECNAME,
1.14    ! kristaps   70:        ENAMESECINC,
1.13      kristaps   71:        EARGREP,
                     72:        EBOOL,
                     73:        ECOLMIS,
                     74:        ENESTDISP,
                     75:        EMISSWIDTH,
                     76:        EWRONGMSEC,
                     77:        ESECOOO,
                     78:        ESECREP,
                     79:        EBADSTAND,
                     80:        ENOMULTILINE,
                     81:        EMULTILINE,
                     82:        ENOLINE,
                     83:        EPROLOOO,
                     84:        EPROLREP,
                     85:        EBADMSEC,
1.14    ! kristaps   86:        EBADSEC,
1.13      kristaps   87:        EFONT,
                     88:        EBADDATE,
1.14    ! kristaps   89:        ENUMFMT,
1.13      kristaps   90:        ENOWIDTH,
                     91:        EUTSNAME,
                     92:        EOBS,
                     93:        EMACPARM,
                     94:        EIMPBRK,
                     95:        EIGNE,
                     96:        EOPEN,
1.14    ! kristaps   97:        EQUOTPHR,
1.13      kristaps   98:        ENOCTX,
1.14    ! kristaps   99:        ESPACE,
        !           100:        MERRMAX
1.13      kristaps  101: };
1.1       kristaps  102:
                    103: #define        MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
                    104:                        int ppos, int *pos, char *buf
                    105:
                    106: struct mdoc_macro {
                    107:        int             (*fp)(MACRO_PROT_ARGS);
                    108:        int               flags;
                    109: #define        MDOC_CALLABLE    (1 << 0)
                    110: #define        MDOC_PARSED      (1 << 1)
                    111: #define        MDOC_EXPLICIT    (1 << 2)
                    112: #define        MDOC_PROLOGUE    (1 << 3)
                    113: #define        MDOC_IGNDELIM    (1 << 4)
                    114:        /* Reserved words in arguments treated as text. */
                    115: };
                    116:
                    117: extern const struct mdoc_macro *const mdoc_macros;
                    118:
                    119: __BEGIN_DECLS
                    120:
1.13      kristaps  121: #define                  mdoc_perr(m, l, p, t) \
                    122:                  mdoc_err((m), (l), (p), 1, (t))
                    123: #define                  mdoc_pwarn(m, l, p, t) \
                    124:                  mdoc_err((m), (l), (p), 0, (t))
                    125: #define                  mdoc_nerr(m, n, t) \
                    126:                  mdoc_err((m), (n)->line, (n)->pos, 0, (t))
                    127: #define                  mdoc_nwarn(m, n, t) \
                    128:                  mdoc_err((m), (n)->line, (n)->pos, 1, (t))
                    129:
                    130: int              mdoc_err(struct mdoc *, int, int, int, enum merr);
                    131: int              mdoc_verr(struct mdoc *, int, int, const char *, ...);
1.12      kristaps  132: int              mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
1.13      kristaps  133:
1.1       kristaps  134: int              mdoc_macro(MACRO_PROT_ARGS);
                    135: int              mdoc_word_alloc(struct mdoc *,
                    136:                        int, int, const char *);
                    137: int              mdoc_elem_alloc(struct mdoc *, int, int,
                    138:                        int, struct mdoc_arg *);
                    139: int              mdoc_block_alloc(struct mdoc *, int, int,
                    140:                        int, struct mdoc_arg *);
                    141: int              mdoc_head_alloc(struct mdoc *, int, int, int);
                    142: int              mdoc_tail_alloc(struct mdoc *, int, int, int);
                    143: int              mdoc_body_alloc(struct mdoc *, int, int, int);
                    144: void             mdoc_node_free(struct mdoc_node *);
                    145: void             mdoc_node_freelist(struct mdoc_node *);
1.4       kristaps  146: void            *mdoc_hash_alloc(void);
                    147: int              mdoc_hash_find(const void *, const char *);
                    148: void             mdoc_hash_free(void *);
1.1       kristaps  149: int              mdoc_iscdelim(char);
                    150: int              mdoc_isdelim(const char *);
                    151: size_t           mdoc_isescape(const char *);
                    152: enum   mdoc_sec  mdoc_atosec(const char *);
                    153: time_t           mdoc_atotime(const char *);
                    154:
                    155: size_t           mdoc_macro2len(int);
                    156: const char      *mdoc_a2arch(const char *);
                    157: const char      *mdoc_a2vol(const char *);
                    158: const char      *mdoc_a2msec(const char *);
                    159: int              mdoc_valid_pre(struct mdoc *,
                    160:                        const struct mdoc_node *);
                    161: int              mdoc_valid_post(struct mdoc *);
                    162: int              mdoc_action_pre(struct mdoc *,
                    163:                        const struct mdoc_node *);
                    164: int              mdoc_action_post(struct mdoc *);
                    165: int              mdoc_argv(struct mdoc *, int, int,
                    166:                        struct mdoc_arg **, int *, char *);
                    167: #define        ARGV_ERROR      (-1)
                    168: #define        ARGV_EOLN       (0)
                    169: #define        ARGV_ARG        (1)
                    170: #define        ARGV_WORD       (2)
                    171: void             mdoc_argv_free(struct mdoc_arg *);
                    172: int              mdoc_args(struct mdoc *, int,
                    173:                        int *, char *, int, char **);
                    174: #define        ARGS_ERROR      (-1)
                    175: #define        ARGS_EOLN       (0)
                    176: #define        ARGS_WORD       (1)
                    177: #define        ARGS_PUNCT      (2)
                    178: #define        ARGS_QWORD      (3)
                    179: #define        ARGS_PHRASE     (4)
                    180:
1.2       kristaps  181: int              mdoc_macroend(struct mdoc *);
1.1       kristaps  182:
                    183: __END_DECLS
                    184:
                    185: #endif /*!LIBMDOC_H*/

CVSweb