Scanner.h

//
//  Scanner.h
//
//  Created by Andreea ERDELYI <andreea.erdelyi@cososys.com>
//
//  Copyright (C) 2017 CoSoSys Ltd team@sensitivity.io
//  CoSoSys Ltd. All rights reserved.
//  Please see the COPYING for more details.
//

#import <Foundation/Foundation.h>

@class ThreatInfo;
@class ThreatHandler;

@interface Scanner : NSObject

- (instancetype _Null_unspecified) init NS_UNAVAILABLE;
+ (instancetype _Null_unspecified) new NS_UNAVAILABLE;
- (instancetype _Null_unspecified) copy NS_UNAVAILABLE;
- (instancetype _Nullable) initWithError:(NSError * _Nullable * _Nullable)error NS_DESIGNATED_INITIALIZER NS_SWIFT_NAME(init());

// MARK: - Cancelable API
- (BOOL) cancelScanWithError:(NSError * _Nullable * _Nullable)error;
- (BOOL) isCanceled:(BOOL* _Nonnull)canceled withError:(NSError * _Nullable * _Nullable)error;

// MARK: - Core scan API
- (BOOL) scanString:(NSString * _Nonnull)text withThreatHandler:(ThreatHandler * _Nonnull)threatHandler withError:(NSError * _Nullable * _Nullable)error NS_SWIFT_NAME(scanString(_:threatHandler:));
- (BOOL) scanData:(NSData * _Nonnull)data withThreatHandler:(ThreatHandler * _Nonnull)threatHandler fileName:(NSString * _Nullable)fileName withError:(NSError * _Nullable * _Nullable)error NS_SWIFT_NAME(scanData(_:threatHandler:fileName:));
- (BOOL) scanFileAtPath:(NSString * _Nonnull)filePath withThreatHandler:(ThreatHandler * _Nonnull)threatHandler withError:(NSError * _Nullable * _Nullable)error NS_SWIFT_NAME(scanFile(atPath:threatHandler:));

// MARK: - Convenience scan API
- (NSArray<ThreatInfo *> * _Nullable) scanString:(NSString * _Nonnull)text stopAtFirstThreat:(BOOL)stopAtFirst withError:(NSError * _Nullable * _Nullable)error;
- (NSArray<ThreatInfo *> * _Nullable) scanData:(NSData * _Nonnull)data stopAtFirstThreat:(BOOL)stopAtFirst fileName:(NSString * _Nullable)fileName withError:(NSError * _Nullable * _Nullable)error;
- (NSArray<ThreatInfo *> * _Nullable) scanFileAtPath:(NSString * _Nonnull)filePath stopAtFirstThreat:(BOOL)stopAtFirst withError:(NSError * _Nullable * _Nullable)error;

@end