Annotation of src/usr.bin/mandoc/html.h, Revision 1.1
1.1 ! schwarze 1: /* $Id: html.h,v 1.13 2009/10/13 10:21:24 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_MAX
! 62: };
! 63:
! 64: struct tag {
! 65: enum htmltag tag;
! 66: SLIST_ENTRY(tag) entry;
! 67: };
! 68:
! 69: struct ord {
! 70: int pos;
! 71: const void *cookie;
! 72: SLIST_ENTRY(ord) entry;
! 73: };
! 74:
! 75: SLIST_HEAD(tagq, tag);
! 76: SLIST_HEAD(ordq, ord);
! 77:
! 78: struct htmlpair {
! 79: enum htmlattr key;
! 80: const char *val;
! 81: };
! 82:
! 83: #define PAIR_CLASS_INIT(p, v) \
! 84: do { (p)->key = ATTR_CLASS; \
! 85: (p)->val = (v); } while (/* CONSTCOND */ 0)
! 86: #define PAIR_HREF_INIT(p, v) \
! 87: do { (p)->key = ATTR_HREF; \
! 88: (p)->val = (v); } while (/* CONSTCOND */ 0)
! 89: #define PAIR_STYLE_INIT(p, h) \
! 90: do { (p)->key = ATTR_STYLE; \
! 91: (p)->val = (h)->buf; } while (/* CONSTCOND */ 0)
! 92:
! 93: struct html {
! 94: int flags;
! 95: #define HTML_NOSPACE (1 << 0)
! 96: #define HTML_NEWLINE (1 << 1)
! 97: #define HTML_IGNDELIM (1 << 2)
! 98: struct tagq tags;
! 99: struct ordq ords;
! 100: void *symtab;
! 101: char *base;
! 102: char *base_man;
! 103: char *base_includes;
! 104: char *style;
! 105: char buf[BUFSIZ];
! 106: size_t buflen;
! 107: };
! 108:
! 109: struct roffsu;
! 110:
! 111: void print_gen_doctype(struct html *);
! 112: void print_gen_head(struct html *);
! 113: struct tag *print_otag(struct html *, enum htmltag,
! 114: int, const struct htmlpair *);
! 115: void print_tagq(struct html *, const struct tag *);
! 116: void print_stagq(struct html *, const struct tag *);
! 117: void print_text(struct html *, const char *);
! 118:
! 119: void bufcat_su(struct html *, const char *,
! 120: const struct roffsu *);
! 121: void buffmt_man(struct html *,
! 122: const char *, const char *);
! 123: void buffmt_includes(struct html *, const char *);
! 124: void buffmt(struct html *, const char *, ...);
! 125: void bufcat(struct html *, const char *);
! 126: void bufcat_style(struct html *,
! 127: const char *, const char *);
! 128: void bufncat(struct html *, const char *, size_t);
! 129: void bufinit(struct html *);
! 130:
! 131: __END_DECLS
! 132:
! 133: #endif /*!HTML_H*/