bslfwd.h

Go to the documentation of this file.

/// @file bslfwd.h
///
///
/// @defgroup bslfwd Package bslfwd
/// @brief  Basic Standard Library System ForWarding Declarations (bslfwd)
/// @addtogroup bsl
/// @{
/// @addtogroup bslfwd
/// [bslfwd]: group__bslfwd.html
/// @{
///
/// # Purpose {#bslfwd-purpose}
/// Provide compatibility for clients using single-level namespace
///
/// @deprecated  Do not use.
///
/// # Mnemonic {#bslfwd-mnemonic}
/// Basic Standard Library System ForWarding Declarations (bslfwd)
///
/// # Description {#bslfwd-description}
/// Each component of this package provides a code snippet defining a
/// forward reference to a corresponding type within 'bsl' (e.g.,
/// 'bslfwd_bslma_allocator' defines a forward reference to the type defined in
/// @ref bslma_allocator ).  If 'BSLFWD_BUILDTARGET_BSL_USING_NAMESPACES' is defined,
/// the forward declaration will refer the 'bsl' type in the two-level namespace;
/// otherwise, it will refer to the type in the legacy single-level namespace
/// (e.g., 'bslma::Allocator' versus 'bslma_Allocator', both in the 'BloombergLP'
/// namespace).
///
/// The components in this package are provided to provide backward compatibility
/// for existing clients.  All new code must be written using the two-level
/// namespace for 'bsl' types.
///
/// ## Hierarchical Synopsis
///
/// The 'bslfwd' package currently has 8 components having 2 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// The order of components within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  2. bslfwd_bslma_allocator                              !DEPRECATED!
///     bslfwd_bslma_default                                !DEPRECATED!
///     bslfwd_bslma_defaultallocatorguard                  !DEPRECATED!
///     bslfwd_bslmf_nil                                    !DEPRECATED!
///     bslfwd_bsls_asserttestexception                     !DEPRECATED!
///     bslfwd_bsls_stopwatch                               !DEPRECATED!
///     bslfwd_bsls_types                                   !DEPRECATED!
///
///  1. bslfwd_buildtarget                                  !DEPRECATED! !PRIVATE!
/// @endcode
///
/// ## Component Synopsis
///
///  'bslfwd_bslma_allocator':                              !DEPRECATED!
///       Provide a forward-declaration for the corresponding BDE type.
/// 
///  'bslfwd_bslma_default':                                !DEPRECATED!
///       Provide a forward-declaration for the corresponding BDE type.
/// 
///  'bslfwd_bslma_defaultallocatorguard':                  !DEPRECATED!
///       Provide a forward-declaration for the corresponding BDE type.
/// 
///  'bslfwd_bslmf_nil':                                    !DEPRECATED!
///       Provide a forward-declaration for the corresponding BDE type.
/// 
///  'bslfwd_bsls_asserttestexception':                     !DEPRECATED!
///       Provide a forward-declaration for the corresponding BDE type.
/// 
///  'bslfwd_bsls_stopwatch':                               !DEPRECATED!
///       Provide a forward-declaration for the corresponding BDE type.
/// 
///  'bslfwd_bsls_types':                                   !DEPRECATED!
///       Provide a forward-declaration for the corresponding BDE type.
/// 
///  @ref bslfwd_buildtarget :                                  !DEPRECATED! !PRIVATE!
///       Supply a compile-time indicator of whether BSL uses C++ namespaces.
///
/// ## Usage
///
/// See "Updating 'bsl' Clients for Two-Level Namespaces" at
/// 'https://bbiportal.bloomberg.com/BDE/Solutions/BSLFWD.html'
///
/// @}
/** @} */