Kotlin `object` companion field not surfaced on outer class binding (KeyboardOptions.Companion, TextStyle.Companion, ...)
評価
この issue はまだ評価されていません。
説明
Summary
Kotlin object companion fields aren't surfaced as public properties on the outer class binding, so consumers can't reach the singleton through the binding alone. They have to fall back to raw JNI (FindClass + GetStaticFieldID("Companion") + GetStaticObjectField) to bootstrap the companion peer.
Repro
Pick any AndroidX type with a Kotlin object companion. androidx.compose.foundation.text.KeyboardOptions is the case I just hit:
public class KeyboardOptions /* ... */ {
public companion object {
public val Default: KeyboardOptions = KeyboardOptions(/* ... */)
}
}
Kotlin lowers that to bytecode:
public final class androidx.compose.foundation.text.KeyboardOptions {
public static final androidx.compose.foundation.text.KeyboardOptions$Companion Companion;
public static final androidx.compose.foundation.text.KeyboardOptions$Companion access$getCompanion$cp();
...
}
After binding through Xamarin.AndroidX.Compose.Foundation 1.11.2.2:
AndroidX.Compose.Foundation.Text.KeyboardOptions— bound (sealed class)KeyboardOptions.Companionnested type — bound with[Register("androidx/compose/foundation/text/KeyboardOptions$Companion", DoNotGenerateAcw = true)]Companion.Default— bound (instance getter, returnsKeyboardOptions)KeyboardOptions.Copy(int, Boolean?, int, int, ...)— bound
What's missing:
- No
KeyboardOptions.Companionstatic property/field accessor on the outer class. Decompiled the binding's outerKeyboardOptionsand theCompanionfield is dropped — there's nopublic static KeyboardOptions.Companion Companion { get; }member to call. - No public ctor (stripped —
@JvmInline value classparams hit the-d9O1mEEmangling). - No
KeyboardOptionsKtstatic helper.
So even though the entire downstream API (Companion.Default, Copy(...)) is bound, there's no binding-only way to get the Companion instance to start the call chain.
Current workaround
Hand-roll the singleton bootstrap once per affected type. Verbatim from Microsoft.AndroidX.Compose/src/Microsoft.AndroidX.Compose/KeyboardOptionsCompanion.cs:
IntPtr cls = JNIEnv.FindClass("androidx/compose/foundation/text/KeyboardOptions");
IntPtr field = JNIEnv.GetStaticFieldID(cls, "Companion",
"Landroidx/compose/foundation/text/KeyboardOptions$Companion;");
IntPtr local = JNIEnv.GetStaticObjectField(cls, field);
s_companion_ref = JNIEnv.NewGlobalRef(local);
JNIEnv.DeleteLocalRef(local);
return new Companion(s_companion_ref, JniHandleOwnership.DoNotTransfer);
Everything downstream (Default, Copy(...)) is the binding — only the static-field read needs JNI. We already have the same workaround for androidx.compose.ui.text.TextStyle.Companion (TextStyleCompanion.cs) and need it for several more (ContentScale.Companion, Alignment.Companion, FontWeight.Companion, etc.).
Proposed fix
Single Metadata.xml fix-up per androidx.compose.* transform that has a Kotlin object companion. For KeyboardOptions:
<!-- androidx.compose.foundation/Transforms/Metadata.xml -->
<attr path="/api/package[@name='androidx.compose.foundation.text']/class[@name='KeyboardOptions']/field[@name='Companion']"
name="visible">true</attr>
After which the binder should emit public static KeyboardOptions.Companion Companion { get; } on the outer class, and consumers can write KeyboardOptions.Companion.Default directly. We'd then delete the hand-rolled JNI bootstrap files.
Possible complication
The binder sometimes hides Companion fields because the property name collides with the nested type name (you end up with two Companion members at the same scope — one type, one property). C# handles that fine, but the generator may have proactively dropped the field to avoid the conflict. If that's the cause, the fix becomes either:
<attr ... name="managedName">CompanionInstance</attr>to rename the property, or<remove-node>+<add-node>injecting an explicit property body.
Both still live in Metadata.xml — no generator code change needed.
Affected packages
Every Compose package that exposes a Kotlin object companion. Most-impactful ones I've already had to bootstrap by hand or know I'll need to:
Xamarin.AndroidX.Compose.Foundation—KeyboardOptions.CompanionXamarin.AndroidX.Compose.UI.Text—TextStyle.Companion,TextDecoration.Companion,FontWeight.Companion,FontFamily.Companion,FontStyle.CompanionXamarin.AndroidX.Compose.UI—Alignment.Companion,Modifier.Companion,ContentScale.CompanionXamarin.AndroidX.Compose.UI.Graphics—Color.Companion,Shape.CompanionfamilyXamarin.AndroidX.Compose.Material3—MaterialTheme.Companion, many of the*Defaultstypes
Not Compose-specific — the same gap should exist on any Kotlin-authored AndroidX type with an object companion.
Related
jonathanpeppers/Microsoft.AndroidX.Compose#246— most recent occurrence (KeyboardOptionsCompanion.cs).TextStyleCompanion.csin the same repo — first occurrence; we hit the identical pattern in Phase 1 and shipped the same JNI workaround.
- 主要言語
- C#
- スター
- 318
- フォーク
- 73
- 平均マージ
- 1日 22時間
- マージ済み PR(30日)
- 8
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dotnet/android-libraries のほかの issue
-
Stable Updates 20261005対応中かも @jonathanpeppers が 3 日前に担当しました。 オープン
dotnet/android-libraries#1556 · リアクション 1 件 · 担当者 2 名 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
dotnet/android-libraries#1549 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
dotnet/android-libraries#1503 ·
-
Compose UI.Graphics: SolidColor(long) constructor stripped due to Kotlin @JvmInline value class param (sibling of java-interop#1440 for ctors)再び着手できるかも @jonathanpeppers が 118 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
dotnet/android-libraries#1470 · リアクション 1 件 · 担当者 2 名 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 45/100
dotnet/android-libraries#1456 · コメント 2 件 · リアクション 1 件 ·
dotnet/android-libraries の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
stryker-mutator/stryker-net#3892 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
MobiFlight/MobiFlight-Connector#3419 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
Kryptos-FR/MarkView.Avalonia#105 ·
メンテナーはふだん 1 日以内に返信
-
[辞書]オープン提案 辞書
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
microsoft/fluentui-blazor#5410 ·
メンテナーはふだん 1 日以内に返信