KvpValue Struct Reference

Implements KvpValue using boost::variant. More...

#include <kvp-value.hpp>

Public Types
enum	Type {   INVALID = -1 , INT64 = 1 , DOUBLE , NUMERIC ,   STRING , GUID , TIME64 , PLACEHOLDER_DONT_USE ,   GLIST , FRAME , GDATE }

Public Member Functions
	KvpValueImpl (KvpValueImpl const &) noexcept
	Performs a deep copy.
KvpValueImpl &	operator= (const KvpValueImpl &) noexcept
	KvpValueImpl (KvpValueImpl &&b) noexcept
	Move.
KvpValueImpl &	operator= (KvpValueImpl &&b) noexcept
template<typename T >
	KvpValueImpl (T) noexcept
	Create a KvpValue containing the passed in item.
	~KvpValueImpl () noexcept
	Performs a deep delete.
KvpValueImpl *	add (KvpValueImpl *) noexcept
	Adds another value to this KvpValueImpl.
KvpValueImpl::Type	get_type () const noexcept
std::string	to_string () const noexcept
std::string	to_string (std::string const &prefix) const noexcept
template<typename T >
T	get () const noexcept
template<typename T >
const T *	get_ptr () const noexcept
template<typename T >
void	set (T) noexcept

Friends
int	compare (const KvpValueImpl &, const KvpValueImpl &) noexcept

Detailed Description

Implements KvpValue using boost::variant.

Capable of holding the following types:

• int64_t
• double
• gnc_numeric
• const char*
• GncGUID*
• Timepsec
• GList*
• KvpFrame*
• GDate

Definition at line 52 of file kvp-value.hpp.

Member Enumeration Documentation

Type

enum KvpValueImpl::Type

Enumerator
INT64	QOF_TYPE_INT64 gint64.
DOUBLE	QOF_TYPE_DOUBLE gdouble.
NUMERIC	QOF_TYPE_NUMERIC.
STRING	QOF_TYPE_STRING gchar*.
GUID	QOF_TYPE_GUID.
TIME64	QOF_TYPE_DATE.
GLIST	no QOF equivalent.
FRAME	no QOF equivalent.
GDATE	no QOF equivalent.

Definition at line 55 of file kvp-value.hpp.

    {
        INVALID = -1,
        INT64 = 1, 
        DOUBLE,     
        NUMERIC,    
        STRING,     
        GUID,       
        TIME64,   
        PLACEHOLDER_DONT_USE, /* Replaces KVP_TYPE_BINARY */
        GLIST,      
        FRAME,      
        GDATE,      
    };

Constructor & Destructor Documentation

KvpValueImpl() [1/3]

KvpValue::KvpValueImpl ( KvpValueImpl const &  other )

noexcept

Performs a deep copy.

Definition at line 34 of file kvp-value.cpp.

{
    duplicate(other);
}

KvpValueImpl() [2/3]

KvpValue::KvpValueImpl ( KvpValueImpl &&  b )

noexcept

Move.

The old object's datastore is set to int64_t 0.

Definition at line 46 of file kvp-value.cpp.

{
    datastore = b.datastore;
    b.datastore = INT64_C(0);
}

KvpValueImpl() [3/3]

template<typename T >

KvpValue::KvpValueImpl ( T  newvalue )

noexcept

Create a KvpValue containing the passed in item.

Note that for pointer types const char*, KvpFrame*, GncGUID*, and GList* the KvpValue takes ownership of the object and will delete/free it when the KvpValue is destroyed. That means these objects must be allocated in the free store or heap as follows:

• const char*: GLib string allocation, e.g. g_strdup()/
• KvpFrame*: operator new
• GncGUID*: guid_new() or guid_copy()
• GList*: Uses g_list_free(), so it's up to classes using this to empty the list before destroying the KvpValue.

Definition at line 150 of file kvp-value.hpp.

                                             :
    datastore(newvalue)
{
}

~KvpValueImpl()

KvpValue::~KvpValueImpl ( )

noexcept

Performs a deep delete.

The contents of this KvpValueImpl are also deleted.

Definition at line 366 of file kvp-value.cpp.

{
    delete_visitor d;
    boost::apply_visitor(d, datastore);
}

Member Function Documentation

add()

KvpValueImpl * KvpValue::add ( KvpValueImpl *  val )

noexcept

Adds another value to this KvpValueImpl.

If this KvpValueImpl represents a collection (GList), the new value is added to the collection and this is returned.

Otherwise, a new KvpValueImpl representing a collection is created, this and the new value are added to it, and it is returned.

Definition at line 60 of file kvp-value.cpp.

{
    /* If already a glist here, just append */
    if (this->datastore.type() == type_id<GList*>())
    {
        GList * list = boost::get<GList*>(datastore);
        datastore = g_list_append (list, val);
        return this;
    }
    /* If some other value, convert it to a glist */
    GList *list = nullptr;
 
    list = g_list_append (list, this);
    list = g_list_append (list, val);
    return new KvpValueImpl(list);
}

get()

template<typename T >

T KvpValue::get ( ) const

noexcept

Definition at line 156 of file kvp-value.hpp.

{
    if (this->datastore.type() != boost::typeindex::type_id<T>()) return {};
    return boost::get<T>(datastore);
}

get_ptr()

template<typename T >

const T * KvpValue::get_ptr ( ) const

noexcept

Definition at line 163 of file kvp-value.hpp.

{
    if (this->datastore.type() != typeid(T)) return nullptr;
    return boost::get<T>(&datastore);
}

get_type()

KvpValue::Type KvpValue::get_type ( ) const

noexcept

Definition at line 78 of file kvp-value.cpp.

{
    if (datastore.type() == type_id<int64_t>())
        return KvpValue::Type::INT64;
    else if (datastore.type() == type_id<double>())
        return KvpValue::Type::DOUBLE;
    else if (datastore.type() == type_id<gnc_numeric>())
        return KvpValue::Type::NUMERIC;
    else if (datastore.type() == type_id<const gchar *>())
        return KvpValue::Type::STRING;
    else if (datastore.type() == type_id<GncGUID *>())
        return KvpValue::Type::GUID;
    else if (datastore.type() == type_id<Time64>())
        return KvpValue::Type::TIME64;
    else if (datastore.type() == type_id<GList *>())
        return KvpValue::Type::GLIST;
    else if (datastore.type() == type_id<KvpFrameImpl *>())
        return KvpValue::Type::FRAME;
    else if (datastore.type() == type_id<GDate>())
        return KvpValue::Type::GDATE;
 
    return KvpValue::Type::INVALID;
}

operator=() [1/2]

KvpValueImpl & KvpValue::operator= ( const KvpValueImpl &  other )

noexcept

Definition at line 40 of file kvp-value.cpp.

{
    duplicate(other);
    return *this;
}

operator=() [2/2]

KvpValueImpl & KvpValue::operator= ( KvpValueImpl &&  b )

noexcept

Definition at line 53 of file kvp-value.cpp.

{
    std::swap (datastore, b.datastore);
    return *this;
}

set()

template<typename T >

void KvpValue::set ( T  val )

noexcept

Definition at line 170 of file kvp-value.hpp.

{
    this->datastore = val;
}

to_string() [1/2]

std::string KvpValue::to_string ( ) const

noexcept

Definition at line 201 of file kvp-value.cpp.

{
    return to_string("");
}

to_string() [2/2]

std::string KvpValue::to_string ( std::string const &  prefix ) const

noexcept

Definition at line 189 of file kvp-value.cpp.

{
    if (this->datastore.type() == type_id<KvpFrame*>())
        return this->get<KvpFrame*>()->to_string(prefix);
    std::ostringstream ret;
    to_string_visitor visitor {ret};
    boost::apply_visitor(visitor, datastore);
    /*We still use g_strdup since the return value will be freed by g_free*/
    return prefix + ret.str();
}

Friends And Related Symbol Documentation

compare

int compare ( const KvpValueImpl &  one, const KvpValueImpl &  two  )

friend

Definition at line 311 of file kvp-value.cpp.

{
    auto type1 = one.get_type();
    auto type2 = two.get_type();
 
    if (type1 != type2)
        return type1 < type2 ? -1 : 1;
 
    compare_visitor comparer;
    return boost::apply_visitor(comparer, one.datastore, two.datastore);
}

---

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

• kvp-value.hpp
• kvp-value.cpp