remove stray byte from broken escape sequence; diff from jmc@

[mandoc.git] / roff.h

diff --git a/roff.h b/roff.h
index c41553e23d965f9bc827fe08b04c9fb44060131a..2933eb9c0bf83eb88fd4f2501185e01e98ed70e2 100644 (file)
--- a/roff.h
+++ b/roff.h
@@ -1,7 +1,7 @@
-/*     $Id: roff.h,v 1.64 2018/12/13 11:55:47 schwarze Exp $   */
+/* $Id: roff.h,v 1.74 2020/04/08 11:56:03 schwarze Exp $       */

 /*
 /*

+ * Copyright (c) 2013-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>

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

- * Copyright (c) 2013,2014,2015,2017,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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -21,6 +21,8 @@
 struct ohash;
 struct mdoc_arg;
 union  mdoc_data;
 struct ohash;
 struct mdoc_arg;
 union  mdoc_data;

+struct tbl_span;
+struct eqn_box;

 
 enum   roff_macroset {
        MACROSET_NONE = 0,
 
 enum   roff_macroset {
        MACROSET_NONE = 0,


@@ -71,9 +73,11 @@ enum roff_type {
 enum   roff_tok {
        ROFF_br = 0,
        ROFF_ce,
 enum   roff_tok {
        ROFF_br = 0,
        ROFF_ce,

+       ROFF_fi,

        ROFF_ft,
        ROFF_ll,
        ROFF_mc,
        ROFF_ft,
        ROFF_ll,
        ROFF_mc,

+       ROFF_nf,

        ROFF_po,
        ROFF_rj,
        ROFF_sp,
        ROFF_po,
        ROFF_rj,
        ROFF_sp,


@@ -158,7 +162,6 @@ enum        roff_tok {
        ROFF_fcolor,
        ROFF_fdeferlig,
        ROFF_feature,
        ROFF_fcolor,
        ROFF_fdeferlig,
        ROFF_feature,

-       /* MAN_fi; ignored in mdoc(7) */

        ROFF_fkern,
        ROFF_fl,
        ROFF_flig,
        ROFF_fkern,
        ROFF_fl,
        ROFF_flig,


@@ -218,7 +221,6 @@ enum        roff_tok {
        ROFF_mso,
        ROFF_na,
        ROFF_ne,
        ROFF_mso,
        ROFF_na,
        ROFF_ne,

-       /* MAN_nf; ignored in mdoc(7) */

        ROFF_nh,
        ROFF_nhychar,
        ROFF_nm,
        ROFF_nh,
        ROFF_nhychar,
        ROFF_nm,


@@ -435,6 +437,7 @@ enum        roff_tok {
        MDOC__Q,
        MDOC__U,
        MDOC_Ta,
        MDOC__Q,
        MDOC__U,
        MDOC_Ta,

+       MDOC_Tg,

        MDOC_MAX,
        MAN_TH,
        MAN_SH,
        MDOC_MAX,
        MAN_TH,
        MAN_SH,


@@ -457,8 +460,6 @@ enum        roff_tok {
        MAN_I,
        MAN_IR,
        MAN_RI,
        MAN_I,
        MAN_IR,
        MAN_RI,

-       MAN_nf,
-       MAN_fi,

        MAN_RE,
        MAN_RS,
        MAN_DT,
        MAN_RE,
        MAN_RS,
        MAN_DT,


@@ -478,11 +479,6 @@ enum       roff_tok {
        MAN_MAX
 };
 
        MAN_MAX
 };
 

-enum   roff_next {
-       ROFF_NEXT_SIBLING = 0,
-       ROFF_NEXT_CHILD
-};
-

 /*
  * Indicates that a BODY's formatting has ended, but
  * the scope is still open.  Used for badly nested blocks.
 /*
  * Indicates that a BODY's formatting has ended, but
  * the scope is still open.  Used for badly nested blocks.


@@ -510,6 +506,7 @@ struct      roff_node {
        struct mdoc_arg  *args;    /* BLOCK/ELEM */
        union mdoc_data  *norm;    /* Normalized arguments. */
        char             *string;  /* TEXT */
        struct mdoc_arg  *args;    /* BLOCK/ELEM */
        union mdoc_data  *norm;    /* Normalized arguments. */
        char             *string;  /* TEXT */

+       char             *tag;     /* For less(1) :t and HTML id=. */

        struct tbl_span  *span;    /* TBL */
        struct eqn_box   *eqn;     /* EQN */
        int               line;    /* Input file line number. */
        struct tbl_span  *span;    /* TBL */
        struct eqn_box   *eqn;     /* EQN */
        int               line;    /* Input file line number. */


@@ -517,14 +514,17 @@ struct    roff_node {
        int               flags;
 #define        NODE_VALID       (1 << 0)  /* Has been validated. */
 #define        NODE_ENDED       (1 << 1)  /* Gone past body end mark. */
        int               flags;
 #define        NODE_VALID       (1 << 0)  /* Has been validated. */
 #define        NODE_ENDED       (1 << 1)  /* Gone past body end mark. */

-#define        NODE_EOS         (1 << 2)  /* At sentence boundary. */
+#define        NODE_BROKEN      (1 << 2)  /* Must validate parent when ending. */

 #define        NODE_LINE        (1 << 3)  /* First macro/text on line. */
 #define        NODE_LINE        (1 << 3)  /* First macro/text on line. */

-#define        NODE_SYNPRETTY   (1 << 4)  /* SYNOPSIS-style formatting. */
-#define        NODE_BROKEN      (1 << 5)  /* Must validate parent when ending. */
-#define        NODE_DELIMO      (1 << 6)
-#define        NODE_DELIMC      (1 << 7)
-#define        NODE_NOSRC       (1 << 8)  /* Generated node, not in input file. */
-#define        NODE_NOPRT       (1 << 9)  /* Shall not print anything. */
+#define        NODE_DELIMO      (1 << 4)
+#define        NODE_DELIMC      (1 << 5)
+#define        NODE_EOS         (1 << 6)  /* At sentence boundary. */
+#define        NODE_SYNPRETTY   (1 << 7)  /* SYNOPSIS-style formatting. */
+#define        NODE_NOFILL      (1 << 8)  /* Fill mode switched off. */
+#define        NODE_NOSRC       (1 << 9)  /* Generated node, not in input file. */
+#define        NODE_NOPRT       (1 << 10) /* Shall not print anything. */
+#define        NODE_ID          (1 << 11) /* Target for deep linking. */
+#define        NODE_HREF        (1 << 12) /* Link to another place in this page. */

        int               prev_font; /* Before entering this node. */
        int               aux;     /* Decoded node data, type-dependent. */
        enum roff_tok     tok;     /* Request or macro ID. */
        int               prev_font; /* Before entering this node. */
        int               aux;     /* Decoded node data, type-dependent. */
        enum roff_tok     tok;     /* Request or macro ID. */


@@ -534,6 +534,7 @@ struct      roff_node {
 };
 
 struct roff_meta {
 };
 
 struct roff_meta {

+       struct roff_node *first;   /* The first node parsed. */

        char             *msec;    /* Manual section, usually a digit. */
        char             *vol;     /* Manual volume title. */
        char             *os;      /* Operating system. */
        char             *msec;    /* Manual section, usually a digit. */
        char             *vol;     /* Manual volume title. */
        char             *os;      /* Operating system. */


@@ -541,48 +542,20 @@ struct    roff_meta {
        char             *title;   /* Manual title, usually CAPS. */
        char             *name;    /* Leading manual name. */
        char             *date;    /* Normalized date. */
        char             *title;   /* Manual title, usually CAPS. */
        char             *name;    /* Leading manual name. */
        char             *date;    /* Normalized date. */

+       char             *sodest;  /* .so target file name or NULL. */

        int               hasbody; /* Document is not empty. */
        int               rcsids;  /* Bits indexed by enum mandoc_os. */
        enum mandoc_os    os_e;    /* Operating system. */
        int               hasbody; /* Document is not empty. */
        int               rcsids;  /* Bits indexed by enum mandoc_os. */
        enum mandoc_os    os_e;    /* Operating system. */

-};
-
-struct roff_man {
-       struct roff_meta  meta;    /* Document meta-data. */
-       struct mparse    *parse;   /* Parse pointer. */
-       struct roff      *roff;    /* Roff parser state data. */
-       struct ohash     *mdocmac; /* Mdoc macro lookup table. */
-       struct ohash     *manmac;  /* Man macro lookup table. */
-       const char       *os_s;    /* Default operating system. */
-       struct roff_node *first;   /* The first node parsed. */
-       struct roff_node *last;    /* The last node parsed. */
-       struct roff_node *last_es; /* The most recent Es node. */
-       int               quick;   /* Abort parse early. */
-       int               flags;   /* Parse flags. */
-#define        MDOC_LITERAL     (1 << 1)  /* In a literal scope. */
-#define        MDOC_PBODY       (1 << 2)  /* In the document body. */
-#define        MDOC_NEWLINE     (1 << 3)  /* First macro/text in a line. */
-#define        MDOC_PHRASE      (1 << 4)  /* In a Bl -column phrase. */
-#define        MDOC_PHRASELIT   (1 << 5)  /* Literal within a phrase. */
-#define        MDOC_FREECOL     (1 << 6)  /* `It' invocation should close. */
-#define        MDOC_SYNOPSIS    (1 << 7)  /* SYNOPSIS-style formatting. */
-#define        MDOC_KEEP        (1 << 8)  /* In a word keep. */
-#define        MDOC_SMOFF       (1 << 9)  /* Spacing is off. */
-#define        MDOC_NODELIMC    (1 << 10) /* Disable closing delimiter handling. */
-#define        MAN_ELINE        (1 << 11) /* Next-line element scope. */
-#define        MAN_BLINE        (1 << 12) /* Next-line block scope. */
-#define        MDOC_PHRASEQF    (1 << 13) /* Quote first word encountered. */
-#define        MDOC_PHRASEQL    (1 << 14) /* Quote last word of this phrase. */
-#define        MDOC_PHRASEQN    (1 << 15) /* Quote first word of the next phrase. */
-#define        MAN_LITERAL       MDOC_LITERAL
-#define        MAN_NEWLINE       MDOC_NEWLINE

        enum roff_macroset macroset; /* Kind of high-level macros used. */
        enum roff_macroset macroset; /* Kind of high-level macros used. */

-       enum roff_sec     lastsec; /* Last section seen. */
-       enum roff_sec     lastnamed; /* Last standard section seen. */
-       enum roff_next    next;    /* Where to put the next node. */

 };
 
 extern const char *const *roff_name;
 
 
 };
 
 extern const char *const *roff_name;
 
 

-void            deroff(char **, const struct roff_node *);
-void            roff_validate(struct roff_man *);
+int              arch_valid(const char *, enum mandoc_os);
+void             deroff(char **, const struct roff_node *);
+struct roff_node *roff_node_child(struct roff_node *);
+struct roff_node *roff_node_next(struct roff_node *);
+struct roff_node *roff_node_prev(struct roff_node *);
+int              roff_node_transparent(struct roff_node *);
+int              roff_tok_transparent(enum roff_tok);