1 # CMake build script for the libgit2 project
3 # Building (out of source build):
4 # > mkdir build && cd build
5 # > cmake .. [-DSETTINGS=VALUE]
12 # > cmake --build . --target install
15 CMAKE_MINIMUM_REQUIRED(VERSION 3.5.1)
16 CMAKE_POLICY(SET CMP0015 NEW)
18 CMAKE_POLICY(SET CMP0051 NEW)
21 CMAKE_POLICY(SET CMP0042 NEW)
24 CMAKE_POLICY(SET CMP0054 NEW)
27 # Add find modules to the path
28 SET(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${libgit2_SOURCE_DIR}/cmake/Modules/")
30 INCLUDE(CheckLibraryExists)
31 INCLUDE(CheckFunctionExists)
32 INCLUDE(CheckSymbolExists)
33 INCLUDE(CheckStructHasMember)
34 INCLUDE(CheckPrototypeDefinition) # Added in CMake 3.0
35 INCLUDE(AddCFlagIfSupported)
36 INCLUDE(FindPkgLibraries)
39 INCLUDE(IdeSplitSources)
40 INCLUDE(FeatureSummary)
41 INCLUDE(EnableWarnings)
45 OPTION(SONAME "Set the (SO)VERSION of the target" ON)
46 OPTION(BUILD_SHARED_LIBS "Build Shared Library (OFF for Static)" ON)
47 OPTION(THREADSAFE "Build libgit2 as threadsafe" ON)
48 OPTION(BUILD_CLAR "Build Tests using the Clar suite" ON)
49 OPTION(BUILD_EXAMPLES "Build library usage example apps" OFF)
50 OPTION(BUILD_FUZZERS "Build the fuzz targets" OFF)
51 OPTION(TAGS "Generate tags" OFF)
52 OPTION(PROFILE "Generate profiling information" OFF)
53 OPTION(ENABLE_TRACE "Enables tracing support" ON)
54 OPTION(LIBGIT2_FILENAME "Name of the produced binary" OFF)
55 OPTION(USE_SSH "Link with libssh2 to enable SSH support" ON)
56 OPTION(USE_HTTPS "Enable HTTPS support. Can be set to a specific backend" ON)
57 OPTION(USE_SHA1 "Enable SHA1. Can be set to CollisionDetection(ON)/HTTPS/Generic" ON)
58 OPTION(USE_GSSAPI "Link with libgssapi for SPNEGO auth" OFF)
59 OPTION(USE_STANDALONE_FUZZERS "Enable standalone fuzzers (compatible with gcc)" OFF)
60 OPTION(USE_LEAK_CHECKER "Run tests with leak checker" OFF)
61 OPTION(DEBUG_POOL "Enable debug pool allocator" OFF)
62 OPTION(ENABLE_WERROR "Enable compilation with -Werror" OFF)
63 OPTION(USE_BUNDLED_ZLIB "Use the bundled version of zlib" OFF)
64 SET(USE_HTTP_PARSER "" CACHE STRING "Specifies the HTTP Parser implementation; either system or builtin.")
65 OPTION(DEPRECATE_HARD "Do not include deprecated functions in the library" OFF)
66 SET(REGEX_BACKEND "" CACHE STRING "Regular expression implementation. One of regcomp_l, pcre2, pcre, regcomp, or builtin.")
70 OPTION(USE_NTLMCLIENT "Enable NTLM support on Unix." OFF )
72 OPTION(USE_NTLMCLIENT "Enable NTLM support on Unix." ON )
76 IF (UNIX AND NOT APPLE)
77 OPTION(ENABLE_REPRODUCIBLE_BUILDS "Enable reproducible builds" OFF)
81 OPTION(USE_ICONV "Link with and use iconv library" ON)
85 # This option must match the settings used in your program, in particular if you
86 # are linking statically
87 OPTION(STATIC_CRT "Link the static CRT libraries" ON)
89 # If you want to embed a copy of libssh2 into libgit2, pass a
91 OPTION(EMBED_SSH_PATH "Path to libssh2 to embed (Windows)" OFF)
96 # By default, libgit2 is built with WinHTTP. To use the built-in
97 # HTTP transport, invoke CMake with the "-DWINHTTP=OFF" argument.
98 OPTION(WINHTTP "Use Win32 WinHTTP routines" ON)
102 # Enable MSVC CRTDBG memory leak reporting when in debug mode.
103 OPTION(MSVC_CRTDBG "Enable CRTDBG memory leak reporting" OFF)
106 FILE(STRINGS "${libgit2_SOURCE_DIR}/include/git2/version.h" GIT2_HEADER REGEX "^#define LIBGIT2_VERSION \"[^\"]*\"$")
108 STRING(REGEX REPLACE "^.*LIBGIT2_VERSION \"([0-9]+).*$" "\\1" LIBGIT2_VERSION_MAJOR "${GIT2_HEADER}")
109 STRING(REGEX REPLACE "^.*LIBGIT2_VERSION \"[0-9]+\\.([0-9]+).*$" "\\1" LIBGIT2_VERSION_MINOR "${GIT2_HEADER}")
110 STRING(REGEX REPLACE "^.*LIBGIT2_VERSION \"[0-9]+\\.[0-9]+\\.([0-9]+).*$" "\\1" LIBGIT2_VERSION_REV "${GIT2_HEADER}")
111 SET(LIBGIT2_VERSION_STRING "${LIBGIT2_VERSION_MAJOR}.${LIBGIT2_VERSION_MINOR}.${LIBGIT2_VERSION_REV}")
113 FILE(STRINGS "${libgit2_SOURCE_DIR}/include/git2/version.h" GIT2_HEADER_SOVERSION REGEX "^#define LIBGIT2_SOVERSION \"([0-9.]+)\"$")
114 STRING(REGEX REPLACE "^.*LIBGIT2_SOVERSION \"([0-9.]+)\"$" "\\1" LIBGIT2_SOVERSION "${GIT2_HEADER_SOVERSION}")
117 ADD_DEFINITIONS(-DGIT_DEPRECATE_HARD)
120 # Platform specific compilation flags
123 MESSAGE(FATAL_ERROR "The STDCALL option is no longer supported; libgit2 is now always built as a cdecl library. If you're using PInvoke, please add the CallingConventions.Cdecl attribute for support.")
126 ADD_DEFINITIONS(-D_SCL_SECURE_NO_WARNINGS)
127 ADD_DEFINITIONS(-D_CRT_SECURE_NO_DEPRECATE)
128 ADD_DEFINITIONS(-D_CRT_NONSTDC_NO_DEPRECATE)
130 STRING(REPLACE "/Zm1000" " " CMAKE_C_FLAGS "${CMAKE_C_FLAGS}")
132 # /GF - String pooling
133 # /MP - Parallel build
134 SET(CMAKE_C_FLAGS "/GF /MP /nologo ${CMAKE_C_FLAGS}")
136 # /Gd - explicitly set cdecl calling convention
137 SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /Gd")
140 SET(CRT_FLAG_DEBUG "/MTd")
141 SET(CRT_FLAG_RELEASE "/MT")
143 SET(CRT_FLAG_DEBUG "/MDd")
144 SET(CRT_FLAG_RELEASE "/MD")
148 SET(GIT_MSVC_CRTDBG 1)
149 SET(CRT_FLAG_DEBUG "${CRT_FLAG_DEBUG}")
150 SET(CMAKE_C_STANDARD_LIBRARIES "${CMAKE_C_STANDARD_LIBRARIES} Dbghelp.lib")
153 # /Zi - Create debugging information
154 # /Od - Disable optimization
155 # /D_DEBUG - #define _DEBUG
156 # /MTd - Statically link the multithreaded debug version of the CRT
157 # /MDd - Dynamically link the multithreaded debug version of the CRT
158 # /RTC1 - Run time checks
159 SET(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /Zi /Od /D_DEBUG /RTC1 ${CRT_FLAG_DEBUG}")
161 # /DNDEBUG - Disables asserts
162 # /MT - Statically link the multithreaded release version of the CRT
163 # /MD - Dynamically link the multithreaded release version of the CRT
164 # /O2 - Optimize for speed
165 # /Oy - Enable frame pointer omission (FPO) (otherwise CMake will automatically turn it off)
166 # /GL - Link time code generation (whole program optimization)
167 # /Gy - Function-level linking
168 SET(CMAKE_C_FLAGS_RELEASE "/DNDEBUG /O2 /Oy /GL /Gy ${CRT_FLAG_RELEASE}")
170 # /Oy- - Disable frame pointer omission (FPO)
171 SET(CMAKE_C_FLAGS_RELWITHDEBINFO "/DNDEBUG /Zi /O2 /Oy- /GL /Gy ${CRT_FLAG_RELEASE}")
173 # /O1 - Optimize for size
174 SET(CMAKE_C_FLAGS_MINSIZEREL "/DNDEBUG /O1 /Oy /GL /Gy ${CRT_FLAG_RELEASE}")
176 # /IGNORE:4221 - Ignore empty compilation units
177 SET(CMAKE_STATIC_LINKER_FLAGS "/IGNORE:4221")
179 # /DYNAMICBASE - Address space load randomization (ASLR)
180 # /NXCOMPAT - Data execution prevention (DEP)
181 # /LARGEADDRESSAWARE - >2GB user address space on x86
182 # /VERSION - Embed version information in PE header
183 SET(CMAKE_EXE_LINKER_FLAGS "/DYNAMICBASE /NXCOMPAT /LARGEADDRESSAWARE /VERSION:${LIBGIT2_VERSION_MAJOR}.${LIBGIT2_VERSION_MINOR}")
185 # /DEBUG - Create a PDB
186 # /LTCG - Link time code generation (whole program optimization)
187 # /OPT:REF /OPT:ICF - Fold out duplicate code at link step
188 # /INCREMENTAL:NO - Required to use /LTCG
189 # /DEBUGTYPE:cv,fixup - Additional data embedded in the PDB (requires /INCREMENTAL:NO, so not on for Debug)
190 SET(CMAKE_EXE_LINKER_FLAGS_DEBUG "/DEBUG")
191 SET(CMAKE_EXE_LINKER_FLAGS_RELEASE "/RELEASE /LTCG /OPT:REF /OPT:ICF /INCREMENTAL:NO")
192 SET(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "/DEBUG /RELEASE /LTCG /OPT:REF /OPT:ICF /INCREMENTAL:NO /DEBUGTYPE:cv,fixup")
193 SET(CMAKE_EXE_LINKER_FLAGS_MINSIZEREL "/RELEASE /LTCG /OPT:REF /OPT:ICF /INCREMENTAL:NO")
195 # Same linker settings for DLL as EXE
196 SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}")
197 SET(CMAKE_SHARED_LINKER_FLAGS_DEBUG "${CMAKE_EXE_LINKER_FLAGS_DEBUG}")
198 SET(CMAKE_SHARED_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}")
199 SET(CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO}")
200 SET(CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL "${CMAKE_EXE_LINKER_FLAGS_MINSIZEREL}")
202 IF (ENABLE_REPRODUCIBLE_BUILDS)
203 SET(CMAKE_C_ARCHIVE_CREATE "<CMAKE_AR> Dqc <TARGET> <LINK_FLAGS> <OBJECTS>")
204 SET(CMAKE_C_ARCHIVE_APPEND "<CMAKE_AR> Dq <TARGET> <LINK_FLAGS> <OBJECTS>")
205 SET(CMAKE_C_ARCHIVE_FINISH "<CMAKE_RANLIB> -D <TARGET>")
208 SET(CMAKE_C_FLAGS "-D_GNU_SOURCE ${CMAKE_C_FLAGS}")
211 ENABLE_WARNINGS(extra)
213 IF (CMAKE_SYSTEM_NAME MATCHES "(Solaris|SunOS)")
214 SET(CMAKE_C_FLAGS "-D_POSIX_C_SOURCE=200112L -D__EXTENSIONS__ -D_POSIX_PTHREAD_SEMANTICS ${CMAKE_C_FLAGS}")
217 SET(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -D_DEBUG -O0")
219 IF (MINGW OR MSYS) # MinGW and MSYS always do PIC and complain if we tell them to
220 STRING(REGEX REPLACE "-fPIC" "" CMAKE_SHARED_LIBRARY_C_FLAGS "${CMAKE_SHARED_LIBRARY_C_FLAGS}")
221 ELSEIF (BUILD_SHARED_LIBS)
222 ADD_C_FLAG_IF_SUPPORTED(-fvisibility=hidden)
224 SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC")
228 # MinGW >= 3.14 uses the C99-style stdio functions
229 # automatically, but forks like mingw-w64 still want
230 # us to define this in order to use them
231 ADD_DEFINITIONS(-D__USE_MINGW_ANSI_STDIO=1)
234 ENABLE_WARNINGS(documentation)
235 DISABLE_WARNINGS(missing-field-initializers)
236 ENABLE_WARNINGS(strict-aliasing)
237 ENABLE_WARNINGS(strict-prototypes)
238 ENABLE_WARNINGS(declaration-after-statement)
239 ENABLE_WARNINGS(shift-count-overflow)
240 ENABLE_WARNINGS(unused-const-variable)
241 ENABLE_WARNINGS(unused-function)
242 ENABLE_WARNINGS(int-conversion)
244 # MinGW uses gcc, which expects POSIX formatting for printf, but
245 # uses the Windows C library, which uses its own format specifiers.
246 # Disable format specifier warnings.
248 DISABLE_WARNINGS(format)
249 DISABLE_WARNINGS(format-security)
251 ENABLE_WARNINGS(format)
252 ENABLE_WARNINGS(format-security)
255 IF("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang")
256 DISABLE_WARNINGS(documentation-deprecated-sync)
260 SET(CMAKE_C_FLAGS "-pg ${CMAKE_C_FLAGS}")
261 SET(CMAKE_EXE_LINKER_FLAGS "-pg ${CMAKE_EXE_LINKER_FLAGS}")
265 # Ensure that MinGW provides the correct header files.
266 IF (WIN32 AND NOT CYGWIN)
267 ADD_DEFINITIONS(-DWIN32 -D_WIN32_WINNT=0x0600)
270 IF( NOT CMAKE_CONFIGURATION_TYPES )
271 # Build Debug by default
272 IF (NOT CMAKE_BUILD_TYPE)
273 SET(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel." FORCE)
276 # Using a multi-configuration generator eg MSVC or Xcode
277 # that uses CMAKE_CONFIGURATION_TYPES and not CMAKE_BUILD_TYPE
280 IF(BUILD_FUZZERS AND NOT USE_STANDALONE_FUZZERS)
281 # The actual sanitizer link target will be added when linking the fuzz
283 SET(CMAKE_REQUIRED_FLAGS "-fsanitize=fuzzer-no-link")
284 ADD_C_FLAG(-fsanitize=fuzzer-no-link)
285 UNSET(CMAKE_REQUIRED_FLAGS)
288 ADD_SUBDIRECTORY(src)
292 IF (NOT BUILD_SHARED_LIBS)
293 SET(CMAKE_FIND_LIBRARY_SUFFIXES ".a")
299 ADD_SUBDIRECTORY(tests)
303 FIND_PROGRAM(CTAGS ctags)
305 MESSAGE(FATAL_ERROR "Could not find ctags command")
308 FILE(GLOB_RECURSE SRC_ALL *.[ch])
312 COMMAND ${CTAGS} -a ${SRC_ALL}
322 ADD_SUBDIRECTORY(examples)
326 IF(NOT USE_STANDALONE_FUZZERS)
328 MESSAGE(FATAL_ERROR "Cannot build the fuzzer targets and the examples together")
331 MESSAGE(FATAL_ERROR "Cannot build the fuzzer targets and the tests together")
334 ADD_SUBDIRECTORY(fuzzers)
337 FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:")
338 FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION "Disabled features:")