json.h

Go to the documentation of this file.

// Copyright (C) 2013-2020 iFunFactory Inc. All Rights Reserved.
//
// This work is confidential and proprietary to iFunFactory Inc. and
// must not be used, disclosed, copied, or distributed without the prior
// consent of iFunFactory Inc.

#ifndef INCLUDE_FUNAPI_COMMON_JSON_H_
#define INCLUDE_FUNAPI_COMMON_JSON_H_

#include <funapi/types.h>
#pragma GCC diagnostic ignored "-Wtype-limits"
#include <rapidjson/document.h>
#pragma GCC diagnostic warning "-Wtype-limits"


namespace fun {

typedef rapidjson::GenericValue<
    rapidjson::UTF8<char>, rapidjson::CrtAllocator> JsonValueImpl;


class Buffer;


class FUNAPI_DLL_VISIBILITY Json : private JsonValueImpl {
 public:
  DECLARE_CLASS_PTR(Json);

  class FUNAPI_DLL_VISIBILITY Attribute : private Member {
   public:
     string GetName() const;
     const Json &GetValue() const;
     Json &GetValue();
   private:
     Attribute();
  };

  typedef Attribute * AttributeIterator;
  typedef const Attribute * ConstAttributeIterator;

  typedef Json * ValueIterator;
  typedef const Json * ConstValueIterator;

  typedef boost::function<void(const string & /*json_string*/,
                               const string & /*error_desc*/,
                               size_t /*error_offset*/)> ParseErrorCallback;

  enum Type {
    kNull = 0,
    kBoolean,
    kInteger,
    kDouble,
    kString,
    kArray,
    kObject
  };

  // Parse option for JSON parser. Can be bit-wise ORed.
  // JSON 파서를 위한 옵션. bit 단위 OR 연산자로 처리 가능
  // For example,
  //   // Discard comments; 주석을 무시하면서 읽기
  //   fun::Json document;
  //   document.FromString(some_json_str, fun::Json::kAllowComment);
  //   // Discard UTF-8 BOM; UTF-8 BOM을 무시하고 읽기
  //   document.FromString(some_json_str, fun::Json::kAllowUtf8Bom);
  //   // Discard comments and UTF-8 BOM
  //   // 주석과 UTF-8 BOM을 무시하면서 읽기
  //   document.FromString(some_json_str,
  //                       fun::Json::kAllowUtf8Bom | fun::json::kAllowComment);
  enum ParserFlag {
    kNone = 0,
    kAllowComment = 1,  // allow single line or multi-line comments in JSON
    kAllowUtf8Bom = 2,  // allow byte order mark in JSON
  };

  static const ParseErrorCallback kDefaultParseErrorHandler;

  // constructor
  Json();
  explicit Json(bool value);
  explicit Json(int value);
  explicit Json(int64_t value);
  explicit Json(double value);
  explicit Json(const char *value);
  explicit Json(const string &value);
  Json(const Json &other);
  Json(Json &&other);

  ~Json();

  void Copy(Json *to) const;
  Json Copy() const;
  void Move(Json *to);

  // read/write from/to string, file, stream
  bool FromString(const string &json_string,
                  const ParseErrorCallback &cb = NULL);
  bool FromString(const string &json_string,
                  int parser_flag,  // see ParserFlag
                  const ParseErrorCallback &cb = NULL);
  bool FromStringInsitu(string *json_string,
                        const ParseErrorCallback &cb = NULL);
  // Deprecated. Please use FromString(..., kAllowComment)
  DEPRECATED(
  bool FromStringWithComments(const string &json_string,
                              const ParseErrorCallback &cb = NULL));
  bool FromString(const char *json_string,
                  const ParseErrorCallback &cb = NULL);
  bool FromStringInsitu(char *json_string,
                        const ParseErrorCallback &cb = NULL);
  bool FromString(const char *json_string,
                  size_t len,
                  const ParseErrorCallback &cb = NULL);
  bool FromStringInsitu(char *json_string,
                        size_t len,
                        const ParseErrorCallback &cb = NULL);
  bool FromFile(const string &file_path,
                const ParseErrorCallback &cb = NULL);
  bool FromFileWithComments(const string &file_path,
                            const ParseErrorCallback &cb = NULL);
  // NOLINT(runtime/references)
  bool FromStream(std::istream &input_stream,
                  const ParseErrorCallback &cb = NULL);
  // Deprecated. Please use FromStream(..., kAllowComment)
  // NOLINT(runtime/references)
  DEPRECATED(
  bool FromStreamWithComments(std::istream &input_stream,
                              const ParseErrorCallback &cb = NULL));
  // NOLINT(runtime/references)
  bool FromStream(std::istream &input_stream,
                  int parser_flag,  // see ParserFlag
                  const ParseErrorCallback &cb = NULL);

  string ToString(bool pretty = false) const;
  void ToString(string *str, bool pretty = false) const;
  void ToString(Buffer *buffer, bool pretty = false) const;
  void ToString(std::ostream *stream, bool pretty = false) const;

  // type check
  Type type() const;
  bool IsNull() const;
  bool IsBool() const;
  bool IsInteger() const;
  bool IsDouble() const;
  bool IsString() const;
  bool IsArray() const;
  bool IsObject() const;

  // assignment operators
  Json &operator=(bool value);
  Json &operator=(int value);
  Json &operator=(int64_t value);
  Json &operator=(double value);
  Json &operator=(const char *value);
  Json &operator=(const string &value);
  Json &operator=(const Json &value);
  Json &operator=(Json &&value);

  // null type
  void SetNull();

  // boolean type
  void SetBool(bool value);
  bool GetBool() const;

  // integer type
  void SetInteger(int64_t value);
  int64_t GetInteger() const;

  // double type
  void SetDouble(double value);
  double GetDouble() const;

  // string type
  void SetString(const string &value);
  string GetString() const;

  // array type
  void SetArray();
  size_t Size() const;
  const Json &operator[](size_t index) const;
  Json &operator[](size_t index);

  void PushBack();
  void PushBack(bool value);
  void PushBack(int value);
  void PushBack(int64_t value);
  void PushBack(double value);
  void PushBack(const char *value);
  void PushBack(const string &value);
  void PushBack(const Json &value);

  void RemoveElementByIndex(size_t index);
  ValueIterator RemoveElement(ValueIterator iterator);
  void RemoveAllElements();

  ValueIterator Begin();
  ValueIterator End();
  ConstValueIterator Begin() const;
  ConstValueIterator End() const;

  // for object type
  void SetObject();
  const Json &operator[](const string &attr_name) const;
  Json &operator[](const string &attr_name);

  bool HasAttribute(const string &attr_name) const;
  bool HasAttribute(const string &attr_name, Type type) const;

  void AddAttribute(const string &attr_name, bool value);
  void AddAttribute(const string &attr_name, int value);
  void AddAttribute(const string &attr_name, int64_t value);
  void AddAttribute(const string &attr_name, double value);
  void AddAttribute(const string &attr_name, const char *value);
  void AddAttribute(const string &attr_name, const string &value);
  void AddAttribute(const string &attr_name, const Json &value);

  const Json &GetAttribute(const string &attr_name) const;
  Json &GetAttribute(const string &attr_name);

  AttributeIterator FindAttribute(const string &attr_name);
  ConstAttributeIterator FindAttribute(const string &attr_name) const;

  bool RemoveAttribute(const string &attr_name);
  AttributeIterator RemoveAttribute(AttributeIterator iterator);
  void RemoveAllAttributes();

  size_t MemberCount() const;
  AttributeIterator AttributeBegin();
  AttributeIterator AttributeEnd();
  ConstAttributeIterator AttributeBegin() const;
  ConstAttributeIterator AttributeEnd() const;
};


FUNAPI_DLL_VISIBILITY bool IsEqual(const Json &value1, const Json &value2);
FUNAPI_DLL_VISIBILITY bool operator==(const Json &lhs, const Json &rhs);
FUNAPI_DLL_VISIBILITY bool operator!=(const Json &lhs, const Json &rhs);
FUNAPI_DLL_VISIBILITY bool operator<(const Json &lhs, const Json &rhs);

FUNAPI_DLL_VISIBILITY const string &ToString(Json::Type type);
FUNAPI_DLL_VISIBILITY
std::ostream &operator<<(std::ostream &out, Json::Type type);

}  // namespace fun

#endif  // INCLUDE_FUNAPI_COMMON_JSON_H_