usr.bin/mandoc/html.h

   1 /*      $Id: html.h,v 1.21 2009/11/16 06:07:49 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
   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_P,
  32         TAG_SPAN,
  33         TAG_LINK,
  34         TAG_BR,
  35         TAG_A,
  36         TAG_TABLE,
  37         TAG_COL,
  38         TAG_TR,
  39         TAG_TD,
  40         TAG_LI,
  41         TAG_UL,
  42         TAG_OL,
  43         TAG_BASE,
  44         TAG_MAX
  45 };
  46
  47 enum    htmlattr {
  48         ATTR_HTTPEQUIV,
  49         ATTR_CONTENT,
  50         ATTR_NAME,
  51         ATTR_REL,
  52         ATTR_HREF,
  53         ATTR_TYPE,
  54         ATTR_MEDIA,
  55         ATTR_CLASS,
  56         ATTR_STYLE,
  57         ATTR_WIDTH,
  58         ATTR_VALIGN,
  59         ATTR_TARGET,
  60         ATTR_ID,
  61         ATTR_SUMMARY,
  62         ATTR_MAX
  63 };
  64
  65 enum    htmlfont {
  66         HTMLFONT_NONE = 0,
  67         HTMLFONT_BOLD,
  68         HTMLFONT_ITALIC,
  69         HTMLFONT_MAX
  70 };
  71
  72 struct  tag {
  73         struct tag       *next;
  74         enum htmltag      tag;
  75 };
  76
  77 struct  ord {
  78         struct ord       *next;
  79         const void       *cookie;
  80         int               pos;
  81 };
  82
  83 struct tagq {
  84         struct tag       *head;
  85 };
  86 struct ordq {
  87         struct ord       *head;
  88 };
  89
  90 struct  htmlpair {
  91         enum htmlattr     key;
  92         const char       *val;
  93 };
  94
  95 #define PAIR_CLASS_INIT(p, v) \
  96         do { (p)->key = ATTR_CLASS; \
  97         (p)->val = (v); } while (/* CONSTCOND */ 0)
  98 #define PAIR_HREF_INIT(p, v) \
  99         do { (p)->key = ATTR_HREF; \
 100         (p)->val = (v); } while (/* CONSTCOND */ 0)
 101 #define PAIR_STYLE_INIT(p, h) \
 102         do { (p)->key = ATTR_STYLE; \
 103         (p)->val = (h)->buf; } while (/* CONSTCOND */ 0)
 104 #define PAIR_SUMMARY_INIT(p, v) \
 105         do { (p)->key = ATTR_SUMMARY; \
 106         (p)->val = (v); } while (/* CONSTCOND */ 0)
 107
 108 struct  html {
 109         int               flags;
 110 #define HTML_NOSPACE     (1 << 0)
 111 #define HTML_IGNDELIM    (1 << 2)
 112         struct tagq       tags;
 113         struct ordq       ords;
 114         void             *symtab;
 115         char             *base;
 116         char             *base_man;
 117         char             *base_includes;
 118         char             *style;
 119         char              buf[BUFSIZ];
 120         size_t            buflen;
 121         struct tag       *metaf;
 122         enum htmlfont     metal;
 123         enum htmlfont     metac;
 124 };
 125
 126 struct  roffsu;
 127
 128 void              print_gen_doctype(struct html *);
 129 void              print_gen_head(struct html *);
 130 struct tag       *print_ofont(struct html *, enum htmlfont);
 131 struct tag       *print_otag(struct html *, enum htmltag,
 132                                 int, const struct htmlpair *);
 133 void              print_tagq(struct html *, const struct tag *);
 134 void              print_stagq(struct html *, const struct tag *);
 135 void              print_text(struct html *, const char *);
 136
 137 void              bufcat_su(struct html *, const char *,
 138                         const struct roffsu *);
 139 void              buffmt_man(struct html *,
 140                         const char *, const char *);
 141 void              buffmt_includes(struct html *, const char *);
 142 void              buffmt(struct html *, const char *, ...);
 143 void              bufcat(struct html *, const char *);
 144 void              bufcat_style(struct html *,
 145                         const char *, const char *);
 146 void              bufncat(struct html *, const char *, size_t);
 147 void              bufinit(struct html *);
 148
 149 void              html_idcat(char *, const char *, int);
 150
 151 __END_DECLS
 152
 153 #endif /*!HTML_H*/