bdls.h

Go to the documentation of this file.

/// @file bdls.h
///
///
/// @defgroup bdls Package bdls
/// @brief  Basic Development Library System-level utilities (bdls)
/// @addtogroup bdl
/// @{
/// @addtogroup bdls
/// [bdls]: group__bdls.html
/// @{
///
/// # Purpose {#bdls-purpose}
/// Provide platform-independent system-level utilities.
///
/// # Mnemonic {#bdls-mnemonic}
/// Basic Development Library System-level utilities (bdls)
///
/// # Description {#bdls-description}
/// The 'bdls' package provides a suite of components for
/// platform-independent interactions with operating system for the management of
/// memory, files, and pipes.
///
/// ## Hierarchical Synopsis
///
/// The 'bdls' package currently has 14 components having 4 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
///  4. bdls_osutil
///     bdls_pipeutil
///
///  3. bdls_fdstreambuf
///     bdls_filedescriptorguard
///     bdls_processutil
///     bdls_tempdirectoryguard
///
///  2. bdls_filesystemutil
///
///  1. bdls_filesystemutil_transitionaluniximputil                      !PRIVATE!
///     bdls_filesystemutil_uniximputil                                  !PRIVATE!
///     bdls_filesystemutil_unixplatform                                 !PRIVATE!
///     bdls_filesystemutil_windowsimputil                               !PRIVATE!
///     bdls_memoryutil
///     bdls_pathutil
///     bdls_testutil                                       !DEPRECATED!
/// @endcode
///
/// ## Component Synopsis
///
///  @ref bdls_fdstreambuf :
///       Provide a stream buffer initialized with a file descriptor.
/// 
///  @ref bdls_filedescriptorguard :
///       Provide a RAII guard class used to close files.
/// 
///  @ref bdls_filesystemutil :
///       Provide methods for filesystem access with multi-language names.
/// 
///  'bdls_filesystemutil_transitionaluniximputil':                      !PRIVATE!
///       Provide testable `bdls::FilesystemUtil` operations for some Unixes.
/// 
///  'bdls_filesystemutil_uniximputil':                                  !PRIVATE!
///       Provide testable `bdls::FilesystemUtil` operations for some Unixes.
/// 
///  'bdls_filesystemutil_unixplatform':                                 !PRIVATE!
///       Provide Unix timstamp and offset type width detection macros.
/// 
///  'bdls_filesystemutil_windowsimputil':                               !PRIVATE!
///       Provide testable `bdls::FilesystemUtil` operations on Windows.
/// 
///  @ref bdls_memoryutil :
///       Provide a set of portable utilities for memory manipulation.
/// 
///  @ref bdls_osutil :
///       Provide utilities related to the operating system.
/// 
///  @ref bdls_pathutil :
///       Provide portable file path manipulation.
/// 
///  @ref bdls_pipeutil :
///       Provide basic portable named-pipe utilities.
/// 
///  @ref bdls_processutil :
///       Provide basic platform-independent utilities related to processes.
/// 
///  @ref bdls_tempdirectoryguard :
///       Provide a scoped guard that creates a unique temporary directory.
/// 
///  @ref bdls_testutil :                                       !DEPRECATED!
///       Provide test utilities for components in `bdl` and above.
///
/// @}
/** @} */