Added mail archive periodically generated by hypermail.

[mandoc.git] / mdoc.h

diff --git a/mdoc.h b/mdoc.h
index 2d2267a2c07d677435749d99074e9cfdab2fd484..80390dd0efb019a465e96494f9c4d0f0c2be1c52 100644 (file)
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,6 +1,6 @@
-/*     $Id: mdoc.h,v 1.77 2010/05/12 16:01:01 kristaps Exp $ */
+/*     $Id: mdoc.h,v 1.102 2010/07/21 09:08:26 kristaps 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


@@ -149,39 +149,42 @@ enum      mdoct {
        MDOC_br,
        MDOC_sp,
        MDOC__U,
        MDOC_br,
        MDOC_sp,
        MDOC__U,

+       MDOC_Ta,

        MDOC_MAX
 };
 
 /* What follows is a list of ALL possible macro arguments. */
 
        MDOC_MAX
 };
 
 /* What follows is a list of ALL possible macro arguments. */
 

-#define        MDOC_Split       0
-#define        MDOC_Nosplit     1
-#define        MDOC_Ragged      2
-#define        MDOC_Unfilled    3
-#define        MDOC_Literal     4
-#define        MDOC_File        5
-#define        MDOC_Offset      6
-#define        MDOC_Bullet      7
-#define        MDOC_Dash        8
-#define        MDOC_Hyphen      9
-#define        MDOC_Item        10
-#define        MDOC_Enum        11
-#define        MDOC_Tag         12
-#define        MDOC_Diag        13
-#define        MDOC_Hang        14
-#define        MDOC_Ohang       15
-#define        MDOC_Inset       16
-#define        MDOC_Column      17
-#define        MDOC_Width       18
-#define        MDOC_Compact     19
-#define        MDOC_Std         20
-#define        MDOC_Filled      21
-#define        MDOC_Words       22
-#define        MDOC_Emphasis    23
-#define        MDOC_Symbolic    24
-#define        MDOC_Nested      25
-#define        MDOC_Centred     26
-#define        MDOC_ARG_MAX     27
+enum   mdocargt {
+       MDOC_Split,
+       MDOC_Nosplit,
+       MDOC_Ragged,
+       MDOC_Unfilled,
+       MDOC_Literal,
+       MDOC_File,
+       MDOC_Offset,
+       MDOC_Bullet,
+       MDOC_Dash,
+       MDOC_Hyphen,
+       MDOC_Item,
+       MDOC_Enum,
+       MDOC_Tag,
+       MDOC_Diag,
+       MDOC_Hang,
+       MDOC_Ohang,
+       MDOC_Inset,
+       MDOC_Column,
+       MDOC_Width,
+       MDOC_Compact,
+       MDOC_Std,
+       MDOC_Filled,
+       MDOC_Words,
+       MDOC_Emphasis,
+       MDOC_Symbolic,
+       MDOC_Nested,
+       MDOC_Centred,
+       MDOC_ARG_MAX
+};

 
 /* Type of a syntax node. */
 enum   mdoc_type {
 
 /* Type of a syntax node. */
 enum   mdoc_type {


@@ -223,7 +226,7 @@ enum        mdoc_sec {
 
 /* Information from prologue. */
 struct mdoc_meta {
 
 /* Information from prologue. */
 struct mdoc_meta {

-       int               msec;
+       char             *msec;

        char             *vol;
        char             *arch;
        time_t            date;
        char             *vol;
        char             *arch;
        time_t            date;


@@ -234,7 +237,7 @@ struct      mdoc_meta {
 
 /* An argument to a macro (multiple values = `It -column'). */
 struct mdoc_argv {
 
 /* An argument to a macro (multiple values = `It -column'). */
 struct mdoc_argv {

-       int               arg;
+       enum mdocargt     arg;

        int               line;
        int               pos;
        size_t            sz;
        int               line;
        int               pos;
        size_t            sz;


@@ -247,44 +250,112 @@ struct   mdoc_arg {
        unsigned int      refcnt;
 };
 
        unsigned int      refcnt;
 };
 

+enum   mdoc_endbody {
+       ENDBODY_NOT = 0,
+       ENDBODY_SPACE,
+       ENDBODY_NOSPACE
+};
+
+enum   mdoc_list {
+       LIST__NONE = 0,
+       LIST_bullet,
+       LIST_column,
+       LIST_dash,
+       LIST_diag,
+       LIST_enum,
+       LIST_hang,
+       LIST_hyphen,
+       LIST_inset,
+       LIST_item,
+       LIST_ohang,
+       LIST_tag
+};
+
+enum   mdoc_disp {
+       DISP__NONE = 0,
+       DISP_centred,
+       DISP_ragged,
+       DISP_unfilled,
+       DISP_filled,
+       DISP_literal
+};
+
+enum   mdoc_auth {
+       AUTH__NONE = 0,
+       AUTH_split,
+       AUTH_nosplit
+};
+
+enum   mdoc_font {
+       FONT__NONE = 0,
+       FONT_Em,
+       FONT_Li,
+       FONT_Sy
+};
+
+struct mdoc_bd {
+       const char       *offs; /* -offset */
+       enum mdoc_disp    type; /* -ragged, etc. */
+       int               comp; /* -compact */
+};
+
+struct mdoc_bl {
+       const char       *width; /* -width */
+       const char       *offs; /* -offset */
+       enum mdoc_list    type; /* -tag, -enum, etc. */
+       int               comp; /* -compact */
+       size_t            ncols; /* -column arg count */
+       const char      **cols; /* -column val ptr */
+};
+
+struct mdoc_bf {
+       enum mdoc_font    font; /* font */
+};
+
+struct mdoc_an {
+       enum mdoc_auth    auth; /* -split, etc. */
+};
+

 /* Node in AST. */
 struct mdoc_node {
 /* Node in AST. */
 struct mdoc_node {

-       struct mdoc_node *parent;
-       struct mdoc_node *child;
-       struct mdoc_node *next;
-       struct mdoc_node *prev;
-       int               nchild;
-       int               line;
-       int               pos;
-       enum mdoct        tok;
+       struct mdoc_node *parent; /* parent AST node */
+       struct mdoc_node *child; /* first child AST node */
+       struct mdoc_node *next; /* sibling AST node */
+       struct mdoc_node *prev; /* prior sibling AST node */
+       int               nchild; /* number children */
+       int               line; /* parse line */
+       int               pos; /* parse column */
+       enum mdoct        tok; /* tok or MDOC__MAX if none */

        int               flags;
        int               flags;

-#define        MDOC_VALID       (1 << 0)
-#define        MDOC_ACTED       (1 << 1)
-#define        MDOC_EOS         (1 << 2)
-       enum mdoc_type    type;
-       enum mdoc_sec     sec;
-
+#define        MDOC_VALID       (1 << 0) /* has been validated */
+#define        MDOC_ACTED       (1 << 1) /* has been acted upon */
+#define        MDOC_EOS         (1 << 2) /* at sentence boundary */
+#define        MDOC_LINE        (1 << 3) /* first macro/text on line */
+#define        MDOC_SYNPRETTY   (1 << 4) /* SYNOPSIS-style formatting */
+#define        MDOC_ENDED       (1 << 5) /* rendering has been ended */
+       enum mdoc_type    type; /* AST node type */
+       enum mdoc_sec     sec; /* current named section */
+       /* FIXME: these can be union'd to shave a few bytes. */

        struct mdoc_arg  *args;         /* BLOCK/ELEM */
        struct mdoc_arg  *args;         /* BLOCK/ELEM */

-#ifdef UGLY

        struct mdoc_node *pending;      /* BLOCK */
        struct mdoc_node *pending;      /* BLOCK */

-#endif

        struct mdoc_node *head;         /* BLOCK */
        struct mdoc_node *body;         /* BLOCK */
        struct mdoc_node *tail;         /* BLOCK */
        char             *string;       /* TEXT */
        struct mdoc_node *head;         /* BLOCK */
        struct mdoc_node *body;         /* BLOCK */
        struct mdoc_node *tail;         /* BLOCK */
        char             *string;       /* TEXT */

+       enum mdoc_endbody end;          /* BODY */
+
+       union {
+               struct mdoc_an  An;
+               struct mdoc_bd *Bd;
+               struct mdoc_bf *Bf;
+               struct mdoc_bl *Bl;
+       } data;

 };
 
 #define        MDOC_IGN_SCOPE   (1 << 0) /* Ignore scope violations. */
 #define        MDOC_IGN_ESCAPE  (1 << 1) /* Ignore bad escape sequences. */
 #define        MDOC_IGN_MACRO   (1 << 2) /* Ignore unknown macros. */
 
 };
 
 #define        MDOC_IGN_SCOPE   (1 << 0) /* Ignore scope violations. */
 #define        MDOC_IGN_ESCAPE  (1 << 1) /* Ignore bad escape sequences. */
 #define        MDOC_IGN_MACRO   (1 << 2) /* Ignore unknown macros. */
 

-/* Call-backs for parse messages. */
-
-struct mdoc_cb {
-       int     (*mdoc_err)(void *, int, int, const char *);
-       int     (*mdoc_warn)(void *, int, int, const char *);
-};
-

 /* See mdoc.3 for documentation. */
 
 extern const char *const *mdoc_macronames;
 /* See mdoc.3 for documentation. */
 
 extern const char *const *mdoc_macronames;


@@ -297,9 +368,9 @@ struct      mdoc;
 /* See mdoc.3 for documentation. */
 
 void             mdoc_free(struct mdoc *);
 /* See mdoc.3 for documentation. */
 
 void             mdoc_free(struct mdoc *);

-struct mdoc     *mdoc_alloc(void *, int, const struct mdoc_cb *);
+struct mdoc     *mdoc_alloc(struct regset *, void *, int, mandocmsg);

 void             mdoc_reset(struct mdoc *);
 void             mdoc_reset(struct mdoc *);

-int              mdoc_parseln(struct mdoc *, int, char *buf);
+int              mdoc_parseln(struct mdoc *, int, char *, int);

 const struct mdoc_node *mdoc_node(const struct mdoc *);
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);
 int              mdoc_endparse(struct mdoc *);
 const struct mdoc_node *mdoc_node(const struct mdoc *);
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);
 int              mdoc_endparse(struct mdoc *);