nmodl_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::NmodlPrintVisitor
 */
 
#include <set>
 
#include "visitors/visitor.hpp"
#include "printer/nmodl_printer.hpp"
 
namespace nmodl {
namespace visitor {
 
/**
 * \addtogroup visitor_classes
 * \{
 */
 
/**
 * \class NmodlPrintVisitor
 * \brief %Visitor for printing AST back to NMODL
 *
 * \note AstNodeType::INDEPENDENT_BLOCK representation in the AST has
 *       been trimmed as the `INDEPENDENT {}` block is now deprecated
 *       and considered an unused construct in MOD files. If a user
 *       attempts to print a MOD file containing an INDEPENDENT block,
 *       it will be skipped, and a comment will be added to indicate
 *       the deprecation.
 */
 
class NmodlPrintVisitor: public ConstVisitor {
  private:
    std::unique_ptr<printer::NMODLPrinter> printer;
 
    /// node types to exclude while printing
    std::set<ast::AstNodeType> exclude_types;
 
    /// check if node is to be excluded while printing
    bool is_exclude_type(ast::AstNodeType type) const {
        return exclude_types.find(type) != exclude_types.end();
    }
 
  public:
    NmodlPrintVisitor()
        : printer(new printer::NMODLPrinter()) {}
 
    NmodlPrintVisitor(std::string filename)
        : printer(new printer::NMODLPrinter(filename)) {}
 
    NmodlPrintVisitor(std::ostream& stream)
        : printer(new printer::NMODLPrinter(stream)) {}
 
    NmodlPrintVisitor(std::ostream& stream, const std::set<ast::AstNodeType>& types)
        : printer(new printer::NMODLPrinter(stream))
        , exclude_types(types){}
 
    // clang-format off
    virtual void visit_node(const ast::Node& node) override;
    virtual void visit_statement(const ast::Statement& node) override;
    virtual void visit_expression(const ast::Expression& node) override;
    virtual void visit_block(const ast::Block& node) override;
    virtual void visit_identifier(const ast::Identifier& node) override;
    virtual void visit_number(const ast::Number& node) override;
    virtual void visit_string(const ast::String& node) override;
    virtual void visit_integer(const ast::Integer& node) override;
    virtual void visit_float(const ast::Float& node) override;
    virtual void visit_double(const ast::Double& node) override;
    virtual void visit_boolean(const ast::Boolean& node) override;
    virtual void visit_name(const ast::Name& node) override;
    virtual void visit_prime_name(const ast::PrimeName& node) override;
    virtual void visit_indexed_name(const ast::IndexedName& node) override;
    virtual void visit_var_name(const ast::VarName& node) override;
    virtual void visit_argument(const ast::Argument& node) override;
    virtual void visit_react_var_name(const ast::ReactVarName& node) override;
    virtual void visit_read_ion_var(const ast::ReadIonVar& node) override;
    virtual void visit_write_ion_var(const ast::WriteIonVar& node) override;
    virtual void visit_nonspecific_cur_var(const ast::NonspecificCurVar& node) override;
    virtual void visit_electrode_cur_var(const ast::ElectrodeCurVar& node) override;
    virtual void visit_range_var(const ast::RangeVar& node) override;
    virtual void visit_global_var(const ast::GlobalVar& node) override;
    virtual void visit_pointer_var(const ast::PointerVar& node) override;
    virtual void visit_random_var(const ast::RandomVar& node) override;
    virtual void visit_bbcore_pointer_var(const ast::BbcorePointerVar& node) override;
    virtual void visit_extern_var(const ast::ExternVar& node) override;
    virtual void visit_param_block(const ast::ParamBlock& node) override;
    virtual void visit_independent_block(const ast::IndependentBlock& node) override;
    virtual void visit_assigned_block(const ast::AssignedBlock& node) override;
    virtual void visit_state_block(const ast::StateBlock& node) override;
    virtual void visit_initial_block(const ast::InitialBlock& node) override;
    virtual void visit_constructor_block(const ast::ConstructorBlock& node) override;
    virtual void visit_destructor_block(const ast::DestructorBlock& node) override;
    virtual void visit_statement_block(const ast::StatementBlock& node) override;
    virtual void visit_derivative_block(const ast::DerivativeBlock& node) override;
    virtual void visit_linear_block(const ast::LinearBlock& node) override;
    virtual void visit_non_linear_block(const ast::NonLinearBlock& node) override;
    virtual void visit_discrete_block(const ast::DiscreteBlock& node) override;
    virtual void visit_function_table_block(const ast::FunctionTableBlock& node) override;
    virtual void visit_function_block(const ast::FunctionBlock& node) override;
    virtual void visit_procedure_block(const ast::ProcedureBlock& node) override;
    virtual void visit_net_receive_block(const ast::NetReceiveBlock& node) override;
    virtual void visit_solve_block(const ast::SolveBlock& node) override;
    virtual void visit_breakpoint_block(const ast::BreakpointBlock& node) override;
    virtual void visit_before_block(const ast::BeforeBlock& node) override;
    virtual void visit_after_block(const ast::AfterBlock& node) override;
    virtual void visit_ba_block(const ast::BABlock& node) override;
    virtual void visit_for_netcon(const ast::ForNetcon& node) override;
    virtual void visit_kinetic_block(const ast::KineticBlock& node) override;
    virtual void visit_unit_block(const ast::UnitBlock& node) override;
    virtual void visit_constant_block(const ast::ConstantBlock& node) override;
    virtual void visit_neuron_block(const ast::NeuronBlock& node) override;
    virtual void visit_unit(const ast::Unit& node) override;
    virtual void visit_double_unit(const ast::DoubleUnit& node) override;
    virtual void visit_local_var(const ast::LocalVar& node) override;
    virtual void visit_limits(const ast::Limits& node) override;
    virtual void visit_number_range(const ast::NumberRange& node) override;
    virtual void visit_constant_var(const ast::ConstantVar& node) override;
    virtual void visit_binary_operator(const ast::BinaryOperator& node) override;
    virtual void visit_unary_operator(const ast::UnaryOperator& node) override;
    virtual void visit_reaction_operator(const ast::ReactionOperator& node) override;
    virtual void visit_paren_expression(const ast::ParenExpression& node) override;
    virtual void visit_binary_expression(const ast::BinaryExpression& node) override;
    virtual void visit_diff_eq_expression(const ast::DiffEqExpression& node) override;
    virtual void visit_unary_expression(const ast::UnaryExpression& node) override;
    virtual void visit_non_lin_equation(const ast::NonLinEquation& node) override;
    virtual void visit_lin_equation(const ast::LinEquation& node) override;
    virtual void visit_function_call(const ast::FunctionCall& node) override;
    virtual void visit_watch(const ast::Watch& node) override;
    virtual void visit_ba_block_type(const ast::BABlockType& node) override;
    virtual void visit_unit_def(const ast::UnitDef& node) override;
    virtual void visit_factor_def(const ast::FactorDef& node) override;
    virtual void visit_valence(const ast::Valence& node) override;
    virtual void visit_unit_state(const ast::UnitState& node) override;
    virtual void visit_local_list_statement(const ast::LocalListStatement& node) override;
    virtual void visit_model(const ast::Model& node) override;
    virtual void visit_define(const ast::Define& node) override;
    virtual void visit_include(const ast::Include& node) override;
    virtual void visit_param_assign(const ast::ParamAssign& node) override;
    virtual void visit_assigned_definition(const ast::AssignedDefinition& node) override;
    virtual void visit_conductance_hint(const ast::ConductanceHint& node) override;
    virtual void visit_expression_statement(const ast::ExpressionStatement& node) override;
    virtual void visit_protect_statement(const ast::ProtectStatement& node) override;
    virtual void visit_from_statement(const ast::FromStatement& node) override;
    virtual void visit_while_statement(const ast::WhileStatement& node) override;
    virtual void visit_if_statement(const ast::IfStatement& node) override;
    virtual void visit_else_if_statement(const ast::ElseIfStatement& node) override;
    virtual void visit_else_statement(const ast::ElseStatement& node) override;
    virtual void visit_watch_statement(const ast::WatchStatement& node) override;
    virtual void visit_mutex_lock(const ast::MutexLock& node) override;
    virtual void visit_mutex_unlock(const ast::MutexUnlock& node) override;
    virtual void visit_conserve(const ast::Conserve& node) override;
    virtual void visit_compartment(const ast::Compartment& node) override;
    virtual void visit_lon_difuse(const ast::LonDifuse& node) override;
    virtual void visit_reaction_statement(const ast::ReactionStatement& node) override;
    virtual void visit_lag_statement(const ast::LagStatement& node) override;
    virtual void visit_constant_statement(const ast::ConstantStatement& node) override;
    virtual void visit_table_statement(const ast::TableStatement& node) override;
    virtual void visit_suffix(const ast::Suffix& node) override;
    virtual void visit_useion(const ast::Useion& node) override;
    virtual void visit_nonspecific(const ast::Nonspecific& node) override;
    virtual void visit_electrode_current(const ast::ElectrodeCurrent& node) override;
    virtual void visit_range(const ast::Range& node) override;
    virtual void visit_global(const ast::Global& node) override;
    virtual void visit_random_var_list(const ast::RandomVarList& node) override;
    virtual void visit_pointer(const ast::Pointer& node) override;
    virtual void visit_bbcore_pointer(const ast::BbcorePointer& node) override;
    virtual void visit_external(const ast::External& node) override;
    virtual void visit_thread_safe(const ast::ThreadSafe& node) override;
    virtual void visit_verbatim(const ast::Verbatim& node) override;
    virtual void visit_line_comment(const ast::LineComment& node) override;
    virtual void visit_block_comment(const ast::BlockComment& node) override;
    virtual void visit_ontology_statement(const ast::OntologyStatement& node) override;
    virtual void visit_program(const ast::Program& node) override;
    virtual void visit_nrn_state_block(const ast::NrnStateBlock& node) override;
    virtual void visit_eigen_newton_solver_block(const ast::EigenNewtonSolverBlock& node) override;
    virtual void visit_eigen_linear_solver_block(const ast::EigenLinearSolverBlock& node) override;
    virtual void visit_wrapped_expression(const ast::WrappedExpression& node) override;
    virtual void visit_derivimplicit_callback(const ast::DerivimplicitCallback& node) override;
    virtual void visit_solution_expression(const ast::SolutionExpression& node) override;
    virtual void visit_update_dt(const ast::UpdateDt& node) override;
    // clang-format on
 
    template <typename T>
    void visit_element(const std::vector<T>& elements,
                       const std::string& separator,
                       bool program,
                       bool statement);
};
 
/** \} */  // end of visitor_classes
 
}  // namespace visitor
}  // namespace nmodl