Add copy to context menu for status bar components. Issue 12777

Author: gnachman

sources/iTermStatusBarActionComponent.m

@@ -114,6 +114,10 @@ - (nullable NSImage *)statusBarComponentIcon {
     return [NSImage it_cacheableImageNamed:@"StatusBarIconAction" forClass:[self class]];
 }
 
+- (NSString *)statusBarComponentCopyableString {
+    return nil;
+}
+
 - (BOOL)statusBarComponentHandlesClicks {
     return YES;
 }
@@ -132,6 +136,10 @@ - (void)statusBarComponentDidClickWithView:(NSView *)view {
 
 @implementation iTermStatusBarActionMenuComponent
 
+- (NSString *)statusBarComponentCopyableString {
+    return nil;
+}
+
 - (nullable NSImage *)statusBarComponentIcon {
     return [NSImage it_cacheableImageNamed:@"StatusBarIconAction" forClass:[self class]];
 }

sources/iTermStatusBarAttributedTextComponent.m

@@ -290,6 +290,10 @@ - (NSFont *)font {
     return self.advancedConfiguration.font ?: [iTermStatusBarAdvancedConfiguration defaultFont];
 }
 
+- (nullable NSString *)statusBarComponentCopyableString {
+    return [[self longestAttributedStringValue] string];
+}
+
 - (CGFloat)statusBarComponentVerticalOffset {
     NSFont *font = [self font];
     const CGFloat containerHeight = _textField.superview.bounds.size.height;

sources/iTermStatusBarComponent.h

@@ -171,6 +171,9 @@ forInvocation:(NSString *)invocation
 
 @optional
 - (NSFont *)font;
+// Returns a string suitable for copying to the clipboard, or nil if this component
+// does not have meaningful copyable text.
+- (nullable NSString *)statusBarComponentCopyableString;
 
 @end
 NS_ASSUME_NONNULL_END

sources/iTermStatusBarContainerView.m

@@ -298,6 +298,15 @@ - (BOOL)shouldDragWindowForEvent:(NSEvent *)event {
 
 - (void)showContextMenuForEvent:(NSEvent *)event {
     NSMenu *menu = [[NSMenu alloc] initWithTitle:@"Contextual Menu"];
+    if ([_component respondsToSelector:@selector(statusBarComponentCopyableString)]) {
+        NSString *copyableString = [_component statusBarComponentCopyableString];
+        if (copyableString.length > 0) {
+            [menu addItemWithTitle:@"Copy"
+                            action:@selector(copyComponentValue:)
+                     keyEquivalent:@""];
+            [menu addItem:[NSMenuItem separatorItem]];
+        }
+    }
     if (![_component statusBarComponentIsInternal]) {
         if ([[_component statusBarComponentKnobs] count]) {
             [menu addItemWithTitle:[NSString stringWithFormat:@"Configure %@", [self.component statusBarComponentShortDescription]]
@@ -331,6 +340,16 @@ - (void)showContextMenuForEvent:(NSEvent *)event {
     [NSMenu popUpContextMenu:menu withEvent:event forView:self];
 }
 
+- (void)copyComponentValue:(id)sender {
+    if ([_component respondsToSelector:@selector(statusBarComponentCopyableString)]) {
+        NSString *string = [_component statusBarComponentCopyableString];
+        if (string.length > 0) {
+            [[NSPasteboard generalPasteboard] clearContents];
+            [[NSPasteboard generalPasteboard] setString:string forType:NSPasteboardTypeString];
+        }
+    }
+}
+
 - (void)configureComponent:(id)sender {
     [self.delegate statusBarContainerView:self configureComponent:self.component];
 }

sources/iTermStatusBarGitComponent.m

@@ -398,6 +398,10 @@ - (void)bumpIfLastCommandWasGit {
     }
 }
 
+- (nullable NSString *)statusBarComponentCopyableString {
+    return self.currentState.branch;
+}
+
 - (BOOL)statusBarComponentHandlesClicks {
     return YES;
 }

sources/iTermStatusBarPlaceholderComponent.m

@@ -45,6 +45,10 @@ - (nullable NSString *)stringValueForCurrentWidth {
     return @[ self.stringValue ?: @"" ];
 }
 
+- (nullable NSString *)statusBarComponentCopyableString {
+    return nil;
+}
+
 - (BOOL)statusBarComponentHandlesClicks {
     return YES;
 }

sources/iTermStatusBarSnippetComponent.m

@@ -50,6 +50,10 @@ - (nullable NSString *)stringValueForCurrentWidth {
     return @[ self.stringValue ];
 }
 
+- (NSString *)statusBarComponentCopyableString {
+    return nil;
+}
+
 - (BOOL)statusBarComponentHandlesClicks {
     return YES;
 }

sources/iTermStatusBarTextComponent.m

@@ -236,6 +236,10 @@ - (NSColor *)statusBarBackgroundColor {
     return [self backgroundColor];
 }
 
+- (nullable NSString *)statusBarComponentCopyableString {
+    return [self longestStringValue];
+}
+
 - (CGFloat)statusBarComponentVerticalOffset {
     const CGFloat containerHeight = _textField.superview.bounds.size.height;
     const CGFloat capHeight = _textField.font.capHeight;

sources/iTermStatusBarTriggersComponent.swift

@@ -64,6 +64,10 @@ class StatusBarTriggersComponent: iTermStatusBarTextComponent {
         return [ stringValue ]
     }
 
+    override func statusBarComponentCopyableString() -> String? {
+        return nil
+    }
+
     override func statusBarComponentHandlesClicks() -> Bool {
         return true
     }

sources/iTermStatusBarVariableBaseComponent.m

@@ -302,6 +302,10 @@ - (nullable NSString *)stringByCompressingString:(NSString *)source {
     return [parts componentsJoinedByString:@"/"];
 }
 
+- (nullable NSString *)statusBarComponentCopyableString {
+    return self.fullString;
+}
+
 - (BOOL)statusBarComponentHandlesClicks {
     return YES;
 }