Simplify by making many functions in the man(7) parser void,

[mandoc.git] / libman.h

diff --git a/libman.h b/libman.h
index 8328c3dcc6630bf735a100669c901846b628fe77..8f66013ab24e7d178122f9b2d5222b3d2149a48f 100644 (file)
--- a/libman.h
+++ b/libman.h
@@ -1,59 +1,78 @@
-/* $Id: libman.h,v 1.5 2009/03/25 15:36:05 kristaps Exp $ */
+/*     $Id: libman.h,v 1.65 2014/11/28 05:51:32 schwarze Exp $ */
 /*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 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 copyright notice and this permission notice appear in all
- * copies.
+ * 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 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR 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.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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,
        MAN_NEXT_CHILD
 };
 
 struct man {
-       void            *data;
-       struct man_cb    cb;
-       void            *htab;
-       int              flags;
-#define        MAN_HALT        (1 << 0)
-       enum man_next    next;
-       struct man_node *last;
-       struct man_node *first;
-       struct man_meta  meta;
+       struct mparse   *parse; /* parse pointer */
+       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 man_node *last; /* the last parsed node */
+       struct man_node *first; /* the first parsed node */
+       struct man_meta  meta; /* document meta-data */
+       struct roff     *roff;
 };
 
+#define        MACRO_PROT_ARGS   struct man *man, \
+                         enum mant tok, \
+                         int line, \
+                         int ppos, \
+                         int *pos, \
+                         char *buf
+
+struct man_macro {
+       void            (*fp)(MACRO_PROT_ARGS);
+       int               flags;
+#define        MAN_SCOPED       (1 << 0)
+#define        MAN_EXPLICIT     (1 << 1)       /* See blk_imp(). */
+#define        MAN_FSCOPED      (1 << 2)       /* See blk_imp(). */
+#define        MAN_NSCOPED      (1 << 3)       /* See in_line_eoln(). */
+#define        MAN_NOCLOSE      (1 << 4)       /* See blk_exp(). */
+#define        MAN_BSCOPE       (1 << 5)       /* Break BLINE scope. */
+#define        MAN_JOIN         (1 << 6)       /* Join arguments together. */
+};
+
+extern const struct man_macro *const man_macros;
+
 __BEGIN_DECLS
 
-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, enum mant);
+void             man_head_alloc(struct man *, int, int, enum mant);
+void             man_body_alloc(struct man *, int, int, enum mant);
+void             man_elem_alloc(struct man *, int, int, enum mant);
+void             man_node_delete(struct man *, struct man_node *);
+void             man_hash_init(void);
+enum mant        man_hash_find(const char *);
+void             man_macroend(struct man *);
+void             man_valid_post(struct man *);
+void             man_unscope(struct man *, const struct man_node *);
 
 __END_DECLS