Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tryswift/TryParsec
Monadic Parser Combinator for try! Swift http://www.tryswiftconf.com/
https://github.com/tryswift/TryParsec
Last synced: 21 days ago
JSON representation
Monadic Parser Combinator for try! Swift http://www.tryswiftconf.com/
- Host: GitHub
- URL: https://github.com/tryswift/TryParsec
- Owner: tryswift
- License: mit
- Created: 2016-02-28T09:46:14.000Z (over 8 years ago)
- Default Branch: swift/5.0
- Last Pushed: 2019-06-08T23:46:44.000Z (over 5 years ago)
- Last Synced: 2024-07-31T21:55:12.920Z (4 months ago)
- Language: Swift
- Size: 120 KB
- Stars: 279
- Watchers: 12
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-combinator-parsers - TryParsec
README
# TryParsec
Monadic Parser Combinator for [try! Swift](http://www.tryswiftconf.com/).
- Inspired by Haskell [Attoparsec](https://hackage.haskell.org/package/attoparsec) & [Aeson](https://hackage.haskell.org/package/aeson), Swift [Argo](https://github.com/thoughtbot/Argo).
- Supports CSV, XML, JSON (+ mapping)
- Doesn't `try`, but please try :)
**NOTE:** This library is still in early development. Please see [TODO & FIXME](#todo--fixme).
## Quick Play
Open `Examples/TryParsecPlayground.playground`.
```bash
$ sudo gem install fastlane
$ fastlane play # prepares Xcode Playground
```
## How to use
```swift
// Simple Arithmetic
let ans = parseArithmetic(" ( 12 + 3 ) * 4+5").value
expect(ans) == 65
// CSV
let csv = parseCSV("foo,bar,baz\r\n1,22,333\r\n").value
expect(csv) == [["foo", "bar", "baz"], ["1", "22", "333"]]
// XML
let xmlString = "
Hello World😇]]>
"
let xml = parseXML(xmlString).value
expect(xml) == [.element("p", [XML.Attribute("class", "welcome")], [.element("a", [XML.Attribute("href", "underground.html"), XML.Attribute("target", "_blank")], [.text("Hello")]), .processingInstruction("php echo ' Cruel'; "), .text(" World"), .comment(" 💀 "), .text("💣->😇")])]
// JSON
let jsonString = "{ \"string\" : \"hello\", \"array\" : [1, \"two\", [true, null]] }"
let json = parseJSON(jsonString).value
expect(json) == JSON.object([
"string" : .string("hello"),
"array" : .array([.number(1), .string("two"), .array([.bool(true), .null])])
])
```
### JSON Decoding & Encoding
```swift
import Curry
struct Model: FromJSON, ToJSON
{
let string: String
let array: [Any]?
static func fromJSON(json: JSON) -> Result
{
return curry(self.init)
<^> json !! "string"
<*> json !? "array"
}
static func toJSON(model: Model) -> JSON
{
return toJSONObject([
"string" ~ model.string,
"array" ~ model.array
])
}
}
let jsonString = "{ \"string\" : \"hello\", \"array\" : [1, \"two\", [true, null]] }"
// JSON String -> Model
let decoded: Result = decode(jsonString)
// Model -> JSON String
let encoded: String = encode(decoded.value!)
```
For `curry`ing, see [thoughtbot/Curry](https://github.com/thoughtbot/Curry) for more information.
## Supported functions
- **Basic Operators:** `>>-`, `<^>`, `<*>`, `*>`, `<*`, `<|>`, `>`
- **Combinators:** `zeroOrOne`, `many`, `many1`, `manyTill`, `skipMany`, `skipMany1`, `sepBy`, `sepBy1`, `sepEndBy`, `sepEndBy1`, `count`, `chainl`, `chainl1`, `chainr`, `chainr1`
- **Text (UnicodeScalarView):** `peek`, `endOfInput`, `satisfy`, `skip`, `skipWhile`, `take`, `takeWhile`, `any`, `char`, `not`, `string`, `asciiCI`, `oneOf`, `noneOf`, `digit`, `hexDigit`, `lowerAlphabet`, `upperAlphabet`, `alphabet`, `alphaNum`, `space`, `skipSpaces`, `endOfLine`, `number`
## TODO & FIXME
- **Improve overall performance**
- Current JSON parsing is 70x~ slower than `NSJSONSerialization` (even with whole-module-optimization)
- Improve error reporting
- Support indent parser (e.g. YAML)
- Once [apple/swift](https://github.com/apple/swift) supports [Higher Kinded Types](https://en.wikipedia.org/wiki/Kind_(type_theory))...
- Support incremental input
- Remove workarounds e.g. reflection-based JSON encoding
## Acknowledgement
This library is heavily inspired by following developers & libraries:
- Bryan O'Sullivan: Author of [Attoparsec](https://hackage.haskell.org/package/attoparsec) & [Aeson](https://hackage.haskell.org/package/aeson) (Haskell)
- Daan Leijen: Author of [Parsec](https://hackage.haskell.org/package/parsec) (Haskell)
- thoughtbot: Author of [Argo](https://github.com/thoughtbot/Argo) (Swift JSON decoding library)
## References
- [Parser Combinators in Swift](https://realm.io/news/tryswift-yasuhiro-inami-parser-combinator/) (video)
- [Parser Combinator in Swift // Speaker Deck](https://speakerdeck.com/inamiy/parser-combinator-in-swift) (slide)
## Licence
[MIT](LICENSE)