Return to libmandoc.h CVS log

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

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

1.31    ! schwarze    1: /*     $OpenBSD: libmandoc.h,v 1.30 2014/10/16 01:10:06 schwarze Exp $ */
1.1       schwarze    2: /*
1.19      schwarze    3:  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.26      schwarze    4:  * Copyright (c) 2013, 2014 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:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     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: #ifndef LIBMANDOC_H
                     19: #define LIBMANDOC_H
                     20:
1.11      schwarze   21: enum   rofferr {
                     22:        ROFF_CONT, /* continue processing line */
                     23:        ROFF_RERUN, /* re-run roff interpreter with offset */
                     24:        ROFF_APPEND, /* re-run main parser, appending next line */
                     25:        ROFF_REPARSE, /* re-run main parser on the result */
                     26:        ROFF_SO, /* include another file */
                     27:        ROFF_IGN, /* ignore current line */
                     28:        ROFF_TBL, /* a table row was successfully parsed */
                     29:        ROFF_EQN, /* an equation was successfully parsed */
                     30:        ROFF_ERR /* badness: puke and stop */
                     31: };
                     32:
1.1       schwarze   33: __BEGIN_DECLS
                     34:
1.11      schwarze   35: struct roff;
                     36: struct mdoc;
                     37: struct man;
                     38:
1.27      schwarze   39: void            mandoc_msg(enum mandocerr, struct mparse *,
1.11      schwarze   40:                        int, int, const char *);
1.27      schwarze   41: void            mandoc_vmsg(enum mandocerr, struct mparse *,
1.11      schwarze   42:                        int, int, const char *, ...);
                     43: char           *mandoc_getarg(struct mparse *, char **, int, int *);
                     44: char           *mandoc_normdate(struct mparse *, char *, int, int);
1.23      schwarze   45: int             mandoc_eos(const char *, size_t);
1.14      schwarze   46: int             mandoc_strntoi(const char *, size_t, int);
1.16      schwarze   47: const char     *mandoc_a2msec(const char*);
1.11      schwarze   48:
1.27      schwarze   49: void            mdoc_free(struct mdoc *);
1.28      schwarze   50: struct mdoc    *mdoc_alloc(struct roff *, struct mparse *,
                     51:                        const char *, int);
1.11      schwarze   52: void            mdoc_reset(struct mdoc *);
1.27      schwarze   53: int             mdoc_parseln(struct mdoc *, int, char *, int);
1.11      schwarze   54: int             mdoc_endparse(struct mdoc *);
                     55: int             mdoc_addspan(struct mdoc *, const struct tbl_span *);
                     56: int             mdoc_addeqn(struct mdoc *, const struct eqn *);
                     57:
1.27      schwarze   58: void            man_free(struct man *);
1.24      schwarze   59: struct man     *man_alloc(struct roff *, struct mparse *, int);
1.11      schwarze   60: void            man_reset(struct man *);
1.27      schwarze   61: int             man_parseln(struct man *, int, char *, int);
1.11      schwarze   62: int             man_endparse(struct man *);
                     63: int             man_addspan(struct man *, const struct tbl_span *);
                     64: int             man_addeqn(struct man *, const struct eqn *);
                     65:
1.27      schwarze   66: void            roff_free(struct roff *);
1.31    ! schwarze   67: struct roff    *roff_alloc(struct mparse *, const struct mchars *, int);
1.11      schwarze   68: void            roff_reset(struct roff *);
1.27      schwarze   69: enum rofferr    roff_parseln(struct roff *, int,
1.11      schwarze   70:                        char **, size_t *, int, int *);
                     71: void            roff_endparse(struct roff *);
1.22      schwarze   72: void            roff_setreg(struct roff *, const char *, int, char sign);
1.21      schwarze   73: int             roff_getreg(const struct roff *, const char *);
1.15      schwarze   74: char           *roff_strdup(const struct roff *, const char *);
1.27      schwarze   75: int             roff_getcontrol(const struct roff *,
1.19      schwarze   76:                        const char *, int *);
1.29      schwarze   77: int             roff_getformat(const struct roff *);
1.11      schwarze   78:
                     79: const struct tbl_span  *roff_span(const struct roff *);
                     80: const struct eqn       *roff_eqn(const struct roff *);
1.1       schwarze   81:
                     82: __END_DECLS
                     83:
                     84: #endif /*!LIBMANDOC_H*/