Return to libmandoc.h CVS log

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

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

1.61    ! schwarze    1: /*     $OpenBSD: libmandoc.h,v 1.60 2018/12/14 01:17:46 schwarze Exp $ */
1.1       schwarze    2: /*
1.19      schwarze    3:  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.57      schwarze    4:  * Copyright (c) 2013,2014,2015,2017,2018 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.59      schwarze   19: /*
                     20:  * Return codes passed from the roff parser to the main parser.
                     21:  */
                     22:
                     23: /* Main instruction: what to do with the returned line. */
                     24: #define        ROFF_IGN        0x000   /* Don't do anything with it. */
                     25: #define        ROFF_CONT       0x001   /* Give it to the high-level parser. */
                     26: #define        ROFF_RERUN      0x002   /* Re-run the roff parser with an offset. */
                     27: #define        ROFF_REPARSE    0x004   /* Recursively run the main parser on it. */
                     28: #define        ROFF_SO         0x008   /* Include the named file. */
                     29: #define        ROFF_MASK       0x00f   /* Only one of these bits should be set. */
                     30:
                     31: /* Options for further parsing, to be OR'ed with the above. */
                     32: #define        ROFF_APPEND     0x010   /* Append the next line to this one. */
                     33: #define        ROFF_USERCALL   0x020   /* Start execution of a new macro. */
                     34: #define        ROFF_USERRET    0x040   /* Abort execution of the current macro. */
                     35: #define        ROFF_WHILE      0x100   /* Start a new .while loop. */
                     36: #define        ROFF_LOOPCONT   0x200   /* Iterate the current .while loop. */
                     37: #define        ROFF_LOOPEXIT   0x400   /* Exit the current .while loop. */
                     38: #define        ROFF_LOOPMASK   0xf00
                     39:
1.11      schwarze   40:
1.32      schwarze   41: struct buf {
1.58      schwarze   42:        char            *buf;
                     43:        size_t           sz;
                     44:        struct buf      *next;
1.32      schwarze   45: };
                     46:
1.1       schwarze   47:
1.11      schwarze   48: struct roff;
1.42      schwarze   49: struct roff_man;
1.11      schwarze   50:
1.61    ! schwarze   51: char           *mandoc_getarg(char **, int, int *);
1.53      schwarze   52: char           *mandoc_normdate(struct roff_man *, char *, int, int);
1.23      schwarze   53: int             mandoc_eos(const char *, size_t);
1.14      schwarze   54: int             mandoc_strntoi(const char *, size_t, int);
1.16      schwarze   55: const char     *mandoc_a2msec(const char*);
1.11      schwarze   56:
1.42      schwarze   57: int             mdoc_parseln(struct roff_man *, int, char *, int);
                     58: void            mdoc_endparse(struct roff_man *);
1.11      schwarze   59:
1.42      schwarze   60: int             man_parseln(struct roff_man *, int, char *, int);
                     61: void            man_endparse(struct roff_man *);
1.32      schwarze   62:
1.33      schwarze   63: int             preconv_cue(const struct buf *, size_t);
1.51      schwarze   64: int             preconv_encode(const struct buf *, size_t *,
1.33      schwarze   65:                        struct buf *, size_t *, int *);
1.11      schwarze   66:
1.27      schwarze   67: void            roff_free(struct roff *);
1.61    ! schwarze   68: struct roff    *roff_alloc(int);
1.11      schwarze   69: void            roff_reset(struct roff *);
1.44      schwarze   70: void            roff_man_free(struct roff_man *);
1.61    ! schwarze   71: struct roff_man        *roff_man_alloc(struct roff *, const char *, int);
1.44      schwarze   72: void            roff_man_reset(struct roff_man *);
1.59      schwarze   73: int             roff_parseln(struct roff *, int, struct buf *, int *);
1.57      schwarze   74: void            roff_userret(struct roff *);
1.11      schwarze   75: void            roff_endparse(struct roff *);
1.22      schwarze   76: void            roff_setreg(struct roff *, const char *, int, char sign);
1.56      schwarze   77: int             roff_getreg(struct roff *, const char *);
1.15      schwarze   78: char           *roff_strdup(const struct roff *, const char *);
1.27      schwarze   79: int             roff_getcontrol(const struct roff *,
1.19      schwarze   80:                        const char *, int *);
1.29      schwarze   81: int             roff_getformat(const struct roff *);