-/* $Id: term.h,v 1.19 2009/03/04 14:41:40 kristaps Exp $ */
+/* $Id: term.h,v 1.100 2014/04/08 07:13:12 schwarze Exp $ */
/*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * 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 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 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.
*/
#ifndef TERM_H
#define TERM_H
-#include "mdoc.h"
-
-#define INDENT 6
-
__BEGIN_DECLS
-enum tsym {
- TERMSYM_RBRACK = 0,
- TERMSYM_LBRACK = 1,
- TERMSYM_LARROW = 2,
- TERMSYM_RARROW = 3,
- TERMSYM_UARROW = 4,
- TERMSYM_DARROW = 5,
- TERMSYM_LSQUOTE = 6,
- TERMSYM_RSQUOTE = 7,
- TERMSYM_SQUOTE = 8,
- TERMSYM_LDQUOTE = 9,
- TERMSYM_RDQUOTE = 10,
- TERMSYM_DQUOTE = 11,
- TERMSYM_LT = 12,
- TERMSYM_GT = 13,
- TERMSYM_LE = 14,
- TERMSYM_GE = 15,
- TERMSYM_EQ = 16,
- TERMSYM_NEQ = 17,
- TERMSYM_ACUTE = 18,
- TERMSYM_GRAVE = 19,
- TERMSYM_PI = 20,
- TERMSYM_PLUSMINUS = 21,
- TERMSYM_INF = 22,
- TERMSYM_INF2 = 23,
- TERMSYM_NAN = 24,
- TERMSYM_BAR = 25,
- TERMSYM_BULLET = 26,
- TERMSYM_AMP = 27,
- TERMSYM_EM = 28,
- TERMSYM_EN = 29,
- TERMSYM_COPY = 30,
- TERMSYM_ASTERISK = 31,
- TERMSYM_SLASH = 32,
- TERMSYM_HYPHEN = 33,
- TERMSYM_SPACE = 34,
- TERMSYM_PERIOD = 35,
- TERMSYM_BREAK = 36,
- TERMSYM_LANGLE = 37,
- TERMSYM_RANGLE = 38
-};
-
+struct termp;
-enum tstyle {
- TERMSTYLE_CLEAR = 0,
- TERMSTYLE_BOLD = 1,
- TERMSTYLE_UNDER = 2,
- TERMSTYLE_MAX = 3
+enum termenc {
+ TERMENC_ASCII,
+ TERMENC_LOCALE,
+ TERMENC_UTF8
};
-struct termsym {
- const char *sym;
- size_t sz;
+enum termtype {
+ TERMTYPE_CHAR,
+ TERMTYPE_PS,
+ TERMTYPE_PDF
};
-struct termp {
- size_t rmargin;
- size_t maxrmargin;
- size_t maxcols;
- size_t offset;
- size_t col;
- int flags;
-#define TERMP_BOLD (1 << 0) /* Embolden words. */
-#define TERMP_UNDERLINE (1 << 1) /* Underline words. */
-#define TERMP_NOSPACE (1 << 2) /* No space before words. */
-#define TERMP_NOLPAD (1 << 3) /* No leftpad before flush. */
-#define TERMP_NOBREAK (1 << 4) /* No break after flush. */
-#define TERMP_LITERAL (1 << 5) /* Literal words. */
-#define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */
-#define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
-#define TERMP_NONOBREAK (1 << 8)
- char *buf;
- struct termsym *symtab; /* Special-symbol table. */
- struct termsym *styletab; /* Style table. */
+enum termfont {
+ TERMFONT_NONE = 0,
+ TERMFONT_BOLD,
+ TERMFONT_UNDER,
+ TERMFONT_BI,
+ TERMFONT__MAX
};
-struct termpair {
- struct termpair *ppair;
- int type;
-#define TERMPAIR_FLAG (1 << 0)
- int flag;
- size_t offset;
- size_t rmargin;
- int count;
-};
+#define TERM_MAXMARGIN 100000 /* FIXME */
-#define TERMPAIR_SETFLAG(termp, p, fl) \
- do { \
- assert(! (TERMPAIR_FLAG & (p)->type)); \
- (termp)->flags |= (fl); \
- (p)->flag = (fl); \
- (p)->type |= TERMPAIR_FLAG; \
- } while (0)
+typedef void (*term_margin)(struct termp *, const void *);
-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 *);
+struct termp_tbl {
+ int width; /* width in fixed chars */
+ int decimal; /* decimal point position */
};
-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 *);
-
+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 tabwidth; /* Distance of tab positions. */
+ 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;
+#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. */
+ 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;
+};
-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 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
git.ckatri.com / mandoc.git / blobdiff