]> git.cameronkatri.com Git - mandoc.git/blobdiff - html.h
document new SEE ALSO .Xr warnings
[mandoc.git] / html.h
diff --git a/html.h b/html.h
index ef0e0d10b27af4cbf2fd2094d04d653352827004..1f0a16d30cf46844188c60aa0b48379548b5d5e8 100644 (file)
--- a/html.h
+++ b/html.h
@@ -1,6 +1,6 @@
-/*     $Id: html.h,v 1.21 2009/11/16 06:07:49 kristaps Exp $ */
+/*     $Id: html.h,v 1.53 2014/08/14 00:31:43 schwarze Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 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
@@ -28,19 +28,28 @@ enum        htmltag {
        TAG_DIV,
        TAG_H1,
        TAG_H2,
-       TAG_P,
        TAG_SPAN,
        TAG_LINK,
        TAG_BR,
        TAG_A,
        TAG_TABLE,
+       TAG_TBODY,
        TAG_COL,
        TAG_TR,
        TAG_TD,
        TAG_LI,
        TAG_UL,
        TAG_OL,
-       TAG_BASE,
+       TAG_DL,
+       TAG_DT,
+       TAG_DD,
+       TAG_BLOCKQUOTE,
+       TAG_P,
+       TAG_PRE,
+       TAG_B,
+       TAG_I,
+       TAG_CODE,
+       TAG_SMALL,
        TAG_MAX
 };
 
@@ -55,10 +64,10 @@ enum        htmlattr {
        ATTR_CLASS,
        ATTR_STYLE,
        ATTR_WIDTH,
-       ATTR_VALIGN,
-       ATTR_TARGET,
        ATTR_ID,
        ATTR_SUMMARY,
+       ATTR_ALIGN,
+       ATTR_COLSPAN,
        ATTR_MAX
 };
 
@@ -66,6 +75,7 @@ enum  htmlfont {
        HTMLFONT_NONE = 0,
        HTMLFONT_BOLD,
        HTMLFONT_ITALIC,
+       HTMLFONT_BI,
        HTMLFONT_MAX
 };
 
@@ -74,79 +84,85 @@ struct      tag {
        enum htmltag      tag;
 };
 
-struct ord {
-       struct ord       *next;
-       const void       *cookie;
-       int               pos;
-};
-
 struct tagq {
        struct tag       *head;
 };
-struct ordq {
-       struct ord       *head;
-};
 
 struct htmlpair {
        enum htmlattr     key;
        const char       *val;
 };
 
-#define        PAIR_CLASS_INIT(p, v) \
-       do { (p)->key = ATTR_CLASS; \
-       (p)->val = (v); } while (/* CONSTCOND */ 0)
-#define        PAIR_HREF_INIT(p, v) \
-       do { (p)->key = ATTR_HREF; \
-       (p)->val = (v); } while (/* CONSTCOND */ 0)
-#define        PAIR_STYLE_INIT(p, h) \
-       do { (p)->key = ATTR_STYLE; \
-       (p)->val = (h)->buf; } while (/* CONSTCOND */ 0)
-#define        PAIR_SUMMARY_INIT(p, v) \
-       do { (p)->key = ATTR_SUMMARY; \
-       (p)->val = (v); } while (/* CONSTCOND */ 0)
+#define        PAIR_INIT(p, t, v) \
+       do { \
+               (p)->key = (t); \
+               (p)->val = (v); \
+       } while (/* CONSTCOND */ 0)
+
+#define        PAIR_ID_INIT(p, v)      PAIR_INIT(p, ATTR_ID, v)
+#define        PAIR_CLASS_INIT(p, v)   PAIR_INIT(p, ATTR_CLASS, v)
+#define        PAIR_HREF_INIT(p, v)    PAIR_INIT(p, ATTR_HREF, v)
+#define        PAIR_STYLE_INIT(p, h)   PAIR_INIT(p, ATTR_STYLE, (h)->buf)
+#define        PAIR_SUMMARY_INIT(p, v) PAIR_INIT(p, ATTR_SUMMARY, v)
+
+enum   htmltype {
+       HTML_HTML_4_01_STRICT,
+       HTML_XHTML_1_0_STRICT
+};
 
 struct html {
        int               flags;
-#define        HTML_NOSPACE     (1 << 0)
-#define        HTML_IGNDELIM    (1 << 2)
-       struct tagq       tags;
-       struct ordq       ords;
-       void             *symtab;
-       char             *base;
-       char             *base_man;
-       char             *base_includes;
-       char             *style;
-       char              buf[BUFSIZ];
+#define        HTML_NOSPACE     (1 << 0) /* suppress next space */
+#define        HTML_IGNDELIM    (1 << 1)
+#define        HTML_KEEP        (1 << 2)
+#define        HTML_PREKEEP     (1 << 3)
+#define        HTML_NONOSPACE   (1 << 4) /* never add spaces */
+#define        HTML_LITERAL     (1 << 5) /* literal (e.g., <PRE>) context */
+#define        HTML_SKIPCHAR    (1 << 6) /* skip the next character */
+       struct tagq       tags; /* stack of open tags */
+       struct rofftbl    tbl; /* current table */
+       struct tag       *tblt; /* current open table scope */
+       struct mchars    *symtab; /* character-escapes */
+       char             *base_man; /* base for manpage href */
+       char             *base_includes; /* base for include href */
+       char             *style; /* style-sheet URI */
+       char              buf[BUFSIZ]; /* see bufcat and friends */
        size_t            buflen;
-       struct tag       *metaf;
-       enum htmlfont     metal;
-       enum htmlfont     metac;
+       struct tag       *metaf; /* current open font scope */
+       enum htmlfont     metal; /* last used font */
+       enum htmlfont     metac; /* current font mode */
+       enum htmltype     type; /* output media type */
+       int               oflags; /* output options */
+#define        HTML_FRAGMENT    (1 << 0) /* don't emit HTML/HEAD/BODY */
 };
 
-struct roffsu;
-
-void             print_gen_doctype(struct html *);
+void             print_gen_decls(struct html *);
 void             print_gen_head(struct html *);
-struct tag      *print_ofont(struct html *, enum htmlfont);
-struct tag      *print_otag(struct html *, enum htmltag, 
+struct tag      *print_otag(struct html *, enum htmltag,
                                int, const struct htmlpair *);
 void             print_tagq(struct html *, const struct tag *);
 void             print_stagq(struct html *, const struct tag *);
 void             print_text(struct html *, const char *);
-
-void             bufcat_su(struct html *, const char *, 
-                       const struct roffsu *);
-void             buffmt_man(struct html *, 
-                       const char *, const char *);
-void             buffmt_includes(struct html *, const char *);
-void             buffmt(struct html *, const char *, ...);
+void             print_tblclose(struct html *);
+void             print_tbl(struct html *, const struct tbl_span *);
+void             print_eqn(struct html *, const struct eqn *);
+
+#if __GNUC__ - 0 >= 4
+__attribute__((__format__ (__printf__, 2, 3)))
+#endif
+void             bufcat_fmt(struct html *, const char *, ...);
 void             bufcat(struct html *, const char *);
-void             bufcat_style(struct html *, 
+void             bufcat_id(struct html *, const char *);
+void             bufcat_style(struct html *,
                        const char *, const char *);
-void             bufncat(struct html *, const char *, size_t);
+void             bufcat_su(struct html *, const char *,
+                       const struct roffsu *);
 void             bufinit(struct html *);
+void             buffmt_man(struct html *,
+                       const char *, const char *);
+void             buffmt_includes(struct html *, const char *);
 
-void             html_idcat(char *, const char *, int);
+int              html_strlen(const char *);
 
 __END_DECLS