Deprecate custom version comparators (#2639)

sparkle-project · Oct 7, 2024 · 544c642 · 544c642
1 parent ad3c8b5
commit 544c642
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/Sparkle/SPUUpdaterDelegate.h b/Sparkle/SPUUpdaterDelegate.h
@@ -386,7 +386,7 @@ SU_EXPORT extern NSString *const SUSystemProfilerPreferredLanguageKey;
  @param updater The updater instance.
  @return The custom version comparator or @c nil if you don't want to be delegated this task.
  */
-- (nullable id<SUVersionComparison>)versionComparatorForUpdater:(SPUUpdater *)updater;
+- (nullable id<SUVersionComparison>)versionComparatorForUpdater:(SPUUpdater *)updater __deprecated_msg("Custom version comparators are deprecated because they are incompatible with how the system compares different versions of an app.");
 
 /**
  Called when a background update will be scheduled after a delay.

diff --git a/Sparkle/SUAppcastDriver.m b/Sparkle/SUAppcastDriver.m
@@ -429,11 +429,14 @@ + (SUAppcastItem *)bestItemFromAppcastItems:(NSArray *)appcastItems getDeltaItem
 {
     id<SUVersionComparison> comparator = nil;
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
     // Give the delegate a chance to provide a custom version comparator
     id<SPUUpdaterDelegate> updaterDelegate = _updaterDelegate;
     if ([updaterDelegate respondsToSelector:@selector((versionComparatorForUpdater:))]) {
         comparator = [updaterDelegate versionComparatorForUpdater:_updater];
     }
+#pragma clang diagnostic pop
 
     // If we don't get a comparator from the delegate, use the default comparator
     if (comparator == nil) {

diff --git a/Sparkle/SUUpdater.m b/Sparkle/SUUpdater.m
@@ -460,6 +460,8 @@ - (void)updaterWillRelaunchApplication:(SPUUpdater *)__unused updater
     }
 }
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-implementations"
 - (id<SUVersionComparison>)versionComparatorForUpdater:(SPUUpdater *)__unused updater
 {
     id<SUVersionComparison> versionComparator;
@@ -468,6 +470,7 @@ - (void)updaterWillRelaunchApplication:(SPUUpdater *)__unused updater
     }
     return versionComparator;
 }
+#pragma clang diagnostic pop
 
 // Private SPUUpdater API that allows us to defer providing an application path to relaunch
 - (NSString * _Nullable)_pathToRelaunchForUpdater:(SPUUpdater *)__unused updater