[BACK]Return to libmandoc.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/libmandoc.h, Revision 1.79

1.79    ! schwarze    1: /* $Id: libmandoc.h,v 1.78 2020/01/19 16:44:50 schwarze Exp $ */
1.1       kristaps    2: /*
1.79    ! schwarze    3:  * Copyright (c) 2013-2015,2017,2018,2020 Ingo Schwarze <schwarze@openbsd.org>
1.32      schwarze    4:  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
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.
1.79    ! schwarze   17:  *
        !            18:  * Internal interfaces for parser utilities needed by multiple parsers
        !            19:  * and the top-level functions to call the mdoc, man, and roff parsers.
1.1       kristaps   20:  */
                     21:
1.74      schwarze   22: /*
                     23:  * Return codes passed from the roff parser to the main parser.
                     24:  */
                     25:
                     26: /* Main instruction: what to do with the returned line. */
                     27: #define        ROFF_IGN        0x000   /* Don't do anything with it. */
                     28: #define        ROFF_CONT       0x001   /* Give it to the high-level parser. */
                     29: #define        ROFF_RERUN      0x002   /* Re-run the roff parser with an offset. */
                     30: #define        ROFF_REPARSE    0x004   /* Recursively run the main parser on it. */
                     31: #define        ROFF_SO         0x008   /* Include the named file. */
                     32: #define        ROFF_MASK       0x00f   /* Only one of these bits should be set. */
                     33:
                     34: /* Options for further parsing, to be OR'ed with the above. */
                     35: #define        ROFF_APPEND     0x010   /* Append the next line to this one. */
                     36: #define        ROFF_USERCALL   0x020   /* Start execution of a new macro. */
                     37: #define        ROFF_USERRET    0x040   /* Abort execution of the current macro. */
                     38: #define        ROFF_WHILE      0x100   /* Start a new .while loop. */
                     39: #define        ROFF_LOOPCONT   0x200   /* Iterate the current .while loop. */
                     40: #define        ROFF_LOOPEXIT   0x400   /* Exit the current .while loop. */
                     41: #define        ROFF_LOOPMASK   0xf00
                     42:
1.14      kristaps   43:
1.45      schwarze   44: struct buf {
1.73      schwarze   45:        char            *buf;
                     46:        size_t           sz;
                     47:        struct buf      *next;
1.45      schwarze   48: };
                     49:
1.1       kristaps   50:
1.14      kristaps   51: struct roff;
1.56      schwarze   52: struct roff_man;
1.78      schwarze   53: struct roff_node;
1.14      kristaps   54:
1.78      schwarze   55: char           *mandoc_normdate(struct roff_node *, struct roff_node *);
1.36      schwarze   56: int             mandoc_eos(const char *, size_t);
1.24      kristaps   57: int             mandoc_strntoi(const char *, size_t, int);
1.29      schwarze   58: const char     *mandoc_a2msec(const char*);
1.14      kristaps   59:
1.56      schwarze   60: int             mdoc_parseln(struct roff_man *, int, char *, int);
                     61: void            mdoc_endparse(struct roff_man *);
1.14      kristaps   62:
1.56      schwarze   63: int             man_parseln(struct roff_man *, int, char *, int);
                     64: void            man_endparse(struct roff_man *);
1.45      schwarze   65:
1.47      schwarze   66: int             preconv_cue(const struct buf *, size_t);
1.66      schwarze   67: int             preconv_encode(const struct buf *, size_t *,
1.47      schwarze   68:                        struct buf *, size_t *, int *);
1.14      kristaps   69:
1.41      schwarze   70: void            roff_free(struct roff *);
1.76      schwarze   71: struct roff    *roff_alloc(int);
1.14      kristaps   72: void            roff_reset(struct roff *);
1.58      schwarze   73: void            roff_man_free(struct roff_man *);
1.76      schwarze   74: struct roff_man        *roff_man_alloc(struct roff *, const char *, int);
1.58      schwarze   75: void            roff_man_reset(struct roff_man *);
1.74      schwarze   76: int             roff_parseln(struct roff *, int, struct buf *, int *);
1.72      schwarze   77: void            roff_userret(struct roff *);
1.16      kristaps   78: void            roff_endparse(struct roff *);
1.79    ! schwarze   79: void            roff_setreg(struct roff *, const char *, int, char);
1.71      schwarze   80: int             roff_getreg(struct roff *, const char *);
1.28      kristaps   81: char           *roff_strdup(const struct roff *, const char *);
1.77      schwarze   82: char           *roff_getarg(struct roff *, char **, int, int *);
1.41      schwarze   83: int             roff_getcontrol(const struct roff *,
1.31      kristaps   84:                        const char *, int *);
1.43      schwarze   85: int             roff_getformat(const struct roff *);

CVSweb