1 # Main CMake file for building Quassel IRC
3 # See INSTALL for possible CMake options (or read the code, Luke)
4 #####################################################################
7 #####################################################################
9 cmake_minimum_required(VERSION 3.5)
11 # Tell CMake about or own modules
12 set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
18 set(QUASSEL_VERSION_STRING "0.14-pre")
20 # Output CMake and Quassel versions as well as build type for debug reasons
21 message(STATUS "Building Quassel ${QUASSEL_VERSION_STRING}...")
22 message(STATUS "Using CMake ${CMAKE_VERSION}")
24 # Set up build type rather early
27 # Support ccache if found
28 # This should happen before calling project(), so compiler settings are validated.
29 option(USE_CCACHE "Enable support for ccache if available" ON)
31 message(STATUS "Checking for ccache")
32 find_program(CCACHE_PROGRAM ccache)
34 set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${CCACHE_PROGRAM}")
35 message(STATUS "Checking for ccache - enabled")
37 message(STATUS "Checking for ccache - not found")
44 # Let CMake handle file generation for Qt
49 # Needed, otherwise some .moc files won't be found with older CMake versions
50 set(CMAKE_INCLUDE_CURRENT_DIR ON)
52 # Include various CMake modules...
53 include(CMakePushCheckState)
54 include(CheckFunctionExists)
55 include(CheckIncludeFileCXX)
56 include(CheckCXXSourceCompiles)
57 include(CMakeDependentOption)
58 include(FeatureSummary)
61 include(QuasselCompileSettings)
62 include(QuasselMacros)
64 # Options and variables that can be set on the command line
65 #####################################################################
67 # Select the binaries to build
68 option(WANT_CORE "Build the core (server) binary" ON)
69 option(WANT_QTCLIENT "Build the client-only binary" ON)
70 option(WANT_MONO "Build the monolithic (all-in-one) binary" ON)
71 add_feature_info(WANT_CORE WANT_CORE "Build the core (server) binary")
72 add_feature_info(WANT_QTCLIENT WANT_QTCLIENT "Build the client-only binary (requires a core to connect to)")
73 add_feature_info(WANT_MONO WANT_MONO "Build the monolithic (all-in-one) binary")
75 # Whether to enable integration with higher-tier KDE frameworks that require runtime support.
76 # We still optionally make use of certain Tier 1 frameworks even if WITH_KDE is disabled.
77 option(WITH_KDE "Integration with the KDE Frameworks runtime environment")
78 add_feature_info(WITH_KDE WITH_KDE "Integrate with the KDE Frameworks runtime environment")
80 # Icon theme support. By default, install the Breeze icon theme (may be disabled if a system installation is present)
81 option(WITH_BUNDLED_ICONS "Install required icons from the Breeze icon theme" ON)
82 add_feature_info(WITH_BUNDLED_ICONS WITH_BUNDLED_ICONS "Install required icons from the Breeze icon theme")
84 option(WITH_OXYGEN_ICONS "Support the Oxygen icon theme (KDE4)" OFF)
85 add_feature_info(WITH_OXYGEN_ICONS WITH_OXYGEN_ICONS "Support the Oxygen icon theme (KDE4)")
87 # For this, the feature info is added after we know if QtWebkit is installed
88 option(WITH_WEBKIT "WebKit support (for link previews) (legacy)" OFF)
90 # For this, the feature info is added after we know if QtWebEngine is installed
91 option(WITH_WEBENGINE "WebEngine support (for link previews)" ON)
94 # Notification Center is only available in > 10.8, which is Darwin v12
95 if (NOT CMAKE_SYSTEM_VERSION VERSION_LESS 12)
96 option(WITH_NOTIFICATION_CENTER "OS X Notification Center support" ON)
97 add_feature_info(WITH_NOTIFICATION_CENTER WITH_NOTIFICATION_CENTER "Use the OS X Notification Center")
99 find_library(CARBON_LIBRARY Carbon)
100 mark_as_advanced(CARBON_LIBRARY)
101 link_libraries(${CARBON_LIBRARY})
104 # Always embed on Windows or OSX; never embed when enabling KDE integration
105 set(EMBED_DEFAULT OFF)
107 set(EMBED_DEFAULT ON)
109 cmake_dependent_option(EMBED_DATA "Embed icons and translations into the binaries instead of installing them" ${EMBED_DEFAULT}
110 "NOT WIN32;NOT WITH_KDE" ${EMBED_DEFAULT})
111 if (NOT EMBED_DEFAULT)
112 add_feature_info(EMBED_DATA EMBED_DATA "Embed icons and translations in the binaries instead of installing them")
115 # The following options are not for end-user consumption, so don't list them in the feature summary
116 cmake_dependent_option(DEPLOY "Add required libs to bundle resources and create a dmg. Note: requires Qt to be built with 10.4u SDK" OFF "APPLE" OFF)
119 # List of authenticators and the cmake flags to build them
120 # (currently that's just LDAP, but more can be added here).
121 ####################################################################
122 option(WITH_LDAP "Enable LDAP authentication support if present on system" ON)
125 #####################################################################
127 # Let automoc/autouic process generated files
129 cmake_policy(SET CMP0071 NEW)
132 # Simplify later checks
133 #####################################################################
135 if (WANT_MONO OR WANT_QTCLIENT)
138 if (WANT_MONO OR WANT_CORE)
144 #####################################################################
146 # Find package dependencies
148 # Note that you can forcefully disable optional packages
149 # using -DCMAKE_DISABLE_FIND_PACKAGE_<PkgName>=TRUE
150 #####################################################################
152 set(QT_MIN_VERSION "5.5.0")
154 # Required Qt components
155 set(qt_components Core Network)
157 list(APPEND qt_components Gui Widgets)
160 list(APPEND qt_components Script Sql)
163 find_package(Qt5 ${QT_MIN_VERSION} REQUIRED COMPONENTS ${qt_components})
164 set_package_properties(Qt5 PROPERTIES TYPE REQUIRED
165 URL "https://www.qt.io/"
166 DESCRIPTION "the Qt libraries"
168 message(STATUS "Found Qt ${Qt5Core_VERSION}")
170 # Optional Qt components
172 find_package(Qt5LinguistTools QUIET)
173 set_package_properties(Qt5LinguistTools PROPERTIES TYPE RECOMMENDED
174 DESCRIPTION "contains tools for handling translation files"
175 PURPOSE "Required for having translations"
180 find_package(Qt5DBus QUIET)
181 set_package_properties(Qt5DBus PROPERTIES TYPE RECOMMENDED
182 URL "https://www.qt.io/"
183 DESCRIPTION "D-Bus support for Qt5"
184 PURPOSE "Needed for supporting D-Bus-based notifications and tray icon, used by most modern desktop environments"
187 find_package(dbusmenu-qt5 QUIET CONFIG)
188 set_package_properties(dbusmenu-qt5 PROPERTIES TYPE RECOMMENDED
189 URL "https://launchpad.net/libdbusmenu-qt"
190 DESCRIPTION "a library implementing the DBusMenu specification"
191 PURPOSE "Required for having a context menu for the D-Bus-based tray icon"
196 find_package(Qt5Multimedia QUIET)
197 set_package_properties(Qt5Multimedia PROPERTIES TYPE RECOMMENDED
198 URL "https://www.qt.io/"
199 DESCRIPTION "Multimedia support for Qt5"
200 PURPOSE "Required for audio notifications"
203 find_package(LibsnoreQt5 0.7.0 QUIET)
204 set_package_properties(LibsnoreQt5 PROPERTIES TYPE OPTIONAL
205 URL "https://projects.kde.org/projects/playground/libs/snorenotify"
206 DESCRIPTION "a cross-platform notification framework"
207 PURPOSE "Enable support for the snorenotify framework"
209 if (LibsnoreQt5_FOUND)
210 find_package(LibsnoreSettingsQt5 QUIET)
211 set_package_properties(LibsnoreSettingsQt5 PROPERTIES TYPE OPTIONAL
212 URL "https://projects.kde.org/projects/playground/libs/snorenotify"
213 DESCRIPTION "a cross-platform notification framework"
214 PURPOSE "Enable support for the snorenotify framework"
219 find_package(Qt5WebEngine QUIET)
220 set_package_properties(Qt5WebEngine PROPERTIES TYPE RECOMMENDED
221 URL "https://www.qt.io/"
222 DESCRIPTION "a WebEngine implementation for Qt"
223 PURPOSE "Needed for displaying previews for URLs in chat"
225 if (Qt5WebEngine_FOUND)
226 find_package(Qt5WebEngineWidgets QUIET)
227 set_package_properties(Qt5WebEngineWidgets PROPERTIES TYPE RECOMMENDED
228 URL "https://www.qt.io/"
229 DESCRIPTION "widgets for Qt's WebEngine implementation"
230 PURPOSE "Needed for displaying previews for URLs in chat"
235 if (WITH_WEBENGINE AND Qt5WebEngineWidgets_FOUND)
236 set(HAVE_WEBENGINE true)
238 add_feature_info("WITH_WEBENGINE, QtWebEngine and QtWebEngineWidgets modules" HAVE_WEBENGINE "Support showing previews for URLs in chat")
240 if (NOT HAVE_WEBENGINE)
242 find_package(Qt5WebKit QUIET)
243 set_package_properties(Qt5WebKit PROPERTIES TYPE OPTIONAL
244 URL "https://www.qt.io/"
245 DESCRIPTION "a WebKit implementation for Qt"
246 PURPOSE "Needed for displaying previews for URLs in chat"
249 find_package(Qt5WebKitWidgets QUIET)
250 set_package_properties(Qt5WebKitWidgets PROPERTIES TYPE OPTIONAL
251 URL "https://www.qt.io/"
252 DESCRIPTION "widgets for Qt's WebKit implementation"
253 PURPOSE "Needed for displaying previews for URLs in chat"
258 if (WITH_WEBKIT AND Qt5WebKitWidgets_FOUND)
259 set(HAVE_WEBKIT true)
261 add_feature_info("WITH_WEBKIT, QtWebKit and QtWebKitWidgets modules" HAVE_WEBKIT "Support showing previews for URLs in chat (legacy)")
267 # extra-cmake-modules
269 set(ecm_find_type "REQUIRED")
270 find_package(ECM NO_MODULE REQUIRED)
272 # Even with KDE integration disabled, we optionally use tier1 frameworks if we find them
273 set(ecm_find_type "RECOMMENDED")
274 find_package(ECM NO_MODULE QUIET)
277 set_package_properties(ECM PROPERTIES TYPE ${ecm_find_type}
278 URL "https://projects.kde.org/projects/kdesupport/extra-cmake-modules"
279 DESCRIPTION "extra modules for CMake, maintained by the KDE project"
280 PURPOSE "Required to find KDE Frameworks components"
284 list(APPEND CMAKE_MODULE_PATH ${ECM_MODULE_PATH})
286 find_package(KF5 REQUIRED COMPONENTS ConfigWidgets CoreAddons Notifications NotifyConfig Sonnet TextWidgets WidgetsAddons XmlGui)
287 set_package_properties(KF5 PROPERTIES TYPE REQUIRED
288 URL "http://www.kde.org"
289 DESCRIPTION "KDE Frameworks"
290 PURPOSE "Required for integration into the Plasma desktop"
292 message(STATUS "Found KDE Frameworks ${KF5_VERSION}")
295 # Optional KF5 tier1 components
296 find_package(KF5Sonnet QUIET)
297 set_package_properties(KF5Sonnet PROPERTIES TYPE RECOMMENDED
298 URL "http://api.kde.org/frameworks-api/frameworks5-apidocs/sonnet/html"
299 DESCRIPTION "framework for providing spell-checking capabilities"
300 PURPOSE "Enables spell-checking support in input widgets"
306 find_package(Qca-qt5 2.0 QUIET)
307 set_package_properties(Qca-qt5 PROPERTIES TYPE RECOMMENDED
308 URL "https://projects.kde.org/projects/kdesupport/qca"
309 DESCRIPTION "Qt Cryptographic Architecture"
310 PURPOSE "Required for encryption support"
314 find_package(Ldap QUIET)
315 set_package_properties(Ldap PROPERTIES TYPE OPTIONAL
316 URL "http://www.openldap.org/"
317 DESCRIPTION "LDAP (Lightweight Directory Access Protocol) libraries"
318 PURPOSE "Enables core user authentication via LDAP"
323 # Non-Qt-based packages
324 #####################################################################
326 find_package(Boost 1.56 REQUIRED)
327 set_package_properties(Boost PROPERTIES TYPE REQUIRED
328 URL "https://www.boost.org/"
329 DESCRIPTION "Boost libraries for C++"
332 find_package(ZLIB REQUIRED)
333 set_package_properties(ZLIB PROPERTIES TYPE REQUIRED
334 URL "http://www.zlib.net"
335 DESCRIPTION "a popular compression library"
336 PURPOSE "Used for protocol compression"
340 # Needed for generating backtraces
341 find_package(Backtrace QUIET)
342 set_package_properties(Backtrace PROPERTIES TYPE RECOMMENDED
343 DESCRIPTION "a header (and possibly library) for inspecting backtraces"
344 PURPOSE "Used for generating backtraces in case of a crash"
349 #####################################################################
351 option(BUILD_TESTING "Enable unit tests" OFF)
352 add_feature_info(BUILD_TESTING BUILD_TESTING "Build unit tests")
355 find_package(GTest QUIET)
356 set_package_properties(GTest PROPERTIES TYPE REQUIRED
357 DESCRIPTION "Google's unit testing framework"
358 PURPOSE "Required for building unit tests"
361 find_package(Qt5Test QUIET)
362 set_package_properties(Qt5Test PROPERTIES TYPE REQUIRED
363 DESCRIPTION "unit testing library for the Qt5 framework"
364 PURPOSE "Required for building unit tests"
369 # Check for SSL support in Qt
370 #####################################################################
372 cmake_push_check_state(RESET)
373 set(CMAKE_REQUIRED_LIBRARIES Qt5::Core)
374 check_cxx_source_compiles("
375 #include \"qglobal.h\"
376 #if defined QT_NO_SSL
377 # error \"No SSL support\"
381 cmake_pop_check_state()
384 add_definitions(-DHAVE_SSL)
386 add_feature_info("SSL support in Qt" HAVE_SSL "Use secure network connections")
388 # Additional compile settings
389 #####################################################################
391 # Needed to compile with mingw without kde
392 if (MINGW AND NOT WITH_KDE)
393 add_definitions(-D_WIN32_WINNT=0x0500)
394 message(STATUS "Added _WIN32_WINNT=0x0500 definition for MinGW")
395 # workaround for bug in mingw gcc 4.0
396 add_definitions(-U__STRICT_ANSI__)
399 # Setup support for KDE Frameworks
400 #####################################################################
402 # We want to do this up here, so we have the necessary variables and defines set before
406 # If KDE Frameworks are present, they're most probably providing Qt5 integration including icon loading
409 include(KDEInstallDirs)
410 include(KDECompilerSettings)
411 include(KDECMakeSettings)
413 kde_enable_exceptions()
414 add_definitions(-DHAVE_KDE -DHAVE_KF5)
418 # This needs to come after setting up KDE integration, so we can use KDE-specific paths
419 include(QuasselInstallDirs)
421 # RPATH and output settings
422 #####################################################################
424 # Build artifacts in a well-known location; especially important for Windows DLLs
425 # (which go into RUNTIME_OUTPUT_DIRECTORY and can thus be found by executables)
426 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
427 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
428 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
430 # These RPATH settings allow for running directly from the build dir
431 set(CMAKE_SKIP_BUILD_RPATH FALSE)
432 set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
433 set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE )
435 # Set install RPATH only if libdir isn't a system directory
436 if (IS_ABSOLUTE "${CMAKE_INSTALL_LIBDIR}")
437 set(libdir "${CMAKE_INSTALL_LIBDIR}")
439 set(libdir "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}")
441 list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${libdir}" is_systemdir)
442 if ("${is_systemdir}" STREQUAL "-1")
443 set(CMAKE_INSTALL_RPATH "${libdir}")
446 # Various config-dependent checks and settings
447 #####################################################################
449 # Check for syslog support
451 check_include_file_cxx(syslog.h HAVE_SYSLOG)
452 add_feature_info("syslog.h" HAVE_SYSLOG "Provide support for logging to the syslog")
456 check_function_exists(umask HAVE_UMASK)
460 message(STATUS "Embedding data files into the binary")
462 message(STATUS "Installing data files separately")
465 # Windows-specific stuff
466 #####################################################################
469 link_libraries(imm32 winmm dbghelp Secur32) # missing by default :/
471 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /DNOMINMAX")
472 set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBUGINFO "/debug /INCREMENTAL:YES /NODEFAULTLIB:libcmt /DEFAULTLIB:msvcrt")
473 set(CMAKE_EXE_LINKER_FLAGS_DEBUG "/debug /INCREMENTAL:YES /NODEFAULTLIB:libcmt")
474 set(CMAKE_EXE_LINKER_FLAGS_DEBUGFULL "${CMAKE_EXE_LINKER_FLAGS_DEBUG}")
475 link_libraries(Version dwmapi shlwapi)
480 # Generate version information from Git
481 #####################################################################
483 include(GetGitRevisionDescription)
484 get_git_head_revision(GIT_REFSPEC GIT_HEAD)
485 git_describe(GIT_DESCRIBE --long)
487 # If in a Git repo we can get the commit-date from a git command
490 COMMAND git -c log.showsignature=false show -s --format=%ct
491 WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
492 OUTPUT_VARIABLE GIT_COMMIT_DATE
493 OUTPUT_STRIP_TRAILING_WHITESPACE
497 # If not in a Git repo try to read GIT_HEAD and GIT_DESCRIBE from
499 if (NOT GIT_HEAD OR NOT GIT_DESCRIBE)
500 if (DEFINED ENV{GIT_HEAD})
501 set(GIT_HEAD $ENV{GIT_HEAD})
503 if (DEFINED ENV{GIT_DESCRIBE})
504 set(GIT_DESCRIBE $ENV{GIT_DESCRIBE})
508 # Sanitize things if we're not in a Git repo
509 if (NOT GIT_HEAD OR NOT GIT_DESCRIBE)
512 set(GIT_COMMIT_DATE 0)
515 configure_file(version.h.in ${CMAKE_BINARY_DIR}/version.h @ONLY)
518 #####################################################################
520 # Add needed subdirs - the order is important, since src needs some vars set by other dirs
521 add_subdirectory(data)
522 add_subdirectory(icons)
523 add_subdirectory(pics)
526 # Set up and display feature summary
527 #####################################################################
529 feature_summary(WHAT ALL
530 INCLUDE_QUIET_PACKAGES
531 FATAL_ON_MISSING_REQUIRED_PACKAGES
534 # Finally, compile the sources
535 # We want this after displaying the feature summary to avoid ugly
536 # CMake backtraces in case a required Qt5 module is missing
537 #####################################################################
539 add_subdirectory(src)
541 # Build tests if so desired
543 add_subdirectory(tests)