Kryptostack: SOK Class Reference

Semantic Object Stack. More...

#include <sok.h>

Inheritance diagram for SOK:

Collaboration diagram for SOK:

Classes
struct	SOKDeque
	Semantic Object Stack - deque member class. More...

Public Member Functions
	SOK ()
	Ctor.

SOK *	dup () const override
	Creates a new instance as copy following the red book definition. More...

SOK *	clone () const override
	Creates a new instance as copy with deep cloning. More...

std::string	opequalequal () const override
	For operators '==' and 'pstack'. More...

OTCode	ot () const override
	Returns an OTCode. More...

std::string	type () const override
	Returns a type name. More...

bool	equal (const SO *p_other) const override
	Equality. More...

size_t	getSize () const override
	Getter for the number of characters or number of objects. More...

size_t	getWatermark () const
	Returns the watermark.

void	setSO (size_t p_index, SOp p_sop)
	Setter for a stack object. More...

SOp	at (size_t p_pos) const
	Returns a copy of the SOp at the given position. More...

SOp	peek () const
	Returns a copy of the SOp of the top most position. More...

SOp	pop ()
	Returns a copy of the top SOp, removes the SOp from the SOK. More...

void	pop_delete ()
	Removes the top most object from SOK, and the referenced SO will be deleted. More...

void	push (SOp p_o1)
	Pushes the object onto the SOK and transfers ownership to the SOK. More...

void	push (SOp p_o1, SOp p_o2)
	Pushes the 2 objects onto the SOK and transfers ownership to the SOK. More...

void	push (std::initializer_list< SOp > p_list)
	Pushes n objects onto the SOK and transfers ownership to the SOK. More...

void	push_front (SOp p_obj)
	Pushes the object onto the front side of the SOK and transfers ownership to the SOK. More...

bool	underflowcheck (size_t p_size) const
	Checks SOK against given size.

bool	otchecker (const std::string &p_s) const
	Checks SO classes on the operand stack against a string of given OTCodes. More...

bool	otchecker (OTCode p_code) const
	Checks SO classes on the operand stack against an OTCodes. More...

bool	countto (size_t &p_retval, OTCode p_code) const
	Count the objects on the SOK down to but excluding the object from the given type. More...

SOp	findValue (const SO *p_key) const
	Finds the given key within the whole stack, assuming a stack with dictionaries only. More...

SOp	findDict (const SO *p_key) const
	Finds the dictionary storing the given key within the whole stack, assuming a stack with dictionaries only. More...

__int128	getI ()
	I from SOK. More...

__float128	getIorRasR ()
	I or R from SOK as R Deletes the top object after reading its value. More...

size_t	getISize_t ()
	I from SOK as size_t. More...

Public Member Functions inherited from SOcomp
std::string	opequal () const override
	For operators '=', 'cvs' and 'stack'. More...

	SO (bool p_exec=false)
	Ctor.

Public Member Functions inherited from SO
	SO (bool p_exec=false)
	Ctor.

virtual	~SO ()=default
	Virtual dtor. More...

bool	getExec () const
	Getter for exec_.

void	setExec (bool p_exec)
	Setter for exec_.

virtual size_t	getSize () const
	Getter for the number of characters or number of objects. More...

virtual SO *	dup () const =0
	Creates a new instance as copy following the red book definition. More...

virtual SO *	clone () const
	Creates a new instance as copy with deep cloning. More...

virtual std::string	opequal () const =0
	For operators '=', 'cvs' and 'stack'. More...

virtual std::string	opequalequal () const
	For operators '==' and 'pstack'. More...

virtual OTCode	ot () const =0
	Returns an OTCode. More...

virtual std::string	type () const =0
	Returns a type name. More...

virtual bool	equal (const SO *) const =0
	Equality. More...

virtual bool	gt (const SO *) const
	Greater than. More...

virtual bool	ge (const SO *) const
	Greater or equal. More...

Public Member Functions inherited from Counter< SO >
	Counter (Counter< SO > &&)=delete

Counter< SO > &	operator= (const Counter< SO > &)=delete

Counter< SO > &	operator= (Counter< SO > &&)=delete

Protected Member Functions
bool	invariant () const noexcept override
	Checks class invariants. More...

Protected Member Functions inherited from Counter< SO >
	Counter ()
	Ctor.

	Counter (const Counter< SO > &)
	Copy ctor.

	~Counter ()
	Dtor.

virtual bool	invariant () const noexcept
	Checks the invariants of the class in which it is defined. More...

Private Member Functions
void	watermark ()
	Update watermark_ if necessary.

Private Attributes
std::shared_ptr< SOKDeque >	deque_
	The shared deque.

size_t	watermark_ {}
	The watermark for the size of the stack.

Additional Inherited Members
Static Public Member Functions inherited from Counter< SO >
static int	getTotalCounter ()
	Static getter for totaly created objects.

static int	getAliveCounter ()
	Static getter for objects alive.

static int	getWatermarkCounter ()
	Static getter for the object counter watermark.

Detailed Description

Semantic Object Stack.

Our own container adapter to std::deque to build a stack. It's a stack of pointers to SO. The bottom object has position 0. The top most object has position size-1.

Invariant: deque_ != nullptr; deque_.stldeque_ elements are never null.

Member Function Documentation

◆ at()

SOp SOK::at ( size_t p_pos ) const

inline

Returns a copy of the SOp at the given position.

The SOK keeps ownership.

Parameters

[in] p_pos position, which is not checked.

Precondition: p_pos < dequesize

◆ clone()

SOK * SOK::clone ( ) const

overridevirtual

Creates a new instance as copy with deep cloning.

Postcondition: return value != nullptr; return value maintains invariants

Reimplemented from SO.

◆ countto()

bool SOK::countto	(	size_t &	p_retval,
		OTCode	p_code
	)		const

Count the objects on the SOK down to but excluding the object from the given type.

Implemented without C++ polymorphisms.

Returns: bool ... true if the given OTCode can be found

Parameters

[out]	p_retval	number of objects
[in]	p_code	OTCode to find

◆ dup()

SOK * SOK::dup ( ) const

inlineoverridevirtual

Creates a new instance as copy following the red book definition.

Implements SO.

◆ equal()

bool SOK::equal ( const SO * ) const

inlineoverridevirtual

Equality.

Equality means: SOL und SOM are always equal.
For SOD and SOK, share_ptr<> points to the same object.
For SOA, share_ptr<> points to the same object, but empty arrays are equal nonetheless.
For SOO and SOo the function pointer must be the same.
Otherwise the value must be the same, even for SOS with shared_ptr<>.

Returns: bool ... true if the SO's are of the same type and equal

See also: Will be used directly and unchanged as operator eq

Implements SO.

◆ findDict()

SOp SOK::findDict ( const SO * p_key ) const

Finds the dictionary storing the given key within the whole stack, assuming a stack with dictionaries only.

Equality is determined by SO::equal(). We return a SOp instead of a SOD * to reduce coupling.

Returns: SOp ... points to the found dictionary, the ownership stays within the stack. Returns a null pointer if p_key can't be found.

Precondition: p_key != nullptr

◆ findValue()

SOp SOK::findValue ( const SO * p_key ) const

Finds the given key within the whole stack, assuming a stack with dictionaries only.

Equality is determined by SO::equal().

Returns: SOp ... points to the found value, the ownership stays within the dictionary. Returns a null pointer if key can't be found.

Precondition: p_key != nullptr

◆ getI()

__int128 SOK::getI ( )

I from SOK.

Deletes the top object after reading its integer value. Checks the type of the operand stack object. Does not check for stack underflow.

Precondition: stack size > 0

◆ getIorRasR()

__float128 SOK::getIorRasR ( )

I or R from SOK as R Deletes the top object after reading its value.

Checks the type of the operand stack object. Does not check for stack underflow.

Precondition: stack size > 0

◆ getISize_t()

size_t SOK::getISize_t ( )

I from SOK as size_t.

Deletes the top object after reading its integer value. Exits with rangecheck, if the integer from stack can not be converted to size_t. Checks the type of the operand stack object. Does not check for stack underflow.

Precondition: stack size > 0

◆ getSize()

size_t SOK::getSize ( ) const

inlineoverridevirtual

Getter for the number of characters or number of objects.

Reimplemented from SO.

◆ invariant()

bool SOK::invariant ( ) const

inlineoverrideprotectedvirtualnoexcept

Checks class invariants.

Returns: bool ... Indicates whether the class invariants are maintained.

Reimplemented from DbC.

◆ opequalequal()

std::string SOK::opequalequal ( ) const

overridevirtual

For operators '==' and 'pstack'.

This function attempts to produce a result that resembles the red book syntax for creating the object.

Reimplemented from SO.

◆ ot()

OTCode SOK::ot ( ) const

inlineoverridevirtual

Returns an OTCode.

A "manual" implementation of polymorphism, where C++-polymorphisms fail

Returns: OTCode ... The OTCode of the instance.

Implements SO.

◆ otchecker() [1/2]

bool SOK::otchecker ( const std::string & p_s ) const

Checks SO classes on the operand stack against a string of given OTCodes.

A character '.' in p_s matches all object types on the stack.

Precondition: stacksize >= length(p_s)

◆ otchecker() [2/2]

bool SOK::otchecker ( OTCode p_code ) const

inline

Checks SO classes on the operand stack against an OTCodes.

Precondition: stack not empty

◆ peek()

SOp SOK::peek ( ) const

inline

Returns a copy of the SOp of the top most position.

The SOK keeps ownership. Calling peek on an empty stack causes undefined behavior.

Precondition: dequesize > 0

◆ pop()

SOp SOK::pop ( )

inline

Returns a copy of the top SOp, removes the SOp from the SOK.

The returned SOp becomes the owner.

Precondition: dequesize > 0

◆ pop_delete()

void SOK::pop_delete ( )

inline

Removes the top most object from SOK, and the referenced SO will be deleted.

Precondition: dequesize > 0

◆ push() [1/3]

void SOK::push ( SOp p_o1 )

inline

Pushes the object onto the SOK and transfers ownership to the SOK.

The SOK is now responsible for managing the object's lifetime.

Precondition: p_o1 != nullptr

◆ push() [2/3]

void SOK::push	(	SOp	p_o1,
		SOp	p_o2
	)

inline

Pushes the 2 objects onto the SOK and transfers ownership to the SOK.

Precondition: p_o1 != nullptr; p_o2 != nullptr

◆ push() [3/3]

void SOK::push ( std::initializer_list< SOp > p_list )

inline

Pushes n objects onto the SOK and transfers ownership to the SOK.

Precondition: all p_list pointers != nullptr

◆ push_front()

void SOK::push_front ( SOp p_obj )

inline

Pushes the object onto the front side of the SOK and transfers ownership to the SOK.

This is a non-stack feature supporting the constructing of a SOK from the operand stack. The SOK is now responsible for managing the object's lifetime.

Precondition: p_obj != nullptr

◆ setSO()

void SOK::setSO	(	size_t	p_index,
		SOp	p_sop
	)

inline

Setter for a stack object.

The existing SOx will be deleted.

Parameters

[in]	p_index	index from 0 to size-1. Attention: no range check.
[in]	p_sop	the SOA takes ownership of this SO.

Precondition: p_index < stacksize; p_sop != nullptr

◆ type()

std::string SOK::type ( ) const

inlineoverridevirtual

Returns a type name.

Returns: std::string ... The type name of the instance.

Implements SO.

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

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ at()

◆ clone()

◆ countto()

◆ dup()

◆ equal()

◆ findDict()

◆ findValue()

◆ getI()

◆ getIorRasR()

◆ getISize_t()

◆ getSize()

◆ invariant()

◆ opequalequal()

◆ ot()

◆ otchecker() [1/2]

◆ otchecker() [2/2]

◆ peek()

◆ pop()

◆ pop_delete()

◆ push() [1/3]

◆ push() [2/3]

◆ push() [3/3]

◆ push_front()

◆ setSO()

◆ type()