Use size_t in manpath instead of int.

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index ad0345dbe7bb9659a709427adb9e060787dc9053..d0560cfc8fc30c430a5737fe3d295a04d4cab7f6 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: mandoc.h,v 1.59 2011/03/17 08:49:34 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.102 2012/05/31 22:29:13 schwarze Exp $ */

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


@@ -74,6 +74,7 @@ enum  mandocerr {
        MANDOCERR_CHILD, /* child violates parent syntax */
        MANDOCERR_NESTEDDISP, /* nested displays are not portable */
        MANDOCERR_SCOPEREP, /* already in literal mode */
        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 */


@@ -103,8 +104,18 @@ enum       mandocerr {
        MANDOCERR_BADESCAPE, /* unknown escape sequence */
        MANDOCERR_BADQUOTE, /* unterminated quoted string */
 
        MANDOCERR_BADESCAPE, /* unknown escape sequence */
        MANDOCERR_BADQUOTE, /* unterminated quoted string */
 

+       /* related to equations */
+       MANDOCERR_EQNQUOTE, /* unexpected literal in equation */
+

        MANDOCERR_ERROR, /* ===== start of errors ===== */
 
        MANDOCERR_ERROR, /* ===== start of errors ===== */
 

+       /* related to equations */
+       MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
+       MANDOCERR_EQNSCOPE, /* equation scope open on exit */
+       MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
+       MANDOCERR_EQNEOF, /* unexpected end of equation */
+       MANDOCERR_EQNSYNT, /* equation syntax error */
+

        /* related to tables */
        MANDOCERR_TBL, /* bad table syntax */
        MANDOCERR_TBLOPT, /* bad table option */
        /* related to tables */
        MANDOCERR_TBL, /* bad table syntax */
        MANDOCERR_TBLOPT, /* bad table option */


@@ -121,7 +132,6 @@ enum        mandocerr {
        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 */


@@ -137,9 +147,9 @@ 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_COLUMNS, /* column syntax is inconsistent */
        MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */

-       MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */

        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_SYNTCHILD, /* child violates parent syntax */
        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_SYNTCHILD, /* child violates parent syntax */
        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */


@@ -165,20 +175,14 @@ struct    tbl {
        int               cols; /* number of columns */
 };
 
        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 {
 /*
  * 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 */
        int               ident; /* 0 <= unique id < cols */

+       int               vert; /* width of preceding vertical line */

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


@@ -193,8 +197,6 @@ enum        tbl_cellt {
        TBL_CELL_DOWN, /* ^ */
        TBL_CELL_HORIZ, /* _, - */
        TBL_CELL_DHORIZ, /* = */
        TBL_CELL_DOWN, /* ^ */
        TBL_CELL_HORIZ, /* _, - */
        TBL_CELL_DHORIZ, /* = */

-       TBL_CELL_VERT, /* | */
-       TBL_CELL_DVERT, /* || */

        TBL_CELL_MAX
 };
 
        TBL_CELL_MAX
 };
 


@@ -203,6 +205,7 @@ enum        tbl_cellt {
  */
 struct tbl_cell {
        struct tbl_cell  *next;
  */
 struct tbl_cell {
        struct tbl_cell  *next;

+       int               vert; /* width of preceding vertical line */

        enum tbl_cellt    pos;
        size_t            spacing;
        int               flags;
        enum tbl_cellt    pos;
        size_t            spacing;
        int               flags;


@@ -269,57 +272,154 @@ 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 */
+enum   eqn_boxt {
+       EQN_ROOT, /* root of parse tree */
+       EQN_TEXT, /* text (number, variable, whatever) */
+       EQN_SUBEXPR, /* nested `eqn' subexpression */
+       EQN_LIST, /* subexpressions list */
+       EQN_MATRIX /* matrix subexpression */

 };
 
 };
 

-/*
- * Available registers (set in libroff, accessed elsewhere).
- */
-enum   regs {
-       REG_nS = 0,
-       REG__MAX
+enum   eqn_markt {
+       EQNMARK_NONE = 0,
+       EQNMARK_DOT,
+       EQNMARK_DOTDOT,
+       EQNMARK_HAT,
+       EQNMARK_TILDE,
+       EQNMARK_VEC,
+       EQNMARK_DYAD,
+       EQNMARK_BAR,
+       EQNMARK_UNDER,
+       EQNMARK__MAX

 };
 
 };
 

-/*
- * A register (struct reg) can consist of many types: this consists of
- * normalised types from the original string form.
+enum   eqn_fontt {
+       EQNFONT_NONE = 0,
+       EQNFONT_ROMAN,
+       EQNFONT_BOLD,
+       EQNFONT_FAT,
+       EQNFONT_ITALIC,
+       EQNFONT__MAX
+};
+
+enum   eqn_post {
+       EQNPOS_NONE = 0,
+       EQNPOS_OVER,
+       EQNPOS_SUP,
+       EQNPOS_SUB,
+       EQNPOS_TO,
+       EQNPOS_FROM,
+       EQNPOS__MAX
+};
+
+enum   eqn_pilet {
+       EQNPILE_NONE = 0,
+       EQNPILE_PILE,
+       EQNPILE_CPILE,
+       EQNPILE_RPILE,
+       EQNPILE_LPILE,
+       EQNPILE_COL,
+       EQNPILE_CCOL,
+       EQNPILE_RCOL,
+       EQNPILE_LCOL,
+       EQNPILE__MAX
+};
+
+ /*
+ * A "box" is a parsed mathematical expression as defined by the eqn.7
+ * grammar.

  */
  */

-union  regval {
-       unsigned  u; /* unsigned integer */
+struct eqn_box {
+       int               size; /* font size of expression */
+#define        EQN_DEFSIZE       INT_MIN
+       enum eqn_boxt     type; /* type of node */
+       struct eqn_box   *first; /* first child node */
+       struct eqn_box   *last; /* last child node */
+       struct eqn_box   *next; /* node sibling */
+       struct eqn_box   *parent; /* node sibling */
+       char             *text; /* text (or NULL) */
+       char             *left;
+       char             *right;
+       enum eqn_post     pos; /* position of next box */
+       enum eqn_markt    mark; /* a mark about the box */
+       enum eqn_fontt    font; /* font of box */
+       enum eqn_pilet    pile; /* equation piling */

 };
 
 /*
 };
 
 /*

- * 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.
+ * An equation consists of a tree of expressions starting at a given
+ * line and position. 

  */
  */

-struct reg {
-       int               set; /* whether set or not */
-       union regval      v; /* parsed data */
+struct eqn {
+       char             *name; /* identifier (or NULL) */
+       struct eqn_box   *root; /* root mathematical expression */
+       int               ln; /* invocation line */
+       int               pos; /* invocation position */

 };
 
 /*
 };
 
 /*

- * 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).
+ * 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.

  */
  */

-struct regset {
-       struct reg        regs[REG__MAX];
+enum   mparset {
+       MPARSE_AUTO, /* magically determine the document type */
+       MPARSE_MDOC, /* assume -mdoc */
+       MPARSE_MAN /* assume -man */

 };
 
 };
 

-typedef        int     (*mandocmsg)(enum mandocerr, void *,
-                       int, int, const char *);
+enum   mandoc_esc {
+       ESCAPE_ERROR = 0, /* bail! unparsable escape */
+       ESCAPE_IGNORE, /* escape to be ignored */
+       ESCAPE_SPECIAL, /* a regular 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 */
+       ESCAPE_SKIPCHAR /* skip the next character */
+};
+
+typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
+                       const char *, int, int, const char *);
+
+struct mparse;
+struct mchars;
+struct mdoc;
+struct man;

 
 __BEGIN_DECLS
 
 void            *mandoc_calloc(size_t, size_t);
 
 __BEGIN_DECLS
 
 void            *mandoc_calloc(size_t, size_t);

+enum mandoc_esc          mandoc_escape(const char **, const char **, int *);

 void            *mandoc_malloc(size_t);
 void            *mandoc_realloc(void *, size_t);
 void            *mandoc_malloc(size_t);
 void            *mandoc_realloc(void *, size_t);

+char            *mandoc_strdup(const char *);
+char            *mandoc_strndup(const char *, size_t);
+struct mchars   *mchars_alloc(void);
+void             mchars_free(struct mchars *);
+char             mchars_num2char(const char *, size_t);
+int              mchars_num2uc(const char *, size_t);
+int              mchars_spec2cp(const struct mchars *, 
+                       const char *, size_t);
+const char      *mchars_spec2str(const struct mchars *, 
+                       const char *, size_t, size_t *);
+struct mparse   *mparse_alloc(enum mparset, enum mandoclevel,
+                       mandocmsg, void *, char *);
+void             mparse_free(struct mparse *);
+void             mparse_keep(struct mparse *);
+enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
+enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
+                       const char *);
+void             mparse_reset(struct mparse *);
+void             mparse_result(struct mparse *, 
+                       struct mdoc **, struct man **);
+const char      *mparse_getkeep(const struct mparse *);
+const char      *mparse_strerror(enum mandocerr);
+const char      *mparse_strlevel(enum mandoclevel);

 
 __END_DECLS
 
 
 __END_DECLS