mirror of
https://github.com/pocoproject/poco.git
synced 2025-11-04 04:09:57 +01:00
94 lines
2.6 KiB
C++
94 lines
2.6 KiB
C++
//
|
|
// JSONString.h
|
|
//
|
|
// Library: Foundation
|
|
// Package: Core
|
|
// Module: String
|
|
//
|
|
// JSONString utility functions.
|
|
//
|
|
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// SPDX-License-Identifier: BSL-1.0
|
|
//
|
|
|
|
|
|
#ifndef Foundation_JSONString_INCLUDED
|
|
#define Foundation_JSONString_INCLUDED
|
|
|
|
|
|
#include "Poco/Foundation.h"
|
|
|
|
|
|
namespace Poco {
|
|
|
|
|
|
enum JSONOptions
|
|
{
|
|
JSON_PRESERVE_KEY_ORDER = 1,
|
|
/// Applies to JSON::Object. If specified, the Object will
|
|
/// preserve the items insertion order. Otherwise, items
|
|
/// will be sorted by keys.
|
|
///
|
|
/// Has no effect on toJSON() function.
|
|
|
|
JSON_ESCAPE_UNICODE = 2,
|
|
/// If specified, when the object is stringified, all
|
|
/// unicode characters will be escaped in the resulting
|
|
/// string.
|
|
|
|
JSON_WRAP_STRINGS = 4
|
|
/// If specified, the object will preserve the items
|
|
/// insertion order. Otherwise, items will be sorted
|
|
/// by keys.
|
|
};
|
|
|
|
|
|
//@ deprecated
|
|
void Foundation_API toJSON(const std::string& value, std::ostream& out, bool wrap = true);
|
|
/// Formats string value into the supplied output stream by
|
|
/// escaping control and ALL Unicode characters.
|
|
/// If wrap is true, the resulting string is enclosed in double quotes.
|
|
///
|
|
/// This function is deprecated, please use
|
|
///
|
|
/// void Poco::toJSON(const std::string&, std::ostream&, int)
|
|
|
|
|
|
//@ deprecated
|
|
std::string Foundation_API toJSON(const std::string& value, bool wrap = true);
|
|
/// Formats string value by escaping control and ALL Unicode characters.
|
|
/// If wrap is true, the resulting string is enclosed in double quotes
|
|
///
|
|
/// Returns formatted string.
|
|
///
|
|
/// This function is deprecated, please use
|
|
///
|
|
/// std::string Poco::toJSON(const std::string&, int)
|
|
|
|
|
|
void Foundation_API toJSON(const std::string& value, std::ostream& out, int options);
|
|
/// Formats string value into the supplied output stream by
|
|
/// escaping control characters.
|
|
/// If JSON_WRAP_STRINGS is in options, the resulting strings is enclosed in double quotes
|
|
/// If JSON_ESCAPE_UNICODE is in options, all unicode characters will be escaped, otherwise
|
|
/// only the compulsory ones.
|
|
|
|
|
|
std::string Foundation_API toJSON(const std::string& value, int options);
|
|
/// Formats string value by escaping control characters.
|
|
/// If JSON_WRAP_STRINGS is in options, the resulting string is enclosed in double quotes
|
|
/// If JSON_ESCAPE_UNICODE is in options, all unicode characters will be escaped, otherwise
|
|
/// only the compulsory ones.
|
|
///
|
|
/// Returns formatted string.
|
|
/// If escapeAllUnicode is true, all unicode characters will be escaped, otherwise only the compulsory ones.
|
|
|
|
|
|
|
|
} // namespace Poco
|
|
|
|
|
|
#endif // Foundation_JSONString_INCLUDED
|