HTMLReader 2.2.1

HTMLReader 2.2.1

×

TestsTested ✓
LangLanguage Obj-CObjective C
License NOASSERTION
ReleasedLast Release Oct 2022
SPMSupports SPM ✓

Maintained by Nolan Waite.

HTMLReader 2.2.1

  • By
  • Nolan Waite

HTMLReader

A WHATWG-compliant HTML parser with CSS selectors in Objective-C and Foundation. It parses HTML just like a browser.

Supports iOS, OS X, tvOS, and watchOS

Usage

A quick example of parsing an inline document and finding the bold text:

import HTMLReader

let document = HTMLDocument(string: """
    <p>
        Ahoy there, <b>sailor</b>!
    </p>
    """)
print(document.firstNode(matchingSelector: "b")?.textContent ?? "")
// => sailor

Manipulating a document is a little more involved, but entirely doable. Here we take the document from the first example and wrap the paragraph within a new element:

if
    let p = document.firstNode(matchingSelector: "p"),
    let parent = p.parent
{
    let wrapper = HTMLElement(tagName: "div", attributes: ["class": "special"])
    let children = parent.mutableChildren
    children.insert(wrapper, at: children.index(of: p))
    p.parent = wrapper
}

print(document.innerHTML)
// => <html><head></head><body><div class="special"><p>\
//        Ahoy there, <b>sailor</b>!\
//    </p></div></body></html>

You can save a document as a file:

let serialized = document.serializedFragment
let temp = FileManager.default.temporaryDirectory
let fileURL = temp.appendPathComponent("nifty.html", isDirectory: false)
do {
    try serialized.write(to: fileURL, atomically: true, encoding: .utf8)
} catch {
    print("Could not save nifty document", error)
}

Finally, the most involved example: fetching the main page for the HTMLReader repository and scraping the description of the project. (This is just an example; GitHub has a fabulous API that you should use if you want to find a repository's description!)

@import HTMLReader;

// Load a web page.
NSURL *url = [NSURL URLWithString:@"https://github.com/nolanw/HTMLReader"];
NSURLSession *session = [NSURLSession sharedSession];
[[session dataTaskWithURL:url completionHandler:
  ^(NSData *data, NSURLResponse *response, NSError *error) {
    NSString *contentType = nil;
    if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
        NSDictionary *headers = [(NSHTTPURLResponse *)response allHeaderFields];
        contentType = headers[@"Content-Type"];
    }
    HTMLDocument *home = [HTMLDocument documentWithData:data
                                      contentTypeHeader:contentType];
    HTMLElement *div = [home firstNodeMatchingSelector:@".repository-meta-content"];
    NSCharacterSet *whitespace = [NSCharacterSet whitespaceAndNewlineCharacterSet];
    NSLog(@"%@", [div.textContent stringByTrimmingCharactersInSet:whitespace]);
    // => A WHATWG-compliant HTML parser in Objective-C.
}] resume];

Installation

You have choices:

  • Copy the files in the Sources folder into your project.

  • Add the following line to your Cartfile:

    github "nolanw/HTMLReader"

  • Add the following line to your Podfile:

    pod "HTMLReader"

  • Add the following line to your Package.swift:

    .package(url: "https://github.com/nolanw/HTMLReader", from: "2.1.6")

  • Add the package in Xcode by selecting File > Swift Packages > Add Package Dependency and enter the URL https://github.com/nolanw/HTMLReader.

  • Clone this repository (perhaps add it as a submodule) and add HTMLReader.xcodeproj to your project/workspace. Then add HTMLReader.framework to your app target. (Or, if you're targeting iOS earlier than 8.0: add libHTMLReader.a to your app target and "$(SYMROOT)/include" to your app target's Header Search Paths.)

HTMLReader has no dependencies other than Foundation.

Why HTMLReader?

I needed to scrape HTML like a browser. I couldn't find a good choice for iOS.

The Alternatives

libxml2 ships with iOS. It parses some variant of HTML 4 (?) and does not handle new/broken markup like a modern browser.

Other Objective-C and Swift libraries I come across (e.g. Fuzi, hpple, Kanna, Ono) use libxml2 and inherit its shortcomings.

SwiftSoup is a Swift port of Jsoup. It didn't exist when I made HTMLReader. (To be fair, publicly, neither did Swift.)

There are C libraries such as Gumbo or Hubbub, but you need to shuffle data to and from Objective-C or Swift. (Also Gumbo wasn't publicly announced until after HTMLReader was far along.)

WebKit ships with iOS, but its HTML parsing abilities are considered private API. I consider a round-trip through a web view inappropriate for parsing HTML. And I didn't make it very far into building my own copy of WebCore.

Google Toolbox for Mac will escape and unescape strings for HTML (e.g. &amp; ⇔ &) but, again, not like a modern browser. For example, GTM will not unescape &#65 (note the missing semicolon).

CFStringTransform does numeric entities via (the reversible) kCFStringTransformToXMLHex, but that rules out named entities.

Does it work?

HTMLReader continually runs html5lib's tokenization and tree construction tests, ignoring the tests for <template> (which HTMLReader does not implement). Note that you need to check out the HTMLReaderTests/html5lib Git submodule in order to actually run these tests.

HTMLReader is continually built and tested on the SDKs available via GitHub Actions. It is intended work on down to iOS 5.0, macOS 10.7, tvOS 9.0, and watchOS 2.0, but there is no automated testing (it's ok to file an issue though!).

Given all that: Build Status

HTMLReader is used by at least one shipping app.

How fast is it?

I'm not sure.

Included in the project is a utility called Benchmarker. It knows how to run three tests:

  • Parsing a large HTML file. In this case, the 7MB single-page HTML specification.
  • Escaping and unescaping entities in the large HTML file.
  • Running a bunch of CSS selectors. Basically copied from a WebKit performance test.

Changes to HTMLReader should not cause these benchmarks to run slower. Ideally changes make them run faster!

Bugs and Feature Requests

Bugs can be reported, and features can be requested, using the issue tracker. Or get in touch directly if you'd prefer.

License

HTMLReader is in the public domain.

Acknowledgements

HTMLReader is developed by Nolan Waite.

Thanks to Chris Williams for contributing the implementation of CSS selectors.