variant.hpp

Go to the documentation of this file.

/************************************************************************
Copyright (C) 2011 - 2014 Project Wolframe.
All rights reserved.

This file is part of Project Wolframe.

Commercial Usage
Licensees holding valid Project Wolframe Commercial licenses may
use this file in accordance with the Project Wolframe
Commercial License Agreement provided with the Software or,
alternatively, in accordance with the terms contained
in a written agreement between the licensee and Project Wolframe.

GNU General Public License Usage
Alternatively, you can redistribute this file and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Wolframe is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Wolframe. If not, see <http://www.gnu.org/licenses/>.

If you have questions regarding the use of this file, please contact
Project Wolframe.

************************************************************************/

#ifndef _Wolframe_TYPES_VARIANT_HPP_INCLUDED
#define _Wolframe_TYPES_VARIANT_HPP_INCLUDED
#include "types/integer.hpp"
#include <boost/cstdint.hpp>
#include <string>
#include <cstring>
#include <ostream>
#include <stdexcept>

namespace _Wolframe {
namespace types {

class CustomDataType;
class CustomDataValue;
class CustomDataInitializer;
class BigNumber;
class DateTime;

class Variant
{
public:
        enum Type
        {
                Null,                   
                Custom,                 
                Timestamp,              
                BigNumber,              
                Double,                 
                Int,                    
                UInt,                   
                Bool,                   
                String                  
        };
        enum Flags
        {
                Initialized     =0x1,   
                Constant        =0x2    
        };

        static const char* typeName( Type i)
        {
                static const char* ar[] = {"null","custom","timestamp","bignumber","double","int","uint","bool","string","array","struct","indirection","unresolved"};
                return ar[ (int)i];
        }
        const char* typeName() const
        {
                return typeName( (Type)m_type);
        }

        struct Data
        {
                typedef _WOLFRAME_INTEGER Int;          
                typedef _WOLFRAME_UINTEGER UInt;        
                typedef _WOLFRAME_UINTEGER Timestamp;   
                union
                {
                        bool Bool;                      
                        double Double;                  
                        Data::Int Int;                  
                        Data::UInt UInt;                
                        Data::UInt Timestamp;           
                        char* String;                   
                        CustomDataValue* Custom;        
                        types::BigNumber* BigNumberRef; 
                        void* Ref;                      
                } value;                                
                union
                {
                        const void* metadata;           
                        std::size_t size;               
                } dim;                                  
        };
        Variant( Type type_)                                    {init(type_);}
        Variant()                                               {init();}
        Variant( bool o)                                        {init(Bool); m_data.value.Bool = o;}
        Variant( double o)                                      {init(Double); m_data.value.Double = o;}
        Variant( float o)                                       {init(Double); m_data.value.Double = o;}

        Variant( const boost::int64_t& o)                       {init(Int); m_data.value.Int = (Data::Int)o;}
        Variant( const boost::uint64_t& o)                      {init(UInt); m_data.value.UInt = (Data::UInt)o;}
        Variant( boost::int32_t o)                              {init(Int); m_data.value.Int = o;}
        Variant( boost::uint32_t o)                             {init(UInt); m_data.value.UInt = o;}
        Variant( boost::int16_t o)                              {init(Int); m_data.value.Int = o;}
        Variant( boost::uint16_t o)                             {init(UInt); m_data.value.UInt = o;}

        Variant( const char* o)                                 {initString( o, std::strlen(o));}
        Variant( const char* o, std::size_t n)                  {initString( o, n);}
        Variant( const std::string& o)                          {initString( o.c_str(), o.size());}
        Variant( const types::CustomDataType* typ,
                 const types::CustomDataInitializer* dsc=0)     {initCustom( typ, dsc);}
        Variant( const types::CustomDataValue& o)               {initCustom( o);}
        Variant( const Variant& o)                              {initCopy( o);}
        Variant( const types::DateTime& o)                      {initDateTime( o);}
        Variant( const types::BigNumber& o)                     {initBigNumber( o);}

        ~Variant()                                              {release();}

        Variant& operator=( const Variant& o)                   {bool init_=initialized(); release(); initCopy( o); setInitialized(init_); return *this;}
        Variant& operator=( bool o)                             {bool init_=initialized(); release(); init(Bool); m_data.value.Bool = o; setInitialized(init_); return *this;}
        Variant& operator=( double o)                           {bool init_=initialized(); release(); init(Double); m_data.value.Double = o; setInitialized(init_); return *this;}
        Variant& operator=( float o)                            {bool init_=initialized(); release(); init(Double); m_data.value.Double = o; setInitialized(init_); return *this;}

        Variant& operator=( const boost::int64_t& o)            {bool init_=initialized(); release(); init(Int); m_data.value.Int = (Data::Int)o; setInitialized(init_); return *this;}
        Variant& operator=( const boost::uint64_t& o)           {bool init_=initialized(); release(); init(UInt); m_data.value.UInt = (Data::UInt)o; setInitialized(init_); return *this;}
        Variant& operator=( boost::int32_t o)                   {bool init_=initialized(); release(); init(Int); m_data.value.Int = o; setInitialized(init_); return *this;}
        Variant& operator=( boost::uint32_t o)                  {bool init_=initialized(); release(); init(UInt); m_data.value.UInt = o; setInitialized(init_); return *this;}
        Variant& operator=( boost::int16_t o)                   {bool init_=initialized(); release(); init(Int); m_data.value.Int = o; setInitialized(init_); return *this;}
        Variant& operator=( boost::uint16_t o)                  {bool init_=initialized(); release(); init(UInt); m_data.value.UInt = o; setInitialized(init_); return *this;}

        Variant& operator=( const types::CustomDataValue& o)    {bool init_=initialized(); release(); initCustom(o); setInitialized(init_); return *this;}
        Variant& operator=( const char* o)                      {bool init_=initialized(); release(); initString( o, std::strlen(o)); setInitialized(init_); return *this;}
        Variant& operator=( const std::string& o)               {bool init_=initialized(); release(); initString( o.c_str(), o.size()); setInitialized(init_); return *this;}
        Variant& operator=( const types::DateTime& o)           {bool init_=initialized(); release(); initDateTime( o); setInitialized(init_); return *this;}
        Variant& operator=( const types::BigNumber& o)          {bool init_=initialized(); release(); initBigNumber( o); setInitialized(init_); return *this;}

        void initConstant( const char* o, std::size_t l);
        void initConstant( const std::string& o)                {initConstant( o.c_str(),o.size());}
        void initConstant( const char* o)                       {initConstant( o, std::strlen(o));}
        void initConstant( const types::CustomDataValue& o);
        void initConstant( const types::BigNumber& o);
        void initConstant( const types::DateTime& o);

        bool operator==( const Variant& o) const                {return compare( o) == 0;}
        bool operator!=( const Variant& o) const                {int cv = compare( o); return cv != 0 && cv != -2;}
        bool operator>( const Variant& o) const                 {int cv = compare( o); return cv > 0;}
        bool operator>=( const Variant& o) const                {int cv = compare( o); return cv >= 0;}
        bool operator<=( const Variant& o) const                {int cv = compare( o); return cv <= 0 && cv != -2;}
        bool operator<( const Variant& o) const                 {int cv = compare( o); return cv == -1;}

        Type type() const                                       {return (Type)m_type;}
        const Data& data() const                                {return m_data;}
        Data& data()                                            {return m_data;}

        char* charptr() const                                   {if (type() != String) throw std::logic_error("illegal access (type mismatch)"); return m_data.value.String;}
        std::size_t charsize() const                            {if (type() != String) throw std::logic_error("illegal access (type mismatch)"); return m_data.dim.size;}
        const CustomDataValue* customref() const                {if (type() != Custom) throw std::logic_error("illegal access (type mismatch)"); return m_data.value.Custom;}
        CustomDataValue* customref()                            {if (type() != Custom) throw std::logic_error("illegal access (type mismatch)"); return m_data.value.Custom;}
        const types::BigNumber* bignumref() const               {if (type() != BigNumber) throw std::logic_error("illegal access (type mismatch)"); return m_data.value.BigNumberRef;}
        types::BigNumber* bignumref()                           {if (type() != BigNumber) throw std::logic_error("illegal access (type mismatch)"); return m_data.value.BigNumberRef;}

        std::string tostring() const;
        std::wstring towstring() const;
        double todouble() const;
        bool tobool() const;
        Data::Int toint() const;
        Data::UInt touint() const;
        Data::Timestamp totimestamp() const;

        std::size_t size() const                                {return (type() == String)?m_data.dim.size:1;}

        bool initialized() const                                {return flags( Initialized);}
        void setInitialized( bool v=true)                       {setFlags( Initialized, v);}

        bool constant() const                                   {return flags( Constant);}

        void setConstant( bool v=true)                          {setFlags( Constant, v);}

        bool atomic() const                                     {return m_type <= (unsigned char)String;}

        bool defined() const                                    {return m_type != (unsigned char)Null;}

        void clear()                                            {release(); init();}

        void convert( Type type_);

        void assign( Type type_, const Variant& o);

        void move( Variant& o);

protected:
        bool flags( Flags flags_) const                         {return ((unsigned char)m_flags & (unsigned char)flags_) == (unsigned char)flags_;}
        void setFlags( Flags flags_, bool v=true)               {if (v) m_flags = (Flags)((unsigned char)m_flags | (unsigned char)flags_); else m_flags = (Flags)((unsigned char)m_flags - ((unsigned char)m_flags & (unsigned char)flags_));}

        void init( Type type_);
        void init();
        void release();
        void initString( const char* str_, std::size_t strsize_);
        void initCustom( const types::CustomDataType* typ,
                        const CustomDataInitializer* dsc=0);
        void initCustom( const types::CustomDataValue& o);
        void initCopy( const Variant& o);
        void initConstCopy( const Variant& o);
        void initDateTime( const types::DateTime& dt);
        void initBigNumber( const types::BigNumber& num);

        int compare( const Variant& o) const;

protected:
        Data m_data;
        unsigned char m_type;
        unsigned char m_flags;
};


struct VariantConst :public Variant
{
        VariantConst()                                  {init();}
        VariantConst( const Variant& o)                 :Variant(){initConstCopy( o);}
        VariantConst( const VariantConst& o)            :Variant(){initConstCopy( o);}
        VariantConst( bool o)                           :Variant(Bool){m_data.value.Bool = o; setConstant();}
        VariantConst( double o)                         :Variant(Double){m_data.value.Double = o; setConstant();}
        VariantConst( float o)                          :Variant(Double){m_data.value.Double = o; setConstant();}

        VariantConst( const boost::int64_t& o)          :Variant(Int){m_data.value.Int = (Data::Int)o; setConstant();}
        VariantConst( const boost::uint64_t& o)         :Variant(UInt){m_data.value.UInt = (Data::UInt)o; setConstant();}
        VariantConst( boost::int32_t o)                 :Variant(Int){m_data.value.Int = o; setConstant();}
        VariantConst( boost::uint32_t o)                :Variant(UInt){m_data.value.UInt = o; setConstant();}
        VariantConst( boost::int16_t o)                 :Variant(Int){m_data.value.Int = o; setConstant();}
        VariantConst( boost::uint16_t o)                :Variant(UInt){m_data.value.UInt = o; setConstant();}
        VariantConst( const types::CustomDataValue& o)  :Variant(){Variant::initConstant( o);}
        VariantConst( const types::BigNumber& o)        :Variant(){Variant::initConstant( o);}
        VariantConst( const char* o)                    :Variant(){Variant::initConstant( o, std::strlen(o));}
        VariantConst( const char* o, std::size_t n)     :Variant(){Variant::initConstant( o, n);}
        VariantConst( const std::string& o)             :Variant(){Variant::initConstant( o.c_str(), o.size());}
        VariantConst( const types::DateTime& o)         :Variant(){Variant::initConstant( o);}
        ~VariantConst(){}

        VariantConst& operator=( const Variant& o)              {bool init_=initialized(); initConstCopy( o); setInitialized(init_); return *this;}
        VariantConst& operator=( const VariantConst& o)         {bool init_=initialized(); initConstCopy( o); setInitialized(init_); return *this;}
        VariantConst& operator=( bool o)                        {bool init_=initialized(); Variant::init(Variant::Bool); m_data.value.Bool = o; setInitialized(init_); setConstant(); return *this;}
        VariantConst& operator=( double o)                      {bool init_=initialized(); Variant::init(Variant::Double); m_data.value.Double = o; setInitialized(init_); setConstant(); return *this;}
        VariantConst& operator=( float o)                       {bool init_=initialized(); Variant::init(Variant::Double); m_data.value.Double = o; setInitialized(init_); setConstant(); return *this;}

        VariantConst& operator=( const boost::int64_t& o)       {bool init_=initialized(); Variant::init(Variant::Int); m_data.value.Int = (Data::Int)o; setInitialized(init_); setConstant(); return *this;}
        VariantConst& operator=( const boost::uint64_t& o)      {bool init_=initialized(); Variant::init(Variant::UInt); m_data.value.UInt = (Data::UInt)o; setInitialized(init_); setConstant(); return *this;}
        VariantConst& operator=( boost::int32_t o)              {bool init_=initialized(); Variant::init(Variant::Int); m_data.value.Int = o; setInitialized(init_); setConstant(); return *this;}
        VariantConst& operator=( boost::uint32_t o)             {bool init_=initialized(); Variant::init(Variant::UInt); m_data.value.UInt = o; setInitialized(init_); setConstant(); return *this;}
        VariantConst& operator=( boost::int16_t o)              {bool init_=initialized(); Variant::init(Variant::Int); m_data.value.Int = o; setInitialized(init_); setConstant(); return *this;}
        VariantConst& operator=( boost::uint16_t o)             {bool init_=initialized(); Variant::init(Variant::UInt); m_data.value.UInt = o; setInitialized(init_); setConstant(); return *this;}

        VariantConst& operator=( const types::CustomDataValue& o){bool init_=initialized(); initConstant( o); setInitialized(init_); return *this;}
        VariantConst& operator=( const types::BigNumber& o)     {bool init_=initialized(); initConstant( o); setInitialized(init_); return *this;}
        VariantConst& operator=( const types::DateTime& o)      {bool init_=initialized(); initConstant( o); setInitialized(init_); return *this;}
        VariantConst& operator=( const char* o)                 {bool init_=initialized(); initConstant( o, std::strlen(o)); setInitialized(init_); return *this;}
        VariantConst& operator=( const std::string& o)          {bool init_=initialized(); initConstant( o.c_str(), o.size()); setInitialized(init_); return *this;}

        void init( const char* o, std::size_t len)              {bool init_=initialized(); initConstant( o, len); setInitialized(init_);}
        void init( const char* o)                               {bool init_=initialized(); initConstant( o, o?std::strlen(o):0); setInitialized(init_);}
        void init( const std::string& o)                        {bool init_=initialized(); initConstant( o.c_str(), o.size()); setInitialized(init_);}
        void init( const types::CustomDataValue& o)             {bool init_=initialized(); initConstant( o); setInitialized(init_);}
        void init( const types::BigNumber& o)                   {bool init_=initialized(); initConstant( o); setInitialized(init_);}
        void init( const types::DateTime& o)                    {bool init_=initialized(); initConstant( o); setInitialized(init_);}

        void init()                                             {Variant::init(); setConstant();}

        void clear()                                            {Variant::init();}
};

}} //namespace

namespace std
{
ostream& operator << (ostream &os, const _Wolframe::types::Variant& o);
} //namespace

#endif