bdls_osutil.h

Go to the documentation of this file.

/// @file bdls_osutil.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdls_osutil.h                                                      -*-C++-*-
#ifndef INCLUDED_BDLS_OSUTIL
#define INCLUDED_BDLS_OSUTIL
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdls_osutil bdls_osutil
/// @brief  Provide utilities related to the operating system.
/// @addtogroup bdl
/// @{
/// @addtogroup bdls
/// @{
/// @addtogroup bdls_osutil
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdls_osutil-purpose"> Purpose</a>
/// * <a href="#bdls_osutil-classes"> Classes </a>
/// * <a href="#bdls_osutil-description"> Description </a>
///   * <a href="#bdls_osutil-usage"> Usage </a>
///     * <a href="#bdls_osutil-example-1-display-os-name-version-and-patch-level"> Example 1: Display OS Name, Version and Patch Level </a>
///
/// # Purpose {#bdls_osutil-purpose}
/// Provide utilities related to the operating system.
///
/// # Classes {#bdls_osutil-classes}
///
/// -  bdls::OsUtil: namespace for operating system information utilities
///
/// @see 
///
/// # Description {#bdls_osutil-description}
/// This component provides a namespace, `bdls::OsUtil`,
/// containing utility functions for retrieving information at runtime about the
/// operating system in which this task is running.
///
/// ## Usage {#bdls_osutil-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Display OS Name, Version and Patch Level {#bdls_osutil-example-1-display-os-name-version-and-patch-level}
///
///
/// The following example demonstrates using `getOsInfo` to obtain information
/// about the operating system at runtime and writing it to the console.
///
/// First, we create strings for the operating system name (`osName`), version
/// (`osVersion`), and patch (`osPatch`), and then call `getOsInfo` to load
/// these strings with values for the operating system the task is executing in:
/// @code
/// bsl::string name;
/// bsl::string version;
/// bsl::string patch;
/// @endcode
/// Then, we use the standard streams to write the operating system version
/// information to the console, or an error message of failure:
/// @code
/// const int rc = bdls::OsUtil::getOsInfo(&name, &version, &patch);
/// if (rc == 0) {
///     bsl::cout << "OS Name: " << name << "\n"
///               << "Version: " << version << "\n"
///               << "Patch:   " << patch << "\n";
/// } else {
///     bsl::cout << "Cannot determine OS name and version\n";
/// }
/// @endcode
/// Finally, the resulting console output on the Red Hat Enterprise Linux Server
/// 5.5 would be
/// @code
/// OS Name: Linux
/// Version: 2.6.18-194.32.1.el5
/// Patch:   #1 SMP Mon Dec 20 10:52:42 EST 2010
/// @endcode
/// On Windows 7 SP1, the display would be
/// @code
/// OS Name: Windows
/// Version: 6.1
/// Patch:   Service Pack 1
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdls
 * @{
 */
/** @addtogroup bdls_osutil
 * @{
 */
 
#include <bsl_string.h>
 
#include <bsls_libraryfeatures.h>
 
#include <string>
 
 
namespace bdls {
 
                               // =============
                               // struct OsUtil
                               // =============
 
/// This `struct` provides a namespace for utility functions retrieving
/// information about the operating system.
///
/// See @ref bdls_osutil 
struct OsUtil {
 
    // CLASS METHODS
 
    /// Load the operating system name, version name and patch name into the
    /// specified `osName`, `osVersion` and `osPatch` respectively.  Return
    /// 0 on success and a non-zero value otherwise.  The loaded values may
    /// represent an emulation provided for the current process (see
    /// "manifest-based behavior" in Windows programming documentation for
    /// an example) and therefore are not suitable for determining supported
    /// features or the real environment/version.  If you need to determine
    /// the presence of certain features please consult the documentation of
    /// the operating systems you need to support.
    static int getOsInfo(bsl::string *osName,
                         bsl::string *osVersion,
                         bsl::string *osPatch);
    static int getOsInfo(std::string *osName,
                         std::string *osVersion,
                         std::string *osPatch);
#ifdef BSLS_LIBRARYFEATURES_HAS_CPP17_PMR_STRING
    static int getOsInfo(std::pmr::string *osName,
                         std::pmr::string *osVersion,
                         std::pmr::string *osPatch);
#endif
};
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2015 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */