bslstl_badweakptr.h

Go to the documentation of this file.

/// @file bslstl_badweakptr.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslstl_badweakptr.h                                                -*-C++-*-
#ifndef INCLUDED_BSLSTL_BADWEAKPTR
#define INCLUDED_BSLSTL_BADWEAKPTR
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslstl_badweakptr bslstl_badweakptr
/// @brief  Provide an exception class to indicate a weak_ptr has expired.
/// @addtogroup bsl
/// @{
/// @addtogroup bslstl
/// @{
/// @addtogroup bslstl_badweakptr
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslstl_badweakptr-purpose"> Purpose</a>
/// * <a href="#bslstl_badweakptr-classes"> Classes </a>
/// * <a href="#bslstl_badweakptr-description"> Description </a>
///   * <a href="#bslstl_badweakptr-usage"> Usage </a>
///     * <a href="#bslstl_badweakptr-example-1-tbd"> Example 1: TBD </a>
///
/// # Purpose {#bslstl_badweakptr-purpose}
/// Provide an exception class to indicate a weak_ptr has expired.
///
/// # Classes {#bslstl_badweakptr-classes}
///
/// -  bslstl::BadWeakPtr: exception class derived from `std` classes
/// -  bsl::bad_weak_ptr: alias to an exception type thrown by the `bsl` library
///
/// **Canonical header:**  bsl_memory.h
///
/// @see  bslstl_sharedptr, bslstl_stdexceptionutil
///
/// # Description {#bslstl_badweakptr-description}
/// This component provides ...
///
/// ## Usage {#bslstl_badweakptr-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: TBD {#bslstl_badweakptr-example-1-tbd}
///
///
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslstl
 * @{
 */
/** @addtogroup bslstl_badweakptr
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bsls_exceptionutil.h>
#include <bsls_keyword.h>
 
#include <exception>
 
#include <memory>                // 'std::bad_weak_ptr' if defined
 
#ifndef BDE_DONT_ALLOW_TRANSITIVE_INCLUDES
#include <bsls_nativestd.h>
#endif // BDE_DONT_ALLOW_TRANSITIVE_INCLUDES
 
 
namespace bslstl { class BadWeakPtr; }
 
 
namespace bsl {
#if 0
typedef std::bad_weak_ptr bad_weak_ptr;
#else
typedef ::BloombergLP::bslstl::BadWeakPtr bad_weak_ptr;
#endif
 
}  // close namespace bsl
 
 
 
namespace bslstl {
 
                       // ================
                       // class BadWeakPtr
                       // ================
 
class BadWeakPtr : public std::exception {
  public:
    /// Create a `BadWeakPtr` object.  Note that this function is explicitly
    /// user-declared, to make it simple to declare `const` objects of this
    /// type.
    BadWeakPtr() BSLS_KEYWORD_NOEXCEPT;
 
    /// Destroy this object.
    ~BadWeakPtr() BSLS_EXCEPTION_VIRTUAL_NOTHROW BSLS_KEYWORD_OVERRIDE;
 
    // ACCESSORS
 
    /// Return a pointer to the string literal "bad_weak_ptr", with a
    /// storage duration of the lifetime of the program.  Note that the
    /// caller should *not* attempt to free this memory.  Note that the
    /// @ref bsls_exceptionutil  macro `BSLS_NOTHROW_SPEC` is deliberately not
    /// used here, as a number of standard libraries declare `what` in the
    /// base `exception` class explicitly with the no-throw specification,
    /// even in a build that may not recognize exceptions.
    const char *what() const BSLS_EXCEPTION_VIRTUAL_NOTHROW
                                                         BSLS_KEYWORD_OVERRIDE;
};
 
// ============================================================================
//                           INLINE DEFINITIONS
// ============================================================================
 
                       // ----------------
                       // class BadWeakPtr
                       // ----------------
 
// CREATORS
inline
BadWeakPtr::BadWeakPtr() BSLS_KEYWORD_NOEXCEPT
: std::exception()
{
}
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2013 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */