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

[mandoc.git] / private.h

diff --git a/private.h b/private.h
index eaa9c6f27e55366401170f8e0748b7f8134c8000..02192565f4dc10ca79d940372112247ee09d36cc 100644 (file)
--- a/private.h
+++ b/private.h
@@ -1,4 +1,4 @@
-/* $Id: private.h,v 1.6 2008/11/25 12:14:02 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,137 +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;

 };
 
 };
 

-#define        ROFF___          0
-#define        ROFF_Dd          1
-#define        ROFF_Dt          2
-#define        ROFF_Os          3
-#define        ROFF_Sh          4
-#define        ROFF_Ss          5
-#define        ROFF_Pp          6
-#define        ROFF_D1          7
-#define        ROFF_Dl          8
-#define        ROFF_Bd          9
-#define        ROFF_Ed          10
-#define        ROFF_Bl          11
-#define        ROFF_El          12
-#define        ROFF_It          13
-#define        ROFF_An          14
-#define        ROFF_Li          15
-#define        ROFF_MAX         16
-
-#define        ROFF_NAMES                      \
-       {                               \
-       "\\\"",                         \
-       "Dd",                           \
-       "Dt",                           \
-       "Os",                           \
-       "Sh",                           \
-       "Ss",                           \
-       "Pp",                           \
-       "D1",                           \
-       "Dl",                           \
-       "Bd",                           \
-       "Ed",                           \
-       "Bl",                           \
-       "El",                           \
-       "It",                           \
-       "An",                           \
-       "Li",                           \
-       }
-
-#define        ROFF_Split       0
-#define        ROFF_Nosplit     1
-#define        ROFF_Ragged      2
-#define        ROFF_Unfilled    3
-#define        ROFF_Literal     4
-#define        ROFF_File        5
-#define        ROFF_Offset      6
-#define        ROFF_Bullet      7
-#define        ROFF_Dash        8
-#define        ROFF_Hyphen      9
-#define        ROFF_Item        10
-#define        ROFF_Enum        11
-#define        ROFF_Tag         12
-#define        ROFF_Diag        13
-#define        ROFF_Hang        14
-#define        ROFF_Ohang       15
-#define        ROFF_Inset       16
-#define        ROFF_Column      17
-#define        ROFF_ARGMAX      18
-
-#define        ROFF_ARGNAMES                   \
-       {                               \
-       "split",                        \
-       "nosplit",                      \
-       "ragged",                       \
-       "unfilled",                     \
-       "literal",                      \
-       "file",                         \
-       "offset",                       \
-       "bullet",                       \
-       "dash",                         \
-       "hyphen",                       \
-       "item",                         \
-       "enum",                         \
-       "tag",                          \
-       "diag",                         \
-       "hang",                         \
-       "ohang",                        \
-       "inset",                        \
-       "column",                       \
-       }
-
-/* FIXME: have a md_roff with all necessary parameters. */
-
-typedef        int     (*roffin)(int, int *, char **);
-typedef        int     (*roffout)(int);
-typedef        int     (*roffblkin)(int);
-typedef        int     (*roffblkout)(int);

 
 

-__BEGIN_DECLS
+/* 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)
+};

 
 

-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);
+#define        mdoc_nwarn(mdoc, node, type, fmt, ...) \
+                 mdoc_vwarn((mdoc), (node)->line, \
+                 (node)->pos, (type), (fmt), ##__VA_ARGS__)

 
 

-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);
+#define        mdoc_nerr(mdoc, node, fmt, ...) \
+                 mdoc_verr((mdoc), (node)->line, \
+                 (node)->pos, (fmt), ##__VA_ARGS__)

 
 

-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);
+#define        mdoc_warn(mdoc, type, fmt, ...) \
+                 mdoc_vwarn((mdoc), (mdoc)->last->line, \
+                 (mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__)

 
 

-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        mdoc_err(mdoc, fmt, ...) \
+                 mdoc_verr((mdoc), (mdoc)->last->line, \
+                 (mdoc)->last->pos, (fmt), ##__VA_ARGS__)

 
 

-struct rofftree;
+#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

 
 

-struct rofftree *roff_alloc(const struct md_args *, 
-                       struct md_mbuf *, const struct md_rbuf *,
-                       roffin, roffout, roffblkin, roffblkout);
-int              roff_engine(struct rofftree *, char *, size_t);
-int              roff_free(struct rofftree *, 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);
+
+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 *);
+
+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)
+
+#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 *);
+void            *xcalloc(size_t, size_t);
+char            *xstrdup(const char *);
+
+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