Move mdoc_isdelim() into mandoc.h as mandoc_isdelim(). This allows the

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index d5b9169be8809fb1c87d5f6e4e2707ad93a7538c..447dbd55d8f3534daf538b51a1e104c98bf0057c 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,6 +1,6 @@
-/*     $Id: mandoc.h,v 1.41 2011/01/01 22:19:15 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.60 2011/03/17 09:16:38 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2011 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


@@ -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 */


@@ -75,10 +77,12 @@ enum        mandocerr {
 
        /* related to missing macro arguments */
        MANDOCERR_MACROEMPTY, /* skipping empty macro */
 
        /* related to missing macro arguments */
        MANDOCERR_MACROEMPTY, /* skipping empty macro */

+       MANDOCERR_ARGCWARN, /* argument count wrong */

        MANDOCERR_DISPTYPE, /* missing display type */
        MANDOCERR_LISTFIRST, /* list type must come first */
        MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
        MANDOCERR_FONTTYPE, /* missing font type */
        MANDOCERR_DISPTYPE, /* missing display 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 */


@@ -101,13 +105,19 @@ enum      mandocerr {
 
        MANDOCERR_ERROR, /* ===== start of errors ===== */
 
 
        MANDOCERR_ERROR, /* ===== start of errors ===== */
 

+       /* related to tables */

        MANDOCERR_TBL, /* bad table syntax */
        MANDOCERR_TBLOPT, /* bad table option */
        MANDOCERR_TBLLAYOUT, /* bad table layout */
        MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
        MANDOCERR_TBLNODATA, /* no table data cells specified */
        MANDOCERR_TBL, /* bad table syntax */
        MANDOCERR_TBLOPT, /* bad table option */
        MANDOCERR_TBLLAYOUT, /* bad table layout */
        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 */


@@ -140,6 +150,21 @@ enum       mandocerr {
        MANDOCERR_MAX
 };
 
        MANDOCERR_MAX
 };
 

+struct tbl {
+       char              tab; /* cell-separator */
+       char              decimal; /* decimal point */
+       int               linesize;
+       int               opts;
+#define        TBL_OPT_CENTRE   (1 << 0)
+#define        TBL_OPT_EXPAND   (1 << 1)
+#define        TBL_OPT_BOX      (1 << 2)
+#define        TBL_OPT_DBOX     (1 << 3)
+#define        TBL_OPT_ALLBOX   (1 << 4)
+#define        TBL_OPT_NOKEEP   (1 << 5)
+#define        TBL_OPT_NOSPACE  (1 << 6)
+       int               cols; /* number of columns */
+};
+

 enum   tbl_headt {
        TBL_HEAD_DATA, /* plug in data from tbl_dat */
        TBL_HEAD_VERT, /* vertical spacer */
 enum   tbl_headt {
        TBL_HEAD_DATA, /* plug in data from tbl_dat */
        TBL_HEAD_VERT, /* vertical spacer */


@@ -153,8 +178,7 @@ enum        tbl_headt {
  */
 struct tbl_head {
        enum tbl_headt    pos;
  */
 struct tbl_head {
        enum tbl_headt    pos;

-       int               width; /* width of cell in fixed chars */
-       int               decimal; /* decimal point position */
+       int               ident; /* 0 <= unique id < cols */

        struct tbl_head  *next;
        struct tbl_head  *prev;
 };
        struct tbl_head  *next;
        struct tbl_head  *prev;
 };


@@ -180,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 */


@@ -202,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 */

 };
 
 /*
 };
 
 /*


@@ -214,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;
 };
 


@@ -230,13 +256,26 @@ enum      tbl_spant {
  * A row of data in a table.
  */
 struct tbl_span {
  * A row of data in a table.
  */
 struct tbl_span {

-       struct tbl_row   *layout; /* layout row: CAN BE NULL */
+       struct tbl       *tbl;
+       struct tbl_head  *head;
+       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)

        enum tbl_spant    pos;
        struct tbl_span  *next;
 };
 
        enum tbl_spant    pos;
        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).
  */


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

-__BEGIN_DECLS
-

 /*
 /*

- * Callback function for warnings, errors, and fatal errors as they
- * occur in the compilers libroff, libmdoc, and libman.
+ * 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.

  */
  */

-typedef        int             (*mandocmsg)(enum mandocerr, void *,
-                               int, int, const char *);
+enum   mdelim {
+       DELIM_NONE = 0,
+       DELIM_OPEN,
+       DELIM_MIDDLE,
+       DELIM_CLOSE
+};
+
+typedef        int     (*mandocmsg)(enum mandocerr, void *,
+                       int, int, const char *);
+
+__BEGIN_DECLS
+
+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