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

[mandoc.git] / term.h

diff --git a/term.h b/term.h
index ac3699a1ab5fa1c753d91bdb7ad6dc4053e73162..fabc117d64c33990479d28aea45311a4c36a4ab8 100644 (file)
--- a/term.h
+++ b/term.h
@@ -1,103 +1,135 @@
-/* $Id: term.h,v 1.28 2009/03/19 16:17:27 kristaps Exp $ */
+/*     $Id: term.h,v 1.118 2015/11/07 14:01:16 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  *
  * 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.
+ * 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 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR 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.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * 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.

  */
  */

-#ifndef TERM_H
-#define TERM_H

 
 

-#include "mdoc.h"
+enum   termenc {
+       TERMENC_ASCII,
+       TERMENC_LOCALE,
+       TERMENC_UTF8
+};

 
 

-/* FIXME - clean up tabs. */
+enum   termtype {
+       TERMTYPE_CHAR,
+       TERMTYPE_PS,
+       TERMTYPE_PDF
+};

 
 

-#define        INDENT            6
+enum   termfont {
+       TERMFONT_NONE = 0,
+       TERMFONT_BOLD,
+       TERMFONT_UNDER,
+       TERMFONT_BI,
+       TERMFONT__MAX
+};

 
 

-__BEGIN_DECLS
+#define        TERM_MAXMARGIN    100000 /* FIXME */

 
 

-enum   termenc {
-       TERMENC_ASCII,
-       TERMENC_LATIN1,
-       TERMENC_UTF8
+struct roff_meta;
+struct termp;
+
+typedef void   (*term_margin)(struct termp *, const struct roff_meta *);
+
+struct termp_tbl {
+       int               width;        /* width in fixed chars */
+       int               decimal;      /* decimal point position */

 };
 
 struct termp {
 };
 
 struct termp {

+       enum termtype     type;
+       struct rofftbl    tbl;          /* table configuration */
+       int               synopsisonly; /* print the synopsis only */
+       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            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            offset;       /* Margin offest. */
        size_t            rmargin;      /* Current right margin. */
        size_t            maxrmargin;   /* Max right margin. */
        size_t            maxcols;      /* Max size of buf. */
        size_t            offset;       /* Margin offest. */

+       size_t            tabwidth;     /* Distance of tab positions. */

        size_t            col;          /* Bytes in buf. */
        size_t            col;          /* Bytes in buf. */

+       size_t            viscol;       /* Chars on current line. */
+       size_t            trailspace;   /* See termp_flushln(). */
+       int               overstep;     /* See termp_flushln(). */
+       int               skipvsp;      /* Vertical space to skip. */

        int               flags;
        int               flags;

-#define        TERMP_NOSPACE    (1 << 0)       /* No space before words. */
-#define        TERMP_NOLPAD     (1 << 1)       /* No leftpad before flush. */
-#define        TERMP_NOBREAK    (1 << 2)       /* No break after flush. */
-#define        TERMP_LITERAL    (1 << 3)       /* Literal words. */
-#define        TERMP_IGNDELIM   (1 << 4)       /* Delims like regulars. */
-#define        TERMP_NONOSPACE  (1 << 5)       /* No space (no autounset). */
-#define        TERMP_NONOBREAK  (1 << 7)       /* Don't newln NOBREAK. */
-#define        TERMP_STYLE       0x0300        /* Style mask. */
-#define        TERMP_BOLD       (1 << 8)       /* Styles... */
-#define        TERMP_UNDER      (1 << 9)
-       char             *buf;          /* Output buffer. */
+#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_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. */
        enum termenc      enc;          /* Type of encoding. */

-       void             *symtab;       /* Encoded-symbol table. */
-};
-
-/* XXX - clean this up. */
-
-struct termpair {
-       struct termpair  *ppair;
-       int               type;
-#define        TERMPAIR_FLAG    (1 << 0)
-       int               flag;
-       size_t            offset;
-       size_t            rmargin;
-       int               count;
+       enum termfont     fontl;        /* Last font set. */
+       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 */
+       void            (*letter)(struct termp *, int);
+       void            (*begin)(struct termp *);
+       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);
+       int             (*hspan)(const struct termp *,
+                               const struct roffsu *);
+       const void       *argf;         /* arg for headf/footf */
+       struct termp_ps  *ps;

 };
 
 };
 

-#define        TERMPAIR_SETFLAG(termp, p, fl) \
-       do { \
-               assert(! (TERMPAIR_FLAG & (p)->type)); \
-               (termp)->flags |= (fl); \
-               (p)->flag = (fl); \
-               (p)->type |= TERMPAIR_FLAG; \
-       } while (0)
-
-struct termact {
-       int     (*pre)(struct termp *, struct termpair *,
-                       const struct mdoc_meta *,
-                       const struct mdoc_node *);
-       void    (*post)(struct termp *, struct termpair *,
-                       const struct mdoc_meta *,
-                       const struct mdoc_node *);
-};

 
 

-void            *ascii2htab(void);
-const char      *a2ascii(void *, const char *, size_t, size_t *);
-void             asciifree(void *);
+struct tbl_span;
+struct eqn;

 
 

-void             newln(struct termp *);
-void             vspace(struct termp *);
-void             word(struct termp *, const char *);
-void             flushln(struct termp *);
-void             transcode(struct termp *, const char *, size_t);
-void             subtree(struct termp *, const struct mdoc_meta *, 
-                       const struct mdoc_node *); 
+const char      *ascii_uc2str(int);

 
 

-const  struct termact   *termacts;
+void             term_eqn(struct termp *, const struct eqn *);
+void             term_tbl(struct termp *, const struct tbl_span *);
+void             term_free(struct termp *);
+void             term_newln(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 struct roff_meta *);
+void             term_end(struct termp *);

 
 

-__END_DECLS
+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);

 
 

-#endif /*!TERM_H*/
+void             term_fontpush(struct termp *, enum termfont);
+void             term_fontpop(struct termp *);
+void             term_fontpopq(struct termp *, int);
+void             term_fontrepl(struct termp *, enum termfont);
+void             term_fontlast(struct termp *);