prime_name.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 AST Implementations
 *
 * \file
 * \brief Auto generated AST classes declaration
 */
 
#include "ast/ast_decl.hpp"
#include "ast/identifier.hpp"
 
namespace nmodl::ast {
 
/**
 * \addtogroup ast_class
 * \ingroup ast
 * \{
 */
 
/**
 * \brief Represents a prime variable (for ODE)
 *
 * In case of ODE specification, all state variables appearing on LHS
  * with \` as suffix are parsed by lexer as ast::PrimeName. For example,
  * in below NMODL construct, m\` is stored as ast::PrimeName with `m` as a
  * ast::PrimeName::value and `1` as an ast::PrimeName::order.
  * 
  * \code
  *     DERIVATIVE states {
  *       m` = m + h
  *     }
  * \endcode
  * 
*/
class PrimeName : public Identifier {
  private:
    /// Name of prime variable
    std::shared_ptr<String> value;
    /// order of ODE
    std::shared_ptr<Integer> order;
    /// token with location information
    std::shared_ptr<ModToken> token;
 
  public:
  /// \name Ctor & dtor
  /// \{
    explicit PrimeName(String* value, Integer* order);
    explicit PrimeName(std::shared_ptr<String> value, std::shared_ptr<Integer> order);
    PrimeName(const PrimeName& obj);
    PrimeName() = default;
    virtual ~PrimeName() = default;
  /// \}
  
  /**
   * \brief Check if the ast node is an instance of ast::PrimeName
   * \return true as object is of type ast::PrimeName
   */
  bool is_prime_name () const noexcept override {
    return true;
  }
 
  /**
   * \brief Return a copy of the current node
   *
   * Recursively make a new copy/clone of the current node including
   * all members and return a pointer to the node. This is used for
   * passes like nmodl::visitor::InlineVisitor where nodes are cloned in the
   * ast.
   *
   * \return pointer to the clone/copy of the current node
   */
  // NOLINTBEGIN(clang-analyzer-cplusplus.NewDeleteLeaks)
   PrimeName* clone() const override {
    return new PrimeName(*this);
  }
  // NOLINTEND(clang-analyzer-cplusplus.NewDeleteLeaks)
 
  /// \name Getters
  /// \{
 
  /**
   * \brief Return type (ast::AstNodeType) of ast node
   *
   * Every node in the ast has a type defined in ast::AstNodeType and this
   * function is used to retrieve the same.
   *
   * \return ast node type i.e. ast::AstNodeType::PRIME_NAME
   *
   * \sa Ast::get_node_type_name
   */
   AstNodeType get_node_type() const noexcept override {
    return AstNodeType::PRIME_NAME;
  }
 
  /**
   * \brief Return type (ast::AstNodeType) of ast node as std::string
   *
   * Every node in the ast has a type defined in ast::AstNodeType.
   * This type name can be returned as a std::string for printing
   * node to text/json form.
   *
   * \return name of the node type as a string i.e. "PrimeName"
   *
   * \sa Ast::get_node_name
   */
   std::string get_node_type_name() const noexcept override {
    return "PrimeName";
  }
 
 
  /**
   * \brief Get std::shared_ptr from `this` pointer of the current ast node
   */
   std::shared_ptr<Ast> get_shared_ptr() override {
    return std::static_pointer_cast<PrimeName>(shared_from_this());
  }
 
  /**
   * \brief Get std::shared_ptr from `this` pointer of the current ast node
   */
   std::shared_ptr<const Ast> get_shared_ptr() const override {
    return std::static_pointer_cast<const PrimeName>(shared_from_this());
  }
 
  /**
   * \brief Return associated token for the current ast node
   *
   * Not all ast nodes have token information. For example, nmodl::visitor::NeuronSolveVisitor
   * can insert new nodes in the ast as a solution of ODEs. In this case, we return
   * nullptr to store in the nmodl::symtab::SymbolTable.
   *
   * \return pointer to token if exist otherwise nullptr
   */
  const ModToken* get_token() const noexcept override {
    return token.get();
  }
  
  
  /**
   * \brief Return name of the node
   *
   * Some ast nodes have a member marked designated as node name. For example,
   * in case of this ast::String has value designated as a
   * node name.
   *
   * \return name of the node as std::string
   *
   * \sa Ast::get_node_type_name
   */
  std::string get_node_name() const override;
  
  /**
   * \brief Getter for member variable \ref PrimeName.value
   */
  std::shared_ptr<String> get_value() const noexcept  {
    return value;
  }
  
  
  
  /**
   * \brief Getter for member variable \ref PrimeName.order
   */
  std::shared_ptr<Integer> get_order() const noexcept  {
    return order;
  }
  /// \}
 
  /// \name Setters
  /// \{
  /**
   * \brief Set token for the current ast node
   */
  void set_token(const ModToken& tok) { token = std::make_shared<ModToken>(tok); }
  
  /**
   * \brief Setter for member variable \ref PrimeName.value (rvalue reference)
   */
  void set_value(std::shared_ptr<String>&& value);
 
  /**
   * \brief Setter for member variable \ref PrimeName.value
   */
  void set_value(const std::shared_ptr<String>& value);
 
  
  /**
   * \brief Setter for member variable \ref PrimeName.order (rvalue reference)
   */
  void set_order(std::shared_ptr<Integer>&& order);
 
  /**
   * \brief Setter for member variable \ref PrimeName.order
   */
  void set_order(const std::shared_ptr<Integer>& order);
 
  /// \}
 
  /// \name Visitor
  /// \{
  /**
   * \brief visit children i.e. member variables of current node using provided visitor
   *
   * Different nodes in the AST have different members (i.e. children). This method
   * recursively visits children using provided visitor.
   *
   * \param v Concrete visitor that will be used to recursively visit children
   *
   * \sa Ast::visit_children for example.
   */
   void visit_children(visitor::Visitor& v) override;
 
  /**
   * \brief visit children i.e. member variables of current node using provided visitor
   *
   * Different nodes in the AST have different members (i.e. children). This method
   * recursively visits children using provided visitor.
   *
   * \param v Concrete constant visitor that will be used to recursively visit children
   *
   * \sa Ast::visit_children for example.
   */
   void visit_children(visitor::ConstVisitor& v) const override;
 
  /**
   * \brief accept (or visit) the current AST node using provided visitor
   *
   * Instead of visiting children of AST node, like Ast::visit_children,
   * accept allows to visit the current node itself using provided concrete
   * visitor.
   *
   * \param v Concrete visitor that will be used to recursively visit node
   *
   * \sa Ast::accept for example.
   */
   void accept(visitor::Visitor& v) override;
 
  /**
   * \copydoc accept(visitor::Visitor&)
   */
   void accept(visitor::ConstVisitor& v) const override;
  /// \}
 
  private:
    /**
     * \brief Set this object as parent for all the children
     *
     * This should be called in every object (with children) constructor
     * to set parents. Since it is called only in the constructors it
     * should not be virtual to avoid ambiguities (issue #295).
     */
     void set_parent_in_children();
};
 
/** \} */  // end of ast_class
 
  
  
 
}  // namespace nmodl::ast