xref: /arkcompiler/ets_frontend/ets2panda/ast_verifier/ASTVerifier.h

/*
 * Copyright (c) 2023-2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ES2PANDA_COMPILER_CORE_ASTVERIFIER_H
#define ES2PANDA_COMPILER_CORE_ASTVERIFIER_H

#include <algorithm>
#include <iterator>
#include <regex>
#include <string>
#include <unordered_set>

#include "ast_verifier/checkContext.h"

#include "ir/astNode.h"
#include "ir/statements/blockStatement.h"
#include "lexer/token/sourceLocation.h"
#include "parser/program/program.h"
#include "util/ustring.h"
#include "utils/arena_containers.h"
#include "varbinder/variable.h"

namespace ark::es2panda::compiler::ast_verifier {

using InvariantCheck = std::function<CheckResult(CheckContext &ctx, const ir::AstNode *)>;
using Invariants = std::map<std::string, InvariantCheck>;

using InvariantNameSet = std::set<std::string>;

class VerificationContext final {
public:
    void IntroduceNewInvariants(util::StringView phaseName)
    {
        if (phaseName == "ScopesInitPhase") {
            accumulatedChecks_.insert("NodeHasParentForAll");
            accumulatedChecks_.insert("NodeHasSourceRangeForAll");
            accumulatedChecks_.insert("EveryChildHasValidParentForAll");
            accumulatedChecks_.insert("EveryChildInParentRangeForAll");
            accumulatedChecks_.insert("VariableHasScopeForAll");
        }
        if (phaseName == "CheckerPhase") {
            accumulatedChecks_.insert("NodeHasTypeForAll");
            accumulatedChecks_.insert("IdentifierHasVariableForAll");
            accumulatedChecks_.insert("ReferenceTypeAnnotationIsNullForAll");
            accumulatedChecks_.insert("ArithmeticOperationValidForAll");
            accumulatedChecks_.insert("SequenceExpressionHasLastTypeForAll");
            accumulatedChecks_.insert("CheckInfiniteLoopForAll");
            accumulatedChecks_.insert("ForLoopCorrectlyInitializedForAll");
            accumulatedChecks_.insert("VariableHasEnclosingScopeForAll");
            accumulatedChecks_.insert("ModifierAccessValidForAll");
            accumulatedChecks_.insert("ImportExportAccessValid");
            accumulatedChecks_.insert("VariableNameIdentifierNameSameForAll");
            accumulatedChecks_.insert("CheckAbstractMethodForAll");
            accumulatedChecks_.insert("GetterSetterValidationForAll");
            accumulatedChecks_.insert("CheckScopeDeclarationForAll");
        }
    }

    const InvariantNameSet &AccumulatedChecks() const
    {
        return accumulatedChecks_;
    }

private:
    InvariantNameSet accumulatedChecks_ {};
};

/*
 * ASTVerifier used for checking various invariants that should hold during AST transformation in lowerings
 * For all available checks lookup the constructor
 */
class ASTVerifier final {
public:
    NO_COPY_SEMANTIC(ASTVerifier);
    NO_MOVE_SEMANTIC(ASTVerifier);

    explicit ASTVerifier(ArenaAllocator *allocator);
    ~ASTVerifier() = default;

    /**
     * @brief Run all existing invariants on some ast node (and consequently it's children)
     * @param ast AstNode which will be analyzed
     * @return Messages report of analysis
     */
    Messages VerifyFull(const ir::AstNode *ast);

    /**
     * @brief Run some particular invariants on some ast node
     * @note invariants must be supplied as strings to invariant_set, additionally invariant
     * name can be suffixed by `ForAll` string to include recursive analysis of provided node
     * I.e. 'HasParent' invariant can be named 'HasParentRecursive' to traverse all child nodes as well
     * @param ast AstNode which will be analyzed
     * @param invariantSet Set of invariants to check
     * @return Messages report of analysis
     */
    Messages Verify(const ir::AstNode *ast, const InvariantNameSet &invariantSet);

private:
    static constexpr const char *RECURSIVE_SUFFIX = "ForAll";

    static InvariantCheck RecursiveInvariant(const InvariantCheck &func)
    {
        return [func](CheckContext &ctx, const ir::AstNode *ast) -> CheckResult {
            std::function<void(const ir::AstNode *)> aux;
            auto finalDecision = CheckDecision::CORRECT;
            aux = [&ctx, func, &aux, &finalDecision](const ir::AstNode *child) -> void {
                const auto [decision, action] = func(ctx, child);
                if (decision == CheckDecision::INCORRECT) {
                    finalDecision = CheckDecision::INCORRECT;
                }
                if (action == CheckAction::SKIP_SUBTREE) {
                    return;
                }
                child->Iterate(aux);
            };
            aux(ast);
            return {finalDecision, CheckAction::CONTINUE};
        };
    }

    template <typename T>
    void AddInvariant(ArenaAllocator *allocator, const std::string &name)
    {
        auto check = *allocator->New<T>(*allocator);
        invariantsChecks_[name] = check;
        invariantsNames_.insert(name);
        invariantsChecks_[name + RECURSIVE_SUFFIX] = RecursiveInvariant(check);
        invariantsNames_.insert(name + RECURSIVE_SUFFIX);
    }

    Invariants invariantsChecks_;
    InvariantNameSet invariantsNames_;
};

}  // namespace ark::es2panda::compiler::ast_verifier

#endif  // ES2PANDA_COMPILER_CORE_ASTVERIFIER_H