bdljsn_writestyle.h

Go to the documentation of this file.

/// @file bdljsn_writestyle.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdljsn_writestyle.h                                                -*-C++-*-
#ifndef INCLUDED_BDLJSN_WRITESTYLE
#define INCLUDED_BDLJSN_WRITESTYLE
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdljsn_writestyle bdljsn_writestyle
/// @brief  Enumerate the formatting styles for a writing a JSON document.
/// @addtogroup bdl
/// @{
/// @addtogroup bdljsn
/// @{
/// @addtogroup bdljsn_writestyle
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdljsn_writestyle-purpose"> Purpose</a>
/// * <a href="#bdljsn_writestyle-classes"> Classes </a>
/// * <a href="#bdljsn_writestyle-description"> Description </a>
///   * <a href="#bdljsn_writestyle-enumerators"> Enumerators </a>
///   * <a href="#bdljsn_writestyle-usage"> Usage </a>
///     * <a href="#bdljsn_writestyle-example-1-basic-syntax"> Example 1: Basic Syntax </a>
///
/// # Purpose {#bdljsn_writestyle-purpose}
/// Enumerate the formatting styles for a writing a JSON document.
///
/// # Classes {#bdljsn_writestyle-classes}
///
/// -  bdljsn::WriteStyle: namespace for styles for writing a JSON document
///
/// @see  bdljsn_writeoptions
///
/// # Description {#bdljsn_writestyle-description}
/// This component provides `bdljsn::WriteStyle`, a namespace for
/// the `enum` type `bdljsn::WriteStyle::Enum`, which enumerates the set of
/// format styles that can be used when writing a JSON document.
///
/// ## Enumerators {#bdljsn_writestyle-enumerators}
///
///
/// @code
/// Name              Description
/// -------------     -------------------------------------------------------
/// e_PRETTY          A human friendly format with configurable new lines and
///                   indentation
///
/// e_ONELINE         A single-line format with a space after each comma and
///                   colon.
///
/// e_COMPACT         A maximally compact format with no white space.
/// @endcode
///
/// ## Usage {#bdljsn_writestyle-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Basic Syntax {#bdljsn_writestyle-example-1-basic-syntax}
///
///
/// The following snippets of code provide a simple illustration of using
/// `bdljsn::WriteStyle`.
///
/// First, we create a variable `value` of type `bdljsn::WriteStyle::Enum` and
/// initialize it with the enumerator value `bdljsn::WriteStyle::e_PRETTY`:
/// @code
/// bdljsn::WriteStyle::Enum value = bdljsn::WriteStyle::e_PRETTY;
/// @endcode
/// Now, we store the address of its ASCII representation in a pointer variable,
/// `asciiValue`, of type `const char *`:
/// @code
/// const char *asciiValue = bdljsn::WriteStyle::toAscii(value);
/// assert(0 == bsl::strcmp(asciiValue, "PRETTY"));
/// @endcode
/// Finally, we print `value` to `bsl::cout`.
/// @code
/// bsl::cout << value << bsl::endl;
/// @endcode
/// This statement produces the following output on `stdout`:
/// @code
/// PRETTY
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdljsn
 * @{
 */
/** @addtogroup bdljsn_writestyle
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bsl_iosfwd.h>
 
 
namespace bdljsn {
                             // =================
                             // struct WriteStyle
                             // =================
 
/// This `struct` provides a namespace for enumerating the formatting styles
/// that can be used for writing a JSON document.  See `Enum` in the TYPES
/// sub-section for details.
///
/// This class:
/// * supports a complete set of *enumeration* operations
///   - except for `bdex` serialization
/// * is `const` *thread-safe*
/// For terminology see @ref bsldoc_glossary .
///
/// See @ref bdljsn_writestyle 
struct WriteStyle {
 
  public:
    // TYPES
    enum Enum {
        e_PRETTY,   // human friendly, with indentation and spaces
        e_ONELINE,  // single-line format with whitespace for readability
        e_COMPACT   // maximally compact, no white-space
    };
 
  public:
    // CLASS METHODS
 
    /// Write the string representation of the specified enumeration `value`
    /// to the specified output `stream`, and return a reference to
    /// `stream`.  Optionally specify an initial indentation `level`, whose
    /// absolute value is incremented recursively for nested objects.  If
    /// `level` is specified, optionally specify `spacesPerLevel`, whose
    /// absolute value indicates the number of spaces per indentation level
    /// for this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  See `toAscii` for
    /// what constitutes the string representation of a `WriteStyle::Enum`
    /// value.
    static bsl::ostream& print(bsl::ostream&    stream,
                               WriteStyle::Enum value,
                               int              level          = 0,
                               int              spacesPerLevel = 4);
 
    /// Return the non-modifiable string representation corresponding to the
    /// specified enumeration `value`, if it exists, and a unique (error)
    /// string otherwise.  The string representation of `value` matches its
    /// corresponding enumerator name with the "e_" prefix elided.  For
    /// example:
    /// @code
    /// bsl::cout << WriteStyle::toAscii(WriteStyle::e_PRETTY);
    /// @endcode
    /// will print the following on standard output:
    /// @code
    /// PRETTY
    /// @endcode 
    /// 
    /// \note Note that   specifying a `value` that does not match any of the
    /// enumerators will result in a string representation that is distinct
    /// from any of those corresponding to the enumerators, but is otherwise
    /// unspecified.
    static const char *toAscii(WriteStyle::Enum value);
};
 
// FREE OPERATORS
 
/// Write the string representation of the specified enumeration `value` to
/// the specified output `stream` in a single-line format, and return a
/// reference to `stream`.  See `toAscii` for what constitutes the string representation of a `bdljsn::WriteStyle::Enum` value.  
/// 
/// \note Note that   this
/// method has the same behavior as
/// @code
/// bdljsn::WriteStyle::print(stream, value, 0, -1);
/// @endcode
bsl::ostream& operator<<(bsl::ostream& stream, WriteStyle::Enum value);
 
}  // close package namespace
 
// ============================================================================
//                            INLINE DEFINITIONS
// ============================================================================
 
                             // -----------------
                             // struct WriteStyle
                             // -----------------
 
// FREE OPERATORS
inline
bsl::ostream& bdljsn::operator<<(bsl::ostream& stream, WriteStyle::Enum value)
{
    return WriteStyle::print(stream, value, 0, -1);
}
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2022 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */