@octane-xplat/nativescript-mason-core 0.0.1 → 1.0.0-beta.1

package/platforms/ios/include/SDWebImage/SDImageFrame.h

@@ -0,0 +1,44 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <Foundation/Foundation.h>
+#import "SDWebImageCompat.h"
+
+/**
+ This class is used for creating animated images via `animatedImageWithFrames` in `SDImageCoderHelper`.
+ @note If you need to specify animated images loop count, use `sd_imageLoopCount` property in `UIImage+Metadata.h`.
+ */
+@interface SDImageFrame : NSObject
+
+/**
+ The image of current frame. You should not set an animated image.
+ */
+@property (nonatomic, strong, readonly, nonnull) UIImage *image;
+/**
+ The duration of current frame to be displayed. The number is seconds but not milliseconds. You should not set this to zero.
+ */
+@property (nonatomic, readonly, assign) NSTimeInterval duration;
+
+/// Create a frame instance with specify image and duration
+/// @param image current frame's image
+/// @param duration current frame's duration
+- (nonnull instancetype)initWithImage:(nonnull UIImage *)image duration:(NSTimeInterval)duration;
+
+/**
+ Create a frame instance with specify image and duration
+
+ @param image current frame's image
+ @param duration current frame's duration
+ @return frame instance
+ */
++ (nonnull instancetype)frameWithImage:(nonnull UIImage *)image duration:(NSTimeInterval)duration;
+
+- (nonnull instancetype)init NS_UNAVAILABLE;
++ (nonnull instancetype)new  NS_UNAVAILABLE;
+
+@end

package/platforms/ios/include/SDWebImage/SDImageGIFCoder.h

@@ -0,0 +1,22 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <Foundation/Foundation.h>
+#import "SDImageIOAnimatedCoder.h"
+
+/**
+ Built in coder using ImageIO that supports animated GIF encoding/decoding
+ @note `SDImageIOCoder` supports GIF but only as static (will use the 1st frame).
+ @note Use `SDImageGIFCoder` for fully animated GIFs. For `UIImageView`, it will produce animated `UIImage`(`NSImage` on macOS) for rendering. For `SDAnimatedImageView`, it will use `SDAnimatedImage` for rendering.
+ @note The recommended approach for animated GIFs is using `SDAnimatedImage` with `SDAnimatedImageView`. It's more performant than `UIImageView` for GIF displaying(especially on memory usage)
+ */
+@interface SDImageGIFCoder : SDImageIOAnimatedCoder <SDProgressiveImageCoder, SDAnimatedImageCoder>
+
+@property (nonatomic, class, readonly, nonnull) SDImageGIFCoder *sharedCoder;
+
+@end

package/platforms/ios/include/SDWebImage/SDImageGraphics.h

@@ -0,0 +1,28 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDWebImageCompat.h"
+#import <CoreGraphics/CoreGraphics.h>
+
+/**
+ These following graphics context method are provided to easily write cross-platform(AppKit/UIKit) code.
+ For UIKit, these methods just call the same method in `UIGraphics.h`. See the documentation for usage.
+ For AppKit, these methods use `NSGraphicsContext` to create image context and match the behavior like UIKit.
+ @note If you don't care bitmap format (ARGB8888) and just draw image, use `SDGraphicsImageRenderer` instead. It's more performant on RAM usage.`
+ */
+
+/// Returns the current graphics context.
+FOUNDATION_EXPORT CGContextRef __nullable SDGraphicsGetCurrentContext(void) CF_RETURNS_NOT_RETAINED;
+/// Creates a bitmap-based graphics context and makes it the current context.
+FOUNDATION_EXPORT void SDGraphicsBeginImageContext(CGSize size);
+/// Creates a bitmap-based graphics context with the specified options.
+FOUNDATION_EXPORT void SDGraphicsBeginImageContextWithOptions(CGSize size, BOOL opaque, CGFloat scale);
+/// Removes the current bitmap-based graphics context from the top of the stack.
+FOUNDATION_EXPORT void SDGraphicsEndImageContext(void);
+/// Returns an image based on the contents of the current bitmap-based graphics context.
+FOUNDATION_EXPORT UIImage * __nullable SDGraphicsGetImageFromCurrentImageContext(void);

package/platforms/ios/include/SDWebImage/SDImageHEICCoder.h

@@ -0,0 +1,25 @@
+/*
+* This file is part of the SDWebImage package.
+* (c) Olivier Poitrey <rs@dailymotion.com>
+*
+* For the full copyright and license information, please view the LICENSE
+* file that was distributed with this source code.
+*/
+
+#import <Foundation/Foundation.h>
+#import "SDImageIOAnimatedCoder.h"
+
+/**
+ This coder is used for HEIC (HEIF with HEVC container codec) image format.
+ Image/IO provide the static HEIC (.heic) support in iOS 11/macOS 10.13/tvOS 11/watchOS 4+.
+ Image/IO provide the animated HEIC (.heics) support in iOS 13/macOS 10.15/tvOS 13/watchOS 6+.
+ See https://nokiatech.github.io/heif/technical.html for the standard.
+ @note This coder is not in the default coder list for now, since HEIC animated image is really rare, and Apple's implementation still contains performance issues. You can enable if you need this.
+ @note If you need to support lower firmware version for HEIF, you can have a try at https://github.com/SDWebImage/SDWebImageHEIFCoder
+ */
+API_AVAILABLE(ios(13.0), tvos(13.0), macos(10.15), watchos(6.0))
+@interface SDImageHEICCoder : SDImageIOAnimatedCoder <SDProgressiveImageCoder, SDAnimatedImageCoder>
+
+@property (nonatomic, class, readonly, nonnull) SDImageHEICCoder *sharedCoder;
+
+@end

package/platforms/ios/include/SDWebImage/SDImageIOAnimatedCoder.h

@@ -0,0 +1,65 @@
+/*
+* This file is part of the SDWebImage package.
+* (c) Olivier Poitrey <rs@dailymotion.com>
+*
+* For the full copyright and license information, please view the LICENSE
+* file that was distributed with this source code.
+*/
+
+#import <Foundation/Foundation.h>
+#import "SDImageCoder.h"
+
+/**
+ This is the abstract class for all animated coder, which use the Image/IO API. You can not use this directly as real coders. A exception will be raised if you use this class.
+ All of the properties need the subclass to implement and works as expected.
+ For Image/IO, See Apple's documentation: https://developer.apple.com/documentation/imageio
+ */
+@interface SDImageIOAnimatedCoder : NSObject <SDProgressiveImageCoder, SDAnimatedImageCoder>
+
+#pragma mark - Subclass Override
+/**
+ The supported animated image format. Such as `SDImageFormatGIF`.
+ @note Subclass override.
+ */
+@property (class, readonly) SDImageFormat imageFormat;
+/**
+ The supported image format UTI Type. Such as `kSDUTTypeGIF`.
+ This can be used for cases when we can not detect `SDImageFormat. Such as progressive decoding's hint format `kCGImageSourceTypeIdentifierHint`.
+ @note Subclass override.
+ */
+@property (class, readonly, nonnull) NSString *imageUTType;
+/**
+ Some image codec use different UTI Type between animated image and static image.
+ For this case, override this method and return the UTI for animated image encoding.
+ @note Defaults to use the value of `imageUTType`, so it's @optional actually.
+ @note Subclass override.
+ */
+@property (class, readonly, nonnull) NSString *animatedImageUTType;
+/**
+ The image container property key used in Image/IO API. Such as `kCGImagePropertyGIFDictionary`.
+ @note Subclass override.
+ */
+@property (class, readonly, nonnull) NSString *dictionaryProperty;
+/**
+ The image unclamped delay time property key used in Image/IO  API. Such as `kCGImagePropertyGIFUnclampedDelayTime`
+ @note Subclass override.
+ */
+@property (class, readonly, nonnull) NSString *unclampedDelayTimeProperty;
+/**
+ The image delay time property key used in Image/IO API. Such as `kCGImagePropertyGIFDelayTime`.
+ @note Subclass override.
+ */
+@property (class, readonly, nonnull) NSString *delayTimeProperty;
+/**
+ The image loop count property key used in Image/IO API. Such as `kCGImagePropertyGIFLoopCount`.
+ @note Subclass override.
+ */
+@property (class, readonly, nonnull) NSString *loopCountProperty;
+/**
+ The default loop count when there are no any loop count information inside image container metadata.
+ For example, for GIF format, the standard use 1 (play once). For APNG format, the standard use 0 (infinity loop).
+ @note Subclass override.
+ */
+@property (class, readonly) NSUInteger defaultLoopCount;
+
+@end

package/platforms/ios/include/SDWebImage/SDImageIOCoder.h

@@ -0,0 +1,30 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <Foundation/Foundation.h>
+#import "SDImageCoder.h"
+
+/**
+ Built in coder that supports PNG, JPEG, TIFF, includes support for progressive decoding.
+ 
+ GIF
+ Also supports static GIF (meaning will only handle the 1st frame).
+ For a full GIF support, we recommend `SDAnimatedImageView` to keep both CPU and memory balanced.
+ 
+ HEIC
+ This coder also supports HEIC format because ImageIO supports it natively. But it depends on the system capabilities, so it won't work on all devices, see: https://devstreaming-cdn.apple.com/videos/wwdc/2017/511tj33587vdhds/511/511_working_with_heif_and_hevc.pdf
+ Decode(Software): !Simulator && (iOS 11 || tvOS 11 || macOS 10.13)
+ Decode(Hardware): !Simulator && ((iOS 11 && A9Chip) || (macOS 10.13 && 6thGenerationIntelCPU))
+ Encode(Software): macOS 10.13
+ Encode(Hardware): !Simulator && ((iOS 11 && A10FusionChip) || (macOS 10.13 && 6thGenerationIntelCPU))
+ */
+@interface SDImageIOCoder : NSObject <SDProgressiveImageCoder>
+
+@property (nonatomic, class, readonly, nonnull) SDImageIOCoder *sharedCoder;
+
+@end

package/platforms/ios/include/SDWebImage/SDImageLoader.h

@@ -0,0 +1,146 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDWebImageCompat.h"
+#import "SDWebImageDefine.h"
+#import "SDWebImageOperation.h"
+#import "SDImageCoder.h"
+
+typedef void(^SDImageLoaderProgressBlock)(NSInteger receivedSize, NSInteger expectedSize, NSURL * _Nullable targetURL);
+typedef void(^SDImageLoaderCompletedBlock)(UIImage * _Nullable image, NSData * _Nullable data, NSError * _Nullable error, BOOL finished);
+
+#pragma mark - Context Options
+
+/**
+ A `UIImage` instance from `SDWebImageManager` when you specify `SDWebImageRefreshCached` and image cache hit.
+ This can be a hint for image loader to load the image from network and refresh the image from remote location if needed. If the image from remote location does not change, you should call the completion with `SDWebImageErrorCacheNotModified` error. (UIImage)
+ @note If you don't implement `SDWebImageRefreshCached` support, you do not need to care about this context option.
+ */
+FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextLoaderCachedImage;
+
+#pragma mark - Helper method
+
+/**
+ This is the built-in decoding process for image download from network or local file.
+ @note If you want to implement your custom loader with `requestImageWithURL:options:context:progress:completed:` API, but also want to keep compatible with SDWebImage's behavior, you'd better use this to produce image.
+
+ @param imageData The image data from the network. Should not be nil
+ @param imageURL The image URL from the input. Should not be nil
+ @param options The options arg from the input
+ @param context The context arg from the input
+ @return The decoded image for current image data load from the network
+ */
+FOUNDATION_EXPORT UIImage * _Nullable SDImageLoaderDecodeImageData(NSData * _Nonnull imageData, NSURL * _Nonnull imageURL, SDWebImageOptions options, SDWebImageContext * _Nullable context);
+
+/**
+ This is the built-in decoding process for image progressive download from network. It's used when `SDWebImageProgressiveLoad` option is set. (It's not required when your loader does not support progressive image loading)
+ @note If you want to implement your custom loader with `requestImageWithURL:options:context:progress:completed:` API, but also want to keep compatible with SDWebImage's behavior, you'd better use this to produce image.
+
+ @param imageData The image data from the network so far. Should not be nil
+ @param imageURL The image URL from the input. Should not be nil
+ @param finished Pass NO to specify the download process has not finished. Pass YES when all image data has finished.
+ @param operation The loader operation associated with current progressive download. Why to provide this is because progressive decoding need to store the partial decoded context for each operation to avoid conflict. You should provide the operation from `loadImageWithURL:` method return value.
+ @param options The options arg from the input
+ @param context The context arg from the input
+ @return The decoded progressive image for current image data load from the network
+ */
+FOUNDATION_EXPORT UIImage * _Nullable SDImageLoaderDecodeProgressiveImageData(NSData * _Nonnull imageData, NSURL * _Nonnull imageURL, BOOL finished,  id<SDWebImageOperation> _Nonnull operation, SDWebImageOptions options, SDWebImageContext * _Nullable context);
+
+/**
+ This function get the progressive decoder for current loading operation. If no progressive decoding is happended or decoder is not able to construct, return nil.
+ @return The progressive decoder associated with the loading operation.
+ */
+FOUNDATION_EXPORT id<SDProgressiveImageCoder> _Nullable SDImageLoaderGetProgressiveCoder(id<SDWebImageOperation> _Nonnull operation);
+
+/**
+ This function set the progressive decoder for current loading operation. If no progressive decoding is happended, pass nil.
+ @param progressiveCoder The loading operation to associate the progerssive decoder.
+ */
+FOUNDATION_EXPORT void SDImageLoaderSetProgressiveCoder(id<SDWebImageOperation> _Nonnull operation, id<SDProgressiveImageCoder> _Nullable progressiveCoder);
+
+#pragma mark - SDImageLoader
+
+/**
+ This is the protocol to specify custom image load process. You can create your own class to conform this protocol and use as a image loader to load image from network or any available remote resources defined by yourself.
+ If you want to implement custom loader for image download from network or local file, you just need to concentrate on image data download only. After the download finish, call `SDImageLoaderDecodeImageData` or `SDImageLoaderDecodeProgressiveImageData` to use the built-in decoding process and produce image (Remember to call in the global queue). And finally callback the completion block.
+ If you directly get the image instance using some third-party SDKs, such as image directly from Photos framework. You can process the image data and image instance by yourself without that built-in decoding process. And finally callback the completion block.
+ @note It's your responsibility to load the image in the desired global queue(to avoid block main queue). We do not dispatch these method call in a global queue but just from the call queue (For `SDWebImageManager`, it typically call from the main queue).
+*/
+@protocol SDImageLoader <NSObject>
+
+@required
+/**
+ Whether current image loader supports to load the provide image URL.
+ This will be checked every time a new image request come for loader. If this return NO, we will mark this image load as failed. If return YES, we will start to call `requestImageWithURL:options:context:progress:completed:`.
+
+ @param url The image URL to be loaded.
+ @return YES to continue download, NO to stop download.
+ */
+- (BOOL)canRequestImageForURL:(nullable NSURL *)url API_DEPRECATED_WITH_REPLACEMENT("canRequestImageForURL:options:context:", macos(10.10, API_TO_BE_DEPRECATED), ios(8.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED));
+
+@optional
+/**
+ Whether current image loader supports to load the provide image URL, with associated options and context.
+ This will be checked every time a new image request come for loader. If this return NO, we will mark this image load as failed. If return YES, we will start to call `requestImageWithURL:options:context:progress:completed:`.
+
+ @param url The image URL to be loaded.
+ @param options A mask to specify options to use for this request
+ @param context A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold.
+ @return YES to continue download, NO to stop download.
+ */
+- (BOOL)canRequestImageForURL:(nullable NSURL *)url
+                      options:(SDWebImageOptions)options
+                      context:(nullable SDWebImageContext *)context;
+
+@required
+/**
+ Load the image and image data with the given URL and return the image data. You're responsible for producing the image instance.
+
+ @param url The URL represent the image. Note this may not be a HTTP URL
+ @param options A mask to specify options to use for this request
+ @param context A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold.
+ @param progressBlock A block called while image is downloading
+ *                    @note the progress block is executed on a background queue
+ @param completedBlock A block called when operation has been completed.
+ @return An operation which allow the user to cancel the current request.
+ */
+- (nullable id<SDWebImageOperation>)requestImageWithURL:(nullable NSURL *)url
+                                                options:(SDWebImageOptions)options
+                                                context:(nullable SDWebImageContext *)context
+                                               progress:(nullable SDImageLoaderProgressBlock)progressBlock
+                                              completed:(nullable SDImageLoaderCompletedBlock)completedBlock;
+
+
+/**
+ Whether the error from image loader should be marked indeed un-recoverable or not.
+ If this return YES, failed URL which does not using `SDWebImageRetryFailed` will be blocked into black list. Else not.
+
+ @param url The URL represent the image. Note this may not be a HTTP URL
+ @param error The URL's loading error, from previous `requestImageWithURL:options:context:progress:completed:` completedBlock's error.
+ @return Whether to block this url or not. Return YES to mark this URL as failed.
+ */
+- (BOOL)shouldBlockFailedURLWithURL:(nonnull NSURL *)url
+                              error:(nonnull NSError *)error API_DEPRECATED_WITH_REPLACEMENT("shouldBlockFailedURLWithURL:error:options:context:", macos(10.10, API_TO_BE_DEPRECATED), ios(8.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED));
+
+@optional
+/**
+ Whether the error from image loader should be marked indeed un-recoverable or not, with associated options and context.
+ If this return YES, failed URL which does not using `SDWebImageRetryFailed` will be blocked into black list. Else not.
+
+ @param url The URL represent the image. Note this may not be a HTTP URL
+ @param error The URL's loading error, from previous `requestImageWithURL:options:context:progress:completed:` completedBlock's error.
+ @param options A mask to specify options to use for this request
+ @param context A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold.
+ @return Whether to block this url or not. Return YES to mark this URL as failed.
+ */
+- (BOOL)shouldBlockFailedURLWithURL:(nonnull NSURL *)url
+                              error:(nonnull NSError *)error
+                            options:(SDWebImageOptions)options
+                            context:(nullable SDWebImageContext *)context;
+
+@end

package/platforms/ios/include/SDWebImage/SDImageLoadersManager.h

@@ -0,0 +1,40 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDImageLoader.h"
+
+/**
+ A loaders manager to manage multiple loaders
+ */
+@interface SDImageLoadersManager : NSObject <SDImageLoader>
+
+/**
+ Returns the global shared loaders manager instance. By default we will set [`SDWebImageDownloader.sharedDownloader`] into the loaders array.
+ */
+@property (nonatomic, class, readonly, nonnull) SDImageLoadersManager *sharedManager;
+
+/**
+ All image loaders in manager. The loaders array is a priority queue, which means the later added loader will have the highest priority
+ */
+@property (nonatomic, copy, nullable) NSArray<id<SDImageLoader>>* loaders;
+
+/**
+ Add a new image loader to the end of loaders array. Which has the highest priority.
+ 
+ @param loader loader
+ */
+- (void)addLoader:(nonnull id<SDImageLoader>)loader;
+
+/**
+ Remove an image loader in the loaders array.
+ 
+ @param loader loader
+ */
+- (void)removeLoader:(nonnull id<SDImageLoader>)loader;
+
+@end