mandoc.1 reflects actual use of -f option (schwarze@openbsd.org)

[mandoc.git] / libmdoc.h

diff --git a/libmdoc.h b/libmdoc.h
index f7054711b378112b249ae5d3779c58b5a05d2173..73963a396e3d4ae2b7d2aec1f31f67404fa5e19c 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,20 +1,18 @@
-/* $Id: libmdoc.h,v 1.3 2009/03/31 13:50:19 kristaps Exp $ */
+/*     $Id: libmdoc.h,v 1.11 2009/06/17 10:53:32 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
  * 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 LIBMDOC_H
 #define LIBMDOC_H
@@ -31,8 +29,9 @@ struct        mdoc {
        struct mdoc_cb    cb;
        void             *htab;
        int               flags;
-#define        MDOC_HALT        (1 << 0)
-#define        MDOC_LITERAL     (1 << 1)
+#define        MDOC_HALT        (1 << 0)       /* Error in parse. Halt. */
+#define        MDOC_LITERAL     (1 << 1)       /* In a literal scope. */
+#define        MDOC_PBODY       (1 << 2)       /* In the document body. */
        int               pflags;
        enum mdoc_next    next;
        struct mdoc_node *last;
@@ -57,48 +56,25 @@ struct      mdoc_macro {
        /* Reserved words in arguments treated as text. */
 };
 
-#define        mdoc_nwarn(mdoc, node, type, fmt, ...) \
-                 mdoc_vwarn((mdoc), (node)->line, \
-                 (node)->pos, (type), (fmt), ##__VA_ARGS__)
-
-#define        mdoc_nerr(mdoc, node, fmt, ...) \
-                 mdoc_verr((mdoc), (node)->line, \
-                 (node)->pos, (fmt), ##__VA_ARGS__)
-
-#define        mdoc_warn(mdoc, type, fmt, ...) \
-                 mdoc_vwarn((mdoc), (mdoc)->last->line, \
-                 (mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__)
-
-#define        mdoc_err(mdoc, fmt, ...) \
-                 mdoc_verr((mdoc), (mdoc)->last->line, \
-                 (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
-
-#define        mdoc_msg(mdoc, fmt, ...) \
-                 mdoc_vmsg((mdoc), (mdoc)->last->line, \
-                 (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
-
-#define        mdoc_pmsg(mdoc, line, pos, fmt, ...) \
-                 mdoc_vmsg((mdoc), (line), \
-                 (pos), (fmt), ##__VA_ARGS__)
-
-#define        mdoc_pwarn(mdoc, line, pos, type, fmt, ...) \
-                 mdoc_vwarn((mdoc), (line), \
-                 (pos), (type), (fmt), ##__VA_ARGS__)
-
-#define        mdoc_perr(mdoc, line, pos, fmt, ...) \
-                 mdoc_verr((mdoc), (line), \
-                 (pos), (fmt), ##__VA_ARGS__)
-
 extern const struct mdoc_macro *const mdoc_macros;
 
 __BEGIN_DECLS
 
+/* 
+ * When GCC2 is deprecated, most of these can be reverted to #define
+ * as mdoc_vXXX using __VA_ARGS__.  Until then, use real functions.
+ */
 int              mdoc_vwarn(struct mdoc *, int, int, 
                        enum mdoc_warn, const char *, ...);
-void             mdoc_vmsg(struct mdoc *, int, int, 
-                       const char *, ...);
 int              mdoc_verr(struct mdoc *, int, int, 
                        const char *, ...);
+int              mdoc_nerr(struct mdoc *, const struct mdoc_node *,
+                       const char *, ...);
+int              mdoc_warn(struct mdoc *, enum mdoc_warn, const char *, ...);
+int              mdoc_err(struct mdoc *, const char *, ...);
+int              mdoc_pwarn(struct mdoc *, int, int,
+                       enum mdoc_warn,const char *, ...);
+int              mdoc_perr(struct mdoc *, int, int, const char *, ...);
 int              mdoc_macro(MACRO_PROT_ARGS);
 int              mdoc_word_alloc(struct mdoc *, 
                        int, int, const char *);
@@ -111,9 +87,9 @@ int            mdoc_tail_alloc(struct mdoc *, int, int, int);
 int              mdoc_body_alloc(struct mdoc *, int, int, int);
 void             mdoc_node_free(struct mdoc_node *);
 void             mdoc_node_freelist(struct mdoc_node *);
-void            *mdoc_tokhash_alloc(void);
-int              mdoc_tokhash_find(const void *, const char *);
-void             mdoc_tokhash_free(void *);
+void            *mdoc_hash_alloc(void);
+int              mdoc_hash_find(const void *, const char *);
+void             mdoc_hash_free(void *);
 int              mdoc_iscdelim(char);
 int              mdoc_isdelim(const char *);
 size_t           mdoc_isescape(const char *);
@@ -146,10 +122,6 @@ int                  mdoc_args(struct mdoc *, int,
 #define        ARGS_QWORD      (3)
 #define        ARGS_PHRASE     (4)
 
-/* FIXME: get rid of these. */
-int              xstrlcpys(char *, const struct mdoc_node *, size_t);
-void            *xrealloc(void *, size_t);
-char            *xstrdup(const char *);
 int              mdoc_macroend(struct mdoc *);
 
 __END_DECLS