BDE 4.39.x Production Release
Loading...
Searching...
No Matches
bslfwd.h
Go to the documentation of this file.
1/// @file bslfwd.h
2///
3///
4/// @defgroup bslfwd Package bslfwd
5/// @brief <span style="color: var(--deprecated-color-dark)">DEPRECATED:</span> Basic Standard Library System ForWarding Declarations (bslfwd)
6/// @addtogroup bsl
7/// @{
8/// @addtogroup bslfwd
9/// @{
10/// * <a href="#bslfwd-purpose"> Purpose</a>
11/// * <a href="#bslfwd-mnemonic"> Mnemonic </a>
12/// * <a href="#bslfwd-description"> Description </a>
13/// * <a href="#bslfwd-hierarchical-synopsis"> Hierarchical Synopsis </a>
14/// * <a href="#bslfwd-component-synopsis"> Component Synopsis </a>
15/// * <a href="#bslfwd-usage"> Usage </a>
16///
17/// # Purpose {#bslfwd-purpose}
18/// Provide compatibility for clients using single-level namespace
19///
20/// @deprecated Do not use.
21///
22/// # Mnemonic {#bslfwd-mnemonic}
23/// Basic Standard Library System ForWarding Declarations (bslfwd)
24///
25/// # Description {#bslfwd-description}
26/// Each component of this package provides a code snippet defining a
27/// forward reference to a corresponding type within 'bsl' (e.g.,
28/// @ref bslfwd_bslma_allocator defines a forward reference to the type defined in
29/// @ref bslma_allocator ). If 'BSLFWD_BUILDTARGET_BSL_USING_NAMESPACES' is defined,
30/// the forward declaration will refer the 'bsl' type in the two-level namespace;
31/// otherwise, it will refer to the type in the legacy single-level namespace
32/// (e.g., 'bslma::Allocator' versus 'bslma_Allocator', both in the 'BloombergLP'
33/// namespace).
34///
35/// The components in this package are provided to provide backward compatibility
36/// for existing clients. All new code must be written using the two-level
37/// namespace for 'bsl' types.
38///
39/// ## Hierarchical Synopsis {#bslfwd-hierarchical-synopsis}
40///
41/// The 'bslfwd' package currently has 8 components having 1 level of physical
42/// dependency. The list below shows the hierarchical ordering of the components.
43/// The order of components within each level is not architecturally significant,
44/// just alphabetical.
45/// @code
46/// 1. bslfwd_bslma_allocator !DEPRECATED!
47/// bslfwd_bslma_default !DEPRECATED!
48/// bslfwd_bslma_defaultallocatorguard !DEPRECATED!
49/// bslfwd_bslmf_nil !DEPRECATED!
50/// bslfwd_bsls_asserttestexception !DEPRECATED!
51/// bslfwd_bsls_stopwatch !DEPRECATED!
52/// bslfwd_bsls_types !DEPRECATED!
53/// bslfwd_buildtarget !DEPRECATED! !PRIVATE!
54/// @endcode
55///
56/// ## Component Synopsis {#bslfwd-component-synopsis}
57///
58/// @ref bslfwd_bslma_allocator : !DEPRECATED!
59/// Provide a forward-declaration for the corresponding BDE type.
60///
61/// @ref bslfwd_bslma_default : !DEPRECATED!
62/// Provide a forward-declaration for the corresponding BDE type.
63///
64/// @ref bslfwd_bslma_defaultallocatorguard : !DEPRECATED!
65/// Provide a forward-declaration for the corresponding BDE type.
66///
67/// @ref bslfwd_bslmf_nil : !DEPRECATED!
68/// Provide a forward-declaration for the corresponding BDE type.
69///
70/// @ref bslfwd_bsls_asserttestexception : !DEPRECATED!
71/// Provide a forward-declaration for the corresponding BDE type.
72///
73/// @ref bslfwd_bsls_stopwatch : !DEPRECATED!
74/// Provide a forward-declaration for the corresponding BDE type.
75///
76/// @ref bslfwd_bsls_types : !DEPRECATED!
77/// Provide a forward-declaration for the corresponding BDE type.
78///
79/// @ref bslfwd_buildtarget : !DEPRECATED! !PRIVATE!
80/// Supply a compile-time indicator of whether BSL uses C++ namespaces.
81///
82/// ## Usage {#bslfwd-usage}
83///
84/// See "Updating 'bsl' Clients for Two-Level Namespaces" at
85/// 'https://bbiportal.bloomberg.com/BDE/Solutions/BSLFWD.html'
86///
87/// @}
88/** @} */