bpp::bpp_entity Class Reference

The base class for all entities in the Bash++ compiler. More...

#include <bpp.h>

Inheritance diagram for bpp::bpp_entity:

Collaboration diagram for bpp::bpp_entity:

Public Member Functions
virtual	~bpp_entity ()=default
virtual bool	add_class (std::shared_ptr< bpp_class > class_)
	Add a class to this entity's list of classes.
virtual bool	add_object (std::shared_ptr< bpp_object > object, bool make_local=false)
	Add an object to this entity's list of objects.
virtual std::shared_ptr< bpp_class >	get_class ()
virtual std::string	get_address () const
virtual void	set_name (const std::string &name)
virtual std::string	get_name () const
virtual std::weak_ptr< bpp::bpp_class >	get_containing_class ()
	Get the class which contains this entity.
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.
virtual void	inherit (std::shared_ptr< bpp_class > parent)
void	set_definition_position (const std::string &file, uint64_t line, uint64_t column)
void	add_reference (const std::string &file, uint64_t line, uint64_t column)
bpp::SymbolPosition	get_initial_definition () const
std::list< bpp::SymbolPosition >	get_references () const
std::unordered_map< std::string, std::shared_ptr< bpp_class > >	get_classes () const
std::unordered_map< std::string, std::shared_ptr< bpp_object > >	get_objects () const
std::shared_ptr< bpp_class >	get_class (const std::string &name)
std::shared_ptr< bpp_object >	get_object (const std::string &name)
std::shared_ptr< bpp_class >	get_parent () const

Protected Attributes
std::string	name = ""
std::unordered_map< std::string, std::shared_ptr< bpp_class > >	classes
	A map of class names to class objects within this entity.
std::unordered_map< std::string, std::shared_ptr< bpp_object > >	objects
	A map of object names to bpp_objects within this entity.
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.
std::shared_ptr< bpp_class >	type = nullptr
std::weak_ptr< bpp_class >	containing_class
std::vector< std::shared_ptr< bpp_class > >	parents
bpp::SymbolPosition	initial_definition
std::list< bpp::SymbolPosition >	references

Detailed Description

The base class for all entities in the Bash++ compiler.

An entity is a class, object, method, or other construct in the Bash++ compiler. This class provides the basic functionality for all entities.

Constructor & Destructor Documentation

~bpp_entity()

virtual bpp::bpp_entity::~bpp_entity ( )

virtualdefault

Member Function Documentation

add_class()

bool bpp::bpp_entity::add_class ( std::shared_ptr< bpp_class >  class_ )

virtual

Add a class to this entity's list of classes.

Parameters

class_

The class to add

Returns

true if the class was added, false if the class already exists

Reimplemented in bpp::bpp_program.

add_object()

bool bpp::bpp_entity::add_object ( std::shared_ptr< bpp_object >  object, bool  make_local = false  )

virtual

Add an object to this entity's list of objects.

Parameters

object

The object to add

Returns

true if the object was added, false if the object already exists

Reimplemented in bpp::bpp_method, and bpp::bpp_code_entity.

add_reference()

void bpp::bpp_entity::add_reference	(	const std::string &	file,
		uint64_t	line,
		uint64_t	column
	)

get_address()

std::string bpp::bpp_entity::get_address ( ) const

virtual

Reimplemented in bpp::bpp_object, and bpp::bpp_datamember.

get_class() [1/2]

std::shared_ptr< bpp_class > bpp::bpp_entity::get_class ( )

virtual

Reimplemented in bpp::bpp_class, and bpp::bpp_object.

get_class() [2/2]

std::shared_ptr< bpp::bpp_class > bpp::bpp_entity::get_class

(

const std::string &

name

)

get_classes()

std::unordered_map< std::string, std::shared_ptr< bpp_class > > bpp::bpp_entity::get_classes

(

)

const

get_containing_class()

std::weak_ptr< bpp::bpp_class > bpp::bpp_entity::get_containing_class ( )

virtual

Get the class which contains this entity.

Useful in many cases, for example in the event that this entity is a method of a particular class

Reimplemented in bpp::bpp_class.

get_initial_definition()

bpp::SymbolPosition bpp::bpp_entity::get_initial_definition

(

)

const

get_name()

std::string bpp::bpp_entity::get_name ( ) const

virtual

get_object()

std::shared_ptr< bpp::bpp_object > bpp::bpp_entity::get_object

(

const std::string &

name

)

get_objects()

std::unordered_map< std::string, std::shared_ptr< bpp_object > > bpp::bpp_entity::get_objects

(

)

const

get_parent()

std::shared_ptr< bpp::bpp_class > bpp::bpp_entity::get_parent

(

)

const

get_references()

std::list< bpp::SymbolPosition > bpp::bpp_entity::get_references

(

)

const

inherit() [1/2]

void bpp::bpp_entity::inherit ( std::shared_ptr< bpp_class >  parent )

virtual

Reimplemented in bpp::bpp_class.

inherit() [2/2]

void bpp::bpp_entity::inherit ( std::shared_ptr< bpp_entity >  parent )

virtual

Inherit from a parent entity.

This function copies all classes and objects from the parent entity into this entity.

Parameters

parent

The parent entity to inherit from

Reimplemented in bpp::bpp_class.

set_containing_class()

bool bpp::bpp_entity::set_containing_class ( std::weak_ptr< bpp::bpp_class >  containing_class )

virtual

Reimplemented in bpp::bpp_class.

set_definition_position()

void bpp::bpp_entity::set_definition_position	(	const std::string &	file,
		uint64_t	line,
		uint64_t	column
	)

set_name()

void bpp::bpp_entity::set_name ( const std::string &  name )

virtual

Reimplemented in bpp::bpp_class.

Member Data Documentation

classes

bpp::bpp_entity::classes

protected

A map of class names to class objects within this entity.

containing_class

std::weak_ptr<bpp_class> bpp::bpp_entity::containing_class

protected

initial_definition

bpp::SymbolPosition bpp::bpp_entity::initial_definition

protected

local_objects

bpp::bpp_entity::local_objects

protected

Like objects, but only for objects whose scope is local to this entity.

name

std::string bpp::bpp_entity::name = ""

protected

objects

bpp::bpp_entity::objects

protected

A map of object names to bpp_objects within this entity.

parents

std::vector<std::shared_ptr<bpp_class> > bpp::bpp_entity::parents

protected

references

std::list<bpp::SymbolPosition> bpp::bpp_entity::references

protected

type

std::shared_ptr<bpp_class> bpp::bpp_entity::type = nullptr

protected

---

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

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