If man(7) next-line scope is open and the line ends with \c,

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 1eb5acf885b00f6fe0fbeea9a1d9969abc13a97b..0ae9b6029719cb33dca84e29029acb430451f4e3 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,7 +1,7 @@
-/*     $Id: mandoc.h,v 1.243 2017/07/06 22:59:48 schwarze Exp $ */
+/*     $Id: mandoc.h,v 1.252 2018/08/24 23:12:33 schwarze Exp $ */
 /*
  * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2018 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -56,9 +56,10 @@ enum mandocerr {
        MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
 
        MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
+       MANDOCERR_DATE_NORM, /* normalizing date format to: ... */
        MANDOCERR_TITLE_CASE, /* lower case character in document title */
        MANDOCERR_RCS_REP, /* duplicate RCS id: ... */
-       MANDOCERR_SEC_TYPO,  /* typo in section name: Sh ... */
+       MANDOCERR_SEC_TYPO,  /* possible typo in section name: Sh ... */
        MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
        MANDOCERR_MACRO_USELESS, /* useless macro: macro */
        MANDOCERR_BX, /* consider using OS macro: macro */
@@ -68,6 +69,7 @@ enum  mandocerr {
        MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */
        MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
        MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
+       MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */
        MANDOCERR_FUNC, /* function name without markup: name() */
        MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
        MANDOCERR_COMMENT_BAD, /* bad comment style */
@@ -193,6 +195,7 @@ enum        mandocerr {
        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
        MANDOCERR_CHAR_BAD, /* skipping bad character: number */
        MANDOCERR_MACRO, /* skipping unknown macro: macro */
+       MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */
        MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
        MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
        MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
@@ -203,6 +206,8 @@ enum        mandocerr {
 
        /* related to request and macro arguments */
        MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
+       MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */
+       MANDOCERR_ARG_NONUM, /* argument number is not numeric */
        MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
        MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
        MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
@@ -211,6 +216,7 @@ enum        mandocerr {
        MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
        MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
        MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
+       MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */
        MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
        MANDOCERR_SO_FAIL, /* .so request failed */
        MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
@@ -222,6 +228,10 @@ enum       mandocerr {
        MANDOCERR_TOOLARGE, /* input too large */
        MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
        MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
+       MANDOCERR_WHILE_NEST, /* nested .while loops */
+       MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */
+       MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */
+       MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */
        MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
        MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
        MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
@@ -334,7 +344,6 @@ struct      tbl_span {
 };
 
 enum   eqn_boxt {
-       EQN_ROOT, /* root of parse tree */
        EQN_TEXT, /* text (number, variable, whatever) */
        EQN_SUBEXPR, /* nested `eqn' subexpression */
        EQN_LIST, /* list (braces, etc.) */
@@ -402,17 +411,6 @@ struct     eqn_box {
        enum eqn_pilet    pile; /* equation piling */
 };
 
-/*
- * An equation consists of a tree of expressions starting at a given
- * line and position.
- */
-struct eqn {
-       char             *name; /* identifier (or NULL) */
-       struct eqn_box   *root; /* root mathematical expression */
-       int               ln; /* invocation line */
-       int               pos; /* invocation position */
-};
-
 /*
  * Parse options.
  */
@@ -441,6 +439,7 @@ enum        mandoc_esc {
        ESCAPE_FONTPREV, /* previous font mode */
        ESCAPE_NUMBERED, /* a numbered glyph */
        ESCAPE_UNICODE, /* a unicode codepoint */
+       ESCAPE_DEVICE, /* print the output device name */
        ESCAPE_BREAK, /* break the output line */
        ESCAPE_NOSPACE, /* suppress space if the last on a line */
        ESCAPE_HORIZ, /* horizontal movement */
@@ -467,7 +466,6 @@ const char   *mchars_spec2str(const char *, size_t, size_t *);
 struct mparse   *mparse_alloc(int, enum mandocerr, mandocmsg,
                        enum mandoc_os, const char *);
 void             mparse_free(struct mparse *);
-void             mparse_keep(struct mparse *);
 int              mparse_open(struct mparse *, const char *);
 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
 enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
@@ -475,7 +473,7 @@ enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
 void             mparse_reset(struct mparse *);
 void             mparse_result(struct mparse *,
                        struct roff_man **, char **);
-const char      *mparse_getkeep(const struct mparse *);
+void             mparse_copy(const struct mparse *);
 const char      *mparse_strerror(enum mandocerr);
 const char      *mparse_strlevel(enum mandoclevel);
 void             mparse_updaterc(struct mparse *, enum mandoclevel *);