User Guide
assigned_definition.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2023 Blue Brain Project, EPFL.
3  * See the top-level LICENSE file for details.
4  *
5  * SPDX-License-Identifier: Apache-2.0
6  */
7 
8 ///
9 /// THIS FILE IS GENERATED AT BUILD TIME AND SHALL NOT BE EDITED.
10 ///
11 
12 #pragma once
13 
14 /**
15  * \dir
16  * \brief Auto generated AST Implementations
17  *
18  * \file
19  * \brief Auto generated AST classes declaration
20  */
21 
22 #include "ast/ast_decl.hpp"
23 #include "ast/statement.hpp"
24 
25 namespace nmodl::ast {
26 
27 /**
28  * \addtogroup ast_class
29  * \ingroup ast
30  * \{
31  */
32 
33 /**
34  * \brief Represents a statement in `ASSIGNED` or `STATE` block
35  *
36  *
37 */
38 class AssignedDefinition : public Statement {
39  private:
40  /// Name of the variable
41  std::shared_ptr<Identifier> name;
42  /// Length in case of array
43  std::shared_ptr<Integer> length;
44  /// TODO
45  std::shared_ptr<Number> from;
46  /// TODO
47  std::shared_ptr<Number> to;
48  /// TODO
49  std::shared_ptr<Number> start;
50  /// TODO
51  std::shared_ptr<Unit> unit;
52  /// TODO
53  std::shared_ptr<Double> abstol;
54  /// token with location information
55  std::shared_ptr<ModToken> token;
56 
57  public:
58  /// \name Ctor & dtor
59  /// \{
61  explicit AssignedDefinition(std::shared_ptr<Identifier> name, std::shared_ptr<Integer> length, std::shared_ptr<Number> from, std::shared_ptr<Number> to, std::shared_ptr<Number> start, std::shared_ptr<Unit> unit, std::shared_ptr<Double> abstol);
63  virtual ~AssignedDefinition() = default;
64  /// \}
65 
66  /**
67  * \brief Check if the ast node is an instance of ast::AssignedDefinition
68  * \return true as object is of type ast::AssignedDefinition
69  */
70  bool is_assigned_definition () const noexcept override {
71  return true;
72  }
73 
74  /**
75  * \brief Return a copy of the current node
76  *
77  * Recursively make a new copy/clone of the current node including
78  * all members and return a pointer to the node. This is used for
79  * passes like nmodl::visitor::InlineVisitor where nodes are cloned in the
80  * ast.
81  *
82  * \return pointer to the clone/copy of the current node
83  */
84  // NOLINTBEGIN(clang-analyzer-cplusplus.NewDeleteLeaks)
85  AssignedDefinition* clone() const override {
86  return new AssignedDefinition(*this);
87  }
88  // NOLINTEND(clang-analyzer-cplusplus.NewDeleteLeaks)
89 
90  /// \name Getters
91  /// \{
92 
93  /**
94  * \brief Return type (ast::AstNodeType) of ast node
95  *
96  * Every node in the ast has a type defined in ast::AstNodeType and this
97  * function is used to retrieve the same.
98  *
99  * \return ast node type i.e. ast::AstNodeType::ASSIGNED_DEFINITION
100  *
101  * \sa Ast::get_node_type_name
102  */
103  AstNodeType get_node_type() const noexcept override {
105  }
106 
107  /**
108  * \brief Return type (ast::AstNodeType) of ast node as std::string
109  *
110  * Every node in the ast has a type defined in ast::AstNodeType.
111  * This type name can be returned as a std::string for printing
112  * node to text/json form.
113  *
114  * \return name of the node type as a string i.e. "AssignedDefinition"
115  *
116  * \sa Ast::get_node_name
117  */
118  std::string get_node_type_name() const noexcept override {
119  return "AssignedDefinition";
120  }
121 
122 
123  /**
124  * \brief Get std::shared_ptr from `this` pointer of the current ast node
125  */
126  std::shared_ptr<Ast> get_shared_ptr() override {
127  return std::static_pointer_cast<AssignedDefinition>(shared_from_this());
128  }
129 
130  /**
131  * \brief Get std::shared_ptr from `this` pointer of the current ast node
132  */
133  std::shared_ptr<const Ast> get_shared_ptr() const override {
134  return std::static_pointer_cast<const AssignedDefinition>(shared_from_this());
135  }
136 
137  /**
138  * \brief Return associated token for the current ast node
139  *
140  * Not all ast nodes have token information. For example, nmodl::visitor::NeuronSolveVisitor
141  * can insert new nodes in the ast as a solution of ODEs. In this case, we return
142  * nullptr to store in the nmodl::symtab::SymbolTable.
143  *
144  * \return pointer to token if exist otherwise nullptr
145  */
146  const ModToken* get_token() const noexcept override {
147  return token.get();
148  }
149 
150 
151  /**
152  * \brief Return name of the node
153  *
154  * Some ast nodes have a member marked designated as node name. For example,
155  * in case of this ast::Identifier has name designated as a
156  * node name.
157  *
158  * \return name of the node as std::string
159  *
160  * \sa Ast::get_node_type_name
161  */
162  std::string get_node_name() const override;
163 
164  /**
165  * \brief Getter for member variable \ref AssignedDefinition.name
166  */
167  std::shared_ptr<Identifier> get_name() const noexcept {
168  return name;
169  }
170 
171 
172 
173  /**
174  * \brief Getter for member variable \ref AssignedDefinition.length
175  */
176  std::shared_ptr<Integer> get_length() const noexcept {
177  return length;
178  }
179 
180 
181 
182  /**
183  * \brief Getter for member variable \ref AssignedDefinition.from
184  */
185  std::shared_ptr<Number> get_from() const noexcept {
186  return from;
187  }
188 
189 
190 
191  /**
192  * \brief Getter for member variable \ref AssignedDefinition.to
193  */
194  std::shared_ptr<Number> get_to() const noexcept {
195  return to;
196  }
197 
198 
199 
200  /**
201  * \brief Getter for member variable \ref AssignedDefinition.start
202  */
203  std::shared_ptr<Number> get_start() const noexcept {
204  return start;
205  }
206 
207 
208 
209  /**
210  * \brief Getter for member variable \ref AssignedDefinition.unit
211  */
212  std::shared_ptr<Unit> get_unit() const noexcept {
213  return unit;
214  }
215 
216 
217 
218  /**
219  * \brief Getter for member variable \ref AssignedDefinition.abstol
220  */
221  std::shared_ptr<Double> get_abstol() const noexcept {
222  return abstol;
223  }
224  /// \}
225 
226  /// \name Setters
227  /// \{
228  /**
229  * \brief Set token for the current ast node
230  */
231  void set_token(const ModToken& tok) { token = std::make_shared<ModToken>(tok); }
232 
233  /**
234  * \brief Setter for member variable \ref AssignedDefinition.name (rvalue reference)
235  */
236  void set_name(std::shared_ptr<Identifier>&& name);
237 
238  /**
239  * \brief Setter for member variable \ref AssignedDefinition.name
240  */
241  void set_name(const std::shared_ptr<Identifier>& name);
242 
243 
244  /**
245  * \brief Setter for member variable \ref AssignedDefinition.length (rvalue reference)
246  */
247  void set_length(std::shared_ptr<Integer>&& length);
248 
249  /**
250  * \brief Setter for member variable \ref AssignedDefinition.length
251  */
252  void set_length(const std::shared_ptr<Integer>& length);
253 
254 
255  /**
256  * \brief Setter for member variable \ref AssignedDefinition.from (rvalue reference)
257  */
258  void set_from(std::shared_ptr<Number>&& from);
259 
260  /**
261  * \brief Setter for member variable \ref AssignedDefinition.from
262  */
263  void set_from(const std::shared_ptr<Number>& from);
264 
265 
266  /**
267  * \brief Setter for member variable \ref AssignedDefinition.to (rvalue reference)
268  */
269  void set_to(std::shared_ptr<Number>&& to);
270 
271  /**
272  * \brief Setter for member variable \ref AssignedDefinition.to
273  */
274  void set_to(const std::shared_ptr<Number>& to);
275 
276 
277  /**
278  * \brief Setter for member variable \ref AssignedDefinition.start (rvalue reference)
279  */
280  void set_start(std::shared_ptr<Number>&& start);
281 
282  /**
283  * \brief Setter for member variable \ref AssignedDefinition.start
284  */
285  void set_start(const std::shared_ptr<Number>& start);
286 
287 
288  /**
289  * \brief Setter for member variable \ref AssignedDefinition.unit (rvalue reference)
290  */
291  void set_unit(std::shared_ptr<Unit>&& unit);
292 
293  /**
294  * \brief Setter for member variable \ref AssignedDefinition.unit
295  */
296  void set_unit(const std::shared_ptr<Unit>& unit);
297 
298 
299  /**
300  * \brief Setter for member variable \ref AssignedDefinition.abstol (rvalue reference)
301  */
302  void set_abstol(std::shared_ptr<Double>&& abstol);
303 
304  /**
305  * \brief Setter for member variable \ref AssignedDefinition.abstol
306  */
307  void set_abstol(const std::shared_ptr<Double>& abstol);
308 
309  /// \}
310 
311  /// \name Visitor
312  /// \{
313  /**
314  * \brief visit children i.e. member variables of current node using provided visitor
315  *
316  * Different nodes in the AST have different members (i.e. children). This method
317  * recursively visits children using provided visitor.
318  *
319  * \param v Concrete visitor that will be used to recursively visit children
320  *
321  * \sa Ast::visit_children for example.
322  */
323  void visit_children(visitor::Visitor& v) override;
324 
325  /**
326  * \brief visit children i.e. member variables of current node using provided visitor
327  *
328  * Different nodes in the AST have different members (i.e. children). This method
329  * recursively visits children using provided visitor.
330  *
331  * \param v Concrete constant visitor that will be used to recursively visit children
332  *
333  * \sa Ast::visit_children for example.
334  */
335  void visit_children(visitor::ConstVisitor& v) const override;
336 
337  /**
338  * \brief accept (or visit) the current AST node using provided visitor
339  *
340  * Instead of visiting children of AST node, like Ast::visit_children,
341  * accept allows to visit the current node itself using provided concrete
342  * visitor.
343  *
344  * \param v Concrete visitor that will be used to recursively visit node
345  *
346  * \sa Ast::accept for example.
347  */
348  void accept(visitor::Visitor& v) override;
349 
350  /**
351  * \copydoc accept(visitor::Visitor&)
352  */
353  void accept(visitor::ConstVisitor& v) const override;
354  /// \}
355 
356  private:
357  /**
358  * \brief Set this object as parent for all the children
359  *
360  * This should be called in every object (with children) constructor
361  * to set parents. Since it is called only in the constructors it
362  * should not be virtual to avoid ambiguities (issue #295).
363  */
364  void set_parent_in_children();
365 };
366 
367 /** \} */ // end of ast_class
368 
369 
370 
371 
372 
373 
374 
375 
376 
377 } // namespace nmodl::ast
nmodl::ast::AssignedDefinition::get_to
std::shared_ptr< Number > get_to() const noexcept
Getter for member variable AssignedDefinition::to.
Definition: assigned_definition.hpp:194
nmodl::visitor::ConstVisitor
Abstract base class for all constant visitors implementation.
Definition: visitor.hpp:302
nmodl::ast::AssignedDefinition::set_start
void set_start(std::shared_ptr< Number > &&start)
Setter for member variable AssignedDefinition::start (rvalue reference)
Definition: ast.cpp:8852
nmodl::ast::Unit
TODO.
Definition: unit.hpp:38
nmodl::ast::AssignedDefinition::set_to
void set_to(std::shared_ptr< Number > &&to)
Setter for member variable AssignedDefinition::to (rvalue reference)
Definition: ast.cpp:8835
nmodl::ast::Identifier
Base class for all identifiers.
Definition: identifier.hpp:41
nmodl::ast::AssignedDefinition::get_start
std::shared_ptr< Number > get_start() const noexcept
Getter for member variable AssignedDefinition::start.
Definition: assigned_definition.hpp:203
nmodl::ast::AssignedDefinition
Represents a statement in ASSIGNED or STATE block.
Definition: assigned_definition.hpp:38
nmodl::ast::AssignedDefinition::get_token
const ModToken * get_token() const noexcept override
Return associated token for the current ast node.
Definition: assigned_definition.hpp:146
nmodl::ast::Double
Represents a double variable.
Definition: double.hpp:53
ast_decl.hpp
THIS FILE IS GENERATED AT BUILD TIME AND SHALL NOT BE EDITED.
nmodl::ast::AssignedDefinition::get_abstol
std::shared_ptr< Double > get_abstol() const noexcept
Getter for member variable AssignedDefinition::abstol.
Definition: assigned_definition.hpp:221
nmodl::ast::AssignedDefinition::set_unit
void set_unit(std::shared_ptr< Unit > &&unit)
Setter for member variable AssignedDefinition::unit (rvalue reference)
Definition: ast.cpp:8869
nmodl::ast::AssignedDefinition::set_abstol
void set_abstol(std::shared_ptr< Double > &&abstol)
Setter for member variable AssignedDefinition::abstol (rvalue reference)
Definition: ast.cpp:8886
nmodl::ast::AssignedDefinition::~AssignedDefinition
virtual ~AssignedDefinition()=default
nmodl::ast::AssignedDefinition::get_node_name
std::string get_node_name() const override
Return name of the node.
Definition: ast.cpp:8596
nmodl::ast::AssignedDefinition::get_length
std::shared_ptr< Integer > get_length() const noexcept
Getter for member variable AssignedDefinition::length.
Definition: assigned_definition.hpp:176
nmodl::ast::Integer
Represents an integer variable.
Definition: integer.hpp:49
nmodl::ast
Abstract Syntax Tree (AST) related implementations.
Definition: ast_common.hpp:29
nmodl::ast::AssignedDefinition::get_shared_ptr
std::shared_ptr< const Ast > get_shared_ptr() const override
Get std::shared_ptr from this pointer of the current ast node.
Definition: assigned_definition.hpp:133
nmodl::ast::AssignedDefinition::is_assigned_definition
bool is_assigned_definition() const noexcept override
Check if the ast node is an instance of ast::AssignedDefinition.
Definition: assigned_definition.hpp:70
nmodl::ast::AssignedDefinition::unit
std::shared_ptr< Unit > unit
TODO.
Definition: assigned_definition.hpp:51
nmodl::ast::AssignedDefinition::get_from
std::shared_ptr< Number > get_from() const noexcept
Getter for member variable AssignedDefinition::from.
Definition: assigned_definition.hpp:185
nmodl::ast::AssignedDefinition::clone
AssignedDefinition * clone() const override
Return a copy of the current node.
Definition: assigned_definition.hpp:85
nmodl::ast::AstNodeType
AstNodeType
Enum type for every AST node type.
Definition: ast_decl.hpp:166
nmodl::ast::AssignedDefinition::visit_children
void visit_children(visitor::Visitor &v) override
visit children i.e.
Definition: ast.cpp:8618
nmodl::ast::AssignedDefinition::set_length
void set_length(std::shared_ptr< Integer > &&length)
Setter for member variable AssignedDefinition::length (rvalue reference)
Definition: ast.cpp:8801
statement.hpp
Auto generated AST classes declaration.
nmodl::ast::AssignedDefinition::from
std::shared_ptr< Number > from
TODO.
Definition: assigned_definition.hpp:45
nmodl::ast::AssignedDefinition::accept
void accept(visitor::Visitor &v) override
accept (or visit) the current AST node using provided visitor
Definition: ast.cpp:8690
nmodl::ast::AssignedDefinition::name
std::shared_ptr< Identifier > name
Name of the variable.
Definition: assigned_definition.hpp:41
nmodl::ast::AssignedDefinition::get_shared_ptr
std::shared_ptr< Ast > get_shared_ptr() override
Get std::shared_ptr from this pointer of the current ast node.
Definition: assigned_definition.hpp:126
nmodl::ast::AssignedDefinition::set_from
void set_from(std::shared_ptr< Number > &&from)
Setter for member variable AssignedDefinition::from (rvalue reference)
Definition: ast.cpp:8818
nmodl::visitor::Visitor
Abstract base class for all visitors implementation.
Definition: visitor.hpp:39
nmodl::ast::AssignedDefinition::token
std::shared_ptr< ModToken > token
token with location information
Definition: assigned_definition.hpp:55
nmodl::ast::AssignedDefinition::set_name
void set_name(std::shared_ptr< Identifier > &&name)
Setter for member variable AssignedDefinition::name (rvalue reference)
Definition: ast.cpp:8784
nmodl::ast::AssignedDefinition::get_node_type_name
std::string get_node_type_name() const noexcept override
Return type (ast::AstNodeType) of ast node as std::string.
Definition: assigned_definition.hpp:118
nmodl::ast::AssignedDefinition::get_node_type
AstNodeType get_node_type() const noexcept override
Return type (ast::AstNodeType) of ast node.
Definition: assigned_definition.hpp:103
nmodl::ast::Statement
TODO.
Definition: statement.hpp:38
nmodl::ast::AssignedDefinition::start
std::shared_ptr< Number > start
TODO.
Definition: assigned_definition.hpp:49
nmodl::ast::AssignedDefinition::length
std::shared_ptr< Integer > length
Length in case of array.
Definition: assigned_definition.hpp:43
nmodl::ast::AstNodeType::ASSIGNED_DEFINITION
@ ASSIGNED_DEFINITION
type of ast::AssignedDefinition
nmodl::ast::AssignedDefinition::to
std::shared_ptr< Number > to
TODO.
Definition: assigned_definition.hpp:47
nmodl::ast::AssignedDefinition::abstol
std::shared_ptr< Double > abstol
TODO.
Definition: assigned_definition.hpp:53
nmodl::ast::AssignedDefinition::set_token
void set_token(const ModToken &tok)
Set token for the current ast node.
Definition: assigned_definition.hpp:231
nmodl::ast::AssignedDefinition::set_parent_in_children
void set_parent_in_children()
Set this object as parent for all the children.
Definition: ast.cpp:8749
nmodl::ast::Number
Base class for all numbers.
Definition: number.hpp:39
nmodl::ast::AssignedDefinition::AssignedDefinition
AssignedDefinition(Identifier *name, Integer *length, Number *from, Number *to, Number *start, Unit *unit, Double *abstol)
Definition: ast.cpp:8699
nmodl::ast::AssignedDefinition::get_unit
std::shared_ptr< Unit > get_unit() const noexcept
Getter for member variable AssignedDefinition::unit.
Definition: assigned_definition.hpp:212
nmodl::ast::AssignedDefinition::get_name
std::shared_ptr< Identifier > get_name() const noexcept
Getter for member variable AssignedDefinition::name.
Definition: assigned_definition.hpp:167
nmodl::ModToken
Represent token returned by scanner.
Definition: modtoken.hpp:50