mandoc/mandoc.h - diff

Return to mandoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.h between version 1.58 and 1.62

-version 1.58, 2011/03/07 01:35:51
+version 1.62, 2011/03/20 11:41:24
 Line 312  struct regset {
 Line 312  struct regset {
 Line 312  struct regset {
          struct reg        regs[REG__MAX];
  };
- __BEGIN_DECLS
+ /*
+  * A punctuation delimiter, used only in mdoc(7) documents, is opening,
+  * closing, or "middle mark" punctuation.  These govern spacing.
+  * Opening punctuation (e.g., the opening parenthesis) suppresses the
+  * following space; closing punctuation (e.g., the closing parenthesis)
+  * suppresses the leading space; middle punctuation (e.g., the vertical
+  * bar) can do either.  The middle punctuation delimiter bends the rules
+  * depending on usage.
+  */
+ enum    mdelim {
+         DELIM_NONE = 0,
+         DELIM_OPEN,
+         DELIM_MIDDLE,
+         DELIM_CLOSE
+ };
  /*
-  * Callback function for warnings, errors, and fatal errors as they
+  * The type of parse sequence.  This value is usually passed via the
-  * occur in the compilers libroff, libmdoc, and libman.
+  * mandoc(1) command line of -man and -mdoc.  It's almost exclusively
+  * -mandoc but the others have been retained for compatibility.
   */
- typedef int             (*mandocmsg)(enum mandocerr, void *,
+ enum    mparset {
-                                 int, int, const char *);
+         MPARSE_AUTO, /* magically determine the document type */
+         MPARSE_MDOC, /* assume -mdoc */
+         MPARSE_MAN /* assume -man */
+ };
+ typedef void    (*mandocmsg)(enum mandocerr, void *,
+                         int, int, const char *);
+ typedef int     (*mevt_open)(void *, const char *);
+ typedef void    (*mevt_close)(void *, const char *);
+ struct  mparse;
+ struct  mdoc;
+ struct  man;
+ __BEGIN_DECLS
+ void              mparse_free(struct mparse *);
+ void              mparse_reset(struct mparse *);
+ struct mparse    *mparse_alloc(enum mparset, mevt_open,
+                         mevt_close, mandocmsg, void *);
+ void              mparse_setstatus(struct mparse *, enum mandoclevel);
+ 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);
+ #define DELIMSZ   6 /* hint: max possible size of a delimiter */
+ enum mdelim       mandoc_isdelim(const char *);
  __END_DECLS

CVSweb