contrib/mdocml/html.h

   1 /*      $Id: html.h,v 1.51 2014/04/20 16:46:04 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   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.
  16  */
  17 #ifndef HTML_H
  18 #define HTML_H
  19
  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,
  36         TAG_TBODY,
  37         TAG_COL,
  38         TAG_TR,
  39         TAG_TD,
  40         TAG_LI,
  41         TAG_UL,
  42         TAG_OL,
  43         TAG_DL,
  44         TAG_DT,
  45         TAG_DD,
  46         TAG_BLOCKQUOTE,
  47         TAG_P,
  48         TAG_PRE,
  49         TAG_B,
  50         TAG_I,
  51         TAG_CODE,
  52         TAG_SMALL,
  53         TAG_MAX
  54 };
  55
  56 enum    htmlattr {
  57         ATTR_HTTPEQUIV,
  58         ATTR_CONTENT,
  59         ATTR_NAME,
  60         ATTR_REL,
  61         ATTR_HREF,
  62         ATTR_TYPE,
  63         ATTR_MEDIA,
  64         ATTR_CLASS,
  65         ATTR_STYLE,
  66         ATTR_WIDTH,
  67         ATTR_ID,
  68         ATTR_SUMMARY,
  69         ATTR_ALIGN,
  70         ATTR_COLSPAN,
  71         ATTR_MAX
  72 };
  73
  74 enum    htmlfont {
  75         HTMLFONT_NONE = 0,
  76         HTMLFONT_BOLD,
  77         HTMLFONT_ITALIC,
  78         HTMLFONT_BI,
  79         HTMLFONT_MAX
  80 };
  81
  82 struct  tag {
  83         struct tag       *next;
  84         enum htmltag      tag;
  85 };
  86
  87 struct tagq {
  88         struct tag       *head;
  89 };
  90
  91 struct  htmlpair {
  92         enum htmlattr     key;
  93         const char       *val;
  94 };
  95
  96 #define PAIR_INIT(p, t, v) \
  97         do { \
  98                 (p)->key = (t); \
  99                 (p)->val = (v); \
 100         } while (/* CONSTCOND */ 0)
 101
 102 #define PAIR_ID_INIT(p, v)      PAIR_INIT(p, ATTR_ID, v)
 103 #define PAIR_CLASS_INIT(p, v)   PAIR_INIT(p, ATTR_CLASS, v)
 104 #define PAIR_HREF_INIT(p, v)    PAIR_INIT(p, ATTR_HREF, v)
 105 #define PAIR_STYLE_INIT(p, h)   PAIR_INIT(p, ATTR_STYLE, (h)->buf)
 106 #define PAIR_SUMMARY_INIT(p, v) PAIR_INIT(p, ATTR_SUMMARY, v)
 107
 108 enum    htmltype {
 109         HTML_HTML_4_01_STRICT,
 110         HTML_XHTML_1_0_STRICT
 111 };
 112
 113 struct  html {
 114         int               flags;
 115 #define HTML_NOSPACE     (1 << 0) /* suppress next space */
 116 #define HTML_IGNDELIM    (1 << 1)
 117 #define HTML_KEEP        (1 << 2)
 118 #define HTML_PREKEEP     (1 << 3)
 119 #define HTML_NONOSPACE   (1 << 4) /* never add spaces */
 120 #define HTML_LITERAL     (1 << 5) /* literal (e.g., <PRE>) context */
 121 #define HTML_SKIPCHAR    (1 << 6) /* skip the next character */
 122         struct tagq       tags; /* stack of open tags */
 123         struct rofftbl    tbl; /* current table */
 124         struct tag       *tblt; /* current open table scope */
 125         struct mchars    *symtab; /* character-escapes */
 126         char             *base_man; /* base for manpage href */
 127         char             *base_includes; /* base for include href */
 128         char             *style; /* style-sheet URI */
 129         char              buf[BUFSIZ]; /* see bufcat and friends */
 130         size_t            buflen;
 131         struct tag       *metaf; /* current open font scope */
 132         enum htmlfont     metal; /* last used font */
 133         enum htmlfont     metac; /* current font mode */
 134         enum htmltype     type; /* output media type */
 135         int               oflags; /* output options */
 136 #define HTML_FRAGMENT    (1 << 0) /* don't emit HTML/HEAD/BODY */
 137 };
 138
 139 void              print_gen_decls(struct html *);
 140 void              print_gen_head(struct html *);
 141 struct tag       *print_otag(struct html *, enum htmltag,
 142                                 int, const struct htmlpair *);
 143 void              print_tagq(struct html *, const struct tag *);
 144 void              print_stagq(struct html *, const struct tag *);
 145 void              print_text(struct html *, const char *);
 146 void              print_tblclose(struct html *);
 147 void              print_tbl(struct html *, const struct tbl_span *);
 148 void              print_eqn(struct html *, const struct eqn *);
 149
 150 #if __GNUC__ - 0 >= 4
 151 __attribute__((__format__ (__printf__, 2, 3)))
 152 #endif
 153 void              bufcat_fmt(struct html *, const char *, ...);
 154 void              bufcat(struct html *, const char *);
 155 void              bufcat_id(struct html *, const char *);
 156 void              bufcat_style(struct html *,
 157                         const char *, const char *);
 158 void              bufcat_su(struct html *, const char *,
 159                         const struct roffsu *);
 160 void              bufinit(struct html *);
 161 void              buffmt_man(struct html *,
 162                         const char *, const char *);
 163 void              buffmt_includes(struct html *, const char *);
 164
 165 int               html_strlen(const char *);
 166
 167 __END_DECLS
 168
 169 #endif /*!HTML_H*/