local_to_assigned.cpp

Go to the documentation of this file.

/*
 * Copyright 2023 Blue Brain Project, EPFL.
 * See the top-level LICENSE file for details.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#include <catch2/catch_test_macros.hpp>
 
#include "ast/program.hpp"
#include "parser/nmodl_driver.hpp"
#include "test/unit/utils/nmodl_constructs.hpp"
#include "visitors/local_to_assigned_visitor.hpp"
#include "visitors/nmodl_visitor.hpp"
#include "visitors/perf_visitor.hpp"
#include "visitors/symtab_visitor.hpp"
 
using namespace nmodl;
using namespace visitor;
using namespace test_utils;
 
using nmodl::parser::NmodlDriver;
using symtab::syminfo::NmodlType;
 
//=============================================================================
// GlobalToRange visitor tests
//=============================================================================
 
std::shared_ptr<ast::Program> run_local_to_assigned_visitor(const std::string& text) {
    std::map<std::string, std::string> rval;
    NmodlDriver driver;
    auto ast = driver.parse_string(text);
 
    SymtabVisitor().visit_program(*ast);
    PerfVisitor().visit_program(*ast);
    LocalToAssignedVisitor().visit_program(*ast);
    SymtabVisitor().visit_program(*ast);
    return ast;
}
 
SCENARIO("LOCAL to ASSIGNED variable transformer", "[visitor][localtoassigned]") {
    GIVEN("mod file with LOCAL variables that are written") {
        std::string input_nmodl = R"(
            NEURON {
                SUFFIX test
            }
 
            LOCAL x, y, z
 
            INITIAL {
                x = 1
            }
 
            BREAKPOINT {
                z = 2
            }
        )";
 
        auto ast = run_local_to_assigned_visitor(input_nmodl);
        auto symtab = ast->get_symbol_table();
 
        THEN("LOCAL variables that are written are turned to ASSIGNED") {
            /// check for all ASSIGNED variables : old ones + newly converted ones
            auto vars = symtab->get_variables_with_properties(NmodlType::assigned_definition);
            REQUIRE(vars.size() == 2);
 
            /// x and z should be converted from LOCAL to ASSIGNED
            auto x = symtab->lookup("x");
            REQUIRE(x != nullptr);
            REQUIRE(x->has_any_property(NmodlType::assigned_definition) == true);
            REQUIRE(x->has_any_property(NmodlType::local_var) == false);
 
            auto z = symtab->lookup("z");
            REQUIRE(z != nullptr);
            REQUIRE(z->has_any_property(NmodlType::assigned_definition) == true);
            REQUIRE(z->has_any_property(NmodlType::local_var) == false);
        }
 
        THEN("LOCAL variables that are read only remain LOCAL") {
            auto vars = symtab->get_variables_with_properties(NmodlType::local_var);
            REQUIRE(vars.size() == 1);
            REQUIRE(vars[0]->get_name() == "y");
        }
    }
}