Move mandoc_isdelim() back into libmdoc.h. This fixes an unreported

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index e7c0e96af9d6f55d9615123dc2befa25c70d5236..694179d1bc64cad2e701188aac4da003fd51e2bf 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: mandoc.h,v 1.51 2011/01/10 15:31:00 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.67 2011/03/22 14:05:45 kristaps Exp $ */
 /*
  * 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_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 */
@@ -68,6 +69,7 @@ enum  mandocerr {
        /* 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 */
@@ -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_WNOSCOPE, /* skipping end of block that is not open */
 
        /* related to bad macro arguments */
        MANDOCERR_IGNARGV, /* skipping argument */
@@ -114,6 +117,7 @@ enum        mandocerr {
 
        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 */
@@ -133,6 +137,7 @@ enum        mandocerr {
 
        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 */
@@ -257,6 +262,7 @@ struct      tbl_span {
        struct tbl_row   *layout; /* layout row */
        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)
@@ -264,50 +270,43 @@ struct    tbl_span {
        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 */
-};
+typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
+                       const char *, int, int, const char *);
 
-/*
- * 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];
-};
+struct mparse;
+struct mdoc;
+struct man;
 
 __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 **);
+
+void            *mandoc_calloc(size_t, size_t);
+void            *mandoc_malloc(size_t);
+void            *mandoc_realloc(void *, size_t);
 
 __END_DECLS