Expose sync interface, add docs/tests

Author: hughsk

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.DS_Store
+npm-debug.log

.npmignore

@@ -1 +1 @@
-node_modules/
+test

LICENSE.md

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2014 [Chris Dickinson](http://github.com/chrisdickinson)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,67 +1,83 @@
-glsl-parser
-===========
+# glsl-parser
 
-a through stream that takes tokens from [glsl-tokenizer](https://github.com/chrisdickinson/glsl-tokenizer) and turns them into
+![](http://img.shields.io/badge/stability-stable-green.svg?style=flat)
+![](http://img.shields.io/npm/v/glsl-parser.svg?style=flat)
+![](http://img.shields.io/npm/dm/glsl-parser.svg?style=flat)
+![](http://img.shields.io/npm/l/glsl-parser.svg?style=flat)
+
+A GLSL parser that takes tokens from
+[glsl-tokenizer](http://github.com/stackgl/glsl-tokenizer) and turns them into
 an AST.
 
-```javascript
+May either be used as a stream
+
+## API
 
-var tokenizer = require('glsl-tokenizer')()
-  , fs = require('fs')
-  , parser = require('./index')
+### `stream = require('glsl-parser/stream')`
 
-var num = 0
+Creates a GLSL parser stream, which emits nodes as they're parsed.
+
+``` javascript
+var TokenStream = require('glsl-tokenizer/stream')
+var ParseStream = require('glsl-parser/stream')
+var fs = require('fs')
 
 fs.createReadStream('test.glsl')
-  .pipe(tokenizer)
-  .pipe(parser())
+  .pipe(TokenStream())
+  .pipe(ParseStream())
   .on('data', function(x) {
     console.log('ast of', x.type)
   })
-
 ```
 
-similar to [JSONStream](https://github.com/dominictarr/JSONStream), you may pass selectors
-into the constructor to match only AST elements at that level. viable selectors are strings
-and regexen, and they'll be matched against the emitted node's `type`.
+### `ast = stream.program`
 
-nodes
------
+The full program's AST, which will be updated with each incoming token.
 
-```
+### `ast = require('glsl-parser/direct')(tokens)`
 
-stmtlist
-stmt
-struct
-function
-functionargs
-decl
-decllist
-forloop
-whileloop
-if
-expr
-precision
-comment
-preprocessor
-keyword
-ident
-return
-continue
-break
-discard
-do-while
-binary
-ternary
-unary
+Synchronously parses an array of tokens from `glsl-tokenizer`.
 
-```
+``` javascript
+var TokenString = require('glsl-tokenizer/string')
+var ParseTokens = require('glsl-parser/direct')
+var fs = require('fs')
 
-legal & caveats
-===============
+var src = fs.readFileSync('test.glsl', 'utf8')
+var tokens = TokenString(src)
+var ast = ParseTokens(tokens)
+
+console.log(ast)
+```
 
-known bugs
-----------
+## Nodes
+
+* `stmtlist`
+* `stmt`
+* `struct`
+* `function`
+* `functionargs`
+* `decl`
+* `decllist`
+* `forloop`
+* `whileloop`
+* `if`
+* `expr`
+* `precision`
+* `comment`
+* `preprocessor`
+* `keyword`
+* `ident`
+* `return`
+* `continue`
+* `break`
+* `discard`
+* `do-while`
+* `binary`
+* `ternary`
+* `unary`
+
+## Known Issues
 
 * because i am not smart enough to write a fully streaming parser, the current parser "cheats" a bit when it encounters a `expr` node! it actually waits until it has all the tokens it needs to build a tree for a given expression, then builds it and emits the constituent child nodes in the expected order. the `expr` parsing is heavily influenced by [crockford's tdop article](http://javascript.crockford.com/tdop/tdop.html). the rest of the parser is heavily influenced by fever dreams.
 
@@ -73,7 +89,6 @@ might not be the case -- it might be a user-defined constructor starting a state
 if you've got unhygenic macros in your code, move the #if / #endifs to statement level, and have them surround
 wholly parseable code. this sucks, and i am sorry.
 
-license
--------
+## License
 
-MIT
+MIT, see [LICENSE.md](LICENSE.md) for more details.

direct.js

@@ -0,0 +1,13 @@
+var parse = require('./lib/index')
+
+module.exports = parseArray
+
+function parseArray(tokens) {
+  var parser = parse()
+
+  for (var i = 0; i < tokens.length; i++) {
+    parser(tokens[i])
+  }
+
+  return parser(null)
+}