bdlat_formattingmode.h

Go to the documentation of this file.

/// @file bdlat_formattingmode.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlat_formattingmode.h                                             -*-C++-*-
#ifndef INCLUDED_BDLAT_FORMATTINGMODE
#define INCLUDED_BDLAT_FORMATTINGMODE
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlat_formattingmode bdlat_formattingmode
/// @brief  Provide formatting mode constants.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlat
/// @{
/// @addtogroup bdlat_formattingmode
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlat_formattingmode-purpose"> Purpose</a>
/// * <a href="#bdlat_formattingmode-classes"> Classes </a>
/// * <a href="#bdlat_formattingmode-description"> Description </a>
///   * <a href="#bdlat_formattingmode-original-type"> Original Type (Schema Type) </a>
///   * <a href="#bdlat_formattingmode-formatting-flags"> Formatting Flags </a>
///   * <a href="#bdlat_formattingmode-usage"> Usage </a>
///
/// # Purpose {#bdlat_formattingmode-purpose}
/// Provide formatting mode constants.
///
/// # Classes {#bdlat_formattingmode-classes}
///
/// -  bdlat_FormattingMode: scope for formatting mode constants
///
/// @see  balxml_typesprintutil balxml_typesparserutil
///
/// # Description {#bdlat_formattingmode-description}
/// The `bdlat_FormattingMode` struct provided in this component
/// defines the symbolic constants for all the formatting modes supported by the
/// `bdlat` framework.  The formatting modes are separated into two categories:
/// a bit-field for the original type (i.e., schema type), and a number of
/// flags.
///
/// ## Original Type (Schema Type) {#bdlat_formattingmode-original-type}
///
///
/// This bit-field defines the formatting modes that are derived based on the
/// type of an element, as defined in the schema.  The available modes are:
/// @code
/// Formatting Mode         Description
/// ---------------         -----------
/// e_DEFAULT               Use a default formatting mode.
/// e_DEC                   Use the decimal format.
/// e_HEX                   Use the hexadecimal format.
/// e_BASE64                Use the base64 format.
/// e_TEXT                  Use the text format.
/// @endcode
///
/// ## Formatting Flags {#bdlat_formattingmode-formatting-flags}
///
///
/// The following bitwise flags can be applied to a schema element:
/// @code
/// Formatting Mode         Description
/// ---------------         -----------
/// e_UNTAGGED              Use untagged formatting (for anonymous choices).
/// e_ATTRIBUTE             Use attribute formatting (for XSD attributes).
/// e_SIMPLE_CONTENT        Use simple content formatting (for XSD simple
///                         content types).
/// e_NILLABLE              Use nillable formatting (for XSD `nillable`
///                         option).
/// e_LIST                  Use the list format (this is used for arrays).
/// e_DEFAULT_VALUE         `default` attribute is specified for the
///                         corresponding `<xs:element>`.
/// @endcode
///
/// ## Usage {#bdlat_formattingmode-usage}
///
///
/// Due to the low-level nature of this component, a usage example is not
/// necessary.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlat
 * @{
 */
/** @addtogroup bdlat_formattingmode
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bdlat_bdeatoverrides.h>
 
 
 
/// This struct contains the symbolic constants for the formatting modes
/// supported by the `bdlat` framework.
///
/// See @ref bdlat_formattingmode 
struct bdlat_FormattingMode {
 
    // CONSTANTS
    enum {
        // bit-field: original type (i.e., schema type)
        e_DEFAULT   = 0x0,  // default formatting mode
        e_DEC       = 0x1,  // use decimal format
        e_HEX       = 0x2,  // use hexadecimal format
        e_BASE64    = 0x3,  // use base64 format
        e_TEXT      = 0x4,  // use text format
        e_TYPE_MASK = 0x7,  // mask for type bit-field
 
        // formatting flags
        e_UNTAGGED       = 0x00010000,  // use untagged formatting
        e_ATTRIBUTE      = 0x00020000,  // use attribute formatting
        e_SIMPLE_CONTENT = 0x00040000,  // use simple content formatting
        e_NILLABLE       = 0x00080000,  // use nillable formatting
        e_LIST           = 0x00100000,  // use list format (for arrays)
        e_DEFAULT_VALUE  = 0x00200000,  // has default value in XSD
        e_FLAGS_MASK     = 0x003F0000   // mask for formatting flags
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
      , DEFAULT           = e_DEFAULT
      , DEC               = e_DEC
      , HEX               = e_HEX
      , BASE64            = e_BASE64
      , TEXT              = e_TEXT
      , TYPE_MASK         = e_TYPE_MASK
      , IS_UNTAGGED       = e_UNTAGGED
      , IS_ATTRIBUTE      = e_ATTRIBUTE
      , IS_SIMPLE_CONTENT = e_SIMPLE_CONTENT
      , IS_NILLABLE       = e_NILLABLE
      , IS_LIST           = e_LIST
      , FLAGS_MASK        = e_FLAGS_MASK
 
      , BDEAT_DEFAULT           = e_DEFAULT
      , BDEAT_DEC               = e_DEC
      , BDEAT_HEX               = e_HEX
      , BDEAT_BASE64            = e_BASE64
      , BDEAT_TEXT              = e_TEXT
      , BDEAT_TYPE_MASK         = e_TYPE_MASK
      , BDEAT_UNTAGGED          = e_UNTAGGED
      , BDEAT_ATTRIBUTE         = e_ATTRIBUTE
      , BDEAT_SIMPLE_CONTENT    = e_SIMPLE_CONTENT
      , BDEAT_NILLABLE          = e_NILLABLE
      , BDEAT_LIST              = e_LIST
      , BDEAT_DEFAULT_VALUE     = e_DEFAULT_VALUE
      , BDEAT_FLAGS_MASK        = e_FLAGS_MASK
      , BDEAT_IS_UNTAGGED       = e_UNTAGGED
      , BDEAT_IS_ATTRIBUTE      = e_ATTRIBUTE
      , BDEAT_IS_SIMPLE_CONTENT = e_SIMPLE_CONTENT
      , BDEAT_IS_NILLABLE       = e_NILLABLE
      , BDEAT_IS_LIST           = e_LIST
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
    };
};
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */