Git Product home page Git Product logo

solidityparser's Introduction

Solidity Parser

This is a Go module to parse Solidity, based on Federico 's ANTLR grammar for the language.

Usage

package main

import (
	"fmt"
	"github.com/antlr/antlr4/runtime/Go/antlr"
	"github.com/duaraghav8/solidityparser"
)

var code = `
contract Foo {
	function bar(uint x) {}
}

contract Bar {
	constructor(){}
}
`

// EverythingListener listens for all rules, i.e., it visits
// all AST nodes.
type EverythingListener struct {
	*solidityparser.BaseSolidityListener
}

func NewEverythingListener() *EverythingListener {
	return new(EverythingListener)
}

func (l *EverythingListener) EnterEveryRule(ctx antlr.ParserRuleContext) {
	fmt.Println("Entered a rule")
	fmt.Println(ctx.GetRuleIndex())
	fmt.Printf("Text: %s\nStart line: %d\n", ctx.GetText(), ctx.GetStart().GetLine())
	fmt.Println("--------------")
}

func main() {
	code := antlr.NewInputStream(code)
	lexer := solidityparser.NewSolidityLexer(code)
	stream := antlr.NewCommonTokenStream(lexer, 0)

	parser := solidityparser.NewSolidityParser(stream)
	parser.AddErrorListener(antlr.NewDiagnosticErrorListener(true))
	parser.BuildParseTrees = true

	tree := parser.SourceUnit()
	antlr.ParseTreeWalkerDefault.Walk(NewEverythingListener(), tree)
}

Building

Install the ANTLR4 tool and the Go runtime as described here & here.

To generate this Parser:

  1. Update the solidity-antlr4 submodule to the appropriate commit.
  2. Run scripts/generate-solidity-parser.sh in the root directory of this repository.
  3. Run go mod tidy && go mod vendor
  4. Commit and push.

solidityparser's People

Watchers

James Cloos avatar Raghav avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.