bsls_int64.h

Go to the documentation of this file.

/// @file bsls_int64.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bsls_int64.h                                                       -*-C++-*-
#ifndef INCLUDED_BSLS_INT64
#define INCLUDED_BSLS_INT64
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bsls_int64 bsls_int64
/// @brief  Provide namespace for platform-dependent 64-bit integer types.
/// @addtogroup bsl
/// @{
/// @addtogroup bsls
/// @{
/// @addtogroup bsls_int64
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bsls_int64-purpose"> Purpose</a>
/// * <a href="#bsls_int64-classes"> Classes </a>
/// * <a href="#bsls_int64-description"> Description </a>
///   * <a href="#bsls_int64-usage"> Usage </a>
///
/// # Purpose {#bsls_int64-purpose}
/// Provide namespace for platform-dependent 64-bit integer types.
///
/// @deprecated  Use component @ref bsls_types  instead.
///
/// # Classes {#bsls_int64-classes}
///
/// -  bsls_Int64: namespace for platform-dependent 64-bit integer types
///
/// # Description {#bsls_int64-description}
/// This component provides platform-independent type names for
/// both signed and unsigned 64 bit integers.  For healthy platforms, the
/// component simply provides a BDE-standard `typedef` for the non-standard
/// native type name.  For defective platforms or compilers, a bde-relevant
/// subset of the needed functionality can be implemented.
///
/// The types (and platform-specific `typedef`s) exposed here are intended for
/// use by @ref bsls_platformutil  only (and not directly by any other client).
/// This component exists to factor out various pathologies, present and future,
/// with 64-bit integers.
///
/// **WARNING** If a given platform has a defective native 64-bit integer type,
/// then there is no guarantee that the types supplied here will be suitable
/// *except* as they are explicitly used by other BDE components.  If a user
/// encounters problems with the types, please contact the author or a BDE
/// library maintenance engineer.
///
/// ## Usage {#bsls_int64-usage}
///
///
/// Do not use this component; use @ref bsls_types  instead.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bsls
 * @{
 */
/** @addtogroup bsls_int64
 * @{
 */
 
#ifdef BDE_OPENSOURCE_PUBLICATION // DEPRECATED
#error "bsls_int64 is deprecated"
#endif
#include <bsls_platform.h>
#include <bsls_types.h>
 
 
 
                          // =================
                          // struct bsls_Int64
                          // =================
 
/// Provide a namespace for the implementations of platform-neutral 64-bit
/// integers.  Namely, this `struct` defines `Int64` as a 64-bit signed
/// integer and `Uint64` as a 64-bit unsigned integer for all supported
/// platforms.
struct bsls_Int64 {
 
    // TYPES
    typedef bsls::Types::Int64  Int64;
 
    /// @deprecated  Use @ref bsls::Types::Int64` and `bsls::Types::Uint64,
    /// respectively, instead.
    typedef bsls::Types::Uint64 Uint64;
};
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2013 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */