contrib/mdocml/html.h

   1 /*      $Id: html.h,v 1.44 2011/05/17 11:34:31 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009, 2010 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_MAX
  79 };
  80
  81 struct  tag {
  82         struct tag       *next;
  83         enum htmltag      tag;
  84 };
  85
  86 struct tagq {
  87         struct tag       *head;
  88 };
  89
  90 struct  htmlpair {
  91         enum htmlattr     key;
  92         const char       *val;
  93 };
  94
  95 #define PAIR_INIT(p, t, v) \
  96         do { \
  97                 (p)->key = (t); \
  98                 (p)->val = (v); \
  99         } while (/* CONSTCOND */ 0)
 100
 101 #define PAIR_ID_INIT(p, v)      PAIR_INIT(p, ATTR_ID, v)
 102 #define PAIR_CLASS_INIT(p, v)   PAIR_INIT(p, ATTR_CLASS, v)
 103 #define PAIR_HREF_INIT(p, v)    PAIR_INIT(p, ATTR_HREF, v)
 104 #define PAIR_STYLE_INIT(p, h)   PAIR_INIT(p, ATTR_STYLE, (h)->buf)
 105 #define PAIR_SUMMARY_INIT(p, v) PAIR_INIT(p, ATTR_SUMMARY, v)
 106
 107 enum    htmltype {
 108         HTML_HTML_4_01_STRICT,
 109         HTML_XHTML_1_0_STRICT
 110 };
 111
 112 struct  html {
 113         int               flags;
 114 #define HTML_NOSPACE     (1 << 0) /* suppress next space */
 115 #define HTML_IGNDELIM    (1 << 1)
 116 #define HTML_KEEP        (1 << 2)
 117 #define HTML_PREKEEP     (1 << 3)
 118 #define HTML_NONOSPACE   (1 << 4) /* never add spaces */
 119 #define HTML_LITERAL     (1 << 5) /* literal (e.g., <PRE>) context */
 120         struct tagq       tags; /* stack of open tags */
 121         struct rofftbl    tbl; /* current table */
 122         struct tag       *tblt; /* current open table scope */
 123         struct mchars    *symtab; /* character-escapes */
 124         char             *base_man; /* base for manpage href */
 125         char             *base_includes; /* base for include href */
 126         char             *style; /* style-sheet URI */
 127         char              buf[BUFSIZ]; /* see bufcat and friends */
 128         size_t            buflen;
 129         struct tag       *metaf; /* current open font scope */
 130         enum htmlfont     metal; /* last used font */
 131         enum htmlfont     metac; /* current font mode */
 132         enum htmltype     type;
 133 };
 134
 135 void              print_gen_decls(struct html *);
 136 void              print_gen_head(struct html *);
 137 struct tag       *print_otag(struct html *, enum htmltag,
 138                                 int, const struct htmlpair *);
 139 void              print_tagq(struct html *, const struct tag *);
 140 void              print_stagq(struct html *, const struct tag *);
 141 void              print_text(struct html *, const char *);
 142 void              print_tblclose(struct html *);
 143 void              print_tbl(struct html *, const struct tbl_span *);
 144
 145 void              bufcat_fmt(struct html *, const char *, ...);
 146 void              bufcat(struct html *, const char *);
 147 void              bufcat_id(struct html *, const char *);
 148 void              bufcat_style(struct html *,
 149                         const char *, const char *);
 150 void              bufcat_su(struct html *, const char *,
 151                         const struct roffsu *);
 152 void              bufinit(struct html *);
 153 void              buffmt_man(struct html *,
 154                         const char *, const char *);
 155 void              buffmt_includes(struct html *, const char *);
 156
 157 int               html_strlen(const char *);
 158
 159 __END_DECLS
 160
 161 #endif /*!HTML_H*/