Base class for all variant types. More...

#include <variant_value.hpp>

Inheritance diagram for wfl::variant_value_base:

Public Member Functions
virtual std::size_t	num_elements () const
	Returns the number of elements in a type. More...

virtual bool	is_empty () const
	Whether the stored value is considered empty or not. More...

virtual std::string	string_cast () const
	Returns the stored variant value in plain string form. More...

virtual std::string	get_serialized_string () const
	Returns the stored variant value in formula syntax. More...

virtual std::string	get_debug_string (formula_seen_stack &, bool) const
	Returns debug info for the variant value. More...

virtual bool	as_bool () const
	Returns a bool expression of the variant value. More...

virtual bool	equals (variant_value_base &) const
	Called to determine if this variant is equal to another of the same type. More...

virtual bool	less_than (variant_value_base &) const
	Called to determine if this variant is less than another of the same type. More...

virtual const formula_variant::type &	get_type () const
	Returns the id of the variant type. More...

virtual boost::iterator_range< variant_iterator >	make_iterator () const
	Creates an iterator pair that can be used for iteration. More...

virtual variant	deref_iterator (const utils::any &iter) const
	Implements the dereference functionality of variant_iterator for a value of this type. More...

virtual void	iterator_inc (utils::any &) const
	Implements the increment functionality of variant_iterator for a value of this type. More...

virtual void	iterator_dec (utils::any &) const
	Implements the decrement functionality of variant_iterator for a value of this type. More...

virtual bool	iterator_equals (const utils::any &, const utils::any &) const
	Implements the equality functionality of variant_iterator for a value of this type. More...

virtual	~variant_value_base ()

Detailed Description

Base class for all variant types.

This provides a common interface for all type classes to implement, as well as giving variant a base pointer type for its value member. It also serves as the implementation of the 'null' variant value.

Do note this class should not implement any data members.

Definition at line 75 of file variant_value.hpp.

Constructor & Destructor Documentation

◆ ~variant_value_base()

virtual wfl::variant_value_base::~variant_value_base ( )

inlinevirtual

Definition at line 187 of file variant_value.hpp.

Member Function Documentation

◆ as_bool()

virtual bool wfl::variant_value_base::as_bool ( ) const

inlinevirtual

Returns a bool expression of the variant value.

Reimplemented in wfl::variant_container< T >, wfl::variant_container< variant_map_raw >, wfl::variant_container< variant_vector >, wfl::variant_string, wfl::variant_callable, and wfl::variant_numeric.

Definition at line 109 of file variant_value.hpp.

◆ deref_iterator()

variant wfl::variant_value_base::deref_iterator ( const utils::any & iter ) const

virtual

Implements the dereference functionality of variant_iterator for a value of this type.

Parameters

iter	The opaque reference that was passed to the variant_iterator by make_iterator.

Reimplemented in wfl::variant_callable, wfl::variant_map, and wfl::variant_list.

Definition at line 29 of file variant_value.cpp.

Referenced by wfl::variant_iterator::operator*().

◆ equals()

virtual bool wfl::variant_value_base::equals ( variant_value_base & ) const

inlinevirtual

Called to determine if this variant is equal to another of the same type.

This function is only called if get_type() returns the same result for both arguments.

Reimplemented in wfl::variant_map, wfl::variant_list, wfl::variant_string, wfl::variant_callable, and wfl::variant_numeric.

Definition at line 118 of file variant_value.hpp.

◆ get_debug_string()

virtual std::string wfl::variant_value_base::get_debug_string	(	formula_seen_stack &	,
		bool
	)		const

inlinevirtual

Returns debug info for the variant value.

Reimplemented in wfl::variant_container< T >, wfl::variant_container< variant_map_raw >, wfl::variant_container< variant_vector >, wfl::variant_callable, wfl::variant_string, wfl::variant_decimal, and wfl::variant_int.

Definition at line 103 of file variant_value.hpp.

References get_serialized_string().

◆ get_serialized_string()

virtual std::string wfl::variant_value_base::get_serialized_string ( ) const

inlinevirtual

Returns the stored variant value in formula syntax.

Reimplemented in wfl::variant_container< T >, wfl::variant_container< variant_map_raw >, wfl::variant_container< variant_vector >, wfl::variant_string, wfl::variant_callable, wfl::variant_decimal, and wfl::variant_int.

Definition at line 97 of file variant_value.hpp.

Referenced by get_debug_string().

◆ get_type()

virtual const formula_variant::type& wfl::variant_value_base::get_type ( ) const

inlinevirtual

Returns the id of the variant type.

Reimplemented in wfl::variant_map, wfl::variant_list, wfl::variant_string, wfl::variant_callable, wfl::variant_decimal, and wfl::variant_int.

Definition at line 133 of file variant_value.hpp.

◆ is_empty()

virtual bool wfl::variant_value_base::is_empty ( ) const

inlinevirtual

Whether the stored value is considered empty or not.

Reimplemented in wfl::variant_container< T >, wfl::variant_container< variant_map_raw >, wfl::variant_container< variant_vector >, and wfl::variant_string.

Definition at line 85 of file variant_value.hpp.

◆ iterator_dec()

virtual void wfl::variant_value_base::iterator_dec ( utils::any & ) const

inlinevirtual

Implements the decrement functionality of variant_iterator for a value of this type.

The parameter is an opaque reference that was passed to the variant_iterator by make_iterator.

Reimplemented in wfl::variant_callable, wfl::variant_container< T >, wfl::variant_container< variant_map_raw >, and wfl::variant_container< variant_vector >.

Definition at line 171 of file variant_value.hpp.

Referenced by wfl::variant_iterator::operator--().

◆ iterator_equals()

virtual bool wfl::variant_value_base::iterator_equals	(	const utils::any &	,
		const utils::any &
	)		const

inlinevirtual

Implements the equality functionality of variant_iterator for a value of this type.

Note that this is only called if the two iterators are already known to be of the same type.

The first parameter is an opaque reference that was passed to the variant_iterator by make_iterator. The second parameter is an opaque reference that was passed to the variant_iterator by make_iterator.

Reimplemented in wfl::variant_container< T >, wfl::variant_container< variant_map_raw >, wfl::variant_container< variant_vector >, and wfl::variant_callable.

Definition at line 182 of file variant_value.hpp.

Referenced by wfl::variant_iterator::operator==().