writer.h

Go to the documentation of this file.

// Copyright 2007-2010 Baptiste Lepilleur
// Distributed under MIT license, or public domain if desired and
// recognized in your jurisdiction.
// See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE

#ifndef JSON_WRITER_H_INCLUDED
#define JSON_WRITER_H_INCLUDED

#if !defined(JSON_IS_AMALGAMATION)
#include "value.h"
#endif // if !defined(JSON_IS_AMALGAMATION)
#include <vector>
#include <string>

// Disable warning C4251: <data member>: <type> needs to have dll-interface to
// be used by...
#if defined(JSONCPP_DISABLE_DLL_INTERFACE_WARNING)
#pragma warning(push)
#pragma warning(disable : 4251)
#endif // if defined(JSONCPP_DISABLE_DLL_INTERFACE_WARNING)

namespace Json {

class Value;

class JSON_API Writer {
public:
  virtual ~Writer();

  virtual std::string write(const Value &root) = 0;
};

class JSON_API FastWriter : public Writer {
public:
  FastWriter();
  virtual ~FastWriter() {}

  void enableYAMLCompatibility();

  void dropNullPlaceholders();

public: // overridden from Writer
  virtual std::string write(const Value &root);

private:
  void writeValue(const Value &value);

  std::string document_;
  bool yamlCompatiblityEnabled_;
  bool dropNullPlaceholders_;
};

class JSON_API StyledWriter : public Writer {
public:
  StyledWriter();
  virtual ~StyledWriter() {}

public: // overridden from Writer
  virtual std::string write(const Value &root);

private:
  void writeValue(const Value &value);
  void writeArrayValue(const Value &value);
  bool isMultineArray(const Value &value);
  void pushValue(const std::string &value);
  void writeIndent();
  void writeWithIndent(const std::string &value);
  void indent();
  void unindent();
  void writeCommentBeforeValue(const Value &root);
  void writeCommentAfterValueOnSameLine(const Value &root);
  bool hasCommentForValue(const Value &value);
  static std::string normalizeEOL(const std::string &text);

  typedef std::vector<std::string> ChildValues;

  ChildValues childValues_;
  std::string document_;
  std::string indentString_;
  int rightMargin_;
  int indentSize_;
  bool addChildValues_;
};

class JSON_API StyledStreamWriter {
public:
  StyledStreamWriter(std::string indentation = "\t");
  ~StyledStreamWriter() {}

public:
  void write(std::ostream &out, const Value &root);

private:
  void writeValue(const Value &value);
  void writeArrayValue(const Value &value);
  bool isMultineArray(const Value &value);
  void pushValue(const std::string &value);
  void writeIndent();
  void writeWithIndent(const std::string &value);
  void indent();
  void unindent();
  void writeCommentBeforeValue(const Value &root);
  void writeCommentAfterValueOnSameLine(const Value &root);
  bool hasCommentForValue(const Value &value);
  static std::string normalizeEOL(const std::string &text);

  typedef std::vector<std::string> ChildValues;

  ChildValues childValues_;
  std::ostream *document_;
  std::string indentString_;
  int rightMargin_;
  std::string indentation_;
  bool addChildValues_;
};

#if defined(JSON_HAS_INT64)
std::string JSON_API valueToString(Int value);
std::string JSON_API valueToString(UInt value);
#endif // if defined(JSON_HAS_INT64)
std::string JSON_API valueToString(LargestInt value);
std::string JSON_API valueToString(LargestUInt value);
std::string JSON_API valueToString(double value);
std::string JSON_API valueToString(bool value);
std::string JSON_API valueToQuotedString(const char *value);

JSON_API std::ostream &operator<<(std::ostream &, const Value &root);

} // namespace Json

#if defined(JSONCPP_DISABLE_DLL_INTERFACE_WARNING)
#pragma warning(pop)
#endif // if defined(JSONCPP_DISABLE_DLL_INTERFACE_WARNING)

#endif // JSON_WRITER_H_INCLUDED