Add example of comments in man.7 and mdoc.7.

[mandoc.git] / term.h

diff --git a/term.h b/term.h
index 09e24295484e9fadc4b7ec04e6923e671c8ab80b..16347aa1118a026d0a812268fb759391045be1ed 100644 (file)
--- a/term.h
+++ b/term.h
@@ -1,6 +1,6 @@
-/*     $Id: term.h,v 1.57 2010/05/24 21:51:20 schwarze Exp $ */
+/*     $Id: term.h,v 1.86 2011/07/22 10:50:46 kristaps Exp $ */

 /*
 /*

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

  *
  * 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


@@ -19,26 +19,46 @@
 
 __BEGIN_DECLS
 
 
 __BEGIN_DECLS
 

+struct termp;
+

 enum   termenc {
 enum   termenc {

-       TERMENC_ASCII
+       TERMENC_ASCII,
+       TERMENC_LOCALE,
+       TERMENC_UTF8
+};
+
+enum   termtype {
+       TERMTYPE_CHAR,
+       TERMTYPE_PS,
+       TERMTYPE_PDF

 };
 
 enum   termfont {
        TERMFONT_NONE = 0,
        TERMFONT_BOLD,
 };
 
 enum   termfont {
        TERMFONT_NONE = 0,
        TERMFONT_BOLD,

-       TERMFONT_UNDER
+       TERMFONT_UNDER,
+       TERMFONT__MAX

 };
 
 #define        TERM_MAXMARGIN    100000 /* FIXME */
 
 };
 
 #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            defrmargin;   /* Right margin of the device.. */
+       enum termtype     type;
+       struct rofftbl    tbl;          /* table configuration */
+       size_t            defrmargin;   /* Right margin of the device. */

        size_t            rmargin;      /* Current right margin. */
        size_t            maxrmargin;   /* Max right margin. */
        size_t            rmargin;      /* Current right margin. */
        size_t            maxrmargin;   /* Max right margin. */

-       size_t            maxcols;      /* Max size of buf. */
+       int               maxcols;      /* Max size of buf. */

        size_t            offset;       /* Margin offest. */
        size_t            tabwidth;     /* Distance of tab positions. */
        size_t            offset;       /* Margin offest. */
        size_t            tabwidth;     /* Distance of tab positions. */

-       size_t            col;          /* Bytes in buf. */
+       int               col;          /* Bytes in buf. */

        size_t            viscol;       /* Chars on current line. */
        int               overstep;     /* See termp_flushln(). */
        int               flags;
        size_t            viscol;       /* Chars on current line. */
        int               overstep;     /* See termp_flushln(). */
        int               flags;


@@ -54,21 +74,45 @@ struct      termp {
 #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_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(). */

-       char             *buf;          /* Output buffer. */
+#define        TERMP_KEEP       (1 << 14)      /* Keep words together. */
+#define        TERMP_PREKEEP    (1 << 15)      /* ...starting with the next one. */
+       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. */
        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             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 *);

 
 

-size_t           term_hspan(const struct roffsu *);
-size_t           term_vspan(const struct roffsu *);
+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 *);
 
 enum termfont    term_fonttop(struct termp *);
 const void      *term_fontq(struct termp *);