aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2023-05-16checkClosure: Add function doc commentTeddy Wing
2023-05-16checkClosure: Clean up old codeTeddy Wing
* Remove old in-progress code now that we have a working implementation. * Add explanatory comments. * Remove `assignmentsInFunc()` which is unused.
2023-05-16run: Add a few explanatory commentsTeddy Wing
2023-05-16run: Clean up old codeTeddy Wing
Remove old unused in-progress code.
2023-05-16Report reference-type closure argumentsTeddy Wing
2023-05-16Get arguments of closure with `funcLit.Type.Params.List`Teddy Wing
Easier to use than `goStmt.Call.Args` because we don't have to handle both `*ast.Expr` and `*ast.UnaryExpr`.
2023-05-16Try to get the arguments of the closure from `goStmt.Call.Args`Teddy Wing
2023-05-16Ignore any identifier that isn't a *types.VarTeddy Wing
Otherwise we can get `*types.TypeName` identifiers, like the variable types in the closure's argument list. We only want to inspect variables.
2023-05-16Add notes for next things to add and fixTeddy Wing
These items don't pass our tests.
2023-05-16Ignore variables defined in the function closureTeddy Wing
This correctly ignores local variables.
2023-05-16Use scope test to report captured variablesTeddy Wing
Report all variables declared in an outer scope. This does match variables defined in the closure too. Will need to fix that.
2023-05-16Add automated testTeddy Wing
Follow `golang.org/x/tools/go/analysis/passes/testinggoroutine` to write the test runner: https://github.com/golang/tools/blob/1c9fe3f82c363b929ef7239ca0ad8a5dafbbcf05/go/analysis/passes/testinggoroutine/testinggoroutine_test.go Add "want" comments to test code for validation.
2023-05-16Rename module to `gopkg.teddywing.com/gocapturedrefrace`Teddy Wing
Decided not to use my personal Git host directly for the module, but a new domain specific to Go modules. This could allow me to host the code elsewhere using a vanity module name.
2023-05-16Ideas for using scope LookupParent to check if variable is localTeddy Wing
2023-05-16Add a note for the current goalTeddy Wing
2023-05-16Find variable in outer scopesTeddy Wing
For every identifier in the closure, check if it exists in an outer scope.
2023-05-16Add note about `(*types.Scope).LookupParent`Teddy Wing
2023-05-16Find a `pass.TypesInfo.Scopes[]` that's not nilTeddy Wing
If I had read the comment for `Scopes` in https://godocs.io/go/types#Info I would have known that only a subset of `ast.Node` can appear in the `Scopes` field. Tried ones until I ended up with valid scopes. Now that we have a valid scope, maybe we can find out if it's using variables not declared within that scope.
2023-05-16Idea for getting the scope of the closureTeddy Wing
Just results in nil.
2023-05-16Add note about getting function ScopeTeddy Wing
2023-05-16Add note about (*ast.CallExpr).ArgsTeddy Wing
Discovered this existed.
2023-05-16Trying to get `types.Scope` of function literalTeddy Wing
Not working, as `funcObj` is nil.
2023-05-16Print origin and scope information of closure variablesTeddy Wing
Debugging and ideas for getting variables defined in this closure's scope.
2023-05-16Use `pass.TypesInfo.Defs[ident]` to differentiate DEFINE/ASSIGNTeddy Wing
Got this idea from a question by zhizhixiong (https://stackoverflow.com/users/12073516/zhizhixiong) on Stack Overflow: https://stackoverflow.com/questions/66544145/how-to-find-the-declaration-of-an-ident-using-go-analysis This seems to correctly print defines and assigns. It doesn't print the `decl` variable though.
2023-05-15`(*AssignStmt).Tok` always appears to be token.DEFINETeddy Wing
2023-05-15assignmentsInFunc: Try checking `(*AssignStmt).Tok`Teddy Wing
This field could maybe tell us whether it was a `:=` assignment (token.DEFINE) or `=` (token.ASSIGN), but it seems like it's always `token.DEFINE`.
2023-05-15Try getting `GenDecl`s in closureTeddy Wing
Turns out this only gets declarations like: var decl string but not: decl := "a" Is there a way to get the above one too?
2023-05-15Add test for reference argumentsTeddy Wing
These should be reported as well, because they're shared references even though they're passed as arguments. This currently reports the variable name as "aStruct", will need to look into how to correct that.
2023-05-15Add a new test for struct methodsTeddy Wing
2023-05-15Idea for getting variable declarations instead of assignmentsTeddy Wing
2023-05-15Get assignments in closureTeddy Wing
Turns out this isn't what we want, as assignments means assignments. I was actually thinking of declarations.
2023-05-15Idea for building a list of variable assignmentsTeddy Wing
2023-05-15Ignore variables from the closure's formal argumentsTeddy Wing
Don't report variables that were passed as arguments to the closure.
2023-05-15Find out how to get closure argumentsTeddy Wing
2023-05-15Ideas for finding out whether a variable is a captured referenceTeddy Wing
2023-05-15Try to limit identifier enumeration to variablesTeddy Wing
This does ignore "strings" and "Repeat" in the "simple.go" test file.
2023-05-15testdata/simple.go: Add package and function callTeddy Wing
Need to refine our identifier filtering.
2023-05-15testdata/simple.go: Add a local variable in closureTeddy Wing
We want to ignore local variables.
2023-05-15testdata/simple.go: Find out what happens when var is reusedTeddy Wing
Second usage of captured reference is reported as expected. That seems correct for our needs.
2023-05-15Find variables in `go func` closuresTeddy Wing
Inspect function literals run by `go` statements, and find all variables in those function literals.
2023-05-14Find `go` statements using Go analyzerTeddy Wing
Build a basic Go analyser that finds `go` statements. Currently testing this with: $ go run ./cmd/gocapturedrefrace ./testdata/ Using the following tutorials as a guide: * https://arslan.io/2019/06/13/using-go-analysis-to-write-a-custom-linter/ * https://scribe.rip/codex/writing-custom-linter-in-go-54ef6f8080
2023-05-13Add Idea.txtTeddy Wing