Return to libmandoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/libmandoc.h, Revision 1.63

1.63    ! schwarze    1: /*     $Id: libmandoc.h,v 1.62 2015/11/07 14:01:16 schwarze Exp $ */
1.1       kristaps    2: /*
1.32      schwarze    3:  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.56      schwarze    4:  * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    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.56      schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1       kristaps   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.56      schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1       kristaps   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.14      kristaps   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.54      schwarze   27:        ROFF_EQN /* an equation was successfully parsed */
1.14      kristaps   28: };
                     29:
1.45      schwarze   30: struct buf {
                     31:        char    *buf;
                     32:        size_t   sz;
                     33: };
                     34:
1.1       kristaps   35:
1.51      schwarze   36: struct mparse;
                     37: struct tbl_span;
                     38: struct eqn;
1.14      kristaps   39: struct roff;
1.56      schwarze   40: struct roff_man;
1.14      kristaps   41:
1.41      schwarze   42: void            mandoc_msg(enum mandocerr, struct mparse *,
1.14      kristaps   43:                        int, int, const char *);
1.37      joerg      44: #if __GNUC__ - 0 >= 4
                     45: __attribute__((__format__ (__printf__, 5, 6)))
                     46: #endif
1.41      schwarze   47: void            mandoc_vmsg(enum mandocerr, struct mparse *,
1.14      kristaps   48:                        int, int, const char *, ...);
1.20      kristaps   49: char           *mandoc_getarg(struct mparse *, char **, int, int *);
1.16      kristaps   50: char           *mandoc_normdate(struct mparse *, char *, int, int);
1.36      schwarze   51: int             mandoc_eos(const char *, size_t);
1.24      kristaps   52: int             mandoc_strntoi(const char *, size_t, int);
1.29      schwarze   53: const char     *mandoc_a2msec(const char*);
1.14      kristaps   54:
1.57      schwarze   55: void            mdoc_hash_init(void);
1.56      schwarze   56: int             mdoc_parseln(struct roff_man *, int, char *, int);
                     57: void            mdoc_endparse(struct roff_man *);
1.14      kristaps   58:
1.57      schwarze   59: void            man_hash_init(void);
1.56      schwarze   60: int             man_parseln(struct roff_man *, int, char *, int);
                     61: void            man_endparse(struct roff_man *);
1.45      schwarze   62:
1.47      schwarze   63: int             preconv_cue(const struct buf *, size_t);
                     64: int             preconv_encode(struct buf *, size_t *,
                     65:                        struct buf *, size_t *, int *);
1.14      kristaps   66:
1.41      schwarze   67: void            roff_free(struct roff *);
1.61      schwarze   68: struct roff    *roff_alloc(struct mparse *, int);
1.14      kristaps   69: void            roff_reset(struct roff *);
1.58      schwarze   70: void            roff_man_free(struct roff_man *);
                     71: struct roff_man        *roff_man_alloc(struct roff *, struct mparse *,
                     72:                        const char *, int);
                     73: void            roff_man_reset(struct roff_man *);
1.48      schwarze   74: enum rofferr    roff_parseln(struct roff *, int, struct buf *, int *);
1.16      kristaps   75: void            roff_endparse(struct roff *);
1.35      schwarze   76: void            roff_setreg(struct roff *, const char *, int, char sign);
1.34      schwarze   77: int             roff_getreg(const struct roff *, const char *);
1.28      kristaps   78: char           *roff_strdup(const struct roff *, const char *);
1.41      schwarze   79: int             roff_getcontrol(const struct roff *,
1.31      kristaps   80:                        const char *, int *);
1.43      schwarze   81: int             roff_getformat(const struct roff *);
1.14      kristaps   82:
1.16      kristaps   83: const struct tbl_span  *roff_span(const struct roff *);
                     84: const struct eqn       *roff_eqn(const struct roff *);