integer.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/number.hpp"
 
namespace nmodl::ast {
 
/**
 * \addtogroup ast_class
 * \ingroup ast
 * \{
 */
 
/**
 * \brief Represents an integer variable
 *
 * Non floating value in the mod file is parsed as an integer. For example,
  * in the below code, integer literals like `0` and `11` are stored as ast::Integer
  * in the AST :
  * 
  * \code{.mod}
  *     FROM i=0 TO N {
  *         tau = X[i] + 11
  *     }
  * \endcode
  * 
  * \sa ast::Float ast::Double
  * 
*/
class Integer : public Number {
  private:
    /// Value of integer
    int value;
    /// if integer is a macro then it's name
    std::shared_ptr<Name> macro;
    /// token with location information
    std::shared_ptr<ModToken> token;
 
  public:
  /// \name Ctor & dtor
  /// \{
    explicit Integer(int value, Name* macro);
    explicit Integer(int value, std::shared_ptr<Name> macro);
    Integer(const Integer& obj);
    Integer() = default;
    virtual ~Integer() = default;
  /// \}
  
  /**
   * \brief Check if the ast node is an instance of ast::Integer
   * \return true as object is of type ast::Integer
   */
  bool is_integer () 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)
  Integer* clone() const override {
    return new Integer(*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::INTEGER
   *
   * \sa Ast::get_node_type_name
   */
  AstNodeType get_node_type() const noexcept override {
    return AstNodeType::INTEGER;
  }
 
  /**
   * \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. "Integer"
   *
   * \sa Ast::get_node_name
   */
  std::string get_node_type_name() const noexcept override {
    return "Integer";
  }
 
 
  /**
   * \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<Integer>(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 Integer>(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 Getter for member variable \ref Integer.value
   */
  int get_value() const noexcept  {
    return value;
  }
  
  
  
  /**
   * \brief Getter for member variable \ref Integer.macro
   */
  std::shared_ptr<Name> get_macro() const noexcept  {
    return macro;
  }
  /// \}
 
  /// \name Setters
  /// \{
  /**
   * \brief Set token for the current ast node
   */
  void set_token(const ModToken& tok) { token = std::make_shared<ModToken>(tok); }
  /**
   * \brief Set new value to the current ast node
   * \sa Integer::eval
   */
  void set(int _value) {
    value = _value;
  }
  
  /**
   * \brief Setter for member variable \ref Integer.value
   */
  void set_value(int value);
 
  
  /**
   * \brief Setter for member variable \ref Integer.macro (rvalue reference)
   */
  void set_macro(std::shared_ptr<Name>&& macro);
 
  /**
   * \brief Setter for member variable \ref Integer.macro
   */
  void set_macro(const std::shared_ptr<Name>& macro);
 
  /// \}
 
  /// \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;
  /// \}
 
    /**
     * \brief Negate the value of current ast node
     *
     * Parser parse `-x` in two parts : `x` and then `-`. Once second token
     * `-` is encountered, the corresponding value of ast node needs to be
     * multiplied by `-1` for ast::Number node types.
     */
    void negate() override {
        value = -value;
    }
 
    /**
     * \brief Return value of the current ast node as double
     */
    double to_double() override {
        return value;
    }
      /**
       * \brief Return value of the ast node
       *
       * Base data type nodes like ast::Inetegr, ast::Double can be evaluated
       * to their literal values. This method is used to access underlying
       * literal value.
       *
       * \sa Integer::set
       */
      int eval() const {
        return value;
      }
  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