HNKCache.h

//
//  HNKCache.h
//  Haneke
//
//  Created by Hermes Pique on 10/02/14.
//  Copyright (c) 2014 Hermes Pique. All rights reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

#import <UIKit/UIKit.h>

@protocol HNKCacheEntity;
@class HNKCacheFormat;

#if HANEKE_DEBUG
#define HanekeLog(...) NSLog(@"HANEKE: %@", [NSString stringWithFormat:__VA_ARGS__]);
#else
#define HanekeLog(...)
#endif

@interface HNKCache : NSObject

#pragma mark Initializing the cache

- (id)initWithName:(NSString*)name;

+ (HNKCache*)sharedCache;

- (void)registerFormat:(HNKCacheFormat*)format;

@property (nonatomic, readonly) NSDictionary *formats;

#pragma mark Getting images

- (UIImage*)imageForEntity:(id<HNKCacheEntity>)entity formatName:(NSString *)formatName error:(NSError*__autoreleasing *)errorPtr;

- (BOOL)retrieveImageForEntity:(id<HNKCacheEntity>)entity formatName:(NSString *)formatName completionBlock:(void(^)(UIImage *image, NSError *error))completionBlock;

- (BOOL)retrieveImageForKey:(NSString*)key formatName:(NSString *)formatName completionBlock:(void(^)(UIImage *image, NSError *error))completionBlock;

#pragma mark Setting images

- (void)setImage:(UIImage*)image forKey:(NSString*)key formatName:(NSString*)formatName;

#pragma mark Removing images

- (void)removeAllImages;

- (void)removeImagesOfFormatNamed:(NSString*)formatName;

- (void)removeImagesOfEntity:(id<HNKCacheEntity>)entity;

@end

@protocol HNKCacheEntity <NSObject>

@property (nonatomic, readonly) NSString *cacheKey;

@optional

@property (nonatomic, readonly) UIImage *cacheOriginalImage;
@property (nonatomic, readonly) NSData *cacheOriginalData;


@end

typedef NS_ENUM(NSInteger, HNKScaleMode)
{
    HNKScaleModeFill = UIViewContentModeScaleToFill,
    HNKScaleModeAspectFit = UIViewContentModeScaleAspectFit,
    HNKScaleModeAspectFill = UIViewContentModeScaleAspectFill,
    HNKScaleModeNone
};

typedef NS_ENUM(NSInteger, HNKPreloadPolicy)
{
    HNKPreloadPolicyNone,
    HNKPreloadPolicyLastSession,
    HNKPreloadPolicyAll
};

@interface HNKCacheFormat : NSObject

@property (nonatomic, assign) BOOL allowUpscaling;

@property (nonatomic, assign) CGFloat compressionQuality;

@property (nonatomic, readonly) NSString *name;

@property (nonatomic, assign) CGSize size;

@property (nonatomic, assign) HNKScaleMode scaleMode;

@property (nonatomic, assign) unsigned long long diskCapacity;

@property (nonatomic, readonly) unsigned long long diskSize;

@property (nonatomic, assign) HNKPreloadPolicy preloadPolicy;

@property (nonatomic, copy) UIImage* (^preResizeBlock)(NSString *key, UIImage *image);

@property (nonatomic, copy) UIImage* (^postResizeBlock)(NSString *key, UIImage *image);

- (id)initWithName:(NSString*)name;

- (UIImage*)resizedImageFromImage:(UIImage*)image;

@end

extern NSString *const HNKErrorDomain;

extern NSString *const HNKExtendedFileAttributeKey;

enum
{
    HNKErrorEntityMustReturnImageOrData = -200,
    HNKErrorEntityCannotReadImageFromData = -201,

    HNKErrorDiskCacheMiss = -300,
    HNKErrorDiskCacheCannotReadFromFile = -301,
    HNKErrorDiskCacheCannotReadImageFromData = -302
};