checkparent_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
 
/**
 *
 * \dir
 * \brief Auto generated visitors
 *
 * \file
 * \brief \copybrief nmodl::visitor::test::CheckParentVisitor
 */
 
#include "visitors/ast_visitor.hpp"
 
namespace nmodl {
namespace visitor {
namespace test {
 
/**
 * @ingroup visitor_classes
 * @{
 */
 
/**
 * \class CheckParentVisitor
 * \brief %Visitor for checking parents of ast nodes
 *
 * The visitor goes down the tree (parent -> children) marking down in
 * parent who is the parent of the node he is visiting.
 * Once check_parent(ast::Ast* node) verified that the current node has
 * the correct parent, we set the current node as parent and go down
 * the tree. Once all the children were checked we set the parent of the
 * current node as parent (it was checked before) and return.
 */
class CheckParentVisitor : public ConstAstVisitor {
    private:
        /**
        * \brief Keeps track of the parents while going down the tree
        */
        const ast::Ast* parent = nullptr;
        /**
        * \brief Flag to activate the parent check on the root node
        *
        * This flag tells to the visitor to check (or not check) if the
        * root node, from which we start the visit, is the root node and
        * thus, it should have nullptr parent
        */
        const bool is_root_with_null_parent = false;
 
        /**
         * \brief Check the parent, throw an error if not
         */
        void check_parent(const ast::Ast& node) const;
 
    public:
 
        /**
         * \brief Standard constructor
         *
         * If \a is_root_with_null_parent is set to true, also the initial
         * node is checked to be sure that is really the root (parent == nullptr)
         */
        CheckParentVisitor(bool is_root_with_null_parent = true)
          : is_root_with_null_parent(is_root_with_null_parent) {}
 
        /**
         * \brief A small wrapper to have a nicer call in parser.cpp
         * \return 0
         */
        int check_ast(const ast::Ast& node);
 
    protected:
 
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_node(const ast::Node& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_statement(const ast::Statement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_expression(const ast::Expression& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_block(const ast::Block& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_identifier(const ast::Identifier& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_number(const ast::Number& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_string(const ast::String& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_integer(const ast::Integer& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_float(const ast::Float& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_double(const ast::Double& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_boolean(const ast::Boolean& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_name(const ast::Name& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_prime_name(const ast::PrimeName& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_indexed_name(const ast::IndexedName& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_var_name(const ast::VarName& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_argument(const ast::Argument& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_react_var_name(const ast::ReactVarName& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_read_ion_var(const ast::ReadIonVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_write_ion_var(const ast::WriteIonVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_nonspecific_cur_var(const ast::NonspecificCurVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_electrode_cur_var(const ast::ElectrodeCurVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_range_var(const ast::RangeVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_global_var(const ast::GlobalVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_pointer_var(const ast::PointerVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_random_var(const ast::RandomVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_bbcore_pointer_var(const ast::BbcorePointerVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_extern_var(const ast::ExternVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_param_block(const ast::ParamBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_independent_block(const ast::IndependentBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_assigned_block(const ast::AssignedBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_state_block(const ast::StateBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_initial_block(const ast::InitialBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_constructor_block(const ast::ConstructorBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_destructor_block(const ast::DestructorBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_statement_block(const ast::StatementBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_derivative_block(const ast::DerivativeBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_linear_block(const ast::LinearBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_non_linear_block(const ast::NonLinearBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_discrete_block(const ast::DiscreteBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_function_table_block(const ast::FunctionTableBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_function_block(const ast::FunctionBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_procedure_block(const ast::ProcedureBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_net_receive_block(const ast::NetReceiveBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_solve_block(const ast::SolveBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_breakpoint_block(const ast::BreakpointBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_before_block(const ast::BeforeBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_after_block(const ast::AfterBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_ba_block(const ast::BABlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_for_netcon(const ast::ForNetcon& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_kinetic_block(const ast::KineticBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_unit_block(const ast::UnitBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_constant_block(const ast::ConstantBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_neuron_block(const ast::NeuronBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_unit(const ast::Unit& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_double_unit(const ast::DoubleUnit& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_local_var(const ast::LocalVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_limits(const ast::Limits& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_number_range(const ast::NumberRange& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_constant_var(const ast::ConstantVar& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_binary_operator(const ast::BinaryOperator& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_unary_operator(const ast::UnaryOperator& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_reaction_operator(const ast::ReactionOperator& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_paren_expression(const ast::ParenExpression& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_binary_expression(const ast::BinaryExpression& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_diff_eq_expression(const ast::DiffEqExpression& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_unary_expression(const ast::UnaryExpression& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_non_lin_equation(const ast::NonLinEquation& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_lin_equation(const ast::LinEquation& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_function_call(const ast::FunctionCall& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_watch(const ast::Watch& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_ba_block_type(const ast::BABlockType& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_unit_def(const ast::UnitDef& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_factor_def(const ast::FactorDef& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_valence(const ast::Valence& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_unit_state(const ast::UnitState& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_local_list_statement(const ast::LocalListStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_model(const ast::Model& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_define(const ast::Define& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_include(const ast::Include& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_param_assign(const ast::ParamAssign& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_assigned_definition(const ast::AssignedDefinition& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_conductance_hint(const ast::ConductanceHint& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_expression_statement(const ast::ExpressionStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_protect_statement(const ast::ProtectStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_from_statement(const ast::FromStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_while_statement(const ast::WhileStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_if_statement(const ast::IfStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_else_if_statement(const ast::ElseIfStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_else_statement(const ast::ElseStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_watch_statement(const ast::WatchStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_mutex_lock(const ast::MutexLock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_mutex_unlock(const ast::MutexUnlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_conserve(const ast::Conserve& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_compartment(const ast::Compartment& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_lon_diffuse(const ast::LonDiffuse& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_reaction_statement(const ast::ReactionStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_lag_statement(const ast::LagStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_constant_statement(const ast::ConstantStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_table_statement(const ast::TableStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_suffix(const ast::Suffix& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_useion(const ast::Useion& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_nonspecific(const ast::Nonspecific& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_electrode_current(const ast::ElectrodeCurrent& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_range(const ast::Range& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_global(const ast::Global& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_random_var_list(const ast::RandomVarList& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_pointer(const ast::Pointer& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_bbcore_pointer(const ast::BbcorePointer& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_external(const ast::External& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_thread_safe(const ast::ThreadSafe& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_verbatim(const ast::Verbatim& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_line_comment(const ast::LineComment& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_block_comment(const ast::BlockComment& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_ontology_statement(const ast::OntologyStatement& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_program(const ast::Program& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_nrn_state_block(const ast::NrnStateBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_eigen_newton_solver_block(const ast::EigenNewtonSolverBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_eigen_linear_solver_block(const ast::EigenLinearSolverBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_cvode_block(const ast::CvodeBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_longitudinal_diffusion_block(const ast::LongitudinalDiffusionBlock& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_wrapped_expression(const ast::WrappedExpression& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_derivimplicit_callback(const ast::DerivimplicitCallback& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_solution_expression(const ast::SolutionExpression& node) override;
        /**
        * \brief Go through the tree while checking the parents
        */
        void visit_update_dt(const ast::UpdateDt& node) override;
};
 
/** @} */  // end of visitor_classes
 
}  // namespace test
}  // namespace visitor
}  // namespace nmodl