baljsn_encoderoptions.h

Go to the documentation of this file.

/// @file baljsn_encoderoptions.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// baljsn_encoderoptions.h                                            -*-C++-*-
#ifndef INCLUDED_BALJSN_ENCODEROPTIONS
#define INCLUDED_BALJSN_ENCODEROPTIONS
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup baljsn_encoderoptions baljsn_encoderoptions
/// @brief  Provide an attribute class for specifying JSON encoding options.
/// @addtogroup bal
/// @{
/// @addtogroup baljsn
/// @{
/// @addtogroup baljsn_encoderoptions
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#baljsn_encoderoptions-purpose"> Purpose</a>
/// * <a href="#baljsn_encoderoptions-classes"> Classes </a>
/// * <a href="#baljsn_encoderoptions-description"> Description </a>
///   * <a href="#baljsn_encoderoptions-attributes"> Attributes </a>
///     * <a href="#baljsn_encoderoptions-implementation-note"> Implementation Note </a>
///   * <a href="#baljsn_encoderoptions-usage"> Usage </a>
///     * <a href="#baljsn_encoderoptions-example-1-creating-and-populating-an-options-object"> Example 1: Creating and Populating an Options Object </a>
///
/// # Purpose {#baljsn_encoderoptions-purpose}
/// Provide an attribute class for specifying JSON encoding options.
///
/// # Classes {#baljsn_encoderoptions-classes}
///
/// -  baljsn::EncoderOptions: options for encoding objects in the JSON format
///
/// @see  baljsn_encoder, baljsn_decoderoptions
///
/// # Description {#baljsn_encoderoptions-description}
/// This component provides a single, simply constrained
/// (value-semantic) attribute class, `baljsn::EncoderOptions`, that is used to
/// specify options for encoding objects in the JSON format.
///
/// ## Attributes {#baljsn_encoderoptions-attributes}
///
///
/// @code
/// Name                Type           Default         Simple Constraints
/// ------------------  -----------    -------         ------------------
/// encodingStyle       EncodingStyle  e_COMPACT       none
/// initialIndentLevel  int            0               >= 0
/// spacesPerLevel      int            0               >= 0
/// encodeEmptyArrays   bool           false           none
/// encodeNullElements  bool           false           none
/// encodeInfAndNaNAsStrings
///                     bool           false           none
/// encodeQuotedDecimal64
///                     bool           true            none
/// datetimeFractionalSecondPrecision
///                     int            3               >= 0 and <= 6
/// maxFloatPrecision   int            0               >= 1 and <= 9  or 0
/// maxDoublePrecision  int            0               >= 1 and <= 17 or 0
/// @endcode
/// * `encodingStyle`: encoding style used to encode the JSON data.
/// * `initialIndentLevel`: Initial indent level for the topmost element.
/// * `spacesPerLevel`: spaces per additional indent level.
/// * `encodeEmptyArrays`: option specifying if empty arrays should be encoded
///   (empty arrays occurring as selections of choices are always encoded).
/// * `encodeNullElements`: option specifying if null elements should be
///                         encoded.
/// * `encodeInfAndNaNAsStrings`: JSON does not provide a way to encode these
///                               values as they are not numbers.  This option
///                               provides a way to encode these values.
///                               Although the resulting output is a valid
///                               JSON document, decoders expecting floating
///                               point numbers to be encoded only as numbers
///                               will fail to decode.  Users of this option
///                               must therefore exercise caution and ensure
///                               that if this option is used then the parser
///                               decoding the generated JSON can handle
///                               doubles as strings.
/// * `encodeQuotedDecimal64`: option specifying a way to encode `Decimal64`
///                             values.  If the `encodeQuotedDecimal64`
///                             attribute value is `true` (the default), the
///                             `Decimal64` values will be encoded quoted,
///                             and otherwise they will be encoded as numbers.
///                             Encoding a Decimal64 as a JSON number will
///                             frequently result in it being later decoded as
///                             a binary floating point number, and in the
///                             process losing digits of precision that were
///                             the point of using the Decimal64 type in the
///                             first place.  Care should be taken when setting
///                             this option to `false` (though it may be useful
///                             when communicating with endpoints that are
///                             known to correctly handle high precision JSON
///                             numbers).
/// * `datetimeFractionalSecondPrecision`: option specifying the number of
///                                        decimal places used for seconds when
///                                        encoding `Datetime` and
///                                        `DatetimeTz`.
/// * `maxFloatPrecision`: [**DEPRECATED**] option specifying the maximum number
///                        of decimal places used to encode each `float` value.
///                        When 0 (the default value) the encoder will use the
///                        minimum that is necessary to restore the binary
///                        value into a `float`.  We recommend against setting
///                        this option: the option was provided prior to the
///                        current default behavior (of choosing the shortest
///                        presentation that can be restored to the original
///                        value) being available.
/// * `maxDoublePrecision`: [**DEPRECATED**] option specifying the maximum number
///                         of decimal places used to encode each `double`
///                         value.  When 0 (the default value) the encoder will
///                         use the minimum that is necessary to restore the
///                         binary value into a `double`.  We recommend against
///                         setting this option: the option was provided prior
///                         to the current default behavior (of choosing the
///                         shortest presentation that can be restored to the
///                         original value) being available.
///
/// ### Implementation Note {#baljsn_encoderoptions-implementation-note}
///
///
/// This file was generated from a script and was subsequently modified to add
/// documentation and to make other changes.  The steps to generate and update
/// this file can be found in the `doc/generating_codec_options.txt` file.
///
/// ## Usage {#baljsn_encoderoptions-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Creating and Populating an Options Object {#baljsn_encoderoptions-example-1-creating-and-populating-an-options-object}
///
///
/// This component is designed to be used at a higher level to set the options
/// for encoding objects in the JSON format.  This example shows how to create
/// and populate an options object.
///
/// First, we default-construct a `baljsn::EncoderOptions` object:
/// @code
/// const int  INITIAL_INDENT_LEVEL      = 1;
/// const int  SPACES_PER_LEVEL          = 4;
/// const bool ENCODE_EMPTY_ARRAYS       = true;
/// const bool ENCODE_NULL_ELEMENTS      = true;
/// const bool ENCODE_INF_NAN_AS_STRINGS = true;
/// const int  DATETIME_PRECISION        = 6;
/// const int  FLOAT_PRECISION           = 3;
/// const int  DOUBLE_PRECISION          = 9;
/// const bool ENCODE_QUOTED_DECIMAL64   = false;
///
/// baljsn::EncoderOptions options;
/// assert(0     == options.initialIndentLevel());
/// assert(0     == options.spacesPerLevel());
/// assert(baljsn::EncoderOptions::e_COMPACT == options.encodingStyle());
/// assert(false == options.encodeEmptyArrays());
/// assert(false == options.encodeNullElements());
/// assert(false == options.encodeInfAndNaNAsStrings());
/// assert(3     == options.datetimeFractionalSecondPrecision());
/// assert(0     == options.maxFloatPrecision());
/// assert(0     == options.maxDoublePrecision());
/// assert(true  == options.encodeQuotedDecimal64());
/// @endcode
/// Next, we populate that object to encode in a prett format using a
/// pre-defined initial indent level and spaces per level:
/// @code
/// options.setEncodingStyle(baljsn::EncodingStyle::e_PRETTY);
/// assert(baljsn::EncoderOptions::e_PRETTY == options.encodingStyle());
///
/// options.setInitialIndentLevel(INITIAL_INDENT_LEVEL);
/// assert(INITIAL_INDENT_LEVEL == options.initialIndentLevel());
///
/// options.setSpacesPerLevel(SPACES_PER_LEVEL);
/// assert(SPACES_PER_LEVEL == options.spacesPerLevel());
///
/// options.setEncodeEmptyArrays(ENCODE_EMPTY_ARRAYS);
/// assert(ENCODE_EMPTY_ARRAYS == options.encodeEmptyArrays());
///
/// options.setEncodeNullElements(ENCODE_NULL_ELEMENTS);
/// assert(ENCODE_NULL_ELEMENTS == options.encodeNullElements());
///
/// options.setEncodeInfAndNaNAsStrings(ENCODE_INF_NAN_AS_STRINGS);
/// assert(ENCODE_INF_NAN_AS_STRINGS == options.encodeInfAndNaNAsStrings());
///
/// options.setDatetimeFractionalSecondPrecision(DATETIME_PRECISION);
/// assert(DATETIME_PRECISION == options.datetimeFractionalSecondPrecision());
///
/// options.setMaxFloatPrecision(FLOAT_PRECISION);
/// assert(FLOAT_PRECISION == options.maxFloatPrecision());
///
/// options.setMaxDoublePrecision(DOUBLE_PRECISION);
/// assert(DOUBLE_PRECISION == options.maxDoublePrecision());
///
/// options.setEncodeQuotedDecimal64(ENCODE_QUOTED_DECIMAL64);
/// ASSERT(ENCODE_QUOTED_DECIMAL64 == options.encodeQuotedDecimal64());
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bal
 * @{
 */
/** @addtogroup baljsn
 * @{
 */
/** @addtogroup baljsn_encoderoptions
 * @{
 */
 
#include <balscm_version.h>
 
#include <bslalg_typetraits.h>
 
#include <bdlat_attributeinfo.h>
#include <bdlat_selectioninfo.h>
#include <bdlat_typetraits.h>
 
#include <bsls_assert.h>
#include <bsls_objectbuffer.h>
#include <bsls_review.h>
 
#include <baljsn_encodingstyle.h>
 
#include <bsl_limits.h>
#include <bsl_iosfwd.h>
 
 
 
namespace baljsn { class EncoderOptions; }
namespace baljsn {
 
                            // ====================
                            // class EncoderOptions
                            // ====================
 
/// Options for performing JSON encoding.  `EncodingStyle` is either
/// `COMPACT` or `PRETTY`.  If `EncodingStyle` is `COMPACT`, no whitespace
/// will be added between elements.  If encoding style is `PRETTY`, then the
/// `InitialIndentLevel` and `SpacesPerLevel` parameters are used to specify
/// the formatting of the output.  Note that `InitialIndentLevel` and
/// `SpacesPerLevel` are ignored when `EncodingStyle` is `COMPACT` (this is
/// the default).  The `EncodeEmptyArrays` and `EncodeNullElements` encode
/// empty array and null elements respectively.  By default empty array and
/// null elements are not encoded.  The `EncodeInfAndNaNAsStrings` attribute
/// provides users the option to encode `Infinity` and `NaN` floating point
/// values as strings.  These values do not have a valid JSON representation
/// and by default such value will result in an encoding error.  The
/// `DatetimeFractionalSecondPrecision` specifies the precision of
/// milliseconds printed with date time values.  By default a precision of
/// `3` decimal places is used.  The `MaxFloatPrecision` and
/// `MaxDoublePrecision` attributes allow specifying the maximum precision
/// for `float` and `double` values.  When not specified, or 0 is specified,
/// the precision is determined automatically to use enough digits to ensure
/// restoring the original binary floating point value by a reader.  We
/// recommend against setting these options: they were provided prior to the
/// current default behavior (of choosing the shortest presentation that can
/// be restored to the original value) being available.
///
/// See @ref baljsn_encoderoptions 
class EncoderOptions {
 
    // INSTANCE DATA
 
    // initial indentation level for the topmost element
    int                   d_initialIndentLevel;
 
    // spaces per additional level of indentation
    int                   d_spacesPerLevel;
 
    // option specifying the number of decimal places used for milliseconds
    // when encoding `Datetime` and `DatetimeTz` values
    int                   d_datetimeFractionalSecondPrecision;
 
    // option specifying the maximum number of decimal places used to
    // encode each `float` value
    int                   d_maxFloatPrecision;
 
    // option specifying the maximum number of decimal places used to
    // encode each `double` value
    int                   d_maxDoublePrecision;
 
    // encoding style used to encode values
    baljsn::EncodingStyle::Value  d_encodingStyle;
 
    // option specifying if empty arrays should be encoded (empty arrays
    // occurring as selections of choices are always encoded)
    bool                  d_encodeEmptyArrays;
 
    // option specifying if null elements should be encoded
    bool                  d_encodeNullElements;
 
    // option specifying a way to encode `Infinity` and `NaN` floating
    // point values.  JSON does not provide a way to encode these values as
    // they are not numbers.  Although the resulting output is a valid JSON
    // document, decoders expecting floating point numbers to be encoded
    // only as numbers will fail to decode.  Users of this option must
    // therefore exercise caution and ensure that if this option is used
    // then the parser decoding the generated JSON can handle doubles as
    // strings.
    bool                  d_encodeInfAndNaNAsStrings;
 
    // option specifying a way to encode `Decimal64` values.  If the option
    // value is `true` then the `Decimal64` value is encoded quoted
    // { "dec": "1.2e-5" }, and unquoted { "dec": 1.2e-5 } otherwise.
    bool                   d_encodeQuotedDecimal64;
  public:
    // TYPES
 
    // This `enum` provides enumerators to specify the encoding styles.  This
    // `enum` is replicated in this `class` for backwards-compatibility with
    // `baejsn`.  Users should use `baljsn::EncodingStyle` directly.
    enum EncodingStyle {
        e_COMPACT = baljsn::EncodingStyle::e_COMPACT,
        e_PRETTY  = baljsn::EncodingStyle::e_PRETTY
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
      , BAEJSN_COMPACT = e_COMPACT
      , BAEJSN_PRETTY  = e_PRETTY
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
    };
 
    enum {
        ATTRIBUTE_ID_INITIAL_INDENT_LEVEL                 = 0
      , ATTRIBUTE_ID_SPACES_PER_LEVEL                     = 1
      , ATTRIBUTE_ID_ENCODING_STYLE                       = 2
      , ATTRIBUTE_ID_ENCODE_EMPTY_ARRAYS                  = 3
      , ATTRIBUTE_ID_ENCODE_NULL_ELEMENTS                 = 4
      , ATTRIBUTE_ID_ENCODE_INF_AND_NA_N_AS_STRINGS       = 5
      , ATTRIBUTE_ID_DATETIME_FRACTIONAL_SECOND_PRECISION = 6
      , ATTRIBUTE_ID_MAX_FLOAT_PRECISION                  = 7
      , ATTRIBUTE_ID_MAX_DOUBLE_PRECISION                 = 8
      , ATTRIBUTE_ID_ENCODE_QUOTED_DECIMAL64              = 9
    };
 
    enum {
        NUM_ATTRIBUTES = 10
    };
 
    enum {
        ATTRIBUTE_INDEX_INITIAL_INDENT_LEVEL                 = 0
      , ATTRIBUTE_INDEX_SPACES_PER_LEVEL                     = 1
      , ATTRIBUTE_INDEX_ENCODING_STYLE                       = 2
      , ATTRIBUTE_INDEX_ENCODE_EMPTY_ARRAYS                  = 3
      , ATTRIBUTE_INDEX_ENCODE_NULL_ELEMENTS                 = 4
      , ATTRIBUTE_INDEX_ENCODE_INF_AND_NA_N_AS_STRINGS       = 5
      , ATTRIBUTE_INDEX_DATETIME_FRACTIONAL_SECOND_PRECISION = 6
      , ATTRIBUTE_INDEX_MAX_FLOAT_PRECISION                  = 7
      , ATTRIBUTE_INDEX_MAX_DOUBLE_PRECISION                 = 8
      , ATTRIBUTE_INDEX_ENCODE_QUOTED_DECIMAL64              = 9
    };
 
    // CONSTANTS
    static const char CLASS_NAME[];
 
    static const int DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL;
 
    static const int DEFAULT_INITIALIZER_SPACES_PER_LEVEL;
 
    static const baljsn::EncodingStyle::Value DEFAULT_INITIALIZER_ENCODING_STYLE;
 
    static const bool DEFAULT_INITIALIZER_ENCODE_EMPTY_ARRAYS;
 
    static const bool DEFAULT_INITIALIZER_ENCODE_NULL_ELEMENTS;
 
    static const bool DEFAULT_INITIALIZER_ENCODE_INF_AND_NA_N_AS_STRINGS;
 
    static const int DEFAULT_INITIALIZER_DATETIME_FRACTIONAL_SECOND_PRECISION;
 
    static const int DEFAULT_INITIALIZER_MAX_FLOAT_PRECISION;
 
    static const int DEFAULT_INITIALIZER_MAX_DOUBLE_PRECISION;
 
    static const bool DEFAULT_INITIALIZER_ENCODE_QUOTED_DECIMAL64;
 
    static const bdlat_AttributeInfo ATTRIBUTE_INFO_ARRAY[];
 
  public:
    // CLASS METHODS
 
    /// Return attribute information for the attribute indicated by the
    /// specified `id` if the attribute exists, and 0 otherwise.
    static const bdlat_AttributeInfo *lookupAttributeInfo(int id);
 
    /// Return attribute information for the attribute indicated by the
    /// specified `name` of the specified `nameLength` if the attribute
    /// exists, and 0 otherwise.
    static const bdlat_AttributeInfo *lookupAttributeInfo(
                                                    const char *name,
                                                    int         nameLength);
 
    // CREATORS
 
    /// Create an object of type `EncoderOptions` having the default value.
    EncoderOptions();
 
    /// Create an object of type `EncoderOptions` having the value of the
    /// specified `original` object.
    EncoderOptions(const EncoderOptions& original);
 
    /// Destroy this object.
    ~EncoderOptions();
 
    // MANIPULATORS
 
    /// Assign to this object the value of the specified `rhs` object.
    EncoderOptions& operator=(const EncoderOptions& rhs);
 
    /// Reset this object to the default value (i.e., its value upon
    /// default construction).
    void reset();
 
    /// Invoke the specified `manipulator` sequentially on the address of
    /// each (modifiable) attribute of this object, supplying `manipulator`
    /// with the corresponding attribute information structure until such
    /// invocation returns a non-zero value.  Return the value from the
    /// last invocation of `manipulator` (i.e., the invocation that
    /// terminated the sequence).
    template<class MANIPULATOR>
    int manipulateAttributes(MANIPULATOR& manipulator);
 
    /// Invoke the specified `manipulator` on the address of
    /// the (modifiable) attribute indicated by the specified `id`,
    /// supplying `manipulator` with the corresponding attribute
    /// information structure.  Return the value returned from the
    /// invocation of `manipulator` if `id` identifies an attribute of this
    /// class, and -1 otherwise.
    template<class MANIPULATOR>
    int manipulateAttribute(MANIPULATOR& manipulator, int id);
 
    /// Invoke the specified `manipulator` on the address of the (modifiable)
    /// attribute indicated by the specified `name` of the specified
    /// `nameLength`, supplying `manipulator` with the corresponding attribute
    /// information structure.  Return the value returned from the invocation
    /// of `manipulator` if `name` identifies an attribute of this class, and
    /// -1 otherwise.
    template<class MANIPULATOR>
    int manipulateAttribute(MANIPULATOR&  manipulator,
                            const char   *name,
                            int           nameLength);
 
    /// Set the "InitialIndentLevel" attribute of this object to the specified
    /// `value`.
    void setInitialIndentLevel(int value);
 
    /// Set the "SpacesPerLevel" attribute of this object to the specified
    /// `value`.
    void setSpacesPerLevel(int value);
 
    void setEncodingStyle(baljsn::EncodingStyle::Value value);
    /// Set the "EncodingStyle" attribute of this object to the specified
    /// `value`.
    void setEncodingStyle(baljsn::EncoderOptions::EncodingStyle value);
 
    /// Set the "EncodeEmptyArrays" attribute of this object to the specified
    /// `value`.
    void setEncodeEmptyArrays(bool value);
 
    /// Set the "EncodeNullElements" attribute of this object to the specified
    /// `value`.
    void setEncodeNullElements(bool value);
 
    /// Set the "EncodeInfAndNaNAsStrings" attribute of this object to the
    /// specified `value`.
    void setEncodeInfAndNaNAsStrings(bool value);
 
    /// Set the "DatetimeFractionalSecondPrecision" attribute of this object
    /// to the specified `value`.
    void setDatetimeFractionalSecondPrecision(int value);
 
    /// Set the "MaxFloatPrecision" attribute of this object to the
    /// specified `value`.
    void setMaxFloatPrecision(int value);
 
    /// Set the "MaxDoublePrecision" attribute of this object to the
    /// specified `value`.
    void setMaxDoublePrecision(int value);
 
    /// Set the "EncodeQuotedDecimal64" attribute of this object to the
    /// specified `value`.
    void setEncodeQuotedDecimal64(bool value);
 
    // ACCESSORS
 
    /// Format this object to the specified output `stream` at the
    /// optionally specified indentation `level` and return a reference to
    /// the modifiable `stream`.  If `level` is specified, optionally
    /// specify `spacesPerLevel`, the number of spaces per indentation level
    /// for this and all of its nested objects.  Each line is indented by
    /// the absolute value of `level * spacesPerLevel`.  If `level` is
    /// negative, suppress indentation of the first line.  If
    /// `spacesPerLevel` is negative, suppress line breaks and format the
    /// entire output on one line.  If `stream` is initially invalid, this
    /// operation has no effect.  Note that a trailing newline is provided
    /// in multiline mode only.
    bsl::ostream& print(bsl::ostream& stream,
                        int           level = 0,
                        int           spacesPerLevel = 4) const;
 
    /// Invoke the specified `accessor` sequentially on each
    /// (non-modifiable) attribute of this object, supplying `accessor`
    /// with the corresponding attribute information structure until such
    /// invocation returns a non-zero value.  Return the value from the
    /// last invocation of `accessor` (i.e., the invocation that terminated
    /// the sequence).
    template<class ACCESSOR>
    int accessAttributes(ACCESSOR& accessor) const;
 
    /// Invoke the specified `accessor` on the (non-modifiable) attribute
    /// of this object indicated by the specified `id`, supplying `accessor`
    /// with the corresponding attribute information structure.  Return the
    /// value returned from the invocation of `accessor` if `id` identifies
    /// an attribute of this class, and -1 otherwise.
    template<class ACCESSOR>
    int accessAttribute(ACCESSOR& accessor, int id) const;
 
    /// Invoke the specified `accessor` on the (non-modifiable) attribute
    /// of this object indicated by the specified `name` of the specified
    /// `nameLength`, supplying `accessor` with the corresponding attribute
    /// information structure.  Return the value returned from the
    /// invocation of `accessor` if `name` identifies an attribute of this
    /// class, and -1 otherwise.
    template<class ACCESSOR>
    int accessAttribute(ACCESSOR&   accessor,
                        const char *name,
                        int         nameLength) const;
 
    /// Return a reference to the non-modifiable "InitialIndentLevel"
    /// attribute of this object.
    int initialIndentLevel() const;
 
    /// Return a reference to the non-modifiable "SpacesPerLevel" attribute
    /// of this object.
    int spacesPerLevel() const;
 
    /// Return a reference to the non-modifiable "EncodingStyle" attribute
    /// of this object.
    baljsn::EncoderOptions::EncodingStyle encodingStyle() const;
 
    /// Return a reference to the non-modifiable "EncodeEmptyArrays"
    /// attribute of this object.  Note that empty arrays occurring as
    /// selections of choices are always encoded regardless of the setting
    /// of this option.
    bool encodeEmptyArrays() const;
 
    /// Return a reference to the non-modifiable "EncodeNullElements"
    /// attribute of this object.
    bool encodeNullElements() const;
 
    /// Return a reference to the non-modifiable "EncodeInfAndNaNAsStrings"
    /// attribute of this object.
    bool encodeInfAndNaNAsStrings() const;
 
    /// Return a reference to the non-modifiable
    /// "DatetimeFractionalSecondPrecision" attribute of this object.
    int datetimeFractionalSecondPrecision() const;
 
    /// Return a reference to the non-modifiable "MaxFloatPrecision"
    /// attribute of this object.
    int maxFloatPrecision() const;
 
    /// Return a reference to the non-modifiable "MaxDoublePrecision"
    /// attribute of this object.
    int maxDoublePrecision() const;
 
    /// Return the value of the "EncodeQuotedDecimal64" attribute of this
    /// object.
    bool encodeQuotedDecimal64() const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` attribute objects have
/// the same value, and `false` otherwise.  Two attribute objects have the
/// same value if each respective attribute has the same value.
inline
bool operator==(const EncoderOptions& lhs, const EncoderOptions& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` attribute objects do not
/// have the same value, and `false` otherwise.  Two attribute objects do
/// not have the same value if one or more respective attributes differ in
/// values.
inline
bool operator!=(const EncoderOptions& lhs, const EncoderOptions& rhs);
 
/// Format the specified `rhs` to the specified output `stream` and
/// return a reference to the modifiable `stream`.
inline
bsl::ostream& operator<<(bsl::ostream& stream, const EncoderOptions& rhs);
 
}  // close package namespace
 
// TRAITS
 
BDLAT_DECL_SEQUENCE_WITH_BITWISEMOVEABLE_TRAITS(baljsn::EncoderOptions)
 
// ============================================================================
//                         INLINE FUNCTION DEFINITIONS
// ============================================================================
 
namespace baljsn {
 
                            // --------------------
                            // class EncoderOptions
                            // --------------------
 
// CLASS METHODS
// MANIPULATORS
template <class MANIPULATOR>
int EncoderOptions::manipulateAttributes(MANIPULATOR& manipulator)
{
    int ret;
 
    ret = manipulator(&d_initialIndentLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_INITIAL_INDENT_LEVEL]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_spacesPerLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_SPACES_PER_LEVEL]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_encodingStyle, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODING_STYLE]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_encodeEmptyArrays, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_EMPTY_ARRAYS]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_encodeNullElements, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_NULL_ELEMENTS]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_encodeInfAndNaNAsStrings, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_INF_AND_NA_N_AS_STRINGS]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_datetimeFractionalSecondPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_DATETIME_FRACTIONAL_SECOND_PRECISION]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_maxFloatPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_FLOAT_PRECISION]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_maxDoublePrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_DOUBLE_PRECISION]);
    if (ret) {
        return ret;
    }
 
    ret = manipulator(&d_encodeQuotedDecimal64, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_QUOTED_DECIMAL64]);
    if (ret) {
        return ret;
    }
 
    return ret;
}
 
template <class MANIPULATOR>
int EncoderOptions::manipulateAttribute(MANIPULATOR& manipulator, int id)
{
    enum { NOT_FOUND = -1 };
 
    switch (id) {
      case ATTRIBUTE_ID_INITIAL_INDENT_LEVEL: {
        return manipulator(&d_initialIndentLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_INITIAL_INDENT_LEVEL]);
      } break;
      case ATTRIBUTE_ID_SPACES_PER_LEVEL: {
        return manipulator(&d_spacesPerLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_SPACES_PER_LEVEL]);
      } break;
      case ATTRIBUTE_ID_ENCODING_STYLE: {
        return manipulator(&d_encodingStyle, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODING_STYLE]);
      } break;
      case ATTRIBUTE_ID_ENCODE_EMPTY_ARRAYS: {
        return manipulator(&d_encodeEmptyArrays, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_EMPTY_ARRAYS]);
      } break;
      case ATTRIBUTE_ID_ENCODE_NULL_ELEMENTS: {
        return manipulator(&d_encodeNullElements, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_NULL_ELEMENTS]);
      } break;
      case ATTRIBUTE_ID_ENCODE_INF_AND_NA_N_AS_STRINGS: {
        return manipulator(&d_encodeInfAndNaNAsStrings, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_INF_AND_NA_N_AS_STRINGS]);
      } break;
      case ATTRIBUTE_ID_DATETIME_FRACTIONAL_SECOND_PRECISION: {
        return manipulator(&d_datetimeFractionalSecondPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_DATETIME_FRACTIONAL_SECOND_PRECISION]);
      } break;
      case ATTRIBUTE_ID_MAX_FLOAT_PRECISION: {
        return manipulator(&d_maxFloatPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_FLOAT_PRECISION]);
      } break;
      case ATTRIBUTE_ID_MAX_DOUBLE_PRECISION: {
        return manipulator(&d_maxDoublePrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_DOUBLE_PRECISION]);
      } break;
      case ATTRIBUTE_ID_ENCODE_QUOTED_DECIMAL64: {
        return manipulator(&d_encodeQuotedDecimal64, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_QUOTED_DECIMAL64]);
      } break;
      default:
        return NOT_FOUND;
    }
}
 
template <class MANIPULATOR>
int EncoderOptions::manipulateAttribute(
        MANIPULATOR&  manipulator,
        const char   *name,
        int           nameLength)
{
    enum { NOT_FOUND = -1 };
 
    const bdlat_AttributeInfo *attributeInfo =
           lookupAttributeInfo(name, nameLength);
    if (0 == attributeInfo) {
        return NOT_FOUND;
    }
 
    return manipulateAttribute(manipulator, attributeInfo->d_id);
}
 
inline
void EncoderOptions::setInitialIndentLevel(int value)
{
    BSLS_ASSERT(0 <= value);
 
    d_initialIndentLevel = value;
}
 
inline
void EncoderOptions::setSpacesPerLevel(int value)
{
    BSLS_ASSERT(0 <= value);
 
    d_spacesPerLevel = value;
}
 
inline
void EncoderOptions::setEncodingStyle(baljsn::EncodingStyle::Value value)
{
    d_encodingStyle = value;
}
 
inline
void EncoderOptions::setEncodingStyle(
                                   baljsn::EncoderOptions::EncodingStyle value)
{
    d_encodingStyle = static_cast<baljsn::EncodingStyle::Value>(value);
}
 
inline
void EncoderOptions::setEncodeEmptyArrays(bool value)
{
    d_encodeEmptyArrays = value;
}
 
inline
void EncoderOptions::setEncodeNullElements(bool value)
{
    d_encodeNullElements = value;
}
 
inline
void EncoderOptions::setEncodeInfAndNaNAsStrings(bool value)
{
    d_encodeInfAndNaNAsStrings = value;
}
 
inline
void EncoderOptions::setDatetimeFractionalSecondPrecision(int value)
{
    BSLS_ASSERT(0 <= value     );
    BSLS_ASSERT(     value <= 6);
 
    d_datetimeFractionalSecondPrecision = value;
}
 
inline
void EncoderOptions::setMaxFloatPrecision(int value)
{
    d_maxFloatPrecision = value;
}
 
inline
void EncoderOptions::setMaxDoublePrecision(int value)
{
    d_maxDoublePrecision = value;
}
 
inline
void EncoderOptions::setEncodeQuotedDecimal64(bool value)
{
    d_encodeQuotedDecimal64 = value;
}
 
// ACCESSORS
template <class ACCESSOR>
int EncoderOptions::accessAttributes(ACCESSOR& accessor) const
{
    int ret;
 
    ret = accessor(d_initialIndentLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_INITIAL_INDENT_LEVEL]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_spacesPerLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_SPACES_PER_LEVEL]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_encodingStyle, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODING_STYLE]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_encodeEmptyArrays, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_EMPTY_ARRAYS]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_encodeNullElements, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_NULL_ELEMENTS]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_encodeInfAndNaNAsStrings, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_INF_AND_NA_N_AS_STRINGS]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_datetimeFractionalSecondPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_DATETIME_FRACTIONAL_SECOND_PRECISION]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_maxFloatPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_FLOAT_PRECISION]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_maxDoublePrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_DOUBLE_PRECISION]);
    if (ret) {
        return ret;
    }
 
    ret = accessor(d_encodeQuotedDecimal64, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_QUOTED_DECIMAL64]);
    if (ret) {
        return ret;
    }
 
    return ret;
}
 
template <class ACCESSOR>
int EncoderOptions::accessAttribute(ACCESSOR& accessor, int id) const
{
    enum { NOT_FOUND = -1 };
 
    switch (id) {
      case ATTRIBUTE_ID_INITIAL_INDENT_LEVEL: {
        return accessor(d_initialIndentLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_INITIAL_INDENT_LEVEL]);
      } break;
      case ATTRIBUTE_ID_SPACES_PER_LEVEL: {
        return accessor(d_spacesPerLevel, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_SPACES_PER_LEVEL]);
      } break;
      case ATTRIBUTE_ID_ENCODING_STYLE: {
        return accessor(d_encodingStyle, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODING_STYLE]);
      } break;
      case ATTRIBUTE_ID_ENCODE_EMPTY_ARRAYS: {
        return accessor(d_encodeEmptyArrays, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_EMPTY_ARRAYS]);
      } break;
      case ATTRIBUTE_ID_ENCODE_NULL_ELEMENTS: {
        return accessor(d_encodeNullElements, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_NULL_ELEMENTS]);
      } break;
      case ATTRIBUTE_ID_ENCODE_INF_AND_NA_N_AS_STRINGS: {
        return accessor(d_encodeInfAndNaNAsStrings, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_INF_AND_NA_N_AS_STRINGS]);
      } break;
      case ATTRIBUTE_ID_DATETIME_FRACTIONAL_SECOND_PRECISION: {
        return accessor(d_datetimeFractionalSecondPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_DATETIME_FRACTIONAL_SECOND_PRECISION]);
      } break;
      case ATTRIBUTE_ID_MAX_FLOAT_PRECISION: {
        return accessor(d_maxFloatPrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_FLOAT_PRECISION]);
      } break;
      case ATTRIBUTE_ID_MAX_DOUBLE_PRECISION: {
        return accessor(d_maxDoublePrecision, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_MAX_DOUBLE_PRECISION]);
      } break;
      case ATTRIBUTE_ID_ENCODE_QUOTED_DECIMAL64: {
        return accessor(d_encodeQuotedDecimal64, ATTRIBUTE_INFO_ARRAY[ATTRIBUTE_INDEX_ENCODE_QUOTED_DECIMAL64]);
      } break;
      default:
        return NOT_FOUND;
    }
}
 
template <class ACCESSOR>
int EncoderOptions::accessAttribute(
        ACCESSOR&   accessor,
        const char *name,
        int         nameLength) const
{
    enum { NOT_FOUND = -1 };
 
    const bdlat_AttributeInfo *attributeInfo =
          lookupAttributeInfo(name, nameLength);
    if (0 == attributeInfo) {
       return NOT_FOUND;
    }
 
    return accessAttribute(accessor, attributeInfo->d_id);
}
 
inline
int EncoderOptions::initialIndentLevel() const
{
    return d_initialIndentLevel;
}
 
inline
int EncoderOptions::spacesPerLevel() const
{
    return d_spacesPerLevel;
}
 
inline
baljsn::EncoderOptions::EncodingStyle EncoderOptions::encodingStyle() const
{
    return static_cast<baljsn::EncoderOptions::EncodingStyle>(d_encodingStyle);
}
 
inline
bool EncoderOptions::encodeEmptyArrays() const
{
    return d_encodeEmptyArrays;
}
 
inline
bool EncoderOptions::encodeNullElements() const
{
    return d_encodeNullElements;
}
 
inline
bool EncoderOptions::encodeInfAndNaNAsStrings() const
{
    return d_encodeInfAndNaNAsStrings;
}
 
inline
int EncoderOptions::datetimeFractionalSecondPrecision() const
{
    return d_datetimeFractionalSecondPrecision;
}
 
inline
int EncoderOptions::maxFloatPrecision() const
{
    return d_maxFloatPrecision;
}
 
inline
int EncoderOptions::maxDoublePrecision() const
{
    return d_maxDoublePrecision;
}
 
inline
bool EncoderOptions::encodeQuotedDecimal64() const
{
    return d_encodeQuotedDecimal64;
}
 
}  // close package namespace
 
// FREE FUNCTIONS
 
inline
bool baljsn::operator==(
        const baljsn::EncoderOptions& lhs,
        const baljsn::EncoderOptions& rhs)
{
    return  lhs.initialIndentLevel() == rhs.initialIndentLevel()
         && lhs.spacesPerLevel() == rhs.spacesPerLevel()
         && lhs.encodingStyle() == rhs.encodingStyle()
         && lhs.encodeEmptyArrays() == rhs.encodeEmptyArrays()
         && lhs.encodeNullElements() == rhs.encodeNullElements()
         && lhs.encodeInfAndNaNAsStrings() == rhs.encodeInfAndNaNAsStrings()
         && lhs.datetimeFractionalSecondPrecision() == rhs.datetimeFractionalSecondPrecision()
         && lhs.maxFloatPrecision() == rhs.maxFloatPrecision()
         && lhs.maxDoublePrecision() == rhs.maxDoublePrecision()
         && lhs.encodeQuotedDecimal64() == rhs.encodeQuotedDecimal64();
}
 
inline
bool baljsn::operator!=(
        const baljsn::EncoderOptions& lhs,
        const baljsn::EncoderOptions& rhs)
{
    return  lhs.initialIndentLevel() != rhs.initialIndentLevel()
         || lhs.spacesPerLevel() != rhs.spacesPerLevel()
         || lhs.encodingStyle() != rhs.encodingStyle()
         || lhs.encodeEmptyArrays() != rhs.encodeEmptyArrays()
         || lhs.encodeNullElements() != rhs.encodeNullElements()
         || lhs.encodeInfAndNaNAsStrings() != rhs.encodeInfAndNaNAsStrings()
         || lhs.datetimeFractionalSecondPrecision() != rhs.datetimeFractionalSecondPrecision()
         || lhs.maxFloatPrecision() != rhs.maxFloatPrecision()
         || lhs.maxDoublePrecision() != rhs.maxDoublePrecision()
         || lhs.encodeQuotedDecimal64() != rhs.encodeQuotedDecimal64();
}
 
inline
bsl::ostream& baljsn::operator<<(
        bsl::ostream& stream,
        const baljsn::EncoderOptions& rhs)
{
    return rhs.print(stream, 0, -1);
}
 
 
#endif
 
// GENERATED BY BLP_BAS_CODEGEN_3.8.24 Fri Feb 17 12:35:40 2017
// USING bas_codegen.pl -m msg --package baljsn --noExternalization -E --noAggregateConversion baljsn.xsd
// SERVICE VERSION
// ----------------------------------------------------------------------------
// Copyright 2015 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */