1ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// Copyright (c) 2011 The Chromium Authors. All rights reserved. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file. 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#ifndef BASE_JSON_JSON_WRITER_H_ 6c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#define BASE_JSON_JSON_WRITER_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 9c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <string> 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 11ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen#include "base/base_api.h" 12c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "base/basictypes.h" 13c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 14c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass Value; 15c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace base { 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 18ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsenclass BASE_API JSONWriter { 19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott public: 20c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Given a root node, generates a JSON string and puts it into |json|. 21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // If |pretty_print| is true, return a slightly nicer formated json string 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // (pads with whitespace to help readability). If |pretty_print| is false, 23c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // we try to generate as compact a string as possible. 24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // TODO(tc): Should we generate json if it would be invalid json (e.g., 25c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // |node| is not a DictionaryValue/ListValue or if there are inf/-inf float 26c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // values)? 27c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott static void Write(const Value* const node, bool pretty_print, 28c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott std::string* json); 29c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 30c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Same as above, but has an option to not escape the string, preserving its 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // UTF8 characters. It is useful if you can pass resulting string to the 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // JSON parser in binary form (as UTF8). 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott static void WriteWithOptionalEscape(const Value* const node, 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool pretty_print, 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool escape, 36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott std::string* json); 37c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 38c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // A static, constant JSON string representing an empty array. Useful 39c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // for empty JSON argument passing. 40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott static const char* kEmptyArray; 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 42c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott private: 43c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott JSONWriter(bool pretty_print, std::string* json); 44c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Called recursively to build the JSON string. Whe completed, value is 46c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // json_string_ will contain the JSON. 47c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void BuildJSONString(const Value* const node, int depth, bool escape); 48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 493345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Appends a quoted, escaped, version of (UTF-8) str to json_string_. 503345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick void AppendQuotedString(const std::string& str); 51c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 52c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Adds space to json_string_ for the indent level. 53c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void IndentLine(int depth); 54c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 55c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Where we write JSON data as we generate it. 56c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott std::string* json_string_; 57c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 58c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool pretty_print_; 59c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott DISALLOW_COPY_AND_ASSIGN(JSONWriter); 61c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott}; 62c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 63c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace base 64c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 65c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // BASE_JSON_JSON_WRITER_H_ 66