Some release notes (this isn't signalling an impending release; I just

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 789e9b60a1521c31fbd559786ff3c5c8393dfea1..5f01644c8e829e88d104ac976125b7101a900b02 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,6 +1,6 @@
-/*     $Id: mandoc.h,v 1.43 2011/01/02 10:10:57 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.76 2011/05/17 11:50:20 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,17 +69,21 @@ 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_SCOPEREP, /* already in literal mode */
        MANDOCERR_SCOPENEST, /* blocks badly nested */
        MANDOCERR_CHILD, /* child violates parent syntax */
        MANDOCERR_NESTEDDISP, /* nested displays are not portable */
        MANDOCERR_SCOPEREP, /* already in literal mode */

+       MANDOCERR_LINESCOPE, /* line scope broken */

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


@@ -99,9 +104,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 */


@@ -110,13 +112,16 @@ enum      mandocerr {
        MANDOCERR_TBLLAYOUT, /* bad table layout */
        MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
        MANDOCERR_TBLNODATA, /* no table data cells specified */
        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 */

-       MANDOCERR_LINESCOPE, /* line scope broken */

        MANDOCERR_ARGCOUNT, /* argument count wrong */
        MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
        MANDOCERR_SCOPEBROKEN, /* missing end of block */
        MANDOCERR_ARGCOUNT, /* argument count wrong */
        MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
        MANDOCERR_SCOPEBROKEN, /* missing end of block */


@@ -132,6 +137,7 @@ enum        mandocerr {
 
        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
 
 
        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
 

+       MANDOCERR_NOTMANUAL, /* manual isn't really a manual */

        MANDOCERR_COLUMNS, /* column syntax is inconsistent */
        MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
        MANDOCERR_COLUMNS, /* column syntax is inconsistent */
        MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */


@@ -149,7 +155,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];

        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)


@@ -158,6 +163,7 @@ struct      tbl {
 #define        TBL_OPT_ALLBOX   (1 << 4)
 #define        TBL_OPT_NOKEEP   (1 << 5)
 #define        TBL_OPT_NOSPACE  (1 << 6)
 #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 {
 };
 
 enum   tbl_headt {


@@ -173,8 +179,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;
 };


@@ -200,7 +205,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 */


@@ -222,11 +227,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 */

 };
 
 /*
 };
 
 /*


@@ -234,9 +240,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;
 };
 


@@ -250,57 +257,86 @@ 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;
 };
 

-/*
- * Available registers (set in libroff, accessed elsewhere).
- */
-enum   regs {
-       REG_nS = 0,
-       REG__MAX
+struct eqn {
+       size_t            sz;
+       char             *data;
+       int               line; /* invocation line */
+       int               pos; /* invocation position */

 };
 
 /*
 };
 
 /*

- * A register (struct reg) can consist of many types: this consists of
- * normalised types from the original string form.
+ * 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.

  */
  */

-union  regval {
-       unsigned  u; /* unsigned integer */
+enum   mparset {
+       MPARSE_AUTO, /* magically determine the document type */
+       MPARSE_MDOC, /* assume -mdoc */
+       MPARSE_MAN /* assume -man */

 };
 
 };
 

-/*
- * A single register entity.  If "set" is zero, the value of the
- * register should be the default one, which is per-register.  It's
- * assumed that callers know which type in "v" corresponds to which
- * register value.
- */
-struct reg {
-       int               set; /* whether set or not */
-       union regval      v; /* parsed data */
+enum   mandoc_esc {
+       ESCAPE_ERROR = 0, /* bail! unparsable escape */
+       ESCAPE_IGNORE, /* escape to be ignored */
+       ESCAPE_SPECIAL, /* a regular special character */
+       ESCAPE_PREDEF, /* a predefined special character */
+       ESCAPE_FONT, /* a generic font mode */
+       ESCAPE_FONTBOLD, /* bold font mode */
+       ESCAPE_FONTITALIC, /* italic font mode */
+       ESCAPE_FONTROMAN, /* roman font mode */
+       ESCAPE_FONTPREV, /* previous font mode */
+       ESCAPE_NUMBERED, /* a numbered glyph */
+       ESCAPE_UNICODE, /* a unicode codepoint */
+       ESCAPE_NOSPACE /* suppress space if the last on a line */

 };
 
 };
 

-/*
- * The primary interface to setting register values is in libroff,
- * although libmdoc and libman from time to time will manipulate
- * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
- */
-struct regset {
-       struct reg        regs[REG__MAX];
-};
+typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
+                       const char *, int, int, const char *);
+
+struct mparse;
+struct mchars;
+struct mdoc;
+struct man;

 
 __BEGIN_DECLS
 
 
 __BEGIN_DECLS
 

-/*
- * Callback function for warnings, errors, and fatal errors as they
- * occur in the compilers libroff, libmdoc, and libman.
- */
-typedef        int             (*mandocmsg)(enum mandocerr, void *,
-                               int, int, const char *);
+void             mparse_free(struct mparse *);
+void             mparse_reset(struct mparse *);
+struct mparse   *mparse_alloc(enum mparset, 
+                       enum mandoclevel, mandocmsg, void *);
+enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
+void             mparse_result(struct mparse *, struct mdoc **, struct man **);
+const char      *mparse_strerror(enum mandocerr);
+const char      *mparse_strlevel(enum mandoclevel);
+
+void            *mandoc_calloc(size_t, size_t);
+void            *mandoc_malloc(size_t);
+void            *mandoc_realloc(void *, size_t);
+
+enum mandoc_esc          mandoc_escape(const char **, const char **, int *);
+
+struct mchars   *mchars_alloc(void);
+char             mchars_num2char(const char *, size_t);
+int              mchars_num2uc(const char *, size_t);
+const char      *mchars_spec2str(struct mchars *, const char *, size_t, size_t *);
+int              mchars_spec2cp(struct mchars *, const char *, size_t);
+const char      *mchars_res2str(struct mchars *, const char *, size_t, size_t *);
+int              mchars_res2cp(struct mchars *, const char *, size_t);
+void             mchars_free(struct mchars *);
+

 
 __END_DECLS
 
 
 __END_DECLS