From a3fe7611a8320675a4c2e96d9aa2f9c720e85f45 Mon Sep 17 00:00:00 2001 From: WebFreak001 Date: Mon, 31 Jan 2022 18:04:17 +0100 Subject: [PATCH 1/5] implement new ThrowExpression & shortened methods --- .../analysis/incorrect_infinite_range.d | 11 +++++-- .../properly_documented_public_functions.d | 29 ++++++++++--------- src/dscanner/analysis/unused.d | 6 ++-- src/dscanner/astprinter.d | 2 +- 4 files changed, 30 insertions(+), 18 deletions(-) diff --git a/src/dscanner/analysis/incorrect_infinite_range.d b/src/dscanner/analysis/incorrect_infinite_range.d index 1df6b3e..ce3e339 100644 --- a/src/dscanner/analysis/incorrect_infinite_range.d +++ b/src/dscanner/analysis/incorrect_infinite_range.d @@ -46,6 +46,8 @@ final class IncorrectInfiniteRangeCheck : BaseAnalyzer { if (fb.specifiedFunctionBody && fb.specifiedFunctionBody.blockStatement !is null) visit(fb.specifiedFunctionBody.blockStatement); + else if (fb.shortenedFunctionBody && fb.shortenedFunctionBody.expression !is null) + visitReturnExpression(fb.shortenedFunctionBody.expression); } override void visit(const BlockStatement bs) @@ -63,9 +65,14 @@ final class IncorrectInfiniteRangeCheck : BaseAnalyzer { if (inStruct == 0 || line == size_t.max) // not within a struct yet return; - if (!rs.expression || rs.expression.items.length != 1) + visitReturnExpression(rs.expression); + } + + void visitReturnExpression(const Expression expression) + { + if (!expression || expression.items.length != 1) return; - UnaryExpression unary = cast(UnaryExpression) rs.expression.items[0]; + UnaryExpression unary = cast(UnaryExpression) expression.items[0]; if (unary is null) return; if (unary.primaryExpression is null) diff --git a/src/dscanner/analysis/properly_documented_public_functions.d b/src/dscanner/analysis/properly_documented_public_functions.d index 70c2d2a..a27f313 100644 --- a/src/dscanner/analysis/properly_documented_public_functions.d +++ b/src/dscanner/analysis/properly_documented_public_functions.d @@ -55,6 +55,8 @@ final class ProperlyDocumentedPublicFunctions : BaseAnalyzer override void visit(const UnaryExpression decl) { + import std.algorithm.searching : canFind; + const IdentifierOrTemplateInstance iot = safeAccess(decl) .functionCallExpression.unaryExpression.primaryExpression .identifierOrTemplateInstance; @@ -69,6 +71,12 @@ final class ProperlyDocumentedPublicFunctions : BaseAnalyzer return t; } + if (inThrowExpression && decl.newExpression && decl.newExpression.type && + !thrown.canFind!(a => a == decl.newExpression.type)) + { + thrown ~= decl.newExpression.type; + } + // enforce(condition); if (iot && iot.identifier.text == "enforce") { @@ -187,7 +195,7 @@ final class ProperlyDocumentedPublicFunctions : BaseAnalyzer if (nestedFuncs == 1) thrown.length = 0; - // detect ThrowStatement only if not nothrow + // detect ThrowExpression only if not nothrow if (!decl.attributes.any!(a => a.attribute.text == "nothrow")) { decl.accept(this); @@ -228,20 +236,14 @@ final class ProperlyDocumentedPublicFunctions : BaseAnalyzer .array; } - override void visit(const ThrowStatement ts) + override void visit(const ThrowExpression ts) { - import std.algorithm.searching : canFind; - + const wasInThrowExpression = inThrowExpression; + inThrowExpression = true; + scope (exit) + inThrowExpression = wasInThrowExpression; ts.accept(this); - if (ts.expression && ts.expression.items.length == 1) - if (const UnaryExpression ue = cast(UnaryExpression) ts.expression.items[0]) - { - if (ue.newExpression && ue.newExpression.type && - !thrown.canFind!(a => a == ue.newExpression.type)) - { - thrown ~= ue.newExpression.type; - } - } + inThrowExpression = false; } alias visit = BaseAnalyzer.visit; @@ -260,6 +262,7 @@ private: } Function lastSeenFun; + bool inThrowExpression; const(Type)[] thrown; // find invalid ddoc parameters (i.e. they don't occur in a function declaration) diff --git a/src/dscanner/analysis/unused.d b/src/dscanner/analysis/unused.d index f1d00b6..890a764 100644 --- a/src/dscanner/analysis/unused.d +++ b/src/dscanner/analysis/unused.d @@ -48,7 +48,9 @@ abstract class UnusedIdentifierCheck : BaseAnalyzer override void visit(const FunctionDeclaration functionDec) { pushScope(); - if (functionDec.functionBody && functionDec.functionBody.specifiedFunctionBody) + if (functionDec.functionBody + && (functionDec.functionBody.specifiedFunctionBody + || functionDec.functionBody.shortenedFunctionBody)) { immutable bool ias = inAggregateScope; inAggregateScope = false; @@ -74,7 +76,7 @@ abstract class UnusedIdentifierCheck : BaseAnalyzer mixin PartsUseVariables!StaticIfCondition; mixin PartsUseVariables!StructDeclaration; mixin PartsUseVariables!TemplateArgumentList; - mixin PartsUseVariables!ThrowStatement; + mixin PartsUseVariables!ThrowExpression; mixin PartsUseVariables!CastExpression; override void visit(const SwitchStatement switchStatement) diff --git a/src/dscanner/astprinter.d b/src/dscanner/astprinter.d index 020e083..50bff99 100644 --- a/src/dscanner/astprinter.d +++ b/src/dscanner/astprinter.d @@ -1146,7 +1146,7 @@ class XMLPrinter : ASTVisitor override void visit(const TemplateValueParameter templateValueParameter) { mixin (tagAndAccept!"templateValueParameter"); } override void visit(const TernaryExpression ternaryExpression) { mixin (tagAndAccept!"ternaryExpression"); } override void visit(const TypeIdentifierPart typeIdentifierPart) { mixin (tagAndAccept!"typeIdentifierPart"); } - override void visit(const ThrowStatement throwStatement) { mixin (tagAndAccept!"throwStatement"); } + override void visit(const ThrowExpression throwExpression) { mixin (tagAndAccept!"throwExpression"); } override void visit(const TryStatement tryStatement) { mixin (tagAndAccept!"tryStatement"); } override void visit(const TemplateInstance templateInstance) { mixin (tagAndAccept!"templateInstance"); } override void visit(const TypeofExpression typeofExpression) { mixin (tagAndAccept!"typeofExpression"); } override void visit(const TypeSpecialization typeSpecialization) { mixin (tagAndAccept!"typeSpecialization"); } override void visit(const TraitsExpression traitsExpression) { mixin (tagAndAccept!"traitsExpression"); } override void visit(const Vector vector) { mixin (tagAndAccept!"vector"); } From 631791e14dd0d32dc85436c4e94fb7fd63fd48fd Mon Sep 17 00:00:00 2001 From: WebFreak001 Date: Wed, 2 Feb 2022 21:02:29 +0100 Subject: [PATCH 2/5] add tests for shortened function body extensions Remove implementation in unused label (expressions can't have labels) --- .../analysis/incorrect_infinite_range.d | 16 ++++++++++++++++ .../properly_documented_public_functions.d | 17 ++++++++++++++++- src/dscanner/analysis/unused_label.d | 4 +--- 3 files changed, 33 insertions(+), 4 deletions(-) diff --git a/src/dscanner/analysis/incorrect_infinite_range.d b/src/dscanner/analysis/incorrect_infinite_range.d index ce3e339..055f05b 100644 --- a/src/dscanner/analysis/incorrect_infinite_range.d +++ b/src/dscanner/analysis/incorrect_infinite_range.d @@ -126,6 +126,22 @@ unittest } } +struct InfiniteRange +{ + bool empty() => false; // [warn]: %1$s + bool stuff() => false; + unittest + { + return false; + } + + // https://issues.dlang.org/show_bug.cgi?id=18409 + struct Foo + { + ~this() nothrow @nogc; + } +} + bool empty() { return false; } class C { bool empty() { return false; } } // [warn]: %1$s diff --git a/src/dscanner/analysis/properly_documented_public_functions.d b/src/dscanner/analysis/properly_documented_public_functions.d index a27f313..3f7b3c9 100644 --- a/src/dscanner/analysis/properly_documented_public_functions.d +++ b/src/dscanner/analysis/properly_documented_public_functions.d @@ -190,7 +190,8 @@ final class ProperlyDocumentedPublicFunctions : BaseAnalyzer import std.array : Appender; // ignore header declaration for now - if (!decl.functionBody || !decl.functionBody.specifiedFunctionBody) + if (!decl.functionBody || (!decl.functionBody.specifiedFunctionBody + && !decl.functionBody.shortenedFunctionBody)) return; if (nestedFuncs == 1) @@ -659,6 +660,20 @@ int foo(int k){} // [warn]: %s assertAnalyzerWarnings(q{ /** + * Description. + * + * Params: + * + * Returns: + * A long description. + */ +int foo(int k) => k; // [warn]: %s + }c.format( + ProperlyDocumentedPublicFunctions.MISSING_PARAMS_MESSAGE.format("k") + ), sac); + + assertAnalyzerWarnings(q{ +/** Description. Params: diff --git a/src/dscanner/analysis/unused_label.d b/src/dscanner/analysis/unused_label.d index ed02880..b70d398 100644 --- a/src/dscanner/analysis/unused_label.d +++ b/src/dscanner/analysis/unused_label.d @@ -51,10 +51,8 @@ final class UnusedLabelCheck : BaseAnalyzer functionBody.specifiedFunctionBody.accept(this); popScope(); } - if (functionBody.missingFunctionBody && functionBody.missingFunctionBody.functionContracts) + if (functionBody.missingFunctionBody && functionBody.missingFunctionBody.functionContracts) functionBody.missingFunctionBody.functionContracts.each!((a){pushScope(); a.accept(this); popScope();}); - if (functionBody.specifiedFunctionBody && functionBody.specifiedFunctionBody.functionContracts) - functionBody.specifiedFunctionBody.functionContracts.each!((a){pushScope(); a.accept(this); popScope();}); } override void visit(const LabeledStatement labeledStatement) From 7f93ffaa1f445f96d18f83cf07ce7ffbff8ef4ec Mon Sep 17 00:00:00 2001 From: WebFreak001 Date: Wed, 2 Feb 2022 21:31:28 +0100 Subject: [PATCH 3/5] add test that #499 is fixed --- src/dscanner/analysis/undocumented.d | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/dscanner/analysis/undocumented.d b/src/dscanner/analysis/undocumented.d index 36551d1..f1d8157 100644 --- a/src/dscanner/analysis/undocumented.d +++ b/src/dscanner/analysis/undocumented.d @@ -347,5 +347,15 @@ unittest deprecated auto func()(){} }, sac); + assertAnalyzerWarnings(q{ + class C{} /// a + interface I{} /// b + enum e = 0; /// c + void f(){} /// d + struct S{} /// e + template T(){} /// f + union U{} /// g + }, sac); + stderr.writeln("Unittest for UndocumentedDeclarationCheck passed."); } From 61b65a9a5517751becf37eb173893488e1b561bb Mon Sep 17 00:00:00 2001 From: WebFreak001 Date: Mon, 7 Feb 2022 20:05:42 +0100 Subject: [PATCH 4/5] actually upgrade libdparse and dsymbol now --- dub.json | 4 ++-- libdparse | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/dub.json b/dub.json index a928e8c..a1745bd 100644 --- a/dub.json +++ b/dub.json @@ -12,8 +12,8 @@ "StdLoggerDisableWarning" ], "dependencies" : { - "libdparse": ">=0.17.0 <1.0.0", - "dsymbol" : ">=0.11.3 <0.12.0", + "libdparse": ">=0.19.0 <1.0.0", + "dsymbol" : ">=0.13.0 <1.0.0", "inifiled" : "~>1.3.1", "emsi_containers" : "~>0.8.0", "libddoc" : "~>0.8.0", diff --git a/libdparse b/libdparse index 7112880..205fa27 160000 --- a/libdparse +++ b/libdparse @@ -1 +1 @@ -Subproject commit 7112880dae3f25553d96dae53a445c16261de7f9 +Subproject commit 205fa27ff39e46d7f2acea0a0f7c9deee0076231 From 6d7ca3282264f1275309bde34a9fcf59492c7055 Mon Sep 17 00:00:00 2001 From: WebFreak001 Date: Mon, 7 Feb 2022 23:20:51 +0100 Subject: [PATCH 5/5] bump dsymbol to 0.13.0 --- dsymbol | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dsymbol b/dsymbol index 666aed3..7e5aaa2 160000 --- a/dsymbol +++ b/dsymbol @@ -1 +1 @@ -Subproject commit 666aed31f6224af737199374cbe7c8c9416c6d80 +Subproject commit 7e5aaa2c6c9bec226e51bcce2e0364ea3fd6a01d