Any.hxx

Go to the documentation of this file.

// Copyright (C) 2006-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef __YACSANY_HXX__
#define __YACSANY_HXX__
 
#include "YACSlibEngineExport.hxx"
#include "RefCounter.hxx"
#include "Exception.hxx"
#include "SharedPtr.hxx"
 
#include <vector>
 
namespace YACS
{
  namespace ENGINE
  {
    class Any;
    class AtomAny;
    class TypeCode;
    class SeqAlloc;
    class ArrayAny;
    class StructAny;
    class SequenceAny;
    class TypeCodeArray;
    class TypeCodeStruct;
    typedef void (*Deallocator)(void *);
 
#ifndef SWIG
    YACSLIBENGINE_EXPORT std::string ToBase64(const std::string& bytes);
    YACSLIBENGINE_EXPORT std::string FromBase64(const std::string& bytes);
    YACSLIBENGINE_EXPORT std::string FromBase64Safe(const std::string& bytes);
#endif
    
    class YACSLIBENGINE_EXPORT StringOnHeap
    {
      friend class Any;
      friend class AtomAny;
      friend class ArrayAny;
    private:
      StringOnHeap(const char *val);
      StringOnHeap(const char *val, std::size_t len);
      StringOnHeap(const std::string& val);
      StringOnHeap(char *val, Deallocator deAlloc);
      bool operator ==(const StringOnHeap& other) const;
      StringOnHeap *deepCopy() const;
      const char *cStr() const { return _str; }
      std::size_t size() const { return _len; }
      ~StringOnHeap();
    private:
      char *_str;
      std::size_t _len;
      Deallocator _dealloc;
    };
 
    typedef SharedPtr<Any> AnyPtr;
    
    class YACSLIBENGINE_EXPORT Any : public RefCounter
    {
      friend class SeqAlloc;
      friend class ArrayAny;
      friend class StructAny;
      friend class SequenceAny;
    public:
      const TypeCode *getType() const { return _type; }
      //for convenience methods
      virtual Any *clone() const = 0;
      virtual AnyPtr operator[](int i) const = 0;
      virtual AnyPtr operator[](const char *key) const = 0;
      virtual bool operator ==(const Any& other) const = 0;
      virtual int getIntValue() const = 0;
      virtual bool getBoolValue() const = 0;
      virtual double getDoubleValue() const = 0;
      virtual std::string getStringValue() const = 0;
      //
    protected:
#ifndef SWIG
      virtual ~Any();
#endif
      Any(TypeCode* type);
      Any(const Any& other);
      virtual void putMyReprAtPlace(char *data) const = 0;
      //static AnyPtr buildAnyFromCoarseData(char *data, TypeCode* type); //Factory Method
      static bool IsNull(char *data);
    protected:
      TypeCode* _type;
    };
 
    typedef SharedPtr<AtomAny> AtomAnyPtr;
 
    class YACSLIBENGINE_EXPORT AtomAny : public Any
    {
      friend class TypeCode;
      friend class TypeCodeObjref;
 
      union ValueContainer
      {
        int _i;
        bool _b;
        double _d;
        StringOnHeap *_s;
      };
    public:
      Any *clone() const;
      template<class T>
      static AtomAny *New(T val) { return new AtomAny(val); }
      static AtomAny *New(char *val, Deallocator dealloc);
      static AtomAny *New(const std::string& val, TypeCode *type);
      AnyPtr operator[](int i) const;
      AnyPtr operator[](const char *key) const;
      bool operator ==(const Any& other) const;
      int getIntValue() const;
      bool getBoolValue() const;
      double getDoubleValue() const;
      std::string getStringValue() const;
      const char *getBytesValue(std::size_t& len) const;
    protected:
      void putMyReprAtPlace(char *data) const;
      static void putReprAtPlace(char *data, const char *src, const TypeCode *type, bool deepCpy);
      static void destroyReprAtPlace(char *data, const TypeCode *type);
      static AnyPtr getOrBuildFromData(char *data, const TypeCode *type);
      static bool takeInChargeStorageOf(TypeCode *type);
    private:
      ~AtomAny();
      AtomAny(int val);
      AtomAny(bool val);
      AtomAny(double val);
      AtomAny(const char *val);
      AtomAny(const std::string& val);
      AtomAny(const std::string& val, TypeCode* type);
      AtomAny(const AtomAny& other);
      AtomAny(char *data, TypeCode* type);
      AtomAny(char *val, Deallocator deAlloc);
    protected:
      ValueContainer _value;
    };
    
    class YACSLIBENGINE_EXPORT SeqAlloc 
    {
      friend class SequenceAny;
      
      char *_start;
      char *_finish;
      char *_endOfStorage;
      Deallocator _notStdDeAlloc;
      const unsigned int _sizeOf1Elm;
    private:
      SeqAlloc(const SeqAlloc& other);
      SeqAlloc(unsigned int sizeOf1Elm);
      ~SeqAlloc();
      void clear();
      void initCoarseMemory(char *mem, unsigned int size, Deallocator dealloc);
      void construct(char *pt, const Any *val);
      void construct(char *pt, const char *val, const TypeCode *tc, bool deepCpy);
      char *allocate(unsigned int nbOfByte);
      void destroy(char *pt, const TypeCode *tc);
      void deallocate(char *pt);
      unsigned int size() const;
      std::vector<unsigned int> getSetItems() const;
    public:
      static const char DFT_CHAR_VAR;
    };
    
    class YACSLIBENGINE_EXPORT ComposedAny : public Any
    {
    public:
      virtual void setEltAtRank(int i, const Any *elem) = 0;
      AnyPtr operator[](const char *key) const;
    protected:
      ComposedAny(const ComposedAny& other);
      ComposedAny(TypeCode* type, bool isNew=true);
    protected:
      void checkTypeOf(const Any *elem) const;
    private://error methods called during incorrect runtime extraction
      int getIntValue() const;
      bool getBoolValue() const;
      double getDoubleValue() const;
      std::string getStringValue() const;
    };
 
    typedef SharedPtr<SequenceAny> SequenceAnyPtr;
    
    class YACSLIBENGINE_EXPORT SequenceAny : public ComposedAny
    {
      friend class TypeCodeSeq;
    public:
      void clear();
      void popBack();
      unsigned int size() const { return _alloc.size(); }
      void pushBack(const Any *elem);
      bool operator ==(const Any& other) const;
      void setEltAtRank(int i, const Any *elem);
      AnyPtr operator[](int i) const;
      Any *clone() const;
      template<class T>
      static SequenceAny *New(const std::vector<T>& vec);
      static SequenceAny *New(const TypeCode *typeOfContent);
      static SequenceAny *New(const TypeCode *typeOfContent, unsigned lgth);
      template<class T>
      static SequenceAny *New(T *val, unsigned int lgth, Deallocator deAlloc);
      std::vector<unsigned int> getSetItems() const { return _alloc.getSetItems(); }
      SequenceAny *removeUnsetItemsFromThis() const;
    protected:
      void putMyReprAtPlace(char *data) const;
      static void putReprAtPlace(char *data, const char *src, const TypeCode *type, bool deepCpy);
      static void destroyReprAtPlace(char *data, const TypeCode *type);
      static AnyPtr getOrBuildFromData(char *data, const TypeCode *type);
      static bool takeInChargeStorageOf(TypeCode *type);
    private:
      ~SequenceAny();
      SequenceAny(const SequenceAny& other);
      SequenceAny(const TypeCode *typeOfContent);
      SequenceAny(const TypeCode *typeOfContent, unsigned lgth);
      SequenceAny(int *val, unsigned int lgth, Deallocator deAlloc);
      SequenceAny(bool *val, unsigned int lgth, Deallocator deAlloc);
      SequenceAny(double *val, unsigned int lgth, Deallocator deAlloc);
      SequenceAny(const std::vector<int>& val);
      SequenceAny(const std::vector<bool>& val);
      SequenceAny(const std::vector<double>& val);
      SequenceAny(const std::vector<std::string>& val);
      void realloc(char *endOfCurrentAllocated, const Any *elem);
      char *performCpy(char *srcStart, char *srcFinish, char *destStart);
    protected:
      SeqAlloc _alloc;
    };
    
    typedef SharedPtr<ArrayAny> ArrayAnyPtr;
 
    class YACSLIBENGINE_EXPORT ArrayAny : public ComposedAny
    {
      friend class TypeCodeArray;
    public:
      void setEltAtRank(int i, const Any *elem);
      bool operator ==(const Any& other) const;
      AnyPtr operator[](int i) const;
      unsigned int size() const;
      Any *clone() const;
      template<class T>
      static ArrayAny *New(const std::vector<T>& vec);
      template<class T>
      static ArrayAny *New(const T *val, unsigned int lgth);
      static ArrayAny *New(const TypeCode *typeOfContent, unsigned int lgth);
    protected:
      void putMyReprAtPlace(char *data) const;
      static void putReprAtPlace(char *data, const char *src, const TypeCodeArray *type, bool deepCpy);
      static void destroyReprAtPlace(char *data, const TypeCodeArray *type);
      static AnyPtr getOrBuildFromData(char *data, const TypeCodeArray *type);
      static bool takeInChargeStorageOf(TypeCode *type);
    private:
      ~ArrayAny();
      ArrayAny(const TypeCode *typeOfContent, unsigned int lgth);
      ArrayAny(char *data, TypeCodeArray * type);
      ArrayAny(const ArrayAny& other);
      ArrayAny(const int *val, unsigned int lgth);
      ArrayAny(const bool *val, unsigned int lgth);
      ArrayAny(const double *val, unsigned int lgth);
      ArrayAny(const std::vector<int>& val);
      ArrayAny(const std::vector<double>& val);
      ArrayAny(const std::vector<std::string>& val);
    protected:
      char *_data;
    };
 
    typedef SharedPtr<StructAny> StructAnyPtr;
 
    class YACSLIBENGINE_EXPORT StructAny : public ComposedAny
    {
      friend class TypeCodeStruct;
    public:
      Any *clone() const;
      bool operator ==(const Any& other) const;
      static StructAny *New(TypeCodeStruct *type);
      AnyPtr operator[](int i) const;
      AnyPtr operator[](const char *key) const;
      void setEltAtRank(int i, const Any *elem);
      void setEltAtRank(const char *key, const Any *elem);
    protected:
      void putMyReprAtPlace(char *data) const;
      static void putReprAtPlace(char *data, const char *src, const TypeCodeStruct *type, bool deepCpy);
      static void destroyReprAtPlace(char *data, const TypeCodeStruct *type);
      static AnyPtr getOrBuildFromData(char *data, const TypeCodeStruct *type);
    private:
      ~StructAny();
      StructAny(TypeCodeStruct *type);
      StructAny(const StructAny& other);
      StructAny(char *data, TypeCodeStruct * type);
    private:
      char *_data;
    };
 
    template<class T>
    SequenceAny *SequenceAny::New(T *val, unsigned int lgth, Deallocator deAlloc)
    {
      return new SequenceAny(val,lgth,deAlloc);
    }
 
    template<class T>
    SequenceAny *SequenceAny::New(const std::vector<T>& vec)
    {
      return new SequenceAny(vec);
    }
 
    template<class T>
    ArrayAny *ArrayAny::New(const std::vector<T>& vec)
    {
      return new ArrayAny(vec);
    }
 
    template<class T>
    ArrayAny *ArrayAny::New(const T *val, unsigned int lgth)
    {
      return new ArrayAny(val,lgth);
    }
  }
}
 
#endif