Skip to content

Commit 65a1198

Browse files
hvitvedhvitved
committed
Ruby: Synthesize implicit super arguments
1 parent c10b580 commit 65a1198

17 files changed

+756
-85
lines changed

‎ruby/ql/lib/codeql/ruby/ast/Expr.qll

+4-21
Original file line numberDiff line numberDiff line change
@@ -248,13 +248,7 @@ class ParenthesizedExpr extends StmtSequence, TParenthesizedExpr {
248248
* baz(qux: 1)
249249
* ```
250250
*/
251-
class Pair extends Expr, TPair {
252-
private Ruby::Pair g;
253-
254-
Pair() { this = TPair(g) }
255-
256-
final override string getAPrimaryQlClass() { result = "Pair" }
257-
251+
class Pair extends Expr instanceof PairImpl {
258252
/**
259253
* Gets the key expression of this pair. For example, the `SymbolLiteral`
260254
* representing the keyword `foo` in the following example:
@@ -266,7 +260,7 @@ class Pair extends Expr, TPair {
266260
* { 'foo' => 123 }
267261
* ```
268262
*/
269-
final Expr getKey() { toGenerated(result) = g.getKey() }
263+
final Expr getKey() { result = PairImpl.super.getKey() }
270264

271265
/**
272266
* Gets the value expression of this pair. For example, the `IntegerLiteral`
@@ -275,20 +269,9 @@ class Pair extends Expr, TPair {
275269
* { 'foo' => 123 }
276270
* ```
277271
*/
278-
final Expr getValue() {
279-
toGenerated(result) = g.getValue() or
280-
synthChild(this, 0, result)
281-
}
282-
283-
final override string toString() { result = "Pair" }
272+
final Expr getValue() { result = PairImpl.super.getValue() }
284273

285-
final override AstNode getAChild(string pred) {
286-
result = super.getAChild(pred)
287-
or
288-
pred = "getKey" and result = this.getKey()
289-
or
290-
pred = "getValue" and result = this.getValue()
291-
}
274+
final override string getAPrimaryQlClass() { result = "Pair" }
292275
}
293276

294277
/**

‎ruby/ql/lib/codeql/ruby/ast/Literal.qll

+3-1
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,9 @@ class StringlikeLiteral extends Literal instanceof StringlikeLiteralImpl {
305305
final override AstNode getAChild(string pred) {
306306
result = Literal.super.getAChild(pred)
307307
or
308-
pred = "getComponent" and result = this.getComponent(_)
308+
pred = "getComponent" and
309+
result = this.getComponent(_) and
310+
not this instanceof SimpleSymbolLiteralSynth
309311
}
310312
}
311313

‎ruby/ql/lib/codeql/ruby/ast/Operation.qll

-4
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,6 @@ class SplatExpr extends UnaryOperation, TSplatExpr {
9292
* ```
9393
*/
9494
class HashSplatExpr extends UnaryOperation, THashSplatExpr {
95-
private Ruby::HashSplatArgument g;
96-
97-
HashSplatExpr() { this = THashSplatExpr(g) }
98-
9995
final override string getAPrimaryQlClass() { result = "HashSplatExpr" }
10096
}
10197

‎ruby/ql/lib/codeql/ruby/ast/internal/AST.qll

+30-11
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,8 @@ private module Cached {
164164
THashKeySymbolLiteral(Ruby::HashKeySymbol g) or
165165
THashLiteral(Ruby::Hash g) or
166166
THashPattern(Ruby::HashPattern g) or
167-
THashSplatExpr(Ruby::HashSplatArgument g) or
167+
THashSplatExprReal(Ruby::HashSplatArgument g) or
168+
THashSplatExprSynth(Ast::AstNode parent, int i) { mkSynthChild(HashSplatExprKind(), parent, i) } or
168169
THashSplatNilParameter(Ruby::HashSplatNil g) { not g.getParent() instanceof Ruby::HashPattern } or
169170
THashSplatParameter(Ruby::HashSplatParameter g) {
170171
not g.getParent() instanceof Ruby::HashPattern
@@ -232,7 +233,8 @@ private module Cached {
232233
TNotExprReal(Ruby::Unary g) { g instanceof @ruby_unary_bang or g instanceof @ruby_unary_not } or
233234
TNotExprSynth(Ast::AstNode parent, int i) { mkSynthChild(NotExprKind(), parent, i) } or
234235
TOptionalParameter(Ruby::OptionalParameter g) or
235-
TPair(Ruby::Pair g) or
236+
TPairReal(Ruby::Pair g) or
237+
TPairSynth(Ast::AstNode parent, int i) { mkSynthChild(PairExprKind(), parent, i) } or
236238
TParenthesizedExpr(Ruby::ParenthesizedStatements g) or
237239
TParenthesizedPattern(Ruby::ParenthesizedPattern g) or
238240
TRShiftExprReal(Ruby::Binary g) { g instanceof @ruby_binary_ranglerangle } or
@@ -274,7 +276,10 @@ private module Cached {
274276
TSimpleParameterSynth(Ast::AstNode parent, int i) {
275277
mkSynthChild(SimpleParameterKind(), parent, i)
276278
} or
277-
TSimpleSymbolLiteral(Ruby::SimpleSymbol g) or
279+
TSimpleSymbolLiteralReal(Ruby::SimpleSymbol g) or
280+
TSimpleSymbolLiteralSynth(Ast::AstNode parent, int i, string value) {
281+
mkSynthChild(SymbolLiteralExprKind(value), parent, i)
282+
} or
278283
TSingletonClass(Ruby::SingletonClass g) or
279284
TSingletonMethod(Ruby::SingletonMethod g) or
280285
TSpaceshipExpr(Ruby::Binary g) { g instanceof @ruby_binary_langleequalrangle } or
@@ -362,19 +367,19 @@ private module Cached {
362367
TEnsure or TEqExpr or TExponentExprReal or TFalseLiteral or TFile or TFindPattern or
363368
TFloatLiteral or TForExpr or TForwardParameter or TForwardArgument or TGEExpr or TGTExpr or
364369
TGlobalVariableAccessReal or THashKeySymbolLiteral or THashLiteral or THashPattern or
365-
THashSplatExpr or THashSplatNilParameter or THashSplatParameter or THereDoc or
370+
THashSplatExprReal or THashSplatNilParameter or THashSplatParameter or THereDoc or
366371
TIdentifierMethodCall or TIfReal or TIfModifierExpr or TInClauseReal or
367372
TInstanceVariableAccessReal or TIntegerLiteralReal or TKeywordParameter or TLEExpr or
368373
TLShiftExprReal or TLTExpr or TLambda or TLeftAssignmentList or TLine or
369374
TLocalVariableAccessReal or TLogicalAndExprReal or TLogicalOrExprReal or TMethod or
370375
TMatchPattern or TModuleDeclaration or TModuloExprReal or TMulExprReal or TNEExpr or
371376
TNextStmt or TNilLiteralReal or TNoRegExpMatchExpr or TNotExprReal or TOptionalParameter or
372-
TPair or TParenthesizedExpr or TParenthesizedPattern or TRShiftExprReal or
377+
TPairReal or TParenthesizedExpr or TParenthesizedPattern or TRShiftExprReal or
373378
TRangeLiteralReal or TRationalLiteral or TRedoStmt or TRegExpLiteral or TRegExpMatchExpr or
374379
TRegularArrayLiteral or TRegularMethodCall or TRegularStringLiteral or TRegularSuperCall or
375380
TRescueClause or TRescueModifierExpr or TRetryStmt or TReturnStmt or
376381
TScopeResolutionConstantAccess or TSelfReal or TSimpleParameterReal or
377-
TSimpleSymbolLiteral or TSingletonClass or TSingletonMethod or TSpaceshipExpr or
382+
TSimpleSymbolLiteralReal or TSingletonClass or TSingletonMethod or TSpaceshipExpr or
378383
TSplatExprReal or TSplatParameter or TStringArrayLiteral or TStringConcatenation or
379384
TStringEscapeSequenceComponent or TStringInterpolationComponent or TStringTextComponent or
380385
TSubExprReal or TSubshellLiteral or TSymbolArrayLiteral or TTernaryIfExpr or TTestPattern or
@@ -392,7 +397,8 @@ private module Cached {
392397
TLShiftExprSynth or TLocalVariableAccessSynth or TLogicalAndExprSynth or
393398
TLogicalOrExprSynth or TMethodCallSynth or TModuloExprSynth or TMulExprSynth or
394399
TNilLiteralSynth or TRShiftExprSynth or TRangeLiteralSynth or TSelfSynth or
395-
TSimpleParameterSynth or TSplatExprSynth or TStmtSequenceSynth or TSubExprSynth;
400+
TSimpleParameterSynth or TSplatExprSynth or THashSplatExprSynth or TStmtSequenceSynth or
401+
TSubExprSynth or TPairSynth or TSimpleSymbolLiteralSynth;
396402

397403
/**
398404
* Gets the underlying TreeSitter entity for a given AST node. This does not
@@ -468,7 +474,7 @@ private module Cached {
468474
n = THashKeySymbolLiteral(result) or
469475
n = THashLiteral(result) or
470476
n = THashPattern(result) or
471-
n = THashSplatExpr(result) or
477+
n = THashSplatExprReal(result) or
472478
n = THashSplatNilParameter(result) or
473479
n = THashSplatParameter(result) or
474480
n = THereDoc(result) or
@@ -499,7 +505,7 @@ private module Cached {
499505
n = TNoRegExpMatchExpr(result) or
500506
n = TNotExprReal(result) or
501507
n = TOptionalParameter(result) or
502-
n = TPair(result) or
508+
n = TPairReal(result) or
503509
n = TParenthesizedExpr(result) or
504510
n = TParenthesizedPattern(result) or
505511
n = TRangeLiteralReal(result) or
@@ -519,7 +525,7 @@ private module Cached {
519525
n = TScopeResolutionConstantAccess(result, _) or
520526
n = TSelfReal(result) or
521527
n = TSimpleParameterReal(result) or
522-
n = TSimpleSymbolLiteral(result) or
528+
n = TSimpleSymbolLiteralReal(result) or
523529
n = TSingletonClass(result) or
524530
n = TSingletonMethod(result) or
525531
n = TSpaceshipExpr(result) or
@@ -633,9 +639,15 @@ private module Cached {
633639
or
634640
result = TSplatExprSynth(parent, i)
635641
or
642+
result = THashSplatExprSynth(parent, i)
643+
or
636644
result = TStmtSequenceSynth(parent, i)
637645
or
638646
result = TSubExprSynth(parent, i)
647+
or
648+
result = TPairSynth(parent, i)
649+
or
650+
result = TSimpleSymbolLiteralSynth(parent, i, _)
639651
}
640652

641653
/**
@@ -726,6 +738,8 @@ class TSelf = TSelfReal or TSelfSynth;
726738

727739
class TDestructuredLhsExpr = TDestructuredLeftAssignment or TLeftAssignmentList;
728740

741+
class TPair = TPairReal or TPairSynth;
742+
729743
class TExpr =
730744
TSelf or TArgumentList or TRescueClause or TRescueModifierExpr or TPair or TStringConcatenation or
731745
TCall or TBlockArgument or TConstantAccess or TControlExpr or TLiteral or TCallable or
@@ -734,6 +748,8 @@ class TExpr =
734748

735749
class TSplatExpr = TSplatExprReal or TSplatExprSynth;
736750

751+
class THashSplatExpr = THashSplatExprReal or THashSplatExprSynth;
752+
737753
class TElse = TElseReal or TElseSynth;
738754

739755
class TStmtSequence =
@@ -768,13 +784,16 @@ class TStringInterpolationComponent =
768784
TStringInterpolationComponentNonRegexp or TStringInterpolationComponentRegexp;
769785

770786
class TStringComponent =
771-
TStringTextComponent or TStringEscapeSequenceComponent or TStringInterpolationComponent;
787+
TStringTextComponent or TStringEscapeSequenceComponent or TStringInterpolationComponent or
788+
TSimpleSymbolLiteralSynth;
772789

773790
class TStringlikeLiteral =
774791
TStringLiteral or TRegExpLiteral or TSymbolLiteral or TSubshellLiteral or THereDoc;
775792

776793
class TStringLiteral = TRegularStringLiteral or TBareStringLiteral;
777794

795+
class TSimpleSymbolLiteral = TSimpleSymbolLiteralReal or TSimpleSymbolLiteralSynth;
796+
778797
class TSymbolLiteral = TSimpleSymbolLiteral or TComplexSymbolLiteral or THashKeySymbolLiteral;
779798

780799
class TComplexSymbolLiteral = TDelimitedSymbolLiteral or TBareSymbolLiteral;

‎ruby/ql/lib/codeql/ruby/ast/internal/Call.qll

+46-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ private import TreeSitter
22
private import Variable
33
private import codeql.ruby.AST
44
private import codeql.ruby.ast.internal.AST
5+
private import codeql.ruby.ast.internal.Scope
56

67
predicate isIdentifierMethodCall(Ruby::Identifier g) { vcall(g) and not access(g, _) }
78

@@ -133,18 +134,61 @@ private string getSuperMethodName(Ruby::Super sup) {
133134
)
134135
}
135136

137+
private Ruby::Identifier getParameter(Ruby::Method m, int pos, Ruby::AstNode param) {
138+
scopeDefinesParameterVariable(m, _, result, pos) and
139+
param = m.getParameters().getChild(pos)
140+
}
141+
136142
class TokenSuperCall extends SuperCallImpl, TTokenSuperCall {
137143
private Ruby::Super g;
138144

139145
TokenSuperCall() { this = TTokenSuperCall(g) }
140146

147+
Ruby::Method getEnclosingMethod() { result = scopeOf(toGenerated(this)).getEnclosingMethod() }
148+
149+
int getNumberOfImplicitArguments() {
150+
exists(Ruby::Method encl |
151+
encl = this.getEnclosingMethod() and
152+
result = count(getParameter(encl, _, _))
153+
)
154+
}
155+
156+
/**
157+
* Gets the local variable defined by parameter `param` which is used as an
158+
* implicit argument at position `pos`.
159+
*
160+
* For example, in
161+
*
162+
* ```ruby
163+
* class Sup
164+
* def m(x)
165+
* end
166+
* end
167+
*
168+
* class Sub < Sup
169+
* def m(x)
170+
* super
171+
* end
172+
* end
173+
* ```
174+
*
175+
* `x` is an implicit argument at position 0 of the `super` call in `Sub#m`.
176+
*/
177+
pragma[nomagic]
178+
LocalVariableReal getImplicitArgument(int pos, Ruby::AstNode param) {
179+
exists(Ruby::Method encl |
180+
encl = this.getEnclosingMethod() and
181+
toGenerated(result.getDefiningAccessImpl()) = getParameter(encl, pos, param)
182+
)
183+
}
184+
141185
final override string getMethodNameImpl() { result = getSuperMethodName(g) }
142186

143187
final override Expr getReceiverImpl() { none() }
144188

145-
final override Expr getArgumentImpl(int n) { none() }
189+
final override Expr getArgumentImpl(int n) { synthChild(this, n, result) }
146190

147-
final override int getNumberOfArgumentsImpl() { result = 0 }
191+
final override int getNumberOfArgumentsImpl() { result = this.getNumberOfImplicitArguments() }
148192

149193
final override Block getBlockImpl() { none() }
150194
}

‎ruby/ql/lib/codeql/ruby/ast/internal/Expr.qll

+35
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,38 @@ class LeftAssignmentListImpl extends DestructuredLhsExprImpl, Ruby::LeftAssignme
120120
)
121121
}
122122
}
123+
124+
abstract class PairImpl extends Expr, TPair {
125+
abstract Expr getKey();
126+
127+
abstract Expr getValue();
128+
129+
final override string toString() { result = "Pair" }
130+
131+
final override AstNode getAChild(string pred) {
132+
result = super.getAChild(pred)
133+
or
134+
pred = "getKey" and result = this.getKey()
135+
or
136+
pred = "getValue" and result = this.getValue()
137+
}
138+
}
139+
140+
class PairReal extends PairImpl, TPairReal {
141+
private Ruby::Pair g;
142+
143+
PairReal() { this = TPairReal(g) }
144+
145+
final override Expr getKey() { toGenerated(result) = g.getKey() }
146+
147+
final override Expr getValue() {
148+
toGenerated(result) = g.getValue() or
149+
synthChild(this, 0, result)
150+
}
151+
}
152+
153+
class PairSynth extends PairImpl, TPairSynth {
154+
final override Expr getKey() { synthChild(this, 0, result) }
155+
156+
final override Expr getValue() { synthChild(this, 1, result) }
157+
}

‎ruby/ql/lib/codeql/ruby/ast/internal/Literal.qll

+18-2
Original file line numberDiff line numberDiff line change
@@ -608,16 +608,32 @@ class BareStringLiteral extends StringLiteralImpl, TBareStringLiteral {
608608

609609
abstract class SymbolLiteralImpl extends StringlikeLiteralImpl, TSymbolLiteral { }
610610

611-
class SimpleSymbolLiteral extends SymbolLiteralImpl, TSimpleSymbolLiteral {
611+
abstract class SimpleSymbolLiteralImpl extends SymbolLiteralImpl, TSimpleSymbolLiteral { }
612+
613+
class SimpleSymbolLiteralReal extends SimpleSymbolLiteralImpl, TSimpleSymbolLiteral {
612614
private Ruby::SimpleSymbol g;
613615

614-
SimpleSymbolLiteral() { this = TSimpleSymbolLiteral(g) }
616+
SimpleSymbolLiteralReal() { this = TSimpleSymbolLiteralReal(g) }
615617

616618
final override StringComponent getComponentImpl(int n) { n = 0 and toGenerated(result) = g }
617619

618620
final override string toString() { result = g.getValue() }
619621
}
620622

623+
class SimpleSymbolLiteralSynth extends SimpleSymbolLiteralImpl, TSimpleSymbolLiteralSynth,
624+
StringComponentImpl
625+
{
626+
private string value;
627+
628+
SimpleSymbolLiteralSynth() { this = TSimpleSymbolLiteralSynth(_, _, value) }
629+
630+
final override string getValue() { result = value }
631+
632+
final override StringComponent getComponentImpl(int n) { n = 0 and result = this }
633+
634+
final override string toString() { result = value }
635+
}
636+
621637
abstract class ComplexSymbolLiteral extends SymbolLiteralImpl, TComplexSymbolLiteral { }
622638

623639
class DelimitedSymbolLiteral extends ComplexSymbolLiteral, TDelimitedSymbolLiteral {

0 commit comments

Comments
 (0)