ulxr_value.h

Go to the documentation of this file.

/***************************************************************************
                  ulxr_value.h  -  values passed by xml-rpc
                             -------------------
    begin                : Sun Mar 10 2002
    copyright            : (C) 2002-2007 by Ewald Arnold
    email                : ulxmlrpcpp@ewald-arnold.de

    $Id: ulxr_value.h 940 2006-12-30 18:22:05Z ewald-arnold $

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

/**************************************************************************
 *
 * This program 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 of the License,
 * or (at your option) any later version.
 *
 * This program 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 Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 ***************************************************************************/

#ifndef ULXR_VALUE_H
#define ULXR_VALUE_H


#include <ulxmlrpcpp/ulxmlrpcpp.h>  // always first header

#include <map>
#include <vector>


namespace ulxr {


typedef enum
{
  RpcInteger, RpcDouble,   RpcBoolean,
  RpcStrType, RpcDateTime, RpcBase64,
  RpcArray,   RpcStruct,   RpcVoid
}
ValueType;


class Void;
class Boolean;
class Integer;
class Double;
class Array;
class Struct;
class RpcString;
class Base64;
class DateTime;
class ValueBase;


class ULXR_API_DECL0 Value
{
 public:

   Value ();

   Value (const Value &val);

   Value (const Boolean &val);

   Value (const Integer &val);

   Value (const Double &val);

   Value (const Array &val);

   Value (const Struct &val);

   Value (const RpcString &val);

   Value (const Base64 &val);

   Value (const DateTime &val);

#ifdef ULXR_USE_INTRINSIC_VALUE_TYPES

   Value (const char *val);

   Value (const wchar_t *val);

   Value (const double &val);

   Value (const int &val);

   Value (const bool &val);

#endif

   virtual ~Value();

   Value &operator=(const Value &val);

   CppString getSignature(bool deep = false) const;

   virtual std::string getWbXml() const;

   CppString getXml(int indent = 0) const;

   operator Void& ();

   operator const Void& () const;

   operator Boolean& ();
   operator const Boolean& () const;

   operator Integer& ();

   operator const Integer& () const;

   operator Double& ();

   operator const Double& () const;

   operator Array& ();

   operator const Array& () const;

   operator Struct& ();

   operator const Struct& () const;

   operator RpcString& ();

   operator const RpcString& () const;

   operator Base64& ();

   operator const Base64& () const;

   operator DateTime& ();

   operator const DateTime& () const;

   Struct* getStruct();

   const Struct* getStruct() const;

   Array* getArray();

   const Array* getArray() const;

   bool isBoolean() const;

   bool isVoid() const;

   bool isInteger() const;

   bool isDouble() const;

   bool isArray() const;

   bool isStruct() const;

   bool isString() const;

   bool isBase64() const;

   bool isDateTime() const;

   ValueType getType() const;

   CppString getTypeName() const;

 private:

   union
   {
     ValueBase *baseVal;
     Void      *voidVal;

     Boolean   *boolVal;
     Integer   *intVal;
     Double    *doubleVal;
     Array     *arrayVal;
     Struct    *structVal;
     RpcString *stringVal;
     Base64    *base64Val;
     DateTime  *dateVal;
   };
};




class ULXR_API_DECL0 ValueBase
{
 public:

   ValueBase (ValueType t);

   virtual ~ValueBase ();

   bool isVoid() const;

   bool isBoolean() const;

   bool isInteger() const;

   bool isDouble() const;

   bool isArray() const;

   bool isStruct() const;

   bool isString() const;

   bool isBase64() const;

   bool isDateTime() const;

   ValueType getType() const;

   virtual ValueBase* cloneValue() const = 0;

   virtual CppString getSignature(bool deep = false) const = 0;

   virtual std::string getWbXml() const = 0;

   virtual CppString getXml(int indent = 0) const = 0;

   CppString getTypeName() const;

 private:

   ValueType type;

   ValueBase ();
};




class ULXR_API_DECL0 Void : public ValueBase
{
 public:

   Void ();

   virtual ~Void ();

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

 private:

   bool val;
};




class ULXR_API_DECL0 Boolean : public ValueBase
{
 public:

   Boolean ();

   Boolean (bool b);

   Boolean (const CppString &s);

   virtual ~Boolean ();

   bool getBoolean () const;

   void setBoolean(const bool newval);

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

 private:

   bool val;
};




class ULXR_API_DECL0 Integer : public ValueBase
{
 public:

   Integer ();

   Integer (int i);

   Integer (const CppString &s);

   virtual ~Integer ();

   int getInteger () const;

   void setInteger(const int newval);

   virtual ValueBase* cloneValue() const;

  virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

 private:

   int val;
};




class ULXR_API_DECL0 Double : public ValueBase
{
 public:

   Double ();

   Double (double d);

   Double (const CppString &s);

   virtual ~Double ();

   double getDouble () const;

   void setDouble(const double newval);

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

   static bool setScientificMode(bool scientific);
   
 private:

   double val;
   
   static bool scientific;
};




class ULXR_API_DECL0 Array : public ValueBase
{
 public:

   Array ();

   virtual ~Array ();

   void addItem(const Value &item);

   void setItem(unsigned idx, const Value &item);

   Value getItem(unsigned idx);

   unsigned size() const;

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

   void clear();

 private:

   std::vector<Value> values;
};


template<class T>
Array& operator<< (Array& array, const T& t)
{
  array.addItem(t);
  return array;
}



class ULXR_API_DECL0 Struct : public ValueBase
{
 public:

   class Member;

   Struct ();

   virtual ~Struct ();

   void addMember(const CppString &name, const Value &item);

   std::vector<CppString> getMemberNames() const;

   Value getMember(const CppString &name) const;

   bool hasMember(const CppString &name) const;

   unsigned size() const;

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

   CppString  dump_C_decl(const char *name) const;

   void clear();

  protected:

   typedef std::map<CppString, Value>  Members;

   const Members & getAllMembers() const;

 private:

   typedef std::pair<CppString, Value> Member_pair;

   Members val;
};


class ULXR_API_DECL0 Struct::Member
{
  public:

    Member(const CppString &str, const Value &val);

    const CppString &getName() const;

    const Value &getValue() const;

 private:

   CppString  str;
   Value      t;

};



#ifdef ULXR_STRUCT_MEMBER_FROM_NAME_VALUE

Struct::Member ULXR_API_DECL0 operator<< (const CppString &str, const Value &t);

#endif

Struct::Member ULXR_API_DECL0 make_member (const CppString &str, const Value &t);

Struct ULXR_API_DECL0 & operator<< (Struct &st, const Struct::Member &k);




class ULXR_API_DECL0 RpcString : public ValueBase
{
 public:

   RpcString ();

#ifdef ULXR_UNICODE

   RpcString (const Cpp16BitString &s);

#endif

   RpcString (const Cpp8BitString &s);

   virtual ~RpcString ();

#ifdef ULXR_UNICODE

   void setString(const Cpp16BitString &newval);

#endif

   void setString(const Cpp8BitString &newval);

#if (defined(HAVE_ICONV_H) || defined(HAVE_ICONV)) && !defined (ULXR_UNICODE)

   void setString(const Cpp8BitString &newval, const char *encoding);

   CppString getString (const char *encoding) const;

#endif

   CppString getString () const;

#ifdef ULXR_UNICODE

   Cpp16BitString getUnicodeString () const;

#endif

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

 private:

   CppString val;
};




class ULXR_API_DECL0 DateTime : public ValueBase
{
 public:

   DateTime ();

   DateTime (const CppString &s);

   DateTime (const ulxr_time_t &tm);

   virtual ~DateTime ();

   CppString getDateTime () const;

   void setDateTime(const CppString &newval);

   void setDateTime (const ulxr_time_t &tm,
                     bool add_dash = false,
                     bool add_colon = true);

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

 private:

   CppString val;
};




class ULXR_API_DECL0 Base64 : public ValueBase
{
 public:

   Base64 ();

   Base64 (const CppString &s);

   virtual ~Base64 ();

   CppString getString () const;

   CppString getBase64() const;

   void setBase64(const CppString s);

   void setString(const CppString &newval);

   virtual ValueBase* cloneValue() const;

   virtual CppString getSignature(bool deep = false) const;

   static CppString getValueName();

   virtual std::string getWbXml() const;

   virtual CppString getXml(int indent = 0) const;

 private:

   CppString val;
};


}  // namespace ulxr



#endif // ULXR_VALUE_H

---