Vastly simplify man(7) block unwinding, similar to mdoc_macro.c 1.171.

[mandoc.git] / libman.h

diff --git a/libman.h b/libman.h
index 8f1228d498527f5dc33ec250e4ce1a2a5a75bd06..d20e1b77a32fbb357b92d03a2104727136909368 100644 (file)
--- a/libman.h
+++ b/libman.h
@@ -1,23 +1,20 @@
-/*     $Id: libman.h,v 1.10 2009/06/18 10:53:58 kristaps Exp $ */
+/*     $Id: libman.h,v 1.70 2015/04/02 23:48:19 schwarze Exp $ */
 /*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 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 LIBMAN_H
-#define LIBMAN_H
-
-#include "man.h"
 
 enum   man_next {
        MAN_NEXT_SIBLING = 0,
@@ -25,56 +22,52 @@ enum        man_next {
 };
 
 struct man {
-       void            *data;
-       struct man_cb    cb;
-       void            *htab;
-       int              pflags;
-       int              flags;
-#define        MAN_HALT        (1 << 0)
-#define        MAN_NLINE       (1 << 1)
-       enum man_next    next;
-       struct man_node *last;
-       struct man_node *first;
-       struct man_meta  meta;
+       struct mparse   *parse; /* parse pointer */
+       const char      *defos; /* default OS argument for .TH */
+       int              quick; /* abort parse early */
+       int              flags; /* parse flags */
+#define        MAN_ELINE       (1 << 1) /* Next-line element scope. */
+#define        MAN_BLINE       (1 << 2) /* Next-line block scope. */
+#define        MAN_LITERAL     (1 << 4) /* Literal input. */
+#define        MAN_NEWLINE     (1 << 6) /* first macro/text in a line */
+       enum man_next    next; /* where to put the next node */
+       struct roff_node *last; /* the last parsed node */
+       struct roff_node *first; /* the first parsed node */
+       struct roff_meta meta; /* document meta-data */
+       struct roff     *roff;
 };
 
-enum   merr {
-       WNPRINT,
-       WNMEM,
-       WMSEC,
-       WDATE,
-       WLNSCOPE,
-       WTSPACE,
-       WTQUOTE
+#define        MACRO_PROT_ARGS   struct man *man, \
+                         int tok, \
+                         int line, \
+                         int ppos, \
+                         int *pos, \
+                         char *buf
+
+struct man_macro {
+       void            (*fp)(MACRO_PROT_ARGS);
+       int               flags;
+#define        MAN_SCOPED       (1 << 0)  /* Optional next-line scope. */
+#define        MAN_NSCOPED      (1 << 1)  /* Allowed in next-line element scope. */
+#define        MAN_BSCOPE       (1 << 2)  /* Break next-line block scope. */
+#define        MAN_JOIN         (1 << 3)  /* Join arguments together. */
 };
 
-__BEGIN_DECLS
+extern const struct man_macro *const man_macros;
 
-#define                  man_perr(m, l, p, t) \
-                 man_err((m), l, p, 1, (t))
-#define                  man_pwarn(m, l, p, t) \
-                 man_err((m), l, p, 0, (t))
-#define                  man_nerr(m, n, t) \
-                 man_err((m), (n)->line, (n)->pos, 1, (t))
-#define                  man_nwarn(m, n, t) \
-                 man_err((m), (n)->line, (n)->pos, 0, (t))
+__BEGIN_DECLS
 
-int              man_err(struct man *, int, int, int, enum merr);
-int              man_word_alloc(struct man *, int, int, const char *);
-int              man_elem_alloc(struct man *, int, int, int);
-void             man_node_free(struct man_node *);
-void             man_node_freelist(struct man_node *);
-void            *man_hash_alloc(void);
-int              man_macro(struct man *, int, 
-                       int, int, int *, char *);
-int              man_hash_find(const void *, const char *);
-void             man_hash_free(void *);
-int              man_macroend(struct man *);
-int              man_vwarn(struct man *, int, int, const char *, ...);
-int              man_verr(struct man *, int, int, const char *, ...);
-int              man_valid_post(struct man *);
-int              man_action_post(struct man *);
+void             man_word_alloc(struct man *, int, int, const char *);
+void             man_word_append(struct man *, const char *);
+void             man_block_alloc(struct man *, int, int, int);
+void             man_head_alloc(struct man *, int, int, int);
+void             man_body_alloc(struct man *, int, int, int);
+void             man_elem_alloc(struct man *, int, int, int);
+void             man_node_delete(struct man *, struct roff_node *);
+void             man_hash_init(void);
+int              man_hash_find(const char *);
+void             man_macroend(struct man *);
+void             man_valid_post(struct man *);
+void             man_unscope(struct man *, const struct roff_node *);
 
 __END_DECLS
-
-#endif /*!LIBMAN_H*/