BDE 4.39.x Production Release
Loading...
Searching...
No Matches
bdls.h
Go to the documentation of this file.
1/// @file bdls.h
2///
3///
4/// @defgroup bdls Package bdls
5/// @brief Basic Development Library System-level utilities (bdls)
6/// @addtogroup bdl
7/// @{
8/// @addtogroup bdls
9/// @{
10/// * <a href="#bdls-purpose"> Purpose</a>
11/// * <a href="#bdls-mnemonic"> Mnemonic </a>
12/// * <a href="#bdls-description"> Description </a>
13/// * <a href="#bdls-hierarchical-synopsis"> Hierarchical Synopsis </a>
14/// * <a href="#bdls-component-synopsis"> Component Synopsis </a>
15///
16/// # Purpose {#bdls-purpose}
17/// Provide platform-independent system-level utilities.
18///
19/// # Mnemonic {#bdls-mnemonic}
20/// Basic Development Library System-level utilities (bdls)
21///
22/// # Description {#bdls-description}
23/// The 'bdls' package provides a suite of components for
24/// platform-independent interactions with operating system for the management of
25/// memory, files, and pipes.
26///
27/// ## Hierarchical Synopsis {#bdls-hierarchical-synopsis}
28///
29/// The 'bdls' package currently has 14 components having 4 levels of physical
30/// dependency. The list below shows the hierarchical ordering of the components.
31/// The order of components within each level is not architecturally significant,
32/// just alphabetical.
33/// @code
34/// 4. bdls_osutil
35/// bdls_pipeutil
36///
37/// 3. bdls_fdstreambuf
38/// bdls_filedescriptorguard
39/// bdls_processutil
40/// bdls_tempdirectoryguard
41///
42/// 2. bdls_filesystemutil
43///
44/// 1. bdls_filesystemutil_transitionaluniximputil !PRIVATE!
45/// bdls_filesystemutil_uniximputil !PRIVATE!
46/// bdls_filesystemutil_unixplatform !PRIVATE!
47/// bdls_filesystemutil_windowsimputil !PRIVATE!
48/// bdls_memoryutil
49/// bdls_pathutil
50/// bdls_testutil !DEPRECATED!
51/// @endcode
52///
53/// ## Component Synopsis {#bdls-component-synopsis}
54///
55/// @ref bdls_fdstreambuf :
56/// Provide a stream buffer initialized with a file descriptor.
57///
58/// @ref bdls_filedescriptorguard :
59/// Provide a RAII guard class used to close files.
60///
61/// @ref bdls_filesystemutil :
62/// Provide methods for filesystem access with multi-language names.
63///
64/// @ref bdls_filesystemutil_transitionaluniximputil : !PRIVATE!
65/// Provide testable `bdls::FilesystemUtil` operations for some Unixes.
66///
67/// @ref bdls_filesystemutil_uniximputil : !PRIVATE!
68/// Provide testable `bdls::FilesystemUtil` operations for some Unixes.
69///
70/// @ref bdls_filesystemutil_unixplatform : !PRIVATE!
71/// Provide Unix timestamp and offset type width detection macros.
72///
73/// @ref bdls_filesystemutil_windowsimputil : !PRIVATE!
74/// Provide testable `bdls::FilesystemUtil` operations on Windows.
75///
76/// @ref bdls_memoryutil :
77/// Provide a set of portable utilities for memory manipulation.
78///
79/// @ref bdls_osutil :
80/// Provide utilities related to the operating system.
81///
82/// @ref bdls_pathutil :
83/// Provide portable file path manipulation.
84///
85/// @ref bdls_pipeutil :
86/// Provide basic portable named-pipe utilities.
87///
88/// @ref bdls_processutil :
89/// Provide basic platform-independent utilities related to processes.
90///
91/// @ref bdls_tempdirectoryguard :
92/// Provide a scoped guard that creates a unique temporary directory.
93///
94/// @ref bdls_testutil : !DEPRECATED!
95/// Provide test utilities for components in `bdl` and above.
96///
97/// @}
98/** @} */