Variable.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * libhomegear-base 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 3 of the
 * License, or (at your option) any later version.
 *
 * libhomegear-base 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 libhomegear-base.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef VARIABLE_H_
#define VARIABLE_H_

#include "Encoding/RapidXml/rapidxml.h"
#include "DeviceDescription/Logical.h"
#include "DeviceDescription/Physical.h"

#include <vector>
#include <string>
#include <memory>
#include <map>
#include <list>
#include <cmath>

using namespace rapidxml;

namespace BaseLib {

enum class VariableType {
  tVoid = 0x00,
  tInteger = 0x01,
  tBoolean = 0x02,
  tString = 0x03,
  tFloat = 0x04,
  tArray = 0x100,
  tStruct = 0x101,
  //rpcDate = 0x10,
  tBase64 = 0x11,
  tBinary = 0xD0,
  tInteger64 = 0xD1,
  tVariant = 0x1111,
};

class Variable;

typedef std::shared_ptr<Variable> PVariable;
typedef std::shared_ptr<PVariable> PPVariable;
typedef std::pair<std::string, PVariable> StructElement;
typedef std::map<std::string, PVariable> Struct;
typedef std::shared_ptr<std::map<std::string, PVariable>> PStruct;
typedef std::vector<PVariable> Array;
typedef std::shared_ptr<Array> PArray;
typedef std::list<PVariable> List;
typedef std::shared_ptr<List> PList;

class Variable {
 private:
  typedef void (Variable::*bool_type)() const;

  void this_type_does_not_support_comparisons() const {}
  std::string print(PVariable variable, std::string indent, bool ignoreIndentOnFirstLine, bool oneLine);
  std::string printStruct(PStruct rpcStruct, std::string indent, bool ignoreIndentOnFirstLine, bool oneLine);
  std::string printArray(PArray rpcArray, std::string indent, bool ignoreIndentOnFirstLine, bool oneLine);

  void parseXmlNode(const xml_node *node, PStruct &xmlStruct);
 public:
  bool errorStruct = false;
  VariableType type;
  std::string stringValue;
  int32_t integerValue = 0;
  int64_t integerValue64 = 0;
  double floatValue = 0;
  bool booleanValue = false;
  PArray arrayValue;
  PStruct structValue;
  std::vector<uint8_t> binaryValue;

  Variable();
  Variable(Variable const &rhs);
  explicit Variable(VariableType variableType);
  explicit Variable(uint8_t integer);
  explicit Variable(int32_t integer);
  explicit Variable(uint32_t integer);
  explicit Variable(int64_t integer);
  explicit Variable(uint64_t integer);
  explicit Variable(const std::string &string);
  explicit Variable(const char *string);
  explicit Variable(bool boolean);
  explicit Variable(double floatVal);
  explicit Variable(const PArray &arrayVal);
  explicit Variable(const std::vector<std::string> &arrayVal);
  explicit Variable(const PStruct &structVal);
  explicit Variable(const std::vector<uint8_t> &binaryVal);
  explicit Variable(const uint8_t *binaryVal, size_t binaryValSize);
  explicit Variable(const std::vector<char> &binaryVal);
  explicit Variable(const char *binaryVal, size_t binaryValSize);

  explicit Variable(DeviceDescription::ILogical::Type::Enum variableType);
  explicit Variable(const xml_node *node);
  virtual ~Variable();
  static PVariable createError(int32_t faultCode, const std::string& faultString, bool retry = false);
  std::string print(bool stdout = false, bool stderr = false, bool oneLine = false);
  void trimStrings();
  static std::string getTypeString(VariableType type);
  void setType(VariableType value) { type = value; };
  void setType(DeviceDescription::ILogical::Type::Enum value);
  static PVariable fromString(std::string &value, DeviceDescription::ILogical::Type::Enum type);
  static PVariable fromString(std::string &value, DeviceDescription::IPhysical::Type::Enum type);
  static PVariable fromString(std::string &value, VariableType type);
  std::string toString();
  Variable &operator=(const Variable &rhs);
  bool operator==(const Variable &rhs);
  bool operator<(const Variable &rhs);
  bool operator<=(const Variable &rhs);
  bool operator>(const Variable &rhs);
  bool operator>=(const Variable &rhs);
  bool operator!=(const Variable &rhs);
  operator bool_type() const;
};

}

#endif