ball_severityutil.h

Go to the documentation of this file.

/// @file ball_severityutil.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// ball_severityutil.h                                                -*-C++-*-
#ifndef INCLUDED_BALL_SEVERITYUTIL
#define INCLUDED_BALL_SEVERITYUTIL
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup ball_severityutil ball_severityutil
/// @brief  Provide a suite of utility functions on `ball::Severity` levels.
/// @addtogroup bal
/// @{
/// @addtogroup ball
/// @{
/// @addtogroup ball_severityutil
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#ball_severityutil-purpose"> Purpose</a>
/// * <a href="#ball_severityutil-classes"> Classes </a>
/// * <a href="#ball_severityutil-description"> Description </a>
///   * <a href="#ball_severityutil-synopsis"> Synopsis </a>
///   * <a href="#ball_severityutil-usage"> Usage </a>
///     * <a href="#ball_severityutil-example-1-basic-usage"> Example 1: Basic Usage </a>
///
/// # Purpose {#ball_severityutil-purpose}
/// Provide a suite of utility functions on `ball::Severity` levels.
///
/// # Classes {#ball_severityutil-classes}
///
/// -  ball::SeverityUtil: namespace for functions on `ball::Severity::Level`
///
/// @see  ball_severity
///
/// # Description {#ball_severityutil-description}
/// This component provides a suite of pure procedures that apply
/// to the `ball::Severity::Level` enumeration.  In particular, the
/// `ball::SeverityUtil` `struct` provides a `fromAsciiCaseless` function that
/// returns the `ball::Severity::Level` enumerator value corresponding to a
/// given ASCII string (without regard to the case of the characters in the
/// string) and an `isValidNameCaseless` function that confirms that a given
/// string corresponds to one of the enumerators in the `ball::Severity::Level`
/// enumeration (similarly, without regard to the case of the characters in the
/// string).
///
/// ## Synopsis {#ball_severityutil-synopsis}
///
///
/// The following is a list of functions available in this component:
/// @code
/// static int  ball::SeverityUtil::fromAsciiCaseless(
///                                             ball::Severity::Level *level,
///                                             const char            *name);
///
/// static bool ball::SeverityUtil::isValidNameCaseless(const char *name);
/// @endcode
///
/// ## Usage {#ball_severityutil-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Basic Usage {#ball_severityutil-example-1-basic-usage}
///
///
/// In this example, we show how to validate that a set of C-style strings
/// correspond to `ball::Severity::Level` enumerators, and then use those
/// strings to generate enumerator values that, in turn, may be used to
/// administer a logger manager.  Here, for convenience, we define our strings
/// in an array, much as how we might receive them from a command line:
/// @code
/// const char *argv[] = {
///     "INFO",   // record
///     "WARN",   // pass
///     "ERROR",  // trigger
///     "FATAL"   // trigger-all
/// };
///
/// assert(ball::SeverityUtil::isValidNameCaseless(argv[0]));
/// assert(ball::SeverityUtil::isValidNameCaseless(argv[1]));
/// assert(ball::SeverityUtil::isValidNameCaseless(argv[2]));
/// assert(ball::SeverityUtil::isValidNameCaseless(argv[3]));
///
/// ball::Severity::Level record;
/// ball::Severity::Level pass;
/// ball::Severity::Level trigger;
/// ball::Severity::Level triggerAll;
///
/// assert(0 == ball::SeverityUtil::fromAsciiCaseless(&record,     argv[0]));
/// assert(0 == ball::SeverityUtil::fromAsciiCaseless(&pass,       argv[1]));
/// assert(0 == ball::SeverityUtil::fromAsciiCaseless(&trigger,    argv[2]));
/// assert(0 == ball::SeverityUtil::fromAsciiCaseless(&triggerAll, argv[3]));
///
/// assert(ball::Severity::e_INFO  == record);
/// assert(ball::Severity::e_WARN  == pass);
/// assert(ball::Severity::e_ERROR == trigger);
/// assert(ball::Severity::e_FATAL == triggerAll);
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bal
 * @{
 */
/** @addtogroup ball
 * @{
 */
/** @addtogroup ball_severityutil
 * @{
 */
 
#include <balscm_version.h>
 
#include <ball_severity.h>
 
 
namespace ball {
 
                        // ===================
                        // struct SeverityUtil
                        // ===================
 
/// This `struct` provides a namespace for non-primitive procedures on the
/// `Severity::Level` enumeration.
///
/// See @ref ball_severityutil 
struct SeverityUtil {
 
    // CLASS METHODS
 
    /// Load into the specified `level` the value of the `Severity::Level`
    /// enumerator corresponding to the specified `name` (without regard to
    /// the case of the characters in `name`).  Return 0 on success, and a
    /// non-zero value with no effect on `level` otherwise.  
    /// 
    /// \pre The behavior is undefined   unless `level` is non-null and `name` is a null-terminated (C-style) string.  
    /// 
    /// \note Note that   this procedure will fail unless
    /// `isValidName(name)` is 'true.
    static int fromAsciiCaseless(Severity::Level *level, const char *name);
 
    /// Return `true` if the specified `name` corresponds to an enumerator
    /// in the `Severity::Level` enumeration (without regard to the
    /// characters in `name`), and `false` otherwise.  
    /// 
    /// \pre The behavior is undefined   unless `name` is a null-terminated (C-style) string.  
    /// 
    /// \note Note that   the names corresponding to `Severity::Level` enumerators are
    /// case *insensitive*.
    static bool isValidNameCaseless(const char *name);
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
    /// Load into the specified `level` the value of the `Severity::Level`
    /// enumerator corresponding to the specified `name` (without regard to
    /// the case of the characters in `name`).  Return 0 on success, and a
    /// non-zero value with no effect on `level` otherwise.  
    /// 
    /// \pre The behavior is undefined   unless `level` is non-null and `name` is a null-terminated (C-style) string.  
    /// 
    /// \note Note that   this procedure will fail unless
    /// `isValidName(name)` is `true`.
    ///
    /// @deprecated  Use @ref fromAsciiCaseless instead.
    static int fromAscii(Severity::Level *level, const char *name);
 
    /// Return `true` if the specified `name` corresponds to an enumerator
    /// in the `Severity::Level` enumeration, and `false` otherwise.  
    /// 
    /// \pre The behavior is undefined   unless `name` is a null-terminated (C-style) string.  
    /// 
    /// \note Note that   the names corresponding to `Severity::Level`
    /// enumerators are case *insensitive*.
    ///
    /// @deprecated  Use @ref isValidNameCaseless instead.
    static bool isValidName(const char *name);
#endif // BDE_OMIT_INTERNAL_DEPRECATED
};
 
// ============================================================================
//                              INLINE DEFINITIONS
// ============================================================================
 
                        // -------------------
                        // struct SeverityUtil
                        // -------------------
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
// CLASS METHODS
inline
int SeverityUtil::fromAscii(Severity::Level *level, const char *name)
{
    return fromAsciiCaseless(level, name);
}
 
inline
bool SeverityUtil::isValidName(const char *name)
{
    return isValidNameCaseless(name);
}
#endif // BDE_OMIT_INTERNAL_DEPRECATED
 
}  // close package namespace
 
 
#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 ----------------------------------
 
/** @} */
/** @} */
/** @} */