1 /*************************************************************************************************** 2 3 Zyan Core Library (Zycore-C) 4 5 Original Author : Florian Bernd 6 7 * Permission is hereby granted, free of charge, to any person obtaining a copy 8 * of this software and associated documentation files (the "Software"), to deal 9 * in the Software without restriction, including without limitation the rights 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 * copies of the Software, and to permit persons to whom the Software is 12 * furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in all 15 * copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 * SOFTWARE. 24 25 ***************************************************************************************************/ 26 27 /** 28 * @file 29 * Master include file, including everything else. 30 */ 31 32 #ifndef ZYCORE_H 33 #define ZYCORE_H 34 35 #include <Zycore/Types.h> 36 37 // TODO: 38 39 #ifdef __cplusplus 40 extern "C" { 41 #endif 42 43 /* ============================================================================================== */ 44 /* Macros */ 45 /* ============================================================================================== */ 46 47 /* ---------------------------------------------------------------------------------------------- */ 48 /* Constants */ 49 /* ---------------------------------------------------------------------------------------------- */ 50 51 /** 52 * A macro that defines the zycore version. 53 */ 54 #define ZYCORE_VERSION (ZyanU64)0x0001000500000000 55 56 /* ---------------------------------------------------------------------------------------------- */ 57 /* Helper macros */ 58 /* ---------------------------------------------------------------------------------------------- */ 59 60 /** 61 * Extracts the major-part of the zycore version. 62 * 63 * @param version The zycore version value 64 */ 65 #define ZYCORE_VERSION_MAJOR(version) (ZyanU16)((version & 0xFFFF000000000000) >> 48) 66 67 /** 68 * Extracts the minor-part of the zycore version. 69 * 70 * @param version The zycore version value 71 */ 72 #define ZYCORE_VERSION_MINOR(version) (ZyanU16)((version & 0x0000FFFF00000000) >> 32) 73 74 /** 75 * Extracts the patch-part of the zycore version. 76 * 77 * @param version The zycore version value 78 */ 79 #define ZYCORE_VERSION_PATCH(version) (ZyanU16)((version & 0x00000000FFFF0000) >> 16) 80 81 /** 82 * Extracts the build-part of the zycore version. 83 * 84 * @param version The zycore version value 85 */ 86 #define ZYCORE_VERSION_BUILD(version) (ZyanU16)(version & 0x000000000000FFFF) 87 88 /* ---------------------------------------------------------------------------------------------- */ 89 90 /* ============================================================================================== */ 91 /* Exported functions */ 92 /* ============================================================================================== */ 93 94 /** 95 * Returns the zycore version. 96 * 97 * @return The zycore version. 98 * 99 * Use the macros provided in this file to extract the major, minor, patch and build part from the 100 * returned version value. 101 */ 102 ZYCORE_EXPORT ZyanU64 ZycoreGetVersion(void); 103 104 /* ============================================================================================== */ 105 106 #ifdef __cplusplus 107 } 108 #endif 109 110 #endif /* ZYCORE_H */ 111