//
//  GTDiffFile.h
//  ObjectiveGitFramework
//
//  Created by Danny Greg on 30/11/2012.
//  Copyright (c) 2012 GitHub, Inc. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "git2/diff.h"

/// Flags which may be set on the file.
///
/// GTDiffFileFlagBinaryMask - A mask to just retrieve the binary/not binary
///                            information from a set of flags.
///
/// See diff.h for further documentation.
typedef NS_OPTIONS(NSInteger, GTDiffFileFlag) {
	GTDiffFileFlagValidID = GIT_DIFF_FLAG_VALID_ID,
	GTDiffFileFlagBinary = GIT_DIFF_FLAG_BINARY,
	GTDiffFileFlagNotBinary = GIT_DIFF_FLAG_NOT_BINARY,

	GTDiffFileFlagBinaryMask = GTDiffFileFlagBinary | GTDiffFileFlagNotBinary,
};

@class GTOID;

NS_ASSUME_NONNULL_BEGIN

/// A class representing a file on one side of a diff.
@interface GTDiffFile : NSObject

/// The location within the working directory of the file.
@property (nonatomic, readonly, copy) NSString *path;

/// The size (in bytes) of the file.
@property (nonatomic, readonly) NSUInteger size;

/// Any flags set on the file (see `GTDiffFileFlag` for more info).
@property (nonatomic, readonly) GTDiffFileFlag flags;

/// The mode of the file.
@property (nonatomic, readonly) mode_t mode;

/// The OID for the file.
@property (nonatomic, readonly, copy) GTOID * _Nullable OID;

/// The git_diff_file represented by the receiver.
@property (nonatomic, readonly) git_diff_file git_diff_file;

- (instancetype)init NS_UNAVAILABLE;

/// Initializes the receiver with the provided libgit2 object. Designated initializer.
///
/// file - The git_diff_file wrapped by the receiver.
///
/// Returns an initialized GTDiffFile.
- (instancetype _Nullable)initWithGitDiffFile:(git_diff_file)file NS_DESIGNATED_INITIALIZER;

@end

NS_ASSUME_NONNULL_END