roff.h

   1 /*      $Id: roff.h,v 1.24 2011/02/09 09:05:52 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17 #ifndef ROFF_H
  18 #define ROFF_H
  19
  20 enum    rofferr {
  21         ROFF_CONT, /* continue processing line */
  22         ROFF_RERUN, /* re-run roff interpreter with offset */
  23         ROFF_APPEND, /* re-run main parser, appending next line */
  24         ROFF_REPARSE, /* re-run main parser on the result */
  25         ROFF_SO, /* include another file */
  26         ROFF_IGN, /* ignore current line */
  27         ROFF_TBL, /* a table row was successfully parsed */
  28         ROFF_EQN, /* an equation was successfully parsed */
  29         ROFF_ERR /* badness: puke and stop */
  30 };
  31
  32 __BEGIN_DECLS
  33
  34 struct  roff;
  35
  36 void              roff_free(struct roff *);
  37 struct  roff     *roff_alloc(struct regset *, void *, mandocmsg);
  38 void              roff_reset(struct roff *);
  39 enum    rofferr   roff_parseln(struct roff *, int,
  40                         char **, size_t *, int, int *);
  41 void              roff_endparse(struct roff *);
  42 const struct tbl_span *roff_span(const struct roff *);
  43 const struct eqn *roff_eqn(const struct roff *);
  44
  45 __END_DECLS
  46
  47 #endif /*!ROFF_H*/