src/cmakelists: add targets to build macos bundles

Add the target memento_bundle to build a bundle for Memento. This
changes the option MEMENTO_APPBUNDLE option to MEMENTO_BUNDLE. It also
makes MEMENTO_CERT a CMake option called MEMENTO_CODESIGN_IDENTITY. If
all this is set, an macOS bundle is created.

This approach is better than Memento 1.0's bundle code since it was very
brittle. It is slow as hell though.

This was primarily generated by Codex.

Fixes an issue where SYSTEM_QCORO was used in some targets instead of
MEMENTO_SYSTEM_QCORO.

Author: ripose-jp

.github/workflows/build.yml

@@ -79,7 +79,7 @@ jobs:
     - name: Install Dependencies
       run: |
         brew update || true
-        brew install cmake sqlite3 qt6 mpv mecab mecab-ipadic json-c libzip python || true
+        brew install git cmake sqlite3 qt6 qcoro6 mpv mecab mecab-ipadic json-c libzip || true
 
     - name: Checkout Repository
       uses: actions/checkout@v4
@@ -88,5 +88,5 @@ jobs:
       run: |
         mkdir build
         cd build
-        cmake .. -DMEMENTO_OCR_SUPPORT=OFF -DMEMENTO_MECAB_SUPPORT=ON -DMEMENTO_WERROR=ON
-        cmake --build . -j $(nproc)
+        cmake .. -DMEMENTO_OCR_SUPPORT=OFF -DMEMENTO_MECAB_SUPPORT=ON -DMEMENTO_SYSTEM_QCORO=ON -DMEMENTO_BUNDLE=ON -DMEMENTO_WERROR=ON
+        cmake --build . --target memento_bundle -j$(sysctl -n hw.ncpu)

CMakeLists.txt

@@ -36,8 +36,8 @@ endif()
 add_subdirectory(option)
 
 # Check that dangerous options have no been toggled
-if(NOT APPLE AND MEMENTO_APPBUNDLE)
-	message(FATAL_ERROR "You cannot set the MEMENTO_APPBUNDLE option to ON on non-Apple platforms.")
+if(NOT APPLE AND MEMENTO_BUNDLE)
+	message(FATAL_ERROR "You cannot set the MEMENTO_BUNDLE option to ON on non-Apple platforms.")
 endif()
 
 # Set the module path
@@ -53,7 +53,7 @@ list(
 	"-Wall"
 	"-Wextra"
 	"-Wpedantic"
-	"$<$<BOOL:${MEMENTO_APPBUNDLE}>:-DMEMENTO_APPBUNDLE=1>"
+	"$<$<BOOL:${MEMENTO_BUNDLE}>:-DMEMENTO_BUNDLE=1>"
 	"$<$<BOOL:${MEMENTO_ASAN}>:-fsanitize=address>"
 	"$<$<BOOL:${MEMENTO_MECAB_SUPPORT}>:-DMEMENTO_MECAB_SUPPORT=1>"
 	"$<$<BOOL:${MEMENTO_OCR_SUPPORT}>:-DMEMENTO_OCR_SUPPORT=1>"

README.md

@@ -146,7 +146,7 @@ sudo cmake --build . --target install
    ```
 1. Install the necessary tools and dependencies:
    ```
-   brew install git cmake sqlite3 qt6 mpv mecab mecab-ipadic json-c libzip
+   brew install git cmake sqlite3 qt6 qcoro6 mpv mecab mecab-ipadic json-c libzip
    ```
 1. Clone the repository:
    ```
@@ -162,9 +162,28 @@ sudo cmake --build . --target install
    ```
 1. The resulting executable will be:
    ```
-   Memento/build/src/memento.app/Contents/MacOS/memento
-   ```
-
+   Memento/build/src/memento
+   ```
+
+### macOS Bundle
+
+1. Follow steps 1 - 3 of the macOS build instructions.
+1. Open the **Keychain Access** app.
+1. Go to **Keychain Access** > **Certificate Assistant** >
+   **Create a Certificate...** in the menubar.
+1. Put the name of your certificate in the 'Name' field, set the
+   'Certificate Type' to 'Code Signing', and click 'Create'.
+1. Return to your terminal and input:
+    ```
+    cd Memento
+    mkdir build
+    cmake -S . -B build -DMEMENTO_CODESIGN_IDENTITY="<certificate name>" -DMEMENTO_BUNDLE=ON -DCMAKE_BUILD_TYPE=Release -DMEMENTO_MECAB_SUPPORT=ON -DMEMENTO_SYSTEM_QCORO=ON
+    cmake --build build --target memento_bundle -j$(sysctl -n hw.ncpu)
+    ```
+1. The resulting app bundle will located at:
+    ```
+    Memento/build/src/Memento.app
+    ```
 
 ## Configuration
 

cmake/BundleMacOS.cmake.in

@@ -0,0 +1,49 @@
+include(BundleUtilities)
+
+# BundleUtilities normally copies framework resources together with the
+# framework binary. Keep that behavior so copied frameworks remain valid code
+# bundles for codesign, but drop Homebrew Python's nested Python.app helper
+# afterward. That helper is not needed by Memento and points back to Homebrew,
+# which otherwise makes bundle verification fail.
+function(copy_resolved_framework_into_bundle resolved_item resolved_embedded_item)
+    get_filename_component(resolved_dir "${resolved_item}" DIRECTORY)
+    get_filename_component(resolved_dir "${resolved_dir}/../.." ABSOLUTE)
+    get_filename_component(
+        resolved_embedded_dir "${resolved_embedded_item}" DIRECTORY
+    )
+    get_filename_component(
+        resolved_embedded_dir "${resolved_embedded_dir}/../.." ABSOLUTE
+    )
+    if(NOT EXISTS "${resolved_embedded_dir}")
+        file(COPY "${resolved_dir}" DESTINATION "${resolved_embedded_dir}/..")
+    endif()
+
+    if(resolved_embedded_item MATCHES "/Python\\.framework/")
+        get_filename_component(
+            python_framework_version_dir "${resolved_embedded_item}" DIRECTORY
+        )
+        file(REMOVE_RECURSE
+            "${python_framework_version_dir}/Resources/Python.app"
+            "${python_framework_version_dir}/bin"
+            "${python_framework_version_dir}/lib"
+        )
+    endif()
+endfunction()
+
+if(NOT DEFINED MEMENTO_BUNDLE_PATH)
+    set(MEMENTO_BUNDLE_PATH "${CMAKE_INSTALL_PREFIX}/Memento.app")
+endif()
+set(MEMENTO_BUNDLE_LIBRARY_DIRS "@MEMENTO_BUNDLE_LIBRARY_DIRS@")
+
+if(NOT EXISTS "${MEMENTO_BUNDLE_PATH}")
+    message(FATAL_ERROR
+        "Cannot bundle dependencies: ${MEMENTO_BUNDLE_PATH} does not exist."
+    )
+endif()
+
+message(STATUS "Bundling macOS dependencies into ${MEMENTO_BUNDLE_PATH}")
+fixup_bundle(
+    "${MEMENTO_BUNDLE_PATH}"
+    ""
+    "${MEMENTO_BUNDLE_LIBRARY_DIRS}"
+)

cmake/CopyMeCabDictionaryMacOS.cmake.in

@@ -0,0 +1,19 @@
+if(NOT DEFINED MEMENTO_BUNDLE_PATH)
+    set(MEMENTO_BUNDLE_PATH "${CMAKE_INSTALL_PREFIX}/Memento.app")
+endif()
+
+if(NOT EXISTS "${MEMENTO_BUNDLE_PATH}")
+    message(FATAL_ERROR
+        "Cannot copy MeCab dictionary: ${MEMENTO_BUNDLE_PATH} does not exist."
+    )
+endif()
+
+set(MEMENTO_MECAB_DICTIONARY_DESTINATION
+    "${MEMENTO_BUNDLE_PATH}/Contents/Resources/mecab/dic"
+)
+
+file(MAKE_DIRECTORY "${MEMENTO_MECAB_DICTIONARY_DESTINATION}")
+file(COPY
+    "@PROJECT_SOURCE_DIR@/dic/"
+    DESTINATION "${MEMENTO_MECAB_DICTIONARY_DESTINATION}"
+)

cmake/DeployQtMacOS.cmake.in

@@ -0,0 +1,26 @@
+if(NOT DEFINED MEMENTO_BUNDLE_PATH)
+    set(MEMENTO_BUNDLE_PATH "${CMAKE_INSTALL_PREFIX}/Memento.app")
+endif()
+
+if(NOT EXISTS "${MEMENTO_BUNDLE_PATH}")
+    message(FATAL_ERROR
+        "Cannot deploy Qt dependencies: ${MEMENTO_BUNDLE_PATH} does not exist."
+    )
+endif()
+
+message(STATUS "Deploying Qt macOS dependencies into ${MEMENTO_BUNDLE_PATH}")
+execute_process(
+    COMMAND
+        "@MEMENTO_MACDEPLOYQT_EXECUTABLE@"
+        "${MEMENTO_BUNDLE_PATH}"
+        "-qmldir=@PROJECT_SOURCE_DIR@/src/qml"
+        -always-overwrite
+    RESULT_VARIABLE MEMENTO_MACDEPLOYQT_RESULT
+)
+if(NOT MEMENTO_MACDEPLOYQT_RESULT EQUAL 0)
+    message(WARNING
+        "macdeployqt reported errors while staging ${MEMENTO_BUNDLE_PATH}; "
+        "the final BundleUtilities pass will re-scan and verify the complete "
+        "bundle."
+    )
+endif()

cmake/SignMacOS.cmake.in

@@ -0,0 +1,67 @@
+if(NOT DEFINED MEMENTO_BUNDLE_PATH)
+    set(MEMENTO_BUNDLE_PATH "${CMAKE_INSTALL_PREFIX}/Memento.app")
+endif()
+set(MEMENTO_CODESIGN_IDENTITY "@MEMENTO_CODESIGN_IDENTITY@")
+
+if(NOT EXISTS "${MEMENTO_BUNDLE_PATH}")
+    message(FATAL_ERROR
+        "Cannot sign app bundle: ${MEMENTO_BUNDLE_PATH} does not exist."
+    )
+endif()
+
+file(GLOB MEMENTO_FRAMEWORKS
+    LIST_DIRECTORIES true
+    "${MEMENTO_BUNDLE_PATH}/Contents/Frameworks/*.framework"
+)
+file(GLOB_RECURSE MEMENTO_DYLIBS
+    LIST_DIRECTORIES false
+    "${MEMENTO_BUNDLE_PATH}/Contents/Frameworks/*.dylib"
+    "${MEMENTO_BUNDLE_PATH}/Contents/PlugIns/*.dylib"
+)
+list(SORT MEMENTO_DYLIBS)
+list(SORT MEMENTO_FRAMEWORKS)
+
+foreach(MEMENTO_CODE_ITEM IN LISTS MEMENTO_DYLIBS)
+    if(IS_SYMLINK "${MEMENTO_CODE_ITEM}")
+        continue()
+    endif()
+    execute_process(
+        COMMAND /usr/bin/codesign --force --sign "${MEMENTO_CODESIGN_IDENTITY}" "${MEMENTO_CODE_ITEM}"
+        RESULT_VARIABLE MEMENTO_CODESIGN_RESULT
+    )
+    if(NOT MEMENTO_CODESIGN_RESULT EQUAL 0)
+        message(FATAL_ERROR
+            "Failed to sign nested code item: ${MEMENTO_CODE_ITEM}"
+        )
+    endif()
+endforeach()
+
+foreach(MEMENTO_CODE_ITEM IN LISTS MEMENTO_FRAMEWORKS)
+    execute_process(
+        COMMAND /usr/bin/codesign --force --sign "${MEMENTO_CODESIGN_IDENTITY}" "${MEMENTO_CODE_ITEM}"
+        RESULT_VARIABLE MEMENTO_CODESIGN_RESULT
+    )
+    if(NOT MEMENTO_CODESIGN_RESULT EQUAL 0)
+        message(FATAL_ERROR
+            "Failed to sign framework: ${MEMENTO_CODE_ITEM}"
+        )
+    endif()
+endforeach()
+
+execute_process(
+    COMMAND /usr/bin/codesign --force --sign "${MEMENTO_CODESIGN_IDENTITY}" "${MEMENTO_BUNDLE_PATH}"
+    RESULT_VARIABLE MEMENTO_CODESIGN_RESULT
+)
+if(NOT MEMENTO_CODESIGN_RESULT EQUAL 0)
+    message(FATAL_ERROR "Failed to sign app bundle: ${MEMENTO_BUNDLE_PATH}")
+endif()
+
+execute_process(
+    COMMAND /usr/bin/codesign --verify --strict --verbose=2 "${MEMENTO_BUNDLE_PATH}"
+    RESULT_VARIABLE MEMENTO_CODESIGN_VERIFY_RESULT
+)
+if(NOT MEMENTO_CODESIGN_VERIFY_RESULT EQUAL 0)
+    message(FATAL_ERROR
+        "Signed app bundle failed verification: ${MEMENTO_BUNDLE_PATH}"
+    )
+endif()

option/CMakeLists.txt

@@ -1,6 +1,6 @@
 # Apple Build Options
-option(MEMENTO_APPBUNDLE "Toggle when building macOS AppBundles" OFF)
-option(MEMENTO_CERT "Certificate name used to sign the AppBundle" "")
+option(MEMENTO_BUNDLE "Toggle when building macOS Bundles" OFF)
+set(MEMENTO_CODESIGN_IDENTITY "" CACHE STRING "macOS code signing identity for the Bundle")
 
 # Release Options
 option(MEMENTO_RELEASE_BUILD "Toggle to build with release settings" OFF)

src/CMakeLists.txt

@@ -16,9 +16,24 @@ add_subdirectory(util)
 # Executable Targets
 qt_add_executable(
     memento
-    "$<$<BOOL:${WIN32}>:${PROJECT_SOURCE_DIR}/res/appicon.rc>"
     main.cpp
 )
+if(WIN32)
+    target_sources(
+        memento
+        PRIVATE "${PROJECT_SOURCE_DIR}/res/appicon.rc"
+    )
+endif()
+if(APPLE AND MEMENTO_BUNDLE)
+    target_sources(
+        memento
+        PRIVATE ${PROJECT_SOURCE_DIR}/res/memento.icns
+    )
+    set_source_files_properties(
+        "${PROJECT_SOURCE_DIR}/res/memento.icns"
+        PROPERTIES MACOSX_PACKAGE_LOCATION "Resources"
+    )
+endif()
 configure_file(
     qml/util/Features.qml.in
     "${PROJECT_SOURCE_DIR}/src/qml/util/Features.qml"
@@ -95,10 +110,13 @@ target_include_directories(memento PRIVATE ${MEMENTO_INCLUDE_DIRS})
 target_compile_options(memento PRIVATE ${MEMENTO_COMPILER_FLAGS})
 set_target_properties(
     memento PROPERTIES
+    OUTPUT_NAME "$<$<BOOL:${MEMENTO_BUNDLE}>:Memento>$<$<NOT:$<BOOL:${MEMENTO_BUNDLE}>>:memento>"
+    MACOSX_BUNDLE_BUNDLE_NAME Memento
     MACOSX_BUNDLE_GUI_IDENTIFIER io.ripose_jp.Memento
     MACOSX_BUNDLE_BUNDLE_VERSION ${PROJECT_VERSION}
     MACOSX_BUNDLE_SHORT_VERSION_STRING ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}
-    MACOSX_BUNDLE TRUE
+    MACOSX_BUNDLE ${MEMENTO_BUNDLE}
+    MACOSX_BUNDLE_ICON_FILE memento.icns
     WIN32_EXECUTABLE ${MEMENTO_WIN32_EXECUTABLE}
 )
 target_link_libraries(
@@ -132,6 +150,104 @@ install(
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
 )
+if(APPLE AND MEMENTO_BUNDLE)
+    # BundleUtilities walks the actual linked dependency graph from the bundle.
+    # These directories are only search hints so it can resolve @rpath entries
+    # back to the exact libraries CMake found on this machine.
+    set(
+        MEMENTO_BUNDLE_LIBRARY_HINTS
+        "${JsonC_LIBRARY}"
+        "${libzip_LIBRARY}"
+        "${mpv_LIBRARY}"
+    )
+    if(MEMENTO_MECAB_SUPPORT)
+        list(APPEND MEMENTO_BUNDLE_LIBRARY_HINTS "${MeCab_LIBRARY}")
+    endif()
+    if(MEMENTO_OCR_SUPPORT AND MEMENTO_SYSTEM_MOCR)
+        list(APPEND MEMENTO_BUNDLE_LIBRARY_HINTS "${mocr_LIBRARY}" "${mocrxx_LIBRARY}")
+    endif()
+    list(REMOVE_DUPLICATES MEMENTO_BUNDLE_LIBRARY_HINTS)
+
+    set(MEMENTO_BUNDLE_LIBRARY_DIRS "")
+    foreach(MEMENTO_BUNDLE_LIBRARY_HINT IN LISTS MEMENTO_BUNDLE_LIBRARY_HINTS)
+        get_filename_component(
+            MEMENTO_BUNDLE_LIBRARY_DIR "${MEMENTO_BUNDLE_LIBRARY_HINT}" DIRECTORY
+        )
+        list(APPEND MEMENTO_BUNDLE_LIBRARY_DIRS "${MEMENTO_BUNDLE_LIBRARY_DIR}")
+    endforeach()
+    list(REMOVE_DUPLICATES MEMENTO_BUNDLE_LIBRARY_DIRS)
+
+    # On macOS, use macdeployqt directly.  It is the native Qt deployment tool
+    # for bundles and, unlike the generic install helper, copies QML plugins
+    # into their final bundle layout instead of relying on staging symlinks.
+    find_program(MEMENTO_MACDEPLOYQT_EXECUTABLE macdeployqt REQUIRED)
+    configure_file(
+        "${PROJECT_SOURCE_DIR}/cmake/DeployQtMacOS.cmake.in"
+        "${PROJECT_BINARY_DIR}/DeployQtMacOS.cmake"
+        @ONLY
+    )
+    install(SCRIPT "${PROJECT_BINARY_DIR}/DeployQtMacOS.cmake")
+
+    configure_file(
+        "${PROJECT_SOURCE_DIR}/cmake/BundleMacOS.cmake.in"
+        "${PROJECT_BINARY_DIR}/BundleMacOS.cmake"
+        @ONLY
+    )
+    install(SCRIPT "${PROJECT_BINARY_DIR}/BundleMacOS.cmake")
+
+    if(MEMENTO_MECAB_SUPPORT)
+        configure_file(
+            "${PROJECT_SOURCE_DIR}/cmake/CopyMeCabDictionaryMacOS.cmake.in"
+            "${PROJECT_BINARY_DIR}/CopyMeCabDictionaryMacOS.cmake"
+            @ONLY
+        )
+        install(SCRIPT "${PROJECT_BINARY_DIR}/CopyMeCabDictionaryMacOS.cmake")
+    endif()
+
+    add_custom_target(
+        memento_bundle
+        COMMAND
+            "${CMAKE_COMMAND}"
+            -DMEMENTO_BUNDLE_PATH=$<TARGET_BUNDLE_DIR:memento>
+            -P "${PROJECT_BINARY_DIR}/DeployQtMacOS.cmake"
+        COMMAND
+            "${CMAKE_COMMAND}"
+            -DMEMENTO_BUNDLE_PATH=$<TARGET_BUNDLE_DIR:memento>
+            -P "${PROJECT_BINARY_DIR}/BundleMacOS.cmake"
+        DEPENDS memento
+        COMMENT "Bundling dependencies into Memento.app"
+        VERBATIM
+    )
+    if(MEMENTO_MECAB_SUPPORT)
+        add_custom_command(
+            TARGET memento_bundle
+            POST_BUILD
+            COMMAND
+                "${CMAKE_COMMAND}"
+                -DMEMENTO_BUNDLE_PATH=$<TARGET_BUNDLE_DIR:memento>
+                -P "${PROJECT_BINARY_DIR}/CopyMeCabDictionaryMacOS.cmake"
+            VERBATIM
+        )
+    endif()
+
+    if(MEMENTO_CODESIGN_IDENTITY)
+        configure_file(
+            "${PROJECT_SOURCE_DIR}/cmake/SignMacOS.cmake.in"
+            "${PROJECT_BINARY_DIR}/SignMacOS.cmake"
+            @ONLY
+        )
+        install(SCRIPT "${PROJECT_BINARY_DIR}/SignMacOS.cmake")
+        add_custom_command(
+            TARGET memento_bundle
+            POST_BUILD
+            COMMAND
+                "${CMAKE_COMMAND}"
+                -DMEMENTO_BUNDLE_PATH=$<TARGET_BUNDLE_DIR:memento>
+                -P "${PROJECT_BINARY_DIR}/SignMacOS.cmake"
+            VERBATIM
+        )
+    endif()
+endif()
 if(UNIX AND NOT APPLE)
 	install(
 		FILES "${PROJECT_SOURCE_DIR}/res/memento.desktop"