1 # Copyright (C) 2020 The Khronos Group Inc.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
9 # Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
12 # Redistributions in binary form must reproduce the above
13 # copyright notice, this list of conditions and the following
14 # disclaimer in the documentation and/or other materials provided
15 # with the distribution.
17 # Neither the name of The Khronos Group Inc. nor the names of its
18 # contributors may be used to endorse or promote products derived
19 # from this software without specific prior written permission.
21 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 # COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 # POSSIBILITY OF SUCH DAMAGE.
34 # increase to 3.1 once all major distributions
35 # include a version of CMake >= 3.1
36 cmake_minimum_required(VERSION 3.14.0)
38 cmake_policy(SET CMP0048 NEW)
41 cmake_policy(SET CMP0054 NEW)
44 project(glslang LANGUAGES CXX)
46 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
48 # Enable compile commands database
49 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
51 # Adhere to GNU filesystem layout conventions
52 include(GNUInstallDirs)
53 include(CMakePackageConfigHelpers)
55 # Needed for CMAKE_DEPENDENT_OPTION macro
56 include(CMakeDependentOption)
58 option(BUILD_SHARED_LIBS "Build Shared Libraries" OFF)
59 option(BUILD_EXTERNAL "Build external dependencies in /External" ON)
67 if ("${CMAKE_BUILD_TYPE}" STREQUAL "")
68 # This logic inside SPIRV-Tools, which can upset build target dependencies
69 # if changed after targets are already defined. To prevent these issues,
70 # ensure CMAKE_BUILD_TYPE is assigned early and at the glslang root scope.
71 message(STATUS "No build type selected, default to Debug")
72 set(CMAKE_BUILD_TYPE "Debug")
75 option(SKIP_GLSLANG_INSTALL "Skip installation" ${SKIP_GLSLANG_INSTALL})
76 if(NOT ${SKIP_GLSLANG_INSTALL})
77 set(ENABLE_GLSLANG_INSTALL ON)
79 option(ENABLE_SPVREMAPPER "Enables building of SPVRemapper" ON)
81 option(ENABLE_GLSLANG_BINARIES "Builds glslangValidator and spirv-remap" ON)
83 option(ENABLE_GLSLANG_JS
84 "If using Emscripten, build glslang.js. Otherwise, builds a sample executable for binary-size testing." OFF)
85 CMAKE_DEPENDENT_OPTION(ENABLE_GLSLANG_WEBMIN
86 "Reduces glslang to minimum needed for web use"
87 OFF "ENABLE_GLSLANG_JS"
89 CMAKE_DEPENDENT_OPTION(ENABLE_GLSLANG_WEBMIN_DEVEL
90 "For ENABLE_GLSLANG_WEBMIN builds, enables compilation error messages"
91 OFF "ENABLE_GLSLANG_WEBMIN"
93 CMAKE_DEPENDENT_OPTION(ENABLE_EMSCRIPTEN_SINGLE_FILE
94 "If using Emscripten, enables SINGLE_FILE build"
95 OFF "ENABLE_GLSLANG_JS AND EMSCRIPTEN"
97 CMAKE_DEPENDENT_OPTION(ENABLE_EMSCRIPTEN_ENVIRONMENT_NODE
98 "If using Emscripten, builds to run on Node instead of Web"
99 OFF "ENABLE_GLSLANG_JS AND EMSCRIPTEN"
102 CMAKE_DEPENDENT_OPTION(ENABLE_HLSL
103 "Enables HLSL input support"
104 ON "NOT ENABLE_GLSLANG_WEBMIN"
107 option(ENABLE_RTTI "Enables RTTI" OFF)
108 option(ENABLE_EXCEPTIONS "Enables Exceptions" OFF)
109 option(ENABLE_OPT "Enables spirv-opt capability if present" ON)
111 if(MINGW OR (CMAKE_SYSTEM_NAME STREQUAL "Darwin" AND ${CMAKE_CXX_COMPILER_ID} MATCHES "GNU"))
112 # Workaround for CMake behavior on Mac OS with gcc, cmake generates -Xarch_* arguments
114 option(ENABLE_PCH "Enables Precompiled header" OFF)
116 option(ENABLE_PCH "Enables Precompiled header" ON)
118 option(ENABLE_CTEST "Enables testing" ON)
120 if(ENABLE_GLSLANG_INSTALL AND CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND WIN32)
121 set(CMAKE_INSTALL_PREFIX "install" CACHE STRING "..." FORCE)
124 option(USE_CCACHE "Use ccache" OFF)
126 find_program(CCACHE_FOUND ccache)
128 set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
137 add_definitions(-DENABLE_HLSL)
140 if(ENABLE_GLSLANG_WEBMIN)
141 add_definitions(-DGLSLANG_WEB)
142 if(ENABLE_GLSLANG_WEBMIN_DEVEL)
143 add_definitions(-DGLSLANG_WEB_DEVEL)
148 set(CMAKE_DEBUG_POSTFIX "d")
149 option(OVERRIDE_MSVCCRT "Overrides runtime of MSVC " ON)
150 if(MSVC AND OVERRIDE_MSVCCRT)
151 include(ChooseMSVCCRT.cmake)
153 add_definitions(-DGLSLANG_OSINCLUDE_WIN32)
155 add_definitions(-DGLSLANG_OSINCLUDE_UNIX)
157 message("unknown platform")
160 if(${CMAKE_CXX_COMPILER_ID} MATCHES "GNU")
161 add_compile_options(-Wall -Wmaybe-uninitialized -Wuninitialized -Wunused -Wunused-local-typedefs
162 -Wunused-parameter -Wunused-value -Wunused-variable -Wunused-but-set-parameter -Wunused-but-set-variable -fno-exceptions)
163 add_compile_options(-Wno-reorder) # disable this from -Wall, since it happens all over.
165 add_compile_options(-fno-rtti)
167 if(NOT ENABLE_EXCEPTIONS)
168 add_compile_options(-fno-exceptions)
170 if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "9.0.0")
171 add_compile_options(-Werror=deprecated-copy)
174 if(NOT CMAKE_VERSION VERSION_LESS "3.13" AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin")
175 # Error if there's symbols that are not found at link time.
176 # add_link_options() was added in CMake 3.13 - if using an earlier
177 # version don't set this - it should be caught by presubmits anyway.
178 add_link_options("-Wl,--no-undefined")
180 elseif(${CMAKE_CXX_COMPILER_ID} MATCHES "Clang" AND NOT MSVC)
181 add_compile_options(-Wall -Wuninitialized -Wunused -Wunused-local-typedefs
182 -Wunused-parameter -Wunused-value -Wunused-variable)
183 add_compile_options(-Wno-reorder) # disable this from -Wall, since it happens all over.
185 add_compile_options(-fno-rtti)
187 if(NOT ENABLE_EXCEPTIONS)
188 add_compile_options(-fno-exceptions)
191 if(NOT CMAKE_VERSION VERSION_LESS "3.13")
192 # Error if there's symbols that are not found at link time.
193 # add_link_options() was added in CMake 3.13 - if using an earlier
194 # version don't set this - it should be caught by presubmits anyway.
195 if (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
196 add_link_options("-Wl,-undefined,error")
198 add_link_options("-Wl,--no-undefined")
203 string(FIND "${CMAKE_CXX_FLAGS}" "/GR" MSVC_HAS_GR)
205 string(REGEX REPLACE "/GR" "/GR-" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
207 add_compile_options(/GR-) # Disable RTTI
210 if(ENABLE_EXCEPTIONS)
211 add_compile_options(/EHsc) # Enable Exceptions
213 string(REGEX REPLACE "/EHsc" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}") # Try to remove default /EHsc cxx_flag
214 add_compile_options(/D_HAS_EXCEPTIONS=0)
218 if(ENABLE_GLSLANG_JS)
220 add_compile_options(/Os /GR-)
222 add_compile_options(-Os -fno-rtti -fno-exceptions)
223 if(${CMAKE_CXX_COMPILER_ID} MATCHES "Clang" AND NOT MSVC)
224 add_compile_options(-Wno-unused-parameter)
225 add_compile_options(-Wno-unused-variable -Wno-unused-const-variable)
231 if(${CMAKE_VERSION} VERSION_LESS 3.1)
232 # CMake versions before 3.1 do not understand CMAKE_CXX_STANDARD
233 # remove this block once CMake >=3.1 has fixated in the ecosystem
234 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
236 set(CMAKE_CXX_STANDARD 11)
237 set(CMAKE_CXX_STANDARD_REQUIRED ON)
238 set(CMAKE_CXX_EXTENSIONS OFF)
241 function(glslang_set_link_args TARGET)
242 # For MinGW compiles, statically link against the GCC and C++ runtimes.
243 # This avoids the need to ship those runtimes as DLLs.
244 if(WIN32 AND ${CMAKE_CXX_COMPILER_ID} MATCHES "GNU")
245 set_target_properties(${TARGET} PROPERTIES
246 LINK_FLAGS "-static -static-libgcc -static-libstdc++")
248 endfunction(glslang_set_link_args)
250 if(NOT COMMAND find_host_package)
251 macro(find_host_package)
252 find_package(${ARGN})
256 # Root directory for build-time generated include files
257 set(GLSLANG_GENERATED_INCLUDEDIR "${CMAKE_BINARY_DIR}/include")
259 ################################################################################
260 # Build version information generation
261 ################################################################################
262 include(parse_version.cmake)
263 set(GLSLANG_CHANGES_FILE "${CMAKE_CURRENT_SOURCE_DIR}/CHANGES.md")
264 set(GLSLANG_BUILD_INFO_H_TMPL "${CMAKE_CURRENT_SOURCE_DIR}/build_info.h.tmpl")
265 set(GLSLANG_BUILD_INFO_H "${GLSLANG_GENERATED_INCLUDEDIR}/glslang/build_info.h")
267 parse_version(${GLSLANG_CHANGES_FILE} GLSLANG)
269 function(configurate_version)
270 set(major ${GLSLANG_VERSION_MAJOR})
271 set(minor ${GLSLANG_VERSION_MINOR})
272 set(patch ${GLSLANG_VERSION_PATCH})
273 set(flavor ${GLSLANG_VERSION_FLAVOR})
274 configure_file(${GLSLANG_BUILD_INFO_H_TMPL} ${GLSLANG_BUILD_INFO_H} @ONLY)
277 configurate_version()
279 # glslang_add_build_info_dependency() adds the glslang-build-info dependency and
280 # generated include directories to target.
281 function(glslang_add_build_info_dependency target)
282 target_include_directories(${target} PUBLIC $<BUILD_INTERFACE:${GLSLANG_GENERATED_INCLUDEDIR}>)
285 # glslang_only_export_explicit_symbols() makes the symbol visibility hidden by
286 # default for <target> when building shared libraries, and sets the
287 # GLSLANG_IS_SHARED_LIBRARY define, and GLSLANG_EXPORTING to 1 when specifically
289 function(glslang_only_export_explicit_symbols target)
290 if(BUILD_SHARED_LIBS)
291 target_compile_definitions(${target} PUBLIC "GLSLANG_IS_SHARED_LIBRARY=1")
293 target_compile_definitions(${target} PRIVATE "GLSLANG_EXPORTING=1")
295 target_compile_options(${target} PRIVATE "-fvisibility=hidden")
300 # glslang_pch() adds precompiled header rules to <target> for the pre-compiled
301 # header file <pch>. As target_precompile_headers() was added in CMake 3.16,
302 # this is a no-op if called on earlier versions of CMake.
303 if(NOT CMAKE_VERSION VERSION_LESS "3.16" AND ENABLE_PCH)
304 function(glslang_pch target pch)
305 target_precompile_headers(${target} PRIVATE ${pch})
308 function(glslang_pch target pch)
311 message("Your CMake version is ${CMAKE_VERSION}. Update to at least 3.16 to enable precompiled headers to speed up incremental builds")
315 if(BUILD_EXTERNAL AND IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/External)
316 find_host_package(PythonInterp 3 REQUIRED)
318 # We depend on these for later projects, so they should come first.
319 add_subdirectory(External)
322 if(NOT TARGET SPIRV-Tools-opt)
327 message(STATUS "optimizer enabled")
328 add_definitions(-DENABLE_OPT=1)
331 message(STATUS "spirv-tools not linked - illegal SPIRV may be generated for HLSL")
333 add_definitions(-DENABLE_OPT=0)
336 add_subdirectory(glslang)
337 add_subdirectory(OGLCompilersDLL)
338 if(ENABLE_GLSLANG_BINARIES)
339 add_subdirectory(StandAlone)
341 add_subdirectory(SPIRV)
343 add_subdirectory(hlsl)
346 add_subdirectory(gtests)
349 if(ENABLE_CTEST AND BUILD_TESTING)
350 # glslang-testsuite runs a bash script on Windows.
351 # Make sure to use '-o igncr' flag to ignore carriage returns (\r).
352 set(IGNORE_CR_FLAG "")
354 set(IGNORE_CR_FLAG -o igncr)
357 if (CMAKE_CONFIGURATION_TYPES)
358 set(RESULTS_PATH ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIGURATION>/localResults)
359 set(VALIDATOR_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/$<CONFIGURATION>/glslangValidator)
360 set(REMAP_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/$<CONFIGURATION>/spirv-remap)
362 set(RESULTS_PATH ${CMAKE_CURRENT_BINARY_DIR}/localResults)
363 set(VALIDATOR_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/glslangValidator)
364 set(REMAP_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/spirv-remap)
367 add_test(NAME glslang-testsuite
368 COMMAND bash ${IGNORE_CR_FLAG} runtests ${RESULTS_PATH} ${VALIDATOR_PATH} ${REMAP_PATH}
369 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/Test/)
372 if(ENABLE_GLSLANG_INSTALL)
373 file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/glslang-config.cmake.in" [=[
375 include("@PACKAGE_PATH_EXPORT_TARGETS@")
378 set(PATH_EXPORT_TARGETS "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}/glslang-targets.cmake")
379 configure_package_config_file(
380 "${CMAKE_CURRENT_BINARY_DIR}/glslang-config.cmake.in"
381 "${CMAKE_CURRENT_BINARY_DIR}/glslang-config.cmake"
384 INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
387 write_basic_package_version_file("${CMAKE_CURRENT_BINARY_DIR}/glslang-config-version.cmake"
388 VERSION ${GLSLANG_VERSION}
389 COMPATIBILITY SameMajorVersion
393 EXPORT glslang-targets
394 NAMESPACE "glslang::"
395 DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
400 "${CMAKE_CURRENT_BINARY_DIR}/glslang-config.cmake"
401 "${CMAKE_CURRENT_BINARY_DIR}/glslang-config-version.cmake"
403 "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"