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