In -Tman mode, support automatic word keeps in the SYNOPSIS

[mandoc.git] / term.h

diff --git a/term.h b/term.h
index 28c68b36b062db19ce13384fb4fcfe369cd76bde..3da11394bc20c249c8487839c9326e6f9ec71539 100644 (file)
--- a/term.h
+++ b/term.h
@@ -1,64 +1,129 @@
-/* $Id: term.h,v 1.3 2009/02/22 15:50:45 kristaps Exp $ */
+/*     $Id: term.h,v 1.92 2012/05/31 22:29:13 schwarze Exp $ */

 /*
 /*

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

  *
  * 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 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
 
  */
 #ifndef TERM_H
 #define TERM_H
 

-#include "mdoc.h"
-

 __BEGIN_DECLS
 
 __BEGIN_DECLS
 

+struct termp;
+
+enum   termenc {
+       TERMENC_ASCII,
+       TERMENC_LOCALE,
+       TERMENC_UTF8
+};
+
+enum   termtype {
+       TERMTYPE_CHAR,
+       TERMTYPE_PS,
+       TERMTYPE_PDF
+};
+
+enum   termfont {
+       TERMFONT_NONE = 0,
+       TERMFONT_BOLD,
+       TERMFONT_UNDER,
+       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 {

-       size_t            rmargin;
-       size_t            maxrmargin;
-       size_t            maxcols;
-       size_t            offset;
-       size_t            col;
+       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            rmargin;      /* Current right margin. */
+       size_t            maxrmargin;   /* Max right margin. */
+       int               maxcols;      /* Max size of buf. */
+       size_t            offset;       /* Margin offest. */
+       size_t            tabwidth;     /* Distance of tab positions. */
+       int               col;          /* Bytes in buf. */
+       size_t            viscol;       /* Chars on current line. */
+       int               overstep;     /* See termp_flushln(). */
+       int               skipvsp;      /* Vertical space to skip. */

        int               flags;
        int               flags;

-#define        TERMP_BOLD       (1 << 0)       /* Embolden words. */
-#define        TERMP_UNDERLINE  (1 << 1)       /* Underline words. */
+#define        TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */

 #define        TERMP_NOSPACE    (1 << 2)       /* No space before 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. */
-       char             *buf;
-};
-
-struct termact {
-       int             (*pre)(struct termp *,
-                               const struct mdoc_meta *,
-                               const struct mdoc_node *);
-       void            (*post)(struct termp *,
-                               const struct mdoc_meta *,
-                               const struct mdoc_node *);
+#define        TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */
+#define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
+#define        TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
+#define        TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
+#define        TERMP_HANG       (1 << 9)       /* See term_flushln(). */
+#define        TERMP_TWOSPACE   (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_KEEP       (1 << 14)      /* Keep words together. */
+#define        TERMP_PREKEEP    (1 << 15)      /* ...starting with the next one. */
+#define        TERMP_SKIPCHAR   (1 << 16)      /* Skip the next character. */
+       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);
+       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                     termprint(const struct mdoc_node *,
-                               const struct mdoc_meta *);
+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                     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);
+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);

 
 

-const  struct termact   *termacts;
+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