Merge branch 'master' into vital-module

Author: haya14busa

README.mkd

@@ -1,6 +1,38 @@
-# Vim Script Parsers
+# VimL Parsers
 
 [![Build Status](https://travis-ci.org/vim-jp/vim-vimlparser.svg?branch=master)](https://travis-ci.org/vim-jp/vim-vimlparser) [![codecov](https://codecov.io/gh/vim-jp/vim-vimlparser/branch/master/graph/badge.svg)](https://codecov.io/gh/vim-jp/vim-vimlparser)
 
+This is Vim script (a.k.a. VimL) parsers.
 
-TODO: write something.
+## Features
+
+The parser to make AST (Abstract Syntax Tree)
+
+## Supported languages
+
+This parser provide same feature for following languages.
+
+* Vim script
+* Python
+* Javascript 
+
+## Example
+
+All of interfaces are provided from vimlparser module. VimLParser parse into AST using StringReader, and Compiler to compile nodes.
+
+```vim
+let s:vimlparser = vimlparser#import()
+let code = [
+\ 'let s:message = printf("hello %d", 1+(2*3))'
+\]
+let r = s:StringReader.new(code)
+let p = s:VimLParser.new()
+let c = s:Compiler.new()
+echo join(c.compile(p.parse(r)), "\n")
+```
+
+This above code output following.
+
+```
+(let = s:message (printf "hello %d" (+ 1 (* 2 3))))
+```

autoload/vital/__vimlparser__/VimLParser.vim

@@ -452,6 +452,7 @@ function! s:VimLParser.parse(reader)
   let self.reader = a:reader
   let self.context = []
   let toplevel = s:Node(s:NODE_TOPLEVEL)
+  let toplevel.pos = self.reader.getpos()
   let toplevel.body = []
   call self.push_context(toplevel)
   while self.reader.peek() !=# '<EOF>'

js/vimlparser.js

@@ -669,6 +669,7 @@ VimLParser.prototype.parse = function(reader) {
     this.reader = reader;
     this.context = [];
     var toplevel = Node(NODE_TOPLEVEL);
+    toplevel.pos = this.reader.getpos();
     toplevel.body = [];
     this.push_context(toplevel);
     while (this.reader.peek() != "<EOF>") {

py/vimlparser.py

@@ -583,6 +583,7 @@ def parse(self, reader):
         self.reader = reader
         self.context = []
         toplevel = Node(NODE_TOPLEVEL)
+        toplevel.pos = self.reader.getpos()
         toplevel.body = []
         self.push_context(toplevel)
         while self.reader.peek() != "<EOF>":