Split the document parsing sequence out of main.c and into read.c,

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 75d8f1d36d6ee722eae55717272123c285541027..cb7935435727f492c7f1245e20032e8b0d1e8d11 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: mandoc.h,v 1.47 2011/01/04 12:06:21 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.62 2011/03/20 11:41:24 kristaps Exp $ */

 /*
  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
 /*
  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *


@@ -50,7 +50,8 @@ enum  mandocerr {
        MANDOCERR_NOTITLE, /* no title in document */
        MANDOCERR_UPPERCASE, /* document title should be all caps */
        MANDOCERR_BADMSEC, /* unknown manual section */
        MANDOCERR_NOTITLE, /* no title in document */
        MANDOCERR_UPPERCASE, /* document title should be all caps */
        MANDOCERR_BADMSEC, /* unknown manual section */

-       MANDOCERR_BADDATE, /* cannot parse date argument */
+       MANDOCERR_NODATE, /* date missing, using today's date */
+       MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */

        MANDOCERR_PROLOGOOO, /* prologue macros out of order */
        MANDOCERR_PROLOGREP, /* duplicate prologue macro */
        MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
        MANDOCERR_PROLOGOOO, /* prologue macros out of order */
        MANDOCERR_PROLOGREP, /* duplicate prologue macro */
        MANDOCERR_BADPROLOG, /* macro not allowed in prologue */


@@ -68,6 +69,7 @@ enum  mandocerr {
        /* related to macros and nesting */
        MANDOCERR_MACROOBS, /* skipping obsolete macro */
        MANDOCERR_IGNPAR, /* skipping paragraph macro */
        /* related to macros and nesting */
        MANDOCERR_MACROOBS, /* skipping obsolete macro */
        MANDOCERR_IGNPAR, /* skipping paragraph macro */

+       MANDOCERR_IGNNS, /* skipping no-space macro */

        MANDOCERR_SCOPENEST, /* blocks badly nested */
        MANDOCERR_CHILD, /* child violates parent syntax */
        MANDOCERR_NESTEDDISP, /* nested displays are not portable */
        MANDOCERR_SCOPENEST, /* blocks badly nested */
        MANDOCERR_CHILD, /* child violates parent syntax */
        MANDOCERR_NESTEDDISP, /* nested displays are not portable */


@@ -80,6 +82,7 @@ enum  mandocerr {
        MANDOCERR_LISTFIRST, /* list type must come first */
        MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
        MANDOCERR_FONTTYPE, /* missing font type */
        MANDOCERR_LISTFIRST, /* list type must come first */
        MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
        MANDOCERR_FONTTYPE, /* missing font type */

+       MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */

 
        /* related to bad macro arguments */
        MANDOCERR_IGNARGV, /* skipping argument */
 
        /* related to bad macro arguments */
        MANDOCERR_IGNARGV, /* skipping argument */


@@ -100,9 +103,6 @@ enum        mandocerr {
        MANDOCERR_BADESCAPE, /* unknown escape sequence */
        MANDOCERR_BADQUOTE, /* unterminated quoted string */
 
        MANDOCERR_BADESCAPE, /* unknown escape sequence */
        MANDOCERR_BADQUOTE, /* unterminated quoted string */
 

-       /* related to tables */
-       MANDOCERR_TBLEXTRADAT, /* extra data cells */
-

        MANDOCERR_ERROR, /* ===== start of errors ===== */
 
        /* related to tables */
        MANDOCERR_ERROR, /* ===== start of errors ===== */
 
        /* related to tables */


@@ -112,9 +112,12 @@ enum       mandocerr {
        MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
        MANDOCERR_TBLNODATA, /* no table data cells specified */
        MANDOCERR_TBLIGNDATA, /* ignore data in cell */
        MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
        MANDOCERR_TBLNODATA, /* no table data cells specified */
        MANDOCERR_TBLIGNDATA, /* ignore data in cell */

+       MANDOCERR_TBLBLOCK, /* data block still open */
+       MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */

 
        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
        MANDOCERR_BADCHAR, /* skipping bad character */
 
        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
        MANDOCERR_BADCHAR, /* skipping bad character */

+       MANDOCERR_NAMESC, /* escaped character not allowed in a name */

        MANDOCERR_NOTEXT, /* skipping text before the first section header */
        MANDOCERR_MACRO, /* skipping unknown macro */
        MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
        MANDOCERR_NOTEXT, /* skipping text before the first section header */
        MANDOCERR_MACRO, /* skipping unknown macro */
        MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */


@@ -151,7 +154,6 @@ struct      tbl {
        char              tab; /* cell-separator */
        char              decimal; /* decimal point */
        int               linesize;
        char              tab; /* cell-separator */
        char              decimal; /* decimal point */
        int               linesize;

-       char              delims[2]; /* FIXME: deprecate */

        int               opts;
 #define        TBL_OPT_CENTRE   (1 << 0)
 #define        TBL_OPT_EXPAND   (1 << 1)
        int               opts;
 #define        TBL_OPT_CENTRE   (1 << 0)
 #define        TBL_OPT_EXPAND   (1 << 1)


@@ -202,7 +204,7 @@ enum        tbl_cellt {
 struct tbl_cell {
        struct tbl_cell  *next;
        enum tbl_cellt    pos;
 struct tbl_cell {
        struct tbl_cell  *next;
        enum tbl_cellt    pos;

-       int               spacing;
+       size_t            spacing;

        int               flags;
 #define        TBL_CELL_TALIGN  (1 << 0) /* t, T */
 #define        TBL_CELL_BALIGN  (1 << 1) /* d, D */
        int               flags;
 #define        TBL_CELL_TALIGN  (1 << 0) /* t, T */
 #define        TBL_CELL_BALIGN  (1 << 1) /* d, D */


@@ -224,11 +226,12 @@ struct    tbl_row {
 };
 
 enum   tbl_datt {
 };
 
 enum   tbl_datt {

-       TBL_DATA_DATA,
-       TBL_DATA_HORIZ,
-       TBL_DATA_DHORIZ,
-       TBL_DATA_NHORIZ,
-       TBL_DATA_NDHORIZ
+       TBL_DATA_NONE, /* has no data */
+       TBL_DATA_DATA, /* consists of data/string */
+       TBL_DATA_HORIZ, /* horizontal line */
+       TBL_DATA_DHORIZ, /* double-horizontal line */
+       TBL_DATA_NHORIZ, /* squeezed horizontal line */
+       TBL_DATA_NDHORIZ /* squeezed double-horizontal line */

 };
 
 /*
 };
 
 /*


@@ -236,9 +239,10 @@ enum       tbl_datt {
  * string value that's in the cell.  The rest is layout.
  */
 struct tbl_dat {
  * string value that's in the cell.  The rest is layout.
  */
 struct tbl_dat {

-       struct tbl_cell  *layout; /* layout cell: CAN BE NULL */
+       struct tbl_cell  *layout; /* layout cell */
+       int               spans; /* how many spans follow */

        struct tbl_dat   *next;
        struct tbl_dat   *next;

-       char             *string;
+       char             *string; /* data (NULL if not TBL_DATA_DATA) */

        enum tbl_datt     pos;
 };
 
        enum tbl_datt     pos;
 };
 


@@ -254,9 +258,10 @@ enum       tbl_spant {
 struct tbl_span {
        struct tbl       *tbl;
        struct tbl_head  *head;
 struct tbl_span {
        struct tbl       *tbl;
        struct tbl_head  *head;

-       struct tbl_row   *layout; /* layout row: CAN BE NULL */
+       struct tbl_row   *layout; /* layout row */

        struct tbl_dat   *first;
        struct tbl_dat   *last;
        struct tbl_dat   *first;
        struct tbl_dat   *last;

+       int               line; /* parse line */

        int               flags;
 #define        TBL_SPAN_FIRST   (1 << 0)
 #define        TBL_SPAN_LAST    (1 << 1)
        int               flags;
 #define        TBL_SPAN_FIRST   (1 << 0)
 #define        TBL_SPAN_LAST    (1 << 1)


@@ -264,6 +269,13 @@ struct     tbl_span {
        struct tbl_span  *next;
 };
 
        struct tbl_span  *next;
 };
 

+struct eqn {
+       size_t            sz;
+       char             *data;
+       int               line; /* invocation line */
+       int               pos; /* invocation position */
+};
+

 /*
  * Available registers (set in libroff, accessed elsewhere).
  */
 /*
  * Available registers (set in libroff, accessed elsewhere).
  */


@@ -300,14 +312,57 @@ struct    regset {
        struct reg        regs[REG__MAX];
 };
 
        struct reg        regs[REG__MAX];
 };
 

-__BEGIN_DECLS
+/*
+ * A punctuation delimiter, used only in mdoc(7) documents, is opening,
+ * closing, or "middle mark" punctuation.  These govern spacing.
+ * Opening punctuation (e.g., the opening parenthesis) suppresses the
+ * following space; closing punctuation (e.g., the closing parenthesis)
+ * suppresses the leading space; middle punctuation (e.g., the vertical
+ * bar) can do either.  The middle punctuation delimiter bends the rules
+ * depending on usage.
+ */
+enum   mdelim {
+       DELIM_NONE = 0,
+       DELIM_OPEN,
+       DELIM_MIDDLE,
+       DELIM_CLOSE
+};

 
 /*
 
 /*

- * Callback function for warnings, errors, and fatal errors as they
- * occur in the compilers libroff, libmdoc, and libman.
+ * The type of parse sequence.  This value is usually passed via the
+ * mandoc(1) command line of -man and -mdoc.  It's almost exclusively
+ * -mandoc but the others have been retained for compatibility.

  */
  */

-typedef        int             (*mandocmsg)(enum mandocerr, void *,
-                               int, int, const char *);
+enum   mparset {
+       MPARSE_AUTO, /* magically determine the document type */
+       MPARSE_MDOC, /* assume -mdoc */
+       MPARSE_MAN /* assume -man */
+};
+
+typedef        void    (*mandocmsg)(enum mandocerr, void *,
+                       int, int, const char *);
+typedef        int     (*mevt_open)(void *, const char *);
+typedef        void    (*mevt_close)(void *, const char *);
+
+struct mparse;
+struct mdoc;
+struct man;
+
+__BEGIN_DECLS
+
+void             mparse_free(struct mparse *);
+void             mparse_reset(struct mparse *);
+struct mparse   *mparse_alloc(enum mparset, mevt_open, 
+                       mevt_close, mandocmsg, void *);
+void             mparse_setstatus(struct mparse *, enum mandoclevel);
+enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
+void             mparse_result(struct mparse *, struct mdoc **, struct man **);
+
+void            *mandoc_calloc(size_t, size_t);
+void            *mandoc_malloc(size_t);
+void            *mandoc_realloc(void *, size_t);
+#define        DELIMSZ   6 /* hint: max possible size of a delimiter */
+enum mdelim      mandoc_isdelim(const char *);

 
 __END_DECLS
 
 
 __END_DECLS