Cleaned up library manuals: removed old escapes, added EXAMPLES, stripped

[mandoc.git] / libman.h

diff --git a/libman.h b/libman.h
index 4054b22f9a0869b37b2de1f8169a52e322fa5ee8..da939e9c175c0c482fc91b12b5b5270165bfe613 100644 (file)
--- a/libman.h
+++ b/libman.h
@@ -1,20 +1,18 @@
-/* $Id: libman.h,v 1.3 2009/03/23 15:41:09 kristaps Exp $ */
+/*     $Id: libman.h,v 1.43 2010/08/20 01:02:07 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>

  *
  * Permission to use, copy, modify, and distribute this software for any
  *
  * 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
  */
 #ifndef LIBMAN_H
 #define LIBMAN_H


@@ -27,27 +25,69 @@ enum        man_next {
 };
 
 struct man {
 };
 
 struct man {

-       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;
+       void            *data; /* private application data */
+       mandocmsg        msg; /* output message handler */
+       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_ILINE       (1 << 3) /* Ignored in next-line scope. */
+#define        MAN_LITERAL     (1 << 4) /* Literal input. */
+#define        MAN_BPLINE      (1 << 5)
+       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 */

 };
 
 };
 

+#define        MACRO_PROT_ARGS   struct man *m, \
+                         enum mant tok, \
+                         int line, \
+                         int ppos, \
+                         int *pos, \
+                         char *buf
+
+struct man_macro {
+       int             (*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(). */
+};
+
+extern const struct man_macro *const man_macros;
+

 __BEGIN_DECLS
 
 __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_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_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_hash_init(void);
+enum   mant      man_hash_find(const char *);

 int              man_macroend(struct man *);
 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_action_post(struct man *);
+int              man_action_pre(struct man *, struct man_node *);
+int              man_unscope(struct man *, 
+                       const struct man_node *, enum mandocerr);

 
 __END_DECLS
 
 
 __END_DECLS