# Kanna(鉋)
Kanna(鉋) is an XML/HTML parser for cross-platform(macOS, iOS, tvOS, watchOS and Linux!).
It was inspired by [Nokogiri](https://github.com/sparklemotion/nokogiri)(鋸).
[](https://github.com/tid-kijyun/Kanna/actions/workflows/ci.yml)
[](https://developer.apple.com/resources/)
[](http://cocoadocs.org/docsets/Kanna/)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
[](LICENSE)
:information_source: [Documentation](http://tid-kijyun.github.io/Kanna/)
## Features
- [x] XPath 1.0 support for document searching
- [x] CSS3 selector support for document searching
- [x] Support for namespaces
- [x] Comprehensive test suite
## Installation for Swift 5
#### CocoaPods
Add the following to your `Podfile`:
```ruby
use_frameworks!
pod 'Kanna', '~> 5.2.2'
```
#### Carthage
Add the following to your `Cartfile`:
```ogdl
github "tid-kijyun/Kanna" ~> 5.2.2
```
For xcode 11.3 and earlier, the following settings are required.
1. In the project settings add `$(SDKROOT)/usr/include/libxml2` to the "header search paths" field
#### Swift Package Manager
1. Installing libxml2 to your computer:
```bash
// macOS: For xcode 11.3 and earlier, the following settings are required.
$ brew install libxml2
$ brew link --force libxml2
// Linux(Ubuntu):
$ sudo apt-get install libxml2-dev
```
2. Add the following to your `Package.swift`:
```swift
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "YourProject",
dependencies: [
.package(url: "https://github.com/tid-kijyun/Kanna.git", from: "5.2.2"),
],
targets: [
.target(
name: "YourTarget",
dependencies: ["Kanna"]),
]
)
```
```bash
$ swift build
```
*Note: When a build error occurs, please try run the following command:*
```bash
// Linux(Ubuntu)
$ sudo apt-get install pkg-config
```
#### Manual Installation
1. Add these files to your project:
[Kanna.swift](Source/Kanna.swift)
[CSS.swift](Source/CSS.swift)
[libxmlHTMLDocument.swift](Source/libxml/libxmlHTMLDocument.swift)
[libxmlHTMLNode.swift](Source/libxml/libxmlHTMLNode.swift)
[libxmlParserOption.swift](Source/libxml/libxmlParserOption.swift)
[Modules](Modules)
1. In the target settings add `$(SDKROOT)/usr/include/libxml2` to the `Search Paths > Header Search Paths` field
1. In the target settings add `$(SRCROOT)/Modules` to the `Swift Compiler - Search Paths > Import Paths` field
#### [Installation for swift 4](https://github.com/tid-kijyun/Kanna/blob/master/Documentation/InstallationForSwift4.md)
#### [Installation for swift 3](https://github.com/tid-kijyun/Kanna/blob/master/Documentation/InstallationForSwift3.md)
## Synopsis
```swift
import Kanna
let html = "..."
if let doc = try? HTML(html: html, encoding: .utf8) {
print(doc.title)
// Search for nodes by CSS
for link in doc.css("a, link") {
print(link.text)
print(link["href"])
}
// Search for nodes by XPath
for link in doc.xpath("//a | //link") {
print(link.text)
print(link["href"])
}
}
```
```swift
let xml = "..."
if let doc = try? Kanna.XML(xml: xml, encoding: .utf8) {
let namespaces = [
"o": "urn:schemas-microsoft-com:office:office",
"ss": "urn:schemas-microsoft-com:office:spreadsheet"
]
if let author = doc.at_xpath("//o:Author", namespaces: namespaces) {
print(author.text)
}
}
```
## Donation
If you like Kanna, please donate via GitHub sponsors or PayPal.
It is used to improve and maintain the library.
## License
The MIT License. See the LICENSE file for more information.