configure app group; change data&config directory

Author: eagleoflqj

.github/workflows/ci.yml

@@ -46,7 +46,7 @@ jobs:
           git apply --directory=fcitx5 patches/fcitx5.patch
           git apply --directory=engines/fcitx5-hallelujah patches/hallelujah.patch
           git apply --directory=engines/fcitx5-rime patches/rime.patch
-          PKG_CONFIG_PATH=build/sysroot/usr/lib/pkgconfig cmake -B build -G Xcode \
+          cmake -B build -G Xcode \
             -DHALLELUJAH=ON \
             -DRIME=ON \
             -DCMAKE_TOOLCHAIN_FILE=cmake/ios.cmake \

CMakeLists.txt

@@ -29,6 +29,8 @@ set(KEYBOARD_LANGUAGE "zh-Hans")
 set(PREBUILDER_LIB_DIR "${PROJECT_BINARY_DIR}/sysroot/usr/lib")
 set(PREBUILDER_SHARE_DIR "${PROJECT_BINARY_DIR}/sysroot/usr/share")
 
+set(ENV{PKG_CONFIG_PATH} "${PREBUILDER_LIB_DIR}/pkgconfig")
+
 # For dependencies not to be find via pkg-config
 set(LibIntl_DIR "${PREBUILDER_LIB_DIR}/cmake")
 find_package(LibIntl)

README.md

@@ -2,5 +2,44 @@
 
 [Fcitx5](https://github.com/fcitx/fcitx5) input method framework ported to iOS.
 
+## Build
+This project is NOT managed by Xcode,
+but Xcode is needed for iOS SDK.
+
+### Install dependencies
+```sh
+brew install cmake extra-cmake-modules gettext
+IOS_PLATFORM=SIMULATOR ./install-deps.sh
+```
+
+### Apply patches
+```sh
+git apply --directory=fcitx5 patches/fcitx5.patch
+git apply --directory=engines/fcitx5-rime patches/rime.patch # if building with Rime
+```
+
+### Build with CMake
+```sh
+cmake -B build -G Xcode \
+  -DRIME=ON \
+  -DCMAKE_TOOLCHAIN_FILE=cmake/ios.cmake \
+  -DIOS_PLATFORM=SIMULATOR
+cmake --build build --config Debug
+```
+
+### Play with simulator
+```sh
+xcrun simctl list devices
+xcrun simctl boot UUID
+xcrun simctl install booted build/src/Debug-iphonesimulator/Fcitx5.app
+```
+After the first time you execute `xcrun simctl install`,
+you need to add Fcitx5 in Settings -> General -> Keyboard -> Keyboards -> Add New Keyboard.
+
+* Simulator is not emulator (virtual machine). Simulator file system is mapped from host filesystem. A process in simulator is a process in macOS.
+* App and input method (custom keyboard extension) are different programs. They share a directory (via App Group) in ~/Library/Developer/CoreSimulator/Devices/UUID/data/Containers/Shared/AppGroup.
+
 ## Credits
+* [fcitx5](https://github.com/fcitx/fcitx5): LGPL-2.1-or-later
+* [ios-cmake](https://github.com/sheldonth/ios-cmake): MIT
 * [swift-cmake-examples](https://github.com/apple/swift-cmake-examples): Apache-2.0

assets/app.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>com.apple.security.application-groups</key>
+  <array>
+    <string>org.fcitx.Fcitx5</string>
+  </array>
+</dict>
+</plist>

assets/keyboard.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>com.apple.security.application-groups</key>
+  <array>
+    <string>org.fcitx.Fcitx5</string>
+  </array>
+</dict>
+</plist>

keyboard/CMakeLists.txt

@@ -5,6 +5,8 @@ set_target_properties(keyboard PROPERTIES
     XCODE_PRODUCT_TYPE "com.apple.product-type.app-extension"
 )
 
+set_xcode_property(keyboard CODE_SIGN_ENTITLEMENTS ${PROJECT_SOURCE_DIR}/assets/keyboard.entitlements)
+
 target_include_directories(keyboard PRIVATE
     "${CMAKE_CURRENT_SOURCE_DIR}"
     "${CMAKE_CURRENT_BINARY_DIR}/../fcitx5"

keyboard/KeyboardViewController.swift

@@ -35,7 +35,10 @@ class KeyboardViewController: UIInputViewController, FcitxProtocol {
       mainStackView.bottomAnchor.constraint(equalTo: view.bottomAnchor, constant: 0),
     ])
 
-    startFcitx(Bundle.main.bundlePath)
+    startFcitx(
+      Bundle.main.bundlePath,
+      FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "org.fcitx.Fcitx5")!
+        .path)
 
     // Perform custom UI setup here
     self.nextKeyboardButton = UIButton(type: .system)

keyboard/fcitx.cpp

@@ -55,27 +55,27 @@ void setupLog() {
     fcitx::Log::setLogRule("*=5,notimedate");
 }
 
-void setupEnv(const char *bundlePath) {
+void setupEnv(const char *bundlePath, const char *appGroupPath) {
     fs::path bundle = bundlePath;
-    fs::path home = getenv("HOME");
+    fs::path group = appGroupPath;
     std::string xdg_data_dirs = bundle / "share";
-    std::string xdg_data_home = home / "Documents";
-    std::string fcitx_config_home = home / "Library/config";
+    std::string xdg_data_home = group / "data";
+    std::string fcitx_config_home = group / "config";
     setenv("XDG_DATA_DIRS", xdg_data_dirs.c_str(), 1);
     setenv("XDG_DATA_HOME", xdg_data_home.c_str(), 1);
     // By default FCITX_DATA_HOME is XDG_DATA_HOME/fcitx5. Flatten it like f5a.
     setenv("FCITX_DATA_HOME", xdg_data_home.c_str(), 1);
     // By default FCITX_CONFIG_HOME is XDG_CONFIG_HOME/fcitx5. Move it from
-    // ~/.config/fcitx5 to ~/Library/config.
+    // ~/.config/fcitx5 to appGroupPath/config.
     setenv("FCITX_CONFIG_HOME", fcitx_config_home.c_str(), 1);
 }
 
-void startFcitx(const char *bundlePath) {
+void startFcitx(const char *bundlePath, const char *appGroupPath) {
     if (instance) {
         return;
     }
     setupLog();
-    setupEnv(bundlePath);
+    setupEnv(bundlePath, appGroupPath);
 
     instance = std::make_unique<fcitx::Instance>(0, nullptr);
     instance->setInputMethodMode(fcitx::InputMethodMode::OnScreenKeyboard);

keyboard/fcitx.h

@@ -2,7 +2,7 @@
 
 #include <objc/objc.h>
 
-void startFcitx(const char *bundlePath);
+void startFcitx(const char *bundlePath, const char *appGroupPath);
 void focusIn(id client);
 void focusOut();
 bool processKey(const char *key);

src/CMakeLists.txt

@@ -21,6 +21,8 @@ set_target_properties(${BUNDLE_NAME} PROPERTIES
     XCODE_EMBED_APP_EXTENSIONS keyboard
 )
 
+set_xcode_property(${BUNDLE_NAME} CODE_SIGN_ENTITLEMENTS ${PROJECT_SOURCE_DIR}/assets/app.entitlements)
+
 add_custom_command(
     TARGET ${BUNDLE_NAME}
     POST_BUILD COMMAND /bin/sh -c