Sync section titles with OpenBSD.

[mandoc.git] / term.h

diff --git a/term.h b/term.h
index 7cbe91450c4b3c6727b3d3cbd6fb59964700d958..decd7f40649ef262dee975bad9c26b61c55734fe 100644 (file)
--- a/term.h
+++ b/term.h
@@ -1,6 +1,7 @@
-/*     $Id: term.h,v 1.36 2009/04/12 19:45:26 kristaps Exp $ */
+/*     $Id: term.h,v 1.101 2014/04/20 16:46:05 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011, 2012, 2013, 2014 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


@@ -17,49 +18,118 @@
 #ifndef TERM_H
 #define TERM_H
 
 #ifndef TERM_H
 #define TERM_H
 

-/* FIXME - clean up tabs. */
-
-#define        INDENT            5
-#define        HALFINDENT        3
-

 __BEGIN_DECLS
 
 __BEGIN_DECLS
 

+struct termp;
+

 enum   termenc {
        TERMENC_ASCII,
 enum   termenc {
        TERMENC_ASCII,

-       TERMENC_LATIN1,         /* Not implemented. */
-       TERMENC_UTF8            /* Not implemented. */
+       TERMENC_LOCALE,
+       TERMENC_UTF8
+};
+
+enum   termtype {
+       TERMTYPE_CHAR,
+       TERMTYPE_PS,
+       TERMTYPE_PDF
+};
+
+enum   termfont {
+       TERMFONT_NONE = 0,
+       TERMFONT_BOLD,
+       TERMFONT_UNDER,
+       TERMFONT_BI,
+       TERMFONT__MAX
+};
+
+#define        TERM_MAXMARGIN    100000 /* FIXME */
+
+typedef void   (*term_margin)(struct termp *, const void *);
+
+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               mdocstyle;    /* imitate mdoc(7) output */
+       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 << 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_NBRWORD    (1 << 4)       /* Make next word nonbreaking. */
+#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_NOBREAK    (1 << 8)       /* See term_flushln(). */
+#define        TERMP_BRIND      (1 << 9)       /* See term_flushln(). */
+#define        TERMP_DANGLE     (1 << 10)      /* See term_flushln(). */
+#define        TERMP_HANG       (1 << 11)      /* See term_flushln(). */
+#define        TERMP_NOSPLIT    (1 << 12)      /* See termp_an_pre/post(). */
+#define        TERMP_SPLIT      (1 << 13)      /* See termp_an_pre/post(). */
+#define        TERMP_ANPREC     (1 << 14)      /* See termp_an_pre(). */
+       int              *buf;          /* Output buffer. */

        enum termenc      enc;          /* Type of encoding. */
        enum termenc      enc;          /* Type of encoding. */

-       void             *symtab;       /* Encoded-symbol table. */
+       struct mchars    *symtab;       /* Encoded-symbol table. */
+       enum termfont     fontl;        /* Last font set. */
+       enum termfont     fontq[10];    /* Symmetric fonts. */
+       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, size_t);
+       size_t          (*width)(const struct termp *, int);
+       double          (*hspan)(const struct termp *,
+                               const struct roffsu *);
+       const void       *argf;         /* arg for headf/footf */
+       struct termp_ps  *ps;

 };
 
 };
 

-void            *term_ascii2htab(void);
-const char      *term_a2ascii(void *, const char *, size_t, size_t *);
-void             term_asciifree(void *);
-
+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_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 void *);
+void             term_end(struct termp *);
+
+void             term_setwidth(struct termp *, const char *);
+size_t           term_hspan(const struct termp *,
+                       const struct roffsu *);
+size_t           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);
+
+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_fontpopq(struct termp *, const void *);
+void             term_fontrepl(struct termp *, enum termfont);
+void             term_fontlast(struct termp *);

 
 __END_DECLS
 
 
 __END_DECLS