make log string interpolation public (#87)

Author: eagleoflqj

common/CMakeLists.txt

@@ -7,5 +7,5 @@ target_include_directories(FcitxCommon PRIVATE
 )
 target_link_libraries(FcitxCommon Fcitx5::Core nlohmann_json)
 
-add_library(SwiftUtil util.swift locale.swift)
+add_library(SwiftUtil util.swift logging.swift locale.swift)
 set_target_properties(SwiftUtil PROPERTIES Swift_MODULE_NAME SwiftUtil)

common/locale.swift

@@ -1,13 +1,12 @@
 // See fcitx5-macos/src/locale.swift
 
 import Foundation
-import SwiftUtil
 
 // Return app locale or system locale if called from app.
 // Return system locale if called from keyboard.
 public func getLocale() -> String {
   let locale = Locale.current
-  logger.info("System locale = \(locale.identifier)")
+  FCITX_INFO("System locale = \(locale.identifier)")
 
   if let languageCode = locale.language.languageCode?.identifier {
     if languageCode == "zh" {

common/logging.swift

@@ -0,0 +1,28 @@
+import OSLog
+
+private let logger = Logger(subsystem: "org.fcitx.Fcitx5", category: "FcitxLog")
+
+// swift-format-ignore: AlwaysUseLowerCamelCase
+public func FCITX_DEBUG(_ message: String) {
+  // https://stackoverflow.com/questions/57509909/swift-oslog-os-log-not-showing-up-in-console-app
+  #if targetEnvironment(simulator)
+    logger.info("\(message, privacy: .public)")
+  #else
+    logger.debug("\(message, privacy: .public)")
+  #endif
+}
+
+// swift-format-ignore: AlwaysUseLowerCamelCase
+public func FCITX_INFO(_ message: String) {
+  logger.info("\(message, privacy: .public)")
+}
+
+// swift-format-ignore: AlwaysUseLowerCamelCase
+public func FCITX_WARN(_ message: String) {
+  logger.error("\(message, privacy: .public)")
+}
+
+// swift-format-ignore: AlwaysUseLowerCamelCase
+public func FCITX_ERROR(_ message: String) {
+  logger.fault("\(message, privacy: .public)")
+}

common/util.swift

@@ -1,13 +1,11 @@
 import CryptoKit
 import Foundation
-import OSLog
-
-public let logger = Logger(subsystem: "org.fcitx.Fcitx5", category: "FcitxLog")
 
 public let documents = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
 // For SideStore, app group is not available, so fallback to documents.
-public let appGroup = FileManager.default.containerURL(
-  forSecurityApplicationGroupIdentifier: "group.org.fcitx.Fcitx5") ?? documents
+public let appGroup =
+  FileManager.default.containerURL(
+    forSecurityApplicationGroupIdentifier: "group.org.fcitx.Fcitx5") ?? documents
 public let appGroupConfig = appGroup.appendingPathComponent("config")
 public let appGroupTmp = appGroup.appendingPathComponent("tmp")
 public let appGroupData = appGroup.appendingPathComponent("data")
@@ -119,7 +117,8 @@ public func initProfile() {
   mkdirP(appGroupConfig.path)
   let profileURL = appGroupConfig.appendingPathComponent("profile")
   if !profileURL.exists() {
-    try? FileManager.default.copyItem(at: Bundle.main.bundleURL.appendingPathComponent("profile"), to: profileURL)
+    try? FileManager.default.copyItem(
+      at: Bundle.main.bundleURL.appendingPathComponent("profile"), to: profileURL)
   }
 }
 

ipc/ipc.swift

@@ -31,5 +31,5 @@ public func requestReload() {
       to: appGroupTmp.appendingPathComponent("\(keyboard).reload"), atomically: true,
       encoding: .utf8)
   }
-  logger.info("Reload requested")
+  FCITX_INFO("Reload requested")
 }

keyboard/KeyboardViewController.swift

@@ -46,7 +46,7 @@ class KeyboardViewController: UIInputViewController, FcitxProtocol {
 
   override func viewDidLoad() {
     id = UInt64(Int(bitPattern: Unmanaged.passUnretained(self).toOpaque()))
-    logger.info("viewDidLoad \(self.id)")
+    FCITX_INFO("viewDidLoad \(self.id)")
     super.viewDidLoad()
     redirectStderr()
     initProfile()
@@ -66,7 +66,7 @@ class KeyboardViewController: UIInputViewController, FcitxProtocol {
   }
 
   override func viewWillAppear(_ animated: Bool) {
-    logger.info("viewWillAppear \(self.id)")
+    FCITX_INFO("viewWillAppear \(self.id)")
     SwiftFrontend.setClient(self)
     KeyboardUI.setClient(self)
 
@@ -87,7 +87,7 @@ class KeyboardViewController: UIInputViewController, FcitxProtocol {
     super.viewWillAppear(animated)
     let keyboard = Bundle.main.bundleURL.deletingPathExtension().lastPathComponent
     if removeFile(appGroupTmp.appendingPathComponent("\(keyboard).reload")) {
-      logger.info("Reload accepted")
+      FCITX_INFO("Reload accepted")
       reload()
     }
     vm.setDisplayMode(.initial)
@@ -96,7 +96,7 @@ class KeyboardViewController: UIInputViewController, FcitxProtocol {
   }
 
   override func viewWillDisappear(_ animated: Bool) {
-    logger.info("viewWillDisappear \(self.id)")
+    FCITX_INFO("viewWillDisappear \(self.id)")
     super.viewWillDisappear(animated)
     focusOut()
     hostingController.willMove(toParent: nil)
@@ -105,11 +105,11 @@ class KeyboardViewController: UIInputViewController, FcitxProtocol {
   }
 
   deinit {
-    logger.info("deinit \(self.id)")
+    FCITX_INFO("deinit \(self.id)")
   }
 
   override func viewWillLayoutSubviews() {
-    logger.info("viewWillLayoutSubviews \(self.id)")
+    FCITX_INFO("viewWillLayoutSubviews \(self.id)")
     super.viewWillLayoutSubviews()
   }
 

scripts/format.sh

@@ -1,2 +1,2 @@
 find common src keyboard iosfrontend iosnotifications uipanel -name '*.cpp' -o -name '*.h' | xargs clang-format -i
-swift-format format --in-place $(find src keyboard iosfrontend iosnotifications uipanel protocol ipc -name '*.swift')
+swift-format format --in-place $(find common src keyboard iosfrontend iosnotifications uipanel protocol ipc -name '*.swift')

scripts/lint.sh

@@ -1,7 +1,7 @@
 set -e
 
 find common src keyboard iosfrontend iosnotifications uipanel -name '*.cpp' -o -name '*.h' | xargs clang-format -Werror --dry-run
-swift-format lint -rs src keyboard iosfrontend iosnotifications uipanel protocol ipc
+swift-format lint -rs common src keyboard iosfrontend iosnotifications uipanel protocol ipc
 
 localizables=$(find assets -name 'Localizable.strings')
 for localizable in $localizables; do

src/App.swift

@@ -14,7 +14,7 @@ struct Fcitx5App: App {
         SceneDelegate.contentView?.handleURL(url)
       }.onChange(of: scenePhase) { newPhase in
         if newPhase == .active {
-          logger.info("App is active")
+          FCITX_INFO("App is active")
           sync(
             documents.appendingPathComponent("rime"), appGroupData.appendingPathComponent("rime"))
         }

uipanel/KeyModifier.swift

@@ -285,7 +285,7 @@ func executeActions(_ actions: [[String: String]]) {
         let code = action["code"] ?? ""
         client.keyPressed(key, code)
       default:
-        logger.error("Unknown action type: \(type)")
+        FCITX_ERROR("Unknown action type: \(type)")
       }
     }
   }