Project layout updates

Author: marcprux

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: swift-android-oslog ci
+name: swift-android-native ci
 on:
   push:
     branches: [ main ]

Package.swift

@@ -2,13 +2,13 @@
 import PackageDescription
 
 let package = Package(
-    name: "swift-android-oslog",
+    name: "swift-android-native",
     products: [
-        .library(name: "AndroidOSLog", targets: ["AndroidOSLog"])
+        .library(name: "AndroidLogging", targets: ["AndroidLogging"])
     ],
     targets: [
-        .systemLibrary(name: "CAndroidLog"),
-        .target(name: "AndroidOSLog", dependencies: [.target(name: "CAndroidLog", condition: .when(platforms: [.android]))]),
-        .testTarget(name: "AndroidOSLogTests", dependencies: [.target(name: "AndroidOSLog")])
+        .systemLibrary(name: "AndroidNDK"),
+        .target(name: "AndroidLogging", dependencies: [.target(name: "AndroidNDK", condition: .when(platforms: [.android]))]),
+        .testTarget(name: "AndroidLoggingTests", dependencies: [.target(name: "AndroidLogging")])
     ]
 )

README.md

@@ -1,54 +1,63 @@
-# OSLog for Android
+# Android Native
 
-This package provides a Logger API for native Swift on Android compatible with
-the [OSLog Logger](https://developer.apple.com/documentation/os/logger)
-for Darwin platforms.
+This package provides a Swift interface to various
+Android [NDK APIs](https://developer.android.com/ndk/reference).
 
-# Requirements
+## Requirements
 
-  - Swift 5.9
-  - [Swift Android SDK](https://github.com/finagolfin/swift-android-sdk)
+- Swift 5.9
+- [Swift Android SDK](https://github.com/finagolfin/swift-android-sdk)
 
-# Installation
+## Installation
 
-## Swift Package Manager
+### Swift Package Manager
 
 Add the package to your `Package.swift` file:
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/skiptools/swift-android-oslog.git", from: "1.0.0")
+    .package(url: "https://github.com/skiptools/swift-android-logging.git", from: "1.0.0")
 ]
 ```
 
-Then add it as a conditional dependency for any targets that need it:
+# AndroidLogging
+
+This module provides a Logger API for native Swift on Android compatible with
+the [OSLog Logger](https://developer.apple.com/documentation/os/logger)
+for Darwin platforms.
+
+## Installation
+
+### Swift Package Manager
+
+Add the `AndroidLogging` module as a conditional dependency for any targets that need it:
 
 ```swift
 .target(name: "MyTarget", dependencies: [
-    .product(name: "AndroidOSLog", package: "swift-android-oslog", condition: .when(platforms: [.android]))
+    .product(name: "AndroidLogging", package: "swift-android-logging", condition: .when(platforms: [.android]))
 ])
 ```
 
-# Usage
+## Usage
 
-## Example
+### Example
 
-This example will use the system `OSLog` on Darwin platforms and `AndroidOSLog` on Android
+This example will use the system `OSLog` on Darwin platforms and `AndroidLogging` on Android
 to provide common logging functionality across operating systems:
 
 ```swift
 #if canImport(Darwin)
 import OSLog
 #elseif os(Android)
-import AndroidOSLog
+import AndroidLogging
 #endif
 
 let logger = Logger(subsystem: "Subsystem", category: "Category")
 
 logger.info("Hello Android logcat!")
 ```
 
-## Viewing Logs
+### Viewing Logs
 
 Android log messages for connected devices and emulators
 can be viewed from the Terminal using the
@@ -64,8 +73,21 @@ $ adb logcat '*:S' 'Subsystem/Category:I'
 [Android Studio](https://developer.android.com/studio/debug/logcat) provides the ability to
  graphically view and filter log messages, as do most other Android IDEs.
 
-# License
+## Internals
+
+### Implementation details
+
+The `Logger` functions will forward messages to the NDK
+[__android_log_write](https://developer.android.com/ndk/reference/group/logging#group___logging_1ga32a7173b092ec978b50490bd12ee523b)
+function.
+
+### Limitations
+
+- `OSLogMessage` is simply a typealias to `Swift.String`, and does not implement any of the [redaction features](https://developer.apple.com/documentation/os/logging/generating_log_messages_from_your_code#3665948) of the Darwin version.
+- 
+
+## License
 
-AndroidOSLog is licensed under the Apache 2.0 license with a runtime library exception,
+Licensed under the Apache 2.0 license with a runtime library exception,
 meaning you do not need to attribute the project in your application.
 See the [LICENSE](LICENSE) file for details.

Sources/AndroidOSLog/OSLog.swift renamed to Sources/AndroidLogging/AndroidLogging.swift

@@ -1,6 +1,6 @@
 #if os(Android)
 import Android
-import CAndroidLog
+import AndroidNDK
 
 public typealias OSLogMessage = String
 
@@ -69,10 +69,13 @@ public struct Logger : @unchecked Sendable {
         androidLog(priority: priority, message: message)
     }
 
+    private var logTag: String {
+        subsystem.isEmpty && category.isEmpty ? "" : (subsystem + "/" + category)
+    }
+
     private func androidLog(priority: android_LogPriority, message: OSLogMessage) {
-        let tag = subsystem.isEmpty && category.isEmpty ? "" : (subsystem + "/" + category)
-        //swift_android_log(priority, tagPtr, messagePtr)
-        __android_log_write(Int32(priority.rawValue), tag, message)
+        //swift_android_log(priority, logTag, messagePtr)
+        __android_log_write(Int32(priority.rawValue), logTag, message)
     }
 }
 
@@ -101,7 +104,7 @@ extension OSLogType {
     public static let fault: OSLogType = OSLogType(0x11)
 }
 
-#elseif canImport(OSLog)
+#elseif canImport(os)
 @_exported import OSLog
 #endif
 

Sources/CAndroidLog/include/coslog.h renamed to Sources/AndroidNDK/include/ndk.h

@@ -0,0 +1,4 @@
+module AndroidNDK [system] {
+  link "log"
+  export *
+}

Sources/AndroidNDK/module.modulemap

@@ -1,5 +1,5 @@
 #if defined(__ANDROID__)
-#include "coslog.h"
+#include "ndk.h"
 
 // https://android.googlesource.com/platform/system/core/+/jb-dev/include/android/log.h
 void swift_android_log(android_LogPriority level, const char *tag, const char *msg) {

Sources/CAndroidLog/coslog.c renamed to Sources/AndroidNDK/ndk.c

@@ -1,13 +1,13 @@
 import XCTest
-import AndroidOSLog // note: on non-android platforms, this will just export the system OSLog
+import AndroidLogging // note: on non-android platforms, this will just export the system OSLog
 
 @available(iOS 14.0, *)
-class AndroidOSLogTests : XCTestCase {
+class AndroidLoggingTests : XCTestCase {
     public func testOSLogAPI() {
         let emptyLogger = Logger()
         emptyLogger.info("Android logger test: empty message")
 
-        let logger = Logger(subsystem: "AndroidOSLog", category: "test")
+        let logger = Logger(subsystem: "AndroidLoggingTests", category: "test")
 
         logger.log("Android logger test: LOG message")