Availability attribute support

[christiangnrd]

#50

[github-actions]

Your PR requires formatting changes to meet the project's style guidelines.
Please consider running Runic (git runic master) to apply these changes.

Click here to view the suggested changes.

diff --git a/src/syntax.jl b/src/syntax.jl
index d447fed..fd07371 100644
--- a/src/syntax.jl
+++ b/src/syntax.jl
@@ -290,7 +290,7 @@ macro objcwrapper(ex...)
   # parse kwargs
   comparison = nothing
   immutable = nothing
-  availability = nothing
+    availability = nothing
   for kw in kwargs
     if kw isa Expr && kw.head == :(=)
       kw, value = kw.args
@@ -300,8 +300,8 @@ macro objcwrapper(ex...)
       elseif kw == :immutable
         value isa Bool || wrappererror("immutable keyword argument must be a literal boolean")
         immutable = value
-      elseif kw == :availability
-        availability = get_avail_exprs(__module__, value)
+            elseif kw == :availability
+                availability = get_avail_exprs(__module__, value)
       else
         wrappererror("unrecognized keyword argument: $kw")
       end
@@ -311,7 +311,7 @@ macro objcwrapper(ex...)
   end
   immutable = something(immutable, true)
   comparison = something(comparison, !immutable)
-  availability = something(availability, PlatformAvailability(:macos, v"0"))
+    availability = something(availability, PlatformAvailability(:macos, v"0"))
 
   # parse class definition
   if Meta.isexpr(def, :(<:))
@@ -352,9 +352,9 @@ macro objcwrapper(ex...)
 
     # add a pseudo constructor to the abstract type that also checks for nil pointers.
     function $name(ptr::id)
-      @static if !Sys.isapple() || ObjectiveC.is_unavailable($availability)
-        throw($UnavailableError(Symbol($name), $availability))
-      end
+            @static if !Sys.isapple() || ObjectiveC.is_unavailable($availability)
+                throw($UnavailableError(Symbol($name), $availability))
+            end
 
       ptr == nil && throw(UndefRefError())
       $instance(ptr)

[codecov]

Codecov Report

Attention: Patch coverage is 96.15385% with 3 lines in your changes missing coverage. Please review.

Project coverage is 77.71%. Comparing base (6911018) to head (1964af7).
Report is 28 commits behind head on master.

Files with missing lines	Patch %	Lines
src/version.jl	92.00%	2 Missing ⚠️
src/syntax.jl	91.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #51      +/-   ##
==========================================
+ Coverage   71.91%   77.71%   +5.79%     
==========================================
  Files          10       13       +3     
  Lines         769      987     +218     
==========================================
+ Hits          553      767     +214     
- Misses        216      220       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[maleadt]

What about making this more generic than only checking against the macOS version, taking an arbitrary bool instead? Is there precedent for, say, platform-dependent attributes? If so, what about:

availability = is_macos(v"15")
availability = (Sys.ARCH == :aarch64)

[christiangnrd]

I don't think there is precedence for this, I tried to have it behave like the clang attribute, and the only platform that supports both it and Julia is macOS.

I'm not opposed to it, but this would leave the need for code in the toml config for wrapping, and I would like it if the version errors were informative. Although maybe it could be changed to something like

UnavailableError: `<Symbol>` is not available on your platform, you may need to upgrade your operating system.

[christiangnrd]

Did not mean to close

[maleadt]

this would leave the need for code in the toml config for wrapping

The TOML could always use a more specific macos_availability attribute and generate the appropriate code.

I would like it if the version errors were informative

I wonder if we could symbolize the condition:

UnavailableError: `<Symbol>` is not available on your platform, which does not fulfill the necessary predicate (`is_macos(v"15")`)

That said, I'm totally fine with mimicking Clang and providing something more specific. I'd then mimic it somewhat closer though, also including the platform and introduced/deprecated/obsolete. Just spitballing, but what about:

# in ObjectiveC.jl:
struct macOS
  # ...
  macOS(introduced::VersionNumber, deprecated=nothing, obsolete=nothing) = ...
end

# in user code
@objcwrapper availability = macOS(v"14") Foo <: Object
@objcwrapper availability = [macOS(introduced=v"14", deprecated=v"15")] Bar <: Object

[christiangnrd]

I went with the second option with lowercase macos since that's what it is with Clang.

Open to any suggestions to simplify the code but it works and would be fairly easy to extend with a new platform if ever needed.

If this is approved I'll submit a PR to Julia for the OncePer constructs to subtype Function to make the nightly tests pass. JuliaLang/julia#57289

[christiangnrd]

Now based on #52 for the nightly fixes.

[maleadt]

Looking good! Some suggestions for simplifying/generalizing the implementation, I'd properly support multiple platforms already by supporting both macOS and Darwin availability selectors.

[christiangnrd]

I think this is ready to merge!

[maleadt]

Nice! Couple of minor suggestions.

I also don't particularly like the negative is_unavailable, but I guess that's how it's done in Clang?

[christiangnrd]

I've applied your suggestions.

is_unavailable was chosen purely for making the logic easier to implement.

If it's okay with you, since this is internal, I'll make the change to is_available in a follow-up PR but I think we should merge this.