Adhere to ::Range pattern

This commit is contained in:
Tom Hvitved
2020-12-02 11:27:00 +01:00
parent b2483069e0
commit 77129e473a
7 changed files with 186 additions and 152 deletions

View File

@@ -1,56 +1,70 @@
import codeql_ruby.AST
private import TreeSitter
abstract class CallableRange extends AstNode {
abstract Parameter getParameter(int n);
}
class MethodRange extends CallableRange, @method {
final override Generated::Method generated;
override Parameter getParameter(int n) { result = generated.getParameters().getChild(n) }
string getName() {
result = generated.getName().(Generated::Token).getValue() or
// TODO: use hand-written Symbol class
result = generated.getName().(Generated::Symbol).toString() or
result = generated.getName().(Generated::Setter).getName().getValue() + "="
module Callable {
abstract class Range extends AstNode {
abstract Parameter getParameter(int n);
}
}
class SingletonMethodRange extends CallableRange, @singleton_method {
final override Generated::SingletonMethod generated;
module Method {
class Range extends Callable::Range, @method {
final override Generated::Method generated;
override Parameter getParameter(int n) { result = generated.getParameters().getChild(n) }
override Parameter getParameter(int n) { result = generated.getParameters().getChild(n) }
string getName() {
result = generated.getName().(Generated::Token).getValue() or
// TODO: use hand-written Symbol class
result = generated.getName().(Generated::Symbol).toString() or
result = generated.getName().(Generated::Setter).getName().getValue() + "="
string getName() {
result = generated.getName().(Generated::Token).getValue() or
// TODO: use hand-written Symbol class
result = generated.getName().(Generated::Symbol).toString() or
result = generated.getName().(Generated::Setter).getName().getValue() + "="
}
}
}
class LambdaRange extends CallableRange, @lambda {
final override Generated::Lambda generated;
module SingletonMethod {
class Range extends Callable::Range, @singleton_method {
final override Generated::SingletonMethod generated;
final override Parameter getParameter(int n) { result = generated.getParameters().getChild(n) }
override Parameter getParameter(int n) { result = generated.getParameters().getChild(n) }
string getName() {
result = generated.getName().(Generated::Token).getValue() or
// TODO: use hand-written Symbol class
result = generated.getName().(Generated::Symbol).toString() or
result = generated.getName().(Generated::Setter).getName().getValue() + "="
}
}
}
abstract class BlockRange extends CallableRange {
Generated::BlockParameters params;
module Lambda {
class Range extends Callable::Range, @lambda {
final override Generated::Lambda generated;
final override Parameter getParameter(int n) { result = params.getChild(n) }
final override Parameter getParameter(int n) { result = generated.getParameters().getChild(n) }
}
}
class DoBlockRange extends BlockRange, @do_block {
final override Generated::DoBlock generated;
module Block {
abstract class Range extends Callable::Range {
Generated::BlockParameters params;
DoBlockRange() { params = generated.getParameters() }
final override Parameter getParameter(int n) { result = params.getChild(n) }
}
}
class BraceBlockRange extends BlockRange, @block {
final override Generated::Block generated;
module DoBlock {
class Range extends Block::Range, @do_block {
final override Generated::DoBlock generated;
BraceBlockRange() { params = generated.getParameters() }
Range() { params = generated.getParameters() }
}
}
module BraceBlock {
class Range extends Block::Range, @block {
final override Generated::Block generated;
Range() { params = generated.getParameters() }
}
}

View File

@@ -35,40 +35,46 @@ private predicate patternNode(Generated::AstNode n, boolean parameter) {
*/
predicate assignment(Generated::Identifier i, boolean parameter) { patternNode(i, parameter) }
abstract class PatternRange extends AstNode {
PatternRange() { patternNode(this, _) }
module Pattern {
abstract class Range extends AstNode {
Range() { patternNode(this, _) }
abstract Variable getAVariable();
abstract Variable getAVariable();
}
}
class VariablePatternRange extends PatternRange {
override Generated::Identifier generated;
module VariablePattern {
class Range extends Pattern::Range {
override Generated::Identifier generated;
string getVariableName() { result = generated.getValue() }
string getVariableName() { result = generated.getValue() }
override Variable getAVariable() { access(this, result) }
override Variable getAVariable() { access(this, result) }
}
}
abstract class TuplePatternRange extends PatternRange {
abstract PatternRange getElement(int i);
module TuplePattern {
abstract class Range extends Pattern::Range {
abstract Pattern::Range getElement(int i);
override Variable getAVariable() { result = this.getElement(_).getAVariable() }
}
private class ParameterTuplePatternRange extends TuplePatternRange {
override Generated::DestructuredParameter generated;
override PatternRange getElement(int i) { result = generated.getChild(i) }
}
private class AssignmentTuplePatternRange extends TuplePatternRange {
override Generated::DestructuredLeftAssignment generated;
override PatternRange getElement(int i) { result = generated.getChild(i) }
}
private class AssignmentListPatternRange extends TuplePatternRange {
override Generated::LeftAssignmentList generated;
override PatternRange getElement(int i) { result = generated.getChild(i) }
override Variable getAVariable() { result = this.getElement(_).getAVariable() }
}
private class ParameterTuplePatternRange extends Range {
override Generated::DestructuredParameter generated;
override Pattern::Range getElement(int i) { result = generated.getChild(i) }
}
private class AssignmentTuplePatternRange extends Range {
override Generated::DestructuredLeftAssignment generated;
override Pattern::Range getElement(int i) { result = generated.getChild(i) }
}
private class AssignmentListPatternRange extends Range {
override Generated::LeftAssignmentList generated;
override Pattern::Range getElement(int i) { result = generated.getChild(i) }
}
}

View File

@@ -13,7 +13,9 @@ private VariableScope enclosingScope(Generated::AstNode node) {
result.getScopeElement() = parent*(node.getParent())
}
private predicate parameterAssignment(CallableScopeRange scope, string name, Generated::Identifier i) {
private predicate parameterAssignment(
CallableScope::Range scope, string name, Generated::Identifier i
) {
assignment(i, true) and
scope = enclosingScope(i) and
name = i.getValue()
@@ -21,7 +23,7 @@ private predicate parameterAssignment(CallableScopeRange scope, string name, Gen
/** Holds if `scope` defines `name` in its parameter declaration at `i`. */
private predicate scopeDefinesParameterVariable(
CallableScopeRange scope, string name, Generated::Identifier i
CallableScope::Range scope, string name, Generated::Identifier i
) {
parameterAssignment(scope, name, i) and
// In case of overlapping parameter names (e.g. `_`), only the first
@@ -142,69 +144,83 @@ private module Cached {
import Cached
abstract class VariableScopeRange extends TScope {
abstract string toString();
module VariableScope {
abstract class Range extends TScope {
abstract string toString();
abstract AstNode getScopeElement();
}
class TopLevelScopeRange extends VariableScopeRange, TTopLevelScope {
override string toString() { result = "top-level scope" }
override AstNode getScopeElement() { TTopLevelScope(result) = this }
}
class ModuleScopeRange extends VariableScopeRange, TModuleScope {
override string toString() { result = "module scope" }
override AstNode getScopeElement() { TModuleScope(result) = this }
}
class ClassScopeRange extends VariableScopeRange, TClassScope {
override string toString() { result = "class scope" }
override AstNode getScopeElement() { TClassScope(result) = this }
}
class CallableScopeRange extends VariableScopeRange, TCallableScope {
private Callable c;
CallableScopeRange() { this = TCallableScope(c) }
override string toString() {
(c instanceof Method or c instanceof SingletonMethod) and
result = "method scope"
or
c instanceof Lambda and
result = "lambda scope"
or
c instanceof Block and
result = "block scope"
abstract AstNode getScopeElement();
}
override Callable getScopeElement() { TCallableScope(result) = this }
}
class VariableRange extends TVariable {
abstract string getName();
module TopLevelScope {
class Range extends VariableScope::Range, TTopLevelScope {
override string toString() { result = "top-level scope" }
string toString() { result = this.getName() }
abstract Location getLocation();
abstract VariableScope getDeclaringScope();
override AstNode getScopeElement() { TTopLevelScope(result) = this }
}
}
class LocalVariableRange extends VariableRange {
private VariableScope scope;
private string name;
private Generated::Identifier i;
module ModuleScope {
class Range extends VariableScope::Range, TModuleScope {
override string toString() { result = "module scope" }
LocalVariableRange() { this = TLocalVariable(scope, name, i) }
final override string getName() { result = name }
final override Location getLocation() { result = i.getLocation() }
final override VariableScope getDeclaringScope() { result = scope }
override AstNode getScopeElement() { TModuleScope(result) = this }
}
}
module ClassScope {
class Range extends VariableScope::Range, TClassScope {
override string toString() { result = "class scope" }
override AstNode getScopeElement() { TClassScope(result) = this }
}
}
module CallableScope {
class Range extends VariableScope::Range, TCallableScope {
private Callable c;
Range() { this = TCallableScope(c) }
override string toString() {
(c instanceof Method or c instanceof SingletonMethod) and
result = "method scope"
or
c instanceof Lambda and
result = "lambda scope"
or
c instanceof Block and
result = "block scope"
}
override Callable getScopeElement() { TCallableScope(result) = this }
}
}
module Variable {
class Range extends TVariable {
abstract string getName();
string toString() { result = this.getName() }
abstract Location getLocation();
abstract VariableScope getDeclaringScope();
}
}
module LocalVariable {
class Range extends Variable::Range {
private VariableScope scope;
private string name;
private Generated::Identifier i;
Range() { this = TLocalVariable(scope, name, i) }
final override string getName() { result = name }
final override Location getLocation() { result = i.getLocation() }
final override VariableScope getDeclaringScope() { result = scope }
}
}