2 ## This file is part of the PulseView project.
4 ## Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5 ## Copyright (C) 2012-2013 Alexandru Gagniuc <mr.nuke.me@gmail.com>
6 ## Copyright (C) 2020 Soeren Apel <soeren@apelpie.net>
8 ## This program is free software: you can redistribute it and/or modify
9 ## it under the terms of the GNU General Public License as published by
10 ## the Free Software Foundation, either version 2 of the License, or
11 ## (at your option) any later version.
13 ## This program is distributed in the hope that it will be useful,
14 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ## GNU General Public License for more details.
18 ## You should have received a copy of the GNU General Public License
19 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
22 cmake_minimum_required(VERSION 2.8.12)
24 include(GNUInstallDirs)
28 # Let AUTOMOC and AUTOUIC process GENERATED files.
30 cmake_policy(SET CMP0071 NEW)
33 # Only interpret if() arguments as variables or keywords when unquoted.
35 cmake_policy(SET CMP0054 NEW)
38 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/CMake")
40 #===============================================================================
42 #-------------------------------------------------------------------------------
44 option(DISABLE_WERROR "Build without -Werror" TRUE)
45 option(ENABLE_SIGNALS "Build with UNIX signals" TRUE)
46 option(ENABLE_STACKTRACE "Enable stack trace when crashing" FALSE)
47 option(ENABLE_DECODE "Build with libsigrokdecode" TRUE)
48 option(ENABLE_FLOW "Build with libsigrokflow" FALSE)
49 option(ENABLE_TESTS "Enable unit tests" FALSE)
50 option(STATIC_PKGDEPS_LIBS "Statically link to (pkg-config) libraries" FALSE)
53 # On Windows/MinGW we need to statically link to libraries.
54 # This option is user configurable, but enable it by default on win32.
55 set(STATIC_PKGDEPS_LIBS TRUE)
57 # Windows does not support UNIX signals.
58 set(ENABLE_SIGNALS FALSE)
61 if(NOT CMAKE_BUILD_TYPE)
62 set(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING
63 "Choose the type of build (None, Debug, Release, RelWithDebInfo, MinSizeRel)."
67 #===============================================================================
69 #-------------------------------------------------------------------------------
71 add_subdirectory(manual)
73 #===============================================================================
75 #-------------------------------------------------------------------------------
77 list(APPEND PKGDEPS glib-2.0>=2.28.0)
78 list(APPEND PKGDEPS glibmm-2.4>=2.28.0)
81 list(APPEND PKGDEPS gstreamermm-1.0>=1.8.0)
82 list(APPEND PKGDEPS libsigrokflow>=0.1.0)
85 set(LIBSR_CXX_BINDING "libsigrokcxx>=0.5.1")
86 list(APPEND PKGDEPS "${LIBSR_CXX_BINDING}")
89 list(APPEND PKGDEPS libsigrokdecode>=0.5.2)
93 list(APPEND PKGDEPS libsigrokandroidutils>=0.1.0)
96 find_package(PkgConfig)
97 pkg_check_modules(LIBSRCXX ${LIBSR_CXX_BINDING})
98 if(NOT LIBSRCXX_FOUND OR NOT LIBSRCXX_VERSION)
99 message(FATAL_ERROR "libsigrok C++ bindings missing, check libsigrok's 'configure' output (missing dependencies?)")
101 pkg_check_modules(PKGDEPS REQUIRED ${PKGDEPS})
103 set(CMAKE_AUTOMOC TRUE)
105 find_package(Qt5 5.3 COMPONENTS Core Gui LinguistTools Widgets Svg REQUIRED)
107 message(STATUS "Qt version: ${Qt5_VERSION}")
110 # MXE workaround: Use pkg-config to find Qt5 libs.
111 # https://github.com/mxe/mxe/issues/1642
112 # Not required (and doesn't work) on MSYS2.
113 if(NOT DEFINED ENV{MSYSTEM})
114 pkg_check_modules(QT5ALL REQUIRED Qt5Widgets>=5.3 Qt5Gui>=5.3 Qt5Svg>=5.3)
118 set(QT_LIBRARIES Qt5::Gui Qt5::Widgets Qt5::Svg)
120 set(BOOSTCOMPS filesystem serialization system)
122 list(APPEND BOOSTCOMPS unit_test_framework)
125 if(ENABLE_STACKTRACE)
126 find_package(Boost 1.65.1 COMPONENTS ${BOOSTCOMPS} REQUIRED)
128 find_package(Boost 1.55 COMPONENTS ${BOOSTCOMPS} REQUIRED)
131 # Find the platform's thread library (needed for C++11 threads).
132 # This will set ${CMAKE_THREAD_LIBS_INIT} to the correct, OS-specific value.
133 find_package(Threads REQUIRED)
135 # Check for explicit link against libatomic
137 # Depending on the toolchain, linking a program using atomic functions may need
138 # "-latomic" explicitly passed to the linker
140 # This check first tests if atomics are available in the C-library, if not and
141 # libatomic exists, then it runs the same test with -latomic added to the
144 # Helper for checking for atomics
145 function(check_working_cxx_atomics varname additional_lib)
146 include(CheckCXXSourceCompiles)
147 include(CMakePushCheckState)
148 cmake_push_check_state()
149 set(CMAKE_REQUIRED_FLAGS "-std=c++11")
150 set(CMAKE_REQUIRED_LIBRARIES "${additional_lib}")
151 set(CMAKE_REQUIRED_QUIET 1)
152 CHECK_CXX_SOURCE_COMPILES("
156 return std::atomic_fetch_add_explicit(&x, 1, std::memory_order_seq_cst);
159 cmake_pop_check_state()
160 endfunction(check_working_cxx_atomics)
162 # First check if atomics work without the library.
163 # If not, check if the library exists, and atomics work with it.
164 check_working_cxx_atomics(HAVE_CXX_ATOMICS_WITHOUT_LIB "")
165 if(HAVE_CXX_ATOMICS_WITHOUT_LIB)
166 message(STATUS "Atomics provided by the C-library - yes")
168 message(STATUS "Atomics provided by the C-library - no")
169 find_library(LIBATOMIC_LIBRARY NAMES atomic PATH_SUFFIXES lib)
170 if(LIBATOMIC_LIBRARY)
171 check_working_cxx_atomics(HAVE_CXX_ATOMICS_WITH_LIB "${LIBATOMIC_LIBRARY}")
172 if (HAVE_CXX_ATOMICS_WITH_LIB)
173 message(STATUS "Atomics provided by libatomic - yes")
175 message(STATUS "Atomics provided by libatomic - no")
176 message(FATAL_ERROR "Compiler must support std::atomic!")
179 message(FATAL_ERROR "Compiler appears to require libatomic, but cannot find it.")
183 #===============================================================================
184 #= System Introspection
185 #-------------------------------------------------------------------------------
188 memaccess_check_unaligned_le(HAVE_UNALIGNED_LITTLE_ENDIAN_ACCESS)
190 #===============================================================================
192 #-------------------------------------------------------------------------------
194 set(PV_TITLE PulseView)
195 set(PV_VERSION_STRING "0.5.0")
197 set(PV_GLIBMM_VERSION ${PKGDEPS_glibmm-2.4_VERSION})
199 include(GetGitRevisionDescription)
201 # Append the revision hash unless we are exactly on a tagged release.
202 git_describe(PV_TAG_VERSION_STRING --match "pulseview-${PV_VERSION_STRING}" --exact-match)
203 if(NOT PV_TAG_VERSION_STRING)
204 get_git_head_revision(PV_REVSPEC PV_HASH)
206 string(SUBSTRING "${PV_HASH}" 0 7 PV_SHORTHASH)
207 set(PV_VERSION_STRING "${PV_VERSION_STRING}-git-${PV_SHORTHASH}")
210 # Non-tagged releases use the unstable manual
211 set(PV_MANUAL_VERSION "unstable")
213 # Tagged releases use a fixed manual version
214 set(PV_MANUAL_VERSION ${PV_VERSION_STRING})
217 if(PV_VERSION_STRING MATCHES "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(-[-0-9a-z]*)?$")
218 set(PV_VERSION_MAJOR ${CMAKE_MATCH_1})
219 set(PV_VERSION_MINOR ${CMAKE_MATCH_2})
220 set(PV_VERSION_MICRO ${CMAKE_MATCH_3})
221 set(PV_VERSION_SUFFIX ${CMAKE_MATCH_4})
224 message(STATUS "${PV_TITLE} version: ${PV_VERSION_STRING}")
227 ${PROJECT_SOURCE_DIR}/config.h.in
228 ${PROJECT_BINARY_DIR}/config.h
231 #===============================================================================
233 #-------------------------------------------------------------------------------
235 set(pulseview_SOURCES
239 pv/globalsettings.cpp
245 pv/binding/binding.cpp
246 pv/binding/inputoutput.cpp
247 pv/binding/device.cpp
249 pv/data/analogsegment.cpp
251 pv/data/logicsegment.cpp
252 pv/data/signalbase.cpp
253 pv/data/signaldata.cpp
255 pv/devices/device.cpp
257 pv/devices/hardwaredevice.cpp
258 pv/devices/inputfile.cpp
259 pv/devices/sessionfile.cpp
260 pv/dialogs/connect.cpp
261 pv/dialogs/inputoutputoptions.cpp
262 pv/dialogs/settings.cpp
263 pv/dialogs/storeprogress.cpp
264 pv/popups/deviceoptions.cpp
265 pv/popups/channels.cpp
272 pv/subwindows/subwindowbase.cpp
273 pv/toolbars/mainbar.cpp
274 pv/views/trace/analogsignal.cpp
275 pv/views/trace/cursor.cpp
276 pv/views/trace/cursorpair.cpp
277 pv/views/trace/flag.cpp
278 pv/views/trace/header.cpp
279 pv/views/trace/marginwidget.cpp
280 pv/views/trace/logicsignal.cpp
281 pv/views/trace/ruler.cpp
282 pv/views/trace/signal.cpp
283 pv/views/trace/timeitem.cpp
284 pv/views/trace/timemarker.cpp
285 pv/views/trace/trace.cpp
286 pv/views/trace/tracegroup.cpp
287 pv/views/trace/tracepalette.cpp
288 pv/views/trace/tracetreeitem.cpp
289 pv/views/trace/tracetreeitemowner.cpp
290 pv/views/trace/triggermarker.cpp
291 pv/views/trace/view.cpp
292 pv/views/trace/viewitem.cpp
293 pv/views/trace/viewitemowner.cpp
294 pv/views/trace/viewitempaintparams.cpp
295 pv/views/trace/viewport.cpp
296 pv/views/trace/viewwidget.cpp
297 pv/views/viewbase.cpp
298 pv/views/trace/standardbar.cpp
299 pv/widgets/colorbutton.cpp
300 pv/widgets/colorpopup.cpp
301 pv/widgets/devicetoolbutton.cpp
302 pv/widgets/exportmenu.cpp
303 pv/widgets/flowlayout.cpp
304 pv/widgets/importmenu.cpp
306 pv/widgets/popuptoolbutton.cpp
307 pv/widgets/sweeptimingwidget.cpp
308 pv/widgets/timestampspinbox.cpp
309 pv/widgets/wellarray.cpp
312 # This list includes only QObject derived class headers.
313 set(pulseview_HEADERS
315 pv/globalsettings.hpp
319 pv/binding/device.hpp
321 pv/data/analogsegment.hpp
323 pv/data/logicsegment.hpp
324 pv/data/signalbase.hpp
325 pv/dialogs/connect.hpp
326 pv/dialogs/inputoutputoptions.hpp
327 pv/dialogs/settings.hpp
328 pv/dialogs/storeprogress.hpp
329 pv/popups/channels.hpp
330 pv/popups/deviceoptions.hpp
337 pv/subwindows/subwindowbase.hpp
338 pv/toolbars/mainbar.hpp
339 pv/views/trace/analogsignal.hpp
340 pv/views/trace/cursor.hpp
341 pv/views/trace/flag.hpp
342 pv/views/trace/header.hpp
343 pv/views/trace/logicsignal.hpp
344 pv/views/trace/marginwidget.hpp
345 pv/views/trace/ruler.hpp
346 pv/views/trace/signal.hpp
347 pv/views/trace/timeitem.hpp
348 pv/views/trace/timemarker.hpp
349 pv/views/trace/trace.hpp
350 pv/views/trace/tracegroup.hpp
351 pv/views/trace/tracetreeitem.hpp
352 pv/views/trace/triggermarker.hpp
353 pv/views/trace/view.hpp
354 pv/views/trace/viewitem.hpp
355 pv/views/trace/viewport.hpp
356 pv/views/trace/viewwidget.hpp
357 pv/views/viewbase.hpp
358 pv/views/trace/standardbar.hpp
359 pv/widgets/colorbutton.hpp
360 pv/widgets/colorpopup.hpp
361 pv/widgets/devicetoolbutton.hpp
362 pv/widgets/exportmenu.hpp
363 pv/widgets/flowlayout.hpp
364 pv/widgets/importmenu.hpp
366 pv/widgets/popuptoolbutton.hpp
367 pv/widgets/sweeptimingwidget.hpp
368 pv/widgets/timestampspinbox.hpp
369 pv/widgets/wellarray.hpp
372 set(pulseview_RESOURCES
377 list(APPEND pulseview_SOURCES signalhandler.cpp)
378 list(APPEND pulseview_HEADERS signalhandler.hpp)
382 list(APPEND pulseview_SOURCES
383 pv/binding/decoder.cpp
384 pv/data/decodesignal.cpp
385 pv/data/decode/annotation.cpp
386 pv/data/decode/decoder.cpp
387 pv/data/decode/row.cpp
388 pv/data/decode/rowdata.cpp
389 pv/subwindows/decoder_selector/item.cpp
390 pv/subwindows/decoder_selector/model.cpp
391 pv/subwindows/decoder_selector/subwindow.cpp
392 pv/views/decoder_output/view.cpp
393 pv/views/decoder_output/QHexView.cpp
394 pv/views/trace/decodetrace.cpp
395 pv/widgets/decodergroupbox.cpp
396 pv/widgets/decodermenu.cpp
399 list(APPEND pulseview_HEADERS
400 pv/data/decodesignal.hpp
401 pv/subwindows/decoder_selector/subwindow.hpp
402 pv/views/decoder_output/view.hpp
403 pv/views/decoder_output/QHexView.hpp
404 pv/views/trace/decodetrace.hpp
405 pv/widgets/decodergroupbox.hpp
406 pv/widgets/decodermenu.hpp
411 # Use the sigrok icon for the pulseview.exe executable.
412 set(CMAKE_RC_COMPILE_OBJECT "${CMAKE_RC_COMPILER} -O coff -I${CMAKE_CURRENT_SOURCE_DIR} <SOURCE> <OBJECT>")
414 list(APPEND pulseview_SOURCES pulseviewico.rc)
418 list(APPEND pulseview_SOURCES
419 android/assetreader.cpp
420 android/loghandler.cpp
424 qt5_add_resources(pulseview_RESOURCES_RCC ${pulseview_RESOURCES})
426 #===============================================================================
428 #-------------------------------------------------------------------------------
430 file(GLOB TS_FILES ${CMAKE_SOURCE_DIR}/l10n/*.ts)
431 set_property(SOURCE ${TS_FILES} PROPERTY OUTPUT_LOCATION ${CMAKE_BINARY_DIR}/l10n)
432 if (NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
433 configure_file("translations.qrc" "translations.qrc" COPYONLY)
436 qt5_add_translation(QM_FILES ${TS_FILES})
437 qt5_create_translation(QM_FILES ${pulseview_SOURCES} ${TS_FILES})
439 qt5_add_resources(pulseview_RESOURCES_RCC ${CMAKE_BINARY_DIR}/translations.qrc)
441 #===============================================================================
442 #= Global Definitions
443 #-------------------------------------------------------------------------------
445 add_definitions(-DQT_NO_KEYWORDS)
446 add_definitions(-D__STDC_LIMIT_MACROS)
447 add_definitions(-Wall -Wextra)
448 add_definitions(-std=c++11)
449 add_definitions(-DBOOST_MATH_DISABLE_FLOAT128=1)
452 add_definitions(-DENABLE_FLOW)
456 add_definitions(-DENABLE_DECODE)
459 if(NOT DISABLE_WERROR)
460 add_definitions(-Werror)
464 add_definitions(-DENABLE_SIGNALS)
467 if(ENABLE_STACKTRACE)
468 add_definitions(-DENABLE_STACKTRACE)
471 #===============================================================================
472 #= Global Include Directories
473 #-------------------------------------------------------------------------------
476 ${CMAKE_CURRENT_BINARY_DIR}
477 ${CMAKE_CURRENT_SOURCE_DIR}
478 ${Boost_INCLUDE_DIRS}
481 if(STATIC_PKGDEPS_LIBS)
482 include_directories(${PKGDEPS_STATIC_INCLUDE_DIRS})
484 include_directories(${PKGDEPS_INCLUDE_DIRS})
487 #===============================================================================
488 #= Linker Configuration
489 #-------------------------------------------------------------------------------
491 link_directories(${Boost_LIBRARY_DIRS})
493 set(PULSEVIEW_LINK_LIBS
496 ${CMAKE_THREAD_LIBS_INIT}
500 if(STATIC_PKGDEPS_LIBS)
501 link_directories(${PKGDEPS_STATIC_LIBRARY_DIRS})
502 list(APPEND PULSEVIEW_LINK_LIBS ${PKGDEPS_STATIC_LDFLAGS})
504 link_directories(${PKGDEPS_LIBRARY_DIRS})
505 list(APPEND PULSEVIEW_LINK_LIBS ${PKGDEPS_LIBRARIES})
509 # On Windows we need to statically link the libqsvg imageformat
510 # plugin (and the QtSvg component) for SVG graphics/icons to work.
511 # We also need QWindowsIntegrationPlugin, Qt5PlatformSupport (only for
512 # Qt < 5.8.0), and all Qt libs and their dependencies.
513 add_definitions(-DQT_STATICPLUGIN)
514 list(APPEND PULSEVIEW_LINK_LIBS Qt5::QSvgPlugin)
515 list(APPEND PULSEVIEW_LINK_LIBS Qt5::QWindowsIntegrationPlugin)
516 if(Qt5Gui_VERSION VERSION_LESS 5.8.0)
517 list(APPEND PULSEVIEW_LINK_LIBS -lQt5PlatformSupport)
519 list(APPEND PULSEVIEW_LINK_LIBS ${QT5ALL_LDFLAGS})
522 if(ENABLE_STACKTRACE)
523 # Needed to resolve dladdr.
524 list(APPEND PULSEVIEW_LINK_LIBS "-ldl")
528 list(APPEND PULSEVIEW_LINK_LIBS "-llog")
531 set(INPUT_FILES_LIST ${pulseview_SOURCES} ${pulseview_RESOURCES_RCC} ${QM_FILES})
533 add_library(${PROJECT_NAME} SHARED ${INPUT_FILES_LIST})
535 add_executable(${PROJECT_NAME} ${INPUT_FILES_LIST})
538 target_link_libraries(${PROJECT_NAME} ${PULSEVIEW_LINK_LIBS})
540 if(WIN32 AND NOT ${CMAKE_BUILD_TYPE} STREQUAL "Debug")
541 # Pass -mwindows so that no "DOS box" opens when PulseView is started.
542 set_target_properties(${PROJECT_NAME} PROPERTIES LINK_FLAGS "-mwindows")
545 #===============================================================================
547 #-------------------------------------------------------------------------------
549 # Install the executable.
550 install(TARGETS ${PROJECT_NAME} DESTINATION bin/)
552 # Install the manpage.
553 install(FILES doc/pulseview.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 COMPONENT doc)
555 # Install the desktop file.
556 install(FILES contrib/org.sigrok.PulseView.desktop DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/applications)
558 # Install the AppData/AppStream file.
559 install(FILES contrib/org.sigrok.PulseView.appdata.xml DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/metainfo)
561 # Install the PulseView icons.
562 install(FILES icons/pulseview.png DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/48x48/apps)
563 install(FILES icons/pulseview.svg DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/apps)
565 # Generate Windows installer script.
566 configure_file(contrib/pulseview_cross.nsi.in ${CMAKE_CURRENT_BINARY_DIR}/contrib/pulseview_cross.nsi @ONLY)
568 #===============================================================================
569 #= Packaging (handled by CPack)
570 #-------------------------------------------------------------------------------
572 set(CPACK_PACKAGE_VERSION_MAJOR ${PV_VERSION_MAJOR})
573 set(CPACK_PACKAGE_VERSION_MINOR ${PV_VERSION_MINOR})
574 set(CPACK_PACKAGE_VERSION_PATCH ${PV_VERSION_MICRO})
575 set(CPACK_PACKAGE_DESCRIPTION_FILE ${CMAKE_CURRENT_SOURCE_DIR}/README)
576 set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_CURRENT_SOURCE_DIR}/COPYING)
577 set(CPACK_SOURCE_IGNORE_FILES ${CMAKE_CURRENT_BINARY_DIR} ".gitignore" ".git")
578 set(CPACK_SOURCE_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${PV_VERSION_STRING}")
579 set(CPACK_SOURCE_GENERATOR "TGZ")
583 #===============================================================================
585 #-------------------------------------------------------------------------------
588 add_subdirectory(test)
590 add_test(test ${CMAKE_CURRENT_BINARY_DIR}/test/pulseview-test)