Make Cmd-E work and always share to OS Find Pasteboard

Cmd-E (Edit -> Use Selection for Find") in most macOS apps follow the
convention that it shares to the system Find Pasteboard, while Cmd-G
uses the Find Pasteboard to find the next item. Make Cmd-E always do
that even if MMShareFindPboard is set to NO. This way, normal searches
in Vim wouldn't pollute the system find pasteboard, but could still have
a way to share to it by using this action.

Author: ychin

runtime/doc/gui_mac.txt

@@ -120,16 +120,18 @@ These are the non-standard commands that MacVim supports:
 	|:macaction|	|:macmenu|
 
 							*macvim-find*
-Whenever you search for something in Vim (e.g. using "/") the search query is
-copied to the macOS "Find Pasteboard".  The idea is that if you search for
-something and switch to another application, then you can hit <D-g> (or <D-G>)
-to repeat the search in the new app.  The same feature works if you search in
-some app, switch to MacVim and hit <D-g>.
+Whenever you search for something in Vim (e.g. using "/"), or hit <D-e> when
+you have text selected, the search query is copied to the macOS "Find
+Pasteboard".  The idea is that if you search for something and switch to
+another application, then you can hit <D-g> (or <D-G>) to repeat the search in
+the new app.  The same feature works if you search in some app, switch to
+MacVim and hit <D-g>.
 
 If you would like to turn off sharing Vim's search query to the macOS Find
-Pasteboard, you can set |MMShareFindPboard| to "NO". <D-g> will still use the
-OS Find Pasteboard for searching though (use |n| instead if that's not what
-you want).
+Pasteboard, you can set |MMShareFindPboard| to "NO". Even when that's set,
+<D-g> will still use the OS Find Pasteboard for searching (use |n| instead if
+that's not what you want), and <D-e> ("Edit -> Use Selection for Find") will
+still share the search pattern to Find Pasteboard.
 
 Note that the command |n| is not the same as <D-g>.  The former will repeat
 the last search made in Vim, whereas the latter searches for the string on the
@@ -445,6 +447,8 @@ Action				Description ~
 fileOpen:			Show "File Open" dialog
 findNext:			Search forward using the "Find Pasteboard"
 findPrevious:			Search backward using the "Find Pasteboard"
+useSelectionForFind:		Search the selected text and share to "Find
+				Pasteboard"
 fontSizeDown:			Decrease font size
 fontSizeUp:			Increase font size
 hide:				Hide MacVim

runtime/menu.vim

@@ -231,7 +231,7 @@ elseif has("gui_macvim")
   vnoremenu <silent> &Edit.Find.Find\.\.\.	y:promptfind <C-R>=<SID>FixFText()<CR><CR>
   an 20.410.20 &Edit.Find.Find\ Next			<Nop>
   an 20.410.30 &Edit.Find.Find\ Previous		<Nop>
-  vnoremenu 20.410.35 &Edit.Find.Use\ Selection\ for\ Find	y:let @/=@"<CR>:<BS>
+  vnoremenu 20.410.35 &Edit.Find.Use\ Selection\ for\ Find	<Nop>
 else
   an 20.410	 &Edit.&Find<Tab>/			/
   an 20.420	 &Edit.Find\ and\ Rep&lace<Tab>:%s	:%s/
@@ -1261,7 +1261,7 @@ if has("gui_macvim")
   macm Edit.Find.Find\.\.\.			key=<D-f>
   macm Edit.Find.Find\ Next			key=<D-g> action=findNext:
   macm Edit.Find.Find\ Previous			key=<D-G> action=findPrevious:
-  macm Edit.Find.Use\ Selection\ for\ Find	key=<D-e>
+  macm Edit.Find.Use\ Selection\ for\ Find	key=<D-e> action=useSelectionForFind:
   macm Edit.Font.Show\ Fonts			action=orderFrontFontPanel:
   macm Edit.Font.Bigger				key=<D-=> action=fontSizeUp:
   macm Edit.Font.Smaller			key=<D--> action=fontSizeDown:

src/MacVim/Actions.plist

@@ -22,6 +22,8 @@
 	<string></string>
 	<key>findPrevious:</key>
 	<string></string>
+	<key>useSelectionForFind:</key>
+	<string></string>
 	<key>fontSizeDown:</key>
 	<string></string>
 	<key>fontSizeUp:</key>

src/MacVim/MMBackend.h

@@ -58,6 +58,7 @@ extern NSTimeInterval MMBalloonEvalInternalDelay;
     BOOL                imState;
     int                 winposX;
     int                 winposY;
+    BOOL                addToFindPboardOverride;
 #ifdef FEAT_BEVAL
     NSString            *lastToolTip;
 #endif
@@ -155,6 +156,9 @@ extern NSTimeInterval MMBalloonEvalInternalDelay;
 - (void)setWaitForAck:(BOOL)yn;
 - (void)waitForConnectionAcknowledgement;
 
+- (BOOL)addToFindPboardOverride;
+- (void)clearAddToFindPboardOverride;
+
 - (BOOL)imState;
 - (void)setImState:(BOOL)activated;
 

src/MacVim/MMBackend.m

@@ -193,6 +193,7 @@ - (int)checkForModifiedBuffers;
 - (void)addInput:(NSString *)input;
 - (void)redrawScreen;
 - (void)handleFindReplace:(NSDictionary *)args;
+- (void)useSelectionForFind;
 - (void)handleMarkedText:(NSData *)data;
 - (void)handleGesture:(NSData *)data;
 #ifdef FEAT_BEVAL
@@ -254,6 +255,8 @@ - (id)init
         ASLogNotice(@"Failed to load dictionaries.%@", MMSymlinkWarningString);
     }
 
+    addToFindPboardOverride = NO;
+
     return self;
 }
 
@@ -1701,6 +1704,16 @@ - (oneway void)acknowledgeConnection
     waitForAck = NO;
 }
 
+- (BOOL)addToFindPboardOverride
+{
+    return addToFindPboardOverride;
+}
+
+- (void)clearAddToFindPboardOverride
+{
+	addToFindPboardOverride = NO;
+}
+
 - (BOOL)imState
 {
     return imState;
@@ -2072,6 +2085,8 @@ - (void)handleInputEvent:(int)msgid data:(NSData *)data
         [self handleOpenWithArguments:[NSDictionary dictionaryWithData:data]];
     } else if (FindReplaceMsgID == msgid) {
         [self handleFindReplace:[NSDictionary dictionaryWithData:data]];
+    } else if (UseSelectionForFindMsgID == msgid) {
+        [self useSelectionForFind];
     } else if (ZoomMsgID == msgid) {
         if (!data) return;
         const void *bytes = [data bytes];
@@ -2967,6 +2982,21 @@ - (void)handleFindReplace:(NSDictionary *)args
     vim_free(replace);
 }
 
+- (void)useSelectionForFind
+{
+    if (VIsual_active && (State & NORMAL)) {
+		// This happens when Cmd-E is pressed and is supposed to be consistent
+		// with normal macOS apps, so it always writes to the system find
+		// pasteboard, unlike normal searches where it could be turned off via
+		// MMShareFindPboard. Set an override to make sure it gets shared out.
+		// Since gui_macvim_add_to_find_pboard is going to get called after
+		// this returns it will be responsible for calling
+		// clearAddToFindPboardOverride to clean up.
+        addToFindPboardOverride = YES;
+        [self addInput:@"y:let @/=@\"<CR>:<BS>"];
+    }
+}
+
 
 - (void)handleMarkedText:(NSData *)data
 {

src/MacVim/MMWindowController.h

@@ -102,6 +102,7 @@
 - (IBAction)performClose:(id)sender;
 - (IBAction)findNext:(id)sender;
 - (IBAction)findPrevious:(id)sender;
+- (IBAction)useSelectionForFind:(id)sender;
 - (IBAction)vimMenuItemAction:(id)sender;
 - (IBAction)vimToolbarItemAction:(id)sender;
 - (IBAction)fontSizeUp:(id)sender;

src/MacVim/MMWindowController.m

@@ -877,6 +877,11 @@ - (IBAction)findPrevious:(id)sender
     [self doFindNext:NO];
 }
 
+- (IBAction)useSelectionForFind:(id)sender
+{
+    [vimController sendMessage:UseSelectionForFindMsgID data:nil];
+}
+
 - (IBAction)vimMenuItemAction:(id)sender
 {
     if (![sender isKindOfClass:[NSMenuItem class]]) return;

src/MacVim/MacVim.h

@@ -234,6 +234,7 @@ enum {
     SetFullScreenColorMsgID,
     ShowFindReplaceDialogMsgID,
     FindReplaceMsgID,
+    UseSelectionForFindMsgID,
     ActivateKeyScriptMsgID,
     DeactivateKeyScriptMsgID,
     EnableImControlMsgID,

src/MacVim/gui_macvim.m

@@ -1870,7 +1870,19 @@
 {
     if (!pat) return;
 
-	if (!MMShareFindPboard) return;
+	if ([MMBackend sharedInstance].addToFindPboardOverride) {
+		// MMBackend would set addToFindPboardOverride to YES when we are
+		// using the useSelectionFodFind: macaction, accessible via Cmd-E,
+		// which indicates we always want to share to the find pasteboard
+		// unlike normal search. Since this function is called after the action
+		// is handled we need to manually clear the override so it doesn't
+		// persist in later searches.
+		[[MMBackend sharedInstance] clearAddToFindPboardOverride];
+	} else {
+		if (!MMShareFindPboard) {
+			return;
+		}
+	}
 
 #ifdef FEAT_MBYTE
     pat = CONVERT_TO_UTF8(pat);