Support .RE with an argument; needed for audio/pms(1).

[mandoc.git] / libmandoc.h

diff --git a/libmandoc.h b/libmandoc.h
index ab21a421214a05189fe19cd7503200899433c0c1..11feebdc10198d36d8922531a2b4183636b8260d 100644 (file)
--- a/libmandoc.h
+++ b/libmandoc.h
@@ -1,6 +1,7 @@
-/*     $Id: libmandoc.h,v 1.9 2010/07/18 17:00:26 schwarze Exp $ */
+/*     $Id: libmandoc.h,v 1.55 2015/01/15 04:26:39 schwarze Exp $ */
 /*
- * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -14,24 +15,81 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifndef LIBMANDOC_H
-#define LIBMANDOC_H
+
+enum   rofferr {
+       ROFF_CONT, /* continue processing line */
+       ROFF_RERUN, /* re-run roff interpreter with offset */
+       ROFF_APPEND, /* re-run main parser, appending next line */
+       ROFF_REPARSE, /* re-run main parser on the result */
+       ROFF_SO, /* include another file */
+       ROFF_IGN, /* ignore current line */
+       ROFF_TBL, /* a table row was successfully parsed */
+       ROFF_EQN /* an equation was successfully parsed */
+};
+
+struct buf {
+       char    *buf;
+       size_t   sz;
+};
 
 __BEGIN_DECLS
 
-int             mandoc_special(char *);
-void           *mandoc_calloc(size_t, size_t);
-char           *mandoc_strdup(const char *);
-void           *mandoc_malloc(size_t);
-void           *mandoc_realloc(void *, size_t);
-time_t          mandoc_a2time(int, const char *);
-#define                 MTIME_CANONICAL        (1 << 0)
-#define                 MTIME_REDUCED          (1 << 1)
-#define                 MTIME_MDOCDATE         (1 << 2)
-#define                 MTIME_ISO_8601         (1 << 3)
-int             mandoc_eos(const char *, size_t, int);
-int             mandoc_hyph(const char *, const char *);
+struct mparse;
+struct mchars;
+struct tbl_span;
+struct eqn;
+struct roff;
+struct mdoc;
+struct man;
 
-__END_DECLS
+void            mandoc_msg(enum mandocerr, struct mparse *,
+                       int, int, const char *);
+#if __GNUC__ - 0 >= 4
+__attribute__((__format__ (__printf__, 5, 6)))
+#endif
+void            mandoc_vmsg(enum mandocerr, struct mparse *,
+                       int, int, const char *, ...);
+char           *mandoc_getarg(struct mparse *, char **, int, int *);
+char           *mandoc_normdate(struct mparse *, char *, int, int);
+int             mandoc_eos(const char *, size_t);
+int             mandoc_strntoi(const char *, size_t, int);
+const char     *mandoc_a2msec(const char*);
+
+void            mdoc_free(struct mdoc *);
+struct mdoc    *mdoc_alloc(struct roff *, struct mparse *,
+                       const char *, int);
+void            mdoc_reset(struct mdoc *);
+int             mdoc_parseln(struct mdoc *, int, char *, int);
+void            mdoc_endparse(struct mdoc *);
+void            mdoc_addspan(struct mdoc *, const struct tbl_span *);
+void            mdoc_addeqn(struct mdoc *, const struct eqn *);
+
+void            man_free(struct man *);
+struct man     *man_alloc(struct roff *, struct mparse *,
+                       const char *, int);
+void            man_reset(struct man *);
+int             man_parseln(struct man *, int, char *, int);
+void            man_endparse(struct man *);
+void            man_addspan(struct man *, const struct tbl_span *);
+void            man_addeqn(struct man *, const struct eqn *);
 
-#endif /*!LIBMANDOC_H*/
+int             preconv_cue(const struct buf *, size_t);
+int             preconv_encode(struct buf *, size_t *,
+                       struct buf *, size_t *, int *);
+
+void            roff_free(struct roff *);
+struct roff    *roff_alloc(struct mparse *, const struct mchars *, int);
+void            roff_reset(struct roff *);
+enum rofferr    roff_parseln(struct roff *, int, struct buf *, int *);
+void            roff_endparse(struct roff *);
+void            roff_setreg(struct roff *, const char *, int, char sign);
+int             roff_getreg(const struct roff *, const char *);
+char           *roff_strdup(const struct roff *, const char *);
+int             roff_getcontrol(const struct roff *,
+                       const char *, int *);
+int             roff_getformat(const struct roff *);
+
+const struct tbl_span  *roff_span(const struct roff *);
+const struct eqn       *roff_eqn(const struct roff *);
+
+__END_DECLS