Hotstring.ahk

/*
Hotstring(
	trigger:
		A string or a regular expression to trigger the hotstring. (If you use a regex here, the mode should be 3 for the regex to work)
	
	label:
		A string to replace the trigger / A label to go to / A function to call when the hotstring is triggered.
		If you used a regular expression as the trigger and mode was set to three, backreferences like $0, $1 would work.
		If a function name was passed, the function will be called with the phrase that triggered the hotstring(If the trigger was a string)
			or the Match object(If the trigger was a regex & mode equals 3).
		If this parameter was a label, the global variable '$' will contain the string/match object.
		If you wish to remove a hotstring, Pass the trigger with this parameter empty.
	
	Mode:
		A number between 1 and 3 that determines the properties of the hotstring.
		If Mode == 1 then the hotstring is case insensitive.
		If Mode == 2 then the hostrings is case sensitive.
		If Mode == 3 then you can use regex in the trigger.
		1 is the defualt.
	clearTrigger:
			Determines if the trigger is erased after the hotstring is triggered.
	cond:
			A name of a function that allows the conditional trigerring of the hotstring.
)
*/
Hotstring(trigger, label, mode := 1, clearTrigger := 1, cond := "")
{
	Global $
	Static keysBound := false,hotkeyPrefix := "~$", hotstrings := {}, typed := "", keys := {"symbols": "!""#$%&'()*+,-./:;<=>?@[\]^_``{|}~", "num": "0123456789", "alpha":"abcdefghijklmnopqrstuvwxyz", "other": "BS,Return,Tab,Space", "breakKeys":"Left,Right,Up,Down,Home,End,RButton,LButton,LControl,RControl,LAlt,RAlt,AppsKey,Lwin,Rwin,WheelDown,WheelUp,f1,f2,f3,f4,f5,f6,f7,f8,f9,f6,f7,f9,f10,f11,f12", "numpad":"Numpad0,Numpad1,Numpad2,Numpad3,Numpad4,Numpad5,Numpad6,Numpad7,Numpad8,Numpad9,NumpadDot,NumpadDiv,NumpadMult,NumpadAdd,NumpadSub,NumpadEnter"}, effect := {"Return" : "`n", "Tab":A_Tab, "Space": A_Space, "Enter":"`n", "Dot": ".", "Div":"/", "Mult":"*", "Add":"+", "Sub":"-"}
	
	If (!keysBound)
	{
		; Binds the keys to watch for triggers.
		For k, v In ["symbols", "num", "alpha"]
		{
			; alphanumeric/symbols
			v := keys[v]
			Loop, Parse, v
				Hotkey, %hotkeyPrefix%%A_LoopField%, __hotstring
		}
		v := keys.alpha
		Loop, Parse, v
			Hotkey, %hotkeyPrefix%+%A_Loopfield%, __hotstring
		For k, v In ["other", "breakKeys", "numpad"]
		{
			; comma separated values
			v := keys[v]
			Loop, Parse, v, `,
				Hotkey, %hotkeyPrefix%%A_LoopField%, __hotstring
		}
		keysBound := true ; keysBound is a static varible. Now, the keys won't be bound twice.
	}
	If (mode == "CALLBACK")
	{
		; Callback for the hotkey.s
		Hotkey := SubStr(A_ThisHotkey, 3)
		If (StrLen(Hotkey) == 2 && Substr(Hotkey, 1, 1) == "+" && Instr(keys.alpha, Substr(Hotkey, 2, 1)))
		{
			Hotkey := Substr(Hotkey, 2)
			If (!GetKeyState("Capslock", "T"))
				StringUpper, Hotkey,Hotkey
		}
		
		shiftState := GetKeyState("Shift", "P")
		uppercase := GetKeyState("Capslock", "T") ? !shiftState : shiftState 
		; If capslock is down, shift's function is reversed.(ie pressing shift and a key while capslock is on will provide the lowercase key)
		If (uppercase && Instr(keys.alpha, Hotkey))
			StringUpper, Hotkey, Hotkey
		If (Instr("," . keys.breakKeys . ",", "," . Hotkey . ","))
		{
			typed := ""
			Return
		}
		Else If Hotkey In Return,Tab,Space
			typed .= effect[Hotkey]
		Else If (Hotkey == "BS")
		{
			; trim typed var if Backspace was pressed.
			StringTrimRight, typed, typed, 1
			Return
		}
		Else If (RegExMatch(Hotkey, "Numpad(.+?)", numKey))
		{
			If (numkey1 ~= "\d")
				typed .= numkey1
			Else
				typed .= effects[numKey1]
		}
		Else
			typed .= Hotkey
		matched := false
		For k, v In hotstrings
		{
			matchRegex := (v.mode == 1 ? "Oi)" : "") . (v.mode == 3 ? RegExReplace(v.trigger, "\$$", "") : "\Q" . v.trigger . "\E") . "$"
			If (v.mode == 3)
			{
				If (matchRegex ~= "^[^\s\)\(\\]+?\)")
					matchRegex := "O" . matchRegex
				Else
					matchRegex := "O)" . matchRegex
			}
			If (RegExMatch(typed, matchRegex, local$))
			{
				matched := true
				If (v.cond != "" && IsFunc(v.cond))
				{
					; If hotstring has a condition function.
					A_LoopCond := Func(v.cond)
					If (A_LoopCond.MinParams >= 1)
					{
						; If the function has atleast 1 parameters.
						A_LoopRetVal := A_LoopCond.(v.mode == 3 ? local$ : local$.Value(0))
					}
					Else
						A_LoopRetVal := A_LoopCond.()
					If (!A_LoopRetVal)
					{
						; If the function returns a non-true value.
						matched := false
						Continue
					}
				}
				If (v.clearTrigger)
					SendInput % "{BS " . StrLen(local$.Value(0)) . "}"	; Delete the trigger
				If (IsLabel(v.label))
				{
					$ := v.mode == 3 ? local$ : local$.Value(0)
					GoSub, % v.label
				}
				Else If (IsFunc(v.label))
				{
					callbackFunc := Func(v.label)
					If (callbackFunc.MinParams >= 1)
						callbackFunc.(v.mode == 3 ? local$ : local$.Value(0))
					Else
						callbackFunc.()
				}
				Else
				{
					toSend := v.label
					; Working out the backreferences
					Loop, % local$.Count()
						StringReplace, toSend, toSend, % "$" . A_Index, % local$.Value(A_index), All
					toSend := RegExReplace(toSend, "([!#\+\^\{\}])", "{$1}")	; Escape modifiers
					SendInput, %toSend%
				}
			}
		}
		If (matched)
			typed := ""
		Else If (StrLen(typed) > 350)
			StringTrimLeft, typed, typed, 200
	}
	Else
	{
		If (hotstrings.HasKey(trigger) && label == "")
		{
			; Removing a hotstring.
			hotstrings.remove(trigger)
		}
		Else
		{
			; Add to hotstrings object.
			hotstrings[trigger] := {"trigger" : trigger, "label":label, "mode":mode, "clearTrigger" : clearTrigger, "cond": cond}
		}
	}
	Return

	__hotstring:
	; This label is triggered every time a key is pressed.
	Hotstring("", "", "CALLBACK")
	Return
}