[ClockKit] Add support for Xcode 12 beta 1. #9010

mandel-macaque · 2020-07-06T03:12:10Z

No description provided.

monojenkins · 2020-07-06T06:08:57Z

Build success
✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)
✅ Test run succeeded

tests/xtro-sharpie/watchOS-ClockKit.ignore

src/clockkit.cs

rolfbjarne · 2020-07-06T09:01:11Z

src/clockkit.cs

+
+		[Watch (7, 0), NoiOS]
+		[Static]
+		[Export ("templateWithRow1ImageProvider:row1Column1TextProvider:row1Column2TextProvider:row2ImageProvider:row2Column1TextProvider:row2Column2TextProvider:row3ImageProvider:row3Column1TextProvider:row3Column2TextProvider:")]


Looks like someone never heard of arrays before...

src/clockkit.cs

rolfbjarne · 2020-07-06T09:11:31Z

src/clockkit.cs

+
+	[Watch (7, 0), NoiOS]
+	[BaseType (typeof (CLKComplicationTemplateGraphicExtraLargeCircular))]
+	interface CLKComplicationTemplateGraphicExtraLargeCircularOpenGaugeRangeText {


Say that 10 times fast as you can!

src/clockkit.cs

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

spouliot · 2020-07-06T12:15:43Z

src/Constants.iOS.cs.in

@@ -146,5 +146,7 @@ namespace ObjCRuntime {
 		public const string AutomaticAssessmentConfigurationLibrary = "/System/Library/Frameworks/AutomaticAssessmentConfiguration.framework/AutomaticAssessmentConfiguration";
 		// iOS 14.0
 		public const string AppClipLibrary = "/System/Library/Frameworks/AppClip.framework/AppClip";
+		// waiting on apple to fix the headers https://github.com/xamarin/maccore/issues/2258
+		// public const string ClockKitLibrary = "/System/Library/Frameworks/ClockKit.framework/ClockKit";


I don't think ClockKit is supposed to be available on iOS, looks like an header error in Xcode (which would explain the lack of framework on iOS 14)

spouliot · 2020-07-06T12:17:39Z

tests/mtouch/RegistrarTest.cs

@@ -346,6 +346,8 @@ public void MT4134 ()
 					new { Framework = "BackgroundTasks", Version = "13.0" },
 					new { Framework = "QuickLookThumbnailing", Version = "13.0" },
 					new { Framework = "AutomaticAssessmentConfiguration", Version = "13.4" },
+					// waiting on apple to ifx the headers https://github.com/xamarin/maccore/issues/2258
+					// new { Framework = "ClockKit", Version = "14.0" },


I would not add the lines for this, since the fix will likely mean we don't need them (and they won't merge cleanly with other new frameworks to be added)

spouliot · 2020-07-06T12:18:41Z

tools/common/Frameworks.cs

@@ -333,6 +333,9 @@ public static Frameworks GetiOSFrameworks (Application app)

 				{ "AppClip", "AppClip", 14,0 },

+				// waiting on apple to fix it: https://github.com/xamarin/maccore/issues/2258
+				// { "ClockKit", "ClockKit", 14,0 },
+


spouliot · 2020-07-06T12:18:48Z

tools/mtouch/Makefile

@@ -162,6 +162,9 @@ SIMLAUNCHER_FRAMEWORKS =  \
 	-weak_framework AutomaticAssessmentConfiguration	\
 						\
 	-weak_framework AppClip	\
+	# waiting on apple to fix the framework on ios
+	# https://github.com/xamarin/maccore/issues/2258
+	# -weak_framework ClockKit \


spouliot · 2020-07-06T12:20:28Z

tests/xtro-sharpie/watchOS-ClockKit.ignore

+!incorrect-protocol-member! CLKComplicationDataSource::getSupportedTimeTravelDirectionsForComplication:withHandler: is OPTIONAL and should NOT be abstract
+
+# no needed, families is a smart enum and the same can be achived with .net
+!missing-pinvoke! CLKAllComplicationFamilies is not bound


I think it needs to be bound

https://docs.prod.msd.developer.g.apple.com/documentation/clockkit/3555308-clkallcomplicationfamilies

sounds like it can return a different subset based on OS version (or even watch model at some point) while our smart enum will always have the same values (and the availability attributes are removed by the linker)

spouliot · 2020-07-06T12:26:29Z

src/clockkit.cs

+		[Export ("initWithTextProvider:")]
+		IntPtr Constructor (CLKTextProvider textProvider);
+
+		[Watch (7, 0), NoiOS]


spouliot · 2020-07-06T12:26:44Z

src/clockkit.cs

 	}

 	[BaseType (typeof (CLKComplicationTemplate))]
 	interface CLKComplicationTemplateModularSmallSimpleImage {

 		[Export ("imageProvider", ArgumentSemantic.Copy)]
 		CLKImageProvider ImageProvider { get; set; }
+
+		[Watch (7, 0), NoiOS]


double check all [NoiOS]

spouliot · 2020-07-06T12:29:03Z

src/clockkit.cs

 	interface CLKImageProvider : NSCopying {

+		[Deprecated (PlatformName.iOS, 14, 0, message: "The default constructor is deprecated.")]


no need for this message - unless we can provide what should be used

spouliot · 2020-07-06T12:29:20Z

src/clockkit.cs

 	interface CLKTextProvider : NSCopying {
+
+		[Deprecated (PlatformName.iOS, 14, 0, message: "The default constructor is deprecated. Use the provided factories instead.")]


same, only last part is useful

spouliot · 2020-07-06T12:32:05Z

src/clockkit.cs

+		CLKComplicationTemplateGraphicRectangularFullImage Create (CLKFullColorImageProvider imageProvider);
+	}
+
+	[Abstract] // from docs 'An abstract superclass for all the extra large circular graphic templates.'


we had problems with [Abstract] before, since Apple can return instance of them.
Might be better to have no public ctor (and no member) and an [Advice] this is meant to abstract

Do we want to deal with the one in https://github.com/xamarin/xamarin-macios/blob/main/src/clockkit.cs#L715 too? That is the main reason I used Abstract here, to follow the same pattern.

I wonder if we should be fixing this at the generator level, i.e. [Abstract] on a type to mean [Advice ("blah!")]

I wonder if we should be fixing this at the generator level, i.e. [Abstract] on a type to mean [Advice ("blah!")]

It's already filed: #4969

monojenkins · 2020-07-06T14:44:17Z

Build success
✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)
✅ Test run succeeded

whitneyschmidt · 2020-07-06T21:05:11Z

src/clockkit.cs

+
+		[Watch (7, 0), NoiOS]
+		[Export ("initWithRow1Column1TextProvider:row1Column2TextProvider:row2Column1TextProvider:row2Column2TextProvider:")]
+		IntPtr Constructor (CLKTextProvider row1Column1TextProvider, CLKTextProvider row1Column2TextProvider, CLKTextProvider row2Column1TextProvider, CLKTextProvider row2Column2TextProvider);


I wonder whether you could simplify all of these param names to row1Column1Provider since they're all text providers?

Open to suggestions, but the name has to point to the row and the column, we could remove TextProvider, but doesn't make it much nicer :/

As rolf said, someone does not know about arrays

A custom .ctor (CLKTextProvider[,] textProviders) with additional validations (ranges) could be manually added (and tested) and this one could become internal (or protected for subclassing).

You might know a trick I don't with C# because the way to call another constructor on c# is:

public CLKComplicationTemplateModularLargeTable (CLKTextProvider[] data) : this (data[0], data[1], data[2], data[3], data[4]) { }

And this code is super error prone. I cannot validate that data is not null AND I cannot check the number of items before I call this. Factory methods, Ok, no problem, the constructors, I don't see how unless I do a binding to a IntPtr for the objc msg send etc..

There's an ugly trick using a static method : this (CheckData (data), data [1], ...)
But better call objc_msgSend (and not this)
Not sure it's worth it... at least right now (can be added at any time)

whitneyschmidt · 2020-07-06T21:06:16Z

src/clockkit.cs

+
+		[Watch (7, 0), NoiOS]
+		[Export ("initWithHeaderTextProvider:row1Column1TextProvider:row1Column2TextProvider:row2Column1TextProvider:row2Column2TextProvider:")]
+		IntPtr Constructor (CLKTextProvider headerTextProvider, CLKTextProvider row1Column1TextProvider, CLKTextProvider row1Column2TextProvider, CLKTextProvider row2Column1TextProvider, CLKTextProvider row2Column2TextProvider);


Same as above.

whitneyschmidt · 2020-07-06T21:06:33Z

src/clockkit.cs

+		[Watch (7, 0), NoiOS]
+		[Static]
+		[Export ("templateWithHeaderImageProvider:headerTextProvider:row1Column1TextProvider:row1Column2TextProvider:row2Column1TextProvider:row2Column2TextProvider:")]
+		CLKComplicationTemplateModularLargeTable Create ([NullAllowed] CLKImageProvider headerImageProvider, CLKTextProvider headerTextProvider, CLKTextProvider row1Column1TextProvider, CLKTextProvider row1Column2TextProvider, CLKTextProvider row2Column1TextProvider, CLKTextProvider row2Column2TextProvider);


whitneyschmidt · 2020-07-06T21:07:40Z

src/clockkit.cs

+
+		[Watch (7, 0), NoiOS]
+		[Export ("initWithRow1Column1TextProvider:row1Column2TextProvider:row2Column1TextProvider:row2Column2TextProvider:row3Column1TextProvider:row3Column2TextProvider:")]
+		IntPtr Constructor (CLKTextProvider row1Column1TextProvider, CLKTextProvider row1Column2TextProvider, CLKTextProvider row2Column1TextProvider, CLKTextProvider row2Column2TextProvider, CLKTextProvider row3Column1TextProvider, CLKTextProvider row3Column2TextProvider);


And more of the same?

monojenkins · 2020-07-08T19:15:11Z

Build failure
❌ Build failed or was aborted

spouliot

how did you merge ?
your PR now includes stuff that should not be there

spouliot · 2020-07-08T19:26:04Z

src/ClockKit/CLKComplication.cs

+	public partial class CLKComplication {
+			[Watch (7,0)]
+			[DllImport (Constants.ClockKitLibrary, EntryPoint = "CLKAllComplicationFamilies")]
+			public static extern NSNumber[] GetAllComplicationFamilies ();


oh, that needs a test because it defy my understanding of p/invokes wrt ObjC ;-)

spouliot · 2020-07-08T19:27:40Z

src/clockkit.cs

@@ -13,12 +13,38 @@
 using UIKit;

 namespace ClockKit {
+
+	[Watch (7,0), iOS (14, 0)]


remove [iOS]

spouliot · 2020-07-08T19:28:21Z

src/clockkit.cs

 		[Export ("getSupportedTimeTravelDirectionsForComplication:withHandler:")]
 		void GetSupportedTimeTravelDirections (CLKComplication complication, Action<CLKComplicationTimeTravelDirections> handler);

+		[Deprecated (PlatformName.WatchOS, 7, 0, message: "Backwards extension and time travel is not longer supported.")]


is not -> are no ?

spouliot · 2020-07-08T19:28:29Z

src/clockkit.cs

@@ -51,6 +79,7 @@ interface CLKComplicationDataSource {
 		[Export ("getCurrentTimelineEntryForComplication:withHandler:")]
 		void GetCurrentTimelineEntry (CLKComplication complication, Action<CLKComplicationTimelineEntry> handler);

+		[Deprecated (PlatformName.WatchOS, 7, 0, message: "Backwards extension and time travel is not longer supported.")]


is not -> are no ?

spouliot · 2020-07-08T19:29:26Z

src/clockkit.cs

 	interface CLKComplicationTemplate : NSCopying {

 		[NullAllowed, Export ("tintColor", ArgumentSemantic.Copy)]
 		UIColor TintColor { get; set; }
+
+		[Deprecated (PlatformName.iOS, 14, 0, message: "Use the provided factories instead.")]


watchOS ?
it was not available before on iOS so it can't be deprecated in 14

spouliot · 2020-07-08T19:31:23Z

src/clockkit.cs

 	interface CLKImageProvider : NSCopying {

+		[Deprecated (PlatformName.iOS, 14, 0)] 


monojenkins · 2020-07-08T20:53:31Z

Build success
✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)
✅ Test run succeeded

monojenkins · 2020-07-10T18:33:14Z

Build failure
✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)
🔥 Test run failed 🔥

Test results

16 tests failed, 77 tests passed.

Failed tests

monotouch-test/iOS Unified 32-bits - simulator/Debug: BuildFailure
monotouch-test/iOS Unified 32-bits - simulator/Debug (LinkSdk): BuildFailure
monotouch-test/iOS Unified 32-bits - simulator/Debug (static registrar): BuildFailure
monotouch-test/iOS Unified 32-bits - simulator/Release (all optimizations): BuildFailure
monotouch-test/iOS Unified 64-bits - simulator/Debug: BuildFailure
monotouch-test/iOS Unified 64-bits - simulator/Debug (LinkSdk): BuildFailure
monotouch-test/iOS Unified 64-bits - simulator/Debug (static registrar): BuildFailure
monotouch-test/iOS Unified 64-bits - simulator/Release (all optimizations): BuildFailure
monotouch-test/tvOS - simulator/Debug: BuildFailure
monotouch-test/tvOS - simulator/Debug (LinkSdk): BuildFailure
monotouch-test/tvOS - simulator/Debug (static registrar): BuildFailure
monotouch-test/tvOS - simulator/Release (all optimizations): BuildFailure
monotouch-test/watchOS 32-bits - simulator/Debug: BuildFailure
monotouch-test/watchOS 32-bits - simulator/Debug (LinkSdk): BuildFailure
monotouch-test/watchOS 32-bits - simulator/Debug (static registrar): BuildFailure
monotouch-test/watchOS 32-bits - simulator/Release (all optimizations): BuildFailure

spouliot · 2020-07-10T18:43:00Z

src/ClockKit/CLKComplication.cs

+			[DllImport (Constants.ClockKitLibrary)]
+			static extern IntPtr CLKAllComplicationFamilies ();
+
+			public static NSNumber[] GetAllComplicationFamilies ()


NSNumber is not a very nice type to expose and you already did a better job elsewhere in the bindings ;-)

[Export ("supportedFamilies")] [BindAs ( typeof (CLKComplicationFamily []))] NSNumber[] SupportedFamilies { get; }

monojenkins · 2020-07-10T23:47:02Z

Build failure
❌ Build failed or was aborted

✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

monojenkins · 2020-07-11T01:21:29Z

Build success
✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)
✅ Test run succeeded

dalexsoto

Just a couple of nits but 👍

dalexsoto · 2020-07-13T14:13:39Z

src/ClockKit/CLKComplication.cs

+			public static CLKComplicationFamily[] GetAllComplicationFamilies ()
+			{
+				using (var nsArray = new NSArray (CLKAllComplicationFamilies ())) {
+					var families = new CLKComplicationFamily [(int)nsArray.Count];
+					for (nuint i = 0; i < nsArray.Count; i++)
+					{
+						families[i] = (CLKComplicationFamily)nsArray.GetItem <NSNumber> (i).Int32Value;
+					}
+					return families;
+				}
+			}


cute but 😛

Suggested change

public static CLKComplicationFamily[] GetAllComplicationFamilies ()

{

using (var nsArray = new NSArray (CLKAllComplicationFamilies ())) {

var families = new CLKComplicationFamily [(int)nsArray.Count];

for (nuint i = 0; i < nsArray.Count; i++)

{

families[i] = (CLKComplicationFamily)nsArray.GetItem <NSNumber> (i).Int32Value;

}

return families;

}

}

[Watch (7,0)]

public static CLKComplicationFamily[] GetAllComplicationFamilies () => NSArray.EnumsFromHandle<CLKComplicationFamily> (CLKAllComplicationFamilies ());

ah... source code beauty contest ;-)
I prefer the smallest (IL) one :)

@spouliot heh I like consistency (I wonder who taught me that 😁) if we do (or don't) like NSArray.EnumsFromHandle then we have a problem elsewhere

So, after my experience with LINQ... I'm going for the explicit implementation

LINQ? There is no linq involved at all :)

@mandel-macaque if you mean => that is just an Expression body definition and if you really do not like it you can do

Suggested change

public static CLKComplicationFamily[] GetAllComplicationFamilies ()

{

using (var nsArray = new NSArray (CLKAllComplicationFamilies ())) {

var families = new CLKComplicationFamily [(int)nsArray.Count];

for (nuint i = 0; i < nsArray.Count; i++)

{

families[i] = (CLKComplicationFamily)nsArray.GetItem <NSNumber> (i).Int32Value;

}

return families;

}

}

[Watch (7,0)]

public static CLKComplicationFamily[] GetAllComplicationFamilies ()

{

return NSArray.EnumsFromHandle<CLKComplicationFamily> (CLKAllComplicationFamilies ());

}

That said you are missing [Watch (7,0)] for GetAllComplicationFamilies

No, I use => alot, I'm talking about the IL of EnumsFromHandle hehe

a call to EnumsFromHandle is a lot smaller then the code above
the total size diff will depend on the app, and if anything else uses EnumsFromHandle or the code it depends on
so YYMV, but considering watchOS size limitations having less code is generally better

src/clockkit.cs

Co-authored-by: Alex Soto <alex@alexsoto.me>

monojenkins · 2020-07-13T23:11:13Z

Build failure
❌ Build failed or was aborted

✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

monojenkins · 2020-07-14T02:28:21Z

Build success
✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)
✅ Test run succeeded

rolfbjarne · 2020-07-14T07:19:34Z

src/ClockKit/CLKComplication.cs

+				}
+			}
+	}
+}


rolfbjarne · 2020-07-14T07:19:42Z

tests/monotouch-test/ClockKit/CLKComplicationTest.cs

+		}
+	}
+}
+#endif


tests/monotouch-test/ClockKit/CLKComplicationTest.cs

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

monojenkins · 2020-07-14T12:05:10Z

Build failure
❌ Build failed or was aborted

monojenkins · 2020-07-14T14:15:04Z

Build success
✅ Build succeeded
✅ API Diff (from stable)
ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)
✅ Test run succeeded

[ClockKit] Add support for Xcode 12 beta 1.

26efc26

mandel-macaque requested review from chamons, rolfbjarne and spouliot as code owners July 6, 2020 03:12

rolfbjarne requested changes Jul 6, 2020

View reviewed changes

mandel-macaque commented Jul 6, 2020

View reviewed changes

src/clockkit.cs Show resolved Hide resolved

Apply suggestions from code review

4f18188

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

spouliot suggested changes Jul 6, 2020

View reviewed changes

whitneyschmidt approved these changes Jul 6, 2020

View reviewed changes

mandel-macaque added 3 commits July 8, 2020 11:49

Merge branch 'xcode12' into clockkit-xcode12-beta1

466d52b

Move key to correct location.

14a087a

Add missing PInkvoke.

55acfd8

spouliot suggested changes Jul 8, 2020

View reviewed changes

mandel-macaque added 3 commits July 10, 2020 09:54

Merge branch 'xcode12' into clockkit-xcode12-beta1

9316de6

Address reviews and add missing test.

370a489

Undo changed added by vsmac.

0fec044

spouliot suggested changes Jul 10, 2020

View reviewed changes

mandel-macaque added 2 commits July 10, 2020 18:39

Use smart enum instead.

8e252ea

Use VSMac is enfuraiting.

98b6e85

dalexsoto approved these changes Jul 13, 2020

View reviewed changes

spouliot approved these changes Jul 13, 2020

View reviewed changes

mandel-macaque commented Jul 13, 2020

View reviewed changes

src/clockkit.cs Outdated Show resolved Hide resolved

Apply suggestions from code review

6bcb2ae

dalexsoto reviewed Jul 13, 2020

View reviewed changes

src/clockkit.cs Outdated Show resolved Hide resolved

Update src/clockkit.cs

beefac6

Co-authored-by: Alex Soto <alex@alexsoto.me>

rolfbjarne approved these changes Jul 14, 2020

View reviewed changes

mandel-macaque and others added 2 commits July 14, 2020 07:59

Update tests/monotouch-test/ClockKit/CLKComplicationTest.cs

1545343

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

Add missing attr.

85249a3

mandel-macaque merged commit 8bb6005 into xamarin:xcode12 Jul 14, 2020

mandel-macaque deleted the clockkit-xcode12-beta1 branch July 14, 2020 15:12

		interface CLKImageProvider : NSCopying {

		[Deprecated (PlatformName.iOS, 14, 0, message: "The default constructor is deprecated.")]

		interface CLKTextProvider : NSCopying {

		[Deprecated (PlatformName.iOS, 14, 0, message: "The default constructor is deprecated. Use the provided factories instead.")]

		interface CLKImageProvider : NSCopying {

		[Deprecated (PlatformName.iOS, 14, 0)]

[ClockKit] Add support for Xcode 12 beta 1. #9010

[ClockKit] Add support for Xcode 12 beta 1. #9010

Conversation

mandel-macaque commented Jul 6, 2020

monojenkins commented Jul 6, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monojenkins commented Jul 6, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mandel-macaque Jul 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monojenkins commented Jul 8, 2020

spouliot left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monojenkins commented Jul 8, 2020

monojenkins commented Jul 10, 2020

Test results

Failed tests

Choose a reason for hiding this comment

monojenkins commented Jul 10, 2020

monojenkins commented Jul 11, 2020

dalexsoto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dalexsoto Jul 13, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monojenkins commented Jul 13, 2020

monojenkins commented Jul 14, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monojenkins commented Jul 14, 2020

monojenkins commented Jul 14, 2020

mandel-macaque Jul 8, 2020 •

edited

Loading

spouliot left a comment •

edited

Loading

dalexsoto Jul 13, 2020 •

edited

Loading