]> git.cameronkatri.com Git - mandoc.git/blobdiff - libmdoc.h
Churn-ish check-in getting mdoc_parseln() and man_parseln() to accept a
[mandoc.git] / libmdoc.h
index 880d7ea5e7c431ffb88c52474b8b3481d0d3ce4c..e0d96a58e9a2e3545c309f0fe0f64f7935f25a86 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,6 @@
-/*     $Id: libmdoc.h,v 1.7 2009/06/10 20:18:43 kristaps Exp $ */
+/*     $Id: libmdoc.h,v 1.54 2010/06/26 15:36:37 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -17,6 +17,7 @@
 #ifndef LIBMDOC_H
 #define LIBMDOC_H
 
+#include "regs.h"
 #include "mdoc.h"
 
 enum   mdoc_next {
@@ -26,11 +27,15 @@ enum        mdoc_next {
 
 struct mdoc {
        void             *data;
-       struct mdoc_cb    cb;
-       void             *htab;
+       mandocmsg         msg;
        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 */
+#define        MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
+#define        MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
+#define        MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
+#define        MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
        int               pflags;
        enum mdoc_next    next;
        struct mdoc_node *last;
@@ -40,9 +45,8 @@ struct        mdoc {
        enum mdoc_sec     lastsec;
 };
 
-
-#define        MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
-                       int ppos, int *pos, char *buf
+#define        MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
+                       int line, int ppos, int *pos, char *buf
 
 struct mdoc_macro {
        int             (*fp)(MACRO_PROT_ARGS);
@@ -55,94 +59,82 @@ 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__)
+enum   margserr {
+       ARGS_ERROR,
+       ARGS_EOLN,
+       ARGS_WORD,
+       ARGS_PUNCT,
+       ARGS_QWORD,
+       ARGS_PHRASE,
+       ARGS_PPHRASE,
+       ARGS_PEND
+};
 
-#define        mdoc_pwarn(mdoc, line, pos, type, fmt, ...) \
-                 mdoc_vwarn((mdoc), (line), \
-                 (pos), (type), (fmt), ##__VA_ARGS__)
+enum   margverr {
+       ARGV_ERROR,
+       ARGV_EOLN,
+       ARGV_ARG,
+       ARGV_WORD
+};
 
-#define        mdoc_perr(mdoc, line, pos, fmt, ...) \
-                 mdoc_verr((mdoc), (line), \
-                 (pos), (fmt), ##__VA_ARGS__)
+enum   mdelim {
+       DELIM_NONE = 0,
+       DELIM_OPEN,
+       DELIM_MIDDLE,
+       DELIM_CLOSE
+};
 
 extern const struct mdoc_macro *const mdoc_macros;
 
 __BEGIN_DECLS
 
-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 *, ...);
+#define                  mdoc_pmsg(m, l, p, t) \
+                 (*(m)->msg)((t), (m)->data, (l), (p), NULL)
+#define                  mdoc_nmsg(m, n, t) \
+                 (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
+int              mdoc_vmsg(struct mdoc *, enum mandocerr
+                       int, int, const char *, ...);
 int              mdoc_macro(MACRO_PROT_ARGS);
 int              mdoc_word_alloc(struct mdoc *, 
                        int, int, const char *);
 int              mdoc_elem_alloc(struct mdoc *, int, int, 
-                       int, struct mdoc_arg *);
+                       enum mdoct, struct mdoc_arg *);
 int              mdoc_block_alloc(struct mdoc *, int, int, 
-                       int, struct mdoc_arg *);
-int              mdoc_head_alloc(struct mdoc *, int, int, int);
-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_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 *);
+                       enum mdoct, struct mdoc_arg *);
+int              mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
+int              mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
+int              mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
+void             mdoc_node_delete(struct mdoc *, struct mdoc_node *);
+void             mdoc_hash_init(void);
+enum mdoct       mdoc_hash_find(const char *);
+enum mdelim      mdoc_iscdelim(char);
+enum mdelim      mdoc_isdelim(const char *);
 size_t           mdoc_isescape(const char *);
-enum   mdoc_sec  mdoc_atosec(const char *);
+enum   mdoc_sec  mdoc_str2sec(const char *);
 time_t           mdoc_atotime(const char *);
-
-size_t           mdoc_macro2len(int);
+size_t           mdoc_macro2len(enum mdoct);
+const char      *mdoc_a2att(const char *);
+const char      *mdoc_a2lib(const char *);
+const char      *mdoc_a2st(const char *);
 const char      *mdoc_a2arch(const char *);
 const char      *mdoc_a2vol(const char *);
 const char      *mdoc_a2msec(const char *);
-int              mdoc_valid_pre(struct mdoc *, 
-                       const struct mdoc_node *);
+int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 int              mdoc_valid_post(struct mdoc *);
 int              mdoc_action_pre(struct mdoc *, 
-                       const struct mdoc_node *);
+                       struct mdoc_node *);
 int              mdoc_action_post(struct mdoc *);
-int              mdoc_argv(struct mdoc *, int, int,
+enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
                        struct mdoc_arg **, int *, char *);
-#define        ARGV_ERROR      (-1)
-#define        ARGV_EOLN       (0)
-#define        ARGV_ARG        (1)
-#define        ARGV_WORD       (2)
 void             mdoc_argv_free(struct mdoc_arg *);
-int              mdoc_args(struct mdoc *, int,
+void             mdoc_argn_free(struct mdoc_arg *, int);
+enum margserr    mdoc_args(struct mdoc *, int,
+                       int *, char *, enum mdoct, char **);
+enum margserr    mdoc_zargs(struct mdoc *, int, 
                        int *, char *, int, char **);
-#define        ARGS_ERROR      (-1)
-#define        ARGS_EOLN       (0)
-#define        ARGS_WORD       (1)
-#define        ARGS_PUNCT      (2)
-#define        ARGS_QWORD      (3)
-#define        ARGS_PHRASE     (4)
+#define        ARGS_DELIM      (1 << 1)
+#define        ARGS_TABSEP     (1 << 2)
+#define        ARGS_NOWARN     (1 << 3)
 
 int              mdoc_macroend(struct mdoc *);