Function BIF_DECL

source/hotkey.cpp:2567–2755

BIF_DECL(BIF_Hotstring)
{
	aResultToken.symbol = SYM_STRING;
	aResultToken.marker = _T("");

	_f_param_string(name, 0);
	_f_param_string_opt(action, 1);
	_f_param_string_opt(onoff, 2);

	if (!_tcsicmp(name, _T("EndChars"))) // Equivalent to #Hotstring EndChars <action>
	{
		TokenSetResult(aResultToken, g_EndChars); // Return the old value.
		if (!ParamIndexIsOmitted(1))
			// There is some concern of a race condition with the hook thread, but since g_EndChars
			// has static storage duration and is therefore zero-initialized at startup (in particular,
			// the last char is always zero), the only consequence would be that some old end chars may
			// be used if a hotstring is evaluated during the tcslcpy() call.
			tcslcpy(g_EndChars, action, _countof(g_EndChars));
		return;
	}
	else if (!_tcsicmp(name, _T("MouseReset"))) // "MouseReset, true" seems more intuitive than "NoMouse, false"
	{
		bool previous_value = g_HSResetUponMouseClick;
		if (!ParamIndexIsOmitted(1))
		{
			g_HSResetUponMouseClick = ParamIndexToBOOL(1);
			if (g_HSResetUponMouseClick != previous_value && Hotstring::sEnabledCount) // No need if there aren't any hotstrings.
				Hotkey::ManifestAllHotkeysHotstringsHooks(); // Install the hook if needed, or uninstall if no longer needed.
		}
		aResultToken.symbol = SYM_INTEGER;
		aResultToken.value_int64 = previous_value;
		return;
	}
	else if (!_tcsicmp(name, _T("Reset")))
	{
		*g_HSBuf = '\0';
		g_HSBufLength = 0;
		return;
	}
	else if (aParamCount == 1 && *name != ':') // Equivalent to #Hotstring <name>
	{
		// TODO: Build string of current options and return it?
		bool unused_X_option; // 'X' option is required to be passed for each Hotstring() call, for clarity.
		Hotstring::ParseOptions(name, g_HSPriority, g_HSKeyDelay, g_HSSendMode, g_HSCaseSensitive
			, g_HSConformToCase, g_HSDoBackspace, g_HSOmitEndChar, g_HSSendRaw, g_HSEndCharRequired
			, g_HSDetectWhenInsideWord, g_HSDoReset, unused_X_option, g_SuspendExemptHS);
		return;
	}

	// Parse the hotstring name (this is similar to a section in LoadIncludedFile()):
	LPTSTR hotstring_start = NULL;
	LPTSTR hotstring_options = _T(""); // Set default as "no options were specified for this hotstring".
	if (name[0] == ':' && name[1])
	{
		if (name[1] != ':')
		{
			hotstring_options = name + 1; // Point it to the hotstring's option letters.
			// The following relies on the fact that options should never contain a literal colon.