blpapi_versioninfo.h

Go to the documentation of this file.

/* Copyright 2012. Bloomberg Finance L.P.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:  The above
 * copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef INCLUDED_BLPAPI_VERSIONINFO
#define INCLUDED_BLPAPI_VERSIONINFO

#ifndef INCLUDED_BLPAPI_CALL
#include <blpapi_call.h>
#endif

#ifndef INCLUDED_BLPAPI_DEFS
#include <blpapi_defs.h>
#endif

#ifndef INCLUDED_BLPAPI_VERSIONMACROS
#include <blpapi_versionmacros.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif // ifdef __cplusplus

BLPAPI_EXPORT
void blpapi_getVersionInfo(int *majorVersion,
        int *minorVersion,
        int *patchVersion,
        int *buildVersion);
BLPAPI_EXPORT
const char *blpapi_getVersionIdentifier(void);
#ifdef __cplusplus
}

#include <ostream>
#include <sstream>
#include <string>

namespace BloombergLP {
namespace blpapi {

class VersionInfo {

  private:
    int d_major;
    int d_minor;
    int d_patch;
    int d_build;

    VersionInfo(int major, int minor, int patch, int build);
  public:
    // CREATORS
    static VersionInfo headerVersion();
    static VersionInfo runtimeVersion();
    VersionInfo();
    // ACCESSORS
    int majorVersion() const;
    int minorVersion() const;
    int patchVersion() const;
    int buildVersion() const;
    static std::string versionIdentifier();
};

std::ostream& operator<<(std::ostream& stream, const VersionInfo& rhs);
//=============================================================================
//                         INLINE FUNCTION DEFINITIONS
//=============================================================================

// -----------------
// class VersionInfo
// -----------------
// CREATORS
inline VersionInfo::VersionInfo(int major, int minor, int patch, int build)
    : d_major(major)
    , d_minor(minor)
    , d_patch(patch)
    , d_build(build)
{
}

inline VersionInfo VersionInfo::headerVersion()
{
    return VersionInfo(BLPAPI_VERSION_MAJOR,
            BLPAPI_VERSION_MINOR,
            BLPAPI_VERSION_PATCH,
            BLPAPI_VERSION_BUILD);
}

inline VersionInfo VersionInfo::runtimeVersion()
{
    int major, minor, patch, build;
    blpapi_getVersionInfo(&major, &minor, &patch, &build);
    return VersionInfo(major, minor, patch, build);
}

inline VersionInfo::VersionInfo()
{
    blpapi_getVersionInfo(&d_major, &d_minor, &d_patch, &d_build);
}

// ACCESSORS
inline int VersionInfo::majorVersion() const { return d_major; }

inline int VersionInfo::minorVersion() const { return d_minor; }

inline int VersionInfo::patchVersion() const { return d_patch; }

inline int VersionInfo::buildVersion() const { return d_build; }

inline std::string VersionInfo::versionIdentifier()
{
    std::ostringstream oss;
    oss << "blpapi-cpp; headers " << headerVersion() << "; runtime "
        << runtimeVersion();
    if (BLPAPI_CALL_AVAILABLE(blpapi_getVersionIdentifier)) {
        oss << '-' << BLPAPI_CALL(blpapi_getVersionIdentifier)();
    }
    return oss.str();
}

inline std::ostream& operator<<(std::ostream& stream, const VersionInfo& rhs)
{
    return stream << rhs.majorVersion() << '.' << rhs.minorVersion() << '.'
                  << rhs.patchVersion() << '.' << rhs.buildVersion();
}

} // close namespace blpapi
} // close namespace BloombergLP

#endif // ifdef __cplusplus

#endif // INCLUDED_BLPAPI_VERSIONINFO