Lua bindings for the Gumbo HTML5 parsing library.
Work in progress. A versioned release will be made when the API has stabilized.
Running the html5lib tree-construction tests currently produces the following stats:
Passed: 1217
Failed: 3
Skipped: 115
By default, the Makefile will consult pkg-config for the appropriate Lua variables. Usually the following commands will be sufficient:
make
make check
[sudo] make install
However, if your Lua installation doesn't include a pkg-config file,
running make will simply complain and exit. In this case, the 3
relevant variables will have to be specified manually, for example:
make LUA_CFLAGS=-I/usr/include/lua5.2
make check
make install LUA_LMOD_DIR=/usr/share/lua/5.2 LUA_CMOD_DIR=/usr/lib/lua/5.2
The gumbo module provides two functions:
parse(html [, tab_stop])
Parses a string of UTF-8 encoded HTML and returns a Document node. The
optional tab_stop parameter specifies the size to use for tab
characters when computing source positions (default: 8).
parse_file(path_or_file [, tab_stop])
As above, but first reading input from an open file handle or opening and reading input from a filename specified as a string.
Either function may return nil and an error message on failure, which
can either be handled explicitly or wrapped with assert().
See also: find_links.lua and remove_by_id.lua.
The document node is the top-level table returned by the parse functions and contains all other nodes as descendants.
Fields:
type: Always has a value of"document"for document nodes.doctype: A table of fields parsed from the doctype declaration, ornil:name: The root element name.publicId: The public identifier, or"".systemId: The system identifier, or"".
quirks_mode: One of"quirks","no-quirks"or"limited-quirks".root: A reference to the child<html>element.[1..n]: Child nodes.
Element nodes are represented as tables, with child nodes stored in numeric indices.
Fields:
type: Always has a value of"element"for element nodes.tag: The tag name, normalized to lower case.tag_namespace: Either"html","svg"or"math".attr: A table of attributes.[1..n]: Tables, each representing a single attribute, in source order:name: The name of the attribute (normalized to lower case).value: The attribute value.namespace: Either"xlink","xml","xmlns"ornil.linecolumnoffset
["xyz"]: Thevalueof the attribute withname"xyz".
parse_flagslinecolumnoffset[1..n]: Child nodes.
Methods:
attr_iter: returns an iterator that produces the valuesindex, name, value, namespace, line, column, offsetfor each of the element's attributes. See: find_links.lua.
There are 4 text node types, which all share a common structure.
Fields:
type: One of"text","whitespace","comment"or"cdata".text: The text contents. Does not include comment/cdata delimiters.linecolumnoffset
make check: run the lua-gumbo functional tests.make check-html5lib: run the html5lib tree-construction tests.
Copyright (c) 2013-2014, Craig Barnes.
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.