The CommonMark specification allows list markers fo the form "number) "

[mandoc.git] / term.h

diff --git a/term.h b/term.h
index bded62263e46645a11e6163c7472c7a785f36799..fabc117d64c33990479d28aea45311a4c36a4ab8 100644 (file)
--- a/term.h
+++ b/term.h
@@ -1,26 +1,20 @@
-/*     $Id: term.h,v 1.96 2013/12/24 23:04:36 schwarze Exp $ */
+/*     $Id: term.h,v 1.118 2015/11/07 14:01:16 schwarze Exp $ */

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

- * Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011-2015 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
  * copyright notice and this permission notice appear in all copies.
  *
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES

  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */

-#ifndef TERM_H
-#define TERM_H
-
-__BEGIN_DECLS
-
-struct termp;

 
 enum   termenc {
        TERMENC_ASCII,
 
 enum   termenc {
        TERMENC_ASCII,


@@ -44,7 +38,10 @@ enum termfont {
 
 #define        TERM_MAXMARGIN    100000 /* FIXME */
 
 
 #define        TERM_MAXMARGIN    100000 /* FIXME */
 

-typedef void   (*term_margin)(struct termp *, const void *);
+struct roff_meta;
+struct termp;
+
+typedef void   (*term_margin)(struct termp *, const struct roff_meta *);

 
 struct termp_tbl {
        int               width;        /* width in fixed chars */
 
 struct termp_tbl {
        int               width;        /* width in fixed chars */


@@ -54,9 +51,12 @@ struct       termp_tbl {
 struct termp {
        enum termtype     type;
        struct rofftbl    tbl;          /* table configuration */
 struct termp {
        enum termtype     type;
        struct rofftbl    tbl;          /* table configuration */

+       int               synopsisonly; /* print the synopsis only */

        int               mdocstyle;    /* imitate mdoc(7) output */
        int               mdocstyle;    /* imitate mdoc(7) output */

+       size_t            line;         /* Current output line number. */

        size_t            defindent;    /* Default indent for text. */
        size_t            defrmargin;   /* Right margin of the device. */
        size_t            defindent;    /* Default indent for text. */
        size_t            defrmargin;   /* Right margin of the device. */

+       size_t            lastrmargin;  /* Right margin before the last ll. */

        size_t            rmargin;      /* Current right margin. */
        size_t            maxrmargin;   /* Max right margin. */
        size_t            maxcols;      /* Max size of buf. */
        size_t            rmargin;      /* Current right margin. */
        size_t            maxrmargin;   /* Max right margin. */
        size_t            maxcols;      /* Max size of buf. */


@@ -68,23 +68,27 @@ struct      termp {
        int               overstep;     /* See termp_flushln(). */
        int               skipvsp;      /* Vertical space to skip. */
        int               flags;
        int               overstep;     /* See termp_flushln(). */
        int               skipvsp;      /* Vertical space to skip. */
        int               flags;

-#define        TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */
-#define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
-#define        TERMP_NONOSPACE  (1 << 3)       /* No space (no autounset). */
-#define        TERMP_KEEP       (1 << 5)       /* Keep words together. */
-#define        TERMP_PREKEEP    (1 << 6)       /* ...starting with the next one. */
-#define        TERMP_SKIPCHAR   (1 << 7)       /* Skip the next character. */
+#define        TERMP_SENTENCE   (1 << 0)       /* Space before a sentence. */
+#define        TERMP_NOSPACE    (1 << 1)       /* No space before words. */
+#define        TERMP_NONOSPACE  (1 << 2)       /* No space (no autounset). */
+#define        TERMP_NBRWORD    (1 << 3)       /* Make next word nonbreaking. */
+#define        TERMP_KEEP       (1 << 4)       /* Keep words together. */
+#define        TERMP_PREKEEP    (1 << 5)       /* ...starting with the next one. */
+#define        TERMP_BACKAFTER  (1 << 6)       /* Back up after next character. */
+#define        TERMP_BACKBEFORE (1 << 7)       /* Back up before next character. */

 #define        TERMP_NOBREAK    (1 << 8)       /* See term_flushln(). */
 #define        TERMP_NOBREAK    (1 << 8)       /* See term_flushln(). */

-#define        TERMP_DANGLE     (1 << 9)       /* See term_flushln(). */
-#define        TERMP_HANG       (1 << 10)      /* See term_flushln(). */
-#define        TERMP_NOSPLIT    (1 << 11)      /* See termp_an_pre/post(). */
-#define        TERMP_SPLIT      (1 << 12)      /* See termp_an_pre/post(). */
-#define        TERMP_ANPREC     (1 << 13)      /* See termp_an_pre(). */
+#define        TERMP_BRTRSP     (1 << 9)       /* See term_flushln(). */
+#define        TERMP_BRIND      (1 << 10)      /* See term_flushln(). */
+#define        TERMP_DANGLE     (1 << 11)      /* See term_flushln(). */
+#define        TERMP_HANG       (1 << 12)      /* See term_flushln(). */
+#define        TERMP_NOSPLIT    (1 << 13)      /* Do not break line before .An. */
+#define        TERMP_SPLIT      (1 << 14)      /* Break line before .An. */
+#define        TERMP_NONEWLINE  (1 << 15)      /* No line break in nofill mode. */

        int              *buf;          /* Output buffer. */
        enum termenc      enc;          /* Type of encoding. */
        int              *buf;          /* Output buffer. */
        enum termenc      enc;          /* Type of encoding. */

-       struct mchars    *symtab;       /* Encoded-symbol table. */

        enum termfont     fontl;        /* Last font set. */
        enum termfont     fontl;        /* Last font set. */

-       enum termfont     fontq[10];    /* Symmetric fonts. */
+       enum termfont    *fontq;        /* Symmetric fonts. */
+       int               fontsz;       /* Allocated size of font stack */

        int               fonti;        /* Index of font stack. */
        term_margin       headf;        /* invoked to print head */
        term_margin       footf;        /* invoked to print foot */
        int               fonti;        /* Index of font stack. */
        term_margin       headf;        /* invoked to print head */
        term_margin       footf;        /* invoked to print foot */


@@ -93,13 +97,20 @@ struct      termp {
        void            (*end)(struct termp *);
        void            (*endline)(struct termp *);
        void            (*advance)(struct termp *, size_t);
        void            (*end)(struct termp *);
        void            (*endline)(struct termp *);
        void            (*advance)(struct termp *, size_t);

+       void            (*setwidth)(struct termp *, int, int);

        size_t          (*width)(const struct termp *, int);
        size_t          (*width)(const struct termp *, int);

-       double          (*hspan)(const struct termp *,
+       int             (*hspan)(const struct termp *,

                                const struct roffsu *);
        const void       *argf;         /* arg for headf/footf */
        struct termp_ps  *ps;
 };
 
                                const struct roffsu *);
        const void       *argf;         /* arg for headf/footf */
        struct termp_ps  *ps;
 };
 

+
+struct tbl_span;
+struct eqn;
+
+const char      *ascii_uc2str(int);
+

 void             term_eqn(struct termp *, const struct eqn *);
 void             term_tbl(struct termp *, const struct tbl_span *);
 void             term_free(struct termp *);
 void             term_eqn(struct termp *, const struct eqn *);
 void             term_tbl(struct termp *, const struct tbl_span *);
 void             term_free(struct termp *);


@@ -107,25 +118,18 @@ void                term_newln(struct termp *);
 void             term_vspace(struct termp *);
 void             term_word(struct termp *, const char *);
 void             term_flushln(struct termp *);
 void             term_vspace(struct termp *);
 void             term_word(struct termp *, const char *);
 void             term_flushln(struct termp *);

-void             term_begin(struct termp *, term_margin, 
-                       term_margin, const void *);
+void             term_begin(struct termp *, term_margin,
+                       term_margin, const struct roff_meta *);

 void             term_end(struct termp *);
 
 void             term_end(struct termp *);
 

-size_t           term_hspan(const struct termp *, 
-                       const struct roffsu *);
-size_t           term_vspan(const struct termp *,
-                       const struct roffsu *);
+void             term_setwidth(struct termp *, const char *);
+int              term_hspan(const struct termp *, const struct roffsu *);
+int              term_vspan(const struct termp *, const struct roffsu *);

 size_t           term_strlen(const struct termp *, const char *);
 size_t           term_len(const struct termp *, size_t);
 
 size_t           term_strlen(const struct termp *, const char *);
 size_t           term_len(const struct termp *, size_t);
 

-enum termfont    term_fonttop(struct termp *);
-const void      *term_fontq(struct termp *);

 void             term_fontpush(struct termp *, enum termfont);
 void             term_fontpop(struct termp *);
 void             term_fontpush(struct termp *, enum termfont);
 void             term_fontpop(struct termp *);

-void             term_fontpopq(struct termp *, const void *);
+void             term_fontpopq(struct termp *, int);

 void             term_fontrepl(struct termp *, enum termfont);
 void             term_fontlast(struct termp *);
 void             term_fontrepl(struct termp *, enum termfont);
 void             term_fontlast(struct termp *);

-
-__END_DECLS
-
-#endif /*!TERM_H*/