resource/include/OCRepresentation.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   7 // Licensed under the Apache License, Version 2.0 (the "License");
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an "AS IS" BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 /**
  22  * @file
  23  *
  24  * This file contains the declaration of classes and its members related
  25  * to OCRepresentation.
  26  */
  27
  28 #ifndef OC_REPRESENTATION_H_
  29 #define OC_REPRESENTATION_H_
  30
  31
  32 #include <string>
  33 #include <sstream>
  34 #include <vector>
  35 #include <map>
  36
  37 #include <AttributeValue.h>
  38 #include <StringConstants.h>
  39
  40 #ifdef __ANDROID__
  41 #include "OCAndroid.h"
  42 #endif
  43
  44 #include <OCException.h>
  45
  46 namespace OC
  47 {
  48
  49     enum class InterfaceType
  50     {
  51         None,
  52         LinkParent,
  53         BatchParent,
  54         DefaultParent,
  55         LinkChild,
  56         BatchChild,
  57         DefaultChild
  58     };
  59
  60     class MessageContainer
  61     {
  62         public:
  63             void setPayload(const OCPayload* rep);
  64
  65             void setPayload(const OCDevicePayload* rep);
  66
  67             void setPayload(const OCPlatformPayload* rep);
  68
  69             void setPayload(const OCRepPayload* rep);
  70
  71             OCRepPayload* getPayload() const;
  72
  73             const std::vector<OCRepresentation>& representations() const;
  74
  75             void addRepresentation(const OCRepresentation& rep);
  76
  77             const OCRepresentation& operator[](int index) const
  78             {
  79                 return m_reps[index];
  80             }
  81
  82             const OCRepresentation& back() const
  83             {
  84                 return m_reps.back();
  85             }
  86         private:
  87             std::vector<OCRepresentation> m_reps;
  88     };
  89     class OCRepresentation
  90     {
  91         public:
  92             friend bool operator==(const OC::OCRepresentation&, const OC::OCRepresentation&);
  93             // Note: Implementation of all constructors and destructors
  94             // are all placed in the same location due to a crash that
  95             // was observed in Android, where merely constructing/destructing
  96             // an OCRepresentation object was enough to cause an invalid 'free'.
  97             // It is believed that this is a result of incompatible compiler
  98             // options between the gradle JNI and armeabi scons build, however
  99             // this fix will work in the meantime.
 100             OCRepresentation(): m_interfaceType(InterfaceType::None){}
 101
 102             OCRepresentation(OCRepresentation&&) = default;
 103
 104             OCRepresentation(const OCRepresentation&) = default;
 105
 106             OCRepresentation& operator=(const OCRepresentation&) = default;
 107
 108             OCRepresentation& operator=(OCRepresentation&&) = default;
 109
 110             virtual ~OCRepresentation(){}
 111
 112             void setDevAddr(const OCDevAddr addr);
 113
 114             const std::string getHost() const;
 115
 116             OCRepPayload* getPayload() const;
 117
 118             void addChild(const OCRepresentation&);
 119
 120             void clearChildren();
 121
 122             const std::vector<OCRepresentation>& getChildren() const;
 123
 124             void setChildren(const std::vector<OCRepresentation>& children);
 125
 126             void setUri(const char* uri);
 127
 128             void setUri(const std::string& uri);
 129
 130             std::string getUri() const;
 131
 132             const std::vector<std::string>& getResourceTypes() const;
 133
 134             void setResourceTypes(const std::vector<std::string>& resourceTypes);
 135
 136             void addResourceType(const std::string& str);
 137
 138             const std::vector<std::string>& getResourceInterfaces() const;
 139
 140             void setResourceInterfaces(const std::vector<std::string>& resourceInterfaces);
 141
 142             void addResourceInterface(const std::string& str);
 143
 144             bool emptyData() const;
 145
 146             int numberOfAttributes() const;
 147
 148             bool erase(const std::string& str);
 149
 150             template <typename T>
 151             void setValue(const std::string& str, const T& val)
 152             {
 153                 m_values[str] = val;
 154             }
 155
 156             // using R-value(or universal ref depending) to move string and vector<uint8_t>
 157             template <typename T>
 158             void setValue(const std::string& str, T&& val)
 159             {
 160                 m_values[str] = std::forward<T>(val);
 161             }
 162
 163             const std::map<std::string, AttributeValue>& getValues() const {
 164                 return m_values;
 165             }
 166
 167             /**
 168              *  Retrieve the attribute value associated with the supplied name
 169              *
 170              *  @param str Name of the attribute
 171              *  @param val Value of the attribute
 172              *  @return The getValue method returns true if the attribute was
 173              *        found in the representation.  Otherwise it returns false.
 174              */
 175             template <typename T>
 176             bool getValue(const std::string& str, T& val) const
 177             {
 178                 auto x = m_values.find(str);
 179
 180                 if(x!= m_values.end())
 181                 {
 182                     try
 183                     {
 184                         val = boost::get<T>(x->second);
 185                         return true;
 186                     }
 187                     catch (boost::bad_get& e)
 188                     {
 189                         val = T();
 190                         return false;
 191                     }
 192                 }
 193                 else
 194                 {
 195                     val = T();
 196                     return false;
 197                 }
 198             }
 199
 200             /**
 201              *  Return the attribute value associated with the supplied name
 202              *
 203              *  @param str Name of the attribute
 204              *  @return When the representation contains the attribute, the
 205              *       the associated value is returned.  Otherwise, getValue
 206              *       returns the default contructed value for the type.
 207              */
 208             template <typename T>
 209             T getValue(const std::string& str) const
 210             {
 211                 T val = T();
 212                 auto x = m_values.find(str);
 213                 if(x != m_values.end())
 214                 {
 215                     try
 216                     {
 217                         val = boost::get<T>(x->second);
 218                     }
 219                     catch (boost::bad_get& e)
 220                     {
 221                         return val;
 222                     }
 223                 }
 224                 return val;
 225             }
 226
 227            /**
 228             *  Retrieve the attributevalue structure associated with the supplied name
 229             *
 230             *  @param str Name of the attribute
 231             *  @param attrValue Attribute Value structure
 232             *  @return The getAttributeValue method returns true if the attribute was
 233             *        found in the representation.  Otherwise it returns false.
 234             */
 235             bool getAttributeValue(const std::string& str, AttributeValue& attrValue) const
 236             {
 237                 auto x = m_values.find(str);
 238
 239                 if (x != m_values.end())
 240                 {
 241                     attrValue = x->second;
 242                     return true;
 243                 }
 244                 else
 245                 {
 246                     return false;
 247                 }
 248             }
 249
 250             std::string getValueToString(const std::string& key) const;
 251             bool hasAttribute(const std::string& str) const;
 252
 253             void setNULL(const std::string& str);
 254
 255             bool isNULL(const std::string& str) const;
 256
 257         private:
 258             std::string m_host;
 259
 260             // STL Container stuff
 261         public:
 262             class iterator;
 263             class const_iterator;
 264             // Shim class to allow iterating and indexing of the OCRepresentation
 265             // object.
 266             class AttributeItem
 267             {
 268                 friend class OCRepresentation;
 269                 friend class iterator;
 270                 friend class const_iterator;
 271                 public:
 272                     const std::string& attrname() const;
 273                     AttributeType type() const;
 274                     AttributeType base_type() const;
 275                     size_t depth() const;
 276                     template<typename T>
 277                     T getValue() const
 278                     {
 279                         try
 280                         {
 281                             return boost::get<T>(m_values[m_attrName]);
 282                         }
 283                         catch (boost::bad_get& e)
 284                         {
 285                             T val = T();
 286                             return val;
 287                         }
 288                     }
 289
 290                     std::string getValueToString() const;
 291
 292                     template<typename T>
 293                     AttributeItem& operator=(T&& rhs)
 294                     {
 295                         m_values[m_attrName] = std::forward<T>(rhs);
 296                         return *this;
 297                     }
 298
 299                     AttributeItem& operator=(std::nullptr_t /*rhs*/)
 300                     {
 301                         NullType t;
 302                         m_values[m_attrName] = t;
 303                         return *this;
 304                     }
 305
 306                     // Enable-if required to prevent conversions to alternate types.  This prevents
 307                     // ambigious conversions in the case where conversions can include a number of
 308                     // types, such as the string constructor.
 309                     template<typename T, typename std::enable_if<
 310                         is_component<T,
 311                             remove_first<AttributeValue>::type
 312                             >::value
 313                         , int>::type = 0
 314                     >
 315                     operator T() const
 316                     {
 317                         return this->getValue<T>();
 318                     }
 319
 320                     template<typename T, typename std::enable_if<
 321                         std::is_same<T, std::nullptr_t>::value
 322                         , int>::type = 0
 323                     >
 324                     operator T() const
 325                     {
 326                         this->getValue<NullType>();
 327                         return nullptr;
 328                     }
 329
 330                 private:
 331                     AttributeItem(const std::string& name,
 332                             std::map<std::string, AttributeValue>& vals);
 333                     AttributeItem(const AttributeItem&) = default;
 334                     std::string m_attrName;
 335                     std::map<std::string, AttributeValue>& m_values;
 336             };
 337
 338             // Iterator to allow iteration via STL containers/methods
 339             class iterator
 340             {
 341                 friend class OCRepresentation;
 342                 public:
 343                     typedef iterator self_type;
 344                     typedef AttributeItem value_type;
 345                     typedef value_type& reference;
 346                     typedef value_type* pointer;
 347                     typedef std::forward_iterator_tag iterator_category;
 348                     typedef int difference_type;
 349
 350                     iterator(const iterator&) = default;
 351                     ~iterator() = default;
 352
 353                     bool operator ==(const iterator&) const;
 354                     bool operator !=(const iterator&) const;
 355
 356                     iterator& operator++();
 357                     iterator operator++(int);
 358
 359                     reference operator*();
 360                     pointer operator->();
 361                 private:
 362                     iterator(std::map<std::string, AttributeValue>::iterator&& itr,
 363                             std::map<std::string, AttributeValue>& vals)
 364                         : m_iterator(std::move(itr)),
 365                         m_item(m_iterator != vals.end() ? m_iterator->first:"", vals){}
 366                     std::map<std::string, AttributeValue>::iterator m_iterator;
 367                     AttributeItem m_item;
 368             };
 369
 370             class const_iterator
 371             {
 372                 friend class OCRepresentation;
 373                 public:
 374                     typedef iterator self_type;
 375                     typedef const AttributeItem value_type;
 376                     typedef value_type& const_reference;
 377                     typedef value_type* const_pointer;
 378                     typedef std::forward_iterator_tag iterator_category;
 379                     typedef int difference_type;
 380
 381                     const_iterator(const iterator& rhs)
 382                         :m_iterator(rhs.m_iterator), m_item(rhs.m_item){}
 383                     const_iterator(const const_iterator&) = default;
 384                     ~const_iterator() = default;
 385
 386                     bool operator ==(const const_iterator&) const;
 387                     bool operator !=(const const_iterator&) const;
 388
 389                     const_iterator& operator++();
 390                     const_iterator operator++(int);
 391
 392                     const_reference operator*() const;
 393                     const_pointer operator->() const;
 394                 private:
 395                     const_iterator(std::map<std::string, AttributeValue>::const_iterator&& itr,
 396                             std::map<std::string, AttributeValue>& vals)
 397                         : m_iterator(std::move(itr)),
 398                         m_item(m_iterator != vals.end() ? m_iterator->first: "", vals){}
 399                     std::map<std::string, AttributeValue>::const_iterator m_iterator;
 400                     AttributeItem m_item;
 401             };
 402
 403             iterator begin();
 404             const_iterator begin() const;
 405             const_iterator cbegin() const;
 406             iterator end();
 407             const_iterator end() const;
 408             const_iterator cend() const;
 409             size_t size() const;
 410             bool empty() const;
 411
 412             AttributeItem operator[](const std::string& key);
 413             const AttributeItem operator[](const std::string& key) const;
 414         private:
 415             friend class OCResourceResponse;
 416             friend class MessageContainer;
 417
 418             template<typename T>
 419             void payload_array_helper(const OCRepPayloadValue* pl, size_t depth);
 420             template<typename T>
 421             T payload_array_helper_copy(size_t index, const OCRepPayloadValue* pl);
 422             void setPayload(const OCRepPayload* payload);
 423             void setPayloadArray(const OCRepPayloadValue* pl);
 424             void getPayloadArray(OCRepPayload* payload,
 425                     const OCRepresentation::AttributeItem& item) const;
 426             // the root node has a slightly different JSON version
 427             // based on the interface type configured in ResourceResponse.
 428             // This allows ResourceResponse to set it, so that the save function
 429             // doesn't serialize things that it isn't supposed to serialize.
 430             void setInterfaceType(InterfaceType ift)
 431             {
 432                 m_interfaceType = ift;
 433             }
 434
 435             // class used to wrap the 'prop' feature of the save/load
 436             class Prop
 437             {
 438                 public:
 439                     Prop(std::vector<std::string>& resourceTypes,
 440                             std::vector<std::string>& interfaces)
 441                     : m_types(resourceTypes), m_interfaces(interfaces)
 442                     {}
 443
 444                  /*   Prop(const std::vector<std::string>& resourceTypes,
 445                             const std::vector<std::string>& interfaces)
 446                     :m_types(resourceTypes),
 447                     m_interfaces(interfaces)
 448                     {}*/
 449                 private:
 450                     std::vector<std::string>& m_types;
 451                     std::vector<std::string>& m_interfaces;
 452             };
 453         private:
 454             std::string m_uri;
 455             std::vector<OCRepresentation> m_children;
 456             mutable std::map<std::string, AttributeValue> m_values;
 457             std::vector<std::string> m_resourceTypes;
 458             std::vector<std::string> m_interfaces;
 459
 460             InterfaceType m_interfaceType;
 461     };
 462
 463     std::ostream& operator <<(std::ostream& os, const OCRepresentation::AttributeItem& ai);
 464 } // namespace OC
 465
 466
 467 #endif // OC_REPRESENTATION_H_
 468