/** @file
* IPRT - Build Configuration Information
*/
/*
* Copyright (C) 2009-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___iprt_buildconfig_h
#define ___iprt_buildconfig_h
/** @defgroup grp_rt_buildconfig RTBldCfg - Build Configuration Information
* @ingroup grp_rt
* @{
*/
/**
* Gets the source code management revision of the IPRT build.
* @returns Source code management revision number.
*/
/**
* Gets the source code management revision of the IPRT build.
* @returns Read only string containing the revision number.
*/
RTDECL(const char *) RTBldCfgRevisionStr(void);
/**
* Gets the product version string.
*
* This will be a string on the form "x.y.z[_string]".
*
* @returns Read only version string.
*
* @remarks This is a build time configuration thing that the product using IPRT
* will set. It is therefore not any IPRT version, but rather the
* version of that product.
*/
RTDECL(const char *) RTBldCfgVersion(void);
/**
* Gets the major product version number.
* @returns Major product version number.
* @remarks See RTBldCfgVersion.
*/
/**
* Gets the minor product version number.
* @returns Minor product version number.
* @remarks See RTBldCfgVersion.
*/
/**
* Gets the product build number.
* @returns Product build number.
* @remarks See RTBldCfgVersion.
*/
/**
* Gets the build target name.
*
* @returns Read only build target string.
*/
RTDECL(const char *) RTBldCfgTarget(void);
/**
* Gets the build target architecture name.
*
* @returns Read only build target architecture string.
*/
RTDECL(const char *) RTBldCfgTargetArch(void);
/**
* Gets the build target-dot-architecture name.
*
* @returns Read only build target-dot-architecture string.
*/
RTDECL(const char *) RTBldCfgTargetDotArch(void);
/**
* Gets the build type name.
*
* @returns Read only build type string.
*/
RTDECL(const char *) RTBldCfgType(void);
/**
* Gets the name of the compiler used for building IPRT.
*
* @returns Read only compiler name.
*/
RTDECL(const char *) RTBldCfgCompiler(void);
/** @} */
#endif