1 /*
2 * Copyright (c) 2023-2024 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "ASTVerifier.h"
17 #include "ast_verifier/sequenceExpressionHasLastType.h"
18 #include "ast_verifier/checkAbstractMethod.h"
19 #include "ast_verifier/checkInfiniteLoop.h"
20 #include "ast_verifier/checkContext.h"
21 #include "ast_verifier/everyChildHasValidParent.h"
22 #include "ast_verifier/everyChildInParentRange.h"
23 #include "ast_verifier/getterSetterValidation.h"
24 #include "ast_verifier/identifierHasVariable.h"
25 #include "ast_verifier/nodeHasParent.h"
26 #include "ast_verifier/nodeHasSourceRange.h"
27 #include "ast_verifier/nodeHasType.h"
28 #include "ast_verifier/referenceTypeAnnotationIsNull.h"
29 #include "ast_verifier/variableHasScope.h"
30 #include "ast_verifier/variableHasEnclosingScope.h"
31 #include "ast_verifier/forLoopCorrectlyInitialized.h"
32 #include "ast_verifier/modifierAccessValid.h"
33 #include "ast_verifier/importExportAccessValid.h"
34 #include "ast_verifier/arithmeticOperationValid.h"
35 #include "ast_verifier/variableNameIdentifierNameSame.h"
36 #include "ast_verifier/checkScopeDeclaration.h"
37
38 namespace ark::es2panda::compiler::ast_verifier {
39
ASTVerifier(ArenaAllocator *allocator)40 ASTVerifier::ASTVerifier(ArenaAllocator *allocator)
41 {
42 AddInvariant<NodeHasParent>(allocator, "NodeHasParent");
43 AddInvariant<NodeHasSourceRange>(allocator, "NodeHasSourceRange");
44 AddInvariant<NodeHasType>(allocator, "NodeHasType");
45 AddInvariant<IdentifierHasVariable>(allocator, "IdentifierHasVariable");
46 AddInvariant<VariableHasScope>(allocator, "VariableHasScope");
47 AddInvariant<EveryChildHasValidParent>(allocator, "EveryChildHasValidParent");
48 AddInvariant<EveryChildInParentRange>(allocator, "EveryChildInParentRange");
49 AddInvariant<VariableHasEnclosingScope>(allocator, "VariableHasEnclosingScope");
50 AddInvariant<CheckInfiniteLoop>(allocator, "CheckInfiniteLoop");
51 AddInvariant<ForLoopCorrectlyInitialized>(allocator, "ForLoopCorrectlyInitialized");
52 AddInvariant<ModifierAccessValid>(allocator, "ModifierAccessValid");
53 AddInvariant<ImportExportAccessValid>(allocator, "ImportExportAccessValid");
54 AddInvariant<ArithmeticOperationValid>(allocator, "ArithmeticOperationValid");
55 AddInvariant<SequenceExpressionHasLastType>(allocator, "SequenceExpressionHasLastType");
56 AddInvariant<ReferenceTypeAnnotationIsNull>(allocator, "ReferenceTypeAnnotationIsNull");
57 AddInvariant<VariableNameIdentifierNameSame>(allocator, "VariableNameIdentifierNameSame");
58 AddInvariant<CheckAbstractMethod>(allocator, "CheckAbstractMethod");
59 AddInvariant<GetterSetterValidation>(allocator, "GetterSetterValidation");
60 AddInvariant<CheckScopeDeclaration>(allocator, "CheckScopeDeclaration");
61 }
62
VerifyFull(const ir::AstNode *ast)63 Messages ASTVerifier::VerifyFull(const ir::AstNode *ast)
64 {
65 auto recursiveChecks = InvariantNameSet {};
66 std::copy_if(invariantsNames_.begin(), invariantsNames_.end(),
67 std::inserter(recursiveChecks, recursiveChecks.end()),
68 [](const std::string &s) { return s.find(RECURSIVE_SUFFIX) != s.npos; });
69 return Verify(ast, recursiveChecks);
70 }
71
Verify(const ir::AstNode *ast, const InvariantNameSet &invariantSet)72 Messages ASTVerifier::Verify(const ir::AstNode *ast, const InvariantNameSet &invariantSet)
73 {
74 CheckContext ctx {};
75 const auto containsInvariants =
76 std::includes(invariantsNames_.begin(), invariantsNames_.end(), invariantSet.begin(), invariantSet.end());
77 if (!containsInvariants) {
78 auto invalidInvariants = InvariantNameSet {};
79 for (const auto &invariant : invariantSet) {
80 if (invariantsNames_.find(invariant) == invariantsNames_.end()) {
81 invalidInvariants.insert(invariant);
82 }
83 }
84 for (const auto &invariant : invalidInvariants) {
85 ctx.AddCheckMessage(std::string {"Invariant was not found: "} + invariant, *ast, lexer::SourcePosition {});
86 }
87 }
88
89 for (const auto &name : invariantSet) {
90 if (const auto &found = invariantsChecks_.find(name); found != invariantsChecks_.end()) {
91 if (ast == nullptr) {
92 continue;
93 }
94
95 auto invariant = found->second;
96 ctx.SetCheckName(name.data());
97 invariant(ctx, ast);
98 }
99 }
100
101 return ctx.GetMessages();
102 }
103
104 } // namespace ark::es2panda::compiler::ast_verifier
105