Few cents about my commits

iOS13 PostFix #2: Non static @Bridge method in enums

|

This post continues series of fixes discovered during compilation of CocoaTouch library.

PostFix #2: Adding support for non-static @Bridge method in enums classes

Other postfixes:

Issue was discovered during compiling of UIImageSymbolWeight class:

java.lang.IllegalArgumentException: Receiver of non static @Bridge method <org.robovm.apple.uikit.UIImageSymbolWeight: double toFontWeight()> must either be a Struct or a NativeObject
	at org.robovm.compiler.BroMethodCompiler.getBridgeOrCallbackFunctionType(BroMethodCompiler.java:554)
	at org.robovm.compiler.BroMethodCompiler.getBridgeFunctionType(BroMethodCompiler.java:526)

What is wrong

Small background

The cause method is described as following:

    /**
     * @since Available in iOS 13.0 and later.
     */
    @Bridge(symbol="UIFontWeightForImageSymbolWeight", optional=true)
    public native @MachineSizedFloat double toFontWeight();

It is not a part of enum but UIFontWeightForImageSymbolWeight function bindings was put into this valued enum by bro-gen, yaml file of binding looks as below:

founctions:
    #ios13
    UIFontWeightForImageSymbolWeight:
        class: UIImageSymbolWeight
        name: toFontWeight

And the function itself is declared in UIKit as below:

UIKIT_EXTERN UIFontWeight UIFontWeightForImageSymbolWeight(UIImageSymbolWeight symbolWeight) API_AVAILABLE(ios(13.0),tvos(13.0),watchos(6.0));

Where non static @Bridge method come from

Normally binding for C function goes as static method and binding for UIFontWeightForImageSymbolWeight should be:

    @Bridge(symbol="UIFontWeightForImageSymbolWeight", optional=true)
    public static native @MachineSizedFloat double toFontWeight(UIImageSymbolWeight symbolWeight);

But in case receiver (class we put binding of function) and first argument’s type matches method might be made non-static and without first parameter. RoboVM compiler handles the case and provides this as first argument when makes a call to C function.

Root case

Is stated in execption text itself: Receiver of non static @Bridge method must either be a Struct or a NativeObject. From other side when method is static and first parameter present compiler doesn’t compline much as long as it can marshal the type. This is limitation a limitation of code that handles non-static @Bridge methods.

The fix

Utlimate fix would be to adapt compiler to accept any marshalable type as receiver but this would require sensitive amount of code to be adapted. Real world fix is to support ValuedEnum type in row of Struct and NativeObject and provide proper marshallers. Its minimze amount of compiler code to be changed and enough to have it working. Code delivered as PR420

Comments