Reorganize source code and fix ambiguous class name

TheAssassin · TheAssassin · commit 3cdbe3e44f48 · 2022-08-16T02:58:08.000+02:00
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -26,96 +26,12 @@ endif()
 
 add_subdirectory(util)
 add_subdirectory(updateinformation)
-add_subdirectory(appimage)
-
-# core library
-add_library(libappimageupdate SHARED
-    ${PROJECT_SOURCE_DIR}/include/appimage/update.h
-    updater.cpp
-)
-# since the target is called libsomething, one doesn't need CMake's additional lib prefix
-set_target_properties(libappimageupdate
-    PROPERTIES
-    PREFIX ""
-    PUBLIC_HEADER ${PROJECT_SOURCE_DIR}/include/appimage/update.h
-)
-# link thread libraries
-target_link_libraries(libappimageupdate
-    PRIVATE ${CMAKE_THREAD_LIBS_INIT}
-    PRIVATE ${CPR_LIBRARIES}
-    PRIVATE util
-    PRIVATE appimage
-    ${ZSYNC2_LINK_TYPE} ${ZSYNC2_LIBRARY_NAME}
-)
-# include directories, publicly
-target_include_directories(libappimageupdate
-    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-    PUBLIC $<INSTALL_INTERFACE:include>
-)
-set_target_properties(libappimageupdate PROPERTIES INSTALL_RPATH "\$ORIGIN/")
-
-
-# core library
-add_library(libappimageupdate_static STATIC
-    ${PROJECT_SOURCE_DIR}/include/appimage/update.h
-    updater.cpp
-)
-# since the target is called libsomething, one doesn't need CMake's additional lib prefix
-set_target_properties(libappimageupdate_static
-    PROPERTIES
-    PREFIX ""
-    OUTPUT_NAME "libappimageupdate"
-    PUBLIC_HEADER ${PROJECT_SOURCE_DIR}/include/appimage/update.h
-)
-# link thread libraries
-target_link_libraries(libappimageupdate_static
-    PRIVATE appimage
-    PRIVATE ${CMAKE_THREAD_LIBS_INIT}
-    PRIVATE ${CPR_LIBRARIES}
-    PRIVATE util
-    ${ZSYNC2_LINK_TYPE} ${ZSYNC2_LIBRARY_NAME}
-)
-# include directories, publicly
-target_include_directories(libappimageupdate_static
-    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-    PUBLIC $<INSTALL_INTERFACE:include>
-)
-
+add_subdirectory(updater)
 
 if(NOT BUILD_LIBAPPIMAGEUPDATE_ONLY)
-    # CLI application
-    add_executable(appimageupdatetool main.cpp)
-    # link to core lib
-    target_link_libraries(appimageupdatetool libappimageupdate util)
-    if(NOT USE_SYSTEM_ZSYNC2)
-        target_link_libraries(appimageupdatetool ${ZSYNC2_LIBRARY_NAME})
-    endif()
-
-    # set up rpath
-    set_target_properties(libappimageupdate libappimageupdate_static PROPERTIES INSTALL_RPATH "\$ORIGIN")
-    set_target_properties(appimageupdatetool PROPERTIES INSTALL_RPATH "\$ORIGIN/../${CMAKE_INSTALL_LIBDIR}")
+    add_subdirectory(cli)
 endif()
 
-# install targets
-install(
-    TARGETS libappimageupdate
-    EXPORT AppImageUpdateTargets
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT LIBAPPIMAGEUPDATE
-    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/appimage COMPONENT LIBAPPIMAGEUPDATE-DEV
-)
-install(
-    TARGETS libappimageupdate_static
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT LIBAPPIMAGEUPDATE
-    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/appimage COMPONENT LIBAPPIMAGEUPDATE-DEV
-)
-if(NOT BUILD_LIBAPPIMAGEUPDATE_ONLY)
-    install(
-        TARGETS appimageupdatetool
-        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT APPIMAGEUPDATETOOL
-    )
-endif()
-
-
 # include Qt UI
 if(BUILD_QT_UI)
     add_subdirectory(qt-ui)
diff --git a/src/appimage/CMakeLists.txt b/src/appimage/CMakeLists.txt
diff --git a/src/cli/CMakeLists.txt b/src/cli/CMakeLists.txt
@@ -0,0 +1,16 @@
+# CLI application
+add_executable(appimageupdatetool main.cpp)
+# link to core lib
+target_link_libraries(appimageupdatetool libappimageupdate util)
+if(NOT USE_SYSTEM_ZSYNC2)
+    target_link_libraries(appimageupdatetool ${ZSYNC2_LIBRARY_NAME})
+endif()
+
+# set up rpath
+set_target_properties(appimageupdatetool PROPERTIES INSTALL_RPATH "\$ORIGIN/../${CMAKE_INSTALL_LIBDIR}")
+
+# install target
+install(
+    TARGETS appimageupdatetool
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT APPIMAGEUPDATETOOL
+)
diff --git a/src/cli/main.cpp b/src/cli/main.cpp
diff --git a/src/updater/CMakeLists.txt b/src/updater/CMakeLists.txt
@@ -0,0 +1,67 @@
+# core library
+add_library(libappimageupdate SHARED
+    ${PROJECT_SOURCE_DIR}/include/appimage/update.h
+    updater.cpp
+)
+# since the target is called libsomething, one doesn't need CMake's additional lib prefix
+set_target_properties(libappimageupdate
+    PROPERTIES
+    PREFIX ""
+    PUBLIC_HEADER ${PROJECT_SOURCE_DIR}/include/appimage/update.h
+)
+# link thread libraries
+target_link_libraries(libappimageupdate
+    PRIVATE ${CMAKE_THREAD_LIBS_INIT}
+    PRIVATE ${CPR_LIBRARIES}
+    PRIVATE util
+    PRIVATE updateinformation
+    ${ZSYNC2_LINK_TYPE} ${ZSYNC2_LIBRARY_NAME}
+)
+# include directories, publicly
+target_include_directories(libappimageupdate
+    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    PUBLIC $<INSTALL_INTERFACE:include>
+)
+set_target_properties(libappimageupdate PROPERTIES INSTALL_RPATH "\$ORIGIN/")
+
+
+# core library
+add_library(libappimageupdate_static STATIC
+    ${PROJECT_SOURCE_DIR}/include/appimage/update.h
+    updater.cpp
+)
+# since the target is called libsomething, one doesn't need CMake's additional lib prefix
+set_target_properties(libappimageupdate_static
+    PROPERTIES
+    PREFIX ""
+    OUTPUT_NAME "libappimageupdate"
+    PUBLIC_HEADER ${PROJECT_SOURCE_DIR}/include/appimage/update.h
+)
+# link thread libraries
+target_link_libraries(libappimageupdate_static
+    PRIVATE ${CMAKE_THREAD_LIBS_INIT}
+    PRIVATE ${CPR_LIBRARIES}
+    PRIVATE util
+    PRIVATE updateinformation
+    ${ZSYNC2_LINK_TYPE} ${ZSYNC2_LIBRARY_NAME}
+)
+# include directories, publicly
+target_include_directories(libappimageupdate_static
+    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    PUBLIC $<INSTALL_INTERFACE:include>
+)
+# set up rpath
+set_target_properties(libappimageupdate libappimageupdate_static PROPERTIES INSTALL_RPATH "\$ORIGIN")
+
+# install targets
+install(
+    TARGETS libappimageupdate
+    EXPORT AppImageUpdateTargets
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT LIBAPPIMAGEUPDATE
+    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/appimage COMPONENT LIBAPPIMAGEUPDATE-DEV
+)
+install(
+    TARGETS libappimageupdate_static
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT LIBAPPIMAGEUPDATE
+    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/appimage COMPONENT LIBAPPIMAGEUPDATE-DEV
+)
diff --git a/src/updater/updater.cpp b/src/updater/updater.cpp
@@ -17,7 +17,7 @@
 // local headers
 #include "appimage/update.h"
 #include "updateinformation/updateinformation.h"
-#include "appimage/appimage.h"
+#include "util/updatableappimage.h"
 #include "util/util.h"
 #include "zsutil.h"
 
@@ -42,7 +42,7 @@ namespace appimage::update {
         {};
 
     public:
-        AppImage appImage;
+        UpdatableAppImage appImage;
 
         // we call this "raw" update information to highlight the difference between strings and the new
         // UpdateInformation infrastructure
@@ -388,14 +388,14 @@ namespace appimage::update {
             return VALIDATION_FAILED;
         }
 
-        AppImage newAppImage(pathToNewAppImage);
+        UpdatableAppImage newAppImage(pathToNewAppImage);
 
         auto pathToOldAppImage = abspath(d->appImage.path());
         if (pathToOldAppImage == pathToNewAppImage) {
             pathToOldAppImage = pathToNewAppImage + ".zs-old";
         }
 
-        AppImage oldAppImage(pathToOldAppImage);
+        UpdatableAppImage oldAppImage(pathToOldAppImage);
 
         auto oldSignature = oldAppImage.readSignature();
         auto newSignature = newAppImage.readSignature();
diff --git a/src/util/CMakeLists.txt b/src/util/CMakeLists.txt
@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.19)
 
 add_library(util STATIC
     util.cpp
-    util.h
+    updatableappimage.cpp
 )
 # include the complete source to force the use of project-relative include paths
 target_include_directories(util
diff --git a/src/util/updatableappimage.cpp b/src/util/updatableappimage.cpp
@@ -3,7 +3,7 @@
 #include <zshash.h>
 
 // local headers
-#include "appimage.h"
+#include "updatableappimage.h"
 #include "updateinformation/updateinformation.h"
 #include "util/util.h"
 
@@ -12,20 +12,20 @@ namespace appimage::update {
     using namespace util;
     using namespace zsync2;
 
-    void AppImage::assertIfstreamGood(const std::ifstream& ifs) const {
+    void UpdatableAppImage::assertIfstreamGood(const std::ifstream& ifs) const {
         if (!ifs || !ifs.good()) {
             throw AppImageError("Error while opening/accessing/reading from AppImage: " + _path);
         }
     }
 
-    std::ifstream AppImage::_open() const  {
+    std::ifstream UpdatableAppImage::_open() const  {
         // check whether file exists
         std::ifstream ifs(_path);
         assertIfstreamGood(ifs);
         return ifs;
     }
 
-    bool AppImage::_hasElfMagicValue(std::ifstream& ifs) const {
+    bool UpdatableAppImage::_hasElfMagicValue(std::ifstream& ifs) const {
         static constexpr int elfMagicPos = 0;
         static const std::string elfMagicValue = "\7ELF";
 
@@ -40,7 +40,7 @@ namespace appimage::update {
         return elfMagicPosData.data() == elfMagicValue;
     }
 
-    bool AppImage::_hasIsoMagicValue(std::ifstream& ifs) const {
+    bool UpdatableAppImage::_hasIsoMagicValue(std::ifstream& ifs) const {
         static constexpr int isoMagicPos = 32769;
         static const std::string isoMagicValue = "CD001";
 
@@ -55,13 +55,13 @@ namespace appimage::update {
         return isoMagicPosData.data() == isoMagicValue;
     }
 
-    AppImage::AppImage(std::string path) : _path(std::move(path)) {}
+    UpdatableAppImage::UpdatableAppImage(std::string path) : _path(std::move(path)) {}
 
-    std::string AppImage::path() const {
+    std::string UpdatableAppImage::path() const {
         return _path;
     }
 
-    int AppImage::appImageType() const {
+    int UpdatableAppImage::appImageType() const {
         auto ifs = _open();
 
         // read magic number
@@ -97,7 +97,7 @@ namespace appimage::update {
         throw AppImageError("Unknown AppImage type or not an AppImage");
     }
 
-    std::string AppImage::readSignature() const {
+    std::string UpdatableAppImage::readSignature() const {
         const auto type = appImageType();
 
         if (type != 2) {
@@ -107,7 +107,7 @@ namespace appimage::update {
         return readElfSection(_path, ".sha256_sig");
     }
 
-    std::string AppImage::readSigningKey() const {
+    std::string UpdatableAppImage::readSigningKey() const {
         const auto type = appImageType();
 
         if (type != 2) {
@@ -117,7 +117,7 @@ namespace appimage::update {
         return readElfSection(_path, ".sig_key");
     }
 
-    std::string AppImage::readRawUpdateInformation() const {
+    std::string UpdatableAppImage::readRawUpdateInformation() const {
         auto ifs = _open();
 
         int type;
@@ -156,7 +156,7 @@ namespace appimage::update {
         throw AppImageError("Reading update information not supported for type " + std::to_string(type));
     }
 
-    std::string AppImage::calculateHash() const {
+    std::string UpdatableAppImage::calculateHash() const {
         // read offset and length of signature section to skip it later
         unsigned long sigOffset = 0, sigLength = 0;
         unsigned long keyOffset = 0, keyLength = 0;
diff --git a/src/util/updatableappimage.h b/src/util/updatableappimage.h
@@ -9,7 +9,7 @@ namespace appimage::update {
         using std::runtime_error::runtime_error;
     };
 
-    class AppImage {
+    class UpdatableAppImage {
     private:
         std::string _path;
 
@@ -23,7 +23,7 @@ namespace appimage::update {
         bool _hasIsoMagicValue(std::ifstream& ifs) const;
 
     public:
-        explicit AppImage(std::string path);
+        explicit UpdatableAppImage(std::string path);
 
         [[nodiscard]] std::string path() const;
 

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.19)`
`3`	`3`
`4`	`4`	`add_library(util STATIC`
`5`	`5`	`util.cpp`
`6`		`- util.h`
	`6`	`+ updatableappimage.cpp`
`7`	`7`	`)`
`8`	`8`	`# include the complete source to force the use of project-relative include paths`
`9`	`9`	`target_include_directories(util`