[BACK]Return to html.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/html.h, Revision 1.52

1.52    ! schwarze    1: /*     $Id: html.h,v 1.51 2014/04/20 16:46:04 schwarze Exp $ */
1.1       kristaps    2: /*
1.46      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.6       kristaps    6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    8:  *
1.6       kristaps    9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16:  */
                     17: #ifndef HTML_H
                     18: #define HTML_H
                     19:
1.6       kristaps   20: __BEGIN_DECLS
                     21:
                     22: enum   htmltag {
                     23:        TAG_HTML,
                     24:        TAG_HEAD,
                     25:        TAG_BODY,
                     26:        TAG_META,
                     27:        TAG_TITLE,
                     28:        TAG_DIV,
                     29:        TAG_H1,
                     30:        TAG_H2,
                     31:        TAG_SPAN,
                     32:        TAG_LINK,
                     33:        TAG_BR,
                     34:        TAG_A,
                     35:        TAG_TABLE,
1.28      kristaps   36:        TAG_TBODY,
1.6       kristaps   37:        TAG_COL,
                     38:        TAG_TR,
                     39:        TAG_TD,
                     40:        TAG_LI,
                     41:        TAG_UL,
                     42:        TAG_OL,
1.28      kristaps   43:        TAG_DL,
                     44:        TAG_DT,
                     45:        TAG_DD,
1.29      kristaps   46:        TAG_BLOCKQUOTE,
1.30      kristaps   47:        TAG_P,
1.31      kristaps   48:        TAG_PRE,
1.32      kristaps   49:        TAG_B,
1.33      kristaps   50:        TAG_I,
1.34      kristaps   51:        TAG_CODE,
1.35      kristaps   52:        TAG_SMALL,
1.52    ! schwarze   53:        TAG_EM,
1.6       kristaps   54:        TAG_MAX
                     55: };
                     56:
                     57: enum   htmlattr {
                     58:        ATTR_HTTPEQUIV,
                     59:        ATTR_CONTENT,
                     60:        ATTR_NAME,
                     61:        ATTR_REL,
                     62:        ATTR_HREF,
                     63:        ATTR_TYPE,
                     64:        ATTR_MEDIA,
                     65:        ATTR_CLASS,
                     66:        ATTR_STYLE,
                     67:        ATTR_WIDTH,
1.11      kristaps   68:        ATTR_ID,
1.15      kristaps   69:        ATTR_SUMMARY,
1.32      kristaps   70:        ATTR_ALIGN,
1.39      kristaps   71:        ATTR_COLSPAN,
1.6       kristaps   72:        ATTR_MAX
                     73: };
                     74:
1.21      kristaps   75: enum   htmlfont {
                     76:        HTMLFONT_NONE = 0,
                     77:        HTMLFONT_BOLD,
                     78:        HTMLFONT_ITALIC,
1.49      schwarze   79:        HTMLFONT_BI,
1.21      kristaps   80:        HTMLFONT_MAX
                     81: };
                     82:
1.6       kristaps   83: struct tag {
1.14      kristaps   84:        struct tag       *next;
1.6       kristaps   85:        enum htmltag      tag;
                     86: };
                     87:
1.14      kristaps   88: struct tagq {
                     89:        struct tag       *head;
                     90: };
1.6       kristaps   91:
                     92: struct htmlpair {
                     93:        enum htmlattr     key;
1.13      kristaps   94:        const char       *val;
1.1       kristaps   95: };
                     96:
1.23      kristaps   97: #define        PAIR_INIT(p, t, v) \
                     98:        do { \
                     99:                (p)->key = (t); \
                    100:                (p)->val = (v); \
                    101:        } while (/* CONSTCOND */ 0)
                    102:
                    103: #define        PAIR_ID_INIT(p, v)      PAIR_INIT(p, ATTR_ID, v)
                    104: #define        PAIR_CLASS_INIT(p, v)   PAIR_INIT(p, ATTR_CLASS, v)
                    105: #define        PAIR_HREF_INIT(p, v)    PAIR_INIT(p, ATTR_HREF, v)
                    106: #define        PAIR_STYLE_INIT(p, h)   PAIR_INIT(p, ATTR_STYLE, (h)->buf)
                    107: #define        PAIR_SUMMARY_INIT(p, v) PAIR_INIT(p, ATTR_SUMMARY, v)
1.12      kristaps  108:
1.51      schwarze  109: enum   htmltype {
1.22      kristaps  110:        HTML_HTML_4_01_STRICT,
                    111:        HTML_XHTML_1_0_STRICT
                    112: };
                    113:
1.6       kristaps  114: struct html {
                    115:        int               flags;
1.40      kristaps  116: #define        HTML_NOSPACE     (1 << 0) /* suppress next space */
1.25      kristaps  117: #define        HTML_IGNDELIM    (1 << 1)
                    118: #define        HTML_KEEP        (1 << 2)
                    119: #define        HTML_PREKEEP     (1 << 3)
1.40      kristaps  120: #define        HTML_NONOSPACE   (1 << 4) /* never add spaces */
                    121: #define        HTML_LITERAL     (1 << 5) /* literal (e.g., <PRE>) context */
1.48      schwarze  122: #define        HTML_SKIPCHAR    (1 << 6) /* skip the next character */
1.38      kristaps  123:        struct tagq       tags; /* stack of open tags */
                    124:        struct rofftbl    tbl; /* current table */
1.39      kristaps  125:        struct tag       *tblt; /* current open table scope */
1.41      kristaps  126:        struct mchars    *symtab; /* character-escapes */
1.38      kristaps  127:        char             *base_man; /* base for manpage href */
                    128:        char             *base_includes; /* base for include href */
                    129:        char             *style; /* style-sheet URI */
                    130:        char              buf[BUFSIZ]; /* see bufcat and friends */
1.51      schwarze  131:        size_t            buflen;
1.35      kristaps  132:        struct tag       *metaf; /* current open font scope */
                    133:        enum htmlfont     metal; /* last used font */
                    134:        enum htmlfont     metac; /* current font mode */
1.47      kristaps  135:        enum htmltype     type; /* output media type */
                    136:        int               oflags; /* output options */
                    137: #define        HTML_FRAGMENT    (1 << 0) /* don't emit HTML/HEAD/BODY */
1.6       kristaps  138: };
1.12      kristaps  139:
1.22      kristaps  140: void             print_gen_decls(struct html *);
1.6       kristaps  141: void             print_gen_head(struct html *);
1.51      schwarze  142: struct tag      *print_otag(struct html *, enum htmltag,
1.6       kristaps  143:                                int, const struct htmlpair *);
                    144: void             print_tagq(struct html *, const struct tag *);
                    145: void             print_stagq(struct html *, const struct tag *);
                    146: void             print_text(struct html *, const char *);
1.39      kristaps  147: void             print_tblclose(struct html *);
1.37      kristaps  148: void             print_tbl(struct html *, const struct tbl_span *);
1.45      kristaps  149: void             print_eqn(struct html *, const struct eqn *);
1.1       kristaps  150:
1.50      joerg     151: #if __GNUC__ - 0 >= 4
                    152: __attribute__((__format__ (__printf__, 2, 3)))
                    153: #endif
1.44      kristaps  154: void             bufcat_fmt(struct html *, const char *, ...);
                    155: void             bufcat(struct html *, const char *);
                    156: void             bufcat_id(struct html *, const char *);
1.51      schwarze  157: void             bufcat_style(struct html *,
1.44      kristaps  158:                        const char *, const char *);
1.51      schwarze  159: void             bufcat_su(struct html *, const char *,
1.12      kristaps  160:                        const struct roffsu *);
1.44      kristaps  161: void             bufinit(struct html *);
1.51      schwarze  162: void             buffmt_man(struct html *,
1.12      kristaps  163:                        const char *, const char *);
1.10      kristaps  164: void             buffmt_includes(struct html *, const char *);
                    165:
1.42      kristaps  166: int              html_strlen(const char *);
1.16      kristaps  167:
1.1       kristaps  168: __END_DECLS
                    169:
                    170: #endif /*!HTML_H*/

CVSweb