Add event-based triggers. These triggers fire from events such a session ending or the hostname changing. Issue 12735

Author: gnachman

Interfaces/PreferencePanel.xib

@@ -5474,7 +5474,7 @@ CA
                             <rect key="frame" x="326" y="21" width="286" height="14"/>
                             <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                             <textFieldCell key="cell" controlSize="small" lineBreakMode="clipping" alignment="left" title="⚠️ You may want a trigger to stop buffering" id="r4L-CE-8Bh">
-                                <font key="font" size="11" name=".AppleColorEmojiUI"/>
+                                <font key="font" metaFont="smallSystem"/>
                                 <color key="textColor" name="labelColor" catalog="System" colorSpace="catalog"/>
                                 <color key="backgroundColor" name="textBackgroundColor" catalog="System" colorSpace="catalog"/>
                             </textFieldCell>
@@ -5661,7 +5661,7 @@ CA
                             <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                             <clipView key="contentView" id="ArV-0K-qze">
                                 <rect key="frame" x="1" y="1" width="450" height="95"/>
-                                <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
+                                <autoresizingMask key="autoresizingMask"/>
                                 <subviews>
                                     <tableView verticalHuggingPriority="750" allowsExpansionToolTips="YES" columnAutoresizingStyle="lastColumnOnly" alternatingRowBackgroundColors="YES" columnReordering="NO" columnResizing="NO" multipleSelection="NO" autosaveColumns="NO" id="5661">
                                         <rect key="frame" x="0.0" y="0.0" width="450" height="95"/>
@@ -8873,11 +8873,11 @@ See the [documentation](https://iterm2.com/automatic-profile-switching.html) for
                         </tabViewItem>
                         <tabViewItem label="Panes" identifier="2" id="zjb-6I-dDc">
                             <view key="view" id="kid-3c-MWv">
-                                <rect key="frame" x="10" y="33" width="590" height="353"/>
+                                <rect key="frame" x="10" y="33" width="590" height="334"/>
                                 <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
                                 <subviews>
                                     <customView fixedFrame="YES" translatesAutoresizingMaskIntoConstraints="NO" id="DgM-Zm-3SV" customClass="iTermPreferencesInnerTabContainerView">
-                                        <rect key="frame" x="16" y="182" width="551" height="168"/>
+                                        <rect key="frame" x="16" y="163" width="551" height="168"/>
                                         <autoresizingMask key="autoresizingMask" flexibleMinX="YES" flexibleMaxX="YES" flexibleMinY="YES"/>
                                         <subviews>
                                             <button fixedFrame="YES" translatesAutoresizingMaskIntoConstraints="NO" id="rf8-fE-qJb">
@@ -9818,7 +9818,7 @@ instead of the system keyboard.</string>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <clipView key="contentView" id="N1C-ir-dI5">
                         <rect key="frame" x="1" y="1" width="238" height="377"/>
-                        <autoresizingMask key="autoresizingMask"/>
+                        <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
                         <subviews>
                             <tableView verticalHuggingPriority="750" allowsExpansionToolTips="YES" columnAutoresizingStyle="lastColumnOnly" columnReordering="NO" columnResizing="NO" autosaveColumns="NO" typeSelect="NO" id="5562">
                                 <rect key="frame" x="0.0" y="0.0" width="238" height="377"/>

iTerm2.xcodeproj/project.pbxproj

@@ -8,6 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		06E0C88E1DF9695400AA061B /* iTermServiceProvider.h in Headers */ = {isa = PBXBuildFile; fileRef = 06E0C88C1DF9695400AA061B /* iTermServiceProvider.h */; };
+		10AAA7668EA8FBDD64696AB7 /* iTermEventTriggerParameterView.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE7B0AE10E1598EDE1E01795 /* iTermEventTriggerParameterView.swift */; };
 		1D027C111CD1867000B0FBFF /* iTermColorPresets.h in Headers */ = {isa = PBXBuildFile; fileRef = 1D027C0F1CD1867000B0FBFF /* iTermColorPresets.h */; };
 		1D0318281A42563A00932107 /* iTermImageWell.h in Headers */ = {isa = PBXBuildFile; fileRef = 1D0318261A42563A00932107 /* iTermImageWell.h */; };
 		1D0318291A42563A00932107 /* iTermImageWell.h in Headers */ = {isa = PBXBuildFile; fileRef = 1D0318261A42563A00932107 /* iTermImageWell.h */; };
@@ -925,6 +926,7 @@
 		5ECE005F1454E59B004861E9 /* PseudoTerminalRestorer.h in Headers */ = {isa = PBXBuildFile; fileRef = 5ECE005D1454E59B004861E9 /* PseudoTerminalRestorer.h */; };
 		6998793AE8C54A0EAE7D5D0F /* PillBackgroundRenderer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7F3AA921DF1744D7BA890104 /* PillBackgroundRenderer.swift */; };
 		70C067D3E9484CA9A48D69BD /* ButtonPillInfo.swift in Sources */ = {isa = PBXBuildFile; fileRef = E7E1E38CBCE5463DA81CC1CF /* ButtonPillInfo.swift */; };
+		7531FA92945C4C5ABAB8F390 /* iTermEventTriggerEvaluator.swift in Sources */ = {isa = PBXBuildFile; fileRef = B231EDB860248C368A511B42 /* iTermEventTriggerEvaluator.swift */; };
 		756C32AD2597AC2E0047B3A9 /* iTermImage+Sixel.m in Sources */ = {isa = PBXBuildFile; fileRef = 756C32AC2597AC2E0047B3A9 /* iTermImage+Sixel.m */; };
 		756C32B72597AC8C0047B3A9 /* libsixel.a in Frameworks */ = {isa = PBXBuildFile; fileRef = A67D194E2237045C00BD0D4D /* libsixel.a */; };
 		7577E2A12593B88700905402 /* iTermSandboxedWorkerClient.h in Headers */ = {isa = PBXBuildFile; fileRef = 7577E29F2593B88700905402 /* iTermSandboxedWorkerClient.h */; };
@@ -9097,6 +9099,7 @@
 		A6FFAE722CF682B60031FB21 /* iTermDoubleWidthCharacterCache.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = iTermDoubleWidthCharacterCache.h; sourceTree = "<group>"; };
 		A6FFAE742CF682D40031FB21 /* iTermDoubleWidthCharacterCache.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = iTermDoubleWidthCharacterCache.m; sourceTree = "<group>"; };
 		AF19E441FF824539A275D8DA /* iTermLayoutCalculator.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = iTermLayoutCalculator.m; sourceTree = "<group>"; };
+		B231EDB860248C368A511B42 /* iTermEventTriggerEvaluator.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = iTermEventTriggerEvaluator.swift; sourceTree = "<group>"; };
 		C6675EBA1C4FE96B0041173B /* iTermSelectorSwizzler.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = iTermSelectorSwizzler.h; sourceTree = "<group>"; };
 		C6675EBB1C4FE96B0041173B /* iTermSelectorSwizzler.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = iTermSelectorSwizzler.m; sourceTree = "<group>"; };
 		D3CE2D4C1A00936F0098ED99 /* PSMDarkTabStyle.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PSMDarkTabStyle.h; sourceTree = "<group>"; };
@@ -9118,6 +9121,7 @@
 		DD57633605653C5F00F1905E /* iTerm2.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = iTerm2.plist; sourceTree = "<group>"; };
 		DDF0FD63062916F70080EF74 /* iTermApplication.h */ = {isa = PBXFileReference; fileEncoding = 4; indentWidth = 4; lastKnownFileType = sourcecode.c.h; path = iTermApplication.h; sourceTree = "<group>"; tabWidth = 4; };
 		DDF0FD64062916F70080EF74 /* iTermApplication.m */ = {isa = PBXFileReference; fileEncoding = 4; indentWidth = 4; lastKnownFileType = sourcecode.c.objc; lineEnding = 0; path = iTermApplication.m; sourceTree = "<group>"; tabWidth = 4; xcLanguageSpecificationIdentifier = xcode.lang.objc; };
+		DE7B0AE10E1598EDE1E01795 /* iTermEventTriggerParameterView.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = iTermEventTriggerParameterView.swift; sourceTree = "<group>"; };
 		E7E1E38CBCE5463DA81CC1CF /* ButtonPillInfo.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ButtonPillInfo.swift; sourceTree = "<group>"; };
 		E8A66F030272453F03A80106 /* iTermController.m */ = {isa = PBXFileReference; fileEncoding = 30; indentWidth = 4; lastKnownFileType = sourcecode.c.objc; lineEnding = 0; path = iTermController.m; sourceTree = "<group>"; tabWidth = 4; xcLanguageSpecificationIdentifier = xcode.lang.objc; };
 		E8CF755F026DDA6303A80106 /* PTYScrollView.m */ = {isa = PBXFileReference; fileEncoding = 30; indentWidth = 4; lastKnownFileType = sourcecode.c.objc; lineEnding = 0; path = PTYScrollView.m; sourceTree = "<group>"; tabWidth = 4; xcLanguageSpecificationIdentifier = xcode.lang.objc; };
@@ -13354,6 +13358,8 @@
 			isa = PBXGroup;
 			children = (
 				207C83644F1E850C9F1E918A /* iTermTouchIDHelper.swift */,
+				B231EDB860248C368A511B42 /* iTermEventTriggerEvaluator.swift */,
+				DE7B0AE10E1598EDE1E01795 /* iTermEventTriggerParameterView.swift */,
 			);
 			name = sources;
 			path = sources;
@@ -19956,6 +19962,8 @@
 				A6F7D4EE2E0532B40065D09C /* Database.swift in Sources */,
 				A6069F0A2DF25C1A00EE6CC7 /* AIPluginClient.swift in Sources */,
 				84914ABAD880FC4B174DFAF5 /* iTermTouchIDHelper.swift in Sources */,
+				7531FA92945C4C5ABAB8F390 /* iTermEventTriggerEvaluator.swift in Sources */,
+				10AAA7668EA8FBDD64696AB7 /* iTermEventTriggerParameterView.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

sources/AlertTrigger.m

@@ -7,6 +7,7 @@
 
 #import "AlertTrigger.h"
 #import "PTYSession.h"
+#import "iTerm2SharedARC-Swift.h"
 #import "PTYTab.h"
 #import "PseudoTerminal.h"
 #import "iTermAdvancedSettingsModel.h"
@@ -35,6 +36,12 @@ - (BOOL)takesParameter
     return YES;
 }
 
+- (NSSet<NSNumber *> *)allowedMatchTypes {
+    NSMutableSet *set = [NSMutableSet setWithObject:@(iTermTriggerMatchTypeRegex)];
+    [set unionSet:[iTermEventTriggerMatchTypeHelper allEventTypesSet]];
+    return set;
+}
+
 - (BOOL)performActionWithCapturedStrings:(NSArray<NSString *> *)stringArray
                           capturedRanges:(const NSRange *)capturedRanges
                                inSession:(id<iTermTriggerSession>)aSession

sources/AnnotateTrigger.m

@@ -29,6 +29,11 @@ - (NSString *)triggerOptionalParameterPlaceholderWithInterpolation:(BOOL)interpo
     return @"Enter annotation";
 }
 
+// Annotations require captured text ranges, so not compatible with event triggers
+- (NSSet<NSNumber *> *)allowedMatchTypes {
+    return [NSSet setWithArray:@[ @(iTermTriggerMatchTypeRegex) ]];
+}
+
 
 - (BOOL)performActionWithCapturedStrings:(NSArray<NSString *> *)stringArray
                           capturedRanges:(const NSRange *)capturedRanges

sources/BellTrigger.m

@@ -9,6 +9,7 @@
 
 #import "DebugLogging.h"
 #import "VT100Screen.h"
+#import "iTerm2SharedARC-Swift.h"
 
 @implementation BellTrigger
 
@@ -26,6 +27,12 @@ - (BOOL)takesParameter
     return NO;
 }
 
+- (NSSet<NSNumber *> *)allowedMatchTypes {
+    NSMutableSet *set = [NSMutableSet setWithObject:@(iTermTriggerMatchTypeRegex)];
+    [set unionSet:[iTermEventTriggerMatchTypeHelper allEventTypesSet]];
+    return set;
+}
+
 - (BOOL)performActionWithCapturedStrings:(NSArray<NSString *> *)stringArray
                           capturedRanges:(const NSRange *)capturedRanges
                                inSession:(id<iTermTriggerSession>)aSession

sources/BounceTrigger.m

@@ -6,6 +6,7 @@
 //
 
 #import "BounceTrigger.h"
+#import "iTerm2SharedARC-Swift.h"
 
 // How to bounce. The parameter takes an integer value equal to one of these. This is the tag.
 typedef NS_ENUM(int, BounceTriggerParamTag) {
@@ -43,6 +44,12 @@ - (BOOL)isIdempotent {
     return YES;
 }
 
+- (NSSet<NSNumber *> *)allowedMatchTypes {
+    NSMutableSet *set = [NSMutableSet setWithObject:@(iTermTriggerMatchTypeRegex)];
+    [set unionSet:[iTermEventTriggerMatchTypeHelper allEventTypesSet]];
+    return set;
+}
+
 - (NSInteger)indexForObject:(id)object {
     int i = 0;
     for (NSNumber *n in [self objectsSortedByValueInDict:[self menuItemsForPoupupButton]]) {

sources/BufferInputTrigger.swift

@@ -37,6 +37,13 @@ class BufferInputTrigger: Trigger {
         return true
     }
 
+    // Requires a live session to buffer input
+    override var allowedMatchTypes: Set<NSNumber> {
+        var set: Set<NSNumber> = [NSNumber(value: iTermTriggerMatchType.regex.rawValue)]
+        set.formUnion(EventTriggerMatchTypeHelper.allEventTypesExceptSessionEndedSet)
+        return set
+    }
+
     override func paramIsPopupButton() -> Bool {
         true
     }

sources/CoprocessTrigger.m

@@ -9,6 +9,7 @@
 #import "CoprocessTrigger.h"
 #import "iTermAnnouncementViewController.h"
 #import "PTYSession.h"
+#import "iTerm2SharedARC-Swift.h"
 
 static NSString *const kSuppressCoprocessTriggerWarning = @"NoSyncSuppressCoprocessTriggerWarning";
 
@@ -30,6 +31,13 @@ - (NSString *)triggerOptionalParameterPlaceholderWithInterpolation:(BOOL)interpo
     return @"Enter coprocess command to run";
 }
 
+// Requires a live session to launch a coprocess
+- (NSSet<NSNumber *> *)allowedMatchTypes {
+    NSMutableSet *set = [NSMutableSet setWithObject:@(iTermTriggerMatchTypeRegex)];
+    [set unionSet:[iTermEventTriggerMatchTypeHelper allEventTypesExceptSessionEndedSet]];
+    return set;
+}
+
 - (BOOL)performActionWithCapturedStrings:(NSArray<NSString *> *)stringArray
                           capturedRanges:(const NSRange *)capturedRanges
                                inSession:(id<iTermTriggerSession>)aSession

sources/FoldTrigger.swift

@@ -19,6 +19,12 @@ class FoldTrigger: Trigger {
         return true
     }
 
+    override var allowedMatchTypes: Set<NSNumber> {
+        var set: Set<NSNumber> = [NSNumber(value: iTermTriggerMatchType.regex.rawValue)]
+        set.formUnion(EventTriggerMatchTypeHelper.allEventTypesSet)
+        return set
+    }
+
     override func triggerOptionalParameterPlaceholder(withInterpolation interpolation: Bool) -> String? {
         return "Name of Mark"
     }

sources/ITAddressBookMgr.h

@@ -554,11 +554,29 @@ static inline iTermLoggingStyle iTermLoggingStyleFromUserDefaultsValue(NSUIntege
 }
 
 typedef NS_ENUM(NSInteger, iTermTriggerMatchType) {
+    // Regex-based (0-99)
     iTermTriggerMatchTypeRegex = 0,
     iTermTriggerMatchTypeURLRegex = 1,
-    iTermTriggerMatchTypePageContentRegex = 2
+    iTermTriggerMatchTypePageContentRegex = 2,
+
+    // Event-based (100+)
+    iTermTriggerMatchTypeEventPromptDetected = 100,
+    iTermTriggerMatchTypeEventCommandFinished = 101,
+    iTermTriggerMatchTypeEventDirectoryChanged = 102,
+    iTermTriggerMatchTypeEventHostChanged = 103,
+    iTermTriggerMatchTypeEventUserChanged = 104,
+    iTermTriggerMatchTypeEventIdle = 105,
+    iTermTriggerMatchTypeEventActivityAfterIdle = 106,
+    iTermTriggerMatchTypeEventSessionEnded = 107,
+    iTermTriggerMatchTypeEventBellReceived = 108,
+    iTermTriggerMatchTypeEventLongRunningCommand = 109,
+    iTermTriggerMatchTypeEventCustomEscapeSequence = 110
 };
 
+static inline BOOL iTermTriggerMatchTypeIsEvent(iTermTriggerMatchType type) {
+    return type >= 100;
+}
+
 typedef struct {
     double width;
     double height;