Cmake refactorings (#95)

GuLinux · web-flow · commit dafda4d3e993 · 2019-06-18T11:41:29.000+01:00
* Use cmake configuration file instead of inline definitions.
Move mount files in separate library

* Fix frontend compilation

#skip_ci
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -19,7 +19,6 @@ include(cmake/functions.cmake)
 
 external_project_download(cmake/GuLinux-Commons.cmake.in GuLinux-Commons)
 
-add_definitions(-DSRC_DIR="${CMAKE_SOURCE_DIR}")
 configure_file(${CMAKE_SOURCE_DIR}/scripts/version.sh.in ${CMAKE_BINARY_DIR}/scripts/version.sh)
 
 if(NOT OSX_BUNDLE)
diff --git a/cmake/find_dependencies.cmake b/cmake/find_dependencies.cmake
@@ -10,7 +10,6 @@ find_package(Qt5Network REQUIRED )
 find_package(Qt5OpenGL)
 if(Qt5OpenGL_FOUND AND NOT ${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
   message("Using OpenGL renderer for image view")
-  add_definitions(-DHAVE_QT5_OPENGL)
   set(Qt5_OpenGL_LIBRARIES Qt5::OpenGL)
 endif()
 include_directories(${Qt5Widgets_INCLUDE_DIRS} ${Qt5PrintSupport_INCLUDE_DIRS})
diff --git a/cmake/functions.cmake b/cmake/functions.cmake
@@ -47,11 +47,6 @@ function(add_driver)
   set(enabled_drivers ${enabled_drivers} ${add_driver_NAME} CACHE INTERNAL "")
 endfunction()
 
-# Updates the specified CMake variable in the parent scope
-macro(update_parent VAR_NAME)
-    set(${VAR_NAME} ${${VAR_NAME}} PARENT_SCOPE)
-endmacro(update_parent)
-
 function(external_project_download IN_FILE OUT_DIR)
   configure_file(${IN_FILE} ${OUT_DIR}_download/CMakeLists.txt)
   execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" .
diff --git a/cmake/options.cmake b/cmake/options.cmake
@@ -20,26 +20,14 @@ option(ADD_DRIVERS_BUILD_DIRECTORY "Search for drivers in the current build dire
 
 # Developer mode: log all message to stderr
 option(DEVELOPER_MODE "Force logging mode to debug" OFF)
-if(DEVELOPER_MODE)
-  add_definitions(-DDEVELOPER_MODE)
-endif()
-
 option(DEBUG_NETWORK_PACKETS "Debug network packets" OFF)
-if(DEBUG_NETWORK_PACKETS)
-  add_definitions(-DDEBUG_NETWORK_PACKETS)
-endif()
-
 option(DISABLE_TRACKING "Disable tracking implementation" ON)
-if(DISABLE_TRACKING)
-    add_definitions(-DDISABLE_TRACKING)
-endif()
 
 # Extra executables to be built
 if("${CPACK_GENERATOR}" STREQUAL "DragNDrop")
     message("Disabling PlanetaryImager network daemon and frontend in bundle mode")
     set(build_network_server Off)
     set(OSX_BUNDLE On)
-    add_definitions(-DOSX_BUNDLE=1)
     set(CMAKE_INSTALL_PREFIX /)
     set(MACOSX_BUNDLE_BUNDLE_NAME PlanetaryImager)
     set(MACOSX_BUNDLE_BUNDLE_VERSION ${FULL_VERSION})
diff --git a/cmake/utils.cmake b/cmake/utils.cmake
@@ -11,5 +11,4 @@
   set(PlanetaryImager_ARCH i686)
  endif (CMAKE_HOST_SYSTEM_PROCESSOR MATCHES "armv6l")
 
- add_definitions(-DHOST_PROCESSOR="${CMAKE_HOST_SYSTEM_PROCESSOR}" -DARCHITECTURE="${PlanetaryImager_ARCH}")
  message("Detected architecture: ${PlanetaryImager_ARCH}")
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -1,15 +1,6 @@
 set(PlanetaryImager_GUI_SRCS planetaryimager_mainwindow.cpp mainwindowwidgets.cpp planetaryimager_mainwindow.ui resources/resources.qrc)
 set(PlanetaryImager_SRCS planetaryimager_main.cpp ${PlanetaryImager_GUI_SRCS})
-
-
-if(static_qt_windows)
-    add_definitions(-DSTATIC_WINDOWS_PLUGIN)
-endif()
-
-
-if(HAVE_LIBINDI)
-    add_definitions(-DHAVE_LIBINDI)
-endif()
+include_directories(${CMAKE_CURRENT_BINARY_DIR})
 
 if(OSX_BUNDLE)
     set(drivers_destination ${APPBUNDLE_INSTALL_PREFIX}/Contents/Plugins/${CMAKE_PROJECT_NAME})
@@ -23,26 +14,27 @@ set(CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXE
 if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
   set(drivers_destination drivers)
   set(binary_destination .)
-  add_definitions(-DDRIVERS_DIRECTORY="${drivers_destination}")
+  set(DRIVERS_DIRECTORY "${drivers_destination}")
 else()
   if(OSX_BUNDLE)
-      add_definitions(-DDRIVERS_DIRECTORY="../Plugins/${CMAKE_PROJECT_NAME}")
+      set(DRIVERS_DIRECTORY "../Plugins/${CMAKE_PROJECT_NAME}")
       set(CMAKE_INSTALL_RPATH "@executable_path/../Frameworks" "@executable_path/../../Frameworks")
   else()
-      add_definitions(-DDRIVERS_DIRECTORY="${CMAKE_INSTALL_PREFIX}/${drivers_destination}")
+      set(DRIVERS_DIRECTORY "${CMAKE_INSTALL_PREFIX}/${drivers_destination}")
   endif()
 endif()
 
 
 if(ADD_DRIVERS_BUILD_DIRECTORY)
-  add_definitions(-DADDITIONAL_DRIVERS_DIRECTORY="${CMAKE_CURRENT_BINARY_DIR}/drivers")
+    set(ADDITIONAL_DRIVERS_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/drivers")
 endif()
 
 add_subdirectory(drivers)
 add_subdirectory(image_handlers)
 add_subdirectory(widgets)
 add_subdirectory(commons)
 add_subdirectory(network)
+add_subdirectory(mount)
 
 
 message(STATUS "********* ExtraLibraries: ${EXTRA_LIBRARIES}")
@@ -68,7 +60,6 @@ target_link_libraries(${appname}
     network_server
     ${planetary_imager_backend_DEPS}
     ${planetary_imager_frontend_DEPS}
-    ${planetary_imager_commons_DEPS}
     ${planetary_imager_backend_DEPS}
     ${planetary_imager_commons_DEPS}
     GuLinux_Qt_Commons
@@ -89,8 +80,6 @@ if(build_network_server)
     network_server
     ${planetary_imager_backend_DEPS}
     ${planetary_imager_commons_DEPS}
-    ${planetary_imager_backend_DEPS}
-    ${planetary_imager_commons_DEPS}
     GuLinux_Qt_Commons
     GuLinux_c++_Commons
     ${Boost_LIBRARIES}
@@ -144,4 +133,5 @@ else()
     install(TARGETS ${install_targets} RUNTIME DESTINATION ${binary_destination})
 endif()
 
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/commons/definitions.h.in ${CMAKE_CURRENT_BINARY_DIR}/commons/definitions.h)
 
diff --git a/src/commons/CMakeLists.txt b/src/commons/CMakeLists.txt
@@ -1,18 +1,5 @@
-set(planetaryimager-commons-INCLUDE_DIRS "" CACHE INTERNAL "")
-set(planetaryimager-commons-LINK-DIRS "" CACHE INTERNAL "")
-set(planetaryimager-commons-LIBS "" CACHE INTERNAL "")
-set(planetaryimager-commons-DEFS "" CACHE INTERNAL "")
-
 file(GLOB planetaryimager-commons-SRCS *.cpp)
 configure_file(version.h.in version.h)
 
-add_subdirectory(mount)
-
 add_library(planetaryimager-commons STATIC ${planetaryimager-commons-SRCS})
-
-add_definitions(${planetaryimager-commons-DEFS})
-target_include_directories(planetaryimager-commons PRIVATE ${planetaryimager-commons-INCLUDE_DIRS})
-link_directories(${planetaryimager-commons-LINK-DIRS})
-target_link_libraries(planetaryimager-commons ${planetaryimager-commons-LIBS})
-
 add_imager_dependencies(planetaryimager-commons)
diff --git a/src/commons/commandline.cpp b/src/commons/commandline.cpp
@@ -25,6 +25,7 @@
 #include <iostream>
 #include "loghandler.h"
 #include <QStandardPaths>
+#include "commons/definitions.h"
 
 using namespace std;
 using namespace std::placeholders;
@@ -58,12 +59,10 @@ CommandLine::~CommandLine()
 
 CommandLine & CommandLine::backend()
 {
-
-#ifdef OSX_BUNDLE
-  QString driversDirectory = QCoreApplication::applicationDirPath() + "/" + DRIVERS_DIRECTORY;
-#else
   QString driversDirectory = DRIVERS_DIRECTORY;
-#endif
+  if(OSX_BUNDLE == 1) {
+    driversDirectory = QCoreApplication::applicationDirPath() + "/" + DRIVERS_DIRECTORY;
+  }
   d->parser.addOption({"drivers", "Drivers directory", "drivers_directory_path", driversDirectory});
   d->loggingOptions();
   return *this;
@@ -112,9 +111,9 @@ CommandLine & CommandLine::process()
 QStringList CommandLine::driversDirectories() const
 {
   QStringList drivers(d->parser.value("drivers"));
-#ifdef ADDITIONAL_DRIVERS_DIRECTORY
-  drivers << ADDITIONAL_DRIVERS_DIRECTORY;
-#endif
+  if(ADD_DRIVERS_BUILD_DIRECTORY == 1) {
+      drivers << ADDITIONAL_DRIVERS_DIRECTORY;
+  }
   return drivers;
 }
 
diff --git a/src/commons/definitions.h.in b/src/commons/definitions.h.in
@@ -0,0 +1,19 @@
+#ifndef DEFINITIONS_H
+#define DEFINITIONS_H
+
+#cmakedefine01 DEVELOPER_MODE
+#cmakedefine01 DEBUG_NETWORK_PACKETS
+#cmakedefine01 DISABLE_TRACKING
+#cmakedefine01 OSX_BUNDLE
+#cmakedefine01 STATIC_QT_WINDOWS
+#cmakedefine01 HAVE_LIBINDI
+#cmakedefine01 ADD_DRIVERS_BUILD_DIRECTORY
+
+#define DRIVERS_DIRECTORY "${DRIVERS_DIRECTORY}"
+#define ADDITIONAL_DRIVERS_DIRECTORY "${ADDITIONAL_DRIVERS_DIRECTORY}"
+#define SRC_DIR "${CMAKE_SOURCE_DIR}"
+#define HOST_PROCESSOR "${CMAKE_HOST_SYSTEM_PROCESSOR}"
+#define ARCHITECTURE "${PlanetaryImager_ARCH}"
+
+#endif
+
diff --git a/src/commons/loghandler.cpp b/src/commons/loghandler.cpp
@@ -27,6 +27,7 @@
 #include "commons/commandline.h"
 #include <QMutex>
 #include <QMutexLocker>
+#include "commons/definitions.h"
 
 using namespace std;
 using namespace std::placeholders;
@@ -65,7 +66,7 @@ void LogHandler::Private::log_handler(QtMsgType type, const QMessageLogContext &
     {QtDebugMsg   , 50},
   };
   for(auto output: outputs) {
-#ifndef DEVELOPER_MODE
+#if DEVELOPER_MODE == 0
     if(priority[type] > priority[output.level])
       continue;
 #endif
diff --git a/src/commons/mount/CMakeLists.txt b/src/commons/mount/CMakeLists.txt
diff --git a/src/image_handlers/output_writers/CMakeLists.txt b/src/image_handlers/output_writers/CMakeLists.txt
@@ -5,5 +5,4 @@ add_backend_dependencies(ser_writer)
 add_library(image_file_writer STATIC imagefilewriter.cpp)
 add_backend_dependencies(image_file_writer)
 add_library(video_writer STATIC cvvideowriter.cpp)
-add_definitions(-DHAVE_CV_VIDEO)
 add_backend_dependencies(video_writer)
diff --git a/src/mount/CMakeLists.txt b/src/mount/CMakeLists.txt
@@ -0,0 +1,23 @@
+set(mount-SRCS mount.cpp)
+add_backend_dependencies(mount)
+# Temporary hack: adding to both frontend and backend to let the client compile. This should really be a backend dependency only.
+add_frontend_dependencies(mount)
+
+if(HAVE_LIBINDI)
+    set(enabled_mounts ${enabled_mounts} INDI CACHE INTERNAL "")
+    set(mount-SRCS ${mount-SRCS} indi.cpp)
+
+    # Do not use ${LIBINDI_LIBRARIES}; on some installations it may be missing "libindiclient" (which we need),
+    # and contain "libindidriver" (not needed, and requiring additional dependencies).
+    find_package(Threads REQUIRED)
+
+    add_backend_dependencies(indiclient ${CMAKE_THREAD_LIBS_INIT})
+    # Temporary hack: adding to both frontend and backend to let the client compile. This should really be a backend dependency only.
+    add_frontend_dependencies(indiclient ${CMAKE_THREAD_LIBS_INIT})
+    message("INDI support enabled (Mount).")
+else()
+    message("INDI support disabled: libindi not found.")
+endif()
+
+add_library(mount STATIC ${mount-SRCS})
+
diff --git a/src/mount/indi.cpp b/src/mount/indi.cpp
diff --git a/src/mount/mount.cpp b/src/mount/mount.cpp
@@ -17,6 +17,7 @@
  */
 
 #include "mount.h"
+#include "commons/definitions.h"
 
 namespace Mount
 {
@@ -26,12 +27,7 @@ bool isConnectionSupported(ConnectionType connType)
     switch (connType)
     {
         case ConnectionType::INDI:
-#ifdef HAVE_LIBINDI
-            return true;
-#else
-            return false;
-#endif
-
+            return HAVE_LIBINDI == 1;
         case ConnectionType::SkyWatcher:
             return false;
         // safety net, returning false as driver is unknown
diff --git a/src/mount/mount.h b/src/mount/mount.h
diff --git a/src/network/networkdispatcher.cpp b/src/network/networkdispatcher.cpp
@@ -26,7 +26,8 @@
 #include "commons/utils.h"
 #include <QCoreApplication>
 #include "Qt/qt_strings_helper.h"
-#ifdef DEVELOPER_MODE
+#include "commons/definitions.h"
+#if DEVELOPER_MODE == 1
 #include "commons/loghandler.h"
 #endif
 
@@ -124,7 +125,7 @@ bool NetworkDispatcher::is_connected() const
 
 void NetworkDispatcher::Private::debugPacket(const NetworkPacketPtr& packet, const QString& prefix)
 {
-#ifdef DEBUG_NETWORK_PACKETS
+#if DEBUG_NETWORK_PACKETS == 1
     QString payload;
     if(packet->payloadVariant().isValid()) {
         QDebug(&payload) << packet->payloadVariant();
diff --git a/src/network/server/networkserver.cpp b/src/network/server/networkserver.cpp
@@ -31,6 +31,7 @@
 #include "network/server/filesystemforwarder.h"
 #include "image_handlers/saveimages.h"
 #include "planetaryimager.h"
+#include "commons/definitions.h"
 
 using namespace std;
 using namespace std::placeholders;
@@ -109,7 +110,7 @@ namespace {
 
 void NetworkServer::Private::bytes_sent(quint64 written, quint64 sent)
 {
-#ifdef DEVELOPER_MODE
+#if DEVELOPER_MODE == 1
     qDebug() << "written: %1 MB, sent: %2 MB, cached: %3 MB, rate: %4 MB/sec"_q
       % to_mb(written) % to_mb(sent) % to_mb(written - sent) % ( to_mb(sent - last_sent) / to_secs(elapsed.elapsed()) );
 #endif
diff --git a/src/planetaryimager.cpp b/src/planetaryimager.cpp
@@ -24,8 +24,9 @@
 #include <QTimer>
 #include "image_handlers/saveimages.h"
 #include "drivers/driver.h"
+#include "commons/definitions.h"
 
-#ifdef STATIC_WINDOWS_PLUGIN
+#if STATIC_QT_WINDOWS == 1
 #pragma message("Initializing Qt static plugins")
 #include <QtPlugin>
 Q_IMPORT_PLUGIN(QWindowsIntegrationPlugin)
diff --git a/src/planetaryimager_daemon.cpp b/src/planetaryimager_daemon.cpp
@@ -32,6 +32,7 @@
 #include "planetaryimager.h"
 #include "Qt/qt_strings_helper.h"
 #include "commons/commandline.h"
+#include "commons/definitions.h"
 #include "commons/frame.h"
 #include "network/networkdispatcher.h"
 
diff --git a/src/planetaryimager_frontend.cpp b/src/planetaryimager_frontend.cpp
@@ -26,6 +26,7 @@
 #include <QMenu>
 #include "commons/commandline.h"
 #include "commons/frame.h"
+#include "commons/definitions.h"
 
 #include "network/client/gui/connectionmanager.h"
 
diff --git a/src/planetaryimager_main.cpp b/src/planetaryimager_main.cpp
@@ -33,6 +33,7 @@
 #include "image_handlers/threadimagehandler.h"
 #include "commons/frame.h"
 #include "network/networkdispatcher.h"
+#include "commons/definitions.h"
 #include "planetaryimager.h"
 
 using namespace std;
diff --git a/src/planetaryimager_mainwindow.cpp b/src/planetaryimager_mainwindow.cpp
diff --git a/src/widgets/mount_dialog.cpp b/src/widgets/mount_dialog.cpp
diff --git a/support/docker/files/configuration-windows-x86_64-static.cmake b/support/docker/files/configuration-windows-x86_64-static.cmake
