bdlde_base64alphabet.h

Go to the documentation of this file.

/// @file bdlde_base64alphabet.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlde_base64alphabet.h                                             -*-C++-*-
 
#ifndef INCLUDED_BDLDE_BASE64ALPHABET
#define INCLUDED_BDLDE_BASE64ALPHABET
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlde_base64alphabet bdlde_base64alphabet
/// @brief  Provide an enumeration of the set of possible base 64 alphabets.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlde
/// @{
/// @addtogroup bdlde_base64alphabet
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlde_base64alphabet-purpose"> Purpose</a>
/// * <a href="#bdlde_base64alphabet-classes"> Classes </a>
/// * <a href="#bdlde_base64alphabet-description"> Description </a>
///   * <a href="#bdlde_base64alphabet-enumerators"> Enumerators </a>
///   * <a href="#bdlde_base64alphabet-usage"> Usage </a>
///     * <a href="#bdlde_base64alphabet-example-1-basic-usage"> Example 1: Basic Usage </a>
///
/// # Purpose {#bdlde_base64alphabet-purpose}
/// Provide an enumeration of the set of possible base 64 alphabets.
///
/// # Classes {#bdlde_base64alphabet-classes}
///
/// -  bdlde::Base64Alphabet: namespace for an alphabet `enum`
///
/// @see  bdlde_base64encoderoptions, bdlde_base64decoderoptions,
///           bdlde_base64encoder,        bdlde_base64decoder
///
/// # Description {#bdlde_base64alphabet-description}
/// This component provides a namespace for the `enum` type
/// `bdlde::Base64Alphabet::Enum`, which enumerates the set of possible
/// alphabets.
///
/// ## Enumerators {#bdlde_base64alphabet-enumerators}
///
///
///
/// | Name            | Description |
/// | --------------- | ----------- |
/// | e_BASIC         |  standard base64 alphabet |
/// | e_URL           |  URL-safe base64 alphabet |
///
///
/// ## Usage {#bdlde_base64alphabet-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Basic Usage {#bdlde_base64alphabet-example-1-basic-usage}
///
///
/// The following snippets of code provide a simple illustration of
/// `bdlde::Base64Alphabet` usage.
///
/// First, we create variable of type `bdlde::Base64Alphabet::Enum` and
/// initialize it with the enumerator values:
/// @code
/// const bdlde::Base64Alphabet::Enum basic = bdlde::Base64Alphabet::e_BASIC;
/// const bdlde::Base64Alphabet::Enum url   = bdlde::Base64Alphabet::e_URL;
/// @endcode
/// Next, we store a pointer to their ASCII representation in variables of type
/// `const char *`:
/// @code
/// const char *asciiBasic = bdlde::Base64Alphabet::toAscii(basic);
/// const char *asciiUrl   = bdlde::Base64Alphabet::toAscii(url);
/// assert(0 == bsl::strcmp(asciiBasic, "BASIC"));
/// assert(0 == bsl::strcmp(asciiUrl,   "URL"));
/// @endcode
///  Now, we stream some `Enum`s to `ostream`s:
/// @code
/// bsl::ostringstream ossBasic, ossUrl;
///
/// ossBasic << basic;
/// ossUrl   << url;
/// @endcode
/// Finally, we observe the output of the streaming:
/// @code
/// assert(ossBasic.str() == "BASIC");
/// assert(ossUrl.str()   == "URL");
///
/// assert(ossBasic.str() == asciiBasic);
/// assert(ossUrl.str()   == asciiUrl);
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlde
 * @{
 */
/** @addtogroup bdlde_base64alphabet
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bsls_platform.h>
 
#include <bsl_iosfwd.h>
 
 
namespace bdlde {
 
                            // =====================
                            // struct Base64Alphabet
                            // =====================
 
/// This `struct` provides a namespace for enumerating the set of alphabets.
/// See `Enum` in the TYPES sub-section for details.
///
/// This class:
/// * supports a complete set of *enumeration* operations
///   - except for `bdex` serialization
/// For terminology see @ref bsldoc_glossary .
struct Base64Alphabet {
 
  public:
    // TYPES
    enum Enum {
        e_BASIC,
        e_URL
    };
 
  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
    /// `ByteOrder::Enum` value.
    static bsl::ostream& print(bsl::ostream& stream,
                               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 the
    /// name of its corresponding base enumeration with the "e_" prefix
    /// elided.  For example:
    /// @code
    /// bsl::cout << ByteOrder::toAscii(ByteOrder::e_URL);
    /// @endcode
    /// will print the following on standard output:
    /// @code
    /// URL
    /// @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(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::Base64Alphabet::Enum` value.  Note that this
/// method has the same behavior as
/// @code
/// bdlde::Base64Alphabet::print(stream, value, 0, -1);
/// @endcode
bsl::ostream& operator<<(bsl::ostream& stream, Base64Alphabet::Enum value);
 
}  // close package namespace
 
 
#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 ----------------------------------
 
/** @} */
/** @} */
/** @} */