symtab_visitor.hpp

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
 */
 
///
/// THIS FILE IS GENERATED AT BUILD TIME AND SHALL NOT BE EDITED.
///
 
#pragma once
 
/**
 * \file
 * \brief \copybrief nmodl::visitor::SymtabVisitor
 */
 
#include <set>
 
#include "symtab/symbol_table.hpp"
#include "visitors/ast_visitor.hpp"
#include "visitors/json_visitor.hpp"
 
namespace nmodl {
namespace visitor {
 
/**
 * @addtogroup visitor_classes
 * @{
 */
 
/**
 * \class SymtabVisitor
 * \brief Concrete visitor for constructing symbol table from AST
 */
class SymtabVisitor: public AstVisitor {
  private:
    symtab::ModelSymbolTable* modsymtab = nullptr;
 
    std::unique_ptr<printer::JSONPrinter> printer;
    std::set<std::string> block_to_solve;
    bool update = false;
    bool under_state_block = false;
 
  public:
    explicit SymtabVisitor(bool update = false)
        : printer(new printer::JSONPrinter())
        , update(update) {}
 
    SymtabVisitor(symtab::ModelSymbolTable* _modsymtab, bool update = false)
        : modsymtab(_modsymtab)
        , update(update) {}
 
    SymtabVisitor(std::ostream& os, bool update = false)
        : printer(new printer::JSONPrinter(os))
        , update(update) {}
 
    SymtabVisitor(const std::string& filename, bool update = false)
        : printer(new printer::JSONPrinter(filename))
        , update(update) {}
 
    void add_model_symbol_with_property(ast::Node* node, symtab::syminfo::NmodlType property);
 
    void setup_symbol(ast::Node* node, symtab::syminfo::NmodlType property);
 
    void setup_symbol_table(ast::Ast* node, const std::string& name, bool is_global);
 
    void setup_symbol_table_for_program_block(ast::Program* node);
 
    void setup_symbol_table_for_global_block(ast::Node* node);
 
    void setup_symbol_table_for_scoped_block(ast::Node* node, const std::string& name);
 
    // clang-format off
    void visit_prime_name(ast::PrimeName& node) override;
    void visit_argument(ast::Argument& node) override;
    void visit_read_ion_var(ast::ReadIonVar& node) override;
    void visit_write_ion_var(ast::WriteIonVar& node) override;
    void visit_nonspecific_cur_var(ast::NonspecificCurVar& node) override;
    void visit_electrode_cur_var(ast::ElectrodeCurVar& node) override;
    void visit_range_var(ast::RangeVar& node) override;
    void visit_global_var(ast::GlobalVar& node) override;
    void visit_pointer_var(ast::PointerVar& node) override;
    void visit_random_var(ast::RandomVar& node) override;
    void visit_bbcore_pointer_var(ast::BbcorePointerVar& node) override;
    void visit_extern_var(ast::ExternVar& node) override;
    void visit_param_block(ast::ParamBlock& node) override;
    void visit_independent_block(ast::IndependentBlock& node) override;
    void visit_assigned_block(ast::AssignedBlock& node) override;
    void visit_state_block(ast::StateBlock& node) override;
    void visit_initial_block(ast::InitialBlock& node) override;
    void visit_constructor_block(ast::ConstructorBlock& node) override;
    void visit_destructor_block(ast::DestructorBlock& node) override;
    void visit_statement_block(ast::StatementBlock& node) override;
    void visit_derivative_block(ast::DerivativeBlock& node) override;
    void visit_linear_block(ast::LinearBlock& node) override;
    void visit_non_linear_block(ast::NonLinearBlock& node) override;
    void visit_discrete_block(ast::DiscreteBlock& node) override;
    void visit_function_table_block(ast::FunctionTableBlock& node) override;
    void visit_function_block(ast::FunctionBlock& node) override;
    void visit_procedure_block(ast::ProcedureBlock& node) override;
    void visit_net_receive_block(ast::NetReceiveBlock& node) override;
    void visit_solve_block(ast::SolveBlock& node) override;
    void visit_breakpoint_block(ast::BreakpointBlock& node) override;
    void visit_before_block(ast::BeforeBlock& node) override;
    void visit_after_block(ast::AfterBlock& node) override;
    void visit_ba_block(ast::BABlock& node) override;
    void visit_for_netcon(ast::ForNetcon& node) override;
    void visit_kinetic_block(ast::KineticBlock& node) override;
    void visit_unit_block(ast::UnitBlock& node) override;
    void visit_constant_block(ast::ConstantBlock& node) override;
    void visit_neuron_block(ast::NeuronBlock& node) override;
    void visit_local_var(ast::LocalVar& node) override;
    void visit_constant_var(ast::ConstantVar& node) override;
    void visit_unit_def(ast::UnitDef& node) override;
    void visit_factor_def(ast::FactorDef& node) override;
    void visit_define(ast::Define& node) override;
    void visit_param_assign(ast::ParamAssign& node) override;
    void visit_assigned_definition(ast::AssignedDefinition& node) override;
    void visit_table_statement(ast::TableStatement& node) override;
    void visit_useion(ast::Useion& node) override;
    void visit_program(ast::Program& node) override;
    void visit_nrn_state_block(ast::NrnStateBlock& node) override;
    void visit_eigen_newton_solver_block(ast::EigenNewtonSolverBlock& node) override;
    void visit_eigen_linear_solver_block(ast::EigenLinearSolverBlock& node) override;
    // clang-format on
};
 
/** @} */  // end of visitor_classes
 
}  // namespace visitor
}  // namespace nmodl