A high-performance HTML5 parser with CSS selectors and DOM manipulation for the Ring programming language.
RingHTML is a powerful Ring library for parsing and manipulating HTML documents. It provides a simple and intuitive API for extracting data, navigating the DOM tree, and building HTML programmatically.
This project is made possible by the blazing-fast Lexbor HTML5 parser.
- High-Performance: Powered by Lexbor, one of the fastest HTML5 parsers available.
- CSS Selectors: Full support for CSS selectors (
#id,.class,tag,parent child, etc.). - DOM Navigation: Traverse parent, children, siblings, first/last child with ease.
- DOM Manipulation: Create, modify, insert, and remove nodes programmatically.
- Content Extraction: Extract text, HTML, innerHTML, and attributes from any element.
- Unicode Support: Full international character support for multilingual content.
Follow these instructions to get the RingHTML library up and running on your system.
- Ring: Ensure you have Ring language version 1.24 or higher installed.
ringpm install ring-html from ysdragonParsing HTML and extracting data is straightforward. Here's a simple example:
# Load the RingHTML library
load "html.ring"
# Parse an HTML document
doc = new HTML('
<html>
<body>
<h1 class="title">Welcome to RingHTML!</h1>
<div class="content">
<p>This is a <strong>powerful</strong> HTML parser.</p>
<ul>
<li><a href="/docs">Documentation</a></li>
<li><a href="/examples">Examples</a></li>
</ul>
</div>
</body>
</html>
')
# Find elements using CSS selectors
title = doc.find("h1.title")[1]
see "Title: " + title.text() + nl
# Extract all links
links = doc.find("a")
for link in links
see "Link: " + link.text() + " -> " + link.attr("href") + nl
nextFor more advanced examples, see the examples/ directory.
The main document parser class.
| Method | Description |
|---|---|
new HTML(html) |
Parse HTML string and create document |
find(selector) |
Find all elements matching CSS selector → [HTMLNode, ...] |
body() |
Get the <body> element → HTMLNode |
head() |
Get the <head> element → HTMLNode |
root() / html() |
Get the <html> root element → HTMLNode |
createNode(tagName) |
Create a new element → HTMLNode |
createTextNode(text) |
Create a new text node → HTMLNode |
Represents a DOM node with full navigation and manipulation capabilities.
| Method | Description |
|---|---|
text() |
Get combined text content of node and children |
html() |
Get outer HTML (includes the tag itself) |
innerHTML() |
Get inner HTML (children only) |
tag() |
Get tag name (e.g., "div", "p") |
| Method | Description |
|---|---|
attr(name) |
Get attribute value |
has_attr(name) |
Check if attribute exists → bool |
attributes() |
Get all attributes → [[name, value], ...] |
setAttribute(name, value) |
Set or update attribute |
removeAttribute(name) |
Remove an attribute |
| Method | Description |
|---|---|
find(selector) |
Find descendants matching selector |
parent() |
Get parent node |
children() |
Get all child nodes → [HTMLNode, ...] |
firstChild() |
Get first child element |
lastChild() |
Get last child element |
next_sibling() |
Get next sibling node |
prev_sibling() |
Get previous sibling node |
| Method | Description |
|---|---|
appendChild(node) |
Append a child node |
insertBefore(node) |
Insert node before this one |
insertAfter(node) |
Insert node after this one |
remove() |
Remove this node from DOM |
setInnerText(text) |
Set text content, replacing all children |
setInnerHTML(html) |
Set inner HTML, replacing all children |
If you want to contribute to the development of RingHTML or build it from source, follow these steps.
- CMake: Version 3.16 or higher.
- C Compiler: A C compiler compatible with your platform (e.g., GCC, Clang, MSVC).
- Ring: You need to have the Ring language source code available on your machine.
-
Clone the Repository:
git clone https://github.com/ysdragon/ring-html.git --recursive cd ring-html -
Set the
RINGEnvironment Variable: Before running CMake, set theRINGenvironment variable to point to the Ring language source code.- Windows (Command Prompt):
set RING=X:\path\to\ring
- Windows (PowerShell):
$env:RING = "X:\path\to\ring"
- Unix/Linux/macOS:
export RING=/path/to/ring
- Windows (Command Prompt):
-
Configure with CMake:
mkdir build cd build cmake .. -
Build the Project:
cmake --build .
The compiled library will be placed in the lib/<os>/<arch> directory.
| Platform | Architectures |
|---|---|
| Linux | amd64, arm64 |
| macOS | amd64, arm64 |
| FreeBSD | amd64, arm64 |
| Windows | x64, x86, ARM64 |
Contributions are welcome! If you have ideas for improvements or have found a bug, please open an issue or submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
![@github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=64&v=4){kind=small}