86ca63beaf14edbc3443304912889a3eda4fea9b — Drew DeVault 4 months ago
Initial commit; basic AST dumper for research
5 files changed, 272 insertions(+), 0 deletions(-)

A .gitignore
A LICENSE
A go.mod
A main.go
A notes
A  => .gitignore +1 -0
@@ 1,1 @@
+annotatego

A  => LICENSE +165 -0
@@ 1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2019 Drew DeVault
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

A  => go.mod +3 -0
@@ 1,3 @@
+module git.sr.ht/~sircmpwn/annotatego
+
+go 1.12

A  => main.go +71 -0
@@ 1,71 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"go/ast"
+	"go/token"
+	"go/parser"
+)
+
+type identVisitor struct {
+	ident    *ast.Ident
+	selector *ast.SelectorExpr
+}
+
+func (v *identVisitor) Visit(node ast.Node) ast.Visitor {
+	if ident, ok := node.(*ast.Ident); ok {
+		v.ident = ident
+		return nil
+	}
+	if sel, ok := node.(*ast.SelectorExpr); ok {
+		v.selector = sel
+	}
+	return v
+}
+
+type visitor struct {
+	indent   string
+	fs       *token.FileSet
+	filename string
+}
+
+func strNode(node ast.Node) string {
+	switch node := node.(type) {
+	case *ast.Ident:
+		return fmt.Sprintf("ident{%s, %v}", node.Name, node.Obj)
+	case *ast.CallExpr:
+		return fmt.Sprintf("callExpr{fn: %T %v %s}",
+			node.Fun, node.Fun, strNode(node.Fun))
+	}
+	return fmt.Sprintf("%v", node)
+}
+
+func (v visitor) Visit(node ast.Node) ast.Visitor {
+	if node == nil {
+		v.indent = v.indent[:len(v.indent)-2]
+		return v
+	}
+	pos := v.fs.Position(node.Pos())
+	fmt.Printf("%s:%d:%d: %s%T %p %v\n", v.filename,
+		pos.Line, pos.Column, v.indent, node, node, strNode(node))
+	v.indent += "  "
+	return v
+}
+
+func main() {
+	var fs *token.FileSet = token.NewFileSet()
+	for _, arg := range os.Args[1:] {
+		pkgs, err := parser.ParseDir(fs, arg, nil, 0)
+		if err != nil {
+			panic(err)
+		}
+		for _, pkg := range pkgs {
+			for filename, file := range pkg.Files {
+				for _, decl := range file.Decls {
+					ast.Walk(visitor{"", fs, filename}, decl)
+				}
+			}
+		}
+	}
+}

A  => notes +32 -0
@@ 1,32 @@
+function declarations are fairly straightforward:
+
+	*ast.FuncDecl &{<nil> 0xc000084960 setId 0xc00000cc80 0xc0000849f0}
+	  *ast.FieldList &{678 [0xc0000207c0] 693}
+		*ast.Field &{<nil> [worker] 0xc00000ca60 <nil> <nil>}
+		  *ast.Ident ident{worker, &{var worker 0xc0000207c0 <nil> <nil>}}
+		   *ast.StarExpr &{686 Worker}
+			 *ast.Ident ident{Worker, &{type Worker 0xc0000843c0 <nil> <nil>}}
+	   *ast.Ident ident{setId, <nil>}
+
+	- Recv is the type it's being declared for
+	- Name is the name, duh
+	- Rest is not important here
+
+function calls are more complicated:
+
+	atomic.AddInt64(&lastId, 1) ->
+
+	*ast.CallExpr 0xc000020840 &{0xc00000cb40 744 [0xc00000cb80 0xc00000cba0] 0 755}
+	  *ast.SelectorExpr 0xc00000cb40 &{atomic AddInt64}
+		*ast.Ident 0xc00000cb00 ident{atomic, <nil>}
+		 *ast.Ident 0xc00000cb20 ident{AddInt64, <nil>}
+	   *ast.UnaryExpr 0xc00000cb80 &{745 & lastId}
+		 *ast.Ident 0xc00000cb60 ident{lastId, &{var lastId 0xc000090140 0 <nil>}}
+	   *ast.BasicLit 0xc00000cba0 &{754 INT 1}
+
+	accounts = append(accounts, account) ->
+
+	*ast.CallExpr 0xc0000b57c0 &{append 5267 [accounts account] 0 5285}
+	  *ast.Ident 0xc0000b6ec0 ident{append, <nil>}
+	  *ast.Ident 0xc0000b6ee0 ident{accounts, &{var accounts 0xc000091b80 0 <nil>}}
+	  *ast.Ident 0xc0000b6f00 ident{account, &{var account 0xc0000b4bc0 <nil> <nil>}}