OpenBSD src/sbin was used as a tool to hunt bugs in mandoc.

[mandoc.git] / libmdoc.h

diff --git a/libmdoc.h b/libmdoc.h
index 095eb5ed633440b5c37a7e1ede2c2245793b8ee2..92724e959cbc37a67a0f7efb6e7ddd5855a088d5 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,6 @@
-/*     $Id: libmdoc.h,v 1.43 2010/05/14 12:55:22 kristaps Exp $ */
+/*     $Id: libmdoc.h,v 1.61 2010/07/13 23:53:20 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -25,82 +25,33 @@ enum        mdoc_next {
 };
 
 struct mdoc {
 };
 
 struct mdoc {

-       void             *data;
-       struct mdoc_cb    cb;
+       void             *data; /* private application data */
+       mandocmsg         msg; /* message callback */

        int               flags;
 #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 */
        int               flags;
 #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) /* in a literal within a phrase */
+#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 */
+#define        MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */

        int               pflags;
        int               pflags;

-       enum mdoc_next    next;
-       struct mdoc_node *last;
-       struct mdoc_node *first;
-       struct mdoc_meta  meta;
+       enum mdoc_next    next; /* where to put the next node */
+       struct mdoc_node *last; /* the last node parsed */
+       struct mdoc_node *first; /* the first node parsed */
+       struct mdoc_meta  meta; /* document meta-data */

        enum mdoc_sec     lastnamed;
        enum mdoc_sec     lastsec;
        enum mdoc_sec     lastnamed;
        enum mdoc_sec     lastsec;

+       struct regset    *regs; /* registers */

 };
 
 };
 

-enum   merr {
-       ETAILWS = 0,
-       EQUOTPARM,
-       EQUOTTERM,
-       EARGVAL,        
-       EBODYPROL,
-       EPROLBODY,
-       ETEXTPROL,
-       ENOBLANK,
-       ETOOLONG,
-       EESCAPE,
-       EPRINT,
-       ENODAT,
-       ENOPROLOGUE,
-       ELINE,
-       EATT,
-       ENAME,
-       ELISTTYPE,
-       EDISPTYPE,
-       EMULTIDISP,
-       EMULTILIST,
-       ESECNAME,
-       ENAMESECINC,
-       EARGREP,
-       EBOOL,
-       ECOLMIS,
-       ENESTDISP,
-       EMISSWIDTH,
-       EWRONGMSEC,
-       ESECOOO,
-       ESECREP,
-       EBADSTAND,
-       ENOMULTILINE,
-       EMULTILINE,
-       ENOLINE,
-       EPROLOOO,
-       EPROLREP,
-       EBADMSEC,
-       EBADSEC,
-       EFONT,
-       EBADDATE,
-       ENUMFMT,
-       ENOWIDTH,
-       EUTSNAME,
-       EOBS,
-       EIMPBRK,
-       EIGNE,
-       EOPEN,
-       EQUOTPHR,
-       ENOCTX,
-       ELIB,
-       EBADCHILD,
-       ENOTYPE,
-       EBADCOMMENT,
-       MERRMAX
-};
-
-#define        MACRO_PROT_ARGS struct mdoc *m, enum mdoct 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);
 
 struct mdoc_macro {
        int             (*fp)(MACRO_PROT_ARGS);


@@ -131,23 +82,23 @@ enum       margverr {
        ARGV_WORD
 };
 
        ARGV_WORD
 };
 

+enum   mdelim {
+       DELIM_NONE = 0,
+       DELIM_OPEN,
+       DELIM_MIDDLE,
+       DELIM_CLOSE
+};
+

 extern const struct mdoc_macro *const mdoc_macros;
 
 __BEGIN_DECLS
 
 extern const struct mdoc_macro *const mdoc_macros;
 
 __BEGIN_DECLS
 

-#define                  mdoc_perr(m, l, p, t) \
-                 mdoc_err((m), (l), (p), 1, (t))
-#define                  mdoc_pwarn(m, l, p, t) \
-                 mdoc_err((m), (l), (p), 0, (t))
-#define                  mdoc_nerr(m, n, t) \
-                 mdoc_err((m), (n)->line, (n)->pos, 1, (t))
-#define                  mdoc_nwarn(m, n, t) \
-                 mdoc_err((m), (n)->line, (n)->pos, 0, (t))
-
-int              mdoc_err(struct mdoc *, int, int, int, enum merr);
-int              mdoc_verr(struct mdoc *, int, int, const char *, ...);
-int              mdoc_vwarn(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_macro(MACRO_PROT_ARGS);
 int              mdoc_word_alloc(struct mdoc *, 
                        int, int, const char *);


@@ -158,11 +109,14 @@ int                 mdoc_block_alloc(struct mdoc *, int, int,
 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);
 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);

+int              mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
+                       enum mdoct tok, struct mdoc_node *body,
+                       enum mdoc_endbody end);

 void             mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 void             mdoc_hash_init(void);
 enum mdoct       mdoc_hash_find(const char *);
 void             mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 void             mdoc_hash_init(void);
 enum mdoct       mdoc_hash_find(const char *);

-int              mdoc_iscdelim(char);
-int              mdoc_isdelim(const char *);
+enum mdelim      mdoc_iscdelim(char);
+enum mdelim      mdoc_isdelim(const char *);

 size_t           mdoc_isescape(const char *);
 enum   mdoc_sec  mdoc_str2sec(const char *);
 time_t           mdoc_atotime(const char *);
 size_t           mdoc_isescape(const char *);
 enum   mdoc_sec  mdoc_str2sec(const char *);
 time_t           mdoc_atotime(const char *);


@@ -173,11 +127,10 @@ const char         *mdoc_a2st(const char *);
 const char      *mdoc_a2arch(const char *);
 const char      *mdoc_a2vol(const char *);
 const char      *mdoc_a2msec(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 *, 
 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 *);
 enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
                        struct mdoc_arg **, int *, char *);
 int              mdoc_action_post(struct mdoc *);
 enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
                        struct mdoc_arg **, int *, char *);


@@ -190,7 +143,6 @@ enum margserr         mdoc_zargs(struct mdoc *, int,
 #define        ARGS_DELIM      (1 << 1)
 #define        ARGS_TABSEP     (1 << 2)
 #define        ARGS_NOWARN     (1 << 3)
 #define        ARGS_DELIM      (1 << 1)
 #define        ARGS_TABSEP     (1 << 2)
 #define        ARGS_NOWARN     (1 << 3)

-#define ARGS_PPHRASED  (1 << 4)

 
 int              mdoc_macroend(struct mdoc *);
 
 
 int              mdoc_macroend(struct mdoc *);