eugene.levenetc
797284dada
This commit will introduce the first processing queue which will take care of properly ordering the 'to translate' symbols as well as taking care of 'dependency' symbols (aka symbols mentioned in signatures or as supertypes). - There are several changes like properly translating types as ObjCProtocolType instead of ObjCClassType (if origin was an interface) - Type translation of generics defined on interfaces will also emit id type. - Add initial nested classes collection to the queue - Add extension function test, add tickets references ^KT-65237 Verification Pending ^KT-65329 Verification Pending
ObjC Export Header generator
This tool is used for 'translating' Kotlin code into ObjC 'stubs' and ultimately rendering ObjC header files.
Usage
CLI: Building .framework files
The CLI will use this module for building the corresponding .framework binaries from Kotlin. This method will operate on previously built .klib binaries (with fully validated frontend). The 'klibs' will be deserialized and headers and bridges between Kotlin and ObjC will be built. This mode currently operates on K1 based descriptors
IDE: Providing Kotlin <-> ObjC/Swift cross language support
In order for Fleet to provide tooling that is capable of refactoring symbols between Kotlin and ObjC, this tool is used.
Example:
given the following Kotlin code
@ObjCName("FooObjC")
class Foo
and the following Swift usage
func bar() {
FooObjC()
}
refactoring inside either Kotlin or Swift will be consistent across Kotlin and Swift.
Two Implementations (K1, Analysis Api)
There are currently two implementations for this tool
K1
This is the K1 (descriptor based) implementation that is currently used by the CLI and K1 based IDEs.
Analysis Api (WiP)
This implementation is currently 'work in progress' and shall replace the K1 usage in the IDE later. This implementation could theoretically also replace the K1 implementation if necessary.
Testing
Run all tests
./gradlew :native:objcexport-header-generator:check
The most important test is ObjCExportHeaderGeneratorTest.kt as this test defines the contract of how a header shall be generated from a given Kotlin input. This test can run against both implementations.
./gradlew :native:objcexport-header-generator:testK1
./gradlew :native:objcexport-header-generator:testAnalysisApi
Note: Since the Analysis Api implementation is WIP yet, this test can be used for debugging, but is not fully implemented yet.
CI setup and 'TodoAnalysisApi'
As explained previously, tests in :native:objcexport-header-generator will be able to run against K1 and the AA implementation.
The CI will now run both cases. However, some tests are not yet expected to pass for the newer AA based implementation.
In this case the test can be marked as 'todo' using the @TodoAnalysisApi annotation.
Example
@Test
@TodoAnalysisApi
fun myTest() {
}
This annotation will
- Ignore test the test failure for the AA based implementation on the CI
- Mark the displayName of the test with 'TODO' (e.g.
[AA] myTest // TODO)
Note:
- If the annotation is still present, but the test is successful, then an error is emitted that reminds you about removing the annotation
- To make the tests execute normally (for more convenient local development), Gradle property
kif.localcan be used:
./gradlew :native:objcexport-header-generator:check -Pkif.local
// ^