package html

Import Path
	html (on golang.org and go.dev)

Dependency Relation
	imports 3 packages, and imported by 3 packages

Involved Source Files

	      entity.go
	   d➜ escape.go
		Package html provides functions for escaping and unescaping HTML text.
Code Examples

	EscapeString
		package main
		
		import (
			"fmt"
			"html"
		)
		
		func main() {
			const s = `"Fran & Freddie's Diner" `
			fmt.Println(html.EscapeString(s))
		}


	UnescapeString
		package main
		
		import (
			"fmt"
			"html"
		)
		
		func main() {
			const s = `"Fran & Freddie's Diner" <[email protected]>`
			fmt.Println(html.UnescapeString(s))
		}


Package-Level Functions (total 4, in which 2 are exported)

	 func EscapeString(s string) string
		EscapeString escapes special characters like "<" to become "&lt;". It
		escapes only five such characters: <, >, &, ' and ".
		UnescapeString(EscapeString(s)) == s always holds, but the converse isn't
		always true.

	 func UnescapeString(s string) string
		UnescapeString unescapes entities like "&lt;" to become "<". It unescapes a
		larger range of entities than EscapeString escapes. For example, "&aacute;"
		unescapes to "á", as does "&#225;" and "&#xE1;".
		UnescapeString(EscapeString(s)) == s always holds, but the converse isn't
		always true.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func populateMaps()
		populateMaps populates entity and entity2.

	 func unescapeEntity(b []byte, dst, src int) (dst1, src1 int)
		unescapeEntity reads an entity like "&lt;" from b[src:] and writes the
		corresponding "<" to b[dst:], returning the incremented dst and src cursors.
		Precondition: b[src] == '&' && dst <= src.


Package-Level Variables (total 5, none are exported)

	/* 5 unexporteds ... *//* 5 unexporteds: */
	  var entity map[string]rune
		entity is a map from HTML entity names to their values. The semicolon matters:
		https://html.spec.whatwg.org/multipage/named-characters.html
		lists both "amp" and "amp;" as two separate entries.

		Note that the HTML5 list is larger than the HTML4 list at
		http://www.w3.org/TR/html4/sgml/entities.html

	  var entity2 map[string][2]rune
		HTML entities that are two unicode codepoints.

	  var htmlEscaper *strings.Replacer
	  var populateMapsOnce sync.Once
		populateMapsOnce guards calling populateMaps.

	  var replacementTable [32]rune
		These replacements permit compatibility with old numeric entities that
		assumed Windows-1252 encoding.
		https://html.spec.whatwg.org/multipage/parsing.html#numeric-character-reference-end-state


Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const longestEntityWithoutSemicolon = 6
		All entities that do not end with ';' are 6 or fewer bytes long.

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.