PBGitIndex.h

   1 //
   2 //  PBGitIndex.h
   3 //  GitX
   4 //
   5 //  Created by Pieter de Bie on 9/12/09.
   6 //  Copyright 2009 Pieter de Bie. All rights reserved.
   7 //
   8
   9 #import <Cocoa/Cocoa.h>
  10
  11 @class PBGitRepository;
  12 @class PBChangedFile;
  13
  14 /*
  15  * Notifications this class will send
  16  */
  17
  18 // Refreshing index
  19 extern NSString *PBGitIndexIndexRefreshStatus;
  20 extern NSString *PBGitIndexIndexRefreshFailed;
  21 extern NSString *PBGitIndexFinishedIndexRefresh;
  22
  23 // The "indexChanges" array has changed
  24 extern NSString *PBGitIndexIndexUpdated;
  25
  26 // Committing files
  27 extern NSString *PBGitIndexCommitStatus;
  28 extern NSString *PBGitIndexCommitFailed;
  29 extern NSString *PBGitIndexFinishedCommit;
  30
  31 // Changing to amend
  32 extern NSString *PBGitIndexAmendMessageAvailable;
  33
  34 // This is for general operations, like applying a patch
  35 extern NSString *PBGitIndexOperationFailed;
  36
  37
  38
  39 // Represents a git index for a given work tree.
  40 // As a single git repository can have multiple trees,
  41 // the tree has to be given explicitly, even though
  42 // multiple trees is not yet supported in GitX
  43 @interface PBGitIndex : NSObject {
  44
  45 @private
  46         PBGitRepository *repository;
  47         NSURL *workingDirectory;
  48         NSMutableArray *files;
  49
  50         NSUInteger refreshStatus;
  51         NSDictionary *amendEnvironment;
  52         BOOL amend;
  53 }
  54
  55 // Whether we want the changes for amending,
  56 // or for
  57 @property BOOL amend;
  58
  59 - (id)initWithRepository:(PBGitRepository *)repository workingDirectory:(NSURL *)workingDirectory;
  60
  61 // A list of PBChangedFile's with differences between the work tree and the index
  62 // This method is KVO-aware, so changes when any of the index-modifying methods are called
  63 // (including -refresh)
  64 - (NSArray *)indexChanges;
  65
  66 // Refresh the index
  67 - (void)refresh;
  68
  69 - (void)commitWithMessage:(NSString *)commitMessage;
  70
  71 // Inter-file changes:
  72 - (BOOL)stageFiles:(NSArray *)stageFiles;
  73 - (BOOL)unstageFiles:(NSArray *)unstageFiles;
  74 - (void)discardChangesForFiles:(NSArray *)discardFiles;
  75
  76 // Intra-file changes
  77 - (BOOL)applyPatch:(NSString *)hunk stage:(BOOL)stage reverse:(BOOL)reverse;
  78 - (NSString *)diffForFile:(PBChangedFile *)file staged:(BOOL)staged contextLines:(NSUInteger)context;
  79
  80 @end