replace libdparse in auto ref assignment (#51)

This commit is contained in:
lucica28 2022-12-02 12:16:01 +02:00 committed by Vladiwostok
parent 00eaef95b6
commit 7faa2cbae3
2 changed files with 50 additions and 81 deletions

View File

@ -5,127 +5,97 @@
module dscanner.analysis.auto_ref_assignment; module dscanner.analysis.auto_ref_assignment;
import dparse.lexer;
import dparse.ast;
import dscanner.analysis.base; import dscanner.analysis.base;
/** /**
* Checks for assignment to auto-ref function parameters. * Checks for assignment to auto-ref function parameters.
*/ */
final class AutoRefAssignmentCheck : BaseAnalyzer extern(C++) class AutoRefAssignmentCheck(AST) : BaseAnalyzerDmd
{ {
mixin AnalyzerInfo!"auto_ref_assignment_check"; mixin AnalyzerInfo!"auto_ref_assignment_check";
alias visit = BaseAnalyzerDmd.visit;
mixin ScopedVisit!(AST.ClassDeclaration);
mixin ScopedVisit!(AST.StructDeclaration);
mixin ScopedVisit!(AST.FuncDeclaration);
mixin ScopedVisit!(AST.InterfaceDeclaration);
mixin ScopedVisit!(AST.UnionDeclaration);
mixin ScopedVisit!(AST.ScopeStatement);
/// ///
this(BaseAnalyzerArguments args) extern(D) this(string fileName)
{ {
super(args); super(fileName);
} }
override void visit(const Module m) override void visit(AST.TemplateDeclaration td)
{ {
pushScope(); auto autoRefParamsOld = autoRefParams;
m.accept(this); autoRefParams = [];
popScope(); auto temp = inTemplateScope;
inTemplateScope = true;
super.visit(td);
inTemplateScope = temp;
autoRefParams = autoRefParamsOld;
} }
override void visit(const FunctionDeclaration func) override void visit(AST.Parameter p)
{ {
if (func.parameters is null || func.parameters.parameters.length == 0) import dmd.astenums : STC;
return;
pushScope(); if (p.storageClass & STC.auto_ && p.storageClass & STC.ref_ && p.ident)
scope (exit) autoRefParams ~= p.ident.toString();
popScope();
func.accept(this);
} }
override void visit(const Parameter param) override void visit(AST.AssignExp ae)
{ {
import std.algorithm.searching : canFind; import std.algorithm: canFind;
immutable bool isAuto = param.parameterAttributes.canFind!(a => a.idType == cast(ubyte) tok!"auto"); auto ie = ae.e1.isIdentifierExp();
immutable bool isRef = param.parameterAttributes.canFind!(a => a.idType == cast(ubyte) tok!"ref");
if (!isAuto || !isRef) if (ie && inTemplateScope && autoRefParams.canFind(ie.ident.toString()))
return; addErrorMessage(cast(ulong) ae.loc.linnum, cast(ulong) ae.loc.charnum, KEY,
addSymbol(param.name.text); "Assignment to auto-ref function parameter.");
} }
override void visit(const AssignExpression assign) template ScopedVisit(NodeType)
{ {
if (assign.operator == tok!"" || scopes.length == 0) override void visit(NodeType n)
return; {
interest ~= assign; auto temp = inTemplateScope;
assign.ternaryExpression.accept(this); inTemplateScope = false;
interest.length--; super.visit(n);
inTemplateScope = temp;
}
} }
override void visit(const IdentifierOrTemplateInstance ioti)
{
import std.algorithm.searching : canFind;
if (ioti.identifier == tok!"" || !interest.length)
return;
if (scopes[$ - 1].canFind(ioti.identifier.text))
addErrorMessage(interest[$ - 1], KEY, MESSAGE);
}
override void visit(const IdentifierChain ic)
{
import std.algorithm.searching : canFind;
if (ic.identifiers.length == 0 || !interest.length)
return;
if (scopes[$ - 1].canFind(ic.identifiers[0].text))
addErrorMessage(interest[$ - 1], KEY, MESSAGE);
}
alias visit = BaseAnalyzer.visit;
private: private:
const(char[])[] autoRefParams;
bool inTemplateScope;
enum string MESSAGE = "Assignment to auto-ref function parameter."; enum KEY = "dscanner.suspicious.object_const";
enum string KEY = "dscanner.suspicious.auto_ref_assignment";
const(AssignExpression)[] interest;
void addSymbol(string symbolName)
{
scopes[$ - 1] ~= symbolName;
}
void pushScope()
{
scopes.length++;
}
void popScope()
{
scopes = scopes[0 .. $ - 1];
}
string[][] scopes;
} }
unittest unittest
{ {
import std.stdio : stderr; import std.stdio : stderr;
import std.format : format;
import dscanner.analysis.config : StaticAnalysisConfig, Check, disabledConfig; import dscanner.analysis.config : StaticAnalysisConfig, Check, disabledConfig;
import dscanner.analysis.helpers : assertAnalyzerWarnings; import dscanner.analysis.helpers : assertAnalyzerWarnings = assertAnalyzerWarningsDMD;
StaticAnalysisConfig sac = disabledConfig(); StaticAnalysisConfig sac = disabledConfig();
sac.auto_ref_assignment_check = Check.enabled; sac.auto_ref_assignment_check = Check.enabled;
assertAnalyzerWarnings(q{ assertAnalyzerWarnings(q{
int doStuff(T)(auto ref int a) int doStuff(T)(auto ref int a)
{ {
a = 10; /+ a = 10; // [warn]: Assignment to auto-ref function parameter.
^^^^^^ [warn]: %s +/
} }
int doStuff(T)(ref int a) int doStuff(T)(ref int a)
{ {
a = 10; a = 10;
} }
}c.format(AutoRefAssignmentCheck.MESSAGE), sac); }c, sac);
stderr.writeln("Unittest for AutoRefAssignmentCheck passed."); stderr.writeln("Unittest for AutoRefAssignmentCheck passed.");
} }

View File

@ -917,10 +917,6 @@ private BaseAnalyzer[] getAnalyzersForModuleAndConfig(string fileName,
analysisConfig.long_line_check == Check.skipTests && !ut), analysisConfig.long_line_check == Check.skipTests && !ut),
analysisConfig.max_line_length); analysisConfig.max_line_length);
if (moduleName.shouldRun!AutoRefAssignmentCheck(analysisConfig))
checks ~= new AutoRefAssignmentCheck(args.setSkipTests(
analysisConfig.auto_ref_assignment_check == Check.skipTests && !ut));
if (moduleName.shouldRun!UselessAssertCheck(analysisConfig)) if (moduleName.shouldRun!UselessAssertCheck(analysisConfig))
checks ~= new UselessAssertCheck(args.setSkipTests( checks ~= new UselessAssertCheck(args.setSkipTests(
analysisConfig.useless_assert_check == Check.skipTests && !ut)); analysisConfig.useless_assert_check == Check.skipTests && !ut));
@ -1333,6 +1329,9 @@ MessageSet analyzeDmd(string fileName, ASTBase.Module m, const char[] moduleName
fileName, fileName,
config.opequals_tohash_check == Check.skipTests && !ut config.opequals_tohash_check == Check.skipTests && !ut
); );
if (moduleName.shouldRunDmd!(AutoRefAssignmentCheck!ASTBase)(config))
visitors ~= new AutoRefAssignmentCheck!ASTBase(fileName);
foreach (visitor; visitors) foreach (visitor; visitors)
{ {