Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helje5/swiftyexpat

Simple wrapper for the Expat XML parser.
https://github.com/helje5/swiftyexpat

expat-xml-parser swift xml-parser

Last synced: 2 months ago
JSON representation

Simple wrapper for the Expat XML parser.

Awesome Lists containing this project

README

        

# SwiftyExpat

![Swift2](https://img.shields.io/badge/swift-2-blue.svg)
![Swift4](https://img.shields.io/badge/swift-4-blue.svg)
![Swift5](https://img.shields.io/badge/swift-5-blue.svg)
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
![tuxOS](https://img.shields.io/badge/os-tuxOS-green.svg?style=flat)
![Travis](https://travis-ci.org/AlwaysRightInstitute/SwiftyExpat.svg?branch=develop)

Simple wrapper for the Expat XML parser.

### ChangeLog

2019-10-04: Update to work w/ Swift 5.1 (aka Xcode 11).

2018-04-27: Updated to work w/ Swift 4.0.3 (aka Xcode 9.2). Support for Swift Package Manager.

2015-12-09: Updated to work w/ Swift 2.1.1 (aka Xcode 7.3?).

20xx-yy-zz: Updated to work w/ Swift v0.2b5 (aka Xcode 7b5).

Note: The SwiftyExpat version for Swift 1.x was using a modified Expat which
used blocks instead of C function pointer callbacks. Swift 2 now supports C
function pointer calls and hence this project got rewritten for this.

### Targets

The project includes two targets:
- SwiftyExpat
- SwiftyExpatTests

(the SPM setup has `Expat` as an own target)

I suggest you start by looking at the SwiftyExpatTests.

#### SwiftyExpat

This is a tiny framework wth a small Swift class to make the API nicer.
Though this is not really necessary - Expat is reasonably easy to use from
Swift as-is.

```Swift
let p = Expat()
.onStartElement { name, attrs in print("<\(name) \(attrs)") }
.onEndElement { name in print(">\(name)") }
.onStartNamespace { prefix, uri in print("+NS[\(prefix)] = \(uri)") }
.onEndNamespace { prefix in print("-NS[\(prefix)]") }
.onError { error in print("ERROR: \(error)") }
p.write("world")
p.close()
```

The raw Expat API works like this:
```Swift
let p = XML_ParserCreate("UTF-8")
defer { XML_ParserFree(p) }

XML_SetStartElementHandler(p) { _, name, attrs in
print("start tag \(String.fromCString(name)!)")
}
XML_SetEndElementHandler (p) { _, name in
print("end tag \(String.fromCString(name)!)")
}

XML_Parse(p, "", 8, 0)
XML_Parse(p, "", 0, 1)
```
You get the idea ...

Note: The closures in the raw API cannot capture variables. If you need to pass
around context (very likely ...), you need to fill the regular Expat 'user data'
field (which the wrapper does, if you need an example).

#### SwiftyExpatTests

Just a tiny demo on how to invoke the parser.

### Contact

[@helje5](http://twitter.com/helje5) | [email protected]