solidity-parser-antlr

A Solidity parser built on top of a robust ANTLR4 grammar.

Extended by Peng Gao (gaopeng32@gmail.com) to add support for tree depth and id of AST nodes.

Extended Usage

Example of an AST node: depth denotes the tree depth, id denotes the order of visiting

{ type: 'SourceUnit',
  children:
   [ { type: 'ContractDefinition',
       name: 'test',
       baseContracts: [],
       subNodes: [Array],
       kind: 'contract',
       loc: [Object],
       range: [Array],
       depth: 1,
       id: 1 } ],
  loc:
   { start: { line: 1, column: 0 }, end: { line: 1, column: 31 } },
  range: [ 0, 31 ],
  depth: 0,
  id: 0 
}

Example usage

// Parse Solidity source
const parser = require('./solidity-parser-antlr/src/index')
var source = "contract test { uint a; uint b;}"
var ast = parser.parse(source, {loc: true, range: true}) // original ast
parser.setDepthAndID(ast, true, true) // add the depth and id to the ast

// Visit AST
parser.visit(ast, {
  PrevAll: (node) => {
    // Triggered before all types of node are visited
    console.log("prevall: " + node.type)
  },

  PostAll: (node) => {
    // Triggered after all types of node are visited
    console.log("postall: " + node.type)
  },
   
  ImportDirective: function(node) {
    console.log(node.path) // triggered only for ImportDirective node type
  }
})

Usage

import parser from 'solidity-parser-antlr';

var input = `
    contract test {
        uint256 a;
        function f() {}
    }
`
try {
    parser.parse(input)
} catch (e) {
    if (e instanceof parser.ParserError) {
        console.log(e.errors)
    }
}

The parse method also accepts a second argument which lets you specify the following options, in a style similar to the esprima API:

Key	Type	Default	Description
tolerant	Boolean	false	When set to `true` it will collect syntax errors and place them in a list under the key `errors` inside the root node of the returned AST. Otherwise, it will raise a `parser.ParserError`.
loc	Boolean	false	When set to `true`, it will add location information to each node, with start and stop keys that contain the corresponding line and column numbers.
range	Boolean	false	When set to `true`, it will add range information to each node, which consists of a two-element array with start and stop character indexes in the input.

Example with location information

parser.parse('contract test { uint a; }', { loc: true })

// { type: 'SourceUnit',
//   children:
//    [ { type: 'ContractDefinition',
//        name: 'test',
//        baseContracts: [],
//        subNodes: [Array],
//        kind: 'contract',
//        loc: [Object] } ],
//   loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 24 } } }

Example using a visitor to walk over the AST

var ast = parser.parse('contract test { uint a; }')

// output the path of each import found
parser.visit(ast, {
  ImportDirective: function(node) {
    console.log(node.path)
  }
})

Author

Federico Bond (@federicobond)

License

MIT