Merge pull request #212 from txchen/master

Make app.launch() faster by introducing an option
kasper · May 13, 2018 · f70f0e0 · f70f0e0
2 parents 55272dc + c5324a9
commit f70f0e0
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/Phoenix/PHApp.h b/Phoenix/PHApp.h
@@ -16,7 +16,7 @@
 #pragma mark - Apps
 
 + (instancetype) get:(NSString *)appName;
-+ (instancetype) launch:(NSString *)appName;
++ (instancetype) launch:(NSString *)appName :(NSDictionary<NSString *, id> *)optionals;
 + (instancetype) focused;
 + (NSArray<PHApp *> *) all;
 

diff --git a/Phoenix/PHApp.m b/Phoenix/PHApp.m
@@ -15,6 +15,7 @@ @interface PHApp ()
 @implementation PHApp
 
 static NSString * const PHAppForceOptionKey = @"force";
+static NSString * const PHAppLaunchFocusOptionKey = @"focus";
 
 #pragma mark - Initialising
 
@@ -41,7 +42,7 @@ + (instancetype) get:(NSString *)appName {
     return nil;
 }
 
-+ (instancetype) launch:(NSString *)appName {
++ (instancetype) launch:(NSString *)appName :(NSDictionary<NSString *, id> *)optionals {
 
     NSWorkspace *sharedWorkspace = [NSWorkspace sharedWorkspace];
     NSString *appPath = [sharedWorkspace fullPathForApplication:appName];
@@ -51,9 +52,16 @@ + (instancetype) launch:(NSString *)appName {
         return nil;
     }
 
+    NSNumber *focusOption = optionals[PHAppLaunchFocusOptionKey];
+
+    NSWorkspaceLaunchOptions launchOption = NSWorkspaceLaunchWithoutActivation;
+    if (focusOption && focusOption.boolValue) {
+        launchOption = NSWorkspaceLaunchDefault;
+    }
+
     NSError *error;
     NSRunningApplication *app = [sharedWorkspace launchApplicationAtURL:[NSURL fileURLWithPath:appPath]
-                                                                options:NSWorkspaceLaunchWithoutActivation
+                                                                options:launchOption
                                                           configuration:@{}
                                                                   error:&error];
     if (error) {

diff --git a/docs/API.md b/docs/API.md
@@ -564,7 +564,7 @@ Use the `App`-object to control apps. Beware that an app can get stale if you ke
 class App implements Identifiable
 
   static App get(String appName)
-  static App launch(String appName)
+  static App launch(String appName, Map<String, AnyObject> optionals)
   static App focused()
   static Array<App> all()
 
@@ -587,7 +587,7 @@ end
 ```
 
 - `get(String appName)` returns the running app with the given name, returns `undefined` if the app is not currently running
-- `launch(String appName)` launches to the background and returns the app with the given name, returns `undefined` if unsuccessful
+- `launch(String appName, Map<String, AnyObject> optionals)` launches and returns the app with the given name, returns `undefined` if unsuccessful
 - `focused()` returns the focused app
 - `all()` returns all running apps
 - `processIdentifier()` returns the process identifier (PID) for the app, returns `-1` if the app does not have a PID
@@ -613,6 +613,10 @@ end
 
 - `force` (boolean): if set `true` force terminates the app
 
+### Launch Optionals
+
+- `focus` (boolean): if set `true`, the launched app will be automatically focused. You don't need to call app.focus() to bring it forward.
+
 ## 21. Window
 
 Use the `Window`-object to control windows. Every screen (i.e. display) combines to form a large rectangle. Every window lives within this rectangle and their position can be altered by giving coordinates inside this rectangle. To position a window to a specific display, you need to calculate its position within the large rectangle. To figure out the coordinates for a given screen, use the functions in `Screen`. Beware that a window can get stale if you keep a reference to it and it is for instance closed while you do so.