bdlde_charconvertstatus.h

Go to the documentation of this file.

/// @file bdlde_charconvertstatus.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlde_charconvertstatus.h                                          -*-C++-*-
#ifndef INCLUDED_BDLDE_CHARCONVERTSTATUS
#define INCLUDED_BDLDE_CHARCONVERTSTATUS
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlde_charconvertstatus bdlde_charconvertstatus
/// @brief  Provide masks for interpreting status from charconvert functions.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlde
/// @{
/// @addtogroup bdlde_charconvertstatus
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlde_charconvertstatus-purpose"> Purpose</a>
/// * <a href="#bdlde_charconvertstatus-classes"> Classes </a>
/// * <a href="#bdlde_charconvertstatus-description"> Description </a>
///   * <a href="#bdlde_charconvertstatus-enumerators"> Enumerators </a>
///   * <a href="#bdlde_charconvertstatus-usage"> Usage </a>
///     * <a href="#bdlde_charconvertstatus-example-1-basic-syntax"> Example 1: Basic Syntax </a>
///
/// # Purpose {#bdlde_charconvertstatus-purpose}
/// Provide masks for interpreting status from charconvert functions.
///
/// # Classes {#bdlde_charconvertstatus-classes}
///
/// -  bdlde::CharConvertStatus: namespace for bit-wise mask of charconvert status
///
/// @see  bdlde_charconvertutf16, bdlde_charconvertucs2
///
/// # Description {#bdlde_charconvertstatus-description}
/// This component provides a namespace for the `enum` type
/// `bdlde::CharConvertStatus::Enum`, which enumerates the set of bit-wise masks
/// that can be used to interpret return values from translation functions in
/// components @ref bdlde_charconvertutf16  and @ref bdlde_charconvertucs2 .
///
/// ## Enumerators {#bdlde_charconvertstatus-enumerators}
///
///
/// @code
/// Name                      Description
/// -------------------   ---------------------------------------------
/// k_INVALID_INPUT_BIT   Invalid code points or sequences of bytes / words
///                       were encountered in the input.
/// k_OUT_OF_SPACE_BIT    The space provided for the output was
///                       insufficient for the translation.
/// @endcode
///
/// ## Usage {#bdlde_charconvertstatus-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Basic Syntax {#bdlde_charconvertstatus-example-1-basic-syntax}
///
///
/// The following snippets of code provide a simple illustration of
/// `bdlde::CharConvertStatus` usage.
///
/// First, we create a variable `value` of type `bdlde::CharConvertStatus::Enum`
/// and initialize it with the value 3, which is not a valid value of the
/// `enum`.
/// @code
///     bdlde::CharConvertStatus::Enum value =
///                              bdlde::CharConvertStatus::k_INVALID_INPUT_BIT;
/// @endcode
/// Next, we store a pointer to its ASCII representation in a variable
/// `asciiValue` of type `const char *`:
/// @code
///     const char *asciiValue = bdlde::CharConvertStatus::toAscii(value);
///     assert(0 == bsl::strcmp(asciiValue, "INVALID_INPUT_BIT"));
/// @endcode
/// Finally, we print `value` to `bsl::cout`.
/// @code
///     if (veryVerbose) {
///         bsl::cout << value << bsl::endl;
///     }
/// @endcode
/// This statement produces the following output on `stdout`:
/// @code
/// INVALID_INPUT_BIT
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlde
 * @{
 */
/** @addtogroup bdlde_charconvertstatus
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bsl_iosfwd.h>
 
 
namespace bdlde {
 
                          // ========================
                          // struct CharConvertStatus
                          // ========================
 
/// This `struct` provides a namespace for enumerating the set of mask
/// codes that can be used to interpret `int` return values from translation
/// functions in `bdede`.
///
/// This class:
/// * supports a complete set of *enumeration* operations
///   - except for `bdex` serialization
/// * is `const` *thread-safe*
/// For terminology see @ref bsldoc_glossary .
struct CharConvertStatus {
 
  public:
    // TYPES
    enum Enum {
        k_INVALID_INPUT_BIT = 0x1,      // Invalid code points or sequences of
                                        // bytes or words were encountered in
                                        // the input.
        k_OUT_OF_SPACE_BIT  = 0x2       // The space provided for the output
                                        // was insufficient for the
                                        // translation.
    };
 
  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
    /// `CharConvertStatus::Enum` value.
    static bsl::ostream& print(bsl::ostream&           stream,
                               CharConvertStatus::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 "k_" prefix elided.  For
    /// example:
    /// @code
    /// bsl::cout << CharConvertStatus::toAscii(
    ///                   CharConvertStatus::k_OUT_OF_SPACE_BIT);
    /// @endcode
    /// will print the following on standard output:
    /// @code
    /// OUT_OF_SPACE_BIT
    /// @endcode
    /// 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(CharConvertStatus::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 `bdlde::CharConvertStatus::Enum` value.  Note that
/// this method has the same behavior as
/// @code
/// bdlde::CharConvertStatus::print(stream, value, 0, -1);
/// @endcode
bsl::ostream& operator<<(bsl::ostream&           stream,
                         CharConvertStatus::Enum value);
 
}  // close package namespace
 
// ============================================================================
//                        INLINE FUNCTION DEFINITIONS
// ============================================================================
 
                      // -------------------------------
                      // struct bdlde::CharConvertStatus
                      // -------------------------------
 
// FREE OPERATORS
inline
bsl::ostream& bdlde::operator<<(bsl::ostream&           stream,
                                CharConvertStatus::Enum value)
{
    return CharConvertStatus::print(stream, value, 0, -1);
}
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2018 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */