v1.112 Define alternative Paste shortcuts in INI

Author: hi5

changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v1.112
+
+* New: Define alternative Paste shortcuts in PasteShortCuts.ini (e.g. Shift+Insert for console programs)
+
 ### v1.111
 
 * New: Limit entries in Yank entry sub-menu for valid history entries

cl3.ahk

@@ -1,7 +1,7 @@
 /*
 
 Script      : CL3 ( = CLCL CLone ) - AutoHotkey 1.1+
-Version     : 1.111
+Version     : 1.112
 Author      : hi5
 Purpose     : CL3 started as a lightweight clone of the CLCL clipboard caching utility  
               which can be found at http://www.nakka.com/soft/clcl/index_eng.html.
@@ -42,7 +42,7 @@ SetWorkingDir, %A_ScriptDir%
 AutoTrim, off
 StringCaseSense, On
 name:="CL3 "
-version:="v1.111"
+version:="v1.112"
 CycleFormat:=0
 Templates:={}
 Global CyclePlugins,History,SettingsObj,Slots,ClipChainData ; CyclePlugins v1.72+, others v1.9.4 for API access
@@ -60,7 +60,7 @@ loop, parse, iconlist, CSV
 	 icon%A_LoopField%:="icon-" A_LoopField ".ico"
 
 ; <for compiled scripts>
-;@Ahk2Exe-SetFileVersion 1.111
+;@Ahk2Exe-SetFileVersion 1.112
 ;@Ahk2Exe-SetDescription CL3 Clipboard Manager
 ;@Ahk2Exe-SetProductName CL3
 ;@Ahk2Exe-SetProductVersion Compiled with AutoHotkey v%A_AhkVersion%
@@ -87,6 +87,7 @@ Suspend, Off
 
 Settings()
 Settings_Hotkeys()
+Settings_PasteShortCuts()
 HistoryRules()
 
 ahk_icons_path:=A_AhkPath
@@ -571,6 +572,7 @@ If ShowTemplates
 				 MenuAccelerator:=0
 				 Loop, parse, templatefolderFiles, |
 					{
+					 FileEncoding, UTF-8
 					 FileRead, a, %TemplateFolder%%subtemplatefolder%\%A_LoopField%
 					 Templates[subtemplatefolder,A_Index]:=a
 					 if (Mod(MenuAccelerator,26)=0)
@@ -734,17 +736,32 @@ DispToolTipText(TextIn,Format=0,time=0)
 
 PasteIt(source="")
 	{
-	 global StartTime,PasteTime,ActiveWindowID,oldttext,ttext,ClipboardOwnerProcessName,ClipboardPrivate
+	 global StartTime,PasteTime,ActiveWindowID,oldttext,ttext,ClipboardOwnerProcessName,ClipboardPrivate,PasteShortCuts
+	 PasteKey:="^v"
 	 StartTime:=A_TickCount
 	 If ((StartTime - PasteTime) < 75) ; to prevent double paste after using #f/#v in combination
 		Return
 ;@Ahk2Exe-IgnoreBegin
 	 #Include *i %A_ScriptDir%\plugins\PastePrivateRules.ahk
 ;@Ahk2Exe-IgnoreEnd		
+
 	 WinActivate, ahk_id %ActiveWindowID%
+	 WinGet, CurrentProcessName, ProcessName, A
+	 StringLower, CurrentProcessName, CurrentProcessName ; needed due to "StringCaseSense, On" set at startup
+
+	 for k, v in PasteShortCuts
+		{
+		 If CurrentProcessName in % v.programs
+		 	PasteKey:=v.key
+		}
+
 	 If PasteDelay
 		Sleep % PasteDelay
-	 Send ^v
+
+	 If (PasteKey = "") or (PasteKey = "[SEND]")
+		SendRaw % clipboard
+	 else	
+		Send % PasteKey
 
 	 PasteTime := A_TickCount
 	 oldttext:="", ttext:="", ActiveWindowID:="",ClipboardOwnerProcessName:=""

lib/settings.ahk

@@ -296,6 +296,27 @@ Settings_Hotkeys()
 ;			Hotkey, %hk_notes%, off
 	}
 
+Settings_PasteShortCuts()
+	{
+	 global PasteShortCuts:=[]
+	 i:=A_ScriptDir "\PasteShortCuts.ini"
+	 If !FileExist(i)
+		Return
+	 IniRead, OutputVarSectionNames, %i%
+	 Loop, parse, OutputVarSectionNames, `n, `r
+	 	{
+		 IniRead, OutputVarPrograms, %i%, %A_LoopField%, Programs, 0
+		 IniRead, OutputVarKey, %i%, %A_LoopField%, Key, 0
+		 StringLower, OutputVarPrograms, OutputVarPrograms ; needed due to "StringCaseSense, On" set at startup
+		 OutputVarPrograms:=Trim(RegExReplace(OutputVarPrograms,"ms)\s*,\s*",","),",") ; trim spaces between program names e.g. program.exe , anotherprogram.exe
+		 If OutputVarPrograms not in 0,error
+		 	PasteShortCuts[A_LoopField,"programs"]:=OutputVarPrograms
+		 If OutputVarKey not in 0,Error
+		 	PasteShortCuts[A_LoopField,"key"]:=Trim(OutputVarKey,Chr(34))
+		 OutputVarPrograms:="",OutputVarKey:=""
+	 	}
+	}
+
 Settings_menu:
 #Include %A_ScriptDir%\lib\SettingsGui.ahk
 

license.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 hi5 <https://github.com/hi5>
+Copyright (c) 2013-2025 hi5 <https://github.com/hi5>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

readme.md

@@ -1,13 +1,13 @@
-# CL3 <sup>v1.111</sup> - Clipboard caching utility
+# CL3 <sup>v1.112</sup> - Clipboard caching utility
 
 CL3 started as a lightweight clone of the CLCL clipboard caching utility
 which can be found at <http://www.nakka.com/soft/clcl/index_eng.html>.
-But some unique [features](#features) have been added making it more versatile "text only" Clipboard manager.
+But some unique [features](#features) have been added making it a more versatile "text only" Clipboard manager.
 
-Intended for AutoHotkey Unicode (64-bit version of AutoHotkey is automatically Unicode).
+Intended for AutoHotkey Unicode (the 64-bit version of AutoHotkey is automatically Unicode).
 
-💡 Relies standard copy/paste shortcuts for the applications you are using, so <kbd>Ctrl</kbd>+<kbd>c</kbd> and <kbd>Ctrl</kbd>+<kbd>v</kbd>, and right click "copy" via mouse actions.
-Programs that rely on other shortcuts to store/restore clipboard contents may not work (e.g. vim).
+💡 Relies on standard copy/paste shortcuts for the applications you are using, so <kbd>Ctrl</kbd>+<kbd>c</kbd> and <kbd>Ctrl</kbd>+<kbd>v</kbd>, and right click "copy" via mouse actions.
+Programs that rely on other shortcuts to store and restore clipboard contents may not work (e.g. vim).
 
 💬 Forum thread [https://autohotkey.com/boards/viewtopic.php?f=6&t=814](https://autohotkey.com/boards/viewtopic.php?f=6&t=814)
 
@@ -62,11 +62,11 @@ _CL3 gets its name from CLCL CLone = CL3_
 - Limited history (18 items+26 items in secondary menu, does remember more entries in XML history file)
 - Search history (v1.2+)
 - 10 Slots with options to save/load several sets (v1.2+)
-- Cycle through clipboard - forwards and backwards - with tooltip preview (v1.3+). Cycle through plugins (v1.8+)
+- Cycle through the clipboard history - forwards and backwards - with tooltip preview (v1.3+). Cycle through plugins (v1.8+)
 - ClipChain with preview GUI, paste items in predefined order, save/load several sets (v1.5+) [Wiki](https://github.com/hi5/CL3/wiki/ClipChain)
 - Supports FIFO (first in first out) pasting (v1.7) [#3](https://github.com/hi5/CL3/issues/3)
 - Remove (yank) entries from history
-- No duplicate entries in clipboard (automatically removed)
+- No duplicate entries in the clipboard history (automatically removed)
 - Templates: simply text files which are read at start up
 - Plugins: AutoHotkey functions (scripts) defined in separate files
 
@@ -156,7 +156,7 @@ The text file will be placed in the CL3 script folder.
 
 You can use the AutoReplace plugin to modify the text in the clipboard using a find/replace rule before adding
 it to the history. You can use StringReplace or a Regular Expression. Settings are stored in _AutoReplace.xml_
-**Note: very experimental plugin. The plugin interface (GUI) needs to refined, entire process should be improved.
+**Note: very experimental plugin. The plugin interface (GUI) needs to be refined, entire process should be improved.
 A Listview would be more logical and flexible. But for now it does the job, albeit crudely.**
 
 Feedback available via "Tray Tip" - see settings.
@@ -206,7 +206,7 @@ d. 1
 
 If you start FIFO at 'D' pressing <kbd>Ctrl</kbd>+<kbd>v</kbd> four times will paste 1, 2, 3, 4.  
 After pasting the last (here fourth) item, FIFO stops.  
-TrayTips will appear at the start and stop of a FIFO cycle.
+TrayTips will appear at the start and end of a FIFO cycle.
 
 ### Sort [v1.94+]
 
@@ -217,7 +217,7 @@ See [Sort](https://www.autohotkey.com/docs/commands/Sort.htm) documentation for
 
 If you select the yank option in the menu you will be presented with a 
 simple **a** to **r** menu to indicate which of the most recent items you wish to
-delete.
+delete. To delete the entire history select "Clear History" (v1.111+)
 
 ## Cycle through clipboard history [v1.3+]
 
@@ -258,8 +258,8 @@ Some ideas for further development you may wish to consider:
 - ~~Extending the number of menu entries in the secondary menu ("more history")~~ _v1.100+_
 - Include rich text formats
 - Include images - rough guide to add it (very alpha) here https://www.autohotkey.com/boards/viewtopic.php?p=314319#p314319
-- Introduce various paste methods, also for specific programs 
-  for example send each character individually
+- ~~Introduce various paste methods, also for specific programs? 
+  for example send each character individually~~ _v1.112+_
 - More (default) plugins:
 	- Improved title case (various scripts are available which could replace the current basic one)
 	- Strip HTML
@@ -343,7 +343,7 @@ Apart from plugins, `plugins\MyPlugins.ahk` is also a useful method to add addit
 
 1. Copy or Cut and Append to clipboard
 
-Some text editors already offer this functionality, but you make it available everywhere using CL3.  
+Some text editors already offer this functionality, but you can make it available everywhere using CL3.  
 Add the following code for copy and/or cut to `plugins\MyPlugins.ahk`
 
 ```autohotkey
@@ -415,11 +415,35 @@ Return
 Add an optional include file that "does something" before it actually pastes.  
 The file is not present in the repository and a new file has to be created in `cl3\plugins\` with the name `PastePrivateRules.ahk`
 
+Examples:
+
 * Pasting file(s) from CL3 history https://www.autohotkey.com/boards/viewtopic.php?p=314316#p314316 using `ClipboardSetFiles()` and `If WinActive()`
 * Append to File name in "Open/Save as" dialogs - https://github.com/hi5/CL3/issues/14
+* Paste in putty.exe (as of v1.112 can be care of using PasteShortCuts.ini) - https://github.com/hi5/CL3/issues/27
 
 Note: your `PastePrivateRules.ahk` will never be part of this GitHub repository so anything you add won't be overwritten if you update CL3 in the future. 
 
+# PasteShortCuts.ini
+
+Note: a default setup can be found in `res\PasteShortCuts.ini` (online [here](https://github.com/hi5/CL3/blob/master/res/PasteShortCuts.ini)) - copy the file to the CL3 folder and restart CL3.
+
+To setup CL3 for programs where you don't want to use the standard Windows shortcut (Ctrl+v) to paste
+create or edit `PasteShortCuts.ini` in the CL3 program folder. Details below and in the ini file as well.
+
+```ini
+[SectionName] - Create a section (any name)
+Programs=       CSV list of program executables
+Key=            Use AHK notation (^=ctrl +=shift !=alt), if KEY is empty or "[SEND]" (no quotes)
+                CL3 will use SendRaw to send the clipboard to the application - results may vary
+```
+Terminal programs often prefer <kbd>Shift</kbd>+<kbd>Insert</kbd> (`+{Ins}`) as Paste shortcut
+
+Using `PastePrivateRules.ahk` is another option, see examples listed above.
+
+# Experimental
+
+* [HistoryRules](https://github.com/hi5/CL3/blob/master/docs/HistoryRules.md) to allow CL3 to filter clipboard content before adding it to history, allowing or skipping text.
+
 # Changelog
 
 The changelog is available here: [changelog.md](changelog.md)