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

[mandoc.git] / private.h

diff --git a/private.h b/private.h
index 72aabe4822ed6d1004f61df72dd0a361b2bdfc4a..02192565f4dc10ca79d940372112247ee09d36cc 100644 (file)
--- a/private.h
+++ b/private.h
@@ -1,4 +1,4 @@
-/* $Id: private.h,v 1.4 2008/11/24 14:24:55 kristaps Exp $ */
+/* $Id: private.h,v 1.67 2009/01/17 16:15:27 kristaps Exp $ */

 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -19,49 +19,158 @@
 #ifndef PRIVATE_H
 #define PRIVATE_H
 
 #ifndef PRIVATE_H
 #define PRIVATE_H
 

-struct md_rbuf {
-       int              fd;
-       char            *name;
-       char            *buf;
-       size_t           bufsz;
-       size_t           line;
+#include "mdoc.h"
+
+enum   mdoc_next {
+       MDOC_NEXT_SIBLING = 0,
+       MDOC_NEXT_CHILD

 };
 
 };
 

-struct md_mbuf {
-       int              fd;
-       char            *name;
-       char            *buf;
-       size_t           bufsz;
-       size_t           pos;
+struct mdoc {
+       void             *data;
+       struct mdoc_cb    cb;
+       void             *htab;
+       int               flags;
+#define        MDOC_HALT        (1 << 0)
+       enum mdoc_next    next;
+       struct mdoc_node *last;
+       struct mdoc_node *first;
+       struct mdoc_meta  meta;
+       enum mdoc_sec     sec_lastn;
+       enum mdoc_sec     sec_last;

 };
 
 };
 

+
+/* 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_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
 
 __BEGIN_DECLS
 

-typedef        void  (*(*md_init)(const struct md_args *, 
-                       struct md_mbuf *, const struct md_rbuf *));
-typedef        int     (*md_line)(void *, char *, size_t);
-typedef        int     (*md_exit)(void *, int);
+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 *, 
+                       int, int, const char *);
+int              mdoc_elem_alloc(struct mdoc *, int, int, 
+                       int, size_t, const struct mdoc_arg *);
+int              mdoc_block_alloc(struct mdoc *, int, int, 
+                       int, size_t, const struct mdoc_arg *);
+int              mdoc_root_alloc(struct mdoc *);
+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_sibling(struct mdoc *, int, struct mdoc_node **,
+                       struct mdoc_node **, struct mdoc_node *);
+void            *mdoc_tokhash_alloc(void);
+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(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);

 
 

-void            *md_init_html4_strict(const struct md_args *,
-                       struct md_mbuf *, const struct md_rbuf *);
-int              md_line_html4_strict(void *, char *, size_t);
-int              md_exit_html4_strict(void *, int);
+int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
+int              mdoc_valid_post(struct mdoc *);
+int              mdoc_action_pre(struct mdoc *, struct mdoc_node *);
+int              mdoc_action_post(struct mdoc *);

 
 

-void            *md_init_dummy(const struct md_args *,
-                       struct md_mbuf *, const struct md_rbuf *);
-int              md_line_dummy(void *, char *, size_t);
-int              md_exit_dummy(void *, int);
+int              mdoc_argv(struct mdoc *, int, int, 
+                       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(int, struct mdoc_arg *);
+int              mdoc_args(struct mdoc *, int,
+                       int *, char *, int, char **);
+#define        ARGS_ERROR      (-1)
+#define        ARGS_EOLN       (0)
+#define        ARGS_WORD       (1)
+#define        ARGS_PUNCT      (2)

 
 

-int              md_buf_puts(struct md_mbuf *, const char *, size_t);
-int              md_buf_putchar(struct md_mbuf *, char);
-int              md_buf_putstring(struct md_mbuf *, const char *);
+#define        ARGS_QUOTED     (1 << 0)
+#define        ARGS_DELIM      (1 << 1)
+#define        ARGS_TABSEP     (1 << 2)

 
 

-struct rofftree;
+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 *);
+void            *xcalloc(size_t, size_t);
+char            *xstrdup(const char *);

 
 

-struct rofftree *roff_alloc(const struct md_args *, 
-                       struct md_mbuf *, const struct md_rbuf *);
-int              roff_engine(struct rofftree *, char *, size_t);
-int              roff_free(struct rofftree *, int);
+int              macro_obsolete(MACRO_PROT_ARGS);
+int              macro_constant(MACRO_PROT_ARGS);
+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_scoped_close(MACRO_PROT_ARGS);
+int              macro_scoped_line(MACRO_PROT_ARGS);
+int              macro_prologue(MACRO_PROT_ARGS);
+int              macro_end(struct mdoc *);

 
 __END_DECLS
 
 
 __END_DECLS