format.go (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | package htmlformat
import (
"bufio"
"fmt"
"io"
"strings"
"unicode"
"unicode/utf8"
"golang.org/x/net/html"
"golang.org/x/net/html/atom"
)
// Document formats a HTML document.
func Document(w io.Writer, r io.Reader) (err error) {
node, err := html.Parse(r)
if err != nil {
return err
}
return Nodes(w, []*html.Node{node})
}
// Fragment formats a fragment of a HTML document.
func Fragment(w io.Writer, r io.Reader) (err error) {
context := &html.Node{
Type: html.ElementNode,
}
nodes, err := html.ParseFragment(r, context)
if err != nil {
return err
}
return Nodes(w, nodes)
}
// Nodes formats a slice of HTML nodes.
func Nodes(w io.Writer, nodes []*html.Node) (err error) {
for _, node := range nodes {
if err = printNode(w, node, false, 0); err != nil {
return
}
}
return
}
// Is this node a tag with no end tag such as <meta> or <br>?
// http://www.w3.org/TR/html-markup/syntax.html#syntax-elements
func isVoidElement(n *html.Node) bool {
switch n.DataAtom {
case atom.Area, atom.Base, atom.Br, atom.Col, atom.Command, atom.Embed,
atom.Hr, atom.Img, atom.Input, atom.Keygen, atom.Link,
atom.Meta, atom.Param, atom.Source, atom.Track, atom.Wbr:
return true
}
return false
}
func isSpecialContentElement(n *html.Node) bool {
if n != nil {
switch n.DataAtom {
case atom.Style,
atom.Script:
return true
}
}
return false
}
func isEmptyTextNode(n *html.Node) bool {
return n.Type == html.TextNode && strings.TrimSpace(n.Data) == ""
}
func getFirstRune(s string) rune {
r, _ := utf8.DecodeRuneInString(s)
return r
}
func hasSingleTextChild(n *html.Node) bool {
return n != nil && n.FirstChild != nil && n.FirstChild == n.LastChild && n.FirstChild.Type == html.TextNode
}
func printNode(w io.Writer, n *html.Node, pre bool, level int) (err error) {
switch n.Type {
case html.TextNode:
if pre {
if _, err = fmt.Fprint(w, n.Data); err != nil {
return
}
return nil
}
s := n.Data
s = strings.TrimSpace(s)
if s != "" {
if !isSpecialContentElement(n.Parent) && !hasSingleTextChild(n.Parent) &&
(n.PrevSibling == nil || !unicode.IsPunct(getFirstRune(s))) {
if err = printIndent(w, level); err != nil {
return
}
}
if isSpecialContentElement(n.Parent) {
scanner := bufio.NewScanner(strings.NewReader(s))
for scanner.Scan() {
t := scanner.Text()
if _, err = fmt.Fprintln(w); err != nil {
return
}
if err = printIndent(w, level+1); err != nil {
return
}
if _, err = fmt.Fprint(w, t); err != nil {
return
}
}
if err = scanner.Err(); err != nil {
return
}
if _, err = fmt.Fprintln(w); err != nil {
return
}
} else {
if _, err = fmt.Fprint(w, s); err != nil {
return
}
if !hasSingleTextChild(n.Parent) {
if _, err = fmt.Fprint(w, "\n"); err != nil {
return
}
}
}
}
case html.ElementNode:
if err = printIndent(w, level); err != nil {
return
}
if _, err = fmt.Fprintf(w, "<%s", n.Data); err != nil {
return
}
for _, a := range n.Attr {
val := html.EscapeString(a.Val)
if _, err = fmt.Fprintf(w, ` %s="%s"`, a.Key, val); err != nil {
return
}
}
if _, err = fmt.Fprint(w, ">"); err != nil {
return
}
if !hasSingleTextChild(n) {
if _, err = fmt.Fprint(w, "\n"); err != nil {
return
}
}
if !isVoidElement(n) {
if err = printChildren(w, n, isPreFormatted(n.Data), level+1); err != nil {
return
}
if isSpecialContentElement(n) || !hasSingleTextChild(n) {
if err = printIndent(w, level); err != nil {
return
}
}
if _, err = fmt.Fprintf(w, "</%s>", n.Data); err != nil {
return
}
if n.NextSibling == nil ||
(!unicode.IsPunct(getFirstRune(n.NextSibling.Data)) || n.NextSibling.Type == html.ElementNode) {
if _, err = fmt.Fprint(w, "\n"); err != nil {
return
}
}
}
case html.CommentNode:
if err = printIndent(w, level); err != nil {
return
}
if _, err = fmt.Fprintf(w, "<!--%s-->\n", n.Data); err != nil {
return
}
if err = printChildren(w, n, false, level); err != nil {
return
}
case html.DoctypeNode, html.DocumentNode:
if err = printChildren(w, n, false, level); err != nil {
return
}
}
return
}
func isPreFormatted(s string) bool {
return s == "pre" || s == "script" || s == "style"
}
func printChildren(w io.Writer, n *html.Node, pre bool, level int) (err error) {
child := n.FirstChild
for child != nil {
if err = printNode(w, child, pre, level); err != nil {
return
}
child = child.NextSibling
}
return
}
func printIndent(w io.Writer, level int) (err error) {
_, err = fmt.Fprint(w, strings.Repeat(" ", level))
return err
}
|