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)
14 include(QuasselVersion)
16 message(STATUS "Using CMake ${CMAKE_VERSION}")
18 # Set up build type rather early
21 # Support ccache if found
22 # This should happen before calling project(), so compiler settings are validated.
23 option(USE_CCACHE "Enable support for ccache if available" ON)
25 message(STATUS "Checking for ccache")
26 find_program(CCACHE_PROGRAM ccache)
28 set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${CCACHE_PROGRAM}")
29 message(STATUS "Checking for ccache - enabled")
31 message(STATUS "Checking for ccache - not found")
38 # Let CMake handle file generation for Qt
43 # Needed, otherwise some .moc files won't be found with older CMake versions
44 set(CMAKE_INCLUDE_CURRENT_DIR ON)
46 # Include various CMake modules...
47 include(CMakePushCheckState)
48 include(CheckFunctionExists)
49 include(CheckIncludeFileCXX)
50 include(CheckCXXSourceCompiles)
51 include(CMakeDependentOption)
52 include(FeatureSummary)
55 include(QuasselCompileSettings)
56 include(QuasselMacros)
58 # Options and variables that can be set on the command line
59 #####################################################################
61 # Select the binaries to build
62 option(WANT_CORE "Build the core (server) binary" ON)
63 option(WANT_QTCLIENT "Build the client-only binary" ON)
64 option(WANT_MONO "Build the monolithic (all-in-one) binary" ON)
65 add_feature_info(WANT_CORE WANT_CORE "Build the core (server) binary")
66 add_feature_info(WANT_QTCLIENT WANT_QTCLIENT "Build the client-only binary (requires a core to connect to)")
67 add_feature_info(WANT_MONO WANT_MONO "Build the monolithic (all-in-one) binary")
69 # Whether to enable integration with higher-tier KDE frameworks that require runtime support.
70 # We still optionally make use of certain Tier 1 frameworks even if WITH_KDE is disabled.
71 option(WITH_KDE "Integration with the KDE Frameworks runtime environment")
72 add_feature_info(WITH_KDE WITH_KDE "Integrate with the KDE Frameworks runtime environment")
74 # Icon theme support. By default, install the Breeze icon theme (may be disabled if a system installation is present)
75 option(WITH_BUNDLED_ICONS "Install required icons from the Breeze icon theme" ON)
76 add_feature_info(WITH_BUNDLED_ICONS WITH_BUNDLED_ICONS "Install required icons from the Breeze icon theme")
78 option(WITH_OXYGEN_ICONS "Support the Oxygen icon theme (KDE4)" OFF)
79 add_feature_info(WITH_OXYGEN_ICONS WITH_OXYGEN_ICONS "Support the Oxygen icon theme (KDE4)")
81 # For this, the feature info is added after we know if QtWebkit is installed
82 option(WITH_WEBKIT "WebKit support (for link previews) (legacy)" OFF)
84 # For this, the feature info is added after we know if QtWebEngine is installed
85 option(WITH_WEBENGINE "WebEngine support (for link previews)" ON)
88 # Notification Center is only available in > 10.8, which is Darwin v12
89 if (NOT CMAKE_SYSTEM_VERSION VERSION_LESS 12)
90 option(WITH_NOTIFICATION_CENTER "OS X Notification Center support" ON)
91 add_feature_info(WITH_NOTIFICATION_CENTER WITH_NOTIFICATION_CENTER "Use the OS X Notification Center")
93 find_library(CARBON_LIBRARY Carbon)
94 mark_as_advanced(CARBON_LIBRARY)
95 link_libraries(${CARBON_LIBRARY})
98 # Always embed on Windows or OSX; never embed when enabling KDE integration
99 set(EMBED_DEFAULT OFF)
101 set(EMBED_DEFAULT ON)
103 cmake_dependent_option(EMBED_DATA "Embed icons and translations into the binaries instead of installing them" ${EMBED_DEFAULT}
104 "NOT WIN32;NOT WITH_KDE" ${EMBED_DEFAULT})
105 if (NOT EMBED_DEFAULT)
106 add_feature_info(EMBED_DATA EMBED_DATA "Embed icons and translations in the binaries instead of installing them")
109 # The following options are not for end-user consumption, so don't list them in the feature summary
110 cmake_dependent_option(DEPLOY "Add required libs to bundle resources and create a dmg" OFF "APPLE" OFF)
112 # List of authenticators and the cmake flags to build them
113 # (currently that's just LDAP, but more can be added here).
114 ####################################################################
115 option(WITH_LDAP "Enable LDAP authentication support if present on system" ON)
118 #####################################################################
120 # Visibility settings apply to all targets
122 cmake_policy(SET CMP0063 NEW)
125 # Let automoc/autouic process generated files
127 cmake_policy(SET CMP0071 NEW)
130 set(BUILD_SHARED_LIBS TRUE CACHE BOOL "" FORCE)
132 # Don't use X11 on OSX
134 set(CMAKE_DISABLE_FIND_PACKAGE_X11 true)
135 set(CMAKE_DISABLE_FIND_PACKAGE_XCB true)
136 set(CMAKE_DISABLE_FIND_PACKAGE_Qt5X11Extras true)
139 # Simplify later checks
140 #####################################################################
142 if (WANT_MONO OR WANT_QTCLIENT)
145 if (WANT_MONO OR WANT_CORE)
150 #####################################################################
152 # Find package dependencies
154 # Note that you can forcefully disable optional packages
155 # using -DCMAKE_DISABLE_FIND_PACKAGE_<PkgName>=TRUE
156 #####################################################################
158 set(QT_MIN_VERSION "5.5.0")
160 # Required Qt components
161 set(qt_components Core Network)
163 list(APPEND qt_components Gui Widgets)
166 list(APPEND qt_components Script Sql)
169 find_package(Qt5 ${QT_MIN_VERSION} REQUIRED COMPONENTS ${qt_components})
170 set_package_properties(Qt5 PROPERTIES TYPE REQUIRED
171 URL "https://www.qt.io/"
172 DESCRIPTION "the Qt libraries"
174 message(STATUS "Found Qt ${Qt5Core_VERSION}")
176 # Optional Qt components
178 find_package(Qt5LinguistTools QUIET)
179 set_package_properties(Qt5LinguistTools PROPERTIES TYPE RECOMMENDED
180 DESCRIPTION "contains tools for handling translation files"
181 PURPOSE "Required for having translations"
186 find_package(Qt5DBus QUIET)
187 set_package_properties(Qt5DBus PROPERTIES TYPE RECOMMENDED
188 URL "https://www.qt.io/"
189 DESCRIPTION "D-Bus support for Qt5"
190 PURPOSE "Needed for supporting D-Bus-based notifications and tray icon, used by most modern desktop environments"
193 find_package(dbusmenu-qt5 QUIET CONFIG)
194 set_package_properties(dbusmenu-qt5 PROPERTIES TYPE RECOMMENDED
195 URL "https://launchpad.net/libdbusmenu-qt"
196 DESCRIPTION "a library implementing the DBusMenu specification"
197 PURPOSE "Required for having a context menu for the D-Bus-based tray icon"
202 find_package(Qt5Multimedia QUIET)
203 set_package_properties(Qt5Multimedia PROPERTIES TYPE RECOMMENDED
204 URL "https://www.qt.io/"
205 DESCRIPTION "Multimedia support for Qt5"
206 PURPOSE "Required for audio notifications"
209 find_package(LibsnoreQt5 0.7.0 QUIET)
210 set_package_properties(LibsnoreQt5 PROPERTIES TYPE OPTIONAL
211 URL "https://projects.kde.org/projects/playground/libs/snorenotify"
212 DESCRIPTION "a cross-platform notification framework"
213 PURPOSE "Enable support for the snorenotify framework"
215 if (LibsnoreQt5_FOUND)
216 find_package(LibsnoreSettingsQt5 QUIET)
217 set_package_properties(LibsnoreSettingsQt5 PROPERTIES TYPE OPTIONAL
218 URL "https://projects.kde.org/projects/playground/libs/snorenotify"
219 DESCRIPTION "a cross-platform notification framework"
220 PURPOSE "Enable support for the snorenotify framework"
225 find_package(Qt5WebEngine QUIET)
226 set_package_properties(Qt5WebEngine PROPERTIES TYPE RECOMMENDED
227 URL "https://www.qt.io/"
228 DESCRIPTION "a WebEngine implementation for Qt"
229 PURPOSE "Needed for displaying previews for URLs in chat"
231 if (Qt5WebEngine_FOUND)
232 find_package(Qt5WebEngineWidgets QUIET)
233 set_package_properties(Qt5WebEngineWidgets PROPERTIES TYPE RECOMMENDED
234 URL "https://www.qt.io/"
235 DESCRIPTION "widgets for Qt's WebEngine implementation"
236 PURPOSE "Needed for displaying previews for URLs in chat"
241 if (WITH_WEBENGINE AND Qt5WebEngineWidgets_FOUND)
242 set(HAVE_WEBENGINE true)
244 add_feature_info("WITH_WEBENGINE, QtWebEngine and QtWebEngineWidgets modules" HAVE_WEBENGINE "Support showing previews for URLs in chat")
246 if (NOT HAVE_WEBENGINE)
248 find_package(Qt5WebKit QUIET)
249 set_package_properties(Qt5WebKit PROPERTIES TYPE OPTIONAL
250 URL "https://www.qt.io/"
251 DESCRIPTION "a WebKit implementation for Qt"
252 PURPOSE "Needed for displaying previews for URLs in chat"
255 find_package(Qt5WebKitWidgets QUIET)
256 set_package_properties(Qt5WebKitWidgets PROPERTIES TYPE OPTIONAL
257 URL "https://www.qt.io/"
258 DESCRIPTION "widgets for Qt's WebKit implementation"
259 PURPOSE "Needed for displaying previews for URLs in chat"
264 if (WITH_WEBKIT AND Qt5WebKitWidgets_FOUND)
265 set(HAVE_WEBKIT true)
267 add_feature_info("WITH_WEBKIT, QtWebKit and QtWebKitWidgets modules" HAVE_WEBKIT "Support showing previews for URLs in chat (legacy)")
273 # extra-cmake-modules
275 set(ecm_find_type "REQUIRED")
276 find_package(ECM NO_MODULE REQUIRED)
278 # Even with KDE integration disabled, we optionally use tier1 frameworks if we find them
279 set(ecm_find_type "RECOMMENDED")
280 find_package(ECM NO_MODULE QUIET)
283 set_package_properties(ECM PROPERTIES TYPE ${ecm_find_type}
284 URL "https://projects.kde.org/projects/kdesupport/extra-cmake-modules"
285 DESCRIPTION "extra modules for CMake, maintained by the KDE project"
286 PURPOSE "Required to find KDE Frameworks components"
290 list(APPEND CMAKE_MODULE_PATH ${ECM_MODULE_PATH})
292 find_package(KF5 REQUIRED COMPONENTS ConfigWidgets CoreAddons Notifications NotifyConfig Sonnet TextWidgets WidgetsAddons XmlGui)
293 set_package_properties(KF5 PROPERTIES TYPE REQUIRED
294 URL "http://www.kde.org"
295 DESCRIPTION "KDE Frameworks"
296 PURPOSE "Required for integration into the Plasma desktop"
298 message(STATUS "Found KDE Frameworks ${KF5_VERSION}")
301 # Optional KF5 tier1 components
302 find_package(KF5Sonnet QUIET)
303 set_package_properties(KF5Sonnet PROPERTIES TYPE RECOMMENDED
304 URL "http://api.kde.org/frameworks-api/frameworks5-apidocs/sonnet/html"
305 DESCRIPTION "framework for providing spell-checking capabilities"
306 PURPOSE "Enables spell-checking support in input widgets"
312 find_package(Qca-qt5 2.0 QUIET)
313 set_package_properties(Qca-qt5 PROPERTIES TYPE RECOMMENDED
314 URL "https://projects.kde.org/projects/kdesupport/qca"
315 DESCRIPTION "Qt Cryptographic Architecture"
316 PURPOSE "Required for encryption support"
320 find_package(Ldap QUIET)
321 set_package_properties(Ldap PROPERTIES TYPE OPTIONAL
322 URL "http://www.openldap.org/"
323 DESCRIPTION "LDAP (Lightweight Directory Access Protocol) libraries"
324 PURPOSE "Enables core user authentication via LDAP"
329 # Non-Qt-based packages
330 #####################################################################
332 find_package(Boost 1.56 REQUIRED)
333 set_package_properties(Boost PROPERTIES TYPE REQUIRED
334 URL "https://www.boost.org/"
335 DESCRIPTION "Boost libraries for C++"
338 find_package(ZLIB REQUIRED)
339 set_package_properties(ZLIB PROPERTIES TYPE REQUIRED
340 URL "http://www.zlib.net"
341 DESCRIPTION "a popular compression library"
342 PURPOSE "Used for protocol compression"
346 # Needed for generating backtraces
347 find_package(Backtrace QUIET)
348 set_package_properties(Backtrace PROPERTIES TYPE RECOMMENDED
349 DESCRIPTION "a header (and possibly library) for inspecting backtraces"
350 PURPOSE "Used for generating backtraces in case of a crash"
355 #####################################################################
357 option(BUILD_TESTING "Enable unit tests" OFF)
358 add_feature_info(BUILD_TESTING BUILD_TESTING "Build unit tests")
361 find_package(GTest QUIET)
362 set_package_properties(GTest PROPERTIES TYPE REQUIRED
363 DESCRIPTION "Google's unit testing framework"
364 PURPOSE "Required for building unit tests"
367 find_package(Qt5Test QUIET)
368 set_package_properties(Qt5Test PROPERTIES TYPE REQUIRED
369 DESCRIPTION "unit testing library for the Qt5 framework"
370 PURPOSE "Required for building unit tests"
374 # GTest messes with CMAKE_CXX_FLAGS, so process them again
375 process_cmake_cxx_flags()
378 # Check for SSL support in Qt
379 #####################################################################
381 cmake_push_check_state(RESET)
382 set(CMAKE_REQUIRED_LIBRARIES Qt5::Core)
383 check_cxx_source_compiles("
384 #include \"qglobal.h\"
385 #if defined QT_NO_SSL
386 # error \"No SSL support\"
390 cmake_pop_check_state()
393 add_definitions(-DHAVE_SSL)
395 add_feature_info("SSL support in Qt" HAVE_SSL "Use secure network connections")
397 # Setup support for KDE Frameworks
398 #####################################################################
401 add_definitions(-DHAVE_KDE -DHAVE_KF5)
404 # If KDE Frameworks are present, they're most probably providing Qt5 integration including icon loading
407 include(KDEInstallDirs)
410 # This needs to come after setting up KDE integration, so we can use KDE-specific paths
411 include(QuasselInstallDirs)
413 # RPATH and output settings
414 #####################################################################
416 # Build artifacts in a well-known location; especially important for Windows DLLs
417 # (which go into RUNTIME_OUTPUT_DIRECTORY and can thus be found by executables)
418 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
419 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
420 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
422 # These RPATH settings allow for running directly from the build dir
423 set(CMAKE_SKIP_BUILD_RPATH FALSE)
424 set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
425 set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE )
427 # Set install RPATH only if libdir isn't a system directory
428 if (IS_ABSOLUTE "${CMAKE_INSTALL_LIBDIR}")
429 set(libdir "${CMAKE_INSTALL_LIBDIR}")
431 set(libdir "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}")
433 list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${libdir}" is_systemdir)
434 if ("${is_systemdir}" STREQUAL "-1")
435 set(CMAKE_INSTALL_RPATH "${libdir}")
438 # Various config-dependent checks and settings
439 #####################################################################
441 # Check for syslog support
443 check_include_file_cxx(syslog.h HAVE_SYSLOG)
444 add_feature_info("syslog.h" HAVE_SYSLOG "Provide support for logging to the syslog")
448 check_function_exists(umask HAVE_UMASK)
452 message(STATUS "Embedding data files into the binary")
454 message(STATUS "Installing data files separately")
457 # Windows-specific stuff
458 #####################################################################
461 link_libraries(imm32 winmm dbghelp Secur32) # missing by default :/
463 link_libraries(Version dwmapi shlwapi)
468 #####################################################################
470 # Add needed subdirs - the order is important, since src needs some vars set by other dirs
471 add_subdirectory(data)
472 add_subdirectory(icons)
473 add_subdirectory(pics)
476 # Set up and display feature summary
477 #####################################################################
479 feature_summary(WHAT ALL
480 INCLUDE_QUIET_PACKAGES
481 FATAL_ON_MISSING_REQUIRED_PACKAGES
484 # Finally, compile the sources
485 # We want this after displaying the feature summary to avoid ugly
486 # CMake backtraces in case a required Qt5 module is missing
487 #####################################################################
489 add_subdirectory(src)
491 # Build tests if so desired
493 add_subdirectory(tests)