libmandoc.h

   1 /*      $Id: libmandoc.h,v 1.51 2014/12/01 08:05:52 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
   4  * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
   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
  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
  31 struct  buf {
  32         char    *buf;
  33         size_t   sz;
  34 };
  35
  36 __BEGIN_DECLS
  37
  38 struct  mparse;
  39 struct  mchars;
  40 enum    mandocerr;
  41 struct  tbl_span;
  42 struct  eqn;
  43 struct  roff;
  44 struct  mdoc;
  45 struct  man;
  46
  47 void             mandoc_msg(enum mandocerr, struct mparse *,
  48                         int, int, const char *);
  49 #if __GNUC__ - 0 >= 4
  50 __attribute__((__format__ (__printf__, 5, 6)))
  51 #endif
  52 void             mandoc_vmsg(enum mandocerr, struct mparse *,
  53                         int, int, const char *, ...);
  54 char            *mandoc_getarg(struct mparse *, char **, int, int *);
  55 char            *mandoc_normdate(struct mparse *, char *, int, int);
  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 void             mdoc_free(struct mdoc *);
  61 struct  mdoc    *mdoc_alloc(struct roff *, struct mparse *,
  62                         const char *, int);
  63 void             mdoc_reset(struct mdoc *);
  64 int              mdoc_parseln(struct mdoc *, int, char *, int);
  65 int              mdoc_endparse(struct mdoc *);
  66 void             mdoc_addspan(struct mdoc *, const struct tbl_span *);
  67 void             mdoc_addeqn(struct mdoc *, const struct eqn *);
  68
  69 void             man_free(struct man *);
  70 struct  man     *man_alloc(struct roff *, struct mparse *, int);
  71 void             man_reset(struct man *);
  72 int              man_parseln(struct man *, int, char *, int);
  73 int              man_endparse(struct man *);
  74 void             man_addspan(struct man *, const struct tbl_span *);
  75 void             man_addeqn(struct man *, const struct eqn *);
  76
  77 int              preconv_cue(const struct buf *, size_t);
  78 int              preconv_encode(struct buf *, size_t *,
  79                         struct buf *, size_t *, int *);
  80
  81 void             roff_free(struct roff *);
  82 struct roff     *roff_alloc(struct mparse *, const struct mchars *, int);
  83 void             roff_reset(struct roff *);
  84 enum rofferr     roff_parseln(struct roff *, int, struct buf *, int *);
  85 void             roff_endparse(struct roff *);
  86 void             roff_setreg(struct roff *, const char *, int, char sign);
  87 int              roff_getreg(const struct roff *, const char *);
  88 char            *roff_strdup(const struct roff *, const char *);
  89 int              roff_getcontrol(const struct roff *,
  90                         const char *, int *);
  91 int              roff_getformat(const struct roff *);
  92
  93 const struct tbl_span   *roff_span(const struct roff *);
  94 const struct eqn        *roff_eqn(const struct roff *);
  95
  96 __END_DECLS