Documentation, more validations, cleaned up actions, added Nm action.

[mandoc.git] / private.h

diff --git a/private.h b/private.h
index 3b5b4655a03dea6e8612235b03d631c037bf1317..02192565f4dc10ca79d940372112247ee09d36cc 100644 (file)
--- a/private.h
+++ b/private.h
@@ -1,4 +1,4 @@
-/* $Id: private.h,v 1.61 2009/01/09 14:45:44 kristaps Exp $ */
+/* $Id: private.h,v 1.67 2009/01/17 16:15:27 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -41,35 +41,67 @@ struct      mdoc {
 };
 
 
+/* FIXME: it's 9 (this isn't used properly). */
+
+#define        MDOC_LINEARG_MAX 12
+
 #define        MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
                        int ppos, int *pos, char *buf
 
 struct mdoc_macro {
-       int     (*fp)(MACRO_PROT_ARGS);
-       int       flags;
-#define        MDOC_CALLABLE   (1 << 0)
-#define        MDOC_PARSED     (1 << 1)
-#define        MDOC_EXPLICIT   (1 << 2)
-#define        MDOC_QUOTABLE   (1 << 3)
-#define        MDOC_PROLOGUE   (1 << 4)
-#define        MDOC_NESTED     (1 << 5)
+       int             (*fp)(MACRO_PROT_ARGS);
+       int               flags;
+#define        MDOC_CALLABLE    (1 << 0)
+#define        MDOC_PARSED      (1 << 1)
+#define        MDOC_EXPLICIT    (1 << 2)
+#define        MDOC_QUOTABLE    (1 << 3)
+#define        MDOC_PROLOGUE    (1 << 4)
+#define        MDOC_TABSEP      (1 << 5)
 };
 
+#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
 
-#define        mdoc_vwarn(m, n, t) \
-                 mdoc_pwarn((m), (n)->line, (n)->pos, (t))
-#define        mdoc_verr(m, n, t) \
-                 mdoc_perr((m), (n)->line, (n)->pos, (t))
-#define        mdoc_warn(m, t) \
-                 mdoc_pwarn((m), (m)->last->line, (m)->last->pos, (t))
-#define        mdoc_err(m, t) \
-                 mdoc_perr((m), (m)->last->line, (m)->last->pos, (t))
-int              mdoc_pwarn(struct mdoc *, int, int, enum mdoc_warn);
-int              mdoc_perr(struct mdoc *, int, int, enum mdoc_err);
-void             mdoc_msg(struct mdoc *, const char *, ...);
+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_macro(MACRO_PROT_ARGS);
 int              mdoc_find(const struct mdoc *, const char *);
 int              mdoc_word_alloc(struct mdoc *, 
@@ -90,13 +122,15 @@ int                  mdoc_tokhash_find(const void *, const char *);
 void             mdoc_tokhash_free(void *);
 int              mdoc_isdelim(const char *);
 int              mdoc_iscdelim(char);
-enum   mdoc_sec  mdoc_atosec(size_t, const char **);
+enum   mdoc_sec  mdoc_atosec(const char *);
 enum   mdoc_msec mdoc_atomsec(const char *);
 enum   mdoc_vol  mdoc_atovol(const char *);
 enum   mdoc_arch mdoc_atoarch(const char *);
 enum   mdoc_att  mdoc_atoatt(const char *);
 time_t           mdoc_atotime(const char *);
 
+char            *mdoc_type2a(enum mdoc_type);
+
 int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 int              mdoc_valid_post(struct mdoc *);
 int              mdoc_action_pre(struct mdoc *, struct mdoc_node *);
@@ -118,7 +152,9 @@ int           mdoc_args(struct mdoc *, int,
 
 #define        ARGS_QUOTED     (1 << 0)
 #define        ARGS_DELIM      (1 << 1)
+#define        ARGS_TABSEP     (1 << 2)
 
+int              xstrlcats(char *, const struct mdoc_node *, size_t);
 int              xstrlcat(char *, const char *, size_t);
 int              xstrlcpy(char *, const char *, size_t);
 int              xstrcmp(const char *, const char *);
@@ -131,7 +167,7 @@ int           macro_constant_scoped(MACRO_PROT_ARGS);
 int              macro_constant_delimited(MACRO_PROT_ARGS);
 int              macro_text(MACRO_PROT_ARGS);
 int              macro_scoped(MACRO_PROT_ARGS);
-int              macro_close_explicit(MACRO_PROT_ARGS);
+int              macro_scoped_close(MACRO_PROT_ARGS);
 int              macro_scoped_line(MACRO_PROT_ARGS);
 int              macro_prologue(MACRO_PROT_ARGS);
 int              macro_end(struct mdoc *);