A class in Bash++. More...

#include <bpp.h>

Inheritance diagram for bpp::bpp_class:

Collaboration diagram for bpp::bpp_class:

Public Member Functions
	bpp_class ()

std::weak_ptr< bpp_class >	get_containing_class () const override
	Get the class which contains this entity. More...

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

std::shared_ptr< bpp_class >	get_class () const override

void	set_name (const std::string &name)

bool	add_method (std::shared_ptr< bpp_method > method)
	Add a method to the class. More...

bool	add_datamember (std::shared_ptr< bpp_datamember > datamember)
	Add a datamember to the class. More...

bool	set_constructor (std::shared_ptr< bpp_constructor > constructor)

bool	set_destructor (std::shared_ptr< bpp_destructor > destructor)

std::string	get_name () const

std::vector< std::shared_ptr< bpp_method > >	get_methods () const

std::vector< std::shared_ptr< bpp_datamember > >	get_datamembers () const

std::shared_ptr< bpp_constructor >	get_constructor () const

std::shared_ptr< bpp_destructor >	get_destructor () const

bool	has_constructor () const

bool	has_destructor () const

std::shared_ptr< bpp_method >	get_method (const std::string &name, std::shared_ptr< bpp_entity > context)
	Get a method by name. More...

std::shared_ptr< bpp_method >	get_method_UNSAFE (const std::string &name)
	Get a method by name without checking the context. More...

std::shared_ptr< bpp_datamember >	get_datamember (const std::string &name, std::shared_ptr< bpp_entity > context)
	Get a datamember by name. More...

void	inherit (std::shared_ptr< bpp_class > parent) override
	Inherit from a parent class. More...

std::shared_ptr< bpp::bpp_class >	get_parent ()

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 bool	add_object (std::shared_ptr< bpp_object > object)
	Add an object to this entity's list of objects. More...

virtual std::string	get_address () const

virtual void	inherit (std::shared_ptr< bpp_entity > parent)
	Inherit from a parent entity. More...

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)

Private Member Functions
void	remove_default_toPrimitive ()
	Remove the default toPrimitive method. More...

void	add_default_toPrimitive ()
	Add the default toPrimitive method. More...

Private Attributes
std::string	name

std::vector< std::shared_ptr< bpp_method > >	methods

std::vector< std::shared_ptr< bpp_datamember > >	datamembers

std::shared_ptr< bpp_constructor >	constructor

std::shared_ptr< bpp_destructor >	destructor

bool	constructor_set = false

bool	destructor_set = false

bool	has_custom_toPrimitive = false

Additional Inherited Members
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

A class in Bash++.

Constructor & Destructor Documentation

◆ bpp_class()

bpp::bpp_class::bpp_class ( )

Member Function Documentation

◆ add_datamember()

bool bpp::bpp_class::add_datamember ( std::shared_ptr< bpp_datamember > datamember )

Add a datamember to the class.

◆ add_default_toPrimitive()

void bpp::bpp_class::add_default_toPrimitive ( )

private

Add the default toPrimitive method.

Each class has a default toPrimitive method which simply echoes the class name. This method is only added if the class does not have a custom toPrimitive method.

◆ add_method()

bool bpp::bpp_class::add_method ( std::shared_ptr< bpp_method > method )

Add a method to the class.

◆ get_class()

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

overridevirtual

Reimplemented from bpp::bpp_entity.

◆ get_constructor()

std::shared_ptr< bpp_constructor > bpp::bpp_class::get_constructor ( ) const

◆ get_containing_class()

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

overridevirtual

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 from bpp::bpp_entity.

◆ get_datamember()

std::shared_ptr< bpp::bpp_datamember > bpp::bpp_class::get_datamember	(	const std::string &	name,
		std::shared_ptr< bpp_entity >	context
	)

Get a datamember by name.

This function returns a datamember by name, taking into account the scope of the datamember.

If the datamember is public, it is returned.

If the datamember is private or protected, it is returned only if the context permits. Otherwise, we return bpp::inaccessible_datamember.

Parameters

name	The name of the datamember to get
context	The context in which the datamember is being accessed

Returns: The datamember, bpp::inaccessible_datamember, or nullptr if it does not exist

◆ get_datamembers()

std::vector< std::shared_ptr< bpp_datamember > > bpp::bpp_class::get_datamembers ( ) const

◆ get_destructor()

std::shared_ptr< bpp_destructor > bpp::bpp_class::get_destructor ( ) const

◆ get_method()

std::shared_ptr< bpp::bpp_method > bpp::bpp_class::get_method	(	const std::string &	name,
		std::shared_ptr< bpp_entity >	context
	)

Get a method by name.

This function returns a method by name, taking into account the scope of the method.

If the method is public, it is returned.

If the method is private or protected, it is returned only if the context permits. Otherwise, we return bpp::inaccessible_method.

Parameters

name	The name of the method to get
context	The context in which the method is being accessed

Returns: The method, bpp::inaccessible_method, or nullptr if it does not exist

◆ get_method_UNSAFE()

std::shared_ptr< bpp::bpp_method > bpp::bpp_class::get_method_UNSAFE ( const std::string & name )

Get a method by name without checking the context.

This function returns a method by name without checking the context.

This function is UNSAFE and should only be used when the context is known to be correct or the consequences of an incorrect context are acceptable.

Parameters

name	The name of the method to get

Returns: The method, or nullptr if it does not exist

◆ get_methods()

std::vector< std::shared_ptr< bpp_method > > bpp::bpp_class::get_methods ( ) const

◆ get_name()

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

virtual

Reimplemented from bpp::bpp_entity.

◆ get_parent()

std::shared_ptr< bpp::bpp_class > bpp::bpp_class::get_parent ( )

◆ has_constructor()

bool bpp::bpp_class::has_constructor ( ) const

◆ has_destructor()

bool bpp::bpp_class::has_destructor ( ) const

◆ inherit()

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

overridevirtual

Inherit from a parent class.

This function copies all methods and datamembers from the parent class into this class.

Parameters

parent The parent class to inherit from

Reimplemented from bpp::bpp_entity.

◆ remove_default_toPrimitive()

void bpp::bpp_class::remove_default_toPrimitive ( )

private

Remove the default toPrimitive method.

Each class has a default toPrimitive method which simply echoes the class name. This method is only added if the class does not have a custom toPrimitive method.

◆ set_constructor()

bool bpp::bpp_class::set_constructor ( std::shared_ptr< bpp_constructor > constructor )

◆ set_containing_class()

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

overridevirtual

Reimplemented from bpp::bpp_entity.

◆ set_destructor()

bool bpp::bpp_class::set_destructor ( std::shared_ptr< bpp_destructor > destructor )

◆ set_name()

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

Member Data Documentation

◆ constructor

std::shared_ptr<bpp_constructor> bpp::bpp_class::constructor

private

◆ constructor_set

bool bpp::bpp_class::constructor_set = false

private

◆ datamembers

std::vector<std::shared_ptr<bpp_datamember> > bpp::bpp_class::datamembers

private

◆ destructor

std::shared_ptr<bpp_destructor> bpp::bpp_class::destructor

private

◆ destructor_set

bool bpp::bpp_class::destructor_set = false

private

◆ has_custom_toPrimitive

bool bpp::bpp_class::has_custom_toPrimitive = false

private

◆ methods

std::vector<std::shared_ptr<bpp_method> > bpp::bpp_class::methods

private

◆ name

std::string bpp::bpp_class::name

private

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

src/bpp_include/bpp.h
src/bpp_include/bpp_class.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ bpp_class()

Member Function Documentation

◆ add_datamember()

◆ add_default_toPrimitive()

◆ add_method()

◆ get_class()

◆ get_constructor()

◆ get_containing_class()

◆ get_datamember()

◆ get_datamembers()

◆ get_destructor()

◆ get_method()

◆ get_method_UNSAFE()

◆ get_methods()

◆ get_name()

◆ get_parent()

◆ has_constructor()

◆ has_destructor()

◆ inherit()

◆ remove_default_toPrimitive()

◆ set_constructor()

◆ set_containing_class()

◆ set_destructor()

◆ set_name()

Member Data Documentation

◆ constructor

◆ constructor_set

◆ datamembers

◆ destructor

◆ destructor_set

◆ has_custom_toPrimitive

◆ methods

◆ name