contrib/mdocml/libmandoc.h

   1 /* $Id: libmandoc.h,v 1.80 2021/06/27 17:57:54 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2013-2015,2017,2018,2020 Ingo Schwarze <schwarze@openbsd.org>
   4  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
   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 AUTHORS DISCLAIM ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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  * Internal interfaces for parser utilities needed by multiple parsers
  19  * and the top-level functions to call the mdoc, man, and roff parsers.
  20  */
  21
  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
  43
  44 struct  buf {
  45         char            *buf;
  46         size_t           sz;
  47         struct buf      *next;
  48 };
  49
  50
  51 struct  roff;
  52 struct  roff_man;
  53 struct  roff_node;
  54
  55 char            *mandoc_normdate(struct roff_node *, struct roff_node *);
  56 int              mandoc_eos(const char *, size_t);
  57 int              mandoc_strntoi(const char *, size_t, int);
  58 const char      *mandoc_a2msec(const char*);
  59
  60 int              mdoc_parseln(struct roff_man *, int, char *, int);
  61 void             mdoc_endparse(struct roff_man *);
  62
  63 int              man_parseln(struct roff_man *, int, char *, int);
  64 void             man_endparse(struct roff_man *);
  65
  66 int              preconv_cue(const struct buf *, size_t);
  67 int              preconv_encode(const struct buf *, size_t *,
  68                         struct buf *, size_t *, int *);
  69
  70 void             roff_free(struct roff *);
  71 struct roff     *roff_alloc(int);
  72 void             roff_reset(struct roff *);
  73 void             roff_man_free(struct roff_man *);
  74 struct roff_man *roff_man_alloc(struct roff *, const char *, int);
  75 void             roff_man_reset(struct roff_man *);
  76 int              roff_parseln(struct roff *, int, struct buf *, int *, size_t);
  77 void             roff_userret(struct roff *);
  78 void             roff_endparse(struct roff *);
  79 void             roff_setreg(struct roff *, const char *, int, char);
  80 int              roff_getreg(struct roff *, const char *);
  81 char            *roff_strdup(const struct roff *, const char *);
  82 char            *roff_getarg(struct roff *, char **, int, int *);
  83 int              roff_getcontrol(const struct roff *,
  84                         const char *, int *);
  85 int              roff_getformat(const struct roff *);