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 845c85a5c2923dad28ef80ba59386ce61ed3945a..5f01644c8e829e88d104ac976125b7101a900b02 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: mandoc.h,v 1.56 2011/02/06 22:02:58 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.76 2011/05/17 11:50:20 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 */
@@ -73,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_LINESCOPE, /* line scope broken */
 
        /* related to missing macro arguments */
        MANDOCERR_MACROEMPTY, /* skipping empty macro */
@@ -120,7 +122,6 @@ enum        mandocerr {
        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 */
@@ -136,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 */
@@ -271,52 +273,70 @@ struct    tbl_span {
 struct eqn {
        size_t            sz;
        char             *data;
+       int               line; /* invocation line */
+       int               pos; /* invocation position */
 };
 
 /*
- * Available registers (set in libroff, accessed elsewhere).
+ * 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.
  */
-enum   regs {
-       REG_nS = 0,
-       REG__MAX
+enum   mparset {
+       MPARSE_AUTO, /* magically determine the document type */
+       MPARSE_MDOC, /* assume -mdoc */
+       MPARSE_MAN /* assume -man */
 };
 
-/*
- * A register (struct reg) can consist of many types: this consists of
- * normalised types from the original string form.
- */
-union  regval {
-       unsigned  u; /* unsigned integer */
+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 */
 };
 
-/*
- * 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 mchars;
+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 **);
+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