ScummVM API documentation
config.h
1 /* Copyright (C) 2003, 2004, 2005, 2006, 2008, 2009 Dean Beeler, Jerome Fisher
2  * Copyright (C) 2011-2021 Dean Beeler, Jerome Fisher, Sergey V. Mikayev
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License as published by
6  * the Free Software Foundation, either version 2.1 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef MT32EMU_CONFIG_H
19 #define MT32EMU_CONFIG_H
20 
21 #define MT32EMU_VERSION "2.7.0"
22 #define MT32EMU_VERSION_MAJOR 2
23 #define MT32EMU_VERSION_MINOR 7
24 #define MT32EMU_VERSION_PATCH 0
25 
26 /* Library Exports Configuration
27  *
28  * This reflects the API types actually provided by the library build.
29  * 0: The full-featured C++ API is only available in this build. The client application may ONLY use MT32EMU_API_TYPE 0.
30  * 1: The C-compatible API is only available. The library is built as a shared object, only C functions are exported,
31  * and thus the client application may NOT use MT32EMU_API_TYPE 0.
32  * 2: The C-compatible API is only available. The library is built as a shared object, only the factory function
33  * is exported, and thus the client application may ONLY use MT32EMU_API_TYPE 2.
34  * 3: All the available API types are provided by the library build.
35  */
36 #define MT32EMU_EXPORTS_TYPE 0
37 #define MT32EMU_API_TYPE 0
38 
39 /* Type of library build.
40  *
41  * For shared library builds, MT32EMU_SHARED is defined, so that compiler-specific attributes are assigned
42  * to all the exported symbols as appropriate. MT32EMU_SHARED is undefined for static library builds.
43  */
44 #undef MT32EMU_SHARED
45 
46 /* Whether the library is built as a shared object with a version tag to enable runtime version checks. */
47 #define MT32EMU_WITH_VERSION_TAGGING 0
48 
49 /* Automatic runtime check of the shared library version in client applications.
50  *
51  * When the shared library is built with version tagging enabled, the client application may rely on an automatic
52  * version check that ensures forward compatibility. See VersionTagging.h for more info.
53  * 0: Disables the automatic runtime version check in the client application. Implied for static library builds
54  * and when version tagging is not used in a shared object.
55  * 1: Enables an automatic runtime version check in client applications that utilise low-level C++ API,
56  * i.e. when MT32EMU_API_TYPE 0. Client applications that rely on the C-compatible API are supposed
57  * to check the version of the shared object by other means (e.g. using versioned C symbols, etc.).
58  * 2: Enables an automatic runtime version check for C++ and C client applications.
59  */
60 #if MT32EMU_WITH_VERSION_TAGGING
61 # ifndef MT32EMU_RUNTIME_VERSION_CHECK
62 # define MT32EMU_RUNTIME_VERSION_CHECK @libmt32emu_RUNTIME_VERSION_CHECK@
63 # endif
64 #else
65 # undef MT32EMU_RUNTIME_VERSION_CHECK
66 #endif
67 
68 #endif /* #ifndef MT32EMU_CONFIG_H */