1 | /** @file
|
---|
2 | * IPRT - Build Configuration Information
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2009 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___iprt_buildconfig_h
|
---|
27 | #define ___iprt_buildconfig_h
|
---|
28 |
|
---|
29 | #include <iprt/cdefs.h>
|
---|
30 | #include <iprt/types.h>
|
---|
31 |
|
---|
32 | RT_C_DECLS_BEGIN
|
---|
33 |
|
---|
34 | /** @defgroup grp_rt_buildconfig RTBldCfg - Build Configuration Information
|
---|
35 | * @ingroup grp_rt
|
---|
36 | * @{
|
---|
37 | */
|
---|
38 |
|
---|
39 | /**
|
---|
40 | * Gets the source code management revision of the IPRT build.
|
---|
41 | * @returns Source code management revision number.
|
---|
42 | */
|
---|
43 | RTDECL(uint32_t) RTBldCfgRevision(void);
|
---|
44 |
|
---|
45 | /**
|
---|
46 | * Gets the source code management revision of the IPRT build.
|
---|
47 | * @returns Read only string containing the revision number.
|
---|
48 | */
|
---|
49 | RTDECL(const char *) RTBldCfgRevisionStr(void);
|
---|
50 |
|
---|
51 | /**
|
---|
52 | * Gets the product version string.
|
---|
53 | *
|
---|
54 | * This will be a string on the form "x.y.z[_string]".
|
---|
55 | *
|
---|
56 | * @returns Read only version string.
|
---|
57 | *
|
---|
58 | * @remarks This is a build time configuration thing that the product using IPRT
|
---|
59 | * will set. It is therefore not any IPRT version, but rather the
|
---|
60 | * version of that product.
|
---|
61 | */
|
---|
62 | RTDECL(const char *) RTBldCfgVersion(void);
|
---|
63 |
|
---|
64 | /**
|
---|
65 | * Gets the major product version number.
|
---|
66 | * @returns Major product version number.
|
---|
67 | * @remarks See RTBldCfgVersion.
|
---|
68 | */
|
---|
69 | RTDECL(uint32_t) RTBldCfgVersionMajor(void);
|
---|
70 |
|
---|
71 | /**
|
---|
72 | * Gets the minor product version number.
|
---|
73 | * @returns Minor product version number.
|
---|
74 | * @remarks See RTBldCfgVersion.
|
---|
75 | */
|
---|
76 | RTDECL(uint32_t) RTBldCfgVersionMinor(void);
|
---|
77 |
|
---|
78 | /**
|
---|
79 | * Gets the product build number.
|
---|
80 | * @returns Product build number.
|
---|
81 | * @remarks See RTBldCfgVersion.
|
---|
82 | */
|
---|
83 | RTDECL(uint32_t) RTBldCfgVersionBuild(void);
|
---|
84 |
|
---|
85 | /**
|
---|
86 | * Gets the build target name.
|
---|
87 | *
|
---|
88 | * @returns Read only build target string.
|
---|
89 | */
|
---|
90 | RTDECL(const char *) RTBldCfgTarget(void);
|
---|
91 |
|
---|
92 | /**
|
---|
93 | * Gets the build target architecture name.
|
---|
94 | *
|
---|
95 | * @returns Read only build target architecture string.
|
---|
96 | */
|
---|
97 | RTDECL(const char *) RTBldCfgTargetArch(void);
|
---|
98 |
|
---|
99 | /**
|
---|
100 | * Gets the build target-dot-architecture name.
|
---|
101 | *
|
---|
102 | * @returns Read only build target-dot-architecture string.
|
---|
103 | */
|
---|
104 | RTDECL(const char *) RTBldCfgTargetDotArch(void);
|
---|
105 |
|
---|
106 | /**
|
---|
107 | * Gets the build type name.
|
---|
108 | *
|
---|
109 | * @returns Read only build type string.
|
---|
110 | */
|
---|
111 | RTDECL(const char *) RTBldCfgType(void);
|
---|
112 |
|
---|
113 |
|
---|
114 | /** @} */
|
---|
115 |
|
---|
116 | RT_C_DECLS_END
|
---|
117 |
|
---|
118 | #endif
|
---|
119 |
|
---|