simtap 0.0.0-stage → 0.6.1

package/vendor/axe/Frameworks/FBControlCore.framework/Versions/A/Headers/FBProcessIO.h

@@ -0,0 +1,126 @@
+/*
+ * 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/FBProcessStream.h>
+
+/**
+ A result of "attaching" to an IO object, realized as file descriptors.
+ */
+@interface FBProcessIOAttachment : NSObject
+
+#pragma mark Properties
+
+/**
+ The attachment for stdin.
+ */
+@property (nullable, nonatomic, readonly, strong) FBProcessStreamAttachment *stdIn;
+
+/**
+ The attachment for stdout.
+ */
+@property (nullable, nonatomic, readonly, strong) FBProcessStreamAttachment *stdOut;
+
+/**
+ The attachment for stderr.
+ */
+@property (nullable, nonatomic, readonly, strong) FBProcessStreamAttachment *stdErr;
+
+/**
+ Detach from all the streams.
+ This may be called multiple times, the underlying streams will only detach once per instance.
+ */
+- (nonnull FBFuture<NSNull *> *)detach;
+
+@end
+
+/**
+ A result of "attaching" to an IO object, realized as file paths.
+ */
+@interface FBProcessFileAttachment : NSObject
+
+/**
+ The attachment for stdout.
+ */
+@property (nullable, nonatomic, readonly, strong) id<FBProcessFileOutput> stdOut;
+
+/**
+ The attachment for stderr.
+ */
+@property (nullable, nonatomic, readonly, strong) id<FBProcessFileOutput> stdErr;
+
+/**
+ Detach from all the streams.
+ This may be called multiple times, the underlying streams will only detach once per instance.
+ */
+- (nonnull FBFuture<NSNull *> *)detach;
+
+@end
+
+/**
+ A composite of streams for the stdin, stdout and stderr streams connected to a process.
+ */
+@interface FBProcessIO <StdInType : id, StdOutType : id, StdErrType : id> : NSObject
+
+#pragma mark Initializers
+
+/**
+ The Designated Initializer.
+
+ @param stdIn the stdin.
+ @param stdOut the stdout.
+ @param stdErr the stderr.
+ @return a new FBProcessIO instance.
+ */
+- (nonnull instancetype)initWithStdIn:(nullable FBProcessInput<StdInType> *)stdIn stdOut:(nullable FBProcessOutput<StdOutType> *)stdOut stdErr:(nullable FBProcessOutput<StdErrType> *)stdErr;
+
+/**
+ An IO object that accepts no input and returns no output.
+ */
++ (nonnull instancetype)outputToDevNull;
+
+#pragma mark Properties
+
+/**
+ The FBProcessInput for stdin.
+ */
+@property (nullable, nonatomic, readonly, strong) FBProcessInput<StdInType> *stdIn;
+
+/**
+The FBProcessOutput for stdout.
+ */
+@property (nullable, nonatomic, readonly, strong) FBProcessOutput<StdOutType> *stdOut;
+
+/**
+ The FBProcessOutput for stderr.
+ */
+@property (nullable, nonatomic, readonly, strong) FBProcessOutput<StdErrType> *stdErr;
+
+/**
+ The queue to use.
+ */
+@property (nonnull, nonatomic, readonly, strong) dispatch_queue_t queue;
+
+#pragma mark Methods
+
+/**
+ Attach to all the streams, returning the composite attachment for file descriptors.
+ Will error if any of the stream attachments error.
+ If any of the stream attachments error, then any succeeding attachments will detach.
+ This should only be called once. Calling attach more than once per instance will fail.
+ */
+- (nonnull FBFuture<FBProcessIOAttachment *> *)attach;
+
+/**
+ Attach to all the streams, returning the composite attachment for file paths.
+ Will error if any of the stream attachments error.
+ If any of the stream attachments error, then any succeeding attachments will detach.
+ */
+- (nonnull FBFuture<FBProcessFileAttachment *> *)attachViaFile;
+
+@end

package/vendor/axe/Frameworks/FBControlCore.framework/Versions/A/Headers/FBProcessStream.h

@@ -0,0 +1,175 @@
+/*
+ * 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/FBDataConsumer.h>
+#import <FBControlCore/FBFuture.h>
+
+typedef NS_ENUM(NSUInteger, FBProcessStreamAttachmentMode) {
+  FBProcessStreamAttachmentModeInput = 0,
+  FBProcessStreamAttachmentModeOutput = 1,
+};
+
+/**
+ An attached standard stream object.
+ */
+@interface FBProcessStreamAttachment : NSObject
+
+/**
+ The file descriptor to attach to.
+ */
+@property (nonatomic, readonly, assign) int fileDescriptor;
+
+/**
+ Whether the implementor should close when it reaches the end of its stream.
+ */
+@property (nonatomic, readonly, assign) BOOL closeOnEndOfFile;
+
+/**
+ Whether the attachment represents an input or an output.
+ */
+@property (nonatomic, readonly, assign) FBProcessStreamAttachmentMode mode;
+
+/**
+ Checks fileDescriptor status and closes it if necessary;
+ */
+- (void)close;
+
+@end
+
+@protocol FBStandardStream;
+@protocol FBStandardStreamTransfer;
+@protocol FBProcessFileOutput;
+@protocol FBProcessOutput;
+
+/**
+ A container object for the output of a process.
+ */
+@interface FBProcessOutput <WrappedType> : NSObject
+
+#pragma mark Initializers
+
+/**
+ An Output Container for /dev/nul
+
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<NSNull *> *)outputForNullDevice;
+
+/**
+ An Output Container for a File Path.
+
+ @param filePath the File Path to write to, may not be nil.
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<NSString *> *)outputForFilePath:(nonnull NSString *)filePath;
+
+/**
+ An Output Container for an Input Stream
+
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<NSInputStream *> *)outputToInputStream;
+
+/**
+ An Output Container that passes to both a data consumer and a logger.
+
+ @param dataConsumer the file consumer to write to.
+ @param logger the logger to log to.
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<id<FBDataConsumer>> *)outputForDataConsumer:(nonnull id<FBDataConsumer>)dataConsumer logger:(nonnull id<FBControlCoreLogger>)logger;
+
+/**
+ An Output Container that passes to Data Consumer.
+
+ @param dataConsumer the data consumer to write to.
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<id<FBDataConsumer>> *)outputForDataConsumer:(nonnull id<FBDataConsumer>)dataConsumer;
+
+/**
+ An Output Container that writes to a logger
+
+ @param logger the logger to log to.
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<id<FBControlCoreLogger>> *)outputForLogger:(nonnull id<FBControlCoreLogger>)logger;
+
+/**
+ An Output Container that accumulates data in memory
+
+ @param data the mutable data to append to.
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<NSMutableData *> *)outputToMutableData:(nonnull NSMutableData *)data;
+
+/**
+ An Output Container that accumulates data in memory, exposing it as a string.
+
+ @param data the mutable data to append to.
+ @return a Process Output instance.
+ */
++ (nonnull FBProcessOutput<NSString *> *)outputToStringBackedByMutableData:(nonnull NSMutableData *)data;
+
+#pragma mark Properties
+
+/**
+ The wrapped contents of the stream.
+ */
+@property (nonnull, nonatomic, readonly, strong) WrappedType contents;
+
+- (nonnull FBFuture<FBProcessStreamAttachment *> *)attach;
+- (nonnull FBFuture<NSNull *> *)detach;
+- (nonnull FBFuture<id<FBProcessFileOutput>> *)providedThroughFile;
+- (nonnull FBFuture<id<FBDataConsumer>> *)providedThroughConsumer;
+
+@end
+
+/**
+ A container object for the input of a process.
+ */
+@interface FBProcessInput <WrappedType> : NSObject
+
+#pragma mark Initializers
+
+/**
+ An input container that provides a data consumer.
+ The 'contents' field will contain an opaque consumer that can be written to externally.
+
+ @return a FBProcessInput instance wrapping a data consumer.
+ */
++ (nonnull FBProcessInput<id<FBDataConsumer>> *)inputFromConsumer;
+
+/**
+ An input container that provides an NSOutputStream.
+ The 'contents' field will contain an NSOutputStream that can be written to.
+
+ @return a FBProcessInput instance wrapping an NSOutputStream.
+ */
++ (nonnull FBProcessInput<NSOutputStream *> *)inputFromStream;
+
+/**
+ An Input container that connects data to the input.
+
+ @param data the data to send.
+ @return a Process Input instance.
+ */
++ (nonnull FBProcessInput<NSData *> *)inputFromData:(nonnull NSData *)data;
+
+#pragma mark Properties
+
+/**
+ The wrapped contents of the stream.
+ */
+@property (nonnull, nonatomic, readonly, strong) WrappedType contents;
+
+- (nonnull FBFuture<FBProcessStreamAttachment *> *)attach;
+- (nonnull FBFuture<NSNull *> *)detach;
+
+@end

package/vendor/axe/Frameworks/FBControlCore.framework/Versions/A/Headers/FBProcessTerminationStrategy.h

@@ -0,0 +1,25 @@
+/*
+ * 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>
+
+/**
+ An Option Set for Process Termination.
+ */
+typedef NS_ENUM(NSUInteger, FBProcessTerminationStrategyOptions) {
+  FBProcessTerminationStrategyOptionsCheckProcessExistsBeforeSignal = 1 << 2, /** Checks for the process to exist before signalling **/
+  FBProcessTerminationStrategyOptionsCheckDeathAfterSignal = 1 << 3, /** Waits for the process to die before returning **/
+  FBProcessTerminationStrategyOptionsBackoffToSIGKILL = 1 << 4, /** Whether to backoff to SIGKILL if a less severe signal fails **/
+};
+
+/**
+ A Configuration for the Strategy.
+ */
+typedef struct {
+  int signo;
+  FBProcessTerminationStrategyOptions options;
+} FBProcessTerminationStrategyConfiguration;

package/vendor/axe/Frameworks/FBControlCore.framework/Versions/A/Headers/FBScreenshotCommands.h

@@ -0,0 +1,15 @@
+/*
+ * 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>
+
+/**
+ An enum for Screenshot Formats.
+ */
+typedef NSString *FBScreenshotFormat NS_STRING_ENUM;
+extern FBScreenshotFormat _Nonnull const FBScreenshotFormatJPEG NS_SWIFT_NAME(jpeg);
+extern FBScreenshotFormat _Nonnull const FBScreenshotFormatPNG NS_SWIFT_NAME(png);

package/vendor/axe/Frameworks/FBControlCore.framework/Versions/A/Headers/FBSettingsCommands.h

@@ -0,0 +1,22 @@
+/*
+ * 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>
+
+/**
+ An Enumeration Representing Services.
+ */
+typedef NSString *FBTargetSettingsService NS_STRING_ENUM;
+
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServiceContacts;
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServicePhotos;
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServiceCamera;
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServiceLocation;
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServiceMicrophone;
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServiceUrl;
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServiceNotification;
+extern FBTargetSettingsService _Nonnull const FBTargetSettingsServiceHealth;

package/vendor/axe/Frameworks/FBControlCore.framework/Versions/A/Headers/FBSocketServer.h

@@ -0,0 +1,63 @@
+/*
+ * 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 <netinet/in.h>
+#import <sys/socket.h>
+
+#import <Foundation/Foundation.h>
+
+#import <FBControlCore/FBFuture.h>
+
+@protocol FBSocketServerDelegate;
+
+/**
+ A Generic Socket Server.
+ */
+@interface FBSocketServer : NSObject
+
+#pragma mark Initializers
+
+/**
+ Creates and returns a socket reader for the provided port and consumer.
+
+ @param port the port to bind against.
+ @param delegate the delegate to use.
+ @return a new socket reader.
+ */
++ (nonnull instancetype)socketServerOnPort:(in_port_t)port delegate:(nonnull id<FBSocketServerDelegate>)delegate;
+
+#pragma mark Properties
+
+/**
+ The Port the Server is Bound on
+ */
+@property (nonatomic, readonly, assign) in_port_t port;
+
+#pragma mark Public Methods
+
+/**
+ Create and Listen to the socket.
+
+ @return A future that resolves when listening has started.
+ */
+- (nonnull FBFuture<NSNull *> *)startListening;
+
+/**
+ Stop listening to the socket
+
+ @return A future that resolves when listening has ended.
+ */
+- (nonnull FBFuture<NSNull *> *)stopListening;
+
+/**
+ Starts the socket server, managed by a context manager
+
+ @return a FBFutureContext that will stop listening when the context is torn down.
+ */
+- (nonnull FBFutureContext<NSNull *> *)startListeningContext;
+
+@end

package/vendor/axe/Frameworks/FBControlCore.framework/Versions/A/Headers/FBSubprocess.h

@@ -0,0 +1,131 @@
+/*
+ * 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/FBFuture.h>
+#import <FBControlCore/FBiOSTargetOperation.h>
+
+static const size_t FBProcessOutputErrorMessageLength = 200;
+
+@class FBProcessSpawnConfiguration;
+
+/**
+ A representation of a process that has been launched.
+ */
+@interface FBSubprocess <StdInType : id, StdOutType : id, StdErrType : id> : NSObject
+
+#pragma mark Properties
+
+/**
+ The Process Idenfifer of the Launched Process.
+ */
+@property (nonatomic, readonly, assign) pid_t processIdentifier;
+
+/**
+ A future that resolves with the the value from waitpid(2) on termination.
+ This will always resolve on completion, regardless of whether the process was signalled or exited normally.
+ Cancelling this Future will have no effect. To terminate the process use the `sendSignal:` APIs.
+ */
+@property (nonnull, nonatomic, readonly, strong) FBFuture<NSNumber *> *statLoc;
+
+/**
+ A future that resolves with the exit code upon termination.
+ If the process exited abnormally then this future will error.
+ Cancelling this Future will have no effect. To terminate the process use the `sendSignal:` APIs.
+ */
+@property (nonnull, nonatomic, readonly, strong) FBFuture<NSNumber *> *exitCode;
+
+/**
+ A future that resolves when the process terminates with a signal.
+ If the process exited normally then this future will error.
+ Cancelling this Future will have no effect. To terminate the process use the `sendSignal:` APIs.
+ */
+@property (nonnull, nonatomic, readonly, strong) FBFuture<NSNumber *> *signal;
+
+/**
+ The IO Object attached to the process.
+ */
+@property (nonnull, nonatomic, readonly, strong) FBProcessSpawnConfiguration *configuration;
+
+/**
+ Returns the stdin of the task.
+ May be called from any thread.
+ The valid types for these values are the wrapped types in FBProcessInput.
+ */
+@property (nullable, nonatomic, readonly, strong) StdInType stdIn;
+
+/**
+ Returns the stdout of the task.
+ May be called from any thread.
+ The valid types for these values are the wrapped types in FBProcessOutput.
+ */
+@property (nullable, nonatomic, readonly, strong) StdOutType stdOut;
+
+/**
+ Returns the stderr of the task.
+ May be called from any thread.
+ The valid types for these values are the wrapped types in FBProcessOutput.
+ */
+@property (nullable, nonatomic, readonly, strong) StdErrType stdErr;
+
+#pragma mark Initializers
+
+/**
+ The Designated Initializer.
+
+ @param processIdentifier the process identifier of the launched process
+ @param statLoc a future that will fire when the process has terminated. The value is that of waitpid(2).
+ @param exitCode a future that will fire when the process exits. See -[FBSubprocess exitCode]
+ @param signal a future that will fire when the process is signalled. See -[FBSubprocess signal]
+ @param configuration the configuration the process was launched with.
+ @param queue the queue to perform actions on.
+ @return an implementation of FBSubprocess.
+ */
+- (nonnull instancetype)initWithProcessIdentifier:(pid_t)processIdentifier statLoc:(nonnull FBFuture<NSNumber *> *)statLoc exitCode:(nonnull FBFuture<NSNumber *> *)exitCode signal:(nonnull FBFuture<NSNumber *> *)signal configuration:(nonnull FBProcessSpawnConfiguration *)configuration queue:(nonnull dispatch_queue_t)queue;
+
+/**
+ Launches a process with the provided configuration.
+
+ @param configuration the configuration to use.
+ @param logger an optional logger to log process lifecycle events to.
+ @return a future that resolves with the launched process once it has been started.
+ */
++ (nonnull FBFuture<FBSubprocess *> *)launchProcessWithConfiguration:(nonnull FBProcessSpawnConfiguration *)configuration logger:(nonnull id<FBControlCoreLogger>)logger;
+
+#pragma mark Methods
+
+/**
+ Confirms that the process exited with a defined set of status codes.
+ Cancelling this future will have no effect.
+
+ @param acceptableExitCodes the exit codes to check for, must not be nil.
+ @return a Future with the same base behaviour as -[FBSubprocess exitCode] with additional checking of codes.
+ */
+- (nonnull FBFuture<NSNumber *> *)exitedWithCodes:(nonnull NSSet<NSNumber *> *)acceptableExitCodes;
+
+/**
+ Signal the process.
+ The future returned will resolve when the process has terminated and can be ignored if not required.
+
+ @param signo the signal number to send.
+ @return a successful Future that resolves to the signal number when the process has terminated.
+ */
+- (nonnull FBFuture<NSNumber *> *)sendSignal:(int)signo;
+
+/**
+ A mechanism for sending an signal to a task, backing off to a kill.
+ If the process does not die before the timeout is hit, a SIGKILL will be sent.
+
+ @param signo the signal number to send.
+ @param timeout the timeout to wait before sending a SIGKILL.
+ @param logger used for log information when timeout happened, may be nil.
+ @return a future that resolves to the signal sent when the process has been terminated.
+ */
+- (nonnull FBFuture<NSNumber *> *)sendSignal:(int)signo backingOffToKillWithTimeout:(NSTimeInterval)timeout logger:(nullable id<FBControlCoreLogger>)logger;
+
+@end