Return to libmandoc.h CVS log

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

Annotation of src/usr.bin/mandoc/libmandoc.h, Revision 1.42

1.42    ! schwarze    1: /*     $OpenBSD: libmandoc.h,v 1.41 2015/01/15 04:26:06 schwarze Exp $ */
1.1       schwarze    2: /*
1.19      schwarze    3:  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.42    ! schwarze    4:  * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1       schwarze    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
                      7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
                      9:  *
1.42    ! schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1       schwarze   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.42    ! schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1       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.
                     17:  */
                     18:
1.11      schwarze   19: enum   rofferr {
                     20:        ROFF_CONT, /* continue processing line */
                     21:        ROFF_RERUN, /* re-run roff interpreter with offset */
                     22:        ROFF_APPEND, /* re-run main parser, appending next line */
                     23:        ROFF_REPARSE, /* re-run main parser on the result */
                     24:        ROFF_SO, /* include another file */
                     25:        ROFF_IGN, /* ignore current line */
                     26:        ROFF_TBL, /* a table row was successfully parsed */
1.40      schwarze   27:        ROFF_EQN /* an equation was successfully parsed */
1.11      schwarze   28: };
                     29:
1.32      schwarze   30: struct buf {
                     31:        char    *buf;
                     32:        size_t   sz;
                     33: };
                     34:
1.1       schwarze   35: __BEGIN_DECLS
                     36:
1.37      schwarze   37: struct mparse;
                     38: struct mchars;
                     39: struct tbl_span;
                     40: struct eqn;
1.11      schwarze   41: struct roff;
1.42    ! schwarze   42: struct roff_man;
1.11      schwarze   43:
1.27      schwarze   44: void            mandoc_msg(enum mandocerr, struct mparse *,
1.11      schwarze   45:                        int, int, const char *);
1.27      schwarze   46: void            mandoc_vmsg(enum mandocerr, struct mparse *,
1.11      schwarze   47:                        int, int, const char *, ...);
                     48: char           *mandoc_getarg(struct mparse *, char **, int, int *);
                     49: char           *mandoc_normdate(struct mparse *, char *, int, int);
1.23      schwarze   50: int             mandoc_eos(const char *, size_t);
1.14      schwarze   51: int             mandoc_strntoi(const char *, size_t, int);
1.16      schwarze   52: const char     *mandoc_a2msec(const char*);
1.11      schwarze   53:
1.42    ! schwarze   54: void            mdoc_free(struct roff_man *);
        !            55: struct roff_man        *mdoc_alloc(struct roff *, struct mparse *,
1.28      schwarze   56:                        const char *, int);
1.42    ! schwarze   57: void            mdoc_reset(struct roff_man *);
        !            58: int             mdoc_parseln(struct roff_man *, int, char *, int);
        !            59: void            mdoc_endparse(struct roff_man *);
        !            60: void            mdoc_addspan(struct roff_man *, const struct tbl_span *);
        !            61: void            mdoc_addeqn(struct roff_man *, const struct eqn *);
1.11      schwarze   62:
1.42    ! schwarze   63: void            man_free(struct roff_man *);
        !            64: struct roff_man        *man_alloc(struct roff *, struct mparse *,
1.39      schwarze   65:                        const char *, int);
1.42    ! schwarze   66: void            man_reset(struct roff_man *);
        !            67: int             man_parseln(struct roff_man *, int, char *, int);
        !            68: void            man_endparse(struct roff_man *);
        !            69: void            man_addspan(struct roff_man *, const struct tbl_span *);
        !            70: void            man_addeqn(struct roff_man *, const struct eqn *);
1.32      schwarze   71:
1.33      schwarze   72: int             preconv_cue(const struct buf *, size_t);
                     73: int             preconv_encode(struct buf *, size_t *,
                     74:                        struct buf *, size_t *, int *);
1.11      schwarze   75:
1.27      schwarze   76: void            roff_free(struct roff *);
1.31      schwarze   77: struct roff    *roff_alloc(struct mparse *, const struct mchars *, int);
1.11      schwarze   78: void            roff_reset(struct roff *);
1.34      schwarze   79: enum rofferr    roff_parseln(struct roff *, int, struct buf *, int *);
1.11      schwarze   80: void            roff_endparse(struct roff *);
1.22      schwarze   81: void            roff_setreg(struct roff *, const char *, int, char sign);
1.21      schwarze   82: int             roff_getreg(const struct roff *, const char *);
1.15      schwarze   83: char           *roff_strdup(const struct roff *, const char *);
1.27      schwarze   84: int             roff_getcontrol(const struct roff *,
1.19      schwarze   85:                        const char *, int *);
1.29      schwarze   86: int             roff_getformat(const struct roff *);
1.11      schwarze   87:
                     88: const struct tbl_span  *roff_span(const struct roff *);
                     89: const struct eqn       *roff_eqn(const struct roff *);
1.1       schwarze   90:
                     91: __END_DECLS