implement device orientation

CompanionLib/FBIDBCommandExecutor.h

@@ -198,6 +198,13 @@ extern FBFileContainerKind const FBFileContainerKindFramework;
  */
 - (FBFuture<NSNull *> *)hid:(FBSimulatorHIDEvent *)event;
 
+/**
+ Set the device orientation
+
+ @return null future
+ */
+- (FBFuture<NSNull *> *)set_device_orientation:(FBSimulatorDeviceOrientation)deviceOrientation;
+
 /**
  Sets latitude and longitude of the Simulator.
  The behaviour of a directly-launched Simulator differs from Simulator.app slightly, in that the location isn't automatically set.

CompanionLib/FBIDBCommandExecutor.m

@@ -163,6 +163,17 @@ - (instancetype)initWithTarget:(id<FBiOSTarget>)target storageManager:(FBIDBStor
     }];
 }
 
+- (FBFuture<NSNull *> *)set_device_orientation:(FBSimulatorDeviceOrientation)deviceOrientation
+{
+  id<FBDeviceOrientationCommands> commands = (id<FBDeviceOrientationCommands>) self.target;
+  if (![commands conformsToProtocol:@protocol(FBDeviceOrientationCommands)]) {
+    return [[FBIDBError
+      describeFormat:@"%@ does not conform to FBDeviceOrientationCommands", commands]
+      failFuture];
+  }
+  return [commands setDeviceOrientation:deviceOrientation];
+}
+
 - (FBFuture<NSNull *> *)set_location:(double)latitude longitude:(double)longitude
 {
   id<FBLocationCommands> commands = (id<FBLocationCommands>) self.target;

FBControlCore/Commands/FBDeviceOrientationCommands.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef NS_ENUM(unsigned int, FBSimulatorDeviceOrientation) {
+  FBSimulatorDeviceOrientationPortrait = 1,
+  FBSimulatorDeviceOrientationPortraitUpsideDown = 2,
+  FBSimulatorDeviceOrientationLandscapeLeft = 3,
+  FBSimulatorDeviceOrientationLandscapeRight = 4
+};
+
+
+/**
+ Commands to change the device orientation
+ */
+@protocol FBDeviceOrientationCommands <NSObject, FBiOSTargetCommand>
+
+/**
+ Sets the device orientation
+
+ @return A future that when the orientation change has been dispatched
+ */
+- (FBFuture<NSNull*> *)setDeviceOrientation:(FBSimulatorDeviceOrientation)deviceOrientation;
+
+@end
+
+NS_ASSUME_NONNULL_END
+

FBControlCore/FBControlCore.h

@@ -95,3 +95,4 @@
 #import <FBControlCore/FBConcatedJsonParser.h>
 #import <FBControlCore/FBCrashLogParser.h>
 #import <FBControlCore/FBArchitectureProcessAdapter.h>
+#import <FBControlCore/FBDeviceOrientationCommands.h>

FBSimulatorControl.xcodeproj/project.pbxproj

@@ -49,6 +49,10 @@
 		A2FD7D0E2739922400542291 /* FBSimulatorMemoryCommands.h in Headers */ = {isa = PBXBuildFile; fileRef = A2FD7D0C2739922400542291 /* FBSimulatorMemoryCommands.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		A2FD7D11273992A400542291 /* FBSimulatorNotificationCommands.h in Headers */ = {isa = PBXBuildFile; fileRef = A2FD7D0F273992A400542291 /* FBSimulatorNotificationCommands.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		A2FD7D12273992A400542291 /* FBSimulatorNotificationCommands.m in Sources */ = {isa = PBXBuildFile; fileRef = A2FD7D10273992A400542291 /* FBSimulatorNotificationCommands.m */; };
+		A6F73D2D2E0ED14E00AAE67E /* FBDeviceOrientationCommands.h in Headers */ = {isa = PBXBuildFile; fileRef = A6F73D2C2E0ED14E00AAE67E /* FBDeviceOrientationCommands.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		A6F73D2F2E0ED97E00AAE67E /* FBSimulatorDeviceOrientationCommands.h in Headers */ = {isa = PBXBuildFile; fileRef = A6F73D2E2E0ED97E00AAE67E /* FBSimulatorDeviceOrientationCommands.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		A6F73D312E0ED9DE00AAE67E /* FBSimulatorDeviceOrientationCommands.m in Sources */ = {isa = PBXBuildFile; fileRef = A6F73D302E0ED9DE00AAE67E /* FBSimulatorDeviceOrientationCommands.m */; };
+		A6F73D332E0EEC8200AAE67E /* SimDevice+GSEventsPrivate.m in Sources */ = {isa = PBXBuildFile; fileRef = A6F73D322E0EEC8200AAE67E /* SimDevice+GSEventsPrivate.m */; };
 		AA0080D71DB4CCFD009A25CB /* FBProcessTerminationStrategy.h in Headers */ = {isa = PBXBuildFile; fileRef = AA0080D51DB4CCFD009A25CB /* FBProcessTerminationStrategy.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		AA0080D81DB4CCFD009A25CB /* FBProcessTerminationStrategy.m in Sources */ = {isa = PBXBuildFile; fileRef = AA0080D61DB4CCFD009A25CB /* FBProcessTerminationStrategy.m */; };
 		AA07B3451D531FEA007FB614 /* FBSimulatorInflationStrategy.h in Headers */ = {isa = PBXBuildFile; fileRef = AA07B3431D531FEA007FB614 /* FBSimulatorInflationStrategy.h */; };
@@ -777,6 +781,11 @@
 		A2FD7D0C2739922400542291 /* FBSimulatorMemoryCommands.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = FBSimulatorMemoryCommands.h; sourceTree = "<group>"; };
 		A2FD7D0F273992A400542291 /* FBSimulatorNotificationCommands.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = FBSimulatorNotificationCommands.h; sourceTree = "<group>"; };
 		A2FD7D10273992A400542291 /* FBSimulatorNotificationCommands.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FBSimulatorNotificationCommands.m; sourceTree = "<group>"; };
+		A66FF9F42DF88FC5002A30D3 /* SimDevice+GSEventsPrivate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "SimDevice+GSEventsPrivate.h"; sourceTree = "<group>"; };
+		A6F73D2C2E0ED14E00AAE67E /* FBDeviceOrientationCommands.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = FBDeviceOrientationCommands.h; sourceTree = "<group>"; };
+		A6F73D2E2E0ED97E00AAE67E /* FBSimulatorDeviceOrientationCommands.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = FBSimulatorDeviceOrientationCommands.h; sourceTree = "<group>"; };
+		A6F73D302E0ED9DE00AAE67E /* FBSimulatorDeviceOrientationCommands.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = FBSimulatorDeviceOrientationCommands.m; sourceTree = "<group>"; };
+		A6F73D322E0EEC8200AAE67E /* SimDevice+GSEventsPrivate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "SimDevice+GSEventsPrivate.m"; sourceTree = "<group>"; };
 		AA0080D51DB4CCFD009A25CB /* FBProcessTerminationStrategy.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = FBProcessTerminationStrategy.h; sourceTree = "<group>"; };
 		AA0080D61DB4CCFD009A25CB /* FBProcessTerminationStrategy.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FBProcessTerminationStrategy.m; sourceTree = "<group>"; };
 		AA017F4C1BD7784700F45E9D /* libShimulator.dylib */ = {isa = PBXFileReference; lastKnownFileType = "compiled.mach-o.dylib"; path = libShimulator.dylib; sourceTree = "<group>"; };
@@ -1588,6 +1597,7 @@
 				A2FD7D032739887200542291 /* FBDapServerCommands.h */,
 				AA2E38E021E626B10065C800 /* FBDebuggerCommands.h */,
 				AA685CD22550299200E2DD9D /* FBDeveloperDiskImageCommands.h */,
+				A6F73D2C2E0ED14E00AAE67E /* FBDeviceOrientationCommands.h */,
 				AA8D347124D04BD0000FAC59 /* FBDiagnosticInformationCommands.h */,
 				AA59F46424912730007C1875 /* FBEraseCommands.h */,
 				AA98266924E1348C006E05A9 /* FBFileCommands.h */,
@@ -1633,6 +1643,8 @@
 				AAB475F620C8217F00B37634 /* FBSimulatorCrashLogCommands.m */,
 				AA8ECA892254F301007925E6 /* FBSimulatorDebuggerCommands.h */,
 				AA8ECA8A2254F301007925E6 /* FBSimulatorDebuggerCommands.m */,
+				A6F73D2E2E0ED97E00AAE67E /* FBSimulatorDeviceOrientationCommands.h */,
+				A6F73D302E0ED9DE00AAE67E /* FBSimulatorDeviceOrientationCommands.m */,
 				AA3EA8511F31B20D003FBDC1 /* FBSimulatorFileCommands.h */,
 				AA3EA8521F31B20D003FBDC1 /* FBSimulatorFileCommands.m */,
 				AA56445C1E5F6ED0006C1077 /* FBSimulatorKeychainCommands.h */,
@@ -1809,6 +1821,8 @@
 				AA386D251E44F04F005C6118 /* NSString-SimServiceContextExtras.h */,
 				AA386D261E44F04F005C6118 /* NSUserDefaults-SimDefaults.h */,
 				AA386D271E44F04F005C6118 /* SimDevice.h */,
+				A66FF9F42DF88FC5002A30D3 /* SimDevice+GSEventsPrivate.h */,
+				A6F73D322E0EEC8200AAE67E /* SimDevice+GSEventsPrivate.m */,
 				AA386D281E44F04F005C6118 /* SimDevice+Removed.h */,
 				AA386D291E44F04F005C6118 /* SimDeviceBootInfo.h */,
 				AA386D2A1E44F04F005C6118 /* SimDeviceIO.h */,
@@ -2945,6 +2959,7 @@
 				AA9517811C15F54600A89CAD /* FBSimulatorControl+PrincipalClass.h in Headers */,
 				AA95177E1C15F54600A89CAD /* FBSimulator+Private.h in Headers */,
 				AAE90BC21D2A4578004EE9E5 /* FBSimulatorControlFrameworkLoader.h in Headers */,
+				A6F73D2F2E0ED97E00AAE67E /* FBSimulatorDeviceOrientationCommands.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -3024,6 +3039,7 @@
 				EEBD607E1C9062E900298A07 /* FBControlCoreError.h in Headers */,
 				AA685CD32550299200E2DD9D /* FBDeveloperDiskImageCommands.h in Headers */,
 				AA5B3DD61FE3134D00B77376 /* FBScreenshotCommands.h in Headers */,
+				A6F73D2D2E0ED14E00AAE67E /* FBDeviceOrientationCommands.h in Headers */,
 				AABBF3231DAC110000E2B6AF /* FBProcessBuilder.h in Headers */,
 				AA805F7F1F0D0E0000AB31DE /* FBLogCommands.h in Headers */,
 				A2FD7D042739887200542291 /* FBDapServerCommands.h in Headers */,
@@ -3444,6 +3460,7 @@
 				AA9517521C15F54600A89CAD /* FBSimulatorConfiguration.m in Sources */,
 				AA9517541C15F54600A89CAD /* FBSimulatorControlConfiguration.m in Sources */,
 				AA1B5D921CF6DD800073A203 /* FBSimulatorDeletionStrategy.m in Sources */,
+				A6F73D312E0ED9DE00AAE67E /* FBSimulatorDeviceOrientationCommands.m in Sources */,
 				AA6F824821639857007AAF19 /* FBAppleSimctlCommandExecutor.m in Sources */,
 				AAAB13291C74EC0300F3B083 /* FBSimulatorSet.m in Sources */,
 				A2FD7D012739885300542291 /* FBSimulatorDapServerCommands.m in Sources */,
@@ -3484,6 +3501,7 @@
 				A2FD7D12273992A400542291 /* FBSimulatorNotificationCommands.m in Sources */,
 				AA6A3B401CC1597000E016C4 /* FBSimulatorBootStrategy.m in Sources */,
 				AAF7B0DA1DDB1CD60079ED11 /* FBSimulatorShutdownStrategy.m in Sources */,
+				A6F73D332E0EEC8200AAE67E /* SimDevice+GSEventsPrivate.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

FBSimulatorControl/Commands/FBSimulatorDeviceOrientationCommands.h

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <FBControlCore/FBControlCore.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ An Implementation of FBSimulatorAccessibilityCommands.
+ */
+@interface FBSimulatorDeviceOrientationCommands : NSObject <FBDeviceOrientationCommands>
+
+@end
+
+NS_ASSUME_NONNULL_END

FBSimulatorControl/Commands/FBSimulatorDeviceOrientationCommands.m

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <CoreSimulator/SimDevice.h>
+
+#import "FBSimulatorDeviceOrientationCommands.h"
+
+#import "FBSimulator.h"
+#import "SimulatorApp/Purple.h"
+#import "CoreSimulator/SimDevice+GSEventsPrivate.h"
+
+@interface FBSimulatorDeviceOrientationCommands ()
+
+@property (nonatomic, weak, readonly) FBSimulator *simulator;
+
+@end
+
+@implementation FBSimulatorDeviceOrientationCommands
+
+#pragma mark Initializers
+
++ (nonnull instancetype)commandsWithTarget:(FBSimulator *)target
+{
+  return [[self alloc] initWithSimulator:target];
+}
+
+- (instancetype)initWithSimulator:(FBSimulator *)simulator
+{
+  self = [super init];
+  if (!self) {
+    return nil;
+  }
+
+  _simulator = simulator;
+
+  return self;
+}
+
+- (nonnull FBFuture<NSNull *> *)setDeviceOrientation:(FBSimulatorDeviceOrientation)deviceOrientation
+{
+  PurpleMessage *purpleMessage = malloc(sizeof(PurpleMessage));
+  memset(purpleMessage, 0, sizeof(PurpleMessage));
+  purpleMessage->header.msgh_bits = MACH_MSGH_BITS(MACH_MSG_TYPE_COPY_SEND, 0);
+  purpleMessage->header.msgh_size = sizeof(PurpleMessage);
+  purpleMessage->header.msgh_id = 0x7b;
+  purpleMessage->message.field1 = 0x20032;
+  purpleMessage->message.field9 = 0x4;
+  purpleMessage->message.field10 = (unsigned int)deviceOrientation;
+  return sendPurpleMessage(self.simulator.device, purpleMessage);
+}
+
+@end

FBSimulatorControl/Management/FBSimulator.h

@@ -17,6 +17,7 @@
 #import <FBSimulatorControl/FBSimulatorMemoryCommands.h>
 #import <FBSimulatorControl/FBSimulatorSettingsCommands.h>
 #import <FBSimulatorControl/FBSimulatorNotificationCommands.h>
+#import <FBSimulatorControl/FBSimulatorDeviceOrientationCommands.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -31,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  An implementation of FBiOSTarget for iOS Simulators.
  */
-@interface FBSimulator : NSObject <FBiOSTarget, FBAccessibilityCommands, FBMemoryCommands, FBFileCommands, FBLocationCommands, FBNotificationCommands, FBProcessSpawnCommands, FBSimulatorKeychainCommands, FBSimulatorSettingsCommands, FBSimulatorLifecycleCommands, FBSimulatorLaunchCtlCommands, FBSimulatorMediaCommands, FBXCTestExtendedCommands, FBDapServerCommand, FBSimulatorAccessibilityOperations>
+@interface FBSimulator : NSObject <FBiOSTarget, FBAccessibilityCommands, FBMemoryCommands, FBFileCommands, FBLocationCommands, FBNotificationCommands, FBProcessSpawnCommands, FBSimulatorKeychainCommands, FBSimulatorSettingsCommands, FBSimulatorLifecycleCommands, FBSimulatorLaunchCtlCommands, FBSimulatorMediaCommands, FBXCTestExtendedCommands, FBDapServerCommand, FBSimulatorAccessibilityOperations, FBDeviceOrientationCommands>
 
 #pragma mark Properties
 

FBSimulatorControl/Management/FBSimulator.m

@@ -40,6 +40,7 @@
 #import "FBSimulatorSettingsCommands.h"
 #import "FBSimulatorVideoRecordingCommands.h"
 #import "FBSimulatorXCTestCommands.h"
+#import "FBSimulatorDeviceOrientationCommands.h"
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wprotocol"
@@ -311,6 +312,7 @@ - (void)forwardInvocation:(NSInvocation *)invocation
       FBXCTraceRecordCommands.class,
       FBSimulatorNotificationCommands.class,
       FBSimulatorMemoryCommands.class,
+      FBSimulatorDeviceOrientationCommands.class
     ];
   });
   return commandClasses;

PrivateHeaders/CoreSimulator/SimDevice+GSEventsPrivate.h

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <CoreSimulator/SimDevice.h>
+#import <SimulatorApp/Purple.h>
+#import <FBControlCore/FBFuture.h>
+
+#import <Foundation/Foundation.h>
+
+@interface SimDevice (GSEventsPrivate)
+- (NSMachPort*)gsEventsPort;
+- (dispatch_queue_t)gsEventsQueue;
+- (void)sendPurpleMessage:(PurpleMessage*)purpleMessage;
+@end
+
+FBFuture<NSNull *> *sendPurpleMessage(SimDevice *self, PurpleMessage *purpleMessage);

PrivateHeaders/CoreSimulator/SimDevice+GSEventsPrivate.m

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "SimDevice+GSEventsPrivate.h"
+
+#import <FBControlCore/FBControlCore.h>
+
+#import <objc/runtime.h>
+
+NSMachPort *gsEventsPort(SimDevice* self, SEL _cmd);
+dispatch_queue_t gsEventsQueue(SimDevice *self, SEL _cmd);
+
+NSMachPort *gsEventsPort(SimDevice* self, SEL _cmd)
+{
+  NSMachPort *gsEventsPort = objc_getAssociatedObject(self, _cmd);
+  if (gsEventsPort.isValid) {
+    return gsEventsPort;
+  }
+
+  NSError *error;
+  mach_port_name_t purpleWorkspacePort = [self lookup:@"PurpleWorkspacePort" error:&error];
+  gsEventsPort = (NSMachPort*)[NSMachPort portWithMachPort:purpleWorkspacePort options:NSMachPortDeallocateSendRight];
+  if (!gsEventsPort) {
+    mach_port_deallocate(mach_task_self(), purpleWorkspacePort);
+    return nil;
+  }
+
+  objc_setAssociatedObject(self, _cmd, gsEventsPort, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+  return gsEventsPort;
+}
+
+dispatch_queue_t gsEventsQueue(SimDevice *self, SEL _cmd)
+{
+  dispatch_queue_t gsEventsQueue = objc_getAssociatedObject(self, _cmd);
+  if (gsEventsQueue) {
+    return gsEventsQueue;
+  }
+
+  @synchronized (self) {
+    gsEventsQueue = objc_getAssociatedObject(self, _cmd);
+    if (gsEventsQueue) {
+      return gsEventsQueue;
+    }
+
+    gsEventsQueue =  dispatch_queue_create("com.apple.iphonesimulator.SimDeviceSimulatorBridge.gsEventsQueue", DISPATCH_QUEUE_SERIAL);
+    if (!gsEventsQueue) {
+      return nil;
+    }
+
+    objc_setAssociatedObject(self, _cmd, gsEventsQueue, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+    return gsEventsQueue;
+  }
+}
+
+FBFuture<NSNull *> *sendPurpleMessage(SimDevice *self, PurpleMessage *purpleMessage)
+{
+  return [FBFuture onQueue:gsEventsQueue(self, @selector(gsEventsQueue)) resolve:^FBFuture *{
+    if (!MACH_PORT_VALID(purpleMessage->header.msgh_remote_port)) {
+      NSMachPort *port = gsEventsPort(self, @selector(gsEventsPort));
+      purpleMessage->header.msgh_remote_port = [port machPort];
+    }
+    mach_msg_return_t result = mach_msg_send((mach_msg_header_t*)&purpleMessage->header);
+    free(purpleMessage);
+    if (result != MACH_MSG_SUCCESS) {
+      return [[FBControlCoreError
+        describeFormat:@"Could not send purple message, mach_msg_send() failed with %0x08x", result]
+        failFuture];
+    }
+    return FBFuture.empty;
+  }];
+}