bpp::bpp_string Class Reference

The practical difference between bpp_code_entity and bpp_string is how we handle the code buffers. More...

#include <bpp.h>

Inheritance diagram for bpp::bpp_string:

Collaboration diagram for bpp::bpp_string:

Public Member Functions
	bpp_string ()
void	add_code (const std::string &code, bool add_newline=true) override
	Add code to the primary buffer. More...
void	add_code_to_previous_line (const std::string &code) override
	Add code to the pre-code buffer. More...
void	add_code_to_next_line (const std::string &code) override
	Add code to the post-code buffer. More...
std::string	get_code () const override
	Return the contents of the main code buffer as a string. More...
std::string	get_pre_code () const override
	Return the contents of the pre-code buffer as a string. More...
std::string	get_post_code () const override
	Return the contents of the post-code buffer as a string. More...
Public Member Functions inherited from bpp::bpp_code_entity
	bpp_code_entity ()
virtual	~bpp_code_entity ()=default
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 ()
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)

Additional Inherited Members
Protected Attributes inherited from bpp::bpp_code_entity
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

The practical difference between bpp_code_entity and bpp_string is how we handle the code buffers.

When you call add_code() on a bpp_code_entity, it will flush the pre_code and post_code buffers.

Meaning that we're treating the pre_code and post_code buffers as the pre- and post-code for this particular line of code. So when we finish writing this line of code, we should ensure that this line of code is preceded by its pre-code, and followed by its post-code

In a bpp_code_entity, the code:

echo @this.dataMember

Becomes:

{pre-code necessary to fetch @this.dataMember}
echo ${the resolved reference}
{post-code necessary to clear the memory}

In a bpp_string, however, calling add_code() does not ever flush those buffers. Why?

Because, if you imagine we're literally dealing with an actual string (although the same rules apply in some other cases), it's important not to muddy up the contents of the string with a bunch of pre- and post-code. If, for example, there are object references within the string, they should be resolved BEFORE the entire string, And cleared AFTER the entire string

This ensures that for a bpp_string, the code:

echo "This is a very long string
    That spans multiple lines
    And has a reference to @this.dataMember"

Becomes:

{pre-code necessary to fetch @this.dataMember}
echo "This is a very long string
    That spans multiple lines
    And has a reference to ${the resolved reference}"
{post-code necessary to clear the memory}

So, bpp_string gives us more direct control over where the pre- and post-code is added

In some other part of the compiler where we're parsing the above example string, the code might look something like:

entity->add_code_to_previous_line(pre_code);
entity->add_code_to_next_line(post_code);
    ^ These two lines prepare the code buffers in the code_entity
entity->add_code("echo \"This is a very long string....."); // etc
    ^ This line adds the code & *maybe* flushes the buffers we just prepared

Where "entity" may be a bpp_code_entity or a bpp_string

In general, parser rules which handle things such as object references don't pay attention to whether they're dealing with a bpp_code_entity or a bpp_string. The code necessary to fetch an object reference (for example) is simply added to the pre-code buffer, and the code necessary to clear that memory is simply added to the post-code buffer. The question of whether or when those buffers should be flushed is left to the entity itself (code_entity or string).

Constructor & Destructor Documentation

bpp_string()

bpp::bpp_string::bpp_string

(

)

Member Function Documentation

add_code()

void bpp::bpp_string::add_code ( const std::string &  code, bool  add_newline = true  )

overridevirtual

Add code to the primary buffer.

Parameters

code	The code to add
add_newline	Ignored in the case of bpp_string

Reimplemented from bpp::bpp_code_entity.

add_code_to_next_line()

void bpp::bpp_string::add_code_to_next_line ( const std::string &  code )

overridevirtual

Add code to the post-code buffer.

Reimplemented from bpp::bpp_code_entity.

add_code_to_previous_line()

void bpp::bpp_string::add_code_to_previous_line ( const std::string &  code )

overridevirtual

Add code to the pre-code buffer.

Reimplemented from bpp::bpp_code_entity.

get_code()

std::string bpp::bpp_string::get_code ( ) const

overridevirtual

Return the contents of the main code buffer as a string.

Reimplemented from bpp::bpp_code_entity.

get_post_code()

std::string bpp::bpp_string::get_post_code ( ) const

overridevirtual

Return the contents of the post-code buffer as a string.

Reimplemented from bpp::bpp_code_entity.

get_pre_code()

std::string bpp::bpp_string::get_pre_code ( ) const

overridevirtual

Return the contents of the pre-code buffer as a string.

Reimplemented from bpp::bpp_code_entity.

---

The documentation for this class was generated from the following files:

• src/bpp_include/bpp.h
• src/bpp_include/bpp_string.cpp