]> git.cameronkatri.com Git - mandoc.git/blobdiff - libmandoc.h
warning about unknown .Lb arguments; inspired by mdoclint(1)
[mandoc.git] / libmandoc.h
index eadaf25743e688d7664ec9ca5a3511bc3c83bdb8..abc616a59e870b65ec79bc8fcd17b3b2f51d136e 100644 (file)
@@ -1,31 +1,80 @@
-/*     $Id: libmandoc.h,v 1.12 2011/03/17 08:49:34 kristaps Exp $ */
+/*     $Id: libmandoc.h,v 1.67 2017/04/29 12:45:41 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, 2015 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
  * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * 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
 
-__BEGIN_DECLS
+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 */
+};
 
-int             mandoc_special(char *);
-char           *mandoc_strdup(const char *);
-char           *mandoc_getarg(char **, mandocmsg, void *, int, int *);
-char           *mandoc_normdate(char *, mandocmsg, void *, int, int);
-int             mandoc_eos(const char *, size_t, int);
-int             mandoc_hyph(const char *, const char *);
+struct buf {
+       char    *buf;
+       size_t   sz;
+};
 
-__END_DECLS
 
-#endif /*!LIBMANDOC_H*/
+struct mparse;
+struct tbl_span;
+struct eqn;
+struct roff;
+struct roff_man;
+
+void            mandoc_msg(enum mandocerr, struct mparse *,
+                       int, int, const char *);
+void            mandoc_vmsg(enum mandocerr, struct mparse *,
+                       int, int, const char *, ...)
+                       __attribute__((__format__ (__printf__, 5, 6)));
+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*);
+
+int             mdoc_parseln(struct roff_man *, int, char *, int);
+void            mdoc_endparse(struct roff_man *);
+
+int             man_parseln(struct roff_man *, int, char *, int);
+void            man_endparse(struct roff_man *);
+
+int             preconv_cue(const struct buf *, size_t);
+int             preconv_encode(const struct buf *, size_t *,
+                       struct buf *, size_t *, int *);
+
+void            roff_free(struct roff *);
+struct roff    *roff_alloc(struct mparse *, int);
+void            roff_reset(struct roff *);
+void            roff_man_free(struct roff_man *);
+struct roff_man        *roff_man_alloc(struct roff *, struct mparse *,
+                       const char *, int);
+void            roff_man_reset(struct roff_man *);
+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 *);