Merge pull request #34 from mattfenwick/master

Parser:  grammar, top-level parsing, terminology

grammar.md

@@ -0,0 +1,47 @@
+## Lexical syntax ##
+
+    OPEN-PAREN   :=   '('
+    
+    CLOSE-PAREN  :=   ')'
+    
+    OPEN-SQUARE  :=   '['
+    
+    CLOSE-SQUARE :=   ']'
+    
+    OPEN-CURLY   :=   '{'
+    
+    CLOSE-CURLY  :=   '}'
+    
+    WHITESPACE   :=   ' '  |  '\t'  |  '\n'  |  '\r'
+    
+    COMMENT      :=   ';'  ???
+    
+    STRING       :=   '"'  ???  '"'
+    
+    CONSTANT     :=   '*'  ???  '*'
+    
+    BOOLEAN      :=   'true'  |  'false'
+    
+    SYMBOL       :=   ???
+    
+    NUMBER       :=   ???
+    
+    HASH         :=   '#!'  ???
+
+
+## Grammar ## ([example](http://docs.python.org/2/reference/grammar.html))
+
+    Hy           :=  HASH  |  COMMENT  |  WHITESPACE  |  Expression
+
+    Expression   :=  OPEN-PAREN  Operator  Args  Close-Paren
+    
+    Operator     :=  ???
+    
+    Args         :=  Value(*)
+    
+    List         :=  OPEN-SQUARE  Value(*)  CLOSE-SQUARE
+    
+    Map          :=  OPEN-CURLY  ( Value  Value )(*)  CLOSE-CURLY
+    
+    Value        :=  STRING  |  CONSTANT  |  BOOLEAN  |  SYMBOL  |  NUMBER  |  Expression  |  List  |  Map
+ 

tests/lexer/test_basic_lexing.py

@@ -73,3 +73,8 @@ def test_full_recurse():
         ],
         ['fn1', 'foo', 'bar']
     ] == tokenize("(fn el (+ 1 2 (== 1 20) (- 1 1)))(fn1 foo bar)")
+
+    
+def test_string():
+    """ Lex a lone string """
+    assert ['"a string"'] == tokenize('"a string"')