Always use Scripting Bridge to invoke GUI from CLI

When the CLI command is invoked without any arguments or with some refs,
the CLI command was using a low-level NSAppleEventDescriptor to
communicate with the main GUI process. That behavior was inconsistent
with the behavior for other command-line options, where communication is
done with high-level Scripting Bridge. Moreover, the GUI side was
failing to handle the NSAppleEventDescriptor and thus ignoring command
line arguments passed from CLI (cf. #196).

This commit modifies the code so that CLI and GUI always use Scripting
Bridge to send and receive command-line arguments correctly.

Author: magicant

Classes/GitXScriptingConstants.h

@@ -14,5 +14,7 @@
 #define kGitXCloneDestinationURLKey @"destinationURL"
 #define kGitXCloneIsBareKey @"isBare"
 
+#define kGitXOpenArgumentsStringKey @"openArguments"
+
 #define kGitXFindSearchStringKey @"searchString"
 #define kGitXFindInModeKey @"inMode"

Classes/git/PBGitRepository.h

@@ -140,6 +140,7 @@ static NSString * PBStringFromBranchFilterType(PBGitXBranchFilterType type) {
 - (NSURL*) getIndexURL;
 
 // for the scripting bridge
+- (void)openWithScriptCommand:(NSScriptCommand *)command;
 - (void)findInModeScriptCommand:(NSScriptCommand *)command;
 
 @end

Classes/git/PBGitRepository.m

@@ -943,31 +943,22 @@ - (void)handleRevListArguments:(NSArray *)arguments
 	[self.windowController showHistoryView:self];
 }
 
-- (void)handleBranchFilterEventForFilter:(PBGitXBranchFilterType)filter additionalArguments:(NSMutableArray *)arguments
+- (void)handleBranchFilterEventForFilter:(PBGitXBranchFilterType)filter additionalArguments:(NSArray *)arguments
 {
 	self.currentBranchFilter = filter;
 	[PBGitDefaults setShowStageView:NO];
 	[self.windowController showHistoryView:self];
 
 	// treat any additional arguments as a rev-list specifier
 	if ([arguments count] > 1) {
-		[arguments removeObjectAtIndex:0];
-		[self handleRevListArguments:arguments];
+		NSMutableArray *argumentsButFirst = [arguments mutableCopy];
+		[argumentsButFirst removeObjectAtIndex:0];
+		[self handleRevListArguments:argumentsButFirst];
 	}
 }
 
-- (void)handleGitXScriptingArguments:(NSAppleEventDescriptor *)argumentsList
+- (void)handleGitXScriptingArguments:(NSArray *)arguments
 {
-	NSMutableArray *arguments = [NSMutableArray array];
-	uint argumentsIndex = 1; // AppleEvent list descriptor's are one based
-	while(1) {
-		NSAppleEventDescriptor *arg = [argumentsList descriptorAtIndex:argumentsIndex++];
-		if (arg)
-			[arguments addObject:[arg stringValue]];
-		else
-			break;
-	}
-
 	if (![arguments count])
 		return;
 
@@ -998,32 +989,12 @@ - (void)handleGitXScriptingArguments:(NSAppleEventDescriptor *)argumentsList
 	[self handleRevListArguments:arguments];
 }
 
-// see if the current appleEvent has the command line arguments from the gitx cli
-// this could be from an openApplication or an openDocument apple event
-// when opening a repository this is called before the sidebar controller gets it's awakeFromNib: message
-// if the repository is already open then this is also a good place to catch the event as the window is about to be brought forward
-- (void)showWindows
+// for the scripting bridge
+- (void)openWithScriptCommand:(NSScriptCommand *)command
 {
-	NSAppleEventDescriptor *currentAppleEvent = [[NSAppleEventManager sharedAppleEventManager] currentAppleEvent];
-
-	if (currentAppleEvent) {
-		NSAppleEventDescriptor *eventRecord = [currentAppleEvent paramDescriptorForKeyword:keyAEPropData];
-
-		// on app launch there may be many repositories opening, so double check that this is the right repo
-		NSString *path = [[eventRecord paramDescriptorForKeyword:typeFileURL] stringValue];
-		if (path) {
-			NSURL *workingDirectory = [NSURL URLWithString:path];
-			if ([[GitRepoFinder gitDirForURL:workingDirectory] isEqual:[self fileURL]]) {
-				NSAppleEventDescriptor *argumentsList = [eventRecord paramDescriptorForKeyword:kGitXAEKeyArgumentsList];
-				[self handleGitXScriptingArguments:argumentsList];
-
-				// showWindows may be called more than once during app launch so remove the CLI data after we handle the event
-				[currentAppleEvent removeDescriptorWithKeyword:keyAEPropData];
-			}
-		}
-	}
-
-	[super showWindows];
+	NSDictionary *commandArguments = [command arguments];
+	NSArray *arguments = [commandArguments objectForKey:kGitXOpenArgumentsStringKey];
+	[self handleGitXScriptingArguments:arguments];
 }
 
 // for the scripting bridge

Classes/gitx.m

@@ -145,39 +145,6 @@ void handleDiffWithArguments(NSURL *repositoryURL, NSArray *arguments)
 	exit(0);
 }
 
-void handleOpenRepository(NSURL *repositoryURL, NSMutableArray *arguments)
-{
-	// if there are command line arguments send them to GitX through an Apple Event
-	// the recordDescriptor will be stored in keyAEPropData inside the openDocument or openApplication event
-	NSAppleEventDescriptor *recordDescriptor = nil;
-	if ([arguments count]) {
-		recordDescriptor = [NSAppleEventDescriptor recordDescriptor];
-
-		NSAppleEventDescriptor *listDescriptor = [NSAppleEventDescriptor listDescriptor];
-		uint listIndex = 1; // AppleEvent list descriptor's are one based
-		for (NSString *argument in arguments)
-			[listDescriptor insertDescriptor:[NSAppleEventDescriptor descriptorWithString:argument] atIndex:listIndex++];
-
-		[recordDescriptor setParamDescriptor:listDescriptor forKeyword:kGitXAEKeyArgumentsList];
-
-		// this is used as a double check in GitX
-		NSAppleEventDescriptor *url = [NSAppleEventDescriptor descriptorWithString:[repositoryURL absoluteString]];
-		[recordDescriptor setParamDescriptor:url forKeyword:typeFileURL];
-	}
-
-	// use NSWorkspace to open GitX and send the arguments
-	// this allows the repository document to modify itself before it shows it's GUI
-	BOOL didOpenURLs = [[NSWorkspace sharedWorkspace] openURLs:[NSArray arrayWithObject:repositoryURL]
-									   withAppBundleIdentifier:kGitXBundleIdentifier
-													   options:0
-								additionalEventParamDescriptor:recordDescriptor
-											 launchIdentifiers:NULL];
-	if (!didOpenURLs) {
-		printf("Unable to open GitX.app\n");
-		exit(2);
-	}
-}
-
 void handleInit(NSURL *repositoryURL)
 {
 	GitXApplication *gitXApp = [SBApplication applicationWithBundleIdentifier:kGitXBundleIdentifier];
@@ -253,6 +220,15 @@ PBHistorySearchMode searchModeForCommandLineArgument(NSString *argument)
 	return nil;
 }
 
+void handleOpenRepository(NSURL *repositoryURL, NSMutableArray *arguments)
+{
+	GitXApplication *gitXApp = [SBApplication applicationWithBundleIdentifier:kGitXBundleIdentifier];
+	[gitXApp open:[NSArray arrayWithObject:repositoryURL]];
+
+	GitXDocument *repositoryDocument = documentForURL([gitXApp documents], repositoryURL);
+	[repositoryDocument openArguments:arguments];
+}
+
 void handleGitXSearch(NSURL *repositoryURL, NSMutableArray *arguments)
 {
 	NSString *searchString = [arguments componentsJoinedByString:@" "];

GitX.h

@@ -43,6 +43,7 @@
 - (void) delete;  // Delete an object.
 - (void) duplicateTo:(SBObject *)to withProperties:(NSDictionary *)withProperties;  // Copy an object.
 - (void) moveTo:(SBObject *)to;  // Move an object to a new location.
+- (void) openArguments:(NSArray *)arguments;  // Open a repository and optionally select given refs.
 - (void) searchString:(NSString *)string inMode:(NSInteger)inMode;  // Highlight commits that match the given search string.
 
 @end
@@ -67,6 +68,7 @@
 - (void) delete;  // Delete an object.
 - (void) duplicateTo:(SBObject *)to withProperties:(NSDictionary *)withProperties;  // Copy an object.
 - (void) moveTo:(SBObject *)to;  // Move an object to a new location.
+- (void) openArguments:(NSArray *)arguments;  // Open a repository and optionally select given refs.
 - (void) searchString:(NSString *)string inMode:(NSInteger)inMode;  // Highlight commits that match the given search string.
 
 @end

GitX.sdef

@@ -173,6 +173,14 @@
 			</parameter>
 		</command>
 
+		<command name="open" code="GitXOpen" description="Open a repository and optionally select given refs.">
+			<direct-parameter type="specifier" description="The repository document to open."/>
+			<parameter name="arguments" code="ARGS" description="The arguments">
+				<type type="text" list="yes"/>
+				<cocoa key="openArguments"/>
+			</parameter>
+		</command>
+
 		<command name="search" code="GitXSrch" description="Highlight commits that match the given search string.">
 			<direct-parameter type="specifier" description="The repository document to search."/>
 			<parameter name="string" code="SRCH" type="text" optional="yes" description="The string to search for.">
@@ -197,6 +205,9 @@
 
 		<class-extension extends="document" code="docu" description="A document.">
 			<cocoa class="PBGitRepository"/>
+			<responds-to name="open">
+				<cocoa method="openWithScriptCommand:"/>
+			</responds-to>
 			<responds-to name="search">
 				<cocoa method="findInModeScriptCommand:"/>
 			</responds-to>