ECValue.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <Bentley/VirtualCollectionIterator.h>
#include <Bentley/DateTime.h>
#include <ECObjects/ECInstance.h>
#include <ECObjects/ECObjects.h>
#include <ECObjects/StandardCustomAttributeHelper.h>
#include <Geom/GeomApi.h>

BEGIN_BENTLEY_ECOBJECT_NAMESPACE

typedef RefCountedPtr<ECPropertyValue> ECPropertyValuePtr;
typedef RefCountedPtr<ECValuesCollection> ECValuesCollectionPtr;



//=======================================================================================    
//=======================================================================================    
struct ArrayInfo
    {
private:
    union
        {
        ArrayKind       m_arrayKind;
        PrimitiveType   m_elementPrimitiveType;
        };    
    bool                m_isFixedCount;
    uint32_t            m_count;
            
public:
    void InitializeStructArray (uint32_t count, bool isFixedSize); // cannot have a real constructor due to inclusion in a union

    void InitializePrimitiveArray (PrimitiveType elementPrimitiveType, uint32_t count, bool isFixedCount); // cannot have a real constructor due to inclusion in a union
    
    ECOBJECTS_EXPORT uint32_t        GetCount() const;
    ECOBJECTS_EXPORT bool            IsFixedCount() const;
    ECOBJECTS_EXPORT bool            IsPrimitiveArray() const;
    ECOBJECTS_EXPORT bool            IsStructArray() const;
    ECOBJECTS_EXPORT ValueKind       GetKind() const;
    ECOBJECTS_EXPORT PrimitiveType   GetElementPrimitiveType() const;
    };

//=======================================================================================
//=======================================================================================
struct ECValue
    {
public:
    void ShallowCopy (ECValueCR v);
private:        
    union
        {
        ValueKind       m_valueKind;
        PrimitiveType   m_primitiveType;
        };

    uint8_t             m_stateFlags;
    mutable uint8_t     m_ownershipFlags;       // mutable because string ownership may change when we perform on-demand encoding conversions...

    void                InitForString (void const * str);
    BentleyStatus       SetBinaryInternal (const Byte * data, size_t size, bool holdADuplicate = false);
    bool                ConvertToPrimitiveFromString (PrimitiveType primitiveType);

protected:    
    typedef bvector<ECValue>  ValuesVector;
    typedef bvector<ECValue>* ValuesVectorP;
    
    struct BinaryInfo
        {
        const Byte *        m_data; 
        size_t              m_size; 
        };

    struct StringInfo
        {
    private:

        Utf8CP              m_utf8;             
        Utf16CP             m_utf16;
#if !defined (_WIN32)
        WCharCP             m_wchar;        // On Windows we use m_utf16. The presence of the extra pointer wouldn't hurt anything but want to ensure it's only used on unix.
#endif
        };

    struct DateTimeInfo
        {
    private:
        ::Int64             m_ceTicks;
        DateTime::Kind      m_kind;
        DateTime::Component m_component;
        bool                m_isMetadataSet;

        };

    union
        {
        bool                m_boolean;      
        ::Int32             m_integer32;    
        ::Int64             m_long64;       
        double              m_double;       
        mutable StringInfo  m_stringInfo;       // mutable so that we can convert to requested encoding on demand
        DPoint2d            m_dPoint2d;     
        DateTimeInfo        m_dateTimeInfo; 
        DPoint3d            m_dPoint3d;     
        ArrayInfo           m_arrayInfo;    
        BinaryInfo          m_binaryInfo;   
        IECInstanceP        m_structInstance;   
        };

    void ConstructUninitialized();
    inline void FreeMemory ();
         
public:
    ECOBJECTS_EXPORT void            Clear();
    ECOBJECTS_EXPORT ECValueR        operator= (ECValueCR rhs);    
    ECOBJECTS_EXPORT ~ECValue();

    ECOBJECTS_EXPORT ECValue ();
    ECOBJECTS_EXPORT ECValue (ECValueCR v);

    ECOBJECTS_EXPORT explicit ECValue (ValueKind classification);

    ECOBJECTS_EXPORT explicit ECValue (PrimitiveType primitiveType);

    ECOBJECTS_EXPORT explicit ECValue (::Int32 integer32);

    ECOBJECTS_EXPORT explicit ECValue (::Int64 long64);

    ECOBJECTS_EXPORT explicit ECValue (double doubleVal);

    ECOBJECTS_EXPORT explicit ECValue (WCharCP string, bool holdADuplicate = true);

    ECOBJECTS_EXPORT explicit ECValue (Utf8CP string, bool holdADuplicate = true);

    ECOBJECTS_EXPORT explicit ECValue (Utf16CP string, bool holdADuplicate = true);

    ECOBJECTS_EXPORT explicit ECValue (const Byte * blob, size_t size);

    ECOBJECTS_EXPORT explicit ECValue (DPoint2dCR point2d);

    ECOBJECTS_EXPORT explicit ECValue (DPoint3dCR point3d);

    ECOBJECTS_EXPORT explicit ECValue (bool value);

    ECOBJECTS_EXPORT explicit ECValue (DateTimeCR dateTime);

    ECOBJECTS_EXPORT void           SetIsReadOnly(bool isReadOnly);

    ECOBJECTS_EXPORT bool           IsReadOnly() const;

    ECOBJECTS_EXPORT void           SetIsNull(bool isNull); 

    ECOBJECTS_EXPORT bool           IsNull() const;

    ECOBJECTS_EXPORT void           SetIsLoaded(bool isLoaded); 

    ECOBJECTS_EXPORT bool           IsLoaded() const; 

    ECOBJECTS_EXPORT void           SetToNull(); 

    ECOBJECTS_EXPORT void           From(ECValueCR v);

    ECOBJECTS_EXPORT ValueKind      GetKind() const; 
    ECOBJECTS_EXPORT bool           IsUninitialized () const; 
    
    ECOBJECTS_EXPORT bool           IsString () const;
    ECOBJECTS_EXPORT bool           IsUtf8 () const;
    ECOBJECTS_EXPORT bool           IsInteger () const;
    ECOBJECTS_EXPORT bool           IsLong () const;
    ECOBJECTS_EXPORT bool           IsDouble () const;
    ECOBJECTS_EXPORT bool           IsBinary () const;
    ECOBJECTS_EXPORT bool           IsBoolean () const;

    ECOBJECTS_EXPORT bool           IsPoint2D () const;
    ECOBJECTS_EXPORT bool           IsPoint3D () const;
    ECOBJECTS_EXPORT bool           IsDateTime () const;
    ECOBJECTS_EXPORT bool           IsIGeometry() const;

    ECOBJECTS_EXPORT bool           IsArray () const;
    ECOBJECTS_EXPORT bool           IsStruct () const;
    ECOBJECTS_EXPORT bool           IsPrimitive () const;
    ECOBJECTS_EXPORT PrimitiveType  GetPrimitiveType() const; 

    ECOBJECTS_EXPORT BentleyStatus  SetPrimitiveType(PrimitiveType primitiveElementType);
    
    ECOBJECTS_EXPORT bool           CanConvertToPrimitiveType (PrimitiveType type) const;

    ECOBJECTS_EXPORT ECObjectsStatus  SetStructArrayInfo (uint32_t count, bool isFixedSize);

    ECOBJECTS_EXPORT ECObjectsStatus  SetPrimitiveArrayInfo (PrimitiveType primitiveElementtype, uint32_t count, bool isFixedSize);
    
    ECOBJECTS_EXPORT ArrayInfo      GetArrayInfo() const;
    
    ECOBJECTS_EXPORT int32_t        GetInteger () const;  
    ECOBJECTS_EXPORT BentleyStatus  SetInteger (int32_t integer); 
    
    ECOBJECTS_EXPORT int64_t        GetLong () const;
    ECOBJECTS_EXPORT BentleyStatus  SetLong (int64_t long64);
 
    ECOBJECTS_EXPORT bool           GetBoolean () const;
    ECOBJECTS_EXPORT BentleyStatus  SetBoolean (bool value);

    ECOBJECTS_EXPORT double         GetDouble () const;
    ECOBJECTS_EXPORT BentleyStatus  SetDouble (double value);  
        
    ECOBJECTS_EXPORT WCharCP        GetString () const;
    ECOBJECTS_EXPORT Utf8CP         GetUtf8CP () const;
    ECOBJECTS_EXPORT Utf16CP        GetUtf16CP () const;    // the only real caller of this should be ECDBuffer

    ECOBJECTS_EXPORT BentleyStatus  SetString (WCharCP string, bool holdADuplicate = true);
    ECOBJECTS_EXPORT BentleyStatus  SetUtf8CP (Utf8CP string, bool holdADuplicate = true);
    ECOBJECTS_EXPORT BentleyStatus  SetUtf16CP (Utf16CP string, bool holdADuplicate = true);    // primarily for use by ECDBuffer

    ECOBJECTS_EXPORT const Byte *   GetBinary (size_t& size) const;

    ECOBJECTS_EXPORT BentleyStatus  SetBinary (const Byte * data, size_t size, bool holdADuplicate = false);

    ECOBJECTS_EXPORT IGeometryPtr   GetIGeometry () const;


    ECOBJECTS_EXPORT BentleyStatus  SetIGeometry (IGeometryCR geometry);

    ECOBJECTS_EXPORT IECInstancePtr GetStruct() const;
    ECOBJECTS_EXPORT BentleyStatus  SetStruct (IECInstanceP structInstance);

    ECOBJECTS_EXPORT DateTime       GetDateTime () const;

    ECOBJECTS_EXPORT BentleyStatus  SetDateTime (DateTimeCR dateTime);

    ECOBJECTS_EXPORT int64_t        GetDateTimeTicks () const;

    ECOBJECTS_EXPORT int64_t        GetDateTimeUnixMillis() const;

    ECOBJECTS_EXPORT int64_t        GetDateTimeTicks (bool& hasMetadata, DateTime::Info& metadata) const;

    ECOBJECTS_EXPORT BentleyStatus  SetDateTimeTicks (int64_t ceTicks);

    ECOBJECTS_EXPORT BentleyStatus  SetDateTimeTicks (int64_t ceTicks, DateTime::Info const& dateTimeMetadata);

//
    ECOBJECTS_EXPORT DPoint2d       GetPoint2D() const;
    ECOBJECTS_EXPORT BentleyStatus  SetPoint2D (DPoint2dCR value);

    ECOBJECTS_EXPORT DPoint3d       GetPoint3D() const;
    ECOBJECTS_EXPORT BentleyStatus  SetPoint3D (DPoint3dCR value);

    static uint32_t                 GetFixedPrimitiveValueSize (PrimitiveType primitiveType);

    ECOBJECTS_EXPORT WString       ToString () const;
    
    ECOBJECTS_EXPORT bool           Equals (ECValueCR v) const;
    };


//=======================================================================================    
//======================================================================================= 
struct ECValueAccessor
    {
public:

    const static int INDEX_ROOT = -1;
    struct Location
        {
    private:
        ECEnablerCP             m_enabler;
        int                     m_propertyIndex;
        int                     m_arrayIndex;
        mutable ECPropertyCP    m_cachedProperty;
    public:
        Location (ECEnablerCP enabler, int propIdx, int arrayIdx) : m_enabler(enabler), m_propertyIndex(propIdx), m_arrayIndex(arrayIdx), m_cachedProperty(NULL) { }

        Location () : m_enabler(NULL), m_propertyIndex(-1), m_arrayIndex(INDEX_ROOT), m_cachedProperty(NULL) { }

        Location (const Location& loc) : m_enabler(loc.m_enabler), m_propertyIndex(loc.m_propertyIndex), m_arrayIndex(loc.m_arrayIndex), m_cachedProperty(loc.m_cachedProperty) { }
    public:
        ECEnablerCP                     GetEnabler() const          { return m_enabler; }
        int                             GetPropertyIndex() const    { return m_propertyIndex; }

        int                             GetArrayIndex() const       { return m_arrayIndex; }

        ECOBJECTS_EXPORT ECPropertyCP   GetECProperty() const;
        };

    typedef bvector<Location> LocationVector;

private:
    //"BACK" OF VECTOR IS DEEPEST ELEMENT
    LocationVector          m_locationVector;
    bool                    m_isAdhoc;
public:
    ECOBJECTS_EXPORT uint32_t               GetDepth() const;

    ECOBJECTS_EXPORT WCharCP                GetAccessString (uint32_t depth) const;

    ECOBJECTS_EXPORT WCharCP                GetAccessString () const;

    ECOBJECTS_EXPORT void  PushLocation (ECEnablerCR enabler, int propertyIndex, int arrayIndex=INDEX_ROOT);

    ECOBJECTS_EXPORT bool  PushLocation (ECEnablerCR enabler, WCharCP accessString,   int arrayIndex=INDEX_ROOT);

    ECOBJECTS_EXPORT void  PushLocation (IECInstanceCR instance, int propertyIndex, int arrayIndex=INDEX_ROOT);

    ECOBJECTS_EXPORT bool  PushLocation (IECInstanceCR instance, WCharCP accessString,   int arrayIndex=INDEX_ROOT);

    ECOBJECTS_EXPORT void       PopLocation ();

    ECOBJECTS_EXPORT Location&  DeepestLocation ();

    ECOBJECTS_EXPORT Location const&  DeepestLocationCR () const;

    ECOBJECTS_EXPORT void  Clear ();

    ECOBJECTS_EXPORT WString               GetPropertyName () const;

    ECOBJECTS_EXPORT ECValueAccessor () : m_isAdhoc (false) { }

    ECOBJECTS_EXPORT ECValueAccessor (ECValueAccessorCR accessor);

    ECOBJECTS_EXPORT WString               GetManagedAccessString () const;

    ECOBJECTS_EXPORT bool                   operator!=(ECValueAccessorCR accessor) const;

    ECOBJECTS_EXPORT bool                   operator==(ECValueAccessorCR accessor) const;

    ECOBJECTS_EXPORT static ECObjectsStatus PopulateValueAccessor (ECValueAccessor& va, IECInstanceCR instance, WCharCP managedPropertyAccessor);

    ECOBJECTS_EXPORT static ECObjectsStatus PopulateValueAccessor (ECValueAccessor& va, ECEnablerCR enabler, WCharCP managedPropertyAccessor);
    };


//=======================================================================================  
//======================================================================================= 
struct ECPropertyValue : RefCountedBase
    {
public:
    ECOBJECTS_EXPORT IECInstanceCR          GetInstance () const;

    ECOBJECTS_EXPORT ECValueCR              GetValue () const;

    ECOBJECTS_EXPORT ECValueAccessorCR      GetValueAccessor () const;
    
    ECOBJECTS_EXPORT bool                   HasChildValues () const;
    
    ECOBJECTS_EXPORT ECValuesCollectionPtr  GetChildValues () const;

    ECOBJECTS_EXPORT static ECPropertyValuePtr     GetPropertyValue (IECInstanceCR instance, WCharCP propertyAccessor);
    };

//=======================================================================================  
//======================================================================================= 
struct ECValuesCollectionIterator : RefCountedBase, std::iterator<std::forward_iterator_tag, ECPropertyValue const>
    {

public:
    ECOBJECTS_EXPORT bool               IsDifferent(ECValuesCollectionIterator const& iter) const;

    ECOBJECTS_EXPORT void               MoveToNext ();

    ECOBJECTS_EXPORT ECPropertyValue const& GetCurrent () const;
    };

//=======================================================================================    
//======================================================================================= 
struct ECValuesCollection : RefCountedBase
    {
public:
    typedef VirtualCollectionIterator<ECValuesCollectionIterator> const_iterator;
    ECOBJECTS_EXPORT const_iterator begin () const;

    ECOBJECTS_EXPORT const_iterator end ()   const;

    ECOBJECTS_EXPORT static ECValuesCollectionPtr Create (IECInstanceCR instance);

    ECOBJECTS_EXPORT static ECValuesCollectionPtr Create (ECPropertyValueCR propertyValue);

    ECOBJECTS_EXPORT ECPropertyValueCR  GetParentProperty () const;
    };

END_BENTLEY_ECOBJECT_NAMESPACE