src/third_party/libjingle/source/talk/base/json.h

   1 /*
   2  * libjingle
   3  * Copyright 2004--2005, Google Inc.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *  1. Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *  2. Redistributions in binary form must reproduce the above copyright notice,
  11  *     this list of conditions and the following disclaimer in the documentation
  12  *     and/or other materials provided with the distribution.
  13  *  3. The name of the author may not be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef TALK_BASE_JSON_H_
  29 #define TALK_BASE_JSON_H_
  30
  31 #include <string>
  32 #include <vector>
  33
  34 #ifdef JSONCPP_RELATIVE_PATH
  35 #include "json/json.h"
  36 #else
  37 #include "third_party/jsoncpp/json.h"
  38 #endif
  39
  40 // TODO: Move to talk_base namespace
  41
  42 ///////////////////////////////////////////////////////////////////////////////
  43 // JSON Helpers
  44 ///////////////////////////////////////////////////////////////////////////////
  45
  46 // Robust conversion operators, better than the ones in JsonCpp.
  47 bool GetIntFromJson(const Json::Value& in, int* out);
  48 bool GetUIntFromJson(const Json::Value& in, unsigned int* out);
  49 bool GetStringFromJson(const Json::Value& in, std::string* out);
  50 bool GetBoolFromJson(const Json::Value& in, bool* out);
  51 bool GetDoubleFromJson(const Json::Value& in, double* out);
  52
  53 // Pull values out of a JSON array.
  54 bool GetValueFromJsonArray(const Json::Value& in, size_t n,
  55                            Json::Value* out);
  56 bool GetIntFromJsonArray(const Json::Value& in, size_t n,
  57                          int* out);
  58 bool GetUIntFromJsonArray(const Json::Value& in, size_t n,
  59                           unsigned int* out);
  60 bool GetStringFromJsonArray(const Json::Value& in, size_t n,
  61                             std::string* out);
  62 bool GetBoolFromJsonArray(const Json::Value& in, size_t n,
  63                           bool* out);
  64 bool GetDoubleFromJsonArray(const Json::Value& in, size_t n,
  65                             double* out);
  66
  67 // Convert json arrays to std::vector
  68 bool JsonArrayToValueVector(const Json::Value& in,
  69                             std::vector<Json::Value>* out);
  70 bool JsonArrayToIntVector(const Json::Value& in,
  71                           std::vector<int>* out);
  72 bool JsonArrayToUIntVector(const Json::Value& in,
  73                            std::vector<unsigned int>* out);
  74 bool JsonArrayToStringVector(const Json::Value& in,
  75                              std::vector<std::string>* out);
  76 bool JsonArrayToBoolVector(const Json::Value& in,
  77                            std::vector<bool>* out);
  78 bool JsonArrayToDoubleVector(const Json::Value& in,
  79                              std::vector<double>* out);
  80
  81 // Convert std::vector to json array
  82 Json::Value ValueVectorToJsonArray(const std::vector<Json::Value>& in);
  83 Json::Value IntVectorToJsonArray(const std::vector<int>& in);
  84 Json::Value UIntVectorToJsonArray(const std::vector<unsigned int>& in);
  85 Json::Value StringVectorToJsonArray(const std::vector<std::string>& in);
  86 Json::Value BoolVectorToJsonArray(const std::vector<bool>& in);
  87 Json::Value DoubleVectorToJsonArray(const std::vector<double>& in);
  88
  89 // Pull values out of a JSON object.
  90 bool GetValueFromJsonObject(const Json::Value& in, const std::string& k,
  91                             Json::Value* out);
  92 bool GetIntFromJsonObject(const Json::Value& in, const std::string& k,
  93                           int* out);
  94 bool GetUIntFromJsonObject(const Json::Value& in, const std::string& k,
  95                            unsigned int* out);
  96 bool GetStringFromJsonObject(const Json::Value& in, const std::string& k,
  97                              std::string* out);
  98 bool GetBoolFromJsonObject(const Json::Value& in, const std::string& k,
  99                            bool* out);
 100 bool GetDoubleFromJsonObject(const Json::Value& in, const std::string& k,
 101                              double* out);
 102
 103 // Writes out a Json value as a string.
 104 std::string JsonValueToString(const Json::Value& json);
 105
 106 #endif  // TALK_BASE_JSON_H_