When in a <PRE>, don't print out the <BR> before lines that have leading

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 1d8913abe7ea1ee35b5ebfea1af2fde3e2b9d0c8..f9c77487493f6ea9a9c9a86385da76e68ea66e87 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,6 +1,6 @@
-/*     $Id: mandoc.h,v 1.39 2011/01/01 15:45:18 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.53 2011/01/12 15:50:42 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
@@ -75,10 +75,12 @@ enum        mandocerr {
 
        /* 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_WNOSCOPE, /* skipping end of block that is not open */
 
        /* related to bad macro arguments */
        MANDOCERR_IGNARGV, /* skipping argument */
@@ -101,13 +103,19 @@ enum      mandocerr {
 
        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_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_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 */
@@ -140,6 +148,39 @@ enum       mandocerr {
        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 */
+       TBL_HEAD_DVERT  /* double-vertical spacer */
+};
+
+/*
+ * The head of a table specifies all of its columns.  When formatting a
+ * tbl_span, iterate over these and plug in data from the tbl_span when
+ * appropriate, using tbl_cell as a guide to placement.
+ */
+struct tbl_head {
+       enum tbl_headt    pos;
+       int               ident; /* 0 <= unique id < cols */
+       struct tbl_head  *next;
+       struct tbl_head  *prev;
+};
+
 enum   tbl_cellt {
        TBL_CELL_CENTRE, /* c, C */
        TBL_CELL_RIGHT, /* r, R */
@@ -161,7 +202,7 @@ enum        tbl_cellt {
 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 */
@@ -170,6 +211,7 @@ struct      tbl_cell {
 #define        TBL_CELL_EQUAL   (1 << 4) /* e, E */
 #define        TBL_CELL_UP      (1 << 5) /* u, U */
 #define        TBL_CELL_WIGN    (1 << 6) /* z, Z */
+       struct tbl_head  *head;
 };
 
 /*
@@ -181,31 +223,46 @@ struct    tbl_row {
        struct tbl_cell  *last;
 };
 
+enum   tbl_datt {
+       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 */
+};
+
 /*
  * A cell within a row of data.  The "string" field contains the actual
  * 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;
-       char             *string;
-       int               flags;
-#define        TBL_DATA_HORIZ   (1 << 0)
-#define        TBL_DATA_DHORIZ  (1 << 1)
-#define        TBL_DATA_NHORIZ  (1 << 2)
-#define        TBL_DATA_NDHORIZ (1 << 3)
+       char             *string; /* data (NULL if not TBL_DATA_DATA) */
+       enum tbl_datt     pos;
+};
+
+enum   tbl_spant {
+       TBL_SPAN_DATA, /* span consists of data */
+       TBL_SPAN_HORIZ, /* span is horizontal line */
+       TBL_SPAN_DHORIZ /* span is double horizontal line */
 };
 
 /*
  * 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;
        int               flags;
-#define        TBL_SPAN_HORIZ  (1 << 0)
-#define        TBL_SPAN_DHORIZ (1 << 1)
+#define        TBL_SPAN_FIRST   (1 << 0)
+#define        TBL_SPAN_LAST    (1 << 1)
+       enum tbl_spant    pos;
        struct tbl_span  *next;
 };