dali-toolkit/devel-api/builder/base64-encoding.h

   1 #ifndef DALI_TOOLKIT_BASE64_ENCODING_H
   2 #define DALI_TOOLKIT_BASE64_ENCODING_H
   3
   4 /*
   5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/property.h>
  23 #include <dali/public-api/common/vector-wrapper.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 /**
  32  * @brief Parses a Property::STRING or Property::ARRAY of STRINGS to
  33  * retrieve a block of uint32_t data.
  34  *
  35  * Data can be encoded using the base64 encoding scheme to allow it to be used
  36  * in JSON (The property system maps to JSON types).
  37  *
  38  * @param[in] value The property value to decode
  39  * @param[out] outputData The output data block
  40  * @return True if a data block was decoded successfully.
  41  */
  42 bool DecodeBase64PropertyData( const Property::Value& value, std::vector<uint32_t>& outputData );
  43
  44 /**
  45  * @brief Convert a block of uint32_t data into a Property::STRING or ARRAY of STRINGs
  46  * encoded using base64. This allows the data to be mapped to JSON easily.
  47  *
  48  * @param[out] value The value to write data into (to avoid copying).
  49  * @param[in] inputData The input
  50  */
  51 void EncodeBase64PropertyData( Property::Value& value, const std::vector<uint32_t>& inputData );
  52
  53 } // namespace Toolkit
  54
  55 } // namespace Dali
  56
  57
  58 #endif // DALI_TOOLKIT_BASE64_ENCODING_H