Fill in more version notes.

[mandoc.git] / libmdoc.h

diff --git a/libmdoc.h b/libmdoc.h
index d383f7bae9c1942394656e4ba58390d5cb7c2151..92724e959cbc37a67a0f7efb6e7ddd5855a088d5 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,6 @@
-/*     $Id: libmdoc.h,v 1.51 2010/05/31 15:42:09 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,8 +25,8 @@ enum  mdoc_next {
 };
 
 struct mdoc {
 };
 
 struct mdoc {

-       void             *data;
-       mandocmsg         msg;
+       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 */
        int               flags;
 #define        MDOC_HALT        (1 << 0) /* error in parse: halt */
 #define        MDOC_LITERAL     (1 << 1) /* in a literal scope */


@@ -35,17 +35,23 @@ struct      mdoc {
 #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_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 */

 };
 
 };
 

-#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);


@@ -103,6 +109,9 @@ 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 *);


@@ -118,8 +127,7 @@ 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 *, 
                        struct mdoc_node *);
 int              mdoc_valid_post(struct mdoc *);
 int              mdoc_action_pre(struct mdoc *, 
                        struct mdoc_node *);