STLValue is the reference implementation of a PikaScript variable. More...

#include <PikaScript.h>

Inheritance diagram for Pika::STLValue< S >:

Collaboration diagram for Pika::STLValue< S >:

Typedefs.
typedef S	String
	The class to use for all strings (i.e. the super-class).

typedef S::value_type	Char
	The character type for all strings (e.g. char or wchar_t).

typedef S	String
	The class to use for all strings (i.e. the super-class).

typedef S::value_type	Char
	The character type for all strings (e.g. char or wchar_t).

Constructors.
	STLValue ()
	The default constructor initializes the value to the empty string (or "void").

	STLValue (double d)
	Constructs a value representing the double precision floating point `d`.

	STLValue (float f)
	Constructs a value representing the single precision floating point `f`.

	STLValue (long i)
	Constructs a value representing the signed long integer `l`.

	STLValue (ulong i)
	Constructs a value representing the ulong integer `l`.

	STLValue (int i)
	Constructs a value representing the signed integer `i`.

	STLValue (uint i)
	Constructs a value representing the unsigned integer `i`.

	STLValue (bool b)
	Constructs a value representing the boolean `b`.

template<class T >
	STLValue (const T &s)
	Pass other types of construction onwards to the super-class `S`.

	STLValue ()
	The default constructor initializes the value to the empty string (or "void").

	STLValue (double d)
	Constructs a value representing the double precision floating point `d`.

	STLValue (float f)
	Constructs a value representing the single precision floating point `f`.

	STLValue (long i)
	Constructs a value representing the signed long integer `l`.

	STLValue (ulong i)
	Constructs a value representing the ulong integer `l`.

	STLValue (int i)
	Constructs a value representing the signed integer `i`.

	STLValue (uint i)
	Constructs a value representing the unsigned integer `i`.

	STLValue (bool b)
	Constructs a value representing the boolean `b`.

template<class T >
	STLValue (const T &s)
	Pass other types of construction onwards to the super-class `S`.

Conversion to native C++ types.
	operator bool () const
	Converts the value to a boolean. More...

	operator long () const
	Converts the value to a signed long integer. More...

	operator double () const
	Converts the value to a double precision floating point. More...

	operator float () const
	Converts the value to a single precision floating point. More...

	operator ulong () const
	Converts the value to an ulong integer. More...

	operator int () const
	Converts the value to a signed integer. More...

	operator uint () const
	Converts the value to an unsigned integer. More...

	operator bool () const
	Converts the value to a boolean. More...

	operator long () const
	Converts the value to a signed long integer. More...

	operator double () const
	Converts the value to a double precision floating point. More...

	operator float () const
	Converts the value to a single precision floating point. More...

	operator ulong () const
	Converts the value to an ulong integer. More...

	operator int () const
	Converts the value to a signed integer. More...

	operator uint () const
	Converts the value to an unsigned integer. More...

Overloaded operators (comparisons and subscript).
bool	operator< (const STLValue &r) const
	Less than comparison operator. More...

bool	operator== (const STLValue &r) const
	Equality operator. More...

bool	operator!= (const STLValue &r) const
	Non-equality operator. More...

bool	operator> (const STLValue &r) const
	Greater than comparison operator. More...

bool	operator<= (const STLValue &r) const
	Less than or equal to comparison operator. More...

bool	operator>= (const STLValue &r) const
	Greater than or equal to comparison operator. More...

const STLValue	operator[] (const STLValue &i) const
	The subscript operator returns the concatenation of the value with the dot (.) separator (if necessary) and the value `i`. More...

bool	operator< (const STLValue &r) const
	Less than comparison operator. More...

bool	operator== (const STLValue &r) const
	Equality operator. More...

bool	operator!= (const STLValue &r) const
	Non-equality operator. More...

bool	operator> (const STLValue &r) const
	Greater than comparison operator. More...

bool	operator<= (const STLValue &r) const
	Less than or equal to comparison operator. More...

bool	operator>= (const STLValue &r) const
	Greater than or equal to comparison operator. More...

const STLValue	operator[] (const STLValue &i) const
	The subscript operator returns the concatenation of the value with the dot (.) separator (if necessary) and the value `i`. More...

Classification methods.
bool	isVoid () const
	Returns true if the value represents the empty string.

bool	isVoid () const
	Returns true if the value represents the empty string.

Helper templates to allow certain operations on any type that is convertible to a STLValue.
template<class T >
bool	operator< (const T &r) const

template<class T >
bool	operator== (const T &r) const

template<class T >
bool	operator!= (const T &r) const

template<class T >
bool	operator> (const T &r) const

template<class T >
bool	operator<= (const T &r) const

template<class T >
bool	operator>= (const T &r) const

template<class T >
const STLValue	operator[] (const T &i) const

template<class T >
bool	operator< (const T &r) const

template<class T >
bool	operator== (const T &r) const

template<class T >
bool	operator!= (const T &r) const

template<class T >
bool	operator> (const T &r) const

template<class T >
bool	operator<= (const T &r) const

template<class T >
bool	operator>= (const T &r) const

template<class T >
const STLValue	operator[] (const T &i) const

Detailed Description

template<class S>
class Pika::STLValue< S >

STLValue is the reference implementation of a PikaScript variable.

Internally, all values are represented by an STL compliant string class S *. This class actually inherits from S (with public inheritance) for optimization reasons. This way we avoid a lot of unnecessary temporary objects when we cast to and from strings. (Unfortunately it is not possible to make this inheritance private and add conversion operators to the S class. Explicit conversion operators in C++ have lower priority than implicit base class conversions.)

Although it may seem inefficient to store all variables in textual representation it makes PikaScript easy to interface with and debug for. With the custom value <-> text conversion routines in PikaScript the performance isn't too bad. It mainly depends on the performance of the string implementation which is the reason why this class is a template. The standard variant of STLValue uses std::string, but you may want to "plug in" a more efficient class.

STLValue supports construction from and casting to the following C++ types:

bool
int
uint
long
ulong
float
double
the template string class S

Note: PikaScript only requires a specific subset of the STL string features. Utility member functions (such as find_first_of) are never used (instead, the equivalent generic STL algorithms are utilized). Destructive functions such as insert and erase are not used either. Furthermore, PikaScript consider all string access through the subscript operator [] to be for reading only (therefore only a const function for this operator is required).

Definition at line 173 of file PikaScript.h.

Member Function Documentation

template<class S >

Pika::STLValue< S >::operator bool ( ) const

Converts the value to a boolean.

If the value isn't "true" or "false" an exception is thrown.

template<class S >

Pika::STLValue< S >::operator bool ( ) const

Converts the value to a boolean.

If the value isn't "true" or "false" an exception is thrown.

Definition at line 251 of file PikaScriptImpl.h.

template<class S >

Pika::STLValue< S >::operator double ( ) const

Converts the value to a double precision floating point.

If the value isn't in valid floating point format an exception is thrown.

template<class S >

Pika::STLValue< S >::operator double ( ) const

Converts the value to a double precision floating point.

If the value isn't in valid floating point format an exception is thrown.

Definition at line 264 of file PikaScriptImpl.h.

template<class S >

Pika::STLValue< S >::operator float ( ) const

inline

Converts the value to a single precision floating point.

If the value isn't in valid floating point format an exception is thrown.

Definition at line 197 of file PikaScript.h.

template<class S >

Pika::STLValue< S >::operator float ( ) const

inline

Converts the value to a single precision floating point.

If the value isn't in valid floating point format an exception is thrown.

Definition at line 197 of file PikaScript.h.

template<class S >

Pika::STLValue< S >::operator int ( ) const

inline

Converts the value to a signed integer.