Visitor for printing compatibility issues of the mod file More...

Detailed Description

Visitor for printing compatibility issues of the mod file

INDEPENDENT_BLOCK is ignored (no error raised) as stated in: https://www.neuron.yale.edu/neuron/static/py_doc/modelspec/programmatic/mechanisms/nmodl.html

Definition at line 42 of file codegen_compatibility_visitor.hpp.

#include <codegen_compatibility_visitor.hpp>

Inheritance diagram for nmodl::codegen::CodegenCompatibilityVisitor:

Public Member Functions
bool	find_unhandled_ast_nodes (Ast &node) const
	Search the ast::Ast for nodes that are incompatible with NMODL `C++` code generator. More...

Ctor & dtor
	CodegenCompatibilityVisitor (const std::string &simulator="coreneuron")
	Default CodegenCompatibilityVisitor constructor. More...

Public Member Functions inherited from nmodl::visitor::AstVisitor
void	visit_node (ast::Node &node) override
	visit node of type ast::Node More...

void	visit_statement (ast::Statement &node) override
	visit node of type ast::Statement More...

void	visit_expression (ast::Expression &node) override
	visit node of type ast::Expression More...

void	visit_block (ast::Block &node) override
	visit node of type ast::Block More...

void	visit_identifier (ast::Identifier &node) override
	visit node of type ast::Identifier More...

void	visit_number (ast::Number &node) override
	visit node of type ast::Number More...

void	visit_string (ast::String &node) override
	visit node of type ast::String More...

void	visit_integer (ast::Integer &node) override
	visit node of type ast::Integer More...

void	visit_float (ast::Float &node) override
	visit node of type ast::Float More...

void	visit_double (ast::Double &node) override
	visit node of type ast::Double More...

void	visit_boolean (ast::Boolean &node) override
	visit node of type ast::Boolean More...

void	visit_name (ast::Name &node) override
	visit node of type ast::Name More...

void	visit_prime_name (ast::PrimeName &node) override
	visit node of type ast::PrimeName More...

void	visit_indexed_name (ast::IndexedName &node) override
	visit node of type ast::IndexedName More...

void	visit_var_name (ast::VarName &node) override
	visit node of type ast::VarName More...

void	visit_argument (ast::Argument &node) override
	visit node of type ast::Argument More...

void	visit_react_var_name (ast::ReactVarName &node) override
	visit node of type ast::ReactVarName More...

void	visit_read_ion_var (ast::ReadIonVar &node) override
	visit node of type ast::ReadIonVar More...

void	visit_write_ion_var (ast::WriteIonVar &node) override
	visit node of type ast::WriteIonVar More...

void	visit_nonspecific_cur_var (ast::NonspecificCurVar &node) override
	visit node of type ast::NonspecificCurVar More...

void	visit_electrode_cur_var (ast::ElectrodeCurVar &node) override
	visit node of type ast::ElectrodeCurVar More...

void	visit_range_var (ast::RangeVar &node) override
	visit node of type ast::RangeVar More...

void	visit_global_var (ast::GlobalVar &node) override
	visit node of type ast::GlobalVar More...

void	visit_pointer_var (ast::PointerVar &node) override
	visit node of type ast::PointerVar More...

void	visit_random_var (ast::RandomVar &node) override
	visit node of type ast::RandomVar More...

void	visit_bbcore_pointer_var (ast::BbcorePointerVar &node) override
	visit node of type ast::BbcorePointerVar More...

void	visit_extern_var (ast::ExternVar &node) override
	visit node of type ast::ExternVar More...

void	visit_param_block (ast::ParamBlock &node) override
	visit node of type ast::ParamBlock More...

void	visit_independent_block (ast::IndependentBlock &node) override
	visit node of type ast::IndependentBlock More...

void	visit_assigned_block (ast::AssignedBlock &node) override
	visit node of type ast::AssignedBlock More...

void	visit_state_block (ast::StateBlock &node) override
	visit node of type ast::StateBlock More...

void	visit_initial_block (ast::InitialBlock &node) override
	visit node of type ast::InitialBlock More...

void	visit_constructor_block (ast::ConstructorBlock &node) override
	visit node of type ast::ConstructorBlock More...

void	visit_destructor_block (ast::DestructorBlock &node) override
	visit node of type ast::DestructorBlock More...

void	visit_statement_block (ast::StatementBlock &node) override
	visit node of type ast::StatementBlock More...

void	visit_derivative_block (ast::DerivativeBlock &node) override
	visit node of type ast::DerivativeBlock More...

void	visit_linear_block (ast::LinearBlock &node) override
	visit node of type ast::LinearBlock More...

void	visit_non_linear_block (ast::NonLinearBlock &node) override
	visit node of type ast::NonLinearBlock More...

void	visit_discrete_block (ast::DiscreteBlock &node) override
	visit node of type ast::DiscreteBlock More...

void	visit_function_table_block (ast::FunctionTableBlock &node) override
	visit node of type ast::FunctionTableBlock More...

void	visit_function_block (ast::FunctionBlock &node) override
	visit node of type ast::FunctionBlock More...

void	visit_procedure_block (ast::ProcedureBlock &node) override
	visit node of type ast::ProcedureBlock More...

void	visit_net_receive_block (ast::NetReceiveBlock &node) override
	visit node of type ast::NetReceiveBlock More...

void	visit_solve_block (ast::SolveBlock &node) override
	visit node of type ast::SolveBlock More...

void	visit_breakpoint_block (ast::BreakpointBlock &node) override
	visit node of type ast::BreakpointBlock More...

void	visit_before_block (ast::BeforeBlock &node) override
	visit node of type ast::BeforeBlock More...

void	visit_after_block (ast::AfterBlock &node) override
	visit node of type ast::AfterBlock More...

void	visit_ba_block (ast::BABlock &node) override
	visit node of type ast::BABlock More...

void	visit_for_netcon (ast::ForNetcon &node) override
	visit node of type ast::ForNetcon More...

void	visit_kinetic_block (ast::KineticBlock &node) override
	visit node of type ast::KineticBlock More...

void	visit_unit_block (ast::UnitBlock &node) override
	visit node of type ast::UnitBlock More...

void	visit_constant_block (ast::ConstantBlock &node) override
	visit node of type ast::ConstantBlock More...

void	visit_neuron_block (ast::NeuronBlock &node) override
	visit node of type ast::NeuronBlock More...

void	visit_unit (ast::Unit &node) override
	visit node of type ast::Unit More...

void	visit_double_unit (ast::DoubleUnit &node) override
	visit node of type ast::DoubleUnit More...

void	visit_local_var (ast::LocalVar &node) override
	visit node of type ast::LocalVar More...

void	visit_limits (ast::Limits &node) override
	visit node of type ast::Limits More...

void	visit_number_range (ast::NumberRange &node) override
	visit node of type ast::NumberRange More...

void	visit_constant_var (ast::ConstantVar &node) override
	visit node of type ast::ConstantVar More...

void	visit_binary_operator (ast::BinaryOperator &node) override
	visit node of type ast::BinaryOperator More...

void	visit_unary_operator (ast::UnaryOperator &node) override
	visit node of type ast::UnaryOperator More...

void	visit_reaction_operator (ast::ReactionOperator &node) override
	visit node of type ast::ReactionOperator More...

void	visit_paren_expression (ast::ParenExpression &node) override
	visit node of type ast::ParenExpression More...

void	visit_binary_expression (ast::BinaryExpression &node) override
	visit node of type ast::BinaryExpression More...

void	visit_diff_eq_expression (ast::DiffEqExpression &node) override
	visit node of type ast::DiffEqExpression More...

void	visit_unary_expression (ast::UnaryExpression &node) override
	visit node of type ast::UnaryExpression More...

void	visit_non_lin_equation (ast::NonLinEquation &node) override
	visit node of type ast::NonLinEquation More...

void	visit_lin_equation (ast::LinEquation &node) override
	visit node of type ast::LinEquation More...

void	visit_function_call (ast::FunctionCall &node) override
	visit node of type ast::FunctionCall More...

void	visit_watch (ast::Watch &node) override
	visit node of type ast::Watch More...

void	visit_ba_block_type (ast::BABlockType &node) override
	visit node of type ast::BABlockType More...

void	visit_unit_def (ast::UnitDef &node) override
	visit node of type ast::UnitDef More...

void	visit_factor_def (ast::FactorDef &node) override
	visit node of type ast::FactorDef More...

void	visit_valence (ast::Valence &node) override
	visit node of type ast::Valence More...

void	visit_unit_state (ast::UnitState &node) override
	visit node of type ast::UnitState More...

void	visit_local_list_statement (ast::LocalListStatement &node) override
	visit node of type ast::LocalListStatement More...

void	visit_model (ast::Model &node) override
	visit node of type ast::Model More...

void	visit_define (ast::Define &node) override
	visit node of type ast::Define More...

void	visit_include (ast::Include &node) override
	visit node of type ast::Include More...

void	visit_param_assign (ast::ParamAssign &node) override
	visit node of type ast::ParamAssign More...

void	visit_assigned_definition (ast::AssignedDefinition &node) override
	visit node of type ast::AssignedDefinition More...

void	visit_conductance_hint (ast::ConductanceHint &node) override
	visit node of type ast::ConductanceHint More...

void	visit_expression_statement (ast::ExpressionStatement &node) override
	visit node of type ast::ExpressionStatement More...

void	visit_protect_statement (ast::ProtectStatement &node) override
	visit node of type ast::ProtectStatement More...

void	visit_from_statement (ast::FromStatement &node) override
	visit node of type ast::FromStatement More...

void	visit_while_statement (ast::WhileStatement &node) override
	visit node of type ast::WhileStatement More...

void	visit_if_statement (ast::IfStatement &node) override
	visit node of type ast::IfStatement More...

void	visit_else_if_statement (ast::ElseIfStatement &node) override
	visit node of type ast::ElseIfStatement More...

void	visit_else_statement (ast::ElseStatement &node) override
	visit node of type ast::ElseStatement More...

void	visit_watch_statement (ast::WatchStatement &node) override
	visit node of type ast::WatchStatement More...

void	visit_mutex_lock (ast::MutexLock &node) override
	visit node of type ast::MutexLock More...

void	visit_mutex_unlock (ast::MutexUnlock &node) override
	visit node of type ast::MutexUnlock More...

void	visit_conserve (ast::Conserve &node) override
	visit node of type ast::Conserve More...

void	visit_compartment (ast::Compartment &node) override
	visit node of type ast::Compartment More...

void	visit_lon_diffuse (ast::LonDiffuse &node) override
	visit node of type ast::LonDiffuse More...

void	visit_reaction_statement (ast::ReactionStatement &node) override
	visit node of type ast::ReactionStatement More...

void	visit_lag_statement (ast::LagStatement &node) override
	visit node of type ast::LagStatement More...

void	visit_constant_statement (ast::ConstantStatement &node) override
	visit node of type ast::ConstantStatement More...

void	visit_table_statement (ast::TableStatement &node) override
	visit node of type ast::TableStatement More...

void	visit_suffix (ast::Suffix &node) override
	visit node of type ast::Suffix More...

void	visit_useion (ast::Useion &node) override
	visit node of type ast::Useion More...

void	visit_nonspecific (ast::Nonspecific &node) override
	visit node of type ast::Nonspecific More...

void	visit_electrode_current (ast::ElectrodeCurrent &node) override
	visit node of type ast::ElectrodeCurrent More...

void	visit_range (ast::Range &node) override
	visit node of type ast::Range More...

void	visit_global (ast::Global &node) override
	visit node of type ast::Global More...

void	visit_random_var_list (ast::RandomVarList &node) override
	visit node of type ast::RandomVarList More...

void	visit_pointer (ast::Pointer &node) override
	visit node of type ast::Pointer More...

void	visit_bbcore_pointer (ast::BbcorePointer &node) override
	visit node of type ast::BbcorePointer More...

void	visit_external (ast::External &node) override
	visit node of type ast::External More...

void	visit_thread_safe (ast::ThreadSafe &node) override
	visit node of type ast::ThreadSafe More...

void	visit_verbatim (ast::Verbatim &node) override
	visit node of type ast::Verbatim More...

void	visit_line_comment (ast::LineComment &node) override
	visit node of type ast::LineComment More...

void	visit_block_comment (ast::BlockComment &node) override
	visit node of type ast::BlockComment More...

void	visit_ontology_statement (ast::OntologyStatement &node) override
	visit node of type ast::OntologyStatement More...

void	visit_program (ast::Program &node) override
	visit node of type ast::Program More...

void	visit_nrn_state_block (ast::NrnStateBlock &node) override
	visit node of type ast::NrnStateBlock More...

void	visit_eigen_newton_solver_block (ast::EigenNewtonSolverBlock &node) override
	visit node of type ast::EigenNewtonSolverBlock More...

void	visit_eigen_linear_solver_block (ast::EigenLinearSolverBlock &node) override
	visit node of type ast::EigenLinearSolverBlock More...

void	visit_cvode_block (ast::CvodeBlock &node) override
	visit node of type ast::CvodeBlock More...

void	visit_longitudinal_diffusion_block (ast::LongitudinalDiffusionBlock &node) override
	visit node of type ast::LongitudinalDiffusionBlock More...

void	visit_wrapped_expression (ast::WrappedExpression &node) override
	visit node of type ast::WrappedExpression More...

void	visit_derivimplicit_callback (ast::DerivimplicitCallback &node) override
	visit node of type ast::DerivimplicitCallback More...

void	visit_solution_expression (ast::SolutionExpression &node) override
	visit node of type ast::SolutionExpression More...

void	visit_update_dt (ast::UpdateDt &node) override
	visit node of type ast::UpdateDt More...

Public Member Functions inherited from nmodl::visitor::Visitor
virtual	~Visitor ()=default

Private Types
typedef std::string(CodegenCompatibilityVisitor::*	FunctionPointer) (ast::Ast &node, const std::shared_ptr< ast::Ast > &) const
	Typedef for defining FunctionPointer that points to the function needed to be called for every kind of error. More...

Private Member Functions
std::string	return_error_if_solve_method_is_unhandled (ast::Ast &node, const std::shared_ptr< ast::Ast > &ast_node) const
	Takes as parameter an std::shared_ptr<ast::Ast>, searches if the method used for solving is supported and if it is not it returns a relative error message. More...

template<typename T >
std::string	return_error_with_name (ast::Ast &, const std::shared_ptr< ast::Ast > &ast_node) const
	Takes as parameter an std::shared_ptr<ast::Ast> node and returns a relative error with the name, the type and the location of the unhandled statement. More...

template<typename T >
std::string	return_error_without_name (ast::Ast &, const std::shared_ptr< ast::Ast > &ast_node) const
	Takes as parameter an std::shared_ptr<ast::Ast> node and returns a relative error with the type and the location of the unhandled statement. More...

std::string	return_error_extern (ast::Ast &node, const std::shared_ptr< ast::Ast > &ast_node) const
	Callback when detecting EXTERNAL. More...

std::string	return_error_global_var (ast::Ast &node, const std::shared_ptr< ast::Ast > &ast_node) const
	Takes as parameter the ast::Ast to read the symbol table and an std::shared_ptr<ast::Ast> node and returns relative error if a variable that is writen in the mod file is defined as GLOBAL instead of RANGE. More...

std::string	return_error_param_var (ast::Ast &node, const std::shared_ptr< ast::Ast > &ast_node) const

std::string	return_error_if_no_bbcore_read_write (ast::Ast &node, const std::shared_ptr< ast::Ast > &ast_node) const
	Takes as parameter the ast::Ast and checks if the functions "bbcore_read" and "bbcore_write" are defined in any of the ast::Ast VERBATIM blocks. More...

Private Attributes
const std::string	simulator = "coreneuron"

Static Private Attributes
static const std::map< ast::AstNodeType, FunctionPointer >	unhandled_ast_types_func
	associated container to find the function needed to be called in for every ast::AstNodeType that is unsupported More...

static const std::set< std::string >	handled_solvers
	Set of handled solvers by the NMODL `C++` code generator. More...

Member Typedef Documentation

◆ FunctionPointer

typedef std::string(CodegenCompatibilityVisitor::* nmodl::codegen::CodegenCompatibilityVisitor::FunctionPointer) (ast::Ast &node, const std::shared_ptr< ast::Ast > &) const

private

Typedef for defining FunctionPointer that points to the function needed to be called for every kind of error.

Definition at line 45 of file codegen_compatibility_visitor.hpp.

Constructor & Destructor Documentation

◆ CodegenCompatibilityVisitor()

nmodl::codegen::CodegenCompatibilityVisitor::CodegenCompatibilityVisitor ( const std::string & simulator = "coreneuron" )

inline

Default CodegenCompatibilityVisitor constructor.

The argument simulator must be "neuron" for NEURON, everything else refers to CoreNEURON. The compatibility will be checked as if generating code for the specified simulator.

Definition at line 71 of file codegen_compatibility_visitor.hpp.

Member Function Documentation

◆ find_unhandled_ast_nodes()

bool nmodl::codegen::CodegenCompatibilityVisitor::find_unhandled_ast_nodes ( Ast & node ) const

Search the ast::Ast for nodes that are incompatible with NMODL C++ code generator.

Parameters

node Ast

Returns: bool if there are unhandled nodes or not

Checks all the ast::AstNodeType that are not handled in NMODL code generation backend for CoreNEURON and prints related messages. If there is some kind of incompatibility return false.

Definition at line 156 of file codegen_compatibility_visitor.cpp.

◆ return_error_extern()

std::string nmodl::codegen::CodegenCompatibilityVisitor::return_error_extern	(	ast::Ast &	node,
		const std::shared_ptr< ast::Ast > &	ast_node
	)		const

private

Callback when detecting EXTERNAL.

Definition at line 54 of file codegen_compatibility_visitor.cpp.

◆ return_error_global_var()

std::string nmodl::codegen::CodegenCompatibilityVisitor::return_error_global_var	(	ast::Ast &	node,
		const std::shared_ptr< ast::Ast > &	ast_node
	)		const

private

Takes as parameter the ast::Ast to read the symbol table and an std::shared_ptr<ast::Ast> node and returns relative error if a variable that is writen in the mod file is defined as GLOBAL instead of RANGE.

Parameters

node	Ast
ast_node	Ast node which is checked

Returns: std::string error

Definition at line 70 of file codegen_compatibility_visitor.cpp.

◆ return_error_if_no_bbcore_read_write()

std::string nmodl::codegen::CodegenCompatibilityVisitor::return_error_if_no_bbcore_read_write	(	ast::Ast &	node,
		const std::shared_ptr< ast::Ast > &	ast_node
	)		const

private

Takes as parameter the ast::Ast and checks if the functions "bbcore_read" and "bbcore_write" are defined in any of the ast::Ast VERBATIM blocks.

The function is called if there is a BBCORE_POINTER defined in the mod file

Parameters

node	Ast
ast_node	Not used by the function

Returns: std::string error

Definition at line 110 of file codegen_compatibility_visitor.cpp.

◆ return_error_if_solve_method_is_unhandled()

std::string nmodl::codegen::CodegenCompatibilityVisitor::return_error_if_solve_method_is_unhandled	(	ast::Ast &	node,
		const std::shared_ptr< ast::Ast > &	ast_node
	)		const

private

Takes as parameter an std::shared_ptr<ast::Ast>, searches if the method used for solving is supported and if it is not it returns a relative error message.

Parameters

node	Not used by the function
ast_node	Ast node which is checked

Returns: std::string error

Definition at line 32 of file codegen_compatibility_visitor.cpp.

◆ return_error_param_var()

std::string nmodl::codegen::CodegenCompatibilityVisitor::return_error_param_var	(	ast::Ast &	node,
		const std::shared_ptr< ast::Ast > &	ast_node
	)		const

private

Definition at line 94 of file codegen_compatibility_visitor.cpp.

◆ return_error_with_name()

template<typename T >

std::string nmodl::codegen::CodegenCompatibilityVisitor::return_error_with_name	(	ast::Ast &	,
		const std::shared_ptr< ast::Ast > &	ast_node
	)		const

inlineprivate

Takes as parameter an std::shared_ptr<ast::Ast> node and returns a relative error with the name, the type and the location of the unhandled statement.

Template Parameters

T	Type of node parameter in the ast::Ast

Parameters

node	Not used by the function
ast_node	Ast node which is checked

Returns: std::string error

Definition at line 104 of file codegen_compatibility_visitor.hpp.

◆ return_error_without_name()

template<typename T >

std::string nmodl::codegen::CodegenCompatibilityVisitor::return_error_without_name	(	ast::Ast &	,
		const std::shared_ptr< ast::Ast > &	ast_node
	)		const

inlineprivate

Takes as parameter an std::shared_ptr<ast::Ast> node and returns a relative error with the type and the location of the unhandled statement.

Template Parameters

T	Type of node parameter in the ast::Ast

Parameters

node	Not used by the function
ast_node	Ast node which is checked

Returns: std::string error

Definition at line 129 of file codegen_compatibility_visitor.hpp.

Member Data Documentation

◆ handled_solvers

const std::set<std::string> nmodl::codegen::CodegenCompatibilityVisitor::handled_solvers

inlinestaticprivate

Initial value:

{codegen::naming::CNEXP_METHOD,
                                                              codegen::naming::EULER_METHOD,
                                                              codegen::naming::DERIVIMPLICIT_METHOD,
                                                              codegen::naming::SPARSE_METHOD,
                                                              codegen::naming::AFTER_CVODE_METHOD}

Set of handled solvers by the NMODL C++ code generator.

Definition at line 54 of file codegen_compatibility_visitor.hpp.

◆ simulator

const std::string nmodl::codegen::CodegenCompatibilityVisitor::simulator = "coreneuron"

private

Definition at line 60 of file codegen_compatibility_visitor.hpp.

◆ unhandled_ast_types_func

const std::map< ast::AstNodeType, CodegenCompatibilityVisitor::FunctionPointer > nmodl::codegen::CodegenCompatibilityVisitor::unhandled_ast_types_func

staticprivate

associated container to find the function needed to be called in for every ast::AstNodeType that is unsupported

Definition at line 51 of file codegen_compatibility_visitor.hpp.

The documentation for this class was generated from the following files:

/home/runner/work/nmodl/nmodl/src/codegen/codegen_compatibility_visitor.hpp
/home/runner/work/nmodl/nmodl/src/codegen/codegen_compatibility_visitor.cpp

Detailed Description

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Member Typedef Documentation

◆ FunctionPointer

Constructor & Destructor Documentation

◆ CodegenCompatibilityVisitor()

Member Function Documentation

◆ find_unhandled_ast_nodes()

◆ return_error_extern()

◆ return_error_global_var()

◆ return_error_if_no_bbcore_read_write()

◆ return_error_if_solve_method_is_unhandled()

◆ return_error_param_var()

◆ return_error_with_name()

◆ return_error_without_name()

Member Data Documentation

◆ handled_solvers

◆ simulator

◆ unhandled_ast_types_func