An entity which can contain code. More...
#include <bpp.h>
Public Member Functions | |
| bpp_code_entity () | |
| virtual | ~bpp_code_entity ()=default |
| virtual void | add_code (const std::string &code, bool add_newline=true) |
| Add code to the code entity. More... | |
| virtual void | add_code_to_previous_line (const std::string &code) |
| Add code to the code entity's pre-code buffer. More... | |
| virtual void | add_code_to_next_line (const std::string &code) |
| Add code to the code entity's post-code buffer. More... | |
| bool | add_object (std::shared_ptr< bpp_object > object) override |
| Add an object to the code entity. More... | |
| virtual void | flush_nextline_buffer () |
| virtual void | flush_postline_buffer () |
| virtual void | flush_code_buffers () |
| virtual void | clear_all_buffers () |
| virtual std::string | get_code () const |
| Return the contents of the main code buffer as a string. More... | |
| virtual std::string | get_pre_code () const |
| Return the contents of the pre-code buffer as a string. More... | |
| virtual std::string | get_post_code () const |
| Return the contents of the post-code buffer as a string. More... | |
 Public Member Functions inherited from bpp::bpp_entity | |
| virtual | ~bpp_entity ()=default |
| virtual bool | add_class (std::shared_ptr< bpp_class > class_) |
| Add a class to this entity's list of classes. More... | |
| virtual std::shared_ptr< bpp_class > | get_class () const |
| virtual std::string | get_address () const |
| virtual std::string | get_name () const |
| virtual std::weak_ptr< bpp::bpp_class > | get_containing_class () const |
| Get the class which contains this entity. More... | |
| virtual bool | set_containing_class (std::weak_ptr< bpp::bpp_class > containing_class) |
| virtual void | inherit (std::shared_ptr< bpp_entity > parent) |
| Inherit from a parent entity. More... | |
| virtual void | inherit (std::shared_ptr< bpp_class > parent) |
| virtual std::unordered_map< std::string, std::shared_ptr< bpp_class > > | get_classes () const |
| virtual std::unordered_map< std::string, std::shared_ptr< bpp_object > > | get_objects () const |
| virtual std::shared_ptr< bpp_class > | get_class (const std::string &name) |
| virtual std::shared_ptr< bpp_object > | get_object (const std::string &name) |
Protected Attributes | |
| std::shared_ptr< std::ostream > | code = std::make_shared<std::ostringstream>() |
| std::string | nextline_buffer = "" |
| std::string | postline_buffer = "" |
| bool | buffers_flushed = false |
| Protected Attributes inherited from bpp::bpp_entity | |
| std::unordered_map< std::string, std::shared_ptr< bpp_class > > | classes |
| A map of class names to class objects within this entity. More... | |
| std::unordered_map< std::string, std::shared_ptr< bpp_object > > | objects |
| A map of object names to bpp_objects within this entity. More... | |
| std::unordered_map< std::string, std::shared_ptr< bpp_object > > | local_objects |
| Like objects, but only for objects whose scope is local to this entity. More... | |
| std::shared_ptr< bpp_class > | type = nullptr |
| std::weak_ptr< bpp_class > | containing_class |
| std::vector< std::shared_ptr< bpp_class > > | parents |
Detailed Description
An entity which can contain code.
Such as a method, a supershell, or the program itself
This class provides the basic functionality for entities which can contain code Including 3 distinct code buffers:
- pre_code: Code that should be executed before the main code
- code: The main code
- post_code: Code that should be executed after the main code
Generally, the pre_code and post_code are used to set up and clean up the environment
This class also provides the ability to add code to the pre_code, code, and post_code buffers And to flush those buffers when necessary
Constructor & Destructor Documentation
◆ bpp_code_entity()
| bpp::bpp_code_entity::bpp_code_entity | ( | ) |
◆ ~bpp_code_entity()
|
virtualdefault |
Member Function Documentation
◆ add_code()
|
virtual |
Add code to the code entity.
This function adds code to the code entity's primary buffer. If the code contains a newline character, all code buffers are flushed. This ensures that the pre- and post- code relevant to each particular line of code is placed before and after the relevant line of code.
- Parameters
-
code The code to add add_newline Whether to add a newline character after the code (default: true)
Reimplemented in bpp::bpp_string.
◆ add_code_to_next_line()
|
virtual |
Add code to the code entity's post-code buffer.
Reimplemented in bpp::bpp_string.
◆ add_code_to_previous_line()
|
virtual |
Add code to the code entity's pre-code buffer.
Reimplemented in bpp::bpp_string.
◆ add_object()
|
overridevirtual |
Add an object to the code entity.
Adding an object to a code entity involves adding the necessary code to create the object. Unlike in the case where we add an object to a non-code entity, where we only need to update the object map.
This function generates the code necessary to create the object, including calling its constructor if it exists.
- Parameters
-
object The object to add
Reimplemented from bpp::bpp_entity.
◆ clear_all_buffers()
|
virtual |
◆ flush_code_buffers()
|
virtual |
◆ flush_nextline_buffer()
|
virtual |
◆ flush_postline_buffer()
|
virtual |
◆ get_code()
|
virtual |
Return the contents of the main code buffer as a string.
Reimplemented in bpp::bash_if_branch, bpp::bash_while_loop, and bpp::bpp_string.
◆ get_post_code()
|
virtual |
Return the contents of the post-code buffer as a string.
Reimplemented in bpp::bash_if_branch, bpp::bash_while_loop, and bpp::bpp_string.
◆ get_pre_code()
|
virtual |
Return the contents of the pre-code buffer as a string.
Reimplemented in bpp::bash_if_branch, bpp::bash_while_loop, and bpp::bpp_string.
Member Data Documentation
◆ buffers_flushed
|
protected |
◆ code
|
protected |
◆ nextline_buffer
|
protected |
◆ postline_buffer
|
protected |
The documentation for this class was generated from the following files:
- src/bpp_include/bpp.h
- src/bpp_include/bpp_code_entity.cpp
