Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
itod committed Jan 27, 2010
1 parent d96aedc commit 6d21b9a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.textile
Expand Up @@ -3,17 +3,16 @@ h1. "ParseKit - Cocoa Objective-C Framework for parsing, tokenizing and language
ParseKit is a Mac OS X Framework written by Todd Ditchendorf in Objective-C 2.0 and released under the MIT Open Source License. ParseKit is suitable for use on Mac OS X Leopard, Snow Leopard or "iPhone OS":iphone.html. ParseKit is an Objective-C implementation of the tools described in ""Building Parsers with Java" (Amazon.com: Building Parsers With Java[TM]: Steven John Metsker: Books)":http://www.amazon.com/Building-Parsers-Java-Steven-Metsker/dp/0201719622 by Steven John Metsker. ParseKit includes additional features beyond the designs from the book and also some changes to match common Cocoa/Objective-C conventions. These changes are relatively superficial, however, and Metsker's book is the best documentation available for ParseKit.
The ParseKit Framework offers 3 basic services of general interest to Cocoa developers:

**"String Tokenization":/tokenization.html** via the Objective-C PKTokenizer and PKToken classes.
**High-Level Language Parsing via Objective-C** - An Objective-C parser-building API (the PKParser class and sublcasses).
**"Objective-C Parser Generation via Grammars":grammars.html** - Generate an Objective-C parser for your custom language using a "BNF":http://en.wikipedia.org/wiki/Backus%E2%80%93Naur_Form-style grammar syntax (similar to yacc or ANTLR). While parsing, the parser will provide callbacks to your Objective-C code.
1. **"String Tokenization":/tokenization.html** via the Objective-C PKTokenizer and PKToken classes.
2. **High-Level Language Parsing via Objective-C** - An Objective-C parser-building API (the PKParser class and sublcasses).
3. **"Objective-C Parser Generation via Grammars":grammars.html** - Generate an Objective-C parser for your custom language using a "BNF":http://en.wikipedia.org/wiki/Backus%E2%80%93Naur_Form-style grammar syntax (similar to yacc or ANTLR). While parsing, the parser will provide callbacks to your Objective-C code.

The ParseKit source code is available from the "Subversion repository":http://code.google.com/p/todparsekit/source/checkout at the "Google Code project page":http://code.google.com/p/todparsekit/. The latest tagged (stable) version is recommended. p{=margin-bottom:40px;}. svn co http://todparsekit.googlecode.com/svn/tags/release-1.5-tag
More documentation:

"Instructions for including ParseKit in your iPhone OS app":iphone.html
"Doxygen-generated Header Docs":doxygen/
h2. More documentation:

Projects using ParseKit:
* "Instructions for including ParseKit in your iPhone OS app":iphone.html

h2. Projects using ParseKit:

"Spike":http://lucidmac.com/products/spike: A Rails log file viewer/analyzer by Matt Mower
"JSTalk":http://github.com/ccgus/jstalk/tree/master: Interprocess Cocoa scripting with JavaScript by Gus Mueller
Expand All @@ -37,6 +36,7 @@ The ParseKit Xcode project consists of 6 targets:
h2. ParseKit Framework

h3. Tokenization

The API for tokenization is provided by the PKTokenizer class. Cocoa developers will be familiar with the NSScanner class provided by the Foundation Framework which provides a similar service. However, the PKTokenizer class is simpler and more powerful for many use cases.
Example usage:

Expand Down

0 comments on commit 6d21b9a

Please sign in to comment.