Return to libmandoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/libmandoc.h, Revision 1.50

1.50    ! schwarze    1: /*     $Id: libmandoc.h,v 1.49 2014/11/28 06:27:05 schwarze Exp $ */
1.1       kristaps    2: /*
1.32      schwarze    3:  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.40      schwarze    4:  * Copyright (c) 2013, 2014 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:  *
                     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:
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 */
                     27:        ROFF_EQN, /* an equation was successfully parsed */
                     28:        ROFF_ERR /* badness: puke and stop */
                     29: };
                     30:
1.45      schwarze   31: struct buf {
                     32:        char    *buf;
                     33:        size_t   sz;
                     34: };
                     35:
1.1       kristaps   36: __BEGIN_DECLS
                     37:
1.14      kristaps   38: struct roff;
                     39: struct mdoc;
                     40: struct man;
                     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.41      schwarze   55: void            mdoc_free(struct mdoc *);
1.42      schwarze   56: struct mdoc    *mdoc_alloc(struct roff *, struct mparse *,
                     57:                        const char *, int);
1.14      kristaps   58: void            mdoc_reset(struct mdoc *);
1.41      schwarze   59: int             mdoc_parseln(struct mdoc *, int, char *, int);
1.14      kristaps   60: int             mdoc_endparse(struct mdoc *);
1.49      schwarze   61: void            mdoc_addspan(struct mdoc *, const struct tbl_span *);
                     62: void            mdoc_addeqn(struct mdoc *, const struct eqn *);
1.14      kristaps   63:
1.41      schwarze   64: void            man_free(struct man *);
1.38      schwarze   65: struct man     *man_alloc(struct roff *, struct mparse *, int);
1.14      kristaps   66: void            man_reset(struct man *);
1.41      schwarze   67: int             man_parseln(struct man *, int, char *, int);
1.14      kristaps   68: int             man_endparse(struct man *);
1.49      schwarze   69: void            man_addspan(struct man *, const struct tbl_span *);
                     70: void            man_addeqn(struct man *, const struct eqn *);
1.45      schwarze   71:
1.47      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.14      kristaps   75:
1.41      schwarze   76: void            roff_free(struct roff *);
1.46      schwarze   77: struct roff    *roff_alloc(struct mparse *, const struct mchars *, int);
1.14      kristaps   78: void            roff_reset(struct roff *);
1.48      schwarze   79: enum rofferr    roff_parseln(struct roff *, int, struct buf *, int *);
1.16      kristaps   80: void            roff_endparse(struct roff *);
1.35      schwarze   81: void            roff_setreg(struct roff *, const char *, int, char sign);
1.34      schwarze   82: int             roff_getreg(const struct roff *, const char *);
1.28      kristaps   83: char           *roff_strdup(const struct roff *, const char *);
1.41      schwarze   84: int             roff_getcontrol(const struct roff *,
1.31      kristaps   85:                        const char *, int *);
1.43      schwarze   86: int             roff_getformat(const struct roff *);
1.14      kristaps   87:
1.16      kristaps   88: const struct tbl_span  *roff_span(const struct roff *);
                     89: const struct eqn       *roff_eqn(const struct roff *);
1.1       kristaps   90:
                     91: __END_DECLS