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 e1a9aecc8ee6c6ba1c77194395ff189451392003..d20e1b77a32fbb357b92d03a2104727136909368 100644 (file)
--- a/libman.h
+++ b/libman.h
@@ -1,23 +1,20 @@
-/*     $Id: libman.h,v 1.44 2010/11/30 15:36:28 kristaps Exp $ */
+/*     $Id: libman.h,v 1.70 2015/04/02 23:48:19 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * 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.
  *
  *
  * 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
  * 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.
  */
  * 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,
 
 enum   man_next {
        MAN_NEXT_SIBLING = 0,


@@ -25,68 +22,52 @@ enum        man_next {
 };
 
 struct man {
 };
 
 struct man {

-       void            *data; /* private application data */
-       mandocmsg        msg; /* output message handler */
+       struct mparse   *parse; /* parse pointer */
+       const char      *defos; /* default OS argument for .TH */
+       int              quick; /* abort parse early */

        int              flags; /* parse flags */
        int              flags; /* parse flags */

-#define        MAN_HALT        (1 << 0) /* badness happened: die */

 #define        MAN_ELINE       (1 << 1) /* Next-line element scope. */
 #define        MAN_BLINE       (1 << 2) /* Next-line block scope. */
 #define        MAN_ELINE       (1 << 1) /* Next-line element scope. */
 #define        MAN_BLINE       (1 << 2) /* Next-line block scope. */

-#define        MAN_ILINE       (1 << 3) /* Ignored in next-line scope. */

 #define        MAN_LITERAL     (1 << 4) /* Literal input. */
 #define        MAN_LITERAL     (1 << 4) /* Literal input. */

-#define        MAN_BPLINE      (1 << 5)
+#define        MAN_NEWLINE     (1 << 6) /* first macro/text in a line */

        enum man_next    next; /* where to put the next node */
        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 regset   *regs; /* registers */
+       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;

 };
 
 };
 

-#define        MACRO_PROT_ARGS   struct man *m, \
-                         enum mant tok, \
+#define        MACRO_PROT_ARGS   struct man *man, \
+                         int tok, \

                          int line, \
                          int ppos, \
                          int *pos, \
                          char *buf
 
 struct man_macro {
                          int line, \
                          int ppos, \
                          int *pos, \
                          char *buf
 
 struct man_macro {

-       int             (*fp)(MACRO_PROT_ARGS);
+       void            (*fp)(MACRO_PROT_ARGS);

        int               flags;
        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_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. */

 };
 
 extern const struct man_macro *const man_macros;
 
 __BEGIN_DECLS
 
 };
 
 extern const struct man_macro *const man_macros;
 
 __BEGIN_DECLS
 

-#define                  man_pmsg(m, l, p, t) \
-                 (*(m)->msg)((t), (m)->data, (l), (p), NULL)
-#define                  man_nmsg(m, n, t) \
-                 (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
-int              man_word_alloc(struct man *, int, int, const char *);
-int              man_block_alloc(struct man *, int, int, enum mant);
-int              man_head_alloc(struct man *, int, int, enum mant);
-int              man_body_alloc(struct man *, int, int, enum mant);
-int              man_elem_alloc(struct man *, int, int, enum mant);
-void             man_node_delete(struct man *, struct man_node *);
+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);
 void             man_hash_init(void);

-enum   mant      man_hash_find(const char *);
-int              man_macroend(struct man *);
-int              man_args(struct man *, int, int *, char *, char **);
-#define        ARGS_ERROR      (-1)
-#define        ARGS_EOLN       (0)
-#define        ARGS_WORD       (1)
-#define        ARGS_QWORD      (1)
-int              man_vmsg(struct man *, enum mandocerr,
-                       int, int, const char *, ...);
-int              man_valid_post(struct man *);
-int              man_valid_pre(struct man *, struct man_node *);
-int              man_unscope(struct man *, 
-                       const struct man_node *, enum mandocerr);
+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
 
 __END_DECLS

-
-#endif /*!LIBMAN_H*/