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 #include "ast_verifier/checkConstProperties.h"
38
39 namespace ark::es2panda::compiler::ast_verifier {
40
ASTVerifier(ArenaAllocator * allocator)41 ASTVerifier::ASTVerifier(ArenaAllocator *allocator)
42 {
43 AddInvariant<NodeHasParent>(allocator, "NodeHasParent");
44 AddInvariant<NodeHasSourceRange>(allocator, "NodeHasSourceRange");
45 AddInvariant<NodeHasType>(allocator, "NodeHasType");
46 AddInvariant<IdentifierHasVariable>(allocator, "IdentifierHasVariable");
47 AddInvariant<VariableHasScope>(allocator, "VariableHasScope");
48 AddInvariant<EveryChildHasValidParent>(allocator, "EveryChildHasValidParent");
49 AddInvariant<EveryChildInParentRange>(allocator, "EveryChildInParentRange");
50 AddInvariant<VariableHasEnclosingScope>(allocator, "VariableHasEnclosingScope");
51 AddInvariant<CheckInfiniteLoop>(allocator, "CheckInfiniteLoop");
52 AddInvariant<ForLoopCorrectlyInitialized>(allocator, "ForLoopCorrectlyInitialized");
53 AddInvariant<ModifierAccessValid>(allocator, "ModifierAccessValid");
54 AddInvariant<ImportExportAccessValid>(allocator, "ImportExportAccessValid");
55 AddInvariant<ArithmeticOperationValid>(allocator, "ArithmeticOperationValid");
56 AddInvariant<SequenceExpressionHasLastType>(allocator, "SequenceExpressionHasLastType");
57 AddInvariant<ReferenceTypeAnnotationIsNull>(allocator, "ReferenceTypeAnnotationIsNull");
58 AddInvariant<VariableNameIdentifierNameSame>(allocator, "VariableNameIdentifierNameSame");
59 AddInvariant<CheckAbstractMethod>(allocator, "CheckAbstractMethod");
60 AddInvariant<GetterSetterValidation>(allocator, "GetterSetterValidation");
61 AddInvariant<CheckScopeDeclaration>(allocator, "CheckScopeDeclaration");
62 AddInvariant<CheckConstProperties>(allocator, "CheckConstProperties");
63 }
64
VerifyFull(const ir::AstNode * ast)65 Messages ASTVerifier::VerifyFull(const ir::AstNode *ast)
66 {
67 auto recursiveChecks = InvariantNameSet {};
68 std::copy_if(invariantsNames_.begin(), invariantsNames_.end(),
69 std::inserter(recursiveChecks, recursiveChecks.end()),
70 [](const std::string &s) { return s.find(RECURSIVE_SUFFIX) != s.npos; });
71 return Verify(ast, recursiveChecks);
72 }
73
Verify(const ir::AstNode * ast,const InvariantNameSet & invariantSet)74 Messages ASTVerifier::Verify(const ir::AstNode *ast, const InvariantNameSet &invariantSet)
75 {
76 CheckContext ctx {};
77 const auto containsInvariants =
78 std::includes(invariantsNames_.begin(), invariantsNames_.end(), invariantSet.begin(), invariantSet.end());
79 if (!containsInvariants) {
80 auto invalidInvariants = InvariantNameSet {};
81 for (const auto &invariant : invariantSet) {
82 if (invariantsNames_.find(invariant) == invariantsNames_.end()) {
83 invalidInvariants.insert(invariant);
84 }
85 }
86 for (const auto &invariant : invalidInvariants) {
87 ctx.AddCheckMessage(std::string {"Invariant was not found: "} + invariant, *ast, lexer::SourcePosition {});
88 }
89 }
90
91 for (const auto &name : invariantSet) {
92 if (const auto &found = invariantsChecks_.find(name); found != invariantsChecks_.end()) {
93 if (ast == nullptr) {
94 continue;
95 }
96
97 auto invariant = found->second;
98 ctx.SetCheckName(name.data());
99 invariant(ctx, ast);
100 }
101 }
102
103 return ctx.GetMessages();
104 }
105
106 } // namespace ark::es2panda::compiler::ast_verifier
107