Merge pull request SDWebImage#2343 from dreampiggy/feature_watchkit_s…

…etImage_4.x

Add the support for watchOS to use View Category method (sd_setImageWithURL:) on WKInterfaceImage

Examples/SDWebImage Watch Demo Extension/InterfaceController.m

@@ -7,7 +7,7 @@
  */
 
 #import "InterfaceController.h"
-#import <SDWebImage/SDWebImageManager.h>
+#import <SDWebImage/UIImageView+WebCache.h>
 
 
 @interface InterfaceController()
@@ -30,9 +30,8 @@ - (void)willActivate {
     [super willActivate];
 
     NSString *urlString = @"https://nr-platform.s3.amazonaws.com/uploads/platform/published_extension/branding_icon/275/AmazonS3.png";
-    [[SDWebImageManager sharedManager] loadImageWithURL:[NSURL URLWithString:urlString] options:0 progress:nil completed:^(UIImage * _Nullable image, NSData * _Nullable data, NSError * _Nullable error, SDImageCacheType cacheType, BOOL finished, NSURL * _Nullable imageURL) {
-        self.imageInterface.image = image;
-    }];
+    WKInterfaceImage *imageInterface = self.imageInterface;
+    [imageInterface sd_setImageWithURL:[NSURL URLWithString:urlString]];
 }
 
 - (void)didDeactivate {

SDWebImage/SDWebImageCompat.h

@@ -70,6 +70,12 @@
     #endif
     #if SD_WATCH
         #import <WatchKit/WatchKit.h>
+        #ifndef UIView
+            #define UIView WKInterfaceObject
+        #endif
+        #ifndef UIImageView
+            #define UIImageView WKInterfaceImage
+        #endif
     #endif
 #endif
 

SDWebImage/UIImageView+WebCache.h

@@ -7,9 +7,6 @@
  */
 
 #import "SDWebImageCompat.h"
-
-#if SD_UIKIT || SD_MAC
-
 #import "SDWebImageManager.h"
 
 /**
@@ -195,5 +192,3 @@
 #endif
 
 @end
-
-#endif

SDWebImage/UIImageView+WebCache.m

@@ -7,9 +7,6 @@
  */
 
 #import "UIImageView+WebCache.h"
-
-#if SD_UIKIT || SD_MAC
-
 #import "objc/runtime.h"
 #import "UIView+WebCacheOperation.h"
 #import "UIView+WebCache.h"
@@ -140,5 +137,3 @@ - (void)sd_cancelCurrentAnimationImagesLoad {
 #endif
 
 @end
-
-#endif

SDWebImage/UIView+WebCache.h

@@ -7,9 +7,6 @@
  */
 
 #import "SDWebImageCompat.h"
-
-#if SD_UIKIT || SD_MAC
-
 #import "SDWebImageManager.h"
 #import "SDWebImageTransition.h"
 
@@ -105,6 +102,8 @@ typedef void(^SDSetImageBlock)(UIImage * _Nullable image, NSData * _Nullable ima
  */
 - (void)sd_cancelCurrentImageLoad;
 
+#if SD_UIKIT || SD_MAC
+
 #pragma mark - Image Transition
 
 /**
@@ -135,6 +134,6 @@ typedef void(^SDSetImageBlock)(UIImage * _Nullable image, NSData * _Nullable ima
 
 #endif
 
-@end
-
 #endif
+
+@end

SDWebImage/UIView+WebCache.m

@@ -7,9 +7,6 @@
  */
 
 #import "UIView+WebCache.h"
-
-#if SD_UIKIT || SD_MAC
-
 #import "objc/runtime.h"
 #import "UIView+WebCacheOperation.h"
 
@@ -23,8 +20,8 @@
 #if SD_UIKIT
 static char TAG_ACTIVITY_INDICATOR;
 static char TAG_ACTIVITY_STYLE;
-#endif
 static char TAG_ACTIVITY_SHOW;
+#endif
 
 @implementation UIView (WebCache)
 
@@ -78,10 +75,12 @@ - (void)sd_internalSetImageWithURL:(nullable NSURL *)url
     }
 
     if (url) {
+#if SD_UIKIT
         // check if activityView is enabled or not
         if ([self sd_showActivityIndicatorView]) {
             [self sd_addActivityIndicator];
         }
+#endif
 
         // reset the progress
         self.sd_imageProgress.totalUnitCount = 0;
@@ -105,7 +104,9 @@ - (void)sd_internalSetImageWithURL:(nullable NSURL *)url
         id <SDWebImageOperation> operation = [manager loadImageWithURL:url options:options progress:combinedProgressBlock completed:^(UIImage *image, NSData *data, NSError *error, SDImageCacheType cacheType, BOOL finished, NSURL *imageURL) {
             __strong __typeof (wself) sself = wself;
             if (!sself) { return; }
+#if SD_UIKIT
             [sself sd_removeActivityIndicator];
+#endif
             // if the progress not been updated, mark it to complete state
             if (finished && !error && sself.sd_imageProgress.totalUnitCount == 0 && sself.sd_imageProgress.completedUnitCount == 0) {
                 sself.sd_imageProgress.totalUnitCount = SDWebImageProgressUnitCountUnknown;
@@ -144,32 +145,44 @@ - (void)sd_internalSetImageWithURL:(nullable NSURL *)url
                 targetData = nil;
             }
 
+#if SD_UIKIT || SD_MAC
             // check whether we should use the image transition
             SDWebImageTransition *transition = nil;
             if (finished && (options & SDWebImageForceTransition || cacheType == SDImageCacheTypeNone)) {
                 transition = sself.sd_imageTransition;
             }
+#endif
             if ([context valueForKey:SDWebImageInternalSetImageGroupKey]) {
                 dispatch_group_t group = [context valueForKey:SDWebImageInternalSetImageGroupKey];
                 dispatch_group_enter(group);
                 dispatch_main_async_safe(^{
+#if SD_UIKIT || SD_MAC
                     [sself sd_setImage:targetImage imageData:targetData basedOnClassOrViaCustomSetImageBlock:setImageBlock transition:transition cacheType:cacheType imageURL:imageURL];
+#else
+                    [sself sd_setImage:targetImage imageData:targetData basedOnClassOrViaCustomSetImageBlock:setImageBlock];
+#endif
                 });
                 // ensure completion block is called after custom setImage process finish
                 dispatch_group_notify(group, dispatch_get_main_queue(), ^{
                     callCompletedBlockClojure();
                 });
             } else {
                 dispatch_main_async_safe(^{
+#if SD_UIKIT || SD_MAC
                     [sself sd_setImage:targetImage imageData:targetData basedOnClassOrViaCustomSetImageBlock:setImageBlock transition:transition cacheType:cacheType imageURL:imageURL];
+#else
+                    [sself sd_setImage:targetImage imageData:targetData basedOnClassOrViaCustomSetImageBlock:setImageBlock];
+#endif
                     callCompletedBlockClojure();
                 });
             }
         }];
         [self sd_setImageLoadOperation:operation forKey:validOperationKey];
     } else {
         dispatch_main_async_safe(^{
+#if SD_UIKIT
             [self sd_removeActivityIndicator];
+#endif
             if (completedBlock) {
                 NSError *error = [NSError errorWithDomain:SDWebImageErrorDomain code:-1 userInfo:@{NSLocalizedDescriptionKey : @"Trying to load a nil url"}];
                 completedBlock(nil, error, SDImageCacheTypeNone, url);
@@ -183,23 +196,31 @@ - (void)sd_cancelCurrentImageLoad {
 }
 
 - (void)sd_setImage:(UIImage *)image imageData:(NSData *)imageData basedOnClassOrViaCustomSetImageBlock:(SDSetImageBlock)setImageBlock {
+#if SD_UIKIT || SD_MAC
     [self sd_setImage:image imageData:imageData basedOnClassOrViaCustomSetImageBlock:setImageBlock transition:nil cacheType:0 imageURL:nil];
+#else
+    // watchOS does not support view transition. Simplify the logic
+    if (setImageBlock) {
+        setImageBlock(image, imageData);
+    } else if ([self isKindOfClass:[UIImageView class]]) {
+        UIImageView *imageView = (UIImageView *)self;
+        [imageView setImage:image];
+    }
+#endif
 }
 
+#if SD_UIKIT || SD_MAC
 - (void)sd_setImage:(UIImage *)image imageData:(NSData *)imageData basedOnClassOrViaCustomSetImageBlock:(SDSetImageBlock)setImageBlock transition:(SDWebImageTransition *)transition cacheType:(SDImageCacheType)cacheType imageURL:(NSURL *)imageURL {
     UIView *view = self;
     SDSetImageBlock finalSetImageBlock;
     if (setImageBlock) {
         finalSetImageBlock = setImageBlock;
-    }
-#if SD_UIKIT || SD_MAC
-    else if ([view isKindOfClass:[UIImageView class]]) {
+    } else if ([view isKindOfClass:[UIImageView class]]) {
         UIImageView *imageView = (UIImageView *)view;
         finalSetImageBlock = ^(UIImage *setImage, NSData *setImageData) {
             imageView.image = setImage;
         };
     }
-#endif
 #if SD_UIKIT
     else if ([view isKindOfClass:[UIButton class]]) {
         UIButton *button = (UIButton *)view;
@@ -257,15 +278,20 @@ - (void)sd_setImage:(UIImage *)image imageData:(NSData *)imageData basedOnClassO
         }
     }
 }
+#endif
 
 - (void)sd_setNeedsLayout {
 #if SD_UIKIT
     [self setNeedsLayout];
 #elif SD_MAC
     [self setNeedsLayout:YES];
+#elif SD_WATCH
+    // Do nothing because WatchKit automatically layout the view after property change
 #endif
 }
 
+#if SD_UIKIT || SD_MAC
+
 #pragma mark - Image Transition
 - (SDWebImageTransition *)sd_imageTransition {
     return objc_getAssociatedObject(self, @selector(sd_imageTransition));
@@ -275,18 +301,16 @@ - (void)setSd_imageTransition:(SDWebImageTransition *)sd_imageTransition {
     objc_setAssociatedObject(self, @selector(sd_imageTransition), sd_imageTransition, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
 }
 
-#pragma mark - Activity indicator
-
-#pragma mark -
 #if SD_UIKIT
+
+#pragma mark - Activity indicator
 - (UIActivityIndicatorView *)activityIndicator {
     return (UIActivityIndicatorView *)objc_getAssociatedObject(self, &TAG_ACTIVITY_INDICATOR);
 }
 
 - (void)setActivityIndicator:(UIActivityIndicatorView *)activityIndicator {
     objc_setAssociatedObject(self, &TAG_ACTIVITY_INDICATOR, activityIndicator, OBJC_ASSOCIATION_RETAIN);
 }
-#endif
 
 - (void)sd_setShowActivityIndicatorView:(BOOL)show {
     objc_setAssociatedObject(self, &TAG_ACTIVITY_SHOW, @(show), OBJC_ASSOCIATION_RETAIN);
@@ -296,18 +320,15 @@ - (BOOL)sd_showActivityIndicatorView {
     return [objc_getAssociatedObject(self, &TAG_ACTIVITY_SHOW) boolValue];
 }
 
-#if SD_UIKIT
 - (void)sd_setIndicatorStyle:(UIActivityIndicatorViewStyle)style{
     objc_setAssociatedObject(self, &TAG_ACTIVITY_STYLE, [NSNumber numberWithInt:style], OBJC_ASSOCIATION_RETAIN);
 }
 
 - (int)sd_getIndicatorStyle{
     return [objc_getAssociatedObject(self, &TAG_ACTIVITY_STYLE) intValue];
 }
-#endif
 
 - (void)sd_addActivityIndicator {
-#if SD_UIKIT
     dispatch_main_async_safe(^{
         if (!self.activityIndicator) {
             self.activityIndicator = [[UIActivityIndicatorView alloc] initWithActivityIndicatorStyle:[self sd_getIndicatorStyle]];
@@ -332,20 +353,19 @@ - (void)sd_addActivityIndicator {
         }
         [self.activityIndicator startAnimating];
     });
-#endif
 }
 
 - (void)sd_removeActivityIndicator {
-#if SD_UIKIT
     dispatch_main_async_safe(^{
         if (self.activityIndicator) {
             [self.activityIndicator removeFromSuperview];
             self.activityIndicator = nil;
         }
     });
-#endif
 }
 
-@end
+#endif
 
 #endif
+
+@end

SDWebImage/UIView+WebCacheOperation.h

@@ -7,10 +7,7 @@
  */
 
 #import "SDWebImageCompat.h"
-
-#if SD_UIKIT || SD_MAC
-
-#import "SDWebImageManager.h"
+#import "SDWebImageOperation.h"
 
 // These methods are used to support canceling for UIView image loading, it's designed to be used internal but not external.
 // All the stored operations are weak, so it will be dalloced after image loading finished. If you need to store operations, use your own class to keep a strong reference for them.
@@ -39,5 +36,3 @@
 - (void)sd_removeImageLoadOperationWithKey:(nullable NSString *)key;
 
 @end
-
-#endif

SDWebImage/UIView+WebCacheOperation.m

@@ -7,9 +7,6 @@
  */
 
 #import "UIView+WebCacheOperation.h"
-
-#if SD_UIKIT || SD_MAC
-
 #import "objc/runtime.h"
 
 static char loadOperationKey;
@@ -71,5 +68,3 @@ - (void)sd_removeImageLoadOperationWithKey:(nullable NSString *)key {
 }
 
 @end
-
-#endif