resource/include/OCUtilities.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 #ifndef _INTEL_OCUTILITIES_H_
  22 #define _INTEL_OCUTILITIES_H_
  23
  24 #include <map>
  25 #include <vector>
  26 #include <memory>
  27 #include <utility>
  28 #include <exception>
  29
  30 #include <OCException.h>
  31 #include <StringConstants.h>
  32
  33 namespace OC {
  34     namespace Utilities {
  35
  36         typedef std::map<std::string, std::string> QueryParamsKeyVal;
  37         /*
  38          * @brief helper function that parses the query parameters component
  39          * of a URI into a key-value map.  This function expects the uri
  40          * parameter to contain the query parameters component of a URI
  41          * (everything after the '?', excluding anything anchors).
  42          *
  43          * Note that output will not perform URL decoding
  44          */
  45         QueryParamsKeyVal getQueryParams(const std::string& uri);
  46     }
  47 }
  48
  49 /* The C++11 standard unfortunately forgot to provide make_unique<>! However, if we're
  50 using C++14 or later, we want to take the standard library's implementation: */
  51 #if defined(__cplusplus) && __cplusplus < 201300
  52 namespace OC {
  53
  54     template<typename T, typename ...XS>
  55     std::unique_ptr<T> make_unique(XS&& ...xs)
  56     {
  57         return std::unique_ptr<T>(new T(std::forward<XS>(xs)...));
  58     }
  59
  60 } // namespace OC
  61 #else
  62     using std::make_unique;
  63 #endif
  64
  65 namespace OC {
  66
  67     using OC::make_unique;
  68
  69     /* Examine an OCStackResult, and either forward its value or raise an exception: */
  70     OCStackResult result_guard(const OCStackResult r);
  71
  72     /* Check for a nullptr, and throw an exception if we see one; otherwise, return the
  73     result of the function call: */
  74     template <typename PtrT, typename FnT, typename ...ParamTs>
  75     auto nil_guard(PtrT&& p, FnT&& fn, ParamTs&& ...params) -> OCStackResult
  76     {
  77         if(nullptr == p)
  78         {
  79             throw OCException(OC::Exception::NIL_GUARD_NULL, OC_STACK_INVALID_PARAM);
  80         }
  81
  82         // Note that although parameters are being forwarded, std::bind() will make a single copy:
  83         return std::bind(fn, p, std::forward<ParamTs>(params)...)();
  84     }
  85
  86     /* Check for nullptr and forward the result of an OC function call on success; raise
  87     an exception on failure or exceptional result: */
  88     template <typename PtrT, typename FnT, typename ...ParamTs>
  89     auto checked_guard(PtrT&& p, FnT&& fn, ParamTs&& ...params) -> OCStackResult
  90     {
  91         return result_guard(nil_guard(p, fn, std::forward<ParamTs>(params)...));
  92     }
  93
  94 } // namespace OC
  95
  96 namespace OC
  97 {
  98     template<typename T, typename = void>
  99     struct is_vector
 100     {
 101         constexpr static bool value = false;
 102     };
 103
 104     template<typename T>
 105     struct is_vector<T,
 106         typename std::enable_if<
 107             std::is_same<T, std::vector<typename T::value_type, typename T::allocator_type>>::value
 108         >::type
 109     >
 110     {
 111         constexpr static bool value = true;
 112     };
 113 } // namespace OC
 114
 115 #endif