0) {\n\t\tLPWSTR sBuf = sWChar.GetBufferSetLength(iLen);\n\t\tiLen = MultiByteToWideChar(CP_UTF8, 0, sUTF8, iChars, sBuf, iLen);\n\t\tsWChar.ReleaseBufferSetLength(sBuf[iLen - 1] ? iLen : iLen - 1);\n\t\treturn (iLen > 0) ? sWChar.GetString() : NULL;\n\t}\n\n\treturn *sUTF8 != 0 ? sWChar.GetString() : NULL;\n}\n\nLPCWSTR StringCharToWChar(LPCSTR sChar, CStringW &sWChar, int iChars/* = -1*/, UINT codepage/* = CP_ACP*/)\n{\n\tif (!sChar)\n\t\treturn NULL;\n\n\tsWChar.Empty();\n\tint iLen = MultiByteToWideChar(codepage, 0, sChar, iChars, NULL, 0);\n\tif (iLen > 0) {\n\t\tLPWSTR sBuf = sWChar.GetBufferSetLength(iLen);\n\t\tMultiByteToWideChar(codepage, 0, sChar, iChars, sBuf, iLen);\n\t\tsWChar.ReleaseBufferSetLength(sBuf[iLen - 1] ? iLen : iLen - 1);\n\t\treturn (iLen > 0) ? sWChar.GetString() : NULL;\n\t}\n\n\treturn (*sChar != 0) ? sWChar.GetString() : NULL;\n}\n\nLPCSTR StringWCharToUTF8(LPCWSTR sWChar, CStringA &sUTF8, int iChars/* = -1*/)\n{\n\tif (!sWChar)\n\t\treturn NULL;\n\n\tsUTF8.Empty();\n\tint iLen = WideCharToMultiByte(CP_UTF8, 0, sWChar, iChars, NULL, 0, NULL, NULL);\n\tif (iLen > 0) {\n\t\tLPSTR sBuf = sUTF8.GetBufferSetLength(iLen);\n\t\tWideCharToMultiByte(CP_UTF8, 0, sWChar, iChars, sBuf, iLen, NULL, NULL);\n\t\tsUTF8.ReleaseBufferSetLength(sBuf[iLen - 1] ? iLen : iLen - 1);\n\t\treturn (iLen > 0) ? sUTF8.GetString() : NULL;\n\t}\n\n\treturn (*sWChar != 0) ? sUTF8.GetString() : NULL;\n}\n\nLPCSTR StringCharToUTF8(LPCSTR sChar, CStringA &sUTF8, int iChars/* = -1*/, UINT codepage/* = CP_ACP*/)\n{\n\treturn StringWCharToUTF8(CStringWCharFromChar(sChar, iChars, codepage), sUTF8);\n}\n\nLPCSTR StringWCharToChar(LPCWSTR sWChar, CStringA &sChar, int iChars/* = -1*/, char chDef/* = '?'*/, UINT codepage/* = CP_ACP*/)\n{\n\tif (!sWChar)\n\t\treturn NULL;\n\n\tsChar.Empty();\n\tint iLen = WideCharToMultiByte(codepage, WC_NO_BEST_FIT_CHARS, sWChar, iChars, NULL, 0, &chDef, NULL);\n\tif (iLen > 0) {\n\t\tLPSTR sBuf = sChar.GetBufferSetLength(iLen);\n\t\tWideCharToMultiByte(codepage, WC_NO_BEST_FIT_CHARS, sWChar, iChars, sBuf, iLen, &chDef, NULL);\n\t\tsChar.ReleaseBufferSetLength(sBuf[iLen - 1] ? iLen : iLen - 1);\n\t\treturn (iLen > 0) ? sChar.GetString() : NULL;\n\t}\n\n\treturn (*sWChar != 0) ? sChar.GetString() : NULL;\n}\n\nLPCSTR StringUTF8ToChar(LPCSTR sUTF8, CStringA &sChar, int iChars/* = -1*/, char chDef/* = '?'*/, UINT codepage/* = CP_ACP*/)\n{\n\treturn StringWCharToChar(CStringWCharFromUTF8(sUTF8, iChars), sChar, iChars, chDef, codepage);\n}\n#endif\n\ntemplate <typename SRC_T, typename DEST_T>\nSRC_T _StringDummyConv(SRC_T sSrc, DEST_T &sDest, int iChars = -1)\n{\n\tif (!sSrc)\n\t\treturn NULL;\n\tif (iChars >= 0)\n\t\tsDest.SetString(sSrc, iChars);\n\telse\n\t\tsDest = sSrc;\n\treturn sDest;\n}\n\nLPCWSTR _StringDummyConvW(LPCWSTR sSrc, CStringW &sDest, int iChars/* = -1*/)\n{\n\treturn _StringDummyConv(sSrc, sDest, iChars);\n}\n\nLPCSTR _StringDummyConvA(LPCSTR sSrc, CStringA &sDest, int iChars/* = -1*/)\n{\n\treturn _StringDummyConv(sSrc, sDest, iChars);\n}\n"},"size":{"kind":"number","value":3178,"string":"3,178"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":89,"string":"89"},"avg_line_length":{"kind":"number","value":33.60674157303371,"string":"33.606742"},"max_line_length":{"kind":"number","value":128,"string":"128"},"alphanum_fraction":{"kind":"number","value":0.703486477680026,"string":"0.703486"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_githubcode":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11072,"cells":{"id":{"kind":"number","value":16059,"string":"16,059"},"file_name":{"kind":"string","value":"script_autoit.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_autoit.cpp"},"content":{"kind":"string","value":"///////////////////////////////////////////////////////////////////////////////\n//\n// AutoIt\n//\n// Copyright (C)1999-2006:\n//\t\t- Jonathan Bennett <jon@hiddensoft.com>\n//\t\t- Others listed at https://www.autoitscript.com/autoit3/docs/credits.htm\n// - Chris Mallett (support@autohotkey.com): various enhancements and\n// adaptation of this file's functions to interface with AutoHotkey.\n//\n// This program is free software; you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation; either version 2 of the License, or\n// (at your option) any later version.\n//\n///////////////////////////////////////////////////////////////////////////////\n\n#include \"stdafx.h\" // pre-compiled headers\n//#include <winsock.h> // for WSADATA. This also requires wsock32.lib to be linked in.\n#include <winsock2.h>\n#include <tlhelp32.h> // For the ProcessExist routines.\n#include <wininet.h> // For Download().\n#include \"script.h\"\n#include \"globaldata.h\"\n#include \"window.h\" // For ControlExist().\n#include \"application.h\" // For SLEEP_WITHOUT_INTERRUPTION and MsgSleep().\n#include \"script_func_impl.h\"\n#include \"abi.h\"\n#include <Psapi.h>\n\n\nResultType Script::DoRunAs(LPTSTR aCommandLine, LPCTSTR aWorkingDir, bool aDisplayErrors, WORD aShowWindow\n\t, PROCESS_INFORMATION &aPI, bool &aSuccess // Output parameters we set for caller, but caller must have initialized aSuccess to false.\n\t, HANDLE &aNewProcess, DWORD &aLastError) // Same, but initialize to NULL.\n{\n\ttypedef BOOL (WINAPI *MyCreateProcessWithLogonW)(\n\t\tLPCWSTR lpUsername, // user's name\n\t\tLPCWSTR lpDomain, // user's domain\n\t\tLPCWSTR lpPassword, // user's password\n\t\tDWORD dwLogonFlags, // logon option\n\t\tLPCWSTR lpApplicationName, // executable module name\n\t\tLPWSTR lpCommandLine, // command-line string\n\t\tDWORD dwCreationFlags, // creation flags\n\t\tLPVOID lpEnvironment, // new environment block\n\t\tLPCWSTR lpCurrentDirectory, // current directory name\n\t\tLPSTARTUPINFOW lpStartupInfo, // startup information\n\t\tLPPROCESS_INFORMATION lpProcessInfo // process information\n\t\t);\n\t// Set up wide char version that we need for CreateProcessWithLogon\n\t// init structure for running programs (wide char version)\n\tSTARTUPINFOW wsi = {0};\n\twsi.cb\t\t\t= sizeof(STARTUPINFOW);\n\twsi.dwFlags\t\t= STARTF_USESHOWWINDOW;\n\twsi.wShowWindow = aShowWindow;\n\t// The following are left initialized to 0/NULL (initialized earlier above):\n\t//wsi.lpReserved = NULL;\n\t//wsi.lpDesktop\t= NULL;\n\t//wsi.lpTitle = NULL;\n\t//wsi.cbReserved2 = 0;\n\t//wsi.lpReserved2 = NULL;\n\n#ifndef UNICODE\n\t// Convert to wide character format:\n\tWCHAR command_line_wide[LINE_SIZE], working_dir_wide[MAX_PATH];\n\tToWideChar(aCommandLine, command_line_wide, LINE_SIZE); // Dest. size is in wchars, not bytes.\n\tif (aWorkingDir && *aWorkingDir)\n\t\tToWideChar(aWorkingDir, working_dir_wide, MAX_PATH); // Dest. size is in wchars, not bytes.\n\telse\n\t\t*working_dir_wide = 0; // wide-char terminator.\n\n\tif (lpfnDLLProc(mRunAsUser, mRunAsDomain, mRunAsPass, LOGON_WITH_PROFILE, 0\n\t\t, command_line_wide, 0, 0, *working_dir_wide ? working_dir_wide : NULL, &wsi, &aPI))\n#else\n\tif (CreateProcessWithLogonW(mRunAsUser, mRunAsDomain, mRunAsPass, LOGON_WITH_PROFILE, 0\n\t\t, aCommandLine, 0, 0, aWorkingDir && *aWorkingDir ? aWorkingDir : NULL, &wsi, &aPI))\n#endif\n\t{\n\t\taSuccess = true;\n\t\tif (aPI.hThread)\n\t\t\tCloseHandle(aPI.hThread); // Required to avoid memory leak.\n\t\taNewProcess = aPI.hProcess;\n\t}\n\telse\n\t\taLastError = GetLastError(); // Caller will use this to get an error message and set g->LastError if needed.\n\treturn OK;\n}\n\n\n\nbif_impl void RunAs(optl<StrArg> aUser, optl<StrArg> aPass, optl<StrArg> aDomain)\n{\n\tStringTCharToWChar(aUser.value_or_empty(), g_script.mRunAsUser);\n\tStringTCharToWChar(aPass.value_or_empty(), g_script.mRunAsPass);\n\tStringTCharToWChar(aDomain.value_or_empty(), g_script.mRunAsDomain);\n}\n\n\n\nbif_impl FResult SysGetIPAddresses(IObject *&aRetVal)\n{\n\t// aaa.bbb.ccc.ddd = 15, but allow room for larger IP's in the future.\n\t#define IP_ADDRESS_SIZE 32 // The maximum size of any of the strings we return, including terminator.\n\n\tauto addresses = Array::Create();\n\tif (!addresses)\n\t\treturn FR_E_OUTOFMEM;\n\n\tWSADATA wsadata;\n\tif (WSAStartup(MAKEWORD(1, 1), &wsadata)) // Failed (it returns 0 on success).\n\t{\n\t\taRetVal = addresses;\n\t\treturn OK;\n\t}\n\n\tchar host_name[256];\n\tHOSTENT *lpHost = nullptr;\n\t// gethostname would probably only fail in exceptional circumstances, such as a damaged OS install\n\t// where networking is very broken. Running in safe mode without networking was confirmed to cause\n\t// gethostbyname to return NULL.\n\tif (gethostname(host_name, _countof(host_name)) == 0)\n\t\tlpHost = gethostbyname(host_name);\n\n\tif (lpHost)\n\tfor (int i = 0; lpHost->h_addr_list[i]; ++i)\n\t{\n\t\tIN_ADDR inaddr;\n\t\tmemcpy(&inaddr, lpHost->h_addr_list[i], 4);\n#ifdef UNICODE\n\t\tCStringTCharFromChar addr_buf(inet_ntoa(inaddr));\n\t\tLPTSTR addr_str = const_cast<LPTSTR>(addr_buf.GetString());\n#else\n\t\tLPTSTR addr_str = inet_ntoa(inaddr);\n#endif\n\t\tif (!addresses->Append(addr_str))\n\t\t{\n\t\t\taddresses->Release();\n\t\t\tWSACleanup();\n\t\t\treturn FR_E_OUTOFMEM;\n\t\t}\n\t}\n\n\tWSACleanup();\n\taRetVal = addresses;\n\treturn OK;\n}\n\n\n\nBIV_DECL_R(BIV_IsAdmin)\n{\n\tbool result = false; // Default.\n\tSC_HANDLE h = OpenSCManager(NULL, NULL, SC_MANAGER_LOCK);\n\tif (h)\n\t{\n\t\tSC_LOCK lock = LockServiceDatabase(h);\n\t\tif (lock)\n\t\t{\n\t\t\tUnlockServiceDatabase(lock);\n\t\t\tresult = true; // Current user is admin.\n\t\t}\n\t\telse\n\t\t{\n\t\t\tDWORD lastErr = GetLastError();\n\t\t\tif (lastErr == ERROR_SERVICE_DATABASE_LOCKED)\n\t\t\t\tresult = true; // Current user is admin.\n\t\t}\n\t\tCloseServiceHandle(h);\n\t}\n\t_f_return_b(result);\n}\n\n\n\nbif_impl FResult PixelGetColor(int aX, int aY, optl<StrArg> aMode, StrRet &aRetVal)\n{\n\tLPTSTR buf = aRetVal.CallerBuf();\n\taRetVal.SetTemp(buf, 8);\n\t\n\tauto aOptions = aMode.value_or_empty();\n\n\tif (tcscasestr(aOptions, _T(\"Slow\"))) // New mode for v1.0.43.10. Takes precedence over Alt mode.\n\t{\n\t\treturn PixelSearch(nullptr, nullptr, nullptr, aX, aY, aX, aY, 0, 0, buf); // It takes care of setting the return value.\n\t}\n\n\tCoordToScreen(aX, aY, COORD_MODE_PIXEL);\n\t\n\tbool use_alt_mode = tcscasestr(aOptions, _T(\"Alt\")) != NULL; // New mode for v1.0.43.10: Two users reported that CreateDC works better in certain windows such as SciTE, at least one some systems.\n\tHDC hdc = use_alt_mode ? CreateDC(_T(\"DISPLAY\"), NULL, NULL, NULL) : GetDC(NULL);\n\tif (!hdc)\n\t\treturn FR_E_WIN32;\n\n\t// Assign the value as an 32-bit int to match Window Spy reports color values.\n\t// Update for v1.0.21: Assigning in hex format seems much better, since it's easy to\n\t// look at a hex BGR value to get some idea of the hue. In addition, the result\n\t// is zero padded to make it easier to convert to RGB and more consistent in\n\t// appearance:\n\tCOLORREF color = GetPixel(hdc, aX, aY);\n\tif (use_alt_mode)\n\t\tDeleteDC(hdc);\n\telse\n\t\tReleaseDC(NULL, hdc);\n\n\t_stprintf(buf, _T(\"0x%06X\"), bgr_to_rgb(color));\n\treturn OK;\n}\n\n\n\nbif_impl FResult MenuSelect(ExprTokenType *aWinTitle, optl<StrArg> aWinText, StrArg aMenu\n\t, optl<StrArg> a1, optl<StrArg> a2, optl<StrArg> a3, optl<StrArg> a4, optl<StrArg> a5, optl<StrArg> a6\n\t, optl<StrArg> aExcludeTitle, optl<StrArg> aExcludeText)\n{\n\tHWND target_window;\n\tDETERMINE_TARGET_WINDOW;\n\t\n\tLPCTSTR names[] { aMenu, a1.value_or_null(), a2.value_or_null(), a3.value_or_null(), a4.value_or_null(), a5.value_or_null(), a6.value_or_null() };\n\tint name_index = 0, name_count = 0;\n\t// Count up to the last present name parameter.\n\tfor (int i = 0; i < _countof(names); ++i)\n\t\tif (names[i])\n\t\t\tname_count = i + 1;\n\t// Any omitted parameters preceding name_count will be detected by the main loop as invalid.\n\n\tUINT message = WM_COMMAND;\n\tHMENU hMenu;\n\tif (!_tcsicmp(names[0], _T(\"0&\")))\n\t{\n\t\thMenu = GetSystemMenu(target_window, FALSE);\n\t\tname_index += 1;\n\t\tmessage = WM_SYSCOMMAND;\n\t}\n\telse\n\t\thMenu = GetMenu(target_window);\n\tif (!hMenu) // Window has no menu bar.\n\t\treturn FError(ERR_WINDOW_HAS_NO_MENU, nullptr, ErrorPrototype::Target);\n\n\tint menu_item_count = GetMenuItemCount(hMenu);\n\t//if (menu_item_count < 1) // Menu bar has no menus.\n\t//\tgoto error;\n\t\n#define MENU_ITEM_IS_SUBMENU 0xFFFFFFFF\n#define UPDATE_MENU_VARS(menu_pos) \\\nmenu_id = GetMenuItemID(hMenu, menu_pos);\\\nif (menu_id == MENU_ITEM_IS_SUBMENU)\\\n\tmenu_item_count = GetMenuItemCount(hMenu = GetSubMenu(hMenu, menu_pos));\\\nelse\\\n{\\\n\tmenu_item_count = 0;\\\n\thMenu = NULL;\\\n}\n\n\tUINT menu_id = MENU_ITEM_IS_SUBMENU;\n\tTCHAR menu_text[1024];\n\tbool match_found;\n\tsize_t this_menu_param_length, menu_text_length;\n\tint pos, target_menu_pos;\n\tLPCTSTR this_menu_param = nullptr;\n\n\tfor ( ; name_index < name_count; ++name_index)\n\t{\n\t\tif (!hMenu) // The nesting of submenus ended prior to the end of the list of menu search terms.\n\t\t\tbreak;\n\t\tthis_menu_param = names[name_index];\n\t\tif (!this_menu_param || !*this_menu_param)\n\t\t\tbreak;\n\n\t\tthis_menu_param_length = _tcslen(this_menu_param);\n\t\ttarget_menu_pos = (this_menu_param[this_menu_param_length - 1] == '&') ? ATOI(this_menu_param) - 1 : -1;\n\t\tif (target_menu_pos > -1)\n\t\t{\n\t\t\tif (target_menu_pos >= menu_item_count) // Invalid menu position (doesn't exist).\n\t\t\t\tbreak;\n\t\t\tUPDATE_MENU_VARS(target_menu_pos)\n\t\t}\n\t\telse // Searching by text rather than numerical position.\n\t\t{\n\t\t\tfor (match_found = false, pos = 0; pos < menu_item_count; ++pos)\n\t\t\t{\n\t\t\t\tmenu_text_length = GetMenuString(hMenu, pos, menu_text, _countof(menu_text) - 1, MF_BYPOSITION);\n\t\t\t\t// v1.0.43.03: It's debatable, but it seems best to support locale's case insensitivity for\n\t\t\t\t// menu items, since menu names tend to adapt to the user's locale. By contrast, things\n\t\t\t\t// like process names (in the Process command) do not tend to change, so it seems best to\n\t\t\t\t// have them continue to use stricmp(): 1) avoids breaking existing scripts; 2) provides\n\t\t\t\t// consistent behavior across multiple locales; 3) performance.\n\t\t\t\tmatch_found = !lstrcmpni(menu_text // This call is basically a strnicmp() that obeys locale.\n\t\t\t\t\t, menu_text_length > this_menu_param_length ? this_menu_param_length : menu_text_length\n\t\t\t\t\t, this_menu_param, this_menu_param_length);\n\t\t\t\t//match_found = strcasestr(menu_text, this_menu_param);\n\t\t\t\tTCHAR *cpamp;\n\t\t\t\tif (!match_found && (cpamp = _tcschr(menu_text, '&')))\n\t\t\t\t{\n\t\t\t\t\t// Try again to find a match, this time without the ampersands used to indicate a menu item's\n\t\t\t\t\t// shortcut key. One might assume that only the first & needs to be removed, but the actual\n\t\t\t\t\t// behaviour confirmed on Windows 10.0.19041 was:\n\t\t\t\t\t// - Only every second & in a series of consecutive &&s was kept.\n\t\t\t\t\t// - Only the *first* &-letter was usable as a shortcut key.\n\t\t\t\t\t// - Only the *last* & caused an underline.\n\t\t\t\t\tfor (TCHAR *cplit = cpamp; ; ++cpamp, ++cplit)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (*cpamp == '&')\n\t\t\t\t\t\t\t++cpamp; // Skip this '&' but copy the next character unconditionally, even if it is '&'.\n\t\t\t\t\t\t*cplit = *cpamp;\n\t\t\t\t\t\tif (!*cpamp)\n\t\t\t\t\t\t\tbreak; // Only after copying, so menu_text is null-terminated at the correct position (cpw).\n\t\t\t\t\t}\n\t\t\t\t\tmenu_text_length = _tcslen(menu_text);\n\t\t\t\t\tmatch_found = !lstrcmpni(menu_text // This call is basically a strnicmp() that obeys locale.\n\t\t\t\t\t\t, menu_text_length > this_menu_param_length ? this_menu_param_length : menu_text_length\n\t\t\t\t\t\t, this_menu_param, this_menu_param_length);\n\t\t\t\t\t//match_found = strcasestr(menu_text, this_menu_param);\n\t\t\t\t}\n\t\t\t\tif (match_found)\n\t\t\t\t{\n\t\t\t\t\tUPDATE_MENU_VARS(pos)\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t} // inner for()\n\t\t\tif (!match_found) // The search hierarchy (nested menus) specified in the params could not be found.\n\t\t\t\tbreak;\n\t\t} // else\n\t} // outer for()\n\n\tif (name_index < name_count)\n\t\treturn FR_E_ARG(2 + name_index);\n\t// This would happen if the outer loop above had zero iterations due to aMenu1 being NULL or blank,\n\t// or if the caller specified a submenu as the target (which doesn't seem valid since an app would\n\t// never expect to ever receive a message for a submenu?):\n\tif (menu_id == MENU_ITEM_IS_SUBMENU)\n\t\treturn FR_E_ARG(2 + name_count - 1);\n\n\t// Since the above didn't return, the specified search hierarchy was completely found.\n\tPostMessage(target_window, message, (WPARAM)menu_id, 0);\n\treturn OK;\n}\n\n\n\nbif_impl FResult ControlSetChecked(int aValue, CONTROL_PARAMETERS_DECL)\n{\n\tif (aValue < -1 || aValue > 1)\n\t\treturn FR_E_ARG(0);\n\tDETERMINE_TARGET_CONTROL2;\n\tDWORD_PTR dwResult;\n\tif (aValue != -1)\n\t{\n\t\tif (!SendMessageTimeout(control_window, BM_GETCHECK, 0, 0, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\t\treturn FR_E_WIN32;\n\t\tif (dwResult == (aValue ? BST_CHECKED : BST_UNCHECKED)) // It's already in the right state, so don't press it.\n\t\t\treturn OK;\n\t}\n\t// MSDN docs for BM_CLICK (and au3 author says it applies to this situation also):\n\t// \"If the button is in a dialog box and the dialog box is not active, the BM_CLICK message\n\t// might fail. To ensure success in this situation, call the SetActiveWindow function to activate\n\t// the dialog box before sending the BM_CLICK message to the button.\"\n\tATTACH_THREAD_INPUT\n\tSetActiveWindow(target_window == control_window ? GetNonChildParent(control_window) : target_window); // v1.0.44.13: Fixed to allow for the fact that target_window might be the control itself (e.g. via ahk_id %ControlHWND%).\n\tRECT rect;\n\tif (!GetWindowRect(control_window, &rect))\t// au3: Code to primary click the centre of the control\n\t\trect.bottom = rect.left = rect.right = rect.top = 0;\n\tauto lparam = MAKELPARAM((rect.right - rect.left) / 2, (rect.bottom - rect.top) / 2);\n\tFResult fr = (\n\t\t\tPostMessage(control_window, WM_LBUTTONDOWN, MK_LBUTTON, lparam) &&\n\t\t\tPostMessage(control_window, WM_LBUTTONUP, 0, lparam)\n\t\t) ? OK : FR_E_WIN32(GetLastError());\n\tDETACH_THREAD_INPUT\n\tDoControlDelay;\n\treturn fr;\n}\n\n\n\nbif_impl FResult ControlGetChecked(CONTROL_PARAMETERS_DECL, BOOL &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tDWORD_PTR dwResult;\n\tif (!SendMessageTimeout(control_window, BM_GETCHECK, 0, 0, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\taRetVal = dwResult == BST_CHECKED;\n\treturn OK;\n}\n\n\n\nFResult WinSetStyle(StrArg aValue, CONTROL_PARAMETERS_DECL_OPT, int style_index);\n\nbif_impl FResult ControlSetStyle(StrArg aValue, CONTROL_PARAMETERS_DECL)\n{\n\treturn WinSetStyle(aValue, &CONTROL_PARAMETERS, GWL_STYLE);\n}\n\nbif_impl FResult ControlSetExStyle(StrArg aValue, CONTROL_PARAMETERS_DECL)\n{\n\treturn WinSetStyle(aValue, &CONTROL_PARAMETERS, GWL_EXSTYLE);\n}\n\n\n\nstatic FResult ControlGetLong(CONTROL_PARAMETERS_DECL, UINT &aRetVal, int nIndex)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\taRetVal = GetWindowLong(control_window, nIndex);\n\treturn OK;\n}\n\nbif_impl FResult ControlGetStyle(CONTROL_PARAMETERS_DECL, UINT &aRetVal)\n{\n\treturn ControlGetLong(CONTROL_PARAMETERS, aRetVal, GWL_STYLE);\n}\n\nbif_impl FResult ControlGetExStyle(CONTROL_PARAMETERS_DECL, UINT &aRetVal)\n{\n\treturn ControlGetLong(CONTROL_PARAMETERS, aRetVal, GWL_EXSTYLE);\n}\n\n\n\nstatic FResult ControlShowDropDown(CONTROL_PARAMETERS_DECL, BOOL aShow)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tDWORD_PTR dwResult;\n\t// CB_SHOWDROPDOWN: Although the return value (dwResult) is always TRUE, SendMessageTimeout()\n\t// will return failure if it times out:\n\tif (!SendMessageTimeout(control_window, CB_SHOWDROPDOWN\n\t\t, (WPARAM)aShow, 0, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\tDoControlDelay;\n\treturn OK;\n}\n\nbif_impl FResult ControlShowDropDown(CONTROL_PARAMETERS_DECL)\n{\n\treturn ControlShowDropDown(CONTROL_PARAMETERS, TRUE);\n}\n\nbif_impl FResult ControlHideDropDown(CONTROL_PARAMETERS_DECL)\n{\n\treturn ControlShowDropDown(CONTROL_PARAMETERS, FALSE);\n}\n\n\n\nenum IndexControlType {\n\tIC_INVALID = 0,\n\tIC_COMBO,\n\tIC_LIST,\n\tIC_TAB\n};\n\nstatic IndexControlType GetIndexControlType(HWND aControl, FResult &fr, bool aAllowTab = false)\n{\n\tTCHAR classname[256 + 1];\n\tGetClassName(aControl, classname, _countof(classname));\n\tif (tcscasestr(classname, _T(\"Combo\")))\n\t\treturn IC_COMBO;\n\telse if (tcscasestr(classname, _T(\"List\")))\n\t\treturn IC_LIST;\n\telse if (aAllowTab && tcscasestr(classname, _T(\"Tab\")))\n\t\treturn IC_TAB;\n\tfr = FError(ERR_GUI_NOT_FOR_THIS_TYPE, classname, ErrorPrototype::Target);\n\treturn IC_INVALID;\n}\n\n\n\nbif_impl FResult ControlAddItem(StrArg aItem, CONTROL_PARAMETERS_DECL, INT_PTR &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr))\n\t{\n\tcase IC_COMBO: msg = CB_ADDSTRING; break;\n\tcase IC_LIST: msg = LB_ADDSTRING; break;\n\tdefault: return fr;\n\t}\n\tDWORD_PTR dwResult;\n\tif (!SendMessageTimeout(control_window, msg, 0, (LPARAM)aItem, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\tif (dwResult == CB_ERR || dwResult == CB_ERRSPACE) // General error or insufficient space to store it.\n\t\t// CB_ERR == LB_ERR\n\t\treturn FR_E_FAILED;\n\tDoControlDelay;\n\taRetVal = dwResult + 1; // Return the one-based index of the new item.\n\treturn OK;\n}\n\n\n\nbif_impl FResult ControlDeleteItem(INT_PTR aIndex, CONTROL_PARAMETERS_DECL)\n{\n\tif (--aIndex < 0)\n\t\treturn FR_E_ARG(0);\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr))\n\t{\n\tcase IC_COMBO: msg = CB_DELETESTRING; break;\n\tcase IC_LIST: msg = LB_DELETESTRING; break;\n\tdefault: return fr;\n\t}\n\tDWORD_PTR dwResult;\n\tif (!SendMessageTimeout(control_window, msg, (WPARAM)aIndex, 0, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\tif (dwResult == CB_ERR) // CB_ERR == LB_ERR\n\t\treturn FR_E_FAILED;\n\tDoControlDelay;\n\treturn OK;\n}\n\n\n\nstatic FResult ControlNotifyParent(HWND control_window, UINT x_msg, UINT y_msg)\n{\n\tHWND immediate_parent;\n\tif ( !(immediate_parent = GetParent(control_window)) )\n\t\treturn FR_E_WIN32;\n\tSetLastError(0); // Must be done to differentiate between success and failure when control has ID 0.\n\tauto control_id = GetDlgCtrlID(control_window);\n\tif (!control_id && GetLastError()) // Both conditions must be checked (see above).\n\t\treturn FR_E_WIN32; // Avoid sending the notification in case some other control has ID 0.\n\t// Proceed even if control_id == 0, since some applications are known to\n\t// utilize the notification in that case (e.g. Notepad's Save As dialog).\n\tDWORD_PTR dwResult;\n\tif (!SendMessageTimeout(immediate_parent, WM_COMMAND, (WPARAM)MAKELONG(control_id, x_msg)\n\t\t, (LPARAM)control_window, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\tif (!SendMessageTimeout(immediate_parent, WM_COMMAND, (WPARAM)MAKELONG(control_id, y_msg)\n\t\t, (LPARAM)control_window, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\tDoControlDelay;\n\treturn OK;\n}\n\n\n\nbif_impl FResult ControlChooseIndex(INT_PTR aIndex, CONTROL_PARAMETERS_DECL)\n{\n\tif (--aIndex < -1)\n\t\treturn FR_E_ARG(0);\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg, x_msg, y_msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr, true))\n\t{\n\tcase IC_COMBO:\n\t\tmsg = CB_SETCURSEL;\n\t\tx_msg = CBN_SELCHANGE;\n\t\ty_msg = CBN_SELENDOK;\n\t\tbreak;\n\tcase IC_LIST:\n\t\tif (GetWindowLong(control_window, GWL_STYLE) & (LBS_EXTENDEDSEL|LBS_MULTIPLESEL))\n\t\t\tmsg = LB_SETSEL;\n\t\telse // single-select listbox\n\t\t\tmsg = LB_SETCURSEL;\n\t\tx_msg = LBN_SELCHANGE;\n\t\ty_msg = LBN_DBLCLK;\n\t\tbreak;\n\tcase IC_TAB:\n\t\tif (aIndex < 0)\n\t\t\treturn FR_E_ARG(0);\n\t\treturn ControlSetTab(control_window, (DWORD)aIndex);\n\tdefault:\n\t\treturn fr;\n\t}\n\n\tDWORD_PTR dwResult;\n\tif (msg == LB_SETSEL) // Multi-select, so use the cumulative method.\n\t{\n\t\tif (!SendMessageTimeout(control_window, msg, aIndex != -1, aIndex, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\t\treturn FR_E_WIN32;\n\t}\n\telse // ComboBox or single-select ListBox.\n\t\tif (!SendMessageTimeout(control_window, msg, aIndex, 0, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\t\treturn FR_E_WIN32;\n\tif (dwResult == CB_ERR && aIndex != -1) // CB_ERR == LB_ERR\n\t\treturn FR_E_FAILED;\n\n\treturn ControlNotifyParent(control_window, x_msg, y_msg);\n}\n\n\n\nbif_impl FResult ControlChooseString(StrArg aValue, CONTROL_PARAMETERS_DECL, INT_PTR &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg, x_msg, y_msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr))\n\t{\n\tcase IC_COMBO:\n\t\tmsg = CB_SELECTSTRING;\n\t\tx_msg = CBN_SELCHANGE;\n\t\ty_msg = CBN_SELENDOK;\n\t\tbreak;\n\tcase IC_LIST:\n\t\tif (GetWindowLong(control_window, GWL_STYLE) & (LBS_EXTENDEDSEL|LBS_MULTIPLESEL))\n\t\t\tmsg = LB_FINDSTRING;\n\t\telse // single-select listbox\n\t\t\tmsg = LB_SELECTSTRING;\n\t\tx_msg = LBN_SELCHANGE;\n\t\ty_msg = LBN_DBLCLK;\n\t\tbreak;\n\tdefault:\n\t\treturn fr;\n\t}\n\tDWORD_PTR dwResult, item_index;\n\tif (msg == LB_FINDSTRING) // Multi-select ListBox (LB_SELECTSTRING is not supported by these).\n\t{\n\t\tif (!SendMessageTimeout(control_window, msg, -1, (LPARAM)aValue, SMTO_ABORTIFHUNG, 2000, &item_index))\n\t\t\treturn FR_E_WIN32;\n\t\tif (item_index == LB_ERR)\n\t\t\treturn FR_E_FAILED;\n\t\tif (!SendMessageTimeout(control_window, LB_SETSEL, TRUE, item_index, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\t\treturn FR_E_WIN32;\n\t\tif (dwResult == LB_ERR)\n\t\t\treturn FR_E_FAILED;\n\t}\n\telse // ComboBox or single-select ListBox.\n\t{\n\t\tif (!SendMessageTimeout(control_window, msg, -1, (LPARAM)aValue, SMTO_ABORTIFHUNG, 2000, &item_index))\n\t\t\treturn FR_E_WIN32;\n\t\tif (item_index == CB_ERR) // CB_ERR == LB_ERR\n\t\t\treturn FR_E_FAILED;\n\t}\n\taRetVal = item_index + 1; // Return the index chosen. Might have some use if the string was ambiguous.\n\treturn ControlNotifyParent(control_window, x_msg, y_msg);\n}\n\n\n\nbif_impl FResult EditPaste(StrArg aValue, CONTROL_PARAMETERS_DECL)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tDWORD_PTR dwResult;\n\tif (!SendMessageTimeout(control_window, EM_REPLACESEL, TRUE, (LPARAM)aValue, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\tDoControlDelay;\n\treturn OK;\n}\n\n\n\nbif_impl FResult ControlFindItem(StrArg aString, CONTROL_PARAMETERS_DECL, INT_PTR &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr))\n\t{\n\tcase IC_COMBO: msg = CB_FINDSTRINGEXACT; break;\n\tcase IC_LIST: msg = LB_FINDSTRINGEXACT; break;\n\tdefault: return fr;\n\t}\n\tDWORD_PTR index;\n\tif (!SendMessageTimeout(control_window, msg, -1, (LPARAM)aString, SMTO_ABORTIFHUNG, 2000, &index))\n\t\treturn FR_E_WIN32;\n\tif (index == CB_ERR) // CBERR == LB_ERR\n\t\treturn FR_E_FAILED;\n\taRetVal = index + 1;\n\treturn OK;\n}\n\n\n\nbif_impl FResult ControlGetIndex(CONTROL_PARAMETERS_DECL, INT_PTR &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr, true))\n\t{\n\tcase IC_COMBO: msg = CB_GETCURSEL; break;\n\tcase IC_LIST: msg = LB_GETCURSEL; break;\n\tcase IC_TAB: msg = TCM_GETCURSEL; break;\n\tdefault: return fr;\n\t}\n\tDWORD_PTR index;\n\tif (!SendMessageTimeout(control_window, msg, 0, 0, SMTO_ABORTIFHUNG, 2000, &index))\n\t\treturn FR_E_WIN32;\n\taRetVal = index + 1;\n\treturn OK;\n}\n\n\n\nbif_impl FResult ControlGetChoice(CONTROL_PARAMETERS_DECL, StrRet &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg, x_msg, y_msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr, true))\n\t{\n\tcase IC_COMBO:\n\t\tmsg = CB_GETCURSEL;\n\t\tx_msg = CB_GETLBTEXTLEN;\n\t\ty_msg = CB_GETLBTEXT;\n\t\tbreak;\n\tcase IC_LIST:\n\t\tmsg = LB_GETCURSEL;\n\t\tx_msg = LB_GETTEXTLEN;\n\t\ty_msg = LB_GETTEXT;\n\t\tbreak;\n\tdefault:\n\t\treturn fr;\n\t}\n\tDWORD_PTR index, estimated_length, actual_length;\n\tif (!SendMessageTimeout(control_window, msg, 0, 0, SMTO_ABORTIFHUNG, 2000, &index))\n\t\treturn FR_E_WIN32;\n\tif (index == CB_ERR) // CBERR == LB_ERR\n\t\treturn FR_E_FAILED;\n\tif (!SendMessageTimeout(control_window, x_msg, (WPARAM)index, 0, SMTO_ABORTIFHUNG, 2000, &estimated_length))\n\t\treturn FR_E_WIN32;\n\tif (estimated_length == CB_ERR)\n\t\treturn FR_E_FAILED;\n\t// In unusual cases, MSDN says the indicated length might be longer than it actually winds up\n\t// being when the item's text is retrieved.\n\tauto buf = aRetVal.Alloc(estimated_length);\n\tif (!buf)\n\t\treturn FR_E_OUTOFMEM;\n\tif (!SendMessageTimeout(control_window, y_msg, (WPARAM)index, (LPARAM)buf, SMTO_ABORTIFHUNG, 2000, &actual_length))\n\t\treturn FR_E_WIN32;\n\tif (actual_length > estimated_length) // Guard against bogus return values. Also covers actual_length == CB_ERR due to unsigned type.\n\t\treturn FR_E_FAILED;\n\taRetVal.SetLength(actual_length); // Update to actual vs. estimated length.\n\treturn OK;\n}\n\n\n\nstatic FResult ControlGetItems(Array *items, DWORD_PTR item_count, HWND control_window, UINT x_msg, UINT y_msg)\n{\n\tDWORD_PTR length, u, item_length;\n\t// Calculate the required buffer size for the largest string.\n\tfor (length = 0, u = 0; u < item_count; ++u)\n\t{\n\t\tif (!SendMessageTimeout(control_window, x_msg, u, 0, SMTO_ABORTIFHUNG, 5000, &item_length)\n\t\t\t|| item_length == LB_ERR) // Note that item_length is legitimately zero for a blank item in the list.\n\t\t\treturn FR_E_FAILED;\n\t\tif (length < item_length)\n\t\t\tlength = item_length;\n\t}\n\t// In unusual cases, MSDN says the indicated length might be longer than it actually winds up\n\t// being when the item's text is retrieved.\n\t++length; // To include the null-terminator.\n\t// Could use alloca when length is within a safe limit, but it seems unlikely to help\n\t// performance much since the bottleneck is probably in message passing between processes.\n\t// Although length is only the size of the largest item, not the total of all items,\n\t// I don't know how large an item can be, so it's safest to just use malloc().\n\tLPTSTR dyn_buf;\n\tif ( !(dyn_buf = tmalloc(length)) )\n\t\treturn FR_E_OUTOFMEM;\n\tfor (u = 0; u < item_count; ++u)\n\t{\n\t\tif (!SendMessageTimeout(control_window, y_msg, (WPARAM)u, (LPARAM)dyn_buf, SMTO_ABORTIFHUNG, 5000, &item_length)\n\t\t\t|| item_length > length) // Guard against bogus return values. Also covers item_length == CB_ERR due to unsigned type.\n\t\t\tbreak;\n\t\tdyn_buf[item_length] = '\\0'; // Play it safe.\n\t\tif (!items->Append(dyn_buf))\n\t\t\tbreak;\n\t}\n\tfree(dyn_buf);\n\treturn u < item_count ? FR_E_FAILED : OK;\n}\n\nbif_impl FResult ControlGetItems(CONTROL_PARAMETERS_DECL, IObject *&aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tUINT msg, x_msg, y_msg;\n\tFResult fr = FAIL;\n\tswitch (GetIndexControlType(control_window, fr, true))\n\t{\n\tcase IC_COMBO:\n\t\tmsg = CB_GETCOUNT;\n\t\tx_msg = CB_GETLBTEXTLEN;\n\t\ty_msg = CB_GETLBTEXT;\n\t\tbreak;\n\tcase IC_LIST:\n\t\tmsg = LB_GETCOUNT;\n\t\tx_msg = LB_GETTEXTLEN;\n\t\ty_msg = LB_GETTEXT;\n\t\tbreak;\n\tdefault:\n\t\treturn fr;\n\t}\n\tDWORD_PTR item_count;\n\tif (!SendMessageTimeout(control_window, msg, 0, 0, SMTO_ABORTIFHUNG, 5000, &item_count))\n\t\treturn FR_E_WIN32;\n\tif (item_count == LB_ERR) // There was a problem getting the count.\n\t\treturn FR_E_FAILED;\n\tArray *items;\n\tif ( !(items = Array::Create()) )\n\t\treturn FR_E_OUTOFMEM;\n\tfr = ControlGetItems(items, item_count, control_window, x_msg, y_msg);\n\tif (fr != OK)\n\t{\n\t\titems->Release();\n\t\treturn fr;\n\t}\n\taRetVal = items;\n\treturn OK;\n}\n\n\n\nbif_impl FResult EditGetLineCount(CONTROL_PARAMETERS_DECL, UINT_PTR &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\t// MSDN: \"If the control has no text, the return value is 1. The return value will never be less than 1.\"\n\tif (!SendMessageTimeout(control_window, EM_GETLINECOUNT, 0, 0, SMTO_ABORTIFHUNG, 2000, (PDWORD_PTR)&aRetVal))\n\t\treturn FR_E_WIN32;\n\treturn OK;\n}\n\n\n\nbif_impl FResult EditGetCurrentLine(CONTROL_PARAMETERS_DECL, UINT_PTR &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tDWORD_PTR line_number;\n\tif (!SendMessageTimeout(control_window, EM_LINEFROMCHAR, -1, 0, SMTO_ABORTIFHUNG, 2000, &line_number))\n\t\treturn FR_E_WIN32;\n\taRetVal = line_number + 1;\n\treturn OK;\n}\n\n\n\nbif_impl FResult EditGetCurrentCol(CONTROL_PARAMETERS_DECL, UINT &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tDWORD_PTR dwResult, line_number;\n\tDWORD start = 0, end = 0;\n\t// The dwResult from the first msg below is not useful and is not checked.\n\tif ( !SendMessageTimeout(control_window, EM_GETSEL, (WPARAM)&start, (LPARAM)&end, SMTO_ABORTIFHUNG, 2000, &dwResult)\n\t\t|| !SendMessageTimeout(control_window, EM_LINEFROMCHAR, (WPARAM)start, 0, SMTO_ABORTIFHUNG, 2000, &line_number) )\n\t\treturn FR_E_WIN32;\n\tif (!line_number) // Since we're on line zero, the column number is simply start+1.\n\t{\n\t\taRetVal = start + 1; // +1 to convert from zero based.\n\t\treturn OK;\n\t}\n\t// The original Au3 function repeatedly decremented the character index and called EM_LINEFROMCHAR\n\t// until the row changed. Don't know why; the EM_LINEINDEX method is MUCH faster for long lines and\n\t// probably has been available since the dawn of time, though I've only tested it on Windows 10.\n\tDWORD_PTR line_start;\n\tif (!SendMessageTimeout(control_window, EM_LINEINDEX, (WPARAM)line_number, 0, SMTO_ABORTIFHUNG, 2000, &line_start))\n\t\treturn FR_E_WIN32;\n\taRetVal = start - (UINT)line_start + 1;\n\treturn OK;\n}\n\n\n\nbif_impl FResult EditGetLine(INT_PTR aIndex, CONTROL_PARAMETERS_DECL, StrRet &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tauto control_index = aIndex - 1;\n\tif (control_index < 0)\n\t\treturn FR_E_ARG(0);\n\tDWORD_PTR dwLineCount, dwResult;\n\t// Lexikos: Not sure if the following comment is relevant (does the OS multiply by sizeof(wchar_t)?).\n\t// jackieku: 32768 * sizeof(wchar_t) = 65536, which can not be stored in a unsigned 16bit integer.\n\tTCHAR line_buf[32767];\n\t*(LPWORD)line_buf = 32767; // EM_GETLINE requires first word of string to be set to its size.\n\tif (!SendMessageTimeout(control_window, EM_GETLINE, (WPARAM)control_index, (LPARAM)line_buf, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\tif (!dwResult) // Line is empty or line number is invalid.\n\t{\n\t\tif (!SendMessageTimeout(control_window, EM_GETLINECOUNT, 0, 0, SMTO_ABORTIFHUNG, 2000, &dwLineCount))\n\t\t\treturn FR_E_WIN32;\n\t\tif ((DWORD_PTR)control_index >= dwLineCount)\n\t\t\treturn FR_E_ARG(0);\n\t}\n\treturn aRetVal.Copy(line_buf, dwResult) ? OK : FR_E_OUTOFMEM;\n}\n\n\n\nbif_impl FResult EditGetSelectedText(CONTROL_PARAMETERS_DECL, StrRet &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\tDWORD_PTR length, dwResult;\n\tDWORD start = 0, end = 0;\n\t// Note: The RichEdit controls of certain apps such as Metapad don't return the right selection\n\t// with this technique. Au3 has the same problem with them, so for now it's just documented here\n\t// as a limitation.\n\tif (!SendMessageTimeout(control_window, EM_GETSEL, (WPARAM)&start, (LPARAM)&end, SMTO_ABORTIFHUNG, 2000, &dwResult))\n\t\treturn FR_E_WIN32;\n\t// The above sets start to be the zero-based position of the start of the selection (similar for end).\n\t// If there is no selection, start and end will be equal, at least in the edit controls I tried it with.\n\t// The dwResult from the above is not useful and is not checked.\n\tif (start > end) // Later sections rely on this for safety with unsupported controls.\n\t\treturn FR_E_FAILED; // The most likely cause is that this isn't an Edit control, but that isn't certain.\n\tif (start == end)\n\t{\n\t\taRetVal.SetEmpty();\n\t\treturn OK;\n\t}\n\tif ( !SendMessageTimeout(control_window, WM_GETTEXTLENGTH, 0, 0, SMTO_ABORTIFHUNG, 2000, &length)\n\t\t|| !length ) // Since the above didn't return for start == end, this is an error because we have a selection of non-zero length, but no text to go with it!\n\t\treturn FR_E_FAILED;\n\t// Dynamic memory is used because we must get all the control's text so that just the selected region\n\t// can be cropped out and returned:\n\tLPTSTR dyn_buf = tmalloc(length + 1);\n\tif (!dyn_buf)\n\t\treturn FR_E_OUTOFMEM;\n\tif ( !SendMessageTimeout(control_window, WM_GETTEXT, (WPARAM)(length + 1), (LPARAM)dyn_buf, SMTO_ABORTIFHUNG, 2000, &length)\n\t\t|| !length || end > length )\n\t{\n\t\t// The first check above implies failure since the length is unexpectedly zero\n\t\t// (above implied it shouldn't be). The second check is also a problem because the\n\t\t// end of the selection should not be beyond the length of text that was retrieved.\n\t\tfree(dyn_buf);\n\t\treturn FR_E_FAILED;\n\t}\n\tdyn_buf[end] = '\\0'; // Terminate the string at the end of the selection.\n\tauto fr = aRetVal.Copy(dyn_buf + start, end - start) ? OK : FR_E_OUTOFMEM;\n\tfree(dyn_buf);\n\treturn fr;\n}\n\n\n\n// The terminology \"HWND\" was chosen rather than \"ID\" to avoid confusion with a control's\n// dialog ID (as retrieved by GetDlgCtrlID). This also reserves the word ID for possible\n// use with the control's Dialog ID in future versions.\nbif_impl FResult ControlGetHwnd(CONTROL_PARAMETERS_DECL, UINT &aRetVal)\n{\n\tDETERMINE_TARGET_CONTROL2;\n\taRetVal = (UINT)(size_t)control_window;\n\treturn OK;\n}\n\n\n\nbif_impl FResult Download(StrArg aURL, StrArg aFilespec)\n{\n\t// v1.0.44.07: Set default to INTERNET_FLAG_RELOAD vs. 0 because the vast majority of usages would want\n\t// the file to be retrieved directly rather than from the cache.\n\t// v1.0.46.04: Added more no-cache flags because otherwise, it definitely falls back to the cache if\n\t// the remote server doesn't respond (and perhaps other errors), which defeats the ability to use the\n\t// Download command for uptime/server monitoring. Also, in spite of what MSDN says, it seems nearly\n\t// certain based on other sources that more than one flag is supported. Someone also mentioned that\n\t// INTERNET_FLAG_CACHE_IF_NET_FAIL is related to this, but there's no way to specify it in these\n\t// particular calls, and it's the opposite of the desired behavior anyway; so it seems impossible to\n\t// turn it off explicitly.\n\tDWORD flags_for_open_url = INTERNET_FLAG_RELOAD | INTERNET_FLAG_NO_CACHE_WRITE;\n\taURL = omit_leading_whitespace(aURL);\n\tif (*aURL == '*') // v1.0.44.07: Provide an option to override flags_for_open_url.\n\t{\n\t\tflags_for_open_url = ATOU(++aURL);\n\t\tif (auto cp = StrChrAny(aURL, _T(\" \\t\"))) // Find first space or tab.\n\t\t\taURL = omit_leading_whitespace(cp);\n\t}\n\n\t// Open the internet session. v1.0.45.03: Provide a non-NULL user-agent because some servers reject\n\t// requests that lack a user-agent. Furthermore, it's more professional to have one, in which case it\n\t// should probably be kept as simple and unchanging as possible. Using something like the script's name\n\t// as the user agent (even if documented) seems like a bad idea because it might contain personal/sensitive info.\n\tHINTERNET hInet = InternetOpen(_T(\"AutoHotkey\"), INTERNET_OPEN_TYPE_PRECONFIG_WITH_NO_AUTOPROXY, NULL, NULL, 0);\n\tif (!hInet)\n\t\treturn FR_E_WIN32;\n\n\t// Open the required URL\n\tHINTERNET hFile = InternetOpenUrl(hInet, aURL, NULL, 0, flags_for_open_url, 0);\n\tif (!hFile)\n\t{\n\t\tDWORD last_error = GetLastError(); // Save this before calling InternetCloseHandle, otherwise it is set to 0.\n\t\t// The following error can be returned if the server requests authentication. If authentication\n\t\t// isn't required, sending the request again using the same handles \"authenticates\" anonymously.\n\t\tif ( !(last_error == ERROR_INTERNET_CLIENT_AUTH_CERT_NEEDED\n\t\t\t&& (hFile = InternetOpenUrl(hInet, aURL, NULL, 0, flags_for_open_url, 0))) )\n\t\t{\n\t\t\tlast_error = GetLastError();\n\t\t\tInternetCloseHandle(hInet);\n\t\t\treturn FR_E_WIN32(last_error);\n\t\t}\n\t}\n\n\t// Open our output file (overwrite if necessary)\n\tauto hOut = CreateFile(aFilespec, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, NULL);\n\tif (hOut == INVALID_HANDLE_VALUE)\n\t{\n\t\tDWORD last_error = GetLastError();\n\t\tInternetCloseHandle(hFile);\n\t\tInternetCloseHandle(hInet);\n\t\treturn FR_E_WIN32(last_error);\n\t}\n\n\tBYTE bufData[1024 * 1]; // v1.0.44.11: Reduced from 8 KB to alleviate GUI window lag during Download. Testing shows this reduction doesn't affect performance on high-speed downloads (in fact, downloads are slightly faster; I tested two sites, one at 184 KB/s and the other at 380 KB/s). It might affect slow downloads, but that seems less likely so wasn't tested.\n\tINTERNET_BUFFERSA buffers = {0};\n\tbuffers.dwStructSize = sizeof(INTERNET_BUFFERSA);\n\tbuffers.lpvBuffer = bufData;\n\tbuffers.dwBufferLength = sizeof(bufData);\n\n\tLONG_OPERATION_INIT\n\n\t// Read the file. I don't think synchronous transfers typically generate the pseudo-error\n\t// ERROR_IO_PENDING, so that is not checked here. That's probably just for async transfers.\n\t// IRF_NO_WAIT is used to avoid requiring the call to block until the buffer is full. By\n\t// having it return the moment there is any data in the buffer, the program is made more\n\t// responsive, especially when the download is very slow and/or one of the hooks is installed:\n\tBOOL result;\n\tDWORD bytes_written;\n\tif (*aURL == 'h' || *aURL == 'H')\n\t{\n\t\twhile (result = InternetReadFileExA(hFile, &buffers, IRF_NO_WAIT, NULL)) // Assign\n\t\t{\n\t\t\tif (!buffers.dwBufferLength) // Transfer is complete.\n\t\t\t\tbreak;\n\t\t\tLONG_OPERATION_UPDATE // Done in between the net-read and the file-write to improve avg. responsiveness.\n\t\t\tresult = WriteFile(hOut, bufData, buffers.dwBufferLength, &bytes_written, nullptr);\n\t\t\tif (!result)\n\t\t\t\tbreak;\n\t\t\tbuffers.dwBufferLength = sizeof(bufData); // Reset buffer capacity for next iteration.\n\t\t}\n\t}\n\telse // v1.0.48.04: This section adds support for FTP and perhaps Gopher by using InternetReadFile() instead of InternetReadFileEx().\n\t{\n\t\tDWORD number_of_bytes_read;\n\t\twhile (result = InternetReadFile(hFile, bufData, sizeof(bufData), &number_of_bytes_read))\n\t\t{\n\t\t\tif (!number_of_bytes_read)\n\t\t\t\tbreak;\n\t\t\tLONG_OPERATION_UPDATE\n\t\t\tresult = WriteFile(hOut, bufData, number_of_bytes_read, &bytes_written, nullptr);\n\t\t\tif (!result)\n\t\t\t\tbreak;\n\t\t}\n\t}\n\tDWORD last_error = GetLastError();\n\t// Close internet session:\n\tInternetCloseHandle(hFile);\n\tInternetCloseHandle(hInet);\n\t// Close output file:\n\tCloseHandle(hOut);\n\n\tif (!result) // An error occurred during the transfer.\n\t{\n\t\tDeleteFile(aFilespec); // Delete damaged/incomplete file.\n\t\treturn FR_E_WIN32(last_error);\n\t}\n\treturn OK;\n}\n\n\n\nint CALLBACK FileSelectFolderCallback(HWND hwnd, UINT uMsg, LPARAM lParam, LPARAM lpData)\n{\n\tif (uMsg == BFFM_INITIALIZED) // Caller has ensured that lpData isn't NULL by having set a valid lParam value.\n\t\tSendMessage(hwnd, BFFM_SETSELECTION, TRUE, lpData);\n\t// In spite of the quote below, the behavior does not seem to vary regardless of what value is returned\n\t// upon receipt of BFFM_VALIDATEFAILED, at least on XP. But in case it matters on other OSes, preserve\n\t// compatibility with versions older than 1.0.36.03 by keeping the dialog displayed even if the user enters\n\t// an invalid folder:\n\t// MSDN: \"Returns zero except in the case of BFFM_VALIDATEFAILED. For that flag, returns zero to dismiss\n\t// the dialog or nonzero to keep the dialog displayed.\"\n\treturn uMsg == BFFM_VALIDATEFAILED; // i.e. zero should be returned in almost every case.\n}\n\n\n\nbif_impl FResult DirSelect(optl<StrArg> aRootDir, optl<int> aOptions, optl<StrArg> aGreeting, StrRet &aRetVal)\n{\n\tif (g_nFolderDialogs >= MAX_FOLDERDIALOGS)\n\t{\n\t\t// Have a maximum to help prevent runaway hotkeys due to key-repeat feature, etc.\n\t\treturn FError(_T(\"The maximum number of Folder Dialogs has been reached.\"));\n\t}\n\n\tLPMALLOC pMalloc;\n\tHRESULT hr = SHGetMalloc(&pMalloc);\n if (FAILED(hr))\t// Initialize\n\t\treturn hr;\n\n\t// v1.0.36.03: Support initial folder, which is different than the root folder because the root only\n\t// controls the origin point (above which the control cannot navigate).\n\tLPTSTR initial_folder;\n\tTCHAR root_dir[MAX_PATH*2 + 5]; // Up to two paths might be present inside, including an asterisk and spaces between them.\n\tif (aRootDir.has_value())\n\t\ttcslcpy(root_dir, aRootDir.value(), _countof(root_dir)); // Make a modifiable copy.\n\telse\n\t\t*root_dir = '\\0';\n\tif (initial_folder = _tcschr(root_dir, '*'))\n\t{\n\t\t*initial_folder = '\\0'; // Terminate so that root_dir becomes an isolated string.\n\t\t// Must eliminate the trailing whitespace or it won't work. However, only up to one space or tab\n\t\t// so that path names that really do end in literal spaces can be used:\n\t\tif (initial_folder > root_dir && IS_SPACE_OR_TAB(initial_folder[-1]))\n\t\t\tinitial_folder[-1] = '\\0';\n\t\t// In case absolute paths can ever have literal leading whitespace, preserve that whitespace\n\t\t// by incrementing by only one and not calling omit_leading_whitespace(). This has been documented.\n\t\t++initial_folder;\n\t}\n\telse\n\t\tinitial_folder = NULL;\n\tif (!*(omit_leading_whitespace(root_dir))) // Count all-whitespace as a blank string, but retain leading whitespace if there is also non-whitespace inside.\n\t\t*root_dir = '\\0';\n\n\tBROWSEINFO bi;\n\tif (initial_folder)\n\t{\n\t\tbi.lpfn = FileSelectFolderCallback;\n\t\tbi.lParam = (LPARAM)initial_folder; // Used by the callback above.\n\t}\n\telse\n\t\tbi.lpfn = NULL; // It will ignore the value of bi.lParam when lpfn is NULL.\n\n\tif (*root_dir)\n\t{\n\t\tIShellFolder *pDF;\n\t\tif (SHGetDesktopFolder(&pDF) == NOERROR)\n\t\t{\n\t\t\tLPITEMIDLIST pIdl = NULL;\n\t\t\tULONG chEaten;\n\t\t\tULONG dwAttributes;\n#ifdef UNICODE\n\t\t\tpDF->ParseDisplayName(NULL, NULL, root_dir, &chEaten, &pIdl, &dwAttributes);\n#else\n\t\t\tOLECHAR olePath[MAX_PATH];\t\t\t// wide-char version of path name\n\t\t\tToWideChar(root_dir, olePath, MAX_PATH); // Dest. size is in wchars, not bytes.\n\t\t\tpDF->ParseDisplayName(NULL, NULL, olePath, &chEaten, &pIdl, &dwAttributes);\n#endif\n\t\t\tpDF->Release();\n\t\t\tbi.pidlRoot = pIdl;\n\t\t}\n\t}\n\telse // No root directory.\n\t\tbi.pidlRoot = NULL; // Make it use \"My Computer\" as the root dir.\n\n\tint iImage = 0;\n\tbi.iImage = iImage;\n\tbi.hwndOwner = THREAD_DIALOG_OWNER; // Can be NULL, which is used rather than main window since no need to have main window forced into the background by this.\n\tTCHAR greeting[1024];\n\tif (aGreeting.has_nonempty_value())\n\t\ttcslcpy(greeting, aGreeting.value(), _countof(greeting));\n\telse\n\t\tsntprintf(greeting, _countof(greeting), _T(\"Select Folder - %s\"), g_script.DefaultDialogTitle());\n\tbi.lpszTitle = greeting;\n\n\t// Bitwise flags:\n\t#define FSF_ALLOW_CREATE 0x01\n\t#define FSF_EDITBOX 0x02\n\t#define FSF_NONEWDIALOG 0x04\n\tauto options = (DWORD)aOptions.value_or(FSF_ALLOW_CREATE);\n\tbi.ulFlags =\n\t\t ((options & FSF_NONEWDIALOG) ? 0 : BIF_NEWDIALOGSTYLE) // v1.0.48: Added to support BartPE/WinPE.\n\t\t| ((options & FSF_ALLOW_CREATE) ? 0 : BIF_NONEWFOLDERBUTTON)\n\t\t| ((options & FSF_EDITBOX) ? BIF_EDITBOX : 0);\n\n\tTCHAR Result[2048];\n\tbi.pszDisplayName = Result; // This will hold the user's choice.\n\n\t// At this point, we know a dialog will be displayed. See macro's comments for details:\n\tDIALOG_PREP\n\tPOST_AHK_DIALOG(0) // Do this only after the above. Must pass 0 for timeout in this case.\n\n\t++g_nFolderDialogs;\n\tLPITEMIDLIST lpItemIDList = SHBrowseForFolder(&bi); // Spawn Dialog\n\t--g_nFolderDialogs;\n\n\tDIALOG_END\n\tif (!lpItemIDList)\n\t{\n\t\t// Due to rarity and because there doesn't seem to be any way to detect it,\n\t\t// no exception is thrown when the function fails. Instead, we just assume\n\t\t// that the user pressed CANCEL (which should not be treated as an error):\n\t\taRetVal.SetEmpty();\n\t\treturn OK;\n\t}\n\n\t*Result = '\\0'; // Reuse this var, this time to hold the result of the below:\n\tSHGetPathFromIDList(lpItemIDList, Result);\n\tpMalloc->Free(lpItemIDList);\n\tpMalloc->Release();\n\n\treturn aRetVal.Copy(Result) ? OK : FR_E_OUTOFMEM;\n}\n\n\n\nbif_impl FResult FileGetShortcut(StrArg aShortcutFile, StrRet *aTarget, StrRet *aWorkingDir\n\t, StrRet *aArgs, StrRet *aDesc, StrRet *aIcon, ResultToken *aIconNum, int *aRunState)\n// Credited to Holger <Holger.Kotsch at GMX de>.\n{\n\tCoInitialize(NULL);\n\tIShellLink *psl;\n\tHRESULT hr;\n\n\tif (SUCCEEDED(hr = CoCreateInstance(CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER, IID_IShellLink, (LPVOID *)&psl)))\n\t{\n\t\tIPersistFile *ppf;\n\t\tif (SUCCEEDED(hr = psl->QueryInterface(IID_IPersistFile, (LPVOID *)&ppf)))\n\t\t{\n#ifdef UNICODE\n\t\t\tif (SUCCEEDED(hr = ppf->Load(aShortcutFile, 0)))\n#else\n\t\t\tWCHAR wsz[MAX_PATH+1]; // +1 hasn't been explained, but is retained in case it's needed.\n\t\t\tToWideChar(aShortcutFile, wsz, MAX_PATH+1); // Dest. size is in wchars, not bytes.\n\t\t\tif (SUCCEEDED(hr = ppf->Load((const WCHAR*)wsz, 0)))\n#endif\n\t\t\t{\n\t\t\t\tTCHAR buf[MAX_PATH+1];\n\t\t\t\tint icon_index, show_cmd;\n\n\t\t\t\tif (aTarget)\n\t\t\t\t{\n\t\t\t\t\tpsl->GetPath(buf, MAX_PATH, NULL, SLGP_UNCPRIORITY);\n\t\t\t\t\taTarget->Copy(buf);\n\t\t\t\t}\n\t\t\t\tif (aWorkingDir)\n\t\t\t\t{\n\t\t\t\t\tpsl->GetWorkingDirectory(buf, MAX_PATH);\n\t\t\t\t\taWorkingDir->Copy(buf);\n\t\t\t\t}\n\t\t\t\tif (aArgs)\n\t\t\t\t{\n\t\t\t\t\tpsl->GetArguments(buf, MAX_PATH);\n\t\t\t\t\taArgs->Copy(buf);\n\t\t\t\t}\n\t\t\t\tif (aDesc)\n\t\t\t\t{\n\t\t\t\t\tpsl->GetDescription(buf, MAX_PATH); // Testing shows that the OS limits it to 260 characters.\n\t\t\t\t\taDesc->Copy(buf);\n\t\t\t\t}\n\t\t\t\tif (aIcon || aIconNum)\n\t\t\t\t{\n\t\t\t\t\tpsl->GetIconLocation(buf, MAX_PATH, &icon_index);\n\t\t\t\t\tif (aIcon)\n\t\t\t\t\t\taIcon->Copy(buf);\n\t\t\t\t\tif (aIconNum)\n\t\t\t\t\t\tif (*buf)\n\t\t\t\t\t\t\taIconNum->SetValue(icon_index + (icon_index >= 0 ? 1 : 0)); // Convert from 0-based to 1-based for consistency with the Menu command, etc. but leave negative resource IDs as-is.\n\t\t\t\t\t\t//else: Leave it blank to indicate that there is none.\n\t\t\t\t}\n\t\t\t\tif (aRunState)\n\t\t\t\t{\n\t\t\t\t\tpsl->GetShowCmd(&show_cmd);\n\t\t\t\t\t*aRunState = show_cmd;\n\t\t\t\t\t// For the above, decided not to translate them to Max/Min/Normal since other\n\t\t\t\t\t// show-state numbers might be supported in the future (or are already). In other\n\t\t\t\t\t// words, this allows the flexibility to specify some number other than 1/3/7 when\n\t\t\t\t\t// creating the shortcut in case it happens to work. Of course, that applies only\n\t\t\t\t\t// to FileCreateShortcut, not here. But it's done here so that this command is\n\t\t\t\t\t// compatible with that one.\n\t\t\t\t}\n\t\t\t}\n\t\t\tppf->Release();\n\t\t}\n\t\tpsl->Release();\n\t}\n\tCoUninitialize();\n\treturn hr;\n}\n\n\n\nbif_impl FResult FileCreateShortcut(StrArg aTargetFile, StrArg aShortcutFile, optl<StrArg> aWorkingDir\n\t, optl<StrArg> aArgs, optl<StrArg> aDescription, optl<StrArg> aIconFile, optl<StrArg> aHotkey\n\t, optl<int> aIconNumber, optl<int> aRunState)\n{\n\tCoInitialize(NULL);\n\tIShellLink *psl;\n\tHRESULT hr;\n\n\tif (SUCCEEDED(hr = CoCreateInstance(CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER, IID_IShellLink, (LPVOID *)&psl)))\n\t{\n\t\tpsl->SetPath(aTargetFile);\n\t\tif (aWorkingDir.has_value())\n\t\t\tpsl->SetWorkingDirectory(aWorkingDir.value());\n\t\tif (aArgs.has_value())\n\t\t\tpsl->SetArguments(aArgs.value());\n\t\tif (aDescription.has_value())\n\t\t\tpsl->SetDescription(aDescription.value());\n\t\tint icon_index = aIconNumber.value_or(0);\n\t\tif (aIconFile.has_value())\n\t\t\tpsl->SetIconLocation(aIconFile.value(), icon_index - (icon_index > 0 ? 1 : 0)); // Convert 1-based index to 0-based, but leave negative resource IDs as-is.\n\t\tif (aHotkey.has_value())\n\t\t{\n\t\t\tWORD mods = 0;\n\t\t\tLPCTSTR cp = aHotkey.value();\n\t\t\tfor (;; ++cp)\n\t\t\t{\n\t\t\t\tif (!*cp || !cp[1]) // The last char is never a modifier.\n\t\t\t\t\tbreak;\n\t\t\t\telse if (*cp == '^')\n\t\t\t\t\tmods |= HOTKEYF_CONTROL;\n\t\t\t\telse if (*cp == '!')\n\t\t\t\t\tmods |= HOTKEYF_ALT;\n\t\t\t\telse if (*cp == '+')\n\t\t\t\t\tmods |= HOTKEYF_SHIFT;\n\t\t\t\telse\n\t\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\t// For backwards compatibility: if modifiers omitted, assume CTRL+ALT.\n\t\t\tif (!mods)\n\t\t\t\tmods = HOTKEYF_CONTROL | HOTKEYF_ALT;\n\n\t\t\t// If badly formatted, it's not a critical error, just continue.\n\t\t\tvk_type vk = TextToVK(cp);\n\t\t\tif (vk)\n\t\t\t\t// Vk in low 8 bits, mods in high 8:\n\t\t\t\tpsl->SetHotkey( (WORD)vk | (mods << 8) );\n\t\t}\n\t\tif (aRunState.has_value())\n\t\t\tpsl->SetShowCmd(*aRunState); // No validation is done since there's a chance other numbers might be valid now or in the future.\n\n\t\tIPersistFile *ppf;\n\t\tif (SUCCEEDED(hr = psl->QueryInterface(IID_IPersistFile,(LPVOID *)&ppf)))\n\t\t{\n#ifndef UNICODE\n\t\t\tWCHAR wsz[MAX_PATH];\n\t\t\tToWideChar(aShortcutFile, wsz, MAX_PATH); // Dest. size is in wchars, not bytes.\n#else\n\t\t\tLPCWSTR wsz = aShortcutFile;\n#endif\n\t\t\t// MSDN says to pass \"The absolute path of the file\". Windows 10 requires it.\n\t\t\tWCHAR full_path[MAX_PATH];\n\t\t\tGetFullPathNameW(wsz, _countof(full_path), full_path, NULL);\n\t\t\thr = ppf->Save(full_path, TRUE);\n\t\t\tppf->Release();\n\t\t}\n\t\tpsl->Release();\n\t}\n\n\tCoUninitialize();\n\treturn hr;\n}\n\n\n\nbif_impl FResult FileRecycle(StrArg aFilePattern)\n{\n\tif (!aFilePattern || !*aFilePattern)\n\t\treturn FR_E_ARG(0); // Since this is probably not what the user intended.\n\n\tSHFILEOPSTRUCT FileOp;\n\tTCHAR szFileTemp[_MAX_PATH+2];\n\n\t// au3: Get the fullpathname - required for UNDO to work\n\tLine::Util_GetFullPathName(aFilePattern, szFileTemp);\n\n\t// au3: We must also make it a double nulled string *sigh*\n\tszFileTemp[_tcslen(szFileTemp)+1] = '\\0';\n\n\t// au3: set to known values - Corrects crash\n\tFileOp.hNameMappings = NULL;\n\tFileOp.lpszProgressTitle = NULL;\n\tFileOp.fAnyOperationsAborted = FALSE;\n\tFileOp.hwnd = NULL;\n\tFileOp.pTo = NULL;\n\n\tFileOp.pFrom = szFileTemp;\n\tFileOp.wFunc = FO_DELETE;\n\tFileOp.fFlags = FOF_SILENT | FOF_ALLOWUNDO | FOF_NOCONFIRMATION | FOF_WANTNUKEWARNING;\n\n\t// SHFileOperation() returns 0 on success:\n\treturn SHFileOperation(&FileOp) ? FR_E_FAILED : OK;\n}\n\n\n\nbif_impl FResult FileRecycleEmpty(optl<StrArg> szPath)\n{\n\tHRESULT hr = SHEmptyRecycleBin(NULL, szPath.value_or_null(), SHERB_NOCONFIRMATION | SHERB_NOPROGRESSUI | SHERB_NOSOUND);\n\t// Throw no error for E_UNEXPECTED, since that is returned in the common case where the\n\t// recycle bin is already empty. Seems more useful and user-friendly to ignore it.\n\treturn hr != E_UNEXPECTED ? hr : OK;\n}\n\n\n\nbif_impl FResult FileGetVersion(optl<StrArg> aPath, StrRet &aRetVal)\n{\n\tg->LastError = 0; // Set default for successful return or non-Win32 errors.\n\n\tauto path = aPath.has_value() ? aPath.value() : g->mLoopFile ? g->mLoopFile->file_path : _T(\"\");\n\tif (!*path)\n\t\treturn FR_E_ARG(0);\n\n\tDWORD dwUnused, dwSize;\n\tif ( !(dwSize = GetFileVersionInfoSize(path, &dwUnused)) ) // No documented limit on how large it can be, so don't use _alloca().\n\t\treturn FR_E_WIN32;\n\n\tBYTE *pInfo = (BYTE*)malloc(dwSize); // Allocate the size retrieved by the above.\n\tVS_FIXEDFILEINFO *pFFI;\n\tUINT uSize;\n\n\t// Read the version resource\n\tif (!GetFileVersionInfo(path, 0, dwSize, (LPVOID)pInfo)\n\t// Locate the fixed information\n\t\t|| !VerQueryValue(pInfo, _T(\"\\\\\"), (LPVOID *)&pFFI, &uSize))\n\t{\n\t\tfree(pInfo);\n\t\treturn FR_E_WIN32;\n\t}\n\n\t// extract the fields you want from pFFI\n\tUINT iFileMS = (UINT)pFFI->dwFileVersionMS;\n\tUINT iFileLS = (UINT)pFFI->dwFileVersionLS;\n\tsntprintf(aRetVal.CallerBuf(), aRetVal.CallerBufSize, _T(\"%u.%u.%u.%u\")\n\t\t, (iFileMS >> 16), (iFileMS & 0xFFFF), (iFileLS >> 16), (iFileLS & 0xFFFF));\n\taRetVal.SetTemp(aRetVal.CallerBuf());\n\n\tfree(pInfo);\n\treturn OK;\n}\n\n\n\nbool Line::Util_CopyDir(LPCTSTR szInputSource, LPCTSTR szInputDest, int OverwriteMode, bool bMove)\n{\n\tif (!*szInputSource || !*szInputDest)\n\t\treturn false;\n\n\tbool bOverwrite = OverwriteMode == 1 || OverwriteMode == 2; // Strict validation for safety.\n\n\t// Get the fullpathnames and strip trailing \\s\n\tTCHAR szSource[_MAX_PATH+2];\n\tTCHAR szDest[_MAX_PATH+2];\n\tUtil_GetFullPathName(szInputSource, szSource);\n\tUtil_GetFullPathName(szInputDest, szDest);\n\n\t// Permit !IsDir when copying to support extracting zip files. Other checks prevent\n\t// going in the other direction, which isn't supported by SHFileOperation anyway.\n\t// The \"\\*.*\" suffix added below prevents any single file from being copied.\n\tif (bMove && Util_IsDir(szSource) == false)\n\t\treturn false;\t\t\t\t\t\t\t// Nope\n\n\t// Jon on the AutoIt forums says \"Well SHFileOp is way too unpredictable under 9x. Grrr.\"\n\t// So the comments below about some OSes/old versions are probably just referring to 9x,\n\t// which we don't support anymore. Testing on Windows 2000 and Windows 10 showed that\n\t// SHFileOperation can move a directory between two volumes. However, performing copy\n\t// then remove ensures nothing is removed if the copy partially fails, so it's kept this\n\t// way for backward-compatibility, even though it may be inconsistent with local moves.\n\t// Obsolete comment from Util_MoveDir:\n\t// If the source and dest are on different volumes then we must copy rather than move\n\t// as move in this case only works on some OSes. Copy and delete (poor man's move).\n\tif (bMove && (ctolower(szSource[0]) != ctolower(szDest[0]) || szSource[1] != ':'))\n\t{\n\t\tif (!Util_CopyDir(szSource, szDest, bOverwrite, false))\n\t\t\treturn false;\n\t\treturn Util_RemoveDir(szSource, true);\n\t}\n\n\t// Does the destination dir exist?\n\tDWORD attr = GetFileAttributes(szDest);\n\tif (attr != 0xFFFFFFFF) // Destination already exists as a file or directory.\n\t{\n\t\tif (attr & FILE_ATTRIBUTE_DIRECTORY) // Dest already exists as a directory.\n\t\t{\n\t\t\tif (!bOverwrite) // Overwrite Mode is \"Never\".\n\t\t\t\treturn false;\n\t\t}\n\t\telse // Dest already exists as a file.\n\t\t\treturn false; // Don't even attempt to overwrite a file with a dir, regardless of mode (I think SHFileOperation refuses to do it anyway).\n\t}\n\telse // Dest doesn't exist.\n\t{\n\t\t// We must create the top level directory\n\t\t// FOF_SILENT (which is included in FOF_NO_UI and means \"Do not display a progress dialog box\")\n\t\t// seems to be bugged on some older OSes (such as 2k and XP). Specifically, it answers \"No\" to\n\t\t// the \"confirmmkdir\" dialog, which it isn't supposed to suppress, and ignores FOF_NOCONFIRMMKDIR.\n\t\t// Creating the directory first works around this. Win 7 is okay without this; Vista wasn't tested.\n\t\tif (!bMove && !FileCreateDir(szDest))\n\t\t\treturn false;\n\t}\n\n\t// The wildcard below is kept for backward-compatibility, although as indicated above, the\n\t// issues alluded to below are probably only on 9x, which is no longer supported. Adding the\n\t// wildcard appears to permit copying a directory into itself (perhaps because the directory\n\t// itself isn't being copied), although we still document the result as \"undefined\".\n\t// This suffix also allows SHFileOperation to extract the contents of a zip file, and prevents\n\t// it from copying the source itself into the destination.\n\tif (!bMove)\n\t\t_tcscat(szSource, _T(\"\\\\*.*\"));\n\n\t// We must also make source\\dest double nulled strings for the SHFileOp API\n\tszSource[_tcslen(szSource)+1] = '\\0';\t\n\tszDest[_tcslen(szDest)+1] = '\\0';\t\n\n\t// Setup the struct\n\tSHFILEOPSTRUCT FileOp = {0};\n\tFileOp.pFrom = szSource;\n\tFileOp.pTo = szDest;\n\tFileOp.wFunc = bMove ? FO_MOVE : FO_COPY;\n\tFileOp.fFlags = FOF_NO_UI; // Set default.\n\tif (OverwriteMode == 2)\n\t\tFileOp.fFlags |= FOF_MULTIDESTFILES; // v1.0.46.07: Using the FOF_MULTIDESTFILES flag (as hinted by MSDN) overwrites/merges any existing target directory. This logic supersedes and fixes old logic that didn't work properly when the source dir was being both renamed and moved to overwrite an existing directory.\n\t// All of the below left set to NULL/FALSE by the struct initializer higher above:\n\t//FileOp.hNameMappings\t\t\t= NULL;\n\t//FileOp.lpszProgressTitle\t\t= NULL;\n\t//FileOp.fAnyOperationsAborted\t= FALSE;\n\t//FileOp.hwnd\t\t\t\t\t= NULL;\n\n\t// If the source directory contains any saved webpages consisting of a SiteName.htm file and a\n\t// corresponding directory named SiteName_files, the following may indicate an error even when the\n\t// copy is successful. Under Windows XP at least, the return value is 7 under these conditions,\n\t// which according to WinError.h is \"ERROR_ARENA_TRASHED: The storage control blocks were destroyed.\"\n\t// However, since this error might occur under a variety of circumstances, it probably wouldn't be\n\t// proper to consider it a non-error.\n\t// I also checked GetLastError() after calling SHFileOperation(), but it does not appear to be\n\t// valid/useful in this case (MSDN mentions this fact but isn't clear about it).\n\t// The issue appears to affect only FileCopyDir, not FileMoveDir or FileRemoveDir. It also seems\n\t// unlikely to affect FileCopy/FileMove because they never copy directories.\n\treturn !SHFileOperation(&FileOp);\n}\n\n\n\nbool Line::Util_RemoveDir(LPCTSTR szInputSource, bool bRecurse)\n{\n\tif (!*szInputSource)\n\t\treturn false;\n\n\tSHFILEOPSTRUCT\tFileOp;\n\tTCHAR\t\t\tszSource[_MAX_PATH+2];\n\t\n\t// If recursion not on just try a standard delete on the directory (the SHFile function WILL\n\t// delete a directory even if not empty no matter what flags you give it...)\n\tif (bRecurse == false)\n\t{\n\t\t// v1.1.31.00: Use the original source path in case its length exceeds _MAX_PATH.\n\t\t// Relative paths and trailing slashes are okay in this case, and Util_IsDir() is\n\t\t// not needed since the function only removes empty directories, not files.\n\t\tif (!RemoveDirectory(szInputSource))\n\t\t\treturn false;\n\t\telse\n\t\t\treturn true;\n\t}\n\n\t// Get the fullpathnames and strip trailing \\s\n\tUtil_GetFullPathName(szInputSource, szSource);\n\n\t// Ensure source is a directory\n\tif (Util_IsDir(szSource) == false)\n\t\treturn false;\t\t\t\t\t\t\t// Nope\n\n\t// We must also make double nulled strings for the SHFileOp API\n\tszSource[_tcslen(szSource)+1] = '\\0';\n\n\t// Setup the struct\n\tFileOp.pFrom\t\t\t\t\t= szSource;\n\tFileOp.pTo\t\t\t\t\t\t= NULL;\n\tFileOp.hNameMappings\t\t\t= NULL;\n\tFileOp.lpszProgressTitle\t\t= NULL;\n\tFileOp.fAnyOperationsAborted\t= FALSE;\n\tFileOp.hwnd\t\t\t\t\t\t= NULL;\n\n\tFileOp.wFunc\t= FO_DELETE;\n\tFileOp.fFlags\t= FOF_SILENT | FOF_NOCONFIRMMKDIR | FOF_NOCONFIRMATION | FOF_NOERRORUI;\n\t\n\treturn !SHFileOperation(&FileOp);\n}\n\n\n\n///////////////////////////////////////////////////////////////////////////////\n// Util_CopyFile()\n// (moves files too)\n// Returns the number of files that could not be copied or moved due to error.\n///////////////////////////////////////////////////////////////////////////////\nint Line::Util_CopyFile(LPCTSTR szInputSource, LPCTSTR szInputDest, bool bOverwrite, bool bMove, DWORD &aLastError)\n{\n\tTCHAR szSource[T_MAX_PATH];\n\tTCHAR szDest[T_MAX_PATH];\n\tTCHAR szDestPattern[MAX_PATH];\n\n\t// Get local version of our source/dest with full path names, strip trailing \\s\n\t// and normalize the path separator (replace / with \\).\n\tUtil_GetFullPathName(szInputSource, szSource, _countof(szSource));\n\tUtil_GetFullPathName(szInputDest, szDest, _countof(szDest));\n\n\t// If the source or dest is a directory then add *.* to the end\n\tif (Util_IsDir(szSource))\n\t\t_tcscat(szSource, _T(\"\\\\*.*\"));\n\tif (Util_IsDir(szDest))\n\t\t_tcscat(szDest, _T(\"\\\\*.*\"));\n\n\tWIN32_FIND_DATA\tfindData;\n\tHANDLE hSearch = FindFirstFile(szSource, &findData);\n\tif (hSearch == INVALID_HANDLE_VALUE)\n\t{\n\t\taLastError = GetLastError(); // Set even in this case since FindFirstFile can fail due to actual errors, such as an invalid path.\n\t\treturn StrChrAny(const_cast<LPTSTR>(szInputSource), _T(\"?*\")) ? 0 : 1; // Indicate failure only if there were no wildcards.\n\t}\n\taLastError = 0; // Set default. Overridden only when a failure occurs.\n\n\t// Otherwise, loop through all the matching files.\n\n\t// Locate the filename/pattern, which will be overwritten on each iteration.\n\tLPTSTR source_append_pos = _tcsrchr(szSource, '\\\\') + 1;\n\tLPTSTR dest_append_pos = _tcsrchr(szDest, '\\\\') + 1;\n\tsize_t space_remaining = _countof(szSource) - (source_append_pos - szSource) - 1;\n\n\t// Copy destination filename or pattern, since it will be overwritten.\n\ttcslcpy(szDestPattern, dest_append_pos, _countof(szDestPattern));\n\n\tint failure_count = 0;\n\tLONG_OPERATION_INIT\n\n\tdo\n\t{\n\t\t// Since other script threads can interrupt during LONG_OPERATION_UPDATE, it's important that\n\t\t// this function and those that call it not refer to sArgDeref[] and sArgVar[] anytime after an\n\t\t// interruption becomes possible. This is because an interrupting thread usually changes the\n\t\t// values to something inappropriate for this thread.\n\t\tLONG_OPERATION_UPDATE\n\n\t\t// Make sure the returned handle is a file and not a directory before we\n\t\t// try and do copy type things on it!\n\t\tif (findData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) // dwFileAttributes should never be invalid (0xFFFFFFFF) in this case.\n\t\t\tcontinue;\n\n\t\tif (_tcslen(findData.cFileName) > space_remaining) // v1.0.45.03: Basic check in case of files whose full spec is over 260 characters long.\n\t\t{\n\t\t\taLastError = ERROR_BUFFER_OVERFLOW; // MSDN: \"The file name is too long.\"\n\t\t\t++failure_count;\n\t\t\tcontinue;\n\t\t}\n\t\t_tcscpy(source_append_pos, findData.cFileName); // Indirectly populate szSource. Above has ensured this won't overflow.\n\n\t\t// Expand the destination based on this found file\n\t\tUtil_ExpandFilenameWildcard(findData.cFileName, szDestPattern, dest_append_pos);\n\n\t\t// Fixed for v1.0.36.01: This section has been revised to avoid unnecessary calls; but more\n\t\t// importantly, it now avoids the deletion and complete loss of a file when it is copied or\n\t\t// moved onto itself. That used to happen because any existing destination file used to be\n\t\t// deleted prior to attempting the move/copy.\n\t\tif (bMove) // Move vs. copy mode.\n\t\t{\n\t\t\t// Note that MoveFile() is capable of moving a file to a different volume, regardless of\n\t\t\t// operating system version. That's enough for what we need because this function never\n\t\t\t// moves directories, only files.\n\n\t\t\t// The following call will report success if source and dest are the same file, even if\n\t\t\t// source is something like \"..\\Folder\\Filename.txt\" and dest is something like\n\t\t\t// \"C:\\Folder\\Filename.txt\" (or if source is an 8.3 filename and dest is the long name\n\t\t\t// of the same file). This is good because it avoids the need to devise code\n\t\t\t// to determine whether two different path names refer to the same physical file\n\t\t\t// (note that GetFullPathName() has shown itself to be inadequate for this purpose due\n\t\t\t// to problems with short vs. long names, UNC vs. mapped drive, and possibly NTFS hard\n\t\t\t// links (aliases) that might all cause two different filenames to point to the same\n\t\t\t// physical file on disk (hopefully MoveFile handles all of these correctly by indicating\n\t\t\t// success [below] when a file is moved onto itself, though it has only been tested for\n\t\t\t// basic cases of relative vs. absolute path).\n\t\t\tif (!MoveFile(szSource, szDest))\n\t\t\t{\n\t\t\t\t// If overwrite mode was not specified by the caller, or it was but the existing\n\t\t\t\t// destination file cannot be deleted (perhaps because it is a folder rather than\n\t\t\t\t// a file), or it can be deleted but the source cannot be moved, indicate a failure.\n\t\t\t\t// But by design, continue the operation. The following relies heavily on\n\t\t\t\t// short-circuit boolean evaluation order:\n\t\t\t\tif ( !(bOverwrite && DeleteFile(szDest) && MoveFile(szSource, szDest)) )\n\t\t\t\t{\n\t\t\t\t\taLastError = GetLastError();\n\t\t\t\t\t++failure_count; // At this stage, any of the above 3 being false is cause for failure.\n\t\t\t\t}\n\t\t\t\t//else everything succeeded, so nothing extra needs to be done. In either case,\n\t\t\t\t// continue on to the next file.\n\t\t\t}\n\t\t}\n\t\telse // The mode is \"Copy\" vs. \"Move\"\n\t\t\tif (!CopyFile(szSource, szDest, !bOverwrite)) // Force it to fail if bOverwrite==false.\n\t\t\t{\n\t\t\t\taLastError = GetLastError();\n\t\t\t\t++failure_count;\n\t\t\t}\n\t} while (FindNextFile(hSearch, &findData));\n\n\tFindClose(hSearch);\n\treturn failure_count;\n}\n\n\n\nvoid Line::Util_ExpandFilenameWildcard(LPCTSTR szSource, LPCTSTR szDest, LPTSTR szExpandedDest)\n{\n\t// copy one.two.three *.txt = one.two .txt\n\t// copy one.two.three *.*.txt = one.two. .txt (extra asterisks are removed)\n\t// copy one.two\t\t test = test\n\n\tTCHAR\tszSrcFile[_MAX_PATH+1];\n\tTCHAR\tszSrcExt[_MAX_PATH+1];\n\n\tTCHAR\tszDestFile[_MAX_PATH+1];\n\tTCHAR\tszDestExt[_MAX_PATH+1];\n\n\t// If the destination doesn't include a wildcard, send it back verbatim\n\tif (_tcschr(szDest, '*') == NULL)\n\t{\n\t\t_tcscpy(szExpandedDest, szDest);\n\t\treturn;\n\t}\n\n\t// Split source and dest into file and extension\n\t_tsplitpath( szSource, NULL, NULL, szSrcFile, szSrcExt );\n\t_tsplitpath( szDest, NULL, NULL, szDestFile, szDestExt );\n\n\t// Source and Dest ext will either be \".nnnn\" or \"\" or \".*\", remove the period\n\tif (szSrcExt[0] == '.')\n\t\t_tcscpy(szSrcExt, &szSrcExt[1]);\n\tif (szDestExt[0] == '.')\n\t\t_tcscpy(szDestExt, &szDestExt[1]);\n\n\t// Replace first * in the destfile with the srcfile, remove any other *\n\tUtil_ExpandFilenameWildcardPart(szSrcFile, szDestFile, szExpandedDest);\n\t\n\tif (*szSrcExt || *szDestExt)\n\t{\n\t\tLPTSTR ext = _tcschr(szExpandedDest, '\\0');\n\t\t\n\t\tif (!szDestExt[0])\n\t\t{\n\t\t\t// Always include the source extension if destination extension was blank\n\t\t\t// (for backward-compatibility, this is done even if a '.' was present)\n\t\t\tszDestExt[0] = '*';\n\t\t\tszDestExt[1] = '\\0';\n\t\t}\n\n\t\t// Replace first * in the destext with the srcext, remove any other *\n\t\tUtil_ExpandFilenameWildcardPart(szSrcExt, szDestExt, ext + 1);\n\n\t\t// If there's a non-blank extension, replace the filename's null terminator with .\n\t\tif (ext[1])\n\t\t\t*ext = '.';\n\t}\n}\n\n\n\nvoid Line::Util_ExpandFilenameWildcardPart(LPCTSTR szSource, LPCTSTR szDest, LPTSTR szExpandedDest)\n{\n\tLPTSTR lpTemp;\n\tint i, j, k;\n\n\t// Replace first * in the dest with the src, remove any other *\n\ti = 0; j = 0; k = 0;\n\tlpTemp = (LPTSTR)_tcschr(szDest, '*');\n\tif (lpTemp != NULL)\n\t{\n\t\t// Contains at least one *, copy up to this point\n\t\twhile(szDest[i] != '*')\n\t\t\tszExpandedDest[j++] = szDest[i++];\n\t\t// Skip the * and replace in the dest with the srcext\n\t\twhile(szSource[k] != '\\0')\n\t\t\tszExpandedDest[j++] = szSource[k++];\n\t\t// Skip any other *\n\t\ti++;\n\t\twhile(szDest[i] != '\\0')\n\t\t{\n\t\t\tif (szDest[i] == '*')\n\t\t\t\ti++;\n\t\t\telse\n\t\t\t\tszExpandedDest[j++] = szDest[i++];\n\t\t}\n\t\tszExpandedDest[j] = '\\0';\n\t}\n\telse\n\t{\n\t\t// No wildcard, straight copy of destext\n\t\t_tcscpy(szExpandedDest, szDest);\n\t}\n}\n\n\n\nbool Line::Util_IsDir(LPCTSTR szPath) // Returns true if the path is a directory\n{\n\tDWORD dwTemp = GetFileAttributes(szPath);\n\treturn dwTemp != 0xffffffff && (dwTemp & FILE_ATTRIBUTE_DIRECTORY);\n}\n\n\n\nvoid Line::Util_GetFullPathName(LPCTSTR szIn, LPTSTR szOut)\n// Returns the full pathname and strips any trailing \\s. Assumes output is _MAX_PATH in size.\n{\n\tASSERT(*szIn && szOut);\n\tLPTSTR szFilePart;\n\tGetFullPathName(szIn, _MAX_PATH, szOut, &szFilePart);\n\tstrip_trailing_backslash(szOut);\n}\n\n\n\nvoid Line::Util_GetFullPathName(LPCTSTR szIn, LPTSTR szOut, DWORD aBufSize)\n{\n\tASSERT(*szIn && szOut);\n\tGetFullPathName(szIn, aBufSize, szOut, NULL);\n\tstrip_trailing_backslash(szOut);\n}\n\n\n\nFResult Shutdown(int nFlag)\n// Shutdown or logoff the system.\n// Returns OK if successful.\n{\n/* \nflags can be a combination of:\n#define EWX_LOGOFF 0\n#define EWX_SHUTDOWN 0x00000001\n#define EWX_REBOOT 0x00000002\n#define EWX_FORCE 0x00000004\n#define EWX_POWEROFF 0x00000008 */\n\n\tHANDLE\t\t\t\thToken; \n\tTOKEN_PRIVILEGES\ttkp; \n\n\t// Get a token for this process.\n \tif (!OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &hToken)) \n\t\treturn FR_E_WIN32;\n \n\t// Get the LUID for the shutdown privilege.\n \tLookupPrivilegeValue(NULL, SE_SHUTDOWN_NAME, &tkp.Privileges[0].Luid); \n \n\ttkp.PrivilegeCount = 1; /* one privilege to set */\n\ttkp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED; \n \n\t// Get the shutdown privilege for this process.\n \tAdjustTokenPrivileges(hToken, FALSE, &tkp, 0, (PTOKEN_PRIVILEGES)NULL, 0); \n \n\t// Cannot test the return value of AdjustTokenPrivileges.\n \tif (GetLastError() != ERROR_SUCCESS) \n\t\treturn FR_E_WIN32;\n\n\t// ExitWindows\n\tif (ExitWindowsEx(nFlag, 0))\n\t\treturn OK;\n\telse\n\t\treturn FR_E_WIN32;\n}\n\n\n\nvoid Util_WinKill(HWND hWnd)\n{\n\tDWORD_PTR dwResult;\n\t// Use WM_CLOSE vs. SC_CLOSE in this case, since the target window is slightly more likely to\n\t// respond to that:\n\tif (!SendMessageTimeout(hWnd, WM_CLOSE, 0, 0, SMTO_ABORTIFHUNG, 500, &dwResult)) // Wait up to 500ms.\n\t{\n\t\t// Use more force - Mwuahaha\n\t\tDWORD pid = 0;\n\t\tGetWindowThreadProcessId(hWnd, &pid);\n\t\tHANDLE hProcess = pid ? OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid) : NULL;\n\t\tif (hProcess)\n\t\t{\n\t\t\tTerminateProcess(hProcess, 0);\n\t\t\tCloseHandle(hProcess);\n\t\t}\n\t}\n}\n\n\n\nvoid DoIncrementalMouseMove(int aX1, int aY1, int aX2, int aY2, int aSpeed)\n// aX1 and aY1 are the starting coordinates, and \"2\" are the destination coordinates.\n// Caller has ensured that aSpeed is in the range 0 to 100, inclusive.\n{\n\t// AutoIt3: So, it's a more gradual speed that is needed :)\n\tint delta;\n\t#define INCR_MOUSE_MIN_SPEED 32\n\n\twhile (aX1 != aX2 || aY1 != aY2)\n\t{\n\t\tif (aX1 < aX2)\n\t\t{\n\t\t\tdelta = (aX2 - aX1) / aSpeed;\n\t\t\tif (delta == 0 || delta < INCR_MOUSE_MIN_SPEED)\n\t\t\t\tdelta = INCR_MOUSE_MIN_SPEED;\n\t\t\tif ((aX1 + delta) > aX2)\n\t\t\t\taX1 = aX2;\n\t\t\telse\n\t\t\t\taX1 += delta;\n\t\t} \n\t\telse \n\t\t\tif (aX1 > aX2)\n\t\t\t{\n\t\t\t\tdelta = (aX1 - aX2) / aSpeed;\n\t\t\t\tif (delta == 0 || delta < INCR_MOUSE_MIN_SPEED)\n\t\t\t\t\tdelta = INCR_MOUSE_MIN_SPEED;\n\t\t\t\tif ((aX1 - delta) < aX2)\n\t\t\t\t\taX1 = aX2;\n\t\t\t\telse\n\t\t\t\t\taX1 -= delta;\n\t\t\t}\n\n\t\tif (aY1 < aY2)\n\t\t{\n\t\t\tdelta = (aY2 - aY1) / aSpeed;\n\t\t\tif (delta == 0 || delta < INCR_MOUSE_MIN_SPEED)\n\t\t\t\tdelta = INCR_MOUSE_MIN_SPEED;\n\t\t\tif ((aY1 + delta) > aY2)\n\t\t\t\taY1 = aY2;\n\t\t\telse\n\t\t\t\taY1 += delta;\n\t\t} \n\t\telse \n\t\t\tif (aY1 > aY2)\n\t\t\t{\n\t\t\t\tdelta = (aY1 - aY2) / aSpeed;\n\t\t\t\tif (delta == 0 || delta < INCR_MOUSE_MIN_SPEED)\n\t\t\t\t\tdelta = INCR_MOUSE_MIN_SPEED;\n\t\t\t\tif ((aY1 - delta) < aY2)\n\t\t\t\t\taY1 = aY2;\n\t\t\t\telse\n\t\t\t\t\taY1 -= delta;\n\t\t\t}\n\n\t\tMouseEvent(MOUSEEVENTF_MOVE | MOUSEEVENTF_ABSOLUTE, 0, aX1, aY1);\n\t\tDoMouseDelay();\n\t\t// Above: A delay is required for backward compatibility and because it's just how the incremental-move\n\t\t// feature was originally designed in AutoIt v3. It may in fact improve reliability in some cases,\n\t\t// especially with the mouse_event() method vs. SendInput/Play.\n\t} // while()\n}\n\n\n\n////////////////////\n// PROCESS ROUTINES\n////////////////////\n\nDWORD ProcessExist(LPCTSTR aProcess, bool aGetParent, bool aVerifyPID)\n{\n\t// Determine the PID if aProcess is a pure, non-negative integer (any negative number\n\t// is more likely to be the name of a process [with a leading dash], rather than the PID).\n\tDWORD specified_pid = IsNumeric(aProcess) ? ATOU(aProcess) : 0;\n\tif (specified_pid && !aGetParent)\n\t{\n\t\t// Most of the time while a PID is being used, the process still exists. So try opening\n\t\t// the process directly, since doing so is much faster than enumerating all processes:\n\t\tif (HANDLE hproc = OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION | SYNCHRONIZE, FALSE, specified_pid))\n\t\t{\n\t\t\tDWORD wait_result = WAIT_FAILED;\n\t\t\t// OpenProcess can succeed for erroneous PID values; e.g. values of 1501 to 1503 can\n\t\t\t// open the process with ID 1500. This is likely due to the undocumented fact that\n\t\t\t// PIDs are a multiple of four: https://devblogs.microsoft.com/oldnewthing/20080228-00/?p=23283\n\t\t\tDWORD actual_pid = GetProcessId(hproc); // Requires PROCESS_QUERY_LIMITED_INFORMATION access.\n\t\t\tif (actual_pid == specified_pid)\n\t\t\t{\n\t\t\t\t// OpenProcess can succeed for a process which has already exited if another process\n\t\t\t\t// still has an open handle to it. So check whether it's still running:\n\t\t\t\twait_result = WaitForSingleObject(hproc, 0); // Requires SYNCHRONIZE access.\n\t\t\t}\n\t\t\tCloseHandle(hproc);\n\t\t\tif (wait_result == WAIT_OBJECT_0)\n\t\t\t\treturn 0; // Process has exited.\n\t\t\tif (wait_result == WAIT_TIMEOUT)\n\t\t\t\treturn specified_pid; // Process still running.\n\t\t\t// Otherwise, fall back to the slow but more reliable method to get a more conclusive result.\n\t\t}\n\t\t// If OpenProcess failed, some likely causes are ERROR_ACCESS_DENIED and ERROR_INVALID_PARAMETER.\n\t\t// The latter probably indicates the PID is invalid, but we continue anyway, for the unlikely\n\t\t// case of a process with a name composed of digits and no extension (verified possible).\n\t\t// If ERROR_ACCESS_DENIED was returned, we can't rule out the false-positive cases described\n\t\t// above without doing a thorough enumeration of processes, so continue in that case as well.\n\t\tif (!aVerifyPID && GetLastError() != ERROR_INVALID_PARAMETER && !(specified_pid & 3))\n\t\t\t// Caller doesn't strictly need a result of \"no such process\" if the process apparently\n\t\t\t// exists but can't be opened, so we return early under these specific conditions.\n\t\t\t// This speeds up ProcessGetPath(PID) when PID identifies a protected system process,\n\t\t\t// without affecting error detection significantly.\n\t\t\treturn specified_pid;\n\t\t// (specified_pid & 3) almost certainly means an invalid PID, but since that's not documented,\n\t\t// do a thorough check before returning 0 in case there ever is a valid PID like that.\n\t}\n\n\tPROCESSENTRY32 proc;\n proc.dwSize = sizeof(proc);\n\tHANDLE snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);\n\tProcess32First(snapshot, &proc);\n\n\twhile (Process32Next(snapshot, &proc))\n\t{\n\t\tif (specified_pid && specified_pid == proc.th32ProcessID)\n\t\t{\n\t\t\tCloseHandle(snapshot);\n\t\t\treturn aGetParent ? proc.th32ParentProcessID : specified_pid;\n\t\t}\n\t\t// Otherwise, check for matching name even if aProcess is purely numeric (i.e. a number might\n\t\t// also be a valid name?):\n\t\t// It seems that proc.szExeFile never contains a path, just the executable name.\n\t\t// But in case it ever does, ensure consistency by removing the path:\n\t\tLPCTSTR proc_name = _tcsrchr(proc.szExeFile, '\\\\');\n\t\tproc_name = proc_name ? proc_name + 1 : proc.szExeFile;\n\t\tif (!_tcsicmp(proc_name, aProcess)) // lstrcmpi() is not used: 1) avoids breaking existing scripts; 2) provides consistent behavior across multiple locales; 3) performance.\n\t\t{\n\t\t\tCloseHandle(snapshot);\n\t\t\treturn aGetParent ? proc.th32ParentProcessID : proc.th32ProcessID;\n\t\t}\n\t}\n\tCloseHandle(snapshot);\n\treturn 0; // Not found.\n}\n"},"size":{"kind":"number","value":72149,"string":"72,149"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1730,"string":"1,730"},"avg_line_length":{"kind":"number","value":38.95086705202312,"string":"38.950867"},"max_line_length":{"kind":"number","value":366,"string":"366"},"alphanum_fraction":{"kind":"number","value":0.7207916274560128,"string":"0.720792"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11073,"cells":{"id":{"kind":"number","value":16060,"string":"16,060"},"file_name":{"kind":"string","value":"script_com.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_com.cpp"},"content":{"kind":"string","value":"#include \"stdafx.h\"\n#include \"globaldata.h\"\n#include \"script.h\"\n#include \"script_object.h\"\n#include \"script_com.h\"\n#include \"script_func_impl.h\"\n#include \"script_gui.h\"\n#include <DispEx.h>\n\n\n// IID__IObject -- .NET's System.Object:\nconst IID IID__Object = {0x65074F7F, 0x63C0, 0x304E, 0xAF, 0x0A, 0xD5, 0x17, 0x41, 0xCB, 0x4A, 0x8D};\n\n// Identifies an AutoHotkey object which was passed to a COM API and back again:\nconst IID IID_IObjectComCompatible = { 0x619f7e25, 0x6d89, 0x4eb4, 0xb2, 0xfb, 0x18, 0xe7, 0xc7, 0x3c, 0xe, 0xa6 };\n\n\n\nBIF_DECL(ComObject_Call) // Formerly BIF_ComObjCreate.\n{\n\t++aParam; // Exclude `this`\n\t--aParamCount;\n\n\tHRESULT hr;\n\tCLSID clsid, iid;\n\tfor (;;)\n\t{\n#ifdef UNICODE\n\t\tLPTSTR cls = TokenToString(*aParam[0]);\n#else\n\t\tCStringWCharFromTChar cls = TokenToString(*aParam[0]);\n#endif\n\t\t// It has been confirmed on Windows 10 that both CLSIDFromString and CLSIDFromProgID\n\t\t// were unable to resolve a ProgID starting with '{', like \"{Foo\", though \"Foo}\" works.\n\t\t// There are probably also guidelines and such that prohibit it.\n\t\tif (cls[0] == '{')\n\t\t\thr = CLSIDFromString(cls, &clsid);\n\t\telse\n\t\t\t// CLSIDFromString is known to be able to resolve ProgIDs via the registry,\n\t\t\t// but fails on registration-free classes such as \"Microsoft.Windows.ActCtx\".\n\t\t\t// CLSIDFromProgID works for that, but fails when given a CLSID string\n\t\t\t// (consistent with VBScript and JScript in both cases).\n\t\t\thr = CLSIDFromProgID(cls, &clsid);\n\t\tif (FAILED(hr)) break;\n\n\t\t__int64 punk = 0;\n\t\tif (aParamCount > 1)\n\t\t{\n\t\t\thr = CLSIDFromString(CStringWCharFromTCharIfNeeded(TokenToString(*aParam[1])), &iid);\n\t\t\tif (FAILED(hr)) break;\n\t\t}\n\t\telse\n\t\t\tiid = IID_IDispatch;\n\n\t\thr = CoCreateInstance(clsid, NULL, CLSCTX_SERVER, iid, (void **)&punk);\n\t\tif (FAILED(hr)) break;\n\n\t\t_f_return(new ComObject(punk, iid == IID_IDispatch ? VT_DISPATCH : VT_UNKNOWN));\n\t}\n\tComError(hr, aResultToken);\n}\n\n\nBIF_DECL(BIF_ComObjGet)\n{\n\tHRESULT hr;\n\tIDispatch *pdisp;\n\thr = CoGetObject(CStringWCharFromTCharIfNeeded(TokenToString(*aParam[0])), NULL, IID_IDispatch, (void **)&pdisp);\n\tif (SUCCEEDED(hr))\n\t{\n\t\t_f_return(new ComObject(pdisp));\n\t}\n\t_f_set_retval_p(_T(\"\"), 0);\n\tComError(hr, aResultToken);\n}\n\n\nBIF_DECL(BIF_ComObj) // Handles both ComObjFromPtr and ComValue.Call.\n{\n\tif (!TokenIsNumeric(*aParam[0]))\n\t\t_f_throw_param(0, _T(\"Number\"));\n\t\t\n\tVARTYPE vt;\n\tunion\n\t{\n\t\t__int64 llVal = 0; // Must be zero-initialized for TokenToVarType().\n\t\tdouble dblVal;\n\t\tfloat fltVal;\n\t};\n\tHRESULT hr;\n\tUSHORT flags = 0;\n\n\tif (aParamCount > 1)\n\t{\n\t\t// ComValue(vt, value [, flags])\n\t\tif (aParamCount > 2)\n\t\t{\n\t\t\tThrow_if_Param_NaN(2);\n\t\t\tflags = (USHORT)TokenToInt64(*aParam[2]);\n\t\t}\n\t\tvt = (VARTYPE)TokenToInt64(*aParam[0]);\n\t\tif (FAILED(hr = TokenToVarType(*aParam[1], vt, &llVal, true)))\n\t\t\treturn ComError(hr, aResultToken);\n\t\tif (vt == VT_BSTR && TypeOfToken(*aParam[1]) != SYM_INTEGER)\n\t\t\tflags |= ComObject::F_OWNVALUE; // BSTR was allocated above, so make sure it will be freed later.\n\t}\n\telse\n\t{\n\t\t// ComObjFromPtr(pdisp)\n\t\tvt = VT_DISPATCH;\n\t\tllVal = TokenToInt64(*aParam[0]);\n\t\tif (!(IUnknown *)llVal)\n\t\t\t_f_throw_param(0); // Require ComValue(9,0) for null; assume ComObjFromPtr(0) is an error.\n\t}\n\n\tif (vt == VT_DISPATCH || vt == VT_UNKNOWN)\n\t{\n\t\tIUnknown *punk = (IUnknown *)llVal;\n\t\tif (punk)\n\t\t{\n\t\t\tif (aParamCount == 1) // Implies above set vt = VT_DISPATCH.\n\t\t\t{\n\t\t\t\tIDispatch *pdisp;\n\t\t\t\tif (SUCCEEDED(punk->QueryInterface(IID_IDispatch, (void **)&pdisp)))\n\t\t\t\t{\n\t\t\t\t\t// Replace caller-specified interface pointer with pdisp. v2: Caller is expected\n\t\t\t\t\t// to have called AddRef() if they want to keep the pointer. In v1, nearly all\n\t\t\t\t\t// users of this function either passed the F_OWNVALUE flag or simply failed to\n\t\t\t\t\t// release their copy of the pointer, so now \"taking ownership\" is the default\n\t\t\t\t\t// behaviour and the flag has no effect on VT_DISPATCH/VT_UNKNOWN.\n\t\t\t\t\tpunk->Release();\n\t\t\t\t\tllVal = (__int64)pdisp;\n\t\t\t\t}\n\t\t\t\t// Otherwise interpret it as IDispatch anyway, since caller has requested it and\n\t\t\t\t// there are known cases where it works (such as some CLR COM callable wrappers).\n\t\t\t}\n\t\t}\n\t\t// Otherwise, NULL may have some meaning, so allow it. If the\n\t\t// script tries to invoke the object, it'll get a warning then.\n\t}\n\n\t_f_return(new ComObject(llVal, vt, flags));\n}\n\nBIF_DECL(ComValue_Call)\n{\n\t++aParam; // Exclude `this`\n\t--aParamCount;\n\tBIF_ComObj(aResultToken, aParam, aParamCount);\n}\n\n\nBIF_DECL(BIF_ComObjActive)\n{\n\t_f_set_retval_p(_T(\"\"), 0);\n\n\tHRESULT hr;\n\tCLSID clsid;\n\tIUnknown *punk;\n\thr = CLSIDFromString(CStringWCharFromTCharIfNeeded(TokenToString(*aParam[0])), &clsid);\n\tif (SUCCEEDED(hr))\n\t{\n\t\thr = GetActiveObject(clsid, NULL, &punk);\n\t\tif (SUCCEEDED(hr))\n\t\t{\n\t\t\tIDispatch *pdisp;\n\t\t\thr = punk->QueryInterface(IID_IDispatch, (void **)&pdisp);\n\t\t\tpunk->Release();\n\t\t\tif (SUCCEEDED(hr))\n\t\t\t{\n\t\t\t\t_f_return(new ComObject(pdisp));\n\t\t\t}\n\t\t}\n\t}\n\tComError(hr, aResultToken);\n}\n\n\nITypeInfo *GetClassTypeInfo(IUnknown *aUnk)\n{\n\tBOOL found = false;\n\tITypeInfo *ptinfo;\n\tTYPEATTR *typeattr;\n\n\t// Find class typeinfo via IProvideClassInfo if available.\n\t// Testing shows this works in some cases where the IDispatch method fails,\n\t// such as for an HTMLDivElement object from an IE11 WebBrowser control.\n\tIProvideClassInfo *ppci;\n\tif (SUCCEEDED(aUnk->QueryInterface<IProvideClassInfo>(&ppci)))\n\t{\n\t\tfound = SUCCEEDED(ppci->GetClassInfo(&ptinfo));\n\t\tppci->Release();\n\t\tif (found)\n\t\t\treturn ptinfo;\n\t}\n\n\t//\n\t// Find class typeinfo via IDispatch.\n\t//\n\tIDispatch *pdsp;\n\tITypeLib *ptlib;\n\tIID iid;\n\tif (SUCCEEDED(aUnk->QueryInterface<IDispatch>(&pdsp)))\n\t{\n\t\t// Get IID and typelib of this object's IDispatch implementation.\n\t\tif (SUCCEEDED(pdsp->GetTypeInfo(0, LOCALE_USER_DEFAULT, &ptinfo)))\n\t\t{\n\t\t\tUINT index;\n\t\t\tif (SUCCEEDED(ptinfo->GetTypeAttr(&typeattr)))\n\t\t\t{\n\t\t\t\tiid = typeattr->guid;\n\t\t\t\tptinfo->ReleaseTypeAttr(typeattr);\n\t\t\t\tfound = SUCCEEDED(ptinfo->GetContainingTypeLib(&ptlib, &index));\n\t\t\t}\n\t\t\tptinfo->Release();\n\t\t}\n\t\tpdsp->Release();\n\t}\n\n\tif (!found)\n\t\t// No typelib to search through, so give up.\n\t\treturn NULL;\n\tfound = false;\n\n\tUINT ctinfo = ptlib->GetTypeInfoCount();\n\tfor (UINT i = 0; i < ctinfo; i++)\n\t{\n\t\tTYPEKIND typekind;\n\t\t// Consider only classes:\n\t\tif (FAILED(ptlib->GetTypeInfoType(i, &typekind)) || typekind != TKIND_COCLASS\n\t\t\t|| FAILED(ptlib->GetTypeInfo(i, &ptinfo)))\n\t\t\tcontinue;\n\n\t\tWORD cImplTypes = 0;\n\t\tif (SUCCEEDED(ptinfo->GetTypeAttr(&typeattr)))\n\t\t{\n\t\t\tcImplTypes = typeattr->cImplTypes;\n\t\t\tptinfo->ReleaseTypeAttr(typeattr);\n\t\t}\n\n\t\tfor (UINT j = 0; j < cImplTypes; j++)\n\t\t{\n\t\t\tINT flags;\n\t\t\tif (SUCCEEDED(ptinfo->GetImplTypeFlags(j, &flags)) && flags == IMPLTYPEFLAG_FDEFAULT)\n\t\t\t{\n\t\t\t\t// This is the default interface of the class.\n\t\t\t\tHREFTYPE reftype;\n\t\t\t\tITypeInfo *prinfo;\n\t\t\t\tif (SUCCEEDED(ptinfo->GetRefTypeOfImplType(j, &reftype))\n\t\t\t\t\t&& SUCCEEDED(ptinfo->GetRefTypeInfo(reftype, &prinfo)))\n\t\t\t\t{\n\t\t\t\t\tif (SUCCEEDED(prinfo->GetTypeAttr(&typeattr)))\n\t\t\t\t\t{\n\t\t\t\t\t\t// If the IID matches, this is probably the right class.\n\t\t\t\t\t\tfound = iid == typeattr->guid;\n\t\t\t\t\t\tprinfo->ReleaseTypeAttr(typeattr);\n\t\t\t\t\t}\n\t\t\t\t\tprinfo->Release();\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\tif (found)\n\t\t\tbreak;\n\t\tptinfo->Release();\n\t}\n\tptlib->Release();\n\treturn found ? ptinfo : NULL;\n}\n\n\nBIF_DECL(BIF_ComObjConnect)\n{\n\t_f_set_retval_p(_T(\"\"), 0);\n\t\n\tLPCTSTR prefix = nullptr; // Set default: disconnect.\n\tIObject *handlers = nullptr; //\n\tif (!ParamIndexIsOmitted(1))\n\t{\n\t\tprefix = ParamIndexToString(1);\n\t\thandlers = ParamIndexToObject(1);\n\t\tif (!*prefix && !handlers) // Blank or pure numeric (which is not valid as a prefix).\n\t\t\t_f_throw_param(1);\n\t}\n\n\tif (ComObject *obj = dynamic_cast<ComObject *>(TokenToObject(*aParam[0])))\n\t{\n\t\tif ((obj->mVarType != VT_DISPATCH && obj->mVarType != VT_UNKNOWN) || !obj->mUnknown)\n\t\t{\n\t\t\t_f_throw_param(0);\n\t\t}\n\n\t\tbool already_connected = obj->mEventSink;\n\t\tif (already_connected)\n\t\t{\n\t\t\tif (!prefix)\n\t\t\t{\n\t\t\t\tHRESULT hr = obj->mEventSink->Connect(); // This should result in mEventSink being deleted.\n\t\t\t\tif (FAILED(hr))\n\t\t\t\t\tComError(hr, aResultToken);\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\t\telse\n\t\t\tobj->mEventSink = new ComEvent(obj);\n\t\t\n\t\t// Set or update prefix/event sink prior to calling Advise().\n\t\tobj->mEventSink->SetPrefixOrSink(prefix, handlers);\n\t\tif (already_connected)\n\t\t\treturn;\n\t\t\n\t\tHRESULT hr = E_NOINTERFACE;\n\t\t\n\t\tif (ITypeInfo *ptinfo = GetClassTypeInfo(obj->mUnknown))\n\t\t{\n\t\t\tTYPEATTR *typeattr;\n\t\t\tWORD cImplTypes = 0;\n\t\t\tif (SUCCEEDED(ptinfo->GetTypeAttr(&typeattr)))\n\t\t\t{\n\t\t\t\tcImplTypes = typeattr->cImplTypes;\n\t\t\t\tptinfo->ReleaseTypeAttr(typeattr);\n\t\t\t}\n\n\t\t\tfor (UINT j = 0; j < cImplTypes; j++)\n\t\t\t{\n\t\t\t\tINT flags;\n\t\t\t\tHREFTYPE reftype;\n\t\t\t\tITypeInfo *prinfo;\n\t\t\t\tif (SUCCEEDED(ptinfo->GetImplTypeFlags(j, &flags)) && flags == (IMPLTYPEFLAG_FDEFAULT | IMPLTYPEFLAG_FSOURCE)\n\t\t\t\t\t&& SUCCEEDED(ptinfo->GetRefTypeOfImplType(j, &reftype))\n\t\t\t\t\t&& SUCCEEDED(ptinfo->GetRefTypeInfo(reftype, &prinfo)))\n\t\t\t\t{\n\t\t\t\t\tif (SUCCEEDED(prinfo->GetTypeAttr(&typeattr)))\n\t\t\t\t\t{\n\t\t\t\t\t\tif (typeattr->typekind == TKIND_DISPATCH)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\thr = obj->mEventSink->Connect(prinfo, &typeattr->guid);\n\t\t\t\t\t\t\t// Let the connection point's reference be the only one, so we can detect when it releases.\n\t\t\t\t\t\t\t// If Connect() failed, this will delete the event sink, which will set mEventSink = nullptr.\n\t\t\t\t\t\t\tobj->mEventSink->Release();\n\t\t\t\t\t\t\tprinfo->ReleaseTypeAttr(typeattr);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tprinfo->ReleaseTypeAttr(typeattr);\n\t\t\t\t\t}\n\t\t\t\t\tprinfo->Release();\n\t\t\t\t}\n\t\t\t}\n\t\t\tptinfo->Release();\n\t\t}\n\n\t\tif (FAILED(hr))\n\t\t\tComError(hr, aResultToken);\n\t}\n\telse\n\t\t_f_throw_param(0, _T(\"ComValue\"));\n}\n\n\nComEvent::~ComEvent()\n{\n\t// At this point, all references have been released, including the\n\t// reference held by the connection point (if a connection was made),\n\t// so Unadvise() isn't necessary and couldn't be successful anyway.\n\tif (mObject)\n\t\tmObject->mEventSink = nullptr;\n\tif (mTypeInfo)\n\t\tmTypeInfo->Release();\n\tif (mAhkObject)\n\t\tmAhkObject->Release();\n}\n\n\nBIF_DECL(BIF_ComObjValue)\n{\n\tComObject *obj = dynamic_cast<ComObject *>(TokenToObject(*aParam[0]));\n\tif (!obj)\n\t\t_f_throw_param(0, _T(\"ComValue\"));\n\taResultToken.value_int64 = obj->mVal64;\n}\n\n\nBIF_DECL(BIF_ComObjType)\n{\n\tComObject *obj = dynamic_cast<ComObject *>(TokenToObject(*aParam[0]));\n\tif (!obj)\n\t\t_f_return_empty; // So ComObjType(x) != \"\" can be used for \"x is ComObject\".\n\tif (aParamCount < 2)\n\t{\n\t\taResultToken.value_int64 = obj->mVarType;\n\t}\n\telse\n\t{\n\t\taResultToken.symbol = SYM_STRING; // for all code paths below\n\t\taResultToken.marker = _T(\"\"); // in case of error\n\t\taResultToken.marker_length = 0;\n\n\t\tLPTSTR requested_info = TokenToString(*aParam[1]);\n\n\t\tITypeInfo *ptinfo = NULL;\n\t\tif (tolower(*requested_info) == 'c')\n\t\t{\n\t\t\t// Get class information.\n\t\t\tif ((VT_DISPATCH == obj->mVarType || VT_UNKNOWN == obj->mVarType) && obj->mUnknown)\n\t\t\t{\n\t\t\t\tptinfo = GetClassTypeInfo(obj->mUnknown);\n\t\t\t\tif (ptinfo)\n\t\t\t\t{\n\t\t\t\t\tif (!_tcsicmp(requested_info, _T(\"Class\")))\n\t\t\t\t\t\trequested_info = _T(\"Name\");\n\t\t\t\t\telse if (!_tcsicmp(requested_info, _T(\"CLSID\")))\n\t\t\t\t\t\trequested_info = _T(\"IID\");\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Get IDispatch information.\n\t\t\tif (VT_DISPATCH == obj->mVarType && obj->mDispatch)\n\t\t\t\tif (FAILED(obj->mDispatch->GetTypeInfo(0, LOCALE_USER_DEFAULT, &ptinfo)))\n\t\t\t\t\tptinfo = NULL;\n\t\t}\n\t\tif (ptinfo)\n\t\t{\n\t\t\tif (!_tcsicmp(requested_info, _T(\"Name\")))\n\t\t\t{\n\t\t\t\tBSTR name;\n\t\t\t\tif (SUCCEEDED(ptinfo->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL)))\n\t\t\t\t{\n\t\t\t\t\tTokenSetResult(aResultToken, CStringTCharFromWCharIfNeeded(name), SysStringLen(name));\n\t\t\t\t\tSysFreeString(name);\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (!_tcsicmp(requested_info, _T(\"IID\")))\n\t\t\t{\n\t\t\t\tTYPEATTR *typeattr;\n\t\t\t\tif (SUCCEEDED(ptinfo->GetTypeAttr(&typeattr)))\n\t\t\t\t{\n\t\t\t\t\taResultToken.marker = aResultToken.buf;\n#ifdef UNICODE\n\t\t\t\t\taResultToken.marker_length = StringFromGUID2(typeattr->guid, aResultToken.marker, MAX_NUMBER_SIZE) - 1; // returns length including the null terminator\n#else\n\t\t\t\t\tWCHAR cnvbuf[MAX_NUMBER_SIZE];\n\t\t\t\t\tStringFromGUID2(typeattr->guid, cnvbuf, MAX_NUMBER_SIZE);\n\t\t\t\t\tCStringCharFromWChar cnvstring(cnvbuf);\n\t\t\t\t\tmemcpy(aResultToken.marker, cnvstring.GetBuffer(), aResultToken.marker_length = cnvstring.GetLength());\n#endif\n\t\t\t\t\tptinfo->ReleaseTypeAttr(typeattr);\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t\taResultToken.ParamError(1, aParam[1]);\n\t\t\tptinfo->Release();\n\t\t}\n\t}\n}\n\n\nBIF_DECL(BIF_ComObjFlags)\n{\n\tComObject *obj = dynamic_cast<ComObject *>(TokenToObject(*aParam[0]));\n\tif (!obj)\n\t\t_f_throw_param(0, _T(\"ComValue\"));\n\tif (aParamCount > 1)\n\t{\n\t\tThrow_if_Param_NaN(1);\n\t\tUSHORT flags, mask;\n\t\tif (aParamCount > 2)\n\t\t{\n\t\t\tThrow_if_Param_NaN(2);\n\t\t\tflags = (USHORT)TokenToInt64(*aParam[1]);\n\t\t\tmask = (USHORT)TokenToInt64(*aParam[2]);\n\t\t}\n\t\telse\n\t\t{\n\t\t\t__int64 bigflags = TokenToInt64(*aParam[1]);\n\t\t\tif (bigflags < 0)\n\t\t\t{\n\t\t\t\t// Remove specified -flags.\n\t\t\t\tflags = 0;\n\t\t\t\tmask = (USHORT)-bigflags;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// Add only specified flags.\n\t\t\t\tflags = (USHORT)bigflags;\n\t\t\t\tmask = flags;\n\t\t\t}\n\t\t}\n\t\tobj->mFlags = (obj->mFlags & ~mask) | (flags & mask);\n\t}\n\taResultToken.value_int64 = obj->mFlags;\n}\n\n\nBIF_DECL(ComObjArray_Call)\n{\n\t++aParam; // Exclude `this`\n\t--aParamCount;\n\n\tThrow_if_Param_NaN(0);\n\tVARTYPE vt = (VARTYPE)TokenToInt64(*aParam[0]);\n\tSAFEARRAYBOUND bound[8]; // Same limit as ComObject::SafeArrayInvoke().\n\tint dims = aParamCount - 1;\n\tASSERT(dims <= _countof(bound)); // Enforced by MaxParams.\n\t//if (dims > _countof(bound))\n\t//\t_f_throw(ERR_TOO_MANY_PARAMS);\n\tfor (int i = 0; i < dims; ++i)\n\t{\n\t\tThrow_if_Param_NaN(i + 1);\n\t\tbound[i].cElements = (ULONG)TokenToInt64(*aParam[i + 1]);\n\t\tbound[i].lLbound = 0;\n\t}\n\tif (SAFEARRAY *psa = SafeArrayCreate(vt, dims, bound))\n\t{\n\t\t_f_return(new ComObject((__int64)psa, VT_ARRAY | vt, ComObject::F_OWNVALUE));\n\t}\n\tif (vt > 1 && vt < 0x18 && vt != 0xF)\n\t\t_f_throw_oom;\n\t_f_throw_param(0);\n}\n\n\nBIF_DECL(BIF_ComObjQuery)\n{\n\tIUnknown *punk = NULL;\n\t__int64 pint = 0;\n\tIObject *iobj;\n\tHRESULT hr;\n\n\tif (auto *obj = dynamic_cast<ComObject *>(iobj = TokenToObject(*aParam[0])))\n\t{\n\t\t// We were passed a ComObject, but does it contain an interface pointer?\n\t\tif (obj->mVarType == VT_UNKNOWN || obj->mVarType == VT_DISPATCH)\n\t\t\tpunk = obj->mUnknown;\n\t}\n\tif (!punk)\n\t{\n\t\t// Since it wasn't a valid ComObject, it should be a raw interface pointer.\n\t\tif (iobj)\n\t\t{\n\t\t\t// ComObject isn't handled this way since it could be VT_DISPATCH.\n\t\t\tUINT_PTR ptr;\n\t\t\tif (GetObjectPtrProperty(iobj, _T(\"Ptr\"), ptr, aResultToken) != OK)\n\t\t\t\treturn;\n\t\t\tpunk = (IUnknown *)ptr;\n\t\t}\n\t\telse\n\t\t\tpunk = (IUnknown *)TokenToInt64(*aParam[0]);\n\t}\n\tif (punk < (IUnknown *)65536) // Error-detection: the first 64KB of address space is always invalid.\n\t\t_f_throw_param(0);\n\n\tGUID iid;\n\tif (aParamCount > 2) // QueryService(obj, SID, IID)\n\t{\n\t\tGUID sid;\n\t\tif ( SUCCEEDED(hr = CLSIDFromString(CStringWCharFromTCharIfNeeded(TokenToString(*aParam[1])), &sid))\n\t\t\t&& SUCCEEDED(hr = CLSIDFromString(CStringWCharFromTCharIfNeeded(TokenToString(*aParam[2])), &iid)) )\n\t\t{\n\t\t\tIServiceProvider *pprov;\n\t\t\tif (SUCCEEDED(hr = punk->QueryInterface<IServiceProvider>(&pprov)))\n\t\t\t{\n\t\t\t\thr = pprov->QueryService(sid, iid, (void **)&pint);\n\t\t\t}\n\t\t}\n\t}\n\telse // QueryInterface(obj, IID)\n\t{\n\t\tif (SUCCEEDED(hr = CLSIDFromString(CStringWCharFromTCharIfNeeded(TokenToString(*aParam[1])), &iid)))\n\t\t{\n\t\t\thr = punk->QueryInterface(iid, (void **)&pint);\n\t\t}\n\t}\n\n\tif (pint)\n\t\t_f_return(new ComObject(pint, iid == IID_IDispatch ? VT_DISPATCH : VT_UNKNOWN));\n\tComError(hr, aResultToken);\n}\n\n\nbool SafeSetTokenObject(ExprTokenType &aToken, IObject *aObject)\n{\n\tif (aObject)\n\t{\n\t\taToken.symbol = SYM_OBJECT;\n\t\taToken.object = aObject;\n\t\treturn true;\n\t}\n\telse\n\t{\n\t\taToken.symbol = SYM_STRING;\n\t\taToken.marker = _T(\"\");\n\t\taToken.marker_length = 0;\n\t\treturn false;\n\t}\n}\n\n\nvoid VariantToToken(VARIANT &aVar, ResultToken &aToken, bool aRetainVar = true)\n{\n\taToken.mem_to_free = NULL; // Set default.\t\n\tswitch (aVar.vt)\n\t{\n\tcase VT_BSTR:\n\t\taToken.symbol = SYM_STRING;\n\t\taToken.marker = _T(\"\"); // Set default.\n\t\taToken.marker_length = 0;\n\t\tsize_t len;\n\t\tif (len = SysStringLen(aVar.bstrVal))\n\t\t{\n#ifdef UNICODE\n\t\t\tif (aRetainVar)\n\t\t\t{\n\t\t\t\t// It's safe to pass back the actual BSTR from aVar in this case.\n\t\t\t\taToken.marker = aVar.bstrVal;\n\t\t\t\taToken.marker_length = len;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// Allocate some memory to pass back to caller:\n\t\t\t\taToken.Malloc(aVar.bstrVal, len);\n\t\t\t}\n#else\n\t\t\tCStringCharFromWChar buf(aVar.bstrVal, len);\n\t\t\tlen = buf.GetLength(); // Get ANSI length.\n\t\t\tif (aToken.mem_to_free = buf.DetachBuffer())\n\t\t\t{\n\t\t\t\taToken.marker = aToken.mem_to_free;\n\t\t\t\taToken.marker_length = len;\n\t\t\t}\n#endif\n\t\t}\n\t\tif (!aRetainVar)\n\t\t\tVariantClear(&aVar);\n\t\tbreak;\n\tcase VT_I4:\n\t\taToken.symbol = SYM_INTEGER;\n\t\taToken.value_int64 = aVar.lVal;\n\t\tbreak;\n\tcase VT_R8:\n\t\taToken.symbol = SYM_FLOAT;\n\t\taToken.value_double = aVar.dblVal;\n\t\tbreak;\n\tcase VT_R4:\n\t\taToken.symbol = SYM_FLOAT;\n\t\taToken.value_double = (double)aVar.fltVal;\n\t\tbreak;\n\tcase VT_BOOL:\n\t\taToken.symbol = SYM_INTEGER;\n\t\taToken.value_int64 = aVar.iVal != VARIANT_FALSE;\n\t\tbreak;\n\tcase VT_UNKNOWN:\n\t\tif (aVar.punkVal)\n\t\t{\n\t\t\tIEnumVARIANT *penum;\n\t\t\tif (SUCCEEDED(aVar.punkVal->QueryInterface(IID_IEnumVARIANT, (void**) &penum)))\n\t\t\t{\n\t\t\t\tif (!aRetainVar)\n\t\t\t\t\taVar.punkVal->Release();\n\t\t\t\tif (!SafeSetTokenObject(aToken, new ComEnum(penum)))\n\t\t\t\t\tpenum->Release();\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tIDispatch *pdisp;\n\t\t\t// .NET objects implement the COM IDispatch interface, but unfortunately\n\t\t\t// they don't always respond to QueryInterface() for said interface. So\n\t\t\t// instead we have to query for the _Object interface, which itself\n\t\t\t// inherits from IDispatch.\n\t\t\tif (SUCCEEDED(aVar.punkVal->QueryInterface(IID__Object, (void**) &pdisp)))\n\t\t\t{\n\t\t\t\tif (!aRetainVar)\n\t\t\t\t\taVar.punkVal->Release();\n\t\t\t\tif (!SafeSetTokenObject(aToken, new ComObject(pdisp)))\n\t\t\t\t\tpdisp->Release();\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\t// FALL THROUGH to the next case:\n\tcase VT_DISPATCH:\n\t\tif (aVar.punkVal)\n\t\t{\n\t\t\tIObjectComCompatible *pobj;\n\t\t\tif (SUCCEEDED(aVar.punkVal->QueryInterface(IID_IObjectComCompatible, (void**)&pobj)))\n\t\t\t{\n\t\t\t\taToken.object = pobj;\n\t\t\t\taToken.symbol = SYM_OBJECT;\n\t\t\t\tif (!aRetainVar)\n\t\t\t\t\t// QI called AddRef, so Release this reference.\n\t\t\t\t\taVar.punkVal->Release();\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (aRetainVar)\n\t\t\t\t// Caller is keeping their ref, so we AddRef.\n\t\t\t\taVar.punkVal->AddRef();\n\t\t\taToken.object = new ComObject((__int64)aVar.punkVal, aVar.vt);\n\t\t\taToken.symbol = SYM_OBJECT;\n\t\t\tbreak;\n\t\t}\n\t\t// FALL THROUGH to the next case:\n\tcase VT_EMPTY:\n\tcase VT_NULL:\n\t\taToken.symbol = SYM_STRING;\n\t\taToken.marker = _T(\"\");\n\t\taToken.marker_length = 0;\n\t\tbreak;\n\tcase VT_I1:\n\tcase VT_I2:\n\tcase VT_I8:\n\tcase VT_UI1:\n\tcase VT_UI2:\n\tcase VT_UI4:\n\tcase VT_UI8:\n\t{\n\t\tVARIANT var {};\n\t\tVariantChangeType(&var, &aVar, 0, VT_I8);\n\t\taToken.symbol = SYM_INTEGER;\n\t\taToken.value_int64 = var.llVal;\n\t\tbreak;\n\t}\n\tcase VT_ERROR:\n\t\tif (aVar.scode == DISP_E_PARAMNOTFOUND)\n\t\t{\n\t\t\taToken.symbol = SYM_MISSING;\n\t\t\tbreak;\n\t\t}\n\t\t// FALL THROUGH to the next case:\n\tdefault:\n\t\t{\n\t\t\tVARIANT var = {0};\n\t\t\tif (aVar.vt < VT_ARRAY // i.e. not byref or an array.\n\t\t\t\t&& SUCCEEDED(VariantChangeType(&var, &aVar, 0, VT_BSTR))) // Convert it to a BSTR.\n\t\t\t{\n\t\t\t\t// Recursive call to handle conversions and memory management correctly:\n\t\t\t\tVariantToToken(var, aToken, false);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tif (!SafeSetTokenObject(aToken,\n\t\t\t\t\t\tnew ComObject((__int64)aVar.parray, aVar.vt, aRetainVar ? 0 : ComObject::F_OWNVALUE)))\n\t\t\t\t{\n\t\t\t\t\t// Out of memory; value cannot be returned, so must be freed here.\n\t\t\t\t\tif (!aRetainVar)\n\t\t\t\t\t\tVariantClear(&aVar);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n\nvoid AssignVariant(Var &aArg, VARIANT &aVar, bool aRetainVar = true)\n{\n\tif (aVar.vt == VT_BSTR)\n\t{\n\t\t// Avoid an unnecessary mem alloc and copy in some cases.\n\t\taArg.AssignStringW(aVar.bstrVal, SysStringLen(aVar.bstrVal));\n\t\tif (!aRetainVar)\n\t\t\tVariantClear(&aVar);\n\t\treturn;\n\t}\n\tResultToken token;\n\tVariantToToken(aVar, token, aRetainVar);\n\tswitch (token.symbol)\n\t{\n\tcase SYM_STRING: // VT_BSTR was handled above, but VariantToToken coerces unhandled types to strings.\n\t\tif (token.mem_to_free)\n\t\t\taArg.AcceptNewMem(token.mem_to_free, token.marker_length);\n\t\telse // Value was VT_EMPTY or VT_NULL, was coerced to an empty string, or malloc failed.\n\t\t\taArg.Assign();\n\t\tbreak;\n\tcase SYM_OBJECT:\n\t\taArg.AssignSkipAddRef(token.object); // Let aArg take responsibility for it.\n\t\tbreak;\n\tdefault:\n\t\taArg.Assign(token);\n\t\tbreak;\n\t}\n\t//token.Free(); // Above already took care of mem_to_free and object.\n}\n\n\nvoid TokenToVariant(ExprTokenType &aToken, VARIANT &aVar, TTVArgType *aVarIsArg)\n{\n\tif (aVarIsArg)\n\t\t*aVarIsArg = VariantIsValue;\n\n\tif (aToken.symbol == SYM_VAR)\n\t\taToken.var->ToTokenSkipAddRef(aToken);\n\n\tswitch(aToken.symbol)\n\t{\n\tcase SYM_STRING:\n\t\taVar.vt = VT_BSTR;\n\t\taVar.bstrVal = SysAllocString(CStringWCharFromTCharIfNeeded(aToken.marker));\n\t\tif (aVarIsArg)\n\t\t\t*aVarIsArg = VariantIsAllocatedString;\n\t\tbreak;\n\tcase SYM_INTEGER:\n\t\taVar.llVal = aToken.value_int64;\n\t\taVar.vt = (aVar.llVal == (int)aVar.llVal) ? VT_I4 : VT_I8;\n\t\tbreak;\n\tcase SYM_FLOAT:\n\t\taVar.vt = VT_R8;\n\t\taVar.dblVal = aToken.value_double;\n\t\tbreak;\n\tcase SYM_OBJECT:\n\t\tif (ComObject *obj = dynamic_cast<ComObject *>(aToken.object))\n\t\t{\n\t\t\tobj->ToVariant(aVar);\n\t\t\tif (!aVarIsArg)\n\t\t\t{\n\t\t\t\tif (aVar.vt == VT_DISPATCH || aVar.vt == VT_UNKNOWN)\n\t\t\t\t{\n\t\t\t\t\tif (aVar.punkVal)\n\t\t\t\t\t\taVar.punkVal->AddRef();\n\t\t\t\t}\n\t\t\t\telse if (obj->mFlags & ComObject::F_OWNVALUE)\n\t\t\t\t{\n\t\t\t\t\tif ((aVar.vt & ~VT_TYPEMASK) == VT_ARRAY)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Copy array since both sides will call Destroy().\n\t\t\t\t\t\tif (FAILED(SafeArrayCopy(aVar.parray, &aVar.parray)))\n\t\t\t\t\t\t\taVar.vt = VT_EMPTY;\n\t\t\t\t\t}\n\t\t\t\t\telse if (aVar.vt == VT_BSTR)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Copy the string.\n\t\t\t\t\t\taVar.bstrVal = SysAllocStringLen(aVar.bstrVal, SysStringLen(aVar.bstrVal));\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tbreak;\n\t\t}\n\t\tif (aVarIsArg)\n\t\t{\n\t\t\t// Caller is equipped to marshal VT_BYREF|VT_VARIANT back to VarRef, so check for that.\n\t\t\tif (VarRef *ref = dynamic_cast<VarRef *>(aToken.object))\n\t\t\t{\n\t\t\t\t*aVarIsArg = VariantIsVarRef;\n\t\t\t\taVar.vt = VT_BYREF | VT_VARIANT;\n\t\t\t\taVar.pvarVal = (VARIANT *)malloc(sizeof(VARIANT));\n\t\t\t\tExprTokenType token;\n\t\t\t\tref->ToTokenSkipAddRef(token);\n\t\t\t\tif (token.symbol == SYM_MISSING)\n\t\t\t\t\taVar.pvarVal->vt = VT_EMPTY; // Seems better than BSTR(\"\") or ERROR(DISP_E_PARAMNOTFOUND).\n\t\t\t\telse\n\t\t\t\t\tTokenToVariant(token, *aVar.pvarVal, nullptr);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\taVar.vt = VT_DISPATCH;\n\t\taVar.pdispVal = aToken.object;\n\t\tif (!aVarIsArg)\n\t\t\taToken.object->AddRef();\n\t\tbreak;\n\tcase SYM_MISSING:\n\t\taVar.vt = VT_ERROR;\n\t\taVar.scode = DISP_E_PARAMNOTFOUND;\n\t\tbreak;\n\t}\n}\n\n\nHRESULT TokenToVarType(ExprTokenType &aToken, VARTYPE aVarType, void *apValue, bool aCallerIsComValue)\n// Copy the value of a given token into a variable of the given VARTYPE.\n{\n\tif (aVarType == VT_VARIANT)\n\t{\n\t\tVariantClear((VARIANT *)apValue);\n\t\tTokenToVariant(aToken, *(VARIANT *)apValue, FALSE);\n\t\treturn S_OK;\n\t}\n\n#define U 0 // Unsupported in SAFEARRAY/VARIANT (but vt 15 has no assigned meaning).\n#define P sizeof(void *)\n\t// Unfortunately there appears to be no function to get the size of a given VARTYPE,\n\t// and VariantCopyInd() copies in the wrong direction. An alternative approach to\n\t// the following would be to switch(aVarType) and copy using the appropriate pointer\n\t// type, but disassembly shows that approach produces larger code and internally uses\n\t// an array of sizes like this anyway:\n\tstatic const char vt_size[] = {U,U,2,4,4,8,8,8,P,P,4,2,U,P,U,U,1,1,2,4,8,8,4,4,U,U,U,U,U,U,U,U,U,U,U,U,U,P,P};\n\t// Checking aCallerIsComValue has these purposes:\n\t// - Let ComValue() accept a raw pointer/integer value for VT_BYREF, VT_ARRAY and\n\t// any types not explicitly supported.\n\t// - When an integer value is passed by ComValue(), copy all 64 bits.\n\tsize_t vsize = aCallerIsComValue ? 8 : (aVarType < _countof(vt_size)) ? vt_size[aVarType] : 0;\n\tif (!vsize)\n\t\treturn DISP_E_BADVARTYPE;\n#undef P\n#undef U\n\n\tVARIANT src;\n\n\tif (aVarType == VT_BOOL)\n\t{\n\t\t// Use AutoHotkey's boolean evaluation rules, but VARIANT_TRUE == -1.\n\t\t*((VARIANT_BOOL*)apValue) = -TokenToBOOL(aToken);\n\t\treturn S_OK;\n\t}\n\n\tif (TypeOfToken(aToken) == SYM_INTEGER)\n\t{\n\t\t// This has a few uses:\n\t\t// - Allows pointer types to be initialized by pointer value for ComValue().\n\t\t// - Avoids truncation or loss of precision for large integer values,\n\t\t// since TokenToVariant() only uses the common VT_I4 or VT_R8 types.\n\t\t// - Probably faster.\n\t\tsrc.vt = VT_I8;\n\t\tsrc.llVal = TokenToInt64(aToken);\n\t\tswitch (aVarType)\n\t\t{\n\t\tcase VT_R4:\n\t\tcase VT_R8:\n\t\tcase VT_DATE: // Date is \"double\" based.\n\t\t\t// Doesn't make sense to reinterpret the bits of an integer value as float.\n\t\t\tbreak;\n\t\tcase VT_CY:\n\t\t\t// This ensures 42 and 42.0 produce the same value.\n\t\t\tsrc.llVal *= 10000;\n\t\t\t*((CY*)apValue) = src.cyVal;\n\t\t\treturn S_OK;\n\t\tcase VT_BSTR:\n\t\tcase VT_DISPATCH:\n\t\tcase VT_UNKNOWN:\n\t\t\tif (!aCallerIsComValue)\n\t\t\t\tbreak;\n\t\t\t// Otherwise, fall through:\n\t\tdefault:\n\t\t\tmemcpy(apValue, &src.llVal, vsize);\n\t\t\treturn S_OK;\n\t\t}\n\t}\n\telse\n\t\tTokenToVariant(aToken, src, FALSE);\n\t// Above may have set var.vt to VT_BSTR (a newly allocated string or one passed via ComObject),\n\t// VT_DISPATCH or VT_UNKNOWN (in which case it called AddRef()). The value is either freed by\n\t// VariantChangeType() or moved into *apValue, so we don't free it except on failure.\n\tif (src.vt != aVarType)\n\t{\n\t\t// Attempt to coerce var to the correct type:\n\t\tHRESULT hr = VariantChangeType(&src, &src, 0, aVarType);\n\t\tif (FAILED(hr))\n\t\t{\n\t\t\tVariantClear(&src);\n\t\t\treturn hr;\n\t\t}\n\t}\n\t// Free existing value.\n\tif (aVarType == VT_UNKNOWN || aVarType == VT_DISPATCH)\n\t{\n\t\tIUnknown *punk = *(IUnknown **)apValue;\n\t\tif (punk)\n\t\t\tpunk->Release();\n\t}\n\telse if (aVarType == VT_BSTR)\n\t{\n\t\tSysFreeString(*(BSTR *)apValue);\n\t}\n\t// Write new value (shallow copy).\n\tmemcpy(apValue, &src.lVal, vsize);\n\treturn S_OK;\n}\n\n\nvoid VarTypeToToken(VARTYPE aVarType, void *apValue, ResultToken &aToken)\n// Copy a value of the given VARTYPE into a token.\n{\n\tVARIANT src, dst;\n\tsrc.vt = VT_BYREF | aVarType;\n\tsrc.pbVal = (BYTE *)apValue;\n\tdst.vt = VT_EMPTY;\n\tif (FAILED(VariantCopyInd(&dst, &src)))\n\t\tdst.vt = VT_EMPTY;\n\tVariantToToken(dst, aToken, false);\n}\n\n\nResultType ComError(HRESULT hr)\n{\n\tResultToken errorToken;\n\terrorToken.SetResult(OK);\n\tComError(hr, errorToken);\n\treturn errorToken.Result();\n}\n\nvoid ComError(HRESULT hr, ResultToken &aResultToken, LPTSTR name, EXCEPINFO* pei)\n{\n\tif (hr != DISP_E_EXCEPTION)\n\t\tpei = NULL;\n\n\tif (pei)\n\t{\n\t\tif (pei->pfnDeferredFillIn)\n\t\t\t(*pei->pfnDeferredFillIn)(pei);\n\t\thr = pei->wCode ? 0x80040200 + pei->wCode : pei->scode;\n\t}\n\n\tTCHAR buf[4096];\n\tint size = _stprintf(buf, _T(\"(0x%X) \"), hr);\n\tauto msg_buf = buf + size;\n\tint msg_size = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, hr, 0, msg_buf, _countof(buf) - size - 1, NULL);\n\tif (msg_size)\n\t{\n\t\t// Remove any possible trailing \\r\\n.\n\t\tif (msg_buf[msg_size-1] == '\\n')\n\t\t\tmsg_buf[--msg_size] = '\\0';\n\t\tif (msg_buf[msg_size-1] == '\\r')\n\t\t\tmsg_buf[--msg_size] = '\\0';\n\t}\n\tsize += msg_size;\n\tif (pei)\n\t{\n\t\tif (pei->bstrDescription)\n\t\t\tsize += _sntprintf(buf + size, _countof(buf) - size, _T(\"\\n%ws\"), pei->bstrDescription);\n\t\tif (pei->bstrSource)\n\t\t\tsize += _sntprintf(buf + size, _countof(buf) - size, _T(\"\\nSource:\\t%ws\"), pei->bstrSource);\n\t}\n\n\tif (pei)\n\t{\n\t\tSysFreeString(pei->bstrSource);\n\t\tSysFreeString(pei->bstrDescription);\n\t\tSysFreeString(pei->bstrHelpFile);\n\t}\n\n\taResultToken.Error(buf, name);\n}\n\n\n\nSTDMETHODIMP ComEvent::QueryInterface(REFIID riid, void **ppv)\n{\n\tif (riid == mIID || riid == IID_IDispatch || riid == IID_IUnknown)\n\t{\n\t\tAddRef();\n\t\t*ppv = this;\n\t\treturn S_OK;\n\t}\n\telse\n\t{\n\t\t*ppv = NULL;\n\t\treturn E_NOINTERFACE;\n\t}\n}\n\nSTDMETHODIMP ComEvent::GetIDsOfNames(REFIID riid, LPOLESTR *rgszNames, UINT cNames, LCID lcid, DISPID *rgDispId)\n{\n\treturn mTypeInfo->GetIDsOfNames(rgszNames, cNames, rgDispId);\n}\n\nSTDMETHODIMP ComEvent::Invoke(DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS *pDispParams, VARIANT *pVarResult, EXCEPINFO *pExcepInfo, UINT *puArgErr)\n{\n\tif (!mObject) // mObject == NULL should be impossible unless Unadvise() somehow fails while leaving behind a valid connection. Check it anyway since it might be difficult to debug, depending on what we're connected to.\n\t\treturn DISP_E_MEMBERNOTFOUND;\n\n\t// Resolve method name.\n\tBSTR memberName;\n\tUINT nNames;\n\tif (FAILED(mTypeInfo->GetNames(dispIdMember, &memberName, 1, &nNames)))\n\t\treturn DISP_E_MEMBERNOTFOUND;\n\n\tUINT cArgs = pDispParams->cArgs;\n\tconst UINT ADDITIONAL_PARAMS = 2; // mObject (passed by us) and mAhkObject (passed by Object::Invoke).\n\tconst UINT MAX_COM_PARAMS = MAX_FUNCTION_PARAMS - ADDITIONAL_PARAMS;\n\tif (cArgs > MAX_COM_PARAMS) // Probably won't happen in any real-world script.\n\t\tcArgs = MAX_COM_PARAMS; // Just omit the rest of the params.\n\n\t// Make a temporary copy of pDispParams to allow us to insert one:\n\tDISPPARAMS dispParams;\n\tVARIANTARG *vargs = (VARIANTARG *)_alloca((cArgs + 1) * sizeof(VARIANTARG));\n\tmemcpy(&dispParams, pDispParams, sizeof(dispParams));\n\tmemcpy(vargs + 1, pDispParams->rgvarg, cArgs * sizeof(VARIANTARG));\n\tdispParams.rgvarg = vargs;\n\t\n\t// Pass our object last (right-to-left) for either of the following cases:\n\t//\ta) Our caller doesn't include its IDispatch interface pointer in the parameter list.\n\t//\tb) The script needs a reference to the original wrapper object; i.e. mObject.\n\tvargs[0].vt = VT_DISPATCH;\n\tvargs[0].pdispVal = mObject;\n\tdispParams.cArgs = ++cArgs;\n\n\tHRESULT hr;\n\tIDispatch *func;\n\tDISPID dispid;\n\n\tif (mAhkObject)\n\t{\n\t\tfunc = mAhkObject;\n\t\thr = func->GetIDsOfNames(IID_NULL, &memberName, 1, lcid, &dispid);\n\t}\n\telse\n\t{\n\t\t// Copy method name into our buffer, applying prefix and converting if necessary.\n\t\tTCHAR funcName[256];\n\t\tsntprintf(funcName, _countof(funcName), _T(\"%s%ws\"), mPrefix, memberName);\n\t\t// Find the script function (or any callable object in a global var):\n\t\tfunc = mModule->FindGlobalObject(funcName);\n\t\tdispid = DISPID_VALUE;\n\t\thr = func ? S_OK : DISP_E_MEMBERNOTFOUND;\n\t}\n\tSysFreeString(memberName);\n\n\tif (SUCCEEDED(hr))\n\t\thr = func->Invoke(dispid, riid, lcid, wFlags, &dispParams, pVarResult, pExcepInfo, puArgErr);\n\n\treturn hr;\n}\n\nHRESULT ComEvent::Connect(ITypeInfo *tinfo, IID *iid)\n{\n\tbool want_to_connect = tinfo;\n\tif (want_to_connect)\n\t{\n\t\t// Set these unconditionally to ensure they are released on failure or disconnection.\n\t\tASSERT(!mTypeInfo && iid);\n\t\tmTypeInfo = tinfo;\n\t\tmIID = *iid;\n\t}\n\t\n\tIConnectionPointContainer *pcpc;\n\tHRESULT hr = mObject->mDispatch->QueryInterface(IID_IConnectionPointContainer, (void **)&pcpc);\n\tif (SUCCEEDED(hr))\n\t{\n\t\tIConnectionPoint *pconn;\n\t\thr = pcpc->FindConnectionPoint(mIID, &pconn);\n\t\tif (SUCCEEDED(hr))\n\t\t{\n\t\t\tif (want_to_connect)\n\t\t\t\thr = pconn->Advise(this, &mCookie);\n\t\t\telse if (mCookie != 0) // This check preserves legacy behaviour of ComObjConnect(obj) without a prior connection.\n\t\t\t\thr = pconn->Unadvise(mCookie); // This should result in this ComEvent being deleted.\n\t\t\tpconn->Release();\n\t\t}\n\t\tpcpc->Release();\n\t}\n\treturn hr;\n}\n\nvoid ComEvent::SetPrefixOrSink(LPCTSTR pfx, IObject *ahkObject)\n{\n\tif (mAhkObject)\n\t{\n\t\tmAhkObject->Release();\n\t\tmAhkObject = NULL;\n\t}\n\tif (ahkObject)\n\t{\n\t\tahkObject->AddRef();\n\t\tmAhkObject = ahkObject;\n\t}\n\tif (pfx)\n\t{\n\t\tmModule = g_script.CurrentModule();\n\t\ttcslcpy(mPrefix, pfx, _countof(mPrefix));\n\t}\n}\n\nResultType ComObject::Invoke(IObject_Invoke_PARAMS_DECL)\n{\n\tif (mVarType != VT_DISPATCH || !mDispatch)\n\t{\n\t\tIObject *proto;\n\t\tif (mVarType & VT_ARRAY)\n\t\t\tproto = Object::sComArrayPrototype;\n\t\telse if (mVarType & VT_BYREF)\n\t\t\tproto = Object::sComRefPrototype;\n\t\telse\n\t\t\tproto = Object::sComValuePrototype;\n\t\treturn proto->Invoke(aResultToken, aFlags | IF_SUBSTITUTE_THIS, aName, aThisToken, aParam, aParamCount);\n\t}\n\n\tDISPID dispid;\n\tHRESULT\thr;\n\tif ((aFlags & IF_NEWENUM) && (!aParamCount || ParamIndexToInt(0) <= 2))\n\t{\n\t\thr = S_OK;\n\t\tdispid = DISPID_NEWENUM;\n\t\taName = _T(\"_NewEnum\"); // Init for ComError().\n\t\taParamCount = 0;\n\t}\n\telse if (!aName)\n\t{\n\t\thr = S_OK;\n\t\tdispid = DISPID_VALUE;\n\t}\n\telse\n\t{\n#ifdef UNICODE\n\t\tLPOLESTR wname = aName;\n#else\n\t\tCStringWCharFromChar cnvbuf(aName);\n\t\tLPOLESTR wname = (LPOLESTR)(LPCWSTR)cnvbuf;\n#endif\n\t\thr = mDispatch->GetIDsOfNames(IID_NULL, &wname, 1, LOCALE_USER_DEFAULT, &dispid);\n\t\tif (hr == DISP_E_UNKNOWNNAME) // v1.1.18: Retry with IDispatchEx if supported, to allow creating new properties.\n\t\t{\n\t\t\tif (IS_INVOKE_SET)\n\t\t\t{\n\t\t\t\tIDispatchEx *dispEx;\n\t\t\t\tif (SUCCEEDED(mDispatch->QueryInterface<IDispatchEx>(&dispEx)))\n\t\t\t\t{\n\t\t\t\t\tBSTR bname = SysAllocString(wname);\n\t\t\t\t\t// fdexNameEnsure gives us a new ID if needed, though GetIDsOfNames() will\n\t\t\t\t\t// still fail for some objects until after the assignment is performed below.\n\t\t\t\t\thr = dispEx->GetDispID(bname, fdexNameEnsure, &dispid);\n\t\t\t\t\tSysFreeString(bname);\n\t\t\t\t\tdispEx->Release();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif (FAILED(hr))\n\t\t\taParamCount = 0; // Skip parameter conversion and cleanup.\n\t}\n\t\n\tstatic DISPID dispidParam = DISPID_PROPERTYPUT;\n\tDISPPARAMS dispparams = {NULL, NULL, 0, 0};\n\tVARIANTARG *rgvarg;\n\tTTVArgType *argtype;\n\tEXCEPINFO excepinfo = {0};\n\tVARIANT varResult = {0};\n\t\n\tif (aParamCount)\n\t{\n\t\trgvarg = (VARIANTARG *)_alloca(sizeof(VARIANTARG) * aParamCount);\n\t\targtype = (TTVArgType *)_alloca(sizeof(TTVArgType) * aParamCount);\n\n\t\tfor (int i = 1; i <= aParamCount; i++)\n\t\t{\n\t\t\tTokenToVariant(*aParam[aParamCount-i], rgvarg[i-1], &argtype[i-1]);\n\t\t}\n\n\t\tdispparams.rgvarg = rgvarg;\n\t\tdispparams.cArgs = aParamCount;\n\t\tif (IS_INVOKE_SET)\n\t\t{\n\t\t\tdispparams.rgdispidNamedArgs = &dispidParam;\n\t\t\tdispparams.cNamedArgs = 1;\n\t\t}\n\t}\n\n\tif (SUCCEEDED(hr))\n\t{\n\t\tWORD flags[2] {0};\n\t\tif (IS_INVOKE_SET)\n\t\t{\n\t\t\t// Use PROPERTYPUTREF when assigning an object, but fall back to PROPERTYPUT if DISP_E_MEMBERNOTFOUND is\n\t\t\t// returned. In the fallback case, the COM server might invoke the object's DISPID_VALUE member to get\n\t\t\t// a value to assign; e.g. r.Pattern := {__item: \"hello\"} is the same as r.Pattern := \"hello\" when r is\n\t\t\t// a VBScript RegExp object.\n\t\t\tif (rgvarg[0].vt == VT_DISPATCH)\n\t\t\t\tflags[0] = DISPATCH_PROPERTYPUTREF, flags[1] = DISPATCH_PROPERTYPUT;\n\t\t\telse\n\t\t\t\tflags[0] = DISPATCH_PROPERTYPUT;\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Make a first attempt using only the one flag matching the local syntax, so that COM servers which\n\t\t\t// support retrieving or calling the same member (like AutoHotkey) will perform the correct operation.\n\t\t\tflags[0] = IS_INVOKE_CALL ? DISPATCH_METHOD : DISPATCH_PROPERTYGET;\n\t\t\t// For backward-compatibility and to account for inconsistencies (like _NewEnum being a property or a\n\t\t\t// method), let there be a second attempt using the combined flags. This is probably the same as just\n\t\t\t// swapping METHOD and PROPERTYGET, but might not be in all cases (i.e. for objects that don't use the\n\t\t\t// system-provided IDispatch implementation).\n\t\t\tflags[1] = DISPATCH_METHOD | DISPATCH_PROPERTYGET;\n\t\t}\n\t\thr = mDispatch->Invoke(dispid, IID_NULL, LOCALE_USER_DEFAULT, flags[0], &dispparams, &varResult, &excepinfo, NULL);\n\t\tif (hr == DISP_E_MEMBERNOTFOUND && flags[1]) // Only this particular HRESULT.\n\t\t\thr = mDispatch->Invoke(dispid, IID_NULL, LOCALE_USER_DEFAULT, flags[1], &dispparams, &varResult, &excepinfo, NULL);\n\t}\n\n\tfor (int i = 0; i < aParamCount; i++)\n\t{\n\t\t// TokenToVariant() in \"arg\" mode never calls AddRef() or SafeArrayCopy(), so the arg needs to be freed\n\t\t// only if it is a BSTR and not one which came from a ComObject wrapper (such as ComObject(9, pbstr)).\n\t\tswitch (argtype[i])\n\t\t{\n\t\tcase VariantIsAllocatedString:\n\t\t\tSysFreeString(rgvarg[i].bstrVal);\n\t\t\tbreak;\n\t\tcase VariantIsVarRef:\n\t\t\tAssignVariant(*(VarRef *)aParam[aParamCount - (i + 1)]->object, *rgvarg[i].pvarVal, false);\n\t\t\tfree(rgvarg[i].pvarVal);\n\t\t\tbreak;\n\t\t}\n\t}\n\n\tif (FAILED(hr))\n\t{\n\t\tif (hr == DISP_E_UNKNOWNNAME || hr == DISP_E_MEMBERNOTFOUND)\n\t\t\treturn INVOKE_NOT_HANDLED;\n\n\t\tComError(hr, aResultToken, aName, &excepinfo);\n\t}\n\telse if\t(IS_INVOKE_SET)\n\t{\n\t\t// aResultToken's value is ignored by ExpandExpression() for IT_SET.\n\t\tVariantClear(&varResult);\n\t}\n\telse\n\t{\n\t\tVariantToToken(varResult, aResultToken, false);\n\t}\n\n\treturn\taResultToken.Result();\n}\n\n\n\nObjectMemberMd ComObject::sArrayMembers[]\n{\n\tmd_member_x(ComObject, __Item, SafeArray_Item, GET, (Ret, Variant, RetVal), (In, Params, Index)),\n\tmd_member_x(ComObject, __Item, SafeArray_Item, SET, (In, Variant, Value), (In, Params, Index)),\n\tmd_member_x(ComObject, __Enum, SafeArray_Enum, CALL, (In_Opt, Int32, N), (Ret, Object, RetVal)),\n\tmd_member_x(ComObject, Clone, SafeArray_Clone, CALL, (Ret, Object, RetVal)),\n\tmd_member_x(ComObject, MaxIndex, SafeArray_MaxIndex, CALL, (In_Opt, UInt32, Dims), (Ret, Int32, RetVal)),\n\tmd_member_x(ComObject, MinIndex, SafeArray_MinIndex, CALL, (In_Opt, UInt32, Dims), (Ret, Int32, RetVal))\n};\n\nObjectMember ComObject::sRefMembers[]\n{\n\tObject_Property_get_set(__Item),\n\tObject_Property_get_set(__Value),\n};\n\nObjectMember ComObject::sValueMembers[]\n{\n\tObject_Property_get_set(Ptr),\n};\n\n\nvoid DefineComPrototypeMembers()\n{\n\tObject::DefineMembers(Object::sComValuePrototype, _T(\"ComValue\"), ComObject::sValueMembers, _countof(ComObject::sValueMembers));\n\tObject::DefineMembers(Object::sComRefPrototype, _T(\"ComValueRef\"), ComObject::sRefMembers, _countof(ComObject::sRefMembers));\n\tObject::DefineMetadataMembers(Object::sComArrayPrototype, _T(\"ComObjArray\"), ComObject::sArrayMembers, _countof(ComObject::sArrayMembers));\n}\n\n\nvoid ComObject::Invoke(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (aID == P___Item) // ComValueRef\n\t{\n\t\tVARTYPE item_type = mVarType & VT_TYPEMASK;\n\t\tif (IS_INVOKE_SET)\n\t\t{\n\t\t\tauto hr = TokenToVarType(*aParam[0], item_type, mValPtr);\n\t\t\tif (FAILED(hr))\n\t\t\t{\n\t\t\t\tComError(hr, aResultToken);\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\t\telse\n\t\t{\n\t\t\tVarTypeToToken(item_type, mValPtr, aResultToken);\n\t\t}\n\t}\n\telse // P_Ptr\n\t{\n\t\tif (IS_INVOKE_SET)\n\t\t{\n\t\t\tif ((mVarType == VT_UNKNOWN || mVarType == VT_DISPATCH) && !mUnknown)\n\t\t\t{\n\t\t\t\t// Allow this assignment only in the specific cases indicated above, to avoid ambiguity\n\t\t\t\t// about what to do with the old value. This operation is specifically intended for use\n\t\t\t\t// with DllCall; i.e. DllCall(..., \"ptr*\", o := ComValue(13,0)) to wrap a returned ptr.\n\t\t\t\t// Assigning zero is permitted and there is no AddRef because the caller wants us to\n\t\t\t\t// Release the interface pointer automatically.\n\t\t\t\tif (!ParamIndexIsNumeric(0))\n\t\t\t\t\t_f_throw_type(_T(\"Number\"), *aParam[0]);\n\t\t\t\tmUnknown = (IUnknown *)ParamIndexToInt64(0);\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\t\telse // GET\n\t\t{\n\t\t\t// Support passing VT_ARRAY, VT_BYREF or IUnknown to DllCall.\n\t\t\tif ((mVarType & (VT_ARRAY | VT_BYREF)) || mVarType == VT_UNKNOWN || mVarType == VT_DISPATCH)\n\t\t\t\t_o_return(mVal64);\n\t\t}\n\t\t_o_throw(ERR_INVALID_USAGE);\n\t}\n}\n\n\nFResult ComObject::SafeArray_Enum(optl<int> n, IObject *&aRetVal)\n{\n\tHRESULT hr;\n\tComArrayEnum *enm;\n\tif (SUCCEEDED(hr = ComArrayEnum::Begin(this, enm, n.value_or(2))))\n\t\taRetVal = enm;\n\treturn OK;\n}\n\n\nFResult ComObject::SafeArray_Clone(IObject *&aRetVal)\n{\n\tHRESULT hr;\n\tSAFEARRAY *clone;\n\tif (SUCCEEDED(hr = SafeArrayCopy((SAFEARRAY*)mVal64, &clone)))\n\t\taRetVal = new ComObject((__int64)clone, mVarType, F_OWNVALUE);\n\treturn hr;\n}\n\n\nFResult ComObject::SafeArray_MaxIndex(optl<UINT> aDims, int &aRetVal)\n{\n\treturn SafeArrayGetUBound((SAFEARRAY*)mVal64, aDims.value_or(1), (LONG*)&aRetVal);\n}\n\n\nFResult ComObject::SafeArray_MinIndex(optl<UINT> aDims, int &aRetVal)\n{\n\treturn SafeArrayGetLBound((SAFEARRAY*)mVal64, aDims.value_or(1), (LONG*)&aRetVal);\n}\n\n\nFResult ComObject::SafeArray_Item(VariantParams &aParam, ExprTokenType *aNewValue, ResultToken *aResultToken)\n{\n\tASSERT(aNewValue || aResultToken);\n\tSAFEARRAY *psa = (SAFEARRAY*)mVal64;\n\tVARTYPE item_type = (mVarType & VT_TYPEMASK);\n\n\tUINT dims = SafeArrayGetDim(psa);\n\tLONG index[8];\n\t// Verify correct number of parameters/dimensions (maximum 8).\n\tif (dims > _countof(index) || dims != aParam.count)\n\t\treturn FR_E_ARGS;\n\t// Build array of indices from parameters.\n\tfor (UINT i = 0; i < dims; ++i)\n\t{\n\t\tif (!TokenIsNumeric(*aParam.value[i]))\n\t\t\treturn FParamError(i, aParam.value[i], _T(\"Number\"));\n\t\tindex[i] = (LONG)TokenToInt64(*aParam.value[i]);\n\t}\n\n\tvoid *item;\n\n\tSafeArrayLock(psa);\n\n\tauto hr = SafeArrayPtrOfIndex(psa, index, &item);\n\tif (SUCCEEDED(hr))\n\t{\n\t\tif (aNewValue)\n\t\t\thr = TokenToVarType(*aNewValue, item_type, item);\n\t\telse\n\t\t\tVarTypeToToken(item_type, item, *aResultToken);\n\t}\n\n\tSafeArrayUnlock(psa);\n\n\treturn hr;\n}\n\n\nLPTSTR ComObject::Type()\n{\n\tif ((mVarType == VT_DISPATCH || mVarType == VT_UNKNOWN) && mUnknown)\n\t{\n\t\t// Use COM class name if available.\n\t\tBSTR name = nullptr;\n\t\tif (ITypeInfo *ptinfo = GetClassTypeInfo(mUnknown))\n\t\t{\n\t\t\tptinfo->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL);\n\t\t\tptinfo->Release();\n\t\t}\n\t\tif (name)\n\t\t{\n\t\t\tstatic TCHAR sBuf[64]; // Seems generous enough.\n\t\t\ttcslcpy(sBuf, CStringTCharFromWCharIfNeeded(name), _countof(sBuf));\n\t\t\tSysFreeString(name);\n\t\t\treturn sBuf;\n\t\t}\n\t}\n\tif (auto classname = Base()->GetOwnPropString(_T(\"__Class\")))\n\t\treturn classname;\n\treturn _T(\"ComValue\"); // Provide a safe default in case __Class was removed.\n}\n\n\nObject *ComObject::Base()\n{\n\tif (mVarType & VT_ARRAY)\n\t\treturn Object::sComArrayPrototype;\n\tif (mVarType & VT_BYREF)\n\t\treturn Object::sComRefPrototype;\n\tif (mVarType == VT_DISPATCH && mUnknown)\n\t\treturn Object::sComObjectPrototype;\n\treturn Object::sComValuePrototype;\n}\n\n\nComEnum::ComEnum(IEnumVARIANT *enm)\n\t: penum(enm)\n\t, cheat(false)\n{\n\tIServiceProvider *sp;\n\tif (SUCCEEDED(enm->QueryInterface<IServiceProvider>(&sp)))\n\t{\n\t\tIUnknown *unk;\n\t\tif (SUCCEEDED(sp->QueryService<IUnknown>(IID_IObjectComCompatible, &unk)))\n\t\t{\n\t\t\tcheat = true;\n\t\t\tunk->Release();\n\t\t}\n\t\tsp->Release();\n\t}\n}\n\n\nResultType ComEnum::Next(Var *aVar0, Var *aVar1)\n{\n\tVARIANT var[2] = {0};\n\tif (penum->Next(1 + (cheat && aVar1), var, NULL) == S_OK)\n\t{\n\t\tif (aVar0)\n\t\t\tAssignVariant(*aVar0, var[0], false);\n\t\tif (aVar1)\n\t\t{\n\t\t\tif (cheat && aVar1)\n\t\t\t\tAssignVariant(*aVar1, var[1], false);\n\t\t\telse\n\t\t\t\taVar1->Assign((__int64)var[0].vt);\n\t\t}\n\t\treturn CONDITION_TRUE;\n\t}\n\treturn CONDITION_FALSE;\n}\n\n\nHRESULT ComArrayEnum::Begin(ComObject *aArrayObject, ComArrayEnum *&aEnum, int aMode)\n{\n\tHRESULT hr;\n\tSAFEARRAY *psa = aArrayObject->mArray;\n\tvoid *arrayData;\n\tlong lbound, ubound;\n\n\tif (SafeArrayGetDim(psa) != 1)\n\t\treturn E_NOTIMPL;\n\t\n\tif ( SUCCEEDED(hr = SafeArrayGetLBound(psa, 1, &lbound))\n\t\t&& SUCCEEDED(hr = SafeArrayGetUBound(psa, 1, &ubound))\n\t\t&& SUCCEEDED(hr = SafeArrayAccessData(psa, &arrayData)) )\n\t{\n\t\tVARTYPE arrayType = aArrayObject->mVarType & VT_TYPEMASK;\n\t\tUINT elemSize = SafeArrayGetElemsize(psa);\n\t\taEnum = new ComArrayEnum(aArrayObject, arrayData, lbound, ubound, elemSize, arrayType, aMode >= 2);\n\t\taArrayObject->AddRef(); // Keep obj alive until enumeration completes.\n\t}\n\treturn hr;\n}\n\nComArrayEnum::~ComArrayEnum()\n{\n\tSafeArrayUnaccessData(mArrayObject->mArray); // Counter the lock done by ComArrayEnum::Begin.\n\tmArrayObject->Release();\n}\n\nResultType ComArrayEnum::Next(Var *aVar1, Var *aVar2)\n{\n\t++mOffset;\n\tif (mLBound + mOffset <= mUBound)\n\t{\n\t\tvoid *p = ((char *)mData) + mOffset * mElemSize;\n\t\tVARIANT var = {0};\n\t\tif (mType == VT_VARIANT)\n\t\t{\n\t\t\t// Make shallow copy of the VARIANT item.\n\t\t\tmemcpy(&var, p, sizeof(VARIANT));\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Build VARIANT with shallow copy of the item.\n\t\t\tvar.vt = mType;\n\t\t\tmemcpy(&var.lVal, p, mElemSize);\n\t\t}\n\t\tif (mIndexMode)\n\t\t{\n\t\t\tif (aVar1)\n\t\t\t\taVar1->Assign(mLBound + mOffset);\n\t\t\taVar1 = aVar2;\n\t\t}\n\t\tif (aVar1)\n\t\t\tAssignVariant(*aVar1, var);\n\t\treturn CONDITION_TRUE;\n\t}\n\treturn CONDITION_FALSE;\n}\n\n\nSTDMETHODIMP EnumComCompat::QueryInterface(REFIID riid, void **ppvObject)\n{\n\tif (riid == IID_IUnknown || riid == IID_IEnumVARIANT)\n\t\t*ppvObject = static_cast<IEnumVARIANT*>(this);\n\telse if (riid == IID_IServiceProvider)\n\t\t*ppvObject = static_cast<IServiceProvider*>(this);\n\telse\n\t\treturn E_NOTIMPL;\n\tAddRef();\n\treturn S_OK;\n}\n\nSTDMETHODIMP EnumComCompat::QueryService(REFGUID guidService, REFIID riid, void **ppvObject)\n{\n\t// This is our secret handshake for enabling AutoHotkey enumeration behaviour.\n\t// Unlike calls to QueryInterface for this IID (due to the lack of registration etc.),\n\t// calls to this method should pass through the process/thread apartment boundary.\n\tif (guidService == IID_IObjectComCompatible && riid == IID_IUnknown)\n\t{\n\t\t*ppvObject = static_cast<IEnumVARIANT*>(this);\n\t\tAddRef();\n\t\tmCheat = true;\n\t\treturn S_OK;\n\t}\n\t*ppvObject = nullptr;\n\treturn E_NOTIMPL;\n}\n\nSTDMETHODIMP_(ULONG) EnumComCompat::AddRef()\n{\n\treturn ++mRefCount;\n}\n\nSTDMETHODIMP_(ULONG) EnumComCompat::Release()\n{\n\tif (mRefCount > 1)\n\t\treturn --mRefCount;\n\tdelete this;\n\treturn 0;\n}\n\nSTDMETHODIMP EnumComCompat::Next(ULONG celt, /*out*/ VARIANT *rgVar, /*out*/ ULONG *pCeltFetched)\n{\n\tif (!celt)\n\t\treturn E_INVALIDARG;\n\n\tint pc = min(celt, 1U + mCheat);\n\tVarRef *var[2] = { new VarRef, pc > 1 ? new VarRef : nullptr };\n\tExprTokenType tparam[2], *param[] = { tparam, tparam + 1 };\n\ttparam[0].SetValue(var[0]);\n\tif (var[1])\n\t\ttparam[1].SetValue(var[1]);\n\tswitch (CallEnumerator(mEnum, param, pc, false))\n\t{\n\tcase CONDITION_TRUE:\n\t\t{\n\t\t\tExprTokenType value;\n\t\t\tvar[0]->ToTokenSkipAddRef(value);\n\t\t\tTokenToVariant(value, rgVar[0], FALSE);\n\t\t\tif (var[1])\n\t\t\t{\n\t\t\t\tvar[1]->ToTokenSkipAddRef(value);\n\t\t\t\tTokenToVariant(value, rgVar[1], FALSE);\n\t\t\t}\n\t\t\tif (pCeltFetched)\n\t\t\t\t*pCeltFetched = pc;\n\t\t\tbreak;\n\t\t}\n\t\t// else fall through.\n\tcase INVOKE_NOT_HANDLED:\n\tcase EARLY_EXIT:\n\tcase FAIL:\n\t\tif (pCeltFetched)\n\t\t\t*pCeltFetched = 0;\n\t\tcelt = -1;\n\t\tbreak;\n\t}\n\n\tdelete var[0];\n\tif (var[1])\n\t\tdelete var[1];\n\n\treturn celt == pc ? S_OK : S_FALSE;\n}\n\nSTDMETHODIMP EnumComCompat::Skip(ULONG celt)\n{\n\treturn E_NOTIMPL;\n}\n\nSTDMETHODIMP EnumComCompat::Reset()\n{\n\treturn E_NOTIMPL;\n}\n\nSTDMETHODIMP EnumComCompat::Clone(/*out*/ IEnumVARIANT **ppEnum)\n{\n\treturn E_NOTIMPL;\n}\n\n\nIObject *GuiType::ControlGetActiveX(HWND aWnd)\n{\n\ttypedef HRESULT (WINAPI *MyAtlAxGetControl)(HWND h, IUnknown **p);\n\tstatic MyAtlAxGetControl fnAtlAxGetControl = NULL;\n\tif (!fnAtlAxGetControl)\n\t\tif (HMODULE hmodAtl = GetModuleHandle(_T(\"atl\"))) // GuiType::AddControl should have already permanently loaded it.\n\t\t\tfnAtlAxGetControl = (MyAtlAxGetControl)GetProcAddress(hmodAtl, \"AtlAxGetControl\");\n\tif (fnAtlAxGetControl) // Should always be non-NULL if aControl is actually an ActiveX control.\n\t{\n\t\tIUnknown *punk;\n\t\tif (SUCCEEDED(fnAtlAxGetControl(aWnd, &punk)))\n\t\t{\n\t\t\tIObject *pobj;\n\t\t\tIDispatch *pdisp;\n\t\t\tif (SUCCEEDED(punk->QueryInterface(IID_IDispatch, (void **)&pdisp)))\n\t\t\t{\n\t\t\t\tpunk->Release();\n\t\t\t\tpobj = new ComObject(pdisp);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tpobj = new ComObject((__int64)punk, VT_UNKNOWN);\n\t\t\t}\n\t\t\treturn pobj;\n\t\t}\n\t}\n\treturn NULL;\n}\n\n\nSTDMETHODIMP IObjectComCompatible::QueryInterface(REFIID riid, void **ppv)\n{\n\tif (riid == IID_IDispatch || riid == IID_IUnknown || &riid == &IID_IObjectComCompatible)\n\t{\n\t\tAddRef();\n\t\t//*ppv = static_cast<IDispatch *>(this);\n\t\t*ppv = this;\n\t\treturn S_OK;\n\t}\n\telse\n\t{\n\t\t*ppv = NULL;\n\t\treturn E_NOINTERFACE;\n\t}\n}\n\nSTDMETHODIMP IObjectComCompatible::GetTypeInfoCount(UINT *pctinfo)\n{\n\t*pctinfo = 0;\n\treturn S_OK;\n}\n\nSTDMETHODIMP IObjectComCompatible::GetTypeInfo(UINT itinfo, LCID lcid, ITypeInfo **pptinfo)\n{\n\t*pptinfo = NULL;\n\treturn E_NOTIMPL;\n}\n\nstatic LPTSTR *sDispNameByIdMinus1;\nstatic DISPID *sDispIdSortByName;\nstatic DISPID sDispNameCount, sDispNameMax;\n\nSTDMETHODIMP IObjectComCompatible::GetIDsOfNames(REFIID riid, LPOLESTR *rgszNames, UINT cNames, LCID lcid, DISPID *rgDispId)\n{\n\tHRESULT result_on_success = cNames == 1 ? S_OK : DISP_E_UNKNOWNNAME;\n\tfor (UINT i = 0; i < cNames; ++i)\n\t\trgDispId[i] = DISPID_UNKNOWN;\n\n#ifdef UNICODE\n\tLPTSTR name = *rgszNames;\n#else\n\tCStringCharFromWChar name_buf(*rgszNames);\n\tLPTSTR name = const_cast<LPTSTR>(name_buf.GetString());\n#endif\n\n\tint left, right, mid, result;\n\tfor (left = 0, right = sDispNameCount - 1; left <= right;)\n\t{\n\t\tmid = (left + right) / 2;\n\t\t// Comparison is case-sensitive so that the proper case of the name comes through for\n\t\t// meta-functions or new assignments. Using different case will produce a different ID,\n\t\t// but the ID is ultimately mapped back to the name when the member is invoked anyway.\n\t\tresult = _tcscmp(name, sDispNameByIdMinus1[sDispIdSortByName[mid] - 1]);\n\t\tif (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse if (result < 0)\n\t\t\tright = mid - 1;\n\t\telse // Match found.\n\t\t{\n\t\t\t*rgDispId = sDispIdSortByName[mid];\n\t\t\treturn result_on_success;\n\t\t}\n\t}\n\n\tif (sDispNameMax == sDispNameCount)\n\t{\n\t\tint new_max = sDispNameMax ? sDispNameMax * 2 : 16;\n\t\tLPTSTR *new_names = (LPTSTR *)realloc(sDispNameByIdMinus1, new_max * sizeof(LPTSTR *));\n\t\tif (!new_names)\n\t\t\treturn E_OUTOFMEMORY;\n\t\tDISPID *new_ids = (DISPID *)realloc(sDispIdSortByName, new_max * sizeof(DISPID));\n\t\tif (!new_ids)\n\t\t{\n\t\t\tfree(new_names);\n\t\t\treturn E_OUTOFMEMORY;\n\t\t}\n\t\tsDispNameByIdMinus1 = new_names;\n\t\tsDispIdSortByName = new_ids;\n\t\tsDispNameMax = new_max;\n\t}\n\n\tLPTSTR name_copy = SimpleHeap::Malloc(name);\n\tif (!name_copy)\n\t\treturn E_OUTOFMEMORY;\n\n\tsDispNameByIdMinus1[sDispNameCount] = name_copy; // Put names in ID order; index = ID - 1.\n\tif (left < sDispNameCount)\n\t\tmemmove(sDispIdSortByName + left + 1, sDispIdSortByName + left, (sDispNameCount - left) * sizeof(DISPID));\n\tsDispIdSortByName[left] = ++sDispNameCount; // Insert ID in order sorted by name, for binary search. ID = index + 1, to avoid DISPID_VALUE.\n\n\t*rgDispId = sDispNameCount;\n\treturn result_on_success;\n}\n\nSTDMETHODIMP IObjectComCompatible::Invoke(DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS *pDispParams, VARIANT *pVarResult, EXCEPINFO *pExcepInfo, UINT *puArgErr)\n{\n\tResultToken param_token[MAX_FUNCTION_PARAMS];\n\tExprTokenType *param[MAX_FUNCTION_PARAMS];\n\t\n\tUINT cArgs = pDispParams->cArgs;\n\tif (cArgs >= MAX_FUNCTION_PARAMS) // Probably won't happen in any real-world script.\n\t\tcArgs = MAX_FUNCTION_PARAMS - 1; // Just omit the rest of the params.\n\n\t// PUT is probably never combined with GET/METHOD, so is handled first. Some common problem\n\t// cases which combine GET and METHOD include:\n\t// - Foo.Bar in VBScript.\n\t// - foo.bar() and foo.bar[] in C#. There's no way to differentiate, so we just use METHOD\n\t// when there are parameters to cover the most common cases. Both will work with user-\n\t// defined properties (v1.1.16+) since they can be \"called\", but won't work with __Get.\n\t// - foo[bar] and foo(bar) in C# both use METHOD|GET with DISPID_VALUE.\n\t// - foo(bar) (but not foo[bar]) in JScript uses METHOD|GET with DISPID_VALUE.\n\tint flags = (wFlags & (DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF)) ? IT_SET\n\t\t: (wFlags & DISPATCH_METHOD) ? IT_CALL : IT_GET;\n\t\n\tExprTokenType **first_param = param + 1;\n\tint param_count = cArgs;\n\tLPTSTR name;\n\t\n\tif (dispIdMember > 0 && dispIdMember <= sDispNameCount)\n\t\tname = sDispNameByIdMinus1[dispIdMember - 1];\n\telse if (dispIdMember == DISPID_VALUE)\n\t\tname = nullptr;\n\telse if (dispIdMember == DISPID_NEWENUM && (wFlags & (DISPATCH_METHOD | DISPATCH_PROPERTYGET)))\n\t{\n\t\tname = _T(\"__Enum\");\n\t\tflags |= IF_NEWENUM;\n\t\twFlags = (wFlags & ~DISPATCH_PROPERTYGET) | DISPATCH_METHOD;\n\t}\n\telse\n\t\treturn DISP_E_MEMBERNOTFOUND;\n\t\n\tfor (UINT i = 1; i <= cArgs; ++i)\n\t{\n\t\tVARIANTARG &varg = pDispParams->rgvarg[cArgs-i];\n\t\tif (varg.vt & VT_BYREF)\n\t\t{\n\t\t\t// Allocate and pass a temporary Var to transparently support ByRef.\n\t\t\tauto varref = new VarRef();\n\t\t\tparam_token[i].SetValue(varref);\n\t\t\tparam_token[i].mem_to_free = nullptr;\n\t\t\tif (varg.vt == (VT_BYREF | VT_BSTR))\n\t\t\t{\n\t\t\t\t// Avoid an unnecessary string-copy that would be made by VariantCopyInd().\n\t\t\t\tvarref->AssignStringW(*varg.pbstrVal, SysStringLen(*varg.pbstrVal));\n\t\t\t}\n\t\t\telse if (varg.vt == (VT_BYREF | VT_VARIANT))\n\t\t\t{\n\t\t\t\tAssignVariant(*varref, *varg.pvarVal);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tVARIANT value;\n\t\t\t\tvalue.vt = VT_EMPTY;\n\t\t\t\tVariantCopyInd(&value, &varg);\n\t\t\t\tAssignVariant(*varref, value, false); // false causes value's memory/ref to be transferred to var or freed.\n\t\t\t}\n\t\t}\n\t\telse\n\t\t{\n\t\t\tVariantToToken(varg, param_token[i]);\n\t\t}\n\t\tparam[i] = ¶m_token[i];\n\t}\n\t\n\tExprTokenType this_token;\n\tthis_token.symbol = SYM_OBJECT;\n\tthis_token.object = this;\n\n\tHRESULT result_to_return;\n\tFuncResult result_token;\n\tint outer_excptmode = g->ExcptMode;\n\tg->ExcptMode |= EXCPTMODE_CATCH; // Indicate exceptions will be handled (by our caller, the COM client).\n\n\tfor (;;)\n\t{\n\t\tswitch (static_cast<IObject *>(this)->Invoke(result_token, flags, name, this_token, first_param, param_count))\n\t\t{\n\t\tcase FAIL:\n\t\t\tresult_to_return = E_FAIL;\n\t\t\tif (g->ThrownToken)\n\t\t\t{\n\t\t\t\tObject *obj;\n\t\t\t\tif (pExcepInfo && (obj = dynamic_cast<Object*>(TokenToObject(*g->ThrownToken)))) // MSDN: pExcepInfo \"Can be NULL\"\n\t\t\t\t{\n\t\t\t\t\tZeroMemory(pExcepInfo, sizeof(EXCEPINFO));\n\t\t\t\t\tpExcepInfo->scode = result_to_return = DISP_E_EXCEPTION;\n\t\t\t\t\t\n\t\t\t\t\t#define SysStringFromToken(...) \\\n\t\t\t\t\t\tSysAllocString(CStringWCharFromTCharIfNeeded(TokenToString(__VA_ARGS__)))\n\n\t\t\t\t\tExprTokenType token;\n\t\t\t\t\tif (obj->GetOwnProp(token, _T(\"Message\")))\n\t\t\t\t\t\tpExcepInfo->bstrDescription = SysStringFromToken(token, result_token.buf);\n\t\t\t\t\tif (obj->GetOwnProp(token, _T(\"What\")))\n\t\t\t\t\t\tpExcepInfo->bstrSource = SysStringFromToken(token, result_token.buf);\n\t\t\t\t\tif (obj->GetOwnProp(token, _T(\"File\")))\n\t\t\t\t\t\tpExcepInfo->bstrHelpFile = SysStringFromToken(token, result_token.buf);\n\t\t\t\t\tpExcepInfo->dwHelpContext = (DWORD)obj->GetOwnPropInt64(_T(\"Line\"));\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// Showing an error message seems more helpful than silently returning E_FAIL.\n\t\t\t\t\t// Although there's risk of our caller showing a second message or handling\n\t\t\t\t\t// the error in some other way, it couldn't report anything specific since\n\t\t\t\t\t// all it will have is the generic failure code.\n\t\t\t\t\tg_script.UnhandledException(NULL);\n\t\t\t\t}\n\t\t\t\tg_script.FreeExceptionToken(g->ThrownToken);\n\t\t\t}\n\t\t\tbreak;\n\t\tcase INVOKE_NOT_HANDLED:\n\t\t\tif ((flags & IT_BITMASK) == IT_CALL && (wFlags & DISPATCH_PROPERTYGET))\n\t\t\t{\n\t\t\t\t// Request was to call a method OR retrieve a property, but we now know there's no such\n\t\t\t\t// method. For DISPID_VALUE, it could be Obj(X) in VBScript and C#, or Obj[X] in C#.\n\t\t\t\t// For other IDs, Obj.X(Y) in VBScript is known to do this. VBScript uses () for both\n\t\t\t\t// functions and array indexing.\n\t\t\t\tflags = IT_GET;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tresult_to_return = DISP_E_MEMBERNOTFOUND;\n\t\t\tbreak;\n\t\tdefault:\n\t\t\tresult_to_return = S_OK;\n\t\t\tif (!pVarResult)\n\t\t\t\tbreak;\n\t\t\tif (dispIdMember == DISPID_NEWENUM && result_token.symbol == SYM_OBJECT)\n\t\t\t{\n\t\t\t\tpVarResult->vt = VT_UNKNOWN;\n\t\t\t\tpVarResult->punkVal = static_cast<IEnumVARIANT*>(new EnumComCompat(result_token.object));\n\t\t\t\tresult_token.symbol = SYM_INTEGER; // Skip Release().\n\t\t\t}\n\t\t\telse\n\t\t\t\tTokenToVariant(result_token, *pVarResult, FALSE);\n\t\t}\n\t\tbreak;\n\t}\n\n\tg->ExcptMode = outer_excptmode;\n\n\t// Clean up:\n\tresult_token.Free();\n\tfor (UINT i = 1; i <= cArgs; ++i)\n\t{\n\t\tVARIANTARG &varg = pDispParams->rgvarg[cArgs-i];\n\t\tif (varg.vt & VT_BYREF)\n\t\t{\n\t\t\tASSERT(param_token[i].symbol == SYM_OBJECT && dynamic_cast<VarRef *>(param_token[i].object));\n\t\t\tauto varref = (VarRef *)param_token[i].object;\n\t\t\tExprTokenType value;\n\t\t\tvarref->ToTokenSkipAddRef(value);\n\t\t\tTokenToVarType(value, varg.vt & ~VT_BYREF, varg.pvRecord);\n\t\t}\n\t\tparam_token[i].Free();\n\t}\n\n\treturn result_to_return;\n}\n"},"size":{"kind":"number","value":55191,"string":"55,191"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1791,"string":"1,791"},"avg_line_length":{"kind":"number","value":27.739251814628695,"string":"27.739252"},"max_line_length":{"kind":"number","value":220,"string":"220"},"alphanum_fraction":{"kind":"number","value":0.6991632979223465,"string":"0.699163"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11074,"cells":{"id":{"kind":"number","value":16061,"string":"16,061"},"file_name":{"kind":"string","value":"script_menu.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_menu.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"script.h\"\n#include \"globaldata.h\" // for a lot of things\n#include \"application.h\" // for MsgSleep()\n#include \"window.h\" // for SetForegroundWindowEx()\n#include \"script_func_impl.h\"\n#include \"script_gui.h\"\n\n\n\nObjectMemberMd UserMenu::sMembers[] =\n{\n\tmd_member(UserMenu, Add, CALL, (In_Opt, String, Name), (In_Opt, Object, FunctionOrSubmenu), (In_Opt, String, Options)),\n\tmd_member(UserMenu, AddStandard, CALL, md_arg_none),\n\tmd_member(UserMenu, Check, CALL, (In, String, Item)),\n\tmd_property(UserMenu, ClickCount, Int32),\n\tmd_property(UserMenu, Default, String),\n\tmd_member(UserMenu, Delete, CALL, (In_Opt, String, Item)),\n\tmd_member(UserMenu, Disable, CALL, (In, String, Item)),\n\tmd_member(UserMenu, Enable, CALL, (In, String, Item)),\n\tmd_property_get(UserMenu, Handle, UIntPtr),\n\tmd_member(UserMenu, Insert, CALL, (In_Opt, String, Before), (In_Opt, String, Name), (In_Opt, Object, FunctionOrSubmenu), (In_Opt, String, Options)),\n\tmd_member(UserMenu, Rename, CALL, (In, String, Item), (In_Opt, String, NewName)),\n\tmd_member(UserMenu, SetColor, CALL, (In_Opt, Variant, Color), (In_Opt, Bool32, ApplyToSubmenus)),\n\tmd_member(UserMenu, SetIcon, CALL, (In, String, Item), (In, String, File), (In_Opt, Int32, Number), (In_Opt, Int32, Width)),\n\tmd_member(UserMenu, Show, CALL, (In_Opt, Int32, X), (In_Opt, Int32, Y), (In_Opt, Bool32, Wait)),\n\tmd_member(UserMenu, ToggleCheck, CALL, (In, String, Item), (Ret, Bool32, RetVal)),\n\tmd_member(UserMenu, ToggleEnable, CALL, (In, String, Item), (Ret, Bool32, RetVal)),\n\tmd_member(UserMenu, Uncheck, CALL, (In, String, Item)),\n};\nint UserMenu::sMemberCount = _countof(sMembers);\n\n\n\nFResult UserMenu::Add(optl<StrArg> aName, optl<IObject*> aFuncOrSubmenu, optl<StrArg> aOptions)\n{\n\treturn Add(aName, aFuncOrSubmenu, aOptions, nullptr);\n}\n\n\n\nFResult UserMenu::Insert(optl<StrArg> aBefore, optl<StrArg> aName, optl<IObject*> aFuncOrSubmenu, optl<StrArg> aOptions)\n{\n\tUserMenuItem *prev_item = mLastMenuItem; // Default to append.\n\tif (aBefore.has_nonempty_value()) // i.e. caller specified where to insert.\n\t{\n\t\tbool search_by_pos;\n\t\tif (!FindItem(aBefore.value(), prev_item, search_by_pos))\n\t\t{\n\t\t\t// The item wasn't found. Treat it as an error unless it is the position\n\t\t\t// immediately after the last item.\n\t\t\tif ( !(search_by_pos && ATOI(aBefore.value()) == (int)mMenuItemCount + 1) )\n\t\t\t\treturn ItemNotFoundError(aBefore.value());\n\t\t}\n\t}\n\treturn Add(aName, aFuncOrSubmenu, aOptions\n\t\t// To simplify insertion, give AddItem() a pointer to the variable within the\n\t\t// linked-list which points to the item, rather than a pointer to the item itself:\n\t\t, prev_item ? &prev_item->mNextMenuItem : &mFirstMenuItem);\n}\n\n\n\nFResult UserMenu::Add(optl<StrArg> aName, optl<IObject*> aFuncOrSubmenu, optl<StrArg> aOptions, UserMenuItem **aInsertAt)\n{\n\tauto options = aOptions.value_or_empty();\n\tif (aName.is_blank_or_omitted())\n\t{\n\t\tif (aFuncOrSubmenu.has_value() || *options)\n\t\t\treturn FR_E_ARGS; // Invalid combination of parameters.\n\t\treturn AddItem(_T(\"\"), 0, nullptr, nullptr, _T(\"\"), aInsertAt) ? OK : FR_FAIL;\n\t}\n\t\n\tbool search_by_pos = false;\n\tUserMenuItem *menu_item = nullptr, *menu_item_prev = nullptr;\n\tif (!aInsertAt) // Add(), not Insert().\n\t{\n\t\tmenu_item = FindItem(aName.value(), menu_item_prev, search_by_pos);\n\t\tif (!menu_item && search_by_pos)\n\t\t\treturn FR_E_ARG(0); // Invalid position.\n\t}\n\t\n\t// Whether an existing menu item's options should be updated without updating its submenu or callback:\n\tbool update_existing_item_options = (menu_item && !aFuncOrSubmenu.has_value() && *options);\n\t\n\tIObject *callback = nullptr;\n\tUserMenu *submenu = nullptr;\n\tif (!update_existing_item_options)\n\t{\n\t\tif (!aFuncOrSubmenu.has_value())\n\t\t\treturn FR_E_ARG(aInsertAt ? 2 : 1);\n\t\tsubmenu = dynamic_cast<UserMenu *>(aFuncOrSubmenu.value());\n\t\tif (submenu) // Param #2 is a Menu object.\n\t\t{\n\t\t\t// Before going further: since a submenu has been specified, make sure that the parent\n\t\t\t// menu is not included anywhere in the nested hierarchy of that submenu's submenus.\n\t\t\t// The OS doesn't seem to like that, creating empty or strange menus if it's attempted.\n\t\t\t// Although adding a menu bar as a submenu appears to work, displaying it does strange\n\t\t\t// things to the actual menu bar on any GUI it is assigned to.\n\t\t\tif (submenu == this || submenu->ContainsMenu(this)\n\t\t\t\t|| submenu->mMenuType != MENU_TYPE_POPUP)\n\t\t\t\treturn FR_E_ARG(aInsertAt ? 2 : 1);\n\t\t}\n\t\telse \n\t\t{\n\t\t\t// Param #2 is not a submenu.\n\t\t\tcallback = aFuncOrSubmenu.value();\n\t\t\tauto fr = ValidateFunctor(callback, 3);\n\t\t\tif (fr != OK)\n\t\t\t\treturn fr;\n\t\t}\n\t}\n\t\n\tif (menu_item)\n\t\treturn ModifyItem(menu_item, callback, submenu, options) ? OK : FR_FAIL;\n\telse\n\t\treturn AddItem(aName.value(), 0, callback, submenu, options, aInsertAt) ? OK : FR_FAIL;\n}\n\n\n\nFResult UserMenu::AddStandard()\n{\n\treturn AppendStandardItems() ? OK : FR_FAIL;\n}\n\n\n\nFResult UserMenu::Delete(optl<StrArg> aItemName)\n{\n\tif (!aItemName.has_value())\n\t{\n\t\tDeleteAllItems();\n\t\treturn OK;\n\t}\n\tif (aItemName.is_blank())\n\t\treturn FR_E_ARG(0);\n\tbool search_by_pos = false;\n\tUserMenuItem *menu_item_prev\n\t\t, *menu_item = FindItem(aItemName.value(), menu_item_prev, search_by_pos);\n\tif (!menu_item)\n\t\treturn ItemNotFoundError(aItemName.value());\n\tDeleteItem(menu_item, menu_item_prev);\n\treturn OK;\n}\n\n\n\nFResult UserMenu::Rename(StrArg aItemName, optl<StrArg> aNewName)\n{\n\tUserMenuItem *item;\n\tauto fr = GetItem(aItemName, item);\n\tif (fr != OK)\n\t\treturn fr;\n\tauto new_name = aNewName.value_or_empty();\n\tif (!RenameItem(item, new_name))\n\t\treturn FError(_T(\"Rename failed (name too long?).\"), new_name);\n\treturn OK;\n}\n\n\n\nFResult UserMenu::SetColor(ExprTokenType *aColor, optl<BOOL> aApplyToSubmenus)\n{\n\tBOOL submenus = aApplyToSubmenus.value_or(TRUE);\n\tCOLORREF color = CLR_DEFAULT;\n\tif (aColor && !ColorToBGR(*aColor, color))\n\t\treturn FR_E_ARG(0);\n\tSetColor(color, submenus);\n\treturn OK;\n}\n\n\n\nFResult UserMenu::SetIcon(StrArg aItemName, StrArg aIconFile, optl<int> aIconNumber, optl<int> aIconWidth)\n{\n\tUserMenuItem *item;\n\tauto fr = GetItem(aItemName, item);\n\tif (fr != OK)\n\t\treturn fr;\n\t// Icon width defaults to system small icon size. Original icon size will be used if \"0\" is specified.\n\tif (!SetItemIcon(item, aIconFile, aIconNumber.value_or(0)\n\t\t, aIconWidth.has_value() ? aIconWidth.value() : GetSystemMetrics(SM_CXSMICON)))\n\t\treturn FError(ERR_LOAD_ICON, aIconFile);\n\treturn OK;\n}\n\n\n\nFResult UserMenu::Show(optl<int> aX, optl<int> aY, optl<BOOL> aWait)\n{\n\treturn Display(aX.value_or(COORD_UNSPECIFIED), aY.value_or(COORD_UNSPECIFIED), aWait) ? OK : FR_FAIL;\n}\n\n\n\nFResult UserMenu::Check(StrArg aItemName)\n{\n\treturn SetItemState(aItemName, MFS_CHECKED, MFS_CHECKED);\n}\n\nFResult UserMenu::ToggleCheck(StrArg aItemName, BOOL &aRetVal)\n{\n\tUINT state;\n\tauto fr = SetItemState(aItemName, MFS_CHECKED, 0, &state);\n\taRetVal = (state & MFS_CHECKED) ? TRUE : FALSE;\n\treturn fr;\n}\n\nFResult UserMenu::Uncheck(StrArg aItemName)\n{\n\treturn SetItemState(aItemName, 0, MFS_CHECKED);\n}\n\nFResult UserMenu::Disable(StrArg aItemName)\n{\n\treturn SetItemState(aItemName, MFS_DISABLED, MFS_DISABLED);\n}\n\nFResult UserMenu::Enable(StrArg aItemName)\n{\n\treturn SetItemState(aItemName, 0, MFS_DISABLED);\n}\n\nFResult UserMenu::ToggleEnable(StrArg aItemName, BOOL &aRetVal)\n{\n\tUINT state;\n\tauto fr = SetItemState(aItemName, MFS_DISABLED, 0, &state);\n\taRetVal = (state & MFS_DISABLED) ? FALSE : TRUE;\n\treturn fr;\n}\n\n\n\nFResult UserMenu::get_ClickCount(int &aRetVal)\n{\n\taRetVal = mClickCount;\n\treturn OK;\n}\n\nFResult UserMenu::set_ClickCount(int aValue)\n{\n\tif (aValue < 1 || aValue > 2)\n\t\treturn FR_E_ARG(0);\n\tmClickCount = aValue;\n\treturn OK;\n}\n\n\n\nFResult UserMenu::get_Default(StrRet &aRetVal)\n{\n\taRetVal.SetTemp(mDefault ? mDefault->mName : _T(\"\"));\n\treturn OK;\n}\n\nFResult UserMenu::set_Default(StrArg aItemName)\n{\n\tUserMenuItem *item = nullptr;\n\tif (*aItemName)\n\t{\n\t\tauto fr = GetItem(aItemName, item);\n\t\tif (fr != OK)\n\t\t\treturn fr;\n\t}\n\tSetDefault(item);\n\treturn OK;\n}\n\n\n\nFResult UserMenu::get_Handle(UINT_PTR &aRetVal)\n{\n\tif (!mMenu)\n\t\tif (!CreateHandle())\n\t\t\treturn FR_E_WIN32;\n\taRetVal = (UINT_PTR)mMenu;\n\treturn OK;\n}\n\n\n\nUserMenu *Script::FindMenu(HMENU aMenuHandle)\n{\n\tif (!aMenuHandle) return NULL;\n\tfor (UserMenu *menu = mFirstMenu; menu != NULL; menu = menu->mNextMenu)\n\t\tif (menu->mMenu == aMenuHandle)\n\t\t\treturn menu;\n\treturn NULL; // No match found.\n}\n\n\n\nUserMenu::UserMenu(MenuTypeType aMenuType)\n\t: mMenuType(aMenuType)\n{\n\tSetBase(sPrototype);\n\tg_script.AddMenu(this);\n}\n\nUserMenu *Script::AddMenu(UserMenu *aMenu)\n// Returns the newly created UserMenu object.\n{\n\tASSERT(aMenu);\n\tif (!mFirstMenu)\n\t\tmFirstMenu = mLastMenu = aMenu;\n\telse\n\t{\n\t\tmLastMenu->mNextMenu = aMenu;\n\t\t// This must be done after the above:\n\t\tmLastMenu = aMenu;\n\t}\n\t++mMenuCount; // Only after memory has been successfully allocated.\n\treturn aMenu;\n}\n\n\n\nResultType Script::ScriptDeleteMenu(UserMenu *aMenu)\n// Deletes a UserMenu object and all the UserMenuItem objects that belong to it.\n// Any UserMenuItem object that has a submenu attached to it does not result in\n// that submenu being deleted, even if no other menus are using that submenu\n// (i.e. the user must delete all menus individually). Any menus which have\n// aMenu as one of their submenus will have that menu item deleted from their\n// menus to avoid any chance of problems due to non-existent or NULL submenus.\n{\n\t// Delete any other menu's menu item that has aMenu as its attached submenu:\n\t// This is not done because reference counting ensures that submenus are not\n\t// deleted before the parent menu, except when the script is exiting.\n\t//UserMenuItem *mi, *mi_prev, *mi_to_delete;\n\t//for (UserMenu *m = mFirstMenu; m; m = m->mNextMenu)\n\t//\tif (m != aMenu) // Don't bother with this menu even if it's submenu of itself, since it will be destroyed anyway.\n\t//\t\tfor (mi = m->mFirstMenuItem, mi_prev = NULL; mi;)\n\t//\t\t{\n\t//\t\t\tmi_to_delete = mi;\n\t//\t\t\tmi = mi->mNextMenuItem;\n\t//\t\t\tif (mi_to_delete->mSubmenu == aMenu)\n\t//\t\t\t\tm->DeleteItem(mi_to_delete, mi_prev);\n\t//\t\t\telse\n\t//\t\t\t\tmi_prev = mi_to_delete;\n\t//\t\t}\n\t// Remove aMenu from the linked list.\n\tUserMenu *aMenu_prev;\n\tif (aMenu == mFirstMenu) // Checked first since it's always true when called by ~Script().\n\t{\n\t\tmFirstMenu = aMenu->mNextMenu; // Can be NULL if the list will now be empty.\n\t\taMenu_prev = NULL;\n\t}\n\telse // Find the item that occurs prior to aMenu in the list:\n\t\tfor (aMenu_prev = mFirstMenu; aMenu_prev; aMenu_prev = aMenu_prev->mNextMenu)\n\t\t\tif (aMenu_prev->mNextMenu == aMenu)\n\t\t\t{\n\t\t\t\taMenu_prev->mNextMenu = aMenu->mNextMenu; // Can be NULL if aMenu was the last one.\n\t\t\t\tbreak;\n\t\t\t}\n\tif (aMenu == mLastMenu)\n\t\tmLastMenu = aMenu_prev; // Can be NULL if the list will now be empty.\n\t--mMenuCount;\n\t// Do this last when its contents are no longer needed. It will delete all\n\t// the items in the menu and destroy the OS menu itself:\n\taMenu->Dispose();\n\treturn OK;\n}\n\n\n\nvoid UserMenu::Dispose()\n{\n\tDestroyHandle();\n\tDeleteAllItems();\n\tif (mBrush) // Free the brush used for the menu's background color.\n\t\tDeleteObject(mBrush);\n}\n\n\n\nUserMenu::~UserMenu()\n{\n\tg_script.ScriptDeleteMenu(this);\n}\n\n\n\nUINT Script::GetFreeMenuItemID()\n// Returns an unused menu item ID, or 0 if all IDs are used.\n{\n\t// Need to find a menuID that isn't already in use by one of the other menu items.\n\t// But also need to conserve menu items since only a relatively small number of IDs is available.\n\t// Can't simply use ID_USER_FIRST + mMenuItemCount because: 1) There might be more than one\n\t// user defined menu; 2) a menu item in the middle of the list may have been deleted,\n\t// in which case that value would already be in use by the last item.\n\t// Update: Now using caching of last successfully found free-ID to greatly improve avg.\n\t// performance, especially for menus that contain thousands of items and submenus, such as\n\t// ones that are built to mirror an entire nested directory structure. Caching should\n\t// improve performance even after all menu IDs within the available range have been\n\t// allocated once (via adding and deleting menus + menu items) since large blocks of free IDs\n\t// should be free, and on average, the caching will exploit these large free blocks. However,\n\t// if large amounts of menus and menu items are continually deleted and re-added by a script,\n\t// the pool of free IDs will become fragmented over time, which will reduce performance.\n\t// Since that kind of script behavior seems very rare, no attempt is made to \"defragment\".\n\t// If more performance is needed in the future (seems unlikely for 99.9999% of scripts),\n\t// could maintain an field of ~64000 bits, each bit representing whether a menu item ID is\n\t// free. Then, every time a menu or one or more of its IDs is deleted or added, the corresponding\n\t// ID could be marked as free/taken. That would add quite a bit of complexity to the menu\n\t// delete code, however, and it would reduce the overall maintainability. So it definitely\n\t// doesn't seem worth it, especially since Windows XP seems to have trouble even displaying\n\t// menus larger than around 15000-25000 items.\n\tstatic UINT sLastFreeID = ID_USER_FIRST - 1;\n\t// Increment by one for each new search, both due to the above line and because the\n\t// last-found free ID has a high likelihood of still being in use:\n\t++sLastFreeID;\n\tbool id_in_use;\n\t// Note that the i variable is used to force the loop to complete exactly one full\n\t// circuit through all available IDs, regardless of where the starting/cached value:\n\tfor (int i = 0; i < (ID_USER_LAST - ID_USER_FIRST + 1); ++i, ++sLastFreeID) // FOR EACH ID\n\t{\n\t\tif (sLastFreeID > ID_USER_LAST)\n\t\t\tsLastFreeID = ID_USER_FIRST; // Wrap around to the beginning so that one complete circuit is made.\n\t\tid_in_use = false; // Reset the default each iteration (overridden if the below finds a match).\n\t\tfor (UserMenu *m = mFirstMenu; m; m = m->mNextMenu) // FOR EACH MENU\n\t\t{\n\t\t\tfor (UserMenuItem *mi = m->mFirstMenuItem; mi; mi = mi->mNextMenuItem) // FOR EACH MENU ITEM\n\t\t\t{\n\t\t\t\tif (mi->mMenuID == sLastFreeID)\n\t\t\t\t{\n\t\t\t\t\tid_in_use = true;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (id_in_use) // No point in searching the other menus, since it's now known to be in use.\n\t\t\t\tbreak;\n\t\t}\n\t\tif (!id_in_use) // Break before the loop increments sLastFreeID.\n\t\t\tbreak;\n\t}\n\treturn id_in_use ? 0 : sLastFreeID;\n}\n\n\n\nFResult UserMenu::GetItem(LPCTSTR aNameOrPos, UserMenuItem *&aItem)\n{\n\tbool bypos;\n\tUserMenuItem *prev;\n\taItem = FindItem(aNameOrPos, prev, bypos);\n\tif (aItem)\n\t\treturn OK;\n\treturn ItemNotFoundError(aNameOrPos);\n}\n\n\n\n__declspec(noinline)\nFResult UserMenu::ItemNotFoundError(LPCTSTR aItem)\n{\n\treturn FError(ERR_INVALID_MENU_ITEM, aItem, ErrorPrototype::Target);\n}\n\n\n\nUserMenuItem *UserMenu::FindItem(LPCTSTR aNameOrPos, UserMenuItem *&aPrevItem, bool &aByPos)\n{\n\tint index_to_find = -1;\n\tsize_t length = _tcslen(aNameOrPos);\n\t// Check if the caller identified the menu item by position/index rather than by name.\n\t// This should be reasonably backwards-compatible, as any scripts that want literally\n\t// \"1&\" as menu item text would have to actually write \"1&&\".\n\tif (length > 1\n\t\t&& aNameOrPos[length - 1] == '&' // Use the same convention as MenuSelect: 1&, 2&, 3&...\n\t\t&& aNameOrPos[length - 2] != '&') // Not &&, which means one literal &.\n\t\tindex_to_find = ATOI(aNameOrPos) - 1; // Yields -1 if aParam3 doesn't start with a number.\n\taByPos = index_to_find > -1;\n\t// Find the item.\n\tint current_index = 0;\n\tUserMenuItem *menu_item_prev = NULL, *menu_item;\n\tfor (menu_item = mFirstMenuItem\n\t\t; menu_item\n\t\t; menu_item_prev = menu_item, menu_item = menu_item->mNextMenuItem, ++current_index)\n\t\tif (current_index == index_to_find // Found by index.\n\t\t\t|| !_tcsicmp(menu_item->mName, aNameOrPos)) // Found by case-insensitive text match.\n\t\t\tbreak;\n\taPrevItem = menu_item_prev;\n\treturn menu_item;\n}\n\n\n\nUserMenuItem *UserMenu::FindItemByID(UINT aID)\n{\n\tfor (UserMenuItem *mi = mFirstMenuItem; mi; mi = mi->mNextMenuItem)\n\t\tif (mi->mMenuID == aID)\n\t\t\treturn mi;\n\treturn NULL;\n}\n\n\n\n// Macros for use with the below methods (in previous versions, submenus were identified by position):\n#define aMenuItem_ID\t\taMenuItem->mMenuID\n#define aMenuItem_MF_BY\t\tMF_BYCOMMAND\n#define UPDATE_GUI_MENU_BARS(menu_type, hmenu) \\\n\tif (menu_type == MENU_TYPE_BAR && g_firstGui)\\\n\t\tGuiType::UpdateMenuBars(hmenu); // Above: If it's not a popup, it's probably a menu bar.\n\n\n\nResultType UserMenu::AddItem(LPCTSTR aName, UINT aMenuID, IObject *aCallback, UserMenu *aSubmenu, LPCTSTR aOptions\n\t, UserMenuItem **aInsertAt)\n// Caller must have already ensured that aName does not yet exist as a user-defined menu item\n// in this->mMenu.\n{\n\tsize_t length = _tcslen(aName);\n\tif (length > MAX_MENU_NAME_LENGTH)\n\t\treturn g_script.RuntimeError(_T(\"Menu item name too long.\"), aName);\n\t// If caller didn't specify a (built-in) item ID, get the next free ID.\n\t// Even separators get an ID, so that they can be modified later using the position& notation.\n\tif ( !aMenuID && !(aMenuID = g_script.GetFreeMenuItemID()) )\n\t\treturn g_script.RuntimeError(_T(\"Too many menu items.\")); // All ~64000 IDs are in use!\n\t// After mem is allocated, the object takes charge of its later deletion:\n\tLPTSTR name_dynamic;\n\tif (length)\n\t{\n\t\tif ( !(name_dynamic = tmalloc(length + 1)) ) // +1 for terminator.\n\t\t\treturn MemoryError();\n\t\t_tcscpy(name_dynamic, aName);\n\t}\n\telse\n\t\tname_dynamic = Var::sEmptyString; // So that it can be detected as a non-allocated empty string.\n\tUserMenuItem *menu_item = new UserMenuItem(name_dynamic, length + 1, aMenuID, aCallback, aSubmenu, this);\n\tif (*aOptions && !UpdateOptions(menu_item, aOptions))\n\t{\n\t\t// Invalid options; an error message was displayed.\n\t\tdelete menu_item; \n\t\treturn FAIL;\n\t}\n\tif (mMenu)\n\t{\n\t\tInternalAppendMenu(menu_item, aInsertAt ? *aInsertAt : NULL);\n\t\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu)\n\t}\n\tif (aInsertAt)\n\t{\n\t\t// Caller has passed a pointer to the variable in the linked list which should\n\t\t// hold this new item; either &mFirstMenuItem or &previous_item->mNextMenuItem.\n\t\tmenu_item->mNextMenuItem = *aInsertAt;\n\t\tif (!*aInsertAt)\n\t\t\tmLastMenuItem = menu_item;\n\t\t// This must be done after the above:\n\t\t*aInsertAt = menu_item;\n\t}\n\telse\n\t{\n\t\t// Append the item.\n\t\tif (!mFirstMenuItem)\n\t\t\tmFirstMenuItem = menu_item;\n\t\telse\n\t\t\tmLastMenuItem->mNextMenuItem = menu_item;\n\t\t// This must be done after the above:\n\t\tmLastMenuItem = menu_item;\n\t}\n\t++mMenuItemCount; // Only after memory has been successfully allocated.\n\tif (_tcschr(aName, '\\t')) // v1.1.04: The new item has a keyboard accelerator.\n\t\tUpdateAccelerators();\n\treturn OK;\n}\n\n\n\nResultType UserMenu::InternalAppendMenu(UserMenuItem *mi, UserMenuItem *aInsertBefore)\n// Appends an item to mMenu and and ensures the new item's ID is set.\n{\n\tMENUITEMINFO mii;\n\tmii.cbSize = sizeof(mii);\n\tmii.fMask = MIIM_ID | MIIM_FTYPE | MIIM_STRING | MIIM_STATE;\n\tmii.wID = mi->mMenuID;\n\tmii.fType = mi->mMenuType;\n\tmii.dwTypeData = mi->mName;\n\tmii.fState = mi->mMenuState;\n\tif (mi->mSubmenu)\n\t{\n\t\t// Ensure submenu is created so that its handle can be used below.\n\t\tif (!mi->mSubmenu->CreateHandle())\n\t\t\treturn FAIL;\n\t\tmii.fMask |= MIIM_SUBMENU;\n\t\tmii.hSubMenu = mi->mSubmenu->mMenu;\n\t}\n\tif (mi->mBitmap)\n\t{\n\t\tmii.fMask |= MIIM_BITMAP;\n\t\tmii.hbmpItem = mi->mBitmap;\n\t}\n\tUINT insert_at;\n\tBOOL by_position;\n\tif (aInsertBefore)\n\t\tinsert_at = aInsertBefore->mMenuID, by_position = FALSE;\n\telse\n\t\tinsert_at = GetMenuItemCount(mMenu), by_position = TRUE;\n\t// Although AppendMenu() ignores the ID when adding a separator and provides no way to\n\t// specify the ID when adding a submenu, that is purely a limitation of AppendMenu().\n\t// Using InsertMenuItem() instead allows us to always set the ID, which simplifies\n\t// identifying separator and submenu items later on.\n\treturn InsertMenuItem(mMenu, insert_at, by_position, &mii) ? OK : FAIL;\n}\n\n\n\nUserMenuItem::UserMenuItem(LPTSTR aName, size_t aNameCapacity, UINT aMenuID, IObject *aCallback, UserMenu *aSubmenu, UserMenu *aMenu)\n// UserMenuItem Constructor.\n\t: mName(aName), mNameCapacity(aNameCapacity), mMenuID(aMenuID), mCallback(aCallback), mSubmenu(aSubmenu), mMenu(aMenu)\n\t, mPriority(0) // default priority = 0\n\t, mMenuState(MFS_ENABLED | MFS_UNCHECKED), mMenuType(*aName ? MFT_STRING : MFT_SEPARATOR)\n\t, mNextMenuItem(NULL)\n\t, mBitmap(NULL) // L17: Initialize mIcon/mBitmap union.\n{\n\tif (aSubmenu)\n\t\taSubmenu->AddRef();\n}\n\n\n\nvoid UserMenu::DeleteItem(UserMenuItem *aMenuItem, UserMenuItem *aMenuItemPrev, bool aUpdateGuiMenuBars)\n{\n\t// Remove this menu item from the linked list:\n\tif (aMenuItem == mLastMenuItem)\n\t\tmLastMenuItem = aMenuItemPrev; // Can be NULL if the list will now be empty.\n\tif (aMenuItemPrev) // there is another item prior to aMenuItem in the linked list.\n\t\taMenuItemPrev->mNextMenuItem = aMenuItem->mNextMenuItem; // Can be NULL if aMenuItem was the last one.\n\telse // aMenuItem was the first one in the list.\n\t\tmFirstMenuItem = aMenuItem->mNextMenuItem; // Can be NULL if the list will now be empty.\n\tif (mMenu) // Delete the item from the menu.\n\t\tRemoveMenu(mMenu, aMenuItem_ID, aMenuItem_MF_BY); // v1.0.48: Lexikos: DeleteMenu() destroys any sub-menu handle associated with the item, so use RemoveMenu. Otherwise the submenu handle stored somewhere else in memory would suddenly become invalid.\n\tRemoveItemIcon(aMenuItem); // L17: Free icon or bitmap.\n\tif (mDefault == aMenuItem)\n\t\tmDefault = NULL; // No need to SetDefaultMenuItem since the previous default item was removed.\n\tdelete aMenuItem; // Do this last when its contents are no longer needed.\n\t--mMenuItemCount;\n\tif (aUpdateGuiMenuBars)\n\t\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu) // Verified as being necessary.\n}\n\n\n\nvoid UserMenu::DeleteAllItems()\n// Remove all menu items from the linked list and from the menu.\n{\n\t// Fixed for v1.1.27.03: Don't attempt to take a shortcut by calling DestroyHandle(), as it\n\t// will fail if this is a sub-menu of a menu bar. Removing the items individually will\n\t// do exactly what the user expects. The following old comment indicates one reason\n\t// DestroyHandle() was used; that reason is now obsolete since submenus are given IDs:\n\t// \"In addition, this avoids the need to find any submenus by position:\"\n\tif (!mFirstMenuItem)\n\t\treturn; // If there are no user-defined menu items, it's already in the correct state.\n\tUserMenuItem *menu_item_to_delete;\n\tfor (UserMenuItem *mi = mFirstMenuItem; mi;)\n\t{\n\t\tif (mMenu)\n\t\t\tRemoveMenu(mMenu, mi->mMenuID, MF_BYCOMMAND);\n\t\tmenu_item_to_delete = mi;\n\t\tmi = mi->mNextMenuItem;\n\t\tRemoveItemIcon(menu_item_to_delete); // L26: Free icon or bitmap!\n\t\tdelete menu_item_to_delete;\n\t}\n\tmFirstMenuItem = mLastMenuItem = NULL;\n\tmMenuItemCount = 0;\n\tmDefault = NULL; // i.e. there can't be a *user-defined* default item anymore, even if this is the tray.\n\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu) // Verified as being necessary.\n}\n\n\n\nUserMenuItem::~UserMenuItem()\n{\n\tif (mName != Var::sEmptyString)\n\t\tfree(mName);\n\t// mCallback is handled by ~IObjectRef().\n\tif (mSubmenu)\n\t\tmSubmenu->Release();\n}\n\n\n\nResultType UserMenu::ModifyItem(UserMenuItem *aMenuItem, IObject *aCallback, UserMenu *aSubmenu, LPCTSTR aOptions)\n// Modify the callback, submenu, or options of a menu item (exactly one of these should be NULL and the\n// other not except when updating only the options).\n// If a menu item becomes a submenu, we don't relinquish its ID in case it's ever made a normal item\n// again (avoids the need to re-lookup a unique ID).\n{\n\tif (*aOptions && UpdateOptions(aMenuItem, aOptions) != OK)\n\t\treturn FAIL; // UpdateOptions displays an error message if aOptions contains invalid options.\n\tif (!aCallback && !aSubmenu) // We were called only to update this item's options.\n\t\treturn OK;\n\n\tif (aMenuItem->mMenuID >= ID_TRAY_FIRST && aCallback)\n\t{\n\t\t// For a custom label to work for this item, it must have a different ID.\n\t\tMENUITEMINFO mii;\n\t\tmii.cbSize = sizeof(mii);\n\t\tmii.fMask = MIIM_ID;\n\t\tmii.wID = g_script.GetFreeMenuItemID();\n\t\tif (mMenu)\n\t\t\tSetMenuItemInfo(mMenu, aMenuItem->mMenuID, FALSE, &mii);\n\t\taMenuItem->mMenuID = mii.wID;\n\t}\n\n\taMenuItem->mCallback = aCallback; // This will be NULL if this menu item is a separator or submenu.\n\tif (aMenuItem->mSubmenu == aSubmenu) // Below relies on this check.\n\t\treturn OK;\n\n\tif (aSubmenu)\n\t\taSubmenu->AddRef();\n\tif (aMenuItem->mSubmenu)\n\t\taMenuItem->mSubmenu->Release();\n\taMenuItem->mSubmenu = aSubmenu;\n\n\tif (!mMenu)\n\t\treturn OK;\n\t// Otherwise, since the OS menu exists, one of these is to be done to aMenuItem in it:\n\t// 1) Change a submenu to point to a different menu.\n\t// 2) Change a submenu so that it becomes a normal menu item.\n\t// 3) Change a normal menu item into a submenu.\n\t// Replacing or removing a submenu is known to destroy the old submenu as a side-effect,\n\t// so instead of changing the submenu directly, remove the item and add it back with the\n\t// correct properties.\n\tRemoveMenu(mMenu, aMenuItem->mMenuID, MF_BYCOMMAND);\n\tInternalAppendMenu(aMenuItem, aMenuItem->mNextMenuItem);\n\treturn OK;\n}\n\n\n\nResultType UserMenu::UpdateOptions(UserMenuItem *aMenuItem, LPCTSTR aOptions)\n{\n\tUINT new_type = aMenuItem->mMenuType; // Set default.\n\n\tTCHAR option_word[16]; // Enough for any single option word or number, with room to avoid false positives due to truncation.\n\tLPCTSTR next_option, option_end;\n\tbool adding;\n\n\t// See GuiType::ControlParseOptions() for comments about how the options are parsed.\n\tfor (next_option = aOptions; *next_option; next_option = option_end)\n\t{\n\t\tnext_option = omit_leading_whitespace(next_option);\n\t\tif (*next_option == '-')\n\t\t{\n\t\t\tadding = false;\n\t\t\t++next_option;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tadding = true;\n\t\t\tif (*next_option == '+')\n\t\t\t\t++next_option;\n\t\t}\n\n\t\tif (!*next_option)\n\t\t\tbreak;\n\t\tfor (option_end = next_option; *option_end && !IS_SPACE_OR_TAB(*option_end); ++option_end);\n\t\tif (option_end == next_option)\n\t\t\tcontinue;\n\t\t\n\t\ttcslcpy(option_word, next_option, min((option_end - next_option) + 1, _countof(option_word)));\n\n\t\t// End generic option-parsing code; begin menu options.\n\t\tif (!_tcsicmp(option_word, _T(\"Radio\"))) if (adding) new_type |= MFT_RADIOCHECK; else new_type &= ~MFT_RADIOCHECK;\n\t\telse if (mMenuType == MENU_TYPE_BAR && !_tcsicmp(option_word, _T(\"Right\"))) if (adding) new_type |= MFT_RIGHTJUSTIFY; else new_type &= ~MFT_RIGHTJUSTIFY;\n\t\telse if (!_tcsicmp(option_word, _T(\"Break\"))) if (adding) new_type |= MFT_MENUBREAK; else new_type &= ~MFT_MENUBREAK;\n\t\telse if (!_tcsicmp(option_word, _T(\"BarBreak\"))) if (adding) new_type |= MFT_MENUBARBREAK; else new_type &= ~MFT_MENUBARBREAK;\n\t\telse if (ctoupper(*option_word) == 'P')\n\t\t\taMenuItem->mPriority = ATOI(option_word + 1);\t// invalid priority options are not detected, due to rarity and for brevity. Hence, eg Pxyz, is equivalent to P0.\n\t\telse\n\t\t{\n\t\t\tif (!ValueError(ERR_INVALID_OPTION, option_word, FAIL_OR_OK)) // invalid option\n\t\t\t\treturn FAIL;\n\t\t\t// Otherwise, user wants to continue.\n\t\t}\n\t}\n\n\tif (new_type != aMenuItem->mMenuType)\n\t{\n\t\tif (mMenu)\n\t\t{\n\t\t\tMENUITEMINFO mii;\n\t\t\tmii.cbSize = sizeof(mii);\n\t\t\tmii.fMask = MIIM_FTYPE;\n\t\t\tmii.fType = new_type;\n\t\t\tSetMenuItemInfo(mMenu, aMenuItem->mMenuID, FALSE, &mii);\n\t\t}\n\t\taMenuItem->mMenuType = (WORD)new_type;\n\t}\n\treturn OK;\n}\n\n\n\nResultType UserMenu::RenameItem(UserMenuItem *aMenuItem, LPCTSTR aNewName)\n// Caller should specify \"\" for aNewName to convert aMenuItem into a separator.\n// Returns FAIL if the new name conflicts with an existing name.\n{\n\tif (_tcslen(aNewName) > MAX_MENU_NAME_LENGTH)\n\t\treturn FAIL; // Caller should display error if desired.\n\n\t// Preserve any additional type flags set by options, but exclude the main type bits.\n\t// Also clear MFT_OWNERDRAW (if set by the script), since it changes the meaning of dwTypeData.\n\t// MSDN: \"The MFT_BITMAP, MFT_SEPARATOR, and MFT_STRING values cannot be combined with one another.\"\n\tUINT new_type = (aMenuItem->mMenuType & ~(MFT_BITMAP | MFT_SEPARATOR | MFT_STRING | MFT_OWNERDRAW))\n\t\t| (*aNewName ? MFT_STRING : MFT_SEPARATOR);\n\n\tif (!mMenu) // Just update the member variables for later use when the menu is created.\n\t{\n\t\taMenuItem->mMenuType = (WORD)new_type;\n\t\treturn UpdateName(aMenuItem, aNewName);\n\t}\n\n\tMENUITEMINFO mii;\n\tmii.cbSize = sizeof(mii);\n\tmii.fMask = 0;\n\n\tif (*aNewName)\n\t{\n\t\tif (aMenuItem->mMenuType & MFT_SEPARATOR)\n\t\t{\n\t\t\t// Since this item is currently a separator, the system will have disabled it.\n\t\t\t// Set the item's state to what it should be:\n\t\t\tmii.fMask |= MIIM_STATE;\n\t\t\tmii.fState = aMenuItem->mMenuState;\n\t\t}\n\t}\n\telse // converting into a separator\n\t{\n\t\t// Testing shows that if an item is converted into a separator and back into a\n\t\t// normal item, it retains its submenu. So don't set the submenu to NULL, since\n\t\t// it's not necessary and would result in the OS destroying the submenu:\n\t\t//if (aMenuItem->mSubmenu) // Converting submenu into a separator.\n\t\t//{\n\t\t//\tmii.fMask |= MIIM_SUBMENU;\n\t\t//\tmii.hSubMenu = NULL;\n\t\t//}\n\t}\n\n\tmii.fMask |= MIIM_TYPE;\n\tmii.fType = new_type;\n\tmii.dwTypeData = const_cast<LPTSTR>(aNewName);\n\n\t// v1.1.04: If the new and old names both have accelerators, call UpdateAccelerators() if they\n\t// are different. Otherwise call it if only one is NULL (i.e. accelerator was added or removed).\n\tLPCTSTR old_accel = _tcschr(aMenuItem->mName, '\\t'), new_accel = _tcschr(aNewName, '\\t');\n\tbool update_accel = old_accel && new_accel ? _tcsicmp(old_accel, new_accel) : old_accel != new_accel;\n\n\t// Failure is rare enough in the below that no attempt is made to undo the above:\n\tBOOL result = SetMenuItemInfo(mMenu, aMenuItem->mMenuID, FALSE, &mii);\n\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu) // Verified as being necessary.\n\tif ( !(result && UpdateName(aMenuItem, aNewName)) )\n\t\treturn FAIL;\n\taMenuItem->mMenuType = (WORD)mii.fType; // Update this in case the menu is destroyed/recreated.\n\tif (update_accel) // v1.1.04: Above determined this item's accelerator was changed.\n\t\tUpdateAccelerators(); // Must not be done until after mName is updated.\n\tif (*aNewName)\n\t\tApplyItemIcon(aMenuItem); // If any. Simpler to call this than combine it into the logic above.\n\treturn OK;\n}\n\n\n\nResultType UserMenu::UpdateName(UserMenuItem *aMenuItem, LPCTSTR aNewName)\n// Caller should already have ensured that aMenuItem is not too long.\n{\n\tsize_t new_length = _tcslen(aNewName);\n\tif (new_length)\n\t{\n\t\tif (new_length >= aMenuItem->mNameCapacity) // Too small, so reallocate.\n\t\t{\n\t\t\t// Use a temp var. so that mName will never wind up being NULL (relied on by other things).\n\t\t\t// This also retains the original menu name if the allocation fails:\n\t\t\tLPTSTR temp = tmalloc(new_length + 1); // +1 for terminator.\n\t\t\tif (!temp)\n\t\t\t\treturn FAIL;\n\t\t\t// Otherwise:\n\t\t\tif (aMenuItem->mName != Var::sEmptyString) // Since it was previously allocated, free it.\n\t\t\t\tfree(aMenuItem->mName);\n\t\t\taMenuItem->mName = temp;\n\t\t\taMenuItem->mNameCapacity = new_length + 1;\n\t\t}\n\t\t_tcscpy(aMenuItem->mName, aNewName);\n\t}\n\telse // It will become a separator.\n\t{\n\t\t*aMenuItem->mName = '\\0'; // Safe because even if it's capacity is 1 byte, it's a writable byte.\n\t}\n\treturn OK;\n}\n\n\n\nvoid UserMenu::SetItemState(UserMenuItem *aMenuItem, UINT aState, UINT aStateMask)\n{\n\tif (mMenu)\n\t{\n\t\tMENUITEMINFO mii;\n\t\tmii.cbSize = sizeof(mii);\n\t\tmii.fMask = MIIM_STATE;\n\t\t// Retrieve the current state from the menu rather than using mMenuState,\n\t\t// in case the script has modified the state via DllCall.\n\t\tif (GetMenuItemInfo(mMenu, aMenuItem->mMenuID, FALSE, &mii))\n\t\t{\n\t\t\tmii.fState = (mii.fState & ~aStateMask) ^ aState;\n\t\t\t// Update our state in case the menu gets destroyed/recreated.\n\t\t\taMenuItem->mMenuState = (WORD)mii.fState;\n\t\t\t// Set the new state.\n\t\t\tSetMenuItemInfo(mMenu, aMenuItem->mMenuID, FALSE, &mii);\n\t\t\tif (aStateMask & MFS_DISABLED) // i.e. enabling or disabling, which would affect a menu bar.\n\t\t\t\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu) // Verified as being necessary.\n\t\t\treturn;\n\t\t}\n\t}\n\taMenuItem->mMenuState = (WORD)((aMenuItem->mMenuState & ~aStateMask) ^ aState);\n}\n\n\n\n__declspec(noinline)\nFResult UserMenu::SetItemState(StrArg aItemName, UINT aState, UINT aStateMask, UINT *aNewState)\n{\n\tUserMenuItem *item;\n\tauto fr = GetItem(aItemName, item);\n\tif (fr != OK)\n\t\treturn fr;\n\tSetItemState(item, aState, aStateMask);\n\tif (aNewState)\n\t\t*aNewState = item->mMenuState;\n\treturn OK;\n}\n\n\n\nvoid UserMenu::SetDefault(UserMenuItem *aMenuItem, bool aUpdateGuiMenuBars)\n{\n\tif (mDefault == aMenuItem)\n\t\treturn;\n\tmDefault = aMenuItem;\n\tif (!mMenu) // No further action required: the new setting will be in effect when the menu is created.\n\t\treturn;\n\tif (aMenuItem) // A user-defined menu item is being made the default.\n\t\tSetMenuDefaultItem(mMenu, aMenuItem->mMenuID, FALSE); // This also ensures that only one is default at a time.\n\telse\n\t\tSetMenuDefaultItem(mMenu, -1, FALSE);\n\tif (aUpdateGuiMenuBars)\n\t\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu) // Testing shows that menu bars themselves can have default items, and that this is necessary.\n}\n\n\n\nResultType UserMenu::CreateHandle()\n// Menu bars require non-popup menus (CreateMenu vs. CreatePopupMenu). Rather than maintain two\n// different types of HMENUs on the rare chance that a script might try to use a menu both as\n// a popup and a menu bar, it seems best to have only one type to keep the code simple and reduce\n// resources used for the menu. This is reflected in MenuCreate() and MenuBarCreate(), which\n// create the UserMenu with the appropriate value for mMenuType.\n{\n\tif (mMenu)\n\t\treturn OK;\n\tif ( !(mMenu = (mMenuType == MENU_TYPE_BAR) ? CreateMenu() : CreatePopupMenu()) )\n\t\t// Failure is rare, so no error msg here (caller can, if it wants).\n\t\treturn FAIL;\n\n\t// It seems best not to have a mandatory EXIT item added to the bottom of the tray menu\n\t// because omitting it allows the tray icon to be shown even when the user wants it to\n\t// have no menu at all (i.e. avoids the need for #NoTrayIcon just to disable the showing\n\t// of the menu). If it was done, it should not be done here because calling Menu.Handle\n\t// prior to adding items would have the effect of inserting EXIT at the top.\n\t//if (!mMenuItemCount)\n\t//{\n\t//\tAppendMenu(mTrayMenu->mMenu, MF_STRING, ID_TRAY_EXIT, \"E&xit\");\n\t//\treturn OK;\n\t//}\n\n\t// Now append all of the user defined items:\n\tUserMenuItem *mi;\n\tfor (mi = mFirstMenuItem; mi; mi = mi->mNextMenuItem)\n\t\tInternalAppendMenu(mi);\n\n\tif (mDefault)\n\t\t// This also automatically ensures that only one is default at a time:\n\t\tSetMenuDefaultItem(mMenu, mDefault->mMenuID, FALSE);\n\n\t// Apply background color if this menu has a non-standard one. If this menu has submenus,\n\t// they will be individually given their own background color when created via CreateHandle(),\n\t// which is why false is passed:\n\tApplyColor(false);\n\n\t// L17: Apply default style to merge checkmark/icon columns in menu.\n\tMENUINFO menu_info;\n\tmenu_info.cbSize = sizeof(MENUINFO);\n\tmenu_info.fMask = MIM_STYLE;\n\tmenu_info.dwStyle = MNS_CHECKORBMP;\n\tSetMenuInfo(mMenu, &menu_info);\n\n\treturn OK;\n}\n\n\n\nvoid UserMenu::SetColor(COLORREF aColor, bool aApplyToSubmenus)\n{\n\t// AssignColor() takes care of deleting old brush, etc.\n\tAssignColor(aColor, mColor, mBrush);\n\t// To avoid complications, such as a submenu being detached from its parent and then its parent\n\t// later being deleted (which causes the HBRUSH to get deleted too), give each submenu it's\n\t// own HBRUSH handle by calling SetColor() for each:\n\tif (aApplyToSubmenus)\n\t\tfor (UserMenuItem *mi = mFirstMenuItem; mi; mi = mi->mNextMenuItem)\n\t\t\tif (mi->mSubmenu)\n\t\t\t\tmi->mSubmenu->SetColor(aColor, aApplyToSubmenus);\n\tif (mMenu)\n\t{\n\t\tApplyColor(aApplyToSubmenus);\n\t\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu) // Verified as being necessary.\n\t}\n}\n\n\n\nvoid UserMenu::ApplyColor(bool aApplyToSubmenus)\n// Caller has ensured that mMenu is not NULL.\n// The below should be done even if the default color is being (re)applied because\n// testing shows that the OS sets the color to white if the HBRUSH becomes invalid.\n// The caller is also responsible for calling UPDATE_GUI_MENU_BARS if desired.\n{\n\tMENUINFO mi = {0}; \n\tmi.cbSize = sizeof(MENUINFO);\n\tmi.fMask = MIM_BACKGROUND|(aApplyToSubmenus ? MIM_APPLYTOSUBMENUS : 0);\n\tmi.hbrBack = mBrush;\n\tSetMenuInfo(mMenu, &mi);\n}\n\n\n\nResultType UserMenu::AppendStandardItems()\n// Caller must ensure that this->mMenu exists if it wants the items to be added immediately.\n{\n\tstruct StandardItem\n\t{\n\t\tLPTSTR name;\n\t\tUINT id;\n\t};\n\tstatic StandardItem sItems[] =\n\t{\n\t\t_T(\"&Open\"), ID_TRAY_OPEN,\n#ifndef AUTOHOTKEYSC\n\t\t_T(\"&Help\"), ID_TRAY_HELP,\n\t\t_T(\"\"), ID_TRAY_SEP1,\n\t\t_T(\"&Window Spy\"), ID_TRAY_WINDOWSPY,\n\t\t_T(\"&Reload Script\"), ID_TRAY_RELOADSCRIPT,\n\t\t_T(\"&Edit Script\"), ID_TRAY_EDITSCRIPT,\n\t\t_T(\"\"), ID_TRAY_SEP2,\n#endif\n\t\t_T(\"&Suspend Hotkeys\"), ID_TRAY_SUSPEND,\n\t\t_T(\"&Pause Script\"), ID_TRAY_PAUSE,\n\t\t_T(\"E&xit\"), ID_TRAY_EXIT\n\t};\n\tUserMenuItem *&first_new_item = mLastMenuItem ? mLastMenuItem->mNextMenuItem : mFirstMenuItem;\n\tint i = g_AllowMainWindow ? 0 : 1;\n\tfor (; i < _countof(sItems); ++i)\n\t{\n#ifndef AUTOHOTKEYSC\n\t\tif (i == 1 && g_script.mKind == Script::ScriptKindResource)\n\t\t\ti += 6;\n\t\t// To minimize code size, and to make it easier for a stdin script to imitate a standard script,\n\t\t// the Reload and Edit options are not disabled or removed here for stdin scripts.\n\t\t//else if (i == 4 && g_script.mKind == Script::ScriptKindStdIn)\n\t\t//\ti += 3;\n#endif\n\t\tif (!FindItemByID(sItems[i].id)) // Avoid duplicating items, but add any missing ones.\n\t\t\tif (!AddItem(sItems[i].name, sItems[i].id, NULL, NULL, _T(\"\"), NULL))\n\t\t\t\treturn FAIL;\n\t}\n\tif (this == g_script.mTrayMenu && !mDefault && first_new_item\n\t\t&& first_new_item->mMenuID == ID_TRAY_OPEN)\n\t{\n\t\t// No user-defined default menu item, so use the standard one.\n\t\tSetDefault(first_new_item, false);\n\t}\n\tUPDATE_GUI_MENU_BARS(mMenuType, mMenu) // Verified as being necessary (though it would be rare anyone would want a menu bar to contain the std items).\n\treturn OK; // For caller convenience.\n}\n\n\n\nResultType UserMenu::EnableStandardOpenItem(bool aEnable)\n{\n\tfor (UserMenuItem *mi_prev = NULL, *mi = mFirstMenuItem; mi; mi_prev = mi, mi = mi->mNextMenuItem)\n\t{\n\t\tif (mi->mMenuID >= ID_TRAY_FIRST)\n\t\t{\n\t\t\tbool is_enabled = mi->mMenuID == ID_TRAY_OPEN;\n\t\t\tif (is_enabled != aEnable)\n\t\t\t{\n\t\t\t\tif (aEnable)\n\t\t\t\t{\n\t\t\t\t\tUserMenuItem **p = mi_prev ? &mi_prev->mNextMenuItem : &mFirstMenuItem;\n\t\t\t\t\tif (!AddItem(_T(\"&Open\"), ID_TRAY_OPEN, NULL, NULL, _T(\"\"), p))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\tif (this == g_script.mTrayMenu && !mDefault)\n\t\t\t\t\t\tSetDefault(*p);\n\t\t\t\t\treturn OK;\n\t\t\t\t}\n\t\t\t\tDeleteItem(mi, mi_prev);\n\t\t\t\treturn OK;\n\t\t\t}\n\t\t\tbreak;\n\t\t}\n\t}\n\treturn OK;\n}\n\n\n\nvoid UserMenu::DestroyHandle()\n// Destroys the Win32 menu or marks it NULL if it has already been destroyed externally.\n// This should be called only when the UserMenu is being deleted (or the script is exiting),\n// otherwise any parent menus would still refer to the old Win32 menu. If the UserMenu is\n// being deleted, that implies that its reference count is zero, meaning it isn't in use as\n// a submenu or menu bar.\n{\n\tif (!mMenu) // For performance.\n\t\treturn;\n\t// Testing on Windows 10 shows that DestroyMenu() is able to destroy a menu even while it is\n\t// being displayed, causing only temporary cosmetic issues. Previous testing with menu bars\n\t// showed similar results. There wouldn't be much point in checking the following because the\n\t// script is in an uninterruptible state while the menu is displayed, which in addition to\n\t// pausing the current thread (which happens anyway), no new threads can be launched:\n\t//if (g_MenuIsVisible)\n\t//\treturn FAIL;\n\n\t// MSDN: \"DestroyMenu is recursive, that is, it will destroy the menu and all its submenus.\"\n\t// Therefore remove all submenus before destroying the menu, in case the script is using them.\n\t// If the script is not using them, they will be destroyed automatically as they are released\n\t// by ~UserMenuItem().\n\tfor (UserMenuItem *mi = mFirstMenuItem; mi ; mi = mi->mNextMenuItem)\n\t\tif (mi->mSubmenu)\n\t\t\tRemoveMenu(mMenu, mi->mMenuID, MF_BYCOMMAND);\n\n\tDestroyMenu(mMenu);\n\tmMenu = NULL;\n}\n\n\n\nResultType UserMenu::Display(int aX, int aY, optl<BOOL> aWait)\n// aForceToForeground defaults to true because when a menu is displayed spontaneously rather than\n// in response to the user right-clicking the tray icon, I believe that the OS will revert to its\n// behavior of \"resisting\" a window that tries to \"steal focus\". I believe this resistance does\n// not occur when the user clicks the icon because that click causes the task bar to get focus,\n// and it is likely that the OS allows other windows to steal focus from the task bar without\n// resistance. This is done because if the main window is *not* successfully activated prior to\n// displaying the menu, it might be impossible to dismiss the menu by clicking outside of it.\n{\n\tif (mMenuType != MENU_TYPE_POPUP)\n\t\treturn g_script.RuntimeError(ERR_INVALID_MENU_TYPE);\n\tif (!mMenuItemCount)\n\t\treturn OK; // Consider the display of an empty menu to be a success.\n\tif (!CreateHandle()) // Create if needed. No error msg since so rare.\n\t\treturn FAIL;\n\t//if (!IsMenu(mMenu))\n\t//\tmMenu = NULL;\n\tif (this == g_script.mTrayMenu)\n\t{\n\t\t// These are okay even if the menu items don't exist (perhaps because the user customized the menu):\n\t\tCheckMenuItem(mMenu, ID_TRAY_SUSPEND, g_IsSuspended ? MF_CHECKED : MF_UNCHECKED);\n\t\tCheckMenuItem(mMenu, ID_TRAY_PAUSE, g->IsPaused ? MF_CHECKED : MF_UNCHECKED);\n\t}\n\n\tPOINT pt;\n\tif (aX == COORD_UNSPECIFIED || aY == COORD_UNSPECIFIED)\n\t\tGetCursorPos(&pt);\n\tif (!(aX == COORD_UNSPECIFIED && aY == COORD_UNSPECIFIED)) // At least one was specified.\n\t{\n\t\t// If one coordinate was omitted, pt contains the cursor position in SCREEN COORDINATES.\n\t\t// So don't do something like this, which would incorrectly offset the cursor position\n\t\t// by the window position if CoordMode != Screen:\n\t\t//CoordToScreen(pt, COORD_MODE_MENU);\n\t\tPOINT origin = {0};\n\t\tCoordToScreen(origin, COORD_MODE_MENU);\n\t\tif (aX != COORD_UNSPECIFIED)\n\t\t\tpt.x = aX + origin.x;\n\t\tif (aY != COORD_UNSPECIFIED)\n\t\t\tpt.y = aY + origin.y;\n\t}\n\n\t// UPDATE: For v1.0.35.14, must ensure one of the script's windows is active before showing the menu\n\t// because otherwise the menu cannot be dismissed via the escape key or by clicking outside the menu.\n\t// Testing shows that ensuring any of our thread's windows is active allows both the tray menu and\n\t// any popup or context menus to work correctly.\n\t// UPDATE: For v1.0.35.12, the script's main window (g_hWnd) is activated only for the tray menu because:\n\t// 1) Doing so for GUI context menus seems to prevent mouse clicks in the menu or elsewhere in the window.\n\t// 2) It would probably have other side effects for other uses of popup menus.\n\tHWND fore_win = GetForegroundWindow();\n\tbool change_fore;\n\tif (change_fore = (!fore_win || GetWindowThreadProcessId(fore_win, NULL) != g_MainThreadID))\n\t{\n\t\t// Always bring main window to foreground right before TrackPopupMenu(), even if window is hidden.\n\t\tSetForegroundWindowEx(g_hWnd, true);\n\t}\n\tif (g_MenuIsTempModeless)\n\t{\n\t\t// First end the previous menu, whose thread was interrupted to display this menu.\n\t\t// This is necessary to ensure the menu/window style changes made below are reverted.\n\t\tEndMenu();\n\t\tMsgSleep(-1);\n\t}\n\t// This works around an issue observed on Windows 10, where the menu doesn't respond to\n\t// keyboard input if none of the script's windows have previously received input:\n\tstatic bool sAppliedWorkaround = false;\n\tif (!sAppliedWorkaround)\n\t{\n\t\tsAppliedWorkaround = true;\n\t\tPostMessage(change_fore ? g_hWnd : fore_win, WM_KEYUP, 0, 0);\n\t\tSLEEP_WITHOUT_INTERRUPTION(-1);\n\t}\n\tMENUINFO mi;\n\tmi.cbSize = sizeof(mi);\n\tmi.fMask = MIM_STYLE;\n\tmi.dwStyle = 0;\n\tGetMenuInfo(mMenu, &mi);\n\tbool temp_topmost = false;\n\tbool own_by_fore = false;\n\t// Temporarily make the menu modeless to allow new threads to launch without preventing the menu from\n\t// accepting user input. If it was already modeless, don't wait for it to close before returning.\n\tbool temp_modeless = !(mi.dwStyle & MNS_MODELESS);\n\tif (temp_modeless)\n\t{\n\t\tmi.dwStyle |= MNS_MODELESS;\n\t\tSetMenuInfo(mMenu, &mi);\n\t\t// Use this to keep track of whether a modeless menu is active. Modeless menus correctly cancel\n\t\t// when losing focus to another window in the same app, but not when losing focus to another app,\n\t\t// so we handle that explicitly in \"case WM_ACTIVATEAPP:\".\n\t\tg_MenuIsTempModeless = mMenu;\n\t\t// Modeless menus appear to always place themselves in the z-order according to whether the owner\n\t\t// window is topmost, which makes sense except that this places them behind the tray or overflow\n\t\t// area, inconsistent with modal menus. To work around that, make g_hWnd temporarily topmost.\n\t\t// Making the menu window topmost in WM_INITMENUPOPUP is insufficient because each time a submenu\n\t\t// is shown, the menu windows are reordered, and WM_INITMENUPOPUP for the submenu is received\n\t\t// before its window is created. Making g_hWnd topmost shouldn't be too disruptive because\n\t\t// SetForegroundWindow() already brought it to the front if it was visible.\n\t\t// Only g_hWnd and GUI windows can own the menu, otherwise WM_(UN)INITPOPUPMENU won't be caught.\n\t\t// Allowing an active GUI window to own the menu ensures the menu appears on top even if the GUI\n\t\t// is topmost, without making g_hWnd topmost.\n\t\town_by_fore = !change_fore && GuiType::FindGui(fore_win);\n\t\ttemp_topmost = !own_by_fore\n\t\t\t&& (GetWindowLong(fore_win, GWL_EXSTYLE) & WS_EX_TOPMOST)\n\t\t\t&& !(GetWindowLong(g_hWnd, GWL_EXSTYLE) & WS_EX_TOPMOST);\n\t\tif (temp_topmost)\n\t\t\tSetWindowPos(g_hWnd, HWND_TOPMOST, 0, 0, 0, 0, SWP_NOMOVE | SWP_NOSIZE);\n\t}\n\tg_MenuIsTempTopmost = temp_topmost;\n\tTrackPopupMenuEx(mMenu, TPM_LEFTALIGN | TPM_LEFTBUTTON, pt.x, pt.y, own_by_fore ? fore_win : g_hWnd, NULL);\n\tif (mi.dwStyle & MNS_MODELESS)\n\t{\n\t\t// Default to waiting if the menu was modal upon entry to this function, else not waiting.\n\t\t// If we're not waiting, must not restore the foreground window yet since the menu is almost\n\t\t// certainly still visible.\n\t\tif (!aWait.value_or(temp_modeless))\n\t\t\treturn OK; // The other actions below are unlikely to apply in this case.\n\t\t// We made it modeless, so wait until the menu closes before returning.\n\t\twhile (g_MenuIsTempModeless == mMenu)\n\t\t\tMsgSleep(INTERVAL_UNSPECIFIED);\n\t}\n\t// Seems best to avoid the following for the tray menu since it doesn't seem to work and might\n\t// produce side-effects in some cases. The check might currently be unnecessary when the tray\n\t// menu is shown by internal code because !aWait would have caused return above, but it might\n\t// be helpful for cases where the script shows the tray menu manually, such as if it intercepts\n\t// right click by handling the AHK_NOTIFYICON message.\n\tif (this != g_script.mTrayMenu)\n\t{\n\t\tif (change_fore && fore_win && GetForegroundWindow() == g_hWnd)\n\t\t{\n\t\t\t// The last of the conditions above is checked in case the user clicked the taskbar or some\n\t\t\t// other window to dismiss the menu. In that case, the following isn't done because it typically\n\t\t\t// steals focus from the user's intended window, and this attempt usually fails due to the OS's\n\t\t\t// anti-focus-stealing measure, which in turn would cause fore_win's taskbar button to flash annoyingly.\n\t\t\tSetForegroundWindow(fore_win); // See comments above for why SetForegroundWindowEx() isn't used.\n\t\t\t// The following resolves the issue where the window would not have enough time to become active\n\t\t\t// before we continued using our timeslice to return to our caller and launch our new thread.\n\t\t\t// In other words, the menu thread would launch before SetForegroundWindow() actually had a chance\n\t\t\t// to take effect:\n\t\t\t// 0 is exactly the amount of time (-1 is not enough because it doesn't yield) needed for that\n\t\t\t// other process to actually ack/perform the activation of its window and clean out its queue using\n\t\t\t// one timeslice. This has been tested even when the CPU is maxed from some third-party process.\n\t\t\t// For performance and code simplicity, it seems best not to do a GetForegroundWindow() loop that\n\t\t\t// waits for it to become active (unless others report that this method is significantly unreliable):\n\t\t\tSLEEP_WITHOUT_INTERRUPTION(0);\n\t\t}\n\t}\n\t// Fix for v1.0.38.05: If the current thread is interruptible (which it should be since a menu was just\n\t// displayed, which almost certainly timed out the default Thread Interrupt setting), the following\n\t// MsgSleep() will launch the selected menu item's subroutine. This fix is needed because of a change\n\t// in v1.0.38.04, namely the line \"g_script.mLastPeekTime = tick_now;\" in IsCycleComplete().\n\t// The root problem here is that it would not be intuitive to allow the command after\n\t// \"Menu, MyMenu, Show\" to run before the menu item's subroutine launches as a new thread.\n\t// \n\t// You could argue that selecting a menu item should immediately execute the selected menu item's\n\t// callback rather than queuing it up as a new thread. However, even if that is a better method,\n\t// it would break existing scripts that rely on new-thread behavior (such as fresh default for\n\t// SetKeyDelay).\n\t//\n\t// Without this fix, a script such as the following (and many other things similar) would\n\t// counterintuitively fail to launch the selected item's subroutine:\n\t// Menu, MyMenu, Add, NOTEPAD\n\t// Menu, MyMenu, Show\n\t// ; Sleep 0 ; Uncommenting this line was necessary in v1.0.38.04 but not any other versions.\n\t// ExitApp\n\tMsgSleep(-1);\n\treturn OK;\n}\n\n\n\nUINT UserMenuItem::Pos()\n{\n\tUINT pos = 0;\n\tfor (UserMenuItem *mi = mMenu->mFirstMenuItem; mi; mi = mi->mNextMenuItem, ++pos)\n\t\tif (mi == this)\n\t\t\treturn pos;\n\treturn UINT_MAX;\n}\n\n\n\nbool UserMenu::ContainsMenu(UserMenu *aMenu)\n{\n\tif (!aMenu)\n\t\treturn false;\n\t// For each submenu in mMenu: Check if it or any of its submenus equals aMenu.\n\tfor (UserMenuItem *mi = mFirstMenuItem; mi; mi = mi->mNextMenuItem)\n\t\tif (mi->mSubmenu)\n\t\t\tif (mi->mSubmenu == aMenu || mi->mSubmenu->ContainsMenu(aMenu)) // recursive\n\t\t\t\treturn true;\n\t\t\t//else keep searching\n\treturn false;\n}\n\n\n\nvoid UserMenu::UpdateAccelerators()\n{\n\tif (!mMenu)\n\t\t// Menu doesn't exist yet, so can't be attached (directly or indirectly) to any GUIs.\n\t\treturn;\n\n\tif (mMenuType == MENU_TYPE_BAR)\n\t{\n\t\tfor (GuiType* gui = g_firstGui; gui; gui = gui->mNextGui)\n\t\t\tif (GetMenu(gui->mHwnd) == mMenu)\n\t\t\t{\n\t\t\t\tgui->UpdateAccelerators(*this);\n\t\t\t\t// Continue in case there are other GUIs using this menu.\n\t\t\t\t//break;\n\t\t\t}\n\t}\n\telse\n\t{\n\t\t// This menu isn't a menu bar, but perhaps it is contained by one.\n\t\tfor (UserMenu *menu = g_script.mFirstMenu; menu; menu = menu->mNextMenu)\n\t\t\tif (menu->mMenuType == MENU_TYPE_BAR && menu->ContainsMenu(this))\n\t\t\t{\n\t\t\t\tmenu->UpdateAccelerators();\n\t\t\t\t// Continue in case there are other menus which contain this submenu.\n\t\t\t\t//break;\n\t\t\t}\n\t\treturn;\n\t}\n}\n\n\n\n//\n// L17: Menu-item icon functions.\n//\n\n\nResultType UserMenu::SetItemIcon(UserMenuItem *aMenuItem, LPCTSTR aFilename, int aIconNumber, int aWidth)\n{\n\tif (!*aFilename || (*aFilename == '*' && !aFilename[1]))\n\t{\n\t\tRemoveItemIcon(aMenuItem);\n\t\treturn OK;\n\t}\n\n\tint image_type;\n\tHBITMAP new_icon, new_copy;\n\t// Currently height is always -1 and cannot be overridden. -1 means maintain aspect ratio, usually 1:1 for icons.\n\tif ( !(new_icon = LoadPicture(aFilename, aWidth, -1, image_type, aIconNumber, false)) )\n\t\treturn FAIL;\n\n\tif (image_type != IMAGE_BITMAP) // Convert to 32-bit bitmap:\n\t{\n\t\tnew_copy = IconToBitmap32((HICON)new_icon, true);\n\t\t// Even if conversion failed, we have no further use for the icon:\n\t\tDestroyIcon((HICON)new_icon);\n\t\tif (!new_copy)\n\t\t\treturn FAIL;\n\t\tnew_icon = new_copy;\n\t}\n\n\tif (aMenuItem->mBitmap) // Delete previous bitmap.\n\t\tDeleteObject(aMenuItem->mBitmap);\n\t\n\taMenuItem->mBitmap = new_icon;\n\n\tif (mMenu)\n\t\tApplyItemIcon(aMenuItem);\n\n\treturn aMenuItem->mBitmap ? OK : FAIL;\n}\n\n\n// Caller has ensured mMenu is non-NULL.\nvoid UserMenu::ApplyItemIcon(UserMenuItem *aMenuItem)\n{\n\tif (aMenuItem->mBitmap)\n\t{\n\t\tMENUITEMINFO item_info;\n\t\titem_info.cbSize = sizeof(MENUITEMINFO);\n\t\titem_info.fMask = MIIM_BITMAP;\n\t\t// Set HBMMENU_CALLBACK or 32-bit bitmap as appropriate.\n\t\titem_info.hbmpItem = aMenuItem->mBitmap;\n\t\tSetMenuItemInfo(mMenu, aMenuItem_ID, aMenuItem_MF_BY, &item_info);\n\t}\n}\n\n\nvoid UserMenu::RemoveItemIcon(UserMenuItem *aMenuItem)\n{\n\tif (aMenuItem->mBitmap)\n\t{\n\t\tif (mMenu)\n\t\t{\n\t\t\tMENUITEMINFO item_info;\n\t\t\titem_info.cbSize = sizeof(MENUITEMINFO);\n\t\t\titem_info.fMask = MIIM_BITMAP;\n\t\t\titem_info.hbmpItem = NULL;\n\t\t\tSetMenuItemInfo(mMenu, aMenuItem_ID, aMenuItem_MF_BY, &item_info);\n\t\t}\n\t\tDeleteObject(aMenuItem->mBitmap);\n\t\taMenuItem->mBitmap = NULL;\n\t}\n}\n\n"},"size":{"kind":"number","value":53000,"string":"53,000"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1259,"string":"1,259"},"avg_line_length":{"kind":"number","value":39.603653693407466,"string":"39.603654"},"max_line_length":{"kind":"number","value":251,"string":"251"},"alphanum_fraction":{"kind":"number","value":0.7322568750363887,"string":"0.732257"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11075,"cells":{"id":{"kind":"number","value":16062,"string":"16,062"},"file_name":{"kind":"string","value":"Debugger.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/Debugger.cpp"},"content":{"kind":"string","value":"/*\nDebugger.cpp - Main body of AutoHotkey debugger engine.\n\nOriginal code by Steve Gray.\n\nThis software is provided 'as-is', without any express or implied\nwarranty. In no event will the authors be held liable for any damages\narising from the use of this software.\n\nPermission is granted to anyone to use this software for any purpose,\nincluding commercial applications, and to alter it and redistribute it\nfreely, without restriction.\n*/\n\n#include \"stdafx.h\"\n\n#include \"defines.h\"\n#include \"globaldata.h\" // for access to many global vars\n#include \"script_object.h\"\n#include \"script_com.h\"\n#include \"TextIO.h\"\n//#include \"Debugger.h\" // included by globaldata.h\n\n#ifdef CONFIG_DEBUGGER\n\n// helper macro for WriteF()\n#define U4T(s) CStringUTF8FromTChar(s).GetString()\n\n#include <ws2tcpip.h>\n#include <wspiapi.h> // for getaddrinfo()\n#include <stdarg.h>\n\nDebugger g_Debugger;\nCStringA g_DebuggerHost;\nCStringA g_DebuggerPort;\n\nLPCTSTR g_AutoExecuteThreadDesc = _T(\"Auto-execute\"); // This is used to reduce code size (allow comparing address vs. string).\n\n// The first breakpoint uses sMaxId + 1. Don't change this without also changing breakpoint_remove.\nint Breakpoint::sMaxId = 0;\n\n\nDebugger::CommandDef Debugger::sCommands[] =\n{\n\t{\"run\", &run},\n\t{\"step_into\", &step_into},\n\t{\"step_over\", &step_over},\n\t{\"step_out\", &step_out},\n\t{\"break\", &_break},\n\t{\"stop\", &stop},\n\t{\"detach\", &detach},\n\n\t{\"status\", &status},\n\t\n\t{\"stack_get\", &stack_get},\n\t{\"stack_depth\", &stack_depth},\n\t{\"context_get\", &context_get},\n\t{\"context_names\", &context_names},\n\n\t{\"property_get\", &property_get},\n\t{\"property_set\", &property_set},\n\t{\"property_value\", &property_value},\n\t\n\t{\"feature_get\", &feature_get},\n\t{\"feature_set\", &feature_set},\n\t\n\t{\"breakpoint_set\", &breakpoint_set},\n\t{\"breakpoint_get\", &breakpoint_get},\n\t{\"breakpoint_update\", &breakpoint_update},\n\t{\"breakpoint_remove\", &breakpoint_remove},\n\t{\"breakpoint_list\", &breakpoint_list},\n\n\t{\"stdout\", &redirect_stdout},\n\t{\"stderr\", &redirect_stderr},\n\n\t{\"typemap_get\", &typemap_get},\n\t\n\t{\"source\", &source},\n};\n\n\ninline bool PreExecLineIsSlippery(Line *aLine)\n{\n\tActionTypeType act = aLine->mActionType;\n\t// BLOCK_BEGIN: yes\n\t// BLOCK_END: yes if !mAttribute (not a function-body)\n\t// TRY, CATCH, FINALLY: yes\n\t// THROW, SWITCH: no\n\t// CASE: yes\n\treturn act >= ACT_TRY ? (act <= ACT_FINALLY || act == ACT_CASE)\n\t\t: act == ACT_BLOCK_BEGIN || act == ACT_BLOCK_END && !aLine->mAttribute;\n}\n\ninline bool BreakpointLineIsSlippery(Line *aLine)\n{\n\tActionTypeType act = aLine->mActionType;\n\t// BLOCK_BEGIN: yes\n\t// BLOCK_END: no (can be used for \"break-on-return\"; also, doesn't make sense to slip to the next line?)\n\t// ELSE: yes\n\t// TRY, CATCH, FINALLY: yes\n\t// THROW, SWITCH: no\n\t// CASE: yes\n\treturn act >= ACT_TRY ? (act <= ACT_FINALLY || act == ACT_CASE)\n\t\t: act == ACT_ELSE || act == ACT_BLOCK_BEGIN;\n}\n\nLine *Debugger::FindFirstLineForBreakpoint(int file_index, UINT line_no)\n{\n\tLine *found_line = nullptr;\n\tfor (auto mod = g_script.mLastModule; mod; mod = mod->mPrev)\n\tfor (Line *line = mod->mFirstLine; line; line = line->mNextLine)\n\t{\n\t\tif (line->mFileIndex == file_index && line->mLineNumber >= line_no)\n\t\t{\n\t\t\t// ACT_ELSE and ACT_BLOCK_BEGIN generally don't cause PreExecLine() to be called,\n\t\t\t// so any breakpoint set on one of those lines would never be hit. Attempting to\n\t\t\t// set a breakpoint on one of these should act like setting a breakpoint on a line\n\t\t\t// which contains no code: put the breakpoint at the next line instead.\n\t\t\t// ACT_CASE executes when the *previous* case reaches its end, so for that case\n\t\t\t// we want to shift the breakpoint to the first Line after the ACT_CASE.\n\t\t\tif (BreakpointLineIsSlippery(line))\n\t\t\t\tcontinue;\n\t\t\t// Use the first line of code at or after lineno, like Visual Studio.\n\t\t\t// To display the breakpoint correctly, an IDE should use breakpoint_get.\n\t\t\tif (!found_line || found_line->mLineNumber > line->mLineNumber)\n\t\t\t\tfound_line = line;\n\t\t\tif (line->mLineNumber == line_no)\n\t\t\t\tbreak;\n\t\t\t//else must keep searching, since class var initializers can cause lines to be listed out of order.\n\t\t}\n\t}\n\treturn found_line;\n}\n\nBreakpoint *Debugger::CreateBreakpoint()\n{\n\tauto bp = new Breakpoint();\n\tmLastBreakpoint->next = bp;\n\tmLastBreakpoint = bp;\n\treturn bp;\n}\n\nvoid Debugger::DeleteBreakpoint(Breakpoint *aBp)\n{\n\t// aBp != mFirstBreakpoint, because that's currently always &mBreakOnException.\n\tfor (Breakpoint *p = mFirstBreakpoint;; p = p->next)\n\t{\n\t\tif (p->next == aBp)\n\t\t{\n\t\t\tp->next = aBp->next;\n\t\t\tif (mLastBreakpoint == aBp)\n\t\t\t\tmLastBreakpoint = p;\n\t\t\tbreak;\n\t\t}\n\t}\n\tdelete aBp;\n}\n\n// Set Line::mBreakpoint for all executable lines that share the line's number,\n// such as an expression and any fat arrow function's it contains, or all param\n// default initializers in e.g. `Fn(a:=[], b:={}) {`.\nvoid SetBreakpointForLineGroup(Line *line, Breakpoint *bp)\n{\n\tauto line_no = line->mLineNumber;\n\tauto file_no = line->mFileIndex;\n\tdo {\n\t\tif (line->mActionType != ACT_BLOCK_BEGIN) // Skip the block-begin implied by any fat-arrow.\n\t\t\tline->mBreakpoint = bp;\n\t\tline = line->mNextLine;\n\t} while (line && line->mLineNumber == line_no && line->mFileIndex == file_no);\n}\n\n\n// PreExecLine: aLine is about to execute; handle current line marker, breakpoints and step into/over/out.\nint Debugger::PreExecLine(Line *aLine)\n{\n\t// Using this->mCurrLine might perform a little better than the alternative, at the expense of a\n\t// small amount of complexity in stack_get (which is only called by request of the debugger client):\n\t//\tmStack.mTop->line = aLine;\n\tmCurrLine = aLine;\n\n\tif (mProcessingCommands) // Reentry into ProcessCommands() isn't possible, so Break() would be ignored.\n\t\treturn DEBUGGER_E_OK; // Skip the rest; in particular, don't delete any temporary breakpoints.\n\t\n\t// Check for a breakpoint on the current line:\n\tBreakpoint *bp = aLine->mBreakpoint;\n\tif (bp && bp->state == BS_Enabled)\n\t{\n\t\tif (bp->temporary)\n\t\t{\n\t\t\tLine *line = aLine, *prev;\n\t\t\twhile ((prev = line->mPrevLine) && prev->mLineNumber == line->mLineNumber && prev->mFileIndex == line->mFileIndex)\n\t\t\t\tline = prev;\n\t\t\tSetBreakpointForLineGroup(line, nullptr);\n\t\t\tDeleteBreakpoint(bp);\n\t\t}\n\t\treturn Break();\n\t}\n\n\tif ((mInternalState == DIS_StepInto\n\t\t|| mInternalState == DIS_StepOver && mStack.Depth() <= mContinuationDepth\n\t\t|| mInternalState == DIS_StepOut && mStack.Depth() < mContinuationDepth) // Due to short-circuit boolean evaluation, mStack.Depth() is only evaluated once and only if mInternalState is StepOver or StepOut.\n\t\t// Although IF/ELSE/LOOP skips its block-begin, standalone/function-body block-begin still gets here; we want to skip it,\n\t\t// unless it's the block-end of a function, to allow breaking there after a \"return\" to inspect variables while still in scope.\n\t\t&& !PreExecLineIsSlippery(aLine)\n\t\t&& aLine->mLineNumber) // Lines with no number should be skipped (e.g. lines inserted by Script::DefineClassInit).\n\t{\n\t\treturn Break();\n\t}\n\t\n\t// Check if a command was sent asynchronously (while the script was running).\n\t// Such commands may also be detected via the AHK_CHECK_DEBUGGER message,\n\t// but if the program is checking for messages infrequently or not at all,\n\t// the check here is needed to ensure the debugger is responsive.\n\tif (HasPendingCommand())\n\t{\n\t\t// A command was sent asynchronously.\n\t\treturn ProcessCommands();\n\t}\n\t\n\treturn DEBUGGER_E_OK;\n}\n\n\nvoid Debugger::LeaveFunction()\n{\n\t// If the debugger is stepping out from a user-defined function, break at the line\n\t// which called the function. Otherwise, a step might appear to jump from one\n\t// function to another called by the same line, or to the next line, or to some line\n\t// further up the stack. Into/Over count as stepping out only if the function we're\n\t// leaving is the one in which the step command was issued.\n\tif (mInternalState == DIS_StepInto\n\t\t|| ((mInternalState == DIS_StepOut || mInternalState == DIS_StepOver)\n\t\t\t&& mStack.Depth() < mContinuationDepth) // Always '<' and not '<=' (for StepOver) because we just returned from a function call.\n\t\t&& mStack.mTop > mStack.mBottom) // More than one entry, otherwise mCurrLine has no meaning.\n\t\tPreExecLine(mCurrLine);\n}\n\n\nbool Debugger::PreThrow(ExprTokenType *aException)\n{\n\tif (mBreakOnException.state != BS_Enabled)\n\t\treturn false;\n\tif (mBreakOnException.temporary)\n\t\tmBreakOnException.state = BS_Disabled;\n\tmThrownToken = aException;\n\t// The spec doesn't provide a way to differentiate between handled and unhandled exceptions,\n\t// nor when to use the \"exception\" and \"error\" statuses, so we'll use them for that:\n\tBreak((g->ExcptMode & EXCPTMODE_CATCH) ? \"exception\" : \"error\");\n\tbool suppress_default_handling = mThrownToken == NULL; // Signal from client via property_set.\n\tmThrownToken = NULL;\n\treturn suppress_default_handling;\n}\n\n\nbool Debugger::HasPendingCommand()\n// Returns true if there is data in the socket's receive buffer.\n// This is used for receiving commands asynchronously.\n{\n\tu_long dataPending;\n\tif (ioctlsocket(mSocket, FIONREAD, &dataPending) == 0)\n\t\treturn dataPending > 0;\n\treturn false;\n}\n\n\nint Debugger::EnterBreakState(LPCSTR aReason)\n{\n\tif (mInternalState != DIS_Break)\n\t{\n\t\tif (mInternalState != DIS_Starting)\n\t\t\t// Send a response for the previous continuation command.\n\t\t\tif (int err = SendContinuationResponse(nullptr, \"break\", aReason))\n\t\t\t\treturn err;\n\t\t// Remove keyboard/mouse hooks.\n\t\tif (mDisabledHooks = GetActiveHooks())\n\t\t\tAddRemoveHooks(0, true);\n\t\t// Set break state.\n\t\tmInternalState = DIS_Break;\n\t}\n\t//else: no continuation command has been received so send no \"response\".\n\t// Hooks were already removed and mDisabledHooks must not be overwritten.\n\treturn DEBUGGER_E_OK;\n}\n\n\nvoid Debugger::ExitBreakState()\n{\n\t// Restore keyboard/mouse hooks if they were previously removed.\n\tif (mDisabledHooks)\n\t{\n\t\tAddRemoveHooks(mDisabledHooks, true);\n\t\tmDisabledHooks = 0;\n\t}\n}\n\n\nint Debugger::Break(LPCSTR aReason)\n{\n\treturn ProcessCommands(aReason);\n}\n\n\nconst int MAX_DBGP_ARGS = 16; // More than currently necessary.\n\nint Debugger::ProcessCommands(LPCSTR aBreakReason)\n{\n\tint err;\n\n\t// The command loop isn't designed to support re-entry, so that is prevented by\n\t// the following check. Re-entry could otherwise occur if a command causes script\n\t// to execute and then a command is received asynchonously or a breakpoint is hit.\n\t// Such commands include:\n\t// - property_get when evaluation of an object property is required.\n\t// - property_set when an object with __delete is released.\n\t// Note that both the executing command and pending command could be asynchronous.\n\t// Although re-entry could be supported by preserving data already in the buffers,\n\t// more complexity would be needed to ensure each command is given the chance to\n\t// complete before another one is pushed onto the stack (otherwise, rapid commands\n\t// could cause stack exhaustion).\n\tif (mProcessingCommands)\n\t\treturn DEBUGGER_E_OK;\n\tif (aBreakReason)\n\t\tif (err = EnterBreakState(aBreakReason))\n\t\t\treturn err;\n\tmProcessingCommands = true;\n\t// Set a non-zero ExcptMode so that UnhandledException will be called for runtime\n\t// errors, and use EXCPTMODE_DEBUGGER so that UnhandledException will immediately\n\t// free the exception and return FAIL without doing any reporting.\n\t// Any ExcptMode flags of the interrupted thread don't apply to code executed by the\n\t// debugger, since it isn't executing within or being called by the current block.\n\tauto excptmode = g->ExcptMode;\n\tg->ExcptMode = EXCPTMODE_DEBUGGER;\n\n\t// Disable notification of READ readiness and reset socket to synchronous mode.\n\tu_long zero = 0;\n\tWSAAsyncSelect(mSocket, g_hWnd, 0, 0);\n\tioctlsocket(mSocket, FIONBIO, &zero);\n\n\tfor (;;)\n\t{\n\t\tint command_length;\n\n\t\tif (err = ReceiveCommand(&command_length))\n\t\t\tbreak; // Already called FatalError().\n\n\t\tchar *command = mCommandBuf.mData;\n\t\tchar *args = strchr(command, ' ');\n\t\tchar *argv[MAX_DBGP_ARGS];\n\t\tint arg_count = 0;\n\n\t\t// transaction_id is considered optional for the following reasons:\n\t\t// - The spec doesn't explicitly say it is mandatory (just \"standard\").\n\t\t// - We don't actually need it for anything.\n\t\t// - Rejecting the command doesn't seem useful.\n\t\t// - It makes manually typing DBGp commands easier.\n\t\tchar *transaction_id = \"\";\n\n\t\tif (args)\n\t\t{\n\t\t\t// Split command name and args.\n\t\t\t*args++ = '\\0';\n\t\t\t// Split args into arg vector.\n\t\t\terr = ParseArgs(args, argv, arg_count, transaction_id);\n\t\t}\n\t\t\n\t\tif (!err)\n\t\t{\n\t\t\tfor (int i = 0; ; ++i)\n\t\t\t{\n\t\t\t\tif (i == _countof(sCommands))\n\t\t\t\t{\n\t\t\t\t\terr = DEBUGGER_E_UNIMPL_COMMAND;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tif (!strcmp(sCommands[i].mName, command))\n\t\t\t\t{\n\t\t\t\t\t// EXECUTE THE DBGP COMMAND.\n\t\t\t\t\terr = (this->*sCommands[i].mFunc)(argv, arg_count, transaction_id);\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (!err)\n\t\t{\n\t\t\tif (mResponseBuf.mDataUsed)\n\t\t\t\terr = SendResponse();\n\t\t\telse\n\t\t\t\terr = SendStandardResponse(command, transaction_id);\n\t\t\tif (err)\n\t\t\t\tbreak; // Already called FatalError().\n\t\t}\n\t\telse if (err == DEBUGGER_E_CONTINUE)\n\t\t{\n\t\t\tASSERT(mInternalState != DIS_Break);\n\t\t\t// Response will be sent when the debugger breaks again.\n\t\t\terr = DEBUGGER_E_OK;\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Clear the response buffer in case a response was partially written\n\t\t\t// before the error was encountered (or the command failed because the\n\t\t\t// response buffer is full and cannot be expanded).\n\t\t\tmResponseBuf.Clear();\n\n\t\t\tif (mSocket == INVALID_SOCKET) // Already disconnected; see FatalError().\n\t\t\t\tbreak;\n\n\t\t\tif (err = SendErrorResponse(command, transaction_id, err))\n\t\t\t\tbreak; // Already called FatalError().\n\t\t}\n\t\t\n\t\t// Remove this command and its args from the buffer.\n\t\t// (There may be additional commands following it.)\n\t\tif (mCommandBuf.mDataUsed) // i.e. it hasn't been cleared as a result of disconnecting.\n\t\t\tmCommandBuf.Delete(command_length + 1);\n\n\t\t// If a command is received asynchronously, the debugger does not\n\t\t// enter a break state. In that case, we need to return after each\n\t\t// command to avoid blocking in recv().\n\t\tif (mInternalState != DIS_Break)\n\t\t{\n\t\t\t// As ExitBreakState() can cause re-entry into ReceiveCommand() via the message pump,\n\t\t\t// it is safe to call only now that the command has been removed from the buffer.\n\t\t\tif (mInternalState != DIS_Starting) // i.e. it hasn't already been called by Disconnect().\n\t\t\t\tExitBreakState();\n\t\t\tbreak;\n\t\t}\n\t}\n\tASSERT(mInternalState != DIS_Break);\n\tmProcessingCommands = false;\n\tg->ExcptMode = excptmode;\n\t// Register for message-based notification of data arrival. If a command\n\t// is received asynchronously, control will be passed back to the debugger\n\t// to process it. This allows the debugger engine to respond even if the\n\t// script is sleeping or waiting for messages.\n\tif (mSocket != INVALID_SOCKET)\n\t\tWSAAsyncSelect(mSocket, g_hWnd, AHK_CHECK_DEBUGGER, FD_READ | FD_CLOSE);\n\treturn err;\n}\n\nint Debugger::ParseArgs(char *aArgs, char **aArgV, int &aArgCount, char *&aTransactionId)\n{\n\taArgCount = 0;\n\n\twhile (*aArgs)\n\t{\n\t\tif (aArgCount == MAX_DBGP_ARGS)\n\t\t\treturn DEBUGGER_E_PARSE_ERROR;\n\n\t\tif (*aArgs != '-')\n\t\t\treturn DEBUGGER_E_PARSE_ERROR;\n\t\t++aArgs;\n\n\t\tchar arg_char = *aArgs;\n\t\tif (!arg_char)\n\t\t\treturn DEBUGGER_E_PARSE_ERROR;\n\t\t\n\t\tif (aArgs[1] == ' ' && aArgs[2] != '-')\n\t\t{\n\t\t\t// Move the arg letter onto the space.\n\t\t\t*++aArgs = arg_char;\n\t\t}\n\t\t// Store a pointer to the arg letter, followed immediately by its value.\n\t\taArgV[aArgCount++] = aArgs;\n\t\t\n\t\tif (arg_char == 'i')\n\t\t{\n\t\t\t// Handle transaction_id here to simplify many other sections.\n\t\t\taTransactionId = aArgs + 1;\n\t\t\t--aArgCount;\n\t\t}\n\n\t\tif (arg_char == '-') // -- base64-encoded-data\n\t\t\tbreak;\n\n\t\tchar *next_arg;\n\t\tif (aArgs[1] == '\"')\n\t\t{\n\t\t\tchar *arg_end;\n\t\t\tfor (arg_end = aArgs + 1, next_arg = aArgs + 2; *next_arg != '\"'; ++arg_end, ++next_arg)\n\t\t\t{\n\t\t\t\tif (*next_arg == '\\\\')\n\t\t\t\t\t++next_arg; // Currently only \\\\ and \\\" are supported; i.e. mark next char as literal.\n\t\t\t\tif (!*next_arg)\n\t\t\t\t\treturn DEBUGGER_E_PARSE_ERROR;\n\t\t\t\t// Copy the value to eliminate the quotes and escape sequences.\n\t\t\t\t*arg_end = *next_arg;\n\t\t\t}\n\t\t\t*arg_end = '\\0'; // Terminate this arg.\n\t\t\t++next_arg;\n\t\t\tif (!*next_arg)\n\t\t\t\tbreak;\n\t\t\tif (strncmp(next_arg, \" -\", 2))\n\t\t\t\treturn DEBUGGER_E_PARSE_ERROR;\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Find where this arg's value ends and the next arg begins.\n\t\t\tnext_arg = strstr(aArgs + 1, \" -\");\n\t\t\tif (!next_arg)\n\t\t\t\tbreak;\n\t\t\t*next_arg = '\\0'; // Terminate this arg.\n\t\t}\n\t\t\n\t\t// Point aArgs to the next arg's hyphen.\n\t\taArgs = next_arg + 1;\n\t}\n\n\treturn DEBUGGER_E_OK;\n}\n\n\n//\n// DBGP COMMANDS\n//\n\n// Calculate base64-encoded size of data, including NULL terminator. org_size must be > 0 if unsigned.\n#define DEBUGGER_BASE64_ENCODED_SIZE(org_size) ((((org_size)-1)/3+1)*4 +1)\n\nDEBUGGER_COMMAND(Debugger::status)\n{\n\tif (aArgCount)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tchar *status;\n\tswitch (mInternalState)\n\t{\n\tcase DIS_Starting:\tstatus = \"starting\";\tbreak;\n\tcase DIS_Break:\t\tstatus = \"break\";\t\tbreak;\n\tdefault:\t\t\tstatus = \"running\";\n\t}\n\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"status\\\" status=\\\"%s\\\" reason=\\\"ok\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t, status, aTransactionId);\n}\n\nDEBUGGER_COMMAND(Debugger::feature_get)\n{\n\t// feature_get accepts exactly one arg: -n feature_name.\n\tif (aArgCount != 1 || ArgChar(aArgV, 0) != 'n')\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tchar *feature_name = ArgValue(aArgV, 0);\n\n\tbool supported = false; // Is %feature_name% a supported feature string?\n\tchar *setting = \"\";\n\n\tif (!strncmp(feature_name, \"language_\", 9)) {\n\t\tif (!strcmp(feature_name + 9, \"supports_threads\"))\n\t\t\tsetting = \"0\";\n\t\telse if (!strcmp(feature_name + 9, \"name\"))\n\t\t\tsetting = DEBUGGER_LANG_NAME;\n\t\telse if (!strcmp(feature_name + 9, \"version\"))\n\t\t\tsetting = AHK_VERSION;\n\t} else if (!strcmp(feature_name, \"encoding\"))\n\t\tsetting = \"UTF-8\";\n\telse if (!strcmp(feature_name, \"protocol_version\")\n\t\t\t|| !strcmp(feature_name, \"supports_async\"))\n\t\tsetting = \"1\";\n\t// Not supported: data_encoding - assume base64.\n\t// Not supported: breakpoint_languages - assume only %language_name% is supported.\n\telse if (!strcmp(feature_name, \"breakpoint_types\"))\n\t\tsetting = \"line exception\";\n\telse if (!strcmp(feature_name, \"multiple_sessions\"))\n\t\tsetting = \"0\";\n\telse if (!strcmp(feature_name, \"max_data\"))\n\t\tsetting = _itoa(mMaxPropertyData, (char*)_alloca(MAX_INTEGER_SIZE), 10);\n\telse if (!strcmp(feature_name, \"max_children\"))\n\t\tsetting = _ultoa(mMaxChildren, (char*)_alloca(MAX_INTEGER_SIZE), 10);\n\telse if (!strcmp(feature_name, \"max_depth\"))\n\t\tsetting = _ultoa(mMaxDepth, (char*)_alloca(MAX_INTEGER_SIZE), 10);\n\t// TODO: STOPPING state for retrieving variable values, etc. after the script finishes, then implement supports_postmortem feature name. Requires debugger client support.\n\telse\n\t{\n\t\tfor (int i = 0; i < _countof(sCommands); ++i)\n\t\t{\n\t\t\tif (!strcmp(sCommands[i].mName, feature_name))\n\t\t\t{\n\t\t\t\tsupported = true;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\tif (*setting)\n\t\tsupported = true;\n\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"feature_get\\\" feature_name=\\\"%e\\\" supported=\\\"%i\\\" transaction_id=\\\"%e\\\">%s</response>\"\n\t\t, feature_name, (int)supported, aTransactionId, setting);\n}\n\nDEBUGGER_COMMAND(Debugger::feature_set)\n{\n\tchar arg, *value;\n\n\tchar *feature_name = NULL, *feature_value = NULL;\n\n\tfor (int i = 0; i < aArgCount; ++i)\n\t{\n\t\targ = ArgChar(aArgV, i);\n\t\tvalue = ArgValue(aArgV, i);\n\t\tswitch (arg)\n\t\t{\n\t\tcase 'n': feature_name = value; break;\n\t\tcase 'v': feature_value = value; break;\n\t\tdefault:\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t}\n\t}\n\n\tif (!feature_name || !feature_value)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tbool success = false;\n\n\t// Since all supported features are positive integers:\n\tint ival = atoi(feature_value);\n\tif (ival < 0)\n\t{\n\t\t// Since this value is invalid, return success=\"0\" to indicate the error.\n\t\t// Setting the feature to a negative value might cause instability elsewhere.\n\t}\n\telse if (success = !strcmp(feature_name, \"max_data\"))\n\t{\n\t\tif (ival == 0) // Although this isn't in the spec, at least one IDE relies on it.\n\t\t\tival = INT_MAX; // Strictly following the spec, we should probably return 0 bytes of data.\n\t\tmMaxPropertyData = ival;\n\t}\n\telse if (success = !strcmp(feature_name, \"max_children\"))\n\t\tmMaxChildren = ival;\n\telse if (success = !strcmp(feature_name, \"max_depth\"))\n\t\tmMaxDepth = ival;\n\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"feature_set\\\" feature=\\\"%e\\\" success=\\\"%i\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t, feature_name, (int)success, aTransactionId);\n}\n\nDEBUGGER_COMMAND(Debugger::run)\n{\n\treturn run_step(aArgV, aArgCount, aTransactionId, \"run\", DIS_Run);\n}\n\nDEBUGGER_COMMAND(Debugger::step_into)\n{\n\treturn run_step(aArgV, aArgCount, aTransactionId, \"step_into\", DIS_StepInto);\n}\n\nDEBUGGER_COMMAND(Debugger::step_over)\n{\n\treturn run_step(aArgV, aArgCount, aTransactionId, \"step_over\", DIS_StepOver);\n}\n\nDEBUGGER_COMMAND(Debugger::step_out)\n{\n\treturn run_step(aArgV, aArgCount, aTransactionId, \"step_out\", DIS_StepOut);\n}\n\nint Debugger::run_step(char **aArgV, int aArgCount, char *aTransactionId, char *aCommandName, DebuggerInternalStateType aNewState)\n{\n\tif (aArgCount)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\n\tif (mInternalState != DIS_Break)\n\t\treturn DEBUGGER_E_COMMAND_UNAVAIL;\n\n\tmInternalState = aNewState;\n\tmContinuationDepth = mStack.Depth();\n\tmContinuationTransactionId = aTransactionId;\n\t\n\t// Response will be sent when the debugger breaks.\n\treturn DEBUGGER_E_CONTINUE;\n}\n\nDEBUGGER_COMMAND(Debugger::_break)\n{\n\tif (aArgCount)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\tif (int err = EnterBreakState())\n\t\treturn err;\n\treturn DEBUGGER_E_OK;\n}\n\nDEBUGGER_COMMAND(Debugger::stop)\n{\n\tmContinuationTransactionId = aTransactionId;\n\n\t// Call g_script.TerminateApp instead of g_script.ExitApp to bypass OnExit function.\n\tg_script.TerminateApp(EXIT_EXIT, 0); // This also causes this->Exit() to be called.\n\t\n\t// Should never be reached, but must be here to avoid a compile error:\n\treturn DEBUGGER_E_INTERNAL_ERROR;\n}\n\nDEBUGGER_COMMAND(Debugger::detach)\n{\n\tmContinuationTransactionId = aTransactionId; // Seems more appropriate than using the previous ID (if any).\n\t// User wants to stop the debugger but let the script keep running.\n\tExit(EXIT_NONE, \"detach\"); // Anything but EXIT_ERROR. Sends \"stopped\" response, then disconnects.\n\treturn DEBUGGER_E_CONTINUE; // Response already sent.\n}\n\nDEBUGGER_COMMAND(Debugger::breakpoint_set)\n{\n\tchar arg, *value;\n\t\n\tchar *type = NULL, state = BS_Enabled, *filename = NULL;\n\tLineNumberType lineno = 0;\n\tbool temporary = false;\n\n\tfor (int i = 0; i < aArgCount; ++i)\n\t{\n\t\targ = ArgChar(aArgV, i);\n\t\tvalue = ArgValue(aArgV, i);\n\t\tswitch (arg)\n\t\t{\n\t\tcase 't': // type = line | call | return | exception | conditional | watch\n\t\t\ttype = value;\n\t\t\tbreak;\n\n\t\tcase 's': // state = enabled | disabled\n\t\t\tif (!strcmp(value, \"enabled\"))\n\t\t\t\tstate = BS_Enabled;\n\t\t\telse if (!strcmp(value, \"disabled\"))\n\t\t\t\tstate = BS_Disabled;\n\t\t\telse\n\t\t\t\treturn DEBUGGER_E_BREAKPOINT_STATE;\n\t\t\tbreak;\n\n\t\tcase 'f': // filename\n\t\t\tfilename = value;\n\t\t\tbreak;\n\n\t\tcase 'n': // lineno\n\t\t\tlineno = strtoul(value, NULL, 10);\n\t\t\tbreak;\n\n\t\tcase 'r': // temporary = 0 | 1\n\t\t\ttemporary = (*value != '0');\n\t\t\tbreak;\n\t\t\t\n\t\tcase 'x': // exception\n\t\t\tif (!stricmp(value, \"Any\")) // Require this or nothing, for now.\n\t\t\t\tbreak;\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\t\tcase 'm': // function\n\t\tcase 'h': // hit_value\n\t\tcase 'o': // hit_condition = >= | == | %\n\t\tcase '-': // expression for conditional breakpoints\n\t\t\t// These aren't used/supported.\n\t\tdefault:\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t}\n\t}\n\n\t// Breakpoint type is required according to the spec, but allowing it to be omitted\n\t// and defaulting to \"line\" is more convenient for debugging the debugger via console.\n\tif (type && strcmp(type, \"line\")) // i.e. type was specified and is not \"line\".\n\t{\n\t\tif (!strcmp(type, \"exception\") && lineno == 0 && !filename)\n\t\t{\n\t\t\tmBreakOnException.state = state;\n\t\t\tmBreakOnException.temporary = temporary;\n\t\t\t\n\t\t\treturn mResponseBuf.WriteF(\n\t\t\t\t\"<response command=\\\"breakpoint_set\\\" transaction_id=\\\"%e\\\" state=\\\"%s\\\" id=\\\"%i\\\"/>\"\n\t\t\t\t, aTransactionId, state ? \"enabled\" : \"disabled\", mBreakOnException.id);\n\t\t}\n\t\treturn DEBUGGER_E_BREAKPOINT_TYPE;\n\t}\n\tif (lineno < 1)\n\t\treturn DEBUGGER_E_BREAKPOINT_INVALID;\n\n\tint file_index = 0;\n\n\tif (filename)\n\t{\n\t\t// Decode filename URI -> path, in-place.\n\t\tDecodeURI(filename);\n\t\tCStringTCharFromUTF8 filename_t(filename);\n\n\t\t// Find the specified source file.\n\t\tfor (file_index = 0; file_index < Line::sSourceFileCount; ++file_index)\n\t\t\tif (!_tcsicmp(filename_t, Line::sSourceFile[file_index]))\n\t\t\t\tbreak;\n\n\t\tif (file_index >= Line::sSourceFileCount)\n\t\t\treturn DEBUGGER_E_BREAKPOINT_INVALID;\n\t}\n\n\tif (auto line = FindFirstLineForBreakpoint(file_index, lineno))\n\t{\n\t\tBreakpoint *bp = line->mBreakpoint;\n\t\tif (!bp)\n\t\t{\n\t\t\tbp = CreateBreakpoint();\n\t\t\tbp->line = line;\n\t\t\tSetBreakpointForLineGroup(line, bp);\n\t\t}\n\t\tbp->state = state;\n\t\tbp->temporary = temporary;\n\n\t\treturn mResponseBuf.WriteF(\n\t\t\t\"<response command=\\\"breakpoint_set\\\" transaction_id=\\\"%e\\\" state=\\\"%s\\\" id=\\\"%i\\\"/>\"\n\t\t\t, aTransactionId, state ? \"enabled\" : \"disabled\", bp->id);\n\t}\n\t// There are no lines of code beginning at or after lineno.\n\treturn DEBUGGER_E_BREAKPOINT_INVALID;\n}\n\nint Debugger::WriteBreakpointXml(Breakpoint *aBreakpoint)\n{\n\tif (aBreakpoint->type == BT_Exception)\n\t\treturn mResponseBuf.WriteF(\"<breakpoint id=\\\"%i\\\" type=\\\"exception\\\" state=\\\"%s\\\" exception=\\\"Any\\\"/>\"\n\t\t\t, aBreakpoint->id, aBreakpoint->state == BS_Enabled ? \"enabled\" : \"disabled\");\n\treturn mResponseBuf.WriteF(\"<breakpoint id=\\\"%i\\\" type=\\\"line\\\" state=\\\"%s\\\" filename=\\\"%r\\\" lineno=\\\"%u\\\"/>\"\n\t\t, aBreakpoint->id, aBreakpoint->state ? \"enabled\" : \"disabled\"\n\t\t, Line::sSourceFile[aBreakpoint->line->mFileIndex], aBreakpoint->line->mLineNumber);\n}\n\nDEBUGGER_COMMAND(Debugger::breakpoint_get)\n{\n\t// breakpoint_get accepts exactly one arg: -d breakpoint_id.\n\tif (aArgCount != 1 || ArgChar(aArgV, 0) != 'd')\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tint breakpoint_id = atoi(ArgValue(aArgV, 0));\n\n\tfor (auto bp = mFirstBreakpoint; bp; bp = bp->next)\n\t{\n\t\tif (bp->id == breakpoint_id)\n\t\t{\n\t\t\tmResponseBuf.WriteF(\"<response command=\\\"breakpoint_get\\\" transaction_id=\\\"%e\\\">\", aTransactionId);\n\t\t\tWriteBreakpointXml(bp);\n\t\t\tmResponseBuf.Write(\"</response>\");\n\n\t\t\treturn DEBUGGER_E_OK;\n\t\t}\n\t}\n\n\treturn DEBUGGER_E_BREAKPOINT_NOT_FOUND;\n}\n\nDEBUGGER_COMMAND(Debugger::breakpoint_update)\n{\n\tchar arg, *value;\n\t\n\tint breakpoint_id = -1;\n\tLineNumberType lineno = 0;\n\tchar state = -1;\n\n\tfor (int i = 0; i < aArgCount; ++i)\n\t{\n\t\targ = ArgChar(aArgV, i);\n\t\tvalue = ArgValue(aArgV, i);\n\t\tswitch (arg)\n\t\t{\n\t\tcase 'd':\n\t\t\tif (!cisdigit(*value))\n\t\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t\tbreakpoint_id = atoi(value);\n\t\t\tbreak;\n\n\t\tcase 's':\n\t\t\tif (!strcmp(value, \"enabled\"))\n\t\t\t\tstate = BS_Enabled;\n\t\t\telse if (!strcmp(value, \"disabled\"))\n\t\t\t\tstate = BS_Disabled;\n\t\t\telse\n\t\t\t\treturn DEBUGGER_E_BREAKPOINT_STATE;\n\t\t\tbreak;\n\n\t\tcase 'n':\n\t\t\tlineno = strtoul(value, NULL, 10);\n\t\t\tbreak;\n\n\t\tcase 'h': // hit_value\n\t\tcase 'o': // hit_condition\n\t\t\t// These aren't used/supported, but ignored for now.\n\t\t\tbreak;\n\n\t\tdefault:\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t}\n\t}\n\n\tfor (auto bp = mFirstBreakpoint; bp; bp = bp->next)\n\t{\n\t\tif (bp->id == breakpoint_id)\n\t\t{\n\t\t\tif (lineno && !bp->line)\n\t\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\t\t\tif (lineno && bp->line->mLineNumber != lineno)\n\t\t\t{\n\t\t\t\t// Move the breakpoint within its current file.\n\t\t\t\tLine *new_line = FindFirstLineForBreakpoint(bp->line->mFileIndex, lineno);\n\t\t\t\tif (new_line != bp->line)\n\t\t\t\t{\n\t\t\t\t\tif (!new_line)\n\t\t\t\t\t\treturn DEBUGGER_E_BREAKPOINT_INVALID;\n\t\t\t\t\tSetBreakpointForLineGroup(bp->line, nullptr);\n\t\t\t\t\tSetBreakpointForLineGroup(new_line, bp);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (state != -1)\n\t\t\t\tbp->state = state;\n\n\t\t\treturn DEBUGGER_E_OK;\n\t\t}\n\t}\n\n\treturn DEBUGGER_E_BREAKPOINT_NOT_FOUND;\n}\n\nDEBUGGER_COMMAND(Debugger::breakpoint_remove)\n{\n\t// breakpoint_remove accepts exactly one arg: -d breakpoint_id.\n\tif (aArgCount != 1 || ArgChar(aArgV, 0) != 'd')\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tauto arg = ArgValue(aArgV, 0);\n\tif (!cisdigit(*arg)) // Don't interpret empty/non-numeric values as ID 0.\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\tint breakpoint_id = atoi(arg);\n\t\n\tif (breakpoint_id == mBreakOnException.id)\n\t{\n\t\tmBreakOnException.state = BS_Disabled;\n\t\treturn DEBUGGER_E_OK;\n\t}\n\n\t// mFirstBreakpoint itself is currently always &mBreakOnException.\n\tfor (auto bp = mFirstBreakpoint->next; bp; bp = bp->next)\n\t{\n\t\tif (bp->id == breakpoint_id)\n\t\t{\n\t\t\tSetBreakpointForLineGroup(bp->line, nullptr);\n\t\t\tDeleteBreakpoint(bp);\n\t\t\treturn DEBUGGER_E_OK;\n\t\t}\n\t}\n\n\treturn DEBUGGER_E_BREAKPOINT_NOT_FOUND;\n}\n\nDEBUGGER_COMMAND(Debugger::breakpoint_list)\n{\n\tif (aArgCount)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\n\tmResponseBuf.WriteF(\"<response command=\\\"breakpoint_list\\\" transaction_id=\\\"%e\\\">\", aTransactionId);\n\t\n\tfor (auto bp = mFirstBreakpoint->state ? mFirstBreakpoint : mFirstBreakpoint->next; bp; bp = bp->next)\n\t\tWriteBreakpointXml(bp);\n\n\treturn mResponseBuf.Write(\"</response>\");\n}\n\nDEBUGGER_COMMAND(Debugger::stack_depth)\n{\n\tif (aArgCount)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"stack_depth\\\" depth=\\\"%i\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t, mStack.Depth(), aTransactionId);\n}\n\nDEBUGGER_COMMAND(Debugger::stack_get)\n{\n\tint depth = -1;\n\n\tif (aArgCount)\n\t{\n\t\t// stack_get accepts one optional arg: -d depth.\n\t\tif (aArgCount > 1 || ArgChar(aArgV, 0) != 'd')\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\tdepth = atoi(ArgValue(aArgV, 0));\n\t\tif (depth < 0 || depth >= mStack.Depth())\n\t\t\treturn DEBUGGER_E_INVALID_STACK_DEPTH;\n\t}\n\n\tmResponseBuf.WriteF(\"<response command=\\\"stack_get\\\" transaction_id=\\\"%e\\\">\", aTransactionId);\n\t\n\tint level = 0;\n\tDbgStack::Entry *se;\n\tfor (se = mStack.mTop; se >= mStack.mBottom; --se)\n\t{\n\t\tif (depth == -1 || depth == level)\n\t\t{\n\t\t\tLine *line;\n\t\t\tif (se == mStack.mTop)\n\t\t\t{\n\t\t\t\tASSERT(mCurrLine); // Should always be valid.\n\t\t\t\tline = mCurrLine; // See PreExecLine() for comments.\n\t\t\t}\n\t\t\telse if (se->type == DbgStack::SE_Thread)\n\t\t\t{\n\t\t\t\t// !se->line implies se->type == SE_Thread.\n\t\t\t\tif (se->desc != g_AutoExecuteThreadDesc && se[1].type == DbgStack::SE_UDF)\n\t\t\t\t\t// Show the function's jump-to line since se->line is most likely whatever line\n\t\t\t\t\t// this thread interrupted. Don't do it for the auto-execute thread since in\n\t\t\t\t\t// that case the function doesn't represent the thread's overall execution.\n\t\t\t\t\tline = se[1].udf->func->mJumpToLine;\n\t\t\t\telse\n\t\t\t\t\t// The auto-execute thread is probably the only one that can exist without\n\t\t\t\t\t// a Sub or Func entry immediately above it. As se != mStack.mTop, se->line\n\t\t\t\t\t// has been set to a non-NULL by DbgStack::Push().\n\t\t\t\t\tline = se->line;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tline = se->line;\n\t\t\t}\n\t\t\tmResponseBuf.WriteF(\"<stack level=\\\"%i\\\" type=\\\"file\\\" filename=\\\"%r\\\" lineno=\\\"%u\\\" where=\\\"\"\n\t\t\t\t, level, Line::sSourceFile[line->mFileIndex], line->mLineNumber);\n\t\t\tswitch (se->type)\n\t\t\t{\n\t\t\tcase DbgStack::SE_Thread:\n\t\t\t\tmResponseBuf.WriteF(\"%e thread\", U4T(se->desc)); // %e to escape characters which desc may contain (e.g. \"a & b\" in hotkey name).\n\t\t\t\tbreak;\n\t\t\tcase DbgStack::SE_UDF:\n\t\t\t\tmResponseBuf.WriteF(\"%e()\", U4T(se->udf->func->mName));\n\t\t\t\tbreak;\n\t\t\tcase DbgStack::SE_BIF:\n\t\t\t\tmResponseBuf.WriteF(\"%e()\", U4T(se->func->mName));\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tmResponseBuf.Write(\"\\\"/>\");\n\t\t}\n\t\t++level;\n\t}\n\n\treturn mResponseBuf.Write(\"</response>\");\n}\n\nDEBUGGER_COMMAND(Debugger::context_names)\n{\n\tif (aArgCount)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"context_names\\\" transaction_id=\\\"%e\\\"><context name=\\\"Local\\\" id=\\\"0\\\"/><context name=\\\"Global\\\" id=\\\"1\\\"/></response>\"\n\t\t, aTransactionId);\n}\n\nDEBUGGER_COMMAND(Debugger::context_get)\n{\n\tint err = DEBUGGER_E_OK;\n\tchar arg, *value;\n\n\tint context_id = 0, depth = 0;\n\n\tfor (int i = 0; i < aArgCount; ++i)\n\t{\n\t\targ = ArgChar(aArgV, i);\n\t\tvalue = ArgValue(aArgV, i);\n\t\tswitch (arg)\n\t\t{\n\t\tcase 'c':\tcontext_id = atoi(value);\tbreak;\n\t\tcase 'd':\n\t\t\tdepth = atoi(value);\n\t\t\tif (depth && (depth < 0 || depth >= mStack.Depth())) // Allow depth 0 even when stack is empty.\n\t\t\t\treturn DEBUGGER_E_INVALID_STACK_DEPTH;\n\t\t\tbreak;\n\t\tdefault:\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t}\n\t}\n\n\t// Two lists are used to support static and non-static variables, both of which\n\t// are seen to be in \"local\" context, since they are in the same namespace (and\n\t// it never makes sense to have a static and non-static with the same name).\n\t// Non-static variables are expected to be used more often, so are listed first.\n\tVarList *var_lists[2] = { nullptr, nullptr };\n\tVarBkp *bkp = NULL, *bkp_end = NULL;\n\t\n\tif (context_id == PC_Local)\n\t\tmStack.GetLocalVars(depth, var_lists[0], var_lists[1], bkp, bkp_end);\n\telse if (context_id == PC_Global)\n\t\tvar_lists[0] = g_script.GlobalVars();\n\telse\n\t\treturn DEBUGGER_E_INVALID_CONTEXT;\n\n\tmResponseBuf.WriteF(\n\t\t\"<response command=\\\"context_get\\\" context=\\\"%i\\\" transaction_id=\\\"%e\\\">\"\n\t\t, context_id, aTransactionId);\n\n\tTCHAR value_buf[_f_retval_buf_size];\n\tCStringA name_buf;\n\tPropertyInfo prop(name_buf, value_buf);\n\tprop.max_data = mMaxPropertyData;\n\tprop.pagesize = mMaxChildren;\n\tprop.max_depth = mMaxDepth;\n\tfor ( ; bkp < bkp_end; ++bkp)\n\t\tif (bkp->mType != VAR_CONSTANT) // Exclude closures.\n\t\t\tif ( (err = GetPropertyInfo(*bkp, prop))\n\t\t\t\t|| (err = WritePropertyXml(prop, bkp->mVar->mName)) )\n\t\t\t\tbreak;\n\tfor (int j = 0; j < _countof(var_lists); ++j)\n\t{\n\t\tif (!var_lists[j])\n\t\t\tcontinue;\n\t\tVar **vars = var_lists[j]->mItem;\n\t\tint var_count = var_lists[j]->mCount;\n\t\tfor (int i = 0; i < var_count; ++i)\n\t\t\tif (vars[i]->mType != VAR_CONSTANT || context_id != PC_Local) // Exclude closures.\n\t\t\t\tif ( (err = GetPropertyInfo(*vars[i], prop))\n\t\t\t\t\t|| (err = WritePropertyXml(prop, vars[i]->mName)) )\n\t\t\t\t\tbreak;\n\t}\n\tif (err)\n\t\treturn err;\n\n\treturn mResponseBuf.Write(\"</response>\");\n}\n\nDEBUGGER_COMMAND(Debugger::typemap_get)\n{\n\tif (aArgCount)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"typemap_get\\\" transaction_id=\\\"%e\\\" xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\">\"\n\t\t\t\"<map type=\\\"string\\\" name=\\\"string\\\" xsi:type=\\\"xsd:string\\\"/>\"\n\t\t\t\"<map type=\\\"int\\\" name=\\\"integer\\\" xsi:type=\\\"xsd:long\\\"/>\"\n\t\t\t\"<map type=\\\"float\\\" name=\\\"float\\\" xsi:type=\\\"xsd:double\\\"/>\"\n\t\t\t\"<map type=\\\"object\\\" name=\\\"object\\\"/>\"\n\t\t\"</response>\"\n\t\t, aTransactionId);\n}\n\nDEBUGGER_COMMAND(Debugger::property_get)\n{\n\treturn property_get_or_value(aArgV, aArgCount, aTransactionId, true);\n}\n\nDEBUGGER_COMMAND(Debugger::property_value)\n{\n\treturn property_get_or_value(aArgV, aArgCount, aTransactionId, false);\n}\n\n\nint Debugger::GetPropertyInfo(Var &aVar, PropertyInfo &aProp)\n{\n\taProp.is_alias = aVar.mType == VAR_ALIAS;\n\taProp.is_static = aVar.IsStatic();\n\taProp.is_builtin = aVar.mType == VAR_VIRTUAL;\n\taProp.kind = PropValue;\n\taProp.invokee = nullptr;\n\treturn GetPropertyValue(aVar, aProp.value);\n}\n\nint Debugger::GetPropertyInfo(VarBkp &aBkp, PropertyInfo &aProp)\n{\n\tVar temp; // Never freed, as that would invalidate aBkp.\n\ttemp.Restore(aBkp);\n\treturn GetPropertyInfo(temp, aProp);\n}\n\nint Debugger::GetPropertyValue(Var &aVar, ResultToken &aValue)\n{\n\taValue.Free();\n\taValue.InitResult(aValue.buf);\n\taVar.Get(aValue);\n\treturn aValue.Exited() ? DEBUGGER_E_EVAL_FAIL : DEBUGGER_E_OK;\n}\n\nint Debugger::GetPropertyValue(VarBkp &aBkp, ResultToken &aValue)\n{\n\tVar temp; // Never freed, as that would invalidate aBkp.\n\ttemp.Restore(aBkp);\n\treturn GetPropertyValue(temp, aValue);\n}\n\n\nint Debugger::WritePropertyObjectXml(PropertyInfo &aProp)\n{\n\tASSERT(aProp.value.symbol == SYM_OBJECT || aProp.invokee);\n\tif (!aProp.invokee)\n\t\taProp.invokee = aProp.value.object;\n\tPropertyWriter pw(*this, aProp);\n\t// Write out the object's properties.\n\tObject *defs;\n\tif (aProp.invokee->IsOfType(Object::sPrototype))\n\t\tdefs = static_cast<Object*>(aProp.invokee);\n\telse\n\t\tdefs = aProp.invokee->Base();\n\tdefs->DebugWriteProperty(&pw, aProp.page, aProp.pagesize, aProp.max_depth);\n\taProp.fullname.Truncate(pw.mNameLength);\n\t// For simplicity/code size, instead of requiring error handling in aObject,\n\t// any failure during the above sets pw.mError, which causes it to ignore\n\t// any further method calls. Since we're finished now, return the error\n\t// code (even if it's \"OK\"):\n\treturn pw.mError;\n}\n\n\nvoid Object::DebugWriteProperty(IDebugProperties *aDebugger, int aPage, int aPageSize, int aDepth)\n{\n\tauto enum_method = IsClassPrototype() ? nullptr : GetMethod(_T(\"__Enum\"));\n\tint num_children = (int)mFields.Length() + (mBase != nullptr) + (enum_method != nullptr);\n\n\tDebugCookie cookie;\n\taDebugger->BeginProperty(NULL, \"object\", num_children, cookie);\n\n\tif (aDepth > 0)\n\t{\n\t\tauto props = new PropEnum(this, aDebugger->ThisToken());\n\t\tVar vname, vval;\n\n\t\tint page_start = aPageSize * aPage, page_end = aPageSize * (aPage + 1);\n\t\tint i = 0;\n\n\t\tif (mBase)\n\t\t{\n\t\t\t// Since this object has a \"base\", let it count as the first field.\n\t\t\tif (page_start == 0) // i.e. this is the first page.\n\t\t\t\taDebugger->WriteBaseProperty(mBase);\n\t\t\ti++; // Count it even if it wasn't within the current page.\n\t\t}\n\n\t\t// For each field NOT in the requested page...\n\t\tfor (; i < page_start && props->Next(nullptr, nullptr) == CONDITION_TRUE; ++i);\n\n\t\t// For each field in the requested page...\n\t\tfor (; i < page_end; ++i)\n\t\t{\n\t\t\tauto result = props->Next(&vname, &vval);\n\t\t\tif (result == CONDITION_FALSE)\n\t\t\t\tbreak;\n\t\t\tExprTokenType value;\n\t\t\tif (result == CONDITION_TRUE)\n\t\t\t\tvval.ToTokenSkipAddRef(value);\n\t\t\telse // For PropEnum, this means a property was enumerated but its getter failed/exited.\n\t\t\t\tvalue.SetValue(_T(\"<error>\"), 7);\n\t\t\taDebugger->WriteProperty(vname.Contents(), value);\n\t\t}\n\n\t\tvname.Free();\n\t\tvval.Free();\n\n\t\tif (enum_method && i < page_end)\n\t\t{\n\t\t\tif (dynamic_cast<NativeFunc *>(enum_method))\n\t\t\t{\n\t\t\t\t// Built-in enumerators are always safe to call automatically.\n\t\t\t\taDebugger->WriteEnumItems(this, page_start - i, page_end - i);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tDebugCookie cookie;\n\t\t\t\t// Write an empty property; enumerate only on property_get.\n\t\t\t\taDebugger->BeginProperty(\"<enum>\", \"object\", 1, cookie);\n\t\t\t\taDebugger->EndProperty(cookie);\n\t\t\t}\n\t\t}\n\n\t\tprops->Release();\n\t}\n\n\taDebugger->EndProperty(cookie);\n}\n\n\nint Debugger::WriteEnumItems(PropertyInfo &aProp)\n{\n\taProp.facet = \"\";\n\tPropertyWriter pw(*this, aProp);\n\tint start = aProp.page * aProp.pagesize;\n\tpw.WriteEnumItems(aProp.invokee, start, start + aProp.pagesize);\n\treturn pw.mError;\n}\n\nvoid Debugger::PropertyWriter::WriteEnumItems(IObject *aEnumerable, int aStart, int aEnd)\n{\n\tIObject *enumerator;\n\tauto result = GetEnumerator(enumerator, ExprTokenType(aEnumerable), 2, false);\n\tif (result != OK)\n\t{\n\t\t// Just return no items, since setting an error would prevent any other properties\n\t\t// from being returned. For context_get in particular, one bad __Enum could break\n\t\t// the client's ability to list variables.\n\t\t//mError = DEBUGGER_E_EVAL_FAIL;\n\t\treturn;\n\t}\n\tif (enumerator == aEnumerable) // Only valid when result == OK.\n\t{\n\t\t// No __Enum method, so Object::DebugWriteProperty wouldn't have returned <enum>.\n\t\t// CallEnumerator could succeed for `f.<enum>` if `f` is an enumerator function,\n\t\t// but proceeding would generally put the enumerator in a state where subsequent\n\t\t// calls by the debugger or script return nothing. Prohibiting this also ensures\n\t\t// we don't return a <property> for any arbitrary non-enumerable value.\n\t\tenumerator->Release();\n\t\treturn;\n\t}\n\n\tDebugCookie cookie;\n\tbool write_main_property = !mDepth;\n\tif (write_main_property)\n\t{\n\t\tif (mProp.kind == PropEnum)\n\t\t\tmProp.invokee = enumerator;\n\t\tBeginProperty(nullptr, \"object\", 1, cookie);\n\t}\n\t\n\tif (mProp.max_depth)\n\t{\n\t\tauto vkey = new VarRef(), vval = new VarRef();\n\t\tExprTokenType tparam[] = { vkey, vval }, *param[] = { tparam, tparam + 1 };\n\t\tfor (int i = 0; i < aEnd; ++i)\n\t\t{\n\t\t\tresult = CallEnumerator(enumerator, param, 2, false);\n\t\t\tif (result != CONDITION_TRUE)\n\t\t\t\tbreak;\n\t\t\tif (i >= aStart)\n\t\t\t{\n\t\t\t\tExprTokenType tkey, tval;\n\t\t\t\tvkey->ToTokenSkipAddRef(tkey);\n\t\t\t\tvval->ToTokenSkipAddRef(tval);\n\t\t\t\tWriteProperty(tkey, tval);\n\t\t\t}\n\t\t}\n\t\tvkey->Release();\n\t\tvval->Release();\n\t}\n\n\tif (write_main_property)\n\t\tEndProperty(cookie);\n\n\tenumerator->Release();\n}\n\nint Debugger::WritePropertyXml(PropertyInfo &aProp)\n{\n\tchar facetbuf[32]; // Alias Builtin Static\n\tfacetbuf[0] = '\\0';\n\tif (aProp.is_alias)\n\t\tstrcat(facetbuf, \" Alias\");\n\tif (aProp.is_builtin)\n\t\tstrcat(facetbuf, \" Builtin\");\n\tif (aProp.is_static)\n\t\tstrcat(facetbuf, \" Static\");\n\taProp.facet = facetbuf + (*facetbuf != '\\0'); // Skip the leading space, if non-empty.\n\n\tASSERT(aProp.kind != PropEnum);\n\tif (aProp.value.symbol == SYM_OBJECT || aProp.invokee) // An object or `primitive.<base>`\n\t\treturn WritePropertyObjectXml(aProp);\n\n\tchar *type;\n\tswitch (aProp.value.symbol)\n\t{\n\tcase SYM_STRING: type = \"string\"; break;\n\tcase SYM_INTEGER: type = \"integer\"; break;\n\tcase SYM_FLOAT: type = \"float\"; break;\n\n\tdefault:\n\t\t// Catch SYM_VAR or any invalid symbol in debug mode. In release mode, treat as undefined\n\t\t// (the compiler can omit the SYM_MISSING check because the default branch covers it).\n\t\tASSERT(FALSE);\n\tcase SYM_MISSING:\n\t\ttype = \"undefined\";\n\t}\n\t// If we fell through, value and type have been set appropriately above.\n\tmResponseBuf.WriteF(\"<property name=\\\"%e\\\" fullname=\\\"%e\\\" type=\\\"%s\\\" facet=\\\"%s\\\" children=\\\"0\\\" encoding=\\\"base64\\\" size=\\\"\"\n\t\t, aProp.name, aProp.fullname.GetString(), type, aProp.facet);\n\tint err;\n\tif (err = WritePropertyData(aProp.value, aProp.max_data))\n\t\treturn err;\n\treturn mResponseBuf.Write(\"</property>\");\n}\n\nint Debugger::WritePropertyXml(PropertyInfo &aProp, LPTSTR aName)\n{\n\tStringTCharToUTF8(aName, aProp.fullname);\n\taProp.name = aProp.fullname;\n\treturn WritePropertyXml(aProp);\n}\n\nvoid Debugger::AppendPropertyName(CStringA &aNameBuf, size_t aParentNameLength, const char *aName)\n{\n\t// Property names are almost always valid identifiers, but even most invalid names\n\t// should work as long as '.' and '[' are not used. Supporting those does not seem\n\t// worth any added code size.\n\taNameBuf.AppendFormat(\".%s\", aName);\n}\n\nvoid Debugger::AppendStringKey(CStringA &aNameBuf, size_t aParentNameLength, const char *aName)\n{\n\t// \" must be escape in some way to remove ambiguity. Currently the v1 method is used\n\t// since lexikos' version of SciTEDebug.ahk relies on it, and it isn't necessary to\n\t// match the v2 expression syntax.\n\tchar c;\n\tconst char *ccp;\n\tint extra = 4; // 4 for [\"\"]. Also count double-quote marks:\n\tfor (ccp = aName; *ccp; ++ccp) extra += *ccp=='\"';\n\tchar *cp = aNameBuf.GetBufferSetLength(aParentNameLength + strlen(aName) + extra) + aParentNameLength;\n\t*cp++ = '[';\n\t*cp++ = '\"';\n\tfor (ccp = aName; c = *ccp; ++ccp)\n\t{\n\t\t*cp++ = c;\n\t\tif (c == '\"')\n\t\t\t*cp++ = '\"'; // i.e. replace \" with \"\"\n\t}\n\t*cp++ = '\"';\n\t*cp++ = ']';\n\taNameBuf.ReleaseBuffer();\n}\n\nint Debugger::WritePropertyData(LPCTSTR aData, size_t aDataSize, int aMaxEncodedSize)\n// Accepts a \"native\" string, converts it to UTF-8, base64-encodes it and writes\n// the end of the property's size attribute followed by the base64-encoded data.\n{\n\tint err;\n\t\n#ifdef UNICODE\n\tLPCWSTR utf16_value = aData;\n\tsize_t total_utf16_size = aDataSize;\n#else\n\t// ANSI mode. For simplicity, convert the entire data to UTF-16 rather than attempting to\n\t// calculate how much ANSI text will produce the right number of UTF-8 bytes (since UTF-16\n\t// is needed as an intermediate step anyway). This would fail if the string length exceeds\n\t// INT_MAX, but that would only matter if we built ANSI for x64 (and we don't).\n\tCStringWCharFromChar utf16_buf(aData, aDataSize);\n\tLPCWSTR utf16_value = utf16_buf.GetString();\n\tsize_t total_utf16_size = utf16_buf.GetLength();\n\tif (!total_utf16_size && aDataSize) // Conversion failed (too large?)\n\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n#endif\n\t\n\t// The spec says: \"The IDE should not read more data than the length defined in the packet\n\t// header. The IDE can determine if there is more data by using the property data length\n\t// information.\" This has two implications:\n\t// 1) The size attribute should represent the total size, not the amount of data actually\n\t// returned (when limited by aMaxEncodedSize). This is more useful anyway.\n\t// 2) Since the data is encoded as UTF-8, the size attribute must be a UTF-8 byte count\n\t// for any comparison by the IDE to give the correct result.\n\n\t// According to the spec, -m 0 should mean \"unlimited\".\n\tif (!aMaxEncodedSize)\n\t\taMaxEncodedSize = INT_MAX;\n\t\n\t// Calculate:\n\t// - the total size in terms of UTF-8 bytes (even if that exceeds INT_MAX).\n\tsize_t total_utf8_size = 0;\n\t// - the maximum number of wide chars to convert, taking aMaxEncodedSize into account.\n\tint utf16_size = (int)total_utf16_size;\n\t// - the required buffer size for conversion, in bytes.\n\tint utf8_size = -1;\n\n\tfor (size_t i = 0; i < total_utf16_size; ++i)\n\t{\n\t\twchar_t wc = utf16_value[i];\n\t\t\n\t\tint char_size;\n\t\tif (wc <= 0x007F)\n\t\t\tchar_size = 1;\n\t\telse if (wc <= 0x07FF)\n\t\t\tchar_size = 2;\n\t\telse if (IS_SURROGATE_PAIR(wc, utf16_value[i+1]))\n\t\t\tchar_size = 4;\n\t\telse\n\t\t\tchar_size = 3;\n\t\t\n\t\ttotal_utf8_size += char_size;\n\n\t\tif (total_utf8_size > (size_t)aMaxEncodedSize)\n\t\t{\n\t\t\tif (utf16_size == total_utf16_size) // i.e. this is the first surplus char.\n\t\t\t{\n\t\t\t\t// Truncate the input; utf16_value[i] and beyond will not be converted/sent.\n\t\t\t\tutf16_size = (int)i;\n\t\t\t\tutf8_size = (int)(total_utf8_size - char_size);\n\t\t\t}\n\t\t}\n\t}\n\tif (utf8_size == -1) // Data was not limited by aMaxEncodedSize.\n\t\tutf8_size = (int)total_utf8_size;\n\t\n\t// Calculate maximum length of base64-encoded data.\n\tint space_needed = DEBUGGER_BASE64_ENCODED_SIZE(utf8_size);\n\t\n\t// Reserve enough space for the data's length, \"> and encoded data.\n\tif (err = mResponseBuf.ExpandIfNecessary(mResponseBuf.mDataUsed + space_needed + MAX_INTEGER_LENGTH + 2))\n\t\treturn err;\n\t\n\t// Complete the size attribute by writing the total size, in terms of UTF-8 bytes.\n\tif (err = mResponseBuf.WriteF(\"%u\\\">\", total_utf8_size))\n\t\treturn err;\n\n\t// Convert to UTF-8, using mResponseBuf temporarily.\n\tchar *utf8_value = mResponseBuf.mData + mResponseBuf.mDataSize - space_needed;\n\tutf8_size = WideCharToMultiByte(CP_UTF8, 0, utf16_value, utf16_size, utf8_value, utf8_size, NULL, NULL);\n\tif (!utf8_size && utf16_size) // Conversion failed.\n\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\n\t// Base64-encode and write the var data.\n\treturn mResponseBuf.WriteEncodeBase64(utf8_value, (size_t)utf8_size, true);\n}\n\nint Debugger::WritePropertyData(ExprTokenType &aValue, int aMaxEncodedSize)\n{\n\tLPTSTR value;\n\tsize_t value_length;\n\tTCHAR number_buf[MAX_NUMBER_SIZE];\n\n\tvalue = TokenToString(aValue, number_buf, &value_length);\n\t\n\treturn WritePropertyData(value, value_length, aMaxEncodedSize);\n}\n\nint Debugger::ParsePropertyName(LPCSTR aFullName, int aDepth, int aVarScope, ExprTokenType *aSetValue\n\t, PropertySource &aResult)\n{\n\tCStringTCharFromUTF8 name_buf(aFullName);\n\treturn ParsePropertyName(name_buf.GetBuffer(), aDepth, aVarScope, aSetValue, aResult);\n}\n\nint Debugger::ParsePropertyName(LPWSTR aNamePtr, int aDepth, int aVarScope, ExprTokenType *aSetValue\n\t, PropertySource &aResult)\n{\n\tTCHAR c, *cp = aNamePtr, *cp_end;\n\t\n\tint err = DEBUGGER_E_OK;\n\tResultToken **temp = nullptr;\n\tint temp_size = 0, temp_count = 0;\n\tExprTokenType **param_buf = nullptr;\n\tint param_size = 0;\n\t\n\taResult.kind = PropNone;\n\n\tstruct Invocation\n\t{\n\t\tInvocation *outer = nullptr;\n\t\tResultToken *leftval = nullptr;\n\t\tIObject *invokee = nullptr;\n\t\tLPWSTR name = nullptr;\n\t\tint flags = 0, param_offset = 0;\n\t\tWCHAR end_char = '\\0';\n\t} root_inv, *inv = &root_inv;\n\n\t// Property names that aren't valid identifiers can be set via .%% or DefineProp.\n\t// Currently those aren't escaped in any way, so the following permits most characters,\n\t// and even the empty string. The <base> and <enum> sections rely on this permitting <>.\n\tconstexpr auto TERMINATORS = L\".,[]()\";\n\n\tfor (;;)\n\t{\n\t\tif (temp_count == temp_size)\n\t\t{\n\t\t\tauto new_size = temp_size ? temp_size * 2 : 64;\n\t\t\tauto new_temp = (ResultToken**)realloc(temp, new_size * sizeof(ResultToken*));\n\t\t\tif (!new_temp)\n\t\t\t{\n\t\t\t\terr = DEBUGGER_E_INTERNAL_ERROR;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\ttemp = new_temp;\n\t\t\ttemp_size = new_size;\n\t\t}\n\t\tauto &lastval = *(temp[temp_count++] = new (_alloca(sizeof(ResultToken))) ResultToken());\n\t\tlastval.InitResult(aResult.value.buf);\n\t\tcontinue_with_same_lastval:\n\n\t\tc = *cp;\n\t\tif (!c) // Checked after continue_with_same_lastval to avoid returning \"\" in some cases, such as `1,`\n\t\t{\n\t\t\terr = DEBUGGER_E_INVALID_OPTIONS;\n\t\t\tbreak;\n\t\t}\n\t\tif (!inv->leftval)\n\t\t{\n\t\t\tVar *var = nullptr;\n\t\t\tVarBkp *varbkp = nullptr;\n\n\t\t\tif (!_tcsnicmp(cp, _T(\"<exception>\"), 11))\n\t\t\t{\n\t\t\t\tif (!mThrownToken)\n\t\t\t\t{\n\t\t\t\t\terr = DEBUGGER_E_UNKNOWN_PROPERTY;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tcp += 11;\n\t\t\t\tif (!*cp)\n\t\t\t\t{\n\t\t\t\t\t// `property_get -n <exception>` is our non-standard way to retrieve the thrown value during an exception break.\n\t\t\t\t\t// `property_set -n <exception> --` is our non-standard way to \"clear the exception\" (suppress the error dialog).\n\t\t\t\t\tif (aSetValue)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (!TokenIsEmptyString(*aSetValue))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\terr = DEBUGGER_E_INVALID_OPTIONS;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tmThrownToken = nullptr;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tlastval.CopyValueFrom(*mThrownToken);\n\t\t\t}\n\t\t\telse if (cp_end = ParsePropertyKeyLiteral(cp, lastval))\n\t\t\t{\n\t\t\t\tcp = cp_end;\n\t\t\t}\n\t\t\telse if (IS_IDENTIFIER_CHAR(*cp))\n\t\t\t{\n\t\t\t\tauto name = cp;\n\t\t\t\tcp = find_identifier_end(cp + 1);\n\t\t\t\tauto name_length = cp - name;\n\t\t\t\tc = *cp;\n\t\t\t\t*cp = '\\0'; // Temporarily terminate.\n\n\t\t\t\tVarList *vars = nullptr;\n\t\t\t\tbool search_local = (aVarScope & VAR_LOCAL) && g->CurrentFunc;\n\t\t\t\tif (search_local && aDepth > 0)\n\t\t\t\t{\n\t\t\t\t\tVarList *static_vars = nullptr;\n\t\t\t\t\tVarBkp *bkps = nullptr, *bkps_end = nullptr;\n\t\t\t\t\tmStack.GetLocalVars(aDepth, vars, static_vars, bkps, bkps_end);\n\t\t\t\t\tfor (; bkps < bkps_end; ++bkps)\n\t\t\t\t\t\tif (!_tcsicmp(bkps->mVar->mName, name))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tvarbkp = bkps;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\tif (!varbkp && static_vars)\n\t\t\t\t\t\tvar = static_vars->Find(name);\n\t\t\t\t\t// If a var wasn't found above, make sure not to return a local var of the wrong function or depth.\n\t\t\t\t\tif (!var)\n\t\t\t\t\t\taVarScope = FINDVAR_GLOBAL;\n\t\t\t\t}\n\n\t\t\t\tif (!var && !varbkp)\n\t\t\t\t{\n\t\t\t\t\tint insert_pos;\n\t\t\t\t\tif (vars) // Use this first to support aDepth.\n\t\t\t\t\t\tvar = vars->Find(name, &insert_pos);\n\t\t\t\t\tif (!var) // Use FindVar to support built-ins and globals.\n\t\t\t\t\t\tvar = g_script.FindVar(name, name_length, aVarScope, &vars, &insert_pos);\n\t\t\t\t\tif (!var && aSetValue) // Avoid creating empty variables.\n\t\t\t\t\t\tvar = g_script.AddVar(name, name_length, vars, insert_pos\n\t\t\t\t\t\t\t, search_local ? VAR_LOCAL : VAR_GLOBAL);\n\t\t\t\t}\n\n\t\t\t\t*cp = c; // Undo temporary termination.\n\n\t\t\t\tif (!var && !varbkp)\n\t\t\t\t{\n\t\t\t\t\terr = DEBUGGER_E_UNKNOWN_PROPERTY;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tif (!c)\n\t\t\t\t{\n\t\t\t\t\t// Just a variable name.\n\t\t\t\t\tif (var)\n\t\t\t\t\t\taResult.var = var, aResult.kind = PropVar;\n\t\t\t\t\telse\n\t\t\t\t\t\taResult.bkp = varbkp, aResult.kind = PropVarBkp;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tif (varbkp && varbkp->mType == VAR_ALIAS)\n\t\t\t\t\tvar = varbkp->mAliasFor;\n\t\t\t\tif (var)\n\t\t\t\t\terr = GetPropertyValue(*var, lastval);\n\t\t\t\telse\n\t\t\t\t\terr = GetPropertyValue(*varbkp, lastval);\n\t\t\t}\n\t\t\telse if (inv->outer && (c == ',' || c == inv->end_char))\n\t\t\t{\n\t\t\t\t// Missing parameter or empty parameter list.\n\t\t\t\tlastval.symbol = SYM_MISSING;\n\t\t\t}\n\t\t\telse\n\t\t\t\tbreak; // Syntax error; err will be set due to *cp != 0.\n\n\t\t\tif (lastval.symbol == SYM_OBJECT && !var) // AddRef() was called only if var != nullptr.\n\t\t\t\tlastval.object->AddRef();\n\n\t\t\tc = *cp;\n\t\t\tif (!c)\n\t\t\t\tbreak; // lastval is the final result, in temp[temp_count-1].\n\t\t\tif (lastval.symbol == SYM_MISSING && !(c == ',' || c == inv->end_char))\n\t\t\t{\n\t\t\t\terr = DEBUGGER_E_UNKNOWN_PROPERTY;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tinv->leftval = &lastval;\n\t\t\tcontinue; // inv->leftval is a parameter or left-hand side of an invocation.\n\t\t}\n\t\t// Now inv->leftval has been set up with a value, and lastval is available to place a result into.\n\n\t\tif (!inv->invokee) // Initialize for a potential invocation.\n\t\t\tif (inv->leftval->symbol == SYM_OBJECT)\n\t\t\t{\n\t\t\t\tinv->invokee = inv->leftval->object;\n\t\t\t\tinv->flags = 0;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tinv->invokee = Object::ValueBase(*inv->leftval);\n\t\t\t\tinv->flags = IF_SUBSTITUTE_THIS;\n\t\t\t}\n\t\tASSERT(inv->invokee || inv->leftval->symbol == SYM_MISSING && (c == ',' || c == inv->end_char));\n\n\t\tfor (c = *cp; c == '.'; cp = cp_end)\n\t\t{\n\t\t\tfor (cp_end = ++cp; !_tcschr(TERMINATORS, c = *cp_end); ++cp_end);\n\t\t\t*cp_end = '\\0';\n\n\t\t\tif (!_tcsicmp(cp, _T(\"<base>\"))) // Debugger pseudo-property.\n\t\t\t{\n\t\t\t\t// x.<base> returns the base of x, but x.<base>.y invokes the version of y defined\n\t\t\t\t// by x.<base> but with `this` set to x (for property getters or methods).\n\t\t\t\tif (inv->flags != IF_SUBSTITUTE_THIS) // i.e. it's not already *implicitly* the value's base.\n\t\t\t\t\tinv->invokee = inv->invokee->Base();\n\t\t\t\tif (!inv->invokee) // Any.Prototype.<base> (potentially with a suffix)\n\t\t\t\t{\n\t\t\t\t\terr = DEBUGGER_E_UNKNOWN_PROPERTY;\n\t\t\t\t\tgoto break_outer;\n\t\t\t\t}\n\t\t\t\tinv->flags = IF_SUPER;\n\t\t\t}\n\t\t\telse if (!_tcsicmp(cp, _T(\"<enum>\"))) // Debugger pseudo-property.\n\t\t\t{\n\t\t\t\t// x.<enum>[1] invokes x[1], but caller knows to enumerate items when aResult.kind == PropEnum.\n\t\t\t\tif (!c)\n\t\t\t\t\taResult.kind = PropEnum;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tASSERT(!inv->name);\n\t\t\t\tinv->name = cp;\n\t\t\t\tcp = cp_end;\n\t\t\t\tbreak; // Break inner loop to invoke this property below.\n\t\t\t}\n\t\t} // for()\n\t\t// Due to potential null-termination of a property name above, must now use c instead of *cp.\n\t\t\n\t\tif (c == '[' && (cp[1] != ']' || !inv->name) || c == '(')\n\t\t{\n\t\t\tif (c == '(')\n\t\t\t\tinv->flags |= IT_CALL;\n\t\t\tauto new_inv = new (_alloca(sizeof(Invocation))) Invocation();\n\t\t\tnew_inv->end_char = c == '(' ? ')' : ']';\n\t\t\tnew_inv->param_offset = inv->param_offset;\n\t\t\tnew_inv->outer = inv;\n\t\t\tinv = new_inv;\n\t\t\tcp++;\n\t\t\tgoto continue_with_same_lastval;\n\t\t}\n\n\t\tExprTokenType **param = nullptr;\n\t\tint param_count = 0;\n\n\t\tif (!inv->name)\n\t\t{\n\t\t\t// name is null and '[' and '(' are not present, therefore inv->leftval is not being invoked.\n\t\t\tif (!c)\n\t\t\t{\n\t\t\t\t--temp_count;\n\t\t\t\tASSERT(temp[temp_count-1] == inv->leftval);\n\t\t\t\tbreak; // inv->leftval is the final result (lastval wasn't needed).\n\t\t\t}\n\t\t\t// leftval should be a parameter.\n\t\t\t\n\t\t\tif (inv->param_offset + 1 >= param_size) // +1 for aSetValue\n\t\t\t{\n\t\t\t\tauto new_size = param_size ? param_size * 2 : 64;\n\t\t\t\tauto new_buf = (ExprTokenType**)realloc(param_buf, new_size * sizeof(ExprTokenType*));\n\t\t\t\tif (!new_buf)\n\t\t\t\t{\n\t\t\t\t\terr = DEBUGGER_E_INTERNAL_ERROR;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tparam_buf = new_buf;\n\t\t\t\tparam_size = new_size;\n\t\t\t}\n\t\t\tparam_buf[inv->param_offset++] = inv->leftval;\n\n\t\t\tif (c == ',')\n\t\t\t{\n\t\t\t\tcp++;\n\t\t\t\tinv->leftval = nullptr;\n\t\t\t\tinv->invokee = nullptr;\n\t\t\t\tinv->flags = 0;\n\t\t\t\tgoto continue_with_same_lastval;\n\t\t\t}\n\n\t\t\tif (inv->end_char != c)\n\t\t\t\tbreak; // Syntax error.\n\t\t\t\n\t\t\tparam = param_buf + inv->outer->param_offset;\n\t\t\tparam_count = inv->param_offset - inv->outer->param_offset;\n\t\t\twhile (param_count && param[param_count-1]->symbol == SYM_MISSING)\n\t\t\t\t--param_count;\n\t\t\tinv = inv->outer;\n\t\t\tcp_end = ++cp; // Set things up to continue parsing after the end char.\n\t\t\tc = *cp;\n\t\t}\n\t\t\n\t\t// Prepare parameters for invocation.\n\t\tExprTokenType *value_to_set = !c ? aSetValue : NULL;\n\t\tif (value_to_set)\n\t\t{\n\t\t\tif ((inv->flags & IT_BITMASK) == IT_CALL)\n\t\t\t{\n\t\t\t\terr = DEBUGGER_E_INVALID_OPTIONS;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (param)\n\t\t\t\tparam[param_count] = aSetValue;\n\t\t\telse\n\t\t\t\tparam = &aSetValue;\n\t\t\tparam_count++;\n\t\t\tinv->flags |= IT_SET;\n\t\t}\n\n\t\t// Attempt to invoke property.\n\t\tauto result = inv->invokee->Invoke(lastval, inv->flags, inv->name, *inv->leftval, param, param_count);\n\n\t\tif (lastval.symbol == SYM_STRING && !lastval.mem_to_free)\n\t\t{\n\t\t\t// Make a copy of the string since it could otherwise be deleted as a side-effect\n\t\t\t// of a subsequent Invoke or Release call, or be overwritten if in prop.buf.\n\t\t\tif (!lastval.Malloc(lastval.marker, lastval.marker_length))\n\t\t\t\tresult = FAIL;\n\t\t}\n\n\t\tif (result != OK) // FAIL, INVOKE_NOT_HANDLED or EARLY_EXIT\n\t\t{\n\t\t\terr = result == INVOKE_NOT_HANDLED ? DEBUGGER_E_UNKNOWN_PROPERTY : DEBUGGER_E_EVAL_FAIL;\n\t\t\tbreak;\n\t\t}\n\t\tinv->invokee = nullptr;\n\t\tif (!c)\n\t\t\tbreak;\n\t\tinv->leftval = &lastval;\n\t\tinv->name = nullptr;\n\t\tinv->flags = 0;\n\t\tASSERT(cp == cp_end && (*cp == c || !*cp));\n\t\t*cp = c; // Potentially undo temporary termination.\n\t}\n\tbreak_outer:\n\t\n\tif (!err && (*cp || inv->outer || !temp_count))\n\t\terr = DEBUGGER_E_INVALID_OPTIONS;\n\n\tif (!err && !aSetValue && (!aResult.kind || aResult.kind == PropEnum))\n\t{\n\t\t// temp[--temp_count] is used in preference to inv->leftval, which should have the same value,\n\t\t// because we also want to \"remove\" it from the array so that it won't be deleted below.\n\t\tauto &ret = *temp[--temp_count];\n\t\tif (!aResult.kind)\n\t\t\taResult.kind = PropValue;\n\t\taResult.invokee = inv->invokee;\n\t\taResult.value.CopyValueFrom(ret);\n\t\taResult.value.mem_to_free = ret.mem_to_free;\n\t}\n\t\n\twhile (temp_count)\n\t\ttemp[--temp_count]->Free();\n\tfree(temp);\n\tfree(param_buf);\n\treturn err;\n}\n\nLPWSTR Debugger::ParsePropertyKeyLiteral(LPWSTR src, ExprTokenType &t_key)\n{\n\tif (*src == '\"')\n\t{\n\t\t// Quoted string which may contain any character.\n\t\tt_key.symbol = SYM_STRING;\n\t\tt_key.marker = ++src;\n\t\t// Replace \"\" with \" in-place and find end of string:\n\t\tWCHAR *dst;\n\t\tfor (dst = src; WCHAR c = *src; ++src)\n\t\t{\n\t\t\tif (c == '\"')\n\t\t\t{\n\t\t\t\t// Quote mark; but is it a literal quote mark?\n\t\t\t\tif (*++src != '\"') // This currently doesn't match up with expression syntax, but is left this way for simplicity.\n\t\t\t\t\t// Nope.\n\t\t\t\t\tbreak;\n\t\t\t\t//else above skipped the second quote mark, so fall through:\n\t\t\t}\n\t\t\t*dst++ = c;\n\t\t}\n\t\t*dst = '\\0';\n\t\tt_key.marker_length = dst - t_key.marker;\n\t\treturn src;\n\t}\n\telse if (!_tcsnicmp(src, _T(\"Object(\"), 7) && cisdigit(src[7]))\n\t{\n\t\t// Object(n) where n is the address of a key object, as a literal signed integer.\n\t\tt_key.value_int64 = istrtoi64(src + 7, &src);\n\t\tif (*src != ')')\n\t\t\treturn nullptr;\n\t\tt_key.symbol = SYM_OBJECT;\n\t\treturn src + 1;\n\t}\n\telse\n\t{\n\t\tLPTSTR iend, fend;\n\t\tauto ival = istrtoi64(src, &iend);\n\t\tauto fval = _tcstod(src, &fend);\n\t\tif (fend > iend)\n\t\t{\n\t\t\tt_key.SetValue(fval);\n\t\t\treturn fend;\n\t\t}\n\t\telse if (iend > src)\n\t\t{\n\t\t\tt_key.SetValue(ival);\n\t\t\treturn iend;\n\t\t}\n\t}\n\treturn nullptr;\n}\n\n\nint Debugger::property_get_or_value(char **aArgV, int aArgCount, char *aTransactionId, bool aIsPropertyGet)\n{\n\tint err;\n\tchar arg, *value;\n\n\tchar *name = NULL;\n\tint context_id = 0, depth = 0; // Var context and stack depth.\n\tCStringA name_buf;\n\tTCHAR value_buf[_f_retval_buf_size];\n\tPropertyInfo prop(name_buf, value_buf);\n\tprop.pagesize = mMaxChildren;\n\tprop.max_data = aIsPropertyGet ? mMaxPropertyData : 1024*1024*1024; // Limit property_value to 1GB by default.\n\tprop.max_depth = mMaxDepth; // Max property nesting depth.\n\n\tfor (int i = 0; i < aArgCount; ++i)\n\t{\n\t\targ = ArgChar(aArgV, i);\n\t\tvalue = ArgValue(aArgV, i);\n\t\tswitch (arg)\n\t\t{\n\t\t// property long name\n\t\tcase 'n': name = value; break;\n\t\t// context id - optional, default zero. see PropertyContextType enum.\n\t\tcase 'c': context_id = atoi(value); break;\n\t\t// stack depth - optional, default zero\n\t\tcase 'd':\n\t\t\tdepth = atoi(value);\n\t\t\tif (depth && (depth < 0 || depth >= mStack.Depth())) // Allow depth 0 even when stack is empty.\n\t\t\t\treturn DEBUGGER_E_INVALID_STACK_DEPTH;\n\t\t\tbreak;\n\t\t// max data size - optional\n\t\tcase 'm': prop.max_data = atoi(value); break;\n\t\t// data page - optional\n\t\tcase 'p': prop.page = atoi(value); break;\n\n\t\tdefault:\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t}\n\t}\n\n\tif (!name || prop.max_data < 0)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tint always_use;\n\tswitch (context_id)\n\t{\n\t// It seems best to allow context id zero to retrieve either a local or global,\n\t// rather than requiring the IDE to check each context when looking up a variable.\n\t//case PC_Local:\talways_use = FINDVAR_LOCAL; break;\n\tcase PC_Local:\talways_use = FINDVAR_FOR_READ; break;\n\tcase PC_Global:\talways_use = FINDVAR_GLOBAL; break;\n\tdefault:\n\t\treturn DEBUGGER_E_INVALID_CONTEXT;\n\t}\n\n\tif (err = ParsePropertyName(name, depth, always_use, NULL, prop))\n\t{\n\t\t// Var not found/invalid name.\n\t\tif (!aIsPropertyGet)\n\t\t\treturn err;\n\t\t// Return a value of type \"undefined\". This was originally done to work around\n\t\t// an issue with the DBGp plugin for Notepad++, but that was last updated in 2012\n\t\t// and doesn't support Notepad++ 64-bit. Now it's done for compatibility with\n\t\t// AutoHotkey-specific clients that may have come to rely on it:\n\t\tprop.kind = PropValue;\n\t\tif (prop.value.symbol == SYM_OBJECT)\n\t\t\tprop.value.object->Release();\n\t\tprop.value.symbol = SYM_MISSING;\n\t}\n\t//else var and field were set by the called function.\n\n\tswitch (prop.kind)\n\t{\n\tcase PropVar: err = GetPropertyInfo(*prop.var, prop); break;\n\tcase PropVarBkp: err = GetPropertyInfo(*prop.bkp, prop); break;\n\t//case PropEnum: // value already set by ParsePropertyName().\n\tdefault: err = DEBUGGER_E_OK; break;\n\t}\n\tif (!err)\n\t{\n\t\tif (aIsPropertyGet)\n\t\t{\n\t\t\tmResponseBuf.WriteF(\n\t\t\t\t\"<response command=\\\"property_get\\\" transaction_id=\\\"%e\\\">\"\n\t\t\t\t, aTransactionId);\n\t\t\tname_buf.SetString(name); // prop.fullname is an alias of name_buf.\n\t\t\t// For simplicity and code size, we use the full caller-specified name\n\t\t\t// instead of trying to parse out the \"short\" name or record it during\n\t\t\t// ParsePropertyName (which would have to take into account differences\n\t\t\t// between UTF-8 and LPTSTR):\n\t\t\tprop.name = name;\n\t\t\tif (prop.kind == PropEnum)\n\t\t\t\terr = WriteEnumItems(prop);\n\t\t\telse\n\t\t\t\terr = WritePropertyXml(prop);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tmResponseBuf.WriteF(\n\t\t\t\t\"<response command=\\\"property_value\\\" transaction_id=\\\"%e\\\" encoding=\\\"base64\\\" size=\\\"\"\n\t\t\t\t, aTransactionId);\n\t\t\terr = WritePropertyData(prop.value, prop.max_data);\n\t\t}\n\t}\n\treturn err ? err : mResponseBuf.Write(\"</response>\");\n}\n\nDEBUGGER_COMMAND(Debugger::property_set)\n{\n\tint err;\n\tchar arg, *value;\n\n\tchar *name = NULL, *new_value = NULL, *type = \"string\";\n\tint context_id = 0, depth = 0;\n\n\tfor (int i = 0; i < aArgCount; ++i)\n\t{\n\t\targ = ArgChar(aArgV, i);\n\t\tvalue = ArgValue(aArgV, i);\n\t\tswitch (arg)\n\t\t{\n\t\t// property long name\n\t\tcase 'n': name = value; break;\n\t\t// context id - optional, default zero. see PropertyContextType enum.\n\t\tcase 'c': context_id = atoi(value); break;\n\t\t// stack depth - optional, default zero\n\t\tcase 'd':\n\t\t\tdepth = atoi(value);\n\t\t\tif (depth && (depth < 0 || depth >= mStack.Depth())) // Allow depth 0 even when stack is empty.\n\t\t\t\treturn DEBUGGER_E_INVALID_STACK_DEPTH;\n\t\t\tbreak;\n\t\t// new base64-encoded value\n\t\tcase '-': new_value = value; break;\n\t\t// data type: string, integer or float\n\t\tcase 't': type = value; break;\n\t\t// not sure what the use of the 'length' arg is...\n\t\tcase 'l': break;\n\n\t\tdefault:\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t}\n\t}\n\n\tif (!name || !new_value)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tint always_use;\n\tswitch (context_id)\n\t{\n\t// For consistency with property_get, create a local only if no global exists.\n\t//case PC_Local:\talways_use = FINDVAR_LOCAL; break;\n\tcase PC_Local:\talways_use = FINDVAR_DEFAULT; break;\n\tcase PC_Global:\talways_use = FINDVAR_GLOBAL; break;\n\tdefault:\n\t\treturn DEBUGGER_E_INVALID_CONTEXT;\n\t}\n\n\t// \"Data must be encoded using base64.\" : https://xdebug.org/docs-dbgp.php\n\t// Fixed in v1.1.24.03 to expect base64 even for integer/float:\n\tint value_length = (int)Base64Decode(new_value, new_value);\n\t\n\tCString val_buf;\n\tExprTokenType val;\n\tif (!strcmp(type, \"integer\"))\n\t{\n\t\tval.SetValue(_atoi64(new_value));\n\t}\n\telse if (!strcmp(type, \"float\"))\n\t{\n\t\tval.SetValue(atof(new_value));\n\t}\n\telse // Assume type is \"string\", since that's the only other supported type.\n\t{\n\t\tStringUTF8ToTChar(new_value, val_buf, value_length);\n\t\tval.SetValue((LPTSTR)val_buf.GetString(), val_buf.GetLength());\n\t}\n\n\tTCHAR value_buf[_f_retval_buf_size];\n\tPropertySource target(value_buf);\n\tif (err = ParsePropertyName(name, depth, always_use, &val, target))\n\t\treturn err;\n\n\tbool success;\n\tswitch (target.kind)\n\t{\n\tcase PropVarBkp:\n\t\tif (target.bkp->mType != VAR_ALIAS)\n\t\t{\n\t\t\tVarBkp &bkp = *target.bkp;\n\t\t\tif (bkp.mAttrib & VAR_ATTRIB_IS_OBJECT)\n\t\t\t{\n\t\t\t\tbkp.mAttrib &= ~VAR_ATTRIB_IS_OBJECT;\n\t\t\t\tbkp.mObject->Release();\n\t\t\t}\n\t\t\tif (val.symbol == SYM_STRING)\n\t\t\t{\n\t\t\t\tif ((val.marker_length + 1) * sizeof(TCHAR) > bkp.mByteCapacity && val.marker_length)\n\t\t\t\t{\n\t\t\t\t\tif (bkp.mHowAllocated == ALLOC_MALLOC)\n\t\t\t\t\t\tfree(bkp.mCharContents);\n\t\t\t\t\telse\n\t\t\t\t\t\tbkp.mHowAllocated = ALLOC_MALLOC;\n\t\t\t\t\tbkp.mByteCapacity = (val_buf.GetAllocLength() + 1) * sizeof(TCHAR);\n\t\t\t\t\tbkp.mCharContents = val_buf.DetachBuffer();\n\t\t\t\t\tbkp.mAttrib &= ~VAR_ATTRIB_OFTEN_REMOVED;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\ttmemcpy(bkp.mCharContents, val.marker, val.marker_length + 1);\n\t\t\t\tbkp.mByteLength = val.marker_length * sizeof(TCHAR);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tbkp.mContentsInt64 = val.value_int64;\n\t\t\t\tbkp.mAttrib = bkp.mAttrib\n\t\t\t\t\t& ~(VAR_ATTRIB_TYPES | VAR_ATTRIB_NOT_NUMERIC | VAR_ATTRIB_UNINITIALIZED)\n\t\t\t\t\t| (val.symbol == SYM_INTEGER ? VAR_ATTRIB_IS_INT64 : VAR_ATTRIB_IS_DOUBLE) | VAR_ATTRIB_CONTENTS_OUT_OF_DATE;\n\t\t\t}\n\t\t\tsuccess = true;\n\t\t\tbreak;\n\t\t}\n\t\ttarget.var = target.bkp->mAliasFor;\n\t\t// Fall through:\n\tcase PropVar:\n\t\tsuccess = !VAR_IS_READONLY(*target.var) && target.var->Assign(val);\n\t\tbreak;\n\tcase PropNone: // Assignment handled by ParsePropertyName().\n\t\tsuccess = true;\n\t\tbreak;\n\tdefault:\n\t\tsuccess = false;\n\t}\n\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"property_set\\\" success=\\\"%i\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t, (int)success, aTransactionId);\n}\n\nDEBUGGER_COMMAND(Debugger::source)\n{\n\tchar arg, *value;\n\n\tchar *filename = NULL;\n\tLineNumberType begin_line = 0, end_line = UINT_MAX;\n\n\tfor (int i = 0; i < aArgCount; ++i)\n\t{\n\t\targ = ArgChar(aArgV, i);\n\t\tvalue = ArgValue(aArgV, i);\n\t\tswitch (arg)\n\t\t{\n\t\tcase 'b': begin_line = strtoul(value, NULL, 10); break;\n\t\tcase 'e': end_line = strtoul(value, NULL, 10); break;\n\t\tcase 'f': filename = value; break;\n\t\tdefault:\n\t\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\t\t}\n\t}\n\n\tif (!filename || begin_line > end_line)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tint file_index;\n\n\t// Decode filename URI -> path, in-place.\n\tDecodeURI(filename);\n\n\tCStringTCharFromUTF8 filename_t(filename);\n\n\t// Ensure the file is actually a source file - i.e. don't let the debugger client retrieve any arbitrary file.\n\tfor (file_index = 0; file_index < Line::sSourceFileCount; ++file_index)\n\t{\n\t\tif (!_tcsicmp(filename_t, Line::sSourceFile[file_index]))\n\t\t{\n\t\t\tTextFile tf;\n\t\t\tif (!tf.Open(filename_t, DEFAULT_READ_FLAGS, g_DefaultScriptCodepage))\n\t\t\t\treturn DEBUGGER_E_CAN_NOT_OPEN_FILE;\n\t\t\t\n\t\t\tmResponseBuf.WriteF(\"<response command=\\\"source\\\" success=\\\"1\\\" transaction_id=\\\"%e\\\" encoding=\\\"base64\\\">\"\n\t\t\t\t\t\t\t\t, aTransactionId);\n\n\t\t\tCStringA utf8_buf;\n\t\t\tTCHAR line_buf[LINE_SIZE + 2]; // May contain up to two characters of the previous line to simplify base64-encoding.\n\t\t\tint line_length;\n\t\t\tint line_remainder = 0;\n\n\t\t\tLineNumberType current_line = 0;\n\t\t\t\n\t\t\twhile (-1 != (line_length = tf.ReadLine(line_buf + line_remainder, LINE_SIZE)))\n\t\t\t{\n\t\t\t\tif (++current_line >= begin_line)\n\t\t\t\t{\n\t\t\t\t\tif (current_line > end_line)\n\t\t\t\t\t\tbreak; // done.\n\t\t\t\t\t\n\t\t\t\t\t// Encode in multiples of 3 characters to avoid inserting padding characters.\n\t\t\t\t\tline_length += line_remainder; // Include remainder of previous line.\n\t\t\t\t\tline_remainder = line_length % 3;\n\t\t\t\t\tline_length -= line_remainder;\n\n\t\t\t\t\tif (line_length)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Convert line to UTF-8.\n\t\t\t\t\t\tStringTCharToUTF8(line_buf, utf8_buf, line_length);\n\t\t\t\t\t\t// Base64-encode and write this line and its trailing newline character into the response buffer.\n\t\t\t\t\t\tif (mResponseBuf.WriteEncodeBase64(utf8_buf.GetString(), utf8_buf.GetLength()) != DEBUGGER_E_OK)\n\t\t\t\t\t\t\tgoto break_outer_loop; // fail.\n\t\t\t\t\t}\n\t\t\t\t\t//else not enough data to encode in this iteration.\n\n\t\t\t\t\tif (line_remainder) // 0, 1 or 2.\n\t\t\t\t\t{\n\t\t\t\t\t\tline_buf[0] = line_buf[line_length];\n\t\t\t\t\t\tif (line_remainder > 1)\n\t\t\t\t\t\t\tline_buf[1] = line_buf[line_length + 1];\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (line_remainder) // Write any left-over characters.\n\t\t\t{\n\t\t\t\tStringTCharToUTF8(line_buf, utf8_buf, line_remainder);\n\t\t\t\tif (mResponseBuf.WriteEncodeBase64(utf8_buf.GetString(), utf8_buf.GetLength()) != DEBUGGER_E_OK)\n\t\t\t\t\tbreak; // fail.\n\t\t\t}\n\n\t\t\tif (!current_line || current_line < begin_line)\n\t\t\t\tbreak; // fail.\n\t\t\t// else if (current_line < end_line) -- just return what we can.\n\n\t\t\treturn mResponseBuf.Write(\"</response>\");\n\t\t}\n\t}\nbreak_outer_loop:\n\t// If we got here, one of the following is true:\n\t//\t- Something failed and used 'break'.\n\t//\t- The requested file is not a known source file of this script.\n\tmResponseBuf.Clear();\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"source\\\" success=\\\"0\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t, aTransactionId);\n}\n\nint Debugger::redirect_std(char **aArgV, int aArgCount, char *aTransactionId, char *aCommandName)\n{\n\tint new_mode = -1;\n\t// stdout and stderr accept exactly one arg: -c mode.\n\tif (aArgCount == 1 && ArgChar(aArgV, 0) == 'c')\n\t\tnew_mode = atoi(ArgValue(aArgV, 0));\n\n\tif (new_mode < SR_Disabled || new_mode > SR_Redirect)\n\t\treturn DEBUGGER_E_INVALID_OPTIONS;\n\n\tif (!stricmp(aCommandName, \"stdout\"))\n\t\tmStdOutMode = (StreamRedirectType)new_mode;\n\telse\n\t\tmStdErrMode = (StreamRedirectType)new_mode;\n\n\treturn mResponseBuf.WriteF(\n\t\t\"<response command=\\\"%s\\\" success=\\\"1\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t, aCommandName, aTransactionId);\n}\n\nDEBUGGER_COMMAND(Debugger::redirect_stdout)\n{\n\treturn redirect_std(aArgV, aArgCount, aTransactionId, \"stdout\");\n}\n\nDEBUGGER_COMMAND(Debugger::redirect_stderr)\n{\n\treturn redirect_std(aArgV, aArgCount, aTransactionId, \"stderr\");\n}\n\n//\n// END DBGP COMMANDS\n//\n\n//\n// DBGP STREAMS\n//\n\nint Debugger::WriteStreamPacket(LPCTSTR aText, LPCSTR aType)\n{\n\tASSERT(!mResponseBuf.mFailed);\n\t// Although it is contrary to the DBGP spec, allowing stream packets to be sent while the debugger\n\t// is in a break state (but executing due to a property getter invoked by property_get or context_get)\n\t// is useful for debugging and therefore allowed. We just have to be sure to preserve any partial\n\t// response already present in the buffer:\n\tsize_t offset = mResponseBuf.mDataUsed;\n\tmResponseBuf.WriteF(\"<stream type=\\\"%s\\\">\", aType);\n\tCStringUTF8FromTChar packet(aText);\n\tmResponseBuf.WriteEncodeBase64(packet, packet.GetLength() + 1); // Includes the null-terminator.\n\tmResponseBuf.Write(\"</stream>\");\n\treturn SendResponse(offset);\n}\n\nbool Debugger::OutputStdErr(LPCTSTR aText)\n{\n\tif (mStdErrMode != SR_Disabled) // i.e. SR_Copy or SR_Redirect\n\t\tWriteStreamPacket(aText, \"stderr\");\n\treturn mStdErrMode == SR_Redirect;\n}\n\nbool Debugger::OutputStdOut(LPCTSTR aText)\n{\n\tif (mStdOutMode != SR_Disabled) // i.e. SR_Copy or SR_Redirect\n\t\tWriteStreamPacket(aText, \"stdout\");\n\treturn mStdOutMode == SR_Redirect;\n}\n\nint Debugger::SendErrorResponse(char *aCommandName, char *aTransactionId, int aError, char *aExtraAttributes)\n{\n\tmResponseBuf.WriteF(\"<response command=\\\"%s\\\" transaction_id=\\\"%e\"\n\t\t, aCommandName, aTransactionId);\n\t\n\tif (aExtraAttributes)\n\t\tmResponseBuf.WriteF(\"\\\" %s>\", aExtraAttributes);\n\telse\n\t\tmResponseBuf.Write(\"\\\">\");\n\n\tmResponseBuf.WriteF(\"<error code=\\\"%i\\\"/></response>\", aError);\n\n\treturn SendResponse();\n}\n\nint Debugger::SendStandardResponse(char *aCommandName, char *aTransactionId)\n{\n\tmResponseBuf.WriteF(\"<response command=\\\"%s\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t\t\t\t\t, aCommandName, aTransactionId);\n\n\treturn SendResponse();\n}\n\nint Debugger::SendContinuationResponse(LPCSTR aCommand, LPCSTR aStatus, LPCSTR aReason)\n{\n\tif (!aCommand)\n\t{\n\t\tswitch (mInternalState)\n\t\t{\n\t\tcase DIS_StepInto:\taCommand = \"step_into\";\tbreak;\n\t\tcase DIS_StepOver:\taCommand = \"step_over\";\tbreak;\n\t\tcase DIS_StepOut:\taCommand = \"step_out\";\tbreak;\n\t\tcase DIS_Run:\t\taCommand = \"run\";\t\tbreak;\n\t\t// Seems more useful then silently failing:\n\t\tdefault:\t\t\taCommand = \"\";\n\t\t}\n\t}\n\n\tmResponseBuf.WriteF(\"<response command=\\\"%s\\\" status=\\\"%s\\\" reason=\\\"%s\\\" transaction_id=\\\"%e\\\"/>\"\n\t\t\t\t\t\t, aCommand, aStatus, aReason, (LPCSTR)mContinuationTransactionId);\n\n\treturn SendResponse();\n}\n\n// Debugger::ReceiveCommand\n//\n// Receives a full command line into mCommandBuf. If part of the next command is\n// received, it remains in the buffer until the next call to ReceiveCommand.\n//\nint Debugger::ReceiveCommand(int *aCommandLength)\n{\n\tASSERT(mSocket != INVALID_SOCKET); // Shouldn't be at this point; will be caught by recv() anyway.\n\tASSERT(!mCommandBuf.mFailed); // Should have been previously reset.\n\n\tDWORD u = 0;\n\n\tfor(;;)\n\t{\n\t\t// Check data received in the previous iteration or by a previous call to ReceiveCommand().\n\t\tfor ( ; u < mCommandBuf.mDataUsed; ++u)\n\t\t{\n\t\t\tif (mCommandBuf.mData[u] == '\\0')\n\t\t\t{\n\t\t\t\tif (aCommandLength)\n\t\t\t\t\t*aCommandLength = u; // Does not include the null-terminator.\n\t\t\t\treturn DEBUGGER_E_OK;\n\t\t\t}\n\t\t}\n\n\t\t// Init or expand the buffer as necessary.\n\t\tif (mCommandBuf.mDataUsed == mCommandBuf.mDataSize && mCommandBuf.Expand() != DEBUGGER_E_OK)\n\t\t\treturn FatalError(); // This also calls mCommandBuf.Clear() via Disconnect().\n\n\t\t// Receive and append data.\n\t\tint bytes_received = recv(mSocket, mCommandBuf.mData + mCommandBuf.mDataUsed, (int)(mCommandBuf.mDataSize - mCommandBuf.mDataUsed), 0);\n\n\t\tif (bytes_received == SOCKET_ERROR)\n\t\t\treturn FatalError();\n\n\t\tmCommandBuf.mDataUsed += bytes_received;\n\t}\n}\n\n// Debugger::SendResponse\n//\n// Sends a response to a command, using mResponseBuf.mData as the message body.\n//\nint Debugger::SendResponse(size_t aStartOffset)\n{\n\tASSERT(!mResponseBuf.mFailed);\n\tASSERT(aStartOffset < mResponseBuf.mDataUsed);\n\tASSERT(mResponseBuf.mDataUsed <= mResponseBuf.mDataSize);\n\n\tchar response_header[DEBUGGER_RESPONSE_OVERHEAD];\n\n\tsize_t data_length = mResponseBuf.mDataUsed - aStartOffset;\n\t\n\t// Messages sent by the debugger engine must always be NULL terminated.\n\t// ExpandIfNecessary() reserved 1 byte for this (excluded from mDataSize):\n\tmResponseBuf.mData[mResponseBuf.mDataUsed] = '\\0';\n\t\n\t// Each message is prepended with a stringified integer representing the length of the XML data packet.\n\tExp32or64(_itoa,_i64toa)(data_length + DEBUGGER_XML_TAG_SIZE, response_header, 10);\n\n\t// The length and XML data are separated by a NULL byte.\n\tchar *buf = strchr(response_header, '\\0') + 1;\n\n\t// The XML document tag must always be present to provide XML version and encoding information.\n\tbuf += sprintf(buf, \"%s\", DEBUGGER_XML_TAG);\n\n\t// Send the response header.\n\tif ( SOCKET_ERROR == send(mSocket, response_header, (int)(buf - response_header), 0)\n\t // Send the message body.\n\t || SOCKET_ERROR == send(mSocket, mResponseBuf.mData + aStartOffset, (int)(data_length + 1), 0) )\n\t{\n\t\t// Unrecoverable error: disconnect the debugger.\n\t\treturn FatalError();\n\t}\n\n\tmResponseBuf.mDataUsed = aStartOffset;\n\treturn DEBUGGER_E_OK;\n}\n\n// Debugger::Connect\n//\n// Connect to a debugger UI. Returns a Winsock error code on failure, otherwise 0.\n//\nint Debugger::Connect(const char *aAddress, const char *aPort)\n{\n\tint err;\n\tWSADATA wsadata;\n\tSOCKET s;\n\t\n\tif (WSAStartup(MAKEWORD(2,2), &wsadata))\n\t\treturn FatalError();\n\t\n\ts = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);\n\n\tif (s != INVALID_SOCKET)\n\t{\n\t\taddrinfo hints = {0};\n\t\taddrinfo *res;\n\t\t\n\t\thints.ai_family = AF_INET;\n\t\thints.ai_socktype = SOCK_STREAM;\n\t\thints.ai_protocol = IPPROTO_TCP;\n\n\t\terr = getaddrinfo(aAddress, aPort, &hints, &res);\n\t\t\n\t\tif (err == 0)\n\t\t{\n\t\t\tfor (;;)\n\t\t\t{\n\t\t\t\terr = connect(s, res->ai_addr, (int)res->ai_addrlen);\n\t\t\t\tif (err == 0)\n\t\t\t\t\tbreak;\n\t\t\t\tswitch (MessageBox(g_hWnd, DEBUGGER_ERR_FAILEDTOCONNECT, g_script.mFileSpec, MB_ABORTRETRYIGNORE | MB_ICONSTOP | MB_SETFOREGROUND | MB_APPLMODAL))\n\t\t\t\t{\n\t\t\t\tcase IDABORT:\n\t\t\t\t\tg_script.ExitApp(EXIT_CLOSE);\n\t\t\t\t\t// If it didn't exit (due to OnExit), fall through to the next case:\n\t\t\t\tcase IDIGNORE:\n\t\t\t\t\tclosesocket(s);\n\t\t\t\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\t\t\t\t}\n\t\t\t}\n\t\t\t\n\t\t\tfreeaddrinfo(res);\n\t\t\t\n\t\t\tif (err == 0)\n\t\t\t{\n\t\t\t\tmSocket = s;\n\n\t\t\t\tCStringUTF8FromTChar ide_key(CString().GetEnvironmentVariable(_T(\"DBGP_IDEKEY\")));\n\t\t\t\tCStringUTF8FromTChar session(CString().GetEnvironmentVariable(_T(\"DBGP_COOKIE\")));\n\n\t\t\t\t// Clear the buffer in case of a previous failed session.\n\t\t\t\tmResponseBuf.Clear();\n\n\t\t\t\t// Write init message.\n\t\t\t\tmResponseBuf.WriteF(\"<init appid=\\\"\" AHK_NAME \"\\\" ide_key=\\\"%e\\\" session=\\\"%e\\\" thread=\\\"%u\\\" parent=\\\"\\\" language=\\\"\" DEBUGGER_LANG_NAME\n\t\t\t\t\t\"\\\" protocol_version=\\\"1.0\\\" fileuri=\\\"%r\\\"/>\"\n\t\t\t\t\t, ide_key.GetString(), session.GetString(), GetCurrentThreadId(), g_script.mFileSpec);\n\n\t\t\t\tif (SendResponse() == DEBUGGER_E_OK)\n\t\t\t\t{\n\t\t\t\t\t// mCurrLine isn't updated unless the debugger is connected, so set it now.\n\t\t\t\t\t// g_script.mCurrLine should always be non-NULL after the script is loaded,\n\t\t\t\t\t// even if no threads are active.\n\t\t\t\t\tmCurrLine = g_script.mCurrLine;\n\t\t\t\t\treturn DEBUGGER_E_OK;\n\t\t\t\t}\n\n\t\t\t\tmSocket = INVALID_SOCKET; // Don't want FatalError() to attempt a second closesocket().\n\t\t\t}\n\t\t}\n\n\t\tclosesocket(s);\n\t}\n\n\tWSACleanup();\n\treturn FatalError(DEBUGGER_ERR_FAILEDTOCONNECT DEBUGGER_ERR_DISCONNECT_PROMPT);\n}\n\n// Debugger::Disconnect\n//\n// Disconnect the debugger UI.\n//\nint Debugger::Disconnect()\n{\n\tif (mSocket != INVALID_SOCKET)\n\t{\n\t\tshutdown(mSocket, 2);\n\t\tclosesocket(mSocket);\n\t\tmSocket = INVALID_SOCKET;\n\t\tWSACleanup();\n\t}\n\t// These are reset in case we re-attach to the debugger client later:\n\tmCommandBuf.Clear();\n\tmResponseBuf.Clear();\n\tmStdOutMode = SR_Disabled;\n\tmStdErrMode = SR_Disabled;\n\tif (mInternalState == DIS_Break)\n\t\tExitBreakState();\n\tmInternalState = DIS_Starting;\n\treturn DEBUGGER_E_OK;\n}\n\n// Debugger::Exit\n//\n// Gracefully end debug session. Called on script exit. Also called by \"detach\" DBGp command.\n//\nvoid Debugger::Exit(ExitReasons aExitReason, char *aCommandName)\n{\n\tif (mSocket == INVALID_SOCKET)\n\t\treturn;\n\t// Don't care if it fails as we may be exiting due to a previous failure.\n\tSendContinuationResponse(aCommandName, \"stopped\", aExitReason == EXIT_ERROR ? \"error\" : \"ok\");\n\tDisconnect();\n}\n\nint Debugger::FatalError(LPCTSTR aMessage)\n{\n\tg_Debugger.Disconnect();\n\n\tif (IDNO == MessageBox(g_hWnd, aMessage, g_script.mFileSpec, MB_YESNO | MB_ICONSTOP | MB_SETFOREGROUND | MB_APPLMODAL))\n\t{\n\t\t// This might not exit, depending on OnExit:\n\t\tg_script.ExitApp(EXIT_CLOSE);\n\t}\n\treturn DEBUGGER_E_INTERNAL_ERROR;\n}\n\nconst char *Debugger::sBase64Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/\";\n\n#define BINARY_TO_BASE64_CHAR(b) (sBase64Chars[(b) & 63])\n#define BASE64_CHAR_TO_BINARY(q) (strchr(sBase64Chars, q)-sBase64Chars)\n\n// Encode base 64 data.\nsize_t Debugger::Base64Encode(char *aBuf, const char *aInput, size_t aInputSize/* = -1*/)\n{\n\tUINT_PTR buffer;\n\tsize_t i, len = 0;\n\n\tif (aInputSize == -1) // Direct comparison since aInputSize is unsigned.\n\t\taInputSize = strlen(aInput);\n\n\tfor (i = aInputSize; i > 2; i -= 3)\n\t{\n\t\tbuffer = (UCHAR)aInput[0] << 16 | (UCHAR)aInput[1] << 8 | (UCHAR)aInput[2]; // L39: Fixed for chars outside the range 0..127. [thanks jackieku]\n\t\taInput += 3;\n\n\t\taBuf[len + 0] = BINARY_TO_BASE64_CHAR(buffer >> 18);\n\t\taBuf[len + 1] = BINARY_TO_BASE64_CHAR(buffer >> 12);\n\t\taBuf[len + 2] = BINARY_TO_BASE64_CHAR(buffer >> 6);\n\t\taBuf[len + 3] = BINARY_TO_BASE64_CHAR(buffer);\n\t\tlen += 4;\n\t}\n\tif (i > 0)\n\t{\n\t\tbuffer = (UCHAR)aInput[0] << 16;\n\t\tif (i > 1)\n\t\t\tbuffer |= (UCHAR)aInput[1] << 8;\n\t\t// aInput not incremented as it is not used below.\n\n\t\taBuf[len + 0] = BINARY_TO_BASE64_CHAR(buffer >> 18);\n\t\taBuf[len + 1] = BINARY_TO_BASE64_CHAR(buffer >> 12);\n\t\taBuf[len + 2] = (i > 1) ? BINARY_TO_BASE64_CHAR(buffer >> 6) : '=';\n\t\taBuf[len + 3] = '=';\n\t\tlen += 4;\n\t}\n\taBuf[len] = '\\0';\n\treturn len;\n}\n\n// Decode base 64 data. aBuf and aInput may point to the same buffer.\nsize_t Debugger::Base64Decode(char *aBuf, const char *aInput, size_t aInputSize/* = -1*/)\n{\n\tUINT_PTR buffer;\n\tsize_t i, len = 0;\n\n\tif (aInputSize == -1) // Direct comparison since aInputSize is unsigned.\n\t\taInputSize = strlen(aInput);\n\n\twhile (aInputSize > 0 && aInput[aInputSize-1] == '=')\n\t\t--aInputSize;\n\n\tfor (i = aInputSize; i > 3; i -= 4)\n\t{\n\t\tbuffer\t= BASE64_CHAR_TO_BINARY(aInput[0]) << 18 // L39: Fixed bad reliance on order of *side-effects++. [thanks fincs]\n\t\t\t\t| BASE64_CHAR_TO_BINARY(aInput[1]) << 12\n\t\t\t\t| BASE64_CHAR_TO_BINARY(aInput[2]) << 6\n\t\t\t\t| BASE64_CHAR_TO_BINARY(aInput[3]);\n\t\taInput += 4;\n\n\t\taBuf[len + 0] = (buffer >> 16) & 255;\n\t\taBuf[len + 1] = (buffer >> 8) & 255;\n\t\taBuf[len + 2] = buffer & 255;\n\t\tlen += 3;\n\t}\n\n\tif (i > 1)\n\t{\n\t\tbuffer = BASE64_CHAR_TO_BINARY(aInput[0]) << 18\n\t\t\t\t| BASE64_CHAR_TO_BINARY(aInput[1]) << 12;\n\t\tif (i > 2)\n\t\t\tbuffer |= BASE64_CHAR_TO_BINARY(aInput[2]) << 6;\n\t\t// aInput not incremented as it is not used below.\n\n\t\taBuf[len++] = (buffer >> 16) & 255;\n\t\tif (i > 2)\n\t\t\taBuf[len++] = (buffer >> 8) & 255;\n\t}\n\taBuf[len] = '\\0';\n\treturn len;\n}\n\n//\n// class Debugger::Buffer - simplifies memory management.\n//\n\n// Write data into the buffer, expanding it as necessary.\nint Debugger::Buffer::Write(char *aData, size_t aDataSize)\n{\n\tif (mFailed) // See WriteF() for comments.\n\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\n\tif (aDataSize == -1)\n\t\taDataSize = strlen(aData);\n\n\tif (aDataSize == 0)\n\t\treturn DEBUGGER_E_OK;\n\n\tif (ExpandIfNecessary(mDataUsed + aDataSize) != DEBUGGER_E_OK)\n\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\n\tmemcpy(mData + mDataUsed, aData, aDataSize);\n\tmDataUsed += aDataSize;\n\treturn DEBUGGER_E_OK;\n}\n\n// Write formatted data into the buffer. Supports %s (char*), %e (char*, \"&'<> escaped), %i (int), %u (unsigned int), %p (UINT_PTR).\nint Debugger::Buffer::WriteF(const char *aFormat, ...)\n{\n\tif (mFailed)\n\t{\n\t\t// A prior Write() failed and the now-invalid data hasn't yet been cleared\n\t\t// from the buffer. Abort. This allows numerous other parts of the code\n\t\t// to omit error-checking.\n\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\t}\n\n\tint i;\n\tsize_t len;\n\tchar c;\n\tconst char *format_ptr, *s, *param_ptr, *entity;\n\tchar number_buf[MAX_INTEGER_SIZE];\n\tva_list vl;\n\t\n\tfor (len = 0, i = 0; i < 2; ++i)\n\t{\n\t\tva_start(vl, aFormat);\n\n\t\t// Calculate the required buffer size.\n\t\tfor (format_ptr = aFormat; c = *format_ptr; ++format_ptr)\n\t\t{\n\t\t\tif (c == '%')\n\t\t\t{\n\t\t\t\tswitch (format_ptr[1])\n\t\t\t\t{\n\t\t\t\tcase 's': s = va_arg(vl, char*); break;\n\t\t\t\tcase 'i': s = _itoa(va_arg(vl, int), number_buf, 10); break;\n\t\t\t\tcase 'u': s = _ultoa(va_arg(vl, unsigned long), number_buf, 10); break;\n\t\t\t\tcase 'p': s = Exp32or64(_ultoa,_ui64toa)(va_arg(vl, UINT_PTR), number_buf, 10); break;\n\n\t\t\t\tcase 'e': // String, replace \"&'<> with appropriate XML entity.\n\t\t\t\t{\n\t\t\t\t\ts = va_arg(vl, char*);\n\t\t\t\t\tif (i == 0)\n\t\t\t\t\t{\n\t\t\t\t\t\tfor (param_ptr = s; *param_ptr; ++param_ptr)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tswitch (*param_ptr)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcase '\"': case '\\'':\tlen += 6; break; // " or '\n\t\t\t\t\t\t\tcase '&':\t\t\t\tlen += 5; break; // &\n\t\t\t\t\t\t\tcase '<': case '>':\t\tlen += 4; break; // < or >\n\t\t\t\t\t\t\tdefault: ++len;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\tfor (param_ptr = s; c = *param_ptr; ++param_ptr)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tswitch (c)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcase '\"': entity = \"quot\"; break;\n\t\t\t\t\t\t\tcase '\\'': entity = \"apos\"; break;\n\t\t\t\t\t\t\tcase '&': entity = \"amp\"; break;\n\t\t\t\t\t\t\tcase '<': entity = \"lt\"; break;\n\t\t\t\t\t\t\tcase '>': entity = \"gt\"; break;\n\t\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\t\tmData[mDataUsed++] = c;\n\t\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t// One of: \"'&<> - entity is set to the appropriate entity name.\n\t\t\t\t\t\t\tmDataUsed += sprintf(mData + mDataUsed, \"&%s;\", entity);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t++format_ptr; // Skip %, outer loop will skip format char.\n\t\t\t\t\t//s = NULL; // Skip section below.\n\t\t\t\t\t//break;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\tcase 'r':\n\t\t\t\t\tif (i == 0)\n\t\t\t\t\t\tlen += EstimateFileURILength(va_arg(vl, LPCTSTR));\n\t\t\t\t\telse\n\t\t\t\t\t\tWriteFileURI(va_arg(vl, LPCTSTR));\n\t\t\t\t\t++format_ptr; // Skip %, outer loop will skip format char.\n\t\t\t\t\tcontinue;\n\n\t\t\t\tdefault:\n\t\t\t\t\ts = NULL; // Skip section below.\n\t\t\t\t} // switch (format_ptr[1])\n\n\t\t\t\tif (s)\n\t\t\t\t{\t// %s, %i or %u.\n\t\t\t\t\tif (i == 0)\n\t\t\t\t\t{\t// Calculate required buffer space on first iteration.\n\t\t\t\t\t\tlen += strlen(s);\n\t\t\t\t\t}\n\t\t\t\t\telse if (len = strlen(s))\n\t\t\t\t\t{\t// Write into buffer on second iteration.\n\t\t\t\t\t\t// memcpy as we don't want the terminating null character.\n\t\t\t\t\t\tmemcpy(mData + mDataUsed, s, len);\n\t\t\t\t\t\tmDataUsed += len;\n\t\t\t\t\t}\n\t\t\t\t\t++format_ptr; // Skip %, outer loop will skip format char.\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t} // if (c == '%')\n\t\t\t// Count or copy character as is.\n\t\t\tif (i == 0)\n\t\t\t\t++len;\n\t\t\telse\n\t\t\t\tmData[mDataUsed++] = *format_ptr;\n\t\t} // for (format_ptr = aFormat; c = *format_ptr; ++format_ptr)\n\n\t\tif (i == 0)\n\t\t\tif (ExpandIfNecessary(mDataUsed + len) != DEBUGGER_E_OK)\n\t\t\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\t} // for (len = 0, i = 0; i < 2; ++i)\n\n\treturn DEBUGGER_E_OK;\n}\n\nint Debugger::Buffer::EstimateFileURILength(LPCTSTR aPath)\n{\n\tTBYTE c, len = 8; // \"file:///\"\n\tfor (LPCTSTR ptr = aPath; c = *ptr; ++ptr)\n\t{\n\t\tif (cisalnum(c) || _tcschr(_T(\"-_.!~*'()/\\\\\"), c))\n\t\t\t++len;\n\t\telse\n\t\t\t// For code size, estimate based on worst-case scenario (U+FFFF -> %ef%bf%bf).\n\t\t\t// Any extra space is likely to be used at some point, as the response buffer gets reused.\n\t\t\tlen += 9;\n\t}\n\treturn len;\n}\n\n// Convert a file path to a URI and write it to the buffer.\n// Caller has already verified there is enough space in the buffer.\nvoid Debugger::Buffer::WriteFileURI(LPCWSTR aPath)\n{\n\tmemcpy(mData + mDataUsed, \"file:///\", 8);\n\tmDataUsed += 8;\n\n\tchar utf8[4];\n\n\t// Write to the buffer, encoding as we go.\n\tint c;\n\tfor (auto ptr = aPath; c = *ptr; ++ptr)\n\t{\n\t\tif (cisalnum(c) || strchr(\"-_.!~*()/\", c))\n\t\t{\n\t\t\tmData[mDataUsed++] = (char)c;\n\t\t}\n\t\telse if (c == '\\\\')\n\t\t{\n\t\t\t// This could be encoded as %5C, but it's more readable this way:\n\t\t\tmData[mDataUsed++] = '/';\n\t\t}\n\t\telse\n\t\t{\n\t\t\tbool extra = IS_SURROGATE_PAIR(ptr[0], ptr[1]);\n\t\t\tint utf8_size = WideCharToMultiByte(CP_UTF8, 0, ptr, 1 + extra, utf8, sizeof(utf8), NULL, NULL);\n\t\t\tptr += extra;\n\t\t\tfor (int i = 0; i < utf8_size; ++i)\n\t\t\t{\n\t\t\t\tint len = sprintf(mData + mDataUsed, \"%%%02X\", utf8[i] & 0xff);\n\t\t\t\tif (len != -1)\n\t\t\t\t\tmDataUsed += len;\n\t\t\t}\n\t\t}\n\t}\n}\n\nint Debugger::Buffer::WriteEncodeBase64(const char *aInput, size_t aInputSize, bool aSkipBufferSizeCheck/* = false*/)\n{\n\tif (aInputSize)\n\t{\n\t\tif (!aSkipBufferSizeCheck)\n\t\t{\n\t\t\t// Ensure required buffer space is available.\n\t\t\tif (ExpandIfNecessary(mDataUsed + DEBUGGER_BASE64_ENCODED_SIZE(aInputSize)) != DEBUGGER_E_OK)\n\t\t\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\t\t}\n\t\t//else caller has already ensured there is enough space and wants to be absolutely sure mData isn't reallocated.\n\t\tASSERT(mDataUsed + aInputSize < mDataSize);\n\t\t\n\t\tif (aInput)\n\t\t\tmDataUsed += Debugger::Base64Encode(mData + mDataUsed, aInput, aInputSize);\n\t\t//else caller wanted to reserve some buffer space, probably to read the raw data into.\n\t}\n\t//else there's nothing to write, just return OK. Calculations above can't handle (size_t)0\n\treturn DEBUGGER_E_OK;\n}\n\n// Decode a file URI in-place.\nvoid Debugger::DecodeURI(char *aUri)\n{\n\tchar *end = strchr(aUri, 0);\n\tchar escape[3];\n\tescape[2] = '\\0';\n\n\tif (!strnicmp(aUri, \"file:///\", 8))\n\t{\n\t\t// Use memmove since I'm not sure if strcpy can handle overlap.\n\t\tend -= 8;\n\t\tmemmove(aUri, aUri + 8, end - aUri);\n\t}\n\t// Some debugger UI's use file://path even though it is invalid (it should be file:///path or file://server/path).\n\t// For compatibility with these UI's, support file://.\n\telse if (!strnicmp(aUri, \"file://\", 7))\n\t{\n\t\tend -= 7;\n\t\tmemmove(aUri, aUri + 7, end - aUri);\n\t}\n\n\tchar *dst, *src;\n\tfor (src = dst = aUri; src < end; ++src, ++dst)\n\t{\n\t\tif (*src == '%' && src + 2 < end)\n\t\t{\n\t\t\tescape[0] = *++src;\n\t\t\tescape[1] = *++src;\n\t\t\t*dst = (char)strtol(escape, NULL, 16);\n\t\t}\n\t\telse if (*src == '/')\n\t\t\t*dst = '\\\\';\n\t\telse\n\t\t\t*dst = *src;\n\t}\n\t*dst = '\\0';\n}\n\n// Initialize or expand the buffer, don't care how much.\nint Debugger::Buffer::Expand()\n{\n\treturn ExpandIfNecessary(mDataSize + 1);\n}\n\n// Expand as necessary to meet a minimum required size.\nint Debugger::Buffer::ExpandIfNecessary(size_t aRequiredSize)\n{\n\tif (mFailed)\n\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\n\tsize_t new_size;\n\tfor (new_size = mDataSize ? mDataSize + 1 : DEBUGGER_INITIAL_BUFFER_SIZE\n\t\t; new_size <= aRequiredSize\n\t\t; new_size *= 2);\n\n\tif (new_size > mDataSize + 1)\n\t{\n\t\t// For simplicity, this preserves all of mData not just the first mDataUsed bytes. Some sections may rely on this.\n\t\tchar *new_data = (char*)realloc(mData, new_size);\n\n\t\tif (new_data == NULL)\n\t\t{\n\t\t\tmFailed = TRUE;\n\t\t\treturn DEBUGGER_E_INTERNAL_ERROR;\n\t\t}\n\n\t\tmData = new_data;\n\t\tmDataSize = new_size - 1; // Reserve 1 byte for null-termination.\n\t}\n\treturn DEBUGGER_E_OK;\n}\n\n// Remove data from the front of the buffer (i.e. after it is processed).\nvoid Debugger::Buffer::Delete(size_t aDataSize)\n{\n\tASSERT(aDataSize <= mDataUsed);\n\t// Move remaining data to the front of the buffer.\n\tif (aDataSize < mDataUsed)\n\t\tmemmove(mData, mData + aDataSize, mDataUsed - aDataSize);\n\tmDataUsed -= aDataSize;\n}\n\nvoid Debugger::Buffer::Clear()\n{\n\tmDataUsed = 0;\n\tmFailed = FALSE;\n}\n\n\n\nDbgStack::Entry *DbgStack::Push()\n{\n\tif (mTop == mTopBound)\n\t\tExpand();\n\tif (mTop >= mBottom)\n\t{\n\t\t// Whenever this entry != mTop, Entry::line is used instead of g_Debugger.mCurrLine,\n\t\t// which means that it needs to point to the last executed line at that depth. The\n\t\t// following fixes a bug where the line number of this entry appears to revert to\n\t\t// the first line of the function or sub whenever the debugger steps into another\n\t\t// function or sub. Entry::line is also used by Object::Error__New even when the\n\t\t// debugger is disconnected, which has two consequences:\n\t\t// - g_script.mCurrLine must be used in place of g_Debugger.mCurrLine.\n\t\t// - Changing PreExecLine() to update mStack.mTop->line won't help.\n\t\tmTop->line = g_script.mCurrLine;\n\t}\n\treturn ++mTop;\n}\n\nvoid DbgStack::Pop()\n{\n\tASSERT(mTop >= mBottom);\n\t--mTop;\n\tif (mTop >= mBottom)\n\t\tg_script.mCurrLine = g_Debugger.mCurrLine = mTop->line;\n}\n\nvoid DbgStack::Push(LPCTSTR aDesc)\n{\n\tEntry &s = *Push();\n\ts.line = NULL;\n\ts.desc = aDesc;\n\ts.type = SE_Thread;\n}\n\t\nvoid DbgStack::Push(NativeFunc *aFunc)\n{\n\tEntry &s = *Push();\n\ts.line = NULL;\n\ts.func = aFunc;\n\ts.type = SE_BIF;\n}\n\nvoid DbgStack::Push(UDFCallInfo *aUDF)\n{\n\tEntry &s = *Push();\n\ts.line = aUDF->func->mJumpToLine;\n\ts.udf = aUDF;\n\ts.type = SE_UDF;\n}\n\n\nLPCTSTR DbgStack::Entry::Name()\n{\n\tswitch (type)\n\t{\n\tcase SE_UDF:\n\t\treturn udf->func->mName;\n\tcase SE_BIF:\n\t\treturn func->mName;\n\tdefault: // SE_Thread\n\t\treturn desc;\n\t}\n}\n\n\nvoid DbgStack::GetLocalVars(int aDepth, VarList *&aVars, VarList *&aStaticVars, VarBkp *&aBkp, VarBkp *&aBkpEnd)\n{\n\tDbgStack::Entry *se = mTop - aDepth;\n\tfor (;;)\n\t{\n\t\tif (se < mBottom)\n\t\t\treturn;\n\t\tif (se->type == DbgStack::SE_UDF)\n\t\t\tbreak;\n\t\t--se;\n\t}\n\tauto &func = *se->udf->func;\n\taStaticVars = &func.mStaticVars;\n\tif (func.mInstances > 1 && aDepth > 0)\n\t{\n\t\twhile (++se <= mTop)\n\t\t{\n\t\t\tif (se->type == DbgStack::SE_UDF && se->udf->func == &func)\n\t\t\t{\n\t\t\t\t// This instance interrupted the target instance, so its backup\n\t\t\t\t// contains the values of the target instance's local variables.\n\t\t\t\taBkp = se->udf->backup;\n\t\t\t\taBkpEnd = aBkp + se->udf->backup_count;\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\t}\n\t// Since above did not return, this instance wasn't interrupted.\n\taVars = &func.mVars;\n}\n\n\nvoid Debugger::PropertyWriter::WriteProperty(LPCSTR aName, ExprTokenType &aValue)\n{\n\tmProp.fullname.AppendFormat(\".%s\", aName);\n\t_WriteProperty(aValue);\n}\n\n\nvoid Debugger::PropertyWriter::WriteProperty(LPCWSTR aName, ExprTokenType &aValue)\n{\n\tWriteProperty(CStringUTF8FromWChar(aName), aValue);\n}\n\n\nvoid Debugger::PropertyWriter::WriteProperty(ExprTokenType &aKey, ExprTokenType &aValue)\n{\n\tswitch (aKey.symbol)\n\t{\n\tcase SYM_INTEGER: mProp.fullname.AppendFormat(\"[%Ii]\", aKey.value_int64); break;\n\tcase SYM_OBJECT: mProp.fullname.AppendFormat(\"[Object(%Ii)]\", aKey.object); break;\n\tdefault:\n\t\tASSERT(aKey.symbol == SYM_STRING);\n\t\tmDbg.AppendStringKey(mProp.fullname, mNameLength, CStringUTF8FromTChar(aKey.marker));\n\t}\n\t_WriteProperty(aValue);\n}\n\n\nvoid Debugger::PropertyWriter::WriteBaseProperty(IObject *aBase)\n{\n\tmProp.fullname.Append(\".<base>\", 7);\n\t_WriteProperty(mProp.value, aBase);\n}\n\n\nvoid Debugger::PropertyWriter::WriteDynamicProperty(LPTSTR aName)\n{\n\tFuncResult result_token;\n\tauto result = mProp.invokee->Invoke(result_token, IT_GET, aName, mProp.value, nullptr, 0);\n\tif (!result)\n\t\tresult_token.SetValue(_T(\"<error>\"), 7);\n\tmDbg.AppendPropertyName(mProp.fullname, mNameLength, CStringUTF8FromTChar(aName));\n\t_WriteProperty(result_token);\n\tresult_token.Free();\n}\n\n\nvoid Debugger::PropertyWriter::_WriteProperty(ExprTokenType &aValue, IObject *aInvokee)\n{\n\tif (mError)\n\t\treturn;\n\tPropertyInfo prop(mProp.fullname, mProp.value.buf);\n\tif (aInvokee)\n\t\tprop.invokee = aInvokee;\n\t// Find the property's \"relative\" name at the end of the buffer:\n\tprop.name = mProp.fullname.GetString() + mNameLength;\n\tif (*prop.name == '.')\n\t\tprop.name++;\n\t// Write the property (and if it contains an object, any child properties):\n\tprop.value.CopyValueFrom(aValue);\n\tif (aValue.symbol == SYM_OBJECT)\n\t\taValue.object->AddRef();\n\t//prop.page = 0; // \"the childrens pages are always the first page.\"\n\tprop.pagesize = mProp.pagesize;\n\tprop.max_data = mProp.max_data;\n\tprop.max_depth = mProp.max_depth - mDepth;\n\tmError = mDbg.WritePropertyXml(prop);\n\t// Truncate back to the parent property name:\n\tmProp.fullname.Truncate(mNameLength);\n}\n\n\nvoid Debugger::PropertyWriter::BeginProperty(LPCSTR aName, LPCSTR aType, int aNumChildren, DebugCookie &aCookie)\n{\n\tif (mError)\n\t\treturn;\n\n\tmDepth++;\n\n\tif (mDepth == 1) // Write <property> for the object itself.\n\t{\n\t\tLPTSTR classname;\n\t\tLPSTR class_suffix = \"\";\n\t\tif ( mProp.invokee->IsOfType(Object::sPrototype)\n\t\t\t&& (classname = static_cast<Object*>(mProp.invokee)->GetOwnPropString(_T(\"__Class\"))) )\n\t\t\tclass_suffix = \".Prototype\";\n\t\telse\n\t\t\tclassname = mProp.invokee->Type();\n\t\tmError = mDbg.mResponseBuf.WriteF(\"<property name=\\\"%e\\\" fullname=\\\"%e\\\" type=\\\"%s\\\" facet=\\\"%s\\\" classname=\\\"%s%s\\\" address=\\\"%p\\\" size=\\\"0\\\" page=\\\"%i\\\" pagesize=\\\"%i\\\" children=\\\"%i\\\">\"\n\t\t\t\t\t, mProp.name, mProp.fullname.GetString(), aType, mProp.facet, U4T(classname), class_suffix, mProp.invokee, mProp.page, mProp.pagesize, aNumChildren > 0);\n\t\treturn;\n\t}\n\n\t// aName is the raw name of this property. Before writing it into the response,\n\t// convert it to the required expression-like form. Do this conversion within\n\t// mProp.fullname so it can be used for the fullname attribute:\n\tmDbg.AppendPropertyName(mProp.fullname, mNameLength, aName);\n\n\t// Find the property's \"relative\" name at the end of the buffer:\n\tLPCSTR name = mProp.fullname.GetString() + mNameLength;\n\tif (*name == '.')\n\t\tname++;\n\t\n\t// Save length of outer property name and update mNameLength.\n\taCookie = (DebugCookie)mNameLength;\n\tmNameLength = mProp.fullname.GetLength();\n\n\tmError = mDbg.mResponseBuf.WriteF(\"<property name=\\\"%e\\\" fullname=\\\"%e\\\" type=\\\"%s\\\" size=\\\"0\\\" page=\\\"0\\\" pagesize=\\\"%i\\\" children=\\\"%i\\\">\"\n\t\t\t\t, name, mProp.fullname.GetString(), aType, mProp.pagesize, aNumChildren > 0);\n}\n\n\nvoid Debugger::PropertyWriter::EndProperty(DebugCookie aCookie)\n{\n\tif (mError)\n\t\treturn;\n\n\tmDepth--;\n\n\tif (mDepth > 0) // If we just ended a child property...\n\t{\n\t\tmNameLength = (size_t)aCookie; // Restore to the value it had before BeginProperty().\n\t\tmProp.fullname.Truncate(mNameLength);\n\t}\n\t\n\tmError = mDbg.mResponseBuf.Write(\"</property>\");\n}\n\n\nvoid GetScriptStack(LPTSTR aBuf, int aBufSize, DbgStack::Entry *aTop)\n{\n\t*aBuf = '\\0';\n\taBufSize -= 12;\n\tauto aBuf_orig = aBuf;\n\tfor (auto se = aTop ? aTop : g_Debugger.mStack.mTop - 1; se >= g_Debugger.mStack.mBottom; --se)\n\t{\n\t\tauto &line = se->line ? *se->line : *g_script.mCurrLine;\n\t\tauto line_start = aBuf;\n\t\tif (se->type != DbgStack::SE_Thread || se->desc == g_AutoExecuteThreadDesc)\n\t\t{\n\t\t\tauto name = se->Name();\n\t\t\tif (name == g_AutoExecuteThreadDesc)\n\t\t\t\tname = _T(\"\");\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"%s (%i) : [%s] \")\n\t\t\t\t, Line::sSourceFile[line.mFileIndex], (int)line.mLineNumber, name);\n\t\t\taBuf = line.ToText(aBuf, BUF_SPACE_REMAINING, true, 0, false, false);\n\t\t}\n\t\tif (se->type == DbgStack::SE_Thread)\n\t\t{\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"> %s\\r\\n\"), se->desc);\n\t\t}\n\t\tif (BUF_SPACE_REMAINING <= 1) // In case of truncation, there should be 1 char left, since the terminator is not counted.\n\t\t{\n\t\t\taBuf = line_start;\n\t\t\taBufSize += 12;\n\t\t\tsntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"... %i more\"), int(se - g_Debugger.mStack.mBottom) + 1);\n\t\t\tbreak;\n\t\t}\n\t}\n}\n\n\n#endif\n\n\n// Helper for Var::ToText().\n\nLPTSTR Var::ObjectToText(LPTSTR aName, LPTSTR aBuf, int aBufSize)\n{\n\tLPTSTR aBuf_orig = aBuf;\n\taBuf += sntprintf(aBuf, aBufSize, _T(\"%s: %s object\"), aName, mObject->Type());\n\tif (ComObject *cobj = dynamic_cast<ComObject *>(mObject))\n\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\" {wrapper: 0x%IX, vt: 0x%04hX, value: 0x%I64X}\"), cobj, cobj->mVarType, cobj->mVal64);\n\telse\n\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\" {address: 0x%IX}\"), mObject);\n\treturn aBuf;\n}\n"},"size":{"kind":"number","value":96794,"string":"96,794"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":2816,"string":"2,816"},"avg_line_length":{"kind":"number","value":31.24964488636364,"string":"31.249645"},"max_line_length":{"kind":"number","value":207,"string":"207"},"alphanum_fraction":{"kind":"number","value":0.6881982791832542,"string":"0.688198"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11076,"cells":{"id":{"kind":"number","value":16063,"string":"16,063"},"file_name":{"kind":"string","value":"script_object.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_object.cpp"},"content":{"kind":"string","value":"#include \"stdafx.h\" // pre-compiled headers\n#include \"defines.h\"\n#include \"globaldata.h\"\n#include \"script.h\"\n#include \"application.h\"\n\n#include \"script_object.h\"\n#include \"script_func_impl.h\"\n#include \"script_gui.h\"\n#include \"input_object.h\"\n\n#include <errno.h> // For ERANGE.\n#include <initializer_list>\n\n\n//\n// CallMethod - Invoke a method with no parameters, discarding the result.\n//\n\nResultType CallMethod(IObject *aInvokee, IObject *aThis, LPTSTR aMethodName\n\t, ExprTokenType *aParamValue, int aParamCount, __int64 *aRetVal // For event handlers.\n\t, int aExtraFlags, bool aReturnBoolean)\n{\n\tResultToken result_token;\n\tTCHAR result_buf[MAX_NUMBER_SIZE];\n\tresult_token.InitResult(result_buf);\n\n\tExprTokenType this_token(aThis);\n\n\tExprTokenType **param = (ExprTokenType **)_alloca(aParamCount * sizeof(ExprTokenType *));\n\tfor (int i = 0; i < aParamCount; ++i)\n\t\tparam[i] = aParamValue + i;\n\n\tResultType result = aInvokee->Invoke(result_token, IT_CALL | aExtraFlags, aMethodName, this_token, param, aParamCount);\n\n\t// Exceptions are thrown by Invoke for too few/many parameters, but not for non-existent method.\n\t// Check for that here, with the exception that objects are permitted to lack a __Delete method.\n\tif (result == INVOKE_NOT_HANDLED && !(aExtraFlags & IF_BYPASS_METAFUNC))\n\t\tresult = ResultToken().UnknownMemberError(this_token, IT_CALL, aMethodName);\n\n\tif (result != EARLY_EXIT && result != FAIL)\n\t{\n\t\tif (aReturnBoolean)\n\t\t\tresult = TokenToBOOL(result_token) ? CONDITION_TRUE : CONDITION_FALSE;\n\t\telse\n\t\t\t// Indicate to caller whether an integer value was returned (for MsgMonitor()).\n\t\t\tresult = TokenIsEmptyString(result_token) ? OK : EARLY_RETURN;\n\t}\n\t\n\tif (aRetVal) // Always set this as some callers don't initialize it:\n\t\t*aRetVal = result == EARLY_RETURN ? TokenToInt64(result_token) : 0;\n\n\tresult_token.Free();\n\treturn result;\n}\n\n\n//\n// Object::Create - Create a new Object given an array of property name/value pairs.\n//\n\nObject *Object::Create()\n{\n\tObject *obj = new Object();\n\tobj->SetBase(Object::sPrototype);\n\treturn obj;\n}\n\nObject *Object::Create(ExprTokenType *aParam[], int aParamCount, ResultToken *apResultToken)\n{\n\tif (aParamCount & 1)\n\t{\n\t\tapResultToken->Error(ERR_PARAM_COUNT_INVALID);\n\t\treturn NULL; // Odd number of parameters - reserved for future use.\n\t}\n\n\tObject *obj = Object::Create();\n\tif (aParamCount)\n\t{\n\t\tif (aParamCount > 8)\n\t\t\t// Set initial capacity to avoid multiple expansions.\n\t\t\t// For simplicity, failure is handled by the loop below.\n\t\t\tobj->SetInternalCapacity(aParamCount >> 1);\n\t\t// Otherwise, there are 4 or less key-value pairs. When the first\n\t\t// item is inserted, a default initial capacity of 4 will be set.\n\n\t\tTCHAR buf[MAX_NUMBER_SIZE];\n\t\t\n\t\tfor (int i = 0; i + 1 < aParamCount; i += 2)\n\t\t{\n\t\t\tif (aParam[i]->symbol == SYM_MISSING || aParam[i+1]->symbol == SYM_MISSING)\n\t\t\t\tcontinue; // For simplicity and flexibility.\n\n\t\t\tauto name = TokenToString(*aParam[i], buf);\n\n\t\t\tif (!_tcsicmp(name, _T(\"Base\")) && apResultToken)\n\t\t\t{\n\t\t\t\tauto base = dynamic_cast<Object *>(TokenToObject(*aParam[i + 1]));\n\t\t\t\tif (!obj->SetBase(base, *apResultToken))\n\t\t\t\t{\n\t\t\t\t\tobj->Release();\n\t\t\t\t\treturn nullptr;\n\t\t\t\t}\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tif (!obj->SetOwnProp(name, *aParam[i + 1]))\n\t\t\t{\n\t\t\t\tif (apResultToken)\n\t\t\t\t\tapResultToken->MemoryError();\n\t\t\t\tobj->Release();\n\t\t\t\treturn NULL;\n\t\t\t}\n\t\t}\n\t}\n\treturn obj;\n}\n\nObject *Object::CreateStructPtr(UINT_PTR aPtr, Object *aBase, ResultToken &aResultToken)\n{\n\tauto obj = Create();\n\tif (!obj)\n\t{\n\t\taResultToken.MemoryError();\n\t\treturn nullptr;\n\t}\n\tobj->mFlags |= NoCallDelete;\n\tif (!obj->SetBase(aBase, aResultToken))\n\t{\n\t\tobj->Release();\n\t\treturn nullptr;\n\t}\n\tobj->SetDataPtr(aPtr);\n\treturn obj;\n}\n\n\n//\n// Map::Create - Create a new Map given an array of key/value pairs.\n// Map::SetItems - Add or set items given an array of key/value pairs.\n//\n\nMap *Map::Create(ExprTokenType *aParam[], int aParamCount)\n{\n\tASSERT(!(aParamCount & 1));\n\n\tMap *map = new Map();\n\tmap->SetBase(Map::sPrototype);\n\tif (aParamCount && !map->SetItems(aParam, aParamCount))\n\t{\n\t\t// Out of memory.\n\t\tmap->Release();\n\t\treturn NULL;\n\t}\n\treturn map;\n}\n\nResultType Map::SetItems(ExprTokenType *aParam[], int aParamCount)\n{\n\tASSERT(!(aParamCount & 1)); // Caller should verify and throw.\n\n\tif (!aParamCount)\n\t\treturn OK;\n\n\t// Calculate the maximum number of items that will exist after all items are added.\n\t// There may be an excess if some items already exist, so instead of allocating this\n\t// exact amount up front, postpone it until the last possible moment.\n\tindex_t max_capacity_required = mCapacity + (aParamCount >> 1);\n\n\tfor (int i = 0; i + 1 < aParamCount; i += 2)\n\t{\n\t\tif (aParam[i]->symbol == SYM_MISSING || aParam[i+1]->symbol == SYM_MISSING)\n\t\t\tcontinue; // For simplicity and flexibility.\n\n\t\t// See comments above. HasItem() is checked so that the capacity won't be expanded\n\t\t// unnecessarily if all of the remaining items already exist. This produces smaller\n\t\t// code than inlining FindItem()/Assign() here and benchmarks faster than allowing\n\t\t// unnecessary expansion for a case like Map('c',x,'b',x,'a',x).set('a',y,'b',y).\n\t\tif (mCapacity == mCount && !HasItem(*aParam[i]))\n\t\t\tSetInternalCapacity(max_capacity_required);\n\n\t\tif (!SetItem(*aParam[i], *aParam[i + 1]))\n\t\t\treturn FAIL; // Out of memory.\n\t}\n\n\treturn OK;\n}\n\n\n//\n// Cloning\n//\n\n// Helper function for temporary implementation of Clone by Object and subclasses.\n// Should be eliminated once revision of the object model is complete.\nObject *Object::CloneTo(Object &obj)\n{\n\t// Allocate space in destination object.\n\tauto field_count = mFields.Length();\n\tif (field_count && !obj.SetInternalCapacity(field_count))\n\t{\n\t\tobj.Release();\n\t\treturn NULL;\n\t}\n\n\tint failure_count = 0; // See comment below.\n\tindex_t i;\n\n\tobj.mFields.Length() = field_count;\n\n\tfor (i = 0; i < field_count; ++i)\n\t{\n\t\tFieldType &dst = obj.mFields[i];\n\t\tFieldType &src = mFields[i];\n\n\t\t// Copy name.\n\t\tdst.key_c = src.key_c;\n\t\tif ( !(dst.name = _tcsdup(src.name)) )\n\t\t{\n\t\t\t// Rather than trying to set up the object so that what we have\n\t\t\t// so far is valid in order to break out of the loop, continue,\n\t\t\t// make all fields valid and then allow them to be freed. \n\t\t\t++failure_count;\n\t\t}\n\n\t\t// Copy value.\n\t\tif (!dst.InitCopy(src))\n\t\t\t++failure_count;\n\t}\n\tif (failure_count)\n\t{\n\t\t// One or more memory allocations failed. It seems best to return a clear failure\n\t\t// indication rather than an incomplete copy. Now that the loop above has finished,\n\t\t// the object's contents are at least valid and it is safe to free the object:\n\t\tobj.Release();\n\t\treturn NULL;\n\t}\n\tif (mBase)\n\t\tobj.SetBase(mBase);\n\treturn &obj;\n}\n\nMap *Map::CloneTo(Map &obj)\n{\n\tObject::CloneTo(obj);\n\n\tif (!obj.SetInternalCapacity(mCount))\n\t{\n\t\tobj.Release();\n\t\treturn NULL;\n\t}\n\n\tint failure_count = 0; // See Object::CloneT() for comments.\n\tindex_t i;\n\n\tobj.mFlags = mFlags;\n\tobj.mCount = mCount;\n\tobj.mKeyOffsetObject = mKeyOffsetObject;\n\tobj.mKeyOffsetString = mKeyOffsetString;\n\tif (obj.mKeyOffsetObject < 0) // Currently might always evaluate to false.\n\t{\n\t\tobj.mKeyOffsetObject = 0; // aStartOffset excluded all integer and some or all object keys.\n\t\tif (obj.mKeyOffsetString < 0)\n\t\t\tobj.mKeyOffsetString = 0; // aStartOffset also excluded some string keys.\n\t}\n\t//else no need to check mKeyOffsetString since it should always be >= mKeyOffsetObject.\n\n\tfor (i = 0; i < mCount; ++i)\n\t{\n\t\tPair &dst = obj.mItem[i];\n\t\tPair &src = mItem[i];\n\n\t\t// Copy key.\n\t\tif (i >= obj.mKeyOffsetString)\n\t\t{\n\t\t\tdst.key_c = src.key_c;\n\t\t\tif ( !(dst.key.s = _tcsdup(src.key.s)) )\n\t\t\t{\n\t\t\t\t// Key allocation failed. At this point, all int and object keys\n\t\t\t\t// have been set and values for previous items have been copied.\n\t\t\t\t++failure_count;\n\t\t\t}\n\t\t}\n\t\telse \n\t\t{\n\t\t\t// Copy whole key; search \"(IntKeyType)(INT_PTR)\" for comments.\n\t\t\tdst.key = src.key;\n\t\t\tif (i >= obj.mKeyOffsetObject)\n\t\t\t\tdst.key.p->AddRef();\n\t\t}\n\n\t\t// Copy value.\n\t\tif (!dst.InitCopy(src))\n\t\t\t++failure_count;\n\t}\n\tif (failure_count)\n\t{\n\t\tobj.Release();\n\t\treturn NULL;\n\t}\n\treturn &obj;\n}\n\n\n//\n// Array::ToParams - Used for variadic function-calls.\n//\n\n// Copies this array's elements into the parameter list.\n// Caller has ensured param_list can fit aParamCount + Length().\nvoid Array::ToParams(ExprTokenType *token, ExprTokenType **param_list, ExprTokenType **aParam, int aParamCount)\n{\n\tfor (index_t i = 0; i < mLength; ++i)\n\t\tmItem[i].ToToken(token[i]);\n\t\n\tExprTokenType **param_ptr = param_list;\n\tfor (int i = 0; i < aParamCount; ++i)\n\t\t*param_ptr++ = aParam[i]; // Caller-supplied param token.\n\tfor (index_t i = 0; i < mLength; ++i)\n\t\t*param_ptr++ = &token[i]; // New param.\n}\n\nResultType GetEnumerator(IObject *&aEnumerator, ExprTokenType &aEnumerable, int aVarCount, bool aDisplayError)\n{\n\tFuncResult result_token;\n\tExprTokenType t_count(aVarCount), *param[] = { &t_count };\n\tIObject *invokee = TokenToObject(aEnumerable);\n\tif (!invokee)\n\t\tinvokee = Object::ValueBase(aEnumerable);\n\tif (invokee)\n\t{\n\t\t// enum := object.__Enum(number of vars)\n\t\t// IF_NEWENUM causes ComObjects to invoke a _NewEnum method or property.\n\t\t// IF_BYPASS_METAFUNC causes Objects to skip the __Call meta-function if __Enum is not found.\n\t\tauto result = invokee->Invoke(result_token, IT_CALL | IF_NEWENUM | IF_BYPASS_METAFUNC, _T(\"__Enum\"), aEnumerable, param, 1);\n\t\tif (result == FAIL || result == EARLY_EXIT)\n\t\t\treturn result;\n\t\tif (result == INVOKE_NOT_HANDLED)\n\t\t{\n\t\t\taEnumerator = invokee;\n\t\t\taEnumerator->AddRef();\n\t\t\treturn OK;\n\t\t}\n\t\taEnumerator = TokenToObject(result_token);\n\t\tif (aEnumerator)\n\t\t\treturn OK;\n\t}\n\tresult_token.Free();\n\tif (aDisplayError)\n\t\tg_script.RuntimeError(ERR_TYPE_MISMATCH, _T(\"__Enum\"), FAIL, nullptr, ErrorPrototype::Type);\n\treturn FAIL;\n}\n\nResultType CallEnumerator(IObject *aEnumerator, ExprTokenType *aParam[], int aParamCount, bool aDisplayError)\n{\n\tFuncResult result_token;\n\tExprTokenType t_this(aEnumerator);\n\tfor (int i = 0; i < aParamCount; ++i)\n\t\tif (aParam[i]->symbol == SYM_OBJECT)\n\t\t{\n\t\t\tASSERT(dynamic_cast<VarRef *>(aParam[i]->object));\n\t\t\t((VarRef *)aParam[i]->object)->UninitializeNonVirtual(VAR_NEVER_FREE);\n\t\t}\n\tauto result = aEnumerator->Invoke(result_token, IT_CALL, nullptr, t_this, aParam, aParamCount);\n\tif (result == FAIL || result == EARLY_EXIT || result == INVOKE_NOT_HANDLED)\n\t{\n\t\tif (result == INVOKE_NOT_HANDLED && aDisplayError)\n\t\t\treturn g_script.RuntimeError(ERR_NOT_ENUMERABLE, nullptr, FAIL, nullptr, ErrorPrototype::Type); // Object not callable -> wrong type of object.\n\t\treturn result;\n\t}\n\tresult = TokenToBOOL(result_token) ? CONDITION_TRUE : CONDITION_FALSE;\n\tresult_token.Free();\n\treturn result;\n}\n\n// Calls an Enumerator repeatedly and returns an Array of all first-arg values.\n// This is used in conjunction with Array::ToParams to support other objects.\nArray *Array::FromEnumerable(ExprTokenType &aEnumerable)\n{\n\tIObject *enumerator;\n\tauto result = GetEnumerator(enumerator, aEnumerable, 1, true);\n\tif (result == FAIL || result == EARLY_EXIT)\n\t\treturn nullptr;\n\t\n\tauto varref = new VarRef();\n\tExprTokenType tvar { varref }, *param = &tvar;\n\tArray *vargs = Array::Create();\n\tfor (;;)\n\t{\n\t\tauto result = CallEnumerator(enumerator, ¶m, 1, true);\n\t\tif (result == FAIL)\n\t\t{\n\t\t\tvargs->Release();\n\t\t\tvargs = nullptr;\n\t\t\tbreak;\n\t\t}\n\t\tif (result != CONDITION_TRUE)\n\t\t\tbreak;\n\t\tExprTokenType value;\n\t\tvarref->ToTokenSkipAddRef(value);\n\t\tvargs->Append(value);\n\t}\n\tvarref->Release();\n\tenumerator->Release();\n\treturn vargs;\n}\n\n\n//\n// Array::ToStrings - Used by StrSplit.\n//\n\nResultType Array::ToStrings(LPTSTR *aStrings, int &aStringCount, int aStringsMax)\n{\n\tfor (index_t i = 0; i < mLength; ++i)\n\t\tif (SYM_STRING == mItem[i].symbol)\n\t\t\taStrings[i] = mItem[i].string;\n\t\telse\n\t\t\treturn FAIL;\n\taStringCount = mLength;\n\treturn OK;\n}\n\n\n//\n// Object::Delete - Called immediately before the object is deleted.\n//\t\t\t\t\tReturns false if object should not be deleted yet.\n//\n\nbool Object::Delete()\n{\n\tif (mNested && mNested[0] && mRefCount)\n\t{\n\t\t// Let \"outer\" be mNested[0] and \"inner\" be the current object. The circular dependency\n\t\t// is handled by counting inner's reference to outer only while there are external refs\n\t\t// to inner (mRefCount>0). Delete is called when mRefCount==1 about to become 0, meaning\n\t\t// the last external reference is released, and inner must Release outer.\n\t\t// Outer's __delete may rely on the inner objects, and yet inner's __delete can't execute\n\t\t// safely if its DataPtr() points to deleted data. So outer is always destructed first,\n\t\t// and it becomes responsible for recursively destructing inner.\n\t\tmRefCount--; // To reflect that this object doesn't have a counted ref to outer during outer's __delete.\n\t\tbool deleted = mNested[0]->Release() == 0;\n\t\tmRefCount++;\n\t\treturn deleted; // Caller will --mRefCount.\n\t}\n\n\t// __Delete shouldn't be called for Prototype objects. Although it would be more efficient to\n\t// exclusively use the flag, it has been documented that __Delete isn't called if __Class exists.\n\tif (!(mFlags & NoCallDelete) && !FindField(_T(\"__Class\")))\n\t{\n\t\t// L33: Privatize the last recursion layer's deref buffer in case it is in use by our caller.\n\t\t// It's done here rather than in Var::FreeAndRestoreFunctionVars (even though the below might\n\t\t// not actually call any script functions) because this function is probably executed much\n\t\t// less often in most cases.\n\t\tPRIVATIZE_S_DEREF_BUF;\n\n\t\t// If an exception has been thrown, temporarily clear it for execution of __Delete.\n\t\tResultToken *exc = g->ThrownToken;\n\t\tg->ThrownToken = NULL;\n\t\t\n\t\t// This prevents an erroneous \"The current thread will exit\" message when an error occurs,\n\t\t// by causing LineError() to throw an exception:\n\t\tint outer_excptmode = g->ExcptMode;\n\t\tg->ExcptMode |= EXCPTMODE_DELETE;\n\n\t\t{\n\t\t\tFuncResult rt;\n\t\t\tCallMeta(_T(\"__Delete\"), rt, ExprTokenType(this), nullptr, 0);\n\t\t\trt.Free();\n\t\t}\n\n\t\t// Call main destructor and all nested destructors before deleting anything, since an outer\n\t\t// object's nested objects should be assumed valid within the outer object's destructor,\n\t\t// and all objects in the group may rely on the mData of the outer-most object.\n\t\tif (mNested)\n\t\t\tCallNestedDelete();\n\n\t\tg->ExcptMode = outer_excptmode;\n\n\t\t// Exceptions thrown by __Delete are reported immediately because they would not be handled\n\t\t// consistently by the caller (they would typically be \"thrown\" by the next function call),\n\t\t// and because the caller must be allowed to make additional __Delete calls.\n\t\tif (g->ThrownToken)\n\t\t\tg_script.FreeExceptionToken(g->ThrownToken);\n\n\t\t// If an exception has been thrown by our caller, it's likely that it can and should be handled\n\t\t// reliably by our caller, so restore it.\n\t\tif (exc)\n\t\t\tg->ThrownToken = exc;\n\n\t\tDEPRIVATIZE_S_DEREF_BUF; // L33: See above.\n\n\t\t// Above may pass the script a reference to this object to allow cleanup routines to free any\n\t\t// associated resources. Deleting it is only safe if the script no longer holds any references\n\t\t// to it. Since cleanup routines may (intentionally or unintentionally) copy this reference,\n\t\t// ensure this object really has no more references before proceeding with deletion:\n\t\tif (mRefCount > 1)\n\t\t\treturn false;\n\t}\n\n\treturn ObjectBase::Delete();\n}\n\n\nvoid Object::CallNestedDelete()\n{\n\t// Caller has prepared the thread for __Delete to be called directly.\n\tASSERT(mRefCount == 1 && mNested && mBase);\n\tauto si = mBase->GetStructInfo();\n\tfor (auto i = si->nested_count; i > 0; --i)\n\t\tif (mNested[i] && !mNested[i]->mRefCount)\n\t\t{\n\t\t\tFuncResult rt;\n\t\t\t++mRefCount;\n\t\t\t++mNested[i]->mRefCount;\n\t\t\tmNested[i]->CallMeta(_T(\"__Delete\"), rt, ExprTokenType(mNested[i]), nullptr, 0);\n\t\t\trt.Free();\n\t\t\tif (mNested[i]->mNested && mNested[i]->mNested[0])\n\t\t\t\tmNested[i]->CallNestedDelete();\n\t\t\t--mNested[i]->mRefCount;\n\t\t\t--mRefCount;\n\t\t}\n}\n\n\nObject::~Object()\n{\n\tif (mNested)\n\t{\n\t\t// Nested objects have been \"destructed\" but not actually deleted yet.\n\t\tauto si = mBase->GetStructInfo();\n\t\tfor (auto i = si->nested_count; i > 0; --i)\n\t\t\tif (mNested[i] && !mNested[i]->mRefCount)\n\t\t\t\tdelete mNested[i];\n\t\tdelete[] mNested;\n\t}\n\tif (mBase)\n\t\tmBase->Release();\n\tif (mFlags & DataIsAllocatedFlag)\n\t\tfree(mData);\n}\n\n\nvoid Map::Clear()\n{\n\twhile (mCount)\n\t{\n\t\t--mCount;\n\t\t// Copy key before Free() since it might cause re-entry via __delete.\n\t\tauto key = mItem[mCount].key;\n\t\tmItem[mCount].Free();\n\t\tif (mCount >= mKeyOffsetString)\n\t\t\tfree(key.s);\n\t\telse \n\t\t{\n\t\t\t--mKeyOffsetString;\n\t\t\tif (mCount >= mKeyOffsetObject)\n\t\t\t\tkey.p->Release(); // Might also cause re-entry.\n\t\t\telse\n\t\t\t\t--mKeyOffsetObject;\n\t\t}\n\t}\n}\n\n\n//\n// Invoke - dynamic dispatch\n//\n\nObjectMember Object::sMembers[] =\n{\n\tObject_Method1(__Ref, 1, 1),\n\tObject_Method1(Clone, 0, 0),\n\tObject_Method1(DefineProp, 2, 2),\n\tObject_Method1(DeleteProp, 1, 1),\n\tObject_Method1(GetOwnPropDesc, 1, 1),\n\tObject_Method1(HasOwnProp, 1, 1),\n\tObject_Method1(OwnProps, 0, 0),\n\tObject_Method1(Props, 0, 0)\n};\n\nLPTSTR Object::sMetaFuncName[] = { _T(\"__Get\"), _T(\"__Set\"), _T(\"__Call\") };\n\nResultType Object::Invoke(IObject_Invoke_PARAMS_DECL)\n{\n\t// In debug mode, verify aResultToken has been initialized correctly.\n\tASSERT(aResultToken.symbol == SYM_STRING && aResultToken.marker && !*aResultToken.marker);\n\tASSERT(aResultToken.Result() == OK);\n\n\tname_t name;\n\tif (!aName)\n\t{\n\t\tname = IS_INVOKE_CALL ? _T(\"Call\") : _T(\"__Item\");\n\t\taFlags |= IF_BYPASS_METAFUNC;\n\t}\n\telse\n\t\tname = aName;\n\t\n\tResultType result;\n\n\tswitch (INVOKE_TYPE)\n\t{\n\tcase IT_GET: result = GetProperty(aResultToken, aFlags, name, aThisToken, aParam, aParamCount); break;\n\tcase IT_SET: result = SetProperty(aResultToken, aFlags, name, aThisToken, aParam, aParamCount); break;\n\tdefault: result = CallProperty(aResultToken, aFlags, name, aThisToken, aParam, aParamCount); break;\n\t}\n\n\tif (result == INVOKE_NOT_HANDLED && !(aFlags & IF_BYPASS_METAFUNC))\n\t\tresult = CallMetaVarg(aFlags, aName, aResultToken, aThisToken, aParam, aParamCount);\n\n\treturn result;\n}\n\n\nResultType Object::GetProperty(ResultToken &aResultToken, int aFlags, name_t aName, ExprTokenType &aThisToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tIObject *method = nullptr;\n\n\tfor (auto that = this; that; that = that->mBase)\n\t{\n\t\tauto field = that->FindField(aName);\n\t\tif (!field)\n\t\t\tcontinue;\n\n\t\tif (field->symbol != SYM_DYNAMIC || field->prop->NoParamGet)\n\t\t{\n\t\t\tint flag = aParamCount ? IF_BYPASS___VALUE : 0;\n\t\t\tauto result = GetFieldValue(aResultToken, aFlags | flag, *field, aThisToken);\n\t\t\tif (!aParamCount || result != OK)\n\t\t\t\treturn result;\n\t\t\treturn ApplyParams(aResultToken, aFlags, aParam, aParamCount);\n\t\t}\n\t\telse if (auto getter = field->prop->Getter())\n\t\t{\n\t\t\treturn CallEtter(aResultToken, aFlags, getter, aThisToken, aParam, aParamCount);\n\t\t}\n\t\telse if (!method)\n\t\t{\n\t\t\tmethod = field->prop->Method();\n\t\t}\n\t}\n\n\tif (method)\n\t{\n\t\tmethod->AddRef();\n\t\taResultToken.SetValue(method);\n\t\treturn OK;\n\t}\n\n\treturn INVOKE_NOT_HANDLED;\n}\n\n\nResultType Object::GetFieldValue(ResultToken &aResultToken, int aFlags, FieldType &aField, ExprTokenType &aThisToken)\n{\n\tif (aField.symbol == SYM_TYPED_FIELD)\n\t{\n\t\tauto that = GetThisForTypedValue(aResultToken, aFlags, aField.name, aThisToken);\n\t\treturn that ? that->GetTypedValue(aResultToken, aFlags, *aField.tprop) : FAIL;\n\t}\n\telse if (aField.symbol == SYM_DYNAMIC)\n\t{\n\t\tif (aField.prop->Getter())\n\t\t\treturn CallEtter(aResultToken, aFlags, aField.prop->Getter(), aThisToken, nullptr, 0);\n\t\tauto method = aField.prop->Method();\n\t\tmethod->AddRef();\n\t\taResultToken.SetValue(method);\n\t\treturn OK;\n\t}\n\taField.ReturnRef(aResultToken);\n\treturn OK;\n}\n\n\nResultType Object::CallProperty(ResultToken &aResultToken, int aFlags, name_t aName, ExprTokenType &aThisToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tResultToken method_token;\n\tmethod_token.InitResult(aResultToken.buf);\n\tauto result = GetMethodValue(method_token, aFlags, aName, aThisToken);\n\tif (result != INVOKE_NOT_HANDLED)\n\t{\n\t\tif (result == OK)\n\t\t\tresult = CallAsMethod(method_token, aResultToken, aThisToken, aParam, aParamCount);\n\t\tmethod_token.Free();\n\t}\n\treturn result;\n}\n\n\nResultType Object::GetMethodValue(ResultToken &aResultToken, int aFlags, name_t aName, ExprTokenType &aThisToken)\n{\n\tFieldType *getter = nullptr;\n\tfor (auto that = this; that; that = that->mBase)\n\t{\n\t\tauto field = that->FindField(aName);\n\t\tif (!field)\n\t\t\tcontinue;\n\t\tif (field->symbol != SYM_DYNAMIC)\n\t\t{\n\t\t\tgetter = field;\n\t\t\tbreak;\n\t\t}\n\t\tif (auto method = field->prop->Method())\n\t\t{\n\t\t\tmethod->AddRef();\n\t\t\taResultToken.SetValue(method);\n\t\t\treturn OK;\n\t\t}\n\t\tif (!getter && field->prop->Getter())\n\t\t\tgetter = field;\n\t}\n\tif (getter)\n\t\treturn GetFieldValue(aResultToken, (aFlags & ~IT_BITMASK) | IF_BYPASS___VALUE, *getter, aThisToken);\n\treturn INVOKE_NOT_HANDLED;\n}\n\n\nResultType Object::SetProperty(ResultToken &aResultToken, int aFlags, name_t aName, ExprTokenType &aThisToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tObject *that;\n\tindex_t insert_pos, other_pos;\n\tFieldType *field = nullptr;\n\n\tfor (that = this; that; that = that->mBase)\n\t{\n\t\tauto candidate = that->FindField(aName, that == this ? insert_pos : other_pos);\n\t\tif (!candidate)\n\t\t\tcontinue;\n\t\tif (candidate->symbol != SYM_DYNAMIC)\n\t\t{\n\t\t\t// This value property takes precedence over anything inherited from that->mBase,\n\t\t\t// but any previously found getter or method implies that this property is read-only.\n\t\t\tif (!field)\n\t\t\t\tfield = candidate;\n\t\t\tbreak;\n\t\t}\n\t\tauto setter = candidate->prop->Setter();\n\t\tif (setter && !(aParamCount > 1 && candidate->prop->NoParamSet))\n\t\t{\n\t\t\t// Setter hasn't been shadowed by a value/typed property, and either takes parameters\n\t\t\t// or none were passed. If it takes parameters, the search stops here even if there\n\t\t\t// are insufficient parameters to successfully call the setter.\n\t\t\treturn CallEtter(aResultToken, aFlags, setter, aThisToken, aParam, aParamCount);\n\t\t}\n\t\t// Save the first getter in case no setter is found, or the first method if no getters.\n\t\tif ( !(field && field->prop->Getter()) && candidate->prop->Getter()\n\t\t\t|| !field && candidate->prop->Method() )\n\t\t\tfield = candidate;\n\t}\n\n\tif (!field && !(aFlags & IF_BYPASS_METAFUNC))\n\t{\n\t\t// Call __Set before creating a field.\n\t\tauto result = CallMetaVarg(aFlags, aName, aResultToken, aThisToken, aParam, aParamCount);\n\t\tif (result != INVOKE_NOT_HANDLED)\n\t\t\treturn result;\n \t}\n\n\tif (aParamCount > 1)\n\t{\n\t\tif (!field)\n\t\t\treturn INVOKE_NOT_HANDLED;\n\n\t\t// Apply parameters to the property's value, since there is no setter which accepts parameters.\n\t\tauto result = GetFieldValue(aResultToken, (aFlags & ~IT_BITMASK) | IF_BYPASS___VALUE, *field, aThisToken);\n\t\tif (result != OK)\n\t\t\treturn result;\n\t\treturn ApplyParams(aResultToken, aFlags, aParam, aParamCount);\n\t}\n\n\tif (field && field->symbol == SYM_TYPED_FIELD)\n\t{\n\t\tauto that = GetThisForTypedValue(aResultToken, aFlags, aName, aThisToken);\n\t\treturn that ? that->SetTypedValue(aResultToken, aFlags, aName, *field->tprop, **aParam) : FAIL;\n\t}\n\t\n\tif (field && field->symbol == SYM_DYNAMIC || (aFlags & (IF_SUBSTITUTE_THIS | IF_SUPER)))\n\t{\n\t\tif ((aFlags & IF_SUPER) && !(field && field->symbol == SYM_DYNAMIC))\n\t\t{\n\t\t\t// This is `super.x := y` where x is either a value property or undefined.\n\t\t\t// If aThisToken is an Object, use the base Object implementation of set: create a value property.\n\t\t\tif (auto real_this = dynamic_cast<Object *>(TokenToObject(aThisToken)))\n\t\t\t{\n\t\t\t\tif (!real_this->SetOwnProp(aName, **aParam))\n\t\t\t\t\treturn aResultToken.MemoryError();\n\t\t\t\treturn OK;\n\t\t\t}\n\t\t}\n\t\t// This property has a getter but no setter; or either IF_SUBSTITUTE_THIS or IF_SUPER was set and above\n\t\t// did not return, in which case the property should be considered read-only, since it can't be stored\n\t\t// in the actual target object (which is aThisToken, not C++ `this`).\n\t\treturn field ? aResultToken.Error(ERR_PROPERTY_READONLY, aName) : INVOKE_NOT_HANDLED;\n\t}\n\n\tif (this != that)\n\t{\n\t\tif (aFlags & IF_NO_NEW_PROPS)\n\t\t\treturn INVOKE_NOT_HANDLED;\n\t\tif (aParam[0]->symbol == SYM_MISSING)\n\t\t\treturn OK; // No action needed for x.y := unset.\n\t\tif ( !(field = Insert(aName, insert_pos)) )\n\t\t\treturn aResultToken.MemoryError();\n\t}\n\telse if (aParam[0]->symbol == SYM_MISSING) // x.y := unset\n\t{\n\t\t// Completely delete the property, since other sections currently aren't designed to handle properties\n\t\t// with no value (unlike Array and Map items).\n\t\tmFields.Remove((index_t)(field - mFields), 1);\n\t\treturn OK;\n\t}\n\n\treturn field->Assign(**aParam) ? OK : aResultToken.MemoryError();\n}\n\n\nResultType Object::CallEtter(ResultToken &aResultToken, int aFlags, IObject *aEtter, ExprTokenType &aThisToken, ExprTokenType *aParam[], int aParamCount)\n{\n\t// Prepare the parameter list: this, [value,] actual_param*\n\tExprTokenType this_etter(aEtter);\n\tauto prop_param = (ExprTokenType **)_malloca((aParamCount + 1) * sizeof(ExprTokenType *));\n\tif (!prop_param)\n\t\treturn aResultToken.MemoryError();\n\tprop_param[0] = &aThisToken; // For the hidden \"this\" parameter in the getter/setter.\n\tint prop_param_count = 1;\n\tif (IS_INVOKE_SET)\n\t\t// Put the setter's hidden \"value\" parameter before the other parameters.\n\t\tprop_param[prop_param_count++] = aParam[--aParamCount];\n\tmemcpy(prop_param + prop_param_count, aParam, aParamCount * sizeof(ExprTokenType *));\n\tprop_param_count += aParamCount;\n\t// Call getter/setter.\n\tauto result = aEtter->Invoke(aResultToken, IT_CALL, nullptr, this_etter, prop_param, prop_param_count);\n\t_freea(prop_param);\n\tif (result == INVOKE_NOT_HANDLED)\n\t\treturn aResultToken.UnknownMemberError(this_etter, IT_CALL, nullptr);\n\treturn result;\n}\n\n\nObject *Object::GetThisForTypedValue(ResultToken &aResultToken, int aFlags, name_t aName, ExprTokenType &aThisToken)\n{\n\tauto realthis = this;\n\tif (aFlags & (IF_SUBSTITUTE_THIS | IF_SUPER))\n\t\trealthis = dynamic_cast<Object*>(TokenToObject(aThisToken));\n\tif (realthis && realthis->mData && !(realthis->mFlags & DataIsStructInfo))\n\t\treturn realthis;\n\taResultToken.Error(_T(\"Property invalid for object with null data.\"), aName);\n\treturn nullptr;\n}\n\n\nResultType Object::GetTypedValue(ResultToken &aResultToken, int aFlags, TypedProperty &aProp)\n{\n\t// TODO: allow inheriting DataPtr()?\n\tauto ptr = (void*)(DataPtr() + aProp.data_offset);\n\tif (aProp.class_object) // Struct type.\n\t{\n\t\tObject *nested = mNested ? mNested[aProp.object_index] : nullptr;\n\t\tif (!nested) // Since it wasn't constructed, this must be a pointer, not a real struct.\n\t\t{\n\t\t\tauto proto = dynamic_cast<Object*>(aProp.class_object->GetOwnPropObj(_T(\"Prototype\")));\n\t\t\tif (!proto)\n\t\t\t\treturn INVOKE_NOT_HANDLED;\n\t\t\tnested = CreateStructPtr((UINT_PTR)ptr, proto, aResultToken);\n\t\t\tif (!nested)\n\t\t\t\treturn FAIL; // Error was already raised.\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (nested->AddRef() == 1) // First external reference.\n\t\t\t\tthis->AddRef(); // Keep this alive while nested is referenced externally.\n\t\t}\n\t\tif (!(aFlags & IF_BYPASS___VALUE))\n\t\t{\n\t\t\tauto result = nested->Invoke(aResultToken, IT_GET | IF_BYPASS_METAFUNC, _T(\"__value\"), ExprTokenType(nested), nullptr, 0);\n\t\t\tif (result != INVOKE_NOT_HANDLED)\n\t\t\t{\n\t\t\t\tnested->Release(); // This will recursively Release() if appropriate.\n\t\t\t\treturn result;\n\t\t\t}\n\t\t}\n\t\taResultToken.SetValue(nested);\n\t}\n\telse if (aProp.item_count)\n\t{\n\t\tASSERT(aProp.type == MdType::Void); // Untyped buffer.\n\t\taResultToken.SetValue((size_t)ptr);\n\t}\n\telse\n\t{\n\t\tTypedPtrToToken(aProp.type, ptr, aResultToken);\n\t\tASSERT(aResultToken.symbol != SYM_OBJECT); // Shouldn't happen since we don't support typed Object-pointer properties, but if it happened we may need to AddRef().\n\t}\n\treturn OK;\n}\n\n\nResultType Object::SetTypedValue(ResultToken &aResultToken, int aFlags, name_t aName, TypedProperty &aProp, ExprTokenType &aValue)\n{\n\tauto ptr = (void*)(DataPtr() + aProp.data_offset);\n\tif (aProp.class_object)\n\t{\n\t\tObject *nested = mNested[aProp.object_index];\n\t\tmRefCount++; // Must be done at least when nested->mRefCount == 0 (and then reversed when nested->mRefCount reaches 0 again).\n\t\tnested->mRefCount++; // Avoid calling Delete() when the __value setter returns.\n\t\tauto param = &aValue;\n\t\tauto result = nested->Invoke(aResultToken, IT_SET | IF_BYPASS_METAFUNC | IF_NO_NEW_PROPS, _T(\"__Value\"), ExprTokenType(nested), ¶m, 1);\n\t\tnested->mRefCount--;\n\t\tmRefCount--;\n\t\tif (result != INVOKE_NOT_HANDLED)\n\t\t\treturn result;\n\t\treturn aResultToken.Error(_T(\"Assignment to struct is not supported.\"));\n\t}\n\tif (aProp.item_count)\n\t\treturn aResultToken.Error(ERR_PROPERTY_READONLY, aName);\n\treturn SetValueOfTypeAtPtr(aProp.type, ptr, aValue, aResultToken);\n}\n\n\nResultType Object::ApplyParams(ResultToken &aThisResultToken, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t// On input, aThisResultToken contains the value to invoke, having been either retrieved\n\t// from a field or returned from a property getter. Callers rely on us to free any string\n\t// value if appropriate, regardless of whether the recursive invoke succeeds (it might\n\t// succeed if the script has defined String.Prototype.__Item, for instance).\n\tResultToken this_token;\n\tthis_token.CopyValueFrom(aThisResultToken);\n\tthis_token.mem_to_free = aThisResultToken.mem_to_free;\n\taThisResultToken.mem_to_free = nullptr;\n\taThisResultToken.SetValue(_T(\"\"), -1);\n\tauto &aResultToken = aThisResultToken;\n\t\n\tIObject *this_obj = TokenToObject(this_token);\n\tif (!this_obj)\n\t{\n\t\tthis_obj = ValueBase(this_token);\n\t\taFlags |= IF_SUBSTITUTE_THIS;\n\t}\n\n\tauto result = this_obj->Invoke(aResultToken, aFlags, nullptr, this_token, aParam, aParamCount);\n\n\tif (aResultToken.symbol == SYM_STRING && !aResultToken.mem_to_free && aResultToken.marker != aResultToken.buf)\n\t{\n\t\t// Returned strings are sometimes in memory owned by the object, so make a copy\n\t\t// before potentially releasing this_obj via this_token.Free().\n\t\tif (!TokenSetResult(aResultToken, aResultToken.marker, aResultToken.marker_length))\n\t\t\tresult = FAIL;\n\t}\n\n\tif (result == INVOKE_NOT_HANDLED)\n\t{\n\t\t// Something like obj.x[y] where obj.x exists but obj.x[y] does not. Throw here\n\t\t// to override the default error message, which would indicate that \"x\" is unknown.\n\t\tresult = aResultToken.UnknownMemberError(this_token, aFlags, nullptr);\n\t}\n\n\tthis_token.Free();\n\treturn result;\n}\n\n\n\nResultType ObjectBase::Invoke(IObject_Invoke_PARAMS_DECL)\n{\n\tif (auto base = Base())\n\t{\n\t\taFlags |= IF_SUBSTITUTE_THIS;\n\t\treturn base->Invoke(IObject_Invoke_PARAMS);\n\t}\n\treturn INVOKE_NOT_HANDLED;\n}\n\n\n\nvoid Object::CallBuiltin(int aID, ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tswitch (aID)\n\t{\n\tcase FID_ObjOwnPropCount:\treturn PropCount(aResultToken, 0, IT_CALL, aParam, aParamCount);\n\tcase FID_ObjHasOwnProp:\t\treturn HasOwnProp(aResultToken, 0, IT_CALL, aParam, aParamCount);\n\tcase FID_ObjGetCapacity:\treturn GetCapacity(aResultToken, 0, IT_CALL, aParam, aParamCount);\n\tcase FID_ObjSetCapacity:\treturn SetCapacity(aResultToken, 0, IT_CALL, aParam, aParamCount);\n\tcase FID_ObjOwnProps:\t\treturn OwnProps(aResultToken, 0, IT_CALL, aParam, aParamCount);\n\t}\n}\n\n\nObjectMember Map::sMembers[] =\n{\n\tObject_Member(__Item, __Item, 0, IT_SET | BIMF_UNSET_ARG_1, 1, 1),\n\tObject_Member(Capacity, Capacity, 0, IT_SET),\n\tObject_Member(CaseSense, CaseSense, 0, IT_SET),\n\tObject_Member(Count, Count, 0, IT_GET),\n\tObject_Method1(__Enum, 0, 1),\n\tObject_Member(__New, Set, 0, IT_CALL, 0, MAXP_VARIADIC),\n\tObject_Method1(Clear, 0, 0),\n\tObject_Method1(Clone, 0, 0),\n\tObject_Method1(Delete, 1, 1),\n\tObject_Member(Get, __Item, 0, IT_CALL, 1, 2),\n\tObject_Method1(Has, 1, 1),\n\tObject_Method1(Set, 0, MAXP_VARIADIC) // Allow 0 for flexibility with variadic calls.\n};\n\n\nvoid Map::__Item(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (!IS_INVOKE_SET) // Get or call.\n\t{\n\t\tif (!GetItem(aResultToken, *aParam[0]))\n\t\t{\n\t\t\tif (ParamIndexIsOmitted(1))\n\t\t\t{\n\t\t\t\tauto result = Invoke(aResultToken, IT_GET, _T(\"Default\"), ExprTokenType { this }, nullptr, 0);\n\t\t\t\tif (result == INVOKE_NOT_HANDLED)\n\t\t\t\t\t_o_return_unset;\n\t\t\t\treturn;\n\t\t\t}\n\t\t\t// Otherwise, caller provided a default value.\n\t\t\taResultToken.CopyValueFrom(*aParam[1]);\n\t\t}\n\t\tif (aResultToken.symbol == SYM_OBJECT)\n\t\t\taResultToken.object->AddRef();\n\t\treturn;\n\t}\n\telse\n\t{\n\t\tif (aParam[0]->symbol == SYM_MISSING)\n\t\t\treturn Delete(aResultToken, aID, aFlags, aParam + 1, 1);\n\t\tif (!SetItem(*aParam[1], *aParam[0]))\n\t\t\t_o_throw_oom;\n\t}\n}\n\n\nvoid Map::Set(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (aParamCount & 1)\n\t\t_o_throw(ERR_PARAM_COUNT_INVALID);\n\tif (!SetItems(aParam, aParamCount))\n\t\t_o_throw_oom;\n\tAddRef();\n\t_o_return(this);\n}\n\n\n\n//\n// Internal\n//\n\nResultType Object::CallAsMethod(ExprTokenType &aFunc, ResultToken &aResultToken, ExprTokenType &aThisToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tauto func = TokenToObject(aFunc);\n\tif (!func)\n\t\tfunc = ValueBase(aFunc);\n\tExprTokenType **param = (ExprTokenType **)_malloca((aParamCount + 1) * sizeof(ExprTokenType *));\n\tif (!param)\n\t\treturn aResultToken.MemoryError();\n\tparam[0] = &aThisToken;\n\tmemcpy(param + 1, aParam, aParamCount * sizeof(ExprTokenType *));\n\t// return %func%(this, aParam*)\n\tauto invoke_result = func->Invoke(aResultToken, IT_CALL, nullptr, aFunc, param, aParamCount + 1);\n\t_freea(param);\n\treturn invoke_result;\n}\n\nResultType Object::CallMeta(LPTSTR aName, ResultToken &aResultToken, ExprTokenType &aThisToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tIObject *method;\n\tif (method = GetMethod(aName))\n\t{\n\t\treturn CallAsMethod(ExprTokenType(method), aResultToken, aThisToken, aParam, aParamCount);\n\t}\n\treturn INVOKE_NOT_HANDLED;\n}\n\nResultType Object::CallMetaVarg(int aFlags, LPTSTR aName, ResultToken &aResultToken, ExprTokenType &aThisToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tauto func = GetMethod(sMetaFuncName[INVOKE_TYPE]);\n\tif (!func)\n\t\treturn INVOKE_NOT_HANDLED;\n\tif (IS_INVOKE_SET)\n\t\t--aParamCount;\n\tauto vargs = Array::Create(aParam, aParamCount);\n\tif (!vargs)\n\t\treturn aResultToken.MemoryError();\n\tExprTokenType name_token(aName), args_token(vargs), *param[4];\n\tparam[0] = &aThisToken; // this\n\tparam[1] = &name_token; // name\n\tparam[2] = &args_token; // args\n\tint param_count = 3;\n\tif (IS_INVOKE_SET)\n\t\tparam[param_count++] = aParam[aParamCount]; // value\n\t// return %func%(this, name, args [, value])\n\tResultType aResult = func->Invoke(aResultToken, IT_CALL, nullptr, ExprTokenType(func), param, param_count);\n\tvargs->Release();\n\treturn aResult;\n}\n\n\n//\n// Helper function for WinMain()\n//\n\nArray *Array::FromArgV(LPTSTR *aArgV, int aArgC)\n{\n\tExprTokenType *token = (ExprTokenType *)_alloca(aArgC * sizeof(ExprTokenType));\n\tExprTokenType **param = (ExprTokenType **)_alloca(aArgC * sizeof(ExprTokenType*));\n\tfor (int j = 0; j < aArgC; ++j)\n\t{\n\t\ttoken[j].SetValue(aArgV[j]);\n\t\tparam[j] = &token[j];\n\t}\n\treturn Create(param, aArgC);\n}\n\n\n\n//\n// Helper function for StrSplit/WinGetList/WinGetControls\n//\n\nbool Array::Append(ExprTokenType &aValue)\n{\n\tif (mLength == MaxIndex || !EnsureCapacity(mLength + 1))\n\t\treturn false;\n\tauto &item = mItem[mLength++];\n\titem.Minit();\n\treturn item.Assign(aValue);\n}\n\n\n//\n// Helper function used with class definitions.\n//\n\nvoid Object::EndClassDefinition()\n{\n\tauto &obj = *(Object *)GetOwnPropObj(_T(\"Prototype\"));\n\t// Each variable declaration created a 'missing' property in the class or prototype object to prevent\n\t// duplicate or conflicting declarations. Remove them now so that the declaration acts like a normal\n\t// assignment (i.e. invokes property setters and __Set), for flexibility and consistency.\n\tRemoveMissingProperties();\n\tobj.RemoveMissingProperties();\n}\n\nvoid Object::RemoveMissingProperties()\n{\n\tfor (index_t i = mFields.Length(); i > 0; )\n\t{\n\t\ti--;\n\t\tif (mFields[i].symbol == SYM_MISSING)\n\t\t\tmFields.Remove(i, 1);\n\t}\n}\n\n\n\nbool ObjectBase::IsOfType(Object *aPrototype)\n{\n\tauto base = Base();\n\treturn base == aPrototype || base->IsDerivedFrom(aPrototype);\n}\n\nbool Object::IsOfType(Object *aPrototype)\n{\n\treturn aPrototype == Object::sPrototype || (!IsClassPrototype() && IsDerivedFrom(aPrototype));\n}\n\n\nbool Object::IsDerivedFrom(IObject *aBase)\n{\n\tObject *base;\n\tfor (base = mBase; base; base = base->mBase)\n\t\tif (base == aBase)\n\t\t\treturn true;\n\treturn false;\n}\n\n\nObject *Object::GetNativeBase()\n{\n\tObject *base;\n\tfor (base = mBase; base; base = base->mBase)\n\t\tif (base->IsNativeClassPrototype())\n\t\t\treturn base;\n\treturn nullptr;\n}\n\n\nbool Object::CanSetBase(Object *aBase)\n{\n\tauto new_native_base = (!aBase || aBase->IsNativeClassPrototype())\n\t\t? aBase : aBase->GetNativeBase();\n\treturn new_native_base == GetNativeBase() // Cannot change native type.\n\t\t&& !aBase->IsDerivedFrom(this) && aBase != this; // Cannot create loops.\n}\n\n\nResultType Object::SetBase(Object *aNewBase, ResultToken &aResultToken)\n{\n\tif (!CanSetBase(aNewBase))\n\t\treturn aResultToken.ValueError(ERR_INVALID_BASE);\n\tSetBase(aNewBase);\n\treturn OK;\n}\n\n\n//\n// Object::Type() - Returns the object's type/class name.\n//\n\nLPTSTR Object::Type()\n{\n\tObject *base;\n\tif (HasOwnProp(_T(\"__Class\")))\n\t\treturn _T(\"Prototype\"); // This object is a prototype.\n\tfor (base = mBase; base; base = base->mBase)\n\t\tif (auto classname = base->GetOwnPropString(_T(\"__Class\")))\n\t\t\treturn classname; // This object is an instance of that class.\n\treturn _T(\"Object\"); // Provide a default in case __Class has been removed from all of the base objects.\n}\n\n\nObject *Object::CreateClass(Object *aPrototype, Object *aBase)\n{\n\tauto cls = new Object();\n\tcls->SetBase(aBase);\n\tcls->SetOwnProp(_T(\"Prototype\"), aPrototype);\n\treturn cls;\n}\n\n\nObject *Object::CreatePrototype(LPTSTR aClassName, Object *aBase)\n{\n\tauto obj = new Object();\n\tobj->mFlags |= ClassPrototype;\n\tobj->SetOwnProp(_T(\"__Class\"), ExprTokenType(aClassName), false);\n\tobj->SetBase(aBase);\n\treturn obj;\n}\n\n\nObject *Object::CreatePrototype(LPTSTR aClassName, Object *aBase, ObjectMember aMember[], int aMemberCount)\n{\n\tauto obj = CreatePrototype(aClassName, aBase);\n\treturn DefineMembers(obj, aClassName, aMember, aMemberCount);\n}\n\nObject *Object::CreatePrototype(LPTSTR aClassName, Object *aBase, ObjectMemberMd aMember[], int aMemberCount)\n{\n\tauto obj = CreatePrototype(aClassName, aBase);\n\treturn DefineMetadataMembers(obj, aClassName, aMember, aMemberCount);\n}\n\nObject *Object::CreatePrototype(LPTSTR aClassName, Object *aBase, ObjectMemberListType aMember, int aMemberCount)\n{\n\tif (aMember.duck)\n\t\treturn CreatePrototype(aClassName, aBase, aMember.duck, aMemberCount);\n\telse\n\t\treturn CreatePrototype(aClassName, aBase, aMember.meta, aMemberCount);\n}\n\n\nObject *Object::DefineMembers(Object *obj, LPTSTR aClassName, ObjectMember aMember[], int aMemberCount)\n{\n\tif (aMemberCount)\n\t\tobj->mFlags |= NativeClassPrototype;\n\n\tTCHAR full_name[MAX_VAR_NAME_LENGTH + 1];\n\tTCHAR *name = full_name + _stprintf(full_name, _T(\"%s.Prototype.\"), aClassName);\n\n\tfor (int i = 0; i < aMemberCount; ++i)\n\t{\n\t\tconst auto &member = aMember[i];\n\t\t_tcscpy(name, member.name);\n\t\tif (member.invokeType == IT_CALL)\n\t\t{\n\t\t\tauto func = new BuiltInMethod(SimpleHeap::Alloc(full_name));\n\t\t\tfunc->mBIM = member.method;\n\t\t\tfunc->mMID = member.id;\n\t\t\tfunc->mMIT = IT_CALL;\n\t\t\tfunc->mMinParams = member.minParams + 1; // Includes `this`.\n\t\t\tfunc->mIsVariadic = member.maxParams == MAXP_VARIADIC;\n\t\t\tfunc->mParamCount = func->mIsVariadic ? func->mMinParams : member.maxParams + 1;\n\t\t\tfunc->mClass = obj; // AddRef not needed since neither mClass nor our caller's reference to obj is ever Released.\n\t\t\tobj->DefineMethod(member.name, func);\n\t\t\tfunc->Release();\n\t\t}\n\t\telse\n\t\t{\n\t\t\tauto prop = obj->DefineProperty(name);\n\t\t\tprop->NoParamGet = prop->NoParamSet = member.maxParams == 0;\n\t\t\tprop->NoEnumGet = member.minParams > 0;\n\t\t\t\n\t\t\tauto op_name = _tcschr(name, '\\0');\n\n\t\t\t_tcscpy(op_name, _T(\".Get\"));\n\t\t\tauto func = new BuiltInMethod(SimpleHeap::Alloc(full_name));\n\t\t\tfunc->mBIM = member.method;\n\t\t\tfunc->mMID = member.id;\n\t\t\tfunc->mMIT = IT_GET;\n\t\t\tfunc->mMinParams = member.minParams + 1; // Includes `this`.\n\t\t\tfunc->mParamCount = member.maxParams + 1;\n\t\t\tfunc->mIsVariadic = member.maxParams == MAXP_VARIADIC;\n\t\t\tfunc->mClass = obj;\n\t\t\tprop->SetGetter(func);\n\t\t\tfunc->Release();\n\t\t\t\n\t\t\tif ((member.invokeType & IT_BITMASK) == IT_SET) // & allows for additional flags.\n\t\t\t{\n\t\t\t\t_tcscpy(op_name, _T(\".Set\"));\n\t\t\t\tfunc = new BuiltInMethod(SimpleHeap::Alloc(full_name));\n\t\t\t\tfunc->mBIM = member.method;\n\t\t\t\tfunc->mMID = member.id;\n\t\t\t\tfunc->mMIT = member.invokeType;\n\t\t\t\tfunc->mMinParams = member.minParams + 2; // Includes `this` and `value`.\n\t\t\t\tfunc->mParamCount = member.maxParams + 2;\n\t\t\t\tfunc->mIsVariadic = member.maxParams == MAXP_VARIADIC;\n\t\t\t\tfunc->mClass = obj;\n\t\t\t\tprop->SetSetter(func);\n\t\t\t\tfunc->Release();\n\t\t\t}\n\t\t}\n\t}\n\n\treturn obj;\n}\n\nObject *Object::CreateClass(LPTSTR aClassName, Object *aBase, Object *aPrototype, ClassFactoryDef aFactory)\n{\n\tauto class_obj = CreateClass(aPrototype, aBase);\n\n\tif (aFactory.call)\n\t{\n\t\tTCHAR full_name[MAX_VAR_NAME_LENGTH + 1];\n\t\t_stprintf(full_name, _T(\"%s.Call\"), aClassName);\n\t\tauto ctor = new BuiltInFunc(SimpleHeap::Alloc(full_name));\n\t\tctor->mBIF = aFactory.call;\n\t\tctor->mFID = FID_Object_New;\n\t\tctor->mMinParams = aFactory.min_params; // Usually 1, the class object.\n\t\tctor->mParamCount = aFactory.max_params;\n\t\tctor->mIsVariadic = aFactory.is_variadic; // Usually variadic since __new(...) may be redefined/overridden.\n\t\tclass_obj->DefineMethod(_T(\"Call\"), ctor);\n\t\tctor->Release();\n\t}\n\n\tauto var = g_script.FindOrAddVar(aClassName, 0, VAR_DECLARE_GLOBAL | VAR_EXPORTED);\n\tvar->AssignSkipAddRef(class_obj);\n\tvar->MakeReadOnly();\n\n\treturn class_obj;\n}\n\n\n//\n// Object:: and Map:: Built-ins\n//\n\nvoid Object::DeleteProp(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tauto field = FindField(ParamIndexToString(0, _f_number_buf));\n\tif (!field)\n\t\t_o_return_empty;\n\tfield->ReturnMove(aResultToken); // Return the removed value.\n\tmFields.Remove((index_t)(field - mFields), 1);\n\t_o_return_empty;\n}\n\nvoid Map::Delete(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tPair *item;\n\tindex_t pos;\n\tSymbolType key_type;\n\tKey key;\n\n\tif (item = FindItem(*aParam[0], _f_number_buf, key_type, key, pos))\n\t\tpos = index_t(item - mItem); // else min_pos was already set by FindItem.\n\n\tif (!item) // Nothing to remove.\n\t{\n\t\t// Our return value when only one arg is given is supposed to be the value\n\t\t// removed from this[arg], but there wasn't one.\n\t\t_o_return_unset;\n\t}\n\t// Set return value to the removed item.\n\titem->ReturnMove(aResultToken);\n\t// Copy item to temporary memory so that Free() and Release() can be postponed,\n\t// in case they cause re-entry via __delete. ReturnMove() may have transferred\n\t// an object value, but not the key or Property getter/setter.\n\tauto copy = (Pair *)_alloca(sizeof(*item));\n\tmemcpy(copy, item, sizeof(*item));\n\t// Remove item.\n\tmemmove(item, item + 1, (mCount - (pos + 1)) * sizeof(Pair));\n\tmCount--;\n\t// Free item and keys.\n\tcopy->Free();\n\tif (key_type == SYM_STRING)\n\t\tfree(copy->key.s);\n\telse // i.e. SYM_OBJECT or SYM_INTEGER\n\t{\n\t\tmKeyOffsetString--;\n\t\tif (key_type == SYM_INTEGER)\n\t\t\tmKeyOffsetObject--;\n\t\telse\n\t\t\tcopy->key.p->Release();\n\t}\n\t_o_return_retval;\n}\n\n\nvoid Map::Clear(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tClear();\n\t_o_return_empty;\n}\n\n\nvoid Object::PropCount(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t_o_return((__int64)mFields.Length());\n}\n\nvoid Map::Count(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t_o_return((__int64)mCount);\n}\n\nvoid Map::CaseSense(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (IS_INVOKE_GET)\n\t{\n\t\tif (mFlags & MapUseLocale)\n\t\t\t_o_return_p(_T(\"Locale\"));\n\t\tif (mFlags & MapCaseless)\n\t\t\t_o_return_p(_T(\"Off\"));\n\t\t_o_return_p(_T(\"On\"));\n\t}\n\n\t// Do not permit a change of flags if the Map contains string keys, as the expected order\n\t// may not match the actual order. To simplify the error message and documentation,\n\t// the Map must be empty of other types of keys as well.\n\tif (mCount)\n\t\t_o_throw(_T(\"Map must be empty\"));\n\n\tswitch (TokenToStringCase(*aParam[0]))\n\t{\n\tcase SCS_SENSITIVE:\n\t\tmFlags &= ~(MapCaseless | MapUseLocale);\n\t\tbreak;\n\tcase SCS_INSENSITIVE_LOCALE:\n\t\tmFlags |= (MapCaseless | MapUseLocale);\n\t\tbreak;\n\tcase SCS_INSENSITIVE:\n\t\tmFlags = (mFlags | MapCaseless) & ~MapUseLocale;\n\t\tbreak;\n\tdefault:\n\t\t_o_throw(ERR_INVALID_VALUE, *aParam[0], ErrorPrototype::Value);\n\t}\n}\n\nvoid Object::GetCapacity(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t_o_return(mFields.Capacity());\n}\n\nvoid Object::SetCapacity(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (!ParamIndexIsNumeric(0))\n\t{\n\t\taResultToken.ParamError(1, aParam[0], _T(\"Number\")); // Param index differs because this is actually the global function ObjSetCapacity().\n\t\treturn;\n\t}\n\n\tindex_t desired_count = (index_t)ParamIndexToInt64(0);\n\tif (desired_count < mFields.Length())\n\t{\n\t\t// It doesn't seem intuitive to allow SetCapacity to truncate the fields array, so just reallocate\n\t\t// as necessary to remove any unused space. Allow negative values since SetCapacity(-1) seems more\n\t\t// intuitive than SetCapacity(0) when the contents aren't being discarded.\n\t\tdesired_count = mFields.Length();\n\t}\n\tif (desired_count == 0)\n\t{\n\t\tmFields.Free();\n\t\tASSERT(desired_count == mFields.Capacity());\n\t}\n\tif (desired_count == mFields.Capacity() || SetInternalCapacity(desired_count))\n\t{\n\t\t_o_return(mFields.Capacity());\n\t}\n\t// At this point, failure isn't critical since nothing is being stored yet. However, it might be easier to\n\t// debug if an error is thrown here rather than possibly later, when the array attempts to resize itself to\n\t// fit new items. This also avoids the need for scripts to check if the return value is less than expected:\n\t_o_throw_oom;\n}\n\nvoid Map::Capacity(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (IS_INVOKE_GET)\n\t{\n\t\t_o_return(mCapacity);\n\t}\n\n\tif (!ParamIndexIsNumeric(0))\n\t\t_o_throw_type(_T(\"Number\"), *aParam[0]);\n\n\tindex_t desired_count = (index_t)ParamIndexToInt64(0);\n\tif (desired_count < mCount)\n\t{\n\t\t// It doesn't seem intuitive to allow SetCapacity to truncate the item array, so just reallocate\n\t\t// as necessary to remove any unused space. Allow negative values since SetCapacity(-1) seems more\n\t\t// intuitive than SetCapacity(0) when the contents aren't being discarded.\n\t\tdesired_count = mCount;\n\t}\n\tif (!desired_count)\n\t{\n\t\tif (mItem)\n\t\t{\n\t\t\tfree(mItem);\n\t\t\tmItem = nullptr;\n\t\t\tmCapacity = 0;\n\t\t}\n\t\t//else mCapacity should already be 0.\n\t\t// Since mCapacity and desired_size are both 0, below will return 0 and won't call SetInternalCapacity.\n\t}\n\tif (desired_count == mCapacity || SetInternalCapacity(desired_count))\n\t{\n\t\t_o_return(mCapacity);\n\t}\n\t// At this point, failure isn't critical since nothing is being stored yet. However, it might be easier to\n\t// debug if an error is thrown here rather than possibly later, when the array attempts to resize itself to\n\t// fit new items. This also avoids the need for scripts to check if the return value is less than expected:\n\t_o_throw_oom;\n}\n\nvoid Object::OwnProps(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t_o_return(new IndexEnumerator(this, ParamIndexToOptionalInt(0, 0)\n\t\t, static_cast<IndexEnumerator::Callback>(&Object::GetEnumProp)));\n}\n\nvoid Object::Props(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t_o_return(new PropEnum(this));\n}\n\nvoid Map::__Enum(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t_o_return(new IndexEnumerator(this, ParamIndexToOptionalInt(0, 0)\n\t\t, static_cast<IndexEnumerator::Callback>(&Map::GetEnumItem)));\n}\n\nvoid Object::HasOwnProp(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\t_o_return(FindField(ParamIndexToString(0, _f_number_buf)) != nullptr);\n}\n\nvoid Map::Has(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tSymbolType key_type;\n\tKey key;\n\tindex_t insert_pos;\n\tauto item = FindItem(*aParam[0], _f_number_buf, /*out*/ key_type, /*out*/ key, /*out*/ insert_pos);\n\t_o_return(item != nullptr);\n}\n\nvoid Object::Clone(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (GetNativeBase() != Object::sPrototype)\n\t\t_o_throw(ERR_TYPE_MISMATCH, ErrorPrototype::Type); // Cannot construct an instance of this class using Object::Clone().\n\tauto clone = new Object();\n\tif (!CloneTo(*clone))\n\t\t_o_throw_oom;\t\n\t_o_return(clone);\n}\n\nvoid Map::Clone(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tauto clone = new Map();\n\tif (!CloneTo(*clone))\n\t\t_o_throw_oom;\n\t_o_return(clone);\n}\n\nbool Object::DefineMethod(name_t aName, IObject *aFunc)\n{\n\tif (auto prop = DefineProperty(aName))\n\t{\n\t\tprop->SetMethod(aFunc);\n\t\treturn true;\n\t}\n\treturn false;\n}\n\nProperty *Object::DefineProperty(name_t aName, bool aEnumerable)\n{\n\tindex_t insert_pos;\n\tauto field = FindField(aName, insert_pos);\n\tif (!field && !(field = Insert(aName, insert_pos)))\n\t\treturn nullptr;\n\tfield->enumerable = aEnumerable;\n\tif (field->symbol != SYM_DYNAMIC)\n\t{\n\t\tfield->Free();\n\t\tfield->symbol = SYM_DYNAMIC;\n\t\tfield->prop = new Property();\n\t}\n\treturn field->prop;\n}\n\nTypedProperty *Object::DefineTypedProperty(name_t aName)\n{\n\tindex_t insert_pos;\n\tauto field = FindField(aName, insert_pos);\n\tif (!field && !(field = Insert(aName, insert_pos)))\n\t\treturn nullptr;\n\tif (field->symbol != SYM_TYPED_FIELD)\n\t{\n\t\tfield->Free();\n\t\tfield->symbol = SYM_TYPED_FIELD;\n\t\tfield->tprop = new TypedProperty();\n\t}\n\treturn field->tprop;\n}\n\nFResult Object::DefineTypedProperty(name_t aName, MdType aType, Object *aClass, size_t aCount)\n{\n\tsize_t psize = 0, palign = 0;\n\tif (aClass)\n\t{\n\t\tif (auto proto = dynamic_cast<Object*>(aClass->GetOwnPropObj(_T(\"Prototype\"))))\n\t\t{\n\t\t\tif (auto psi = proto->GetStructInfo())\n\t\t\t{\n\t\t\t\tpsize = psi->size;\n\t\t\t\tpalign = psi->align;\n\t\t\t}\n\t\t}\n\t}\n\telse if (aCount)\n\t{\n\t\tif (aType == MdType::Void)\n\t\t{\n\t\t\tpsize = aCount;\n\t\t\tpalign = 1;\n\t\t}\n\t}\n\telse\n\t{\n\t\tpalign = psize = TypeSize(aType);\n\t}\n\tif (!psize)\n\t\treturn FR_E_ARGS;\n\tauto si = GetStructInfo(true);\n\tif (!si || (mFlags & StructInfoLocked))\n\t\treturn FR_E_FAILED;\n\tauto tprop = DefineTypedProperty(aName);\n\tif (!tprop)\n\t\treturn FR_E_OUTOFMEM;\n\ttprop->type = aType;\n\tif (tprop->class_object = aClass)\n\t{\n\t\ttprop->object_index = ++si->nested_count; // 1-based, as index 0 is reserved.\n\t\taClass->AddRef();\n\t}\n\ttprop->item_count = aCount;\n\tif (palign > si->align) // TODO: allow overriding struct packing\n\t\tsi->align = palign;\n\tASSERT(palign && ((palign & (palign - 1)) == 0)); // Must be a power of 2.\n\tsi->size = (si->size + palign - 1) & ~(palign - 1);\n\ttprop->data_offset = si->size;\n\tsi->size += psize; // size may be unaligned until the struct definition is closed (if palign < si-align).\n\treturn OK;\n}\n\nObject::StructInfo *Object::GetStructInfo(bool aDefine)\n{\n\tif (!aDefine)\n\t{\n\t\tif (!(mFlags & StructInfoLocked))\n\t\t{\n\t\t\tmFlags |= StructInfoLocked; // Permit no further changes now that there is a dependent struct instance or definition.\n\t\t\tif (mFlags & DataIsStructInfo)\n\t\t\t{\n\t\t\t\t// Apply the struct's final alignment requirement to its size.\n\t\t\t\tauto si = (StructInfo*)mData;\n\t\t\t\tsi->size = (si->size + si->align - 1) & ~(si->align - 1);\n\t\t\t}\n\t\t}\n\t}\n\tif (!(mFlags & DataIsStructInfo))\n\t{\n\t\tauto bsi = mBase ? mBase->GetStructInfo(false) : nullptr;\n\t\tif (mFlags & DataIsSetFlag)\n\t\t\treturn aDefine ? nullptr : bsi;\n\t\tauto si = (StructInfo*)malloc(sizeof(StructInfo));\n\t\tif (!si)\n\t\t\treturn nullptr;\n\t\tif (bsi)\n\t\t{\n\t\t\t*si = *bsi;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tsi->size = 0;\n\t\t\tsi->align = 1;\n\t\t\tsi->nested_count = 0;\n\t\t}\n\t\tmData = si;\n\t\tmFlags |= DataIsStructInfo | DataIsAllocatedFlag;\n\t}\n\treturn (StructInfo*)mData;\n}\n\nResultType FillPropertyFlags(IObject *aObj, bool aSetter, Property &aProp, ResultToken &aResultToken)\n{\n\tbool &no_param = aSetter ? aProp.NoParamSet : aProp.NoParamGet;\n\tno_param = false; // Reset to default, in case of error or undefined MaxParams.\n\t__int64 propval;\n\tResultType result;\n\tif (!aSetter)\n\t{\n\t\taProp.NoEnumGet = false; // Reset to default, in case of error or undefined MaxParams.\n\t\tpropval = 0;\n\t\tresult = GetObjectIntProperty(aObj, _T(\"MinParams\"), propval, aResultToken, true);\n\t\tswitch (result)\n\t\t{\n\t\tcase FAIL:\n\t\tcase EARLY_EXIT:\n\t\t\treturn result;\n\t\tcase OK:\n\t\t\taProp.NoEnumGet = propval > 1;\n\t\t}\n\t}\n\tpropval = 0;\n\tresult = GetObjectIntProperty(aObj, _T(\"MaxParams\"), propval, aResultToken, true);\n\tswitch (result)\n\t{\n\tcase FAIL:\n\tcase EARLY_EXIT:\n\t\treturn result;\n\tcase OK:\n\t\tno_param = propval == (aSetter ? 2 : 1);\n\t\tif (!no_param)\n\t\t\tbreak; // No need to query IsVariadic.\n\t\tpropval = 0;\n\t\tresult = GetObjectIntProperty(aObj, _T(\"IsVariadic\"), propval, aResultToken, true);\n\t\tswitch (result)\n\t\t{\n\t\tcase FAIL:\n\t\tcase EARLY_EXIT:\n\t\t\treturn result;\n\t\tcase OK:\n\t\t\tif (propval)\n\t\t\t\tno_param = false; // Reset to false; property accepts parameters.\n\t\t}\n\t}\n\treturn OK;\n}\n\nvoid Object::DefineProp(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tauto name = ParamIndexToString(0, _f_number_buf);\n\tif (!*name)\n\t\t_o_throw_param(0);\n\tExprTokenType getter, setter, method, value;\n\tgetter.symbol = SYM_INVALID;\n\tsetter.symbol = SYM_INVALID;\n\tmethod.symbol = SYM_INVALID;\n\tvalue.symbol = SYM_INVALID;\n\tauto desc = dynamic_cast<Object *>(ParamIndexToObject(1));\n\tif (desc && desc->GetOwnProp(value, _T(\"Type\"))) // TODO: make this properly mutually exclusive with the others\n\t{\n\t\tObject *pclass = dynamic_cast<Object*>(TokenToObject(value));\n\t\tMdType ptype = pclass ? MdType::Void : TypeCode(TokenToString(value));\n\t\tsize_t pcount = (ptype == MdType::Void) ? (size_t)TokenToInt64(value) : 0;\n\t\tswitch (DefineTypedProperty(name, ptype, pclass, pcount))\n\t\t{\n\t\tcase OK:\n\t\t\tAddRef();\n\t\t\t_o_return(this);\n\t\tcase FR_E_ARGS:\n\t\t\t_o_throw_param(1);\n\t\tcase FR_E_OUTOFMEM:\n\t\t\t_o_throw_oom;\n\t\tdefault:\n\t\t\t_o_throw(_T(\"Cannot add typed property.\"));\n\t\t}\n\t}\n\tif (!desc // Must be an Object.\n\t\t|| desc->GetOwnProp(getter, _T(\"Get\")) && getter.symbol != SYM_OBJECT // If defined, must be an object.\n\t\t|| desc->GetOwnProp(setter, _T(\"Set\")) && setter.symbol != SYM_OBJECT\n\t\t|| desc->GetOwnProp(method, _T(\"Call\")) && method.symbol != SYM_OBJECT\n\t\t|| desc->GetOwnProp(value, _T(\"Value\")) && (getter.symbol != SYM_INVALID || setter.symbol != SYM_INVALID || method.symbol != SYM_INVALID)\n\t\t// To help prevent errors, throw if none of the above properties were present. This also serves to\n\t\t// reserve some cases for possible future use, such as passing a function object to imply {get:...}.\n\t\t|| getter.symbol == SYM_INVALID && setter.symbol == SYM_INVALID && method.symbol == SYM_INVALID && value.symbol == SYM_INVALID)\n\t\t_o_throw_param(1);\n\tif (value.symbol != SYM_INVALID) // Above already verified that neither Get nor Set was present.\n\t{\n\t\tif (!SetOwnProp(name, value))\n\t\t\t_o_throw_oom;\n\t\tAddRef();\n\t\t_o_return(this);\n\t}\n\tauto prop = DefineProperty(name);\n\tif (!prop)\n\t\t_o_throw_oom;\n\tif (getter.symbol == SYM_OBJECT)\n\t{\n\t\tprop->SetGetter(getter.object);\n\t\tFillPropertyFlags(getter.object, false, *prop, aResultToken);\n\t}\n\tif (setter.symbol == SYM_OBJECT)\n\t{\n\t\tprop->SetSetter(setter.object);\n\t\tFillPropertyFlags(setter.object, true, *prop, aResultToken);\n\t}\n\tif (method.symbol == SYM_OBJECT)\n\t{\n\t\tprop->SetMethod(method.object);\n\t}\n\tAddRef();\n\t_o_return(this);\n}\n\nvoid Object::GetOwnPropDesc(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tauto name = ParamIndexToString(0, _f_number_buf);\n\tif (!*name)\n\t\t_o_throw_param(0);\n\tauto field = FindField(name);\n\tif (!field)\n\t\t_o__ret(aResultToken.UnknownMemberError(ExprTokenType(this), IT_GET, name));\n\tauto desc = Object::Create();\n\tdesc->SetInternalCapacity(field->symbol == SYM_DYNAMIC ? 3 : 1);\n\tif (field->symbol == SYM_DYNAMIC)\n\t{\n\t\tif (auto getter = field->prop->Getter()) desc->SetOwnProp(_T(\"Get\"), getter);\n\t\tif (auto setter = field->prop->Setter()) desc->SetOwnProp(_T(\"Set\"), setter);\n\t\tif (auto method = field->prop->Method()) desc->SetOwnProp(_T(\"Call\"), method);\n\t}\n\telse if (field->symbol == SYM_TYPED_FIELD)\n\t{\n\t\tif (field->tprop->class_object)\n\t\t\tdesc->SetOwnProp(_T(\"Type\"), field->tprop->class_object);\n\t\telse if (field->tprop->type != MdType::Void)\n\t\t\tdesc->SetOwnProp(_T(\"Type\"), TypeName(field->tprop->type));\n\t\telse\n\t\t\tdesc->SetOwnProp(_T(\"Type\"), (__int64)field->tprop->item_count);\n\t\tdesc->SetOwnProp(_T(\"Offset\"), field->tprop->data_offset);\n\t}\n\telse\n\t{\n\t\tExprTokenType value;\n\t\tfield->ToToken(value);\n\t\tdesc->SetOwnProp(_T(\"Value\"), value);\n\t}\n\t_o_return(desc);\n}\n\nvoid NewPropRef(ResultToken &aResultToken, IObject *aObj, LPCTSTR aName)\n{\n\tauto new_name = _tcsdup(aName);\n\tif (!new_name)\n\t\t_f_throw_oom;\n\taObj->AddRef();\n\t_f_return(new PropRef(aObj, new_name));\n}\n\nvoid Object::__Ref(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tauto name = ParamIndexToString(0, _f_retval_buf);\n\tif (!*name)\n\t\t_f_throw_param(0);\n\n\tfor (Object *that = this; that; that = that->mBase)\n\t{\n\t\tif (auto field = that->FindField(name))\n\t\t{\n\t\t\tif (field->symbol != SYM_TYPED_FIELD || !field->tprop->class_object)\n\t\t\t\tbreak;\n\t\t\tObject *nested = mNested[field->tprop->object_index];\n\t\t\tif (!nested)\n\t\t\t\tbreak;\n\t\t\tif (nested->AddRef() == 1) // Nested objects have this unique requirement.\n\t\t\t\tthis->AddRef();\n\t\t\t_o_return(nested);\n\t\t}\n\t}\n\n\tNewPropRef(aResultToken, this, name);\n}\n\nBIF_DECL(PropRef_Call)\n{\n\t++aParam, --aParamCount; // Exclude \"PropRef\" itself.\n\tauto that = ParamIndexToObject(0);\n\tif (!that)\n\t\t_f_throw_param(0, _T(\"object\"));\n\tauto name = ParamIndexToString(1, _f_retval_buf);\n\tif (!*name)\n\t\t_f_throw_param(1);\n\tNewPropRef(aResultToken, that, name);\n}\n\nvoid PropRef::__Value(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (mThat->Invoke(aResultToken, aFlags, mMember, ExprTokenType(mThat), aParam, aParamCount) == INVOKE_NOT_HANDLED)\n\t\t_o_return_unset;\n}\n\n\n//\n// Class objects\n//\n\nResultType Object::New(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount, Object *aOuter)\n{\n\tObject *base = dynamic_cast<Object *>(ParamIndexToObject(0));\n\tObject *proto = base ? dynamic_cast<Object *>(base->GetOwnPropObj(_T(\"Prototype\"))) : nullptr;\n\tif (!proto)\n\t{\n\t\tRelease();\n\t\treturn aResultToken.ParamError(0, aParam[0]);\n\t}\n\tif (!SetBase(proto, aResultToken))\n\t{\n\t\tRelease();\n\t\treturn FAIL;\n\t}\n\tif (auto si = proto->GetStructInfo()) // Typed properties are defined.\n\t{\n\t\tif (!mData && si->size)\n\t\t{\n\t\t\tif (FAILED(AllocDataPtr(si->size)))\n\t\t\t{\n\t\t\t\tRelease();\n\t\t\t\treturn aResultToken.MemoryError();\n\t\t\t}\n\t\t\tZeroMemory((void*)DataPtr(), DataSize());\n\t\t}\n\t\tif (si->nested_count)\n\t\t{\n\t\t\tmNested = new (std::nothrow) Object * [si->nested_count + 1];\n\t\t\tif (!mNested)\n\t\t\t{\n\t\t\t\tRelease();\n\t\t\t\treturn aResultToken.MemoryError();\n\t\t\t}\n\t\t\tZeroMemory(mNested, sizeof(Object *) * (si->nested_count + 1));\n\t\t\tauto result = NestedNew(aResultToken, si);\n\t\t\tif (result != OK)\n\t\t\t\treturn result;\n\t\t}\n\t}\n\tif (aOuter)\n\t{\n\t\tif (!mNested)\n\t\t{\n\t\t\tmNested = new (std::nothrow) Object * [1];\n\t\t\tif (!mNested)\n\t\t\t{\n\t\t\t\tRelease();\n\t\t\t\treturn aResultToken.MemoryError();\n\t\t\t}\n\t\t}\n\t\tmNested[0] = aOuter;\n\t\taOuter->AddRef();\n\t}\n\treturn Construct(aResultToken, aParam + 1, aParamCount - 1);\n}\n\nResultType Object::NestedNew(ResultToken &aResultToken, StructInfo *si)\n{\n\tASSERT(si->nested_count && mNested);\n\t\n\t// TODO: probably make an ordered list in si during definition (or when the struct definition is finalized) instead of this?\n\tauto offsets = (size_t*)_alloca(sizeof(size_t) * si->nested_count);\n\tZeroMemory(offsets, sizeof(size_t) * si->nested_count);\n\n\t// First pass: gather class objects into definition order.\n\tfor (auto base = mBase; base; base = base->mBase)\n\t{\n\t\tif (!(base->mFlags & DataIsStructInfo))\n\t\t\tcontinue;\n\t\tfor (index_t i = 0; i < base->mFields.Length(); ++i)\n\t\t{\n\t\t\tauto &field = base->mFields[i];\n\t\t\tif (field.symbol == SYM_TYPED_FIELD && field.tprop->class_object)\n\t\t\t{\n\t\t\t\tASSERT(field.tprop->object_index <= si->nested_count);\n\t\t\t\tASSERT(!mNested[field.tprop->object_index]); // Should always be null since every new property gets a new object_index, even if it shadows a base property.\n\t\t\t\tmNested[field.tprop->object_index] = field.tprop->class_object;\n\t\t\t\toffsets[field.tprop->object_index - 1] = field.tprop->data_offset;\n\t\t\t}\n\t\t}\n\t}\n\n\tauto data_ptr = DataPtr();\n\n\t// Second pass: construct objects.\n\tResultType result;\n\tsize_t i;\n\tfor (i = 1; i <= si->nested_count; ++i)\n\t{\n\t\tif (!mNested[i]) // Possible in case of redefinition via DefineProp.\n\t\t\tcontinue;\n\t\t// TODO: support native types other than Object\n\t\tauto nested = Object::Create();\n\t\tif (!nested)\n\t\t{\n\t\t\tresult = aResultToken.MemoryError();\n\t\t\tbreak;\n\t\t}\n\t\tnested->SetDataPtr(data_ptr + offsets[i-1]);\n\t\tExprTokenType prop_class { mNested[i] }, *pcarg {&prop_class};\n\t\tresult = nested->New(aResultToken, &pcarg, 1, this);\n\t\tif (result != OK)\n\t\t\tbreak;\n\t\t// During construction, 'nested' has a non-zero mRefCount and a counted reference to 'this'.\n\t\t// Now it needs to have mRefCount == 0 to reflect that there aren't any external references.\n\t\tnested->mRefCount--;\n\t\tmRefCount--;\n\t\taResultToken.symbol = SYM_INTEGER; // New has set this to nested. Reset to default without calling Release().\n\t\tASSERT(nested->mRefCount == 0 && mRefCount);\n\t\tmNested[i] = nested;\n\t}\n\tif (i <= si->nested_count)\n\t{\n\t\tASSERT(result != OK);\n\t\t// Clear any pointers stored in the first pass, since AddRef() wasn't called.\n\t\tdo mNested[i++] = nullptr; while (i <= si->nested_count);\n\t\t// this object won't be returned, since construction failed.\n\t\tRelease();\n\t}\n\treturn result;\n}\n\nResultType Object::Construct(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tExprTokenType this_token(this);\n\tResultType result;\n\n\t// __Init was added so that instance variables can be initialized in the correct order\n\t// (beginning at the root class and ending at class_object) before __New is called.\n\t// It shouldn't be explicitly defined by the user, but auto-generated in DefineClassVars().\n\tresult = CallMeta(_T(\"__Init\"), aResultToken, this_token, nullptr, 0);\n\tif (result != INVOKE_NOT_HANDLED)\n\t{\n\t\t// It's possible that __Init is user-defined (despite recommendations in the\n\t\t// documentation) or built-in, so make sure the return value, if any, is freed:\n\t\taResultToken.Free();\n\t\t// Reset to defaults for __New, invoked below.\n\t\taResultToken.InitResult(aResultToken.buf);\n\t\tif (result == FAIL || result == EARLY_EXIT) // Checked only after Free() and InitResult() as caller might expect mem_to_free == NULL.\n\t\t{\n\t\t\tRelease();\n\t\t\treturn aResultToken.SetExitResult(result); // SetExitResult is necessary because result was reset by InitResult.\n\t\t}\n\t}\n\n\treturn ConstructNoInit(aResultToken, aParam, aParamCount, this_token);\n}\n\nResultType Object::ConstructNoInit(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount, ExprTokenType &aThisToken)\n{\n\t// __New may be defined by the script for custom initialization code.\n\tauto result = CallMeta(_T(\"__New\"), aResultToken, aThisToken, aParam, aParamCount);\n\taResultToken.Free();\n\tif (result == INVOKE_NOT_HANDLED && aParamCount)\n\t{\n\t\t// Maybe the caller expects the parameters to be used in some way, but they won't\n\t\t// since there's no __New. Treat it the same as having __New without parameters.\n\t\tresult = aResultToken.Error(ERR_TOO_MANY_PARAMS);\n\t}\n\tif (result == FAIL || result == EARLY_EXIT)\n\t{\n\t\t// An error was raised within __New() or while trying to call it, or Exit was called.\n\t\tRelease();\n\t\treturn result;\n\t}\n\n\taResultToken.SetValue(this); // No AddRef() since Object::New() would need to Release().\n\treturn aResultToken.SetResult(OK);\n}\n\nBIF_DECL(Any___Init)\n{\n\t_f_return_empty;\n}\n\n\n//\n// Object::Variant\n//\n\nvoid Object::Variant::Minit()\n{\n\tsymbol = SYM_MISSING;\n\tnew (&string) String();\n}\n\nvoid Object::Variant::AssignEmptyString()\n{\n\tFree();\n\tsymbol = SYM_STRING;\n\tnew (&string) String();\n}\n\nvoid Object::Variant::AssignMissing()\n{\n\tFree();\n\tMinit();\n}\n\nbool Object::Variant::Assign(LPTSTR str, size_t len, bool exact_size)\n{\n\tif (len == -1)\n\t\tlen = _tcslen(str);\n\n\tif (!len) // Check len, not *str, since it might be binary data or not null-terminated.\n\t{\n\t\tAssignEmptyString();\n\t\treturn true;\n\t}\n\n\tif (symbol != SYM_STRING || len >= string.Capacity())\n\t{\n\t\tAssignEmptyString(); // Free object or previous buffer (which was too small).\n\n\t\tsize_t new_size = len + 1;\n\t\tif (!exact_size)\n\t\t{\n\t\t\t// Use size calculations equivalent to Var:\n\t\t\tif (new_size < 16)\n\t\t\t\tnew_size = 16; // 16 seems like a good size because it holds nearly any number. It seems counterproductive to go too small because each malloc has overhead.\n\t\t\telse if (new_size < MAX_PATH)\n\t\t\t\tnew_size = MAX_PATH; // An amount that will fit all standard filenames seems good.\n\t\t\telse if (new_size < (160 * 1024)) // MAX_PATH to 160 KB or less -> 10% extra.\n\t\t\t\tnew_size = (size_t)(new_size * 1.1);\n\t\t\telse if (new_size < (1600 * 1024)) // 160 to 1600 KB -> 16 KB extra\n\t\t\t\tnew_size += (16 * 1024);\n\t\t\telse if (new_size < (6400 * 1024)) // 1600 to 6400 KB -> 1% extra\n\t\t\t\tnew_size += (new_size / 100);\n\t\t\telse // 6400 KB or more: Cap the extra margin at some reasonable compromise of speed vs. mem usage: 64 KB\n\t\t\t\tnew_size += (64 * 1024);\n\t\t}\n\t\tif (!string.SetCapacity(new_size))\n\t\t\treturn false; // And leave string empty (as set by Free() above).\n\t}\n\t// else we have a buffer with sufficient capacity already.\n\n\tLPTSTR buf = string.Value();\n\ttmemcpy(buf, str, len);\n\tbuf[len] = '\\0'; // Must be done separately since some callers pass a substring.\n\tstring.Length() = len;\n\treturn true; // Success.\n}\n\nbool Object::Variant::Assign(ExprTokenType &aParam)\n{\n\tExprTokenType temp, *val; // Seems more maintainable to use a copy; avoid any possible side-effects.\n\tif (aParam.symbol == SYM_VAR)\n\t{\n\t\taParam.var->ToTokenSkipAddRef(temp); // Skip AddRef() if applicable because it's called below.\n\t\tval = &temp;\n\t}\n\telse\n\t\tval = &aParam;\n\n\tswitch (val->symbol)\n\t{\n\tcase SYM_STRING:\n\t\treturn Assign(val->marker, val->marker_length);\n\tcase SYM_MISSING:\n\t\tAssignMissing();\n\t\treturn OK;\n\tcase SYM_OBJECT:\n\t\tFree(); // Free string or object, if applicable.\n\t\tsymbol = SYM_OBJECT; // Set symbol *after* calling Free().\n\t\tobject = val->object;\n\t\tobject->AddRef();\n\t\tbreak;\n\t//case SYM_INTEGER:\n\t//case SYM_FLOAT:\n\tdefault:\n\t\tFree(); // Free string or object, if applicable.\n\t\tsymbol = val->symbol; // Either SYM_INTEGER or SYM_FLOAT. Set symbol *after* calling Free().\n\t\tn_int64 = val->value_int64; // Also handles value_double via union.\n\t\tbreak;\n\t}\n\treturn true;\n}\n\n// Copy a value from a Variant into this uninitialized Variant.\nbool Object::Variant::InitCopy(Variant &val)\n{\n\tswitch (symbol = val.symbol)\n\t{\n\tcase SYM_STRING:\n\t\tnew (&string) String();\n\t\treturn Assign(val.string, val.string.Length(), true); // Pass true to conserve memory (no space is allowed for future expansion).\n\tcase SYM_OBJECT:\n\t\t(object = val.object)->AddRef();\n\t\tbreak;\n\tcase SYM_DYNAMIC:\n\t\tprop = new Property(*val.prop);\n\t\tif (auto obj = prop->Getter()) obj->AddRef();\n\t\tif (auto obj = prop->Setter()) obj->AddRef();\n\t\tif (auto obj = prop->Method()) obj->AddRef();\n\t\tbreak;\n\tcase SYM_TYPED_FIELD:\n\t\ttprop = new TypedProperty();\n\t\t*tprop = *val.tprop;\n\t\tbreak;\n\t//case SYM_INTEGER:\n\t//case SYM_FLOAT:\n\tdefault:\n\t\tn_int64 = val.n_int64; // Union copy.\n\t}\n\treturn true;\n}\n\n// Return value, knowing Variant will be kept around.\n// Copying of value can be skipped.\nvoid Object::Variant::ReturnRef(ResultToken &result)\n{\n\tswitch (result.symbol = symbol) // Assign.\n\t{\n\tcase SYM_STRING:\n\t\tresult.marker = string;\n\t\tresult.marker_length = string.Length();\n\t\tbreak;\n\tcase SYM_OBJECT:\n\t\tobject->AddRef();\n\t\tresult.object = object;\n\t\tbreak;\n\t//case SYM_MISSING: // Callers don't need special handling for this.\n\t//case SYM_INTEGER:\n\t//case SYM_FLOAT:\n\tdefault:\n\t\tresult.value_int64 = n_int64; // Union copy.\n\t}\n}\n\n// Return value, knowing Variant will shortly be deleted.\n// Value may be moved from Variant into ResultToken.\nvoid Object::Variant::ReturnMove(ResultToken &result)\n{\n\tswitch (result.symbol = symbol)\n\t{\n\tcase SYM_STRING:\n\t\t// For simplicity, just discard the memory of item.string (can't return it as-is since\n\t\t// the string isn't at the start of its memory block). Scripts can use the 2-param mode\n\t\t// to avoid any performance penalty this may incur.\n\t\tTokenSetResult(result, string, string.Length());\n\t\tbreak;\n\tcase SYM_OBJECT:\n\t\tresult.object = object;\n\t\tMinit(); // Let item forget the object ref since we are taking ownership.\n\t\tbreak;\n\tcase SYM_MISSING:\n\t\t// This implements \"blank if none\" documented for some methods in v2.0.\n\t\t// TODO: v2.1/future mode: return unset\n\tcase SYM_DYNAMIC:\n\tcase SYM_TYPED_FIELD: // This is a field definition; it can't have a value.\n\t\tresult.SetValue(_T(\"\"), 0);\n\t\tbreak;\n\t//case SYM_INTEGER:\n\t//case SYM_FLOAT:\n\tdefault:\n\t\tresult.value_int64 = n_int64; // Effectively also value_double = n_double.\n\t}\n}\n\n// Used when we want the value as is, in a token. Does not AddRef() or copy strings.\nvoid Object::Variant::ToToken(ExprTokenType &aToken)\n{\n\tswitch (aToken.symbol = symbol) // Assign.\n\t{\n\tcase SYM_STRING:\n\t\taToken.marker = string;\n\t\taToken.marker_length = string.Length();\n\t\tbreak;\n\tcase SYM_DYNAMIC:\n\tcase SYM_TYPED_FIELD:\n\t\t// This can be reached via Object::GetOwnProp.\n\t\taToken.symbol = SYM_INVALID; // Allow caller to detect this as an error.\n\t\tbreak;\n\tdefault:\n\t\taToken.value_int64 = n_int64; // Union copy.\n\t}\n}\n\nvoid Object::Variant::Free()\n// Only the value is freed, since keys only need to be freed when a field is removed\n// entirely or the Object is being deleted. See Object::Delete.\n// CONTAINED VALUE WILL NOT BE VALID AFTER THIS FUNCTION RETURNS.\n{\n\tswitch (symbol)\n\t{\n\tcase SYM_STRING: string.~String(); break;\n\tcase SYM_OBJECT: object->Release(); break;\n\tcase SYM_DYNAMIC: delete prop; break;\n\tcase SYM_TYPED_FIELD: delete tprop; break;\n\t}\n}\n\nTypedProperty::~TypedProperty()\n{\n\tif (class_object)\n\t\tclass_object->Release();\n}\n\n\n\n//\n// Array\n//\n\nResultType Array::SetCapacity(index_t aNewCapacity)\n{\n\tif (mLength > aNewCapacity)\n\t\tRemoveAt(aNewCapacity, mLength - aNewCapacity);\n\tauto new_item = (Variant *)realloc(mItem, sizeof(Variant) * aNewCapacity);\n\tif (!new_item && aNewCapacity)\n\t\treturn FAIL;\n\tmItem = new_item;\n\tmCapacity = aNewCapacity;\n\treturn OK;\n}\n\nResultType Array::EnsureCapacity(index_t aRequired)\n{\n\tif (mCapacity >= aRequired)\n\t\treturn OK;\n\t// Simple doubling of previous capacity, if that's enough, seems adequate.\n\t// Otherwise, allocate exactly the amount required with no room to spare.\n\t// v1 Object doubled in capacity when needed to add a new field, but started\n\t// at 4 and did not allocate any extra space when inserting with InsertAt or\n\t// Push. By contrast, this approach:\n\t// 1) Wastes no space in the possibly common case where Array::InsertAt is\n\t// called exactly once (such as when constructing the Array).\n\t// 2) Expands exponentially if Push is being used repeatedly, which should\n\t// perform much better than expanding by 1 each time.\n\tif (aRequired < (mCapacity << 1))\n\t\taRequired = (mCapacity << 1);\n\treturn SetCapacity(aRequired);\n}\n\ntemplate<typename TokenT>\nResultType Array::InsertAt(index_t aIndex, TokenT aValue[], index_t aCount)\n{\n\tASSERT(aIndex <= mLength);\n\n\tif (!EnsureCapacity(mLength + aCount))\n\t\treturn FAIL;\n\n\tif (aIndex < mLength)\n\t{\n\t\tmemmove(mItem + aIndex + aCount, mItem + aIndex, (mLength - aIndex) * sizeof(mItem[0]));\n\t}\n\tfor (index_t i = 0; i < aCount; ++i)\n\t{\n\t\tmItem[aIndex + i].Minit();\n\t\tmItem[aIndex + i].Assign(aValue[i]);\n\t}\n\tmLength += aCount;\n\treturn OK;\n}\n\ntemplate ResultType Array::InsertAt(index_t, ExprTokenType *[], index_t);\ntemplate ResultType Array::InsertAt(index_t, ExprTokenType [], index_t);\n\nvoid Array::RemoveAt(index_t aIndex, index_t aCount)\n{\n\tASSERT(aIndex + aCount <= mLength);\n\n\tfor (index_t i = 0; i < aCount; ++i)\n\t{\n\t\tmItem[aIndex + i].Free();\n\t}\n\tif (aIndex < mLength)\n\t{\n\t\tmemmove(mItem + aIndex, mItem + aIndex + aCount, (mLength - aIndex - aCount) * sizeof(mItem[0]));\n\t}\n\tmLength -= aCount;\n}\n\nResultType Array::SetLength(index_t aNewLength)\n{\n\tif (mLength > aNewLength)\n\t{\n\t\tRemoveAt(aNewLength, mLength - aNewLength);\n\t\treturn OK;\n\t}\n\tif (aNewLength > mCapacity && !SetCapacity(aNewLength))\n\t\treturn FAIL;\n\tfor (index_t i = mLength; i < aNewLength; ++i)\n\t{\n\t\tmItem[i].Minit();\n\t}\n\tmLength = aNewLength;\n\treturn OK;\n}\n\nArray::~Array()\n{\n\tRemoveAt(0, mLength);\n\tfree(mItem);\n}\n\nArray *Array::Create(ExprTokenType *aValue[], index_t aCount)\n{\n\tauto arr = new Array();\n\tarr->SetBase(Array::sPrototype);\n\tif (!aCount || arr->InsertAt(0, aValue, aCount))\n\t\treturn arr;\n\tarr->Release();\n\treturn nullptr;\n}\n\nArray *Array::Clone()\n{\n\tauto arr = new Array();\n\tif (!CloneTo(*arr))\n\t\treturn nullptr; // CloneTo() released arr.\n\tif (!arr->SetCapacity(mCapacity))\n\t\treturn nullptr;\n\tfor (index_t i = 0; i < mLength; ++i)\n\t{\n\t\tauto &new_item = arr->mItem[arr->mLength++];\n\t\tnew_item.Minit();\n\t\tExprTokenType value;\n\t\tmItem[i].ToToken(value);\n\t\tif (!new_item.Assign(value))\n\t\t{\n\t\t\tarr->Release();\n\t\t\treturn nullptr;\n\t\t}\n\t}\n\treturn arr;\n}\n\nbool Array::ItemToToken(index_t aIndex, ExprTokenType &aToken)\n{\n\tif (aIndex >= mLength)\n\t\treturn false;\n\tmItem[aIndex].ToToken(aToken);\n\treturn true;\n}\n\nObjectMember Array::sMembers[] =\n{\n\tObject_Member(__Item, Invoke, P___Item, IT_SET | BIMF_UNSET_ARG_1, 1, 1),\n\tObject_Property_get_set(Capacity),\n\tObject_Property_get_set(Length),\n\tObject_Member(__New, Invoke, M_Push, IT_CALL, 0, MAXP_VARIADIC),\n\tObject_Method(__Enum, 0, 1),\n\tObject_Method(Clone, 0, 0),\n\tObject_Method(Delete, 1, 1),\n\tObject_Method(Get, 1, 2),\n\tObject_Method(Has, 1, 1),\n\tObject_Method(InsertAt, 1, MAXP_VARIADIC),\n\tObject_Method(Pop, 0, 0),\n\tObject_Method(Push, 0, MAXP_VARIADIC),\n\tObject_Method(RemoveAt, 1, 2)\n};\n\nvoid Array::Invoke(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tswitch (aID)\n\t{\n\tcase P___Item:\n\tcase M_Get:\n\t{\n\t\tauto index = ParamToZeroIndex(*aParam[IS_INVOKE_SET ? 1 : 0]);\n\t\tif (index >= mLength)\n\t\t\t_o_throw(ERR_INVALID_INDEX, *aParam[IS_INVOKE_SET ? 1 : 0], ErrorPrototype::Index);\n\t\tauto &item = mItem[index];\n\t\tif (IS_INVOKE_SET)\n\t\t{\n\t\t\tif (!item.Assign(*aParam[0]))\n\t\t\t\t_o_throw_oom;\n\t\t\treturn;\n\t\t}\n\t\tif (item.symbol == SYM_MISSING)\n\t\t{\n\t\t\tif (!ParamIndexIsOmitted(1)) // Get(index, default)\n\t\t\t{\n\t\t\t\taResultToken.CopyValueFrom(*aParam[1]);\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tauto result = Object::Invoke(aResultToken, IT_GET, _T(\"Default\"), ExprTokenType{this}, nullptr, 0);\n\t\t\tif (result != INVOKE_NOT_HANDLED)\n\t\t\t\t_o_return_retval;\n\t\t\t_o_return_unset;\n\t\t}\n\t\titem.ReturnRef(aResultToken);\n\t\t_o_return_retval;\n\t}\n\n\tcase P_Length:\n\tcase P_Capacity:\n\t\tif (IS_INVOKE_SET)\n\t\t{\n\t\t\tif (!ParamIndexIsNumeric(0))\n\t\t\t\t_o_throw_type(_T(\"Number\"), *aParam[0]);\n\t\t\tauto arg64 = (UINT64)ParamIndexToInt64(0);\n\t\t\tif (arg64 < 0 || arg64 > MaxIndex)\n\t\t\t\t_o_throw_value(ERR_INVALID_VALUE);\n\t\t\tif (!(aID == P_Capacity ? SetCapacity((index_t)arg64) : SetLength((index_t)arg64)))\n\t\t\t\t_o_throw_oom;\n\t\t\treturn;\n\t\t}\n\t\t_o_return(aID == P_Capacity ? Capacity() : Length());\n\n\tcase M_InsertAt:\n\tcase M_Push:\n\t{\n\t\tindex_t index;\n\t\tif (aID == M_InsertAt)\n\t\t{\n\t\t\tindex = ParamToZeroIndex(*aParam[0]);\n\t\t\tif (index > mLength || index + (index_t)aParamCount > MaxIndex) // The second condition is very unlikely.\n\t\t\t\t_o_throw_param(0);\n\t\t\taParam++;\n\t\t\taParamCount--;\n\t\t}\n\t\telse\n\t\t\tindex = mLength;\n\t\tif (!InsertAt(index, aParam, aParamCount))\n\t\t\t_o_throw_oom;\n\t\t_o_return_empty;\n\t}\n\n\tcase M_RemoveAt:\n\tcase M_Pop:\n\t{\n\t\tindex_t index;\n\t\tif (aID == M_RemoveAt)\n\t\t{\n\t\t\tindex = ParamToZeroIndex(*aParam[0]);\n\t\t\tif (index >= mLength)\n\t\t\t\t_o_throw_param(0);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (!mLength)\n\t\t\t\t_o_throw(_T(\"Array is empty.\"));\n\t\t\tindex = mLength - 1;\n\t\t}\n\t\t\n\t\tindex_t count = 1;\n\t\tbool return_it = ParamIndexIsOmitted(1);\n\t\tif (!return_it)\n\t\t{\n\t\t\tThrow_if_Param_NaN(1);\n\t\t\tcount = (index_t)ParamIndexToInt64(1);\n\t\t}\n\t\tif (index + count > mLength)\n\t\t\t_o_throw_param(1);\n\n\t\tif (return_it) // Remove-and-return mode.\n\t\t{\n\t\t\tmItem[index].ReturnMove(aResultToken);\n\t\t\tif (aResultToken.Exited())\n\t\t\t\treturn;\n\t\t}\n\t\t\n\t\tRemoveAt(index, count);\n\t\treturn;\n\t}\n\t\n\tcase M_Has:\n\t{\n\t\tauto index = ParamToZeroIndex(*aParam[0]);\n\t\t_o_return(index >= 0 && index < mLength && mItem[index].symbol != SYM_MISSING);\n\t}\n\n\tcase M_Delete:\n\t{\n\t\tauto index = ParamToZeroIndex(*aParam[0]);\n\t\tif (index >= mLength)\n\t\t\t_o_throw_param(0);\n\t\tmItem[index].ReturnMove(aResultToken);\n\t\tmItem[index].AssignMissing();\n\t\t_o_return_retval;\n\t}\n\n\tcase M_Clone:\n\t\tif (auto *arr = Clone())\n\t\t\t_o_return(arr);\n\t\t_o_throw_oom;\n\n\tcase M___Enum:\n\t\t_o_return(new IndexEnumerator(this, ParamIndexToOptionalInt(0, 0)\n\t\t\t, static_cast<IndexEnumerator::Callback>(&Array::GetEnumItem)));\n\t}\n}\n\nArray::index_t Array::ParamToZeroIndex(ExprTokenType &aParam)\n{\n\tif (!TokenIsNumeric(aParam))\n\t\treturn BadIndex;\n\tauto index = TokenToInt64(aParam);\n\tif (index <= 0) // Let -1 be the last item and 0 be the first unused index.\n\t\tindex += mLength + 1;\n\t--index; // Convert to zero-based.\n\treturn index >= 0 && index <= MaxIndex ? UINT(index) : BadIndex;\n}\n\n\nResultType Array::GetEnumItem(UINT &aIndex, Var *aVal, Var *aReserved, int aVarCount)\n{\n\tif (aIndex < mLength)\n\t{\n\t\tResultType result = OK;\n\t\tif (aVarCount > 1)\n\t\t{\n\t\t\t// Put the index first, only when there are two parameters.\n\t\t\tif (aVal)\n\t\t\t\tresult = aVal->Assign((__int64)aIndex + 1);\n\t\t\taVal = aReserved;\n\t\t}\n\t\tif (aVal && result)\n\t\t{\n\t\t\tauto &item = mItem[aIndex];\n\t\t\tswitch (item.symbol)\n\t\t\t{\n\t\t\tdefault:\n\t\t\t\tif (item.symbol == SYM_MISSING)\n\t\t\t\t\tresult = aVal->AssignUnset();\n\t\t\t\telse\n\t\t\t\t\tresult = aVal->AssignString(item.string, item.string.Length());\n\t\t\t\tbreak;\n\t\t\tcase SYM_INTEGER:\tresult = aVal->Assign(item.n_int64);\tbreak;\n\t\t\tcase SYM_FLOAT:\t\tresult = aVal->Assign(item.n_double);\tbreak;\n\t\t\tcase SYM_OBJECT:\tresult = aVal->Assign(item.object);\t\tbreak;\n\t\t\t}\n\t\t}\n\t\treturn result ? CONDITION_TRUE : FAIL;\n\t}\n\treturn CONDITION_FALSE;\n}\n\n\n\n//\n// Enumerator\n//\n\nbool EnumBase::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tVar *var[] { nullptr, nullptr };\n\tfor (int i = 0; i < _countof(var); ++i)\n\t\tif (i < aParamCount)\n\t\t\tif (IObject *obj = ParamIndexToObject(i))\n\t\t\t{\n\t\t\t\tvar[i] = new (_alloca(sizeof(Var))) Var(obj); // mType = VAR_VIRTUAL_OBJ\n\t\t\t}\n\t\t\telse if (aParam[i]->symbol != SYM_MISSING)\n\t\t\t{\n\t\t\t\taResultToken.ParamError(i, aParam[i], _T(\"variable reference\"));\n\t\t\t\treturn false;\n\t\t\t}\n\n\tauto result = Next(var[0], var[1]);\n\tswitch (result)\n\t{\n\tcase CONDITION_TRUE:\n\tcase CONDITION_FALSE:\n\t\taResultToken.SetValue(result == CONDITION_TRUE);\n\t\treturn true;\n\tdefault: // Probably FAIL or EARLY_EXIT.\n\t\taResultToken.SetExitResult(result);\n\t\treturn false;\n\t}\n}\n\n\nResultType IndexEnumerator::Next(Var *var0, Var *var1)\n{\n\treturn (mObject->*mGetItem)(++mIndex, var0, var1, mParamCount ? mParamCount : var1 ? 2 : 1);\n}\n\n\nResultType Object::GetEnumProp(UINT &aIndex, Var *aName, Var *aVal, int aVarCount)\n{\n\tfor ( ; aIndex < mFields.Length(); ++aIndex)\n\t{\n\t\tFieldType &field = mFields[aIndex];\n\t\t// Assign name first to ensure stability in case the field is deleted by the property getter.\n\t\tif (aName)\n\t\t\taName->Assign(field.name);\n\t\tif (aVal)\n\t\t{\n\t\t\tif (field.symbol == SYM_DYNAMIC)\n\t\t\t{\n\t\t\t\t// Skip it if it can't be called without parameters, or if there's no getter in this object\n\t\t\t\t// (consistent with inherited properties that have neither getter nor setter defined here).\n\t\t\t\t// Also skip if this is a class prototype, since that isn't an instance of the class and\n\t\t\t\t// therefore isn't a valid target for a method/property call.\n\t\t\t\tif (field.prop->NoEnumGet || !field.prop->Getter() || IsClassPrototype())\n\t\t\t\t\tcontinue;\n\n\t\t\t\tFuncResult result_token;\n\t\t\t\tExprTokenType getter(field.prop->Getter());\n\t\t\t\tExprTokenType object(this);\n\t\t\t\tauto *param = &object;\n\t\t\t\tauto result = getter.object->Invoke(result_token, IT_CALL, nullptr, getter, ¶m, 1);\n\t\t\t\tif (result == FAIL || result == EARLY_EXIT)\n\t\t\t\t\treturn result;\n\t\t\t\tif (result_token.mem_to_free)\n\t\t\t\t{\n\t\t\t\t\tASSERT(result_token.symbol == SYM_STRING && result_token.mem_to_free == result_token.marker);\n\t\t\t\t\taVal->AcceptNewMem(result_token.mem_to_free, result_token.marker_length);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\taVal->Assign(result_token);\n\t\t\t\t\tresult_token.Free();\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (field.symbol == SYM_TYPED_FIELD)\n\t\t\t{\n\t\t\t\t// Typed properties are owned by the prototype, but have values only in the instances.\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tExprTokenType value;\n\t\t\t\tfield.ToToken(value);\n\t\t\t\taVal->Assign(value);\n\t\t\t}\n\t\t}\n\t\treturn CONDITION_TRUE;\n\t}\n\treturn CONDITION_FALSE;\n}\n\n\nObject::PropEnum::PropEnum(Object *aObject)\n{\n\tfor (Object *p = aObject; p; p = p->mBase)\n\t\t++mIndexCount;\n\tmIndex = new index_t[mIndexCount];\n\tmemset(mIndex, 0, mIndexCount * sizeof(index_t));\n\tmObject = aObject;\n\tmObject->AddRef();\n\tmThisToken.SetValue(mObject);\n}\n\n\nObject::PropEnum::PropEnum(Object *aObject, ExprTokenType &aThisToken)\n\t: PropEnum(aObject)\n{\n\tmThisToken.CopyValueFrom(aThisToken);\n}\n\n\nObject::PropEnum::~PropEnum()\n{\n\tmObject->Release();\n\tdelete[] mIndex;\n}\n\n\nResultType Object::PropEnum::Next(Var *aName, Var *aVal)\n{\n\tint nextidx, testidx = 0;\n\tObject *nextobj = nullptr;\n\n\t// Property getters should not be called for Prototype objects, since they are not instances.\n\t// Checking via mThisToken rather than mObject supports the substitution performed by the debugger.\n\tbool is_proto = mThisToken.symbol == SYM_OBJECT\n\t\t&& mThisToken.object->IsOfType(Object::sPrototype)\n\t\t&& static_cast<Object*>(mThisToken.object)->IsClassPrototype();\n\n\tfor (Object *testobj = mObject;; )\n\t{\n\t\tif (mIndex[testidx] < testobj->mFields.Length())\n\t\t{\n\t\t\tauto &testfld = testobj->mFields[mIndex[testidx]];\n\t\t\tif (!testfld.enumerable\n\t\t\t\t|| testfld.symbol == SYM_DYNAMIC && (testfld.prop->NoEnumGet || !testfld.prop->Getter() || is_proto))\n\t\t\t{\n\t\t\t\t++mIndex[testidx]; // Skip this property.\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tint r = nextobj ? _tcsicmp(testfld.name, nextobj->mFields[mIndex[nextidx]].name) : -1;\n\t\t\tif (r < 0)\n\t\t\t{\n\t\t\t\tnextidx = testidx;\n\t\t\t\tnextobj = testobj;\n\t\t\t}\n\t\t\telse if (r == 0)\n\t\t\t{\n\t\t\t\t++mIndex[testidx]; // Skip this shadowed property.\n\t\t\t\t// No need to consider the name at the new index, since r > 0 can be inferred.\n\t\t\t}\n\t\t}\n\t\t++testidx, testobj = testobj->mBase;\n\t\tif (!testobj || testidx >= mIndexCount)\n\t\t\tbreak; // No more bases.\n\t}\n\tif (!nextobj)\n\t\treturn CONDITION_FALSE;\n\n\tUINT tempidx = mIndex[nextidx];\n\n\tauto &field = nextobj->mFields[mIndex[nextidx]++];\n\n\tResultType result = OK;\n\tif (aName)\n\t\tresult = aName->Assign(field.name);\n\n\tif (aVal && result)\n\t{\n\t\tFuncResult result_token;\n\t\tauto result = mObject->GetFieldValue(result_token, IT_GET | IF_BYPASS___VALUE, field, mThisToken);\n\t\tif (result == FAIL || result == EARLY_EXIT)\n\t\t\treturn result;\n\t\tif (result_token.mem_to_free)\n\t\t{\n\t\t\tASSERT(result_token.symbol == SYM_STRING && result_token.mem_to_free == result_token.marker);\n\t\t\taVal->AcceptNewMem(result_token.mem_to_free, result_token.marker_length);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tresult = aVal->Assign(result_token);\n\t\t\tresult_token.Free();\n\t\t}\n\t}\n\t\n\treturn result ? CONDITION_TRUE : FAIL;\n}\n\n\nResultType Map::GetEnumItem(UINT &aIndex, Var *aKey, Var *aVal, int aVarCount)\n{\n\tif (aIndex < mCount)\n\t{\n\t\tauto &item = mItem[aIndex];\n\t\tResultType result = OK;\n\t\tif (aKey)\n\t\t{\n\t\t\tif (aIndex < mKeyOffsetObject) // mKeyOffsetInt < mKeyOffsetObject\n\t\t\t\tresult = aKey->Assign(item.key.i);\n\t\t\telse if (aIndex < mKeyOffsetString) // mKeyOffsetObject < mKeyOffsetString\n\t\t\t\tresult = aKey->Assign(item.key.p);\n\t\t\telse // mKeyOffsetString < mCount\n\t\t\t\tresult = aKey->Assign(item.key.s);\n\t\t}\n\t\tif (aVal && result)\n\t\t{\n\t\t\tExprTokenType value;\n\t\t\titem.ToToken(value);\n\t\t\tresult = aVal->Assign(value);\n\t\t}\n\t\treturn result ? CONDITION_TRUE : FAIL;\n\t}\n\treturn CONDITION_FALSE;\n}\n\n\nResultType RegExMatchObject::GetEnumItem(UINT &aIndex, Var *aKey, Var *aVal, int aVarCount)\n{\n\tif (aIndex >= (UINT)mPatternCount)\n\t\treturn CONDITION_FALSE;\n\t// In single-var mode, return the subpattern values.\n\t// Otherwise, return the subpattern names first and values second.\n\tif (aVarCount == 1)\n\t{\n\t\taVal = aKey;\n\t\taKey = nullptr;\n\t}\n\tResultType result = OK;\n\tif (aKey)\n\t{\n\t\tif (mPatternName && mPatternName[aIndex])\n\t\t\tresult = aKey->Assign(mPatternName[aIndex]);\n\t\telse\n\t\t\tresult = aKey->Assign((__int64)aIndex);\n\t}\n\tif (aVal && result)\n\t{\n\t\tresult = aVal->Assign(mHaystack - mHaystackStart + mOffset[aIndex*2], mOffset[aIndex*2+1]);\n\t}\n\treturn result ? CONDITION_TRUE : FAIL;\n}\n\n\n\n//\n// Object:: and Map:: Internal Methods\n//\n\nMap::Pair *Map::FindItem(IntKeyType val, index_t left, index_t right, index_t &insert_pos)\n// left and right must be set by caller to the appropriate bounds within mItem.\n{\n\twhile (left < right)\n\t{\n\t\tindex_t mid = left + ((right - left) >> 1);\n\t\tauto &item = mItem[mid];\n\n\t\tauto result = val - item.key.i;\n\n\t\tif (result < 0)\n\t\t\tright = mid;\n\t\telse if (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse\n\t\t\treturn &item;\n\t}\n\tinsert_pos = left;\n\treturn nullptr;\n}\n\nObject::FieldType *Object::FindField(name_t name, index_t &insert_pos)\n{\n\tindex_t left = 0, mid, right = mFields.Length();\n\tint first_char = *name;\n\tif (first_char <= 'Z' && first_char >= 'A')\n\t\tfirst_char += 32;\n\twhile (left < right)\n\t{\n\t\tmid = left + ((right - left) >> 1);\n\t\t\n\t\tFieldType &field = mFields[mid];\n\t\t\n\t\t// key_c contains the lower-case version of field.name[0]. Checking key_c first\n\t\t// allows the _tcsicmp() call to be skipped whenever the first character differs.\n\t\t// This also means that .name isn't dereferenced, which means one less potential\n\t\t// CPU cache miss (where we wait for the data to be pulled from RAM into cache).\n\t\t// field.key_c might cause a cache miss, but it's very likely that key.s will be\n\t\t// read into cache at the same time (but only the pointer value, not the chars).\n\t\tint result = first_char - field.key_c;\n\t\tif (!result)\n\t\t\tresult = _tcsicmp(name, field.name);\n\t\t\n\t\tif (result < 0)\n\t\t\tright = mid;\n\t\telse if (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse\n\t\t\treturn &field;\n\t}\n\tinsert_pos = left;\n\treturn nullptr;\n}\n\nbool Object::HasProp(name_t name)\n{\n\treturn FindField(name) || mBase && mBase->HasProp(name);\n}\n\nIObject *Object::GetMethod(name_t name)\n{\n\t// Return the function(?) object which would be called if the named property is called,\n\t// or nullptr if that would require invoking a getter. Does not verify that the object\n\t// is callable, and does not support primitive values (even in the unusual case that Call\n\t// has been implemented via the value's base/prototype).\n\tbool dynamic_only = false;\n\tfor (Object *that = this; that; that = that->mBase)\n\t{\n\t\tif (auto field = that->FindField(name))\n\t\t{\n\t\t\tif (field->symbol != SYM_DYNAMIC)\n\t\t\t\treturn (dynamic_only || field->symbol != SYM_OBJECT) ? nullptr : field->object;\n\t\t\tif (auto func = field->prop->Method())\n\t\t\t\treturn func; // Method takes precedence over any inherited value or getter.\n\t\t\tif (field->prop->Getter())\n\t\t\t\tdynamic_only = true; // Getter takes precedence over any inherited value.\n\t\t}\n\t}\n\treturn nullptr;\n}\n\nbool Object::HasMethod(name_t aName)\n{\n\treturn GetMethod(aName) != nullptr;\n}\n\nMap::Pair *Map::FindItem(LPTSTR val, index_t left, index_t right, index_t &insert_pos)\n// left and right must be set by caller to the appropriate bounds within mItem.\n{\n\tbool caseless = mFlags & MapCaseless;\n\tbool use_locale = mFlags & MapUseLocale;\n\tindex_t mid;\n\tint first_char = caseless ? 0 : *val;\n\twhile (left < right)\n\t{\n\t\tmid = left + ((right - left) >> 1);\n\n\t\tauto &item = mItem[mid];\n\n\t\t// key_c contains key.s[0], cached there for performance if !caseless.\n\t\t// If caseless, key_c is 0 since this simple formula is insufficient to\n\t\t// replicate the sort order of _tcsicmp and lstrcmpi.\n\t\tint result = first_char - item.key_c;\n\t\tif (!result)\n\t\t\tresult = !caseless ? _tcscmp(val, item.key.s)\n\t\t\t\t: use_locale ? lstrcmpi(val, item.key.s) : _tcsicmp(val, item.key.s);\n\n\t\tif (result < 0)\n\t\t\tright = mid;\n\t\telse if (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse\n\t\t\treturn &item;\n\t}\n\tinsert_pos = left;\n\treturn nullptr;\n}\n\nMap::Pair *Map::FindItem(SymbolType key_type, Key key, index_t &insert_pos)\n// Searches for an item with the given key. If found, a pointer to the item is returned. Otherwise\n// NULL is returned and insert_pos is set to the index a newly created item should be inserted at.\n// key_type and key are output for creating a new item or removing an existing one correctly.\n// left and right must indicate the appropriate section of mItem to search, based on key type.\n{\n\tindex_t left, right;\n\n\tswitch (key_type)\n\t{\n\tcase SYM_STRING:\n\t\tleft = mKeyOffsetString;\n\t\tright = mCount; // String keys are last in the mItem array.\n\t\treturn FindItem(key.s, left, right, insert_pos);\n\tcase SYM_OBJECT:\n\t\tleft = mKeyOffsetObject;\n\t\tright = mKeyOffsetString; // Object keys end where String keys begin.\n\t\t// left and right restrict the search to just the portion with object keys.\n\t\t// Reuse the integer search function to reduce code size. On 32-bit builds,\n\t\t// this requires that the upper 32 bits of each key have been initialized.\n\t\treturn FindItem((IntKeyType)(INT_PTR)key.p, left, right, insert_pos);\n\t//case SYM_INTEGER:\n\tdefault:\n\t\tleft = mKeyOffsetInt;\n\t\tright = mKeyOffsetObject; // Int keys end where Object keys begin.\n\t\treturn FindItem(key.i, left, right, insert_pos);\n\t}\n}\n\nvoid Map::ConvertKey(ExprTokenType &key_token, LPTSTR buf, SymbolType &key_type, Key &key)\n// Converts key_token to the appropriate key_type and key.\n// The exact type of the key is not preserved, since that often produces confusing behaviour;\n// for example, guis[WinExist()] := x ... x := guis[A_Gui] would fail because A_Gui returns a\n// string. Strings are converted to integers only where conversion back to string produces\n// the same string, so for instance, \"01\" and \" 1 \" and \"+0x8000\" are left as strings.\n{\n\tSymbolType inner_type = key_token.symbol;\n\tif (inner_type == SYM_VAR)\n\t{\n\t\tswitch (key_token.var->IsPureNumericOrObject())\n\t\t{\n\t\tcase VAR_ATTRIB_IS_INT64:\tinner_type = SYM_INTEGER; break;\n\t\tcase VAR_ATTRIB_IS_OBJECT:\tinner_type = SYM_OBJECT; break;\n\t\tcase VAR_ATTRIB_IS_DOUBLE:\tinner_type = SYM_FLOAT; break;\n\t\tdefault:\t\t\t\t\tinner_type = SYM_STRING; break;\n\t\t}\n\t}\n\tif (inner_type == SYM_OBJECT)\n\t{\n\t\tkey_type = SYM_OBJECT;\n\t\t// Set i to support the way FindItem() is used. Otherwise on 32-bit builds the\n\t\t// upper 32 bits would be potentially uninitialized, and searches could fail.\n\t\tkey.i = (IntKeyType)(INT_PTR)TokenToObject(key_token);\n\t\treturn;\n\t}\n\tif (inner_type == SYM_INTEGER)\n\t{\n\t\tkey.i = TokenToInt64(key_token);\n\t\tkey_type = SYM_INTEGER;\n\t\treturn;\n\t}\n\tkey_type = SYM_STRING;\n\tkey.s = TokenToString(key_token, buf);\n}\n\nMap::Pair *Map::FindItem(ExprTokenType &key_token, LPTSTR aBuf, SymbolType &key_type, Key &key, index_t &insert_pos)\n// Searches for an item with the given key, where the key is a token passed from script.\n{\n\tConvertKey(key_token, aBuf, key_type, key);\n\treturn FindItem(key_type, key, insert_pos);\n}\n\t\nbool Object::SetInternalCapacity(index_t new_capacity)\n// Expands mFields to the specified number if fields.\n// Caller *must* ensure new_capacity >= 1 && new_capacity >= mFields.Length().\n{\n\treturn mFields.SetCapacity(new_capacity);\n}\n\nbool Map::SetInternalCapacity(index_t new_capacity)\n// Caller *must* ensure new_capacity >= 1 && new_capacity >= mCount.\n{\n\tPair *new_fields = (Pair *)realloc(mItem, new_capacity * sizeof(Pair));\n\tif (!new_fields)\n\t\treturn false;\n\tmItem = new_fields;\n\tmCapacity = new_capacity;\n\treturn true;\n}\n\t\nObject::FieldType *Object::Insert(name_t name, index_t at)\n// Inserts a single field with the given key at the given offset.\n// Caller must ensure 'at' is the correct offset for this key.\n{\n\tif (mFields.Length() == mFields.Capacity() && !Expand() // Attempt to expand if at capacity.\n\t\t|| !(name = _tcsdup(name))) // Attempt to duplicate key-string.\n\t{\t// Out of memory.\n\t\treturn nullptr;\n\t}\n\t// There is now definitely room in mFields for a new field.\n\tFieldType &field = *mFields.InsertUninitialized(at, 1);\n\tfield.key_c = ctolower(*name);\n\tfield.name = name; // Above has already copied string or called key.p->AddRef() as appropriate.\n\tfield.Minit(); // Initialize to default value. Caller will likely reassign.\n\tfield.enumerable = true;\n\treturn &field;\n}\n\nMap::Pair *Map::Insert(SymbolType key_type, Key key, index_t at)\n// Inserts a single item with the given key at the given offset.\n// Caller must ensure 'at' is the correct offset for this key.\n{\n\tif (mCount == mCapacity && !Expand() // Attempt to expand if at capacity.\n\t\t|| key_type == SYM_STRING && !(key.s = _tcsdup(key.s))) // Attempt to duplicate key-string.\n\t{\t// Out of memory.\n\t\treturn NULL;\n\t}\n\t// There is now definitely room in mItem for a new item.\n\n\tauto &item = mItem[at];\n\tif (at < mCount)\n\t\t// Move existing items to make room.\n\t\tmemmove(&item + 1, &item, (mCount - at) * sizeof(Pair));\n\t++mCount; // Only after memmove above.\n\n\t// Update key-type offsets based on where and what was inserted; also update this key's ref count:\n\tif (key_type == SYM_STRING)\n\t{\n\t\titem.key_c = (mFlags & MapCaseless) ? 0 : *key.s;\n\t}\n\telse\n\t{\n\t\t// Must be either SYM_INTEGER or SYM_OBJECT, which both precede SYM_STRING.\n\t\t++mKeyOffsetString;\n\n\t\tif (key_type != SYM_OBJECT)\n\t\t\t// Must be SYM_INTEGER, which precedes SYM_OBJECT.\n\t\t\t++mKeyOffsetObject;\n\t\telse\n\t\t\tkey.p->AddRef();\n\t}\n\n\titem.key = key; // Above has already copied string or called key.p->AddRef() as appropriate.\n\titem.Minit(); // Initialize to default value. Caller will likely reassign.\n\n\treturn &item;\n}\n\n\n\n//\n// Func: A function, either built-in or created by a function definition.\n//\n\nResultType Func::Invoke(IObject_Invoke_PARAMS_DECL)\n{\n\tif (!aName && IS_INVOKE_CALL && !HasOwnProps()) // Very rough check that covers the most common cases.\n\t{\n\t\t// Take a shortcut for performance.\n\t\tCall(aResultToken, aParam, aParamCount);\n\t\treturn aResultToken.Result();\n\t}\n\treturn Object::Invoke(IObject_Invoke_PARAMS);\n}\n\nvoid Func::Invoke(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tswitch (MemberID(aID))\n\t{\n\tcase M_Call:\n\t\tCall(aResultToken, aParam, aParamCount);\n\t\treturn;\n\n\tcase M_Bind:\n\t\tif (BoundFunc *bf = BoundFunc::Bind(this, IT_CALL, nullptr, aParam, aParamCount))\n\t\t\t_o_return(bf);\n\t\t_o_throw_oom;\n\n\tcase M_IsOptional:\n\t\tif (aParamCount)\n\t\t{\n\t\t\tint param = ParamIndexToInt(0);\n\t\t\tif (param > 0 && (param <= mParamCount || mIsVariadic))\n\t\t\t\t_o_return(ArgIsOptional(param-1));\n\t\t\telse\n\t\t\t\t_o_throw_param(0);\n\t\t}\n\t\telse\n\t\t\t_o_return(mMinParams != mParamCount || mIsVariadic); // True if any params are optional.\n\t\n\tcase M_IsByRef:\n\t\tif (aParamCount)\n\t\t{\n\t\t\tint param = ParamIndexToInt(0);\n\t\t\tif (param <= 0 || param > mParamCount && !mIsVariadic)\n\t\t\t\t_o_throw_param(0);\n\t\t\t_o_return(ArgIsOutputVar(param-1));\n\t\t}\n\t\telse\n\t\t{\n\t\t\tfor (int param = 0; param < mParamCount; ++param)\n\t\t\t\tif (ArgIsOutputVar(param))\n\t\t\t\t\t_o_return(TRUE);\n\t\t\t_o_return(FALSE);\n\t\t}\n\n\tcase P_Name: _o_return(const_cast<LPTSTR>(mName));\n\tcase P_MinParams: _o_return(mMinParams);\n\tcase P_MaxParams: _o_return(mParamCount);\n\tcase P_IsBuiltIn: _o_return(IsBuiltIn());\n\tcase P_IsVariadic: _o_return(mIsVariadic);\n\t}\n}\n\n\nbool BoundFunc::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\t// Combine the bound parameters with the supplied parameters.\n\tint bound_count = mParams->Length();\n\tif (bound_count > 0)\n\t{\n\t\tExprTokenType *token = (ExprTokenType *)_alloca(bound_count * sizeof(ExprTokenType));\n\t\tExprTokenType **param = (ExprTokenType **)_alloca((bound_count + aParamCount) * sizeof(ExprTokenType *));\n\t\tmParams->ToParams(token, param, NULL, 0);\n\t\t// Fill in any missing parameters with those that were supplied.\n\t\t// Provides greater utility than binding to the parameter's default value.\n\t\tfor (int i = 0; i < bound_count && aParamCount; ++i)\n\t\t{\n\t\t\tif (param[i]->symbol == SYM_MISSING)\n\t\t\t{\n\t\t\t\tparam[i] = *(aParam++);\n\t\t\t\t--aParamCount;\n\t\t\t}\n\t\t}\n\t\tmemcpy(param + bound_count, aParam, aParamCount * sizeof(ExprTokenType *));\n\t\taParam = param;\n\t\taParamCount += bound_count;\n\t}\n\n\tExprTokenType this_token;\n\tthis_token.symbol = SYM_OBJECT;\n\tthis_token.object = mFunc;\n\n\t// Call the function or object.\n\tswitch (mFunc->Invoke(aResultToken, mFlags, mMember, this_token, aParam, aParamCount))\n\t{\n\tcase FAIL:\n\t\treturn FAIL;\n\tdefault:\n\t\treturn OK;\n\tcase INVOKE_NOT_HANDLED:\n\t\treturn aResultToken.UnknownMemberError(this_token, IT_CALL, mMember);\n\t}\n}\n\nBoundFunc *BoundFunc::Bind(IObject *aFunc, int aFlags, LPCTSTR aMember, ExprTokenType **aParam, int aParamCount)\n{\n\tLPTSTR member;\n\tif (!aMember)\n\t\tmember = nullptr;\n\telse if (!(member = _tcsdup(aMember)))\n\t\treturn nullptr;\n\tif (auto params = Array::Create(aParam, aParamCount))\n\t{\n\t\taFunc->AddRef();\n\t\t// BoundFunc takes our reference to params.\n\t\treturn new BoundFunc(aFunc, member, params, aFlags);\n\t}\n\tfree(member);\n\treturn nullptr;\n}\n\nBoundFunc::~BoundFunc()\n{\n\tmFunc->Release();\n\tmParams->Release();\n\tfree(mMember);\n}\n\n\nbool Closure::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tAddRef();\t// Avoid it being deleted during the call.\n\tauto result = mFunc->Call(aResultToken, aParam, aParamCount, mVars);\n\tRelease();\n\treturn result;\n}\n\nClosure::~Closure()\n{\n\tif (!(mFlags & ClosureGroupedFlag))\n\t\tmVars->Release();\n}\n\nbool Closure::Delete()\n{\n\tif ((mFlags & ClosureGroupedFlag) && !mVars->FullyReleased(mRefCount))\n\t\treturn false;\n\treturn Func::Delete();\n}\n\nbool FreeVars::FullyReleased(ULONG aRefPendingRelease)\n{\n\t// This function is part of a workaround for circular references that occur because all closures\n\t// have a reference to this FreeVars, while any closure referenced by itself or another closure\n\t// has a reference in mVar[].\n\t// aRefPendingRelease is 0 when this is being released the normal way (due to either the outer\n\t// function returning or a non-grouped Closure being deleted) and 1 when the script releases its\n\t// last direct reference to a grouped Closure.\n\tif (mRefCount)\n\t\treturn mRefCount < 0; // Negative values mean a previous call (still on the stack) is deleting this.\n\tint circular_closures = 0;\n\tULONG extra_references = 0;\n\tfor (int i = 0; i < mVarCount; ++i)\n\t\tif (mVar[i].Type() == VAR_CONSTANT)\n\t\t{\n\t\t\tASSERT(mVar[i].HasObject() && dynamic_cast<ObjectBase*>(mVar[i].Object())); // Any object in VAR_CONSTANT must derive from ObjectBase.\n\t\t\tauto obj = (ObjectBase *)mVar[i].Object();\n\t\t\textra_references += obj->RefCount();\n\t\t\t++circular_closures;\n\t\t}\n\t// aRefPendingRelease == 0 && extra_references > 0: keep alive.\n\t// aRefPendingRelease == 1 && extra_references > 1: keep alive.\n\t// aRefPendingRelease == 1 && extra_references == 1: delete, because that one Closure is being deleted.\n\tif (extra_references > aRefPendingRelease)\n\t\treturn false;\n\t--mRefCount; // Now that delete is certain, make this non-zero to prevent reentry.\n\tif (circular_closures)\n\t{\n\t\t// Any closure which is in a downvar and is not also an upvar (i.e. it is defined in this function,\n\t\t// not an outer one) has mRefCount == 0 at this point, meaning its only reference is the uncounted\n\t\t// one in mVar[]. In order to free the object properly, mRefCount needs to be restored to 1 prior\n\t\t// to Release(), which will be called by Var::Free() via ~FreeVars().\n\t\tfor (int i = 0; i < mVarCount; ++i)\n\t\t\tif (mVar[i].IsDirectConstant())\n\t\t\t{\n\t\t\t\tauto obj = (ObjectBase *)mVar[i].Object();\n\t\t\t\tobj->AddRef();\n\t\t\t}\n\t}\n\tdelete this;\n\treturn true;\n}\n\n\nResultType IObjectPtr::ExecuteInNewThread(TCHAR *aNewThreadDesc, ExprTokenType *aParamValue, int aParamCount, bool aReturnBoolean) const\n{\n\tDEBUGGER_STACK_PUSH(aNewThreadDesc)\n\tResultType result = CallMethod(mObject, mObject, nullptr, aParamValue, aParamCount, nullptr, 0, aReturnBoolean);\n\tDEBUGGER_STACK_POP()\n\treturn result;\n}\n\n\nFunc *IObjectPtr::ToFunc() const\n{\n\treturn dynamic_cast<Func *>(mObject);\n}\n\nLPCTSTR IObjectPtr::Name() const\n{\n\tif (auto func = ToFunc()) return func->mName;\n\treturn mObject->Type();\n}\n\n\n\nResultType MsgMonitorList::Call(ExprTokenType *aParamValue, int aParamCount, int aInitNewThreadIndex, __int64 *aRetVal)\n{\n\tResultType result = OK;\n\t__int64 retval = 0;\n\t\n\tfor (MsgMonitorInstance inst (*this); inst.index < inst.count; ++inst.index)\n\t{\n\t\tif (inst.index >= aInitNewThreadIndex) // Re-initialize the thread.\n\t\t\tInitNewThread(0, true, false);\n\t\t\n\t\tIObject *func = mMonitor[inst.index].func;\n\n\t\tif (!CallMethod(func, func, nullptr, aParamValue, aParamCount, &retval))\n\t\t{\n\t\t\tresult = FAIL; // Callback encountered an error.\n\t\t\tbreak;\n\t\t}\n\t\tif (retval)\n\t\t{\n\t\t\tresult = CONDITION_TRUE;\n\t\t\tbreak;\n\t\t}\n\t}\n\tif (aRetVal)\n\t\t*aRetVal = retval;\n\treturn result;\n}\n\n\n\nResultType MsgMonitorList::Call(ExprTokenType *aParamValue, int aParamCount, UINT aMsg, UCHAR aMsgType, GuiType *aGui, INT_PTR *aRetVal)\n{\n\tDEBUGGER_STACK_PUSH(_T(\"Gui\"))\n\tResultType result = OK;\n\t__int64 retval = 0;\n\tBOOL thread_used = FALSE;\n\tUINT_PTR event_info = g->EventInfo;\n\t\n\tfor (MsgMonitorInstance inst (*this); inst.index < inst.count; ++inst.index)\n\t{\n\t\tMsgMonitorStruct &mon = mMonitor[inst.index];\n\t\tif (mon.msg != aMsg || mon.msg_type != aMsgType)\n\t\t\tcontinue;\n\n\t\tIObject *func = mon.is_method ? aGui->mEventSink : mon.func; // is_method == true implies the GUI has an event sink object.\n\t\tLPTSTR method_name = mon.is_method ? mon.method_name : nullptr;\n\n\t\tif (thread_used) // Re-initialize the thread.\n\t\t{\n\t\t\tInitNewThread(0, true, false);\n\t\t\tg->EventInfo = event_info;\n\t\t}\n\t\t\n\t\t// Set last found window (as documented).\n\t\tg->hWndLastUsed = aGui->mHwnd;\n\t\t\n\t\t// If we're about to call a method of the Gui itself, don't pass the Gui as the first parameter\n\t\t// since it will be in `this`. Doing this here rather than when the parameters are built ensures\n\t\t// that message monitor functions (not methods) still receive the expected Gui parameter.\n\t\tint skip_arg = func == aGui && mon.is_method && aParamValue->symbol == SYM_OBJECT && aParamValue->object == aGui;\n\n\t\tresult = CallMethod(func, func, method_name, aParamValue + skip_arg, aParamCount - skip_arg, &retval);\n\t\tif (result == FAIL) // Callback encountered an error.\n\t\t\tbreak;\n\t\tif (result == EARLY_RETURN) // Callback returned a non-empty value.\n\t\t\tbreak;\n\t\tthread_used = TRUE;\n\t}\n\tif (aRetVal)\n\t\t*aRetVal = (INT_PTR)retval;\n\tDEBUGGER_STACK_POP()\n\treturn result;\n}\n\n\n\n//\n// Buffer\n//\n\nBufferObject *BufferObject::Create(void *aData, size_t aSize)\n{\n\tauto obj = new BufferObject(aData, aSize);\n\tobj->SetBase(BufferObject::sPrototype);\n\treturn obj;\n}\n\nObjectMember BufferObject::sMembers[] =\n{\n\tObject_Method(__New, 0, 2),\n\tObject_Property_get(Ptr),\n\tObject_Property_get_set(Size)\n};\n\nvoid BufferObject::Invoke(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tswitch (aID)\n\t{\n\tcase P_Ptr:\n\t\t_o_return((size_t)mData);\n\tcase P_Size: // Size or __New\n\t\tif (!IS_INVOKE_GET)\n\t\t{\n\t\t\tif (!ParamIndexIsOmitted(0))\n\t\t\t{\n\t\t\t\tif (!ParamIndexIsNumeric(0))\n\t\t\t\t\tif (IS_INVOKE_SET)\n\t\t\t\t\t\t_o_throw_type(_T(\"Number\"), *aParam[0]);\n\t\t\t\t\telse\n\t\t\t\t\t\t_o_throw_param(0, _T(\"Number\"));\n\t\t\t\tauto new_size = ParamIndexToInt64(0);\n\t\t\t\tif (new_size < 0 || new_size > SIZE_MAX)\n\t\t\t\t\t_o_throw_value(ERR_INVALID_VALUE);\n\t\t\t\tif (!Resize((size_t)new_size))\n\t\t\t\t\t_o_throw_oom;\n\t\t\t}\n\t\t\tif (!ParamIndexIsOmitted(1))\n\t\t\t{\n\t\t\t\tif (!ParamIndexIsNumeric(1))\n\t\t\t\t\t_o_throw_param(1, _T(\"Number\"));\n\t\t\t\tmemset(mData, (char)ParamIndexToInt64(1), mSize);\n\t\t\t}\n\t\t\treturn;\n\t\t}\n\t\t_o_return(mSize);\n\t}\n}\n\nResultType BufferObject::Resize(size_t aNewSize)\n{\n\t// It seems worthwhile to guarantee that no reallocation is performed if size is the same.\n\t// Testing (in 2022) showed realloc() to return new blocks even if the same size is passed\n\t// in multiple times.\n\tif (aNewSize == mSize)\n\t\treturn OK;\n\tauto new_data = realloc(mData, aNewSize);\n\tif (!new_data && aNewSize)\n\t\treturn FAIL;\n\tmData = new_data;\n\tmSize = aNewSize;\n\treturn OK;\n}\n\n\nvoid ClipboardAll::__New(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tvoid *data;\n\tsize_t size;\n\tif (!aParamCount)\n\t{\n\t\t// Retrieve clipboard contents.\n\t\tif (!Var::GetClipboardAll(&data, &size))\n\t\t\t_o_return_FAIL;\n\t}\n\telse\n\t{\n\t\t// Use caller-supplied data.\n\t\tsize_t caller_data;\n\t\tif (auto obj = ParamIndexToObject(0))\n\t\t{\n\t\t\tGetBufferObjectPtr(aResultToken, obj, caller_data, size);\n\t\t\tif (aResultToken.Exited())\n\t\t\t\treturn;\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Caller supplied an address.\n\t\t\tThrow_if_Param_NaN(0);\n\t\t\tcaller_data = (size_t)ParamIndexToIntPtr(0);\n\t\t\tif (caller_data < 65536) // Basic check to catch incoming raw addresses that are zero or blank. On Win32, the first 64KB of address space is always invalid.\n\t\t\t\t_o_throw_param(0);\n\t\t\tsize = -1;\n\t\t}\n\t\tif (!ParamIndexIsOmitted(1))\n\t\t{\n\t\t\tThrow_if_Param_NaN(1);\n\t\t\tsize = (size_t)ParamIndexToIntPtr(1);\n\t\t}\n\t\telse if (size == -1) // i.e. it can be omitted when size != -1 (a string was passed).\n\t\t\treturn (void)aResultToken.ParamError(1, nullptr);\n\t\tif ( !(data = malloc(size)) ) // More likely to be due to invalid parameter than out of memory.\n\t\t\t_o_throw_oom;\n\t\tmemcpy(data, (void *)caller_data, size);\n\t}\n\tif (mData != data)\n\t\tfree(mData); // In case of explicit call to __New.\n\tmData = data;\n\tmSize = size;\n}\n\n\nObject *ClipboardAll::Create()\n{\n\tauto obj = new ClipboardAll();\n\tobj->SetBase(ClipboardAll::sPrototype);\n\treturn obj;\n}\n\n\nObjectMember ClipboardAll::sMembers[]\n{\n\tObject_Method1(__New, 0, 2)\n};\n\n\n\nObjectMember Func::sMembers[] =\n{\n\tObject_Method(Bind, 0, MAXP_VARIADIC),\n\tObject_Method(Call, 0, MAXP_VARIADIC),\n\tObject_Method(IsByRef, 0, MAX_FUNCTION_PARAMS),\n\tObject_Method(IsOptional, 0, MAX_FUNCTION_PARAMS),\n\n\tObject_Property_get(IsBuiltIn),\n\tObject_Property_get(IsVariadic),\n\tObject_Property_get(MaxParams),\n\tObject_Property_get(MinParams),\n\tObject_Property_get(Name)\n};\n\n\n\nObjectMember RegExMatchObject::sMembers[] =\n{\n\tObject_Method(__Enum, 0, 1),\n\tObject_Method(__Get, 2, 2),\n\tObject_Member(__Item, Invoke, M_Value, IT_GET, 0, 1),\n\tObject_Member(Count, Invoke, M_Count, IT_GET, 0, 0),\n\tObject_Method(Len, 0, 1),\n\tObject_Member(Len, Invoke, M_Len, IT_GET, 0, 1),\n\tObject_Member(Mark, Invoke, M_Mark, IT_GET, 0, 0),\n\tObject_Method(Name, 1, 1),\n\tObject_Member(Name, Invoke, M_Name, IT_GET, 1, 1),\n\tObject_Method(Pos, 0, 1),\n\tObject_Member(Pos, Invoke, M_Pos, IT_GET, 0, 1),\n};\n\n\n\nObjectMember Object::sErrorMembers[]\n{\n\tObject_Member(__New, Error__New, M_Error__New, IT_CALL, 0, 3),\n\tObject_Member(Show, Error_Show, 0, IT_CALL, 0, 2),\n};\n\nObjectMember Object::sOSErrorMembers[]\n{\n\tObject_Member(__New, Error__New, M_OSError__New, IT_CALL, 0, 3)\n};\n\n\n\nObjectMember VarRef::sMembers[]\n{\n\tObject_Member(__Value, __Value, 0, IT_SET | BIMF_UNSET_ARG_1)\n};\n\nObjectMember PropRef::sMembers[]\n{\n\tObject_Member(__Value, __Value, 0, IT_SET | BIMF_UNSET_ARG_1)\n};\n\n\n\nstruct ClassDef\n{\n\tLPCTSTR name;\n\tObject **proto_var;\n\tClassFactoryDef factory;\n\tObjectMemberListType members;\n\tint member_count;\n\tstd::initializer_list<ClassDef> subclasses;\n};\n\nvoid DefineClasses(Object *aBaseClass, Object *aBaseProto, std::initializer_list<ClassDef> aClasses)\n{\n\tfor (auto &c : aClasses)\n\t{\n\t\tauto proto = (c.proto_var && *c.proto_var) ? *c.proto_var\n\t\t\t: Object::CreatePrototype(const_cast<LPTSTR>(c.name), aBaseProto, c.members, c.member_count);\n\t\tif (c.proto_var)\n\t\t\t*c.proto_var = proto;\n\t\tauto cobj = Object::CreateClass(const_cast<LPTSTR>(c.name), aBaseClass, proto, c.factory);\n\t\tif (c.subclasses.size())\n\t\t\tDefineClasses(cobj, proto, c.subclasses);\n\t}\n}\n\n\nvoid Object::CreateRootPrototypes()\n{\n\t// Create the root prototypes before defining any members, since\n\t// each member relies on Func::sPrototype having been initialized.\n\tsAnyPrototype = CreatePrototype(_T(\"Any\"), nullptr);\n\tsPrototype = CreatePrototype(_T(\"Object\"), sAnyPrototype);\n\tFunc::sPrototype = CreatePrototype(_T(\"Func\"), Object::sPrototype);\n\n\t// These methods correspond to global functions, as BuiltInMethod\n\t// only handles Objects, and these must handle primitive values.\n\tstatic const LPTSTR sFuncs[] = { _T(\"GetMethod\"), _T(\"HasBase\"), _T(\"HasMethod\"), _T(\"HasProp\") };\n\tfor (int i = 0; i < _countof(sFuncs); ++i)\n\t\tsAnyPrototype->DefineMethod(sFuncs[i], g_script.GetBuiltinObject(sFuncs[i]));\n\tauto prop = sAnyPrototype->DefineProperty(_T(\"Base\"), false);\n\tprop->NoParamGet = prop->NoParamSet = true;\n\tprop->SetGetter(g_script.GetBuiltinObject(_T(\"ObjGetBase\")));\n\tprop->SetSetter(g_script.GetBuiltinObject(_T(\"ObjSetBase\")));\n\t\n\t// Define __Init so that Script::DefineClassInit can add an unconditional super.__Init().\n\tstatic auto __Init = new BuiltInFunc { _T(\"\"), Any___Init, 1, 1 };\n\tsAnyPrototype->DefineMethod(_T(\"__Init\"), __Init);\n\n\tDefineMembers(sPrototype, _T(\"Object\"), sMembers, _countof(sMembers));\n\tDefineMembers(Func::sPrototype, _T(\"Func\"), Func::sMembers, _countof(Func::sMembers));\n\n\t// Create classes.\n\t//\n\n\tsClassPrototype = Object::CreatePrototype(_T(\"Class\"), Object::sPrototype);\n\tauto anyClass = CreateClass(_T(\"Any\"), sClassPrototype, sAnyPrototype, nullptr);\n\tObject::sClass = CreateClass(_T(\"Object\"), anyClass, Object::sPrototype, NewObject<Object>);\n\tObject::sObjectCall = Object::sClass->GetOwnPropMethod(_T(\"Call\"));\n\n\tObjectCtor no_ctor = nullptr;\n\tObjectMember *no_members = nullptr;\n\n\tDefineClasses(Object::sClass, Object::sPrototype, {\n\t\t{_T(\"Array\"), &Array::sPrototype, NewObject<Array>\n\t\t\t, Array::sMembers, _countof(Array::sMembers)},\n\t\t{_T(\"Buffer\"), &BufferObject::sPrototype, NewObject<BufferObject>, BufferObject::sMembers, _countof(BufferObject::sMembers), {\n\t\t\t{_T(\"ClipboardAll\"), &ClipboardAll::sPrototype, NewObject<ClipboardAll>\n\t\t\t\t, ClipboardAll::sMembers, _countof(ClipboardAll::sMembers)}\n\t\t}},\n\t\t{_T(\"Class\"), &Object::sClassPrototype, {Class_New, 0, 2, true}},\n\t\t{_T(\"Error\"), &ErrorPrototype::Error, no_ctor, sErrorMembers, _countof(sErrorMembers), {\n\t\t\t{_T(\"MemoryError\"), &ErrorPrototype::Memory},\n\t\t\t{_T(\"OSError\"), &ErrorPrototype::OS, no_ctor, sOSErrorMembers, _countof(sOSErrorMembers)},\n\t\t\t{_T(\"TargetError\"), &ErrorPrototype::Target},\n\t\t\t{_T(\"TimeoutError\"), &ErrorPrototype::Timeout},\n\t\t\t{_T(\"TypeError\"), &ErrorPrototype::Type},\n\t\t\t{_T(\"UnsetError\"), &ErrorPrototype::Unset, no_ctor, no_members, 0, {\n\t\t\t\t{_T(\"MemberError\"), &ErrorPrototype::Member, no_ctor, no_members, 0, {\n\t\t\t\t\t{_T(\"PropertyError\"), &ErrorPrototype::Property},\n\t\t\t\t\t{_T(\"MethodError\"), &ErrorPrototype::Method}\n\t\t\t\t}},\n\t\t\t\t{_T(\"UnsetItemError\"), &ErrorPrototype::UnsetItem}\n\t\t\t}},\n\t\t\t{_T(\"ValueError\"), &ErrorPrototype::Value, no_ctor, no_members, 0, {\n\t\t\t\t{_T(\"IndexError\"), &ErrorPrototype::Index}\n\t\t\t}},\n\t\t\t{_T(\"ZeroDivisionError\"), &ErrorPrototype::ZeroDivision}\n\t\t}},\n\t\t{_T(\"Func\"), &Func::sPrototype, no_ctor, Func::sMembers, _countof(Func::sMembers), {\n\t\t\t{_T(\"BoundFunc\"), &BoundFunc::sPrototype},\n\t\t\t{_T(\"Closure\"), &Closure::sPrototype},\n\t\t\t{_T(\"Enumerator\"), &EnumBase::sPrototype}\n\t\t}},\n\t\t{_T(\"Gui\"), &GuiType::sPrototype, NewObject<GuiType>\n\t\t\t, GuiType::sMembers, GuiType::sMemberCount},\n\t\t{_T(\"InputHook\"), &InputObject::sPrototype, NewObject<InputObject>\n\t\t\t, InputObject::sMembers, InputObject::sMemberCount},\n\t\t{_T(\"Map\"), &Map::sPrototype, NewObject<Map>\n\t\t\t, Map::sMembers, _countof(Map::sMembers)},\n\t\t{_T(\"Menu\"), &UserMenu::sPrototype, NewObject<UserMenu>\n\t\t\t, UserMenu::sMembers, UserMenu::sMemberCount, {\n\t\t\t{_T(\"MenuBar\"), &UserMenu::sBarPrototype, NewObject<UserMenu::Bar>}\n\t\t}},\n\t\t{_T(\"RegExMatchInfo\"), &RegExMatchObject::sPrototype, no_ctor\n\t\t\t, RegExMatchObject::sMembers, _countof(RegExMatchObject::sMembers)}\n\t});\n\n\t// Parameter counts are specified for static Call in the following classes\n\t// but not those using NewObject<> because the latter passes parameters on\n\t// to __New, which can be redefined by a subclass. Specifying counts here\n\t// sets MinParams/MaxParams/IsVariadic appropriately and avoids the need to\n\t// validate aParamCount in each function, which reduces code size.\n\t// Note that the `this` parameter (the class itself) is counted.\n\tDefineClasses(anyClass, sAnyPrototype, {\n\t\t{_T(\"ComValue\"), &sComValuePrototype, {ComValue_Call, 3, 4}, no_members, 0, {\n\t\t\t{_T(\"ComObjArray\"), &sComArrayPrototype, {ComObjArray_Call, 3, 10}},\n\t\t\t{_T(\"ComObject\"), &sComObjectPrototype, {ComObject_Call, 2, 3}},\n\t\t\t{_T(\"ComValueRef\"), &sComRefPrototype}\n\t\t}},\n\t\t{_T(\"Primitive\"), &Object::sPrimitivePrototype, no_ctor, no_members, 0, {\n\t\t\t{_T(\"Number\"), &Object::sNumberPrototype, {BIF_Number, 2, 2}, no_members, 0, {\n\t\t\t\t{_T(\"Float\"), &Object::sFloatPrototype, {BIF_Float, 2, 2}},\n\t\t\t\t{_T(\"Integer\"), &Object::sIntegerPrototype, {BIF_Integer, 2, 2}}\n\t\t\t}},\n\t\t\t{_T(\"String\"), &Object::sStringPrototype, {BIF_String, 2, 2}}\n\t\t}},\n\t\t{_T(\"Module\"), &ScriptModule::sPrototype},\n\t\t{_T(\"PropRef\"), &PropRef::sPrototype, {PropRef_Call, 3, 3}, PropRef::sMembers, _countof(PropRef::sMembers)},\n\t\t{_T(\"VarRef\"), &sVarRefPrototype, no_ctor, VarRef::sMembers, _countof(VarRef::sMembers)}\n\t});\n\n\tGuiControlType::DefineControlClasses();\n\tDefineComPrototypeMembers();\n\tDefineFileClass();\n\n\t// Permit Object.Call to construct Error objects.\n\tErrorPrototype::Error->mFlags &= ~NativeClassPrototype;\n\tErrorPrototype::OS->mFlags &= ~NativeClassPrototype;\n}\n\nObject *Object::sAnyPrototype;\nObject *Func::sPrototype;\nObject *Object::sPrototype;\n\nObject *Object::sClassPrototype;\nObject *Array::sPrototype;\nObject *Map::sPrototype;\n\nObject *Object::sClass;\n\nObject *Closure::sPrototype;\nObject *BoundFunc::sPrototype;\nObject *EnumBase::sPrototype;\n\nObject *BufferObject::sPrototype;\nObject *ClipboardAll::sPrototype;\n\nObject *RegExMatchObject::sPrototype;\n\nObject *GuiType::sPrototype;\nObject *UserMenu::sPrototype;\nObject *UserMenu::sBarPrototype;\n\nnamespace ErrorPrototype\n{\n\tObject *Error, *Memory, *Type, *Value, *OS, *ZeroDivision;\n\tObject *Target, *Unset, *Member, *Property, *Method, *Index, *UnsetItem;\n\tObject *Timeout;\n}\n\nObject *Object::sVarRefPrototype;\nObject *PropRef::sPrototype;\nObject *Object::sComObjectPrototype, *Object::sComValuePrototype, *Object::sComArrayPrototype, *Object::sComRefPrototype;\n\nIObject *Object::sObjectCall;\n\n\n//\n// Primitive values as objects\n//\n\nObject *Object::sPrimitivePrototype;\nObject *Object::sStringPrototype;\nObject *Object::sNumberPrototype;\nObject *Object::sIntegerPrototype;\nObject *Object::sFloatPrototype;\n\nObject *Object::ValueBase(ExprTokenType &aValue)\n{\n\tswitch (TypeOfToken(aValue))\n\t{\n\tcase SYM_STRING: return Object::sStringPrototype;\n\tcase SYM_INTEGER: return Object::sIntegerPrototype;\n\tcase SYM_FLOAT: return Object::sFloatPrototype;\n\t}\n\treturn nullptr;\n}\n\n\n\nvoid Object::DefineClass(name_t aName, Object *aClass)\n{\n\tauto prop = DefineProperty(aName);\n\n\tExprTokenType values[] { aClass, aName }, *param[] { values, values + 1 };\n\n\tauto info = SimpleHeap::Alloc<NestedClassInfo>();\n\tinfo->class_object = aClass;\n\tinfo->constructed = false;\n\taClass->AddRef();\n\n\tauto get = new BuiltInFunc { _T(\"\"), Class_GetNestedClass, 1, 1, false, info };\n\tprop->NoParamGet = prop->NoParamSet = true;\n\tprop->SetGetter(get);\n\n\tauto call = new BuiltInFunc { _T(\"\"), Class_CallNestedClass, 1, 1, true, info };\n\tprop->SetMethod(call);\n}\n\n\nBIF_DECL(Class_GetNestedClass)\n{\n\tauto info = (NestedClassInfo *)aResultToken.func->mData;\n\tauto cls = info->class_object;\n\tcls->AddRef();\n\tif (info->constructed)\n\t\t_f_return(cls);\n\tinfo->constructed = true;\n\tcls->Construct(aResultToken, nullptr, 0);\n}\n\n\nBIF_DECL(Class_CallNestedClass)\n{\n\tauto info = (NestedClassInfo *)aResultToken.func->mData;\n\tauto cls = info->class_object;\n\tif (!info->constructed)\n\t{\n\t\tinfo->constructed = true;\n\t\tcls->AddRef(); // Necessary because Construct() calls Release() on failure/exit.\n\t\tif (cls->Construct(aResultToken, nullptr, 0) != OK) // FAIL or EXIT\n\t\t\treturn;\n\t\tcls->Release();\n\t\taResultToken.InitResult(aResultToken.buf);\n\t}\n\telse\n\t\taResultToken.symbol = SYM_STRING; // Set the default expected by Invoke.\n\tcls->Invoke(aResultToken, IT_CALL, nullptr, ExprTokenType { cls }, aParam + 1, aParamCount - 1);\n}\n\n\nBIF_DECL(Class_New)\n{\n\t// For backward-compatibility, Class() is the same as (Object.Call)(Class).\n\t// Class(unset) would have thrown ERR_TOO_MANY_PARAMS, so is exempted from this.\n\tif (aParamCount == 1)\n\t\treturn NewObject<Object>(aResultToken, aParam, aParamCount);\n\n\t// aParam[0] is implicit and mandatory, as this is a method. Usually it should be Class itself,\n\t// but might be something else if the script explicitly calls (Class.Call)(this) or extends Class\n\t// itself (which is not the same as an instance of Class, as that derives from Class.Prototype).\n\t++aParam, --aParamCount; // Exclude \"Class\" itself.\n\n\t// Get the optional name and class parameters.\n\tLPTSTR name = _T(\"\");\n\tIObject *obj0 = ParamIndexToObject(0);\n\tif (!obj0)\n\t{\n\t\tname = ParamIndexToString(0, _f_retval_buf);\n\t\t++aParam, --aParamCount;\n\t}\n\tObject *base_class = obj0 ? dynamic_cast<Object *>(obj0) : ParamIndexIsOmitted(0) ? Object::sClass : dynamic_cast<Object *>(ParamIndexToObject(0));\n\tObject *base_proto = base_class ? dynamic_cast<Object *>(base_class->GetOwnPropObj(_T(\"Prototype\"))) : nullptr;\n\tif (!base_proto)\n\t\treturn (void)aResultToken.ParamError(obj0 ? 0 : 1, aParam[0], _T(\"Class\"));\n\tif (aParamCount)\n\t\t++aParam, --aParamCount;\n\n\tauto proto = Object::CreatePrototype(name, base_proto);\n\tauto class_obj = Object::CreateClass(proto, base_class);\n\tproto->Release();\n\t// Don't call any inherited __Init, since that would reinitialize static variables and duplicate\n\t// any typed properties defined by that one class. This either releases or returns class_obj:\n\tclass_obj->ConstructNoInit(aResultToken, aParam, aParamCount, ExprTokenType(class_obj));\n}\n"},"size":{"kind":"number","value":117410,"string":"117,410"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":3465,"string":"3,465"},"avg_line_length":{"kind":"number","value":31.266955266955268,"string":"31.266955"},"max_line_length":{"kind":"number","value":164,"string":"164"},"alphanum_fraction":{"kind":"number","value":0.7108866026641277,"string":"0.710887"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11077,"cells":{"id":{"kind":"number","value":16065,"string":"16,065"},"file_name":{"kind":"string","value":"ahklib.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/ahklib.cpp"},"content":{"kind":"string","value":"/*\nahklib.cpp\n\nOriginal code by Steve Gray.\n\nThis software is provided 'as-is', without any express or implied\nwarranty. In no event will the authors be held liable for any damages\narising from the use of this software.\n\nPermission is granted to anyone to use this software for any purpose,\nincluding commercial applications, and to alter it and redistribute it\nfreely, without restriction.\n*/\n\n#include \"stdafx.h\"\n#include \"globaldata.h\"\n#include \"DispObject.h\"\n#include \"script_com.h\"\n#include \"script_func_impl.h\"\n\n#include \"autogenerated/ahklib_h.h\"\n#include \"autogenerated/ahklib_i.c\"\n\n\n#define AHKAPI(_rettype_) extern \"C\" __declspec(dllexport) _rettype_ __stdcall\n\n\nIDispatch *lib_ProblemCallback = nullptr;\n\n\nvoid EarlyAppInit();\nResultType InitForExecution();\nint MainExecuteScript(bool aMsgSleep = true);\n\n\nAHKAPI(int) Main(int argc, LPTSTR argv[])\n{\n\t__argc = argc;\n\t__targv = argv;\n\t// _tWinMain() doesn't use lpCmdLine or nShowCmd.\n\treturn _tWinMain(g_hInstance, NULL, nullptr, SW_SHOWNORMAL);\n}\n\n\nclass DECLSPEC_NOVTABLE EnumVARIANT : public IEnumVARIANT\n{\n\tULONG mRefCount;\n\nprotected:\n\tULONG mIndex;\n\npublic:\n\tEnumVARIANT() : mRefCount(0), mIndex(0) {}\n\n\tvirtual ~EnumVARIANT() {}\n\n\tSTDMETHODIMP QueryInterface(REFIID riid, void **ppvObject)\n\t{\n\t\tif (riid == IID_IUnknown || riid == IID_IEnumVARIANT)\n\t\t\t*ppvObject = static_cast<IEnumVARIANT*>(this);\n\t\telse\n\t\t\treturn E_NOTIMPL;\n\t\tAddRef();\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP_(ULONG) AddRef()\n\t{\n\t\treturn ++mRefCount;\n\t}\n\n\tSTDMETHODIMP_(ULONG) Release()\n\t{\n\t\tif (mRefCount)\n\t\t\treturn --mRefCount;\n\t\tdelete this;\n\t\treturn 0;\n\t}\n\n\tSTDMETHODIMP Next(ULONG celt, /*out*/ VARIANT *rgVar, /*out*/ ULONG *pCeltFetched) = 0;\n\t\n\tSTDMETHODIMP Skip(ULONG celt) { return E_NOTIMPL; }\n\tSTDMETHODIMP Reset() { return E_NOTIMPL; }\n\tSTDMETHODIMP Clone(/*out*/ IEnumVARIANT **ppEnum) { return E_NOTIMPL; }\n};\n\n\nclass DescribeFunc : public DispObject<IDescribeFunc>\n{\n\tFunc *mFunc;\n\npublic:\n\tDescribeFunc(ITypeInfo *typeInfo) : DispObject<IDescribeFunc>(typeInfo) {}\n\n\tstatic HRESULT Create(Func *func, IDispatch **ppDisp)\n\t{\n\t\tauto hr = CreateDispatchInstance<DescribeFunc>(ppDisp);\n\t\tif (FAILED(hr))\n\t\t\treturn hr;\n\t\tstatic_cast<DescribeFunc*>(*ppDisp)->mFunc = func;\n\t\treturn S_OK;\n\t}\n\t\n\tSTDMETHODIMP_(BSTR) get_Name() { return SysAllocString(mFunc->mName); }\n\tSTDMETHODIMP_(BSTR) get_File() { return SysAllocString(Line::sSourceFile[mFunc->mFileIndex]); }\n\tSTDMETHODIMP_(UINT) get_Line() { return mFunc->mLineNumber; }\n\tSTDMETHODIMP_(UINT) get_EndLine();\n\tSTDMETHODIMP_(BOOL) get_IsBuiltIn() { return mFunc->IsBuiltIn(); }\n\tSTDMETHODIMP_(BOOL) get_IsVariadic() { return mFunc->mIsVariadic; }\n\tSTDMETHODIMP_(int) get_MinParams() { return mFunc->mMinParams; }\n\tSTDMETHODIMP_(int) get_MaxParams() { return mFunc->mParamCount; }\n\tSTDMETHODIMP_(HRESULT) get_Vars(IDispatch** ppDisp);\n\tSTDMETHODIMP_(HRESULT) get_Params(IDispatch** Value);\n\tSTDMETHODIMP_(HRESULT) get_Globals(IDispatch** Value);\n\tSTDMETHODIMP_(BSTR) get_DefaultVarType();\n};\n\n\nclass EnumFuncs : public EnumVARIANT\n{\npublic:\n\tEnumFuncs() : EnumVARIANT() {}\n\n\tSTDMETHODIMP Next(ULONG celt, /*out*/ VARIANT *rgVar, /*out*/ ULONG *pCeltFetched)\n\t{\n\t\tULONG i;\n\t\tfor (i = 0; i < celt && mIndex < (ULONG)g_script.mFuncs.mCount; ++i, ++mIndex)\n\t\t{\n\t\t\trgVar->vt = VT_DISPATCH;\n\t\t\tauto hr = DescribeFunc::Create(g_script.mFuncs.mItem[mIndex], &rgVar->pdispVal);\n\t\t\tif (FAILED(hr))\n\t\t\t{\n\t\t\t\tif (pCeltFetched)\n\t\t\t\t\t*pCeltFetched = i;\n\t\t\t\treturn hr;\n\t\t\t}\n\t\t}\n\t\tif (pCeltFetched)\n\t\t\t*pCeltFetched = i;\n\t\treturn i < celt ? S_FALSE : S_OK;\n\t}\n};\n\n\nclass FuncCollection : public DispObject<IDispCollection>\n{\npublic:\n\tFuncCollection(ITypeInfo *typeInfo) : DispObject<IDispCollection>(typeInfo) {}\n\n\tSTDMETHODIMP get_Item(VARIANT* index, VARIANT *value)\n\t{\n\t\tif (index->vt != VT_BSTR)\n\t\t\treturn DISP_E_TYPEMISMATCH;\n\t\tauto var = g_script.FindGlobalVar(index->bstrVal); // FIXME: Module support.\n\t\tif (!var)\n\t\t\treturn DISP_E_BADINDEX;\n\t\tauto func = dynamic_cast<Func*>(var->ToObject());\n\t\tif (!func)\n\t\t\treturn DISP_E_BADINDEX;\n\t\tvalue->vt = VT_DISPATCH;\n\t\treturn DescribeFunc::Create(func, &value->pdispVal);\n\t}\n\n\tSTDMETHODIMP get_Count(int *pCount)\n\t{\n\t\t*pCount = g_script.mFuncs.mCount;\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP _NewEnum(IEnumVARIANT **ppEnum)\n\t{\n\t\t*ppEnum = new EnumFuncs();\n\t\treturn S_OK;\n\t}\n};\n\n\nclass DescribeParam : public DispObject<IDescribeParam>\n{\n\tFuncParam *mParam;\n\tbool mIsRest;\n\npublic:\n\tDescribeParam(ITypeInfo *typeInfo) : DispObject<IDescribeParam>(typeInfo) {}\n\n\tstatic HRESULT Create(FuncParam *param, bool isRest, IDispatch **ppDisp)\n\t{\n\t\tauto hr = CreateDispatchInstance<DescribeParam>(ppDisp);\n\t\tif (FAILED(hr))\n\t\t\treturn hr;\n\t\tstatic_cast<DescribeParam*>(*ppDisp)->mParam = param;\n\t\tstatic_cast<DescribeParam*>(*ppDisp)->mIsRest = isRest;\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP_(BSTR) get_Name() { return SysAllocString(mParam->var->mName); }\n\tSTDMETHODIMP_(BOOL) get_IsByRef() { return mParam->is_byref; }\n\tSTDMETHODIMP_(BOOL) get_IsOptional() { return mParam->default_type != PARAM_DEFAULT_NONE; }\n\tSTDMETHODIMP_(BOOL) get_IsRest() { return mIsRest; }\n\n\tSTDMETHODIMP get_Default(VARIANT* value)\n\t{\n\t\tswitch (mParam->default_type)\n\t\t{\n\t\tcase PARAM_DEFAULT_INT:\n\t\t\tvalue->vt = ((int)mParam->default_int64 == mParam->default_int64) ? VT_I4 : VT_I8;\n\t\t\tvalue->llVal = mParam->default_int64;\n\t\t\tbreak;\n\t\tcase PARAM_DEFAULT_FLOAT:\n\t\t\tvalue->vt = VT_R8;\n\t\t\tvalue->dblVal = mParam->default_double;\n\t\t\tbreak;\n\t\tcase PARAM_DEFAULT_STR:\n\t\t\tvalue->vt = VT_BSTR;\n\t\t\tvalue->bstrVal = SysAllocString(mParam->default_str);\n\t\t\tbreak;\n\t\tdefault:\n\t\t\tvalue->vt = VT_EMPTY;\n\t\t}\n\t\treturn S_OK;\n\t}\n};\n\n\nclass EnumParams : public EnumVARIANT\n{\n\tUserFunc *mFunc;\n\npublic:\n\tEnumParams(UserFunc *func) : mFunc(func) {}\n\n\tSTDMETHODIMP Next(ULONG celt, /*out*/ VARIANT *rgVar, /*out*/ ULONG *pCeltFetched)\n\t{\n\t\tULONG i;\n\t\tfor (i = 0; i < celt && mIndex < (ULONG)mFunc->mParamCount + mFunc->mIsVariadic; ++i, ++mIndex)\n\t\t{\n\t\t\trgVar->vt = VT_DISPATCH;\n\t\t\tauto hr = DescribeParam::Create(mFunc->mParam + mIndex, mIndex == mFunc->mParamCount, &rgVar->pdispVal);\n\t\t\tif (FAILED(hr))\n\t\t\t{\n\t\t\t\tif (pCeltFetched)\n\t\t\t\t\t*pCeltFetched = i;\n\t\t\t\treturn hr;\n\t\t\t}\n\t\t}\n\t\tif (pCeltFetched)\n\t\t\t*pCeltFetched = i;\n\t\treturn i < celt ? S_FALSE : S_OK;\n\t}\n};\n\n\nclass ParamCollection : public DispObject<IDispCollection>\n{\n\tUserFunc *mFunc;\n\npublic:\n\tParamCollection(ITypeInfo *typeInfo) : DispObject<IDispCollection>(typeInfo) {}\n\n\tstatic HRESULT Create(UserFunc *func, IDispatch **ppDisp)\n\t{\n\t\tauto hr = CreateDispatchInstance<ParamCollection>(ppDisp);\n\t\tif (FAILED(hr))\n\t\t\treturn hr;\n\t\tstatic_cast<ParamCollection*>(*ppDisp)->mFunc = func;\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP get_Item(VARIANT* index, VARIANT *value)\n\t{\n\t\tif (index->vt != VT_I4)\n\t\t\treturn DISP_E_TYPEMISMATCH;\n\t\tif (index->lVal < 1 || index->lVal > mFunc->mParamCount + mFunc->mIsVariadic)\n\t\t\treturn DISP_E_BADINDEX;\n\t\tvalue->vt = VT_DISPATCH;\n\t\treturn DescribeParam::Create(mFunc->mParam + index->lVal - 1, index->lVal > mFunc->mParamCount, &value->pdispVal);\n\t}\n\n\tSTDMETHODIMP get_Count(int *pCount)\n\t{\n\t\t*pCount = mFunc->mParamCount + mFunc->mIsVariadic;\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP _NewEnum(IEnumVARIANT **ppEnum)\n\t{\n\t\t*ppEnum = new EnumParams(mFunc);\n\t\treturn S_OK;\n\t}\n};\n\n\nclass DescribeVar : public DispObject<IDescribeVar>\n{\n\tVar *mVar;\n\npublic:\n\tDescribeVar(ITypeInfo *typeInfo) : DispObject<IDescribeVar>(typeInfo) {}\n\n\tstatic HRESULT Create(Var *var, IDispatch **ppDisp)\n\t{\n\t\tauto hr = CreateDispatchInstance<DescribeVar>(ppDisp);\n\t\tif (FAILED(hr))\n\t\t\treturn hr;\n\t\tstatic_cast<DescribeVar*>(*ppDisp)->mVar = var;\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP_(BSTR) get_Name() { return SysAllocString(mVar->mName); }\n\tSTDMETHODIMP_(BOOL) get_IsReadOnly() { return VAR_IS_READONLY(*mVar); }\n\tSTDMETHODIMP_(BOOL) get_IsVirtual() { return mVar->IsVirtual(); }\n\tSTDMETHODIMP_(BOOL) get_IsDeclared() { return mVar->IsDeclared(); }\n\tSTDMETHODIMP_(BOOL) get_IsSuperGlobal() { return FALSE; }\n};\n\n\nclass VarCollection;\nclass EnumVars : public EnumVARIANT\n{\n\tVarList *mVars;\n\npublic:\n\tEnumVars(VarList *vars) : mVars(vars) {}\n\n\tSTDMETHODIMP Next(ULONG celt, /*out*/ VARIANT *rgVar, /*out*/ ULONG *pCeltFetched);\n};\n\n\nclass VarCollection : public DispObject<IDispCollection>\n{\n\tVarList *mVars;\n\npublic:\n\tVarCollection(ITypeInfo *typeInfo) : DispObject<IDispCollection>(typeInfo) {}\n\n\tstatic HRESULT Create(VarList *vars, IDispatch **ppDisp)\n\t{\n\t\tauto hr = CreateDispatchInstance<VarCollection>(ppDisp);\n\t\tif (FAILED(hr))\n\t\t\treturn hr;\n\t\tauto &inst = *static_cast<VarCollection*>(*ppDisp);\n\t\tinst.mVars = vars;\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP get_Item(VARIANT* index, VARIANT *value)\n\t{\n\t\tif (index->vt != VT_BSTR)\n\t\t\treturn DISP_E_TYPEMISMATCH;\n\t\tVar *var = mVars->Find(value->bstrVal);\n\t\tif (!var)\n\t\t\treturn DISP_E_BADINDEX;\n\t\tvalue->vt = VT_DISPATCH;\n\t\treturn DescribeVar::Create(var, &value->pdispVal);\n\t}\n\n\tSTDMETHODIMP get_Count(int *pCount)\n\t{\n\t\t*pCount = mVars->mCount;\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP _NewEnum(IEnumVARIANT **ppEnum)\n\t{\n\t\t*ppEnum = new EnumVars(mVars);\n\t\treturn S_OK;\n\t}\n};\n\n\nSTDMETHODIMP EnumVars::Next(ULONG celt, /*out*/ VARIANT *rgVar, /*out*/ ULONG *pCeltFetched)\n{\n\tULONG i;\n\tfor (i = 0; i < celt && mIndex < (ULONG)mVars->mCount; ++i, ++mIndex)\n\t{\n\t\trgVar[i].vt = VT_DISPATCH;\n\t\tauto hr = DescribeVar::Create(mVars->mItem[mIndex], &rgVar[i].pdispVal);\n\t\tif (FAILED(hr))\n\t\t{\n\t\t\tif (pCeltFetched)\n\t\t\t\t*pCeltFetched = i;\n\t\t\treturn hr;\n\t\t}\n\t}\n\tif (pCeltFetched)\n\t\t*pCeltFetched = i;\n\treturn i < celt ? S_FALSE : S_OK;\n}\n\n\nUINT DescribeFunc::get_EndLine()\n{\n\tif (auto func = dynamic_cast<UserFunc*>(mFunc))\n\t\tif (Line *line = func->mJumpToLine->mRelatedLine)\n\t\t\treturn line->mPrevLine->mLineNumber;\n\treturn 0;\n}\n\n\nHRESULT DescribeFunc::get_Vars(IDispatch** ppDisp)\n{\n\tif (auto func = dynamic_cast<UserFunc*>(mFunc))\n\t\treturn VarCollection::Create(&func->mVars, ppDisp);\n\treturn E_NOTIMPL;\n}\n\n\nHRESULT DescribeFunc::get_Params(IDispatch** ppDisp)\n{\n\tif (auto func = dynamic_cast<UserFunc*>(mFunc))\n\t\treturn ParamCollection::Create(func, ppDisp);\n\treturn E_NOTIMPL;\n}\n\n\nHRESULT DescribeFunc::get_Globals(IDispatch** ppDisp)\n{\n\tif (auto func = dynamic_cast<UserFunc*>(mFunc))\n\t\treturn VarCollection::Create(&func->mStaticVars, ppDisp); // FIXME: filter to globals, add .StaticVars\n\treturn E_NOTIMPL;\n}\n\n\nBSTR DescribeFunc::get_DefaultVarType()\n{\n\tLPCTSTR mode = nullptr;\n\tif (auto func = dynamic_cast<UserFunc*>(mFunc))\n\t\tswitch (func->mDefaultVarType)\n\t\t{\n\t\tcase VAR_DECLARE_STATIC: mode = _T(\"static\"); break;\n\t\tcase VAR_DECLARE_GLOBAL: mode = _T(\"global\"); break;\n\t\t}\n\treturn mode ? SysAllocString(mode) : nullptr;\n}\n\n\nclass DescribeLabel : public DispObject<IDescribeLabel>\n{\n\tLabel *mLabel;\n\npublic:\n\tDescribeLabel(ITypeInfo *typeInfo) : DispObject<IDescribeLabel>(typeInfo) {}\n\n\tstatic HRESULT Create(Label *label, IDispatch **ppDisp)\n\t{\n\t\tauto hr = CreateDispatchInstance<DescribeLabel>(ppDisp);\n\t\tif (FAILED(hr))\n\t\t\treturn hr;\n\t\tstatic_cast<DescribeLabel*>(*ppDisp)->mLabel = label;\n\t\treturn S_OK;\n\t}\n\t\n\tSTDMETHODIMP_(BSTR) get_Name() { return SysAllocString(mLabel->mName); }\n\tSTDMETHODIMP_(BSTR) get_File() { return SysAllocString(Line::sSourceFile[mLabel->mFileIndex]); }\n\tSTDMETHODIMP_(UINT) get_Line() { return mLabel->mLineNumber; }\n};\n\n\nclass EnumLabels : public EnumVARIANT\n{\n\tLabel *mCurrLabel;\n\npublic:\n\tEnumLabels() : EnumVARIANT(), mCurrLabel(g_script.mDefaultModule.mFirstLabel) {}\n\n\tSTDMETHODIMP Next(ULONG celt, /*out*/ VARIANT *rgVar, /*out*/ ULONG *pCeltFetched)\n\t{\n\t\tULONG i;\n\t\tfor (i = 0; i < celt && mCurrLabel; ++i, mCurrLabel = mCurrLabel->mNextLabel)\n\t\t{\n\t\t\trgVar[i].vt = VT_DISPATCH;\n\t\t\tauto hr = DescribeLabel::Create(mCurrLabel, &rgVar[i].pdispVal);\n\t\t\tif (FAILED(hr))\n\t\t\t{\n\t\t\t\tif (pCeltFetched)\n\t\t\t\t\t*pCeltFetched = i;\n\t\t\t\treturn hr;\n\t\t\t}\n\t\t}\n\t\tif (pCeltFetched)\n\t\t\t*pCeltFetched = i;\n\t\treturn i < celt ? S_FALSE : S_OK;\n\t}\n};\n\n\nclass LabelCollection : public DispObject<IDispCollection>\n{\npublic:\n\tLabelCollection(ITypeInfo *typeInfo) : DispObject<IDispCollection>(typeInfo) {}\n\n\tSTDMETHODIMP get_Item(VARIANT* index, VARIANT *value)\n\t{\n\t\tif (index->vt != VT_BSTR)\n\t\t\treturn DISP_E_TYPEMISMATCH;\n\t\tLabel *label = g_script.FindLabel(index->bstrVal); // FIXME: Module support.\n\t\tif (!label)\n\t\t\treturn DISP_E_BADINDEX;\n\t\tvalue->vt = VT_DISPATCH;\n\t\treturn DescribeLabel::Create(label, &value->pdispVal);\n\t}\n\n\tSTDMETHODIMP get_Count(int *pCount)\n\t{\n\t\t*pCount = g_script.mLabelCount; // FIXME: This counts all labels, not just those available in this collection.\n\t\treturn S_OK;\n\t}\n\n\tSTDMETHODIMP _NewEnum(IEnumVARIANT **ppEnum)\n\t{\n\t\t*ppEnum = new EnumLabels();\n\t\treturn S_OK;\n\t}\n};\n\n\nclass AutoHotkeyScript : public ObjectBase\n{\n\tResultType Invoke(IObject_Invoke_PARAMS_DECL)\n\t{\n\t\tauto var = g_script.FindGlobalVar(aName);\n\t\tif (!var)\n\t\t\treturn INVOKE_NOT_HANDLED;\n\t\tif (IS_INVOKE_CALL || aParamCount > (IS_INVOKE_SET ? 1 : 0))\n\t\t{\n\t\t\tauto obj = var->HasObject() ? var->Object() : nullptr;\n\t\t\tif (!obj)\n\t\t\t{\n\t\t\t\tExprTokenType token;\n\t\t\t\ttoken.SetVar(var);\n\t\t\t\tobj = Object::ValueBase(token);\n\t\t\t\taFlags |= IF_SUBSTITUTE_THIS;\n\t\t\t}\n\t\t\treturn obj->Invoke(aResultToken, aFlags, nullptr, ExprTokenType(obj), aParam, aParamCount);\n\t\t}\n\t\tif (IS_INVOKE_SET) // Script.Var := Value\n\t\t\treturn var->Assign(*aParam[0]);\n\t\t// Script.Var\n\t\tif (!var->IsVirtual())\n\t\t{\n\t\t\tvar->ToToken(aResultToken);\n\t\t\treturn OK;\n\t\t}\n\t\t// Built-in/virtual variable\n\t\tvar->Get(aResultToken);\n\t\tif (aResultToken.symbol == SYM_OBJECT)\n\t\t\taResultToken.object->AddRef();\n\t\treturn aResultToken.Result();\n\t}\n\n\tObject *Base()\n\t{\n\t\tstatic Object *sPrototype = Object::CreatePrototype(_T(\"Script\"), Object::sAnyPrototype);\n\t\treturn sPrototype;\n\t}\n\n\tIObject_Type_Impl(\"Script\")\n};\n\n\nclass AutoHotkeyLib : public DispObject<IAutoHotkeyLib>\n{\n\tAutoHotkeyScript *mScript;\n\npublic:\n\tAutoHotkeyLib(ITypeInfo *typeInfo) : DispObject<IAutoHotkeyLib>(typeInfo), mScript(nullptr) {}\n\n\n\tSTDMETHODIMP Main(BSTR cmdLine, int *exitCode)\n\t{\n\t\tif (Line::sSourceFileCount)\n\t\t\treturn HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED);\n\t\tint argc;\n\t\tauto argv = CommandLineToArgvW(cmdLine, &argc);\n\t\t*exitCode = ::Main(argc, argv);\n\t\tLocalFree(argv);\n\t\treturn S_OK;\n\t}\n\n\n\tSTDMETHODIMP LoadFile(LPTSTR aScriptPath)\n\t{\n\t\tif (Line::sSourceFileCount)\n\t\t\treturn HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED);\n\t\tEarlyAppInit();\n\t\tif (!g_script.Init(aScriptPath, nullptr))\n\t\t\treturn E_FAIL;\n\t\tif (g_script.LoadFromFile(aScriptPath) == LOADING_FAILED\n\t\t\t|| !InitForExecution())\n\t\t\treturn E_FAIL;\n\t\treturn S_OK;\n\t}\n\n\n\tSTDMETHODIMP Execute(int *aExitCode)\n\t{\n\t\tif (!g_script.mIsReadyToExecute)\n\t\t\treturn E_FAIL;\n\t\t*aExitCode = MainExecuteScript(false);\n\t\treturn S_OK;\n\t}\n\n\n\tSTDMETHODIMP OnProblem(IDispatch *callback)\n\t{\n\t\tauto prev = lib_ProblemCallback;\n\t\tif (callback)\n\t\t\tcallback->AddRef();\n\t\tlib_ProblemCallback = callback;\n\t\tif (prev)\n\t\t\tprev->Release();\n\t\treturn S_OK;\n\t}\n\n\n\tSTDMETHODIMP get_Script(IDispatch **ppScript)\n\t{\n\t\tif (!mScript)\n\t\t\tmScript = new AutoHotkeyScript;\n\t\tmScript->AddRef();\n\t\t*ppScript = mScript;\n\t\treturn S_OK;\n\t}\n\n\n\tSTDMETHODIMP get_Funcs(IDispatch **ppFuncs)\n\t{\n\t\treturn CreateDispatchInstance<FuncCollection>(ppFuncs);\n\t}\n\n\tSTDMETHODIMP get_Vars(IDispatch **ppVars)\n\t{\n\t\treturn VarCollection::Create(&g_script.mVars, ppVars);\n\t}\n\n\tSTDMETHODIMP get_Labels(IDispatch **ppLabels)\n\t{\n\t\treturn CreateDispatchInstance<LabelCollection>(ppLabels);\n\t}\n\n\n\tSTDMETHODIMP get_Files(SAFEARRAY **psa)\n\t{\n\t\t*psa = SafeArrayCreateVector(VT_BSTR, 1, Line::sSourceFileCount);\n\t\tif (!*psa)\n\t\t\treturn E_OUTOFMEMORY;\n\t\tfor (LONG i = 1; i <= Line::sSourceFileCount; ++i)\n\t\t\tSafeArrayPutElement(*psa, &i, SysAllocString(Line::sSourceFile[i-1]));\n\t\treturn S_OK;\n\t}\n};\n\n\nbool LibNotifyProblem(ExprTokenType &aProblem)\n{\n\tif (!lib_ProblemCallback)\n\t\treturn false;\n\tVARIANTARG arg;\n\tTTVArgType arg_type;\n\tTokenToVariant(aProblem, arg, &arg_type);\n\tDISPPARAMS prm = { &arg, nullptr, 1, 0 };\n\tVARIANT result;\n\tauto hr = lib_ProblemCallback->Invoke(DISPID_VALUE, IID_NULL, LOCALE_USER_DEFAULT, DISPATCH_METHOD, &prm, &result, nullptr, nullptr);\n\tif (arg_type == VariantIsAllocatedString)\n\t\tSysFreeString(arg.bstrVal);\n\treturn SUCCEEDED(hr);\n}\n\n\nbool LibNotifyProblem(LPCTSTR aMessage, LPCTSTR aExtra, Line *aLine, bool aWarn)\n{\n\tif (!lib_ProblemCallback)\n\t\treturn false;\n\tstatic Line sLine(0, 0, ACT_EXPRESSION, nullptr, 0);\n\tif (!aLine)\n\t{\n\t\tsLine.mFileIndex = g_script.mCurrFileIndex;\n\t\tsLine.mLineNumber = g_script.mCombinedLineNumber;\n\t\taLine = &sLine;\n\t}\n\tauto obj = aLine->CreateRuntimeException(aMessage, aExtra, aWarn ? Object::sPrototype : nullptr);\n\tauto result = LibNotifyProblem(ExprTokenType(obj));\n\tobj->Release();\n\treturn result;\n}\n\n\nAHKAPI(HRESULT) Host(IDispatch **ppLib)\n{\n\treturn CreateDispatchInstance<AutoHotkeyLib>(ppLib);\n}\n\n\nBOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)\n{\n\tswitch( fdwReason ) \n\t{ \n\tcase DLL_PROCESS_ATTACH:\n\t\tg_hInstance = hinstDLL;\n\t\tbreak;\n\tcase DLL_PROCESS_DETACH:\n\t\tif (lpvReserved != nullptr)\n\t\t\tbreak;\n\t\t// Perform any necessary cleanup.\n\t\tbreak;\n\t}\n\treturn TRUE;\n}\n\n\nHRESULT LoadMyTypeLib(ITypeLib **ppTypeLib)\n{\n\tTCHAR lib_path[MAX_PATH + 1];\n\tDWORD len = GetModuleFileName(g_hInstance, lib_path, _countof(lib_path));\n\tif (!len || len == _countof(lib_path))\n\t\treturn E_FAIL;\n\treturn LoadTypeLib(lib_path, ppTypeLib);\n}\n\n\nHRESULT LoadMyTypeInfo(REFIID riid, ITypeInfo **ppTypeInfo)\n{\n\tITypeLib* pTypeLib;\n\tif (FAILED(LoadMyTypeLib(&pTypeLib)))\n\t\treturn E_FAIL;\n\tHRESULT hr = pTypeLib->GetTypeInfoOfGuid(riid, ppTypeInfo);\n\tpTypeLib->Release();\n\treturn hr;\n}\n"},"size":{"kind":"number","value":17436,"string":"17,436"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":599,"string":"599"},"avg_line_length":{"kind":"number","value":26.48914858096828,"string":"26.489149"},"max_line_length":{"kind":"number","value":134,"string":"134"},"alphanum_fraction":{"kind":"number","value":0.728029214559387,"string":"0.728029"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11078,"cells":{"id":{"kind":"number","value":16066,"string":"16,066"},"file_name":{"kind":"string","value":"application.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/application.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"application.h\"\n#include \"globaldata.h\" // for access to g_clip, the \"g\" global struct, etc.\n#include \"window.h\" // for several MsgBox and window functions\n#include \"util.h\" // for strlcpy()\n#include \"resources/resource.h\" // For ID_TRAY_OPEN.\n#include \"script_gui.h\"\n\n\nbool MsgSleep(int aSleepDuration, MessageMode aMode)\n// Returns true if it launched at least one thread, and false otherwise.\n// aSleepDuration can be be zero to do a true Sleep(0), or less than 0 to avoid sleeping or\n// waiting at all (i.e. messages are checked and if there are none, the function will return\n// immediately). aMode is either RETURN_AFTER_MESSAGES (default) or WAIT_FOR_MESSAGES.\n// If the caller doesn't specify aSleepDuration, this function will return after a\n// time less than or equal to SLEEP_INTERVAL (i.e. the exact amount of the sleep\n// isn't important to the caller). This mode is provided for performance reasons\n// (it avoids calls to GetTickCount and the TickCount math). However, if the\n// caller's script subroutine is suspended due to action by us, an unknowable\n// amount of time may pass prior to finally returning to the caller.\n{\n\tbool we_turned_on_defer = false; // Set default.\n\tif (aMode == RETURN_AFTER_MESSAGES_SPECIAL_FILTER)\n\t{\n\t\taMode = RETURN_AFTER_MESSAGES; // To simplify things further below, eliminate the mode RETURN_AFTER_MESSAGES_SPECIAL_FILTER from further consideration.\n\t\t// g_DeferMessagesForUnderlyingPump is a global because the instance of MsgSleep on the call stack\n\t\t// that set it to true could launch new thread(s) that call MsgSleep again (i.e. a new layer), and a global\n\t\t// is the easiest way to inform all such MsgSleeps that there's a non-standard msg pump beneath them on the\n\t\t// call stack.\n\t\tif (!g_DeferMessagesForUnderlyingPump)\n\t\t{\n\t\t\tg_DeferMessagesForUnderlyingPump = true;\n\t\t\twe_turned_on_defer = true;\n\t\t}\n\t\t// So now either we turned it on or some layer beneath us did. Therefore, we know there's at least one\n\t\t// non-standard msg pump beneath us on the call stack.\n\t}\n\n\t// While in mode RETURN_AFTER_MESSAGES, there are different things that can happen:\n\t// 1) We launch a new hotkey subroutine, interrupting/suspending the old one. But\n\t// subroutine calls this function again, so now it's recursed. And thus the\n\t// new subroutine can be interrupted yet again.\n\t// 2) We launch a new hotkey subroutine, but it returns before any recursed call\n\t// to this function discovers yet another hotkey waiting in the queue. In this\n\t// case, this instance/recursion layer of the function should process the\n\t// hotkey messages linearly rather than recursively? No, this doesn't seem\n\t// necessary, because we can just return from our instance/layer and let the\n\t// caller handle any messages waiting in the queue. Eventually, the queue\n\t// should be emptied, especially since most hotkey subroutines will run\n\t// much faster than the user could press another hotkey, with the possible\n\t// exception of the key-repeat feature triggered by holding a key down.\n\t// Even in that case, the worst that would happen is that messages would\n\t// get dropped off the queue because they're too old (I think that's what\n\t// happens).\n\t// Based on the above, when mode is RETURN_AFTER_MESSAGES, we process\n\t// all messages until a hotkey message is encountered, at which time we\n\t// launch that subroutine only and then return when it returns to us, letting\n\t// the caller handle any additional messages waiting on the queue. This avoids\n\t// the need to have a \"run the hotkeys linearly\" mode in a single iteration/layer\n\t// of this function. Note: The WM_QUIT message does not receive any higher\n\t// precedence in the queue than other messages. Thus, if there's ever concern\n\t// that that message would be lost, as a future change perhaps can use PeekMessage()\n\t// with a filter to explicitly check to see if our queue has a WM_QUIT in it\n\t// somewhere, prior to processing any messages that might take result in\n\t// a long delay before the remainder of the queue items are processed (there probably\n\t// aren't any such conditions now, so nothing to worry about?)\n\n\t// Above is somewhat out-of-date. The objective now is to spend as much time\n\t// inside GetMessage() as possible, since it's the keystroke/mouse engine\n\t// whenever the hooks are installed. Any time we're not in GetMessage() for\n\t// any length of time (say, more than 20ms), keystrokes and mouse events\n\t// will be lagged. PeekMessage() is probably almost as good, but it probably\n\t// only clears out any waiting keys prior to returning. CONFIRMED: PeekMessage()\n\t// definitely routes to the hook, perhaps only if called regularly (i.e. a single\n\t// isolated call might not help much).\n\n\t// Decided to support a true Sleep(0) for aSleepDuration == 0, as well\n\t// as no delay at all if aSleepDuration < 0. This is needed to implement\n\t// \"SetKeyDelay, 0\" and possibly other things. I believe a Sleep(0)\n\t// is always <= Sleep(1) because both of these will wind up waiting\n\t// a full timeslice if the CPU is busy.\n\n\t// Reminder for anyone maintaining or revising this code:\n\t// Giving each subroutine its own thread rather than suspending old ones is\n\t// probably not a good idea due to the exclusive nature of the GUI\n\t// (i.e. it's probably better to suspend existing subroutines rather than\n\t// letting them continue to run because they might activate windows and do\n\t// other stuff that would interfere with the window automation activities of\n\t// other threads)\n\n\t// If caller didn't specify, the exact amount of the Sleep() isn't\n\t// critical to it, only that we handles messages and do Sleep()\n\t// a little.\n\t// Most of this initialization section isn't needed if aMode == WAIT_FOR_MESSAGES,\n\t// but it's done anyway for consistency:\n\tbool allow_early_return;\n\tif (aSleepDuration == INTERVAL_UNSPECIFIED)\n\t{\n\t\taSleepDuration = SLEEP_INTERVAL; // Set interval to be the default length.\n\t\tallow_early_return = true;\n\t}\n\telse\n\t\t// The timer resolution makes waiting for half or less of an\n\t\t// interval too chancy. The correct thing to do on average\n\t\t// is some kind of rounding, which this helps with:\n\t\tallow_early_return = (aSleepDuration <= SLEEP_INTERVAL_HALF);\n\n\t// Record the start time when the caller first called us so we can keep\n\t// track of how much time remains to sleep (in case the caller's subroutine\n\t// is suspended until a new subroutine is finished). But for small sleep\n\t// intervals, don't worry about it.\n\t// Note: QueryPerformanceCounter() has very high overhead compared to GetTickCount():\n\tDWORD start_time = allow_early_return ? 0 : GetTickCount();\n\n\t// This check is also done even if the main timer will be set (below) so that\n\t// an initial check is done rather than waiting 10ms more for the first timer\n\t// message to come in. Some of our many callers would want this, and although some\n\t// would not need it, there are so many callers that it seems best to just do it\n\t// unconditionally, especially since it's not a high overhead call (e.g. it returns\n\t// immediately if the tickcount is still the same as when it was last run).\n\t// Another reason for doing this check immediately is that our msg queue might\n\t// contains a time-consuming msg prior to our WM_TIMER msg, e.g. a hotkey msg.\n\t// In that case, the hotkey would be processed and launched without us first having\n\t// emptied the queue to discover the WM_TIMER msg. In other words, WM_TIMER msgs\n\t// might get buried in the queue behind others, so doing this check here should help\n\t// ensure that timed subroutines are checked often enough to keep them running at\n\t// their specified frequencies.\n\t// Note that ExecUntil() no longer needs to call us solely for prevention of lag\n\t// caused by the keyboard & mouse hooks, so checking the timers early, rather than\n\t// immediately going into the GetMessage() state, should not be a problem:\n\tPOLL_JOYSTICK_IF_NEEDED // Do this first since it's much faster.\n\tbool return_value = false; // Set default. Also, this is used by the macro below.\n\tCHECK_SCRIPT_TIMERS_IF_NEEDED\n\n\t// Because this function is called recursively: for now, no attempt is\n\t// made to improve performance by setting the timer interval to be\n\t// aSleepDuration rather than a standard short interval. That would cause\n\t// a problem if this instance of the function invoked a new subroutine,\n\t// suspending the one that called this instance. The new subroutine\n\t// might need a timer of a longer interval, which would mess up\n\t// this layer. One solution worth investigating is to give every\n\t// layer/instance its own timer (the ID of the timer can be determined\n\t// from info in the WM_TIMER message). But that can be a real mess\n\t// because what if a deeper recursion level receives our first\n\t// WM_TIMER message because we were suspended too long? Perhaps in\n\t// that case we wouldn't our WM_TIMER pulse because upon returning\n\t// from those deeper layers, we would check to see if the current\n\t// time is beyond our finish time. In addition, having more timers\n\t// might be worse for overall system performance than having a single\n\t// timer that pulses very frequently (because the system must keep\n\t// them all up-to-date). UPDATE: Timer is now also needed whenever an\n\t// aSleepDuration greater than 0 is about to be done and there are some\n\t// script timers that need to be watched (this happens when aMode == WAIT_FOR_MESSAGES).\n\t// UPDATE: Make this a macro so that it is dynamically resolved every time, in case\n\t// the value of g_script.mTimerEnabledCount changes on-the-fly.\n\t// UPDATE #2: The below has been changed in light of the fact that the main timer is\n\t// now kept always-on whenever there is at least one enabled timed subroutine.\n\t// This policy simplifies ExecUntil() and long-running commands such as FileSetAttrib.\n\t// UPDATE #3: Use aMode == RETURN_AFTER_MESSAGES, not g_nThreads > 0, because the\n\t// \"Edit This Script\" menu item (and possibly other places) might result in an indirect\n\t// call to us and we will need the timer to avoid getting stuck in the GetMessageState()\n\t// with hotkeys being disallowed due to filtering:\n\tbool this_layer_needs_timer = (aSleepDuration > 0 && aMode == RETURN_AFTER_MESSAGES);\n\tif (this_layer_needs_timer)\n\t{\n\t\t++g_nLayersNeedingTimer; // IsCycleComplete() is responsible for decrementing this for us.\n\t\tSET_MAIN_TIMER\n\t\t// Reasons why the timer might already have been on:\n\t\t// 1) g_script.mTimerEnabledCount is greater than zero or there are joystick hotkeys.\n\t\t// 2) another instance of MsgSleep() (beneath us in the stack) needs it (see the comments\n\t\t// in IsCycleComplete() near KILL_MAIN_TIMER for details).\n\t}\n\n\t// Only used when aMode == RETURN_AFTER_MESSAGES:\n\t// True if the current subroutine was interrupted by another:\n\t//bool was_interrupted = false;\n\tbool sleep0_was_done = false;\n\tbool empty_the_queue_via_peek = false;\n\tint messages_received = 0; // This is used to ensure we Sleep() at least a minimal amount if no messages are received.\n\n\tbool msg_was_handled;\n\tHWND fore_window, focused_control, criterion_found_hwnd;\n\tTCHAR wnd_class_name[32];\n\tUserMenuItem *menu_item;\n\tHotkeyIDType hk_id;\n\tHotkey *hk;\n\tUSHORT variant_id;\n\tHotkeyVariant *variant;\n\tint priority;\n\tHotstring *hs;\n\tGuiType *pgui; // This is just a temp variable and should not be referred to once the below has been determined.\n\tGuiControlType *pcontrol, *ptab_control;\n\tGuiIndexType gui_control_index;\n\tGuiEventType gui_action;\n\tUCHAR gui_event_kind;\n\tUINT gui_event_code;\n\tDWORD_PTR gui_event_info;\n\tBYTE gui_event_byte;\n\tbool event_is_control_generated;\n\tMsgMonitorList *check_if_running;\n\tExprTokenType gui_event_args[6]; // Current maximum number of arguments for Gui event handlers.\n\tint gui_event_arg_count;\n\tPOINT gui_point;\n\tHDROP hdrop_to_free;\n\tinput_type *input_hook;\n\tLRESULT msg_reply;\n\tBOOL peek_result;\n\tMSG msg;\n\n\tfor (;;) // Main event loop.\n\t{\n\t\tif (aSleepDuration > 0 && !empty_the_queue_via_peek && !g_DeferMessagesForUnderlyingPump) // g_Defer: Requires a series of Peeks to handle non-contiguous ranges, which is why GetMessage() can't be used.\n\t\t{\n\t\t\t// The following comment is mostly obsolete as of v1.0.39 (which introduces a thread\n\t\t\t// dedicated to the hooks). However, using GetMessage() is still superior to\n\t\t\t// PeekMessage() for performance reason. Add to that the risk of breaking things\n\t\t\t// and it seems clear that it's best to retain GetMessage().\n\t\t\t// Older comment:\n\t\t\t// Use GetMessage() whenever possible -- rather than PeekMessage() or a technique such\n\t\t\t// MsgWaitForMultipleObjects() -- because it's the \"engine\" that passes all keyboard\n\t\t\t// and mouse events immediately to the low-level keyboard and mouse hooks\n\t\t\t// (if they're installed). Otherwise, there's greater risk of keyboard/mouse lag.\n\t\t\t// PeekMessage(), depending on how, and how often it's called, will also do this, but\n\t\t\t// I'm not as confident in it.\n\t\t\tif (GetMessage(&msg, NULL, 0, MSG_FILTER_MAX) == -1) // -1 is an error, 0 means WM_QUIT\n\t\t\t\tcontinue; // Error probably happens only when bad parameters were passed to GetMessage().\n\t\t\t//else let any WM_QUIT be handled below.\n\t\t}\n\t\telse // aSleepDuration < 1 || empty_the_queue_via_peek || g_DeferMessagesForUnderlyingPump\n\t\t{\n\t\t\tbool do_special_msg_filter, peek_was_done = false; // Set default.\n\t\t\t// Check the active window in each iteration in case a significant amount of time has passed since\n\t\t\t// the previous iteration (due to launching threads, etc.)\n\t\t\tif (g_DeferMessagesForUnderlyingPump && (fore_window = GetForegroundWindow()) != NULL // There is a foreground window.\n\t\t\t\t&& GetWindowThreadProcessId(fore_window, NULL) == g_MainThreadID) // And it belongs to our main thread (the main thread is the only one that owns any windows).\n\t\t\t{\n\t\t\t\tdo_special_msg_filter = false; // Set default.\n if (g_nFileDialogs) // v1.0.44.12: Also do the special Peek/msg filter below for FileSelect because testing shows that frequently-running timers disrupt the ability to double-click.\n\t\t\t\t\tdo_special_msg_filter = IsWindowStandardDialog(fore_window); // Due to checking g_nFileDialogs above, this means that this dialog is probably FileSelect rather than MsgBox/InputBox/DirSelect (even if this guess is wrong, it seems fairly inconsequential to filter the messages since other pump beneath us on the call-stack will handle them ok).\n\t\t\t\tif (!do_special_msg_filter && (focused_control = GetFocus()))\n\t\t\t\t{\n\t\t\t\t\tGetClassName(focused_control, wnd_class_name, _countof(wnd_class_name));\n\t\t\t\t\tdo_special_msg_filter = !_tcsicmp(wnd_class_name, _T(\"SysTreeView32\")) // A TreeView owned by our thread has focus (includes DirSelect's TreeView).\n\t\t\t\t\t\t|| !_tcsicmp(wnd_class_name, _T(\"SysListView32\"));\n\t\t\t\t}\n\t\t\t\tif (do_special_msg_filter)\n\t\t\t\t{\n\t\t\t\t\t// v1.0.48.03: Below now applies to SysListView32 because otherwise a timer that runs\n\t\t\t\t\t// while the user is dragging a rectangle around a selection (Marquee) can cause the\n\t\t\t\t\t// mouse button to appear to be stuck down down after the user releases it.\n\t\t\t\t\t// v1.0.44.12: Below now applies to FileSelect dialogs too (see reason above).\n\t\t\t\t\t// v1.0.44.11: Since one of our thread's TreeViews has focus (even in DirSelect), this\n\t\t\t\t\t// section is a work-around for the fact that the TreeView's message pump (somewhere beneath\n\t\t\t\t\t// us on the call stack) is apparently designed to process some mouse messages directly rather\n\t\t\t\t\t// than receiving them indirectly (in its WindowProc) via our call to DispatchMessage() here\n\t\t\t\t\t// in this pump. The symptoms of this issue are an inability of a user to reliably select\n\t\t\t\t\t// items in a TreeView (the selection sometimes snaps back to the previously selected item),\n\t\t\t\t\t// which can be reproduced by showing a TreeView while a 10ms script timer is running doing\n\t\t\t\t\t// a trivial single line such as x=1.\n\t\t\t\t\t// NOTE: This happens more often in DirSelect dialogs, I believe because it's msg\n\t\t\t\t\t// pump is ALWAYS running but that of a GUI TreeView is running only during mouse capture\n\t\t\t\t\t// (i.e. when left/right button is down).\n\t\t\t\t\t// This special handling for TreeView can someday be broadened so that focused control's\n\t\t\t\t\t// class isn't checked: instead, could check whether left and/or right mouse button is\n\t\t\t\t\t// logically down (which hasn't yet been tested). Or it could be broadened to include\n\t\t\t\t\t// other system dialogs and/or common controls that have unusual processing in their\n\t\t\t\t\t// message pumps -- processing that requires them to directly receive certain messages\n\t\t\t\t\t// rather than having them dispatched directly to their WindowProc.\n\t\t\t\t\tpeek_was_done = true;\n\t\t\t\t\t// Peek() must be used instead of Get(), and Peek() must be called more than once to handle\n\t\t\t\t\t// the two ranges on either side of the mouse messages. But since it would be improper\n\t\t\t\t\t// to process messages out of order (and might lead to side-effects), force the retrieval\n\t\t\t\t\t// to be in chronological order by checking the timestamps of each Peek first message, and\n\t\t\t\t\t// then fetching the one that's oldest (since it should be the one that's been waiting the\n\t\t\t\t\t// longest and thus generally should be ahead of the other Peek's message in the queue):\n\t\t\t\t\tUINT filter_max = (IsInterruptible() ? UINT_MAX : WM_HOTKEY - 1); // Fixed in v1.1.16 to not use MSG_FILTER_MAX, which would produce 0 when IsInterruptible(). Although WM_MOUSELAST+1..0 seems to produce the right results, MSDN does not indicate that it is valid.\n#define PEEK1(mode) PeekMessage(&msg, NULL, 0, WM_MOUSEFIRST-1, mode) // Relies on the fact that WM_MOUSEFIRST < MSG_FILTER_MAX\n#define PEEK2(mode) PeekMessage(&msg, NULL, WM_MOUSELAST+1, filter_max, mode)\n\t\t\t\t\tif (!PEEK1(PM_NOREMOVE)) // Since no message in Peek1, safe to always use Peek2's (even if it has no message either).\n\t\t\t\t\t\tpeek_result = PEEK2(PM_REMOVE);\n\t\t\t\t\telse // Peek1 has a message. So if Peek2 does too, compare their timestamps.\n\t\t\t\t\t{\n\t\t\t\t\t\tDWORD peek1_time = msg.time; // Save it due to overwrite in next line.\n\t\t\t\t\t\tif (!PEEK2(PM_NOREMOVE)) // Since no message in Peek2, use Peek1's.\n\t\t\t\t\t\t\tpeek_result = PEEK1(PM_REMOVE);\n\t\t\t\t\t\telse // Both Peek2 and Peek1 have a message waiting, so to break the tie, retrieve the oldest one.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// In case tickcount has wrapped, compare it the better way (must cast to int to avoid\n\t\t\t\t\t\t\t// loss of negative values):\n\t\t\t\t\t\t\tpeek_result = ((int)(msg.time - peek1_time) > 0) // Peek2 is newer than Peek1, so treat peak1 as oldest and thus first in queue.\n\t\t\t\t\t\t\t\t? PEEK1(PM_REMOVE) : PEEK2(PM_REMOVE);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (!peek_was_done) // Since above didn't Peek(), fall back to doing the Peek with the standard filter.\n\t\t\t\tpeek_result = PeekMessage(&msg, NULL, 0, MSG_FILTER_MAX, PM_REMOVE);\n\t\t\tif (!peek_result) // No more messages\n\t\t\t{\n\t\t\t\t// UPDATE: The section marked \"OLD\" below is apparently not quite true: although Peek() has been\n\t\t\t\t// caught yielding our timeslice, it's now difficult to reproduce. Perhaps it doesn't consistently\n\t\t\t\t// yield (maybe it depends on the relative priority of competing processes) and even when/if it\n\t\t\t\t// does yield, it might somehow not be as long or as good as Sleep(0). This is evidenced by the fact\n\t\t\t\t// that some of my script's WinWaitClose's finish too quickly when the Sleep(0) is omitted after a\n\t\t\t\t// Peek() that returned FALSE.\n\t\t\t\t// OLD (mostly obsolete in light of above): It is not necessary to actually do the Sleep(0) when\n\t\t\t\t// aSleepDuration == 0 because the most recent PeekMessage() has just yielded our prior timeslice.\n\t\t\t\t// This is because when Peek() doesn't find any messages, it automatically behaves as though it\n\t\t\t\t// did a Sleep(0).\n\t\t\t\tif (aSleepDuration == 0 && !sleep0_was_done)\n\t\t\t\t{\n\t\t\t\t\tSleep(0);\n\t\t\t\t\tsleep0_was_done = true;\n\t\t\t\t\t// Now start a new iteration of the loop that will see if we\n\t\t\t\t\t// received any messages during the up-to-20ms delay (perhaps even more)\n\t\t\t\t\t// that just occurred. It's done this way to minimize keyboard/mouse\n\t\t\t\t\t// lag (if the hooks are installed) that will occur if any key or\n\t\t\t\t\t// mouse events are generated during that 20ms. Note: It seems that\n\t\t\t\t\t// the OS knows not to yield our timeslice twice in a row: once for\n\t\t\t\t\t// the Sleep(0) above and once for the upcoming PeekMessage() (if that\n\t\t\t\t\t// PeekMessage() finds no messages), so it does not seem necessary\n\t\t\t\t\t// to check HIWORD(GetQueueStatus(QS_ALLEVENTS)). This has been confirmed\n\t\t\t\t\t// via the following test, which shows that while BurnK6 (CPU maxing program)\n\t\t\t\t\t// is foreground, a Sleep(0) really does a Sleep(60). But when it's not\n\t\t\t\t\t// foreground, it only does a Sleep(20). This behavior is UNAFFECTED by\n\t\t\t\t\t// the added presence of a HIWORD(GetQueueStatus(QS_ALLEVENTS)) check here:\n\t\t\t\t\t//SplashTextOn,,, xxx\n\t\t\t\t\t//WinWait, xxx ; set last found window\n\t\t\t\t\t//Loop\n\t\t\t\t\t//{\n\t\t\t\t\t//\tstart = %a_tickcount%\n\t\t\t\t\t//\tSleep, 0\n\t\t\t\t\t//\telapsed = %a_tickcount%\n\t\t\t\t\t//\telapsed -= %start%\n\t\t\t\t\t//\tWinSetTitle, %elapsed%\n\t\t\t\t\t//}\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\t// Otherwise: aSleepDuration is non-zero or we already did the Sleep(0)\n\t\t\t\tif (messages_received == 0 && allow_early_return)\n\t\t\t\t{\n\t\t\t\t\t// Fix for v1.1.05.04: Since Peek() didn't find a message, avoid maxing the CPU.\n\t\t\t\t\t// This specific section is needed for Wait() when an underlying thread\n\t\t\t\t\t// is displaying a dialog, and perhaps in other cases.\n\t\t\t\t\t// Fix for v1.1.07.00: Avoid Sleep() if caller specified a duration of zero;\n\t\t\t\t\t// otherwise SendEvent with a key delay of 0 will be slower than expected.\n\t\t\t\t\t// This affects auto-replace hotstrings in SendEvent mode (which is the default\n\t\t\t\t\t// when SendInput is unavailable). Note that if aSleepDuration == 0, Sleep(0)\n\t\t\t\t\t// was already called above or by a prior iteration.\n\t\t\t\t\tif (aSleepDuration > 0)\n\t\t\t\t\t\tSleep(5); // This is a somewhat arbitrary value: the intent of a value below 10 is to avoid yielding more than one timeslice on all systems even if they have unusual timeslice sizes / system timers.\n\t\t\t\t\t++messages_received; // Don't repeat this section.\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\t// Notes for the macro further below:\n\t\t\t\t// Must decrement prior to every RETURN to balance it.\n\t\t\t\t// Do this prior to checking whether timer should be killed, below.\n\t\t\t\t// Kill the timer only if we're about to return OK to the caller since the caller\n\t\t\t\t// would still need the timer if FAIL was returned above. But don't kill it if\n\t\t\t\t// there are any enabled timed subroutines, because the current policy it to keep\n\t\t\t\t// the main timer always-on in those cases. UPDATE: Also avoid killing the timer\n\t\t\t\t// if there are any script threads running. To do so might cause a problem such\n\t\t\t\t// as in this example scenario: MsgSleep() is called for any reason with a delay\n\t\t\t\t// large enough to require the timer. The timer is set. But a msg arrives that\n\t\t\t\t// MsgSleep() dispatches to MainWindowProc(). If it's a hotkey or custom menu,\n\t\t\t\t// MsgSleep() is called recursively with a delay of -1. But when it finishes via\n\t\t\t\t// IsCycleComplete(), the timer would be wrongly killed because the underlying\n\t\t\t\t// instance of MsgSleep still needs it. Above is even more wide-spread because if\n\t\t\t\t// MsgSleep() is called recursively for any reason, even with a duration >10, it will\n\t\t\t\t// wrongly kill the timer upon returning, in some cases. For example, if the first call to\n\t\t\t\t// MsgSleep(-1) finds a hotkey or menu item msg, and executes the corresponding subroutine,\n\t\t\t\t// that subroutine could easily call MsgSleep(10+) for any number of reasons, which\n\t\t\t\t// would then kill the timer.\n\t\t\t\t// Also require that aSleepDuration > 0 so that MainWindowProc()'s receipt of a\n\t\t\t\t// WM_HOTKEY msg, to which it responds by turning on the main timer if the script\n\t\t\t\t// is uninterruptible, is not defeated here. In other words, leave the timer on so\n\t\t\t\t// that when the script becomes interruptible once again, the hotkey will take effect\n\t\t\t\t// almost immediately rather than having to wait for the displayed dialog to be\n\t\t\t\t// dismissed (if there is one).\n\t\t\t\t//\n\t\t\t\t// \"we_turned_on_defer\" is necessary to prevent us from turning it off if some other\n\t\t\t\t// instance of MsgSleep beneath us on the calls stack turned it on. Only it should\n\t\t\t\t// turn it off because it might still need the \"true\" value for further processing.\n\t\t\t\t#define RETURN_FROM_MSGSLEEP \\\n\t\t\t\t{\\\n\t\t\t\t\tif (we_turned_on_defer)\\\n\t\t\t\t\t\tg_DeferMessagesForUnderlyingPump = false;\\\n\t\t\t\t\tif (this_layer_needs_timer)\\\n\t\t\t\t\t{\\\n\t\t\t\t\t\t--g_nLayersNeedingTimer;\\\n\t\t\t\t\t\tif (aSleepDuration > 0 && !g_nLayersNeedingTimer && !g_script.mTimerEnabledCount && !Hotkey::sJoyHotkeyCount)\\\n\t\t\t\t\t\t\tKILL_MAIN_TIMER \\\n\t\t\t\t\t}\\\n\t\t\t\t\treturn return_value;\\\n\t\t\t\t}\n\t\t\t\t// IsCycleComplete should always return OK in this case. Also, was_interrupted\n\t\t\t\t// will always be false because if this \"aSleepDuration < 1\" call really\n\t\t\t\t// was interrupted, it would already have returned in the hotkey cases\n\t\t\t\t// of the switch(). UPDATE: was_interrupted can now the hotkey case in\n\t\t\t\t// the switch() doesn't return, relying on us to do it after making sure\n\t\t\t\t// the queue is empty.\n\t\t\t\t// The below is checked here rather than in IsCycleComplete() because\n\t\t\t\t// that function is sometimes called more than once prior to returning\n\t\t\t\t// (e.g. empty_the_queue_via_peek) and we only want this to be decremented once:\n\t\t\t\tif (IsCycleComplete(aSleepDuration, start_time, allow_early_return)) // v1.0.44.11: IsCycleComplete() must be called for all modes, but now its return value is checked due to the new g_DeferMessagesForUnderlyingPump mode.\n\t\t\t\t\tRETURN_FROM_MSGSLEEP\n\t\t\t\t// Otherwise (since above didn't return) combined logic has ensured that all of the following are true:\n\t\t\t\t// 1) aSleepDuration > 0\n\t\t\t\t// 2) !empty_the_queue_via_peek\n\t\t\t\t// 3) The above two combined with logic above means that g_DeferMessagesForUnderlyingPump==true.\n\t\t\t\tSleep(5); // Since Peek() didn't find a message, avoid maxing the CPU. This is a somewhat arbitrary value: the intent of a value below 10 is to avoid yielding more than one timeslice on all systems even if they have unusual timeslice sizes / system timers.\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// else Peek() found a message, so process it below.\n\t\t} // PeekMessage() vs. GetMessage()\n\n\t\t// Since above didn't return or \"continue\", a message has been received that is eligible\n\t\t// for further processing.\n\t\t++messages_received;\n\n\t\t// For max. flexibility, it seems best to allow the message filter to have the first\n\t\t// crack at looking at the message, before even TRANSLATE_AHK_MSG:\n\t\tif (g_MsgMonitor.Count() && MsgMonitor(msg.hwnd, msg.message, msg.wParam, msg.lParam, &msg, msg_reply)) // Count is checked here to avoid function-call overhead.\n\t\t{\n\t\t\tcontinue; // MsgMonitor has returned \"true\", indicating that this message should be omitted from further processing.\n\t\t\t// NOTE: Above does \"continue\" and ignores msg_reply. This is because testing shows that\n\t\t\t// messages received via Get/PeekMessage() were always sent via PostMessage. If an\n\t\t\t// another thread sends ours a message, MSDN implies that Get/PeekMessage() internally\n\t\t\t// calls the message's WindowProc directly and sends the reply back to the other thread.\n\t\t\t// That makes sense because it seems unlikely that DispatchMessage contains any means\n\t\t\t// of replying to a message because it has no way of knowing whether the MSG struct\n\t\t\t// arrived via Post vs. SendMessage.\n\t\t}\n\n\t\t// If this message might be for one of our GUI windows, check that before doing anything\n\t\t// else with the message. This must be done first because some of the standard controls\n\t\t// also use WM_USER messages, so we must not assume they're generic thread messages just\n\t\t// because they're >= WM_USER. The exception is AHK_GUI_ACTION should always be handled\n\t\t// here rather than by IsDialogMessage().\n\t\t// UPDATE: MSDN isn't clear about which messages IsDialogMessage() dispatches, so it's\n\t\t// now only used for keyboard handling. This reduces code complexity a little and\n\t\t// eliminates some uncertainty about message routing. All of the cases for WM_USER\n\t\t// range messages below already checked msg.hwnd to ensure it is one of our messages.\n\t\t// UPDATE: Mouse messages must also be passed through IsDialogMessage() so that clicking\n\t\t// a Button will temporarily apply the BS_DEFPUSHBUTTON style.\n\t\tif (g_firstGui // Checked first to help performance, since all messages must come through this bottleneck.\n\t\t\t&& (msg.message >= WM_KEYFIRST && msg.message <= WM_KEYLAST\n\t\t\t\t|| msg.message >= WM_MOUSEFIRST && msg.message <= WM_MOUSELAST)\n\t\t\t&& (pgui = GuiType::FindGuiParent(msg.hwnd))) // Ordered for short-circuit performance.\n\t\t{\n\t\t\tfocused_control = msg.hwnd; // Alias for maintainability. Seems more appropriate (and efficient) to use this vs. GetFocus().\n\n\t\t\tif (pgui->mAccel) // v1.1.04: Keyboard accelerators.\n\t\t\t\tif (TranslateAccelerator(pgui->mHwnd, pgui->mAccel, &msg))\n\t\t\t\t\tcontinue; // Above call handled it.\n\n\t\t\t// Relies heavily on short-circuit boolean order:\n\t\t\tif ( msg.message == WM_KEYDOWN && pgui->mTabControlCount\n\t\t\t\t&& (msg.wParam == VK_NEXT || msg.wParam == VK_PRIOR || msg.wParam == VK_TAB\n\t\t\t\t\t|| msg.wParam == VK_LEFT || msg.wParam == VK_RIGHT)\n\t\t\t\t&& (pcontrol = pgui->FindControl(focused_control)) && pcontrol->type != GUI_CONTROL_HOTKEY )\n\t\t\t{\n\t\t\t\tptab_control = NULL; // Set default.\n\t\t\t\tif (pcontrol->type == GUI_CONTROL_TAB) // The focused control is a tab control itself.\n\t\t\t\t{\n\t\t\t\t\tptab_control = pcontrol;\n\t\t\t\t\t// For the below, note that Alt-left and Alt-right are automatically excluded,\n\t\t\t\t\t// as desired, since any key modified only by alt would be WM_SYSKEYDOWN vs. WM_KEYDOWN.\n\t\t\t\t\tif (msg.wParam == VK_LEFT || msg.wParam == VK_RIGHT)\n\t\t\t\t\t{\n\t\t\t\t\t\tpgui->SelectAdjacentTab(*ptab_control, msg.wParam == VK_RIGHT, false, false);\n\t\t\t\t\t\t// Pass false for both the above since that's the whole point of having arrow\n\t\t\t\t\t\t// keys handled separately from the below: Focus should stay on the tabs\n\t\t\t\t\t\t// rather than jumping to the first control of the tab, it focus should not\n\t\t\t\t\t\t// wrap around to the beginning or end (to conform to standard behavior for\n\t\t\t\t\t\t// arrow keys).\n\t\t\t\t\t\tcontinue; // Suppress this key even if the above failed (probably impossible in this case).\n\t\t\t\t\t}\n\t\t\t\t\t//else fall through to the next part.\n\t\t\t\t}\n\t\t\t\t// If focus is in a multiline edit control, don't act upon Control-Tab (and\n\t\t\t\t// shift-control-tab -> for simplicity & consistency) since Control-Tab is a special\n\t\t\t\t// keystroke that inserts a literal tab in the edit control:\n\t\t\t\tif ( msg.wParam != VK_LEFT && msg.wParam != VK_RIGHT\n\t\t\t\t\t&& (GetKeyState(VK_CONTROL) & 0x8000) // Even if other modifiers are down, it still qualifies. Use GetKeyState() vs. GetAsyncKeyState() because the former's definition is more suitable.\n\t\t\t\t\t&& (msg.wParam != VK_TAB || pcontrol->type != GUI_CONTROL_EDIT\n\t\t\t\t\t\t|| !(GetWindowLong(pcontrol->hwnd, GWL_STYLE) & ES_MULTILINE)) )\n\t\t\t\t{\n\t\t\t\t\t// If ptab_control wasn't determined above, check if focused control is owned by a tab control:\n\t\t\t\t\tif (!ptab_control && !(ptab_control = pgui->FindTabControl(pcontrol->tab_control_index)) )\n\t\t\t\t\t\t// Fall back to the first tab control (for consistency & simplicity, seems best\n\t\t\t\t\t\t// to always use the first rather than something fancier such as \"nearest in z-order\".\n\t\t\t\t\t\tptab_control = pgui->FindTabControl(0);\n\t\t\t\t\tif (ptab_control && IsWindowEnabled(ptab_control->hwnd))\n\t\t\t\t\t{\n\t\t\t\t\t\tpgui->SelectAdjacentTab(*ptab_control\n\t\t\t\t\t\t\t, msg.wParam == VK_NEXT || (msg.wParam == VK_TAB && !(GetKeyState(VK_SHIFT) & 0x8000)) // Use GetKeyState() vs. GetAsyncKeyState() because the former's definition is more suitable.\n\t\t\t\t\t\t\t, true, true);\n\t\t\t\t\t\t// Update to the below: Must suppress the tab key at least, to prevent it\n\t\t\t\t\t\t// from navigating *and* changing the tab. And since this one is suppressed,\n\t\t\t\t\t\t// might as well suppress the others for consistency.\n\t\t\t\t\t\t// Older: Since WM_KEYUP is not handled/suppressed here, it seems best not to\n\t\t\t\t\t\t// suppress this WM_KEYDOWN either (it should do nothing in this case\n\t\t\t\t\t\t// anyway, but for balance this seems best): Fall through to the next section.\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\t//else fall through to the below.\n\t\t\t\t}\n\t\t\t\t//else fall through to the below.\n\t\t\t} // Interception of keystrokes for navigation in tab control.\n\n\t\t\t// v1.0.34: Fix for the fact that a multiline edit control will send WM_CLOSE to its parent\n\t\t\t// when user presses ESC while it has focus. The following check is similar to the block's above.\n\t\t\t// The alternative to this approach would have been to override the edit control's WindowProc,\n\t\t\t// but the following seemed to be less code. Although this fix is only necessary for multiline\n\t\t\t// edits, its done for all edits since it doesn't do any harm. In addition, there is no need to\n\t\t\t// check what modifiers are down because we never receive the keystroke for Ctrl-Esc and Alt-Esc\n\t\t\t// (the OS handles those beforehand) and both Win-Esc and Shift-Esc are identical to a naked Esc\n\t\t\t// inside an edit. The following check relies heavily on short-circuit eval. order.\n\t\t\tif ( msg.message == WM_KEYDOWN\n\t\t\t\t&& (msg.wParam == VK_ESCAPE || msg.wParam == VK_TAB // v1.0.38.03: Added VK_TAB handling for \"WantTab\".\n\t\t\t\t\t|| (msg.wParam == 'A' && (GetKeyState(VK_CONTROL) & 0x8000) // v1.0.44: Added support for \"WantCtrlA\".\n\t\t\t\t\t\t&& !(GetKeyState(VK_RMENU) & 0x8000))) // v1.1.17: Exclude AltGr+A (Ctrl+Alt+A).\n\t\t\t\t&& (pcontrol = pgui->FindControl(focused_control))\n\t\t\t\t&& pcontrol->type == GUI_CONTROL_EDIT)\n\t\t\t{\n\t\t\t\tswitch(msg.wParam)\n\t\t\t\t{\n\t\t\t\tcase 'A': // v1.0.44: Support for Ctrl-A to select all text.\n\t\t\t\t\tif (!(pcontrol->attrib & GUI_CONTROL_ATTRIB_ALTSUBMIT)) // i.e. presence of AltSubmit bit DISABLES Ctrl-A handling.\n\t\t\t\t\t{\n\t\t\t\t\t\tSendMessage(pcontrol->hwnd, EM_SETSEL, 0, -1); // Select all text.\n\t\t\t\t\t\tcontinue; // Omit this keystroke from any further processing.\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase VK_ESCAPE:\n\t\t\t\t\tpgui->Escape();\n\t\t\t\t\tcontinue; // Omit this keystroke from any further processing.\n\t\t\t\tdefault: // VK_TAB\n\t\t\t\t\tif ((pcontrol->attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR) // It has the \"WantTab\" property.\n\t\t\t\t\t\t&& !(GetWindowLong(pcontrol->hwnd, GWL_STYLE) & ES_READONLY)) // It doesn't have \"ReadOnly\".\n\t\t\t\t\t{\n\t\t\t\t\t\t// For flexibility, do this even for single-line edit controls, though in that\n\t\t\t\t\t\t// case the tab keystroke will produce an \"empty box\" character.\n\t\t\t\t\t\t// Strangely, if a message pump other than this one (MsgSleep) is running,\n\t\t\t\t\t\t// such as that of a MsgBox, \"WantTab\" is already in effect unconditionally,\n\t\t\t\t\t\t// perhaps because MsgBox and others respond to WM_GETDLGCODE with DLGC_WANTTAB.\n\t\t\t\t\t\tSendMessage(pcontrol->hwnd, EM_REPLACESEL, TRUE, (LPARAM)\"\\t\");\n\t\t\t\t\t\tcontinue; // Omit this keystroke from any further processing.\n\t\t\t\t\t}\n\t\t\t\t} // switch()\n\t\t\t}\n\n\t\t\tif (GuiType::sTreeWithEditInProgress && msg.message == WM_KEYDOWN)\n\t\t\t{\n\t\t\t\tif (msg.wParam == VK_RETURN)\n\t\t\t\t{\n\t\t\t\t\tTreeView_EndEditLabelNow(GuiType::sTreeWithEditInProgress, FALSE); // Save changes to label/text.\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\telse if (msg.wParam == VK_ESCAPE)\n\t\t\t\t{\n\t\t\t\t\tTreeView_EndEditLabelNow(GuiType::sTreeWithEditInProgress, TRUE); // Cancel without saving.\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// IsDialogMessage() takes care of standard keyboard handling within the dialog,\n\t\t\t// such as tab to change focus and Enter to activate the default button.\n\t\t\t// Avoid calling IsDialogMessage() for WM_SYSCHAR if the GUI has no controls.\n\t\t\t// It seems that if a GUI has no controls, IsDialogMessage() will return true for\n\t\t\t// Alt+n combinations without invoking the default processing, such as focusing\n\t\t\t// a menu bar item. IsDialogMessage() still needs to be called for some messages;\n\t\t\t// at the very least, WM_KEYDOWN (VK_ESC) must be intercepted for GuiEscape to work.\n\t\t\tif (pgui->mControlCount || msg.message != WM_SYSCHAR)\n\t\t\t{\n\t\t\t\tg_CalledByIsDialogMessageOrDispatch = &msg;\n\t\t\t\tmsg_was_handled = IsDialogMessage(pgui->mHwnd, &msg); // Pass the dialog HWND, not msg.hwnd, which is often a control.\n\t\t\t\tg_CalledByIsDialogMessageOrDispatch = nullptr;\n\t\t\t\tif (msg_was_handled) // This message was handled by IsDialogMessage() above.\n\t\t\t\t\tcontinue; // Continue with the main message loop.\n\t\t\t}\n\t\t} // if (keyboard or mouse message posted to GUI)\n\n\t\t// v1.0.44: There's no reason to call TRANSLATE_AHK_MSG here because all WM_COMMNOTIFY messages\n\t\t// are sent to g_hWnd. Thus, our call to DispatchMessage() later below will route such messages to\n\t\t// MainWindowProc(), which will then call TRANSLATE_AHK_MSG().\n\t\t//TRANSLATE_AHK_MSG(msg.message, msg.wParam)\n\n\t\tswitch(msg.message)\n\t\t{\n\t\t// MSG_FILTER_MAX should prevent us from receiving this first group of messages whenever g_AllowInterruption or\n\t\t// g->AllowThreadToBeInterrupted is false.\n\t\tcase AHK_HOOK_HOTKEY: // Sent from this app's keyboard or mouse hook.\n\t\tcase AHK_HOTSTRING: // Sent from keybd hook to activate a non-auto-replace hotstring.\n\t\tcase AHK_CLIPBOARD_CHANGE:\n\t\t\t// This extra handling is present because common controls and perhaps other OS features tend\n\t\t\t// to use WM_USER+NN messages, a practice that will probably be even more common in the future.\n\t\t\t// To cut down on message conflicts, dispatch such messages whenever their HWND isn't a what\n\t\t\t// it should be for a message our own code generated. That way, the target control (if any)\n\t\t\t// will still get the msg.\n\t\t\tif (msg.hwnd && msg.hwnd != g_hWnd) // v1.0.44: It's wasn't sent by our code; perhaps by a common control's code.\n\t\t\t\tbreak; // Dispatch it vs. discarding it, in case it's for a control.\n\t\t\t//ELSE FALL THROUGH:\n\t\tcase AHK_GUI_ACTION: // The user pressed a button on a GUI window, or some other actionable event. Listed before the below for performance.\n\t\tcase WM_HOTKEY: // As a result of this app having previously called RegisterHotkey(), or from TriggerJoyHotkeys().\n\t\tcase AHK_USER_MENU: // The user selected a custom menu item.\n\t\tcase AHK_INPUT_END: // Input ended (sent by the hook thread).\n\t\tcase AHK_INPUT_KEYDOWN:\n\t\tcase AHK_INPUT_CHAR:\n\t\tcase AHK_INPUT_KEYUP:\n\t\t{\n\t\t\thdrop_to_free = NULL; // Set default for this message's processing (simplifies code).\n\t\t\tswitch(msg.message)\n\t\t\t{\n\t\t\tcase AHK_GUI_ACTION: // Listed first for performance.\n\t\t\t\t// Assume that it is possible that this message's GUI window has been destroyed\n\t\t\t\t// (and maybe even recreated) since the time the msg was posted. If this can happen,\n\t\t\t\t// that's another reason for finding which GUI this control is associate with (it also\n\t\t\t\t// needs to be found so that we can call the correct GUI window object to perform\n\t\t\t\t// the action):\n\t\t\t\tif ( !(pgui = GuiType::FindGui(msg.hwnd)) ) // No associated GUI object, so ignore this event.\n\t\t\t\t\t// v1.0.44: Dispatch vs. continue/discard since it's probably for a common control\n\t\t\t\t\t// whose msg number happens to be AHK_GUI_ACTION. Do this *only* when HWND isn't recognized,\n\t\t\t\t\t// not when msg content is invalid, because dispatching a msg whose HWND is one of our own\n\t\t\t\t\t// GUI windows might cause GuiWindowProc to fwd it back to us, creating an infinite loop.\n\t\t\t\t\tgoto break_out_of_main_switch; // Goto seems preferably in this case for code size & performance.\n\t\t\t\t\n\t\t\t\tgui_event_info = (DWORD_PTR)msg.lParam;\n\t\t\t\tgui_action = LOBYTE(msg.wParam); // Byte 0.\n\t\t\t\tgui_event_byte = HIBYTE(msg.wParam); // Byte 1. Sometimes used as an additional parameter.\n\t\t\t\tgui_control_index = HIWORD(msg.wParam); // Bytes 2-3. Caller has set it to NO_CONTROL_INDEX if it isn't applicable.\n\t\t\t\tgui_event_arg_count = 0;\n\t\t\t\tgui_event_code = gui_action; // Set default. Using both this and gui_action simplifies some things.\n\n\t\t\t\tpcontrol = gui_control_index < pgui->mControlCount ? pgui->mControl[gui_control_index] : NULL; // Set for use in other places below.\n\n\t\t\t\tcheck_if_running = &pgui->mEvents; // Set default.\n\t\t\t\tevent_is_control_generated = false; // Set default.\n\t\t\t\tgui_event_kind = GUI_EVENTKIND_EVENT; // Set default.\n\n\t\t\t\tswitch(gui_action)\n\t\t\t\t{\n\t\t\t\tcase GUI_EVENT_CLOSE:\n\t\t\t\tcase GUI_EVENT_ESCAPE:\n\t\t\t\tcase GUI_EVENT_RESIZE:\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_EVENT_CONTEXTMENU:\n\t\t\t\t\t// Must allow multiple threads because otherwise the user cannot right-click twice consecutively\n\t\t\t\t\t// (the second click is blocked because the menu is still displayed at the instant of the click).\n\t\t\t\t\tcheck_if_running = NULL;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_EVENT_DROPFILES:\n\t\t\t\t\thdrop_to_free = pgui->mHdrop; // This variable simplifies the code further below.\n\t\t\t\t\tif ( !hdrop_to_free // Checked just in case, so that the below can query it.\n\t\t\t\t\t\t|| !(gui_event_info = DragQueryFile(hdrop_to_free, 0xFFFFFFFF, NULL, 0)) ) // Probably impossible, but if it ever can happen, seems best to ignore it.\n\t\t\t\t\t{\n\t\t\t\t\t\tif (hdrop_to_free) // Checked again in case short-circuit boolean above never checked it.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tDragFinish(hdrop_to_free); // Since the drop-thread will not be launched, free the memory.\n\t\t\t\t\t\t\tpgui->mHdrop = NULL; // Indicate that this GUI window is ready for another drop.\n\t\t\t\t\t\t}\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\t// mHdrop != NULL prevents another DROPFILES event from being queued, up until the\n\t\t\t\t\t// message is received here and we remove WS_EX_ACCEPTFILES. After that the user\n\t\t\t\t\t// can no longer drop files onto the window, but it may still be necessary to check\n\t\t\t\t\t// for running instances in case of:\n\t\t\t\t\t// 1) Another WM_DROPFILES already in the queue, but not yet processed.\n\t\t\t\t\t// 2) Someone posting WM_DROPFILES (i.e. fake drag and drop).\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_EVENT_WM_COMMAND:\n\t\t\t\t\tgui_event_kind = GUI_EVENTKIND_COMMAND;\n\t\t\t\t\tgui_event_code = (GuiEventType)gui_event_info;\n\t\t\t\t\t// Fall through:\n\t\t\t\tdefault: // This is an action from a particular control in the GUI window.\n\t\t\t\t\tif (!pcontrol) // gui_control_index was beyond the quantity of controls, possibly due to parent window having been destroyed since the msg was sent (or bogus msg).\n\t\t\t\t\t\tcontinue; // Discarding an invalid message here is relied upon both other sections below.\n\t\t\t\t\t// It seems best by default not to allow multiple threads for the same event.\n\t\t\t\t\t// Such events are discarded because it seems likely that most script designers\n\t\t\t\t\t// would want to see the effects of faulty design (e.g. long running timers or\n\t\t\t\t\t// hotkeys that interrupt gui threads) rather than having events for later,\n\t\t\t\t\t// when they might suddenly take effect unexpectedly.\n\t\t\t\t\tcheck_if_running = &pcontrol->events;\n\t\t\t\t\tevent_is_control_generated = true; // As opposed to a drag-and-drop or context-menu event that targets a specific control.\n\t\t\t\t} // switch(gui_action)\n\t\t\t\t\n\t\t\t\t// IsMonitoring() isn't checked at this stage for performance and code size, and because\n\t\t\t\t// it was checked prior to posting AHK_GUI_ACTION. If the handler was removed since then,\n\t\t\t\t// the section below will do some unnecessary but harmless work.\n\t\t\t\tif (check_if_running && check_if_running->IsRunning(gui_event_code, gui_event_kind))\n\t\t\t\t{\n\t\t\t\t\tif (hdrop_to_free) // Unlikely but possible, in theory. Doesn't seem to affect code size.\n\t\t\t\t\t{\n\t\t\t\t\t\tDragFinish(hdrop_to_free); // Since the drop-thread will not be launched, free the memory.\n\t\t\t\t\t\tpgui->mHdrop = NULL; // Indicate that this GUI window is ready for another drop.\n\t\t\t\t\t}\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\tpriority = 0; // Always use default for now.\n\t\t\t\tbreak; // case AHK_GUI_ACTION\n\n\t\t\tcase AHK_USER_MENU: // user-defined menu item\n\t\t\t\tif (msg.wParam) // Poster specified that this menu item was from a gui's menu bar (since wParam is unsigned, any incoming -1 is seen as greater than max).\n\t\t\t\t{\n\t\t\t\t\t// The menu type is passed with the message so that its value will be in sync with\n\t\t\t\t\t// the timestamp of the message (in case this message has been stuck in the queue\n\t\t\t\t\t// for a long time).\n\t\t\t\t\t// msg.wParam is the HWND rather than a pointer to avoid any chance of problems with\n\t\t\t\t\t// a gui object having been destroyed while the msg was waiting in the queue.\n\t\t\t\t\tif (!(pgui = GuiType::FindGui((HWND)msg.wParam)) // Not a GUI's menu bar item...\n\t\t\t\t\t\t&& msg.hwnd && msg.hwnd != g_hWnd) // ...and not a script menu item.\n\t\t\t\t\t\tgoto break_out_of_main_switch; // See \"goto break_out_of_main_switch\" higher above for complete explanation.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tpgui = NULL; // Set for use in later sections.\n\t\t\t\tif ( !(menu_item = g_script.FindMenuItemByID((UINT)msg.lParam)) ) // Item not found.\n\t\t\t\t\tcontinue; // ignore the msg\n\t\t\t\t// And just in case a menu item that lacks a label (such as a separator) is ever\n\t\t\t\t// somehow selected (perhaps via someone sending direct messages to us, bypassing\n\t\t\t\t// the menu):\n\t\t\t\tif (!menu_item->mCallback)\n\t\t\t\t\tcontinue;\n\t\t\t\t// Ignore/discard a hotkey or custom menu item event if the current thread's priority\n\t\t\t\t// is higher than it's:\n\t\t\t\tpriority = menu_item->mPriority;\n\t\t\t\tbreak;\n\n\t\t\tcase AHK_HOTSTRING:\n\t\t\t\tif (msg.wParam >= Hotstring::sHotstringCount) // Invalid hotstring ID (perhaps spoofed by external app)\n\t\t\t\t\tcontinue; // Do nothing.\n\t\t\t\ths = Hotstring::shs[msg.wParam]; // For performance and convenience.\n\t\t\t\tif (hs->mHotCriterion)\n\t\t\t\t{\n\t\t\t\t\t// For details, see comments in the hotkey section of this switch().\n\t\t\t\t\tif ( !(criterion_found_hwnd = HotCriterionAllowsFiring(hs->mHotCriterion, hs->mName)) )\n\t\t\t\t\t\t// Hotstring is no longer eligible to fire even though it was when the hook sent us\n\t\t\t\t\t\t// the message. Abort the firing even though the hook may have already started\n\t\t\t\t\t\t// executing the hotstring by suppressing the final end-character or other actions.\n\t\t\t\t\t\t// It seems preferable to abort midway through the execution than to continue sending\n\t\t\t\t\t\t// keystrokes to the wrong window, or when the hotstring has become suspended.\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t// For details, see comments in the hotkey section of this switch().\n\t\t\t\t\tif (hs->mHotCriterion->Type == HOT_IF_NOT_ACTIVE || hs->mHotCriterion->Type == HOT_IF_NOT_EXIST)\n\t\t\t\t\t\tcriterion_found_hwnd = NULL; // For \"NONE\" and \"NOT\", there is no last found window.\n\t\t\t\t\telse if (HOT_IF_REQUIRES_EVAL(hs->mHotCriterion->Type))\n\t\t\t\t\t\tcriterion_found_hwnd = g_HotExprLFW; // For #if WinExist(WinTitle) and similar.\n\t\t\t\t}\n\t\t\t\telse // No criterion, so it's a global hotstring. It can always fire, but it has no \"last found window\".\n\t\t\t\t\tcriterion_found_hwnd = NULL;\n\t\t\t\t// Do a simple replacement for the hotstring if that's all that's called for.\n\t\t\t\t// Don't create a new quasi-thread or any of that other complexity done further\n\t\t\t\t// below. But also do the backspacing (if specified) for a non-autoreplace hotstring,\n\t\t\t\t// even if it can't launch due to MaxThreads, MaxThreadsPerHotkey, or some other reason:\n\t\t\t\ths->DoReplace(msg.lParam); // Does only the backspacing if it's not an auto-replace hotstring.\n\t\t\t\tif (hs->mReplacement) // Fully handled by the above; i.e. it's an auto-replace hotstring.\n\t\t\t\t\tcontinue;\n\t\t\t\t// Otherwise, continue on and let a new thread be created to handle this hotstring.\n\t\t\t\t// Since this isn't an auto-replace hotstring, set this value to support\n\t\t\t\t// the built-in variable A_EndChar:\n\t\t\t\tg_script.mEndChar = hs->mEndCharRequired ? (TCHAR)LOWORD(msg.lParam) : 0; // v1.0.48.04: Explicitly set 0 when hs->mEndCharRequired==false because LOWORD is used for something else in that case.\n\t\t\t\tpriority = hs->mPriority;\n\t\t\t\tbreak;\n\n\t\t\tcase AHK_CLIPBOARD_CHANGE: // Due to the registration of an OnClipboardChange function in the script.\n\t\t\t\tif (g_script.mOnClipboardChangeIsRunning)\n\t\t\t\t\tcontinue;\n\t\t\t\tpriority = 0; // Always use default for now.\n\t\t\t\tbreak;\n\n\t\t\tcase AHK_INPUT_END:\n\t\t\t\tinput_hook = InputRelease((input_type *)msg.wParam); // The function will verify that it is a valid input_type pointer.\n\t\t\t\tif (!input_hook)\n\t\t\t\t\tcontinue; // No OnEnd callback/invalid message.\n\t\t\t\tpriority = 0;\n\t\t\t\tbreak;\n\n\t\t\tcase AHK_INPUT_KEYDOWN:\n\t\t\tcase AHK_INPUT_CHAR:\n\t\t\tcase AHK_INPUT_KEYUP:\n\t\t\t\tfor (input_hook = g_input; input_hook && input_hook != (input_type *)msg.wParam; input_hook = input_hook->Prev);\n\t\t\t\tif (!input_hook)\n\t\t\t\t\tcontinue; // Invalid message or Input already ended (and therefore may have been deleted).\n\t\t\t\tif (!(msg.message == AHK_INPUT_KEYDOWN ? input_hook->ScriptObject->onKeyDown\n\t\t\t\t\t: msg.message == AHK_INPUT_KEYUP ? input_hook->ScriptObject->onKeyUp\n\t\t\t\t\t: input_hook->ScriptObject->onChar))\n\t\t\t\t\tcontinue;\n\t\t\t\tpriority = 0;\n\t\t\t\tbreak;\n\n\t\t\tdefault: // hotkey\n\t\t\t\thk_id = msg.wParam & HOTKEY_ID_MASK;\n\t\t\t\tif (hk_id >= Hotkey::sHotkeyCount) // Invalid hotkey ID.\n\t\t\t\t\tcontinue;\n\t\t\t\thk = Hotkey::shk[hk_id];\n\t\t\t\t// Check if criterion allows firing.\n\t\t\t\t// For maintainability, this is done here rather than a little further down\n\t\t\t\t// past the g_MaxThreadsTotal and thread-priority checks. Those checks hardly\n\t\t\t\t// ever abort a hotkey launch anyway.\n\t\t\t\t//\n\t\t\t\t// If message is WM_HOTKEY, it's either:\n\t\t\t\t// 1) A joystick hotkey from TriggerJoyHotkeys(), in which case the lParam is ignored.\n\t\t\t\t// 2) A hotkey message sent by the OS, in which case lParam contains currently-unused info set by the OS.\n\t\t\t\t//\n\t\t\t\t// An incoming WM_HOTKEY can be subject to #HotIf Win. at this stage under the following conditions:\n\t\t\t\t// 1) Joystick hotkey, because it relies on us to do the check so that the check is done only\n\t\t\t\t// once rather than twice.\n\t\t\t\t// 2) #HotIf Win. keybd hotkeys that were made non-hook because they have a non-suspended, global variant.\n\t\t\t\t//\n\t\t\t\t// If message is AHK_HOOK_HOTKEY:\n\t\t\t\t// Rather than having the hook pass the qualified variant to us, it seems preferable\n\t\t\t\t// to search through all the criteria again and rediscover it. This is because conditions\n\t\t\t\t// may have changed since the message was posted, and although the hotkey might still be\n\t\t\t\t// eligible for firing, a different variant might now be called for (e.g. due to a change\n\t\t\t\t// in the active window). Since most criteria hotkeys have at most only a few criteria,\n\t\t\t\t// and since most such criteria are #HotIf WinActive rather than Exist, the performance will\n\t\t\t\t// typically not be reduced much at all. Furthermore, trading performance for greater\n\t\t\t\t// reliability seems worth it in this case.\n\t\t\t\t// \n\t\t\t\t// The inefficiency of calling HotCriterionAllowsFiring() twice for each hotkey --\n\t\t\t\t// once in the hook and again here -- seems justified for the following reasons:\n\t\t\t\t// - It only happens twice if the hotkey a hook hotkey (multi-variant keyboard hotkeys\n\t\t\t\t// that have a global variant are usually non-hook, even on NT/2k/XP).\n\t\t\t\t// - The hook avoids doing its first check of WinActive/Exist if it sees that the hotkey\n\t\t\t\t// has a non-suspended, global variant. That way, hotkeys that are hook-hotkeys for\n\t\t\t\t// reasons other than #HotIf Win. (such as mouse, overriding OS hotkeys, or hotkeys\n\t\t\t\t// that are too fancy for RegisterHotkey) will not have to do the check twice.\n\t\t\t\t// - It provides the ability to set the last-found-window for #HotIf WinActive/Exist\n\t\t\t\t// (though it's not needed for the \"Not\" counterparts). This HWND could be passed\n\t\t\t\t// via the message, but that would require malloc-there and free-here, and might\n\t\t\t\t// result in memory leaks if its ever possible for messages to get discarded by the OS.\n\t\t\t\t// - It allows hotkeys that were eligible for firing at the time the message was\n\t\t\t\t// posted but that have since become ineligible to be aborted. This seems like a\n\t\t\t\t// good precaution for most users/situations because such hotkey subroutines will\n\t\t\t\t// often assume (for scripting simplicity) that the specified window is active or\n\t\t\t\t// exists when the subroutine executes its first line.\n\t\t\t\t// - Most criterion hotkeys use #HotIf WinActive(), which is a very fast call. Also, although\n\t\t\t\t// WinText and/or \"SetTitleMatchMode 'Slow'\" slow down window searches, those are rarely\n\t\t\t\t// used too.\n\t\t\t\t//\n\t\t\t\tvariant = NULL; // Set default.\n\t\t\t\t// For #HotIf hotkey variants, we don't want to evaluate the expression a second time. If the hook\n\t\t\t\t// thread determined that a specific variant should fire, it is passed via the high word of wParam:\n\t\t\t\tif (variant_id = HIWORD(msg.wParam))\n\t\t\t\t{\n\t\t\t\t\t// The following relies on the fact that variants can't be removed or re-ordered;\n\t\t\t\t\t// variant_id should always be the variant's one-based index in the linked list:\n\t\t\t\t\t--variant_id; // i.e. index 1 should be mFirstVariant, not mFirstVariant->mNextVariant.\n\t\t\t\t\tfor (variant = hk->mFirstVariant; variant_id; variant = variant->mNextVariant, --variant_id);\n\t\t\t\t}\n\t\t\t\tif ( !(variant || (variant = hk->CriterionAllowsFiring(&criterion_found_hwnd\n\t\t\t\t\t, msg.message == AHK_HOOK_HOTKEY ? KEY_IGNORE_LEVEL(HIWORD(msg.lParam)) : 0))) )\n\t\t\t\t\tcontinue; // No criterion is eligible, so ignore this hotkey event (see other comments).\n\t\t\t\t\t// If this is AHK_HOOK_HOTKEY, criterion was eligible at time message was posted,\n\t\t\t\t\t// but not now. Seems best to abort (see other comments).\n\t\t\t\t\n\t\t\t\t// Due to the key-repeat feature and the fact that most scripts use a value of 1\n\t\t\t\t// for their #MaxThreadsPerHotkey, this check will often help average performance\n\t\t\t\t// by avoiding a lot of unnecessary overhead that would otherwise occur:\n\t\t\t\tif (!hk->PerformIsAllowed(*variant))\n\t\t\t\t{\n\t\t\t\t\t// The key is buffered in this case to boost the responsiveness of hotkeys\n\t\t\t\t\t// that are being held down by the user to activate the keyboard's key-repeat\n\t\t\t\t\t// feature. This way, there will always be one extra event waiting in the queue,\n\t\t\t\t\t// which will be fired almost the instant the previous iteration of the subroutine\n\t\t\t\t\t// finishes (this above description applies only when MaxThreadsPerHotkey is 1,\n\t\t\t\t\t// which it usually is).\n\t\t\t\t\thk->RunAgainAfterFinished(*variant); // Wheel notch count (g->EventInfo below) should be okay because subsequent launches reuse the same thread attributes to do the repeats.\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Now that above has ensured variant is non-NULL:\n\t\t\t\tHotkeyCriterion *hc = variant->mHotCriterion;\n\t\t\t\tif (!hc || hc->Type == HOT_IF_NOT_ACTIVE || hc->Type == HOT_IF_NOT_EXIST)\n\t\t\t\t\tcriterion_found_hwnd = NULL; // For \"NONE\" and \"NOT\", there is no last found window.\n\t\t\t\telse if (HOT_IF_REQUIRES_EVAL(hc->Type))\n\t\t\t\t\tcriterion_found_hwnd = g_HotExprLFW; // For #HotIf WinExist(WinTitle) and similar.\n\n\t\t\t\tpriority = variant->mPriority;\n\t\t\t} // switch(msg.message)\n\n\t\t\tif (g_nThreads >= g_MaxThreadsTotal)\n\t\t\t{\n\t\t\t\t// Allow only a limited number of recursion levels to avoid any chance of\n\t\t\t\t// stack overflow. So ignore this message. Later, can devise some way\n\t\t\t\t// to support \"queuing up\" these launch-thread events for use later when\n\t\t\t\t// there is \"room\" to run them, but that might cause complications because\n\t\t\t\t// in some cases, the user didn't intend to hit the key twice (e.g. due to\n\t\t\t\t// \"fat fingers\") and would have preferred to have it ignored. Doing such\n\t\t\t\t// might also make \"infinite key loops\" harder to catch because the rate\n\t\t\t\t// of incoming hotkeys would be slowed down to prevent the subroutines from\n\t\t\t\t// running concurrently.\n\t\t\t\tif (hdrop_to_free) // This is only non-NULL when pgui is non-NULL and gui_action==GUI_EVENT_DROPFILES\n\t\t\t\t{\n\t\t\t\t\tDragFinish(hdrop_to_free); // Since the drop-thread will not be launched, free the memory.\n\t\t\t\t\tpgui->mHdrop = NULL; // Indicate that this GUI window is ready for another drop.\n\t\t\t\t}\n\t\t\t\tif (msg.message == AHK_INPUT_END)\n\t\t\t\t\tinput_hook->ScriptObject->Release();\n\t\t\t\tcontinue;\n\t\t\t\t// If the above \"continued\", it seems best not to re-queue/buffer the key since\n\t\t\t\t// it might be a while before the number of threads drops back below the limit.\n\t\t\t}\n\n\t\t\t// Discard the event if it's priority is lower than that of the current thread:\n\t\t\tif (priority < g->Priority)\n\t\t\t{\n\t\t\t\tif (hdrop_to_free) // This is only non-NULL when pgui is non-NULL and gui_action==GUI_EVENT_DROPFILES\n\t\t\t\t{\n\t\t\t\t\tDragFinish(hdrop_to_free); // Since the drop-thread will not be launched, free the memory.\n\t\t\t\t\tpgui->mHdrop = NULL; // Indicate that this GUI window is ready for another drop.\n\t\t\t\t}\n\t\t\t\tif (msg.message == AHK_INPUT_END)\n\t\t\t\t\tinput_hook->ScriptObject->Release();\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\t// Now it is certain that the new thread will be launched, so set everything up.\n\t\t\t// Perform the new thread's subroutine:\n\t\t\treturn_value = true; // We will return this value to indicate that we launched at least one new thread.\n\n\t\t\t// UPDATE v1.0.48: The main timer is no longer killed because testing shows that\n\t\t\t// SetTimer() and/or KillTimer() are relatively slow calls. Thus it is likely that\n\t\t\t// on average, it's better to receive some unnecessary WM_TIMER messages (especially\n\t\t\t// since WM_TIMER processing is fast when there's nothing to do) than it is to\n\t\t\t// KILL and then RE-SET the main timer for every new thread (especially rapid-fire\n\t\t\t// threads like some GUI threads can be). This also makes the thread types that are\n\t\t\t// handled here more like other threads such as timers, callbacks, and OnMessage.\n\t\t\t// Also, not doing the following KILL_MAIN_TIMER avoids have to check whether\n\t\t\t// SET_MAIN_TIMER is needed in two places further below (e.g. RETURN_FROM_MSGSLEEP).\n\t\t\t// OLDER COMMENTS:\n\t\t\t// Always kill the main timer, for performance reasons and for simplicity of design,\n\t\t\t// prior to embarking on new subroutine whose duration may be long (e.g. the called\n\t\t\t// subroutine may not return to us for seconds, minutes, or more; during which time\n\t\t\t// we don't want the timer running because it will only fill up the queue with\n\t\t\t// WM_TIMER messages and thus hurt performance).\n\t\t\t// UPDATE: But don't kill it if it should be always-on to support the existence of\n\t\t\t// at least one enabled timed subroutine or joystick hotkey:\n\t\t\t//if (!g_script.mTimerEnabledCount && !Hotkey::sJoyHotkeyCount)\n\t\t\t//\tKILL_MAIN_TIMER;\n\n\t\t\tswitch(msg.message)\n\t\t\t{\n\t\t\tcase AHK_GUI_ACTION: // Listed first for performance.\n\t\t\tcase AHK_CLIPBOARD_CHANGE:\n\t\t\tcase AHK_INPUT_END:\n\t\t\tcase AHK_INPUT_KEYDOWN:\n\t\t\tcase AHK_INPUT_CHAR:\n\t\t\tcase AHK_INPUT_KEYUP:\n\t\t\tcase AHK_USER_MENU: // user-defined menu item\n\t\t\t\tbreak; // Do nothing at this stage.\n\t\t\tdefault: // hotkey or hotstring\n\t\t\t\t// Just prior to launching the hotkey, update these values to support built-in\n\t\t\t\t// variables such as A_TimeSincePriorHotkey:\n\t\t\t\tg_script.mPriorHotkeyName = g_script.mThisHotkeyName;\n\t\t\t\tg_script.mPriorHotkeyStartTime = g_script.mThisHotkeyStartTime;\n\t\t\t\t// Unlike hotkeys -- which can have a name independent of their label by being created or updated\n\t\t\t\t// with the HOTKEY command -- a hot string's unique name is always its label since that includes\n\t\t\t\t// the options that distinguish between (for example) :c:ahk:: and ::ahk::\n\t\t\t\tg_script.mThisHotkeyName = (msg.message == AHK_HOTSTRING) ? hs->mName : hk->mName;\n\t\t\t\tg_script.mThisHotkeyStartTime = GetTickCount(); // Fixed for v1.0.35.10 to not happen for GUI threads.\n\t\t\t}\n\n\t\t\t// Make every newly launched subroutine start off with the global default values that\n\t\t\t// the user set up in the auto-execute part of the script (e.g. KeyDelay, WinDelay, etc.).\n\t\t\tInitNewThread(priority, false, true);\n\t\t\tglobal_struct &g = *::g; // ONLY AFTER above is it safe to \"lock in\". Reduces code size a bit (31 bytes currently) and may improve performance. Eclipsing ::g with local g makes compiler remind/enforce the use of the right one.\n\n\t\t\t// Do this nearly last, right before launching the thread:\n\t\t\tg_script.mLastPeekTime = GetTickCount();\n\t\t\t// v1.0.38.04: The above now resets mLastPeekTime too to reduce situations in which a thread\n\t\t\t// doesn't even run one line before being interrupted by another thread. Here's how that would\n\t\t\t// happen: ExecUntil() would see that a Peek() is due and call PeekMessage(). The Peek() will\n\t\t\t// yield if we have no messages and the CPU is under heavy load, and thus the script might not\n\t\t\t// get another timeslice for 20ms (or even longer if there is more than one other needy process).\n\t\t\t// Even if the Peek() doesn't yield (i.e. we have messages), those messages might take a long time\n\t\t\t// to process (such as WM_PAINT) even though the script is uninterruptible. Either way, when the\n\t\t\t// Peek-check completes, a long time might have passed, and the thread might now be interruptible\n\t\t\t// due to the interruptible-timer having expired (which is probably possible only in the no-yield\n\t\t\t// scenario above, since in the case of yield, ExecUntil wouldn't check messages again after the\n\t\t\t// yield). Thus, the Peek-check's MsgSleep() might launch an interrupting thread before the prior\n\t\t\t// thread had a chance to execute even one line. Resetting mLastPeekTime above should alleviate that,\n\t\t\t// perhaps even completely resolve it due to the way tickcounts tend not to change early on in\n\t\t\t// a timeslice (perhaps because timeslices fall exactly upon tick-count boundaries). If it doesn't\n\t\t\t// completely resolve it, mLastPeekTime could instead be set to zero as a special value that\n\t\t\t// ExecUntil recognizes to do the following processing, but this processing reduces performance\n\t\t\t// by 2.5% in a simple addition-loop benchmark:\n\t\t\t//if (g_script.mLastPeekTime)\n\t\t\t//\tLONG_OPERATION_UPDATE\n\t\t\t//else\n\t\t\t//\tg_script.mLastPeekTime = GetTickCount();\n\n\t\t\tswitch (msg.message)\n\t\t\t{\n\t\t\tcase AHK_GUI_ACTION: // Listed first for performance.\n\t\t\t{\n#define EVT_ARG_ADD(_value) gui_event_args[gui_event_arg_count++].SetValue(_value)\n\n\t\t\t\t// The following check isn't used because a Gui with an event sink can also have events handled\n\t\t\t\t// by unrelated function objects. Instead, MsgMonitorList::Call adjusts parameters as needed:\n\t\t\t\t//if (event_is_control_generated || pgui->mEventSink != pgui)\n\t\t\t\tEVT_ARG_ADD(event_is_control_generated ? (IObject*)pcontrol : (IObject*)pgui);\n\n\t\t\t\tswitch(gui_action)\n\t\t\t\t{\n\t\t\t\tcase GUI_EVENT_CONTEXTMENU:\n\t\t\t\t\tbool from_keyboard; // True if this context-menu was generated via the keyboard (such as AppsKey or Shift-F10):\n\t\t\t\t\tfrom_keyboard = gui_event_byte;\n\t\t\t\t\tgui_point = msg.pt; // Set default. v1.0.38: More accurate/customary to use msg.pt than GetCursorPos().\n\t\t\t\t\tif (pcontrol) // i.e. this context menu is for a control rather than a click somewhere in the parent window itself.\n\t\t\t\t\t{\n\t\t\t\t\t\t// By definition, pcontrol should be the focused control. However, testing shows that\n\t\t\t\t\t\t// it can also be the only control in a window that lacks any focus-capable controls.\n\t\t\t\t\t\t// If the window has no controls at all, testing shows that pcontrol will be NULL,\n\t\t\t\t\t\t// in which case GuiPoint default set earlier is retained (for AppsKey too).\n\t\t\t\t\t\tif (from_keyboard)\n\t\t\t\t\t\t\tpgui->ControlGetPosOfFocusedItem(*pcontrol, gui_point); // Since pcontrol!=NULL, find out which item is focused in this control.\n\t\t\t\t\t\t//else this is a context-menu event that was invoked via normal mouse click. Leave\n\t\t\t\t\t\t// g.GuiPoint at its default set earlier.\n\t\t\t\t\t\tswitch(pcontrol->type)\n\t\t\t\t\t\t{\n\t\t\t\t\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\t\t\t\t\t// Retrieve the focused item, which is not necessarily the one which was clicked.\n\t\t\t\t\t\t\t// LB_ITEMFROMPOINT could be used to get the item at the mouse position, but since\n\t\t\t\t\t\t\t// the control doesn't provide any visual feedback that the item was clicked, it\n\t\t\t\t\t\t\t// doesn't feel right. We could provide feedback by automatically selecting the\n\t\t\t\t\t\t\t// item, but that would be non-trivial due to single- vs. multi-select, and it\n\t\t\t\t\t\t\t// might not be what the user wants anyway.\n\t\t\t\t\t\t\tgui_event_info = 1 + (int)SendMessage(pcontrol->hwnd, LB_GETCARETINDEX, 0, 0); // Cast to int to preserve any -1 value.\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase GUI_CONTROL_LISTVIEW:\n\t\t\t\t\t\t\tif (from_keyboard) // AppsKey or Shift+F10.\n\t\t\t\t\t\t\t\tgui_event_info = 1 + ListView_GetNextItem(pcontrol->hwnd, -1, LVNI_FOCUSED);\n\t\t\t\t\t\t\t// Otherwise, this event should have been generated by NM_RCLICK, in which case\n\t\t\t\t\t\t\t// gui_event_info already contains the row number.\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase GUI_CONTROL_TREEVIEW:\n\t\t\t\t\t\t\t// Retrieve the HTREEITEM that is the true target of this event.\n\t\t\t\t\t\t\tif (from_keyboard) // AppsKey or Shift+F10.\n\t\t\t\t\t\t\t\tgui_event_info = (DWORD_PTR)SendMessage(pcontrol->hwnd, TVM_GETNEXTITEM, TVGN_CARET, NULL); // Get focused item.\n\t\t\t\t\t\t\telse // Context menu invoked via right-click. Find out which item (if any) was clicked on.\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t// Use HitTest because the focused item isn't necessarily the one that was\n\t\t\t\t\t\t\t\t// clicked on. This is because unlike a ListView, right-clicking a TreeView\n\t\t\t\t\t\t\t\t// item doesn't change the focus. Instead, the target item is momentarily\n\t\t\t\t\t\t\t\t// selected for visual confirmation and then unselected.\n\t\t\t\t\t\t\t\tTVHITTESTINFO ht;\n\t\t\t\t\t\t\t\tht.pt = msg.pt;\n\t\t\t\t\t\t\t\tScreenToClient(pcontrol->hwnd, &ht.pt);\n\t\t\t\t\t\t\t\tgui_event_info = (DWORD_PTR)TreeView_HitTest(pcontrol->hwnd, &ht);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t//else pcontrol==NULL: Since there is no focused control, it seems best to report the\n\t\t\t\t\t// cursor's position rather than some arbitrary center-point, or top-left point in the\n\t\t\t\t\t// parent window. This is because it might be more convenient for the user to move the\n\t\t\t\t\t// mouse to select a menu item (since menu will be close to mouse cursor).\n\t\t\t\t\t\n\t\t\t\t\t// Convert to client coordinates, since that's what we use for positioning controls,\n\t\t\t\t\t// and it's usually the default Menu CoordMode. Since the script might not use the\n\t\t\t\t\t// coordinates to display a menu, it seems best to use this even if the script has\n\t\t\t\t\t// changed the default CoordMode.\n\t\t\t\t\tScreenToClient(pgui->mHwnd, &gui_point);\n\t\t\t\t\t\n\t\t\t\t\t// Build event arguments.\n\t\t\t\t\tif (pcontrol)\n\t\t\t\t\t\tEVT_ARG_ADD(pcontrol);\n\t\t\t\t\telse\n\t\t\t\t\t\tEVT_ARG_ADD(_T(\"\"));\n\t\t\t\t\tEVT_ARG_ADD((__int64)gui_event_info);\n\t\t\t\t\tEVT_ARG_ADD(!from_keyboard); // True if mouse-activated.\n\t\t\t\t\tEVT_ARG_ADD(gui_point.x);\n\t\t\t\t\tEVT_ARG_ADD(gui_point.y);\n\t\t\t\t\tbreak; // case GUI_CONTEXT_MENU.\n\n\t\t\t\tcase GUI_EVENT_DROPFILES:\n\t\t\t\t\tgui_point = msg.pt; // v1.0.38: More accurate/customary to use msg.pt than GetCursorPos().\n\t\t\t\t\tScreenToClient(pgui->mHwnd, &gui_point); // Seems more useful/appropriate than window coordinates, especially now that Client CoordMode is the starting default.\n\t\t\t\t\t// Visually indicate that drops aren't allowed while and existing drop is still being\n\t\t\t\t\t// processed. Fix for v1.0.31.02: The window's current ExStyle is fetched every time\n\t\t\t\t\t// in case a non-GUI command altered it (such as making it transparent):\n\t\t\t\t\tSetWindowLong(pgui->mHwnd, GWL_EXSTYLE, GetWindowLong(pgui->mHwnd, GWL_EXSTYLE) & ~WS_EX_ACCEPTFILES);\n\n\t\t\t\t\t// Build event arguments.\n\t\t\t\t\tif (pcontrol)\n\t\t\t\t\t\tEVT_ARG_ADD(pcontrol);\n\t\t\t\t\telse\n\t\t\t\t\t\tEVT_ARG_ADD(_T(\"\"));\n\t\t\t\t\tEVT_ARG_ADD(GuiType::CreateDropArray(hdrop_to_free)); // Currently must be the third-last arg; see \"Free the drop array.\"\n\t\t\t\t\tEVT_ARG_ADD(pgui->Unscale(gui_point.x));\n\t\t\t\t\tEVT_ARG_ADD(pgui->Unscale(gui_point.y));\n\n\t\t\t\t\t// Free the drop object.\n\t\t\t\t\tDragFinish(hdrop_to_free);\n\t\t\t\t\tpgui->mHdrop = NULL;\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase GUI_EVENT_CLOSE:\n\t\t\t\tcase GUI_EVENT_ESCAPE:\n\t\t\t\tcase GUI_EVENT_RESIZE:\n\t\t\t\t\tif (gui_action == GUI_EVENT_RESIZE)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Build event arguments.\n\t\t\t\t\t\tEVT_ARG_ADD((char)gui_event_byte); // MinMax state\n\t\t\t\t\t\tEVT_ARG_ADD(pgui->Unscale(LOWORD(gui_event_info))); // Width\n\t\t\t\t\t\tEVT_ARG_ADD(pgui->Unscale(HIWORD(gui_event_info))); // Height\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase GUI_EVENT_WM_COMMAND: // Control-generated, but no additional parameters.\n\t\t\t\t\tbreak;\n\n\t\t\t\tdefault: // Other control-generated event (i.e. event_is_control_generated==true).\n\t\t\t\t\tif (pcontrol->type == GUI_CONTROL_LINK && gui_action == GUI_EVENT_CLICK)\n\t\t\t\t\t{\n\t\t\t\t\t\tLITEM item;\n\t\t\t\t\t\titem.mask = LIF_URL|LIF_ITEMID|LIF_ITEMINDEX;\n\t\t\t\t\t\titem.iLink = (int)gui_event_info - 1;\n\t\t\t\t\t\tif (!SendMessage(pcontrol->hwnd, LM_GETITEM, NULL, (LPARAM)&item))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// Make sure they are initialized to sensible values.\n\t\t\t\t\t\t\t*item.szID = '\\0';\n\t\t\t\t\t\t\t*item.szUrl = '\\0';\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (*item.szID)\n\t\t\t\t\t\t\tEVT_ARG_ADD(item.szID); // ID attribute.\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tEVT_ARG_ADD((int)gui_event_info); // One-based index.\n\t\t\t\t\t\tEVT_ARG_ADD(item.szUrl); // Empty unless it had a href which failed to execute.\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tEVT_ARG_ADD((__int64)gui_event_info);\n\t\t\t\t\tswitch (gui_action)\n\t\t\t\t\t{\n\t\t\t\t\tcase GUI_EVENT_ITEMSELECT:\n\t\t\t\t\t\tif (pcontrol->type != GUI_CONTROL_LISTVIEW)\n\t\t\t\t\t\t\tbreak; // Should be a TreeView, which does not raise an event for de-selection.\n\t\t\t\t\t\t// Otherwise, this is a ListView, so add the parameter indicating whether this\n\t\t\t\t\t\t// is selection or de-selection:\n\t\t\t\t\tcase GUI_EVENT_ITEMCHECK: // Parameter indicates checked (1) vs unchecked (0).\n\t\t\t\t\tcase GUI_EVENT_ITEMEXPAND: // Parameter indicates expanded (1) vs collapsed (0).\n\t\t\t\t\t\tEVT_ARG_ADD((int)gui_event_byte - 1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t} // switch (msg.message)\n\n\t\t\t\tpgui->AddRef(); // Keep the pointer valid at least until the thread finishes.\n\n\t\t\t\tResultType result;\n\t\t\t\tINT_PTR retval;\n\n\t\t\t\tif (gui_action == GUI_EVENT_CONTEXTMENU && pcontrol)\n\t\t\t\t{\n\t\t\t\t\t// Call the control's context menu handler, if any, omitting the \"Gui\" parameter\n\t\t\t\t\t// for consistency with other Ctrl events (and perhaps convenience).\n\t\t\t\t\tresult = pcontrol->events.Call(gui_event_args + 1, gui_event_arg_count - 1, gui_event_code, gui_event_kind, pgui);\n\t\t\t\t\tif (result == EARLY_RETURN // Suppress the GUI's handler for this event, if any.\n\t\t\t\t\t\t|| !pgui->mHwnd) // Gui was destroyed.\n\t\t\t\t\t{\n\t\t\t\t\t\tpgui->Release();\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tMsgMonitorList &events = event_is_control_generated ? pcontrol->events : pgui->mEvents;\n\t\t\t\tresult = events.Call(gui_event_args, gui_event_arg_count, gui_event_code, gui_event_kind, pgui, &retval);\n\t\t\t\t\n\t\t\t\tif (pgui->mHwnd) // i.e. GUI was not destroyed.\n\t\t\t\t{\n\t\t\t\t\tswitch (gui_action)\n\t\t\t\t\t{\n\t\t\t\t\tcase GUI_EVENT_CLOSE:\n\t\t\t\t\t\t// If the return value is false/unspecified, hide/destroy the Gui.\n\t\t\t\t\t\tif (!retval)\n\t\t\t\t\t\t\tpgui->Cancel();\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase GUI_EVENT_DROPFILES:\n\t\t\t\t\t\tif (pgui->IsMonitoring(gui_action)) // Reapply the style only if we're still monitoring this event.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// The window's current ExStyle is fetched every time in case a non-GUI\n\t\t\t\t\t\t\t// command altered it (such as making it transparent):\n\t\t\t\t\t\t\tSetWindowLong(pgui->mHwnd, GWL_EXSTYLE, GetWindowLong(pgui->mHwnd, GWL_EXSTYLE) | WS_EX_ACCEPTFILES);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (gui_action == GUI_EVENT_DROPFILES) // Must be done regardless of pgui->mHwnd.\n\t\t\t\t\tgui_event_args[gui_event_arg_count - 3].object->Release(); // Free the drop array.\n\t\t\t\t// Counteract the earlier AddRef(). If the Gui was destroyed (and none of this\n\t\t\t\t// Gui's other labels are still running), this will free the Gui structure.\n\t\t\t\tpgui->Release();\n\t\t\t\tbreak;\n\t\t\t} // case AHK_GUI_ACTION\n\n\t\t\tcase AHK_USER_MENU: // user-defined menu item\n\t\t\t{\n\t\t\t\t// Below: the menu type is passed with the message so that its value will be in sync\n\t\t\t\t// with the timestamp of the message (in case this message has been stuck in the\n\t\t\t\t// queue for a long time):\n\t\t\t\tif (pgui) // Set by an earlier stage. It means poster specified that this menu item was from a gui's menu bar.\n\t\t\t\t{\n\t\t\t\t\t// As documented, set the last found window if possible/applicable. It's not necessary to\n\t\t\t\t\t// check IsWindow/IsWindowVisible/DetectHiddenWindows since GetValidLastUsedWindow()\n\t\t\t\t\t// takes care of that whenever the script actually tries to use the last found window.\n\t\t\t\t\tg.hWndLastUsed = pgui->mHwnd; // OK if NULL.\n\t\t\t\t\t// This flags GUI menu items as being GUI so that the script has a way of detecting\n\t\t\t\t\t// whether a given submenu's item was selected from inside a menu bar vs. a popup:\n\t\t\t\t\tg.EventInfo = (EventInfoType)pgui->mHwnd;\n\t\t\t\t\tpgui->AddRef();\n\t\t\t\t}\n\t\t\t\tUserMenu *menu = menu_item->mMenu; // In case the item is deleted.\n\t\t\t\tmenu->AddRef();\n\t\t\t\tExprTokenType param[] =\n\t\t\t\t{\n\t\t\t\t\tmenu_item->mName, // This should be immediately copied into a script variable, so it's okay if menu_item is deleted.\n\t\t\t\t\t(__int64)(menu_item->Pos() + 1), // +1 to convert zero-based to one-based.\n\t\t\t\t\tmenu\n\t\t\t\t};\n\t\t\t\tmenu_item->mCallback->ExecuteInNewThread(_T(\"Menu\"), param, _countof(param));\n\t\t\t\tmenu->Release();\n\t\t\t\tif (pgui)\n\t\t\t\t\tpgui->Release();\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase AHK_HOTSTRING:\n\t\t\t\tg.hWndLastUsed = criterion_found_hwnd; // v1.0.42. Even if the window is invalid for some reason, IsWindow() and such are called whenever the script accesses it (GetValidLastUsedWindow()).\n\t\t\t\tg.SendLevel = hs->mInputLevel;\n\t\t\t\tg.HotCriterion = hs->mHotCriterion; // v2: Let the Hotkey command use the criterion of this hotstring by default.\n\t\t\t\ths->PerformInNewThreadMadeByCaller();\n\t\t\t\tbreak;\n\n\t\t\tcase AHK_CLIPBOARD_CHANGE:\n\t\t\t{\n\t\t\t\tint type = CountClipboardFormats() ? (IsClipboardFormatAvailable(CF_NATIVETEXT) || IsClipboardFormatAvailable(CF_HDROP) ? 1 : 2) : 0;\n\t\t\t\tExprTokenType param ((__int64)type);\n\t\t\t\tg_script.mOnClipboardChangeIsRunning = true;\n\t\t\t\tDEBUGGER_STACK_PUSH(_T(\"OnClipboardChange\"))\n\t\t\t\tg_script.mOnClipboardChange.Call(¶m, 1, 1);\n\t\t\t\tDEBUGGER_STACK_POP()\n\t\t\t\tg_script.mOnClipboardChangeIsRunning = false;\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase AHK_INPUT_END:\n\t\t\t{\n\t\t\t\tExprTokenType param = input_hook->ScriptObject;\n\t\t\t\tIObjectPtr(input_hook->ScriptObject->onEnd)->ExecuteInNewThread(_T(\"InputHook\"), ¶m, 1);\n\t\t\t\tinput_hook->ScriptObject->Release();\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t\n\t\t\tcase AHK_INPUT_KEYDOWN:\n\t\t\tcase AHK_INPUT_KEYUP:\n\t\t\t{\n\t\t\t\tExprTokenType params[] =\n\t\t\t\t{\n\t\t\t\t\tinput_hook->ScriptObject,\n\t\t\t\t\t__int64(vk_type(msg.lParam)),\n\t\t\t\t\t__int64(sc_type(msg.lParam >> 16)),\n\t\t\t\t};\n\t\t\t\tIObjectPtr onKey = msg.message == AHK_INPUT_KEYDOWN ? input_hook->ScriptObject->onKeyDown : input_hook->ScriptObject->onKeyUp;\n\t\t\t\tonKey->ExecuteInNewThread(_T(\"InputHook\"), params, _countof(params));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase AHK_INPUT_CHAR:\n\t\t\t{\n\t\t\t\tTCHAR chars[] = { TCHAR(msg.lParam), TCHAR(msg.lParam >> 16), '\\0' };\n\t\t\t\tExprTokenType params[] =\n\t\t\t\t{\n\t\t\t\t\tinput_hook->ScriptObject,\n\t\t\t\t\tchars\n\t\t\t\t};\n\t\t\t\tIObjectPtr(input_hook->ScriptObject->onChar)->ExecuteInNewThread(_T(\"InputHook\"), params, _countof(params));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tdefault: // hotkey\n\t\t\t\tif (IS_WHEEL_VK(hk->mVK)) // If this is true then also: msg.message==AHK_HOOK_HOTKEY\n\t\t\t\t\tg.EventInfo = LOWORD(msg.lParam); // v1.0.43.03: Override the thread default of 0 with the number of notches by which the wheel was turned.\n\t\t\t\t\t// Above also works for RunAgainAfterFinished since that feature reuses the same thread attributes set above.\n\t\t\t\tg.hWndLastUsed = criterion_found_hwnd; // v1.0.42. Even if the window is invalid for some reason, IsWindow() and such are called whenever the script accesses it (GetValidLastUsedWindow()).\n\t\t\t\tg.SendLevel = variant->mInputLevel;\n\t\t\t\tg.HotCriterion = variant->mHotCriterion; // v2: Let the Hotkey command use the criterion of this hotkey variant by default.\n\t\t\t\thk->PerformInNewThreadMadeByCaller(*variant);\n\t\t\t\t\n\t\t\t}\n\n\t\t\t// v1.0.37.06: Call ResumeUnderlyingThread() even if aMode==WAIT_FOR_MESSAGES; this is for\n\t\t\t// maintainability and also in case the pause command has been used to unpause the idle thread.\n\t\t\tResumeUnderlyingThread();\n\t\t\t// DUE TO THE --g DONE BY THE LINE ABOVE, ANYTHING BETWEEN THIS POINT AND THE NEXT '}' MUST USE :;g INSTEAD OF g.\n\n\t\t\tif (aMode == WAIT_FOR_MESSAGES) // This is the idle state, so we were called directly from WinMain().\n\t\t\t\tcontinue; // The above condition is possible only when the AutoExec section had ended prior to the thread we just launched.\n\n\t\t\t// Otherwise a script thread other than the idle thread has just been resumed.\n\t\t\tif (IsCycleComplete(aSleepDuration, start_time, allow_early_return))\n\t\t\t{\n\t\t\t\t// Check for messages once more in case the subroutine that just completed\n\t\t\t\t// above didn't check them that recently. This is done to minimize the time\n\t\t\t\t// our thread spends *not* pumping messages, which in turn minimizes keyboard\n\t\t\t\t// and mouse lag if the hooks are installed (even though this is no longer\n\t\t\t\t// true due to v1.0.39's dedicated hook thread, it seems best to continue this\n\t\t\t\t// practice to maximize responsiveness of hotkeys, the app itself [e.g. tray\n\t\t\t\t// menu], and also to retain backward compatibility). Set the state of this\n\t\t\t\t// function/layer/instance so that it will use peek-mode. UPDATE: Don't change\n\t\t\t\t// the value of aSleepDuration to -1 because IsCycleComplete() needs to know the\n\t\t\t\t// original sleep time specified by the caller to determine whether\n\t\t\t\t// to decrement g_nLayersNeedingTimer:\n\t\t\t\tempty_the_queue_via_peek = true;\n\t\t\t\tallow_early_return = true;\n\t\t\t\t// And now let it fall through to the \"continue\" statement below.\n\t\t\t}\n\t\t\t// and now if the cycle isn't complete, stay in the blessed GetMessage() state until the time\n\t\t\t// has expired.\n\t\t\tcontinue;\n\t\t} // End of cases that launch new threads, such as hotkeys and GUI events.\n\n\t\tcase WM_TIMER:\n\t\t\tif (msg.lParam // This WM_TIMER is intended for a TimerProc...\n\t\t\t\t|| msg.hwnd != g_hWnd) // ...or it's intended for a window other than the main window, which implies that it doesn't belong to program internals (i.e. the script is probably using it). This fix was added in v1.0.47.02 and it also fixes the ES_NUMBER balloon bug.\n\t\t\t\tbreak; // Fall through to let a later section do DispatchMessage() on it.\n\t\t\t// It seems best to poll the joystick for every WM_TIMER message (i.e. every 10ms or so on\n\t\t\t// NT/2k/XP). This is because if the system is under load, it might be 20ms, 40ms, or even\n\t\t\t// longer before we get a timeslice again and that is a long time to be away from the poll\n\t\t\t// (a fast button press-and-release might occur in less than 50ms, which could be missed if\n\t\t\t// the polling frequency is too low):\n\t\t\tPOLL_JOYSTICK_IF_NEEDED // Do this first since it's much faster.\n\t\t\tCHECK_SCRIPT_TIMERS_IF_NEEDED\n\t\t\tif (aMode == WAIT_FOR_MESSAGES)\n\t\t\t\t// Timer should have already been killed if we're in this state.\n\t\t\t\t// But there might have been some WM_TIMER msgs already in the queue\n\t\t\t\t// (they aren't removed when the timer is killed). Or perhaps\n\t\t\t\t// a caller is calling us with this aMode even though there\n\t\t\t\t// are suspended subroutines (currently never happens).\n\t\t\t\t// In any case, these are always ignored in this mode because\n\t\t\t\t// the caller doesn't want us to ever return. UPDATE: This can now\n\t\t\t\t// happen if there are any enabled timed subroutines we need to keep an\n\t\t\t\t// eye on, which is why the mTimerEnabledCount value is checked above\n\t\t\t\t// prior to starting a new iteration.\n\t\t\t\tcontinue;\n\t\t\tif (aSleepDuration < 1) // In this case, WM_TIMER messages have already fulfilled their function, above.\n\t\t\t\tcontinue;\n\t\t\t// Otherwise aMode == RETURN_AFTER_MESSAGES:\n\t\t\t// Realistically, there shouldn't be any more messages in our queue\n\t\t\t// right now because the queue was stripped of WM_TIMER messages\n\t\t\t// prior to the start of the loop, which means this WM_TIMER\n\t\t\t// came in after the loop started. So in the vast majority of\n\t\t\t// cases, the loop would have had enough time to empty the queue\n\t\t\t// prior to this message being received. Therefore, just return rather\n\t\t\t// than trying to do one final iteration in peek-mode (which might\n\t\t\t// complicate things, i.e. the below function makes certain changes\n\t\t\t// in preparation for ending this instance/layer, only to be possibly,\n\t\t\t// but extremely rarely, interrupted/recursed yet again if that final\n\t\t\t// peek were to detect a recursable message):\n\t\t\tif (IsCycleComplete(aSleepDuration, start_time, allow_early_return))\n\t\t\t\tRETURN_FROM_MSGSLEEP\n\t\t\t// Otherwise, stay in the blessed GetMessage() state until the time has expired:\n\t\t\tcontinue;\n\n\t\tcase WM_CANCELJOURNAL:\n\t\t\t// IMPORTANT: It's tempting to believe that WM_CANCELJOURNAL might be lost/dropped if the script\n\t\t\t// is displaying a MsgBox or other dialog that has its own msg pump (since such a pump would\n\t\t\t// discard any msg with a NULL HWND). However, that is not true in this case because such a dialog's\n\t\t\t// msg pump would be beneath this one on the call stack. This is because our caller is calling us in\n\t\t\t// a loop that does not permit the script to display any *additional* dialogs. Thus, our msg pump\n\t\t\t// here should always receive the OS-generated WM_CANCELJOURNAL msg reliably.\n\t\t\t// v1.0.44: This message is now received only when the user presses Ctrl-Alt-Del or Ctrl-Esc during\n\t\t\t// playback. For performance and simplicity, the playback hook itself no longer sends this message,\n\t\t\t// instead directly sets g_PlaybackHook = NULL to notify the installer of the hook that it's gone.\n\t\t\tg_PlaybackHook = NULL; // A signal for caller.\n\t\t\tempty_the_queue_via_peek = true;\n\t\t\t// Above is set to so that we return faster, since our caller should be SendKeys() whenever\n\t\t\t// WM_CANCELJOURNAL is received, and SendKeys() benefits from a faster return.\n\t\t\tcontinue;\n\n\t\tcase WM_KEYDOWN:\n\t\t\tif (msg.hwnd == g_hWndEdit && msg.wParam == VK_ESCAPE)\n\t\t\t{\n\t\t\t\t// This won't work if a MessageBox() window is displayed because its own internal\n\t\t\t\t// message pump will dispatch the message to our edit control, which will just\n\t\t\t\t// ignore it. And avoiding setting the focus to the edit control won't work either\n\t\t\t\t// because the user can simply click in the window to set the focus. But for now,\n\t\t\t\t// this is better than nothing:\n\t\t\t\tShowWindow(g_hWnd, SW_HIDE); // And it's okay if this msg gets dispatched also.\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// Otherwise, break so that the messages will get dispatched. We need the other\n\t\t\t// WM_KEYDOWN msgs to be dispatched so that the cursor is keyboard-controllable in\n\t\t\t// the edit window:\n\t\t\tbreak;\n\n\t\tcase WM_QUIT:\n\t\t\t// The app normally terminates before WM_QUIT is ever seen here because of the way\n\t\t\t// WM_CLOSE is handled by MainWindowProc(). However, this is kept here in case anything\n\t\t\t// external ever explicitly posts a WM_QUIT to our thread's queue:\n\t\t\tg_script.ExitApp(EXIT_CLOSE);\n\t\t\tcontinue; // Since ExitApp() won't necessarily exit.\n\t\t} // switch()\nbreak_out_of_main_switch:\n\n\t\t// If a \"continue\" statement wasn't encountered somewhere in the switch(), we want to\n\t\t// process this message in a more generic way.\n\t\t// This little part is from the Miranda source code. But it doesn't seem\n\t\t// to provide any additional functionality: You still can't use keyboard\n\t\t// keys to navigate in the dialog unless it's the topmost dialog.\n\t\t// UPDATE: The reason it doesn't work for non-topmost MessageBoxes is that\n\t\t// this message pump isn't even the one running. It's the pump of the\n\t\t// top-most MessageBox itself, which apparently doesn't properly dispatch\n\t\t// all types of messages to other MessagesBoxes. However, keeping this\n\t\t// here is probably a good idea because testing reveals that it does\n\t\t// sometimes receive messages intended for MessageBox windows (which makes\n\t\t// sense because our message pump here retrieves all thread messages).\n\t\t// It might cause problems to dispatch such messages directly, since\n\t\t// IsDialogMessage() is supposed to be used in lieu of DispatchMessage()\n\t\t// for these types of messages.\n\t\t// NOTE: THE BELOW IS CONFIRMED to be needed, at least for a FileSelect()\n\t\t// dialog whose quasi-thread has been suspended, and probably for some of the other\n\t\t// types of dialogs as well:\n\t\tif ((fore_window = GetForegroundWindow()) != NULL // There is a foreground window.\n\t\t\t&& GetWindowThreadProcessId(fore_window, NULL) == g_MainThreadID) // And it belongs to our main thread (the main thread is the only one that owns any windows).\n\t\t{\n\t\t\tif (IsWindowStandardDialog(fore_window)) // MsgBox, InputBox, FileSelect, DirSelect dialog.\n\t\t\t{\n\t\t\t\tg_CalledByIsDialogMessageOrDispatch = &msg; // In case there is any way IsDialogMessage() can call one of our own window proc's rather than that of a MsgBox, etc.\n\t\t\t\tmsg_was_handled = IsDialogMessage(fore_window, &msg); // This message is for it, so let it process it.\n\t\t\t\tg_CalledByIsDialogMessageOrDispatch = nullptr;\n\t\t\t\tif (msg_was_handled)\n\t\t\t\t\tcontinue; // This message is done, so start a new iteration to get another msg.\n\t\t\t}\n\t\t}\n\t\t// Translate keyboard input for any of our thread's windows that need it:\n\t\tif (!g_hAccelTable || !TranslateAccelerator(g_hWnd, g_hAccelTable, &msg))\n\t\t{\n\t\t\tg_CalledByIsDialogMessageOrDispatch = &msg;\n\t\t\tTranslateMessage(&msg);\n\t\t\tDispatchMessage(&msg); // This is needed to send keyboard input and other messages to various windows and for some WM_TIMERs.\n\t\t\tg_CalledByIsDialogMessageOrDispatch = nullptr;\n\t\t}\n\t} // infinite-loop\n}\n\n\n\nResultType IsCycleComplete(int aSleepDuration, DWORD aStartTime, bool aAllowEarlyReturn)\n// This function is used just to make MsgSleep() more readable/understandable.\n{\n\t// Note: Even if TickCount has wrapped due to system being up more than about 49 days,\n\t// DWORD subtraction still gives the right answer as long as aStartTime itself isn't more\n\t// than about 49 days ago. Note: must cast to int or any negative result will be lost\n\t// due to DWORD type:\n\tDWORD tick_now = GetTickCount();\n\tif (!aAllowEarlyReturn && (int)(aSleepDuration - (tick_now - aStartTime)) > SLEEP_INTERVAL_HALF)\n\t\t// Early return isn't allowed and the time remaining is large enough that we need to\n\t\t// wait some more (small amounts of remaining time can't be effectively waited for\n\t\t// due to the 10ms granularity limit of SetTimer):\n\t\treturn FAIL; // Tell the caller to wait some more.\n\n\t// v1.0.38.04: Reset mLastPeekTime because caller has just done a GetMessage() or PeekMessage(),\n\t// both of which should have routed events to the keyboard/mouse hooks like LONG_OPERATION_UPDATE's\n\t// PeekMessage() and thus satisfied the reason that mLastPeekTime is tracked in the first place.\n\t// UPDATE: Although the hooks now have a dedicated thread, there's a good chance mLastPeekTime is\n\t// beneficial in terms of increasing GUI & script responsiveness, so it is kept.\n\t// The following might also improve performance slightly by avoiding extra Peek() calls, while also\n\t// reducing premature thread interruptions.\n\tg_script.mLastPeekTime = tick_now;\n\treturn OK;\n}\n\n\n\nbool CheckScriptTimers()\n// Returns true if it launched at least one thread, and false otherwise.\n// It's best to call this function only directly from MsgSleep() or when there is an instance of\n// MsgSleep() closer on the call stack than the nearest dialog's message pump (e.g. MsgBox).\n// This is because threads some events might get queued up for our thread during the execution\n// of the timer subroutines here. When those subroutines finish, if we return directly to a dialog's\n// message pump, and such pending messages might be discarded or mishandled.\n// Caller should already have checked the value of g_script.mTimerEnabledCount to ensure it's\n// greater than zero, since we don't check that here (for performance).\n// This function will go through the list of timed subroutines only once and then return to its caller.\n// It does it only once so that it won't keep a thread beneath it permanently suspended if the sum\n// total of all timer durations is too large to be run at their specified frequencies.\n// This function is allowed to be called recursively, which handles certain situations better:\n// 1) A hotkey subroutine interrupted and \"buried\" one of the timer subroutines in the stack.\n// In this case, we don't want all the timers blocked just because that one is, so recursive\n// calls from ExecUntil() are allowed, and they might discover other timers to run.\n// 2) If the script is idle but one of the timers winds up taking a long time to execute (perhaps\n// it gets stuck in a long WinWait), we want a recursive call (from MsgSleep() in this example)\n// to launch any other enabled timers concurrently with the first, so that they're not neglected\n// just because one of the timers happens to be long-running.\n// Of course, it's up to the user to design timers so that they don't cause problems when they\n// interrupted hotkey subroutines, or when they themselves are interrupted by hotkey subroutines\n// or other timer subroutines.\n{\n\t// When the following is true, such as during a SendKeys() operation, it seems best not to launch any\n\t// new timed subroutines. The reasons for this are similar to the reasons for not allowing hotkeys\n\t// to fire during such times. Those reasons are discussed in other comments. In addition,\n\t// it seems best as a policy not to allow timed subroutines to run while the script's current\n\t// quasi-thread is paused. Doing so would make the tray icon flicker (were it even updated below,\n\t// which it currently isn't) and in any case is probably not what the user would want. Most of the\n\t// time, the user would want all timed subroutines stopped while the current thread is paused.\n\t// And even if this weren't true, the confusion caused by the subroutines still running even when\n\t// the current thread is paused isn't worth defaulting to the opposite approach. In the future,\n\t// and if there's demand, perhaps a config option can added that allows a different default behavior.\n\t// UPDATE: It seems slightly better (more consistent) to disallow all timed subroutines whenever\n\t// there is even one paused thread anywhere in the \"stack\".\n\t// v1.0.48: Since g_IdleIsPaused was removed (to simplify a lot of things), g_nPausedThreads now\n\t// counts the idle thread if it's paused. Also, to avoid array overflow, g_MaxThreadsTotal must not\n\t// be exceeded except where otherwise documented.\n\t// v2.0: g->AllowTimers is ignored when !g_nThreads so that its value can be retained for use as\n\t// the default for new threads, after the auto-execute thread finishes.\n\tif (g_nPausedThreads > 0 || (!g->AllowTimers && g_nThreads) || g_nThreads >= g_MaxThreadsTotal || !IsInterruptible()) // See above.\n\t\treturn false;\n\n\tScriptTimer *ptimer, *next_timer;\n\tBOOL at_least_one_timer_launched;\n\tDWORD tick_start;\n\n\t// Note: It seems inconsequential if a subroutine that the below loop executes causes a\n\t// new timer to be added to the linked list while the loop is still enumerating the timers.\n\n\tfor (at_least_one_timer_launched = FALSE, ptimer = g_script.mFirstTimer\n\t\t; ptimer != NULL\n\t\t; ptimer = next_timer)\n\t{\n\t\tScriptTimer &timer = *ptimer; // For performance and convenience.\n\t\tif (!timer.mEnabled || timer.mExistingThreads > 0 || timer.mPriority < g->Priority) // thread priorities\n\t\t{\n\t\t\tnext_timer = timer.mNextTimer;\n\t\t\tcontinue;\n\t\t}\n\n\t\ttick_start = GetTickCount(); // Call GetTickCount() every time in case a previous iteration of the loop took a long time to execute.\n\t\t// As of v1.0.36.03, the following subtracts two DWORDs to support intervals of 49.7 vs. 24.8 days.\n\t\t// This should work as long as the distance between the values being compared isn't greater than\n\t\t// 49.7 days. This is because 1 minus 2 in unsigned math yields 0xFFFFFFFF milliseconds (49.7 days).\n\t\t// If the distance between time values is greater than 49.7 days (perhaps because the computer was\n\t\t// suspended/hibernated for 50+ days), the next launch of the affected timer(s) will be delayed\n\t\t// by up to 100% of their periods. See IsInterruptible() for more discussion.\n\t\tif (tick_start - timer.mTimeLastRun < (DWORD)timer.mPeriod) // Timer is not yet due to run.\n\t\t{\n\t\t\tnext_timer = timer.mNextTimer;\n\t\t\tcontinue;\n\t\t}\n\t\t// Otherwise, this timer is due to run.\n\t\tif (!at_least_one_timer_launched) // This will be the first timer launched here.\n\t\t{\n\t\t\tat_least_one_timer_launched = TRUE;\n\t\t\t// Since this is the first subroutine that will be launched during this call to\n\t\t\t// this function, we know it will wind up running at least one subroutine, so\n\t\t\t// certain changes are made:\n\t\t\t// Increment the count of quasi-threads only once because this instance of this\n\t\t\t// function will never create more than 1 thread (i.e. if there is more than one\n\t\t\t// enabled timer subroutine, the will always be run sequentially by this instance).\n\t\t\t// If g_nThreads is zero, incrementing it will also effectively mark the script as\n\t\t\t// non-idle, the main consequence being that an otherwise-idle script can be paused\n\t\t\t// if the user happens to do it at the moment a timed subroutine is running, which\n\t\t\t// seems best since some timed subroutines might take a long time to run:\n\t\t\t++g_nThreads; // These are the counterparts the decrements that will be done further\n\t\t\t++g; // below by ResumeUnderlyingThread().\n\t\t\t// But never kill the main timer, since the mere fact that we're here means that\n\t\t\t// there's at least one enabled timed subroutine. Though later, performance can\n\t\t\t// be optimized by killing it if there's exactly one enabled subroutine, or if\n\t\t\t// all the subroutines are already in a running state (due to being buried beneath\n\t\t\t// the current quasi-thread). However, that might introduce unwanted complexity\n\t\t\t// in other places that would need to start up the timer again because we stopped it, etc.\n\t\t} // if (!at_least_one_timer_launched)\n\n\t\t// Fix for v1.0.31: mTimeLastRun is now given its new value *before* the thread is launched\n\t\t// rather than after. This allows a timer to be reset by its own thread -- by means of\n\t\t// \"SetTimer, TimerName\", which is otherwise impossible because the reset was being\n\t\t// overridden by us here when the thread finished.\n\t\t// Seems better to store the start time rather than the finish time, though it's clearly\n\t\t// debatable. The reason is that it's sometimes more important to ensure that a given\n\t\t// timed subroutine is *begun* at the specified interval, rather than assuming that\n\t\t// the specified interval is the time between when the prior run finished and the new\n\t\t// one began. This should make timers behave more consistently (i.e. how long a timed\n\t\t// subroutine takes to run SHOULD NOT affect its *apparent* frequency, which is number\n\t\t// of times per second or per minute that we actually attempt to run it):\n\t\ttimer.mTimeLastRun = tick_start;\n\t\tif (timer.mRunOnlyOnce)\n\t\t\ttimer.Disable(); // This is done prior to launching the thread for reasons similar to above.\n\n\t\t// v1.0.38.04: The following line is done prior to the timer launch to reduce situations\n\t\t// in which a timer thread is interrupted before it can execute even a single line.\n\t\t// Search for mLastPeekTime in MsgSleep() for detailed explanation.\n\t\tg_script.mLastPeekTime = tick_start; // It's valid to reset this because by definition, \"msg\" just came in to our caller via Get() or Peek(), both of which qualify as a Peek() for this purpose.\n\n\t\t// This next line is necessary in case a prior iteration of our loop invoked a different\n\t\t// timed subroutine that changed any of the global struct's values. In other words, make\n\t\t// every newly launched subroutine start off with the global default values that\n\t\t// the user set up in the auto-execute part of the script (e.g. KeyDelay, WinDelay, etc.).\n\t\t// Pass false as 3rd param below because ++g_nThreads should be done only once rather than\n\t\t// for each Init(), and also it's not necessary to call update the tray icon since timers\n\t\t// won't run if there is any paused thread, thus the icon can't currently be showing \"paused\".\n\t\tInitNewThread(timer.mPriority, false, false);\n\n\t\t// This is used to determine which timer SetTimer,,xxx acts on:\n\t\tg->CurrentTimer = &timer;\n\n\t\t++timer.mExistingThreads;\n\t\ttimer.mCallback->ExecuteInNewThread(_T(\"Timer\"));\n\t\t--timer.mExistingThreads;\n\n\t\tfor (auto *this_timer = &timer; this_timer; this_timer = next_timer)\n\t\t{\n\t\t\t// Resolve the next timer only now, in case other timers were created or deleted while\n\t\t\t// this timer was executing. Must be done before the timer is potentially deleted below.\n\t\t\t// Currently timers are disabled only when they can't be deleted (because they're\n\t\t\t// running). So now that this one has finished, check if it needs to be deleted.\n\t\t\tif (this_timer->mEnabled || this_timer->mExistingThreads || this_timer->mDeleteLocked)\n\t\t\t{\n\t\t\t\tif (this_timer == &timer) // If this_timer itself has just executed.\n\t\t\t\t\tnext_timer = this_timer->mNextTimer;\n\t\t\t\t//else leave next_timer == this_timer, in case it is ready to execute.\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tnext_timer = this_timer->mNextTimer;\n\t\t\tif (next_timer)\n\t\t\t\tnext_timer->mDeleteLocked++; // Prevent next_timer from being deleted.\n\t\t\t// The following call can trigger __delete, which can cause further changes to timers,\n\t\t\t// either directly via SetTimer or via thread interruption.\n\t\t\tg_script.DeleteTimer(this_timer->mCallback->ToObject());\n\t\t\tif (next_timer)\n\t\t\t\tnext_timer->mDeleteLocked--; // Might still be non-zero due to thread interruption.\n\t\t\t// Now also check next_timer, in case it was disabled while __delete was executing.\n\t\t} // for() series of timers being deleted.\n\t\t\n\t} // for() each timer.\n\n\tif (at_least_one_timer_launched) // Since at least one subroutine was run above, restore various values for our caller.\n\t{\n\t\tResumeUnderlyingThread();\n\t\treturn true;\n\t}\n\treturn false;\n}\n\n\n\nvoid PollJoysticks()\n// It's best to call this function only directly from MsgSleep() or when there is an instance of\n// MsgSleep() closer on the call stack than the nearest dialog's message pump (e.g. MsgBox).\n// This is because events posted to the thread indirectly by us here would be discarded or mishandled\n// by a non-standard (dialog) message pump.\n//\n// Polling the joysticks this way rather than using joySetCapture() is preferable for several reasons:\n// 1) I believe joySetCapture() internally polls the joystick anyway, via a system timer, so it probably\n// doesn't perform much better (if at all) than polling \"manually\".\n// 2) joySetCapture() only supports 4 buttons;\n// 3) joySetCapture() will fail if another app is already capturing the joystick;\n// 4) Even if the joySetCapture() succeeds, other programs (e.g. older games), would be prevented from\n// capturing the joystick while the script in question is running.\n{\n\t// Even if joystick hotkeys aren't currently allowed to fire, poll it anyway so that hotkey\n\t// messages can be buffered for later.\n\tstatic DWORD sButtonsPrev[MAX_JOYSTICKS] = {0}; // Set initial state to \"all buttons up for all joysticks\".\n\tJOYINFOEX jie;\n\tDWORD buttons_newly_down;\n\n\tfor (int i = 0; i < MAX_JOYSTICKS; ++i)\n\t{\n\t\tif (!Hotkey::sJoystickHasHotkeys[i])\n\t\t\tcontinue;\n\t\t// Reset these every time in case joyGetPosEx() ever changes them. Also, most systems have only one joystick,\n\t\t// so this code will hardly ever be executed more than once (and sometimes zero times):\n\t\tjie.dwSize = sizeof(JOYINFOEX);\n\t\tjie.dwFlags = JOY_RETURNBUTTONS; // vs. JOY_RETURNALL\n\t\tif (joyGetPosEx(i, &jie) != JOYERR_NOERROR) // Skip this joystick and try the others.\n\t\t\tcontinue;\n\t\t// The exclusive-or operator determines which buttons have changed state. After that,\n\t\t// the bitwise-and operator determines which of those have gone from up to down (the\n\t\t// down-to-up events are currently not significant).\n\t\tbuttons_newly_down = (jie.dwButtons ^ sButtonsPrev[i]) & jie.dwButtons;\n\t\tsButtonsPrev[i] = jie.dwButtons;\n\t\tif (!buttons_newly_down)\n\t\t\tcontinue;\n\t\t// See if any of the joystick hotkeys match this joystick ID and one of the buttons that\n\t\t// has just been pressed on it. If so, queue up (buffer) the hotkey events so that they will\n\t\t// be processed when messages are next checked:\n\t\tHotkey::TriggerJoyHotkeys(i, buttons_newly_down);\n\t}\n}\n\n\n\ninline bool MsgMonitor(MsgMonitorInstance &aInstance, HWND aWnd, UINT aMsg, WPARAM awParam, LPARAM alParam, MSG *apMsg, LRESULT &aMsgReply);\nbool MsgMonitor(HWND aWnd, UINT aMsg, WPARAM awParam, LPARAM alParam, MSG *apMsg, LRESULT &aMsgReply)\n// Returns false if the message is not being monitored, or it is but the called function indicated\n// that the message should be given its normal processing. Returns true when the caller should\n// not process this message but should instead immediately reply with aMsgReply (if a reply is possible).\n// When false is returned, caller should ignore the value of aMsgReply.\n{\n\t// This function directly launches new threads rather than posting them as something like\n\t// AHK_GUI_ACTION (which would allow them to be queued by means of MSG_FILTER_MAX) because a message\n\t// monitor function in the script can return \"true\" to exempt the message from further processing.\n\t// Consequently, the MSG_FILTER_MAX queuing effect will only occur for monitored messages that are\n\t// numerically greater than WM_HOTKEY. Other messages will not be subject to the filter and thus\n\t// will arrive here even when the script is currently uninterruptible, in which case it seems best\n\t// for flexibility to allow the interruption (the same is done for CreateCallback).\n\t//if (!INTERRUPTIBLE_IN_EMERGENCY)\n\t//\treturn false;\n\n\tbool result = false; // Set default: Tell the caller to give this message any additional/default processing.\n\tMsgMonitorInstance inst (g_MsgMonitor); // Register this instance so that index can be adjusted by BIF_OnMessage if an item is deleted.\n\n\t// Linear search vs. binary search should perform better on average because the vast majority\n\t// of message monitoring scripts are expected to monitor only a few message numbers.\n\tfor (inst.index = 0; inst.index < inst.count; ++inst.index)\n\t\tif (g_MsgMonitor[inst.index].msg == aMsg)\n\t\t{\n\t\t\tif (MsgMonitor(inst, aWnd, aMsg, awParam, alParam, apMsg, aMsgReply))\n\t\t\t{\n\t\t\t\tresult = true;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\treturn result;\n}\n\nbool MsgMonitor(MsgMonitorInstance &aInstance, HWND aWnd, UINT aMsg, WPARAM awParam, LPARAM alParam, MSG *apMsg, LRESULT &aMsgReply)\n{\n\tMsgMonitorStruct *monitor = &g_MsgMonitor[aInstance.index];\n\tIObject *func = monitor->func; // In case monitor item gets deleted while the function is running (e.g. by the function itself).\n\n\t// Many of the things done below are similar to the thread-launch procedure used in MsgSleep(),\n\t// so maintain them together and see MsgSleep() for more detailed comments.\n\tif (g_nThreads >= g_MaxThreadsTotal)\n\t\treturn false;\n\tif (monitor->instance_count >= monitor->max_instances || g->Priority > 0) // Monitor is already running more than the max number of instances, or existing thread's priority is too high to be interrupted.\n\t\treturn false;\n\t// Since above didn't return, the launch of the new thread is now considered unavoidable.\n\n\t// See MsgSleep() for comments about the following section.\n\tInitNewThread(0, false, true);\n\tDEBUGGER_STACK_PUSH(_T(\"OnMessage\")) // Push a \"thread\" onto the debugger's stack. For simplicity and performance, use the function name vs something like \"message 0x123\".\n\n\t// Set last found window (as documented). Can be NULL.\n\t// Nested controls like ComboBoxes require more than a simple call to GetParent().\n\tg->hWndLastUsed = GetNonChildParent(aWnd); // Assign parent window as the last found window (it's ok if it's hidden).\n\tif (apMsg)\n\t{\n\t\tg->EventInfo = apMsg->time;\n\t}\n\t//else leave them at their init-thread defaults.\n\t\n\t// v1.0.38.04: Below was added to maximize responsiveness to incoming messages. The reasoning\n\t// is similar to why the same thing is done in MsgSleep() prior to its launch of a thread, so see\n\t// MsgSleep for more comments:\n\tg_script.mLastPeekTime = GetTickCount();\n\t++monitor->instance_count;\n\n\t// Set up the array of parameters for func->Invoke().\n\tExprTokenType param[] =\n\t{\n\t\t(__int64)awParam,\n\t\t(__int64)(DWORD_PTR)alParam, // Additional type-cast prevents sign-extension on 32-bit, since LPARAM is signed.\n\t\t(__int64)aMsg,\n\t\t(__int64)(size_t)aWnd\n\t};\n\n\tResultType result;\n\t__int64 retval;\n\n\tresult = CallMethod(func, func, nullptr, param, _countof(param), &retval);\n\n\tbool block_further_processing = (result == EARLY_RETURN);\n\tif (block_further_processing)\n\t\taMsgReply = (LRESULT)retval;\n\t//else leave aMsgReply uninitialized because we'll be returning false later below, which tells our caller\n\t// to ignore aMsgReply.\n\n\tDEBUGGER_STACK_POP()\n\n\tResumeUnderlyingThread();\n\n\t// Check that the msg monitor still exists (it may have been deleted during the thread that just finished,\n\t// either by the thread itself or some other thread that interrupted it). The following cases are possible:\n\t// 1) This msg monitor is deleted, so g_MsgMonitor[aInstance.index] is either an obsolete array item\n\t// or some other msg monitor. Ensure this item matches before decrementing instance_count.\n\t// 2) An older msg monitor is deleted, so aInstance.index has been adjusted by BIF_OnMessage\n\t// and still points at the correct monitor.\n\t// 3) This msg monitor is deleted and recreated. aInstance.index might point to the new monitor,\n\t// in which case instance_count is zero and must not be decremented. If other monitors were also\n\t// deleted, aInstance.index might point at a different monitor or an obsolete array item.\n\t// 4) A newer msg monitor is deleted; nothing needs to be done since this item wasn't affected.\n\t// 5) Some other msg monitor is created; nothing needs to be done since it's added at the end of the list.\n\t//\n\t// UPDATE: We now use a simpler method which flags this specific instance as having been deleted,\n\t// so if the monitor is deleted and then recreated (with instance_count == 0), there's no chance\n\t// it will be picked up as the same instance.\n\t//\n\t// If \"monitor\" is defunct due to deletion, decrementing its instance_count is harmless. However,\n\t// \"monitor\" might have been reused by BIF_OnMessage() to create a new msg monitor, so it must be\n\t// checked to avoid wrongly decrementing some other msg monitor's instance_count.\n\tif (!aInstance.deleted)\n\t{\n\t\tmonitor = &g_MsgMonitor[aInstance.index]; // Retrieve it again in case it was moved.\n\t\tif (monitor->instance_count) // Checked for maintainability. Zero should be impossible due to the \"deleted\" check.\n\t\t\t--monitor->instance_count;\n\t}\n\telse\n\t{\n\t\t// \"monitor\" is now some other msg-monitor, so don't change it (see comments above).\n\t\taInstance.deleted = false; // Reset for subsequent iterations.\n\t}\n\treturn block_further_processing; // If false, the caller will ignore aMsgReply and process this message normally. If true, aMsgReply contains the reply the caller should immediately send for this message.\n}\n\n\n\nvoid InitNewThread(int aPriority, bool aSkipUninterruptible, bool aIncrementThreadCountAndUpdateTrayIcon\n\t, bool aIsCritical)\n// The value of aIsCritical is ignored when aSkipUninterruptible==true.\n// To reduce the expectation that a newly launched hotkey or timed subroutine will\n// be immediately interrupted by a timed subroutine or hotkey, interruptions are\n// forbidden for a short time (user-configurable). If the subroutine is a quick one --\n// finishing prior to when ExecUntil() or the Timer would have set g_AllowInterruption to be\n// true -- we will set it to be true afterward so that it gets done as quickly as possible.\n// The following rules of precedence apply:\n// If either UninterruptibleTime or UninterruptedLineCountMax is zero, newly launched subroutines\n// are always interruptible. Otherwise: If both are negative, newly launched subroutines are\n// never interruptible. If only one is negative, newly launched subroutines cannot be interrupted\n// due to that component, only the other one (which is now known to be positive otherwise the\n// first rule of precedence would have applied).\n{\n\tif (aIncrementThreadCountAndUpdateTrayIcon)\n\t{\n\t\t++g_nThreads; // It is the caller's responsibility to avoid calling us if the thread count is too high.\n\t\t// Once g_array[0] is used by AutoExec section, it's never used by any other thread because:\n\t\t// 1) the auto-execute thread might never finish, in which case it needs to keep consulting the values in g_array[0].\n\t\t// 2) it's used to retain the default settings for each newly launched thread.\n\t\t++g; \n\t}\n\t// Copy only settings, not state, from the auto-execute thread.\n\tmemcpy(static_cast<ScriptThreadSettings*>(g), static_cast<ScriptThreadSettings*>(&g_default), sizeof(ScriptThreadSettings));\n\n\tglobal_struct &g = *::g; // Must be done AFTER the ++g above. Reduces code size and may improve performance.\n\tglobal_clear_state(g);\n\tg.Priority = aPriority;\n\n\t// If the current quasi-thread is paused, the thread we're about to launch will not be, so the tray icon\n\t// needs to be checked unless the caller said it wasn't needed. In any case, if the tray icon is already\n\t// in the right state (which it usually, since paused threads are rare), UpdateTrayIcon() is a very fast call.\n\tif (aIncrementThreadCountAndUpdateTrayIcon)\n\t\tg_script.UpdateTrayIcon(); // Must be done ONLY AFTER updating \"g\" (e.g, ++g) and/or g->IsPaused.\n\n\tif (aSkipUninterruptible)\n\t\treturn;\n\n\tif (!g.ThreadIsCritical)\n\t\tg.ThreadIsCritical = aIsCritical;\n\n\tif (g_script.mUninterruptibleTime && g_script.mUninterruptedLineCountMax // Both components must be non-zero to start off uninterruptible.\n\t\t|| g.ThreadIsCritical) // v1.0.38.04.\n\t{\n\t\tg.PeekFrequency = UNINTERRUPTIBLE_PEEK_FREQUENCY; // This ensures the thread will always have a chance to call Critical() before MsgSleep() is called.\n\t\tg.AllowThreadToBeInterrupted = false;\n\t\tif (!g.ThreadIsCritical)\n\t\t{\n\t\t\tif (g_script.mUninterruptibleTime < 0) // A setting of -1 (or any negative) means the thread's uninterruptibility never times out.\n\t\t\t\tg.UninterruptibleDuration = -1; // \"Lock in\" the above because for backward compatibility, above is not supposed to affect threads after they're created. Override the default value contained in g_default.\n\t\t\t\t//g.ThreadStartTime doesn't need to be set when g.UninterruptibleDuration < 0.\n\t\t\telse // It's now known to be >0 (due to various checks above).\n\t\t\t{\n\t\t\t\t// For backward compatibility, \"lock in\" the time this thread will become interruptible\n\t\t\t\t// because that's how previous versions behaved (i.e. 'Thread \"Interrupt\", NewTimeout'\n\t\t\t\t// doesn't affect the current thread, only the thread creation behavior in the future).\n\t\t\t\t// This also makes it more predictable, since AllowThreadToBeInterrupted is only changed\n\t\t\t\t// when IsInterruptible() is called, which might not happen in between changes to the setting.\n\t\t\t\t// For explanation of why two fields instead of one are used, see comments in IsInterruptible().\n\t\t\t\tg.ThreadStartTime = GetTickCount();\n\t\t\t\tg.UninterruptibleDuration = g_script.mUninterruptibleTime;\n\t\t\t}\n\t\t}\n\t\t//else g.ThreadIsCritical==true, in which case the values set above won't matter; so they're not set.\n\t}\n\t//else g.AllowThreadToBeInterrupted is left at its default of true, in which case the values set\n\t// above won't matter; so they're not set.\n}\n\n\n\nvoid ResumeUnderlyingThread()\n{\n\tif (g->ThrownToken)\n\t\tg_script.FreeExceptionToken(g->ThrownToken);\n\n\n\t// The following section handles the switch-over to the former/underlying \"g\" item:\n\t--g_nThreads; // Other sections below might rely on this having been done early.\n\t--g;\n\t// The below relies on the above having restored \"g\" to be the global_struct of the underlying thread.\n\n\t// If the thread to be resumed was paused and has not been unpaused above, it will automatically be\n\t// resumed in a paused state because when we return from this function, we should be returning to\n\t// an instance of ExecUntil() (our caller), which should be in a pause loop still. Conversely,\n\t// if the thread to be resumed wasn't paused but was just paused above, the icon will be changed now\n\t// but the thread won't actually pause until ExecUntil() goes into its pause loop (which should be\n\t// immediately after the current command finishes, if execution is right in the middle of a command\n\t// due to the command having done a MsgSleep to allow a thread to interrupt).\n\t// Older comment: Always update the tray icon in case the paused state of the subroutine\n\t// we're about to resume is different from our previous paused state. Do this even\n\t// when the macro is used by CheckScriptTimers(), which although it might not technically\n\t// need it, lends maintainability and peace of mind.\n\tg_script.UpdateTrayIcon();\n\n\tif (!g_nThreads)\n\t{\n\t\t// If this was the last running thread and the script has nothing keeping it open (hotkeys, Gui,\n\t\t// message monitors, etc.) then it should terminate now:\n\t\tif (!g_OnExitIsRunning)\n\t\t\tg_script.ExitIfNotPersistent(EXIT_EXIT);\n\t\t// Since above didn't ExitApp(), reset the exit code for when we do eventually ExitApp():\n\t\tg_script.mPendingExitCode = 0;\n\t}\n}\n\n\n\nBOOL IsInterruptible()\n// Generally, anything that checks the value of g->AllowThreadToBeInterrupted should instead call this.\n// Indicates whether the current thread should be allowed to be interrupted by a new thread.\n// Managing uninterruptibility this way vs. SetTimer()+KillTimer() makes thread-creation speed\n// at least 10 times faster (perhaps even 100x if only the creation itself is measured).\n// This is because SetTimer() and/or KillTimer() are relatively slow calls, at least on XP.\n{\n\t// Having the two variables g_AllowInterruption and g->AllowThreadToBeInterrupted supports\n\t// the case where an uninterruptible operation such as SendKeys() happens to occur while\n\t// g->AllowThreadToBeInterrupted is true, which avoids having to backup and restore\n\t// g->AllowThreadToBeInterrupted in several places.\n\tif (!INTERRUPTIBLE_IN_EMERGENCY)\n\t\treturn FALSE; // Since it's not even emergency-interruptible, it can't be ordinary-interruptible.\n\tif (!g_nThreads) // Except in the above case, we're always interruptible if no threads are running.\n\t\treturn TRUE; // This is necessary to allow g_array[0].ThreadIsCritical to hold the default\n\t\t\t\t\t // setting without it preventing threads from launching after auto-exec finishes.\n\t// Otherwise, update g->AllowThreadToBeInterrupted (if necessary) and use that to determine the final answer.\n\t// Below are the reasons for having g->UninterruptibleDuration as a field separate from g->ThreadStartTime\n\t// (i.e. this is why they aren't merged into one called TimeThreadWillBecomeInterruptible):\n\t// (1) Need some way of indicating \"never time out\", which is currently done via\n\t// UninterruptibleDuration<0. Although that could be done as a bool to reduce global_struct size,\n\t// there's also the below.\n\t// (2) Suspending or hibernating the computer while a thread is uninterruptible could cause the thread to\n\t// become semi-permanently uninterruptible. For example:\n\t// - If a thread's uninterruptibility timeout is 60 seconds (or even 60 milliseconds);\n\t// - And the computer is suspended/hibernated before the uninterruptibility can time out;\n\t// - And the computer is then resumed 25 days later;\n\t// - Thread would be wrongly uninterruptible for ~24 days because the single-field method\n\t// (TimeThreadWillBecomeInterruptible) would have to subtract that field from GetTickCount()\n\t// and view the result as a signed integer.\n\t// (3) Somewhat similar to #2 above, there may be ways now or in the future for a script to have an\n\t// active/current thread but nothing the script does ever requires a call to IsInterruptible()\n\t// (currently unlikely since MSG_FILTER_MAX calls it). This could cause a TickCount to get too\n\t// stale and have the same consequences as described in #2 above.\n\t// OVERALL: Although the method used here can wrongly extend the uninterruptibility of a thread by as\n\t// much as 100%, since g_script.mUninterruptible time defaults to 17 milliseconds (and in practice is\n\t// rarely raised beyond 1000) it doesn't matter much in those cases. Even when g_script.mUninterruptible\n\t// is large such as 20 days, this method can be off by no more than 20 days, which isn't too bad\n\t// in percentage terms compared to the alternative, which could cause a timeout of 15 milliseconds to\n\t// increase to 24 days. Windows Vista and beyond have a 64-bit tickcount available, so that may be of\n\t// use in future versions (hopefully it performs nearly as well as GetTickCount()).\n\t// v2.0: g->UninterruptedLineCount is checked to ensure that each thread is allowed to execute at least\n\t// one line before being interrupted. This was proven necessary for g->UninterruptibleDuration <= 16\n\t// because GetTickCount() updates in increments of 15 or 16 and therefore 16 can be virtually no time\n\t// at all. It might also be needed for larger values if the system is busy.\n\tif ( !g->AllowThreadToBeInterrupted // Those who check whether g->AllowThreadToBeInterrupted==false should then check whether it should be made true.\n\t\t&& g->UninterruptibleDuration > -1 // Must take precedence over the below. g_script.mUninterruptibleTime is not checked because it's supposed to go into effect during thread creation, not after the thread is running and has possibly changed the timeout via 'Thread \"Interrupt\"'.\n\t\t&& (DWORD)(GetTickCount()- g->ThreadStartTime) >= (DWORD)g->UninterruptibleDuration // See big comment section above.\n\t\t&& g->UninterruptedLineCount // In case of \"Critical\" on the first line. See v2.0 comment above.\n\t\t)\n\t{\n\t\t// Once the thread becomes interruptible by any means, g->ThreadStartTime/UninterruptibleDuration\n\t\t// can never matter anymore because only Critical (never \"Thread Interrupt\") can turn off the\n\t\t// interruptibility again, and it resets g->UninterruptibleDuration.\n\t\tg->AllowThreadToBeInterrupted = true; // Avoids issues with 49.7 day limit of 32-bit TickCount, and also helps performance future callers of this function (they can skip most of the checking above).\n\t\tif (!g->ThreadIsCritical)\n\t\t\tg->PeekFrequency = DEFAULT_PEEK_FREQUENCY;\n\t}\n\t//else g->AllowThreadToBeInterrupted is already up-to-date.\n\treturn (BOOL)g->AllowThreadToBeInterrupted;\n}\n\n\n\nvoid MsgWaitUnpause()\n{\n\tauto &g = *::g;\n\twhile (g.IsPaused)\n\t{\n\t\tMsgWaitForMultipleObjects(0, nullptr, FALSE, INFINITE, QS_ALLINPUT);\n\t\tMsgSleep(-1);\n\t}\n}\n\n\n\nVOID CALLBACK MsgBoxTimeout(HWND hWnd, UINT uMsg, UINT_PTR idEvent, DWORD dwTime)\n{\n\t// Unfortunately, it appears that MessageBox() will return zero rather\n\t// than AHK_TIMEOUT, specified below -- at least under WinXP. This\n\t// makes it impossible to distinguish between a MessageBox() that's been\n\t// timed out (destroyed) by this function and one that couldn't be\n\t// created in the first place due to some other error. But since\n\t// MessageBox() errors are rare, we assume that they timed out if\n\t// the MessageBox() returns 0. UPDATE: Due to the fact that TimerProc()'s\n\t// are called via WM_TIMER messages in our msg queue, make sure that the\n\t// window really exists before calling EndDialog(), because if it doesn't,\n\t// chances are that EndDialog() was already called with another value.\n\t// UPDATE #2: Actually that isn't strictly needed because MessageBox()\n\t// ignores the AHK_TIMEOUT value we send here. But it feels safer:\n\tif (IsWindow(hWnd))\n\t\tEndDialog(hWnd, AHK_TIMEOUT);\n\tKillTimer(hWnd, idEvent);\n\t// v1.0.33: The following was added to fix the fact that a MsgBox with only an OK button\n\t// does not actually send back the code sent by EndDialog() above. The HWND is checked\n\t// in case \"g\" is no longer the original thread due to another thread having interrupted it.\n\t// v1.1.30.01: The loop was added so that the timeout can be detected even if the thread\n\t// which owns the dialog was interrupted.\n\tfor (auto *dialog_g = g; dialog_g >= g_array; --dialog_g)\n\t\tif (dialog_g->DialogHWND == hWnd) // Regardless of whether IsWindow() is true.\n\t\t{\n\t\t\tdialog_g->MsgBoxTimedOut = true;\n\t\t\tbreak;\n\t\t}\n}\n\n\n\nVOID CALLBACK InputTimeout(HWND hWnd, UINT uMsg, UINT_PTR idEvent, DWORD dwTime)\n{\n\tint new_timer_period = 0;\n\tfor (auto *input = g_input; input; input = input->Prev)\n\t{\n\t\tif (input->Timeout && input->InProgress())\n\t\t{\n\t\t\tint time_left = int(input->TimeoutAt - dwTime);\n\t\t\tif (time_left <= 0)\n\t\t\t\tinput->EndByTimeout();\n\t\t\telse if (time_left < new_timer_period || !new_timer_period)\n\t\t\t\tnew_timer_period = time_left;\n\t\t}\n\t}\n\tif (new_timer_period != 0)\n\t\tSET_INPUT_TIMER(new_timer_period, dwTime + new_timer_period)\n\telse\n\t\tKILL_INPUT_TIMER\n}\n\n\n\nVOID CALLBACK RefreshInterruptibility(HWND hWnd, UINT uMsg, UINT_PTR idEvent, DWORD dwTime)\n{\n\tIsInterruptible(); // Search on RefreshInterruptibility for comments.\n}\n\n\n\nvoid InitMenuPopup(HMENU aMenu)\n{\n\tif (MenuIsModeless(aMenu))\n\t{\n\t\t// Modeless menus don't interfere with things in the same way as modal menus.\n\t\tg_MenuIsVisible = false;\n\t}\n}\n\n\n\nvoid UninitMenuPopup(HMENU aMenu)\n{\n\tif (g_MenuIsTempModeless == aMenu)\n\t{\n\t\tg_MenuIsTempModeless = NULL;\n\t\t// Restore the menu's previous style so that next time the menu is shown, we can identify it\n\t\t// as one that we need to make temporarily modeless (i.e. not one the script has made modeless),\n\t\t// and also in case the script calls TrackPopupMenuEx directly and expects it to wait.\n\t\tMENUINFO mi;\n\t\tmi.cbSize = sizeof(mi);\n\t\tmi.fMask = MIM_STYLE;\n\t\tif (GetMenuInfo(aMenu, &mi))\n\t\t{\n\t\t\tmi.dwStyle &= ~MNS_MODELESS;\n\t\t\tSetMenuInfo(aMenu, &mi);\n\t\t}\n\t\t// Revert g_hWnd to non-topmost if appropriate.\n\t\tif (g_MenuIsTempTopmost)\n\t\t\tSetWindowPos(g_hWnd, HWND_NOTOPMOST, 0, 0, 0, 0, SWP_NOMOVE | SWP_NOSIZE);\n\t}\n}\n\n\n\nbool MenuIsModeless(HMENU aMenu)\n{\n\tMENUINFO mi;\n\tmi.cbSize = sizeof(mi);\n\tmi.fMask = MIM_STYLE;\n\tmi.dwStyle = 0;\n\tGetMenuInfo(aMenu, &mi);\n\treturn (mi.dwStyle & MNS_MODELESS);\n}\n"},"size":{"kind":"number","value":121366,"string":"121,366"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1962,"string":"1,962"},"avg_line_length":{"kind":"number","value":57.73190621814475,"string":"57.731906"},"max_line_length":{"kind":"number","value":349,"string":"349"},"alphanum_fraction":{"kind":"number","value":0.728081875760245,"string":"0.728082"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11079,"cells":{"id":{"kind":"number","value":16067,"string":"16,067"},"file_name":{"kind":"string","value":"error.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/error.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\"\n#include \"script.h\"\n#include \"globaldata.h\"\n#include \"window.h\"\n#include \"TextIO.h\"\n#include \"abi.h\"\n#include <richedit.h>\n\n\nResultType Line::PreparseError(LPTSTR aErrorText, LPTSTR aExtraInfo)\n{\n\treturn LineError(aErrorText, FAIL, aExtraInfo);\n}\n\n\n#ifdef CONFIG_DEBUGGER\nLPCTSTR Debugger::WhatThrew()\n{\n\t// We want 'What' to indicate the function/sub/operation that *threw* the exception.\n\t// For BIFs, throwing is always explicit. For a UDF, 'What' should only name it if\n\t// it explicitly constructed the Exception object. This provides an easy way for\n\t// OnError and Catch to categorise errors. No information is lost because File/Line\n\t// can already be used locate the function/sub that was running.\n\t// So only return a name when a BIF is raising an error:\n\tif (mStack.mTop < mStack.mBottom || mStack.mTop->type != DbgStack::SE_BIF)\n\t\treturn _T(\"\");\n\treturn mStack.mTop->func->mName;\n}\n#endif\n\n\nIObject *Line::CreateRuntimeException(LPCTSTR aErrorText, LPCTSTR aExtraInfo, Object *aPrototype)\n{\n\t// Build the parameters for Object::Create()\n\tExprTokenType aParams[3]; int aParamCount = 2;\n\tExprTokenType* aParam[3] { aParams + 0, aParams + 1, aParams + 2 };\n\taParams[0].SetValue(const_cast<LPTSTR>(aErrorText));\n#ifdef CONFIG_DEBUGGER\n\taParams[1].SetValue(const_cast<LPTSTR>(g_Debugger.WhatThrew()));\n#else\n\t// Without the debugger stack, there's no good way to determine what's throwing. It could be:\n\t//g_act[mActionType].Name; // A command implemented as an Action (g_act).\n\t//g->CurrentFunc->mName; // A user-defined function.\n\t//???; // A built-in function implemented as a Func (g_BIF).\n\taParams[1].SetValue(_T(\"\"), 0);\n#endif\n\tif (aExtraInfo && *aExtraInfo)\n\t\taParams[aParamCount++].SetValue(const_cast<LPTSTR>(aExtraInfo));\n\n\tauto obj = Object::Create();\n\tif (!obj)\n\t\treturn nullptr;\n\tif (!aPrototype)\n\t\taPrototype = ErrorPrototype::Error;\n\tobj->SetBase(aPrototype);\n\tFuncResult rt;\n\tg_script.mCurrLine = this;\n\tg_script.mNewRuntimeException = obj;\n\tif (!obj->Construct(rt, aParam, aParamCount))\n\t\tobj = nullptr; // Construct released it.\n\tg_script.mNewRuntimeException = nullptr;\n\treturn obj;\n}\n\n\nResultType Line::ThrowRuntimeException(LPCTSTR aErrorText, LPCTSTR aExtraInfo)\n{\n\treturn g_script.ThrowRuntimeException(aErrorText, aExtraInfo, this, FAIL);\n}\n\nResultType Script::ThrowRuntimeException(LPCTSTR aErrorText, LPCTSTR aExtraInfo\n\t, Line *aLine, ResultType aErrorType, Object *aPrototype)\n{\n\t// ThrownToken should only be non-NULL while control is being passed up the\n\t// stack, which implies no script code can be executing.\n\tASSERT(!g->ThrownToken);\n\n\tif (!aLine)\n\t\taLine = mCurrLine;\n\n\tResultToken *token;\n\tif ( !(token = new ResultToken)\n\t\t|| !(token->object = aLine->CreateRuntimeException(aErrorText, aExtraInfo, aPrototype)) )\n\t{\n\t\t// Out of memory. It's likely that we were called for this very reason.\n\t\t// Since we don't even have enough memory to allocate an exception object,\n\t\t// just show an error message and exit the thread. Don't call LineError(),\n\t\t// since that would recurse into this function.\n\t\tif (token)\n\t\t\tdelete token;\n\t\tif (!g->ThrownToken)\n\t\t{\n\t\t\tMsgBox(ERR_OUTOFMEM ERR_ABORT);\n\t\t\treturn FAIL;\n\t\t}\n\t\t//else: Thrown by Error constructor?\n\t}\n\telse\n\t{\n\t\ttoken->symbol = SYM_OBJECT;\n\t\ttoken->mem_to_free = NULL;\n\n\t\treturn aLine->SetThrownToken(*g, token, aErrorType);\n\t}\n\n\t// Returning FAIL causes each caller to also return FAIL, until either the\n\t// thread has fully exited or the recursion layer handling ACT_TRY is reached:\n\treturn FAIL;\n}\n\nResultType Script::ThrowRuntimeException(LPCTSTR aErrorText, LPCTSTR aExtraInfo)\n{\n\treturn ThrowRuntimeException(aErrorText, aExtraInfo, mCurrLine, FAIL);\n}\n\n\nResultType Line::SetThrownToken(global_struct &g, ResultToken *aToken, ResultType aErrorType)\n{\n#ifdef CONFIG_DEBUGGER\n\tif (g_Debugger.IsConnected())\n\t\tif (g_Debugger.PreThrow(aToken) && !(g.ExcptMode & EXCPTMODE_CATCH))\n\t\t{\n\t\t\t// The debugger has entered (and left) a break state, so the client has had a\n\t\t\t// chance to inspect the exception and report it. There's nothing in the DBGp\n\t\t\t// spec about what to do next, probably since PHP would just log the error.\n\t\t\t// In our case, it seems more useful to suppress the dialog than to show it.\n\t\t\tg_script.FreeExceptionToken(aToken);\n\t\t\treturn FAIL;\n\t\t}\n#endif\n\tg.ThrownToken = aToken;\n\tif (!(g.ExcptMode & EXCPTMODE_CATCH))\n\t\treturn g_script.UnhandledException(this, aErrorType); // Usually returns FAIL; may return OK if aErrorType == FAIL_OR_OK.\n\treturn FAIL;\n}\n\n\nBIF_DECL(BIF_Throw)\n{\n\tif (!aParamCount || aParam[aParamCount - 1]->symbol == SYM_MISSING)\n\t{\n\t\tif (g->ExcptMode & EXCPTMODE_CAUGHT) // Re-throw.\n\t\t\t_f_return_FAIL;\n\t\t_f_throw(ERR_EXCEPTION);\n\t}\n\tauto ¶m = *aParam[aParamCount - 1];\n\tResultToken* token = new ResultToken;\n\ttoken->mem_to_free = nullptr;\n\tswitch (param.symbol)\n\t{\n\tcase SYM_OBJECT:\n\t\ttoken->SetValue(param.object);\n\t\tparam.object->AddRef();\n\t\tbreak;\n\tcase SYM_VAR:\n\t\tparam.var->ToToken(*token);\n\t\tbreak;\n\tdefault:\n\t\ttoken->CopyValueFrom(param);\n\t}\n\tif (token->symbol == SYM_STRING && !token->Malloc(token->marker, token->marker_length))\n\t{\n\t\tdelete token;\n\t\t_f_throw_oom;\n\t}\n\t// Throw() isn't made continuable in v2.1 because existing v2.0 code isn't\n\t// expected to deal with the possibility that the thread doesn't exit.\n\tg_script.mCurrLine->SetThrownToken(*g, token, FAIL);\n\taResultToken.SetExitResult(FAIL);\n}\n\n\nResultType Script::Win32Error(DWORD aError, ResultType aErrorType)\n{\n\tTCHAR number_string[_MAX_ULTOSTR_BASE10_COUNT];\n\t// Convert aError to string to pass it through RuntimeError, but it will ultimately\n\t// be converted to the error number and proper message by OSError.Prototype.__New.\n\t_ultot(aError, number_string, 10);\n\treturn RuntimeError(number_string, _T(\"\"), aErrorType, nullptr, ErrorPrototype::OS);\n}\n\n\nvoid Script::SetErrorStdOut(LPTSTR aParam)\n{\n\tmErrorStdOutCP = Line::ConvertFileEncoding(aParam);\n\t// Seems best not to print errors to stderr if the encoding was invalid. Current behaviour\n\t// for an encoding of -1 would be to print only the ASCII characters and drop the rest, but\n\t// if our caller is expecting UTF-16, it won't be readable.\n\tmErrorStdOut = mErrorStdOutCP != -1;\n\t// If invalid, no error is shown here because this function might be called early, before\n\t// Line::sSourceFile[0] is given its value. Instead, errors appearing as dialogs should\n\t// be a sufficient clue that the /ErrorStdOut= value was invalid.\n}\n\nvoid Script::PrintErrorStdOut(LPCTSTR aErrorText, int aLength, LPCTSTR aFile)\n{\n#ifdef CONFIG_DEBUGGER\n\tif (g_Debugger.OutputStdOut(aErrorText))\n\t\treturn;\n#endif\n\tTextFile tf;\n\ttf.Open(aFile, TextStream::APPEND, mErrorStdOutCP);\n\ttf.Write(aErrorText, aLength);\n\ttf.Close();\n}\n\nint FormatStdErr(LPTSTR aBuf, int aBufSize, LPCTSTR aErrorText, LPCTSTR aExtraInfo, FileIndexType aFileIndex, LineNumberType aLineNumber, bool aWarn = false)\n{\n\t#define STD_ERROR_FORMAT _T(\"%s (%d) : ==> %s%s\\n\")\n\tint n = sntprintf(aBuf, aBufSize, STD_ERROR_FORMAT, Line::sSourceFile[aFileIndex], aLineNumber\n\t\t, aWarn ? _T(\"Warning: \") : _T(\"\"), aErrorText);\n\tif (*aExtraInfo)\n\t\tn += sntprintf(aBuf + n, aBufSize - n, _T(\" Specifically: %s\\n\"), aExtraInfo);\n\treturn n;\n}\n\n// For backward compatibility, this actually prints to stderr, not stdout.\nvoid Script::PrintErrorStdOut(LPCTSTR aErrorText, LPCTSTR aExtraInfo, FileIndexType aFileIndex, LineNumberType aLineNumber)\n{\n\tTCHAR buf[LINE_SIZE * 2];\n\tauto n = FormatStdErr(buf, _countof(buf), aErrorText, aExtraInfo, aFileIndex, aLineNumber);\n\tPrintErrorStdOut(buf, n, _T(\"**\"));\n}\n\nResultType Line::LineError(LPCTSTR aErrorText, ResultType aErrorType, LPCTSTR aExtraInfo)\n{\n\tASSERT(aErrorText);\n\tif (!aExtraInfo)\n\t\taExtraInfo = _T(\"\");\n\n\tif (g_script.mIsReadyToExecute)\n\t{\n\t\treturn g_script.RuntimeError(aErrorText, aExtraInfo, aErrorType, this);\n\t}\n\t\n#ifdef CONFIG_DLL\n\tif (LibNotifyProblem(aErrorText, aExtraInfo, this))\n\t\treturn aErrorType;\n#endif\n\t\n\tif (g_script.mErrorStdOut && aErrorType != WARN)\n\t{\n\t\t// JdeB said:\n\t\t// Just tested it in Textpad, Crimson and Scite. they all recognise the output and jump\n\t\t// to the Line containing the error when you double click the error line in the output\n\t\t// window (like it works in C++). Had to change the format of the line to: \n\t\t// printf(\"%s (%d) : ==> %s: \\n%s \\n%s\\n\",szInclude, nAutScriptLine, szText, szScriptLine, szOutput2 );\n\t\t// MY: Full filename is required, even if it's the main file, because some editors (EditPlus)\n\t\t// seem to rely on that to determine which file and line number to jump to when the user double-clicks\n\t\t// the error message in the output window.\n\t\t// v1.0.47: Added a space before the colon as originally intended. Toralf said, \"With this minor\n\t\t// change the error lexer of Scite recognizes this line as a Microsoft error message and it can be\n\t\t// used to jump to that line.\"\n\t\tg_script.PrintErrorStdOut(aErrorText, aExtraInfo, mFileIndex, mLineNumber);\n\t\treturn FAIL;\n\t}\n\n\treturn g_script.ShowError(aErrorText, aErrorType, aExtraInfo, this);\n}\n\nResultType Script::RuntimeError(LPCTSTR aErrorText, LPCTSTR aExtraInfo, ResultType aErrorType, Line *aLine, Object *aPrototype)\n{\n\tASSERT(aErrorText);\n\tif (!aExtraInfo)\n\t\taExtraInfo = _T(\"\");\n\n\tif ((g->ExcptMode || mOnError.Count()\n#ifdef CONFIG_DEBUGGER\n\t\t|| g_Debugger.BreakOnExceptionIsEnabled()\n#endif\n\t\t|| aPrototype) && aErrorType != WARN)\n\t\treturn ThrowRuntimeException(aErrorText, aExtraInfo, aLine, aErrorType, aPrototype);\n\t\n#ifdef CONFIG_DLL\n\tif (LibNotifyProblem(aErrorText, aExtraInfo, aLine))\n\t\treturn aErrorType;\n#endif\n\t\n\treturn ShowError(aErrorText, aErrorType, aExtraInfo, aLine);\n}\n\nFResult FError(LPCTSTR aErrorText, LPCTSTR aExtraInfo, Object *aPrototype)\n{\n\treturn g_script.RuntimeError(aErrorText, aExtraInfo, FAIL_OR_OK, nullptr, aPrototype) ? FR_ABORTED : FR_FAIL;\n}\n\n\nstruct ErrorBoxParam\n{\n\tLPCTSTR text;\n\tResultType type;\n\tLPCTSTR info;\n\tLine *line;\n\tObject *obj;\n#ifdef CONFIG_DEBUGGER\n\tint stack_index;\n#endif\n};\n\n\n#ifdef CONFIG_DEBUGGER\nvoid InsertCallStack(HWND re, ErrorBoxParam &error)\n{\n\tTCHAR buf[SCRIPT_STACK_BUF_SIZE], *stack = _T(\"\");\n\tif (error.obj && error.obj->IsOfType(Object::sPrototype))\n\t{\n\t\tauto obj = static_cast<Object*>(error.obj);\n\t\tif (auto temp = obj->GetOwnPropString(_T(\"Stack\")))\n\t\t\tstack = temp;\n\t}\n\telse if (error.stack_index >= 0)\n\t{\n\t\tGetScriptStack(stack = buf, _countof(buf), g_Debugger.mStack.mBottom + error.stack_index);\n\t}\n\n\tCHARFORMAT cfBold;\n\tcfBold.cbSize = sizeof(cfBold);\n\tcfBold.dwMask = CFM_BOLD | CFM_LINK;\n\tcfBold.dwEffects = CFE_BOLD;\n\tSendMessage(re, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM)&cfBold);\n\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)_T(\"Call stack:\\n\"));\n\tcfBold.dwEffects = 0;\n\tSendMessage(re, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM)&cfBold);\n\n\tif (!*stack)\n\t\treturn;\n\n\t// Prevent insertion of a blank line at the end (a bit pedantic, I know):\n\tauto stack_end = _tcschr(stack, '\\0');\n\tif (stack_end[-1] == '\\n')\n\t\t*--stack_end = '\\0';\n\tif (stack_end > stack && stack_end[-1] == '\\r')\n\t\t*--stack_end = '\\0';\n\t\n\tCHARFORMAT cfLink;\n\tcfLink.cbSize = sizeof(cfLink);\n\tcfLink.dwMask = CFM_LINK | CFM_BOLD;\n\tcfLink.dwEffects = CFE_LINK;\n\t//cfLink.crTextColor = 0xbb4d00; // Has no effect on Windows 7 or 11 (even with CFM_COLOR).\n\n\tCHARRANGE cr;\n\tSendMessage(re, EM_EXGETSEL, 0, (LPARAM)&cr); // This will become the start position of the stack text.\n\tauto start_pos = cr.cpMin;\n\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)stack);\n\t\t\n\tfor (auto cp = stack; ; )\n\t{\n\t\tif (auto ext = _tcsstr(cp, _T(\".ahk (\")))\n\t\t{\n\t\t\t// Apply CFE_LINK effect (and possibly colour) to the full path.\n\t\t\tcr.cpMax = cr.cpMin + int(ext - cp) + 4;\n\t\t\tSendMessage(re, EM_EXSETSEL, 0, (LPARAM)&cr);\n\t\t\tSendMessage(re, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM)&cfLink);\n\t\t}\n\t\tauto cpn = _tcschr(cp, '\\n');\n\t\tif (!cpn)\n\t\t\tbreak;\n\t\tcr.cpMin += int(cpn - cp);\n\t\tif (cpn == cp || cpn[-1] != '\\r') // Count the \\n only if \\r wasn't already counted, since it seems RichEdit uses just \\r internally.\n\t\t\t++cr.cpMin;\n\t\tcp = cpn + 1;\n\t}\n\n\tcr.cpMin = cr.cpMax = start_pos - 1; // Remove selection.\n\tSendMessage(re, EM_EXSETSEL, 0, (LPARAM)&cr);\n}\n#endif\n\n\nvoid InitErrorBox(HWND hwnd, ErrorBoxParam &error)\n{\n\tTCHAR buf[1024];\n\n\tSetWindowText(hwnd, g_script.DefaultDialogTitle());\n\n\tSetWindowLongPtr(hwnd, DWLP_USER, (LONG_PTR)&error);\n\n\tHWND re = GetDlgItem(hwnd, IDC_ERR_EDIT);\n\n\tRECT rc, rcOffset {0,0,7,7};\n\tSendMessage(re, EM_GETRECT, 0, (LPARAM)&rc);\n\tMapDialogRect(hwnd, &rcOffset);\n\trc.left += rcOffset.right;\n\trc.top += rcOffset.bottom;\n\trc.right -= rcOffset.right;\n\trc.bottom -= rcOffset.bottom;\n\tSendMessage(re, EM_SETRECTNP, 0, (LPARAM)&rc);\n\n\tPARAFORMAT pf;\n\tpf.cbSize = sizeof(pf);\n\tpf.dwMask = PFM_TABSTOPS;\n\tpf.cTabCount = 1;\n\tpf.rgxTabs[0] = 300;\n\tSendMessage(re, EM_SETPARAFORMAT, 0, (LPARAM)&pf);\n\n\tSETTEXTEX t { ST_SELECTION | ST_UNICODE, CP_UTF16 };\n\tSETTEXTEX t_rtf { ST_SELECTION | ST_DEFAULT, CP_UTF8 };\n\n\tCHARFORMAT2 cf;\n\tcf.cbSize = sizeof(cf);\n\n\tcf.dwMask = CFM_SIZE;\n\tcf.yHeight = 9*20;\n\tSendMessage(re, EM_SETCHARFORMAT, SCF_DEFAULT, (LPARAM)&cf);\n\t\n\tcf.dwMask = CFM_SIZE | CFM_COLOR;\n\tcf.yHeight = 10*20;\n\tcf.crTextColor = 0x3399;\n\tcf.dwEffects = 0;\n\tSendMessage(re, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM)&cf);\n\t\n\tsntprintf(buf, _countof(buf), _T(\"%s: %.500s\\n\")\n\t\t, error.type == CRITICAL_ERROR ? _T(\"Critical Error\")\n\t\t\t: error.type == WARN ? _T(\"Warning\") : _T(\"Error\")\n\t\t, error.text);\n\tauto cp = _tcschr(buf, '\\n');\n\tif (auto c = *++cp) // Multiple lines in error.text.\n\t{\n\t\t// Insert a break *after* the \\n so that formatting will revert to default afterward.\n\t\t*cp = '\\0';\n\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)buf);\n\t\t*cp = c;\n\t}\n\telse\n\t\tcp = buf;\n\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)cp);\n\t\n\tbool file_needs_break = true;\n\tif (error.info && *error.info)\n\t{\n\t\tUINT suffix = _tcslen(error.info) > 80 ? 8230 : 0;\n\t\tif (file_needs_break = error.line || error.obj)\n\t\t\tsntprintf(buf, _countof(buf), _T(\"\\nSpecifically: %.80s%s\\n\"), error.info, &suffix);\n\t\telse\n\t\t\tsntprintf(buf, _countof(buf), _T(\"\\nText:\\t%.80s%s\\n\"), error.info, &suffix);\n\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)buf);\n\t}\n\n\tif (error.line)\n\t{\n\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)_T(\"\\n\"));\n\n\t\t#define LINES_ABOVE_AND_BELOW 2\n\n\t\t// Determine the range of lines to be shown:\n\t\tLine *line_start = error.line, *line_end = error.line;\n\t\tif (g_AllowMainWindow)\n\t\t{\n\t\t\tfor (int i = 0\n\t\t\t\t; i < LINES_ABOVE_AND_BELOW && line_start->mPrevLine != NULL\n\t\t\t\t; ++i, line_start = line_start->mPrevLine);\n\t\t\tfor (int i = 0\n\t\t\t\t; i < LINES_ABOVE_AND_BELOW && line_end->mNextLine != NULL\n\t\t\t\t; ++i, line_end = line_end->mNextLine);\n\t\t}\n\t\t//else show only a single line, to conceal the script's source code.\n\n\t\tint last_file = 0; // Init to zero so path is omitted if it is the main file.\n\t\tfor (auto line = line_start; ; line = line->mNextLine)\n\t\t{\n\t\t\tif (last_file != line->mFileIndex)\n\t\t\t{\n\t\t\t\tlast_file = line->mFileIndex;\n\t\t\t\tsntprintf(buf, _countof(buf), _T(\"\\t---- %s\\n\"), Line::sSourceFile[line->mFileIndex]);\n\t\t\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)buf);\n\t\t\t}\n\t\t\tint lead = 0;\n\t\t\tif (line == error.line)\n\t\t\t{\n\t\t\t\tcf.dwMask = CFM_COLOR | CFM_BACKCOLOR;\n\t\t\t\tcf.crTextColor = 0; // Use explicit black to ensure visibility if a high contrast theme is enabled.\n\t\t\t\tcf.crBackColor = 0x60ffff;\n\t\t\t\tSendMessage(re, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM)&cf);\n\t\t\t\tbuf[lead++] = 9654; // ▶\n\t\t\t}\n\t\t\tbuf[lead++] = '\\t';\n\t\t\tbuf[lead] = '\\0';\n\t\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)buf);\n\n\t\t\tline->ToText(buf, _countof(buf), true);\n\t\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)buf);\n\t\t\tif (line == line_end)\n\t\t\t\tbreak;\n\t\t}\n\t}\n\telse\n\t{\n\t\tLPCTSTR file = nullptr;\n\t\tLineNumberType line = 0;\n\t\tif (error.obj)\n\t\t{\n\t\t\tfile = error.obj->GetOwnPropString(_T(\"File\"));\n\t\t\tline = (LineNumberType)error.obj->GetOwnPropInt64(_T(\"Line\"));\n\t\t}\n\t\telse\n\t\t{\n\t\t\tfile = g_script.CurrentFile();\n\t\t\tline = g_script.CurrentLine();\n\t\t}\n\t\tif (file && *file)\n\t\t{\n\t\t\tsntprintf(buf, _countof(buf), line ? _T(\"\\nLine:\\t%d\\nFile:\\t\") : _T(\"\\nFile: \"), line);\n\t\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)(buf + !file_needs_break));\n\t\t\tcf.dwMask = CFM_LINK;\n\t\t\tcf.dwEffects = CFE_LINK; // Mark it as a link.\n\t\t\tSendMessage(re, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM)&cf);\n\t\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)file);\n\t\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)_T(\"\\n\"));\n\t\t}\n\t}\n\n\tLPCTSTR footer = error.obj ? error.obj->GetOwnPropString(_T(\"Hint\")) : nullptr;\n\tif (footer) // Footer was specified.\n\t{\n\t\tif (!*footer) // Explicitly blank: omit default footer.\n\t\t\tfooter = nullptr;\n\t}\n\telse // Use default footer for this error type, if any.\n\t{\n\t\tswitch (error.type)\n\t\t{\n\t\tcase WARN: footer = ERR_WARNING_FOOTER; break;\n\t\tcase FAIL_OR_OK: break;\n\t\tcase CRITICAL_ERROR: footer = UNSTABLE_WILL_EXIT; break;\n\t\tdefault: footer = (g->ExcptMode & EXCPTMODE_DELETE) ? ERR_ABORT_DELETE\n\t\t\t: g_script.mIsReadyToExecute ? ERR_ABORT_NO_SPACES\n\t\t\t: g_script.mIsRestart ? OLD_STILL_IN_EFFECT\n\t\t\t: WILL_EXIT;\n\t\t}\n\t}\n\tif (footer)\n\t{\n\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)_T(\"\\n\"));\n\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)footer);\n\t}\n\n#ifdef CONFIG_DEBUGGER\n\tLPCTSTR stack;\n\tif ( error.stack_index >= 0\n\t\t|| error.obj && error.obj->IsOfType(Object::sPrototype)\n\t\t\t&& (stack = error.obj->GetOwnPropString(_T(\"Stack\"))) && *stack )\n\t{\n\t\t// Stack trace appears to be available, so add a link to show it.\n\t\tCHARRANGE cr;\n\t\tfor (int i = footer ? 2 : 1; i; --i)\n\t\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)_T(\"\\n\"));\n\t\tSendMessage(re, EM_EXGETSEL, 0, (LPARAM)&cr);\n#define SHOW_CALL_STACK_TEXT _T(\"Show call stack »\")\n\t\tSendMessage(re, EM_REPLACESEL, FALSE, (LPARAM)SHOW_CALL_STACK_TEXT);\n\t\tcr.cpMax = -1; // Select to end.\n\t\tSendMessage(re, EM_EXSETSEL, 0, (LPARAM)&cr);\n\t\tcf.dwMask = CFM_LINK;\n\t\tcf.dwEffects = CFE_LINK; // Mark it as a link.\n\t\tSendMessage(re, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM)&cf);\n\t\tcr.cpMin = -1; // Deselect (move selection anchor to insertion point).\n\t\tSendMessage(re, EM_EXSETSEL, 0, (LPARAM)&cr);\n\t}\n#endif\n\n\tSendMessage(re, EM_SETEVENTMASK, 0, ENM_REQUESTRESIZE | ENM_LINK | ENM_KEYEVENTS);\n\tSendMessage(re, EM_REQUESTRESIZE, 0, 0);\n\n#ifndef AUTOHOTKEYSC\n\tif (error.line && error.line->mFileIndex ? *Line::sSourceFile[error.line->mFileIndex] == '*'\n\t\t: g_script.mKind != Script::ScriptKindFile)\n\t\t// Source \"file\" is an embedded resource or stdin, so can't be edited.\n\t\tEnableWindow(GetDlgItem(hwnd, ID_FILE_EDITSCRIPT), FALSE);\n#endif\n\n\tif (error.type != FAIL_OR_OK)\n\t{\n\t\tHWND hide = GetDlgItem(hwnd, error.type == WARN ? IDCANCEL : IDCONTINUE);\n\t\tif (error.type == WARN)\n\t\t{\n\t\t\t// Hide \"Abort\" since it it's not applicable to warnings except as an alias of ExitApp,\n\t\t\t// shift \"Continue\" to the right for aesthetic purposes and make it the default button\n\t\t\t// (otherwise the left-most button would become the default).\n\t\t\tRECT rc;\n\t\t\tGetClientRect(hide, &rc);\n\t\t\tMapWindowPoints(hide, hwnd, (LPPOINT)&rc, 1);\n\t\t\tHWND keep = GetDlgItem(hwnd, IDCONTINUE);\n\t\t\tMoveWindow(keep, rc.left, rc.top, rc.right, rc.bottom, FALSE);\n\t\t\tDefDlgProc(hwnd, DM_SETDEFID, IDCONTINUE, 0);\n\t\t\tSetFocus(keep);\n\t\t}\n\t\tShowWindow(hide, SW_HIDE);\n\t}\n}\n\n\nINT_PTR CALLBACK ErrorBoxProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)\n{\n\tswitch (msg)\n\t{\n\tcase WM_COMMAND:\n\t\tswitch (LOWORD(wParam))\n\t\t{\n\t\tcase IDCONTINUE:\n\t\tcase IDCANCEL:\n\t\t\tEndDialog(hwnd, wParam);\n\t\t\treturn TRUE;\n\t\tcase ID_FILE_EDITSCRIPT:\n\t\t{\n\t\t\tauto &error = *(ErrorBoxParam*)GetWindowLongPtr(hwnd, DWLP_USER);\n\t\t\tif (error.line)\n\t\t\t{\n\t\t\t\tg_script.Edit(Line::sSourceFile[error.line->mFileIndex]);\n\t\t\t\treturn TRUE;\n\t\t\t}\n\t\t}\n\t\tdefault:\n\t\t\tif (LOWORD(wParam) >= ID_FILE_RELOADSCRIPT)\n\t\t\t{\n\t\t\t\t// Call the handler directly since g_hWnd might be NULL if this is a warning dialog.\n\t\t\t\tHandleMenuItem(NULL, LOWORD(wParam), NULL);\n\t\t\t\tif (LOWORD(wParam) == ID_FILE_RELOADSCRIPT)\n\t\t\t\t\tEndDialog(hwnd, IDCANCEL);\n\t\t\t\treturn TRUE;\n\t\t\t}\n\t\t}\n\t\tbreak;\n\tcase WM_NOTIFY:\n\t\tif (wParam == IDC_ERR_EDIT)\n\t\t{\n\t\t\tHWND re = ((NMHDR*)lParam)->hwndFrom;\n\t\t\tswitch (((NMHDR*)lParam)->code)\n\t\t\t{\n\t\t\tcase EN_MSGFILTER:\n\t\t\t{\n\t\t\t\tauto mf = (MSGFILTER*)lParam;\n\t\t\t\tif (mf->msg == WM_CHAR)\n\t\t\t\t\t// Forward it to any of the buttons so the dialog will process it as a mnemonic.\n\t\t\t\t\tPostMessage(GetDlgItem(hwnd, IDCANCEL), mf->msg, mf->wParam, mf->lParam);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase EN_REQUESTRESIZE: // Received when the RichEdit's content grows beyond its capacity to display all at once.\n\t\t\t{\n\t\t\t\tRECT &rcNew = ((REQRESIZE*)lParam)->rc;\n\t\t\t\tRECT rcOld, rcInner;\n\t\t\t\tGetWindowRect(re, &rcOld);\n\t\t\t\tSendMessage(re, EM_GETRECT, 0, (LPARAM)&rcInner);\n\t\t\t\t// Stack traces can get quite \"tall\" if the paths/lines are mostly short,\n\t\t\t\t// so impose a rough limit to ensure the dialog remains usable.\n\t\t\t\tint rough_limit = GetSystemMetrics(SM_CYSCREEN) * 3 / 4;\n\t\t\t\tif (rcNew.bottom > rough_limit)\n\t\t\t\t\trcNew.bottom = rough_limit;\n\t\t\t\tint delta = rcNew.bottom - (rcInner.bottom - rcInner.top);\n\t\t\t\tif (rcNew.bottom == rough_limit)\n\t\t\t\t\tSendMessage(re, EM_SHOWSCROLLBAR, SB_VERT, TRUE);\n\t\t\t\t// Enable horizontal scroll bars if necessary.\n\t\t\t\tif (rcNew.right > (rcInner.right - rcInner.left)\n\t\t\t\t\t&& !(GetWindowLong(re, GWL_STYLE) & WS_HSCROLL))\n\t\t\t\t{\n\t\t\t\t\tSendMessage(re, EM_SHOWSCROLLBAR, SB_HORZ, TRUE);\n\t\t\t\t\tdelta += GetSystemMetrics(SM_CYHSCROLL);\n\t\t\t\t}\n\t\t\t\t// Move the buttons (and the RichEdit, temporarily).\n\t\t\t\tScrollWindow(hwnd, 0, delta, NULL, NULL);\n\t\t\t\t// Resize the RichEdit, while also moving it back to the origin.\n\t\t\t\tMoveWindow(re, 0, 0, rcOld.right - rcOld.left, rcOld.bottom - rcOld.top + delta, TRUE);\n\t\t\t\t// Adjust the dialog's height and vertical position.\n\t\t\t\tGetWindowRect(hwnd, &rcOld);\n\t\t\t\tMoveWindow(hwnd, rcOld.left, rcOld.top - (delta / 2), rcOld.right - rcOld.left, rcOld.bottom - rcOld.top + delta, TRUE);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase EN_LINK: // Received when the user clicks or moves the mouse over text with the CFE_LINK effect.\n\t\t\t\tif (((ENLINK*)lParam)->msg == WM_LBUTTONUP)\n\t\t\t\t{\n\t\t\t\t\tTEXTRANGE tr { ((ENLINK*)lParam)->chrg };\n\t\t\t\t\tSendMessage(re, EM_EXSETSEL, 0, (LPARAM)&tr.chrg);\n\t\t\t\t\ttr.lpstrText = (LPTSTR)talloca(tr.chrg.cpMax - tr.chrg.cpMin + 1);\n\t\t\t\t\t*tr.lpstrText = '\\0';\n\t\t\t\t\tSendMessage(re, EM_GETTEXTRANGE, 0, (LPARAM)&tr);\n\t\t\t\t\tPostMessage(hwnd, WM_NEXTDLGCTL, TRUE, FALSE); // Make it less edit-like by shifting focus away.\n#ifdef CONFIG_DEBUGGER\n\t\t\t\t\tif (!_tcscmp(tr.lpstrText, SHOW_CALL_STACK_TEXT))\n\t\t\t\t\t{\n\t\t\t\t\t\tauto &error = *(ErrorBoxParam*)GetWindowLongPtr(hwnd, DWLP_USER);\n\t\t\t\t\t\tInsertCallStack(re, error);\n\t\t\t\t\t\treturn TRUE;\n\t\t\t\t\t}\n#endif\n\t\t\t\t\tg_script.Edit(tr.lpstrText);\n\t\t\t\t\treturn TRUE;\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\tbreak;\n\tcase WM_INITDIALOG:\n\t\tInitErrorBox(hwnd, *(ErrorBoxParam *)lParam);\n\t\treturn FALSE; // \"return FALSE to prevent the system from setting the default keyboard focus\"\n\t}\n\treturn FALSE;\n}\n\n\n__declspec(noinline)\nResultType Script::ShowError(LPCTSTR aErrorText, ResultType aErrorType, LPCTSTR aExtraInfo, Line *aLine)\n{\n\t// This overload reduces code size vs. using optional parameters since the the latter\n\t// works by the compiler implicitly inserting the default values in the compiled code.\n\treturn ShowError(aErrorText, aErrorType, aExtraInfo, aLine, nullptr);\n}\n\n\nResultType Script::ShowError(LPCTSTR aErrorText, ResultType aErrorType, LPCTSTR aExtraInfo, Line *aLine, Object *aException)\n{\n\tif (!aErrorText)\n\t\taErrorText = _T(\"\");\n\tif (!aExtraInfo)\n\t\taExtraInfo = _T(\"\");\n\n#ifdef CONFIG_DEBUGGER\n\tif (g_Debugger.HasStdErrHook())\n\t{\n\t\tTCHAR buf[LINE_SIZE * 2];\n\t\tLine *line = aLine ? aLine : mCurrLine;\n\t\tFormatStdErr(buf, _countof(buf), aErrorText, aExtraInfo\n\t\t\t, line ? line->mFileIndex : mCurrFileIndex\n\t\t\t, line ? line->mLineNumber : mCombinedLineNumber\n\t\t\t, aErrorType == WARN);\n\t\tg_Debugger.OutputStdErr(buf);\n\t}\n#endif\n\n\tstatic auto sMod = LoadLibrary(_T(\"riched20.dll\")); // RichEdit20W\n\t//static auto sMod = LoadLibrary(_T(\"msftedit.dll\")); // MSFTEDIT_CLASS (RICHEDIT50W)\n\tErrorBoxParam error;\n\terror.text = aErrorText;\n\terror.type = aErrorType;\n\terror.info = aExtraInfo;\n\terror.line = aLine;\n\terror.obj = aException;\n#ifdef CONFIG_DEBUGGER\n\terror.stack_index = (aException || !g_script.mIsReadyToExecute) ? -1 : int(g_Debugger.mStack.mTop - g_Debugger.mStack.mBottom);\n#endif\n\tINT_PTR result = DialogBoxParam(NULL, MAKEINTRESOURCE(IDD_ERRORBOX), NULL, ErrorBoxProc, (LPARAM)&error);\n\tif (result == IDCONTINUE && aErrorType == FAIL_OR_OK)\n\t\treturn OK;\n\tif (result == -1) // May have failed to show the custom dialog box.\n\t\tMsgBox(aErrorText, MB_TOPMOST); // Keep it simple since it will hopefully never be needed.\n\n\tif (aErrorType == CRITICAL_ERROR && mIsReadyToExecute)\n\t\tExitApp(EXIT_CRITICAL); // Pass EXIT_CRITICAL to ensure the program always exits, regardless of OnExit.\n\tif (aErrorType == WARN && result == IDCANCEL && !mIsReadyToExecute) // Let Escape cancel loading the script.\n\t\tExitApp(EXIT_EXIT);\n\n\treturn FAIL; // Some callers rely on a FAIL result to propagate failure.\n}\n\n\n\nResultType Script::ScriptError(LPCTSTR aErrorText, LPCTSTR aExtraInfo)\n// Even though this is a Script method, including it here since it shares\n// a common theme with the other error-displaying functions:\n{\n\tif (mCurrLine && g_script.mIsReadyToExecute)\n\t\t// If a line is available, do RuntimeError instead for exceptions and line context.\n\t\treturn RuntimeError(aErrorText, aExtraInfo, FAIL, mCurrLine);\n\t// Otherwise: The fact that mCurrLine is NULL means that the line currently being loaded\n\t// has not yet been successfully added to the linked list. Such errors will always result\n\t// in the program exiting.\n\tif (!aErrorText)\n\t\taErrorText = _T(\"Unk\"); // Placeholder since it shouldn't be NULL.\n\tif (!aExtraInfo) // In case the caller explicitly called it with NULL.\n\t\taExtraInfo = _T(\"\");\n\t\n#ifdef CONFIG_DLL\n\tif (LibNotifyProblem(aErrorText, aExtraInfo, nullptr))\n\t\treturn FAIL;\n#endif\n\t\n\tif (g_script.mErrorStdOut && !g_script.mIsReadyToExecute) // i.e. runtime errors are always displayed via dialog.\n\t{\n\t\t// See LineError() for details.\n\t\tPrintErrorStdOut(aErrorText, aExtraInfo, mCurrLine ? mCurrLine->mFileIndex : mCurrFileIndex, CurrentLine());\n\t}\n\telse\n\t{\n\t\tShowError(aErrorText, FAIL, aExtraInfo, nullptr);\n\t}\n\treturn FAIL; // See above for why it's better to return FAIL than CRITICAL_ERROR.\n}\n\n\n\nLPCTSTR VarKindForErrorMessage(Var *aVar)\n{\n\tswitch (aVar->Type())\n\t{\n\tcase VAR_VIRTUAL: return _T(\"built-in variable\");\n\tcase VAR_CONSTANT: return aVar->Object()->Type();\n\tdefault: return Var::DeclarationType(aVar->Scope());\n\t}\n}\n\nResultType Script::ConflictingDeclarationError(LPCTSTR aDeclType, Var *aExisting)\n{\n\tTCHAR buf[127];\n\tsntprintf(buf, _countof(buf), _T(\"This %s declaration conflicts with an existing %s.\")\n\t\t, aDeclType, VarKindForErrorMessage(aExisting));\n\treturn ScriptError(buf, aExisting->mName);\n}\n\n\nResultType Line::ValidateVarUsage(Var *aVar, int aUsage)\n{\n\tif (VARREF_IS_WRITE(aUsage) && aVar->IsReadOnly() && aUsage != VARREF_LVALUE_MAYBE)\n\t\treturn VarIsReadOnlyError(aVar, aUsage);\n\treturn OK;\n}\n\n__declspec(noinline)\nResultType Script::VarIsReadOnlyError(Var *aVar, int aErrorType)\n{\n\tTCHAR buf[127];\n\tsntprintf(buf, _countof(buf), _T(\"This %s cannot %s.\")\n\t\t, VarKindForErrorMessage(aVar)\n\t\t, aErrorType == VARREF_OUTPUT_VAR ? _T(\"be used as an output variable\")\n\t\t: aErrorType == VARREF_REF ? _T(\"have its reference taken\")\n\t\t: _T(\"be assigned a value\"));\n\treturn ScriptError(buf, aVar->mName);\n}\n\nResultType Line::VarIsReadOnlyError(Var *aVar, int aErrorType)\n{\n\tg_script.mCurrLine = this;\n\treturn g_script.VarIsReadOnlyError(aVar, aErrorType);\n}\n\n\nResultType Line::LineUnexpectedError()\n{\n\tTCHAR buf[127];\n\tsntprintf(buf, _countof(buf), _T(\"Unexpected \\\"%s\\\"\"), g_act[mActionType].Name);\n\treturn LineError(buf);\n}\n\n\n\nResultType Script::CriticalError(LPCTSTR aErrorText, LPCTSTR aExtraInfo)\n{\n\tg->ExcptMode = EXCPTMODE_NONE; // Do not throw an exception.\n\tif (mCurrLine)\n\t\tmCurrLine->LineError(aErrorText, CRITICAL_ERROR, aExtraInfo);\n\t// mCurrLine should always be non-NULL during runtime, and CRITICAL_ERROR should\n\t// cause LineError() to exit even if an OnExit routine is present, so this is here\n\t// mainly for maintainability.\n\tTerminateApp(EXIT_CRITICAL, 0);\n\treturn FAIL; // Never executed.\n}\n\n\n\n__declspec(noinline)\nResultType ResultToken::Error(LPCTSTR aErrorText)\n{\n\t// Defining this overload separately rather than making aErrorInfo optional reduces code size\n\t// by not requiring the compiler to 'push' the second parameter's default value at each call site.\n\treturn Error(aErrorText, _T(\"\"));\n}\n\n__declspec(noinline)\nResultType ResultToken::Error(LPCTSTR aErrorText, LPCTSTR aExtraInfo)\n{\n\treturn Error(aErrorText, aExtraInfo, nullptr);\n}\n\n__declspec(noinline)\nResultType ResultToken::Error(LPCTSTR aErrorText, Object *aPrototype)\n{\n\treturn Error(aErrorText, nullptr, aPrototype);\n}\n\n__declspec(noinline)\nResultType ResultToken::Error(LPCTSTR aErrorText, LPCTSTR aExtraInfo, Object *aPrototype)\n{\n\t// These two assertions should always pass, since anything else would imply returning a value,\n\t// not throwing an error. If they don't, the memory/object might not be freed since the caller\n\t// isn't expecting a value, or they might be freed twice (if the callee already freed it).\n\t//ASSERT(!mem_to_free); // At least one caller frees it after calling this function.\n\tASSERT(symbol != SYM_OBJECT);\n\treturn Fail(g_script.RuntimeError(aErrorText, aExtraInfo, FAIL_OR_OK, nullptr, aPrototype));\n}\n\n__declspec(noinline)\nResultType ResultToken::Error(LPCTSTR aErrorText, ExprTokenType &aExtraInfo, Object *aPrototype)\n{\n\tTCHAR buf[MAX_NUMBER_SIZE];\n\treturn Error(aErrorText, TokenToString(aExtraInfo, buf), aPrototype);\n}\n\n__declspec(noinline)\nResultType ResultToken::MemoryError()\n{\n\treturn Error(ERR_OUTOFMEM, nullptr, ErrorPrototype::Memory);\n}\n\nResultType MemoryError()\n{\n\treturn g_script.RuntimeError(ERR_OUTOFMEM, nullptr, FAIL, nullptr, ErrorPrototype::Memory);\n}\n\nvoid SimpleHeap::CriticalFail()\n{\n\tg_script.CriticalError(ERR_OUTOFMEM);\n}\n\n__declspec(noinline)\nResultType ResultToken::ValueError(LPCTSTR aErrorText)\n{\n\treturn Error(aErrorText, nullptr, ErrorPrototype::Value);\n}\n\n__declspec(noinline)\nResultType ResultToken::ValueError(LPCTSTR aErrorText, LPCTSTR aExtraInfo)\n{\n\treturn Error(aErrorText, aExtraInfo, ErrorPrototype::Value);\n}\n\n__declspec(noinline)\nResultType ValueError(LPCTSTR aErrorText, LPCTSTR aExtraInfo, ResultType aErrorType)\n{\n\tif (!g_script.mIsReadyToExecute)\n\t\treturn g_script.ScriptError(aErrorText, aExtraInfo);\n\treturn g_script.RuntimeError(aErrorText, aExtraInfo, aErrorType, nullptr, ErrorPrototype::Value);\n}\n\n__declspec(noinline)\nFResult FValueError(LPCTSTR aErrorText, LPCTSTR aExtraInfo)\n{\n\treturn FError(aErrorText, aExtraInfo, ErrorPrototype::Value);\n}\n\n__declspec(noinline)\nResultType ResultToken::UnknownMemberError(ExprTokenType &aObject, int aFlags, LPCTSTR aMember)\n{\n\tTCHAR msg[512];\n\tif (!aMember)\n\t\taMember = (aFlags & IT_CALL) ? _T(\"Call\") : _T(\"__Item\");\n\tsntprintf(msg, _countof(msg), _T(\"This value of type \\\"%s\\\" has no %s named \\\"%s\\\".\")\n\t\t, TokenTypeString(aObject), (aFlags & IT_CALL) ? _T(\"method\") : _T(\"property\"), aMember);\n\treturn Error(msg, nullptr, (aFlags & IT_CALL) ? ErrorPrototype::Method : ErrorPrototype::Property);\n}\n\n__declspec(noinline)\nResultType ResultToken::Win32Error(DWORD aError)\n{\n\tif (g_script.Win32Error(aError) == FAIL)\n\t\treturn SetExitResult(FAIL);\n\tSetValue(_T(\"\"), 0);\n\treturn FAIL;\n}\n\n\nvoid TokenTypeAndValue(ExprTokenType &aToken, LPCTSTR &aType, LPCTSTR &aValue, TCHAR *aNBuf)\n{\n\tif (aToken.symbol == SYM_VAR && aToken.var->IsUninitializedNormalVar())\n\t\taType = _T(\"unset variable\"), aValue = aToken.var->mName;\n\telse if (TokenIsEmptyString(aToken))\n\t\taType = _T(\"empty string\"), aValue = _T(\"\");\n\telse\n\t\taType = TokenTypeString(aToken), aValue = TokenToString(aToken, aNBuf);\n}\n\n\n__declspec(noinline)\nResultType TypeError(LPCTSTR aExpectedType, ExprTokenType &aActualValue)\n{\n\tTCHAR number_buf[MAX_NUMBER_SIZE];\n\tLPCTSTR actual_type, value_as_string;\n\tif (aActualValue.symbol == SYM_VAR && aActualValue.var->IsUninitializedNormalVar())\n\t\treturn g_script.VarUnsetError(aActualValue.var);\n\tTokenTypeAndValue(aActualValue, actual_type, value_as_string, number_buf);\n\treturn TypeError(aExpectedType, actual_type, value_as_string);\n}\n\nResultType TypeError(LPCTSTR aExpectedType, LPCTSTR aActualType, LPCTSTR aExtraInfo)\n{\n\tauto an = [](LPCTSTR thing) {\n\t\treturn _tcschr(_T(\"aeiou\"), ctolower(*thing)) ? _T(\"n\") : _T(\"\");\n\t};\n\tTCHAR msg[512];\n\tsntprintf(msg, _countof(msg), _T(\"Expected a%s %s but got a%s %s.\")\n\t\t, an(aExpectedType), aExpectedType, an(aActualType), aActualType);\n\treturn g_script.RuntimeError(msg, aExtraInfo, FAIL_OR_OK, nullptr, ErrorPrototype::Type);\n}\n\nResultType ResultToken::TypeError(LPCTSTR aExpectedType, ExprTokenType &aActualValue)\n{\n\treturn Fail(::TypeError(aExpectedType, aActualValue));\n}\n\nFResult FTypeError(LPCTSTR aExpectedType, ExprTokenType &aActualValue)\n{\n\treturn TypeError(aExpectedType, aActualValue) == OK ? FR_ABORTED : FR_FAIL;\n}\n\n\n__declspec(noinline)\nResultType ParamError(int aIndex, ExprTokenType *aParam, LPCTSTR aExpectedType, LPCTSTR aFunction)\n{\n\tauto an = [](LPCTSTR thing) {\n\t\treturn _tcschr(_T(\"aeiou\"), ctolower(*thing)) ? _T(\"n\") : _T(\"\");\n\t};\n\tTCHAR msg[512];\n\tTCHAR number_buf[MAX_NUMBER_SIZE];\n\tLPCTSTR actual_type, value_as_string;\n#ifdef CONFIG_DEBUGGER\n\tif (!aFunction)\n\t\taFunction = g_Debugger.WhatThrew();\n#endif\n\tif (!aParam || aParam->symbol == SYM_MISSING)\n\t{\n#ifdef CONFIG_DEBUGGER\n\t\tsntprintf(msg, _countof(msg), _T(\"Parameter #%i of %s must not be omitted in this case.\")\n\t\t\t, aIndex + 1, aFunction);\n#else\n\t\tsntprintf(msg, _countof(msg), _T(\"Parameter #%i must not be omitted in this case.\")\n\t\t\t, aIndex + 1);\n#endif\n\t\treturn g_script.RuntimeError(msg, nullptr, FAIL_OR_OK, nullptr, ErrorPrototype::Value);\n\t}\n\tTokenTypeAndValue(*aParam, actual_type, value_as_string, number_buf);\n\tif (!*value_as_string && !aExpectedType)\n\t\tvalue_as_string = actual_type;\n#ifdef CONFIG_DEBUGGER\n\tif (aExpectedType)\n\t\tsntprintf(msg, _countof(msg), _T(\"Parameter #%i of %s requires a%s %s, but received a%s %s.\")\n\t\t\t, aIndex + 1, aFunction, an(aExpectedType), aExpectedType, an(actual_type), actual_type);\n\telse\n\t\tsntprintf(msg, _countof(msg), _T(\"Parameter #%i of %s is invalid.\"), aIndex + 1, g_Debugger.WhatThrew());\n#else\n\tif (aExpectedType)\n\t\tsntprintf(msg, _countof(msg), _T(\"Parameter #%i requires a%s %s, but received a%s %s.\")\n\t\t\t, aIndex + 1, an(aExpectedType), aExpectedType, an(actual_type), actual_type);\n\telse\n\t\tsntprintf(msg, _countof(msg), _T(\"Parameter #%i invalid.\"), aIndex + 1);\n#endif\n\treturn g_script.RuntimeError(msg, value_as_string, FAIL_OR_OK, nullptr\n\t\t, aExpectedType ? ErrorPrototype::Type : ErrorPrototype::Value);\n}\n\n__declspec(noinline)\nResultType ResultToken::ParamError(int aIndex, ExprTokenType *aParam)\n{\n\treturn Fail(::ParamError(aIndex, aParam, nullptr, nullptr));\n}\n\n__declspec(noinline)\nResultType ResultToken::ParamError(int aIndex, ExprTokenType *aParam, LPCTSTR aExpectedType)\n{\n\treturn Fail(::ParamError(aIndex, aParam, aExpectedType, nullptr));\n}\n\n__declspec(noinline)\nResultType ResultToken::ParamError(int aIndex, ExprTokenType *aParam, LPCTSTR aExpectedType, LPCTSTR aFunction)\n{\n\treturn Fail(::ParamError(aIndex, aParam, aExpectedType, aFunction));\n}\n\nFResult FParamError(int aIndex, ExprTokenType *aParam, LPCTSTR aExpectedType)\n{\n\treturn ::ParamError(aIndex, aParam, aExpectedType, nullptr) == OK ? FR_ABORTED : FR_FAIL;\n}\n\n\n\nResultType FResultToError(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount, FResult aResult, int aFirstParam)\n{\n\tif (aResult & FR_OUR_FLAG)\n\t{\n\t\tif (aResult & FR_INT_FLAG)\n\t\t{\n\t\t\t// This is a bit of a hack and should probably be revised.\n\t\t\tTCHAR buf[12];\n\t\t\treturn aResultToken.Error(ERR_FAILED, _itot(FR_GET_THROWN_INT(aResult), buf, 10));\n\t\t}\n\t\tauto code = HRESULT_CODE(aResult);\n\t\tswitch (HRESULT_FACILITY(aResult))\n\t\t{\n\t\tcase FR_FACILITY_CONTROL:\n\t\t\tASSERT(!code);\n\t\t\treturn aResultToken.SetExitResult(FAIL);\n\t\tcase FR_FACILITY_ARG:\n\t\t\tif (aResult == FR_E_ARGS)\n\t\t\t\treturn aResultToken.Error(ERR_PARAM_INVALID);\n\t\t\treturn aResultToken.ParamError(code, code + aFirstParam < aParamCount ? aParam[code + aFirstParam] : nullptr);\n\t\tcase FACILITY_WIN32:\n\t\t\tif (!code)\n\t\t\t\tcode = GetLastError();\n\t\t\treturn aResultToken.Win32Error(code);\n#ifndef _DEBUG\n\t\tdefault: // Using a default case may slightly reduce code size.\n#endif\n\t\tcase FR_FACILITY_ERR:\n\t\t\tswitch (code)\n\t\t\t{\n\t\t\tcase HRESULT_CODE(FR_E_OUTOFMEM):\n\t\t\t\treturn aResultToken.MemoryError();\n\t\t\t}\n\t\t}\n\t\tASSERT(aResult == FR_E_FAILED); // Alert for any unhandled error codes in debug mode.\n\t\treturn aResultToken.Error(ERR_FAILED);\n\t}\n\telse // Presumably a HRESULT error value.\n\t{\n\t\treturn aResultToken.Win32Error(aResult);\n\t}\n}\n\n\n\n__declspec(noinline)\nResultType Script::UnhandledException(Line* aLine, ResultType aErrorType)\n{\n\tglobal_struct &g = *::g;\n\t\n\tResultToken *token = g.ThrownToken;\n\t// Clear ThrownToken to allow any applicable callbacks to execute correctly.\n\t// This includes OnError callbacks explicitly called below, but also COM events\n\t// and CallbackCreate callbacks that execute while MsgBox() is waiting.\n\tg.ThrownToken = NULL;\n\t\n#ifdef CONFIG_DEBUGGER\n\tif (g.ExcptMode & EXCPTMODE_DEBUGGER)\n\t{\n\t\tFreeExceptionToken(token);\n\t\treturn FAIL;\n\t}\n#endif\n\t\n\t// OnError: Allow the script to handle it via a global callback.\n\tstatic bool sOnErrorRunning = false;\n\tif (mOnError.Count() && !sOnErrorRunning)\n\t{\n\t\t__int64 retval;\n\t\tsOnErrorRunning = true;\n\t\tExprTokenType param[2];\n\t\tparam[0].CopyValueFrom(*token);\n\t\tparam[1].SetValue(aErrorType == CRITICAL_ERROR ? _T(\"ExitApp\")\n\t\t\t: aErrorType == FAIL_OR_OK ? _T(\"Return\") : _T(\"Exit\"));\n\t\tmOnError.Call(param, 2, INT_MAX, &retval);\n\t\tsOnErrorRunning = false;\n\t\tif (g.ThrownToken) // An exception was thrown by the callback.\n\t\t{\n\t\t\t// UnhandledException() has already been called recursively for g.ThrownToken,\n\t\t\t// so don't show a second error message. This allows `throw param1` to mean\n\t\t\t// \"abort all OnError callbacks and show default message now\".\n\t\t\tFreeExceptionToken(token);\n\t\t\treturn FAIL;\n\t\t}\n\t\tif (retval < 0 && aErrorType == FAIL_OR_OK)\n\t\t{\n\t\t\tFreeExceptionToken(token);\n\t\t\treturn OK; // Ignore error and continue.\n\t\t}\n\t\t// Some callers rely on g.ThrownToken!=NULL to unwind the stack, so it is restored\n\t\t// rather than freeing it immediately. If the exception object has __Delete, it\n\t\t// will be called after the stack unwinds.\n\t\tif (retval)\n\t\t{\n\t\t\tg.ThrownToken = token;\n\t\t\treturn FAIL; // Exit thread.\n\t\t}\n\t}\n\t\n#ifdef CONFIG_DLL\n\tif (LibNotifyProblem(*token))\n\t{\n\t\tg.ThrownToken = token; // See comments above.\n\t\treturn FAIL;\n\t}\n#endif\n\n\tif (ShowError(aLine, aErrorType, token) == OK)\n\t{\n\t\tFreeExceptionToken(token);\n\t\treturn OK;\n\t}\n\tg.ThrownToken = token;\n\treturn FAIL;\n}\n\n\n\nResultType Script::ShowError(Line* aLine, ResultType aErrorType, ExprTokenType *token)\n{\n\tLPCTSTR message = _T(\"\"), extra = _T(\"\");\n\tTCHAR extra_buf[MAX_NUMBER_SIZE], message_buf[MAX_NUMBER_SIZE];\n\t\n\tObject *ex = dynamic_cast<Object *>(TokenToObject(*token));\n\tif (ex)\n\t{\n\t\t// For simplicity and safety, we call into the Object directly rather than via Invoke().\n\t\tExprTokenType t;\n\t\tif (ex->GetOwnProp(t, _T(\"Message\")))\n\t\t\tmessage = TokenToString(t, message_buf);\n\t\tif (ex->GetOwnProp(t, _T(\"Extra\")))\n\t\t\textra = TokenToString(t, extra_buf);\n\t\tLPCTSTR file = ex->GetOwnPropString(_T(\"File\"));\n\t\tLineNumberType line_no = (LineNumberType)ex->GetOwnPropInt64(_T(\"Line\"));\n\t\tif (file && *file && line_no)\n\t\t{\n\t\t\t// Locate the line by number and file index, then display that line instead\n\t\t\t// of the caller supplied one since it's probably more relevant.\n\t\t\tint file_index;\n\t\t\tfor (file_index = 0; file_index < Line::sSourceFileCount; ++file_index)\n\t\t\t\tif (!_tcsicmp(file, Line::sSourceFile[file_index]))\n\t\t\t\t\tbreak;\n\t\t\tif (!aLine || aLine->mFileIndex != file_index || aLine->mLineNumber != line_no) // Keep aLine if it matches, in case of multiple Lines with the same number.\n\t\t\t{\n\t\t\t\tLine *line = nullptr;\n\t\t\t\tfor (auto mod = mLastModule; mod; mod = mod->mPrev)\n\t\t\t\tfor (line = mod->mFirstLine;\n\t\t\t\t\tline && (line->mLineNumber != line_no || line->mFileIndex != file_index\n\t\t\t\t\t\t|| !line->mArgc && line->mNextLine && line->mNextLine->mLineNumber == line_no); // Skip any same-line block-begin/end, try, else or finally.\n\t\t\t\t\tline = line->mNextLine);\n\t\t\t\tif (line)\n\t\t\t\t\taLine = line;\n\t\t\t}\n\t\t}\n\t}\n\telse\n\t{\n\t\t// Assume it's a string or number.\n\t\textra = TokenToString(*token, message_buf);\n\t}\n\n\t// If message is empty (or a string or number was thrown), display a default message for clarity.\n\tif (!*message)\n\t\tmessage = _T(\"Unhandled exception.\");\n\n\treturn ShowError(message, aErrorType, extra, aLine, ex);\n}\n\n\n\nvoid Object::Error_Show(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tResultType type = FAIL_OR_OK;\n\tif (aParamCount && aParam[0]->symbol != SYM_MISSING)\n\t{\n\t\tstatic LPCTSTR sKindName[] { _T(\"Return\"), _T(\"Exit\"), _T(\"ExitApp\"), _T(\"Warn\") };\n\t\tstatic ResultType sKindType[] { FAIL_OR_OK, FAIL, CRITICAL_ERROR, WARN };\n\t\tauto kind = TokenToString(*aParam[0]);\n\t\tfor (int i = 0;; ++i)\n\t\t{\n\t\t\tif (i == _countof(sKindName))\n\t\t\t\t_f_throw_param(0);\n\t\t\tif (!_tcsicmp(kind, sKindName[i]))\n\t\t\t{\n\t\t\t\ttype = sKindType[i];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\tExprTokenType t_this(this);\n\t_o_return(g_script.ShowError(nullptr, type, &t_this) == OK ? -1 : 1);\n}\n\n\n\nvoid Script::FreeExceptionToken(ResultToken*& aToken)\n{\n\t// Release any potential content the token may hold\n\taToken->Free();\n\t// Free the token itself.\n\tdelete aToken;\n\t// Clear caller's variable.\n\taToken = NULL;\n}\n\n\n\nbool Line::CatchThis(ExprTokenType &aThrown) // ACT_CATCH\n{\n\tauto args = (CatchStatementArgs *)mAttribute;\n\tif (!args || !args->prototype_count)\n\t\treturn Object::HasBase(aThrown, ErrorPrototype::Error);\n\tfor (int i = 0; i < args->prototype_count; ++i)\n\t\tif (Object::HasBase(aThrown, args->prototype[i]))\n\t\t\treturn true;\n\treturn false;\n}\n\n\n\nvoid Script::ScriptWarning(WarnMode warnMode, LPCTSTR aWarningText, LPCTSTR aExtraInfo, Line *line)\n{\n\tif (!line) line = mCurrLine;\n\tint fileIndex = line ? line->mFileIndex : mCurrFileIndex;\n\tFileIndexType lineNumber = line ? line->mLineNumber : mCombinedLineNumber;\n\t\n#ifdef CONFIG_DLL\n\tif (LibNotifyProblem(aWarningText, aExtraInfo, line, true))\n\t\treturn;\n#endif\n\t\n\tif (warnMode == WARNMODE_ON)\n\t\twarnMode = g_WarnMode;\n\tif (warnMode == WARNMODE_OFF)\n\t\treturn;\n\n\tTCHAR buf[MSGBOX_TEXT_SIZE];\n\tauto n = FormatStdErr(buf, _countof(buf), aWarningText, aExtraInfo, fileIndex, lineNumber, true);\n\n\tif (warnMode == WARNMODE_STDOUT)\n\t\tPrintErrorStdOut(buf, n);\n\telse\n#ifdef CONFIG_DEBUGGER\n\tif (!g_Debugger.OutputStdErr(buf))\n#endif\n\t\tOutputDebugString(buf);\n\n\t// In MsgBox mode, MsgBox is in addition to OutputDebug\n\tif (warnMode == WARNMODE_MSGBOX)\n\t{\n\t\tg_script.ShowError(aWarningText, WARN, aExtraInfo, line);\n\t}\n}\n\n\n\nvoid Script::WarnUnassignedVar(Var *var, Line *aLine)\n{\n\tauto warnMode = mCurrentModule->Warn_VarUnset;\n\tif (!warnMode)\n\t\treturn;\n\n\t// Currently only the first reference to each var generates a warning even when using\n\t// StdOut/OutputDebug. MarkAlreadyWarned() is also used to suppress warnings for any\n\t// var which is checked with IsSet().\n\t//if (warnMode == WARNMODE_MSGBOX)\n\t{\n\t\t// The following check uses a flag separate to IsAssignedSomewhere() because setting\n\t\t// that one for the purpose of preventing multiple MsgBoxes would cause other callers\n\t\t// of IsAssignedSomewhere() to get the wrong result if a MsgBox has been shown.\n\t\tif (var->HasAlreadyWarned())\n\t\t\treturn;\n\t\tvar->MarkAlreadyWarned();\n\t}\n\n\t// No check for a global variable is done because var is unassigned and therefore should\n\t// have resolved to a global if there was one, unless it was declared local.\n\tTCHAR buf[1024];\n\tsntprintf(buf, _countof(buf), _T(\"This %s appears to never be assigned a value.\"), Var::DeclarationType(var->Scope()));\n\tScriptWarning(warnMode, buf, var->mName, aLine);\n}\n\n\n\nResultType Script::VarUnsetError(Var *var)\n{\n\tTCHAR buf[1024];\n\tbool isUndeclaredLocal = (var->Scope() & (VAR_LOCAL | VAR_DECLARED)) == VAR_LOCAL;\n\tbool sameNameAsGlobal = isUndeclaredLocal && FindGlobalVar(var->mName);\n\tsntprintf(buf, _countof(buf), _T(\"This %s has not been assigned a value.%s\"), Var::DeclarationType(var->Scope())\n\t\t, sameNameAsGlobal ? _T(\"\\nA global declaration inside the function may be required.\") : _T(\"\"));\n\treturn RuntimeError(buf, var->mName, FAIL_OR_OK, nullptr, ErrorPrototype::Unset);\n}\n\n\n\nvoid Script::WarnLocalSameAsGlobal(LPCTSTR aVarName)\n// Relies on the following pre-conditions:\n// 1) It is an implicit (not declared) variable.\n// 2) Caller has verified that a global variable exists with the same name.\n// 3) g->CurrentFunc->mModule->Warn_LocalSameAsGlobal is on (true).\n// 4) g->CurrentFunc is the function which contains this variable.\n{\n\tTCHAR buf[DIALOG_TITLE_SIZE];\n\tsntprintf(buf, _countof(buf), _T(\"%s (in function %s)\"), aVarName, g->CurrentFunc->mName);\n\tScriptWarning(g->CurrentFunc->mModule->Warn_LocalSameAsGlobal, WARNING_LOCAL_SAME_AS_GLOBAL, buf);\n}\n"},"size":{"kind":"number","value":45549,"string":"45,549"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1216,"string":"1,216"},"avg_line_length":{"kind":"number","value":34.859375,"string":"34.859375"},"max_line_length":{"kind":"number","value":159,"string":"159"},"alphanum_fraction":{"kind":"number","value":0.7263148353764927,"string":"0.726315"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11080,"cells":{"id":{"kind":"number","value":16068,"string":"16,068"},"file_name":{"kind":"string","value":"script.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"script.h\"\n#include \"script_gui.h\"\n#include \"globaldata.h\" // for a lot of things\n#include \"util.h\" // for strlcpy() etc.\n#include \"window.h\" // for a lot of things\n#include \"application.h\" // for MsgSleep()\n#include \"TextIO.h\"\n\n#define NA MAX_FUNCTION_PARAMS\n#define BIFn(name, minp, maxp, bif, ...) {_T(#name), bif, minp, maxp, FID_##name, __VA_ARGS__}\n#define BIFi(name, minp, maxp, bif, id, ...) {_T(#name), bif, minp, maxp, id, __VA_ARGS__}\n#define BIF1(name, minp, maxp, ...) {_T(#name), BIF_##name, minp, maxp, 0, __VA_ARGS__}\n// The following array defines all built-in functions, their min and max parameter counts,\n// and which real C++ function contains their implementation. The macros above are used to\n// reduce repetition and implement code-sharing: BIFs which share a C++ function are assigned\n// an integer ID, defined in the BuiltInFunctionID enum. Items must be in alphabetical order.\nFuncEntry g_BIF[] =\n{\n\tBIF1(Abs, 1, 1),\n\tBIFn(ACos, 1, 1, BIF_ASinACos),\n\tBIFn(ASin, 1, 1, BIF_ASinACos),\n\tBIF1(ATan, 1, 1),\n\tBIF1(ATan2, 2, 2),\n\tBIFn(Ceil, 1, 1, BIF_FloorCeil),\n\tBIF1(Chr, 1, 1),\n\tBIF1(Click, 0, 6),\n#ifdef ENABLE_DLLCALL\n\tBIFn(ComCall, 2, NA, BIF_DllCall),\n#endif\n\tBIF1(ComObjActive, 1, 1),\n\tBIF1(ComObjConnect, 1, 2),\n\tBIF1(ComObjFlags, 1, 3),\n\tBIFi(ComObjFromPtr, 1, 1, BIF_ComObj, 0),\n\tBIF1(ComObjGet, 1, 1),\n\tBIF1(ComObjQuery, 2, 3),\n\tBIF1(ComObjType, 1, 2),\n\tBIF1(ComObjValue, 1, 1),\n\tBIF1(Cos, 1, 1),\n#ifdef ENABLE_DLLCALL\n\tBIFn(DllCall, 1, NA, BIF_DllCall),\n#endif\n\tBIF1(Exp, 1, 1),\n\tBIF1(FileOpen, 2, 3),\n\tBIFn(Floor, 1, 1, BIF_FloorCeil),\n\tBIF1(Format, 1, NA),\n\tBIF1(FormatTime, 0, 2),\n\tBIFn(GetMethod, 1, 3, BIF_GetMethod),\n\tBIF1(HasBase, 2, 2),\n\tBIFn(HasMethod, 1, 3, BIF_GetMethod),\n\tBIF1(HasProp, 2, 2),\n\tBIF1(InStr, 2, 5),\n\tBIFi(IsAlnum, 1, 2, BIF_IsTypeish, VAR_TYPE_ALNUM),\n\tBIFi(IsAlpha, 1, 2, BIF_IsTypeish, VAR_TYPE_ALPHA),\n\tBIFi(IsDigit, 1, 1, BIF_IsTypeish, VAR_TYPE_DIGIT),\n\tBIFi(IsFloat, 1, 1, BIF_IsTypeish, VAR_TYPE_FLOAT),\n\tBIFi(IsInteger, 1, 1, BIF_IsTypeish, VAR_TYPE_INTEGER),\n\tBIFi(IsLower, 1, 2, BIF_IsTypeish, VAR_TYPE_LOWER),\n\tBIFi(IsNumber, 1, 1, BIF_IsTypeish, VAR_TYPE_NUMBER),\n\tBIF1(IsObject, 1, 1),\n\tBIFi(IsSetRef, 1, 1, BIF_IsSet, 0, {1}),\n\tBIFi(IsSpace, 1, 1, BIF_IsTypeish, VAR_TYPE_SPACE),\n\tBIFi(IsTime, 1, 1, BIF_IsTypeish, VAR_TYPE_TIME),\n\tBIFi(IsUpper, 1, 2, BIF_IsTypeish, VAR_TYPE_UPPER),\n\tBIFi(IsXDigit, 1, 1, BIF_IsTypeish, VAR_TYPE_XDIGIT),\n\tBIFn(Ln, 1, 1, BIF_SqrtLogLn),\n\tBIFn(Log, 1, 1, BIF_SqrtLogLn),\n\tBIFn(LTrim, 1, 2, BIF_Trim),\n\tBIFn(Max, 1, NA, BIF_MinMax),\n\tBIFn(Min, 1, NA, BIF_MinMax),\n\tBIF1(Mod, 2, 2),\n\tBIF1(NumGet, 2, 3),\n\tBIF1(NumPut, 3, NA),\n\tBIFn(ObjAddRef, 1, 1, BIF_ObjAddRefRelease),\n\tBIF1(ObjBindMethod, 1, NA),\n\tBIFn(ObjFromPtr, 1, 1, BIF_ObjPtr),\n\tBIFn(ObjFromPtrAddRef, 1, 1, BIF_ObjPtr),\n\tBIFn(ObjGetBase, 1, 1, BIF_Base),\n\tBIFn(ObjGetCapacity, 1, 1, BIF_ObjXXX),\n\tBIFn(ObjHasOwnProp, 2, 2, BIF_ObjXXX),\n\tBIFn(ObjOwnPropCount, 1, 1, BIF_ObjXXX),\n\tBIFn(ObjOwnProps, 1, 1, BIF_ObjXXX),\n\tBIFn(ObjPtr, 1, 1, BIF_ObjPtr),\n\tBIFn(ObjPtrAddRef, 1, 1, BIF_ObjPtr),\n\tBIFn(ObjRelease, 1, 1, BIF_ObjAddRefRelease),\n\tBIFn(ObjSetBase, 2, 2, BIF_Base),\n\tBIFn(ObjSetCapacity, 2, 2, BIF_ObjXXX),\n\tBIF1(Ord, 1, 1),\n\tBIF1(Random, 0, 2),\n\tBIFn(RegCreateKey, 0, 1, BIF_Reg),\n\tBIFn(RegDelete, 0, 2, BIF_Reg),\n\tBIFn(RegDeleteKey, 0, 1, BIF_Reg),\n\tBIFn(RegRead, 0, 3, BIF_Reg),\n\tBIFn(RegWrite, 0, 4, BIF_Reg),\n\tBIF1(Round, 1, 2),\n\tBIFn(RTrim, 1, 2, BIF_Trim),\n\tBIF1(Sin, 1, 1),\n\tBIF1(Sort, 1, 3),\n\tBIFn(SoundGetInterface, 1, 3, BIF_Sound),\n\tBIFn(SoundGetMute, 0, 2, BIF_Sound),\n\tBIFn(SoundGetName, 0, 2, BIF_Sound),\n\tBIFn(SoundGetVolume, 0, 2, BIF_Sound),\n\tBIFn(SoundSetMute, 1, 3, BIF_Sound),\n\tBIFn(SoundSetVolume, 1, 3, BIF_Sound),\n\tBIFn(Sqrt, 1, 1, BIF_SqrtLogLn),\n\tBIF1(StrCompare, 2, 3),\n\tBIFn(StrGet, 1, 3, BIF_StrGetPut),\n\tBIF1(StrLen, 1, 1),\n\tBIFn(StrLower, 1, 1, BIF_StrCase),\n\tBIF1(StrPtr, 1, 1),\n\tBIFn(StrPut, 1, 4, BIF_StrGetPut),\n\tBIFn(StrTitle, 1, 1, BIF_StrCase),\n\tBIF1(StructFromPtr, 2, 2),\n\tBIFn(StrUpper, 1, 1, BIF_StrCase),\n\tBIF1(SubStr, 2, 3),\n\tBIF1(Tan, 1, 1),\n\tBIF1(Throw, 0, NA),\n\tBIFn(Trim, 1, 2, BIF_Trim),\n\tBIF1(Type, 1, 1),\n\tBIF1(VarSetStrCapacity, 1, 2, {1}),\n\tBIF1(VerCompare, 2, 2),\n\tBIFn(WinActive, 0, 4, BIF_WinExistActive),\n\tBIFn(WinExist, 0, 4, BIF_WinExistActive),\n};\n#undef NA\n#undef BIFn\n#undef BIF1\n\n\n#define A_x(name, fn) { _T(#name), fn, NULL }\n#define A_(name) A_x(name, BIV_##name)\n#define A_wx(name, fnget, fnset) { _T(#name), fnget, fnset }\n#define A_w(name) A_wx(name, BIV_##name, BIV_##name##_Set)\n// IMPORTANT: The following array must be kept in alphabetical order\n// for binary search to work. See Script::GetBuiltInVar for further comments.\n// g_BIV_A: All built-in vars beginning with \"A_\". The prefix is omitted from each\n// name to reduce code size and speed up the comparisons.\nVarEntry g_BIV_A[] =\n{\n\tA_(AhkPath),\n\tA_(AhkVersion),\n\tA_w(AllowMainWindow),\n\tA_x(AppData, BIV_SpecialFolderPath),\n\tA_x(AppDataCommon, BIV_SpecialFolderPath),\n\tA_w(Clipboard),\n\tA_x(ComputerName, BIV_UserName_ComputerName),\n\tA_(ComSpec),\n\tA_wx(ControlDelay, BIV_xDelay, BIV_xDelay_Set),\n\tA_wx(CoordModeCaret, BIV_CoordMode, BIV_CoordMode_Set),\n\tA_wx(CoordModeMenu, BIV_CoordMode, BIV_CoordMode_Set),\n\tA_wx(CoordModeMouse, BIV_CoordMode, BIV_CoordMode_Set),\n\tA_wx(CoordModePixel, BIV_CoordMode, BIV_CoordMode_Set),\n\tA_wx(CoordModeToolTip, BIV_CoordMode, BIV_CoordMode_Set),\n\tA_(Cursor),\n\tA_x(DD, BIV_DateTime),\n\tA_x(DDD, BIV_MMM_DDD),\n\tA_x(DDDD, BIV_MMM_DDD),\n\tA_w(DefaultMouseSpeed),\n\tA_x(Desktop, BIV_SpecialFolderPath),\n\tA_x(DesktopCommon, BIV_SpecialFolderPath),\n\tA_w(DetectHiddenText),\n\tA_w(DetectHiddenWindows),\n\tA_(EndChar),\n\tA_w(EventInfo),\n\tA_w(FileEncoding),\n\tA_(HotIf),\n\tA_wx(HotkeyInterval, BIV_Hotkey, BIV_Hotkey_Set),\n\tA_wx(HotkeyModifierTimeout, BIV_Hotkey, BIV_Hotkey_Set),\n\tA_x(Hour, BIV_DateTime),\n\tA_(IconFile),\n\tA_w(IconHidden),\n\tA_(IconNumber),\n\tA_w(IconTip),\n\tA_wx(Index, BIV_LoopIndex, BIV_LoopIndex_Set),\n\tA_(InitialWorkingDir),\n\tA_(Is64bitOS),\n\tA_(IsAdmin),\n\tA_(IsCompiled),\n\tA_(IsCritical),\n\tA_(IsPaused),\n\tA_(IsSuspended),\n\tA_(KeybdHookInstalled),\n\tA_wx(KeyDelay, BIV_xDelay, BIV_xDelay_Set),\n\tA_wx(KeyDelayPlay, BIV_xDelay, BIV_xDelay_Set),\n\tA_wx(KeyDuration, BIV_xDelay, BIV_xDelay_Set),\n\tA_wx(KeyDurationPlay, BIV_xDelay, BIV_xDelay_Set),\n\tA_(Language),\n\tA_w(LastError),\n\tA_(LineFile),\n\tA_(LineNumber),\n\tA_w(ListLines),\n\tA_(LoopField),\n\tA_(LoopFileAttrib),\n\tA_(LoopFileDir),\n\tA_(LoopFileExt),\n\tA_(LoopFileFullPath),\n\tA_x(LoopFileName, BIV_LoopFileName),\n\tA_(LoopFilePath),\n\tA_x(LoopFileShortName, BIV_LoopFileName),\n\tA_(LoopFileShortPath),\n\tA_x(LoopFileSize, BIV_LoopFileSize),\n\tA_x(LoopFileSizeKB, BIV_LoopFileSize),\n\tA_x(LoopFileSizeMB, BIV_LoopFileSize),\n\tA_x(LoopFileTimeAccessed, BIV_LoopFileTime),\n\tA_x(LoopFileTimeCreated, BIV_LoopFileTime),\n\tA_x(LoopFileTimeModified, BIV_LoopFileTime),\n\tA_(LoopReadLine),\n\tA_(LoopRegKey),\n\tA_(LoopRegName),\n\tA_(LoopRegTimeModified),\n\tA_(LoopRegType),\n\tA_wx(MaxHotkeysPerInterval, BIV_Hotkey, BIV_Hotkey_Set),\n\tA_x(MDay, BIV_DateTime),\n\tA_w(MenuMaskKey),\n\tA_x(Min, BIV_DateTime),\n\tA_x(MM, BIV_DateTime),\n\tA_x(MMM, BIV_MMM_DDD),\n\tA_x(MMMM, BIV_MMM_DDD),\n\tA_x(Mon, BIV_DateTime),\n\tA_wx(MouseDelay, BIV_xDelay, BIV_xDelay_Set),\n\tA_wx(MouseDelayPlay, BIV_xDelay, BIV_xDelay_Set),\n\tA_(MouseHookInstalled),\n\tA_x(MSec, BIV_DateTime),\n\tA_(MyDocuments),\n\tA_x(Now, BIV_Now),\n\tA_x(NowUTC, BIV_Now),\n\tA_(OSVersion),\n\tA_(PriorHotkey),\n\tA_(PriorKey),\n\tA_x(ProgramFiles, BIV_SpecialFolderPath),\n\tA_x(Programs, BIV_SpecialFolderPath),\n\tA_x(ProgramsCommon, BIV_SpecialFolderPath),\n\tA_(PtrSize),\n\tA_w(RegView),\n\tA_(ScreenDPI),\n\tA_x(ScreenHeight, BIV_ScreenWidth_Height),\n\tA_x(ScreenWidth, BIV_ScreenWidth_Height),\n\tA_(ScriptDir),\n\tA_(ScriptFullPath),\n\tA_(ScriptHwnd),\n\tA_w(ScriptName),\n\tA_x(Sec, BIV_DateTime),\n\tA_w(SendLevel),\n\tA_w(SendMode),\n\tA_x(Space, BIV_Space_Tab),\n\tA_x(StartMenu, BIV_SpecialFolderPath),\n\tA_x(StartMenuCommon, BIV_SpecialFolderPath),\n\tA_x(Startup, BIV_SpecialFolderPath),\n\tA_x(StartupCommon, BIV_SpecialFolderPath),\n\tA_w(StoreCapsLockMode),\n\tA_x(Tab, BIV_Space_Tab),\n\tA_(Temp), // Debatably should be A_TempDir, but brevity seemed more popular with users, perhaps for heavy uses of the temp folder.,\n\tA_(ThisFunc),\n\tA_(ThisHotkey),\n\tA_(TickCount),\n\tA_x(TimeIdle, BIV_TimeIdle),\n\tA_x(TimeIdleKeyboard, BIV_TimeIdle),\n\tA_x(TimeIdleMouse, BIV_TimeIdle),\n\tA_x(TimeIdlePhysical, BIV_TimeIdle),\n\tA_(TimeSincePriorHotkey),\n\tA_(TimeSinceThisHotkey),\n\tA_w(TitleMatchMode),\n\tA_wx(TitleMatchModeSpeed, BIV_TitleMatchModeSpeed, BIV_TitleMatchMode_Set),\n\tA_(TrayMenu),\n\tA_x(UserName, BIV_UserName_ComputerName),\n\tA_x(WDay, BIV_DateTime),\n\tA_wx(WinDelay, BIV_xDelay, BIV_xDelay_Set),\n\tA_(WinDir),\n\tA_w(WorkingDir),\n\tA_x(YDay, BIV_DateTime),\n\tA_x(Year, BIV_DateTime),\n\tA_x(YWeek, BIV_DateTime),\n\tA_x(YYYY, BIV_DateTime)\n};\n#undef A_\n#undef A_x\n#undef A_w\n#undef A_wx\n#undef VF\n\n\n// General note about the methods in here:\n// Want to be able to support multiple simultaneous points of execution\n// because more than one subroutine can be executing simultaneously\n// (well, more precisely, there can be more than one script subroutine\n// that's in a \"currently running\" state, even though all such subroutines,\n// except for the most recent one, are suspended. So keep this in mind when\n// using things such as static data members or static local variables.\n\n\nScript::Script()\n\t: mFirstLine(NULL), mLastLine(NULL), mCurrLine(NULL)\n\t, mThisHotkeyName(_T(\"\")), mPriorHotkeyName(_T(\"\")), mThisHotkeyStartTime(0), mPriorHotkeyStartTime(0)\n\t, mEndChar(0), mThisHotkeyModifiersLR(0)\n\t, mOnClipboardChangeIsRunning(false)\n\t, mLastLabel(NULL)\n\t, mFirstTimer(NULL), mLastTimer(NULL), mTimerEnabledCount(0), mTimerCount(0)\n\t, mFirstMenu(NULL), mLastMenu(NULL), mMenuCount(0)\n\t, mNextLineIsFunctionBody(false)\n\t, mClassObjectCount(0), mClassProperty(NULL), mClassPropertyDef(NULL)\n\t, mCurrFileIndex(0), mCombinedLineNumber(0)\n\t, mFileSpec(_T(\"\")), mFileDir(_T(\"\")), mFileName(_T(\"\")), mOurEXE(_T(\"\")), mOurEXEDir(_T(\"\")), mMainWindowTitle(_T(\"\"))\n\t, mScriptName(NULL)\n\t, mIsReadyToExecute(false), mAutoExecSectionIsRunning(false)\n\t, mIsRestart(false), mErrorStdOut(false), mErrorStdOutCP(0)\n#ifndef AUTOHOTKEYSC\n\t, mValidateThenExit(false)\n\t, mCmdLineInclude(NULL)\n#endif\n\t, mUninterruptedLineCountMax(1000), mUninterruptibleTime(17)\n\t, mCustomIcon(NULL), mCustomIconSmall(NULL) // Normally NULL unless there's a custom tray icon loaded dynamically.\n\t, mCustomIconFile(NULL), mIconFrozen(false), mTrayIconTip(NULL) // Allocated on first use.\n\t, mCustomIconNumber(0)\n{\n\t// v1.0.25: mLastScriptRest (removed in v2) and mLastPeekTime are now initialized\n\t// right before the auto-exec section of the script is launched, which avoids an\n\t// initial Sleep(10) in ExecUntil that would otherwise occur.\n\tZeroMemory(&mNIC, sizeof(mNIC)); // Constructor initializes this, to be safe.\n\tmNIC.hWnd = NULL; // Set this as an indicator that it tray icon is not installed.\n\n\tmBuiltinModule.mIsBuiltinModule = true;\n\t\n\t// This is done here rather than in Init() because by then CreateRootPrototypes()\n\t// definitely would have already caused functions to be added to the list.\n\tmFuncs.Alloc(100); // Avoid multiple reallocations for simple scripts.\n\n#ifdef _DEBUG\n\tif (ID_FILE_EXIT < ID_MAIN_FIRST) // Not a very thorough check.\n\t\tScriptError(_T(\"DEBUG: ID_FILE_EXIT is too large (conflicts with IDs reserved via ID_USER_FIRST).\"));\n\tif (MAX_CONTROLS_PER_GUI > ID_USER_FIRST - 3)\n\t\tScriptError(_T(\"DEBUG: MAX_CONTROLS_PER_GUI is too large (conflicts with IDs reserved via ID_USER_FIRST).\"));\n\tif (g_ActionCount != ACT_LAST_NAMED_ACTION + 1)\n\t\tScriptError(_T(\"DEBUG: g_act and enum_act are out of sync.\"));\n\tint LargestMaxParams, i;\n\t// Find the Largest value of MaxParams used by any command and make sure it\n\t// isn't something larger than expected by the parsing routines:\n\tfor (LargestMaxParams = i = 0; i < g_ActionCount; ++i)\n\t\tif (g_act[i].MaxParams > LargestMaxParams)\n\t\t\tLargestMaxParams = g_act[i].MaxParams;\n\tif (LargestMaxParams > MAX_ARGS)\n\t\tScriptError(_T(\"DEBUG: At least one command supports more arguments than allowed.\"));\n\tif (sizeof(ActionTypeType) == 1 && g_ActionCount > 256)\n\t\tScriptError(_T(\"DEBUG: Since there are now more than 256 Action Types, the ActionTypeType\")\n\t\t\t_T(\" typedef must be changed.\"));\n\t// Ensure binary-search arrays are sorted correctly:\n\tfor (int i = 1; i < _countof(g_BIF); ++i)\n\t\tif (_tcsicmp(g_BIF[i-1].mName, g_BIF[i].mName) >= 0)\n\t\t\tScriptError(_T(\"DEBUG: g_BIF out of order.\"), g_BIF[i].mName);\n\tfor (int i = 1; i < _countof(g_BIV_A); ++i)\n\t\tif (_tcsicmp(g_BIV_A[i-1].name, g_BIV_A[i].name) >= 0)\n\t\t\tScriptError(_T(\"DEBUG: g_BIV_A out of order.\"), g_BIV_A[i].name);\n#endif\n\tInitializeCriticalSection(&g_CriticalRegExCache); // v1.0.45.04: Must be done early so that it's unconditional, so that DeleteCriticalSection() in the script destructor can also be unconditional.\n\tOleInitialize(NULL);\n}\n\n\n\nScript::~Script() // Destructor.\n{\n\tHotkey::AllDestruct(); // Unregister hooks and hotkeys.\n\n\tif (mNIC.hWnd) // Tray icon is installed.\n\t\tShell_NotifyIcon(NIM_DELETE, &mNIC); // Remove it.\n\n\tif (mOnClipboardChange.Count()) // Remove from viewer chain.\n\t\tEnableClipboardListener(false);\n\n\t// The following fixes being unable to paste text copied from an error dialog after the\n\t// program exits (if it wasn't already pasted at least once), and may similarly be of\n\t// benefit to scripts which directly or indirectly use OLE for clipboard.\n\tOleFlushClipboard();\n\n\t// DestroyWindow() will cause MainWindowProc() to immediately receive and process the\n\t// WM_DESTROY msg, which should in turn result in any child windows being destroyed\n\t// and other cleanup being done:\n\tg_DestroyWindowCalled = true;\n\tDestroyWindow(g_hWnd);\n\n\n\tint i;\n\t// It is safer/easier to destroy the GUI windows prior to the menus (especially the menu bars).\n\t// This is because one GUI window might get destroyed and take with it a menu bar that is still\n\t// in use by an existing GUI window. GuiType::Destroy() adheres to this philosophy by detaching\n\t// its menu bar prior to destroying its window.\n\tGuiType* gui;\n\twhile (gui = g_firstGui) // Destroy any remaining GUI windows (due to e.g. circular references). Also: assignment.\n\t\tgui->Destroy();\n\tfor (i = 0; i < GuiType::sFontCount; ++i) // Now that GUI windows are gone, delete all GUI fonts.\n\t\tif (GuiType::sFont[i].hfont)\n\t\t\tDeleteObject(GuiType::sFont[i].hfont);\n\t// The above might attempt to delete an HFONT from GetStockObject(DEFAULT_GUI_FONT), etc.\n\t// But that should be harmless:\n\t// MSDN: \"It is not necessary (but it is not harmful) to delete stock objects by calling DeleteObject.\"\n\n\t// Above: Probably best to have removed icon from tray and destroyed any Gui windows that were\n\t// using it prior to getting rid of the script's custom icon below:\n\tif (mCustomIcon)\n\t{\n\t\tDestroyIcon(mCustomIcon);\n\t\tDestroyIcon(mCustomIconSmall); // Should always be non-NULL if mCustomIcon is non-NULL.\n\t}\n\n\t// Since they're not associated with a window, we must free the resources for all popup menus.\n\t// Update: Even if a menu is being used as a GUI window's menu bar, see note above for why menu\n\t// destruction is done AFTER the GUI windows are destroyed:\n\tfor (UserMenu *m = mFirstMenu; m; m = m->mNextMenu)\n\t\tm->Dispose();\n\n\t// Since tooltip windows are unowned, they should be destroyed to avoid resource leak:\n\tfor (i = 0; i < MAX_TOOLTIPS; ++i)\n\t\tif (g_hWndToolTip[i] && IsWindow(g_hWndToolTip[i]))\n\t\t\tDestroyWindow(g_hWndToolTip[i]);\n\n\t// Close any open sound item to prevent hang-on-exit in certain operating systems or conditions.\n\t// If there's any chance that a sound was played and not closed out, or that it is still playing,\n\t// this check is done. Otherwise, the check is avoided since it might be a high overhead call,\n\t// especially if the sound subsystem part of the OS is currently swapped out or something:\n\tif (g_SoundWasPlayed)\n\t{\n\t\tTCHAR buf[MAX_PATH * 2]; // See \"MAX_PATH note\" in Line::SoundPlay for comments.\n\t\tmciSendString(_T(\"status \") SOUNDPLAY_ALIAS _T(\" mode\"), buf, _countof(buf), NULL);\n\t\tif (*buf) // \"playing\" or \"stopped\"\n\t\t\tmciSendString(_T(\"close \") SOUNDPLAY_ALIAS, NULL, 0, NULL);\n\t}\n\n#ifdef CONFIG_DLL\n\tUnregisterClass(WINDOW_CLASS_MAIN, g_hInstance);\n\tUnregisterClass(WINDOW_CLASS_GUI, g_hInstance);\n#endif\n\n\tDeleteCriticalSection(&g_CriticalRegExCache); // g_CriticalRegExCache is used elsewhere for thread-safety.\n\tOleUninitialize();\n}\n\n\n\nResultType Script::Init(LPTSTR aScriptFilename, IObject *aArgs)\n// Returns OK or FAIL.\n// Caller has provided an empty string for aScriptFilename if this is a compiled script.\n// Otherwise, aScriptFilename can be NULL if caller hasn't determined the filename of the script yet.\n{\n\tTCHAR buf[UorA(T_MAX_PATH, 2048)]; // Just to make sure we have plenty of room to do things with.\n\tsize_t buf_length;\n\n\t// It may be better to get the module name this way rather than reading it from the registry\n\t// in case the user has moved it to a folder other than the install folder, hasn't installed it,\n\t// or has renamed the EXE file itself.\n\tif (buf_length = GetModuleFileName(NULL, buf, _countof(buf)))\n\t{\n\t\t// Any path longer than MAX_PATH is probably impossible as of 2018 since testing indicates\n\t\t// the program can't start if its path is longer than MAX_PATH-1 even with Windows 10 long\n\t\t// path awareness enabled.\n\t\tif (buf_length == _countof(buf)) // It was truncated.\n\t\t\treturn FAIL; // Seems the safest option for this unlikely case.\n\t\tConvertFilespecToCorrectCase(buf, _countof(buf), buf_length); // Normalize the case for A_AhkPath. This might change the length, e.g. due to expansion of 8.3 filename.\n\t\tmOurEXE = SimpleHeap::Alloc(buf, buf_length);\n\t\tLPTSTR last_backslash = _tcsrchr(buf, '\\\\');\n\t\tif (last_backslash) // Probably always true due to the nature of GetModuleFileName().\n\t\t\tmOurEXEDir = SimpleHeap::Alloc(buf, last_backslash - buf);\n\t}\n\n#ifdef AUTOHOTKEYSC\n\tmKind = ScriptKindResource;\n\t// Fix for v1.0.29: Override the caller's use of __argv[0] by using GetModuleFileName(),\n\t// so that when the script is started from the command line but the user didn't type the\n\t// extension, the extension will be included. This necessary because otherwise\n\t// #SingleInstance wouldn't be able to detect duplicate versions in every case.\n\t// It also provides more consistency.\n\taScriptFilename = buf;\n#else\n#ifdef _DEBUG\n\tif (!aScriptFilename)\n\t\taScriptFilename = _T(\"Test\\\\Test.ahk\");\n#endif\n\tif (!aScriptFilename)\n\t{\n\t\t// Since no script-file was specified on the command line, use the default path,\n\t\t// <EXEDIR>\\<EXENAME>.ahk. This is intended for portable copies of AutoHotkey.\n\t\t// Users of a proper AutoHotkey installation should open .ahk files directly.\n\t\tLPTSTR suffix, dot;\n\t\tif ( (suffix = _tcsrchr(buf, '\\\\')) // Find name part of path.\n\t\t\t&& (dot = _tcsrchr(suffix, '.')) // Find extension part of name.\n\t\t\t&& dot - buf + 5 < _countof(buf) ) // Enough space in buffer?\n\t\t{\n\t\t\t_tcscpy(dot, EXT_AUTOHOTKEY);\n\t\t}\n\t\telse // Very unlikely.\n\t\t\treturn FAIL;\n\n\t\taScriptFilename = buf; // Use the entire path, including the exe's directory.\n\t}\n\tif (*aScriptFilename == '*')\n\t{\n\t\tif (!aScriptFilename[1]) // Read script from stdin.\n\t\t{\n\t\t\tmKind = ScriptKindStdIn;\n\t\t\tbuf[0] = '*';\n\t\t\tbuf[1] = '\\0';\n\t\t\t// Seems best to disable #SingleInstance for stdin scripts.\n\t\t\tg_AllowOnlyOneInstance = SINGLE_INSTANCE_OFF;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tmKind = ScriptKindResource;\n\t\t\tg_AllowMainWindow = false;\n\t\t}\n\t}\n\telse\n\t{\n\t\tmKind = ScriptKindFile;\n\t\tif (aScriptFilename != buf)\n\t\t{\n\t\t\t// In case the script is a relative filespec (relative to current working dir):\n\t\t\tbuf_length = GetFullPathName(aScriptFilename, _countof(buf), buf, NULL); // Succeeds even on nonexistent files.\n\t\t\tif (!buf_length || buf_length >= _countof(buf))\n\t\t\t\treturn FAIL; // Due to rarity, no error msg, just abort.\n\t\t\t// Using the correct case not only makes it look better in title bar & tray tool tip,\n\t\t\t// it also helps with the detection of \"this script already running\" since otherwise\n\t\t\t// it might not find the dupe if the same script name is launched with different\n\t\t\t// lowercase/uppercase letters:\n\t\t\tConvertFilespecToCorrectCase(buf, _countof(buf), buf_length); // This might change the length, e.g. due to expansion of 8.3 filename.\n\t\t}\n\t}\n#endif\n\tmFileSpec = SimpleHeap::Alloc(buf); // The full spec is stored for convenience.\n\tLPTSTR filename_marker;\n\tif (filename_marker = _tcsrchr(buf, '\\\\'))\n\t{\n\t\tmFileDir = SimpleHeap::Alloc(buf, filename_marker - buf);\n\t\t++filename_marker;\n\t}\n\telse\n\t{\n\t\t// There is no slash in \"*\" (i.e. g_RunStdIn). The only other known cause of this\n\t\t// condition is a path being too long for GetFullPathName to expand it into buf,\n\t\t// in which case buf and mFileSpec are now empty, and this will cause LoadFromFile()\n\t\t// to fail and the program to exit.\n\t\tmFileDir = g_WorkingDirOrig;\n\t\tfilename_marker = buf;\n\t}\n\tmFileName = SimpleHeap::Alloc(filename_marker);\n#ifdef AUTOHOTKEYSC\n\t// Omit AutoHotkey from the window title, like AutoIt3 does for its compiled scripts.\n\t// One reason for this is to reduce backlash if evil-doers create viruses and such\n\t// with the program. buf already contains the full path, so no change is needed.\n#else\n\tif (_tcscmp(aScriptFilename, SCRIPT_RESOURCE_SPEC))\n\t\tsntprintfcat(buf, _countof(buf), _T(\" - %s\"), mKind != ScriptKindResource ? T_AHK_NAME_VERSION : aScriptFilename);\n#endif\n\tmMainWindowTitle = SimpleHeap::Alloc(buf);\n\n\t// Up to this point, mCurrentModule == &mBuiltinModule for initialization of built-ins.\n\t// From this point, declarations should add names to a script module, not mBuiltinModule.\n\tmCurrentModule = &mDefaultModule;\n\tmModules.Insert(&mDefaultModule, 0); // __Main\n\tmModules.Insert(&mBuiltinModule, 1); // AHK\n\tASSERT(mModules.mCount == 2);\n\n\tif (aArgs) // Caller-provided command-line args.\n\t{\n\t\tVar *var = g_script.FindOrAddVar(_T(\"A_Args\"), 6, VAR_DECLARE_GLOBAL);\n\t\tif (!var || !var->AssignSkipAddRef(aArgs))\n\t\t\treturn FAIL;\n\t}\n\n\treturn OK;\n}\n\n\t\n\nResultType Script::CreateWindows()\n// Returns OK or FAIL.\n{\n\tif (!mMainWindowTitle || !*mMainWindowTitle) return FAIL; // Init() must be called before this function.\n\t// Register a window class for the main window:\n\tWNDCLASSEX wc = {0};\n\twc.cbSize = sizeof(wc);\n\twc.lpszClassName = WINDOW_CLASS_MAIN;\n\twc.hInstance = g_hInstance;\n\twc.lpfnWndProc = MainWindowProc;\n\t// The following are left at the default of NULL/0 set higher above:\n\t//wc.style = 0; // CS_HREDRAW | CS_VREDRAW\n\t//wc.cbClsExtra = 0;\n\t//wc.cbWndExtra = 0;\n\t// Load the main icon in the two sizes needed throughout the program:\n\tg_IconLarge = ExtractIconFromExecutable(NULL, -IDI_MAIN, 0, 0);\n\tg_IconSmall = ExtractIconFromExecutable(NULL, -IDI_MAIN, GetSystemMetrics(SM_CXSMICON), 0);\n\twc.hIcon = g_IconLarge;\n\twc.hIconSm = g_IconSmall;\n\twc.hCursor = LoadCursor((HINSTANCE) NULL, IDC_ARROW);\n\twc.hbrBackground = (HBRUSH)(COLOR_BTNFACE + 1); // Needed for ProgressBar. Old: (HBRUSH)GetStockObject(WHITE_BRUSH);\n\twc.lpszMenuName = MAKEINTRESOURCE(IDR_MENU_MAIN); // NULL; // \"MainMenu\";\n\tif (!RegisterClassEx(&wc))\n\t{\n\t\tMsgBox(_T(\"RegClass\")); // Short/generic msg since so rare.\n\t\treturn FAIL;\n\t}\n\n\tTCHAR class_name[64];\n\tHWND fore_win = GetForegroundWindow();\n\tbool do_minimize = !fore_win || (GetClassName(fore_win, class_name, _countof(class_name))\n\t\t&& !_tcsicmp(class_name, _T(\"Shell_TrayWnd\"))); // Shell_TrayWnd is the taskbar's class on Win98/XP and probably the others too.\n\n\t// v2: Set the default size to 75% of the primary work area (which seems to be what\n\t// CW_USEDEFAULT does, at least on Windows 11); but limit the default width to the\n\t// total height, so the window won't be ridiculously wide on ultra-wide screens.\n\tRECT work;\n\tSystemParametersInfo(SPI_GETWORKAREA, 0, &work, 0);\n\tint default_width = (work.right - work.left) * 3 / 4;\n\tint default_height = work.bottom - work.top;\n\tif (default_width > default_height)\n\t\tdefault_width = default_height;\n\tdefault_height = default_height * 3 / 4;\n\n\t// Note: the title below must be constructed the same was as is done by our\n\t// WinMain() (so that we can detect whether this script is already running)\n\t// which is why it's standardized in g_script.mMainWindowTitle.\n\t// Create the main window. Prevent momentary disruption of Start Menu, which\n\t// some users understandably don't like, by omitting the taskbar button temporarily.\n\t// This is done because testing shows that minimizing the window further below, even\n\t// though the window is hidden, would otherwise briefly show the taskbar button (or\n\t// at least redraw the taskbar). Sometimes this isn't noticeable, but other times\n\t// (such as when the system is under heavy load) a user reported that it is quite\n\t// noticeable. WS_EX_TOOLWINDOW is used instead of WS_EX_NOACTIVATE because\n\t// WS_EX_NOACTIVATE is available only on 2000/XP.\n\tif ( !(g_hWnd = CreateWindowEx(do_minimize ? WS_EX_TOOLWINDOW : 0\n\t\t, WINDOW_CLASS_MAIN\n\t\t, mMainWindowTitle\n\t\t, WS_OVERLAPPEDWINDOW // Style. Alt: WS_POPUP or maybe 0.\n\t\t, CW_USEDEFAULT // xpos\n\t\t, CW_USEDEFAULT // ypos\n\t\t, default_width // width\n\t\t, default_height // height\n\t\t, NULL // parent window\n\t\t, NULL // Identifies a menu, or specifies a child-window identifier depending on the window style\n\t\t, g_hInstance // passed into WinMain\n\t\t, NULL)) ) // lpParam\n\t{\n\t\tMsgBox(_T(\"CreateWindow\")); // Short msg since so rare.\n\t\treturn FAIL;\n\t}\n\n\t// Now that all static initializers (such as for Object::sPrototype)\n\t// are guaranteed to have been executed, construct the Tray menu.\n\tmTrayMenu = new UserMenu(MENU_TYPE_POPUP);\n\tmTrayMenu->AppendStandardItems();\n\n\t// Stdin scripts leave the menu items enabled, to make it easier to imitate a standard script\n\t// (such as by handling the appropriate WM_COMMAND messages and overriding Reload/Edit).\n\tif (mKind == ScriptKindResource)\n\t{\n\t\tHMENU menu = GetMenu(g_hWnd);\n\t\t// Disable the Edit menu item, since it's not useful without a source file:\n\t\tEnableMenuItem(menu, ID_FILE_EDITSCRIPT, MF_DISABLED | MF_GRAYED);\n\t\tif (!g_AllowMainWindow) // Apply the compiled-script default value.\n\t\t\tEnableOrDisableViewMenuItems(menu, MF_DISABLED | MF_GRAYED);\n\t}\n\n\tif ( !(g_hWndEdit = CreateWindow(_T(\"Edit\"), NULL, WS_CHILD | WS_VISIBLE | WS_BORDER\n\t\t| ES_LEFT | ES_MULTILINE | ES_READONLY | WS_VSCROLL // | WS_HSCROLL (saves space)\n\t\t, 0, 0, 0, 0, g_hWnd, (HMENU)1, g_hInstance, NULL)) )\n\t{\n\t\tMsgBox(_T(\"CreateWindow\")); // Short msg since so rare.\n\t\treturn FAIL;\n\t}\n\t// FONTS: The font used by default, at least on XP, is GetStockObject(SYSTEM_FONT).\n\t// Use something more appealing (monospaced seems preferable):\n\tHDC hdc = GetDC(g_hWndEdit);\n\tg_hFontEdit = CreateFont(FONT_POINT(hdc, 10), 0, 0, 0, 0, 0, 0, 0, 0, 0, 0\n\t\t, DEFAULT_QUALITY, DEFAULT_PITCH | FF_DONTCARE, _T(\"Consolas\"));\n\tReleaseDC(g_hWndEdit, hdc);\n\tSendMessage(g_hWndEdit, WM_SETFONT, (WPARAM)g_hFontEdit, 0);\n\n\t// v1.0.30.05: Specifying a limit of zero opens the control to its maximum text capacity,\n\t// which removes the 32K size restriction. Testing shows that this does not increase the actual\n\t// amount of memory used for controls containing small amounts of text. All it does is allow\n\t// the control to allocate more memory as needed.\n\tSendMessage(g_hWndEdit, EM_LIMITTEXT, 0, 0);\n\n\t// Some of the MSDN docs mention that an app's very first call to ShowWindow() makes that\n\t// function operate in a special mode. Therefore, it seems best to get that first call out\n\t// of the way to avoid the possibility that the first-call behavior will cause problems with\n\t// our normal use of ShowWindow() below and other places. Also, decided to ignore nCmdShow,\n // to avoid any momentary visual effects on startup.\n\t// Update: It's done a second time because the main window might now be visible if the process\n\t// that launched ours specified that. It seems best to override the requested state because\n\t// some calling processes might specify \"maximize\" or \"shownormal\" as generic launch method.\n\t// The script can display it's own main window with ListLines, etc.\n\t// MSDN: \"the nCmdShow value is ignored in the first call to ShowWindow if the program that\n\t// launched the application specifies startup information in the structure. In this case,\n\t// ShowWindow uses the information specified in the STARTUPINFO structure to show the window.\n\t// On subsequent calls, the application must call ShowWindow with nCmdShow set to SW_SHOWDEFAULT\n\t// to use the startup information provided by the program that launched the application.\"\n\tShowWindow(g_hWnd, SW_HIDE);\n\tShowWindow(g_hWnd, SW_HIDE);\n\n\t// Now that the first call to ShowWindow() is out of the way, minimize the main window so that\n\t// if the script is launched from the Start Menu (and perhaps other places such as the\n\t// Quick-launch toolbar), the window that was active before the Start Menu was displayed will\n\t// become active again. But as of v1.0.25.09, this minimize is done more selectively to prevent\n\t// the launch of a script from knocking the user out of a full-screen game or other application\n\t// that would be disrupted by an SW_MINIMIZE:\n\tif (do_minimize)\n\t{\n\t\tShowWindow(g_hWnd, SW_MINIMIZE);\n\t\tSetWindowLong(g_hWnd, GWL_EXSTYLE, 0); // Give the main window back its taskbar button.\n\t}\n\n\tg_hAccelTable = LoadAccelerators(g_hInstance, MAKEINTRESOURCE(IDR_ACCELERATOR1));\n\n\tif (g_NoTrayIcon)\n\t\tmNIC.hWnd = NULL; // Set this as an indicator that tray icon is not installed.\n\telse\n\t\t// Even if the below fails, don't return FAIL in case the user is using a different shell\n\t\t// or something. In other words, it is expected to fail under certain circumstances and\n\t\t// we want to tolerate that:\n\t\tCreateTrayIcon();\n\n\treturn OK;\n}\n\n\n\nvoid Script::EnableClipboardListener(bool aEnable)\n{\n\tstatic bool sEnabled = false;\n\tif (aEnable == sEnabled) // Simplifies BIF_On.\n\t\treturn;\n\tif (aEnable)\n\t\tAddClipboardFormatListener(g_hWnd);\n\telse\n\t\tRemoveClipboardFormatListener(g_hWnd);\n\tsEnabled = aEnable;\n}\n\n\n\nvoid Script::AllowMainWindow(bool aAllow)\n{\n\tif (g_AllowMainWindow == aAllow)\n\t\treturn;\n\tg_AllowMainWindow = aAllow;\n\tEnableOrDisableViewMenuItems(GetMenu(g_hWnd)\n\t\t, aAllow ? MF_ENABLED : MF_DISABLED | MF_GRAYED);\n\tmTrayMenu->EnableStandardOpenItem(aAllow);\n}\n\nvoid Script::EnableOrDisableViewMenuItems(HMENU aMenu, UINT aFlags)\n{\n\tEnableMenuItem(aMenu, ID_VIEW_KEYHISTORY, aFlags);\n\tEnableMenuItem(aMenu, ID_VIEW_LINES, aFlags);\n\tEnableMenuItem(aMenu, ID_VIEW_VARIABLES, aFlags);\n\tEnableMenuItem(aMenu, ID_VIEW_HOTKEYS, aFlags);\n}\n\n\n\nvoid Script::CreateTrayIcon()\n// It is the caller's responsibility to ensure that the previous icon is first freed/destroyed\n// before calling us to install a new one. However, that is probably not needed if the Explorer\n// crashed, since the memory used by the tray icon was probably destroyed along with it.\n{\n\tZeroMemory(&mNIC, sizeof(mNIC)); // To be safe.\n\t// Using NOTIFYICONDATA_V2_SIZE vs. sizeof(NOTIFYICONDATA) improves compatibility with Win9x maybe.\n\t// MSDN: \"Using [NOTIFYICONDATA_V2_SIZE] for cbSize will allow your application to use NOTIFYICONDATA\n\t// with earlier Shell32.dll versions, although without the version 6.0 enhancements.\"\n\t// Update: Using V2 gives an compile error so trying V1. Update: Trying sizeof(NOTIFYICONDATA)\n\t// for compatibility with VC++ 6.x. This is also what AutoIt3 uses:\n\tmNIC.cbSize = sizeof(NOTIFYICONDATA); // NOTIFYICONDATA_V1_SIZE\n\tmNIC.hWnd = g_hWnd;\n\tmNIC.uID = AHK_NOTIFYICON; // This is also used for the ID, see TRANSLATE_AHK_MSG for details.\n\tmNIC.uFlags = NIF_MESSAGE | NIF_TIP | NIF_ICON;\n\tmNIC.uCallbackMessage = AHK_NOTIFYICON;\n\tmNIC.hIcon = mCustomIconSmall ? mCustomIconSmall : g_IconSmall;\n\tUPDATE_TIP_FIELD\n\tif (!Shell_NotifyIcon(NIM_ADD, &mNIC))\n\t\tmNIC.hWnd = NULL; // Set this as an indicator that tray icon is not installed.\n}\n\n\n\nvoid Script::UpdateTrayIcon(bool aForceUpdate)\n{\n\tif (!mNIC.hWnd) // tray icon is not installed\n\t\treturn;\n\tstatic bool icon_shows_paused = false;\n\tstatic bool icon_shows_suspended = false;\n\tif (!aForceUpdate && (mIconFrozen || (g->IsPaused == icon_shows_paused && g_IsSuspended == icon_shows_suspended)))\n\t\treturn; // it's already in the right state\n\tint icon;\n\tif (g->IsPaused && g_IsSuspended)\n\t\ticon = IDI_PAUSE_SUSPEND;\n\telse if (g->IsPaused)\n\t\ticon = IDI_PAUSE;\n\telse if (g_IsSuspended)\n\t\ticon = IDI_SUSPEND;\n\telse\n\t\ticon = IDI_MAIN;\n\t// Use the custom tray icon if the icon is normal (non-paused & non-suspended):\n\tmNIC.hIcon = (mCustomIconSmall && (mIconFrozen || (!g->IsPaused && !g_IsSuspended))) ? mCustomIconSmall // L17: Always use small icon for tray.\n\t\t// For simplicity, g_IconSmall isn't used since it might not match the current tray icon size.\n\t\t//: (icon == IDI_MAIN) ? g_IconSmall // Use the pre-loaded small icon for best quality.\n\t\t: NULL;\n\tif (!mNIC.hIcon)\n\t{\n\t\t// Retrieve the tray icon size each time in case the primary screen's DPI has changed.\n\t\tint cx = GetSystemTrayIconSize();\n\t\t// Use LR_SHARED for simplicity and performance more than to conserve memory in this case.\n\t\t// The documentation says \"This function finds the first image in the cache with the requested\n\t\t// resource name, regardless of the size requested.\" -- but testing (on Windows 11) showed that\n\t\t// in reality, it caches one icon handle per size.\n\t\tmNIC.hIcon = (HICON)LoadImage(g_hInstance, MAKEINTRESOURCE(icon), IMAGE_ICON, cx, cx, LR_SHARED); \n\t}\n\t// NIM_ADD is attempted as a fallback, since NIM_MODIFY can fail if the taskbar was\n\t// recreated or the icon has been deleted by a script calling Shell_NotifyIcon().\n\tif (Shell_NotifyIcon(NIM_MODIFY, &mNIC) || Shell_NotifyIcon(NIM_ADD, &mNIC))\n\t{\n\t\ticon_shows_paused = g->IsPaused;\n\t\ticon_shows_suspended = g_IsSuspended;\n\t}\n\t// else do nothing, just leave it in the same state.\n}\n\n\n\nbif_impl FResult TraySetIcon(optl<StrArg> aIconFile, optl<int> aIconNumber, optl<BOOL> aFreeze)\n{\n\treturn g_script.SetTrayIcon(aIconFile.value_or_null(), aIconNumber.value_or(1)\n\t\t, aFreeze.has_value() ? aFreeze.value() ? TOGGLED_ON : TOGGLED_OFF : NEUTRAL) ? OK : FR_FAIL;\n}\n\nResultType Script::SetTrayIcon(LPCTSTR aIconFile, int aIconNumber, ToggleValueType aFreezeIcon)\n{\n\tbool force_update = false;\n\n\tif (aFreezeIcon != NEUTRAL) // i.e. if it's blank, don't change the current setting of mIconFrozen.\n\t{\n\t\tif (mIconFrozen != (aFreezeIcon == TOGGLED_ON)) // It needs to be toggled.\n\t\t{\n\t\t\tmIconFrozen = !mIconFrozen;\n\t\t\tforce_update = true; // Ensure the icon correctly reflects the current setting and suspend/pause status.\n\t\t}\n\t}\n\t\n\tif (aIconFile && *aIconFile == '*' && !aIconFile[1]) // Restore the standard icon.\n\t{\n\t\tif (mCustomIcon)\n\t\t{\n\t\t\tGuiType::DestroyIconsIfUnused(mCustomIcon, mCustomIconSmall); // v1.0.37.07: Solves reports of Gui windows losing their icons.\n\t\t\t// If the above doesn't destroy the icon, the GUI window(s) still using it are responsible for\n\t\t\t// destroying it later.\n\t\t\tmCustomIcon = NULL; // To indicate that there is no custom icon.\n\t\t\tmCustomIconSmall = NULL;\n\t\t\tfree(mCustomIconFile);\n\t\t\tmCustomIconFile = NULL;\n\t\t\tmCustomIconNumber = 0;\n\t\t\tforce_update = true;\n\t\t}\n\t\taIconFile = nullptr; // Update the icon and return, below.\n\t}\n\t\n\tif (!aIconFile) // No icon specified, or it was already reset to default above.\n\t{\n\t\tif (force_update)\n\t\t\tUpdateTrayIcon(true);\n\t\treturn OK;\n\t}\n\n\t// v1.0.43.03: Load via LoadPicture() vs. ExtractIcon() because ExtractIcon harms the quality\n\t// of 16x16 icons inside .ico files by first scaling them to 32x32 (which then has to be scaled\n\t// back to 16x16 for the tray and for the SysMenu icon). I've visually confirmed that the\n\t// distortion occurs at least when a 16x16 icon is loaded by ExtractIcon() then put into the\n\t// tray. It might not be the scaling itself that distorts the icon: the pixels are all in the\n\t// right places, it's just that some are the wrong color/shade. This implies that some kind of\n\t// unwanted interpolation or color tweaking is being done by ExtractIcon (and probably LoadIcon),\n\t// but not by LoadImage.\n\t// Also, load the icon at actual size so that when/if this icon is used for a GUI window, its\n\t// appearance in the alt-tab menu won't be unexpectedly poor due to having been scaled from its\n\t// native size down to 16x16.\n\t\n\tif (aIconNumber == 0) // Must validate for use in two places below.\n\t\taIconNumber = 1; // Must be != 0 to tell LoadPicture that \"icon must be loaded, never a bitmap\".\n\n\tint image_type;\n\t// L17: For best results, load separate small and large icons.\n\tHICON new_icon_small;\n\tHICON new_icon = NULL; // Initialize to detect failure to load either icon.\n\tHMODULE icon_module = NULL; // Must initialize because it's not always set by LoadPicture().\n\tif (!_tcsnicmp(aIconFile, _T(\"HICON:\"), 6) && aIconFile[6] != '*')\n\t{\n\t\t// Handle this here rather than in LoadPicture() because the first call would destroy the\n\t\t// original icon (due to specifying the width and height), causing the second call to fail.\n\t\t// Keep the original size for both icons since that sometimes produces better results than\n\t\t// CopyImage(), and it keeps the code smaller.\n\t\tnew_icon_small = (HICON)(UINT_PTR)ATOI64(aIconFile + 6);\n\t\tnew_icon = new_icon_small; // DestroyIconsIfUnused() handles this case by calling DestroyIcon() only once.\n\t}\n\telse if ( new_icon_small = (HICON)LoadPicture(aIconFile, GetSystemMetrics(SM_CXSMICON), GetSystemMetrics(SM_CYSMICON), image_type, aIconNumber, false) ) // Called with icon_number > 0, it guarantees return of an HICON/HCURSOR, never an HBITMAP.\n\t\tif ( !(new_icon = (HICON)LoadPicture(aIconFile, GetSystemMetrics(SM_CXICON), GetSystemMetrics(SM_CYICON), image_type, aIconNumber, false, NULL, &icon_module)) )\n\t\t\tDestroyIcon(new_icon_small);\n\tif ( !new_icon )\n\t\treturn g_script.RuntimeError(ERR_LOAD_ICON, aIconFile);\n\n\tSendMessage(g_hWnd, WM_SETICON, ICON_SMALL, (LPARAM)new_icon_small);\n\tSendMessage(g_hWnd, WM_SETICON, ICON_BIG, (LPARAM)new_icon);\n\n\tGuiType::DestroyIconsIfUnused(mCustomIcon, mCustomIconSmall); // This destroys it if non-NULL and it's not used by an GUI windows.\n\n\tmCustomIcon = new_icon;\n\tmCustomIconSmall = new_icon_small;\n\tmCustomIconNumber = aIconNumber;\n\t\n\tTCHAR full_path[MAX_PATH], *filename_marker;\n\t// If the icon was loaded from a DLL, relative->absolute conversion below may produce the\n\t// wrong result (i.e. in the typical case where the DLL is not in the working directory).\n\t// So in that case, get the path of the module which contained the icon (if available).\n\t// Get the full path in case it's a relative path. This is documented and it's done in case\n\t// the script ever changes its working directory:\n\tif ( icon_module && GetModuleFileName(icon_module, full_path, _countof(full_path))\n\t\t|| GetFullPathName(aIconFile, _countof(full_path) - 1, full_path, &filename_marker) )\n\t\taIconFile = full_path;\n\tfree(mCustomIconFile);\n\tmCustomIconFile = _tcsdup(aIconFile); // Failure isn't checked due to rarity and for simplicity; it'll be reported as empty in that case.\n\n\tif (icon_module)\n\t\tFreeLibrary(icon_module);\n\n\tif (!g_NoTrayIcon)\n\t\tUpdateTrayIcon(true); // Need to use true in this case too.\n\treturn OK;\n}\n\n\n\nResultType Script::AutoExecSection()\n// Returns FAIL if can't run due to critical error. Otherwise returns OK.\n{\n\t// Now that g_MaxThreadsTotal has been permanently set by the processing of script directives like\n\t// #MaxThreads, an appropriately sized array can be allocated:\n\tif ( !(g_array = (global_struct *)malloc((g_MaxThreadsTotal+TOTAL_ADDITIONAL_THREADS) * sizeof(global_struct))) )\n\t\treturn FAIL; // Due to rarity, just abort. It wouldn't be safe to run ExitApp() due to possibility of an OnExit function.\n\tCopyMemory(g_array, g, sizeof(global_struct)); // Copy the temporary/startup \"g\" into array[0].\n\tg = g_array; // Must be done after above.\n\n\t// v2: Ensure the Hotkey function defaults to no criterion rather than the last #HotIf WinActive/Exist(). Alternatively we\n\t// could replace CopyMemory() above with global_init(), but it would need to be changed back if ever we\n\t// want a directive to affect the default settings.\n\tg->HotCriterion = NULL;\n\t\n\t++g_nThreads;\n\tmAutoExecSectionIsRunning = true;\n\tDEBUGGER_STACK_PUSH(g_AutoExecuteThreadDesc)\n\n\t// v1.0.48: Due to switching from SET_UNINTERRUPTIBLE_TIMER to IsInterruptible():\n\t// In spite of the comments in IsInterruptible(), periodically have a timer call IsInterruptible() due to\n\t// the following scenario:\n\t// - Interrupt timeout is 60 seconds (or 60 milliseconds for that matter).\n\t// - For some reason IsInterrupt() isn't called for 24+ hours even though there is a current/active thread.\n\t// - RefreshInterruptibility() fires at 23 hours and marks the thread interruptible.\n\t// - Sometime after that, one of the following happens:\n\t// Computer is suspended/hibernated and stays that way for 50+ days.\n\t// IsInterrupt() is never called (except by RefreshInterruptibility()) for 50+ days.\n\t// (above is currently unlikely because MSG_FILTER_MAX calls IsInterruptible())\n\t// In either case, RefreshInterruptibility() has prevented the uninterruptibility duration from being\n\t// wrongly extended by up to 100% of g_script.mUninterruptibleTime. This isn't a big deal if\n\t// g_script.mUninterruptibleTime is low (like it almost always is); but if it's fairly large, say an hour,\n\t// this can prevent an unwanted extension of up to 1 hour.\n\t// Although any call frequency less than 49.7 days should work, currently calling once per 23 hours\n\t// in case any older operating systems have a SetTimer() limit of less than 0x7FFFFFFF (and also to make\n\t// it less likely that a long suspend/hibernate would cause the above issue). The following was\n\t// actually tested on Windows XP and a message does indeed arrive 23 hours after the script starts.\n\tSetTimer(g_hWnd, TIMER_ID_REFRESH_INTERRUPTIBILITY, 23*60*60*1000, RefreshInterruptibility); // 3rd param must not exceed 0x7FFFFFFF (2147483647; 24.8 days).\n\n\tSET_AUTOEXEC_TIMER(100); // Currently this only marks the auto-execute thread as uninterruptible for the time indicated.\n\t\n\t// v1.0.25: This is now done here, closer to the actual execution of the first line in the script,\n\t// to avoid an unnecessary Sleep(10) that would otherwise occur in ExecUntil:\n\tmLastPeekTime = GetTickCount();\n\n\tResultType result = OK;\n\n\t// Execute all modules, in reverse order of creation.\n\tfor (auto mod = mLastModule; mod; mod = mod->mPrev)\n\t{\n\t\tresult = ExecuteModule(mod);\n\t\tif (result != OK)\n\t\t\tbreak;\n\t}\n\n\t// Reset current module in case ListVars is used without g->CurrentFunc set.\n\tmCurrentModule = &mDefaultModule;\n\n\t// REMEMBER: The ExecUntil() call above will never return if the AutoExec section never finishes\n\t// (e.g. infinite loop) or it uses Exit/ExitApp.\n\n\tDEBUGGER_STACK_POP()\n\tmAutoExecSectionIsRunning = false;\n\t--g_nThreads;\n\n\t// Check if an exception has been thrown\n\tif (g->ThrownToken)\n\t\tg_script.FreeExceptionToken(g->ThrownToken);\n\n\t// Now that the auto-execute thread has finished, ensure that the very first g-item is always\n\t// interruptible. This avoids having to treat the first g-item as special in various places.\n\tglobal_maximize_interruptibility(*g); // See below.\n\n\treturn result;\n}\n\n\n\nResultType Script::ExecuteModule(ScriptModule *aModule)\n{\n\tif (!aModule->mFirstLine || aModule->mExecuted)\n\t\treturn OK;\n\taModule->mExecuted = true; // Set first to block recursion in cases where imp->mod imports aModule.\n\tfor (auto imp = aModule->mImports; imp; imp = imp->next)\n\t{\n\t\tauto result = ExecuteModule(imp->mod);\n\t\tif (result != OK)\n\t\t\treturn result;\n\t}\n\tmCurrentModule = aModule;\n\treturn aModule->mFirstLine->ExecUntil(UNTIL_RETURN);\n}\n\n\n\nbool Script::IsPersistent()\n{\n\t// Consider the script \"persistent\" if any of the following conditions are true:\n\tif (Hotkey::sHotkeyCount || Hotstring::sHotstringCount // At least one hotkey or hotstring exists.\n\t\t// No attempt is made to determine if the hotkeys/hotstrings are enabled, since even if they\n\t\t// are, it's impossible to detect whether #HotIf will allow them to ever execute.\n\t\t|| g_persistent // Persistent() has been used somewhere in the script.\n\t\t|| g_script.mTimerEnabledCount // At least one script timer is currently enabled.\n\t\t|| mOnClipboardChange.Count() // The script is monitoring clipboard changes.\n\t\t|| g_input // At least one active InputHook.\n\t\t|| IsWindowVisible(g_hWnd))\n\t\treturn true;\n\t// OnMessage does not make the script persistent because:\n\t// 1) It has too many uses to assume that the author would want the script to be persistent\n\t// (which would probably only be in cases where OnMessage is the main purpose of the script,\n\t// such as if it just idles until a command is received via WM_COPYDATA or other message).\n\t// 2) It's often used in conjunction with a GUI, and in such cases it's probably more convenient\n\t// to rely on other logic to keep the script running while the GUI is visible, and allow it to\n\t// exit when the GUI is closed.\n\t// 3) Message monitors that are intended to keep the script running probably won't be removed,\n\t// so checking the number of active monitors here at runtime doesn't offer much benefit vs.\n\t// requiring the script to call Persistent() if needed.\n\t// 4) The only alternatives to OnMessage are generally window subclassing and hooks, which come\n\t// with various problems, such as spamming ListLines, interacting badly with Pause/A_IsPaused\n\t// (due to thread-starting messages passing through the window proc), and others.\n\t// Adding custom items to A_TrayMenu does not make the script persistent because:\n\t// 1) It could be something like a slight modification to a standard item's behaviour,\n\t// or something else that isn't intended to keep the script running.\n\t// 2) Custom items usually aren't removed, so having checks for them at runtime is not as helpful\n\t// as some of the conditions above, like timers and visible windows. When they are removed, it\n\t// is always a direct action of the code, not some external event.\n\t// 3) If adding custom items made the script persistent, it can be worked around by intercepting\n\t// right-clicks on the tray icon and showing some other menu, but replicating the Pause/Suspend\n\t// checkmarks and AddStandard() behaviour is surprisingly complicated. By contrast, calling\n\t// Persistent() before/after adding the custom items is trivial.\n\tfor (GuiType* gui = g_firstGui; gui; gui = gui->mNextGui)\n\t\tif (IsWindowVisible(gui->mHwnd)) // A GUI is visible.\n\t\t\treturn true;\n\t// Otherwise, none of the above conditions are true; but there might still be\n\t// one or more script threads running. Caller is responsible for checking that.\n\treturn false;\n}\n\n\n\nvoid Script::ExitIfNotPersistent(ExitReasons aExitReason)\n{\n\tif (g_nThreads || IsPersistent())\n\t\treturn;\n\tg_script.ExitApp(aExitReason);\n}\n\n\n\nbif_impl void Edit(optl<StrArg> aFileName)\n{\n\tg_script.Edit(aFileName.value_or_null());\n}\n\nResultType Script::Edit(LPCTSTR aFileName)\n{\n#ifdef AUTOHOTKEYSC\n\treturn OK; // Do nothing.\n#else\n\tHWND hwnd = NULL;\n\tif (!aFileName)\n\t{\n\t\tif (mKind != ScriptKindFile)\n\t\t\treturn OK;\n\t\tTitleMatchModes old_mode = g->TitleMatchMode;\n\t\tg->TitleMatchMode = FIND_ANYWHERE;\n\t\thwnd = WinExist(*g, mFileSpec, _T(\"\"), mMainWindowTitle, _T(\"\")); // Exclude our own main window.\n\t\tif (!hwnd)\n\t\t\thwnd = WinExist(*g, mFileName, _T(\"\"), mMainWindowTitle, _T(\"\")); // Try again without path.\n\t\tg->TitleMatchMode = old_mode;\n\t\taFileName = mFileSpec;\n\t}\n\tif (hwnd)\n\t{\n\t\tTCHAR class_name[32];\n\t\tGetClassName(hwnd, class_name, _countof(class_name));\n\t\tif (!_tcscmp(class_name, _T(\"#32770\")) || !_tcsnicmp(class_name, _T(\"AutoHotkey\"), 10)) // MessageBox(), InputBox(), FileSelect(), or GUI/script-owned window.\n\t\t\thwnd = NULL; // Exclude it from consideration.\n\t}\n\tif (hwnd) // File appears to already be open for editing, so use the current window.\n\t\tSetForegroundWindowEx(hwnd);\n\telse\n\t{\n\t\tTCHAR buf[T_MAX_PATH + 2]; // +2 for the two quote marks.\n\t\t// Enclose in double quotes anything that might contain spaces since the CreateProcess()\n\t\t// method, which is attempted first, is more likely to succeed. This is because it uses\n\t\t// the command line method of creating the process, with everything all lumped together:\n\t\tsntprintf(buf, _countof(buf), _T(\"\\\"%s\\\"\"), aFileName);\n\t\tif (!ActionExec(_T(\"Edit\"), buf, mFileDir, false)) // Since this didn't work, try notepad.\n\t\t{\n\t\t\t// Even though notepad properly handles filenames with spaces in them under WinXP,\n\t\t\t// even without double quotes around them, it seems safer and more correct to always\n\t\t\t// enclose the filename in double quotes for maximum compatibility with all OSes:\n\t\t\tif (!ActionExec(_T(\"notepad.exe\"), buf, mFileDir, false))\n\t\t\t\tMsgBox(_T(\"Could not open script.\")); // Short message since so rare.\n\t\t}\n\t}\n\treturn OK;\n#endif\n}\n\n\n\nbif_impl FResult Reload()\n{\n\t// If Reload() returns failure, that means a failure to launch the new process at all,\n\t// and an error message was displayed or an exception was thrown, so we must return FR_FAIL.\n\t// If Reload() returns success but the script doesn't terminate even after some delay,\n\t// it can be assumed that the reload didn't work, and the script can take follow-on action.\n\treturn g_script.Reload(true) ? OK : FR_FAIL;\n}\n\nResultType Script::Reload(bool aDisplayErrors)\n{\n\t// The new instance we're about to start will tell our process to stop, or it will display\n\t// a syntax error or some other error, in which case our process will still be running:\n#ifdef AUTOHOTKEYSC\n\t// This is here in case a compiled script ever uses the Reload function. Since the \"Reload Script\"\n\t// tray menu item is not available for compiled scripts, it can't be called from there.\n\treturn g_script.ActionExec(mOurEXE, _T(\"/restart\"), g_WorkingDirOrig, aDisplayErrors);\n#else\n\tif (mKind == ScriptKindStdIn)\n\t\treturn OK;\n\tTCHAR arg_string[UorA(MAX_WIDE_PATH, MAX_PATH * 2 + 16)]; // MAX_WIDEPATH coincides with the CreateProcess command line length limit (+1).\n\tif (mCmdLineInclude)\n\t\tsntprintf(arg_string, _countof(arg_string), _T(\"/include \\\"%s\\\" \"), mCmdLineInclude);\n\telse\n\t\t*arg_string = '\\0';\n\tsntprintfcat(arg_string, _countof(arg_string), _T(\"/restart /script \\\"%s\\\"\"), Line::sSourceFile[0]);\n\treturn g_script.ActionExec(mOurEXE, arg_string, g_WorkingDirOrig, aDisplayErrors);\n#endif\n}\n\n\n\nbif_impl ResultType Exit(optl<int> aExitCode)\n{\n\t// Even if the script isn't persistent, this thread might've interrupted another which should\n\t// be allowed to complete normally. This is especially important in v2 because a persistent\n\t// script can become non-persistent by disabling a timer, closing a GUI, etc. So if there\n\t// are any threads below this one, only exit this thread:\n\t//if (g_nThreads > 1 || g_script.IsPersistent())\n\t// UPDATE: Handle it this way unconditionally so that the thread is properly exited prior to\n\t// the script terminating; i.e. any FINALLY statements are executed and __delete is called for\n\t// any objects in local variables or on the expression evaluation stack.\n\t// UPDATE: Also need to make sure that the exit code gets used (commit 40dd95f broke that).\n\t// For now it seems best to match the old behaviour of ignoring the exit code if Exit isn't\n\t// going to immediately terminate the script. Avoid checking IsPersistent() here because\n\t// conditions can change during stack-unwind due to __delete or FINALLY. Instead, this is\n\t// reset to 0 in ResumeUnderlyingThread().\n\tif (g_nThreads <= 1)\n\t\tg_script.mPendingExitCode = aExitCode.has_value() ? *aExitCode : 0;\n\treturn EARLY_EXIT;\n}\n\nbif_impl ResultType ExitApp(optl<int> aExitCode)\n{\n\tg_script.mPendingExitCode = aExitCode.has_value() ? *aExitCode : 0;\n\treturn g_script.ExitApp(EXIT_EXIT);\n}\n\n\n\nResultType Script::ExitApp(ExitReasons aExitReason)\n// Normal exit (if aBuf is NULL), or a way to exit immediately on error (which is mostly\n// for times when it would be unsafe to call MsgBox() due to the possibility that it would\n// make the situation even worse).\n{\n\t// If we're called before the script has loaded, it is almost certainly by the ExitApp\n\t// button on an error/warning dialog. Treat it as a load-time error either way since\n\t// that's probably what the user wants.\n\tint aExitCode = mIsReadyToExecute ? mPendingExitCode : CRITICAL_ERROR;\n\n\t// Note that currently, mOnExit.Count() can only be non-zero if the script is in a runnable\n\t// state (since registering an OnExit function requires that the script calls OnExit()).\n\t// If this ever changes, the !mIsReadyToExecute condition should be added below:\n\tif (!mOnExit.Count() || g_OnExitIsRunning)\n\t{\n\t\t// In the case of g_OnExitIsRunning == true:\n\t\t// There is another instance of this function beneath us on the stack. Since we have\n\t\t// been called, this is a true exit condition and we exit immediately.\n\t\t// MUST NOT create a new thread when g_OnExitIsRunning because g_array allows only one\n\t\t// extra thread for ExitApp() (which allows it to run even when MAX_THREADS_EMERGENCY has\n\t\t// been reached). See TOTAL_ADDITIONAL_THREADS.\n\t\tTerminateApp(aExitReason, aExitCode);\n\t}\n\n\t// Otherwise, the script contains the special OnExit function that we will run here instead\n\t// of exiting. And since it does, we know that the script is in a ready-to-execute state\n\t// because that is the only way an OnExit function could have been defined in the first place.\n\t// The OnExit function may return true in order to abort the Exit sequence (e.g. it could\n\t// display an \"Are you sure?\" prompt, and if the user chooses \"No\", it returns true, letting\n\t// the thread we create below end normally).\n\n\t// Next, save the current state of the globals so that they can be restored just prior\n\t// to returning to our caller:\n\tInitNewThread(0, true, true); // Uninterruptibility is handled below. Since this special thread should always run, no checking of g_MaxThreadsTotal is done before calling this.\n\n\t// Turn on uninterruptibility to forbid any hotkeys, timers, or user defined menu items\n\t// to interrupt. This is mainly done for peace-of-mind (since possible interactions due to\n\t// interruptions have not been studied) and the fact that this most users would not want this\n\t// subroutine to be interruptible (it usually runs quickly anyway). Another reason to make\n\t// it non-interruptible is that some OnExit functions might destruct things used by the\n\t// script's hotkeys/timers/menu items, and activating these items during the deconstruction\n\t// would not be safe. Finally, if a logoff or shutdown is occurring, it seems best to prevent\n\t// timed subroutines from running -- which might take too much time and prevent the exit from\n\t// occurring in a timely fashion. An option can be added via the FutureUse param to make it\n\t// interruptible if there is ever a demand for that.\n\t// UPDATE: g_AllowInterruption is now used instead of g->AllowThreadToBeInterrupted for two reasons:\n\t// 1) It avoids the need to do \"int mUninterruptedLineCountMax_prev = g_script.mUninterruptedLineCountMax;\"\n\t// (Disable this item so that ExecUntil() won't automatically make our new thread uninterruptible\n\t// after it has executed a certain number of lines).\n\t// 2) Mostly obsolete: If the thread we're interrupting is uninterruptible, the uninterruptible timer\n\t// might be currently pending. When it fires, it would make the OnExit function interruptible\n\t// rather than the underlying subroutine. The above fixes the first part of that problem.\n\t// The 2nd part is fixed by reinstating the timer when the uninterruptible thread is resumed.\n\t// This special handling is only necessary here -- not in other places where new threads are\n\t// created -- because OnExit is the only type of thread that can interrupt an uninterruptible\n\t// thread.\n\tBOOL g_AllowInterruption_prev = g_AllowInterruption; // Save current setting.\n\tg_AllowInterruption = FALSE; // Mark the thread just created above as permanently uninterruptible (i.e. until it finishes and is destroyed).\n\n\tg_OnExitIsRunning = true;\n\tDEBUGGER_STACK_PUSH(_T(\"OnExit\"))\n\n\tExprTokenType param[] = { GetExitReasonString(aExitReason), (__int64)aExitCode };\n\tResultType result = mOnExit.Call(param, _countof(param), 1);\n\t\n\tDEBUGGER_STACK_POP()\n\n\tif (result != CONDITION_TRUE // OnExit function did not return true to prevent exit.\n\t\t|| EXITREASON_MUST_EXIT(aExitReason)) // Caller requested we exit unconditionally.\n\t\tTerminateApp(aExitReason, aExitCode);\n\n\t// Otherwise:\n\tg_AllowInterruption = g_AllowInterruption_prev; // Restore original setting.\n\tResumeUnderlyingThread();\n\t// If this OnExit thread is the last script thread and the script is not persistent, the above\n\t// call recurses into this function. g_OnExitIsRunning == true prevents infinite recursion\n\t// in that case. It is now safe to reset:\n\tg_OnExitIsRunning = false; // In case the user wanted the thread to end normally (see above).\n\n\treturn EARLY_EXIT;\n}\n\n\n\n#ifdef RELEASE_SOME_OBJECTS_ON_EXIT\nvoid ReleaseVarObjects(VarList &aVars)\n{\n\tfor (int v = 0; v < aVars.mCount; ++v)\n\t{\n\t\tVar &var = *aVars.mItem[v];\n\t\tif (var.IsObject() && var.Type() == VAR_NORMAL)\n\t\t\tvar.ReleaseObject(); // ReleaseObject() vs Free() for performance (though probably not important at this point).\n\t\t// Otherwise, maybe best not to free it in case an object's __Delete meta-function uses it?\n\t}\n}\n\nvoid ReleaseStaticVarObjects(FuncList &aFuncs)\n{\n\tfor (int i = 0; i < aFuncs.mCount; ++i)\n\t{\n\t\tUserFunc &f = *aFuncs.mItem[i];\n\t\t// Since it doesn't seem feasible to release all var backups created by recursive function\n\t\t// calls and all tokens in the 'stack' of each currently executing expression, currently\n\t\t// only static and global variables are released. It seems best for consistency to also\n\t\t// avoid releasing top-level non-static local variables (i.e. which aren't in var backups).\n\t\tReleaseVarObjects(f.mStaticVars);\n\t}\n}\n#endif\n\n\n\nvoid Script::TerminateApp(ExitReasons aExitReason, int aExitCode)\n// Note that g_script's destructor takes care of most other cleanup work, such as destroying\n// tray icons, menus, and unowned windows such as ToolTip.\n{\n#ifdef RELEASE_SOME_OBJECTS_ON_EXIT\n\t// v2.1: This was disabled rather than updating it to iterate through module variables because\n\t// it has always been incomplete (doesn't finalize all objects) and caused unexpected behaviour\n\t// (some global or static variables are arbitrarily unset before __delete executes).\n\t// L31: Release objects stored in variables, where possible.\n\tif (aExitReason != EXIT_CRITICAL) // i.e. Avoid making matters worse if EXIT_CRITICAL.\n\t{\n\t\t// Ensure the current thread is not paused and can't be interrupted\n\t\t// in case one or more objects need to call a __delete meta-function.\n\t\tg_AllowInterruption = FALSE;\n\t\tg->IsPaused = false;\n\n\t\tReleaseVarObjects(mVars);\n\t\tReleaseStaticVarObjects(mFuncs);\n\t}\n#endif\n#ifdef CONFIG_DEBUGGER // L34: Exit debugger *after* the above to allow debugging of any invoked __Delete handlers.\n\tg_Debugger.Exit(aExitReason);\n#endif\n\n\t// PostQuitMessage() might be needed to prevent hang-on-exit. Once this is done, no message boxes or\n\t// other dialogs can be displayed. MSDN: \"The exit value returned to the system must be the wParam\n\t// parameter of the WM_QUIT message.\" In our case, PostQuitMessage() should announce the same exit code\n\t// that we will eventually call exit() with:\n\tPostQuitMessage(aExitCode);\n\n\t// I know this isn't the preferred way to exit the program. However, due to unusual\n\t// conditions such as the script having MsgBoxes or other dialogs displayed on the screen\n\t// at the time the user exits (in which case our main event loop would be \"buried\" underneath\n\t// the event loops of the dialogs themselves), this is the only reliable way I've found to exit\n\t// so far.\n\texit(aExitCode); // exit() is insignificant in code size. It does more than ExitProcess(), but perhaps nothing more that this application actually requires.\n}\n\n\n\nUINT Script::LoadFromFile(LPCTSTR aFileSpec)\n// Returns the number of non-comment lines that were loaded, or LOADING_FAILED on error.\n{\n\tmIsReadyToExecute = mAutoExecSectionIsRunning = false;\n\tif (!aFileSpec)\n\t\taFileSpec = mFileSpec;\n\n#ifndef AUTOHOTKEYSC // When not in stand-alone mode, read an external script file.\n\tDWORD attr = mKind == ScriptKindFile ? GetFileAttributes(aFileSpec) : 0; // v1.1.17: Don't check if reading script from stdin.\n\tif (attr == MAXDWORD) // File does not exist or lacking the authorization to get its attributes.\n\t{\n\t\tif (!g_script.mErrorStdOut)\n\t\t{\n\t\t\tTCHAR buf[T_MAX_PATH + 24];\n\t\t\tsntprintf(buf, _countof(buf), _T(\"%s\\n%s\"), ERR_SCRIPT_NOT_FOUND, aFileSpec);\n\t\t\tMsgBox(buf, MB_ICONHAND);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tLine::sSourceFile = &mFileSpec;\n\t\t\tScriptError(ERR_SCRIPT_NOT_FOUND);\n\t\t}\n\t\treturn LOADING_FAILED;\n\t}\n#endif\n\n\t// Load the main script file. This will also load any files it includes with #Include.\n\tif (!LoadIncludedFile(mKind == ScriptKindStdIn ? _T(\"*\") : aFileSpec, false, false))\n\t\treturn LOADING_FAILED;\n\t\t\n\tg_SuspendExempt = false; // #SuspendExempt should not affect Hotkey()/Hotstring().\n\n#ifdef ENABLE_DLLCALL\n\t// So that (the last occuring) \"#DllLoad directory\" doesn't affect calls to GetDllProcAddress for run time calls to DllCall\n\t// or DllCall optimizations in Line::ExpressionToPostfix.\n\tif (!SetDllDirectory(NULL))\n\t{\n\t\tScriptError(ERR_INTERNAL_CALL);\n\t\treturn LOADING_FAILED;\n\t}\n#endif\n\n\tif (!CloseCurrentModule() || !ResolveImports())\n\t\treturn LOADING_FAILED;\n\n\t// Preparse all expressions and resolve all variable references. The outer-most scope\n\t// is preparsed first, then each function, working inward through all nested functions.\n\t// All of a function's non-dynamic local variables are created before variable names\n\t// are resolved in nested functions.\n\t// Read references (VARREF_READ) are resolved only after all assignments have been\n\t// preparsed throughout the script, in case one creates an assume-global variable.\n\tif (!PreparseExpressions()\n\t\t|| !PreparseExpressions(mFuncs)\n\t\t|| !PreparseVarRefs())\n\t\treturn LOADING_FAILED; // Error was already displayed by the above call.\n\n\t// Do some processing of local variables to support closures.\n\t// This must be done after PreparseExpressions() has resolved all variable references.\n\tif (!PreprocessLocalVars(mFuncs))\n\t\treturn LOADING_FAILED;\n\n\t// Set the working directory to the script's directory. This must be done after the above\n\t// since the working dir may have been changed by the script's use of \"#Include C:\\Scripts\".\n\t// LoadIncludedFile() also changes it, but any value other than mFileDir would have been\n\t// restored by \"#Include\" after LoadIncludedFile() returned. Note that A_InitialWorkingDir\n\t// contains the startup-determined working directory, so no flexibility is lost.\n\tSetCurrentDirectory(mFileDir);\n\tg_WorkingDir.SetString(mFileDir);\n\n\tif (!PreparseCommands())\n\t\treturn LOADING_FAILED; // Error was already displayed by the above calls.\n\t\n#ifndef AUTOHOTKEYSC\n\tif (mValidateThenExit)\n\t\treturn 0; // Tell our caller to do a normal exit.\n#endif\n\n\treturn TRUE; // Must be non-zero.\n}\n\n\n\nbool Script::IsFunctionDefinition(LPTSTR aBuf, LPTSTR aNextBuf)\n// Helper function for LoadIncludedFile().\n// Caller passes in an aBuf containing a candidate line such as \"function(x, y)\"\n// Caller has ensured that aBuf is rtrim'd.\n// Caller should pass NULL for aPendingFunctionHasBrace to indicate that function definitions (open-brace\n// on same line as function) are not allowed. When non-NULL *and* aBuf is a function call/def,\n// *aPendingFunctionHasBrace is set to true if a brace is present at the end, or false otherwise.\n// In addition, any open-brace is removed from aBuf in this mode.\n{\n\tLPTSTR action_start = aBuf;\n\tLPTSTR action_end = find_identifier_end(aBuf);\n\tbool is_default_export = false;\n\tif (IS_SPACE_OR_TAB(*action_end) && action_end - action_start == 6) // Allow modifier keywords.\n\t{\n\t\tbool is_export = !_tcsnicmp(aBuf, _T(\"Export\"), 6);\n\t\tif (is_export || !_tcsnicmp(aBuf, _T(\"Static\"), 6))\n\t\t\taction_start = omit_leading_whitespace(action_end);\n\t\tif (is_default_export = is_export && !_tcsnicmp(action_start, _T(\"Default\"), 7) && IS_SPACE_OR_TAB(action_start[7]))\n\t\t\taction_start = omit_leading_whitespace(action_start + 8);\n\t\taction_end = find_identifier_end(action_start);\n\t}\n\t// Can't be a function definition or call without an open-parenthesis as first char found by the above.\n\t// action_end points at the first character which is not usable in an identifier, such as a space, tab\n\t// colon or other operator symbol. As a result, it can't be:\n\t// 1) a hotstring, since they always start with at least one colon that would be caught immediately as \n\t// first-expr-char-is-not-open-parenthesis by the above.\n\t// 2) Any kind of math or assignment, such as var:=(x+y) or var+=(x+y).\n\t// The only things it could be other than a function call or function definition are:\n\t// Single-line hotkey such as KeyName::MsgBox. But (:: is the only valid hotkey where *action_end == '(',\n\t// and that's handled by excluding action_end == aBuf.\n\tif (*action_end != '(' || action_end == action_start && !is_default_export)\n\t\treturn false;\n\t// Is it a control flow statement, such as \"if(condition)\"?\n\tif (action_start == aBuf && (g->CurrentFunc || !g_script.mClassObjectCount))\n\t{\n\t\t*action_end = '\\0';\n\t\tbool is_control_flow = ConvertActionType(aBuf);\n\t\t*action_end = '(';\n\t\tif (is_control_flow)\n\t\t\treturn false;\n\t}\n\t// It's not control flow.\n\tLPTSTR param_end = action_end + FindExprDelim(action_end, ')', 1);\n\tif (*param_end != ')')\n\t\treturn false;\n\tLPTSTR next_token = omit_leading_whitespace(param_end + 1);\n\treturn *next_token == 0 && *aNextBuf == '{' // Brace on next line.\n\t\t|| *next_token == '{' && next_token[1] == 0 // Brace on same line.\n\t\t|| *next_token == '=' && next_token[1] == '>'; // Fn() => expr\n}\n\n\n\ninline LPTSTR IsClassDefinition(LPTSTR aBuf, TCHAR *aExport)\n{\n\tif (aExport) // Export is permitted.\n\t{\n\t\t*aExport = 0; // No export.\n\t\tif (!_tcsnicmp(aBuf, _T(\"Export\"), 6) && IS_SPACE_OR_TAB(aBuf[6]))\n\t\t{\n\t\t\taBuf = omit_leading_whitespace(aBuf + 7);\n\t\t\tif (!_tcsnicmp(aBuf, _T(\"Default\"), 7) && IS_SPACE_OR_TAB(aBuf[7]))\n\t\t\t{\n\t\t\t\taBuf = omit_leading_whitespace(aBuf + 8);\n\t\t\t\t*aExport = 'D'; // Default export.\n\t\t\t}\n\t\t\telse\n\t\t\t\t*aExport = 'E'; // Non-default export.\n\t\t}\n\t}\n\tif (_tcsnicmp(aBuf, _T(\"Class\"), 5) || !IS_SPACE_OR_TAB(aBuf[5])) // i.e. it's not \"Class\" followed by a space or tab.\n\t\treturn NULL;\n\tLPTSTR class_name = omit_leading_whitespace(aBuf + 6);\n\tif (_tcschr(EXPR_ALL_SYMBOLS, *class_name))\n\t\t// It's probably something like \"Class := GetClass()\".\n\t\treturn NULL;\n\t// Validation of the name is left up to the caller, for simplicity.\n\treturn class_name;\n}\n\n\n\nvoid RemoveBufChar0(LPTSTR aBuf, size_t &aBufLength)\n{\n\tLPTSTR cp = omit_leading_whitespace(aBuf + 1);\n\taBufLength -= (cp - aBuf);\n\tif (aBufLength) // Some non-whitespace remains.\n\t\ttmemmove(aBuf, aBuf + 1, aBufLength);\n\telse\n\t\t*aBuf = '\\0';\n}\n\n\n\nbool ClassHasOpenBrace(LPTSTR aBuf, size_t aBufLength, LPTSTR aNextBuf, size_t &aNextBufLength)\n{\n\tif (aBuf[aBufLength - 1] == '{') // Brace on same line (OTB).\n\t{\n\t\trtrim(aBuf, aBufLength - 1);\n\t\treturn true;\n\t}\n\tif (*aNextBuf == '{') // Brace on next line.\n\t{\n\t\t// Remove '{' from aNextBuf since ACT_BLOCK_END is unwanted in this context.\n\t\tRemoveBufChar0(aNextBuf, aNextBufLength);\n\t\treturn true;\n\t}\n\treturn false;\n}\n\n\n\nResultType Script::OpenIncludedFile(TextStream *&ts, LPCTSTR aFileSpec, bool aAllowDuplicateInclude, bool aIgnoreLoadFailure)\n// Open the included file. Returns CONDITION_TRUE if the file is to\n// be loaded, otherwise OK (duplicate/already loaded) or FAIL (error).\n// See \"full_path\" below for why this is separate to LoadIncludedFile(). \n{\n#ifndef AUTOHOTKEYSC\n\tif (!aFileSpec || !*aFileSpec) return FAIL;\n\n\tif (Line::sSourceFileCount >= Line::sMaxSourceFiles)\n\t{\n\t\tif (Line::sSourceFileCount >= ABSOLUTE_MAX_SOURCE_FILES)\n\t\t\treturn ScriptError(_T(\"Too many includes.\")); // Short msg since so rare.\n\t\tint new_max;\n\t\tif (Line::sMaxSourceFiles)\n\t\t{\n\t\t\tnew_max = 2*Line::sMaxSourceFiles;\n\t\t\tif (new_max > ABSOLUTE_MAX_SOURCE_FILES)\n\t\t\t\tnew_max = ABSOLUTE_MAX_SOURCE_FILES;\n\t\t}\n\t\telse\n\t\t\tnew_max = 100;\n\t\t// For simplicity and due to rarity of every needing to, expand by reallocating the array.\n\t\t// Use a temp var. because realloc() returns NULL on failure but leaves original block allocated.\n\t\tLPTSTR *realloc_temp = (LPTSTR *)realloc(Line::sSourceFile, new_max * sizeof(LPTSTR)); // If passed NULL, realloc() will do a malloc().\n\t\tif (!realloc_temp)\n\t\t\treturn ScriptError(ERR_OUTOFMEM); // Short msg since so rare.\n\t\tLine::sSourceFile = realloc_temp;\n\t\tLine::sMaxSourceFiles = new_max;\n\t}\n\n\t// Use of stack memory here to build the full path is the most efficient method,\n\t// but utilizes 64KB per buffer on Unicode builds. There is virtually no cost\n\t// when used here, but if used directly in LoadIncludedFile(), this would mean\n\t// 64KB used *for each instance on the stack*, which significantly reduces the\n\t// recursion limit for #include inside #include. Note that enclosing the buf\n\t// within a limited scope is insufficient, as the compiler will (or may) still\n\t// allocate the required stack space on entry to the function.\n\tTCHAR full_path[T_MAX_PATH];\n\n\tint source_file_index = Line::sSourceFileCount;\n\tbool is_first_source_file = !source_file_index;\n\tif (is_first_source_file && *aFileSpec != '*')\n\t\t// Since this is the first source file, it must be the main script file. Just point it to the\n\t\t// location of the filespec already dynamically allocated:\n\t\tLine::sSourceFile[source_file_index] = mFileSpec;\n\telse\n\t{\n\t\t// Get the full path in case aFileSpec has a relative path. This is done so that duplicates\n\t\t// can be reliably detected (we only want to avoid including a given file more than once):\n\t\tLPTSTR filename_marker;\n\t\tif (*aFileSpec == '*')\n\t\t{\n\t\t\ttcslcpy(full_path, aFileSpec, _countof(full_path));\n\t\t\tCharUpper(full_path); // Resource names must be upper-case.\n\t\t}\n\t\telse\n\t\t\tGetFullPathName(aFileSpec, _countof(full_path), full_path, &filename_marker);\n\t\t// Check if this file was already included. If so, it's not an error because we want\n\t\t// to support automatic \"include once\" behavior. So ignore repeats if requested by the\n\t\t// caller, otherwise reuse the file index and allocated path:\n\t\tfor (source_file_index = 0; source_file_index < Line::sSourceFileCount; ++source_file_index)\n\t\t\tif (!ostrcmpi(Line::sSourceFile[source_file_index], full_path)) // Case insensitive like the file system (e.g. \"Ä\" == \"ä\" in the NTFS).\n\t\t\t\tbreak;\n\t\t// The path is copied into persistent memory further below, after the file has been opened,\n\t\t// in case the opening fails and aIgnoreLoadFailure==true. Initialize for the check below.\n\t\tLine::sSourceFile[Line::sSourceFileCount] = NULL;\n\t}\n\n\tbool is_duplicate = mCurrentModule->HasFileIndex(source_file_index);\n\tif (is_duplicate && !aAllowDuplicateInclude)\n\t\treturn OK;\n\n\tLPCTSTR filespec_to_open = aFileSpec;\n\tUINT codepage = g_DefaultScriptCodepage;\n\n\tTextMem::Buffer textbuf(nullptr, 0, false);\n\tHRSRC hRes;\n\tif (*aFileSpec == '*' && aFileSpec[1] && (hRes = FindResource(NULL, aFileSpec + 1, RT_RCDATA)))\n\t{\n\t\tHGLOBAL hResData = LoadResource(NULL, hRes);\n\t\tif (hResData && (textbuf.mBuffer = LockResource(hResData)))\n\t\t{\n\t\t\ttextbuf.mLength = SizeofResource(NULL, hRes);\n\t\t\tfilespec_to_open = textbuf;\n\t\t\tcodepage = CP_UTF8;\n\t\t\tts = new TextMem();\n\t\t}\n\t}\n\telse\n\t\tts = new TextFile();\n\n\tif (!ts || !ts->Open(filespec_to_open, DEFAULT_READ_FLAGS, codepage))\n\t{\n\t\tif (aIgnoreLoadFailure)\n\t\t\treturn OK;\n\t\tTCHAR msg_text[T_MAX_PATH + 64]; // T_MAX_PATH vs. MAX_PATH because the full length could be utilized with ErrorStdOut.\n\t\tsntprintf(msg_text, _countof(msg_text), _T(\"%s file \\\"%s\\\" cannot be opened.\")\n\t\t\t, source_file_index ? _T(\"#Include\") : _T(\"Script\"), aFileSpec);\n\t\treturn ScriptError(msg_text);\n\t}\n\t\n\t// This is done only after the file has been successfully opened in case aIgnoreLoadFailure==true:\n\tif (!Line::sSourceFile[source_file_index])\n\t\tLine::sSourceFile[source_file_index] = SimpleHeap::Alloc(full_path);\n\tif (source_file_index == Line::sSourceFileCount)\n\t\t++Line::sSourceFileCount;\n\tif (!is_duplicate)\n\t\tif (!mCurrentModule->AddFileIndex(source_file_index))\n\t\t\treturn FAIL;\n\n\tif (is_first_source_file)\n\t{\n\t\t// Load any pre-script resource.\n\t\tif (FindResource(NULL, SCRIPT_PRESOURCE_NAME, RT_RCDATA)\n\t\t\t&& !LoadIncludedFile(SCRIPT_PRESOURCE_SPEC, false, false))\n\t\t\treturn FAIL;\n\n\t\t// Load any file specified with the /include switch.\n\t\tif (mCmdLineInclude\n\t\t\t&& !LoadIncludedFile(mCmdLineInclude, false, false))\n\t\t\treturn FAIL;\n\t}\n\n\t// Set after recursive calls above.\n\tmCurrFileIndex = source_file_index;\n\t\n\t// Set the working directory so that any #Include directives are relative to the directory\n\t// containing this file by default. Call SetWorkingDir() vs. SetCurrentDirectory() so that it\n\t// succeeds even for a root drive like C: that lacks a backslash (see SetWorkingDir() for details).\n\tif (source_file_index)\n\t{\n\t\tLPTSTR terminate_here = _tcsrchr(full_path, '\\\\');\n\t\tif (terminate_here > full_path)\n\t\t{\n\t\t\t*terminate_here = '\\0'; // Temporarily terminate it for use with SetWorkingDir().\n\t\t\tSetWorkingDir(full_path);\n\t\t\t*terminate_here = '\\\\'; // Undo the termination.\n\t\t}\n\t\t//else: probably impossible? Just leave the working dir as-is, for simplicity.\n\t}\n\telse\n\t\tSetWorkingDir(mFileDir);\n\n#else // Stand-alone mode (there are no include files in this mode since all of them were merged into the main script at the time of compiling).\n\n\tTextMem::Buffer textbuf(NULL, 0, false);\n\n\tHRSRC hRes;\n\tHGLOBAL hResData;\n\n\thRes = FindResource(NULL, SCRIPT_RESOURCE_NAME, RT_RCDATA);\n\tif ( !( hRes \n\t\t\t&& (textbuf.mLength = SizeofResource(NULL, hRes))\n\t\t\t&& (hResData = LoadResource(NULL, hRes))\n\t\t\t&& (textbuf.mBuffer = LockResource(hResData)) ) )\n\t{\n\t\treturn ScriptError(_T(\"Could not extract script from EXE.\"), aFileSpec);\n\t}\n\n\tts = new TextMem();\n\t// NOTE: Ahk2Exe strips off the UTF-8 BOM.\n\tts->Open(textbuf, TextStream::READ | TextStream::EOL_CRLF | TextStream::EOL_ORPHAN_CR, CP_UTF8);\n\n\t// Since this is a compiled script, there is only one script file.\n\t// Just point it to the location of the filespec already dynamically allocated:\n\tLine::sSourceFile[0] = mFileSpec;\n\t++Line::sSourceFileCount;\n\n#endif\n\t\n\t// Since above did not continue, proceed with loading the file.\n\treturn CONDITION_TRUE;\n}\n\n\n\nResultType Script::LoadIncludedFile(LPCTSTR aFileSpec, bool aAllowDuplicateInclude, bool aIgnoreLoadFailure)\n// Returns OK or FAIL.\n{\n\tTextStream *ts = nullptr;\n\tResultType result = OpenIncludedFile(ts, aFileSpec, aAllowDuplicateInclude, aIgnoreLoadFailure);\n\tif (result == CONDITION_TRUE)\n\t\tresult = LoadIncludedFile(ts);\n\tif (ts)\n\t\tdelete ts;\n\treturn result;\n}\n\n\n\nResultType Script::LoadIncludedFile(TextStream *fp)\n// Returns OK or FAIL.\n{\n\t// Keep this var on the stack due to recursion, which allows newly created lines to be given the\n\t// correct file number even when some #include's have been encountered in the middle of the script:\n\tint source_file_index = mCurrFileIndex;\n\n\tbool blocks_previously_open = mLineParent || mClassObjectCount; // For error detection.\n\n\tLineBuffer buf, next_buf;\n\tsize_t &buf_length = buf.length, &next_buf_length = next_buf.length;\n\n\t// File is now open, read lines from it.\n\n\tbool has_continuation_section;\n\n\tLPTSTR hotkey_flag, hotstring_start, hotstring_options;\n\tbool hotstring_execute;\n\tResultType hotkey_validity;\n\n#ifdef AUTOHOTKEYSC\n\t// -1 (MAX_UINT in this case) to compensate for the fact that there is a comment containing\n\t// the version number added to the top of each compiled script:\n\tLineNumberType phys_line_number = -1;\n#else\n\tLineNumberType phys_line_number = 0;\n#endif\n\t\n\tif (!buf.Expand() || !next_buf.Expand())\n\t\treturn ScriptError(ERR_OUTOFMEM);\n\n\t// buf is initialized this way rather than calling GetLine() to simplify handling of comment\n\t// sections beginning at the first line, and to reduce code size by having GetLine() only\n\t// called from one place:\n\t*buf = '\\0';\n\n\twhile (buf_length != -1) // Compare directly to -1 since length is unsigned.\n\t{\n\t\t// For each whole line (a line with continuation section is counted as only a single line\n\t\t// for the purpose of this outer loop).\n\n\t\t// Keep track of this line's *physical* line number within its file for A_LineNumber and\n\t\t// error reporting purposes. This must be done only in the outer loop so that it tracks\n\t\t// the topmost line of any set of lines merged due to continuation section/line(s)..\n\t\tmCombinedLineNumber = phys_line_number;\n\n\t\t// This must be reset for each iteration because a prior iteration may have changed it, even\n\t\t// indirectly by calling something that changed it:\n\t\tmCurrLine = NULL; // To signify that we're in transition, trying to load a new one.\n\n\t\tif (!GetLineContinuation(fp, buf, next_buf, phys_line_number, has_continuation_section))\n\t\t\treturn FAIL;\n\nprocess_completed_line:\n\t\t// buf_length can't be -1 (though next_buf_length can) because outer loop's condition prevents it:\n\t\tif (!buf_length) // Done only after the line number increments above so that the physical line number is properly tracked.\n\t\t\tgoto continue_main_loop; // In lieu of \"continue\", for performance.\n\n\t\t// Since neither of the above executed, or they did but didn't \"continue\",\n\t\t// buf now contains a non-commented line, either by itself or built from\n\t\t// any continuation sections/lines that might have been present. Also note that\n\t\t// by design, phys_line_number will be greater than mCombinedLineNumber whenever\n\t\t// a continuation section/lines were used to build this combined line.\n\n\t\thotstring_start = NULL;\n\t\thotkey_flag = NULL;\n\t\tif (buf[0] == ':' && buf[1])\n\t\t{\n\t\t\thotstring_options = buf + 1; // Point it to the hotstring's option letters, if any.\n\t\t\tif (buf[1] != ':')\n\t\t\t{\n\t\t\t\t// Escape sequences aren't meaningful here; the options always end at the first colon.\n\t\t\t\t// For backward compatibility, the following doesn't use IS_HOTSTRING_OPTION().\n\t\t\t\tif ( !(hotstring_start = _tcschr(hotstring_options, ':')) )\n\t\t\t\t\thotstring_start = NULL; // Indicate that this isn't a hotstring after all.\n\t\t\t\telse\n\t\t\t\t\t++hotstring_start; // Points to the hotstring itself.\n\t\t\t}\n\t\t\telse // Double-colon, so it's a hotstring if there's more after this (but this means no options are present).\n\t\t\t\tif (buf[2])\n\t\t\t\t\thotstring_start = buf + 2;\n\t\t\t\t//else it's just a naked \"::\", which is nothing valid.\n\t\t}\n\n\t\tif (hotstring_start)\n\t\t{\n\t\t\t// Check for 'X' option early since escape sequence processing depends on it.\n\t\t\thotstring_execute = g_HSSameLineAction;\n\t\t\tfor (auto cp = hotstring_options; cp < hotstring_start; ++cp)\n\t\t\t\tif (ctoupper(*cp) == 'X')\n\t\t\t\t{\n\t\t\t\t\thotstring_execute = cp[1] != '0';\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t// Find the hotstring's delimiting double-colon, while considering escape sequences.\n\t\t\t// This is necessary for it to handle cases such as the following:\n\t\t\t// ::abc```:::Replacement String\n\t\t\t// The above hotstring translates literally into \"abc`:\".\n\t\t\t// v2.0: Use the first non-escaped double-colon, not the last, since it seems more likely\n\t\t\t// that the user intends to produce text with \"::\" in it rather than typing \"::\" to trigger\n\t\t\t// the hotstring, and generally the trigger should be short. By contrast, the v1 policy\n\t\t\t// behaved inconsistently with an odd number of colons, such as:\n\t\t\t// ::foo::::bar ; foo:: -> bar\n\t\t\t// ::foo:::bar ; foo -> :bar\n\t\t\tfor (LPTSTR cp = hotstring_start; cp = _tcsstr(cp, HOTKEY_FLAG); ++cp) // Only increment by 1, since colons 2-3 in both `::: and `:::: are the hotkey flag.\n\t\t\t{\n\t\t\t\tif (!CharIsEscaped(cp, hotstring_start))\n\t\t\t\t{\n\t\t\t\t\thotkey_flag = cp;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (!hotkey_flag)\n\t\t\t\thotstring_start = NULL; // Indicate that this isn't a hotstring after all.\n\t\t}\n\t\tif (!hotstring_start) // Not a hotstring (hotstring_start is checked *again* in case above block changed it; otherwise hotkeys like \": & x\" aren't recognized).\n\t\t{\n\t\t\t// Note that there may be an action following the HOTKEY_FLAG (on the same line).\n\t\t\tif (hotkey_flag = _tcsstr(buf, HOTKEY_FLAG)) // Find the first one from the left, in case there's more than 1.\n\t\t\t{\n\t\t\t\tif (hotkey_flag == buf && hotkey_flag[2] == ':') // v1.0.46: Support \":::\" to mean \"colon is a hotkey\".\n\t\t\t\t\t++hotkey_flag;\n\t\t\t\t\t// Above: Hotkeys like \"^:::\" and \"l & :::\" are not supported because: 1) some cases are\n\t\t\t\t\t// ambiguous, such as \"^:::\" legitimately remapping caret to colon; 2) retaining support\n\t\t\t\t\t// for colon as a remap target would require larger/more complicated code; 3) such hotkeys\n\t\t\t\t\t// are hard for a human to read/interpret.\n\t\t\t\t// v1.0.40: It appears to be a hotkey, but validate it as such before committing to processing\n\t\t\t\t// it as a hotkey. If it fails validation as a hotkey, try to interpret it as a statement in\n\t\t\t\t// case the double-colon is within a quoted string.\n\t\t\t\t// Note: Hotstrings can't suffer from this type of ambiguity because a leading colon or pair of\n\t\t\t\t// colons makes them easier to detect.\n\t\t\t\tauto cp = omit_trailing_whitespace(buf, hotkey_flag); // For maintainability.\n\t\t\t\tTCHAR orig_char = *cp;\n\t\t\t\t*cp = '\\0'; // Temporarily terminate.\n\t\t\t\thotkey_validity = Hotkey::TextInterpret(omit_leading_whitespace(buf), NULL); // Passing NULL calls it in validate-only mode.\n\t\t\t\tswitch (hotkey_validity)\n\t\t\t\t{\n\t\t\t\tcase FAIL:\n\t\t\t\t\treturn FAIL; // It's an invalid hotkey and above already displayed the error message.\n\t\t\t\tcase CONDITION_FALSE:\n\t\t\t\t\thotkey_flag = NULL; // It doesn't look like valid hotkey syntax, so parse it as something else (so the error message won't be ERR_INVALID_KEYNAME).\n\t\t\t\t\tbreak;\n\t\t\t\t//case CONDITION_TRUE:\n\t\t\t\t\t// It's a key that doesn't exist on the current keyboard layout. Leave hotkey_flag set\n\t\t\t\t\t// so that the section below handles it as a hotkey. This ensures any same-line action\n\t\t\t\t\t// or trailing block is interpreted correctly. A warning will be displayed below.\n\t\t\t\t}\n\t\t\t\t*cp = orig_char; // Undo the temp. termination above.\n\t\t\t}\n\t\t}\n\n\t\tif (hotkey_flag && hotkey_flag > buf) // It's a hotkey/hotstring label.\n\t\t{\n\t\t\tif (g->CurrentFunc || mClassObjectCount)\n\t\t\t{\n\t\t\t\t// The reason for not allowing hotkeys and hotstrings inside a function's body is that it\n\t\t\t\t// would create a nested function that could be called without ever calling the outer function.\n\t\t\t\t// If the hotkey function became a closure, activating the hotkey would at best merely raise an\n\t\t\t\t// error since it would not be associated with any particular call to the outer function.\n\t\t\t\t// Currently CreateHotFunc() isn't set up to permit it; e.g. it doesn't set mOuterFunc or\n\t\t\t\t// mDownVar, so a hotkey inside a function would reset g->CurrentFunc to nullptr for the\n\t\t\t\t// remainder of the outer function and would crash if the hotkey references any outer vars.\n\t\t\t\treturn ScriptError(_T(\"Hotkeys/hotstrings are not allowed inside functions or classes.\"), buf);\n\t\t\t}\n\n\t\t\t*hotkey_flag = '\\0'; // Terminate so that buf is now the hotkey's name.\n\t\t\thotkey_flag += HOTKEY_FLAG_LENGTH; // Now hotkey_flag is the hotkey's action, if any.\n\t\t\t\n\t\t\tLPTSTR next_nonspace = omit_leading_whitespace(hotkey_flag);\n\t\t\tbool hotkey_uses_otb = *next_nonspace == '{' && !next_nonspace[1]; // Has already been rtrimmed by GetLine().\n\t\t\tif (!hotstring_start || hotstring_execute)\n\t\t\t{\n\t\t\t\t// Mustn't use ltrim(hotkey_flag) because that would cause buf.length to become incorrect:\n\t\t\t\thotkey_flag = next_nonspace;\n\t\t\t}\n\t\t\t// else don't trim auto-replace hotstrings since literal spaces in both substrings are significant.\n\t\t\tHookActionType hook_action; // Becomes valid only when !hotstring_start.\n\t\t\t\n\t\t\tif (hotstring_start)\n\t\t\t{\n\t\t\t\tif (!*hotstring_start)\n\t\t\t\t\treturn ScriptError(_T(\"This hotstring is missing its abbreviation.\"), buf); // Display buf vs. hotkey_flag in case the line is simply \"::::\".\n\t\t\t\t// In the case of hotstrings, hotstring_start is the beginning of the hotstring itself,\n\t\t\t\t// i.e. the character after the second colon. hotstring_options is the first character\n\t\t\t\t// in the options list (which is terminated by a colon). hotkey_flag is blank or the\n\t\t\t\t// hotstring's auto-replace text or same-line action.\n\t\t\t\t// v1.0.42: Unlike hotkeys, duplicate hotstrings are not detected. This is because\n\t\t\t\t// hotstrings are less commonly used and also because it requires more code to find\n\t\t\t\t// hotstring duplicates (and performs a lot worse if a script has thousands of\n\t\t\t\t// hotstrings) because of all the hotstring options.\n\n\t\t\t\tif (hotkey_uses_otb)\n\t\t\t\t{\n\t\t\t\t\t// Never use otb if text or raw mode is in effect for this hotstring.\n\t\t\t\t\t// Either explicitly or via #hotstring.\n\t\t\t\t\tbool uses_text_or_raw_mode = g_HSSendRaw;\n\t\t\t\t\tfor (LPTSTR cp = hotstring_options; cp < hotstring_start; ++cp)\n\t\t\t\t\t\tswitch (ctoupper(*cp))\n\t\t\t\t\t\t{\n\t\t\t\t\t\tcase 'T':\n\t\t\t\t\t\tcase 'R':\n\t\t\t\t\t\t\tuses_text_or_raw_mode = cp[1] != '0';\n\t\t\t\t\t\t}\n\t\t\t\t\tif (uses_text_or_raw_mode)\n\t\t\t\t\t\thotkey_uses_otb = false;\n\t\t\t\t}\n\n\t\t\t\tLPCTSTR replacement;\n\n\t\t\t\t// The hotstring never uses otb if it uses X or T options (either explicitly or via #hotstring).\n\t\t\t\tif (!*hotkey_flag || hotkey_uses_otb || hotstring_execute)\n\t\t\t\t{\n\t\t\t\t\t// It is not auto-replace\n\t\t\t\t\treplacement = nullptr;\n\t\t\t\t}\n\t\t\t\telse if (mPendingHotkey)\n\t\t\t\t{\n\t\t\t\t\t// It is autoreplace but an earlier hotkey or hotstring is \"stacked\" above. Treat it\n\t\t\t\t\t// as an error as it doesn't make sense. Otherwise one could write something like:\n\t\t\t\t\t/*\n\t\t\t\t\t::abc::\n\t\t\t\t\t::def::text\n\t\t\t\t\tx::action\n\t\t\t\t\t which would work as,\n\t\t\t\t\t::def::text\n\t\t\t\t\t::abc::\n\t\t\t\t\tx::action\n\t\t\t\t\t*/\n\t\t\t\t\t// Note that if it is \":X:def::action\" instead, we do not end up here and \"::abc::\"\n\t\t\t\t\t// will also trigger \"action\". The line number determined below may be incorrect,\n\t\t\t\t\t// but is better than reporting the line of this autoreplace hotstring.\n\t\t\t\t\tmCombinedLineNumber--;\n\t\t\t\t\treturn ScriptError(ERR_HOTKEY_MISSING_BRACE, mPendingHotkey);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\treplacement = hotkey_flag;\n\t\t\t\t\n\t\t\t\tConvertEscapeSequences(hotstring_start);\n\t\t\t\tif (replacement)\n\t\t\t\t\tConvertEscapeSequences(hotkey_flag);\n\n\t\t\t\tif (!Hotstring::AddHotstring(buf, nullptr, hotstring_options, hotstring_start, replacement, has_continuation_section))\n\t\t\t\t\treturn FAIL;\n\t\t\t\tif (replacement)\n\t\t\t\t\tgoto continue_main_loop;\n\t\t\t\tmPendingHotkey = Hotstring::shs[Hotstring::sHotstringCount-1]->mName; // For error-reporting.\n\t\t\t}\n\t\t\telse // It's a hotkey vs. hotstring.\n\t\t\t{\n\t\t\t\t// To use '{' as remap_dest, escape it.\n\t\t\t\tif (hotkey_flag[0] == g_EscapeChar && hotkey_flag[1] == '{')\n\t\t\t\t\thotkey_flag++;\n\n\t\t\t\tauto remap_name = hotkey_flag; // Set default, conditionally overridden below (v1.0.44.07).\n\t\t\t\tvk_type remap_dest_vk;\n\t\t\t\t// v1.0.40: Check if this is a remap rather than hotkey:\n\t\t\t\tif (!hotkey_uses_otb \n\t\t\t\t\t&& *hotkey_flag // This hotkey's action is on the same line as its trigger definition.\n\t\t\t\t\t&& (remap_dest_vk = remap_name[1] ? TextToVK(remap_name = const_cast<LPTSTR>(Hotkey::TextToModifiers(hotkey_flag, NULL))) : 0xFF) ) // And the action appears to be a remap destination rather than a command.\n\t\t\t\t\t// For above:\n\t\t\t\t\t// Fix for v1.0.44.07: Set remap_dest_vk to 0xFF if hotkey_flag's length is only 1 because:\n\t\t\t\t\t// 1) It allows a destination key that doesn't exist in the keyboard layout (such as 6::ð in\n\t\t\t\t\t// English).\n\t\t\t\t\t// 2) It improves performance a little by not calling TextToVK except when the destination key\n\t\t\t\t\t// might be a mouse button or some longer key name whose actual/correct VK value is relied\n\t\t\t\t\t// upon by other places below.\n\t\t\t\t{\n\t\t\t\t\tauto result = ParseRemap(buf, remap_dest_vk, remap_name, hotkey_flag);\n\t\t\t\t\tif (!result)\n\t\t\t\t\t\treturn result;\n\t\t\t\t\tif (result != CONDITION_FALSE)\n\t\t\t\t\t\tgoto continue_main_loop;\n\t\t\t\t\t// Since above didn't goto this is not a remap after all:\n\t\t\t\t}\n\n\t\t\t\tUCHAR no_suppress;\n\t\t\t\tbool hook_is_mandatory;\n\t\t\t\thook_action = Hotkey::ConvertAltTab(hotkey_flag, false);\n\t\t\t\tauto hk = Hotkey::FindHotkeyByTrueNature(buf, no_suppress, hook_is_mandatory);\n\t\t\t\tif (hk) // Parent hotkey found. Add a child/variant hotkey for it.\n\t\t\t\t{\n\t\t\t\t\tif (hook_action) // no_suppress has always been ignored for these types (alt-tab hotkeys).\n\t\t\t\t\t{\n\t\t\t\t\t\t// Hotkey::Dynamic() contains logic and comments similar to this, so maintain them together.\n\t\t\t\t\t\t// An attempt to add an alt-tab variant to an existing hotkey. This might have\n\t\t\t\t\t\t// merit if the intention is to make it alt-tab now but to later disable that alt-tab\n\t\t\t\t\t\t// aspect via the Hotkey cmd to let the context-sensitive variants shine through\n\t\t\t\t\t\t// (take effect).\n\t\t\t\t\t\thk->mHookAction = hook_action;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\t// Detect duplicate hotkey variants to help spot bugs in scripts.\n\t\t\t\t\t\tif (hk->FindVariant()) // See if there's already a variant matching the current criteria (no_suppress does not make variants distinct form each other because it would require firing two hotkey IDs in response to pressing one hotkey, which currently isn't in the design).\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tmCurrLine = NULL; // Prevents showing unhelpful vicinity lines.\n\t\t\t\t\t\t\treturn ScriptError(_T(\"Duplicate hotkey.\"), buf);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (!hk->AddVariant(nullptr, no_suppress))\n\t\t\t\t\t\t\treturn ScriptError(ERR_OUTOFMEM, buf);\n\t\t\t\t\t\tif (hook_is_mandatory || g_ForceKeybdHook)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// Require the hook for all variants of this hotkey if any variant requires it.\n\t\t\t\t\t\t\t// This seems more intuitive than the old behaviour, which required $ or #UseHook\n\t\t\t\t\t\t\t// to be used on the *first* variant, even though it affected all variants.\n\t\t\t\t\t\t\thk->mKeybdHookMandatory = true;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\telse // No parent hotkey yet, so create it.\n\t\t\t\t{\n\t\t\t\t\tif (hook_action != HK_NORMAL && mPendingHotkey)\n\t\t\t\t\t\t// A hotkey is stacked above, eg,\n\t\t\t\t\t\t// x::\n\t\t\t\t\t\t// y & z::altTab\n\t\t\t\t\t\t// Not supported.\n\t\t\t\t\t\treturn ScriptError(ERR_HOTKEY_MISSING_BRACE, mPendingHotkey);\n\t\t\t\t\t\n\t\t\t\t\thk = Hotkey::AddHotkey(nullptr, hook_action, buf, no_suppress);\n\t\t\t\t\tif (!hk)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (hotkey_validity != CONDITION_TRUE)\n\t\t\t\t\t\t\treturn FAIL; // It already displayed the error.\n\t\t\t\t\t\t// This hotkey uses a single-character key name, which could be valid on some other\n\t\t\t\t\t\t// keyboard layout. Allow the script to start, but warn the user about the problem.\n#ifndef AUTOHOTKEYSC\n\t\t\t\t\t\tif (!mValidateThenExit) // Current keyboard layout is not relevant in /validate mode.\n#endif\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tTCHAR msg_text[128];\n\t\t\t\t\t\t\tsntprintf(msg_text, _countof(msg_text), _T(\"Note: The hotkey %s will not be active because it does not exist in the current keyboard layout.\"), static_cast<LPTSTR>(buf));\n\t\t\t\t\t\t\tMsgBox(msg_text);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (hook_action == HK_NORMAL && hk) // For simplicity, there's no detection of invalid stacking of \"inactive\" single-letter hotkeys (see above).\n\t\t\t\t\tmPendingHotkey = hk->mName;\n\t\t\t}\n\t\t\tif (*hotkey_flag) // This hotkey's/hotstring's action is on the same line as its label.\n\t\t\t{\n\t\t\t\tif (hotkey_uses_otb) {\n\t\t\t\t\t// x::{\n\t\t\t\t\t//\t; code\n\t\t\t\t\t// }\n\t\t\t\t\tif (!AddLine(ACT_BLOCK_BEGIN))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t}\n\t\t\t\t// Don't add AltTab or similar as a line, since it has no meaning as a script command.\n\t\t\t\telse if (hotstring_start ? hotstring_execute : !hook_action)\n\t\t\t\t{\n\t\t\t\t\t// Eg, \":X:abc::msgbox\" or \"x::msgbox\", \n\t\t\t\t\t// x::\n\t\t\t\t\t// {\n\t\t\t\t\t// msgbox\n\t\t\t\t\t// }\n\t\t\t\t\t// Remove the hotkey from buf.\n\t\t\t\t\tbuf_length -= hotkey_flag - buf;\n\t\t\t\t\ttmemmove(buf, hotkey_flag, buf_length);\n\t\t\t\t\tbuf[buf_length] = '\\0';\n\t\t\t\t\t// Before adding the line, apply expression line-continuation logic, which hasn't\n\t\t\t\t\t// been applied yet because hotkey labels can contain unbalanced ()[]{}:\n\t\t\t\t\tif (!GetLineContExpr(fp, buf, next_buf, phys_line_number, has_continuation_section))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\tif (IsFunctionDefinition(buf, next_buf)) // x::y(ThisHotkey){\n\t\t\t\t\t\tgoto process_completed_line;\n\t\t\t\t\tauto open_block = mLineParent;\n\t\t\t\t\tif (!ParseAndAddLineInBlock(buf)) // Function body - one line\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\tif (open_block != mLineParent) // key::try { or similar.\n\t\t\t\t\t{\n\t\t\t\t\t\tmCurrLine = nullptr;\n\t\t\t\t\t\treturn ScriptError(ERR_HOTKEY_MISSING_BRACE);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tgoto continue_main_loop; // In lieu of \"continue\", for performance.\n\t\t} // if (hotkey_flag && hotkey_flag > buf)\n\n\t\t// Otherwise, not a hotkey or hotstring. Check if it's a generic, non-hotkey label:\n\t\tif (buf[buf_length - 1] == ':' // Labels must end in a colon (buf was previously rtrimmed).\n\t\t\t&& (!mClassObjectCount || g->CurrentFunc)) // Not directly inside a class body or property definition (but inside a method is okay).\n\t\t{\n\t\t\t// Labels (except hotkeys) must contain no whitespace, delimiters, or escape-chars.\n\t\t\t// This is to avoid problems where a legitimate action-line ends in a colon,\n\t\t\t// such as \"#Include c:\", and for sanity (so labels can be readily recognized).\n\t\t\t// We allow hotkeys to violate this since they may contain commas, but they must\n\t\t\t// also be a valid combination of symbols and key names, so there is no ambiguity.\n\t\t\t// v2.0: Require label names to use the same set of characters as other identifiers.\n\t\t\t// Aside from consistency and ensuring readability, this might enable future changes\n\t\t\t// to the parser or new syntax.\n\t\t\tauto cp = find_identifier_end<LPTSTR>(buf);\n\t\t\tif ((cp - buf + 1) == buf_length && cp > buf)\n\t\t\t{\n\t\t\t\tbuf[--buf_length] = '\\0'; // Remove the trailing colon.\n\t\t\t\tif (!_tcsicmp(buf, _T(\"Default\")) && mLineParent && mLineParent->mPrevLine // \"Default:\" case.\n\t\t\t\t\t&& mLineParent->mPrevLine->mActionType == ACT_SWITCH) // It's a normal label in any other case.\n\t\t\t\t{\n\t\t\t\t\tif (!AddLine(ACT_CASE))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tif (mPendingHotkey) // It is a label in a \"stack\" of hotkeys.\n\t\t\t\t\t\treturn ScriptError(ERR_HOTKEY_MISSING_BRACE, mPendingHotkey);\n\t\t\t\t\tif (!AddLabel(buf, false))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t}\n\t\t\t\tgoto continue_main_loop; // In lieu of \"continue\", for performance.\n\t\t\t}\n\t\t}\n\t\t// Since above didn't \"goto\", it's not a label.\n\t\tif (*buf == '#')\n\t\t{\n\t\t\tif (!_tcsnicmp(buf, _T(\"#HotIf\"), 6) && IS_SPACE_OR_TAB(buf[6]))\n\t\t\t{\n\t\t\t\t// Allow an expression enclosed in ()/[]/{} to span multiple lines:\n\t\t\t\tif (!GetLineContExpr(fp, buf, next_buf, phys_line_number, has_continuation_section))\n\t\t\t\t\treturn FAIL;\n\t\t\t}\n\t\t\tauto saved_line_number = mCombinedLineNumber; // Backup in case IsDirective() processes an include file, which would change mCombinedLineNumber's value.\n\t\t\tswitch(IsDirective(buf)) // Note that it may alter the contents of buf\n\t\t\t{\n\t\t\tcase CONDITION_TRUE:\n\t\t\t\t// Since the directive may have been a #include which called us recursively,\n\t\t\t\t// restore the class's values for these two, which are maintained separately\n\t\t\t\t// like this to avoid having to specify them in various calls, especially the\n\t\t\t\t// hundreds of calls to ScriptError() and LineError():\n\t\t\t\tmCurrFileIndex = source_file_index;\n\t\t\t\tmCombinedLineNumber = saved_line_number;\n\t\t\t\tgoto continue_main_loop; // In lieu of \"continue\", for performance.\n\t\t\tcase FAIL: // IsDirective() already displayed the error.\n\t\t\t\treturn FAIL;\n\t\t\t//case CONDITION_FALSE: Do nothing; let processing below handle it.\n\t\t\t}\n\t\t}\n\t\t// Otherwise, treat it as a normal script line.\n\n\t\tif (*buf == '{' || *buf == '}')\n\t\t{\n\t\t\tif (mClassObjectCount && !g->CurrentFunc)\n\t\t\t{\n\t\t\t\tif (*buf == '{')\n\t\t\t\t\treturn ScriptError(ERR_UNEXPECTED_OPEN_BRACE, buf);\n\n\t\t\t\tif (mClassProperty)\n\t\t\t\t{\n\t\t\t\t\t// Close this property definition.\n\t\t\t\t\tmClassProperty = NULL;\n\t\t\t\t\tif (mClassPropertyDef)\n\t\t\t\t\t{\n\t\t\t\t\t\tfree(mClassPropertyDef);\n\t\t\t\t\t\tmClassPropertyDef = NULL;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// End of class definition.\n\t\t\t\t\t--mClassObjectCount;\n\t\t\t\t\tmClassObject[mClassObjectCount]->EndClassDefinition(); // Remove instance variables from the class object.\n\t\t\t\t\tmClassObject[mClassObjectCount]->Release();\n\t\t\t\t\t// Revert to the name of the class this class is nested inside, or \"\" if none.\n\t\t\t\t\tif (auto cp1 = _tcsrchr(mClassName, '.'))\n\t\t\t\t\t\t*cp1 = '\\0';\n\t\t\t\t\telse\n\t\t\t\t\t\t*mClassName = '\\0';\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // Normal block begin/end.\n\t\t\t{\n\t\t\t\tif (!AddLine(*buf == '{' ? ACT_BLOCK_BEGIN : ACT_BLOCK_END))\n\t\t\t\t\treturn FAIL;\n\t\t\t\tif (mExprContainingThisFunc && *buf != '{' && mLastLine->mAttribute == mExprContainingThisFunc->func)\n\t\t\t\t{\n\t\t\t\t\tif (IS_IDENTIFIER_CHAR(buf[1])) // Prevent (a(){...}b) from producing (ab).\n\t\t\t\t\t\treturn ScriptError(ERR_EXPR_SYNTAX, buf);\n\t\t\t\t\tauto expr = mExprContainingThisFunc;\n\t\t\t\t\t// expr contains some code and parser state that was saved when a function definition\n\t\t\t\t\t// was encountered by ParseAndAddLine(). expr->code includes up to (and including)\n\t\t\t\t\t// the function name. Append this current line to form the final expression (unless\n\t\t\t\t\t// there's another function definition, in which case, rinse and repeat).\n\t\t\t\t\t// A special marker is inserted so that ParseOperands() can reference the function.\n\t\t\t\t\tsize_t extra = FDE_SUBSTITUTE_STRING_LENGTH;\n\t\t\t\t\tif (!buf.EnsureCapacity(--buf_length + expr->length + extra))\n\t\t\t\t\t\treturn MemoryError();\n\t\t\t\t\ttmemmove(buf + expr->length + extra, buf + 1, buf_length + 1);\n\t\t\t\t\ttmemmove(buf, expr->code, expr->length);\n\t\t\t\t\ttmemmove(buf + expr->length, FDE_SUBSTITUTE_STRING, extra);\n\t\t\t\t\tbuf_length += expr->length + extra;\n\t\t\t\t\tmCombinedLineNumber = expr->line_no;\n\t\t\t\t\tmCurrLine = NULL; // See comments below.\n\t\t\t\t\tmExprContainingThisFunc = expr->outer;\n\t\t\t\t\tif (!GetLineContExpr(fp, buf, next_buf, phys_line_number, has_continuation_section))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\tif (!expr->action && IsFunctionDefinition(buf, next_buf))\n\t\t\t\t\t{\n\t\t\t\t\t\tif (!DefineFunc(buf))\n\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\tif ( !ParseAndAddLine(buf, expr->action)\n\t\t\t\t\t\t\t|| expr->add_block_end_after && !AddLine(ACT_BLOCK_END) )\n\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t}\n\t\t\t\t\tif (mExprContainingThisFunc != expr->outer) // (f1(){},f2(){}) or f2(a:=f1(){}){}\n\t\t\t\t\t{\n\t\t\t\t\t\tmExprContainingThisFunc->pending_hotkey = expr->pending_hotkey;\n\t\t\t\t\t\tmExprContainingThisFunc->rejoin_first_line = expr->rejoin_first_line;\n\t\t\t\t\t\tmExprContainingThisFunc->rejoin_last_line = expr->rejoin_last_line;\n\t\t\t\t\t}\n\t\t\t\t\telse if (expr->pending_hotkey) // #HotIf fn(){}\n\t\t\t\t\t{\n\t\t\t\t\t\tmPendingHotkey = expr->pending_hotkey;\n\t\t\t\t\t\tASSERT(expr->func->mOuterFunc->mJumpToLine->mActionType == ACT_HOTKEY_IF);\n\t\t\t\t\t\texpr->func->mOuterFunc->mJumpToLine->mAttribute = g->HotCriterion;\n\t\t\t\t\t}\n\t\t\t\t\telse if (expr->rejoin_first_line) // Used by DefineClassVarInit().\n\t\t\t\t\t{\n\t\t\t\t\t\tmLastLine->mNextLine = expr->rejoin_first_line;\n\t\t\t\t\t\texpr->rejoin_first_line->mPrevLine = mLastLine;\n\t\t\t\t\t\tg->CurrentFunc = nullptr;\n\t\t\t\t\t\tmLastLine = expr->rejoin_last_line;\n\t\t\t\t\t\tif (mLastLine->mActionType == ACT_BLOCK_END)\n\t\t\t\t\t\t\tmPendingRelatedLine = mLastLine->mParentLine;\n\t\t\t\t\t}\n\t\t\t\t\tdelete expr;\n\t\t\t\t\tgoto continue_main_loop;\n\t\t\t\t}\n\t\t\t}\n\t\t\t// Allow the remainder of the line to be treated as a separate line:\n\t\t\tLPTSTR cp = omit_leading_whitespace(buf + 1);\n\t\t\tif (*cp)\n\t\t\t{\n\t\t\t\tbuf_length -= (cp - buf);\n\t\t\t\ttmemmove(buf, cp, buf_length + 1);\n\t\t\t\tmCurrLine = NULL; // To signify that we're in transition, trying to load a new line.\n\t\t\t\tgoto process_completed_line; // Have the main loop process the contents of \"buf\" as though it came in from the script.\n\t\t\t}\n\t\t\tgoto continue_main_loop; // It's just a naked \"{\" or \"}\", so no more processing needed for this line.\n\t\t}\n\n\t\t// Handle this first so that GetLineContExpr() doesn't need to detect it for OTB exclusion:\n\t\tTCHAR class_export_type = 0;\n\t\tif (LPTSTR class_name = IsClassDefinition(buf, mClassObjectCount ? nullptr : &class_export_type))\n\t\t{\n\t\t\tif (g->CurrentFunc)\n\t\t\t\treturn ScriptError(_T(\"Functions cannot contain classes.\"), buf);\n\t\t\tif (!ClassHasOpenBrace(buf, buf_length, next_buf, next_buf_length))\n\t\t\t\treturn ScriptError(ERR_MISSING_OPEN_BRACE, buf);\n\t\t\tif (!DefineClass(class_name, class_export_type))\n\t\t\t\treturn FAIL;\n\t\t\tgoto continue_main_loop;\n\t\t}\n\n\t\t// Aside from goto/break/continue, anything not already handled above is either an expression\n\t\t// or something with similar lexical requirements (i.e. balanced parentheses/brackets/braces).\n\t\t// The following call allows any expression enclosed in ()/[]/{} to span multiple lines:\n\t\tif (!GetLineContExpr(fp, buf, next_buf, phys_line_number, has_continuation_section))\n\t\t\treturn FAIL;\n\n\t\tif (mClassProperty && !g->CurrentFunc) // This is checked before IsFunction() to prevent method definitions inside a property.\n\t\t{\n\t\t\tif (!_tcsnicmp(buf, _T(\"Get\"), 3) || !_tcsnicmp(buf, _T(\"Set\"), 3))\n\t\t\t{\n\t\t\t\tLPTSTR cp = omit_leading_whitespace(buf + 3);\n\t\t\t\tif (!*cp && *next_buf == '{' // Brace on next line\n\t\t\t\t\t|| *cp == '{' && !cp[1] // Brace on this line\n\t\t\t\t\t|| *cp == '=' && cp[1] == '>') // => expr\n\t\t\t\t{\n\t\t\t\t\tLPTSTR dot = _tcschr(mClassPropertyDef, '.');\n\t\t\t\t\tdot[1] = *buf; // Replace the x in property.xet(params).\n\t\t\t\t\tif (!DefineClassPropertyXet(buf, cp))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\tgoto continue_main_loop;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn ScriptError(ERR_INVALID_LINE_IN_PROPERTY_DEF, buf);\n\t\t}\n\n\t\tif (mClassObjectCount && !g->CurrentFunc) // Inside a class definition (and not inside a method).\n\t\t{\n\t\t\tLPTSTR id = buf;\n\t\t\tbool is_static = false;\n\t\t\tif (!_tcsnicmp(id, _T(\"Static\"), 6) && IS_SPACE_OR_TAB(id[6]))\n\t\t\t{\n\t\t\t\tid = omit_leading_whitespace(id + 7);\n\t\t\t\tif (IS_IDENTIFIER_CHAR(*id))\n\t\t\t\t\tis_static = true;\n\t\t\t\telse\n\t\t\t\t\tid = buf;\n\t\t\t}\n\t\t\tif (IsFunctionDefinition(id, next_buf))\n\t\t\t{\n\t\t\t\tif (!DefineFunc(id, is_static))\n\t\t\t\t\treturn FAIL;\n\t\t\t\tgoto continue_main_loop;\n\t\t\t}\n\t\t\tLPCTSTR cp;\n\t\t\tfor (cp = id; IS_IDENTIFIER_CHAR(*cp) || *cp == '.'; ++cp);\n\t\t\tif (cp > id) // i.e. buf begins with an identifier.\n\t\t\t{\n\t\t\t\tcp = omit_leading_whitespace(cp);\n\t\t\t\tif (*cp == ':') // This is a value property declaration (name := initializer, name : type).\n\t\t\t\t{\n\t\t\t\t\tif (!DefineClassVars(id, is_static))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\tgoto continue_main_loop;\n\t\t\t\t}\n\t\t\t\tif (!*cp || *cp == '[' || *cp == '{' || (*cp == '=' && cp[1] == '>')) // Property or invalid.\n\t\t\t\t{\n\t\t\t\t\tbool buf_has_brace;\n\t\t\t\t\tif (!DefineClassProperty(id, is_static, buf_has_brace))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\tif (!buf_has_brace)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (*next_buf != '{')\n\t\t\t\t\t\t\treturn ScriptError(ERR_UNRECOGNIZED_ACTION, buf); // Vague message because user's intention is unknown.\n\t\t\t\t\t\tRemoveBufChar0(next_buf, next_buf_length);\n\t\t\t\t\t}\n\t\t\t\t\tgoto continue_main_loop;\n\t\t\t\t}\n\t\t\t}\n\t\t\t// Anything not already handled above is not valid directly inside a class definition.\n\t\t\treturn ScriptError(ERR_INVALID_LINE_IN_CLASS_DEF, buf);\n\t\t}\n\t\telse if (IsFunctionDefinition(buf, next_buf))\n\t\t{\n\t\t\tif (!DefineFunc(buf))\n\t\t\t\treturn FAIL;\n\t\t\tgoto continue_main_loop;\n\t\t}\n\t\telse if (!mLineParent && !_tcsnicmp(buf, _T(\"Import\"), 6) && IS_SPACE_OR_TAB(buf[6]))\n\t\t{\n\t\t\tif (!ParseImportStatement(buf + 7))\n\t\t\t\treturn FAIL;\n\t\t\tgoto continue_main_loop;\n\t\t}\n\n\t\t// Parse the command, assignment or expression, including any same-line open brace or sub-action\n\t\t// for ELSE, TRY, CATCH or FINALLY. Unlike braces at the start of a line (processed above), this\n\t\t// does not allow directives or labels to the right of the command.\n\t\tif (!ParseAndAddLine(buf))\n\t\t\treturn FAIL;\n\ncontinue_main_loop: // This method is used in lieu of \"continue\" for performance and code size reduction.\n\t\t// Since above didn't \"continue\", resume loading script line by line:\n\t\tswap(buf.p, next_buf.p);\n\t\tswap(buf.size, next_buf.size);\n\t\tbuf_length = next_buf_length;\n\t\t// The lines above alternate buffers (toggles next_buf to be the unused buffer), which helps\n\t\t// performance because it avoids memcpy from buf2 to buf1.\n\t} // for each whole/constructed line.\n\n\t// The following checks detect errors where a \"}\" was missed or there's an If/Else/etc.\n\t// or hotkey at the end of the file with no corresponding body. Although it's possible\n\t// that another file might follow this one and fill in the missing part, it's much more\n\t// likely to be an error. blocks_previously_open is checked rather than source_file_index\n\t// so that errors in auto-includes are detected.\n\t\n\tif (mLineParent && mLineParent->mActionType != ACT_BLOCK_BEGIN) // If, Else, Loop, etc. without a block or action.\n\t\treturn mLineParent->LineUnexpectedError();\n\n\tif (!blocks_previously_open && (mLineParent || mClassObjectCount))\n\t{\n\t\tif (mLineParent)\n\t\t\treturn mLineParent->LineError(ERR_MISSING_CLOSE_BRACE);\n\t\t// A class definition has not been closed with \"}\". Previously this was detected by adding\n\t\t// the open and close braces as lines, but this way is simpler and has less overhead.\n\t\t// The downside is that the line number won't be shown; however, the class name will.\n\t\t// Seems okay not to show mClassProperty->mName since the class is missing \"}\" as well.\n\t\treturn ScriptError(ERR_MISSING_CLOSE_BRACE, mClassName);\n\t}\n\n\tif (mPendingHotkey)\n\t\treturn ScriptError(ERR_HOTKEY_MISSING_BRACE, mPendingHotkey);\n\n\t// Detect a common cause of issues with non-ASCII characters: file saved as ANSI but read as UTF-8.\n\t// As UTF-8 is recommended and is nearly always the default, it is referenced directly in the message.\n\t// For code size and due to rarity, setting a different default with /CP disables the warning rather\n\t// than changing the message to be accurate or implying that a BOM is required (it normally isn't).\n\tif (fp->DecodingErrors() && fp->GetCodePage() == CP_UTF8)\n\t{\n\t\tmCurrLine = nullptr;\n\t\tmCombinedLineNumber = 0;\n\t\tScriptWarning(g_WarnMode, _T(\"Some non-ASCII characters could not be decoded.\\n\\nEnsure that the file is saved as UTF-8.\"));\n\t}\n\n\t++mCombinedLineNumber; // L40: Put the implicit ACT_EXIT on the line after the last physical line (for the debugger).\n\treturn OK;\n}\n\n\n\nResultType Script::ParseRemap(LPCTSTR aSource, vk_type remap_dest_vk, LPCTSTR aDestName, LPCTSTR aDestMods)\n{\n\tTCHAR remap_source[32], remap_dest[32], remap_dest_modifiers[8]; // Must fit the longest key name (currently Browser_Favorites [17]), but buffer overflow is checked just in case.\n\tLPCTSTR cp1;\n\tauto remap_source_vk = TextToVK(cp1 = Hotkey::TextToModifiers(aSource, NULL)); // An earlier stage verified that it's a valid hotkey, though VK could be zero.\n\tbool remap_source_is_combo = _tcsstr(cp1, COMPOSITE_DELIMITER);\n\tbool remap_source_is_mouse = IsMouseVK(remap_source_vk);\n\tbool remap_dest_is_mouse = IsMouseVK(remap_dest_vk);\n\tbool remap_keybd_to_mouse = !remap_source_is_mouse && remap_dest_is_mouse;\n\tbool remap_wheel = IS_WHEEL_VK(remap_source_vk) || IS_WHEEL_VK(remap_dest_vk);\n\tsntprintf(remap_source, _countof(remap_source), _T(\"%s%s%s\")\n\t\t, remap_source_is_combo ? _T(\"\") : _T(\"*\") // v1.1.27.01: Omit * when the remap source is a custom combo.\n\t\t, _tcslen(cp1) == 1 && IsCharUpper(*cp1) ? _T(\"+\") : _T(\"\") // Allow A::b to be different than a::b.\n\t\t, aSource); // Include any modifiers too, e.g. ^b::c.\n\tif (*aDestName == '\"' || *aDestName == g_EscapeChar) // Need to escape these.\n\t{\n\t\t*remap_dest = g_EscapeChar;\n\t\tremap_dest[1] = *aDestName;\n\t\tremap_dest[2] = '\\0';\n\t}\n\telse\n\t\ttcslcpy(remap_dest, aDestName, _countof(remap_dest)); // But exclude modifiers here; they're wanted separately.\n\ttcslcpy(remap_dest_modifiers, aDestMods, min(_countof(remap_dest_modifiers), aDestName - aDestMods + 1));\n\n\tif (remap_dest_vk == VK_PAUSE\n\t\t&& !*remap_dest_modifiers // If modifiers are present, it can't be a call to the Pause function.\n\t\t&& (!_tcsicmp(remap_dest, _T(\"Pause\")))) // Specifically \"Pause\", not \"vk13\".\n\t{\n\t\t// Pause is excluded because it is more common to create a hotkey to pause the script than\n\t\t// to remap something to the Pause/Break key, and that's how it was in v1. Any other key\n\t\t// names are interpreted as remapping even if the user defines a function with that name.\n\t\t// Doing otherwise would be complicated and probably undesirable.\n\t\treturn CONDITION_FALSE;\n\t}\n\n\t// It is a remapping. Create one \"down\" and one \"up\" hotkey,\n\t// eg, \"x::y\" yields,\n\t// *x::\n\t// {\n\t// SetKeyDelay(-1), Send(\"{Blind}{y DownR}\")\n\t// }\n\t// *x up::\n\t// {\n\t// SetKeyDelay(-1), Send(\"{Blind}{y Up}\")\n\t// }\n\t// Using one line to facilitate code.\n\n\t// For remapping, decided to use a \"macro expansion\" approach because I think it's considerably\n\t// smaller in code size and complexity than other approaches would be. I originally wanted to\n\t// do it with the hook by changing the incoming event prior to passing it back out again (for\n\t// example, a::b would transform an incoming 'a' keystroke into 'b' directly without having\n\t// to suppress the original keystroke and simulate a new one). Unfortunately, the low-level\n\t// hooks apparently do not allow this. Here is the test that confirmed it:\n\t// if (event.vkCode == 'A')\n\t// {\n\t//\tevent.vkCode = 'B';\n\t//\tevent.scanCode = 0x30; // Or use vk_to_sc(event.vkCode).\n\t//\treturn CallNextHookEx(g_KeybdHook, aCode, wParam, lParam);\n\t// }\n\n\tif (mPendingHotkey)\n\t\t// Checking this to disallow stacking, eg\n\t\t// x::\n\t\t// y::z\n\t\t// which would cause x:: to just do the \"down\"\n\t\t// part of y::z.\n\t\treturn ScriptError(ERR_HOTKEY_MISSING_BRACE, mPendingHotkey);\n\n\tauto make_remap_hotkey = [&](LPTSTR aKey)\n\t\t{\n\t\t\tauto func = CreateHotFunc();\n\t\t\tif (!func)\n\t\t\t\treturn FAIL;\n\t\t\tUCHAR no_suppress;\n\t\t\tbool hook_is_mandatory;\n\t\t\tauto hk = Hotkey::FindHotkeyByTrueNature(aKey, no_suppress, hook_is_mandatory);\n\t\t\tif (hk)\n\t\t\t{\n\t\t\t\tif (!hk->AddVariant(func, no_suppress))\n\t\t\t\t\treturn FAIL;\n\t\t\t}\n\t\t\telse if (!Hotkey::AddHotkey(func, HK_NORMAL, aKey, no_suppress))\n\t\t\t\treturn FAIL;\n\t\t\treturn OK;\n\t\t};\n\t// Start with the \"down\" hotkey:\n\tif (!make_remap_hotkey(remap_source))\n\t\treturn FAIL;\n\n\tTCHAR remap_buf[LINE_SIZE];\n\tauto cp = remap_buf;\n\tcp += _stprintf(cp\n\t\t, _T(\"%s(-1),\") // Does NOT need to be \"-1, -1\" for SetKeyDelay (see below).\n\t\t, remap_dest_is_mouse ? _T(\"SetMouseDelay\") : _T(\"SetKeyDelay\") // Using the full function names vs. Set%sDelay might help size due to string pooling.\n\t);\n\t// It seems unnecessary to set press-duration to -1 even though the auto-exec section might\n\t// have set it to something higher than -1 because:\n\t// 1) Press-duration doesn't apply to normal remappings since they use down-only and up-only events.\n\t// 2) Although it does apply to remappings such as a::B and a::^b (due to press-duration being\n\t// applied after a change to modifier state), those remappings are fairly rare and supporting\n\t// a non-negative-one press-duration (almost always 0) probably adds a degree of flexibility\n\t// that may be desirable to keep.\n\t// 3) SendInput may become the predominant SendMode, so press-duration won't often be in effect anyway.\n\t// 4) It has been documented that remappings use the auto-execute section's press-duration.\n\t// The primary reason for adding Key/MouseDelay -1 is to minimize the chance that a one of\n\t// these hotkey threads will get buried under some other thread such as a timer, which\n\t// would disrupt the remapping if #MaxThreadsPerHotkey is at its default of 1.\n\tif (remap_keybd_to_mouse && !remap_wheel)\n\t{\n\t\t// Since source is keybd and dest is mouse, prevent keyboard auto-repeat from auto-repeating\n\t\t// the mouse button (since that would be undesirable 90% of the time). This is done\n\t\t// by inserting a single extra IF-statement above the Send that produces the down-event:\n\t\tcp += _stprintf(cp, _T(\"!GetKeyState(\\\"%s\\\")&&\"), remap_dest); // Should be no risk of buffer overflow due to prior validation.\n\t}\n\t// Otherwise, remap_keybd_to_mouse==false.\n\n\tTCHAR blind_mods[17], *next_blind_mod = blind_mods;\n\tconst auto mod_string = MODLR_STRING;\n\tauto &hk = *Hotkey::shk[Hotkey::sHotkeyCount - 1];\n\tfor (int i = 0; i < 8; ++i)\n\t\tif (hk.mModifiersConsolidatedLR & (1 << i))\n\t\t\tif (!_tcschr(remap_dest_modifiers, mod_string[i*2+1])) // This works around an issue with {Blind+}+x releasing RShift to press LShift.\n\t\t\t{\n\t\t\t\t*next_blind_mod++ = mod_string[i*2]; // < or >\n\t\t\t\t*next_blind_mod++ = mod_string[i*2+1]; // One of ^!+#\n\t\t\t}\n\t*next_blind_mod = '\\0';\n\tLPTSTR extra_event = _T(\"\"); // Set default.\n\tcp += _stprintf(cp\n\t\t, _T(\"Send(\\\"{Blind%s}%s%s{%s%s}\\\")\") // DownR vs. Down. See Send's DownR handler for details.\n\t\t, blind_mods, extra_event, remap_dest_modifiers, remap_dest, remap_wheel ? _T(\"\") : _T(\" DownR\"));\n\n\tauto define_remap_func = [&]()\n\t\t{\n\t\t\tif (!AddLine(ACT_BLOCK_BEGIN)\n\t\t\t\t|| !ParseAndAddLine(remap_buf)\n\t\t\t\t|| !AddLine(ACT_BLOCK_END))\n\t\t\t\treturn FAIL;\n\t\t\treturn OK;\n\t\t};\n\tif (!define_remap_func()) // the \"down\" function.\n\t\treturn FAIL;\n\tif (remap_wheel) // Mapping key-down to wheel or vice versa is sufficient; mapping key-up to wheel would cause double scrolling.\n\t\treturn OK;\n\t//\n\t// \"Down\" is finished, proceed with \"Up\":\n\t//\n\t_stprintf(remap_buf\n\t\t, _T(\"%s up\") // Key-up hotkey, e.g. *LButton up::\n\t\t, remap_source);\n\tif (!make_remap_hotkey(remap_buf))\n\t\treturn FAIL;\n\t_stprintf(remap_buf\n\t\t, _T(\"%s(-1),\")\n\t\t_T(\"Send(\\\"{Blind}{%s Up}\\\")\\n\") // Unlike the down-event above, remap_dest_modifiers is not included for the up-event; e.g. ^{b up} is inappropriate.\n\t\t, remap_dest_is_mouse ? _T(\"SetMouseDelay\") : _T(\"SetKeyDelay\") // Using the full function names vs. Set%sDelay might help size due to string pooling.\n\t\t, remap_dest\n\t);\n\tif (!define_remap_func()) // define the \"up\" function.\n\t\treturn FAIL;\n\treturn OK;\n}\n\n\n\nbool Script::EndsWithOperator(LPTSTR aBuf, LPTSTR aBuf_marker)\n// Returns true if aBuf_marker is the end of an operator, excluding ++ and --.\n{\n\tLPTSTR cp = aBuf_marker; // Caller has omitted trailing whitespace.\n\tif (*cp == '.') // It's only a meaningful end-of-line operator if preceded by a space; something like \"2.\" should not cause continuation.\n\t\treturn cp > aBuf && IS_SPACE_OR_TAB(cp[-1]);\n\tif (_tcschr(EXPR_OPERATOR_SYMBOLS, *cp) // It's a binary operator or ++ or --.\n\t\t&& !((*cp == '+' || *cp == '-') && cp > aBuf && cp[-1] == *cp)) // Not ++ or --.\n\t\treturn true;\n\tLPTSTR word;\n\tfor (word = cp; word > aBuf && IS_IDENTIFIER_CHAR(word[-1]); --word);\n\tif (word > aBuf && word[-1] == '.')\n\t\treturn false; // Reserved words are permitted as property names, so `a.as` isn't an operator.\n\tswitch (ConvertWordOperator(word, cp - word + 1))\n\t{\n\tcase SYM_OR:\n\tcase SYM_AND:\n\tcase SYM_IS:\n\tcase SYM_LOWNOT:\n\tcase SYM_RESERVED_OPERATOR:\n\t\treturn true;\n\t}\n\treturn false;\n}\n\n\n\nResultType Script::LineBuffer::EnsureCapacity(size_t aLength)\n{\n\taLength += RESERVED_SPACE;\n\tif (size >= aLength)\n\t\treturn OK;\n\t// See comments in Expand() regarding buffer growth.\n\tsize_t newsize = size ? size : INITIAL_SIZE;\n\twhile (newsize < aLength)\n\t\tnewsize *= 2;\n\treturn Realloc(newsize);\n}\n\nResultType Script::LineBuffer::Expand()\n{\n\t// The buffer typically needs to grow incrementally while joining lines in a continuation section.\n\t// Expanding in large increments avoids multiple reallocs in most files. Expanding exponentially\n\t// scales better in theory, though some testing showed it to have virtually no impact on load time\n\t// even with very long lines. Memory usage isn't a concern since the buffer will be freed after\n\t// the script file is read.\n\treturn Realloc(size ? size * 2 : INITIAL_SIZE);\n}\n\nResultType Script::LineBuffer::Realloc(size_t aNewSize)\n{\n\tLPTSTR newp = (LPTSTR)realloc(p, sizeof(TCHAR) * aNewSize);\n\tif (!newp)\n\t\treturn FAIL;\n\tp = newp;\n\tsize = aNewSize;\n\treturn OK;\n}\n\n\n\nResultType Script::GetLineContExpr(TextStream *fp, LineBuffer &buf, LineBuffer &next_buf\n\t, LineNumberType &phys_line_number, bool &has_continuation_section)\n// Determine whether buf has an unclosed (/[/{, and if so, complete the expression by\n// appending subsequent lines until the number of opening and closing symbols balances out.\n// Continuation lines and sections are assumed to have already been handled (and appended to\n// buf) by a previous call to GetLineContinuation(), but **only up to the unbalanced line**;\n// any subsequent contination is handled by this function.\n{\n\tenum_act action_type = ACT_INVALID; // Set default.\n\tptrdiff_t action_end_pos = 0;\n\n\tsize_t &buf_length = buf.length;\n\tsize_t &next_buf_length = next_buf.length;\n\n\tTCHAR expect[MAX_BALANCEEXPR_DEPTH], open_quote = 0;\n\tint balance = BalanceExpr(buf, 0, expect);\n\tif (balance < 0 // Invalid.\n\t\t|| !buf_length // Blank (shouldn't happen as buf must already qualify as expression-like).\n\t\t|| next_buf_length == -1) // End of file.\n\t\treturn balance == 0 ? OK : BalanceExprError(balance, expect, buf);\n\t\n\t// Perform rough checking for this line's action type.\n\tfor (LPTSTR action_start = buf; ; )\n\t{\n\t\tLPTSTR action_end = find_identifier_end(action_start);\n\t\tif (action_end > action_start)\n\t\t{\n\t\t\tTCHAR orig_char = *action_end;\n\t\t\t// This relies on names of control flow statements being invalid for use as var/func names:\n\t\t\tif ((IS_SPACE_OR_TAB(orig_char) || orig_char == '(' || orig_char == '{') // '{' supports \"else{\".\n\t\t\t\t&& !(mClassObjectCount && !g->CurrentFunc)) // Not in a class body (where Else/Try/Finally are just property names).\n\t\t\t{\n\t\t\t\t*action_end = '\\0';\n\t\t\t\taction_type = (enum_act)ConvertActionType(action_start);\n\t\t\t\t*action_end = orig_char;\n\n\t\t\t\tif (action_type == ACT_ELSE || action_type == ACT_TRY || action_type == ACT_FINALLY)\n\t\t\t\t{\n\t\t\t\t\taction_start = omit_leading_whitespace(action_end);\n\t\t\t\t\tif (*action_start == '{')\n\t\t\t\t\t\treturn OK; // This is unconditionally a block-begin, not an expression.\n\t\t\t\t\tcontinue; // Parse any same-line action instead.\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\taction_end_pos = action_end - buf; // Use position since action_end will be invalidated if buf is reallocated.\n\t\tbreak;\n\t}\n\n\tdo\n\t{\n\t\tif (balance == 0)\n\t\t{\n\t\t\tif (buf[buf_length - 1] == ':')\n\t\t\t{\n\t\t\t\t// Rather than checking for ACT_CASE and \"Default:\" or \"Default :\" (even though Default is recognized\n\t\t\t\t// as such only within a Switch), just treat all statement types the same: do line continuation only\n\t\t\t\t// if this \":\" has a matching \"?\".\n\t\t\t\tif (FindExprDelim(buf, ':') == buf_length - 1)\n\t\t\t\t{\n\t\t\t\t\t// This is either an error or the colon terminating a case/default statement.\n\t\t\t\t\treturn OK;\n\t\t\t\t}\n\t\t\t\t//else this colon qualifies for line continuation.\n\t\t\t}\n\t\t\telse if (EndsWithOperator(buf, buf + (buf_length - 1)))\n\t\t\t{\n\t\t\t\t// This relies on names of control flow statements being invalid for use as var/func names:\n\t\t\t\tauto next_action_end = find_identifier_end((LPTSTR)next_buf);\n\t\t\t\tTCHAR orig_char = *next_action_end;\n\t\t\t\t*next_action_end = '\\0';\n\t\t\t\tauto next_action_type = ConvertActionType(next_buf);\n\t\t\t\t*next_action_end = orig_char;\n\t\t\t\tif (next_action_type)\n\t\t\t\t\t// Avoid continuation in this case because it leads to confusing error messages.\n\t\t\t\t\treturn OK;\n\t\t\t}\n\t\t\telse if (!IsSOLContExpr(next_buf))\n\t\t\t{\n\t\t\t\t// There's no continuation by enclosure and no continuation operator, so we're done.\n\t\t\t\treturn OK;\n\t\t\t}\n\t\t}\n\t\t// Before appending each line, check whether the last line ended with OTB '{'.\n\t\t// It can be OTB even for balance > 1, but only with an inline function definition.\n\t\t// balance > 0 implies buf_length >= 1, but below requires buf_length >= 2.\n\t\t// The shortest valid OTB is for the property \"p{\". Finding '{' usually implies\n\t\t// buf_length >= 2 because '{' at the start of buf is usually handled by the\n\t\t// caller, but that isn't always the case (e.g. for one-line hotkeys).\n\t\telse if (buf[buf_length - 1] == '{' && buf_length >= 2)\n\t\t{\n\t\t\t// Some common OTB constructs:\n\t\t\t// myfn() {\n\t\t\t// if (cond) {\n\t\t\t// while (cond) {\n\t\t\t// loop {\n\t\t\t// if cond {\n\t\t\t// For the first few cases, *cp == ')' is sufficient. There is no need to verify\n\t\t\t// that this is a function definition because \") {\" is only valid in that case.\n\t\t\t// \"] {\" is either a property definition or invalid.\n\t\t\t// For other cases, checking the action_type is the only way to resolve the ambiguity\n\t\t\t// between \"loop {\" and \"return {\". Since valid OTB can't be preceded by an operator\n\t\t\t// such as \":= {\", also check that case to improve flexibility.\n\t\t\tLPTSTR cp = omit_trailing_whitespace(buf, buf + (buf_length - 2));\n\t\t\tif (*cp == ')' // Function/method definition or reserved.\n\t\t\t\t|| balance == 1 // The following cases don't apply if the '{' is enclosed.\n\t\t\t\t&& (*cp == ']' // Property definition or reserved.\n\t\t\t\t || IS_IDENTIFIER_CHAR(*cp) && mClassObjectCount && !g->CurrentFunc // As above (get/set was handled by caller).\n\t\t\t\t\t// Above must check the last two conditions to exclude \"return {\" and \"MyFunc {\",\n\t\t\t\t\t// and must cover both \"prop {\" and \"static prop {\", so uses *cp, not action_end_pos.\n\t\t\t\t\t// Expressions like \"x := y {\" are reserved/not valid, so are not considered here.\n\t\t\t\t || ACT_IS_LINE_PARENT(action_type) && !EndsWithOperator(buf, cp))) // Control flow OTB.\n\t\t\t\treturn OK;\n\t\t}\n\t\telse if (buf[buf_length - 1] == ')' && *next_buf == '{')\n\t\t{\n\t\t\t// This is a function definition enclosed within an expression. In order to permit a statement\n\t\t\t// on the same line as the opening brace, it is currently necessary to move the brace up one line.\n\t\t\tLPTSTR cp = omit_leading_whitespace(next_buf + 1);\n\t\t\tif (*cp)\n\t\t\t{\n\t\t\t\tbuf[buf_length++] = '{';\n\t\t\t\tbuf[buf_length] = '\\0';\n\t\t\t\ttmemcpy(next_buf, cp, (next_buf.length -= (cp - next_buf)) + 1);\n\t\t\t\treturn OK; \n\t\t\t}\n\t\t\t// The line is just \"{\", so let it be handled by line continuation since we can't leave next_buf empty.\n\t\t}\n\t\tif (next_buf_length) // Skip empty/comment lines.\n\t\t{\n\t\t\tif (!buf.EnsureCapacity(next_buf_length + buf_length + 1))\n\t\t\t\treturn ScriptError(ERR_OUTOFMEM);\n\t\t\tbalance = BalanceExpr(next_buf, balance, expect, &open_quote); // Adjust balance based on what we're about to append.\n\t\t\tbuf[buf_length++] = ' '; // To ensure two distinct tokens aren't joined together. ' ' vs. '\\n' because DefineFunc() currently doesn't permit '\\n'.\n\t\t\ttmemcpy(buf + buf_length, next_buf, next_buf_length); // Append next_buf to this line.\n\t\t\tbuf_length += next_buf_length;\n\t\t\tbuf[buf_length] = '\\0';\n\t\t}\n\t\tauto prev_length = buf_length; // Store length vs. pointer since buf may be reallocated below.\n\t\t// This serves to get the next non-blank, non-comment line into next_buf but also handles any\n\t\t// continuation sections which follow the line just appended:\n\t\tif (!GetLineContinuation(fp, buf, next_buf, phys_line_number, has_continuation_section))\n\t\t\treturn FAIL;\n\t\tif (buf_length > prev_length && balance >= 0)\n\t\t\tbalance = BalanceExpr(buf + prev_length, balance, expect, &open_quote); // Adjust balance based on what was appended.\n\t\tif (open_quote)\n\t\t{\n\t\t\t// Unterminated string (continuation expressions should not automatically permit strings to span lines).\n\t\t\texpect[0] = open_quote;\n\t\t\texpect[1] = 0;\n\t\t\tbalance = -1;\n\t\t}\n\t} // do\n\twhile (balance >= 0 && next_buf_length != -1);\n\tif (balance != 0)\n\t{\n\t\t// buf might include some lines that the author did not intend to be merged, so report\n\t\t// the error immediately. Leaving it to later might obscure it with some other problem,\n\t\t// such as control flow statements being interpreted as invalid variable references.\n\t\treturn BalanceExprError(balance, expect, buf);\n\t}\n\treturn OK;\n}\n\n\n\nbool Script::IsSOLContExpr(LineBuffer &next_buf)\n{\n\tLPTSTR cp, hotkey_flag;\n\n\tswitch(ctoupper(*next_buf)) // Above has ensured *next_buf != '\\0' (toupper might have problems with '\\0').\n\t{\n\tcase 'A': // AND, AS (future use)\n\tcase 'O': // OR\n\tcase 'I': // IS, IN, (unwanted) ISSET\n\tcase 'C': // CONTAINS (future use)\n\t\t// See comments in the default section further below.\n\t\tcp = find_identifier_end<LPTSTR>(next_buf);\n\t\t// Although (x)and(y) is technically valid, it's quite unusual. The space or tab requirement is kept\n\t\t// as the simplest way to allow method definitions to use these as names (when called, the leading dot\n\t\t// ensures there is no ambiguity). Note that checking if we're inside a class definition is not\n\t\t// sufficient because multi-line expressions are valid there too (i.e. for var initializers).\n\t\t// This also rules out valid double-derefs such as and%suffix% := 1.\n\t\tif (IS_SPACE_OR_TAB(*cp))\n\t\t{\n\t\t\t// Unlike in v1, there's no check for an operator after AND/OR (such as AND := 1) because they\n\t\t\t// should never be used as variable names.\n\t\t\tauto op = ConvertWordOperator(next_buf, cp - next_buf);\n\t\t\tif (op && op != SYM_ISSET) // IsSet is excluded for property definitions like IsSet => true.\n\t\t\t\treturn true;\n\t\t}\n\t\tbreak;\n\tdefault:\n\t\t// Desired line continuation operators:\n\t\t// Pretty much everything, namely:\n\t\t// +, -, *, /, //, **, <<, >>, &, |, ^, <, >, <=, >=, =, ==, <>, !=, :=, +=, -=, /=, *=, ?, :\n\t\t// And also the following remaining unaries (i.e. those that aren't also binaries): !, ~\n\t\t// The first line below checks for ::, ++, and --. Those can't be continuation lines because:\n\t\t// \"::\" isn't a valid operator (this also helps performance if there are many hotstrings).\n\t\t// ++ and -- are ambiguous with an isolated line containing ++Var or --Var (and besides,\n\t\t// wanting to use ++ to continue an expression seems extremely rare, though if there's ever\n\t\t// demand for it, might be able to look at what lies to the right of the operator's operand\n\t\t// -- though that would produce inconsistent continuation behavior since ++Var itself still\n\t\t// could never be a continuation line due to ambiguity).\n\t\t//\n\t\t// The logic here isn't smart enough to differentiate between a leading - that's meant as a\n\t\t// continuation character and one that isn't. Even if it were, it would still be ambiguous in\n\t\t// some cases because the author's intent isn't known; for example, the leading minus sign on\n\t\t// the second line below is ambiguous:\n\t\t// x := y \n\t\t// -z ? a:=1 : func() \n\t\tif ((*next_buf == ':' || *next_buf == '+' || *next_buf == '-') && next_buf[1] == *next_buf // See above.\n\t\t\t|| !_tcschr(CONTINUATION_LINE_SYMBOLS, *next_buf)) // Line doesn't start with a continuation char.\n\t\t\tbreak;\n\t\t// Some of the above checks must be done before the next ones.\n\t\tif ( !(hotkey_flag = _tcsstr(next_buf, HOTKEY_FLAG)) ) // Without any \"::\", it can't be a hotkey or hotstring.\n\t\t\treturn true;\n\t\tif (*next_buf == ':') // First char is ':', so it's more likely a hotstring than a hotkey.\n\t\t{\n\t\t\t// Remember that hotstrings can contain what *appear* to be quoted literal strings,\n\t\t\t// so detecting whether a \"::\" is in a quoted/literal string in this case would\n\t\t\t// be more complicated. That's one reason this other method is used.\n\t\t\tbool hotstring_options_all_valid = true;\n\t\t\tfor (cp = next_buf + 1; *cp && *cp != ':'; ++cp)\n\t\t\t\tif (!IS_HOTSTRING_OPTION(*cp)) // Not a perfect test, but eliminates most of what little remaining ambiguity exists between ':' as a continuation character vs. ':' as the start of a hotstring. It especially eliminates the \":=\" operator.\n\t\t\t\t{\n\t\t\t\t\thotstring_options_all_valid = false;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\tif (hotstring_options_all_valid && *cp == ':') // It's almost certainly a hotstring.\n\t\t\t\tbreak; // So don't treat it as a continuation line.\n\t\t\t//else it's not a hotstring but it might still be a hotkey such as \": & x::\".\n\t\t\t// So continue checking below.\n\t\t}\n\t\t// Since above didn't \"break\", this line isn't a hotstring but it is probably a hotkey\n\t\t// because above already discovered that it contains \"::\" somewhere. The v1 policy was\n\t\t// to do some rough checks for comma hotkeys and quote marks. For v2, we use a much\n\t\t// clearer rule: if it's valid hotkey syntax (even with invalid key names), it's not\n\t\t// continuation. There is at least one pathological case that could be an expression,\n\t\t// but it's much more likely to be intended as a hotkey:\n\t\t// MsgBox\n\t\t// +!'::' ; 0\n\t\t*hotkey_flag = '\\0';\n\t\tbool valid_hotkey = Hotkey::TextInterpret(next_buf, NULL, true) == OK;\n\t\t*hotkey_flag = *HOTKEY_FLAG;\n\t\tif (!valid_hotkey)\n\t\t\treturn true; // It's not valid hotkey syntax, so treat it as continuation even if it's ultimately a syntax error.\n\t} // switch(toupper(*next_buf))\n\treturn false;\n}\n\n\n\nResultType Script::BalanceExprError(int aBalance, TCHAR aExpect[], LPTSTR aLineText)\n{\n\tTCHAR expected, found;\n\tif (aBalance < 0)\n\t{\n\t\texpected = aExpect[0];\n\t\tfound = aExpect[1];\n\t}\n\telse\n\t{\n\t\texpected = aBalance < MAX_BALANCEEXPR_DEPTH ? aExpect[aBalance - 1] : 0;\n\t\tfound = 0;\n\t}\n\tTCHAR msgbuf[40];\n\tLPTSTR msgfmt;\n\tif (expected && found)\n\t\tmsgfmt = _T(\"Missing \\\"%c\\\" before \\\"%c\\\"\");\n\telse if (found)\n\t\tmsgfmt = _T(\"Unexpected \\\"%c\\\"\"), expected = found;\n\telse if (expected)\n\t\tmsgfmt = _T(\"Missing \\\"%c\\\"\");\n\telse\n\t\tmsgfmt = _T(\"Missing symbol\"); // Rare case (expression too deep to keep track of what's missing).\n\tsntprintf(msgbuf, _countof(msgbuf), msgfmt, expected, found);\n\treturn ScriptError(msgbuf, aLineText);\n}\n\n\n\nResultType Script::GetLineContinuation(TextStream *fp, LineBuffer &buf, LineBuffer &next_buf\n\t, LineNumberType &phys_line_number, bool &has_continuation_section)\n{\n\tbool do_rtrim, literal_escapes, literal_quotes;\n\t#define CONTINUATION_SECTION_WITHOUT_COMMENTS 1 // MUST BE 1 because it's the default set by anything that's boolean-true.\n\t#define CONTINUATION_SECTION_WITH_COMMENTS 2 // Zero means \"not in a continuation section\".\n\tint in_continuation_section, indent_level;\n\tToggleValueType do_ltrim;\n\tTCHAR indent_char, suffix[16];\n\tsize_t suffix_length;\n\n\tLPTSTR next_option, option_end, cp;\n\tTCHAR orig_char, quote_char;\n\tbool in_comment_section;\n\tint quote_pos;\n\tint continuation_line_count;\n\n\tauto &buf_length = buf.length;\n\tauto &next_buf_length = next_buf.length;\n\n\t// Read in the next line (if that next line is the start of a continuation section, append\n\t// it to the line currently being processed:\n\tfor (has_continuation_section = in_comment_section = false, in_continuation_section = 0;;)\n\t{\n\t\t// This increment relies on the fact that this loop always has at least one iteration:\n\t\t++phys_line_number; // Tracks phys. line number in *this* file (independent of any recursion caused by #Include).\n\t\tnext_buf_length = GetLine(next_buf, in_continuation_section, in_comment_section, fp);\n\t\tif (!in_continuation_section)\n\t\t{\n\t\t\t// v2: The comment-end is allowed at the end of the line (vs. just the start) to reduce\n\t\t\t// confusion for users expecting C-like behaviour, but unlike v1.1, the end flag is not\n\t\t\t// allowed outside of comments, since allowing and ignoring */ at the end of any line\n\t\t\t// seems to have risk of ambiguity.\n\t\t\t// If this policy is changed to ignore an orphan */, remember to allow */:: as a hotkey.\n\n\t\t\t// Check for /* first in case */ appears on the same line. There's no need to check\n\t\t\t// in_comment_section since this has the same effect either way (and it's usually false).\n\t\t\tif (!_tcsncmp(next_buf, _T(\"/*\"), 2))\n\t\t\t{\n\t\t\t\tin_comment_section = true;\n\t\t\t\t// But don't \"continue;\" since there might be a */ on this same line.\n\t\t\t}\n\n\t\t\tif (in_comment_section)\n\t\t\t{\n\t\t\t\tif (next_buf_length == -1) // Compare directly to -1 since length is unsigned.\n\t\t\t\t\tbreak; // By design, it's not an error. This allows \"/*\" to be used to comment out the bottommost portion of the script without needing a matching \"*/\".\n\n\t\t\t\tif (!_tcsncmp(next_buf, _T(\"*/\"), 2))\n\t\t\t\t{\n\t\t\t\t\tin_comment_section = false;\n\t\t\t\t\tnext_buf_length -= 2; // Adjust for removal of */ from the beginning of the string.\n\t\t\t\t\ttmemmove(next_buf, next_buf + 2, next_buf_length + 1); // +1 to include the string terminator.\n\t\t\t\t\tnext_buf_length = ltrim(next_buf, next_buf_length); // Get rid of any whitespace that was between the comment-end and remaining text.\n\t\t\t\t\tif (!*next_buf) // The rest of the line is empty, so it was just a naked comment-end.\n\t\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// This entire line is part of the comment, but there might be */ at the end of the line.\n\t\t\t\t\tif (next_buf_length >= 2 && !_tcscmp(next_buf + (next_buf_length - 2), _T(\"*/\")))\n\t\t\t\t\t\tin_comment_section = false;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// v1.0.38.06: The following has been fixed to exclude \"(:\" and \"(::\". These should be\n\t\t\t// labels/hotkeys, not the start of a continuation section.\n\t\t\t// v2: Unlike v1, a line that starts with '(' but that ends with ':' is not a valid label,\n\t\t\t// so should be treated as a continuation section, for cases like \"(Join:\".\n\t\t\tif ( !(in_continuation_section = (next_buf_length != -1 && *next_buf == '(' && next_buf[1] != ':')) ) // Compare directly to -1 since length is unsigned.\n\t\t\t{\n\t\t\t\tif (!next_buf_length)\n\t\t\t\t\t// It is permitted to have blank lines and comment lines in between the line above\n\t\t\t\t\t// and any continuation section/line that might come after the end of the\n\t\t\t\t\t// comment/blank lines:\n\t\t\t\t\tcontinue;\n\t\t\t\t// Since there is no continuation section and this line isn't blank, no further searching\n\t\t\t\t// is needed. This also covers the case of EOF (next_buf_length == -1).\n\t\t\t\tbreak;\n\t\t\t} // if (!in_continuation_section)\n\n\t\t\t// OTHERWISE in_continuation_section != 0, so the above has found the first line of a new\n\t\t\t// continuation section.\n\t\t\tcontinuation_line_count = 0; // Reset for this new section.\n\t\t\t// Parse options. First set the defaults, which can be individually overridden\n\t\t\t// by any options actually present. RTrim defaults to ON for two reasons:\n\t\t\t// 1) Whitespace often winds up at the end of a lines in a text editor by accident. In addition,\n\t\t\t// whitespace at the end of any consolidated/merged line will be rtrim'd anyway, since that's\n\t\t\t// how command parsing works.\n\t\t\t// 2) Copy & paste from the forum and perhaps other web sites leaves a space at the end of each\n\t\t\t// line. Although this behavior is probably site/browser-specific, it's a consideration.\n\t\t\tdo_ltrim = NEUTRAL; // Start off at neutral/smart-trim.\n\t\t\tdo_rtrim = true; // Seems best to rtrim even if this line is a hotstring, since it is very rare that trailing spaces and tabs would ever be desirable.\n\t\t\t// For hotstrings (which could be detected via *buf==':'), it seems best not to default the\n\t\t\t// escape character (`) to be literal because the ability to have `t `r and `n inside the\n\t\t\t// hotstring continuation section seems more useful/common than the ability to use the\n\t\t\t// accent character by itself literally (which seems quite rare in most languages).\n\t\t\tliteral_escapes = false;\n\t\t\t//literal_quotes is set below based on the contents of buf.\n\t\t\t// The default is linefeed because:\n\t\t\t// 1) It's the best choice for hotstrings, for which the line continuation mechanism is well suited.\n\t\t\t// 2) It's good for FileAppend.\n\t\t\t// 3) Minor: Saves memory in large sections by being only one character instead of two.\n\t\t\tsuffix[0] = '\\n';\n\t\t\tsuffix[1] = '\\0';\n\t\t\tsuffix_length = 1;\n\t\t\tLPTSTR invalid_option = nullptr;\n\t\t\tfor (next_option = omit_leading_whitespace(next_buf + 1); *next_option; next_option = omit_leading_whitespace(option_end))\n\t\t\t{\n\t\t\t\t// Find the end of this option item:\n\t\t\t\tif ( !(option_end = StrChrAny(next_option, _T(\" \\t\"))) ) // Space or tab.\n\t\t\t\t\toption_end = next_option + _tcslen(next_option); // Set to position of zero terminator instead.\n\n\t\t\t\t// Temporarily terminate to help eliminate ambiguity for words contained inside other words,\n\t\t\t\t// such as hypothetical \"Checked\" inside of \"CheckedGray\":\n\t\t\t\torig_char = *option_end;\n\t\t\t\t*option_end = '\\0';\n\n\t\t\t\tif (!_tcsnicmp(next_option, _T(\"Join\"), 4))\n\t\t\t\t{\n\t\t\t\t\tnext_option += 4;\n\t\t\t\t\ttcslcpy(suffix, next_option, _countof(suffix)); // The word \"Join\" by itself will product an empty string, as documented.\n\t\t\t\t\t// Only `s and `t are replaced, as everything else must be in a quoted string, which would\n\t\t\t\t\t// perform its own conversion of escape sequences. In particular, `` is left as is since\n\t\t\t\t\t// it would otherwise be converted again later; i.e. ```` would become a literal `.\n\t\t\t\t\tConvertSpaceEscapeSequences(suffix);\n\t\t\t\t\tsuffix_length = _tcslen(suffix);\n\t\t\t\t}\n\t\t\t\telse if (!_tcsnicmp(next_option, _T(\"LTrim\"), 5))\n\t\t\t\t\tdo_ltrim = (next_option[5] == '0') ? TOGGLED_OFF : TOGGLED_ON; // i.e. Only an explicit zero will turn it off.\n\t\t\t\telse if (!_tcsnicmp(next_option, _T(\"RTrim\"), 5))\n\t\t\t\t\tdo_rtrim = (next_option[5] != '0');\n\t\t\t\telse if (!_tcsnicmp(next_option, _T(\"Comments\"), option_end - next_option)) // Any prefix is supported, but the documented options are: C, Com, Comment, Comments\n\t\t\t\t\tin_continuation_section = CONTINUATION_SECTION_WITH_COMMENTS; // Override the default, which is boolean true (i.e. 1).\n\t\t\t\telse if (*next_option == g_EscapeChar && !next_option[1])\n\t\t\t\t\tliteral_escapes = true;\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// If ')' is present in any as yet unrecognized option, treat this line as an expression and not\n\t\t\t\t\t// the start of a continuation section. This allows expressions to start the line with '(' to\n\t\t\t\t\t// control order of precedence, like (x.y)() or (x=y) && z(). Do the same for '(', for symmetry\n\t\t\t\t\t// and to allow multi-line expressions starting with (( and (MyFunc(.\n\t\t\t\t\tfor (cp = next_option; *cp; ++cp)\n\t\t\t\t\t\tif (*cp == '(' || *cp == ')')\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tin_continuation_section = 0;\n\t\t\t\t\t\t\t*option_end = orig_char; // Undo the temporary termination.\n\t\t\t\t\t\t\treturn OK;\n\t\t\t\t\t\t}\n\t\t\t\t\t// All other characters are reserved for possible future options or to detect errors. One reason\n\t\t\t\t\t// not to assume any invalid continuation section was intended to be an expression is that something\n\t\t\t\t\t// like the following would result in a 'Missing \"' error instead of reporting the invalid option:\n\t\t\t\t\t// sometext := \"\n\t\t\t\t\t// (Jion`r`n\n\t\t\t\t\t// ...\n\t\t\t\t\t// Mark the first invalid option, but don't report it until any other options are checked for ().\n\t\t\t\t\tif (!invalid_option)\n\t\t\t\t\t\tinvalid_option = next_option;\n\t\t\t\t}\n\n\t\t\t\t// If the item was not handled by the above, ignore it because it is unknown.\n\t\t\t\t*option_end = orig_char; // Undo the temporary termination.\n\t\t\t} // for() each item in option list\n\n\t\t\tif (invalid_option)\n\t\t\t\treturn ScriptError(ERR_INVALID_OPTION, invalid_option);\n\n\t\t\t// This section determines the default value for literal_quotes based on whether this\n\t\t\t// continuation section appears to start inside a quoted string. This is done because\n\t\t\t// unconditionally defaulting to true would make it possible to start a quoted string\n\t\t\t// but impossible to end it within the same section, which seems counter-intuitive.\n\t\t\t// It's okay if buf contains something other than an expression, because in that case\n\t\t\t// it won't matter whether the quote marks are escaped or not.\n\t\t\tif (!has_continuation_section)\n\t\t\t{\n\t\t\t\tquote_pos = 0; // Init.\n\t\t\t\tquote_char = 0;\n\t\t\t}\n\t\t\tfor (;;)\n\t\t\t{\n\t\t\t\tif (quote_char) // quote_marker is within a string.\n\t\t\t\t{\n\t\t\t\t\tquote_pos += FindTextDelim(buf + quote_pos, quote_char);\n\t\t\t\t\tif (!buf[quote_pos]) // No end quote yet.\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t++quote_pos; // Skip the end quote.\n\t\t\t\t}\n\t\t\t\tfor ( ; buf[quote_pos] && buf[quote_pos] != '\"' && buf[quote_pos] != '\\''; ++quote_pos);\n\t\t\t\tif ( !(quote_char = buf[quote_pos]) )\n\t\t\t\t\tbreak;\n\t\t\t\t++quote_pos; // Continue scanning after the start quote.\n\t\t\t}\n\t\t\tliteral_quotes = quote_char != 0; // true if this section starts inside a quoted string.\n\t\t\t// quote_pos and quote_char are retained between iterations of the outer loop to ensure\n\t\t\t// correct detection when there are multiple continuation sections, and to avoid re-scanning\n\t\t\t// the entire buf for each new section.\n\n\t\t\t// \"has_continuation_section\" indicates whether the line we're about to construct is partially\n\t\t\t// composed of continuation lines beneath it. It's separate from continuation_line_count\n\t\t\t// in case there is another continuation section immediately after/adjacent to the first one,\n\t\t\t// but the second one doesn't have any lines in it:\n\t\t\thas_continuation_section = true;\n\n\t\t\tcontinue; // Now that the open-parenthesis of this continuation section has been processed, proceed to the next line.\n\t\t} // if (!in_continuation_section)\n\n\t\t// Since above didn't \"continue\", we're in the continuation section and thus next_buf contains\n\t\t// either a line to be appended onto buf or the closing parenthesis of this continuation section.\n\t\tif (next_buf_length == -1) // Compare directly to -1 since length is unsigned.\n\t\t\treturn ScriptError(ERR_MISSING_CLOSE_PAREN, buf);\n\t\tif (next_buf_length == -2) // v1.0.45.03: Special flag that means \"this is a commented-out line to be\n\t\t\tcontinue; // entirely omitted from the continuation section.\" Compare directly to -2 since length is unsigned.\n\n\t\tsize_t cp_length, need_escapes = 0;\n\t\tif (*next_buf == ')')\n\t\t{\n\t\t\tin_continuation_section = 0; // Facilitates back-to-back continuation sections and proper incrementing of phys_line_number.\n\t\t\tnext_buf_length = rtrim(next_buf, next_buf_length); // Done because GetLine() wouldn't have done it due to have told it we're in a continuation section.\n\t\t\t// Anything that lies to the right of the close-parenthesis gets appended verbatim, with\n\t\t\t// no trimming (for flexibility) and no options-driven translation:\n\t\t\tcp = next_buf + 1; // Use temp var cp to avoid a memcpy.\n\t\t\tcp_length = next_buf_length - 1;\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// To support continuation sections following a naked action name such as \"return\", add a space.\n\t\t\t// Checking for an action name at the start of buf would be insufficient due to try/else/finally,\n\t\t\t// hotkeys with same-line action, etc. so perform only very basic checking. This probably also\n\t\t\t// benefits other expressions, such as if buf ends with a variable name. The quote_char check\n\t\t\t// prevents unwanted spaces in quoted strings at the expense of possible inconsistency in some\n\t\t\t// vanishingly rare cases, such as:\n\t\t\t// - Auto-replace hotstring with an odd number of quote marks on the first line, a word char\n\t\t\t// at the end of the first line *and* a continuation section following it.\n\t\t\t// - Other very unconventional cases, such as labels or directives which also meet the above\n\t\t\t// criteria (it's very unlikely for continuation sections to be used with these at all).\n\t\t\tif (!continuation_line_count && !quote_char // First content line and we're not in a quoted string.\n\t\t\t\t&& buf_length && IS_IDENTIFIER_CHAR(buf[buf_length - 1]) // buf ends with a possible var/action name.\n\t\t\t\t&& buf_length + 1 < LINE_SIZE)\n\t\t\t{\n\t\t\t\tbuf[buf_length++] = ' ';\n\t\t\t\tbuf[buf_length] = '\\0';\n\t\t\t}\n\t\t\t// The following are done in this block only because anything that comes after the closing\n\t\t\t// parenthesis (i.e. the block above) is exempt from translations and custom trimming.\n\t\t\t// This means that commas are always delimiters and percent signs are always deref symbols\n\t\t\t// in the previous block.\n\t\t\tcp = next_buf; // Set default, to be overridden in case of ltrim.\n\t\t\tcp_length = next_buf_length; // Set default, to be overridden in case of rtrim.\n\t\t\tif (do_ltrim == NEUTRAL)\n\t\t\t{\n\t\t\t\t// Neither \"LTrim\" nor \"LTrim0\" was present in this section's options, so\n\t\t\t\t// trim the continuation section based on the indentation of the first line.\n\t\t\t\tif (!continuation_line_count)\n\t\t\t\t{\n\t\t\t\t\t// This is the first line.\n\t\t\t\t\tindent_char = *cp;\n\t\t\t\t\tif (IS_SPACE_OR_TAB(indent_char))\n\t\t\t\t\t{\n\t\t\t\t\t\t// For simplicity, require that only one type of indent char is used. Otherwise\n\t\t\t\t\t\t// we'd have to provide some way to set the width (in spaces) of a tab char.\n\t\t\t\t\t\tfor (indent_level = 1; cp[indent_level] == indent_char; ++indent_level);\n\t\t\t\t\t\t// Let the section below actually remove the indentation on this and subsequent lines.\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tindent_level = 0; // No trimming is to be done.\n\t\t\t\t}\n\t\t\t\tif (indent_level)\n\t\t\t\t{\n\t\t\t\t\tint i;\n\t\t\t\t\tfor (i = 0; i < indent_level && cp[i] == indent_char; ++i);\n\t\t\t\t\tif (i == indent_level)\n\t\t\t\t\t{\n\t\t\t\t\t\t// LTrim exactly (indent_level) occurrences of (indent_char).\n\t\t\t\t\t\tcp += i;\n\t\t\t\t\t\tcp_length -= i;\n\t\t\t\t\t}\n\t\t\t\t\t// Otherwise, the indentation on this line is inconsistent with the first line,\n\t\t\t\t\t// so just leave it as is.\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (do_ltrim == TOGGLED_ON)\n\t\t\t{\n\t\t\t\t// Trim all leading whitespace.\n\t\t\t\tcp = omit_leading_whitespace(cp);\n\t\t\t\tcp_length -= (cp - next_buf);\n\t\t\t}\n\t\t\tif (do_rtrim)\n\t\t\t{\n\t\t\t\t// Exclude trailing whitespace from cp_length.\n\t\t\t\twhile (cp_length && IS_SPACE_OR_TAB(cp[cp_length - 1]))\n\t\t\t\t\tcp_length--;\n\t\t\t}\n\t\t\t\n\t\t\t// Insert escape characters as needed for escape characters or quote marks to be interpreted\n\t\t\t// literally, as per continuation section options or detection of enclosing quote marks.\n\t\t\tif (literal_escapes || literal_quotes)\n\t\t\t{\n\t\t\t\t// It is probably counter-productive to perform the full calculation, since we really only need\n\t\t\t\t// a figure to pass to EnsureCapacity(). If buf needs to be expanded, it will be doubled in size\n\t\t\t\t// anyway, and usually will be reused many times. So just use a simple worst-case estimate:\n\t\t\t\tneed_escapes = cp_length;\n\t\t\t\t//for (size_t i = 0; i < cp_length; ++i)\n\t\t\t\t//{\n\t\t\t\t//\tif (cp[i] == g_EscapeChar)\n\t\t\t\t//\t\tliteral_escapes ? ++need_escapes : ++i; // If not literal, it might escape a quote mark to its right.\n\t\t\t\t//\telse if (cp[i] == quote_char) // It's the type of quote that needs to be escaped, and hasn't been.\n\t\t\t\t//\t\tneed_escapes += literal_quotes;\n\t\t\t\t//}\n\t\t\t}\n\t\t} // Handling of a normal line within a continuation section.\n\n\t\t// Must check the combined length only after anything that might have expanded the string above.\n\t\tif (!buf.EnsureCapacity(buf_length + suffix_length + cp_length + need_escapes))\n\t\t\treturn ScriptError(ERR_OUTOFMEM);\n\n\t\t++continuation_line_count;\n\t\t// Append this continuation line onto the primary line.\n\t\t// The suffix for the previous line gets written immediately prior to writing this next line,\n\t\t// which allows the suffix to be omitted for the final line. But if this is the first line,\n\t\t// No suffix is written because there is no previous line in the continuation section.\n\t\t// In addition, if !in_continuation_section, cp is raw text occuring to the right of the\n\t\t// continuation section's closing parenthesis. In this case too, the previous line doesn't\n\t\t// get a suffix.\n\t\tif (continuation_line_count > 1 && suffix_length && in_continuation_section)\n\t\t{\n\t\t\ttmemcpy(buf + buf_length, suffix, suffix_length + 1); // Append and include the zero terminator.\n\t\t\tbuf_length += suffix_length; // Must be done only after the old value of buf_length was used above.\n\t\t}\n\t\tif (need_escapes)\n\t\t{\n\t\t\t// Append this line to buf, while also escaping escape characters or quotes as needed.\n\t\t\tLPTSTR cp2 = buf + buf_length;\n\t\t\tfor (size_t i = 0; i < cp_length; ++i)\n\t\t\t{\n\t\t\t\tif (cp[i] == g_EscapeChar)\n\t\t\t\t{\n\t\t\t\t\t*cp2++ = g_EscapeChar;\n\t\t\t\t\tif (!literal_escapes)\n\t\t\t\t\t{\n\t\t\t\t\t\t++i; // Handle the second char in this iteration to ensure `\" won't become ``\".\n\t\t\t\t\t\tif (i >= cp_length) // Only true when there's a trailing `. Must be checked to prevent overflow.\n\t\t\t\t\t\t\tbreak; // Legacy behaviour: leave it as is, and it may escape the char after the closing parenthesis.\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\telse if (cp[i] == quote_char) // It's the type of quote that needs to be escaped, and hasn't been.\n\t\t\t\t{\n\t\t\t\t\tif (literal_quotes)\n\t\t\t\t\t\t*cp2++ = g_EscapeChar;\n\t\t\t\t}\n\t\t\t\t*cp2++ = cp[i];\n\t\t\t}\n\t\t\t*cp2 = '\\0';\n\t\t\tbuf_length += (cp2 - (buf + buf_length));\n\t\t}\n\t\telse if (cp_length)\n\t\t{\n\t\t\ttmemcpy(buf + buf_length, cp, cp_length + 1); // Append this line to prev. and include the zero terminator.\n\t\t\tbuf_length += cp_length; // Must be done only after the old value of buf_length was used above.\n\t\t}\n\t} // for() each sub-line (continued line) that composes this line.\n\treturn OK;\n}\n\n\n\nsize_t Script::GetLine(LineBuffer &aBuf, int aInContinuationSection, bool aInBlockComment, TextStream *ts)\n{\n\tsize_t aBuf_length = 0;\n\tfor (;;)\n\t{\n\t\tauto aBuf_capacity = aBuf.Capacity();\n\t\tauto read_length = ts->ReadLine(aBuf + aBuf_length, (DWORD)(aBuf_capacity - aBuf_length));\n\t\tif (!read_length && !aBuf_length) // End of file was reached and there's no line text from a previous iteration.\n\t\t{\n\t\t\taBuf[0] = '\\0';\n\t\t\treturn -1;\n\t\t}\n\t\taBuf_length += read_length;\n\t\tif (aBuf[aBuf_length - 1] == '\\n')\n\t\t\t--aBuf_length;\n\t\tif (aBuf_length < aBuf_capacity)\n\t\t\tbreak; // It read one complete line, either finding a line ending or reaching end of file.\n\t\t// This line is at least the size of aBuf, so expand aBuf to read more.\n\t\tif (!aBuf.Expand())\n\t\t\treturn -1;\n\t}\n\taBuf[aBuf_length] = '\\0';\n\n\tif (aInContinuationSection)\n\t{\n\t\tLPTSTR cp = omit_leading_whitespace(aBuf);\n\t\tif (aInContinuationSection == CONTINUATION_SECTION_WITHOUT_COMMENTS) // By default, continuation sections don't allow comments (lines beginning with a semicolon are treated as literal text).\n\t\t{\n\t\t\t// Caller relies on us to detect the end of the continuation section so that trimming\n\t\t\t// will be done on the final line of the section and so that a comment can immediately\n\t\t\t// follow the closing parenthesis (on the same line). Example:\n\t\t\t// (\n\t\t\t//\tText\n\t\t\t// ) ; Same line comment.\n\t\t\tif (*cp != ')') // This isn't the last line of the continuation section, so leave the line untrimmed (caller will apply the ltrim setting on its own).\n\t\t\t\treturn aBuf_length; // Earlier sections are responsible for keeping aBufLength up-to-date with any changes to aBuf.\n\t\t\t//else this line starts with ')', so continue on to later section that checks for a same-line comment on its right side.\n\t\t}\n\t\telse // aInContinuationSection == CONTINUATION_SECTION_WITH_COMMENTS (i.e. comments are allowed in this continuation section).\n\t\t{\n\t\t\t// Fix for v1.0.46.09+: The \"com\" option shouldn't put \"ltrim\" into effect.\n\t\t\tif (*cp == g_CommentChar)\n\t\t\t{\n\t\t\t\t*aBuf = '\\0'; // Since this line is a comment, have the caller ignore it.\n\t\t\t\treturn -2; // Callers tolerate -2 only when in a continuation section. -2 indicates, \"don't include this line at all, not even as a blank line to which the JOIN string (default \"\\n\") will apply.\n\t\t\t}\n\t\t\tif (*cp == ')') // This is the last line of the continuation section.\n\t\t\t{\n\t\t\t\tltrim(aBuf); // Ltrim this line unconditionally so that caller will see that it starts with ')' without having to do extra steps.\n\t\t\t\taBuf_length = _tcslen(aBuf); // ltrim() doesn't always return an accurate length, so do it this way.\n\t\t\t}\n\t\t}\n\t}\n\t// Since above didn't return, either:\n\t// 1) We're not in a continuation section at all, so apply ltrim() to support semicolons after tabs or\n\t// other whitespace. Seems best to rtrim also.\n\t// 2) CONTINUATION_SECTION_WITHOUT_COMMENTS but this line is the final line of the section. Apply\n\t// trim() and other logic further below because caller might rely on it.\n\t// 3) CONTINUATION_SECTION_WITH_COMMENTS (i.e. comments allowed), but this line isn't a comment (though\n\t// it may start with ')' and thus be the final line of this section). In either case, need to check\n\t// for same-line comments further below.\n\tif (aInContinuationSection != CONTINUATION_SECTION_WITH_COMMENTS) // Case #1 & #2 above.\n\t{\n\t\taBuf_length = trim(aBuf);\n\t\tif (aInBlockComment)\n\t\t{\n\t\t\tif ( !(*aBuf == '*' && aBuf[1] == '/') )\n\t\t\t\t// Avoid stripping ;comments since that would prevent detection of the comment-end\n\t\t\t\t// in cases like \"; xxx */\".\n\t\t\t\treturn aBuf_length;\n\t\t\t//else the block comment ends at */ and there may be a ;line comment following it.\n\t\t}\n\t\telse if (*aBuf == g_CommentChar)\n\t\t{\n\t\t\t// Due to other checks, aInContinuationSection==false whenever the above condition is true.\n\t\t\t*aBuf = '\\0';\n\t\t\treturn 0;\n\t\t}\n\t}\n\t//else CONTINUATION_SECTION_WITH_COMMENTS (case #3 above), which due to other checking also means that\n\t// this line isn't a comment (though it might have a comment on its right side, which is checked below).\n\t// CONTINUATION_SECTION_WITHOUT_COMMENTS would already have returned higher above if this line isn't\n\t// the last line of the continuation section.\n\n\t// Handle comment-flags that appear to the right of a valid line:\n\tLPTSTR cp, prevp;\n\tfor (cp = _tcschr(aBuf, g_CommentChar); cp; cp = _tcschr(cp + 1, g_CommentChar))\n\t{\n\t\t// If no whitespace to its left, it's not a valid comment.\n\t\t// We insist on this so that a semi-colon (for example) immediately after\n\t\t// a word (as semi-colons are often used) will not be considered a comment.\n\t\tprevp = cp - 1;\n\t\tif (prevp < aBuf) // should never happen because we already checked above.\n\t\t{\n\t\t\t*aBuf = '\\0';\n\t\t\treturn 0;\n\t\t}\n\t\tif (IS_SPACE_OR_TAB_OR_NBSP(*prevp)) // consider it to be a valid comment flag\n\t\t{\n\t\t\t*prevp = '\\0';\n\t\t\taBuf_length = rtrim_with_nbsp(aBuf, prevp - aBuf); // Since it's our responsibility to return a fully trimmed string.\n\t\t\tbreak; // Once the first valid comment-flag is found, nothing after it can matter.\n\t\t}\n\t\telse // No whitespace to the left.\n\t\t{\n\t\t\t// The following is done here, at this early stage, to support escaping the comment flag in\n\t\t\t// hotkeys and directives (the latter is mostly for backward-compatibility).\n\t\t\tLPTSTR p;\n\t\t\tfor (p = prevp; p > aBuf && *p == g_EscapeChar && p[-1] == g_EscapeChar; p -= 2);\n\t\t\tif (p >= aBuf && *p == g_EscapeChar) // Odd number of escape chars: remove the final escape char.\n\t\t\t{\n\t\t\t\t// The following isn't exactly correct because it prevents an include filename from ever\n\t\t\t\t// containing the literal string \"`;\". This is because attempts to escape the accent via\n\t\t\t\t// \"``;\" are not supported. This is documented here as a known limitation because fixing\n\t\t\t\t// it would probably break existing scripts that rely on the fact that accents do not need\n\t\t\t\t// to be escaped inside #Include. Also, the likelihood of \"`;\" appearing literally in a\n\t\t\t\t// legitimate #Include file seems vanishingly small.\n\t\t\t\ttmemmove(prevp, prevp + 1, _tcslen(prevp + 1) + 1); // +1 for the terminator.\n\t\t\t\t--aBuf_length;\n\t\t\t\t// Then continue looking for others.\n\t\t\t}\n\t\t\t// else there wasn't any whitespace to its left, so keep looking in case there's\n\t\t\t// another further on in the line.\n\t\t}\n\t} // for()\n\n\treturn aBuf_length; // The above is responsible for keeping aBufLength up-to-date with any changes to aBuf.\n}\n\n\n\ninline ResultType Script::IsDirective(LPTSTR aBuf)\n// aBuf must be a modifiable string as it may be temporarily terminated at different points.\n// Returns CONDITION_TRUE, CONDITION_FALSE, or FAIL.\n// Note: Don't assume that every line in the script that starts with '#' is a directive\n// because hotkeys can legitimately start with that as well. i.e., the following line should\n// not be unconditionally ignored, just because it starts with '#', since it is a valid hotkey:\n// #y::run, notepad\n{\n\tTCHAR end_flags[] = {' ', '\\t', '\\0'}; // '\\0' must be last.\n\tLPTSTR directive_end, parameter;\n\tif ( !(directive_end = StrChrAny(aBuf, end_flags)) )\n\t{\n\t\tdirective_end = aBuf + _tcslen(aBuf); // Point it to the zero terminator.\n\t\tparameter = NULL;\n\t}\n\telse\n\t\tif (!*(parameter = omit_leading_whitespace(directive_end)))\n\t\t\tparameter = NULL;\n\n\t// Make a null-terminated copy of the potential directive name, if not already terminated,\n\t// so that overlapping names such as #MaxThreads and #MaxThreadsPerHotkey won't get mixed up.\n\t// This significantly reduces code size vs. using tcslicmp() in IS_DIRECTIVE_MATCH().\n\tLPCTSTR directive_name;\n\tTCHAR directive_name_buf[32];\n\tif (directive_end - aBuf >= _countof(directive_name_buf))\n\t\treturn CONDITION_FALSE;\n\tif (*directive_end)\n\t{\n\t\ttcslcpy(directive_name_buf, aBuf, directive_end - aBuf + 1);\n\t\tdirective_name = directive_name_buf;\n\t}\n\telse\n\t\tdirective_name = aBuf;\n\t#define IS_DIRECTIVE_MATCH(directive) (!_tcsicmp(directive_name, directive))\n\n\tbool is_include_again = false; // Set default in case of short-circuit boolean.\n\tif (IS_DIRECTIVE_MATCH(_T(\"#Include\")) || (is_include_again = IS_DIRECTIVE_MATCH(_T(\"#IncludeAgain\"))))\n\t{\n\t\t// Standalone EXEs ignore this directive since the included files were already merged in\n\t\t// with the main file when the script was compiled. These should have been removed\n\t\t// or commented out by Ahk2Exe, but just in case, it's safest to ignore them:\n#ifdef AUTOHOTKEYSC\n\t\treturn CONDITION_TRUE;\n#else\n\t\tif (!parameter)\n\t\t\treturn ScriptError(ERR_PARAM1_REQUIRED, aBuf);\n\t\t\n\t\t// Permit quote marks around the parameter. In future, quote marks might be required,\n\t\t// or the parameter might be evaluated as an expression.\n\t\tparameter = strip_quote_marks(parameter);\n\t\tif (!*parameter)\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID);\n\n\t\t// v1.0.32:\n\t\tbool ignore_load_failure = (parameter[0] == '*' && ctoupper(parameter[1]) == 'I' && IS_SPACE_OR_TAB(parameter[2])); // Relies on short-circuit boolean order.\n\t\tif (ignore_load_failure)\n\t\t\tparameter += 3; // Skip over at most one space or tab, since others might be a literal part of the filename.\n\n\t\tif (*parameter == '<') // Support explicitly-specified <standard_lib_name>.\n\t\t{\n\t\t\tLPTSTR parameter_end = _tcschr(parameter, '>');\n\t\t\tif (parameter_end && !parameter_end[1])\n\t\t\t{\n\t\t\t\t++parameter; // Remove '<'.\n\t\t\t\t*parameter_end = '\\0'; // Remove '>'.\n\t\t\t\t// Save the working directory; see the similar line below for details.\n\t\t\t\tLPTSTR prev_dir = GetWorkingDir();\n\t\t\t\t// Attempt to find the script file in a Lib folder:\n\t\t\t\tauto path = FindLibraryFile(parameter, parameter_end - parameter);\n\t\t\t\t// Attempt to include the file if found:\n\t\t\t\tbool error_was_shown = path && !LoadIncludedFile(path, false, ignore_load_failure);\n\t\t\t\t// Restore the working directory.\n\t\t\t\tif (prev_dir)\n\t\t\t\t{\n\t\t\t\t\tSetCurrentDirectory(prev_dir);\n\t\t\t\t\tfree(prev_dir);\n\t\t\t\t}\n\t\t\t\t// If any file was included, consider it a success; i.e. allow #include <lib> and #include <lib_func>.\n\t\t\t\tif (!error_was_shown && (path || ignore_load_failure))\n\t\t\t\t\treturn CONDITION_TRUE;\n\t\t\t\t*parameter_end = '>'; // Restore '>' for display to the user.\n\t\t\t\treturn error_was_shown ? FAIL : ScriptError(_T(\"Script library not found.\"), aBuf);\n\t\t\t}\n\t\t\t//else invalid syntax; treat it as a regular #include which will almost certainly fail.\n\t\t}\n\n\t\tLPTSTR include_path;\n\t\tif (!DerefInclude(include_path, parameter))\n\t\t\treturn FAIL;\n\n\t\tDWORD attr = GetFileAttributes(include_path);\n\t\tif (attr != 0xFFFFFFFF && (attr & FILE_ATTRIBUTE_DIRECTORY)) // File exists and its a directory (possibly A_ScriptDir or A_AppData set above).\n\t\t{\n\t\t\t// v1.0.35.11 allow changing of load-time directory to increase flexibility. This feature has\n\t\t\t// been asked for directly or indirectly several times.\n\t\t\t// If a script ever wants to use a string like \"%A_ScriptDir%\" literally in an include's filename,\n\t\t\t// that would not work. But that seems too rare to worry about.\n\t\t\t// v1.0.45.01: Call SetWorkingDir() vs. SetCurrentDirectory() so that it succeeds even for a root\n\t\t\t// drive like C: that lacks a backslash (see SetWorkingDir() for details).\n\t\t\tSetWorkingDir(include_path);\n\t\t\tfree(include_path);\n\t\t\treturn CONDITION_TRUE;\n\t\t}\n\t\t// Save the working directory because LoadIncludedFile() changes it, and we want to retain any directory\n\t\t// set by a previous instance of \"#Include DirPath\" for any other instances of #Include below this line.\n\t\tLPTSTR prev_dir = GetWorkingDir();\n\t\t// Since above didn't return, it's a file (or non-existent file, in which case the below will display\n\t\t// the error). This will also display any other errors that occur:\n\t\tResultType result = LoadIncludedFile(include_path, is_include_again, ignore_load_failure) ? CONDITION_TRUE : FAIL;\n\t\t// Restore the working directory.\n\t\tif (prev_dir)\n\t\t{\n\t\t\tSetCurrentDirectory(prev_dir);\n\t\t\tfree(prev_dir);\n\t\t}\n\t\tfree(include_path);\n\t\treturn result;\n#endif\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#DllLoad\")))\n\t{\n\t\tif (!parameter)\n\t\t{\n\t\t\t// an empty #DllLoad restores the default search order.\n\t\t\tif (!SetDllDirectory(NULL))\n\t\t\t\treturn ScriptError(ERR_INTERNAL_CALL);\n\t\t\treturn CONDITION_TRUE;\n\t\t}\n\n\t\t// Permit quote marks around the parameter. In future, quote marks might be required,\n\t\t// or the parameter might be evaluated as an expression.\n\t\tparameter = strip_quote_marks(parameter);\n\n\t\t// ignore failure if path is preceeded by \"*i\".\n\t\tbool ignore_load_failure = (parameter[0] == '*' && ctoupper(parameter[1]) == 'I'); // Relies on short-circuit boolean order.\n\t\tif (ignore_load_failure)\n\t\t{\n\t\t\tparameter += 2;\n\t\t\tif (IS_SPACE_OR_TAB(*parameter)) // Skip over at most one space or tab, since others might be a literal part of the filename.\n\t\t\t\t++parameter;\n\t\t}\n\t\tLPTSTR library_path;\t// needs to be freed before return, unless DerefInclude return FAIL.\n\t\tif (!DerefInclude(library_path, parameter))\n\t\t\treturn FAIL;\n\t\tDWORD attr = GetFileAttributes(library_path);\n\t\tif (attr != 0xFFFFFFFF && (attr & FILE_ATTRIBUTE_DIRECTORY)) // File exists and its a directory\n\t\t{\n\t\t\tBOOL result = SetDllDirectory(library_path);\n\t\t\tfree(library_path);\n\t\t\tif (!result)\n\t\t\t\treturn ScriptError(ERR_INTERNAL_CALL);\n\t\t\treturn CONDITION_TRUE;\n\t\t}\n\t\tResultType result = CONDITION_TRUE;\t// set default\n\t\tHMODULE hmodule = LoadLibrary(library_path);\n\n\t\tif (hmodule)\n\t\t\t// \"Pin\" the dll so that the script cannot unload it with FreeLibrary.\n\t\t\t// This is done to avoid undefined behaviour when DllCall optimizations\n\t\t\t// resolves a proc address in a dll loaded by this directive.\n\t\t\tGetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_PIN, library_path, &hmodule); // MSDN regarding hmodule: \"If the function fails, this parameter is NULL.\"\n\n\t\tif (!hmodule\t\t\t\t\t// the library couldn't be loaded\n\t\t\t&& !ignore_load_failure)\t// no *i was specified\n\t\t\tresult = ScriptError(_T(\"Failed to load DLL.\"), library_path);\n\t\tfree(library_path);\n\t\treturn result;\n\t} // end #DllLoad\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#NoTrayIcon\")))\n\t{\n\t\tg_NoTrayIcon = true;\n\t\treturn CONDITION_TRUE;\n\t}\n\tif (IS_DIRECTIVE_MATCH(_T(\"#SingleInstance\")))\n\t{\n\t\t// Since \"Prompt\" is the default mode when #SingleInstance is not present, make #SingleInstance\n\t\t// on its own activate \"Force\" mode. But also allow \"Force\" and \"Prompt\" explicitly, since it\n\t\t// might help clarity (and may be useful for overriding an #include?).\n\t\tif (!parameter || !_tcsicmp(parameter, _T(\"Force\")))\n\t\t\tg_AllowOnlyOneInstance = SINGLE_INSTANCE_REPLACE;\n\t\telse if (!_tcsicmp(parameter, _T(\"Prompt\")))\n\t\t\tg_AllowOnlyOneInstance = SINGLE_INSTANCE_PROMPT;\n\t\telse if (!_tcsicmp(parameter, _T(\"Ignore\")))\n\t\t\tg_AllowOnlyOneInstance = SINGLE_INSTANCE_IGNORE;\n\t\telse if (!_tcsicmp(parameter, _T(\"Off\")))\n\t\t\tg_AllowOnlyOneInstance = SINGLE_INSTANCE_OFF;\n\t\telse // Since it could be a typo like \"Of\", alert the user:\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID, aBuf);\n\t\treturn CONDITION_TRUE;\n\t}\n\tif (IS_DIRECTIVE_MATCH(_T(\"#UseHook\")))\n\t{\n\t\tif (!ConvertDirectiveBool(parameter, g_ForceKeybdHook, true))\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID, parameter);\n\t\treturn CONDITION_TRUE;\n\t}\n\n\t// L4: Handle #HotIf (expression) directive.\n\tif (IS_DIRECTIVE_MATCH(_T(\"#HotIf\")))\n\t{\n\t\t// Disallow #HotIf inside a function or class.\n\t\tif (mClassObjectCount || g->CurrentFunc)\n\t\t\treturn ScriptError(ERR_INVALID_USAGE);\n\n\t\tif (!parameter) // The omission of the parameter indicates that any existing criteria should be turned off.\n\t\t{\n\t\t\tg->HotCriterion = NULL; // Indicate that no criteria are in effect for subsequent hotkeys.\n\t\t\treturn CONDITION_TRUE;\n\t\t}\n\n\t\t// Check for a duplicate #HotIf expression;\n\t\t// - Prevents duplicate hotkeys under separate copies of the same expression.\n\t\t// - HotIf would only be able to select the first expression with the given source code.\n\t\t// - Conserves memory.\n\t\tif (g->HotCriterion = FindHotkeyIfExpr(parameter))\n\t\t\treturn CONDITION_TRUE;\n\n\t\tauto pending_hotkey = mPendingHotkey;\n\t\tmPendingHotkey = nullptr;\n\n\t\t// Create a function to return the result of the expression\n\t\t// specified by \"parameter\":\n\n\t\tauto func = CreateHotFunc();\n\t\t\n\t\tauto fr = Hotkey::IfExpr(func); // Set the new criterion.\n\t\tif (fr != OK) // Only OK and FR_E_OUTOFMEM should be possible given how it's called.\n\t\t\treturn fr == FR_E_OUTOFMEM ? ScriptError(ERR_OUTOFMEM) : FAIL;\n\n\t\tg->HotCriterion->OriginalExpr = SimpleHeap::Alloc(parameter);\n\t\t\n\t\tif (!ParseAndAddLineInBlock(parameter, ACT_HOTKEY_IF)) // PreparseExpressions will change this to ACT_RETURN\n\t\t\treturn ScriptError(ERR_OUTOFMEM);\n\n\t\tif (mExprContainingThisFunc)\n\t\t\tmExprContainingThisFunc->pending_hotkey = pending_hotkey;\n\t\telse\n\t\t{\n\t\t\tmPendingHotkey = pending_hotkey;\n\t\t\tfunc->mJumpToLine->mAttribute = g->HotCriterion; // Must be set for PreparseHotkeyIfExpr\n\t\t}\n\t\t\n\t\treturn CONDITION_TRUE;\n\t}\n\n\t// L4: Allow #HotIf timeout to be adjusted.\n\tif (IS_DIRECTIVE_MATCH(_T(\"#HotIfTimeout\")))\n\t{\n\t\tif (parameter)\n\t\t\tg_HotExprTimeout = ATOU(parameter);\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#Hotstring\")))\n\t{\n\t\tif (parameter)\n\t\t{\n\t\t\tLPTSTR suboption = tcscasestr(parameter, _T(\"EndChars\"));\n\t\t\tif (suboption)\n\t\t\t{\n\t\t\t\t// Since it's not realistic to have only a couple, spaces and literal tabs\n\t\t\t\t// must be included in between other chars, e.g. `n `t has a space in between.\n\t\t\t\t// Also, EndChar \\t will have a space and a tab since there are two spaces\n\t\t\t\t// after the word EndChar.\n\t\t\t\tif ( !(parameter = StrChrAny(suboption, _T(\"\\t \"))) )\n\t\t\t\t\treturn CONDITION_TRUE;\n\t\t\t\tparameter++;\n\t\t\t\tConvertEscapeSequences(g_EndChars, _countof(g_EndChars), parameter, _tcslen(parameter));\n\t\t\t\treturn CONDITION_TRUE;\n\t\t\t}\n\t\t\tif (!_tcsnicmp(parameter, _T(\"NoMouse\"), 7)) // v1.0.42.03\n\t\t\t{\n\t\t\t\tg_HSResetUponMouseClick = false;\n\t\t\t\treturn CONDITION_TRUE;\n\t\t\t}\n\t\t\t// Otherwise assume it's a list of options. Note that for compatibility with its\n\t\t\t// other caller, it will stop at end-of-string or ':', whichever comes first.\n\t\t\tHotstring::ParseOptions(parameter, g_HSPriority, g_HSKeyDelay, g_HSSendMode, g_HSCaseSensitive\n\t\t\t\t, g_HSConformToCase, g_HSDoBackspace, g_HSOmitEndChar, g_HSSendRaw, g_HSEndCharRequired\n\t\t\t\t, g_HSDetectWhenInsideWord, g_HSDoReset, g_HSSameLineAction, g_SuspendExemptHS);\n\t\t}\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#MaxThreadsPerHotkey\")))\n\t{\n\t\tif (parameter)\n\t\t{\n\t\t\t// Use value as a temp holder since it's int vs. UCHAR and can thus detect very large or negative values:\n\t\t\tint value = ATOI(parameter); // parameter was set to the right position by the above macro\n\t\t\tif (value > MAX_THREADS_LIMIT) // For now, keep this limited to prevent stack overflow due to too many pseudo-threads.\n\t\t\t\tvalue = MAX_THREADS_LIMIT; // UPDATE: To avoid array overflow, this limit must by obeyed except where otherwise documented.\n\t\t\telse if (value < 1)\n\t\t\t\tvalue = 1;\n\t\t\tg_MaxThreadsPerHotkey = value; // Note: g_MaxThreadsPerHotkey is UCHAR.\n\t\t}\n\t\treturn CONDITION_TRUE;\n\t}\n\tif (IS_DIRECTIVE_MATCH(_T(\"#MaxThreadsBuffer\")))\n\t{\n\t\tif (!ConvertDirectiveBool(parameter, g_MaxThreadsBuffer, true))\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID, parameter);\n\t\treturn CONDITION_TRUE;\n\t}\n\tif (IS_DIRECTIVE_MATCH(_T(\"#MaxThreads\")))\n\t{\n\t\tif (parameter)\n\t\t{\n\t\t\tint value = ATOI(parameter); // parameter was set to the right position by the above macro\n\t\t\tif (value > MAX_THREADS_LIMIT) // For now, keep this limited to prevent stack overflow due to too many pseudo-threads.\n\t\t\t\tvalue = MAX_THREADS_LIMIT; // UPDATE: To avoid array overflow, this limit must by obeyed except where otherwise documented.\n\t\t\telse if (value < 1)\n\t\t\t\tvalue = 1;\n\t\t\tg_MaxThreadsTotal = value;\n\t\t}\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#SuspendExempt\")))\n\t{\n\t\tif (!ConvertDirectiveBool(parameter, g_SuspendExempt, true))\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID, aBuf);\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#ClipboardTimeout\")))\n\t{\n\t\tif (parameter)\n\t\t\tg_ClipboardTimeout = ATOI(parameter); // parameter was set to the right position by the above macro\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#WinActivateForce\")))\n\t{\n\t\tg_WinActivateForce = true;\n\t\treturn CONDITION_TRUE;\n\t}\n\tif (IS_DIRECTIVE_MATCH(_T(\"#ErrorStdOut\")))\n\t{\n\t\t// Permit quote marks around the parameter. In future, quote marks might be required,\n\t\t// or the parameter might be evaluated as an expression.\n\t\tparameter = strip_quote_marks(parameter);\n\t\tSetErrorStdOut(parameter);\n\t\tif (mErrorStdOutCP == -1)\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID, parameter);\n\t\treturn CONDITION_TRUE;\n\t}\n\t\n\tif (IS_DIRECTIVE_MATCH(_T(\"#InputLevel\")))\n\t{\n\t\t// All hotkeys declared after this directive are assigned the specified InputLevel.\n\t\t// Input generated at a given SendLevel can only trigger hotkeys that belong to a\n\t\t// lower InputLevel. Hotkeys at the lowest level (0) cannot be triggered by any\n\t\t// generated input (the same behavior as AHK versions before this feature).\n\t\t// The default level is 0.\n\n\t\tint group = parameter ? ATOI(parameter) : 0;\n\t\tif (!SendLevelIsValid(group))\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID, aBuf);\n\n\t\tg_InputLevel = group;\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#Warn\")))\n\t{\n\t\tif (!parameter)\n\t\t\tparameter = _T(\"\");\n\n\t\tLPTSTR param1_end = _tcschr(parameter, g_delimiter);\n\t\tLPTSTR param2 = _T(\"\");\n\t\tif (param1_end)\n\t\t{\n\t\t\tparam2 = omit_leading_whitespace(param1_end + 1);\n\t\t\tparam1_end = omit_trailing_whitespace(parameter, param1_end - 1);\n\t\t\tparam1_end[1] = '\\0';\n\t\t}\n\n\t\tint i;\n\n\t\tstatic const LPCTSTR sWarnTypes[] = { WARN_TYPE_STRINGS };\n\t\tWarnType warnType = INVALID_WARN_TYPE; // Set default.\n\t\tif (*parameter)\n\t\t{\n\t\t\tfor (i = 0;; ++i)\n\t\t\t{\n\t\t\t\tif (i == _countof(sWarnTypes))\n\t\t\t\t{\n\t\t\t\t\tif (*param2)\n\t\t\t\t\t\treturn ScriptError(ERR_PARAM_INVALID, aBuf);\n\t\t\t\t\tparam2 = parameter;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tif (!_tcsicmp(parameter, sWarnTypes[i]))\n\t\t\t\t{\n\t\t\t\t\twarnType = (WarnType)i;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tstatic const LPCTSTR sWarnModes[] = { WARN_MODE_STRINGS };\n\t\tWarnMode warnMode = WARNMODE_ON; // Set default.\n\t\tif (*param2)\n\t\t{\n\t\t\tfor (i = 0; ; ++i)\n\t\t\t{\n\t\t\t\tif (i == _countof(sWarnModes))\n\t\t\t\t\treturn ScriptError(ERR_PARAM2_INVALID, param2);\n\t\t\t\tif (!_tcsicmp(param2, sWarnModes[i]))\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t\twarnMode = (WarnMode)i;\n\t\t}\n\n\t\t// The following series of \"if\" statements was confirmed to produce smaller code\n\t\t// than a switch() with a final case WARN_ALL that duplicates all of the assignments:\n\n\t\tif (warnType == WARN_LOCAL_SAME_AS_GLOBAL || warnType == WARN_ALL)\n\t\t\tmCurrentModule->Warn_LocalSameAsGlobal = warnMode;\n\t\t\n\t\tif (warnType == INVALID_WARN_TYPE) // Type not specified.\n\t\t\tif (warnMode == WARNMODE_ON) // Mode \"On\" or not specified.\n\t\t\t{\n\t\t\t\tif (!*param2)\n\t\t\t\t\tmCurrentModule->Warn_LocalSameAsGlobal = WARNMODE_OFF; // Reset to universal default.\n\t\t\t\twarnType = WARN_ALL; // Reset the rest to ON.\n\t\t\t}\n\t\t\telse\n\t\t\t\tg_WarnMode = warnMode;\n\n\t\tif (warnType == WARN_UNREACHABLE || warnType == WARN_ALL)\n\t\t\tmCurrentModule->Warn_Unreachable = warnMode;\n\n\t\tif (warnType == WARN_VAR_UNSET || warnType == WARN_ALL)\n\t\t\tmCurrentModule->Warn_VarUnset = warnMode;\n\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#Requires\")))\n\t{\n#ifdef AUTOHOTKEYSC\n\t\treturn CONDITION_TRUE; // Omit the checks for compiled scripts to reduce code size.\n#else\n\t\tif (!parameter)\n\t\t\treturn ScriptError(ERR_PARAM1_REQUIRED);\n\n\t\tif (!_tcsnicmp(parameter, _T(\"AutoHotkey\"), 10))\n\t\t{\n\t\t\tif (!parameter[10]) // Just #requires AutoHotkey; would seem silly to warn the user in this case.\n\t\t\t\treturn CONDITION_TRUE;\n\n\t\t\tif (IS_SPACE_OR_TAB(parameter[10]))\n\t\t\t{\n\t\t\t\tTCHAR word[32];\n\t\t\t\tfor (LPCTSTR end, cp = parameter + 11; ; cp = end)\n\t\t\t\t{\n\t\t\t\t\tcp = omit_leading_whitespace(cp);\n\t\t\t\t\tif (!*cp)\n\t\t\t\t\t\treturn CONDITION_TRUE;\n\t\t\t\t\t\n\t\t\t\t\tfor (end = cp; *end && !IS_SPACE_OR_TAB(*end); ++end);\n\t\t\t\t\ttcslcpy(word, cp, min(_countof(word), end - cp + 1));\n\n\t\t\t\t\t// Allow these words when appropriate: 32-bit, 64-bit\n\t\t\t\t\tif (!_tcsicmp(word, _T(AHK_BIT)))\n\t\t\t\t\t\tcontinue;\n\n\t\t\t\t\t// It's either an unment requirement or a version number.\n\t\t\t\t\tif (VersionSatisfies(T_AHK_VERSION, word))\n\t\t\t\t\t\tcontinue;\n\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\t// Unmet or unrecognized requirement.\n\t\treturn RequirementError(parameter);\n#endif\n\t}\n\t\n\tif (IS_DIRECTIVE_MATCH(_T(\"#DefaultReturn\")))\n\t{\n\t\tif (!parameter)\n\t\t\treturn ScriptError(ERR_PARAM1_REQUIRED);\n\t\tif (!_tcsicmp(parameter, _T(\"unset\")))\n\t\t\tmDefaultReturn = SYM_MISSING;\n\t\telse if (!_tcsicmp(parameter, _T(\"\\\"\\\"\"))) // Enforce consistency for this back-compat switch; require \"\" and not ''.\n\t\t\tmDefaultReturn = SYM_STRING;\n\t\telse\n\t\t\treturn ScriptError(ERR_PARAM1_INVALID, parameter);\n\t\treturn CONDITION_TRUE;\n\t}\n\n\tif (IS_DIRECTIVE_MATCH(_T(\"#Module\")))\n\t{\n\t\tif (mLineParent || mClassObjectCount)\n\t\t\treturn ScriptError(ERR_UNEXPECTED_DIRECTIVE, aBuf);\n\t\tif (!parameter)\n\t\t\treturn ScriptError(ERR_PARAM1_REQUIRED);\n\t\treturn ParseModuleDirective(parameter);\n\t}\n\n\t// Otherwise, report that this line isn't a directive:\n\treturn CONDITION_FALSE;\n}\n\n\n\nResultType Script::ConvertDirectiveBool(LPTSTR aBuf, bool &aResult, bool aDefault)\n{\n\tif (!aBuf || !*aBuf)\n\t\taResult = aDefault;\n\telse if (!_tcsicmp(aBuf, _T(\"True\")) || *aBuf == '1' && !aBuf[1])\n\t\taResult = true;\n\telse if (!_tcsicmp(aBuf, _T(\"False\")) || *aBuf == '0' && !aBuf[1])\n\t\taResult = false;\n\telse\n\t\treturn FAIL;\n\treturn OK;\n}\n\n\n\nResultType Script::RequirementError(LPCTSTR aRequirement)\n{\n\tTCHAR buf[512];\n\tsntprintf(buf, _countof(buf), _T(\"This script requires %s.\\n\\nCurrent interpreter: %s v%s %s\\n%s\")\n\t\t, aRequirement, T_AHK_NAME, T_AHK_VERSION, _T(AHK_BIT), mOurEXE);\n\treturn ScriptError(buf);\n}\n\n\n\nvoid ScriptTimer::Disable()\n{\n\tmEnabled = false;\n\t--g_script.mTimerEnabledCount;\n\tif (!g_script.mTimerEnabledCount && !g_nLayersNeedingTimer && !Hotkey::sJoyHotkeyCount)\n\t\tKILL_MAIN_TIMER\n\t// Above: If there are now no enabled timed subroutines, kill the main timer since there's no other\n\t// reason for it to exist if we're here. This is because or direct or indirect caller is\n\t// currently always ExecUntil(), which doesn't need the timer while its running except to\n\t// support timed subroutines. UPDATE: The above is faulty; Must also check g_nLayersNeedingTimer\n\t// because our caller can be one that still needs a timer as proven by this script that\n\t// hangs otherwise:\n\t//SetTimer, Test, on \n\t//Sleep, 1000 \n\t//msgbox, done\n\t//return\n\t//Test: \n\t//SetTimer, Test, off \n\t//return\n}\n\n\n\nResultType Script::UpdateOrCreateTimer(IObject *aCallback\n\t, bool aUpdatePeriod, __int64 aPeriod, bool aUpdatePriority, int aPriority)\n// Caller should specific a blank aPeriod to prevent the timer's period from being changed\n// (i.e. if caller just wants to turn on or off an existing timer). But if it does this\n// for a non-existent timer, that timer will be created with the default period as specified in\n// the constructor.\n{\n\tScriptTimer *timer;\n\tfor (timer = mFirstTimer; timer != NULL; timer = timer->mNextTimer)\n\t\tif (timer->mCallback == aCallback) // Match found.\n\t\t\tbreak;\n\tbool timer_existed = (timer != NULL);\n\tif (!timer_existed) // Create it.\n\t{\n\t\ttimer = new ScriptTimer(aCallback);\n\t\tif (!mFirstTimer)\n\t\t\tmFirstTimer = mLastTimer = timer;\n\t\telse\n\t\t{\n\t\t\tmLastTimer->mNextTimer = timer;\n\t\t\t// This must be done after the above:\n\t\t\tmLastTimer = timer;\n\t\t}\n\t\t++mTimerCount;\n\t}\n\n\tif (!timer->mEnabled)\n\t{\n\t\ttimer->mEnabled = true;\n\t\t++mTimerEnabledCount;\n\t\tSET_MAIN_TIMER // Ensure the API timer is always running when there is at least one enabled timed subroutine.\n\t\tif (timer_existed)\n\t\t{\n\t\t\t// mEnabled is currently used to mark a running timer for deletion upon return.\n\t\t\t// Since the timer could be recreated by a different thread which just happens\n\t\t\t// to interrupt the timer thread, it seems best for consistency to reset Period\n\t\t\t// and Priority as though it had already been deleted.\n\t\t\taUpdatePeriod = true;\n\t\t\taUpdatePriority = true;\n\t\t}\n\t}\n\n\tif (aUpdatePeriod)\n\t{\n\t\tif (aPeriod < 0) // Support negative periods to mean \"run only once\".\n\t\t{\n\t\t\ttimer->mRunOnlyOnce = true;\n\t\t\ttimer->mPeriod = (DWORD)-aPeriod;\n\t\t}\n\t\telse // Positive number.\n\t\t{\n\t\t\ttimer->mPeriod = (DWORD)aPeriod;\n\t\t\ttimer->mRunOnlyOnce = false;\n\t\t}\n\t\tif (timer->mPeriod == 1)\n\t\t\ttimer->mPeriod = 0; // Allow execution within the same tick (though not guaranteed).\n\t}\n\n\tif (aUpdatePriority)\n\t\ttimer->mPriority = aPriority;\n\n\tif (aUpdatePeriod || !aUpdatePriority)\n\t\t// Caller relies on us updating mTimeLastRun in this case. This is done because it's more\n\t\t// flexible, e.g. a user might want to create a timer that is triggered 5 seconds from now.\n\t\t// In such a case, we don't want the timer's first triggering to occur immediately.\n\t\t// Instead, we want it to occur only when the full 5 seconds have elapsed:\n\t\ttimer->mTimeLastRun = GetTickCount();\n\n // Below is obsolete, see above for why:\n\t// We don't have to kill or set the main timer because the only way this function is called\n\t// is directly from the execution of a script line inside ExecUntil(), in which case:\n\t// 1) KILL_MAIN_TIMER is never needed because the timer shouldn't exist while in ExecUntil().\n\t// 2) SET_MAIN_TIMER is never needed because it will be set automatically the next time ExecUntil()\n\t// calls MsgSleep().\n\treturn OK;\n}\n\n\n\nvoid Script::DeleteTimer(IObject *aLabel)\n{\n\tScriptTimer *timer, *previous = NULL;\n\tfor (timer = mFirstTimer; timer != NULL; previous = timer, timer = timer->mNextTimer)\n\t\tif (timer->mCallback == aLabel) // Match found.\n\t\t{\n\t\t\t// Disable it, even if it's not technically being deleted yet.\n\t\t\tif (timer->mEnabled)\n\t\t\t\ttimer->Disable(); // Keeps track of mTimerEnabledCount and whether the main timer is needed.\n\t\t\tif (timer->mExistingThreads // This condition differs from g->CurrentTimer == timer, which only detects the \"top-most\" timer.\n\t\t\t\t|| timer->mDeleteLocked)\n\t\t\t{\n\t\t\t\t// In this case we can't delete the timer yet, but CheckScriptTimers()\n\t\t\t\t// will check mEnabled after the callback returns and will delete it then.\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// Remove it from the list.\n\t\t\tif (previous)\n\t\t\t\tprevious->mNextTimer = timer->mNextTimer;\n\t\t\telse\n\t\t\t\tmFirstTimer = timer->mNextTimer;\n\t\t\tif (mLastTimer == timer)\n\t\t\t\tmLastTimer = previous;\n\t\t\tmTimerCount--;\n\t\t\t// Delete the timer, automatically releasing its reference to the object.\n\t\t\tdelete timer;\n\t\t\tbreak;\n\t\t}\n}\n\n\n\nLabel *Script::FindLabel(LPCTSTR aLabelName)\n// Returns the first label whose name matches aLabelName, or NULL if not found.\n\n// If duplicates labels are now possible, callers must be aware that only the first match is returned.\n// This helps performance by requiring on average only half the labels to be searched before\n// a match is found.\n{\n\tif (!aLabelName || !*aLabelName) return NULL;\n\tfor (auto label = CurrentFirstLabel(); label; label = label->mNextLabel)\n\t\tif (!_tcsicmp(label->mName, aLabelName)) // lstrcmpi() is not used: 1) avoids breaking existing scripts; 2) provides consistent behavior across multiple locales; 3) performance.\n\t\t\treturn label; // Match found.\n\treturn NULL; // No match found.\n}\n\n\n\nResultType Script::AddLabel(LPTSTR aLabelName, bool aAllowDupe)\n// Returns OK or FAIL.\n{\n\tif (!*aLabelName)\n\t\treturn FAIL; // For now, silent failure because callers should check this beforehand.\n\tLabel *&first_label = g->CurrentFunc ? g->CurrentFunc->mFirstLabel : mCurrentModule->mFirstLabel;\n\tLabel *&last_label = g->CurrentFunc ? g->CurrentFunc->mLastLabel : mLastLabel;\n\tif (!aAllowDupe && FindLabel(aLabelName))\n\t{\n\t\t// Don't attempt to dereference label->mJumpToLine because it might not\n\t\t// exist yet. Example:\n\t\t// label1:\n\t\t// label1: <-- This would be a dupe-error but it doesn't yet have an mJumpToLine.\n\t\t// return\n\t\treturn ScriptError(_T(\"Duplicate label.\"), aLabelName);\n\t}\n\tLPTSTR new_name = SimpleHeap::Alloc(aLabelName);\n\tLabel *the_new_label = new Label(new_name); // Pass it the dynamic memory area we created.\n#ifdef CONFIG_DLL\n\t++mLabelCount;\n\tthe_new_label->mLineNumber = mCombinedLineNumber;\n\tthe_new_label->mFileIndex = mCurrFileIndex;\n#endif\n\tthe_new_label->mPrevLabel = last_label; // Whether NULL or not.\n\tif (first_label == NULL)\n\t\tfirst_label = the_new_label;\n\telse\n\t\tlast_label->mNextLabel = the_new_label;\n\t// This must be done after the above:\n\tlast_label = the_new_label;\n\treturn OK;\n}\n\n\n\nResultType Script::ParseAndAddLine(LPTSTR aLineText, ActionTypeType aActionType)\n// Returns OK or FAIL.\n// aLineText needs to be a string whose contents are modifiable (though the string won't be made any\n// longer than it is now, so it doesn't have to be of size LINE_SIZE). This helps performance by\n// allowing the string to be split into sections without having to make temporary copies.\n// aLineText must point to a buffer with room to append \"()\" if it may contain a function call statement\n// (which is only possible when aActionType is ACT_INVALID/omitted or an ACT with possible subaction).\n{\n#ifdef _DEBUG\n\tif (!aLineText || !*aLineText && !aActionType)\n\t\treturn ScriptError(_T(\"DEBUG: ParseAndAddLine() called incorrectly.\"));\n#endif\n\tsize_t line_length = _tcslen(aLineText); // Length is needed in a couple of places.\n\n\tTCHAR action_name[MAX_VAR_NAME_LENGTH + 1], *end_marker;\n\tLPTSTR action_args;\n\n\tif (aActionType)\n\t{\n\t\t*action_name = '\\0';\n\t\tend_marker = NULL; // Indicate that there is no action to mark the end of.\n\t}\n\telse // Action type was not determined by caller.\n\t{\n\t\t// Find the name, if any, at the start of the line.\n\t\tend_marker = ParseActionType(action_name, aLineText);\n\t}\n\t\n\t// Above has ensured that end_marker is the address of the first character after the action name,\n\t// or NULL if there is no action name.\n\tif (end_marker)\n\t{\n\t\taction_args = omit_leading_whitespace(end_marker);\n\t\t// For v2, the interpretation of a control flow keyword shouldn't be affected by whatever\n\t\t// operator follows it, so this is done before checking for assignments or other operators.\n\t\tif (IS_SPACE_OR_TAB(*end_marker) || *end_marker == '(' || !*end_marker || *end_marker == '{')\n\t\t\taActionType = ConvertActionType(action_name);\n\t\tif (*end_marker == '{' && !(aActionType == ACT_ELSE || aActionType == ACT_LOOP\n\t\t\t|| aActionType == ACT_SWITCH || aActionType >= ACT_TRY && aActionType <= ACT_FINALLY))\n\t\t\taActionType = ACT_INVALID; // Not an action for which \"xxx{\" is valid.\n\t}\n\telse\n\t{\n\t\taction_args = aLineText;\n\t}\n\t\n\tif (aLineText[line_length - 1] == '{'\n\t\t&& (!ACT_IS_LINE_PARENT(aActionType) || BalanceExpr(aLineText) > 1)) // Not an action type that permits OTB, or the '{' is enclosed.\n\t{\n\t\t// This is part of a workaround for parser limitations, that allows function definitions to be used\n\t\t// within an expression. Either GetLineContExpr() has determined that this is OTB, or it is at the\n\t\t// end of the script (so there aren't any subsequent lines to be appended to it).\n\t\t// GetLineContExpr()/BalanceExpr() normally balances opening and closing symbols, but in this case\n\t\t// there may be a number of open parentheses/brackets/braces with the close symbol to come after\n\t\t// the function. It does at least ensure aLineText doesn't contain an unterminated quoted string\n\t\t// or consist of just \"){\", so those cases don't need to be handled here.\n\t\tASSERT(line_length > 1); // Should be guaranteed as '{' on its own wouldn't cause a ParseAndAddLine() call.\n\t\tsize_t i = line_length - 2;\n\t\twhile (IS_SPACE_OR_TAB(aLineText[i]) && i)\n\t\t\t--i;\n\t\tif (aLineText[i] != ')')\n\t\t\treturn ScriptError(ERR_UNEXPECTED_OPEN_BRACE);\n\t\tTCHAR quote = 0;\n\t\tint open = 1;\n\t\twhile (i > 0 && open)\n\t\t{\n\t\t\tswitch (aLineText[--i])\n\t\t\t{\n\t\t\tcase ')': ++open; break;\n\t\t\tcase '(': --open; break;\n\t\t\tcase '\"':\n\t\t\tcase '\\'':\n\t\t\t\tfor (quote = aLineText[i--]; i > 0; --i)\n\t\t\t\t\tif (aLineText[i] == quote && !CharIsEscaped(aLineText + i, aLineText))\n\t\t\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\tASSERT(!open);\n\t\tLPTSTR open_paren = aLineText + i;\n\t\tLPTSTR id = open_paren;\n\t\twhile (id > aLineText && IS_IDENTIFIER_CHAR(id[-1]))\n\t\t\t--id;\n\t\tif (id == aLineText && !aActionType)\n\t\t{\n\t\t\t// This catches any lines *starting with* a function definition that somehow make it here instead of\n\t\t\t// going to DefineFunc(). Without this, the definition might be called since the preprocessed line\n\t\t\t// will look like a function call statement.\n\t\t\tmCurrLine = nullptr;\n\t\t\treturn ScriptError(ERR_UNEXPECTED_DECL, aLineText);\n\t\t}\n\t\tif (end_marker) // Action name was parsed from aLineText, so to repeat that we must reset aActionType.\n\t\t\taActionType = ACT_INVALID; // Store the original value passed by our caller.\n\t\t// Save everything up to (but not including) the open parentheses. When the close brace\n\t\t// is found, anything following it will be appended to this code, effectively forming an\n\t\t// expression which references the function by name.\n\t\tsize_t len = open_paren - aLineText;\n\t\tLPTSTR code = tmalloc(len + 1);\n\t\tif (!code)\n\t\t\treturn MemoryError();\n\t\ttmemcpy(code, aLineText, len);\n\t\tcode[len] = '\\0';\n\t\tauto expr = new PartialExpression(code, len, aActionType, *this); // Save the prefix code and some current script state.\n\t\t// Parse the start of the function definition, including the open brace.\n\t\tif (!DefineFunc(id, false, FuncDefExpression))\n\t\t{\n\t\t\tdelete expr;\n\t\t\treturn FAIL;\n\t\t}\n\t\texpr->func = g->CurrentFunc; // Save this so that the correct block-end is detected.\n\t\tmExprContainingThisFunc = expr;\n\t\treturn OK;\n\t}\n\n\tbool add_openbrace_afterward = false; // v1.0.41: Set default for use in supporting brace in \"if (expr) {\" and \"Loop {\".\n\tbool all_args_are_expressions = false;\n\n\tif (!aActionType) // i.e. not yet determined.\n\t{\n\t\t//////////////////////////////////////////////////////\n\t\t// Detect operators and assignments such as := and +=\n\t\t//////////////////////////////////////////////////////\n\n\t\tif (*aLineText == '\"' || *aLineText == '\\'')\n\t\t{\n\t\t\taction_args = aLineText + FindTextDelim(aLineText, *aLineText, 1);\n\t\t\tif (*action_args)\n\t\t\t{\n\t\t\t\taction_args = omit_leading_whitespace(action_args + 1);\n\t\t\t\tif (*action_args != '.') // Don't treat \"\" := x as valid.\n\t\t\t\t\taction_args = aLineText;\n\t\t\t}\n\t\t}\n\n\t\tTCHAR action_args_2nd_char = action_args[1];\n\n\t\tswitch(*action_args)\n\t\t{\n\t\tcase ':':\n\t\t\t// v1.0.40: Allow things like \"MsgBox :: test\" to be valid by insisting that '=' follows ':'.\n\t\t\t// v2.0: The example above is invalid, but it's still best to verify this is really ':='.\n\t\t\tif (action_args_2nd_char == '=') // i.e. :=\n\t\t\t\taActionType = action_args[2] ? ACT_ASSIGNEXPR : ACT_EXPRESSION; // ACT_EXPRESSION is used to produce a more helpful error message.\n\t\t\tbreak;\n\t\tcase '+':\n\t\tcase '-':\n\t\t\t// Support for ++i and --i. Do a complete validation/recognition of the operator to allow\n\t\t\t// a line such as the following, which omits the first optional comma, to still be recognized\n\t\t\t// as a command rather than a variable-with-operator:\n\t\t\t// SetWinDelay -1\n\t\t\t// v2.0: Cases like `x ++` aren't currently supported due to the risk of misinterpreting\n\t\t\t// something like `myfn ++x` or other contrived-but-valid calls like `myfn ++(b ? x : y)`\n\t\t\t// or `myfn ++++x`. Unlike ternary, it's probably more common to write ++ without the space.\n\t\t\tif (!end_marker && action_args_2nd_char == *action_args // i.e. the pre-increment/decrement operator; e.g. ++index or --index.\n\t\t\t\t|| action_args_2nd_char == '=') // i.e. x+=y or x-=y (by contrast, post-increment/decrement is recognized only after we check for a command name to cut down on ambiguity).\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\tbreak;\n\t\tcase '*': // *=\n\t\tcase '|': // |=\n\t\tcase '&': // &=\n\t\tcase '^': // ^=\n\t\t\tif (action_args_2nd_char == '=')\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\tbreak;\n\t\tcase '/':\n\t\t\tif (action_args_2nd_char == '=' // i.e. /=\n\t\t\t\t|| action_args_2nd_char == '/' && action_args[2] == '=') // i.e. //=\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\tbreak;\n\t\tcase '>':\n\t\tcase '<':\n\t\t\tif (action_args_2nd_char == *action_args && ( action_args[2] == '='\t// i.e. >>= and <<=\n\t\t\t\t|| (action_args_2nd_char == '>' && action_args[2] == '>' && action_args[3] == '=') )) // >>>=\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\tbreak;\n\t\tcase '?': // Stand-alone ternary beginning with a variable, such as true ? fn1() : fn2().\n\t\t\t// v2.0: Even if this is a valid function name (which is impossible to determine for\n\t\t\t// user-defined functions at this stage), this can't be a valid function call statement\n\t\t\t// since its first parameter would begin with the '?' operator.\n\t\t\tif (action_args_2nd_char != '.')\n\t\t\t{\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// Do some further checking to treat `a.?b c` like `a.b c` (method call statement).\n\t\tcase '.': // L34: Handle dot differently now that dot is considered an action end flag. Detects some more errors and allows some valid expressions which weren't previously allowed.\n\t\t\tif (action_args_2nd_char == '=')\n\t\t\t{\t// Concat-assign .=\n\t\t\t\taActionType = ACT_EXPRESSION;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tLPTSTR id_begin = action_args + (*action_args == '?' ? 2 : 1);\n\t\t\t\tLPTSTR cp, id_end;\n\t\t\t\tbool has_space_or_tab;\n\t\t\t\tfor (;;) // L35: Loop to fix x.y.z() and similar.\n\t\t\t\t{\n\t\t\t\t\tid_end = find_identifier_end(id_begin);\n\t\t\t\t\tif ( id_end == id_begin // No identifier.\n\t\t\t\t\t\t&& *id_end != g_DerefChar // It's not a.%b%\n\t\t\t\t\t\t&& !(id_begin[-2] == '?' && (*id_end == '(' || *id_end == '[')) ) // It's not a?.() or a?.[b]\n\t\t\t\t\t\tbreak; // Invalid.\n\t\t\t\t\tif (*id_end == '(' // Allow function/method Call as standalone expression.\n\t\t\t\t\t\t|| *id_end == g_DerefChar) // Allow dynamic property/method access (too hard to validate what's to the right of %).\n\t\t\t\t\t{\n\t\t\t\t\t\taActionType = ACT_EXPRESSION;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\thas_space_or_tab = IS_SPACE_OR_TAB(*id_end);\n\t\t\t\t\tcp = omit_leading_whitespace(id_end);\n\t\t\t\t\tif (*cp) // Avoid checking cp[1] and cp[2] when !*cp.\n\t\t\t\t\tif (*cp == '[' // x.y[z]\n\t\t\t\t\t\t|| cp[1] == '=' && _tcschr(_T(\":+-*/|&^.\"), cp[0]) // Two-char assignment operator.\n\t\t\t\t\t\t// or there are two repeated characters \n\t\t\t\t\t\t|| cp[1] == cp[0]\n\t\t\t\t\t\t&& ( ( _tcschr(_T(\"/<>?\"), cp[0]) && cp[2] == '=' // //=, <<=, >>= or ??=\n\t\t\t\t\t\t\t\t\t|| *cp == '+' || *cp == '-' ) // x.y++ or x.y--\n\t\t\t\t\t\t\t// or three repeated characters:\n\t\t\t\t\t\t\t|| (cp[0] == '>' && cp[2] == '>' && cp[3] == '=') )\t) // >>>=\n\t\t\t\t\t{\t// Allow Set and bracketed Get as standalone expression.\n\t\t\t\t\t\taActionType = ACT_EXPRESSION;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tif (*cp == '?')\n\t\t\t\t\t\t++cp;\n\t\t\t\t\tif (*cp != '.')\n\t\t\t\t\t{\n\t\t\t\t\t\tif (!*cp || has_space_or_tab)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tend_marker = id_end;\n\t\t\t\t\t\t\t// Let the parentheses be added in the section below.\n\t\t\t\t\t\t}\n\t\t\t\t\t\t//else: Neither a command nor a legal standalone expression.\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tid_begin = cp + 1;\n\t\t\t\t}\n\t\t\t}\n\t\t\tbreak;\n\t\t//default: Leave aActionType set to ACT_INVALID. This also covers case '\\0' in case that's possible.\n\t\t} // switch()\n\n\t\tif (aActionType) // An assignment or other type of action was discovered above.\n\t\t{\n\t\t\tif (aActionType == ACT_ASSIGNEXPR)\n\t\t\t{\n\t\t\t\t// Find the first non-function comma.\n\t\t\t\t// This is done because ACT_ASSIGNEXPR needs to make comma-separated sub-expressions\n\t\t\t\t// into one big ACT_EXPRESSION so that the leftmost sub-expression will get evaluated\n\t\t\t\t// prior to the others (for consistency and as documented).\n\t\t\t\t// ALSO: ACT_ASSIGNEXPR is made into ACT_EXPRESSION *only* when multi-statement\n\t\t\t\t// commas are present because it performs much better for trivial assignments,\n\t\t\t\t// even some which aren't optimized to become non-expressions.\n\t\t\t\tLPTSTR cp = action_args + FindExprDelim(action_args, g_delimiter, 2);\n\t\t\t\tif (*cp) // Found a delimiting comma other than one in a sub-statement or function. Shouldn't need to worry about unquoted escaped commas since they don't make sense with += and -=.\n\t\t\t\t{\n\t\t\t\t\t// Any non-function comma qualifies this as multi-statement.\n\t\t\t\t\taActionType = ACT_EXPRESSION;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// The following converts:\n\t\t\t\t\t// x := 2 -> ACT_ASSIGNEXPR, x, 2\n\t\t\t\t\t*action_args = g_delimiter; // Replace the \":\" with a delimiter for later parsing.\n\t\t\t\t\taction_args[1] = ' '; // Remove the \"=\" from consideration.\n\t\t\t\t}\n\t\t\t}\n\t\t\t//else it's already an isolated expression, so no changes are desired.\n\t\t\taction_args = aLineText; // Since this is an assignment and/or expression, use the line's full text for later parsing.\n\t\t} // if (aActionType)\n\n\t} // Handling of assignments and other operators.\n\t//else aActionType was already determined.\n\n\tif (!aActionType)\n\t{\n\t\tif (end_marker && (!*end_marker || IS_SPACE_OR_TAB(*end_marker))\n\t\t\t&& *action_args != '=' // Allow for a more specific error message for `x = y` when it isn't recognized as an expression (e.g. ternary).\n\t\t\t&& *action_args != ':' // Exclude `default :` (for anything else, this just affects which error message is shown).\n\t\t\t&& !(*action_name <= '9' && *action_name >= '0')) // Exclude numbers, since no function name can start with a number.\n\t\t{\n\t\t\t// Convert function/method call statements to function/method calls.\n\t\t\tif (*end_marker) // Replace space or tab with parenthesis.\n\t\t\t\t*end_marker = '(';\n\t\t\telse\n\t\t\t\taLineText[line_length++] = '(';\n\t\t\taLineText[line_length++] = ')';\n\t\t\taLineText[line_length] = '\\0';\n\t\t\taction_args = aLineText;\n\t\t\taActionType = ACT_EXPRESSION;\n\t\t}\n\t\telse if (*action_args == ':')\n\t\t{\n\t\t\t// Default isn't handled as its own action type because that would only cover the cases\n\t\t\t// where there is a space after the name. This covers \"Default: subaction\", \"Default :\"\n\t\t\t// and \"Default : subaction\". \"Default:\" on its own is handled by label-parsing.\n\t\t\tif (!_tcsicmp(action_name, _T(\"Default\")))\n\t\t\t{\n\t\t\t\tif (!AddLine(ACT_CASE))\n\t\t\t\t\treturn FAIL;\n\t\t\t\taction_args = omit_leading_whitespace(action_args + 1);\n\t\t\t\tif (!*action_args)\n\t\t\t\t\treturn OK;\n\t\t\t\treturn ParseAndAddLine(action_args);\n\t\t\t}\n\t\t}\n\t\telse if (_tcschr(EXPR_ALL_SYMBOLS, *action_args))\n\t\t{\n\t\t\tLPTSTR question_mark;\n\t\t\tif ((*action_args == '+' || *action_args == '-') && action_args[1] == *action_args) // Post-inc/dec. See comments further below.\n\t\t\t{\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\t\taction_args = aLineText; // Since this is an expression, use the line's full text for later parsing.\n\t\t\t}\n\t\t\telse if ((question_mark = _tcschr(action_args,'?')) && _tcschr(question_mark,':')) // Rough check (see comments below). Relies on short-circuit boolean order.\n\t\t\t{\n\t\t\t\t// To avoid hindering load-time error detection such as misspelled command names, allow stand-alone\n\t\t\t\t// expressions only for things that can produce a side-effect (currently only ternaries like\n\t\t\t\t// the ones mentioned later below need to be checked since the following other things were\n\t\t\t\t// previously recognized as ACT_EXPRESSION if appropriate: function-calls, post- and\n\t\t\t\t// pre-inc/dec (++/--), and assignment operators like := += *=\n\t\t\t\t// Stand-alone ternaries are checked for here rather than earlier to allow a command name\n\t\t\t\t// (of present) to take precedence (since stand-alone ternaries seem much rarer than \n\t\t\t\t// \"Command ? something\" such as \"MsgBox ? something\". Could also check for a colon somewhere\n\t\t\t\t// to the right if further ambiguity-resolution is ever needed. Also, a stand-alone ternary\n\t\t\t\t// should have at least one function-call and/or assignment; otherwise it would serve no purpose.\n\t\t\t\t// A line may contain a stand-alone ternary operator to call functions that have side-effects\n\t\t\t\t// or perform assignments. For example:\n\t\t\t\t// IsDone ? fn1() : fn2()\n\t\t\t\t// 3 > 2 ? x:=1 : y:=1\n\t\t\t\t// (3 > 2) ... not supported due to overlap with continuation sections.\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\t\taction_args = aLineText; // Since this is an assignment and/or expression, use the line's full text for later parsing.\n\t\t\t}\n\t\t\t//else leave it as an unknown action to avoid hindering load-time error detection.\n\t\t\t// In other words, don't be too permissive about what gets marked as a stand-alone expression.\n\t\t}\n\t\tif (!aActionType) // Above still didn't find a valid action (i.e. check aActionType again in case the above changed it).\n\t\t{\n\t\t\tif (end_marker && (*end_marker == '(' || *end_marker == '[') // v1.0.46.11: Recognize as multi-statements that start with a function, like \"fn(), x:=4\". v1.0.47.03: Removed the following check to allow a close-brace to be followed by a comma-less function-call: strchr(action_args, g_delimiter).\n\t\t\t\t|| *action_args == g_DerefChar // Something beginning with a double-deref (which may contain expressions).\n\t\t\t\t|| *aLineText == '(' // Probably an expression with parentheses to control order of evaluation. In this case, aLineText == action_args, so it was already handled by the condition above.\n\t\t\t\t)\n\t\t\t{\n\t\t\t\taActionType = ACT_EXPRESSION; // Mark this line as a stand-alone expression.\n\t\t\t\taction_args = aLineText; // Since this is a function-call followed by a comma and some other expression, use the line's full text for later parsing.\n\t\t\t}\n\t\t\telse if (*action_args == '=' && action_args[1] != '=')\n\t\t\t\t// v2: Give a more specific error message since the user probably meant to do an old-style assignment.\n\t\t\t\treturn ScriptError(_T(\"Syntax error. Did you mean to use \\\":=\\\"?\"), aLineText);\n\t\t\telse if (*action_args == g_delimiter)\n\t\t\t\treturn ScriptError(_T(\"Function calls require a space or \\\"(\\\". Use comma only between parameters.\"), aLineText);\n\t\t\telse\n\t\t\t\t// v1.0.40: Give a more specific error message now that hotkeys can make it here due to\n\t\t\t\t// the change that avoids the need to escape double-colons:\n\t\t\t\treturn ScriptError(_tcsstr(aLineText, HOTKEY_FLAG) ? ERR_INVALID_HOTKEY : ERR_UNRECOGNIZED_ACTION, aLineText);\n\t\t}\n\t} // if (!aActionType)\n\telse if (aActionType == ACT_LOOP)\n\t{\n\t\tLPTSTR cp = StrChrAny(action_args, EXPR_OPERAND_TERMINATORS);\n\t\tif (cp && cp > action_args && (IS_SPACE_OR_TAB(*cp) || *cp == g_delimiter))\n\t\t{\n\t\t\tLPTSTR next_nonspace = omit_leading_whitespace(cp);\n\t\t\tbool comma_was_used = *next_nonspace == g_delimiter;\n\t\t\t// Now cp points at the next character after the first word, while next_nonspace points\n\t\t\t// at the next non-whitespace character after that. If comma_was_used, there is also\n\t\t\t// a comma and potentially more whitespace to skip if a valid loop keyword is used.\n\t\t\tTCHAR orig_char = *cp;\n\t\t\t*cp = '\\0'; // Terminate the sub-command name.\n\t\t\tif (!_tcsicmp(_T(\"Files\"), action_args))\n\t\t\t\taActionType = ACT_LOOP_FILE;\n\t\t\telse if (!_tcsicmp(_T(\"Reg\"), action_args))\n\t\t\t\taActionType = ACT_LOOP_REG;\n\t\t\telse if (!_tcsicmp(_T(\"Read\"), action_args))\n\t\t\t\taActionType = ACT_LOOP_READ;\n\t\t\telse if (!_tcsicmp(_T(\"Parse\"), action_args))\n\t\t\t\taActionType = ACT_LOOP_PARSE;\n\t\t\t*cp = orig_char; // Undo the temporary termination.\n\t\t\tif (aActionType != ACT_LOOP) // Loop sub-type discovered above.\n\t\t\t\t// Set action_args to the start of the actual args, skipping the optional delimiter.\n\t\t\t\taction_args = comma_was_used ? omit_leading_whitespace(next_nonspace + 1) : next_nonspace;\n\t\t\telse if (comma_was_used)\n\t\t\t\t// This is a plain word or variable reference followed by a comma. It could be a\n\t\t\t\t// multi-statement expression, but in this case the first sub-statement would have\n\t\t\t\t// no effect, so it's probably an error.\n\t\t\t\treturn ScriptError(_T(\"Invalid loop type.\"), aLineText);\n\t\t}\n\t}\n\telse if (ACT_IS_VAR_DECL(aActionType))\n\t{\n\t\tint declare_type;\n\t\tswitch (aActionType)\n\t\t{\n\t\tcase ACT_STATIC: declare_type = VAR_DECLARE_STATIC; break;\n\t\tcase ACT_LOCAL: declare_type = VAR_DECLARE_LOCAL; break;\n\t\tcase ACT_EXPORT: declare_type = VAR_GLOBAL | VAR_EXPORTED; break;\n\t\tdefault: declare_type = VAR_DECLARE_GLOBAL; break;\n\t\t}\n\n\t\tif (!*action_args) // It's the word \"global\", \"local\", \"static\" by itself.\n\t\t{\n\t\t\t// Any combination of declarations is allowed here for simplicity, but only declarations can\n\t\t\t// appear above this line. This reserves the use of \"global\"/\"static\" inside a nested block\n\t\t\t// for potential future use, rather than letting it affect the entire function .\n\t\t\t// mLastParamInitializer is checked to allow for lines which are added for optional parameters\n\t\t\t// when the parameter's default expression is not a simple literal string or number, since they\n\t\t\t// actually come from the parameter list and not the body of the function.\n\t\t\tif (declare_type != VAR_DECLARE_LOCAL && (mNextLineIsFunctionBody || mLastParamInitializer == mLastLine))\n\t\t\t{\n\t\t\t\tg->CurrentFunc->mDefaultVarType = declare_type;\n\t\t\t\t// No further action is required.\n\t\t\t\treturn OK;\n\t\t\t}\n\t\t\t// Otherwise, it occurs too far down in the body.\n\t\t\treturn ScriptError(ERR_UNEXPECTED_DECL, aLineText);\n\t\t}\n\t\t\t\n\t\t// Since above didn't break or return, a variable is being declared.\n\n\t\tif (!g->CurrentFunc && (declare_type & VAR_LOCAL))\n\t\t\treturn ScriptError(ERR_UNEXPECTED_DECL, aLineText);\n\n\t\tint initializers = 0;\n\t\tLPTSTR init_end = aLineText;\n\t\tfor (LPTSTR item_end, item = action_args; *item; item = item_end) // FOR EACH COMMA-SEPARATED ITEM IN THE DECLARATION LIST.\n\t\t{\n\t\t\titem_end = find_identifier_end(item);\n\t\t\tsize_t var_name_length = item_end - item;\n\t\t\tif (!var_name_length)\n\t\t\t\treturn ScriptError(ERR_INVALID_VARDECL, item);\n\n\t\t\tVar *var = nullptr;\n\t\t\tVar *global_var = nullptr;\n\t\t\tif (declare_type & VAR_GLOBAL)\n\t\t\t{\n\t\t\t\t// This is done separately since it may also need to be added to mStaticVars:\n\t\t\t\tif ( !(global_var = FindOrAddVar(item, var_name_length, declare_type)) )\n\t\t\t\t\treturn FAIL; // It already displayed the error.\n\t\t\t}\n\n\t\t\tif (g->CurrentFunc)\n\t\t\t{\n\t\t\t\tint insert_pos;\n\t\t\t\tVarList *varlist;\n\t\t\t\tResultType result = OK;\n\t\t\t\t// Search both locals and statics so any conflicts are detected, but set insert_pos\n\t\t\t\t// according to which list we want to insert into. For \"global\", we want to insert\n\t\t\t\t// into the static list to make it accessible to the function.\n\t\t\t\tint insert_into = global_var ? (VAR_LOCAL_STATIC | VAR_LOCAL) : declare_type;\n\t\t\t\tvar = FindVar(item, var_name_length, insert_into, &varlist, &insert_pos, &result);\n\t\t\t\tif (!var)\n\t\t\t\t{\n\t\t\t\t\tif (!result)\n\t\t\t\t\t\treturn result;\n\t\t\t\t\tif (global_var) // Implies (declare_type & VAR_GLOBAL) != 0.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Insert could be skipped if the function is assume-global, but isn't because:\n\t\t\t\t\t\t// - When !mNextLineIsFunctionBody, mDefaultVarType might still be changed.\n\t\t\t\t\t\t// - It seems harmless to add any explicitly declared globals here.\n\t\t\t\t\t\t// - There might be some reason to refer to the declared globals in future.\n\t\t\t\t\t\tif (!varlist->Insert(global_var, insert_pos))\n\t\t\t\t\t\t\treturn ScriptError(ERR_OUTOFMEM);\n\t\t\t\t\t\tvar = global_var;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\tvar = AddVar(item, var_name_length, varlist, insert_pos, declare_type);\n\t\t\t\t\t\tif (!var)\n\t\t\t\t\t\t\treturn FAIL; // It already displayed the error.\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t// Detect the following conflicts:\n\t\t\t\t// - Declaring local but found a static/global in conflicts, or vice versa.\n\t\t\t\t// - Declaring static but found a global in varlist, or vice versa.\n\t\t\t\t// - Declaring local but found a parameter in varlist.\n\t\t\t\t// - Declaring a built-in variable as local or static.\n\t\t\t\t// But permit the following:\n\t\t\t\t// - Exact duplicate declarations, such as for two different code paths.\n\t\t\t\tif (var->Scope() != declare_type)\n\t\t\t\t\treturn ConflictingDeclarationError(Var::DeclarationType(declare_type), var);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tvar = global_var;\n\t\t\t\tif (declare_type & VAR_EXPORTED)\n\t\t\t\t\tvar->Scope() |= VAR_EXPORTED; // Mightn't be set if var was already defined.\n\t\t\t}\n\n\t\t\titem_end = omit_leading_whitespace(item_end); // Move up to the next comma, assignment-op, or '\\0'.\n\t\t\tif (*item_end && *item_end != ',')\n\t\t\t{\n\t\t\t\t// Since this variable might already have a value, compound assignments are\n\t\t\t\t// permitted (although not very conventional). This is mostly for globals,\n\t\t\t\t// which might only be referenced on this one line (and outside the function),\n\t\t\t\t// but might have some utility with \"static\" due to its once-only nature.\n\t\t\t\tif (!( _tcschr(_T(\":+-*/.|&^\"), *item_end) && item_end[1] == '=' // += -= *= /= .= |= &= ^=\n\t\t\t\t\t|| _tcschr(_T(\"/<>?\"), *item_end) && item_end[1] == *item_end && (item_end[2] == '=' // //= <<= >>= ??=\n\t\t\t\t\t\t|| (*item_end == '>' && item_end[2] == *item_end && item_end[3] == '=')) )) // >>>=\n\t\t\t\t\treturn ScriptError(ERR_INVALID_VARDECL, item); // It's not any of the above, so it's invalid.\n\t\t\t\t// Find the comma (or terminator) that marks the end of this initializer.\n\t\t\t\titem_end += FindExprDelim(item_end);\n\t\t\t\tif (initializers > 0)\n\t\t\t\t{\n\t\t\t\t\t*init_end++ = ',';\n\t\t\t\t\tif (init_end < item)\n\t\t\t\t\t\t*init_end++ = ' '; // For readability in ListLines.\n\t\t\t\t}\n\t\t\t\ttmemmove(init_end, item, (item_end - item));\n\t\t\t\tinit_end += (item_end - item);\n\t\t\t\t++initializers;\n\t\t\t}\n\t\t\tif (*item_end == ',')\n\t\t\t\titem_end = omit_leading_whitespace(item_end + 1); // Find the start of the next item.\n\t\t\telse if (*item_end)\n\t\t\t\treturn ScriptError(ERR_INVALID_VARDECL, item);\n\t\t} // for() each item in the declaration list.\n\t\tif (init_end == aLineText) // No initializers are present.\n\t\t\treturn OK;\n\t\t*init_end = '\\0';\n\t\tend_marker = NULL;\n\t\taction_args = aLineText;\n\t\tif (aActionType != ACT_STATIC)\n\t\t\taActionType = ACT_EXPRESSION; // ACT_LOCAL and ACT_GLOBAL aren't handled at runtime.\n\t}\n\tint mark;\n\tLPTSTR subaction_start = NULL;\n\t// Perform some pre-processing to allow the parameter list of a control flow statement\n\t// to be enclosed in parentheses. For goto/break/continue, this changes the parameter\n\t// from a literal label to an expression. For others it is just a matter of coding style.\n\t// No pre-processing is needed for statements with exactly one parameter, since they will\n\t// be interpreted correctly with or without parentheses.\n\tswitch (aActionType)\n\t{\n\t// Cases not handled here because they do not require pre-processing:\n\t//case ACT_IF:\n\t//case ACT_WHILE:\n\t//case ACT_UNTIL:\n\t// Cases omitted to prevent empty \"()\" from being allowed:\n\t//case ACT_LOOP:\n\t//case ACT_RETURN:\n\tcase ACT_FOR:\n\tcase ACT_CATCH:\n\t\tend_marker = action_args; // Handle both \"for(...)\" and \"for (...)\" below.\n\tcase ACT_GOTO:\n\tcase ACT_BREAK: // These only support constant expressions (checked later).\n\tcase ACT_CONTINUE: //\n\t\tif (end_marker && *end_marker == '(')\n\t\t{\n\t\t\tLPTSTR last_char = aLineText + line_length - 1;\n\t\t\tif (*last_char == '{' && (aActionType == ACT_FOR || aActionType == ACT_CATCH))\n\t\t\t{\n\t\t\t\tadd_openbrace_afterward = true;\n\t\t\t\tlast_char = omit_trailing_whitespace(end_marker, last_char - 1);\n\t\t\t}\n\t\t\tif (*last_char == ')')\n\t\t\t{\n\t\t\t\t// Remove the parentheses (and possible open brace) and trailing space.\n\t\t\t\tASSERT(action_args == end_marker);\n\t\t\t\t++action_args;\n\t\t\t\tlast_char = omit_trailing_whitespace(end_marker, last_char - 1);\n\t\t\t\tlast_char[1] = '\\0';\n\t\t\t\t// Treat this like a function call: all parameters are sub-expressions.\n\t\t\t\tall_args_are_expressions = true;\n\t\t\t}\n\t\t}\n\t\tif (aActionType != ACT_CATCH || *action_args != '{') // i.e. \"Catch varname\" must be handled a different way.\n\t\t\tbreak;\n\t\t// Otherwise, fall through to handle \"Catch {\":\n\tcase ACT_ELSE:\n\tcase ACT_TRY:\n\tcase ACT_FINALLY:\n\t\tif (end_marker && *end_marker == '(') // Seems best to treat this as an error, perhaps reserve for future use.\n\t\t\treturn ScriptError(ERR_EXPR_SYNTAX, aLineText);\n\t\tif (*action_args == '{')\n\t\t{\n\t\t\tadd_openbrace_afterward = true;\n\t\t\taction_args = omit_leading_whitespace(action_args + 1);\n\t\t}\n\t\tif (*action_args)\n\t\t{\n\t\t\tsubaction_start = action_args;\n\t\t\t*--action_args = '\\0'; // Relies on there being a space, tab or brace at this position.\n\t\t}\n\t\tbreak;\n\tcase ACT_CASE:\n\t\tmark = FindExprDelim(action_args, ':');\n\t\tif (!action_args[mark])\n\t\t\treturn ScriptError(ERR_MISSING_COLON, aLineText);\n\t\taction_args[mark] = '\\0';\n\t\trtrim(action_args);\n\t\tsubaction_start = omit_leading_whitespace(action_args + mark + 1);\n\t\tif (!*subaction_start) // Nothing to the right of ':'.\n\t\t\tsubaction_start = NULL;\n\t\tbreak;\n\t}\n\n\tAction &this_action = g_act[aActionType];\n\n\t// v2: All statements accept expressions by default, except goto/break/continue.\n\tif (aActionType > ACT_LAST_JUMP || aActionType < ACT_FIRST_JUMP)\n\t\tall_args_are_expressions = true;\n\n\tif (aActionType == ACT_FOR)\n\t{\n\t\t// Validate \"For\" syntax and translate to conventional command syntax.\n\t\t// \"For x,y in z\" -> \"For x,y, z\"\n\t\t// \"For x in y\" -> \"For x,, y\"\n\t\tLPTSTR cp;\n\t\tfor (cp = action_args; ; )\n\t\t{\n\t\t\tif (ctolower(cp[0]) == 'i' && ctolower(cp[1]) == 'n' && IS_SPACE_OR_TAB(cp[2]))\n\t\t\t\tbreak;\n\t\t\tif (!IS_LEADING_IDENTIFIER_CHAR(*cp) && *cp != g_delimiter)\n\t\t\t\treturn ScriptError(ERR_EXPR_SYNTAX, aLineText);\n\t\t\twhile (IS_IDENTIFIER_CHAR(*cp)) ++cp;\n\t\t\tif (*cp == g_delimiter) ++cp;\n\t\t\twhile (IS_SPACE_OR_TAB(*cp)) ++cp;\n\t\t}\n\t\t// Replace \"in\" with a normal arg delimiter, or space if there are no vars.\n\t\tcp[0] = cp == action_args ? ' ' : g_delimiter;\n\t\tcp[1] = ' ';\n\t}\n\telse if (aActionType == ACT_CATCH)\n\t{\n\t\t// Add as 1 arg and parse later.\n\t\tall_args_are_expressions = false;\n\t}\n\n\t/////////////////////////////////////////////////////////////\n\t// Parse the parameter string into a list of separate params.\n\t/////////////////////////////////////////////////////////////\n\t// MaxParams has already been verified as being <= MAX_ARGS.\n\tint nArgs;\n\tLPTSTR arg[MAX_ARGS];\n\tint max_params = this_action.MaxParams;\n\tint max_params_minus_one = max_params - 1;\n\tbool is_expression;\n\n\tfor (nArgs = mark = 0; action_args[mark] && nArgs < max_params; ++nArgs)\n\t{\n\t\targ[nArgs] = action_args + mark;\n\n\t\tis_expression = all_args_are_expressions; // This would be false for goto/break/continue.\n\n\t\t// Find the end of the above arg:\n\t\tif (is_expression)\n\t\t\t// Find the next delimiter, taking into account quote marks, parentheses, etc.\n\t\t\tmark = FindExprDelim(action_args, g_delimiter, mark);\n\t\telse\n\t\t\t// Find the next non-literal delimiter.\n\t\t\tmark = FindTextDelim(action_args, g_delimiter, mark);\n\n\t\tif (action_args[mark]) // A non-literal delimiter was found.\n\t\t{\n\t\t\tif (nArgs == max_params_minus_one) // There should be no delimiter, since this is the last arg.\n\t\t\t{\n\t\t\t\t++nArgs;\n\t\t\t\tbreak; // Let section below handle it as an error (if it's not ACT_EXPRESSION).\n\t\t\t}\n\t\t\taction_args[mark] = '\\0'; // Terminate the previous arg.\n\t\t\t// Trim any whitespace from the previous arg. This operation will not alter the contents\n\t\t\t// of anything beyond action_args[i], so it should be safe.\n\t\t\trtrim(arg[nArgs], (action_args + mark) - arg[nArgs]);\n\t\t\t// Omit the leading whitespace from the next arg:\n\t\t\tfor (++mark; IS_SPACE_OR_TAB(action_args[mark]); ++mark);\n\t\t\t// Now <mark> marks the end of the string, the start of the next arg,\n\t\t\t// or a delimiter-char (if the next arg is blank).\n\t\t}\n\t}\n\n\t///////////////////////////////////////////////////////////////////////////////\n\t// Ensure there are sufficient parameters for this command. Note: If MinParams\n\t// is greater than 0, the param numbers 1 through MinParams are required to be\n\t// non-blank.\n\t///////////////////////////////////////////////////////////////////////////////\n\tTCHAR error_msg[1024];\n\tif (nArgs < this_action.MinParams)\n\t{\n\t\tsntprintf(error_msg, _countof(error_msg), _T(\"\\\"%s\\\" requires at least %d parameter%s.\")\n\t\t\t, this_action.Name, this_action.MinParams\n\t\t\t, this_action.MinParams > 1 ? _T(\"s\") : _T(\"\"));\n\t\treturn ScriptError(error_msg, aLineText);\n\t}\n\tif (action_args[mark] && aActionType >= ACT_FIRST_NAMED_ACTION && !(aActionType == ACT_CATCH || ACT_IS_VAR_DECL(aActionType)))\n\t{\n\t\tsntprintf(error_msg, _countof(error_msg), _T(\"\\\"%s\\\" accepts at most %d parameter%s.\")\n\t\t\t, this_action.Name, max_params\n\t\t\t, max_params > 1 ? _T(\"s\") : _T(\"\"));\n\t\treturn ScriptError(error_msg, aLineText);\n\t}\n\tfor (int i = 0, non_blank_params = aActionType == ACT_CASE ? nArgs : aActionType == ACT_CATCH ? nArgs - 1 : this_action.MinParams\n\t\t; i < non_blank_params; ++i) // It's only safe to do this after the above.\n\t\tif (!*arg[i])\n\t\t{\n\t\t\tsntprintf(error_msg, _countof(error_msg), _T(\"\\\"%s\\\" requires that parameter #%u be non-blank.\")\n\t\t\t\t, this_action.Name, i + 1);\n\t\t\treturn ScriptError(error_msg, aLineText);\n\t\t}\n\n\t// Handle one-true-brace (OTB).\n\t// Else, Try and Finally were already handled, since they also accept a sub-action.\n\tif (nArgs && (ACT_IS_LOOP(aActionType) || aActionType == ACT_IF || aActionType == ACT_CATCH || aActionType == ACT_SWITCH)\n\t\t&& !add_openbrace_afterward) // It wasn't already handled.\n\t{\n\t\tLPTSTR arg1 = arg[nArgs - 1]; // For readability and possibly performance.\n\t\tLPTSTR arg1_last_char = arg1 + _tcslen(arg1) - 1;\n\t\tif (arg1_last_char >= arg1 // Checked for maintainability. Probably unnecessary since if true, arg1_last_char would be the null-terminator of the previous arg (never '{').\n\t\t\t&& *arg1_last_char == '{') // Relies on short-circuit boolean evaluation.\n\t\t{\n\t\t\tadd_openbrace_afterward = true;\n\t\t\t*arg1_last_char = '\\0'; // Since it will be fully handled here, remove the brace from further consideration.\n\t\t\tif (!rtrim(arg1)) // Trimmed down to nothing, so only a brace was present: remove the arg completely.\n\t\t\t\tif (aActionType == ACT_LOOP || aActionType == ACT_CATCH || aActionType == ACT_SWITCH)\n\t\t\t\t\t--nArgs;\n\t\t\t\telse // ACT_WHILE, ACT_FOR or ACT_IF\n\t\t\t\t\treturn ScriptError(ERR_PARAM1_REQUIRED, aLineText);\n\t\t}\n\t}\n\n\tif (aActionType == ACT_SWITCH && nArgs && !*arg[0]) // Switch with parameters - do this only after the above, since it might remove one arg.\n\t\tScriptError(ERR_PARAM1_MUST_NOT_BE_BLANK); // \"Switch , y\" or \"Switch , \"\n\n\tif (!AddLine(aActionType, arg, nArgs, all_args_are_expressions))\n\t\treturn FAIL;\n\tif (add_openbrace_afterward)\n\t\tif (!AddLine(ACT_BLOCK_BEGIN))\n\t\t\treturn FAIL;\n\tif (!subaction_start) // There is no subaction in this case.\n\t\treturn OK;\n\treturn ParseAndAddLine(subaction_start); // Escape sequences in the subaction haven't been translated yet.\n}\n\n\n\ninline LPTSTR Script::ParseActionType(LPTSTR aBufTarget, LPTSTR aBufSource)\n// inline since it's called so often.\n// aBufTarget should be at least MAX_VAR_NAME_LENGTH + 1 in size.\n// Returns NULL if it's not a named action; otherwise, the address of the first\n// character after the action name in aBufSource (possibly the null-terminator).\n{\n\t////////////////////////////////////////////////////////\n\t// Find the action name and the start of the param list.\n\t////////////////////////////////////////////////////////\n\tLPTSTR end_marker = find_identifier_end(aBufSource);\n\tsize_t action_name_length = end_marker - aBufSource;\n\tif (!action_name_length || action_name_length > MAX_VAR_NAME_LENGTH)\n\t{\n\t\t// For the \"too long\" case, it will ultimately be treated as an unrecognized action.\n\t\t*aBufTarget = '\\0';\n\t\treturn NULL;\n\t}\n\ttcslcpy(aBufTarget, aBufSource, action_name_length + 1);\n\treturn end_marker;\n}\n\n\n\ninline ActionTypeType Script::ConvertActionType(LPCTSTR aActionTypeString)\n// inline since it's called so often, but don't keep it in the .h due to #include issues.\n{\n\t// For the loop's index:\n\t// Use an int rather than ActionTypeType since it's sure to be large enough to go beyond\n\t// 256 if there happen to be exactly 256 actions in the array:\n \tfor (int action_type = ACT_FIRST_NAMED_ACTION; action_type <= ACT_LAST_NAMED_ACTION; ++action_type)\n\t\tif (!_tcsicmp(aActionTypeString, g_act[action_type].Name)) // Match found.\n\t\t\treturn action_type;\n\treturn ACT_INVALID; // On failure to find a match.\n}\n\n\n\nResultType Script::AddLine(ActionTypeType aActionType, LPTSTR aArg[], int aArgc, bool aAllArgsAreExpressions)\n// aArg must be a collection of pointers to memory areas that are modifiable, and there\n// must be at least aArgc number of pointers in the aArg array.\n// Returns OK or FAIL.\n{\n#ifdef _DEBUG\n\tif (aActionType == ACT_INVALID)\n\t\treturn ScriptError(_T(\"DEBUG: BAD AddLine\"), aArgc > 0 ? aArg[0] : _T(\"\"));\n#endif\n\tif (mPendingHotkey)\n\t{\n\t\tif (aActionType != ACT_BLOCK_BEGIN)\n\t\t\treturn ScriptError(ERR_HOTKEY_MISSING_BRACE, mPendingHotkey);\n\t\tif (!CreateHotFunc())\n\t\t\treturn FAIL;\n\t\tmPendingHotkey = nullptr;\n\t}\n\tif (aActionType == ACT_BLOCK_BEGIN && mIgnoreNextBlockBegin)\n\t{\n\t\tmIgnoreNextBlockBegin = false;\n\t\treturn OK;\n\t}\n\tif (aActionType == ACT_RETURN && !aArgc && g->CurrentFunc && mDefaultReturn == SYM_MISSING) // SYM_STRING needs no handling as it is the real default, for now.\n\t{\n\t\taArg = (LPTSTR*)_alloca(sizeof(LPTSTR*));\n\t\t*aArg = _T(\"unset\");\n\t\taArgc = 1;\n\t}\n\telse if (aActionType == ACT_BLOCK_END && mLineParent && mLineParent->mActionType == ACT_BLOCK_BEGIN\n\t\t&& mLineParent->mAttribute == g->CurrentFunc && g->CurrentFunc // This is the block-end of a function.\n\t\t&& mDefaultReturn == SYM_MISSING // It should default to unset, and doesn't end with a return.\n\t\t&& (mLastLine->mActionType != ACT_RETURN || mLastLine->mParentLine != mLineParent)) // It wouldn't be \"unreachable\".\n\t{\n\t\tif (!AddLine(ACT_RETURN, nullptr, 0, true)) // The recursive call will detect that this needs to be `return unset`.\n\t\t\treturn FAIL;\n\t}\n\n\tDerefList deref; // Will be used to temporarily store the var-deref locations in each arg.\n\tArgStruct *new_arg; // We will allocate some dynamic memory for this, then hang it onto the new line.\n\tLPTSTR this_aArg;\n\n\t//////////////////////////////////////////////////////////\n\t// Build the new arg list in dynamic memory.\n\t// The allocated structs will be attached to the new line.\n\t//////////////////////////////////////////////////////////\n\tif (!aArgc)\n\t\tnew_arg = NULL; // Just need an empty array in this case.\n\telse\n\t{\n\t\tnew_arg = SimpleHeap::Alloc<ArgStruct>(aArgc);\n\n\t\tint i;\n\n\t\tfor (i = 0; i < aArgc; ++i)\n\t\t{\n\t\t\t////////////////\n\t\t\t// FOR EACH ARG:\n\t\t\t////////////////\n\t\t\tthis_aArg = aArg[i]; // For performance and convenience.\n\t\t\tArgStruct &this_new_arg = new_arg[i]; // Same.\n\t\t\tthis_new_arg.postfix = NULL; // Set default early, for maintainability.\n\n\t\t\t// Determine whether this arg is ARG_TYPE_NORMAL or ARG_TYPE_OUTPUT_VAR. Blank args are\n\t\t\t// set to ARG_TYPE_NORMAL for maintainability, so ARG_TYPE_OUTPUT_VAR always has a non-null\n\t\t\t// var at runtime. ARG_TYPE_INPUT_VAR is never encountered at this stage; it is only used\n\t\t\t// by certain optimizations in ExpressionToPostfix(), which comes later.\n\t\t\tthis_new_arg.type = *this_aArg ? Line::ArgIsVar(aActionType, i, aArgc) : ARG_TYPE_NORMAL;\n\t\t\t\n\t\t\t// All non-blank args are handled by ExpressionToPostfix, except where caller has indicated\n\t\t\t// this action type does not accept an expression (e.g. \"goto label\").\n\t\t\tthis_new_arg.is_expression = *this_aArg && aAllArgsAreExpressions;\n\n\t\t\t// So that it can be passed to Alloc(), first update the length to match what the text will be\n\t\t\t// (if the alloc fails, an inaccurate length won't matter because it's a program-abort situation).\n\t\t\t// The length member was added in v1.0.44.14 to boost runtime performance, but is currently only\n\t\t\t// used to estimate how much deref buf space is needed; see EXPR_BUF_SIZE macro.\n\t\t\tthis_new_arg.length = (ArgLengthType)_tcslen(this_aArg);\n\t\t\t\n\t\t\t// Create a copy of arg text in persistent memory.\n\t\t\tthis_new_arg.text = SimpleHeap::Alloc(this_aArg, this_new_arg.length);\n\n\t\t\t///////////////////////////////////////////\n\t\t\t// Build the list of operands for this arg.\n\t\t\t///////////////////////////////////////////\n\t\t\t// Now that any escaped quote marks etc. have been marked, pre-parse all operands\n\t\t\t// in this_new_arg.text. Review is needed to determine whether var derefs still\n\t\t\t// need to be resolved at this stage (and whether this is optimal). Other operands\n\t\t\t// are marked at this stage to avoid some redundant processing later.\n\t\t\t// Note: this_new_arg.text is scanned rather than this_aArg because we want to\n\t\t\t// establish pointers to the correct area of memory:\n\t\t\tderef.count = 0; // Init for each arg.\n\n\t\t\tif (this_new_arg.is_expression)\n\t\t\t{\n\t\t\t\tif (!ParseOperands(this_new_arg.text, deref))\n\t\t\t\t\treturn FAIL;\n\t\t\t}\n\t\t\t// Otherwise, this arg does not contain an expression and therefore cannot contain\n\t\t\t// any derefs. This is currently limited to ACT_GOTO/ACT_BREAK/ACT_CONTINUE,\n\t\t\t// which require either a literal label name or () to force an expression.\n\n\t\t\t//////////////////////////////////////////////////////////////\n\t\t\t// Allocate mem for this arg's list of dereferenced variables.\n\t\t\t//////////////////////////////////////////////////////////////\n\t\t\tif (deref.count)\n\t\t\t{\n\t\t\t\tthis_new_arg.deref = SimpleHeap::Alloc<DerefType>(deref.count + 1); // +1 for the \"NULL-item\" terminator.\n\t\t\t\tmemcpy(this_new_arg.deref, deref.items, deref.count * sizeof(DerefType));\n\t\t\t\t// Terminate the list of derefs with a deref that has a NULL marker:\n\t\t\t\tthis_new_arg.deref[deref.count].marker = NULL;\n\t\t\t}\n\t\t\telse\n\t\t\t\tthis_new_arg.deref = NULL;\n\t\t} // for each arg.\n\t} // there are more than zero args.\n\n\t//////////////////////////////////////////////////////////////////////////////////////\n\t// Now the above has allocated some dynamic memory, the pointers to which we turn over\n\t// to Line's constructor so that they can be anchored to the new line.\n\t//////////////////////////////////////////////////////////////////////////////////////\n\tLine *the_new_line = new Line(mCurrFileIndex, mCombinedLineNumber, aActionType, new_arg, aArgc);\n\n\tLine &line = *the_new_line; // For performance and convenience.\n\n\tline.mPrevLine = mLastLine; // Whether NULL or not.\n\tif (mFirstLine == NULL)\n\t\tmFirstLine = the_new_line;\n\telse\n\t\tmLastLine->mNextLine = the_new_line;\n\t// This must be done after the above:\n\tmLastLine = the_new_line;\n\tmCurrLine = the_new_line; // To help error reporting.\n\n\t///////////////////////////////////////////////////////////////////\n\t// Do any post-add validation & handling for specific action types.\n\t///////////////////////////////////////////////////////////////////\n\t// v2.0: Currently almost none of the v1 validation is done here, since built-in functions\n\t// are now fully parsed as expressions and not as unique action types. This old method\n\t// was never applicable to expressions/functions, which are more complicated to validate.\n\t// This should be replaced with better tools (separate to the program), such as syntax\n\t// checkers which can operate while the user is editing, before they try to run the script.\n\tif (aActionType == ACT_RETURN)\n\t{\n\t\tif (aArgc > 0 && !g->CurrentFunc)\n\t\t\treturn ScriptError(_T(\"Return's parameter should be blank except inside a function.\"));\n\t}\n\t\n\tif (mNextLineIsFunctionBody)\n\t{\n\t\tg->CurrentFunc->mJumpToLine = the_new_line;\n\t\tmNextLineIsFunctionBody = false;\n\t}\n\n\t// This next section and the block-begin/end sections below are responsible\n\t// for setting up the relationships of lines (mParentLine and mRelatedLine).\n\t// This was previously done as a separate pass, but doing it here enables\n\t// all subsequent stages to rely on the relationships already being defined.\n\t// It also reduced code size.\n\tswitch (aActionType)\n\t{\n\tcase ACT_CASE:\n\t\tif (!(mLineParent && mLineParent->mPrevLine && mLineParent->mPrevLine->mActionType == ACT_SWITCH))\n\t\t\treturn line.LineUnexpectedError();\n\t\tASSERT(mLineParent->mActionType == ACT_BLOCK_BEGIN);\n\t\tLine *last_case;\n\t\tif ((last_case = mLineParent->mNextLine) && last_case != &line)\n\t\t{\n\t\t\t// Form a linked list of CASE lines for this SWITCH.\n\t\t\twhile (last_case->mRelatedLine)\n\t\t\t\tlast_case = last_case->mRelatedLine;\n\t\t\tlast_case->mRelatedLine = &line;\n\t\t}\n\t\tbreak;\n\tcase ACT_ELSE:\n\tcase ACT_UNTIL:\n\tcase ACT_CATCH:\n\tcase ACT_FINALLY:\n\t\tbool expected = false;\n\t\tLine *parent = mPendingRelatedLine;\n\t\tfor (;; parent = parent->mParentLine)\n\t\t{\n\t\t\tif (!parent)\n\t\t\t\treturn line.LineUnexpectedError();\n\t\t\tenum_act parent_act = (enum_act)parent->mActionType;\n\t\t\tswitch (aActionType)\n\t\t\t{\n\t\t\tcase ACT_ELSE:\n\t\t\t\tif (parent_act == ACT_TRY)\n\t\t\t\t\t// Prevent the Else in Try..Else from attaching to a previous statement, since some users\n\t\t\t\t\t// might expect Try..Else to be synonmous with Try..Catch Error..Else (which is currently\n\t\t\t\t\t// disabled for code size, and because \"try x else y\" sounds more like y could be executed\n\t\t\t\t\t// if x was NOT successful).\n\t\t\t\t\treturn line.LineUnexpectedError();\n\t\t\t\texpected = parent_act == ACT_IF || parent_act == ACT_CATCH || ACT_IS_LOOP(parent_act);\n\t\t\t\tbreak;\n\t\t\tcase ACT_UNTIL: expected = ACT_IS_LOOP_EXCLUDING_WHILE(parent_act); break;\n\t\t\tcase ACT_FINALLY:\n\t\t\t\tif (parent_act == ACT_ELSE)\n\t\t\t\t{\n\t\t\t\t\tLine *else_line = parent; // But what kind of ELSE?\n\t\t\t\t\tparent = parent->mPrevLine; // This is potentially the last line of a compound statement above the ELSE.\n\t\t\t\t\tdo // Find the IF/CATCH at the same level as the ELSE.\n\t\t\t\t\t\tparent = parent->mParentLine;\n\t\t\t\t\twhile (parent->mParentLine != else_line->mParentLine);\n\t\t\t\t\texpected = parent->mActionType == ACT_CATCH;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\t// Fall through:\n\t\t\tcase ACT_CATCH:\n\t\t\t\texpected = parent_act == ACT_TRY || parent_act == ACT_CATCH;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (expected)\n\t\t\t\tbreak;\n\t\t}\n\t\tline.mParentLine = parent->mParentLine; // Not parent itself, since an ELSE can't jump into its IF's body.\n\t\tbreak;\n\t}\n\twhile (mPendingRelatedLine) // A completed block or a parent line with a single-line action, waiting for its mRelatedLine.\n\t{\n\t\tbool break_time = aActionType == ACT_UNTIL && ACT_IS_LOOP_EXCLUDING_WHILE(mPendingRelatedLine->mActionType); // Until must \"relate to\" only a single statement.\n\t\tmPendingRelatedLine->mRelatedLine = &line;\n\t\t// Regardless of whether mPendingRelatedLine is a block-begin or parent line,\n\t\t// its own parent also needs its mRelatedLine set, unless that's an open block.\n\t\tmPendingRelatedLine = mPendingRelatedLine->mParentLine;\n\t\tif (mPendingRelatedLine && mPendingRelatedLine->mActionType == ACT_BLOCK_BEGIN)\n\t\t\tmPendingRelatedLine = nullptr;\n\t\tif (break_time)\n\t\t\tbreak;\n\t}\n\n\tif (!line.mParentLine)\n\t\tline.mParentLine = mLineParent;\n\tif (ACT_IS_LINE_PARENT(aActionType))\n\t{\n\t\tmLineParent = &line;\n\t}\n\telse if (aActionType == ACT_BLOCK_BEGIN)\n\t{\n\t\tmLineParent = &line;\n\t\t// It's only necessary to check the last func, not the one(s) that come before it, to see if its\n\t\t// mJumpToLine is NULL. This is because our caller has made it impossible for a function\n\t\t// to ever have been defined in the first place if it lacked its opening brace. Search on\n\t\t// \"consecutive function\" for more comments.\n\t\tif (g->CurrentFunc && !g->CurrentFunc->mJumpToLine)\n\t\t{\n\t\t\tline.mAttribute = g->CurrentFunc; // Flag this ACT_BLOCK_BEGIN as the opening brace of the function's body.\n\t\t\t// For efficiency, and to prevent ExecUntil from starting a new recursion layer for the function's\n\t\t\t// body, the function's execution should begin at the first line after its open-brace (even if that\n\t\t\t// first line is another open-brace or the function's close-brace (i.e. an empty function):\n\t\t\tmNextLineIsFunctionBody = true;\n\t\t}\n\t}\n\telse if (mLineParent && mLineParent->mActionType != ACT_BLOCK_BEGIN)\n\t{\n\t\t // A parent line's action was just added, and isn't itself a parent.\n\t\tif (mLineParent->mActionType == ACT_SWITCH)\n\t\t\treturn mLineParent->LineError(ERR_MISSING_OPEN_BRACE);\n\t\tmPendingRelatedLine = mLineParent; // The next line will be the parent's mRelatedLine.\n\t\tdo\n\t\t\tmLineParent = mLineParent->mParentLine;\n\t\twhile (mLineParent && mLineParent->mActionType != ACT_BLOCK_BEGIN);\n\t}\n\t// See further below for ACT_BLOCK_END.\n\n\t// Above must be done prior to the below, since it sometimes sets mAttribute for use below.\n\n\t///////////////////////////////////////////////////////////////\n\t// Update any labels that should refer to the newly added line.\n\t///////////////////////////////////////////////////////////////\n\t// If the label most recently added doesn't yet have an anchor in the script, provide it.\n\t// UPDATE: In addition, keep searching backward through the labels until a non-NULL\n\t// mJumpToLine is found. All the ones with a NULL should point to this new line to\n\t// support cases where one label immediately follows another in the script.\n\t// v2.1: mNoUpdateLabels was originally used by some callers who are inserting lines\n\t// which shouldn't be associated with any pending labels, but was superseded in v2.0\n\t// by searching only g->CurrentFunc, which has no labels in those cases.\n\t//if (!mNoUpdateLabels)\n\t{\n\t\tfor (Label *label = g->CurrentFunc ? g->CurrentFunc->mLastLabel : mLastLabel;\n\t\t\tlabel != NULL && label->mJumpToLine == NULL; label = label->mPrevLabel)\n\t\t{\n\t\t\tif (line.mActionType == ACT_ELSE || line.mActionType == ACT_UNTIL || line.mActionType == ACT_CATCH)\n\t\t\t\treturn ScriptError(_T(\"A label must not point to an ELSE or UNTIL or CATCH.\"));\n\t\t\t// The following is inaccurate; each block-end is in fact owned by its block-begin\n\t\t\t// and not the block that encloses them both, so this restriction is unnecessary.\n\t\t\t// THE COMMENT BELOW IS OBSOLETE:\n\t\t\t// Don't allow this because it may cause problems in a case such as this because\n\t\t\t// label1 points to the end-block which is at the same level (and thus normally\n\t\t\t// an allowable jumppoint) as the goto. But we don't want to allow jumping into\n\t\t\t// a block that belongs to a control structure. In this case, it would probably\n\t\t\t// result in a runtime error when the execution unexpectedly encounters the ELSE\n\t\t\t// after performing the goto:\n\t\t\t// goto, label1\n\t\t\t// if x\n\t\t\t// {\n\t\t\t// ...\n\t\t\t// label1:\n\t\t\t// }\n\t\t\t// else\n\t\t\t// ...\n\t\t\t//\n\t\t\t// An alternate way to deal with the above would be to make each block-end be owned\n\t\t\t// by its block-begin rather than the block that encloses them both.\n\t\t\t//if (line.mActionType == ACT_BLOCK_END)\n\t\t\t//\treturn ScriptError(_T(\"A label must not point to the end of a block. For loops, use Continue vs. Goto.\"));\n\t\t\tlabel->mJumpToLine = the_new_line;\n\t\t}\n\t}\n\n\t// Above must be done prior to the below, because otherwise a function-local label's mJumpToLine\n\t// would not be set in a case like the following:\n\t// Func(){\n\t// ...\n\t// local_label:\n\t// }\n\n\tif (aActionType == ACT_BLOCK_END)\n\t{\n\t\tif (!line.mParentLine || line.mParentLine->mActionType != ACT_BLOCK_BEGIN)\n\t\t\treturn line.LineUnexpectedError();\n\t\tmPendingRelatedLine = mLineParent; // The next line will be the block-begin's mRelatedLine, and possibly its parent's mRelatedLine.\n\n\t\t// Rather than checking whether each newly added line is being added into a Switch,\n\t\t// just verify here that the first line of each Switch's block is valid:\n\t\tif (mLineParent->mPrevLine && mLineParent->mPrevLine->mActionType == ACT_SWITCH\n\t\t\t&& mLineParent->mNextLine->mActionType != ACT_CASE\n\t\t\t&& mLineParent->mNextLine != &line)\n\t\t\treturn mLineParent->mNextLine->LineError(_T(\"Expected Case/Default.\"));\n\n\t\tif (g->CurrentFunc && g->CurrentFunc == mLineParent->mAttribute)\n\t\t{\n\t\t\tline.mAttribute = g->CurrentFunc; // Flag this ACT_BLOCK_END as the ending brace of this function's body.\n\t\t\tg->CurrentFunc = g->CurrentFunc->mOuterFunc; // Step out of this function.\n\t\t\tif (g->CurrentFunc && !g->CurrentFunc->mJumpToLine)\n\t\t\t\t// The outer function has no body yet, so it probably began with one or more nested functions.\n\t\t\t\tmNextLineIsFunctionBody = true;\n\t\t\t// If the function's block-begin's parent is not a block-begin, the function must be\n\t\t\t// a fat arrow function. Don't look further up the chain in that case because the next\n\t\t\t// line should be a child of the same parent as the block-begin.\n\t\t\tmLineParent = mLineParent->mParentLine;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tdo\n\t\t\t\tmLineParent = mLineParent->mParentLine;\n\t\t\twhile (mLineParent && mLineParent->mActionType != ACT_BLOCK_BEGIN);\n\t\t}\n\t}\n\n\treturn OK;\n}\n\n\n\nResultType DerefList::Push()\n{\n\tif (count == size)\n\t{\n\t\tconst int block_size = 128; // In most cases one allocation will be enough.\n\t\tDerefType *p = (DerefType *)realloc(items, (size + block_size) * sizeof(DerefType));\n\t\tif (!p)\n\t\t\treturn MemoryError();\n\t\titems = p;\n\t\tsize += block_size;\n\t}\n\t++count;\n\treturn OK;\n}\n\n\n\nResultType Script::ParseOperands(LPTSTR aArgText, DerefList &aDeref, int *aPos, TCHAR aEndChar)\n{\n\tLPTSTR op_begin, op_end;\n\tsize_t operand_length;\n\tTCHAR close_char, *cp;\n\tint j;\n\tbool is_function;\n\tbool is_double_deref;\n\tSymbolType wordop;\n\n\top_begin = aArgText;\n\tif (aPos)\n\t\top_begin += *aPos;\n\tfor (; *op_begin; op_begin = op_end)\n\t{\n\t\twhile (*op_begin && _tcschr(EXPR_OPERAND_TERMINATORS, *op_begin)) // Skip over whitespace, operators, and parentheses.\n\t\t{\n\t\t\tif (*op_begin == aEndChar)\n \t\t{\n \t\t\tif (aPos)\n \t\t\t\t*aPos = int(op_begin - aArgText);\n \t\t\treturn OK;\n \t\t}\n\t\t\tif (*op_begin == g_DerefChar)\n\t\t\t\t// This is the start of a double-deref with no initial literal part. Double-derefs are\n\t\t\t\t// handled outside the loop for simplicity. Breaking out of the loop means that this\n\t\t\t\t// will be seen as an operand of zero length.\n\t\t\t\tbreak;\n\t\t\tif (*op_begin == '.')\n\t\t\t{\n\t\t\t\t// This case also handles the dot in `.=` (the `=` is skipped by the next iteration).\n\t\t\t\t// Skip the numeric literal or identifier to the right of this, if there is one.\n\t\t\t\t// This won't skip the signed exponent of a scientific-notation literal, but that should\n\t\t\t\t// be OK as it will be recognized as purely numeric in the next iteration of this loop.\n\t\t\t\top_end = find_identifier_end(op_begin + 1);\n\t\t\t\tif (*op_end != g_DerefChar || aEndChar == g_DerefChar)\n\t\t\t\t{\n\t\t\t\t\top_begin = op_end;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\t// Otherwise, it's a dynamic property or method call.\n\t\t\t\t++op_begin; // Skip the dot.\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tswitch (*op_begin)\n\t\t\t{\n\t\t\tdefault:\n\t\t\t\top_begin++;\n\t\t\t\tcontinue;\n\n\t\t\tcase '\\n':\n\t\t\t\t// Allow `n unquoted in expressions so that continuation sections can be used to\n\t\t\t\t// spread an expression across multiple lines without requiring the \"Join\" option;\n\t\t\t\t// but replace them with spaces now so they don't need to be handled later on.\n\t\t\t\t*op_begin++ = ' ';\n\t\t\t\tcontinue;\n\n\t\t\t// These errors are detected by GetLineContExpr()/BalanceExpr() or later by ExpressionToPostfix:\n\t\t\t//case ')':\n\t\t\t//case ']':\n\t\t\t//case '}':\n\t\t\t//\treturn ScriptError(ERR_EXPR_SYNTAX, op_begin);\n\t\t\tcase '(': close_char = ')'; break;\n\t\t\tcase '[': close_char = ']'; break;\n\t\t\tcase '{': close_char = '}'; break;\n\t\t\t}\n\t\t\t// Since above didn't \"continue\", recurse to handle nesting:\n\t\t\tj = (int)(op_begin - aArgText + 1);\n\t\t\tif (close_char == ')')\n\t\t\t{\n\t\t\t\t// Before parsing derefs, check if this is the parameter list of an inline function.\n\t\t\t\tLPTSTR close_paren = aArgText + FindExprDelim(aArgText, close_char, j);\n\t\t\t\tif (*close_paren)\n\t\t\t\t{\n\t\t\t\t\tcp = omit_leading_whitespace(close_paren + 1);\n\t\t\t\t\tif (*cp == '=' && cp[1] == '>') // () => Fat arrow function.\n\t\t\t\t\t{\n\t\t\t\t\t\tif (aDeref.count)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tDerefType &d = *aDeref.Last();\n\t\t\t\t\t\t\tif (d.type == DT_VAR && d.marker + d.length == op_begin)\n\t\t\t\t\t\t\t\top_begin = d.marker;\n\t\t\t\t\t\t\telse if (op_begin > aArgText && IS_IDENTIFIER_CHAR(op_begin[-1])) // Something like x.y() => z.\n\t\t\t\t\t\t\t\treturn ScriptError(ERR_EXPR_SYNTAX, d.marker);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (!ParseFatArrow(aArgText, aDeref, op_begin, close_paren, cp + 2, op_begin))\n\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\telse if (!_tcsnicmp(op_begin, FDE_SUBSTITUTE_STRING, FDE_SUBSTITUTE_STRING_LENGTH))\n\t\t\t\t\t{\n\t\t\t\t\t\t// Find the next unresolved FDE at the current nesting level.\n\t\t\t\t\t\tint &index = mExprContainingThisFunc ? mExprContainingThisFunc->funcs_index : mExprFuncIndex;\n\t\t\t\t\t\tfor (; index < mFuncs.mCount && mFuncs.mItem[index]->mIsFuncExpression != FuncDefExpression; ++index);\n\t\t\t\t\t\tif (index >= mFuncs.mCount)\n\t\t\t\t\t\t\treturn ScriptError(ERR_EXPR_SYNTAX, FDE_SUBSTITUTE_STRING); // The source code likely included FDE_SUBSTITUTE_STRING, but it might have been a prior one.\n\t\t\t\t\t\tauto func = mFuncs.mItem[index++];\n\t\t\t\t\t\tfunc->mIsFuncExpression = FuncDefExpressionResolved; // Allow outer functions to skip over this one when looking for their own FDE.\n\t\t\t\t\t\tfunc->mOuterFunc = g->CurrentFunc;\n\t\t\t\t\t\tauto var = AddFuncVar(func);\n\t\t\t\t\t\tif (!var)\n\t\t\t\t\t\t\treturn FAIL;\n\n\t\t\t\t\t\tDerefType *d = aDeref.count ? aDeref.Last() : nullptr;\n\t\t\t\t\t\tif (d && d->type == DT_VAR && d->marker + d->length == op_begin)\n\t\t\t\t\t\t\td->length += FDE_SUBSTITUTE_STRING_LENGTH;\n\t\t\t\t\t\telse if (!aDeref.Push())\n\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\td = aDeref.Last(), d->marker = op_begin, d->length = FDE_SUBSTITUTE_STRING_LENGTH;\n\t\t\t\t\t\td->type = DT_FUNCREF;\n\t\t\t\t\t\td->var = var;\n\t\t\t\t\t\top_begin = d->marker + d->length;\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (!ParseOperands(aArgText, aDeref, &j, close_char))\n\t\t\t\treturn FAIL;\n\t\t\top_begin = aArgText + j;\n\t\t\tif (*op_begin)\n\t\t\t\top_begin++;\n\t\t\t//else:\n\t\t\t\t// Missing close paren/bracket/brace. Let ExpressionToPostfix() handle it.\n\t\t}\n\t\tif (!*op_begin) // The above loop reached the end of the string: No operands remaining.\n\t\t\tbreak;\n\t\t// Now op_begin is the start of an operand, which might be a variable reference, a numeric\n\t\t// literal, or a string literal.\n\n\t\tif (*op_begin == '\"' || *op_begin == '\\'')\n\t\t{\n\t\t\top_end = aArgText + FindTextDelim(aArgText, *op_begin, int(op_begin - aArgText + 1));\n\t\t\tif (!*op_end)\n\t\t\t\treturn ScriptError(ERR_MISSING_CLOSE_QUOTE, op_begin);\n\t\t\tif (!aDeref.Push())\n\t\t\t\treturn FAIL;\n\t\t\tDerefType &this_deref = *aDeref.Last();\n\t\t\tthis_deref.type = DT_QSTRING;\n\t\t\tthis_deref.terminal = true;\n\t\t\tthis_deref.marker = op_begin + 1;\n\t\t\tthis_deref.length = DerefLengthType(op_end - (op_begin + 1));\n\t\t\tthis_deref.substring_count = 1;\n\t\t\t++op_end;\n\t\t\t// op_end is now set correctly to allow the outer loop to continue.\n\t\t\tcontinue;\n\t\t}\n\n\t\tif (*op_begin <= '9' && *op_begin >= '0') // Numeric literal. Numbers starting with a decimal point are handled under \"case '.'\".\n\t\t{\n\t\t\t// Behaviour here should match the similar section in ExpressionToPostfix().\n\t\t\tistrtoi64(op_begin, &op_end);\n\t\t\tif (!IS_HEX(op_begin)) // This check is probably only needed on VC++ 2015 and later, where _tcstod allows hex.\n\t\t\t{\n\t\t\t\tLPTSTR d_end;\n\t\t\t\t_tcstod(op_begin, &d_end);\n\t\t\t\tif (op_end < d_end && _tcschr(EXPR_OPERAND_TERMINATORS, *d_end))\n\t\t\t\t{\n\t\t\t\t\top_end = d_end;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (_tcschr(EXPR_OPERAND_TERMINATORS, *op_end))\n\t\t\t{\n\t\t\t\t// Do nothing further since pure numbers don't need any processing at this stage.\n\t\t\t\t// If this number has a fractional part, it is handled by \"case '.'\" above.\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t//else: It's not valid, but let it pass through to Var::ValidateName() to generate an error message.\n\t\t}\n\n\t\t// Find the end of this operand (the position immediately after the operand):\n\t\top_end = find_identifier_end(op_begin);\n\t\t// Now op_end marks the end of this operand. The end might be the zero terminator, an operator, etc.\n\t\toperand_length = op_end - op_begin;\n\n\t\tif (is_double_deref = (*op_end == g_DerefChar && aEndChar != g_DerefChar))\n\t\t{\n\t\t\t// This operand is the leading literal part of a double dereference.\n\t\t\tj = (int)(op_begin - aArgText);\n\t\t\tif (!ParseDoubleDeref(aArgText, aDeref, &j))\n\t\t\t\treturn FAIL;\n\t\t\top_end = aArgText + j;\n\t\t\tis_function = *op_end == '('; // Dynamic function call.\n\t\t}\n\t\telse if (!operand_length) // Found an illegal char.\n\t\t{\n\t\t\t// Due to other checks above, this should be possible only when *op_end is an illegal\n\t\t\t// character (since it is not null, an operand terminator or identifier character).\n\t\t\t// All characters are permitted in quoted strings, which were already handled above.\n\t\t\t// An invalid identifier such as \"bad\\01\" is processed as a valid var \"bad\" followed\n\t\t\t// by a zero-length operand (triggering this section).\n\t\t\treturn ScriptError(ERR_EXP_ILLEGAL_CHAR, op_end);\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Before checking for word operators, check if this is the \"key\" in {key: value}.\n\t\t\t// Things like {new: true} and obj.new are allowed because there is no ambiguity.\n\t\t\t// This is done after the check for '.' above so that {x.y:z} is parsed as {(x.y):z}.\n\t\t\tcp = omit_leading_whitespace(op_end);\n\t\t\tif (*cp == ':' && cp[1] != '=') // Not :=\n\t\t\t{\n\t\t\t\tcp = omit_trailing_whitespace(aArgText, op_begin - 1);\n\t\t\t\tif (*cp == ',' || *cp == '{')\n\t\t\t\t{\n\t\t\t\t\t// This is either the key in a key-value pair in an object literal, or a syntax\n\t\t\t\t\t// error which will be caught at a later stage (since the ':' is missing its '?').\n\t\t\t\t\tcontinue; // Leave it unmarked so ExpressionToPostfix() handles it as a literal.\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (*cp == '=' && cp[1] == '>') // one_param => Fat arrow function.\n\t\t\t{\n\t\t\t\tif (!ParseFatArrow(aArgText, aDeref, op_begin, op_end, cp + 2, op_end))\n\t\t\t\t\treturn FAIL;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tis_function\t= *op_end == '(';\n\t\t}\n\n\t\tif (!aDeref.Push())\n\t\t\treturn FAIL;\n\t\tauto &this_deref = *aDeref.Last();\n\n\t\tif (is_double_deref)\n\t\t{\n\t\t\t// Mark the end of this dynamic reference.\n\t\t\tthis_deref.marker = op_end;\n\t\t\tthis_deref.length = 0;\n\t\t\tthis_deref.error_marker = op_begin;\n\t\t\tif (op_begin > aArgText && op_begin[-1] == '.')\n\t\t\t\tthis_deref.type = DT_DOTPERCENT;\n\t\t\telse\n\t\t\t\tthis_deref.type = DT_DOUBLE;\n\t\t}\n\t\telse if ( operand_length < 9 && (wordop = ConvertWordOperator(op_begin, operand_length)) )\n\t\t{\n\t\t\t// It's a word operator like AND/OR/NOT.\n\t\t\tif (SYM_IS_RESERVED(wordop))\n\t\t\t{\n\t\t\t\treturn ScriptError(_T(\"Unexpected reserved word.\"), op_begin);\n\t\t\t}\n\t\t\t// Mark this word as an operator. Unlike the old method of replacing \"OR\" with \"||\",\n\t\t\t// this leaves ListLines more accurate. More importantly, it allows \"Hotkey, If\" to\n\t\t\t// recognize an expression which uses AND/OR. Additionally, the \"NEW\" operator will\n\t\t\t// require a DerefType struct in the postfix expression phase anyway.\n\t\t\tthis_deref.marker = op_begin;\n\t\t\tthis_deref.length = (DerefLengthType)operand_length;\n\t\t\tthis_deref.type = DT_WORDOP;\n\t\t\tthis_deref.symbol = wordop;\n\t\t}\n\t\telse if (operand_length == 4 && !_tcsnicmp(op_begin, _T(\"True\"), 4)\n\t\t\t|| operand_length == 5 && !_tcsnicmp(op_begin, _T(\"False\"), 5))\n\t\t{\n\t\t\tthis_deref.marker = op_begin;\n\t\t\tthis_deref.length = (DerefLengthType)operand_length;\n\t\t\tthis_deref.type = DT_CONST_INT;\n\t\t\tthis_deref.int_value = toupper(*op_begin) == 'T';\n\t\t}\n\t\telse // This operand is a variable name or function name.\n\t\t{\n\t\t\t// Store the deref's starting location, even for functions (leave it set to the start\n\t\t\t// of the function's name for use when doing error reporting at other stages -- i.e.\n\t\t\t// don't set it to the address of the first param or closing-paren-if-no-params):\n\t\t\tthis_deref.marker = op_begin;\n\t\t\tthis_deref.length = (DerefLengthType)operand_length;\n\t\t\tthis_deref.type = DT_VAR;\n\t\t\tthis_deref.var = nullptr; // To be resolved later.\n\t\t}\n\t}\n\tif (aPos)\n \t*aPos = int(op_begin - aArgText);\n\treturn OK;\n}\n\n\nResultType Script::ParseDoubleDeref(LPTSTR aArgText, DerefList &aDeref, int *aPos)\n{\n\tLPTSTR op_begin, dd_begin;\n\tLPTSTR op_end;\n\tint count = 0;\n\tfor (op_begin = dd_begin = aArgText + *aPos; ; op_begin = op_end + 1)\n\t{\n\t\top_end = find_identifier_end(op_begin);\n\t\t\n\t\t// String \"derefs\" are needed to pair up to the '%' markers, allowing both\n\t\t// to be optimized out if the string is empty (as on either side of %a%).\n\t\tif (!aDeref.Push())\n\t\t\treturn FAIL;\n\t\tDerefType &this_deref = *aDeref.Last();\n\t\tthis_deref.type = DT_STRING;\n\t\tthis_deref.terminal = *op_end != g_DerefChar;\n\t\tthis_deref.marker = op_begin;\n\t\tthis_deref.length = DerefLengthType(op_end - op_begin);\n\t\tthis_deref.substring_count = ++count;\n\n\t\t*aPos = int(op_end - aArgText);\n\t\tif (this_deref.terminal)\n\t\t\tbreak;\n\t\t(*aPos)++;\n\t\tif (!ParseOperands(aArgText, aDeref, aPos, g_DerefChar))\n\t\t\treturn FAIL;\n\t\top_end = aArgText + *aPos;\n\t\tif (*op_end != g_DerefChar)\n\t\t\treturn ScriptError(_T(\"Missing ending \\\"%\\\"\"), op_begin);\n\t}\n\treturn OK;\n}\n\n\nSymbolType Script::ConvertWordOperator(LPCTSTR aWord, size_t aLength)\n{\n\tstruct WordOp\n\t{\n\t\tLPCTSTR word;\n\t\tSymbolType op;\n\t};\n\tstatic WordOp sWordOp[] =\n\t{\n\t\t{ _T(\"or\"), SYM_OR },\n\t\t{ _T(\"and\"), SYM_AND },\n\t\t{ _T(\"not\"), SYM_LOWNOT },\n\t\t{ _T(\"is\"), SYM_IS },\n\t\t{ _T(\"IsSet\"), SYM_ISSET },\n\t\t{ SUPER_KEYWORD, SYM_SUPER },\n\t\t{ _T(\"as\"), SYM_RESERVED_OPERATOR },\n\t\t{ _T(\"contains\"), SYM_RESERVED_OPERATOR },\n\t\t{ _T(\"in\"), SYM_RESERVED_OPERATOR },\n\t\t{ _T(\"unset\"), SYM_MISSING },\n\t};\n\tfor (int i = 0; i < _countof(sWordOp); ++i)\n\t{\n\t\tif (!_tcsnicmp(sWordOp[i].word, aWord, aLength) && !sWordOp[i].word[aLength])\n\t\t{\n\t\t\treturn sWordOp[i].op;\n\t\t}\n\t}\n\treturn (SymbolType)FALSE;\n}\n\n\nResultType Script::ParseFatArrow(LPTSTR aArgText, DerefList &aDeref\n\t, LPTSTR aPrmStart, LPTSTR aPrmEnd, LPTSTR aExpr, LPTSTR &aExprEnd)\n{\n\tint expr_start_pos = int(aExpr - aArgText);\n\tint expr_end_pos = FindExprDelim(aArgText, 0, expr_start_pos);\n\tif (!ParseFatArrow(aDeref, aPrmStart, aPrmEnd, aExpr, aArgText + expr_end_pos))\n\t\treturn FAIL;\n\taExprEnd = aArgText + expr_end_pos;\n\treturn OK;\n}\n\n\nResultType Script::ParseFatArrow(DerefList &aDeref, LPTSTR aPrmStart, LPTSTR aPrmEnd, LPTSTR aExpr, LPTSTR aExprEnd)\n{\n\tTCHAR orig_end;\n\tif (*aPrmEnd == ')') // `() => e` or `fn() => e`, not `v => e`.\n\t{\n\t\torig_end = aPrmEnd[1];\n\t\taPrmEnd[1] = '\\0';\n\t\tif (!DefineFunc(aPrmStart, false, FuncDefFatArrow))\n\t\t\treturn FAIL;\n\t\taPrmEnd[1] = orig_end;\n\t}\n\telse // aPrmStart is a variable name and aPrmEnd is the next character after it.\n\t{\n\t\t// Format the parameter list as needed for DefineFunc().\n\t\tTCHAR prm[MAX_VAR_NAME_LENGTH + 4];\n\t\tsntprintf(prm, _countof(prm), _T(\"(%.*s)\"), aPrmEnd - aPrmStart, aPrmStart);\n\t\tif (!DefineFunc(prm, false, FuncDefFatArrow))\n\t\t\treturn FAIL;\n\t}\n\n\tauto &func = *g->CurrentFunc;\n\n\tfor (; aExprEnd > aExpr && IS_SPACE_OR_TAB(aExprEnd[-1]); --aExprEnd);\n\torig_end = *aExprEnd;\n\t*aExprEnd = '\\0';\n\tif (!ParseAndAddLineInBlock(aExpr, ACT_RETURN))\n\t\treturn FAIL;\n\t*aExprEnd = orig_end;\n\n\tif (*aPrmStart == '(' || *aPrmEnd != ')') // Anonymous function is not yet preceded by a DT_VAR.\n\t{\n\t\tif (!aDeref.Push())\n\t\t\treturn FAIL;\n\t}\n\telse // Replace the DT_VAR preceding this fat arrow function with DT_FUNCREF.\n\t{\n\t\tASSERT(aDeref.count && aDeref.Last()->type == DT_VAR && aDeref.Last()->marker == aPrmStart);\n\t}\n\tauto &fr = *aDeref.Last();\n\tfr.type = DT_FUNCREF;\n\tfr.marker = aPrmStart; // Mark the entire fat arrow expression as a function deref.\n\tfr.length = DerefLengthType(aExprEnd - aPrmStart); // Relies on the fact that an arg can't be longer than the max deref length (because ArgLengthType == DerefLengthType).\n\t// Find the Var already added by AddFunc(), or inserted at position 0 if anonymous.\n\t// Avoid using FindVar() because g->CurrentFunc is not set appropriately if aExpr\n\t// contains the start of a function definition expression.\n\tauto &vars = func.mOuterFunc ? func.mOuterFunc->mVars : *GlobalVars();\n\tfr.var = *func.mName ? vars.Find(func.mName) : vars.mItem[0];\n\tASSERT(fr.var && vars.mCount);\n\n\treturn OK;\n}\n\n\nResultType Script::ParseAndAddLineInBlock(LPTSTR aLineText, ActionTypeType aActionType)\n{\n\tif (!AddLine(ACT_BLOCK_BEGIN))\n\t\treturn FAIL;\n\n\tauto expr = mExprContainingThisFunc;\n\tif (!ParseAndAddLine(aLineText, aActionType))\n\t\treturn FAIL;\n\n\tif (mExprContainingThisFunc != expr)\n\t{\n\t\tmExprContainingThisFunc->add_block_end_after = true;\n\t\treturn OK;\n\t}\n\treturn AddLine(ACT_BLOCK_END);\n}\n\n\n\nUserFunc* Script::CreateHotFunc()\n{\n\tif (!DefineFunc(_T(\"<Hotkey>(ThisHotkey)\")))\n\t\treturn nullptr;\n\treturn g->CurrentFunc;\n}\n\n\n\nResultType Script::DefineFunc(LPTSTR aBuf, bool aStatic, FuncDefType aIsInExpression)\n// Returns OK or FAIL.\n{\n\tLPTSTR param_end, param_start = _tcschr(aBuf, '('); // Caller has ensured that this will return non-NULL.\n\tint insert_pos;\n\t\n\tbool is_method = mClassObjectCount && !g->CurrentFunc && !aIsInExpression;\n\tif (is_method) // Class method or property getter/setter.\n\t{\n\t\tObject *class_object = mClassObject[mClassObjectCount - 1];\n\t\tif (!aStatic)\n\t\t\tclass_object = (Object *)class_object->GetOwnPropObj(_T(\"Prototype\"));\n\n\t\t*param_start = '\\0'; // Temporarily terminate, for simplicity.\n\n\t\t// Build the fully-qualified method name for A_ThisFunc and ListVars:\n\t\t// AddFunc() enforces a limit of MAX_VAR_NAME_LENGTH characters for function names.\n\t\t// For simplicity, allow one extra char to be printed and rely on AddFunc() detecting\n\t\t// that the name is too long.\n\t\tTCHAR full_name[MAX_VAR_NAME_LENGTH + 1 + 1]; // Extra +1 for null terminator.\n\t\t_sntprintf(full_name, MAX_VAR_NAME_LENGTH + 1, aStatic ? _T(\"%s.%s\") : _T(\"%s.Prototype.%s\"), mClassName, aBuf);\n\t\tfull_name[MAX_VAR_NAME_LENGTH + 1] = '\\0'; // Must terminate at this exact point if _sntprintf hit the limit.\n\t\t\n\t\t*param_start = '('; // Undo temporary termination.\n\n\t\t// Below passes class_object for AddFunc() to store the func \"by reference\" in it:\n\t\tif ( !(g->CurrentFunc = AddFunc(full_name, -1, aIsInExpression, class_object)) )\n\t\t\treturn FAIL;\n\t}\n\telse\n\t{\n\t\t// The value of g->CurrentFunc must be set here rather than by our caller since AddVar(), which we call,\n\t\t// relies upon it having been done.\n\t\tif ( !(g->CurrentFunc = AddFunc(aBuf, param_start - aBuf, aIsInExpression)) )\n\t\t\treturn FAIL; // It already displayed the error.\n\t}\n\n\t// mNextLineIsFunctionBody can be true in cases where a function begins with a nested function.\n\t// Reset it to false for this new function prior to any AddLine() calls; it will be set back to\n\t// true if appropriate when the block-end of this function is found.\n\tmNextLineIsFunctionBody = false;\n\n\tauto &func = *g->CurrentFunc; // For performance and convenience.\n\n\tsize_t param_length, value_length;\n\tFuncParam param[MAX_FUNCTION_PARAMS];\n\tint param_count = 0;\n\tTCHAR buf[LINE_SIZE];\n\tbool param_must_have_default = false;\n\tbool at_least_one_default_expr = false;\n\n#ifdef CONFIG_DLL\n\tfunc.mLineNumber = mCombinedLineNumber;\n\tfunc.mFileIndex = mCurrFileIndex;\n#endif\n\n\tif (is_method)\n\t{\n\t\t// Add the automatic/hidden \"this\" parameter.\n\t\tif ( !(param[0].var = AddVar(_T(\"this\"), 4, &func.mVars, 0, VAR_DECLARE_LOCAL | VAR_LOCAL_FUNCPARAM)) )\n\t\t\treturn FAIL;\n\t\tparam[0].default_type = PARAM_DEFAULT_NONE;\n\t\tparam[0].is_byref = false;\n\t\t++param_count;\n\t\t++func.mMinParams;\n\n\t\tif (mClassProperty && toupper(param_start[-3]) == 'S') // Set\n\t\t{\n\t\t\t// Unlike __Set, the property setters accept the value as the second parameter,\n\t\t\t// so that we can make it automatic here and make variadic properties easier.\n\t\t\tif ( !(param[1].var = AddVar(_T(\"value\"), 5, &func.mVars, 1, VAR_DECLARE_LOCAL | VAR_LOCAL_FUNCPARAM)) )\n\t\t\t\treturn FAIL;\n\t\t\tparam[1].default_type = PARAM_DEFAULT_UNSET;\n\t\t\tparam[1].is_byref = false;\n\t\t\t++param_count;\n\t\t\t++func.mMinParams;\n\t\t}\n\t}\n\n\tfor (param_start = omit_leading_whitespace(param_start + 1);;)\n\t{\n\t\tif (*param_start == ')') // No more params.\n\t\t\tbreak;\n\n\t\tif (param_count >= MAX_FUNCTION_PARAMS)\n\t\t\treturn ScriptError(_T(\"Too many params.\"), param_start); // Short msg since so rare.\n\t\tFuncParam &this_param = param[param_count]; // For performance and convenience.\n\n\t\tif (this_param.is_byref = (*param_start == '&')) // ByRef.\n\t\t\tparam_start = omit_leading_whitespace(param_start + 1);\n\t\t\n\t\tparam_end = find_identifier_end(param_start);\n\t\tparam_length = param_end - param_start;\n\t\tif (param_length)\n\t\t{\n\t\t\tVarList *varlist; // FindVar() should always set this to &func.mVars, but best to pass it for maintainability.\n\t\t\tif (this_param.var = FindVar(param_start, param_length, FINDVAR_LOCAL, &varlist, &insert_pos))\n\t\t\t\treturn ConflictingDeclarationError(_T(\"parameter\"), this_param.var);\n\t\t\tif ( !(this_param.var = AddVar(param_start, param_length, varlist, insert_pos, VAR_DECLARE_LOCAL | VAR_LOCAL_FUNCPARAM)) )\t// Pass VAR_LOCAL_FUNCPARAM as last parameter to mean \"it's a local but more specifically a function's parameter\".\n\t\t\t\treturn FAIL; // It already displayed the error, including attempts to have reserved names as parameter names.\n\t\t\tparam_start = omit_leading_whitespace(param_end);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (*param_start != '*')\n\t\t\t\treturn ScriptError(ERR_MISSING_PARAM_NAME, aBuf); // Reporting aBuf vs. param_start seems more informative since Vicinity isn't shown.\n\t\t\t// fn(a,*) permits surplus parameters but does not store them.\n\t\t\tthis_param.var = NULL;\n\t\t}\n\t\t\n\t\tthis_param.default_type = PARAM_DEFAULT_NONE; // Set default.\n\n\t\tif (func.mIsVariadic = (*param_start == '*'))\n\t\t{\n\t\t\tparam_start = omit_leading_whitespace(param_start + 1);\n\t\t\tif (*param_start != ')')\n\t\t\t\t// Give vague error message since the user's intent isn't clear.\n\t\t\t\treturn ScriptError(ERR_MISSING_CLOSE_PAREN, param_start);\n\t\t\t// Although this param must be counted since it needs a FuncParam in the array,\n\t\t\t// it doesn't count toward func.mMinParams or func.mParamCount.\n\t\t\t++param_count;\n\t\t\tbreak;\n\t\t}\n\n\t\tif (*param_start == '=') // This will probably be a common error for users transitioning from v1.\n\t\t\treturn ScriptError(ERR_BAD_OPTIONAL_PARAM, param_start);\n\n\t\t// v1.0.35: Check if a default value is specified for this parameter and set up for the next iteration.\n\t\t// The following section is similar to that used to support initializers for static variables.\n\t\t// So maybe maintain them together.\n\t\tif (*param_start == ':') // This is the default value of the param just added.\n\t\t{\n\t\t\tif (param_start[1] != '=')\n\t\t\t\treturn ScriptError(ERR_BAD_OPTIONAL_PARAM, param_start);\n\n\t\t\tparam_start = omit_leading_whitespace(param_start + 2); // Start of the default value.\n\t\t\tif (*param_start == '\"' || *param_start == '\\'') // Quoted literal string, or the empty string.\n\t\t\t{\n\t\t\t\t// Find the end of this string literal, taking into account quote type and escape chars.\n\t\t\t\tparam_end = param_start + FindTextDelim(param_start, *param_start, 1);\n\t\t\t\tif (*param_end) // Close-quote was found.\n\t\t\t\t{\n\t\t\t\t\tauto next_non_white = *omit_leading_whitespace(param_end + 1);\n\t\t\t\t\tif (next_non_white == ',' || next_non_white == ')') // Just a literal string.\n\t\t\t\t\t{\n\t\t\t\t\t\tparam_start++; // Skip the opening quote mark.\n\t\t\t\t\t\tsize_t len;\n\t\t\t\t\t\t// Raw escape sequences like `n haven't been converted yet, so it's done here while also copying the string.\n\t\t\t\t\t\tthis_param.default_type = PARAM_DEFAULT_STR;\n\t\t\t\t\t\tthis_param.default_str = ConvertEscapeSequences<SimpleHeap::Alloc<TCHAR>>(param_start, param_end - param_start, len);\n\t\t\t\t\t\t++param_end; // Move beyond the close-quote, for below.\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (this_param.default_type != PARAM_DEFAULT_STR)\n\t\t\t{\n\t\t\t\tvalue_length = FindExprDelim(param_start, 0);\n\t\t\t\tif (value_length >= _countof(buf)) // Default expressions shouldn't realistically be longer than LINE_SIZE.\n\t\t\t\t\treturn ScriptError(ERR_INVALID_FUNCDECL, aBuf);\n\t\t\t\tif (value_length <= MAX_NUMBER_SIZE)\n\t\t\t\t{\n\t\t\t\t\ttcslcpy(buf, param_start, value_length + 1); // Make a temp copy to simplify the below (especially IsNumeric).\n\t\t\t\t\tvalue_length = rtrim(buf, value_length); // trim white space for _tcsicmp below\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\t*buf = '\\0'; // It can't be any of the optimized defaults, so skip the copy.\n\t\t\t\tif (!_tcsicmp(buf, _T(\"False\")))\n\t\t\t\t{\n\t\t\t\t\tthis_param.default_type = PARAM_DEFAULT_INT;\n\t\t\t\t\tthis_param.default_int64 = 0;\n\t\t\t\t}\n\t\t\t\telse if (!_tcsicmp(buf, _T(\"True\")))\n\t\t\t\t{\n\t\t\t\t\tthis_param.default_type = PARAM_DEFAULT_INT;\n\t\t\t\t\tthis_param.default_int64 = 1;\n\t\t\t\t}\n\t\t\t\telse if (!_tcsicmp(buf, _T(\"unset\")))\n\t\t\t\t{\n\t\t\t\t\tthis_param.default_type = PARAM_DEFAULT_UNSET;\n\t\t\t\t}\n\t\t\t\telse // The only things supported other than the above are integers and floats.\n\t\t\t\t{\n\t\t\t\t\tswitch(IsNumeric(buf, true, false, true))\n\t\t\t\t\t{\n\t\t\t\t\tcase PURE_INTEGER:\n\t\t\t\t\t\tthis_param.default_type = PARAM_DEFAULT_INT;\n\t\t\t\t\t\tthis_param.default_int64 = ATOI64(buf);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase PURE_FLOAT:\n\t\t\t\t\t\tthis_param.default_type = PARAM_DEFAULT_FLOAT;\n\t\t\t\t\t\tthis_param.default_double = _tstof(buf); // _tstof() vs. ATOF() because PURE_FLOAT is never hexadecimal.\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault: // Not numeric (and also not a quoted string because that was handled earlier).\n\t\t\t\t\t\t// This was previously done using ??, which gave the wrong result for ByRef parameters,\n\t\t\t\t\t\t// since ?? checks the target variable when one is provided. So instead, the Line is executed\n\t\t\t\t\t\t// directly by UserFunc::Call() if the parameter is omitted. To prevent them from executing\n\t\t\t\t\t\t// unconditionally, PreparseExpressions() sets mJumpToLine to the real first line of the body,\n\t\t\t\t\t\t// after it uses the initial value of mJumpToLine (which is set by ParseAndAddLine below).\n\t\t\t\t\t\tsntprintf(buf, _countof(buf), _T(\"%s := %.*s\"), this_param.var->mName, value_length, param_start);\n\t\t\t\t\t\tif (!at_least_one_default_expr)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tat_least_one_default_expr = true;\n\t\t\t\t\t\t\tif (!AddLine(ACT_BLOCK_BEGIN))\n\t\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (!ParseAndAddLine(buf, ACT_EXPRESSION))\n\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t\tthis_param.default_type = PARAM_DEFAULT_EXPR;\n\t\t\t\t\t\tthis_param.default_expr = mLastLine;\n\t\t\t\t\t\tmLastParamInitializer = mLastLine; // Allow other checks to identify this as not an actual script line.\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tparam_end = param_start + value_length;\n\t\t\t}\n\t\t\tparam_must_have_default = true; // For now, all other params after this one must also have default values.\n\t\t\t// Set up for the next iteration:\n\t\t\tparam_start = omit_leading_whitespace(param_end);\n\t\t}\n\t\telse if (*param_start == '?')\n\t\t{\n\t\t\tthis_param.default_type = PARAM_DEFAULT_UNSET;\n\t\t\tparam_must_have_default = true; // For now, all other params after this one must also have default values.\n\t\t\t// Set up for the next iteration:\n\t\t\tparam_start = omit_leading_whitespace(param_start + 1);\n\t\t}\n\t\telse // This parameter does not have a default value specified.\n\t\t{\n\t\t\tif (param_must_have_default)\n\t\t\t\treturn ScriptError(_T(\"Parameter default required.\"), this_param.var->mName);\n\t\t\t++func.mMinParams;\n\t\t}\n\t\t++param_count;\n\n\t\tif (*param_start != ',' && *param_start != ')') // Something like \"fn(a, b c)\" (missing comma) would cause this.\n\t\t\treturn ScriptError(ERR_MISSING_COMMA, aBuf); // Reporting aBuf vs. param_start seems more informative since Vicinity isn't shown.\n\t\tif (*param_start == ',')\n\t\t{\n\t\t\tparam_start = omit_leading_whitespace(param_start + 1);\n\t\t\tif (*param_start == ')') // If *param_start is ',' it will be caught as an error by the next iteration.\n\t\t\t\treturn ScriptError(ERR_MISSING_PARAM_NAME, aBuf); // Reporting aBuf vs. param_start seems more informative since Vicinity isn't shown.\n\t\t}\n\t\t//else it's ')', in which case the next iteration will handle it.\n\t\t// Above has ensured that param_start now points to the next parameter, or ')' if none.\n\t} // for() each formal parameter.\n\n\tif (at_least_one_default_expr)\n\t\tmIgnoreNextBlockBegin = true; // This is only set after all parameters are parsed, in case they contain fat arrow functions.\n\n\tif (param_count)\n\t{\n\t\t// Allocate memory only for the actual number of parameters actually present.\n\t\tfunc.mParam = SimpleHeap::Alloc<FuncParam>(param_count);\n\t\tfunc.mParamCount = param_count - func.mIsVariadic; // i.e. don't count the final \"param*\" of a variadic function.\n\t\tmemcpy(func.mParam, param, param_count * sizeof(FuncParam));\n\t}\n\t//else leave func.mParam/mParamCount set to their NULL/0 defaults.\n\t\n\tif (mPendingHotkey)\n\t{\n\t\tif (func.mMinParams > 1 || (func.mParamCount == 0 && !func.mIsVariadic))\n\t\t\t// func must accept at least one parameter (or use *), any remaining parameters must be optional.\n\t\t\treturn ScriptError(ERR_HOTKEY_FUNC_PARAMS, aBuf);\n\n\t\t// Check all hotkeys, since there might be multiple\n\t\t// hotkeys stacked:\n\t\t// ^a::\n\t\t// ^b::\n\t\t// somefunc(){ ...\n\t\tfor (int i = 0; i < Hotkey::sHotkeyCount; ++i)\n\t\t{\n\t\t\tfor (HotkeyVariant* v = Hotkey::shk[i]->mFirstVariant; v; v = v->mNextVariant)\n\t\t\t\tif (!v->mCallback)\n\t\t\t\t{\n\t\t\t\t\tv->mCallback = &func;\n\t\t\t\t\tv->mOriginalCallback = &func;\t// To make scripts more maintainable and to\n\t\t\t\t\t\t\t\t\t\t\t\t\t// make the hotkey() function more consistent.\n\t\t\t\t\t\t\t\t\t\t\t\t\t// For example,\n\t\t\t\t\t\t\t\t\t\t\t\t\t// x::{\n\t\t\t\t\t\t\t\t\t\t\t\t\t// }\n\t\t\t\t\t\t\t\t\t\t\t\t\t// Hotkey 'x', 'x', 'off'\n\t\t\t\t\t\t\t\t\t\t\t\t\t// should be valid if the script is changed to,\n\t\t\t\t\t\t\t\t\t\t\t\t\t// x::\n\t\t\t\t\t\t\t\t\t\t\t\t\t// myFunc(){\n\t\t\t\t\t\t\t\t\t\t\t\t\t// }\n\t\t\t\t\t\t\t\t\t\t\t\t\t// Hotkey 'x', 'x', 'off'\n\n\t\t\t\t\tbreak;\t// Only one variant possible, per hotkey.\n\t\t\t\t}\n\t\t}\n\t\t// Check hotstrings as well (even if a hotkey was found):\n\t\tfor (int i = Hotstring::sHotstringCount - 1; i >= 0; --i) // Start with the last one defined, for performance.\n\t\t{\n\t\t\tif (Hotstring::shs[i]->mCallback || Hotstring::shs[i]->mReplacement)\n\t\t\t\t// This hotstring has a function or is auto-replace.\n\t\t\t\t// Since hotstrings are listed in order of definition and we're iterating in\n\t\t\t\t// the reverse order, there's no need to continue.\n\t\t\t\tbreak;\n\t\t\tHotstring::shs[i]->mCallback = &func;\n\t\t}\n\n\t\tmPendingHotkey = nullptr;\n\t}\n\n\t// At this point, param_start points to ')'.\n\tASSERT(*param_start == ')');\n\tparam_start = omit_leading_whitespace(param_start + 1);\n\tif (*param_start == '{') // OTB.\n\t{\n\t\tif (!AddLine(ACT_BLOCK_BEGIN))\n\t\t\treturn FAIL;\n\t\tASSERT(!param_start[1]); // IsFunctionDefinition() verified this.\n\t}\n\telse if (*param_start == '=' && '>' == param_start[1]) // => expr\n\t{\n\t\tparam_start = omit_leading_whitespace(param_start + 2);\n\t\tif (!*param_start)\n\t\t\treturn ScriptError(ERR_INVALID_FUNCDECL, aBuf);\n\t\tif (!ParseAndAddLineInBlock(param_start, ACT_RETURN))\n\t\t\treturn FAIL;\n\t}\n\telse\n\t{\n\t\t// IsFunctionDefinition() permits only {, => or \\0.\n\t\tASSERT(!*param_start);\n\t}\n\treturn OK;\n}\n\n\n\nResultType Script::DefineClass(LPTSTR aBuf, TCHAR aExport)\n{\n\tif (mClassObjectCount == MAX_NESTED_CLASSES)\n\t\treturn ScriptError(_T(\"This class definition is nested too deep.\"), aBuf);\n\n\tLPTSTR cp, class_name = aBuf, base_class_name = nullptr;\n\tObject *outer_class, *base_class = Object::sClass, *base_prototype = Object::sPrototype;\n\tVar *class_var;\n\tExprTokenType token;\n\n\tfor (cp = aBuf; *cp && !IS_SPACE_OR_TAB(*cp); ++cp);\n\tsize_t class_name_length = cp - aBuf;\n\tif (*cp)\n\t{\n\t\t*cp = '\\0'; // Null-terminate here for class_name.\n\t\tcp = omit_leading_whitespace(cp + 1);\n\t\tif (_tcsnicmp(cp, _T(\"extends\"), 7) || !IS_SPACE_OR_TAB(cp[7]))\n\t\t\treturn ScriptError(_T(\"Syntax error in class definition.\"), cp);\n\t\tbase_class_name = omit_leading_whitespace(cp + 8);\n\t\tif (!*base_class_name)\n\t\t\treturn ScriptError(_T(\"Missing class name.\"), cp);\n\t\tbase_class = FindClass(base_class_name);\n\t\tbase_prototype = base_class ? (Object *)base_class->GetOwnPropObj(_T(\"Prototype\")) : nullptr;\n\t}\n\n\t// Validate the name even if this is a nested definition, for consistency.\n\tif (!Var::ValidateName(class_name, DISPLAY_CLASS_ERROR))\n\t\treturn FAIL;\n\n\tbool conflict_found = false;\n\t\n\tif (mClassObjectCount) // Nested class definition.\n\t{\n\t\touter_class = mClassObject[mClassObjectCount - 1];\n\t\tif (outer_class->HasOwnProp(class_name))\n\t\t{\n\t\t\tconflict_found = true;\n\t\t\t// If \"continuing\" a predefined class was permitted, this is where we would\n\t\t\t// set class_object; but only after confirming that token contains a class.\n\t\t\t// It could be a previously declared instance/static var.\n\t\t}\n\t}\n\telse // Top-level class definition.\n\t{\n\t\tif (aExport == 'D' && mCurrentModule->mSelf)\n\t\t\treturn ScriptError(ERR_DUPLICATE_DECLARATION, aBuf);\n\t\t*mClassName = '\\0'; // Init.\n\t\tVarList *varlist = GlobalVars();\n\t\tint insert_pos;\n\t\tclass_var = varlist->Find(class_name, &insert_pos);\n\t\tif (class_var)\n\t\t{\n\t\t\tif (class_var->IsDeclared())\n\t\t\t\treturn ConflictingDeclarationError(_T(\"class\"), class_var);\n\t\t}\n\t\telse if ( !(class_var = AddVar(class_name, class_name_length, varlist, insert_pos, VAR_DECLARE_GLOBAL)) )\n\t\t\treturn FAIL;\n\t\tif (aExport == 'E')\n\t\t\tclass_var->Scope() |= VAR_EXPORTED;\n\t\tif (aExport == 'D')\n\t\t\tmCurrentModule->mSelf = class_var;\n\t}\n\t\n\tsize_t length = _tcslen(mClassName), extra_length = class_name_length + 1; // +1 for '.'\n\tif (length + extra_length >= _countof(mClassName))\n\t\treturn ScriptError(_T(\"Full class name is too long.\"));\n\tif (length)\n\t\tmClassName[length++] = '.';\n\ttmemcpy(mClassName + length, class_name, extra_length); // Includes null-terminator.\n\tlength += extra_length - 1; // -1 to exclude the null-terminator.\n\n\t// For now, it seems more useful to detect a duplicate as an error rather than as\n\t// a continuation of the previous definition. Partial definitions might be allowed\n\t// in future, perhaps via something like \"Class Foo continued\".\n\tif (conflict_found)\n\t\treturn ScriptError(ERR_DUPLICATE_DECLARATION, aBuf);\n\n\tObject *prototype = Object::CreatePrototype(mClassName, base_prototype);\n\tObject *class_object = Object::CreateClass(prototype, base_class ? base_class : Object::sClassPrototype);\n\n\tif (!base_class)\n\t{\n\t\t// None of this module's class declarations up to this point match base_class_name,\n\t\t// but it could be a class defined below this point, or a class defined in a module\n\t\t// which hasn't been imported yet or has been imported but hasn't been resolved.\n\t\tauto urc = new UnresolvedBaseClass;\n\t\turc->subclass = class_object;\n\t\turc->subclass_proto = prototype;\n\t\turc->name = _tcsdup(base_class_name);\n\t\turc->file_index = mCurrFileIndex;\n\t\turc->line_number = mCombinedLineNumber;\n\t\turc->next = mCurrentModule->mUnresolvedBaseClass;\n\t\tmCurrentModule->mUnresolvedBaseClass = urc;\n\t}\n\n\tif (mClassObjectCount)\n\t{\n\t\t// Define property outer_class.%class_name%.\n\t\touter_class->DefineClass(class_name, class_object);\n\t}\n\telse\n\t{\n\t\tclass_var->Assign(class_object); // Assign to global variable named %class_name%.\n\t\tclass_var->MakeReadOnly();\n\t\tclass_var->MarkUninitialized(); // This enables the constructor to be called on first use.\n\t}\n\n\tif (mClassObjectCount ? !DefineClassVarInit(mClassName, true, outer_class, ACT_EXPRESSION) : !ParseAndAddLine(mClassName, ACT_EXPRESSION))\n\t\treturn FAIL;\n\tmClassObject[mClassObjectCount++] = class_object;\n\t// Define __Init unconditionally so that classes without static vars do not inherit __Init.\n\tif (!DefineClassInit(true))\n\t\treturn FAIL;\n\tif (base_class_name)\n\t{\n\t\t// Ensure the base class is initialized by inserting a reference to it into static __Init.\n\t\t// Otherwise, the base class could be accessed via .base without triggering initialization.\n\t\tif (!DefineClassVarInit(base_class_name, true, class_object, ACT_EXPRESSION))\n\t\t\treturn FAIL;\n\t}\n\t\n\t// This line enables a class without any static methods to be freed at program exit,\n\t// or sooner if it's a nested class and the script removes it from the outer class.\n\t// Classes with static methods are never freed, since the method itself retains a\n\t// reference to the class.\n\tclass_object->Release();\n\n\treturn OK;\n}\n\n\nResultType Script::DefineClassProperty(LPTSTR aBuf, bool aStatic, bool &aBufHasBraceOrNotNeeded)\n{\n\tLPTSTR name_end = find_identifier_end(aBuf);\n\tLPTSTR param_start = omit_leading_whitespace(name_end);\n\tLPTSTR param_end, next_token;\n\tif (*param_start == '[')\n\t{\n\t\tparam_start = omit_leading_whitespace(param_start + 1);\n\t\tif (*param_start == ']')\n\t\t\treturn ScriptError(ERR_PROPERTY_EMPTY_BRACKETS, aBuf);\n\t\tparam_end = param_start + FindExprDelim(param_start, ']');\n\t\tif (!*param_end)\n\t\t\treturn ScriptError(ERR_MISSING_CLOSE_BRACKET, aBuf);\n\t\tnext_token = omit_leading_whitespace(param_end + 1);\n\t}\n\telse\n\t{\n\t\tparam_end = param_start;\n\t\tnext_token = param_start;\n\t}\n\tif (!*next_token)\n\t\taBufHasBraceOrNotNeeded = false;\n\telse if (*next_token == '{' && !next_token[1]\n\t\t|| *next_token == '=' && next_token[1] == '>')\n\t\taBufHasBraceOrNotNeeded = true;\n\telse\n\t\treturn ScriptError(ERR_INVALID_LINE_IN_CLASS_DEF, aBuf);\n\n\t// Save the property name and parameter list for later use with DefineFunc().\n\tint name_length = int(name_end - aBuf);\n\tint param_length = int(param_end - param_start);\n\tmClassPropertyDef = tmalloc(name_length + param_length + 7); // +7 for \".Get()\\0\"\n\tif (!mClassPropertyDef)\n\t\treturn ScriptError(ERR_OUTOFMEM);\n\t_stprintf(mClassPropertyDef, _T(\"%.*s.Get(%.*s)\"), name_length, aBuf, param_length, param_start);\n\n\tObject *class_object = mClassObject[mClassObjectCount - 1];\n\tif (!aStatic)\n\t\tclass_object = (Object *)class_object->GetOwnPropObj(_T(\"Prototype\"));\n\tTCHAR end_char = *name_end; // In case there's no space before =>.\n\t*name_end = 0; // Terminate for aBuf use below.\n\tswitch (class_object->GetOwnPropType(aBuf))\n\t{\n\tcase Object::PropType::Object:\n\tcase Object::PropType::DynamicValue: // get/set\n\tcase Object::PropType::DynamicMixed: // get/set and call\n\t\treturn ScriptError(ERR_DUPLICATE_DECLARATION, aBuf);\n\t}\n\tmClassProperty = class_object->DefineProperty(aBuf);\n\tmClassPropertyStatic = aStatic;\n\tif (!mClassProperty)\n\t\treturn ScriptError(ERR_OUTOFMEM);\n\n\t*name_end = end_char;\n\tif (*next_token == '=') // => expr\n\t{\n\t\t// mClassPropertyDef is already set up for \"Get\".\n\t\tif (!DefineClassPropertyXet(aBuf, next_token))\n\t\t\treturn FAIL;\n\t\t// Immediately close this property definition.\n\t\tmClassProperty = NULL;\n\t\tfree(mClassPropertyDef);\n\t\tmClassPropertyDef = NULL;\n\t}\n\n\treturn OK;\n}\n\n\nResultType Script::DefineClassPropertyXet(LPTSTR aBuf, LPTSTR aEnd)\n{\n\t// For simplicity, pass the property definition to DefineFunc instead of the actual\n\t// line text, even though it makes some error messages a bit inaccurate. (That would\n\t// happen anyway when DefineFunc() finds a syntax error in the parameter list.)\n\tif (!DefineFunc(mClassPropertyDef, mClassPropertyStatic))\n\t\treturn FAIL;\n\tif (g->CurrentFunc == mClassProperty->Setter())\n\t\tmClassProperty->NoParamSet = g->CurrentFunc->mParamCount == 2 && !g->CurrentFunc->mIsVariadic;\n\telse\n\t{\n\t\tmClassProperty->NoParamGet = g->CurrentFunc->mParamCount == 1 && !g->CurrentFunc->mIsVariadic;\n\t\tmClassProperty->NoEnumGet = g->CurrentFunc->mMinParams > 1;\n\t}\n\tif (*aEnd && !AddLine(ACT_BLOCK_BEGIN)) // *aEnd is '{' or '='.\n\t\treturn FAIL;\n\tif (*aEnd == '=') // => expr\n\t{\n\t\taEnd = omit_leading_whitespace(aEnd + 2);\n\t\tif (!ParseAndAddLine(aEnd, ACT_RETURN)\n\t\t\t|| !AddLine(ACT_BLOCK_END))\n\t\t\treturn FAIL;\n\t}\n\treturn OK;\n}\n\n\nResultType Script::DefineClassVars(LPTSTR aBuf, bool aStatic)\n{\n\tObject *class_object = mClassObject[mClassObjectCount - 1];\n\tObject *prototype = aStatic ? class_object : (Object *)class_object->GetOwnPropObj(_T(\"Prototype\"));\n\n\tLPTSTR item, item_end;\n\tTCHAR orig_char, buf[LINE_SIZE], type_buf[LINE_SIZE];\n\tsize_t buf_used = 0;\n\tExprTokenType unset_token;\n\tunset_token.symbol = SYM_MISSING;\n\n\tfor (item = omit_leading_whitespace(aBuf); *item;) // FOR EACH COMMA-SEPARATED ITEM IN THE DECLARATION LIST.\n\t{\n\t\tauto name_end = item_end = find_identifier_end(item);\n\t\tif (item_end == item)\n\t\t\treturn ScriptError(ERR_INVALID_CLASS_VAR, item);\n\t\torig_char = *item_end;\n\t\t*item_end = '\\0'; // Temporarily terminate.\n\t\tauto item_exists = prototype->GetOwnPropType(item);\n\t\t*item_end = orig_char; // Undo termination.\n\t\tbool item_name_has_dot = (orig_char == '.');\n\t\tif (item_name_has_dot)\n\t\t{\n\t\t\t// This is something like \"object.key := 5\", which is only valid if \"object\" was\n\t\t\t// previously declared (and will presumably be assigned an object at runtime).\n\t\t\t// Ensure that at least the root class var exists; any further validation would\n\t\t\t// be impossible since the object doesn't exist yet.\n\t\t\tif (item_exists == Object::PropType::None)\n\t\t\t\treturn ScriptError(_T(\"Unknown class var.\"), item);\n\t\t\tfor (TCHAR *cp; *item_end == '.'; item_end = cp)\n\t\t\t{\n\t\t\t\tfor (cp = item_end + 1; IS_IDENTIFIER_CHAR(*cp); ++cp);\n\t\t\t\tif (cp == item_end + 1)\n\t\t\t\t\t// This '.' wasn't followed by a valid identifier. Leave item_end\n\t\t\t\t\t// pointing at '.' and allow the switch() below to report the error.\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t\tname_end = item_end;\n\t\t}\n\t\titem_end = omit_leading_whitespace(item_end);\n\t\tif (!item_name_has_dot)\n\t\t{\n\t\t\tLPTSTR type_name = nullptr, type_name_end = nullptr;\n\t\t\tif (*item_end == ':' && item_end[1] != '=' && !aStatic)\n\t\t\t{\n\t\t\t\t// A type declaration could consist of any expression that returns\n\t\t\t\t// a Class-like object, but this section primarily aims to permit:\n\t\t\t\t// - abc\n\t\t\t\t// - abc.def\n\t\t\t\t// - abc(params)\n\t\t\t\t// - abc[count]\n\t\t\t\t// This is done in a way that allows other forms for flexibility:\n\t\t\t\t// - abc(params).subtype\n\t\t\t\t// - (any expression)\n\t\t\t\ttype_name = omit_leading_whitespace(item_end + 1);\n\t\t\t\tfor (auto cp = type_name;; ++cp)\n\t\t\t\t{\n\t\t\t\t\tcp = find_identifier_end(cp);\n\t\t\t\t\tif (*cp == '(' || *cp == '[')\n\t\t\t\t\t{\n\t\t\t\t\t\tcp += 1 + FindExprDelim(cp + 1, *cp == '(' ? ')' : ']');\n\t\t\t\t\t\tif (*cp)\n\t\t\t\t\t\t\t++cp;\n\t\t\t\t\t}\n\t\t\t\t\ttype_name_end = cp;\n\t\t\t\t\tcp = omit_leading_whitespace(type_name_end);\n\t\t\t\t\tif (*cp != '.' || cp == type_name)\n\t\t\t\t\t{\n\t\t\t\t\t\tif ((*cp == ':' && cp[1] == '=' || *cp == ',' || !*cp) && cp != type_name)\n\t\t\t\t\t\t\titem_end = cp;\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\ttype_name = nullptr;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tswitch (item_exists)\n\t\t\t{\n\t\t\tdefault: // Dynamic...\n\t\t\t\tif (!type_name)\n\t\t\t\t\tbreak; // Let this line assign to the property.\n\t\t\tcase Object::PropType::Value:\n\t\t\tcase Object::PropType::Object: // Prototype or nested class.\n\t\t\tcase Object::PropType::Typed:\n\t\t\t\treturn ScriptError(ERR_DUPLICATE_DECLARATION, item);\n\t\t\tcase Object::PropType::None:\n\t\t\t\t*name_end = '\\0'; // Temporarily terminate.\n\t\t\t\tif (type_name)\n\t\t\t\t{\n\t\t\t\t\t// Use static __Init() to define the property types.\n\t\t\t\t\t// It's done this way for a couple of reasons:\n\t\t\t\t\t// - Allows types to be parameterized or dynamically constructed.\n\t\t\t\t\t// - Allows properties to depend on classes that are defined below\n\t\t\t\t\t// the current point in the script.\n\t\t\t\t\tauto type_end_char = *type_name_end;\n\t\t\t\t\t*type_name_end = '\\0';\n\t\t\t\t\tTCHAR qu[2] { 0 };\n\t\t\t\t\tif (TypeCode(type_name) != MdType::Void)\n\t\t\t\t\t\tqu[0] = '\\'';\n\t\t\t\t\t_sntprintf(type_buf, _countof(type_buf), _T(\"this.Prototype.DefineProp('%s',{Type:%s%s%s})\")\n\t\t\t\t\t\t, item, qu, type_name, qu);\n\t\t\t\t\tif (!DefineClassVarInit(type_buf, true, class_object, ACT_EXPRESSION))\n\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t*type_name_end = type_end_char;\n\t\t\t\t}\n\t\t\t\t// Store the unset marker in prototype.%item% to allow duplicate declarations to be detected:\n\t\t\t\tif (!prototype->SetOwnProp(item, unset_token))\n\t\t\t\t\treturn ScriptError(ERR_OUTOFMEM);\n\t\t\t\t*name_end = orig_char; // Undo termination.\n\t\t\t}\n\t\t}\n\t\t\t\t\t\t\n\t\t// This section is very similar to the one in ParseAndAddLine() which deals with\n\t\t// variable declarations, so maybe maintain them together:\n\n\t\tswitch (*item_end)\n\t\t{\n\t\tcase ',': // No initializer is present for this variable, so move on to the next one.\n\t\t\titem = omit_leading_whitespace(item_end + 1); // Set \"item\" for use by the next iteration.\n\t\t\tcontinue; // No further processing needed below.\n\t\tcase '\\0': // No initializer is present for this variable, so move on to the next one.\n\t\t\titem = item_end; // Set \"item\" for use by the loop's condition.\n\t\t\tcontinue;\n\t\tcase ':':\n\t\t\tif (item_end[1] == '=')\n\t\t\t{\n\t\t\t\titem_end += 2; // Point to the character after the \":=\".\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// Otherwise, fall through to below:\n\t\tdefault:\n\t\t\treturn ScriptError(ERR_INVALID_CLASS_VAR, item);\n\t\t}\n\t\t\t\t\t\t\n\t\t// Since above didn't \"continue\", this declared variable also has an initializer.\n\t\t// Build an expression which can be executed to initialize this class variable.\n\t\titem_end = omit_leading_whitespace(item_end);\n\t\tLPTSTR right_side_of_operator = item_end; // Save for use below.\n\n\t\titem_end += FindExprDelim(item_end); // Find the next comma which is not part of the initializer (or find end of string).\n\n\t\t// Append \"ClassNameOrThis.VarName := Initializer, \" to the buffer.\n\t\tLPCTSTR initializer = _T(\"%s.%.*s := %.*s, \");\n\t\tint chars_written = _sntprintf(buf + buf_used, _countof(buf) - buf_used, initializer\n\t\t\t, aStatic ? mClassName : _T(\"this\"), (int)(name_end - item), item, (int)(item_end - right_side_of_operator), right_side_of_operator);\n\t\tif (chars_written < 0)\n\t\t\treturn ScriptError(_T(\"Declaration too long.\")); // Short message since should be rare.\n\t\tbuf_used += chars_written;\n\n\t\t// Set \"item\" for use by the next iteration:\n\t\titem = (*item_end == ',') // i.e. it's not the terminator and thus not the final item in the list.\n\t\t\t? omit_leading_whitespace(item_end + 1)\n\t\t\t: item_end; // It's the terminator, so let the loop detect that to finish.\n\t}\n\tif (buf_used)\n\t{\n\t\t// Above wrote at least one initializer expression into buf.\n\t\tbuf[buf_used -= 2] = '\\0'; // Remove the final \", \"\n\t\treturn DefineClassVarInit(buf, aStatic, prototype);\n\t}\n\treturn OK;\n}\n\n\nResultType Script::DefineClassVarInit(LPTSTR aBuf, bool aStatic, Object *aObject, ActionTypeType aActionType)\n{\n\tLine *script_last_line = mLastLine;\n\tLine *block_end;\n\tauto init_func = (UserFunc *)aObject->GetOwnPropMethod(_T(\"__Init\")); // Can only be a user-defined function or nullptr at this stage.\n\tif (init_func)\n\t{\n\t\t// __Init method already exists, so find the end of its body.\n\t\tfor (block_end = init_func->mJumpToLine;\n\t\t\tblock_end->mActionType != ACT_BLOCK_END || block_end->mAttribute != init_func;\n\t\t\tblock_end = block_end->mNextLine);\n\t}\n\telse\n\t{\n\t\t// Create an __Init method for this class/prototype.\n\t\tinit_func = DefineClassInit(aStatic);\n\t\tif (!init_func)\n\t\t\treturn FAIL;\n\t\tscript_last_line = block_end = mLastLine;\n\t}\n\t\n\t// Temporarily replace mLastLine to insert script lines at the end of __Init.\n\tg->CurrentFunc = init_func; // g->CurrentFunc should be NULL prior to this.\n\tmLastLine = block_end->mPrevLine; // i.e. insert before block_end.\n\tmLastLine->mNextLine = nullptr; // For maintainability; AddLine() should overwrite it regardless.\n\tmCurrLine = nullptr; // Fix for v1.1.09.02: Leaving this non-NULL at best causes error messages to show irrelevant vicinity lines, and at worst causes a crash because the linked list is in an inconsistent state.\n\tif (init_func->mJumpToLine == block_end) // This can be true only for the first static initializer.\n\t{\n\t\tinit_func->mJumpToLine = nullptr; // Without this, a fat arrow function in aBuf would fail to reset mNextLineIsFunctionBody = true.\n\t\tmNextLineIsFunctionBody = true;\n\t}\n\n\tLine *prl = mPendingRelatedLine; // This was set by AddLine(ACT_BLOCK_END) if DefineClassInit() was just called.\n\tmPendingRelatedLine = nullptr;\n\t// No need to account for pending labels because 1) labels aren't allowed in a class body,\n\t// 2) any label above the class would already point to the implied \"initialization\" line,\n\t// 3) AddLine will only check for pending labels in g->CurrentFunc (i.e. init_func).\n\tif (!ParseAndAddLine(aBuf, aActionType))\n\t\treturn FAIL; // Above already displayed the error.\n\tif (mExprContainingThisFunc)\n\t{\n\t\t// aBuf contained the start of a function definition expression, so defer the rest.\n\t\tmExprContainingThisFunc->rejoin_first_line = block_end;\n\t\tmExprContainingThisFunc->rejoin_last_line = script_last_line;\n\t}\n\telse\n\t{\n\t\tmPendingRelatedLine = prl;\n\t\t// Rejoin the function's block-end (and any lines following it) to the main script.\n\t\tmLastLine->mNextLine = block_end;\n\t\tblock_end->mPrevLine = mLastLine;\n\t\t// mFirstLine should be left as it is: if it was NULL, it now contains a pointer to our\n\t\t// __init function's block-begin, which is now the very first executable line in the script.\n\t\tg->CurrentFunc = nullptr;\n\t\t// Restore mLastLine so that any subsequent script lines are added at the correct point.\n\t\tmLastLine = script_last_line;\n\t}\n\treturn OK;\n}\n\n\nUserFunc *Script::DefineClassInit(bool aStatic)\n{\n\tTCHAR def[] = _T(\"__Init(){\");\n\tif (!DefineFunc(def, aStatic))\n\t\treturn nullptr;\n\tif (!aStatic)\n\t{\n\t\tif (!ParseAndAddLine(SUPER_KEYWORD _T(\".__Init()\"), ACT_EXPRESSION)) // Initialize base-class variables first. Relies on short-circuit evaluation.\n\t\t\treturn nullptr;\n\t\tmLastLine->mLineNumber = 0; // Signal the debugger to skip this line while stepping in/over/out.\n\t}\n\tauto init_func = g->CurrentFunc;\n\tif (!AddLine(ACT_BLOCK_END)) // This also resets g->CurrentFunc to NULL.\n\t\treturn nullptr;\n\tmLastLine->mLineNumber = 0; // See above.\n\treturn init_func;\n}\n\n\nObject *Script::FindClass(LPCTSTR aClassName, size_t aClassNameLength)\n{\n\tif (!aClassNameLength)\n\t\taClassNameLength = _tcslen(aClassName);\n\tif (!aClassNameLength || aClassNameLength > MAX_CLASS_NAME_LENGTH)\n\t\treturn NULL;\n\n\tLPTSTR cp, key;\n\tExprTokenType token;\n\tObject *base_object = NULL;\n\tTCHAR class_name[MAX_CLASS_NAME_LENGTH + 2]; // Extra +1 for '.' to simplify parsing.\n\t\n\t// Make temporary copy which we can modify.\n\ttmemcpy(class_name, aClassName, aClassNameLength);\n\tclass_name[aClassNameLength] = '.'; // To simplify parsing.\n\tclass_name[aClassNameLength + 1] = '\\0';\n\n\t// Get base variable; e.g. \"MyClass\" in \"MyClass.MySubClass\".\n\tcp = _tcschr(class_name + 1, '.');\n\t// To reserve for possible future use with local classes, resolve the class variable according\n\t// to the current scope (which is always global for class..extends, but often local for Catch).\n\t// This also avoids confusion due to inconsistency between `catch x` and other references to x.\n\tVar *base_var = FindVar(class_name, cp - class_name);\n\tfor (;;)\n\t{\n\t\tif (!base_var || !base_var->HasObject()) // Has vs. Is to handle import aliases.\n\t\t\treturn nullptr;\n\t\n\t\tIObject *obj = base_var->Object();\n\t\tif (obj->IsOfType(Object::sClassPrototype))\n\t\t{\n\t\t\tbase_object = (Object*)obj;\n\t\t\tbreak;\n\t\t}\n\t\tif (obj->Base() != ScriptModule::sPrototype)\n\t\t\treturn nullptr; // Maybe something like \"Class nonsense extends MsgBox\".\n\n\t\tauto mod = (ScriptModule*)obj;\n\t\tkey = cp + 1; cp = _tcschr(key, '.');\n\t\t*cp = '\\0';\n\t\tbase_var = mod->mVars.Find(key);\n\t\tif (!base_var || !base_var->IsExported())\n\t\t\treturn nullptr;\n\t}\n\n\tfor (key = cp + 1; cp = _tcschr(key, '.'); key = cp + 1) // For each key in something like TypeVar.Key1.Key2.\n\t{\n\t\tif (cp == key)\n\t\t\treturn NULL; // ScriptError(_T(\"Missing name.\"), cp);\n\t\t*cp = '\\0'; // Terminate at the delimiting dot.\n\t\t// Invoking at this stage isn't safe since aClassName could include the name of a\n\t\t// user-defined property getter, or the class might implement __Get, and the script\n\t\t// isn't necessarily ready to execute. Get it this way instead:\n\t\tauto getter = dynamic_cast<BuiltInFunc*>(base_object->GetOwnPropGetter(key));\n\t\tif (!getter || getter->mBIF != Class_GetNestedClass)\n\t\t\treturn NULL;\n\t\tbase_object = ((NestedClassInfo*)getter->mData)->class_object;\n\t}\n\n\treturn base_object;\n}\n\n\n\n#ifndef AUTOHOTKEYSC\n\n#define FUNC_LIB_EXT EXT_AUTOHOTKEY\n#define FUNC_LIB_EXT_LENGTH (_countof(FUNC_LIB_EXT) - 1)\n#define FUNC_LOCAL_LIB _T(\"\\\\Lib\\\\\") // Needs leading and trailing backslash.\n#define FUNC_LOCAL_LIB_LENGTH (_countof(FUNC_LOCAL_LIB) - 1)\n#define FUNC_USER_LIB _T(\"\\\\AutoHotkey\\\\Lib\\\\\") // Needs leading and trailing backslash.\n#define FUNC_USER_LIB_LENGTH (_countof(FUNC_USER_LIB) - 1)\n#define FUNC_STD_LIB _T(\"\\\\Lib\\\\\") // Needs leading and trailing backslash.\n#define FUNC_STD_LIB_LENGTH (_countof(FUNC_STD_LIB) - 1)\n\n#define FUNC_LIB_COUNT 3\n\nvoid Script::InitFuncLibraries(FuncLibrary aLib[])\n{\n\t// Local lib in script's directory.\n\tInitFuncLibrary(aLib[0], mFileDir, FUNC_LOCAL_LIB);\n\n\t// User lib in Documents folder.\n\tPWSTR docs_dir = GetDocumentsFolder();\n\tInitFuncLibrary(aLib[1], docs_dir, FUNC_USER_LIB);\n\tCoTaskMemFree(docs_dir);\n\n\t// Std lib in AutoHotkey directory.\n\tInitFuncLibrary(aLib[2], mOurEXEDir, FUNC_STD_LIB);\n}\n\nvoid Script::InitFuncLibrary(FuncLibrary &aLib, LPTSTR aPathBase, LPTSTR aPathSuffix)\n{\n\tTCHAR buf[T_MAX_PATH + 1]; // +1 to ensure truncated paths are filtered out due to being too long for GetFileAttributes(). It would probably have to be intentional due to MAX_PATH limits elsewhere, but this +1 costs nothing.\n\tint length = sntprintf(buf, _countof(buf), _T(\"%s%s\"), aPathBase, aPathSuffix);\n\tDWORD attr = GetFileAttributes(buf); // Seems to accept directories that have a trailing backslash, which is good because it simplifies the code.\n\tif (attr == 0xFFFFFFFF || !(attr & FILE_ATTRIBUTE_DIRECTORY)) // Directory doesn't exist or it's a file vs. directory. Relies on short-circuit boolean order.\n\t{\n\t\taLib.path = _T(\"\");\n\t\treturn;\n\t}\n\t// Allow room for appending each candidate file/function name. This could be exactly\n\t// MAX_PATH on ANSI builds since no path longer than that would work, but doing it this\n\t// way simplifies length checks later (and Unicode builds support much longer paths).\n\tsize_t buf_size = length + MAX_VAR_NAME_LENGTH + FUNC_LIB_EXT_LENGTH + 1;\n\taLib.path = SimpleHeap::Alloc<TCHAR>(buf_size);\n\ttmemcpy(aLib.path, buf, length + 1);\n\taLib.length = length;\n}\n\nLPTSTR Script::FindLibraryFile(LPTSTR aFuncName, size_t aFuncNameLength, bool aIsModule)\n// If aFuncNameLength is 0, the entire length of aFuncName is used.\n// Returns the path; valid only until the next call to this function.\n{\n\tint i;\n\tDWORD attr;\n\n\tstatic FuncLibrary sLib[FUNC_LIB_COUNT] = {0};\n\n\tif (!sLib[0].path) // Allocate & discover paths only upon first use because many scripts won't use anything from the library. This saves a bit of memory and performance.\n\t\tInitFuncLibraries(sLib);\n\t// Above must ensure that all sLib[].path elements are non-NULL (but they can be \"\" to indicate \"no library\").\n\n\tif (!aFuncNameLength) // Caller didn't specify, so use the entire string.\n\t\taFuncNameLength = _tcslen(aFuncName);\n\tif (aFuncNameLength > MAX_VAR_NAME_LENGTH) // Too long to fit in the allowed space, and also too long to be a valid function name.\n\t\treturn nullptr;\n\n\tTCHAR *dest;\n\tLPTSTR naked_filename = aFuncName; // Set up for the first iteration.\n\tsize_t naked_filename_length = aFuncNameLength; //\n\n\t\tfor (i = 0; i < FUNC_LIB_COUNT; ++i)\n\t\t{\n\t\t\tif (!*sLib[i].path) // Library is marked disabled, so skip it.\n\t\t\t\tcontinue;\n\n\t\t\tdest = (LPTSTR) tmemcpy(sLib[i].path + sLib[i].length, naked_filename, naked_filename_length); // Append the filename to the library path.\n\t\t\t_tcscpy(dest + naked_filename_length, FUNC_LIB_EXT); // Append the file extension.\n\n\t\t\tattr = GetFileAttributes(sLib[i].path); // Testing confirms that GetFileAttributes() doesn't support wildcards; which is good because we want filenames containing question marks to be \"not found\" rather than being treated as a match-pattern.\n\t\t\tif (attr == 0xFFFFFFFF || (attr & FILE_ATTRIBUTE_DIRECTORY)) // File doesn't exist or it's a directory.\n\t\t\t\tcontinue;\n\n\t\t\t// Since above didn't \"continue\", a file exists whose name matches that of the requested library.\n\t\t\treturn sLib[i].path; // Only valid until the next call to this function.\n\t\t} // for() each library directory.\n\n\tif (aIsModule)\n\t\treturn nullptr;\n\n\t// The legacy behaviour for #Include <A_B> is that all Libs are searched for A_B.ahk before\n\t// searching for A.ahk, which means that A_B.ahk takes precedence over A.ahk even if A.ahk\n\t// is defined in the local Lib and A_B.ahk is not.\n\tif (auto first_underscore = _tcschr(aFuncName, '_'))\n\t\treturn FindLibraryFile(aFuncName, first_underscore - aFuncName);\n\treturn nullptr;\n}\n\n#endif\n\n\n\ntemplate<typename T, int S>\nT *ScriptItemList<T, S>::Find(LPCTSTR aName, int *apInsertPos)\n{\n\t// Using a binary searchable array vs a linked list speeds up dynamic function calls, on average.\n\tint left, right, mid, result;\n\tfor (left = 0, right = mCount - 1; left <= right;)\n\t{\n\t\tmid = (left + right) / 2;\n\t\tresult = _tcsicmp(aName, mItem[mid]->mName); // lstrcmpi() is not used: 1) avoids breaking existing scripts; 2) provides consistent behavior across multiple locales; 3) performance.\n\t\tif (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse if (result < 0)\n\t\t\tright = mid - 1;\n\t\telse // Match found.\n\t\t{\n\t\t\tif (apInsertPos)\n\t\t\t\t*apInsertPos = mid;\n\t\t\treturn mItem[mid];\n\t\t}\n\t}\n\tif (apInsertPos)\n\t\t*apInsertPos = left;\n\treturn NULL;\n}\n\n\n\ntemplate<typename T, int S>\nT *ScriptItemList<T, S>::Find(LPCTSTR aName, size_t aNameLength, int *apInsertPos)\n{\n\tif (!aName[aNameLength])\n\t\treturn Find(aName, apInsertPos);\n\n\t// For the below, no error is reported because callers don't want that. Instead, simply return\n\t// nullptr to indicate that names that are illegal or too long are not found. When the caller\n\t// later tries to add the item, it will get an error then:\n\tif (aNameLength > MAX_VAR_NAME_LENGTH)\n\t\treturn nullptr;\n\n\t// The following copy is made because it allows the search to use _tcsicmp() instead of _tcsnicmp(),\n\t// which improves performance. The copy includes only the first aNameLength characters from aName:\n\tTCHAR name[MAX_VAR_NAME_LENGTH + 1];\n\ttcslcpy(name, aName, aNameLength + 1); // +1 to convert length to size.\n\n\treturn Find(name, apInsertPos);\n}\n\n\n\nIObject *Script::GetBuiltinObject(LPCTSTR aName)\n{\n\tauto var = FindOrAddBuiltInVar(aName, true, nullptr);\n\treturn var ? var->ToObject() : nullptr;\n}\n\n\n\nBuiltInFunc::BuiltInFunc(FuncEntry &bif) : BuiltInFunc(bif.mName)\n{\n\tmBIF = bif.mBIF;\n\tmMinParams = bif.mMinParams;\n\tmIsVariadic = bif.mMaxParams == MAX_FUNCTION_PARAMS;\n\tmParamCount = mIsVariadic ? bif.mMinParams : bif.mMaxParams;\n\tmFID = (BuiltInFunctionID)bif.mID;\n\tmOutputVars = bif.mOutputVars;\n}\n\n\n\nFunc *Script::GetBuiltInFunc(LPCTSTR aFuncName)\n{\n\tint left, right, mid, result;\n\tfor (left = 0, right = _countof(g_BIF) - 1; left <= right;)\n\t{\n\t\tmid = (left + right) / 2;\n\t\tresult = _tcsicmp(aFuncName, g_BIF[mid].mName);\n\t\tif (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse if (result < 0)\n\t\t\tright = mid - 1;\n\t\telse // Match found.\n\t\t\treturn new BuiltInFunc(g_BIF[mid]);\n\t}\n\treturn GetBuiltInMdFunc(aFuncName);\n}\n\n\n\nUserFunc *Script::AddFunc(LPCTSTR aFuncName, size_t aFuncNameLength, FuncDefType aIsInExpression, Object *aClassObject)\n// Returns the address of the new function or NULL on failure.\n// The caller must already have verified that this isn't a duplicate function.\n{\n\tbool is_static = !_tcsnicmp(aFuncName, _T(\"Static\"), 6) && IS_SPACE_OR_TAB(aFuncName[6]); // Valid only for nested functions (for methods, it is handled by caller).\n\tbool is_export = !_tcsnicmp(aFuncName, _T(\"Export\"), 6) && IS_SPACE_OR_TAB(aFuncName[6]); // Valid only for global functions (for methods, it already errored out).\n\tbool is_default_export = false;\n\tif (is_static || is_export)\n\t{\n\t\tif (is_static == !g->CurrentFunc)\n\t\t{\n\t\t\tScriptError(ERR_INVALID_FUNCDECL, aFuncName); // Uses a generic message to minimize code size.\n\t\t\treturn nullptr;\n\t\t}\n\t\tsize_t n;\n\t\tfor (n = 7; IS_SPACE_OR_TAB(aFuncName[n]); ++n);\n\t\tif (is_default_export = is_export && !_tcsnicmp(aFuncName + n, _T(\"Default\"), 7) && IS_SPACE_OR_TAB(aFuncName[n + 7]))\n\t\t{\n\t\t\tif (mCurrentModule->mSelf)\n\t\t\t{\n\t\t\t\tScriptError(ERR_DUPLICATE_DECLARATION, aFuncName);\n\t\t\t\treturn nullptr;\n\t\t\t}\n\t\t\tis_export = false; // For \"export default internalname() =>\", don't export internalname.\n\t\t\tfor (n += 8; IS_SPACE_OR_TAB(aFuncName[n]); ++n);\n\t\t}\n\t\tif (aFuncNameLength >= n) // Checked for maintainability; should always be true.\n\t\t{\n\t\t\taFuncNameLength -= n;\n\t\t\taFuncName += n;\n\t\t}\n\t\t//else (shouldn't happen): it will fail to validate below.\n\t}\n\n\tif (aFuncNameLength == -1) // Caller didn't specify, so use the entire string.\n\t\taFuncNameLength = _tcslen(aFuncName);\n\n\tif (aFuncNameLength > MAX_VAR_NAME_LENGTH) // Various parts of the code rely on this limit being enforced.\n\t{\n\t\tScriptError(_T(\"Function name too long.\"), aFuncName);\n\t\treturn nullptr;\n\t}\n\n\t// ValidateName requires that the name be null-terminated, but it isn't in this case.\n\t// Doing this first saves doing tcslcpy() into a temporary buffer, and won't leak memory\n\t// since the script currently always exits if an error occurs anywhere below:\n\tLPTSTR new_name = SimpleHeap::Alloc(aFuncName, aFuncNameLength);\n\n\t// new_name can legitimately be blank for some callers, or something like <Hotkey>.\n\t// Invalid chars are excluded by preventing recognition as a function definition,\n\t// but names beginning with numbers can reach this point.\n\tif (!aClassObject && *new_name && *new_name != '<' && !Var::ValidateName(new_name, DISPLAY_FUNC_ERROR)) // Variable and function names are both validated the same way.\n\t\treturn nullptr; // Above already displayed the error for us.\n\n\tauto the_new_func = new UserFunc(new_name);\n\n\tthe_new_func->mModule = mCurrentModule;\n\tthe_new_func->mIsFuncExpression = aIsInExpression;\n\n\tif (aClassObject)\n\t{\n\t\tLPTSTR key = _tcsrchr(new_name, '.'); // DefineFunc() always passes \"ClassName.MethodName\".\n\t\t++key;\n\t\tif (!Var::ValidateName(key, DISPLAY_METHOD_ERROR))\n\t\t\treturn nullptr;\n\t\tif (mClassProperty)\n\t\t{\n\t\t\tbool is_getter = ctoupper(*key) == 'G';\n\t\t\tif (is_getter ? mClassProperty->Getter() : mClassProperty->Setter())\n\t\t\t{\n\t\t\t\tScriptError(ERR_DUPLICATE_DECLARATION, new_name);\n\t\t\t\treturn nullptr;\n\t\t\t}\n\t\t\tif (is_getter)\n\t\t\t\tmClassProperty->SetGetter(the_new_func);\n\t\t\telse\n\t\t\t\tmClassProperty->SetSetter(the_new_func);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tswitch (aClassObject->GetOwnPropType(key))\n\t\t\t{\n\t\t\tcase Object::PropType::Object:\n\t\t\tcase Object::PropType::DynamicMethod: // call\n\t\t\tcase Object::PropType::DynamicMixed: // get/set and call\n\t\t\t\tScriptError(ERR_DUPLICATE_DECLARATION, new_name);\n\t\t\t\treturn nullptr;\n\t\t\t}\n\t\t\tif (!aClassObject->DefineMethod(key, the_new_func))\n\t\t\t{\n\t\t\t\tScriptError(ERR_OUTOFMEM);\n\t\t\t\treturn nullptr;\n\t\t\t}\n\t\t}\n\t\taClassObject->AddRef(); // In case the script clears the class var.\n\t\tthe_new_func->mClass = aClassObject;\n\t\t// Also add it to the script's list of functions, to support #Warn LocalSameAsGlobal\n\t\t// and automatic cleanup of objects in static vars on program exit.\n\t}\n\telse if (*new_name != '<' // i.e. not <Hotkey>\n\t\t&& aIsInExpression != FuncDefExpression) // Defer the following for these.\n\t{\n\t\tif (is_static)\n\t\t\tthe_new_func->mIsStatic = true;\n\t\tauto var = AddFuncVar(the_new_func);\n\t\tif (!var)\n\t\t\treturn nullptr;\n\t\tif (is_export)\n\t\t\tvar->Scope() |= VAR_EXPORTED;\n\t\tif (is_default_export)\n\t\t\tmCurrentModule->mSelf = var;\n\t}\n\n\treturn AddFuncToList(the_new_func);\n}\n\n\n\nVar *Script::AddFuncVar(UserFunc *aFunc)\n{\n\tResultType result = OK;\n\tVarList *varlist;\n\tint insert_pos;\n\tint scope = (g->CurrentFunc ? VAR_DECLARE_LOCAL : VAR_DECLARE_GLOBAL);\n\tif (aFunc->mIsStatic)\n\t\tscope |= VAR_LOCAL_STATIC;\n\tsize_t name_length = _tcslen(aFunc->mName);\n\tVar *var = name_length ? FindVar(aFunc->mName, name_length, scope, &varlist, &insert_pos, &result) : NULL;\n\tif (var && var->IsDeclared())\n\t{\n\t\t// Anything found at this early stage must have been created by a prior declaration\n\t\t// or predefined. Treat it as an error even if var is uninitialized, otherwise:\n\t\t// 1) \"static x\" or \"global x\" prior to the function would affect its scope/duration\n\t\t// in a way that is problematic for closures and probably unintentional.\n\t\t// 2) It would be possible to declare the function as local/global prior to defining\n\t\t// it, but not afterward (as the conflict would be detected by ParseAndAddLine).\n\t\tConflictingDeclarationError(_T(\"function\"), var);\n\t\treturn nullptr;\n\t}\n\tif (!var)\n\t{\n\t\tif (!name_length)\n\t\t{\n\t\t\tinsert_pos = 0;\n\t\t\tvarlist = g->CurrentFunc ? &g->CurrentFunc->mVars : GlobalVars();\n\t\t}\n\t\tvar = AddVar(aFunc->mName, name_length, varlist, insert_pos, scope | ADDVAR_NO_VALIDATE); // Already validated, or invalid in the case of anonymous functions.\n\t\tif (!var)\n\t\t\treturn nullptr;\n\t}\n\tASSERT(var->IsUninitialized());\n\tvar->Assign(aFunc);\n\tvar->MakeReadOnly();\n\treturn var;\n}\n\n\n\t\nUserFunc *Script::AddFuncToList(UserFunc *aFunc)\n{\n\taFunc->mOuterFunc = g->CurrentFunc;\n\t\n\t// Function definition expressions are parsed before the expression which \"contains\" them,\n\t// which puts the FDE before its outer function in mFuncs, in cases like `outer() => FDE(){`.\n\t// To correct that, insert new non-FDE functions before the first unresolved FDE.\n\tint &index = mExprContainingThisFunc ? mExprContainingThisFunc->funcs_index : mExprFuncIndex;\n\tint new_index = mFuncs.mCount;\n\tif (index == INT_MAX && aFunc->mIsFuncExpression == FuncDefExpression)\n\t\tindex = new_index;\n\tif (aFunc->mIsFuncExpression != FuncDefExpression && index <= new_index) // <= vs < keeps it pointing beyond the end when there aren't any FDEs.\n\t{\n\t\t// index might not point to an FDE if functions were defined within a previous FDE,\n\t\t// or if a previous FDE was resolved prior to this definition. This might not be\n\t\t// necessary, but keeps mFuncs in a sensible order:\n\t\tfor (; index < mFuncs.mCount && mFuncs.mItem[index]->mIsFuncExpression != FuncDefExpression; ++index);\n\t\tnew_index = index++; // Insert here and increment index so it still points to the same item.\n\t}\n\n\tif (!mFuncs.Insert(aFunc, new_index))\n\t{\n\t\tScriptError(ERR_OUTOFMEM);\n\t\treturn nullptr;\n\t}\n\n\treturn aFunc;\n}\n\n\n\ntemplate<typename T, int INITIAL_SIZE>\nResultType ScriptItemList<T, INITIAL_SIZE>::Insert(T *aFunc, int aInsertPos)\n{\n\tif (mCount == mCountMax)\n\t{\n\t\t// Allocate or expand function list.\n\t\tif (!Alloc(mCountMax ? mCountMax * 2 : INITIAL_SIZE))\n\t\t\treturn FAIL;\n\t}\n\n\tif (aInsertPos != mCount) // Need to make room at the indicated position for this variable.\n\t\tmemmove(mItem + aInsertPos + 1, mItem + aInsertPos, (mCount - aInsertPos) * sizeof(Func *));\n\t//else both are zero or the item is being inserted at the end of the list, so it's easy.\n\tmItem[aInsertPos] = aFunc;\n\t++mCount;\n\treturn OK;\n}\n\n\n\ntemplate<typename T, int S>\nResultType ScriptItemList<T,S>::Alloc(int aAllocCount)\n{\n\tT **temp = (T **)realloc(mItem, aAllocCount * sizeof(T *)); // If passed NULL, realloc() will do a malloc().\n\tif (!temp)\n\t\treturn FAIL;\n\tmItem = temp;\n\tmCountMax = aAllocCount;\n\treturn OK;\n}\n\n\n\n// Explicit instantiation needed for other compilation units.\ntemplate struct ScriptItemList<ScriptModule, 16>;\n\n\n\nsize_t Line::ArgIndexLength(int aArgIndex)\n// This function is similar to ArgToInt(), so maintain them together.\n// \"ArgLength\" is the arg's fully resolved, dereferenced length during runtime.\n// Callers must call this only at times when sArgDeref and sArgVar are defined/meaningful.\n// Caller must ensure that aArgIndex is 0 or greater.\n// ArgLength() was added in v1.0.44.14 to help its callers improve performance by avoiding\n// costly calls to _tcslen() (which is especially beneficial for huge strings).\n{\n#ifdef _DEBUG\n\tif (aArgIndex < 0)\n\t{\n\t\tLineError(_T(\"DEBUG: BAD\"), WARN);\n\t\taArgIndex = 0; // But let it continue.\n\t}\n#endif\n\tif (aArgIndex >= mArgc) // Arg doesn't exist, so don't try accessing sArgVar (unlike sArgDeref, it wouldn't be valid to do so).\n\t\treturn 0; // i.e. treat it as the empty string.\n\tif (!mArg[aArgIndex].is_expression && mArg[aArgIndex].postfix)\n\t{\n\t\t// This is a simple constant value or variable reference.\n\t\tswitch (mArg[aArgIndex].postfix->symbol)\n\t\t{\n\t\tcase SYM_STRING:\n\t\t\treturn mArg[aArgIndex].postfix->marker_length;\n\t\tcase SYM_VAR:\n\t\t\treturn mArg[aArgIndex].postfix->var->Length();\n\t\t}\n\t}\n\t// Otherwise, length isn't known, so do it the slow way.\n\treturn _tcslen(sArgDeref[aArgIndex]);\n}\n\n\n\n__int64 Line::ArgIndexToInt64(int aArgIndex)\n// This function is similar to ArgIndexLength(), so maintain them together.\n// Callers must call this only at times when sArgDeref and sArgVar are defined/meaningful.\n// Caller must ensure that aArgIndex is 0 or greater.\n{\n#ifdef _DEBUG\n\tif (aArgIndex < 0)\n\t{\n\t\tLineError(_T(\"DEBUG: BAD\"), WARN);\n\t\taArgIndex = 0; // But let it continue.\n\t}\n#endif\n\tif (aArgIndex >= mArgc) // See ArgIndexLength() for comments.\n\t\treturn 0; // i.e. treat it as ATOI64(\"\").\n\tif (!mArg[aArgIndex].is_expression && mArg[aArgIndex].postfix)\n\t\treturn TokenToInt64(*mArg[aArgIndex].postfix);\n\t// Otherwise:\n\treturn ATOI64(sArgDeref[aArgIndex]);\n}\n\n\nVar *Script::FindOrAddVar(LPCTSTR aVarName, size_t aVarNameLength, int aScope)\n// Caller has ensured that aVarName isn't NULL.\n// Returns the Var whose name matches aVarName. If it doesn't exist, it is created.\n{\n\tif (!*aVarName)\n\t\treturn NULL;\n\tif (!aVarNameLength) // Caller didn't specify, so use the entire string.\n\t\taVarNameLength = _tcslen(aVarName);\n\tResultType result = OK; // Must set default.\n\tVarList *varlist;\n\tint insert_pos;\n\tVar *var;\n\tif (var = FindVar(aVarName, aVarNameLength, aScope, &varlist, &insert_pos, &result))\n\t\treturn var;\n\tif (!result) // An error was displayed.\n\t\treturn nullptr;\n\t// Otherwise, no match found, so create a new var.\n\tbool is_local = varlist != GlobalVars();\n\t// This will return NULL if there was a problem, in which case AddVar() will already have displayed the error:\n\treturn AddVar(aVarName, aVarNameLength, varlist, insert_pos\n\t\t, (aScope & ~(VAR_LOCAL | VAR_GLOBAL)) | (is_local ? VAR_LOCAL : VAR_GLOBAL)); // When aScope == FINDVAR_DEFAULT, it contains both the \"local\" and \"global\" bits. This ensures only the appropriate bit is set.\n}\n\n\n\nVar *Script::FindVar(LPCTSTR aVarName, size_t aVarNameLength, int aScope\n\t, VarList **apList, int *apInsertPos, ResultType *aDisplayError)\n// Caller has ensured that aVarName isn't NULL. It must also ignore the contents of apInsertPos when\n// a match (non-NULL value) is returned.\n// Returns the Var whose name matches aVarName. If it doesn't exist, NULL is returned.\n// If caller provided a non-NULL apInsertPos, it will be given the array index that a newly\n// inserted item should have to keep the list in sorted order (which also allows the ListVars command\n// to display the variables in alphabetical order).\n{\n\tif (!*aVarName)\n\t\treturn NULL;\n\tif (!aVarNameLength) // Caller didn't specify, so use the entire string.\n\t\taVarNameLength = _tcslen(aVarName);\n\n\t// For the below, no error is reported because callers don't want that. Instead, simply return\n\t// NULL to indicate that names that are illegal or too long are not found. When the caller later\n\t// tries to add the variable, it will get an error then:\n\tif (aVarNameLength > MAX_VAR_NAME_LENGTH)\n\t\treturn NULL;\n\n\t// The following copy is made because it allows the various searches below to use _tcsicmp() instead of\n\t// strlicmp(), which close to doubles their performance. The copy includes only the first aVarNameLength\n\t// characters from aVarName:\n\tTCHAR var_name[MAX_VAR_NAME_LENGTH + 1];\n\ttcslcpy(var_name, aVarName, aVarNameLength + 1); // +1 to convert length to size.\n\n\tglobal_struct &g = *::g; // Reduces code size and may improve performance.\n\tbool search_local = (aScope & VAR_LOCAL) && g.CurrentFunc;\n\t// Above has ensured that g.CurrentFunc!=NULL whenever search_local==true.\n\n\tif (search_local)\n\t{\n\t\tauto &func = *g.CurrentFunc;\n\t\tint nonstatic_pos, static_pos;\n\t\tif (Var *found = func.mVars.Find(var_name, &nonstatic_pos)) return found;\n\t\tif (Var *found = func.mStaticVars.Find(var_name, &static_pos)) return found;\n\t\tbool add_static = (aScope & VAR_LOCAL_STATIC)\n\t\t\t|| !(aScope & VAR_DECLARED) && (func.mDefaultVarType & VAR_LOCAL_STATIC);\n\t\tif (apList) *apList = add_static ? &func.mStaticVars : &func.mVars;\n\t\tif (apInsertPos) *apInsertPos = add_static ? static_pos : nonstatic_pos;\n\t}\n\telse\n\t{\n\t\tauto varlist = GlobalVars();\n\t\tint insert_pos;\n\t\tif (Var *found = varlist->Find(var_name, &insert_pos)) return found;\n\t\tif (apList) *apList = varlist;\n\t\tif (apInsertPos) *apInsertPos = insert_pos;\n\n\t\tif (aScope & FINDVAR_GLOBAL_FALLBACK) // Declarations shadow imported names.\n\t\t\tif (Var *found = FindImportedVar(var_name))\n\t\t\t\treturn found;\n\t}\n\n\t// Since no match was found, if this is a local fall back to searching outer functions and the\n\t// list of globals if the caller didn't insist on a particular type:\n\tif (search_local && (aScope & VAR_GLOBAL))\n\t{\n\t\t// Search outer functions, if applicable:\n\t\tif (g.CurrentFunc->mOuterFunc)\n\t\t\tif (Var *found = FindUpVar(var_name, aVarNameLength, *g.CurrentFunc, aDisplayError))\n\t\t\t\treturn found;\n\t\t// No local var was found, nor was a global declared in this function (otherwise it would\n\t\t// have been found in g.CurrentFunc->mStaticVars), so caller wants to fall back to a global\n\t\t// in this case only if the function is assume-global or FINDVAR_GLOBAL_FALLBACK was used.\n\t\t// However, they want the insertion (if our caller will be doing one) to insert according to\n\t\t// the current assume-mode. Therefore, if the mode is assume-global, pass apList/apInsertPos\n\t\t// to FindVar() so that it will update them to be global.\n\t\tif (g.CurrentFunc->IsAssumeGlobal())\n\t\t\treturn FindVar(aVarName, aVarNameLength, FINDVAR_GLOBAL, apList, apInsertPos);\n\t\tif (aScope & FINDVAR_GLOBAL_FALLBACK)\n\t\t\tif (Var *found = FindGlobalVar(aVarName, aVarNameLength))\n\t\t\t\treturn found;\n\t}\n\t// Otherwise, since above didn't return:\n\treturn FindOrAddBuiltInVar(var_name, aScope & FINDVAR_GLOBAL_FALLBACK, aDisplayError);\n}\n\n\n\nVar *Script::FindUpVar(LPCTSTR aVarName, size_t aVarNameLength, UserFunc &aInner, ResultType *aDisplayError)\n{\n\t// Do not search outer if inner is *explicitly* assume-global, since in that case a\n\t// global var should be returned in preference to anything defined by outer.\n\tif (aInner.mDefaultVarType == VAR_DECLARE_GLOBAL)\n\t\treturn nullptr;\n\tauto &outer = *aInner.mOuterFunc;\n\tVar *outer_var;\n\tif ( (outer_var = outer.mStaticVars.Find(aVarName)) || aInner.mIsStatic )\n\t\treturn outer_var; // Can be nullptr if aInner.mIsStatic.\n\tif ( !(outer_var = outer.mVars.Find(aVarName)) )\n\t{\n\t\tif ( !(outer.mOuterFunc && (outer_var = FindUpVar(aVarName, aVarNameLength, outer, aDisplayError))) )\n\t\t\treturn nullptr;\n\t\t// Static or declared-global variables of outer would return above by virtue of being\n\t\t// in mStaticVars, but variables pulled in from further out must still be checked:\n\t\tif (!outer_var->IsNonStaticLocal())\n\t\t\treturn outer_var;\n\t}\n\t// At this point, all var refs used in declarations, assignments or &var in the outer\n\t// function should have already been parsed, while it's possible that some read-refs\n\t// have not. Ignore all variables that lack an assignment, &var or declaration.\n\t// - Avoids an issue where only read-refs ABOVE the nested function are accessible\n\t// (which could also be fixed by changing PreparseVarRefs to parse one function\n\t// at a time, parsing outer in its entirety before inner).\n\t// - Avoids inconsistency between read-refs and write-refs: when the outer var is created\n\t// by a read-ref, closures which only read would capture it, while closures which write\n\t// would create their own local.\n\t// - Avoids having behaviour depend on whether a global exists: when outer and inner both\n\t// only use read-refs (but maybe assign dynamically), whether the nested function becomes\n\t// a closure might depend on whether the var is global or local to outer.\n\t// - Having a non-dynamic assignment (and no global declaration) makes it easier to see\n\t// that the var is local by looking at just the outer function, and avoids warnings.\n\t// - A clear rule is easier to remember.\n\tif ( !(outer_var->IsAssignedSomewhere() || outer_var->IsDeclared()) )\n\t\treturn nullptr;\n\t// Since this local variable is not static, things need to be set up so that the inner\n\t// function will capture it as an upvar at the appropriate time.\n\tif (mIsReadyToExecute)\n\t{\n\t\t// This dynamic reference resolved to a variable that hasn't been captured by the\n\t\t// current function, so is not safe to return.\n\t\tif (aDisplayError)\n\t\t\t*aDisplayError = RuntimeError(ERR_DYNAMIC_UPVAR, aVarName);\n\t\treturn nullptr;\n\t}\n\tASSERT(!outer.mDownVar && !aInner.mUpVar); // PreprocessLocalVars has not yet been called.\n\tif (!(outer_var->Scope() & VAR_DOWNVAR))\n\t{\n\t\touter.mDownVarCount++;\n\t\touter_var->Scope() |= VAR_DOWNVAR;\n\t}\n\t// At this point aInner doesn't have a variable by this name, so create one:\n\tint insert_pos;\n\taInner.mVars.Find(aVarName, &insert_pos);\n\tVar *inner_var = AddVar(aVarName, aVarNameLength, &aInner.mVars, insert_pos, VAR_LOCAL | VAR_DECLARED | ADDVAR_NO_VALIDATE); // VAR_DECLARED suppresses checking for a global for #Warn LocalSameAsGlobal or when #Warn UseUnset is triggered.\n\tif (!inner_var)\n\t{\n\t\tif (aDisplayError)\n\t\t\t*aDisplayError = FAIL; // Error already displayed.\n\t\treturn nullptr;\n\t}\n\tASSERT(outer_var->Type() != VAR_CONSTANT || outer_var->HasObject() && dynamic_cast<UserFunc*>(outer_var->Object()));\n\tbool indefinite = outer_var->Type() == VAR_CONSTANT && !((UserFunc *)outer_var->Object())->mUpVarCount;\n\tif (!indefinite && ++aInner.mUpVarCount == 1) // This function's first definite upvar.\n\t{\n\t\t// Count all references to aInner as upvars (except the one in outer).\n\t\tCountNestedFuncRefs(outer, aInner.mName);\n\t}\n\tinner_var->SetAliasDirect(outer_var); // Temporarily point the upvar to its downvar for later processing.\n\tinner_var->MarkAssignedSomewhere(); // Upvars are not candidates for #Warn VarUnset.\n\treturn inner_var;\n}\n\n\n\nvoid Script::CountNestedFuncRefs(UserFunc &aWithin, LPCTSTR aFuncName)\n{\n\tfor (int i = 0; i < aWithin.mVars.mCount; ++i) // There's no list of nested functions, so we look for them within mVars.\n\t{\n\t\tVar &nfv = *aWithin.mVars.mItem[i];\n\t\tif (nfv.Type() == VAR_CONSTANT && !nfv.IsAlias()) // nfv is a reference to a function defined within aWithin (an alias would be a reference to something from outside).\n\t\t{\n\t\t\tASSERT(nfv.HasObject() && dynamic_cast<UserFunc*>(nfv.Object()));\n\t\t\tauto &nf = *(UserFunc *)nfv.Object();\n\t\t\tVar *uv = nf.mVars.Find(aFuncName);\n\t\t\tif (uv && uv->IsAlias()) // nf refers to the outer aFuncName (if not an alias, it would be a nested function with the same name).\n\t\t\t{\n\t\t\t\tnf.mUpVarCount++; // Count uv as an upvar, as caller has determined aFuncName is now a closure.\n\t\t\t\tif (nf.mUpVarCount == 1) // nf's first definite upvar, so nf is also now known to be a closure.\n\t\t\t\t\tCountNestedFuncRefs(*nf.mOuterFunc, nf.mName); // Count all references to nf as upvars (except the one in nf.mOuterFunc).\n\t\t\t\tif (uv->Scope() & VAR_DOWNVAR) // uv is also referenced by functions nested within nf,\n\t\t\t\t\tCountNestedFuncRefs(nf, aFuncName); // so recurse.\n\t\t\t}\n\t\t}\n\t}\n}\n\n\n\nVar *Script::AddVar(LPCTSTR aVarName, size_t aVarNameLength, VarList *aList, int aInsertPos, int aScope)\n// Returns the address of the new variable or NULL on failure.\n// Caller must ensure that aVarName isn't NULL and that this isn't a duplicate variable name.\n// In addition, it has provided aInsertPos, which is the insertion point so that the list stays sorted.\n{\n\tif (aVarNameLength > MAX_VAR_NAME_LENGTH)\n\t{\n\t\tScriptError(_T(\"Variable name too long.\"), aVarName);\n\t\treturn NULL;\n\t}\n\n\t// Make a temporary copy that includes only the first aVarNameLength characters from aVarName:\n\tTCHAR var_name[MAX_VAR_NAME_LENGTH + 1];\n\ttcslcpy(var_name, aVarName, aVarNameLength + 1); // See explanation above. +1 to convert length to size.\n\n\tif (aScope & ADDVAR_NO_VALIDATE)\n\t\taScope &= ~ADDVAR_NO_VALIDATE;\n\telse if (*var_name && !Var::ValidateName(var_name))\n\t\t// Above already displayed error for us.\n\t\treturn NULL;\n\n\tif ((aScope & (VAR_LOCAL | VAR_DECLARED)) == VAR_LOCAL // This is an implicit local.\n\t\t&& g->CurrentFunc->mModule->Warn_LocalSameAsGlobal && !mIsReadyToExecute // This warning isn't desired at runtime (v2: might only be called at runtime by the debugger?).\n\t\t&& FindGlobalVar(var_name, aVarNameLength))\n\t\tWarnLocalSameAsGlobal(var_name);\n\n\t// Allocate some dynamic memory to pass to the constructor:\n\tLPTSTR new_name = SimpleHeap::Malloc(var_name, aVarNameLength);\n\tif (!new_name)\n\t\t// It already displayed the error for us.\n\t\treturn NULL;\n\n\t// Below specifically tests for VAR_LOCAL and excludes other non-zero values/flags:\n\t// VAR_LOCAL_FUNCPARAM should not be made static.\n\t// VAR_LOCAL_STATIC is already static.\n\t// VAR_DECLARED indicates mDefaultVarType is irrelevant.\n\tif (aScope == VAR_LOCAL && (g->CurrentFunc->mDefaultVarType & VAR_LOCAL_STATIC))\n\t\t// v1.0.48: Lexikos: Current function is assume-static, so set static attribute.\n\t\taScope |= VAR_LOCAL_STATIC;\n\n\tVar *the_new_var = new Var(new_name, aScope);\n\tif (!the_new_var || !aList->Insert(the_new_var, aInsertPos))\n\t{\n\t\tMemoryError();\n\t\treturn NULL;\n\t}\n\n\tif (aScope & VAR_LOCAL_FUNCPARAM)\n\t\tthe_new_var->MarkAssignedSomewhere();\n\n\treturn the_new_var;\n}\n\n\n\nVar *Script::FindOrAddBuiltInVar(LPCTSTR aVarName, bool aAllowNonVirtual, ResultType *aDisplayError)\n{\n\t// mBuiltinModule currently isn't handled via mCurrentModule->mImports because we would\n\t// still need to call Find() to get insert_pos if a BIV must be added, and then there's\n\t// the question of what to do if a non-null value is returned even though the caller\n\t// should have found it via mImports and thereby prevented this call.\n\tint insert_pos;\n\tVar *var = mBuiltinModule.mVars.Find(aVarName, &insert_pos);\n\tif (var)\n\t\treturn (aAllowNonVirtual || var->Type() == VAR_VIRTUAL) ? var : nullptr;\n\n\tFunc *func = nullptr;\n\tif (auto biv = GetBuiltInVar(aVarName))\n\t{\n\t\tif (auto name = SimpleHeap::Malloc(aVarName))\n\t\t\tvar = new Var(name, biv, VAR_DECLARE_GLOBAL | VAR_EXPORTED);\n\t}\n\telse if (aAllowNonVirtual && (func = GetBuiltInFunc(aVarName)))\n\t{\n\t\tvar = new Var(const_cast<LPTSTR>(func->mName), VAR_DECLARE_GLOBAL | VAR_EXPORTED);\n\t}\n\telse\n\t\treturn nullptr;\n\n\tif (!var || !mBuiltinModule.mVars.Insert(var, insert_pos))\n\t{\n\t\tif (func)\n\t\t\tfunc->Release();\n\t\tif (aDisplayError)\n\t\t\t*aDisplayError = MemoryError();\n\t\treturn nullptr;\n\t}\n\tif (func)\n\t{\n\t\tvar->AssignSkipAddRef(func);\n\t\tvar->MakeReadOnly();\n\t}\n\treturn var;\n}\n\n\n\nVarEntry *Script::GetBuiltInVar(LPCTSTR aVarName)\n{\n\t// This array approach saves about 9KB on code size over the old approach\n\t// of a series of if's and _tcscmp calls, and performs about the same.\n\t// The \"A_\" prefix is omitted from each name string to reduce code size.\n\tif ((aVarName[0] == 'A' || aVarName[0] == 'a') && aVarName[1] == '_')\n\t\taVarName += 2;\n\telse\n\t\treturn nullptr;\n\t// Using binary search vs. linear search performs a bit better (notably for\n\t// rare/contrived cases like A_x%index%) and doesn't affect code size much.\n\tint left, right, mid, result;\n\tfor (left = 0, right = _countof(g_BIV_A) - 1; left <= right;)\n\t{\n\t\tmid = (left + right) / 2;\n\t\tresult = _tcsicmp(aVarName, g_BIV_A[mid].name);\n\t\tif (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse if (result < 0)\n\t\t\tright = mid - 1;\n\t\telse // Match found.\n\t\t\treturn &g_BIV_A[mid];\n\t}\n\t// Since above didn't return:\n\treturn nullptr;\n}\n\n\n\nWinGroup *Script::FindGroup(LPCTSTR aGroupName, bool aCreateIfNotFound)\n// Caller must ensure that aGroupName isn't NULL. But if it's the empty string, NULL is returned.\n// Returns the Group whose name matches aGroupName. If it doesn't exist, it is created if aCreateIfNotFound==true.\n// Thread-safety: This function is thread-safe (except when called with aCreateIfNotFound==true) even when\n// the main thread happens to be calling AddGroup() and changing the linked list while it's being traversed here\n// by the hook thread. However, any subsequent changes to this function or AddGroup() must be carefully reviewed.\n{\n\tif (!*aGroupName)\n\t{\n\t\tif (aCreateIfNotFound)\n\t\t\t// An error message must be shown in this case since our caller is about to\n\t\t\t// exit the current script thread (and we don't want it to happen silently).\n\t\t\tValueError(_T(\"Blank group name.\"), nullptr, FAIL);\n\t\treturn NULL;\n\t}\n\tfor (WinGroup *group = mFirstGroup; group != NULL; group = group->mNextGroup)\n\t\tif (!_tcsicmp(group->mName, aGroupName)) // lstrcmpi() is not used: 1) avoids breaking existing scripts; 2) provides consistent behavior across multiple locales; 3) performance.\n\t\t\treturn group; // Match found.\n\t// Otherwise, no match found, so create a new group.\n\tif (!aCreateIfNotFound || AddGroup(aGroupName) != OK)\n\t\treturn NULL;\n\treturn mLastGroup;\n}\n\n\n\nResultType Script::AddGroup(LPCTSTR aGroupName)\n// Returns OK or FAIL.\n// The caller must already have verified that this isn't a duplicate group.\n// This function is not thread-safe because it adds an entry to the quasi-global list of window groups.\n// In addition, if this function is being called by one thread while another thread is calling FindGroup(),\n// the thread-safety notes in FindGroup() apply.\n{\n\tsize_t aGroupName_length = _tcslen(aGroupName);\n\tif (aGroupName_length > MAX_VAR_NAME_LENGTH)\n\t\treturn ValueError(_T(\"Group name too long.\"), aGroupName, FAIL);\n\tif (!Var::ValidateName(aGroupName, DISPLAY_GROUP_ERROR)) // Seems best to use same validation as var names.\n\t\treturn FAIL;\n\n\tLPTSTR new_name = SimpleHeap::Malloc(aGroupName, aGroupName_length);\n\tif (!new_name)\n\t\treturn FAIL; // It already displayed the error for us.\n\n\t// The precise method by which the follows steps are done should be thread-safe even if\n\t// some other thread calls FindGroup() in the middle of the operation. But any changes\n\t// must be carefully reviewed:\n\tWinGroup *the_new_group = new WinGroup(new_name);\n\tif (mFirstGroup == NULL)\n\t\tmFirstGroup = the_new_group;\n\telse\n\t\tmLastGroup->mNextGroup = the_new_group;\n\t// This must be done after the above:\n\tmLastGroup = the_new_group;\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseExpressions()\n{\n\tfor (mCurrentModule = mLastModule; mCurrentModule; mCurrentModule = mCurrentModule->mPrev)\n\t\tif (!PreparseExpressions(mCurrentModule->mFirstLine))\n\t\t\treturn FAIL;\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseExpressions(Line *aStartingLine)\n{\n\tfor (Line *line = aStartingLine; line; line = line->mNextLine) // For each line.\n\t{\n\t\t// Skip any function bodies.\n\t\twhile (line->mActionType == ACT_BLOCK_BEGIN && line->mAttribute)\n\t\t\tif ( !(line = line->mRelatedLine) )\n\t\t\t\treturn OK;\n\t\tif (line->mActionType == ACT_BLOCK_END && line->mAttribute)\n\t\t\treturn OK; // End of this function.\n\n\t\tmCurrLine = line; // For error reporting in FindVar() and perhaps other places.\n\n\t\tif (line->mActionType == ACT_CATCH)\n\t\t{\n\t\t\t// Preparse Catch's output var at this stage so it has the proper assign-local effect.\n\t\t\t// Don't parse the class names yet since that might parse a given name as global when it\n\t\t\t// should be local due to a subsequent assignment. Delaying it ensures CATCH's classes\n\t\t\t// are always consistent with other references in the function, and ensures that adding\n\t\t\t// local classes in future won't necessitate a change in behaviour.\n\t\t\tif (!PreparseCatchVar(line))\n\t\t\t\treturn FAIL;\n\t\t\tcontinue;\n\t\t}\n\n\t\tfor (int i = 0; i < line->mArgc; ++i) // For each arg.\n\t\t{\n\t\t\tArgStruct &this_arg = line->mArg[i]; // For performance and convenience.\n\t\t\tif (!this_arg.is_expression) // Plain text; i.e. goto/break/continue label.\n\t\t\t\tcontinue;\n\t\t\tASSERT(!this_arg.postfix);\n\t\t\t// Otherwise, convert the expression text to postfix form and set is_expression\n\t\t\t// based on whether the arg should be evaluated by ExpandExpression():\n\t\t\tif (!line->ExpressionToPostfix(this_arg)) // Doing this here, after the script has been loaded, might improve the compactness/adjacent-ness of the compiled expressions in memory, which might improve performance due to CPU caching.\n\t\t\t\treturn FAIL; // The function above already displayed the error msg.\n\t\t}\n\t}\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseExpressions(FuncList &aFuncs)\n{\n\tfor (int i = 0; i < aFuncs.mCount; ++i)\n\t{\n\t\tUserFunc &func = *aFuncs.mItem[i];\n\t\t\n\t\t// Variables that were assignable in the outer function should also be assignable\n\t\t// in the inner function by default; i.e. assume-global mode should be inherited.\n\t\t// This must be done before assignments are parsed, and can't be done when the\n\t\t// function is first added because a function definition expression's initial value\n\t\t// for mOuterFunc can be incorrect (if it's inside a parameter default initializer\n\t\t// or fat arrow function, although the latter can't use a global declaration).\n\t\tif (func.mOuterFunc && func.mOuterFunc->IsAssumeGlobal() && func.mDefaultVarType == VAR_DECLARE_LOCAL)\n\t\t\tfunc.mDefaultVarType = VAR_GLOBAL; // Not VAR_DECLARE_GLOBAL, which would prevent referencing of outer vars.\n\n\t\tg->CurrentFunc = &func;\n\t\tif (!PreparseExpressions(func.mJumpToLine)) // Preparse this function's body.\n\t\t\treturn FAIL;\n\t\t// Now that expressions have been preparsed, remove any parameter default expressions\n\t\t// from the normal flow of execution by adjusting the function's mJumpToLine. (This\n\t\t// wasn't done earlier because the original value is needed above.)\n\t\tif (mLastParamInitializer && func.mMinParams < func.mParamCount)\n\t\t{\n\t\t\tfor (int i = func.mParamCount; --i >= func.mMinParams; )\n\t\t\t{\n\t\t\t\tif (func.mParam[i].default_type == PARAM_DEFAULT_EXPR)\n\t\t\t\t{\n\t\t\t\t\tfunc.mJumpToLine = func.mParam[i].default_expr->mNextLine;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\t// Nested functions will be preparsed next, due to the fact that they immediately\n\t\t// follow the outer function in aFuncs.\n\t}\n\tg->CurrentFunc = nullptr;\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseCommands()\n{\n\tfor (mCurrentModule = mLastModule; mCurrentModule; mCurrentModule = mCurrentModule->mPrev)\n\t\tif (!PreparseCommands(mCurrentModule->mFirstLine))\n\t\t\treturn FAIL;\n\tmCurrentModule = &mDefaultModule; // Reset in case debugger queries properties prior to AutoExecSection().\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseCommands(Line *aStartingLine)\n// Preparse any commands which might rely on blocks having been fully preparsed,\n// such as any command which has a jump target (label).\n// Also perform some late-stage optimizations and validation.\n{\n\tfor (Line *line = aStartingLine; line; line = line->mNextLine)\n\t{\n\t\tLPTSTR line_raw_arg1 = LINE_RAW_ARG1; // Resolve only once to help reduce code size.\n\t\tLPTSTR line_raw_arg2 = LINE_RAW_ARG2; //\n\t\t\n\t\tswitch (line->mActionType)\n\t\t{\n\t\tcase ACT_BLOCK_BEGIN:\n\t\t\tif (line->mAttribute) // This is the opening brace of a function definition.\n\t\t\t\tg->CurrentFunc = (UserFunc *)line->mAttribute; // Must be set only for the above condition because functions can of course contain types of blocks other than the function's own block.\n\t\t\tbreak;\n\t\tcase ACT_BLOCK_END:\n\t\t\tif (line->mAttribute) // This is the closing brace of a function definition.\n\t\t\t{\n\t\t\t\tauto &func = *(UserFunc *)line->mAttribute;\n\n\t\t\t\tg->CurrentFunc = func.mOuterFunc;\n\n\t\t\t\tLine *block_begin = line->mParentLine;\n\t\t\t\tLine *parent = block_begin->mParentLine;\n\n\t\t\t\tif (func.mIsFuncExpression // =>\n\t\t\t\t\t&& block_begin->mParentLine\n\t\t\t\t\t&& block_begin->mParentLine->mActionType != ACT_BLOCK_BEGIN)\n\t\t\t\t{\n\t\t\t\t\tif (line->mNextLine->mActionType == ACT_BLOCK_BEGIN) // It could only be a fat arrow block-begin under these conditions.\n\t\t\t\t\t\t// There's another =>function after this one (defined within the same\n\t\t\t\t\t\t// expression), so just continue until the last =>function is found.\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t// This fat arrow function's parent line is a statement with a single-line\n\t\t\t\t\t// action, but that action is currently separated from its parent by one or\n\t\t\t\t\t// more fat arrow functions. It won't work that way because If/Else/Loop/etc.\n\t\t\t\t\t// all skip an initial ACT_BLOCK_BEGIN (to avoid an extra ExecUntil call),\n\t\t\t\t\t// which would result in executing the function's body instead of skipping it.\n\t\t\t\t\tLine *body = line->mNextLine;\n\t\t\t\t\tblock_begin = parent->mNextLine; // In case there are multiple fat arrow functions on one line.\n\t\t\t\t\tLine *after_body = parent->mRelatedLine;\n\t\t\t\t\tLine *body_end = after_body->mPrevLine; // In case body is multiple lines (such as a nested IF or LOOP).\n\t\t\t\t\t// Swap the statement body and fat arrow functions around to make it work:\n\t\t\t\t\tparent ->mNextLine = body , body ->mPrevLine = parent;\n\t\t\t\t\tbody_end ->mNextLine = block_begin, block_begin->mPrevLine = body_end;\n\t\t\t\t\tline ->mNextLine = after_body , after_body ->mPrevLine = line;\n\t\t\t\t}\n\t\t\t\telse if (parent && parent->mActionType != ACT_BLOCK_BEGIN)\n\t\t\t\t{\n\t\t\t\t\t// This is a normal function definition directly under If/Else/Loop/etc.\n\t\t\t\t\t// It would execute incorrectly as described above, so raise an error.\n\t\t\t\t\treturn block_begin->PreparseError(_T(\"Unexpected function\"));\n\t\t\t\t}\n\t\t\t}\n\t\t\tbreak;\n\t\tcase ACT_BREAK:\n\t\tcase ACT_CONTINUE:\n\t\t\t{\n\t\t\t\tif (line->ArgHasDeref(1))\n\t\t\t\t\t// It seems unlikely that computing the target loop at runtime would be useful.\n\t\t\t\t\t// For simplicity, rule out things like \"break(var)\" and \"break(func())\":\n\t\t\t\t\treturn line->PreparseError(ERR_PARAM1_INVALID); //_T(\"Target label of Break/Continue cannot be dynamic.\"));\n\t\t\t\tLPTSTR loop_name = line_raw_arg1;\n\t\t\t\tLabel *loop_label = nullptr;\n\t\t\t\tLine *loop_line, *innermost_loop = nullptr;\n\t\t\t\tif (*loop_name && !IsNumeric(loop_name))\n\t\t\t\t{\n\t\t\t\t\t// Target is a named loop.\n\t\t\t\t\tif ( !(loop_label = FindLabel(loop_name)) )\n\t\t\t\t\t\treturn line->PreparseError(ERR_NO_LABEL, loop_name);\n\t\t\t\t\t// loop_label->mJumpToLine is used only to identify the line in the loop below.\n\t\t\t\t\t// This approach ensures the loop is a valid target. The previous approach using\n\t\t\t\t\t// innermost_loop->IsJumpValid() failed to detect cases where the target loop is\n\t\t\t\t\t// a valid goto target but doesn't enclose this BREAK/CONTINUE.\n\t\t\t\t}\n\t\t\t\tint n = loop_label ? 0 : *loop_name ? _ttoi(loop_name) : 1;\n\t\t\t\t// For n > 0, find the nth innermost loop which encloses this line.\n\t\t\t\t// Otherwise, determine whether loop_label points to a valid loop.\n\t\t\t\tfor (loop_line = line->mParentLine; loop_line; loop_line = loop_line->mParentLine)\n\t\t\t\t{\n\t\t\t\t\tif (ACT_IS_LOOP(loop_line->mActionType)) // Any type of LOOP, FOR or WHILE.\n\t\t\t\t\t{\n\t\t\t\t\t\tif (!innermost_loop)\n\t\t\t\t\t\t\tinnermost_loop = loop_line;\n\t\t\t\t\t\tif (--n == 0) // == not <=, so \"break 0\" and negative values are detected as invalid.\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tif (loop_label && loop_label->mJumpToLine == loop_line)\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tif (loop_line->mActionType == ACT_BLOCK_BEGIN && loop_line->mAttribute\n\t\t\t\t\t\t|| loop_line->mActionType == ACT_FINALLY)\n\t\t\t\t\t{\n\t\t\t\t\t\tloop_line = nullptr;\n\t\t\t\t\t\tbreak; // Stop the search here since any outer loop would be an invalid target.\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (!innermost_loop)\n\t\t\t\t\treturn line->PreparseError(_T(\"Break/Continue must be enclosed by a Loop.\"));\n\t\t\t\tif (!loop_line)\n\t\t\t\t\treturn line->PreparseError(ERR_PARAM1_INVALID);\n\t\t\t\tif (loop_line != innermost_loop)\n\t\t\t\t{\n\t\t\t\t\tif (line->mActionType == ACT_BREAK)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Find the line to which we'll actually jump when the loop breaks.\n\t\t\t\t\t\tloop_line = loop_line->mRelatedLine; // From LOOP itself to the line after the LOOP's body.\n\t\t\t\t\t\tif (loop_line->mActionType == ACT_UNTIL)\n\t\t\t\t\t\t\tloop_line = loop_line->mNextLine;\n\t\t\t\t\t}\n\t\t\t\t\tline->mRelatedLine = loop_line;\n\t\t\t\t}\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase ACT_GOTO:\n\t\t\t// This must be done here (i.e. *after* all the script lines have been added),\n\t\t\t// so that labels both above and below each Goto can be resolved.\n\t\t\tif (line->ArgHasDeref(1))\n\t\t\t\t// Since the jump-point contains a deref, it must be resolved at runtime:\n\t\t\t\tline->mRelatedLine = NULL;\n \t\t\telse if (!line->GetJumpTarget(false))\n\t\t\t\treturn FAIL; // Error was already displayed by the called function.\n\t\t\tbreak;\n\n\t\tcase ACT_HOTKEY_IF:\n\t\t\tPreparseHotkeyIfExpr(line);\n\t\t\tline->mActionType = ACT_RETURN;\n\t\t\tbreak; // No need for the ACT_RETURN validation performed below in this case.\n\n\t\tcase ACT_RETURN:\n\t\t\tfor (Line *parent = line->mParentLine; parent; parent = parent->mParentLine)\n\t\t\t\tif (parent->mActionType == ACT_FINALLY)\n\t\t\t\t\treturn line->PreparseError(ERR_BAD_JUMP_INSIDE_FINALLY);\n\t\t\t\telse if (parent->mActionType == ACT_BLOCK_BEGIN && parent->mAttribute)\n\t\t\t\t\tbreak; // Allow \"return\" to be used inside a nested function or fat arrow function.\n\t\t\tbreak;\n\n\t\tcase ACT_CATCH:\n\t\t\tif (!PreparseCatchClass(line))\n\t\t\t\treturn FAIL;\n\t\t\tbreak;\n\t\t}\n\n\t\t// Finalize and optimize postfix expressions.\n\t\tfor (int i = 0; i < line->mArgc; ++i)\n\t\t\tif (line->mArg[i].postfix && !line->FinalizeExpression(line->mArg[i]))\n\t\t\t\treturn FAIL;\n\n\t\t// Check for unreachable code.\n\t\tif (mCurrentModule->Warn_Unreachable)\n\t\tswitch (line->mActionType)\n\t\t{\n\t\tcase ACT_RETURN:\n\t\tcase ACT_BREAK:\n\t\tcase ACT_CONTINUE:\n\t\tcase ACT_GOTO:\n\t\t// v2: ACT_EXIT is always from AddLine(ACT_EXIT), since a script calling Exit would produce ACT_EXPRESSION.\n\t\t//case ACT_EXIT:\n\t\t//case ACT_EXITAPP: // Excluded since it's just a function in v2, and there can't be any expectation that the code following it will execute anyway.\n\t\t\tLine *next_line = line->mNextLine;\n\t\t\tif (!next_line // line is the script's last line.\n\t\t\t\t|| next_line->mParentLine != line->mParentLine) // line is the one-line action of if/else/loop/etc.\n\t\t\t\tbreak;\n\t\t\twhile (next_line->mActionType == ACT_BLOCK_BEGIN && next_line->mAttribute)\n\t\t\t\tnext_line = next_line->mRelatedLine; // Skip function body.\n\t\t\tswitch (next_line->mActionType)\n\t\t\t{\n\t\t\tcase ACT_EXIT: // v2: It's from an automatic AddLine(), so should be excluded.\n\t\t\tcase ACT_BLOCK_END: // There's nothing following this line in the same block.\n\t\t\tcase ACT_CASE:\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tif (IsLabelTarget(next_line))\n\t\t\t\tbreak;\n\t\t\tTCHAR buf[64];\n\t\t\tsntprintf(buf, _countof(buf), _T(\"This line will never execute, due to %s preceding it.\"), g_act[line->mActionType].Name);\n\t\t\tScriptWarning(mCurrentModule->Warn_Unreachable, buf, _T(\"\"), next_line);\n\t\t}\n\t} // for()\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseCatchVar(Line *aLine)\n{\n\tif (!aLine->mArgc)\n\t\treturn OK;\n\tauto args = SimpleHeap::Alloc<CatchStatementArgs>();\n\targs->output_var = nullptr;\n\targs->prototype = nullptr;\n\targs->prototype_count = 0;\n\taLine->mAttribute = args;\n\tLPTSTR cp = aLine->mArg->text + aLine->mArg->length;\n\tfor (LPTSTR min_space_position = aLine->mArg->text + 2;;)\n\t{\n\t\t--cp;\n\t\tif (cp < min_space_position)\n\t\t\treturn OK;\n\t\tif (IS_SPACE_OR_TAB(*cp))\n\t\t\tbreak;\n\t\tif (!IS_IDENTIFIER_CHAR(*cp))\n\t\t\t//return *cp == '.' ? OK : aLine->LineError(ERR_EXPR_SYNTAX);\n\t\t\treturn OK; // Leave error reporting to PreparseCatchClass().\n\t}\n\tLPTSTR var_name = cp + 1;\n\tcp = omit_trailing_whitespace(aLine->mArg->text + 1, cp);\n\tif (ctolower(*cp) == 's' && ctolower(cp[-1]) == 'a' && (cp - 1 == aLine->mArg->text || IS_SPACE_OR_TAB(cp[-2])))\n\t{\n\t\tVar *var;\n\t\tif ( !(var = FindOrAddVar(var_name, 0, FINDVAR_FOR_WRITE))\n\t\t\t|| !aLine->ValidateVarUsage(var, VARREF_OUTPUT_VAR) )\n\t\t\treturn FAIL;\n\t\tvar->MarkAssignedSomewhere();\n\t\targs->output_var = var;\n\t\taLine->mArg->length = ArgLengthType((cp - 1) - aLine->mArg->text);\n\t}\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseCatchClass(Line *aLine)\n{\n\tif (!aLine->mArgc || !aLine->mArg->length) // PreparseCatchVar() may have already set length to exclude \" as output_var\".\n\t\treturn OK;\n\tIObject *prototype[MAX_ARGS - 1]; // Set an arbitrary limit to simplify the code; using MAX_ARGS to keep things consistent, -1 for the output var.\n\tint prototype_count = 0;\n\tfor (LPTSTR cp = aLine->mArg->text, cp_end = cp + aLine->mArg->length; cp < cp_end; )\n\t{\n\t\tif (prototype_count)\n\t\t{\n\t\t\tif (*cp != g_delimiter)\n\t\t\t\treturn aLine->LineError(ERR_EXPR_SYNTAX);\n\t\t\tif (prototype_count == _countof(prototype))\n\t\t\t\treturn aLine->LineError(_T(\"Too many classes.\"));\n\t\t\tcp = omit_leading_whitespace(cp + 1);\n\t\t}\n\t\tLPTSTR end = cp;\n\t\twhile (IS_IDENTIFIER_CHAR(*end) || *end == '.') ++end;\n\t\tLPTSTR next = omit_leading_whitespace(end);\n\t\tif (end == cp)\n\t\t\treturn aLine->LineError(ERR_EXPR_SYNTAX);\n\t\tauto cls = FindClass(cp, end - cp);\n\t\tif ( !cls || !(prototype[prototype_count++] = cls->GetOwnPropObj(_T(\"Prototype\"))) )\n\t\t\treturn aLine->LineError(_T(\"Invalid class.\"), FAIL, cp);\n\t\tcp = next;\n\t}\n\tif (prototype_count) // Currently should always be non-zero due to the length check.\n\t{\n\t\tauto args = (CatchStatementArgs *)aLine->mAttribute;\n\t\targs->prototype = SimpleHeap::Alloc<IObject *>(prototype_count);\n\t\targs->prototype_count = prototype_count;\n\t\tmemcpy(args->prototype, prototype, prototype_count * sizeof(IObject *));\n\t}\n\treturn OK;\n}\n\n\n\nbool Script::IsLabelTarget(Line *aLine)\n{\n\tfor (auto lbl = CurrentFirstLabel(); lbl; lbl = lbl->mNextLabel)\n\t\tif (lbl->mJumpToLine == aLine)\n\t\t\treturn true;\n\treturn false;\n}\n\n\n\nResultType Line::ExpressionToPostfix(ArgStruct &aArg)\n{\n\tExprTokenType *infix = NULL;\n\tResultType result = ExpressionToPostfix(aArg, infix);\n\t// This approach produces smaller code than using RAII in the function below:\n\tfree(infix);\n\treturn result;\n}\n\nResultType Line::ExpressionToPostfix(ArgStruct &aArg, ExprTokenType *&aInfix)\n// Returns OK or FAIL.\n{\n\t// Having a precedence array is required at least for SYM_POWER (since the order of evaluation\n\t// of something like 2**1**2 does matter). It also helps performance by avoiding unnecessary pushing\n\t// and popping of operators to the stack. This array must be kept in sync with \"enum SymbolType\".\n\t// Also, dimensioning explicitly by SYM_COUNT helps enforce that at compile-time:\n\tstatic UCHAR sPrecedence[SYM_COUNT] = // Performance: UCHAR vs. INT benches a little faster, perhaps due to the slight reduction in code size it causes.\n\t{\n\t\t0,0,0,0,0,0,0,0,0// SYM_STRING, SYM_INTEGER, SYM_FLOAT, SYM_MISSING, SYM_VAR, SYM_OBJECT, SYM_DYNAMIC, SYM_SUPER, SYM_BEGIN (SYM_BEGIN must be lowest precedence).\n\t\t, 82, 82 // SYM_POST_INCREMENT, SYM_POST_DECREMENT: Highest precedence operator so that it will work even though it comes *after* a variable name (unlike other unaries, which come before).\n\t\t, 85 // SYM_MAYBE -- Right-associative so that in a chain like a?.b?.c, both operators short-circuit to the same point.\n\t\t, 86 // SYM_DOT\n\t\t, 2,2,2,2,2,2 // SYM_CPAREN, SYM_CBRACKET, SYM_CBRACE, SYM_OPAREN, SYM_OBRACKET, SYM_OBRACE (to simplify the code, parentheses/brackets/braces must be lower than all operators in precedence).\n\t\t, 6 // SYM_COMMA -- Must be just above SYM_OPAREN so it doesn't pop OPARENs off the stack.\n\t\t, 7,7,7,7,7,7,7,7,7,7,7,7,7,7 // SYM_ASSIGN_*. THESE HAVE AN ODD NUMBER to indicate right-to-left evaluation order, which is necessary for cascading assignments such as x:=y:=1 to work.\n//\t\t, 8 // THIS VALUE MUST BE LEFT UNUSED so that the one above can be promoted to it by the infix-to-postfix routine.\n\t\t, 11, 11 // SYM_IFF_ELSE, SYM_IFF_THEN (ternary conditional). HAS AN ODD NUMBER to indicate right-to-left evaluation order, which is necessary for ternaries to perform traditionally when nested in each other without parentheses.\n//\t\t, 12 // THIS VALUE MUST BE LEFT UNUSED so that the one above can be promoted to it by the infix-to-postfix routine.\n\t\t, 15 // SYM_OR_MAYBE -- Right-associative as below.\n\t\t, 17 // SYM_OR -- Right-associative so that short-circuit skips the entire right branch, instead of evaluating each one in sequence with the same result.\n\t\t, 21 // SYM_AND -- As above.\n//\t\t, 25 // Reserved for SYM_LOWNOT.\n//\t\t, 26 // THIS VALUE MUST BE LEFT UNUSED so that the one above can be promoted to it by the infix-to-postfix routine.\n\t\t, 28 // SYM_IS\n\t\t, 30, 30, 30, 30 // SYM_EQUAL, SYM_EQUALCASE, SYM_NOTEQUAL, SYM_NOTEQUALCASE (lower prec. than the below so that \"x < 5 = var\" means \"result of comparison is the boolean value in var\".\n\t\t, 34, 34, 34, 34 // SYM_GT, SYM_LT, SYM_GTOE, SYM_LTOE\n\t\t, 36 // SYM_REGEXMATCH\n\t\t, 38 // SYM_CONCAT\n\t\t, 4\t\t\t\t // SYM_LOW_CONCAT\n\t\t, 42 // SYM_BITOR -- Seems more intuitive to have these three higher in prec. than the above, unlike C and Perl, but like Python.\n\t\t, 46 // SYM_BITXOR\n\t\t, 50 // SYM_BITAND\n\t\t, 54, 54, 54 // SYM_BITSHIFTLEFT, SYM_BITSHIFTRIGHT, SYM_BITSHIFTRIGHT_LOGICAL\n\t\t, 62\t\t\t // SYM_INTEGERDIVIDE\n\t\t, 58, 58 // SYM_ADD, SYM_SUBTRACT\n\t\t, 62, 62\t // SYM_MULTIPLY, SYM_DIVIDE\n\t\t, 73 // SYM_POWER (see note below). Changed to right-associative for v2.\n\t\t, 25 // SYM_LOWNOT (the word \"NOT\": the low precedence version of logical-not). HAS AN ODD NUMBER to indicate right-to-left evaluation order so that things like \"not not var\" are supports (which can be used to convert a variable into a pure 1/0 boolean value).\n\t\t, 67,67,67,67,67 // SYM_NEGATIVE (unary minus), SYM_POSITIVE (unary plus), SYM_REF, SYM_HIGHNOT (the high precedence \"!\" operator), SYM_BITNOT\n\t\t// NOTE: THE ABOVE MUST BE AN ODD NUMBER to indicate right-to-left evaluation order, which was added in v1.0.46 to support consecutive unary operators such as !*var !!var (!!var can be used to convert a value into a pure 1/0 boolean).\n//\t\t, 68 // THIS VALUE MUST BE LEFT UNUSED so that the one above can be promoted to it by the infix-to-postfix routine.\n\t\t, 86 // SYM_ISSET -- Only used in the deref list, so precedence value is not used.\n\t\t, 77, 77 // SYM_PRE_INCREMENT, SYM_PRE_DECREMENT (higher precedence than SYM_POWER because it doesn't make sense to evaluate power first because that would cause ++/-- to fail due to operating on a non-lvalue.\n//\t\t, 78 // THIS VALUE MUST BE LEFT UNUSED so that the one above can be promoted to it by the infix-to-postfix routine.\n//\t\t, 82, 82 // RESERVED FOR SYM_POST_INCREMENT, SYM_POST_DECREMENT (which are listed higher above for the performance of YIELDS_AN_OPERAND().\n\t\t, 2 // SYM_FUNC -- Only SYM_CPAREN should terminate the parameter list and pop SYM_FUNC off the stack.\n\t\t, 0, 0 // SYM_RESERVED_*\n\t};\n\t// Most programming languages give exponentiation a higher precedence than unary minus and logical-not.\n\t// For example, -2**2 is evaluated as -(2**2), not (-2)**2 (the latter is unsupported by qmathPow anyway).\n\t// However, this rule requires a small workaround in the postfix-builder to allow 2**-2 to be\n\t// evaluated as 2**(-2) rather than being seen as an error. v1.0.45: A similar thing is required\n\t// to allow the following to work: 2**!1, 2**not 0, 2**~0xFFFFFFFE, 2**&x.\n\n\t// IsSet is constructed here because it's a sort of intrinsic function with its own\n\t// special rules. ExprOp<> isn't used because it doesn't have parameter count limits\n\t// or a name (which is displayed when the parameter count is invalid, for instance).\n\tstatic BuiltInFunc *sIsSetFunc = new BuiltInFunc { _T(\"IsSet\"), BIF_IsSet, 1, 1 };\n\n\tExprTokenType *infix = NULL;\n\tint infix_size = 0, infix_count = 0, allow_for_extra_postfix = 0;\n\tconst int INFIX_GROWTH = 128; // Amount to grow by each time expansion is needed. Rarely needed more than once (from zero).\n\tconst int INFIX_MIN_SPACE = 5; // Minimum space to allow prior to each iteration or deref-processing. Room for auto-concat, two tokens for `.id`, `. (\"s\")` for DT_STRING, and `f(fn)` for DT_FUNCREF; plus the final SYM_INVALID.\n\n\t///////////////////////////////////////////////////////////////////////////////////////////////\n\t// TOKENIZE THE INFIX EXPRESSION INTO AN INFIX ARRAY: Avoids the performance overhead of having\n\t// to re-detect whether each symbol is an operand vs. operator at multiple stages.\n\t///////////////////////////////////////////////////////////////////////////////////////////////\n\tLPTSTR op_end, cp;\n\tDerefType *deref, *this_deref;\n\tint cp1; // int vs. char benchmarks slightly faster, and is slightly smaller in code size.\n\tTCHAR number_buf[MAX_NUMBER_SIZE];\n\n\tfor (cp = aArg.text, deref = aArg.deref // Start at the beginning of this arg's text and look for the next deref.\n\t\t;; ++deref, ++infix_count) // FOR EACH DEREF IN AN ARG:\n\t{\n\t\tthis_deref = deref && deref->marker ? deref : NULL; // A deref with a NULL marker terminates the list (i.e. the final deref isn't a deref, merely a terminator of sorts.\n\n\t\t// BEFORE PROCESSING \"this_deref\" ITSELF, MUST FIRST PROCESS ANY LITERAL/RAW TEXT THAT LIES TO ITS LEFT.\n\t\tif (this_deref && cp < this_deref->marker // There's literal/raw text to the left of the next deref.\n\t\t\t|| !this_deref && *cp) // ...or there's no next deref, but there's some literal raw text remaining to be processed.\n\t\t{\n\t\t\tfor (;; ++infix_count) // FOR EACH TOKEN INSIDE THIS RAW/LITERAL TEXT SECTION.\n\t\t\t{\n\t\t\t\t// Because neither the postfix array nor the stack can ever wind up with more tokens than were\n\t\t\t\t// contained in the original infix array, only the infix array need be checked for overflow:\n\t\t\t\tif (infix_count + INFIX_MIN_SPACE > infix_size)\n\t\t\t\t{\n\t\t\t\t\tinfix_size += INFIX_GROWTH;\n\t\t\t\t\tif (void *p = realloc(infix, infix_size * sizeof(ExprTokenType)))\n\t\t\t\t\t\taInfix = infix = (ExprTokenType *)p;\n\t\t\t\t\telse\n\t\t\t\t\t\treturn LineError(ERR_OUTOFMEM);\n\t\t\t\t}\n\n\t\t\t\tcp = omit_leading_whitespace(cp);\n\t\t\t\tif (!*cp // Very end of expression...\n\t\t\t\t\t|| this_deref && cp >= this_deref->marker) // ...or no more literal/raw text left to process at the left side of this_deref.\n\t\t\t\t\tbreak; // Break out of inner loop so that bottom of the outer loop will process this_deref itself.\n\n\t\t\t\tExprTokenType &this_infix_item = infix[infix_count]; // Might help reduce code size since it's referenced many places below.\n\t\t\t\tthis_infix_item.callsite = nullptr; // Init needed for SYM_ASSIGN and related; a non-NULL value means it should be converted to an object-assignment.\n\t\t\t\t// Above: SYM_REF and possibly others may rely on this zero-initializing the union.\n\t\t\t\tthis_infix_item.error_reporting_marker = cp; // Used for reporting syntax errors with unary and binary operators, and may be overwritten via union for other symbols.\n\n\t\t\t\t// Auto-concat requires a space or tab for the following reasons:\n\t\t\t\t// - Readability.\n\t\t\t\t// - Compliance with the documentation.\n\t\t\t\t// - To simplify handling of expressions like x[y]().\n\t\t\t\t// - To reserve other combinations for future use; e.g. R\"raw string\".\n#define CHECK_AUTO_CONCAT \\\n\t\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol)) \\\n\t\t\t\t{ \\\n\t\t\t\t\tif (!IS_SPACE_OR_TAB(cp[-1])) \\\n\t\t\t\t\t\treturn LineError(ERR_BAD_AUTO_CONCAT, FAIL, cp); \\\n\t\t\t\t\tinfix[infix_count].error_reporting_marker = _T(\"auto-concat\"); \\\n\t\t\t\t\tinfix[infix_count++].symbol = SYM_CONCAT; \\\n\t\t\t\t}\n\n\t\t\t\t// CHECK IF THIS CHARACTER IS AN OPERATOR.\n\t\t\t\tcp1 = cp[1]; // Improves performance by nearly 5% and appreciably reduces code size (at the expense of being less maintainable).\n\t\t\t\tswitch (*cp)\n\t\t\t\t{\n\t\t\t\t// The most common cases are kept up top to enhance performance if switch() is implemented as if-else ladder.\n\t\t\t\tcase '+':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_ADD;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (cp1 == '+')\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t// For consistency, assume that since the previous item is an operand (even if it's\n\t\t\t\t\t\t\t\t// ')'), this is a post-op that applies to that operand. For example, the following\n\t\t\t\t\t\t\t\t// are all treated the same for consistency (implicit concatenation where the '.'\n\t\t\t\t\t\t\t\t// is omitted is rare anyway).\n\t\t\t\t\t\t\t\t// x++ y\n\t\t\t\t\t\t\t\t// x ++ y\n\t\t\t\t\t\t\t\t// x ++y\n\t\t\t\t\t\t\t\t// The following implicit concat is deliberately unsupported:\n\t\t\t\t\t\t\t\t// \"string\" ++x\n\t\t\t\t\t\t\t\t// The ++ above is seen as applying to the string because it doesn't seem worth\n\t\t\t\t\t\t\t\t// the complexity to distinguish between expressions that can accept a post-op\n\t\t\t\t\t\t\t\t// and those that can't (operands other than variables can have a post-op;\n\t\t\t\t\t\t\t\t// e.g. (x:=y)++).\n\t\t\t\t\t\t\t\t// UPDATE: Quoted literal strings now explicitly support the above, but not\n\t\t\t\t\t\t\t\t// other operands such as 123 ++x, which would be vanishingly rare.\n\t\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_POST_INCREMENT;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_ADD;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse if (cp1 == '+') // Pre-increment.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_PRE_INCREMENT;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse // Unary plus.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_POSITIVE; // Added in v2 for symmetry with SYM_NEGATIVE; i.e. if -x produces NaN, so should +x.\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase '-':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_SUBTRACT;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\t// Otherwise (since above didn't \"break\"):\n\t\t\t\t\t// Must allow consecutive unary minuses because otherwise, the following example\n\t\t\t\t\t// would not work correctly when y contains a negative value: var := 3 * -y\n\t\t\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol))\n\t\t\t\t\t{\n\t\t\t\t\t\tif (cp1 == '-')\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// See comments at SYM_POST_INCREMENT about this section.\n\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_POST_DECREMENT;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_SUBTRACT;\n\t\t\t\t\t}\n\t\t\t\t\telse if (cp1 == '-') // Pre-decrement.\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_PRE_DECREMENT;\n\t\t\t\t\t}\n\t\t\t\t\telse // Unary minus.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Set default for cases where the processing below this line doesn't determine\n\t\t\t\t\t\t// it's a negative numeric literal:\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_NEGATIVE;\n\t\t\t\t\t\t// v1.0.40.06: The smallest signed 64-bit number (-0x8000000000000000) wasn't properly\n\t\t\t\t\t\t// supported in previous versions because its unary minus was being seen as an operator,\n\t\t\t\t\t\t// and thus the raw number was being passed as a positive to _atoi64() or _strtoi64(),\n\t\t\t\t\t\t// neither of which would recognize it as a valid value. To correct this, a unary\n\t\t\t\t\t\t// minus followed by a raw numeric literal is now treated as a single literal number\n\t\t\t\t\t\t// rather than unary minus operator followed by a positive number.\n\t\t\t\t\t\t//\n\t\t\t\t\t\t// To be a valid \"literal negative number\", the character immediately following\n\t\t\t\t\t\t// the unary minus must not be:\n\t\t\t\t\t\t// 1) Whitespace (atoi() and such don't support it, nor is it at all conventional).\n\t\t\t\t\t\t// 2) An open-parenthesis such as the one in -(x).\n\t\t\t\t\t\t// 3) Another unary minus or operator such as --x (which is the pre-decrement operator).\n\t\t\t\t\t\t// To cover the above and possibly other unforeseen things, insist that the first\n\t\t\t\t\t\t// character be a digit (even a hex literal must start with 0).\n\t\t\t\t\t\tif ((cp1 >= '0' && cp1 <= '9') || cp1 == '.') // v1.0.46.01: Recognize dot too, to support numbers like -.5.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t_tcstod(cp, &op_end); // Find the end of this number, the easy way.\n\t\t\t\t\t\t\t// 1.0.46.11: Due to obscurity, no changes have been made here to support scientific\n\t\t\t\t\t\t\t// notation followed by the power operator; e.g. -1.0e+1**5.\n\t\t\t\t\t\t\tif (!this_deref || op_end < this_deref->marker) // Detect numeric double derefs such as one created via \"12%i% = value\".\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t// Because the power operator takes precedence over unary minus, don't collapse\n\t\t\t\t\t\t\t\t// unary minus into a literal numeric literal if the number is immediately\n\t\t\t\t\t\t\t\t// followed by the power operator. This is correct behavior even for\n\t\t\t\t\t\t\t\t// -0x8000000000000000 because -0x8000000000000000**2 would in fact be undefined\n\t\t\t\t\t\t\t\t// because ** is higher precedence than unary minus and +0x8000000000000000 is\n\t\t\t\t\t\t\t\t// beyond the signed 64-bit range. SEE ALSO the comments higher above.\n\t\t\t\t\t\t\t\t// Use a temp variable because unquoted_literal requires that op_end be set properly:\n\t\t\t\t\t\t\t\tLPTSTR pow_temp = omit_leading_whitespace(op_end);\n\t\t\t\t\t\t\t\tif (!(pow_temp[0] == '*' && pow_temp[1] == '*'))\n\t\t\t\t\t\t\t\t\tgoto unquoted_literal; // Goto is used for performance and also as a patch to minimize the chance of breaking other things via redesign.\n\t\t\t\t\t\t\t\t//else it's followed by pow. Since pow is higher precedence than unary minus,\n\t\t\t\t\t\t\t\t// leave this unary minus as an operator so that it will take effect after the pow.\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t//else it appears to be a double deref; invalid, since names beginning with a digit are\n\t\t\t\t\t\t\t// prohibited. Either way it would be detected as an error, but interpreting it as a\n\t\t\t\t\t\t\t// double-deref gives it a more intuitive error message (than ERR_BAD_AUTO_CONCAT).\n\t\t\t\t\t\t}\n\t\t\t\t\t} // Unary minus.\n\t\t\t\t\tbreak;\n\t\t\t\tcase ',':\n\t\t\t\t\tthis_infix_item.symbol = SYM_COMMA; // Used to separate sub-statements and function parameters.\n\t\t\t\t\tbreak;\n\t\t\t\tcase '/':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_DIVIDE;\n\t\t\t\t\t}\n\t\t\t\t\telse if (cp1 == '/')\n\t\t\t\t\t{\n\t\t\t\t\t\tif (cp[2] == '=')\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcp += 2; // An additional increment to have loop skip over the operator's 2nd & 3rd symbols.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_INTEGERDIVIDE;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the second '/' too.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_INTEGERDIVIDE;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_DIVIDE;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '*':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_MULTIPLY;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\tif (cp1 == '*') // Python, Perl, and other languages also use ** for power.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the second '*' too.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_POWER;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_MULTIPLY;\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase '!':\n\t\t\t\t\tif (cp1 == '=') // i.e. !=\n\t\t\t\t\t\t// An additional increment for each '=' to have loop skip over the '=' too.\n\t\t\t\t\t\t++cp, this_infix_item.symbol\t= cp[1] == '=' // note, cp[1] is not equal to cp1 here due to ++cp\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t? (++cp, SYM_NOTEQUALCASE)\t// !==\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t: SYM_NOTEQUAL;\t\t\t\t// != \n\t\t\t\t\telse\n\t\t\t\t\t\t// If what lies to its left is a CPARAN or OPERAND, SYM_CONCAT is not auto-inserted because:\n\t\t\t\t\t\t// 1) Allows ! and ~ to potentially be overloaded to become binary and unary operators in the future.\n\t\t\t\t\t\t// 2) Keeps the behavior consistent with unary minus, which could never auto-concat since it would\n\t\t\t\t\t\t// always be seen as the binary subtract operator in such cases.\n\t\t\t\t\t\t// 3) Simplifies the code.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_HIGHNOT; // High-precedence counterpart of the word \"not\".\n\t\t\t\t\tbreak;\n\t\t\t\tcase '(':\n\t\t\t\t\t// The below should not hurt any future type-casting feature because the type-cast can be checked\n\t\t\t\t\t// for prior to checking the below. For example, if what immediately follows the open-paren is\n\t\t\t\t\t// the string \"int)\", this symbol is not open-paren at all but instead the unary type-cast-to-int\n\t\t\t\t\t// operator.\n\t\t\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol)\n\t\t\t\t\t\t&& IS_SPACE_OR_TAB(cp[-1])) // If there's no space, it will be processed as a function call.\n\t\t\t\t\t{\n\t\t\t\t\t\tinfix[infix_count].error_reporting_marker = _T(\"auto-concat\");\n\t\t\t\t\t\tinfix[infix_count++].symbol = SYM_CONCAT;\n\t\t\t\t\t}\n\t\t\t\t\tinfix[infix_count].symbol = SYM_OPAREN; // MUST NOT REFER TO this_infix_item IN CASE ABOVE DID ++infix_count.\n\t\t\t\t\tinfix[infix_count].marker = cp;\n\t\t\t\t\tbreak;\n\t\t\t\tcase ')':\n\t\t\t\t\tthis_infix_item.symbol = SYM_CPAREN;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '[': // L31\n\t\t\t\t\tif (infix_count && infix[infix_count - 1].symbol == SYM_DOT // obj.x[ ...\n\t\t\t\t\t\t&& *omit_leading_whitespace(cp + 1) != ']') // not obj.x[]\n\t\t\t\t\t{\n\t\t\t\t\t\t// L36: This is something like obj.x[y] or obj.x[y]:=z, which should be treated\n\t\t\t\t\t\t//\t\tas a single operation such as ObjGet(obj,\"x\",y) or ObjSet(obj,\"x\",y,z).\n\t\t\t\t\t\t--infix_count;\n\t\t\t\t\t\t// Below will change the SYM_DOT token into SYM_OBRACKET, keeping the existing callsite struct.\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\tauto callsite = new CallSite();\n\t\t\t\t\t\tif ( !(infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol)) )\n\t\t\t\t\t\t\tcallsite->func = ExprOp<Op_Array, 0>();\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tcallsite->flags = IT_GET; // This may be overridden by standard_pop_into_postfix.\n\t\t\t\t\t\tthis_infix_item.callsite = callsite;\n\t\t\t\t\t}\n\t\t\t\t\t// DO NOT USE this_infix_item in case above did --infix_count.\n\t\t\t\t\tinfix[infix_count].symbol = SYM_OBRACKET;\n\t\t\t\t\tbreak;\n\t\t\t\tcase ']': // L31\n\t\t\t\t\tthis_infix_item.symbol = SYM_CBRACKET;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '{':\n\t\t\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol))\n\t\t\t\t\t\treturn LineError(_T(\"Unexpected \\\"{\\\"\"));\n\t\t\t\t\tthis_infix_item.callsite = new CallSite();\n\t\t\t\t\tthis_infix_item.callsite->func = ExprOp<Op_Object, 0>();\n\t\t\t\t\tthis_infix_item.symbol = SYM_OBRACE;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '}':\n\t\t\t\t\tthis_infix_item.symbol = SYM_CBRACE;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '=':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the other '=' too.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_EQUALCASE;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_EQUAL;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '>':\n\t\t\t\t\tswitch (cp1)\n\t\t\t\t\t{\n\t\t\t\t\tcase '=':\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the '=' too.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_GTOE;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase '>':\n\t\t\t\t\t\tif (cp[2] == '=')\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcp += 2; // An additional increment to have loop skip over the operator's 2nd & 3rd symbols.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_BITSHIFTRIGHT;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the second '>' too.\n\t\t\t\t\t\t\tif (cp[1] == '>') // look for a third '>'\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t++cp; // to have the loop skip the third '>'\n\t\t\t\t\t\t\t\t// it is SYM_BITSHIFTRIGHT_LOGICAL or SYM_ASSIGN_BITSHIFTRIGHT_LOGICAL\n\t\t\t\t\t\t\t\tthis_infix_item.symbol = cp[1] == '=' ? (cp++, SYM_ASSIGN_BITSHIFTRIGHT_LOGICAL) : SYM_BITSHIFTRIGHT_LOGICAL;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_BITSHIFTRIGHT;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_GT;\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase '<':\n\t\t\t\t\tswitch (cp1)\n\t\t\t\t\t{\n\t\t\t\t\tcase '=':\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the '=' too.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_LTOE;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase '<':\n\t\t\t\t\t\tif (cp[2] == '=')\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcp += 2; // An additional increment to have loop skip over the operator's 2nd & 3rd symbols.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_BITSHIFTLEFT;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the second '<' too.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_BITSHIFTLEFT;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_LT;\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase '&':\n\t\t\t\t\tif (cp1 == '&')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the second '&' too.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_AND;\n\t\t\t\t\t}\n\t\t\t\t\telse if (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_BITAND;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\t// Differentiate between unary \"take a reference to\" and the \"bitwise and\" operator:\n\t\t\t\t\t\t// See '-' above for more details:\n\t\t\t\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol))\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_BITAND;\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_REF;\n\t\t\t\t\t\t\tthis_infix_item.var_usage = VARREF_READ; // Set default: assume a VarRef is needed.\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase '|':\n\t\t\t\t\tif (cp1 == '|')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the second '|' too.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_OR;\n\t\t\t\t\t}\n\t\t\t\t\telse if (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_BITOR;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_BITOR;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '^':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_BITXOR;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_BITXOR;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '~':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp;\n\t\t\t\t\t\tthis_infix_item.callsite = new CallSite();\n\t\t\t\t\t\tthis_infix_item.callsite->func = ExprOp<Op_RegEx, 0>();\n\t\t\t\t\t\tthis_infix_item.callsite->param_count = 2;\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_REGEXMATCH;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t// If what lies to its left is a CPARAN or OPERAND, SYM_CONCAT is not auto-inserted because:\n\t\t\t\t\t// 1) Allows ! and ~ to potentially be overloaded to become binary and unary operators in the future.\n\t\t\t\t\t// 2) Keeps the behavior consistent with unary minus, which could never auto-concat since it would\n\t\t\t\t\t// always be seen as the binary subtract operator in such cases.\n\t\t\t\t\t// 3) Simplifies the code.\n\t\t\t\t\tthis_infix_item.symbol = SYM_BITNOT;\n\t\t\t\t\tbreak;\n\t\t\t\tcase '?':\n\t\t\t\t\tif (cp1 == '?')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\tif (cp[1] == '=')\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_MAYBE;\n\t\t\t\t\t\t\t++cp;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_OR_MAYBE;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tbool maybe;\n\t\t\t\t\top_end = omit_leading_whitespace(cp + 1);\n\t\t\t\t\tif (*op_end == '.' && (op_end[1] == '(' || op_end[1] == '[')) // fun?.() or arr?.[i]\n\t\t\t\t\t{\n\t\t\t\t\t\t// Prohibit x.y?.(z) for now since it's probably ideal to have it short-circuit over (z)\n\t\t\t\t\t\t// if the method doesn't exist, and call with `this == x` (like JavaScript in both cases).\n\t\t\t\t\t\t// This can only work with objects which allow checking for the presence of the method.\n\t\t\t\t\t\t// To implement it that way we would need special handling, perhaps like:\n\t\t\t\t\t\t// 1. x\n\t\t\t\t\t\t// stack: [x]\n\t\t\t\t\t\t// 2. FUNC {member: 'y', flags: EIF_MAYBE_GET_METHOD}\n\t\t\t\t\t\t// stack: [x.GetMethod('y'), x] or [unset]\n\t\t\t\t\t\t// 3. MAYBE\n\t\t\t\t\t\t// goto 6 if unset\n\t\t\t\t\t\t// 4. z\n\t\t\t\t\t\t// stack: [x.y, x, z]\n\t\t\t\t\t\t// 5. FUNC {flags: IT_CALL} ; calls (x.y)(x, z)\n\t\t\t\t\t\tif (op_end[1] == '(' && infix_count && infix[infix_count-1].symbol == SYM_DOT)\n\t\t\t\t\t\t\treturn LineError(_T(\"Optional method calls are not supported.\"), FAIL, cp);\n\t\t\t\t\t\tmaybe = true;\n\t\t\t\t\t\tcp = op_end; // The loop will skip over '.' itself.\n\t\t\t\t\t}\n\t\t\t\t\telse if (*op_end == '.' && IS_IDENTIFIER_CHAR(op_end[1])) // x?.y or x?.123\n\t\t\t\t\t{\n\t\t\t\t\t\t// Do some extra checks to allow an optional chain enclosed in parentheses to use numeric\n\t\t\t\t\t\t// property names without breaking expressions like a?.123:b, for backward-compatibility.\n\t\t\t\t\t\tLPTSTR d_end;\n\t\t\t\t\t\tauto id = op_end + 1, id_end = find_identifier_end(id);\n\t\t\t\t\t\t_tcstod(id, &d_end); // This accounts for scientific notation.\n\t\t\t\t\t\tif (id_end != d_end || *id_end == '(' || *id_end == '[')\n\t\t\t\t\t\t\tmaybe = id_end >= d_end;\n\t\t\t\t\t\telse // Could be either a floating-point literal or a property.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tid += FindExprDelim(id, 0);\n\t\t\t\t\t\t\t// Above has found ':' only if there is one within the same sub-expression (considering\n\t\t\t\t\t\t\t// parentheses, commas, etc.) which wasn't matched to a '?' at or to the right of d.\n\t\t\t\t\t\t\tmaybe = *id != ':';\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\tmaybe = _tcschr(EXPR_SYMBOLS_AFTER_MAYBE, *op_end); // Can't be valid ternary in any of these cases. *op_end == 0 is included in the search to support fat arrow functions (line continuation otherwise prevents it from occurring at EOL, except at EOF).\n\t\t\t\t\t}\n\t\t\t\t\tif (maybe)\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_MAYBE;\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_IFF_THEN;\n\t\t\t\t\tbreak;\n\t\t\t\tcase ':':\n\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t{\n\t\t\t\t\t\t++cp; // An additional increment to have loop skip over '=' too.\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_infix_item.symbol = SYM_IFF_ELSE;\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase '\"': // QUOTED/LITERAL STRING.\n\t\t\t\tcase '\\'':\n\t\t\t\t\t// This is the opening quote mark of a literal string. The string itself will be\n\t\t\t\t\t// handled via the \"deref\" list.\n\t\t\t\t\tinfix_count--; // Counter the loop's increment.\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase g_DerefChar:\n\t\t\t\t\t// Deref char within a string or double-deref; acts as concat.\n\t\t\t\t\tthis_infix_item.symbol = SYM_LOW_CONCAT;\n\t\t\t\t\tbreak;\n\n\t\t\t\tdefault: // NUMERIC-LITERAL, DOUBLE-DEREF, RELATIONAL OPERATOR SUCH AS \"NOT\", OR UNRECOGNIZED SYMBOL.\n\t\t\t\t\tif (*cp == '.') // This one must be done here rather than as a \"case\". See comment below.\n\t\t\t\t\t{\n\t\t\t\t\t\tif (cp1 == '=')\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t++cp; // An additional increment to have loop skip over the operator's second symbol.\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_ASSIGN_CONCAT;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (IS_SPACE_OR_TAB(cp1))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (!infix_count || !IS_SPACE_OR_TAB(cp[-1])) // L31: Disallow things like \"obj. name\" since it seems ambiguous. Checking infix_count ensures cp is not the beginning of the string (\". \" at the beginning of an expression would also be invalid). Checking IS_SPACE_OR_TAB seems more appropriate than looking in EXPR_OPERAND_TERMINATORS; it enforces the previously unenforced but documented rule that concat-dot requires a space on either side.\n\t\t\t\t\t\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, cp);\n\t\t\t\t\t\t\tthis_infix_item.symbol = SYM_CONCAT;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t//else this is a '.' that isn't followed by a space, tab, or '='. So it's probably\n\t\t\t\t\t\t// a number without a leading zero like .2, so continue on below to process it.\n\t\t\t\t\t\t// BACKWARD COMPATIBILITY: The above behavior creates ambiguity between a \"pure\"\n\t\t\t\t\t\t// concat operator (.) and numbers that begin with a decimal point. I think that\n\t\t\t\t\t\t// came about because the concat operator was added after numbers like .5 had been\n\t\t\t\t\t\t// supported a long time. In any case, it's documented that the '.' operator must\n\t\t\t\t\t\t// have a space on both sides to be valid, and maybe automatic/implicit concatenation\n\t\t\t\t\t\t// handles most such situations properly anyway (e.g. the expression \"x .5\").\n\n\t\t\t\t\t\t// L31\n\t\t\t\t\t\t// Rather than checking if this \".xxx\" is numeric and trying to detect things like \"obj.123\" or \".123e+1\",\n\t\t\t\t\t\t// use a simpler method: if . follows something which yields an operand, treat it as member access. As a\n\t\t\t\t\t\t// side-effect, implicit concatenation is no longer supported for floating point numbers beginning with \".\".\n\t\t\t\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (this_deref && this_deref->marker == cp + 1) // Dynamic member such as x.%y% or x.y%z%.\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t--infix_count; // Counter the loop's increment.\n\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t// Skip this '.'\n\t\t\t\t\t\t\t++cp;\n\n\t\t\t\t\t\t\t// Find the end of the operand (\".operand\"):\n\t\t\t\t\t\t\top_end = find_identifier_end(cp);\n\t\t\t\t\t\t\tif (!_tcschr(EXPR_OPERAND_TERMINATORS, *op_end))\n\t\t\t\t\t\t\t\treturn LineError(ERR_EXP_ILLEGAL_CHAR, FAIL, op_end);\n\n\t\t\t\t\t\t\tif (op_end == cp) // Missing identifier.\n\t\t\t\t\t\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, cp-1); // Intentionally vague since the user's intention isn't clear.\n\n\t\t\t\t\t\t\tauto callsite = new CallSite();\n\t\t\t\t\t\t\tcallsite->member = op_end == cp ? nullptr : SimpleHeap::Alloc(cp, op_end - cp);\n\n\t\t\t\t\t\t\tSymbolType new_symbol; // Type of token: SYM_FUNC or SYM_DOT (which must be treated differently as it doesn't have parentheses).\n\t\t\t\t\t\t\tif (*op_end == '(')\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tnew_symbol = SYM_FUNC;\n\t\t\t\t\t\t\t\tcallsite->flags = IT_CALL;\n\t\t\t\t\t\t\t\t// DON'T DO THE FOLLOWING - must let next iteration handle '(' so it outputs a SYM_OPAREN:\n\t\t\t\t\t\t\t\t//++op_end;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tnew_symbol = SYM_DOT; // This will be changed to SYM_FUNC at a later stage.\n\t\t\t\t\t\t\t\tcallsite->flags = IT_GET; // Set default; may be overridden by standard_pop_into_postfix.\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t// Output the operator next - after the operand to avoid auto-concat.\n\t\t\t\t\t\t\tinfix[infix_count].symbol = new_symbol;\n\t\t\t\t\t\t\tinfix[infix_count].callsite = callsite;\n\t\t\t\t\t\t\tinfix[infix_count].error_reporting_marker = cp - 1;\n\n\t\t\t\t\t\t\t// Continue processing after this operand. Outer loop will do ++infix_count.\n\t\t\t\t\t\t\tcp = op_end;\n\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\nunquoted_literal:\n\t\t\t\t\t// This operand is a normal raw numeric-literal, or an unquoted literal string/key in\n\t\t\t\t\t// an object literal, such as \"{key: value}\". Word operators such as AND/OR/NOT/NEW\n\t\t\t\t\t// and variable/function references don't reach this point as they are pre-parsed by\n\t\t\t\t\t// ParseOperands() and placed into the \"deref\" array. Unrecognized symbols should be\n\t\t\t\t\t// impossible at this stage because prior validation would have caught them.\n\t\t\t\t\tCHECK_AUTO_CONCAT;\n\t\t\t\t\t// MUST NOT REFER TO this_infix_item IN CASE ABOVE DID ++infix_count:\n\t\t\t\t\tExprTokenType &this_literal = infix[infix_count];\n\n\t\t\t\t\tif (*cp <= '9' && (*cp >= '0' || *cp == '+' || *cp == '-' || *cp == '.'))\n\t\t\t\t\t{\n\t\t\t\t\t\t// Looks like a number. The checks above and IsHex() below rule out the strings\n\t\t\t\t\t\t// \"inf\", \"infinity\", \"nan\" and \"nanxxx\", and hexadecimal floating-point numbers,\n\t\t\t\t\t\t// which would otherwise be interpreted as valid if supported by the compiler\n\t\t\t\t\t\t// (VC++ 2015 and later). This is done because we don't support those values\n\t\t\t\t\t\t// elsewhere in the code, such as in IsNumeric().\n\t\t\t\t\t\tLPTSTR i_end, d_end;\n\t\t\t\t\t\t__int64 i = istrtoi64(cp, &i_end);\n\t\t\t\t\t\tif (!IsHex(cp))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tdouble d = _tcstod(cp, &d_end);\n\t\t\t\t\t\t\tif (d_end > i_end && _tcschr(EXPR_OPERAND_TERMINATORS, *d_end))\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tthis_literal.symbol = SYM_FLOAT;\n\t\t\t\t\t\t\t\tthis_literal.value_double = d;\n\t\t\t\t\t\t\t\tcp = d_end; // Have the loop process whatever lies at d_end and beyond.\n\t\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (*cp == '.') // Must be checked to avoid `(.foo)` being interpreted as `((0).foo)`.\n\t\t\t\t\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, cp);\n\t\t\t\t\t\tif (_tcschr(EXPR_OPERAND_TERMINATORS, *i_end)\n\t\t\t\t\t\t\t// Exclude property names composed of digits, in an object literal:\n\t\t\t\t\t\t\t&& !(*omit_leading_whitespace(i_end) == ':' && infix_count\n\t\t\t\t\t\t\t\t&& (infix[infix_count-1].symbol == SYM_OBRACE || infix[infix_count-1].symbol == SYM_COMMA)))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tthis_literal.symbol = SYM_INTEGER;\n\t\t\t\t\t\t\tthis_literal.value_int64 = i;\n\t\t\t\t\t\t\tcp = i_end; // Have the loop process whatever lies at i_end and beyond.\n\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\top_end = find_identifier_end(cp);\n\t\t\t\t\t// SYM_STRING: either the \"key\" in \"{key: value}\" or a syntax error (might be impossible).\n\t\t\t\t\tLPTSTR str = SimpleHeap::Alloc(cp, op_end - cp);\n\t\t\t\t\tthis_literal.SetValue(str, op_end - cp);\n\t\t\t\t\tcp = op_end; // Have the loop process whatever lies at op_end and beyond.\n\t\t\t\t\tcontinue; // \"Continue\" to avoid the ++cp at the bottom.\n\t\t\t\t} // switch() for type of symbol/operand.\n\t\t\t\tif (IS_ASSIGNMENT_EXCEPT_POST_AND_PRE(this_infix_item.symbol))\n\t\t\t\t\t++allow_for_extra_postfix;\n\t\t\t\telse if (this_infix_item.symbol == SYM_POST_INCREMENT || this_infix_item.symbol == SYM_POST_DECREMENT)\n\t\t\t\t\tallow_for_extra_postfix += 4;\n\t\t\t\telse if (this_infix_item.symbol == SYM_PRE_INCREMENT || this_infix_item.symbol == SYM_PRE_DECREMENT)\n\t\t\t\t\tallow_for_extra_postfix += 2;\n\t\t\t\t++cp; // i.e. increment only if a \"continue\" wasn't encountered somewhere above. Although maintainability is reduced to do this here, it avoids dozens of ++cp in other places.\n\t\t\t} // for each token in this section of raw/literal text.\n\t\t} // End of processing of raw/literal text (such as operators) that lie to the left of this_deref.\n\n\t\tif (!this_deref) // All done because the above just processed all the raw/literal text (if any) that\n\t\t\tbreak; // lay to the right of the last deref.\n\n\t\tif (infix_count + INFIX_MIN_SPACE > infix_size)\n\t\t{\n\t\t\tinfix_size += INFIX_GROWTH;\n\t\t\tif (void *p = realloc(infix, infix_size * sizeof(ExprTokenType)))\n\t\t\t\taInfix = infix = (ExprTokenType *)p;\n\t\t\telse\n\t\t\t\treturn LineError(ERR_OUTOFMEM);\n\t\t}\n\n\t\t// THE ABOVE HAS NOW PROCESSED ANY/ALL RAW/LITERAL TEXT THAT LIES TO THE LEFT OF this_deref.\n\t\t// SO NOW PROCESS THIS_DEREF ITSELF.\n\t\tDerefType &this_deref_ref = *this_deref; // Boosts performance slightly.\n\t\tif (this_deref_ref.type == DT_STRING || this_deref_ref.type == DT_QSTRING)\n\t\t{\n\t\t\tbool is_end_of_string = this_deref_ref.terminal;\n\t\t\tbool is_start_of_string = this_deref_ref.substring_count == 1;\n\t\t\tbool require_paren = this_deref_ref.substring_count > 1 || !this_deref_ref.terminal;\n\n\t\t\tcp = this_deref_ref.marker; // This is done in case omit_leading_whitespace() skipped over leading whitespace of a string.\n\n\t\t\tif (infix_count && YIELDS_AN_OPERAND(infix[infix_count - 1].symbol))\n\t\t\t{ \n\t\t\t\tLPTSTR start_of_literal = cp - (this_deref_ref.type == DT_QSTRING);\n\t\t\t\tTCHAR c = start_of_literal[-1];\n\t\t\t\t// See CHECK_AUTO_CONCAT macro definition for comments.\n\t\t\t\tif (c != '.') // i.e. it's not a dynamic member like .my%x%\n\t\t\t\t{\n\t\t\t\t\tif (!IS_SPACE_OR_TAB(c))\n\t\t\t\t\t\treturn LineError(ERR_BAD_AUTO_CONCAT, FAIL, start_of_literal);\n\t\t\t\t\tinfix[infix_count++].symbol = SYM_CONCAT;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tbool can_be_optimized_out = this_deref_ref.length == 0 && this_deref_ref.type != DT_QSTRING;\n\t\t\tif (can_be_optimized_out)\n\t\t\t{\n\t\t\t\t// This substring is empty; can we optimize it out along with one concat op?\n\t\t\t\tif (*cp == g_DerefChar)\n\t\t\t\t\t// Skip the deref char, which otherwise produces SYM_LOW_CONCAT. Can't use cp++ because we need\n\t\t\t\t\t// to ensure the value stored infix[].marker below doesn't end up pointing to an open parenthesis,\n\t\t\t\t\t// such as for obj.%(methodexpr)%(). length can be repurposed because this deref will be discarded.\n\t\t\t\t\tthis_deref_ref.length = 1; \n\t\t\t\telse if (infix_count && infix[infix_count - 1].symbol == SYM_LOW_CONCAT)\n\t\t\t\t\tinfix_count--; // Undo the concat op.\n\t\t\t\telse\n\t\t\t\t\tcan_be_optimized_out = false;\n\t\t\t}\n\n\t\t\tif (require_paren && is_start_of_string)\n\t\t\t{\n\t\t\t\tinfix[infix_count].symbol = SYM_OPAREN;\n\t\t\t\tinfix[infix_count].marker = cp;\n\t\t\t\tinfix_count++;\n\t\t\t}\n\n\t\t\tif (!can_be_optimized_out)\n\t\t\t{\n\t\t\t\tsize_t length;\n\t\t\t\tauto str = ConvertEscapeSequences<SimpleHeap::Alloc<TCHAR>>(this_deref_ref.marker, this_deref_ref.length, length);\n\t\t\t\tASSERT(!str[length]);\n\t\t\t\tinfix[infix_count].SetValue(str, length);\n\t\t\t\tinfix_count++;\n\t\t\t}\n\t\t\tcp += this_deref_ref.length;\n\n\t\t\tif (is_end_of_string)\n\t\t\t{\n\t\t\t\tif (this_deref_ref.type == DT_QSTRING)\n\t\t\t\t{\n\t\t\t\t\tcp = omit_leading_whitespace(cp + 1);\n\t\t\t\t\tif (*cp && _tcschr(_T(\"+-*&~!\"), *cp) && cp[1] != '=' && (cp[1] != '&' || *cp != '&'))\n\t\t\t\t\t{\n\t\t\t\t\t\t// The symbol following this literal string is either a unary operator or a\n\t\t\t\t\t\t// binary operator which can't (at least logically) be applied to a literal\n\t\t\t\t\t\t// string. Since the user's intention isn't clear, treat it as a syntax error.\n\t\t\t\t\t\t// The most common cases where this helps are:\n\t\t\t\t\t\t//\tMsgBox % \"var's address is \" &var ; Misinterpreted as SYM_BITAND.\n\t\t\t\t\t\t//\tMsgBox % \"counter is now \" ++var ; Misinterpreted as SYM_POST_INCREMENT.\n\t\t\t\t\t\treturn LineError(_T(\"Unexpected operator following literal string.\"), FAIL, cp);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (infix[infix_count - 1].symbol == SYM_IFF_THEN) // Something like %foo?%. Later checks differentiate %invalid?% from this.%valid?%.\n\t\t\t\t\tinfix[infix_count - 1].symbol = SYM_MAYBE;\n\t\t\t\tif (require_paren)\n\t\t\t\t{\n \t\t\t\tinfix[infix_count].symbol = SYM_CPAREN;\n\t\t\t\t\tinfix_count++;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// *cp must be either % (indicating an expression within the string) or the end of\n\t\t\t\t// the arg (implying this is a top-level unquoted string and !aArg.is_expression),\n\t\t\t\t// except that an optimization above may have skipped the '%'.\n\t\t\t\tASSERT(*cp == g_DerefChar || !*cp || can_be_optimized_out && cp[-1] == g_DerefChar);\n\t\t\t}\n\t\t\t// Counter the loop's increment. It's done this way for simplicity, since a variable\n\t\t\t// number of tokens are created by this section and the conditions are a bit convoluted.\n\t\t\tinfix_count--;\n\t\t\tcontinue;\n\t\t}\n\t\telse if (this_deref_ref.type == DT_DOUBLE) // Marks the end of a var double-dereference.\n\t\t{\n\t\t\tinfix[infix_count].symbol = SYM_DYNAMIC;\n\t\t\tinfix[infix_count].marker = cp - 1; // For error-reporting in this case, since error_reporting_marker overlaps with var_usage.\n\t\t\tinfix[infix_count].var_usage = VARREF_READ; // Set default.\n\t\t}\n\t\telse if (this_deref_ref.type == DT_DOTPERCENT)\n\t\t{\n\t\t\tauto callsite = new CallSite();\n\t\t\tif (*this_deref_ref.marker == '(')\n\t\t\t{\n\t\t\t\tinfix[infix_count].symbol = SYM_FUNC;\n\t\t\t\tcallsite->flags = IT_CALL | EIF_STACK_MEMBER;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tinfix[infix_count].symbol = SYM_DOT;\n\t\t\t\tcallsite->flags = IT_GET | EIF_STACK_MEMBER;\n\t\t\t}\n\t\t\tinfix[infix_count].callsite = callsite;\n\t\t\tinfix[infix_count].error_reporting_marker = cp;\n\t\t}\n\t\telse if (this_deref_ref.type == DT_WORDOP)\n\t\t{\n\t\t\tif (this_deref_ref.symbol == SYM_SUPER)\n\t\t\t{\n\t\t\t\t// These checks ensure SYM_SUPER doesn't need to be specifically handled by\n\t\t\t\t// ExpandExpression(); it will be pushed onto the stack due to IS_OPERAND()\n\t\t\t\t// and handled directly by SYM_FUNC.\n\t\t\t\tLPTSTR next_op = cp + this_deref_ref.length;\n\t\t\t\tif (*next_op != '(') // Permit super() to mean super.call(), but do not permit \"super (1)\".\n\t\t\t\t{\n\t\t\t\t\tnext_op = omit_leading_whitespace(next_op); // The \".\" and \"[]\" operators permit leading spaces.\n\t\t\t\t\tif (*next_op != '.' && *next_op != '[') // Permit super.x and super[i].\n\t\t\t\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, cp);\n\t\t\t\t}\n\t\t\t\tif (!g->CurrentFunc || !g->CurrentFunc->mClass)\n\t\t\t\t\treturn LineError(_T(\"\\\"\") SUPER_KEYWORD _T(\"\\\" is valid only inside a class.\"), FAIL, cp);\n\t\t\t\tCHECK_AUTO_CONCAT;\n\t\t\t}\n\t\t\telse if (this_deref_ref.symbol == SYM_ISSET)\n\t\t\t{\n\t\t\t\tif (cp[this_deref_ref.length] != '(')\n\t\t\t\t\treturn LineError(ERR_MISSING_OPEN_PAREN, FAIL, cp);\n\t\t\t\tCHECK_AUTO_CONCAT;\n\t\t\t\tinfix[infix_count].callsite = new CallSite();\n\t\t\t\tinfix[infix_count].callsite->func = sIsSetFunc;\n\t\t\t\tinfix[infix_count].error_reporting_marker = cp;\n\t\t\t\tthis_deref_ref.symbol = SYM_FUNC;\n\t\t\t}\n\t\t\tinfix[infix_count].symbol = this_deref_ref.symbol;\n\t\t\tinfix[infix_count].error_reporting_marker = this_deref_ref.marker;\n\t\t\tif (this_deref_ref.symbol == SYM_MISSING)\n\t\t\t{\n\t\t\t\t// Insert a SYM_MAYBE to handle validation.\n\t\t\t\tinfix_count++;\n\t\t\t\tinfix[infix_count].symbol = SYM_MAYBE;\n\t\t\t\tinfix[infix_count].circuit_token = &infix[infix_count-1]; // Flag it as already \"applied\".\n\t\t\t\tinfix[infix_count].error_reporting_marker = this_deref_ref.marker;\n\t\t\t}\n\t\t}\n\t\telse if (this_deref_ref.type == DT_CONST_INT)\n\t\t{\n\t\t\tCHECK_AUTO_CONCAT;\n\t\t\tinfix[infix_count].SetValue(this_deref_ref.int_value);\n\t\t}\n\t\telse // this_deref is a variable (DT_VAR) or fat arrow function (DT_FUNCREF).\n\t\t{\n\t\t\tCHECK_AUTO_CONCAT;\n\t\t\t// Use SYM_VAR for both built-in and normal vars at this stage, since some normal vars\n\t\t\t// might become read-only later on anyway. This simplifies some parts, as non-dynamic\n\t\t\t// references are always SYM_VAR and SYM_DYNAMIC has only one meaning. A later stage\n\t\t\t// will validate and translate each SYM_VAR as needed.\n\t\t\tinfix[infix_count].symbol = SYM_VAR;\n\t\t\tinfix[infix_count].var_deref = &this_deref_ref;\n\t\t\tinfix[infix_count].var_usage = VARREF_READ; // Set default, for detection of how this var ref is used.\n\t\t} // Handling of the var or function in this_deref.\n\n\t\t// Finally, jump over the dereference text. Note that in the case of an expression, there might not\n\t\t// be any percent signs within the text of the dereference, e.g. x + y, not %x% + %y% (unless they're\n\t\t// deliberately double-derefs).\n\t\tcp += this_deref_ref.length;\n\t\t// The outer loop will now do ++infix for us.\n\t} // For each deref in this expression, and also for the final literal/raw text to the right of the last deref.\n\n\tif (infix_count == 0)\n\t\t// Probably something like \"Loop Parse, foo, `n\" since an empty expression wouldn't make it this far.\n\t\t// infix_size is 0 in this case, so cannot continue. An alternative would be to treat this as a blank\n\t\t// parameter, but it's probably more useful to treat it as an error (maybe \"`n\" was intended).\n\t\treturn LineError(ERR_EXPR_SYNTAX);\n\n\tif (aArg.type == ARG_TYPE_OUTPUT_VAR)\n\t{\n\t\tif (infix_count != 1 || infix->symbol != SYM_VAR)\n\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, aArg.text);\n\t\tinfix->var_usage = VARREF_OUTPUT_VAR;\n\t}\n\n\t// Terminate the array with a special item. This allows infix-to-postfix conversion to do a faster\n\t// traversal of the infix array.\n\tASSERT(infix_count < infix_size);\n\tinfix[infix_count].symbol = SYM_INVALID;\n\n\t////////////////////////////\n\t// CONVERT INFIX TO POSTFIX.\n\t////////////////////////////\n\n\t// postfix may need to be a bit bigger than infix: Allow an extra slot for each compound assignment,\n\t// in case it targets an object/property and therefore needs to be expanded. Also allow an extra slot\n\t// to be temporarily occupied by a short-circuit operator popped from the stack.\n\tint max_postfix_count = infix_count + allow_for_extra_postfix + 1;\n\tExprTokenType **postfix = (ExprTokenType **)_alloca(max_postfix_count * sizeof(ExprTokenType *));\n\tExprTokenType **stack = (ExprTokenType **)_alloca((infix_count + 1) * sizeof(ExprTokenType *)); // +1 for SYM_BEGIN on the stack.\n\tint postfix_count = 0, stack_count = 0;\n\t// Above dimensions the stack to be as large as the infix/postfix arrays to cover worst-case\n\t// scenarios and avoid having to check for overflow. For the infix-to-postfix conversion, the\n\t// stack must be large enough to hold a malformed expression consisting entirely of operators\n\t// (though other checks might prevent this).\n\n#ifdef _DEBUG\n#undef STACK_PUSH\n#define STACK_PUSH(token_ptr) (ASSERT(stack_count < infix_count), stack[stack_count++] = (token_ptr))\n#endif\n\n\t// SYM_BEGIN is the first item to go on the stack. It's a flag to indicate that conversion to postfix has begun:\n\tExprTokenType token_begin;\n\ttoken_begin.symbol = SYM_BEGIN;\n\tSTACK_PUSH(&token_begin);\n\n\tSymbolType stack_symbol, infix_symbol, sym_prev, sym_next;\n\tExprTokenType *this_infix = infix;\n\n\tfor (;;) // While SYM_BEGIN is still on the stack, continue iterating.\n\t{\n\t\tASSERT(postfix_count < max_postfix_count);\n\t\tExprTokenType *&this_postfix = postfix[postfix_count]; // Resolve early, especially for use by \"goto\". Reduces code size a bit, though it doesn't measurably help performance.\n\t\tinfix_symbol = this_infix->symbol; //\n\t\tstack_symbol = stack[stack_count - 1]->symbol; // Frequently used, so resolve only once to help performance.\n\n\t\t// Put operands into the postfix array immediately, then move on to the next infix item:\n\t\tif (IS_OPERAND(infix_symbol))\n\t\t{\n\t\t\tthis_postfix = this_infix++;\n\t\t\t++postfix_count;\n\t\t\tcontinue; // Doing a goto to a hypothetical \"standard_postfix\" (in lieu of these last 3 lines) reduced performance and didn't help code size.\n\t\t}\n\n\t\t// Since above didn't \"continue\", the current infix symbol is not an operand, but an operator or other symbol.\n\n\t\tswitch(infix_symbol)\n\t\t{\n\t\tcase SYM_CPAREN: // Listed first for performance. It occurs frequently while emptying the stack to search for the matching open-parenthesis.\n\t\tcase SYM_CBRACKET:\t// Requires similar handling to CPAREN.\n\t\tcase SYM_CBRACE:\t// Requires similar handling to CPAREN.\n\t\tcase SYM_COMMA:\t\t// COMMA is handled here with CPAREN/BRACKET/BRACE for parameter counting and validation.\n\t\t{\n\t\t\t// Prior handling ensures there is an OPAREN or FUNC on the stack for any CPAREN/CBRACKET/CBRACE,\n\t\t\t// and GetLineContExpr()/BalanceExpr() has ensured that the opening and closing symbols match.\n\t\t\tif (sPrecedence[stack_symbol] > sPrecedence[infix_symbol])\n\t\t\t{\n\t\t\t\tgoto standard_pop_into_postfix;\n\t\t\t\t// By not incrementing i, the loop will continue to encounter SYM_CPAREN and thus\n\t\t\t\t// continue to pop things off the stack until the corresponding OPAREN is reached.\n\t\t\t}\n\t\t\tASSERT(stack_symbol == SYM_FUNC || IS_OPAREN_LIKE(stack_symbol)\n\t\t\t\t|| infix_symbol == SYM_COMMA && (stack_symbol == SYM_COMMA || stack_symbol == SYM_BEGIN));\n\t\t\t// Otherwise, this infix item is a comma or a close-paren/bracket/brace whose corresponding\n\t\t\t// open-paren or SYM_FUNC is now at the top of the stack. A function parameter has just\n\t\t\t// been completed in postfix, so we have extra work to do:\n\t\t\t// a) Maintain and validate the parameter count.\n\t\t\t// b) Allow empty parameters by inserting the SYM_MISSING marker.\n\t\t\tCallSite *in_param_list = (stack_symbol == SYM_FUNC || stack_symbol == SYM_OBRACE || stack_symbol == SYM_OBRACKET)\n\t\t\t\t? stack[stack_count - 1]->callsite : nullptr;\n\t\t\tsym_prev = this_infix[-1].symbol; // There's always at least one token preceding this one.\n\t\t\tif (!in_param_list)\n\t\t\t{\n\t\t\t\tif (sym_prev == SYM_OPAREN || sym_prev == SYM_COMMA) // () or ,)\n\t\t\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, this_infix->error_reporting_marker);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tif (infix_symbol == SYM_COMMA || !IS_OPAREN_LIKE(sym_prev)) // i.e. not an empty parameter list.\n\t\t\t\t{\n\t\t\t\t\tif (sym_prev == SYM_COMMA || IS_OPAREN_LIKE(sym_prev)) // Empty parameter.\n\t\t\t\t\t{\n\t\t\t\t\t\tint num_blank_params = 0;\n\t\t\t\t\t\twhile (this_infix->symbol == SYM_COMMA)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t++this_infix;\n\t\t\t\t\t\t\t++num_blank_params;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tinfix_symbol = this_infix->symbol; // In case this_infix changed above.\n\t\t\t\t\t\tif (!IS_CPAREN_LIKE(infix_symbol))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tfor (int i = 0; i < num_blank_params; ++i)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t// Do not reuse the infix token, since checks in other places depend on it being\n\t\t\t\t\t\t\t\t// identified as SYM_COMMA. Using _alloca() inexplicably produces somewhat smaller\n\t\t\t\t\t\t\t\t// code than setting it up like token_begin, at least at the time of this comment.\n\t\t\t\t\t\t\t\tExprTokenType *missing = (ExprTokenType *)_alloca(sizeof(ExprTokenType));\n\t\t\t\t\t\t\t\tmissing->symbol = SYM_MISSING;\n\t\t\t\t\t\t\t\tpostfix[postfix_count++] = missing;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tin_param_list->param_count += num_blank_params;\n\t\t\t\t\t\t\t// Go back to the top to update the this_postfix ref.\n\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// Since above didn't \"continue\", the last blank parameter is at the end of the list (and that's\n\t\t\t\t\t\t// terminated with the correct symbol), so there's no need to put anything in postfix or adjust\n\t\t\t\t\t\t// param_count. this_infix has already been adjusted to discard the blank parameters.\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\t// This is SYM_COMMA or SYM_CPAREN/BRACKET/BRACE at the end of a parameter.\n\t\t\t\t\t\t++in_param_list->param_count;\n\n\t\t\t\t\t\tif (stack_symbol == SYM_OBRACE && (in_param_list->param_count & 1)) // i.e. an odd number of parameters, which means no \"key:\" was specified.\n\t\t\t\t\t\t\treturn LineError(_T(\"Missing \\\"propertyname:\\\" in object literal.\"));\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (infix_symbol == SYM_COMMA)\n\t\t\t{\n\t\t\t\tif (!in_param_list) // This comma separates statements rather than function parameters.\n\t\t\t\t{\n\t\t\t\t\tif (postfix_count && postfix[postfix_count - 1]->symbol == SYM_FUNC)\n\t\t\t\t\t\tpostfix[postfix_count - 1]->callsite->flags |= EIF_UNSET_RETURN;\n\t\t\t\t\t// Put this comma immediately into postfix so that when it is encountered at\n\t\t\t\t\t// run-time, it will pop and discard the result of its left-hand sub-statement.\n\t\t\t\t\tthis_postfix = this_infix++;\n\t\t\t\t\t++postfix_count;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\t// It's a function comma, so don't put it in stack or postfix because parameters need\n\t\t\t\t// to be pushed sequentially onto the stack and left there until SYM_FUNC pops them off.\n\t\t\t\t++this_infix;\n\t\t\t}\n\t\t\telse if (stack_symbol == SYM_OPAREN)\n\t\t\t{\n\t\t\t\t++this_infix; // Since this pair of parentheses is done, move on to the next token in the infix expression.\n\t\t\t\t--stack_count; // Remove this open-paren from the stack, since it is now complete.\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tthis_infix->callsite = in_param_list; // For SYM_MAYBE.\n\t\t\t\t++this_infix;\n\t\t\t\tstack[stack_count - 1]->symbol = SYM_FUNC; // In case it was SYM_OBRACKET or SYM_OBRACE.\n\t\t\t\tgoto standard_pop_into_postfix; // Pop the token (now SYM_FUNC) into the postfix array to immediately follow its params.\n\t\t\t}\n\t\t\tbreak;\n\t\t}\n\n\t\tcase SYM_FUNC:\n\t\t\t// Normal function calls are handled by case SYM_OPAREN; this one handles some misc. cases\n\t\t\t// like x.y(), x.%y%() and IsSet().\n\t\t\tSTACK_PUSH(this_infix++);\n\t\t\tASSERT(this_infix->symbol == SYM_OPAREN);\n\t\t\tthis_infix++;\n\t\t\tbreak;\n\n\t\tcase SYM_OPAREN:\n\t\t\t// Each open-parenthesis goes on the stack to await its matching close-parenthesis,\n\t\t\t// unless it belongs to a function call, in which case SYM_FUNC goes on the stack.\n\t\t\tif (this_infix > infix && YIELDS_AN_OPERAND(this_infix[-1].symbol)\n\t\t\t\t&& *this_infix->marker == '(') // i.e. it's not an implicit SYM_OPAREN generated by DT_STRING.\n\t\t\t{\n\t\t\t\t// this_infix[-1] is the object to be called (or an error).\n\t\t\t\tauto token = (ExprTokenType *)_alloca(sizeof(ExprTokenType)); // Reusing this_infix breaks validation for IS_PREFIX_OPERATOR(infix_symbol).\n\t\t\t\ttoken->symbol = SYM_FUNC;\n\t\t\t\ttoken->callsite = new CallSite();\n\t\t\t\tif (!token->callsite)\n\t\t\t\t\treturn LineError(ERR_OUTOFMEM);\n\t\t\t\ttoken->error_reporting_marker = this_infix->error_reporting_marker;\n\t\t\t\tSTACK_PUSH(token);\n\t\t\t}\n\t\t\telse\n\t\t\t\tSTACK_PUSH(this_infix);\n\t\t\tthis_infix++;\n\t\t\tbreak;\n\t\t\t\n\t\tcase SYM_OBRACKET:\n\t\tcase SYM_OBRACE:\n\t\t\tSTACK_PUSH(this_infix++); // Push this '[' onto the stack to await its ']'.\n\t\t\tbreak;\n\n\t\tcase SYM_DOT: // x.y\n\t\t\tthis_infix->symbol = SYM_FUNC;\n\t\t\tSTACK_PUSH(this_infix++);\n\t\t\tgoto standard_pop_into_postfix; // Pop it into postfix to immediately follow its operands.\n\n\t\tcase SYM_IFF_ELSE: // i.e. this infix symbol is ':'.\n\t\t\tif (stack_symbol == SYM_OBRACE)\n\t\t\t{\n\t\t\t\t// This should be the end of a property name in something like {x: y}.\n\t\t\t\tif (postfix_count)\n\t\t\t\t{\n\t\t\t\t\tLPCTSTR cp;\n\t\t\t\t\tswitch (postfix[postfix_count - 1]->symbol)\n\t\t\t\t\t{\n\t\t\t\t\tcase SYM_DYNAMIC:\n\t\t\t\t\t\t// This is the end of a dynamic property name in something like {%x%: y}.\n\t\t\t\t\t\tpostfix_count--;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase SYM_STRING:\n\t\t\t\t\t\t// Is this a quoted string (invalid here) or unquoted property name?\n\t\t\t\t\t\tfor (cp = this_infix->error_reporting_marker - 1; IS_SPACE_OR_TAB(*cp); --cp);\n\t\t\t\t\t\tif (IS_IDENTIFIER_CHAR(*cp))\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\treturn LineError(_T(\"Invalid property name in object literal.\"));\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t++stack[stack_count - 1]->callsite->param_count;\n\t\t\t\t++this_infix;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tif (stack_symbol == SYM_OPAREN || stack_symbol == SYM_OBRACKET || stack_symbol == SYM_BEGIN)\n\t\t\t\treturn LineError(_T(\"Unexpected \\\":\\\"\")); // () and [] were already balanced by GetLineContExpr(), so the colon seems to be what is out of place. Also, don't refer to ')' since it might be a function call statement.\n\t\t\t// Otherwise:\n\t\t\tif (stack_symbol == SYM_IFF_THEN) // See comments near the bottom of this case. The first found \"THEN\" on the stack must be the one that goes with this \"ELSE\".\n\t\t\t{\n\t\t\t\t// An earlier stage put THEN directly into the postfix array before also pushing it onto the stack.\n\t\t\t\t// Pop this THEN off the stack and point it at its ELSE, but don't write it into postfix again:\n\t\t\t\tSTACK_POP->circuit_token = this_infix;\n\t\t\t\t// Since this ELSE also marks the end of the THEN branch, write it to postfix (in place of the above)\n\t\t\t\t// so that after the THEN branch is evaluated it will hit this ELSE and skip over the ELSE branch:\n\t\t\t\tthis_postfix = this_infix;\n\t\t\t\t++postfix_count;\n\t\t\t\t// Also push this ELSE onto the stack. Once the end of branch is found, ELSE will be popped off the\n\t\t\t\t// stack, updated to point to the end of the ELSE branch and not written to postfix a second time:\n\t\t\t\tSTACK_PUSH(this_infix++);\n\t\t\t\t// Above also increments this_infix: this ELSE found its matching IF/THEN, so it's time to move on to the next token in the infix expression.\n\t\t\t}\n\t\t\telse // This stack item is an operator, possibly even some other THEN's ELSE (all such ELSE's should be purged from the stack to properly support nested ternary).\n\t\t\t{\n\t\t\t\t// By not incrementing this_infix, the loop will continue to encounter SYM_IFF_ELSE and thus\n\t\t\t\t// continue to pop things off the stack until the corresponding SYM_IFF_THEN is reached.\n\t\t\t\tgoto standard_pop_into_postfix;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase SYM_INVALID:\n\t\t\tASSERT(!IS_OPAREN_LIKE(stack_symbol)); // GetLineContExpr()/BalanceExpr() ensures this won't happen.\n\t\t\tif (stack_symbol == SYM_BEGIN) // Stack is basically empty, so stop the loop.\n\t\t\t{\n\t\t\t\t--stack_count; // Remove SYM_BEGIN from the stack, leaving the stack empty for use in postfix eval.\n\t\t\t\tgoto end_of_infix_to_postfix; // Both infix and stack have been fully processed, so the postfix expression is now completely built.\n\t\t\t}\n\t\t\telse // Pop item off the stack, AND CONTINUE ITERATING, which will hit this line until stack is empty.\n\t\t\t\tgoto standard_pop_into_postfix;\n\t\t\t// ALL PATHS ABOVE must continue or goto.\n\t\t\t\n\t\tcase SYM_MULTIPLY:\n\t\t\tif (this_infix[1].symbol == SYM_CPAREN || this_infix[1].symbol == SYM_CBRACKET) // Func(params*) or obj.foo[params*]\n\t\t\t{\n\t\t\t\t// Balancing done by GetLineContExpr()/BalanceExpr() ensures there is a matching FUNC/OPAREN/OBRACKET,\n\t\t\t\t// which must be still on the stack at this point.\n\t\t\t\tASSERT(stack_symbol != SYM_BEGIN);\n\t\t\t\tif (!IS_OPAREN_LIKE(stack_symbol) && stack_symbol != SYM_FUNC)\n\t\t\t\t\tgoto standard_pop_into_postfix;\n\t\t\t\tif (stack_symbol == SYM_OPAREN) // Non-function parentheses.\n\t\t\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, this_infix->error_reporting_marker);\n\t\t\t\tstack[stack_count - 1]->callsite->is_variadic(true);\n\t\t\t\t++this_infix;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// DO NOT BREAK: FALL THROUGH TO BELOW\n\n\t\tdefault: // This infix symbol is an operator, so act according to its precedence.\n\t\t\t// If the symbol waiting on the stack has a lower precedence than the current symbol, push the\n\t\t\t// current symbol onto the stack so that it will be processed sooner than the waiting one.\n\t\t\t// Otherwise, pop waiting items off the stack (by means of i not being incremented) until their\n\t\t\t// precedence falls below the current item's precedence, or the stack is emptied.\n\t\t\t// Note: BEGIN and OPAREN are the lowest precedence items ever to appear on the stack (CPAREN\n\t\t\t// never goes on the stack, so can't be encountered there).\n\t\t\tif ( sPrecedence[stack_symbol] < sPrecedence[infix_symbol] + (sPrecedence[infix_symbol] % 2) // Performance: An sPrecedence2[] array could be made in lieu of the extra add+indexing+modulo, but it benched only 0.3% faster, so the extra code size it caused didn't seem worth it.\n\t\t\t\t|| IS_ASSIGNMENT_EXCEPT_POST_AND_PRE(infix_symbol) // See note 1 below. Ordered for short-circuit performance.\n\t\t\t\t|| stack_symbol == SYM_POWER && SYM_OVERRIDES_POWER_ON_STACK(infix_symbol) ) // See note 2 below.\n\t\t\t{\n\t\t\t\t// NOTE 1: v1.0.46: The IS_ASSIGNMENT_EXCEPT_POST_AND_PRE line above was added in conjunction with\n\t\t\t\t// the new assignment operators (e.g. := and +=). Here's what it does: Normally, the assignment\n\t\t\t\t// operators have the lowest precedence of all (except for commas) because things that lie\n\t\t\t\t// to the *right* of them in the infix expression should be evaluated first to be stored\n\t\t\t\t// as the assignment's result. However, if what lies to the *left* of the assignment\n\t\t\t\t// operator isn't a valid lvalue/variable (and not even a unary like -x can produce an lvalue\n\t\t\t\t// because they're not supposed to alter the contents of the variable), obeying the normal\n\t\t\t\t// precedence rules would be produce a syntax error due to \"assigning to non-lvalue\".\n\t\t\t\t// So instead, apply any pending operator on the stack (which lies to the left of the lvalue\n\t\t\t\t// in the infix expression) *after* the assignment by leaving it on the stack. For example,\n\t\t\t\t// C++ and probably other languages (but not the older ANSI C) evaluate \"true ? x:=1 : y:=1\"\n\t\t\t\t// as a pair of assignments rather than as who-knows-what (probably a syntax error if you\n\t\t\t\t// strictly followed precedence). Similarly, C++ evaluates \"true ? var1 : var2 := 3\" not as\n\t\t\t\t// \"(true ? var1 : var2) := 3\" (like ANSI C) but as \"true ? var1 : (var2 := 3)\". Other examples:\n\t\t\t\t// -> not var:=5 ; It's evaluated contrary to precedence as: not (var:=5) [PHP does this too,\n\t\t\t\t// and probably others]\n\t\t\t\t// -> 5 + var+=5 ; It's evaluated contrary to precedence as: 5 + (var+=5) [not sure if other\n\t\t\t\t// languages do ones like this]\n\t\t\t\t// -> ++i := 5 ; Silly since increment has no lasting effect; so assign the 5 then do the pre-inc.\n\t\t\t\t// -> ++i /= 5 ; Valid, but maybe too obscure and inconsistent to treat it differently than\n\t\t\t\t// the others (especially since not many people will remember that unlike i++, ++i produces\n\t\t\t\t// an lvalue); so divide by 5 then do the increment.\n\t\t\t\t// -> i++ := 5 (and i++ /= 5) ; Postfix operator can't produce an lvalue, so do the assignment\n\t\t\t\t// first and then the postfix op.\n\t\t\t\t// Also, SYM_FUNC seems unaffected by any of this due to its enclosing parentheses (i.e. even\n\t\t\t\t// if a function-call can someday generate an lvalue [SYM_VAR], the current rules probably\n\t\t\t\t// already support it.\n\t\t\t\t// Performance: Adding the above behavior reduced the expressions benchmark by only 0.6%; so\n\t\t\t\t// it seems worth it.\n\t\t\t\t//\n\t\t\t\t// NOTE 2: The SYM_POWER line above is a workaround to allow 2**-2 (and others in v1.0.45) to be\n\t\t\t\t// evaluated as 2**(-2) rather than being seen as an error. However, as of v1.0.46, consecutive\n\t\t\t\t// unary operators are supported via the right-to-left evaluation flag above (formerly, consecutive\n\t\t\t\t// unaries produced a failure [blank value]). For example:\n\t\t\t\t// !!x ; Useful to convert a blank value into a zero for use with uninitialized variables.\n\t\t\t\t// not not x ; Same as above.\n\t\t\t\t// Other examples: !-x, -!x, !&x, -&Var, ~&Var\n\t\t\t\t// And these deref ones (which worked even before v1.0.46 by different means: giving\n\t\t\t\t// '*' a higher precedence than the other unaries): !*Var, -*Var and ~*Var\n\t\t\t\t// !x ; Supported even if X contains a negative number, since x is recognized as an isolated operand and not something containing unary minus.\n\t\t\t\t//\n\n\t\t\t\t// Perform some rough checks to detect most syntax errors. This is done after the\n\t\t\t\t// precedence check so that it isn't done multiple times for a single token when\n\t\t\t\t// the stack contains one or more higher-precedence operators, and also so that\n\t\t\t\t// the left operand (if this is a binary operator) has been popped into postfix.\n\t\t\t\tsym_prev = this_infix > infix ? this_infix[-1].symbol : SYM_INVALID;\n\t\t\t\tsym_next = this_infix[1].symbol; // It will be SYM_INVALID if there are no more.\n\t\t\t\tSymbolType sym_postfix = postfix_count ? postfix[postfix_count-1]->symbol : SYM_INVALID;\n\t\t\t\tif (IS_ASSIGNMENT_OR_POST_OP(infix_symbol))\n\t\t\t\t{\n\t\t\t\t\t// Assignment and postfix operators must be preceded by a variable, except for\n\t\t\t\t\t// assignment operators which have a non-null callsite, indicating that the target\n\t\t\t\t\t// is an object's property. Postfix operators which apply to an object's property\n\t\t\t\t\t// are fully handled in the standard_pop_into_postfix section.\n\t\t\t\t\tif (this_infix->callsite) // Object property. Takes precedence over the next checks.\n\t\t\t\t\t{} // Nothing needed here.\n\t\t\t\t\telse if ((sym_postfix == SYM_VAR || sym_postfix == SYM_DYNAMIC) && postfix[postfix_count-1]->var_usage == VARREF_READ) // var_usage check excludes (var?) :=.\n\t\t\t\t\t\tpostfix[postfix_count-1]->var_usage = (infix_symbol == SYM_ASSIGN_MAYBE) ? VARREF_LVALUE_MAYBE : VARREF_LVALUE; // Mark this as the target of an assignment.\n\t\t\t\t\telse if (infix_symbol == SYM_ASSIGN_MAYBE || !IS_OPERATOR_VALID_LVALUE(sym_postfix))\n\t\t\t\t\t\treturn LineError(ERR_INVALID_ASSIGNMENT, FAIL, this_infix->error_reporting_marker);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// Prefix operators must not be preceded by an operand.\n\t\t\t\t\t// Binary operators must be preceded by an operand.\n\t\t\t\t\t// If sym_prev == SYM_FUNC, that can only be the result of SYM_DOT (x.y).\n\t\t\t\t\tif ((YIELDS_AN_OPERAND(sym_prev) || sym_prev == SYM_FUNC) == IS_PREFIX_OPERATOR(infix_symbol))\n\t\t\t\t\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, this_infix->error_reporting_marker);\n\t\t\t\t\t// If it's pre-increment/decrement, looking to the right in infix is insufficient.\n\t\t\t\t\t// For cases like ++this.x, we must wait until the operator is popped from the stack.\n\t\t\t\t}\n\t\t\t\tif (!IS_POSTFIX_OPERATOR(infix_symbol))\n\t\t\t\t{\n\t\t\t\t\t// Prefix and binary operators must be followed by an operand.\n\t\t\t\t\tif ( !(IS_OPERAND(sym_next)\n\t\t\t\t\t\t || sym_next == SYM_FUNC\n\t\t\t\t\t\t || IS_OPAREN_LIKE(sym_next)\n\t\t\t\t\t\t || IS_PREFIX_OPERATOR(sym_next)) )\n\t\t\t\t\t\treturn LineError(ERR_EXPR_MISSING_OPERAND, FAIL, this_infix->error_reporting_marker);\n\t\t\t\t}\n\n\t\t\t\tif (infix_symbol == SYM_ASSIGN_MAYBE)\n\t\t\t\t{\n\t\t\t\t\t// Handle the ?? part of ??= by inserting it into postfix immediately and pointing\n\t\t\t\t\t// it at this assignment (evaluation resumes at the token after circuit_token).\n\t\t\t\t\tthis_postfix = (ExprTokenType *)_alloca(sizeof(ExprTokenType));\n\t\t\t\t\tthis_postfix->symbol = SYM_OR_MAYBE;\n\t\t\t\t\tthis_postfix->error_reporting_marker = this_infix->error_reporting_marker; // FinalizeExpression relies on this.\n\t\t\t\t\tthis_postfix->circuit_token = this_infix;\n\t\t\t\t\t++postfix_count;\n\t\t\t\t\tthis_infix->symbol = SYM_ASSIGN; // This might be changed again in standard_pop_into_postfix.\n\t\t\t\t}\n\t\t\t\telse if (IS_SHORT_CIRCUIT_OPERATOR(infix_symbol))\n\t\t\t\t{\n\t\t\t\t\tif (infix_symbol == SYM_OR_MAYBE || infix_symbol == SYM_MAYBE)\n\t\t\t\t\t{\n\t\t\t\t\t\tbool applied = this_infix->circuit_token != nullptr;\n\t\t\t\t\t\tif (applied)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tbool literal_unset = this_infix->circuit_token->symbol == SYM_MISSING;\n\t\t\t\t\t\t\tthis_infix->circuit_token = nullptr; // Reset for next phase.\n\t\t\t\t\t\t\tif (literal_unset)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tif (this_infix[1].symbol != SYM_MAYBE) // Not `unset?`\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t// Don't put it into postfix, because it's not allowed to short-circuit.\n\t\t\t\t\t\t\t\t\tSTACK_PUSH(this_infix++);\n\t\t\t\t\t\t\t\t\tgoto standard_pop_into_postfix;\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\tthis_infix++; // Discard the first SYM_MAYBE so error_reporting_marker will point to '?'.\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (sym_prev == SYM_VAR || sym_prev == SYM_DYNAMIC)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tthis_infix[-1].var_usage = VARREF_READ_MAYBE;\n\t\t\t\t\t\t\t\tapplied = true;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\telse if (sym_prev == SYM_FUNC) // x.y?\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tthis_infix[-1].callsite->flags |= EIF_UNSET_RETURN | EIF_UNSET_PROP;\n\t\t\t\t\t\t\t\tapplied = true;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\telse if ((sym_prev == SYM_CPAREN || sym_prev == SYM_CBRACKET) && this_infix[-1].callsite) // x()?, x[]?, x.y[z]?, x?.[]?\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tthis_infix[-1].callsite->flags |= EIF_UNSET_RETURN;\n\t\t\t\t\t\t\t\tapplied = true;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (!applied)\n\t\t\t\t\t\t\treturn LineError(_T(\"Unexpected \\\"?\\\"\"), FAIL, this_infix->error_reporting_marker);\n\t\t\t\t\t}\n\t\t\t\t\t// Short-circuit boolean evaluation works as follows:\n\t\t\t\t\t//\n\t\t\t\t\t// When an AND/OR/IFF is encountered in infix, it is immediately put into postfix to act as a\n\t\t\t\t\t// unary operator on its left operand and something like a conditional jump instruction. It is\n\t\t\t\t\t// also pushed onto the stack so that the end of its right branch can be found in accordance with\n\t\t\t\t\t// precedence rules; when it is popped off the stack, circuit_token is set to the last token in\n\t\t\t\t\t// postfix at that point, which is necessarily the end of the operator's right branch.\n\t\t\t\t\t//\n\t\t\t\t\t// x AND y\n\t\t\t\t\t// x OR y\n\t\t\t\t\t// x IFF_THEN y IFF_ELSE z\n\t\t\t\t\t//\n\t\t\t\t\t// AND/OR: Pop operand off stack. If short-circuit condition is satified, push the operand back\n\t\t\t\t\t// onto the stack and jump over the operator's right branch; otherwise simply continue, allowing\n\t\t\t\t\t// the right branch to be evaluated and its result used as the overall result of the AND/OR.\n\t\t\t\t\t//\n\t\t\t\t\t// IFF_THEN: Pop operand off stack. If false, jump to the \"else\" branch; otherwise continue.\n\t\t\t\t\t// IFF_ELSE: Encountered only after evaluating the \"then\" branch; jumps over the \"else\" branch.\n\t\t\t\t\t//\n\t\t\t\t\t// This new approach has the following benefits over the old approach:\n\t\t\t\t\t// 1) circuit_token doesn't need to be checked every time a value is pushed onto the stack.\n\t\t\t\t\t// 2) circuit_token doesn't need to propagate from an operator or function-call to its result.\n\t\t\t\t\t// 3) Cascading of short-circuit operators does not need to be handled specifically\n\t\t\t\t\t// as it is naturally supported via infix-to-postfix conversion.\n\t\t\t\t\t// 4) Since circuit_token is only needed in the actual operators, it can overlap with\n\t\t\t\t\t// the value fields -- i.e. the size of ExprTokenType may be reduced (assuming\n\t\t\t\t\t// the other uses of circuit_token can be eliminated).\n\t\t\t\t\t//\n\t\t\t\t\t// OBSOLETE COMMENTS:\n\t\t\t\t\t// To facilitate short-circuit boolean evaluation, right before an AND/OR/IFF is pushed onto the\n\t\t\t\t\t// stack, point the end of it's left branch to it. Note that the following postfix token\n\t\t\t\t\t// can itself be of type AND/OR/IFF, a simple example of which is \"if (true and true and true)\",\n\t\t\t\t\t// in which the first and's parent (in an imaginary tree) is the second \"and\".\n\t\t\t\t\t// But how is it certain that this is the final operator or operand of and AND/OR/IFF's left branch?\n\t\t\t\t\t// Here is the explanation:\n\t\t\t\t\t// Everything higher precedence than the AND/OR/IFF came off the stack right before it, resulting in\n\t\t\t\t\t// what must be a balanced/complete sub-postfix-expression in and of itself (unless the expression\n\t\t\t\t\t// has a syntax error, which is caught in various places). Because it's complete, during the\n\t\t\t\t\t// postfix evaluation phase, that sub-expression will result in a new operand for the stack,\n\t\t\t\t\t// which must then be the left side of the AND/OR/IFF because the right side immediately follows it\n\t\t\t\t\t// within the postfix array, which in turn is immediately followed its operator (namely AND/OR/IFF).\n\t\t\t\t\t// Also, the final result of an IFF's condition-branch must point to the IFF/THEN symbol itself\n\t\t\t\t\t// because that's the means by which the condition is merely \"checked\" rather than becoming an\n\t\t\t\t\t// operand itself.\n\t\t\t\t\t//\n\t\t\t\t\tthis_postfix = this_infix;\n\t\t\t\t\t++postfix_count;\n\t\t\t\t}\n\t\t\t\tSTACK_PUSH(this_infix++); // Push this_infix onto the stack and move rightward to the next infix item.\n\t\t\t}\n\t\t\telse // Stack item's precedence >= infix's (if equal, left-to-right evaluation order is in effect).\n\t\t\t\tgoto standard_pop_into_postfix;\n\t\t} // switch(infix_symbol)\n\n\t\tcontinue; // Avoid falling into the label below except via explicit jump. Performance: Doing it this way rather than replacing break with continue everywhere above generates slightly smaller and slightly faster code.\nstandard_pop_into_postfix: // Use of a goto slightly reduces code size.\n\t\tthis_postfix = STACK_POP;\n\t\t// Additional processing for short-circuit evaluation and syntax sugar:\n\t\tSymbolType postfix_symbol = this_postfix->symbol;\n\t\tswitch (postfix_symbol)\n\t\t{\n\t\tcase SYM_LOW_CONCAT:\n\t\t\t// Now that operator precedence has been fully handled, change the symbol to simplify runtime evaluation.\n\t\t\tthis_postfix->symbol = SYM_CONCAT;\n\t\t\tbreak;\n\n\t\tcase SYM_FUNC:\n\t\t\tinfix_symbol = this_infix->symbol;\n\t\t\t// The sections below pre-process assignments to work with objects:\n\t\t\t//\tx.y := z\t->\tx \"y\" z (set)\n\t\t\t//\tx[y] += z\t->\tx y (get in-place, assume 2 params) z (add) (set)\n\t\t\t//\tx.y[i] /= z\t->\tx \"y\" i 3 (get in-place, n params) z (div) (set)\n\t\t\tif ((this_postfix->callsite->flags & IT_BITMASK) == IT_GET\n\t\t\t\t&& stack_symbol != SYM_MAYBE && infix_symbol != SYM_MAYBE) // Exclude x?.y++ and ++x.y? to provide a better error message.\n\t\t\t{\n\t\t\t\tif (IS_ASSIGNMENT_EXCEPT_POST_AND_PRE(infix_symbol))\n\t\t\t\t{\n\t\t\t\t\tauto callsite = this_postfix->callsite; // To be reused below.\n\t\t\t\t\tif (infix_symbol != SYM_ASSIGN)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Give it a new callsite since the original one will be reused below\n\t\t\t\t\t\t// (so that there's no redundant allocation for the SYM_ASSIGN case).\n\t\t\t\t\t\tthis_postfix->callsite = new CallSite();\n\t\t\t\t\t\tthis_postfix->callsite->flags\t\t= callsite->flags | EIF_LEAVE_PARAMS;\n\t\t\t\t\t\tthis_postfix->callsite->member\t\t= callsite->member;\n\t\t\t\t\t\tthis_postfix->callsite->param_count\t= callsite->param_count;\n\t\t\t\t\t\tif (infix_symbol == SYM_ASSIGN_MAYBE)\n\t\t\t\t\t\t\tthis_postfix->callsite->flags |= callsite->param_count ? EIF_UNSET_RETURN : (EIF_UNSET_RETURN | EIF_UNSET_PROP);\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\t--postfix_count; // Discard this token; the assignment op will be converted into SYM_FUNC later.\n\t\t\t\t\t}\n\t\t\t\t\tcallsite->flags = IT_SET | (callsite->flags & ~IT_GET);\n\t\t\t\t\tcallsite->param_count++; // Include the value to be assigned.\n\t\t\t\t\tthis_infix->callsite = callsite;\n\t\t\t\t\t// Now let this_infix be processed by the next iteration, and eventually\n\t\t\t\t\t// have its symbol changed to SYM_FUNC.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tstack_symbol = stack[stack_count - 1]->symbol;\n\t\t\t\t\t// Post-increment/decrement has higher precedence, so check for it first:\n\t\t\t\t\tbool is_post_op = (infix_symbol == SYM_POST_INCREMENT || infix_symbol == SYM_POST_DECREMENT);\n\t\t\t\t\tif ( is_post_op\n\t\t\t\t\t\t|| infix_symbol != SYM_DOT && infix_symbol != SYM_OPAREN // Do not apply the \"++\" to the \"x.y\" part of \"++x.y.z\" (SYM_DOT) or \"++x.y.%z%\" (SYM_OPAREN).\n\t\t\t\t\t\t\t&& infix_symbol != SYM_OBRACKET // or the \"x.y\" in \"x.y[z]\", or \"x[y]\" in \"x[y][z]\".\n\t\t\t\t\t\t&& (stack_symbol == SYM_PRE_INCREMENT || stack_symbol == SYM_PRE_DECREMENT) )\n\t\t\t\t\t{\n\t\t\t\t\t\tauto get_token = this_postfix;\n\t\t\t\t\t\tauto get_callsite = get_token->callsite;\n\t\t\t\t\t\t\n\t\t\t\t\t\tauto error_marker = (is_post_op ? this_infix : stack[stack_count-1])->error_reporting_marker;\n\n\t\t\t\t\t\tauto set_callsite = new CallSite();\n\t\t\t\t\t\tset_callsite->member = get_callsite->member;\n\t\t\t\t\t\tset_callsite->flags = IT_SET | (get_callsite->flags & ~IT_GET);\n\t\t\t\t\t\tset_callsite->param_count = get_callsite->param_count + 1;\n\t\t\t\t\t\t\n\t\t\t\t\t\tget_callsite->flags |= EIF_LEAVE_PARAMS;\n\n\t\t\t\t\t\tbool is_increment = is_post_op ? infix_symbol == SYM_POST_INCREMENT\n\t\t\t\t\t\t\t: stack_symbol == SYM_PRE_INCREMENT;\n\t\t\t\t\t\t// Drop the pre/post operator since it's fully handled here, but reuse the token:\n\t\t\t\t\t\tauto n_token = is_post_op ? this_infix++ : stack[--stack_count];\n\t\t\t\t\t\tn_token->SetValue(is_increment ? 1 : -1);\n\n\t\t\t\t\t\tpostfix[postfix_count + 1] = n_token;\n\t\t\t\t\t\tpostfix[postfix_count + 2] = (ExprTokenType *)_alloca(sizeof(ExprTokenType));\n\t\t\t\t\t\tpostfix[postfix_count + 2]->symbol = SYM_ADD;\n\t\t\t\t\t\tpostfix[postfix_count + 2]->error_reporting_marker = error_marker;\n\t\t\t\t\t\tpostfix[postfix_count + 3] = (ExprTokenType *)_alloca(sizeof(ExprTokenType));\n\t\t\t\t\t\tpostfix[postfix_count + 3]->symbol = SYM_FUNC;\n\t\t\t\t\t\tpostfix[postfix_count + 3]->callsite = set_callsite;\n\t\t\t\t\t\tpostfix[postfix_count + 3]->error_reporting_marker = error_marker;\n\t\t\t\t\t\tif (is_post_op)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// Subtract from the result to get back to the original value.\n\t\t\t\t\t\t\tpostfix[postfix_count + 4] = n_token;\n\t\t\t\t\t\t\tpostfix[postfix_count + 5] = (ExprTokenType *)_alloca(sizeof(ExprTokenType));\n\t\t\t\t\t\t\tpostfix[postfix_count + 5]->symbol = SYM_SUBTRACT;\n\t\t\t\t\t\t\tpostfix[postfix_count + 5]->error_reporting_marker = error_marker;\n\t\t\t\t\t\t\tpostfix_count += 5; // Account for the extra tokens; a final ++ is done below.\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tpostfix_count += 3;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if ((this_postfix->callsite->flags & IT_BITMASK) == IT_CALL)\n\t\t\t{\n\t\t\t\tif (this_postfix->callsite->param_count == 1 && this_postfix->callsite->func == sIsSetFunc)\n\t\t\t\t{\n\t\t\t\t\tauto &last_postfix = *postfix[postfix_count - 1];\n\t\t\t\t\tif (last_postfix.symbol == SYM_VAR || last_postfix.symbol == SYM_DYNAMIC)\n\t\t\t\t\t{\n\t\t\t\t\t\tlast_postfix.var_usage = VARREF_ISSET;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tif (last_postfix.symbol == SYM_ASSIGN)\n\t\t\t\t\t{\n\t\t\t\t\t\tauto &left_of_assign = (&last_postfix)[-1];\n\t\t\t\t\t\tif ((left_of_assign.symbol == SYM_VAR || left_of_assign.symbol == SYM_DYNAMIC) && left_of_assign.var_usage == VARREF_LVALUE)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tleft_of_assign.var_usage = VARREF_LVALUE_ISSET;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\treturn LineError(_T(\"IsSet requires a variable.\"), FAIL, this_postfix->error_reporting_marker);\n\t\t\t\t}\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase SYM_REGEXMATCH: // a ~= b -> RegExMatch(a, b)\n\t\t\tthis_postfix->symbol = SYM_FUNC;\n\t\t\tbreak;\n\n\t\tcase SYM_AND:\n\t\tcase SYM_OR:\n\t\tcase SYM_OR_MAYBE:\n\t\tcase SYM_IFF_ELSE:\n\t\t{\n\t\t\t// Point this short-circuit operator to the end of its right operand.\n\t\t\tExprTokenType *iff_end = postfix[postfix_count - 1];\n\t\t\tif (this_postfix == iff_end) // i.e. the last token is the operator itself.\n\t\t\t\treturn LineError(ERR_EXPR_MISSING_OPERAND, FAIL, this_postfix->error_reporting_marker);\n\t\t\t// Point the original token already in postfix to the end of its right branch:\n\t\t\tthis_postfix->circuit_token = iff_end;\n\t\t\tcontinue; // This token was already put into postfix by an earlier stage, so skip it this time.\n\t\t}\n\t\tcase SYM_IFF_THEN:\n\t\t\treturn LineError(_T(\"Unexpected \\\"?\\\"\"), FAIL, this_postfix->marker);\n\t\t\n\t\tcase SYM_MAYBE:\n\t\t{\n\t\t\tExprTokenType *chain_end = this_postfix->circuit_token;\n\t\t\tif (!chain_end)\n\t\t\t{\n\t\t\t\t// This SYM_MAYBE is being popped for the first time, so this is the end of the optional chain\n\t\t\t\t// (but not necessarily the final jump target).\n\t\t\t\tthis_postfix->circuit_token = chain_end = postfix[postfix_count - 1];\n\t\t\t\tif (this_postfix == chain_end) // i.e. postfix[postfix_count] == postfix[postfix_count-1]\n\t\t\t\t\tpostfix_count--; // Nothing to short-circuit, so remove it from postfix.\n\t\t\t}\n\t\t\t// Work out where an unset value would end up, and whether it is valid.\n\t\t\tauto inf = this_infix;\n\t\t\tauto stk = stack + stack_count - 1;\n\t\t\tfor (;;)\n\t\t\t{\n\t\t\t\tstack_symbol = (*stk)->symbol;\n\t\t\t\tinfix_symbol = inf->symbol;\n\t\t\t\tif (IS_CPAREN_LIKE(infix_symbol))\n\t\t\t\t{\n\t\t\t\t\tif (stack_symbol == SYM_OPAREN) // We provide the result of (...).\n\t\t\t\t\t{\n\t\t\t\t\t\tinf++, stk--;\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\tif (stack_symbol == SYM_IFF_ELSE) // We provide the result of the false branch.\n\t\t\t\t\t{\n\t\t\t\t\t\tstk--;\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (SYM_MAYBE_IGNORES_ON_STACK(stack_symbol)) // We're in the RHS, so not actually input to the operator.\n\t\t\t\t{\n\t\t\t\t\tstk--; // Unset would pass through to the next item on the stack.\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (infix_symbol == SYM_IFF_ELSE) // The false branch will immediately follow, so may as well short-circuit that too.\n\t\t\t{\n\t\t\t\tif (stack_symbol == SYM_IFF_THEN)\n\t\t\t\t{\n\t\t\t\t\t// Insert MAYBE above IFF_THEN, to locate end of branch.\n\t\t\t\t\tfor (auto mov = stack + stack_count++; mov > stk; --mov)\n\t\t\t\t\t\tmov[0] = mov[-1];\n\t\t\t\t\t*stk = this_postfix;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (IS_CPAREN_LIKE(infix_symbol) || infix_symbol == SYM_COMMA)\n\t\t\t{\n\t\t\t\tif (stack_symbol == SYM_FUNC && this_postfix < chain_end)\n\t\t\t\t\treturn LineError(_T(\"This unset expression requires a final \\\"?\\\" or \\\"??\\\".\"), FAIL, this_postfix->error_reporting_marker);\n\t\t\t}\n\t\t\telse if (infix_symbol == SYM_OR_MAYBE || infix_symbol == SYM_MAYBE) // SYM_MAYBE is right-associative, so found in infix_symbol only due to parentheses; e.g. ((a?.b)?)\n\t\t\t{\n\t\t\t\tinf->circuit_token = this_postfix; // Just as a way to flag it as having had an effect.\n\t\t\t\tstack_symbol = SYM_MAYBE; // Ignore the stack; it's not relevant until the entire maybe chain has been processed.\n\t\t\t}\n\t\t\telse if (infix_symbol == SYM_INVALID) // End of expression.\n\t\t\t{\n\t\t\t\tif (stack_symbol == SYM_BEGIN)\n\t\t\t\t{\n\t\t\t\t\t// Action types not permitted:\n\t\t\t\t\t// ACT_HOTKEY_IF is optional but must be boolean, not unset.\n\t\t\t\t\t// ACT_LOOP can't distinguish between unset and \"\" (which is equivalent to 0).\n\t\t\t\t\t// ACT_LOOP_* can be supported easily enough, but it's also easy to do ?? \"\" or similar.\n\t\t\t\t\t// ACT_SWITCH/ACT_CASE: unclear whether an unset case should be \"omitting\" or\n\t\t\t\t\t// compared to the switch value. There would be no difference when the switch\n\t\t\t\t\t// value is not `unset` and has no `?`, but there's also the issue of consistency\n\t\t\t\t\t// with equality operators and the overall concept of unset.\n\t\t\t\t\t// ACT_FOR could skip enumeration when unset (like `?? (*)=> false` or `?? []`).\n\t\t\t\t\t// ACT_IF/WHILE/UNTIL should not treat unset as false.\n\t\t\t\t\t// It's also easier to remember if only `return` and `:=` permit unset, and less likely\n\t\t\t\t\t// to cause issues due to the ambiguity of `?`; e.g. `for x in y? {` could technically\n\t\t\t\t\t// be ternary with an object literal, and it currently works that way.\n\t\t\t\t\t// If this is ever changed, it should probably require this_postfix >= chain_end\n\t\t\t\t\t// when `?` is used in the sense of \"omit the parameter\".\n\t\t\t\t\tif ( !(mActionType == ACT_RETURN || mActionType == ACT_EXPRESSION || mActionType == ACT_ASSIGNEXPR || mActionType == ACT_STATIC) )\n\t\t\t\t\t\treturn LineError(_T(\"This statement's parameters cannot be unset.\"), FAIL, this_postfix->error_reporting_marker);\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (IS_ASSIGNMENT_OR_POST_OP(infix_symbol))\n\t\t\t\t//continue; // Relying on the assignment's own error-checking is insufficient for (x := unset) := y.\n\t\t\t\treturn LineError(ERR_INVALID_ASSIGNMENT, FAIL, inf->error_reporting_marker);\n\t\t\telse if ( !((infix_symbol == SYM_FUNC || infix_symbol == SYM_DOT) && (inf->callsite->flags & EIF_STACK_MEMBER)) ) // x.%a?.b%\n\t\t\t\treturn LineError(_T(\"This operator's left operand must not be unset.\"), FAIL, infix_symbol == SYM_DYNAMIC ? inf->marker : inf->error_reporting_marker);\n\t\t\tif (stack_symbol == SYM_PRE_INCREMENT || stack_symbol == SYM_PRE_DECREMENT\n\t\t\t\t|| stack_symbol == SYM_POST_INCREMENT || stack_symbol == SYM_POST_DECREMENT)\n\t\t\t\treturn LineError(ERR_INVALID_ASSIGNMENT, FAIL, (*stk)->error_reporting_marker);\n\t\t\tif ( !(stack_symbol == SYM_FUNC || stack_symbol == SYM_MAYBE\n\t\t\t\t|| IS_OPAREN_LIKE(stack_symbol) || stack_symbol == SYM_BEGIN\n\t\t\t\t|| stack_symbol == SYM_REF && (stk < stack + stack_count - 1) && stk[1]->symbol == SYM_ASSIGN) )\n\t\t\t\treturn LineError(_T(\"This operator's right operand must not be unset.\"), FAIL, (*stk)->error_reporting_marker);\n\t\t\tthis_postfix->circuit_token = postfix[postfix_count - 1]; // Update the final jump target (has no effect unless chain_end is followed by the else branch of a ternary).\n\t\t\t// For each MAYBE at the top of the stack, pop it off and update its jump target too.\n\t\t\t// Since this MAYBE passed validation, so should those others; but they wouldn't pass\n\t\t\t// the function parameter check in a case like f(a?.b?). This fixes that.\n\t\t\twhile (stack[stack_count - 1]->symbol == SYM_MAYBE)\n\t\t\t\tstack[--stack_count]->circuit_token = postfix[postfix_count - 1];\n\t\t\tcontinue; // This token was already put into postfix by an earlier stage, so skip it this time.\n\t\t}\n\n\t\tcase SYM_REF:\n\t\t\tpostfix_symbol = postfix[postfix_count - 1]->symbol;\n\t\t\tif (postfix_symbol == SYM_VAR || postfix_symbol == SYM_DYNAMIC)\n\t\t\t\tpostfix[postfix_count - 1]->var_usage = VARREF_REF;\n\t\t\telse if (postfix_symbol == SYM_FUNC\n\t\t\t\t&& (postfix[postfix_count - 1]->callsite->flags & IT_BITMASK) == IT_GET\n\t\t\t\t&& postfix[postfix_count - 1]->callsite->param_count == 0) // &x.y\n\t\t\t{\n\t\t\t\t// Change { x, get y } to { x, 'y', call __Ref }\n\t\t\t\tauto callsite = postfix[postfix_count - 1]->callsite;\n\t\t\t\tthis_postfix->SetValue(callsite->member ? callsite->member : _T(\"__Item\"));\n\t\t\t\tcallsite->flags = IT_CALL | IF_BYPASS_METAFUNC;\n\t\t\t\tcallsite->member = _T(\"__Ref\");\n\t\t\t\tcallsite->param_count = 1;\n\t\t\t\tswap(this_postfix, postfix[postfix_count - 1]);\n\t\t\t}\n\t\t\telse if (!IS_OPERATOR_VALID_LVALUE(postfix_symbol))\n\t\t\t\treturn LineError(_T(\"\\\"&\\\" requires a variable.\"));\n\t\t\tbreak;\n\n\t\tcase SYM_PRE_INCREMENT:\n\t\tcase SYM_PRE_DECREMENT:\n\t\t\tif (postfix_count)\n\t\t\t{\n\t\t\t\tExprTokenType &target = *postfix[postfix_count - 1];\n\t\t\t\t// This is nearly identical to the section for assignments under \"if (IS_ASSIGNMENT_OR_POST_OP(infix_symbol))\":\n\t\t\t\tif ((target.symbol == SYM_VAR || target.symbol == SYM_DYNAMIC) && target.var_usage != VARREF_READ_MAYBE) // Exclude `++var?` (invalid).\n\t\t\t\t\ttarget.var_usage = VARREF_LVALUE; // Mark this as the target of an assignment.\n\t\t\t\telse if (!IS_OPERATOR_VALID_LVALUE(target.symbol))\n\t\t\t\t\treturn LineError(ERR_INVALID_ASSIGNMENT, FAIL, this_postfix->error_reporting_marker);\n\t\t\t}\n\t\t\tbreak;\n\n\t\tdefault:\n\t\t\tif (!IS_ASSIGNMENT_EXCEPT_POST_AND_PRE(postfix_symbol))\n\t\t\t\tbreak;\n\t\t\tif (this_postfix->callsite)\n\t\t\t{\n\t\t\t\t// An earlier iteration of the SYM_FUNC section above used callsite to mark this as an object assignment.\n\t\t\t\tExprTokenType *assign_op = this_postfix;\n\t\t\t\tif (postfix_symbol != SYM_ASSIGN) // e.g. += or .=\n\t\t\t\t{\n\t\t\t\t\tswitch (postfix_symbol)\n\t\t\t\t\t{\n\t\t\t\t\tcase SYM_ASSIGN_ADD:\t\t\t\t\tpostfix_symbol = SYM_ADD; break;\n\t\t\t\t\tcase SYM_ASSIGN_SUBTRACT:\t\t\t\tpostfix_symbol = SYM_SUBTRACT; break;\n\t\t\t\t\tcase SYM_ASSIGN_MULTIPLY:\t\t\t\tpostfix_symbol = SYM_MULTIPLY; break;\n\t\t\t\t\tcase SYM_ASSIGN_DIVIDE:\t\t\t\t\tpostfix_symbol = SYM_DIVIDE; break;\n\t\t\t\t\tcase SYM_ASSIGN_INTEGERDIVIDE:\t\t\tpostfix_symbol = SYM_INTEGERDIVIDE; break;\n\t\t\t\t\tcase SYM_ASSIGN_BITOR:\t\t\t\t\tpostfix_symbol = SYM_BITOR; break;\n\t\t\t\t\tcase SYM_ASSIGN_BITXOR:\t\t\t\t\tpostfix_symbol = SYM_BITXOR; break;\n\t\t\t\t\tcase SYM_ASSIGN_BITAND:\t\t\t\t\tpostfix_symbol = SYM_BITAND; break;\n\t\t\t\t\tcase SYM_ASSIGN_BITSHIFTLEFT:\t\t\tpostfix_symbol = SYM_BITSHIFTLEFT; break;\n\t\t\t\t\tcase SYM_ASSIGN_BITSHIFTRIGHT:\t\t\tpostfix_symbol = SYM_BITSHIFTRIGHT; break;\n\t\t\t\t\tcase SYM_ASSIGN_BITSHIFTRIGHT_LOGICAL:\tpostfix_symbol = SYM_BITSHIFTRIGHT_LOGICAL; break;\n\t\t\t\t\tcase SYM_ASSIGN_CONCAT:\t\t\t\t\tpostfix_symbol = SYM_CONCAT; break;\n\t\t\t\t\t}\n\t\t\t\t\t// Insert the concat or math operator before the assignment:\n\t\t\t\t\tthis_postfix = (ExprTokenType *)_alloca(sizeof(ExprTokenType));\n\t\t\t\t\tthis_postfix->symbol = postfix_symbol;\n\t\t\t\t\tpostfix[++postfix_count] = assign_op;\n\t\t\t\t}\n\t\t\t\tassign_op->symbol = SYM_FUNC; // An earlier stage already set up assign_op->callsite.\n\t\t\t}\n\t\t}\n\t\t++postfix_count;\n\t} // End of loop that builds postfix array from the infix array.\nend_of_infix_to_postfix:\n\n\tif (!postfix_count) // The code below relies on this check. This can't be an empty (omitted) expression because an earlier check would've turned it into a non-expression.\n\t\treturn LineError(ERR_EXPR_SYNTAX, FAIL, mArgc > 1 ? aArg.text : _T(\"\"));\n\n\tif (mActionType == ACT_EXPRESSION) // Allow standalone function calls to return unset.\n\t\tif (postfix[postfix_count-1]->symbol == SYM_FUNC)\n\t\t\tpostfix[postfix_count-1]->callsite->flags |= EIF_UNSET_RETURN; // But not EIF_UNSET_PROP!\n\n\t// The following enables ExpandExpression() to be skipped in common cases for ACT_ASSIGNEXPR\n\t// and ACT_RETURN. A similar optimization used to be done for simple literal integers by\n\t// storing an __int64* in arg.postfix, but this new approach allows floating-point numbers\n\t// and literal strings to be optimized, and the pure numeric status of floats to be retained.\n\t// Unlike the old method, numeric literals are reformatted to look exactly like they would if\n\t// this remained an expression; for example, MsgBox 1.00 shows \"1.0\" instead of \"1.00\".\n\tExprTokenType &only_token = *postfix[0];\n\tSymbolType only_symbol = only_token.symbol;\n\tif ( postfix_count == 1 && IS_OPERAND(only_symbol) // This expression is a lone operand, like (1) or \"string\".\n\t\t&& (mActionType < ACT_FOR || mActionType > ACT_UNTIL) // It's not WHILE or UNTIL, which currently perform better as expressions, or FOR, which performs the same but currently expects aResultToken to always be set.\n\t\t&& (mActionType != ACT_SWITCH && mActionType != ACT_CASE) // It's not SWITCH or CASE, which require a proper postfix expression.\n\t\t&& (mActionType != ACT_HOTKEY_IF) // #HotIf requires the expression text not be modified.\n\t\t&& (only_symbol != SYM_VAR || mActionType != ACT_RETURN) // \"return var\" is kept as an expression for correct handling of local vars (see \"ToReturnValue\") and ByRef.\n\t\t)\n\t{\n\t\t// The checks above leave: ACT_ASSIGNEXPR, ACT_EXPRESSION? (ineffectual), ACT_IF,\n\t\t// ACT_LOOP and co., ACT_GOTO, ACT_RETURN (if not var).\n\t\tswitch (only_symbol)\n\t\t{\n\t\tcase SYM_INTEGER:\n\t\tcase SYM_FLOAT:\n\t\t\t// Convert this numeric literal back into a string to ensure the format is consistent.\n\t\t\t// This also ensures parentheses are not present in the output, for cases like MsgBox (1.0).\n\t\t\taArg.text = SimpleHeap::Alloc(TokenToString(only_token, number_buf));\n\t\t\taArg.is_expression = false;\n\t\t\tbreak;\n\t\tcase SYM_STRING:\n\t\t\t// If this arg will be expanded normally, it needs a pointer to the final string,\n\t\t\t// without leading/trailing quotation marks. This doesn't apply to ACT_ASSIGNEXPR or\n\t\t\t// ACT_RETURN, since they use the string token in postfix. Line::ToText compensates\n\t\t\t// for this by adding quotes.\n\t\t\taArg.text = only_token.marker;\n\t\t\taArg.is_expression = false;\n\t\t\tbreak;\n\t\tcase SYM_VAR:\n\t\t\t// Since is_expression is still true, this is only a hint for a later stage:\n\t\t\tif (aArg.type != ARG_TYPE_OUTPUT_VAR)\n\t\t\t\taArg.type = ARG_TYPE_INPUT_VAR;\n\t\t\tbreak;\n\t\t}\n\t}\n\n\t// Create a new postfix array and attach it to this arg of this line.\n\taArg.postfix = SimpleHeap::Alloc<ExprTokenType>(postfix_count + 1); // +1 for the terminator item added below.\n\n\tint i, j, max_stack = 0, max_alloc = 0;\n\tfor (i = 0; i < postfix_count; ++i) // Copy the postfix array in physically sorted order into the new postfix array.\n\t{\n\t\tExprTokenType &new_token = aArg.postfix[i];\n\t\tnew_token.CopyExprFrom(*postfix[i]);\n\t\tASSERT((UINT)new_token.symbol < SYM_COUNT);\n\t\tif (SYM_USES_CIRCUIT_TOKEN(new_token.symbol)) // Adjust each circuit_token address to be relative to the new array rather than the temp/infix array.\n\t\t{\n\t\t\t// circuit_token should always be non-NULL at this point.\n\t\t\tfor (j = i + 1; postfix[j] != new_token.circuit_token; ++j)\n\t\t\t{\n\t\t\t\tASSERT(j < postfix_count); // Should always be found (unless there's a bug), and always to the right in the postfix array, so no need to check postfix_count in release mode.\n\t\t\t}\n\t\t\tnew_token.circuit_token = aArg.postfix + j;\n\t\t}\n\t\t// Simple calculation: only operands and SYM_FUNC can increase the stack count,\n\t\t// so this finds the worst-case stack requirement (or slightly higher).\n\t\tif (IS_OPERAND(new_token.symbol) || new_token.symbol == SYM_FUNC)\n\t\t\t++max_stack;\n\t\t// Resolve variable references for assignments and output vars. Leave all others\n\t\t// for later to facilitate detecting variables which are not assigned anywhere.\n\t\tif (new_token.symbol == SYM_VAR && VARREF_IS_WRITE(new_token.var_usage))\n\t\t{\n\t\t\tnew_token.var = g_script.FindOrAddVar(new_token.var_deref->marker, new_token.var_deref->length, FINDVAR_FOR_WRITE);\n\t\t\tif (!new_token.var)\n\t\t\t\treturn FAIL;\n\t\t\t// This is currently left to FinalizeExpression() to reduce code size:\n\t\t\t//if (new_token.var_usage != VARREF_REF // Validation of REF is left to FinalizeExpression().\n\t\t\t//\t&& !ValidateVarUsage(new_token.var, new_token.var_usage))\n\t\t\t//\treturn FAIL;\n\t\t\tnew_token.var->MarkAssignedSomewhere();\n\t\t\tif (aArg.type == ARG_TYPE_OUTPUT_VAR)\n\t\t\t{\n\t\t\t\taArg.deref = (DerefType *)new_token.var;\n\t\t\t\taArg.is_expression = false;\n\t\t\t}\n\t\t}\n\t\t// Count the tokens which potentially use to_free[].\n\t\tif (new_token.symbol == SYM_DYNAMIC || new_token.symbol == SYM_FUNC\n\t\t\t|| new_token.symbol == SYM_CONCAT || new_token.symbol == SYM_REF\n\t\t\t|| new_token.symbol == SYM_VAR)\n\t\t\t++max_alloc;\n\t}\n\taArg.postfix[postfix_count].symbol = SYM_INVALID; // Special item to mark the end of the array.\n\taArg.max_stack = max_stack;\n\taArg.max_alloc = max_alloc;\n\n\treturn OK;\n}\n\n\n\nResultType Line::FinalizeExpression(ArgStruct &aArg)\n{\n\tauto stack = (ExprTokenType **)_alloca(aArg.max_stack * sizeof(ExprTokenType **));\n\tint stack_count = 0;\n\t// stack_count checks: Since missing operands are caught at an earlier stage, it doesn't\n\t// seem possible to produce any situation where the stack is unbalanced, but due to the\n\t// overall complexity it seems best to assume that it could happen. Having these checks\n\t// here might help catch future (or present) bugs.\n\n#define CHECK_STACK(N) if (stack_count < (N)) return LineError(ERR_EXPR_SYNTAX)\n\n\tfor (auto this_postfix = aArg.postfix; this_postfix->symbol != SYM_INVALID; ++this_postfix)\n\t{\n\t\tauto postfix_symbol = this_postfix->symbol;\n\t\tASSERT((UINT)postfix_symbol < SYM_COUNT);\n\t\tif (IS_OPERAND(postfix_symbol))\n\t\t{\n\t\t\tif (postfix_symbol == SYM_DYNAMIC)\n\t\t\t{\n\t\t\t\tCHECK_STACK(1);\n\t\t\t\t--stack_count;\n\t\t\t}\n\t\t\tstack[stack_count++] = this_postfix;\n\t\t}\n\t\telse if (IS_POSTFIX_OPERATOR(postfix_symbol) || IS_PREFIX_OPERATOR(postfix_symbol))\n\t\t{\n\t\t\tCHECK_STACK(1);\n\t\t\tstack[stack_count - 1] = this_postfix;\n\t\t}\n\t\telse if (SYM_USES_CIRCUIT_TOKEN(postfix_symbol))\n\t\t{\n\t\t\tCHECK_STACK(1);\n\t\t\t// Pop the result of the left branch of this short-circuit operator, then just allow the right branch\n\t\t\t// to be evaluated and its value/token used as the result. A consequence of this simple approach is\n\t\t\t// that when a short-circuit expression is passed as a parameter, only the right branch...\n\t\t\t// 1) is permitted to be something like &A_Index, being passed to a built-in output var param.\n\t\t\t// 2) is resolved to a function address in something like DllCall(a || \"B\") or DllCall(a?\"B\":\"C\").\n\t\t\t// If this is changed, be sure that both branches are \"finalized\"; i.e. don't just skip over the right\n\t\t\t// branch, since it might contain invalid function calls. This seems difficult to do in one pass since\n\t\t\t// the end of the right branch isn't marked in any way, but it can be done by having a recursive call\n\t\t\t// finalize from [this_postfix] to [this_postfix->circuit_token], then having this layer skip it.\n\t\t\t// One exception: the ?? implicitly inserted by `A ??= B` doesn't pop A because it's needed by the\n\t\t\t// assignment. This doesn't apply to `A.B ??= C` because there's an implicit SYM_FUNC which grows\n\t\t\t// the stack by one, and the final assignment is SYM_FUNC, not SYM_ASSIGN.\n\t\t\tif ( !(postfix_symbol == SYM_OR_MAYBE\n\t\t\t\t&& this_postfix->circuit_token->symbol == SYM_ASSIGN\n\t\t\t\t&& *this_postfix->circuit_token->error_reporting_marker == '?') ) // SYM_ASSIGN_MAYBE was changed to this at load time.\n\t\t\t\t--stack_count;\n\t\t}\n\t\telse if (postfix_symbol == SYM_COMMA)\n\t\t{\n\t\t\t//CHECK_STACK(1);\n\t\t\t--stack_count;\n\t\t}\n\t\telse if (postfix_symbol != SYM_FUNC)\n\t\t{\n\t\t\tCHECK_STACK(2);\n\t\t\t--stack_count; // Pop RHS\n\t\t\tstack[stack_count - 1] = this_postfix; // Replace LHS\n\t\t}\n\t\telse // SYM_FUNC\n\t\t{\n\t\t\tint prev_stack_count = stack_count;\n\t\t\tint param_count = this_postfix->callsite->param_count;\n\t\t\tCHECK_STACK(param_count\n\t\t\t\t+ ((this_postfix->callsite->flags & EIF_STACK_MEMBER) ? 1 : 0)\n\t\t\t\t+ (this_postfix->callsite->func ? 0 : 1));\n\t\t\tstack_count -= param_count;\n\t\t\tauto param = stack + stack_count;\n\t\t\tbool call_call = !this_postfix->callsite->member && IT_CALL == (this_postfix->callsite->flags & IT_BITMASK);\n\t\t\tif (this_postfix->callsite->flags & EIF_STACK_MEMBER)\n\t\t\t{\n\t\t\t\t--stack_count;\n\t\t\t\tcall_call = false;\n\t\t\t}\n\t\t\tFunc *func = nullptr;\n\t\t\tif (this_postfix->callsite->func)\n\t\t\t\tfunc = this_postfix->callsite->func;\n\t\t\telse\n\t\t\t{\n\t\t\t\tauto &func_op = *stack[--stack_count];\n\t\t\t\tfunc = dynamic_cast<Func*>(TokenToObject(func_op));\n\t\t\t}\n\t\t\tif (this_postfix->callsite->flags & EIF_LEAVE_PARAMS)\n\t\t\t\tstack_count = prev_stack_count;\n\t\t\tif (func && call_call)\n\t\t\t{\n\t\t\t\tif (this_postfix->callsite->is_variadic())\n\t\t\t\t\t--param_count; // Exclude the array parameter, which resolves to 0 or more parameters.\n\t\t\t\tif (param_count < func->mMinParams && !this_postfix->callsite->is_variadic())\n\t\t\t\t\treturn LineError(ERR_TOO_FEW_PARAMS, FAIL, func->mName);\n\t\t\t\tif (param_count > func->mParamCount && !func->mIsVariadic)\n\t\t\t\t\treturn LineError(ERR_TOO_MANY_PARAMS, FAIL, func->mName);\n\n\t\t\t\tauto func_as_bif = dynamic_cast<BuiltInFunc*>(func);\n\t\t\t\tauto func_as_udf = dynamic_cast<UserFunc*>(func);\n\t\t\t\tauto *bif = func_as_bif ? func_as_bif->mBIF : nullptr;\n\n\t\t\t\tfor (int i = 0; i < param_count; ++i)\n\t\t\t\t{\n\t\t\t\t\tswitch (param[i]->symbol)\n\t\t\t\t\t{\n\t\t\t\t\tcase SYM_MISSING:\n\t\t\t\t\t\tif (!func->ArgIsOptional(i))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tTCHAR buf[16], *arg;\n\t\t\t\t\t\t\tif (func_as_udf)\n\t\t\t\t\t\t\t\targ = func_as_udf->mParam[i].var->mName;\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tsntprintf(arg = buf, _countof(buf), _T(\"#%i\"), i + 1);\n\t\t\t\t\t\t\treturn LineError(ERR_PARAM_REQUIRED, FAIL, arg);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase SYM_REF:\n\t\t\t\t\t\tif (func->ArgIsOutputVar(i))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// Override the SYM_REF's default var_usage of VARREF_READ to indicate 1) that SYM_VAR can be\n\t\t\t\t\t\t\t// passed directly without the need to allocate a VarRef, and 2) which var types are allowed.\n\t\t\t\t\t\t\t// Permit VAR_VIRTUAL for all built-in functions except VarSetStrCapacity.\n\t\t\t\t\t\t\tparam[i]->var_usage =\n\t\t\t\t\t\t\t\t(!bif || bif == BIF_VarSetStrCapacity) ? VARREF_REF\n\t\t\t\t\t\t\t\t:\t\t\t\t\t\t\t\t\t\t VARREF_OUTPUT_VAR;\n\t\t\t\t\t\t\tif (!bif)\n\t\t\t\t\t\t\t\tparam[i]->object = func; // Used during runtime to detect when a VarRef is needed due to recursion (func->mInstances).\n\t\t\t\t\t\t\tif (param[i][-1].symbol == SYM_DYNAMIC || param[i][-1].symbol == SYM_VAR)\n\t\t\t\t\t\t\t\tparam[i][-1].var_usage = param[i]->var_usage;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif (bif == &BIF_DllCall && param_count)\n\t\t\t\t{\n\t\t\t\t\tif (param[0]->symbol == SYM_STRING)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (void *function = GetDllProcAddress(param[0]->marker))\n\t\t\t\t\t\t\tparam[0]->SetValue((__int64)function);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tstack[stack_count++] = this_postfix;\n\t\t} // SYM_FUNC\n\t} // postfix loop\n\n\tif (stack_count != 1)\n\t\treturn LineError(ERR_EXPR_SYNTAX);\n\n#undef CHECK_STACK\n\n\tfor (auto this_postfix = aArg.postfix; this_postfix->symbol != SYM_INVALID; ++this_postfix)\n\t{\n\t\tif (this_postfix->symbol != SYM_VAR)\n\t\t\tcontinue;\n\t\t// Now that var_usage has been set for any SYM_REF operators in postfix that are passed\n\t\t// to functions, ensure the var being referenced is valid for the given var_usage.\n\t\tif (!ValidateVarUsage(this_postfix->var, this_postfix->var_usage))\n\t\t\treturn FAIL;\n\t\tif (!this_postfix->var->ResolveAlias()->IsAssignedSomewhere() // ResolveAlias() is used to support aliases created by Import.\n\t\t\t&& this_postfix->var_usage == VARREF_READ) // i.e. VARREF_READ_MAYBE (var?, var ?? value) generates no warning but doesn't mark var as assigned.\n\t\t\tg_script.WarnUnassignedVar(this_postfix->var, this);\n\t}\n\n\treturn OK;\n}\n\n\n//-------------------------------------------------------------------------------------\n\n// Init static vars:\nLine *Line::sLog[] = {NULL}; // Initialize all the array elements.\nDWORD Line::sLogTick[]; // No initialization needed.\nint Line::sLogNext = 0; // Start at the first element.\n\n#ifdef AUTOHOTKEYSC // Reduces code size to omit things that are unused, and helps catch bugs at compile-time.\n\tLPTSTR Line::sSourceFile[1]; // No init needed.\n#else\n\tLPTSTR *Line::sSourceFile = NULL; // Init to NULL for use with realloc() and for maintainability.\n\tint Line::sMaxSourceFiles = 0;\n#endif\n\tint Line::sSourceFileCount = 0; // Zero source files initially. The main script will be the first.\n\nLPTSTR Line::sDerefBuf = NULL; // Buffer to hold the values of any args that need to be dereferenced.\nsize_t Line::sDerefBufSize = 0;\nint Line::sLargeDerefBufs = 0; // Keeps track of how many large bufs exist on the call-stack, for the purpose of determining when to stop the buffer-freeing timer.\nLPTSTR Line::sArgDeref[MAX_ARGS]; // No init needed.\n\n\nvoid Line::FreeDerefBufIfLarge()\n{\n\tif (sDerefBufSize > LARGE_DEREF_BUF_SIZE)\n\t{\n\t\t// Freeing the buffer should be safe even if the script's current quasi-thread is in the middle\n\t\t// of executing a command, since commands are all designed to make only temporary use of the\n\t\t// deref buffer (they make copies of anything they need prior to calling MsgSleep() or anything\n\t\t// else that might pump messages and thus result in a call to us here).\n\t\tfree(sDerefBuf); // The above size-check has ensured this is non-NULL.\n\t\tSET_S_DEREF_BUF(NULL, 0);\n\t\t--sLargeDerefBufs;\n\t\tif (!sLargeDerefBufs)\n\t\t\tKILL_DEREF_TIMER\n\t}\n\t//else leave the timer running because some other deref buffer in a recursed ExpandArgs() layer\n\t// is still waiting to be freed (even if it isn't, it should be harmless to keep the timer running\n\t// just in case, since each call to ExpandArgs() will reset/postpone the timer due to the script\n\t// having demonstrated that it isn't idle).\n}\n\n\n\n// Maintain a circular queue of the lines most recently executed:\n#define LOG_LINE(line) \\\n{ \\\n\tsLog[sLogNext] = line; \\\n\tsLogTick[sLogNext++] = GetTickCount(); \\\n\tif (sLogNext >= LINE_LOG_SIZE) \\\n\t\tsLogNext = 0; \\\n}\n\n\n\nResultType Line::ExecUntil(ExecUntilMode aMode, ResultToken *aResultToken, Line **apJumpToLine)\n// Start executing at \"this\" line, stop when aMode indicates.\n// RECURSIVE: Handles all lines that involve flow-control.\n// aMode can be UNTIL_RETURN, UNTIL_BLOCK_END, ONLY_ONE_LINE.\n// Returns OK, FAIL, EARLY_RETURN, EARLY_EXIT, or (perhaps only indirectly) LOOP_BREAK, or LOOP_CONTINUE.\n// apJumpToLine is a pointer to Line-ptr (handle), which is an output parameter. If NULL,\n// the caller is indicating it doesn't need this value, so it won't (and can't) be set by\n// the called recursion layer.\n{\n\tLine *unused_jump_to_line;\n\tLine *&caller_jump_to_line = apJumpToLine ? *apJumpToLine : unused_jump_to_line; // Simplifies code in other places.\n\t// Important to init, since most of the time it will keep this value.\n\t// Tells caller that no jump is required (default):\n\tcaller_jump_to_line = NULL;\n\n\t// The benchmark improvement of having the following variables declared outside the loop rather than inside\n\t// is about 0.25%. Since that is probably not even statistically significant, the only reason for declaring\n\t// them here is in case compilers other than MSVC++ 7.1 benefit more -- and because it's an old silly habit.\n\t__int64 loop_iteration;\n\tLoopFilesStruct *loop_file;\n\tRegItemStruct *loop_reg_item;\n\tLoopReadFileStruct *loop_read_file;\n\tLPTSTR loop_field;\n\n\tLine *jump_to_line; // Don't use *apJumpToLine because it might not exist.\n\tLabel *jump_to_label; // For use with Goto.\n\tResultType if_condition, result;\n\tLONG_OPERATION_INIT\n\tglobal_struct &g = *::g; // Reduces code size and may improve performance. Eclipsing ::g with local g makes compiler remind/enforce the use of the right one.\n\n\tfor (Line *line = this; line != NULL;)\n\t{\n\t\t// The below must be done at least when the keybd or mouse hook is active, but is currently\n\t\t// always done since it's a very low overhead call, and has the side-benefit of making\n\t\t// the app maximally responsive when the script is busy.\n\t\t// This low-overhead call achieves at least two purposes optimally:\n\t\t// 1) Keyboard and mouse lag is minimized when the hook(s) are installed, since this single\n\t\t// Peek() is apparently enough to route all pending input to the hooks (though it's inexplicable\n\t\t// why calling MsgSleep(-1) does not achieve this goal, since it too does a Peek().\n\t\t// Nevertheless, that is the testing result that was obtained: the mouse cursor lagged\n\t\t// in tight script loops even when MsgSleep(-1) or (0) was called every 10ms or so.\n\t\t// 2) The app is maximally responsive while executing in a tight loop.\n\t\t// 3) Hotkeys are maximally responsive. For example, if a user has game hotkeys, using\n\t\t// a GetTickCount() method (which very slightly improves performance by cutting back on\n\t\t// the number of Peek() calls) would introduce up to 10ms of delay before the hotkey\n\t\t// finally takes effect. 10ms can be significant in games, where ping (latency) itself\n\t\t// can sometimes be only 10 or 20ms. UPDATE: It looks like PeekMessage() yields CPU time\n\t\t// automatically, similar to a Sleep(0), when our queue has no messages. Since this would\n\t\t// make scripts slow to a crawl, only do the Peek() every 5ms or so (though the timer\n\t\t// granularity is 10ms on most OSes, so that's the true interval).\n\t\t// 4) Timed subroutines are run as consistently as possible (to help with this, a check\n\t\t// similar to the below is also done for single commmands that take a long time, such\n\t\t// as Download, FileSetAttrib, etc.\n\t\tLONG_OPERATION_UPDATE\n\n\t\t// If interruptions are currently forbidden, it's our responsibility to check if the number\n\t\t// of lines that have been run since this quasi-thread started now indicate that\n\t\t// interruptibility should be reenabled. g.UninterruptedLineCount must also be tracked\n\t\t// for IsInterruptible() to detect execution of the thread's first line.\n\t\t// v1.0.38.04: If g.ThreadIsCritical==true, no need to check or accumulate g.UninterruptedLineCount\n\t\t// because the script is now in charge of this thread's interruptibility.\n\t\tif (!g.AllowThreadToBeInterrupted && !g.ThreadIsCritical) // Ordered for short-circuit performance.\n\t\t{\n\t\t\t// Incrementing this unconditionally makes it a relatively crude measure,\n\t\t\t// but it seems okay to be less accurate for this purpose:\n\t\t\t++g.UninterruptedLineCount;\n\t\t\t// To preserve backward compatibility, ExecUntil() must be the one to check\n\t\t\t// g.UninterruptedLineCount and update g.AllowThreadToBeInterrupted, rather than doing\n\t\t\t// those things on-demand in IsInterruptible(). If those checks were moved to\n\t\t\t// IsInterruptible(), they might compare against a different/changed value of\n\t\t\t// g_script.mUninterruptedLineCountMax because IsInterruptible() is called only upon demand.\n\t\t\t// THIS SECTION DOES NOT CHECK g.ThreadStartTime because that only needs to be\n\t\t\t// checked on demand by callers of IsInterruptible().\n\t\t\tif (g.UninterruptedLineCount > g_script.mUninterruptedLineCountMax // See above.\n\t\t\t\t&& g_script.mUninterruptedLineCountMax > -1)\n\t\t\t{\n\t\t\t\tg.AllowThreadToBeInterrupted = true;\n\t\t\t\tg.PeekFrequency = DEFAULT_PEEK_FREQUENCY;\n\t\t\t}\n\t\t}\n\n\t\t// At this point, a pause may have been triggered either by the above MsgSleep()\n\t\t// or due to the action of a command (e.g. Pause, or perhaps tray menu \"pause\" was selected during Sleep):\n\t\tif (g.IsPaused)\n\t\t\tMsgWaitUnpause();\n\n\t\t// Do these only after the above has had its opportunity to spend a significant amount\n\t\t// of time doing what it needed to do. i.e. do these immediately before the line will actually\n\t\t// be run so that the time it takes to run will be reflected in the ListLines log.\n g_script.mCurrLine = line; // Simplifies error reporting when we get deep into function calls.\n\n\t\tif (g.ListLinesIsEnabled)\n\t\t\tLOG_LINE(line)\n\n#ifdef CONFIG_DEBUGGER\n\t\tif (g_Debugger.IsConnected() && line->mActionType != ACT_WHILE) // L31: PreExecLine of ACT_WHILE is now handled in PerformLoopWhile() where inspecting A_Index will yield the correct result.\n\t\t\tg_Debugger.PreExecLine(line);\n#endif\n\n\t\t// Do this only after the opportunity to Sleep (above) has passed, because during\n\t\t// that sleep, a new subroutine might be launched which would likely overwrite the\n\t\t// deref buffer used for arg expansion, below:\n\t\t// Expand any dereferences contained in this line's args.\n\t\t// Note: Only one line at a time be expanded via the above function. So be sure\n\t\t// to store any parts of a line that are needed prior to moving on to the next\n\t\t// line (e.g. control stmts such as IF and LOOP).\n\t\tif (!ACT_EXPANDS_ITS_OWN_ARGS(line->mActionType))\n\t\t{\n\t\t\tresult = line->ExpandArgs(line->mActionType == ACT_RETURN ? aResultToken : NULL);\n\t\t\t// As of v1.0.31, ExpandArgs() will also return EARLY_EXIT if a function call inside one of this\n\t\t\t// line's expressions did an EXIT.\n\t\t\tif (result != OK)\n\t\t\t\treturn result; // In the case of FAIL: Abort the current subroutine, but don't terminate the app.\n\t\t}\n\n\t\tswitch (line->mActionType)\n\t\t{\n\t\tcase ACT_IF:\n\t\t\tif_condition = line->EvaluateCondition();\n#ifdef _DEBUG // FAIL can be returned only in DEBUG mode.\n\t\t\tif (if_condition == FAIL)\n\t\t\t\treturn FAIL;\n#endif\n\t\t\tif (if_condition == CONDITION_TRUE)\n\t\t\t{\n\t\t\t\t// Under these conditions, line->mNextLine has already been verified non-NULL by the pre-parser,\n\t\t\t\t// so this dereference is safe:\n\t\t\t\tif (line->mNextLine->mActionType == ACT_BLOCK_BEGIN)\n\t\t\t\t{\n\t\t\t\t\t// If this IF/ELSE has a block under it rather than just a single line, take a shortcut\n\t\t\t\t\t// and directly execute the block. This avoids one recursive call to ExecUntil()\n\t\t\t\t\t// for each iteration, which can speed up short/fast IFs/ELSEs by as much as 25%.\n\t\t\t\t\t// Another benefit is conservation of stack space, especially during \"else if\" ladders.\n\t\t\t\t\t//\n\t\t\t\t\t// At this point, line->mNextLine->mNextLine is already verified non-NULL by the pre-parser\n\t\t\t\t\t// because it checks that every IF/ELSE has a line under it (ACT_BLOCK_BEGIN in this case)\n\t\t\t\t\t// and that every ACT_BLOCK_BEGIN has at least one line under it.\n\t\t\t\t\tdo\n\t\t\t\t\t\tresult = line->mNextLine->mNextLine->ExecUntil(UNTIL_BLOCK_END, aResultToken, &jump_to_line);\n\t\t\t\t\twhile (jump_to_line == line->mNextLine); // The above call encountered a Goto that jumps to the \"{\". See ACT_BLOCK_BEGIN in ExecUntil() for details.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tresult = line->mNextLine->ExecUntil(ONLY_ONE_LINE, aResultToken, &jump_to_line);\n\t\t\t\tif (jump_to_line == line)\n\t\t\t\t\t// Since this IF's ExecUntil() encountered a Goto whose target is the IF\n\t\t\t\t\t// itself, continue with the for-loop without moving to a different\n\t\t\t\t\t// line. Also: stay in this recursion layer even if aMode == ONLY_ONE_LINE\n\t\t\t\t\t// because we don't want the caller handling it because then it's cleanup\n\t\t\t\t\t// to jump to its end-point (beyond its own and any unowned elses) won't work.\n\t\t\t\t\t// Example:\n\t\t\t\t\t// if x <-- If this layer were to do it, its own else would be unexpectedly encountered.\n\t\t\t\t\t// label1:\n\t\t\t\t\t// if y <-- We want this statement's layer to handle the goto.\n\t\t\t\t\t// goto, label1\n\t\t\t\t\t// else\n\t\t\t\t\t// ...\n\t\t\t\t\t// else\n\t\t\t\t\t// ...\n\t\t\t\t\tcontinue;\n\t\t\t\tif (aMode == ONLY_ONE_LINE // See below.\n\t\t\t\t\t|| result != OK) // i.e. FAIL, EARLY_RETURN, EARLY_EXIT, LOOP_BREAK, or LOOP_CONTINUE.\n\t\t\t\t{\n\t\t\t\t\t// When jump_to_line!=NULL, the above call to ExecUntil() told us to jump somewhere.\n\t\t\t\t\t// But if we're in ONLY_ONE_LINE mode, our caller must handle it because only it knows how\n\t\t\t\t\t// to extricate itself from whatever it's doing. Additionally, if result is LOOP_CONTINUE\n\t\t\t\t\t// or LOOP_BREAK and jump_to_line is not NULL, each ExecUntil() or PerformLoop() recursion\n\t\t\t\t\t// layer must pass jump_to_line to its caller, all the way up to the target loop which\n\t\t\t\t\t// will then know it should either BREAK or CONTINUE.\n\t\t\t\t\t//\n\t\t\t\t\t// EARLY_RETURN can occur if this if's action was a block and that block contained a RETURN,\n\t\t\t\t\t// or if this if's only action is RETURN.\n\t\t\t\t\t//\n\t\t\t\t\tcaller_jump_to_line = jump_to_line; // Tell the caller to handle this jump (if applicable). jump_to_line==NULL is ok.\n\t\t\t\t\treturn result;\n\t\t\t\t}\n\t\t\t\t// Now this if-statement, including any nested if's and their else's,\n\t\t\t\t// has been fully evaluated by the recursion above. We must jump to\n\t\t\t\t// the end of this if-statement to get to the right place for\n\t\t\t\t// execution to resume. UPDATE: Or jump to the goto target if the\n\t\t\t\t// call to ExecUntil told us to do that instead:\n\t\t\t\tif (jump_to_line != NULL)\n\t\t\t\t{\n\t\t\t\t\tif (jump_to_line->mParentLine != line->mParentLine)\n\t\t\t\t\t{\n\t\t\t\t\t\tcaller_jump_to_line = jump_to_line; // Tell the caller to handle this jump.\n\t\t\t\t\t\treturn OK;\n\t\t\t\t\t}\n\t\t\t\t\tline = jump_to_line;\n\t\t\t\t}\n\t\t\t\telse // Do the normal clean-up for an IF statement:\n\t\t\t\t{\n\t\t\t\t\tline = line->mRelatedLine; // The preparser has ensured that this is always non-NULL.\n\t\t\t\t\tif (line->mActionType == ACT_ELSE)\n\t\t\t\t\t\tline = line->mRelatedLine;\n\t\t\t\t\t\t// Now line is the ELSE's \"I'm finished\" jump-point, which is where\n\t\t\t\t\t\t// we want to be. If line is now NULL, it will be caught when this\n\t\t\t\t\t\t// loop iteration is ended by the \"continue\" stmt below. UPDATE:\n\t\t\t\t\t\t// it can't be NULL since all scripts now end in ACT_EXIT.\n\t\t\t\t\t// else the IF had NO else, so we're already at the IF's \"I'm finished\" jump-point.\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // if_condition == CONDITION_FALSE\n\t\t\t{\n\t\t\t\tline = line->mRelatedLine; // The preparser has ensured that this is always non-NULL.\n\t\t\t\tif (line->mActionType == ACT_ELSE) // This IF has an else.\n\t\t\t\t{\n\t\t\t\t\tif (line->mNextLine->mActionType == ACT_BLOCK_BEGIN)\n\t\t\t\t\t{\n\t\t\t\t\t\t// For comments, see the \"if_condition==CONDITION_TRUE\" section higher above.\n\t\t\t\t\t\tdo\n\t\t\t\t\t\t\tresult = line->mNextLine->mNextLine->ExecUntil(UNTIL_BLOCK_END, aResultToken, &jump_to_line);\n\t\t\t\t\t\twhile (jump_to_line == line->mNextLine);\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\t// Preparser has ensured that every ELSE has a non-NULL next line:\n\t\t\t\t\t\tresult = line->mNextLine->ExecUntil(ONLY_ONE_LINE, aResultToken, &jump_to_line);\n\n\t\t\t\t\tif (aMode == ONLY_ONE_LINE || result != OK) // See the similar section above for comments.\n\t\t\t\t\t{\n\t\t\t\t\t\tcaller_jump_to_line = jump_to_line;\n\t\t\t\t\t\treturn result;\n\t\t\t\t\t}\n\t\t\t\t\tif (jump_to_line != NULL)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (jump_to_line->mParentLine != line->mParentLine)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcaller_jump_to_line = jump_to_line; // Tell the caller to handle this jump.\n\t\t\t\t\t\t\treturn OK;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// jump to where the called function told us to go, rather than the end of our ELSE.\n\t\t\t\t\t\tline = jump_to_line;\n\t\t\t\t\t}\n\t\t\t\t\telse // Do the normal clean-up for an ELSE statement.\n\t\t\t\t\t\tline = line->mRelatedLine;\n\t\t\t\t\t\t// Now line is the ELSE's \"I'm finished\" jump-point, which is where\n\t\t\t\t\t\t// we want to be. If line is now NULL, it will be caught when this\n\t\t\t\t\t\t// loop iteration is ended by the \"continue\" stmt below. UPDATE:\n\t\t\t\t\t\t// it can't be NULL since all scripts now end in ACT_EXIT.\n\t\t\t\t}\n\t\t\t\telse if (aMode == ONLY_ONE_LINE)\n\t\t\t\t\t// Since this IF statement has no ELSE, and since it was executed\n\t\t\t\t\t// in ONLY_ONE_LINE mode, the IF-ELSE statement, which counts as\n\t\t\t\t\t// one line for the purpose of ONLY_ONE_LINE mode, has finished:\n\t\t\t\t\treturn OK;\n\t\t\t\t// else we're already at the IF's \"I'm finished\" jump-point.\n\t\t\t} // if_condition == CONDITION_FALSE\n\t\t\tcontinue; // Let the for-loop process the new location specified by <line>.\n\n\t\tcase ACT_GOTO:\n\t\t\t// A single goto can cause an infinite loop if misused, so be sure to do this to\n\t\t\t// prevent the program from hanging:\n\t\t\tif ( !(jump_to_label = (Label *)line->mRelatedLine) )\n\t\t\t\t// The label is a dereference, otherwise it would have been resolved at load-time.\n\t\t\t\t// So send true because we don't want to update its mRelatedLine. This is because\n\t\t\t\t// we want to resolve the label every time through the loop in case the variable\n\t\t\t\t// that contains the label changes, e.g. Goto(VarContainingLabelName)\n\t\t\t\tif ( !(jump_to_label = line->GetJumpTarget(true)) )\n\t\t\t\t\treturn FAIL; // Error was already displayed by the called function.\n\t\t\t// One or both of these lines can be NULL. But the preparser should have\n\t\t\t// ensured that all we need to do is a simple compare to determine\n\t\t\t// whether this Goto should be handled by this layer or its caller\n\t\t\t// (i.e. if this Goto's target is not in our nesting level, it MUST be the\n\t\t\t// caller's responsibility to either handle it or pass it on to its\n\t\t\t// caller).\n\t\t\tif (aMode == ONLY_ONE_LINE || line->mParentLine != jump_to_label->mJumpToLine->mParentLine)\n\t\t\t{\n\t\t\t\tcaller_jump_to_line = jump_to_label->mJumpToLine; // Tell the caller to handle this jump.\n\t\t\t\treturn OK;\n\t\t\t}\n\t\t\t// Otherwise, we will handle this Goto since it's in our nesting layer:\n\t\t\tline = jump_to_label->mJumpToLine;\n\t\t\tcontinue; // Resume looping starting at the above line. \"continue\" is actually slight faster than \"break\" in these cases.\n\n\t\tcase ACT_RETURN:\n\t\t\t// Although a return is really just a kind of block-end, keep it separate\n\t\t\t// because when a return is encountered inside a block, it has a double function:\n\t\t\t// to first break out of all enclosing blocks and then return from the function.\n\t\t\t// NOTE: The return's ARG1 expression has been evaluated by ExpandArgs() above,\n\t\t\t// which is desirable *even* if aResultToken is NULL (i.e. the caller will be\n\t\t\t// ignoring the return value) in case the return's expression calls a function\n\t\t\t// which has side-effects. For example, \"return LogThisEvent()\".\n\t\t\tif (aMode != UNTIL_RETURN)\n\t\t\t\t// Tells the caller to return early if it's not the function that directly\n\t\t\t\t// brought us into this subroutine. i.e. it allows us to escape from\n\t\t\t\t// any number of nested blocks in order to get back out of their\n\t\t\t\t// recursive layers and back to the place this RETURN has meaning\n\t\t\t\t// to someone (at the right recursion layer):\n\t\t\t\treturn EARLY_RETURN;\n\t\t\treturn OK;\n\n\t\tcase ACT_BREAK:\n\t\t\tif (line->mRelatedLine)\n\t\t\t{\n\t\t\t\t// Rather than having PerformLoop() handle LOOP_BREAK specifically, tell our caller to jump to\n\t\t\t\t// the line *after* the loop's body. This is always a jump our caller must handle, unlike GOTO:\n\t\t\t\tcaller_jump_to_line = line->mRelatedLine;\n\t\t\t\t// Return OK instead of LOOP_BREAK to handle it like GOTO. Returning LOOP_BREAK would\n\t\t\t\t// cause the following to behave incorrectly (as described in the comments):\n\t\t\t\t// If (True) ; LOOP_BREAK takes precedence, causing this ExecUntil() layer to return.\n\t\t\t\t// Loop, 1 ; Non-NULL jump-to-line causes the LOOP_BREAK result to propagate.\n\t\t\t\t// Loop, 1\n\t\t\t\t// Break, 2\n\t\t\t\t// MsgBox, This message would not be displayed.\n\t\t\t\treturn OK;\n\t\t\t}\n\t\t\treturn LOOP_BREAK;\n\n\t\tcase ACT_CONTINUE:\n\t\t\tif (line->mRelatedLine)\n\t\t\t{\n\t\t\t\t// Signal any loops nested between this line and the target loop to return LOOP_CONTINUE:\n\t\t\t\tcaller_jump_to_line = line->mRelatedLine; // Okay even if NULL.\n\t\t\t}\n\t\t\treturn LOOP_CONTINUE;\n\n\t\tcase ACT_LOOP:\n\t\tcase ACT_LOOP_FILE:\n\t\tcase ACT_LOOP_REG:\n\t\tcase ACT_LOOP_READ:\n\t\tcase ACT_LOOP_PARSE:\n\t\tcase ACT_FOR:\n\t\tcase ACT_WHILE:\n\t\t{\n\t\t\t// HANDLE ANY ERROR CONDITIONS THAT CAN ABORT THE LOOP:\n\t\t\tFileLoopModeType file_loop_mode;\n\t\t\tHKEY root_key_type; // For registry loops, this holds the type of root key, independent of whether it is local or remote.\n\t\t\tif (line->mActionType == ACT_LOOP_FILE || line->mActionType == ACT_LOOP_REG)\n\t\t\t{\n\t\t\t\tif (line->mActionType == ACT_LOOP_REG)\n\t\t\t\t\tif ( !(root_key_type = RegConvertKey(ARG1)) )\n\t\t\t\t\t\treturn line->LineError(ERR_PARAM1_INVALID, FAIL, ARG1);\n\n\t\t\t\tfile_loop_mode = (line->mArgc <= 1) ? FILE_LOOP_FILES_ONLY : ConvertLoopMode(ARG2);\n\t\t\t\tif (file_loop_mode == FILE_LOOP_INVALID)\n\t\t\t\t\treturn line->LineError(ERR_PARAM2_INVALID, FAIL, ARG2);\n\t\t\t}\n\n\t\t\t// ONLY AFTER THE ABOVE IS IT CERTAIN THE LOOP WILL LAUNCH (i.e. there was no error or early return).\n\t\t\t// So only now is it safe to make changes to global things like g.mLoopIteration.\n\t\t\tjump_to_line = NULL; // Init this output parameter prior to starting each type of loop.\n\n\t\t\tLine *finished_line = line->mRelatedLine;\n\t\t\tLine *until;\n\t\t\tif (finished_line->mActionType == ACT_UNTIL)\n\t\t\t{\t// This loop has an additional post-condition.\n\t\t\t\tuntil = finished_line;\n\t\t\t\t// When finished, we'll jump to the line after UNTIL:\n\t\t\t\tfinished_line = finished_line->mNextLine;\n\t\t\t}\n\t\t\telse\n\t\t\t\tuntil = NULL;\n\n\t\t\t// IN CASE THERE'S AN OUTER LOOP ENCLOSING THIS ONE, BACK UP THE A_LOOPXXX VARIABLES.\n\t\t\t// (See the \"restore\" section further below for comments.)\n\t\t\tloop_iteration = g.mLoopIteration;\n\t\t\tloop_file = g.mLoopFile;\n\t\t\tloop_reg_item = g.mLoopRegItem;\n\t\t\tloop_read_file = g.mLoopReadFile;\n\t\t\tloop_field = g.mLoopField;\n\n\t\t\t// INIT \"A_INDEX\" (one-based not zero-based). This is done here rather than in each PerformLoop()\n\t\t\t// function because it reduces code size and also because registry loops and file-pattern loops\n\t\t\t// can be intrinsically recursive (this is also related to the loop-recursion bugfix documented\n\t\t\t// for v1.0.20: fixes A_Index so that it doesn't wrongly reset to 0 inside recursive file-loops\n\t\t\t// and registry loops).\n\t\t\tif (line->mActionType != ACT_FOR) // PerformLoopFor() sets it later so its enumerator expression (which is evaluated only once) can refer to the A_Index of the outer loop.\n\t\t\t\tg.mLoopIteration = 1;\n\n\t\t\t// PERFORM THE LOOP:\n\t\t\tswitch (line->mActionType)\n\t\t\t{\n\t\t\tcase ACT_LOOP: // Listed first for performance.\n\t\t\t\tbool is_infinite; // \"is_infinite\" is more maintainable and future-proof than using LLONG_MAX to simulate an infinite loop. Plus it gives peace-of-mind and the LLONG_MAX method doesn't measurably improve benchmarks (nor does BOOL vs. bool).\n\t\t\t\t__int64 iteration_limit;\n\t\t\t\tif (line->mArgc > 0) // At least one parameter is present.\n\t\t\t\t{\n\t\t\t\t\titeration_limit = line->ArgToInt64(1); // If it's negative, zero iterations will be performed automatically.\n\t\t\t\t\tis_infinite = false;\n\t\t\t\t}\n\t\t\t\telse // No parameters are present.\n\t\t\t\t{\n\t\t\t\t\titeration_limit = 0; // Avoids debug-mode's \"used without having been defined\" (though it's merely passed as a parameter, not ever used in this case).\n\t\t\t\t\tis_infinite = true; // Override the default set earlier.\n\t\t\t\t}\n\t\t\t\tresult = line->PerformLoop(aResultToken, jump_to_line, until, iteration_limit, is_infinite);\n\t\t\t\tbreak;\n\t\t\tcase ACT_WHILE:\n\t\t\t\tresult = line->PerformLoopWhile(aResultToken, jump_to_line);\n\t\t\t\tbreak;\n\t\t\tcase ACT_FOR:\n\t\t\t\tresult = line->PerformLoopFor(aResultToken, jump_to_line, until);\n\t\t\t\tbreak;\n\t\t\tcase ACT_LOOP_PARSE:\n\t\t\t\t// The phrase \"csv\" is unique enough since user can always rearrange the letters\n\t\t\t\t// to do a literal parse using C, S, and V as delimiters:\n\t\t\t\tif (_tcsicmp(ARG2, _T(\"CSV\")))\n\t\t\t\t\tresult = line->PerformLoopParse(aResultToken, jump_to_line, until);\n\t\t\t\telse\n\t\t\t\t\tresult = line->PerformLoopParseCSV(aResultToken, jump_to_line, until);\n\t\t\t\tbreak;\n\t\t\tcase ACT_LOOP_READ:\n\t\t\t\tresult = line->PerformLoopReadFile(aResultToken, jump_to_line, until, ARG1, ARG2);\n\t\t\t\tbreak;\n\t\t\tcase ACT_LOOP_FILE:\n\t\t\t\tresult = line->PerformLoopFilePattern(aResultToken, jump_to_line, until\n\t\t\t\t\t, (file_loop_mode & ~FILE_LOOP_RECURSE), (file_loop_mode & FILE_LOOP_RECURSE), ARG1);\n\t\t\t\tbreak;\n\t\t\tcase ACT_LOOP_REG:\n\t\t\t\t// This isn't the most efficient way to do things (e.g. the repeated calls to\n\t\t\t\t// RegConvertRootKey()), but it the simplest way for now. Optimization can\n\t\t\t\t// be done at a later time:\n\t\t\t\tbool is_remote_registry;\n\t\t\t\tHKEY root_key;\n\t\t\t\tLPTSTR subkey;\n\t\t\t\tif (root_key = RegConvertKey(ARG1, &subkey, &is_remote_registry)) // This will open the key if it's remote.\n\t\t\t\t{\n\t\t\t\t\t// root_key_type needs to be passed in order to support GetLoopRegKey():\n\t\t\t\t\tresult = line->PerformLoopReg(aResultToken, jump_to_line, until\n\t\t\t\t\t\t, (file_loop_mode & ~FILE_LOOP_RECURSE), (file_loop_mode & FILE_LOOP_RECURSE), root_key_type, root_key, subkey);\n\t\t\t\t\tif (is_remote_registry)\n\t\t\t\t\t\tRegCloseKey(root_key);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\t// The open of a remote key failed (we know it's remote otherwise it should have\n\t\t\t\t\t// failed earlier rather than here).\n\t\t\t\t\tresult = g_script.Win32Error();\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\t// RESTORE THE PREVIOUS A_LOOPXXX VARIABLES. If there isn't an outer loop, this will set them\n\t\t\t// all to NULL/0, which is the most proper and also in keeping with historical behavior.\n\t\t\t// This backup/restore approach was adopted in v1.0.44.14 to simplify things and improve maintainability.\n\t\t\t// This change improved performance by only 1%, which isn't statistically significant. More importantly,\n\t\t\t// it indirectly fixed the following bug:\n\t\t\t// When a \"return\" is executed inside a loop's body (and possibly an Exit or Fail too, but those are\n\t\t\t// covered more for simplicity and maintainability), the situations below require superglobals like\n\t\t\t// A_Index and A_LoopField to be restored for the outermost caller of ExecUntil():\n\t\t\t// 1) Var%A_Index% := func_that_returns_directly_from_inside_a_loop_body().\n\t\t\t// The above happened because the return in the function's loop failed to restore A_Index for its\n\t\t\t// caller because it had been designed to restore inter-line, not for intra-line activities like\n\t\t\t// calling functions.\n\t\t\t// 2) A command that has expressions in two separate parameters and one of those parameters calls\n\t\t\t// a function that returns directly from inside one of its loop bodies.\n\t\t\t//\n\t\t\t// This change was made feasible by making the A_LoopXXX attributes thread-specific, which prevents\n\t\t\t// interrupting threads from affecting the values our thread sees here. So that change protects\n\t\t\t// against thread interruptions, and this backup/restore change here keeps the Loop variables in\n\t\t\t// sync with the current nesting level (braces, function calls, etc.)\n\t\t\t// \n\t\t\t// The memory for structs like g.mLoopFile resides in the stack of an instance of PerformLoop(),\n\t\t\t// which is our caller or our caller's caller, etc. In other words, it shouldn't be possible for\n\t\t\t// variables like g.mLoopFile to be non-NULL if there isn't a PerformLoop() beneath us in the stack.\n\t\t\tg.mLoopIteration = loop_iteration;\n\t\t\tg.mLoopFile = loop_file;\n\t\t\tg.mLoopRegItem = loop_reg_item;\n\t\t\tg.mLoopReadFile = loop_read_file;\n\t\t\tg.mLoopField = loop_field;\n\n\t\t\tif (result == FAIL || result == EARLY_RETURN || result == EARLY_EXIT)\n\t\t\t\treturn result;\n\t\t\t// else result can be LOOP_BREAK or OK or LOOP_CONTINUE (but only if a loop-label was given).\n\n\t\t\tif (jump_to_line)\n\t\t\t{\n\t\t\t\tif (jump_to_line->mParentLine != line->mParentLine)\n\t\t\t\t{\n\t\t\t\t\t// Our caller must handle the jump if it doesn't share the same parent as the\n\t\t\t\t\t// current line (i.e. it's not at the same nesting level) because that means\n\t\t\t\t\t// the jump target is at a more shallow nesting level than where we are now:\n\t\t\t\t\tcaller_jump_to_line = jump_to_line; // Tell the caller to handle this jump (if applicable).\n\t\t\t\t\treturn result; // If LOOP_CONTINUE, must be passed along so the target loop knows what to do.\n\t\t\t\t}\n\t\t\t\t// Since above didn't return, we're supposed to handle this jump. So jump and then\n\t\t\t\t// continue execution from there:\n\t\t\t\tline = jump_to_line;\n\t\t\t\tcontinue; // end this case of the switch().\n\t\t\t}\n\t\t\tif (finished_line->mActionType == ACT_ELSE)\n\t\t\t{\n\t\t\t\tif (result == CONDITION_FALSE)\n\t\t\t\t{\n\t\t\t\t\tline = finished_line->mNextLine;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\tfinished_line = finished_line->mRelatedLine;\n\t\t\t}\n\t\t\tif (aMode == ONLY_ONE_LINE)\n\t\t\t\treturn OK;\n\t\t\t// Since the above didn't return or break, either the loop has completed the specified\n\t\t\t// number of iterations or it was broken via the break command. In either case, we jump\n\t\t\t// to the line after our loop's structure and continue there:\n\t\t\tline = finished_line;\n\t\t\tcontinue; // Resume looping starting at the above line. \"continue\" is actually slightly faster than \"break\" in these cases.\n\t\t} // case ACT_LOOP, ACT_LOOP_*, ACT_FOR, ACT_WHILE.\n\n\t\tcase ACT_TRY:\n\t\tcase ACT_CATCH:\n\t\t{\n\t\t\tActionTypeType this_act = line->mActionType;\n\t\t\tint outer_excptmode = g.ExcptMode;\n\n\t\t\tResultToken *our_token = g.ThrownToken; // Should always be non-null for CATCH and null for TRY.\n\t\t\tg.ThrownToken = nullptr; // Must be done before assigning the output var in case Assign() causes script to execute via __Delete.\n\n\t\t\tif (this_act == ACT_CATCH)\n\t\t\t{\n\t\t\t\tASSERT(our_token);\n\t\t\t\tg.ExcptMode |= EXCPTMODE_CAUGHT;\n\n\t\t\t\t// Assign the thrown token to the variable if provided.\n\t\t\t\tresult = OK;\n\t\t\t\tif (auto args = (CatchStatementArgs *)line->mAttribute)\n\t\t\t\t\tif (args->output_var)\n\t\t\t\t\t\tresult = args->output_var->Assign(*our_token);\n\t\t\t\tif (!result)\n\t\t\t\t{\n\t\t\t\t\tg_script.FreeExceptionToken(our_token);\n\t\t\t\t\treturn FAIL;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // (this_act == ACT_TRY)\n\t\t\t{\n\t\t\t\t//g.ExcptMode |= EXCPTMODE_TRY; // Currently unused. Must use |= rather than = to avoid removing EXCPTMODE_CATCH, if present.\n\t\t\t\tif (line->mRelatedLine->mActionType != ACT_FINALLY) // Try without Catch/Finally acts like it has an empty Catch.\n\t\t\t\t{\n\t\t\t\t\tg.ExcptMode |= EXCPTMODE_CATCH;\n\t\t\t\t\t// Disable re-throw when catch is present, since the inner layer won't have the Error object to match\n\t\t\t\t\t// against type filters such as `try..catch SpecificError`, and fixing that would increase complexity\n\t\t\t\t\t// or the size of global_struct.\n\t\t\t\t\tg.ExcptMode &= ~EXCPTMODE_CAUGHT;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// The following section is similar to ACT_IF.\n\t\t\tjump_to_line = NULL;\n\t\t\tif (line->mNextLine->mActionType == ACT_BLOCK_BEGIN)\n\t\t\t{\n\t\t\t\tdo\n\t\t\t\t\tresult = line->mNextLine->mNextLine->ExecUntil(UNTIL_BLOCK_END, aResultToken, &jump_to_line);\n\t\t\t\twhile (jump_to_line == line->mNextLine); // The above call encountered a Goto that jumps to the \"{\". See ACT_BLOCK_BEGIN in ExecUntil() for details.\n\t\t\t}\n\t\t\telse\n\t\t\t\tresult = line->mNextLine->ExecUntil(ONLY_ONE_LINE, aResultToken, &jump_to_line);\n\n\t\t\tbool UnhandledException_was_not_called = (g.ExcptMode & EXCPTMODE_CATCH); // Because CATCH is present (or TRY without CATCH or FINALLY).\n\t\t\tif (our_token) // Implies this is CATCH, or TRY but somehow g.ThrownToken was already non-null due to a prior exception.\n\t\t\t{\n\t\t\t\tif (!result && !g.ThrownToken) // Assume this is a re-throw, since any other failure should have generated a new exception.\n\t\t\t\t{\n\t\t\t\t\tg.ThrownToken = our_token, our_token = nullptr;\n\t\t\t\t\tUnhandledException_was_not_called = true; // Because THROW didn't have our_token to pass to it.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tg_script.FreeExceptionToken(our_token); // Get this out of the way now in case of early \"goto\" or \"return\".\n\t\t\t}\n\t\t\tg.ExcptMode = outer_excptmode; // Reset it now in case of early \"goto\" or \"return\".\n\n\t\t\t// Move to the next line after the 'try' or 'catch' block.\n\t\t\tline = line->mRelatedLine;\n\n\t\t\tbool bHasCatch = false;\n\t\t\tif (this_act == ACT_TRY)\n\t\t\t{\n\t\t\t\twhile (line->mActionType == ACT_CATCH)\n\t\t\t\t{\n\t\t\t\t\tbHasCatch = true;\n\t\t\t\t\tif (g.ThrownToken && line->CatchThis(*g.ThrownToken))\n\t\t\t\t\t{\n\t\t\t\t\t\t// An exception was thrown and we have a 'catch' block, so let the next\n\t\t\t\t\t\t// iteration handle it. Implies result == FAIL && jump_to_line == NULL,\n\t\t\t\t\t\t// but result won't have any meaning for the next iteration.\n\t\t\t\t\t\tgoto continue_ExecUntil_loop;\n\t\t\t\t\t}\n\t\t\t\t\t// Otherwise: an exception of appropriate type was not thrown, so skip this 'catch'.\n\t\t\t\t\tline = line->mRelatedLine;\n\t\t\t\t}\n\t\t\t\tif (!bHasCatch && g.ThrownToken && line->mActionType != ACT_FINALLY\n\t\t\t\t\t&& Object::HasBase(*g.ThrownToken, ErrorPrototype::Error)) // Make `try {}` equivalent to `try {} catch {}` without a class.\n\t\t\t\t{\n\t\t\t\t\t// An exception was thrown, but no 'catch' nor 'finally' is present.\n\t\t\t\t\t// In this case 'try' acts as a catch-all.\n\t\t\t\t\tg_script.FreeExceptionToken(g.ThrownToken);\n\t\t\t\t\tresult = OK;\n\t\t\t\t}\n\t\t\t\tif (!g.ThrownToken && line->mActionType == ACT_ELSE && result == OK && !jump_to_line)\n\t\t\t\t{\n\t\t\t\t\t// Since no exception was thrown, execute the ELSE (by jumping to its first statement).\n\t\t\t\t\tline = line->mNextLine;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // this_act == ACT_CATCH\n\t\t\t{\n\t\t\t\t// Even if g.ThrownToken, no other 'catch' statements at this level should execute.\n\t\t\t\twhile (line->mActionType == ACT_CATCH)\n\t\t\t\t\tline = line->mRelatedLine;\n\t\t\t}\n\t\t\tif (line->mActionType == ACT_ELSE)\n\t\t\t\tline = line->mRelatedLine;\n\t\t\tif (line->mActionType == ACT_FINALLY)\n\t\t\t{\n\t\t\t\tif (result == OK && !jump_to_line)\n\t\t\t\t\t// Execution is being allowed to flow normally into the finally block and\n\t\t\t\t\t// then the line after. Let the next iteration handle the finally block.\n\t\t\t\t\tcontinue;\n\n\t\t\t\t// One of the following occurred:\n\t\t\t\t// - An exception was thrown, and this try..(catch)..finally block didn't handle it.\n\t\t\t\t// - A control flow statement such as break, continue or goto was used.\n\t\t\t\t// Recursively execute the finally block before continuing.\n\t\t\t\tResultToken *thrown_token = g.ThrownToken;\n\t\t\t\tg.ThrownToken = NULL; // Must clear this temporarily to avoid arbitrarily re-throwing it.\n\t\t\t\tLine *invalid_jump; // Don't overwrite jump_to_line in case the try block used goto.\n\t\t\t\tPRIVATIZE_S_DEREF_BUF; // In case return was used and is returning the contents of the deref buf.\n\t\t\t\tResultType res = line->ExecUntil(ONLY_ONE_LINE, NULL, &invalid_jump);\n\t\t\t\tDEPRIVATIZE_S_DEREF_BUF;\n\t\t\t\tif (res != OK || invalid_jump)\n\t\t\t\t{\n\t\t\t\t\tif (thrown_token) // The new error takes precedence over this one.\n\t\t\t\t\t\tg_script.FreeExceptionToken(thrown_token);\n\t\t\t\t\tif (res == FAIL || res == EARLY_EXIT)\n\t\t\t\t\t\t// Above: It's borderline whether Exit should be valid here, but it's allowed for\n\t\t\t\t\t\t// two reasons: 1) if the script was non-persistent it could have already terminated\n\t\t\t\t\t\t// anyway, and 2) it's only a question of whether to show a message before exiting.\n\t\t\t\t\t\treturn res;\n\t\t\t\t\t// The remaining cases are all invalid jumps/control flow statements. All such cases\n\t\t\t\t\t// should be detected at load time, but it seems best to keep this for maintainability:\n\t\t\t\t\treturn g_script.mCurrLine->LineError(ERR_BAD_JUMP_INSIDE_FINALLY);\n\t\t\t\t}\n\t\t\t\tg.ThrownToken = thrown_token; // If non-NULL, this was thrown within the try block.\n\t\t\t}\n\t\t\tif (g.ThrownToken && UnhandledException_was_not_called && !(g.ExcptMode & EXCPTMODE_CATCH))\n\t\t\t{\n\t\t\t\t// Known limitation: UnhandledException wasn't called when the error was thrown since a CATCH\n\t\t\t\t// was present, but it wasn't caught due to the type filter, so we have to do this here so the\n\t\t\t\t// error will be reported. The idea of calling UnhandledException early is that OnError can\n\t\t\t\t// attach a debugger which can inspect the stack before it unwinds, but at this point it has\n\t\t\t\t// already partially unwound.\n\t\t\t\t// mCurrLine is more likely to be relevant than `line`, which at this point is probably the\n\t\t\t\t// line after the TRY/ELSE. This is only used if ThrownToken doesn't have valid File/Line\n\t\t\t\t// properties; i.e. it's not a proper Error, so it's something not intended for error-reporting.\n\t\t\t\treturn g_script.UnhandledException(g_script.mCurrLine);\n\t\t\t}\n\t\t\t\n\t\t\tif (aMode == ONLY_ONE_LINE || result != OK)\n\t\t\t{\n\t\t\t\tcaller_jump_to_line = jump_to_line;\n\t\t\t\treturn result;\n\t\t\t}\n\n\t\t\tif (jump_to_line != NULL) // Implies goto or break/continue loop_name was used.\n\t\t\t{\n\t\t\t\tif (jump_to_line->mParentLine != line->mParentLine)\n\t\t\t\t{\n\t\t\t\t\tcaller_jump_to_line = jump_to_line;\n\t\t\t\t\treturn OK;\n\t\t\t\t}\n\t\t\t\tline = jump_to_line;\n\t\t\t}\n\t\t\tcontinue_ExecUntil_loop:\n\t\t\tcontinue;\n\t\t}\n\n\t\tcase ACT_FINALLY:\n\t\t{\n\t\t\t// Directly execute next line\n\t\t\tline = line->mNextLine;\n\t\t\tcontinue;\n\t\t}\n\n\t\tcase ACT_SWITCH:\n\t\t{\n\t\t\tLine *line_to_execute = NULL;\n\n\t\t\t// Privatize our deref buf so that any function calls within any of the SWITCH/CASE\n\t\t\t// expressions can allocate and use their own separate deref buf. Our deref buf\n\t\t\t// will be reused for each expression evaluation.\n\t\t\tPRIVATIZE_S_DEREF_BUF;\n\n\t\t\tsize_t switch_value_mem_size = 0;\n\t\t\tResultToken switch_value;\n\t\t\tswitch_value.mem_to_free = NULL;\n\t\t\tSymbolType switch_is_numeric = PURE_NOT_NUMERIC;\n\t\t\tStringCaseSenseType string_case_sense = SCS_INVALID; // In this case, the default value indicates numeric comparison should be used when appropriate.\n\t\t\tif (!line->mArgc) // Switch with no value: find the first 'true' case.\n\t\t\t{\n\t\t\t\tswitch_value.symbol = SYM_INVALID;\n\t\t\t\tresult = OK;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// Load time validation has ensured that at least the first parameter is present in this case.\n\t\t\t\tresult = line->ExpandSingleArg(0, switch_value, our_deref_buf, our_deref_buf_size);\n\t\t\t\tif (result == OK // Do not bother with the CaseSense parameter if the switch value expression failed.\n\t\t\t\t\t&& line->mArgc == 2)\n\t\t\t\t{\n\t\t\t\t\t// The CaseSense parameter was specified.\n\t\t\t\t\tResultToken case_sense_value;\n\t\t\t\t\tcase_sense_value.mem_to_free = NULL;\n\t\t\t\t\tsize_t mem_size = 0;\n\t\t\t\t\tresult = line->ExpandSingleArg(1, case_sense_value, case_sense_value.mem_to_free, mem_size);\n\t\t\t\t\tif (result == OK)\n\t\t\t\t\t{\n\t\t\t\t\t\tstring_case_sense = TokenToStringCase(case_sense_value);\n\n\t\t\t\t\t\tresult = string_case_sense >= SCS_INSENSITIVE_LOGICAL ? line->LineError(ERR_PARAM2_INVALID) : OK;\n\t\t\t\t\t}\n\t\t\t\t\tcase_sense_value.Free();\n\t\t\t\t}\n\t\t\t\tif (result == OK)\n\t\t\t\t{\n\t\t\t\t\tif (string_case_sense == SCS_INVALID)\n\t\t\t\t\t{\n\t\t\t\t\t\t// In this mode, numeric comparison is performed if both switch_value and case_value are\n\t\t\t\t\t\t// numeric. For performance, call IsNumeric() for switch_value only once. If non-numeric,\n\t\t\t\t\t\t// IsNumeric() calls can be avoided for each case_value. If it's an object, the comparison\n\t\t\t\t\t\t// result will be false (not an error) if case_value is not an object, as for a == b.\n\t\t\t\t\t\t// If string comparison ends up being performed, \n\t\t\t\t\t\tswitch (switch_value.symbol)\n\t\t\t\t\t\t{\n\t\t\t\t\t\tcase SYM_STRING: switch_is_numeric = IsNumeric(switch_value.marker, TRUE, FALSE, TRUE); break;\n\t\t\t\t\t\tcase SYM_OBJECT: break; // Leave switch_is_numeric at its default value, PURE_NOT_NUMERIC.\n\t\t\t\t\t\tdefault: switch_is_numeric = switch_value.symbol; break;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\t// Since the CaseSense parameter was specified, perform string comparison for every case.\n\t\t\t\t\t\t// Avoid calling IsNumeric(), for performance and because its result is not relevant.\n\t\t\t\t\t\t// It doesn't make sense to specify case sensitivity for objects, so treat that as an error\n\t\t\t\t\t\t// (otherwise EvaluateSwitchCase would ignore string_case_sense). \n\t\t\t\t\t\tif (switch_value.symbol == SYM_OBJECT)\n\t\t\t\t\t\t\tresult = TypeError(_T(\"String\"), switch_value);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (result == OK)\n\t\t\t{\n\t\t\t\tif (switch_value.symbol == SYM_STRING && switch_value.marker == our_deref_buf)\n\t\t\t\t{\n\t\t\t\t\t// Prevent the case expressions from reusing our_deref_buf, since we'll need it.\n\t\t\t\t\t// A new buf will be allocated by ExpandSingleArg() if required, which would only\n\t\t\t\t\t// be if at least one case expression is not a literal number/quoted string.\n\t\t\t\t\tswitch_value.mem_to_free = our_deref_buf;\n\t\t\t\t\tswitch_value_mem_size = our_deref_buf_size;\n\t\t\t\t\tour_deref_buf = NULL;\n\t\t\t\t\tour_deref_buf_size = 0;\n\t\t\t\t}\n\t\t\t\t// For each CASE:\n\t\t\t\tfor (Line *case_line = line->mNextLine->mNextLine; case_line && case_line->mActionType == ACT_CASE; case_line = case_line->mRelatedLine)\n\t\t\t\t{\n\t\t\t\t\tint arg, arg_count = case_line->mArgc;\n\t\t\t\t\tif (!arg_count) // The default case.\n\t\t\t\t\t{\n\t\t\t\t\t\tline_to_execute = case_line->mNextLine;\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\tfor (arg = 0; arg < arg_count; ++arg)\n\t\t\t\t\t{\n\t\t\t\t\t\tResultToken case_value;\n\t\t\t\t\t\tresult = case_line->ExpandSingleArg(arg, case_value, our_deref_buf, our_deref_buf_size);\n\t\t\t\t\t\tif (result != OK)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tline_to_execute = NULL; // Do not execute default case.\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbool found;\n\t\t\t\t\t\tif (switch_value.symbol != SYM_INVALID)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tresult = EvaluateSwitchCase(switch_value, switch_is_numeric, case_value, string_case_sense);\n\t\t\t\t\t\t\tif (result != CONDITION_TRUE && result != CONDITION_FALSE)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tline_to_execute = NULL; // Do not execute default case.\n\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tfound = result == CONDITION_TRUE;\n\t\t\t\t\t\t\tresult = OK;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tfound = TokenToBOOL(case_value);\n\t\t\t\t\t\tif (case_value.symbol == SYM_OBJECT)\n\t\t\t\t\t\t\tcase_value.object->Release();\n\t\t\t\t\t\tif (found)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tline_to_execute = case_line->mNextLine;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif (arg < arg_count)\n\t\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tif (switch_value_mem_size)\n\t\t\t\t{\n\t\t\t\t\tif (our_deref_buf)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Free the newly allocated deref buf.\n\t\t\t\t\t\tfree(our_deref_buf);\n\t\t\t\t\t\tif (our_deref_buf_size > LARGE_DEREF_BUF_SIZE)\n\t\t\t\t\t\t\t--sLargeDerefBufs;\n\t\t\t\t\t}\n\t\t\t\t\t// Restore original deref buf.\n\t\t\t\t\tour_deref_buf = switch_value.mem_to_free;\n\t\t\t\t\tour_deref_buf_size = switch_value_mem_size;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tswitch_value.Free();\n\t\t\t}\n\n\t\t\tDEPRIVATIZE_S_DEREF_BUF;\n\n\t\t\tif (line_to_execute)\n\t\t\t{\n\t\t\t\t// Above found a matching CASE. Execute the lines between it and the next CASE or block-end.\n\t\t\t\tresult = line_to_execute->ExecUntil(UNTIL_BLOCK_END, aResultToken, &jump_to_line);\n\t\t\t}\n\t\t\telse\n\t\t\t\tjump_to_line = NULL;\n\n\t\t\tif (result != OK || aMode == ONLY_ONE_LINE)\n\t\t\t{\n\t\t\t\tcaller_jump_to_line = jump_to_line;\n\t\t\t\treturn result;\n\t\t\t}\n\t\t\t\n\t\t\tif (jump_to_line != NULL)\n\t\t\t{\n\t\t\t\tif (jump_to_line->mParentLine != line->mParentLine)\n\t\t\t\t{\n\t\t\t\t\tcaller_jump_to_line = jump_to_line;\n\t\t\t\t\treturn OK;\n\t\t\t\t}\n\t\t\t\tline = jump_to_line;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t\n\t\t\t// Continue execution at the line following the block-end.\n\t\t\tline = line->mRelatedLine;\n\t\t\tcontinue;\n\t\t}\n\n\t\tcase ACT_CASE:\n\t\t\t// This is the next CASE after one that matched, so we're done.\n\t\t\treturn OK;\n\n#ifndef CONFIG_DLL\n#endif\n\t\tcase ACT_BLOCK_BEGIN:\n\t\t\tif (line->mAttribute) // This is the ACT_BLOCK_BEGIN that starts a function's body.\n\t\t\t{\n\t\t\t\t// Anytime this happens at runtime it means a function has been defined inside the\n\t\t\t\t// auto-execute section, a block, or other place the flow of execution can reach\n\t\t\t\t// on its own. This is not considered a call to the function. Instead, the entire\n\t\t\t\t// body is just skipped over using this high performance method. However, the function's\n\t\t\t\t// opening brace will show up in ListLines, but that seems preferable to the performance\n\t\t\t\t// overhead of explicitly removing it here.\n\t\t\t\tline = line->mRelatedLine; // Resume execution at the line following this functions end-block.\n\t\t\t\tcontinue; // Resume looping starting at the above line. \"continue\" is actually slight faster than \"break\" in these cases.\n\t\t\t}\n\t\t\t// In this case, line->mNextLine is already verified non-NULL by the pre-parser:\n\t\t\tresult = line->mNextLine->ExecUntil(UNTIL_BLOCK_END, aResultToken, &jump_to_line);\n\t\t\tif (jump_to_line == line)\n\t\t\t\t// Since this Block-begin's ExecUntil() encountered a Goto whose target is the\n\t\t\t\t// block-begin itself, continue with the for-loop without moving to a different\n\t\t\t\t// line. Also: stay in this recursion layer even if aMode == ONLY_ONE_LINE\n\t\t\t\t// because we don't want the caller handling it because then it's cleanup\n\t\t\t\t// to jump to its end-point (beyond its own and any unowned elses) won't work.\n\t\t\t\t// Example:\n\t\t\t\t// if x <-- If this layer were to do it, its own else would be unexpectedly encountered.\n\t\t\t\t// label1:\n\t\t\t\t// { <-- We want this statement's layer to handle the goto.\n\t\t\t\t// if y\n\t\t\t\t// goto, label1\n\t\t\t\t// else\n\t\t\t\t// ...\n\t\t\t\t// }\n\t\t\t\t// else\n\t\t\t\t// ...\n\t\t\t\tcontinue;\n\t\t\tif (aMode == ONLY_ONE_LINE\n\t\t\t\t|| result != OK) // i.e. FAIL, EARLY_RETURN, EARLY_EXIT, LOOP_BREAK, or LOOP_CONTINUE.\n\t\t\t{\n\t\t\t\t// For more detailed comments, see the section (above this switch structure) which handles IF.\n\t\t\t\tcaller_jump_to_line = jump_to_line; // Tell the caller to handle this jump (if applicable). jump_to_line==NULL is ok.\n\t\t\t\treturn result;\n\t\t\t}\n\t\t\t// Currently, all blocks are normally executed in ONLY_ONE_LINE mode because\n\t\t\t// they are the direct actions of an IF, an ELSE, or a LOOP. So the\n\t\t\t// above will already have returned except when the user has created a\n\t\t\t// generic, standalone block with no associated control statement.\n\t\t\t// Check to see if we need to jump somewhere:\n\t\t\tif (jump_to_line != NULL)\n\t\t\t{\n\t\t\t\tif (line->mParentLine != jump_to_line->mParentLine)\n\t\t\t\t{\n\t\t\t\t\tcaller_jump_to_line = jump_to_line; // Tell the caller to handle this jump (if applicable).\n\t\t\t\t\treturn OK;\n\t\t\t\t}\n\t\t\t\t// Since above didn't return, jump to where the caller told us to go, rather than the end of\n\t\t\t\t// our block.\n\t\t\t\tline = jump_to_line;\n\t\t\t}\n\t\t\telse // Just go to the end of our block and continue from there.\n\t\t\t\tline = line->mRelatedLine;\n\t\t\t\t// Now line is the line after the end of this block. Can be NULL (end of script).\n\t\t\t\t// UPDATE: It can't be NULL (not that it matters in this case) since the loader\n\t\t\t\t// has ensured that all scripts now end in an ACT_EXIT.\n\t\t\tcontinue; // Resume looping starting at the above line. \"continue\" is actually slightly faster than \"break\" in these cases.\n\n\t\tcase ACT_BLOCK_END:\n\t\t\t// v2: This check is disabled to reduce code size, as it doesn't seem to be needed\n\t\t\t// now that GOSUB has been removed. Validation in PreparseBlocks() should make it\n\t\t\t// impossible to produce this condition:\n\t\t\t//if (aMode != UNTIL_BLOCK_END)\n\t\t\t//\treturn line->LineError(_T(\"A \\\"return\\\" must be encountered prior to this \\\"}\\\".\"));\n\t\t\treturn OK; // It's the caller's responsibility to resume execution at the next line, if appropriate.\n\n\t\t// ACT_ELSE can happen when one of the cases in this switch failed to properly handle\n\t\t// aMode == ONLY_ONE_LINE. But even if ever happens, it will just drop into the default\n\t\t// case, which will result in a FAIL (silent exit of thread) as an indicator of the problem.\n\t\t// So it's commented out:\n\t\t//case ACT_ELSE:\n\t\t//\t// Shouldn't happen if the pre-parser and this function are designed properly?\n\t\t//\treturn line->LineError(\"Unexpected ELSE.\");\n\n\t\tcase ACT_ASSIGNEXPR:\n\t\t\tresult = line->PerformAssign();\n\t\t\t// Fall through:\n\t\tcase ACT_EXPRESSION:\n\t\t\t// Nothing else needs to be done because the expression in ARG1 (which is the only arg)\n\t\t\t// has already been evaluated and its functions and subfunctions called. Examples:\n\t\t\t// fn(123, \"string\", var, fn2(y))\n\t\t\t// x&=3\n\t\t\t// var ? func() : x:=y\n\t\t\tif (result != OK || aMode == ONLY_ONE_LINE)\n\t\t\t\treturn result; // Usually OK or FAIL; can also be EARLY_EXIT.\n\t\t\tline = line->mNextLine;\n\t\t\tcontinue;\n\n\t\tcase ACT_STATIC:\n\t\t\tif (result != OK)\n\t\t\t\treturn result;\n\t\t\t// If this is the function's first line, must update mJumpToLine so that it will skip this one.\n\t\t\tif (g.CurrentFunc && g.CurrentFunc->mJumpToLine == line)\n\t\t\t\tg.CurrentFunc->mJumpToLine = line->mNextLine;\n\t\t\t// Update any If/Else/Loop or similar (there can be multiple nested) that immediately precedes\n\t\t\t// this line so that they do not jump to this one after executing their body.\n\t\t\tfor (Line *parent = line->mPrevLine->mParentLine; parent && parent->mRelatedLine == line; parent = parent->mParentLine)\n\t\t\t\tparent->mRelatedLine = line->mNextLine;\n\t\t\t// Remove this line from the main list, so that it won't be executed again during normal flow.\n\t\t\tline->mPrevLine->mNextLine = line->mNextLine;\n\t\t\tline->mNextLine->mPrevLine = line->mPrevLine;\n\t\t\tif (aMode == ONLY_ONE_LINE)\n\t\t\t\treturn result;\n\t\t\tline = line->mNextLine;\n\t\t\tcontinue;\n\n\t\tcase ACT_EXIT: // In this context it's the ACT_EXIT added automatically by LoadFromFile().\n\t\t\t// Exit at the end of the auto-execute section has historically been equivalent to Return,\n\t\t\t// but with v2.1 we need this to be distinct from Exit() as it is added to the end of each\n\t\t\t// module. Modules aren't given their own initialization thread since they might want to\n\t\t\t// change default settings by design.\n\t\t\treturn OK;\n\n#ifdef _DEBUG\n\t\tdefault:\n\t\t\treturn LineError(_T(\"DEBUG: ExecUntil(): Unhandled action type.\"));\n#endif\n\t\t} // switch()\n\t} // for each line\n\n\t// Above loop ended because the end of the script was reached.\n\t// At this point, it should be impossible for aMode to be\n\t// UNTIL_BLOCK_END because that would mean that the blocks\n\t// aren't all balanced (or there is a design flaw in this\n\t// function), but they are balanced because the preparser\n\t// verified that. It should also be impossible for the\n\t// aMode to be ONLY_ONE_LINE because the function is only\n\t// called in that mode to execute the first action-line\n\t// beneath an IF or an ELSE, and the preparser has already\n\t// verified that every such IF and ELSE has a non-NULL\n\t// line after it. Finally, aMode can be UNTIL_RETURN, but\n\t// that is normal mode of operation at the top level,\n\t// so probably shouldn't be considered an error. For example,\n\t// if the script has no hotkeys, it is executed from its\n\t// first line all the way to the end. For it not to have\n\t// a RETURN or EXIT is not an error. UPDATE: The loader\n\t// now ensures that all scripts end in ACT_EXIT, so\n\t// this line should never be reached:\n\treturn OK;\n}\n\n\n\nResultType Line::EvaluateCondition()\n// Returns CONDITION_TRUE or CONDITION_FALSE (FAIL is returned only in DEBUG mode).\n{\n#ifdef _DEBUG\n\tif (mActionType != ACT_IF)\n\t\treturn LineError(_T(\"DEBUG: EvaluateCondition() was called with a line that isn't a condition.\"));\n#endif\n\n\t// The following is ordered for short-circuit performance.\n\tVar *var = mArg[0].type == ARG_TYPE_INPUT_VAR ? VAR(mArg[0]) : nullptr;\n\tbool if_condition = var ? VarToBOOL(*var) // Not verified recently: 30% faster than having ExpandArgs() resolve ARG1 even when it's a naked variable.\n\t\t: ResultToBOOL(ARG1); // CAN'T simply check *ARG1=='1' because the loadtime routine has various ways of setting if_expresion to false for things that are normally expressions.\n\n\treturn if_condition ? CONDITION_TRUE : CONDITION_FALSE;\n}\n\n\n\nResultType Line::EvaluateSwitchCase(ExprTokenType &aSwitch, SymbolType aSwitchIsNumeric, ExprTokenType &aCase, StringCaseSenseType aStringCaseSense)\n// Performs comparison of two tokens for Switch().\n{\n\tSymbolType case_is_numeric = PURE_NOT_NUMERIC;\n\tif (aStringCaseSense == SCS_INVALID)\n\t{\n\t\t// Perform numeric comparison if both aSwitch and aCase are numeric and at least one\n\t\t// is pure numeric, not a string. This should match the behaviour of SYM_EQUALCASE.\n\t\tif (aSwitchIsNumeric && !(aSwitch.symbol == SYM_STRING && aCase.symbol == SYM_STRING))\n\t\t\tcase_is_numeric = TokenIsNumeric(aCase);\n\t\t//else no need to call TokenIsNumeric(); just leave case_is_numeric set to its default\n\t\t// value so that string comparison will be used.\n\t}\n\telse // Since CaseSense was specified, unconditionally use string comparison.\n\t{\n\t\tif (aCase.symbol == SYM_OBJECT)\n\t\t\treturn TypeError(_T(\"String\"), aCase);\n\t\t// Caller has unconditionally set aSwitchIsNumeric to PURE_NOT_NUMERIC in this case,\n\t\t// and has already verified aSwitch.symbol != SYM_OBJECT.\n\t}\n\tbool equal;\n\tif (aSwitch.symbol == SYM_OBJECT || aCase.symbol == SYM_OBJECT)\n\t\tequal = aSwitch.symbol == aCase.symbol && aSwitch.object == aCase.object;\n\telse if (!case_is_numeric)\n\t{\n\t\tTCHAR left_buf[MAX_NUMBER_SIZE], *left_string = TokenToString(aSwitch, left_buf);\n\t\tTCHAR right_buf[MAX_NUMBER_SIZE], *right_string = TokenToString(aCase, right_buf);\n\t\tswitch (aStringCaseSense)\n\t\t{\n\t\tcase SCS_INSENSITIVE:\t\t\tequal = !_tcsicmp(left_string, right_string); break;\n\t\tcase SCS_INSENSITIVE_LOCALE:\tequal = !lstrcmpi(left_string, right_string); break;\n\t\tdefault:\t\t\t\t\t\tequal = !_tcscmp(left_string, right_string); break;\n\t\t}\n\t}\n\telse if (aSwitchIsNumeric == PURE_INTEGER && case_is_numeric == PURE_INTEGER)\n\t\tequal = TokenToInt64(aSwitch) == TokenToInt64(aCase);\n\telse\n\t\tequal = TokenToDouble(aSwitch) == TokenToDouble(aCase);\n\treturn equal ? CONDITION_TRUE : CONDITION_FALSE;\n}\n\n\n\n// Evaluate an #HotIf expression or callback function.\n// This is called by MainWindowProc when it receives an AHK_HOT_IF_EVAL message.\nResultType HotkeyCriterion::Eval(LPTSTR aHotkeyName)\n{\n\t// Initialize a new quasi-thread to evaluate the expression. This may not be necessary for simple\n\t// expressions, but expressions which call user-defined functions may otherwise interfere with\n\t// whatever quasi-thread is running when the hook thread requests that this expression be evaluated.\n\t\n\t// Based on parts of MsgMonitor(). See there for comments.\n\n\tif (g_nThreads >= g_MaxThreadsTotal)\n\t\treturn CONDITION_FALSE;\n\n\tbool prev_defer_messages = g_DeferMessagesForUnderlyingPump;\n\t// Force the use of PeekMessage() within MsgSleep() since GetMessage() is known to stall while\n\t// the system is waiting for our keyboard hook to return (last confirmed on Windows 10.0.18356).\n\t// This might relate to WM_TIMER being lower priority than the input hardware processing\n\t// performed by GetMessage(). MsgSleep() relies on WM_TIMER acting as a timeout for GetMessage().\n\tg_DeferMessagesForUnderlyingPump = true;\n\n\t// See MsgSleep() for comments about the following section.\n\t// Critical seems to improve reliability, either because the thread completes faster (i.e. before the timeout) or because we check for messages less often.\n\tInitNewThread(0, false, true, true);\n\n\t// Let HotIf default to the criterion currently being evaluated, in case Hotkey() is called.\n\tg->HotCriterion = this;\n\n\t// Update A_ThisHotkey, useful if #HotIf calls a function to do its dirty work.\n\tLPTSTR prior_hotkey_name[] = { g_script.mThisHotkeyName, g_script.mPriorHotkeyName };\n\tDWORD prior_hotkey_time[] = { g_script.mThisHotkeyStartTime, g_script.mPriorHotkeyStartTime };\n\tg_script.mPriorHotkeyName = g_script.mThisHotkeyName;\t\t\t// For consistency\n\tg_script.mPriorHotkeyStartTime = g_script.mThisHotkeyStartTime; //\n\tg_script.mThisHotkeyName = aHotkeyName;\n\tg_script.mThisHotkeyStartTime = // Updated for consistency.\n\tg_script.mLastPeekTime = GetTickCount();\n\n\t// CALL THE CALLBACK\n\tExprTokenType param = aHotkeyName;\n\tauto result = IObjectPtr(Callback)->ExecuteInNewThread(_T(\"#HotIf\"), ¶m, 1, true);\n\n\t// The following allows the expression to set the Last Found Window for the\n\t// hotkey function.\n\t// There may be some rare cases where the wrong hotkey gets this HWND (perhaps\n\t// if there are multiple hotkey messages in the queue), but there doesn't seem\n\t// to be any easy way around that.\n\tg_HotExprLFW = g->hWndLastUsed; // Even if above failed, for simplicity.\n\n\t// A_ThisHotkey must be restored else A_PriorHotkey will get an incorrect value later.\n\tg_script.mThisHotkeyName = prior_hotkey_name[0];\n\tg_script.mThisHotkeyStartTime = prior_hotkey_time[0];\n\tg_script.mPriorHotkeyName = prior_hotkey_name[1];\n\tg_script.mPriorHotkeyStartTime = prior_hotkey_time[1];\n\n\tResumeUnderlyingThread();\n\n\tg_DeferMessagesForUnderlyingPump = prev_defer_messages;\n\n\treturn result;\n}\n\n\n\n// The following macro is used to reduce repetition, in lieu of an inline function,\n// which wouldn't be fully inlined. Benchmarks showed this affected performance of\n// very simple loops by a few percent. Making it a macro also allows repetition of\n// the result checks to be avoided.\n//\n// Simple loops are about 6% faster by omitting the open-brace from ListLines, so\n// it seems worth it:\n//if (g.ListLinesIsEnabled)\n//\tLOG_LINE(mNextLine)\n//\n// If this loop has a block under it rather than just a single line, take a shortcut\n// and directly execute the block. This avoids one recursive call to ExecUntil()\n// for each iteration, which can speed up short/fast loops by as much as 30%.\n// Another benefit is conservation of stack space, especially during \"else if\" ladders.\n//\n// At this point, mNextLine is already verified non-NULL by the pre-parser because it\n// checks that every LOOP has a line under it (ACT_BLOCK_BEGIN in this case) and that\n// every ACT_BLOCK_BEGIN has at least one line under it.\n#define PERFORMLOOP_EXECUTE_BODY \\\n\tif (mNextLine->mActionType == ACT_BLOCK_BEGIN) \\\n\t{ \\\n\t\tdo \\\n\t\t\tresult = mNextLine->mNextLine->ExecUntil(UNTIL_BLOCK_END, aResultToken, &jump_to_line); \\\n\t\twhile (jump_to_line == mNextLine); \\\n\t} \\\n\telse \\\n\t\tresult = mNextLine->ExecUntil(ONLY_ONE_LINE, aResultToken, &jump_to_line); /* i.e. \"goto somewhere\" or \"continue a_loop_which_encloses_this_one\". */ \\\n\tif (jump_to_line && !(result == LOOP_CONTINUE && jump_to_line == this)) \\\n\t{ /* jump_to_line must be a line that's at the same level or higher as our Exec_Until's LOOP statement itself. */ \\\n\t\taJumpToLine = jump_to_line; /* Signal the caller to handle this jump. */ \\\n\t\tbreak; \\\n\t} \\\n\tif (result == LOOP_CONTINUE) /* Continue this loop (outer loops were handled via jump_to_line above). */ \\\n\t\tresult = OK; /* Don't propagate the LOOP_CONTINUE result since it has already achieved its purpose. */ \\\n\telse if (result != OK) /* i.e. result == LOOP_BREAK || result == EARLY_RETURN || result == EARLY_EXIT || result == FAIL) */ \\\n\t\tbreak;\n#define PERFORMLOOP_EVALUATE_UNTIL \\\n\tif (aUntil && aUntil->EvaluateLoopUntil(result)) \\\n\t\tbreak;\n\n\n\nResultType Line::PerformLoop(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil\n\t, __int64 aIterationLimit, bool aIsInfinite) // bool performs better than BOOL in current benchmarks for this.\n// This performs much better (by at least 7%) as a function than as inline code, probably because\n// it's only called to set up the loop, not each time through the loop.\n{\n\tResultType result = CONDITION_FALSE;\n\tLine *jump_to_line = nullptr;\n\tglobal_struct &g = *::g; // Primarily for performance in this case.\n\n\tfor (; aIsInfinite || g.mLoopIteration <= aIterationLimit; ++g.mLoopIteration)\n\t{\n\t\t// Execute the body of the loop (either just one statement or a block of statements).\n\t\t// Preparser has ensured that every LOOP has a non-NULL next line.\n\t\tPERFORMLOOP_EXECUTE_BODY\n\t\tPERFORMLOOP_EVALUATE_UNTIL\n\t\t// Since the macro didn't \"break\", the result of executing the body of the loop was either OK\n\t\t// (the current iteration completed normally) or LOOP_CONTINUE (the current loop iteration\n\t\t// was cut short). In both cases, just continue on through the loop.\n\t} // for()\n\n\t// The script's loop is now over.\n\treturn result;\n}\n\n\n\n// Lexikos: ACT_WHILE\nResultType Line::PerformLoopWhile(ResultToken *aResultToken, Line *&aJumpToLine)\n{\n\tResultType result = CONDITION_FALSE;\n\tLine *jump_to_line = nullptr;\n\tglobal_struct &g = *::g; // Might slightly speed up the loop below.\n\n\tfor (;; ++g.mLoopIteration)\n\t{\n\t\tg_script.mCurrLine = this; // For error-reporting purposes.\n#ifdef CONFIG_DEBUGGER\n\t\t// L31: Let the debugger break at the 'While' line each iteration. Before this change,\n\t\t// a While loop with empty body such as While FuncWithSideEffect() {} would be \"hit\"\n\t\t// (via breakpoint or step) only once even if the loop had multiple iterations.\n\t\t// A_Index was also reported as \"0\"; it will now be reported correctly.\n\t\tif (g_Debugger.IsConnected())\n\t\t\tg_Debugger.PreExecLine(this);\n#endif\n\t\t// Evaluate the expression only now that A_Index has been set.\n\t\tauto args_result = ExpandArgs();\n\t\tif (args_result != OK)\n\t\t\treturn args_result;\n\n\t\t// Unlike if(expression), performance isn't significantly improved to make cases like\n\t\t// \"while x\" and \"while %x%\" into non-expressions (the latter actually performs much\n\t\t// better as an expression). That is why the following check is much simpler than the\n\t\t// one used at ACT_IF in EvaluateCondition():\n\t\tif (!ResultToBOOL(ARG1))\n\t\t\tbreak;\n\n\t\tPERFORMLOOP_EXECUTE_BODY\n\n\t\t// Before re-evaluating the condition, add it to the ListLines log again. This is done\n\t\t// at the end of the loop rather than the beginning because ExecUntil already added the\n\t\t// line once immediately before the first iteration.\n\t\tif (g.ListLinesIsEnabled)\n\t\t\tLOG_LINE(this)\n\t} // for()\n\treturn result; // The script's loop is now over.\n}\n\n\n\nbool Line::EvaluateLoopUntil(ResultType &aResult)\n{\n\tg_script.mCurrLine = this; // For error-reporting purposes.\n\tif (g->ListLinesIsEnabled)\n\t\tLOG_LINE(this);\n#ifdef CONFIG_DEBUGGER\n\t// Let the debugger break at or step onto UNTIL.\n\tif (g_Debugger.IsConnected())\n\t\tg_Debugger.PreExecLine(this);\n#endif\n\taResult = ExpandArgs();\n\tif (aResult != OK)\n\t\treturn true; // i.e. if it fails, break the loop.\n\tif (ResultToBOOL(ARG1))\n\t{\n\t\taResult = LOOP_BREAK; // Break out of any recursive PerformLoopXxx() calls.\n\t\treturn true;\n\t}\n\treturn false;\n}\n\n\n\nResultType Line::PerformLoopFor(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil)\n{\n\tResultType result;\n\tLine *jump_to_line;\n\tglobal_struct &g = *::g; // Might slightly speed up the loop below.\n\n\tResultToken enum_token;\n\tenum_token.InitResult(nullptr); // buf can be null because this isn't ACT_RETURN.\n\tPRIVATIZE_S_DEREF_BUF;\n\tresult = ExpandSingleArg(mArgc - 1, enum_token, our_deref_buf, our_deref_buf_size);\n\tDEPRIVATIZE_S_DEREF_BUF;\n\tif (result != OK)\n\t\t// A script-function-call inside the expression returned EARLY_EXIT or FAIL.\n\t\treturn result;\n\t\n\tint var_count = mArgc - 1;\n\t\n\tIObject *enumerator;\n\tresult = GetEnumerator(enumerator, enum_token, var_count, true);\n\tenum_token.Free();\n\tif (result == FAIL || result == EARLY_EXIT)\n\t\treturn result;\n\n\t// \"Localize\" the loop variables.\n\tauto var_bkp = (VarBkp *)_alloca(sizeof(VarBkp) * var_count);\n\tauto var_param = (ExprTokenType**)_alloca(sizeof(ExprTokenType*) * var_count);\n\tfor (int i = 0; i < var_count; ++i)\n\t{\n\t\tExprTokenType &token = *(ExprTokenType*)_alloca(sizeof(ExprTokenType));\n\t\tvar_param[i] = &token;\n\t\tif (mArg[i].type == ARG_TYPE_OUTPUT_VAR)\n\t\t{\n\t\t\tauto var = VAR(mArg[i]);\n\t\t\tvar->Backup(var_bkp[i]);\n\t\t\ttoken.symbol = SYM_OBJECT;\n\t\t\ttoken.object = var->GetRef();\n\t\t\tif (token.object)\n\t\t\t\tcontinue;\n\t\t\tresult = FAIL;\n\t\t\tvar_count = i + 1; // Restore var_bkp and free any previous refs.\n\t\t}\n\t\t// Omitted.\n\t\ttoken.symbol = SYM_MISSING;\n\t}\n\n\t// Now that the enumerator expression has been evaluated, init A_Index:\n\tg.mLoopIteration = 1;\n\n\tif (result != FAIL)\n\tfor (result = CONDITION_FALSE;; ++g.mLoopIteration)\n\t{\n\t\tauto enum_result = CallEnumerator(enumerator, var_param, var_count, true);\n\t\tif (enum_result == FAIL || enum_result == EARLY_EXIT)\n\t\t{\n\t\t\tresult = enum_result;\n\t\t\tbreak;\n\t\t}\n\t\tif (enum_result != CONDITION_TRUE) // The enumerator returned false, which means there are no more items.\n\t\t\tbreak;\n\t\t// Otherwise the enumerator already stored the next value(s) in the variable(s) we passed it via params.\n\n\t\tPERFORMLOOP_EXECUTE_BODY\n\t\tPERFORMLOOP_EVALUATE_UNTIL\n\t} // for()\n\tenumerator->Release();\n\tfor (int i = 0; i < var_count; ++i)\n\t{\n\t\tif (mArg[i].type == ARG_TYPE_OUTPUT_VAR)\n\t\t{\n\t\t\tVar *var = VAR(mArg[i]);\n\t\t\tvar->Free(VAR_NEVER_FREE | VAR_CLEAR_ALIASES); // Release var's reference to the VarRef.\n\t\t\tvar->Restore(var_bkp[i]);\n\t\t}\n\t\tif (var_param[i]->symbol == SYM_OBJECT)\n\t\t\tvar_param[i]->object->Release();\n\t}\n\treturn result; // The script's loop is now over.\n}\n\n\n\nResultType Line::PerformLoopFilePattern(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil\n\t, FileLoopModeType aFileLoopMode, bool aRecurseSubfolders, LPTSTR aFilePattern)\n{\n\tResultType result = CONDITION_FALSE;\n\t// LoopFilesStruct is currently about 128KB, so it's probably best not to put it on the stack.\n\t// 128KB temporary usage per Loop (for all iterations) seems a reasonable trade-off for supporting\n\t// long paths while keeping code size minimal.\n\tLoopFilesStruct *plfs = new LoopFilesStruct;\n\tif (!plfs)\n\t\treturn MemoryError();\n\t// Parse aFilePattern into its components and copy into *plfs. Copies are taken because:\n\t// - As the lines of the loop are executed, the deref buffer (which is what aFilePattern might\n\t// point to if we were called from ExecUntil()) may be overwritten -- and we will need the path\n\t// string for every loop iteration.\n\t// - We relative paths resolved to full paths in case the working directory is changed after the\n\t// loop begins but before FindFirstFile() is called for a sub-directory.\n\t// - Several built-in variables rely on the paths stored in *plfs and updated on each iteration.\n\t// This approach means a little up-front work that mightn't be needed, but greatly improves\n\t// performance in some common cases, such as if A_LoopFileLongPath is used on each iteration.\n\tif (ParseLoopFilePattern(aFilePattern, *plfs, result))\n\t\tresult = PerformLoopFilePattern(aResultToken, aJumpToLine, aUntil, aFileLoopMode, aRecurseSubfolders, *plfs);\n\t//else: leave result == CONDITION_FALSE, since in effect, no files were found.\n\tdelete plfs;\n\treturn result;\n}\n\n\n\nbool Line::ParseLoopFilePattern(LPTSTR aFilePattern, LoopFilesStruct &lfs, ResultType &aResult)\n// Parse aFilePattern and initialize lfs.\n{\n\tif (!*aFilePattern) // Some checks below may rely on empty aFilePattern having been excluded.\n\t\t// FindFirstFile() would find nothing in this case, but continuing may cause unnecessary\n\t\t// rescursion through all subdirectories of the working directory.\n\t\treturn false;\n\t// Note: Even if aFilePattern is just a directory (i.e. with no wildcard pattern), it seems best\n\t// not to append \"\\\\*.*\" to it because the pattern might be a script variable that the user wants\n\t// to conditionally resolve to various things at runtime. In other words, it's valid to have\n\t// only a single directory be the target of the loop.\n\t\n\t// v1.1.31.00: This function was revised.\n\t// - Resolve aFilePattern to a full path immediately so that changing the working directory\n\t// does not disrupt recursion or A_LoopFileLongPath/ShortPath.\n\t// - Take care that path lengths are not limited to below what the system allows.\n\t// That is, directory+pattern can be up to MAX_PATH on ANSI and 32767 on Unicode,\n\t// although the latter requires the \\\\?\\ prefix or Windows 10 long path awareness.\n\t// - Optimize A_LoopFileLongPath and A_LoopFileShortPath by resolving the path prefix\n\t// up-front and utilizing the names returned by FindFirstFile() during the loop.\n\t// This can be much faster because file system access is minimized. Benchmarks\n\t// showed improvement even for single-iteration loops which use A_LoopFileLongPath.\n\t\n\t// Prior to v1.1.31.00, A_LoopFileLongPath worked as follows:\n\t// - Each reference to A_LoopFileLongPath results in two BIV_LoopFileLongPath calls.\n\t// - BIV_LoopFileLongPath calls GetFullPathName() and ConvertFilespecToCorrectCase().\n\t// - CFTCC() calls FindFirstFile() once for each slash-delimited name.\n\t// - For example, with \"c:\\foo\\bar\\baz.txt\", A_LoopFileLongPath results in SIX calls to\n\t// FindFirstFile().\n\n\t// Find the final name or pattern component of aFilePattern.\n\tLPTSTR name_part, cp;\n\tfor (name_part = cp = aFilePattern; *cp; cp++)\n\t\tif (*cp == '\\\\' || *cp == '/')\n\t\t\tname_part = cp + 1;\n\n\tif (name_part == aFilePattern && *name_part && name_part[1] == ':') // Single character followed by ':' but not '\\\\' or '/'.\n\t\tname_part += 2;\n\t\n\tsize_t pattern_length = cp - name_part;\n\tif (pattern_length > _countof(lfs.pattern)) // Most likely too long to match a real path/filename.\n\t\treturn false; \n\ttmemcpy(lfs.pattern, name_part, pattern_length + 1);\n\tlfs.pattern_length = pattern_length;\n\n\tsize_t orig_dir_length = name_part - aFilePattern;\n\tif (orig_dir_length)\n\t{\n\t\tif ( !(lfs.orig_dir = tmalloc(orig_dir_length + 1)) )\n\t\t{\n\t\t\taResult = MemoryError();\n\t\t\treturn false;\n\t\t}\n\t\ttmemcpy(lfs.orig_dir, aFilePattern, orig_dir_length);\n\t\tlfs.orig_dir[orig_dir_length] = '\\0';\n\t\tlfs.orig_dir_length = orig_dir_length;\n\t}\n\telse\n\t{\n\t\tlfs.orig_dir = _T(\"\");\n\t\tlfs.orig_dir_length = 0;\n\t}\n\n\t// The following aren't checked because A_LoopFileLongPath requires that GetFullPathName()\n\t// be called unconditionally so that relative references such as \"x\\..\\y\" are resolved:\n\t//if ( !(aFilePattern[1] == ':' && aFilePattern[2] == '\\\\') // Not an absolute path with drive letter (must have slash, as \"C:xxx\" is not fully qualified).\n\t//\t&& !(*aFilePattern == '\\\\' && aFilePattern[1] == '\\\\') ) // Not a UNC path.\n\n\t// Testing shows that GetFullPathNameW() supports longer than MAX_PATH even on Windows XP.\n\t// MSDN: \"In the ANSI version of this function, the name is limited to MAX_PATH characters.\n\t// To extend this limit to 32,767 wide characters, call the Unicode version of the function\n\t// (GetFullPathNameW), and prepend \"\\\\?\\\" to the path. \"\n\t// But that's obviously incorrect, since prepending \"\\\\?\\\" would make it an absolute path.\n\t// Instead, we just call it without the prefix, and this works (on Unicode builds).\n\tLPCTSTR dir_to_resolve = *lfs.orig_dir ? lfs.orig_dir : _T(\".\\\\\"); // Include a trailing slash so there will be one in the result.\n\tlfs.file_path_length = GetFullPathName(dir_to_resolve, _countof(lfs.file_path), lfs.file_path, NULL);\n\tif (!lfs.file_path_length)\n\t\t// It's unclear under what conditions GetFullPathName() can fail, but the most likely\n\t\t// cause is that the buffer is too small (and even this is unlikely on Unicode builds).\n\t\t// With current buffer sizes, that implies the path is too long for FindFirstFile().\n\t\treturn false;\n\n\tif (lfs.file_path[lfs.file_path_length - 1] != '\\\\') // aFilePattern was \"x:pattern\" with no slash.\n\t{\n\t\tlfs.file_path[lfs.file_path_length++] = '\\\\';\n\t\tlfs.file_path[lfs.file_path_length] = '\\0';\n\t}\n\t\n\t// Mark the part of file_path which will contain discovered sub-directories/files.\n\t// This will be appended to orig_dir to get the value of A_LoopFilePath.\n\tlfs.file_path_suffix = lfs.file_path + lfs.file_path_length;\n\t\n\t// Correct case and convert any short names to long names for A_LoopFileLongPath.\n\tLPTSTR long_dir;\n\tTCHAR long_dir_buf[MAX_WIDE_PATH]; // Max expanded length is probably about 8k on ANSI, but this covers all builds.\n\tif ( !(long_dir = ConvertFilespecToCorrectCase(lfs.file_path, long_dir_buf, _countof(long_dir_buf), lfs.long_dir_length)) )\n\t{\n\t\t// Conversion failed. In theory, FindFirstFile() can fail for a parent directory\n\t\t// but succeed for the full path, so use file_path as-is and attempt to continue.\n\t\t// Since this is rare, _tcsdup() is still used below rather than aliasing file_path\n\t\t// (which would require avoiding free() in that case).\n\t\tlong_dir = lfs.file_path;\n\t\tlfs.long_dir_length = lfs.file_path_length;\n\t}\n\tif ( !(lfs.long_dir = _tcsdup(long_dir)) ) // Conserve memory during loop execution by not using the full MAX_WIDE_PATH.\n\t{\n\t\taResult = MemoryError();\n\t\treturn false;\n\t}\n\n\t// For simplicity/code size, get the short path unconditionally, even though it's more\n\t// rarely used than the long path (and not required for the loop to function). Having the\n\t// short path built in advance helps performance for loops which use it.\n\t// Testing and research shows that GetShortPathName() uses the long name for a directory\n\t// or file if no short name exists, so it can be as long as orig_dir (also, see below).\n\tlfs.short_path_length = GetShortPathName(lfs.orig_dir, lfs.short_path, _countof(lfs.short_path));\n\tif (lfs.short_path_length > _countof(lfs.short_path)) // Buffer was too small.\n\t\t// This can only occur if the short path is longer than the long path (file_path),\n\t\t// which is possible for names which are short but don't comply with 8.3 rules,\n\t\t// such as \".vs\", which might have the 8.3 name \"VS4DA5~1\". Even so, file_path\n\t\t// must be near the limit for short_path to exceed it.\n\t\treturn false; // short_path and short_path_length aren't valid, so just abort.\n\n\treturn true; // aFilePattern parsed and all members initialized okay.\n}\n\n\n\nResultType Line::PerformLoopFilePattern(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil\n\t, FileLoopModeType aFileLoopMode, bool aRecurseSubfolders, LoopFilesStruct &lfs)\n// This is the recursive part, called for each sub-directory when aRecurseSubfolders is true.\n// Caller has allocated buffers (lfs) and filled in the initial paths and filename/pattern.\n{\n\t// Save current lengths before modification.\n\tsize_t file_path_length = lfs.file_path_length;\n\tsize_t short_path_length = lfs.short_path_length;\n\tlfs.dir_length = file_path_length; // During the loop, lfs.file_path_length will include the filename.\n\t\n\tif (!lfs.pattern_length && lfs.orig_dir_length == 2 && lfs.orig_dir[1] == ':')\n\t{\n\t\t// Handle \"C:\" by changing the pattern to \".\" to match the directory itself,\n\t\t// otherwise it would fail since lfs.file_path contains a trailing slash.\n\t\t// Search for \"=C:\" in SetWorkingDir() for explanation of \"C:\" vs. \"C:\\\".\n\t\tlfs.pattern[0] = '.';\n\t\tlfs.pattern[1] = '\\0';\n\t\tlfs.pattern_length = 1;\n\t\t// Disable recursion since \".\" would otherwise be found in every sub-directory.\n\t\taRecurseSubfolders = false;\n\t}\n\n\tLPTSTR file_path_end = lfs.file_path + file_path_length;\n\tsize_t file_space_remaining = _countof(lfs.file_path) - file_path_length;\n\tif (lfs.pattern_length >= file_space_remaining)\n\t\treturn CONDITION_FALSE;\n\ttmemcpy(file_path_end, lfs.pattern, lfs.pattern_length + 1); // file_path already includes the slash.\n\n\tBOOL file_found;\n\tHANDLE file_search = FindFirstFile(lfs.file_path, &lfs);\n\tfor ( file_found = (file_search != INVALID_HANDLE_VALUE) // Convert FindFirst's return value into a boolean so that it's compatible with FindNext's.\n\t\t; file_found && FileIsFilteredOut(lfs, aFileLoopMode)\n\t\t; file_found = FindNextFile(file_search, &lfs));\n\t// file_found and lfs have now been set for use below.\n\t// Above is responsible for having properly set file_found and file_search.\n\n\tResultType result = CONDITION_FALSE; // Default to \"no iterations executed\".\n\tLine *jump_to_line = nullptr;\n\tglobal_struct &g = *::g; // Primarily for performance in this case.\n\n\tg.mLoopFile = &lfs; // inner file-loop's file takes precedence over any outer file-loop's.\n\t// Other types of loops leave g.mLoopFile unchanged so that a file-loop can enclose some other type of\n\t// inner loop, and that inner loop will still have access to the outer loop's current file.\n\n\tfor (; file_found; ++g.mLoopIteration)\n\t{\n\t\tPERFORMLOOP_EXECUTE_BODY\n\t\tPERFORMLOOP_EVALUATE_UNTIL\n\t\t\n\t\t// The macro above will \"break\", depending on result and jump_to_line.\n\t\t// Otherwise, the result of executing the body of the loop, above, was either OK\n\t\t// (the current iteration completed normally) or LOOP_CONTINUE (the current loop\n\t\t// iteration was cut short). In both cases, just continue on through the loop.\n\t\t// But first do end-of-iteration steps:\n\t\twhile ((file_found = FindNextFile(file_search, &lfs))\n\t\t\t&& FileIsFilteredOut(lfs, aFileLoopMode)); // Relies on short-circuit boolean order.\n\t\t\t// Above is a self-contained loop that keeps fetching files until there's no more files, or a file\n\t\t\t// is found that isn't filtered out. It also sets file_found and lfs for use by the outer loop.\n\t} // for()\n\n\t// The script's loop is now over.\n\tif (file_search != INVALID_HANDLE_VALUE)\n\t\tFindClose(file_search);\n\n\tif (result != OK && result != CONDITION_FALSE || aJumpToLine)\n\t\treturn result;\n\n\t// If aRecurseSubfolders is true, we now need to perform the loop's body for every subfolder to\n\t// search for more files and folders inside that match aFilePattern. We can't do this in the\n\t// first loop, above, because it may have a restricted file-pattern such as *.txt and we want to\n\t// find and recurse into ALL folders:\n\tif (!aRecurseSubfolders) // No need to continue into the \"recurse\" section.\n\t\treturn result;\n\n\t// Since above didn't return, this is a file-loop and recursion into sub-folders has been requested.\n\t// Append * to file_path so that we can retrieve all files and folders in the aFilePattern main dir.\n\t// We're only interested in the folders, but there's no special pattern that would filter out files.\n\tfile_path_end[0] = '*'; // There's always room for this since it's shorter than lfs.pattern.\n\tfile_path_end[1] = '\\0';\n\tfile_search = FindFirstFile(lfs.file_path, &lfs);\n\tif (file_search == INVALID_HANDLE_VALUE)\n\t\treturn result; // Nothing more to do.\n\t// Otherwise, recurse into any subdirectories found inside this parent directory.\n\n\tLPTSTR short_path_end = lfs.short_path + short_path_length;\n\tsize_t short_space_remaining = _countof(lfs.short_path) - short_path_length;\n\n\tdo\n\t{\n\t\tif (!(lfs.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) // We only want directories (except \".\" and \"..\").\n\t\t\t|| lfs.cFileName[0] == '.' && (!lfs.cFileName[1] // Relies on short-circuit boolean order.\n\t\t\t\t|| lfs.cFileName[1] == '.' && !lfs.cFileName[2])) //\n\t\t\tcontinue;\n\n\t\tsize_t this_dir_length = _tcslen(lfs.cFileName);\n\t\tif (this_dir_length + 1 >= file_space_remaining)\n\t\t\t// This should be virtually impossible because:\n\t\t\t// - Unicode builds allow 32767 chars, which is also the limit for most APIs.\n\t\t\t// - ANSI builds allow MAX_PATH*2 (520), but FindFirstFileA() would fail for any\n\t\t\t// file pattern longer than MAX_PATH, and cFileName itself is MAX_PATH chars max.\n\t\t\tcontinue;\n\n\t\t// Append the directory name\\ to file_path.\n\t\ttmemcpy(file_path_end, lfs.cFileName, this_dir_length);\n\t\tfile_path_end[this_dir_length] = '\\\\';\n\t\tfile_path_end[this_dir_length + 1] = '\\0';\n\t\tlfs.file_path_length = file_path_length + this_dir_length + 1;\n\n\t\t// Append the directory's short (8.3) name to short_path.\n\t\tLPTSTR short_name = lfs.cAlternateFileName;\n\t\tsize_t short_name_length = _tcslen(short_name);\n\t\tif (!short_name_length)\n\t\t{\n\t\t\tshort_name = lfs.cFileName; // See BIV_LoopFileName for comments about why cFileName is used.\n\t\t\tshort_name_length = this_dir_length;\n\t\t}\n\t\tif (short_name_length + 1 >= short_space_remaining) // Should realistically never happen, but it's possible for an 8.3 name to be longer than the non-8.3 name.\n\t\t\tcontinue;\n\t\ttmemcpy(short_path_end, short_name, short_name_length);\n\t\tshort_path_end[short_name_length] = '\\\\';\n\t\tshort_path_end[short_name_length + 1] = '\\0';\n\t\tlfs.short_path_length = short_path_length + short_name_length + 1;\n\n\t\tauto sub_result = PerformLoopFilePattern(aResultToken, aJumpToLine, aUntil, aFileLoopMode, aRecurseSubfolders, lfs);\n\t\t// Above returns LOOP_CONTINUE for cases like \"continue 2\" or \"continue outer_loop\", where the\n\t\t// target is not this Loop but a Loop which encloses it. In those cases we want below to return:\n\t\tif (sub_result != CONDITION_FALSE)\n\t\t{\n\t\t\tresult = sub_result;\n\t\t\tif (result != OK) // i.e. result == LOOP_BREAK || result == EARLY_RETURN || result == EARLY_EXIT || result == FAIL\n\t\t\t\tbreak;\n\t\t\tif (aJumpToLine)\n\t\t\t\tbreak; // Return and let our caller handle the jump.\n\t\t}\n\t\t// Otherwise, the recursive call performed no iterations, but result could already be\n\t\t// OK or CONDITION_FALSE depending on whether iterations were performed by this layer.\n\t} while (FindNextFile(file_search, &lfs));\n\t\n\tFindClose(file_search);\n\treturn result; // Return even LOOP_BREAK, since our caller can be either ExecUntil() or ourself.\n}\n\n\n\nResultType Line::PerformLoopReg(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil\n\t, FileLoopModeType aFileLoopMode, bool aRecurseSubfolders, HKEY aRootKeyType, HKEY aRootKey, LPTSTR aRegSubkey)\n// aRootKeyType is the type of root key, independent of whether it's local or remote.\n// This is used because there's no easy way to determine which root key a remote HKEY\n// refers to.\n{\n\tRegItemStruct reg_item(aRootKeyType, aRootKey, aRegSubkey);\n\tHKEY hRegKey;\n\n\t// Open the specified subkey. Be sure to only open with the minimum permission level so that\n\t// the keys & values can be deleted or written to (though I'm not sure this would be an issue\n\t// in most cases):\n\tif (RegOpenKeyEx(reg_item.root_key, reg_item.subkey, 0, KEY_QUERY_VALUE | KEY_ENUMERATE_SUB_KEYS | g->RegView, &hRegKey) != ERROR_SUCCESS)\n\t\treturn CONDITION_FALSE;\n\n\t// Get the count of how many values and subkeys are contained in this parent key:\n\tDWORD count_subkeys;\n\tDWORD count_values;\n\tif (RegQueryInfoKey(hRegKey, NULL, NULL, NULL, &count_subkeys, NULL, NULL\n\t\t, &count_values, NULL, NULL, NULL, NULL) != ERROR_SUCCESS)\n\t{\n\t\tRegCloseKey(hRegKey);\n\t\treturn CONDITION_FALSE;\n\t}\n\n\tResultType result = CONDITION_FALSE;\n\tLine *jump_to_line = nullptr;\n\tDWORD i;\n\tglobal_struct &g = *::g; // Primarily for performance in this case.\n\n\t// See comments in PerformLoop() for details about this section.\n\t#define MAKE_SCRIPT_LOOP_PROCESS_THIS_ITEM \\\n\t{\\\n\t\tg.mLoopRegItem = ®_item;\\\n\t\tPERFORMLOOP_EXECUTE_BODY \\\n\t\tPERFORMLOOP_EVALUATE_UNTIL \\\n\t\t++g.mLoopIteration;\\\n\t}\n\n\tDWORD name_size;\n\n\t// First enumerate the values, which are analogous to files in the file system.\n\t// Later, the subkeys (\"subfolders\") will be done:\n\tif (count_values > 0 && aFileLoopMode != FILE_LOOP_FOLDERS_ONLY) // The caller doesn't want \"files\" (values) excluded.\n\t{\n\t\treg_item.InitForValues();\n\t\t// Going in reverse order allows values to be deleted without disrupting the enumeration,\n\t\t// at least in some cases:\n\t\tfor (i = count_values - 1;; --i) \n\t\t{ \n\t\t\t// Don't use CONTINUE in loops such as this due to the loop-ending condition being explicitly\n\t\t\t// checked at the bottom.\n\t\t\tname_size = _countof(reg_item.name); // Must reset this every time through the loop.\n\t\t\t*reg_item.name = '\\0';\n\t\t\tif (RegEnumValue(hRegKey, i, reg_item.name, &name_size, NULL, ®_item.type, NULL, NULL) == ERROR_SUCCESS)\n\t\t\t\tMAKE_SCRIPT_LOOP_PROCESS_THIS_ITEM\n\t\t\t// else continue the loop in case some of the lower indexes can still be retrieved successfully.\n\t\t\tif (i == 0) // Check this here due to it being an unsigned value that we don't want to go negative.\n\t\t\t\tbreak;\n\t\t}\n\t\tif (result != OK && result != CONDITION_FALSE || aJumpToLine)\n\t\t{\n\t\t\tRegCloseKey(hRegKey);\n\t\t\treturn result;\n\t\t}\n\t}\n\n\t// If the loop is neither processing subfolders nor recursing into them, don't waste the performance\n\t// doing the next loop:\n\tif (!count_subkeys || (aFileLoopMode == FILE_LOOP_FILES_ONLY && !aRecurseSubfolders))\n\t{\n\t\tRegCloseKey(hRegKey);\n\t\treturn result;\n\t}\n\n\t// Enumerate the subkeys, which are analogous to subfolders in the files system:\n\t// Going in reverse order allows keys to be deleted without disrupting the enumeration,\n\t// at least in some cases:\n\treg_item.InitForSubkeys();\n\tTCHAR subkey_full_path[MAX_REG_ITEM_SIZE]; // But doesn't include the root key name, which is not only by design but testing shows that if it did, the length could go over MAX_REG_ITEM_SIZE.\n\tfor (i = count_subkeys - 1;; --i) // Will have zero iterations if there are no subkeys.\n\t{\n\t\t// Don't use CONTINUE in loops such as this due to the loop-ending condition being explicitly\n\t\t// checked at the bottom.\n\t\tname_size = _countof(reg_item.name); // Must be reset for every iteration.\n\t\tif (RegEnumKeyEx(hRegKey, i, reg_item.name, &name_size, NULL, NULL, NULL, ®_item.ftLastWriteTime) == ERROR_SUCCESS)\n\t\t{\n\t\t\tif (aFileLoopMode != FILE_LOOP_FILES_ONLY) // have the script's loop process this subkey.\n\t\t\t\tMAKE_SCRIPT_LOOP_PROCESS_THIS_ITEM\n\t\t\tif (aRecurseSubfolders) // Now recurse into the subkey, regardless of whether it was processed above.\n\t\t\t{\n\t\t\t\t// Build the new subkey name using the an area of memory on the stack that we won't need\n\t\t\t\t// after the recursive call returns to us. Omit the leading backslash if subkey is blank,\n\t\t\t\t// which supports recursively searching the contents of keys contained within a root key\n\t\t\t\t// (fixed for v1.0.17):\n\t\t\t\tsntprintf(subkey_full_path, _countof(subkey_full_path), _T(\"%s%s%s\"), reg_item.subkey\n\t\t\t\t\t, *reg_item.subkey ? _T(\"\\\\\") : _T(\"\"), reg_item.name);\n\t\t\t\t// This section is very similar to the one in PerformLoopFilePattern(), so see it for comments:\n\t\t\t\tauto sub_result = PerformLoopReg(aResultToken, aJumpToLine, aUntil\n\t\t\t\t\t, aFileLoopMode , aRecurseSubfolders, aRootKeyType, aRootKey, subkey_full_path);\n\t\t\t\tif (sub_result != CONDITION_FALSE)\n\t\t\t\t{\n\t\t\t\t\tresult = sub_result;\n\t\t\t\t\tif (result != OK) // i.e. result == LOOP_BREAK || result == EARLY_RETURN || result == EARLY_EXIT || result == FAIL\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tif (aJumpToLine)\n\t\t\t\t\t\tbreak; // Return and let our caller handle the jump.\n\t\t\t\t}\n\t\t\t\t// Otherwise, the recursive call performed no iterations, but result could already be\n\t\t\t\t// OK or CONDITION_FALSE depending on whether iterations were performed by this layer.\n\t\t\t}\n\t\t}\n\t\t// else continue the loop in case some of the lower indexes can still be retrieved successfully.\n\t\tif (i == 0) // Check this here due to it being an unsigned value that we don't want to go negative.\n\t\t\tbreak;\n\t}\n\tRegCloseKey(hRegKey);\n\treturn result;\n}\n\n\n\nResultType Line::PerformLoopParse(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil)\n{\n\tif (!*ARG1) // Since the input variable's contents are blank, the loop will execute zero times.\n\t\treturn CONDITION_FALSE;\n\n\t// The following will be used to hold the parsed items. It needs to have its own storage because\n\t// even though ARG1 might always be a writable memory area, we can't rely upon it being\n\t// persistent because it might reside in the deref buffer, in which case the other commands\n\t// in the loop's body would probably overwrite it. Even if the ARG1's contents aren't in\n\t// the deref buffer, we still can't modify it (i.e. to temporarily terminate it and thus\n\t// bypass the need for malloc() below) because that might modify the variable contents, and\n\t// that variable may be referenced elsewhere in the body of the loop (which would result\n\t// in unexpected side-effects). So, rather than have a limit of 64K or something (which\n\t// would limit this feature's usefulness for parsing a large list of filenames, for example),\n\t// it seems best to dynamically allocate a temporary buffer large enough to hold the\n\t// contents of ARG1 (the input variable). Update: Since these loops tend to be enclosed\n\t// by file-read loops, and thus may be called thousands of times in a short period,\n\t// it should help average performance to use the stack for small vars rather than\n\t// constantly doing malloc() and free(), which are much higher overhead and probably\n\t// cause memory fragmentation (especially with thousands of calls):\n\tsize_t space_needed = ArgLength(1) + 1; // +1 for the zero terminator.\n\tLPTSTR stack_buf, buf;\n\t#define FREE_PARSE_MEMORY if (buf != stack_buf) free(buf) // Also used by the CSV version of this function.\n\t#define LOOP_PARSE_BUF_SIZE 40000 //\n\tif (space_needed <= LOOP_PARSE_BUF_SIZE)\n\t{\n\t\tstack_buf = (LPTSTR)talloca(space_needed); // Helps performance. See comments above.\n\t\tbuf = stack_buf;\n\t}\n\telse\n\t{\n\t\tif ( !(buf = tmalloc(space_needed)) )\n\t\t\t// Probably best to consider this a critical error, since on the rare times it does happen, the user\n\t\t\t// would probably want to know about it immediately.\n\t\t\treturn MemoryError();\n\t\tstack_buf = NULL; // For comparison purposes later below.\n\t}\n\t_tcscpy(buf, ARG1); // Make the copy.\n\n\t// Make a copy of ARG2 and ARG3 in case either one's contents are in the deref buffer, which would\n\t// probably be overwritten by the commands in the script loop's body:\n\tTCHAR delimiters[512], omit_list[512];\n\ttcslcpy(delimiters, ARG2, _countof(delimiters));\n\ttcslcpy(omit_list, ARG3, _countof(omit_list));\n\n\tResultType result = CONDITION_FALSE;\n\tLine *jump_to_line = nullptr;\n\tTCHAR *field, *field_end, saved_char;\n\tsize_t field_length;\n\tglobal_struct &g = *::g; // Primarily for performance in this case.\n\n\tfor (field = buf;;)\n\t{ \n\t\tif (*delimiters)\n\t\t{\n\t\t\tif ( !(field_end = StrChrAny(field, delimiters)) ) // No more delimiters found.\n\t\t\t\tfield_end = field + _tcslen(field); // Set it to the position of the zero terminator instead.\n\t\t}\n\t\telse // Since no delimiters, every char in the input string is treated as a separate field.\n\t\t{\n\t\t\t// But exclude this char if it's in the omit_list:\n\t\t\tif (*omit_list && _tcschr(omit_list, *field))\n\t\t\t{\n\t\t\t\t++field; // Move on to the next char.\n\t\t\t\tif (!*field) // The end of the string has been reached.\n\t\t\t\t\tbreak;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tfield_end = field + 1;\n\t\t}\n\n\t\tsaved_char = *field_end; // In case it's a non-delimited list of single chars.\n\t\t*field_end = '\\0'; // Temporarily terminate so that GetLoopField() will see the correct substring.\n\n\t\tif (*omit_list && *field && *delimiters) // If no delimiters, the omit_list has already been handled above.\n\t\t{\n\t\t\t// Process the omit list.\n\t\t\tfield = omit_leading_any(field, omit_list, field_end - field);\n\t\t\tif (*field) // i.e. the above didn't remove all the chars due to them all being in the omit-list.\n\t\t\t{\n\t\t\t\tfield_length = omit_trailing_any(field, omit_list, field_end - 1);\n\t\t\t\tfield[field_length] = '\\0'; // Terminate here, but don't update field_end, since saved_char needs it.\n\t\t\t}\n\t\t}\n\n\t\tg.mLoopField = field;\n\n\t\tPERFORMLOOP_EXECUTE_BODY\n\t\tPERFORMLOOP_EVALUATE_UNTIL\n\n\t\tif (!saved_char) // The last item in the list has just been processed, so the loop is done.\n\t\t\tbreak;\n\t\t*field_end = saved_char; // Undo the temporary termination, in case the list of delimiters is blank.\n\t\tfield = *delimiters ? field_end + 1 : field_end; // Move on to the next field.\n\t\t++g.mLoopIteration;\n\t}\n\tFREE_PARSE_MEMORY;\n\treturn result;\n}\n\n\n\nResultType Line::PerformLoopParseCSV(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil)\n// This function is similar to PerformLoopParse() so the two should be maintained together.\n// See PerformLoopParse() for comments about the below (comments have been mostly stripped\n// from this function).\n{\n\tif (!*ARG1) // Since the input variable's contents are blank, the loop will execute zero times.\n\t\treturn CONDITION_FALSE;\n\n\t// See comments in PerformLoopParse() for details.\n\tsize_t space_needed = ArgLength(1) + 1; // +1 for the zero terminator.\n\tLPTSTR stack_buf, buf;\n\tif (space_needed <= LOOP_PARSE_BUF_SIZE)\n\t{\n\t\tstack_buf = (LPTSTR)talloca(space_needed); // Helps performance. See comments above.\n\t\tbuf = stack_buf;\n\t}\n\telse\n\t{\n\t\tif ( !(buf = tmalloc(space_needed)) )\n\t\t\treturn MemoryError();\n\t\tstack_buf = NULL; // For comparison purposes later below.\n\t}\n\t_tcscpy(buf, ARG1); // Make the copy.\n\n\tTCHAR omit_list[512];\n\ttcslcpy(omit_list, ARG3, _countof(omit_list));\n\n\tResultType result = CONDITION_FALSE;\n\tLine *jump_to_line = nullptr;\n\tTCHAR *field, *field_end, saved_char;\n\tsize_t field_length;\n\tbool field_is_enclosed_in_quotes;\n\tglobal_struct &g = *::g; // Primarily for performance in this case.\n\n\tfor (field = buf;;)\n\t{\n\t\tif (*field == '\"')\n\t\t{\n\t\t\t// For each field, check if the optional leading double-quote is present. If it is,\n\t\t\t// skip over it since we always know it's the one that marks the beginning of\n\t\t\t// the that field. This assumes that a field containing escaped double-quote is\n\t\t\t// always contained in double quotes, which is how Excel does it. For example:\n\t\t\t// \"\"\"string with escaped quotes\"\"\" resolves to a literal quoted string:\n\t\t\tfield_is_enclosed_in_quotes = true;\n\t\t\t++field;\n\t\t}\n\t\telse\n\t\t\tfield_is_enclosed_in_quotes = false;\n\n\t\tfor (field_end = field;;)\n\t\t{\n\t\t\tif ( !(field_end = _tcschr(field_end, field_is_enclosed_in_quotes ? '\"' : ',')) )\n\t\t\t{\n\t\t\t\t// This is the last field in the string, so set field_end to the position of\n\t\t\t\t// the zero terminator instead:\n\t\t\t\tfield_end = field + _tcslen(field);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (field_is_enclosed_in_quotes)\n\t\t\t{\n\t\t\t\t// The quote discovered above marks the end of the string if it isn't followed\n\t\t\t\t// by another quote. But if it is a pair of quotes, replace it with a single\n\t\t\t\t// literal double-quote and then keep searching for the real ending quote:\n\t\t\t\tif (field_end[1] == '\"') // A pair of quotes was encountered.\n\t\t\t\t{\n\t\t\t\t\ttmemmove(field_end, field_end + 1, _tcslen(field_end + 1) + 1); // +1 to include terminator.\n\t\t\t\t\t++field_end; // Skip over the literal double quote that we just produced.\n\t\t\t\t\tcontinue; // Keep looking for the \"real\" ending quote.\n\t\t\t\t}\n\t\t\t\t// Otherwise, this quote marks the end of the field, so just fall through and break.\n\t\t\t}\n\t\t\t// else field is not enclosed in quotes, so the comma discovered above must be a delimiter.\n\t\t\tbreak;\n\t\t}\n\n\t\tsaved_char = *field_end; // This can be the terminator, a comma, or a double-quote.\n\t\t*field_end = '\\0'; // Terminate here so that GetLoopField() will see the correct substring.\n\n\t\tif (*omit_list && *field)\n\t\t{\n\t\t\t// Process the omit list.\n\t\t\tfield = omit_leading_any(field, omit_list, field_end - field);\n\t\t\tif (*field) // i.e. the above didn't remove all the chars due to them all being in the omit-list.\n\t\t\t{\n\t\t\t\tfield_length = omit_trailing_any(field, omit_list, field_end - 1);\n\t\t\t\tfield[field_length] = '\\0'; // Terminate here, but don't update field_end, since we need its pos.\n\t\t\t}\n\t\t}\n\n\t\tg.mLoopField = field;\n\n\t\tPERFORMLOOP_EXECUTE_BODY\n\t\tPERFORMLOOP_EVALUATE_UNTIL\n\n\t\tif (!saved_char) // The last item in the list has just been processed, so the loop is done.\n\t\t\tbreak;\n\t\tif (saved_char == ',') // Set \"field\" to be the position of the next field.\n\t\t\tfield = field_end + 1;\n\t\telse // saved_char must be a double-quote char.\n\t\t{\n\t\t\tfield = field_end + 1;\n\t\t\tif (!*field) // No more fields occur after this one.\n\t\t\t\tbreak;\n\t\t\t// Find the next comma, which must be a real delimiter since we're in between fields:\n\t\t\tif ( !(field = _tcschr(field, ',')) ) // No more fields.\n\t\t\t\tbreak;\n\t\t\t// Set it to be the first character of the next field, which might be a double-quote\n\t\t\t// or another comma (if the field is empty).\n\t\t\t++field;\n\t\t}\n\t\t++g.mLoopIteration;\n\t}\n\tFREE_PARSE_MEMORY;\n\treturn result;\n}\n\n\n\nResultType Line::PerformLoopReadFile(ResultToken *aResultToken, Line *&aJumpToLine, Line *aUntil\n\t, LPTSTR aReadFileName, LPTSTR aWriteFileName)\n{\n\tTextFile tfile;\n\tbool file_is_open = tfile.Open(aReadFileName, DEFAULT_READ_FLAGS, g->Encoding & CP_AHKCP);\n\tif (!file_is_open)\n\t{\n\t\t// Failed to open the input file. If an ELSE is present, executing it if the file wasn't found\n\t\t// seems much more useful than executing ELSE only for empty files; but if there's no ELSE, it's\n\t\t// probably best to throw an error.\n\t\tDWORD error = GetLastError();\n\t\tif ( !(mRelatedLine->mActionType == ACT_ELSE && (error == ERROR_FILE_NOT_FOUND || error == ERROR_PATH_NOT_FOUND)) )\n\t\t\treturn g_script.Win32Error(error);\n\t\t// Otherwise, execute the ELSE below.\n\t}\n\n\t// Make a persistent copy in case aWriteFileName's contents are in the deref buffer:\n\tif ( !(aWriteFileName = _tcsdup(aWriteFileName)) )\n\t\treturn MemoryError();\n\n\tLoopReadFileStruct loop_info { aWriteFileName };\n\tsize_t line_length;\n\tResultType result = CONDITION_FALSE;\n\tLine *jump_to_line = nullptr;\n\tglobal_struct &g = *::g; // Primarily for performance in this case.\n\tg.mLoopReadFile = &loop_info;\n\n\tif (file_is_open)\n\tfor (;; ++g.mLoopIteration)\n\t{ \n\t\tif ( !(line_length = tfile.ReadLine(loop_info.mCurrentLine, _countof(loop_info.mCurrentLine) - 1)) ) // -1 to ensure there's room for a null-terminator.\n\t\t\tbreak;\n\t\tif (loop_info.mCurrentLine[line_length - 1] == '\\n') // Remove end-of-line character.\n\t\t\t--line_length;\n\t\tloop_info.mCurrentLine[line_length] = '\\0';\n\n\t\tPERFORMLOOP_EXECUTE_BODY\n\t\tPERFORMLOOP_EVALUATE_UNTIL\n\t}\n\n\tif (result == CONDITION_FALSE)\n\t{\n\t\t// No lines were read, so execute this loop's ELSE if present. It's done here rather than\n\t\t// in ExecUntil so that FileAppend can be used within the ELSE to write to mWriteFile.\n\t\tif (mRelatedLine->mActionType == ACT_ELSE)\n\t\t\tresult = mRelatedLine->mNextLine->ExecUntil(ONLY_ONE_LINE, aResultToken, &aJumpToLine);\n\t\telse\n\t\t\tresult = OK; // Never return CONDITION_FALSE, otherwise ExecUntil() will execute the ELSE a second time.\n\t}\n\n\tif (loop_info.mWriteFile)\n\t{\n\t\tloop_info.mWriteFile->Close();\n\t\tdelete loop_info.mWriteFile;\n\t}\n\n\treturn result;\n}\n\n\n\nResultType Line::PerformAssign()\n{\n\t// Note: This line's args have not yet been dereferenced in this case (i.e. ExpandArgs() hasn't been called).\n\t// Currently, ACT_ASSIGNEXPR can occur even when mArg[1].is_expression==false, such as things like var:=5\n\t// and var:=\"string\". Search on \"is_expression = \" to find such cases in the script-loading/parsing routines.\n\t\n\tif (!mArg[1].is_expression)\n\t{\n\t\tASSERT(mArg[1].postfix);\n\t\t// Examples of assignments this covers:\n\t\t//\t\tx := 123\n\t\t//\t\tx := 1.0\n\t\t//\t\tx := \"quoted literal string\"\n\t\t//\t\tx := normal_var ; but not VAR_VIRTUAL or VAR_CONSTANT\n\t\tif (mArg[1].postfix->symbol == SYM_VAR && mArg[1].postfix->var->IsUninitialized()\n\t\t\t&& mArg[1].postfix->var_usage == VARREF_READ)\n\t\t\treturn g_script.VarUnsetError(mArg[1].postfix->var); // !is_expression implies VAR_NORMAL, so InitializeConstant() isn't needed here.\n\t\tVar *output_var = VAR(mArg[0]);\n\t\treturn output_var->Assign(*mArg[1].postfix);\n\t}\n\n\treturn ExpandArgs(); // ExpandExpression() will also take care of the assignment (for performance).\n}\n\n\n\nResultType Script::DerefInclude(LPTSTR &aOutput, LPTSTR aBuf)\n// For #Include, #IncludeAgain and #DllLoad.\n// Based on Line::Deref above, but with a few differences for backward-compatibility:\n// 1) Percent signs that aren't part of a valid deref are not omitted.\n// 2) Escape sequences aren't recognized (`; is handled elsewhere).\n// 3) It is restricted to built-in vars to reduce the risk of breaking any scripts\n// that use percent sign literally in a filename. Most other vars are empty anyway.\n{\n\taOutput = nullptr; // Set default.\n\n\tVarSizeType expanded_length;\n\tsize_t var_name_length;\n\tLPTSTR cp, cp1, dest;\n\n\t// Do two passes:\n\t// #1: Calculate the space needed.\n\t// #2: Expand the contents of aBuf into aOutput.\n\n\tfor (int which_pass = 0; which_pass < 2; ++which_pass)\n\t{\n\t\tif (which_pass) // Starting second pass.\n\t\t{\n\t\t\t// Allocate a buffer to contain the result:\n\t\t\tif ( !(aOutput = tmalloc(expanded_length+1)) )\n\t\t\t\treturn FAIL;\n\t\t\tdest = aOutput;\n\t\t}\n\t\telse // First pass.\n\t\t\texpanded_length = 0; // Init prior to accumulation.\n\n\t\tfor (cp = aBuf; *cp; ++cp) // Increment to skip over the deref/escape just found by the inner for().\n\t\t{\n\t\t\tif (*cp == g_DerefChar)\n\t\t\t{\n\t\t\t\t// It's a dereference symbol, so calculate the size of that variable's contents and add\n\t\t\t\t// that to expanded_length (or copy the contents into aOutputVar if this is the second pass).\n\t\t\t\tfor (cp1 = cp + 1; *cp1 && *cp1 != g_DerefChar; ++cp1); // Find the reference's ending symbol.\n\t\t\t\tvar_name_length = cp1 - cp - 1;\n\t\t\t\tif (*cp1 && var_name_length && var_name_length <= MAX_VAR_NAME_LENGTH)\n\t\t\t\t{\n\t\t\t\t\tVar *var = FindGlobalVar(cp + 1, var_name_length);\n\t\t\t\t\tif (var && var->Type() == VAR_VIRTUAL)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (which_pass) // 2nd pass\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tsize_t var_length = var->CharLength();\n\t\t\t\t\t\t\ttmemcpy(dest, var->Contents(FALSE), var_length); // Pass FALSE since first iteration already populated Contents().\n\t\t\t\t\t\t\tvar->Free();\n\t\t\t\t\t\t\tdest += var_length;\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (!var->PopulateVirtualVar())\n\t\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t\t\texpanded_length += var->CharLength();\n\t\t\t\t\t\t}\n\t\t\t\t\t\tcp = cp1; // For the next loop iteration, continue at the char after this reference's final deref symbol.\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t// Since it wasn't a supported deref, copy the deref char into the output:\n\t\t\t}\n\t\t\tif (which_pass) // 2nd pass\n\t\t\t\t*dest++ = *cp; // Copy all non-variable-ref characters literally.\n\t\t\telse // just accumulate the length\n\t\t\t\t++expanded_length;\n\t\t} // for()\n\t} // for() (first and second passes)\n\n\t*dest = '\\0'; // Terminate the output variable.\n\treturn OK;\n}\n\n\n\nLPTSTR Line::LogToText(LPTSTR aBuf, int aBufSize) // aBufSize should be an int to preserve negatives from caller (caller relies on this).\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// Translates sLog into its text equivalent, putting the result into aBuf and\n// returning the position in aBuf of its new string terminator.\n// Caller has ensured that aBuf is non-NULL and that aBufSize is reasonable (at least 256).\n{\n\tLPTSTR aBuf_orig = aBuf;\n\n\t// Store the position of where each retry done by the outer loop will start writing:\n\tLPTSTR aBuf_log_start = aBuf + sntprintf(aBuf, aBufSize, _T(\"Script lines most recently executed (oldest first).\")\n\t\t_T(\" Press [F5] to refresh. The seconds elapsed between a line and the one after it is in parentheses to\")\n\t\t_T(\" the right (if not 0). The bottommost line's elapsed time is the number of seconds since it executed.\\r\\n\\r\\n\"));\n\n\tint i, lines_to_show, line_index, line_index2, space_remaining; // space_remaining must be an int to detect negatives.\n#ifndef AUTOHOTKEYSC\n\tint last_file_index = -1;\n#endif\n\tDWORD elapsed;\n\tbool this_item_is_special, next_item_is_special;\n\n\t// In the below, sLogNext causes it to start at the oldest logged line and continue up through the newest:\n\tfor (lines_to_show = LINE_LOG_SIZE, line_index = sLogNext;;) // Retry with fewer lines in case the first attempt doesn't fit in the buffer.\n\t{\n\t\taBuf = aBuf_log_start; // Reset target position in buffer to the place where log should begin.\n\t\tfor (next_item_is_special = false, i = 0; i < lines_to_show; ++i, ++line_index)\n\t\t{\n\t\t\tif (line_index >= LINE_LOG_SIZE) // wrap around, because sLog is a circular queue\n\t\t\t\tline_index -= LINE_LOG_SIZE; // Don't just reset it to zero because an offset larger than one may have been added to it.\n\t\t\tif (!sLog[line_index]) // No line has yet been logged in this slot.\n\t\t\t\tcontinue; // ACT_LISTLINES and other things might rely on \"continue\" instead of halting the loop here.\n\t\t\tthis_item_is_special = next_item_is_special;\n\t\t\tnext_item_is_special = false; // Set default.\n\t\t\tif (i + 1 < lines_to_show) // There are still more lines to be processed\n\t\t\t{\n\t\t\t\tif (this_item_is_special) // And we know from the above that this special line is not the last line.\n\t\t\t\t\t// Due to the fact that these special lines are usually only useful when they appear at the\n\t\t\t\t\t// very end of the log, omit them from the log-display when they're not the last line.\n\t\t\t\t\t// In the case of a high-frequency SetTimer, this greatly reduces the log clutter that\n\t\t\t\t\t// would otherwise occur:\n\t\t\t\t\tcontinue;\n\n\t\t\t\t// Since above didn't continue, this item isn't special, so display it normally.\n\t\t\t\telapsed = sLogTick[line_index + 1 >= LINE_LOG_SIZE ? 0 : line_index + 1] - sLogTick[line_index];\n\t\t\t\tif (elapsed > INT_MAX) // INT_MAX is about one-half of DWORD's capacity.\n\t\t\t\t{\n\t\t\t\t\t// v1.0.30.02: Assume that huge values (greater than 24 days or so) were caused by\n\t\t\t\t\t// the new policy of storing WinWait/RunWait/etc.'s line in the buffer whenever\n\t\t\t\t\t// it was interrupted and later resumed by a thread. In other words, there are now\n\t\t\t\t\t// extra lines in the buffer which are considered \"special\" because they don't indicate\n\t\t\t\t\t// a line that actually executed, but rather one that is still executing (waiting).\n\t\t\t\t\tnext_item_is_special = true; // Override the default.\n\t\t\t\t\tif (i + 2 == lines_to_show) // The line after this one is not only special, but the last one that will be shown, so recalculate this one correctly.\n\t\t\t\t\t\telapsed = GetTickCount() - sLogTick[line_index];\n\t\t\t\t\telse // Neither this line nor the special one that follows it is the last.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Refer to the line after the next (special) line to get this line's correct elapsed time.\n\t\t\t\t\t\tline_index2 = line_index + 2;\n\t\t\t\t\t\tif (line_index2 >= LINE_LOG_SIZE)\n\t\t\t\t\t\t\tline_index2 -= LINE_LOG_SIZE;\n\t\t\t\t\t\telapsed = sLogTick[line_index2] - sLogTick[line_index];\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // This is the last line (whether special or not), so compare it's time against the current time instead.\n\t\t\t\telapsed = GetTickCount() - sLogTick[line_index];\n#ifndef AUTOHOTKEYSC\n\t\t\t// If the this line and the previous line are in different files, display the filename:\n\t\t\tif (last_file_index != sLog[line_index]->mFileIndex)\n\t\t\t{\n\t\t\t\tlast_file_index = sLog[line_index]->mFileIndex;\n\t\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"---- %s\\r\\n\"), sSourceFile[last_file_index]);\n\t\t\t}\n#endif\n\t\t\tspace_remaining = BUF_SPACE_REMAINING; // Resolve macro only once for performance.\n\t\t\t// Truncate really huge lines so that the Edit control's size is less likely to be exhausted.\n\t\t\t// In v1.0.30.02, this is even more likely due to having increased the line-buf's capacity from\n\t\t\t// 200 to 400, therefore the truncation point was reduced from 500 to 200 to make it more likely\n\t\t\t// that the first attempt to fit the lines_to_show number of lines into the buffer will succeed.\n\t\t\taBuf = sLog[line_index]->ToText(aBuf, space_remaining < 200 ? space_remaining : 200, true, elapsed, this_item_is_special);\n\t\t\t// If the line above can't fit everything it needs into the remaining space, it will fill all\n\t\t\t// of the remaining space, and thus the check against LINE_LOG_FINAL_MESSAGE_LENGTH below\n\t\t\t// should never fail to catch that, and then do a retry.\n\t\t} // Inner for()\n\n\t\t#define LINE_LOG_FINAL_MESSAGE _T(\"\\r\\nPress [F5] to refresh.\") // Keep the next line in sync with this.\n\t\t#define LINE_LOG_FINAL_MESSAGE_LENGTH 24\n\t\tif (BUF_SPACE_REMAINING > LINE_LOG_FINAL_MESSAGE_LENGTH || lines_to_show < 120) // Either success or can't succeed.\n\t\t\tbreak;\n\n\t\t// Otherwise, there is insufficient room to put everything in, but there's still room to retry\n\t\t// with a smaller value of lines_to_show:\n\t\tlines_to_show -= 100;\n\t\tline_index = sLogNext + (LINE_LOG_SIZE - lines_to_show); // Move the starting point forward in time so that the oldest log entries are omitted.\n\n\t} // outer for() that retries the log-to-buffer routine.\n\n\t// Must add the return value, not LINE_LOG_FINAL_MESSAGE_LENGTH, in case insufficient room (i.e. in case\n\t// outer loop terminated due to lines_to_show being too small).\n\treturn aBuf + sntprintf(aBuf, BUF_SPACE_REMAINING, LINE_LOG_FINAL_MESSAGE);\n}\n\n\n\nLPTSTR Line::ToText(LPTSTR aBuf, int aBufSize, bool aCRLF, DWORD aElapsed, bool aLineWasResumed, bool aLineNumber) // aBufSize should be an int to preserve negatives from caller (caller relies on this).\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// Caller has ensured that aBuf isn't NULL.\n// Translates this line into its text equivalent, putting the result into aBuf and\n// returning the position in aBuf of its new string terminator.\n{\n\tif (aBufSize < 3)\n\t\treturn aBuf;\n\telse\n\t\taBufSize -= (1 + aCRLF); // Reserve one char for LF/CRLF after each line (so that it always get added).\n\n\tLPTSTR aBuf_orig = aBuf;\n\n\tif (aLineNumber)\n\t\taBuf += sntprintf(aBuf, aBufSize, _T(\"%03u: \"), mLineNumber);\n\tif (aLineWasResumed)\n\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"STILL WAITING (%0.2f): \"), (float)aElapsed / 1000.0);\n\n\tif (mActionType == ACT_CASE)\n\t{\n\t\tif (mArgc)\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"%s %s:\"), g_act[mActionType].Name\n\t\t\t\t, mArg[0].text);\n\t\telse\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"Default:\"));\n\t}\n\telse\n\t{\n\t\tint i = 0;\n\t\tif (mActionType == ACT_ASSIGNEXPR)\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"%s := \"), mArg[i++].text);\n\t\telse if (mActionType != ACT_EXPRESSION)\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"%s\"), g_act[mActionType].Name);\n\t\tfor (; i < mArgc; ++i)\n\t\t{\n\t\t\tbool quote = mArg[i].type == ARG_TYPE_NORMAL\n\t\t\t\t&& !mArg[i].is_expression && mArg[i].postfix && mArg[i].postfix->symbol == SYM_STRING;\n\t\t\tLPCTSTR delim = mActionType <= ACT_EXPRESSION ? _T(\"\") : i == 0 ? _T(\" \")\n\t\t\t\t: (i + 1 == mArgc && mActionType == ACT_FOR) ? _T(\" in \")\n\t\t\t\t: _T(\", \");\n\t\t\t// This method is a little more efficient than using snprintfcat().\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, quote ? _T(\"%s\\\"%s\\\"\") : _T(\"%s%s\"), delim, mArg[i].text);\n\t\t}\n\t}\n\tif (aElapsed && !aLineWasResumed)\n\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\" (%0.2f)\"), (float)aElapsed / 1000.0);\n\t// UPDATE for v1.0.25: It seems that MessageBox(), which is the only way these lines are currently\n\t// displayed, prefers \\n over \\r\\n because otherwise, Ctrl-C on the MsgBox copies the lines all\n\t// onto one line rather than formatted nicely as separate lines.\n\t// Room for LF or CRLF was reserved at the top of this function:\n\tif (aCRLF)\n\t\t*aBuf++ = '\\r';\n\t*aBuf++ = '\\n';\n\t*aBuf = '\\0';\n\treturn aBuf;\n}\n\n\n\nvoid ToggleSuspendState()\n{\n\t// If suspension is being turned on:\n\t// It seems unnecessary, and possibly undesirable, to purge any pending hotkey msgs from the msg queue.\n\t// Even if there are some, it's possible that they are exempt from suspension so we wouldn't want to\n\t// globally purge all messages anyway.\n\tg_IsSuspended = !g_IsSuspended;\n\tHotstring::SuspendAll(g_IsSuspended); // Must do this prior to ManifestAllHotkeysHotstringsHooks() to avoid incorrect removal of hook.\n\tHotkey::ManifestAllHotkeysHotstringsHooks(); // Update the state of all hotkeys based on the complex interdependencies hotkeys have with each another.\n\tg_script.UpdateTrayIcon();\n\tCheckMenuItem(GetMenu(g_hWnd), ID_FILE_SUSPEND, g_IsSuspended ? MF_CHECKED : MF_UNCHECKED);\n}\n\n\n\nbif_impl FResult Suspend(optl<int> aMode)\n{\n\tauto toggle = Line::Convert10Toggle(aMode);\n\tif (toggle == TOGGLE_INVALID)\n\t\treturn FR_E_ARG(0);\n\tif (toggle >= TOGGLE // i.e. TOGGLE or NEUTRAL (omitted)\n\t\t|| ((toggle == TOGGLED_ON) != g_IsSuspended))\n\t\tToggleSuspendState();\n\treturn OK;\n}\n\n\n\nvoid PauseUnderlyingThread(bool aTrueForPauseFalseForUnpause)\n{\n\tif (g <= g_array) // Guard against underflow. This condition can occur when the script thread that called us is the AutoExec section or a callback running in the idle/0 thread.\n\t\treturn;\n\tif (g[-1].IsPaused == aTrueForPauseFalseForUnpause) // It's already in the right state.\n\t\treturn; // Return early because doing the updates further below would be wrong in this case.\n\tg[-1].IsPaused = aTrueForPauseFalseForUnpause; // Update the pause state to that specified by caller.\n\tif (aTrueForPauseFalseForUnpause) // The underlying thread is being paused when it was unpaused before.\n\t\t++g_nPausedThreads; // For this purpose the idle thread is counted as a paused thread.\n\telse // The underlying thread is being unpaused when it was paused before.\n\t\t--g_nPausedThreads;\n}\n\n\nbif_impl FResult Pause(optl<int> aNewState)\n{\n\tauto toggle = Line::Convert10Toggle(aNewState);\n\tswitch (toggle)\n\t{\n\tcase NEUTRAL:\n\t\tPauseCurrentThread();\n\t\treturn OK;\n\tcase TOGGLE:\n\t\t// Update for v2: \"Pause -1\" is more useful if it always applies to the thread immediately beneath\n\t\t// the current thread, since pausing the current thread would prevent a hotkey from unpausing itself\n\t\t// by default (there's no longer a special case allowing Pause hotkeys a second thread).\n\t\tif (g > g_array && g[-1].IsPaused) // Checking g>g_array avoids any chance of underflow, which might otherwise happen if this is called by the AutoExec section or a threadless callback running in thread #0.\n\t\t\ttoggle = TOGGLED_OFF;\n\t\t// Fall through:\n\tcase TOGGLED_ON:\n\tcase TOGGLED_OFF:\n\t\t// v1.0.37.06: The old method was to unpause the the nearest paused thread on the call stack;\n\t\t// but it was flawed because if the thread that made the flag true is interrupted, and the new\n\t\t// thread is paused via the pause command, and that thread is then interrupted, when the paused\n\t\t// thread resumes it would automatically and wrongly be unpaused (i.e. the unpause ticket would\n\t\t// be used at a level higher in the call stack than intended).\n\t\t// Flag this thread so that when it ends, the thread beneath it will be unpaused. If that thread\n\t\t// (which can be the idle thread) isn't paused the following flag-change will be ignored at a later\n\t\t// stage. This method also relies on the fact that the current thread cannot itself be paused right\n\t\t// now because it is what got us here.\n\t\tPauseUnderlyingThread(toggle != TOGGLED_OFF); // i.e. pause if ON or fell through from TOGGLE.\n\t\treturn OK;\n\tdefault: // TOGGLE_INVALID or some other disallowed value.\n\t\treturn FR_E_ARG(0);\n\t}\n}\n\n\nvoid PauseCurrentThread()\n{\n\t// Pause the current subroutine (which by definition isn't paused since it had to be active\n\t// to call us). It seems best not to attempt to change the Hotkey mRunAgainAfterFinished\n\t// attribute for the current hotkey (assuming it's even a hotkey that got us here) or\n\t// for them all. This is because it's conceivable that this Pause command occurred\n\t// in a background thread, such as a timed subroutine, in which case we wouldn't want the\n\t// pausing of that thread to affect anything else the user might be doing with hotkeys.\n\t// UPDATE: The above is flawed because by definition the script's quasi-thread that got\n\t// us here is now active. Since it is active, the script will immediately become dormant\n\t// when this is executed, waiting for the user to press a hotkey to launch a new\n\t// quasi-thread. Thus, it seems best to reset all the mRunAgainAfterFinished flags\n\t// in case we are in a hotkey subroutine and in case this hotkey has a buffered repeat-again\n\t// action pending, which the user probably wouldn't want to happen after the script is unpaused:\n\tHotkey::ResetRunAgainAfterFinished();\n\tauto &g = *::g;\n\tg.IsPaused = true;\n\t++g_nPausedThreads; // For this purpose the idle thread is counted as a paused thread.\n\tg_script.UpdateTrayIcon();\n\t// Don't return until the script is unpaused. This is done for two reasons:\n\t// 1) Pause() can be called as part of an expression, in which case it seems more intuitive for\n\t// the script to pause immediately rather than after evaluating more of the expression.\n\t// 2) If `return Pause()` is used, the thread might end before checking g.IsPaused, in which\n\t// case g_nPausedThreads would not be adjusted and timers would forever be disabled.\n\tMsgWaitUnpause();\n}\n\n\n\nResultType Script::PreprocessLocalVars(FuncList &aFuncs)\n{\n\tfor (int i = 0; i < aFuncs.mCount; ++i)\n\t{\n\t\tUserFunc &func = *aFuncs.mItem[i];\n\t\tif (!PreprocessLocalVars(func))\n\t\t\treturn FAIL;\n\t\t// Nested functions will be preparsed next, due to the fact that they immediately\n\t\t// follow the outer function in aFuncs.\n\t}\n\treturn OK;\n}\n\n\n\nResultType Script::PreprocessLocalVars(UserFunc &aFunc)\n{\n\tVar **vars = aFunc.mVars.mItem;\n\tint var_count = aFunc.mVars.mCount;\n\tint closure_count = 0, non_closure_count = 0;\n\tfor (int v = 0; v < var_count; ++v)\n\t{\n\t\tVar &var = *vars[v];\n\t\tif (var.Type() == VAR_CONSTANT)\n\t\t{\n\t\t\t// Currently only nested functions create local constants, but this could be\n\t\t\t// a local constant or an upvar alias for a non-local constant.\n\t\t\tASSERT(var.HasObject() && dynamic_cast<UserFunc *>(var.Object()));\n\t\t\tauto &func = *(UserFunc *)var.Object();\n\t\t\tif (!func.mUpVarCount)\n\t\t\t{\n\t\t\t\t// This function doesn't need to be a closure, so convert it to static.\n\t\t\t\tint insert_pos;\n\t\t\t\taFunc.mStaticVars.Find(var.mName, &insert_pos);\n\t\t\t\taFunc.mStaticVars.Insert(&var, insert_pos);\n\t\t\t\tvar.Scope() |= VAR_LOCAL_STATIC;\n\t\t\t\t++non_closure_count;\n\t\t\t\tif (var.Scope() & VAR_DOWNVAR)\n\t\t\t\t{\n\t\t\t\t\tvar.Scope() &= ~VAR_DOWNVAR;\n\t\t\t\t\t--aFunc.mDownVarCount;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (!var.IsAlias()) // At this stage only upvars are local aliases.\n\t\t\t{\n\t\t\t\t// This is a closure of aFunc and not an alias for an outer function's\n\t\t\t\t// nested function constant.\n\t\t\t\t++closure_count;\n\t\t\t}\n\t\t}\n\t}\n\tif (non_closure_count) // One or more static vars are to be removed from mVars.\n\t{\n\t\tint dst = 0;\n\t\tfor (int src = 0; src < var_count; ++src)\n\t\t\tif (!vars[src]->IsStatic())\n\t\t\t\tvars[dst++] = vars[src];\n\t\taFunc.mVars.mCount = var_count = dst;\n\t}\n\tif (closure_count)\n\t{\n\t\taFunc.mClosure = SimpleHeap::Alloc<ClosureInfo>(closure_count);\n\t\tfor (int v = 0; v < var_count; ++v)\n\t\t{\n\t\t\tVar &var = *vars[v];\n\t\t\tif (!var.IsAlias() && var.Type() == VAR_CONSTANT)\n\t\t\t{\n\t\t\t\tASSERT(var.IsObject() && dynamic_cast<UserFunc *>(var.Object()));\n\t\t\t\tauto &ci = aFunc.mClosure[aFunc.mClosureCount++];\n\t\t\t\tci.var = &var;\n\t\t\t\tci.func = (UserFunc *)var.Object();\n\t\t\t}\n\t\t}\n\t\tASSERT(aFunc.mClosureCount == closure_count);\n\t}\n\tif (aFunc.mUpVarCount)\n\t{\n\t\t// Upvars are vars local to an outer function which are referenced by aFunc.\n\t\t// They might be local to aFunc.mOuterFunc or one further out. In the latter\n\t\t// case, aFunc.mOuterFunc contains a downvar which is also one of its upvars.\n\t\taFunc.mUpVar = SimpleHeap::Alloc<Var*>(aFunc.mUpVarCount);\n\t\taFunc.mUpVarIndex = SimpleHeap::Alloc<int>(aFunc.mUpVarCount);\n\n\t\tauto &outer = *aFunc.mOuterFunc; // Always non-null when aFunc.mUpVarCount > 0.\n\t\tint upvar_count = 0;\n\t\tfor (int v = 0; v < var_count; ++v)\n\t\t{\n\t\t\tVar &var = *vars[v];\n\t\t\tif (!var.IsAlias()) // At this stage only upvars are local aliases.\n\t\t\t\tcontinue;\n\n\t\t\tVar *downvar = var.GetAliasFor(); // FindUpVar() set var to be an alias of the corresponding downvar.\n\t\t\tint d;\n\t\t\tfor (d = 0; ; ++d)\n\t\t\t{\n\t\t\t\tASSERT(d < outer.mDownVarCount);\n\t\t\t\tif (outer.mDownVar[d] == downvar)\n\t\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tASSERT(upvar_count < aFunc.mUpVarCount);\n\t\t\taFunc.mUpVar[upvar_count] = &var;\n\t\t\taFunc.mUpVarIndex[upvar_count] = d;\n\t\t\t++upvar_count;\n\t\t}\n\t\tASSERT(upvar_count == aFunc.mUpVarCount);\n\t}\n\tif (aFunc.mDownVarCount)\n\t{\n\t\t// Downvars are vars local to aFunc which are referenced by a nested function.\n\t\taFunc.mDownVar = SimpleHeap::Alloc<Var*>(aFunc.mDownVarCount);\n\t\t\n\t\tint downvar_count = 0;\n\t\tfor (int v = 0; v < var_count; ++v)\n\t\t{\n\t\t\tif (vars[v]->Scope() & VAR_DOWNVAR)\n\t\t\t{\n\t\t\t\tASSERT(downvar_count < aFunc.mDownVarCount);\n\t\t\t\taFunc.mDownVar[downvar_count++] = vars[v];\n\t\t\t}\n\t\t}\n\t\tASSERT(downvar_count == aFunc.mDownVarCount);\n\t}\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseVarRefs()\n{\n\tfor (mCurrentModule = mLastModule; mCurrentModule; mCurrentModule = mCurrentModule->mPrev)\n\t{\n\t\tif (!PreparseVarRefs(mCurrentModule->mFirstLine))\n\t\t\treturn FAIL;\n\n\t\twhile (auto *unc = mCurrentModule->mUnresolvedBaseClass)\n\t\t{\n\t\t\tObject *proto, *cls = FindClass(unc->name);\n\t\t\tif (!cls || !(proto = (Object*)cls->GetOwnPropObj(_T(\"Prototype\"))))\n\t\t\t{\n\t\t\t\tmCurrLine = NULL;\n\t\t\t\tmCurrFileIndex = unc->file_index;\n\t\t\t\tmCombinedLineNumber = unc->line_number;\n\t\t\t\treturn ScriptError(_T(\"Unknown class.\"), unc->name);\n\t\t\t}\n\t\t\tunc->subclass->SetBase(cls);\n\t\t\tunc->subclass_proto->SetBase(proto);\n\t\t\tmCurrentModule->mUnresolvedBaseClass = unc->next;\n\t\t\tfree(unc->name);\n\t\t\tdelete unc;\n\t\t}\n\t}\n\treturn OK;\n}\n\n\n\nResultType Script::PreparseVarRefs(Line *aStartingLine)\n{\n\tfor (Line *line = aStartingLine; line; line = line->mNextLine)\n\t{\n\t\tswitch (line->mActionType)\n\t\t{ // Establish context for FindOrAddVar:\n\t\tcase ACT_BLOCK_BEGIN: if (line->mAttribute) g->CurrentFunc = (UserFunc *)line->mAttribute; break;\n\t\tcase ACT_BLOCK_END: if (line->mAttribute) g->CurrentFunc = g->CurrentFunc->mOuterFunc; break;\n\t\t}\n\t\t\n\t\tmCurrLine = line; // For error-reporting.\n\n\t\tfor (int a = 0; a < line->mArgc; ++a)\n\t\t{\n\t\t\tArgStruct &arg = line->mArg[a];\n\t\t\tif (!arg.is_expression)\n\t\t\t\tcontinue;\n\t\t\tfor (ExprTokenType *token = arg.postfix; token->symbol != SYM_INVALID; ++token)\n\t\t\t{\n\t\t\t\tif (token->symbol != SYM_VAR // Not a var.\n\t\t\t\t\t|| VARREF_IS_WRITE(token->var_usage)) // Already resolved by ExpressionToPostfix.\n\t\t\t\t\tcontinue;\n\t\t\t\tif (token->var_deref->type == DT_FUNCREF)\n\t\t\t\t{\n\t\t\t\t\ttoken->var = token->var_deref->var;\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\tif ( !(token->var = FindOrAddVar(token->var_deref->marker, token->var_deref->length, FINDVAR_FOR_READ)) )\n\t\t\t\t\treturn FAIL;\n\t\t\t\tswitch (token->var->Type())\n\t\t\t\t{\n\t\t\t\tcase VAR_CONSTANT:\n\t\t\t\t\t// Resolve constants to their values, except in cases like IsSet(SomeClass), or when\n\t\t\t\t\t// the constant is a closure (which may change each time the outer function is called).\n\t\t\t\t\tif (!token->var->IsLocal() && VARREF_IS_READ(token->var_usage) && !token->var->IsUninitialized())\n\t\t\t\t\t\ttoken->var->ToToken(*token);\n\t\t\t\t\tcontinue;\n\t\t\t\tcase VAR_VIRTUAL:\n\t\t\t\t\tif (VARREF_IS_READ(token->var_usage))\n\t\t\t\t\t\t++arg.max_alloc; // Reserve a to_free[] slot for it in ExpandExpression().\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\t// Suppress any VarUnset warnings for IsSet(var) so that it can be used to determine if an\n\t\t\t\t\t// optionally-set global variable has been set, such as a class in an optional #Include.\n\t\t\t\t\t// MarkAssignedSomewhere() isn't used for this because PreprocessLocalVars() hasn't been\n\t\t\t\t\t// called yet, and it relies on the attribute being accurate.\n\t\t\t\t\tif (token->var_usage == VARREF_ISSET)\n\t\t\t\t\t\ttoken->var->MarkAlreadyWarned();\n\t\t\t\t\t// It's too early to show VarUnset warnings, since not all VARREF_ISSET references have been marked.\n\t\t\t\t\t// The effect of IsSet(v) for suppressing the warning shouldn't be positional since it's feasible for\n\t\t\t\t\t// a check in one function to guard evaluation of a VARREF_READ in some other function.\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (arg.type == ARG_TYPE_INPUT_VAR)\n\t\t\t{\n\t\t\t\tif (arg.postfix->symbol != SYM_VAR || arg.postfix->var->Type() != VAR_NORMAL)\n\t\t\t\t{\n\t\t\t\t\t// Can't be ARG_TYPE_INPUT_VAR after all, as VAR_VIRTUAL and VAR_CONSTANT require ExpandExpression\n\t\t\t\t\t// (unless it's a constant which was converted to SYM_OBJECT above).\n\t\t\t\t\targ.type = ARG_TYPE_NORMAL;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// This arg can be optimized by avoiding ExpandExpression.\n\t\t\t\t\targ.deref = (DerefType *)arg.postfix->var;\n\t\t\t\t\targ.is_expression = false;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn OK;\n}\n\n\n\nLPTSTR ListVarsHelper(LPTSTR aBuf, int aBufSize, LPTSTR aBuf_orig, VarList &aVars)\n{\n\tfor (int i = 0; i < aVars.mCount; ++i)\n\t\tswitch (aVars.mItem[i]->Type()) // Don't bother showing VAR_CONSTANT or VAR_VIRTUAL.\n\t\t{\n\t\tcase VAR_NORMAL:\n\t\tcase VAR_VIRTUAL_OBJ:\n\t\t\taBuf = aVars.mItem[i]->ToText(aBuf, BUF_SPACE_REMAINING, true);\n\t\t}\n\treturn aBuf;\n}\n\nLPTSTR Script::ListVars(LPTSTR aBuf, int aBufSize) // aBufSize should be an int to preserve negatives from caller (caller relies on this).\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// Translates this script's list of variables into text equivalent, putting the result\n// into aBuf and returning the position in aBuf of its new string terminator.\n{\n\tLPTSTR aBuf_orig = aBuf;\n\tauto current_func = g->CurrentFunc;\n\tif (current_func)\n\t{\n\t\t// This definition might help compiler string pooling by ensuring it stays the same for all usages:\n\t\t#define LIST_VARS_UNDERLINE _T(\"\\r\\n--------------------------------------------------\\r\\n\")\n\t\tif (current_func->mVars.mCount || !current_func->mStaticVars.mCount)\n\t\t{\n\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"Local Variables for %s()%s\")\n\t\t\t\t, current_func->mName, LIST_VARS_UNDERLINE);\n\t\t\taBuf = ListVarsHelper(aBuf, aBufSize, aBuf_orig, current_func->mVars);\n\t\t}\n\t\tdo {\n\t\t\tif (current_func->mStaticVars.mCount)\n\t\t\t{\n\t\t\t\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"%sStatic Variables for %s()%s\")\n\t\t\t\t\t, (aBuf > aBuf_orig) ? _T(\"\\r\\n\\r\\n\") : _T(\"\"), current_func->mName, LIST_VARS_UNDERLINE);\n\t\t\t\taBuf = ListVarsHelper(aBuf, aBufSize, aBuf_orig, current_func->mStaticVars);\n\t\t\t}\n\t\t} while (current_func = current_func->mOuterFunc);\n\t}\n\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"%sGlobal Variables (alphabetical)%s\")\n\t\t, (aBuf > aBuf_orig) ? _T(\"\\r\\n\\r\\n\") : _T(\"\"), LIST_VARS_UNDERLINE);\n\t// TODO: Variables of all modules?\n\taBuf = ListVarsHelper(aBuf, aBufSize, aBuf_orig, *GlobalVars());\n\treturn aBuf;\n}\n\n\n\nLPTSTR Script::ListKeyHistory(LPTSTR aBuf, int aBufSize) // aBufSize should be an int to preserve negatives from caller (caller relies on this).\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// Translates this key history into text equivalent, putting the result\n// into aBuf and returning the position in aBuf of its new string terminator.\n{\n\tLPTSTR aBuf_orig = aBuf; // Needed for the BUF_SPACE_REMAINING macro.\n\t// I was initially concerned that GetWindowText() can hang if the target window is\n\t// hung. But at least on newer OS's, this doesn't seem to be a problem: MSDN says\n\t// \"If the window does not have a caption, the return value is a null string. This\n\t// behavior is by design. It allows applications to call GetWindowText without hanging\n\t// if the process that owns the target window is hung. However, if the target window\n\t// is hung and it belongs to the calling application, GetWindowText will hang the\n\t// calling application.\"\n\tHWND target_window = GetForegroundWindow();\n\tTCHAR win_title[100];\n\tif (target_window)\n\t\tGetWindowText(target_window, win_title, _countof(win_title));\n\telse\n\t\t*win_title = '\\0';\n\n\tTCHAR timer_list[128];\n\t*timer_list = '\\0';\n\tfor (ScriptTimer *timer = mFirstTimer; timer != NULL; timer = timer->mNextTimer)\n\t\tif (timer->mEnabled)\n\t\t\tsntprintfcat(timer_list, _countof(timer_list) - 3, _T(\"%s \"), timer->mCallback->Name()); // Allow room for \"...\"\n\tif (*timer_list)\n\t{\n\t\tsize_t length = _tcslen(timer_list);\n\t\tif (length > (_countof(timer_list) - 5))\n\t\t\ttcslcpy(timer_list + length, _T(\"...\"), _countof(timer_list) - length);\n\t\telse if (timer_list[length - 1] == ' ')\n\t\t\ttimer_list[--length] = '\\0'; // Remove the last space if there was room enough for it to have been added.\n\t}\n\n\tTCHAR LRtext[256];\n\taBuf += sntprintf(aBuf, aBufSize,\n\t\t_T(\"Window: %s\")\n\t\t//\"\\r\\nBlocks: %u\"\n\t\t_T(\"\\r\\nKeybd hook: %s\")\n\t\t_T(\"\\r\\nMouse hook: %s\")\n\t\t_T(\"\\r\\nEnabled Timers: %u of %u (%s)\")\n\t\t//\"\\r\\nInterruptible?: %s\"\n\t\t_T(\"\\r\\nInterrupted threads: %d%s\")\n\t\t_T(\"\\r\\nPaused threads: %d of %d (%d layers)\")\n\t\t_T(\"\\r\\nModifiers (GetKeyState() now) = %s\")\n\t\t_T(\"\\r\\n\")\n\t\t, win_title\n\t\t//, SimpleHeap::GetBlockCount()\n\t\t, g_KeybdHook == NULL ? _T(\"no\") : _T(\"yes\")\n\t\t, g_MouseHook == NULL ? _T(\"no\") : _T(\"yes\")\n\t\t, mTimerEnabledCount, mTimerCount, timer_list\n\t\t//, INTERRUPTIBLE ? \"yes\" : \"no\"\n\t\t, g_nThreads > 1 ? g_nThreads - 1 : 0\n\t\t, g_nThreads > 1 ? _T(\" (preempted: they will resume when the current thread finishes)\") : _T(\"\")\n\t\t, g_nPausedThreads - (g_array[0].IsPaused && !mAutoExecSectionIsRunning) // Historically thread #0 isn't counted as a paused thread unless the auto-exec section is running but paused.\n\t\t, g_nThreads, g_nLayersNeedingTimer\n\t\t, ModifiersLRToText(GetModifierLRState(true), LRtext));\n\tGetHookStatus(aBuf, BUF_SPACE_REMAINING);\n\taBuf += _tcslen(aBuf); // Adjust for what GetHookStatus() wrote to the buffer.\n\treturn aBuf + sntprintf(aBuf, BUF_SPACE_REMAINING, g_KeyHistory ? _T(\"\\r\\nPress [F5] to refresh.\")\n\t\t: _T(\"\\r\\nKey History has been disabled via KeyHistory(0).\"));\n}\n\n\n\nResultType Script::ActionExec(LPCTSTR aAction, LPCTSTR aParams, LPCTSTR aWorkingDir, bool aDisplayErrors\n\t, LPCTSTR aRunShowMode, HANDLE *aProcess, bool aUpdateLastError, bool aUseRunAs)\n// Caller should specify NULL for aParams if it wants us to attempt to parse out params from\n// within aAction. Caller may specify empty string (\"\") instead to specify no params at all.\n// Remember that aAction and aParams can both be NULL, so don't dereference without checking first.\n// Note: For the Run & RunWait commands, aParams should always be NULL. Params are parsed out of\n// the aActionString at runtime, here, rather than at load-time because Run & RunWait might contain\n// dereferenced variable(s), which can only be resolved at runtime.\n{\n\tHANDLE hprocess_local;\n\tHANDLE &hprocess = aProcess ? *aProcess : hprocess_local; // To simplify other things.\n\thprocess = NULL; // Init output param if the caller gave us memory to store it. Even if caller didn't, other things below may rely on this being initialized.\n\n\t// Launching nothing is always a success:\n\tif (!aAction || !*aAction) return OK;\n\n\tif (aWorkingDir)\n\t{\n\t\tif (*aWorkingDir)\n\t\t{\n\t\t\t// aWorkingDir is validated for two main reasons:\n\t\t\t// 1) To make the cause of failure much clearer when both CreateProcess and ShellExecuteEx fail.\n\t\t\t// 2) To prevent ShellExecuteEx from wrongly executing a file:\n\t\t\t// a) with aAction relative to the wrong working directory; and/or\n\t\t\t// b) with the child process having the wrong working directory.\n\t\t\tauto attrib = GetFileAttributes(aWorkingDir);\n\t\t\tif (attrib == INVALID_FILE_ATTRIBUTES || !(attrib & FILE_ATTRIBUTE_DIRECTORY))\n\t\t\t\treturn aDisplayErrors ? RuntimeError(ERR_PARAM2_INVALID, aWorkingDir) : FAIL;\n\t\t}\n\t\telse\n\t\t\t// Set it to NULL because CreateProcess() won't work if it's the empty string.\n\t\t\taWorkingDir = NULL;\n\t}\n\n\t#define IS_VERB(str) ( !_tcsicmp(str, _T(\"find\")) || !_tcsicmp(str, _T(\"explore\")) || !_tcsicmp(str, _T(\"open\"))\\\n\t\t|| !_tcsicmp(str, _T(\"Edit\")) || !_tcsicmp(str, _T(\"print\")) || !_tcsicmp(str, _T(\"properties\")) )\n\n\t// Set default items to be run by ShellExecute(). These are also used by the error\n\t// reporting at the end, which is why they're initialized even if CreateProcess() works\n\t// and there's no need to use ShellExecute():\n\tLPCTSTR shell_verb = NULL;\n\tLPCTSTR shell_action = aAction;\n\tLPCTSTR shell_params = NULL;\n\t\n\t///////////////////////////////////////////////////////////////////////////////////\n\t// This next section is done prior to CreateProcess() because when aParams is NULL,\n\t// we need to find out whether aAction contains a system verb.\n\t///////////////////////////////////////////////////////////////////////////////////\n\tif (aParams) // Caller specified the params (even an empty string counts, for this purpose).\n\t{\n\t\tif (IS_VERB(shell_action))\n\t\t{\n\t\t\tshell_verb = shell_action;\n\t\t\tshell_action = aParams;\n\t\t}\n\t\telse\n\t\t\tshell_params = aParams;\n\t}\n\telse // Caller wants us to try to parse params out of aAction.\n\t{\n\t\t// Find out the \"first phrase\" in the string to support the special \"find\" and \"explore\" operations.\n\t\tLPTSTR phrase;\n\t\tsize_t phrase_len;\n\t\t// Set phrase_end to be the location of the first whitespace char, if one exists:\n\t\tLPCTSTR phrase_end = StrChrAny(shell_action, _T(\" \\t\")); // Find space or tab.\n\t\tif (phrase_end) // i.e. there is a second phrase.\n\t\t{\n\t\t\tphrase_len = phrase_end - shell_action;\n\t\t\t// Create a null-terminated copy of the phrase for comparison.\n\t\t\tphrase = tmemcpy(talloca(phrase_len + 1), shell_action, phrase_len);\n\t\t\tphrase[phrase_len] = '\\0';\n\t\t\t// Firstly, treat anything following '*' as a verb, to support custom verbs like *Compile.\n\t\t\tif (*phrase == '*')\n\t\t\t\tshell_verb = phrase + 1;\n\t\t\t// Secondly, check for common system verbs like \"find\" and \"edit\".\n\t\t\telse if (IS_VERB(phrase))\n\t\t\t\tshell_verb = phrase;\n\t\t\tif (shell_verb)\n\t\t\t\t// Exclude the verb and its trailing space or tab from further consideration.\n\t\t\t\tshell_action += phrase_len + 1;\n\t\t\t// Otherwise it's not a verb, and may be re-parsed later.\n\t\t}\n\t\t// shell_action will be split into action and params at a later stage if ShellExecuteEx is to be used.\n\t}\n\n\t// This is distinct from hprocess being non-NULL because the two aren't always the\n\t// same. For example, if the user does \"Run, find D:\\\" or \"RunWait, www.yahoo.com\",\n\t// no new process handle will be available even though the launch was successful:\n\tbool success = false; // Separate from last_error for maintainability.\n\tDWORD last_error = 0;\n\n\tbool use_runas = aUseRunAs && (!mRunAsUser.IsEmpty() || !mRunAsPass.IsEmpty() || !mRunAsDomain.IsEmpty());\n\tif (use_runas && shell_verb)\n\t{\n\t\tif (aDisplayErrors)\n\t\t\treturn RuntimeError(_T(\"System verbs unsupported with RunAs.\"));\n\t\treturn FAIL;\n\t}\n\t\n\tsize_t action_length = _tcslen(shell_action); // shell_action == aAction if shell_verb == NULL.\n\tif (action_length >= LINE_SIZE) // Max length supported by CreateProcess() is 32 KB. But there hasn't been any demand to go above 16 KB, so seems little need to support it (plus it reduces risk of stack overflow).\n\t{\n if (aDisplayErrors)\n\t\t\treturn RuntimeError(_T(\"String too long.\")); // Short msg since so rare.\n\t\treturn FAIL;\n\t}\n\n\t// If the caller originally gave us NULL for aParams, always try CreateProcess() before\n\t// trying ShellExecute(). This is because ShellExecute() is usually a lot slower.\n\t// The only exception is if the action appears to be a verb such as open, edit, or find.\n\t// In that case, we'll also skip the CreateProcess() attempt and do only the ShellExecute().\n\t// If the user really meant to launch find.bat or find.exe, for example, he should add\n\t// the extension (e.g. .exe) to differentiate \"find\" from \"find.exe\":\n\tif (!shell_verb)\n\t{\n\t\tSTARTUPINFO si = {0}; // Zero fill to be safer.\n\t\tsi.cb = sizeof(si);\n\t\t// The following are left at the default of NULL/0 set higher above:\n\t\t//si.lpReserved = si.lpDesktop = si.lpTitle = NULL;\n\t\t//si.lpReserved2 = NULL;\n\t\tsi.dwFlags = STARTF_USESHOWWINDOW; // This tells it to use the value of wShowWindow below.\n\t\tsi.wShowWindow = (aRunShowMode && *aRunShowMode) ? Line::ConvertRunMode(aRunShowMode) : SW_SHOWNORMAL;\n\t\tPROCESS_INFORMATION pi = {0};\n\n\t\t// Since CreateProcess() requires that the 2nd param be modifiable, ensure that it is\n\t\t// (even if this is ANSI and not Unicode; it's just safer):\n\t\tLPTSTR command_line;\n\t\tif (aParams && *aParams)\n\t\t{\n\t\t\tcommand_line = talloca(action_length + _tcslen(aParams) + 10); // +10 to allow room for quotes, space, terminator, and any extra chars that might get added in the future.\n\t\t\t_stprintf(command_line, _T(\"\\\"%s\\\" %s\"), aAction, aParams);\n\t\t}\n\t\telse // We're running the original action from caller.\n\t\t{\n\t\t\tcommand_line = talloca(action_length + 1);\n \t_tcscpy(command_line, aAction); // CreateProcessW() requires modifiable string. Although non-W version is used now, it feels safer to make it modifiable anyway.\n\t\t}\n\n\t\tif (use_runas)\n\t\t{\n\t\t\tif (!DoRunAs(command_line, aWorkingDir, aDisplayErrors, si.wShowWindow // wShowWindow (min/max/hide).\n\t\t\t\t, pi, success, hprocess, last_error)) // These are output parameters it will set for us.\n\t\t\t\treturn FAIL; // It already displayed the error, if appropriate.\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// MSDN: \"If [lpCurrentDirectory] is NULL, the new process is created with the same\n\t\t\t// current drive and directory as the calling process.\" (i.e. since caller may have\n\t\t\t// specified a NULL aWorkingDir). Also, we pass NULL in for the first param so that\n\t\t\t// it will behave the following way (hopefully under all OSes): \"the first white-space delimited\n\t\t\t// token of the command line specifies the module name. If you are using a long file name that\n\t\t\t// contains a space, use quoted strings to indicate where the file name ends and the arguments\n\t\t\t// begin (see the explanation for the lpApplicationName parameter). If the file name does not\n\t\t\t// contain an extension, .exe is appended. Therefore, if the file name extension is .com,\n\t\t\t// this parameter must include the .com extension. If the file name ends in a period (.) with\n\t\t\t// no extension, or if the file name contains a path, .exe is not appended. If the file name does\n\t\t\t// not contain a directory path, the system searches for the executable file in the following\n\t\t\t// sequence...\".\n\t\t\t// Provide the app name (first param) if possible, for greater expected reliability.\n\t\t\t// UPDATE: Don't provide the module name because if it's enclosed in double quotes,\n\t\t\t// CreateProcess() will fail, at least under XP:\n\t\t\t//if (CreateProcess(aParams && *aParams ? aAction : NULL\n\t\t\tif (CreateProcess(NULL, command_line, NULL, NULL, FALSE, 0, NULL, aWorkingDir, &si, &pi))\n\t\t\t{\n\t\t\t\tsuccess = true;\n\t\t\t\tif (pi.hThread)\n\t\t\t\t\tCloseHandle(pi.hThread); // Required to avoid memory leak.\n\t\t\t\thprocess = pi.hProcess;\n\t\t\t}\n\t\t\telse\n\t\t\t\tlast_error = GetLastError();\n\t\t}\n\t}\n\n\t// Since CreateProcessWithLogonW() was either not attempted or did not work, it's probably\n\t// best to display an error rather than trying to run it without the RunAs settings.\n\t// This policy encourages users to have RunAs in effect only when necessary:\n\tif (!success && !use_runas) // Either the above wasn't attempted, or the attempt failed. So try ShellExecute().\n\t{\n\t\tSHELLEXECUTEINFO sei = {0};\n\t\t// sei.hwnd is left NULL to avoid potential side-effects with having a hidden window be the parent.\n\t\t// However, doing so may result in the launched app appearing on a different monitor than the\n\t\t// script's main window appears on (for multimonitor systems). This seems fairly inconsequential\n\t\t// since scripted workarounds are possible.\n\t\tsei.cbSize = sizeof(sei);\n\t\t// Below: \"indicate that the hProcess member receives the process handle\" and not to display error dialog:\n\t\tsei.fMask = SEE_MASK_NOCLOSEPROCESS | SEE_MASK_FLAG_NO_UI;\n\t\tsei.lpDirectory = aWorkingDir; // OK if NULL or blank; that will cause current dir to be used.\n\t\tsei.nShow = (aRunShowMode && *aRunShowMode) ? Line::ConvertRunMode(aRunShowMode) : SW_SHOWNORMAL;\n\t\tif (shell_verb)\n\t\t{\n\t\t\tsei.lpVerb = shell_verb;\n\t\t\tif (!_tcsicmp(shell_verb, _T(\"properties\")))\n\t\t\t\tsei.fMask |= SEE_MASK_INVOKEIDLIST; // Need to use this for the \"properties\" verb to work reliably.\n\t\t}\n\t\tif (!shell_params) // i.e. above hasn't determined the params yet.\n\t\t{\n// Rather than just consider the first phrase to be the executable and the rest to be the param, we check it\n// for a proper extension so that the user can launch a document name containing spaces, without having to\n// enclose it in double quotes. UPDATE: Want to be able to support executable filespecs without requiring them\n// to be enclosed in double quotes. Therefore, search the entire string, rather than just first_phrase, for\n// the left-most occurrence of a valid executable extension. This should be fine since the user can still\n// pass in EXEs and such as params as long as the first executable is fully qualified with its real extension\n// so that we can tell that it's the action and not one of the params. UPDATE: Since any file type may\n// potentially accept parameters (.lnk or .ahk files for instance), the first space-terminated substring which\n// is either an existing file or ends in one of .exe,.bat,.com,.cmd,.hta is considered the executable and the\n// rest is considered the param. Remaining shortcomings of this method include:\n// - It doesn't handle an extensionless executable such as \"notepad test.txt\"\n// - It doesn't handle custom file types (scripts etc.) which don't exist in the working directory but can\n// still be executed due to %PATH% and %PATHEXT% even when our caller doesn't supply an absolute path.\n// These limitations seem acceptable since the caller can allow even those cases to work by simply wrapping\n// the action in quote marks.\n\t\t\t// Make a copy so that we can modify it (i.e. split it into action & params).\n\t\t\t// Using talloca ensures it will stick around until the function exits:\n\t\t\tLPTSTR parse_buf = talloca(action_length + 1);\n\t\t\t_tcscpy(parse_buf, shell_action);\n\t\t\tLPTSTR action_extension, action_end;\n\t\t\t// Let quotation marks be used to remove all ambiguity:\n\t\t\tif (*parse_buf == '\"' && (action_end = _tcschr(parse_buf + 1, '\"')))\n\t\t\t{\n\t\t\t\tshell_action = parse_buf + 1;\n\t\t\t\t*action_end = '\\0';\n\t\t\t\tif (action_end[1])\n\t\t\t\t{\n\t\t\t\t\tshell_params = action_end + 1;\n\t\t\t\t\t// Omit the space which should follow, but only one, in case spaces\n\t\t\t\t\t// are meaningful to the target program.\n\t\t\t\t\tif (*shell_params == ' ')\n\t\t\t\t\t\t++shell_params;\n\t\t\t\t}\n\t\t\t\t// Otherwise, there's only the action in quotation marks and no params.\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tif (aWorkingDir) // Set current directory temporarily in case the action is a relative path:\n\t\t\t\t\tSetCurrentDirectory(aWorkingDir);\n\t\t\t\t// For each space which possibly delimits the action and params:\n\t\t\t\tfor (action_end = parse_buf + 1; action_end = _tcschr(action_end, ' '); ++action_end)\n\t\t\t\t{\n\t\t\t\t\t// Find the beginning of the substring or file extension; if \\ is encountered, this might be\n\t\t\t\t\t// an extensionless filename, but it probably wouldn't be meaningful to pass params to such a\n\t\t\t\t\t// file since it can't be associated with anything, so skip to the next space in that case.\n\t\t\t\t\tfor ( action_extension = action_end - 1;\n\t\t\t\t\t\t action_extension > parse_buf && !_tcschr(_T(\"\\\\/.\"), *action_extension);\n\t\t\t\t\t\t --action_extension );\n\t\t\t\t\tif (*action_extension == '.') // Potential file extension; even if action_extension == parse_buf since \".ext\" on its own is a valid filename.\n\t\t\t\t\t{\n\t\t\t\t\t\t*action_end = '\\0'; // Temporarily terminate.\n\t\t\t\t\t\t// If action_extension is a common executable extension, don't call GetFileAttributes() since\n\t\t\t\t\t\t// the file might actually be in a location listed in %PATH% or the App Paths registry key:\n\t\t\t\t\t\tif ( (action_end-action_extension == 4 && tcscasestr(_T(\".exe.bat.com.cmd.hta\"), action_extension))\n\t\t\t\t\t\t// Otherwise the file might still be something capable of accepting params, like a script,\n\t\t\t\t\t\t// so check if what we have is the name of an existing file:\n\t\t\t\t\t\t\t|| !(GetFileAttributes(parse_buf) & FILE_ATTRIBUTE_DIRECTORY) ) // i.e. THE FILE EXISTS and is not a directory. This works because (INVALID_FILE_ATTRIBUTES & FILE_ATTRIBUTE_DIRECTORY) is non-zero.\n\t\t\t\t\t\t{\t\n\t\t\t\t\t\t\tshell_action = parse_buf;\n\t\t\t\t\t\t\tshell_params = action_end + 1;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// What we have so far isn't an obvious executable file type or the path of an existing\n\t\t\t\t\t\t// file, so assume it isn't a valid action. Unterminate and continue the loop:\n\t\t\t\t\t\t*action_end = ' ';\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (aWorkingDir)\n\t\t\t\t\tSetCurrentDirectory(g_WorkingDir); // Restore to proper value.\n\t\t\t}\n\t\t}\n\t\t//else aParams!=NULL, so the extra parsing in the block above isn't necessary.\n\n\t\t// Not done because it may have been set to shell_verb above:\n\t\t//sei.lpVerb = NULL;\n\t\tsei.lpFile = shell_action;\n\t\tsei.lpParameters = shell_params; // NULL if no parameters were present.\n\t\t// Above was fixed v1.0.42.06 to be NULL rather than the empty string to prevent passing an\n\t\t// extra space at the end of a parameter list (this might happen only when launching a shortcut\n\t\t// [.lnk file]). MSDN states: \"If the lpFile member specifies a document file, lpParameters should\n\t\t// be NULL.\" This implies that NULL is a suitable value for lpParameters in cases where you don't\n\t\t// want to pass any parameters at all.\n\t\t\n\t\tif (ShellExecuteEx(&sei)) // Relies on short-circuit boolean order.\n\t\t{\n\t\t\thprocess = sei.hProcess;\n\t\t\t// Even if there's no process handle, it's considered a success because some\n\t\t\t// system verbs and file associations do not create a new process, by design.\n\t\t\tsuccess = true;\n\t\t}\n\t\telse\n\t\t\tlast_error = GetLastError();\n\t}\n\n\tif (!success) // The above attempt(s) to launch failed.\n\t{\n\t\tif (aUpdateLastError)\n\t\t\tg->LastError = last_error;\n\n\t\tif (aDisplayErrors)\n\t\t{\n\t\t\tTCHAR error_text[2048], verb_text[128], system_error_text[512];\n\t\t\tGetWin32ErrorText(system_error_text, _countof(system_error_text), last_error);\n\t\t\tif (shell_verb)\n\t\t\t\tsntprintf(verb_text, _countof(verb_text), _T(\"\\nVerb: <%s>\"), shell_verb);\n\t\t\telse // Don't bother showing it if it's just \"open\".\n\t\t\t\t*verb_text = '\\0';\n\t\t\tif (!shell_params)\n\t\t\t\tshell_params = _T(\"\"); // Expected to be non-NULL below.\n\t\t\t// Use format specifier to make sure it doesn't get too big for the error\n\t\t\t// function to display:\n\t\t\tsntprintf(error_text, _countof(error_text)\n\t\t\t\t, _T(\"%s\\nAction: <%-0.400s%s>\")\n\t\t\t\t_T(\"%s\")\n\t\t\t\t_T(\"\\nParams: <%-0.400s%s>\")\n\t\t\t\t, use_runas ? _T(\"Launch Error (possibly related to RunAs):\") : _T(\"Failed attempt to launch program or document:\")\n\t\t\t\t, shell_action, _tcslen(shell_action) > 400 ? _T(\"...\") : _T(\"\")\n\t\t\t\t, verb_text\n\t\t\t\t, shell_params, _tcslen(shell_params) > 400 ? _T(\"...\") : _T(\"\")\n\t\t\t\t);\n\t\t\treturn RuntimeError(error_text, system_error_text);\n\t\t}\n\t\treturn FAIL;\n\t}\n\n\t// Otherwise, success:\n\tif (aUpdateLastError)\n\t\tg->LastError = 0; // Force zero to indicate success, which seems more maintainable and reliable than calling GetLastError() right here.\n\n\t// If aProcess isn't NULL, the caller wanted the process handle left open and so it must eventually call\n\t// CloseHandle(). Otherwise, we should close the process if it's non-NULL (it can be NULL in the case of\n\t// launching things like \"find D:\\\" or \"www.yahoo.com\").\n\tif (!aProcess && hprocess)\n\t\tCloseHandle(hprocess); // Required to avoid memory leak.\n\treturn OK;\n}\n"},"size":{"kind":"number","value":566893,"string":"566,893"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":11811,"string":"11,811"},"avg_line_length":{"kind":"number","value":44.23774447548895,"string":"44.237744"},"max_line_length":{"kind":"number","value":449,"string":"449"},"alphanum_fraction":{"kind":"number","value":0.6976881921384448,"string":"0.697688"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11081,"cells":{"id":{"kind":"number","value":16069,"string":"16,069"},"file_name":{"kind":"string","value":"script_registry.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_registry.cpp"},"content":{"kind":"string","value":"///////////////////////////////////////////////////////////////////////////////\n//\n// AutoIt\n//\n// Copyright (C)1999-2007:\n//\t\t- Jonathan Bennett <jon@hiddensoft.com>\n//\t\t- Others listed at http://www.autoitscript.com/autoit3/docs/credits.htm\n// - Chris Mallett (support@autohotkey.com): adaptation of this file's\n// functions to interface with AutoHotkey.\n//\n// This program is free software; you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation; either version 2 of the License, or\n// (at your option) any later version.\n//\n///////////////////////////////////////////////////////////////////////////////\n//\n// script_registry.cpp\n//\n// Contains registry handling routines. Part of script.cpp\n//\n///////////////////////////////////////////////////////////////////////////////\n\n\n// Includes\n#include \"stdafx.h\" // pre-compiled headers\n#include \"script.h\"\n#include \"util.h\" // for strlcpy()\n#include \"globaldata.h\"\n#include \"script_func_impl.h\"\n#include \"abi.h\"\n\n\nbif_impl FResult IniRead(StrArg aFilespec, optl<StrArg> aSection, optl<StrArg> aKey, optl<StrArg> aDefault, StrRet &aRetVal)\n{\n\tTCHAR\tszFileTemp[T_MAX_PATH];\n\tTCHAR\t*szFilePart, *cp;\n\tTCHAR\tszBuffer[65535];\t\t\t\t\t// Max ini file size is 65535 under 95\n\t*szBuffer = '\\0';\n\tTCHAR\tszEmpty[] = _T(\"\");\n\n\t// Get the fullpathname (ini functions need a full path):\n\tGetFullPathName(aFilespec, _countof(szFileTemp), szFileTemp, &szFilePart);\n\tif (aKey.has_value()) // But let it be \"\", which would correspond to an entry such as \"=value\".\n\t{\n\t\tif (!aSection.has_value()) // But an explicit \"\" acceptable (see below).\n\t\t\treturn FR_E_ARG(1);\n\t\t// An access violation can occur if the following conditions are met:\n\t\t//\t1) aFilespec specifies a Unicode file.\n\t\t//\t2) aSection is a read-only string, either empty or containing only spaces.\n\t\t//\n\t\t// Debugging at the assembly level indicates that in this specific situation,\n\t\t// it tries to write a zero at the end of aSection (which is already null-\n\t\t// terminated).\n\t\t//\n\t\t// The second condition can ordinarily only be met if Section is omitted,\n\t\t// since in all other cases aSection is writable. Although Section was a\n\t\t// required parameter prior to revision 57, empty or blank section names\n\t\t// are actually valid. Simply passing an empty writable buffer appears\n\t\t// to work around the problem effectively:\n\t\tGetPrivateProfileString(*aSection.value() ? aSection.value() : szEmpty\n\t\t\t, aKey.value(), aDefault.value_or_null(), szBuffer, _countof(szBuffer), szFileTemp);\n\t}\n\telse if (aSection.has_value()\n\t\t? GetPrivateProfileSection(aSection.value(), szBuffer, _countof(szBuffer), szFileTemp)\n\t\t: GetPrivateProfileSectionNames(szBuffer, _countof(szBuffer), szFileTemp))\n\t{\n\t\t// Convert null-terminated array of null-terminated strings to newline-delimited list.\n\t\tfor (cp = szBuffer; ; ++cp)\n\t\t\tif (!*cp)\n\t\t\t{\n\t\t\t\tif (!cp[1])\n\t\t\t\t\tbreak;\n\t\t\t\t*cp = '\\n';\n\t\t\t}\n\t}\n\tg->LastError = GetLastError();\n\tif (g->LastError)\n\t{\n\t\tif (!aDefault.has_value())\n\t\t{\n\t\t\tif (g->LastError == 2)\n\t\t\t\treturn FError(_T(\"The requested key, section or file was not found.\"));\n\t\t\treturn FR_E_WIN32(g->LastError);\n\t\t}\n\t\tif (!aKey.has_value())\n\t\t{\n\t\t\taRetVal.SetTemp(aDefault.value());\n\t\t\treturn OK;\n\t\t}\n\t}\n\t// The above function is supposed to set szBuffer to be aDefault if it can't find the\n\t// file, section, or key. In other words, it always changes the contents of szBuffer.\n\tif (!aRetVal.Copy(szBuffer)) // Avoid using the length the API reported because it might be inaccurate if the data contains any binary zeroes, or if the data is double-terminated, etc.\n\t\treturn FR_E_OUTOFMEM;\n\treturn OK;\n}\n\n#ifdef UNICODE\nstatic BOOL IniEncodingFix(LPCWSTR aFilespec, LPCWSTR aSection)\n{\n\tBOOL result = TRUE;\n\tif (GetFileAttributes(aFilespec) == INVALID_FILE_ATTRIBUTES) // File does not appear to exist.\n\t{\n\t\tHANDLE hFile;\n\t\tDWORD dwWritten;\n\n\t\t// Create a Unicode file. (UTF-16LE BOM)\n\t\thFile = CreateFile(aFilespec, GENERIC_WRITE, 0, NULL, CREATE_NEW, 0, NULL);\n\t\tif (hFile != INVALID_HANDLE_VALUE)\n\t\t{\n\t\t\tDWORD cc = (DWORD)wcslen(aSection);\n\t\t\tLPTSTR section = talloca(cc + 4);\n\t\t\tsntprintf(section, cc + 4, L\"\\xFEFF[%s]\", aSection);\n\t\t\tDWORD cb = _TSIZE(cc + 3);\n\t\t\t\n\t\t\t// Write a UTF-16LE BOM to identify this as a Unicode file.\n\t\t\t// Write [%aSection%] to prevent WritePrivateProfileString from inserting an empty line (for consistency and style).\n\t\t\tif (!WriteFile(hFile, section, cb, &dwWritten, NULL) || dwWritten != cb)\n\t\t\t\tresult = FALSE;\n\n\t\t\tif (!CloseHandle(hFile))\n\t\t\t\tresult = FALSE;\n\t\t}\n\t}\n\treturn result;\n}\n#endif\n\nbif_impl FResult IniWrite(StrArg aValue, StrArg aFilespec, StrArg aSection, optl<StrArg> aKey)\n{\n\tTCHAR\tszFileTemp[T_MAX_PATH];\n\tTCHAR\t*szFilePart;\n\tBOOL\tresult;\n\t// Get the fullpathname (INI functions need a full path) \n\tGetFullPathName(aFilespec, _countof(szFileTemp), szFileTemp, &szFilePart);\n#ifdef UNICODE\n\t// WritePrivateProfileStringW() always creates INIs using the system codepage.\n\t// IniEncodingFix() checks if the file exists and if it doesn't then it creates\n\t// an empty file with a UTF-16LE BOM.\n\tresult = IniEncodingFix(szFileTemp, aSection);\n\tif(result){\n#endif\n\t\tif (aKey.has_value()) // But let it be \"\", which would create an entry such as \"=value\".\n\t\t{\n\t\t\tresult = WritePrivateProfileString(aSection, aKey.value(), aValue, szFileTemp); // Returns zero on failure.\n\t\t}\n\t\telse\n\t\t{\n\t\t\tsize_t value_len = _tcslen(aValue);\n\t\t\tTCHAR c, *cp, *szBuffer = talloca(value_len + 2); // +2 for double null-terminator.\n\t\t\t// Convert newline-delimited list to null-terminated array of null-terminated strings.\n\t\t\tfor (cp = szBuffer; *aValue; ++cp, ++aValue)\n\t\t\t{\n\t\t\t\tc = *aValue;\n\t\t\t\t*cp = (c == '\\n') ? '\\0' : c;\n\t\t\t}\n\t\t\t*cp = '\\0', cp[1] = '\\0'; // Double null-terminator.\n\t\t\tresult = WritePrivateProfileSection(aSection, szBuffer, szFileTemp);\n\t\t}\n\t\tif (result)\n\t\t\tWritePrivateProfileString(NULL, NULL, NULL, szFileTemp);\t// Flush\n#ifdef UNICODE\n\t}\n#endif\n\treturn result ? OK : FR_E_WIN32;\n}\n\n\n\nbif_impl FResult IniDelete(StrArg aFilespec, StrArg aSection, optl<StrArg> aKey)\n// Note that aKey can be NULL, in which case the entire section will be deleted.\n{\n\tTCHAR\tszFileTemp[T_MAX_PATH];\n\tTCHAR\t*szFilePart;\n\t// Get the fullpathname (ini functions need a full path) \n\tGetFullPathName(aFilespec, _countof(szFileTemp), szFileTemp, &szFilePart);\n\tBOOL result = WritePrivateProfileString(aSection, aKey.value_or_null(), NULL, szFileTemp); // Returns zero on failure.\n\tg->LastError = GetLastError();\n\tWritePrivateProfileString(NULL, NULL, NULL, szFileTemp);\t// Flush\n\treturn result ? OK : FR_E_WIN32(g->LastError);\n}\n\n\n\nvoid RegRead(ResultToken &aResultToken, HKEY aRootKey, LPTSTR aRegSubkey, LPTSTR aValueName, ExprTokenType *aDefault)\n{\n\tHKEY\thRegKey;\n\tDWORD\tdwRes, dwBuf, dwType;\n\tLONG result;\n\n\t_f_set_retval_p(_T(\"\"), 0); // Set default in case of early return.\n\n\t// Open the registry key\n\tresult = RegOpenKeyEx(aRootKey, aRegSubkey, 0, KEY_READ | g->RegView, &hRegKey);\n\tif (result != ERROR_SUCCESS)\n\t\tgoto finish_skip_close;\n\n\t// Read the value and determine the type. If aValueName is the empty string, the key's default value is used.\n\tresult = RegQueryValueEx(hRegKey, aValueName, NULL, &dwType, NULL, NULL);\n\tif (result != ERROR_SUCCESS)\n\t\tgoto finish;\n\n\tLPTSTR contents;\n\n\t// The way we read is different depending on the type of the key\n\tswitch (dwType)\n\t{\n\t\tcase REG_DWORD:\n\t\t\tdwRes = sizeof(dwBuf);\n\t\t\tresult = RegQueryValueEx(hRegKey, aValueName, NULL, NULL, (LPBYTE)&dwBuf, &dwRes);\n\t\t\tif (result == ERROR_SUCCESS)\n\t\t\t{\n\t\t\t\t// Set the return value but don't return yet.\n\t\t\t\taResultToken.Return(dwBuf);\n\t\t\t}\n\t\t\tbreak;\n\n\t\t// Note: The contents of any of these types can be >64K on NT/2k/XP+ (though that is probably rare):\n\t\tcase REG_SZ:\n\t\tcase REG_EXPAND_SZ:\n\t\tcase REG_MULTI_SZ:\n\t\t{\n\t\t\tdwRes = 0; // Retained for backward compatibility because values >64K may cause it to fail on Win95 (unverified, and MSDN implies its value should be ignored for the following call).\n\t\t\t// MSDN: If lpData is NULL, and lpcbData is non-NULL, the function returns ERROR_SUCCESS and stores\n\t\t\t// the size of the data, in bytes, in the variable pointed to by lpcbData.\n\t\t\tresult = RegQueryValueEx(hRegKey, aValueName, NULL, NULL, NULL, &dwRes); // Find how large the value is.\n\t\t\tif (result != ERROR_SUCCESS || !dwRes) // Can't find size (realistically might never happen), or size is zero.\n\t\t\t\tbreak;\n\t\t\tDWORD dwCharLen = dwRes / sizeof(TCHAR);\n\t\t\t// Set up the result buffer to receive the contents.\n\t\t\t// Since dwRes includes the space for the zero terminator (if the MSDN docs\n\t\t\t// are accurate), this will size it to be 1 byte larger than we need,\n\t\t\t// which leaves room for the final newline character to be inserted after\n\t\t\t// the last item. But add 2 to the requested capacity in case the data isn't\n\t\t\t// terminated in the registry, which allows double-NULL to be put in for REG_MULTI_SZ later.\n\t\t\tif (!TokenSetResult(aResultToken, NULL, dwCharLen + 2))\n\t\t\t\tbreak; // aResultToken.Error() was already called, but we still need to call RegCloseKey().\n\t\t\t//aResultToken.symbol = SYM_STRING; // Already set by _f_set_reval_p().\n\t\t\tcontents = aResultToken.marker; // This target buf should now be large enough for the result.\n\n\t\t\tresult = RegQueryValueEx(hRegKey, aValueName, NULL, NULL, (LPBYTE)contents, &dwRes);\n\n\t\t\tif (result != ERROR_SUCCESS || !dwRes) // Relies on short-circuit boolean order.\n\t\t\t{\n\t\t\t\t*contents = '\\0'; // MSDN says the contents of the buffer is undefined after the call in some cases, so reset it.\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tdwCharLen = dwRes / sizeof(TCHAR);\n\t\t\t\t// See ReadRegString() for more comments about the following:\n\t\t\t\t// The MSDN docs state that we should ensure that the buffer is NULL-terminated ourselves:\n\t\t\t\t// \"If the data has the REG_SZ, REG_MULTI_SZ or REG_EXPAND_SZ type, then lpcbData will also\n\t\t\t\t// include the size of the terminating null character or characters ... If the data has the\n\t\t\t\t// REG_SZ, REG_MULTI_SZ or REG_EXPAND_SZ type, the string may not have been stored with the\n\t\t\t\t// proper null-terminating characters. Applications should ensure that the string is properly\n\t\t\t\t// terminated before using it, otherwise, the application may fail by overwriting a buffer.\"\n\t\t\t\t//\n\t\t\t\t// The MSDN docs cited above are a little unclear. The most likely interpretation is that\n\t\t\t\t// dwRes contains the true size retrieved. For example, if dwRes is 1, the first char\n\t\t\t\t// in the buffer is either a NULL or an actual non-NULL character that was originally\n\t\t\t\t// stored in the registry incorrectly (i.e. without a terminator).\n\t\t\t\t//\n\t\t\t\t// Include all data up to dwCharLen, excluding one null-terminator if present,\n\t\t\t\t// but ensure the final value is properly null-terminated outside of dwCharLen.\n\t\t\t\tif (!contents[dwCharLen - 1])\n\t\t\t\t\t--dwCharLen;\n\t\t\t\telse\n\t\t\t\t\tcontents[dwCharLen] = '\\0';\n\t\t\t\tif (dwType == REG_MULTI_SZ) // Convert NULL-delimiters into newline delimiters.\n\t\t\t\t{\n\t\t\t\t\t// Translate each null-terminated string within dwCharLen to a newline-terminated string.\n\t\t\t\t\t// There used to be a comment here indicating that terminating the final item with \\n\n\t\t\t\t\t// makes parsing easier, but I don't think that's true when using Loop Parse/StrSplit.\n\t\t\t\t\t// In any case, RegRead's documentation indicates that all items will end with `n.\n\t\t\t\t\t// Cases covered here:\n\t\t\t\t\t// A. item1\\0item2\\0\\0 ; Correctly terminated (one \\0 was excluded from dwCharLen above)\n\t\t\t\t\t// B. item1\\0item2\\0 ; Incorrectly terminated\n\t\t\t\t\t// C. item1\\0item2 ; Incorrectly unterminated (but it was terminated above)\n\t\t\t\t\t// RegRead distinguishes between A & B/C by only showing a trailing blank line for A,\n\t\t\t\t\t// but doing that here would be contrary to the documentation and probably wouldn't be\n\t\t\t\t\t// useful since B and C are technically invalid.\n\t\t\t\t\tif (!dwCharLen // Value was just \\0 on its own (dwCharLen is 0 due to --dwCharLen above).\n\t\t\t\t\t\t|| contents[dwCharLen - 1]) // Case B or C above.\n\t\t\t\t\t{\n\t\t\t\t\t\t++dwCharLen; // Let the null-terminator (guaranteed above) be translated to \\n.\n\t\t\t\t\t\tcontents[dwCharLen] = '\\0'; // Ensure there's still an actual null-terminator.\n\t\t\t\t\t}\n\t\t\t\t\t// Empty items (signified by \\0\\0 within the value) are specifically permitted by this loop,\n\t\t\t\t\t// and are known to commonly occur in the PendingRenameOperations value written by MoveFileEx.\n\t\t\t\t\tfor (DWORD i = 0; i < dwCharLen; ++i)\n\t\t\t\t\t\tif (!contents[i])\n\t\t\t\t\t\t\tcontents[i] = '\\n';\n\t\t\t\t}\n\t\t\t}\n\t\t\taResultToken.marker_length = _tcslen(contents); // Due to conservative buffer sizes above, length is probably too large by 3. So update to reflect the true length.\n\t\t\tbreak;\n\t\t}\n\t\tcase REG_BINARY:\n\t\t{\n\t\t\t// See case REG_SZ for comments.\n\t\t\tdwRes = 0;\n\t\t\tresult = RegQueryValueEx(hRegKey, aValueName, NULL, NULL, NULL, &dwRes); // Find how large the value is.\n\t\t\tif (result != ERROR_SUCCESS || !dwRes) // Can't find size (realistically might never happen), or size is zero.\n\t\t\t\tbreak;\n\n\t\t\t// Set up the result buffer.\n\t\t\t// AutoIt3: Each byte will turned into 2 digits, plus a final null:\n\t\t\tif (!TokenSetResult(aResultToken, NULL, dwRes * 2))\n\t\t\t\tbreak; // aResultToken.Error() was already called, but we still need to call RegCloseKey().\n\t\t\t//aResultToken.symbol = SYM_STRING; // Already set by _f_set_reval_p().\n\t\t\tcontents = aResultToken.marker;\n\t\t\t*contents = '\\0';\n\t\t\t\n\t\t\t// Read the binary data into the variable, placed so that the last byte of\n\t\t\t// binary data will be overwritten as the hexadecimal conversion completes.\n\t\t\tLPBYTE pRegBuffer = (LPBYTE)(contents + dwRes * 2) - dwRes;\n\t\t\tresult = RegQueryValueEx(hRegKey, aValueName, NULL, NULL, pRegBuffer, &dwRes);\n\t\t\tif (result != ERROR_SUCCESS)\n\t\t\t{\n\t\t\t\taResultToken.marker_length = 0; // Override the length set by TokenSetResult().\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tint j = 0;\n\t\t\tDWORD i, n; // i and n must be unsigned to work\n\t\t\tstatic const TCHAR szHexData[] = _T(\"0123456789ABCDEF\");\n\t\t\tfor (i = 0; i < dwRes; ++i)\n\t\t\t{\n\t\t\t\tn = pRegBuffer[i];\t\t\t\t// Get the value and convert to 2 digit hex\n\t\t\t\tcontents[j + 1] = szHexData[n % 16];\n\t\t\t\tn /= 16;\n\t\t\t\tcontents[j] = szHexData[n % 16];\n\t\t\t\tj += 2;\n\t\t\t}\n\t\t\tcontents[j] = '\\0'; // Terminate\n\t\t\t// aResultToken.marker_length was already set by TokenSetResult().\n\t\t\tbreak;\n\t\t}\n\t\tdefault:\n\t\t\tresult = ERROR_UNSUPPORTED_TYPE; // Indicate the error.\n\t\t\tbreak;\n\t}\n\nfinish:\n\t// The function is designed to reach this point only if the key was opened,\n\t// rather than initializing hRegKey to NULL and checking here, since it's\n\t// not clear whether NULL is actually an invalid registry handle value:\n\t//if (hRegKey)\n\tRegCloseKey(hRegKey);\nfinish_skip_close:\n\tg->LastError = result;\n\tif (result == ERROR_FILE_NOT_FOUND && aDefault)\n\t{\n\t\taResultToken.CopyValueFrom(*aDefault);\n\t\tif (aResultToken.symbol == SYM_OBJECT)\n\t\t\taResultToken.object->AddRef(); // Must be done for safety, and supporting objects (returned as is) might have some utility.\n\t}\n\telse if (result != ERROR_SUCCESS)\n\t\t_f_throw_win32(g->LastError);\n} // RegRead()\n\n\n\nvoid RegWrite(ResultToken &aResultToken, ExprTokenType *aValue, DWORD aValueType, HKEY aRootKey, LPTSTR aRegSubkey, LPTSTR aValueName)\n// If aValueName is the empty string, the key's default value is used.\n// if aValue is NULL, aValueType must be REG_NONE; a key will be created but no value will be set.\n{\n\tHKEY\thRegKey;\n\tDWORD\tdwBuf;\n\n\tTCHAR nbuf[MAX_NUMBER_SIZE];\n\tLPTSTR value;\n\tsize_t length;\n\t\n\tLONG result;\n\n\tif (aValue) // RegWrite, not RegCreateKey\n\t{\n\t\tif (aValueType == REG_NONE) // Omitted\n\t\t\treturn (void)aResultToken.ParamError(1, nullptr);\n\n\t\tif (aValueType != REG_DWORD)\n\t\t\tvalue = TokenToString(*aValue, nbuf, &length);\n\t\telse if (TokenIsNumeric(*aValue))\n\t\t\tdwBuf = (DWORD)TokenToInt64(*aValue);\n\t\telse\n\t\t\treturn (void)aResultToken.ParamError(0, aValue, _T(\"Number\"));\n\t}\n\n\t// Open/Create the registry key\n\t// The following works even on root keys (i.e. blank subkey), although values can't be created/written to\n\t// HKCU's root level, perhaps because it's an alias for a subkey inside HKEY_USERS. Even when RegOpenKeyEx()\n\t// is used on HKCU (which is probably redundant since it's a pre-opened key?), the API can't create values\n\t// there even though RegEdit can.\n\tresult = RegCreateKeyEx(aRootKey, aRegSubkey, 0, _T(\"\"), REG_OPTION_NON_VOLATILE, KEY_WRITE | g->RegView, NULL, &hRegKey, NULL);\n\tif (result != ERROR_SUCCESS)\n\t\tgoto finish;\n\n\t// Write the registry differently depending on type of variable we are writing\n\tswitch (aValueType)\n\t{\n\tcase REG_SZ:\n\t\tresult = RegSetValueEx(hRegKey, aValueName, 0, REG_SZ, (CONST BYTE *)value, (DWORD)(length+1) * sizeof(TCHAR));\n\t\tbreak;\n\n\tcase REG_EXPAND_SZ:\n\t\tresult = RegSetValueEx(hRegKey, aValueName, 0, REG_EXPAND_SZ, (CONST BYTE *)value, (DWORD)(length+1) * sizeof(TCHAR));\n\t\tbreak;\n\t\n\tcase REG_MULTI_SZ:\n\t{\n\t\t// Allocate some temporary memory because aValue might not be a writable string,\n\t\t// and we would need to write to it to temporarily change the newline delimiters into\n\t\t// zero-delimiters. Even if we were to require callers to give us a modifiable string,\n\t\t// its capacity may be 1 byte too small to handle the double termination that's needed\n\t\t// (i.e. if the last item in the list happens to not end in a newline):\n\t\tLPTSTR buf = tmalloc(length + 2);\n\t\tif (!buf)\n\t\t{\n\t\t\tresult = ERROR_OUTOFMEMORY;\n\t\t\tbreak;\n\t\t}\n\t\ttcslcpy(buf, value, length + 1);\n\t\t// Double-terminate:\n\t\tbuf[length + 1] = '\\0';\n\n\t\t// Remove any final newline the user may have provided since we don't want the length\n\t\t// to include it when calling RegSetValueEx() -- it would be too large by 1:\n\t\tif (length > 0 && buf[length - 1] == '\\n')\n\t\t\tbuf[--length] = '\\0';\n\n\t\t// Replace the script's delimiter char with the zero-delimiter needed by RegSetValueEx():\n\t\tfor (LPTSTR cp = buf; *cp; ++cp)\n\t\t\tif (*cp == '\\n')\n\t\t\t\t*cp = '\\0';\n\n\t\tresult = RegSetValueEx(hRegKey, aValueName, 0, REG_MULTI_SZ, (CONST BYTE *)buf\n\t\t\t\t\t\t\t\t, (DWORD)(length ? length + 2 : 0) * sizeof(TCHAR));\n\t\tfree(buf);\n\t\tbreak;\n\t}\n\n\tcase REG_DWORD:\n\t\tresult = RegSetValueEx(hRegKey, aValueName, 0, REG_DWORD, (CONST BYTE *)&dwBuf, sizeof(dwBuf));\n\t\tbreak;\n\n\tcase REG_BINARY:\n\t{\n\t\tint nLen = (int)length;\n\n\t\t// String length must be a multiple of 2 \n\t\tif (nLen % 2)\n\t\t{\n\t\t\tresult = ERROR_INVALID_PARAMETER;\n\t\t\tbreak;\n\t\t}\n\n\t\tint nBytes = nLen / 2;\n\t\tLPBYTE pRegBuffer = (LPBYTE) malloc(nBytes);\n\t\tif (!pRegBuffer)\n\t\t{\n\t\t\tresult = ERROR_OUTOFMEMORY;\n\t\t\tbreak;\n\t\t}\n\n\t\t// Really crappy hex conversion\n\t\tint j = 0, i = 0, nVal, nMult;\n\t\twhile (i < nLen && j < nBytes)\n\t\t{\n\t\t\tnVal = 0;\n\t\t\tfor (nMult = 16; nMult >= 0; nMult = nMult - 15)\n\t\t\t{\n\t\t\t\tif (value[i] >= '0' && value[i] <= '9')\n\t\t\t\t\tnVal += (value[i] - '0') * nMult;\n\t\t\t\telse if (value[i] >= 'A' && value[i] <= 'F')\n\t\t\t\t\tnVal += (((value[i] - 'A'))+10) * nMult;\n\t\t\t\telse if (value[i] >= 'a' && value[i] <= 'f')\n\t\t\t\t\tnVal += (((value[i] - 'a'))+10) * nMult;\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tfree(pRegBuffer);\n\t\t\t\t\tRegCloseKey(hRegKey);\n\t\t\t\t\tresult = ERROR_INVALID_PARAMETER;\n\t\t\t\t\tgoto finish;\n\t\t\t\t}\n\t\t\t\t++i;\n\t\t\t}\n\t\t\tpRegBuffer[j++] = (char)nVal;\n\t\t}\n\n\t\tresult = RegSetValueEx(hRegKey, aValueName, 0, REG_BINARY, pRegBuffer, (DWORD)j);\n\t\tfree(pRegBuffer);\n\t\tbreak;\n\t}\n\n\tcase REG_NONE: // RegCreateKey\n\t\tbreak;\n\n\tdefault: // Could be any unsupported value stored in reg_item.type by RegEnumValue().\n\t\tresult = ERROR_INVALID_PARAMETER; // Anything other than ERROR_SUCCESS.\n\t\tbreak;\n\t} // switch()\n\n\tRegCloseKey(hRegKey);\n\t// Additionally, fall through to below:\n\nfinish:\n\tg->LastError = result;\n\tif (result != ERROR_SUCCESS)\n\t\t_f_throw_win32(result);\n\t_f_return_empty;\n} // RegWrite()\n\n\n\nLONG RegRemoveSubkeys(HKEY hRegKey)\n{\n\t// Removes all subkeys to the given key. Will not touch the given key.\n\tTCHAR Name[256];\n\tDWORD dwNameSize;\n\tFILETIME ftLastWrite;\n\tHKEY hSubKey;\n\tLONG result;\n\n\tfor (;;) \n\t{ // infinite loop \n\t\tdwNameSize = _countof(Name)-1;\n\t\tif (RegEnumKeyEx(hRegKey, 0, Name, &dwNameSize, NULL, NULL, NULL, &ftLastWrite) == ERROR_NO_MORE_ITEMS)\n\t\t\treturn ERROR_SUCCESS;\n\t\tresult = RegOpenKeyEx(hRegKey, Name, 0, KEY_READ | g->RegView, &hSubKey);\n\t\tif (result != ERROR_SUCCESS)\n\t\t\tbreak;\n\t\tresult = RegRemoveSubkeys(hSubKey);\n\t\tRegCloseKey(hSubKey);\n\t\tif (result != ERROR_SUCCESS)\n\t\t\tbreak;\n\t\tresult = RegDeleteKey(hRegKey, Name);\n\t\tif (result != ERROR_SUCCESS)\n\t\t\tbreak;\n\t}\n\treturn result;\n}\n\n\n\nvoid RegDelete(ResultToken &aResultToken, HKEY aRootKey, LPTSTR aRegSubkey, LPTSTR aValueName)\n{\n\tLONG result;\n\n\tif (!aRootKey)\n\t\t_f_throw_value(ERR_PARAM1_INVALID);\n\t// Fix for v1.0.48: Don't remove the entire key if it's a root key! According to MSDN,\n\t// the root key would be opened by RegOpenKeyEx() further below whenever aRegSubkey is NULL\n\t// or an empty string. aValueName is also checked to preserve the ability to delete a value\n\t// that exists directly under a root key.\n\tif ( (!aRegSubkey || !*aRegSubkey) && !aValueName )\n\t\t_f_throw_value(_T(\"Cannot delete root key\"));\n\n\t// Open the key we want\n\tHKEY hRegKey;\n\tresult = RegOpenKeyEx(aRootKey, aRegSubkey, 0, KEY_READ | KEY_WRITE | g->RegView, &hRegKey);\n\tif (result != ERROR_SUCCESS)\n\t\tgoto finish;\n\n\tif (!aValueName) // Caller's signal to delete the entire subkey.\n\t{\n\t\t// Remove the entire Key\n\t\tresult = RegRemoveSubkeys(hRegKey); // Delete any subitems within the key.\n\t\tRegCloseKey(hRegKey); // Close parent key. Not sure if this needs to be done only after the above.\n\t\tif (result == ERROR_SUCCESS)\n\t\t{\n\t\t\tif (g->RegView)\n\t\t\t\tresult = RegDeleteKeyEx(aRootKey, aRegSubkey, g->RegView, 0);\n\t\t\telse\n\t\t\t\tresult = RegDeleteKey(aRootKey, aRegSubkey);\n\t\t}\n\t}\n\telse\n\t{\n\t\t// Remove the value.\n\t\tresult = RegDeleteValue(hRegKey, aValueName);\n\t\tRegCloseKey(hRegKey);\n\t}\n\nfinish:\n\tg->LastError = result;\n\tif (result != ERROR_SUCCESS)\n\t\t_f_throw_win32(result);\n\t_f_return_empty;\n} // RegDelete()\n\n\n\nstruct RegRootKeyType\n{\n\tLPTSTR short_name;\n\tLPTSTR long_name;\n\tHKEY key;\n};\n\nstatic RegRootKeyType sRegRootKeyTypes[] =\n{\n\t{_T(\"HKLM\"), _T(\"HKEY_LOCAL_MACHINE\"), HKEY_LOCAL_MACHINE},\n\t{_T(\"HKCR\"), _T(\"HKEY_CLASSES_ROOT\"), HKEY_CLASSES_ROOT},\n\t{_T(\"HKCC\"), _T(\"HKEY_CURRENT_CONFIG\"), HKEY_CURRENT_CONFIG},\n\t{_T(\"HKCU\"), _T(\"HKEY_CURRENT_USER\"), HKEY_CURRENT_USER},\n\t{_T(\"HKU\"), _T(\"HKEY_USERS\"), HKEY_USERS}\n};\n\nHKEY Line::RegConvertRootKeyType(LPTSTR aName)\n{\n\tfor (int i = 0; i < _countof(sRegRootKeyTypes); ++i)\n\t\tif (!_tcsicmp(aName, sRegRootKeyTypes[i].short_name)\n\t\t\t|| !_tcsicmp(aName, sRegRootKeyTypes[i].long_name))\n\t\t\treturn sRegRootKeyTypes[i].key;\n\treturn NULL;\n}\n\nLPTSTR Line::RegConvertRootKeyType(HKEY aKey)\n{\n\tfor (int i = 0; i < _countof(sRegRootKeyTypes); ++i)\n\t\tif (aKey == sRegRootKeyTypes[i].key)\n\t\t\treturn sRegRootKeyTypes[i].long_name;\n\t// These are either unused or so rarely used that they aren't supported:\n\t// HKEY_PERFORMANCE_DATA, HKEY_PERFORMANCE_TEXT, HKEY_PERFORMANCE_NLSTEXT\n\treturn _T(\"\");\n}\n\n\n\nBIF_DECL(BIF_Reg)\n{\n\tTCHAR key_buf[MAX_REG_ITEM_SIZE];\n\tBuiltInFunctionID action = _f_callee_id;\n\tHKEY root_key;\n\tLPTSTR sub_key;\n\tLPTSTR value_name = action == FID_RegDeleteKey ? NULL : _T(\"\"); // Set default.\n\tDWORD value_type = REG_NONE; // RegWrite\n\tExprTokenType *value = nullptr; // RegWrite\n\tbool close_root;\n\tif (action == FID_RegWrite)\n\t{\n\t\tvalue = aParam[0];\n\t\tif (aParamCount > 1)\n\t\t{\n\t\t\tif (aParam[1]->symbol != SYM_MISSING)\n\t\t\t{\n\t\t\t\tvalue_type = Line::RegConvertValueType(ParamIndexToString(1));\n\t\t\t\tif (value_type == REG_NONE) // In this case REG_NONE means unknown/invalid vs. omitted.\n\t\t\t\t\t_f_throw_param(1);\n\t\t\t}\n\t\t\taParamCount -= 2;\n\t\t}\n\t\telse\n\t\t\taParamCount = 0; // It was 1.\n\t\taParam += 2; // There might not have been 2, but it won't be dereferenced in that case anyway.\n\t}\n\tif (ParamIndexIsOmitted(0) && g->mLoopRegItem) // Default to the registry loop's current item.\n\t{\n\t\tRegItemStruct ®_item = *g->mLoopRegItem;\n\t\troot_key = reg_item.root_key;\n\t\tif (reg_item.type == REG_SUBKEY)\n\t\t{\n\t\t\tif (*reg_item.subkey)\n\t\t\t{\n\t\t\t\tsntprintf(key_buf, _countof(key_buf), _T(\"%s\\\\%s\"), reg_item.subkey, reg_item.name);\n\t\t\t\tsub_key = key_buf;\n\t\t\t}\n\t\t\telse\n\t\t\t\tsub_key = reg_item.name;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tsub_key = reg_item.subkey;\n\t\t\tif (action != FID_RegDeleteKey)\n\t\t\t{\n\t\t\t\tvalue_name = reg_item.name; // Set default.\n\t\t\t\tif (value_type == REG_NONE)\n\t\t\t\t\tvalue_type = reg_item.type;\n\t\t\t}\n\t\t}\n\t\t// Do not use RegCloseKey() on this, even if it's a remote key, since our caller handles that:\n\t\tclose_root = false;\n\t}\n\telse\n\t{\n\t\tLPTSTR key_name = ParamIndexToOptionalString(0); // No buf needed since numbers aren't valid root keys.\n\t\troot_key = Line::RegConvertKey(key_name, &sub_key, &close_root);\n\t\tif (!root_key)\n\t\t\treturn (void)aResultToken.ParamError(action == FID_RegWrite ? 2 : 0, aParamCount ? aParam[0] : nullptr);\n\t}\n\tif (!ParamIndexIsOmitted(1)) // Implies this isn't RegDeleteKey.\n\t{\n\t\tif (ParamIndexToObject(1))\n\t\t\treturn (void)aResultToken.ParamError(action == FID_RegWrite ? 3 : 1, aParam[1], _T(\"String\"));\n\t\tvalue_name = ParamIndexToString(1, _f_number_buf);\n\t}\n\n\tswitch (action)\n\t{\n\tcase FID_RegRead: RegRead(aResultToken, root_key, sub_key, value_name, ParamIndexIsOmitted(2) ? nullptr : aParam[2]); break;\n\tcase FID_RegCreateKey:\n\tcase FID_RegWrite: RegWrite(aResultToken, value, value_type, root_key, sub_key, value_name); break;\n\tdefault: RegDelete(aResultToken, root_key, sub_key, value_name); break;\n\t}\n\n\tif (close_root)\n\t\tRegCloseKey(root_key);\n}\n"},"size":{"kind":"number","value":25259,"string":"25,259"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":636,"string":"636"},"avg_line_length":{"kind":"number","value":36.545597484276726,"string":"36.545597"},"max_line_length":{"kind":"number","value":185,"string":"185"},"alphanum_fraction":{"kind":"number","value":0.6961447550737632,"string":"0.696145"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11082,"cells":{"id":{"kind":"number","value":16070,"string":"16,070"},"file_name":{"kind":"string","value":"util.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/util.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include <olectl.h> // for OleLoadPicture()\n#include <gdiplus.h> // Used by LoadPicture().\n#include \"util.h\"\n#include \"globaldata.h\"\n\n\nint GetYDay(int aMon, int aDay, bool aIsLeapYear)\n// Returns a number between 1 and 366.\n// Caller must verify that aMon is a number between 1 and 12, and aDay is a number between 1 and 31.\n{\n\t--aMon; // Convert to zero-based.\n\tif (aIsLeapYear)\n\t{\n\t\tint leap_offset[12] = {0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335};\n\t\treturn leap_offset[aMon] + aDay;\n\t}\n\telse\n\t{\n\t\tint normal_offset[12] = {0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334};\n\t\treturn normal_offset[aMon] + aDay;\n\t}\n}\n\n\n\nint GetISOWeekNumber(LPTSTR aBuf, int aYear, int aYDay, int aWDay)\n// Caller must ensure that aBuf is of size 7 or greater, that aYear is a valid year (e.g. 2005),\n// that aYDay is between 1 and 366, and that aWDay is between 0 and 6 (day of the week).\n// Produces the week number in YYYYNN format, e.g. 200501.\n// Note that year is also returned because it isn't necessarily the same as aTime's calendar year.\n// Based on Linux glibc source code (GPL).\n{\n\t--aYDay; // Convert to zero based.\n\t#define ISO_WEEK_START_WDAY 1 // Monday\n\t#define ISO_WEEK1_WDAY 4 // Thursday\n\t#define ISO_WEEK_DAYS(yday, wday) (yday - (yday - wday + ISO_WEEK1_WDAY + ((366 / 7 + 2) * 7)) % 7 \\\n\t\t+ ISO_WEEK1_WDAY - ISO_WEEK_START_WDAY);\n\n\tint year = aYear;\n\tint days = ISO_WEEK_DAYS(aYDay, aWDay);\n\n\tif (days < 0) // This ISO week belongs to the previous year.\n\t{\n\t\t--year;\n\t\tdays = ISO_WEEK_DAYS(aYDay + (365 + IS_LEAP_YEAR(year)), aWDay);\n\t}\n\telse\n\t{\n\t\tint d = ISO_WEEK_DAYS(aYDay - (365 + IS_LEAP_YEAR(year)), aWDay);\n\t\tif (0 <= d) // This ISO week belongs to the next year.\n\t\t{\n\t\t\t++year;\n\t\t\tdays = d;\n\t\t}\n\t}\n\n\t// Use sntprintf() for safety; that is, in case year contains a value longer than 4 digits.\n\t// This also adds the leading zeros in front of year and week number, if needed.\n\treturn sntprintf(aBuf, 7, _T(\"%04d%02d\"), year, (days / 7) + 1); // Return the length of the string produced.\n}\n\n\n\nResultType YYYYMMDDToFileTime(LPCTSTR aYYYYMMDD, FILETIME &aFileTime)\n{\n\tSYSTEMTIME st;\n\tif (!YYYYMMDDToSystemTime(aYYYYMMDD, st, false)) // \"false\" because it's validated below.\n\t\treturn FAIL;\n\t// This will return failure if aYYYYMMDD contained any invalid elements, such as an\n\t// explicit zero for the day of the month. It also reports failure if st.wYear is\n\t// less than 1601, which for simplicity is enforced globally throughout the program\n\t// since none of the Windows API calls seem to support earlier years.\n\treturn SystemTimeToFileTime(&st, &aFileTime) ? OK : FAIL; // The st.wDayOfWeek member is ignored.\n}\n\n\n\nDWORD YYYYMMDDToSystemTime2(LPCTSTR aYYYYMMDD, SYSTEMTIME *aSystemTime)\n// Calls YYYYMMDDToSystemTime() to fill up to two elements of the aSystemTime array.\n// Returns 0 if the parameter is empty or invalid, otherwise a GDTR bitwise combination\n// to indicate which of the two elements, or both, are present.\n// Caller must ensure that aYYYYMMDD is a modifiable string since it's temporarily altered and restored here.\n{\n\tDWORD gdtr = 0;\n\tif (!*aYYYYMMDD)\n\t\treturn gdtr;\n\tif (*aYYYYMMDD != '-') // Since first char isn't a dash, there is a minimum present.\n\t{\n\t\tTCHAR temp[16];\n\t\ttcslcpy(temp, aYYYYMMDD, _countof(temp));\n\t\tLPCTSTR cp, first = aYYYYMMDD;\n\t\tif (cp = _tcschr(aYYYYMMDD + 1, '-'))\n\t\t{\n\t\t\t// Temporarily terminate; otherwise, the dash and other chars would be considered invalid fields.\n\t\t\tauto n = min(cp - aYYYYMMDD, _countof(temp) - 1);\n\t\t\ttmemcpy(temp, aYYYYMMDD, n);\n\t\t\ttemp[n] = '\\0';\n\t\t\tfirst = temp;\n\t\t}\n\t\tif (YYYYMMDDToSystemTime(first, aSystemTime[0], true)) // Date string is valid.\n\t\t\tgdtr |= GDTR_MIN; // Indicate that minimum is present.\n\t\tif (cp)\n\t\t\taYYYYMMDD = cp + 1; // Set it to the maximum's position for use below.\n\t\telse // No dash, so there is no maximum. Indicate this by making aYYYYMMDD empty.\n\t\t\taYYYYMMDD = _T(\"\");\n\t}\n\telse // *aYYYYMMDD=='-', so only the maximum is present; thus there will be no minimum.\n\t\t++aYYYYMMDD; // Skip over the dash to set it to the maximum's position.\n\tif (*aYYYYMMDD) // There is a maximum.\n\t{\n\t\tif (YYYYMMDDToSystemTime(aYYYYMMDD, aSystemTime[1], true)) // Date string is valid.\n\t\t\tgdtr |= GDTR_MAX; // Indicate that maximum is present.\n\t\telse\n\t\t\tgdtr = 0; // Indicate that the value is invalid.\n\t}\n\treturn gdtr;\n}\n\n\n\nResultType YYYYMMDDToSystemTime(LPCTSTR aYYYYMMDD, SYSTEMTIME &aSystemTime, bool aValidateTimeValues)\n// Although aYYYYMMDD need not be terminated at the end of the YYYYMMDDHH24MISS string (as long as\n// the string's capacity is at least 14), it should be terminated if only the leading part\n// of the YYYYMMDDHH24MISS format is present.\n// Caller must ensure that aYYYYMMDD is non-NULL. If the string's length is not an even number\n// between 4 and 14 (inclusive), FAIL is returned. FAIL is also returned if aValidateTimeValues\n// is true and some elements of aYYYYMMDD were invalid, or if the year is less than 1601\n// (Windows generally does not support earlier years). Otherwise OK is returned.\n{\n\t// sscanf() is avoided because it adds 2 KB to the compressed EXE size.\n\t// Alternative approaches were tried to further reduce size but ultimately had the opposite effect:\n\t// - Parse each sequence of digits inline; e.g. (t[0] - '0') * 10 + (t[1] - '0') ...\n\t// - Parse with istrtoi64() and use division and modulo to extract each component.\n\t// - tcslcpy() once and take each component from the right, re-terminating instead of copying each.\n\tTCHAR temp[16];\n\tsize_t length = _tcslen(aYYYYMMDD); // Use this rather than incrementing the pointer in case there are ever partial fields such as 20051 vs. 200501.\n\t\n\t// Callers who check the return value expect this to be done even when !aValidateTimeValues:\n\tif (length < 4 || (length & 1) || length > 14 || !IsNumeric(aYYYYMMDD, false, false))\n\t\treturn FAIL;\n\n\ttcslcpy(temp, aYYYYMMDD, 5);\n\taSystemTime.wYear = _ttoi(temp);\n\n\tif (length > 4) // It has a month component.\n\t{\n\t\ttcslcpy(temp, aYYYYMMDD + 4, 3);\n\t\taSystemTime.wMonth = _ttoi(temp); // Unlike \"struct tm\", SYSTEMTIME uses 1 for January, not 0.\n\t\t// v1.0.48: Changed not to provide a default when month number is out-of-range.\n\t\t// This allows callers like \"if var is time\" to properly detect badly-formatted dates.\n\t}\n\telse\n\t\taSystemTime.wMonth = 1;\n\n\tif (length > 6) // It has a day-of-month component.\n\t{\n\t\ttcslcpy(temp, aYYYYMMDD + 6, 3);\n\t\taSystemTime.wDay = _ttoi(temp);\n\t}\n\telse\n\t\taSystemTime.wDay = 1;\n\n\tif (length > 8) // It has an hour component.\n\t{\n\t\ttcslcpy(temp, aYYYYMMDD + 8, 3);\n\t\taSystemTime.wHour = _ttoi(temp);\n\t}\n\telse\n\t\taSystemTime.wHour = 0; // Midnight.\n\n\tif (length > 10) // It has a minutes component.\n\t{\n\t\ttcslcpy(temp, aYYYYMMDD + 10, 3);\n\t\taSystemTime.wMinute = _ttoi(temp);\n\t}\n\telse\n\t\taSystemTime.wMinute = 0;\n\n\tif (length > 12) // It has a seconds component.\n\t{\n\t\ttcslcpy(temp, aYYYYMMDD + 12, 3);\n\t\taSystemTime.wSecond = _ttoi(temp);\n\t}\n\telse\n\t\taSystemTime.wSecond = 0;\n\n\taSystemTime.wMilliseconds = 0; // Always set to zero in this case.\n\n\t// v1.0.46.07: Unlike the other date/time components, which are validated further below by the call to\n\t// SystemTimeToFileTime(), \"month\" must be validated in advance because it's used to access an array\n\t// in the day-of-week code further below.\n\t// v1.0.48.04: To fix FormatTime and possibly other things, don't return FAIL when month is out-of-range unless\n\t// aDoValidate==false, and not even then (for maintainability) because a section further below handles it.\n\tif (aSystemTime.wMonth < 1 || aSystemTime.wMonth > 12) // Month must be validated prior to accessing the array further below.\n\t\t// Set an in-range default, which caller is likely to ignore if it passed true for aDoValidate\n\t\t// because the validation further below will also detect the out-of-range month and return FAIL.\n\t\taSystemTime.wDayOfWeek = 1;\n\telse // Month is in-range, which is necessary for the method below to work safely.\n\t{\n\t\t// Day-of-week code by Tomohiko Sakamoto:\n\t\tstatic const int t[] = {0, 3, 2, 5, 0, 3, 5, 1, 4, 6, 2, 4};\n\t\tint y = aSystemTime.wYear;\n\t\ty -= aSystemTime.wMonth < 3;\n\t\taSystemTime.wDayOfWeek = (y + y/4 - y/100 + y/400 + t[aSystemTime.wMonth-1] + aSystemTime.wDay) % 7;\n\t}\n\n\tif (aValidateTimeValues)\n\t{\n\t\tFILETIME ft;\n\t\t// This will return failure if aYYYYMMDD contained any invalid elements, such as an\n\t\t// explicit zero for the day of the month. It also reports failure if st.wYear is\n\t\t// less than 1601, which for simplicity is enforced globally throughout the program\n\t\t// since none of the Windows API calls seem to support earlier years.\n\t\treturn SystemTimeToFileTime(&aSystemTime, &ft) ? OK : FAIL;\n\t\t// Above: The st.wDayOfWeek member is ignored by the above (but might be used by our caller), but\n\t\t// that's okay because it shouldn't need validation.\n\t}\n\treturn OK;\n}\n\n\n\nLPTSTR FileTimeToYYYYMMDD(LPTSTR aBuf, FILETIME &aTime, bool aConvertToLocalTime)\n// Returns aBuf.\n{\n\tFILETIME ft;\n\tif (aConvertToLocalTime)\n\t\tFileTimeToLocalFileTime(&aTime, &ft); // MSDN says that target cannot be the same var as source.\n\telse\n\t\tmemcpy(&ft, &aTime, sizeof(FILETIME)); // memcpy() might be less code size that a struct assignment, ft = aTime.\n\tSYSTEMTIME st;\n\tif (FileTimeToSystemTime(&ft, &st))\n\t\treturn SystemTimeToYYYYMMDD(aBuf, st);\n\t*aBuf = '\\0';\n\treturn aBuf;\n}\n\n\n\nLPTSTR SystemTimeToYYYYMMDD(LPTSTR aBuf, SYSTEMTIME &aTime)\n{\n\t_stprintf(aBuf, _T(\"%04d%02d%02d\") _T(\"%02d%02d%02d\")\n\t\t, aTime.wYear, aTime.wMonth, aTime.wDay\n\t\t, aTime.wHour, aTime.wMinute, aTime.wSecond);\n\treturn aBuf;\n}\n\n\n\n__int64 YYYYMMDDSecondsUntil(LPCTSTR aYYYYMMDDStart, LPCTSTR aYYYYMMDDEnd, FResult &aStatus)\n// Returns the number of seconds from aYYYYMMDDStart until aYYYYMMDDEnd.\n// If aYYYYMMDDStart is blank, the current time will be used in its place.\n{\n\tASSERT(aYYYYMMDDStart && aYYYYMMDDEnd);\n\n\tFILETIME ftStart, ftEnd, ftNowUTC;\n\n\tif (*aYYYYMMDDStart)\n\t{\n\t\tif (!YYYYMMDDToFileTime(aYYYYMMDDStart, ftStart))\n\t\t{\n\t\t\taStatus = FR_E_ARG(1);\n\t\t\treturn 0;\n\t\t}\n\t}\n\telse // Use the current time in its place.\n\t{\n\t\tGetSystemTimeAsFileTime(&ftNowUTC);\n\t\tFileTimeToLocalFileTime(&ftNowUTC, &ftStart); // Convert UTC to local time.\n\t}\n\tif (*aYYYYMMDDEnd)\n\t{\n\t\tif (!YYYYMMDDToFileTime(aYYYYMMDDEnd, ftEnd))\n\t\t{\n\t\t\taStatus = FR_E_ARG(0);\n\t\t\treturn 0;\n\t\t}\n\t}\n\telse // Use the current time in its place.\n\t{\n\t\tGetSystemTimeAsFileTime(&ftNowUTC);\n\t\tFileTimeToLocalFileTime(&ftNowUTC, &ftEnd); // Convert UTC to local time.\n\t}\n\taStatus = OK; // Indicate success.\n\treturn FileTimeSecondsUntil(&ftStart, &ftEnd);\n}\n\n\n\n__int64 FileTimeSecondsUntil(FILETIME *pftStart, FILETIME *pftEnd)\n// Returns the number of seconds from pftStart until pftEnd.\n{\n\tif (!pftStart || !pftEnd) return 0;\n\n\t// The calculation is done this way for compilers that don't support 64-bit math operations (not sure which):\n\t// Note: This must be LARGE vs. ULARGE because we want the calculation to be signed for cases where\n\t// pftStart is greater than pftEnd:\n\tULARGE_INTEGER uiStart, uiEnd;\n\tuiStart.LowPart = pftStart->dwLowDateTime;\n\tuiStart.HighPart = pftStart->dwHighDateTime;\n\tuiEnd.LowPart = pftEnd->dwLowDateTime;\n\tuiEnd.HighPart = pftEnd->dwHighDateTime;\n\t// Must do at least the inner cast to avoid losing negative results:\n\treturn (__int64)((__int64)(uiEnd.QuadPart - uiStart.QuadPart) / 10000000); // Convert from tenths-of-microsecond.\n}\n\n\n\nSymbolType IsNumeric(LPCTSTR aBuf, BOOL aAllowNegative, BOOL aAllowAllWhitespace\n\t, BOOL aAllowFloat, BOOL aAllowImpure) // BOOL vs. bool might squeeze a little more performance out of this frequently-called function.\n// String can contain whitespace.\n// If aBuf doesn't contain something purely numeric, PURE_NOT_NUMERIC is returned. The same happens if\n// aBuf contains a float but aAllowFloat is false. (The aAllowFloat parameter isn't strictly necessary\n// because the caller could just check whether the return value is/isn't PURE_FLOAT to get the same effect.\n// However, supporting aAllowFloat seems to greatly improve maintainability because it saves many callers\n// from having to compare the return value to PURE_INTEGER [they can just interpret the return value as BOOL].\n// It also improves readability due to the \"Is\" part of the function name. So it seems worth keeping.)\n// Otherwise, PURE_INTEGER or PURE_FLOAT is returned.\n// If aAllowAllWhitespace==true and the string is blank or all whitespace, PURE_INTEGER is returned.\n// Obsolete comment: Making this non-inline reduces the size of the compressed EXE by only 2K. Since this\n// function is called so often, it seems preferable to keep it inline for performance.\n{\n\taBuf = omit_leading_whitespace(aBuf); // i.e. caller doesn't have to have ltrimmed, only rtrimmed.\n\tif (!*aBuf) // The string is empty or consists entirely of whitespace.\n\t\treturn aAllowAllWhitespace ? PURE_INTEGER : PURE_NOT_NUMERIC;\n\n\tif (*aBuf == '-')\n\t{\n\t\tif (aAllowNegative)\n\t\t\t++aBuf;\n\t\telse\n\t\t\treturn PURE_NOT_NUMERIC;\n\t}\n\telse if (*aBuf == '+')\n\t\t++aBuf;\n\n\t// Relies on short circuit boolean order to prevent reading beyond the end of the string:\n\tBOOL is_hex = IS_HEX(aBuf); // BOOL vs. bool might squeeze a little more performance out this frequently-called function.\n\tif (is_hex)\n\t\taBuf += 2; // Skip over the 0x prefix.\n\n\t// Set defaults:\n\tBOOL has_decimal_point = false;\n\tBOOL has_exponent = false;\n\tBOOL has_at_least_one_digit = false; // i.e. a string consisting of only \"+\", \"-\" or \".\" is not considered numeric.\n\tint c; // int vs. char might squeeze a little more performance out of it (it does reduce code size by 5 bytes). Probably must stay signed vs. unsigned for some of the uses below.\n\n\tfor (;; ++aBuf)\n\t{\n\t\tc = *aBuf;\n\t\tif (IS_SPACE_OR_TAB(c))\n\t\t{\n\t\t\tif (*omit_leading_whitespace(aBuf)) // But that space or tab is followed by something other than whitespace.\n\t\t\t\tif (!aAllowImpure) // e.g. \"123 456\" is not a valid pure number.\n\t\t\t\t\treturn PURE_NOT_NUMERIC;\n\t\t\t\t// else fall through to the bottom logic.\n\t\t\t// else since just whitespace at the end, the number qualifies as pure, so fall through to the bottom\n\t\t\t// logic (it would already have returned in the loop if it was impure)\n\t\t\tbreak;\n\t\t}\n\t\tif (!c) // End of string was encountered.\n\t\t\tbreak; // The number qualifies as pure, so fall through to the logic at the bottom. (It would already have returned elsewhere in the loop if the number is impure).\n\t\tif (c == '.')\n\t\t{\n\t\t\tif (!aAllowFloat || has_decimal_point || is_hex) // If aAllowFloat==false, a decimal point at the very end of the number is considered non-numeric even if aAllowImpure==true. Some callers might rely on this.\n\t\t\t\t// i.e. if aBuf contains 2 decimal points, it can't be a valid number.\n\t\t\t\t// Note that decimal points are allowed in hexadecimal strings, e.g. 0xFF.EE.\n\t\t\t\t// But since that format doesn't seem to be supported by VC++'s atof() and probably\n\t\t\t\t// related functions, and since it's extremely rare, it seems best not to support it.\n\t\t\t\treturn PURE_NOT_NUMERIC;\n\t\t\telse\n\t\t\t\thas_decimal_point = true;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (is_hex ? !_istxdigit(c) : (c < '0' || c > '9')) // And since we're here, it's not '.' either.\n\t\t\t{\n\t\t\t\tif (aAllowImpure) // Since aStr starts with a number (as verified above), it is considered a number.\n\t\t\t\t{\n\t\t\t\t\tif (has_at_least_one_digit)\n\t\t\t\t\t\treturn has_decimal_point ? PURE_FLOAT : PURE_INTEGER;\n\t\t\t\t\telse // i.e. the strings \".\" and \"-\" are not considered to be numeric by themselves.\n\t\t\t\t\t\treturn PURE_NOT_NUMERIC;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tif (ctoupper(c) != 'E' // v1.0.46.11: Support scientific notation in floating point numbers.\n\t\t\t\t\t\t|| !has_at_least_one_digit // But it must have at least one digit to the left of the 'E'. Some callers rely on this check.\n\t\t\t\t\t\t|| has_exponent\n\t\t\t\t\t\t|| !aAllowFloat)\n\t\t\t\t\t\treturn PURE_NOT_NUMERIC;\n\t\t\t\t\tif (aBuf[1] == '-' || aBuf[1] == '+') // The optional sign is present on the exponent.\n\t\t\t\t\t\t++aBuf; // Omit it from further consideration so that the outer loop doesn't see it as an extra/illegal sign.\n\t\t\t\t\tif (aBuf[1] < '0' || aBuf[1] > '9')\n\t\t\t\t\t\t// Even if it is an 'e', ensure what follows it is a valid exponent. Some callers rely\n\t\t\t\t\t\t// on this check, such as ones that expect \"0.6e\" to be non-numeric.\n\t\t\t\t\t\treturn PURE_NOT_NUMERIC;\n\t\t\t\t\thas_exponent = true;\n\t\t\t\t\thas_decimal_point = true; // For simplicity, since a decimal point after the exponent isn't valid.\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // This character is a valid digit or hex-digit.\n\t\t\t\thas_at_least_one_digit = true;\n\t\t}\n\t} // for()\n\n\tif (has_at_least_one_digit)\n\t\treturn has_decimal_point ? PURE_FLOAT : PURE_INTEGER;\n\telse\n\t\treturn PURE_NOT_NUMERIC; // i.e. the strings \"+\" \"-\" and \".\" are not numeric by themselves.\n}\n\n\n\nvoid strlcpy(LPSTR aDst, LPCSTR aSrc, size_t aDstSize) // Non-inline because it benches slightly faster that way.\n// Caller must ensure that aDstSize is greater than 0.\n// Caller must ensure that the entire capacity of aDst is writable, EVEN WHEN it knows that aSrc is much shorter\n// than the aDstSize. This is because the call to strncpy (which is used for its superior performance) zero-fills\n// any unused portion of aDst.\n// Description:\n// Same as strncpy() but guarantees null-termination of aDst upon return.\n// No more than aDstSize - 1 characters will be copied from aSrc into aDst\n// (leaving room for the zero terminator, which is always inserted).\n// This function is defined in some Unices but is not standard. But unlike\n// other versions, this one uses void for return value for reduced code size\n// (since it's called in so many places).\n{\n\t// Disabled for performance and reduced code size:\n\t//if (!aDst || !aSrc || !aDstSize) return aDstSize; // aDstSize must not be zero due to the below method.\n\t// It might be worthwhile to have a custom char-copying-loop here someday so that number of characters\n\t// actually copied (not including the zero terminator) can be returned to callers who want it.\n\t--aDstSize; // Convert from size to length (caller has ensured that aDstSize > 0).\n\tstrncpy(aDst, aSrc, aDstSize); // NOTE: In spite of its zero-filling, strncpy() benchmarks considerably faster than a custom loop, probably because it uses 32-bit memory operations vs. 8-bit.\n\taDst[aDstSize] = '\\0';\n}\n\n\n\nvoid wcslcpy(LPWSTR aDst, LPCWSTR aSrc, size_t aDstSize)\n{\n\t--aDstSize;\n\twcsncpy(aDst, aSrc, aDstSize);\n\taDst[aDstSize] = '\\0';\n}\n\n\n\nint sntprintf(LPTSTR aBuf, int aBufSize, LPCTSTR aFormat, ...)\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// aBuf will always be terminated here except when aBufSize is <= zero (in which case the caller should\n// already have terminated it). If aBufSize is greater than zero but not large enough to hold the\n// entire result, as much of the result as possible is copied and the return value is aBufSize - 1.\n// Returns the exact number of characters written, not including the zero terminator. A negative\n// number is never returned, even if aBufSize is <= zero (which means there isn't even enough space left\n// to write a zero terminator), under the assumption that the caller has already terminated the string\n// and thus prefers to have 0 rather than -1 returned in such cases.\n// MSDN says (about _snprintf(), and testing shows that it applies to _vsnprintf() too): \"This function\n// does not guarantee NULL termination, so ensure it is followed by sz[size - 1] = 0\".\n{\n\t// The following should probably never be changed without a full suite of tests to ensure the\n\t// change doesn't cause the finicky _vsnprintf() to break something.\n\tif (aBufSize < 1 || !aBuf || !aFormat) return 0; // It's called from so many places that the extra checks seem warranted.\n\tva_list ap;\n\tva_start(ap, aFormat);\n\t// Must use _vsnprintf() not _snprintf() because of the way va_list is handled:\n\tint result = _vsntprintf(aBuf, aBufSize, aFormat, ap); // \"returns the number of characters written, not including the terminating null character, or a negative value if an output error occurs\"\n\taBuf[aBufSize - 1] = '\\0'; // Confirmed through testing: Must terminate at this exact spot because _vsnprintf() doesn't always do it.\n\t// Fix for v1.0.34: If result==aBufSize, must reduce result by 1 to return an accurate result to the\n\t// caller. In other words, if the line above turned the last character into a terminator, one less character\n\t// is now present in aBuf.\n\tif (result == aBufSize)\n\t\t--result;\n\treturn result > -1 ? result : aBufSize - 1; // Never return a negative value. See comment under function definition, above.\n}\n\n\n\nint sntprintfcat(LPTSTR aBuf, int aBufSize, LPCTSTR aFormat, ...)\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// aBuf will always be terminated here except when the amount of space left in the buffer is zero or less.\n// (in which case the caller should already have terminated it). If aBufSize is greater than zero but not\n// large enough to hold the entire result, as much of the result as possible is copied and the return value\n// is space_remaining - 1.\n// The caller must have ensured that aBuf and aFormat are non-NULL and that aBuf contains a valid string\n// (i.e. that it is null-terminated somewhere within the limits of aBufSize).\n// Returns the exact number of characters written, not including the zero terminator. A negative\n// number is never returned, even if aBufSize is <= zero (which means there isn't even enough space left\n// to write a zero terminator), under the assumption that the caller has already terminated the string\n// and thus prefers to have 0 rather than -1 returned in such cases.\n{\n\t// The following should probably never be changed without a full suite of tests to ensure the\n\t// change doesn't cause the finicky _vsnprintf() to break something.\n\tsize_t length = _tcslen(aBuf);\n\tint space_remaining = (int)(aBufSize - length); // Must cast to int to avoid loss of negative values.\n\tif (space_remaining < 1) // Can't even terminate it (no room) so just indicate that no characters were copied.\n\t\treturn 0;\n\taBuf += length; // aBuf is now the spot where the new text will be written.\n\tva_list ap;\n\tva_start(ap, aFormat);\n\t// Must use vsnprintf() not snprintf() because of the way va_list is handled:\n\tint result = _vsntprintf(aBuf, (size_t)space_remaining, aFormat, ap); // \"returns the number of characters written, not including the terminating null character, or a negative value if an output error occurs\"\n\taBuf[space_remaining - 1] = '\\0'; // Confirmed through testing: Must terminate at this exact spot because _vsnprintf() doesn't always do it.\n\treturn result > -1 ? result : space_remaining - 1; // Never return a negative value. See comment under function definition, above.\n}\n\n\n\n// Not currently used by anything, so commented out to possibly reduce code size:\n//int tcslcmp(LPTSTR aBuf1, LPTSTR aBuf2, UINT aLength1, UINT aLength2)\n//// Case sensitive version. See strlicmp() comments below.\n//{\n//\tif (!aBuf1 || !aBuf2) return 0;\n//\tif (aLength1 == UINT_MAX) aLength1 = (UINT)_tcslen(aBuf1);\n//\tif (aLength2 == UINT_MAX) aLength2 = (UINT)_tcslen(aBuf2);\n//\tUINT least_length = aLength1 < aLength2 ? aLength1 : aLength2;\n//\tint diff;\n//\tfor (UINT i = 0; i < least_length; ++i)\n//\t\tif ( diff = (int)((UCHAR)aBuf1[i] - (UCHAR)aBuf2[i]) ) // Use unsigned chars like strcmp().\n//\t\t\treturn diff;\n//\treturn (int)(aLength1 - aLength2);\n//}\n\n\n\nint tcslicmp(LPTSTR aBuf1, LPTSTR aBuf2, size_t aLength1, size_t aLength2)\n// Similar to strnicmp but considers each aBuf to be a string of length aLength if aLength was\n// specified. In other words, unlike strnicmp() which would consider strnicmp(\"ab\", \"abc\", 2)\n// [example verified correct] to be a match, this function would consider them to be\n// a mismatch. Another way of looking at it: aBuf1 and aBuf2 will be directly\n// compared to one another as though they were actually of length aLength1 and\n// aLength2, respectively and then passed to stricmp() (not strnicmp) as those\n// shorter strings. This behavior is useful for cases where you don't want\n// to have to bother with temporarily terminating a string so you can compare\n// only a substring to something else. The return value meaning is the\n// same as strnicmp(). If either aLength param is UINT_MAX (via the default\n// parameters or via explicit call), it will be assumed that the entire\n// length of the respective aBuf will be used.\n{\n\tif (!aBuf1 || !aBuf2) return 0;\n\tif (aLength1 == -1) aLength1 = _tcslen(aBuf1);\n\tif (aLength2 == -1) aLength2 = _tcslen(aBuf2);\n\tsize_t least_length = aLength1 < aLength2 ? aLength1 : aLength2;\n\tint diff;\n\tfor (size_t i = 0; i < least_length; ++i)\n\t\tif ( diff = (int)(ctoupper(aBuf1[i]) - ctoupper(aBuf2[i])) )\n\t\t\treturn diff;\n\t// Since the above didn't return, the strings are equal if they're the same length.\n\t// Otherwise, the longer one is considered greater than the shorter one since the\n\t// longer one's next character is by definition something non-zero. I'm not completely\n\t// sure that this is the same policy followed by ANSI strcmp():\n\treturn (int)(aLength1 - aLength2);\n}\n\n\n\nLPTSTR tcsrstr(LPTSTR aStr, size_t aStr_length, LPCTSTR aPattern, StringCaseSenseType aStringCaseSense, int aOccurrence)\n// Returns NULL if not found, otherwise the address of the found string.\n// This could probably use a faster algorithm someday. For now it seems adequate because\n// scripts rarely use it and when they do, it's usually on short haystack strings (such as\n// to find the last period in a filename).\n{\n\tif (aOccurrence < 1)\n\t\treturn NULL;\n\tif (!*aPattern)\n\t\t// The empty string is found in every string, and since we're searching from the right, return\n\t\t// the position of the zero terminator to indicate the situation:\n\t\treturn aStr + aStr_length;\n\n\tsize_t aPattern_length = _tcslen(aPattern);\n\tTCHAR aPattern_last_char = aPattern[aPattern_length - 1];\n\tTCHAR aPattern_last_char_lower = (aStringCaseSense == SCS_INSENSITIVE_LOCALE)\n\t\t? (TCHAR)ltolower(aPattern_last_char)\n\t\t: ctolower(aPattern_last_char);\n\n\tint occurrence = 0;\n\tLPCTSTR match_starting_pos = aStr + aStr_length - 1;\n\n\t// Keep finding matches from the right until the Nth occurrence (specified by the caller) is found.\n\tfor (;;)\n\t{\n\t\tif (match_starting_pos < aStr)\n\t\t\treturn NULL; // No further matches are possible.\n\t\t// Find (from the right) the first occurrence of aPattern's last char:\n\t\tLPCTSTR last_char_match;\n\t\tfor (last_char_match = match_starting_pos; last_char_match >= aStr; --last_char_match)\n\t\t{\n\t\t\tif (aStringCaseSense == SCS_INSENSITIVE) // The most common mode is listed first for performance.\n\t\t\t{\n\t\t\t\tif (ctolower(*last_char_match) == aPattern_last_char_lower)\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t\telse if (aStringCaseSense == SCS_INSENSITIVE_LOCALE)\n\t\t\t{\n\t\t\t\tif (ltolower(*last_char_match) == aPattern_last_char_lower)\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t\telse // Case sensitive.\n\t\t\t{\n\t\t\t\tif (*last_char_match == aPattern_last_char)\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t\tif (last_char_match < aStr) // No further matches are possible.\n\t\t\treturn NULL;\n\n\t\t// Now that aPattern's last character has been found in aStr, ensure the rest of aPattern\n\t\t// exists in aStr to the left of last_char_match:\n\t\tLPCTSTR full_match, cp;\n\t\tbool found;\n\t\tfor (found = false, cp = aPattern + aPattern_length - 2, full_match = last_char_match - 1;; --cp, --full_match)\n\t\t{\n\t\t\tif (cp < aPattern) // The complete pattern has been found at the position in full_match + 1.\n\t\t\t{\n\t\t\t\t++full_match; // Adjust for the prior iteration's decrement.\n\t\t\t\tif (++occurrence == aOccurrence)\n\t\t\t\t\treturn (LPTSTR) full_match;\n\t\t\t\tfound = true;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (full_match < aStr) // Only after checking the above is this checked.\n\t\t\t\tbreak;\n\n\t\t\tif (aStringCaseSense == SCS_INSENSITIVE) // The most common mode is listed first for performance.\n\t\t\t{\n\t\t\t\tif (ctolower(*full_match) != ctolower(*cp))\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t\telse if (aStringCaseSense == SCS_INSENSITIVE_LOCALE)\n\t\t\t{\n\t\t\t\tif (ltolower(*full_match) != ltolower(*cp))\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t\telse // Case sensitive.\n\t\t\t{\n\t\t\t\tif (*full_match != *cp)\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t} // for() innermost\n\t\tif (found) // Although the above found a match, it wasn't the right one, so resume searching.\n\t\t\tmatch_starting_pos = full_match - 1;\n\t\telse // the pattern broke down, so resume searching at THIS position.\n\t\t\tmatch_starting_pos = last_char_match - 1; // Don't go back by more than 1.\n\t} // while() find next match\n}\n\n\n\nLPTSTR tcscasestr(LPCTSTR phaystack, LPCTSTR pneedle)\n\t// To make this work with MS Visual C++, this version uses tolower/toupper() in place of\n\t// _tolower/_toupper(), since apparently in GNU C, the underscore macros are identical\n\t// to the non-underscore versions; but in MS the underscore ones do an unconditional\n\t// conversion (mangling non-alphabetic characters such as the zero terminator). MSDN:\n\t// tolower: Converts c to lowercase if appropriate\n\t// _tolower: Converts c to lowercase\n\n\t// Return the offset of one string within another.\n\t// Copyright (C) 1994,1996,1997,1998,1999,2000 Free Software Foundation, Inc.\n\t// This file is part of the GNU C Library.\n\n\t// The GNU C Library is free software; you can redistribute it and/or\n\t// modify it under the terms of the GNU Lesser General Public\n\t// License as published by the Free Software Foundation; either\n\t// version 2.1 of the License, or (at your option) any later version.\n\n\t// The GNU C Library is distributed in the hope that it will be useful,\n\t// but WITHOUT ANY WARRANTY; without even the implied warranty of\n\t// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n\t// Lesser General Public License for more details.\n\n\t// You should have received a copy of the GNU Lesser General Public\n\t// License along with the GNU C Library; if not, write to the Free\n\t// Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA\n\t// 02111-1307 USA.\n\n\t// My personal strstr() implementation that beats most other algorithms.\n\t// Until someone tells me otherwise, I assume that this is the\n\t// fastest implementation of strstr() in C.\n\t// I deliberately chose not to comment it. You should have at least\n\t// as much fun trying to understand it, as I had to write it :-).\n\t// Stephen R. van den Berg, berg@pool.informatik.rwth-aachen.de\n\n\t// Faster looping by precalculating bl, bu, cl, cu before looping.\n\t// 2004 Apr 08\tJose Da Silva, digital@joescat@com\n{\n\tregister const TBYTE *haystack, *needle;\n\tregister unsigned bl, bu, cl, cu;\n\t\n\thaystack = (const TBYTE *) phaystack;\n\tneedle = (const TBYTE *) pneedle;\n\n\t// Since ctolower returns TCHAR (which is signed in ANSI builds), typecast to\n\t// TBYTE first to promote characters \\x80-\\xFF to unsigned 32-bit correctly:\n\tbl = (TBYTE)ctolower(*needle);\n\tif (bl != '\\0')\n\t{\n\t\t// Scan haystack until the first character of needle is found:\n\t\tbu = (TBYTE)ctoupper(bl);\n\t\thaystack--;\t\t\t\t/* possible ANSI violation */\n\t\tdo\n\t\t{\n\t\t\tcl = *++haystack;\n\t\t\tif (cl == '\\0')\n\t\t\t\tgoto ret0;\n\t\t}\n\t\twhile ((cl != bl) && (cl != bu));\n\n\t\t// See if the rest of needle is a one-for-one match with this part of haystack:\n\t\tcl = (TBYTE)ctolower(*++needle);\n\t\tif (cl == '\\0') // Since needle consists of only one character, it is already a match as found above.\n\t\t\tgoto foundneedle;\n\t\tcu = (TBYTE)ctoupper(cl);\n\t\t++needle;\n\t\tgoto jin;\n\t\t\n\t\tfor (;;)\n\t\t{\n\t\t\tregister unsigned a;\n\t\t\tregister const TBYTE *rhaystack, *rneedle;\n\t\t\tdo\n\t\t\t{\n\t\t\t\ta = *++haystack;\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto ret0;\n\t\t\t\tif ((a == bl) || (a == bu))\n\t\t\t\t\tbreak;\n\t\t\t\ta = *++haystack;\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto ret0;\nshloop:\n\t\t\t\t;\n\t\t\t}\n\t\t\twhile ((a != bl) && (a != bu));\n\njin:\n\t\t\ta = *++haystack;\n\t\t\tif (a == '\\0') // Remaining part of haystack is shorter than needle. No match.\n\t\t\t\tgoto ret0;\n\n\t\t\tif ((a != cl) && (a != cu)) // This promising candidate is not a complete match.\n\t\t\t\tgoto shloop; // Start looking for another match on the first char of needle.\n\t\t\t\n\t\t\trhaystack = haystack-- + 1;\n\t\t\trneedle = needle;\n\t\t\ta = (TBYTE)ctolower(*rneedle);\n\t\t\t\n\t\t\tif ((TBYTE)ctolower(*rhaystack) == (int) a)\n\t\t\tdo\n\t\t\t{\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto foundneedle;\n\t\t\t\t++rhaystack;\n\t\t\t\ta = (TBYTE)ctolower(*++needle);\n\t\t\t\tif ((TBYTE)ctolower(*rhaystack) != (int) a)\n\t\t\t\t\tbreak;\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto foundneedle;\n\t\t\t\t++rhaystack;\n\t\t\t\ta = (TBYTE)ctolower(*++needle);\n\t\t\t}\n\t\t\twhile ((TBYTE)ctolower(*rhaystack) == (int) a);\n\t\t\t\n\t\t\tneedle = rneedle;\t\t/* took the register-poor approach */\n\t\t\t\n\t\t\tif (a == '\\0')\n\t\t\t\tbreak;\n\t\t} // for(;;)\n\t} // if (bl != '\\0')\nfoundneedle:\n\treturn (LPTSTR) haystack;\nret0:\n\treturn 0;\n}\n\n\n\nLPTSTR ltcschr(LPCTSTR haystack, TCHAR ch)\n{\n\tLPCTSTR cp;\n\tUINT lch = ltolower(ch);\n\tfor (cp = haystack;; ++cp)\n\t{\n\t\tif (ltolower(*cp) == lch)\n\t\t\treturn (LPTSTR)cp;\n\t\tif (!*cp) // Implies lch != 0.\n\t\t\treturn NULL;\n\t}\n}\n\n\n\nLPTSTR lstrcasestr(LPCTSTR phaystack, LPCTSTR pneedle)\n// This is the locale-obeying variant of strcasestr. It uses CharUpper/Lower in place of toupper/lower,\n// which sees chars like ä as the same as Ä (depending on code page/locale). This function is about\n// 1 to 8 times slower than strcasestr() depending on factors such as how many partial matches for needle\n// are in haystack.\n// License: GNU GPL\n// Copyright (C) 1994,1996,1997,1998,1999,2000 Free Software Foundation, Inc.\n// See strcasestr() for more comments.\n{\n\tregister const TBYTE *haystack, *needle;\n\tregister unsigned bl, bu, cl, cu;\n\t\n\thaystack = (const TBYTE *) phaystack;\n\tneedle = (const TBYTE *) pneedle;\n\n\tbl = (UINT)ltolower(*needle);\n\tif (bl != 0)\n\t{\n\t\t// Scan haystack until the first character of needle is found:\n\t\tbu = (UINT)(size_t)ltoupper(bl);\n\t\thaystack--;\t\t\t\t/* possible ANSI violation */\n\t\tdo\n\t\t{\n\t\t\tcl = *++haystack;\n\t\t\tif (cl == '\\0')\n\t\t\t\tgoto ret0;\n\t\t}\n\t\twhile ((cl != bl) && (cl != bu));\n\n\t\t// See if the rest of needle is a one-for-one match with this part of haystack:\n\t\tcl = (UINT)ltolower(*++needle);\n\t\tif (cl == '\\0') // Since needle consists of only one character, it is already a match as found above.\n\t\t\tgoto foundneedle;\n\t\tcu = (UINT)ltoupper(cl);\n\t\t++needle;\n\t\tgoto jin;\n\t\t\n\t\tfor (;;)\n\t\t{\n\t\t\tregister unsigned a;\n\t\t\tregister const TBYTE *rhaystack, *rneedle;\n\t\t\tdo\n\t\t\t{\n\t\t\t\ta = *++haystack;\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto ret0;\n\t\t\t\tif ((a == bl) || (a == bu))\n\t\t\t\t\tbreak;\n\t\t\t\ta = *++haystack;\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto ret0;\nshloop:\n\t\t\t\t;\n\t\t\t}\n\t\t\twhile ((a != bl) && (a != bu));\n\njin:\n\t\t\ta = *++haystack;\n\t\t\tif (a == '\\0') // Remaining part of haystack is shorter than needle. No match.\n\t\t\t\tgoto ret0;\n\n\t\t\tif ((a != cl) && (a != cu)) // This promising candidate is not a complete match.\n\t\t\t\tgoto shloop; // Start looking for another match on the first char of needle.\n\t\t\t\n\t\t\trhaystack = haystack-- + 1;\n\t\t\trneedle = needle;\n\t\t\ta = (UINT)ltolower(*rneedle);\n\t\t\t\n\t\t\tif ((UINT)ltolower(*rhaystack) == a)\n\t\t\tdo\n\t\t\t{\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto foundneedle;\n\t\t\t\t++rhaystack;\n\t\t\t\ta = (UINT)ltolower(*++needle);\n\t\t\t\tif ((UINT)ltolower(*rhaystack) != a)\n\t\t\t\t\tbreak;\n\t\t\t\tif (a == '\\0')\n\t\t\t\t\tgoto foundneedle;\n\t\t\t\t++rhaystack;\n\t\t\t\ta = (UINT)ltolower(*++needle);\n\t\t\t}\n\t\t\twhile ((UINT)ltolower(*rhaystack) == a);\n\t\t\t\n\t\t\tneedle = rneedle;\t\t/* took the register-poor approach */\n\t\t\t\n\t\t\tif (a == '\\0')\n\t\t\t\tbreak;\n\t\t} // for(;;)\n\t} // if (bl != '\\0')\nfoundneedle:\n\treturn (LPTSTR) haystack;\nret0:\n\treturn 0;\n}\n\n\n\ntemplate<typename T> T digitsTo(LPCTSTR p, LPCTSTR &end)\n{\n\tT i = 0;\n\tfor (;; ++p)\n\t{\n\t\tint c = *p;\n\t\tif (c <= '9' && c >= '0')\n\t\t\tc -= '0';\n\t\telse\n\t\t\tbreak;\n\t\ti = i * 10 + c;\n\t}\n\tend = p;\n\treturn i;\n}\n\n\ntemplate<typename T> T xdigitsTo(LPCTSTR p, LPCTSTR &end)\n{\n\tT i = 0;\n\tfor (;; ++p)\n\t{\n\t\tint c = *p;\n\t\tif (c <= '9' && c >= '0')\n\t\t\tc -= '0';\n\t\telse if (c <= 'F' && c >= 'A')\n\t\t\tc -= 'A' - 10;\n\t\telse if (c <= 'f' && c >= 'a')\n\t\t\tc -= 'a' - 10;\n\t\telse\n\t\t\tbreak;\n\t\ti = i * 16 + c;\n\t}\n\tend = p;\n\treturn i;\n}\n\n\n// istrtoi64(): like _tcstoi64, but allows wrapping overflow consistent with\n// arithmetic expressions. Some behaviour may be unlike _tcstoi64/strtoll:\n// - Decimal and hexadecimal are always supported; caller cannot specify base.\n// - A leading '0' does not activate base 8, since we specifically don't want that.\n// - Only space and tab are considered whitespace, consistent with IsNumeric().\n// - errno is never set.\n__int64 istrtoi64(LPCTSTR buf, LPCTSTR *endptr)\n{\n\t// unsigned vs. signed is unlikely to matter in practice, but only unsigned has\n\t// well-defined behaviour regarding overflow (that is, it wraps but technically\n\t// never \"overflows\" according to the standard).\n\tUINT64 i;\n\n\t// Skip spaces and tabs.\n\tLPCTSTR p = omit_leading_whitespace(buf);\n\t\n\t// Determine/skip sign.\n\tbool negative = *p == '-';\n\tif (negative || *p == '+')\n\t\t++p;\n\n\tLPCTSTR end;\n\tif (IS_HEX(p))\n\t{\n\t\tp += 2;\n\t\ti = xdigitsTo<UINT64>(p, end);\n\t}\n\telse\n\t{\n\t\ti = digitsTo<UINT64>(p, end);\n\t}\n\tif (endptr)\n\t\t*endptr = p == end ? buf : end; // Don't consider \" -\" or \"-0x\" numeric on its own.\n\t// Casting out of range unsigned to signed has \"implementation defined\" behaviour;\n\t// Microsoft's implementation does not change the bit pattern.\n\treturn negative ? -(__int64)i : (__int64)i;\n}\n\n\n// nstrtoi64(): like istrtoi64, but permits scientific notation (including a decimal\n// fraction, which may be significant in combination with the exponent).\n// This function is mostly identical to istrtoi64, so comments there also apply here.\n// Attempts to merge the two functions resulted in 300-1000 bytes larger code size due\n// to inlining, how heavily these are used, and the fact that omitted parameters are\n// actually still passed by the compiler.\n__int64 nstrtoi64(LPCTSTR buf)\n{\n\tUINT64 i;\n\n\tLPCTSTR p = omit_leading_whitespace(buf);\n\n\tbool negative = *p == '-';\n\tif (negative || *p == '+')\n\t\t++p;\n\n\tif (IS_HEX(p))\n\t{\n\t\tp += 2;\n\t\ti = xdigitsTo<UINT64>(p, p);\n\t}\n\telse // Decimal.\n\t{\n\t\ti = digitsTo<UINT64>(p, p);\n\n\t\t// Check for a decimal fraction/exponent:\n\t\tLPCTSTR end_int = p;\n\t\tif (*p == '.')\n\t\t{\n\t\t\tdo ++p;\n\t\t\twhile (*p <= '9' && *p >= '0');\n\t\t}\n\t\tLPCTSTR end_fraction = p;\n\t\tif (*p == 'e' || *p == 'E')\n\t\t{\n\t\t\t++p;\n\t\t\tbool exp_negative = *p == '-';\n\t\t\tif (exp_negative || *p == '+')\n\t\t\t\t++p;\n\t\t\tUINT64 exp = digitsTo<UINT64>(p, p); // UINT64 vs. char does not affect code size; using UINT64 ensures that unreasonably large exponents produce a consistent result.\n\t\t\tif (p > end_fraction + 1) // Exponent present.\n\t\t\t{\n\t\t\t\tif (!exp_negative && *end_int == '.')\n\t\t\t\t{\n\t\t\t\t\t// Parse additional digits while simultaneously applying part of the exponentiation.\n\t\t\t\t\tfor (p = end_int + 1; p < end_fraction && exp; ++p, --exp) // Scan from '.' to 'e'\n\t\t\t\t\t\ti = i * 10 + (*p - '0');\n\t\t\t\t}\n\t\t\t\tif (exp >= (exp_negative ? 20 : 64)) // Avoid unnecessary looping for abnormally large exponents.\n\t\t\t\t{\n\t\t\t\t\t// For n * 10**64, the low 64 bits of the result are always 0. \n\t\t\t\t\t// For n / 10**20, the result is always 0 since 10**20 > _UI16_MAX > n.\n\t\t\t\t\ti = 0;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// This section multiplies or divides i by a power of 10 without resorting to\n\t\t\t\t\t// floating-point operations. Overflow of the result is allowed and will wrap,\n\t\t\t\t\t// but to get the correct result we must not wrap the multiplier.\n\t\t\t\t\twhile (exp >= 20) // Implies !exp_negative. 10**20 won't fit in multiplier.\n\t\t\t\t\t{\n\t\t\t\t\t\ti *= 10000000000000000000ui64;\n\t\t\t\t\t\texp -= 19;\n\t\t\t\t\t}\n\t\t\t\t\tif (exp != 0) // An exponent of 0 is valid but does not alter the result.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Perform exponentiation by squaring.\n\t\t\t\t\t\tUINT64 multiplier = 1;\n\t\t\t\t\t\tUINT64 bs = 10;\n\t\t\t\t\t\twhile (exp > 1)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (exp & 1) multiplier *= bs;\n\t\t\t\t\t\t\texp >>= 1;\n\t\t\t\t\t\t\tbs *= bs;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tmultiplier *= bs;\n\t\t\t\t\t\tif (exp_negative)\n\t\t\t\t\t\t\ti /= multiplier;\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\ti *= multiplier;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn negative ? -(__int64)i : (__int64)i;\n}\n\n\n\nUINT StrReplace(LPTSTR aHaystack, LPTSTR aOld, LPTSTR aNew, StringCaseSenseType aStringCaseSense\n\t, UINT aLimit, size_t aSizeLimit, LPTSTR *aDest, size_t *aHaystackLength)\n// Replaces all (or aLimit) occurrences of aOld with aNew in aHaystack.\n// On success, it returns the number of replacements done (0 if none). On failure (out of memory), it returns 0\n// (and if aDest isn't NULL, it also sets *aDest to NULL on failure).\n//\n// PARAMETERS:\n// - aLimit: Specify UINT_MAX to have no restriction on the number of replacements. Otherwise, specify a number >=0.\n// - aSizeLimit: Specify -1 to assume that aHaystack has enough capacity for any mode #1 replacement. Otherwise,\n// specify the size limit (in either mode 1 or 2), but it must be >= length of aHaystack (simplifies the code).\n// - aDest: If NULL, the function will operate in mode #1. Otherwise, it uses mode #2 (see further below).\n// - aHaystackLength: If it isn't NULL, *aHaystackLength must be the length of aHaystack. HOWEVER, *aHaystackLength\n// is then changed here to be the length of the result string so that caller can use it to improve performance.\n//\n// MODE 1 (when aDest==NULL): aHaystack is used as both the source and the destination (sometimes temporary memory\n// is used for performance, but it's freed afterward and so transparent to the caller).\n// When it passes in -1 for aSizeLimit (the default), caller must ensure that aHaystack has enough capacity to hold\n// the new/replaced result. When non-NULL, aSizeLimit will be enforced by limiting the number of replacements to\n// the available memory (i.e. any remaining replacements are simply not done and that part of haystack is unaltered).\n//\n// MODE 2 (when aDest!=NULL): If zero replacements are needed, we set *aDest to be aHaystack to indicate that no\n// new memory was allocated. Otherwise, we store in *aDest the address of the new memory that holds the result.\n// - The caller is responsible for any new memory in *aDest (freeing it, etc.)\n// - The initial value of *aDest doesn't matter.\n// - The contents of aHaystack isn't altered, not even if aOld_length==aNew_length (some callers rely on this).\n//\n// v1.0.45: This function was heavily revised to improve performance and flexibility. It has also made\n// two other/related StrReplace() functions obsolete. Also, the code has been simplified to avoid doing\n// a first pass through haystack to find out exactly how many replacements there are because that step\n// nearly doubles the time required for the entire operation (in most cases). Its benefit was mainly in\n// memory savings and avoidance of any reallocs since the initial alloc was always exactly right; however,\n// testing shows that one or two reallocs are generally much quicker than doing the size-calculation phase\n// because extra alloc'ing & memcpy'ing is much faster than an extra search through haystack for all the matches.\n// Furthermore, the new approach minimizes reallocs by using smart prediction. Furthermore, the caller shrinks\n// the result memory via _expand() to avoid having too much extra/overhang. These optimizations seem to make\n// the new approach better than the old one in every way, but especially performance.\n{\n\t#define REPLACEMENT_MODE2 aDest // For readability.\n\n\t// THINGS TO SET NOW IN CASE OF EARLY RETURN OR GOTO:\n\t// Set up the input/output lengths:\n\tsize_t haystack_length = aHaystackLength ? *aHaystackLength : _tcslen(aHaystack); // For performance, use caller's length if it was provided.\n\tsize_t length_temp; // Just a placeholder/memory location used by the alias below.\n\tsize_t &result_length = aHaystackLength ? *aHaystackLength : length_temp; // Make an alias for convenience and maintainability (if this is an output parameter for our caller, this step takes care that in advance).\n\t// Set up the output buffer:\n\tLPTSTR result_temp; // In mode #1, holds temporary memory that is freed before we return.\n\tLPTSTR &result = aDest ? *aDest : result_temp; // Make an alias for convenience and maintainability (if aDest is non-NULL, it's an output parameter for our caller, and this step takes care that in advance).\n\tresult = NULL; // It's allocated only upon first use to avoid a potentially massive allocation that might\n\tresult_length = 0; // be wasted and cause swapping (not to mention that we'll have better ability to estimate the correct total size after the first replacement is discovered).\n\tsize_t result_size = 0;\n\t// Variables used by both replacement methods.\n\tLPTSTR src, match_pos;\n\t// END OF INITIAL SETUP.\n\n\t// From now on, result_length and result should be kept up-to-date because they may have been set up\n\t// as output parameters above.\n\n\tif (!(*aHaystack && *aOld))\n\t{\n\t\t// Nothing to do if aHaystack is blank. If aOld is blank, that is not supported because it would be an\n\t\t// infinite loop. This policy is now largely due to backward compatibility because some other policy\n\t\t// may have been better.\n\t\tresult = aHaystack; // Return unaltered string to caller in its output parameter (result is an alias for *aDest).\n\t\tresult_length = haystack_length; // This is an alias for an output parameter, so update it for caller.\n\t\treturn 0; // Report \"no replacements\".\n\t}\n\n\tsize_t aOld_length = _tcslen(aOld);\n\tsize_t aNew_length = _tcslen(aNew);\n\tint length_delta = (int)(aNew_length - aOld_length); // Cast to int to avoid loss of unsigned. A negative delta means the replacement substring is smaller than what it's replacing.\n\n\tif (aSizeLimit != -1) // Caller provided a size *restriction*, so if necessary reduce aLimit to stay within bounds. Compare directly to -1 due to unsigned.\n\t{\n\t\tint extra_room = (int)(aSizeLimit-1 - haystack_length); // Cast to int to preserve negatives.\n\t\tif (extra_room < 0) // Caller isn't supposed to call it this way. To avoid having to complicate the\n\t\t\taLimit = 0; // calculations in the else-if below, allow no replacements in this case.\n\t\telse if (length_delta > 0) // New-str is bigger than old-str. This is checked to avoid going negative or dividing by 0 below. A positive delta means length of new/replacement string is greater than that of what it's replacing.\n\t\t{\n\t\t\tUINT upper_limit = (UINT)(extra_room / length_delta);\n\t\t\tif (aLimit > upper_limit)\n\t\t\t\taLimit = upper_limit;\n\t\t}\n\t\t//else length_delta <= 0, so there no overflow should be possible. Leave aLimit as-is.\n\t}\n\n\tif (!REPLACEMENT_MODE2) // Mode #1\n\t{\n\t\tif (!length_delta // old_len==new_len, so use in-place method because it's just as fast in this case but it avoids the extra memory allocation.\n\t\t\t|| haystack_length < 5000) // ...or the in-place method will likely be faster, and an earlier stage has ensured there's no risk of overflow.\n\t\t\tgoto in_place_method; // \"Goto\" to avoid annoying indentation and long IF-blocks.\n\t\t//else continue on because the extra-memory method will usually perform better than the in-place method.\n\t\t// The extra-memory method is much faster than the in-place method when many replacements are needed because\n\t\t// it avoids a memmove() to shift the remainder of the buffer up against the area of memory that\n\t\t// will be replaced (which for the in-place method is done for every replacement). The savings\n\t\t// can be enormous if aSource is very large, assuming the system can allocate the memory without swapping.\n\t}\n\t// Otherwise:\n\t// Since above didn't jump to the in place method, either the extra-memory method is preferred or this is mode #2.\n\t// Never use the in-place method for mode #2 because caller always wants a separate memory area used (for its\n\t// purposes, the extra-memory method is probably just as fast or faster than in-place method).\n\n\t// Below uses a temp var. because realloc() returns NULL on failure but leaves original block allocated.\n\t// Note that if it's given a NULL pointer, realloc() does a malloc() instead.\n\tLPTSTR realloc_temp;\n\t#define STRREPLACE_REALLOC(size) \\\n\t{\\\n\t\tresult_size = size;\\\n\t\tif ( !(realloc_temp = trealloc(result, result_size)) )\\\n\t\t\tgoto out_of_mem;\\\n\t\tresult = realloc_temp;\\\n\t}\n\n\t// Other variables used by the replacement loop:\n\tsize_t haystack_portion_length, new_result_length;\n\tUINT replacement_count;\n\n\t// Perform the replacement:\n\tfor (replacement_count = 0, src = aHaystack\n\t\t; aLimit && (match_pos = tcsstr2(src, aOld, aStringCaseSense));) // Relies on short-circuit boolean order.\n\t{\n\t\t++replacement_count;\n\t\t--aLimit;\n\t\thaystack_portion_length = match_pos - src; // The length of the haystack section between the end of the previous match and the start of the current one.\n\n\t\t// Using the required length calculated below, expand/realloc \"result\" if necessary.\n\t\tnew_result_length = result_length + haystack_portion_length + aNew_length;\n\t\tif (new_result_length >= result_size) // Uses >= to allow room for terminator.\n\t\t\tSTRREPLACE_REALLOC(PredictReplacementSize(length_delta, replacement_count, aLimit, (int)haystack_length\n\t\t\t\t, (int)new_result_length, (int)(match_pos - aHaystack))); // This will return if an alloc error occurs.\n\n\t\t// Now that we know \"result\" has enough capacity, put the new text into it. The first step\n\t\t// is to copy over the part of haystack that appears before the match.\n\t\tif (haystack_portion_length)\n\t\t{\n\t\t\ttmemcpy(result + result_length, src, haystack_portion_length);\n\t\t\tresult_length += haystack_portion_length;\n\t\t}\n\t\t// Now append the replacement string in place of the old string.\n\t\tif (aNew_length)\n\t\t{\n\t\t\ttmemcpy(result + result_length, aNew, aNew_length);\n\t\t\tresult_length += aNew_length;\n\t\t}\n\t\t//else omit it altogether; i.e. replace every aOld with the empty string.\n\n\t\t// Set up src to be the position where the next iteration will start searching. For consistency with\n\t\t// the in-place method, overlapping matches are not detected. For example, the replacement\n\t\t// of all occurrences of \"..\" with \". .\" in \"...\" would produce \". ..\", not \". . .\":\n\t\tsrc = match_pos + aOld_length; // This has two purposes: 1) Since match_pos is about to be altered by strstr, src serves as a placeholder for use by the next iteration; 2) it's also used further below.\n\t}\n\n\tif (!replacement_count) // No replacements were done, so optimize by keeping the original (avoids a malloc+memcpy).\n\t{\n\t\t// The following steps are appropriate for both mode #1 and #2 (for simplicity and maintainability,\n\t\t// they're all done unconditionally even though mode #1 might not require them all).\n\t\tresult = aHaystack; // Return unaltered string to caller in its output parameter (result is an alias for *aDest).\n\t\tresult_length = haystack_length; // This is an alias for an output parameter, so update it for caller.\n\t\treturn replacement_count;\n\t\t// Since no memory was allocated, there's never anything to free.\n\t}\n\t// (Below relies only above having returned when no replacements because it assumes result!=NULL from now on.)\n\n\t// Otherwise, copy the remaining characters after the last replacement (if any) (fixed for v1.0.25.11).\n\tif (haystack_portion_length = haystack_length - (src - aHaystack)) // This is the remaining part of haystack that need to be copied over as-is.\n\t{\n\t\tnew_result_length = result_length + haystack_portion_length;\n\t\tif (new_result_length >= result_size) // Uses >= to allow room for terminator.\n\t\t\tSTRREPLACE_REALLOC(new_result_length + 1); // This will return if an alloc error occurs.\n\t\ttmemcpy(result + result_length, src, haystack_portion_length); // memcpy() usually benches a little faster than strcpy().\n\t\tresult_length = new_result_length; // Remember that result_length is actually an output for our caller, so even if for no other reason, it must be kept accurate for that.\n\t}\n\tresult[result_length] = '\\0'; // Must terminate it unconditionally because other sections usually don't do it.\n\n\tif (!REPLACEMENT_MODE2) // Mode #1.\n\t{\n\t\t// Since caller didn't provide destination memory, copy the result from our temporary memory (that was used\n\t\t// for performance) back into the caller's original buf (which has already been confirmed to be large enough).\n\t\ttmemcpy(aHaystack, result, result_length + 1); // Include the zero terminator.\n\t\tfree(result); // Free the temp. mem that was used for performance.\n\t}\n\treturn replacement_count; // The output parameters have already been populated properly above.\n\nout_of_mem: // This can only happen with the extra-memory method above (which due to its nature can't fall back to the in-place method).\n\tif (result)\n\t{\n\t\tfree(result); // Must be freed in mode #1. In mode #2, it's probably a non-terminated string (not to mention being an incomplete result), so if it ever isn't freed, it should be terminated.\n\t\tresult = NULL; // Indicate failure by setting output param for our caller (this also indicates that the memory was freed).\n\t}\n\tresult_length = 0; // Output parameter for caller, though upon failure it shouldn't matter (just for robustness).\n\treturn 0;\n\nin_place_method:\n\t// This method is available only to mode #1. It should help performance for short strings such as those from\n\t// ExpandExpression().\n\t// This in-place method is used when the extra-memory method wouldn't be faster enough to be worth its cost\n\t// for the particular strings involved here.\n\t//\n\t// Older comment:\n\t// The below doesn't quite work when doing a simple replacement such as \"..\" with \". .\".\n\t// In the above example, \"...\" would be changed to \". ..\" rather than \". . .\" as it should be.\n\t// Therefore, use a less efficient, but more accurate method instead. UPDATE: But this method\n\t// can cause an infinite loop if the new string is a superset of the old string, so don't use\n\t// it after all.\n\t//for ( ; ptr = StrReplace(aHaystack, aOld, aNew, aStringCaseSense); ); // Note that this very different from the below.\n\n\tfor (replacement_count = 0, src = aHaystack\n\t\t; aLimit && (match_pos = tcsstr2(src, aOld, aStringCaseSense)) // Relies on short-circuit boolean order.\n\t\t; --aLimit, ++replacement_count)\n\t{\n\t\tsrc = match_pos + aNew_length; // The next search should start at this position when all is adjusted below.\n\t\tif (length_delta) // This check can greatly improve performance if old and new strings happen to be same length.\n\t\t{\n\t\t\t// Since new string can't fit exactly in place of old string, adjust the target area to\n\t\t\t// accept exactly the right length so that the rest of the string stays unaltered:\n\t\t\ttmemmove(src, match_pos + aOld_length\n\t\t\t\t, (haystack_length - (match_pos - aHaystack)) - aOld_length + 1); // +1 to include zero terminator.\n\t\t\t// Above: Calculating length vs. using strlen() makes overall speed of the operation about\n\t\t\t// twice as fast for some typical test cases in a 2 MB buffer such as replacing \\r\\n with \\n.\n\t\t}\n\t\ttmemcpy(match_pos, aNew, aNew_length); // Perform the replacement.\n\t\t// Must keep haystack_length updated as we go, for use with memmove() above:\n\t\thaystack_length += length_delta; // Note that length_delta will be negative if aNew is shorter than aOld.\n\t}\n\n\tresult_length = haystack_length; // Set for caller (it's an alias for an output parameter).\n\tresult = aHaystack; // Not actually needed in this method, so this is just for maintainability.\n\treturn replacement_count;\n}\n\n\n\nsize_t PredictReplacementSize(ptrdiff_t aLengthDelta, int aReplacementCount, int aLimit, size_t aHaystackLength\n\t, size_t aCurrentLength, size_t aEndOffsetOfCurrMatch)\n// Predict how much size the remainder of a replacement operation will consume, including its actual replacements\n// and the parts of haystack that won't need replacement.\n// PARAMETERS:\n// - aLengthDelta: The estimated or actual difference between the length of the replacement and what it's replacing.\n// A negative number means the replacement is smaller, which will cause a shrinking of the result.\n// - aReplacementCount: The number of replacements so far, including the one the caller is about to do.\n// - aLimit: The *remaining* number of replacements *allowed* (not including the one the caller is about to do).\n// - aHaystackLength: The total length of the original haystack/subject string.\n// - aCurrentLength: The total length of the new/result string including the one the caller is about to do.\n// - aEndOffsetOfCurrMatch: The offset of the char after the last char of the current match. For example, if\n// the empty string is the current match and it's found at the beginning of haystack, this value would be 0.\n{\n\t// Since realloc() is an expensive operation, especially for huge strings, make an extra\n\t// effort to get a good estimate based on how things have been going so far.\n\t// While this should definitely improve average-case memory-utilization and usually performance\n\t// (by avoiding costly realloc's), this estimate is crude because:\n\t// 1) The length of what is being replaced can vary due to wildcards in pattern, etc.\n\t// 2) The length of what is replacing it can vary due to backreferences. Thus, the delta\n\t// of each replacement is only a guess based on that of the current replacement.\n\t// 3) For code simplicity, the number of upcoming replacements isn't yet known; thus a guess\n\t// is made based on how many there have been so far compared to percentage complete.\n\n\tINT_PTR total_delta; // The total increase/decrease in length from the number of predicted additional replacements.\n\tint repl_multiplier = aLengthDelta < 0 ? -1 : 1; // Negative is used to keep additional_replacements_expected conservative even when delta is negative.\n\n\tif (aLengthDelta == 0) // Avoid all the calculations because it will wind up being zero anyway.\n\t\ttotal_delta = 0;\n\telse\n\t{\n\t\tif (!aHaystackLength // aHaystackLength can be 0 if an empty haystack being replaced by something else. If so, avoid divide-by-zero in the prediction by doing something simpler.\n\t\t\t|| !aEndOffsetOfCurrMatch) // i.e. don't the prediction if the current match is the empty string and it was found at the very beginning of Haystack because it would be difficult to be accurate (very rare anyway).\n\t\t\ttotal_delta = repl_multiplier * aLengthDelta; // Due to rarity, just allow room for one extra after the one we're about to do.\n\t\telse // So the above has ensured that the following won't divide by zero anywhere.\n\t\t{\n\t\t\t// The following doesn't take into account the original value of aStartingOffset passed in\n\t\t\t// from the caller because:\n\t\t\t// 1) It's pretty rare for it to be greater than 0.\n\t\t\t// 2) Even if it is, the prediction will just be too conservative at first, but that's\n\t\t\t// pretty harmless; and anyway each successive realloc followed by a match makes the\n\t\t\t// prediction more and more accurate in spite of aStartingOffset>0.\n\t\t\t// percent_complete must be a double because we need at least 9 digits of precision for cases where\n\t\t\t// 1 is divided by a big number like 1 GB.\n\t\t\tdouble percent_complete = aEndOffsetOfCurrMatch // Don't subtract 1 (verified correct).\n\t\t\t\t/ (double)aHaystackLength; // percent_complete isn't actually a percentage, but a fraction of 1. e.g. 0.5 rather than 50.\n\t\t\tint additional_replacements_expected = percent_complete >= 1.0 ? 0 // It's often 100% complete, in which case there's hardly ever another replacement after this one (the only possibility is to replace the final empty-string in haystack with something).\n\t\t\t\t: (int)(\n\t\t\t\t(aReplacementCount / percent_complete) // This is basically \"replacements per percentage point, so far\".\n\t\t\t\t* (1 - percent_complete) // This is the percentage of haystack remaining to be scanned (e.g. 0.5 for 50%).\n\t\t\t\t+ 1 * repl_multiplier // Add 1 or -1 to make it more conservative (i.e. go the opposite direction of ceil when repl_multiplier is negative).\n\t\t\t\t);\n\t\t\t// additional_replacements_expected is defined as the replacements expected *after* the one the caller\n\t\t\t// is about to do.\n\n\t\t\tif (aLimit >= 0 && aLimit < additional_replacements_expected)\n\t\t\t{\t// A limit is currently in effect and it's less than expected replacements, so cap the expected.\n\t\t\t\t// This helps reduce memory utilization.\n\t\t\t\tadditional_replacements_expected = aLimit;\n\t\t\t}\n\t\t\telse // No limit or additional_replacements_expected is within the limit.\n\t\t\t{\n\t\t\t\t// So now things are set up so that there's about a 50/50 chance than no more reallocs\n\t\t\t\t// will be needed. Since realloc is costly (due to internal memcpy), try to reduce\n\t\t\t\t// the odds of it happening without going overboard on memory utilization.\n\t\t\t\t// Something a lot more complicated could be used in place of the below to improve things\n\t\t\t\t// a little, but it just doesn't seem worth it given the usage patterns expected and\n\t\t\t\t// the actual benefits. Besides, there is some limiting logic further below that will\n\t\t\t\t// cap this if it's unreasonably large:\n\t\t\t\tadditional_replacements_expected += (int)(0.20*additional_replacements_expected + 1) // +1 so that there's always at least one extra.\n\t\t\t\t\t* repl_multiplier; // This keeps the estimate conservative if delta < 0.\n\t\t\t}\n\t\t\t// The following is the \"quality\" of the estimate. For example, if this is the very first replacement\n\t\t\t// and 1000 more replacements are predicted, there will often be far fewer than 1000 replacements;\n\t\t\t// in fact, there could well be zero. So in the below, the quality will range from 1 to 3, where\n\t\t\t// 1 is the worst quality and 3 is the best.\n\t\t\tdouble quality = 1 + 2*(1-(\n\t\t\t\t(double)additional_replacements_expected / (aReplacementCount + additional_replacements_expected)\n\t\t\t\t));\n\t\t\t// It seems best to use whichever of the following is greater in the calculation further below:\n\t\t\tINT_PTR haystack_or_new_length = (aCurrentLength > aHaystackLength) ? aCurrentLength : aHaystackLength;\n\t\t\t// The following is a crude sanity limit to avoid going overboard with memory\n\t\t\t// utilization in extreme cases such as when a big string has many replacements\n\t\t\t// in its first half, but hardly any in its second. It does the following:\n\t\t\t// 1) When Haystack-or-current length is huge, this tries to keep the portion of the memory increase\n\t\t\t// that's speculative proportionate to that length, which should reduce the chance of swapping\n\t\t\t// (at the expense of some performance in cases where it causes another realloc to be required).\n\t\t\t// 2) When Haystack-or-current length is relatively small, allow the speculative memory allocation\n\t\t\t// to be many times larger than that length because the risk of swapping is low. HOWEVER, TO\n\t\t\t// AVOID WASTING MEMORY, the caller should probably call _expand() to shrink the result\n\t\t\t// when it detects that far fewer replacements were needed than predicted (this is currently\n\t\t\t// done by Var::AcceptNewMem()).\n\t\t\tINT_PTR total_delta_limit = (INT_PTR)(haystack_or_new_length < 10*1024*1024 ? quality*10*1024*1024\n\t\t\t\t: quality*haystack_or_new_length); // See comment above.\n\t\t\ttotal_delta = additional_replacements_expected\n\t\t\t\t* (aLengthDelta < 0 ? -aLengthDelta : aLengthDelta); // So actually, total_delta will be the absolute value.\n\t\t\tif (total_delta > total_delta_limit)\n\t\t\t\ttotal_delta = total_delta_limit;\n\t\t\ttotal_delta *= repl_multiplier; // Convert back from absolute value.\n\t\t} // The current match isn't an empty string at the very beginning of haystack.\n\t} // aLengthDelta!=0\n\n\t// Above is responsible for having set total_delta properly.\n\tINT_PTR subsequent_length = aHaystackLength - aEndOffsetOfCurrMatch // This is the length of the remaining portion of haystack that might wind up going into the result exactly as-is (adjusted by the below).\n\t\t+ total_delta; // This is additional_replacements_expected times the expected delta (the length of each replacement minus what it replaces) [can be negative].\n\tif (subsequent_length < 0) // Must not go below zero because that would cause the next line to\n\t\tsubsequent_length = 0; // create an increase that's too small to handle the current replacement.\n\n\t// Return the sum of the following:\n\t// 1) subsequent_length: The predicted length needed for the remainder of the operation.\n\t// 2) aCurrentLength: The amount we need now, which includes room for the replacement the caller is about to do.\n\t// Note that aCurrentLength can be 0 (such as for an empty string replacement).\n\treturn subsequent_length + aCurrentLength + 1; // Caller relies on +1 for the terminator.\n}\n\n\n\nLPTSTR TranslateLFtoCRLF(LPCTSTR aString)\n// Can't use StrReplace() for this because any CRLFs originally present in aString are not changed (i.e. they\n// don't become CRCRLF) [there may be other reasons].\n// Translates any naked LFs in aString to CRLF. If there are none, the original string is returned.\n// Otherwise, the translated version is copied into a malloc'd buffer, which the caller must free\n// when it's done with it). \n{\n\tUINT naked_LF_count = 0;\n\tsize_t length = 0;\n\n\tfor (auto cp = aString; *cp; ++cp)\n\t{\n\t\t++length;\n\t\tif (*cp == '\\n' && (cp == aString || cp[-1] != '\\r')) // Relies on short-circuit boolean order.\n\t\t\t++naked_LF_count;\n\t}\n\n\tif (!naked_LF_count)\n\t\treturn const_cast<LPTSTR>(aString);\n\n\t// Allocate the new memory that will become the caller's responsibility:\n\tLPTSTR buf = tmalloc(length + naked_LF_count + 1); // +1 for zero terminator.\n\tif (!buf)\n\t\treturn nullptr;\n\n\t// Now perform the translation.\n\tLPTSTR dp = buf; // Destination.\n\tfor (auto cp = aString; *cp; ++cp)\n\t{\n\t\tif (*cp == '\\n' && (cp == aString || cp[-1] != '\\r')) // Relies on short-circuit boolean order.\n\t\t\t*dp++ = '\\r'; // Insert an extra CR here, then insert the '\\n' normally below.\n\t\t*dp++ = *cp;\n\t}\n\t*dp = '\\0'; // Final terminator.\n\n\treturn buf; // Caller must free it when it's done with it.\n}\n\n\n\nbool DoesFilePatternExist(LPCTSTR aFilePattern, DWORD *aFileAttr, DWORD aRequiredAttr)\n// Returns true if the file/folder exists or false otherwise.\n// If non-NULL, aFileAttr's DWORD is set to the attributes of the file/folder if a match is found.\n// If there is no match, its contents are undefined.\n{\n\tif (!aFilePattern || !*aFilePattern) return false;\n\t// Fix for v1.0.35.12: Don't consider the question mark in \"\\\\?\\Volume{GUID}\\\" to be a wildcard.\n\t// Such volume names are obtained from GetVolumeNameForVolumeMountPoint() and perhaps other functions.\n\t// However, testing shows that wildcards beyond that first one should be seen as real wildcards\n\t// because the wildcard match-method below does work for such volume names.\n\tauto cp = _tcsncmp(aFilePattern, _T(\"\\\\\\\\?\\\\\"), 4) ? aFilePattern : aFilePattern + 4;\n\tif (StrChrAny(cp, _T(\"?*\")))\n\t{\n\t\tWIN32_FIND_DATA wfd;\n\t\tHANDLE hFile = FindFirstFile(aFilePattern, &wfd);\n\t\tif (hFile == INVALID_HANDLE_VALUE)\n\t\t\treturn false;\n\t\t// Skip . and .., which appear to always be listed first (for dir\\* and dir\\*.*).\n\t\twhile (wfd.cFileName[0] == '.' && (!wfd.cFileName[1] || wfd.cFileName[1] == '.' && !wfd.cFileName[2]))\n\t\t\tif (!FindNextFile(hFile, &wfd))\n\t\t\t{\n\t\t\t\tFindClose(hFile);\n\t\t\t\treturn false;\n\t\t\t}\n\t\tif (aRequiredAttr) // Caller wants to check for a file/folder with specific attributes.\n\t\t{\n\t\t\twhile ((wfd.dwFileAttributes & aRequiredAttr) != aRequiredAttr)\n\t\t\t\tif (!FindNextFile(hFile, &wfd))\n\t\t\t\t{\n\t\t\t\t\tFindClose(hFile);\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t// Since above didn't return, a file/folder with the required attribute was found.\n\t\t}\n\t\tFindClose(hFile);\n\t\tif (aFileAttr)\n\t\t\t*aFileAttr = wfd.dwFileAttributes;\n\t\treturn true;\n\t}\n else\n\t{\n\t\tDWORD attr = GetFileAttributes(aFilePattern);\n\t\tif (aRequiredAttr && (attr & aRequiredAttr) != aRequiredAttr)\n\t\t\treturn false;\n\t\tif (aFileAttr)\n\t\t\t*aFileAttr = attr;\n\t\treturn attr != 0xFFFFFFFF;\n\t}\n}\n\n\n\nLPTSTR ConvertFilespecToCorrectCase(LPTSTR aFilespec, LPTSTR aBuf, size_t aBufSize, size_t &aBufLength)\n// Convert aFilespec to proper case and put the result into aBuf.\n// aFilespec and aBuf must not overlap.\n// aFilespec should be modifiable, but on return always has its original value.\n// aBufSize is the size of aBuf in WCHARs, including space for the null-terminator;\n// it should be large enough to allow expansion of short (8.3) names to long names.\n// If the final path would exceed aBufSize or if the conversion could not be completed,\n// returns NULL and leaves aBufLength unchanged; otherwise returns aBuf and sets\n// aBufLength to its length.\n// Note: GetFullPathName() doesn't perform case-correction, only string manipulation.\n// GetLongPathName() skips name components which are not 8.3-compliant.\n{\n\tASSERT(aBufSize > 3);\n\tASSERT(aFilespec != aBuf);\n\tif (!*aFilespec)\n\t\treturn NULL;\n\tLPTSTR dir_start, dir_end;\n\tsize_t built_length;\n\t// Start with something easy, the drive letter:\n\tif (aFilespec[1] == ':' && aFilespec[2] == '\\\\')\n\t{\n\t\taBuf[0] = ctoupper(aFilespec[0]);\n\t\taBuf[1] = ':';\n\t\taBuf[2] = '\\\\';\n\t\t// MSDN: \"An attempt to open a search with a trailing backslash will always fail.\"\n\t\tdir_start = aFilespec + 3; // Skip over the first backslash that goes with the drive letter.\n\t\tbuilt_length = 3;\n\t}\n\telse // it's probably a UNC\n\t{\n\t\tif (_tcsncmp(aFilespec, _T(\"\\\\\\\\\"), 2))\n\t\t\t// It doesn't appear to be a UNC either, so not sure how to deal with it.\n\t\t\treturn NULL;\n\t\t// I think MS says you can't use FindFirstFile() directly on a share name, so we\n\t\t// want to omit both that and the server name from consideration (i.e. we don't attempt\n\t\t// to find their proper case). MSDN: \"Similarly, on network shares, you can use an\n\t\t// lpFileName of the form \"\\\\server\\service\\*\" but you cannot use an lpFileName that\n\t\t// points to the share itself, such as \"\\\\server\\service\".\n\t\tdir_start = aFilespec + 2;\n\t\tLPTSTR end_of_server_name = _tcschr(dir_start, '\\\\');\n\t\tif (end_of_server_name)\n\t\t{\n\t\t\tdir_start = end_of_server_name + 1;\n\t\t\tLPTSTR end_of_share_name = _tcschr(dir_start, '\\\\');\n\t\t\tif (end_of_share_name)\n\t\t\t\tdir_start = end_of_share_name + 1;\n\t\t}\n\t\tbuilt_length = dir_start - aFilespec;\n\t\tif (built_length >= aBufSize) // Too long.\n\t\t\treturn NULL;\n\t\ttmemcpy(aBuf, aFilespec, built_length);\n\t}\n\tWIN32_FIND_DATA found_file;\n\tsize_t found_length;\n\tHANDLE file_search;\n\tfor ( ; dir_end = _tcschr(dir_start, '\\\\'); dir_start = dir_end + 1)\n\t{\n\t\t*dir_end = '\\0'; // Temporarily terminate.\n\t\tfile_search = FindFirstFile(aFilespec, &found_file);\n\t\t*dir_end = '\\\\'; // Restore it before we do anything else.\n\t\tif (file_search == INVALID_HANDLE_VALUE)\n\t\t\treturn NULL;\n\t\tFindClose(file_search);\n\t\t// Append the case-corrected version of this directory name:\n\t\tfound_length = _tcslen(found_file.cFileName);\n\t\tif (built_length + found_length + 1 > aBufSize) // Too long (+1 for the slash).\n\t\t\treturn NULL;\n\t\ttmemcpy(aBuf + built_length, found_file.cFileName, found_length);\n\t\tbuilt_length += found_length;\n\t\taBuf[built_length++] = '\\\\';\n\t}\n\tif (*dir_start) // Not a path ending in '\\\\'.\n\t{\n\t\t// Now do the filename itself:\n\t\tif ( (file_search = FindFirstFile(aFilespec, &found_file)) == INVALID_HANDLE_VALUE )\n\t\t\treturn NULL;\n\t\tFindClose(file_search);\n\t\tfound_length = _tcslen(found_file.cFileName);\n\t\tif (built_length + found_length > aBufSize) // Too long.\n\t\t\treturn NULL;\n\t\ttmemcpy(aBuf + built_length, found_file.cFileName, found_length);\n\t\tbuilt_length += found_length;\n\t}\n\taBuf[built_length] = '\\0';\n\taBufLength = built_length;\n\treturn aBuf;\n}\n\n\n\nvoid ConvertFilespecToCorrectCase(LPTSTR aBuf, size_t aBufSize, size_t &aBufLength)\n{\n\tTCHAR built_filespec[T_MAX_PATH];\n\tif (aBufSize > _countof(built_filespec))\n\t\taBufSize = _countof(built_filespec);\n\tif (ConvertFilespecToCorrectCase(aBuf, built_filespec, aBufSize, aBufLength))\n\t\ttmemcpy(aBuf, built_filespec, aBufLength + 1);\n}\n\n\n\nLPTSTR FileAttribToStr(LPTSTR aBuf, DWORD aAttr)\n// Caller must ensure that aAttr is valid (i.e. that it's not 0xFFFFFFFF).\n{\n\tif (!aBuf) return aBuf;\n\tint length = 0;\n\tif (aAttr & FILE_ATTRIBUTE_READONLY)\n\t\taBuf[length++] = 'R';\n\tif (aAttr & FILE_ATTRIBUTE_ARCHIVE)\n\t\taBuf[length++] = 'A';\n\tif (aAttr & FILE_ATTRIBUTE_SYSTEM)\n\t\taBuf[length++] = 'S';\n\tif (aAttr & FILE_ATTRIBUTE_HIDDEN)\n\t\taBuf[length++] = 'H';\n\tif (aAttr & FILE_ATTRIBUTE_NORMAL)\n\t\taBuf[length++] = 'N';\n\tif (aAttr & FILE_ATTRIBUTE_DIRECTORY)\n\t\taBuf[length++] = 'D';\n\tif (aAttr & FILE_ATTRIBUTE_OFFLINE)\n\t\taBuf[length++] = 'O';\n\tif (aAttr & FILE_ATTRIBUTE_COMPRESSED)\n\t\taBuf[length++] = 'C';\n\tif (aAttr & FILE_ATTRIBUTE_TEMPORARY)\n\t\taBuf[length++] = 'T';\n\tif (aAttr & FILE_ATTRIBUTE_REPARSE_POINT)\n\t\taBuf[length++] = 'L';\n\taBuf[length] = '\\0'; // Perform the final termination.\n\treturn aBuf;\n}\n\n\n\nunsigned __int64 GetFileSize64(HANDLE aFileHandle)\n// Returns ULLONG_MAX on failure. Otherwise, it returns the actual file size.\n{\n ULARGE_INTEGER ui = {0};\n ui.LowPart = GetFileSize(aFileHandle, &ui.HighPart);\n if (ui.LowPart == MAXDWORD && GetLastError() != NO_ERROR)\n return ULLONG_MAX;\n return (unsigned __int64)ui.QuadPart;\n}\n\n\n\nLPTSTR GetWin32ErrorText(LPTSTR aBuf, DWORD aBufSize, DWORD aError)\n// aBufSize is an int to preserve any negative values the caller might pass in.\n{\n\tif (aBufSize < 1)\n\t\treturn aBuf;\n\tif (aBufSize == 1)\n\t{\n\t\t*aBuf = '\\0';\n\t\treturn aBuf;\n\t}\n\tFormatMessage(FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_IGNORE_INSERTS // Ignore inserts: https://blogs.msdn.microsoft.com/oldnewthing/20071128-00/?p=24353\n\t\t, NULL, aError, 0, aBuf, (DWORD)aBufSize - 1, NULL);\n\treturn aBuf;\n}\n\n\n\nvoid AssignColor(LPTSTR aColorName, COLORREF &aColor, HBRUSH &aBrush)\n// Assign the color indicated in aColorName (either a name or a hex RGB value) to both\n// aColor and aBrush, deleting any prior handle in aBrush first. If the color cannot\n// be determined, it will always be set to CLR_DEFAULT (and aBrush set to NULL to match).\n// It will never be set to CLR_NONE.\n{\n\tCOLORREF color = 0;\n\tColorToBGR(aColorName, color);\n\tAssignColor(color, aColor, aBrush);\n}\n\n\n\nvoid AssignColor(COLORREF color, COLORREF &aColor, HBRUSH &aBrush)\n{\n\tif (color != aColor) // It's not already the right color.\n\t{\n\t\taColor = color; // Set default. v1.0.44.09: Added this line to fix the inability to change to a previously selected color after having changed to the default color.\n\t\tif (aBrush) // Free the resources of the old brush.\n\t\t\tDeleteObject(aBrush);\n\t\tif (color == CLR_DEFAULT) // Caller doesn't need brush for CLR_DEFAULT, assuming that's even possible.\n\t\t\taBrush = NULL;\n\t\telse\n\t\t\tif ( !(aBrush = CreateSolidBrush(color)) ) // Failure should be very rare.\n\t\t\t\taColor = CLR_DEFAULT; // A NULL HBRUSH should always corresponds to CLR_DEFAULT.\n\t}\n}\n\n\n\nbool ColorToBGR(LPCTSTR aColorNameOrRGB, COLORREF &aBGR)\n{\n\tif (!*aColorNameOrRGB)\n\t\taBGR = CLR_DEFAULT;\n\telse\n\t{\n\t\taBGR = ColorNameToBGR(aColorNameOrRGB);\n\t\tif (aBGR == CLR_NONE) // A matching color name was not found, so assume it's a hex color value.\n\t\t{\n\t\t\twchar_t *endptr;\n\t\t\t// It seems _tcstol() automatically handles the optional leading \"0x\" if present:\n\t\t\taBGR = rgb_to_bgr(_tcstol(aColorNameOrRGB, &endptr, 16));\n\t\t\t// If the leading part of aColorNameOrRGB was not hex-numeric, black (0x00) will be assumed.\n\t\t\t// The return value will indicate whether the value was entirely a valid hex number.\n\t\t\treturn !*endptr;\n\t\t}\n\t}\n\treturn true;\n}\n\n\n\nCOLORREF ColorNameToBGR(LPCTSTR aColorName)\n// These are the main HTML color names. Returns CLR_NONE if a matching HTML color name can't be found.\n// Returns CLR_DEFAULT only if aColorName is the word Default.\n{\n\tif (!aColorName || !*aColorName) return CLR_NONE;\n\tif (!_tcsicmp(aColorName, _T(\"Black\"))) return 0x000000; // These colors are all in BGR format, not RGB.\n\tif (!_tcsicmp(aColorName, _T(\"Silver\"))) return 0xC0C0C0;\n\tif (!_tcsicmp(aColorName, _T(\"Gray\"))) return 0x808080;\n\tif (!_tcsicmp(aColorName, _T(\"White\"))) return 0xFFFFFF;\n\tif (!_tcsicmp(aColorName, _T(\"Maroon\"))) return 0x000080;\n\tif (!_tcsicmp(aColorName, _T(\"Red\"))) return 0x0000FF;\n\tif (!_tcsicmp(aColorName, _T(\"Purple\"))) return 0x800080;\n\tif (!_tcsicmp(aColorName, _T(\"Fuchsia\")))return 0xFF00FF;\n\tif (!_tcsicmp(aColorName, _T(\"Green\"))) return 0x008000;\n\tif (!_tcsicmp(aColorName, _T(\"Lime\"))) return 0x00FF00;\n\tif (!_tcsicmp(aColorName, _T(\"Olive\"))) return 0x008080;\n\tif (!_tcsicmp(aColorName, _T(\"Yellow\"))) return 0x00FFFF;\n\tif (!_tcsicmp(aColorName, _T(\"Navy\"))) return 0x800000;\n\tif (!_tcsicmp(aColorName, _T(\"Blue\"))) return 0xFF0000;\n\tif (!_tcsicmp(aColorName, _T(\"Teal\"))) return 0x808000;\n\tif (!_tcsicmp(aColorName, _T(\"Aqua\"))) return 0xFFFF00;\n\tif (!_tcsicmp(aColorName, _T(\"Default\")))return CLR_DEFAULT;\n\treturn CLR_NONE;\n}\n\n\n\nPOINT CenterWindow(int aWidth, int aHeight)\n// Given a the window's width and height, calculates where to position its upper-left corner\n// so that it is centered EVEN IF the task bar is on the left side or top side of the window.\n// This does not currently handle multi-monitor systems explicitly, since those calculations\n// require API functions that don't exist in Win95/NT (and thus would have to be loaded\n// dynamically to allow the program to launch). Therefore, windows will likely wind up\n// being centered across the total dimensions of all monitors, which usually results in\n// half being on one monitor and half in the other. This doesn't seem too terrible and\n// might even be what the user wants in some cases (i.e. for really big windows).\n{\n\tRECT rect;\n\tSystemParametersInfo(SPI_GETWORKAREA, 0, &rect, 0); // Get desktop rect excluding task bar.\n\t// Note that rect.left will NOT be zero if the taskbar is on docked on the left.\n\t// Similarly, rect.top will NOT be zero if the taskbar is on docked at the top of the screen.\n\tPOINT pt;\n\tpt.x = rect.left + (((rect.right - rect.left) - aWidth) / 2);\n\tpt.y = rect.top + (((rect.bottom - rect.top) - aHeight) / 2);\n\treturn pt;\n}\n\n\n\nbool FontExist(HDC aHdc, LPCTSTR aTypeface)\n{\n\tLOGFONT lf;\n\tlf.lfCharSet = DEFAULT_CHARSET; // Enumerate all char sets.\n\tlf.lfPitchAndFamily = 0; // Must be zero.\n\ttcslcpy(lf.lfFaceName, aTypeface, LF_FACESIZE);\n\tbool font_exists = false;\n\tEnumFontFamiliesEx(aHdc, &lf, (FONTENUMPROC)FontEnumProc, (LPARAM)&font_exists, 0);\n\treturn font_exists;\n}\n\n\n\nint CALLBACK FontEnumProc(ENUMLOGFONTEX *lpelfe, NEWTEXTMETRICEX *lpntme, DWORD FontType, LPARAM lParam)\n{\n\t*(bool *)lParam = true; // Indicate to the caller that the font exists.\n\treturn 0; // Stop the enumeration after the first, since even one match means the font exists.\n}\n\n\n\nvoid ScreenToWindow(POINT &aPoint, HWND aHwnd)\n// Convert screen coordinates to window coordinates (i.e. relative to the window's upper-left corner).\n{\n\tRECT rect;\n\tGetWindowRect(aHwnd, &rect);\n\taPoint.x -= rect.left;\n\taPoint.y -= rect.top;\n}\n\n\n\nvoid CoordToScreen(int &aX, int &aY, int aWhichMode)\n// aX and aY are interpreted according to the current coord mode. If necessary, they are converted to\n// screen coordinates based on the position of the active window's upper-left corner (or its client area).\n{\n\tint coord_mode = ((g->CoordMode >> aWhichMode) & COORD_MODE_MASK);\n\n\tif (coord_mode == COORD_MODE_SCREEN)\n\t\treturn;\n\n\tHWND active_window = GetForegroundWindow();\n\tif (active_window && !IsIconic(active_window))\n\t{\n\t\tif (coord_mode == COORD_MODE_WINDOW)\n\t\t{\n\t\t\tRECT rect;\n\t\t\tif (GetWindowRect(active_window, &rect))\n\t\t\t{\n\t\t\t\taX += rect.left;\n\t\t\t\taY += rect.top;\n\t\t\t}\n\t\t}\n\t\telse // (coord_mode == COORD_MODE_CLIENT)\n\t\t{\n\t\t\tPOINT pt = {0};\n\t\t\tif (ClientToScreen(active_window, &pt))\n\t\t\t{\n\t\t\t\taX += pt.x;\n\t\t\t\taY += pt.y;\n\t\t\t}\n\t\t}\n\t}\n\t//else no active window per se, so don't convert the coordinates. Leave them as-is as desired\n\t// by the caller. More details:\n\t// Revert to screen coordinates if the foreground window is minimized. Although it might be\n\t// impossible for a visible window to be both foreground and minimized, it seems that hidden\n\t// windows -- such as the script's own main window when activated for the purpose of showing\n\t// a popup menu -- can be foreground while simultaneously being minimized. This fixes an\n\t// issue where the mouse will move to the upper-left corner of the screen rather than the\n\t// intended coordinates (v1.0.17).\n}\n\n\n\nvoid CoordToScreen(POINT &aPoint, int aWhichMode)\n// For convenience. See function above for comments.\n{\n\tCoordToScreen((int &)aPoint.x, (int &)aPoint.y, aWhichMode);\n}\n\n\n\nDWORD GetEnvVarReliable(LPCTSTR aEnvVarName, LPTSTR aBuf)\n// Returns the length of what has been copied into aBuf, not including the null terminator.\n// Caller has ensured that aBuf is large enough (though anything >=32767 is always large enough).\n// This function was added in v1.0.46.08 to fix a long-standing bug that was more fully revealed\n// by 1.0.46.07's reduction of DEREF_BUF_EXPAND_INCREMENT from 32 to 16K (which allowed the Win9x\n// version of GetEnvironmentVariable() to detect that we were lying about the buffer being 32767\n// in size). The reason for lying is that we don't know exactly how big the buffer is, but we do\n// know it's large enough. So we just pass 32767 in an attempt to make it always succeed\n// (mostly because GetEnvironmentVariable() is such a slow call, so it's best to avoid calling it\n// a second time just to get the length).\n// UPDATE: This is now called for all versions of Windows to avoid any chance of crashing or misbehavior,\n// which tends to happen whenever lying to the API (even if it's for a good cause). See similar problems\n// at ReadRegString(). See other comments below.\n{\n\t// Windows 9x is apparently capable of detecting a lie about the buffer size.\n\t// For example, if the memory capacity is only 16K but we pass 32767, it sometimes/always detects that\n\t// and returns 0, even if the string being retrieved is short enough (which it is because the caller\n\t// already verified it). To work around this, give it a genuinely large buffer with an accurate size,\n\t// then copy the result out into the caller's variable. This is almost certainly much faster than\n\t// doing a second call to GetEnvironmentVariable() to get the length because GetEnv() is known to be a\n\t// very slow call.\n\t//\n\t// Don't use a size greater than 32767 because that will cause it to fail on Win95 (tested by Robert Yalkin).\n\t// According to MSDN, 32767 is exactly large enough to handle the largest variable plus its zero terminator.\n\t// Update in 2022: Testing on Windows 11 showed the actual limit to be much higher, perhaps only bounded by\n\t// available memory. Since this function is only used by A_ComSpec and the deprecated auto-env retrieval\n\t// mechanism (and due to rarity of need), no attempt is made to support larger variables.\n\tTCHAR buf[32767];\n\tDWORD length = GetEnvironmentVariable(aEnvVarName, buf, _countof(buf));\n\t// GetEnvironmentVariable() could be called twice, the first time to get the actual size. But that would\n\t// probably perform worse since GetEnvironmentVariable() is a very slow function. In addition, it would\n\t// add code complexity, so it seems best to fetch it into a large buffer then just copy it to dest-var.\n\tif (length && (size_t) length + 1 <= _countof(buf))\n\t\ttmemcpy(aBuf, buf, (size_t) length + 1); // memcpy() usually benches a little faster than strcpy().\n\telse // Failure. The buffer's contents might be undefined in this case.\n\t\t*aBuf = '\\0'; // Caller's buf should always have room for an empty string. So make it empty for maintainability, even if not strictly required by caller.\n\treturn length;\n}\n\n\n\nDWORD ReadRegString(HKEY aRootKey, LPTSTR aSubkey, LPTSTR aValueName, LPTSTR aBuf, DWORD aBufSize, DWORD aFlag)\n// Returns the length of the string (0 if empty).\n// Caller must ensure that size of aBuf is REALLY aBufSize (even when it knows aBufSize is more than\n// it needs) because the API apparently reads/writes parts of the buffer beyond the string it writes!\n// Caller must ensure that aBuf isn't NULL because it doesn't seem worth having a \"give me the size only\" mode.\n// This is because the API might return a size that omits the zero terminator, and the only way to find out for\n// sure is probably to actually fetch the data and check if the terminator is present.\n{\n\tHKEY hkey;\n\tif (RegOpenKeyEx(aRootKey, aSubkey, 0, KEY_QUERY_VALUE | aFlag, &hkey) != ERROR_SUCCESS)\n\t{\n\t\t*aBuf = '\\0';\n\t\treturn 0;\n\t}\n\tDWORD buf_size = aBufSize * sizeof(TCHAR); // Caller's value might be a constant memory area, so need a modifiable copy.\n\tLONG result = RegQueryValueEx(hkey, aValueName, NULL, NULL, (LPBYTE)aBuf, &buf_size);\n\tRegCloseKey(hkey);\n\tif (result != ERROR_SUCCESS || !buf_size) // Relies on short-circuit boolean order.\n\t{\n\t\t*aBuf = '\\0'; // MSDN says the contents of the buffer is undefined after the call in some cases, so reset it.\n\t\treturn 0;\n\t}\n\tbuf_size /= sizeof(TCHAR); // RegQueryValueEx returns size in bytes.\n\t// Otherwise success and non-empty result. This also means that buf_size is accurate and <= to what we sent in.\n\t// Fix for v1.0.47: ENSURE PROPER STRING TERMINATION. This is suspected to be a source of crashing.\n\t// MSDN: \"If the data has the REG_SZ, REG_MULTI_SZ or REG_EXPAND_SZ type, the string may not have been\n\t// stored with the proper null-terminating characters. Therefore, even if the function returns\n\t// ERROR_SUCCESS, the application should ensure that the string is properly terminated before using\n\t// it; otherwise, it may overwrite a buffer. (Note that REG_MULTI_SZ strings should have two\n\t// null-terminating characters.)\"\n\t// MSDN: \"If the data has the REG_SZ, REG_MULTI_SZ or REG_EXPAND_SZ type, this size includes any\n\t// terminating null character or characters.\"\n\t--buf_size; // Convert to the index of the last character written. This is safe because above already checked that buf_size>0.\n\tif (aBuf[buf_size] == '\\0') // It wrote at least one zero terminator (it might write more than one for Unicode, or if it's simply stored with more than one in the registry).\n\t{\n\t\twhile (buf_size && !aBuf[buf_size - 1]) // Scan leftward in case more than one consecutive terminator.\n\t\t\t--buf_size;\n\t\treturn buf_size; // There's a tiny chance that this could the wrong length, namely when the string contains binary zero(s) to the left of non-zero characters. But that seems too rare to be worth calling strlen() for.\n\t}\n\t// Otherwise, it didn't write a terminator, so provide one.\n\t++buf_size; // To reflect the fact that we're about to write an extra char.\n\tif (buf_size >= aBufSize) // There's no room for a terminator without truncating the data (very rare). Seems best to indicate failure.\n\t{\n\t\t*aBuf = '\\0';\n\t\treturn 0;\n\t}\n\t// Otherwise, there's room for the terminator.\n\taBuf[buf_size] = '\\0';\n\treturn buf_size; // There's a tiny chance that this could the wrong length, namely when the string contains binary zero(s) to the left of non-zero characters. But that seems too rare to be worth calling strlen() for.\n}\n\n\n\nBOOL IsProcess64Bit(HANDLE aHandle)\n{\n\tBOOL is32on64;\n#ifdef _WIN64\n\t// No need to load the function dynamically in this case since it should exist on all OSes\n\t// which are able to load 64-bit executables (such as ours):\n\tif (IsWow64Process(aHandle, &is32on64))\n\t\treturn !is32on64; // 64-bit if not running under WOW64.\n\t// Since above didn't return, an error occurred. MSDN isn't clear about what conditions can\n\t// cause this, so for simplicity just assume the target process is 64-bit (like this one).\n\treturn TRUE;\n#else\n\tif (IsWow64Process(GetCurrentProcess(), &is32on64))\n\t{\n\t\tif (is32on64)\n\t\t{\n\t\t\t// We're running under WOW64. Since WOW64 only exists on 64-bit systems and on such systems\n\t\t\t// 32-bit processes can run ONLY under WOW64, if the target process is also running under\n\t\t\t// WOW64 it must be 32-bit; otherwise it must be 64-bit.\n\t\t\tif (IsWow64Process(aHandle, &is32on64))\n\t\t\t\treturn !is32on64;\n\t\t}\n\t}\n\t// Since above didn't return, one of the following is true:\n\t// a) IsWow64Process failed on the first or second call. MSDN isn't clear about what conditions\n\t// can cause this, so for simplicity just assume the target process is 32-bit (like this one).\n\t// b) The current process is not running under WOW64. Since we know it is 32-bit (due to our use\n\t// of conditional compilation), the OS and all running processes must be 32-bit.\n\treturn FALSE;\n#endif\n}\n\nBOOL IsOS64Bit()\n{\n#ifdef _WIN64\n\t// OS must be 64-bit to run this program.\n\treturn TRUE;\n#else\n\t// If OS is 64-bit, this program must be running in WOW64.\n\tBOOL is32on64;\n\tif (IsWow64Process(GetCurrentProcess(), &is32on64))\n\t\treturn is32on64;\n\treturn FALSE;\n#endif\n}\n\n\n\nLPVOID AllocInterProcMem(HANDLE &aHandle, DWORD aSize, HWND aHwnd, DWORD aExtraAccess)\n// aHandle is an output parameter that receives the process handle.\n// Returns NULL on failure (in which case caller should ignore the value of aHandle).\n{\n\tLPVOID mem;\n\tDWORD pid;\n\tGetWindowThreadProcessId(aHwnd, &pid);\n\t// Even if the PID is our own, open the process anyway to simplify the code. After all, it would be\n\t// pretty silly for a script to access its own ListViews via this method.\n\tif ( !(aHandle = OpenProcess(PROCESS_VM_OPERATION | PROCESS_VM_READ | PROCESS_VM_WRITE | aExtraAccess, FALSE, pid)) )\n\t\treturn NULL;\n\t// Reason for using VirtualAllocEx(): When sending LVITEM structures to a control in a remote process, the\n\t// structure and its pszText buffer must both be memory inside the remote process rather than in our own.\n\tmem = VirtualAllocEx(aHandle, NULL, aSize, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);\n\tif (!mem)\n\t\tCloseHandle(aHandle); // Caller should ignore the value of aHandle when return value is NULL.\n\t//else leave the handle open. It's the caller's responsibility to close it.\n\treturn mem;\n}\n\n\n\nvoid FreeInterProcMem(HANDLE aHandle, LPVOID aMem)\n{\n\tVirtualFreeEx(aHandle, aMem, 0, MEM_RELEASE); // Size 0 is used with MEM_RELEASE.\n\tCloseHandle(aHandle);\n}\n\n\n\n// Returns true if a tooltip created by ToolTip already has the given text.\n// MUST NOT call on Windows XP or earlier, due to limitations of TTM_GETTEXT there.\nbool ToolTipTextEquals(HWND aToolTipHwnd, LPCTSTR aText)\n{\n\tTOOLINFO ti;\n\tti.cbSize = sizeof(ti);\n\tti.hwnd = NULL;\n\tti.uId = 0;\n\tsize_t len = _tcslen(aText);\n\tLPTSTR buf = ti.lpszText = (LPTSTR)_malloca((len + 2) * sizeof(TCHAR));\n\tif (!buf)\n\t\treturn false;\n\tSendMessage(aToolTipHwnd, TTM_GETTEXT, len + 2, (LPARAM)&ti);\n\tbool is_equal = !_tcscmp(aText, buf);\n\t_freea(buf);\n\treturn is_equal;\n}\n\n\n\nint GetSystemTrayIconSize()\n{\n\t// This requires Windows 10, version 1607 or later.\n\tstatic auto GetDpiForWindow = (UINT (WINAPI *)(_In_ HWND hwnd))GetProcAddress(GetModuleHandle(_T(\"user32.dll\")), \"GetDpiForWindow\");\n\t// GetSystemMetrics returns values scaled to our base DPI (g_ScreenDPI).\n\tint cx = GetSystemMetrics(SM_CXSMICON);\n\tif (!GetDpiForWindow)\n\t\treturn cx;\n\t// This should be accurate because the icons are to be displayed in Shell_TrayWnd (which is always\n\t// the taskbar of the primary screen), and GetDpiForWindow uses the DPI awareness of the window.\n\t// This differs from GetDpiForSystem, as it appears the \"system DPI\" is fixed at initial login\n\t// and doesn't change after that. Same for GetDpiForWindow(GetDesktopWindow()).\n\tint dpi = GetDpiForWindow(FindWindow(_T(\"Shell_TrayWnd\"), NULL));\n\treturn MulDiv(cx, dpi, g_ScreenDPI);\n}\n\n\n\nHBITMAP LoadPicture(LPCTSTR aFilespec, int aWidth, int aHeight, int &aImageType, int aIconNumber\n\t, bool aUseGDIPlusIfAvailable, bool *apNoDelete, HMODULE *apModule)\n// Returns NULL on failure.\n// If aIconNumber > 0, an HICON or HCURSOR is returned (both should be interchangeable), never an HBITMAP.\n// However, aIconNumber==1 is treated as a special icon upon which LoadImage is given preference over ExtractIcon\n// for .ico/.cur/.ani files.\n// Otherwise, .ico/.cur/.ani files are normally loaded as HICON (unless aUseGDIPlusIfAvailable is true or\n// something else unusual happened such as file contents not matching file's extension). This is done to preserve\n// any properties that HICONs have but HBITMAPs lack, namely the ability to be animated and perhaps other things.\n//\n// Loads a JPG/GIF/BMP/ICO/etc. and returns an HBITMAP or HICON to the caller (which it may call\n// DeleteObject()/DestroyIcon() upon, though upon program termination all such handles are freed\n// automatically). The image is scaled to the specified width and height. If zero is specified\n// for either, the image's actual size will be used for that dimension. If -1 is specified for one,\n// that dimension will be kept proportional to the other dimension's size so that the original aspect\n// ratio is retained.\n{\n\tHBITMAP hbitmap = NULL;\n\taImageType = -1; // The type of image currently inside hbitmap. Set default value for output parameter as \"unknown\".\n\tif (apNoDelete)\n\t\t*apNoDelete = false; // Set default.\n\n\tif (!*aFilespec) // Allow blank filename to yield NULL bitmap (and currently, some callers do call it this way).\n\t\treturn NULL;\n\t// Lexikos: Negative values now indicate an icon's integer resource ID.\n\t//if (aIconNumber < 0) // Allowed to be called this way by GUI and others (to avoid need for validation of user input there).\n\t//\taIconNumber = 0; // Use the default behavior, which is \"load icon or bitmap, whichever is most appropriate\".\n\n\tbool script_passed_handle = false, script_owns_handle = false;\n\tif ( !_tcsnicmp(aFilespec, _T(\"HICON:\"), 6)\n\t\t|| !_tcsnicmp(aFilespec, _T(\"HBITMAP:\"), 8) )\n\t{\n\t\tif (aFilespec[5] == ':') // hicon:\n\t\t{\n\t\t\taImageType = IMAGE_ICON;\n\t\t\taFilespec += 6;\n\t\t}\n\t\telse\n\t\t{\n\t\t\taImageType = IMAGE_BITMAP;\n\t\t\taFilespec += 8;\n\t\t}\n\t\tscript_passed_handle = true;\n\t\tscript_owns_handle = (*aFilespec == '*'); // The \"don't delete my icon/bitmap\" flag.\n\t\tif (script_owns_handle)\n\t\t{\n\t\t\t++aFilespec;\n\t\t\tif (apNoDelete) // Caller supports conditional delete.\n\t\t\t\t*apNoDelete = true; // May be overridden if a resized copy is created below.\n\t\t}\n\t\thbitmap = (HBITMAP)(UINT_PTR)ATOI64(aFilespec);\n\t\tif (!hbitmap)\n\t\t\treturn NULL;\n\t}\n\n\tauto file_ext = _tcsrchr(aFilespec, '.');\n\tif (file_ext)\n\t\t++file_ext;\n\n\t// v1.0.43.07: If aIconNumber is zero, caller didn't specify whether it wanted an icon or bitmap. Thus,\n\t// there must be some kind of detection for whether ExtractIcon is needed instead of GDIPlus/OleLoadPicture.\n\t// Although this could be done by attempting ExtractIcon only after GDIPlus/OleLoadPicture fails (or by\n\t// somehow checking the internal nature of the file), for performance and code size, it seems best to not\n\t// to incur this extra I/O and instead make only one attempt based on the file's extension.\n\t// Must use ExtractIcon() if either of the following is true:\n\t// 1) Caller gave an icon index of the second or higher icon in the file. Update for v1.0.43.05: There\n\t// doesn't seem to be any reason to allow a caller to explicitly specify ExtractIcon as the method of\n\t// loading the *first* icon from a .ico file since LoadImage is likely always superior. This is\n\t// because unlike ExtractIcon/Ex, LoadImage: 1) Doesn't distort icons, especially 16x16 icons; 2) is\n\t// capable of loading icons other than the first by means of width and height parameters.\n\t// 2) The target file is of type EXE/DLL/ICL/CPL/etc. (LoadImage() is documented not to work on those file types).\n\t// ICL files (v1.0.43.05): Apparently ICL files are an unofficial file format. Someone on the newsgroups\n\t// said that an ICL is an \"ICon Library... a renamed 16-bit Windows .DLL (an NE format executable) which\n\t// typically contains nothing but a resource section. The ICL extension seems to be used by convention.\"\n\t// L17: Support negative numbers to mean resource IDs. These are supported by the resource extraction method directly, and by ExtractIcon if aIconNumber < -1.\n\tbool ExtractIcon_was_used = !hbitmap && (aIconNumber > 1 || aIconNumber < 0 || (file_ext && (\n\t\t !_tcsicmp(file_ext, _T(\"exe\"))\n\t\t|| !_tcsicmp(file_ext, _T(\"dll\"))\n\t\t|| !_tcsicmp(file_ext, _T(\"icl\")) // Icon library: Unofficial dll container, see notes above.\n\t\t|| !_tcsicmp(file_ext, _T(\"cpl\")) // Control panel extension/applet (ExtractIcon is said to work on these).\n\t\t|| !_tcsicmp(file_ext, _T(\"scr\")) // Screen saver (ExtractIcon should work since these are really EXEs).\n\t\t// v1.0.44: Below are now omitted to reduce code size and improve performance. They are still supported\n\t\t// indirectly because ExtractIcon is attempted whenever LoadImage() fails further below.\n\t\t//|| !_tcsicmp(file_ext, _T(\"drv\")) // Driver (ExtractIcon is said to work on these).\n\t\t//|| !_tcsicmp(file_ext, _T(\"ocx\")) // OLE/ActiveX Control Extension\n\t\t//|| !_tcsicmp(file_ext, _T(\"vbx\")) // Visual Basic Extension\n\t\t//|| !_tcsicmp(file_ext, _T(\"acm\")) // Audio Compression Manager Driver\n\t\t//|| !_tcsicmp(file_ext, _T(\"bpl\")) // Delphi Library (like a DLL?)\n\t\t// Not supported due to rarity, code size, performance, and uncertainty of whether ExtractIcon works on them.\n\t\t// Update for v1.0.44: The following are now supported indirectly because ExtractIcon is attempted whenever\n\t\t// LoadImage() fails further below.\n\t\t//|| !_tcsicmp(file_ext, _T(\"nil\")) // Norton Icon Library \n\t\t//|| !_tcsicmp(file_ext, _T(\"wlx\")) // Total/Windows Commander Lister Plug-in\n\t\t//|| !_tcsicmp(file_ext, _T(\"wfx\")) // Total/Windows Commander File System Plug-in\n\t\t//|| !_tcsicmp(file_ext, _T(\"wcx\")) // Total/Windows Commander Plug-in\n\t\t//|| !_tcsicmp(file_ext, _T(\"wdx\")) // Total/Windows Commander Plug-in\n\t\t)));\n\n\tif (ExtractIcon_was_used)\n\t{\n\t\taImageType = IMAGE_ICON;\n\n\t\t// L17: Manually extract the most appropriately sized icon resource for the best results.\n\t\thbitmap = (HBITMAP)ExtractIconFromExecutable(aFilespec, aIconNumber, aWidth, aHeight, apModule);\n\n\t\t// At this time it seems unnecessary to fall back to any of the following methods:\n\t\t/*\n\t\tif (aWidth && aHeight) // Lexikos: Alternate methods that give better results than ExtractIcon.\n\t\t{\n\t\t\tint icon_index = aIconNumber > 0 ? aIconNumber - 1 : aIconNumber < -1 ? aIconNumber : 0;\n\t\t\t// Testing shows ExtractIcon retrieves the first icon in the icon group and resizes it to\n\t\t\t// the system large icon size. In case scripts expect this behaviour, and because it is\n\t\t\t// debatable which size will actually look better when scaled, use ExtractIconEX only if\n\t\t\t// a system size is exactly specified. Callers who specifically want the system small or\n\t\t\t// large icon should call GetSystemMetrics() to get the correct aWidth and aHeight.\n\t\t\t// For convenience and because the system icon sizes are probably always square,\n\t\t\t// assume aWidth == -1 is equivalent to aWidth == aHeight (and vice versa).\n\t\t\tif ((aWidth == GetSystemMetrics(SM_CXSMICON) || aWidth == -1) && (aHeight == GetSystemMetrics(SM_CYSMICON) || aHeight == -1))\n\t\t\t{\n\t\t\t\t// Retrieve icon via phiconSmall.\n\t\t\t\tExtractIconEx(aFilespec, icon_index, NULL, (HICON*)&hbitmap, 1);\n\t\t\t}\n\t\t\telse if ((aWidth == GetSystemMetrics(SM_CXICON) || aWidth == -1) && (aHeight == GetSystemMetrics(SM_CYICON) || aHeight == -1))\n\t\t\t{\n\t\t\t\t// Retrieve icon via phiconLarge.\n\t\t\t\tExtractIconEx(aFilespec, icon_index, (HICON*)&hbitmap, NULL, 1);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tUINT icon_id;\n\t\t\t\t// This is the simplest method of loading an icon of an arbitrary size.\n\t\t\t\t// \"However, this function is deprecated not intended for general use.\"\n\t\t\t\t// It is also not documented to support resource IDs, unlike ExtractIcon and ExtractIconEx.\n\t\t\t\tif (-1 == PrivateExtractIcons(aFilespec, icon_index, aWidth == -1 ? aHeight : aWidth, aHeight == -1 ? aWidth : aHeight, (HICON*)&hbitmap, &icon_id, 1, 0))\n\t\t\t\t\thbitmap = NULL;\n\t\t\t}\n\t\t}\n\t\t// Lexikos: ExtractIcon supports resource IDs by specifying nIconIndex < -1, where Abs(nIconIndex)\n\t\t// is the resource ID. nIconIndex MUST NOT BE -1, which is used to indicate the total number of\n\t\t// icons should be returned. ExtractIconEx could be used to support ID -1, but it has different\n\t\t// behaviour to ExtractIcon, and the method above should work in most instances.\n\t\tif (!hbitmap) // The other methods failed or were not used.\n\t\t\thbitmap = (HBITMAP)ExtractIcon(g_hInstance, aFilespec, aIconNumber > 0 ? aIconNumber - 1 : aIconNumber < -1 ? aIconNumber : 0);\n\t\t// Above: Although it isn't well documented at MSDN, apparently both ExtractIcon() and LoadIcon()\n\t\t// scale the icon to the system's large-icon size (usually 32x32) regardless of the actual size of\n\t\t// the icon inside the file. For this reason, callers should call us in a way that allows us to\n\t\t// give preference to LoadImage() over ExtractIcon() (unless the caller needs to retain backward\n\t\t// compatibility with existing scripts that explicitly specify icon #1 to force the ExtractIcon\n\t\t// method to be used).\n\t\t*/\n\t\tif (hbitmap < (HBITMAP)2) // i.e. it's NULL or 1. Return value of 1 means \"incorrect file type\".\n\t\t\treturn NULL; // v1.0.44: Fixed to return NULL vs. hbitmap, since 1 is an invalid handle (perhaps rare since no known bugs caused by it).\n\t\t//else continue on below so that the icon can be resized to the caller's specified dimensions.\n\t}\n\telse if (file_ext) // Make an initial guess of the type of image if the above didn't already determine the type.\n\t{\n\t\tif (!_tcsicmp(file_ext, _T(\"ico\")))\n\t\t\taImageType = IMAGE_ICON;\n\t\telse if (!_tcsicmp(file_ext, _T(\"cur\")) || !_tcsicmp(file_ext, _T(\"ani\")))\n\t\t\taImageType = IMAGE_CURSOR;\n\t\telse if (!_tcsicmp(file_ext, _T(\"bmp\")))\n\t\t\taImageType = IMAGE_BITMAP;\n\t\t//else for other extensions, leave set to \"unknown\" so that the below knows to use IPic or GDI+ to load it.\n\t}\n\t//else same comment as above.\n\n\tif ((aWidth == -1 || aHeight == -1) && (!aWidth || !aHeight))\n\t\taWidth = aHeight = 0; // i.e. One dimension is zero and the other is -1, which resolves to the same as \"keep original size\".\n\tbool keep_aspect_ratio = (aWidth == -1 || aHeight == -1);\n\n\t// Caller should ensure that aUseGDIPlusIfAvailable==false when aIconNumber > 0, since it makes no sense otherwise.\n\tHINSTANCE hinstGDI = NULL;\n\tif (aUseGDIPlusIfAvailable && !(hinstGDI = LoadLibrary(_T(\"gdiplus\")))) // Relies on short-circuit boolean order for performance.\n\t\taUseGDIPlusIfAvailable = false; // Override any original \"true\" value as a signal for the section below.\n\n\tif (!hbitmap && aImageType > -1 && !aUseGDIPlusIfAvailable)\n\t{\n\t\t// Since image hasn't yet be loaded and since the file type appears to be one supported by\n\t\t// LoadImage() [icon/cursor/bitmap], attempt that first. If it fails, fall back to the other\n\t\t// methods below in case the file's internal contents differ from what the file extension indicates.\n\t\tint desired_width, desired_height;\n\t\tif (keep_aspect_ratio) // Load image at its actual size. It will be rescaled to retain aspect ratio later below.\n\t\t{\n\t\t\tdesired_width = 0;\n\t\t\tdesired_height = 0;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tdesired_width = aWidth;\n\t\t\tdesired_height = aHeight;\n\t\t}\n\t\t// For LoadImage() below:\n\t\t// LR_CREATEDIBSECTION applies only when aImageType == IMAGE_BITMAP, but seems appropriate in that case.\n\t\t// Also, if width and height are non-zero, that will determine which icon of a multi-icon .ico file gets\n\t\t// loaded (though I don't know the exact rules of precedence).\n\t\t// KNOWN LIMITATIONS/BUGS:\n\t\t// LoadImage() fails when requesting a size of 1x1 for an image whose orig/actual size is small (e.g. 1x2).\n\t\t// Unlike CopyImage(), perhaps it detects that division by zero would occur and refuses to do the\n\t\t// calculation rather than providing more code to do a correct calculation that doesn't divide by zero.\n\t\t// For example:\n\t\t// LoadImage() Success:\n\t\t// Gui, Add, Pic, h2 w2, bitmap 1x2.bmp\n\t\t// Gui, Add, Pic, h1 w1, bitmap 4x6.bmp\n\t\t// LoadImage() Failure:\n\t\t// Gui, Add, Pic, h1 w1, bitmap 1x2.bmp\n\t\t// LoadImage() also fails on:\n\t\t// Gui, Add, Pic, h1, bitmap 1x2.bmp\n\t\t// And then it falls back to GDIplus, which in the particular case above appears to traumatize the\n\t\t// parent window (or its picture control), because the GUI window hangs (but not the script) after\n\t\t// doing a FileSelect. For example:\n\t\t// Gui, Add, Button,, FileSelect\n\t\t// Gui, Add, Pic, h1, bitmap 1x2.bmp ; Causes GUI window to hang after FileSelect (due to LoadImage failing then falling back to GDIplus; i.e. GDIplus is somehow triggering the problem).\n\t\t// Gui, Show\n\t\t// return\n\t\t// ButtonFileSelect:\n\t\t// FileSelect, outputvar\n\t\t// return\n\t\tif (hbitmap = (HBITMAP)LoadImage(NULL, aFilespec, aImageType, desired_width, desired_height\n\t\t\t, LR_LOADFROMFILE | LR_CREATEDIBSECTION))\n\t\t{\n\t\t\t// The above might have loaded an HICON vs. an HBITMAP (it has been confirmed that LoadImage()\n\t\t\t// will return an HICON vs. HBITMAP is aImageType is IMAGE_ICON/CURSOR). Note that HICON and\n\t\t\t// HCURSOR are identical for most/all Windows API uses. Also note that LoadImage() will load\n\t\t\t// an icon as a bitmap if the file contains an icon but IMAGE_BITMAP was passed in (at least\n\t\t\t// on Windows XP).\n\t\t\tif (!keep_aspect_ratio && !aIconNumber) // No further resizing or conversion is needed.\n\t\t\t\treturn hbitmap;\n\t\t\t// Otherwise, continue on so that the image can be resized via a second call to LoadImage().\n\t\t}\n\t\t// v1.0.40.10: Abort if file doesn't exist so that GDIPlus isn't even attempted. This is done because\n\t\t// loading GDIPlus apparently disrupts the color palette of certain games, at least old ones that use\n\t\t// DirectDraw in 256-color depth.\n\t\telse if (GetFileAttributes(aFilespec) == 0xFFFFFFFF) // For simplicity, we don't check if it's a directory vs. file, since that should be too rare.\n\t\t\treturn NULL;\n\t\telse if (aIconNumber > 0)\n\t\t{\n\t\t\t// UPDATE for v1.0.44: Attempt ExtractIcon in case its some extension that's\n\t\t\t// was recognized as an icon container (such as AutoHotkeySC.bin) and thus wasn't handled higher above.\n\t\t\t//hbitmap = (HBITMAP)ExtractIcon(g_hInstance, aFilespec, aIconNumber - 1);\n\n\t\t\t// L17: Manually extract the most appropriately sized icon resource for the best results.\n\t\t\thbitmap = (HBITMAP)ExtractIconFromExecutable(aFilespec, aIconNumber, aWidth, aHeight, apModule);\n\n\t\t\tif (hbitmap < (HBITMAP)2) // i.e. it's NULL or 1. Return value of 1 means \"incorrect file type\".\n\t\t\t\treturn NULL;\n\t\t\tExtractIcon_was_used = true;\n\t\t\taImageType = IMAGE_ICON;\n\t\t}\n\t\t//else file exists, so continue on so that the other methods are attempted in case file's contents\n\t\t// differ from what the file extension indicates, or in case the other methods can be successful\n\t\t// even when the above failed.\n\t}\n\n\tIPicture *pic = NULL; // Also used to detect whether IPic method was used to load the image.\n\n\tif (!hbitmap) // Above hasn't loaded the image yet, so use the fall-back methods.\n\t{\n\t\t// At this point, regardless of the image type being loaded (even an icon), it will\n\t\t// definitely be converted to a Bitmap below. So set the type:\n\t\taImageType = IMAGE_BITMAP;\n\t\t// Find out if this file type is supported by the non-GDI+ method. This check is not foolproof\n\t\t// since all it does is look at the file's extension, not its contents. However, it doesn't\n\t\t// need to be 100% accurate because its only purpose is to detect whether the higher-overhead\n\t\t// calls to GdiPlus can be avoided.\n\t\tif (aUseGDIPlusIfAvailable || !file_ext || (_tcsicmp(file_ext, _T(\"jpg\"))\n\t\t\t&& _tcsicmp(file_ext, _T(\"jpeg\")) && _tcsicmp(file_ext, _T(\"gif\")))) // Non-standard file type (BMP is already handled above).\n\t\t\tif (!hinstGDI) // We don't yet have a handle from an earlier call to LoadLibary().\n\t\t\t\thinstGDI = LoadLibrary(_T(\"gdiplus\"));\n\t\t// If it is suspected that the file type isn't supported, try to use GdiPlus if available.\n\t\t// If it's not available, fall back to the old method in case the filename doesn't properly\n\t\t// reflect its true contents (i.e. in case it really is a JPG/GIF/BMP internally).\n\t\t// If the below LoadLibrary() succeeds, either the OS is XP+ or the GdiPlus extensions have been\n\t\t// installed on an older OS.\n\t\tif (hinstGDI)\n\t\t{\n\t\t\t// LPVOID and \"int\" are used to avoid compiler errors caused by... namespace issues?\n\t\t\ttypedef int (WINAPI *GdiplusStartupType)(ULONG_PTR*, LPVOID, LPVOID);\n\t\t\ttypedef VOID (WINAPI *GdiplusShutdownType)(ULONG_PTR);\n\t\t\ttypedef int (WINGDIPAPI *GdipCreateBitmapFromFileType)(LPCWSTR, LPVOID);\n\t\t\ttypedef int (WINGDIPAPI *GdipCreateHBITMAPFromBitmapType)(LPVOID, LPVOID, DWORD);\n\t\t\ttypedef int (WINGDIPAPI *GdipDisposeImageType)(LPVOID);\n\t\t\tGdiplusStartupType DynGdiplusStartup = (GdiplusStartupType)GetProcAddress(hinstGDI, \"GdiplusStartup\");\n \t\t\tGdiplusShutdownType DynGdiplusShutdown = (GdiplusShutdownType)GetProcAddress(hinstGDI, \"GdiplusShutdown\");\n \t\t\tGdipCreateBitmapFromFileType DynGdipCreateBitmapFromFile = (GdipCreateBitmapFromFileType)GetProcAddress(hinstGDI, \"GdipCreateBitmapFromFile\");\n \t\t\tGdipCreateHBITMAPFromBitmapType DynGdipCreateHBITMAPFromBitmap = (GdipCreateHBITMAPFromBitmapType)GetProcAddress(hinstGDI, \"GdipCreateHBITMAPFromBitmap\");\n \t\t\tGdipDisposeImageType DynGdipDisposeImage = (GdipDisposeImageType)GetProcAddress(hinstGDI, \"GdipDisposeImage\");\n\n\t\t\tULONG_PTR token;\n\t\t\tGdiplus::GdiplusStartupInput gdi_input;\n\t\t\tGdiplus::GpBitmap *pgdi_bitmap;\n\t\t\tif (DynGdiplusStartup && DynGdiplusStartup(&token, &gdi_input, NULL) == Gdiplus::Ok)\n\t\t\t{\n#ifndef UNICODE\n\t\t\t\tWCHAR filespec_wide[MAX_WIDE_PATH]; // MAX_WIDE_PATH vs. MAX_PATH allows this to work with long paths (\\\\?\\ prefix may be required).\n\t\t\t\tToWideChar(aFilespec, filespec_wide, _countof(filespec_wide)); // Dest. size is in wchars, not bytes.\n\t\t\t\tif (DynGdipCreateBitmapFromFile(filespec_wide, &pgdi_bitmap) == Gdiplus::Ok)\n#else\n\t\t\t\tif (DynGdipCreateBitmapFromFile(aFilespec, &pgdi_bitmap) == Gdiplus::Ok)\n#endif\n\t\t\t\t{\n\t\t\t\t\tif (DynGdipCreateHBITMAPFromBitmap(pgdi_bitmap, &hbitmap, CLR_DEFAULT) != Gdiplus::Ok)\n\t\t\t\t\t\thbitmap = NULL; // Set to NULL to be sure.\n\t\t\t\t\tDynGdipDisposeImage(pgdi_bitmap); // This was tested once to make sure it really returns Gdiplus::Ok.\n\t\t\t\t}\n\t\t\t\t// The current thought is that shutting it down every time conserves resources. If so, it\n\t\t\t\t// seems justified since it is probably called infrequently by most scripts:\n\t\t\t\tDynGdiplusShutdown(token);\n\t\t\t}\n\t\t\tFreeLibrary(hinstGDI);\n\t\t}\n\t\telse // Using old picture loading method.\n\t\t{\n\t\t\t// Based on code sample at http://www.codeguru.com/Cpp/G-M/bitmap/article.php/c4935/\n\t\t\tHANDLE hfile = CreateFile(aFilespec, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);\n\t\t\tif (hfile == INVALID_HANDLE_VALUE)\n\t\t\t\treturn NULL;\n\t\t\tDWORD size = GetFileSize(hfile, NULL);\n\t\t\tHGLOBAL hglobal = GlobalAlloc(GMEM_MOVEABLE, size);\n\t\t\tif (!hglobal)\n\t\t\t{\n\t\t\t\tCloseHandle(hfile);\n\t\t\t\treturn NULL;\n\t\t\t}\n\t\t\tLPVOID hlocked = GlobalLock(hglobal);\n\t\t\tif (!hlocked)\n\t\t\t{\n\t\t\t\tCloseHandle(hfile);\n\t\t\t\tGlobalFree(hglobal);\n\t\t\t\treturn NULL;\n\t\t\t}\n\t\t\t// Read the file into memory:\n\t\t\tReadFile(hfile, hlocked, size, &size, NULL);\n\t\t\tGlobalUnlock(hglobal);\n\t\t\tCloseHandle(hfile);\n\t\t\tLPSTREAM stream;\n\t\t\tif (FAILED(CreateStreamOnHGlobal(hglobal, FALSE, &stream)) || !stream) // Relies on short-circuit boolean order.\n\t\t\t{\n\t\t\t\tGlobalFree(hglobal);\n\t\t\t\treturn NULL;\n\t\t\t}\n\t\t\t// Specify TRUE to have it do the GlobalFree() for us. But since the call might fail, it seems best\n\t\t\t// to free the mem ourselves to avoid uncertainty over what it does on failure:\n\t\t\tif (FAILED(OleLoadPicture(stream, 0, FALSE, IID_IPicture, (void **)&pic)))\n\t\t\t\tpic = NULL;\n\t\t\tstream->Release();\n\t\t\tGlobalFree(hglobal);\n\t\t\tif (!pic)\n\t\t\t\treturn NULL;\n\t\t\tpic->get_Handle((OLE_HANDLE *)&hbitmap);\n\t\t\t// Above: MSDN: \"The caller is responsible for this handle upon successful return. The variable is set\n\t\t\t// to NULL on failure.\"\n\t\t\tif (!hbitmap)\n\t\t\t{\n\t\t\t\tpic->Release();\n\t\t\t\treturn NULL;\n\t\t\t}\n\t\t\t// Don't pic->Release() yet because that will also destroy/invalidate hbitmap handle.\n\t\t} // IPicture method was used.\n\t} // IPicture or GDIPlus was used to load the image, not a simple LoadImage() or ExtractIcon().\n\n\t// Above has ensured that hbitmap is now not NULL.\n\t// Adjust things if \"keep aspect ratio\" is in effect:\n\tif (keep_aspect_ratio)\n\t{\n\t\tHBITMAP hbitmap_to_analyze;\n\t\tICONINFO ii; // Must be declared at this scope level.\n\t\tif (aImageType == IMAGE_BITMAP)\n\t\t\thbitmap_to_analyze = hbitmap;\n\t\telse // icon or cursor\n\t\t{\n\t\t\tif (GetIconInfo((HICON)hbitmap, &ii)) // Works on cursors too.\n\t\t\t\thbitmap_to_analyze = ii.hbmMask; // Use Mask because MSDN implies hbmColor can be NULL for monochrome cursors and such.\n\t\t\telse\n\t\t\t{\n\t\t\t\tDestroyIcon((HICON)hbitmap);\n\t\t\t\treturn NULL; // No need to call pic->Release() because since it's an icon, we know IPicture wasn't used (it only loads bitmaps).\n\t\t\t}\n\t\t}\n\t\t// Above has ensured that hbitmap_to_analyze is now not NULL. Find bitmap's dimensions.\n\t\tBITMAP bitmap;\n\t\tGetObject(hbitmap_to_analyze, sizeof(BITMAP), &bitmap); // Realistically shouldn't fail at this stage.\n\t\tif (aHeight == -1)\n\t\t{\n\t\t\t// Caller wants aHeight calculated based on the specified aWidth (keep aspect ratio).\n\t\t\tif (bitmap.bmWidth) // Avoid any chance of divide-by-zero.\n\t\t\t\taHeight = (int)(((double)bitmap.bmHeight / bitmap.bmWidth) * aWidth + .5); // Round.\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Caller wants aWidth calculated based on the specified aHeight (keep aspect ratio).\n\t\t\tif (bitmap.bmHeight) // Avoid any chance of divide-by-zero.\n\t\t\t\taWidth = (int)(((double)bitmap.bmWidth / bitmap.bmHeight) * aHeight + .5); // Round.\n\t\t}\n\t\tif (aImageType != IMAGE_BITMAP)\n\t\t{\n\t\t\t// It's our responsibility to delete these two when they're no longer needed:\n\t\t\tDeleteObject(ii.hbmColor);\n\t\t\tDeleteObject(ii.hbmMask);\n\t\t\t// If LoadImage() vs. ExtractIcon() was used originally, call LoadImage() again because\n\t\t\t// I haven't found any other way to retain an animated cursor's animation (and perhaps\n\t\t\t// other icon/cursor attributes) when resizing the icon/cursor (CopyImage() doesn't\n\t\t\t// retain animation):\n\t\t\tif (!ExtractIcon_was_used && !script_passed_handle)\n\t\t\t{\n\t\t\t\tDestroyIcon((HICON)hbitmap); // Destroy the original HICON.\n\t\t\t\t// Load a new one, but at the size newly calculated above.\n\t\t\t\treturn (HBITMAP)LoadImage(NULL, aFilespec, aImageType, aWidth, aHeight, LR_LOADFROMFILE);\n\t\t\t}\n\t\t}\n\t}\n\n\tHBITMAP hbitmap_new; // To hold the scaled image (if scaling is needed).\n\tif (pic) // IPicture method was used.\n\t{\n\t\t// The below statement is confirmed by having tested that DeleteObject(hbitmap) fails\n\t\t// if called after pic->Release():\n\t\t// \"Copy the image. Necessary, because upon pic's release the handle is destroyed.\"\n\t\t// MSDN: CopyImage(): \"[If either width or height] is zero, then the returned image will have the\n\t\t// same width/height as the original.\"\n\t\t// Note also that CopyImage() seems to provide better scaling quality than using MoveWindow()\n\t\t// (followed by redrawing the parent window) on the static control that contains it:\n\t\thbitmap_new = (HBITMAP)CopyImage(hbitmap, IMAGE_BITMAP, aWidth, aHeight // We know it's IMAGE_BITMAP in this case.\n\t\t\t, (aWidth || aHeight) ? 0 : LR_COPYRETURNORG); // Produce original size if no scaling is needed.\n\t\tpic->Release();\n\t\t// No need to call DeleteObject(hbitmap), see above.\n\t}\n\telse // GDIPlus or a simple method such as LoadImage or ExtractIcon was used.\n\t{\n\t\tif (!aWidth && !aHeight // No resizing needed.\n\t\t\t&& (!script_owns_handle || apNoDelete) // No copying needed.\n\t\t\t&& (aIconNumber < 1 || aImageType == IMAGE_ICON)) // No conversion to icon needed.\n\t\t\treturn hbitmap;\n\t\t// The following will also handle HICON/HCURSOR correctly if aImageType == IMAGE_ICON/CURSOR.\n\t\t// Also, LR_COPYRETURNORG|LR_COPYDELETEORG is used because it might allow the animation of\n\t\t// a cursor to be retained if the specified size happens to match the actual size of the\n\t\t// cursor. This is because normally, it seems that CopyImage() omits cursor animation\n\t\t// from the new object. MSDN: \"LR_COPYRETURNORG returns the original hImage if it satisfies\n\t\t// the criteria for the copy—that is, correct dimensions and color depth—in which case the\n\t\t// LR_COPYDELETEORG flag is ignored. If this flag is not specified, a new object is always created.\"\n\t\t// KNOWN BUG: Calling CopyImage() when the source image is tiny and the destination width/height\n\t\t// is also small (e.g. 1) causes a divide-by-zero exception.\n\t\t// For example:\n\t\t// Gui, Add, Pic, h1 w-1, bitmap 1x2.bmp ; Crash (divide by zero)\n\t\t// Gui, Add, Pic, h1 w-1, bitmap 2x3.bmp ; Crash (divide by zero)\n\t\t// However, such sizes seem too rare to document or put in an exception handler for.\n\t\thbitmap_new = (HBITMAP)CopyImage(hbitmap, aImageType, aWidth, aHeight\n\t\t\t, script_owns_handle ? (apNoDelete ? LR_COPYRETURNORG : 0) // If the script owns the original handle, never deleted it, and return it only if the caller can be told not to delete it.\n\t\t\t\t: (LR_COPYRETURNORG | LR_COPYDELETEORG));\n\t\t// Above's LR_COPYDELETEORG deletes the original to avoid cascading resource usage. MSDN's\n\t\t// LoadImage() docs say:\n\t\t// \"When you are finished using a bitmap, cursor, or icon you loaded without specifying the\n\t\t// LR_SHARED flag, you can release its associated memory by calling one of [the three functions].\"\n\t\t// Therefore, it seems best to call the right function even though DeleteObject might work on\n\t\t// all of them on some or all current OSes. UPDATE: Evidence indicates that DestroyIcon()\n\t\t// will also destroy cursors, probably because icons and cursors are literally identical in\n\t\t// every functional way. One piece of evidence:\n\t\t//> No stack trace, but I know the exact source file and line where the call\n\t\t//> was made. But still, it is annoying when you see 'DestroyCursor' even though\n\t\t//> there is 'DestroyIcon'.\n\t\t// \"Can't be helped. Icons and cursors are the same thing\" (Tim Robinson (MVP, Windows SDK)).\n\t\t//\n\t\t// Finally, the reason this is important is that it eliminates one handle type\n\t\t// that we would otherwise have to track. For example, if a gui window is destroyed and\n\t\t// and recreated multiple times, its bitmap and icon handles should all be destroyed each time.\n\t\t// Otherwise, resource usage would cascade upward until the script finally terminated, at\n\t\t// which time all such handles are freed automatically.\n\t}\n\tif (aIconNumber > 0 && aImageType == IMAGE_BITMAP)\n\t{\n\t\t// aIconNumber > 0 means the caller requires an icon.\n\t\tICONINFO iconinfo;\n\t\ticoninfo.fIcon = TRUE;\n\t\ticoninfo.hbmMask = hbitmap_new;\n\t\ticoninfo.hbmColor = hbitmap_new;\n\t\tHICON new_icon = CreateIconIndirect(&iconinfo);\n\t\tif (!script_owns_handle)\n\t\t\tDeleteObject(hbitmap_new);\n\t\thbitmap_new = (HBITMAP)new_icon;\n\t\taImageType = IMAGE_ICON;\n\t}\n\tif (hbitmap != hbitmap_new) // A new icon/bitmap was created above.\n\t\tif (apNoDelete)\n\t\t\t*apNoDelete = false; // Override any previously set value.\n\t\t//else caller assumes it must take responsibility for the handle.\n\treturn hbitmap_new;\n}\n\n\nstruct ResourceIndexToIdEnumData\n{\n\tint find_index;\n\tint index;\n\tLPTSTR result;\n};\n\nBOOL CALLBACK ResourceIndexToIdEnumProc(HMODULE hModule, LPCTSTR lpszType, LPTSTR lpszName, LONG_PTR lParam)\n{\n\tResourceIndexToIdEnumData &enum_data = *(ResourceIndexToIdEnumData*)lParam;\n\t\n\tif (++enum_data.index == enum_data.find_index)\n\t{\n\t\tenum_data.result = lpszName;\n\t\treturn FALSE; // Stop\n\t}\n\treturn TRUE; // Continue\n}\n\nstatic TCHAR RESOURCE_ID_NOT_FOUND[] = {0};\n\n// L17: Find ID of resource from one-based index. i.e. IconNumber -> resource ID.\n// v1.1.22.05: Return LPTSTR since some (very few) icons have a string ID.\nLPTSTR ResourceIndexToId(HMODULE aModule, LPCTSTR aType, int aIndex)\n{\n\tResourceIndexToIdEnumData enum_data;\n\tenum_data.find_index = aIndex;\n\tenum_data.index = 0;\n\t// NULL can't be used to indicate \"not found\", as any value between 0 and 0xFFFF is an\n\t// integer ID, including zero, even though some compilers replace it with \"0\" (string).\n\t// (LPTSTR)-1 or \"\" could be used instead, but this method should be safest, since we\n\t// know the API cannot ever return a string at this address:\n\tenum_data.result = RESOURCE_ID_NOT_FOUND;\n\n\tEnumResourceNames(aModule, aType, &ResourceIndexToIdEnumProc, (LONG_PTR)&enum_data);\n\n\treturn enum_data.result;\n}\n\n// L17: Extract icon of the appropriate size from an executable (or compatible) file.\nHICON ExtractIconFromExecutable(LPCTSTR aFilespec, int aIconNumber, int aWidth, int aHeight, HMODULE *apModule)\n{\n\tHICON hicon = NULL;\n\n\t// If the module is already loaded as an executable, LoadLibraryEx returns its handle.\n\t// Otherwise each call will receive its own handle to a data file mapping.\n\tHMODULE hdatafile = aFilespec ? LoadLibraryEx(aFilespec, NULL, LOAD_LIBRARY_AS_DATAFILE) : g_hInstance;\n\tif (hdatafile)\n\t{\n\t\tLPTSTR group_icon_id = (aIconNumber < 0)\n\t\t\t? MAKEINTRESOURCE(-aIconNumber)\n\t\t\t: ResourceIndexToId(hdatafile, (LPCTSTR)RT_GROUP_ICON, aIconNumber ? aIconNumber : 1);\n\n\t\tHRSRC hres;\n\t\tHGLOBAL hresdata;\n\t\tLPVOID presdata;\n\n\t\t// MSDN indicates resources are unloaded when the *process* exits, but also states\n\t\t// that the pointer returned by LockResource is valid until the *module* containing\n\t\t// the resource is unloaded. Testing seems to indicate that unloading a module indeed\n\t\t// unloads or invalidates any resources it contains.\n\t\tif (group_icon_id != RESOURCE_ID_NOT_FOUND\n\t\t\t&& (hres = FindResource(hdatafile, group_icon_id, RT_GROUP_ICON))\n\t\t\t&& (hresdata = LoadResource(hdatafile, hres))\n\t\t\t&& (presdata = LockResource(hresdata)))\n\t\t{\n#pragma pack(push, 1) // For RESDIR, mainly.\n\t\t\tstruct NEWHEADER {\n\t\t\t\tWORD Reserved;\n\t\t\t\tWORD ResType;\n\t\t\t\tWORD ResCount;\n\t\t\t};\n\t\t\tstruct ICONRESDIR {\n\t\t\t\tBYTE Width;\n\t\t\t\tBYTE Height;\n\t\t\t\tBYTE ColorCount;\n\t\t\t\tBYTE reserved;\n\t\t\t};\n\t\t\t// Note that the definition of RESDIR at http://msdn.microsoft.com/en-us/library/ms648026 is\n\t\t\t// completely wrong as at 2015-01-10, but the correct definition is posted in the comments.\n\t\t\tstruct RESDIR {\n\t\t\t\tICONRESDIR Icon;\n\t\t\t\tWORD Planes;\n\t\t\t\tWORD BitCount;\n\t\t\t\tDWORD BytesInRes;\n\t\t\t\tWORD IconCursorId;\n\t\t\t};\n#pragma pack(pop)\n\n\t\t\tif (aWidth == -1)\n\t\t\t\taWidth = aHeight;\n\t\t\tif (aWidth == 0)\n\t\t\t\taWidth = GetSystemMetrics(SM_CXICON);\n\n\t\t\tNEWHEADER *resHead = (NEWHEADER *)presdata;\n\t\t\tWORD resCount = resHead->ResCount;\n\t\t\tRESDIR *resDir = (RESDIR *)(resHead + 1), *chosen = NULL;\n\t\t\tint chosen_width = 0, chosen_depth = 0;\n\t\t\tfor (int i = 0; i < resCount; ++i)\n\t\t\t{\n\t\t\t\tint this_width = resDir[i].Icon.Width;\n\t\t\t\tif (!this_width) // Workaround for 256x256 icons.\n\t\t\t\t\tthis_width = 256;\n\t\t\t\tint this_depth = resDir[i].BitCount;\n\t\t\t\t// Find the closest match for size, preferring the next larger icon if there's\n\t\t\t\t// no exact match. Normally the system will just pick the closest size, but\n\t\t\t\t// at least for our icon, the 32x32 icon rendered at 20x20 looks much better\n\t\t\t\t// than the 16x16 icon rendered at 20x20 (i.e. small icon size for 125% DPI).\n\t\t\t\tif (this_width > chosen_width\n\t\t\t\t\t? chosen_width < aWidth // Current icon smaller than desired, so up-size.\n\t\t\t\t\t: this_width < chosen_width\n\t\t\t\t\t? this_width >= aWidth // This icon is closer to the desired size, so down-size.\n\t\t\t\t\t: this_depth > chosen_depth) // Prioritize size, but otherwise prefer higher bit count.\n\t\t\t\t{\n\t\t\t\t\tchosen = &resDir[i];\n\t\t\t\t\tchosen_width = this_width;\n\t\t\t\t\tchosen_depth = this_depth;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif ( (chosen) // It would be NULL if there were no icons.\n\t\t\t\t&& (hres = FindResource(hdatafile, MAKEINTRESOURCE(chosen->IconCursorId), RT_ICON))\n\t\t\t\t&& (hresdata = LoadResource(hdatafile, hres))\n\t\t\t\t&& (presdata = LockResource(hresdata)) )\n\t\t\t{\n\t\t\t\thicon = CreateIconFromResourceEx((PBYTE)presdata, SizeofResource(hdatafile, hres), TRUE, 0x30000, 0, 0, 0);\n\t\t\t}\n\t\t}\n\n\t\tif (apModule && hicon) // Only return the module if an icon was loaded; otherwise free it.\n\t\t\t*apModule = hdatafile;\n\t\telse if (aFilespec)\n\t\t\tFreeLibrary(hdatafile); // Decrements the executable module's reference count or frees the data file mapping.\n\t}\n\n\t// L20: Fall back to ExtractIcon if the above method failed. This may work on some versions of Windows where\n\t// ExtractIcon supports 16-bit \"executables\" (such as ICL files) that cannot be loaded by LoadLibraryEx.\n\t// However, resource ID -1 is not supported, and if multiple icon sizes exist in the file, the first is used\n\t// rather than the most appropriate.\n\tif (!hicon)\n\t\thicon = ExtractIcon(0, aFilespec, aIconNumber > 0 ? aIconNumber - 1 : aIconNumber < -1 ? aIconNumber : 0);\n\n\treturn hicon;\n}\n\n\nHBITMAP IconToBitmap(HICON ahIcon, bool aDestroyIcon)\n// Converts HICON to an HBITMAP that has ahIcon's actual dimensions.\n// The incoming ahIcon will be destroyed if the caller passes true for aDestroyIcon.\n// Returns NULL on failure, in which case aDestroyIcon will still have taken effect.\n// If the icon contains any transparent pixels, they will be mapped to CLR_NONE within\n// the bitmap so that the caller can detect them.\n{\n\tif (!ahIcon)\n\t\treturn NULL;\n\n\tHBITMAP hbitmap = NULL; // Set default. This will be the value returned.\n\n\tHDC hdc_desktop = GetDC(HWND_DESKTOP);\n\tHDC hdc = CreateCompatibleDC(hdc_desktop); // Don't pass NULL since I think that would result in a monochrome bitmap.\n\tif (hdc)\n\t{\n\t\tICONINFO ii;\n\t\tif (GetIconInfo(ahIcon, &ii))\n\t\t{\n\t\t\tBITMAP icon_bitmap;\n\t\t\t// Find out how big the icon is and create a bitmap compatible with the desktop DC (not the memory DC,\n\t\t\t// since its bits per pixel (color depth) is probably 1.\n\t\t\tif (GetObject(ii.hbmColor, sizeof(BITMAP), &icon_bitmap)\n\t\t\t\t&& (hbitmap = CreateCompatibleBitmap(hdc_desktop, icon_bitmap.bmWidth, icon_bitmap.bmHeight))) // Assign\n\t\t\t{\n\t\t\t\t// To retain maximum quality in case caller needs to resize the bitmap we return, convert the\n\t\t\t\t// icon to a bitmap that matches the icon's actual size:\n\t\t\t\tHGDIOBJ old_object = SelectObject(hdc, hbitmap);\n\t\t\t\tif (old_object) // Above succeeded.\n\t\t\t\t{\n\t\t\t\t\t// Use DrawIconEx() vs. DrawIcon() because someone said DrawIcon() always draws 32x32\n\t\t\t\t\t// regardless of the icon's actual size.\n\t\t\t\t\t// If it's ever needed, this can be extended so that the caller can pass in a background\n\t\t\t\t\t// color to use in place of any transparent pixels within the icon (apparently, DrawIconEx()\n\t\t\t\t\t// skips over transparent pixels in the icon when drawing to the DC and its bitmap):\n\t\t\t\t\tRECT rect = {0, 0, icon_bitmap.bmWidth, icon_bitmap.bmHeight}; // Left, top, right, bottom.\n\t\t\t\t\tHBRUSH hbrush = CreateSolidBrush(CLR_DEFAULT);\n\t\t\t\t\tFillRect(hdc, &rect, hbrush);\n\t\t\t\t\tDeleteObject(hbrush);\n\t\t\t\t\t// Probably something tried and abandoned: FillRect(hdc, &rect, (HBRUSH)GetStockObject(NULL_BRUSH));\n\t\t\t\t\tDrawIconEx(hdc, 0, 0, ahIcon, icon_bitmap.bmWidth, icon_bitmap.bmHeight, 0, NULL, DI_NORMAL);\n\t\t\t\t\t// Debug: Find out properties of new bitmap.\n\t\t\t\t\t//BITMAP b;\n\t\t\t\t\t//GetObject(hbitmap, sizeof(BITMAP), &b);\n\t\t\t\t\tSelectObject(hdc, old_object); // Might be needed (prior to deleting hdc) to prevent memory leak.\n\t\t\t\t}\n\t\t\t}\n\t\t\t// It's our responsibility to delete these two when they're no longer needed:\n\t\t\tDeleteObject(ii.hbmColor);\n\t\t\tDeleteObject(ii.hbmMask);\n\t\t}\n\t\tDeleteDC(hdc);\n\t}\n\tReleaseDC(HWND_DESKTOP, hdc_desktop);\n\tif (aDestroyIcon)\n\t\tDestroyIcon(ahIcon);\n\treturn hbitmap;\n}\n\n\n// Lexikos: Used for menu icons on Windows Vista and later. Some similarities to IconToBitmap, maybe should be merged if IconToBitmap does not specifically need to create a device-dependent bitmap?\nHBITMAP IconToBitmap32(HICON ahIcon, bool aDestroyIcon)\n{\n\t// Get the icon's internal colour and mask bitmaps.\n\t// hbmColor is needed to measure the icon.\n\t// hbmMask is needed to generate an alpha channel if the icon does not have one.\n\tICONINFO icon_info;\n\tif (!GetIconInfo(ahIcon, &icon_info))\n\t\treturn NULL;\n\n\tHBITMAP hbitmap = NULL; // Set default in case of failure.\n\n\t// Get size of icon's internal bitmap.\n\tBITMAP icon_bitmap;\n\tif (GetObject(icon_info.hbmColor, sizeof(BITMAP), &icon_bitmap))\n\t{\n\t\tint width = icon_bitmap.bmWidth;\n\t\tint height = icon_bitmap.bmHeight;\n\n\t\tHDC hdc = CreateCompatibleDC(NULL);\n\t\tif (hdc)\n\t\t{\n\t\t\tBITMAPINFO bitmap_info = {0};\n\t\t\t// Set parameters for 32-bit bitmap. May also be used to retrieve bitmap data from the icon's mask bitmap.\n\t\t\tBITMAPINFOHEADER &bitmap_header = bitmap_info.bmiHeader;\n\t\t\tbitmap_header.biSize = sizeof(BITMAPINFOHEADER);\n\t\t\tbitmap_header.biWidth = width;\n\t\t\tbitmap_header.biHeight = height;\n\t\t\tbitmap_header.biBitCount = 32;\n\t\t\tbitmap_header.biPlanes = 1;\n\n\t\t\t// Create device-independent bitmap.\n\t\t\tUINT *bits;\n\t\t\tif (hbitmap = CreateDIBSection(hdc, &bitmap_info, 0, (void**)&bits, NULL, 0))\n\t\t\t{\n\t\t\t\tHGDIOBJ old_object = SelectObject(hdc, hbitmap);\n\t\t\t\tif (old_object) // Above succeeded.\n\t\t\t\t{\n\t\t\t\t\t// Draw icon onto bitmap. Use DrawIconEx because DrawIcon always draws a large (usually 32x32) icon!\n\t\t\t\t\tDrawIconEx(hdc, 0, 0, ahIcon, 0, 0, 0, NULL, DI_NORMAL);\n\n\t\t\t\t\t// May be necessary for bits to be in sync, according to documentation for CreateDIBSection:\n\t\t\t\t\tGdiFlush();\n\n\t\t\t\t\t// Calculate end of bitmap data.\n\t\t\t\t\tUINT *bits_end = bits + width*height;\n\t\t\t\t\t\n\t\t\t\t\tUINT *this_pixel; // Used in a few loops below.\n\n\t\t\t\t\t// Check for alpha data.\n\t\t\t\t\tbool has_nonzero_alpha = false;\n\t\t\t\t\tfor (this_pixel = bits; this_pixel < bits_end; ++this_pixel)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (*this_pixel >> 24)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\thas_nonzero_alpha = true;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\tif (!has_nonzero_alpha)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Get bitmap data from the icon's mask.\n\t\t\t\t\t\tUINT *mask_bits = (UINT*)_alloca(height*width*4);\n\t\t\t\t\t\tif (GetDIBits(hdc, icon_info.hbmMask, 0, height, (LPVOID)mask_bits, &bitmap_info, 0))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tUINT *this_mask_pixel;\n\t\t\t\t\t\t\t// Use the icon's mask to generate alpha data.\n\t\t\t\t\t\t\tfor (this_pixel = bits, this_mask_pixel = mask_bits; this_pixel < bits_end; ++this_pixel, ++this_mask_pixel)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tif (*this_mask_pixel)\n\t\t\t\t\t\t\t\t\t*this_pixel = 0;\n\t\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\t\t*this_pixel |= 0xff000000;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// GetDIBits failed, simply make the bitmap opaque.\n\t\t\t\t\t\t\tfor (this_pixel = bits; this_pixel < bits_end; ++this_pixel)\n\t\t\t\t\t\t\t\t*this_pixel |= 0xff000000;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\tSelectObject(hdc, old_object);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// Probably very rare, but be on the safe side.\n\t\t\t\t\tDeleteObject(hbitmap);\n\t\t\t\t\thbitmap = NULL;\n\t\t\t\t}\n\t\t\t}\n\t\t\tDWORD dwError = GetLastError();\n\t\t\tDeleteDC(hdc);\n\t\t}\n\t}\n\n\t// It's our responsibility to delete these two when they're no longer needed:\n\tDeleteObject(icon_info.hbmColor);\n\tDeleteObject(icon_info.hbmMask);\n\n\tif (aDestroyIcon)\n\t\tDestroyIcon(ahIcon);\n\n\treturn hbitmap;\n}\n\n\n\nsize_t UnescapedLength(LPCTSTR aSrc, size_t aSrcLen)\n{\n\tsize_t len;\n\tfor (len = aSrcLen; aSrcLen > 1; --aSrcLen, ++aSrc) // > 1 because a trailing ` would be copied as-is.\n\t\tif (*aSrc == g_EscapeChar)\n\t\t\t--len, --aSrcLen, ++aSrc;\n\treturn len;\n}\n\n\n\nLPTSTR ConvertEscapeSequences(LPTSTR aDst, size_t aDstSize, LPCTSTR aSrc, size_t aSrcLen)\n// Copies aSrc to aDst, replacing any escape sequences with their reduced equivalent.\n// String will be truncated if aDstSize - 1 < UnescapedLength(aSrc, aSrcLen).\n// aSrc == aDst is permitted and should not do any unnecessary \"copying\".\n{\n\tauto src = aSrc, src_end = aSrc + aSrcLen;\n\tauto dst = aDst, dst_end = aDst + aDstSize - 1;\n\tfor (LPCTSTR esc;; ++dst, src = esc + 1)\n\t{\n\t\tfor (esc = src; esc < src_end && *esc != g_EscapeChar; ++esc); // Find the next escape char.\n\t\tsize_t seg_len = esc - src; // Calculate length of text segment preceding esc.\n\t\tif (dst != src) // No need to copy or check for overflow when dst == src.\n\t\t{\n\t\t\tif (dst + seg_len >= dst_end) // Avoid overflow.\n\t\t\t{\n\t\t\t\ttmemmove(dst, src, dst_end - dst); // This may truncate the string if aDstSize-1 < aSrcLen.\n\t\t\t\t*dst_end = '\\0';\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t//else there's room for seg_len and at least one more character.\n\t\t\ttmemmove(dst, src, seg_len);\n\t\t}\n\t\tsrc += seg_len;\n\t\tdst += seg_len;\n\t\tif (esc + 1 >= src_end) // No escape char, or just a trailing escape char.\n\t\t{\n\t\t\t*dst = '\\0';\n\t\t\tbreak;\n\t\t}\n\t\tesc++;\n\t\tswitch (*esc)\n\t\t{\n\t\t\t// Only lowercase is recognized for these:\n\t\t\tcase 'a': *dst = '\\a'; break; // alert (bell) character\n\t\t\tcase 'b': *dst = '\\b'; break; // backspace\n\t\t\tcase 'f': *dst = '\\f'; break; // formfeed\n\t\t\tcase 'n': *dst = '\\n'; break; // newline\n\t\t\tcase 'r': *dst = '\\r'; break; // carriage return\n\t\t\tcase 't': *dst = '\\t'; break; // horizontal tab\n\t\t\tcase 'v': *dst = '\\v'; break; // vertical tab\n\t\t\tcase 's': *dst = ' '; break; // space\n\t\t\tdefault: *dst = *esc; break;\n\t\t}\n\t}\n\treturn aDst;\n}\n\n\n\nLPTSTR ConvertEscapeSequences(LPTSTR aBuf)\n// Replaces any escape sequences in aBuf with their reduced equivalent. For example, if aEscapeChar\n// is accent, Each `n would become a literal linefeed. aBuf's length should always be the same or\n// lower than when the process started, so there is no chance of overflow.\n{\n\tsize_t len = _tcslen(aBuf);\n\treturn ConvertEscapeSequences(aBuf, len + 1, aBuf, len);\n}\n\n\n\nLPTSTR ConvertSpaceEscapeSequences(LPTSTR aBuf)\n// Replaces the `s and `t escapes sequences with \\s and \\t, while leaving all other sequences.\n// In particular, `` is left as is so that a subsequent call to ConvertEscapeSequences() won't\n// interpret it as escaping the next char.\n{\n\tauto src = _tcschr(aBuf, g_EscapeChar);\n\tif (!src)\n\t\treturn aBuf;\n\tauto dst = src;\n\tfor ( ; TCHAR c = *src; ++src, ++dst)\n\t{\n\t\tif (c == g_EscapeChar)\n\t\t{\n\t\t\tswitch (src[1])\n\t\t\t{\n\t\t\tcase 's': c = ' '; ++src; break;\n\t\t\tcase 't': c = '\\t'; ++src; break;\n\t\t\t}\n\t\t}\n\t\t*dst = c;\n\t}\n\t*dst = '\\0';\n\treturn aBuf;\n}\n\n\n\nbool CharIsEscaped(LPCTSTR aChar, LPCTSTR aBuf)\n{\n\t// Only the escape char can escape itself, so any odd number of preceding\n\t// escape chars means this quote mark is escaped; e.g. `\" or ```\".\n\tbool escaped = false;\n\twhile (aChar > aBuf && aChar[-1] == g_EscapeChar)\n\t\tescaped = !escaped, --aChar;\n\treturn escaped;\n}\n\n\n\nint FindExprDelim(LPCTSTR aBuf, TCHAR aDelimiter, int aStartIndex, LPCTSTR aLiteralMap)\n// Returns the index of the next delimiter, taking into account quotes, parentheses, etc.\n// If the delimiter is not found, returns the length of aBuf.\n{\n\tTCHAR close_char;\n\tfor (int mark = aStartIndex; ; ++mark)\n\t{\n\t\tif (aBuf[mark] == aDelimiter && (aDelimiter != ':' || aBuf[mark+1] != '='))\n\t\t\treturn mark;\n\t\tswitch (aBuf[mark])\n\t\t{\n\t\tcase '\\0':\n\t\t\t// Reached the end of the string without finding a delimiter. Return the\n\t\t\t// index of the null-terminator since that's typically what the caller wants.\n\t\t\treturn mark;\n\t\tdefault:\n\t\t//case '`': // May indicate an attempt to escape something when aLiteralMap==NULL, but has escape has no meaning here.\n\t\t\t// Not a meaningful character; just have the loop skip over it.\n\t\t\tcontinue;\n\t\tcase '\"': \n\t\tcase '\\'':\n\t\t\tmark = FindTextDelim(aBuf, aBuf[mark], mark + 1, aLiteralMap);\n\t\t\tif (!aBuf[mark]) // i.e. it isn't safe to do ++mark.\n\t\t\t\treturn mark; // See case '\\0' for comments.\n\t\t\tcontinue;\n\t\tcase ')':\n\t\tcase ']':\n\t\tcase '}':\n\t\tcase g_delimiter:\n\t\t\tif (aDelimiter) // Caller wants to find a specific symbol and it's not this one.\n\t\t\t\tcontinue; // Unbalanced parentheses etc are caught at a later stage.\n\t\t\treturn mark;\n\t\tcase ':':\n\t\t\tif (aDelimiter // See above.\n\t\t\t\t|| aBuf[mark + 1] == '=')\n\t\t\t\tcontinue;\n\t\t\t// Since aDelimiter is zero, this colon doesn't belong to a ternary expression\n\t\t\t// or object literal which is part of this sub-expression, so should effectively\n\t\t\t// terminate the sub-expression (likely a fat arrow function).\n\t\t\treturn mark;\n\t\tcase '?':\n\t\t\tif (aBuf[mark + 1] == '?') // ??\n\t\t\t{\n\t\t\t\tmark++; // Skip the second '?'.\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// Otherwise, it could still be [var?], but that shouldn't need special treatment\n\t\t\t// since aDelimiter should be ]/)/}, not :.\n\t\t\tif (aDelimiter && aDelimiter != ':')\n\t\t\t\tcontinue; // The following isn't needed in this case.\n\t\t\tif (aBuf[mark + 1] == '.') // Check for ?.property (which is not ternary).\n\t\t\t{\n\t\t\t\tLPTSTR d_end;\n\t\t\t\tauto id = aBuf + mark + 2, id_end = find_identifier_end(id);\n\t\t\t\t_tcstod(id, &d_end); // This accounts for scientific notation.\n\t\t\t\tif (id_end > d_end || id_end == d_end && (*id_end == '(' || *id_end == '['))\n\t\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tdo\n\t\t\t\tmark++;\n\t\t\twhile (IS_SPACE_OR_TAB(aBuf[mark]));\n\t\t\tif (_tcschr(EXPR_SYMBOLS_AFTER_MAYBE, aBuf[mark]))\n\t\t\t{\n\t\t\t\tmark--; // Counter the loop's increment.\n\t\t\t\tcontinue; // It's SYM_MAYBE, so don't scan for ':'.\n\t\t\t}\n\t\t\t// Scan for the corresponding ':' (or some other closing symbol if that's missing)\n\t\t\t// so that it won't terminate the sub-expression.\n\t\t\tmark = FindExprDelim(aBuf, ':', mark, aLiteralMap);\n\t\t\tif (!aBuf[mark]) // i.e. it isn't safe to do ++mark.\n\t\t\t\treturn mark; // See case '\\0' for comments.\n\t\t\tcontinue; // The colon is also skipped via the loop's increment.\n\t\tcase g_DerefChar:\n\t\t\t// Since the check at the top of the loop didn't \"return\", this is the beginning\n\t\t\t// of a double-deref, not the end.\n\t\t\tclose_char = g_DerefChar;\n\t\t\tbreak;\n\t\tcase '(': close_char = ')'; break;\n\t\tcase '[': close_char = ']'; break;\n\t\tcase '{': close_char = '}'; break;\n\t\t}\n\t\t// Since above didn't \"return\" or \"continue\":\n\t\tmark = FindExprDelim(aBuf, close_char, mark + 1, aLiteralMap);\n\t\tif (!aBuf[mark]) // i.e. it isn't safe to do ++mark.\n\t\t\treturn mark; // See case '\\0' for comments.\n\t\t// Otherwise, continue the loop.\n\t} // for each character.\n}\n\n\n\nint FindTextDelim(LPCTSTR aBuf, TCHAR aDelimiter, int aStartIndex, LPCTSTR aLiteralMap)\n{\n\tfor (int mark = aStartIndex; ; ++mark)\n\t{\n\t\tif (aBuf[mark] == aDelimiter)\n\t\t{\n\t\t\tif (aLiteralMap && aLiteralMap[mark])\n\t\t\t\tcontinue;\n\t\t\treturn mark;\n\t\t}\n\t\tswitch (aBuf[mark])\n\t\t{\n\t\tcase '\\0':\n\t\t\t// Reached the end of the string without finding a delimiter. Return the\n\t\t\t// index of the null-terminator since that's typically what the caller wants.\n\t\t\treturn mark;\n\t\tcase '`':\n\t\t\t// This allows g_DerefChar or aDelimiter to be escaped, but since every other non-null\n\t\t\t// character has no meaning here, it doesn't need to check which character it is skipping.\n\t\t\tif (!aLiteralMap && aBuf[mark+1])\n\t\t\t\t++mark;\n \t\t\tcontinue;\n\t\t}\n\t}\n}\n\n\n\nint BalanceExpr(LPCTSTR aBuf, int aStartBalance, TCHAR aExpect[], TCHAR *aOpenQuote)\n{\n\tTCHAR quote;\n\tint balance = aStartBalance, mark = 0;\n\tif (aOpenQuote && *aOpenQuote)\n\t{\n\t\tmark = FindTextDelim(aBuf, *aOpenQuote, mark);\n\t\tif (!aBuf[mark])\n\t\t\treturn balance;\n\t\t*aOpenQuote = 0;\n\t\t++mark;\n\t}\n\tfor (;; ++mark)\n\t{\n\t\tswitch (aBuf[mark])\n\t\t{\n\t\tcase '\\0':\n\t\t\treturn balance;\n\t\tdefault:\n\t\t//case '`': // May indicate an attempt to escape something, but has escape has no meaning here.\n\t\t//case g_DerefChar: // Caller does not want these balanced.\n\t\t\t// Not a meaningful character; just have the loop skip over it.\n\t\t\tbreak;\n\t\tcase '\"': \n\t\tcase '\\'':\n\t\t\tquote = aBuf[mark];\n\t\t\tmark = FindTextDelim(aBuf, quote, mark + 1);\n\t\t\tif (!aBuf[mark]) // i.e. it isn't safe to do ++mark.\n\t\t\t{\n\t\t\t\tif (aOpenQuote)\n\t\t\t\t{\n\t\t\t\t\t*aOpenQuote = quote;\n\t\t\t\t\treturn balance;\n\t\t\t\t}\n\t\t\t\taExpect[0] = quote; // Expected\n\t\t\t\taExpect[1] = 0; // Found\n\t\t\t\treturn -1; // Since this quote is missing its close-quote, abort the continuation loop.\n\t\t\t}\n\t\t\tbreak;\n\t\tcase ')':\n\t\tcase ']':\n\t\tcase '}':\n\t\t\t--balance;\n\t\t\tif (balance < 0\n\t\t\t\t|| balance < MAX_BALANCEEXPR_DEPTH && aBuf[mark] != aExpect[balance])\n\t\t\t{\n\t\t\t\taExpect[0] = balance < 0 ? 0 : aExpect[balance]; // Expected\n\t\t\t\taExpect[1] = aBuf[mark]; // Found\n\t\t\t\treturn -1;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase '(':\n\t\tcase '[':\n\t\tcase '{':\n\t\t\tif (balance < MAX_BALANCEEXPR_DEPTH)\n\t\t\t\taExpect[balance] = (aBuf[mark] == '(' ? ')' : aBuf[mark] + 2);\n\t\t\t++balance;\n\t\t\tbreak;\n\t\t}\n\t} // for each character.\n}\n\n\n\nint BalanceExpr(LPCTSTR aBuf)\n{\n\tTCHAR expect[MAX_BALANCEEXPR_DEPTH];\n\treturn BalanceExpr(aBuf, 0, expect);\n}\n\n\n\n#if 0 // Currently unused.\nbool IsStringInList(LPTSTR aStr, LPTSTR aList, bool aFindExactMatch)\n// Checks if aStr exists in aList (which is a comma-separated list).\n// If aStr is blank, aList must start with a delimiting comma for there to be a match.\n{\n\t// Must use a temp. buffer because otherwise there's no easy way to properly match upon strings\n\t// such as the following:\n\t// if var in string,,with,,literal,,commas\n\tTCHAR buf[LINE_SIZE];\n\tTCHAR *next_field, *cp, *end_buf = buf + _countof(buf) - 1;\n\n\t// v1.0.48.01: Performance improved by Lexikos.\n\tfor (TCHAR *this_field = aList; *this_field; this_field = next_field) // For each field in aList.\n\t{\n\t\tfor (cp = buf, next_field = this_field; *next_field && cp < end_buf; ++cp, ++next_field) // For each char in the field, copy it over to temporary buffer.\n\t\t{\n\t\t\tif (*next_field == ',') // This is either a delimiter (,) or a literal comma (,,).\n\t\t\t{\n\t\t\t\t++next_field;\n\t\t\t\tif (*next_field != ',') // It's \",\" instead of \",,\" so treat it as the end of this field.\n\t\t\t\t\tbreak;\n\t\t\t\t// Otherwise it's \",,\" and next_field now points at the second comma; so copy that comma\n\t\t\t\t// over as a literal comma then continue copying.\n\t\t\t}\n\t\t\t*cp = *next_field;\n\t\t}\n\n\t\t// The end of this field has been reached (or reached the capacity of the buffer), so terminate the string\n\t\t// in the buffer.\n\t\t*cp = '\\0';\n\n\t\tif (*buf) // It is possible for this to be blank only for the first field. Example: if var in ,abc\n\t\t{\n\t\t\tif (aFindExactMatch)\n\t\t\t{\n\t\t\t\tif (!g_tcscmp(aStr, buf)) // Match found\n\t\t\t\t\treturn true;\n\t\t\t}\n\t\t\telse // Substring match\n\t\t\t\tif (g_tcsstr(aStr, buf)) // Match found\n\t\t\t\t\treturn true;\n\t\t}\n\t\telse // First item in the list is the empty string.\n\t\t\tif (aFindExactMatch) // In this case, this is a match if aStr is also blank.\n\t\t\t{\n\t\t\t\tif (!*aStr)\n\t\t\t\t\treturn true;\n\t\t\t}\n\t\t\telse // Empty string is always found as a substring in any other string.\n\t\t\t\treturn true;\n\t} // for()\n\n\treturn false; // No match found.\n}\n#endif\n\n\n\nLPCTSTR InStrAny(LPCTSTR aStr, LPTSTR aNeedle[], int aNeedleCount, size_t &aFoundLen)\n{\n\t// For each character in aStr:\n\tfor ( ; *aStr; ++aStr)\n\t\t// For each needle:\n\t\tfor (int i = 0; i < aNeedleCount; ++i)\n\t\t\t// For each character in this needle:\n\t\t\tfor (LPCTSTR needle_pos = aNeedle[i], str_pos = aStr; ; ++needle_pos, ++str_pos)\n\t\t\t{\n\t\t\t\tif (!*needle_pos)\n\t\t\t\t{\n\t\t\t\t\t// All characters in needle matched aStr at this position, so we've\n\t\t\t\t\t// found our string. If this needle is empty, it implicitly matches\n\t\t\t\t\t// at the first position in the string.\n\t\t\t\t\taFoundLen = needle_pos - aNeedle[i];\n\t\t\t\t\treturn aStr;\n\t\t\t\t}\n\t\t\t\t// Otherwise, we haven't reached the end of the needle. If we've reached\n\t\t\t\t// the end of aStr, *str_pos and *needle_pos won't match, so the check\n\t\t\t\t// below will break out of the loop.\n\t\t\t\tif (*needle_pos != *str_pos)\n\t\t\t\t\t// Not a match: continue on to the next needle, or the next starting\n\t\t\t\t\t// position in aStr if this is the last needle.\n\t\t\t\t\tbreak;\n\t\t\t}\n\t// If the above loops completed without returning, no matches were found.\n\treturn NULL;\n}\n\n\n\nint FTOA(double aValue, LPTSTR aBuf, int aBufSize)\n// Converts aValue to a string while trying to ensure that conversion back to double will\n// produce the same value. Trailing 0s after the decimal point are stripped for brevity, when not printed in scientific notation.\n// Numbers printed in scientific notation may not contain a decimal point.\n// Caller must ensure there is sufficient buffer size to avoid truncating the output.\n{\n\tint result = sntprintf(aBuf, aBufSize, _T(\"%.17g\"), aValue);\n\t\n\t// the 'g' specifier might cause the result to lack a decimal point. \n\t// If the number is not written in scientific notation, and lacks a decimal point,\n\t// add \".0\" to make the string look like a float.\n\tsize_t search_result = _tcscspn(aBuf, _T(\".e\")); \n\tif (search_result == result\t\t\t// if true, no decimal point, '.', or 'e' was found, add \".0\",\n\t\t&& result + 3 <= aBufSize\t\t// but only if the buffer has room for two more characters and the null terminator,\n\t\t&& cisdigit(aBuf[result - 1]))\t// and the number isn't some variation of inf or NaN.\n\t{\n\t\taBuf[result] = '.';\t\t\t\t// overwrites the current null terminator.\n\t\taBuf[result+1] = '0';\n\t\taBuf[result+2] = '\\0';\n\t\tresult += 2;\t\t\t\t\t// the result is the number of characters written, excluding the terminator.\n\t}\n\treturn result;\n}\n\n\n\n// Caller must call CoTaskMemFree() on the result when done.\nPWSTR GetDocumentsFolder()\n{\n\tPWSTR path;\n\tif (SUCCEEDED(SHGetKnownFolderPath(FOLDERID_Documents, KF_FLAG_DONT_VERIFY, NULL, &path)))\n\t\treturn path;\n\treturn nullptr;\n}\n\n\n\nint CompareVersion(LPCTSTR a, LPCTSTR b)\n{\n\twhile (*a || *b)\n\t{\n\t\t// 1.1-a001 < 1.1 = 1.1.0 = 1.1.0+foo = 1.1.0+123\n\t\tLPTSTR pa, pb;\n\t\tint ia, ib;\n\t\tif (*a == '+') ia = 0, pa = const_cast<LPTSTR>(a); else ia = _tcstol(a, &pa, 10);\n\t\tif (*b == '+') ib = 0, pb = const_cast<LPTSTR>(b); else ib = _tcstol(b, &pb, 10);\n\t\t// If *pa is not in the set .-+\\0, this component is non-numeric (and not empty).\n\t\t// Treat non-numeric as greater than numeric (but assume any absent component is 0).\n\t\tif (!_tcschr(_T(\".-+\"), *pa)) ia = INT_MAX; else a = pa;\n\t\tif (!_tcschr(_T(\".-+\"), *pb)) ib = INT_MAX; else b = pb;\n\t\tif (ia < ib) return -1;\n\t\tif (ia > ib) return 1;\n\t\t// They are either equal or both non-numeric.\n\t\tif (*a == '.' || *b == '.')\n\t\t{\n\t\t\tif (*a == '.') ++a;\n\t\t\tif (*b == '.') ++b;\n\t\t\tcontinue; // On to the next component.\n\t\t}\n\t\t// Give -pre-release lower precedence.\n\t\tif (*a == '-' && *b != '-') return -1;\n\t\tif (*b == '-' && *a != '-') return 1;\n\t\tfor (;; ++a, ++b)\n\t\t{\n\t\t\tauto ac = *a == '+' || *a == '.' ? '\\0' : *a; // Ignore any + suffix (treat as terminator).\n\t\t\tauto bc = *b == '+' || *b == '.' ? '\\0' : *b;\n\t\t\tif (ac != bc) return ac < bc ? -1 : 1;\n\t\t\tif (!ac) // End of both components.\n\t\t\t{\n\t\t\t\tif (*a == '.' || *b == '.')\n\t\t\t\t\tbreak; // Try to compare the next component as numeric.\n\t\t\t\treturn 0; // Both reached the end; a and b are equal.\n\t\t\t}\n\t\t}\n\t}\n\treturn 0;\n}\n\n\n\n__declspec(noinline) // Prioritize code size for this.\nint VersionSatisfies(LPCTSTR v, LPCTSTR req, bool aThreeWayDefault)\n{\n\t// Support prefixes <, >, <=, >=, =; default to >= unless aThreeWayDefault.\n\tbool rmap[] = { false, false, false };\n\tLPCTSTR reqv = req;\n\tif (*reqv == '<') ++reqv, rmap[1-1] = true;\n\tif (*reqv == '>') ++reqv, rmap[1+1] = true;\n\tif (*reqv == '=') ++reqv, rmap[1+0] = true;\n\tbool has_op = reqv != req;\n\t// Support optional v prefix.\n\tif (*v == 'v') ++v;\n\tif (*reqv == 'v') ++reqv;\n\t// Perform the comparison.\n\tint result = CompareVersion(v, reqv);\n\tif (!has_op)\n\t{\n\t\t// When no operator is specified, also require that the major version matches.\n\t\treturn aThreeWayDefault ? result : result >= 0 && _ttoi(v) == _ttoi(reqv);\n\t}\n\treturn rmap[result + 1];\n}\n\n\n\n// Fills a buffer with pseudo-random numbers.\nBOOLEAN __stdcall GenRandom(PVOID RandomBuffer, ULONG RandomBufferLength)\n// Don't change the function signature without also changing the type-cast below.\n{\n\tstatic auto *RtlGenRandom = (decltype(&GenRandom)) GetProcAddress(GetModuleHandle(_T(\"Advapi32\")), \"SystemFunction036\");\n\treturn RtlGenRandom && RtlGenRandom(RandomBuffer, RandomBufferLength);\n}\n\n\n\n#if defined(_MSC_VER) && defined(_DEBUG)\nvoid OutputDebugStringFormat(LPCTSTR fmt, ...)\n{\n\tCString sMsg;\n\tva_list ap;\n\n\tva_start(ap, fmt);\n\tsMsg.FormatV(fmt, ap);\n\tOutputDebugString(sMsg);\n}\n#endif\n"},"size":{"kind":"number","value":145922,"string":"145,922"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":3032,"string":"3,032"},"avg_line_length":{"kind":"number","value":45.10916886543536,"string":"45.109169"},"max_line_length":{"kind":"number","value":256,"string":"256"},"alphanum_fraction":{"kind":"number","value":0.7133352516369914,"string":"0.713335"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11083,"cells":{"id":{"kind":"number","value":16071,"string":"16,071"},"file_name":{"kind":"string","value":"var.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/var.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"defines.h\"\n#include \"script_object.h\"\n#include \"var.h\"\n#include \"globaldata.h\" // for g_script\n#include <utility>\n\n\n// Init static vars:\nTCHAR Var::sEmptyString[] = _T(\"\"); // For explanation, see its declaration in .h file.\n\n\nResultType Var::AssignHWND(HWND aWnd)\n{\n\treturn Assign((size_t)aWnd);\n}\n\n\n\nResultType Var::Assign(Var &aVar)\n// Assign some other variable to the \"this\" variable.\n// aVar.Type() and this->Type() must be VAR_NORMAL.\n// Returns OK or FAIL.\n{\n\tVar &target_var = *ResolveAlias();\n\tVar &source_var = *aVar.ResolveAlias();\n\n\t// Caller already handled virtual target_var.\n\tASSERT(!target_var.IsVirtual());\n\n\tif (source_var.mAttrib & VAR_ATTRIB_UNINITIALIZED)\n\t{\n\t\ttarget_var.UninitializeNonVirtual();\n\t\treturn OK;\n\t}\n\n\tswitch (source_var.mAttrib & VAR_ATTRIB_TYPES) // This switch() method should squeeze a little more performance out of it compared to doing \"&\" for every attribute. Only works for attributes that are mutually-exclusive, which these are.\n\t{\n\tcase VAR_ATTRIB_IS_INT64:\n\t\treturn target_var.Assign(source_var.mContentsInt64);\n\tcase VAR_ATTRIB_IS_DOUBLE:\n\t\treturn target_var.Assign(source_var.mContentsDouble);\n\tcase VAR_ATTRIB_IS_OBJECT:\n\t\treturn target_var.Assign(source_var.mObject);\n\t}\n\t// Otherwise:\n\treturn target_var.Assign(source_var.mCharContents, source_var._CharLength()); // Pass length to improve performance. It isn't necessary to call Contents()/Length() because they must be already up-to-date because there is no binary number to update them from (if there were, the above would have returned). Also, caller ensured Type()==VAR_NORMAL.\n}\n\n\n\nResultType Var::Assign(ExprTokenType &aToken)\n// Returns OK or FAIL.\n// Writes aToken's value into aOutputVar based on the type of the token.\n// Caller must ensure that aToken.symbol is an operand (not an operator or other symbol).\n{\n\tif (VarTypeIsVirtual(mType))\n\t{\n\t\tif (aToken.symbol == SYM_MISSING)\n\t\t\treturn g_script.RuntimeError(ERR_INVALID_ASSIGNMENT);\n\t\treturn AssignVirtual(aToken);\n\t}\n\tswitch (aToken.symbol)\n\t{\n\tcase SYM_STRING: return Assign(aToken.marker, aToken.marker_length);\n\tcase SYM_INTEGER: return Assign(aToken.value_int64); // Listed first for performance because it's Likely the most common from our callers.\n\tcase SYM_VAR: return Assign(*aToken.var);\n\tcase SYM_OBJECT: return Assign(aToken.object);\n\tcase SYM_FLOAT: return Assign(aToken.value_double); // Listed last because it's probably the least common.\n\tdefault:\n\t\tASSERT(!\"Unhandled symbol\");\n\tcase SYM_MISSING:\n\t\tUninitializeNonVirtual();\n\t\treturn OK;\n\t}\n\t// Since above didn't return, it can only be SYM_STRING.\n\treturn Assign(aToken.marker, aToken.marker_length);\n}\n\n\n\nResultType Var::AssignVirtual(ExprTokenType &aValue)\n{\n\tFuncResult result_token;\n\tif (mType == VAR_VIRTUAL)\n\t{\n\t\tif (!mVV->Set) // Might be impossible due to prior validation of assignments/output vars.\n\t\t\treturn g_script.VarIsReadOnlyError(this);\n\t\tmVV->Set(result_token, mName, aValue);\n\t}\n\telse\n\t{\n\t\tASSERT(mType == VAR_VIRTUAL_OBJ && IsObject());\n\t\tAssignVirtualObj(mObject, aValue, result_token);\n\t}\n\treturn result_token.Exited() ? FAIL : OK; // Never EXIT, since callers are likely expecting only FAIL or OK.\n}\n\n\n\nvoid Var::AssignVirtualObj(IObject *aObj, ExprTokenType &aValue, ResultToken &aResultToken)\n{\n\tauto *param = &aValue;\n\tif (aObj->Invoke(aResultToken, IT_SET | IF_BYPASS_METAFUNC | IF_NO_NEW_PROPS, _T(\"__Value\"), ExprTokenType(aObj), ¶m, 1) == INVOKE_NOT_HANDLED)\n\t\taResultToken.UnknownMemberError(ExprTokenType(aObj), IT_SET, _T(\"__Value\"));\n}\n\n\n\nResultType Var::PopulateVirtualVar()\n{\n\tFuncResult result_token;\n\tGet(result_token);\n\tif (result_token.Exited())\n\t\treturn FAIL;\n\tif (result_token.mem_to_free)\n\t{\n\t\t_AcceptNewMem(result_token.mem_to_free, result_token.marker_length);\n\t\tmAttrib |= VAR_ATTRIB_VIRTUAL_OPEN;\n\t\treturn OK;\n\t}\n\tsize_t length;\n\tLPTSTR value = TokenToString(result_token, result_token.buf, &length);\n\tif (!length) // Avoid an indirect call to Free().\n\t{\n\t\tif (mByteCapacity)\n\t\t\t*mCharContents = '\\0';\n\t\treturn OK;\n\t}\n\tif (!AssignString(nullptr, length))\n\t\treturn FAIL;\n\ttmemcpy(mCharContents, value, length + 1);\n\treturn OK;\n}\n\n\n\nvoid Var::UpdateAlias(Var *aTargetVar)\n// Caller must ensure that aTargetVar isn't NULL.\n// When this function actually converts a normal variable into an alias , the variable's old\n// attributes (especially mContents and mCapacity) are hidden/suppressed by virtue of all Var::\n// methods obeying VAR_ALIAS and resolving it to be the target variable. This prevents a memory\n// leak in a case where a UDF is defined to provide a default value for a ByRef parameter, and is\n// called both with and without that parameter.\n{\n\tIObject *ref = aTargetVar->mType == VAR_ALIAS && aTargetVar->IsObject()\n\t\t? aTargetVar->mObject : nullptr;\n\n\t// BELOW IS THE MEANS BY WHICH ALIASES AREN'T ALLOWED TO POINT TO OTHER ALIASES, ONLY DIRECTLY TO\n\t// THE TARGET VAR.\n\t// Resolve aliases-to-aliases for performance. A caller may ask to create an alias\n\t// to an alias when a function calls another function and passes to it one of its own\n\t// byref-params, or if the target var has had its reference taken with GetRef().\n\twhile (aTargetVar->mType == VAR_ALIAS)\n\t\taTargetVar = aTargetVar->mAliasFor;\n\n\t// The following is done only after the above in case there's ever a way for the above\n\t// to circle back to become this variable.\n\t// Prevent potential infinite loops in other methods by refusing to change an alias\n\t// to point to itself.\n\tif (aTargetVar == this)\n\t\treturn;\n\n\tSetAliasDirect(aTargetVar);\n\t\n\t// Done last in case it causes interruption:\n\tASSERT(!IsObject());\n\t//if (IsObject())\n\t//\tReleaseObject();\n\tif (ref)\n\t{\n\t\t_SetObject(ref);\n\t\tref->AddRef();\n\t}\n}\n\n\n\nvoid Var::UpdateAlias(VarRef *aTargetVar)\n{\n\tASSERT(!IsObject());\n\tSetAliasDirect(aTargetVar);\n\t_SetObject(aTargetVar);\n\taTargetVar->AddRef();\n}\n\n\n\nvoid Var::UpdateVirtualObj(IObject *aTargetRef)\n{\n\tASSERT(!IsObject());\n\tmType = VAR_VIRTUAL_OBJ;\n\t_SetObject(aTargetRef);\n\tmAttrib &= ~VAR_ATTRIB_NOT_NUMERIC; // Let IsNumeric() evaluate the property.\n\taTargetRef->AddRef();\n}\n\n\n\nIObject *Var::GetRef()\n{\n\tauto target_var = this;\n\tif (mType == VAR_ALIAS)\n\t{\n\t\tif (mAttrib & VAR_ATTRIB_IS_OBJECT)\n\t\t{\n\t\t\tmObject->AddRef();\n\t\t\treturn mObject;\n\t\t}\n\t\ttarget_var = mAliasFor;\n\t\t// It is also possible for a non-object alias to point to an object alias if the reference operator\n\t\t// is applied to target_var itself or some other alias after this var became an alias of target_var.\n\t\tif (target_var->mType == VAR_ALIAS && (target_var->mAttrib & VAR_ATTRIB_IS_OBJECT))\n\t\t{\n\t\t\ttarget_var->mObject->AddRef();\n\t\t\treturn target_var->mObject;\n\t\t}\n\t}\n\telse if (mType == VAR_VIRTUAL_OBJ)\n\t{\n\t\tASSERT(mAttrib & VAR_ATTRIB_IS_OBJECT);\n\t\tmObject->AddRef();\n\t\treturn mObject;\n\t}\n\tauto ref = new VarRef();\n\tif (!target_var->MoveToNewFreeVar(*ref))\n\t{\n\t\tref->Release();\n\t\treturn nullptr;\n\t}\n\tif (mType == VAR_ALIAS)\n\t\ttarget_var->UpdateAlias(ref);\n\tUpdateAlias(ref);\n\treturn ref;\n}\n\n\n\nResultType Var::MoveToNewFreeVar(Var &aFV)\n{\n\tASSERT(aFV.mType == VAR_NORMAL && (mType == VAR_NORMAL || mType == VAR_VIRTUAL));\n\tASSERT(aFV.mHowAllocated == ALLOC_MALLOC);\n\taFV.mName = mName; // For error reporting.\n\taFV.mScope = mScope | VAR_VARREF; // Flag it as a VarRef to allow ToReturnValue to safely optimize.\n\tif (mAttrib & VAR_ATTRIB_TYPES)\n\t{\n\t\taFV.mContentsInt64 = mContentsInt64;\n\t\taFV.mAttrib = (mAttrib & (VAR_ATTRIB_TYPES | VAR_ATTRIB_CACHE | VAR_ATTRIB_CONTENTS_OUT_OF_DATE));\n\t\tmAttrib &= ~VAR_ATTRIB_TYPES; // Mainly to remove VAR_ATTRIB_IS_OBJECT.\n\t}\n\telse if (mType == VAR_VIRTUAL)\n\t{\n\t\taFV.mType = VAR_VIRTUAL;\n\t\taFV.mVV = mVV;\n\t}\n#if 0\n\t// The following is currently not used because:\n\t// - It causes the capacity of the variable to change (possibly reset to 0), which is bad if\n\t// VarSetStrCapacity(&v, n) was used. GetRef() wouldn't have been called by it because of\n\t// optimization of OutputVar parameters.\n\t// - At worst, a small amount of memory per unique variable is reserved and won't be reused\n\t// from this point on, the same as if its capacity increased beyond MAX_ALLOC_SIMPLE.\n\t// - If the variable isn't empty, it's likely that this action will be repeateded each time\n\t// \t the function is called; i.e. malloc will be used by aFV.Assign() and the string will be\n\t// \t copied, when it would be more efficient to malloc at a earlier point and swap vs. copy.\n\t// - In the most common cases, GetRef() is used when capacity is 0.\n\t// An alternative would be to change VarSetStrCapacity() to always GetRef(), but that would be\n\t// detrimental for optimizing string concatenation, which is its recommended purpose.\n\telse if (mHowAllocated == ALLOC_SIMPLE && !(mScope & (VAR_GLOBAL | VAR_LOCAL_STATIC)))\n\t{\n\t\t// Don't transfer a SimpleHeap buffer to freevars since that would cause the\n\t\t// buffer to be lost permanently when the freevar is deleted (such as after\n\t\t// the function returns and the VarRef's reference count reaches 0).\n\t\tif (!aFV.Assign(mCharContents, CharLength()))\n\t\t\treturn FAIL;\n\t\t//mAttrib = VAR_ATTRIB_UNINITIALIZED;\n\t\t//*mCharContents = '\\0';\n\t\t//mByteLength = 0;\n\t\treturn OK;\n\t}\n#endif\n\telse\n\t{\n\t\tif (!(mAttrib & VAR_ATTRIB_UNINITIALIZED))\n\t\t{\n\t\t\taFV.mAttrib &= ~VAR_ATTRIB_UNINITIALIZED;\n\t\t\tmAttrib |= VAR_ATTRIB_UNINITIALIZED;\n\t\t}\n\t}\n\tstd::swap(aFV.mHowAllocated, mHowAllocated);\n\tstd::swap(aFV.mByteContents, mByteContents);\n\tstd::swap(aFV.mByteCapacity, mByteCapacity);\n\tstd::swap(aFV.mByteLength, mByteLength);\n\treturn OK;\n}\n\n\n\nResultType Var::GetClipboardAll(void **aData, size_t *aDataSize)\n{\n\t*aData = NULL; // Set default in case of early return or empty data.\n\t*aDataSize = 0;\n\n\tif (!g_clip.Open())\n\t\treturn g_script.RuntimeError(CANT_OPEN_CLIPBOARD_READ);\n\n\t// Calculate the size needed:\n\t// EnumClipboardFormats() retrieves all formats, including synthesized formats that don't\n\t// actually exist on the clipboard but are instead constructed on demand. Unfortunately,\n\t// there doesn't appear to be any way to reliably determine which formats are real and\n\t// which are synthesized (if there were such a way, a large memory savings could be\n\t// realized by omitting the synthesized formats from the saved version). One thing that\n\t// is certain is that the \"real\" format(s) come first and the synthesized ones afterward.\n\t// However, that's not quite enough because although it is recommended that apps store\n\t// the primary/preferred format first, the OS does not enforce this. For example, testing\n\t// shows that the apps do not have to store CF_UNICODETEXT prior to storing CF_TEXT,\n\t// in which case the clipboard might have inaccurate CF_TEXT as the first element and\n\t// more accurate/complete (non-synthesized) CF_UNICODETEXT stored as the next.\n\t// In spite of the above, the below seems likely to be accurate 99% or more of the time,\n\t// which seems worth it given the large savings of memory that are achieved, especially\n\t// for large quantities of text or large images. Confidence is further raised by the\n\t// fact that MSDN says there's no advantage/reason for an app to place multiple formats\n\t// onto the clipboard if those formats are available through synthesis.\n\t// And since CF_TEXT always(?) yields synthetic CF_OEMTEXT and CF_UNICODETEXT, and\n\t// probably (but less certainly) vice versa: if CF_TEXT is listed first, it might certainly\n\t// mean that the other two do not need to be stored. There is some slight doubt about this\n\t// in a situation where an app explicitly put CF_TEXT onto the clipboard and then followed\n\t// it with CF_UNICODETEXT that isn't synthesized, nor does it match what would have been\n\t// synthesized. However, that seems extremely unlikely (it would be much more likely for\n\t// an app to store CF_UNICODETEXT *first* followed by custom/non-synthesized CF_TEXT, but\n\t// even that might be unheard of in practice). So for now -- since there is no documentation\n\t// to be found about this anywhere -- it seems best to omit some of the most common\n\t// synthesized formats:\n\t// CF_TEXT is the first of three text formats to appear: Omit CF_OEMTEXT and CF_UNICODETEXT.\n\t// (but not vice versa since those are less certain to be synthesized)\n\t// (above avoids using four times the amount of memory that would otherwise be required)\n\t// UPDATE: Only the first text format is included now, since MSDN says there is no\n\t// advantage/reason to having multiple non-synthesized text formats on the clipboard.\n\t// UPDATE: MS Word 2010 (and perhaps other versions) stores CF_TEXT before CF_UNICODETEXT,\n\t// even when CF_TEXT is incomplete/inaccurate. Since there's no way to know whether it was\n\t// synthesized, it is now stored unconditionally. CF_TEXT and CF_OEMTEXT are discarded to\n\t// save memory and because they should always be synthesized correctly.\n\t// CF_DIB: Always omit this if CF_DIBV5 is available (which must be present on Win2k+, at least\n\t// as a synthesized format, whenever CF_DIB is present?) This policy seems likely to avoid\n\t// the issue where CF_DIB occurs first yet CF_DIBV5 that comes later is *not* synthesized,\n\t// perhaps simply because the app stored DIB prior to DIBV5 by mistake (though there is\n\t// nothing mandatory, so maybe it's not really a mistake). Note: CF_DIBV5 supports alpha\n\t// channel / transparency, and perhaps other things, and it is likely that when synthesized,\n\t// no information of the original CF_DIB is lost. Thus, when CF_DIBV5 is placed back onto\n\t// the clipboard, any app that needs CF_DIB will have it synthesized back to the original\n\t// data (hopefully). It's debatable whether to do it that way or store whichever comes first\n\t// under the theory that an app would never store both formats on the clipboard since MSDN\n\t// says: \"If the system provides an automatic type conversion for a particular clipboard format,\n\t// there is no advantage to placing the conversion format(s) on the clipboard.\"\n\tHGLOBAL hglobal;\n\tUINT size; // Make it 32-bit even on x64 to allow clipboard data to be used between x86 and x64.\n\tUINT format;\n\tVarSizeType space_needed;\n\tUINT dib_format_to_omit = 0;\n\tBOOL save_null_data;\n\t// Start space_needed off at 4 to allow room for guaranteed final termination of the variable's contents.\n\t// The termination must be of the same size as format because a single-byte terminator would\n\t// be read in as a format of 0x00?????? where ?????? is an access violation beyond the buffer.\n\tfor (space_needed = sizeof(format), format = 0; format = EnumClipboardFormats(format);)\n\t{\n\t\tswitch (format)\n\t\t{\n\t\tcase CF_BITMAP:\n\t\tcase CF_ENHMETAFILE:\n\t\tcase CF_DSPENHMETAFILE:\n\t\t\t// These formats appear to be specific handle types, not always safe to call GlobalSize() for.\n\t\t\tcontinue;\n\t\t}\n\t\t// No point in calling GetLastError() since it would never be executed because the loop's\n\t\t// condition breaks on zero return value.\n\t\tif (format == CF_TEXT || format == CF_OEMTEXT // This format is excluded in favour of CF_UNICODETEXT.\n\t\t\t|| format == dib_format_to_omit) // ... or this format was marked excluded by a prior iteration.\n\t\t\tcontinue;\n\t\t// GetClipboardData() causes Task Manager to report a (sometimes large) increase in\n\t\t// memory utilization for the script, which is odd since it persists even after the\n\t\t// clipboard is closed. However, when something new is put onto the clipboard by the\n\t\t// the user or any app, that memory seems to get freed automatically. Also, \n\t\t// GetClipboardData(49356) fails in MS Visual C++ when the copied text is greater than\n\t\t// about 200 KB (but GetLastError() returns ERROR_SUCCESS). When pasting large sections\n\t\t// of colorized text into MS Word, it can't get the colorized text either (just the plain\n\t\t// text). Because of this example, it seems likely it can fail in other places or under\n\t\t// other circumstances, perhaps by design of the app. Therefore, be tolerant of failures\n\t\t// because partially saving the clipboard seems much better than aborting the operation.\n\t\tif (hglobal = g_clip.GetClipboardDataTimeout(format, &save_null_data))\n\t\t{\n\t\t\tspace_needed += (VarSizeType)(sizeof(format) + sizeof(size) + GlobalSize(hglobal)); // The total amount of storage space required for this item.\n\t\t\tif (!dib_format_to_omit)\n\t\t\t{\n\t\t\t\tif (format == CF_DIB)\n\t\t\t\t\tdib_format_to_omit = CF_DIBV5;\n\t\t\t\telse if (format == CF_DIBV5)\n\t\t\t\t\tdib_format_to_omit = CF_DIB;\n\t\t\t}\n\t\t\t// Currently CF_ENHMETAFILE isn't supported, so no need for this section:\n\t\t\t//if (!meta_format_to_omit) // Checked for the same reasons as dib_format_to_omit.\n\t\t\t//{\n\t\t\t//\tif (format == CF_ENHMETAFILE)\n\t\t\t//\t\tmeta_format_to_omit = CF_METAFILEPICT;\n\t\t\t//\telse if (format == CF_METAFILEPICT)\n\t\t\t//\t\tmeta_format_to_omit = CF_ENHMETAFILE;\n\t\t\t//}\n\t\t}\n\t\telse if (save_null_data)\n\t\t\tspace_needed += (VarSizeType)(sizeof(format) + sizeof(size));\n\t\t//else omit this format from consideration.\n\t}\n\n\tif (space_needed == sizeof(format)) // This works because even a single empty format requires space beyond sizeof(format) for storing its format+size.\n\t{\n\t\tg_clip.Close();\n\t\treturn OK;\n\t}\n\n\tif (space_needed & 1)\n\t\t++space_needed; // Ensure it's a multiple of WCHAR.\n\n\tLPVOID binary_contents;\n\t\n\t// Allocate buffer.\n\t*aData = binary_contents = malloc(space_needed);\n\t\n\tif (!binary_contents)\n\t{\n\t\tg_clip.Close();\n\t\treturn MemoryError();\n\t}\n\n\t// Retrieve and store all the clipboard formats. Because failures of GetClipboardData() are now\n\t// tolerated, it seems safest to recalculate the actual size (actual_space_needed) of the data\n\t// in case it varies from that found in the estimation phase. This is especially necessary in\n\t// case GlobalLock() ever fails, since that isn't even attempted during the estimation phase.\n\t// Otherwise, the variable's mLength member would be set to something too high (the estimate),\n\t// which might cause problems elsewhere.\n\tLPVOID hglobal_locked;\n\tVarSizeType added_size, actual_space_used;\n\tfor (actual_space_used = sizeof(format), format = 0; format = EnumClipboardFormats(format);)\n\t{\n\t\tswitch (format)\n\t\t{\n\t\tcase CF_BITMAP:\n\t\tcase CF_ENHMETAFILE:\n\t\tcase CF_DSPENHMETAFILE:\n\t\t\t// These formats appear to be specific handle types, not always safe to call GlobalSize() for.\n\t\t\tcontinue;\n\t\t}\n\t\t// No point in calling GetLastError() since it would never be executed because the loop's\n\t\t// condition breaks on zero return value.\n\t\tif (format == CF_TEXT || format == CF_OEMTEXT\n\t\t\t|| format == dib_format_to_omit /*|| format == meta_format_to_omit*/)\n\t\t\tcontinue;\n\t\t// Although the GlobalSize() documentation implies that a valid HGLOBAL should not be zero in\n\t\t// size, it does happen, at least in MS Word and for CF_BITMAP. Therefore, in order to save\n\t\t// the clipboard as accurately as possible, also save formats whose size is zero. Note that\n\t\t// GlobalLock() fails to work on hglobals of size zero, so don't do it for them.\n\t\thglobal = g_clip.GetClipboardDataTimeout(format, &save_null_data);\n\t\tif (hglobal)\n\t\t\tsize = (UINT)GlobalSize(hglobal); // Data >= 4GB seems extremely unlikely, and couldn't be detected by 32-bit processes anyway, so there's no checking for overflow on x64.\n\t\telse if (save_null_data)\n\t\t\tsize = 0; // This format usually has NULL data.\n\t\telse\n\t\t\tcontinue; // GetClipboardData() failed: skip this format.\n\t\tif (!size || (hglobal_locked = GlobalLock(hglobal))) // Size of zero or lock succeeded: Include this format.\n\t\t{\n\t\t\t// Any changes made to how things are stored here should also be made to the size-estimation\n\t\t\t// phase so that space_needed matches what is done here:\n\t\t\tadded_size = (VarSizeType)(sizeof(format) + sizeof(size) + size);\n\t\t\tactual_space_used += added_size;\n\t\t\tif (actual_space_used > space_needed) // Tolerate incorrect estimate by omitting formats that won't fit.\n\t\t\t\tactual_space_used -= added_size;\n\t\t\telse\n\t\t\t{\n\t\t\t\t*(UINT *)binary_contents = format;\n\t\t\t\tbinary_contents = (char *)binary_contents + sizeof(format);\n\t\t\t\t*(SIZE_T *)binary_contents = size;\n\t\t\t\tbinary_contents = (char *)binary_contents + sizeof(size);\n\t\t\t\tif (size)\n\t\t\t\t{\n\t\t\t\t\tmemcpy(binary_contents, hglobal_locked, size);\n\t\t\t\t\tbinary_contents = (char *)binary_contents + size;\n\t\t\t\t}\n\t\t\t\t//else hglobal_locked is not valid, so don't reference it or unlock it.\n\t\t\t}\n\t\t\tif (size)\n\t\t\t\tGlobalUnlock(hglobal); // hglobal not hglobal_locked.\n\t\t}\n\t}\n\tg_clip.Close();\n\t*(UINT *)binary_contents = 0; // Final termination (must be UINT, see above).\n\n\t*aDataSize = (DWORD)actual_space_used;\n\treturn OK;\n}\n\n\n\nResultType Var::SetClipboardAll(void *aData, size_t aDataSize)\n{\n\tif (!g_clip.Open())\n\t\treturn g_script.RuntimeError(CANT_OPEN_CLIPBOARD_WRITE);\n\tEmptyClipboard(); // Failure is not checked for since it's probably impossible under these conditions.\n\n\t// In case the variable contents are incomplete or corrupted (such as having been read in from a\n\t// bad file with FileRead), prevent reading beyond the end of the variable:\n\tLPVOID next, binary_contents = aData;\n\tLPVOID binary_contents_max = (char *)binary_contents + aDataSize; // The last accessible byte, which should be the last byte of the (UINT)0 terminator.\n\tHGLOBAL hglobal;\n\tLPVOID hglobal_locked;\n\tUINT format;\n\tUINT size;\n\n\twhile ((next = (char *)binary_contents + sizeof(format)) <= binary_contents_max\n\t\t&& (format = *(UINT *)binary_contents)) // Get the format. Relies on short-circuit boolean order.\n\t{\n\t\tbinary_contents = next;\n\t\tif ((next = (char *)binary_contents + sizeof(size)) > binary_contents_max)\n\t\t\tbreak;\n\t\tsize = *(UINT *)binary_contents; // Get the size of this format's data.\n\t\tbinary_contents = next;\n\t\tif ((next = (char *)binary_contents + size) > binary_contents_max)\n\t\t\tbreak;\n\t\t// v1.1.16: Always allocate a non-zero amount, since testing shows that SetClipboardData()\n\t\t// fails when passed a zero-length HGLOBAL, at least on Windows 8. Zero-initialize using\n\t\t// GMEM_ZEROINIT since GlobalAlloc() might return a block larger than requested. Although\n\t\t// it isn't necessarily safer (depending on what programs do with this format), it should\n\t\t// at least be more consistent than leaving it uninitialized, if anything ever uses it.\n\t\tif ( !(hglobal = GlobalAlloc(GMEM_MOVEABLE | GMEM_ZEROINIT, size + (size == 0))) )\n\t\t{\n\t\t\tg_clip.Close();\n\t\t\treturn MemoryError();\n\t\t}\n\t\tif (size) // i.e. Don't try to lock memory of size zero. It's not needed.\n\t\t{\n\t\t\tif ( !(hglobal_locked = GlobalLock(hglobal)) )\n\t\t\t{\n\t\t\t\tGlobalFree(hglobal);\n\t\t\t\tg_clip.Close();\n\t\t\t\treturn g_script.RuntimeError(ERR_INTERNAL_CALL); // Generic msg since so rare.\n\t\t\t}\n\t\t\tmemcpy(hglobal_locked, binary_contents, size);\n\t\t\tGlobalUnlock(hglobal);\n\t\t\tbinary_contents = next;\n\t\t}\n\t\t//else hglobal is just an empty format, but store it for completeness/accuracy (e.g. CF_BITMAP).\n\t\tSetClipboardData(format, hglobal); // The system now owns hglobal.\n\t}\n\n\treturn g_clip.Close();\n}\n\n\n\nResultType Var::AssignString(LPCTSTR aBuf, VarSizeType aLength, bool aExactSize)\n// Returns OK or FAIL.\n// If aBuf isn't NULL, caller must ensure that aLength is either VARSIZE_MAX (which tells us that the\n// entire strlen() of aBuf should be used) or an explicit length (can be zero) that the caller must\n// ensure is less than or equal to the total length of aBuf (if less, only a substring is copied).\n// If aBuf is NULL, the variable will be set up to handle a string of at least aLength\n// in length. In addition, if the var is the clipboard, it will be prepared for writing.\n// Any existing contents of this variable will be destroyed regardless of whether aBuf is NULL.\n// Note that aBuf's memory can safely overlap with that of this->Contents() because in that case the\n// new length of the contents will always be less than or equal to the old length, and thus no\n// reallocation/expansion is needed (such an expansion would free the source before it could be\n// written to the destination). This is because callers pass in an aBuf that is either:\n// 1) Between this->Contents() and its terminator.\n// 2) Equal to this->Contents() but with aLength passed in as shorter than this->Length().\n//\n// Caller can omit both params to set a var to be empty-string, but in that case, if the variable\n// is of large capacity, its memory will not be freed. This is by design because it allows the\n// caller to exploit its knowledge of whether the var's large capacity is likely to be needed\n// again in the near future, thus reducing the expected amount of memory fragmentation.\n// To explicitly free the memory, use Assign(\"\").\n{\n\tif (mType == VAR_ALIAS)\n\t\t// For maintainability, it seems best not to use the following method:\n\t\t// Var &var = *(mType == VAR_ALIAS ? mAliasFor : this);\n\t\t// If that were done, bugs would be easy to introduce in a long function like this one\n\t\t// if your forget at use the implicit \"this\" by accident. So instead, just call self.\n\t\treturn mAliasFor->AssignString(aBuf, aLength, aExactSize);\n\n\tbool do_assign = true; // Set defaults.\n\tbool free_it_if_large = true; //\n\tif (!aBuf)\n\t\tif (aLength == VARSIZE_MAX) // Caller omitted this param too, so it wants to assign empty string.\n\t\t{\n\t\t\tfree_it_if_large = false;\n\t\t\taLength = 0; // aBuf is set to \"\" further below.\n\t\t}\n\t\telse // Caller gave a NULL buffer to signal us to ensure the var is at least aLength in capacity.\n\t\t\tdo_assign = false;\n\telse // Caller provided a non-NULL buffer.\n\t\tif (aLength == VARSIZE_MAX) // Caller wants us to determine its length.\n\t\t\taLength = (mCharContents == aBuf) ? _CharLength() : (VarSizeType)_tcslen(aBuf); // v1.0.45: Added optimization check: (mContents == aBuf). v1.1.09.03: Replaced CharLength() with _CharLength() to avoid updating contents (probably only applicable when aBuf == Var::sEmptyString).\n\t\t//else leave aLength as the caller-specified value in case it's explicitly shorter than the apparent length.\n\tif (!aBuf)\n\t\taBuf = _T(\"\"); // From here on, make sure it's the empty string for all uses (read-only empty string vs. sEmptyString seems more appropriate in this case).\n\n\tsize_t space_needed = aLength + 1; // +1 for the zero terminator.\n\tsize_t space_needed_in_bytes = space_needed * sizeof(TCHAR);\n\n\tif (VarTypeIsVirtual(mType))\n\t{\n\t\tif (do_assign)\n\t\t\treturn AssignVirtual(ExprTokenType(const_cast<LPTSTR>(aBuf), aLength));\n\t\t// Since above didn't return, the caller wants to allocate some temporary memory for\n\t\t// writing the value into, and should call Close() in order to commit the actual value.\n\t}\n\telse if (mType == VAR_CONSTANT) // Might be impossible due to prior validation of assignments/output vars.\n\t\treturn g_script.VarIsReadOnlyError(this);\n\n\tif (space_needed < 2) // Variable is being assigned the empty string (or a deref that resolves to it).\n\t{\n\t\tFree(free_it_if_large ? VAR_FREE_IF_LARGE : VAR_NEVER_FREE); // This also makes the variable blank and removes VAR_ATTRIB_OFTEN_REMOVED.\n\t\treturn OK;\n\t}\n\n\t// On failure, things like making mByteLength 0 and mCharContents blank are not done here for performance\n\t// reasons (it seems too rare that early return/failure will occur below, since it's only due to\n\t// out-of-memory... and even if it does happen, there are probably no consequences to leaving the variable\n\t// the way it is now (rather than forcing it to be blank) since the script thread that caused the error\n\t// will be ended.\n\t// Another reason is that it seems more consistent with other causes of failure, such as for `x := 0/0`.\n\n\tif (space_needed_in_bytes > mByteCapacity)\n\t{\n\t\tsize_t new_size; // Use a new name, rather than overloading space_needed, for maintainability.\n\t\tchar *new_mem;\n\n\t\tswitch (mHowAllocated)\n\t\t{\n\t\tcase ALLOC_NONE:\n\t\tcase ALLOC_SIMPLE:\n\t\t\tif (space_needed_in_bytes <= _TSIZE(MAX_ALLOC_SIMPLE))\n\t\t\t{\n\t\t\t\t// v1.0.31: Conserve memory within large arrays by allowing elements of length 3 or 7, for such\n\t\t\t\t// things as the storage of boolean values, or the storage of short numbers (it's best to use\n\t\t\t\t// multiples of 4 for size due to byte alignment in SimpleHeap; e.g. lengths of 3 and 7).\n\t\t\t\t// Because the above checked that space_needed > mCapacity, the capacity will increase but\n\t\t\t\t// never decrease in this section, which prevent a memory leak by only ever wasting a maximum\n\t\t\t\t// of 4+8+MAX_ALLOC_SIMPLE for each variable (and then only in the worst case -- in the average\n\t\t\t\t// case, it saves memory by avoiding the overhead incurred for each separate malloc'd block).\n\t\t\t\tif (space_needed_in_bytes <= _TSIZE(4)) // Even for aExactSize, it seems best to prevent variables from having only a zero terminator in them because that would usually waste 3 bytes due to byte alignment in SimpleHeap.\n\t\t\t\t\tnew_size = _TSIZE(4); // v1.0.45: Increased from 2 to 4 to exploit byte alignment in SimpleHeap.\n\t\t\t\telse if (aExactSize) // Allows VarSetStrCapacity() to make more flexible use of SimpleHeap.\n\t\t\t\t\tnew_size = space_needed_in_bytes;\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tif (space_needed_in_bytes <= _TSIZE(8))\n\t\t\t\t\t\tnew_size = _TSIZE(8); // v1.0.45: Increased from 7 to 8 to exploit 32-bit alignment in SimpleHeap.\n\t\t\t\t\telse // space_needed <= MAX_ALLOC_SIMPLE\n\t\t\t\t\t\tnew_size = _TSIZE(MAX_ALLOC_SIMPLE);\n\t\t\t\t}\n\t\t\t\t// In the case of mHowAllocated==ALLOC_SIMPLE, the following will allocate another block\n\t\t\t\t// from SimpleHeap even though the var already had one. This is by design because it can\n\t\t\t\t// happen only a limited number of times per variable. See comments further above for details.\n\t\t\t\tif ( !(new_mem = (char *) SimpleHeap::Malloc(new_size)) )\n\t\t\t\t\treturn MemoryError(); // Leave all var members unchanged so that they're consistent with each other.\n\t\t\t\tmHowAllocated = ALLOC_SIMPLE; // In case it was previously ALLOC_NONE. This step must be done only after the alloc succeeded.\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// ** ELSE DON'T BREAK, JUST FALL THROUGH TO THE NEXT CASE. **\n\t\t\t// **\n\t\tcase ALLOC_MALLOC: // Can also reach here by falling through from above.\n\t\t\t// This case can happen even if space_needed is less than MAX_ALLOC_SIMPLE\n\t\t\t// because once a var becomes ALLOC_MALLOC, it should never change to\n\t\t\t// one of the other alloc modes. See comments higher above for explanation.\n\t\t\tnew_size = space_needed_in_bytes; // Below relies on this being initialized unconditionally.\n\t\t\tif (!aExactSize)\n\t\t\t{\n\t\t\t\t// Allow a little room for future expansion to cut down on the number of\n\t\t\t\t// free's and malloc's we expect to have to do in the future for this var:\n\t\t\t\tif (new_size < _TSIZE(16)) // v1.0.45.03: Added this new size to prevent all local variables in a recursive\n\t\t\t\t\tnew_size = _TSIZE(16); // function from having a minimum size of MAX_PATH. 16 seems like a good size because it holds nearly any number. It seems counterproductive to go too small because each malloc, no matter how small, could have around 40 bytes of overhead.\n\t\t\t\telse if (new_size < _TSIZE(MAX_PATH))\n\t\t\t\t\tnew_size = _TSIZE(MAX_PATH); // An amount that will fit all standard filenames seems good.\n\t\t\t\telse if (new_size < _TSIZE(160 * 1024)) // MAX_PATH to 160 KB or less -> 10% extra.\n\t\t\t\t\tnew_size = (size_t)(new_size * 1.1);\n\t\t\t\telse if (new_size < _TSIZE(1600 * 1024)) // 160 to 1600 KB -> 16 KB extra\n\t\t\t\t\tnew_size += _TSIZE(16 * 1024);\n\t\t\t\telse if (new_size < _TSIZE(6400 * 1024)) // 1600 to 6400 KB -> 1% extra\n\t\t\t\t\tnew_size += (new_size / 100); // Produces smaller code than (new_size * 1.01) and benchmarks the same.\n\t\t\t\telse // 6400 KB or more: Cap the extra margin at some reasonable compromise of speed vs. mem usage: 64 KB\n\t\t\t\t\tnew_size += _TSIZE(64 * 1024);\n\t\t\t}\n\t\t\t//else space_needed was already verified higher above to be within bounds.\n\n\t\t\t// In case the old memory area is large, free it before allocating the new one. This reduces\n\t\t\t// the peak memory load on the system and reduces the chance of an actual out-of-memory error.\n\t\t\tbool memory_was_freed;\n\t\t\tif (memory_was_freed = (mHowAllocated == ALLOC_MALLOC && mByteCapacity)) // Verified correct: 1) Both are checked because it might have fallen through from case ALLOC_SIMPLE; 2) mCapacity indicates for certain whether mContents contains the empty string.\n\t\t\t\tfree(mByteContents); // The other members are left temporarily out-of-sync for performance (they're resync'd only if an error occurs).\n\t\t\t//else mContents contains a \"\" or it points to memory on SimpleHeap, so don't attempt to free it.\n\n\t\t\tif ( !(new_mem = (char *)malloc(new_size)) )\n\t\t\t{\n\t\t\t\tif (memory_was_freed) // Resync members to reflect the fact that it was freed (it's done this way for performance).\n\t\t\t\t{\n\t\t\t\t\tmByteLength = 0;\n\t\t\t\t\tmByteCapacity = 0; // Invariant: Anyone setting mCapacity to 0 must also set\n\t\t\t\t\tmCharContents = sEmptyString; // mContents to the empty string.\n\t\t\t\t\tif (mAttrib & (VAR_ATTRIB_IS_INT64 | VAR_ATTRIB_IS_DOUBLE))\n\t\t\t\t\t\tmAttrib |= VAR_ATTRIB_CONTENTS_OUT_OF_DATE; // Since the cached string (if any) was freed.\n\t\t\t\t\telse if ((mAttrib & VAR_ATTRIB_TYPES) == 0) // Value was a string and was freed above.\n\t\t\t\t\t\tmAttrib |= VAR_ATTRIB_UNINITIALIZED; // Since it does not have either of its expected values.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// IMPORTANT: It's the empty string (a constant) or it points to memory on SimpleHeap, so don't\n\t\t\t\t\t// change mContents/Capacity (that would cause a memory leak for reasons described elsewhere).\n\t\t\t\t\t// Leave mAttrib as-is so that any existing value is left unchanged. This is consistent\n\t\t\t\t\t// with the ALLOC_SIMPLE failure case and other aborted assignments, such as `x := 0/0`.\n\t\t\t\t}\n\t\t\t\treturn MemoryError();\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// Below is necessary because it might have fallen through from case ALLOC_SIMPLE.\n\t\t\t\t// This step must be done only after the alloc succeeded (because otherwise, we want to keep it\n\t\t\t\t// set to ALLOC_SIMPLE (fall-through), if that's what it was).\n\t\t\t\tmHowAllocated = ALLOC_MALLOC;\n\t\t\t}\n\t\t\tbreak;\n\t\t\n\t\tdefault:\n\t\t\t// ALLOC_DISABLED: Vars constructed with Var::Var(IObject*) use this for error detection.\n\t\t\tASSERT(FALSE);\n\t\t\treturn FAIL;\n\t\t} // switch()\n\n\t\t// Since above didn't return, the alloc succeeded. Because that's true, all the members (except those\n\t\t// set in their sections above) are updated together so that they stay consistent with each other:\n\t\tmByteContents = new_mem;\n\t\tmByteCapacity = (VarSizeType)new_size;\n\t} // if (space_needed > mCapacity)\n\n\tif (do_assign)\n\t{\n\t\t// Above has ensured that space_needed is either strlen(aBuf)-1 or the length of some\n\t\t// substring within aBuf starting at aBuf. However, aBuf might overlap mContents or\n\t\t// even be the same memory address (due to something like GlobalVar := YieldGlobalVar(),\n\t\t// in which case ACT_ASSIGNEXPR calls us to assign GlobalVar to GlobalVar).\n\t\tif (mCharContents != aBuf)\n\t\t{\n\t\t\t// Don't use strlcpy() or such because:\n\t\t\t// 1) Caller might have specified that only part of aBuf's total length should be copied.\n\t\t\t// 2) mContents and aBuf might overlap (see above comment), in which case strcpy()'s result\n\t\t\t// is undefined, but memmove() is guaranteed to work (and performs about the same).\n\t\t\ttmemmove(mCharContents, aBuf, aLength); // Some callers such as RegEx routines might rely on this copying binary zeroes over rather than stopping at the first binary zero.\n\t\t}\n\t\t//else nothing needs to be done since source and target are identical. Some callers probably rely on\n\t\t// this optimization.\n\t\tmCharContents[aLength] = '\\0'; // v1.0.45: This is now done unconditionally in case caller wants to shorten a variable's existing contents (no known callers do this, but it helps robustness).\n\t}\n\telse // Caller only wanted the variable resized as a preparation for something it will do later.\n\t{\n\t\t// Init for greater robustness/safety (the ongoing conflict between robustness/redundancy and performance).\n\t\t// This has been in effect for so long that some callers probably rely on it.\n\t\t*mCharContents = '\\0'; // If it's sEmptyString, that's okay too because it's writable.\n\t\t// We've done everything except the actual assignment. Let the caller handle that.\n\t\t// Also, the length will be set below to the expected length in case the caller\n\t\t// doesn't override this.\n\t\t// Below: Already verified that the length value will fit into VarSizeType.\n\t}\n\n\t// Writing to union is safe because above already ensured that \"this\" isn't an alias.\n\tmByteLength = aLength * sizeof(TCHAR); // aLength was verified accurate higher above.\n\t\n\tif (VarTypeIsVirtual(mType))\n\t{\n\t\t// This tells Contents() not to call mVV->Get():\n\t\tmAttrib |= VAR_ATTRIB_VIRTUAL_OPEN;\n\t\treturn OK;\n\t}\n\n\t// Update mAttrib and release any object last, after it is known that the assignment has\n\t// succeeded, and the new value is fully in place. This avoids issues of reentrancy due\n\t// to Release triggering a __Delete method.\n\tauto release_me = (mAttrib & VAR_ATTRIB_IS_OBJECT) ? mObject : nullptr;\n\tmAttrib &= ~(VAR_ATTRIB_OFTEN_REMOVED | VAR_ATTRIB_IS_OBJECT);\n\tif (release_me)\n\t\trelease_me->Release();\n\treturn OK;\n}\n\n\n\nResultType Var::AssignBinaryNumber(__int64 aNumberAsInt64, VarAttribType aAttrib)\n{\n\tif (mType == VAR_ALIAS)\n\t\treturn mAliasFor->AssignBinaryNumber(aNumberAsInt64, aAttrib);\n\n\tif (VarTypeIsVirtual(mType))\n\t{\n\t\t// Virtual vars have no binary number cache, as their value may be calculated on-demand.\n\t\t// Additionally, THE CACHE MUST NOT BE USED due to the union containing mVV.\n\t\tExprTokenType value;\n\t\tvalue.symbol = (aAttrib & VAR_ATTRIB_IS_INT64) ? SYM_INTEGER : SYM_FLOAT;\n\t\tvalue.value_int64 = aNumberAsInt64;\n\t\treturn AssignVirtual(value);\n\t}\n\telse if (mType == VAR_CONSTANT) // Might be impossible due to prior validation of assignments/output vars.\n\t\treturn g_script.VarIsReadOnlyError(this);\n\n\tauto release_me = (mAttrib & VAR_ATTRIB_IS_OBJECT) ? mObject : nullptr;\n\n\tmContentsInt64 = aNumberAsInt64;\n\tmAttrib &= ~(VAR_ATTRIB_TYPES | VAR_ATTRIB_NOT_NUMERIC | VAR_ATTRIB_UNINITIALIZED);\n\tmAttrib |= (VAR_ATTRIB_CONTENTS_OUT_OF_DATE | aAttrib); // aAttrib indicates the type of binary number.\n\n\t// Call Release only after completing the assignment, as Release may cause __Delete to execute.\n\tif (release_me)\n\t\trelease_me->Release();\n\treturn OK;\n}\n\n\n\nResultType Var::AssignSkipAddRef(IObject *aValueToAssign)\n{\n\tif (mType == VAR_ALIAS)\n\t\treturn mAliasFor->AssignSkipAddRef(aValueToAssign);\n\n\tif (VarTypeIsVirtual(mType))\n\t{\n\t\tauto result = AssignVirtual(ExprTokenType(aValueToAssign));\n\t\taValueToAssign->Release(); // Caller wanted us to take responsibility for this.\n\t\treturn result;\n\t}\n\n\tif (mAttrib & VAR_ATTRIB_IS_OBJECT)\n\t{\n\t\tauto obj = mObject;\n\t\tmObject = aValueToAssign; // Replace the object. mAttrib should already be correct.\n\t\tobj->Release(); // Called after the assignment in case it triggers __Delete.\n\t\treturn OK;\n\t}\n\n\tFree(); // Free any dynamic memory.\n\t\t\n\t// Already done by Free() above:\n\t//mAttrib &= ~(VAR_ATTRIB_OFTEN_REMOVED | VAR_ATTRIB_UNINITIALIZED);\n\n\t_SetObject(aValueToAssign);\n\t\n\treturn OK;\n}\n\n\n\nvoid Var::Get(ResultToken &aResultToken)\n{\n\tif (mType == VAR_ALIAS)\n\t\treturn mAliasFor->Get(aResultToken);\n\tif (mType == VAR_VIRTUAL)\n\t{\n\t\taResultToken.symbol = SYM_INTEGER; // For _f_return_i() and consistency with BIFs.\n\t\treturn mVV->Get(aResultToken, mName);\n\t}\n\tif (mType != VAR_VIRTUAL_OBJ)\n\t\treturn ToToken(aResultToken);\n\tif (mObject->Invoke(aResultToken, IT_GET | IF_BYPASS_METAFUNC, _T(\"__Value\"), ExprTokenType(mObject), nullptr, 0) == INVOKE_NOT_HANDLED)\n\t\taResultToken.UnknownMemberError(ExprTokenType(mObject), IT_GET, _T(\"__Value\"));\n}\n\n\n\nvoid Var::Free(int aWhenToFree)\n// The name \"Free\" is a little misleading because this function:\n// ALWAYS sets the variable to be blank (except for static variables and aExcludeAliases==true).\n// BUT ONLY SOMETIMES frees the memory, depending on various factors described further below.\n// Caller must be aware that ALLOC_SIMPLE (due to its nature) is never freed.\n// aClearAliasesAndRequireInit may be split into two if any caller ever wants to pass\n// true for one and not the other.\n{\n\t// Not checked because VAR_VIRTUAL uses this to free its temporary buffer:\n\t//if (mType != VAR_NORMAL) // For robustness, since callers generally shouldn't call it this way.\n\t//\treturn;\n\n\tif (mType == VAR_ALIAS) // For simplicity and reduced code size, just make a recursive call to self.\n\t{\n\t\tif (!(aWhenToFree & VAR_CLEAR_ALIASES))\n\t\t{\n\t\t\t// For maintainability, it seems best not to use the following method:\n\t\t\t// Var &var = *(mType == VAR_ALIAS ? mAliasFor : this);\n\t\t\t// If that were done, bugs would be easy to introduce in a long function like this one\n\t\t\t// if your forget at use the implicit \"this\" by accident. So instead, just call self.\n\t\t\tmAliasFor->Free(aWhenToFree);\n\t\t\treturn;\n\t\t}\n\t\tmType = VAR_NORMAL; // Revert alias to normal variable.\n\t}\n\telse if (mType == VAR_VIRTUAL_OBJ)\n\t{\n\t\tif (!(aWhenToFree & VAR_CLEAR_ALIASES))\n\t\t{\n\t\t\tASSERT(FALSE);\n\t\t\treturn;\n\t\t}\n\t\tmType = VAR_NORMAL; // Revert alias to normal variable.\n\t}\n\n\tmByteLength = 0; // Writing to union is safe because above already ensured that \"this\" isn't an alias.\n\t// Even if it isn't free'd, variable will be made blank. So it seems proper to always remove\n\t// the uninitialized attribute (since *we* are initializing it). Some callers may rely on us\n\t// removing these attributes:\n\tmAttrib &= ~(VAR_ATTRIB_OFTEN_REMOVED | VAR_ATTRIB_VIRTUAL_OPEN);\n\n\tif (aWhenToFree & VAR_REQUIRE_INIT)\n\t\t// Caller requires this var to be considered uninitialized from now on. This attribute may\n\t\t// have been removed above, but there was no cost involved. It might not have been set in\n\t\t// the first place, so we must add it here anyway:\n\t\tmAttrib |= VAR_ATTRIB_UNINITIALIZED;\n\n\tif (mAttrib & VAR_ATTRIB_IS_OBJECT)\n\t{\n\t\tmAttrib &= ~VAR_ATTRIB_IS_OBJECT;\n\t\tmObject->Release(); // Called after removing the attribute in case it triggers __Delete.\n\t\treturn; // Must return at this point since __Delete may have assigned some other value.\n\t}\n\n\tswitch (mHowAllocated)\n\t{\n\t// Shouldn't be necessary to check the following because by definition, ALLOC_NONE\n\t// means mContents==sEmptyString (this policy is enforced in other places).\n\t//\n\t//case ALLOC_NONE:\n\t//\tmContents = sEmptyString;\n\t//\tbreak;\n\n\tcase ALLOC_SIMPLE:\n\t\t// Don't set to sEmptyString because then we'd have a memory leak. i.e. once a var becomes\n\t\t// ALLOC_SIMPLE, it should never become ALLOC_NONE again (though it can become ALLOC_MALLOC).\n\t\t*mCharContents = '\\0';\n\t\tbreak;\n\n\tcase ALLOC_MALLOC:\n\t\t// Setting a var whose contents are very large to be nothing or blank is currently the\n\t\t// only way to free up the memory of that var. Shrinking it dynamically seems like it\n\t\t// might introduce too much memory fragmentation and overhead (since in many cases,\n\t\t// it would likely need to grow back to its former size in the near future). So we\n\t\t// only free relatively large vars:\n\t\tif (mByteCapacity)\n\t\t{\n\t\t\t// aWhenToFree & VAR_FREE_IF_LARGE: the memory is not freed if it is a small area because\n\t\t\t// it might help reduce memory fragmentation and improve performance in cases where\n\t\t\t// the memory will soon be needed again (in which case one free+malloc is saved).\n\t\t\tif ( (aWhenToFree & VAR_ALWAYS_FREE)\n\t\t\t\t|| (aWhenToFree & VAR_FREE_IF_LARGE) && mByteCapacity > 4096 )\n\t\t\t{\n\t\t\t\tfree(mByteContents);\n\t\t\t\tmByteCapacity = 0; // Invariant: Anyone setting mCapacity to 0 must also set\n\t\t\t\tmCharContents = sEmptyString; // mContents to the empty string.\n\t\t\t\t// BUT DON'T CHANGE mHowAllocated to ALLOC_NONE (see comments further below).\n\t\t\t}\n\t\t\telse // Don't actually free it, but make it blank (callers rely on this).\n\t\t\t\t*mCharContents = '\\0';\n\t\t}\n\t\t//else mCapacity==0, so mContents is already the empty string, so don't attempt to free\n\t\t// it or assign to it. It was the responsibility of whoever set mCapacity to 0 to ensure mContents\n\t\t// was set properly (which is why it's not done here).\n\n\t\t// But do not change mHowAllocated to be ALLOC_NONE because it would cause a\n\t\t// a memory leak in this sequence of events:\n\t\t// var1 is assigned something short enough to make it ALLOC_SIMPLE\n\t\t// var1 is assigned something large enough to require malloc()\n\t\t// var1 is set to empty string and its mem is thus free()'d by the above.\n\t\t// var1 is once again assigned something short enough to make it ALLOC_SIMPLE\n\t\t// The last step above would be a problem because the 2nd ALLOC_SIMPLE can't\n\t\t// reclaim the spot in SimpleHeap that had been in use by the first. In other\n\t\t// words, when a var makes the transition from ALLOC_SIMPLE to ALLOC_MALLOC,\n\t\t// its ALLOC_SIMPLE memory is lost to the system until the program exits.\n\t\t// But since this loss occurs at most once per distinct variable name,\n\t\t// it's not considered a memory leak because the loss can't exceed a fixed\n\t\t// amount regardless of how long the program runs. The reason for all of this\n\t\t// is that allocating dynamic memory is costly: it causes system memory fragmentation,\n\t\t// (especially if a var were to be malloc'd and free'd thousands of times in a loop)\n\t\t// and small-sized mallocs have a large overhead: it's been said that every block\n\t\t// of dynamic mem, even those of size 1 or 2, incurs about 40 bytes of overhead\n\t\t// (and testing of SimpleHeap supports this).\n\t\t// UPDATE: Yes it's true that a script could create an unlimited number of new variables\n\t\t// by constantly using different dynamic names when creating them. But it's still supportable\n\t\t// that there's no memory leak because even if the worst-case series of events mentioned\n\t\t// higher above occurs for every variable, only a fixed amount of memory is ever lost per\n\t\t// variable. So you could think of the lost memory as part of the basic overhead of creating\n\t\t// a variable (since variables are never truly destroyed, just their contents freed).\n\t\t// The odds against all of these worst-case factors occurring simultaneously in anything other\n\t\t// than a theoretical test script seem nearly astronomical.\n\t\tbreak;\n\t} // switch()\n}\n\n\n\nResultType Var::AppendIfRoom(LPTSTR aStr, VarSizeType aLength)\n// Returns OK if there's room enough to append aStr and it succeeds.\n// Returns FAIL otherwise (also returns FAIL for VAR_VIRTUAL).\n// Environment variables aren't supported here; instead, aStr is appended directly onto the actual/internal\n// contents of the \"this\" variable.\n{\n\tif (mType == VAR_ALIAS)\n\t\treturn mAliasFor->AppendIfRoom(aStr, aLength);\n\tif (mType != VAR_NORMAL // e.g. VAR_VIRTUAL. Some callers do call it this way, but even if not it should be kept for maintainability.\n\t\t|| IsObject()) // Let caller free it; not worth handling here.\n\t\treturn FAIL; // CHECK THIS FIRST, BEFORE BELOW, BECAUSE CALLERS ALWAYS WANT IT TO BE A FAILURE.\n\tif (aLength)\n\t{\n\t\tVarSizeType var_length = Length(); // Get the apparent length because one caller is a concat that wants consistent behavior of the .= operator regardless of whether this shortcut succeeds or not.\n\t\tVarSizeType new_length = var_length + aLength;\n\t\tif (new_length >= _CharCapacity()) // Not enough room.\n\t\t\treturn FAIL;\n\t\ttmemmove(mCharContents + var_length, aStr, aLength); // mContents was updated via Length() above. Use memmove() vs. memcpy() in case there's any overlap between source and dest.\n\t\tmCharContents[new_length] = '\\0'; // Terminate it as a separate step in case caller passed a length shorter than the apparent length of aStr.\n\t\tmByteLength = new_length * sizeof(TCHAR);\n\t}\n\t// Even if nothing was appended above, set the attributes so n:=1,n.=\"\" produces a String, not an Integer.\n\t// If this is a binary-clip variable, appending has probably \"corrupted\" it; so don't allow it to ever be\n\t// put back onto the clipboard as binary data (the routine that does that is designed to detect corruption,\n\t// but it might not be perfect since corruption is so rare). Also remove the other flags that are no longer\n\t// appropriate:\n\tmAttrib &= ~VAR_ATTRIB_OFTEN_REMOVED; // This also removes VAR_ATTRIB_NOT_NUMERIC because appending some digits to an empty variable would make it numeric.\n\treturn OK;\n}\n\n\n\nResultType Var::Append(LPTSTR aStr, VarSizeType aLength)\n// Caller must ensure that Type() == VAR_NORMAL.\n{\n\tif (mType == VAR_ALIAS)\n\t\treturn mAliasFor->Append(aStr, aLength);\n\tif (AppendIfRoom(aStr, aLength))\n\t\treturn OK;\n\t// Since above didn't return, we need to allocate space and postpone freeing our current value\n\t// until after it is copied into the new buffer. The following relies on AppendIfRoom() always\n\t// succeeding if there is room and the var has non-zero length; otherwise AssignString() would\n\t// null-terminate the old contents at position 0 and the result would be incorrect.\n\tLPTSTR old_contents = mCharContents; // Caller has ensured UpdateContents() was called if necessary.\n\tVarSizeType old_length = _CharLength();\n\tVarSizeType old_capacity = (mHowAllocated == ALLOC_MALLOC) ? mByteCapacity : 0;\n\tif (old_capacity)\n\t\tmByteCapacity = 0; // Prevent the call below from freeing it.\n\tif (!AssignString(NULL, _CharLength() + aLength))\n\t{\n\t\tmByteCapacity = old_capacity; // Restore this since the contents are being left as is.\n\t\treturn FAIL;\n\t}\n\ttmemcpy(mCharContents, old_contents, old_length);\n\ttmemcpy(mCharContents + old_length, aStr, aLength + 1);\n\tif (old_capacity)\n\t\tfree(old_contents);\n\treturn OK;\n}\n\n\n\nResultType Var::AcceptNewMem(LPTSTR aNewMem, VarSizeType aLength)\n// Caller provides a new malloc'd memory block (currently must be non-NULL). That block and its\n// contents are directly hung onto this variable in place of its old block, which is freed (except\n// in the case of VAR_VIRTUAL, in which case the memory is passed to mVV->Set() then freed).\n// This function was added in v1.0.45 to aid callers in improving performance.\n{\n\tif (mType == VAR_ALIAS)\n\t\treturn mAliasFor->AcceptNewMem(aNewMem, aLength);\n\tif (mType != VAR_NORMAL)\n\t{\n\t\tauto result = Assign(aNewMem, aLength);\n\t\tfree(aNewMem); // Caller gave it to us to take charge of, but we have no further use for it.\n\t\treturn result;\n\t}\n\telse // VAR_NORMAL\n\t{\n\t\t_AcceptNewMem(aNewMem, aLength);\n\t\treturn OK;\n\t}\n}\n\n\n\nvoid Var::_AcceptNewMem(LPTSTR aNewMem, VarSizeType aLength)\n// Called by AcceptNewMem() when mType == VAR_NORMAL.\n// Called by PopulateVirtualVar() when mType == VAR_VIRTUAL.\n{\n\tFree(VAR_ALWAYS_FREE); // Release the variable's old memory. This also removes flags VAR_ATTRIB_OFTEN_REMOVED.\n\tmHowAllocated = ALLOC_MALLOC; // Must always be this type to avoid complications and possible memory leaks.\n\tmByteContents = (char *) aNewMem;\n\tif (aLength == VARSIZE_MAX)\n\t\taLength = _tcslen(aNewMem);\n\tmByteLength = aLength * sizeof(TCHAR);\n\tASSERT( mByteLength + sizeof(TCHAR) <= _msize(aNewMem) );\n\tmByteCapacity = (VarSizeType)_msize(aNewMem); // Get actual capacity in case it's a lot bigger than aLength+1. _msize() is only about 36 bytes of code and probably a very fast call.\n\t// Already done by Free() above:\n\t//mAttrib &= ~VAR_ATTRIB_OFTEN_REMOVED; // New memory is always non-binary-clip. A new parameter could be added to change this if it's ever needed.\n\n\t// Shrink the memory if there's a lot of wasted space because the extra capacity is seldom utilized\n\t// in real-world scripts.\n\t// A simple rule seems best because shrinking is probably fast regardless of the sizes involved,\n\t// plus and there's considerable rarity to ever needing capacity beyond what's in a variable\n\t// (concat/append is one example). This will leave a large percentage of extra space in small variables,\n\t// but in those rare cases when a script needs to create thousands of such variables, there may be a\n\t// current or future way to shrink an existing variable to contain only its current length, such as\n\t// VarShrink().\n\tif (mByteCapacity - mByteLength > 64)\n\t{\n\t\t// _expand() is only about 75 bytes of uncompressed code size and probably performs very quickly\n\t\t// when shrinking. MSDN implies that when shrinking, failure won't happen unless something is\n\t\t// terribly wrong (e.g. corrupted heap), but it's known to fail in other cases, such as when\n\t\t// called by AutoHotkey running as a Windows store app.\n\t\tif (_expand(mByteContents, mByteLength + sizeof(TCHAR)))\n\t\t\t// Update capacity only after successfully shrinking:\n\t\t\tmByteCapacity = mByteLength + sizeof(TCHAR);\n\t\t// The block is left unchanged on failure, so in that case leave everything as is.\n\t}\n}\n\n\n\nvoid Var::SetLengthFromContents()\n// Function added in v1.0.43.06. It updates the mLength member to reflect the actual current length of mContents.\n// Caller must ensure that Type() is VAR_NORMAL.\n{\n\tif (mType == VAR_ALIAS)\n\t\treturn mAliasFor->SetLengthFromContents();\n\tif (mAttrib & VAR_ATTRIB_CONTENTS_OUT_OF_DATE)\n\t{\n\t\tUpdateContents(); // Set contents and length based on numeric value.\n\t\treturn;\n\t}\n\tsize_t length = 0;\n\tLPTSTR contents = mCharContents;\n\tsize_t max_count = mByteCapacity / sizeof(TCHAR);\n\t// Since the performance cost is low, ensure the string is terminated at the limit of its\n\t// capacity (helps prevent crashes if DLL function didn't do its job and terminate the string,\n\t// or when a function is called that deliberately doesn't terminate the string, such as\n\t// RtlMoveMemory()).\n\tif (max_count == 0)\n\t\tmax_count = 1; // Contents() == Var::sEmptyString in this case, so check it hasn't been tampered with.\n\tlength = _tcsnlen(contents, max_count);\n\tif (length == max_count)\n\t\tg_script.CriticalError(ERR_STRING_NOT_TERMINATED, mName);\n\tmByteLength = _TSIZE(length);\n}\n\n\n\nResultType Var::BackupFunctionVars(UserFunc &aFunc, VarBkp *&aVarBackup, int &aVarBackupCount)\n// All parameters except the first are output parameters that are set for our caller (though caller\n// is responsible for having initialized aVarBackup to NULL).\n// If there is nothing to backup, only the aVarBackupCount is changed (to zero).\n// Returns OK or FAIL.\n{\n\tif ( !(aVarBackupCount = aFunc.mVars.mCount) ) // Nothing needs to be backed up.\n\t\treturn OK; // Leave aVarBackup set to NULL as set by the caller.\n\n\t// NOTES ABOUT MALLOC(): Apparently, the implementation of malloc() is quite good, at least for small blocks\n\t// needed to back up 50 or less variables. It nearly as fast as alloca(), at least when the system\n\t// isn't under load and has the memory to spare without swapping. Therefore, the attempt to use alloca to\n\t// speed up recursive script-functions didn't result in enough of a speed-up (only 1 to 5%) to be worth the\n\t// added complexity.\n\t// Since Var is not a POD struct (it contains private members, a custom constructor, etc.), the VarBkp\n\t// POD struct is used to hold the backup because it's probably better performance than using Var's\n\t// constructor to create each backup array element.\n\tif ( !(aVarBackup = (VarBkp *)malloc(aVarBackupCount * sizeof(VarBkp))) ) // Caller will take care of freeing it.\n\t\treturn FAIL;\n\n\tint i;\n\taVarBackupCount = 0; // Init only once prior to both loops. aVarBackupCount is being \"overloaded\" to track the current item in aVarBackup, BUT ALSO its being updated to an actual count in case some statics are omitted from the array.\n\n\t// Note that Backup() does not make the variable empty after backing it up because that is something\n\t// that must be done by our caller at a later stage.\n\tfor (i = 0; i < aFunc.mVars.mCount; ++i)\n\t\taFunc.mVars.mItem[i]->Backup(aVarBackup[aVarBackupCount++]);\n\treturn OK;\n}\n\n\n\nvoid Var::Backup(VarBkp &aVarBkp)\n// Caller must not call this function for static variables because it's not equipped to deal with them\n// (they don't need to be backed up or restored anyway).\n// This method is used rather than struct copy (=) because it's of expected higher performance than\n// using the Var::constructor to make a copy of each var. Also note that something like memcpy()\n// can't be used on Var objects since they're not POD (e.g. they have a constructor and they have\n// private members).\n{\n\taVarBkp.mVar = this; // Allows the restoration process to always know its target without searching.\n\taVarBkp.mByteContents = mByteContents;\n\taVarBkp.mContentsInt64 = mContentsInt64; // This also copies the other members of the union: mContentsDouble, mObject.\n\taVarBkp.mByteLength = mByteLength; // Since it's a union, it might actually be backing up mAliasFor (happens at least for recursive functions that pass parameters ByRef).\n\taVarBkp.mByteCapacity = mByteCapacity;\n\taVarBkp.mHowAllocated = mHowAllocated; // This might be ALLOC_SIMPLE or ALLOC_NONE if backed up variable was at the lowest layer of the call stack.\n\taVarBkp.mAttrib = mAttrib;\n\taVarBkp.mType = mType; // Fix for v1.0.47.06: Must also back up and restore mType in case an optional ByRef parameter is omitted by one call by specified by another thread that interrupts the first thread's call.\n\t// Once the backup is made, Free() is not called because the whole point of the backup is to\n\t// preserve the original memory/contents of each variable. Instead, clear the variable\n\t// completely and set it up to become ALLOC_MALLOC in case anything actually winds up using\n\t// the variable prior to the restoration of the backup. In other words, ALLOC_SIMPLE and NONE\n\t// retained (if present) because that would cause a memory leak when multiple layers are all\n\t// allowed to use ALLOC_SIMPLE yet none are ever able to free it (the bottommost layer is\n\t// allowed to use ALLOC_SIMPLE because that's a fixed/constant amount of memory gets freed\n\t// when the program exits).\n\t// Now reset this variable (caller has ensured it's non-static) to create a \"new layer\" for it, keeping\n\t// its backup intact but allowing this variable (or formal parameter) to be given a new value in the future:\n\tmByteCapacity = 0; // Invariant: Anyone setting mCapacity to 0 must also set...\n\tmCharContents = sEmptyString; // ...mContents to the empty string.\n\tmByteLength = 0;\n\tmType = VAR_NORMAL;\n\tmHowAllocated = ALLOC_MALLOC; // Never NONE because that would permit SIMPLE. See comments higher above.\n\tmAttrib = VAR_ATTRIB_UNINITIALIZED; // The function's new recursion layer should consider this var uninitialized, even if it was initialized by the previous layer.\n}\n\n\n\nvoid Var::Restore(VarBkp &aVarBkp)\n{\n\tmByteContents = aVarBkp.mByteContents;\n\tmContentsInt64 = aVarBkp.mContentsInt64; // This also copies the other members of the union: mContentsDouble, mObject.\n\tmByteLength = aVarBkp.mByteLength; // Since it's a union, it might actually be restoring mAliasFor, which is desired.\n\tmByteCapacity = aVarBkp.mByteCapacity;\n\tmHowAllocated = aVarBkp.mHowAllocated; // This might be ALLOC_SIMPLE or ALLOC_NONE if backed-up variable was at the lowest layer of the call stack.\n\tmAttrib = aVarBkp.mAttrib;\n\tmType = aVarBkp.mType;\n}\n\n\n\nvoid Var::FreeAndRestoreFunctionVars(UserFunc &aFunc, VarBkp *&aVarBackup, int &aVarBackupCount)\n{\n\tint i;\n\tfor (i = 0; i < aFunc.mVars.mCount; ++i)\n\t\taFunc.mVars.mItem[i]->Free(VAR_ALWAYS_FREE | VAR_CLEAR_ALIASES | VAR_REQUIRE_INIT); // Clear aliases, since their targets should not be freed (they don't belong to this function).\n\n\t// The freeing (above) MUST be done prior to the restore-from-backup below (otherwise there would be\n\t// a memory leak). Static variables are never backed up and thus do not exist in the aVarBackup array.\n\t// This is because by definition, the contents of statics are not freed or altered by the calling procedure\n\t// (regardless how recursive or multi-threaded the function is).\n\tif (aVarBackup) // This is the indicator that a backup was made; thus a restore is also needed.\n\t{\n\t\tfor (i = 0; i < aVarBackupCount; ++i) // Static variables were never backed up so they won't be in this array. See comments above.\n\t\t{\n\t\t\tVarBkp &bkp = aVarBackup[i];\n\t\t\tbkp.mVar->Restore(bkp);\n\t\t}\n\t\tfree(aVarBackup);\n\t\taVarBackup = NULL; // Some callers want this reset; it's an indicator of whether the next function call in this expression (if any) will have a backup.\n\t}\n}\n\n\n\n// Used by the debugger.\nvoid VarBkp::ToToken(ExprTokenType &aValue)\n{\n\tswitch (mAttrib & VAR_ATTRIB_TYPES)\n\t{\n\tcase VAR_ATTRIB_IS_OBJECT: aValue.SetValue(mObject); break;\n\tcase VAR_ATTRIB_IS_INT64: aValue.SetValue(mContentsInt64); break;\n\tcase VAR_ATTRIB_IS_DOUBLE: aValue.SetValue(mContentsDouble); break;\n\tdefault:\n\t\tif (mAttrib & VAR_ATTRIB_UNINITIALIZED)\n\t\t\taValue.symbol = SYM_MISSING;\n\t\telse\n\t\t\taValue.SetValue(mCharContents, mByteLength / sizeof(TCHAR));\n\t}\n}\n\n\n\n// Without __declspec(noinline), this produced larger code than the original, which had\n// the code essentially repeated in ValidateName(). There's no good reason to inline\n// this function (or other functions which are only called to display an error dialog).\n__declspec(noinline)\nResultType DisplayNameError(LPCTSTR aErrorFormat, int aDisplayError, LPCTSTR aName)\n{\n\tif (!aDisplayError)\n\t\treturn FAIL;\n\tstatic LPCTSTR sErrorSubject[] = VALIDATENAME_SUBJECTS;\n\tTCHAR msg[512];\n\tsntprintf(msg, _countof(msg), aErrorFormat\n\t\t, sErrorSubject[VALIDATENAME_SUBJECT_INDEX(aDisplayError)]\n\t\t, aName);\n\treturn g_script.ScriptError(msg);\n}\n\n\n\nResultType Var::ValidateName(LPCTSTR aName, int aDisplayError)\n// Returns OK or FAIL.\n{\n\tif (!*aName) return FAIL; // Shouldn't be called this way.\n\t\n\t// Seems best to disallow variables that start with numbers for purity, to allow\n\t// something like 1e3 to be scientific notation, and possibly other reasons.\n\tif (*aName >= '0' && *aName <= '9')\n\t{\n\t\treturn DisplayNameError(_T(\"This %s name starts with a number, which is not allowed:\\n\\\"%-1.300s\\\"\"), aDisplayError, aName);\n\t}\n\tif (*find_identifier_end(aName) != '\\0')\n\t{\n\t\treturn DisplayNameError(_T(\"The following %s name contains an illegal character:\\n\\\"%-1.300s\\\"\"), aDisplayError, aName);\n\t}\n\tif (aDisplayError == DISPLAY_METHOD_ERROR || aDisplayError == DISPLAY_GROUP_ERROR)\n\t\treturn OK;\n\t// Reserve names of control flow statements. Aside from being more \"pure\" and allowing\n\t// future improvements, it should also help catch syntax errors such as \"if (foo) break\".\n\t// Note that since these statements allow parentheses, they only get here for variable names.\n\t// Reserve operator keywords. This makes ACT_ASSIGNEXPR more consistent with ACT_EXPRESSION,\n\t// such as for \"and := 1\" vs. \"(and := 1)\", though a different error message is given.\n\tif ( Script::ConvertActionType(aName)\n\t\t|| Script::ConvertWordOperator(aName, _tcslen(aName))\n\t\t|| !_tcsicmp(aName, _T(\"True\")) || !_tcsicmp(aName, _T(\"False\")) || !_tcsicmp(aName, _T(\"Throw\")) )\n\t{\n\t\treturn DisplayNameError(_T(\"The following reserved word must not be used as a %s name:\\n\\\"%-1.300s\\\"\"), aDisplayError, aName);\n\t}\n\t// Otherwise:\n\treturn OK;\n}\n\n\n\nResultType Var::AssignStringFromCodePage(LPCSTR aBuf, int aLength, UINT aCodePage)\n{\n#ifndef UNICODE\n\t// Not done since some callers have a more effective optimization in place:\n\t//if (aCodePage == CP_ACP || aCodePage == GetACP())\n\t\t// Avoid unnecessary conversion (ACP -> UTF16 -> ACP).\n\t\t//return AssignString(aBuf, aLength, true, false);\n\t// Convert from specified codepage to UTF-16,\n\tCStringWCharFromChar wide_buf(aBuf, aLength, aCodePage);\n\t// then back to the active codepage:\n\treturn AssignStringToCodePage(wide_buf, wide_buf.GetLength(), CP_ACP);\n#else\n\tint iLen = MultiByteToWideChar(aCodePage, 0, aBuf, aLength, NULL, 0);\n\tif (iLen > 0) {\n\t\tif (!AssignString(NULL, iLen, true))\n\t\t\treturn FAIL;\n\t\tLPWSTR aContents = Contents(TRUE);\n\t\tiLen = MultiByteToWideChar(aCodePage, 0, aBuf, aLength, (LPWSTR) aContents, iLen);\n\t\t// A return value of 0 is not ambiguous here, but any failure is more likely to occur\n\t\t// in the first call. For consistency (see below), let the var be blank on error.\n\t\tif (aLength == -1 && iLen)\n\t\t\t--iLen; // Exclude the null-terminator.\n\t\telse\n\t\t\taContents[iLen] = 0;\n\t\tSetCharLength(iLen);\n\t}\n\telse\n\t\tAssign(); // Return value is ambiguous in this case: may be zero-length input or an error. For simplicity, return OK.\n\treturn OK;\n#endif\n}\n\n\n\nResultType Var::AssignStringToCodePage(LPCWSTR aBuf, int aLength, UINT aCodePage, DWORD aFlags, char aDefChar)\n{\n\tchar *pDefChar;\n\tif (aCodePage == CP_UTF8 || aCodePage == CP_UTF7) {\n\t\tpDefChar = NULL;\n\t\taFlags = 0;\n\t}\n\telse\n\t\tpDefChar = &aDefChar;\n\tint iLen = WideCharToMultiByte(aCodePage, aFlags, aBuf, aLength, NULL, 0, pDefChar, NULL);\n\tif (iLen > 0) {\n\t\tif (!SetCapacity(iLen, true))\n\t\t\treturn FAIL;\n\t\tLPSTR aContents = (LPSTR) Contents(TRUE);\n\t\tiLen = WideCharToMultiByte(aCodePage, aFlags, aBuf, aLength, aContents, iLen, pDefChar, NULL);\n\t\taContents[iLen] = 0;\n\t\tif (!iLen)\n\t\t\treturn FAIL;\n#ifndef UNICODE\n\t\tSetCharLength(aContents[iLen - 1] ? iLen : iLen - 1);\n#endif\n\t}\n\telse\n\t\tAssign();\n\treturn OK;\n}\n\n\n\nLPTSTR ResultToken::Malloc(LPTSTR aValue, size_t aLength)\n{\n\tif (aLength == -1)\n\t\taLength = _tcslen(aValue);\n\tif ( !(mem_to_free = tmalloc(aLength + 1)) )\n\t\treturn NULL;\n\tsymbol = SYM_STRING;\n\tmarker_length = aLength;\n\treturn tmemcpy(marker = mem_to_free, aValue, aLength + 1); // +1 to include the null-terminator.\n}\n\n\n\nResultType Var::InitializeConstant()\n{\n\t// Caller has verified !IsInitialized() && Type() == VAR_CONSTANT.\n\tVar &var = *ResolveAlias();\n\tASSERT(var.mType == VAR_CONSTANT && var.IsObject() && dynamic_cast<::Object*>(var.mObject));\n\tvar.mAttrib &= ~VAR_ATTRIB_UNINITIALIZED; // Only make one attempt; prevents infinite recursion.\n\tFuncResult result_token;\n\tauto cls = (::Object*)var.mObject;\n\tcls->AddRef(); // Necessary because Construct() calls Release() on failure.\n\tauto result = cls->Construct(result_token, nullptr, 0);\n\tif (result == OK)\n\t\tcls->Release();\n\treturn result;\n}\n\n\n\nvoid VarRef::__Value(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (IS_INVOKE_SET)\n\t{\n\t\tif (aParamCount)\n\t\t\tAssign(*aParam[0]) || aResultToken.SetExitResult(FAIL);\n\t\telse\n\t\t\tUninitializeNonVirtual();\n\t}\n\telse\n\t\tToToken(aResultToken);\n}\n"},"size":{"kind":"number","value":65828,"string":"65,828"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1276,"string":"1,276"},"avg_line_length":{"kind":"number","value":48.91849529780564,"string":"48.918495"},"max_line_length":{"kind":"number","value":348,"string":"348"},"alphanum_fraction":{"kind":"number","value":0.7390439794317317,"string":"0.739044"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11084,"cells":{"id":{"kind":"number","value":16072,"string":"16,072"},"file_name":{"kind":"string","value":"MdFunc.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/MdFunc.cpp"},"content":{"kind":"string","value":"\n#include \"stdafx.h\"\n#include \"MdFunc.h\"\n#include \"abi.h\"\n#include \"script_func_impl.h\"\n#include \"window.h\"\n\n\n// internal to this file\nstruct MdFuncEntry\n{\n\tLPCTSTR name;\n\tvoid *function;\n\tMdType rettype;\n\tMdType argtype[23];\n};\n\n\n#define md_mode decl\n#include \"lib\\functions.h\"\n#undef md_mode\n\nMdFuncEntry sMdFunc[]\n{\n\t#define md_mode data\n\t#include \"lib\\functions.h\"\n\t#undef md_mode\n};\n\n\nFunc *Script::GetBuiltInMdFunc(LPCTSTR aFuncName)\n{\n#ifdef _DEBUG\n\tstatic bool sChecked = false;\n\tif (!sChecked)\n\t{\n\t\tsChecked = true;\n\t\tfor (int i = 1; i < _countof(sMdFunc); ++i)\n\t\t\tif (_tcsicmp(sMdFunc[i-1].name, sMdFunc[i].name) >= 0)\n\t\t\t\tMsgBox(_T(\"DEBUG: sMdFunc out of order.\"), 0, sMdFunc[i].name);\n\t}\n#endif\n\tint left, right, mid, result;\n\tfor (left = 0, right = _countof(sMdFunc) - 1; left <= right;)\n\t{\n\t\tmid = (left + right) / 2;\n\t\tauto &f = sMdFunc[mid];\n\t\tresult = _tcsicmp(aFuncName, f.name);\n\t\tif (result > 0)\n\t\t\tleft = mid + 1;\n\t\telse if (result < 0)\n\t\t\tright = mid - 1;\n\t\telse // Match found.\n\t\t{\n\t\t\tint ac;\n\t\t\tfor (ac = 0; ac < _countof(f.argtype) && f.argtype[ac] != MdType::Void; ++ac);\n\t\t\treturn new MdFunc(f.name, f.function, f.rettype, f.argtype, ac);\n\t\t}\n\t}\n\treturn nullptr;\n}\n\n\n#pragma region PerformDynaCall\n\nextern \"C\" UINT64 DynaCall(size_t aArgCount, UINT_PTR *aArg, void *aFunction, DWORD aFlag);\nextern \"C\" float GetFloatRetval();\nextern \"C\" double GetDoubleRetval();\n\n#pragma endregion\n\n\nMdFunc::MdFunc(LPCTSTR aName, void *aMcFunc, MdType aRetType, MdType *aArg, UINT aArgSize, Object *aPrototype)\n\t: NativeFunc(aName)\n\t, mMcFunc {aMcFunc}\n\t, mArgType {aArg}\n\t, mRetType {aRetType}\n\t, mMaxResultTokens {0}\n\t, mArgSlots {0}\n\t, mPrototype {aPrototype}\n\t, mThisCall {aPrototype != nullptr}\n{\n\t// #if _DEBUG, ensure aArg is effectively terminated for the inner loop below.\n\tASSERT(!aArgSize || !MdType_IsMod(aArg[aArgSize - 1]));\n\n#ifdef ENABLE_MD_THISCALL\n\tif (aArgSize > 1 && *aArg == MdType::ThisCall)\n\t{\n\t\tmThisCall = true;\n\t\tmArgType++;\n\t}\n#endif\n\n\tint ac = 0, pc = 0;\n\tif (aPrototype)\n\t\tmMinParams = pc = ac = 1;\n\tfor (UINT i = 0; i < aArgSize; ++i)\n\t{\n\t\tbool opt = false, retval = false;\n\t\tMdType out = MdType::Void;\n\t\tfor (; MdType_IsMod(aArg[i]); ++i)\n\t\t{\n\t\t\tASSERT(i < aArgSize);\n\t\t\tif (aArg[i] == MdType::Optional)\n\t\t\t\topt = true;\n\t\t\telse if (MdType_IsOut(aArg[i]))\n\t\t\t\tout = aArg[i];\n\t\t\telse if (aArg[i] == MdType::RetVal)\n\t\t\t\tretval = true;\n\t\t}\n#ifndef _WIN64\n\t\tif (MdType_Is64bit(aArg[i]) && out == MdType::Void && !opt) // out and opt parameters are excluded because they are passed by address.\n\t\t\t++ac;\n#endif\n\t\t++ac;\n\t\tif (aArg[i] == MdType::Params)\n\t\t{\n\t\t\tASSERT(out == MdType::Void && !retval && !opt);\n\t\t\tmIsVariadic = true;\n\t\t}\n\t\telse if (!retval && !MdType_IsBits(aArg[i]))\n\t\t{\n\t\t\tASSERT(!mIsVariadic);\n\t\t\t++pc;\n\t\t\tif (!opt && pc - 1 == mMinParams)\n\t\t\t\tmMinParams = pc;\n\t\t\tif (aArg[i] == MdType::Variant && out != MdType::Void)\n\t\t\t\t++mMaxResultTokens;\n#ifdef ENABLE_IMPLICIT_TOSTRING\n\t\t\telse if (aArg[i] == MdType::String)\n\t\t\t\t++mMaxResultTokens;\n#endif\n\t\t}\n\t}\n\tmParamCount = pc;\n\tmArgSlots = ac;\n}\n\n\nbool MdFunc::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (!Func::Call(aResultToken, aParam, aParamCount))\n\t\treturn false;\n\n\tif (aParamCount < mMinParams)\n\t{\n\t\taResultToken.Error(ERR_TOO_FEW_PARAMS, mName);\n\t\treturn false;\n\t}\n\n\tDEBUGGER_STACK_PUSH(this) // See comments in BuiltInFunc::Call.\n\n\t// rtp is currently used only for Out Variant params unless ENABLE_IMPLICIT_TOSTRING is defined.\n\tResultToken *rtp = mMaxResultTokens == 0 ? nullptr\n\t\t: (ResultToken *)_alloca(mMaxResultTokens * sizeof(ResultToken));\n\tint rt_count = 0;\n\t\n\tUINT_PTR *args = (UINT_PTR *)_alloca(mArgSlots * sizeof(UINT_PTR));\n\tint first_param_index = 0;\n\n\tResultType result = OK;\n\n\tif (mPrototype) // This implies thiscall and an initial 'this' parameter, excluded from mArgType.\n\t{\n\t\tauto obj = ParamIndexToObject(0);\n\t\t// This handling here is similar to that in BuiltInMethod::Call():\n\t\tif (!obj || !obj->IsOfType(mPrototype))\n\t\t{\n\t\t\tLPCTSTR expected_type = mPrototype->GetOwnPropString(_T(\"__Class\"));\n\t\t\tif (!expected_type)\n\t\t\t\texpected_type = _T(\"?\"); // Script may have tampered with the prototype.\n\t\t\tresult = aResultToken.TypeError(expected_type, *aParam[0]);\n\t\t\tgoto end;\n\t\t}\n\t\t// This is reliant on (IObject*)obj being the same address as (WhateverObject*)obj\n\t\t// (which might not be the case for classes with multiple virtual base classes):\n\t\targs[0] = (UINT_PTR)obj;\n\t\tfirst_param_index = 1;\n\t}\n\n\tMdType retval_arg_type = MdType::Void;\n\tint retval_index = -1;\n\tint output_var_count = 0;\n\tauto atp = mArgType;\n\tfor (int ai = first_param_index, pi = ai; ai < mArgSlots; ++ai, ++atp)\n\t{\n\t\tbool opt = false;\n\t\tMdType out = MdType::Void;\n\t\tfor (; MdType_IsMod(*atp); ++atp)\n\t\t{\n\t\t\tif (*atp == MdType::Optional)\n\t\t\t\topt = true;\n\t\t\telse if (MdType_IsOut(*atp))\n\t\t\t\tout = *atp;\n\t\t\telse if (*atp == MdType::RetVal)\n\t\t\t\tretval_index = ai;\n\t\t}\n\t\tASSERT(retval_index != ai || out != MdType::Void && !opt);\n\t\tauto arg_type = *atp;\n\t\tauto &arg_value = args[ai];\n\t\t\n\t\tif (arg_type == MdType::Params)\n\t\t{\n\t\t\tauto p = (VariantParams *)_alloca(sizeof(VariantParams));\n\t\t\tp->count = pi < aParamCount ? aParamCount - pi : 0;\n\t\t\tp->value = aParam + pi;\n\t\t\targ_value = (UINT_PTR)p;\n\t\t\tcontinue; // Not break, since there might be a retval parameter after it.\n\t\t}\n\t\t\n\t\tif (out != MdType::Void && !(opt && ParamIndexIsOmitted(pi)))\n\t\t{\n\t\t\tvoid *av_buf;\n\t\t\t// Different 'out' modifiers could be supported here to control allocation behaviour,\n\t\t\t// but for built-in functions we'll just use StrRet for String, pointer for all others.\n\t\t\tif (arg_type == MdType::String)\n\t\t\t{\n\t\t\t\tif (retval_index == ai)\n\t\t\t\t\tav_buf = aResultToken.buf;\n\t\t\t\telse\n\t\t\t\t\tav_buf = _alloca(_TSIZE(StrRet::CallerBufSize));\n\t\t\t\t*(LPTSTR)av_buf = '\\0';\n \t\t\t\tav_buf = new (_alloca(sizeof(StrRet))) StrRet((LPTSTR)av_buf);\n\t\t\t\t//MessageBox(NULL, (LPCWSTR)av_buf, NULL, 0);\n\t\t\t}\n\t\t\telse if (arg_type == MdType::Variant)\n\t\t\t{\n\t\t\t\t// Rarely used, so no specialized abstraction yet.\n\t\t\t\tif (retval_index == ai)\n\t\t\t\t\tav_buf = &aResultToken;\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tResultToken &rt = rtp[rt_count++];\n\t\t\t\t\trt.InitResult(talloca(_f_retval_buf_size));\n\t\t\t\t\tav_buf = &rt;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t//ASSERT(arg_type != MdType::Variant);\n\t\t\t\tav_buf = _alloca(8); // This buffer will receive the actual output value.\n\t\t\t\t*(__int64*)av_buf = 0;\n\t\t\t}\n\t\t\targ_value = (UINT_PTR)av_buf; // Pass the address of the buffer or StrRet.\n\t\t}\n\t\t\n\t\tif (retval_index == ai) // Not included within aParam.\n\t\t{\n\t\t\t//if (arg_type == MdType::Variant)\n\t\t\t//\targ_value = (UINT_PTR)&aResultToken;\n\t\t\tretval_arg_type = arg_type;\n\t\t\t//retval_out_type = out;\n\t\t\tcontinue;\n\t\t}\n\n#ifdef ENABLE_MD_BITS\n\t\tif (MdType_IsBits(arg_type))\n\t\t{\n\t\t\t// arg_type represents a constant value to put directly into args.\n\t\t\targ_value = MdType_BitsValue(arg_type);\n\t\t\tcontinue;\n\t\t}\n#endif\n\n\t\tif (ParamIndexIsOmitted(pi))\n\t\t{\n\t\t\tif (!opt)\n\t\t\t{\n\t\t\t\tresult = aResultToken.ParamError(pi, nullptr);\n\t\t\t\tgoto end;\n\t\t\t}\n\t\t\t// Pass nullptr for this optional parameter to indicate that it has been omitted.\n\t\t\t// MdType_Is64bit(arg_type) isn't relevant in this case since opt == true.\n\t\t\targ_value = 0;\n\t\t\tpi++;\n\t\t\tcontinue;\n\t\t}\n\t\tauto ¶m = *aParam[pi++];\n\n\t\tif (out != MdType::Void) // Out or some variant, and not retval (which was already handled).\n\t\t{\n\t\t\tif (!TokenIsOutputVar(param))\n\t\t\t{\n\t\t\t\tresult = aResultToken.ParamError(pi - 1, ¶m, _T(\"variable reference\"));\n\t\t\t\tgoto end;\n\t\t\t}\n\t\t\t++output_var_count;\n\t\t\t// arg_value was already set above.\n\t\t\tcontinue;\n\t\t}\n\n\t\tif (arg_type == MdType::String)\n\t\t{\n\t\t\tLPTSTR buf = nullptr;\n\t\t\tswitch (param.symbol)\n\t\t\t{\n\t\t\tcase SYM_VAR:\n\t\t\t\tif (!param.var->HasObject())\n\t\t\t\t\tbreak; // No buffer needed even if it's pure numeric.\n\t\t\tcase SYM_INTEGER:\n\t\t\tcase SYM_FLOAT:\n\t\t\tcase SYM_OBJECT:\n\t\t\t\tbuf = (LPTSTR)_alloca(MAX_NUMBER_SIZE * sizeof(TCHAR));\n\t\t\t}\n\t\t\tExprTokenType *t;\n\t\t\tif (auto obj = TokenToObject(param))\n\t\t\t{\n#ifdef ENABLE_IMPLICIT_TOSTRING\n\t\t\t\tResultToken &rt = rtp[rt_count++];\n\t\t\t\trt.InitResult(buf);\n\t\t\t\tObjectToString(rt, param, obj);\n\t\t\t\tif (rt.Exited())\n\t\t\t\t{\n\t\t\t\t\tresult = FAIL;\n\t\t\t\t\tgoto end;\n\t\t\t\t}\n\t\t\t\tif (rt.symbol == SYM_OBJECT)\n\t\t\t\t{\n\t\t\t\t\tresult = aResultToken.TypeError(_T(\"String\"), rt);\n\t\t\t\t\tgoto end;\n\t\t\t\t}\n\t\t\t\tt = &rt;\n#else\n\t\t\t\tresult = aResultToken.ParamError(pi - 1, ¶m, _T(\"String\"));\n\t\t\t\tgoto end;\n#endif\n\t\t\t}\n\t\t\telse\n\t\t\t\tt = ¶m;\n\t\t\targ_value = (UINT_PTR)TokenToString(*t, buf);\n\t\t}\n\t\telse if (arg_type == MdType::Object)\n\t\t{\n\t\t\targ_value = (DWORD_PTR)TokenToObject(param);\n\t\t\tif (!arg_value)\n\t\t\t{\n\t\t\t\tresult = aResultToken.ParamError(pi - 1, ¶m, _T(\"Object\"));\n\t\t\t\tgoto end;\n\t\t\t}\n\t\t}\n\t\telse if (arg_type == MdType::Variant)\n\t\t{\n\t\t\targ_value = (DWORD_PTR)¶m;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tExprTokenType nt;\n\t\t\tif (arg_type == MdType::Bool32)\n\t\t\t{\n\t\t\t\tnt.SetValue(TokenToBOOL(param));\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tASSERT(MdType_IsNum(arg_type));\n\t\t\t\tif (!TokenToDoubleOrInt64(param, nt))\n\t\t\t\t{\n\t\t\t\t\tresult = aResultToken.ParamError(pi - 1, ¶m, _T(\"Number\"));\n\t\t\t\t\tgoto end;\n\t\t\t\t}\n\t\t\t}\n\t\t\t// If necessary, convert integer <-> float within the value union.\n\t\t\tswitch (arg_type)\n\t\t\t{\n\t\t\tcase MdType::Float64:\n\t\t\t\tif (nt.symbol == SYM_INTEGER)\n\t\t\t\t\tnt.value_double = (double)nt.value_int64;\n\t\t\t\tbreak;\n\t\t\tcase MdType::Float32:\n\t\t\t\tif (nt.symbol == SYM_INTEGER)\n\t\t\t\t\t*((float*)&nt.value_int64) = (float)nt.value_int64;\n\t\t\t\telse\n\t\t\t\t\t*((float*)&nt.value_int64) = (float)nt.value_double;\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\tif (nt.symbol == SYM_FLOAT)\n\t\t\t\t\tnt.value_int64 = (__int64)nt.value_double;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tvoid *target = &arg_value;\n\t\t\tif (opt) // Optional values are represented by a pointer to a value.\n\t\t\t\targ_value = (UINT_PTR)(target = _alloca(8));\n#ifndef _WIN64\n\t\t\tif (MdType_Is64bit(arg_type))\n\t\t\t{\n\t\t\t\t*(__int64*)target = nt.value_int64;\n\t\t\t\tif (!opt) // See above.\n\t\t\t\t\t++ai; // Consume an additional arg slot.\n\t\t\t}\n\t\t\telse\n\t\t\t\t*(UINT*)target = (UINT)nt.value_int64;\n#else\n\t\t\t*(__int64*)target = nt.value_int64;\n#endif\n\t\t}\n\t}\n\n\tunion {\n\t\tUINT64 rup;\n\t\t__int64 ri64;\n\t\tint ri32;\n\t\tFResult res;\n\t};\n\t// Make the call\n\trup = DynaCall(mArgSlots, args, mMcFunc, mThisCall);\n\n\t// Convert the return value\n\tbool aborted = false;\n\tswitch (mRetType)\n\t{\n\t// Unused return types are commented out or omitted to reduce code size, and disabled\n\t// at compile-time by not providing a valid md_retval<T>::t via template definition.\n\t// Place the most common type (FResult) first in case this compiles to an if-else ladder:\n\tcase MdType::FResult:\n\t\tif (FAILED(res))\n\t\t{\n\t\t\tFResultToError(aResultToken, aParam, aParamCount, res, first_param_index);\n\t\t\taborted = true;\n\t\t}\n\t\telse\n\t\t\taborted = (res == FR_ABORTED);\n\t\tbreak;\n\tcase MdType::ResultType: aResultToken.SetResult((ResultType)rup); break;\n\tcase MdType::Int32: aResultToken.SetValue(ri32); break;\n\tcase MdType::UInt64:\n\tcase MdType::Int64: aResultToken.SetValue(ri64); break;\n\tcase MdType::UInt32: aResultToken.SetValue((UINT)rup); break;\n\t//case MdType::Float64: aResultToken.SetValue(GetDoubleRetval()); break;\n\t//case MdType::String: aResultToken.SetValue((LPTSTR)rup); break; // Strictly statically-allocated strings.\n\t//case MdType::NzIntWin32:\n\t//\tif (!(BOOL)rup)\n\t//\t\taResultToken.Win32Error();\n\t//\tbreak;\n\tcase MdType::Bool32: aResultToken.SetValue(ri32 ? TRUE : FALSE); break;\n\t}\n\tif (retval_index != -1)\n\t{\n\t\tif (retval_arg_type == MdType::String)\n\t\t{\n\t\t\tauto strret = (StrRet*)args[retval_index];\n\t\t\tif (strret->UsedMalloc())\n\t\t\t\taResultToken.AcceptMem(const_cast<LPTSTR>(strret->Value()), strret->Length());\n\t\t\telse if (strret->Value())\n\t\t\t\taResultToken.SetValue(const_cast<LPTSTR>(strret->Value()), strret->Length());\n\t\t\t//else leave aResultToken set to its default value, \"\".\n\t\t}\n\t\telse if (retval_arg_type != MdType::Variant) // Variant type passes aResultToken directly.\n\t\t\tTypedPtrToToken(retval_arg_type, (void*)args[retval_index], aResultToken);\n\t}\n\n\t// Copy output parameters\n\tatp = mArgType;\n\tfor (int ai = first_param_index, pi = ai; output_var_count; ++atp, ++ai, ++pi)\n\t{\n\t\tASSERT(pi < aParamCount); // Implied by how output_var_count was calculated.\n\t\tMdType out = MdType::Void;\n\t\tfor (; MdType_IsMod(*atp); ++atp)\n\t\t\tif (MdType_IsOut(*atp))\n\t\t\t\tout = *atp;\n\t\tif (ai == retval_index)\n\t\t{\n\t\t\t--pi; // This args slot doesn't correspond to an aParam slot.\n\t\t\tcontinue;\n\t\t}\n\t\tif (out == MdType::Void || ParamIndexIsOmitted(pi))\n\t\t\tcontinue;\n\t\t--output_var_count;\n\t\tauto arg_value = args[ai];\n\t\tExprTokenType value;\n\t\tLPTSTR mem_to_free = nullptr;\n\t\tif (*atp == MdType::String)\n\t\t{\n\t\t\tauto strret = (StrRet*)arg_value;\n\t\t\tif (!strret->Value())\n\t\t\t\tvalue.SetValue(_T(\"\"), 0);\n\t\t\telse\n\t\t\t\tvalue.SetValue(const_cast<LPTSTR>(strret->Value()), strret->Length());\n\t\t\tif (strret->UsedMalloc())\n\t\t\t\tmem_to_free = const_cast<LPTSTR>(strret->Value());\n\t\t}\n\t\telse if (*atp == MdType::Variant)\n\t\t{\n\t\t\tResultToken &rt = *(ResultToken*)arg_value;\n\t\t\tASSERT(!rt.mem_to_free || rt.symbol == SYM_STRING && rt.marker == rt.mem_to_free);\n\t\t\tmem_to_free = rt.mem_to_free;\n\t\t\tvalue.CopyValueFrom(rt);\n#ifdef ENABLE_IMPLICIT_TOSTRING\n\t\t\t// ResultTokens are allocated from rtp and Free() is called upon return,\n\t\t\t// but in this case any memory or object contained by the contain will\n\t\t\t// either be moved into var or freed below.\n\t\t\trt.mem_to_free = nullptr;\n\t\t\trt.symbol = SYM_INVALID;\n#endif\n\t\t}\n\t\telse\n\t\t{\n\t\t\tTypedPtrToToken(*atp, (void*)arg_value, value);\n\t\t}\n\t\tVar *var = nullptr;\n\t\tIObject *obj = nullptr;\n\t\tif (aParam[pi]->IsOptimizedOutputVar())\n\t\t{\n\t\t\tvar = aParam[pi]->var;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tobj = ParamIndexToObject(pi);\n\t\t\tif (obj->Base() == Object::sVarRefPrototype)\n\t\t\t\tvar = static_cast<VarRef *>(obj);\n\t\t}\n\t\tif (!result || aborted)\n\t\t{\n\t\t\tif (mem_to_free)\n\t\t\t\tfree(mem_to_free);\n\t\t\tif (value.symbol == SYM_OBJECT)\n\t\t\t\tvalue.object->Release();\n\t\t\t// Although 0 or \"\" is a fairly conventional default, it might not be safe.\n\t\t\t// For error-detection and to avoid unexpected behaviour, \"unset\" the var.\n\t\t\tif (var) // Avoid `obj.__value := unset` as it seems likely to cause another error.\n\t\t\t\tvar->UninitializeNonVirtual();\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (!var)\n\t\t\t\tvar = new (_alloca(sizeof(Var))) Var(obj); // mType = VAR_VIRTUAL_OBJ\n\t\t\tif (mem_to_free)\n\t\t\t\tresult = var->AcceptNewMem(mem_to_free, value.marker_length);\n\t\t\telse if (value.symbol == SYM_OBJECT)\n\t\t\t\tresult = var->AssignSkipAddRef(value.object);\n\t\t\telse\n\t\t\t\tresult = var->Assign(value);\n\t\t}\n\t}\n\n\tif (!result || aborted) // An assignment above or the function call itself failed.\n\t{\n\t\taResultToken.Free();\n\t\taResultToken.mem_to_free = nullptr; // Because Free() doesn't clear it.\n\t\taResultToken.SetValue(_T(\"\"), 0);\n\t}\n\nend:\n\tDEBUGGER_STACK_POP()\n#ifdef ENABLE_IMPLICIT_TOSTRING\n\t// Free any temporary results of ToString() calls.\n\tfor (int i = 0; i < rt_count; ++i)\n\t\trtp[i].Free();\n#endif\n\treturn result;\n}\n\n\n// Shallow-copy a value from aPtr to aToken.\nvoid TypedPtrToToken(MdType aType, void *aPtr, ExprTokenType &aToken)\n{\n\tswitch (aType)\n\t{\n\tcase MdType::Bool32:\n\tcase MdType::Int32: aToken.SetValue(*(int*)aPtr); break;\n\tcase MdType::UInt32: aToken.SetValue(*(UINT*)aPtr); break;\n\tcase MdType::UInt64:\n\tcase MdType::Int64: aToken.SetValue(*(__int64*)aPtr); break;\n\tcase MdType::Float64: aToken.SetValue(*(double*)aPtr); break;\n\tcase MdType::Float32: aToken.SetValue(*(float*)aPtr); break;\n\tcase MdType::Int8: aToken.SetValue(*(INT8*)aPtr); break;\n\tcase MdType::UInt8: aToken.SetValue(*(UINT8*)aPtr); break;\n\tcase MdType::Int16: aToken.SetValue(*(INT16*)aPtr); break;\n\tcase MdType::UInt16: aToken.SetValue(*(UINT16*)aPtr); break;\n\tcase MdType::Object:\n\t\tif (auto obj = *(IObject**)aPtr)\n\t\t\taToken.SetValue(obj);\n\t\telse\n\t\t\taToken.SetValue(_T(\"\"), 0);\n\t\tbreak;\n\t}\n}\n\n\nResultType SetValueOfTypeAtPtr(MdType aType, void *aPtr, ExprTokenType &aValue, ResultToken &aResultToken)\n{\n\tExprTokenType nt;\n\tASSERT(MdType_IsNum(aType));\n\tif (!TokenToDoubleOrInt64(aValue, nt))\n\t\treturn aResultToken.TypeError(_T(\"Number\"), aValue);\n\tif (MdType_IsInt(aType) && nt.symbol == SYM_FLOAT)\n\t\tnt.value_int64 = (__int64)nt.value_double;\n\tswitch (aType)\n\t{\n\t//case MdType::Bool32:\n\tcase MdType::Int32:\n\tcase MdType::UInt32: *(UINT*)aPtr = (UINT)nt.value_int64; break;\n\tcase MdType::UInt64:\n\tcase MdType::Int64: *(__int64*)aPtr = nt.value_int64; break;\n\tcase MdType::Float64: *(double*)aPtr = nt.symbol == SYM_FLOAT ? nt.value_double : (double)nt.value_int64; break;\n\tcase MdType::Float32: *(float*)aPtr = nt.symbol == SYM_FLOAT ? (float)nt.value_double : (float)nt.value_int64; break;\n\tcase MdType::Int8:\n\tcase MdType::UInt8: *(UINT8*)aPtr = (UINT8)nt.value_int64; break;\n\tcase MdType::Int16:\n\tcase MdType::UInt16: *(UINT16*)aPtr = (UINT16)nt.value_int64; break;\n\t//case MdType::Object:\n\tdefault:\n\t\tASSERT(!\"MdType not implemented or not valid\");\n\t}\n\treturn OK;\n}\n\n\nsize_t TypeSize(MdType aType)\n{\n\tswitch (aType)\n\t{\n\tcase MdType::Int8:\n\tcase MdType::UInt8: return 1;\n\tcase MdType::Int16:\n\tcase MdType::UInt16: return 2;\n\tcase MdType::Float32:\n\tcase MdType::Int32:\n\tcase MdType::UInt32: return 4;\n\tcase MdType::Float64:\n\tcase MdType::Int64:\n\tcase MdType::UInt64: return 8;\n\tdefault: return 0;\n\t}\n}\n\n\nstatic LPCTSTR sTypeNames[] = { MDTYPE_NAMES };\n\n\nMdType TypeCode(LPCTSTR aName)\n{\n\tfor (int i = 1; i < _countof(sTypeNames); ++i)\n\t\tif (!_tcsicmp(sTypeNames[i], aName))\n\t\t\treturn (MdType)i;\n\tif (!_tcsicmp(_T(\"iptr\"), aName))\n\t\treturn MdType::IntPtr;\n\tif (!_tcsicmp(_T(\"uptr\"), aName))\n\t\treturn MdType::UIntPtr;\n\treturn MdType::Void;\n}\n\n\nLPCTSTR TypeName(MdType aType)\n{\n\tif ((int)aType > 0 && (int)aType < _countof(sTypeNames))\n\t\treturn sTypeNames[(int)aType];\n\treturn nullptr;\n}\n\n\nbool MdFunc::ArgIsOutputVar(int aIndex)\n{\n\tauto atp = mArgType;\n\tfor (int ai = 0; ai < mArgSlots; ++ai, ++atp, --aIndex)\n\t{\n\t\tMdType out = MdType::Void;\n\t\tfor (; MdType_IsMod(*atp); ++atp)\n\t\t{\n\t\t\tif (MdType_IsOut(*atp))\n\t\t\t\tout = *atp;\n\t\t\telse if (*atp == MdType::RetVal)\n\t\t\t\t++aIndex;\n\t\t}\n\t\tif (aIndex == 0)\n\t\t\treturn out != MdType::Void;\n#ifndef _WIN64\n\t\tif (MdType_Is64bit(*atp))\n\t\t\t++ai;\n#endif\n\t}\n\treturn false;\n}\n\n\nbool MdFunc::ArgIsOptional(int aIndex)\n{\n\tauto atp = mArgType;\n\tfor (int ai = 0; ai < mArgSlots; ++ai, ++atp, --aIndex)\n\t{\n\t\tbool opt = false;\n\t\tfor (; MdType_IsMod(*atp); ++atp)\n\t\t{\n\t\t\tif (*atp == MdType::Optional)\n\t\t\t\topt = true;\n\t\t\telse if (*atp == MdType::RetVal)\n\t\t\t\t++aIndex;\n\t\t}\n\t\tif (aIndex == 0)\n\t\t\treturn opt;\n#ifndef _WIN64\n\t\tif (MdType_Is64bit(*atp))\n\t\t\t++ai;\n#endif\n\t}\n\treturn false;\n}\n\n\nObject *Object::DefineMetadataMembers(Object *obj, LPCTSTR aClassName, ObjectMemberMd aMember[], int aMemberCount)\n{\n\tif (aMemberCount)\n\t\tobj->mFlags |= NativeClassPrototype;\n\n\tTCHAR full_name[MAX_VAR_NAME_LENGTH + 1];\n\tTCHAR *name = full_name + _stprintf(full_name, _T(\"%s.Prototype.\"), aClassName);\n\n\tfor (int i = 0; i < aMemberCount; ++i)\n\t{\n\t\tauto &member = aMember[i];\n\n\t\tint ac;\n\t\tfor (ac = 0; ac < _countof(member.argtype) && member.argtype[ac] != MdType::Void; ++ac);\n\n\t\t_tcscpy(name, member.name);\n\t\tauto op_name = _tcschr(name, '\\0');\n\t\tswitch (member.invokeType)\n\t\t{\n\t\tcase IT_GET: _tcscpy(op_name, _T(\".Get\")); break;\n\t\tcase IT_SET: _tcscpy(op_name, _T(\".Set\")); break;\n\t\t}\n\n\t\tauto func = new MdFunc(SimpleHeap::Alloc(full_name), member.method, MdType::FResult, member.argtype, ac, obj);\n\n\t\tif (member.invokeType == IT_CALL)\n\t\t{\n\t\t\tobj->DefineMethod(name, func);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tauto prop = obj->DefineProperty(const_cast<LPTSTR>(member.name));\n\t\t\tif (member.invokeType == IT_GET)\n\t\t\t{\n\t\t\t\tprop->SetGetter(func);\n\t\t\t\tprop->NoParamGet = func->mParamCount == 1 && !func->mIsVariadic;\n\t\t\t\tprop->NoEnumGet = func->mMinParams > 1;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tprop->SetSetter(func);\n\t\t\t\tprop->NoParamSet = func->mParamCount == 2 && !func->mIsVariadic;\n\t\t\t}\n\t\t}\n\t\tfunc->Release();\n\t}\n\treturn obj;\n}\n"},"size":{"kind":"number","value":19635,"string":"19,635"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":684,"string":"684"},"avg_line_length":{"kind":"number","value":25.526315789473685,"string":"25.526316"},"max_line_length":{"kind":"number","value":136,"string":"136"},"alphanum_fraction":{"kind":"number","value":0.6681671344595668,"string":"0.668167"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11085,"cells":{"id":{"kind":"number","value":16073,"string":"16,073"},"file_name":{"kind":"string","value":"hotkey.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/hotkey.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"hotkey.h\"\n#include \"globaldata.h\" // For g_os and other global vars.\n#include \"window.h\" // For MsgBox()\n//#include \"application.h\" // For ExitApp()\n#include \"script_func_impl.h\"\n\n// Initialize static members:\nHookType Hotkey::sWhichHookNeeded = 0;\nHookType Hotkey::sWhichHookAlways = 0;\nDWORD Hotkey::sTimePrev = {0};\nDWORD Hotkey::sTimeNow = {0};\nHotkey **Hotkey::shk = NULL;\nint Hotkey::shkMax = 0;\nHotkeyIDType Hotkey::sNextID = 0;\nconst HotkeyIDType &Hotkey::sHotkeyCount = Hotkey::sNextID;\nbool Hotkey::sJoystickHasHotkeys[MAX_JOYSTICKS] = {false};\nDWORD Hotkey::sJoyHotkeyCount = 0;\n\n\n\nHWND HotCriterionAllowsFiring(HotkeyCriterion *aCriterion, LPTSTR aHotkeyName)\n// This is a global function because it's used by both hotkeys and hotstrings.\n// In addition to being called by the hook thread, this can now be called by the main thread.\n// That happens when a WM_HOTKEY message arrives (for non-hook hotkeys, i.e. RegisterHotkey).\n// Returns a non-NULL HWND if firing is allowed. However, if it's a global criterion or\n// a \"not-criterion\" such as #HotIf Not WinActive(), (HWND)1 is returned rather than a genuine HWND.\n{\n\tHWND found_hwnd;\n\tif (!aCriterion)\n\t\treturn (HWND)1; // Always allow hotkey to fire.\n\tswitch(aCriterion->Type)\n\t{\n\tcase HOT_IF_ACTIVE:\n\tcase HOT_IF_NOT_ACTIVE:\n\t\tfound_hwnd = WinActive(g_default, aCriterion->WinTitle, aCriterion->WinText, _T(\"\"), _T(\"\"), false); // Thread-safe.\n\t\tbreak;\n\tcase HOT_IF_EXIST:\n\tcase HOT_IF_NOT_EXIST:\n\t\tfound_hwnd = WinExist(g_default, aCriterion->WinTitle, aCriterion->WinText, _T(\"\"), _T(\"\"), false, false); // Thread-safe.\n\t\tbreak;\n\t// L4: Handling of #HotIf (expression) hotkey variants.\n\tcase HOT_IF_CALLBACK:\n\t\t// Expression evaluation must be done in the main thread. If the message times out, the hotkey/hotstring is not allowed to fire.\n\t\tDWORD_PTR res;\n\t\treturn (SendMessageTimeout(g_hWnd, AHK_HOT_IF_EVAL, (WPARAM)aCriterion, (LPARAM)aHotkeyName, SMTO_BLOCK | SMTO_ABORTIFHUNG, g_HotExprTimeout, &res) && res == CONDITION_TRUE) ? (HWND)1 : NULL;\n\t}\n\treturn (aCriterion->Type == HOT_IF_ACTIVE || aCriterion->Type == HOT_IF_EXIST) ? found_hwnd : (HWND)!found_hwnd;\n}\n\n\n\nBIF_DECL(HotIf_Win)\n{\n\tHWND found_hwnd;\n\tauto hc = (HotkeyCriterion*)aResultToken.func->mData;\n\tif (hc->Type >= HOT_IF_EXIST)\n\t{\n\t\tfound_hwnd = WinExist(*g, hc->WinTitle, hc->WinText, _T(\"\"), _T(\"\"), false, true);\n\t\tif (hc->Type == HOT_IF_NOT_EXIST)\n\t\t\tfound_hwnd = (HWND)!found_hwnd;\n\t}\n\telse\n\t{\n\t\tfound_hwnd = WinActive(*g, hc->WinTitle, hc->WinText, _T(\"\"), _T(\"\"), true);\n\t\tif (hc->Type == HOT_IF_NOT_ACTIVE)\n\t\t\tfound_hwnd = (HWND)!found_hwnd;\n\t}\n\t_f_return_i((UINT)(UINT_PTR)found_hwnd);\n}\n\n\n\nvoid SetHotIfReturnValue(ResultToken &aResultToken)\n{\n\tif (!g->HotCriterion)\n\t{\n\t\t// \"\" seems more in line with the intended use than unset (and consistent with\n\t\t// the other hotkey-related variables); e.g. old := HotIf(new) ... HotIf(old).\n\t\t// A minor drawback is that A_HotIf?.() won't work.\n\t\t_f_return_empty;\n\t}\n\tif (!g->HotCriterion->Callback)\n\t{\n\t\t// Provide a value which can be passed back to HotIf to set this criterion.\n\t\t// Making it an actual function which evaluates the criterion also means that\n\t\t// the script can call A_HotIf() to evaluate the current criterion. It won't\n\t\t// actually be called unless the script calls it. WinExist.Bind() or similar\n\t\t// isn't used because it couldn't handle the HOT_IF_NOT variants.\n\t\tg->HotCriterion->Callback = new BuiltInFunc { _T(\"\"), HotIf_Win, 0, 0, false, g->HotCriterion };\n\t}\n\tg->HotCriterion->Callback->AddRef();\n\t_f_return(g->HotCriterion->Callback);\n}\n\n\n\nFResult SetHotkeyCriterion(HotCriterionType aType, LPCTSTR aWinTitle, LPCTSTR aWinText, ResultToken &aResultToken)\n// Returns FR_FAIL if memory couldn't be allocated (and an error was raised), or OK otherwise.\n// This is a global function because it's used by both hotkeys and hotstrings.\n{\n\tHotkeyCriterion *cp = nullptr;\n\tif ( (*aWinTitle || *aWinText)\n\t\t&& !(cp = FindHotkeyCriterion(aType, aWinTitle, aWinText))\n\t\t&& !(cp = AddHotkeyCriterion(aType, aWinTitle, aWinText)) )\n\t\treturn FR_FAIL;\n\tSetHotIfReturnValue(aResultToken);\n\tg->HotCriterion = cp;\n\treturn OK;\n}\n\n\nHotkeyCriterion *FindHotkeyCriterion(HotCriterionType aType, LPCTSTR aWinTitle, LPCTSTR aWinText)\n{\n\t// Storing combinations of WinTitle+WinText doesn't have as good a best-case memory savings as\n\t// have a separate linked list for Title vs. Text. But it does save code size, and in the vast\n\t// majority of scripts, the memory savings would be insignificant.\n\tHotkeyCriterion *cp;\n\tfor (cp = g_FirstHotCriterion; cp; cp = cp->NextCriterion)\n\t\tif (cp->Type == aType && !_tcscmp(cp->WinTitle, aWinTitle) && !_tcscmp(cp->WinText, aWinText)) // Case insensitive.\n\t\t\treturn cp;\n\n\treturn NULL;\n}\n\n\nHotkeyCriterion *AddHotkeyCriterion(HotCriterionType aType, LPCTSTR aWinTitle, LPCTSTR aWinText)\n{\n\tHotkeyCriterion *cp;\n\tcp = SimpleHeap::Alloc<HotkeyCriterion>();\n\tcp->Type = aType;\n\tcp->OriginalExpr = nullptr;\n\tcp->Callback = nullptr;\n\tif (*aWinTitle)\n\t{\n\t\tif ( !(cp->WinTitle = SimpleHeap::Malloc(aWinTitle)) )\n\t\t\treturn NULL;\n\t}\n\telse\n\t\tcp->WinTitle = _T(\"\");\n\tif (*aWinText)\n\t{\n\t\tif ( !(cp->WinText = SimpleHeap::Malloc(aWinText)) )\n\t\t\treturn NULL;\n\t}\n\telse\n\t\tcp->WinText = _T(\"\");\n\treturn AddHotkeyCriterion(cp);\n}\n\n\nHotkeyCriterion *AddHotkeyCriterion(HotkeyCriterion *cp)\n{\n\tcp->NextCriterion = NULL;\n\tif (!g_FirstHotCriterion)\n\t\tg_FirstHotCriterion = g_LastHotCriterion = cp;\n\telse\n\t{\n\t\tg_LastHotCriterion->NextCriterion = cp;\n\t\t// This must be done after the above:\n\t\tg_LastHotCriterion = cp;\n\t}\n\treturn cp;\n}\n\n\nHotkeyCriterion *AddHotkeyIfExpr()\n{\n\tHotkeyCriterion *cp = SimpleHeap::Alloc<HotkeyCriterion>();\n\tcp->NextExpr = NULL;\n\tcp->OriginalExpr = nullptr;\n\tif (g_LastHotExpr)\n\t\tg_LastHotExpr->NextExpr = cp;\n\telse\n\t\tg_FirstHotExpr = cp;\n\tg_LastHotExpr = cp;\n\treturn cp;\n}\n\n\nHotkeyCriterion *FindHotkeyIfExpr(LPCTSTR aExpr)\n{\n\tauto mod = g_script.CurrentModule();\n\tfor (HotkeyCriterion* cp = g_FirstHotExpr; cp; cp = cp->NextExpr)\n\t\tif (cp->OriginalExpr // Checked first since it implies Callback is a UserFunc.\n\t\t\t&& ((UserFunc*)cp->Callback)->mModule == mod // Names in an expression have different meaning depending on module.\n\t\t\t&& !_tcscmp(aExpr, cp->OriginalExpr)) // Case-sensitive since the expression might be.\n\t\t\treturn cp;\n\treturn NULL;\n}\n\n\nvoid Script::PreparseHotkeyIfExpr(Line* aLine)\n// Optimize simple #HotIf expressions into the more specific HOT_IF_ types so that they can be\n// evaluated by the hook directly, without synchronizing with the main thread.\n{\n\tExprTokenType *postfix = aLine->mArg[0].postfix;\n\tif (postfix[0].symbol != SYM_OBJECT)\n\t\treturn;\n\tauto fn = dynamic_cast<BuiltInFunc*>(postfix[0].object);\n\tif (!fn || fn->mBIF != &BIF_WinExistActive)\n\t\treturn; // Not WinExist() or WinActive().\n\t++postfix;\n\tint param_count = 0;\n\twhile (postfix[param_count].symbol == SYM_STRING)\n\t\t++param_count;\n\tif (postfix[param_count].symbol != SYM_FUNC // Not a function call, or it doesn't only accept strings.\n\t\t|| param_count > 2) // Too many parameters.\n\t\treturn;\n\tbool invert = postfix[param_count+1].symbol == SYM_LOWNOT || postfix[param_count+1].symbol == SYM_HIGHNOT;\n\tif (postfix[param_count+1+invert].symbol != SYM_INVALID)\n\t\treturn; // There's more to the expression.\n\t// Otherwise, it was a single call to WinExist() or WinActive() where each parameter\n\t// was exactly one literal string and the result was optionally inverted with \"not\" or \"!\".\n\tHotkeyCriterion *hc = (HotkeyCriterion *)aLine->mAttribute;\n\t// Change the parameters of this criterion. FindHotkeyIfExpr() will still be able to\n\t// find it based on the expression text since it only relies on ExprLine.\n\tif (ctoupper(fn->mName[3]) == 'A')\n\t\thc->Type = invert ? HOT_IF_NOT_ACTIVE : HOT_IF_ACTIVE;\n\telse\n\t\thc->Type = invert ? HOT_IF_NOT_EXIST : HOT_IF_EXIST;\n\thc->WinTitle = param_count > 0 ? postfix[0].marker : _T(\"\");\n\thc->WinText = param_count > 1 ? postfix[1].marker : _T(\"\");\n\t// The following adds a duplicate in the event that there are two different expressions\n\t// which resolve to the same criterion, such as WinExist(\"x\",\"\") and WinExist(\"x\", \"\").\n\t// In that case, only the first criterion can be referenced by its WinTitle & WinText\n\t// (but each can be referenced by its unique expression text). This seems unavoidable\n\t// since variants are only unique to a given expression, and trying to work around that\n\t// here would cause inconsistency since this only applies to very specific expressions.\n\t// At this stage, the only criterion in the list are those added by the following line:\n\tAddHotkeyCriterion(hc);\n}\n\n\n\nvoid Hotkey::ManifestAllHotkeysHotstringsHooks()\n// This function examines all hotkeys and hotstrings to determine:\n// - Which hotkeys to register/unregister, or activate/deactivate in the hook.\n// - Which hotkeys to be changed from HK_NORMAL to HK_KEYBD_HOOK (or vice versa).\n// - In pursuit of the above, also assess the interdependencies between hotkeys: the presence or\n// absence of a given hotkey can sometimes impact whether other hotkeys need to be converted from\n// HK_NORMAL to HK_KEYBD_HOOK. For example, a newly added/enabled global hotkey variant can\n// cause a HK_KEYBD_HOOK hotkey to become HK_NORMAL, and the converse is also true.\n// - Based on the above, decide whether the keyboard and/or mouse hooks need to be (de)activated.\n{\n\t// v1.0.37.05: A prefix key such as \"a\" in \"a & b\" should cause any use of \"a\" as a suffix\n\t// (such as ^!a) also to be a hook hotkey. Otherwise, the ^!a hotkey won't fire because the\n\t// hook prevents the OS's hotkey monitor from seeing that the hotkey was pressed. NOTE:\n\t// This is done only for virtual keys because prefix keys that are done by scan code (mModifierSC)\n\t// should already be hook hotkeys when used as suffix keys (there may be a few unusual exceptions,\n\t// but they seem too rare to justify the extra code size).\n\t// Update for v1.0.40: This first pass through the hotkeys now also checks things for hotkeys\n\t// that can affect other hotkeys. If this weren't done in the first pass, it might be possible\n\t// for a hotkey to make some other hotkey into a hook hotkey, but then the hook might not be\n\t// installed if that hotkey had already been processed earlier in the second pass. Similarly,\n\t// a hotkey processed earlier in the second pass might have been registered when in fact it\n\t// should have become a hook hotkey due to something learned only later in the second pass.\n\t// Doing these types of things in the first pass resolves such situations.\n\t// Update for v1.1.27: Doing the above in the first pass doesn't work correctly, as mType is\n\t// reset to default during the first pass (even if a previous iteration might has set it to\n\t// HK_KEYBD_HOOK, such as when it is eclipsed by a wildcard hotkey). One workaround would\n\t// be to set mKeybdHookMandatory = true, but that would prevent the hotkey from reverting to\n\t// HK_NORMAL when it no longer needs the hook. Instead, there are now three passes.\n\tbool vk_is_prefix[VK_ARRAY_COUNT] = {false};\n\tbool *hk_is_inactive = (bool *)_alloca(sHotkeyCount * sizeof(bool)); // No init needed. Currently limited to around 16k (HOTKEY_ID_MAX).\n\tHotkeyVariant *vp;\n\tint i, j;\n\n\t// FIRST PASS THROUGH THE HOTKEYS:\n\tfor (i = 0; i < sHotkeyCount; ++i)\n\t{\n\t\tHotkey &hot = *shk[i]; // For performance and convenience.\n\t\tif ( hk_is_inactive[i] = ((g_IsSuspended && !hot.IsExemptFromSuspend())\n\t\t\t|| hot.IsCompletelyDisabled()) ) // Listed last for short-circuit performance.\n\t\t{\n\t\t\t// In the cases above, nothing later below can change the fact that this hotkey should\n\t\t\t// now be in an unregistered state.\n\t\t\tif (hot.mIsRegistered)\n\t\t\t{\n\t\t\t\thot.Unregister();\n\t\t\t\t// In case the hotkey's thread is already running, it seems best to cancel any repeat-run\n\t\t\t\t// that has already been scheduled. Older comment: CT_SUSPEND, at least, relies on us to do this.\n\t\t\t\tfor (vp = hot.mFirstVariant; vp; vp = vp->mNextVariant)\n\t\t\t\t\tvp->mRunAgainAfterFinished = false; // Applies to all hotkey types, not just registered ones.\n\t\t\t}\n\t\t\tcontinue;\n\t\t}\n\t\t// Otherwise, this hotkey will be in effect, so check its attributes.\n\n\t\tif (hot.mKeybdHookMandatory)\n\t\t{\n\t\t\t// v1.0.44: The following is relied upon by some things like the Hotkey constructor and the tilde prefix\n\t\t\t// (the latter can set mKeybdHookMandatory for a hotkey sometime after the first variant is added [such\n\t\t\t// as for a subsequent variant]). This practice also improves maintainability.\n\t\t\tif (HK_TYPE_CAN_BECOME_KEYBD_HOOK(hot.mType)) // To ensure it hasn't since become a joystick/mouse/mouse-and-keyboard hotkey.\n\t\t\t\thot.mType = HK_KEYBD_HOOK;\n\t\t}\n\t\telse // Hook isn't mandatory, so set any non-mouse/joystick/both hotkey to normal for possibly overriding later below.\n\t\t{\n\t\t\t// v1.0.42: The following is done to support situations in which a hotkey can be a hook hotkey sometimes,\n\t\t\t// but after a (de)suspend or after a change to other hotkeys via the Hotkey command, might no longer\n\t\t\t// require the hook. Examples include:\n\t\t\t// 1) A hotkey can't be registered because some other app is using it, but later\n\t\t\t// that condition changes.\n\t\t\t// 2) Suspend or the Hotkey command changes wildcard hotkeys so that non-wildcard\n\t\t\t// hotkeys that have the same suffix are no longer eclipsed, and thus don't need\n\t\t\t// the hook. The same type of thing can happen if a key-up hotkey is disabled,\n\t\t\t// which would allow it's key-down hotkey to become non-hook. Similarly, if a\n\t\t\t// all of a prefix key's hotkeys become disabled, and that prefix is also a suffix,\n\t\t\t// those suffixes no longer need to be hook hotkeys.\n\t\t\t// 3) There may be other ways, especially in the future involving #HotIf WinActive/Exist\n\t\t\t// keys whose criteria change.\n\t\t\tif (hot.mType == HK_KEYBD_HOOK)\n\t\t\t\thot.mType = HK_NORMAL; // To possibly be overridden back to HK_KEYBD_HOOK later below; but if not, it will be registered later below.\n\t\t}\n\n\t\tif (hot.mModifierVK)\n\t\t\tvk_is_prefix[hot.mModifierVK] = true;\n\t} // End of first pass loop.\n\t\n\t// SECOND PASS THROUGH THE HOTKEYS:\n\t// Check for hotkeys that can affect other hotkeys, such as wildcard or key-up hotkeys.\n\t// This is separate to the other passes for reasons described at the top of the function.\n\tfor (i = 0; i < sHotkeyCount; ++i)\n\t{\n\t\tif (hk_is_inactive[i])\n\t\t\tcontinue;\n\t\tHotkey &hot = *shk[i]; // For performance and convenience.\n\n\t\tif (hot.mKeyUp && hot.mVK) // No need to do the below for mSC hotkeys since their down hotkeys would already be handled by the hook.\n\t\t{\n\t\t\t// For each key-up hotkey, search for any its counterpart that's a down-hotkey (if any).\n\t\t\t// Such a hotkey should also be handled by the hook because if registered, such as\n\t\t\t// \"#5\" (reg) and \"#5 up\" (hook), the hook would suppress the down event because it\n\t\t\t// is unaware that down-hotkey exists (it's suppressed to prevent the key from being\n\t\t\t// stuck in a logically down state).\n\t\t\tfor (j = 0; j < sHotkeyCount; ++j)\n\t\t\t{\n\t\t\t\t// No need to check the following because they are already hook hotkeys:\n\t\t\t\t// mModifierVK/SC\n\t\t\t\t// mAllowExtraModifiers\n\t\t\t\t// mNoSuppress\n\t\t\t\t// In addition, there is no need to check shk[j]->mKeyUp because that can't be\n\t\t\t\t// true if it's mType is HK_NORMAL:\n\t\t\t\t// Also, g_IsSuspended and IsCompletelyDisabled() aren't checked\n\t\t\t\t// because it's harmless to operate on disabled hotkeys in this way.\n\t\t\t\tif (shk[j]->mVK == hot.mVK && HK_TYPE_CAN_BECOME_KEYBD_HOOK(shk[j]->mType) // Ordered for short-circuit performance.\n\t\t\t\t\t&& shk[j]->mModifiersConsolidatedLR == hot.mModifiersConsolidatedLR)\n\t\t\t\t{\n\t\t\t\t\tshk[j]->mType = HK_KEYBD_HOOK;\n\t\t\t\t\t// And if it's currently registered, it will be unregistered later below.\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// v1.0.40: If this is a wildcard hotkey, any hotkeys it eclipses (i.e. includes as subsets)\n\t\t// should be made into hook hotkeys also, because otherwise they would be overridden by hook.\n\t\t// The following criteria are checked:\n\t\t// 1) Exclude those that have a ModifierSC/VK because in those cases, mAllowExtraModifiers is\n\t\t// ignored.\n\t\t// 2) Exclude those that lack an mVK because those with mSC can't eclipse registered hotkeys\n\t\t// (since any would-be eclipsed mSC hotkey is already a hook hotkey due to is SC nature).\n\t\t// 3) It must not have any mModifiersLR because such hotkeys can't completely eclipse\n\t\t// registered hotkeys since they always have neutral vs. left/right-specific modifiers.\n\t\t// For example, if *<^a is a hotkey, ^a can still be a registered hotkey because it could\n\t\t// still be activated by pressing RControl+a.\n\t\t// 4) For maintainability, it doesn't check mNoSuppress because the hook is needed anyway,\n\t\t// so might as well handle eclipsed hotkeys with it too.\n\t\tif (hot.mAllowExtraModifiers && hot.mVK && !hot.mModifiersLR && !(hot.mModifierSC || hot.mModifierVK))\n\t\t{\n\t\t\tfor (j = 0; j < sHotkeyCount; ++j)\n\t\t\t{\n\t\t\t\t// If it's not of type HK_NORMAL, there's no need to change its type regardless\n\t\t\t\t// of the values of its other members. Also, if the wildcard hotkey (hot) has\n\t\t\t\t// any neutral modifiers, this hotkey must have at least those neutral modifiers\n\t\t\t\t// too or else it's not eclipsed (and thus registering it is okay). In other words,\n\t\t\t\t// the wildcard hotkey's neutral modifiers must be a perfect subset of this hotkey's\n\t\t\t\t// modifiers for this one to be eclipsed by it. Note: Neither mModifiersLR nor\n\t\t\t\t// mModifiersConsolidated is checked for simplicity and also because it seems to add\n\t\t\t\t// flexibility. For example, *<^>^a would require both left AND right ctrl to be down,\n\t\t\t\t// not EITHER. In other words, mModifiersLR can never in effect contain a neutral modifier.\n\t\t\t\tif (shk[j]->mVK == hot.mVK && HK_TYPE_CAN_BECOME_KEYBD_HOOK(shk[j]->mType) // Ordered for short-circuit performance.\n\t\t\t\t\t&& (hot.mModifiers & shk[j]->mModifiers) == hot.mModifiers)\n\t\t\t\t{\n\t\t\t\t\t// Note: No need to check mModifiersLR because it would already be a hook hotkey in that case;\n\t\t\t\t\t// that is, the check of shk[j]->mType precludes it. It also precludes the possibility\n\t\t\t\t\t// of shk[j] being a key-up hotkey, wildcard hotkey, etc.\n\t\t\t\t\tshk[j]->mType = HK_KEYBD_HOOK;\n\t\t\t\t\t// And if it's currently registered, it will be unregistered later below.\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t} // End of second pass loop.\n\n\t// THIRD PASS THROUGH THE HOTKEYS:\n\t// v1.0.42: Reset sWhichHookNeeded because it's now possible that the hook was on before but no longer\n\t// needed due to changing of a hotkey from hook to registered (for various reasons described above):\n\tsWhichHookNeeded = 0;\n\tfor (i = 0; i < sHotkeyCount; ++i)\n\t{\n\t\tif (hk_is_inactive[i])\n\t\t\tcontinue; // v1.0.40: Treat disabled hotkeys as though they're not even present.\n\t\tHotkey &hot = *shk[i]; // For performance and convenience.\n\n\t\t// HK_MOUSE_HOOK hotkeys, and most HK_KEYBD_HOOK hotkeys, are handled by the hotkey constructor.\n\t\t// What we do here upgrade any NORMAL/registered hotkey to HK_KEYBD_HOOK if there are other\n\t\t// hotkeys that interact or overlap with it in such a way that the hook is preferred.\n\t\t// This evaluation is done here because only now that hotkeys are about to be activated do\n\t\t// we know which ones are disabled or suspended, and thus don't need to be taken into account.\n\t\tif (HK_TYPE_CAN_BECOME_KEYBD_HOOK(hot.mType))\n\t\t{\n\t\t\tif (vk_is_prefix[hot.mVK])\n\t\t\t\t// If it's a suffix that is also used as a prefix, use hook (this allows ^!a to work without $ when \"a & b\" is a hotkey).\n\t\t\t\t// v1.0.42: This was fixed so that mVK_WasSpecifiedByNumber dosn't affect it. That is, a suffix that's\n\t\t\t\t// also used as a prefix should become a hook hotkey even if the suffix is specified as \"vkNNN::\".\n\t\t\t\thot.mType = HK_KEYBD_HOOK;\n\t\t\t\t// And if it's currently registered, it will be unregistered later below.\n\t\t\telse\n\t\t\t{\n\t\t\t\t// v1.0.42: Any #HotIf keyboard hotkey must use the hook if it lacks an enabled,\n\t\t\t\t// non-suspended, global variant. Under those conditions, the hotkey is either:\n\t\t\t\t// 1) Single-variant hotkey that has criteria (non-global).\n\t\t\t\t// 2) Multi-variant hotkey but all variants have criteria (non-global).\n\t\t\t\t// 3) A hotkey with a non-suppressed (~) variant (always, for code simplicity): already handled by AddVariant().\n\t\t\t\t// In both cases above, the hook must handle the hotkey because there can be\n\t\t\t\t// situations in which the hook should let the hotkey's keystroke pass through\n\t\t\t\t// to the active window (i.e. the hook is needed to dynamically disable the hotkey).\n\t\t\t\t// mHookAction isn't checked here since those hotkeys shouldn't reach this stage (since they're always hook hotkeys).\n\t\t\t\tfor (hot.mType = HK_KEYBD_HOOK, vp = hot.mFirstVariant; vp; vp = vp->mNextVariant)\n\t\t\t\t{\n\t\t\t\t\tif ( !vp->mHotCriterion && vp->mEnabled // It's a global variant (no criteria) and it's enabled...\n\t\t\t\t\t\t&& (!g_IsSuspended || vp->mSuspendExempt) )\n\t\t\t\t\t\t// ... and this variant isn't suspended (we already know IsCompletelyDisabled()==false from an earlier check).\n\t\t\t\t\t{\n\t\t\t\t\t\thot.mType = HK_NORMAL; // Reset back to how it was before this loop started. Hook not needed.\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t// If the above promoted it from NORMAL to HOOK but the hotkey is currently registered,\n\t\t\t\t// it will be unregistered later below.\n\t\t\t}\n\t\t}\n\n\t\t// Check if this mouse hotkey also requires the keyboard hook (e.g. #LButton).\n\t\t// Some mouse hotkeys, such as those with normal modifiers, don't require it\n\t\t// since the mouse hook has logic to handle that situation. But those that\n\t\t// are composite hotkeys such as \"RButton & Space\" or \"Space & RButton\" need\n\t\t// the keyboard hook:\n\t\tif (hot.mType == HK_MOUSE_HOOK && (\n\t\t\thot.mModifierSC || hot.mSC // i.e. since it's an SC, the modifying key isn't a mouse button.\n\t\t\t|| hot.mHookAction // v1.0.25.05: At least some alt-tab actions require the keyboard hook. For example, a script consisting only of \"MButton::AltTabAndMenu\" would not work properly otherwise.\n\t\t\t// v1.0.25.05: The line below was added to prevent the Start Menu from appearing, which\n\t\t\t// requires the keyboard hook. ALT hotkeys don't need it because the mouse hook sends\n\t\t\t// a CTRL keystroke to disguise them, a trick that is unfortunately not reliable for\n\t\t\t// when it happens while the while key is down (though it does disguise a Win-up).\n\t\t\t|| ((hot.mModifiersConsolidatedLR & (MOD_LWIN|MOD_RWIN)) && !(hot.mModifiersConsolidatedLR & (MOD_LALT|MOD_RALT)))\n\t\t\t// For v1.0.30, above has been expanded to include Win+Shift and Win+Control modifiers.\n\t\t\t|| (hot.mVK && !IsMouseVK(hot.mVK)) // e.g. \"RButton & Space\"\n\t\t\t|| (hot.mModifierVK && !IsMouseVK(hot.mModifierVK))) ) // e.g. \"Space & RButton\"\n\t\t\thot.mType = HK_BOTH_HOOKS; // Needed by ChangeHookState().\n\t\t\t// For the above, the following types of mouse hotkeys do not need the keyboard hook:\n\t\t\t// 1) mAllowExtraModifiers: Already handled since the mouse hook fetches the modifier state\n\t\t\t// manually when the keyboard hook isn't installed.\n\t\t\t// 2) mModifiersConsolidatedLR (i.e. the mouse button is modified by a normal modifier\n\t\t\t// such as CTRL): Same reason as #1.\n\t\t\t// 3) As a subset of #2, mouse hotkeys that use WIN as a modifier will not have the\n\t\t\t// Start Menu suppressed unless the keyboard hook is installed. It's debatable,\n\t\t\t// but that seems a small price to pay (esp. given how rare it is just to have\n\t\t\t// the mouse hook with no keyboard hook) to avoid the overhead of the keyboard hook.\n\t\t\n\t\t// If the hotkey is normal, try to register it. If the register fails, use the hook to try\n\t\t// to override any other script or program that might have it registered (as documented):\n\t\tif (hot.mType == HK_NORMAL)\n\t\t{\n\t\t\tif (!hot.Register()) // Can't register it, usually due to some other application or the OS using it.\n\t\t\t\thot.mType = HK_KEYBD_HOOK;\n\t\t}\n\t\telse // mType isn't NORMAL (possibly due to something above changing it), so ensure it isn't registered.\n\t\t\tif (hot.mIsRegistered) // Improves typical performance since this hotkey could be mouse, joystick, etc.\n\t\t\t\t// Although the hook effectively overrides registered hotkeys, they should be unregistered anyway\n\t\t\t\t// to prevent the Send command from triggering the hotkey, and perhaps other side-effects.\n\t\t\t\thot.Unregister();\n\n\t\tswitch (hot.mType)\n\t\t{\n\t\tcase HK_KEYBD_HOOK: sWhichHookNeeded |= HOOK_KEYBD; break;\n\t\tcase HK_MOUSE_HOOK: sWhichHookNeeded |= HOOK_MOUSE; break;\n\t\tcase HK_BOTH_HOOKS: sWhichHookNeeded |= HOOK_KEYBD|HOOK_MOUSE; break;\n\t\t}\n\t} // for()\n\n\t// Check if anything else requires the hook.\n\t// But do this part outside of the above block because these values may have changed since\n\t// this function was first called. By design, the Num/Scroll/CapsLock AlwaysOn/Off setting\n\t// stays in effect even when Suspend in ON.\n\tif ( Hotstring::sEnabledCount\n\t\t|| g_input // v1.0.91: Hook is needed for collecting input.\n\t\t|| !(g_ForceNumLock == NEUTRAL && g_ForceCapsLock == NEUTRAL && g_ForceScrollLock == NEUTRAL) )\n\t\tsWhichHookNeeded |= HOOK_KEYBD;\n\tif (g_BlockMouseMove || (g_HSResetUponMouseClick && Hotstring::sEnabledCount))\n\t\tsWhichHookNeeded |= HOOK_MOUSE;\n\n\t// Install or deinstall either or both hooks, if necessary, based on these param values.\n\tChangeHookState(shk, sHotkeyCount, sWhichHookNeeded, sWhichHookAlways);\n\n\t// Fix for v1.0.34: If the auto-execute section uses the Hotkey command but returns before doing\n\t// something that calls MsgSleep, the main timer won't have been turned on. For example:\n\t// Hotkey, Joy1, MySubroutine\n\t// ;Sleep 1 ; This was a workaround before this fix.\n\t// return\n\t// By putting the following check here rather than in AutoHotkey.cpp, that problem is resolved.\n\t// In addition...\n\tif (sJoyHotkeyCount) // Joystick hotkeys require the timer to be always on.\n\t\tSET_MAIN_TIMER\n}\n\n\n\nvoid Hotkey::MaybeUninstallHook()\n// Caller knows that one of the users of the keyboard hook no longer requires it,\n// and wants it uninstalled if it is no longer needed by anything else.\n{\n\t// Do some quick checks to avoid scanning all hotkeys unnecessarily:\n\tif (g_input || Hotstring::sEnabledCount || (sWhichHookAlways & HOOK_KEYBD))\n\t\treturn;\n\t// Do more thorough checking to determine whether the hook is still needed:\n\tManifestAllHotkeysHotstringsHooks();\n}\n\n\n\nvoid Hotkey::AllDestruct()\n{\n\t// MSDN: \"Before terminating, an application must call the UnhookWindowsHookEx function to free\n\t// system resources associated with the hook.\"\n\tAddRemoveHooks(0); // Remove all hooks. By contrast, registered hotkeys are unregistered below.\n\tif (g_PlaybackHook) // Would be unusual for this to be installed during exit, but should be checked for completeness.\n\t\tUnhookWindowsHookEx(g_PlaybackHook);\n\tfor (int i = 0; i < sHotkeyCount; ++i)\n\t\tdelete shk[i]; // Unregisters before destroying.\n}\n\n\n\nbool Hotkey::PrefixHasNoEnabledSuffixes(int aVKorSC, bool aIsSC, bool &aSuppress)\n// aVKorSC contains the virtual key or scan code of the specified prefix key (it's a scan code if aIsSC is true).\n// Returns true if this prefix key has no suffixes that can possibly fire. Each such suffix is prevented from\n// firing by one or more of the following:\n// 1) Hotkey is completely disabled via IsCompletelyDisabled().\n// 2) Hotkey has criterion and those criterion do not allow the hotkey to fire.\n// Caller is expected to set aSuppress to a default of false.\n{\n\t// v1.0.44: Added aAsModifier so that a pair of hotkeys such as:\n\t// LControl::tooltip LControl\n\t// <^c::tooltip ^c\n\t// ...works as it did in versions prior to 1.0.41, namely that LControl fires on key-up rather than\n\t// down because it is considered a prefix key for the <^c hotkey .\n\tmodLR_type aAsModifier = KeyToModifiersLR(aIsSC ? 0 : aVKorSC, aIsSC ? aVKorSC : 0, NULL);\n\n\tbool has_enabled_suffix = false;\n\n\tfor (int i = 0; i < sHotkeyCount; ++i)\n\t{\n\t\tHotkey &hk = *shk[i];\n\t\tif (aVKorSC != (aIsSC ? hk.mModifierSC : hk.mModifierVK) && !(aAsModifier & hk.mModifiersLR)\n\t\t\t|| hk.IsCompletelyDisabled())\n\t\t\tcontinue; // This hotkey isn't enabled or it doesn't use the specified key as a prefix. No further checking for it.\n\t\tif (hk.mHookAction)\n\t\t{\n\t\t\tif (g_IsSuspended)\n\t\t\t\t// An alt-tab hotkey (non-NULL mHookAction) is always suspended when g_IsSuspended==true because\n\t\t\t\t// alt-tab hotkeys have no subroutine capable of making them exempt. So g_IsSuspended is checked\n\t\t\t\t// for alt-tab hotkeys here; and for other types of hotkeys, it's checked further below.\n\t\t\t\tcontinue;\n\t\t\t//else // This alt-tab hotkey is currently active.\n\t\t\tif ((hk.mNoSuppress & NO_SUPPRESS_PREFIX) || aSuppress)\n\t\t\t\treturn false; // Since any stored mHotCriterion are ignored for alt-tab hotkeys, no further checking is needed.\n\t\t\thas_enabled_suffix = true;\n\t\t\tcontinue; // Still need to check other hotkeys for NO_SUPPRESS_PREFIX.\n\t\t}\n\t\tif (has_enabled_suffix && !(hk.mNoSuppress & NO_SUPPRESS_PREFIX))\n\t\t\tcontinue; // No need to evaluate this hotkey's variants.\n\t\t// Otherwise, find out if any of its variants is eligible to fire. If so, immediately return\n\t\t// false because even one eligible hotkey means this prefix is enabled.\n\t\tfor (HotkeyVariant *vp = hk.mFirstVariant; vp; vp = vp->mNextVariant)\n\t\t\t// v1.0.42: Fixed to take into account whether the hotkey is suspended (previously it only checked\n\t\t\t// whether the hotkey was enabled (above), which isn't enough):\n\t\t\tif ( vp->mEnabled // This particular variant within its parent hotkey is enabled.\n\t\t\t\t&& (!g_IsSuspended || vp->mSuspendExempt) // This variant isn't suspended...\n\t\t\t\t&& (!vp->mHotCriterion || HotCriterionAllowsFiring(vp->mHotCriterion, hk.mName)) ) // ... and its criteria allow it to fire.\n\t\t\t{\n\t\t\t\tif ((vp->mNoSuppress & NO_SUPPRESS_PREFIX) || aSuppress)\n\t\t\t\t\treturn false; // At least one of this prefix's suffixes is eligible for firing.\n\t\t\t\thas_enabled_suffix = true;\n\t\t\t\tif (!(hk.mNoSuppress & NO_SUPPRESS_PREFIX))\n\t\t\t\t\tbreak; // None of this hotkey's variants have NO_SUPPRESS_PREFIX.\n\t\t\t\t// Keep checking to ensure no other enabled variants have NO_SUPPRESS_PREFIX.\n\t\t\t}\n\t}\n\t// Since above didn't return, either no hotkeys were found for this prefix that are capable of firing,\n\t// or no variants were found with the NO_SUPPRESS_PREFIX flag.\n\taSuppress = has_enabled_suffix;\n\treturn !has_enabled_suffix;\n}\n\n\n\nHotkeyVariant *Hotkey::CriterionAllowsFiring(HWND *aFoundHWND, ULONG_PTR aExtraInfo, LPTSTR aSingleChar)\n// Caller must not call this for AltTab hotkeys IDs because this will always return NULL in such cases.\n// Returns the address of the first matching non-global hotkey variant that is allowed to fire.\n// If there is no non-global one eligible, the global one is returned (or NULL if none).\n// If non-NULL, aFoundHWND is an output variable for the caller, but it is only set if a\n// non-global/criterion variant is found; that is, it isn't changed when no match is found or\n// when the match is a global variant. Even when set, aFoundHWND will be (HWND)1 for\n// \"not-criteria\" such as #HotIf Not WinActive().\n{\n\t// Check mParentEnabled in case the hotkey became disabled between the time the message was posted\n\t// and the time it arrived. A similar check is done for \"suspend\" later below (since \"suspend\"\n\t// is a per-variant attribute).\n\tif (!mParentEnabled) // IsCompletelyDisabled() isn't called because the loop below checks all the mEnabled flags, no need to do it twice.\n\t\treturn NULL;\n\n\tHWND unused;\n\tHWND &found_hwnd = aFoundHWND ? *aFoundHWND : unused; // To simplify other things.\n\tfound_hwnd = NULL; // Set default output parameter for caller (in case loop never sets it).\n\tHotkeyVariant *vp, *vp_to_fire;\n\n\t// aHookAction isn't checked because this should never be called for alt-tab hotkeys (see other comments above).\n\tfor (vp_to_fire = NULL, vp = mFirstVariant; vp; vp = vp->mNextVariant)\n\t{\n\t\t// Technically, g_IsSuspended needs to be checked only if our caller is TriggerJoyHotkeys()\n\t\t// because other callers would never have received the hotkey message in the first place.\n\t\t// However, since it's possible for a hotkey to become suspended between the time its hotkey\n\t\t// message is posted and the time it is fetched and processed, aborting the firing seems\n\t\t// like the best choice for the widest variety of circumstances (even though it's a departure\n\t\t// from the behavior in previous versions). Another reason to check g_IsSuspended unconditionally\n\t\t// is for maintainability and code size reduction. Finally, it's unlikely to significantly\n\t\t// impact performance since the vast majority of hotkeys have either one or just a few variants.\n\t\tif ( vp->mEnabled // This particular variant within its parent hotkey is enabled.\n\t\t\t&& (!g_IsSuspended || vp->mSuspendExempt) // This variant isn't suspended...\n\t\t\t&& HotInputLevelAllowsFiring(vp->mInputLevel, aExtraInfo, aSingleChar) // ... its #InputLevel allows it to fire...\n\t\t\t&& (!vp->mHotCriterion || (found_hwnd = HotCriterionAllowsFiring(vp->mHotCriterion, mName))) ) // ... and its criteria allow it to fire.\n\t\t{\n\t\t\tif (vp->mHotCriterion) // Since this is the first criteria hotkey, it takes precedence.\n\t\t\t\treturn vp;\n\t\t\t//else since this is variant has no criteria, let the first criteria variant in the list\n\t\t\t// take precedence over it (if there is one). If none is found, the vp_to_fire will stay\n\t\t\t// set as the non-criterion variant.\n\t\t\tvp_to_fire = vp;\n\t\t}\n\t}\n\treturn vp_to_fire; // Either NULL or the variant found by the loop.\n}\n\nbool HotInputLevelAllowsFiring(SendLevelType inputLevel, ULONG_PTR aEventExtraInfo, LPTSTR aKeyHistoryChar)\n{\n\tif (InputLevelFromInfo(aEventExtraInfo) <= inputLevel)\n\t{\n\t\tif (aKeyHistoryChar)\n\t\t\t*aKeyHistoryChar = 'i'; // Mark as ignored in KeyHistory\n\t\treturn false;\n\t}\n\treturn true;\n}\n\n\nHotkeyVariant *Hotkey::CriterionFiringIsCertain(HotkeyIDType &aHotkeyIDwithFlags, bool aKeyUp, ULONG_PTR aExtraInfo\n\t, bool &aFireWithNoSuppress, LPTSTR aSingleChar)\n// v1.0.44: Caller has ensured that aFireWithNoSuppress is true if has already been decided and false if undecided.\n// Upon return, caller can assume that the value in it is now decided rather than undecided.\n// v1.0.42: Caller must not call this for AltTab hotkeys IDs, but this will always return NULL in such cases.\n// *aSingleChar is sometimes modified for the caller here (if aSingleChar isn't NULL).\n// Caller has ensured that aHotkeyIDwithFlags contains a valid/existing hotkey ID.\n// Technically, aHotkeyIDwithMask can be with or without the flags in the high bits.\n// If present, they're removed.\n{\n\t// aHookAction isn't checked because this should never be called for alt-tab hotkeys (see other comments above).\n\tHotkeyIDType hotkey_id = aHotkeyIDwithFlags & HOTKEY_ID_MASK;\n\t// The following check is for maintainability, since caller should have already checked and\n\t// handled HOTKEY_ID_ALT_TAB and similar. Less-than-zero check not necessary because it's unsigned.\n\tif (hotkey_id >= sHotkeyCount)\n\t\treturn NULL; // Special alt-tab hotkey quasi-ID used by the hook.\n\tHotkey &hk = *shk[hotkey_id]; // For convenience and performance.\n\n\tif (aFireWithNoSuppress // Caller has already determined its value with certainty...\n\t\t|| (hk.mNoSuppress & NO_SUPPRESS_SUFFIX_VARIES) != NO_SUPPRESS_SUFFIX_VARIES) // ...or its value is easy to determine, so do it now (compare to itself since it's a bitwise union).\n\t{\n\t\t// Since aFireWithNoSuppress can now be easily determined for the caller (or was already determined by the caller\n\t\t// itself), it's possible to take advantage of the following optimization, which is especially important in cases\n\t\t// where TitleMatchMode is \"slow\":\n\t\t// For performance, the following returns without having called WinExist/Active if it sees that one of this\n\t\t// hotkey's variant's will certainly fire due to the fact that it has a non-suspended global variant.\n\t\t// This reduces the number of situations in which double the number of WinExist/Active() calls are made\n\t\t// (once in the hook to determine whether the hotkey keystroke should be passed through to the active window,\n\t\t// and again upon receipt of the message for reasons explained there).\n\t\tfor (HotkeyVariant *vp = hk.mFirstVariant; vp; vp = vp->mNextVariant)\n\t\t\tif (!vp->mHotCriterion && vp->mEnabled && (!g_IsSuspended || vp->mSuspendExempt)\n\t\t\t\t&& HotInputLevelAllowsFiring(vp->mInputLevel, aExtraInfo, aSingleChar))\n\t\t\t{\n\t\t\t\t// Fix for v1.0.47.02: The following section (above \"return\") was moved into this block\n\t\t\t\t// from above the for() because only when this for() returns is it certain that this\n\t\t\t\t// hk/hotkey_id is actually the right one, and thus its attributes can be used to determine\n\t\t\t\t// aFireWithNoSuppress for the caller.\n\t\t\t\t// Since this hotkey has variants only of one type (tilde or non-tilde), this variant must be of that type.\n\t\t\t\tif (!aFireWithNoSuppress) // Caller hasn't yet determined its value with certainty (currently, this statement might always be true).\n\t\t\t\t\taFireWithNoSuppress = (hk.mNoSuppress & AT_LEAST_ONE_VARIANT_HAS_TILDE); // Due to other checks, this means all variants are tilde.\n\t\t\t\treturn vp; // Caller knows this isn't necessarily the variant that will fire since !vp->mHotCriterion.\n\t\t\t}\n\t}\n\n\t// Since above didn't return, a slower method is needed to find out which variant of this hotkey (if any)\n\t// should fire.\n\tHotkeyVariant *vp;\n\tif (vp = hk.CriterionAllowsFiring(NULL, aExtraInfo, aSingleChar))\n\t{\n\t\tif (!aFireWithNoSuppress) // Caller hasn't yet determined its value with certainty (currently, this statement might always be true).\n\t\t\taFireWithNoSuppress = (vp->mNoSuppress & AT_LEAST_ONE_VARIANT_HAS_TILDE);\n\t\treturn vp; // It found an eligible variant to fire.\n\t}\n\n\t// Since above didn't find any variant of the hotkey than can fire, check for other eligible hotkeys.\n\tif (!hk.mHookAction) // Rule out those that aren't susceptible to the bug.\n\t{\n\t\t// Custom combos are no longer ruled out by the above since they allow extra modifiers and\n\t\t// are capable of obscuring non-custom combos; e.g. LCtrl & a:: obscures <^a::, ^+a:: and so on.\n\t\t// Fix for v1.0.46.13: Although the section higher above found no variant to fire for the\n\t\t// caller-specified hotkey ID, it's possible that some other hotkey (one with a wildcard) is\n\t\t// eligible to fire due to the eclipsing behavior of wildcard hotkeys. For example:\n\t\t// #HotIf Not WinActive(\"Untitled\")\n\t\t// q::tooltip ThisHotkey . \" Non-notepad\"\n\t\t// #HotIf WinActive(\"Untitled\")\n\t\t// *q::tooltip ThisHotkey . \" Notepad\"\n\t\t// However, the logic here might not be a perfect solution because it fires the first available\n\t\t// hotkey that has a variant whose criteria are met (which might not be exactly the desired rules\n\t\t// of precedence). However, I think it's extremely rare that there would be more than one hotkey\n\t\t// that matches the original hotkey (VK, SC, has-wildcard) etc. Even in the rare cases that there\n\t\t// is more than one, the rarity is compounded by the rarity of the bug even occurring, which probably\n\t\t// makes the odds vanishingly small. That's why the following simple, high-performance loop is used\n\t\t// rather than more a more complex one that \"locates the smallest (most specific) eclipsed wildcard\n\t\t// hotkey\", or \"the uppermost variant among all eclipsed wildcards that is eligible to fire\".\n\t\t// UPDATE: This now uses a linked list of hotkeys which share the same suffix key, in the order of\n\t\t// sort_most_general_before_least, which might solve the concern about precedence.\n\t\tmod_type modifiers = ConvertModifiersLR(g_modifiersLR_logical_non_ignored); // Neutral modifiers.\n\t\tfor (HotkeyIDType candidate_id = hk.mNextHotkey; candidate_id != HOTKEY_ID_INVALID; )\n\t\t{\n\t\t\tHotkey &hk2 = *shk[candidate_id]; // For performance and convenience.\n\t\t\tcandidate_id = hk2.mNextHotkey;\n\t\t\t// Non-wildcard hotkeys are eligible for the workaround in cases like ^+a vs <^+a vs ^<+a, where\n\t\t\t// the neutral modifier acts as a sort of wildcard (it permits left, right or both). This also\n\t\t\t// increases support for varying names, such as Esc vs. Escape vs. vk1B (which already partially\n\t\t\t// worked if wildcards were used).\n\t\t\t// However, must ensure only the allowed modifiers are down when !mAllowExtraModifiers.\n\t\t\t// mVK and mSC aren't checked since the linked list only includes hotkeys for this same suffix key.\n\t\t\t// This also allows the workaround to be partially applied to LCtrl vs. Ctrl and similar (as suffixes).\n\t\t\tif ( (hk2.mAllowExtraModifiers || !(~hk2.mModifiersConsolidatedLR & g_modifiersLR_logical_non_ignored))\n\t\t\t\t&& hk2.mKeyUp == hk.mKeyUp // Seems necessary that up/down nature is the same in both.\n\t\t\t\t&& !hk2.mModifierVK // Avoid accidental matching of normal hotkeys with custom-combo \"&\"\n\t\t\t\t&& !hk2.mModifierSC // hotkeys that happen to have the same mVK/SC.\n\t\t\t\t&& !hk2.mHookAction // Might be unnecessary to check this; but just in case.\n\t\t\t\t&& hk2.mID != hotkey_id // Don't consider the original hotkey because it was already found ineligible.\n\t\t\t\t&& !(hk2.mModifiers & ~modifiers) // All neutral modifiers required by the candidate are pressed.\n\t\t\t\t&& !(hk2.mModifiersLR & ~g_modifiersLR_logical_non_ignored) // All left-right specific modifiers required by the candidate are pressed.\n\t\t\t\t//&& hk2.mType != HK_JOYSTICK // Seems unnecessary since joystick hotkeys don't call us and even if they did, probably shouldn't be included.\n\t\t\t\t//&& hk2.mParentEnabled ) // CriterionAllowsFiring() will check this for us.\n\t\t\t\t)\n\t\t\t{\n\t\t\t\t// The following section is similar to one higher above, so maintain them together:\n\t\t\t\tif (vp = hk2.CriterionAllowsFiring(NULL, aExtraInfo, aSingleChar))\n\t\t\t\t{\n\t\t\t\t\tif (!aFireWithNoSuppress) // Caller hasn't yet determined its value with certainty (currently, this statement might always be true).\n\t\t\t\t\t\taFireWithNoSuppress = (vp->mNoSuppress & AT_LEAST_ONE_VARIANT_HAS_TILDE);\n\t\t\t\t\taHotkeyIDwithFlags = hk2.mID; // Caller currently doesn't need the flags put onto it, so they're omitted.\n\t\t\t\t\treturn vp; // It found an eligible variant to fire.\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Otherwise, this hotkey has no variants that can fire. Caller wants a few things updated in that case.\n\n\t// v1.1.37: The following isn't done anymore because it makes logic elsewhere harder to follow,\n\t// and was causing a bug where the key-up event of a custom prefix key wasn't suppressed if the\n\t// key had an ineligible key-down hotkey and an eligible key-up hotkey. Another reason not to\n\t// do it is that some callers will consider alternative hotkeys after we return false, so the\n\t// proper value of fire_with_no_suppress can only be known when firing IS certain. The simple\n\t// and logical solution to the issue mentioned below is for certain callers to check our return\n\t// value, and if false, don't suppress.\n\t//if (!aFireWithNoSuppress) // Caller hasn't yet determined its value with certainty.\n\t//\taFireWithNoSuppress = true; // Fix for v1.0.47.04: Added this line and the one above to fix the fact that a context-sensitive hotkey like \"a UP::\" would block the down-event of that key even when the right window/criteria aren't met.\n\n\tif (aSingleChar && *aSingleChar != 'i') // 'i' takes precedence because it's used to detect when #InputLevel prevented the hotkey from firing, to prevent it from being suppressed.\n\t\t*aSingleChar = '#'; // '#' in KeyHistory to indicate this hotkey is disabled due to #HotIf WinActive/Exist() criterion.\n\treturn NULL;\n}\n\n\n\nHotkeyIDType Hotkey::FindPairedHotkey(HotkeyIDType aFirstID, modLR_type aModsLR, bool aKeyUp)\n{\n\tmod_type modifiers = ConvertModifiersLR(aModsLR); // Neutral modifiers.\n\tfor (HotkeyIDType candidate_id = aFirstID; candidate_id != HOTKEY_ID_INVALID; )\n\t{\n\t\tHotkey &hk2 = *shk[candidate_id]; // For performance and convenience.\n\t\tcandidate_id = hk2.mNextHotkey;\n\t\tif ( (hk2.mAllowExtraModifiers || !(~hk2.mModifiersConsolidatedLR & aModsLR))\n\t\t\t&& hk2.mKeyUp == aKeyUp\n\t\t\t&& !hk2.mModifierVK // Avoid accidental matching of normal hotkeys with custom-combo \"&\"\n\t\t\t&& !hk2.mModifierSC // hotkeys that happen to have the same mVK/SC.\n\t\t\t&& !hk2.mHookAction // Might be unnecessary to check this; but just in case.\n\t\t\t&& !(hk2.mModifiers & ~modifiers) // All neutral modifiers required by the candidate are pressed.\n\t\t\t&& !(hk2.mModifiersLR & ~aModsLR) // All left-right specific modifiers required by the candidate are pressed.\n\t\t\t//&& hk2.mParentEnabled // CriterionAllowsFiring() will check this for us.\n\t\t\t)\n\t\t\treturn aKeyUp ? (hk2.mID | HOTKEY_KEY_UP) : hk2.mID;\n\t}\n\treturn HOTKEY_ID_INVALID;\n}\n\n\n\nmodLR_type Hotkey::HotkeyRequiresModLR(HotkeyIDType aHotkeyID, modLR_type aModLR)\n{\n\tif (aHotkeyID >= sHotkeyCount)\n\t\treturn 0;\n\treturn shk[aHotkeyID]->mModifiersConsolidatedLR & aModLR;\n}\n\n\n\nvoid Hotkey::TriggerJoyHotkeys(int aJoystickID, DWORD aButtonsNewlyDown)\n{\n\tfor (int i = 0; i < sHotkeyCount; ++i)\n\t{\n\t\tHotkey &hk = *shk[i]; // For performance and convenience.\n\t\t// Fix for v1.0.34: If hotkey isn't enabled, or hotkeys are suspended and this one isn't\n\t\t// exempt, don't fire it. These checks are necessary only for joystick hotkeys because \n\t\t// normal hotkeys are completely deactivated when turned off or suspended, but the joystick\n\t\t// is still polled even when some joystick hotkeys are disabled. UPDATE: In v1.0.42, Suspend\n\t\t// is checked upon receipt of the message, not here upon sending.\n\t\tif (hk.mType == HK_JOYSTICK && hk.mVK == aJoystickID\n\t\t\t&& (aButtonsNewlyDown & ((DWORD)0x01 << (hk.mSC - JOYCTRL_1)))) // This hotkey's button is among those newly pressed.\n\t\t{\n\t\t\t// Criteria are checked, and variant determined, upon arrival of message rather than when sending\n\t\t\t// (\"suspend\" is also checked then). This is because joystick button presses are never hidden\n\t\t\t// from the active window (the concept really doesn't apply), so not checking here avoids the\n\t\t\t// performance loss of a second check (the loss can be significant in the case of\n\t\t\t// \"SetTitleMatchMode Slow\").\n\t\t\t//\n\t\t\t// Post it to the thread because the message pump itself (not the WindowProc) will handle it.\n\t\t\t// UPDATE: Posting to NULL would have a risk of discarding the message if a MsgBox pump or\n\t\t\t// pump other than MsgSleep() were running. The only reason it doesn't is that this function\n\t\t\t// is only ever called from MsgSleep(), which is careful to process all messages (at least\n\t\t\t// those that aren't kept queued due to the message filter) prior to returning to its caller.\n\t\t\t// But for maintainability, it seems best to change this to g_hWnd vs. NULL to make joystick\n\t\t\t// hotkeys behave more like standard hotkeys.\n\t\t\tPostMessage(g_hWnd, WM_HOTKEY, (WPARAM)i, 0);\n\t\t}\n\t\t//else continue the loop in case the user has newly pressed more than one joystick button.\n\t}\n}\n\n\n\nvoid Hotkey::PerformInNewThreadMadeByCaller(HotkeyVariant &aVariant)\n// Caller is responsible for having called PerformIsAllowed() before calling us.\n// Caller must have already created a new thread for us, and must close the thread when we return.\n{\n\tstatic bool sDialogIsDisplayed = false; // Prevents double-display caused by key buffering.\n\tif (sDialogIsDisplayed) // Another recursion layer is already displaying the warning dialog below.\n\t\treturn; // Don't allow new hotkeys to fire during that time.\n\n\t// Help prevent runaway hotkeys (infinite loops due to recursion in bad script files):\n\tstatic UINT throttled_key_count = 0; // This var doesn't belong in struct since it's used only here.\n\tUINT time_until_now;\n\tint display_warning;\n\tif (!sTimePrev)\n\t\tsTimePrev = GetTickCount();\n\n\t++throttled_key_count;\n\tsTimeNow = GetTickCount();\n\t// Calculate the amount of time since the last reset of the sliding interval.\n\t// Note: A tickcount in the past can be subtracted from one in the future to find\n\t// the true difference between them, even if the system's uptime is greater than\n\t// 49 days and the future one has wrapped but the past one hasn't. This is\n\t// due to the nature of DWORD subtraction. The only time this calculation will be\n\t// unreliable is when the true difference between the past and future\n\t// tickcounts itself is greater than about 49 days:\n\ttime_until_now = (sTimeNow - sTimePrev);\n\tif (display_warning = (throttled_key_count > g_MaxHotkeysPerInterval\n\t\t&& time_until_now < g_HotkeyThrottleInterval))\n\t{\n\t\t// The moment any dialog is displayed, hotkey processing is halted since this\n\t\t// app currently has only one thread.\n\t\tTCHAR error_text[2048];\n\t\t// Using %f with wsprintf() yields a floating point runtime error dialog.\n\t\t// UPDATE: That happens if you don't cast to float, or don't have a float var\n\t\t// involved somewhere. Avoiding floats altogether may reduce EXE size\n\t\t// and maybe other benefits (due to it not being \"loaded\")?\n\t\tsntprintf(error_text, _countof(error_text), _T(\"%u hotkeys have been received in the last %ums.\\n\\n\")\n\t\t\t_T(\"Do you want to continue?\\n(see A_MaxHotkeysPerInterval in the help file)\") // In case its stuck in a loop.\n\t\t\t, throttled_key_count, time_until_now);\n\n\t\t// Turn off any RunAgain flags that may be on, which in essence is the same as de-buffering\n\t\t// any pending hotkey keystrokes that haven't yet been fired:\n\t\tResetRunAgainAfterFinished();\n\n\t\t// This is now needed since hotkeys can still fire while a messagebox is displayed.\n\t\t// Seems safest to do this even if it isn't always necessary:\n\t\tsDialogIsDisplayed = true;\n\t\tg_AllowInterruption = FALSE;\n\t\tif (MsgBox(error_text, MB_YESNO) == IDNO)\n\t\t\tg_script.ExitApp(EXIT_CLOSE); // Might not actually Exit if there's an OnExit function.\n\t\tg_AllowInterruption = TRUE;\n\t\tsDialogIsDisplayed = false;\n\t}\n\t// The display_warning var is needed due to the fact that there's an OR in this condition:\n\tif (display_warning || time_until_now > g_HotkeyThrottleInterval)\n\t{\n\t\t// Reset the sliding interval whenever it expires. Doing it this way makes the\n\t\t// sliding interval more sensitive than alternate methods might be.\n\t\t// Also reset it if a warning was displayed, since in that case it didn't expire.\n\t\tthrottled_key_count = 0;\n\t\tsTimePrev = sTimeNow;\n\t}\n\tif (display_warning)\n\t\t// At this point, even though the user chose to continue, it seems safest\n\t\t// to ignore this particular hotkey event since it might be WinClose or some\n\t\t// other command that would have unpredictable results due to the displaying\n\t\t// of the dialog itself.\n\t\treturn;\n\n\n\t// This is stored as an attribute of the script (semi-globally) rather than passed\n\t// as a parameter to ExecUntil (and from their on to any calls to SendKeys() that it\n\t// makes) because it's possible for SendKeys to be called asynchronously, namely\n\t// by a timed subroutine, while A_HotkeyModifierTimeout is still in effect,\n\t// in which case we would want SendKeys() to take note of these modifiers even\n\t// if it was called from an ExecUntil() other than ours here:\n\tg_script.mThisHotkeyModifiersLR = mModifiersConsolidatedLR;\n\n\t// LAUNCH HOTKEY SUBROUTINE:\n\t++aVariant.mExistingThreads; // This is the thread count for this particular hotkey only.\n\n\tExprTokenType params = { mName };\n\tResultType result = aVariant.mCallback->ExecuteInNewThread(g_script.mThisHotkeyName, ¶ms, 1);\n\t\n\t--aVariant.mExistingThreads;\n\n\tif (result == FAIL)\n\t\taVariant.mRunAgainAfterFinished = false; // Ensure this is reset due to the error.\n\telse if (aVariant.mRunAgainAfterFinished)\n\t{\n\t\t// But MsgSleep() can change it back to true again, when called by the above call\n\t\t// to ExecUntil(), to keep it auto-repeating:\n\t\taVariant.mRunAgainAfterFinished = false; // i.e. this \"run again\" ticket has now been used up.\n\t\tif (GetTickCount() - aVariant.mRunAgainTime <= 1000)\n\t\t{\n\t\t\t// v1.0.44.14: Post a message rather than directly running the above ExecUntil again.\n\t\t\t// This fixes unreported bugs in previous versions where the thread isn't reinitialized before\n\t\t\t// the launch of one of these buffered hotkeys, which caused settings such as SetKeyDelay\n\t\t\t// not to start off at their defaults. Also, there are quite a few other things that the main\n\t\t\t// event loop does to prep for the launch of a hotkey. Rather than copying them here or\n\t\t\t// trying to put them into a shared function (which would be difficult due to their nature),\n\t\t\t// it's much more maintainable to post a message, and in most cases, it shouldn't measurably\n\t\t\t// affect response time (this feature is rarely used anyway).\n\t\t\tPostMessage(g_hWnd, WM_HOTKEY, (WPARAM)mID, 0);\n\t\t}\n\t\t//else it was posted too long ago, so don't do it. This is because most users wouldn't\n\t\t// want a buffered hotkey to stay pending for a long time after it was pressed, because\n\t\t// that might lead to unexpected behavior.\n\t}\n}\n\n\n\nFResult Hotkey::IfExpr(IObject *aExprObj)\n// HotIf ; Set null criterion.\n// HotIf FunctionObject\n{\n\tif (aExprObj)\n\t{\n\t\tHotkeyCriterion *cp;\n\t\t// v2.1: Search all criterion. Callback is non-null if cp->Type == HOT_IF_CALLBACK\n\t\t// or if A_HotIf has been used while g->HotCriterion->Type != HOT_IF_CALLBACK.\n\t\tfor (cp = g_FirstHotCriterion; ; cp = cp->NextCriterion)\n\t\t{\n\t\t\tif (!cp) // End of the list and it wasn't found.\n\t\t\t{\n\t\t\t\tauto fr = ValidateFunctor(aExprObj, 1);\n\t\t\t\tif (fr != OK)\n\t\t\t\t\treturn fr;\n\t\t\t\tif ( !(cp = AddHotkeyIfExpr()) )\n\t\t\t\t\treturn FR_E_OUTOFMEM;\n\t\t\t\taExprObj->AddRef();\n\t\t\t\tcp->Type = HOT_IF_CALLBACK;\n\t\t\t\tcp->Callback = aExprObj;\n\t\t\t\tcp->WinTitle = _T(\"\");\n\t\t\t\tcp->WinText = _T(\"\");\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (cp->Callback == aExprObj)\n\t\t\t\tbreak;\n\t\t}\n\t\tg->HotCriterion = cp;\n\t}\n\telse\n\t{\n\t\tg->HotCriterion = nullptr;\n\t}\n\treturn OK;\n}\n\n\n\nFResult Hotkey::IfExpr(LPCTSTR aExpr)\n// HotIf ; Set null criterion.\n// HotIf \"Exact-expression-text\"\n{\n\tif (!aExpr || !*aExpr)\n\t{\n\t\tg->HotCriterion = nullptr;\n\t}\n\telse\n\t{\n\t\tHotkeyCriterion *cp = FindHotkeyIfExpr(aExpr);\n\t\tif (!cp) // Expression not found.\n\t\t\treturn FValueError(ERR_HOTKEY_IF_EXPR, aExpr);\n\t\tg->HotCriterion = cp;\n\t}\n\treturn OK;\n}\n\n\n\nFResult Hotkey::Dynamic(LPCTSTR aHotkeyName, LPCTSTR aOptions, IObject *aCallback, HookActionType aHookAction)\n// Creates, updates, enables, or disables a hotkey dynamically (while the script is running).\n// Returns OK or FAIL.\n{\n\t// Caller has ensured that aCallback and aHookAction can't both be non-zero. Furthermore,\n\t// both can be zero/NULL only when the caller is updating an existing hotkey to have new options\n\t// (i.e. it's retaining its current callback).\n\tif (aCallback)\n\t{\n\t\tauto fr = ValidateFunctor(aCallback, 1);\n\t\tif (fr != OK)\n\t\t\treturn fr;\n\t}\n\n\tHotkeyIDType on_off = HOTKEY_ID_INVALID;\n\tbool set_max_threads_buffer = false,\tnew_max_threads_buffer;\n\tbool set_suspend_exempt = false,\t\tnew_suspend_exempt;\n\tbool set_priority = false;\t\t\tint new_priority;\n\tbool set_max_threads = false;\t\tint new_max_threads;\n\tbool set_input_level = false;\t\tint new_input_level;\n\n\t// Parse options up front so that if any are invalid, no hotkey is created or altered.\n\tfor (auto cp = aOptions; *cp; )\n\t{\n\t\tswitch (ctoupper(*cp++))\n\t\t{\n\t\tcase 'O':\n\t\t\tif (ctoupper(*cp) == 'N')\n\t\t\t{\n\t\t\t\tcp += 1;\n\t\t\t\ton_off = HOTKEY_ID_ON;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\telse if (!_tcsnicmp(cp - 1, _T(\"Off\"), 3))\n\t\t\t{\n\t\t\t\tcp += 2;\n\t\t\t\ton_off = HOTKEY_ID_OFF;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// Fall through:\n\t\tdefault:\n\t\t\treturn FR_E_ARG(2);\n\t\tcase 'B':\n\t\t\tset_max_threads_buffer = true;\n\t\t\tnew_max_threads_buffer = (*cp != '0'); // i.e. if the char is NULL or something other than '0'.\n\t\t\tcp += (*cp == '0' || *cp == '1');\n\t\t\tcontinue;\n\t\t// For options such as P & T: Require base 10 to prohibit ambiguous cases like P0x01B (since B is a valid option letter).\n\t\tcase 'P':\n\t\t\tset_priority = true;\n\t\t\tnew_priority = _tcstol(cp, const_cast<LPTSTR*>(&cp), 10);\n\t\t\tbreak;\n\t\tcase 'S':\n\t\t\tset_suspend_exempt = true;\n\t\t\tnew_suspend_exempt = (*cp != '0');\n\t\t\tcp += (*cp == '0' || *cp == '1');\n\t\t\tcontinue;\n\t\tcase 'T':\n\t\t\tset_max_threads = true;\n\t\t\tnew_max_threads = _tcstol(cp, const_cast<LPTSTR*>(&cp), 10);\n\t\t\tif (new_max_threads > MAX_THREADS_LIMIT || new_max_threads < 1)\n\t\t\t\treturn FR_E_ARG(2);\n\t\t\tif (new_max_threads > g_MaxThreadsTotal) // Permit caller to specify values larger than #MaxThreads, within the absolute limit imposed above.\n\t\t\t\tnew_max_threads = g_MaxThreadsTotal;\n\t\t\tbreak;\n\t\tcase 'I':\n\t\t\tset_input_level = true;\n\t\t\tnew_input_level = _tcstol(cp, const_cast<LPTSTR*>(&cp), 10);\n\t\t\tif (!SendLevelIsValid(new_input_level))\n\t\t\t\treturn FR_E_ARG(2);\n\t\t\tbreak;\n\t\tcase ' ':\n\t\tcase '\\t':\n\t\t\tcontinue;\n\t\t}\n\t}\n\n\tUCHAR no_suppress;\n\tbool hook_is_mandatory;\n\tHotkey *hk = FindHotkeyByTrueNature(aHotkeyName, no_suppress, hook_is_mandatory); // NULL if not found.\n\tHotkeyVariant *variant = hk ? hk->FindVariant() : NULL;\n\tbool update_all_hotkeys = false; // This method avoids multiple calls to ManifestAllHotkeysHotstringsHooks() (which is high-overhead).\n\tbool variant_was_just_created = false;\n\n\tswitch (aHookAction)\n\t{\n\tcase HOTKEY_ID_ON:\n\tcase HOTKEY_ID_OFF:\n\tcase HOTKEY_ID_TOGGLE:\n\t\tif (!hk)\n\t\t\treturn FError(ERR_NONEXISTENT_HOTKEY, aHotkeyName, ErrorPrototype::Target);\n\t\tif (!(variant || hk->mHookAction)) // mHookAction (alt-tab) hotkeys don't need a variant that matches the current criteria.\n\t\t\t// To avoid ambiguity and also allow the script to use error handling to detect whether a variant\n\t\t\t// already exists, it seems best to strictly require a matching variant rather than falling back\n\t\t\t// onto some \"default variant\" such as the global variant (if any).\n\t\t\treturn FError(ERR_NONEXISTENT_VARIANT, aHotkeyName, ErrorPrototype::Target);\n\t\ton_off = aHookAction;\n\t\tbreak;\n\n\tdefault: // aHookAction is 0 or an AltTab action. COMMAND: Hotkey, Name, Callback|AltTabAction\n\t\tif (!hk) // No existing hotkey of this name, so create a new hotkey.\n\t\t{\n\t\t\tif (aHookAction) // Create hotkey: Hotkey Name, AltTabAction\n\t\t\t\thk = AddHotkey(NULL, aHookAction, aHotkeyName, no_suppress);\n\t\t\telse // Create hotkey: Hotkey Name, Callback [, Options]\n\t\t\t{\n\t\t\t\tif (!aCallback) // Caller is trying to set new aOptions for a nonexistent hotkey.\n\t\t\t\t\treturn FError(ERR_NONEXISTENT_HOTKEY, aHotkeyName, ErrorPrototype::Target);\n\t\t\t\thk = AddHotkey(aCallback, 0, aHotkeyName, no_suppress);\n\t\t\t}\n\t\t\tif (!hk)\n\t\t\t\treturn FAIL; // AddHotkey() already displayed the error.\n\t\t\tvariant = hk->mLastVariant; // Update for use with the options-parsing section further below.\n\t\t\tupdate_all_hotkeys = true;\n\t\t\tvariant_was_just_created = true;\n\t\t}\n\t\telse // Hotkey already exists (though possibly not the required variant). Update the hotkey if appropriate.\n\t\t{\n\t\t\tif (hk->mHookAction != aHookAction) // COMMAND: Change to/from alt-tab hotkey.\n\t\t\t{\n\t\t\t\t// LoadIncludedFile() contains logic and comments similar to this, so maintain them together.\n\t\t\t\t// If aHookAction isn't zero, the caller is converting this hotkey into a global alt-tab\n\t\t\t\t// hotkey (alt-tab hotkeys are never subject to #HotIf, as documented). Thus, variant can\n\t\t\t\t// be NULL because making a hotkey become alt-tab doesn't require the creation or existence\n\t\t\t\t// of a variant matching the current #HotIf criteria. However, continue on to process the\n\t\t\t\t// Options parameter in case it contains \"On\" or some other keyword applicable to alt-tab.\n\t\t\t\thk->mHookAction = aHookAction;\n\t\t\t\tif (!aHookAction)\n\t\t\t\t\t// Since this hotkey is going from alt-tab to non-alt-tab, make sure it's not disabled\n\t\t\t\t\t// because currently, mParentEnabled is only actually used by alt-tab hotkeys (though it\n\t\t\t\t\t// may have other uses in the future, which is why it's implemented and named the way it is).\n\t\t\t\t\thk->mParentEnabled = true;\n\t\t\t\telse // This hotkey is becoming alt-tab.\n\t\t\t\t{\n\t\t\t\t\t// Make the hook mandatory for this hotkey. Known limitation: For maintainability and code size,\n\t\t\t\t\t// this is never undone (even if the hotkey is changed back to non-alt-tab) because there are\n\t\t\t\t\t// many other reasons a hotkey's mKeybdHookMandatory could be true, so can't change it back to\n\t\t\t\t\t// false without checking all those other things.\n\t\t\t\t\tif (HK_TYPE_CAN_BECOME_KEYBD_HOOK(hk->mType))\n\t\t\t\t\t\thk->mKeybdHookMandatory = true; // Causes mType to be set to HK_KEYBD_HOOK by ManifestAllHotkeysHotstringsHooks().\n\t\t\t\t}\n\t\t\t\t// Even if it's still an alt-tab action (just a different one), hook's data structures still\n\t\t\t\t// need to be updated. Otherwise, this is a change from an alt-tab type to a non-alt-tab type,\n\t\t\t\t// or vice versa: Due to the complexity of registered vs. hook hotkeys, for now just start from\n\t\t\t\t// scratch so that there is high confidence that the hook and all registered hotkeys, including\n\t\t\t\t// their interdependencies, will be re-initialized correctly.\n\t\t\t\tupdate_all_hotkeys = true;\n\t\t\t}\n\t\t\t\n\t\t\t// If the above changed the action from an Alt-tab type to non-alt-tab, there may be a callback\n\t\t\t// to be applied to the existing variant (or created as a new variant).\n\t\t\tif (aCallback) // Update hotkey: Hotkey Name, Callback [, Options]\n\t\t\t{\n\t\t\t\t// If there's a matching variant, update its callback. Otherwise, create a new variant.\n\t\t\t\tif (variant) // There's an existing variant...\n\t\t\t\t{\n\t\t\t\t\tif (aCallback != variant->mCallback) // ...and its callback is being changed.\n\t\t\t\t\t\tvariant->mCallback = aCallback;\n\t\t\t\t}\n\t\t\t\telse // No existing variant matching current criteria, so create a new variant.\n\t\t\t\t{\n\t\t\t\t\tif ( !(variant = hk->AddVariant(aCallback, no_suppress)) ) // Out of memory.\n\t\t\t\t\t\treturn FR_E_OUTOFMEM;\n\t\t\t\t\tvariant_was_just_created = true;\n\t\t\t\t\tupdate_all_hotkeys = true;\n\t\t\t\t\t// It seems undesirable for #UseHook to be applied to a hotkey just because it's options\n\t\t\t\t\t// were updated with the Hotkey command; therefore, #UseHook is only applied for newly\n\t\t\t\t\t// created variants such as this one. For others, the $ prefix can be applied.\n\t\t\t\t\tif (g_ForceKeybdHook)\n\t\t\t\t\t\thook_is_mandatory = true;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t\t// NULL callback, so either it just became an alt-tab hotkey above, or it's \"Hotkey Name,, Options\".\n\t\t\t\tif (!variant) // Below relies on this check.\n\t\t\t\t\tbreak; // Let the error-catch below report it as an error.\n\n\t\t\t// v1.1.15: Allow the ~tilde prefix to be added/removed from an existing hotkey variant.\n\t\t\t// v1.1.19: Apply this change even if aCallback is omitted. This is redundant if\n\t\t\t// variant_was_just_created, but checking that condition seems counter-productive.\n\t\t\tvariant->mNoSuppress = no_suppress;\n\t\t\t// hk->mNoSuppress might be inaccurate if a no-suppress flag was just removed from this variant,\n\t\t\t// but that just means a slight reduction in efficiency if tilde is removed from all variants.\n\t\t\thk->mNoSuppress |= no_suppress; // Apply both AT_LEAST_ONE_VARIANT_HAS_TILDE and NO_SUPPRESS_PREFIX, if present.\n\t\t\tif (!(no_suppress & AT_LEAST_ONE_VARIANT_HAS_TILDE))\n\t\t\t\thk->mNoSuppress |= AT_LEAST_ONE_VARIANT_LACKS_TILDE;\n\t\t\t\t\n\t\t\t// v1.1.19: Allow the $UseHook prefix to be added to an existing hotkey.\n\t\t\tif (!hk->mKeybdHookMandatory && (hook_is_mandatory || no_suppress))\n\t\t\t{\n\t\t\t\t// Require the hook for all variants of this hotkey if any variant requires it.\n\t\t\t\t// This seems more intuitive than the old behaviour, which required $ or #UseHook\n\t\t\t\t// to be used on the *first* variant, even though it affected all variants.\n\t\t\t\tupdate_all_hotkeys = true; // Since it may be switching from reg to k-hook.\n\t\t\t\thk->mKeybdHookMandatory = true;\n\t\t\t}\n\t\t} // Hotkey already existed.\n\t\tbreak;\n\t} // switch(aHookAction)\n\n\t// Above has ensured that hk is not NULL.\n\n\t// The following check catches:\n\t// Hotkey, Name,, Options ; Where name exists as a hotkey, but the right variant doesn't yet exist.\n\t// If it catches anything else, that could be a bug, so this error message will help spot it.\n\tif (!(variant || hk->mHookAction)) // mHookAction (alt-tab) hotkeys don't need a variant that matches the current criteria.\n\t\treturn FError(ERR_NONEXISTENT_VARIANT, aHotkeyName, ErrorPrototype::Target);\n\t// Below relies on the fact that either variant or hk->mHookAction (or both) is now non-zero.\n\t// Specifically, when an existing hotkey was changed to become an alt-tab hotkey, above, there will sometimes\n\t// be a NULL variant (depending on whether there happens to be a variant in the hotkey that matches the current criteria).\n\n\t// If aOptions is blank, any new hotkey or variant created above will have used the current values of\n\t// g_MaxThreadsBuffer, etc. (but any pre-existing variant may have other settings).\n\tif (*aOptions && variant)\n\t{\n\t\tif (set_max_threads_buffer)\n\t\t\tvariant->mMaxThreadsBuffer = new_max_threads_buffer;\n\t\tif (set_priority)\n\t\t\tvariant->mPriority = new_priority;\n\t\tif (set_suspend_exempt)\n\t\t\tvariant->mSuspendExempt = new_suspend_exempt;\n\t\tif (set_max_threads)\n\t\t\tvariant->mMaxThreads = new_max_threads;\n\t\tif (set_input_level)\n\t\t{\n\t\t\tif (new_input_level && !hk->mKeybdHookMandatory)\n\t\t\t{\n\t\t\t\t// For simplicity, a hotkey requires the hook if any of its variants have a non-zero\n\t\t\t\t// input level, even if those variants are disabled. The same is done for the tilde\n\t\t\t\t// prefix above and in AddVariant(); see there for more comments.\n\t\t\t\thk->mKeybdHookMandatory = true;\n\t\t\t\tupdate_all_hotkeys = true;\n\t\t\t}\n\t\t\tvariant->mInputLevel = (SendLevelType)new_input_level;\n\t\t}\n\t}\n\t\n\tif (on_off == HOTKEY_ID_TOGGLE)\n\t\ton_off = (variant ? variant->mEnabled : hk->mParentEnabled) ? HOTKEY_ID_OFF : HOTKEY_ID_ON;\n\tif (on_off == HOTKEY_ID_ON)\n\t{\n\t\tif (variant ? hk->Enable(*variant) : hk->EnableParent())\n\t\t\tupdate_all_hotkeys = true; // Do it this way so that any previous \"true\" value isn't lost.\n\t}\n\telse if (on_off == HOTKEY_ID_OFF)\n\t{\n\t\tif (variant ? hk->Disable(*variant) : hk->DisableParent())\n\t\t\tupdate_all_hotkeys = true; // Do it this way so that any previous \"true\" value isn't lost.\n\t\tif (variant_was_just_created) // This variant (and possibly its parent hotkey) was just created above.\n\t\t\tupdate_all_hotkeys = false; // Override the \"true\" that was set (either right above *or* anywhere earlier) because this new hotkey/variant won't affect other hotkeys.\n\t}\n\n\tif (update_all_hotkeys)\n\t\tManifestAllHotkeysHotstringsHooks(); // See its comments for why it's done in so many of the above situations.\n\n\treturn OK;\n}\n\n\n\nHotkey *Hotkey::AddHotkey(IObject *aCallback, HookActionType aHookAction, LPCTSTR aName, UCHAR aNoSuppress)\n// aCallback can be NULL if the caller is creating a dynamic hotkey that has an aHookAction.\n// aName must not be NULL.\n// Returns the address of the new hotkey on success, or NULL otherwise.\n// The caller is responsible for calling ManifestAllHotkeysHotstringsHooks(), if appropriate.\n{\n\tif ( (shkMax <= sNextID && !HookAdjustMaxHotkeys(shk, shkMax, shkMax ? shkMax * 2 : INITIAL_MAX_HOTKEYS)) // Allocate or expand shk if needed.\n\t\t|| !(shk[sNextID] = new Hotkey(sNextID, aCallback, aHookAction, aName, aNoSuppress)) )\n\t{\n\t\tMemoryError();\n\t\treturn NULL;\n\t}\n\tif (!shk[sNextID]->mConstructedOK)\n\t{\n\t\tdelete shk[sNextID]; // SimpleHeap allows deletion of most recently added item.\n\t\treturn NULL; // The constructor already displayed the error.\n\t}\n\t++sNextID;\n\treturn shk[sNextID - 1]; // Indicate success by returning the new hotkey.\n}\n\n\n\nHotkey::Hotkey(HotkeyIDType aID, IObject *aCallback, HookActionType aHookAction, LPCTSTR aName\n\t, UCHAR aNoSuppress)\n\t: mID(HOTKEY_ID_INVALID) // Default until overridden.\n\t// Caller must ensure that either aName or aCallback isn't NULL.\n\t, mVK(0)\n\t, mSC(0)\n\t, mModifiers(0)\n\t, mModifiersLR(0)\n\t, mKeybdHookMandatory(false)\n\t, mAllowExtraModifiers(false)\n\t, mKeyUp(false)\n\t, mNoSuppress(0) // Default is to suppress both prefixes and suffixes.\n\t, mModifierVK(0)\n\t, mModifierSC(0)\n\t, mModifiersConsolidatedLR(0)\n\t, mType(HK_NORMAL) // Default unless overridden to become mouse, joystick, hook, etc.\n\t, mVK_WasSpecifiedByNumber(false)\n\t, mIsRegistered(false)\n\t, mParentEnabled(true)\n\t, mHookAction(aHookAction) // Alt-tab and possibly other uses.\n\t, mFirstVariant(NULL), mLastVariant(NULL) // Init linked list early for maintainability.\n\t, mConstructedOK(false)\n\n// It's better to receive the hotkey_id as a param, since only the caller has better knowledge and\n// verification of the fact that this hotkey's id is always set equal to it's index in the array\n// (for performance reasons).\n{\n\tif (sNextID > HOTKEY_ID_MAX)\n\t{\n\t\t// This will actually cause the script to terminate if this hotkey is a static (load-time)\n\t\t// hotkey. In the future, some other behavior is probably better:\n\t\tg_script.ScriptError(_T(\"Max hotkeys.\")); // Brief msg since so rare.\n\t\treturn;\n\t}\n\n\tif (!TextInterpret(aName, this)) // The called function already displayed the error.\n\t\treturn;\n\n\tif (mType == HK_JOYSTICK)\n\t{\n\t\tif (mModifiers || mModifierVK || mModifierSC)\n\t\t{\n\t\t\tValueError(ERR_INVALID_HOTKEY, aName, FAIL);\n\t\t\treturn;\n\t\t}\n\t}\n\telse // Perform modifier adjustment and other activities that don't apply to joysticks.\n\t{\n\t\t// Remove any modifiers that are obviously redundant from keys (even NORMAL/registered ones\n\t\t// due to cases where RegisterHotkey() fails and the key is then auto-enabled via the hook).\n\t\t// No attempt is currently made to correct a silly hotkey such as \"lwin & lwin\". In addition,\n\t\t// weird hotkeys such as <^Control and ^LControl are not currently validated and might yield\n\t\t// unpredictable results.\n\t\tbool is_neutral;\n\t\tmodLR_type modifiers_lr;\n\t\tif (modifiers_lr = KeyToModifiersLR(mVK, mSC, &is_neutral))\n\t\t{\n\t\t\t// This hotkey's action-key is itself a modifier, so ensure that it's not defined\n\t\t\t// to modify itself. Other sections might rely on us doing this:\n\t\t\tif (is_neutral)\n\t\t\t\t// Since the action-key is a neutral modifier (not left or right specific),\n\t\t\t\t// turn off any neutral modifiers that may be on:\n\t\t\t\tmModifiers &= ~ConvertModifiersLR(modifiers_lr);\n\t\t\telse\n\t\t\t\tmModifiersLR &= ~modifiers_lr;\n\t\t}\n\n\t\tif ( (mHookAction == HOTKEY_ID_ALT_TAB || mHookAction == HOTKEY_ID_ALT_TAB_SHIFT)\n\t\t\t&& !mModifierVK && !mModifierSC )\n\t\t{\n\t\t\tif (mModifiers)\n\t\t\t{\n\t\t\t\t// Neutral modifier has been specified. Future enhancement: improve this\n\t\t\t\t// to try to guess which key, left or right, should be used based on the\n\t\t\t\t// location of the suffix key on the keyboard. Lexikos: Better not do that\n\t\t\t\t// since a wrong guess will leave the user wondering why it doesn't work.\n\t\t\t\tValueError(ERR_ALTTAB_MODLR, aName, FAIL);\n\t\t\t\treturn; // Key is invalid so don't give it an ID.\n\t\t\t}\n\t\t\tif (mModifiersLR)\n\t\t\t{\n\t\t\t\t// If mModifiersLR contains only a single modifier key, that is valid\n\t\t\t\t// so we convert it here to its corresponding mModifierVK for use by\n\t\t\t\t// the hook.\n\t\t\t\tswitch (mModifiersLR)\n\t\t\t\t{\n\t\t\t\tcase MOD_LCONTROL: mModifierVK = VK_LCONTROL; break;\n\t\t\t\tcase MOD_RCONTROL: mModifierVK = VK_RCONTROL; break;\n\t\t\t\tcase MOD_LSHIFT: mModifierVK = VK_LSHIFT; break;\n\t\t\t\tcase MOD_RSHIFT: mModifierVK = VK_RSHIFT; break;\n\t\t\t\tcase MOD_LALT: mModifierVK = VK_LMENU; break;\n\t\t\t\tcase MOD_RALT: mModifierVK = VK_RMENU; break;\n\t\t\t\tcase MOD_LWIN: mModifierVK = VK_LWIN; break;\n\t\t\t\tcase MOD_RWIN: mModifierVK = VK_RWIN; break;\n\t\t\t\tdefault:\n\t\t\t\t\tValueError(ERR_ALTTAB_ONEMOD, aName, FAIL);\n\t\t\t\t\treturn; // Key is invalid so don't give it an ID.\n\t\t\t\t}\n\t\t\t\t// Since above didn't return:\n\t\t\t\tmModifiersLR = 0; // Since ModifierVK/SC is now its substitute.\n\t\t\t}\n\t\t\t// Update: This is no longer needed because the hook attempts to compensate.\n\t\t\t// However, leaving it enabled may improve performance and reliability.\n\t\t\t// Update#2: No, it needs to be disabled, otherwise alt-tab won't work right\n\t\t\t// in the rare case where an ALT key itself is defined as \"AltTabMenu\":\n\t\t\t//else\n\t\t\t\t// It has no ModifierVK/SC and no modifiers, so it's a hotkey that is defined\n\t\t\t\t// to fire only when the Alt-Tab menu is visible. Since the ALT key must be\n\t\t\t\t// down for that menu to be visible (on all OSes?), add the ALT key to this\n\t\t\t\t// keys modifiers so that it will be detected as a hotkey whenever the\n\t\t\t\t// Alt-Tab menu is visible:\n\t\t\t//\tmodifiers |= MOD_ALT;\n\t\t}\n\n\t\tif (HK_TYPE_CAN_BECOME_KEYBD_HOOK(mType)) // Added in v1.0.39 to make a hotkey such as \"LButton & LCtrl\" install the mouse hook.\n\t\t{\n\t\t\tswitch (mVK)\n\t\t\t{\n\t\t\tcase 0: // Scan codes having no available virtual key must always be handled by the hook.\n\t\t\t// In addition, to support preventing the toggleable keys from toggling, handle those\n\t\t\t// with the hook also.\n\t\t\tcase VK_NUMLOCK:\n\t\t\tcase VK_CAPITAL:\n\t\t\tcase VK_SCROLL:\n\t\t\t// When the AppsKey used as a suffix, always use the hook to handle it because registering\n\t\t\t// such keys with RegisterHotkey() will fail to suppress(hide) the key-up events from the system,\n\t\t\t// and the key-up for Apps key, at least in apps like Explorer, is a special event that results in\n\t\t\t// the context menu appearing (though most other apps seem to use the key-down event rather than\n\t\t\t// the key-up, so they would probably work okay). Note: Of possible future use is the fact that\n\t\t\t// if the Alt key is held down before pressing Appskey, it's native function does\n\t\t\t// not occur. This may be similar to the fact that LWIN and RWIN don't cause the\n\t\t\t// start menu to appear if a shift key is held down.\n\t\t\tcase VK_APPS:\n\t\t\t// Finally, the non-neutral (left-right) modifier keys (except LWin and RWin) must also\n\t\t\t// be done with the hook because even if RegisterHotkey() claims to succeed on them,\n\t\t\t// I'm 99% sure I tried it and the hotkeys don't actually work with that method:\n\t\t\tcase VK_LCONTROL:\n\t\t\tcase VK_RCONTROL:\n\t\t\tcase VK_LSHIFT:\n\t\t\tcase VK_RSHIFT:\n\t\t\tcase VK_LMENU:\n\t\t\tcase VK_RMENU:\n\t\t\t\tmKeybdHookMandatory = true;\n\t\t\t\tbreak;\n\n\t\t\t// To prevent the Start Menu from appearing for a naked LWIN or RWIN, must\n\t\t\t// handle this key with the hook (the presence of a normal modifier makes\n\t\t\t// this unnecessary, at least under WinXP, because the Start Menu is\n\t\t\t// never invoked when a modifier key is held down with lwin/rwin).\n\t\t\tcase VK_LWIN:\n\t\t\tcase VK_RWIN:\n\t\t\t// If this hotkey is an unmodified modifier (e.g. Control::) and there\n\t\t\t// are any other hotkeys that rely specifically on this modifier,\n\t\t\t// have the hook handle this hotkey so that it will only fire on key-up\n\t\t\t// rather than key-down. Note: cases where this key's modifiersLR or\n\t\t\t// ModifierVK/SC are non-zero -- as well as hotkeys that use sc vs. vk\n\t\t\t// -- have already been set to use the keybd hook, so don't need to be\n\t\t\t// handled here. UPDATE: All the following cases have been already set\n\t\t\t// to be HK_KEYBD_HOOK:\n\t\t\t// - left/right ctrl/alt/shift (since RegisterHotkey() doesn't support them).\n\t\t\t// - Any key with a ModifierVK/SC\n\t\t\t// - The naked lwin or rwin key (due to the check above)\n\t\t\t// Therefore, the only case left to be detected by this next line is the\n\t\t\t// one in which the user configures the naked neutral key VK_SHIFT,\n\t\t\t// VK_MENU, or VK_CONTROL. As a safety precaution, always handle those\n\t\t\t// neutral keys with the hook so that their action will only fire\n\t\t\t// when the key is released (thus allowing each key to be used for its\n\t\t\t// normal modifying function):\n\t\t\tcase VK_CONTROL:\n\t\t\tcase VK_MENU:\n\t\t\tcase VK_SHIFT:\n\t\t\t\tif (!mModifiers && !mModifiersLR) // Modifier key as suffix and has no modifiers (or only a ModifierVK/SC).\n\t\t\t\t\tmKeybdHookMandatory = true;\n\t\t\t\t//else keys modified by CTRL/SHIFT/ALT/WIN can always be registered normally because these\n\t\t\t\t// modifiers are never used (are overridden) when that key is used as a ModifierVK\n\t\t\t\t// for another key. Example: if key1 is a ModifierVK for another key, ^key1\n\t\t\t\t// (or any other modified versions of key1) can be registered as a hotkey because\n\t\t\t\t// that doesn't affect the hook's ability to use key1 as a prefix:\n\t\t\t\tbreak;\n\t\t\t}\n\t\t} // if HK_TYPE_CAN_BECOME_KEYBD_HOOK(mType)\n\n\t\tif (HK_TYPE_CAN_BECOME_KEYBD_HOOK(mType))\n\t\t\tif ( (mModifiersLR || aHookAction || mKeyUp || mModifierVK || mModifierSC) // mSC is handled higher above.\n\t\t\t\t|| (g_ForceKeybdHook || mAllowExtraModifiers // mNoSuppress must be checked later because it can be changed by any variants added after *this* one.\n\t\t\t\t\t|| (mVK && !mVK_WasSpecifiedByNumber && vk_to_sc(mVK, true))) ) // Its mVK corresponds to two scan codes (such as \"ENTER\").\n\t\t\t\tmKeybdHookMandatory = true;\n\t\t\t// v1.0.38.02: The check of mVK_WasSpecifiedByNumber above was added so that an explicit VK hotkey such\n\t\t\t// as \"VK24::\" (which is VK_HOME) can be handled via RegisterHotkey() vs. the hook. Someone asked for\n\t\t\t// this ability, but even if it weren't for that it seems more correct to recognize an explicitly-specified\n\t\t\t// VK as a \"neutral VK\" (i.e. one that fires for both scan codes if the VK has two scan codes). The user\n\t\t\t// can always specify \"SCnnn::\" as a hotkey to avoid this fire-on-both-scan-codes behavior.\n\n\t\t// Currently, these take precedence over each other in the following order, so don't\n\t\t// just bitwise-or them together in case there's any ineffectual stuff stored in\n\t\t// the fields that have no effect (e.g. modifiers have no effect if there's a mModifierVK):\n\t\tif (mModifierVK)\n\t\t\tmModifiersConsolidatedLR = KeyToModifiersLR(mModifierVK);\n\t\telse if (mModifierSC)\n\t\t\tmModifiersConsolidatedLR = KeyToModifiersLR(0, mModifierSC);\n\t\telse\n\t\t{\n\t\t\tmModifiersConsolidatedLR = mModifiersLR;\n\t\t\tif (mModifiers)\n\t\t\t\tmModifiersConsolidatedLR |= ConvertModifiers(mModifiers);\n\t\t}\n\t} // if (mType != HK_JOYSTICK)\n\n\t// If mKeybdHookMandatory==true, ManifestAllHotkeysHotstringsHooks() will set mType to HK_KEYBD_HOOK for us.\n\n\t// To avoid memory leak, this is done only when it is certain the hotkey will be created:\n\tif ( !(mName = SimpleHeap::Malloc(aName))\n\t\t|| !(AddVariant(aCallback, aNoSuppress)) ) // Too rare to worry about freeing the other if only one fails.\n\t{\n\t\tMemoryError();\n\t\treturn;\n\t}\n\t// Above has ensured that both mFirstVariant and mLastVariant are non-NULL, so callers can rely on that.\n\n\t// Always assign the ID last, right before a successful return, so that the caller is notified\n\t// that the constructor succeeded:\n\tmConstructedOK = true;\n\tmID = aID;\n\t// Don't do this because the caller still needs the old/unincremented value:\n\t//++sHotkeyCount; // Hmm, seems best to do this here, but revisit this sometime.\n}\n\n\n\nHotkeyVariant *Hotkey::FindVariant()\n// Returns the address of the variant in this hotkey whose criterion matches the current #HotIf criterion.\n// If no match, it returns NULL.\n{\n\tfor (HotkeyVariant *vp = mFirstVariant; vp; vp = vp->mNextVariant)\n\t\tif (vp->mHotCriterion == g->HotCriterion)\n\t\t\treturn vp;\n\treturn NULL;\n}\n\n\n\nHotkeyVariant *Hotkey::AddVariant(IObject *aCallback, UCHAR aNoSuppress)\n// Returns NULL upon out-of-memory; otherwise, the address of the new variant.\n// The caller is responsible for calling ManifestAllHotkeysHotstringsHooks(), if appropriate.\n{\n\tHotkeyVariant *vp = SimpleHeap::Alloc<HotkeyVariant>();\n\tZeroMemory(vp, sizeof(HotkeyVariant));\n\t// The following members are left at 0/NULL by the above:\n\t// mNextVariant\n\t// mExistingThreads\n\t// mRunAgainAfterFinished\n\t// mRunAgainTime\n\t// mPriority (default priority is always 0)\n\t// mOriginalCallback\n\tHotkeyVariant &v = *vp;\n\tv.mCallback = aCallback;\n\tv.mMaxThreads = g_MaxThreadsPerHotkey; // The values of these can vary during load-time.\n\tv.mMaxThreadsBuffer = g_MaxThreadsBuffer; //\n\tv.mInputLevel = g_InputLevel;\n\tv.mHotCriterion = g->HotCriterion; // If this hotkey is an alt-tab one (mHookAction), this is stored but ignored until/unless the Hotkey command converts it into a non-alt-tab hotkey.\n\tv.mEnabled = true;\n\tv.mSuspendExempt = g_SuspendExempt;\n\tif (v.mInputLevel > 0)\n\t{\n\t\t// A non-zero InputLevel only works when using the hook\n\t\tmKeybdHookMandatory = true;\n\t}\n\tv.mNoSuppress = aNoSuppress;\n\tmNoSuppress |= aNoSuppress; // Apply both AT_LEAST_ONE_VARIANT_HAS_TILDE and NO_SUPPRESS_PREFIX, if present.\n\tif (aNoSuppress & AT_LEAST_ONE_VARIANT_HAS_TILDE)\n\t{\n\t\t// For simplicity, make the hook mandatory for any hotkey that has at least one non-suppressed variant.\n\t\t// Otherwise, ManifestAllHotkeysHotstringsHooks() would have to do a loop to check if any\n\t\t// non-suppressed variants are actually enabled & non-suspended to decide if the hook is actually needed\n\t\t// for a hotkey that has a global variant. Due to rarity and code size, it doesn't seem worth it.\n\t\tmKeybdHookMandatory = true;\n\t}\n\telse\n\t\tmNoSuppress |= AT_LEAST_ONE_VARIANT_LACKS_TILDE;\n\n\t// Update the linked list:\n\tif (!mFirstVariant)\n\t{\n\t\tvp->mIndex = 1; // Start at 1 since 0 means \"undetermined variant\".\n\t\tmFirstVariant = mLastVariant = vp;\n\t}\n\telse\n\t{\n\t\tvp->mIndex = mLastVariant->mIndex + 1;\n\t\tmLastVariant->mNextVariant = vp;\n\t\t// This must be done after the above:\n\t\tmLastVariant = vp;\n\t}\n\n\treturn vp; // Indicate success by returning the new object.\n}\n\n\n\nResultType Hotkey::TextInterpret(LPCTSTR aName, Hotkey *aThisHotkey, bool aSyntaxCheckOnly)\n// Returns OK or FAIL. This function is static and aThisHotkey is passed in as a parameter\n// so that aThisHotkey can be NULL. NULL signals that aName should be checked as a valid\n// hotkey only rather than populating the members of the new hotkey aThisHotkey. This function\n// and those it calls should avoid showing any error dialogs in validation mode. Instead,\n// it should simply return OK if aName is a valid hotkey and FAIL otherwise.\n{\n\t// Make a copy that can be modified:\n\tTCHAR hotkey_name[256];\n\ttcslcpy(hotkey_name, aName, _countof(hotkey_name));\n\tLPTSTR term1 = hotkey_name;\n\tLPTSTR term2 = _tcsstr(term1, COMPOSITE_DELIMITER);\n\tif (!term2)\n\t\treturn TextToKey(TextToModifiers(term1, aThisHotkey), false, aThisHotkey, aSyntaxCheckOnly);\n\tif (*term1 == '~')\n\t\t++term1; // Some other stage handles this modifier, so just ignore it here.\n LPTSTR end_of_term1 = omit_trailing_whitespace(term1, term2) + 1;\n\t// Temporarily terminate the string so that the 2nd term is hidden:\n\tTCHAR ctemp = *end_of_term1;\n\t*end_of_term1 = '\\0';\n\tResultType result = TextToKey(term1, true, aThisHotkey, aSyntaxCheckOnly);\n\t*end_of_term1 = ctemp; // Undo the termination.\n\tif (result == FAIL || result == CONDITION_FALSE)\n\t\treturn result;\n\tterm2 += COMPOSITE_DELIMITER_LENGTH;\n\tterm2 = omit_leading_whitespace(term2);\n\t// Even though modifiers on keys already modified by a mModifierVK are not supported, call\n\t// TextToModifiers() anyway to use its output (for consistency). The modifiers it sets\n\t// are currently ignored because the mModifierVK takes precedence.\n\t// UPDATE: Treat any modifier other than '~' as an error, since otherwise users expect\n\t// hotkeys like \"' & +e::Send È\" to work.\n\t//term2 = TextToModifiers(term2, aThisHotkey);\n\tif (*term2 == '~')\n\t\t++term2; // Some other stage handles this modifier, so just ignore it here.\n\tResultType result2 = TextToKey(term2, false, aThisHotkey, aSyntaxCheckOnly);\n\treturn result2 != OK ? result2 : result;\n}\n\n\n\nLPCTSTR Hotkey::TextToModifiers(LPCTSTR aText, Hotkey *aThisHotkey, HotkeyProperties *aProperties)\n// This function and those it calls should avoid showing any error dialogs when caller passes NULL for aThisHotkey.\n// Takes input param <text> to support receiving only a subset of object.text.\n// Returns the location in <text> of the first non-modifier key.\n// Checks only the first char(s) for modifiers in case these characters appear elsewhere (e.g. +{+}).\n// But come to think of it, +{+} isn't valid because + itself is already shift-equals. So += would be\n// used instead, e.g. +==action. Similarly, all the others, except =, would be invalid as hotkeys also.\n// UPDATE: On some keyboard layouts, the + key and various others don't require the shift key to be\n// manifest. Thus, on these systems a hotkey such as ^+:: is now supported as meaning Ctrl-Plus.\n{\n\t// Init output parameter for caller if it gave one:\n\tif (aProperties)\n\t\tZeroMemory(aProperties, sizeof(HotkeyProperties));\n\n\tif (!*aText)\n\t\treturn aText; // Below relies on this having ensured that aText isn't blank.\n\n\t// Explicitly avoids initializing modifiers to 0 because the caller may have already included\n\t// some set some modifiers in there.\n\tLPCTSTR marker;\n\tbool key_left, key_right;\n\n\t// Simplifies and reduces code size below:\n\tmod_type temp_modifiers;\n\tmod_type &modifiers = aProperties ? aProperties->modifiers : (aThisHotkey ? aThisHotkey->mModifiers : temp_modifiers);\n\tmodLR_type temp_modifiersLR;\n\tmodLR_type &modifiersLR = aProperties ? aProperties->modifiersLR: (aThisHotkey ? aThisHotkey->mModifiersLR : temp_modifiersLR);\n\n\t// Improved for v1.0.37.03: The loop's condition is now marker[1] vs. marker[0] so that\n\t// the last character is never considered a modifier. This allows a modifier symbol\n\t// to double as the name of a suffix key. It also fixes issues on layouts where the\n\t// symbols +^#! do not require the shift key to be held down, such as the German layout.\n\t//\n\t// Improved for v1.0.40.01: The loop's condition now stops when it reaches a single space followed\n\t// by the word \"Up\" so that hotkeys like \"< up\" and \"+ up\" are supported by seeing their '<' or '+' as\n\t// a key name rather than a modifier symbol.\n\t// Fix for v1.1.27.05: Stop at any space, not just \" up\", so that \" & \" is also covered.\n\t// This fixes \"> & v\" to not interpret \">\" as a modifier. This also causes \"+ ::\" to be\n\t// seen as invalid, where previously TextToModifiers() saw it as Shift+Space but a later\n\t// stage trimmed the space and registered \"+::\". This is best since trailing spaces are\n\t// not allowed in any other hotkeys, and even \"+ ::\" (two spaces) was not allowed.\n\tfor (marker = aText, key_left = false, key_right = false; marker[1] && marker[1] != ' '; ++marker)\n\t{\n\t\tswitch (*marker)\n\t\t{\n\t\tcase '>':\n\t\t\tkey_right = true;\n\t\t\tbreak;\n\t\tcase '<':\n\t\t\tkey_left = true;\n\t\t\tbreak;\n\t\tcase '*':\n\t\t\tif (aThisHotkey)\n\t\t\t\taThisHotkey->mAllowExtraModifiers = true;\n\t\t\tif (aProperties)\n\t\t\t\taProperties->has_asterisk = true;\n\t\t\tbreak;\n\t\tcase '~':\n\t\t\tif (aProperties)\n\t\t\t\taProperties->suffix_has_tilde = true; // If this is the prefix's tilde rather than the suffix, it will be overridden later below.\n\t\t\tbreak;\n\t\tcase '$':\n\t\t\tif (aThisHotkey)\n\t\t\t\taThisHotkey->mKeybdHookMandatory = true; // This flag will be ignored if TextToKey() decides this is a JOYSTICK or MOUSE hotkey.\n\t\t\tif (aProperties)\n\t\t\t\taProperties->hook_is_mandatory = true;\n\t\t\tbreak;\n\t\tcase '!':\n\t\t\tif ((!key_right && !key_left))\n\t\t\t{\n\t\t\t\tmodifiers |= MOD_ALT;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// Both left and right may be specified, e.g. ><+a means both shift keys must be held down:\n\t\t\tif (key_left)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_LALT;\n\t\t\t\tkey_left = false;\n\t\t\t}\n\t\t\tif (key_right)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_RALT;\n\t\t\t\tkey_right = false;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase '^':\n\t\t\tif ((!key_right && !key_left))\n\t\t\t{\n\t\t\t\tmodifiers |= MOD_CONTROL;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (key_left)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_LCONTROL;\n\t\t\t\tkey_left = false;\n\t\t\t}\n\t\t\tif (key_right)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_RCONTROL;\n\t\t\t\tkey_right = false;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase '+':\n\t\t\tif ((!key_right && !key_left))\n\t\t\t{\n\t\t\t\tmodifiers |= MOD_SHIFT;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (key_left)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_LSHIFT;\n\t\t\t\tkey_left = false;\n\t\t\t}\n\t\t\tif (key_right)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_RSHIFT;\n\t\t\t\tkey_right = false;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase '#':\n\t\t\tif ((!key_right && !key_left))\n\t\t\t{\n\t\t\t\tmodifiers |= MOD_WIN;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (key_left)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_LWIN;\n\t\t\t\tkey_left = false;\n\t\t\t}\n\t\t\tif (key_right)\n\t\t\t{\n\t\t\t\tmodifiersLR |= MOD_RWIN;\n\t\t\t\tkey_right = false;\n\t\t\t}\n\t\t\tbreak;\n\t\tdefault:\n\t\t\tgoto break_loop; // Stop immediately whenever a non-modifying char is found.\n\t\t} // switch (*marker)\n\t} // for()\nbreak_loop:\n\n\t// Now *marker is the start of the key's name. In addition, one of the following is now true:\n\t// 1) marker[0] is a non-modifier symbol; that is, the loop stopped because it found the first non-modifier symbol.\n\t// 2) marker[1] is '\\0'; that is, the loop stopped because it reached the next-to-last char (the last char itself is never a modifier; e.g. ^+ is Ctrl+Plus on some keyboard layouts).\n\t// 3) marker[1] is the start of the string \" Up\", in which case marker[0] is considered the suffix key even if it happens to be a modifier symbol (see comments at for-loop's control stmt).\n\tif (aProperties)\n\t{\n\t\t// When caller passes non-NULL aProperties, it didn't omit the prefix portion of a composite hotkey\n\t\t// (e.g. the \"a & \" part of \"a & b\" is present). So parse these and all other types of hotkeys when in this mode.\n\t\tif (auto composite = _tcsstr(marker, COMPOSITE_DELIMITER))\n\t\t{\n\t\t\ttcslcpy(aProperties->prefix_text, marker, _countof(aProperties->prefix_text)); // Protect against overflow case script ultra-long (and thus invalid) key name.\n\t\t\tif (auto temp = _tcsstr(aProperties->prefix_text, COMPOSITE_DELIMITER)) // Check again in case it tried to overflow.\n\t\t\t\tomit_trailing_whitespace(aProperties->prefix_text, temp)[1] = '\\0'; // Truncate prefix_text so that the suffix text is omitted.\n\t\t\tcomposite = omit_leading_whitespace(composite + COMPOSITE_DELIMITER_LENGTH);\n\t\t\taProperties->prefix_has_tilde = aProperties->suffix_has_tilde;\n\t\t\tif (aProperties->suffix_has_tilde = (*composite == '~')) // Override any value of no_suppress set higher above.\n\t\t\t\t++composite; // For simplicity, no skipping of leading whitespace between tilde and the suffix key name.\n\t\t\ttcslcpy(aProperties->suffix_text, composite, _countof(aProperties->suffix_text)); // Protect against overflow case script ultra-long (and thus invalid) key name.\n\t\t}\n\t\telse // A normal (non-composite) hotkey, so no_suppress was already set properly (higher above).\n\t\t\ttcslcpy(aProperties->suffix_text, omit_leading_whitespace(marker), _countof(aProperties->suffix_text)); // Protect against overflow case script ultra-long (and thus invalid) key name.\n\t\tif (auto temp = tcscasestr(aProperties->suffix_text, _T(\" Up\"))) // Should be reliable detection method because leading spaces have been omitted and it's unlikely a legitimate key name will ever contain a space followed by \"Up\".\n\t\t{\n\t\t\tif (!temp[3]) // Not something like \"key up up\", which can happen as a result of \"a up::b\".\n\t\t\t{\n\t\t\t\tomit_trailing_whitespace(aProperties->suffix_text, temp)[1] = '\\0'; // Omit \" Up\" from suffix_text since caller wants that.\n\t\t\t\taProperties->is_key_up = true; // Override the default set earlier.\n\t\t\t}\n\t\t}\n\t}\n\treturn marker;\n}\n\n\n\nResultType Hotkey::TextToKey(LPCTSTR aText, bool aIsModifier, Hotkey *aThisHotkey, bool aSyntaxCheckOnly)\n// This function and those it calls should avoid showing any error dialogs when caller passes NULL for\n// aThisHotkey (however, there is at least one exception explained in comments below where it occurs).\n// Caller must ensure that aText is a modifiable string.\n// Takes input param aText to support receiving only a subset of mName.\n// In private members, sets the values of vk/sc or ModifierVK/ModifierSC depending on aIsModifier.\n// It may also merge new modifiers into the existing value of modifiers, so the caller\n// should never reset modifiers after calling this.\n// Returns OK or FAIL.\n{\n\tvk_type temp_vk; // No need to initialize this one.\n\tsc_type temp_sc = 0;\n\tmodLR_type modifiersLR = 0;\n\tbool is_mouse = false;\n\tint joystick_id;\n\n\tTCHAR buf[32]; // Large enough that truncation wouldn't yield a valid key name.\n\n\t// Previous steps should make it unnecessary to call omit_leading_whitespace(aText).\n\tauto keyname_end = find_identifier_end(aText);\n\tif (keyname_end == aText && *aText) // Any single character except '\\0' can be a key name.\n\t\t++keyname_end;\n\n\tif (!aIsModifier && IS_SPACE_OR_TAB(*keyname_end) && !_tcsicmp(omit_leading_whitespace(keyname_end), _T(\"Up\")))\n\t{\n\t\tif (aSyntaxCheckOnly)\n\t\t\treturn OK; // It's a word or single character followed by \" up\" -- looks valid.\n\t\t// This is a key-up hotkey, such as \"Ctrl Up::\".\n\t\tif (aThisHotkey)\n\t\t\taThisHotkey->mKeyUp = true;\n\t\ttcslcpy(buf, aText, _countof(buf)); // Make a null-terminated copy to simplify various checks below.\n\t\tif (keyname_end - aText < _countof(buf))\n\t\t\tbuf[keyname_end - aText] = '\\0'; // Terminate at the first space so that the word \"up\" is removed from further consideration.\n\t\taText = buf;\n\t}\n\telse\n\t{\n\t\t// If there's something after the first word/character, it's not a hotkey.\n\t\t// Only for *keyname_end != '\\0', no error should be reported if aThisHotkey == NULL\n\t\t// since the caller will attempt to parse the line as something else first, such as\n\t\t// x := '::'\n\t\tif (*keyname_end)\n\t\t\treturn aThisHotkey ? ValueError(ERR_INVALID_HOTKEY, aText, FAIL) : CONDITION_FALSE;\n\t\tif (aSyntaxCheckOnly)\n\t\t\treturn OK;\n\t}\n\n\tHotkeyTypeType hotkey_type_temp;\n\tHotkeyTypeType &hotkey_type = aThisHotkey ? aThisHotkey->mType : hotkey_type_temp; // Simplifies and reduces code size below.\n\n\tif (temp_vk = TextToVK(aText, &modifiersLR, true)) // Assign.\n\t{\n\t\tif (aIsModifier)\n\t\t{\n\t\t\tif (IS_WHEEL_VK(temp_vk))\n\t\t\t\treturn ValueError(ERR_UNSUPPORTED_PREFIX, aText, FAIL);\n\t\t}\n\t\telse\n\t\t\t// This is done here rather than at some later stage because we have access to the raw\n\t\t\t// name of the suffix key (with any leading modifiers such as ^ omitted from the beginning):\n\t\t\tif (aThisHotkey)\n\t\t\t\taThisHotkey->mVK_WasSpecifiedByNumber = !_tcsnicmp(aText, _T(\"VK\"), 2);\n\t\tis_mouse = IsMouseVK(temp_vk);\n\t\tif (modifiersLR & (MOD_LSHIFT | MOD_RSHIFT))\n\t\t\tif (temp_vk >= 'A' && temp_vk <= 'Z') // VK of an alpha char is the same as the ASCII code of its uppercase version.\n\t\t\t\tmodifiersLR &= ~(MOD_LSHIFT | MOD_RSHIFT);\n\t\t\t\t// Above: Making alpha chars case insensitive seems much more friendly. In other words,\n\t\t\t\t// if the user defines ^Z as a hotkey, it will really be ^z, not ^+z. By removing SHIFT\n\t\t\t\t// from the modifiers here, we're only removing it from our modifiers, not the global\n\t\t\t\t// modifiers that have already been set elsewhere for this key (e.g. +Z will still be +z).\n\t}\n\telse // No virtual key was found. Is there a scan code?\n\t\tif ( !(temp_sc = TextToSC(aText)) )\n\t\t\tif ( !(temp_sc = (sc_type)ConvertJoy(aText, &joystick_id, true)) ) // Is there a joystick control/button?\n\t\t\t{\n\t\t\t\tif (!aText[1] && !g_script.mIsReadyToExecute)\n\t\t\t\t{\n\t\t\t\t\t// At load time, single-character key names are always considered valid but show a\n\t\t\t\t\t// warning if they can't be registered as hotkeys on the current keyboard layout.\n\t\t\t\t\tif (!aThisHotkey) // First stage: caller wants to differentiate this case from others.\n\t\t\t\t\t\treturn CONDITION_TRUE; // It's valid, but won't be active.\n\t\t\t\t\treturn FAIL; // Second stage: return FAIL to avoid creating an invalid hotkey.\n\t\t\t\t}\n\t\t\t\t// It's more appropriate to say \"key name\" than \"hotkey\" in this message because it's only\n\t\t\t\t// showing the one bad key name when it's a composite hotkey such as \"Capslock & y\".\n\t\t\t\treturn ValueError(ERR_INVALID_KEYNAME, aText, FAIL);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// Block joystick buttons as prefix keys at this stage in case hotkey_type would be overridden\n\t\t\t\t// by the suffix key. For example, the hotkey `Joy1 & LButton::` would reinterpret Joy1 as sc0C.\n\t\t\t\tif (aIsModifier)\n\t\t\t\t\treturn ValueError(ERR_UNSUPPORTED_PREFIX, aText, FAIL);\n\n\t\t\t\t++sJoyHotkeyCount;\n\t\t\t\thotkey_type = HK_JOYSTICK;\n\t\t\t\ttemp_vk = (vk_type)joystick_id; // 0 is the 1st joystick, 1 the 2nd, etc.\n\t\t\t\tsJoystickHasHotkeys[joystick_id] = true;\n\t\t\t}\n\n\n/*\nIf ever do this, be sure to avoid doing it for keys that must be tracked by scan code (e.g. those in the\nscan code array).\n\tif (!temp_vk && !is_mouse) // sc must be non-zero or else it would have already returned above.\n\t\tif (temp_vk = sc_to_vk(temp_sc))\n\t\t{\n\t\t\tsnprintf(error_text, sizeof(error_text), \"DEBUG: \\\"%s\\\" (scan code %X) was successfully mapped to virtual key %X\", text, temp_sc, temp_vk);\n\t\t\tMsgBox(error_text);\n\t\t\ttemp_sc = 0; // Maybe set this just for safety, even though a non-zero vk should always take precedence over it.\n\t\t}\n*/\n\tif (is_mouse)\n\t\thotkey_type = HK_MOUSE_HOOK;\n\n\tif (aIsModifier)\n\t{\n\t\tif (aThisHotkey)\n\t\t{\n\t\t\taThisHotkey->mModifierVK = temp_vk;\n\t\t\taThisHotkey->mModifierSC = temp_sc;\n\t\t}\n\t}\n\telse\n\t{\n\t\tif (aThisHotkey)\n\t\t{\n\t\t\taThisHotkey->mVK = temp_vk;\n aThisHotkey->mSC = temp_sc;\n\t\t\t// Turn on any additional modifiers. e.g. SHIFT to realize '#'.\n\t\t\t// Fix for v1.0.37.03: To avoid using the keyboard hook for something like \"+::\", which in\n\t\t\t// turn would allow the hotkey fire only for LShift+Equals rather than RShift+Equals, convert\n\t\t\t// modifiers from left-right to neutral. But exclude right-side modifiers (except RWin) so that\n\t\t\t// things like AltGr are more precisely handled (the implications of this policy could use\n\t\t\t// further review). Currently, right-Alt (via AltGr) is the only possible right-side key.\n\t\t\taThisHotkey->mModifiers |= ConvertModifiersLR(modifiersLR & (MOD_RWIN|MOD_LWIN|MOD_LCONTROL|MOD_LALT|MOD_LSHIFT));\n\t\t\taThisHotkey->mModifiersLR |= (modifiersLR & (MOD_RSHIFT|MOD_RALT|MOD_RCONTROL)); // Not MOD_RWIN since it belongs above.\n\t\t}\n\t}\n\treturn OK;\n}\n\n\n\nResultType Hotkey::Register()\n// Returns OK or FAIL. Caller is responsible for having checked whether the hotkey is suspended or disabled.\n{\n\tif (mIsRegistered)\n\t\treturn OK; // It's normal for a disabled hotkey to return OK.\n\n\tif (mType != HK_NORMAL) // Caller normally checks this for performance, but it's checked again for maintainability.\n\t\treturn FAIL; // Don't attempt to register joystick or hook hotkeys, since their VK/modifiers aren't intended for that.\n\n\t// Indicate that the key modifies itself because RegisterHotkey() requires that +SHIFT,\n\t// for example, be used to register the naked SHIFT key. So what we do here saves the\n\t// user from having to specify +SHIFT in the script:\n\tmod_type modifiers_to_register = mModifiers;\n\tswitch (mVK)\n\t{\n\tcase VK_LWIN:\n\tcase VK_RWIN: modifiers_to_register |= MOD_WIN; break;\n\tcase VK_CONTROL: modifiers_to_register |= MOD_CONTROL; break;\n\tcase VK_SHIFT: modifiers_to_register |= MOD_SHIFT; break;\n\tcase VK_MENU: modifiers_to_register |= MOD_ALT; break;\n\t}\n\n\t// Must register them to our main window (i.e. don't use NULL to indicate our thread),\n\t// otherwise any modal dialogs, such as MessageBox(), that call DispatchMessage()\n\t// internally wouldn't be able to find anyone to send hotkey messages to, so they\n\t// would probably be lost:\n\tif (mIsRegistered = RegisterHotKey(g_hWnd, mID, modifiers_to_register, mVK))\n\t\treturn OK;\n\treturn FAIL;\n\t// Above: On failure, reset the modifiers in case this function changed them. This is\n\t// done in case this hotkey will now be handled by the hook, which doesn't want any\n\t// extra modifiers that were added above.\n\t// UPDATE: In v1.0.42, the mModifiers value is never changed here because a hotkey that\n\t// gets registered here one time might fail to be registered some other time (perhaps due\n\t// to Suspend, followed by some other app taking ownership that hotkey, followed by\n\t// de-suspend, which would then have a hotkey with the wrong modifiers in it for the hook.\n}\n\n\n\nResultType Hotkey::Unregister()\n// Returns OK or FAIL.\n{\n\tif (!mIsRegistered)\n\t\treturn OK;\n\t// Don't report any errors in here, at least not when we were called in conjunction\n\t// with cleanup and exit. Such reporting might cause an infinite loop, leading to\n\t// a stack overflow if the reporting itself encounters an error and tries to exit,\n\t// which in turn would call us again:\n\tif (mIsRegistered = !UnregisterHotKey(g_hWnd, mID)) // I've see it fail in one rare case.\n\t\treturn FAIL;\n\treturn OK;\n}\n\n\n\nvoid Hotkey::InstallKeybdHook()\n// Caller must ensure that sWhichHookNeeded and sWhichHookAlways contain HOOK_MOUSE, if appropriate.\n// Generally, this is achieved by having ensured that ManifestAllHotkeysHotstringsHooks() was called at least\n// once since the last time any hotstrings or hotkeys were disabled/enabled/changed, but in any case at least\n// once since the program started.\n{\n\tsWhichHookNeeded |= HOOK_KEYBD;\n\tif (!g_KeybdHook)\n\t\tChangeHookState(shk, sHotkeyCount, sWhichHookNeeded, sWhichHookAlways);\n}\n\n\n\nvoid Hotkey::InstallMouseHook()\n// Same comment as for InstallKeybdHook() above.\n{\n\tsWhichHookNeeded |= HOOK_MOUSE;\n\tif (!g_MouseHook)\n\t\tChangeHookState(shk, sHotkeyCount, sWhichHookNeeded, sWhichHookAlways);\n}\n\n\n\nHotkey *Hotkey::FindHotkeyByTrueNature(LPCTSTR aName, UCHAR &aNoSuppress, bool &aHookIsMandatory)\n// Returns the address of the hotkey if found, NULL otherwise.\n// In v1.0.42, it tries harder to find a match so that the order of modifier symbols doesn't affect the true nature of a hotkey.\n// For example, ^!c should be the same as !^c, primarily because RegisterHotkey() and the hook would consider them the same.\n// Primary benefits to the above:\n// 1) Catches script bugs, such as unintended duplicates.\n// 2) Allows a script to use the Hotkey command more precisely and with greater functionality.\n// 3) Allows hotkey variants to work correctly even when the order of modifiers varies. For example, if ^!c is a hotkey that fires\n// only when window type 1 is active and !^c (reversed modifiers) is a hotkey that fires only when window type 2 is active,\n// one of them would never fire because the hook isn't capable or storing two hotkey IDs for the same combination of\n// modifiers+VK/SC.\n{\n\tHotkeyProperties prop_candidate, prop_existing;\n\tTextToModifiers(aName, NULL, &prop_candidate);\n\taNoSuppress = (prop_candidate.prefix_has_tilde ? NO_SUPPRESS_PREFIX : 0) // Set for caller.\n\t\t\t\t| (prop_candidate.suffix_has_tilde ? AT_LEAST_ONE_VARIANT_HAS_TILDE : 0);\n\taHookIsMandatory = prop_candidate.hook_is_mandatory; // Set for caller.\n\t// Both suffix_has_tilde and prefix_has_tilde are ignored during dupe-checking below.\n\t// See comments inside the loop for details.\n\n\tfor (int i = 0; i < sHotkeyCount; ++i)\n\t{\n\t\tTextToModifiers(shk[i]->mName, NULL, &prop_existing);\n\t\tif ( prop_existing.modifiers == prop_candidate.modifiers\n\t\t\t&& prop_existing.modifiersLR == prop_candidate.modifiersLR\n\t\t\t&& prop_existing.is_key_up == prop_candidate.is_key_up\n\t\t\t// Treat wildcard (*) as an entirely separate hotkey from one without a wildcard. This is because\n\t\t\t// the hook has special handling for wildcards that allow non-wildcard hotkeys that overlap them to\n\t\t\t// take precedence, sort of like \"clip children\". The logic that builds the eclipsing array would\n\t\t\t// need to be redesigned, which might not even be possible given the complexity of interactions\n\t\t\t// between variant-precedence and hotkey/wildcard-precedence.\n\t\t\t// By contrast, in v1.0.44 pass-through (~) is considered an attribute of each variant of a\n\t\t\t// particular hotkey, not something that makes an entirely new hotkey.\n\t\t\t// This was done because the old method of having them distinct appears to have only one advantage:\n\t\t\t// the ability to dynamically enable/disable ~x separately from x (since if both were in effect\n\t\t\t// simultaneously, one would override the other due to two different hotkey IDs competing for the same\n\t\t\t// ID slot within the VK/SC hook arrays). The advantages of allowing tilde to be a per-variant attribute\n\t\t\t// seem substantial, namely to have some variant/siblings pass-through while others do not.\n\t\t\t&& prop_existing.has_asterisk == prop_candidate.has_asterisk\n\t\t\t// v1.0.43.05: Use stricmp not lstrcmpi because an uppercase high ANSI letter isn't necessarily\n\t\t\t// produced by holding down the shift key and pressing the lowercase letter. In addition, it\n\t\t\t// preserves backward compatibility and may improve flexibility.\n\t\t\t&& !_tcsicmp(prop_existing.prefix_text, prop_candidate.prefix_text)\n\t\t\t&& !_tcsicmp(prop_existing.suffix_text, prop_candidate.suffix_text) )\n\t\t\treturn shk[i]; // Match found.\n\t}\n\n\treturn NULL; // No match found.\n}\n\n\n\nHotkey *Hotkey::FindHotkeyContainingModLR(modLR_type aModifiersLR) // , HotkeyIDType hotkey_id_to_omit)\n// Returns the address of the hotkey if found, NULL otherwise.\n// Find the first hotkey whose modifiersLR contains *any* of the modifiers shows in the parameter value.\n// Obsolete: The caller tells us the ID of the hotkey to omit from the search because that one\n// would always be found (since something like \"lcontrol=calc.exe\" in the script\n// would really be defines as \"<^control=calc.exe\".\n// Note: By intent, this function does not find hotkeys whose normal/neutral modifiers\n// contain <modifiersLR>.\n{\n\tif (!aModifiersLR)\n\t\treturn NULL;\n\tfor (int i = 0; i < sHotkeyCount; ++i)\n\t\t// Bitwise set-intersection: indicates if anything in common:\n\t\tif (shk[i]->mModifiersLR & aModifiersLR)\n\t\t//if (i != hotkey_id_to_omit && shk[i]->mModifiersLR & modifiersLR)\n\t\t\treturn shk[i];\n\treturn NULL; // No match found.\n}\n\n\n//Hotkey *Hotkey::FindHotkeyWithThisModifier(vk_type aVK, sc_type aSC)\n//// Returns the address of the hotkey if found, NULL otherwise.\n//// Answers the question: What is the first hotkey with mModifierVK or mModifierSC equal to those given?\n//// A non-zero vk param will take precedence over any non-zero value for sc.\n//{\n//\tif (!aVK & !aSC)\n//\t\treturn NULL;\n//\tfor (int i = 0; i < sHotkeyCount; ++i)\n//\t\tif ( (aVK && aVK == shk[i]->mModifierVK) || (aSC && aSC == shk[i]->mModifierSC) )\n//\t\t\treturn shk[i];\n//\treturn NULL; // No match found.\n//}\n//\n//\n//\n//Hotkey *Hotkey::FindHotkeyBySC(sc2_type aSC2, mod_type aModifiers, modLR_type aModifiersLR)\n//// Returns the address of the hotkey if found, NULL otherwise.\n//// Answers the question: What is the first hotkey with the given sc & modifiers *regardless* of\n//// any non-zero mModifierVK or mModifierSC it may have? The mModifierSC/vk is ignored because\n//// the caller wants to know whether this key would be blocked if its counterpart were registered.\n//// For example, the hook wouldn't see \"MEDIA_STOP & NumpadENTER\" at all if NumPadENTER was\n//// already registered via RegisterHotkey(), since RegisterHotkey() doesn't honor any modifiers\n//// other than the standard ones.\n//{\n//\tfor (int i = 0; i < sHotkeyCount; ++i)\n//\t\tif (!shk[i]->mVK && (shk[i]->mSC == aSC2.a || shk[i]->mSC == aSC2.b))\n//\t\t\tif (shk[i]->mModifiers == aModifiers && shk[i]->mModifiersLR == aModifiersLR) // Ensures an exact match.\n//\t\t\t\treturn shk[i];\n//\treturn NULL; // No match found.\n//}\n\n\n\nLPTSTR Hotkey::ListHotkeys(LPTSTR aBuf, int aBufSize)\n// Translates this script's list of variables into text equivalent, putting the result\n// into aBuf and returning the position in aBuf of its new string terminator.\n{\n\tLPTSTR aBuf_orig = aBuf;\n\t// Save vertical space by limiting newlines here:\n\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"Type\\tOff?\\tLevel\\tRunning\\tName\\r\\n\")\n\t\t\t\t\t\t\t _T(\"-------------------------------------------------------------------\\r\\n\"));\n\t// Start at the oldest and continue up through the newest:\n\tfor (int i = 0; i < sHotkeyCount; ++i)\n\t\taBuf = shk[i]->ToText(aBuf, BUF_SPACE_REMAINING, true);\n\treturn aBuf;\n}\n\n\n\nLPTSTR Hotkey::ToText(LPTSTR aBuf, int aBufSize, bool aAppendNewline)\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// Caller has ensured that aBuf isn't NULL.\n// Translates this var into its text equivalent, putting the result into aBuf and\n// returning the position in aBuf of its new string terminator.\n{\n\tLPTSTR aBuf_orig = aBuf;\n\n\tHotkeyVariant *vp;\n\tint existing_threads;\n\tfor (existing_threads = 0, vp = mFirstVariant; vp; vp = vp->mNextVariant)\n\t\texisting_threads += vp->mExistingThreads;\n\n\tTCHAR existing_threads_str[128];\n\tif (existing_threads)\n\t\t_itot(existing_threads, existing_threads_str, 10);\n\telse\n\t\t*existing_threads_str = '\\0'; // Make it blank to avoid clutter in the hotkey display.\n\n\tTCHAR htype[32];\n\tswitch (mType)\n\t{\n\tcase HK_NORMAL: _tcscpy(htype, _T(\"reg\")); break;\n\tcase HK_KEYBD_HOOK: _tcscpy(htype, _T(\"k-hook\")); break;\n\tcase HK_MOUSE_HOOK: _tcscpy(htype, _T(\"m-hook\")); break;\n\tcase HK_BOTH_HOOKS: _tcscpy(htype, _T(\"2-hooks\")); break;\n\tcase HK_JOYSTICK: _tcscpy(htype, _T(\"joypoll\")); break;\n\tdefault: *htype = '\\0'; // For maintainability; should never happen.\n\t}\n\n\tLPTSTR enabled_str;\n\tif (IsCompletelyDisabled()) // Takes into account alt-tab vs. non-alt-tab, etc.\n\t\tenabled_str = _T(\"OFF\");\n\telse if (mHookAction && mParentEnabled) // It's completely \"on\" in this case.\n\t\tenabled_str = _T(\"\");\n\telse // It's on or if all individual variants are on, otherwise it's partial.\n\t{\n\t\t// Set default: Empty string means \"ON\" because it reduces clutter in the displayed list.\n\t\tfor (enabled_str = _T(\"\"), vp = mFirstVariant; vp; vp = vp->mNextVariant)\n\t\t\tif (!vp->mEnabled)\n\t\t\t{\n\t\t\t\tenabled_str = _T(\"PART\");\n\t\t\t\tbreak;\n\t\t\t}\n\t}\n\n\tTCHAR level_str[7]; // Room for \"99-100\".\n\tint min_level = 100, max_level = -1;\n\tfor (vp = mFirstVariant; vp; vp = vp->mNextVariant)\n\t{\n\t\tif (min_level > vp->mInputLevel)\n\t\t\tmin_level = vp->mInputLevel;\n\t\tif (max_level < vp->mInputLevel)\n\t\t\tmax_level = vp->mInputLevel;\n\t}\n\tif (min_level != max_level)\n\t\t_stprintf(level_str, _T(\"%i-%i\"), min_level, max_level);\n\telse if (min_level)\n\t\tITOA(min_level, level_str);\n\telse // Show nothing for level 0.\n\t\t*level_str = '\\0';\n\n\taBuf += sntprintf(aBuf, BUF_SPACE_REMAINING, _T(\"%s%s\\t%s\\t%s\\t%s\\t%s\")\n\t\t, htype, (mType == HK_NORMAL && !mIsRegistered) ? _T(\"(no)\") : _T(\"\")\n\t\t, enabled_str\n\t\t, level_str\n\t\t, existing_threads_str\n\t\t, mName);\n\tif (aAppendNewline && BUF_SPACE_REMAINING >= 2)\n\t{\n\t\t*aBuf++ = '\\r';\n\t\t*aBuf++ = '\\n';\n\t\t*aBuf = '\\0';\n\t}\n\treturn aBuf;\n}\n\n\n///////////////\n// Hot Strings\n///////////////\n\n// Init static variables:\nHotstring **Hotstring::shs = NULL;\nHotstringIDType Hotstring::sHotstringCount = 0;\nHotstringIDType Hotstring::sHotstringCountMax = 0;\nUINT Hotstring::sEnabledCount = 0;\n\n\nvoid Hotstring::SuspendAll(bool aSuspend)\n{\n\tif (sHotstringCount < 1) // At least one part below relies on this check.\n\t\treturn;\n\n\tUINT u;\n\tif (aSuspend) // Suspend all those that aren't exempt.\n\t{\n\t\t// Recalculating sEnabledCount might perform better in the average case since most aren't exempt.\n\t\tfor (sEnabledCount = 0, u = 0; u < sHotstringCount; ++u)\n\t\t\tif (shs[u]->mSuspendExempt)\n\t\t\t{\n\t\t\t\tshs[u]->mSuspended &= ~HS_SUSPENDED;\n\t\t\t\tif (!shs[u]->mSuspended) // Not turned off.\n\t\t\t\t\t++sEnabledCount;\n\t\t\t}\n\t\t\telse\n\t\t\t\tshs[u]->mSuspended |= HS_SUSPENDED;\n\t}\n\telse // Unsuspend all.\n\t{\n\t\tUINT previous_count = sEnabledCount;\n\t\t// Recalculating sEnabledCount is probably best since we otherwise need to both remove HS_SUSPENDED\n\t\t// and determine if the final suspension status has changed (i.e. no other bits were set).\n\t\tfor (sEnabledCount = 0, u = 0; u < sHotstringCount; ++u)\n\t\t{\n\t\t\tshs[u]->mSuspended &= ~HS_SUSPENDED;\n\t\t\tif (!shs[u]->mSuspended) // Not turned off.\n\t\t\t\t++sEnabledCount;\n\t\t}\n\t\t// v1.0.44.08: Added the following section. Also, the HS buffer is reset, but only when hotstrings\n\t\t// are newly enabled after having been entirely disabled. This is because CollectInput() would not\n\t\t// have been called in a long time, making the contents of g_HSBuf obsolete, which in turn might\n\t\t// otherwise cause accidental firings based on old keystrokes coupled with new ones.\n\t\tif (previous_count == 0 && sEnabledCount > 0)\n\t\t{\n\t\t\t*g_HSBuf = '\\0';\n\t\t\tg_HSBufLength = 0;\n\t\t}\n\t}\n}\n\n\n\nResultType Hotstring::PerformInNewThreadMadeByCaller()\n// Returns OK or FAIL. Caller has already ensured that the backspacing (if specified by mDoBackspace)\n// has been done. Caller must have already created a new thread for us, and must close the thread when\n// we return.\n{\n\tif (mExistingThreads >= mMaxThreads)\n\t\treturn FAIL;\n\t// See Hotkey::Perform() for details about this. For hot strings -- which also use the\n\t// g_script.mThisHotkeyStartTime value to determine whether g_script.mThisHotkeyModifiersLR\n\t// is still timely/accurate -- it seems best to set to \"no modifiers\":\n\tg_script.mThisHotkeyModifiersLR = 0;\n\t++mExistingThreads; // This is the thread count for this particular hotstring only.\n\t\n\tResultType result;\n\tExprTokenType params = { mName };\n\tresult = mCallback->ExecuteInNewThread(g_script.mThisHotkeyName, ¶ms, 1);\n\t\n\t--mExistingThreads;\n\treturn result ? OK : FAIL;\t// Return OK on all non-failure results.\n}\n\n\n\nvoid Hotstring::DoReplace(LPARAM alParam)\n// alParam contains details about how the hotstring was triggered.\n{\n\tglobal_struct &g = *::g; // Reduces code size and may improve performance.\n\t// The below buffer allows room for the longest replacement text plus MAX_HOTSTRING_LENGTH for the\n\t// optional backspaces, +10 for the possible presence of {Raw} and a safety margin.\n\tTCHAR SendBuf[LINE_SIZE + MAX_HOTSTRING_LENGTH + 10];\n\t*SendBuf = '\\0';\n\tLPTSTR start_of_replacement = SendBuf; // Set default.\n\tint skip_chars = HIBYTE(HIWORD(alParam));\n\n\tif (mDoBackspace)\n\t{\n\t\tint backspace_count = mStringLength - skip_chars;\n#ifdef UNICODE\n\t\tfor (LPCTSTR cp = mString + skip_chars; *cp; ++cp)\n\t\t\tif (IS_SURROGATE_PAIR(cp[0], cp[1]))\n\t\t\t\t++cp, --backspace_count; // Treat this surrogate pair as a single character (which it is).\n#endif\n\t\t// Subtract 1 from backspaces because the final key pressed by the user to make a\n\t\t// match was already suppressed by the hook (it wasn't sent through to the active\n\t\t// window). So what we do is backspace over all the other keys prior to that one,\n\t\t// put in the replacement text (if applicable), then send the EndChar through\n\t\t// (if applicable) to complete the sequence.\n\t\tif (!mEndCharRequired)\n\t\t\t--backspace_count;\n\t\tfor (int i = 0; i < backspace_count; ++i)\n\t\t\t*start_of_replacement++ = '\\b'; // Use raw backspaces, not {BS n}, in case the send will be raw.\n\t\t*start_of_replacement = '\\0'; // Terminate the string created above.\n\t}\n\n\tif (mReplacement)\n\t{\n\t\t_tcscpy(start_of_replacement, mReplacement + skip_chars);\n\t\tCaseConformModes case_conform_mode = (CaseConformModes)LOBYTE(HIWORD(alParam));\n\t\tif (case_conform_mode == CASE_CONFORM_ALL_CAPS)\n\t\t\tCharUpper(start_of_replacement);\n\t\telse if (case_conform_mode == CASE_CONFORM_FIRST_CAP)\n\t\t\t*start_of_replacement = ltoupper(*start_of_replacement);\n\t\tif (!mOmitEndChar) // The ending character (if present) needs to be sent too.\n\t\t{\n\t\t\t// Send the final character in raw mode so that chars such as !{} are sent properly.\n\t\t\t// v1.0.43: Avoid two separate calls to SendKeys because:\n\t\t\t// 1) It defeats the uninterruptibility of the hotstring's replacement by allowing the user's\n\t\t\t// buffered keystrokes to take effect in between the two calls to SendKeys.\n\t\t\t// 2) Performance: Avoids having to install the playback hook twice, etc.\n\t\t\tTCHAR end_char;\n\t\t\tif (mEndCharRequired && (end_char = (TCHAR)LOWORD(alParam))) // Must now check mEndCharRequired because LOWORD has been overloaded with context-sensitive meanings.\n\t\t\t{\n\t\t\t\tLPTSTR end = start_of_replacement + _tcslen(start_of_replacement);\n\t\t\t\t// v1.0.43.02: Don't send \"{Raw}\" if already in raw mode!\n\t\t\t\t// v1.1.27: Avoid adding {Raw} if it gets switched on within the replacement text.\n\t\t\t\tif (mSendRaw || tcscasestr(start_of_replacement, _T(\"{Raw}\")) || tcscasestr(start_of_replacement, _T(\"{Text}\")))\n\t\t\t\t\t*end++ = end_char, *end = '\\0';\n\t\t\t\telse\n\t\t\t\t\t_stprintf(end, _T(\"%s%c\"), _T(\"{Raw}\"), end_char);\n\t\t\t}\n\t\t}\n\t}\n\n\tif (!*SendBuf) // No keys to send.\n\t\treturn;\n\n\t// For the following, mSendMode isn't checked because the backup/restore is needed to varying extents\n\t// by every mode.\n\tint old_delay = g.KeyDelay;\n\tint old_press_duration = g.PressDuration;\n\tint old_delay_play = g.KeyDelayPlay;\n\tint old_press_duration_play = g.PressDurationPlay;\n\tSendLevelType old_send_level = g.SendLevel;\n\n\tg.KeyDelay = mKeyDelay; // This is relatively safe since SendKeys() normally can't be interrupted by a new thread.\n\tg.PressDuration = -1; // Always -1, since Send command can be used in body of hotstring to have a custom press duration.\n\tg.KeyDelayPlay = -1;\n\tg.PressDurationPlay = mKeyDelay; // Seems likely to be more useful (such as in games) to apply mKeyDelay to press duration rather than above.\n\t// Setting the SendLevel to 0 rather than this->mInputLevel since auto-replace hotstrings are used for text replacement rather than\n\t// key remapping, which means the user almost always won't want the generated input to trigger other hotkeys or hotstrings.\n\t// Action hotstrings (not using auto-replace) do get their thread's SendLevel initialized to the hotstring's InputLevel.\n\tg.SendLevel = 0;\n\n\t// v1.0.43: The following section gives time for the hook to pass the final keystroke of the hotstring to the\n\t// system. This is necessary only for modes other than the original/SendEvent mode because that one takes\n\t// advantage of the serialized nature of the keyboard hook to ensure the user's final character always appears\n\t// on screen before the replacement text can appear.\n\t// By contrast, when the mode is SendPlay (and less frequently, SendInput), the system and/or hook needs\n\t// another timeslice to ensure that AllowKeyToGoToSystem() actually takes effect on screen (SuppressThisKey()\n\t// doesn't seem to have this problem).\n\tif (!(mDoBackspace || mOmitEndChar) && mSendMode != SM_EVENT) // The final character of the abbreviation (or its EndChar) was not suppressed by the hook.\n\t\tSleep(0);\n\n\tSendKeys(SendBuf, (SendRawModes)mSendRaw, mSendMode); // Send the backspaces and/or replacement.\n\n\t// Restore original values.\n\tg.KeyDelay = old_delay;\n\tg.PressDuration = old_press_duration;\n\tg.KeyDelayPlay = old_delay_play;\n\tg.PressDurationPlay = old_press_duration_play;\n\tg.SendLevel = old_send_level;\n}\n\n\n\nResultType Hotstring::AddHotstring(LPCTSTR aName, IObjectPtr aCallback, LPCTSTR aOptions, LPCTSTR aHotstring\n\t\t, LPCTSTR aReplacement, bool aHasContinuationSection, UCHAR aSuspend)\n// Returns OK or FAIL.\n// Caller has ensured that aHotstringOptions is blank if there are no options. Otherwise, aHotstringOptions\n// should end in a colon, which marks the end of the options list. aHotstring is the hotstring itself\n// (e.g. \"ahk\"), which does not have to be unique, unlike aName, which was made unique by also including\n// any options (e.g. ::ahk:: has a different aName than :c:ahk::).\n// Caller has also ensured that aHotstring is not blank.\n{\n\t// The length is limited for performance reasons, notably so that the hook does not have to move\n\t// memory around in the buffer it uses to watch for hotstrings:\n\tif (_tcslen(aHotstring) > MAX_HOTSTRING_LENGTH)\n\t\treturn ValueError(_T(\"Hotstring max abbreviation length is \") MAX_HOTSTRING_LENGTH_STR _T(\".\"), aHotstring, FAIL);\n\n\tif (!shs)\n\t{\n\t\tif ( !(shs = (Hotstring **)malloc(HOTSTRING_BLOCK_SIZE * sizeof(Hotstring *))) )\n\t\t\treturn MemoryError(); // Short msg. since so rare.\n\t\tsHotstringCountMax = HOTSTRING_BLOCK_SIZE;\n\t}\n\telse if (sHotstringCount >= sHotstringCountMax) // Realloc to preserve contents and keep contiguous array.\n\t{\n\t\t// Expand the array by one block. Use a temp var. because realloc() returns NULL on failure\n\t\t// but leaves original block allocated.\n\t\tvoid *realloc_temp = realloc(shs, (sHotstringCountMax + HOTSTRING_BLOCK_SIZE) * sizeof(Hotstring *));\n\t\tif (!realloc_temp)\n\t\t\treturn MemoryError(); // Short msg. since so rare.\n\t\tshs = (Hotstring **)realloc_temp;\n\t\tsHotstringCountMax += HOTSTRING_BLOCK_SIZE;\n\t}\n\n\tif ( !(shs[sHotstringCount] = new Hotstring(aName, aCallback, aOptions, aHotstring, aReplacement, aHasContinuationSection, aSuspend)) )\n\t\treturn MemoryError(); // Short msg. since so rare.\n\tif (!shs[sHotstringCount]->mConstructedOK)\n\t{\n\t\tdelete shs[sHotstringCount]; // SimpleHeap allows deletion of most recently added item.\n\t\treturn FAIL; // The constructor already displayed the error.\n\t}\n\n\t++sHotstringCount;\n\tif (!g_script.mIsReadyToExecute) // Caller is LoadIncludedFile(); allow BIF_Hotstring to manage this at runtime.\n\t\t++sEnabledCount; // This works because the script can't be suspended during startup (aSuspend is always FALSE).\n\treturn OK;\n}\n\n\n\nHotstring::Hotstring(LPCTSTR aName, IObjectPtr aCallback, LPCTSTR aOptions, LPCTSTR aHotstring, LPCTSTR aReplacement\n\t, bool aHasContinuationSection, UCHAR aSuspend)\n\t: mCallback(aCallback)\n\t, mName(NULL)\n\t, mString(NULL), mReplacement(NULL), mStringLength(0)\n\t, mHotCriterion(g->HotCriterion)\n\t, mSuspended(aSuspend)\n\t, mExistingThreads(0)\n\t, mMaxThreads(g_MaxThreadsPerHotkey) // The value of g_MaxThreadsPerHotkey can vary during load-time.\n\t, mPriority(g_HSPriority), mKeyDelay(g_HSKeyDelay), mSendMode(g_HSSendMode) // And all these can vary too.\n\t, mCaseSensitive(g_HSCaseSensitive), mConformToCase(g_HSConformToCase), mDoBackspace(g_HSDoBackspace)\n\t, mOmitEndChar(g_HSOmitEndChar), mSendRaw(aHasContinuationSection ? SCM_RAW_TEXT : g_HSSendRaw)\n\t, mEndCharRequired(g_HSEndCharRequired), mDetectWhenInsideWord(g_HSDetectWhenInsideWord), mDoReset(g_HSDoReset)\n\t, mInputLevel(g_InputLevel)\n\t, mSuspendExempt(g_SuspendExempt || g_SuspendExemptHS)\n\t, mConstructedOK(false)\n{\n\tbool unused_x = false;\n\tParseOptions(aOptions, mPriority, mKeyDelay, mSendMode, mCaseSensitive, mConformToCase, mDoBackspace\n\t\t, mOmitEndChar, mSendRaw, mEndCharRequired, mDetectWhenInsideWord, mDoReset, unused_x, mSuspendExempt);\n\t\n\t// To avoid memory leak, this is done only when it is certain the hotstring will be created:\n\tif ( !(mString = SimpleHeap::Malloc(aHotstring)) )\n\t\treturn; // ScriptError() was already called by Malloc().\n\tif ( !(mName = SimpleHeap::Malloc(aName)) )\n\t{\n\t\tSimpleHeap::Delete(mString); // SimpleHeap allows deletion of most recently added item.\n\t\treturn;\n\t}\n\tmStringLength = (UCHAR)_tcslen(mString);\n\tif (aReplacement && *aReplacement)\n\t{\n\t\t// SimpleHeap is not used for the replacement as it can be changed at runtime by Hotstring().\n\t\tif ( !(mReplacement = _tcsdup(aReplacement)) )\n\t\t{\n\t\t\tMemoryError(); // Short msg since very rare.\n\t\t\treturn;\n\t\t}\n\t}\n\telse // Leave mReplacement NULL, but make this false so that the hook doesn't do extra work.\n\t\tmConformToCase = false;\n\n\tmConstructedOK = true; // Done at the very end.\n}\n\n\n\nvoid Hotstring::ParseOptions(LPCTSTR aOptions)\n{\n\tbool unused_X_option;\n\tParseOptions(aOptions, mPriority, mKeyDelay, mSendMode, mCaseSensitive, mConformToCase, mDoBackspace\n\t\t, mOmitEndChar, mSendRaw, mEndCharRequired, mDetectWhenInsideWord, mDoReset, unused_X_option, mSuspendExempt);\n}\n\n\n\nvoid Hotstring::ParseOptions(LPCTSTR aOptions, int &aPriority, int &aKeyDelay, SendModes &aSendMode\n\t, bool &aCaseSensitive, bool &aConformToCase, bool &aDoBackspace, bool &aOmitEndChar, SendRawType &aSendRaw\n\t, bool &aEndCharRequired, bool &aDetectWhenInsideWord, bool &aDoReset, bool &aExecuteAction, bool &aSuspendExempt)\n{\n\t// In this case, colon rather than zero marks the end of the string. However, the string\n\t// might be empty so check for that too. In addition, this is now called from\n\t// IsDirective(), so that's another reason to check for normal string termination.\n\tfor (auto cp = aOptions; *cp && *cp != ':'; ++cp)\n\t{\n\t\tauto cp1 = cp + 1;\n\t\tswitch(ctoupper(*cp))\n\t\t{\n\t\tcase '*':\n\t\t\taEndCharRequired = (*cp1 == '0');\n\t\t\tbreak;\n\t\tcase '?':\n\t\t\taDetectWhenInsideWord = (*cp1 != '0');\n\t\t\tbreak;\n\t\tcase 'B': // Do backspacing.\n\t\t\taDoBackspace = (*cp1 != '0');\n\t\t\tbreak;\n\t\tcase 'C':\n\t\t\tif (*cp1 == '0') // restore both settings to default.\n\t\t\t{\n\t\t\t\taConformToCase = true;\n\t\t\t\taCaseSensitive = false;\n\t\t\t}\n\t\t\telse if (*cp1 == '1')\n\t\t\t{\n\t\t\t\taConformToCase = false;\n\t\t\t\taCaseSensitive = false;\n\t\t\t}\n\t\t\telse // treat as plain \"C\"\n\t\t\t{\n\t\t\t\taConformToCase = false; // No point in conforming if its case sensitive.\n\t\t\t\taCaseSensitive = true;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'O':\n\t\t\taOmitEndChar = (*cp1 != '0');\n\t\t\tbreak;\n\t\t// For options such as K & P: Use atoi() vs. ATOI() to avoid interpreting something like 0x01C\n\t\t// as hex when in fact the C was meant to be an option letter:\n\t\tcase 'K':\n\t\t\taKeyDelay = _ttoi(cp1);\n\t\t\tbreak;\n\t\tcase 'P':\n\t\t\taPriority = _ttoi(cp1);\n\t\t\tbreak;\n\t\tcase 'R':\n\t\t\taSendRaw = (*cp1 != '0') ? SCM_RAW : SCM_NOT_RAW;\n\t\t\tbreak;\n\t\tcase 'T':\n\t\t\taSendRaw = (*cp1 != '0') ? SCM_RAW_TEXT : SCM_NOT_RAW;\n\t\t\tbreak;\n\t\tcase 'S':\n\t\t\tif (*cp1)\n\t\t\t\t++cp; // Skip over S's sub-letter (if any) to exclude it from further consideration.\n\t\t\tswitch (ctoupper(*cp1))\n\t\t\t{\n\t\t\t// There is no means to choose SM_INPUT because it seems too rarely desired (since auto-replace\n\t\t\t// hotstrings would then become interruptible, allowing the keystrokes of fast typists to get\n\t\t\t// interspersed with the replacement text).\n\t\t\tcase 'I': aSendMode = SM_INPUT_FALLBACK_TO_PLAY; break;\n\t\t\tcase 'E': aSendMode = SM_EVENT; break;\n\t\t\tcase 'P': aSendMode = SM_PLAY; break;\n\t\t\tdefault: aSuspendExempt = (*cp1 != '0'); break;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'Z':\n\t\t\taDoReset = (*cp1 != '0');\n\t\t\tbreak;\n\t\tcase 'X':\n\t\t\taExecuteAction = (*cp1 != '0');\n\t\t\tbreak;\n\t\t// Otherwise: Ignore other characters, such as the digits that comprise the number after the P option.\n\t\t}\n\t}\n}\n\n\n\nHotstring *Hotstring::FindHotstring(LPCTSTR aHotstring, bool aCaseSensitive, bool aDetectWhenInsideWord, HotkeyCriterion *aHotCriterion)\n{\n\tfor (UINT u = 0; u < sHotstringCount; ++u)\n\t{\n\t\tHotstring &hs = *shs[u];\n\t\t// hs.mEndCharRequired is not checked because although it affects the conditions for activating\n\t\t// the hotstring, ::abbrev:: and :*:abbrev:: cannot co-exist (the latter would always take over).\n\t\tif ( hs.mHotCriterion == aHotCriterion // Same #HotIf criterion.\n\t\t\t&& hs.mCaseSensitive == aCaseSensitive // ::BTW:: and :C:BTW:: can co-exist.\n\t\t\t&& hs.mDetectWhenInsideWord == aDetectWhenInsideWord // :?:ion:: and ::ion:: can co-exist.\n\t\t\t&& (aCaseSensitive ? !_tcscmp(hs.mString, aHotstring) : !lstrcmpi(hs.mString, aHotstring)) ) // :C:BTW:: and :C:btw:: can co-exist, but not ::BTW:: and ::btw::.\n\t\t\treturn &hs;\n\t}\n\treturn NULL;\n}\n\n\n\nbif_impl FResult BIF_Hotstring(StrArg name, ExprTokenType *aReplacement, optl<StrArg> aOnOff, ResultToken &aResultToken)\n{\n\taResultToken.symbol = SYM_STRING;\n\taResultToken.marker = _T(\"\");\n\n\tTCHAR number_buf[MAX_NUMBER_SIZE];\n\tauto action = aReplacement ? TokenToString(*aReplacement, number_buf) : _T(\"\");\n\n\tif (!_tcsicmp(name, _T(\"EndChars\"))) // Equivalent to #Hotstring EndChars <action>\n\t{\n\t\tTokenSetResult(aResultToken, g_EndChars); // Return the old value.\n\t\tif (aReplacement)\n\t\t\t// There is some concern of a race condition with the hook thread, but since g_EndChars\n\t\t\t// has static storage duration and is therefore zero-initialized at startup (in particular,\n\t\t\t// the last char is always zero), the only consequence would be that some old end chars may\n\t\t\t// be used if a hotstring is evaluated during the tcslcpy() call.\n\t\t\ttcslcpy(g_EndChars, action, _countof(g_EndChars));\n\t\treturn OK;\n\t}\n\telse if (!_tcsicmp(name, _T(\"MouseReset\"))) // \"MouseReset, true\" seems more intuitive than \"NoMouse, false\"\n\t{\n\t\tbool previous_value = g_HSResetUponMouseClick;\n\t\tif (aReplacement)\n\t\t{\n\t\t\tg_HSResetUponMouseClick = TokenToBOOL(*aReplacement);\n\t\t\tif (g_HSResetUponMouseClick != previous_value && Hotstring::sEnabledCount) // No need if there aren't any hotstrings.\n\t\t\t\tHotkey::ManifestAllHotkeysHotstringsHooks(); // Install the hook if needed, or uninstall if no longer needed.\n\t\t}\n\t\taResultToken.SetValue(previous_value);\n\t\treturn OK;\n\t}\n\telse if (!_tcsicmp(name, _T(\"Reset\")))\n\t{\n\t\t*g_HSBuf = '\\0';\n\t\tg_HSBufLength = 0;\n\t\treturn OK;\n\t}\n\telse if (!aReplacement && !aOnOff.has_value() && *name != ':') // Equivalent to #Hotstring <name>\n\t{\n\t\t// TODO: Build string of current options and return it?\n\t\tbool unused_X_option; // 'X' option is required to be passed for each Hotstring() call, for clarity.\n\t\tHotstring::ParseOptions(name, g_HSPriority, g_HSKeyDelay, g_HSSendMode, g_HSCaseSensitive\n\t\t\t, g_HSConformToCase, g_HSDoBackspace, g_HSOmitEndChar, g_HSSendRaw, g_HSEndCharRequired\n\t\t\t, g_HSDetectWhenInsideWord, g_HSDoReset, unused_X_option, g_SuspendExemptHS);\n\t\treturn OK;\n\t}\n\n\t// Parse the hotstring name (this is similar to a section in LoadIncludedFile()):\n\tLPCTSTR hotstring_start = NULL;\n\tLPCTSTR hotstring_options = _T(\"\"); // Set default as \"no options were specified for this hotstring\".\n\tif (name[0] == ':' && name[1])\n\t{\n\t\tif (name[1] != ':')\n\t\t{\n\t\t\thotstring_options = name + 1; // Point it to the hotstring's option letters.\n\t\t\t// The following relies on the fact that options should never contain a literal colon.\n\t\t\tif ( !(hotstring_start = _tcschr(hotstring_options, ':')) )\n\t\t\t\thotstring_start = NULL; // Indicate that this isn't a hotstring after all.\n\t\t\telse\n\t\t\t\t++hotstring_start; // Points to the hotstring itself.\n\t\t}\n\t\telse // Double-colon, so it's a hotstring if there's more after this (but this means no options are present).\n\t\t\tif (name[2])\n\t\t\t\thotstring_start = name + 2;\n\t\t\t//else it's just a naked \"::\", which is invalid.\n\t}\n\tif (!hotstring_start)\n\t\treturn FR_E_ARG(0);\n\t\n\t// Determine options which affect hotstring identity/uniqueness.\n\tbool case_sensitive = g_HSCaseSensitive;\n\tbool detect_inside_word = g_HSDetectWhenInsideWord;\n\tbool un; int iun; SendModes sm; SendRawType sr; // Unused.\n\tbool execute_action = false;\n\tif (*hotstring_options)\n\t\tHotstring::ParseOptions(hotstring_options, iun, iun, sm, case_sensitive, un, un, un, sr, un, detect_inside_word, un, execute_action, un);\n\n\tIObject *action_obj = NULL;\n\tif (aReplacement)\n\t{\n\t\tif (action_obj = TokenToObject(*aReplacement))\n\t\t\taction_obj->AddRef();\n\t\telse if (execute_action)\n\t\t\treturn FR_E_ARG(1); // The 'X' option must be used together with a function object.\n\t\t// Otherwise, it's always replacement text\n\t}\n\t\n\tToggleValueType toggle = NEUTRAL;\n\tif ( aOnOff.has_value() && !(toggle = Line::ConvertOnOffToggle(aOnOff.value())) )\n\t{\n\t\tif (action_obj)\n\t\t\taction_obj->Release();\n\t\treturn FR_E_ARG(2);\n\t}\n\n\tbool was_already_enabled;\n\tHotstring *existing = Hotstring::FindHotstring(hotstring_start, case_sensitive, detect_inside_word, g->HotCriterion);\n\tif (existing)\n\t{\n\t\twas_already_enabled = !existing->mSuspended;\n\n\t\t// Update the replacement string or function, if specified.\n\t\tif (action_obj || *action)\n\t\t{\n\t\t\tLPTSTR new_replacement = NULL; // Set default: not auto-replace.\n\t\t\tif (!action_obj) // Caller specified a replacement string ('E' option was handled above).\n\t\t\t{\n\t\t\t\tif (existing->mReplacement && !_tcscmp(action, existing->mReplacement))\n\t\t\t\t{\n\t\t\t\t\t// Caller explicitly passed the same string it already had, which might be common,\n\t\t\t\t\t// such as if a single Hotstring() call site is used to both create and update.\n\t\t\t\t\tnew_replacement = existing->mReplacement; // Avoid reallocating it.\n\t\t\t\t}\n\t\t\t\telse if ( !(new_replacement = _tcsdup(action)) )\n\t\t\t\t\treturn FR_E_OUTOFMEM;\n\t\t\t}\n\t\t\texisting->mSuspended |= HS_TEMPORARILY_DISABLED;\n\t\t\tWaitHookIdle();\n\t\t\t// At this point it is certain the hook thread is not in the middle of reading this\n\t\t\t// hotstring's other properties, such as mReplacement (which we may be about to free).\n\t\t\tif (new_replacement != existing->mReplacement)\n\t\t\t{\n\t\t\t\tif (existing->mReplacement)\n\t\t\t\t\tfree(existing->mReplacement);\n\t\t\t\texisting->mReplacement = new_replacement;\n\t\t\t}\n\t\t\tif (action_obj != existing->mCallback)\n\t\t\t{\n\t\t\t\texisting->mCallback = action_obj;\n\t\t\t}\n\t\t}\n\t\t// Update the hotstring's options. Note that mCaseSensitive and mDetectWhenInsideWord\n\t\t// can't be changed this way since FindHotstring() would not have found it if they differed.\n\t\t// This is done after the above to avoid *partial* updates in the event of a failure.\n\t\texisting->ParseOptions(hotstring_options);\n\t\tswitch (toggle)\n\t\t{\n\t\tcase TOGGLE: existing->mSuspended ^= HS_TURNED_OFF; break;\n\t\tcase TOGGLED_ON: existing->mSuspended &= ~HS_TURNED_OFF; break;\n\t\tcase TOGGLED_OFF: existing->mSuspended |= HS_TURNED_OFF; break;\n\t\t}\n\t\texisting->mSuspended &= ~HS_TEMPORARILY_DISABLED; // Re-enable if it was disabled above.\n\t}\n\telse // No matching hotstring yet.\n\t{\n\t\tif (!action_obj && !*action)\n\t\t\treturn FError(ERR_NONEXISTENT_HOTSTRING, name, ErrorPrototype::Target);\n\n\t\tUCHAR initial_suspend_state = (toggle == TOGGLED_OFF) ? HS_TURNED_OFF : FALSE;\n\t\tif (g_IsSuspended)\n\t\t\tinitial_suspend_state |= HS_SUSPENDED;\n\n\t\tif (!Hotstring::AddHotstring(name, action_obj, hotstring_options, hotstring_start, action, false, initial_suspend_state))\n\t\t{\n\t\t\tif (action_obj)\n\t\t\t\taction_obj->Release();\n\t\t\treturn FR_FAIL;\n\t\t}\n\n\t\texisting = Hotstring::shs[Hotstring::sHotstringCount-1];\n\t\twas_already_enabled = false; // Because it didn't exist.\n\t}\n\n\tif (action_obj)\n\t\taction_obj->Release();\n\n\t// Note that mSuspended must be 0 to count as enabled, meaning the hotstring was neither\n\t// turned off by us nor suspended by SuspendAll(). If it was suspended, there's no change\n\t// in status.\n\tbool is_enabled = !existing->mSuspended; // Important to avoid direct comparison with mSuspended becauses it isn't pure bool.\n\tif (is_enabled != was_already_enabled)\n\t{\n\t\t// One of the following just happened:\n\t\t// - a hotstring was created and enabled\n\t\t// - an existing disabled hotstring was just enabled\n\t\t// - an existing enabled hotstring was just disabled\n\t\tUINT previously_enabled = Hotstring::sEnabledCount;\n\t\tHotstring::sEnabledCount += is_enabled ? +1 : -1;\n\t\tif ((Hotstring::sEnabledCount > 0) != (previously_enabled > 0)) // Change in status of whether the hotstring recognizer is needed.\n\t\t{\n\t\t\tif (is_enabled)\n\t\t\t{\n\t\t\t\t*g_HSBuf = '\\0'; // See SuspendAll() for comments.\n\t\t\t\tg_HSBufLength = 0;\n\t\t\t}\n\t\t\tif (!is_enabled || !g_KeybdHook) // Hook may not be needed anymore || hook is needed but not present.\n\t\t\t\tHotkey::ManifestAllHotkeysHotstringsHooks();\n\t\t}\n\t}\n\treturn OK;\n}\n"},"size":{"kind":"number","value":132722,"string":"132,722"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":2585,"string":"2,585"},"avg_line_length":{"kind":"number","value":48.28471953578337,"string":"48.28472"},"max_line_length":{"kind":"number","value":237,"string":"237"},"alphanum_fraction":{"kind":"number","value":0.7269359906357812,"string":"0.726936"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11086,"cells":{"id":{"kind":"number","value":16075,"string":"16,075"},"file_name":{"kind":"string","value":"input_object.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/input_object.cpp"},"content":{"kind":"string","value":"#include \"stdafx.h\" // pre-compiled headers\n#include \"defines.h\"\n#include \"globaldata.h\"\n#include \"script.h\"\n#include \"application.h\"\n\n#include \"script_object.h\"\n#include \"script_func_impl.h\"\n#include \"input_object.h\"\n\n\nObjectMemberMd InputObject::sMembers[] =\n{\n\t#define BOOL_OPTION(OPT) md_property(InputObject, OPT, Bool32)\n\t#define ONX_OPTION(X) \\\n\t\tmd_property_get(InputObject, On##X, Object), \\\n\t\tmd_property_set(InputObject, On##X, Variant)\n\t\n\tmd_member(InputObject, __New, CALL, (In_Opt, String, Options), (In_Opt, String, EndKeys), (In_Opt, String, MatchList)),\n\tmd_member(InputObject, KeyOpt, CALL, (In, String, Keys), (In, String, KeyOptions)),\n\tmd_member(InputObject, Start, CALL, md_arg_none),\n\tmd_member(InputObject, Stop, CALL, md_arg_none),\n\tmd_member(InputObject, Wait, CALL, (In_Opt, Float64, MaxTime), (Ret, String, RetVal)),\n\t\n\tBOOL_OPTION(BackspaceIsUndo),\n\tBOOL_OPTION(CaseSensitive),\n\tBOOL_OPTION(FindAnywhere),\n\tBOOL_OPTION(NotifyNonText),\n\tBOOL_OPTION(VisibleNonText),\n\tBOOL_OPTION(VisibleText),\n\t\n\tmd_property_get(InputObject, EndKey, String),\n\tmd_property_get(InputObject, EndMods, String),\n\tmd_property_get(InputObject, EndReason, String),\n\tmd_property_get(InputObject, InProgress, Bool32),\n\tmd_property_get(InputObject, Input, String),\n\tmd_property_get(InputObject, Match, String),\n\t\n\tmd_property(InputObject, MinSendLevel, Int32),\n\t\n\tONX_OPTION(Char),\n\tONX_OPTION(End),\n\tONX_OPTION(KeyDown),\n\tONX_OPTION(KeyUp),\n\t\n\tmd_property(InputObject, Timeout, Float64)\n\t#undef BOOL_OPTION\n\t#undef ONX_OPTION\n};\nint InputObject::sMemberCount = _countof(sMembers);\n\nObject *InputObject::sPrototype;\n\nInputObject::InputObject()\n{\n\tinput.ScriptObject = this;\n\tSetBase(sPrototype);\n}\n\n\nObject *InputObject::Create()\n{\n\treturn new InputObject();\n}\n\n\nFResult InputObject::__New(optl<StrArg> aOptions, optl<StrArg> aEndKeys, optl<StrArg> aMatchList)\n{\n\treturn input.Setup(aOptions.value_or_empty(), aEndKeys.value_or_empty(), aMatchList.value_or_empty()) ? OK : FR_FAIL;\n}\n\n\nFResult InputObject::Start()\n{\n\tif (!input.InProgress())\n\t{\n\t\tinput.Buffer[input.BufferLength = 0] = '\\0';\n\t\tInputStart(input);\n\t}\n\treturn OK;\n}\n\n\nFResult InputObject::Wait(optl<double> aMaxTime, StrRet &aRetVal)\n{\n\tauto wait_ms = aMaxTime.has_value() ? (UINT)(aMaxTime.value() * 1000) : UINT_MAX;\n\tauto tick_start = GetTickCount();\n\twhile (input.InProgress() && (GetTickCount() - tick_start) < wait_ms)\n\t\tMsgSleep();\n\treturn get_EndReason(aRetVal);\n}\n\n\nFResult InputObject::Stop()\n{\n\tif (input.InProgress())\n\t\tinput.Stop();\n\treturn OK;\n}\n\n\nFResult InputObject::get_EndReason(StrRet &aRetVal)\n{\n\taRetVal.SetStatic(input.GetEndReason(NULL, 0));\n\treturn OK;\n}\n\nFResult InputObject::get_EndKey(StrRet &aRetVal)\n{\n\tif (input.Status == INPUT_TERMINATED_BY_ENDKEY)\n\t{\n\t\tauto buf = aRetVal.CallerBuf();\n\t\tinput.GetEndReason(buf, aRetVal.CallerBufSize);\n\t\taRetVal.SetTemp(buf);\n\t}\n\telse\n\t\taRetVal.SetEmpty();\n\treturn OK;\n}\n\nFResult InputObject::get_EndMods(StrRet &aRetVal)\n{\n\tauto buf = aRetVal.CallerBuf(), cp = buf;\n\tconst auto mod_string = MODLR_STRING;\n\tfor (int i = 0; i < 8; ++i)\n\t\tif (input.EndingMods & (1 << i))\n\t\t{\n\t\t\t*cp++ = mod_string[i * 2];\n\t\t\t*cp++ = mod_string[i * 2 + 1];\n\t\t}\n\t*cp = '\\0';\n\taRetVal.SetTemp(buf, cp - buf);\n\treturn OK;\n}\n\nFResult InputObject::get_Input(StrRet &aRetVal)\n{\n\taRetVal.SetTemp(input.Buffer, input.BufferLength);\n\treturn OK;\n}\n\nFResult InputObject::get_Match(StrRet &aRetVal)\n{\n\tif (input.Status == INPUT_TERMINATED_BY_MATCH && input.EndingMatchIndex < input.MatchCount)\n\t\taRetVal.SetTemp(input.match[input.EndingMatchIndex]);\n\telse\n\t\taRetVal.SetEmpty();\n\treturn OK;\n}\n\n\nFResult InputObject::get_On(IObject *&aRetVal, IObject *&aOn)\n{\n\tif (aRetVal = aOn)\n\t\taRetVal->AddRef();\n\treturn OK;\n}\n\n\nFResult InputObject::set_On(ExprTokenType &aValue, IObject *&aOn, int aValidParamCount)\n{\n\tauto obj = TokenToObject(aValue);\n\tif (obj)\n\t{\n\t\tauto fr = ValidateFunctor(obj, aValidParamCount);\n\t\tif (fr != OK)\n\t\t\treturn fr;\n\t\tobj->AddRef();\n\t}\n\telse if (!TokenIsEmptyString(aValue))\n\t\treturn FTypeError(_T(\"object\"), aValue);\n\tauto prev = aOn;\n\taOn = obj;\n\tif (prev)\n\t\tprev->Release();\n\treturn OK;\n}\n\n\nFResult InputObject::set_MinSendLevel(int aValue)\n{\n\tif (aValue < 0 || aValue > 101)\n\t\treturn FR_E_ARG(0);\n\tinput.MinSendLevel = aValue;\n\treturn OK;\n}\n\n\nFResult InputObject::set_Timeout(double aValue)\n{\n\tinput.Timeout = (int)(aValue * 1000);\n\tif (input.InProgress() && input.Timeout > 0)\n\t\tinput.SetTimeoutTimer();\n\treturn OK;\n}\n\n\nFResult InputObject::KeyOpt(StrArg keys, StrArg options)\n{\n\tbool adding = true;\n\tUCHAR flag, add_flags = 0, remove_flags = 0;\n\tfor (auto cp = options; *cp; ++cp)\n\t{\n\t\tswitch (ctoupper(*cp))\n\t\t{\n\t\tcase '+': adding = true; continue;\n\t\tcase '-': adding = false; continue;\n\t\tcase ' ': case '\\t': continue;\n\t\tcase 'E': flag = END_KEY_ENABLED; break;\n\t\tcase 'I': flag = INPUT_KEY_IGNORE_TEXT; break;\n\t\tcase 'N': flag = INPUT_KEY_NOTIFY; break;\n\t\tcase 'S':\n\t\t\tflag = INPUT_KEY_SUPPRESS;\n\t\t\tif (adding)\n\t\t\t\tremove_flags |= INPUT_KEY_VISIBLE;\n\t\t\tbreak;\n\t\tcase 'V':\n\t\t\tflag = INPUT_KEY_VISIBLE;\n\t\t\tif (adding)\n\t\t\t\tremove_flags |= INPUT_KEY_SUPPRESS;\n\t\t\tbreak;\n\t\tcase 'Z': // Zero (reset)\n\t\t\tadd_flags = 0;\n\t\t\tremove_flags = INPUT_KEY_OPTION_MASK;\n\t\t\tcontinue;\n\t\tdefault: return FValueError(ERR_INVALID_OPTION, cp);\n\t\t}\n\t\tif (adding)\n\t\t\tadd_flags |= flag; // Add takes precedence over remove, so remove_flags isn't changed.\n\t\telse\n\t\t{\n\t\t\tremove_flags |= flag;\n\t\t\tadd_flags &= ~flag; // Override any previous add.\n\t\t}\n\t}\n\t\n\tif (!_tcsicmp(keys, _T(\"{All}\")))\n\t{\n\t\t// Could optimize by using memset() when remove_flags == 0xFF, but that doesn't seem\n\t\t// worthwhile since this mode is already faster than SetKeyFlags() with a single key.\n\t\tfor (int i = 0; i < _countof(input.KeyVK); ++i)\n\t\t\tinput.KeyVK[i] = (input.KeyVK[i] & ~remove_flags) | add_flags;\n\t\tfor (int i = 0; i < _countof(input.KeySC); ++i)\n\t\t\tinput.KeySC[i] = (input.KeySC[i] & ~remove_flags) | add_flags;\n\t\treturn OK;\n\t}\n\n\treturn input.SetKeyFlags(keys, false, remove_flags, add_flags) ? OK : FR_FAIL;\n}\n"},"size":{"kind":"number","value":5999,"string":"5,999"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":210,"string":"210"},"avg_line_length":{"kind":"number","value":26.23333333333333,"string":"26.233333"},"max_line_length":{"kind":"number","value":120,"string":"120"},"alphanum_fraction":{"kind":"number","value":0.7128678391084798,"string":"0.712868"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11087,"cells":{"id":{"kind":"number","value":16076,"string":"16,076"},"file_name":{"kind":"string","value":"AutoHotkey.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/AutoHotkey.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"globaldata.h\" // for access to many global vars\n#include \"application.h\" // for MsgSleep()\n#include \"window.h\" // For MsgBox()\n#include \"TextIO.h\"\n\n// General note:\n// The use of Sleep() should be avoided *anywhere* in the code. Instead, call MsgSleep().\n// The reason for this is that if the keyboard or mouse hook is installed, a straight call\n// to Sleep() will cause user keystrokes & mouse events to lag because the message pump\n// (GetMessage() or PeekMessage()) is the only means by which events are ever sent to the\n// hook functions.\n\n\nResultType InitForExecution();\nResultType ParseCmdLineArgs(LPTSTR &script_filespec);\nResultType CheckPriorInstance();\nint MainExecuteScript(bool aMsgSleep = true);\n\n\n// Performs any initialization that should be done before LoadFromFile().\nvoid EarlyAppInit()\n{\n\t// v1.1.22+: This is done unconditionally, on startup, so that any attempts to read a drive\n\t// that has no media (and possibly other errors) won't cause the system to display an error\n\t// dialog that the script can't suppress. This is known to affect floppy drives and some\n\t// but not all CD/DVD drives. MSDN says: \"Best practice is that all applications call the\n\t// process-wide SetErrorMode function with a parameter of SEM_FAILCRITICALERRORS at startup.\"\n\t// Note that in previous versions, this was done by the Drive/DriveGet commands and not\n\t// reverted afterward, so it affected all subsequent commands.\n\tSetErrorMode(SEM_FAILCRITICALERRORS);\n\n\t// g_WorkingDir is used by various functions but might currently only be used at runtime.\n\t// g_WorkingDirOrig needs to be initialized before Script::Init() is called.\n\tUpdateWorkingDir();\n\tg_WorkingDirOrig = SimpleHeap::Alloc(g_WorkingDir.GetString());\n\n\t// Initialize early since g is used in many places, including some at load-time.\n\tglobal_init(*g);\n\t\n\t// Initialize the object model here, prior to any use of Objects (or Array below).\n\t// Doing this here rather than in a static initializer in script_object.cpp avoids\n\t// issues of static initialization order. At this point all static members such as\n\t// sMembers arrays have been initialized (normally they are constant initialized\n\t// anyway, but in debug mode the arrays using cast_into_voidp() are not).\n\tObject::CreateRootPrototypes();\n}\n\n\nint WINAPI _tWinMain (HINSTANCE hInstance, HINSTANCE hPrevInstance, LPTSTR lpCmdLine, int nCmdShow)\n{\n\tg_hInstance = hInstance;\n\n\tEarlyAppInit();\n\n\tLPTSTR script_filespec; // Script path as originally specified, or NULL if omitted/defaulted.\n\tif (!ParseCmdLineArgs(script_filespec))\n\t\treturn CRITICAL_ERROR;\n\n\tUINT load_result = g_script.LoadFromFile(script_filespec);\n\tif (load_result == LOADING_FAILED) // Error during load (was already displayed by the function call).\n\t\treturn CRITICAL_ERROR; // Should return this value because PostQuitMessage() also uses it.\n\tif (!load_result) // LoadFromFile() relies upon us to do this check. No script was loaded or we're in /iLib mode, so nothing more to do.\n\t\treturn 0;\n\n\tswitch (CheckPriorInstance())\n\t{\n\tcase EARLY_EXIT: return 0;\n\tcase FAIL: return CRITICAL_ERROR;\n\t}\n\n\tif (!InitForExecution())\n\t\treturn CRITICAL_ERROR;\n\n\treturn MainExecuteScript();\n}\n\n\nResultType ParseCmdLineArgs(LPTSTR &script_filespec)\n{\n\tscript_filespec = NULL; // Set default as \"unspecified/omitted\".\n#ifndef AUTOHOTKEYSC\n\t// Is this a compiled script?\n\tif (FindResource(NULL, SCRIPT_RESOURCE_NAME, RT_RCDATA))\n\t\tscript_filespec = SCRIPT_RESOURCE_SPEC;\n#endif\n\n\t// The number of switches recognized by compiled scripts (without /script) is kept to a minimum\n\t// since all such switches must be effectively reserved, as there's nothing to separate them from\n\t// the switches defined by the script itself. The abbreviated /R and /F switches present in v1\n\t// were also removed for this reason.\n\t// \n\t// Examine command line args. Rules:\n\t// Any special flags (e.g. /force and /restart) must appear prior to the script filespec.\n\t// The script filespec (if present) must be the first non-backslash arg.\n\t// All args that appear after the filespec are considered to be parameters for the script\n\t// and will be stored in A_Args.\n\tint i;\n\tfor (i = 1; i < __argc; ++i) // Start at 1 because 0 contains the program name.\n\t{\n\t\tLPTSTR param = __targv[i]; // For performance and convenience.\n\t\t// Insist that switches be an exact match for the allowed values to cut down on ambiguity.\n\t\t// For example, if the user runs \"CompiledScript.exe /find\", we want /find to be considered\n\t\t// an input parameter for the script rather than a switch:\n\t\tif (!_tcsicmp(param, _T(\"/restart\")))\n\t\t\tg_script.mIsRestart = true;\n\t\telse if (!_tcsicmp(param, _T(\"/force\")))\n\t\t\tg_ForceLaunch = true;\n#ifndef AUTOHOTKEYSC // i.e. the following switch is recognized only by AutoHotkey.exe (especially since recognizing new switches in compiled scripts can break them, unlike AutoHotkey.exe).\n\t\telse if (!_tcsicmp(param, _T(\"/script\")))\n\t\t\tscript_filespec = NULL; // Override compiled script mode, otherwise no effect.\n\t\telse if (script_filespec) // Compiled script mode.\n\t\t\tbreak;\n\t\telse if (!_tcsnicmp(param, _T(\"/ErrorStdOut\"), 12) && (param[12] == '\\0' || param[12] == '='))\n\t\t\tg_script.SetErrorStdOut(param[12] == '=' ? param + 13 : NULL);\n\t\telse if (!_tcsicmp(param, _T(\"/include\")))\n\t\t{\n\t\t\t++i; // Consume the next parameter too, because it's associated with this one.\n\t\t\tif (i >= __argc // Missing the expected filename parameter.\n\t\t\t\t|| g_script.mCmdLineInclude) // Only one is supported, so abort if there's more.\n\t\t\t\treturn FAIL;\n\t\t\tg_script.mCmdLineInclude = __targv[i];\n\t\t}\n\t\telse if (!_tcsicmp(param, _T(\"/validate\")))\n\t\t\tg_script.mValidateThenExit = true;\n\t\t// DEPRECATED: /iLib\n\t\telse if (!_tcsicmp(param, _T(\"/iLib\"))) // v1.0.47: Build an include-file so that ahk2exe can include library functions called by the script.\n\t\t{\n\t\t\t++i; // Consume the next parameter too, because it's associated with this one.\n\t\t\tif (i >= __argc) // Missing the expected filename parameter.\n\t\t\t\treturn FAIL;\n\t\t\t// The original purpose of /iLib has gone away with the removal of auto-includes,\n\t\t\t// but some scripts (like Ahk2Exe) use it to validate the syntax of script files.\n\t\t\tg_script.mValidateThenExit = true;\n\t\t}\n\t\telse if (!_tcsnicmp(param, _T(\"/CP\"), 3)) // /CPnnn\n\t\t{\n\t\t\t// Default codepage for the script file, NOT the default for commands used by it.\n\t\t\tg_DefaultScriptCodepage = ATOU(param + 3);\n\t\t}\n#endif\n#ifdef CONFIG_DEBUGGER\n\t\t// Allow a debug session to be initiated by command-line.\n\t\telse if (!_tcsnicmp(param, _T(\"/Debug\"), 6) && (param[6] == '\\0' || param[6] == '='))\n\t\t{\n\t\t\tif (param[6] == '=')\n\t\t\t{\n\t\t\t\tparam += 7;\n\n\t\t\t\tLPTSTR c = _tcsrchr(param, ':');\n\n\t\t\t\tif (c)\n\t\t\t\t{\n\t\t\t\t\tStringTCharToChar(param, g_DebuggerHost, (int)(c-param));\n\t\t\t\t\tStringTCharToChar(c + 1, g_DebuggerPort);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tStringTCharToChar(param, g_DebuggerHost);\n\t\t\t\t\tg_DebuggerPort = \"9000\";\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tg_DebuggerHost = \"localhost\";\n\t\t\t\tg_DebuggerPort = \"9000\";\n\t\t\t}\n\t\t\t// The actual debug session is initiated after the script is successfully parsed.\n\t\t}\n#endif\n\t\telse // since this is not a recognized switch, the end of the [Switches] section has been reached (by design).\n\t\t{\n#ifndef AUTOHOTKEYSC\n\t\t\tscript_filespec = param; // The first unrecognized switch must be the script filespec, by design.\n\t\t\t++i; // Omit this from the \"args\" array.\n#endif\n\t\t\tbreak; // No more switches allowed after this point.\n\t\t}\n\t}\n\t\n\t// Pass any remaining args to the script via the A_Args array.\n\tauto args = Array::FromArgV(__targv + i, __argc - i);\n\n\t// Set up the basics of the script:\n\treturn g_script.Init(script_filespec, args);\n}\n\n\nResultType CheckPriorInstance()\n{\n\tHWND w_existing = NULL;\n\tUserMessages reason_to_close_prior = (UserMessages)0;\n\tif (g_AllowOnlyOneInstance && !g_script.mIsRestart && !g_ForceLaunch)\n\t{\n\t\tif (w_existing = FindWindow(WINDOW_CLASS_MAIN, g_script.mMainWindowTitle))\n\t\t{\n\t\t\tif (g_AllowOnlyOneInstance == SINGLE_INSTANCE_IGNORE)\n\t\t\t\treturn EARLY_EXIT;\n\t\t\tif (g_AllowOnlyOneInstance != SINGLE_INSTANCE_REPLACE)\n\t\t\t\tif (MsgBox(_T(\"An older instance of this script is already running. Replace it with this\")\n\t\t\t\t\t_T(\" instance?\\nNote: To avoid this message, see #SingleInstance in the help file.\")\n\t\t\t\t\t, MB_YESNO, g_script.mFileName) == IDNO)\n\t\t\t\t\treturn EARLY_EXIT;\n\t\t\t// Otherwise:\n\t\t\treason_to_close_prior = AHK_EXIT_BY_SINGLEINSTANCE;\n\t\t}\n\t}\n\tif (!reason_to_close_prior && g_script.mIsRestart)\n\t\tif (w_existing = FindWindow(WINDOW_CLASS_MAIN, g_script.mMainWindowTitle))\n\t\t\treason_to_close_prior = AHK_EXIT_BY_RELOAD;\n\tif (reason_to_close_prior)\n\t{\n\t\t// Now that the script has been validated and is ready to run, close the prior instance.\n\t\t// We wait until now to do this so that the prior instance's \"restart\" hotkey will still\n\t\t// be available to use again after the user has fixed the script. UPDATE: We now inform\n\t\t// the prior instance of why it is being asked to close so that it can make that reason\n\t\t// available to the OnExit function via a built-in variable:\n\t\tASK_INSTANCE_TO_CLOSE(w_existing, reason_to_close_prior);\n\t\t//PostMessage(w_existing, WM_CLOSE, 0, 0);\n\n\t\t// Wait for it to close before we continue, so that it will deinstall any\n\t\t// hooks and unregister any hotkeys it has:\n\t\tint interval_count;\n\t\tfor (interval_count = 0; ; ++interval_count)\n\t\t{\n\t\t\tSleep(20); // No need to use MsgSleep() in this case.\n\t\t\tif (!IsWindow(w_existing))\n\t\t\t\tbreak; // done waiting.\n\t\t\tif (interval_count == 100)\n\t\t\t{\n\t\t\t\t// This can happen if the previous instance has an OnExit function that takes a long\n\t\t\t\t// time to finish, or if it's waiting for a network drive to timeout or some other\n\t\t\t\t// operation in which it's thread is occupied.\n\t\t\t\tif (MsgBox(_T(\"Could not close the previous instance of this script. Keep waiting?\"), 4) == IDNO)\n\t\t\t\t\treturn FAIL;\n\t\t\t\tinterval_count = 0;\n\t\t\t}\n\t\t}\n\t\t// Give it a small amount of additional time to completely terminate, even though\n\t\t// its main window has already been destroyed:\n\t\tSleep(100);\n\t}\n\treturn OK;\n}\n\n\nResultType InitForExecution()\n{\n\t// Create all our windows and the tray icon. This is done after all other chances\n\t// to return early due to an error have passed, above.\n\tif (!g_script.CreateWindows())\n\t\treturn FAIL;\n\n\tif (g_MaxHistoryKeys && (g_KeyHistory = (KeyHistoryItem *)malloc(g_MaxHistoryKeys * sizeof(KeyHistoryItem))))\n\t\tZeroMemory(g_KeyHistory, g_MaxHistoryKeys * sizeof(KeyHistoryItem)); // Must be zeroed.\n\t//else leave it NULL as it was initialized in globaldata.\n\n\t// From this point on, any errors that are reported should not indicate that they will exit the program.\n\t// Various functions also use this to detect that they are being called by the script at runtime.\n\tg_script.mIsReadyToExecute = true;\n\n\treturn OK;\n}\n\n\nint MainExecuteScript(bool aMsgSleep)\n{\n#ifdef CONFIG_DEBUGGER\n\t// Initiate debug session now if applicable.\n\tif (!g_DebuggerHost.IsEmpty() && g_Debugger.Connect(g_DebuggerHost, g_DebuggerPort) == DEBUGGER_E_OK)\n\t{\n\t\tg_Debugger.Break();\n\t}\n#endif\n\n\t// Activate the hotkeys, hotstrings, and any hooks that are required prior to executing the\n\t// top part (the auto-execute part) of the script so that they will be in effect even if the\n\t// top part is something that's very involved and requires user interaction:\n\tHotkey::ManifestAllHotkeysHotstringsHooks(); // We want these active now in case auto-execute never returns (e.g. loop)\n\n#ifndef _DEBUG\n\t__try\n#endif\n\t{\n\t\t// Run the auto-execute part at the top of the script:\n\t\tauto exec_result = g_script.AutoExecSection();\n\t\t// REMEMBER: The call above will never return if one of the following happens:\n\t\t// 1) The AutoExec section never finishes (e.g. infinite loop).\n\t\t// 2) The AutoExec function uses the Exit or ExitApp command to terminate the script.\n\t\t// 3) The script isn't persistent and its last line is reached (in which case an Exit is implicit).\n\t\t// However, #ifdef CONFIG_DLL, the call will return after Exit is used (but not explicit ExitApp).\n\n#ifdef CONFIG_DLL\n\t\tif (!aMsgSleep)\n\t\t\treturn exec_result ? 0 : CRITICAL_ERROR;\n#endif\n\t\tif (g_script.IsPersistent())\n\t\t{\n\t\t\t// Call it in this special mode to kick off the main event loop.\n\t\t\t// Be sure to pass something >0 for the first param or it will\n\t\t\t// return (and we never want this to return):\n\t\t\tMsgSleep(SLEEP_INTERVAL, WAIT_FOR_MESSAGES);\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// The script isn't persistent, so call OnExit handlers and terminate.\n\t\t\tg_script.ExitApp(exec_result == FAIL ? EXIT_ERROR : EXIT_EXIT);\n\t\t}\n\t}\n#ifndef _DEBUG\n\t__except (EXCEPTION_EXECUTE_HANDLER)\n\t{\n\t\tLPCTSTR msg;\n\t\tauto ecode = GetExceptionCode();\n\t\tswitch (ecode)\n\t\t{\n\t\t// Having specific messages for the most common exceptions seems worth the added code size.\n\t\t// The term \"stack overflow\" is not used because it is probably less easily understood by\n\t\t// the average user, and is not useful as a search term due to stackoverflow.com.\n\t\tcase EXCEPTION_STACK_OVERFLOW: msg = _T(\"Function recursion limit exceeded.\"); break;\n\t\tcase EXCEPTION_ACCESS_VIOLATION: msg = _T(\"Invalid memory read/write.\"); break;\n\t\tdefault: msg = _T(\"System exception 0x%X.\"); break;\n\t\t}\n\t\tTCHAR buf[127];\n\t\tsntprintf(buf, _countof(buf), msg, ecode);\n\t\tg_script.CriticalError(buf);\n\t\treturn ecode;\n\t}\n#endif \n\treturn 0;\n}\n"},"size":{"kind":"number","value":13826,"string":"13,826"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":307,"string":"307"},"avg_line_length":{"kind":"number","value":42.22149837133551,"string":"42.221498"},"max_line_length":{"kind":"number","value":189,"string":"189"},"alphanum_fraction":{"kind":"number","value":0.7320765919548761,"string":"0.732077"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11088,"cells":{"id":{"kind":"number","value":16077,"string":"16,077"},"file_name":{"kind":"string","value":"script_module.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_module.cpp"},"content":{"kind":"string","value":"#include \"stdafx.h\"\n#include \"script.h\"\n#include \"globaldata.h\"\n\n\nObject *ScriptModule::sPrototype;\n\n\nResultType ScriptModule::Invoke(IObject_Invoke_PARAMS_DECL)\n{\n\tauto var = aName ? mVars.Find(aName) : nullptr;\n\tif (!var && mIsBuiltinModule)\n\t\t// This is a slight hack to support built-in vars which haven't been referenced directly.\n\t\tvar = g_script.FindOrAddBuiltInVar(aName, true, nullptr);\n\tif (!var || !var->IsExported())\n\t\treturn ObjectBase::Invoke(IObject_Invoke_PARAMS);\n\n\tif (IS_INVOKE_SET && aParamCount == 1)\n\t\treturn var->Assign(*aParam[0]);\n\n\tvar->Get(aResultToken);\n\tif (aResultToken.Exited() || aParamCount == 0 && IS_INVOKE_GET)\n\t\treturn aResultToken.Result();\n\n\treturn Object::ApplyParams(aResultToken, aFlags, aParam, aParamCount);\n}\n\n\nResultType Script::ParseModuleDirective(LPCTSTR aName)\n{\n\tint at;\n\tif (mModules.Find(aName, &at))\n\t\treturn ScriptError(ERR_DUPLICATE_DECLARATION, aName);\n\t// TODO: Validate module names.\n\taName = SimpleHeap::Alloc(aName);\n\tauto mod = new ScriptModule(aName);\n\t// Let any previous #Warn settings carry over from the previous module, by default.\n\tmod->Warn_LocalSameAsGlobal = mCurrentModule->Warn_LocalSameAsGlobal;\n\tmod->Warn_Unreachable = mCurrentModule->Warn_Unreachable;\n\tmod->Warn_VarUnset = mCurrentModule->Warn_VarUnset;\n\tif (!mModules.Insert(mod, at))\n\t\treturn MemoryError();\n\tCloseCurrentModule();\n\tmCurrentModule = mod;\n\treturn CONDITION_TRUE;\n}\n\n\nResultType Script::ParseImportStatement(LPTSTR aBuf)\n{\n\taBuf = omit_leading_whitespace(aBuf);\n\tauto imp = new ScriptImport();\n\timp->names = SimpleHeap::Alloc(aBuf);\n\timp->mod = nullptr;\n\timp->line_number = mCombinedLineNumber;\n\timp->file_index = mCurrFileIndex;\n\timp->next = mCurrentModule->mImports;\n\tmCurrentModule->mImports = imp;\n\treturn OK;\n}\n\n\nVar *Script::FindImportedVar(LPCTSTR aVarName)\n{\n\tfor (auto imp = CurrentModule()->mImports; imp; imp = imp->next)\n\t{\n\t\tif (*imp->names == '*')\n\t\t{\n\t\t\tauto var = imp->mod->mVars.Find(aVarName);\n\t\t\tif (var && var->IsExported())\n\t\t\t\treturn var;\n\t\t}\n\t}\n\treturn nullptr;\n}\n\n\n// Add a new Var to the current module.\n// Raises an error if a conflicting declaration exists.\n// May use an existing Var if not previously marked as declared, such as if created by Export.\n// Caller provides persistent memory for aVarName.\nVar *Script::AddNewImportVar(LPTSTR aVarName)\n{\n\tint at;\n\tauto var = mCurrentModule->mVars.Find(aVarName, &at);\n\tif (var)\n\t{\n\t\t// Only declared, assigned or exported variables should exist at this point.\n\t\tif (var->IsDeclared() || var->IsAssignedSomewhere())\n\t\t{\n\t\t\tConflictingDeclarationError(_T(\"Import\"), var);\n\t\t\treturn nullptr;\n\t\t}\n\t\tvar->Scope() |= VAR_DECLARED;\n\t}\n\telse\n\t\tvar = new Var(aVarName, VAR_DECLARE_GLOBAL);\n\tif (!mCurrentModule->mVars.Insert(var, at))\n\t{\n\t\tdelete var;\n\t\tMemoryError();\n\t\treturn nullptr;\n\t}\n\treturn var;\n}\n\n\nResultType Script::ResolveImports()\n{\n\tfor (mCurrentModule = mLastModule; mCurrentModule; mCurrentModule = mCurrentModule->mPrev)\n\t{\n\t\tfor (auto imp = mCurrentModule->mImports; imp; imp = imp->next)\n\t\t{\n\t\t\tif (!imp->mod && !ResolveImports(*imp))\n\t\t\t\treturn FAIL;\n\t\t}\n\t}\n\treturn OK;\n}\n\n\nResultType Script::ResolveImports(ScriptImport &imp)\n{\n\t// Set early for code size, in case of error.\n\tmCurrLine = nullptr;\n\tmCombinedLineNumber = imp.line_number;\n\tmCurrFileIndex = imp.file_index;\n\n\tLPTSTR cp = imp.names, mod_name, var_name = nullptr;\n\tif (*cp == '{' || *cp == '*')\n\t{\n\t\tif (*cp == '{')\n\t\t\tcp = _tcschr(cp, '}'); // Should always be found due to GetLineContExpr().\n\t\tcp = omit_leading_whitespace(cp + 1);\n\t\tif (_tcsnicmp(cp, _T(\"From\"), 4) || !IS_SPACE_OR_TAB(cp[4]))\n\t\t\treturn ScriptError(_T(\"Invalid import\"), imp.names);\n\t\tcp = omit_leading_whitespace(cp + 5);\n\t\tmod_name = cp;\n\t}\n\telse\n\t{\n\t\tvar_name = mod_name = cp;\n\t\twhile (*cp && !IS_SPACE_OR_TAB(*cp)) ++cp;\n\t\tif (*cp)\n\t\t{\n\t\t\t*cp = '\\0';\n\t\t\tcp = omit_leading_whitespace(cp + 1);\n\t\t\tif (_tcsnicmp(cp, _T(\"as\"), 2) || !IS_SPACE_OR_TAB(cp[2]))\n\t\t\t\treturn ScriptError(_T(\"Invalid import\"), imp.names);\n\t\t\tvar_name = omit_leading_whitespace(cp + 3);\n\t\t}\n\t}\n\n\tint at;\n\tif ( !(imp.mod = mModules.Find(mod_name, &at)) )\n\t{\n\t\tif (auto path = FindLibraryFile(mod_name, _tcslen(mod_name), true))\n\t\t{\n\t\t\tauto cur_mod = mCurrentModule;\n\t\t\tauto last_mod = mLastModule;\n\t\t\tmLastModule = nullptr; // Start a new chain.\n\t\t\timp.mod = mCurrentModule = new ScriptModule(mod_name);\n\t\t\tif (!mModules.Insert(imp.mod, at))\n\t\t\t\treturn MemoryError();\n\t\t\tif (!LoadIncludedFile(path, false, false))\n\t\t\t\treturn FAIL;\n\t\t\tif (!CloseCurrentModule())\n\t\t\t\treturn FAIL;\n\t\t\tif (!ResolveImports()) // Resolve imports in all modules that were just included.\n\t\t\t\treturn FAIL;\n\t\t\timp.mod->mPrev = last_mod; // Join to previous chain.\n\t\t\tmCurrentModule = cur_mod;\n\t\t}\n\t\telse\n\t\t\treturn ScriptError(_T(\"Module not found\"), mod_name);\n\t}\n\n\tif (var_name)\n\t{\n\t\t// Do not reuse mSelf or a previous Var created by an import even if mod_name == var_name,\n\t\t// since the exported status of the Var (VAR_EXPORTED) shouldn't propagate between modules.\n\t\tauto var = AddNewImportVar(var_name);\n\t\tif (!var)\n\t\t\treturn FAIL;\n\t\tif (imp.mod->mSelf) // Default export.\n\t\t{\n\t\t\t// For code size, aliasing is used even for constants. For non-dynamic references to\n\t\t\t// constants, PreparseVarRefs() eliminates both the alias and the var reference itself.\n\t\t\tvar->UpdateAlias(imp.mod->mSelf);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tvar->Assign(imp.mod);\n\t\t\tvar->MakeReadOnly();\n\t\t}\n\t}\n\n\tif (*imp.names == '{')\n\t{\n\t\tfor (cp = imp.names + 1; *(cp = omit_leading_whitespace(cp)) != '}'; ++cp)\n\t\t{\n\t\t\tauto c = *(cp = find_identifier_end(var_name = mod_name = cp));\n\t\t\t*cp = '\\0';\n\t\t\twhile (IS_SPACE_OR_TAB(c)) c = *++cp; // Find next non-whitespace.\n\t\t\tauto exported = imp.mod->mVars.Find(mod_name);\n\t\t\tif (!exported)\n\t\t\t\treturn ScriptError(_T(\"No such export\"), mod_name);\n\t\t\tif (!_tcsnicmp(cp, _T(\"as\"), 2) && IS_SPACE_OR_TAB(cp[2]))\n\t\t\t{\n\t\t\t\tvar_name = omit_leading_whitespace(cp + 3);\n\t\t\t\tcp = find_identifier_end(var_name);\n\t\t\t\tc = *cp;\n\t\t\t\t*cp = '\\0';\n\t\t\t\twhile (IS_SPACE_OR_TAB(c)) c = *++cp; // Find next non-whitespace.\n\t\t\t}\n\t\t\tif (!(c == ',' || c == '}'))\n\t\t\t{\n\t\t\t\t*cp = c;\n\t\t\t\treturn ScriptError(_T(\"Invalid import\"), cp);\n\t\t\t}\n\t\t\tauto imported = AddNewImportVar(var_name);\n\t\t\tif (!imported)\n\t\t\t\treturn FAIL;\n\t\t\timported->UpdateAlias(exported); // See the other UpdateAlias call above for comments.\n\t\t\tif (c == '}')\n\t\t\t\tbreak;\n\t\t}\n\t}\n\n\treturn OK;\n}\n\n\nResultType Script::CloseCurrentModule()\n{\n\t// Terminate each module with RETURN so that all labels have a target and\n\t// all control flow statements that need it have a non-null mRelatedLine.\n\tif (!AddLine(ACT_EXIT))\n\t\treturn FAIL;\n\n\tmCurrentModule->mPrev = mLastModule;\n\tmLastModule = mCurrentModule;\n\n\tASSERT(!mCurrentModule->mFirstLine || mCurrentModule->mFirstLine == mFirstLine);\n\tmCurrentModule->mFirstLine = mFirstLine;\n\tmFirstLine = nullptr; // Start a new linked list of lines.\n\tmLastLine = nullptr;\n\tmLastLabel = nullptr; // Start a new linked list of labels.\n\treturn OK;\n}\n\n\nbool ScriptModule::HasFileIndex(FileIndexType aFile)\n{\n\tfor (int i = 0; i < mFilesCount; ++i)\n\t\tif (mFiles[i] == aFile)\n\t\t\treturn true;\n\treturn false;\n}\n\n\nResultType ScriptModule::AddFileIndex(FileIndexType aFile)\n{\n\tif (mFilesCount == mFilesCountMax)\n\t{\n\t\tauto new_size = mFilesCount ? mFilesCount * 2 : 8;\n\t\tauto new_files = (FileIndexType*)realloc(mFiles, new_size * sizeof(FileIndexType));\n\t\tif (!new_files)\n\t\t\treturn MemoryError();\n\t\tmFiles = new_files;\n\t\tmFilesCountMax = new_size;\n\t}\n\tmFiles[mFilesCount++] = aFile;\n\treturn OK;\n}\n\n\nIObject *ScriptModule::FindGlobalObject(LPCTSTR aName)\n{\n\tif (auto var = mVars.Find(aName))\n\t{\n\t\tASSERT(!var->IsVirtual());\n\t\treturn var->ToObject();\n\t}\n\treturn nullptr;\n}\n"},"size":{"kind":"number","value":7653,"string":"7,653"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":252,"string":"252"},"avg_line_length":{"kind":"number","value":27.607142857142858,"string":"27.607143"},"max_line_length":{"kind":"number","value":94,"string":"94"},"alphanum_fraction":{"kind":"number","value":0.6956698791909869,"string":"0.69567"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11089,"cells":{"id":{"kind":"number","value":16079,"string":"16,079"},"file_name":{"kind":"string","value":"window.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/window.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"window.h\"\n#include \"util.h\" // for strlcpy()\n#include \"application.h\" // for MsgSleep()\n#include \"psapi.h\" // for ahk_exe\n#include <dwmapi.h>\n#include \"script_gui.h\"\n\n\nHWND WinActivate(global_struct &aSettings, LPTSTR aTitle, LPTSTR aText, LPTSTR aExcludeTitle, LPTSTR aExcludeText\n\t, bool aFindLastMatch, HWND aAlreadyVisited[], int aAlreadyVisitedCount)\n{\n\tHWND target_window;\n\t// There are no checks for WinActivate(\"A\") or WinActivate() since WinExist() handles both\n\t// of those cases.\n\t// There's no attempt to check whether the current active window is a match, because the\n\t// established behaviour is to activate the top/bottom-most active window regardless, and\n\t// that seems more useful than ignoring the call.\n\tif ( !(target_window = WinExist(aSettings, aTitle, aText, aExcludeTitle, aExcludeText, aFindLastMatch\n\t\t, false, aAlreadyVisited, aAlreadyVisitedCount)) )\n\t\treturn NULL;\n\t// Above has ensured that target_window is non-NULL, that it is a valid window, and that\n\t// it is eligible due to g->DetectHiddenWindows being true or the window not being hidden\n\t// (or being one of the script's GUI windows).\n\tHWND activated = SetForegroundWindowEx(target_window);\n\t// Callers want the window found above, even if it isn't now active.\n\treturn target_window;\n}\n\n\n\nHWND AttemptSetForeground(HWND aTargetWindow, HWND aForeWindow)\n// Returns NULL if aTargetWindow or its owned-window couldn't be brought to the foreground.\n// Otherwise, on success, it returns either aTargetWindow or an HWND owned by aTargetWindow.\n{\n\t// Probably best not to trust its return value. It's been shown to be unreliable at times.\n\t// Example: I've confirmed that SetForegroundWindow() sometimes (perhaps about 10% of the time)\n\t// indicates failure even though it succeeds. So we specifically check to see if it worked,\n\t// which helps to avoid using the keystroke (2-alts) method, because that may disrupt the\n\t// desired state of the keys or disturb any menus that the user may have displayed.\n\t// Also: I think the 2-alts last-resort may fire when the system is lagging a bit\n\t// (i.e. a drive spinning up) and the window hasn't actually become active yet,\n\t// even though it will soon become active on its own. Also, SetForegroundWindow() sometimes\n\t// indicates failure even though it succeeded, usually because the window didn't become\n\t// active immediately -- perhaps because the system was under load -- but did soon become\n\t// active on its own (after, say, 50ms or so). UPDATE: If SetForegroundWindow() is called\n\t// on a hung window, at least when AttachThreadInput is in effect and that window has\n\t// a modal dialog (such as MSIE's find dialog), this call might never return, locking up\n\t// our thread. So now we do this fast-check for whether the window is hung first (and\n\t// this call is indeed very fast: its worst case is at least 30x faster than the worst-case\n\t// performance of the ABORT-IF-HUNG method used with SendMessageTimeout.\n\t// UPDATE for v1.0.42.03: To avoid a very rare crashing issue, IsWindowHung() is no longer called\n\t// here, but instead by our caller. Search on \"v1.0.42.03\" for more comments.\n\tBOOL result = SetForegroundWindow(aTargetWindow);\n\t// Note: Increasing the sleep time below did not help with occurrences of \"indicated success\n\t// even though it failed\", at least with metapad.exe being activated while command prompt\n\t// and/or AutoIt2's InputBox were active or present on the screen:\n\tSLEEP_WITHOUT_INTERRUPTION(SLEEP_INTERVAL); // Specify param so that it will try to specifically sleep that long.\n\tHWND new_fore_window = GetForegroundWindow();\n\tif (new_fore_window == aTargetWindow)\n\t\treturn aTargetWindow;\n\tif (new_fore_window != aForeWindow && aTargetWindow == GetWindow(new_fore_window, GW_OWNER))\n\t\t// The window we're trying to get to the foreground is the owner of the new foreground window.\n\t\t// This is considered to be a success because a window that owns other windows can never be\n\t\t// made the foreground window, at least if the windows it owns are visible.\n\t\treturn new_fore_window;\n\t// Otherwise, failure:\n\treturn NULL;\n}\n\n\n\nHWND SetForegroundWindowEx(HWND aTargetWindow, bool aBackgroundActivation)\n// Caller must have ensured that aTargetWindow is a valid window or NULL, since we\n// don't call IsWindow() here.\n{\n\tif (!aTargetWindow)\n\t\treturn NULL; // When called this way (as it is sometimes), do nothing.\n\n\t// v1.0.42.03: Calling IsWindowHung() once here rather than potentially more than once in AttemptSetForeground()\n\t// solves a crash that is not fully understood, nor is it easily reproduced (it occurs only in release mode,\n\t// not debug mode). It's likely a bug in the API's IsHungAppWindow(), but that is far from confirmed.\n\tDWORD target_thread = GetWindowThreadProcessId(aTargetWindow, NULL);\n\tif (target_thread != g_MainThreadID && IsWindowHung(aTargetWindow)) // Calls to IsWindowHung should probably be avoided if the window belongs to our thread. Relies upon short-circuit boolean order.\n\t\treturn NULL;\n\n\tHWND orig_foreground_wnd = GetForegroundWindow();\n\t// AutoIt3: If there is not any foreground window, then input focus is on the TaskBar.\n\t// MY: It is definitely possible for GetForegroundWindow() to return NULL, even on XP.\n\t// Lexikos: It can be easily reproduced by calling GetForegroundWindow() in a tight\n\t// loop on Windows 10 and switching windows with Alt+Esc. In such cases the taskbar\n\t// is definitely NOT active, and if our caller requested activation of the taskbar,\n\t// it should not be skipped just because !orig_foreground_wnd.\n\t// MSDN: \"The foreground window can be NULL in certain circumstances, such as when a\n\t// window is losing activation.\"\n\t//if (!orig_foreground_wnd)\n\t//\torig_foreground_wnd = FindWindow(_T(\"Shell_TrayWnd\"), NULL);\n\n\t// Fix for v1.1.28.02: Restore the window *before* checking if it is already active.\n\t// This was supposed to be done in v1.1.20, but was only done for WinTitle = \"A\".\n\t// See \"IsIconic\" in WinActivate() for comments.\n\tif (IsIconic(aTargetWindow) && !aBackgroundActivation)\n\t\t// This might never return if aTargetWindow is a hung window. But it seems better\n\t\t// to do it this way than to use the PostMessage() method, which might not work\n\t\t// reliably with apps that don't handle such messages in a standard way.\n\t\t// A minimized window must be restored or else SetForegroundWindow() always(?)\n\t\t// won't work on it. UPDATE: ShowWindowAsync() would prevent a hang, but\n\t\t// probably shouldn't use it because we rely on the fact that the message\n\t\t// has been acted on prior to trying to activate the window (and all Async()\n\t\t// does is post a message to its queue):\n\t\tShowWindow(aTargetWindow, SW_RESTORE);\n\n\tif (aTargetWindow == orig_foreground_wnd) // It's already the active window.\n\t\treturn aTargetWindow;\n\n\t// This causes more trouble than it's worth. In fact, the AutoIt author said that\n\t// he didn't think it even helped with the IE 5.5 related issue it was originally\n\t// intended for, so it seems a good idea to NOT to this, especially since I'm 80%\n\t// sure it messes up the Z-order in certain circumstances, causing an unexpected\n\t// window to pop to the foreground immediately after a modal dialog is dismissed:\n\t//BringWindowToTop(aTargetWindow); // AutoIt3: IE 5.5 related hack.\n\n\tHWND new_foreground_wnd;\n\n\tif (!g_WinActivateForce)\n\t\t// Try a simple approach first:\n#define IF_ATTEMPT_SET_FORE if (new_foreground_wnd = AttemptSetForeground(aTargetWindow, orig_foreground_wnd))\n\t\tIF_ATTEMPT_SET_FORE\n\t\t\treturn new_foreground_wnd;\n\t\t// Otherwise continue with the more drastic methods below.\n\n\t// MY: The AttachThreadInput method, when used by itself, seems to always\n\t// work the first time on my XP system, seemingly regardless of whether the\n\t// \"allow focus steal\" change has been made via SystemParametersInfo()\n\t// (but it seems a good idea to keep the SystemParametersInfo() in effect\n\t// in case Win2k or Win98 needs it, or in case it really does help in rare cases).\n\t// In many cases, this avoids the two SetForegroundWindow() attempts that\n\t// would otherwise be needed; and those two attempts cause some windows\n\t// to flash in the taskbar, such as Metapad and Excel (less frequently) whenever\n\t// you quickly activate another window after activating it first (e.g. via hotkeys).\n\t// So for now, it seems best just to use this method by itself. The\n\t// \"two-alts\" case never seems to fire on my system? Maybe it will\n\t// on Win98 sometimes.\n\t// Note: In addition to the \"taskbar button flashing\" annoyance mentioned above\n\t// any SetForegroundWindow() attempt made prior to the one below will,\n\t// as a side-effect, sometimes trigger the need for the \"two-alts\" case\n\t// below. So that's another reason to just keep it simple and do it this way\n\t// only.\n\n\tbool is_attached_my_to_fore = false, is_attached_fore_to_target = false;\n\tDWORD fore_thread;\n\tif (orig_foreground_wnd) // Might be NULL from above.\n\t{\n\t\t// Based on MSDN docs, these calls should always succeed due to the other\n\t\t// checks done above (e.g. that none of the HWND's are NULL):\n\t\tfore_thread = GetWindowThreadProcessId(orig_foreground_wnd, NULL);\n\n\t\t// MY: Normally, it's suggested that you only need to attach the thread of the\n\t\t// foreground window to our thread. However, I've confirmed that doing all three\n\t\t// attaches below makes the attempt much more likely to succeed. In fact, it\n\t\t// almost always succeeds whereas the one-attach method hardly ever succeeds the first\n\t\t// time (resulting in a flashing taskbar button due to having to invoke a second attempt)\n\t\t// when one window is quickly activated after another was just activated.\n\t\t// AutoIt3: Attach all our input threads, will cause SetForeground to work under 98/Me.\n\t\t// MSDN docs: The AttachThreadInput function fails if either of the specified threads\n\t\t// does not have a message queue (My: ok here, since any window's thread MUST have a\n\t\t// message queue). [It] also fails if a journal record hook is installed. ... Note\n\t\t// that key state, which can be ascertained by calls to the GetKeyState or\n\t\t// GetKeyboardState function, is reset after a call to AttachThreadInput. You cannot\n\t\t// attach a thread to a thread in another desktop. A thread cannot attach to itself.\n\t\t// Therefore, idAttachTo cannot equal idAttach. Update: It appears that of the three,\n\t\t// this first call does not offer any additional benefit, at least on XP, so not\n\t\t// using it for now:\n\t\t//if (g_MainThreadID != target_thread) // Don't attempt the call otherwise.\n\t\t//\tAttachThreadInput(g_MainThreadID, target_thread, TRUE);\n\t\tif (fore_thread && g_MainThreadID != fore_thread && !IsWindowHung(orig_foreground_wnd))\n\t\t\tis_attached_my_to_fore = AttachThreadInput(g_MainThreadID, fore_thread, TRUE) != 0;\n\t\tif (fore_thread && target_thread && fore_thread != target_thread) // IsWindowHung(aTargetWindow) was called earlier.\n\t\t\tis_attached_fore_to_target = AttachThreadInput(fore_thread, target_thread, TRUE) != 0;\n\t}\n\n\tstatic bool sTriedKeyUp = false;\n\n\t// The log showed that it never seemed to need more than two tries. But there's\n\t// not much harm in trying a few extra times. The number of tries needed might\n\t// vary depending on how fast the CPU is:\n\tfor (int i = 0; i < 5; ++i)\n\t{\n\t\tif (i == (int)g_WinActivateForce && !sTriedKeyUp) // At least one attempt failed this time, and Alt-up hasn't been tried since the process started.\n\t\t{\n\t\t\tsTriedKeyUp = true;\n\t\t\t// Lexikos: Recent testing on Windows 10.0.19555 indicated that sending Alt-up was just as effective\n\t\t\t// as sending double-Alt (the second Alt was probably just to counter the first one), but it should\n\t\t\t// have lower risk of side-effects since there's no key-down. One observable side-effect is that\n\t\t\t// if the user happens to be holding Alt (and it wasn't suppressed due to being part of a hotkey),\n\t\t\t// the window menu might light up for an instant before the window loses focus. However, this also\n\t\t\t// means that if the system is set to hide the menu mnemonics (underlines), that actually happens\n\t\t\t// whereas they would normally be left visible because the window didn't catch Alt-up.\n\t\t\t// The Alt-up seems to be effective at allowing ALL subsequent SetForegroundWindow() calls to succeed\n\t\t\t// even without AttachThreadInput(), and even if Alt-up is just sent at program startup, so it's only\n\t\t\t// done once per process. In other words, this should stop subsequent calls from causing taskbar\n\t\t\t// buttons to flash. This doesn't seem to be necessary if AttachThreadInput() is used, so it's not\n\t\t\t// done for #WinActivateForce unless there's been one failed attempt.\n\t\t\t// KEY_BLOCK_THIS is used so that if this or any other scripts (running on v1.1.27+) have a hook\n\t\t\t// installed, the Alt-up will be suppressed to further reduce the risk of side-effects. Testing\n\t\t\t// showed that the suppressed event worked just as well (in theory, because the system's handling\n\t\t\t// of it isn't and can't be suppressed).\n\t\t\tKeyEvent(KEYUP, VK_MENU, 0, NULL, false, KEY_BLOCK_THIS);\n\t\t}\n\t\tIF_ATTEMPT_SET_FORE\n\t\t\tbreak;\n\t}\n\n\t// I decided to avoid the quick minimize + restore method of activation. It's\n\t// not that much more effective (if at all), and there are some significant\n\t// disadvantages:\n\t// - This call will often hang our thread if aTargetWindow is a hung window: ShowWindow(aTargetWindow, SW_MINIMIZE)\n\t// - Using SW_FORCEMINIMIZE instead of SW_MINIMIZE has at least one (and probably more)\n\t// side effect: When the window is restored, at least via SW_RESTORE, it is no longer\n\t// maximized even if it was before the minimize. So don't use it.\n\tif (!new_foreground_wnd) // Not successful yet.\n\t{\n\t\t// Some apps may be intentionally blocking us by having called the API function\n\t\t// LockSetForegroundWindow(), for which MSDN says \"The system automatically enables\n\t\t// calls to SetForegroundWindow if the user presses the ALT key or takes some action\n\t\t// that causes the system itself to change the foreground window (for example,\n\t\t// clicking a background window).\" Also, it's probably best to avoid doing\n\t\t// the 2-alts method except as a last resort, because I think it may mess up\n\t\t// the state of menus the user had displayed. And of course if the foreground\n\t\t// app has special handling for alt-key events, it might get confused.\n\t\t// My original note: \"The 2-alts case seems to mess up on rare occasions,\n\t\t// perhaps due to menu weirdness triggered by the alt key.\"\n\t\t// AutoIt3: OK, this is not funny - bring out the extreme measures (usually for 2000/XP).\n\t\t// Simulate two single ALT keystrokes. UPDATE: This hardly ever succeeds. Usually when\n\t\t// it fails, the foreground window is NULL (none). I'm going to try an Win-tab instead,\n\t\t// which selects a task bar button. This seems less invasive than doing an alt-tab\n\t\t// because not only doesn't it activate some other window first, it also doesn't appear\n\t\t// to change the Z-order, which is good because we don't want the alt-tab order\n\t\t// that the user sees to be affected by this. UPDATE: Win-tab isn't doing it, so try\n\t\t// Alt-tab. Alt-tab doesn't do it either. The window itself (metapad.exe is the only\n\t\t// culprit window I've found so far) seems to resist being brought to the foreground,\n\t\t// but later, after the hotkey is released, it can be. So perhaps this is being\n\t\t// caused by the fact that the user has keys held down (logically or physically?)\n\t\t// Releasing those keys with a key-up event might help, so try that sometime:\n\t\tKeyEvent(KEYDOWNANDUP, VK_MENU);\n\t\tKeyEvent(KEYDOWNANDUP, VK_MENU);\n\t\t//KeyEvent(KEYDOWN, VK_LWIN);\n\t\t//KeyEvent(KEYDOWN, VK_TAB);\n\t\t//KeyEvent(KEYUP, VK_TAB);\n\t\t//KeyEvent(KEYUP, VK_LWIN);\n\t\t//KeyEvent(KEYDOWN, VK_MENU);\n\t\t//KeyEvent(KEYDOWN, VK_TAB);\n\t\t//KeyEvent(KEYUP, VK_TAB);\n\t\t//KeyEvent(KEYUP, VK_MENU);\n\t\t// Also replacing \"2-alts\" with \"alt-tab\" below, for now:\n\n\t\tnew_foreground_wnd = AttemptSetForeground(aTargetWindow, orig_foreground_wnd);\n\t} // if()\n\n\t// Very important to detach any threads whose inputs were attached above,\n\t// prior to returning, otherwise the next attempt to attach thread inputs\n\t// for these particular windows may result in a hung thread or other\n\t// undesirable effect:\n\tif (is_attached_my_to_fore)\n\t\tAttachThreadInput(g_MainThreadID, fore_thread, FALSE);\n\tif (is_attached_fore_to_target)\n\t\tAttachThreadInput(fore_thread, target_thread, FALSE);\n\n\t// Finally. This one works, solving the problem of the MessageBox window\n\t// having the input focus and being the foreground window, but not actually\n\t// being visible (even though IsVisible() and IsIconic() say it is)! It may\n\t// help with other conditions under which this function would otherwise fail.\n\t// Here's the way the repeat the failure to test how the absence of this line\n\t// affects things, at least on my XP SP1 system:\n\t// y::MsgBox, test\n\t// #e::(some hotkey that activates Windows Explorer)\n\t// Now: Activate explorer with the hotkey, then invoke the MsgBox. It will\n\t// usually be activated but invisible. Also: Whenever this invisible problem\n\t// is about to occur, with or without this fix, it appears that the OS's z-order\n\t// is a bit messed up, because when you dismiss the MessageBox, an unexpected\n\t// window (probably the one two levels down) becomes active rather than the\n\t// window that's only 1 level down in the z-order:\n\tif (new_foreground_wnd && !aBackgroundActivation) // success.\n\t{\n\t\t// Even though this is already done for the IE 5.5 \"hack\" above, must at\n\t\t// a minimum do it here: The above one may be optional, not sure (safest\n\t\t// to leave it unless someone can test with IE 5.5).\n\t\t// Note: I suspect the two lines below achieve the same thing. They may\n\t\t// even be functionally identical. UPDATE: This may no longer be needed\n\t\t// now that the first BringWindowToTop(), above, has been disabled due to\n\t\t// its causing more trouble than it's worth. But seems safer to leave\n\t\t// this one enabled in case it does resolve IE 5.5 related issues and\n\t\t// possible other issues:\n\t\tBringWindowToTop(aTargetWindow);\n\t\t//SetWindowPos(aTargetWindow, HWND_TOP, 0, 0, 0, 0, SWP_NOMOVE | SWP_NOSIZE);\n\t}\n\treturn new_foreground_wnd; // Return this rather than aTargetWindow because it's more appropriate.\n}\n\n\n\nHWND WinClose(global_struct &aSettings, LPCTSTR aTitle, LPCTSTR aText, int aTimeToWaitForClose\n\t, LPCTSTR aExcludeTitle, LPCTSTR aExcludeText, bool aKillIfHung)\n// Return the HWND of any found-window to the caller so that it has the option of waiting\n// for it to become an invalid (closed) window.\n{\n\tHWND target_window;\n\tIF_USE_FOREGROUND_WINDOW(aSettings.DetectHiddenWindows, aTitle, aText, aExcludeTitle, aExcludeText)\n\t\t// Close topmost (better than !F4 since that uses the alt key, effectively resetting\n\t\t// its status to UP if it was down before. Use WM_CLOSE rather than WM_EXIT because\n\t\t// I think that's what Alt-F4 sends (and otherwise, app may quit without offering\n\t\t// a chance to save).\n\t\t// DON'T DISPLAY a MsgBox (e.g. debugging) before trying to close foreground window.\n\t\t// Otherwise, it may close the owner of the dialog window (this app), perhaps due to\n\t\t// split-second timing issues.\n\telse if (*aTitle || *aText || *aExcludeTitle || *aExcludeText)\n\t{\n\t\t// Since EnumWindows() is *not* guaranteed to start proceed in z-order from topmost to\n\t\t// bottommost (though it almost certainly does), do it this way to ensure that the\n\t\t// topmost window is closed in preference to any other windows with the same <aTitle>\n\t\t// and <aText>:\n\t\tif ( !(target_window = WinActive(aSettings, aTitle, aText, aExcludeTitle, aExcludeText)) )\n\t\t\tif ( !(target_window = WinExist(aSettings, aTitle, aText, aExcludeTitle, aExcludeText)) )\n\t\t\t\treturn NULL;\n\t}\n\telse\n\t\ttarget_window = GetValidLastUsedWindow(aSettings);\n\n\treturn target_window ? WinClose(target_window, aTimeToWaitForClose, aKillIfHung) : NULL;\n}\n\n\n\nHWND WinClose(HWND aWnd, int aTimeToWaitForClose, bool aKillIfHung)\n{\n\tif (aKillIfHung) // This part is based on the AutoIt3 source.\n\t\t// Update: Another reason not to wait a long time with the below is that WinKill\n\t\t// is normally only used when the target window is suspected of being hung. It\n\t\t// seems bad to wait something like 2 seconds in such a case, when the caller\n\t\t// probably already knows it's hung.\n\t\t// Obsolete in light of dedicated hook thread: Because this app is much more sensitive to being\n\t\t// in a \"not-pumping-messages\" state, due to the keyboard & mouse hooks, it seems better to wait\n\t\t// for only 200 ms (e.g. in case the user is gaming and there's a script\n\t\t// running in the background that uses WinKill, we don't want key and mouse events\n\t\t// to freeze for a long time).\n\t\tUtil_WinKill(aWnd);\n\telse // Don't kill.\n\t\t// SC_CLOSE is the same as clicking a window's \"X\"(close) button or using Alt-F4.\n\t\t// Although it's a more friendly way to close windows than WM_CLOSE (and thus\n\t\t// avoids incompatibilities with apps such as MS Visual C++), apps that\n\t\t// have disabled Alt-F4 processing will not be successfully closed. It seems\n\t\t// best not to send both SC_CLOSE and WM_CLOSE because some apps with an \n\t\t// \"Unsaved. Are you sure?\" type dialog might close down completely rather than\n\t\t// waiting for the user to confirm. Anyway, it's extremely rare for a window\n\t\t// not to respond to Alt-F4 (though it is possible that it handles Alt-F4 in a\n\t\t// non-standard way, i.e. that sending SC_CLOSE equivalent to Alt-F4\n\t\t// for windows that handle Alt-F4 manually?) But on the upside, this is nicer\n\t\t// for apps that upon receiving Alt-F4 do some behavior other than closing, such\n\t\t// as minimizing to the tray. Such apps might shut down entirely if they received\n\t\t// a true WM_CLOSE, which is probably not what the user would want.\n\t\t// Update: Switched back to using WM_CLOSE so that instances of AutoHotkey\n\t\t// can be terminated via another instances use of the WinClose command:\n\t\t//PostMessage(aWnd, WM_SYSCOMMAND, SC_CLOSE, 0);\n\t\tPostMessage(aWnd, WM_CLOSE, 0, 0);\n\n\tif (aTimeToWaitForClose < 0)\n\t\taTimeToWaitForClose = 0;\n\tif (!aTimeToWaitForClose)\n\t\treturn aWnd; // v1.0.30: EnumParentActUponAll() relies on the ability to do no delay at all.\n\n\t// Slight delay. Might help avoid user having to modify script to use WinWaitClose()\n\t// in many cases. UPDATE: But this does a Sleep(0), which won't yield the remainder\n\t// of our thread's timeslice unless there's another app trying to use 100% of the CPU?\n\t// So, in reality it really doesn't accomplish anything because the window we just\n\t// closed won't get any CPU time (unless, perhaps, it receives the close message in\n\t// time to ask the OS for us to yield the timeslice). Perhaps some finer tuning\n\t// of this can be done in the future. UPDATE: Testing of WinActivate, which also\n\t// uses this to do a Sleep(0), reveals that it may in fact help even when the CPU\n\t// isn't under load. Perhaps this is because upon Sleep(0), the OS runs the\n\t// WindowProc's of windows that have messages waiting for them so that appropriate\n\t// action can be taken (which may often be nearly instantaneous, perhaps under\n\t// 1ms for a Window to be logically destroyed even if it hasn't physically been\n\t// removed from the screen?) prior to returning the CPU to our thread:\n\tDWORD start_time = GetTickCount(); // Before doing any MsgSleeps, set this.\n //MsgSleep(0); // Always do one small one, see above comments.\n\t// UPDATE: It seems better just to always do one unspecified-interval sleep\n\t// rather than MsgSleep(0), which often returns immediately, probably having\n\t// no effect.\n\n\t// Remember that once the first call to MsgSleep() is done, a new hotkey subroutine\n\t// may fire and suspend what we're doing here. Such a subroutine might also overwrite\n\t// the values our params, some of which may be in the deref buffer. So be sure not\n\t// to refer to those strings once MsgSleep() has been done, below:\n\n\t// This is the same basic code used for WinWaitClose and such:\n\tfor (;;)\n\t{\n\t\t// Seems best to always do the first one regardless of the value \n\t\t// of aTimeToWaitForClose:\n\t\tMsgSleep(INTERVAL_UNSPECIFIED);\n\t\tif (!IsWindow(aWnd)) // It's gone, so we're done.\n\t\t\treturn aWnd;\n\t\t// Must cast to int or any negative result will be lost due to DWORD type:\n\t\tif ((int)(aTimeToWaitForClose - (GetTickCount() - start_time)) <= SLEEP_INTERVAL_HALF)\n\t\t\tbreak;\n\t\t\t// Last param 0 because we don't want it to restore the\n\t\t\t// current active window after the time expires (in case\n\t\t\t// it's suspended). INTERVAL_UNSPECIFIED performs better.\n\t}\n\treturn aWnd; // Done waiting.\n}\n\n\n\t\nHWND WinActive(global_struct &aSettings, LPCTSTR aTitle, LPCTSTR aText, LPCTSTR aExcludeTitle, LPCTSTR aExcludeText\n\t, bool aUpdateLastUsed)\n// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.\n// In addition, it must not change the value of anything in aSettings except when aUpdateLastUsed==true.\n{\n\tHWND target_window;\n\tif (USE_FOREGROUND_WINDOW(aTitle, aText, aExcludeTitle, aExcludeText))\n\t{\n\t\t// User asked us if the \"active\" window is active, which is true if it's not a\n\t\t// hidden window, or if DetectHiddenWindows is ON:\n\t\tSET_TARGET_TO_ALLOWABLE_FOREGROUND(aSettings.DetectHiddenWindows)\n\t\t#define UPDATE_AND_RETURN_LAST_USED_WINDOW(hwnd) \\\n\t\t{\\\n\t\t\tif (aUpdateLastUsed && hwnd)\\\n\t\t\t\taSettings.hWndLastUsed = hwnd;\\\n\t\t\treturn hwnd;\\\n\t\t}\n\t\tUPDATE_AND_RETURN_LAST_USED_WINDOW(target_window)\n\t}\n\n\tHWND fore_win = GetForegroundWindow();\n\tif (!fore_win)\n\t\treturn NULL;\n\n\tif (!(*aTitle || *aText || *aExcludeTitle || *aExcludeText)) // Use the \"last found\" window.\n\t\treturn (fore_win == GetValidLastUsedWindow(aSettings)) ? fore_win : NULL;\n\n\t// Only after the above check should the below be done. This is because \"IfWinActive\" (with no params)\n\t// should be \"true\" if one of the script's GUI windows is active:\n\tif (!aSettings.DetectWindow(fore_win)) // In this case, the caller's window can't be active.\n\t\treturn NULL;\n\n\tWindowSearch ws;\n\tws.SetCandidate(fore_win);\n\n\tif (ws.SetCriteria(aSettings, aTitle, aText, aExcludeTitle, aExcludeText) && ws.IsMatch()) // aSettings.DetectHiddenWindows was already checked above.\n\t\tUPDATE_AND_RETURN_LAST_USED_WINDOW(fore_win) // This also does a \"return\".\n\telse // If the line above didn't return, indicate that the specified window is not active.\n\t\treturn NULL;\n}\n\n\n\nHWND WinExist(global_struct &aSettings, LPCTSTR aTitle, LPCTSTR aText, LPCTSTR aExcludeTitle, LPCTSTR aExcludeText\n\t, bool aFindLastMatch, bool aUpdateLastUsed, HWND aAlreadyVisited[], int aAlreadyVisitedCount)\n// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.\n// In addition, it must not change the value of anything in aSettings except when aUpdateLastUsed==true.\n{\n\tHWND target_window;\n\tif (USE_FOREGROUND_WINDOW(aTitle, aText, aExcludeTitle, aExcludeText))\n\t{\n\t\t// User asked us if the \"active\" window exists, which is true if it's not a\n\t\t// hidden window or DetectHiddenWindows is ON:\n\t\tSET_TARGET_TO_ALLOWABLE_FOREGROUND(aSettings.DetectHiddenWindows)\n\t\t// Updating LastUsed to be hwnd even if it's NULL seems best for consistency?\n\t\t// UPDATE: No, it's more flexible not to never set it to NULL, because there\n\t\t// will be times when the old value is still useful:\n\t\tUPDATE_AND_RETURN_LAST_USED_WINDOW(target_window);\n\t}\n\n\tif (!(*aTitle || *aText || *aExcludeTitle || *aExcludeText))\n\t\t// User passed no params, so use the window most recently found by WinExist().\n\t\t// It's correct to do this even in this function because it's called by\n\t\t// WINWAITCLOSE specifically to discover if the Last-Used window still exists.\n\t\treturn GetValidLastUsedWindow(aSettings);\n\n\tWindowSearch ws;\n\tif (!ws.SetCriteria(aSettings, aTitle, aText, aExcludeTitle, aExcludeText)) // No match is possible with these criteria.\n\t\treturn NULL;\n\n\tws.mFindLastMatch = aFindLastMatch;\n\tws.mAlreadyVisited = aAlreadyVisited;\n\tws.mAlreadyVisitedCount = aAlreadyVisitedCount;\n\n\tif (ws.mCriteria & CRITERION_ID) // \"ahk_id\" will be satisfied if that HWND still exists and is valid.\n\t{\n\t\t// Explicitly allow HWND_BROADCAST for all commands that use WinExist (which is just about all\n\t\t// window commands), even though it's only valid with BIF_PostSendMessage().\n\t\t// This is because HWND_BROADCAST is probably never used as the HWND for a real window, so there\n\t\t// should be no danger of any reasonable script ever passing that value in as a real target window,\n\t\t// which should thus minimize the chance of a crash due to calling various API functions\n\t\t// with invalid window handles.\n\t\tif ( ws.mCriterionHwnd != HWND_BROADCAST // It's not exempt from the other checks on the two lines below.\n\t\t\t&& (!IsWindow(ws.mCriterionHwnd) // And it's either not a valid window...\n\t\t\t\t// ...or the window is not detectible (in v1.0.40.05, child windows are detectible even if hidden):\n\t\t\t\t|| !(aSettings.DetectWindow(ws.mCriterionHwnd)\n\t\t\t\t\t|| (GetWindowLong(ws.mCriterionHwnd, GWL_STYLE) & WS_CHILD))) )\n\t\t\treturn NULL;\n\n\t\t// Otherwise, the window is valid and detectible.\n\t\tws.SetCandidate(ws.mCriterionHwnd);\n\t\tif (!ws.IsMatch()) // Checks if it matches any other criteria: WinTitle, WinText, ExcludeTitle, and anything in the aAlreadyVisited list.\n\t\t\treturn NULL;\n\t\t//else fall through to the section below, since ws.mFoundCount and ws.mFoundParent were set by ws.IsMatch().\n\t}\n\telse // aWinTitle doesn't start with \"ahk_id\". Try to find a matching window.\n\t\tEnumWindows(EnumParentFind, (LPARAM)&ws);\n\n\tUPDATE_AND_RETURN_LAST_USED_WINDOW(ws.mFoundParent) // This also does a \"return\".\n}\n\n\n\nHWND GetValidLastUsedWindow(global_struct &aSettings)\n// If the last found window is one of the script's own GUI windows, it is considered valid even if\n// DetectHiddenWindows is ON. Note that this exemption does not apply to things like \"IfWinExist,\n// My Gui Title\", \"WinActivate, ahk_id <gui id>\", etc.\n// A GUI window can become the last found window while DetectHiddenWindows is ON in two ways:\n// Gui +LastFound\n// The launch of a GUI thread that explicitly set the last found window to be that GUI window.\n{\n\tif (!aSettings.hWndLastUsed || !IsWindow(aSettings.hWndLastUsed))\n\t\treturn NULL;\n\tif ( aSettings.DetectWindow(aSettings.hWndLastUsed)\n\t\t|| (GetWindowLong(aSettings.hWndLastUsed, GWL_STYLE) & WS_CHILD) ) // v1.0.40.05: Child windows (via ahk_id) are always detectible.\n\t\treturn aSettings.hWndLastUsed;\n\t// Otherwise, DetectHiddenWindows is OFF and the window is not visible. Return NULL\n\t// unless this is a GUI window belonging to this particular script, in which case\n\t// the setting of DetectHiddenWindows is ignored (as of v1.0.25.13).\n\treturn GuiType::FindGui(aSettings.hWndLastUsed) ? aSettings.hWndLastUsed : NULL;\n}\n\n\n\nBOOL CALLBACK EnumParentFind(HWND aWnd, LPARAM lParam)\n// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.\n// To continue enumeration, the function must return TRUE; to stop enumeration, it must return FALSE. \n// It's a little strange, but I think EnumWindows() returns FALSE when the callback stopped\n// the enumeration prematurely by returning false to its caller. Otherwise (the enumeration went\n// through every window), it returns TRUE:\n{\n\tWindowSearch &ws = *(WindowSearch *)lParam; // For performance and convenience.\n\tif (!ws.mSettings->DetectWindow(aWnd)) // Skip windows the script isn't supposed to detect.\n\t\treturn TRUE;\n\tws.SetCandidate(aWnd);\n\t// If this window doesn't match, continue searching for more windows (via TRUE). Likewise, if\n\t// mFindLastMatch is true, continue searching even if this window is a match. Otherwise, this\n\t// first match is the one that's desired so stop here:\n\treturn ws.IsMatch() ? ws.mFindLastMatch : TRUE;\n}\n\n\n\nBOOL CALLBACK EnumChildFind(HWND aWnd, LPARAM lParam)\n// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.\n// Although this function could be rolled into a generalized version of the EnumWindowsProc(),\n// it will perform better this way because there's less checking required and no mode/flag indicator\n// is needed inside lParam to indicate which struct element should be searched for. In addition,\n// it's more comprehensible this way. lParam is a pointer to the struct rather than just a\n// string because we want to give back the HWND of any matching window.\n{\n\t// Since WinText and ExcludeText are seldom used in typical scripts, the following buffer\n\t// is put on the stack here rather than on our callers (inside the WindowSearch object),\n\t// which should help conserve stack space on average. Can't use the ws.mCandidateTitle\n\t// buffer because ws.mFindLastMatch might be true, in which case the original title must\n\t// be preserved.\n\tTCHAR win_text[WINDOW_TEXT_SIZE];\n\tWindowSearch &ws = *(WindowSearch *)lParam; // For performance and convenience.\n\n\tif (!(ws.mSettings->DetectHiddenText || IsWindowVisible(aWnd))) // This text element should not be detectible by the script.\n\t\treturn TRUE; // Skip this child and keep enumerating to try to find a match among the other children.\n\n\t// The below was formerly outsourced to the following function, but since it is only called from here,\n\t// it has been moved inline:\n\t// int GetWindowTextByTitleMatchMode(HWND aWnd, LPTSTR aBuf = NULL, int aBufSize = 0)\n\tint text_length = ws.mSettings->TitleFindFast ? GetWindowText(aWnd, win_text, _countof(win_text))\n\t\t: GetWindowTextTimeout(aWnd, win_text, _countof(win_text)); // The slower method that is able to get text from more types of controls (e.g. large edit controls).\n\t// Older idea that for the above that was not adopted:\n\t// Only if GetWindowText() gets 0 length would we try the other method (and of course, don't bother\n\t// using GetWindowTextTimeout() at all if \"fast\" mode is in effect). The problem with this is that\n\t// many controls always return 0 length regardless of which method is used, so this would slow things\n\t// down a little (but not too badly since GetWindowText() is so much faster than GetWindowTextTimeout()).\n\t// Another potential problem is that some controls may return less text, or different text, when used\n\t// with the fast mode vs. the slow mode (unverified). So it seems best NOT to do this and stick with\n\t// the simple approach above.\n\tif (!text_length) // It has no text (or failure to fetch it).\n\t\t*win_text = '\\0';\n\n\t// For compatibility with AutoIt v2, strstr() is always used for control/child text elements.\n\n\t// EXCLUDE-TEXT: The following check takes precedence over the next, so it's done first:\n\tif (*ws.mCriterionExcludeText) // For performance, avoid doing the checks below when blank.\n\t{\n\t\tif (ws.mSettings->TitleMatchMode == FIND_REGEX)\n\t\t{\n\t\t\tif (RegExMatch(win_text, ws.mCriterionExcludeText))\n\t\t\t{\n\t\t\t\tws.mFoundChild = NULL; // In case a previous child window matched.\n\t\t\t\treturn FALSE; // Parent can't be a match, so stop searching its children.\n\t\t\t}\n\t\t}\n\t\telse // For backward compatibility, all modes other than RegEx behave as follows.\n\t\t\tif (_tcsstr(win_text, ws.mCriterionExcludeText))\n\t\t\t{\n\t\t\t\t// Since this child window contains the specified ExcludeText anywhere inside its text,\n\t\t\t\t// the parent window is always a non-match.\n\t\t\t\tws.mFoundChild = NULL; // In case a previous child window matched.\n\t\t\t\treturn FALSE; // Parent can't be a match, so stop searching its children.\n\t\t\t}\n\t}\n\n\tif (!ws.mFoundChild) // No matching child window found yet.\n\t{\n\t\t// WIN-TEXT:\n\t\tif (!*ws.mCriterionText) // Match always found in this case. This check is for performance: it avoids doing the checks below when not needed, especially RegEx. Note: It's possible for mCriterionText to be blank, at least when mCriterionExcludeText isn't blank.\n\t\t{\n\t\t\tws.mFoundChild = aWnd;\n\t\t\t// Don't do the following since it makes ExcludeText ineffective for any control after the\n\t\t\t// first matching control (which might simply be the first control if WinText is blank):\n\t\t\t//return FALSE; // Match found, so stop searching.\n\t\t}\n\t\telse if (ws.mSettings->TitleMatchMode == FIND_REGEX)\n\t\t{\n\t\t\tif (RegExMatch(win_text, ws.mCriterionText)) // Match found.\n\t\t\t\tws.mFoundChild = aWnd;\n\t\t}\n\t\telse // For backward compatibility, all modes other than RegEx behave as follows.\n\t\t\tif (_tcsstr(win_text, ws.mCriterionText)) // Match found.\n\t\t\t\tws.mFoundChild = aWnd;\n\n\t\tif (ws.mFoundChild && !*ws.mCriterionExcludeText)\n\t\t\treturn FALSE; // Match found and no ExcludeText to evaluate against later controls, so stop searching.\n\t}\n\n\t// UPDATE to the below: The MSDN docs state that EnumChildWindows() already handles the\n\t// recursion for us: \"If a child window has created child windows of its own,\n\t// EnumChildWindows() enumerates those windows as well.\"\n\t// Mostly obsolete comments: Since this child doesn't match, make sure none of its\n\t// children (recursive) match prior to continuing the original enumeration. We don't\n\t// discard the return value from EnumChildWindows() because it's FALSE in two cases:\n\t// 1) The given HWND has no children.\n\t// 2) The given EnumChildProc() stopped prematurely rather than enumerating all the windows.\n\t// and there's no way to distinguish between the two cases without using the\n\t// struct's hwnd because GetLastError() seems to return ERROR_SUCCESS in both\n\t// cases.\n\t//EnumChildWindows(aWnd, EnumChildFind, lParam);\n\t// If matching HWND still hasn't been found, return TRUE to keep searching:\n\t//return ws.mFoundChild == NULL;\n\n\treturn TRUE; // Keep searching.\n}\n\n\n\nFResult StatusBarUtil(HWND aWindow, int aPartNumber, StrRet *aRetVal\n\t, LPCTSTR aTextToWaitFor, int aWaitTime, int aCheckInterval)\n// aBarHwnd is allowed to be NULL because in that case, the caller wants us to set aresultToken appropriately.\n{\n\tHWND aBarHwnd = ControlExist(aWindow, _T(\"msctls_statusbar321\"));\n\tif (!aBarHwnd)\n\t\treturn FError(ERR_NO_STATUSBAR, nullptr, ErrorPrototype::Target);\n\n\tif (aCheckInterval < 1)\n\t\taCheckInterval = SB_DEFAULT_CHECK_INTERVAL; // Caller relies on us doing this.\n\tif (aPartNumber < 1)\n\t\taPartNumber = 1; // Caller relies on us to set default in this case.\n\n\t// Must have at least one of these. UPDATE: We want to allow this so that the command can be\n\t// used to wait for the status bar text to become blank:\n\t//if (aTextToWaitFor && !*aTextToWaitFor) return OK;\n\n\t// Whenever using SendMessageTimeout(), our app will be unresponsive until\n\t// the call returns, since our message loop isn't running. In addition,\n\t// if the keyboard or mouse hook is installed, the input events will lag during\n\t// this call. So keep the timeout value fairly short. Update for v1.0.24:\n\t// There have been at least two reports of the StatusBarWait command ending\n\t// prematurely with an ErrorLevel of 2. The most likely culprit is the below,\n\t// which has now been increased from 100 to 2000:\n\t#define SB_TIMEOUT 2000\n\n\tHANDLE handle;\n\tLPVOID remote_buf;\n\tLRESULT part_count; // The number of parts this status bar has.\n\tif (!SendMessageTimeout(aBarHwnd, SB_GETPARTS, 0, 0, SMTO_ABORTIFHUNG, SB_TIMEOUT, (PDWORD_PTR)&part_count)) // It failed or timed out.\n\t\treturn FR_E_WIN32;\n\tif (aPartNumber > part_count)\n\t\treturn FR_E_ARG(aTextToWaitFor ? 2 : 0);\n\tif ( !(remote_buf = AllocInterProcMem(handle, _TSIZE(WINDOW_TEXT_SIZE + 1), aBarHwnd)) )\n\t\treturn FR_E_WIN32;\n\n\tTCHAR local_buf[WINDOW_TEXT_SIZE + 1]; // The local counterpart to the buf allocated remotely above.\n\n\tDWORD_PTR result, start_time;\n\t--aPartNumber; // Convert to zero-based for use below.\n\n\t// Always do the first iteration so that at least one check is done. Also, start_time is initialized\n\t// unconditionally in the name of code size reduction (it's a low overhead call):\n\tfor (*local_buf = '\\0', start_time = GetTickCount();;)\n\t{\n\t\t// MSDN recommends always checking the length of the bar text. It implies that the length is\n\t\t// unrestricted, so a crash due to buffer overflow could otherwise occur:\n\t\tif (SendMessageTimeout(aBarHwnd, SB_GETTEXTLENGTH, aPartNumber, 0, SMTO_ABORTIFHUNG, SB_TIMEOUT, &result))\n\t\t{\n\t\t\t// Testing confirms that LOWORD(result) [the length] does not include the zero terminator.\n\t\t\tif (LOWORD(result) > WINDOW_TEXT_SIZE) // Text would be too large (very unlikely but good to check for security).\n\t\t\t\tbreak; // Abort the operation.\n\t\t\t// Retrieve the bar's text:\n\t\t\tif (SendMessageTimeout(aBarHwnd, SB_GETTEXT, aPartNumber, (LPARAM)remote_buf, SMTO_ABORTIFHUNG, SB_TIMEOUT, &result))\n\t\t\t{\n\t\t\t\tif (!ReadProcessMemory(handle, remote_buf, local_buf, _TSIZE(LOWORD(result) + 1), NULL)) // +1 to include the terminator (verified: length doesn't include zero terminator).\n\t\t\t\t{\n\t\t\t\t\t// Fairly critical error (though rare) so seems best to abort.\n\t\t\t\t\t*local_buf = '\\0'; // In case it changed the buf before failing.\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\t// Check if the retrieved text matches the caller's criteria. In addition to\n\t\t\t\t// normal/intuitive matching, a match is also achieved if both are empty strings.\n\t\t\t\t// In fact, IsTextMatch() yields \"true\" whenever aTextToWaitFor is the empty string:\n\t\t\t\tif (aTextToWaitFor && IsTextMatch(local_buf, aTextToWaitFor))\n\t\t\t\t\treturn TRUE; // Indicate \"match found\".\n\t\t\t}\n\t\t\t//else SB_GETTEXT msg timed out or failed. Leave local_buf unaltered. See comment below.\n\t\t}\n\t\t//else SB_GETTEXTLENGTH msg timed out or failed. For v1.0.37, continue to wait (if other checks\n\t\t// say its okay below) rather than aborting the operation. This should help prevent an abort\n\t\t// when the target window (or the entire system) is unresponsive for a long time, perhaps due\n\t\t// to a drive spinning up, etc.\n\n\t\t// When aTextToWaitFor is NULL, the caller wanted a single check only (no waiting).\n\t\tif (!aTextToWaitFor)\n\t\t\tbreak;\n\n\t\t// Since above didn't break, we're in \"wait\" mode (more than one iteration).\n\t\t// In the following, must cast to int or any negative result will be lost due to DWORD type.\n\t\t// Note: A negative aWaitTime means we're waiting indefinitely for a match to appear.\n\t\t// Don't continue to wait if the status bar no longer exists (which is usually caused\n\t\t// by the parent window having been destroyed).\n\t\tif ( IsWindow(aBarHwnd)\n\t\t\t&& (aWaitTime < 0 || (int)(aWaitTime - (GetTickCount() - start_time)) > SLEEP_INTERVAL_HALF) )\n\t\t\tMsgSleep(aCheckInterval);\n\t\telse // Timed out.\n\t\t\treturn FALSE; // Indicate \"timeout\".\n\t} // for()\n\n\tFreeInterProcMem(handle, remote_buf);\n\t// Consider this to be always successful, even if aBarHwnd == NULL.\n\tif (aRetVal && !aRetVal->Copy(local_buf))\n\t\treturn FR_E_OUTOFMEM;\n\treturn OK;\n}\n\n\n\nHWND ControlExist(HWND aParentWindow, LPCTSTR aClassNameAndNum)\n{\n\tif (!aParentWindow || !aClassNameAndNum || !*aClassNameAndNum)\n\t\treturn NULL;\n\n\tWindowSearch ws;\n\tbool is_class_name = _istdigit(aClassNameAndNum[_tcslen(aClassNameAndNum) - 1]);\n\n\tif (is_class_name)\n\t{\n\t\t// Tell EnumControlFind() to search by Class+Num. Don't call ws.SetCriteria() because\n\t\t// that has special handling for ahk_id, ahk_class, etc. in the first parameter.\n\t\tws.mCriterionClass = aClassNameAndNum;\n\t\tws.mCriterionText = _T(\"\");\n\t}\n\telse // Tell EnumControlFind() to search the control's text.\n\t{\n\t\tws.mCriterionClass = _T(\"\");\n\t\tws.mCriterionText = aClassNameAndNum;\n\t}\n\n\tEnumChildWindows(aParentWindow, EnumControlFind, (LPARAM)&ws); // mFoundChild was initialized by the constructor.\n\n\tif (is_class_name && !ws.mFoundChild)\n\t{\n\t\t// To reduce problems with ambiguity (a class name and number of one control happens\n\t\t// to match the title/text of another control), search again only after the search\n\t\t// for the ClassNameAndNum didn't turn up anything.\n\t\t// Tell EnumControlFind() to search the control's text.\n\t\tws.mCriterionClass = _T(\"\");\n\t\tws.mCriterionText = aClassNameAndNum;\n\t\tEnumChildWindows(aParentWindow, EnumControlFind, (LPARAM)&ws); // ws.mFoundChild is already initialized to NULL due to the above check.\n\t}\n\n\treturn ws.mFoundChild;\n}\n\n\n\nBOOL CALLBACK EnumControlFind(HWND aWnd, LPARAM lParam)\n{\n\tWindowSearch &ws = *(WindowSearch *)lParam; // For performance and convenience.\n\tif (*ws.mCriterionClass) // Caller told us to search by class name and number.\n\t{\n\t\tint length = GetClassName(aWnd, ws.mCandidateTitle, WINDOW_CLASS_SIZE); // Restrict the length to a small fraction of the buffer's size (also serves to leave room to append the sequence number).\n\t\t// Below: i.e. this control's title (e.g. List) in contained entirely\n\t\t// within the leading part of the user specified title (e.g. ListBox).\n\t\t// Even though this is incorrect, the appending of the sequence number\n\t\t// in the second comparison will weed out any false matches.\n\t\t// Note: since some controls end in a number (e.g. SysListView32),\n\t\t// it would not be easy to parse out the user's sequence number to\n\t\t// simplify/accelerate the search here. So instead, use a method\n\t\t// more certain to work even though it's a little ugly. It's also\n\t\t// necessary to do this in a way functionally identical to the below\n\t\t// so that Window Spy's sequence numbers match the ones generated here:\n\t\t// Concerning strnicmp(), see lstrcmpi note below for why a locale-insensitive match isn't done instead.\n\t\tif (length && !_tcsnicmp(ws.mCriterionClass, ws.mCandidateTitle, length)) // Preliminary match of base class name.\n\t\t{\n\t\t\t// mAlreadyVisitedCount was initialized to zero by WindowSearch's constructor. It is used\n\t\t\t// to accumulate how many quasi-matches on this class have been found so far. Also,\n\t\t\t// comparing ws.mAlreadyVisitedCount to atoi(ws.mCriterionClass + length) would not be\n\t\t\t// the same as the below examples such as the following:\n\t\t\t// Say the ClassNN being searched for is List01 (where List0 is the class name and 1\n\t\t\t// is the sequence number). If a class called \"List\" exists in the parent window, it\n\t\t\t// would be found above as a preliminary match. The below would copy \"1\" into the buffer,\n\t\t\t// which is correctly deemed not to match \"01\". By contrast, the atoi() method would give\n\t\t\t// the wrong result because the two numbers are numerically equal.\n\t\t\t_itot(++ws.mAlreadyVisitedCount, ws.mCandidateTitle, 10); // Overwrite the buffer to contain only the count.\n\t\t\t// lstrcmpi() is not used: 1) avoids breaking existing scripts; 2) provides consistent behavior\n\t\t\t// across multiple locales:\n\t\t\tif (!_tcsicmp(ws.mCandidateTitle, ws.mCriterionClass + length)) // The counts match too, so it's a full match.\n\t\t\t{\n\t\t\t\tws.mFoundChild = aWnd; // Save this in here for return to the caller.\n\t\t\t\treturn FALSE; // stop the enumeration.\n\t\t\t}\n\t\t}\n\t}\n\telse // Caller told us to search by the text of the control (e.g. the text printed on a button)\n\t{\n\t\t// Use GetWindowText() rather than GetWindowTextTimeout() because we don't want to find\n\t\t// the name accidentally in the vast amount of text present in some edit controls (e.g.\n\t\t// if the script's source code is open for editing in notepad, GetWindowText() would\n\t\t// likely find an unwanted match for just about anything). In addition,\n\t\t// GetWindowText() is much faster. Update: Yes, it seems better not to use\n\t\t// GetWindowTextByTitleMatchMode() in this case, since control names tend to be so\n\t\t// short (i.e. they would otherwise be very likely to be undesirably found in any large\n\t\t// edit controls the target window happens to own). Update: Changed from strstr()\n\t\t// to strncmp() for greater selectivity. Even with this degree of selectivity, it's\n\t\t// still possible to have ambiguous situations where a control can't be found due\n\t\t// to its title being entirely contained within that of another (e.g. a button\n\t\t// with title \"Connect\" would be found in the title of a button \"Connect All\").\n\t\t// The only way to address that would be to insist on an entire title match, but\n\t\t// that might be tedious if the title of the control is very long. As alleviation,\n\t\t// the class name + seq. number method above can often be used instead in cases\n\t\t// of such ambiguity. Update: Using IsTextMatch() now so that user-specified\n\t\t// TitleMatchMode will be in effect for this also. Also, it's case sensitivity\n\t\t// helps increase selectivity, which is helpful due to how common short or ambiguous\n\t\t// control names tend to be:\n\t\tGetWindowText(aWnd, ws.mCandidateTitle, _countof(ws.mCandidateTitle));\n\t\tif (IsTextMatch(ws.mCandidateTitle, ws.mCriterionText))\n\t\t{\n\t\t\tws.mFoundChild = aWnd; // save this in here for return to the caller.\n\t\t\treturn FALSE;\n\t\t}\n\t}\n\t// Note: The MSDN docs state that EnumChildWindows already handles the\n\t// recursion for us: \"If a child window has created child windows of its own,\n\t// EnumChildWindows() enumerates those windows as well.\"\n\treturn TRUE; // Keep searching.\n}\n\n\n\nint MsgBox(int aValue)\n{\n\tTCHAR str[128];\n\tsntprintf(str, _countof(str), _T(\"Value = %d (0x%X)\"), aValue, aValue);\n\treturn MsgBox(str);\n}\n\n\n\nint MsgBox(LPCTSTR aText, UINT uType, LPCTSTR aTitle, double aTimeout, HWND aOwner)\n// Returns 0 if the attempt failed because of too many existing MessageBox windows,\n// or if MessageBox() itself failed.\n// MB_SETFOREGROUND or some similar setting appears to dismiss some types of screen savers (if active).\n// However, it doesn't undo monitor low-power mode.\n{\n\t// Set the below globals so that any WM_TIMER messages dispatched by this call to\n\t// MsgBox() (which may result in a recursive call back to us) know not to display\n\t// any more MsgBoxes:\n\tif (g_nMessageBoxes >= MAX_MSGBOXES)\n\t\treturn AHK_TOO_MANY_MSGBOXES;\n\n\tif (!aText) // In case the caller explicitly called it with a NULL, overriding the default.\n\t\taText = (uType & 0xF) ? _T(\"\") : _T(\"Press OK to continue.\"); // Use default text only if OK is the only button.\n\tif (!aTitle) // Caller omitted it or explicitly requested the default.\n\t\taTitle = g_script.DefaultDialogTitle();\n\n\t// It doesn't feel safe to modify the contents of the caller's aText and aTitle,\n\t// even if the caller were to tell us it is modifiable. This is because the text\n\t// might be the actual contents of a variable, which we wouldn't want to truncate,\n\t// even temporarily, since other hotkeys can fire while this hotkey subroutine is\n\t// suspended, and those subroutines may refer to the contents of this (now-altered)\n\t// variable. In addition, the text may reside in the clipboard's locked memory\n\t// area, and altering that might result in the clipboard's contents changing\n\t// when MsgSleep() closes the clipboard for us (after we display our dialog here).\n\t// Even though testing reveals that the contents aren't altered (somehow), it\n\t// seems best to have our own local, limited length versions here:\n\t// Note: 8000 chars is about the max you could ever fit on-screen at 1024x768 on some\n\t// XP systems, but it will hold much more before refusing to display at all (i.e.\n\t// MessageBox() returning failure), perhaps about 150K:\n\tTCHAR text[MSGBOX_TEXT_SIZE];\n\tTCHAR title[DIALOG_TITLE_SIZE];\n\ttcslcpy(text, aText, _countof(text));\n\ttcslcpy(title, aTitle, _countof(title));\n\n\tuType |= MB_SETFOREGROUND; // Always do these so that caller doesn't have to specify.\n\n\t// In the below, make the MsgBox owned by the topmost window rather than our main\n\t// window, in case there's another modal dialog already displayed. The forces the\n\t// user to deal with the modal dialogs starting with the most recent one, which\n\t// is what we want. Otherwise, if a middle dialog was dismissed, it probably\n\t// won't be able to return which button was pressed to its original caller.\n\t// UPDATE: It looks like these modal dialogs can't own other modal dialogs,\n\t// so disabling this:\n\t/*\n\tHWND topmost = GetTopWindow(g_hWnd);\n\tif (!topmost) // It has no child windows.\n\t\ttopmost = g_hWnd;\n\t*/\n\n\t// Unhide the main window, but have it minimized. This creates a task\n\t// bar button so that it's easier the user to remember that a dialog\n\t// is open and waiting (there are probably better ways to handle\n\t// this whole thing). UPDATE: This isn't done because it seems\n\t// best not to have the main window be inaccessible until the\n\t// dialogs are dismissed (in case ever want to use it to display\n\t// status info, etc). It seems that MessageBoxes get their own\n\t// task bar button when they're not AppModal, which is one of the\n\t// main things I wanted, so that's good too):\n//\tif (!IsWindowVisible(g_hWnd) || !IsIconic(g_hWnd))\n//\t\tShowWindowAsync(g_hWnd, SW_SHOWMINIMIZED);\n\n\t/*\n\tIf the script contains a line such as \"#y::MsgBox, test\", and a hotkey is used\n\tto activate Windows Explorer and another hotkey is then used to invoke a MsgBox,\n\tthat MsgBox will be psuedo-minimized or invisible, even though it does have the\n\tinput focus. This attempt to fix it didn't work, so something is probably checking\n\tthe physical key state of LWIN/RWIN and seeing that they're down:\n\tmodLR_type modLR_now = GetModifierLRState();\n\tmodLR_type win_keys_down = modLR_now & (MOD_LWIN | MOD_RWIN);\n\tif (win_keys_down)\n\t\tSetModifierLRStateSpecific(win_keys_down, modLR_now, KEYUP);\n\t*/\n\n\t// Note: Even though when multiple messageboxes exist, they might be\n\t// destroyed via a direct call to their WindowProc from our message pump's\n\t// DispatchMessage, or that of another MessageBox's message pump, it\n\t// appears that MessageBox() is designed to be called recursively like\n\t// this, since it always returns the proper result for the button on the\n\t// actual MessageBox it originally invoked. In other words, if a bunch\n\t// of Messageboxes are displayed, and this user dismisses an older\n\t// one prior to dealing with a newer one, all the MessageBox()\n\t// return values will still wind up being correct anyway, at least\n\t// on XP. The only downside to the way this is designed is that\n\t// the keyboard can't be used to navigate the buttons on older\n\t// messageboxes (only the most recent one). This is probably because\n\t// the message pump of MessageBox() isn't designed to properly dispatch\n\t// keyboard messages to other MessageBox window instances. I tried\n\t// to fix that by making our main message pump handle all messages\n\t// for all dialogs, but that turns out to be pretty complicated, so\n\t// I abandoned it for now.\n\n\t// Note: It appears that MessageBox windows, and perhaps all modal dialogs in general,\n\t// cannot own other windows. That's too bad because it would have allowed each new\n\t// MsgBox window to be owned by any previously existing one, so that the user would\n\t// be forced to close them in order if they were APPL_MODAL. But it's not too big\n\t// an issue since the only disadvantage is that the keyboard can't be use to\n\t// to navigate in MessageBoxes other than the most recent. And it's actually better\n\t// the way it is now in the sense that the user can dismiss the messageboxes out of\n\t// order, which might (in rare cases) be desirable.\n\n\tif (aTimeout > 2147483) // This is approximately the max number of seconds that SetTimer can handle.\n\t\taTimeout = 2147483;\n\tif (aTimeout < 0) // But it can be equal to zero to indicate no timeout at all.\n\t\taTimeout = 0.1; // A value that might cue the user that something is wrong.\n\t// For the above:\n\t// MsgBox's smart comma handling will usually prevent negatives due to the fact that it considers\n\t// a negative to be part of the text param. But if it does happen, timeout after a short time,\n\t// which may signal the user that the script passed a bad parameter.\n\n\t// v1.0.33: The following is a workaround for the fact that an MsgBox with only an OK button\n\t// doesn't obey EndDialog()'s parameter:\n\tg->DialogHWND = NULL;\n\tg->MsgBoxTimedOut = false;\n\n\t// At this point, we know a dialog will be displayed. See macro's comments for details:\n\tDIALOG_PREP // Must be done prior to POST_AHK_DIALOG() below.\n\tPOST_AHK_DIALOG((DWORD)(aTimeout * 1000))\n\n\t++g_nMessageBoxes; // This value will also be used as the Timer ID if there's a timeout.\n\tint result = MessageBox(aOwner, text, title, uType);\n\t--g_nMessageBoxes;\n\t// Above's use of aOwner: MsgBox, FileSelect, and other dialogs seem to consider aOwner to be NULL\n\t// when aOwner is minimized or hidden.\n\n\tDIALOG_END\n\n\t// If there's a timer, kill it for performance reasons since it's no longer needed.\n\t// Actually, this isn't easy to do because we don't know what the HWND of the MsgBox\n\t// window was, so don't bother:\n\t//if (aTimeout != 0.0)\n\t//\tKillTimer(...);\n\n//\tif (!g_nMessageBoxes)\n//\t\tShowWindowAsync(g_hWnd, SW_HIDE); // Hide the main window if it no longer has any child windows.\n//\telse\n\n\t// This is done so that the next message box of ours will be brought to the foreground,\n\t// to remind the user that they're still out there waiting, and for convenience.\n\t// Update: It seems bad to do this in cases where the user intentionally wants the older\n\t// messageboxes left in the background, to deal with them later. So, in those cases,\n\t// we might be doing more harm than good because the user's foreground window would\n\t// be intrusively changed by this:\n\t//WinActivateOurTopDialog();\n\n\t// The following comment is apparently not always true -- sometimes the AHK_TIMEOUT from\n\t// EndDialog() is received correctly. But I haven't discovered the circumstances of how\n\t// and why the behavior varies:\n\t// Unfortunately, it appears that MessageBox() will return zero rather\n\t// than AHK_TIMEOUT that was specified in EndDialog() at least under WinXP.\n\tif (g->MsgBoxTimedOut || (!result && aTimeout > 0)) // v1.0.33: Added g->MsgBoxTimedOut, see comment higher above.\n\t\t// Assume it timed out rather than failed, since failure should be VERY rare.\n\t\tresult = AHK_TIMEOUT;\n\t// else let the caller handle the display of the error message because only it knows\n\t// whether to also tell the user something like \"the script will not continue\".\n\treturn result;\n}\n\n\n\nHWND FindOurTopDialog()\n// Returns the HWND of our topmost MsgBox or FileOpen dialog (and perhaps other types of modal\n// dialogs if they are of class #32770) even if it wasn't successfully brought to\n// the foreground here.\n// Using Enum() seems to be the only easy way to do this, since these modal MessageBoxes are\n// *owned*, not children of the main window. There doesn't appear to be any easier way to\n// find out which windows another window owns. GetTopWindow(), GetActiveWindow(), and GetWindow()\n// do not work for this purpose. And using FindWindow() discouraged because it can hang\n// in certain circumstances (Enum is probably just as fast anyway).\n{\n\t// The return value of EnumWindows() is probably a raw indicator of success or failure,\n\t// not whether the Enum found something or continued all the way through all windows.\n\t// So don't bother using it.\n\tpid_and_hwnd_type pid_and_hwnd;\n\tpid_and_hwnd.pid = GetCurrentProcessId();\n\tpid_and_hwnd.hwnd = NULL; // Init. Called function will set this for us if it finds a match.\n\tEnumWindows(EnumDialog, (LPARAM)&pid_and_hwnd);\n\treturn pid_and_hwnd.hwnd;\n}\n\n\n\nBOOL CALLBACK EnumDialog(HWND aWnd, LPARAM lParam)\n// lParam should be a pointer to a ProcessId (ProcessIds are always non-zero?)\n// To continue enumeration, the function must return TRUE; to stop enumeration, it must return FALSE. \n{\n\tpid_and_hwnd_type &pah = *(pid_and_hwnd_type *)lParam; // For performance and convenience.\n\tif (!lParam || !pah.pid) return FALSE;\n\tDWORD pid;\n\tGetWindowThreadProcessId(aWnd, &pid);\n\tif (pid == pah.pid)\n\t{\n\t\t// This checks for the standard dialog window class (#32770), for windows created via MessageBox(),\n\t\t// GetOpenFileName(), and other things that use modal dialogs:\n\t\tif (IsWindowStandardDialog(aWnd))\n\t\t{\n\t\t\tpah.hwnd = aWnd; // An output value for the caller.\n\t\t\treturn FALSE; // We're done.\n\t\t}\n\t}\n\treturn TRUE; // Keep searching.\n}\n\n\n\nHWND GetNonChildParent(HWND aWnd)\n// Returns the first ancestor of aWnd that isn't itself a child. aWnd itself is returned if\n// it is not a child. Returns NULL only if aWnd is NULL. Also, it should always succeed\n// based on the axiom that any window with the WS_CHILD style (aka WS_CHILDWINDOW) must have\n// a non-child ancestor somewhere up the line.\n// This function doesn't do anything special with owned vs. unowned windows. Despite what MSDN\n// says, GetParent() does not return the owner window, at least in some cases on Windows XP\n// (e.g. BulletProof FTP Server). It returns NULL instead. In any case, it seems best not to\n// worry about owner windows for this function's caller (MouseGetPos()), since it might be\n// desirable for that command to return the owner window even though it can't actually be\n// activated. This is because attempts to activate an owner window should automatically cause\n// the OS to activate the topmost owned window instead. In addition, the owner window may\n// contain the actual title or text that the user is interested in. UPDATE: Due to the fact\n// that this function retrieves the first parent that's not a child window, it's likely that\n// that window isn't its owner anyway (since the owner problem usually applies to a parent\n// window being owned by some controlling window behind it).\n{\n\tif (!aWnd) return aWnd;\n\tHWND parent, parent_prev;\n\tfor (parent_prev = aWnd; ; parent_prev = parent)\n\t{\n\t\tif (!(GetWindowLong(parent_prev, GWL_STYLE) & WS_CHILD)) // Found the first non-child parent, so return it.\n\t\t\treturn parent_prev;\n\t\t// Because Windows 95 doesn't support GetAncestor(), we'll use GetParent() instead:\n\t\tif ( !(parent = GetParent(parent_prev)) )\n\t\t\treturn parent_prev; // This will return aWnd if aWnd has no parents.\n\t}\n}\n\n\n\nHWND GetTopChild(HWND aParent)\n{\n\tif (!aParent) return aParent;\n\tHWND hwnd_top, next_top;\n\t// Get the topmost window of the topmost window of...\n\t// i.e. Since child windows can also have children, we keep going until\n\t// we reach the \"last topmost\" window:\n\tfor (hwnd_top = GetTopWindow(aParent)\n\t\t; hwnd_top && (next_top = GetTopWindow(hwnd_top))\n\t\t; hwnd_top = next_top);\n\n\t//if (!hwnd_top)\n\t//{\n\t//\tMsgBox(\"no top\");\n\t//\treturn FAIL;\n\t//}\n\t//else\n\t//{\n\t//\t//if (GetTopWindow(hwnd_top))\n\t//\t//\thwnd_top = GetTopWindow(hwnd_top);\n\t//\tchar class_name[64];\n\t//\tGetClassName(next_top, class_name, sizeof(class_name));\n\t//\tMsgBox(class_name);\n\t//}\n\n\treturn hwnd_top ? hwnd_top : aParent; // Caller relies on us never returning NULL if aParent is non-NULL.\n}\n\n\n\nbool IsWindowHung(HWND aWnd)\n{\n\tif (!aWnd) return false;\n\n\t// OLD, SLOWER METHOD:\n\t// Don't want to use a long delay because then our messages wouldn't get processed\n\t// in a timely fashion. But I'm not entirely sure if the 10ms delay used below\n\t// is even used by the function in this case? Also, the docs aren't clear on whether\n\t// the function returns success or failure if the window is hung (probably failure).\n\t// If failure, perhaps you have to call GetLastError() to determine whether it failed\n\t// due to being hung or some other reason? Does the output param dwResult have any\n\t// useful info in this case? I expect what will happen is that in most cases, the OS\n\t// will already know that the window is hung. However, if the window just became hung\n\t// in the last 5 seconds, I think it may take the remainder of the 5 seconds for the OS\n\t// to notice it. However, allowing it the option of sleeping up to 5 seconds seems\n\t// really bad, since keyboard and mouse input would probably be frozen (actually it\n\t// would just be really laggy because the OS would bypass the hook during that time).\n\t// So some compromise value seems in order. 500ms seems about right. UPDATE: Some\n\t// windows might need longer than 500ms because their threads are engaged in\n\t// heavy operations. Since this method is only used as a fallback method now,\n\t// it seems best to give them the full 5000ms default, which is what (all?) Windows\n\t// OSes use as a cutoff to determine whether a window is \"not responding\":\n\tDWORD_PTR dwResult;\n\t#define Slow_IsWindowHung !SendMessageTimeout(aWnd, WM_NULL, 0, 0, SMTO_ABORTIFHUNG, 5000, &dwResult)\n\n\t// NEW, FASTER METHOD:\n\t// This newer method's worst-case performance is at least 30x faster than the worst-case\n\t// performance of the old method that uses SendMessageTimeout().\n\t// And an even worse case can be envisioned which makes the use of this method\n\t// even more compelling: If the OS considers a window NOT to be hung, but the\n\t// window's message pump is sluggish about responding to the SendMessageTimeout() (perhaps\n\t// taking 2000ms or more to respond due to heavy disk I/O or other activity), the old method\n\t// will take several seconds to return, causing mouse and keyboard lag if our hook(s)\n\t// are installed; not to mention making our app's windows, tray menu, and other GUI controls\n\t// unresponsive during that time). But I believe in this case the new method will return\n\t// instantly, since the OS has been keeping track in the background, and can tell us\n\t// immediately that the window isn't hung.\n\t// Here are some seemingly contradictory statements uttered by MSDN. Perhaps they're\n\t// not contradictory if the first sentence really means \"by a different thread of the same\n\t// process\":\n\t// \"If the specified window was created by a different thread, the system switches to that\n\t// thread and calls the appropriate window procedure. Messages sent between threads are\n\t// processed only when the receiving thread executes message retrieval code. The sending\n\t// thread is blocked until the receiving thread processes the message.\"\n\n\t// The use of IsHungAppWindow() (supported under Win2k+) is discouraged by MS,\n\t// but it's useful to prevent the script from getting hung when it tries to do something\n\t// to a hung window.\n\ttypedef BOOL (WINAPI *MyIsHungAppWindow)(HWND);\n\tstatic MyIsHungAppWindow IsHungAppWindow = (MyIsHungAppWindow)GetProcAddress(GetModuleHandle(_T(\"user32\"))\n\t\t, \"IsHungAppWindow\");\n\treturn IsHungAppWindow ? IsHungAppWindow(aWnd) : Slow_IsWindowHung;\n}\n\n\n\nbool IsWindowCloaked(HWND aWnd)\n{\n\tint cloaked = 0;\n\tconst int DWMWA_CLOAKED = 14; // Work around SDK troubles.\n\tauto result = DwmGetWindowAttribute(aWnd, DWMWA_CLOAKED, &cloaked, sizeof(cloaked));\n\treturn SUCCEEDED(result) && cloaked; // Result is \"invalid parameter\" on Windows 7.\n}\n\n\n\nbool ScriptThreadSettings::DetectWindow(HWND aWnd)\n{\n\treturn DetectHiddenWindows || (IsWindowVisible(aWnd) && !IsWindowCloaked(aWnd));\n}\n\n\n\nbool IsWindowStandardDialog(HWND aWnd)\n{\n\t// This only checks for the standard dialog window class (#32770), which is enough\n\t// for our purposes, although dialogs in general can have other window classes.\n\treturn (LPTSTR)(ULONG_PTR)GetClassLong(aWnd, GCW_ATOM) == WC_DIALOG;\n}\n\n\n\nint GetWindowTextTimeout(HWND aWnd, LPTSTR aBuf, INT_PTR aBufSize, UINT aTimeout)\n// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.\n// aBufSize is an int so that any negative values passed in from caller are not lost.\n// Returns the length of what would be copied (not including the zero terminator).\n// In addition, if aBuf is not NULL, the window text is copied into aBuf (not to exceed aBufSize).\n// AutoIt3 author indicates that using WM_GETTEXT vs. GetWindowText() sometimes yields more text.\n// Perhaps this is because GetWindowText() has built-in protection against hung windows and\n// thus isn't actually sending WM_GETTEXT. The method here is hopefully the best of both worlds\n// (protection against hung windows causing our thread to hang, and getting more text).\n// Another tidbit from MSDN about SendMessage() that might be of use here sometime:\n// \"However, the sending thread will process incoming nonqueued (those sent directly to a window\n// procedure) messages while waiting for its message to be processed. To prevent this, use\n// SendMessageTimeout with SMTO_BLOCK set.\" Currently not using SMTO_BLOCK because it\n// doesn't seem necessary.\n// Update: GetWindowText() is so much faster than SendMessage() and SendMessageTimeout(), at\n// least on XP, so GetWindowTextTimeout() should probably only be used when getting the max amount\n// of text is important (e.g. this function can fetch the text in a RichEdit20A control and\n// other edit controls, whereas GetWindowText() doesn't). This function is used to implement\n// things like WinGetText and ControlGetText, in which getting the maximum amount and types\n// of text is more important than performance.\n{\n\tif (!aWnd || (aBuf && aBufSize < 1)) // No HWND or no room left in buffer (some callers rely on this check).\n\t\treturn 0; // v1.0.40.04: Fixed to return 0 rather than setting aBuf to NULL and continuing (callers don't want that).\n\n\tLRESULT result, length;\n\tif (aBuf)\n\t{\n\t\t*aBuf = '\\0'; // Init just to get it out of the way in case of early return/error.\n\t\tif (aBufSize == 1) // Room only for the terminator, so go no further (some callers rely on this check).\n\t\t\treturn 0;\n\n\t\t// Below demonstrated that GetWindowText() is dramatically faster than either SendMessage()\n\t\t// or SendMessageTimeout() (noticeably faster when you have hotkeys that activate\n\t\t// windows, or toggle between two windows):\n\t\t//return GetWindowText(aWnd, aBuf, aBufSize);\n\t\t//return (int)SendMessage(aWnd, WM_GETTEXT, (WPARAM)aBufSize, (LPARAM)aBuf);\n\n\t\t// Don't bother calling IsWindowHung() because the below call will return\n\t\t// nearly instantly if the OS already \"knows\" that the target window has\n\t\t// be unresponsive for 5 seconds or so (i.e. it keeps track of such things\n\t\t// on an ongoing basis, at least XP seems to).\n\t\tresult = SendMessageTimeout(aWnd, WM_GETTEXT, (WPARAM)aBufSize, (LPARAM)aBuf\n\t\t\t, SMTO_ABORTIFHUNG, aTimeout, (PDWORD_PTR) &length);\n\t\tif (length >= aBufSize) // Happens sometimes (at least ==aBufSize) for apps that wrongly include the terminator in the reported length.\n\t\t\tlength = aBufSize - 1; // Override.\n\n\t\t// v1.0.40.04: The following check was added because when the text is too large to to fit in the\n\t\t// buffer, the OS (or at least certain applications such as AIM) return a length that *includes*\n\t\t// the zero terminator, violating the documented behavior of WM_GETTEXT. In case the returned\n\t\t// length is too long by 1 (or even more than 1), calculate the length explicitly by checking if\n\t\t// there's another terminator to the left of the indicated length. The following loop\n\t\t// is used in lieu of strlen() for performance reasons (because sometimes the text is huge).\n\t\t// It assumes that there will be no more than one additional terminator to the left of the\n\t\t// indicated length, which so far seems to be true:\n\t\tfor (LPTSTR cp = aBuf + length; cp >= aBuf; --cp)\n\t\t{\n\t\t\tif (!*cp)\n\t\t\t{\n\t\t\t\t// Keep going to the left until the last consecutive terminator is found.\n\t\t\t\t// Necessary for AIM when compiled in release mode (but not in debug mode\n\t\t\t\t// for some reason!):\n\t\t\t\tfor (; cp > aBuf && !cp[-1]; --cp); // Self-contained loop. Verified correct.\n\t\t\t\tlength = cp - aBuf;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\t// If the above loop didn't \"break\", a terminator wasn't found.\n\t\t// Terminate explicitly because MSDN docs aren't clear that it will always be terminated automatically.\n\t\t// Update: This also protects against misbehaving apps that might handle the WM_GETTEXT message\n\t\t// rather than passing it to DefWindowProc() but that don't terminate the buffer. This has been\n\t\t// confirmed to be necessary at least for AIM when aBufSize==1 (although 1 is no longer possible due\n\t\t// to a check that has been added further above):\n\t\taBuf[length] = '\\0';\n\t}\n\telse\n\t{\n\t\tresult = SendMessageTimeout(aWnd, WM_GETTEXTLENGTH, 0, 0, SMTO_ABORTIFHUNG, aTimeout, (PDWORD_PTR)&length);\n\t\t// The following can be temporarily uncommented out to demonstrate how some apps such as AIM's\n\t\t// write-an-instant-message window have some controls that respond to WM_GETTEXTLENGTH with a\n\t\t// length that's completely different than the length with which they respond to WM_GETTEXT.\n\t\t// Here are some of the discrepancies:\n\t\t// WM_GETTEXTLENGTH vs. WM_GETTEXT:\n\t\t// 92 vs. 318 (bigger)\n\t\t// 50 vs. 159 (bigger)\n\t\t// 3 vs. 0 (smaller)\n\t\t// 24 vs. 88 (etc.)\n\t\t// 80 vs. 188\n\t\t// 24 vs. 88\n\t\t// 80 vs. 188\n\t\t//char buf[32000];\n\t\t//LRESULT length2;\n\t\t//result = SendMessageTimeout(aWnd, WM_GETTEXT, (WPARAM)sizeof(buf), (LPARAM)buf\n\t\t//\t, SMTO_ABORTIFHUNG, aTimeout, (LPDWORD)&length2);\n\t\t//if (length2 != length)\n\t\t//{\n\t\t//\tint x = 0; // Put breakpoint here.\n\t\t//}\n\t\t// An attempt to fix the size estimate to be larger for misbehaving apps like AIM, but it's ineffective\n\t\t// so commented out:\n\t\t//if (!length)\n\t\t//\tlength = GetWindowTextLength(aWnd);\n\t}\n\n\t// \"length\" contains the length of what was (or would have been) copied, not including the terminator:\n\treturn result ? (int)length : 0; // \"result\" is zero upon failure or timeout.\n}\n\n\n\n///////////////////////////////////////////////////////////////////////////\n\n\n\nResultType WindowSearch::SetCriteria(ScriptThreadSettings &aSettings, LPCTSTR aTitle, LPCTSTR aText, LPCTSTR aExcludeTitle, LPCTSTR aExcludeText)\n// Returns FAIL if the new criteria can't possibly match a window (due to ahk_id being in invalid\n// window or the specified ahk_group not existing). Otherwise, it returns OK.\n// Callers must ensure that aText, aExcludeTitle, and aExcludeText point to buffers whose contents\n// will be available for the entire duration of the search. In other words, the caller should not\n// call MsgSleep() in a way that would allow another thread to launch and overwrite the contents\n// of the sDeref buffer (which might contain the contents). Things like mFoundHWND and mFoundCount\n// are not initialized here because sometimes the caller changes the criteria without wanting to\n// reset the search.\n// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.\n{\n\t// Set any criteria which are not context sensitive. It doesn't seem necessary to make copies of\n\t// mCriterionText, mCriterionExcludeTitle, and mCriterionExcludeText because they're never altered\n\t// here, nor does there seem to be a risk that deref buffer's contents will get overwritten\n\t// while this set of criteria is in effect because our callers never allow interrupting script-threads\n\t// *during* the duration of any one set of criteria.\n\tbool exclude_title_became_non_blank = *aExcludeTitle && !*mCriterionExcludeTitle;\n\tmCriterionExcludeTitle = aExcludeTitle;\n\tmCriterionExcludeTitleLength = _tcslen(mCriterionExcludeTitle); // Pre-calculated for performance.\n\tmCriterionText = aText;\n\tmCriterionExcludeText = aExcludeText;\n\tmSettings = &aSettings;\n\n\tDWORD orig_criteria = mCriteria, this_criterion = CRITERION_TITLE, next_criterion;\n\tLPCTSTR start, end, value, next_value = nullptr;\n\tsize_t value_length, buf_used = 0;\n\n\tfor (mCriteria = 0, start = aTitle; this_criterion; start = next_value, this_criterion = next_criterion)\n\t{\n\t\tfor (next_criterion = 0, end = start; end = tcscasestr(end, _T(\"ahk_\")); end += 4)\n\t\t{\n\t\t\t// To reduce ambiguity, the following requires that any \"ahk_\" criteria beyond the first\n\t\t\t// be preceded by at least one space or tab:\n\t\t\tif (end > aTitle && !IS_SPACE_OR_TAB(end[-1]))\n\t\t\t\tcontinue;\n\t\t\tauto cp = end + 4;\n\t\t\tif (!_tcsnicmp(cp, _T(\"id\"), 2))\n\t\t\t\tcp += 2, next_criterion = CRITERION_ID;\n\t\t\telse if (!_tcsnicmp(cp, _T(\"pid\"), 3))\n\t\t\t\tcp += 3, next_criterion = CRITERION_PID;\n\t\t\telse if (!_tcsnicmp(cp, _T(\"group\"), 5))\n\t\t\t\tcp += 5, next_criterion = CRITERION_GROUP;\n\t\t\telse if (!_tcsnicmp(cp, _T(\"exe\"), 3))\n\t\t\t\tcp += 3, next_criterion = CRITERION_PATH;\n\t\t\telse if (!_tcsnicmp(cp, _T(\"class\"), 5))\n\t\t\t\tcp += 5, next_criterion = CRITERION_CLASS;\n\t\t\telse\n\t\t\t\tcontinue;\n\t\t\tnext_value = cp;\n\t\t\tbreak;\n\t\t}\n\n\t\tswitch (this_criterion)\n\t\t{\n\t\tcase CRITERION_ID:\n\t\t\tHWND hwnd;\n\t\t\thwnd = (HWND)ATOU64(start);\n\t\t\t// Note that this can validly be the HWND of a child window; i.e. ahk_id %ChildWindowHwnd% is supported.\n\t\t\tif (hwnd != HWND_BROADCAST && !IsWindow(hwnd) // Checked here once rather than each call to IsMatch().\n\t\t\t\t|| (mCriteria & CRITERION_ID) && hwnd != mCriterionHwnd) // Two different IDs have been specified, so there can never be a match.\n\t\t\t{\n\t\t\t\tmCriterionHwnd = NULL;\n\t\t\t\treturn FAIL; // Inform caller of invalid criteria. No need to do anything else further below.\n\t\t\t}\n\t\t\tmCriterionHwnd = hwnd;\n\t\t\tbreak;\n\t\tcase CRITERION_PID:\n\t\t\tmCriterionPID = ATOU(start);\n\t\t\tbreak;\n\t\tdefault:\n\t\t\t// In the following line, it may have been preferable to skip only zero or one spaces rather than\n\t\t\t// calling omit_leading_whitespace(). But now this should probably be kept for backward compatibility.\n\t\t\t// Besides, even if it's possible for a class name to start with a space, a RegEx dot or other symbol\n\t\t\t// can be used to match it via SetTitleMatchMode RegEx.\n\t\t\tstart = omit_leading_whitespace(start);\n\t\t\tif (end == start) // Empty or consists entirely of whitespace.\n\t\t\t{\n\t\t\t\t// For backward compatibility, disqualify any title consisting entirely of whitespace,\n\t\t\t\t// but otherwise include any trailing whitespace aside from the final delimiting space.\n\t\t\t\tif (this_criterion == CRITERION_TITLE) // Only title, since it has no explicit keyword.\n\t\t\t\t\tcontinue;\n\t\t\t\tvalue = _T(\"\"); // For backward-compatibility. An empty value is an automatic pass for RegEx mode and fail for other modes.\n\t\t\t}\n\t\t\telse if (end) // Because end != start, this implies end[-1] is the delimiting space.\n\t\t\t{\n\t\t\t\tif (!buf_used) // mCriterionBuf hasn't been used by this call, but may have been used by a previous call.\n\t\t\t\t{\n\t\t\t\t\t// Allow for space in the buffer for all remaining options, to minimize realloc and avoid the need\n\t\t\t\t\t// to update previously stored addresses. Some options don't need buffer space, but this is just\n\t\t\t\t\t// an estimate, and we will allow extra space for future calls anyway.\n\t\t\t\t\tsize_t max_size = _tcschr(end, '\\0') - start + 1;\n\t\t\t\t\tif (max_size > mCriterionBufSize)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Use a generous initial size and exponential growth to minimize the number of reallocs\n\t\t\t\t\t\t// while evaluating window groups.\n\t\t\t\t\t\tif (mCriterionBufSize < 1024)\n\t\t\t\t\t\t\tmCriterionBufSize = 1024;\n\t\t\t\t\t\twhile (mCriterionBufSize < max_size)\n\t\t\t\t\t\t\tmCriterionBufSize <<= 1;\n\t\t\t\t\t\tfree(mCriterionBuf); // The previous content is not needed, so free/malloc rather than realloc.\n\t\t\t\t\t\tif (!(mCriterionBuf = tmalloc(mCriterionBufSize)))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tmCriterionBufSize = 0;\n\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t// Omit exactly one space or tab from the title criterion. That space or tab is the one\n\t\t\t\t// required to delimit the special \"ahk_\" string. Any other spaces or tabs to the left of\n\t\t\t\t// that one are considered literal (for flexibility).\n\t\t\t\tvalue_length = end - start - 1; // -1 to omit the delimiting space.\n\t\t\t\tauto buf = mCriterionBuf + buf_used;\n\t\t\t\ttmemcpy(buf, start, value_length);\n\t\t\t\tbuf[value_length] = '\\0';\n\t\t\t\tbuf_used += value_length + 1;\n\t\t\t\tvalue = buf;\n\t\t\t}\n\t\t\telse\n\t\t\t\tvalue = start;\n\n\t\t\tswitch (this_criterion)\n\t\t\t{\n\t\t\tcase CRITERION_TITLE:\n\t\t\t\t// Due to checks above, there is always at least one non-whitespace character.\n\t\t\t\tmCriterionTitle = value;\n\t\t\t\tmCriterionTitleLength = end ? value_length : _tcslen(value);\n\t\t\t\tbreak;\n\t\t\tcase CRITERION_GROUP:\n\t\t\t\tif ( !(mCriterionGroup = g_script.FindGroup(value)) )\n\t\t\t\t\treturn FAIL; // No such group: Inform caller of invalid criteria. No need to do anything else further below.\n\t\t\t\tbreak;\n\t\t\tcase CRITERION_PATH:\n\t\t\t\tmCriterionPath = value;\n\t\t\t\t// Allow something like \"ahk_exe firefox.exe\" to be an exact match for the process name\n\t\t\t\t// instead of full path, but for flexibility, always use full path when in regex mode.\n\t\t\t\tmCriterionPathIsNameOnly = mSettings->TitleMatchMode != FIND_REGEX && !_tcschr(mCriterionPath, '\\\\');\n\t\t\t\tbreak;\n\t\t\tcase CRITERION_CLASS:\n\t\t\t\tmCriterionClass = value;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\tmCriteria |= this_criterion;\n\t}\n\n\t// Since this function doesn't change mCandidateParent, there is no need to update the candidate's\n\t// attributes unless the type of criterion has changed or if mExcludeTitle became non-blank as\n\t// a result of our action above:\n\tif (mCriteria != orig_criteria || exclude_title_became_non_blank)\n\t\tUpdateCandidateAttributes(); // In case mCandidateParent isn't NULL, fetch different attributes based on what was set above.\n\t//else for performance reasons, avoid unnecessary updates.\n\treturn OK;\n}\n\n\n\nvoid WindowSearch::SetCriteria(global_struct &aSettings, WinGroup &aGroup)\n{\n\tmCriterionExcludeTitle = _T(\"\");\n\tmCriterionExcludeTitleLength = 0;\n\tmCriterionText = _T(\"\");\n\tmCriterionExcludeText = _T(\"\");\n\tmSettings = &aSettings;\n\tmCriterionGroup = &aGroup;\n\tmCriteria = CRITERION_GROUP;\n}\n\n\n\nvoid WindowSearch::UpdateCandidateAttributes()\n// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.\n{\n\t// Nothing to do until SetCandidate() is called with a non-NULL candidate and SetCriteria()\n\t// has been called for the first time (otherwise, mCriterionExcludeTitle and other things\n\t// are not yet initialized:\n\tif (!mCandidateParent || !mCriteria)\n\t\treturn;\n\tif ((mCriteria & CRITERION_TITLE) || *mCriterionExcludeTitle) // Need the window's title in both these cases.\n\t\tif (!GetWindowText(mCandidateParent, mCandidateTitle, _countof(mCandidateTitle)))\n\t\t\t*mCandidateTitle = '\\0'; // Failure or blank title is okay.\n\tif (mCriteria & CRITERION_PID) // In which case mCriterionPID should already be filled in, though it might be an explicitly specified zero.\n\t\tGetWindowThreadProcessId(mCandidateParent, &mCandidatePID);\n\tif (mCriteria & CRITERION_PATH)\n\t{\n\t\tDWORD dwPid;\n\t\tif (GetWindowThreadProcessId(mCandidateParent, &dwPid))\n\t\t\tif (!GetProcessName(dwPid, mCandidatePath, _countof(mCandidatePath), mCriterionPathIsNameOnly))\n\t\t\t\t*mCandidatePath = '\\0';\n\t}\n\tif (mCriteria & CRITERION_CLASS)\n\t\tGetClassName(mCandidateParent, mCandidateClass, _countof(mCandidateClass)); // Limit to WINDOW_CLASS_SIZE in this case since that's the maximum that can be searched.\n\t// Nothing to do for these:\n\t//CRITERION_GROUP: Can't be pre-processed at this stage.\n\t//CRITERION_ID: It is mCandidateParent, which has already been set by SetCandidate().\n}\n\n\n\nHWND WindowSearch::IsMatch(bool aInvert)\n// Caller must have called SetCriteria prior to calling this method, at least for the purpose of setting\n// mSettings to a valid address (and possibly other reasons).\n// This method returns the HWND of mCandidateParent if it matches the previously specified criteria\n// (title/pid/id/class/group) or NULL otherwise. Upon NULL, it doesn't reset mFoundParent or mFoundCount\n// in case previous match(es) were found when mFindLastMatch is in effect.\n// Thread-safety: With the following exception, this function must be kept thread-safe because it may be\n// called (indirectly) by hook thread too: The hook thread must never call here directly or indirectly with\n// mArray!=NULL because the corresponding section below is probably not thread-safe.\n{\n\tif (!mCandidateParent || !mCriteria) // Nothing to check, so no match.\n\t\treturn NULL;\n\n\tif ((mCriteria & CRITERION_TITLE) && *mCriterionTitle) // For performance, avoid the calls below (especially RegEx) when mCriterionTitle is blank (assuming it's even possible for it to be blank under these conditions).\n\t{\n\t\tswitch(mSettings->TitleMatchMode)\n\t\t{\n\t\tcase FIND_ANYWHERE:\n\t\t\tif (!_tcsstr(mCandidateTitle, mCriterionTitle)) // Suitable even if mCriterionTitle is blank, though that's already ruled out above.\n\t\t\t\treturn NULL;\n\t\t\tbreak;\n\t\tcase FIND_IN_LEADING_PART:\n\t\t\tif (_tcsncmp(mCandidateTitle, mCriterionTitle, mCriterionTitleLength)) // Suitable even if mCriterionTitle is blank, though that's already ruled out above. If it were possible, mCriterionTitleLength would be 0 and thus strncmp would yield 0 to indicate \"strings are equal\".\n\t\t\t\treturn NULL;\n\t\t\tbreak;\n\t\tcase FIND_REGEX:\n\t\t\tif (!RegExMatch(mCandidateTitle, mCriterionTitle))\n\t\t\t\treturn NULL;\n\t\t\tbreak;\n\t\tdefault: // Exact match.\n\t\t\tif (_tcscmp(mCandidateTitle, mCriterionTitle))\n\t\t\t\treturn NULL;\n\t\t}\n\t\t// If above didn't return, it's a match so far so continue onward to the other checks.\n\t}\n\n\tif (mCriteria & CRITERION_CLASS) // mCriterionClass is probably always non-blank when CRITERION_CLASS is present (harmless even if it isn't), so *mCriterionClass isn't checked.\n\t{\n\t\tif (mSettings->TitleMatchMode == FIND_REGEX)\n\t\t{\n\t\t\tif (!RegExMatch(mCandidateClass, mCriterionClass))\n\t\t\t\treturn NULL;\n\t\t}\n\t\telse // For backward compatibility, all other modes use exact-match for Class.\n\t\t\tif (_tcscmp(mCandidateClass, mCriterionClass)) // Doesn't match the required class name.\n\t\t\t\treturn NULL;\n\t\t// If nothing above returned, it's a match so far so continue onward to the other checks.\n\t}\n\n\t// For the following, mCriterionPID would already be filled in, though it might be an explicitly specified zero.\n\tif ((mCriteria & CRITERION_PID) && mCandidatePID != mCriterionPID) // Doesn't match required PID.\n\t\treturn NULL;\n\t//else it's a match so far, but continue onward in case there are other criteria.\n\n\tif (mCriteria & CRITERION_PATH)\n\t{\n\t\tif (mSettings->TitleMatchMode == FIND_REGEX)\n\t\t{\n\t\t\tif (!RegExMatch(mCandidatePath, mCriterionPath))\n\t\t\t\treturn NULL;\n\t\t}\n\t\telse\n\t\t\tif (_tcsicmp(mCandidatePath, mCriterionPath)) // Doesn't match the required path.\n\t\t\t\treturn NULL;\n\t\t// If nothing above returned, it's a match so far so continue onward to the other checks.\n\t}\n\n\t// The following also handles the fact that mCriterionGroup might be NULL if the specified group\n\t// does not exist or was never successfully created:\n\tif ((mCriteria & CRITERION_GROUP) && (!mCriterionGroup || !mCriterionGroup->IsMember(mCandidateParent, *mSettings)))\n\t\treturn NULL; // Isn't a member of specified group.\n\t//else it's a match so far, but continue onward in case there are other criteria (a little strange in this case, but might be useful).\n\n\t// CRITERION_ID is listed last since in terms of actual calling frequency, this part is hardly ever\n\t// executed: It's only ever called this way from WinActive(), and possibly indirectly by an ahk_group\n\t// that contains an ahk_id specification. It's also called by WinGetList()'s EnumWindows(), though\n\t// extremely rarely. It's also called this way from other places to determine whether an ahk_id window\n\t// matches the other criteria such as WinText, ExcludeTitle, and mAlreadyVisited.\n\t// mCriterionHwnd should already be filled in, though it might be an explicitly specified zero.\n\t// Note: IsWindow(mCriterionHwnd) was already called by SetCriteria().\n\tif ((mCriteria & CRITERION_ID) && mCandidateParent != mCriterionHwnd) // Doesn't match the required HWND.\n\t\treturn NULL;\n\t//else it's a match so far, but continue onward in case there are other criteria.\n\n\t// The above would have returned if the candidate window isn't a match for what was specified by\n\t// the script's WinTitle parameter. So now check that the ExcludeTitle criterion is satisfied.\n\t// This is done prior to checking WinText/ExcludeText for performance reasons:\n\n\tif (*mCriterionExcludeTitle)\n\t{\n\t\tswitch(mSettings->TitleMatchMode)\n\t\t{\n\t\tcase FIND_ANYWHERE:\n\t\t\tif (_tcsstr(mCandidateTitle, mCriterionExcludeTitle))\n\t\t\t\treturn NULL;\n\t\t\tbreak;\n\t\tcase FIND_IN_LEADING_PART:\n\t\t\tif (!_tcsncmp(mCandidateTitle, mCriterionExcludeTitle, mCriterionExcludeTitleLength))\n\t\t\t\treturn NULL;\n\t\t\tbreak;\n\t\tcase FIND_REGEX:\n\t\t\tif (RegExMatch(mCandidateTitle, mCriterionExcludeTitle))\n\t\t\t\treturn NULL;\n\t\t\tbreak;\n\t\tdefault: // Exact match.\n\t\t\tif (!_tcscmp(mCandidateTitle, mCriterionExcludeTitle))\n\t\t\t\treturn NULL;\n\t\t}\n\t\t// If above didn't return, WinTitle and ExcludeTitle are both satisfied. So continue\n\t\t// on below in case there is some WinText or ExcludeText to search.\n\t}\n\n\tif (!aInvert) // If caller specified aInvert==true, it will do the below instead of us.\n\t\tfor (int i = 0; i < mAlreadyVisitedCount; ++i)\n\t\t\tif (mCandidateParent == mAlreadyVisited[i])\n\t\t\t\treturn NULL;\n\n\tif (*mCriterionText || *mCriterionExcludeText) // It's not quite a match yet since there are more criteria.\n\t{\n\t\t// Check the child windows for the specified criteria.\n\t\t// EnumChildWindows() will return FALSE (failure) in at least two common conditions:\n\t\t// 1) It's EnumChildProc callback returned false (i.e. it ended the enumeration prematurely).\n\t\t// 2) The specified parent has no children.\n\t\t// Since in both these cases GetLastError() returns ERROR_SUCCESS, we discard the return\n\t\t// value and just check mFoundChild to determine whether a match has been found:\n\t\tmFoundChild = NULL; // Init prior to each call, in case mFindLastMatch is true.\n\t\tEnumChildWindows(mCandidateParent, EnumChildFind, (LPARAM)this);\n\t\tif (!mFoundChild) // This parent has no matching child, or no children at all.\n\t\t\treturn NULL;\n\t}\n\n\t// Since the above didn't return or none of the checks above were needed, it's a complete match.\n\t// If mFindLastMatch is true, this new value for mFoundParent will stay in effect until\n\t// overridden by another matching window later:\n\tif (!aInvert)\n\t{\n\t\tmFoundParent = mCandidateParent;\n\t\t++mFoundCount; // This must be done prior to the mArray section below.\n\t}\n\t//else aInvert==true, which means caller doesn't want the above set.\n\n\tif (mArray) // Probably not thread-safe, so hook thread must call only with NULL mArray.\n\t{\n\t\tmArray->Append((__int64)(size_t)mFoundParent);\n\t\t// No error reporting currently, since should be very rare.\n\t}\n\n\t// Fix for v1.0.30.01: Don't return mFoundParent because its NULL when aInvert is true.\n\t// At this stage, the candidate is a known match, so return it:\n\treturn mCandidateParent;\n}\n\n\n\n///////////////////////////////////////////////////////////////////\n\n\n\nvoid DialogPrep()\n// Having it as a function vs. macro should reduce code size due to expansion of macros inside.\n{\n\t// Make the thread immediately interruptible but don't change g->ThreadIsCritical,\n\t// since DIALOG_END will refer to it when resetting g->AllowThreadToBeInterrupted.\n\tg->AllowThreadToBeInterrupted = true;\n\tif (g_KeybdHook) // Workaround added in v1.1.22.01.\n\t{\n\t\t// If a Control or Shift key is physically down, the dialog somehow recognizes this\n\t\t// and acts as though the key is logically down even if it really isn't. Logically\n\t\t// releasing the key before or after the dialog is shown appears to work around the\n\t\t// issue. If one L/R modifier is logically down and the opposite side is physically\n\t\t// down, the workaround isn't wanted/needed, because the dialog *should* act like\n\t\t// the key is down, and it does so until the key is released.\n\t\t// UPDATE: I'm not able to reproduce this problem on Windows 10, but it's done there\n\t\t// too just in case.\n\t\tmod_type mods_logical = ConvertModifiersLR(g_modifiersLR_logical);\n\t\tmodLR_type mods_not_to_release = ConvertModifiers(mods_logical & (MOD_CONTROL | MOD_SHIFT))\n\t\t\t| MOD_LALT | MOD_RALT | MOD_LWIN | MOD_RWIN; // v1.1.23.05: No need to release these keys.\n\t\tmodLR_type mods_to_release = g_modifiersLR_physical & ~mods_not_to_release;\n\t\tif (mods_to_release)\n\t\t{\n\t\t\tif (mods_logical == MOD_WIN) // Fixed in v1.1.23.05 to exclude combinations like MOD_WIN|MOD_CONTROL, which don't need this.\n\t\t\t{\n\t\t\t\t// Even though the Win key isn't being released, sending a Shift or Control key-up\n\t\t\t\t// triggers the Start menu. To prevent that, we send the mask key. This has been\n\t\t\t\t// confirmed to apply to #Control, #Shift and the left/right variants.\n\t\t\t\tKeyEventMenuMask(KEYDOWNANDUP, KEY_IGNORE_ALL_EXCEPT_MODIFIER);\n\t\t\t\t// Releasing the Win key now does not prevent it from being \"masked\" again later:\n\t\t\t\t//mods_to_release |= (g_modifiersLR_logical & (MOD_LWIN | MOD_RWIN));\n\t\t\t}\n\t\t\tSetModifierLRState(0, mods_to_release, NULL, false, false);\n\t\t}\n\t}\n\tif (HIWORD(GetQueueStatus(QS_ALLEVENTS))) // See DIALOG_PREP for explanation.\n\t\tMsgSleep(-1);\n}\n"},"size":{"kind":"number","value":91677,"string":"91,677"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1553,"string":"1,553"},"avg_line_length":{"kind":"number","value":56.31229877656149,"string":"56.312299"},"max_line_length":{"kind":"number","value":276,"string":"276"},"alphanum_fraction":{"kind":"number","value":0.7465053434605162,"string":"0.746505"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11090,"cells":{"id":{"kind":"number","value":16080,"string":"16,080"},"file_name":{"kind":"string","value":"script_object_bif.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_object_bif.cpp"},"content":{"kind":"string","value":"#include \"stdafx.h\" // pre-compiled headers\n#include \"defines.h\"\n#include \"globaldata.h\"\n#include \"script.h\"\n\n#include \"script_object.h\"\n#include \"script_func_impl.h\"\n\n\nextern BuiltInFunc *OpFunc_GetProp, *OpFunc_GetItem, *OpFunc_SetProp, *OpFunc_SetItem;\n\n//\n// Object()\n//\n\nBIF_DECL(Op_Object)\n{\n\tIObject *obj = Object::Create(aParam, aParamCount, &aResultToken);\n\tif (obj)\n\t{\n\t\t// DO NOT ADDREF: the caller takes responsibility for the only reference.\n\t\t_f_return(obj);\n\t}\n\t//else: an error was already thrown.\n}\n\n\n//\n// BIF_Array - Array(items*)\n//\n\nBIF_DECL(Op_Array)\n{\n\tif (auto arr = Array::Create(aParam, aParamCount))\n\t\t_f_return(arr);\n\t_f_throw_oom;\n}\n\t\n\n//\n// IsObject\n//\n\nBIF_DECL(BIF_IsObject)\n{\n\t_f_return_b(TokenToObject(*aParam[0]) != nullptr);\n}\n\t\n\n//\n// Functions for accessing built-in methods (even if obscured by a user-defined method).\n//\n\nBIF_DECL(BIF_ObjXXX)\n{\n\taResultToken.symbol = SYM_STRING;\n\taResultToken.marker = _T(\"\"); // Set default for CallBuiltin().\n\t\n\tObject *obj = dynamic_cast<Object*>(TokenToObject(*aParam[0]));\n\tif (obj)\n\t\tobj->CallBuiltin(_f_callee_id, aResultToken, aParam + 1, aParamCount - 1);\n\telse\n\t\t_f_throw_type(_T(\"Object\"), *aParam[0]);\n}\n\n\n//\n// ObjAddRef/ObjRelease - used with pointers rather than object references.\n//\n\nBIF_DECL(BIF_ObjAddRefRelease)\n{\n\tIObject *obj = (IObject *)TokenToInt64(*aParam[0]);\n\tif (obj < (IObject *)65536) // Rule out some obvious errors.\n\t\t_f_throw_param(0);\n\tif (_f_callee_id == FID_ObjAddRef)\n\t\t_f_return_i(obj->AddRef());\n\telse\n\t\t_f_return_i(obj->Release());\n}\n\n\n//\n// ObjBindMethod(Obj, Method, Params...)\n//\n\nBIF_DECL(BIF_ObjBindMethod)\n{\n\tIObject *func, *bound_func;\n\tif ( !(func = ParamIndexToObject(0)) )\n\t\t_f_throw_param(0);\n\tLPCTSTR name = nullptr;\n\tif (aParamCount > 1)\n\t{\n\t\tswitch (TypeOfToken(*aParam[1]))\n\t\t{\n\t\tcase SYM_MISSING: break;\n\t\tcase SYM_OBJECT: _f_throw_param(1, _T(\"String\"));\n\t\tdefault: name = TokenToString(*aParam[1], _f_number_buf);\n\t\t}\n\t\taParam += 2;\n\t\taParamCount -= 2;\n\t}\n\telse\n\t\taParamCount = 0;\n\tbound_func = BoundFunc::Bind(func, IT_CALL, name, aParam, aParamCount);\n\tif (!bound_func)\n\t\t_f_throw_oom;\n\t_f_return(bound_func);\n}\n\n\n//\n// ObjPtr/ObjPtrAddRef/ObjFromPtr - Convert between object reference and IObject pointer.\n//\n\nBIF_DECL(BIF_ObjPtr)\n{\n\tif (_f_callee_id >= FID_ObjFromPtr)\n\t{\n\t\tauto obj = (IObject *)ParamIndexToInt64(0);\n\t\tif (obj < (IObject *)65536) // Prevent some obvious errors.\n\t\t\t_f_throw_param(0);\n\t\tif (_f_callee_id == FID_ObjFromPtrAddRef)\n\t\t\tobj->AddRef();\n\t\t_f_return(obj);\n\t}\n\telse // FID_ObjPtr or FID_ObjPtrAddRef.\n\t{\n\t\tauto obj = ParamIndexToObject(0);\n\t\tif (!obj)\n\t\t\t_f_throw_type(_T(\"object\"), *aParam[0]);\n\t\tif (_f_callee_id == FID_ObjPtrAddRef)\n\t\t\tobj->AddRef();\n\t\t_f_return((UINT_PTR)obj);\n\t}\n}\n\n\n//\n// ObjSetBase/ObjGetBase - Change or return Object's base without invoking any meta-functions.\n//\n\nBIF_DECL(BIF_Base)\n{\n\tIObject *iobj = ParamIndexToObject(0);\n\tif (_f_callee_id == FID_ObjSetBase)\n\t{\n\t\tObject *obj = dynamic_cast<Object*>(iobj);\n\t\tif (!obj)\n\t\t\t_f_throw_type(_T(\"Object\"), *aParam[0]);\n\t\tauto new_base = dynamic_cast<Object *>(TokenToObject(*aParam[1]));\n\t\tif (!new_base)\n\t\t\t_f_throw_type(_T(\"Object\"), *aParam[1]);\n\t\tif (!obj->SetBase(new_base, aResultToken))\n\t\t\treturn;\n\t}\n\telse // ObjGetBase\n\t{\n\t\tObject *obj_base;\n\t\tif (iobj)\n\t\t\tobj_base = iobj->Base();\n\t\telse\n\t\t\tobj_base = Object::ValueBase(*aParam[0]);\n\t\tif (obj_base)\n\t\t{\n\t\t\tobj_base->AddRef();\n\t\t\t_f_return(obj_base);\n\t\t}\n\t\t// Otherwise, could be Object::sAnyPrototype or SYM_MISSING (via a variadic call).\n\t}\n\t_f_return_empty;\n}\n\n\nbool Object::HasBase(ExprTokenType &aValue, IObject *aBase)\n{\n\tObject *value_base;\n\tif (auto obj = TokenToObject(aValue))\n\t\tvalue_base = obj->Base();\n\telse\n\t\tvalue_base = Object::ValueBase(aValue);\n\tif (value_base)\n\t\treturn value_base == aBase || value_base->IsDerivedFrom(aBase);\n\t// Otherwise, could be Object::sAnyPrototype or SYM_MISSING (via a variadic call).\n\treturn false;\n}\n\n\nBIF_DECL(BIF_HasBase)\n{\n\tauto that_base = ParamIndexToObject(1);\n\tif (!that_base)\n\t\t_f_throw_type(_T(\"object\"), *aParam[1]);\n\t_f_return_b(Object::HasBase(*aParam[0], that_base));\n}\n\n\nObject *ParamToObjectOrBase(ExprTokenType &aToken)\n{\n\tif (IObject *iobj = TokenToObject(aToken))\n\t{\n\t\tif (iobj->IsOfType(Object::sPrototype))\n\t\t\treturn (Object *)iobj;\n\t\treturn iobj->Base();\n\t}\n\treturn Object::ValueBase(aToken);\n}\n\n\nBIF_DECL(BIF_HasProp)\n{\n\tauto obj = ParamToObjectOrBase(*aParam[0]);\n\tif (obj == Object::sComObjectPrototype)\n\t\t_f_throw_param(0);\n\t_f_return_b(obj->HasProp(ParamIndexToString(1, _f_number_buf)));\n}\n\n\nBIF_DECL(BIF_GetMethod)\n{\n\tauto obj = ParamToObjectOrBase(*aParam[0]);\n\tif (obj == Object::sComObjectPrototype)\n\t\t_f_throw_param(0);\n\tauto method_name = ParamIndexToOptionalStringDef(1, nullptr, _f_number_buf);\n\tauto method = method_name ? obj->GetMethod(method_name) : obj; // Validate obj itself as a function if method name is omitted.\n\tif (method)\n\t{\n\t\tint param_count = -1; // Default to no parameter count validation.\n\t\tif (!ParamIndexIsOmitted(2))\n\t\t{\n\t\t\tThrow_if_Param_NaN(2);\n\t\t\tparam_count = ParamIndexToInt(2);\n\t\t}\n\t\tif (param_count != -1 && method_name)\n\t\t\t++param_count; // So caller does not need to include the implicit `this` parameter.\n\t\tswitch (ValidateFunctor(method, param_count, aResultToken, nullptr, _f_callee_id == FID_GetMethod))\n\t\t{\n\t\tcase FAIL: return; // A property call threw an exception, or validation failed for GetMethod.\n\t\tcase CONDITION_FALSE: method = nullptr; // Validation failed for HasMethod.\n\t\t}\n\t}\n\tif (_f_callee_id == FID_HasMethod)\n\t\t_f_return_b(method != nullptr);\n\tif (!method) // No method for GetMethod to return: throw MethodError().\n\t\t_f__ret(aResultToken.UnknownMemberError(*aParam[0], IT_CALL, method_name));\n\tmethod->AddRef();\n\t_f_return(method);\n}\n\n\nBIF_DECL(BIF_StructFromPtr)\n{\n\tObject *base = dynamic_cast<Object *>(ParamIndexToObject(0));\n\tObject *proto = base ? dynamic_cast<Object *>(base->GetOwnPropObj(_T(\"Prototype\"))) : nullptr;\n\tif (!proto || proto->LockStructSize() == 0)\n\t\t_f_throw_param(0);\n\tauto ptr = (UINT_PTR)ParamIndexToInt64(1);\n\tif (ptr < 65536)\n\t\t_f_throw_param(1);\n\tauto obj = Object::CreateStructPtr(ptr, proto, aResultToken);\n\tif (obj)\n\t\t_f_return(obj);\n}\n\n\n//\n// Low level data pointer API\n//\n\nbif_impl FResult ObjSetDataPtr(IObject *aObj, UINT_PTR aPtr)\n{\n\tif (!aObj->IsOfType(Object::sPrototype))\n\t\treturn FR_E_ARG(0);\n\t((Object*)aObj)->SetDataPtr(aPtr);\n\treturn OK;\n}\n\nvoid Object::SetDataPtr(UINT_PTR aPtr)\n{\n\tif (mFlags & DataIsAllocatedFlag)\n\t\tfree(mData);\n\tmData = (void*)aPtr;\n\tmFlags = (mFlags & ~(DataIsAllocatedFlag | DataIsStructInfo)) | DataIsSetFlag;\n}\n\n\nbif_impl FResult ObjGetDataPtr(IObject *aObj, UINT_PTR &aPtr)\n{\n\tif (!aObj->IsOfType(Object::sPrototype))\n\t\treturn FR_E_ARG(0);\n\treturn ((Object*)aObj)->GetDataPtr(aPtr);\n}\n\nFResult Object::GetDataPtr(UINT_PTR &aPtr)\n{\n\tif (!(mFlags & DataIsSetFlag))\n\t\treturn FR_E_FAILED;\n\taPtr = DataPtr();\n\treturn OK;\n}\n\n\n#ifdef ENABLE_OBJALLOCDATA\nbif_impl FResult ObjAllocData(IObject *aObj, UINT_PTR aSize)\n{\n\tif (!aObj->IsOfType(Object::sPrototype))\n\t\treturn FR_E_ARG(0);\n\treturn ((Object*)aObj)->AllocDataPtr(aSize);\n}\n#endif\n\nFResult Object::AllocDataPtr(UINT_PTR aSize)\n{\n\tauto p = (UINT_PTR*)malloc(sizeof(UINT_PTR) + aSize);\n\tif (!p)\n\t\treturn FR_E_OUTOFMEM;\n\tif (mFlags & DataIsAllocatedFlag)\n\t\tfree(mData);\n\t*p = aSize;\n\tmData = p;\n\tmFlags = DataIsAllocatedFlag | DataIsSetFlag | (mFlags & ~DataIsStructInfo);\n\treturn OK;\n}\n\n\nbif_impl FResult ObjGetDataSize(IObject *aObj, UINT_PTR &aRetVal)\n{\n\tif (!aObj->IsOfType(Object::sPrototype))\n\t\treturn FR_E_ARG(0);\n\taRetVal = ((Object*)aObj)->DataSize();\n\tif (!aRetVal)\n\t\taRetVal = ((Object*)aObj)->StructSize();\n\treturn OK;\n}\n\n\n#ifdef ENABLE_OBJALLOCDATA\nbif_impl FResult ObjFreeData(IObject *aObj)\n{\n\tif (!aObj->IsOfType(Object::sPrototype))\n\t\treturn FR_E_ARG(0);\n\treturn ((Object*)aObj)->FreeDataPtr();\n}\n\nFResult Object::FreeDataPtr()\n{\n\tif ((mFlags & (DataIsAllocatedFlag | DataIsSetFlag)) == (DataIsAllocatedFlag | DataIsSetFlag))\n\t{\n\t\tfree(mData);\n\t\tmData = nullptr;\n\t\tmFlags &= ~(DataIsAllocatedFlag | DataIsSetFlag);\n\t}\n\telse if (mData)\n\t\treturn FR_E_FAILED;\n\treturn OK;\n}\n#endif\n"},"size":{"kind":"number","value":8143,"string":"8,143"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":304,"string":"304"},"avg_line_length":{"kind":"number","value":24.59210526315789,"string":"24.592105"},"max_line_length":{"kind":"number","value":127,"string":"127"},"alphanum_fraction":{"kind":"number","value":0.7054891374212624,"string":"0.705489"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11091,"cells":{"id":{"kind":"number","value":16081,"string":"16,081"},"file_name":{"kind":"string","value":"script_gui.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_gui.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include <Shlwapi.h>\n#include <uxtheme.h>\n#include \"script.h\"\n#include \"script_gui.h\"\n#include \"globaldata.h\" // for a lot of things\n#include \"application.h\" // for MsgSleep()\n#include \"window.h\" // for SetForegroundWindowEx()\n#include \"qmath.h\" // for qmathLog()\n#include \"script_func_impl.h\"\n\n\nstatic inline void AddGuiToList(GuiType* gui)\n{\n\tgui->mNextGui = NULL;\n\tgui->mPrevGui = g_lastGui;\n\tif (g_lastGui)\n\t\tg_lastGui->mNextGui = gui;\n\tg_lastGui = gui;\n\tif (!g_firstGui)\n\t\tg_firstGui = gui;\n\t// AddRef() is not called here because we want the GUI to be destroyed automatically\n\t// when the script releases its last reference if it's not visible, or when the GUI\n\t// is closed if the script has no references. See VisibilityChanged().\n}\n\nstatic inline void RemoveGuiFromList(GuiType* gui)\n{\n\tif (!gui->mPrevGui && gui != g_firstGui)\n\t\t// !mPrevGui indicates this is either the first Gui or not in the list.\n\t\t// Since both conditions were met, this Gui must have been partially constructed\n\t\t// but not added to the list, and is being destroyed due to an error in Create.\n\t\treturn;\n\tGuiType *prev = gui->mPrevGui, *&prevNext = prev ? prev->mNextGui : g_firstGui;\n\tGuiType *next = gui->mNextGui, *&nextPrev = next ? next->mPrevGui : g_lastGui;\n\tprevNext = next;\n\tnextPrev = prev;\n}\n\n\n// Gui methods use this macro either if they require the Gui to have a window,\n// or if they aren't safe to use after Dispose() is called.\n#define GUI_MUST_HAVE_HWND if (!mHwnd) return GuiNoWindowError()\n// Using a noinline function reduces code by a few hundred bytes across all methods.\n// Returning something like FR_E_WIN32(ERROR_INVALID_WINDOW_HANDLE) instead is about\n// the same, so it seems better to use the clearer error message.\n__declspec(noinline) FResult GuiNoWindowError() { return FError(ERR_GUI_NO_WINDOW); }\n\n#define CTRL_THROW_IF_DESTROYED if (!hwnd) return ControlDestroyedError()\n__declspec(noinline) FResult ControlDestroyedError() { return FError(_T(\"The control is destroyed.\")); }\n\n\n// Window class atom used by Guis.\nstatic ATOM sGuiWinClass;\n\n\nLPTSTR GuiControlType::sTypeNames[GUI_CONTROL_TYPE_COUNT] = { GUI_CONTROL_TYPE_NAMES };\n\nGuiControls GuiControlType::ConvertTypeName(LPCTSTR aTypeName)\n{\n\tfor (int i = 1; i < _countof(sTypeNames); ++i) // Start at 1 because 0 is GUI_CONTROL_INVALID.\n\t\tif (!_tcsicmp(aTypeName, sTypeNames[i]))\n\t\t\treturn (GuiControls)i;\n\tif (!_tcsicmp(aTypeName, _T(\"DropDownList\"))) return GUI_CONTROL_DROPDOWNLIST;\n\tif (!_tcsicmp(aTypeName, _T(\"Picture\"))) return GUI_CONTROL_PIC;\n\treturn GUI_CONTROL_INVALID;\n}\n\nLPTSTR GuiControlType::GetTypeName()\n{\n\tif (type == GUI_CONTROL_TAB)\n\t{\n\t\t// Tab2 and Tab3 are changed into Tab at an early stage.\n\t\tif (attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR)\n\t\t\treturn sTypeNames[GUI_CONTROL_TAB2];\n\t\tif (GetProp(hwnd, _T(\"ahk_dlg\")))\n\t\t\treturn sTypeNames[GUI_CONTROL_TAB3];\n\t}\n\treturn sTypeNames[type];\n}\n\nGuiControlType::TypeAttribs GuiControlType::TypeHasAttrib(GuiControls aType, TypeAttribs aAttrib)\n{\n\tstatic TypeAttribs sAttrib[] = { 0,\n\t\t/*Text*/ TYPE_STATICBACK | TYPE_SUPPORTS_BGTRANS | TYPE_NO_SUBMIT,\n\t\t/*Pic*/ TYPE_STATICBACK | TYPE_SUPPORTS_BGTRANS | TYPE_NO_SUBMIT | TYPE_HAS_NO_TEXT | TYPE_RESERVE_UNION,\n\t\t/*GroupBox*/ TYPE_STATICBACK | TYPE_SUPPORTS_BGTRANS | TYPE_NO_SUBMIT, // Background affects only the label.\n\t\t/*Button*/ TYPE_MSGBKCOLOR | TYPE_SUPPORTS_BGTRANS | TYPE_NO_SUBMIT, // Background affects only the button's border, on Windows 10.\n\t\t/*CheckBox*/ TYPE_STATICBACK,\n\t\t/*Radio*/ TYPE_STATICBACK | TYPE_NO_SUBMIT, // No-submit: Radio controls are handled separately, by group.\n\t\t/*DDL*/ TYPE_MSGBKCOLOR | TYPE_HAS_ITEMS, // Background affects only the main control, and requires -Theme.\n\t\t/*ComboBox*/ TYPE_MSGBKCOLOR | TYPE_HAS_ITEMS, // Background affects only the main control.\n\t\t/*ListBox*/ TYPE_MSGBKCOLOR | TYPE_HAS_ITEMS,\n\t\t/*ListView*/ TYPE_SETBKCOLOR | TYPE_NO_SUBMIT | TYPE_RESERVE_UNION | TYPE_HAS_ITEMS,\n\t\t/*TreeView*/ TYPE_SETBKCOLOR | TYPE_NO_SUBMIT,\n\t\t/*Edit*/ TYPE_MSGBKCOLOR,\n\t\t/*DateTime*/ 0,\n\t\t/*MonthCal*/ 0,\n\t\t/*Hotkey*/ 0,\n\t\t/*UpDown*/ TYPE_HAS_NO_TEXT,\n\t\t/*Slider*/ TYPE_STATICBACK | TYPE_HAS_NO_TEXT,\n\t\t/*Progress*/ TYPE_SETBKCOLOR | TYPE_HAS_NO_TEXT | TYPE_NO_SUBMIT,\n\t\t/*Tab*/ TYPE_STATICBACK | TYPE_HAS_ITEMS,\n\t\t/*Tab2*/ TYPE_STATICBACK | TYPE_HAS_ITEMS, // Only used prior to control construction; at least TYPE_HAS_ITEMS is needed here.\n\t\t/*Tab3*/ TYPE_STATICBACK | TYPE_HAS_ITEMS, // As above.\n\t\t/*ActiveX*/ TYPE_HAS_NO_TEXT | TYPE_NO_SUBMIT | TYPE_RESERVE_UNION,\n\t\t/*Link*/ TYPE_STATICBACK | TYPE_NO_SUBMIT,\n\t\t/*Custom*/ TYPE_MSGBKCOLOR | TYPE_NO_SUBMIT, // Custom controls *may* use WM_CTLCOLOR.\n\t\t/*StatusBar*/ TYPE_SETBKCOLOR | TYPE_NO_SUBMIT,\n\t};\n\treturn sAttrib[aType] & aAttrib;\n}\n\nUCHAR **ConstructEventSupportArray()\n{\n\t// This is mostly static data, but I haven't figured out how to construct it with just\n\t// an array initialiser (other than by using a fixed size for the sub-array, which\n\t// wastes space due to ListView and TreeView having many more events than other types).\n\tstatic UCHAR *raises[GUI_CONTROL_TYPE_COUNT];\n\t// Not necessary since the array is static and therefore initialised to 0 (NULL):\n\t//#define RAISES_NONE(ctrl) \\\n\t//\traises[ctrl] = NULL;\n\t#define RAISES(ctrl, ...) { \\\n\t\tstatic UCHAR events[] = { __VA_ARGS__, 0 }; \\\n\t\traises[ctrl] = events; \\\n\t}\n\n\tRAISES(GUI_CONTROL_TEXT, GUI_EVENT_CLICK, GUI_EVENT_DBLCLK)\n\tRAISES(GUI_CONTROL_PIC, GUI_EVENT_CLICK, GUI_EVENT_DBLCLK)\n\t//RAISES_NONE(GUI_CONTROL_GROUPBOX)\n\tRAISES(GUI_CONTROL_BUTTON, GUI_EVENT_CLICK, GUI_EVENT_DBLCLK, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_CHECKBOX, GUI_EVENT_CLICK, GUI_EVENT_DBLCLK, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_RADIO, GUI_EVENT_CLICK, GUI_EVENT_DBLCLK, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_DROPDOWNLIST, GUI_EVENT_CHANGE, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_COMBOBOX, GUI_EVENT_CHANGE, GUI_EVENT_DBLCLK, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_LISTBOX, GUI_EVENT_CHANGE, GUI_EVENT_DBLCLK, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_LISTVIEW, GUI_EVENT_DBLCLK, GUI_EVENT_COLCLK, GUI_EVENT_CLICK, GUI_EVENT_ITEMFOCUS, GUI_EVENT_ITEMSELECT, GUI_EVENT_ITEMCHECK, GUI_EVENT_ITEMEDIT, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_TREEVIEW, GUI_EVENT_ITEMSELECT, GUI_EVENT_DBLCLK, GUI_EVENT_CLICK, GUI_EVENT_ITEMEXPAND, GUI_EVENT_ITEMCHECK, GUI_EVENT_ITEMEDIT, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_EDIT, GUI_EVENT_CHANGE, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_DATETIME, GUI_EVENT_CHANGE, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS)\n\tRAISES(GUI_CONTROL_MONTHCAL, GUI_EVENT_CHANGE)\n\tRAISES(GUI_CONTROL_HOTKEY, GUI_EVENT_CHANGE)\n\tRAISES(GUI_CONTROL_UPDOWN, GUI_EVENT_CHANGE)\n\tRAISES(GUI_CONTROL_SLIDER, GUI_EVENT_CHANGE)\n\t//RAISES_NONE(GUI_CONTROL_PROGRESS)\n\tRAISES(GUI_CONTROL_TAB, GUI_EVENT_CHANGE)\n\t//RAISES(GUI_CONTROL_TAB2, ) // Not used since it is changed to TAB at an early stage.\n\t//RAISES(GUI_CONTROL_TAB3, )\n\t//RAISES_NONE(GUI_CONTROL_ACTIVEX)\n\tRAISES(GUI_CONTROL_LINK, GUI_EVENT_CLICK)\n\t//RAISES_NONE(GUI_CONTROL_CUSTOM)\n\tRAISES(GUI_CONTROL_STATUSBAR, GUI_EVENT_CLICK, GUI_EVENT_DBLCLK)\n\n\t//#undef RAISES_NONE\n\t#undef RAISES\n\n\treturn raises;\n}\n\nUCHAR **GuiControlType::sRaisesEvents = ConstructEventSupportArray();\n\nbool GuiControlType::SupportsEvent(GuiEventType aEvent)\n{\n\tif (UCHAR *this_raises = sRaisesEvents[type])\n\t{\n\t\tfor (;; ++this_raises)\n\t\t{\n\t\t\tif (*this_raises == aEvent)\n\t\t\t\treturn true;\n\t\t\tif (!*this_raises) // Checked after aEvent, as it will often be the first item in the array.\n\t\t\t\tbreak;\n\t\t}\n\t}\n\tif (aEvent == GUI_EVENT_CONTEXTMENU)\n\t\treturn true; // All controls implicitly support this.\n\treturn false;\n}\n\n\n// Helper function used to convert a token to an Array object.\nstatic Array* TokenToArray(ExprTokenType &token)\n{\n\treturn dynamic_cast<Array *>(TokenToObject(token));\n}\n\n\n// Enumerator for GuiType objects.\nResultType GuiType::GetEnumItem(UINT &aIndex, Var *aOutputVar1, Var *aOutputVar2, int aVarCount)\n{\n\tif (aIndex >= mControlCount) // Use >= vs. == in case the Gui was destroyed.\n\t\treturn CONDITION_FALSE;\n\tGuiControlType* ctrl = mControl[aIndex];\n\tif (aVarCount == 1) // `for x in myGui` or `[myGui*]`\n\t{\n\t\taOutputVar2 = aOutputVar1; // Return the more useful value in single-var mode: the control object.\n\t\taOutputVar1 = nullptr;\n\t}\n\tResultType result = OK;\n\tif (aOutputVar1)\n\t\tresult = aOutputVar1->AssignHWND(ctrl->hwnd);\n\tif (aOutputVar2 && result)\n\t\tresult = aOutputVar2->Assign(ctrl);\n\treturn result ? CONDITION_TRUE : FAIL;\n}\n\n\nFResult GuiType::__Enum(optl<int> aVarCount, IObject *&aRetVal)\n{\n\tGUI_MUST_HAVE_HWND;\n\taRetVal = new IndexEnumerator(this, aVarCount.value_or(0)\n\t\t, static_cast<IndexEnumerator::Callback>(&GuiType::GetEnumItem));\n\treturn OK;\n}\n\n\nObjectMemberMd GuiType::sMembers[] =\n{\n\tmd_member(GuiType, __Enum, CALL, (In_Opt, Int32, VarCount), (Ret, Object, RetVal)),\n\tmd_member(GuiType, __New, CALL, (In_Opt, String, Options), (In_Opt, String, Title), (In_Opt, Object, EventObj)),\n\t\n\tmd_member(GuiType, Add, CALL, (In, String, ControlType), (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddActiveX, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddButton, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddCheckBox, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddComboBox, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddCustom, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddDateTime, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddDDL, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddDropDownList, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddEdit, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddGroupBox, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddHotkey, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddLink, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddListBox, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddListView, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddMonthCal, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddPic, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddPicture, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddProgress, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddRadio, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddSlider, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddStatusBar, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddTab, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddTab2, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddTab3, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddText, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddTreeView, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\tmd_member(GuiType, AddUpDown, CALL, (In_Opt, String, Options), (In_Opt, Variant, Content), (Ret, Object, RetVal)),\n\t\n\tmd_member(GuiType, Destroy, CALL, md_arg_none),\n\tmd_member(GuiType, Flash, CALL, (In_Opt, Bool32, Blink)),\n\tmd_member(GuiType, GetClientPos, CALL, (Out_Opt, Int32, X), (Out_Opt, Int32, Y), (Out_Opt, Int32, Width), (Out_Opt, Int32, Height)),\n\tmd_member(GuiType, GetPos, CALL, (Out_Opt, Int32, X), (Out_Opt, Int32, Y), (Out_Opt, Int32, Width), (Out_Opt, Int32, Height)),\n\tmd_member(GuiType, Hide, CALL, md_arg_none),\n\tmd_member(GuiType, Maximize, CALL, md_arg_none),\n\tmd_member(GuiType, Minimize, CALL, md_arg_none),\n\tmd_member(GuiType, Move, CALL, (In_Opt, Int32, X), (In_Opt, Int32, Y), (In_Opt, Int32, Width), (In_Opt, Int32, Height)),\n\tmd_member(GuiType, OnEvent, CALL, (In, String, EventName), (In, Variant, Callback), (In_Opt, Int32, AddRemove)),\n\tmd_member(GuiType, OnMessage, CALL, (In, UInt32, Number), (In, Variant, Callback), (In_Opt, Int32, AddRemove)),\n\tmd_member(GuiType, Opt, CALL, (In, String, Options)),\n\tmd_member(GuiType, Restore, CALL, md_arg_none),\n\tmd_member(GuiType, SetFont, CALL, (In_Opt, String, Options), (In_Opt, String, FontName)),\n\tmd_member(GuiType, Show, CALL, (In_Opt, String, Options)),\n\tmd_member(GuiType, Submit, CALL, (In_Opt, Bool32, Hide), (Ret, Object, RetVal)),\n\t\n\tmd_member\t\t(GuiType, __Item, GET, (In, Variant, Index), (Ret, Object, RetVal)),\n\tmd_property_get\t(GuiType, Hwnd, UInt32),\n\tmd_property\t\t(GuiType, Title, String),\n\tmd_property\t\t(GuiType, Name, String),\n\tmd_property_get\t(GuiType, FocusedCtrl, Object),\n\tmd_property\t\t(GuiType, BackColor, Variant),\n\tmd_property\t\t(GuiType, MarginX, Int32),\n\tmd_property\t\t(GuiType, MarginY, Int32),\n\tmd_property\t\t(GuiType, MenuBar, Variant)\n};\n\nint GuiType::sMemberCount = _countof(sMembers);\n\n\nFResult GuiType::Add(StrArg aCtrlType, optl<StrArg> aOptions, ExprTokenType *aContent, IObject *&aRetVal)\n{\n\tauto ctrl_type = GuiControlType::ConvertTypeName(aCtrlType);\n\tif (ctrl_type == GUI_CONTROL_INVALID)\n\t\treturn FValueError(_T(\"Invalid control type.\"), aCtrlType);\n\tauto fr = AddControl(aOptions, aContent, aRetVal, ctrl_type);\n\treturn fr;\n}\n\n\nFResult GuiType::AddControl(optl<StrArg> aOptions, ExprTokenType *aContent, IObject *&aRetVal, GuiControls ctrl_type)\n{\n\tauto options = aOptions.value_or_empty();\n\tTCHAR text_buf[MAX_NUMBER_SIZE], *text = _T(\"\");\n\tArray *text_obj = nullptr;\n\tif (aContent)\n\t{\n\t\tauto temp_obj = TokenToObject(*aContent);\n\t\tif (GuiControlType::TypeHasAttrib(ctrl_type, GuiControlType::TYPE_HAS_ITEMS)) // Need an Array.\n\t\t{\n\t\t\tif ( !(text_obj = dynamic_cast<Array*>(temp_obj)) )\n\t\t\t\treturn FTypeError(_T(\"Array\"), *aContent);\n\t\t}\n\t\telse // Need a String.\n\t\t{\n\t\t\tif (temp_obj)\n\t\t\t\treturn FTypeError(_T(\"String\"), *aContent);\n\t\t\ttext = TokenToString(*aContent, text_buf);\n\t\t}\n\t}\n\tGUI_MUST_HAVE_HWND;\n\tGuiControlType* pcontrol;\n\tResultType result = AddControl(ctrl_type, options, text, pcontrol, text_obj);\n\tif (pcontrol)\n\t{\n\t\tpcontrol->AddRef();\n\t\taRetVal = pcontrol;\n\t}\n\treturn result ? OK : FR_FAIL;\n}\n\n\nFResult GuiType::__New(optl<StrArg> aOptions, optl<StrArg> aTitle, optl<IObject*> aEventObj)\n{\n\tif (mHwnd || mDisposed)\n\t\treturn FError(ERR_INVALID_USAGE);\n\n\tbool set_last_found_window = false;\n\tToggleValueType own_dialogs = TOGGLE_INVALID;\n\tif (!ParseOptions(aOptions.value_or_empty(), set_last_found_window, own_dialogs))\n\t\treturn FR_FAIL;\n\n\tmControl = (GuiControlType **)malloc(GUI_CONTROL_BLOCK_SIZE * sizeof(GuiControlType*));\n\tif (!mControl)\n\t\treturn FR_E_OUTOFMEM;\n\tmControlCapacity = GUI_CONTROL_BLOCK_SIZE;\n\n\tif (aEventObj.has_value())\n\t{\n\t\t// The caller specified an object to use as event sink.\n\t\tmEventSink = aEventObj.value();\n\t\tif (mEventSink != this) // Primarily for custom GUI classes: prevent a circular reference.\n\t\t\tmEventSink->AddRef();\n\t}\n\t\n\tLPCTSTR title = aTitle.has_value() ? aTitle.value() : g_script.DefaultDialogTitle();\n\n\t// Create the Gui, now that we're past all other failure points.\n\tauto fr = Create(title);\n\tif (fr != OK)\n\t\treturn fr;\n\n\tif (set_last_found_window)\n\t\tg->hWndLastUsed = mHwnd;\n\tSetOwnDialogs(own_dialogs);\n\n\t// Successful creation - add the Gui to the global list of Guis and return it\n\tAddGuiToList(this);\n\treturn OK;\n}\n\n\nFResult GuiType::get_Hwnd(UINT &aRetVal)\n{\n\t// Throwing if Destroy() has been called provides a clearer error message than\n\t// returning 0 when the Gui is being passed to a WinTitle parameter, and ensures\n\t// that it won't cause silent failures, such as with DllCall.\n\tGUI_MUST_HAVE_HWND;\n\taRetVal = (UINT)(UINT_PTR)mHwnd;\n\treturn OK;\n}\n\n\nFResult GuiType::get_Title(StrRet &aRetVal)\n{\n\tGUI_MUST_HAVE_HWND;\n\tint length = GetWindowTextLength(mHwnd);\n\tauto buf = aRetVal.Alloc(length);\n\tif (!buf)\n\t\treturn FR_E_OUTOFMEM;\n\tGetWindowText(mHwnd, buf, length+1);\n\treturn OK;\n}\n\n\nFResult GuiType::set_Title(StrArg aValue)\n{\n\tGUI_MUST_HAVE_HWND;\n\tSetWindowText(mHwnd, aValue);\n\treturn OK;\n}\n\n\nFResult GuiType::get___Item(ExprTokenType &aIndex, IObject *&aRetVal)\n{\n\tGUI_MUST_HAVE_HWND; // Seems clearer than relying on the error below.\n\tGuiControlType* ctrl = NULL;\n\tif (TokenIsPureNumeric(aIndex) == SYM_INTEGER)\n\t{\n\t\tHWND hWnd = (HWND)(UINT_PTR)TokenToInt64(aIndex);\n\t\tctrl = FindControl(hWnd);\n\t}\n\telse\n\t{\n\t\tTCHAR buf[MAX_NUMBER_SIZE];\n\t\tGuiIndexType u = FindControl(TokenToString(aIndex, buf));\n\t\tif (u < mControlCount)\n\t\t\tctrl = mControl[u];\n\t}\n\tif (!ctrl)\n\t\treturn FError(_T(\"The specified control does not exist.\"), nullptr, ErrorPrototype::UnsetItem);\n\n\tctrl->AddRef();\n\taRetVal = ctrl;\n\treturn OK;\n}\n\n\nFResult GuiType::get_FocusedCtrl(IObject *&aRetVal)\n{\n\tGUI_MUST_HAVE_HWND;\n\tHWND hwnd = GetFocus();\n\taRetVal = hwnd ? FindControl(hwnd) : nullptr;\n\tif (aRetVal)\n\t\taRetVal->AddRef();\n\treturn OK;\n}\n\n\nFResult GuiType::get_Margin(int &aRetVal, int &aMargin)\n{\n\tif (aMargin == COORD_UNSPECIFIED)\n\t{\n\t\t// Avoid returning an arbitrary value such as COORD_UNSPECIFIED or -1 (Unscale(COORD_UNSPECIFIED)).\n\t\t// Instead, set the default margins if MarginX or MarginY is queried without having first been set,\n\t\t// prior to adding any controls.\n\t\tSetDefaultMargins();\n\t}\n\taRetVal = Unscale(aMargin);\n\treturn OK;\n}\n\n\nFResult GuiType::get_BackColor(ResultToken &aResultToken)\n{\n\tGUI_MUST_HAVE_HWND;\n\tif (mBackgroundColorWin == CLR_DEFAULT)\n\t\treturn OK; // \"\" is the default return value.\n\t_sntprintf(_f_retval_buf, _f_retval_buf_size, _T(\"%06X\"), bgr_to_rgb(mBackgroundColorWin));\n\taResultToken.SetValue(_f_retval_buf);\n\treturn OK;\n}\n\n\nFResult GuiType::set_BackColor(ExprTokenType &aValue)\n{\n\tGUI_MUST_HAVE_HWND;\n\t\n\tCOLORREF new_color;\n\tif (!ColorToBGR(aValue, new_color))\n\t\treturn FValueError(ERR_INVALID_VALUE);\n\t\n\t// AssignColor() takes care of deleting old brush, etc.\n\tAssignColor(new_color, mBackgroundColorWin, mBackgroundBrushWin);\n\t\n\tif (IsWindowVisible(mHwnd))\n\t\t// Force the window to repaint so that colors take effect immediately.\n\t\t// UpdateWindow() isn't enough sometimes/always, so do something more aggressive:\n\t\tInvalidateRect(mHwnd, NULL, TRUE);\n\t\n\treturn OK;\n}\n\n\nFResult GuiType::get_Name(StrRet &aRetVal)\n{\n\taRetVal.SetTemp(mName); // Can safely be nullptr.\n\treturn OK;\n}\n\n\nFResult GuiType::set_Name(StrArg aName)\n{\n\tLPTSTR new_name = nullptr;\n\tif (*aName)\n\t{\n\t\tnew_name = _tcsdup(aName);\n\t\tif (!new_name)\n\t\t\treturn FR_E_OUTOFMEM;\n\t}\n\tfree(mName);\n\tmName = new_name;\n\treturn OK;\n}\n\n\nvoid GuiType::MethodGetPos(int *aX, int *aY, int *aWidth, int *aHeight, RECT &aPos, HWND aOrigin)\n{\n\t// Make coords relative to mOwner (like Move/Show) only if it is the parent window.\n\t// This call is also necessary for GetClientPos (which passes mHwnd for aOrigin).\n\tMapWindowPoints(aOrigin, (mStyle & WS_CHILD) ? mOwner : NULL, (LPPOINT)&aPos, 2);\n\t\n\tif (aX)\t\t\t*aX = aPos.left;\n\tif (aY)\t\t\t*aY = aPos.top;\n\tif (aWidth)\t\t*aWidth = Unscale(aPos.right - aPos.left);\n\tif (aHeight)\t*aHeight = Unscale(aPos.bottom - aPos.top);\n}\n\n\nFResult GuiType::GetPos(int *aX, int *aY, int *aWidth, int *aHeight)\n{\n\tGUI_MUST_HAVE_HWND;\n\tRECT rect;\n\tif (GetWindowRect(mHwnd, &rect))\n\t\tMethodGetPos(aX, aY, aWidth, aHeight, rect, NULL);\n\treturn OK;\n}\n\n\nFResult GuiType::GetClientPos(int *aX, int *aY, int *aWidth, int *aHeight)\n{\n\tGUI_MUST_HAVE_HWND;\n\tRECT rect;\n\tif (GetClientRect(mHwnd, &rect))\n\t\tMethodGetPos(aX, aY, aWidth, aHeight, rect, mHwnd);\n\treturn OK;\n}\n\n\nFResult GuiType::Move(optl<int> aX, optl<int> aY, optl<int> aWidth, optl<int> aHeight)\n{\n\tGUI_MUST_HAVE_HWND;\n\t// Like WinMove, this doesn't check if the window is minimized or do any autosizing.\n\t// Unlike WinMove, this does DPI scaling.\n\tRECT rect;\n\tGetWindowRect(mHwnd, &rect);\n\trect.right -= rect.left; // Convert to width.\n\trect.bottom -= rect.top; // Convert to height.\n\tif (HWND parent = GetParent(mHwnd)) // Allow for +Parent.\n\t\tScreenToClient(parent, (LPPOINT)&rect); // Must do this before the loop, as coord[] already contains client coords.\n\tif (aX.has_value())\t\t\trect.left = Scale(aX.value());\n\tif (aY.has_value())\t\t\trect.top = Scale(aY.value());\n\tif (aWidth.has_value())\t\trect.right = Scale(aWidth.value());\n\tif (aHeight.has_value())\trect.bottom = Scale(aHeight.value());\n\tMoveWindow(mHwnd, rect.left, rect.top, rect.right, rect.bottom, TRUE);\n\treturn OK;\n}\n\n\nbif_impl void GuiFromHwnd(UINT aHwnd, optl<BOOL> aRecurse, IObject *&aGui)\n{\n\tif (aGui = aRecurse.value_or(FALSE) ? GuiType::FindGuiParent((HWND)(UINT_PTR)aHwnd) : GuiType::FindGui((HWND)(UINT_PTR)aHwnd))\n\t\taGui->AddRef();\n}\n\n\nbif_impl void GuiCtrlFromHwnd(UINT aHwnd, IObject *&aGuiCtrl)\n{\n\tif (GuiType* gui = GuiType::FindGuiParent((HWND)(UINT_PTR)aHwnd))\n\t\tif (aGuiCtrl = gui->FindControl((HWND)(UINT_PTR)aHwnd))\n\t\t\taGuiCtrl->AddRef();\n}\n\n\nObjectMemberMd GuiControlType::sMembers[] =\n{\n\tmd_member(GuiControlType, Focus, CALL, md_arg_none),\n\tmd_member(GuiControlType, GetPos, CALL, (Out_Opt, Int32, X), (Out_Opt, Int32, Y), (Out_Opt, Int32, Width), (Out_Opt, Int32, Height)),\n\tmd_member(GuiControlType, Move, CALL, (In_Opt, Int32, X), (In_Opt, Int32, Y), (In_Opt, Int32, Width), (In_Opt, Int32, Height)),\n\tmd_member(GuiControlType, OnCommand, CALL, (In, Int32, NotifyCode), (In, Variant, Callback), (In_Opt, Int32, AddRemove)),\n\tmd_member(GuiControlType, OnEvent, CALL, (In, String, EventName), (In, Variant, Callback), (In_Opt, Int32, AddRemove)),\n\tmd_member(GuiControlType, OnMessage, CALL, (In, UInt32, Number), (In, Variant, Callback), (In_Opt, Int32, AddRemove)),\n\tmd_member(GuiControlType, OnNotify, CALL, (In, Int32, NotifyCode), (In, Variant, Callback), (In_Opt, Int32, AddRemove)),\n\tmd_member(GuiControlType, Opt, CALL, (In, String, Options)),\n\tmd_member(GuiControlType, Redraw, CALL, md_arg_none),\n\tmd_member(GuiControlType, SetFont, CALL, (In_Opt, String, Options), (In_Opt, String, FontName)),\n\t\n\tmd_property_get\t(GuiControlType, ClassNN, String),\n\tmd_property\t\t(GuiControlType, Enabled, Bool32),\n\tmd_property_get\t(GuiControlType, Focused, Bool32),\n\tmd_property_get\t(GuiControlType, Gui, Object),\n\tmd_property_get\t(GuiControlType, Hwnd, UInt32),\n\tmd_property\t\t(GuiControlType, Name, String),\n\tmd_property\t\t(GuiControlType, Text, Variant),\n\tmd_property_get\t(GuiControlType, Type, String),\n\tmd_property\t\t(GuiControlType, Value, Variant),\n\tmd_property\t\t(GuiControlType, Visible, Bool32)\n};\n\nObjectMemberMd GuiControlType::sMembersList[] =\n{\n\tmd_member_x(GuiControlType, Add, List_Add, CALL, (In, Variant, Value)),\n\tmd_member_x(GuiControlType, Choose, List_Choose, CALL, (In, Variant, Value)),\n\tmd_member_x(GuiControlType, Delete, List_Delete, CALL, (In_Opt, Int32, Index))\n};\n\nObjectMemberMd GuiControlType::sMembersTab[] =\n{\n\tmd_member_x(GuiControlType, UseTab, Tab_UseTab, CALL, (In_Opt, Variant, Tab), (In_Opt, Bool32, ExactMatch))\n};\n\nObjectMemberMd GuiControlType::sMembersDate[] =\n{\n\tmd_member_x(GuiControlType, SetFormat, DT_SetFormat, CALL, (In_Opt, String, Format))\n};\n\nObjectMemberMd GuiControlType::sMembersEdit[] =\n{\n\tmd_member_x(GuiControlType, SetCue, Edit_SetCue, CALL, (In, String, CueText), (In_Opt, Bool32, Activate))\n};\n\n#define FUN1(name, minp, maxp, bif) Object_Member(name, bif, 0, IT_CALL, minp, maxp)\n#define FUNn(name, minp, maxp, bif, cat) Object_Member(name, bif, FID_##cat##_##name, IT_CALL, minp, maxp)\n\nObjectMemberMd GuiControlType::sMembersLV[] =\n{\n\tmd_member_x(GuiControlType, GetNext, LV_GetNext, CALL, (In_Opt, Int32, StartIndex), (In_Opt, String, RowType), (Ret, Int32, RetVal)),\n\tmd_member_x(GuiControlType, GetCount, LV_GetCount, CALL, (In_Opt, String, Mode), (Ret, Int32, RetVal)),\n\tmd_member_x(GuiControlType, GetText, LV_GetText, CALL, (In, Int32, Row), (In_Opt, Int32, Column), (Ret, String, RetVal)),\n\tmd_member_x(GuiControlType, Add, LV_Add, CALL, (In_Opt, String, Options), (In, Params, Columns), (Ret, Int32, RetVal)),\n\tmd_member_x(GuiControlType, Insert, LV_Insert, CALL, (In, Int32, Row), (In_Opt, String, Options), (In, Params, Columns), (Ret, Int32, RetVal)),\n\tmd_member_x(GuiControlType, Modify, LV_Modify, CALL, (In, Int32, Row), (In_Opt, String, Options), (In, Params, Columns)),\n\tmd_member_x(GuiControlType, Delete, LV_Delete, CALL, (In_Opt, Int32, Row)),\n\tmd_member_x(GuiControlType, InsertCol, LV_InsertCol, CALL, (In_Opt, Int32, Column), (In_Opt, String, Options), (In_Opt, String, Title), (Ret, Int32, RetVal)),\n\tmd_member_x(GuiControlType, ModifyCol, LV_ModifyCol, CALL, (In_Opt, Int32, Column), (In_Opt, String, Options), (In_Opt, String, Title)),\n\tmd_member_x(GuiControlType, DeleteCol, LV_DeleteCol, CALL, (In, Int32, Column)),\n\tmd_member_x(GuiControlType, SetImageList, LV_SetImageList, CALL, (In, UIntPtr, ImageListID), (In_Opt, Int32, IconType), (Ret, UIntPtr, RetVal))\n};\n\nObjectMemberMd GuiControlType::sMembersTV[] =\n{\n\tmd_member_x(GuiControlType, Add, TV_Add, CALL, (In, String, Name), (In_Opt, UIntPtr, ParentItemID), (In_Opt, String, Options), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, Delete, TV_Delete, CALL, (In_Opt, UIntPtr, ItemID)),\n\tmd_member_x(GuiControlType, Get, TV_Get, CALL, (In, UIntPtr, ItemID), (In, String, Attribute), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, GetChild, TV_GetChild, CALL, (In, UIntPtr, ItemID), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, GetCount, TV_GetCount, CALL, (Ret, UInt32, RetVal)),\n\tmd_member_x(GuiControlType, GetNext, TV_GetNext, CALL, (In_Opt, UIntPtr, ItemID), (In_Opt, String, ItemType), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, GetParent, TV_GetParent, CALL, (In, UIntPtr, ItemID), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, GetPrev, TV_GetPrev, CALL, (In, UIntPtr, ItemID), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, GetSelection, TV_GetSelection, CALL, (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, GetText, TV_GetText, CALL, (In, UIntPtr, ItemID), (Ret, String, RetVal)),\n\tmd_member_x(GuiControlType, Modify, TV_Modify, CALL, (In, UIntPtr, ItemID), (In_Opt, String, Options), (In_Opt, String, NewName), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, SetImageList, TV_SetImageList, CALL, (In, UIntPtr, ImageListID), (In_Opt, Int32, IconType), (Ret, UIntPtr, RetVal))\n};\n\nObjectMemberMd GuiControlType::sMembersSB[] =\n{\n\tmd_member_x(GuiControlType, SetIcon, SB_SetIcon, CALL, (In, String, Filename), (In_Opt, Int32, IconNumber), (In_Opt, UInt32, PartNumber), (Ret, UIntPtr, RetVal)),\n\tmd_member_x(GuiControlType, SetParts, SB_SetParts, CALL, (In, Params, Filename), (Ret, UInt32, RetVal)),\n\tmd_member_x(GuiControlType, SetText, SB_SetText, CALL, (In, String, NewText), (In_Opt, UInt32, PartNumber), (In_Opt, UInt32, Style))\n};\n\nObjectMemberMd GuiControlType::sMembersCB[] =\n{\n\tmd_member_x(GuiControlType, SetCue, CB_SetCue, CALL, (In, String, CueText))\n};\n\n#undef FUN1\n#undef FUNn\n\nObject *GuiControlType::sPrototype;\nObject *GuiControlType::sPrototypeList;\nObject *GuiControlType::sPrototypes[GUI_CONTROL_TYPE_COUNT];\n\nvoid GuiControlType::DefineControlClasses()\n{\n\tauto gui_class = (Object *)g_script.FindGlobalVar(_T(\"Gui\"), 3)->Object();\n\n\tsPrototype = CreatePrototype(_T(\"Gui.Control\"), Object::sPrototype, sMembers, _countof(sMembers));\n\tsPrototypeList = CreatePrototype(_T(\"Gui.List\"), sPrototype, sMembersList, _countof(sMembersList));\n\tauto ctrl_class = CreateClass(sPrototype, Object::sClass);\n\tauto list_class = CreateClass(sPrototypeList, ctrl_class);\n\tgui_class->DefineClass(_T(\"Control\"), ctrl_class);\n\tgui_class->DefineClass(_T(\"List\"), list_class);\n\n\tfor (int i = GUI_CONTROL_INVALID + 1; i < GUI_CONTROL_TYPE_COUNT; ++i)\n\t{\n\t\tif (i == GUI_CONTROL_TAB2 || i == GUI_CONTROL_TAB3)\n\t\t\tcontinue;\n\n\t\t// Determine base prototype and control-type-specific members.\n\t\tObject *base_proto = sPrototype, *base_class = ctrl_class;\n\t\tObjectMemberListType more_items;\n\t\tint how_many = 0;\n\t\tswitch (i)\n\t\t{\n\t\tcase GUI_CONTROL_TAB: more_items = sMembersTab; how_many = _countof(sMembersTab); break;\n\t\tcase GUI_CONTROL_COMBOBOX: more_items = sMembersCB; how_many = _countof(sMembersCB); break;\n\t\tcase GUI_CONTROL_DATETIME: more_items = sMembersDate; how_many = _countof(sMembersDate); break;\n\t\tcase GUI_CONTROL_EDIT: more_items = sMembersEdit; how_many = _countof(sMembersEdit); break;\n\t\tcase GUI_CONTROL_LISTVIEW: more_items = sMembersLV; how_many = _countof(sMembersLV); break;\n\t\tcase GUI_CONTROL_TREEVIEW: more_items = sMembersTV; how_many = _countof(sMembersTV); break;\n\t\tcase GUI_CONTROL_STATUSBAR: more_items = sMembersSB; how_many = _countof(sMembersSB); break;\n\t\t}\n\t\tswitch (i)\n\t\t{\n\t\tcase GUI_CONTROL_TAB:\n\t\tcase GUI_CONTROL_COMBOBOX:\n\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\tcase GUI_CONTROL_LISTBOX: base_proto = sPrototypeList; base_class = list_class; break;\n\t\t}\n\t\tTCHAR buf[32];\n\t\t_sntprintf(buf, 32, _T(\"Gui.%s\"), sTypeNames[i]);\n\t\tsPrototypes[i] = CreatePrototype(buf, base_proto, more_items, how_many);\n\t\tauto cls = CreateClass(sPrototypes[i]);\n\t\tcls->SetBase(base_class);\n\t\tgui_class->DefineClass(sTypeNames[i], cls);\n\t}\n}\n\nObject *GuiControlType::GetPrototype(GuiControls aType)\n{\n\tASSERT(aType <= _countof(sPrototypes));\n\tif (aType == GUI_CONTROL_TAB2 || aType == GUI_CONTROL_TAB3)\n\t\taType = GUI_CONTROL_TAB; // Just make them all Gui.Tab.\n\treturn sPrototypes[aType];\n}\n\n\nFResult GuiControlType::Focus()\n{\n\tCTRL_THROW_IF_DESTROYED;\n\t// MSDN: \"WM_NEXTDLGCTL updates the default pushbutton border, sets the default control identifier,\n\t// and automatically selects the text of an edit control (if the target window is an edit control).\"\n\t// (It also sets the focus.)\n\tSendMessage(gui->mHwnd, WM_NEXTDLGCTL, (WPARAM)hwnd, TRUE);\n\treturn OK;\n}\n\n\nFResult GuiControlType::GetPos(int *aX, int *aY, int *aWidth, int *aHeight)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\t\n\tRECT rect;\n\tGetWindowRect(hwnd, &rect);\n\tMapWindowPoints(NULL, gui->mHwnd, (LPPOINT)&rect, 2);\n\t\n\tif (aX)\t\t\t*aX = gui->Unscale(rect.left);\n\tif (aY)\t\t\t*aY = gui->Unscale(rect.top);\n\tif (aWidth)\t\t*aWidth = gui->Unscale(rect.right - rect.left);\n\tif (aHeight)\t*aHeight = gui->Unscale(rect.bottom - rect.top);\n\t\n\treturn OK;\n}\n\n\nFResult GuiControlType::Move(optl<int> aX, optl<int> aY, optl<int> aWidth, optl<int> aHeight)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->ControlMove(*this, aX.value_or(COORD_UNSPECIFIED), aY.value_or(COORD_UNSPECIFIED), aWidth.value_or(COORD_UNSPECIFIED), aHeight.value_or(COORD_UNSPECIFIED));\n}\n\n\nFResult GuiControlType::OnCommand(int aNotifyCode, ExprTokenType &aCallback, optl<int> aAddRemove)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->OnEvent(this, aNotifyCode, GUI_EVENTKIND_COMMAND, aCallback, aAddRemove);\n}\n\n\nFResult GuiControlType::OnEvent(StrArg aEventName, ExprTokenType &aCallback, optl<int> aAddRemove)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tUINT event_code = GuiType::ConvertEvent(aEventName);\n\tif (!event_code || !SupportsEvent(event_code))\n\t\treturn FR_E_ARG(0);\n\treturn gui->OnEvent(this, event_code, GUI_EVENTKIND_EVENT, aCallback, aAddRemove);\n}\n\n\nFResult GuiControlType::OnMessage(UINT aNumber, ExprTokenType &aCallback, optl<int> aAddRemove)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->OnEvent(this, aNumber, GUI_EVENTKIND_MESSAGE, aCallback, aAddRemove);\n}\n\n\nFResult GuiControlType::OnNotify(int aNotifyCode, ExprTokenType &aCallback, optl<int> aAddRemove)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->OnEvent(this, aNotifyCode, GUI_EVENTKIND_NOTIFY, aCallback, aAddRemove);\n}\n\n\nFResult GuiControlType::Opt(StrArg aOptions)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tGuiControlOptionsType go; // Its contents are not currently used here, but they might be in the future.\n\tgui->ControlInitOptions(go, *this);\n\tif (!gui->ControlParseOptions(aOptions, go, *this, GUI_HWND_TO_INDEX(hwnd)))\n\t\treturn FR_FAIL;\n\treturn OK;\n}\n\n\nFResult GuiControlType::Redraw()\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tRECT rect;\n\tGetWindowRect(hwnd, &rect); // Limit it to only that part of the client area that the control occupies.\n\tMapWindowPoints(NULL, gui->mHwnd, (LPPOINT)&rect, 2); // Convert rect to client coordinates (not the same as GetClientRect()).\n\tInvalidateRect(gui->mHwnd, &rect, TRUE); // Seems safer to use TRUE, not knowing all possible overlaps, etc.\n\treturn OK;\n}\n\n\nFResult GuiControlType::SetFont(optl<StrArg> aOptions, optl<StrArg> aFontName)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->ControlSetFont(*this, aOptions.value_or_empty(), aFontName.value_or_empty()) ? OK : FR_FAIL;\n}\n\n\nFResult GuiControlType::get_ClassNN(StrRet &aRetVal)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tTCHAR class_nn[WINDOW_CLASS_NN_SIZE];\n\tauto fr = ControlGetClassNN(gui->mHwnd, hwnd, class_nn, _countof(class_nn));\n\treturn fr != OK ? fr : aRetVal.Copy(class_nn) ? OK : FR_E_OUTOFMEM;\n}\n\n\nFResult GuiControlType::get_Enabled(BOOL &aRetVal)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\taRetVal = IsWindowEnabled(hwnd) ? 1 : 0;\n\treturn OK;\n}\n\n\nFResult GuiControlType::set_Enabled(BOOL aValue)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tgui->ControlSetEnabled(*this, aValue);\n\treturn OK;\n}\n\n\nFResult GuiControlType::get_Focused(BOOL &aRetVal)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tHWND focus = GetFocus();\n\t// For controls like ComboBox and ActiveX that may have a focused child window,\n\t// also co nsider the control focused if any child of the control is focused.\n\taRetVal = (focus == hwnd || IsChild(hwnd, focus));\n\treturn OK;\n}\n\n\nFResult GuiControlType::get_Gui(IObject *&aRetVal)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tgui->AddRef();\n\taRetVal = gui;\n\treturn OK;\n}\n\n\nFResult GuiControlType::get_Hwnd(UINT &aRetVal)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\taRetVal = (UINT)(UINT_PTR)hwnd;\n\treturn OK;\n}\n\n\nFResult GuiControlType::get_Name(StrRet &aRetVal)\n{\n\taRetVal.SetTemp(name); // Can safely be nullptr.\n\treturn OK;\n}\n\n\nFResult GuiControlType::set_Name(StrArg aValue)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->ControlSetName(*this, aValue);\n}\n\n\nFResult GuiControlType::get_Text(ResultToken &aResultToken)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tgui->ControlGetContents(aResultToken, *this, GuiType::Text_Mode);\n\treturn aResultToken.Exited() ? FR_FAIL : OK;\n}\n\n\nFResult GuiControlType::set_Text(ExprTokenType &aValue)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->ControlSetContents(*this, aValue, true);\n}\n\n\nFResult GuiControlType::get_Type(StrRet &aRetVal)\n{\n\taRetVal.SetStatic(GetTypeName());\n\treturn OK;\n}\n\n\nFResult GuiControlType::get_Value(ResultToken &aResultToken)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tgui->ControlGetContents(aResultToken, *this, GuiType::Value_Mode);\n\treturn aResultToken.Exited() ? FR_FAIL : OK;\n}\n\n\nFResult GuiControlType::set_Value(ExprTokenType &aValue)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->ControlSetContents(*this, aValue, false);\n}\n\n\nFResult GuiControlType::get_Visible(BOOL &aRetVal)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\t// Return the requested visibility state, not the actual state, which would\n\t// be affected by the parent window's visiblity and currently selected tab.\n\taRetVal = (attrib & GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN) ? 0 : 1;\n\treturn OK;\n}\n\n\nFResult GuiControlType::set_Visible(BOOL aValue)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tgui->ControlSetVisible(*this, aValue);\n\treturn OK;\n}\n\nFResult GuiControlType::CB_SetCue(StrArg aCueText)\n{\n\treturn SendMessage(hwnd, CB_SETCUEBANNER, 0, (LPARAM)aCueText) ? OK : FR_E_FAILED;\n}\n\nFResult GuiControlType::Edit_SetCue(StrArg aCueText, optl<BOOL> aShowWhenFocused)\n{\n\treturn SendMessage(hwnd, EM_SETCUEBANNER, aShowWhenFocused.value_or(FALSE), (LPARAM)aCueText) ? OK : FR_E_FAILED;\n}\n\nFResult GuiControlType::Tab_UseTab(ExprTokenType *aTab, optl<BOOL> aExact)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tBOOL whole_match = aExact.value_or(FALSE);\n\tint index; // int vs TabControlIndexType for detection of negative/out-of-range values.\n\tif (!aTab)\n\t\tindex = -1;\n\telse if (TokenIsPureNumeric(*aTab) == SYM_INTEGER)\n\t\tindex = (int)TokenToInt64(*aTab) - 1; // Convert to zero-based and let 0 indicate \"no tab\" (-1).\n\telse\n\t{\n\t\tTCHAR float_buf[MAX_NUMBER_SIZE];\n\t\tauto tab_name = TokenToString(*aTab, float_buf);\n\t\tindex = gui->FindTabIndexByName(*this, tab_name, whole_match);\n\t\tif (index == -1 && *tab_name) // Invalid tab name (but \"\" is a valid way to specify \"no tab\").\n\t\t\tindex = -2; // Flag it as invalid.\n\t}\n\t// Validate parameters before making any changes to the Gui's state:\n\tif (index < -1 || index >= MAX_TABS_PER_CONTROL)\n\t\treturn FR_E_ARG(0);\n\n\tTabIndexType prev_tab_index = gui->mCurrentTabIndex;\n\tTabControlIndexType prev_tab_control_index = gui->mCurrentTabControlIndex;\n\n\tif (index == -1)\n\t\tgui->mCurrentTabControlIndex = MAX_TAB_CONTROLS; // i.e. \"no tab\"\n\telse\n\t{\n\t\tgui->mCurrentTabControlIndex = tab_index;\n\t\tif (gui->mCurrentTabIndex != index)\n\t\t{\n\t\t\tgui->mCurrentTabIndex = index;\n\t\t\t// Changing to a different tab should start a new radio group:\n\t\t\tgui->mInRadioGroup = false;\n\t\t}\n\t}\n\tif (gui->mCurrentTabControlIndex != prev_tab_control_index)\n\t{\n\t\tif (GuiControlType *tab_control = gui->FindTabControl(prev_tab_control_index))\n\t\t{\n\t\t\t// Autosize the previous tab control. Has no effect if it is not a Tab3 control or has\n\t\t\t// already been autosized. Doing it at this point allows the script to set different\n\t\t\t// margins for inside and outside the tab control, and is simpler than the alternative:\n\t\t\t// waiting until the next external control is added. The main drawback is that the\n\t\t\t// script is unable to alternate between tab controls and still utilize autosizing.\n\t\t\t// On the flip side, scripts can use this to their advantage -- to add controls which\n\t\t\t// should not affect the tab control's size.\n\t\t\tgui->AutoSizeTabControl(*tab_control);\n\t\t}\n\t\t// Changing to a different tab control (or none at all when there\n\t\t// was one before, or vice versa) should start a new radio group:\n\t\tgui->mInRadioGroup = false;\n\t}\n\treturn OK;\n}\n\n\nFResult GuiControlType::List_Add(ExprTokenType &aItems)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tauto obj = TokenToArray(aItems);\n\tif (!obj)\n\t\treturn FParamError(0, &aItems, _T(\"Array\"));\n\tgui->ControlAddItems(*this, obj);\n\tif (type == GUI_CONTROL_TAB)\n\t{\n\t\t// Adding tabs may change the space usable by the tab dialog.\n\t\tgui->UpdateTabDialog(hwnd);\n\t\t// Appears to be necessary to resolve a redraw issue, at least for Tab3 on Windows 10.\n\t\tInvalidateRect(gui->mHwnd, NULL, TRUE);\n\t}\n\treturn OK;\n}\n\n\nFResult GuiControlType::List_Delete(optl<int> aIndex)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tUINT msg_one;\n\tUINT msg_all;\n\tswitch (type)\n\t{\n\tcase GUI_CONTROL_TAB: msg_one = TCM_DELETEITEM; msg_all = TCM_DELETEALLITEMS; break;\n\tcase GUI_CONTROL_LISTBOX: msg_one = LB_DELETESTRING; msg_all = LB_RESETCONTENT; break;\n\tdefault: msg_one = CB_DELETESTRING; msg_all = CB_RESETCONTENT; break; // ComboBox/DDL.\n\t}\n\tif (aIndex.has_value()) // Delete item with given index.\n\t{\n\t\tint index = aIndex.value() - 1;\n\t\tif (index < 0)\n\t\t\treturn FR_E_ARG(0);\n\t\tSendMessage(hwnd, msg_one, (WPARAM)index, 0);\n\t}\n\telse // Delete all items.\n\t{\n\t\tSendMessage(hwnd, msg_all, 0, 0);\n\t}\n\tif (type == GUI_CONTROL_TAB)\n\t{\n\t\t// Removing tabs may change the space usable by the tab dialog.\n\t\tgui->UpdateTabDialog(hwnd);\n\t}\n\treturn OK;\n}\n\n\nGuiType *GuiType::FindGui(HWND aHwnd)\n{\n\t// Check that this window is an AutoHotkey Gui.\n\tATOM atom = (ATOM)GetClassLong(aHwnd, GCW_ATOM);\n\tif (atom != sGuiWinClass)\n\t\treturn NULL;\n\n\t// Retrieve the GuiType object associated to it.\n\treturn (GuiType*)GetWindowLongPtr(aHwnd, GWLP_USERDATA);\n}\n\n\nGuiType *GuiType::FindGuiParent(HWND aHwnd)\n// Returns the GuiType of aHwnd or its closest ancestor which is a Gui.\n{\n\tfor ( ; aHwnd; aHwnd = GetParent(aHwnd))\n\t{\n\t\tif (GuiType *gui = FindGui(aHwnd))\n\t\t\treturn gui;\n\t\tif (!(GetWindowLong(aHwnd, GWL_STYLE) & WS_CHILD))\n\t\t\tbreak;\n\t}\n\treturn NULL;\n}\n\n\nFResult GuiType::get_MenuBar(ResultToken &aResultToken)\n{\n\tGUI_MUST_HAVE_HWND;\n\tif (mMenu)\n\t{\n\t\tmMenu->AddRef();\n\t\taResultToken.Return(mMenu);\n\t}\n\treturn OK;\n}\n\n\nFResult GuiType::set_MenuBar(ExprTokenType &aParam)\n{\n\tGUI_MUST_HAVE_HWND;\n\tUserMenu *menu = NULL;\n\tif (!TokenIsEmptyString(aParam))\n\t{\n\t\tmenu = dynamic_cast<UserMenu *>(TokenToObject(aParam));\n\t\tif (!menu || menu->mMenuType != MENU_TYPE_BAR)\n\t\t\treturn FTypeError(_T(\"MenuBar\"), aParam);\n\t\tmenu->CreateHandle(); // Ensure the menu bar physically exists.\n\t\tmenu->AddRef();\n\t}\n\tif (mMenu)\n\t\tmMenu->Release();\n\tmMenu = menu;\n\t::SetMenu(mHwnd, menu ? menu->mMenu : NULL); // Add or remove the menu.\n\tif (menu) // v1.1.04: Keyboard accelerators.\n\t\tUpdateAccelerators(*menu);\n\telse\n\t\tRemoveAccelerators();\n\treturn OK;\n}\n\n\nFResult GuiType::ControlSetName(GuiControlType &aControl, LPCTSTR aName)\n{\n\tLPTSTR new_name = nullptr;\n\tif (aName && *aName)\n\t{\n\t\t// Make sure the name isn't already taken.\n\t\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t\t\tif (mControl[u]->name && !_tcsicmp(mControl[u]->name, aName))\n\t\t\t{\n\t\t\t\tif (mControl[u] == &aControl) // aControl already has this name, but upper- vs lower-case may differ.\n\t\t\t\t\tbreak;\n\t\t\t\treturn FError(_T(\"A control with this name already exists.\"), aName);\n\t\t\t}\n\n\t\tnew_name = _tcsdup(aName);\n\t\tif (!new_name)\n\t\t\treturn FR_E_OUTOFMEM;\n\t}\n\tif (aControl.name)\n\t\tfree(aControl.name);\n\taControl.name = new_name;\n\treturn OK;\n}\n\n\nvoid GuiType::ControlSetEnabled(GuiControlType &aControl, bool aEnabled)\n{\n\tGuiControlType *tab_control;\n\tint selection_index;\n\n\t// GUI_CONTROL_ATTRIB_EXPLICITLY_DISABLED is maintained for use with tab controls. It allows controls\n\t// on inactive tabs to be marked for later enabling. It also allows explicitly disabled controls to\n\t// stay disabled even when their tab/page becomes active. It is updated unconditionally for simplicity\n\t// and maintainability. \n\tif (aEnabled)\n\t\taControl.attrib &= ~GUI_CONTROL_ATTRIB_EXPLICITLY_DISABLED;\n\telse\n\t\taControl.attrib |= GUI_CONTROL_ATTRIB_EXPLICITLY_DISABLED;\n\tif (tab_control = FindTabControl(aControl.tab_control_index)) // It belongs to a tab control that already exists.\n\t{\n\t\tif (GetWindowLong(tab_control->hwnd, GWL_STYLE) & WS_DISABLED) // But its tab control is disabled...\n\t\t\treturn;\n\t\tselection_index = TabCtrl_GetCurSel(tab_control->hwnd);\n\t\tif (selection_index != aControl.tab_index && selection_index != -1)\n\t\t\t// There is no current tab/page or the one selected is not this control's:\n\t\t\t// Do not disable or re-enable the control in this case.\n\t\t\t// v1.0.48.04: Above now also checks for -1, which is a tab control containing zero tabs/pages.\n\t\t\t// The controls on such a tab control might be wrongly/inadvertently visible because\n\t\t\t// ControlUpdateCurrentTab() isn't capable of handling that situation. Since fixing\n\t\t\t// ControlUpdateCurrentTab() would reduce backward compatibility -- and in case anyone is\n\t\t\t// using tabless tab controls for anything -- it seems best to allow these \"wrongly visible\"\n\t\t\t// controls to be explicitly manipulated by GuiControl Enable/Disable and Hide/Show.\n\t\t\t// UPDATE: ControlUpdateCurrentTab() has been fixed, so the controls won't be visible\n\t\t\t// unless the script specifically made them so. The check is kept in case it is of\n\t\t\t// some use. Prior to the fix, the controls would have only been visible if the tab\n\t\t\t// control previously had a tab but it was deleted, since controls are created in a\n\t\t\t// hidden state if the tab they are on is not selected.\n\t\t\treturn;\n\t}\n\t\t\n\t// L23: Restrict focus workaround to when the control is/was actually focused. Fixes a bug introduced by L13: enabling or disabling a control caused the active Edit control to reselect its text.\n\tbool gui_control_was_focused = GetForegroundWindow() == mHwnd && GetFocus() == aControl.hwnd;\n\n\t// Since above didn't return, act upon the enabled/disable:\n\tEnableWindow(aControl.hwnd, aEnabled);\n\t\t\n\t// L23: Only if EnableWindow removed the keyboard focus entirely, reset the focus.\n\tif (gui_control_was_focused && !GetFocus())\n\t\tSetFocus(mHwnd);\n\t\t\n\tif (aControl.type == GUI_CONTROL_TAB) // This control is a tab control.\n\t\t// Update the control so that its current tab's controls will all be enabled or disabled (now\n\t\t// that the tab control itself has just been enabled or disabled):\n\t\tControlUpdateCurrentTab(aControl, false);\n}\n\n\n\nvoid GuiType::ControlSetVisible(GuiControlType &aControl, bool aVisible)\n{\n\tGuiControlType *tab_control;\n\tint selection_index;\n\n\t// GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN is maintained for use with tab controls. It allows controls\n\t// on inactive tabs to be marked for later showing. It also allows explicitly hidden controls to\n\t// stay hidden even when their tab/page becomes active. It is updated unconditionally for simplicity\n\t// and maintainability.\n\tif (aVisible)\n\t\taControl.attrib &= ~GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN;\n\telse\n\t\taControl.attrib |= GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN;\n\tif (tab_control = FindTabControl(aControl.tab_control_index)) // It belongs to a tab control that already exists.\n\t{\n\t\tif (!(GetWindowLong(tab_control->hwnd, GWL_STYLE) & WS_VISIBLE)) // But its tab control is hidden...\n\t\t\treturn;\n\t\tselection_index = TabCtrl_GetCurSel(tab_control->hwnd);\n\t\tif (selection_index != aControl.tab_index && selection_index != -1)\n\t\t\treturn; // v1.0.48.04: Concerning the line above, see comments in ControlSetEnabled.\n\t}\n\t// Since above didn't return, act upon the show/hide:\n\tShowWindow(aControl.hwnd, aVisible ? SW_SHOWNOACTIVATE : SW_HIDE);\n\tif (aControl.type == GUI_CONTROL_TAB) // This control is a tab control.\n\t\t// Update the control so that its current tab's controls will all be shown or hidden (now\n\t\t// that the tab control itself has just been shown or hidden):\n\t\tControlUpdateCurrentTab(aControl, false);\n}\n\n\nFResult GuiType::ControlMove(GuiControlType &aControl, int xpos, int ypos, int width, int height)\n{\n\tRECT rect;\n\tGetWindowRect(aControl.hwnd, &rect); // Failure seems too rare to check for.\n\tPOINT dest_pt = {rect.left, rect.top};\n\tScreenToClient(mHwnd, &dest_pt); // Set default x/y target position, to be possibly overridden below.\n\tif (xpos != COORD_UNSPECIFIED)\n\t\tdest_pt.x = Scale(xpos);\n\tif (ypos != COORD_UNSPECIFIED)\n\t\tdest_pt.y = Scale(ypos);\n\t\n\t// Map to the GUI window's client area (inverse of GetPos) in case the\n\t// GUI window isn't the control's parent, such as if it is on a Tab3.\n\tMapWindowPoints(mHwnd, GetParent(aControl.hwnd), &dest_pt, 1);\n\n\tif (!MoveWindow(aControl.hwnd, dest_pt.x, dest_pt.y\n\t\t, width == COORD_UNSPECIFIED ? rect.right - rect.left : Scale(width)\n\t\t, height == COORD_UNSPECIFIED ? rect.bottom - rect.top : Scale(height)\n\t\t, TRUE)) // Do repaint.\n\t\treturn FR_E_WIN32;\n\n\t// Note that GUI_CONTROL_UPDOWN has no special handling here. This is because unlike slider buddies,\n\t// whose only purpose is to label the control, an up-down's is also content-linked to it, so the\n\t// inability to move the up-down to separate it from its buddy would be a loss of flexibility. For\n\t// this reason and also to reduce code size, the control is not re-buddied to snap them together.\n\tif (aControl.type == GUI_CONTROL_SLIDER) // It seems buddies don't move automatically, so trigger the move.\n\t{\n\t\tHWND buddy1 = (HWND)SendMessage(aControl.hwnd, TBM_GETBUDDY, TRUE, 0);\n\t\tHWND buddy2 = (HWND)SendMessage(aControl.hwnd, TBM_GETBUDDY, FALSE, 0);\n\t\tif (buddy1)\n\t\t{\n\t\t\tSendMessage(aControl.hwnd, TBM_SETBUDDY, TRUE, (LPARAM)buddy1);\n\t\t\t// It doesn't always redraw the buddies correctly, at least on XP, so do it manually:\n\t\t\tInvalidateRect(buddy1, NULL, TRUE);\n\t\t}\n\t\tif (buddy2)\n\t\t{\n\t\t\tSendMessage(aControl.hwnd, TBM_SETBUDDY, FALSE, (LPARAM)buddy2);\n\t\t\tInvalidateRect(buddy2, NULL, TRUE);\n\t\t}\n\t}\n\telse if (aControl.type == GUI_CONTROL_TAB)\n\t{\n\t\t// Check for autosizing flags on this Tab control.\n\t\tint mask = (width == COORD_UNSPECIFIED ? 0 : TAB3_AUTOWIDTH)\n\t\t\t| (height == COORD_UNSPECIFIED ? 0 : TAB3_AUTOHEIGHT);\n\t\tint autosize = (int)(INT_PTR)GetProp(aControl.hwnd, _T(\"ahk_autosize\"));\n\t\tif (autosize & mask) // There are autosize flags to unset (implies this is a Tab3 control).\n\t\t{\n\t\t\tautosize &= ~mask; // Unset the flags corresponding to dimensions we've just set.\n\t\t\tif (autosize)\n\t\t\t\tSetProp(aControl.hwnd, _T(\"ahk_autosize\"), (HANDLE)(INT_PTR)autosize);\n\t\t\telse\n\t\t\t\tRemoveProp(aControl.hwnd, _T(\"ahk_autosize\"));\n\t\t}\n\t}\n\treturn OK;\n}\n\n\nResultType GuiType::ControlSetFont(GuiControlType &aControl, LPCTSTR aOptions, LPCTSTR aFontName)\n{\n\tif (!aControl.UsesFontAndTextColor()) // Control has no use for a font.\n\t\treturn g_script.RuntimeError(ERR_GUI_NOT_FOR_THIS_TYPE);\n\tCOLORREF color = CLR_INVALID;\n\tint font_index;\n\tif (*aOptions || *aFontName) // Use specified font.\n\t{\n\t\tFontType font;\n\t\t// Get control's current font, to inherit attributes.\n\t\tfont.hfont = (HFONT)SendMessage(aControl.hwnd, WM_GETFONT, 0, 0);\n\t\tFontGetAttributes(font);\n\n\t\t// Find or create font with the changed attributes.\n\t\tfont_index = FindOrCreateFont(aOptions, aFontName, &font, &color);\n\t\tif (font_index == -1)\n\t\t\treturn FAIL;\n\t}\n\telse // Use GUI's current font.\n\t{\n\t\tfont_index = mCurrentFontIndex;\n\t\t// It seems more correct to leave the control's current color, since there's\n\t\t// no way to know whether it should take precedence over the GUI's text color.\n\t\t// Require the caller to be explicit and specify the color if it should be changed.\n\t\t//color = mCurrentColor;\n\t}\n\tSendMessage(aControl.hwnd, WM_SETFONT, (WPARAM)sFont[font_index].hfont, 0);\n\tif (color != CLR_INVALID)\n\t\tControlSetTextColor(aControl, color);\n\tControlRedraw(aControl, false); // Required for refresh, at least for edit controls, probably some others.\n\treturn OK;\n}\n\n\nvoid GuiType::ControlSetTextColor(GuiControlType &aControl, COLORREF aColor)\n{\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_LISTVIEW:\n\t\t// Although MSDN doesn't say, ListView_SetTextColor() appears to support CLR_DEFAULT.\n\t\tListView_SetTextColor(aControl.hwnd, aColor);\n\t\tbreak;\n\tcase GUI_CONTROL_TREEVIEW:\n\t\t// Must pass -1 rather than CLR_DEFAULT for TreeView controls.\n\t\tTreeView_SetTextColor(aControl.hwnd, aColor == CLR_DEFAULT ? -1 : aColor);\n\t\tbreak;\n\tcase GUI_CONTROL_DATETIME:\n\t\tControlSetMonthCalColor(aControl, aColor, DTM_SETMCCOLOR);\n\t\tbreak;\n\tcase GUI_CONTROL_MONTHCAL:\n\t\tControlSetMonthCalColor(aControl, aColor, MCM_SETCOLOR);\n\t\tbreak;\n\tdefault:\n\t\tif (aControl.UsesUnionColor()) // For maintainability. Overlaps with previous checks.\n\t\t\taControl.union_color = aColor; // Used by WM_CTLCOLORSTATIC et. al. for some types of controls.\n\t\tbreak;\n\t}\n}\n\n\nvoid GuiType::ControlSetMonthCalColor(GuiControlType &aControl, COLORREF aColor, UINT aMsg)\n{\n\t// Testing shows that changing the COLOR_WINDOWTEXT system color affects MonthCal\n\t// controls, but passing CLR_DEFAULT always sets the color to black regardless.\n\t// MSDN doesn't seem to specify any way to revert to defaults.\n\tif (aColor == CLR_DEFAULT)\n\t\taColor = GetSysColor(COLOR_WINDOWTEXT);\n\tSendMessage(aControl.hwnd, aMsg, MCSC_TEXT, aColor);\n}\n\n\nResultType GuiType::ControlChoose(GuiControlType &aControl, ExprTokenType &aParam, BOOL aOneExact)\n{\n\tint selection_index = -1;\n\tbool is_choose_string = true;\n\tswitch (TypeOfToken(aParam))\n\t{\n\tcase SYM_INTEGER: is_choose_string = false; break;\n\tcase SYM_OBJECT: goto error;\n\t}\n\tTCHAR buf[MAX_NUMBER_SIZE];\n\t\n\tUINT msg_set_index = 0, msg_select_string = 0, msg_find_string = 0;\n\tswitch(aControl.type)\n\t{\n\tcase GUI_CONTROL_TAB:\n\t\tmsg_set_index = TCM_SETCURSEL;\n\t\tbreak;\n\tcase GUI_CONTROL_DROPDOWNLIST:\n\tcase GUI_CONTROL_COMBOBOX:\n\t\tmsg_set_index = CB_SETCURSEL;\n\t\tif (aOneExact)\n\t\t\tmsg_find_string = CB_FINDSTRINGEXACT;\n\t\telse\n\t\t\tmsg_select_string = CB_SELECTSTRING;\n\t\tbreak;\n\tcase GUI_CONTROL_LISTBOX:\n\t\tif (GetWindowLong(aControl.hwnd, GWL_STYLE) & (LBS_EXTENDEDSEL|LBS_MULTIPLESEL))\n\t\t{\n\t\t\t// MSDN: Do not use [LB_SELECTSTRING] with a list box that has the LBS_MULTIPLESEL or the\n\t\t\t// LBS_EXTENDEDSEL styles:\n\t\t\tmsg_set_index = LB_SETSEL;\n\t\t\tmsg_find_string = aOneExact ? LB_FINDSTRINGEXACT : LB_FINDSTRING;\n\t\t}\n\t\telse // single-select listbox\n\t\t{\n\t\t\tmsg_set_index = LB_SETCURSEL;\n\t\t\tif (aOneExact)\n\t\t\t\tmsg_find_string = LB_FINDSTRINGEXACT;\n\t\t\telse\n\t\t\t\tmsg_select_string = LB_SELECTSTRING;\n\t\t}\n\t\tbreak;\n\tdefault: // Not a supported control type.\n\t\t// This shouldn't be possible due to checking of type elsewhere.\n\t\t//return g_script.RuntimeError(ERR_GUI_NOT_FOR_THIS_TYPE); // Disabled to reduce code size.\n\t\tASSERT(!\"invalid control type\");\n\t\tgoto error; // Seems better than returning OK, for the off chance this can happen.\n\t} // switch(control.type)\n\n\tLPTSTR item_string;\n\tif (is_choose_string)\n\t{\n\t\titem_string = TokenToString(aParam, buf);\n\t\t// Testing confirms that the CB and LB messages do not interpret an empty string\n\t\t// as the first item. It seems best for \"\" to deselect the current item/tab.\n\t\tif (!*item_string)\n\t\t{\n\t\t\tselection_index = -1;\n\t\t}\n\t\telse if (msg_select_string)\n\t\t{\n\t\t\tif (SendMessage(aControl.hwnd, msg_select_string, -1, (LPARAM)item_string) == CB_ERR) // CB_ERR == LB_ERR\n\t\t\t\tgoto error;\n\t\t\treturn OK;\n\t\t}\n\t\telse if (msg_find_string)\n\t\t{\n\t\t\tLRESULT found_item = SendMessage(aControl.hwnd, msg_find_string, -1, (LPARAM)item_string);\n\t\t\tif (found_item == LB_ERR) // CB_ERR == LB_ERR\n\t\t\t\tgoto error;\n\t\t\tselection_index = (int)found_item;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tASSERT(aControl.type == GUI_CONTROL_TAB);\n\t\t\tselection_index = FindTabIndexByName(aControl, item_string, aOneExact); // Returns -1 on failure.\n\t\t\tif (selection_index == -1)\n\t\t\t\tgoto error;\n\t\t}\n\t}\n\telse // Choose by position vs. string.\n\t{\n\t\tselection_index = (int)TokenToInt64(aParam) - 1;\n\t\tif (selection_index < -1)\n\t\t\tgoto error;\n\t}\n\tif (msg_set_index == LB_SETSEL) // Multi-select, so use the cumulative method.\n\t{\n\t\tif (aOneExact && selection_index >= 0) // But when selection_index == -1, it would be redundant.\n\t\t\tSendMessage(aControl.hwnd, msg_set_index, FALSE, -1); // Deselect all others.\n\t\tSendMessage(aControl.hwnd, msg_set_index, selection_index >= 0, selection_index);\n\t\t// The return value isn't checked since MSDN doesn't specify what it is in any\n\t\t// case other than failure.\n\t\tif (is_choose_string)\n\t\t{\n\t\t\t// Since this ListBox is multi-select, select ALL matching items:\n\t\t\tfor (;;)\n\t\t\t{\n\t\t\t\tint found_item = (int)SendMessage(aControl.hwnd, msg_find_string, selection_index, (LPARAM)item_string);\n\t\t\t\t// MSDN: \"When the search reaches the bottom of the list box, it continues\n\t\t\t\t// searching from the top of the list box back to the item specified by the\n\t\t\t\t// wParam parameter.\" So if there are no more results, it will return the\n\t\t\t\t// original index found above, not -1.\n\t\t\t\tif (found_item <= selection_index) // The search has looped.\n\t\t\t\t\tbreak;\n\t\t\t\tselection_index = found_item;\n\t\t\t\tSendMessage(aControl.hwnd, LB_SETSEL, TRUE, selection_index);\n\t\t\t}\n\t\t}\n\t}\n\telse\n\t{\n\t\tint result = (int)SendMessage(aControl.hwnd, msg_set_index, selection_index, 0);\n\t\tif (msg_set_index == TCM_SETCURSEL)\n\t\t{\n\t\t\tif (result == -1)\n\t\t\t{\n\t\t\t\tif (SendMessage(aControl.hwnd, TCM_GETCURSEL, 0, 0) != selection_index)\n\t\t\t\t\tgoto error;\n\t\t\t\t// Otherwise, it's on the right tab, so maybe result == -1 because there\n\t\t\t\t// was previously no tab selected.\n\t\t\t}\n\t\t\tif (result != selection_index)\n\t\t\t\tControlUpdateCurrentTab(aControl, false);\n\t\t}\n\t\telse if (result == -1 && selection_index != -1)\n\t\t\tgoto error;\n\t}\n\treturn OK;\n\nerror:\n\treturn ValueError(aOneExact ? ERR_INVALID_VALUE : ERR_PARAM1_INVALID, nullptr, FAIL_OR_OK); // Invalid parameter #1 is almost definitely the cause.\n}\n\nFResult GuiControlType::List_Choose(ExprTokenType &aValue)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\treturn gui->ControlChoose(*this, aValue) ? OK : FR_FAIL;\n}\n\n\nFResult GuiType::ControlSetContents(GuiControlType &aControl, ExprTokenType &aValue, bool aIsText)\n// aContents: The content as a string.\n// aResultToken: Used only to set an exit result in the event of an error.\n{\n\tif (TokenToObject(aValue))\n\t\treturn FR_E_ARG(0); // Generic error because unsure which type is expected.\n\tTCHAR buf[MAX_NUMBER_SIZE];\n\tLPTSTR aContents = TokenToString(aValue, buf);\n\t// Control types for which Text and Value both have special handling:\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_DROPDOWNLIST:\n\tcase GUI_CONTROL_COMBOBOX:\n\tcase GUI_CONTROL_LISTBOX:\n\tcase GUI_CONTROL_TAB:\n\t\treturn ControlSetChoice(aControl, aContents, aIsText);\n\n\tcase GUI_CONTROL_EDIT:\n\t\treturn ControlSetEdit(aControl, aContents, aIsText);\n\n\tcase GUI_CONTROL_DATETIME:\n\t\tif (aIsText)\n\t\t\treturn FError(ERR_GUI_NOT_FOR_THIS_TYPE); // Let the user know the control doesn't support this.\n\t\telse\n\t\t\treturn ControlSetDateTime(aControl, aContents);\n\n\tcase GUI_CONTROL_TEXT:\n\t\t// It seems sensible to treat the caption text of a Text control as its \"value\",\n\t\t// since displaying text is its only purpose; it's just for output only, whereas\n\t\t// an Edit control can be for input or output.\n\t\taIsText = true;\n\t\tbreak;\n\t}\n\t// The remaining control types have no need for special handling of the Text property,\n\t// either because they have normal caption text, or because they have no \"text version\"\n\t// of the value, or no \"value\" at all.\n\tif (aIsText)\n\t{\n\t\tSetWindowText(aControl.hwnd, aContents);\n\t\tif (aControl.background_color == CLR_TRANSPARENT) // +BackgroundTrans\n\t\t\tControlRedraw(aControl);\n\t\treturn OK;\n\t}\n\t// Otherwise, this is the Value property.\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_PIC: return ControlSetPic(aControl, aContents);\n\tcase GUI_CONTROL_MONTHCAL: return ControlSetMonthCal(aControl, aContents);\n\tcase GUI_CONTROL_HOTKEY: return ControlSetHotkey(aControl, aContents);\n\n\tcase GUI_CONTROL_RADIO: // Same as below.\n\tcase GUI_CONTROL_CHECKBOX:\n\tcase GUI_CONTROL_UPDOWN:\n\tcase GUI_CONTROL_SLIDER:\n\tcase GUI_CONTROL_PROGRESS:\n\t{\n\t\tif (!TokenIsNumeric(aValue))\n\t\t\treturn FTypeError(_T(\"Number\"), aValue);\n\t\tint value = (int)TokenToInt64(aValue);\n\t\tswitch (aControl.type)\n\t\t{\n\t\tcase GUI_CONTROL_UPDOWN: return ControlSetUpDown(aControl, value);\n\t\tcase GUI_CONTROL_SLIDER: return ControlSetSlider(aControl, value);\n\t\tcase GUI_CONTROL_PROGRESS: return ControlSetProgress(aControl, value);\n\t\tcase GUI_CONTROL_RADIO: // Same as below.\n\t\tcase GUI_CONTROL_CHECKBOX: return ControlSetCheck(aControl, value);\n\t\t}\n\t}\n\n\t// Already handled in the switch() above:\n\t//case GUI_CONTROL_DATETIME:\n\t//case GUI_CONTROL_DROPDOWNLIST:\n\t//case GUI_CONTROL_COMBOBOX:\n\t//case GUI_CONTROL_LISTBOX:\n\t//case GUI_CONTROL_TAB:\n\t//case GUI_CONTROL_TEXT:\n\n\tcase GUI_CONTROL_LINK:\n\tcase GUI_CONTROL_GROUPBOX:\n\tcase GUI_CONTROL_BUTTON:\n\tcase GUI_CONTROL_STATUSBAR:\n\t\t// Above: The control has no \"value\". GuiControl.Text should be used to set its text.\n\tcase GUI_CONTROL_LISTVIEW: // More flexible methods are available.\n\tcase GUI_CONTROL_TREEVIEW: // More flexible methods are available.\n\tcase GUI_CONTROL_CUSTOM: // Don't know what this control's \"value\" is or how to set it.\n\tcase GUI_CONTROL_ACTIVEX: // Assigning a value doesn't make sense. SetWindowText() does nothing.\n\tdefault: // Should help code size by allowing the compiler to omit checks for the above cases.\n\t\treturn FError(ERR_INVALID_USAGE);\n\t}\n}\n\n\nFResult GuiType::ControlSetPic(GuiControlType &aControl, LPTSTR aContents)\n{\n\t// Update: The below doesn't work, so it will be documented that a picture control\n\t// should be always be referred to by its original filename even if the picture changes.\n\t// Set the text unconditionally even if the picture can't be loaded. This text must\n\t// be set to allow GuiControl(Get) to be able to operate upon the picture without\n\t// needing to identify it via something like \"Static14\".\n\t//SetWindowText(control.hwnd, aContents);\n\t//SendMessage(control.hwnd, WM_SETTEXT, 0, (LPARAM)aContents);\n\n\t// Set default options, to be possibly overridden by any options actually present:\n\t// Fixed for v1.0.23: Below should use GetClientRect() vs. GetWindowRect(), otherwise\n\t// a size too large will be returned if the control has a border:\n\tRECT rect;\n\tGetClientRect(aControl.hwnd, &rect);\n\tint width = rect.right - rect.left;\n\tint height = rect.bottom - rect.top;\n\tint icon_number = 0; // Zero means \"load icon or bitmap (doesn't matter)\".\n\t// Note that setting the control's picture handle to NULL sometimes or always shrinks\n\t// the control down to zero dimensions, so must be done only after the above.\n\n\t// Parse any options that are present in front of the filename:\n\tLPTSTR next_option = omit_leading_whitespace(aContents);\n\tif (*next_option == '*') // Options are present. Must check this here and in the for-loop to avoid omitting legitimate whitespace in a filename that starts with spaces.\n\t{\n\t\tLPTSTR option_end;\n\t\tTCHAR orig_char;\n\t\tfor (; *next_option == '*'; next_option = omit_leading_whitespace(option_end))\n\t\t{\n\t\t\t// Find the end of this option item:\n\t\t\tif ( !(option_end = StrChrAny(next_option, _T(\" \\t\"))) ) // Space or tab.\n\t\t\t\toption_end = next_option + _tcslen(next_option); // Set to position of zero terminator instead.\n\t\t\t// Permanently terminate in between options to help eliminate ambiguity for words contained\n\t\t\t// inside other words, and increase confidence in decimal and hexadecimal conversion.\n\t\t\torig_char = *option_end;\n\t\t\t*option_end = '\\0';\n\t\t\t++next_option; // Skip over the asterisk. It might point to a zero terminator now.\n\t\t\tif (!_tcsnicmp(next_option, _T(\"Icon\"), 4))\n\t\t\t\ticon_number = ATOI(next_option + 4); // LoadPicture() correctly handles any negative value.\n\t\t\telse\n\t\t\t{\n\t\t\t\tswitch (ctoupper(*next_option))\n\t\t\t\t{\n\t\t\t\tcase 'W':\n\t\t\t\t\twidth = ATOI(next_option + 1);\n\t\t\t\t\tbreak;\n\t\t\t\tcase 'H':\n\t\t\t\t\theight = ATOI(next_option + 1);\n\t\t\t\t\tbreak;\n\t\t\t\t// If not one of the above, such as zero terminator or a number, just ignore it.\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t*option_end = orig_char; // Undo the temporary termination so that loop's omit_leading() will work.\n\t\t} // for() each item in option list\n\n\t\t// The below assigns option_end + 1 vs. next_option in case the filename is contained in a\n\t\t// variable ref and/ that filename contains leading spaces. Example:\n\t\t// GuiControl,, MyPic, *w100 *h-1 %FilenameWithLeadingSpaces%\n\t\t// Update: Windows XP and perhaps other OSes will load filenames-containing-leading-spaces\n\t\t// even if those spaces are omitted. However, I'm not sure whether all API calls that\n\t\t// use filenames do this, so it seems best to include those spaces whenever possible.\n\t\taContents = *option_end ? option_end + 1 : option_end; // Set aContents to the start of the image's filespec.\n\t} \n\t//else options are not present, so do not set aContents to be next_option because that would\n\t// omit legitimate spaces and tabs that might exist at the beginning of a real filename (file\n\t// names can start with spaces).\n\n\t// See comments in ControlLoadPicture():\n\tif (!ControlLoadPicture(aControl, aContents, width, height, icon_number))\n\t\treturn FValueError(ERR_INVALID_VALUE, aContents); // A bit vague but probably correct.\n\n\t// Redraw is usually only needed for pictures in a tab control, but is sometimes\n\t// needed outside of that, for .gif and perhaps others. So redraw unconditionally:\n\tControlRedraw(aControl);\n\treturn OK;\n}\n\n\nFResult GuiType::ControlSetCheck(GuiControlType &aControl, int checked)\n{\n\tif ( !(checked == 0 || checked == 1 || (aControl.type == GUI_CONTROL_CHECKBOX && checked == -1)) )\n\t\treturn FValueError(ERR_INVALID_VALUE);\n\tif (checked == -1)\n\t\tchecked = BST_INDETERMINATE;\n\t//else the \"checked\" var is already set correctly.\n\tif (aControl.type == GUI_CONTROL_RADIO)\n\t{\n\t\tControlCheckRadioButton(aControl, GUI_HWND_TO_INDEX(aControl.hwnd), checked);\n\t\treturn OK;\n\t}\n\t// Otherwise, we're operating upon a checkbox.\n\tSendMessage(aControl.hwnd, BM_SETCHECK, checked, 0);\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetCheck(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\tswitch (SendMessage(aControl.hwnd, BM_GETCHECK, 0, 0))\n\t{\n\tcase BST_CHECKED:\n\t\t_o_return(1);\n\tcase BST_UNCHECKED:\n\t\t_o_return(0);\n\tcase BST_INDETERMINATE:\n\t\t// Seems better to use a value other than blank because blank might sometimes represent the\n\t\t// state of an uninitialized or unfetched control. In other words, a blank variable often\n\t\t// has an external meaning that transcends the more specific meaning often desirable when\n\t\t// retrieving the state of the control:\n\t\t_o_return(-1);\n\t}\n\t// Shouldn't be reached since ZERO(BST_UNCHECKED) is returned on failure.\n}\n\n\nFResult GuiType::ControlSetChoice(GuiControlType &aControl, LPTSTR aContents, bool aIsText)\n{\n\tExprTokenType choice;\n\tif (aIsText)\n\t{\n\t\tif (aControl.type == GUI_CONTROL_COMBOBOX)\n\t\t{\n\t\t\t// Use the simple SetWindowText() method, which works on the ComboBox's Edit.\n\t\t\t// Clearing the current selection isn't strictly necessary since ControlGetContents()\n\t\t\t// compensates for the index being inaccurate (due to other possible causes), but it\n\t\t\t// might help in some situations. If it's not done, CB_GETCURSEL will return the\n\t\t\t// previous selection. By contrast, a user typing in the box always sets it to -1.\n\t\t\tSendMessage(aControl.hwnd, CB_SETCURSEL, -1, 0);\n\t\t\tSetWindowText(aControl.hwnd, aContents);\n\t\t\treturn OK;\n\t\t}\n\t\tchoice.symbol = SYM_STRING;\n\t\tchoice.marker = aContents;\n\t}\n\telse // (!aIsText)\n\t{\n\t\tif (!ParseInteger(aContents, choice.value_int64))\n\t\t\treturn FError(ERR_INVALID_VALUE, nullptr, ErrorPrototype::Type);\n\t\tchoice.symbol = SYM_INTEGER;\n\t}\n\treturn ControlChoose(aControl, choice, TRUE) ? OK : FR_FAIL; // Pass TRUE to find an exact (not partial) match.\n}\n\n\nvoid GuiType::ControlGetDDL(ResultToken &aResultToken, GuiControlType &aControl, ValueModeType aMode)\n{\n\tLRESULT index;\n\tif (aMode == Value_Mode || (aMode == Submit_Mode && (aControl.attrib & GUI_CONTROL_ATTRIB_ALTSUBMIT))) // Caller wants the position, not the text.\n\t{\n\t\tindex = SendMessage(aControl.hwnd, CB_GETCURSEL, 0, 0); // Get index of currently selected item.\n\t\t// If there's no item selected (the default state, and also possible by Value:=0\n\t\t// or Text:=\"\"), index is -1 (CB_ERR). Since Value:=0 is valid and Value:=\"\"\n\t\t// is not, return 0 in that case. MSDN: \"If no item is selected, it is CB_ERR.\"\n\t\t_o_return((int)index + 1);\n\t}\n\tControlGetWindowText(aResultToken, aControl);\n}\n\n\nvoid GuiType::ControlGetComboBox(ResultToken &aResultToken, GuiControlType &aControl, ValueModeType aMode)\n{\n\tLRESULT index = SendMessage(aControl.hwnd, CB_GETCURSEL, 0, 0); // Get index of currently selected item.\n\n\t// Problem #1:\n\t// It seems that any text put into a ComboBox's edit field by typing/pasting or via Ctrl.Text\n\t// always resets the current index to -1, even if that text exactly matches an existing item.\n\n\t// Problem #2:\n\t// CB_GETCURSEL sometimes returns an index which doesn't match what's in the Edit control.\n\t// This typically happens as a result of typing/pasting while the drop-down window is visible\n\t// and then canceling the dropdown without making a selection.\n\t// Note that when the CBN_SELENDCANCEL notification is received, CB_GETCURSEL correctly returns -1,\n\t// but at some point after that the control restores the index to a possibly incorrect value. This\n\t// appears to happen in other programs as well, and has been confirmed on Windows 10 and earlier.\n\n\tint edit_length = GetWindowTextLength(aControl.hwnd); // Zero is valid (the control may be empty).\n\t// For simplicity and in case the text is very large, use tmalloc() unconditionally\n\t// even though the text is probably very small. This allocation may be returned below.\n\tLPTSTR edit_text = tmalloc(edit_length + 1);\n\tif (!edit_text)\n\t\t_o_throw_oom;\n\tedit_length = GetWindowText(aControl.hwnd, edit_text, edit_length + 1);\n\tif (index != CB_ERR)\n\t{\n\t\t// The control returned a valid index, so verify that it matches the edit text.\n\t\t// If a search beginning at the indicated item does not return that item, it must\n\t\t// not be a match. This approach avoids retrieving the item's text, which reduces\n\t\t// code size. Performance hasn't been measured, but at a guess, is probably better\n\t\t// when the item matches (as it would 99.9% of the time), and worse in other cases.\n\t\tif (!edit_length)\n\t\t{\n\t\t\t// A different approach is needed in this case since CB_FINDSTRINGEXACT can't\n\t\t\t// search for an empty string. This preserves the ability to detect selection\n\t\t\t// of a specific empty list item, though for simplicity, clearing the edit text\n\t\t\t// will not match up to an empty list item.\n\t\t\tif (0 != SendMessage(aControl.hwnd, CB_GETLBTEXTLEN, (WPARAM)index, 0))\n\t\t\t\tindex = CB_ERR;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (index != SendMessage(aControl.hwnd, CB_FINDSTRINGEXACT, index - 1, (LPARAM)edit_text))\n\t\t\t\tindex = CB_ERR;\n\t\t}\n\t}\n\tif (index == CB_ERR)\n\t{\n\t\t// Check if the Edit field contains text that exactly matches one of the items in the drop-list.\n\t\t// If it does, that item's position should be retrieved in AltSubmit mode (even for non-AltSubmit\n\t\t// mode, this should be done because the case of the item in the drop-list is usually preferable\n\t\t// to any varying case the user may have manually typed).\n\t\tindex = SendMessage(aControl.hwnd, CB_FINDSTRINGEXACT, -1, (LPARAM)edit_text); // It's not case sensitive.\n\t\tif (index == CB_ERR && aMode != Value_Mode) // Text or Submit mode.\n\t\t{\n\t\t\t// edit_text does not match any of the list items, so just return the text.\n\t\t\taResultToken.AcceptMem(edit_text, edit_length);\n\t\t\t_o_return_retval;\n\t\t}\n\t}\n\tfree(edit_text);\n\n\tif (aMode == Value_Mode || (aMode == Submit_Mode && (aControl.attrib & GUI_CONTROL_ATTRIB_ALTSUBMIT))) // Caller wants the position, not the text.\n\t\t_o_return((int)index + 1);\n\n\tLRESULT length = SendMessage(aControl.hwnd, CB_GETLBTEXTLEN, (WPARAM)index, 0);\n\tif (length == CB_ERR) // Given the way it was called, this should be impossible based on MSDN docs.\n\t\t_o_return_empty; // Return empty string (default).\n\t// In unusual cases, MSDN says the indicated length might be longer than it actually winds up\n\t// being when the item's text is retrieved. This should be harmless, since there are many\n\t// other precedents where a variable is sized to something larger than it winds up carrying.\n\tif (!TokenSetResult(aResultToken, NULL, length))\n\t\treturn; // It already displayed the error.\n\tlength = SendMessage(aControl.hwnd, CB_GETLBTEXT, (WPARAM)index, (LPARAM)aResultToken.marker);\n\tif (length == CB_ERR) // Given the way it was called, this should be impossible based on MSDN docs.\n\t\t_o_return_p(_T(\"\"), 0); // Must use this vs _o_return_empty to override TokenSetResult.\n\t_o_return_retval;\n}\n\n\nvoid GuiType::ControlGetListBox(ResultToken &aResultToken, GuiControlType &aControl, ValueModeType aMode)\n{\n\tbool position_mode = (aMode == Value_Mode || (aMode == Submit_Mode && (aControl.attrib & GUI_CONTROL_ATTRIB_ALTSUBMIT)));\n\tif (GetWindowLong(aControl.hwnd, GWL_STYLE) & (LBS_EXTENDEDSEL|LBS_MULTIPLESEL))\n\t{\n\t\tLRESULT sel_count = SendMessage(aControl.hwnd, LB_GETSELCOUNT, 0, 0);\n\t\tif (sel_count < 1) // <=0 to check for LB_ERR too (but it should be impossible in this case).\n\t\t\t_o_return_empty;\n\t\tint *item = (int *)malloc(sel_count * sizeof(int)); // dynamic since there can be a very large number of items.\n\t\tif (!item)\n\t\t\t_o_throw_oom;\n\t\tsel_count = SendMessage(aControl.hwnd, LB_GETSELITEMS, (WPARAM)sel_count, (LPARAM)item);\n\t\tif (sel_count < 1) // 0 or LB_ERR, but both these conditions should be impossible in this case.\n\t\t{\n\t\t\tfree(item);\n\t\t\t_o_return_empty;\n\t\t}\n\n\t\t// Create object for storing the selected items.\n\t\tauto ret = Array::Create();\n\t\tif (!ret)\n\t\t{\n\t\t\tfree(item);\n\t\t\t_o_throw_oom;\n\t\t}\n\n\t\tfor (LRESULT length = sel_count - 1, i = 0; i < sel_count; ++i)\n\t\t{\n\t\t\tif (position_mode) // Caller wants the positions, not the text.\n\t\t\t\tret->Append(item[i] + 1); // +1 to convert from zero-based to 1-based.\n\t\t\telse // Store item text vs. position.\n\t\t\t{\n\t\t\t\tLRESULT item_length = SendMessage(aControl.hwnd, LB_GETTEXTLEN, (WPARAM)item[i], 0);\n\t\t\t\tif (item_length == LB_ERR) // Realistically impossible based on MSDN.\n\t\t\t\t{\n\t\t\t\t\tfree(item);\n\t\t\t\t\tret->Release();\n\t\t\t\t\t_o_throw(_T(\"LB_GETTEXTLEN\")); // Short msg since so rare.\n\t\t\t\t}\n\t\t\t\tLPTSTR temp = tmalloc(item_length+1);\n\t\t\t\tif (!temp)\n\t\t\t\t{\n\t\t\t\t\tfree(item);\n\t\t\t\t\tret->Release();\n\t\t\t\t\t_o_throw_oom; // Short msg since so rare.\n\t\t\t\t}\n\t\t\t\tLRESULT lr = SendMessage(aControl.hwnd, LB_GETTEXT, (WPARAM)item[i], (LPARAM)temp);\n\t\t\t\tif (lr > 0) // Given the way it was called, LB_ERR (-1) should be impossible based on MSDN docs.\n\t\t\t\t\tret->Append(temp, item_length);\n\t\t\t\tfree(temp);\n\t\t\t}\n\t\t}\n\n\t\tfree(item);\n\t\t_o_return(ret);\n\t}\n\telse // Single-select ListBox style.\n\t{\n\t\tLRESULT index = SendMessage(aControl.hwnd, LB_GETCURSEL, 0, 0); // Get index of currently selected item.\n\t\tif (position_mode) // Caller wants the position, not the text.\n\t\t\t_o_return((int)index + 1); // 0 if no selection.\n\t\tif (index == LB_ERR) // There is no selection (or very rarely, some other type of problem).\n\t\t\t_o_return_empty;\n\t\tLRESULT length = SendMessage(aControl.hwnd, LB_GETTEXTLEN, (WPARAM)index, 0);\n\t\tif (length == LB_ERR // Given the way it was called, this should be impossible based on MSDN docs.\n\t\t\t|| length == 0)\n\t\t\t_o_return_empty;\n\t\tif (!TokenSetResult(aResultToken, NULL, length))\n\t\t\treturn; // It already displayed the error.\n\t\tlength = SendMessage(aControl.hwnd, LB_GETTEXT, (WPARAM)index, (LPARAM)aResultToken.marker);\n\t\tif (length == LB_ERR) // Given the way it was called, this should be impossible based on MSDN docs.\n\t\t{\n\t\t\t*aResultToken.marker = 0; // Clear the buffer returned by TokenSetResult.\n\t\t\taResultToken.marker_length = 0;\n\t\t}\n\t}\n\t_o_return_retval;\n}\n\n\nFResult GuiType::ControlSetEdit(GuiControlType &aControl, LPTSTR aContents, bool aIsText)\n{\n\t// Auto-translate LF to CRLF if this is the \"Value\" property of a multi-line Edit control.\n\t// Note that TranslateLFtoCRLF() will return the original buffer we gave it if no translation\n\t// is needed. Otherwise, it will return a new buffer which we are responsible for freeing\n\t// when done (or NULL if it failed to allocate the memory).\n\tLPTSTR malloc_buf = (!aIsText && (GetWindowLong(aControl.hwnd, GWL_STYLE) & ES_MULTILINE))\n\t\t? TranslateLFtoCRLF(aContents) : aContents; // Automatic translation, as documented.\n\tif (!malloc_buf)\n\t\treturn FR_E_OUTOFMEM;\n\t// Users probably don't want or expect the control's event handler to be triggered by this\n\t// action, so suppress it. This makes single-line Edits consistent with all other controls.\n\taControl.attrib |= GUI_CONTROL_ATTRIB_SUPPRESS_EVENTS; // Disable events.\n\t// Set the new content.\n\tSetWindowText(aControl.hwnd, malloc_buf);\n\t// WM_SETTEXT and WM_COMMAND are sent, not posted, so it's certain that the EN_CHANGE\n\t// notification (if any) has been received and discarded. MsgSleep() is not needed.\n\taControl.attrib &= ~GUI_CONTROL_ATTRIB_SUPPRESS_EVENTS; // Enable events.\n\tif (malloc_buf != aContents)\n\t\tfree(malloc_buf);\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetEdit(ResultToken &aResultToken, GuiControlType &aControl)\n// Only called by Edit.Value, so aTranslateEOL == true is implied.\n{\n\tif (!ControlGetWindowText(aResultToken, aControl))\n\t\treturn;\n\tif (GetWindowLong(aControl.hwnd, GWL_STYLE) & ES_MULTILINE) // For consistency with ControlSetEdit().\n\t{\n\t\t// Auto-translate CRLF to LF for better compatibility with other script commands.\n\t\t// Since edit controls tend to have many hard returns in them, use SCS_SENSITIVE to\n\t\t// enhance performance. This performance gain is extreme when the control contains\n\t\t// thousands of CRLFs:\n\t\tStrReplace(aResultToken.marker, _T(\"\\r\\n\"), _T(\"\\n\"), SCS_SENSITIVE\n\t\t\t, -1, -1, NULL, &aResultToken.marker_length); // Pass &marker_length to improve performance and (more importantly) update it.\n\t}\n}\n\n\nFResult GuiType::ControlSetDateTime(GuiControlType &aControl, LPTSTR aContents)\n{\n\tSYSTEMTIME st;\n\tif (*aContents)\n\t{\n\t\tif (YYYYMMDDToSystemTime(aContents, st, true))\n\t\t\tDateTime_SetSystemtime(aControl.hwnd, GDT_VALID, &st);\n\t\telse\n\t\t\treturn FValueError(ERR_INVALID_VALUE, aContents);\n\t}\n\telse // User wants there to be no date selection.\n\t{\n\t\t// Ensure the DTS_SHOWNONE style is present, otherwise it won't work. However,\n\t\t// it appears that this style cannot be applied after the control is created, so\n\t\t// this line is commented out:\n\t\t//SetWindowLong(aControl.hwnd, GWL_STYLE, GetWindowLong(aControl.hwnd, GWL_STYLE) | DTS_SHOWNONE);\n\t\tDateTime_SetSystemtime(aControl.hwnd, GDT_NONE, &st); // Contents of st are ignored in this mode.\n\t}\n\treturn OK;\n}\n\n\nFResult GuiControlType::DT_SetFormat(optl<StrArg> aFormat)\n{\n\tCTRL_THROW_IF_DESTROYED;\n\tbool use_custom_format = false; // Set default.\n\t// Reset style to \"pure\" so that new style (or custom format) can take effect.\n\tDWORD style = GetWindowLong(hwnd, GWL_STYLE) // DTS_SHORTDATEFORMAT==0 so can be omitted below.\n\t\t& ~(DTS_LONGDATEFORMAT | DTS_SHORTDATECENTURYFORMAT | DTS_TIMEFORMAT);\n\tif (aFormat.has_nonempty_value())\n\t{\n\t\t// DTS_SHORTDATEFORMAT and DTS_SHORTDATECENTURYFORMAT\n\t\t// seem to produce identical results (both display 4-digit year), at least on XP. Perhaps\n\t\t// DTS_SHORTDATECENTURYFORMAT is obsolete. In any case, it's uncommon so for simplicity, is\n\t\t// not a named style. It can always be applied numerically if desired. Update:\n\t\t// DTS_SHORTDATECENTURYFORMAT is now applied by default upon creation, which can be overridden\n\t\t// explicitly via -0x0C in the control's options.\n\t\tif (!_tcsicmp(aFormat.value(), _T(\"LongDate\"))) // LongDate seems more readable than \"Long\". It also matches the keyword used by FormatTime.\n\t\t\tstyle |= DTS_LONGDATEFORMAT; // Competing styles were already purged above.\n\t\telse if (!_tcsicmp(aFormat.value(), _T(\"Time\")))\n\t\t\tstyle |= DTS_TIMEFORMAT; // Competing styles were already purged above.\n\t\telse if (!_tcsicmp(aFormat.value(), _T(\"ShortDate\")))\n\t\t{} // No change needed since DTS_SHORTDATEFORMAT is 0 and competing styles were already purged above.\n\t\telse // Custom format.\n\t\t\tuse_custom_format = true;\n\t}\n\t//else aText is blank and use_custom_format==false, which will put DTS_SHORTDATEFORMAT into effect.\n\tif (!use_custom_format)\n\t\tSetWindowLong(hwnd, GWL_STYLE, style);\n\t//else leave style unchanged so that if format is later removed, the underlying named style will\n\t// not have been altered.\n\tDateTime_SetFormat(hwnd, use_custom_format ? aFormat.value() : NULL); // NULL removes any custom format so that the underlying style format is revealed.\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetDateTime(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\tLPTSTR buf = aResultToken.buf;\n\tSYSTEMTIME st;\n\t_o_return_p(DateTime_GetSystemtime(aControl.hwnd, &st) == GDT_VALID\n\t\t? SystemTimeToYYYYMMDD(buf, st) : _T(\"\")); // Blank string whenever GDT_NONE/GDT_ERROR.\n}\n\n\nFResult GuiType::ControlSetMonthCal(GuiControlType &aControl, LPTSTR aContents)\n{\n\tSYSTEMTIME st[2];\n\tDWORD gdtr = YYYYMMDDToSystemTime2(aContents, st);\n\tif (!gdtr) // aContents is empty or invalid (it's not meaningful to set an empty value).\n\t\treturn FValueError(ERR_INVALID_VALUE, aContents);\n\tif (GetWindowLong(aControl.hwnd, GWL_STYLE) & MCS_MULTISELECT) // Must use range-selection even if selection is only one date.\n\t{\n\t\tif (gdtr == GDTR_MIN) // No maximum is present, so set maximum to minimum.\n\t\t\tst[1] = st[0];\n\t\t//else both are present.\n\t\tMonthCal_SetSelRange(aControl.hwnd, st);\n\t}\n\telse\n\t\tMonthCal_SetCurSel(aControl.hwnd, st);\n\tControlRedraw(aControl, true); // Confirmed necessary.\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetMonthCal(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\tLPTSTR buf = aResultToken.buf;\n\tSYSTEMTIME st[2];\n\tif (GetWindowLong(aControl.hwnd, GWL_STYLE) & MCS_MULTISELECT)\n\t{\n\t\t// For code simplicity and due to the expected rarity of using the MonthCal control, much less\n\t\t// in its range-select mode, the range is returned with a dash between the min and max rather\n\t\t// than as an array or anything fancier.\n\t\tMonthCal_GetSelRange(aControl.hwnd, st);\n\t\t// Seems easier for script (due to consistency) to always return it in range format, even if\n\t\t// only one day is selected.\n\t\tSystemTimeToYYYYMMDD(buf, st[0]);\n\t\tbuf[8] = '-'; // Retain only the first 8 chars to omit the time portion, which is unreliable (not relevant anyway).\n\t\tSystemTimeToYYYYMMDD(buf + 9, st[1]);\n\t\tbuf[17] = 0; // Limit to 17 chars to omit the time portion of the second timestamp.\n\t}\n\telse\n\t{\n\t\tMonthCal_GetCurSel(aControl.hwnd, st);\n\t\tSystemTimeToYYYYMMDD(buf, st[0]);\n\t\tbuf[8] = 0; // Limit to 8 chars to omit the time portion, which is unreliable (not relevant anyway).\n\t}\n\t_o_return_p(buf);\n}\n\n\nFResult GuiType::ControlSetHotkey(GuiControlType &aControl, LPTSTR aContents)\n{\n\tSendMessage(aControl.hwnd, HKM_SETHOTKEY, TextToHotkey(aContents), 0); // This will set it to \"None\" if aContents is blank.\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetHotkey(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\tLPTSTR buf = aResultToken.buf;\n\t// Testing shows that neither GetWindowText() nor WM_GETTEXT can pull anything out of a hotkey\n\t// control, so the only type of retrieval that can be offered is the HKM_GETHOTKEY method:\n\tHotkeyToText((WORD)SendMessage(aControl.hwnd, HKM_GETHOTKEY, 0, 0), buf);\n\t_o_return_p(buf);\n}\n\n\nFResult GuiType::ControlSetUpDown(GuiControlType &aControl, int new_pos)\n{\n\t// MSDN: \"If the parameter is outside the control's specified range, nPos will be set to the nearest\n\t// valid value.\"\n\tSendMessage(aControl.hwnd, UDM_SETPOS32, 0, new_pos);\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetUpDown(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\t// Any out of range or non-numeric value in the buddy is ignored since error reporting is\n\t// left up to the script, which can compare contents of buddy to those of UpDown to check\n\t// validity if it wants.\n\tint pos = (int)SendMessage(aControl.hwnd, UDM_GETPOS32, 0, 0);\n\t_o_return(pos);\n}\n\n\nFResult GuiType::ControlSetSlider(GuiControlType &aControl, int aValue)\n{\n\t// Confirmed this fact from MSDN: That the control automatically deals with out-of-range values\n\t// by setting slider to min or max:\n\tSendMessage(aControl.hwnd, TBM_SETPOS, TRUE, ControlInvertSliderIfNeeded(aControl, aValue));\n\t// Above msg has no return value.\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetSlider(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\t_o_return(ControlInvertSliderIfNeeded(aControl, (int)SendMessage(aControl.hwnd, TBM_GETPOS, 0, 0)));\n\t// Above assigns it as a signed value because testing shows a slider can have part or all of its\n\t// available range consist of negative values. 32-bit values are supported if the range is set\n\t// with the right messages.\n}\n\n\nFResult GuiType::ControlSetProgress(GuiControlType &aControl, int aValue)\n{\n\t// Confirmed through testing (PBM_DELTAPOS was also tested): The control automatically deals\n\t// with out-of-range values by setting bar to min or max. \n\tSendMessage(aControl.hwnd, PBM_SETPOS, aValue, 0);\n\treturn OK;\n}\n\n\nvoid GuiType::ControlGetProgress(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\t_o_return((int)SendMessage(aControl.hwnd, PBM_GETPOS, 0, 0));\n}\n\n\nvoid GuiType::ControlGetTab(ResultToken &aResultToken, GuiControlType &aControl, ValueModeType aMode)\n{\n\tLPTSTR buf = aResultToken.buf;\n\tLRESULT index = TabCtrl_GetCurSel(aControl.hwnd); // Get index of currently selected item.\n\tif (aMode == Value_Mode || (aMode == Submit_Mode && (aControl.attrib & GUI_CONTROL_ATTRIB_ALTSUBMIT))) // Caller wants the index, not the text.\n\t\t_o_return((int)index + 1); // 0 if no selection.\n\tif (index == -1) // There is no selection.\n\t\t_o_return_empty;\n\t// Otherwise: Get the stored name/caption of this tab:\n\tTCITEM tci;\n\ttci.mask = TCIF_TEXT;\n\ttci.pszText = buf;\n\ttci.cchTextMax = _f_retval_buf_size-1; // MSDN example uses -1.\n\tif (TabCtrl_GetItem(aControl.hwnd, index, &tci))\n\t\t_o_return_p(buf);\n\t_o_return_empty;\n}\n\n\nResultType GuiType::ControlGetWindowText(ResultToken &aResultToken, GuiControlType &aControl)\n{\n\t// Set up the result token.\n\tint length = GetWindowTextLength(aControl.hwnd); // Might be zero, which is properly handled below.\n\tif (TokenSetResult(aResultToken, NULL, length) != OK)\n\t\treturn FAIL; // It already displayed the error.\n\taResultToken.marker_length = GetWindowText(aControl.hwnd, aResultToken.marker, length+1);\n\t// MSDN: \"If the function succeeds, the return value is the length, in characters,\n\t// of the copied string, not including the terminating null character.\"\n\t// However, GetWindowText() works by sending the control a WM_GETTEXT message, and some\n\t// controls don't respond correctly. Link controls have been caught including the null\n\t// terminator in the count, so this works around it:\n\tif (aResultToken.marker_length && !aResultToken.marker[aResultToken.marker_length-1])\n\t\t--aResultToken.marker_length;\n\treturn OK;\n}\n\n\nvoid GuiType::ControlRedraw(GuiControlType &aControl, bool aOnlyWithinTab)\n{\n\tif ( !aOnlyWithinTab\n\t\t|| FindTabControl(aControl.tab_control_index) && IsWindowVisible(aControl.hwnd) )\n\t{\n\t\tRECT rect;\n\t\tGetWindowRect(aControl.hwnd, &rect); // Limit it to only that part of the client area that is receiving the rect.\n\t\tMapWindowPoints(NULL, mHwnd, (LPPOINT)&rect, 2); // Convert rect to client coordinates (not the same as GetClientRect()).\n\t\tInvalidateRect(mHwnd, &rect, TRUE); // Seems safer to use TRUE, not knowing all possible overlaps, etc.\n\t\t//Overkill: InvalidateRect(mHwnd, NULL, FALSE); // Erase doesn't seem to be necessary.\n\t\t// None of the following is enough:\n\t\t//Changes focused control, so no good: ControlUpdateCurrentTab(*tab_control, false);\n\t\t//RedrawWindow(tab_control->hwnd, NULL, NULL, 0 ..or.. RDW_INVALIDATE);\n\t\t//InvalidateRect(aControl.hwnd, NULL, TRUE);\n\t\t//InvalidateRect(tab_control->hwnd, NULL, TRUE);\n\t}\n}\n\n\n\n/////////////////\n// Static members\n/////////////////\nFontType *GuiType::sFont = NULL; // An array of structs, allocated upon first use.\nint GuiType::sFontCount = 0;\nHWND GuiType::sTreeWithEditInProgress = NULL;\n\n\n\nbool GuiType::Delete() // IObject::Delete()\n{\n\t// Delete() should only be called when the script releases its last reference to the\n\t// object, or when the user closes the window while the script has no references.\n\t// See VisibilityChanged() for details.\n\tif (mHwnd)\n\t\tDestroy();\n\telse\n\t\tDispose();\n\t// OnMessage() or perhaps some other callback may enable the script to regain a ref.\n\t// Although the object is now unusable, for program stability we must `delete this`\n\t// only if mRefCount is still 1 (it's never decremented to 0).\n\tif (mRefCount > 1)\n\t\treturn false;\n\treturn Object::Delete();\n}\n\n\n\nFResult GuiType::Destroy()\n// Destroys the window and performs related cleanup which is only necessary for\n// a successfully constructed Gui, then calls Dispose() for the remaining cleanup.\n{\n\tif (!mHwnd)\n\t\treturn OK; // We have already been destroyed.\n\n\t// First destroy any windows owned by this window, since they will be auto-destroyed\n\t// anyway due to their being owned. By destroying them explicitly, the Destroy()\n\t// function is called recursively which keeps everything relatively neat.\n\t// Lexikos: I'm not really sure what Chris meant by \"neat\", since Destroy() is called\n\t// recursively via WM_DESTROY anyway. It's currently left to WM_DESTROY because the\n\t// code below is actually broken in two ways (unique to the new object-oriented API):\n\t// 1) If there are no external references to gui, it will be deleted and gui->mNextGui\n\t// will likely crash the program.\n\t// 2) Destroy() removes the gui from the list, which causes the loop to break at the\n\t// first owned/child window. Saving the next/previous link before-hand may not\n\t// solve the problem since Destroy() could recursively destroy other windows.\n\t//for (GuiType* gui = g_firstGui; gui; gui = gui->mNextGui)\n\t//\tif (gui->mOwner == mHwnd)\n\t//\t\tgui->Destroy();\n\n\t// Testing shows that this must be done prior to calling DestroyWindow() later below, presumably\n\t// because the destruction immediately destroys the status bar, or prevents it from answering messages.\n\t// MSDN says \"During the processing of [WM_DESTROY], it can be assumed that all child windows still exist\".\n\t// However, for DestroyWindow() to have returned means that WM_DESTROY was already fully processed.\n\tif (mStatusBarHwnd) // IsWindow(gui.mStatusBarHwnd) isn't called because even if possible for it to have been destroyed, SendMessage below should return 0.\n\t{\n\t\t// This is done because the vast majority of people wouldn't want to have to worry about it.\n\t\t// They can always use DllCall() if they want to share the same HICON among multiple parts of\n\t\t// the same bar, or among different windows (fairly rare).\n\t\tHICON hicon;\n\t\tint part_count = (int)SendMessage(mStatusBarHwnd, SB_GETPARTS, 0, NULL); // MSDN: \"This message always returns the number of parts in the status bar [regardless of how it is called]\".\n\t\tfor (int i = 0; i < part_count; ++i)\n\t\t\tif (hicon = (HICON)SendMessage(mStatusBarHwnd, SB_GETICON, i, 0))\n\t\t\t\tDestroyIcon(hicon);\n\t}\n\n\tif (IsWindow(mHwnd)) // If WM_DESTROY called us, the window might already be partially destroyed.\n\t{\n\t\t// If this window is using a menu bar but that menu is also used by some other window, first\n\t\t// detach the menu so that it doesn't get auto-destroyed with the window. This is done\n\t\t// unconditionally since such a menu will be automatically destroyed when the script exits\n\t\t// or when the menu is destroyed explicitly via the Menu command. It also prevents any\n\t\t// submenus attached to the menu bar from being destroyed, since those submenus might be\n\t\t// also used by other menus (however, this is not really an issue since menus destroyed\n\t\t// would be automatically re-created upon next use). But in the case of a window that\n\t\t// is currently using a menu bar, destroying that bar in conjunction with the destruction\n\t\t// of some other window might cause bad side effects on some/all OSes.\n\t\tShowWindow(mHwnd, SW_HIDE); // Hide it to prevent re-drawing due to menu removal.\n\t\t::SetMenu(mHwnd, NULL);\n\t\tif (!mDestroyWindowHasBeenCalled)\n\t\t{\n\t\t\tmDestroyWindowHasBeenCalled = true; // Signal the WM_DESTROY routine not to call us.\n\t\t\tDestroyWindow(mHwnd); // The WindowProc is immediately called and it now destroys the window.\n\t\t}\n\t\t// else WM_DESTROY was called by a function other than this one (possibly auto-destruct due to\n\t\t// being owned by script's main window), so it would be bad to call DestroyWindow() again since\n\t\t// it's already in progress.\n\t}\n\n\t// This is done here rather than in Dispose() because a Gui is added to the list only\n\t// after being successfully constructed, and should remain there only until the window\n\t// is destroyed:\n\tRemoveGuiFromList(this);\n\n\t// It may be possible for an object released below to cause execution of script, and\n\t// although the window has been destroyed (making it impossible for FindGui() to return\n\t// this object) and the Gui has been removed from the list, the script might still have\n\t// a reference to it. It is therefore important that this is done to mark the Gui as\n\t// invalid, so Invoke() raises an error:\n\tmHwnd = NULL;\n\n\t// Clean up final resources.\n\tDispose();\n\n\t// The following might release the final reference to this object, thereby causing 'this'\n\t// to be deleted. See VisibilityChanged() for details.\n\tif (mVisibleRefCounted)\n\t\tRelease();\n\t// IT IS NOW UNSAFE TO REFER TO ANY NON-STATIC MEMBERS OF THIS OBJECT.\n\n\t// If this Gui was the last thing keeping the script running, exit the script:\n\tg_script.ExitIfNotPersistent(EXIT_CLOSE);\n\treturn OK;\n}\n\n\n\nvoid GuiType::Dispose()\n// Cleans up resources managed separately to the window. This is separate from Destroy()\n// for maintainability; i.e. to ensure resources are freed even if the window had not been\n// successfully created.\n{\n\tif (mDisposed)\n\t\treturn;\n\tmDisposed = true;\n\n\tif (mBackgroundBrushWin)\n\t\tDeleteObject(mBackgroundBrushWin);\n\tif (mHdrop)\n\t\tDragFinish(mHdrop);\n\t\n\t// A partially constructed Gui can't have a non-zero mControlCount, but it seems more\n\t// appropriate to do this here than in Destroy():\n\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t{\n\t\tmControl[u]->Dispose();\n\t\tmControl[u]->Release(); // Release() vs delete because the script may still have references to it.\n\t}\n\t// The following has been confirmed necessary to prevent the script from crashing if\n\t// the controls are being enumerated (e.g. by GuiTypeEnum) when the Gui is destroyed:\n\tmControlCount = 0;\n\n\tif (mMenu)\n\t\tmMenu->Release();\n\n\tmEvents.Dispose();\n\tif (mEventSink && this != mEventSink)\n\t\tmEventSink->Release();\n\n\tif (mIconEligibleForDestruction && mIconEligibleForDestruction != g_script.mCustomIcon) // v1.0.37.07.\n\t\tDestroyIconsIfUnused(mIconEligibleForDestruction, mIconEligibleForDestructionSmall);\n\n\t// For simplicity and performance, any fonts used *solely* by a destroyed window are destroyed\n\t// only when the program terminates. Another reason for this is that sometimes a destroyed window\n\t// is soon recreated to use the same fonts it did before.\n\n\tRemoveAccelerators();\n\tfree(mControl); // Free the control array, which was previously malloc'd.\n}\n\n\nvoid GuiControlType::Dispose()\n// Clean up resources associated with this control.\n// It's called Dispose vs Destroy because at the time it is called, the control window\n// has already been destroyed as a side-effect of the parent window being destroyed.\n{\n\tif (type == GUI_CONTROL_PIC && union_hbitmap)\n\t{\n\t\tif (attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR)\n\t\t\tDestroyIcon((HICON)union_hbitmap); // Works on cursors too. See notes in LoadPicture().\n\t\telse // union_hbitmap is a bitmap rather than an icon or cursor.\n\t\t\tDeleteObject(union_hbitmap);\n\t}\n\telse if (type == GUI_CONTROL_LISTVIEW) // It was ensured at an earlier stage that union_lv_attrib != NULL.\n\t\tfree(union_lv_attrib);\n\telse if (type == GUI_CONTROL_ACTIVEX && union_object)\n\t\tunion_object->Release();\n\t//else do nothing, since this type has nothing more than a color stored in the union.\n\tif (background_brush)\n\t\tDeleteObject(background_brush);\n\tevents.Dispose();\n\tif (name)\n\t\tfree(name);\n\tname = NULL;\n\thwnd = NULL;\n\tgui = NULL;\n}\n\n\n\nvoid GuiType::DestroyIconsIfUnused(HICON ahIcon, HICON ahIconSmall)\n// Caller has ensured that the GUI window previously using ahIcon has been destroyed prior to calling\n// this function.\n{\n\tif (!ahIcon) // At least one caller relies on this check.\n\t\treturn;\n\tfor (GuiType* gui = g_firstGui; gui; gui = gui->mNextGui)\n\t{\n\t\t// If another window is using this icon, don't destroy the because that has been reported to disrupt\n\t\t// the window's display of the icon in some cases (apparently WM_SETICON doesn't make a copy of the\n\t\t// icon). The windows still using the icon will be responsible for destroying it later.\n\t\tif (gui->mIconEligibleForDestruction == ahIcon)\n\t\t\treturn;\n\t}\n\t// Since above didn't return, this icon is not currently in use by a GUI window. The caller has\n\t// authorized us to destroy it.\n\tDestroyIcon(ahIcon);\n\t// L17: Small icon should always also be unused at this point.\n\tif (ahIconSmall != ahIcon)\n\t\tDestroyIcon(ahIconSmall);\n}\n\n\n\nFResult GuiType::Create(LPCTSTR aTitle)\n{\n\tif (mHwnd) // It already exists\n\t\treturn FR_E_FAILED; // Should be impossible since mHwnd is checked by caller.\n\n\t// Use a separate class for GUI, which gives it a separate WindowProc and allows it to be more\n\t// distinct when used with the ahk_class method of addressing windows.\n\tif (!sGuiWinClass)\n\t{\n\t\tWNDCLASSEX wc = {0};\n\t\twc.cbSize = sizeof(wc);\n\t\twc.lpszClassName = WINDOW_CLASS_GUI;\n\t\twc.hInstance = g_hInstance;\n\t\twc.lpfnWndProc = GuiWindowProc;\n\t\twc.hIcon = g_IconLarge;\n\t\twc.hIconSm = g_IconSmall;\n\t\twc.style = CS_DBLCLKS; // v1.0.44.12: CS_DBLCLKS is accepted as a good default by nearly everyone. It causes the window to receive WM_LBUTTONDBLCLK, WM_RBUTTONDBLCLK, and WM_MBUTTONDBLCLK (even without this, all windows receive WM_NCLBUTTONDBLCLK, WM_NCMBUTTONDBLCLK, and WM_NCRBUTTONDBLCLK).\n\t\t\t// CS_HREDRAW and CS_VREDRAW are not included above because they cause extra flickering. It's generally better for a window to manage its own redrawing when it's resized.\n\t\twc.hCursor = LoadCursor((HINSTANCE) NULL, IDC_ARROW);\n\t\twc.hbrBackground = (HBRUSH)(COLOR_BTNFACE + 1);\n\t\twc.cbWndExtra = DLGWINDOWEXTRA; // So that it will be the type that uses DefDlgProc() vs. DefWindowProc().\n\t\tsGuiWinClass = RegisterClassEx(&wc);\n\t\tif (!sGuiWinClass)\n\t\t\treturn FR_E_WIN32;\n\t}\n\n\tif ( !(mHwnd = CreateWindowEx(mExStyle, WINDOW_CLASS_GUI, aTitle\n\t\t, mStyle, 0, 0, 0, 0, mOwner, NULL, g_hInstance, NULL)) )\n\t\treturn FR_E_WIN32;\n\n\t// Set the user pointer in the window to this GuiType object, so that it is possible to retrieve it back from the window handle.\n\tSetWindowLongPtr(mHwnd, GWLP_USERDATA, (LONG_PTR)this);\n\n\t// L17: Use separate big/small icons for best results.\n\tHICON big_icon, small_icon;\n\tif (g_script.mCustomIcon)\n\t{\n\t\tmIconEligibleForDestruction = big_icon = g_script.mCustomIcon;\n\t\tmIconEligibleForDestructionSmall = small_icon = g_script.mCustomIconSmall; // Should always be non-NULL if mCustomIcon is non-NULL.\n\t}\n\telse\n\t{\n\t\tbig_icon = g_IconLarge;\n\t\tsmall_icon = g_IconSmall;\n\t\t// Unlike mCustomIcon, leave mIconEligibleForDestruction NULL because these\n\t\t// icons are used for various other purposes and should never be destroyed.\n\t}\n\t// Setting the small icon puts it in the upper left corner of the dialog window.\n\t// Setting the big icon makes the dialog show up correctly in the Alt-Tab menu (but big seems to\n\t// have no effect unless the window is unowned, i.e. it has a button on the task bar).\n\t// Change for v1.0.37.07: Set both icons unconditionally for code simplicity, and also in case\n\t// it's possible for the window to change after creation in a way that would make a custom icon\n\t// become relevant. Set the big icon even if it's owned because there might be ways\n\t// an owned window can have an entry in the alt-tab menu. The following ways come close\n\t// but don't actually succeed:\n\t// 1) It's owned by the main window but the main window isn't visible: It acquires the main window's icon\n\t// in the alt-tab menu regardless of whether it was given a big icon of its own.\n\t// 2) It's owned by another GUI window but it has the WS_EX_APPWINDOW style (might force a taskbar button):\n\t// Same effect as in #1.\n\t// 3) Possibly other ways.\n\tSendMessage(mHwnd, WM_SETICON, ICON_SMALL, (LPARAM)small_icon); // Testing shows that a zero is returned for both;\n\tSendMessage(mHwnd, WM_SETICON, ICON_BIG, (LPARAM)big_icon); // i.e. there is no previous icon to destroy in this case.\n\n\treturn OK;\n}\n\n\nFResult GuiType::OnEvent(StrArg aEventName, ExprTokenType &aCallback, optl<int> aAddRemove)\n{\n\tGUI_MUST_HAVE_HWND;\n\t\n\tGuiEventType evt = ConvertEvent(aEventName);\n\tif (evt < GUI_EVENT_WINDOW_FIRST || evt > GUI_EVENT_WINDOW_LAST)\n\t\treturn FR_E_ARG(0);\n\t\n\treturn OnEvent(nullptr, evt, GUI_EVENTKIND_EVENT, aCallback, aAddRemove);\n}\n\n\nFResult GuiType::OnMessage(UINT aNumber, ExprTokenType &aCallback, optl<int> aAddRemove)\n{\n\tGUI_MUST_HAVE_HWND;\n\t\n\treturn OnEvent(nullptr, aNumber, GUI_EVENTKIND_MESSAGE, aCallback, aAddRemove);\n}\n\n\nFResult GuiType::OnEvent(GuiControlType *aControl, UINT aEvent, UCHAR aEventKind\n\t, ExprTokenType &aCallback, optl<int> aAddRemove)\n{\n\tint max_threads = 1;\n\tif (aAddRemove.has_value())\n\t\tmax_threads = aAddRemove.value();\n\tif (max_threads < -1 || max_threads > 1)\n\t\t// An event can currently only run one thread at a time. By contrast, OnMessage\n\t\t// applies the thread limit per handler, not per message. It's hard to say which\n\t\t// approach is better.\n\t\treturn FR_E_ARG(2);\n\n\tTCHAR nbuf[MAX_NUMBER_SIZE];\n\tIObject *func = TokenToObject(aCallback);\n\tLPTSTR name = func ? nullptr : TokenToString(aCallback, nbuf);\n\tif (!func && !mEventSink)\n\t\treturn FR_E_ARG(1);\n\t\n\treturn OnEvent(aControl, aEvent, aEventKind, func, name, max_threads);\n}\n\n\nFResult GuiType::OnEvent(GuiControlType *aControl, UINT aEvent, UCHAR aEventKind\n\t, IObject *aFunc, LPTSTR aMethodName, int aMaxThreads)\n{\n\tMsgMonitorList &handlers = aControl ? aControl->events : mEvents;\n\tMsgMonitorStruct *mon;\n\tif (aFunc)\n\t\tmon = handlers.Find(aEvent, aFunc, aEventKind);\n\telse\n\t\tmon = handlers.Find(aEvent, aMethodName, aEventKind);\n\tif (!aMaxThreads)\n\t{\n\t\tif (mon)\n\t\t\thandlers.Delete(mon);\n\t\tif (aEventKind == GUI_EVENTKIND_EVENT)\n\t\t\tApplyEventStyles(aControl, aEvent, false);\n\t\telse if (aEventKind == GUI_EVENTKIND_MESSAGE && aControl)\n\t\t\tApplySubclassing(aControl);\n\t\treturn OK;\n\t}\n\tbool append = aMaxThreads >= 0;\n\tif (!append) // Negative values mean \"call it last\".\n\t\taMaxThreads = -aMaxThreads; // Make it positive.\n\tif (aMaxThreads > MsgMonitorStruct::MAX_INSTANCES)\n\t\taMaxThreads = MsgMonitorStruct::MAX_INSTANCES;\n\tif (!mon)\n\t{\n\t\tif (aFunc)\n\t\t{\n\t\t\t// Since this callback is being registered for the first time, validate.\n\t\t\tint param_count = 2;\n\t\t\tswitch (aEventKind)\n\t\t\t{\n\t\t\tcase GUI_EVENTKIND_MESSAGE:\t\tparam_count = 4; break;\n\t\t\tcase GUI_EVENTKIND_COMMAND:\t\tparam_count = 1; break;\n\t\t\tcase GUI_EVENTKIND_EVENT:\n\t\t\t\tswitch (aEvent)\n\t\t\t\t{\n\t\t\t\tcase GUI_EVENT_DROPFILES:\tparam_count = 5; break;\n\t\t\t\tcase GUI_EVENT_CLOSE:\n\t\t\t\tcase GUI_EVENT_ESCAPE:\t\tparam_count = 1; break;\n\t\t\t\tcase GUI_EVENT_RESIZE:\t\tparam_count = 4; break;\n\t\t\t\tcase GUI_EVENT_CONTEXTMENU:\tparam_count = 5 + (aControl == nullptr); break;\n\t\t\t\tcase GUI_EVENT_CLICK:\t\tparam_count = 2 + (aControl->type == GUI_CONTROL_LINK); break;\n\t\t\t\tcase GUI_EVENT_ITEMSELECT:\n\t\t\t\t\tif (aControl->type == GUI_CONTROL_TREEVIEW)\n\t\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_EVENT_ITEMCHECK:\n\t\t\t\tcase GUI_EVENT_ITEMEXPAND:\n\t\t\t\t\tparam_count = 3;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t\tauto fr = ValidateFunctor(aFunc, param_count);\n\t\t\tif (fr != OK)\n\t\t\t\treturn fr;\n\t\t\t// Add the callback.\n\t\t\tmon = handlers.Add(aEvent, aFunc, append);\n\t\t}\n\t\telse\n\t\t\tmon = handlers.Add(aEvent, aMethodName, append);\n\t\tif (!mon)\n\t\t\treturn FR_E_OUTOFMEM;\n\t}\n\tmon->instance_count = 0;\n\tmon->max_instances = aMaxThreads;\n\tmon->msg_type = aEventKind;\n\tif (aEventKind == GUI_EVENTKIND_EVENT)\n\t\tApplyEventStyles(aControl, aEvent, true);\n\telse if (aEventKind == GUI_EVENTKIND_MESSAGE && aControl)\n\t\tApplySubclassing(aControl);\n\treturn OK;\n}\n\n\nvoid GuiType::ApplyEventStyles(GuiControlType *aControl, UINT aEvent, bool aAdded)\n{\n\tint style_type;\n\tDWORD style_bit;\n\tHWND hwnd;\n\tif (aControl)\n\t{\n\t\t// These styles are only added automatically, not removed, for a few reasons:\n\t\t// 1) Reduces code size (by 224 bytes on x86 vs. just 64 bytes for this section).\n\t\t// Note that it's necessary to check for handlers for every event in the group\n\t\t// before removing the style.\n\t\t// 2) The script may have applied the style manually, in which case it should not\n\t\t// be removed automatically (but we have no way to know).\n\t\t// 3) It's probably rare to remove a handler for one of these events.\n\t\tif (!aAdded)\n\t\t\treturn;\n\t\tGuiControlType &control = *aControl;\n\t\t// This approach appears to produce the same code size as just checking for the\n\t\t// events which don't need the style; i.e. GUI_EVENT_CONTEXTMENU and (for Buttons)\n\t\t// GUI_EVENT_CLICK:\n\t\tstatic char sStaticNotify[] = {GUI_EVENT_CLICK, GUI_EVENT_DBLCLK, NULL};\n\t\tstatic char sButtonNotify[] = {GUI_EVENT_DBLCLK, GUI_EVENT_FOCUS, GUI_EVENT_LOSEFOCUS, NULL};\n\t\tchar *event_group;\n\t\tswitch (control.type)\n\t\t{\n\t\tcase GUI_CONTROL_TEXT:\n\t\tcase GUI_CONTROL_PIC:\n\t\t\t// Apply the SS_NOTIFY style *only* if the control actually has an associated action.\n\t\t\t// This is because otherwise the control would steal all clicks for any other controls\n\t\t\t// drawn on top of it (e.g. a picture control with some edit fields drawn on top of it).\n\t\t\t// See comments in the creation of GUI_CONTROL_PIC for more info:\n\t\t\tstyle_bit = SS_NOTIFY;\n\t\t\tevent_group = sStaticNotify;\n\t\t\tbreak;\n\t\t\n\t\tcase GUI_CONTROL_BUTTON:\n\t\tcase GUI_CONTROL_CHECKBOX:\n\t\tcase GUI_CONTROL_RADIO:\n\t\t\tstyle_bit = BS_NOTIFY;\n\t\t\tevent_group = sButtonNotify;\n\t\t\tbreak;\n\t\t\n\t\tdefault:\n\t\t\treturn;\n\t\t}\n\t\tif (!strchr(event_group, aEvent))\n\t\t\treturn;\n\t\tstyle_type = GWL_STYLE;\n\t\thwnd = control.hwnd;\n\t}\n\telse // aControl == NULL\n\t{\n\t\tif (aEvent == GUI_EVENT_DROPFILES)\n\t\t{\n\t\t\t// Apply the WS_EX_ACCEPTFILES style to ensure the window can accept dropped files.\n\t\t\t// Remove the style to ensure the mouse cursor correctly changes to show that the\n\t\t\t// window no longer accepts dropped files.\n\t\t\tstyle_type = GWL_EXSTYLE;\n\t\t\tstyle_bit = WS_EX_ACCEPTFILES;\n\t\t}\n\t\telse\n\t\t\treturn;\n\t\tif (!aAdded && IsMonitoring(aEvent)) // Removed a handler but not the last.\n\t\t\treturn;\n\t\thwnd = mHwnd;\n\t}\n\t// Since above didn't return, there's a style to apply or remove.\n\tDWORD current_style = GetWindowLong(hwnd, style_type);\n\tif (aAdded != ((current_style & style_bit) != 0)) // Needs toggling.\n\t{\n\t\tcurrent_style ^= style_bit; // Toggle it.\n\t\tSetWindowLong(hwnd, style_type, current_style);\n\t}\n}\n\n\nvoid GuiType::ApplySubclassing(GuiControlType *aControl)\n{\n\tif (aControl->events.IsMonitoringGuiMsg())\n\t\tSetWindowSubclass(aControl->hwnd, ControlWindowProc, (UINT_PTR)aControl, 0);\n\telse\n\t\tRemoveWindowSubclass(aControl->hwnd, ControlWindowProc, (UINT_PTR)aControl);\n}\n\n\n\nLPTSTR GuiType::sEventNames[] = GUI_EVENT_NAMES;\n\nLPTSTR GuiType::ConvertEvent(GuiEventType evt)\n{\n\tif (evt < _countof(sEventNames))\n\t\treturn sEventNames[evt];\n\n\t// Else it's a character code - convert it to a string\n\tstatic TCHAR sBuf[2] = { 0, 0 };\n\tsBuf[0] = (TCHAR)(UCHAR)evt;\n\treturn sBuf;\n}\n\nGuiEventType GuiType::ConvertEvent(LPCTSTR evt)\n{\n\tfor (GuiEventType i = 0; i < _countof(sEventNames); ++i)\n\t\tif (!_tcsicmp(sEventNames[i], evt))\n\t\t\treturn i;\n\tif (*evt && !evt[1])\n\t\treturn *evt; // Single-letter event name.\n\treturn GUI_EVENT_NONE;\n}\n\n\n\nIObject* GuiType::CreateDropArray(HDROP hDrop)\n{\n\tauto arr = Array::Create();\n\t// The added complexity/code size of handling out-of-memory here and in MsgSleep()\n\t// by aborting the new thread seems to outweigh the trivial benefits. So assume\n\t// arr is non-NULL and let the access violation occur if otherwise.\n\tTCHAR buf[T_MAX_PATH];\n\tUINT file_count = DragQueryFile(hDrop, 0xFFFFFFFF, NULL, 0);\n\tfor (UINT u = 0; u < file_count; u ++)\n\t{\n\t\tarr->Append(buf, DragQueryFile(hDrop, u, buf, _countof(buf)));\n\t\t// Result not checked for reasons described above. The likely outcome at this\n\t\t// point would be for the event handler to either execute with fewer files than\n\t\t// expected, or for it to raise ERR_OUTOFMEM.\n\t}\n\treturn arr;\n}\n\n\n\nvoid GuiType::UpdateMenuBars(HMENU aMenu)\n// Caller has changed aMenu and wants the change visibly reflected in any windows that that\n// use aMenu as a menu bar. For example, if a menu item has been disabled, the grey-color\n// won't show up immediately unless the window is refreshed.\n{\n\tfor (GuiType* gui = g_firstGui; gui; gui = gui->mNextGui)\n\t{\n\t\t//if (gui->mHwnd) // Always non-NULL for any item in the list.\n\t\tif (GetMenu(gui->mHwnd) == aMenu && IsWindowVisible(gui->mHwnd))\n\t\t{\n\t\t\t// Neither of the below two calls by itself is enough for all types of changes.\n\t\t\t// Thought it's possible that every type of change only needs one or the other, both\n\t\t\t// are done for simplicity:\n\t\t\t// This first line is necessary at least for cases where the height of the menu bar\n\t\t\t// (the number of rows needed to display all its items) has changed as a result\n\t\t\t// of the caller's change. In addition, I believe SetWindowPos() must be called\n\t\t\t// before RedrawWindow() to prevent artifacts in some cases:\n\t\t\tSetWindowPos(gui->mHwnd, NULL, 0, 0, 0, 0, SWP_DRAWFRAME|SWP_FRAMECHANGED|SWP_NOMOVE|SWP_NOSIZE|SWP_NOZORDER|SWP_NOACTIVATE);\n\t\t\t// This line is necessary at least when a single new menu item has been added:\n\t\t\tRedrawWindow(gui->mHwnd, NULL, NULL, RDW_INVALIDATE|RDW_FRAME|RDW_UPDATENOW);\n\t\t\t// RDW_UPDATENOW: Seems best so that the window is in an visible updated state when function\n\t\t\t// returns. This is because if the menu bar happens to be two rows or its size is changed\n\t\t\t// in any other way, the window dimensions themselves might change, and the caller might\n\t\t\t// rely on such a change being visibly finished for PixelGetColor, etc.\n\t\t\t//Not enough: UpdateWindow(gui->mHwnd);\n\t\t}\n\t}\n}\n\n\n\nResultType GuiType::AddControl(GuiControls aControlType, LPCTSTR aOptions, LPCTSTR aText, GuiControlType*& apControl, Array *aObj)\n// Caller must have ensured that mHwnd is non-NULL (i.e. that the parent window already exists).\n{\n\tapControl = NULL; // Initialize return pointer.\n\n\t#define TOO_MANY_CONTROLS _T(\"Too many controls.\") // Short msg since so rare.\n\tif (mControlCount >= MAX_CONTROLS_PER_GUI)\n\t\treturn g_script.RuntimeError(TOO_MANY_CONTROLS);\n\tif (mControlCount >= mControlCapacity) // The section below on the above check already having been done.\n\t{\n\t\t// realloc() to keep the array contiguous, which allows better-performing methods to be\n\t\t// used to access the list of controls in various places.\n\t\t// Expand the array by one block:\n\t\tGuiControlType **realloc_temp; // Needed since realloc returns NULL on failure but leaves original block allocated.\n\t\tif ( !(realloc_temp = (GuiControlType **)realloc(mControl // If passed NULL, realloc() will do a malloc().\n\t\t\t, (mControlCapacity + GUI_CONTROL_BLOCK_SIZE) * sizeof(GuiControlType*))) )\n\t\t\treturn g_script.RuntimeError(TOO_MANY_CONTROLS); // A non-specific msg since this error is so rare.\n\t\tmControl = realloc_temp;\n\t\tmControlCapacity += GUI_CONTROL_BLOCK_SIZE;\n\t}\n\n\t////////////////////////////////////////////////////////////////////////////////////////\n\t// Set defaults for the various options, to be overridden individually by any specified.\n\t////////////////////////////////////////////////////////////////////////////////////////\n\tGuiControlType *pcontrol = new GuiControlType(this);\n\tmControl[mControlCount] = pcontrol;\n\tGuiControlType &control = *pcontrol;\n\n\tcontrol.SetBase(GuiControlType::GetPrototype(aControlType));\n\t\n\tGuiControlOptionsType opt;\n\tControlInitOptions(opt, control);\n\t// aOpt.checked is already okay since BST_UNCHECKED == 0\n\t// Similarly, the zero-init of \"control\" higher above set the right values for password_char, new_section, etc.\n\n\tif (aControlType == GUI_CONTROL_TAB2) // v1.0.47.05: Replace TAB2 with TAB at an early stage to simplify the code. The only purpose of TAB2 is to flag this as the new type of tab that avoids redrawing issues but has a new z-order that would break some existing scripts.\n\t{\n\t\taControlType = GUI_CONTROL_TAB;\n\t\tcontrol.attrib |= GUI_CONTROL_ATTRIB_ALTBEHAVIOR; // v1.0.47.05: A means for new scripts to solve redrawing problems in tab controls at the cost of putting the tab control after its controls in the z-order.\n\t}\n\telse if (aControlType == GUI_CONTROL_TAB3)\n\t{\n\t\taControlType = GUI_CONTROL_TAB;\n\t\topt.tab_control_uses_dialog = true;\n\t\topt.tab_control_autosize = TAB3_AUTOWIDTH | TAB3_AUTOHEIGHT;\n\t}\n\tif (aControlType == GUI_CONTROL_TAB)\n\t{\n\t\tif (mTabControlCount == MAX_TAB_CONTROLS)\n\t\t{\n\t\t\tdelete pcontrol;\n\t\t\treturn g_script.RuntimeError(_T(\"Too many tab controls.\")); // Short msg since so rare.\n\t\t}\n\t\t// For now, don't allow a tab control to be create inside another tab control because it raises\n\t\t// doubt and probably would create complications. If it ever is allowed, note that\n\t\t// control.tab_index stores this tab control's index (0 for the first tab control, 1 for the\n\t\t// second, etc.) -- this is done for performance reasons.\n\t\tcontrol.tab_control_index = MAX_TAB_CONTROLS;\n\t\tcontrol.tab_index = mTabControlCount; // Store its control-index to help look-up performance in other sections.\n\t\t// Autosize any previous tab control, since this new one is going to become current.\n\t\t// This is done here rather than when mCurrentTabControlIndex is actually changed later,\n\t\t// because this new control's positioning might be dependent on the previous control's size.\n\t\tif (GuiControlType *previous_tab_control = FindTabControl(mCurrentTabControlIndex))\n\t\t{\n\t\t\t// See \"case GUI_CMD_TAB:\" for more comments.\n\t\t\tAutoSizeTabControl(*previous_tab_control);\n\t\t}\n\t}\n\telse if (aControlType == GUI_CONTROL_STATUSBAR)\n\t{\n\t\tif (mStatusBarHwnd)\n\t\t{\n\t\t\tdelete pcontrol;\n\t\t\treturn g_script.RuntimeError(_T(\"Too many status bars.\")); // Short msg since so rare.\n\t\t}\n\t\tcontrol.tab_control_index = MAX_TAB_CONTROLS; // Indicate that bar isn't owned by any tab control.\n\t\t// No need to do the following because constructor did it:\n\t\t//control.tab_index = 0; // Ignored but set for maintainability/consistency.\n\t}\n\telse\n\t{\n\t\tcontrol.tab_control_index = mCurrentTabControlIndex;\n\t\tcontrol.tab_index = mCurrentTabIndex;\n\t}\n\n\t// If this is the first control, set the default margin for the window based on the size\n\t// of the current font, but only if the margins haven't already been set:\n\tif (!mControlCount)\n\t{\n\t\tSetDefaultMargins();\n\t\tmPrevX = mMarginX; // This makes first control be positioned correctly if it lacks both X & Y coords.\n\t}\n\n\tcontrol.type = aControlType; // Improves maintainability to do this early, but must be done after TAB2 vs. TAB is resolved higher above.\n\n\t/////////////////////////////////////////////////\n\t// Set control-specific defaults for any options.\n\t/////////////////////////////////////////////////\n\topt.style_add |= WS_VISIBLE; // Starting default for all control types.\n\topt.use_theme = mUseTheme; // Set default.\n\n\t// Radio buttons are handled separately here, outside the switch() further below:\n\tif (aControlType == GUI_CONTROL_RADIO)\n\t{\n\t\t// The BS_NOTIFY style is probably better not applied by default to radios because although it\n\t\t// causes the control to send BN_DBLCLK messages, each double-click by the user is seen only\n\t\t// as one click for the purpose of cosmetically making the button appear like it is being\n\t\t// clicked rapidly. It is applied by ApplyEventStyles() instead.\n\t\t// v1.0.47.04: Removed BS_MULTILINE from default because it is conditionally applied later below.\n\t\t// No WS_TABSTOP here since that is applied elsewhere depending on radio group nature.\n\t\tif (!mInRadioGroup)\n\t\t\topt.style_add |= WS_GROUP; // Tabstop must be handled later below.\n\t\t\t// The mInRadioGroup flag will be changed accordingly after the control is successfully created.\n\t\t//else by default, no WS_TABSTOP or WS_GROUP. However, WS_GROUP can be applied manually via the\n\t\t// options list to split this radio group off from one immediately prior to it.\n\t}\n\telse // Not a radio.\n\t\tif (mInRadioGroup) // Close out the prior radio group by giving this control the WS_GROUP style.\n\t\t\topt.style_add |= WS_GROUP; // This might not be necessary on all OSes, but it seems traditional / best-practice.\n\n\tswitch (aControlType) // Set starting defaults based on control type (the above also does some of that).\n\t{\n\t// Some controls also have the WS_EX_CLIENTEDGE exstyle by default because they look pretty strange\n\t// without them. This seems to be the standard default used by most applications.\n\t// Note: It seems that WS_BORDER is hardly ever used in practice with controls, just parent windows.\n\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\topt.style_add |= WS_TABSTOP|WS_VSCROLL; // CBS_DROPDOWNLIST is forcibly applied later. WS_VSCROLL is necessary.\n\t\tbreak;\n\tcase GUI_CONTROL_COMBOBOX:\n\t\t// CBS_DROPDOWN is set as the default here to allow the flexibility for it to be changed to\n\t\t// CBS_SIMPLE. CBS_SIMPLE is allowed for ComboBox but not DropDownList because CBS_SIMPLE\n\t\t// has an edit control just like a combo, which DropDownList isn't equipped to handle via Submit().\n\t\t// Also, if CBS_AUTOHSCROLL is omitted, typed text cannot go beyond the visible width of the\n\t\t// edit control, so it seems best to have that as a default also:\n\t\topt.style_add |= WS_TABSTOP|WS_VSCROLL|CBS_AUTOHSCROLL|CBS_DROPDOWN; // WS_VSCROLL is necessary.\n\t\tbreak;\n\tcase GUI_CONTROL_LISTBOX:\n\t\t// Omit LBS_STANDARD because it includes LBS_SORT, which we don't want as a default style.\n\t\t// However, as of v1.0.30.03, LBS_USETABSTOPS is included by default because:\n\t\t// 1) Not doing so seems to make it impossible to apply tab stops after the control has been created.\n\t\t// 2) Without this style, tabs appears as empty squares in the text, which seems undesirable for\n\t\t// 99.9% of applications.\n\t\t// 3) LBS_USETABSTOPS can be explicitly removed by specifying -0x80 in the options of \"Gui Add\".\n\t\topt.style_add |= WS_TABSTOP|WS_VSCROLL|LBS_USETABSTOPS; // WS_VSCROLL seems the most desirable default.\n\t\topt.exstyle_add |= WS_EX_CLIENTEDGE;\n\t\tbreak;\n\tcase GUI_CONTROL_LISTVIEW:\n\t\t// The ListView extended styles are actually an entirely separate class of styles that exist\n\t\t// separately from ExStyles. This explains why Get/SetWindowLong doesn't work on them.\n\t\t// But keep in mind that some of the normal/classic extended styles can still be applied\n\t\t// to a ListView via Get/SetWindowLong.\n\t\t// The listview extended styles all require at least ComCtl32.dll 4.70 (some might require more)\n\t\t// and thus will have no effect in Win 95/NT unless they have MSIE 3.x or similar patch installed.\n\t\t// Thus, things like LVS_EX_FULLROWSELECT and LVS_EX_HEADERDRAGDROP will have no effect on those systems.\n\t\topt.listview_style |= LVS_EX_FULLROWSELECT|LVS_EX_HEADERDRAGDROP; // LVS_AUTOARRANGE seems to disrupt the display of the column separators and have other weird effects in Report view.\n\t\topt.style_add |= WS_TABSTOP|LVS_SHOWSELALWAYS; // LVS_REPORT is omitted to help catch bugs involving opt.listview_view. WS_THICKFRAME allows the control itself to be drag-resized.\n\t\topt.exstyle_add |= WS_EX_CLIENTEDGE; // WS_EX_STATICEDGE/WS_EX_WINDOWEDGE/WS_BORDER(non-ex) don't look as nice. WS_EX_DLGMODALFRAME is a weird but interesting effect.\n\t\topt.listview_view = LV_VIEW_DETAILS; // Improves maintainability by avoiding the need to check if it's -1 in other places.\n\t\tbreak;\n\tcase GUI_CONTROL_TREEVIEW:\n\t\t// Default style is somewhat debatable, but the familiarity of Explorer's own defaults seems best.\n\t\t// TVS_SHOWSELALWAYS seems preferable by most people, and is also consistent to what is used for ListView.\n\t\t// Lines and buttons also seem preferable because the main feature of a tree is its hierarchical nature,\n\t\t// and that nature isn't well revealed without buttons, and buttons can't be shown at the root level\n\t\t// without TVS_LINESATROOT, which in turn can't be active without TVS_HASLINES.\n\t\topt.style_add |= WS_TABSTOP|TVS_SHOWSELALWAYS|TVS_HASLINES|TVS_LINESATROOT|TVS_HASBUTTONS; // TVS_LINESATROOT is necessary to get plus/minus buttons on root-level items.\n\t\topt.exstyle_add |= WS_EX_CLIENTEDGE; // Debatable, but seems best for consistency with ListView.\n\t\tbreak;\n\tcase GUI_CONTROL_EDIT:\n\t\topt.style_add |= WS_TABSTOP;\n\t\topt.exstyle_add |= WS_EX_CLIENTEDGE;\n\t\tbreak;\t\t\n\tcase GUI_CONTROL_LINK:\n\t\topt.style_add |= WS_TABSTOP;\n\t\tbreak;\n\tcase GUI_CONTROL_UPDOWN:\n\t\t// UDS_NOTHOUSANDS is debatable:\n\t\t// 1) The primary means by which a script validates whether the buddy contains an invalid\n\t\t// or out-of-range value for its UpDown is to compare the contents of the two. If one\n\t\t// has commas and the other doesn't, the commas must first be removed before comparing.\n\t\t// 2) Presence of commas in numeric data is going to be a source of script bugs for those\n\t\t// who take the buddy's contents rather than the UpDown's contents as the user input.\n\t\t// However, you could argue that script is not proper if it does this blindly because\n\t\t// the buddy could contain an out-of-range or non-numeric value.\n\t\t// 3) Display is more ergonomic if it has commas in it.\n\t\t// The above make it pretty hard to decide, so sticking with the default of have commas\n\t\t// seems ok. Also, UDS_ALIGNRIGHT must be present by default because otherwise buddying\n\t\t// will not take effect correctly.\n\t\topt.style_add |= UDS_SETBUDDYINT|UDS_ALIGNRIGHT|UDS_AUTOBUDDY|UDS_ARROWKEYS;\n\t\tbreak;\n\tcase GUI_CONTROL_DATETIME: // Gets a tabstop even when it contains an empty checkbox indicating \"no date\".\n\t\t// DTS_SHORTDATECENTURYFORMAT is applied by default because it should make results more consistent\n\t\t// across old and new systems. This is because new systems display a 4-digit year even without\n\t\t// this style, but older ones might display a two digit year. This should make any system capable\n\t\t// of displaying a 4-digit year display it in the locale's customary format. On systems that don't\n\t\t// support DTS_SHORTDATECENTURYFORMAT, it should be ignored, resulting in DTS_SHORTDATEFORMAT taking\n\t\t// effect automatically (untested).\n\t\topt.style_add |= WS_TABSTOP|DTS_SHORTDATECENTURYFORMAT;\n\t\tbreak;\n\tcase GUI_CONTROL_BUTTON: // v1.0.45: Removed BS_MULTILINE from default because it is conditionally applied later below.\n\tcase GUI_CONTROL_CHECKBOX: // v1.0.47.04: Removed BS_MULTILINE from default because it is conditionally applied later below.\n\tcase GUI_CONTROL_HOTKEY:\n\tcase GUI_CONTROL_SLIDER:\n\t\topt.style_add |= WS_TABSTOP;\n\t\tbreak;\n\tcase GUI_CONTROL_TAB:\n\t\t// Override the normal default, requiring a manual +Theme in the control's options. This is done\n\t\t// because themed tabs have a gradient background that is currently not well supported by the method\n\t\t// used here (controls' backgrounds do not match the gradient):\n\t\tif (!opt.tab_control_uses_dialog)\n\t\t\topt.use_theme = false;\n\t\topt.style_add |= WS_TABSTOP|TCS_MULTILINE;\n\t\tbreak;\n\tcase GUI_CONTROL_ACTIVEX:\n\t\topt.style_add |= WS_CLIPSIBLINGS;\n\t\tbreak;\n\tcase GUI_CONTROL_CUSTOM:\n\t\topt.style_add |= WS_TABSTOP;\n\t\tbreak;\n\tcase GUI_CONTROL_STATUSBAR:\n\t\t// Although the following appears unnecessary, at least on XP, there's a good chance it's required\n\t\t// on older OSes such as Win 95/NT. On newer OSes, apparently the control shows a grip on\n\t\t// its own even though it doesn't even give itself the SBARS_SIZEGRIP style.\n\t\tif (mStyle & WS_SIZEBOX) // Parent window is resizable.\n\t\t\topt.style_add |= SBARS_SIZEGRIP; // Provide a grip by default.\n\t\t// Below: Seems best to provide SBARS_TOOLTIPS by default, since we're not bound by backward compatibility\n\t\t// like the OS is. In theory, tips should be displayed only when the script has actually set some tip text\n\t\t// (e.g. via SendMessage). In practice, tips are never displayed, even under the precise conditions\n\t\t// described at MSDN's SB_SETTIPTEXT, perhaps under certain OS versions and themes. See bottom of\n\t\t// BIF_StatusBar() for more comments.\n\t\topt.style_add |= SBARS_TOOLTIPS;\n\t\tbreak;\n\tcase GUI_CONTROL_MONTHCAL:\n\t\t// Testing indicates that although the MonthCal attached to a DateTime control can be navigated using\n\t\t// the keyboard on Win2k/XP, standalone MonthCal controls don't support it, except on Vista and later.\n\t\topt.style_add |= WS_TABSTOP;\n\t\tbreak;\n\t// Nothing extra for these currently:\n\t//case GUI_CONTROL_RADIO: This one is handled separately above the switch().\n\t//case GUI_CONTROL_TEXT:\n\t//case GUI_CONTROL_PIC:\n\t//case GUI_CONTROL_GROUPBOX:\n\t//case GUI_CONTROL_PROGRESS:\n\t\t// v1.0.44.11: The following was commented out for GROUPBOX to avoid unwanted wrapping of last letter when\n\t\t// the font is bold on XP Classic theme (other font styles and desktop themes may also be cause this).\n\t\t// Avoiding this problem seems to outweigh the breaking of old scripts that use GroupBoxes with more than\n\t\t// one line of text (which are likely to be very rare).\n\t\t//opt.style_add |= BS_MULTILINE;\n\t\tbreak;\n\t}\n\n\t/////////////////////////////\n\t// Parse the list of options.\n\t/////////////////////////////\n\tif (!ControlParseOptions(aOptions, opt, control))\n\t{\n\t\tdelete pcontrol;\n\t\treturn FAIL; // It already displayed the error.\n\t}\n\n\t// The following is needed by ControlSetListViewOptions/ControlSetTreeViewOptions, and possibly others\n\t// in the future. It applies mCurrentColor as a default if no color was specified for the control.\n\tbool uses_font_and_text_color = control.UsesFontAndTextColor();\n\tif (uses_font_and_text_color) // Must check this to avoid corrupting union_hbitmap for PIC controls.\n\t{\n\t\tif (opt.color == CLR_INVALID) // No color was specified in options param.\n\t\t\topt.color = mCurrentColor;\n\t\tif (control.UsesUnionColor()) // Must check this to avoid corrupting other union members.\n\t\t\tcontrol.union_color = opt.color;\n\t}\n\t// This is not done because it would be inconsistent with the other controls (Progress\n\t// does not react to changes in the window color) and because applying a background\n\t// color requires removing the control's theme:\n\t//if (aControlType == GUI_CONTROL_PROGRESS && opt.color_bk == CLR_INVALID)\n\t//\topt.color_bk = mBackgroundColorWin; // Use the current background color.\n\t// If either color is CLR_DEFAULT, that would be either because the options contained\n\t// cDefault/BackgroundDefault, or because the Gui's current text/background color has\n\t// not been set. In either case, set it to CLR_INVALID to indicate \"no change needed\".\n\tif (opt.color == CLR_DEFAULT)\n\t\topt.color = CLR_INVALID;\n\tif (opt.color_bk == CLR_DEFAULT)\n\t{\n\t\tif (aControlType != GUI_CONTROL_TREEVIEW) // v1.1.08: Always set the back-color of a TreeView, otherwise it sends WM_CTLCOLOREDIT on Win2k/XP (or if it is not themed).\n\t\t\topt.color_bk = CLR_INVALID;\n\t}\n\n\t// Change for v1.0.45 (buttons) and v1.0.47.04 (checkboxes and radios): Under some desktop themes and\n\t// unusual DPI settings, it has been reported that the last letter of the control's text gets truncated\n\t// and/or causes an unwanted wrap that prevents proper display of the text. To solve this, default to\n\t// \"wrapping enabled\" only when necessary. One case it's usually necessary is when there's an explicit\n\t// width present because then the text can automatically word-wrap to the next line if it contains any\n\t// spaces/tabs/dashes (this also improves backward compatibility).\n\tDWORD contains_bs_multiline_if_applicable =\n\t\t(opt.width != COORD_UNSPECIFIED || opt.height != COORD_UNSPECIFIED\n\t\t\t|| opt.row_count > 1.5 || StrChrAny(aText, _T(\"\\n\\r\"))) // Both LF and CR can start new lines.\n\t\t? (BS_MULTILINE & ~opt.style_remove) // Add BS_MULTILINE unless it was explicitly removed.\n\t\t: 0; // Otherwise: Omit BS_MULTILINE (unless it was explicitly added [the \"0\" is verified correct]) because on some unusual DPI settings (i.e. DPIs other than 96 or 120), DrawText() sometimes yields a width that is slightly too narrow, which causes unwanted wrapping in single-line checkboxes/radios/buttons.\n\n\tDWORD style = opt.style_add & ~opt.style_remove;\n\tDWORD exstyle = opt.exstyle_add & ~opt.exstyle_remove;\n\n\t//////////////////////////////////////////\n\t// Force any mandatory styles into effect.\n\t//////////////////////////////////////////\n\tstyle |= WS_CHILD; // All control types must have this, even if script attempted to remove it explicitly.\n\tswitch (aControlType)\n\t{\n\tcase GUI_CONTROL_GROUPBOX:\n\t\t// There doesn't seem to be any flexibility lost by forcing the buttons to be the right type,\n\t\t// and doing so improves maintainability and peace-of-mind:\n\t\tstyle = (style & ~BS_TYPEMASK) | BS_GROUPBOX; // Force it to be the right type of button.\n\t\tbreak;\n\tcase GUI_CONTROL_BUTTON:\n\t\tif (style & BS_DEFPUSHBUTTON) // i.e. its single bit is present. BS_TYPEMASK is not involved in this line because it's a purity check.\n\t\t\tstyle = (style & ~BS_TYPEMASK) | BS_DEFPUSHBUTTON; // Done to ensure the lowest four bits are pure.\n\t\telse\n\t\t\tstyle &= ~BS_TYPEMASK; // Force it to be the right type of button --> BS_PUSHBUTTON == 0\n\t\tstyle |= contains_bs_multiline_if_applicable;\n\t\tbreak;\n\tcase GUI_CONTROL_CHECKBOX:\n\t\t// Note: BS_AUTO3STATE and BS_AUTOCHECKBOX are mutually exclusive due to their overlap within\n\t\t// the bit field:\n\t\tif ((style & BS_AUTO3STATE) == BS_AUTO3STATE) // Fixed for v1.0.45.03 to check if all the BS_AUTO3STATE bits are present, not just \"any\" of them. BS_TYPEMASK is not involved here because this is a purity check, and TYPEMASK would defeat the whole purpose.\n\t\t\tstyle = (style & ~BS_TYPEMASK) | BS_AUTO3STATE; // Done to ensure the lowest four bits are pure.\n\t\telse\n\t\t\tstyle = (style & ~BS_TYPEMASK) | BS_AUTOCHECKBOX; // Force it to be the right type of button.\n\t\tstyle |= contains_bs_multiline_if_applicable; // v1.0.47.04: Added to avoid unwanted wrapping on systems with unusual DPI settings (DPIs other than 96 and 120 sometimes seem to cause a roundoff problem with DrawText()).\n\t\tbreak;\n\tcase GUI_CONTROL_RADIO:\n\t\tstyle = (style & ~BS_TYPEMASK) | BS_AUTORADIOBUTTON; // Force it to be the right type of button.\n\t\t// This below must be handled here rather than in the set-defaults section because this\n\t\t// radio might be the first of its group due to the script having explicitly specified the word\n\t\t// Group in options (useful to make two adjacent radio groups).\n\t\tif (style & WS_GROUP && !(opt.style_remove & WS_TABSTOP))\n\t\t\tstyle |= WS_TABSTOP;\n\t\t// Otherwise it lacks a tabstop by default.\n\t\tstyle |= contains_bs_multiline_if_applicable; // v1.0.47.04: Added to avoid unwanted wrapping on systems with unusual DPI settings (DPIs other than 96 and 120 sometimes seem to cause a roundoff problem with DrawText()).\n\t\tbreak;\n\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\tstyle |= CBS_DROPDOWNLIST; // This works because CBS_DROPDOWNLIST == CBS_SIMPLE|CBS_DROPDOWN\n\t\tbreak;\n\tcase GUI_CONTROL_COMBOBOX:\n\t\tif (style & CBS_SIMPLE) // i.e. CBS_SIMPLE has been added to the original default, so assume it is SIMPLE.\n\t\t\tstyle = (style & ~0x0F) | CBS_SIMPLE; // Done to ensure the lowest four bits are pure.\n\t\telse\n\t\t\tstyle = (style & ~0x0F) | CBS_DROPDOWN; // Done to ensure the lowest four bits are pure.\n\t\tbreak;\n\tcase GUI_CONTROL_LISTBOX:\n\t\tstyle |= LBS_NOTIFY; // There doesn't seem to be any flexibility lost by forcing this style.\n\t\tbreak;\n\tcase GUI_CONTROL_EDIT:\n\t\t// This is done for maintainability and peace-of-mind, though it might not strictly be required\n\t\t// to be done at this stage:\n\t\tif (opt.row_count > 1.5 || _tcschr(aText, '\\n')) // Multiple rows or contents contain newline.\n\t\t\tstyle |= (ES_MULTILINE & ~opt.style_remove); // Add multiline unless it was explicitly removed.\n\t\t// This next check is relied upon by other things. If this edit has the multiline style either\n\t\t// due to the above check or any other reason, provide other default styles if those styles\n\t\t// weren't explicitly removed in the options list:\n\t\tif (style & ES_MULTILINE) // If allowed, enable vertical scrollbar and capturing of ENTER keystrokes.\n\t\t\t// Safest to include ES_AUTOVSCROLL, though it appears to have no effect on XP. See also notes below:\n\t\t\t#define EDIT_MULTILINE_DEFAULT (WS_VSCROLL|ES_WANTRETURN|ES_AUTOVSCROLL)\n\t\t\tstyle |= EDIT_MULTILINE_DEFAULT & ~opt.style_remove;\n\t\t\t// In addition, word-wrapping is implied unless explicitly disabled via -wrap in options.\n\t\t\t// This is because -wrap adds the ES_AUTOHSCROLL style.\n\t\t// else: Single-line edit. ES_AUTOHSCROLL will be applied later below if all the other checks\n\t\t// fail to auto-detect this edit as a multi-line edit.\n\t\t// Notes: ES_MULTILINE is required for any CRLFs in the default value to display correctly.\n\t\t// If ES_MULTILINE is in effect: \"If you do not specify ES_AUTOHSCROLL, the control automatically\n\t\t// wraps words to the beginning of the next line when necessary.\"\n\t\t// Also, ES_AUTOVSCROLL seems to have no additional effect, perhaps because this window type\n\t\t// is considered to be a dialog. MSDN: \"When the multiline edit control is not in a dialog box\n\t\t// and the ES_AUTOVSCROLL style is specified, the edit control shows as many lines as possible\n\t\t// and scrolls vertically when the user presses the ENTER key. If you do not specify ES_AUTOVSCROLL,\n\t\t// the edit control shows as many lines as possible and beeps if the user presses the ENTER key when\n\t\t// no more lines can be displayed.\"\n\t\tbreak;\n\tcase GUI_CONTROL_TAB:\n\t\tstyle |= WS_CLIPSIBLINGS; // MSDN: Both the parent window and the tab control must have the WS_CLIPSIBLINGS window style.\n\t\t// TCS_OWNERDRAWFIXED is required to implement custom Text color in the tabs.\n\t\t// For some reason, it's also required for TabWindowProc's WM_ERASEBKGND to be able to\n\t\t// override the background color of the control's interior, at least when an XP theme is in effect.\n\t\tif (control.background_brush\n\t\t\t|| mBackgroundBrushWin && control.background_color != CLR_DEFAULT\n\t\t\t|| IS_AN_ACTUAL_COLOR(opt.color))\n\t\t{\n\t\t\tstyle |= TCS_OWNERDRAWFIXED;\n\t\t\t// Even if use_theme is true, the theme won't be applied due to the above style.\n\t\t\topt.use_theme = false; // Let CreateTabDialog() know not to enable the theme.\n\t\t}\n\t\telse\n\t\t\tstyle &= ~TCS_OWNERDRAWFIXED;\n\t\tif (opt.width != COORD_UNSPECIFIED) // If a width was specified, don't autosize horizontally.\n\t\t\topt.tab_control_autosize &= ~TAB3_AUTOWIDTH;\n\t\tif (opt.height != COORD_UNSPECIFIED)\n\t\t\topt.tab_control_autosize &= ~TAB3_AUTOHEIGHT;\n\t\tbreak;\n\n\t// Nothing extra for these currently:\n\t//case GUI_CONTROL_TEXT: Ensuring SS_BITMAP and such are absent seems too over-protective.\n\t//case GUI_CONTROL_LINK:\n\t//case GUI_CONTROL_PIC: SS_BITMAP/SS_ICON are applied after the control isn't created so that it doesn't try to auto-load a resource.\n\t//case GUI_CONTROL_LISTVIEW:\n\t//case GUI_CONTROL_TREEVIEW:\n\t//case GUI_CONTROL_DATETIME:\n\t//case GUI_CONTROL_MONTHCAL:\n\t//case GUI_CONTROL_HOTKEY:\n\t//case GUI_CONTROL_UPDOWN:\n\t//case GUI_CONTROL_SLIDER:\n\t//case GUI_CONTROL_PROGRESS:\n\t//case GUI_CONTROL_ACTIVEX:\n\t//case GUI_CONTROL_STATUSBAR:\n\t}\n\n\t// The below will yield NULL for GUI_CONTROL_STATUSBAR because control.tab_control_index==OutOfBounds for it.\n\tGuiControlType *owning_tab_control = FindTabControl(control.tab_control_index); // For use in various places.\n\tGuiControlType *prev_control = mControlCount ? mControl[mControlCount - 1] : NULL; // For code size reduction, performance, and maintainability.\n\n\t////////////////////////////////////////////////////////////////////////////////////////////\n\t// Automatically set the control's position in the client area if no position was specified.\n\t////////////////////////////////////////////////////////////////////////////////////////////\n\tif (opt.x == COORD_UNSPECIFIED && opt.y == COORD_UNSPECIFIED)\n\t{\n\t\tif (owning_tab_control && !GetControlCountOnTabPage(control.tab_control_index, control.tab_index)) // Relies on short-circuit boolean.\n\t\t{\n\t\t\t// Since this control belongs to a tab control and that tab control already exists,\n\t\t\t// Position it relative to the tab control's client area upper-left corner if this\n\t\t\t// is the first control on this particular tab/page:\n\t\t\tPOINT pt = GetPositionOfTabDisplayArea(*owning_tab_control);\n\t\t\t// Since both coords were unspecified, position this control at the upper left corner of its page.\n\t\t\topt.x = pt.x + mMarginX;\n\t\t\topt.y = pt.y + mMarginY;\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// GUI_CONTROL_STATUSBAR ignores these:\n\t\t\t// Since both coords were unspecified, proceed downward from the previous control, using a default margin.\n\t\t\topt.x = mPrevX;\n\t\t\topt.y = mPrevY + mPrevHeight + mMarginY; // Don't use mMaxExtentDown in this is a new column.\n\t\t}\n\t\tif ((aControlType == GUI_CONTROL_TEXT || aControlType == GUI_CONTROL_LINK) && prev_control // This is a text control and there is a previous control before it.\n\t\t\t&& (prev_control->type == GUI_CONTROL_TEXT || prev_control->type == GUI_CONTROL_LINK)\n\t\t\t&& prev_control->tab_control_index == control.tab_control_index // v1.0.44.03: Don't do the adjustment if\n\t\t\t&& prev_control->tab_index == control.tab_index) // it's on another page or in another tab control.\n\t\t\t// Since this text control is being auto-positioned immediately below another, provide extra\n\t\t\t// margin space so that any edit control, dropdownlist, or other \"tall input\" control later added\n\t\t\t// to its right in \"vertical progression\" mode will line up with it.\n\t\t\t// v1.0.44: For code simplicity, this doesn't handle any status bar that might be present in between,\n\t\t\t// since that seems too rare and the consequences too mild.\n\t\t\topt.y += GUI_CTL_VERTICAL_DEADSPACE;\n\t}\n\t// Can't happen due to the logic in the options-parsing section:\n\t//else if (opt.x == COORD_UNSPECIFIED)\n\t//\topt.x = mPrevX;\n\t//else if (y == COORD_UNSPECIFIED)\n\t//\topt.y = mPrevY;\n\n\n\t/////////////////////////////////////////////////////////////////////////////////////\n\t// For certain types of controls, provide a standard row_count if none was specified.\n\t/////////////////////////////////////////////////////////////////////////////////////\n\n\t// Set default for all control types. GUI_CONTROL_MONTHCAL must be set up here because\n\t// an explicitly specified row-count must also avoid calculating height from row count\n\t// in the standard way.\n\tbool calc_height_later = aControlType == GUI_CONTROL_MONTHCAL || aControlType == GUI_CONTROL_LISTVIEW\n\t\t || aControlType == GUI_CONTROL_TREEVIEW;\n\tbool calc_control_height_from_row_count = !calc_height_later; // Set default.\n\n\tif (opt.height == COORD_UNSPECIFIED && opt.row_count < 1)\n\t{\n\t\tswitch(aControlType)\n\t\t{\n\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\tcase GUI_CONTROL_COMBOBOX: // For these 2, row-count is defined as the number of items to display in the list.\n\t\t\t// Update: Unfortunately, heights taller than the desktop do not work: pre-v6 common controls\n\t\t\t// misbehave when the height is too tall to fit on the screen. So the below comment is\n\t\t\t// obsolete and kept only for reference:\n\t\t\t// Since no height or row-count was given, make the control very tall so that OSes older than\n\t\t\t// XP will behavior similar to XP: they will let the desktop height determine how tall the\n\t\t\t// control can be. One exception to this is a true CBS_SIMPLE combo, which has appearance\n\t\t\t// and functionality similar to a ListBox. In that case, a default row-count is provided\n\t\t\t// since that is more appropriate than having a really tall box hogging the window.\n\t\t\t// Because CBS_DROPDOWNLIST includes both CBS_SIMPLE and CBS_DROPDOWN, a true \"simple\"\n\t\t\t// (which is similar to a listbox) must omit CBS_DROPDOWN:\n\t\t\topt.row_count = 3; // Actual height will be calculated below using this.\n\t\t\t// Avoid doing various calculations later below if the XP+ will ignore the height anyway.\n\t\t\t// CBS_NOINTEGRALHEIGHT is checked in case that style was explicitly applied to the control\n\t\t\t// by the script. This is because on XP+ it will cause the combo/DropDownList to obey the\n\t\t\t// specified default height set above. Also, for a pure CBS_SIMPLE combo, the OS always\n\t\t\t// obeys height:\n\t\t\tif ((!(style & CBS_SIMPLE) || (style & CBS_DROPDOWN)) // Not a pure CBS_SIMPLE.\n\t\t\t\t&& !(style & CBS_NOINTEGRALHEIGHT)) // ... and it won't obey the height.\n\t\t\t\tcalc_control_height_from_row_count = false; // Don't bother calculating the height (i.e. override the default).\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\topt.row_count = 3; // Actual height will be calculated below using this.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_LISTVIEW:\n\t\tcase GUI_CONTROL_TREEVIEW:\n\t\tcase GUI_CONTROL_CUSTOM:\n\t\t\topt.row_count = 5; // Actual height will be calculated below using this.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t// Seems more appropriate to give GUI_CONTROL_GROUPBOX exactly two rows: the first for the\n\t\t\t// title of the group-box and the second for its content (since it might contain controls\n\t\t\t// placed horizontally end-to-end, and thus only need one row).\n\t\t\topt.row_count = 2;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_EDIT:\n\t\t\t// If there's no default text in the control from which to later calc the height, use a basic default.\n\t\t\tif (!*aText)\n\t\t\t\topt.row_count = (style & ES_MULTILINE) ? 3.0F : 1.0F;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_DATETIME:\n\t\tcase GUI_CONTROL_HOTKEY:\n\t\t\topt.row_count = 1;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_UPDOWN: // A somewhat arbitrary default in case it will lack a buddy to \"snap to\".\n\t\t\t// Make vertical up-downs tall by default. If their width has also been omitted, they\n\t\t\t// will be made narrow by default in a later section.\n\t\t\tif (style & UDS_HORZ)\n\t\t\t\t// Height vs. row_count is specified to ensure the same thickness for both vertical\n\t\t\t\t// and horizontal up-downs:\n\t\t\t\topt.height = PROGRESS_DEFAULT_THICKNESS; // Seems okay for up-down to use Progress's thickness.\n\t\t\telse\n\t\t\t\topt.row_count = 5.0F;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t// Make vertical trackbars tall by default. If their width has also been omitted, they\n\t\t\t// will be made narrow by default in a later section.\n\t\t\tif (style & TBS_VERT)\n\t\t\t\topt.row_count = 5.0F;\n\t\t\telse\n\t\t\t\topt.height = ControlGetDefaultSliderThickness(style, opt.thickness);\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_PROGRESS:\n\t\t\t// Make vertical progress bars tall by default. If their width has also been omitted, they\n\t\t\t// will be made narrow by default in a later section.\n\t\t\tif (style & PBS_VERTICAL)\n\t\t\t\topt.row_count = 5.0F;\n\t\t\telse\n\t\t\t\t// Height vs. row_count is specified to ensure the same thickness for both vertical\n\t\t\t\t// and horizontal progress bars:\n\t\t\t\topt.height = PROGRESS_DEFAULT_THICKNESS;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_TAB:\n\t\t\topt.row_count = 10;\n\t\t\tbreak;\n\t\t// Types not included\n\t\t// ------------------\n\t\t//case GUI_CONTROL_TEXT: Rows are based on control's contents.\n\t\t//case GUI_CONTROL_LINK: Rows are based on control's contents.\n\t\t//case GUI_CONTROL_PIC: N/A\n\t\t//case GUI_CONTROL_BUTTON: Rows are based on control's contents.\n\t\t//case GUI_CONTROL_CHECKBOX: Same\n\t\t//case GUI_CONTROL_RADIO: Same\n\t\t//case GUI_CONTROL_MONTHCAL: Leave row-count unspecified so that an explicit r1 can be distinguished from \"unspecified\".\n\t\t//case GUI_CONTROL_ACTIVEX: N/A\n\t\t//case GUI_CONTROL_STATUSBAR: For now, row-count is ignored/unused.\n\t\t}\n\t}\n\telse // Either a row_count or a height was explicitly specified.\n\t\t// If OS is XP+, must apply the CBS_NOINTEGRALHEIGHT style for these reasons:\n\t\t// 1) The app now has a manifest, which tells OS to use common controls v6.\n\t\t// 2) Common controls v6 will not obey the the user's specified height for the control's\n\t\t// list portion unless the CBS_NOINTEGRALHEIGHT style is present.\n\t\tif (aControlType == GUI_CONTROL_DROPDOWNLIST || aControlType == GUI_CONTROL_COMBOBOX)\n\t\t\tstyle |= CBS_NOINTEGRALHEIGHT; // Forcibly applied, even if removed in options.\n\n\t////////////////////////////////////////////////////////////////////////////////////////////\n\t// In case the control being added requires an HDC to calculate its size, provide the means.\n\t////////////////////////////////////////////////////////////////////////////////////////////\n\tHDC hdc = NULL;\n\tHFONT hfont_old = NULL;\n\tTEXTMETRIC tm; // Used in more than one place.\n\t// To improve maintainability, always use this macro to deal with the above.\n\t// HDC will be released much further below when it is no longer needed.\n\t// Remember to release DC if ever need to return FAIL in the middle of auto-sizing/positioning.\n\t#define GUI_SET_HDC \\\n\t\tif (!hdc)\\\n\t\t{\\\n\t\t\thdc = GetDC(mHwnd);\\\n\t\t\thfont_old = (HFONT)SelectObject(hdc, sFont[mCurrentFontIndex].hfont);\\\n\t\t}\n\n\t//////////////////////////////////////////////////////////////////////////////////////\n\t// If a row-count was specified or made available by the above defaults, calculate the\n\t// control's actual height (to be used when creating the window). Note: If both\n\t// row_count and height were explicitly specified, row_count takes precedence.\n\t//////////////////////////////////////////////////////////////////////////////////////\n\tif (opt.row_count > 0)\n\t{\n\t\t// For GroupBoxes, add 1 to any row_count greater than 1 so that the title itself is\n\t\t// already included automatically. In other words, the R-value specified by the user\n\t\t// should be the number of rows available INSIDE the box.\n\t\t// For DropDownLists and ComboBoxes, 1 is added because row_count is defined as the\n\t\t// number of rows shown in the drop-down portion of the control, so we need one extra\n\t\t// (used in later calculations) for the always visible portion of the control.\n\t\tswitch (aControlType)\n\t\t{\n\t\tcase GUI_CONTROL_GROUPBOX:\n\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\tcase GUI_CONTROL_COMBOBOX: // LISTVIEW has custom handling later on, so isn't listed here.\n\t\t\t++opt.row_count;\n\t\t\tbreak;\n\t\t}\n\t\tif (calc_control_height_from_row_count)\n\t\t{\n\t\t\tGUI_SET_HDC\n\t\t\tGetTextMetrics(hdc, &tm);\n\t\t\t// Calc the height by adding up the font height for each row, and including the space between lines\n\t\t\t// (tmExternalLeading) if there is more than one line. 0.5 is used in two places to prevent\n\t\t\t// negatives in one, and round the overall result in the other.\n\t\t\topt.height = (int)((tm.tmHeight * opt.row_count) + (tm.tmExternalLeading * ((int)(opt.row_count + 0.5) - 1)) + 0.5);\n\t\t\tswitch (aControlType)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\t\tcase GUI_CONTROL_COMBOBOX:\n\t\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\tcase GUI_CONTROL_DATETIME:\n\t\t\tcase GUI_CONTROL_HOTKEY:\n\t\t\tcase GUI_CONTROL_CUSTOM:\n\t\t\t\topt.height += GUI_CTL_VERTICAL_DEADSPACE;\n\t\t\t\tif (style & WS_HSCROLL)\n\t\t\t\t\topt.height += GetSystemMetrics(SM_CYHSCROLL);\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\t// Provide a extra space for top/bottom margin together, proportional to the current font\n\t\t\t\t// size so that it looks better with very large or small fonts. Logical font height - 1\n\t\t\t\t// looks about right on all font sizes, and with default font size on 100% DPI it gives a\n\t\t\t\t// height of 23, which is what Microsoft recommends: https://msdn.microsoft.com/library/dn742402.aspx#sizing\n\t\t\t\topt.height += -sFont[mCurrentFontIndex].lfHeight - 1;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_GROUPBOX: // Since groups usually contain other controls, the below sizing seems best.\n\t\t\t\t// Use row_count-2 because of the +1 added above for GUI_CONTROL_GROUPBOX.\n\t\t\t\t// The current font's height is added in to provide an upper/lower margin in the box\n\t\t\t\t// proportional to the current font size, which makes it look better in most cases:\n\t\t\t\topt.height += mMarginY * (2 + ((int)(opt.row_count + 0.5) - 2));\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_TAB:\n\t\t\t\topt.height += mMarginY * (2 + ((int)(opt.row_count + 0.5) - 1)); // -1 vs. the -2 used above.\n\t\t\t\tbreak;\n\t\t\t// Types not included\n\t\t\t// ------------------\n\t\t\t//case GUI_CONTROL_TEXT: Uses basic height calculated above the switch().\n\t\t\t//case GUI_CONTROL_LINK: Uses basic height calculated above the switch().\n\t\t\t//case GUI_CONTROL_PIC: Uses basic height calculated above the switch() (seems OK even for pic).\n\t\t\t//case GUI_CONTROL_CHECKBOX: Uses basic height calculated above the switch().\n\t\t\t//case GUI_CONTROL_RADIO: Same.\n\t\t\t//case GUI_CONTROL_UPDOWN: Same.\n\t\t\t//case GUI_CONTROL_SLIDER: Same.\n\t\t\t//case GUI_CONTROL_PROGRESS: Same.\n\t\t\t//case GUI_CONTROL_MONTHCAL: Not included at all in this section because it treats \"rows\" differently.\n\t\t\t//case GUI_CONTROL_ACTIVEX: N/A\n\t\t\t//case GUI_CONTROL_STATUSBAR: N/A\n\t\t\t} // switch\n\t\t}\n\t\telse // calc_control_height_from_row_count == false\n\t\t\t// Assign a default just to allow the control to be created successfully. 13 is the default\n\t\t\t// height of a text/radio control for the typical 8 point font size, but the exact value\n\t\t\t// shouldn't matter (within reason) since calc_control_height_from_row_count is telling us this type of\n\t\t\t// control will not obey the height anyway. Update: It seems better to use a small constant\n\t\t\t// value to help catch bugs while still allowing the control to be created:\n\t\t\tif (!calc_height_later)\n\t\t\t\topt.height = DPIScale(30);\n\t\t\t//else MONTHCAL and others must keep their \"unspecified height\" value for later detection.\n\t}\n\n\tbool control_width_was_set_by_contents = false;\n\n\tif (opt.height == COORD_UNSPECIFIED || opt.width == COORD_UNSPECIFIED)\n\t{\n\t\t// Set defaults:\n\t\tint extra_width = 0, extra_height = 0;\n\t\tUINT draw_format = DT_CALCRECT;\n\n\t\tswitch (aControlType)\n\t\t{\n\t\tcase GUI_CONTROL_EDIT:\n\t\t\tif (!*aText) // Only auto-calculate edit's dimensions if there is text to do it with.\n\t\t\t\tbreak;\n\t\t\t// Since edit controls leave approximate 1 avg-char-width margin on the right side,\n\t\t\t// and probably exactly 4 pixels on the left counting its border and the internal\n\t\t\t// margin), adjust accordingly so that DrawText() will calculate the correct\n\t\t\t// control height based on word-wrapping. Note: Can't use EM_GETRECT because\n\t\t\t// control doesn't exist yet (though that might be an alternative approach for\n\t\t\t// the future):\n\t\t\tGUI_SET_HDC\n\t\t\tGetTextMetrics(hdc, &tm);\n\t\t\textra_width += 4 + tm.tmAveCharWidth;\n\t\t\t// Determine whether there will be a vertical scrollbar present. If ES_MULTILINE hasn't\n\t\t\t// already been applied or auto-detected above, it's possible that a scrollbar will be\n\t\t\t// added later due to the text auto-wrapping. In that case, the calculated height may\n\t\t\t// be incorrect due to the additional wrapping caused by the width taken up by the\n\t\t\t// scrollbar. Since this combination of circumstances is rare, and since there are easy\n\t\t\t// workarounds, it's just documented here as a limitation:\n\t\t\tif (style & WS_VSCROLL)\n\t\t\t\textra_width += GetSystemMetrics(SM_CXVSCROLL);\n\t\t\t// DT_EDITCONTROL: \"the average character width is calculated in the same manner as for an edit control\"\n\t\t\t// Although it's hard to say exactly what the quote above means, DT_EDITCONTROL definitely\n\t\t\t// affects the width of tab stops (making this consistent with Edit controls) and therefore\n\t\t\t// must be included. It also excludes the last line if it is empty, which is undesirable,\n\t\t\t// so we need to compensate for that:\n\t\t\tif (*aText && aText[_tcslen(aText)-1] == '\\n')\n\t\t\t\textra_height += tm.tmHeight + tm.tmExternalLeading;\n\t\t\t// Also include DT_EXPANDTABS under the assumption that if there are tabs present, the user\n\t\t\t// intended for them to be there because a multiline edit would expand them (rather than trying\n\t\t\t// to worry about whether this control *might* become auto-multiline after this point.\n\t\t\tdraw_format |= DT_EXPANDTABS|DT_EDITCONTROL|DT_NOPREFIX; // v1.0.44.10: Added DT_NOPREFIX because otherwise, if the text contains & or &&, the control won't be sized properly.\n\t\t\t// and now fall through and have the dimensions calculated based on what's in the control.\n\t\t\t// ABOVE FALLS THROUGH TO BELOW\n\t\tcase GUI_CONTROL_TEXT:\n\t\tcase GUI_CONTROL_BUTTON:\n\t\tcase GUI_CONTROL_CHECKBOX:\n\t\tcase GUI_CONTROL_RADIO:\n\t\tcase GUI_CONTROL_LINK:\n\t\t{\n\t\t\tGUI_SET_HDC\n\t\t\tif (aControlType == GUI_CONTROL_TEXT)\n\t\t\t{\n\t\t\t\tdraw_format |= DT_EXPANDTABS; // Buttons can't expand tabs, so don't add this for them.\n\t\t\t\tif (style & SS_NOPREFIX) // v1.0.44.10: This is necessary to auto-width the control properly if its contents include any ampersands.\n\t\t\t\t\tdraw_format |= DT_NOPREFIX;\n\t\t\t}\n\t\t\telse if (aControlType == GUI_CONTROL_CHECKBOX || aControlType == GUI_CONTROL_RADIO)\n\t\t\t{\n\t\t\t\t// Both Checkbox and Radio seem to have the same spacing characteristics:\n\t\t\t\t// Expand to allow room for button itself, its border, and the space between\n\t\t\t\t// the button and the first character of its label (this space seems to\n\t\t\t\t// be the same as tmAveCharWidth). +2 seems to be needed to make it work\n\t\t\t\t// for the various sizes of Courier New vs. Verdana that I tested. The\n\t\t\t\t// alternative, (2 * GetSystemMetrics(SM_CXEDGE)), seems to add a little\n\t\t\t\t// too much width (namely 4 vs. 2).\n\t\t\t\tGetTextMetrics(hdc, &tm);\n\t\t\t\textra_width += GetSystemMetrics(SM_CXMENUCHECK) + tm.tmAveCharWidth + 2; // v1.0.40.03: Reverted to +2 vs. +3 (it had been changed to +3 in v1.0.40.01).\n\t\t\t}\n\t\t\tif ((style & WS_BORDER) && (aControlType == GUI_CONTROL_TEXT || aControlType == GUI_CONTROL_LINK))\n\t\t\t{\n\t\t\t\t// This seems to be necessary only for Text and Link controls:\n\t\t\t\textra_width = 2 * GetSystemMetrics(SM_CXBORDER);\n\t\t\t\textra_height = 2 * GetSystemMetrics(SM_CYBORDER);\n\t\t\t}\n\t\t\tif ( opt.width != COORD_UNSPECIFIED // Since a width was given, auto-expand the height via word-wrapping,\n\t\t\t\t&& ( !(aControlType == GUI_CONTROL_BUTTON || aControlType == GUI_CONTROL_CHECKBOX || aControlType == GUI_CONTROL_RADIO)\n\t\t\t\t\t|| (style & BS_MULTILINE) ) ) // except when -Wrap is used on a Button, Checkbox or Radio.\n\t\t\t\tdraw_format |= DT_WORDBREAK;\n\n\t\t\tRECT draw_rect;\n\t\t\tdraw_rect.left = 0;\n\t\t\tdraw_rect.top = 0;\n\t\t\tdraw_rect.right = (opt.width == COORD_UNSPECIFIED) ? 0 : opt.width - extra_width; // extra_width\n\t\t\tdraw_rect.bottom = (opt.height == COORD_UNSPECIFIED) ? 0 : opt.height;\n\n\t\t\tint draw_height;\n\t\t\tTCHAR last_char = 0;\n\n\t\t\t// Since a Link control's text contains markup which isn't actually rendered, we need\n\t\t\t// to strip it out before calling DrawText or it will put out the size calculation:\n\t\t\tif (aControlType == GUI_CONTROL_LINK)\n\t\t\t{\n\t\t\t\t// Unless the control has the LWS_NOPREFIX style, the first ampersand causes the character\n\t\t\t\t// following it to be rendered with an underline, and the ampersand itself is not rendered.\n\t\t\t\t// Since DrawText has this same behaviour by default, we can simply set DT_NOPREFIX when\n\t\t\t\t// appropriate and it should handle the ampersands correctly.\n\t\t\t\tif (style & LWS_NOPREFIX)\n\t\t\t\t\tdraw_format |= DT_NOPREFIX;\n\n\t\t\t\tLPTSTR aTextCopy = new TCHAR[_tcslen(aText) + 1];\n\n\t\t\t\tLPCTSTR src;\n\t\t\t\tLPTSTR dst;\n\t\t\t\tfor (src = aText, dst = aTextCopy; *src; ++src)\n\t\t\t\t{\n\t\t\t\t\tif (*src == '<' && ctoupper(src[1]) == 'A')\n\t\t\t\t\t{\n\t\t\t\t\t\tLPCTSTR linkText = NULL;\n\t\t\t\t\t\tLPCTSTR cp = omit_leading_whitespace(src + 2);\n\n\t\t\t\t\t\t// It is important to note that while the SysLink control's syntax is similar to HTML,\n\t\t\t\t\t\t// it is not HTML. Some valid HTML won't work, and some invalid HTML will. Testing\n\t\t\t\t\t\t// indicates that whitespace is not required between \"<A\" and the attribute, so there\n\t\t\t\t\t\t// is no check to see if the above actually omitted whitespace.\n\t\t\t\t\t\tfor (;;)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (*cp == '>')\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tlinkText = cp + 1;\n\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t// Testing indicates that attribute names can only be alphanumeric chars. This\n\t\t\t\t\t\t\t// method of testing for the attribute name does not treat <a=\"\"> as an error,\n\t\t\t\t\t\t\t// which is perfect since the control tolerates it (the attribute is ignored).\n\t\t\t\t\t\t\twhile (cisalnum(*cp)) \n\t\t\t\t\t\t\t\tcp++;\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// What follows next must be the attribute value. Spaces are not tolerated.\n\t\t\t\t\t\t\tif (*cp != '=' || '\"' != cp[1])\n\t\t\t\t\t\t\t\tbreak; // Not valid.\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// Testing indicates that the attribute value can contain virtually anything,\n\t\t\t\t\t\t\t// including </a> but not quotation marks.\n\t\t\t\t\t\t\tcp = _tcschr(cp + 2, '\"');\n\t\t\t\t\t\t\tif (!cp)\n\t\t\t\t\t\t\t\tbreak; // Not valid.\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// Allow whitespace after the attribute (before '>' or the next attribute).\n\t\t\t\t\t\t\tcp = omit_leading_whitespace(cp + 1);\n\t\t\t\t\t\t} // for (attribute-parsing loop)\n\n\t\t\t\t\t\tif (linkText)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// Testing indicates that spaces in the end tag are not tolerated:\n\t\t\t\t\t\t\tif (auto endTag = tcscasestr(linkText, _T(\"</a>\")))\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t// Copy the link text and skip over the end tag.\n\t\t\t\t\t\t\t\tfor (cp = linkText; cp < endTag; *dst++ = *cp++);\n\t\t\t\t\t\t\t\tsrc = endTag + 3; // The outer loop's increment makes it + 4.\n\t\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t// Otherwise, there's no end tag so the begin tag is treated as text.\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// Otherwise, it wasn't a valid tag, so it is treated as text.\n\t\t\t\t\t} // if (found a tag)\n\t\t\t\t\t*dst++ = *src;\n\t\t\t\t} // for (searching for tag, copying text)\n\t\t\t\t\n\t\t\t\t*dst = '\\0';\n\n\t\t\t\tif (dst > aTextCopy)\n\t\t\t\t\tlast_char = dst[-1];\n\n\t\t\t\t// If no text, \"H\" is used in case the function requires a non-empty string to give consistent results:\n\t\t\t\tdraw_height = DrawText(hdc, *aTextCopy ? aTextCopy : _T(\"H\"), -1, &draw_rect, draw_format);\n\t\t\t\t\n\t\t\t\tdelete[] aTextCopy;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// If no text, \"H\" is used in case the function requires a non-empty string to give consistent results:\n\t\t\t\tdraw_height = DrawText(hdc, *aText ? aText : _T(\"H\"), -1, &draw_rect, draw_format);\n\t\t\t\tif (*aText)\n\t\t\t\t\tlast_char = aText[_tcslen(aText)-1];\n\t\t\t}\n\t\t\t\n\t\t\tint draw_width = draw_rect.right - draw_rect.left;\n\n\t\t\tswitch (aControlType)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\tif (contains_bs_multiline_if_applicable) // BS_MULTILINE style prevents the control from utilizing the extra space.\n\t\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_TEXT:\n\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\tif (!last_char)\n\t\t\t\t\tbreak;\n\t\t\t\t// draw_rect doesn't include the overhang of the last character, so adjust for that\n\t\t\t\t// to avoid clipping of italic fonts and other fonts where characters overlap.\n\t\t\t\t// This is currently only done for Text, Edit and Button controls because the other\n\t\t\t\t// control types won't utilize the extra space (they are apparently clipped according\n\t\t\t\t// to what the OS erroneously calculates the width of the text to be).\n\t\t\t\tABC abc;\n\t\t\t\tif (GetCharABCWidths(hdc, last_char, last_char, &abc))\n\t\t\t\t\tif (abc.abcC < 0)\n\t\t\t\t\t\tdraw_width -= abc.abcC;\n\t\t\t}\n\n\t\t\t// Even if either height or width was already explicitly specified above, it seems best to\n\t\t\t// override it if DrawText() says it's not big enough. REASONING: It seems too rare that\n\t\t\t// someone would want to use an explicit height/width to selectively hide part of a control's\n\t\t\t// contents, presumably for revelation later. If that is truly desired, ControlMove or\n\t\t\t// similar can be used to resize the control afterward. In addition, by specifying BOTH\n\t\t\t// width and height/rows, none of these calculations happens anyway, so that's another way\n\t\t\t// this override can be overridden. UPDATE for v1.0.44.10: The override is now not done for Edit\n\t\t\t// controls because unlike the other control types enumerated above, it is much more common to\n\t\t\t// have an Edit not be tall enough to show all of it's initial text. This fixes the following:\n\t\t\t// Gui, Add, Edit, r2 ,Line1`nLine2`nLine3`nLine4\n\t\t\t// Since there's no explicit width above, the r2 option (or even an H option) would otherwise\n\t\t\t// be overridden in favor of making the edit tall enough to hold all 4 lines.\n\t\t\t// Another reason for not changing the other control types to be like Edit is that backward\n\t\t\t// compatibility probably outweighs any value added by changing them (and the added value is dubious\n\t\t\t// when the comments above are carefully considered).\n\t\t\tif (opt.height == COORD_UNSPECIFIED || (draw_height > opt.height && aControlType != GUI_CONTROL_EDIT))\n\t\t\t{\n\t\t\t\topt.height = draw_height + extra_height;\n\t\t\t\tif (aControlType == GUI_CONTROL_EDIT)\n\t\t\t\t{\n\t\t\t\t\topt.height += GUI_CTL_VERTICAL_DEADSPACE;\n\t\t\t\t\tif (style & WS_HSCROLL)\n\t\t\t\t\t\topt.height += GetSystemMetrics(SM_CYHSCROLL);\n\t\t\t\t}\n\t\t\t\telse if (aControlType == GUI_CONTROL_BUTTON)\n\t\t\t\t\topt.height += -sFont[mCurrentFontIndex].lfHeight - 1; // See calc_control_height_from_row_count section for comments.\n\t\t\t}\n\t\t\tif (opt.width == COORD_UNSPECIFIED || draw_width > opt.width)\n\t\t\t{\n\t\t\t\t// v1.0.44.08: Fixed the following line by moving it into this IF block. This prevents\n\t\t\t\t// an up-down from widening its edit control when that edit control had an explicit width.\n\t\t\t\tcontrol_width_was_set_by_contents = true; // Indicate that this control was auto-width'd.\n\t\t\t\topt.width = draw_width + extra_width; // See comments above for why specified width is overridden.\n\t\t\t\tif (aControlType == GUI_CONTROL_BUTTON)\n\t\t\t\t\t// Allow room for border and an internal margin proportional to the font height.\n\t\t\t\t\t// Button's border is 3D by default, so SM_CXEDGE vs. SM_CXBORDER is used?\n\t\t\t\t\topt.width += 2 * GetSystemMetrics(SM_CXEDGE) + -sFont[mCurrentFontIndex].lfHeight; // Compared to the old way of using point_size, this is slightly wider (which looks better) and automatically scales by DPI.\n\t\t\t}\n\t\t\tbreak;\n\t\t} // case for text/button/checkbox/radio/link\n\n\t\t// Types not included\n\t\t// ------------------\n\t\t//case GUI_CONTROL_PIC: If needed, it is given some default dimensions at the time of creation.\n\t\t//case GUI_CONTROL_GROUPBOX: Seems too rare than anyone would want its width determined by its text.\n\t\t//case GUI_CONTROL_EDIT: It is included, but only if it has default text inside it.\n\t\t//case GUI_CONTROL_TAB: Seems too rare than anyone would want its width determined by tab-count.\n\n\t\t//case GUI_CONTROL_LISTVIEW: Has custom handling later below.\n\t\t//case GUI_CONTROL_TREEVIEW: Same.\n\t\t//case GUI_CONTROL_MONTHCAL: Same.\n\t\t//case GUI_CONTROL_ACTIVEX: N/A?\n\t\t//case GUI_CONTROL_STATUSBAR: Ignores width/height, so no need to handle here.\n\n\t\t//case GUI_CONTROL_DROPDOWNLIST: These last ones are given (later below) a standard width based on font size.\n\t\t//case GUI_CONTROL_COMBOBOX: In addition, their height has already been determined further above.\n\t\t//case GUI_CONTROL_LISTBOX:\n\t\t//case GUI_CONTROL_DATETIME:\n\t\t//case GUI_CONTROL_HOTKEY:\n\t\t//case GUI_CONTROL_UPDOWN:\n\t\t//case GUI_CONTROL_SLIDER:\n\t\t//case GUI_CONTROL_PROGRESS:\n\t\t} // switch()\n\t}\n\n\t//////////////////////////////////////////////////////////////////////////////////////////\n\t// If the width was not specified and the above did not already determine it (which should\n\t// only be possible for the cases contained in the switch-stmt below), provide a default.\n\t//////////////////////////////////////////////////////////////////////////////////////////\n\tif (opt.width == COORD_UNSPECIFIED)\n\t{\n\t\tint gui_standard_width = GUI_STANDARD_WIDTH; // Resolve macro only once for performance/code size.\n\t\tswitch(aControlType)\n\t\t{\n\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\tcase GUI_CONTROL_COMBOBOX:\n\t\tcase GUI_CONTROL_LISTBOX:\n\t\tcase GUI_CONTROL_HOTKEY:\n\t\tcase GUI_CONTROL_EDIT:\n\t\t\topt.width = gui_standard_width;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_LISTVIEW:\n\t\tcase GUI_CONTROL_TREEVIEW:\n\t\tcase GUI_CONTROL_DATETIME: // Seems better to have wider default to fit LongDate and because drop-down calendar is fairly wide (though the latter is a weak reason).\n\t\tcase GUI_CONTROL_CUSTOM:\n\t\t\topt.width = gui_standard_width * 2;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_UPDOWN: // Iffy, but needs some kind of default?\n\t\t\topt.width = (style & UDS_HORZ) ? gui_standard_width : PROGRESS_DEFAULT_THICKNESS; // Progress's default seems ok for up-down too.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t// Make vertical trackbars narrow by default. For vertical trackbars: there doesn't seem\n\t\t\t// to be much point in defaulting the width to something proportional to font size because\n\t\t\t// the thumb only seems to have two sizes and doesn't auto-grow any larger than that.\n\t\t\topt.width = (style & TBS_VERT) ? ControlGetDefaultSliderThickness(style, opt.thickness) : gui_standard_width;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_PROGRESS:\n\t\t\topt.width = (style & PBS_VERTICAL) ? PROGRESS_DEFAULT_THICKNESS : gui_standard_width;\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t// Since groups and tabs contain other controls, allow room inside them for a margin based\n\t\t\t// on current font size.\n\t\t\topt.width = gui_standard_width + (2 * mMarginX);\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_TAB:\n\t\t\t// Tabs tend to be wide so that that tabs can all fit on the top row, and because they\n\t\t\t// are usually used to fill up the entire window. Therefore, default them to the ability\n\t\t\t// to hold two columns of standard-width controls:\n\t\t\topt.width = (2 * gui_standard_width) + (3 * mMarginX); // 3 vs. 2 to allow space in between columns.\n\t\t\tbreak;\n\t\t// Types not included\n\t\t// ------------------\n\t\t//case GUI_CONTROL_TEXT: Exact width should already have been calculated based on contents.\n\t\t//case GUI_CONTROL_LINK: Exact width should already have been calculated based on contents.\n\t\t//case GUI_CONTROL_PIC: Calculated based on actual pic size if no explicit width was given.\n\t\t//case GUI_CONTROL_BUTTON: Exact width should already have been calculated based on contents.\n\t\t//case GUI_CONTROL_CHECKBOX: Same.\n\t\t//case GUI_CONTROL_RADIO: Same.\n\t\t//case GUI_CONTROL_MONTHCAL: Exact width will be calculated after the control is created (size to fit month).\n\t\t//case GUI_CONTROL_ACTIVEX: Defaults to zero width/height, which could be useful in some cases.\n\t\t//case GUI_CONTROL_STATUSBAR: Ignores width, so no need to handle here.\n\t\t}\n\t}\n\n\t/////////////////////////////////////////////////////////////////////////////////////////\n\t// For edit controls: If the above didn't already determine how many rows it should have,\n\t// auto-detect that by comparing the current font size with the specified height. At this\n\t// stage, the above has already ensured that an Edit has at least a height or a row_count.\n\t/////////////////////////////////////////////////////////////////////////////////////////\n\tif (aControlType == GUI_CONTROL_EDIT && !(style & ES_MULTILINE))\n\t{\n\t\tif (opt.row_count < 1) // Determine the row-count to auto-detect multi-line vs. single-line.\n\t\t{\n\t\t\tGUI_SET_HDC\n\t\t\tGetTextMetrics(hdc, &tm);\n\t\t\tint height_beyond_first_row = opt.height - GUI_CTL_VERTICAL_DEADSPACE - tm.tmHeight;\n\t\t\tif (style & WS_HSCROLL)\n\t\t\t\theight_beyond_first_row -= GetSystemMetrics(SM_CYHSCROLL);\n\t\t\tif (height_beyond_first_row > 0)\n\t\t\t{\n\t\t\t\topt.row_count = 1 + ((float)height_beyond_first_row / (tm.tmHeight + tm.tmExternalLeading));\n\t\t\t\t// This section is a near exact match for one higher above. Search for comment\n\t\t\t\t// \"Add multiline unless it was explicitly removed\" for a full explanation and keep\n\t\t\t\t// the below in sync with that section above:\n\t\t\t\tif (opt.row_count > 1.5)\n\t\t\t\t{\n\t\t\t\t\tstyle |= (ES_MULTILINE & ~opt.style_remove); // Add multiline unless it was explicitly removed.\n\t\t\t\t\t// Do the below only if the above actually added multiline:\n\t\t\t\t\tif (style & ES_MULTILINE) // If allowed, enable vertical scrollbar and capturing of ENTER keystrokes.\n\t\t\t\t\t\tstyle |= EDIT_MULTILINE_DEFAULT & ~opt.style_remove;\n\t\t\t\t\t// else: Single-line edit. ES_AUTOHSCROLL will be applied later below if all the other checks\n\t\t\t\t\t// fail to auto-detect this edit as a multi-line edit.\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // there appears to be only one row.\n\t\t\t\topt.row_count = 1;\n\t\t\t\t// And ES_AUTOHSCROLL will be applied later below if all the other checks\n\t\t\t\t// fail to auto-detect this edit as a multi-line edit.\n\t\t}\n\t}\n\n\t// If either height or width is still undetermined, leave it set to COORD_UNSPECIFIED since that\n\t// is a large negative number and should thus help catch bugs. In other words, the above\n\t// heuristics should be designed to handle all cases and always resolve height/width to something,\n\t// with the possible exception of things that auto-size based on external content such as\n\t// GUI_CONTROL_PIC.\n\n\t//////////////////////\n\t//\n\t// CREATE THE CONTROL.\n\t//\n\t//////////////////////\n\tbool do_strip_theme = !opt.use_theme; // Set defaults.\n\tbool retrieve_dimensions = false; //\n\tint item_height, min_list_height;\n\tRECT rect;\n\tHMENU control_id = (HMENU)(size_t)GUI_INDEX_TO_ID(mControlCount); // Cast to size_t avoids compiler warning.\n\tHWND parent_hwnd = mHwnd;\n\n\tbool font_was_set = false; // \"\n\tbool is_parent_visible = IsWindowVisible(mHwnd) && !IsIconic(mHwnd);\n\t#define GUI_SETFONT \\\n\t{\\\n\t\tSendMessage(control.hwnd, WM_SETFONT, (WPARAM)sFont[mCurrentFontIndex].hfont, is_parent_visible);\\\n\t\tfont_was_set = true;\\\n\t}\n\n\t// If a control is being added to a tab, even if the parent window is hidden (since it might\n\t// have been hidden by Gui, Cancel), make sure the control isn't visible unless it's on a\n\t// visible tab.\n\t// The below alters style vs. style_remove, since later below style_remove is checked to\n\t// find out if the control was explicitly hidden vs. hidden by the automatic action here:\n\tbool on_visible_page_of_tab_control = false;\n\tif (control.tab_control_index < MAX_TAB_CONTROLS) // This control belongs to a tab control (must check this even though FindTabControl() does too).\n\t{\n\t\tif (owning_tab_control) // Its tab control exists...\n\t\t{\n\t\t\tHWND tab_dialog = (HWND)GetProp(owning_tab_control->hwnd, _T(\"ahk_dlg\"));\n\t\t\tif (tab_dialog)\n\t\t\t{\n\t\t\t\t// Controls in a Tab3 control are created as children of an invisible dialog window\n\t\t\t\t// rather than as siblings of the tab control. This solves some visual glitches.\n\t\t\t\tparent_hwnd = tab_dialog;\n\t\t\t\tPOINT pt = { opt.x, opt.y };\n\t\t\t\tMapWindowPoints(mHwnd, parent_hwnd, &pt, 1); // Translate from GUI client area to tab client area.\n\t\t\t\topt.x = pt.x, opt.y = pt.y;\n\t\t\t}\n\t\t\tif (!(GetWindowLong(owning_tab_control->hwnd, GWL_STYLE) & WS_VISIBLE) // Don't use IsWindowVisible().\n\t\t\t\t|| TabCtrl_GetCurSel(owning_tab_control->hwnd) != control.tab_index)\n\t\t\t\t// ... but it's not set to the page/tab that contains this control, or the entire tab control is hidden.\n\t\t\t\tstyle &= ~WS_VISIBLE;\n\t\t\telse // Make the following true as long as the parent is also visible.\n\t\t\t\ton_visible_page_of_tab_control = is_parent_visible; // For use later below.\n\t\t}\n\t\telse // Its tab control does not exist, so this control is kept hidden until such time that it does.\n\t\t\tstyle &= ~WS_VISIBLE;\n\t}\n\t// else do nothing.\n\n\tswitch(aControlType)\n\t{\n\tcase GUI_CONTROL_TEXT:\n\t\t// Seems best to omit SS_NOPREFIX by default so that ampersand can be used to create shortcut keys.\n\t\tcontrol.hwnd = CreateWindowEx(exstyle, _T(\"static\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL);\n\t\tbreak;\n\n\tcase GUI_CONTROL_LINK:\n\t\t// Seems best to omit LWS_NOPREFIX by default so that ampersand can be used to create shortcut keys.\n\t\tcontrol.hwnd = CreateWindowEx(exstyle, _T(\"SysLink\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL);\n\t\tbreak;\n\n\tcase GUI_CONTROL_PIC:\n\t\tif (opt.width == COORD_UNSPECIFIED)\n\t\t\topt.width = 0; // Use zero to tell LoadPicture() to keep original width.\n\t\tif (opt.height == COORD_UNSPECIFIED)\n\t\t\topt.height = 0; // Use zero to tell LoadPicture() to keep original height.\n\t\t// Must set its caption to aText so that documented ability to refer to a picture by its original\n\t\t// filename is possible:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, _T(\"static\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height // OK if zero, control creation should still succeed.\n\t\t\t, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (!ControlLoadPicture(control, aText, opt.width, opt.height, opt.icon_number))\n\t\t\t{\n\t\t\t\t// GetLastError() isn't used because a variety of methods are used, and it is likely that\n\t\t\t\t// some failure cases haven't SetLastError().\n\t\t\t\tDestroyWindow(control.hwnd);\n\t\t\t\tcontrol.hwnd = NULL;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// UPDATE ABOUT THE BELOW: Rajat says he can't get the Smart GUI working without\n\t\t\t// the controls retaining their original numbering/z-order. This has to do with the fact\n\t\t\t// that TEXT controls and PIC controls are both static. If only PIC controls were reordered,\n\t\t\t// that's not enough to make things work for him. If only TEXT controls were ALSO reordered\n\t\t\t// to be at the top of the list (so that all statics retain their original ordering with\n\t\t\t// respect to each other) I have a 90% expectation (based on testing) that prefix/shortcut\n\t\t\t// keys inside static text controls would jump to the wrong control because their associated\n\t\t\t// control seems to be based solely on z-order. ANOTHER REASON NOT to ever change the z-order\n\t\t\t// of controls automatically: Every time a picture is added, it would increment the z-order\n\t\t\t// number of all other control types by 1. This is bad especially for text controls because\n\t\t\t// they are static just like pictures, and thus their Class+NN \"unique ID\" would change (as\n\t\t\t// seen by the ControlXXX commands) if a picture were ever added after a window was shown.\n\t\t\t// Older note: calling SetWindowPos() with HWND_TOPMOST doesn't seem to provide any useful\n\t\t\t// effect that I could discern (by contrast, HWND_TOP does actually move a control to the\n\t\t\t// top of the z-order).\n\t\t\t// The below is OBSOLETE and its code further below is commented out:\n\t\t\t// Facts about how overlapping controls are drawn vs. which one receives mouse clicks:\n\t\t\t// 1) The first control created is at the top of the Z-order (i.e. the lowest z-order number\n\t\t\t// and the first in tab navigation), the second is next, and so on.\n\t\t\t// 2) Controls get drawn in ascending Z-order (i.e. the first control is drawn first\n\t\t\t// and any later controls that overlap are drawn on top of it, except for controls that\n\t\t\t// have WS_CLIPSIBLINGS).\n\t\t\t// 3) When a user clicks a point that contains two overlapping controls and each control is\n\t\t\t// capable of capturing clicks, the one closer to the top captures the click even though it\n\t\t\t// was drawn beneath (overlapped by) the other control.\n\t\t\t// Because of this behavior, the following policy seems best:\n\t\t\t// 1) Move all static images to the top of the Z-order so that other controls are always\n\t\t\t// drawn on top of them. This is done because it seems to be the behavior that would\n\t\t\t// be desired at least 90% of the time.\n\t\t\t// 2) Do not do the same for static text and GroupBoxes because it seems too rare that\n\t\t\t// overlapping would be done in such cases, and even if it is done it seems more\n\t\t\t// flexible to allow the order in which the controls were created to determine how they\n\t\t\t// overlap and which one get the clicks.\n\t\t\t//\n\t\t\t// Rather than push static pictures to the top in the reverse order they were created -- \n\t\t\t// which might be a little more intuitive since the ones created first would then always\n\t\t\t// be \"behind\" ones created later -- for simplicity, we do it here at the time the control\n\t\t\t// is created. This avoids complications such as a picture being added after the\n\t\t\t// window is shown for the first time and then not getting sent to the top where it\n\t\t\t// should be. Update: The control is now kept in its original order for two reasons:\n\t\t\t// 1) The reason mentioned above (that later images should overlap earlier images).\n\t\t\t// 2) Allows Rajat's SmartGUI Creator to support picture controls (due to its grid background pic).\n\t\t\t// First find the last picture control in the array. The last one should already be beneath\n\t\t\t// all the others in the z-order due to having been originally added using the below method.\n\t\t\t// Might eventually need to switch to EnumWindows() if it's possible for Z-order to be\n\t\t\t// altered, or controls to be inserted between others, by any commands in the future.\n\t\t\t//GuiIndexType index_of_last_picture = UINT_MAX;\n\t\t\t//for (u = 0; u < mControlCount; ++u)\n\t\t\t//{\n\t\t\t//\tif (mControl[u].type == GUI_CONTROL_PIC)\n\t\t\t//\t\tindex_of_last_picture = u;\n\t\t\t//}\n\t\t\t//if (index_of_last_picture == UINT_MAX) // There are no other pictures, so put this one on top.\n\t\t\t//\tSetWindowPos(control.hwnd, HWND_TOP, 0, 0, 0, 0, SWP_DRAWFRAME|SWP_NOMOVE|SWP_NOSIZE);\n\t\t\t//else // Put this picture after the last picture in the z-order.\n\t\t\t//\tSetWindowPos(control.hwnd, mControl[index_of_last_picture].hwnd, 0, 0, 0, 0, SWP_DRAWFRAME|SWP_NOMOVE|SWP_NOSIZE);\n\t\t\t//// Adjust to control's actual size in case it changed for any reason (failure to load picture, etc.)\n\t\t\tretrieve_dimensions = true;\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_GROUPBOX:\n\t\t// In this case, BS_MULTILINE will obey literal newlines in the text, but it does not automatically\n\t\t// wrap the text, at least on XP. Since it's strange-looking to have multiple lines, newlines\n\t\t// should be rarely present anyway. Also, BS_NOTIFY seems to have no effect on GroupBoxes (it\n\t\t// never sends any BN_CLICKED/BN_DBLCLK messages). This has been verified twice.\n\t\tcontrol.hwnd = CreateWindowEx(exstyle, _T(\"Button\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL);\n\t\tbreak;\n\n\tcase GUI_CONTROL_BUTTON:\n\t\t// For all \"Button\" type controls, BS_MULTILINE is included by default so that any literal\n\t\t// newlines in the button's name will start a new line of text as the user intended.\n\t\t// In addition, this causes automatic wrapping to occur if the user specified a width\n\t\t// too small to fit the entire line.\n\t\tif (control.hwnd = CreateWindowEx(exstyle, _T(\"Button\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (style & BS_DEFPUSHBUTTON)\n\t\t\t{\n\t\t\t\t// First remove the style from the old default button, if there is one:\n\t\t\t\tif (mDefaultButtonIndex < mControlCount)\n\t\t\t\t{\n\t\t\t\t\t// MSDN says this is necessary in some cases:\n\t\t\t\t\t// Since the window might be visible at this point, send BM_SETSTYLE rather than\n\t\t\t\t\t// SetWindowLong() so that the button will get redrawn. Update: The redraw doesn't\n\t\t\t\t\t// actually seem to happen (both the old and the new buttons retain the default-button\n\t\t\t\t\t// appearance until the window gets entirely redraw such as via alt-tab). This is fairly\n\t\t\t\t\t// inexplicable since the exact same technique works with \"GuiControl +Default\". In any\n\t\t\t\t\t// case, this is kept because it also serves to change the default button appearance later,\n\t\t\t\t\t// which is received in the WindowProc via WM_COMMAND:\n\t\t\t\t\tSendMessage(mControl[mDefaultButtonIndex]->hwnd, BM_SETSTYLE\n\t\t\t\t\t\t, (WPARAM)LOWORD((GetWindowLong(mControl[mDefaultButtonIndex]->hwnd, GWL_STYLE) & ~BS_DEFPUSHBUTTON))\n\t\t\t\t\t\t, MAKELPARAM(TRUE, 0)); // Redraw = yes. It's probably smart enough not to do it if the window is hidden.\n\t\t\t\t\t// The below attempts to get the old button to lose its default-border failed. This might\n\t\t\t\t\t// be due to the fact that if the window hasn't yet been shown for the first time, its\n\t\t\t\t\t// client area isn't yet the right size, so the OS decides that no update is needed since\n\t\t\t\t\t// the control is probably outside the boundaries of the window:\n\t\t\t\t\t//InvalidateRect(mHwnd, NULL, TRUE);\n\t\t\t\t\t//GetClientRect(mControl[mDefaultButtonIndex].hwnd, &client_rect);\n\t\t\t\t\t//InvalidateRect(mControl[mDefaultButtonIndex].hwnd, &client_rect, TRUE);\n\t\t\t\t\t//ShowWindow(mHwnd, SW_SHOWNOACTIVATE); // i.e. don't activate it if it wasn't before.\n\t\t\t\t\t//ShowWindow(mHwnd, SW_HIDE);\n\t\t\t\t\t//UpdateWindow(mHwnd);\n\t\t\t\t\t//SendMessage(mHwnd, WM_NCPAINT, 1, 0);\n\t\t\t\t\t//RedrawWindow(mHwnd, NULL, NULL, RDW_INVALIDATE|RDW_FRAME|RDW_UPDATENOW);\n\t\t\t\t\t//SetWindowPos(mHwnd, NULL, 0, 0, 0, 0, SWP_DRAWFRAME|SWP_FRAMECHANGED|SWP_NOMOVE|SWP_NOSIZE|SWP_NOZORDER|SWP_NOACTIVATE);\n\t\t\t\t}\n\t\t\t\tmDefaultButtonIndex = mControlCount;\n\t\t\t\tSendMessage(mHwnd, DM_SETDEFID, (WPARAM)GUI_INDEX_TO_ID(mDefaultButtonIndex), 0);\n\t\t\t\t// Strangely, in spite of the control having been created with the BS_DEFPUSHBUTTON style,\n\t\t\t\t// need to send BM_SETSTYLE or else the default button will lack its visual style when the\n\t\t\t\t// dialog is first shown. Also strange is that the following must be done *after*\n\t\t\t\t// removing the visual/default style from the old default button and/or after doing\n\t\t\t\t// DM_SETDEFID above.\n\t\t\t\tSendMessage(control.hwnd, BM_SETSTYLE, (WPARAM)LOWORD(style), MAKELPARAM(TRUE, 0)); // Redraw = yes. It's probably smart enough not to do it if the window is hidden.\n\t\t\t}\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_CHECKBOX:\n\t\t// The BS_NOTIFY style is not a good idea for checkboxes because although it causes the control\n\t\t// to send BN_DBLCLK messages, any rapid clicks by the user on (for example) a tri-state checkbox\n\t\t// are seen only as one click for the purpose of changing the box's state.\n\t\tif (control.hwnd = CreateWindowEx(exstyle, _T(\"Button\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (opt.checked != BST_UNCHECKED) // Set the specified state.\n\t\t\t\tSendMessage(control.hwnd, BM_SETCHECK, opt.checked, 0);\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_RADIO:\n\t\tcontrol.hwnd = CreateWindowEx(exstyle, _T(\"Button\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL);\n\t\t// opt.checked is handled later below.\n\t\tbreak;\n\n\tcase GUI_CONTROL_DROPDOWNLIST:\n\tcase GUI_CONTROL_COMBOBOX:\n\t\t// It has been verified that that EM_LIMITTEXT has no effect when sent directly\n\t\t// to a ComboBox hwnd; however, it might work if sent to its edit-child. But for now,\n\t\t// a Combobox can only be limited to its visible width. Later, there might\n\t\t// be a way to send a message to its child control to limit its width directly.\n\t\tif (opt.limit && control.type == GUI_CONTROL_COMBOBOX)\n\t\t\tstyle &= ~CBS_AUTOHSCROLL;\n\t\t// Since the control's variable can change, it seems best to pass in the empty string\n\t\t// as the control's caption, rather than the name of the variable. The name of the variable\n\t\t// isn't that useful anymore anyway since GuiControl(Get) can access controls directly by\n\t\t// their current output-var names:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, _T(\"ComboBox\"), _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\t// Set font unconditionally to simplify calculations, which help ensure that at least one item\n\t\t\t// in the DropDownList/Combo is visible when the list drops down:\n\t\t\tGUI_SETFONT // Set font in preparation for asking it how tall each item is.\n\t\t\tif (calc_control_height_from_row_count)\n\t\t\t{\n\t\t\t\titem_height = (int)SendMessage(control.hwnd, CB_GETITEMHEIGHT, 0, 0);\n\t\t\t\t// Note that at this stage, height should contain a explicitly-specified height or height\n\t\t\t\t// estimate from the above, even if row_count is greater than 0.\n\t\t\t\t// The below calculation may need some fine tuning:\n\t\t\t\tint cbs_extra_height = ((style & CBS_SIMPLE) && !(style & CBS_DROPDOWN)) ? 4 : 2;\n\t\t\t\tmin_list_height = (2 * item_height) + GUI_CTL_VERTICAL_DEADSPACE + cbs_extra_height;\n\t\t\t\tif (opt.height < min_list_height) // Adjust so that at least 1 item can be shown.\n\t\t\t\t\topt.height = min_list_height;\n\t\t\t\telse if (opt.row_count > 0)\n\t\t\t\t\t// Now that we know the true item height (since the control has been created and we asked\n\t\t\t\t\t// it), resize the control to try to get it to the match the specified number of rows.\n\t\t\t\t\t// +2 seems to be the exact amount needed to prevent partial rows from showing\n\t\t\t\t\t// on all font sizes and themes when NOINTEGRALHEIGHT is in effect:\n\t\t\t\t\topt.height = (int)(opt.row_count * item_height) + GUI_CTL_VERTICAL_DEADSPACE + cbs_extra_height;\n\t\t\t}\n\t\t\tMoveWindow(control.hwnd, opt.x, opt.y, opt.width, opt.height, TRUE); // Repaint, since it might be visible.\n\t\t\t// Since combo's size is created to accommodate its drop-down height, adjust our true height\n\t\t\t// to its actual collapsed size. This true height is used for auto-positioning the next\n\t\t\t// control, if it uses auto-positioning. It might be possible for it's width to be different\n\t\t\t// also, such as if it snaps to a certain minimize width if one too small was specified,\n\t\t\t// so that is recalculated too:\n\t\t\tretrieve_dimensions = true;\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_LISTBOX:\n\t\t// See GUI_CONTROL_COMBOBOX above for why empty string is passed in as the caption:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, _T(\"ListBox\"), _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (opt.tabstop_count)\n\t\t\t\tSendMessage(control.hwnd, LB_SETTABSTOPS, opt.tabstop_count, (LPARAM)opt.tabstop);\n\t\t\t// For now, it seems best to always override a height that would cause zero items to be\n\t\t\t// displayed. This is because there is a very thin control visible even if the height\n\t\t\t// is explicitly set to zero, which seems pointless (there are other ways to draw thin\n\t\t\t// looking objects for unusual purposes anyway).\n\t\t\t// Set font unconditionally to simplify calculations, which help ensure that at least one item\n\t\t\t// in the DropDownList/Combo is visible when the list drops down:\n\t\t\tGUI_SETFONT // Set font in preparation for asking it how tall each item is.\n\t\t\titem_height = (int)SendMessage(control.hwnd, LB_GETITEMHEIGHT, 0, 0);\n\t\t\t// Note that at this stage, height should contain a explicitly-specified height or height\n\t\t\t// estimate from the above, even if opt.row_count is greater than 0.\n\t\t\tmin_list_height = item_height + GUI_CTL_VERTICAL_DEADSPACE;\n\t\t\tif (style & WS_HSCROLL)\n\t\t\t\t// Assume bar will be actually appear even though it won't in the rare case where\n\t\t\t\t// its specified pixel-width is smaller than the width of the window:\n\t\t\t\tmin_list_height += GetSystemMetrics(SM_CYHSCROLL);\n\t\t\tif (opt.height < min_list_height) // Adjust so that at least 1 item can be shown.\n\t\t\t\topt.height = min_list_height;\n\t\t\telse if (opt.row_count > 0)\n\t\t\t{\n\t\t\t\t// Now that we know the true item height (since the control has been created and we asked\n\t\t\t\t// it), resize the control to try to get it to the match the specified number of rows.\n\t\t\t\topt.height = (int)(opt.row_count * item_height) + GUI_CTL_VERTICAL_DEADSPACE;\n\t\t\t\tif (style & WS_HSCROLL)\n\t\t\t\t\t// Assume bar will be actually appear even though it won't in the rare case where\n\t\t\t\t\t// its specified pixel-width is smaller than the width of the window:\n\t\t\t\topt.height += GetSystemMetrics(SM_CYHSCROLL);\n\t\t\t}\n\t\t\tMoveWindow(control.hwnd, opt.x, opt.y, opt.width, opt.height, TRUE); // Repaint, since it might be visible.\n\t\t\t// Since by default, the OS adjusts list's height to prevent a partial item from showing\n\t\t\t// (LBS_NOINTEGRALHEIGHT), fetch the actual height for possible use in positioning the\n\t\t\t// next control:\n\t\t\tretrieve_dimensions = true;\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_LISTVIEW:\n\t\tif (opt.listview_view != LV_VIEW_TILE) // It was ensured earlier that listview_view can be set to LV_VIEW_TILE only for XP or later.\n\t\t\tstyle = (style & ~LVS_TYPEMASK) | opt.listview_view; // Create control in the correct view mode whenever possible (TILE is the exception because it can't be expressed via style).\n\t\tif (control.hwnd = CreateWindowEx(exstyle, WC_LISTVIEW, _T(\"\"), style, opt.x, opt.y // exstyle does apply to ListViews.\n\t\t\t, opt.width, opt.height == COORD_UNSPECIFIED ? 200 : opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif ( !(control.union_lv_attrib = (lv_attrib_type *)malloc(sizeof(lv_attrib_type))) )\n\t\t\t{\n\t\t\t\t// Since mem alloc problem is so rare just get rid of the control and flag it to be reported\n\t\t\t\t// later below as \"cannot create control\". Doing this avoids the need to every worry whether\n\t\t\t\t// control.union_lv_attrib is NULL in other places.\n\t\t\t\tDestroyWindow(control.hwnd);\n\t\t\t\tcontrol.hwnd = NULL;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// Otherwise:\n\t\t\tZeroMemory(control.union_lv_attrib, sizeof(lv_attrib_type));\n\t\t\tcontrol.union_lv_attrib->sorted_by_col = -1; // Indicate that there is currently no sort order.\n\t\t\tcontrol.union_lv_attrib->no_auto_sort = opt.listview_no_auto_sort;\n\n\t\t\t// v1.0.36.06: If this ListView is owned by a tab control, flag that tab control as needing\n\t\t\t// to stay after all of its controls in the z-order. This solves ListView-inside-Tab redrawing\n\t\t\t// problems, namely the disappearance of the ListView or an incomplete drawing of it.\n\t\t\tif (owning_tab_control)\n\t\t\t\towning_tab_control->attrib |= GUI_CONTROL_ATTRIB_ALTBEHAVIOR;\n\n\t\t\t// Seems best to put tile view into effect before applying any styles that might be dependent upon it:\n\t\t\tif (opt.listview_view == LV_VIEW_TILE) // An earlier stage has verified that this is true only if OS is XP or later.\n\t\t\t\tSendMessage(control.hwnd, LVM_SETVIEW, LV_VIEW_TILE, 0);\n\t\t\tif (opt.listview_style) // This is a third set of styles that exist in addition to normal & extended.\n\t\t\t\tListView_SetExtendedListViewStyle(control.hwnd, opt.listview_style); // No return value. Will have no effect on Win95/NT that lack comctl32.dll 4.70+ distributed with MSIE 3.x.\n\t\t\tControlSetListViewOptions(control, opt); // Relies on adjustments to opt.color and color_bk done higher above.\n\n\t\t\tif (opt.height == COORD_UNSPECIFIED) // Adjust the control's size to fit opt.row_count rows.\n\t\t\t{\n\t\t\t\t// Known limitation: This will be inaccurate if an ImageList is later assigned to the\n\t\t\t\t// ListView because that increases the height of each row slightly (or a lot if\n\t\t\t\t// a large-icon list is forced into Details/Report view and other views that are\n\t\t\t\t// traditionally small-icon). The code size and complexity of trying to compensate\n\t\t\t\t// for this doesn't seem likely to be worth it.\n\t\t\t\tGUI_SETFONT // Required before asking it for a height estimate.\n\t\t\t\tswitch (opt.listview_view)\n\t\t\t\t{\n\t\t\t\tcase LV_VIEW_DETAILS:\n\t\t\t\t\t// The following formula has been tested on XP with the point sizes 8, 9, 10, 12, 14, and 18 for:\n\t\t\t\t\t// Verdana\n\t\t\t\t\t// Courier New\n\t\t\t\t\t// Gui Default Font\n\t\t\t\t\t// Times New Roman\n\t\t\t\t\topt.height = 4 + HIWORD(ListView_ApproximateViewRect(control.hwnd, -1, -1\n\t\t\t\t\t\t, (WPARAM)opt.row_count - 1)); // -1 seems to be needed to make it calculate right for LV_VIEW_DETAILS.\n\t\t\t\t\t// Above: It seems best to exclude any horiz. scroll bar from consideration, even though it will\n\t\t\t\t\t// block the last row if bar is present. The bar can be dismissed by manually dragging the\n\t\t\t\t\t// column dividers or using the GuiControl auto-size methods.\n\t\t\t\t\t// Note that ListView_ApproximateViewRect() is not available on 95/NT4 that lack\n\t\t\t\t\t// comctl32.dll 4.70+ distributed with MSIE 3.x Therefore, rather than having a possibly-\n\t\t\t\t\t// complicated work around in the code to detect DLL version, it will be documented in\n\t\t\t\t\t// the help file that the \"rows\" method will produce an incorrect height on those platforms.\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase LV_VIEW_TILE: // This one can be safely integrated with the LVS ones because it doesn't overlap with them.\n\t\t\t\t\t// The following approach doesn't seem to give back useful info about the total height of a\n\t\t\t\t\t// tile and the border beneath it, so it isn't used:\n\t\t\t\t\t//LVTILEVIEWINFO tvi;\n\t\t\t\t\t//tvi.cbSize = sizeof(LVTILEVIEWINFO);\n\t\t\t\t\t//tvi.dwMask = LVTVIM_TILESIZE | LVTVIM_LABELMARGIN;\n\t\t\t\t\t//ListView_GetTileViewInfo(control.hwnd, &tvi);\n\t\t\t\t\t// The following might not be perfect for integral scrolling purposes, but it does seem\n\t\t\t\t\t// correct in terms of allowing exactly the right number of rows to be visible when the\n\t\t\t\t\t// control is scrolled all the way to the top. It's also correct for eliminating a\n\t\t\t\t\t// vertical scroll bar if the icons all fit into the specified number of rows. Tested on\n\t\t\t\t\t// XP Theme and Classic theme.\n\t\t\t\t\topt.height = 7 + (int)((HIWORD(ListView_GetItemSpacing(control.hwnd, FALSE)) - 3) * opt.row_count);\n\t\t\t\t\tbreak;\n\n\t\t\t\tdefault: // Namely the following:\n\t\t\t\t//case LV_VIEW_ICON:\n\t\t\t\t//case LV_VIEW_SMALLICON:\n\t\t\t\t//case LV_VIEW_LIST:\n\t\t\t\t\t// For these non-report views, it seems far better to define row_count as the number of\n\t\t\t\t\t// icons that can fit vertically rather than as the total number of icons, because the\n\t\t\t\t\t// latter can result in heights that vary based on too many factors, resulting in too\n\t\t\t\t\t// much inconsistency.\n\t\t\t\t\tGUI_SET_HDC\n\t\t\t\t\tGetTextMetrics(hdc, &tm);\n\t\t\t\t\tif (opt.listview_view == LV_VIEW_ICON)\n\t\t\t\t\t{\n\t\t\t\t\t\t// The vertical space between icons is not dependent upon font size. In other words,\n\t\t\t\t\t\t// the control's total height to fit exactly N rows would be icon_height*N plus\n\t\t\t\t\t\t// icon_spacing*(N-1). However, the font height is added so that the last row has\n\t\t\t\t\t\t// enough extra room to display one line of text beneath the icon. The first/constant\n\t\t\t\t\t\t// number below is a combination of two components: 1) The control's internal margin\n\t\t\t\t\t\t// that it maintains to decide when to display scroll bars (perhaps 3 above and 3 below).\n\t\t\t\t\t\t// The space between the icon and its first line of text (which seems constant, perhaps 10).\n\t\t\t\t\t\topt.height = 16 + tm.tmHeight + (int)(GetSystemMetrics(SM_CYICON) * opt.row_count\n\t\t\t\t\t\t\t+ HIWORD(ListView_GetItemSpacing(control.hwnd, FALSE) * (opt.row_count - 1)));\n\t\t\t\t\t\t// More complex and doesn't seem as accurate:\n\t\t\t\t\t\t//float half_icon_spacing = 0.5F * HIWORD(ListView_GetItemSpacing(control.hwnd, FALSE));\n\t\t\t\t\t\t//opt.height = (int)(((HIWORD(ListView_ApproximateViewRect(control.hwnd, 5, 5, 1)) \n\t\t\t\t\t\t//\t+ half_icon_spacing + 4) * opt.row_count) + ((half_icon_spacing - 17) * (opt.row_count - 1)));\n\t\t\t\t\t}\n\t\t\t\t\telse // SMALLICON or LIST. For simplicity, it's done the same way for both, though it doesn't work as well for LIST.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Seems way too high even with \"TRUE\": HIWORD(ListView_GetItemSpacing(control.hwnd, TRUE)\n\t\t\t\t\t\tint cy_smicon = GetSystemMetrics(SM_CYSMICON);\n\t\t\t\t\t\t// 11 seems to be the right value to prevent unwanted vertical scroll bar in SMALLICON view:\n\t\t\t\t\t\topt.height = 11 + (int)((cy_smicon > tm.tmHeight ? cy_smicon : tm.tmHeight) * opt.row_count\n\t\t\t\t\t\t\t+ 1 * (opt.row_count - 1));\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\t} // switch()\n\t\t\t\tMoveWindow(control.hwnd, opt.x, opt.y, opt.width, opt.height, TRUE); // Repaint should be smart enough not to do it if window is hidden.\n\t\t\t} // if (opt.height == COORD_UNSPECIFIED)\n\t\t} // CreateWindowEx() succeeded.\n\t\tbreak;\n\n\tcase GUI_CONTROL_TREEVIEW:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, WC_TREEVIEW, _T(\"\"), style, opt.x, opt.y\n\t\t\t, opt.width, opt.height == COORD_UNSPECIFIED ? 200 : opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (opt.checked)\n\t\t\t\t// Testing confirms that unless the following advice is applied, an item's checkbox cannot\n\t\t\t\t// be checked immediately after the item is created:\n\t\t\t\t// MSDN: If you want to use the checkbox style, you must set the TVS_CHECKBOXES style (with\n\t\t\t\t// SetWindowLong) after you create the tree-view control and before you populate the tree.\n\t\t\t\t// Otherwise, the checkboxes might appear unchecked, depending on timing issues.\n\t\t\t\tSetWindowLong(control.hwnd, GWL_STYLE, style | TVS_CHECKBOXES);\n\t\t\tControlSetTreeViewOptions(control, opt); // Relies on adjustments to opt.color and color_bk done higher above.\n\t\t\tif (opt.himagelist) // Currently only supported upon creation, not via GuiControl, since in that case the decision of whether to destroy the old imagelist would be uncertain.\n\t\t\t\tTreeView_SetImageList(control.hwnd, opt.himagelist, TVSIL_NORMAL); // Currently no error reporting.\n\n\t\t\tif (opt.height == COORD_UNSPECIFIED) // Adjust the control's size to fit opt.row_count rows.\n\t\t\t{\n\t\t\t\t// Known limitation (may exist for TreeViews the same as it does for ListViews):\n\t\t\t\t// The follow might be inaccurate if an ImageList is later assigned to the TreeView because\n\t\t\t\t// that may increase the height of each row. The code size and complexity of trying to\n\t\t\t\t// compensate for this doesn't seem likely to be worth it.\n\t\t\t\tGUI_SETFONT // Required before asking it for a height estimate.\n\t\t\t\topt.height = TreeView_GetItemHeight(control.hwnd);\n\t\t\t\t// The following formula has been tested on XP fonts DefaultGUI, Verdana, Courier (for a few\n\t\t\t\t// point sizes).\n\t\t\t\topt.height = 4 + (int)(opt.row_count * opt.height);\n\t\t\t\t// Above: It seems best to exclude any horiz. scroll bar from consideration, even though it will\n\t\t\t\t// block the last row if bar is present. The bar can be dismissed by manually dragging the\n\t\t\t\t// column dividers or using the GuiControl auto-size methods.\n\t\t\t\t// Note that ListView_ApproximateViewRect() is not available on 95/NT4 that lack\n\t\t\t\t// comctl32.dll 4.70+ distributed with MSIE 3.x Therefore, rather than having a possibly-\n\t\t\t\t// complicated work around in the code to detect DLL version, it will be documented in\n\t\t\t\t// the help file that the \"rows\" method will produce an incorrect height on those platforms.\n\t\t\t\tMoveWindow(control.hwnd, opt.x, opt.y, opt.width, opt.height, TRUE); // Repaint should be smart enough not to do it if window is hidden.\n\t\t\t} // if (opt.height == COORD_UNSPECIFIED)\n\t\t} // CreateWindowEx() succeeded.\n\tbreak;\n\n\tcase GUI_CONTROL_EDIT:\n\t{\n\t\tif (!(style & ES_MULTILINE)) // ES_MULTILINE was not explicitly or automatically specified.\n\t\t{\n\t\t\tif (opt.limit < 0) // This is the signal to limit input length to visible width of field.\n\t\t\t\t// But it can only work if the Edit isn't a multiline.\n\t\t\t\tstyle &= ~(WS_HSCROLL|ES_AUTOHSCROLL); // Enable the limiting style.\n\t\t\telse // Since this is a single-line edit, add AutoHScroll if it wasn't explicitly removed.\n\t\t\t\tstyle |= ES_AUTOHSCROLL & ~opt.style_remove;\n\t\t\t\t// But no attempt is made to turn off WS_VSCROLL or ES_WANTRETURN since those might have some\n\t\t\t\t// usefulness even in a single-line edit? In any case, it seems too overprotective to do so.\n\t\t}\n\t\t// malloc() is done because edit controls in NT/2k/XP support more than 64K.\n\t\t// Mem alloc errors are so rare (since the text is usually less than 32K/64K) that no error is displayed.\n\t\t// Instead, the un-translated text is put in directly. Also, translation is not done for\n\t\t// single-line edits since they can't display line breaks correctly anyway.\n\t\t// Note that TranslateLFtoCRLF() will return the original buffer we gave it if no translation\n\t\t// is needed. Otherwise, it will return a new buffer which we are responsible for freeing\n\t\t// when done (or NULL if it failed to allocate the memory).\n\t\tauto malloc_buf = (*aText && (style & ES_MULTILINE)) ? TranslateLFtoCRLF(aText) : nullptr;\n\t\tif (control.hwnd = CreateWindowEx(exstyle, _T(\"Edit\"), malloc_buf ? malloc_buf : aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\t// As documented in MSDN, setting a password char will have no effect for multi-line edits\n\t\t\t// since they do not support password/mask char.\n\t\t\t// It seems best to allow password_char to be a literal asterisk so that there's a way to\n\t\t\t// have asterisk vs. bullet/closed-circle on OSes that default to bullet.\n\t\t\tif ((style & ES_PASSWORD) && opt.password_char) // Override default.\n\t\t\t\tSendMessage(control.hwnd, EM_SETPASSWORDCHAR, (WPARAM)opt.password_char, 0);\n\t\t\tif (opt.limit < 0)\n\t\t\t\topt.limit = 0;\n\t\t\t//else leave it as the zero (unlimited) or positive (restricted) limit already set.\n\t\t\t// Now set the limit. Specifying a limit of zero opens the control to its maximum text capacity,\n\t\t\t// which removes the 32K size restriction. Testing shows that this does not increase the actual\n\t\t\t// amount of memory used for controls containing small amounts of text. All it does is allow\n\t\t\t// the control to allocate more memory as the user enters text.\n\t\t\tSendMessage(control.hwnd, EM_LIMITTEXT, (WPARAM)opt.limit, 0); // EM_LIMITTEXT == EM_SETLIMITTEXT\n\t\t\tif (opt.tabstop_count)\n\t\t\t\tSendMessage(control.hwnd, EM_SETTABSTOPS, opt.tabstop_count, (LPARAM)opt.tabstop);\n\t\t}\n\t\tif (malloc_buf != aText)\n\t\t\tfree(malloc_buf);\n\t\tbreak;\n\t}\n\n\tcase GUI_CONTROL_DATETIME:\n\t{\n\t\tbool use_custom_format = false;\n\t\tif (*aText)\n\t\t{\n\t\t\t// DTS_SHORTDATEFORMAT and DTS_SHORTDATECENTURYFORMAT seem to produce identical results\n\t\t\t// (both display 4-digit year), at least on XP. Perhaps DTS_SHORTDATECENTURYFORMAT is\n\t\t\t// obsolete. In any case, it's uncommon so for simplicity, is not a named style. It\n\t\t\t// can always be applied numerically if desired. Update: DTS_SHORTDATECENTURYFORMAT is\n\t\t\t// now applied by default higher above, which can be overridden explicitly via -0x0C\n\t\t\t// in the control's options.\n\t\t\tif (!_tcsicmp(aText, _T(\"LongDate\"))) // LongDate seems more readable than \"Long\". It also matches the keyword used by FormatTime.\n\t\t\t\tstyle = (style & ~(DTS_SHORTDATECENTURYFORMAT | DTS_TIMEFORMAT)) | DTS_LONGDATEFORMAT; // Purify.\n\t\t\telse if (!_tcsicmp(aText, _T(\"Time\")))\n\t\t\t\tstyle = (style & ~(DTS_SHORTDATECENTURYFORMAT | DTS_LONGDATEFORMAT)) | DTS_TIMEFORMAT; // Purify.\n\t\t\telse if (!_tcsicmp(aText, _T(\"ShortDate\")))\n\t\t\t\tstyle = (style & ~(DTS_SHORTDATECENTURYFORMAT | DTS_LONGDATEFORMAT)) | DTS_SHORTDATEFORMAT;\n\t\t\telse // Custom format. Don't purify (to retain the underlying default in case custom format is ever removed).\n\t\t\t\tuse_custom_format = true;\n\t\t}\n\t\tif (opt.choice == 2) // \"ChooseNone\" was present, so ensure DTS_SHOWNONE is present to allow it.\n\t\t\tstyle |= DTS_SHOWNONE;\n\t\t//else it's blank, so retain the default DTS_SHORTDATEFORMAT (0x0000).\n\t\tif (control.hwnd = CreateWindowEx(exstyle, DATETIMEPICK_CLASS, _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (use_custom_format)\n\t\t\t\tDateTime_SetFormat(control.hwnd, aText);\n\t\t\t//else keep the default or the format set via style higher above.\n\t\t\t// Feels safer to do range prior to selection even though unlike GUI_CONTROL_MONTHCAL,\n\t\t\t// GUI_CONTROL_DATETIME tolerates them in the reverse order when one doesn't fit the other.\n\t\t\tif (opt.gdtr_range) // If the date/time set above is invalid in light of the following new range, the date will be automatically to the closest valid date.\n\t\t\t\tDateTime_SetRange(control.hwnd, opt.gdtr_range, opt.sys_time_range);\n\t\t\t//else keep default range, which is \"unrestricted range\".\n\t\t\tif (opt.choice) // The option \"ChooseYYYYMMDD\" was present and valid (or ChooseNone was present, choice==2)\n\t\t\t\tDateTime_SetSystemtime(control.hwnd, opt.choice == 1 ? GDT_VALID : GDT_NONE, opt.sys_time);\n\t\t\t//else keep default, which is although undocumented appears to be today's date+time, which certainly is the expected default.\n\t\t\tif (IS_AN_ACTUAL_COLOR(opt.color))\n\t\t\t\tDateTime_SetMonthCalColor(control.hwnd, MCSC_TEXT, opt.color);\n\t\t\t// Note: The DateTime_SetMonthCalFont() macro is never used because apparently it's not required\n\t\t\t// to set the font, or even to repaint.\n\t\t}\n\t\tbreak;\n\t}\n\n\tcase GUI_CONTROL_MONTHCAL:\n\t\tif (*aText)\n\t\t{\n\t\t\topt.gdtr = YYYYMMDDToSystemTime2(aText, opt.sys_time);\n\t\t\tif (!opt.gdtr)\n\t\t\t{\n\t\t\t\tdelete pcontrol;\n\t\t\t\treturn g_script.RuntimeError(ERR_INVALID_VALUE, aText);\n\t\t\t}\n\t\t\tif (opt.gdtr == (GDTR_MIN | GDTR_MAX)) // When range is present, multi-select is automatically put into effect.\n\t\t\t\tstyle |= MCS_MULTISELECT; // Must be applied during control creation since it can't be changed afterward.\n\t\t}\n\t\t// Create the control with arbitrary width/height if no width/height were explicitly specified.\n\t\t// It will be resized after creation by querying the control:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, MONTHCAL_CLASS, _T(\"\"), style, opt.x, opt.y\n\t\t\t, opt.width < 0 ? 100 : opt.width // Negative width has special meaning upon creation (see below).\n\t\t\t, opt.height == COORD_UNSPECIFIED ? 100 : opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (style & MCS_MULTISELECT) // Must do this prior to setting initial contents in case contents is a range greater than 7 days.\n\t\t\t\tMonthCal_SetMaxSelCount(control.hwnd, 366); // 7 days seems too restrictive a default, so expand.\n\t\t\tif (opt.gdtr_range) // If the date/time set above is invalid in light of the following new range, the date will be automatically to the closest valid date.\n\t\t\t\tMonthCal_SetRange(control.hwnd, opt.gdtr_range, opt.sys_time_range);\n\t\t\t//else keep default range, which is \"unrestricted range\".\n\t\t\tif (opt.gdtr) // An explicit selection, either a range or single date, is present.\n\t\t\t{\n\t\t\t\tif (style & MCS_MULTISELECT) // Must use range-selection even if selection is only one date.\n\t\t\t\t{\n\t\t\t\t\tif (opt.gdtr == GDTR_MIN) // No maximum is present, so set maximum to minimum.\n\t\t\t\t\t\topt.sys_time[1] = opt.sys_time[0];\n\t\t\t\t\t//else just max, or both are present. Assume both for code simplicity.\n\t\t\t\t\tMonthCal_SetSelRange(control.hwnd, opt.sys_time);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tMonthCal_SetCurSel(control.hwnd, opt.sys_time);\n\t\t\t}\n\t\t\t//else keep default, which is although undocumented appears to be today's date+time, which certainly is the expected default.\n\t\t\tif (IS_AN_ACTUAL_COLOR(opt.color))\n\t\t\t\tMonthCal_SetColor(control.hwnd, MCSC_TEXT, opt.color);\n\t\t\tGUI_SETFONT // Required before asking it about its month size.\n\t\t\tif ((opt.width == COORD_UNSPECIFIED || opt.height == COORD_UNSPECIFIED)\n\t\t\t\t&& MonthCal_GetMinReqRect(control.hwnd, &rect))\n\t\t\t{\n\t\t\t\t// Autosize width and/or height by asking the control how big each month is.\n\t\t\t\t// MSDN: \"The top and left members of lpRectInfo will always be zero. The right and bottom\n\t\t\t\t// members represent the minimum cx and cy required for the control.\"\n\t\t\t\tif (opt.width < 0) // Negative width vs. COORD_UNSPECIFIED are different in this case.\n\t\t\t\t{\n\t\t\t\t\t// MSDN: \"The rectangle returned by MonthCal_GetMinReqRect does not include the width\n\t\t\t\t\t// of the \"Today\" string, if it is present. If the MCS_NOTODAY style is not set,\n\t\t\t\t\t// retrieve the rectangle that defines the \"Today\" string width by calling the\n\t\t\t\t\t// MonthCal_GetMaxTodayWidth macro. Use the larger of the two rectangles to ensure\n\t\t\t\t\t// that the \"Today\" string is not clipped.\n\t\t\t\t\tint month_width;\n\t\t\t\t\tif (style & MCS_NOTODAY) // No today-string, so width is always that from GetMinReqRect.\n\t\t\t\t\t\tmonth_width = rect.right;\n\t\t\t\t\telse // There will be a today-string present, so use the greater of the two widths.\n\t\t\t\t\t{\n\t\t\t\t\t\tmonth_width = MonthCal_GetMaxTodayWidth(control.hwnd);\n\t\t\t\t\t\tif (month_width < rect.right)\n\t\t\t\t\t\t\tmonth_width = rect.right;\n\t\t\t\t\t}\n\t\t\t\t\tif (opt.width == COORD_UNSPECIFIED) // Use default, which is to provide room for a single month.\n\t\t\t\t\t\topt.width = month_width;\n\t\t\t\t\telse // It's some explicit negative number. Use it as a multiplier to provide multiple months.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Multiple months must need a little extra room for border between: 0.02 but 0.03 is okay.\n\t\t\t\t\t\t// For safety, a larger value is used.\n\t\t\t\t\t\topt.width = -opt.width;\n\t\t\t\t\t\t// Provide room for each separator. There's one separator for each month after the\n\t\t\t\t\t\t// first, and the separator always seems to be exactly 6 regardless of font face/size.\n\t\t\t\t\t\t// This has been tested on both Classic and XP themes.\n\t\t\t\t\t\topt.width = opt.width*month_width + (opt.width - 1)*6;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (opt.height == COORD_UNSPECIFIED)\n\t\t\t\t{\n\t\t\t\t\topt.height = rect.bottom; // Init for default and for use below (room for only a single month's height).\n\t\t\t\t\tif (opt.row_count > 0 && opt.row_count != 1.0) // row_count was explicitly specified by the script, so use its exact value, even if it isn't a whole number (for flexibility).\n\t\t\t\t\t{\n\t\t\t\t\t\t// Unlike horizontally stacked calendars, vertically stacking them produces no separator\n\t\t\t\t\t\t// between them.\n\t\t\t\t\t\tGUI_SET_HDC\n\t\t\t\t\t\tGetTextMetrics(hdc, &tm);\n\t\t\t\t\t\t// If there will be no today string, the height reported by MonthCal_GetMinReqRect\n\t\t\t\t\t\t// is not correct for use in calculating the height of more than one month stacked\n\t\t\t\t\t\t// vertically. Must adjust it to make it display properly.\n\t\t\t\t\t\tif (style & MCS_NOTODAY) // No today string, but space is still reserved for it, so must compensate for that.\n\t\t\t\t\t\t\topt.height += tm.tmHeight + 4; // Formula tested with Courier New and Verdana 8/10/12 with row counts between 1 and 5.\n\t\t\t\t\t\topt.height = (int)(opt.height * opt.row_count); // Calculate height of all months.\n\t\t\t\t\t\t// Regardless of whether MCS_NOTODAY is present, the below is still the right formula.\n\t\t\t\t\t\t// Room for the today-string is reserved only once at the bottom (even without MCS_NOTODAY),\n\t\t\t\t\t\t// so need to subtract that (also note that some months have 6 rows and others only 5,\n\t\t\t\t\t\t// but there is whitespace padding in the case of 5 to make all months the same height).\n\t\t\t\t\t\topt.height = (int)(opt.height - ((opt.row_count - 1) * (tm.tmHeight - 2)));\n\t\t\t\t\t\t// Above: -2 seems to work for Verdana and Courier 8/10/12/14/18.\n\t\t\t\t\t}\n\t\t\t\t\t//else opt.row_count was unspecified, so stay with the default set above of exactly\n\t\t\t\t\t// one month tall.\n\t\t\t\t}\n\t\t\t\tMoveWindow(control.hwnd, opt.x, opt.y, opt.width, opt.height, TRUE); // Repaint should be smart enough not to do it if window is hidden.\n\t\t\t} // Width or height was unspecified.\n\t\t} // Control created OK.\n\t\tbreak;\n\n\tcase GUI_CONTROL_HOTKEY:\n\t\t// In this case, not only doesn't the caption appear anywhere, it's not set either (or at least\n\t\t// not retrievable via GetWindowText()):\n\t\tif (control.hwnd = CreateWindowEx(exstyle, HOTKEY_CLASS, _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (*aText)\n\t\t\t\tSendMessage(control.hwnd, HKM_SETHOTKEY, TextToHotkey(aText), 0);\n\t\t\tif (opt.limit > 0)\n\t\t\t\tSendMessage(control.hwnd, HKM_SETRULES, opt.limit, MAKELPARAM(HOTKEYF_CONTROL|HOTKEYF_ALT, 0));\n\t\t\t\t// Above must also specify Ctrl+Alt or some other default, otherwise the restriction will have\n\t\t\t\t// no effect.\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_UPDOWN:\n\t\t// The buddy of an up-down can meaningfully be one of the following:\n\t\t//case GUI_CONTROL_EDIT:\n\t\t//case GUI_CONTROL_TEXT:\n\t\t//case GUI_CONTROL_GROUPBOX:\n\t\t//case GUI_CONTROL_BUTTON:\n\t\t//case GUI_CONTROL_CHECKBOX:\n\t\t//case GUI_CONTROL_RADIO:\n\t\t//case GUI_CONTROL_LISTBOX:\n\t\t// (But testing shows, not these):\n\t\t//case GUI_CONTROL_UPDOWN: An up-down will snap onto another up-down, but not have any meaningful effect.\n\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t//case GUI_CONTROL_HOTKEY:\n\t\t//case GUI_CONTROL_UPDOWN:\n\t\t//case GUI_CONTROL_SLIDER:\n\t\t//case GUI_CONTROL_PROGRESS:\n\t\t//case GUI_CONTROL_TAB:\n\t\t//case GUI_CONTROL_STATUSBAR: As expected, it doesn't work properly.\n\n\t\t// v1.0.44: Don't allow buddying of UpDown to StatusBar (this must be done prior to the next section).\n\t\t// UPDATE: Due to rarity and user-should-know-better, this is not checked for (to reduce code size):\n\t\t//if (prev_control && prev_control->type == GUI_CONTROL_STATUSBAR)\n\t\t//\tstyle &= ~UDS_AUTOBUDDY;\n\t\t// v1.0.42.02: The below is a fix for tab controls that contain a ListView so that up-downs in the\n\t\t// tab control don't snap onto the tab control (due to the z-order change done by the ListView creation\n\t\t// section whenever a ListView exists inside a tab control).\n\t\tbool provide_buddy_manually;\n\t\tif ( provide_buddy_manually = (style & UDS_AUTOBUDDY)\n\t\t\t&& (mStatusBarHwnd // Added for v1.0.44.01 (fixed in v1.0.44.04): Since the status bar is pushed to the bottom of the z-order after adding each other control, must do manual buddying whenever an UpDown is added after the status bar (to prevent it from attaching to the status bar).\n\t\t\t|| (owning_tab_control // mControlCount is greater than zero whenever owning_tab_control!=NULL\n\t\t\t\t&& (owning_tab_control->attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR))) )\n\t\t\tstyle &= ~UDS_AUTOBUDDY; // Remove it during control creation to avoid up-down snapping onto tab control.\n\n\t\t// Suppress any Edit control Change events which are generated by the UpDown\n\t\t// control implicitly changing the contents of its buddy Edit control.\n\t\tif (prev_control && prev_control->type == GUI_CONTROL_EDIT)\n\t\t\tprev_control->attrib |= GUI_CONTROL_ATTRIB_SUPPRESS_EVENTS;\n\n\t\t// The control is created unconditionally because if UDS_AUTOBUDDY is in effect, need to create the\n\t\t// control to find out its position and size (since it snaps to its buddy). That size can then be\n\t\t// retrieved and used to figure out how to resize the buddy in cases where its width-set-automatically\n\t\t// -based-on-contents should not be squished as a result of buddying.\n\t\tif (control.hwnd = CreateWindowEx(exstyle, UPDOWN_CLASS, _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (provide_buddy_manually) // v1.0.42.02 (see comment where provide_buddy_manually is initialized).\n\t\t\t\tSendMessage(control.hwnd, UDM_SETBUDDY, (WPARAM)prev_control->hwnd, 0); // See StatusBar notes above. Also, mControlCount>0 whenever provide_buddy_manually==true.\n\t\t\tif ( mControlCount // Ensure there is a previous control to snap onto (below relies on this check).\n\t\t\t\t&& ((style & UDS_AUTOBUDDY) || provide_buddy_manually) )\n\t\t\t{\n\t\t\t\t// Since creation of a buddied up-down ignored the specified x/y and width/height, update them\n\t\t\t\t// for use here and also later below for updating mMaxExtentRight, etc.\n\t\t\t\tGetWindowRect(control.hwnd, &rect);\n\t\t\t\tMapWindowPoints(NULL, parent_hwnd, (LPPOINT)&rect, 2); // Convert rect to client coordinates (not the same as GetClientRect()).\n\t\t\t\topt.x = rect.left;\n\t\t\t\topt.y = rect.top;\n\t\t\t\topt.width = rect.right - rect.left;\n\t\t\t\topt.height = rect.bottom - rect.top;\n\t\t\t\t// Get its buddy's rectangle for use in two places:\n\t\t\t\tRECT buddy_rect;\n\t\t\t\tGetWindowRect(prev_control->hwnd, &buddy_rect);\n\t\t\t\tMapWindowPoints(NULL, parent_hwnd, (LPPOINT)&buddy_rect, 2); // Convert rect to client coordinates (not the same as GetClientRect()).\n\t\t\t\t// Note: It does not matter if UDS_HORZ is in effect because strangely, the up-down still\n\t\t\t\t// winds up on the left or right side of the buddy, not the top/bottom.\n\t\t\t\tif (mControlWidthWasSetByContents)\n\t\t\t\t{\n\t\t\t\t\t// Since the previous control's width was determined solely by the size of its contents,\n\t\t\t\t\t// enlarge the control to undo the narrowing just done by the buddying process.\n\t\t\t\t\t// This relies on the fact that during buddying, the UpDown was auto-sized and positioned\n\t\t\t\t\t// to fit its buddy.\n\t\t\t\t\tif (style & UDS_ALIGNRIGHT)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Since moving an up-down's buddy is not enough to move the up-down,\n\t\t\t\t\t\t// so that must be shifted too:\n\t\t\t\t\t\topt.x += opt.width;\n\t\t\t\t\t\trect.right += opt.width; // Updated for use further below.\n\t\t\t\t\t\tMoveWindow(control.hwnd, opt.x, opt.y, opt.width, opt.height, TRUE); // Repaint this control separately from its buddy below.\n\t\t\t\t\t}\n\t\t\t\t\t// Enlarge the buddy control to restore it to the size it had prior to being reduced by the\n\t\t\t\t\t// buddying process:\n\t\t\t\t\tbuddy_rect.right += opt.width; // Must be updated for use in two places.\n\t\t\t\t\tMoveWindow(prev_control->hwnd, buddy_rect.left, buddy_rect.top\n\t\t\t\t\t\t, buddy_rect.right - buddy_rect.left, buddy_rect.bottom - buddy_rect.top, TRUE);\n\t\t\t\t}\n\t\t\t\t// Set x/y and width/height to be that of combined/buddied control so that auto-positioning\n\t\t\t\t// of future controls will see it as a single control:\n\t\t\t\tif (style & UDS_ALIGNRIGHT)\n\t\t\t\t{\n\t\t\t\t\topt.x = buddy_rect.left;\n\t\t\t\t\t// Must calculate the total width of the combined control not as a sum of their two widths,\n\t\t\t\t\t// but as the different between right and left. Otherwise, the width will be off by either\n\t\t\t\t\t// 2 or 3 because of the slight overlap between the two controls.\n\t\t\t\t\topt.width = rect.right - buddy_rect.left;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\topt.width = buddy_rect.right - rect.left;\n\t\t\t\t\t//and opt.x set to the x position of the up-down, since it's on the leftmost side.\n\t\t\t\t// Leave opt.y and opt.height as-is.\n\t\t\t\tif (!opt.range_changed && prev_control->type == GUI_CONTROL_LISTBOX)\n\t\t\t\t{\n\t\t\t\t\t// ListBox buddy needs an inverted UpDown (if the UpDown is vertical) to work the way\n\t\t\t\t\t// you'd expect.\n\t\t\t\t\topt.range_changed = true;\n\t\t\t\t\tif (style & UDS_HORZ) // Use MAXVAL because otherwise ListBox select will be restricted to the first 100 entries.\n\t\t\t\t\t\topt.range_max = UD_MAXVAL;\n\t\t\t\t\telse\n\t\t\t\t\t\topt.range_min = UD_MAXVAL; // ListBox needs an inverted UpDown to work the way you'd expect.\n\t\t\t\t}\n\t\t\t} // The up-down snapped onto a buddy control.\n\t\t\tif (!opt.range_changed) // Control's default is wacky inverted negative, so provide 0-100 as a better/traditional default.\n\t\t\t{\n\t\t\t\topt.range_changed = true;\n\t\t\t\topt.range_max = 100;\n\t\t\t}\n\t\t\tControlSetUpDownOptions(control, opt); // This must be done prior to the below.\n\t\t\t// Set the position unconditionally, even if aText is blank. This causes a blank aText to be\n\t\t\t// see as zero, which ensures the buddy has a legal starting value (which won't happen if the\n\t\t\t// range does not include zero, since it would default to zero then).\n\t\t\t// MSDN: \"If the parameter is outside the control's specified range, nPos will be set to the nearest\n\t\t\t// valid value.\"\n\t\t\tSendMessage(control.hwnd, UDM_SETPOS32, 0, ATOI(aText));\n\t\t} // Control was successfully created.\n\t\tif (prev_control && prev_control->type == GUI_CONTROL_EDIT)\n\t\t\tprev_control->attrib &= ~GUI_CONTROL_ATTRIB_SUPPRESS_EVENTS; // Re-enable Change event.\n\t\tbreak;\n\n\tcase GUI_CONTROL_SLIDER:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, TRACKBAR_CLASS, _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tControlSetSliderOptions(control, opt); // Fix for v1.0.25.08: This must be done prior to the below.\n\t\t\t// The control automatically deals with out-of-range values by setting slider to min or max.\n\t\t\t// MSDN: \"If this value is outside the control's maximum and minimum range, the position\n\t\t\t// is set to the maximum or minimum value.\"\n\t\t\tif (*aText)\n\t\t\t\tSendMessage(control.hwnd, TBM_SETPOS, TRUE, ControlInvertSliderIfNeeded(control, ATOI(aText)));\n\t\t\t\t// Above msg has no return value.\n\t\t\t//else leave it at the OS's default starting position (probably always the far left or top of the range).\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_PROGRESS:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, PROGRESS_CLASS, _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tControlSetProgressOptions(control, opt, style); // Fix for v1.0.27.01: This must be done prior to the below.\n\t\t\t// This has been confirmed though testing, even when the range is dynamically changed\n\t\t\t// after the control is created to something that no longer includes the bar's current\n\t\t\t// position: The control automatically deals with out-of-range values by setting bar to\n\t\t\t// min or max.\n\t\t\tif (*aText)\n\t\t\t\tSendMessage(control.hwnd, PBM_SETPOS, ATOI(aText), 0);\n\t\t\t//else leave it at the OS's default starting position (probably always the far left or top of the range).\n\t\t\tdo_strip_theme = false; // The above would have already stripped it if needed, so don't do it again.\n\t\t}\n\t\tbreak;\n\n\tcase GUI_CONTROL_TAB:\n\t\tif (control.hwnd = CreateWindowEx(exstyle, WC_TABCONTROL, _T(\"\"), style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\tif (opt.tab_control_uses_dialog) // It's a Tab3 control.\n\t\t\t{\n\t\t\t\t// Create a child dialog to host the controls for all tabs.\n\t\t\t\tif (!CreateTabDialog(control, opt))\n\t\t\t\t{\n\t\t\t\t\tDestroyWindow(control.hwnd);\n\t\t\t\t\tcontrol.hwnd = NULL;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (opt.tab_control_autosize)\n\t\t\t\tSetProp(control.hwnd, _T(\"ahk_autosize\"), (HANDLE)opt.tab_control_autosize);\n\t\t\t// After a new tab control is created, default all subsequently created controls to belonging\n\t\t\t// to the first tab of this tab control: \n\t\t\tmCurrentTabControlIndex = mTabControlCount;\n\t\t\tmCurrentTabIndex = 0;\n\t\t\t++mTabControlCount;\n\t\t\t// Override the tab's window-proc so that custom background color becomes possible:\n\t\t\tg_TabClassProc = (WNDPROC)SetWindowLongPtr(control.hwnd, GWLP_WNDPROC, (LONG_PTR)TabWindowProc);\n\t\t\t// Doesn't work to remove theme background from tab:\n\t\t\t//EnableThemeDialogTexture(control.hwnd, ETDT_DISABLE);\n\t\t}\n\t\tbreak;\n\t\t\n\tcase GUI_CONTROL_ACTIVEX:\n\t{\n\t\tstatic bool sAtlAxInitialized = false;\n\t\tif (!sAtlAxInitialized)\n\t\t{\n\t\t\ttypedef BOOL (WINAPI *MyAtlAxWinInit)();\n\t\t\tif (HMODULE hmodAtl = LoadLibrary(_T(\"atl\")))\n\t\t\t{\n\t\t\t\tif (MyAtlAxWinInit fnAtlAxWinInit = (MyAtlAxWinInit)GetProcAddress(hmodAtl, \"AtlAxWinInit\"))\n\t\t\t\t\tsAtlAxInitialized = fnAtlAxWinInit();\n\t\t\t\tif (!sAtlAxInitialized)\n\t\t\t\t\tFreeLibrary(hmodAtl);\n\t\t\t\t// Otherwise, init was successful so don't unload it.\n\t\t\t}\n\t\t\t// If any of the above calls failed, attempt to create the window anyway:\n\t\t}\n\t\tif (control.hwnd = CreateWindowEx(exstyle, _T(\"AtlAxWin\"), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL))\n\t\t{\n\t\t\t// A reference to the object is kept for two reasons:\n\t\t\t// 1) So Ctrl.Value can return the same wrapper object each time.\n\t\t\t// 2) To ensure that if the script subscribes to events with ComObjConnect(),\n\t\t\t// they will continue to work as long as the GUI exists, rather than being\n\t\t\t// disconnected the moment the script releases its reference.\n\t\t\tif ( !(control.union_object = ControlGetActiveX(control.hwnd)) )\n\t\t\t{\n\t\t\t\tDestroyWindow(control.hwnd);\n\t\t\t\tcontrol.hwnd = NULL;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\tbreak;\n\t}\n\n\tcase GUI_CONTROL_CUSTOM:\n\t\tif (opt.customClassAtom == 0)\n\t\t{\n\t\t\tdelete pcontrol;\n\t\t\treturn g_script.RuntimeError(_T(\"A window class is required.\"));\n\t\t}\n\t\tcontrol.hwnd = CreateWindowEx(exstyle, MAKEINTATOM(opt.customClassAtom), aText, style\n\t\t\t, opt.x, opt.y, opt.width, opt.height, parent_hwnd, control_id, g_hInstance, NULL);\n\t\tbreak;\n\n\tcase GUI_CONTROL_STATUSBAR:\n\t\tif (control.hwnd = CreateStatusWindow(style, aText, mHwnd, (UINT)(size_t)control_id))\n\t\t{\n\t\t\tmStatusBarHwnd = control.hwnd;\n\t\t\tif (opt.color_bk != CLR_INVALID) // Explicit color change was requested.\n\t\t\t\tSendMessage(mStatusBarHwnd, SB_SETBKCOLOR, 0, opt.color_bk);\n\t\t}\n\t\tbreak;\n\t} // switch() for control creation.\n\n\t////////////////////////////////\n\t// Release the HDC if necessary.\n\t////////////////////////////////\n\tif (hdc)\n\t{\n\t\tif (hfont_old)\n\t\t{\n\t\t\tSelectObject(hdc, hfont_old); // Necessary to avoid memory leak.\n\t\t\thfont_old = NULL;\n\t\t}\n\t\tReleaseDC(mHwnd, hdc);\n\t\thdc = NULL;\n\t}\n\n\t// Below also serves as a bug check, i.e. GUI_CONTROL_INVALID or some unknown type.\n\tif (!control.hwnd)\n\t{\n\t\tdelete pcontrol;\n\t\treturn g_script.RuntimeError(_T(\"Can't create control.\"));\n\t}\n\t// Otherwise the above control creation succeeded.\n\t++mControlCount;\n\tapControl = pcontrol;\n\tmControlWidthWasSetByContents = control_width_was_set_by_contents; // Set for use by next control, if any.\n\n\tif (control.type == GUI_CONTROL_RADIO)\n\t{\n\t\tif (opt.checked != BST_UNCHECKED)\n\t\t\tControlCheckRadioButton(control, mControlCount - 1, opt.checked); // Also handles alteration of the group's tabstop, etc.\n\t\t//else since the control has just been created, there's no need to uncheck it or do any actions\n\t\t// related to unchecking, such as tabstop adjustment.\n\t\tmInRadioGroup = true; // Set here, only after creation was successful.\n\t}\n\telse // For code simplicity and due to rarity, even GUI_CONTROL_STATUSBAR starts a new radio group.\n\t\tmInRadioGroup = false;\n\n\t// Check style_remove vs. style because this control might be hidden just because it was added\n\t// to a tab that isn't active:\n\tif (opt.style_remove & WS_VISIBLE)\n\t\tcontrol.attrib |= GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN; // For use with tab controls.\n\tif (opt.style_add & WS_DISABLED)\n\t\tcontrol.attrib |= GUI_CONTROL_ATTRIB_EXPLICITLY_DISABLED;\n\n\t// Strip theme from the control if called for:\n\t// It is stripped for radios, checkboxes, and groupboxes if they have a custom text color.\n\t// Otherwise the transparency and/or custom text color will not be obeyed on XP, at least when\n\t// a non-Classic theme is active. For GroupBoxes, when a theme is active, it will obey \n\t// custom background color but not a custom text color. The same is true for radios and checkboxes.\n\tif (do_strip_theme || (control.union_color != CLR_DEFAULT && (control.type == GUI_CONTROL_CHECKBOX\n\t\t|| control.type == GUI_CONTROL_RADIO || control.type == GUI_CONTROL_GROUPBOX)) // GroupBox needs it too.\n\t\t|| (control.type == GUI_CONTROL_GROUPBOX && control.background_color == CLR_TRANSPARENT) // Tested and found to be necessary.\n\t\t|| (control.type == GUI_CONTROL_DROPDOWNLIST && control.background_color != CLR_INVALID))\n\t\tSetWindowTheme(control.hwnd, L\"\", L\"\");\n\n\t// Must set the font even if mCurrentFontIndex > 0, otherwise the bold SYSTEM_FONT will be used.\n\t// Note: Neither the slider's buddies nor itself are affected by the font setting, so it's not applied.\n\t// However, the buddies are affected at the time they are created if they are a type that uses a font.\n\tif (!font_was_set && uses_font_and_text_color)\n\t\tGUI_SETFONT\n\n\tif (opt.redraw == CONDITION_FALSE)\n\t\tSendMessage(control.hwnd, WM_SETREDRAW, FALSE, 0); // Disable redrawing for this control to allow contents to be added to it more quickly.\n\t\t// It's not necessary to do the following because by definition the control has just been created\n\t\t// and thus redraw can't have been off for it previously:\n\t\t//if (opt.redraw == CONDITION_TRUE) // Since redrawing is being turned back on, invalidate the control so that it updates itself.\n\t\t//\tInvalidateRect(control.hwnd, NULL, TRUE);\n\n\t///////////////////////////////////////////////////\n\t// Add any content to the control and set its font.\n\t///////////////////////////////////////////////////\n\tControlAddItems(control, aObj); // Must be done after font-set above so that ListView columns can be auto-sized to fit their text.\n\tif (opt.choice > 0)\n\t\tControlSetChoice(control, opt.choice);\n\n\tif (control.type == GUI_CONTROL_TAB && opt.row_count > 0)\n\t{\n\t\t// Now that the tabs have been added (possibly creating more than one row of tabs), resize so that\n\t\t// the interior of the control has the actual number of rows specified.\n\t\tGetClientRect(control.hwnd, &rect); // MSDN: \"the coordinates of the upper-left corner are (0,0)\"\n\t\t// This is a workaround for the fact that TabCtrl_AdjustRect() seems to give an invalid\n\t\t// height when the tabs are at the bottom, at least on XP. Unfortunately, this workaround\n\t\t// does not work when the tabs or on the left or right side, so don't even bother with that\n\t\t// adjustment (it's very rare that a tab control would have an unspecified width anyway).\n\t\tbool bottom_is_in_effect = (style & TCS_BOTTOM) && !(style & TCS_VERTICAL);\n\t\tif (bottom_is_in_effect)\n\t\t\tSetWindowLong(control.hwnd, GWL_STYLE, style & ~TCS_BOTTOM);\n\t\t// Insist on a taller client area (or same height in the case of TCS_VERTICAL):\n\t\tTabCtrl_AdjustRect(control.hwnd, TRUE, &rect); // Calculate new window height.\n\t\tif (bottom_is_in_effect)\n\t\t\tSetWindowLong(control.hwnd, GWL_STYLE, style);\n\t\topt.height = rect.bottom - rect.top; // Update opt.height for here and for later use below.\n\t\t// The below is commented out because TabCtrl_AdjustRect() is unable to cope with tabs on\n\t\t// the left or right sides. It would be rarely used anyway.\n\t\t//if (style & TCS_VERTICAL && width_was_originally_unspecified)\n\t\t//\t// Also make the interior wider in this case, to make the interior as large as intended.\n\t\t//\t// It is a known limitation that this adjustment does not occur when the script did not\n\t\t//\t// specify a row_count or omitted height and row_count.\n\t\t//\topt.width = rect.right - rect.left;\n\t\tMoveWindow(control.hwnd, opt.x, opt.y, opt.width, opt.height, TRUE); // Repaint, since parent might be visible.\n\t}\n\telse if (control.type == GUI_CONTROL_TAB && opt.tab_control_uses_dialog)\n\t{\n\t\t// Update this tab control's dialog to match the tab's display area. This should be done\n\t\t// whenever the display area changes, such as when tabs are added for the first time or the\n\t\t// number of tab rows changes. It's not done if (opt.row_count > 0), because the section\n\t\t// above would have already triggered an update via MoveWindow/WM_WINDOWPOSCHANGED.\n\t\tUpdateTabDialog(control.hwnd);\n\t}\n\n\tif (retrieve_dimensions) // Update to actual size for use later below.\n\t{\n\t\tGetWindowRect(control.hwnd, &rect);\n\t\topt.height = rect.bottom - rect.top;\n\t\topt.width = rect.right - rect.left;\n\n\t\tif (aControlType == GUI_CONTROL_LISTBOX && (style & WS_HSCROLL))\n\t\t{\n\t\t\tif (opt.hscroll_pixels < 0) // Calculate a default based on control's width.\n\t\t\t\t// Since horizontal scrollbar is relatively rarely used, no fancy method\n\t\t\t\t// such as calculating scrolling-width via LB_GETTEXTLEN & current font's\n\t\t\t\t// average width is used.\n\t\t\t\topt.hscroll_pixels = 3 * opt.width;\n\t\t\t// If hscroll_pixels is now zero or smaller than the width of the control, the\n\t\t\t// scrollbar will not be shown. But the message is still sent unconditionally\n\t\t\t// in case it has some desirable side-effects:\n\t\t\tSendMessage(control.hwnd, LB_SETHORIZONTALEXTENT, (WPARAM)opt.hscroll_pixels, 0);\n\t\t}\n\t}\n\n\t// v1.0.36.06: If this tab control contains a ListView, keep the tab control after all of its controls\n\t// in the z-order. This solves ListView-inside-Tab redrawing problems, namely the disappearance of\n\t// the ListView or an incomplete drawing of it. Doing it this way preserves the tab-navigation\n\t// order of controls inside the tab control, both those above and those beneath the ListView.\n\t// The only thing it alters is the tab navigation to the tab control itself, which will now occur\n\t// after rather than before all the controls inside it. For most uses, this a very minor difference,\n\t// especially given the rarity of having ListViews inside tab controls. If this solution ever\n\t// proves undesirable, one alternative is to somehow force the ListView to properly redraw whenever\n\t// its inside a tab control. Perhaps this could be done by subclassing the ListView or Tab control\n\t// and having it do something different or additional in response to WM_ERASEBKGND. It might\n\t// also be done in the parent window's proc in response to WM_ERASEBKGND.\n\tif (owning_tab_control && parent_hwnd == mHwnd) // The control is on a tab control which is its sibling.\n\t{\n\t\t// Fix for v1.0.35: Probably due to clip-siblings, adding a control within the area of a tab control\n\t\t// does not properly draw the control. This seems to apply to most/all control types.\n\t\tif (on_visible_page_of_tab_control)\n\t\t{\n\t\t\t// Not enough for GUI_CONTROL_DATETIME (it's border is not drawn):\n\t\t\t//InvalidateRect(control.hwnd, NULL, TRUE); // TRUE is required, at least for GUI_CONTROL_DATETIME.\n\t\t\tGetWindowRect(control.hwnd, &rect);\n\t\t\tMapWindowPoints(NULL, mHwnd, (LPPOINT)&rect, 2); // Convert rect to client coordinates (not the same as GetClientRect()).\n\t\t\tInvalidateRect(mHwnd, &rect, FALSE);\n\t\t}\n\t\tif (owning_tab_control->attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR) // Put the tab control after the newly added control. See comment higher above.\n\t\t\tSetWindowPos(owning_tab_control->hwnd, control.hwnd, 0, 0, 0, 0, SWP_NOMOVE|SWP_NOSIZE|SWP_NOACTIVATE);\n\t}\n\n\t// v1.0.44: Must keep status bar at the bottom of the z-order so that it gets drawn last. This alleviates\n\t// (but does not completely prevent) other controls from overlapping it and getting drawn on top. This is\n\t// done each time a control is added -- rather than at some single time such as when the parent window is\n\t// first shown -- in case the script adds more controls later.\n\tif (mStatusBarHwnd) // Seems harmless to do it even if the just-added control IS the status bar. Also relies on the fact that that only one status bar is allowed.\n\t\tSetWindowPos(mStatusBarHwnd, HWND_BOTTOM, 0, 0, 0, 0, SWP_NOMOVE|SWP_NOSIZE|SWP_NOACTIVATE);\n\n\tif (aControlType != GUI_CONTROL_STATUSBAR) // i.e. don't let status bar affect positioning of controls relative to each other.\n\t{\n\t\tif (parent_hwnd != mHwnd) // This control is in a tab dialog.\n\t\t{\n\t\t\t// Translate the coordinates back to Gui-relative client coordinates.\n\t\t\tPOINT pt = { opt.x, opt.y };\n\t\t\tMapWindowPoints(parent_hwnd, mHwnd, &pt, 1);\n\t\t\topt.x = pt.x, opt.y = pt.y;\n\t\t}\n\n\t\t////////////////////////////////////////////////////////////////////////////////////////////////////\n\t\t// Save the details of this control's position for possible use in auto-positioning the next control.\n\t\t////////////////////////////////////////////////////////////////////////////////////////////////////\n\t\tmPrevX = opt.x;\n\t\tmPrevY = opt.y;\n\t\tmPrevWidth = opt.width;\n\t\tmPrevHeight = opt.height;\n\t\tint right = opt.x + opt.width;\n\t\tint bottom = opt.y + opt.height;\n\t\tif (parent_hwnd == mHwnd // Skip this for controls which are clipped by a parent control.\n\t\t\t&& !opt.tab_control_autosize) // For auto-sizing Tab3, don't adjust mMaxExtent until later.\n\t\t{\n\t\t\tif (right > mMaxExtentRight)\n\t\t\t\tmMaxExtentRight = right;\n\t\t\tif (bottom > mMaxExtentDown)\n\t\t\t\tmMaxExtentDown = bottom;\n\t\t}\n\n\t\t// As documented, always start new section for very first control, but never if this control is GUI_CONTROL_STATUSBAR.\n\t\tif (opt.start_new_section || mControlCount == 1 // aControlType!=GUI_CONTROL_STATUSBAR due to check higher above.\n\t\t\t|| (mControlCount == 2 && mControl[0]->type == GUI_CONTROL_STATUSBAR)) // This is the first non-statusbar control.\n\t\t{\n\t\t\tmSectionX = opt.x;\n\t\t\tmSectionY = opt.y;\n\t\t\tmMaxExtentRightSection = right;\n\t\t\tmMaxExtentDownSection = bottom;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (right > mMaxExtentRightSection)\n\t\t\t\tmMaxExtentRightSection = right;\n\t\t\tif (bottom > mMaxExtentDownSection)\n\t\t\t\tmMaxExtentDownSection = bottom;\n\t\t}\n\t}\n\n\treturn OK;\n}\n\n\n\nFResult GuiType::Opt(StrArg aOptions)\n{\n\tGUI_MUST_HAVE_HWND;\n\tbool set_last_found_window = false;\n\tToggleValueType own_dialogs = TOGGLE_INVALID;\n\tif (!ParseOptions(aOptions, set_last_found_window, own_dialogs))\n\t\treturn FR_FAIL; // Above already displayed an error message.\n\tif (set_last_found_window)\n\t\tg->hWndLastUsed = mHwnd;\n\tSetOwnDialogs(own_dialogs);\n\treturn OK;\n}\n\n\n\nResultType GuiType::ParseOptions(LPCTSTR aOptions, bool &aSetLastFoundWindow, ToggleValueType &aOwnDialogs)\n// This function is similar to ControlParseOptions() further below, so should be maintained alongside it.\n// Caller must have already initialized aSetLastFoundWindow/, bool &aOwnDialogs with desired starting values.\n// Caller must ensure that aOptions is a modifiable string, since this method temporarily alters it.\n{\n\tif (mHwnd)\n\t{\n\t\t// Since window already exists, its mStyle and mExStyle members might be out-of-date due to\n\t\t// \"WinSet Transparent\", etc. So update them:\n\t\tmStyle = GetWindowLong(mHwnd, GWL_STYLE);\n\t\tmExStyle = GetWindowLong(mHwnd, GWL_EXSTYLE);\n\t}\n\tDWORD style_orig = mStyle;\n\tDWORD exstyle_orig = mExStyle;\n\n\tTCHAR option[MAX_NUMBER_SIZE + 1]; // Enough for any single option word or number, with room to avoid issues due to truncation.\n\tLPCTSTR next_option, option_end;\n\tDWORD option_dword;\n\tbool adding; // Whether this option is being added (+) or removed (-).\n\n\tfor (next_option = aOptions; *next_option; next_option = omit_leading_whitespace(option_end))\n\t{\n\t\tif (*next_option == '-')\n\t\t{\n\t\t\tadding = false;\n\t\t\t// omit_leading_whitespace() is not called, which enforces the fact that the option word must\n\t\t\t// immediately follow the +/- sign. This is done to allow the flexibility to have options\n\t\t\t// omit the plus/minus sign, and also to reserve more flexibility for future option formats.\n\t\t\t++next_option; // Point it to the option word itself.\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Assume option is being added in the absence of either sign. However, when we were\n\t\t\t// called by GuiControl(), the first option in the list must begin with +/- otherwise the cmd\n\t\t\t// would never have been properly detected as GUICONTROL_CMD_OPTIONS in the first place.\n\t\t\tadding = true;\n\t\t\tif (*next_option == '+')\n\t\t\t\t++next_option; // Point it to the option word itself.\n\t\t\t//else do not increment, under the assumption that the plus has been omitted from a valid\n\t\t\t// option word and is thus an implicit plus.\n\t\t}\n\n\t\tif (!*next_option) // In case the entire option string ends in a naked + or -.\n\t\t\tbreak;\n\t\t// Find the end of this option item:\n\t\tfor (option_end = next_option; *option_end && !IS_SPACE_OR_TAB(*option_end); ++option_end);\n\t\tif (option_end == next_option)\n\t\t\tcontinue; // i.e. the string contains a + or - with a space or tab after it, which is intentionally ignored.\n\t\t\n\t\t// Make a null-terminated copy to simplify comparisons below.\n\t\ttcslcpy(option, next_option, min((option_end - next_option) + 1, _countof(option)));\n\t\t\n\t\t// Attributes and option words:\n\n\t\tbool set_owner;\n\t\tif ((set_owner = !_tcsnicmp(option, _T(\"Owner\"), 5))\n\t\t\t || !_tcsnicmp(option, _T(\"Parent\"), 6))\n\t\t{\n\t\t\tif (!adding)\n\t\t\t\tmOwner = NULL;\n\t\t\telse\n\t\t\t{\n\t\t\t\tauto name = option + 5 + !set_owner; // 6 for \"Parent\"\n\t\t\t\tif (*name || !set_owner) // i.e. \"+Parent\" on its own is invalid (and should not default to g_hWnd).\n\t\t\t\t{\n\t\t\t\t\tHWND new_owner = NULL;\n\t\t\t\t\tUINT hwnd_uint;\n\t\t\t\t\tif (ParseInteger(name, hwnd_uint))\n\t\t\t\t\t\tif (IsWindow((HWND)(UINT_PTR)hwnd_uint))\n\t\t\t\t\t\t\tnew_owner = (HWND)(UINT_PTR)hwnd_uint;\n\t\t\t\t\tif (!new_owner || new_owner == mHwnd) // Window can't own itself!\n\t\t\t\t\t{\n\t\t\t\t\t\tif (!ValueError(_T(\"Invalid or nonexistent owner or parent window.\"), option, FAIL_OR_OK))\n\t\t\t\t\t\t\treturn FAIL;\n\t\t\t\t\t\t// Otherwise, user wants to continue.\n\t\t\t\t\t}\n\t\t\t\t\tmOwner = new_owner;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tmOwner = g_hWnd; // Make a window owned (by script's main window) omits its taskbar button.\n\t\t\t}\n\t\t\tif (set_owner) // +/-Owner\n\t\t\t{\n\t\t\t\tif (mStyle & WS_CHILD)\n\t\t\t\t{\n\t\t\t\t\t// Since Owner and Parent are mutually-exclusive by nature, it seems appropriate for\n\t\t\t\t\t// +Owner to also apply -Parent. If this wasn't done, +Owner would merely change the\n\t\t\t\t\t// parent window (see comments further below).\n\t\t\t\t\tmStyle = mStyle & ~WS_CHILD | WS_POPUP;\n\t\t\t\t\tif (mHwnd)\n\t\t\t\t\t{\n\t\t\t\t\t\t// This seems to be necessary even if SetWindowLong() is called to update the\n\t\t\t\t\t\t// style before attempting to change the owner. By contrast, there doesn't seem\n\t\t\t\t\t\t// to be any problem with delaying the style update until after all of the other\n\t\t\t\t\t\t// options are parsed.\n\t\t\t\t\t\tSetParent(mHwnd, NULL);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t// Although MSDN doesn't explicitly document any way to change the owner of an existing\n\t\t\t\t// window, the following method was mentioned in a PDC talk by Raymond Chen. MSDN does\n\t\t\t\t// say it shouldn't be used to change the parent of a child window, but maybe what it\n\t\t\t\t// actually means is that \"HWNDPARENT\" is a misnomer; it should've been \"HWNDOWNER\".\n\t\t\t\t// On the other hand, this method ACTUALLY DOES CHANGE THE PARENT WINDOW if mHwnd is a\n\t\t\t\t// child window and the check above is disabled (at least it did during testing).\n\t\t\t\tif (mHwnd)\n\t\t\t\t\tSetWindowLongPtr(mHwnd, GWLP_HWNDPARENT, (LONG_PTR)mOwner);\n\t\t\t}\n\t\t\telse // +/-Parent\n\t\t\t{\n\t\t\t\tif (mHwnd)\n\t\t\t\t\tSetParent(mHwnd, mOwner);\n\t\t\t\tif (mOwner)\n\t\t\t\t\tmStyle = mStyle & ~WS_POPUP | WS_CHILD;\n\t\t\t\telse\n\t\t\t\t\tmStyle = mStyle & ~WS_CHILD | WS_POPUP;\n\t\t\t\t// The new style will be applied by a later section.\n\t\t\t}\n\t\t}\n\n\t\telse if (!_tcsicmp(option, _T(\"AlwaysOnTop\")))\n\t\t{\n\t\t\t// If the window already exists, SetWindowLong() isn't enough. Must use SetWindowPos()\n\t\t\t// to make it take effect.\n\t\t\tif (mHwnd)\n\t\t\t{\n\t\t\t\tSetWindowPos(mHwnd, adding ? HWND_TOPMOST : HWND_NOTOPMOST, 0, 0, 0, 0\n\t\t\t\t\t, SWP_NOMOVE|SWP_NOSIZE|SWP_NOACTIVATE); // SWP_NOACTIVATE prevents the side-effect of activating the window, which is undesirable if only its style is changing.\n\t\t\t\t// Fix for v1.0.41.01: Update the original style too, so that the call to SetWindowLong() later below\n\t\t\t\t// is made only if multiple styles are being changed on the same line, e.g. Gui +Disabled -SysMenu\n\t\t\t\tif (adding) exstyle_orig |= WS_EX_TOPMOST; else exstyle_orig &= ~WS_EX_TOPMOST;\n\t\t\t}\n\t\t\t// Fix for v1.0.41.01: The following line is now done unconditionally. Previously, it wasn't\n\t\t\t// done if the window already existed, which caused an example such as the following to first\n\t\t\t// set the window always on top and then immediately afterward try to unset it via SetWindowLong\n\t\t\t// (because mExStyle hadn't been updated to reflect the change made by SetWindowPos):\n\t\t\t// Gui, +AlwaysOnTop +Disabled -SysMenu\n\t\t\tif (adding) mExStyle |= WS_EX_TOPMOST; else mExStyle &= ~WS_EX_TOPMOST;\n\t\t}\n\n\t\telse if (!_tcsicmp(option, _T(\"Border\")))\n\t\t\tif (adding) mStyle |= WS_BORDER; else mStyle &= ~WS_BORDER;\n\n\t\telse if (!_tcsicmp(option, _T(\"Caption\")))\n\t\t\tif (adding) mStyle |= WS_CAPTION; else mStyle = mStyle & ~WS_CAPTION;\n\n\t\telse if (!_tcsicmp(option, _T(\"Disabled\")))\n\t\t{\n\t\t\tif (mHwnd)\n\t\t\t{\n\t\t\t\tEnableWindow(mHwnd, adding ? FALSE : TRUE); // Must not not apply WS_DISABLED directly because that breaks the window.\n\t\t\t\t// Fix for v1.0.41.01: Update the original style too, so that the call to SetWindowLong() later below\n\t\t\t\t// is made only if multiple styles are being changed on the same line, e.g. Gui +Disabled -SysMenu\n\t\t\t\tif (adding) style_orig |= WS_DISABLED; else style_orig &= ~WS_DISABLED;\n\t\t\t}\n\t\t\t// Fix for v1.0.41.01: The following line is now done unconditionally. Previously, it wasn't\n\t\t\t// done if the window already existed, which caused an example such as the following to first\n\t\t\t// disable the window and then immediately afterward try to enable it via SetWindowLong\n\t\t\t// (because mStyle hadn't been updated to reflect the change made by SetWindowPos):\n\t\t\t// Gui, +AlwaysOnTop +Disabled -SysMenu\n\t\t\tif (adding) mStyle |= WS_DISABLED; else mStyle &= ~WS_DISABLED;\n\t\t}\n\t\t\n\t\telse if (!_tcsicmp(option, _T(\"LastFound\")))\n\t\t\taSetLastFoundWindow = true; // Regardless of whether \"adding\" is true or false.\n\n\t\telse if (!_tcsicmp(option, _T(\"MaximizeBox\"))) // See above comment.\n\t\t\tif (adding) mStyle |= WS_MAXIMIZEBOX|WS_SYSMENU; else mStyle &= ~WS_MAXIMIZEBOX;\n\n\t\telse if (!_tcsicmp(option, _T(\"MinimizeBox\")))\n\t\t\t// WS_MINIMIZEBOX requires WS_SYSMENU to take effect. It can be explicitly omitted\n\t\t\t// via \"+MinimizeBox -SysMenu\" if that functionality is ever needed.\n\t\t\tif (adding) mStyle |= WS_MINIMIZEBOX|WS_SYSMENU; else mStyle &= ~WS_MINIMIZEBOX;\n\n\t\telse if (!_tcsnicmp(option, _T(\"MinSize\"), 7)) // v1.0.44.13: Added for use with WM_GETMINMAXINFO.\n\t\t{\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tParseMinMaxSizeOption(option + 7, mMinWidth, mMinHeight);\n\t\t\t}\n\t\t\telse // \"-MinSize\", so tell the WM_GETMINMAXINFO handler to use system defaults.\n\t\t\t{\n\t\t\t\tmMinWidth = COORD_UNSPECIFIED;\n\t\t\t\tmMinHeight = COORD_UNSPECIFIED;\n\t\t\t}\n\t\t}\n\n\t\telse if (!_tcsnicmp(option, _T(\"MaxSize\"), 7)) // v1.0.44.13: Added for use with WM_GETMINMAXINFO.\n\t\t{\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tParseMinMaxSizeOption(option + 7, mMaxWidth, mMaxHeight);\n\t\t\t}\n\t\t\telse // \"-MaxSize\", so tell the WM_GETMINMAXINFO handler to use system defaults.\n\t\t\t{\n\t\t\t\tmMaxWidth = COORD_UNSPECIFIED;\n\t\t\t\tmMaxHeight = COORD_UNSPECIFIED;\n\t\t\t}\n\t\t}\n\n\t\telse if (!_tcsicmp(option, _T(\"OwnDialogs\")))\n\t\t\taOwnDialogs = (adding ? TOGGLED_ON : TOGGLED_OFF);\n\n\t\telse if (!_tcsicmp(option, _T(\"Resize\"))) // Minus removes either or both.\n\t\t\tif (adding) mStyle |= WS_SIZEBOX|WS_MAXIMIZEBOX; else mStyle &= ~(WS_SIZEBOX|WS_MAXIMIZEBOX);\n\n\t\telse if (!_tcsicmp(option, _T(\"SysMenu\")))\n\t\t\tif (adding) mStyle |= WS_SYSMENU; else mStyle &= ~WS_SYSMENU;\n\n\t\telse if (!_tcsicmp(option, _T(\"Theme\")))\n\t\t\tmUseTheme = adding;\n\t\t\t// But don't apply/remove theme from parent window because that is usually undesirable.\n\t\t\t// This is because even old apps running on XP still have the new parent window theme,\n\t\t\t// at least for their title bar and title bar buttons (except console apps, maybe).\n\n\t\telse if (!_tcsicmp(option, _T(\"ToolWindow\")))\n\t\t\t// WS_EX_TOOLWINDOW provides narrower title bar, omits task bar button, and omits\n\t\t\t// entry in the alt-tab menu.\n\t\t\tif (adding) mExStyle |= WS_EX_TOOLWINDOW; else mExStyle &= ~WS_EX_TOOLWINDOW;\n\n\t\telse if (!_tcsicmp(option, _T(\"DPIScale\")))\n\t\t\tmUsesDPIScaling = adding;\n\n\t\t// This one should be near the bottom since \"E\" is fairly vague and might be contained at the start\n\t\t// of future option words such as Edge, Exit, etc.\n\t\telse if (ctoupper(*option) == 'E' && ParsePositiveInteger(option + 1, option_dword)) // Extended style\n\t\t{\n\t\t\tif (adding)\n\t\t\t\tmExStyle |= option_dword;\n\t\t\telse\n\t\t\t\tmExStyle &= ~option_dword;\n\t\t}\n\n\t\telse if (ParsePositiveInteger(option, option_dword)) // Above has already verified that *option can't be whitespace.\n\t\t{\n\t\t\t// Pure numbers are assumed to be style additions or removals:\n\t\t\tif (adding)\n\t\t\t\tmStyle |= option_dword;\n\t\t\telse\n\t\t\t\tmStyle &= ~option_dword;\n\t\t}\n\n\t\telse // v1.1.04: Validate Gui options.\n\t\t{\n\t\t\tif (!ValueError(ERR_INVALID_OPTION, option, FAIL_OR_OK))\n\t\t\t\treturn FAIL;\n\t\t\t// Otherwise, user wants to continue.\n\t\t}\n\n\t} // for() each item in option list\n\n\t// Besides reducing the code size and complexity, another reason all changes to style are made\n\t// here rather than above is that multiple changes might have been made above to the style,\n\t// and there's no point in redrawing/updating the window for each one:\n\tif (mHwnd && (mStyle != style_orig || mExStyle != exstyle_orig))\n\t{\n\t\t// v1.0.27.01: Must do this prior to SetWindowLong() because sometimes SetWindowLong()\n\t\t// traumatizes the window (such as \"Gui -Caption\"), making it effectively invisible\n\t\t// even though its non-functional remnant is still on the screen:\n\t\tbool is_visible = IsWindowVisible(mHwnd) && !IsIconic(mHwnd);\n\n\t\t// Since window already exists but its style has changed, attempt to update it dynamically.\n\t\tif (mStyle != style_orig)\n\t\t\tSetWindowLong(mHwnd, GWL_STYLE, mStyle);\n\t\tif (mExStyle != exstyle_orig)\n\t\t\tSetWindowLong(mHwnd, GWL_EXSTYLE, mExStyle);\n\n\t\tif (is_visible)\n\t\t{\n\t\t\t// Hiding then showing is the only way I've discovered to make it update. If the window\n\t\t\t// is not updated, a strange effect occurs where the window is still visible but can no\n\t\t\t// longer be used at all (clicks pass right through it). This show/hide method is less\n\t\t\t// desirable due to possible side effects caused to any script that happens to be watching\n\t\t\t// for its existence/non-existence, so it would be nice if some better way can be discovered\n\t\t\t// to do this.\n\t\t\t// Update by Lexikos: I've been unable to produce the \"strange effect\" described above using\n\t\t\t// WinSet on Win2k/XP/7, so changing this section to use the same method as WinSet. If there\n\t\t\t// are any problems, at least WinSet and Gui will be consistent.\n\t\t\t// SetWindowPos is also necessary, otherwise the frame thickness entirely around the window\n\t\t\t// does not get updated (just parts of it):\n\t\t\tSetWindowPos(mHwnd, NULL, 0, 0, 0, 0, SWP_DRAWFRAME|SWP_FRAMECHANGED|SWP_NOMOVE|SWP_NOSIZE|SWP_NOZORDER|SWP_NOACTIVATE);\n\t\t\t// ShowWindow(mHwnd, SW_HIDE);\n\t\t\t// ShowWindow(mHwnd, SW_SHOWNA); // i.e. don't activate it if it wasn't before. Note that SW_SHOWNA avoids restoring the window if it is currently minimized or maximized (unlike SW_SHOWNOACTIVATE).\n\t\t\tInvalidateRect(mHwnd, NULL, TRUE); // Quite a few styles require this to become visibly manifest.\n\t\t\t// None of the following methods alone is enough, at least not when the window is currently active:\n\t\t\t// 1) InvalidateRect(mHwnd, NULL, TRUE);\n\t\t\t// 2) SendMessage(mHwnd, WM_NCPAINT, 1, 0); // 1 = Repaint entire frame.\n\t\t\t// 3) RedrawWindow(mHwnd, NULL, NULL, RDW_INVALIDATE|RDW_FRAME|RDW_UPDATENOW);\n\t\t\t// 4) SetWindowPos(mHwnd, NULL, 0, 0, 0, 0, SWP_DRAWFRAME|SWP_FRAMECHANGED|SWP_NOMOVE|SWP_NOSIZE|SWP_NOZORDER|SWP_NOACTIVATE);\n\t\t}\n\t\t// Continue on to create the window so that code is simplified in other places by\n\t\t// using the assumption that \"if gui[i] object exists, so does its window\".\n\t\t// Another important reason this is done is that if an owner window were to be destroyed\n\t\t// before the window it owns is actually created, the WM_DESTROY logic would have to check\n\t\t// for any windows owned by the window being destroyed and update them.\n\t}\n\n\treturn OK;\n}\n\n\n\nvoid GuiType::GetNonClientArea(LONG &aWidth, LONG &aHeight)\n// Added for v1.0.44.13.\n// Yields only the *extra* width/height added by the windows non-client area.\n// If the window hasn't been shown for the first time, the caller wants zeros.\n// The reason for making the script specify size of client area rather than entire window is that it\n// seems far more useful. For example, a script might know exactly how much minimum height its\n// controls require in the client area, but would find it inconvenient to have to take into account\n// the height of the title bar and menu bar (which vary depending on theme and other settings).\n{\n\tif (mGuiShowHasNeverBeenDone) // In this case, the script might not yet have added the menu bar and other styles that affect the size of the non-client area. So caller wants to do these calculations later.\n\t{\n\t\taWidth = 0;\n\t\taHeight = 0;\n\t\treturn;\n\t}\n\t// Otherwise, mGuiShowHasNeverBeenDone==false, which should mean that mHwnd!=NULL.\n\tRECT rect, client_rect;\n\tGetWindowRect(mHwnd, &rect);\n\tGetClientRect(mHwnd, &client_rect); // Client rect's left & top are always zero.\n\taWidth = (rect.right - rect.left) - client_rect.right;\n\taHeight = (rect.bottom - rect.top) - client_rect.bottom;\n}\n\n\n\nvoid GuiType::GetTotalWidthAndHeight(LONG &aWidth, LONG &aHeight)\n// Added for v1.0.44.13.\n// Yields total width and height of entire window.\n// If the window hasn't been shown for the first time, the caller wants COORD_CENTERED.\n{\n\tif (mGuiShowHasNeverBeenDone)\n\t{\n\t\taWidth = COORD_CENTERED;\n\t\taHeight = COORD_CENTERED;\n\t\treturn;\n\t}\n\t// Otherwise, mGuiShowHasNeverBeenDone==false, which should mean that mHwnd!=NULL.\n\tRECT rect;\n\tGetWindowRect(mHwnd, &rect);\n\taWidth = rect.right - rect.left;\n\taHeight = rect.bottom - rect.top;\n}\n\n\n\nvoid GuiType::ParseMinMaxSizeOption(LPCTSTR option_value, LONG &aWidth, LONG &aHeight)\n{\n\tif (*option_value)\n\t{\n\t\t// The following will retrieve zeros if window hasn't yet been shown for the first time,\n\t\t// in which case the first showing will do the NC adjustment for us. The overall approach\n\t\t// used here was chose to avoid any chance for Min/MaxSize to be adjusted more than once\n\t\t// to convert client size to entire-size, which would be wrong since the adjustment must be\n\t\t// applied only once. Examples of such situations are when one of the coordinates is omitted,\n\t\t// or when +MinSize is specified prior to the first \"Gui Show\" but +MaxSize is specified after.\n\t\tLONG nc_width, nc_height;\n\t\tGetNonClientArea(nc_width, nc_height);\n\t\t// _ttoi() vs. ATOI() is used below to avoid ambiguity of \"x\" being hex 0x vs. a delimiter.\n\t\tauto pos_of_the_x = StrChrAny(option_value, _T(\"Xx\"));\n\t\tif (pos_of_the_x && pos_of_the_x[1]) // Kept simple due to rarity of transgressions and their being inconsequential.\n\t\t\taHeight = Scale(_ttoi(pos_of_the_x + 1)) + nc_height;\n\t\t//else it's \"MinSize333\" or \"MinSize333x\", so leave height unchanged as documented.\n\t\tif (pos_of_the_x != option_value) // There's no 'x' or it lies to the right of option_value.\n\t\t\taWidth = Scale(_ttoi(option_value)) + nc_width; // _ttoi() automatically stops converting when it reaches non-numeric character.\n\t\t//else it's \"MinSizeX333\", so leave width unchanged as documented.\n\t}\n\telse // Since no width or height was specified:\n\t\t// Use the window's current size. But if window hasn't yet been shown for the\n\t\t// first time, this will set the values to COORD_CENTERED, which tells the\n\t\t// first-show routine to get the total width/height upon first showing (since\n\t\t// that's where the window's initial size is determined).\n\t\tGetTotalWidthAndHeight(aWidth, aHeight);\n}\n\n\n\nResultType GuiType::ControlParseOptions(LPCTSTR aOptions, GuiControlOptionsType &aOpt, GuiControlType &aControl\n\t, GuiIndexType aControlIndex)\n// Caller must have already initialized aOpt with zeroes or any other desired starting values.\n// Caller must ensure that aOptions is a modifiable string, since this method temporarily alters it.\n{\n\tTCHAR option[MAX_NUMBER_SIZE + 1]; // Enough for any single option word or number, with room to avoid issues due to truncation.\n\tLPCTSTR next_option, option_end;\n\tLPCTSTR error_message; // Used by \"return_error:\" when aControl.hwnd == NULL.\n\tDWORD option_dword;\n\tbool adding; // Whether this option is being added (+) or removed (-).\n\tGuiControlType *tab_control;\n\tRECT rect;\n\tPOINT pt;\n\tbool do_invalidate_rect = false; // Set default.\n\n\tfor (next_option = aOptions; *next_option; next_option = omit_leading_whitespace(option_end))\n\t{\n\t\tif (*next_option == '-')\n\t\t{\n\t\t\tadding = false;\n\t\t\t// omit_leading_whitespace() is not called, which enforces the fact that the option word must\n\t\t\t// immediately follow the +/- sign. This is done to allow the flexibility to have options\n\t\t\t// omit the plus/minus sign, and also to reserve more flexibility for future option formats.\n\t\t\t++next_option; // Point it to the option word itself.\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Assume option is being added in the absence of either sign. However, when we were\n\t\t\t// called by GuiControl(), the first option in the list must begin with +/- otherwise the cmd\n\t\t\t// would never have been properly detected as GUICONTROL_CMD_OPTIONS in the first place.\n\t\t\tadding = true;\n\t\t\tif (*next_option == '+')\n\t\t\t\t++next_option; // Point it to the option word itself.\n\t\t\t//else do not increment, under the assumption that the plus has been omitted from a valid\n\t\t\t// option word and is thus an implicit plus.\n\t\t}\n\n\t\tif (!*next_option) // In case the entire option string ends in a naked + or -.\n\t\t\tbreak;\n\t\t// Find the end of this option item:\n\t\tfor (option_end = next_option; *option_end && !IS_SPACE_OR_TAB(*option_end); ++option_end);\n\t\tif (option_end == next_option)\n\t\t\tcontinue; // i.e. the string contains a + or - with a space or tab after it, which is intentionally ignored.\n\t\t\n\t\t// Make a null-terminated copy to simplify comparisons below.\n\t\ttcslcpy(option, next_option, min((option_end - next_option) + 1, _countof(option)));\n\n\t\t// Attributes:\n\t\tif (!_tcsicmp(option, _T(\"Section\"))) // Adding and removing are treated the same in this case.\n\t\t\taOpt.start_new_section = true; // Ignored by caller when control already exists.\n\t\telse if (!_tcsicmp(option, _T(\"AltSubmit\")) && aControl.type != GUI_CONTROL_EDIT)\n\t\t{\n\t\t\t// v1.0.44: Don't allow control's AltSubmit bit to be set unless it's valid option for\n\t\t\t// that type. This protects the GUI_CONTROL_ATTRIB_ALTSUBMIT bit from being corrupted\n\t\t\t// in control types that use it for other/internal purposes. Update: For code size reduction\n\t\t\t// and performance, only exclude control types that use the ALTSUBMIT bit for an internal\n\t\t\t// purpose vs. allowing the script to set it via \"AltSubmit\".\n\t\t\tif (adding) aControl.attrib |= GUI_CONTROL_ATTRIB_ALTSUBMIT; else aControl.attrib &= ~GUI_CONTROL_ATTRIB_ALTSUBMIT;\n\t\t\t//switch(aControl.type)\n\t\t\t//{\n\t\t\t//case GUI_CONTROL_TAB:\n\t\t\t//case GUI_CONTROL_PIC:\n\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t//case GUI_CONTROL_SLIDER:\n\t\t\t//\tif (adding) aControl.attrib |= GUI_CONTROL_ATTRIB_ALTSUBMIT; else aControl.attrib &= ~GUI_CONTROL_ATTRIB_ALTSUBMIT;\n\t\t\t//\tbreak;\n\t\t\t//// All other types either use the bit for some internal purpose or want it reserved for possible\n\t\t\t//// future use. So don't allow the presence of \"AltSubmit\" to change the bit.\n\t\t\t//}\n\t\t}\n\n\t\t// Content of control (these are currently only effective if the control is being newly created):\n\t\telse if (!_tcsnicmp(option, _T(\"Checked\"), 7)) // Caller knows to ignore if inapplicable. Applicable for ListView too.\n\t\t{\n\t\t\tauto option_value = option + 7;\n\t\t\tif (!_tcsicmp(option_value, _T(\"Gray\"))) // Radios can't have the 3rd/gray state, but for simplicity it's permitted.\n\t\t\t\tif (adding) aOpt.checked = BST_INDETERMINATE; else aOpt.checked = BST_UNCHECKED;\n\t\t\telse\n\t\t\t{\n\t\t\t\tif (aControl.type == GUI_CONTROL_LISTVIEW)\n\t\t\t\t\tif (adding) aOpt.listview_style |= LVS_EX_CHECKBOXES; else aOpt.listview_style &= ~LVS_EX_CHECKBOXES;\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// As of v1.0.26, Checked/Hidden/Disabled can be followed by an optional 1/0/-1 so that\n\t\t\t\t\t// there is a way for a script to set the starting state by reading from an INI or registry\n\t\t\t\t\t// entry that contains 1 or 0 instead of needing the literal word \"checked\" stored in there.\n\t\t\t\t\t// Otherwise, a script would have to do something like the following before every \"Gui Add\":\n\t\t\t\t\t// if Box1Enabled\n\t\t\t\t\t// Enable = Enabled\n\t\t\t\t\t// else\n\t\t\t\t\t// Enable =\n\t\t\t\t\t// Gui Add, checkbox, %Enable%, My checkbox.\n\t\t\t\t\tif (*option_value) // There's more after the word, namely a 1, 0, or -1.\n\t\t\t\t\t{\n\t\t\t\t\t\taOpt.checked = ATOI(option_value);\n\t\t\t\t\t\tif (aOpt.checked == -1)\n\t\t\t\t\t\t\taOpt.checked = BST_INDETERMINATE;\n\t\t\t\t\t}\n\t\t\t\t\telse // Below is also used for GUI_CONTROL_TREEVIEW creation because its checkboxes must be added AFTER the control is created.\n\t\t\t\t\t\taOpt.checked = adding; // BST_CHECKED == 1, BST_UNCHECKED == 0\n\t\t\t\t}\n\t\t\t} // Non-checkedGRAY\n\t\t} // Checked.\n\t\telse if (!_tcsnicmp(option, _T(\"Choose\"), 6))\n\t\t{\n\t\t\t// \"CHOOSE\" provides an easier way to conditionally select a different item at the time\n\t\t\t// the control is added. Example: gui, add, ListBox, vMyList Choose%choice%, %MyItemList%\n\t\t\t// Caller should ignore aOpt.choice if it isn't applicable for this control type.\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tauto option_value = option + 6;\n\t\t\t\tswitch (aControl.type)\n\t\t\t\t{\n\t\t\t\tcase GUI_CONTROL_DATETIME:\n\t\t\t\t\tif (!_tcsicmp(option_value, _T(\"None\")))\n\t\t\t\t\t\taOpt.choice = 2; // Special flag value to indicate \"none\".\n\t\t\t\t\telse // See if it's a valid date-time.\n\t\t\t\t\t\tif (YYYYMMDDToSystemTime(option_value, aOpt.sys_time[0], true)) // Date string is valid.\n\t\t\t\t\t\t\taOpt.choice = 1; // Overwrite 0 to flag sys_time as both present and valid.\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\terror_message = ERR_INVALID_OPTION;\n\t\t\t\t\t\t\tgoto return_error;\n\t\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\taOpt.choice = ATOI(option_value);\n\t\t\t\t\tif (aOpt.choice < 1) // Invalid: number should be 1 or greater.\n\t\t\t\t\t\taOpt.choice = 0; // Flag it as invalid.\n\t\t\t\t}\n\t\t\t}\n\t\t\t//else do nothing (not currently implemented)\n\t\t}\n\n\t\t// Styles (general):\n\t\telse if (!_tcsicmp(option, _T(\"Border\")))\n\t\t\tif (adding) aOpt.style_add |= WS_BORDER; else aOpt.style_remove |= WS_BORDER;\n\t\telse if (!_tcsicmp(option, _T(\"VScroll\"))) // Seems harmless in this case not to check aControl.type to ensure it's an input-capable control.\n\t\t\tif (adding) aOpt.style_add |= WS_VSCROLL; else aOpt.style_remove |= WS_VSCROLL;\n\t\telse if (!_tcsnicmp(option, _T(\"HScroll\"), 7)) // Seems harmless in this case not to check aControl.type to ensure it's an input-capable control.\n\t\t{\n\t\t\tif (aControl.type == GUI_CONTROL_TREEVIEW)\n\t\t\t\t// Testing shows that Tree doesn't seem to fully support removal of hscroll bar after creation.\n\t\t\t\tif (adding) aOpt.style_remove |= TVS_NOHSCROLL; else aOpt.style_add |= TVS_NOHSCROLL;\n\t\t\telse\n\t\t\t\tif (adding)\n\t\t\t\t{\n\t\t\t\t\t// MSDN: \"To respond to the LB_SETHORIZONTALEXTENT message, the list box must have\n\t\t\t\t\t// been defined with the WS_HSCROLL style.\"\n\t\t\t\t\taOpt.style_add |= WS_HSCROLL;\n\t\t\t\t\tauto option_value = option + 7;\n\t\t\t\t\taOpt.hscroll_pixels = *option_value ? ATOI(option_value) : -1; // -1 signals it to use a default based on control's width.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\taOpt.style_remove |= WS_HSCROLL;\n\t\t}\n\t\telse if (!_tcsicmp(option, _T(\"Tabstop\"))) // Seems harmless in this case not to check aControl.type to ensure it's an input-capable control.\n\t\t\tif (adding) aOpt.style_add |= WS_TABSTOP; else aOpt.style_remove |= WS_TABSTOP;\n\t\telse if (!_tcsicmp(option, _T(\"NoTab\"))) // Supported for backward compatibility and it might be more ergonomic for \"Gui Add\".\n\t\t\tif (adding) aOpt.style_remove |= WS_TABSTOP; else aOpt.style_add |= WS_TABSTOP;\n\t\telse if (!_tcsicmp(option, _T(\"group\")))\n\t\t\tif (adding) aOpt.style_add |= WS_GROUP; else aOpt.style_remove |= WS_GROUP;\n\t\telse if (!_tcsicmp(option, _T(\"Redraw\"))) // Seems a little more intuitive/memorable than \"Draw\".\n\t\t\taOpt.redraw = adding ? CONDITION_TRUE : CONDITION_FALSE; // Otherwise leave it at its default of 0.\n\t\telse if (!_tcsnicmp(option, _T(\"Disabled\"), 8))\n\t\t{\n\t\t\t// As of v1.0.26, Checked/Hidden/Disabled can be followed by an optional 1/0/-1 so that\n\t\t\t// there is a way for a script to set the starting state by reading from an INI or registry\n\t\t\t// entry that contains 1 or 0 instead of needing the literal word \"checked\" stored in there.\n\t\t\t// Otherwise, a script would have to do something like the following before every \"Gui Add\":\n\t\t\t// if Box1Enabled\n\t\t\t// Enable = Enabled\n\t\t\t// else\n\t\t\t// Enable =\n\t\t\t// Gui Add, checkbox, %Enable%, My checkbox.\n\t\t\tif (option[8] && !ATOI(option + 8)) // If it's Disabled0, invert the mode to become \"enabled\".\n\t\t\t\tadding = !adding;\n\t\t\tif (aControl.hwnd) // More correct to call EnableWindow and let it set the style. Do not set the style explicitly in this case since that might break it.\n\t\t\t\tEnableWindow(aControl.hwnd, adding ? FALSE : TRUE);\n\t\t\telse\n\t\t\t\tif (adding) aOpt.style_add |= WS_DISABLED; else aOpt.style_remove |= WS_DISABLED;\n\t\t\t// Update the \"explicitly\" flags so that switching tabs won't reset the control's state.\n\t\t\tif (adding)\n\t\t\t\taControl.attrib |= GUI_CONTROL_ATTRIB_EXPLICITLY_DISABLED;\n\t\t\telse\n\t\t\t\taControl.attrib &= ~GUI_CONTROL_ATTRIB_EXPLICITLY_DISABLED;\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"Hidden\"), 6))\n\t\t{\n\t\t\t// As of v1.0.26, Checked/Hidden/Disabled can be followed by an optional 1/0/-1 so that\n\t\t\t// there is a way for a script to set the starting state by reading from an INI or registry\n\t\t\t// entry that contains 1 or 0 instead of needing the literal word \"checked\" stored in there.\n\t\t\t// Otherwise, a script would have to do something like the following before every \"Gui Add\":\n\t\t\t// if Box1Enabled\n\t\t\t// Enable = Enabled\n\t\t\t// else\n\t\t\t// Enable =\n\t\t\t// Gui Add, checkbox, %Enable%, My checkbox.\n\t\t\tif (option[6] && !ATOI(option + 6)) // If it's Hidden0, invert the mode to become \"show\".\n\t\t\t\tadding = !adding;\n\t\t\tif (aControl.hwnd) // More correct to call ShowWindow() and let it set the style. Do not set the style explicitly in this case since that might break it.\n\t\t\t\tShowWindow(aControl.hwnd, adding ? SW_HIDE : SW_SHOWNOACTIVATE);\n\t\t\telse\n\t\t\t\tif (adding) aOpt.style_remove |= WS_VISIBLE; else aOpt.style_add |= WS_VISIBLE;\n\t\t\t// Update the \"explicitly\" flags so that switching tabs won't reset the control's state.\n\t\t\tif (adding)\n\t\t\t\taControl.attrib |= GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN;\n\t\t\telse\n\t\t\t\taControl.attrib &= ~GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN;\n\t\t}\n\t\telse if (!_tcsicmp(option, _T(\"Wrap\")))\n\t\t{\n\t\t\tswitch(aControl.type)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_TEXT: // This one is a little tricky but the below should be appropriate in most cases:\n\t\t\t\tif (adding) aOpt.style_remove |= SS_TYPEMASK; else aOpt.style_add = (aOpt.style_add & ~SS_TYPEMASK) | SS_LEFTNOWORDWRAP; // v1.0.44.10: Added SS_TYPEMASK to \"else\" section to provide more graceful handling for cases like \"-Wrap +Center\", which would otherwise put an unexpected style like SS_OWNERDRAW into effect.\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\tcase GUI_CONTROL_CHECKBOX:\n\t\t\tcase GUI_CONTROL_RADIO:\n\t\t\t\tif (adding) aOpt.style_add |= BS_MULTILINE; else aOpt.style_remove |= BS_MULTILINE;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_UPDOWN:\n\t\t\t\tif (adding) aOpt.style_add |= UDS_WRAP; else aOpt.style_remove |= UDS_WRAP;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_EDIT: // Must be a multi-line now or shortly in the future or these will have no effect.\n\t\t\t\tif (adding) aOpt.style_remove |= WS_HSCROLL|ES_AUTOHSCROLL; else aOpt.style_add |= ES_AUTOHSCROLL;\n\t\t\t\t// WS_HSCROLL is removed because with it, wrapping is automatically off.\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_TAB:\n\t\t\t\tif (adding) aOpt.style_add |= TCS_MULTILINE; else aOpt.style_remove |= TCS_MULTILINE;\n\t\t\t\t// WS_HSCROLL is removed because with it, wrapping is automatically off.\n\t\t\t\tbreak;\n\t\t\t// N/A for these:\n\t\t\t//case GUI_CONTROL_PIC:\n\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t//case GUI_CONTROL_DATETIME:\n\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t//case GUI_CONTROL_HOTKEY:\n\t\t\t//case GUI_CONTROL_SLIDER:\n\t\t\t//case GUI_CONTROL_PROGRESS:\n\t\t\t//case GUI_CONTROL_LINK:\n\t\t\t}\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"Background\"), 10))\n\t\t{\n\t\t\tauto option_value = option + 10;\n\n\t\t\t// Reset background properties to simplify the next section.\n\t\t\taControl.background_color = CLR_INVALID;\n\t\t\tif (aControl.background_brush)\n\t\t\t{\n\t\t\t\tDeleteObject(aControl.background_brush);\n\t\t\t\taControl.background_brush = NULL;\n\t\t\t}\n\n\t\t\tif (!_tcsicmp(option_value, _T(\"Trans\")))\n\t\t\t{\n\t\t\t\tif (adding)\n\t\t\t\t{\n\t\t\t\t\tif (!aControl.SupportsBackgroundTrans())\n\t\t\t\t\t{\n\t\t\t\t\t\terror_message = ERR_GUI_NOT_FOR_THIS_TYPE;\n\t\t\t\t\t\tgoto return_error;\n\t\t\t\t\t}\n\t\t\t\t\taControl.background_color = CLR_TRANSPARENT;\n\t\t\t\t}\n\t\t\t\t//else do nothing, because the attrib was already removed above.\n\t\t\t}\n\t\t\telse if (adding)\n\t\t\t{\n\t\t\t\tif (*option_value)\n\t\t\t\t{\n\t\t\t\t\tif (!aControl.SupportsBackgroundColor())\n\t\t\t\t\t{\n\t\t\t\t\t\terror_message = ERR_GUI_NOT_FOR_THIS_TYPE;\n\t\t\t\t\t\tgoto return_error;\n\t\t\t\t\t}\n\t\t\t\t\tif (!ColorToBGR(option_value, aOpt.color_bk))\n\t\t\t\t\t{\n\t\t\t\t\t\terror_message = ERR_INVALID_OPTION;\n\t\t\t\t\t\tgoto return_error;\n\t\t\t\t\t}\n\t\t\t\t\tif (aOpt.color_bk != CLR_DEFAULT && aControl.RequiresBackgroundBrush())\n\t\t\t\t\t\taControl.background_brush = CreateSolidBrush(aOpt.color_bk);\n\t\t\t\t\taControl.background_color = aOpt.color_bk;\n\t\t\t\t}\n\t\t\t\t//else +Background (the traditional way to revert -Background).\n\t\t\t\t// background_brush and background_color were already reset above.\n\t\t\t}\n\t\t\telse // -Background\n\t\t\t{\n\t\t\t\taControl.background_color = CLR_DEFAULT;\n\t\t\t\taOpt.color_bk = CLR_DEFAULT;\n\t\t\t}\n\t\t} // Option \"Background\".\n\t\telse if (!_tcsicmp(option, _T(\"group\"))) // This overlaps with g-label, but seems well worth it in this case.\n\t\t\tif (adding) aOpt.style_add |= WS_GROUP; else aOpt.style_remove |= WS_GROUP;\n\t\telse if (!_tcsicmp(option, _T(\"Theme\")))\n\t\t\taOpt.use_theme = adding;\n\n\t\t// Picture / ListView\n\t\telse if (!_tcsnicmp(option, _T(\"Icon\"), 4)) // Caller should ignore aOpt.icon_number if it isn't applicable for this control type.\n\t\t{\n\t\t\tauto option_value = option + 4;\n\t\t\tif (aControl.type == GUI_CONTROL_LISTVIEW) // Unconditional regardless of the value of \"adding\".\n\t\t\t\taOpt.listview_view = _tcsicmp(option_value, _T(\"Small\")) ? LV_VIEW_ICON : LV_VIEW_SMALLICON;\n\t\t\telse\n\t\t\t\tif (adding)\n\t\t\t\t\taOpt.icon_number = ATOI(option_value);\n\t\t\t\t//else do nothing (not currently implemented)\n\t\t}\n\t\telse if (!_tcsicmp(option, _T(\"Report\")))\n\t\t\taOpt.listview_view = LV_VIEW_DETAILS; // Unconditional regardless of the value of \"adding\".\n\t\telse if (!_tcsicmp(option, _T(\"List\")))\n\t\t\taOpt.listview_view = LV_VIEW_LIST; // Unconditional regardless of the value of \"adding\".\n\t\telse if (!_tcsicmp(option, _T(\"Tile\"))) // Fortunately, subsequent changes to the control's style do not pop it out of Tile mode. It's apparently smart enough to do that only when the LVS_TYPEMASK bits change.\n\t\t\taOpt.listview_view = LV_VIEW_TILE;\n\t\telse if (aControl.type == GUI_CONTROL_LISTVIEW && !_tcsicmp(option, _T(\"Hdr\")))\n\t\t\tif (adding) aOpt.style_remove |= LVS_NOCOLUMNHEADER; else aOpt.style_add |= LVS_NOCOLUMNHEADER;\n\t\telse if (aControl.type == GUI_CONTROL_LISTVIEW && !_tcsnicmp(option, _T(\"NoSort\"), 6))\n\t\t{\n\t\t\tif (!_tcsicmp(option + 6, _T(\"Hdr\"))) // Prevents the header from being clickable like a set of buttons.\n\t\t\t\tif (adding) aOpt.style_add |= LVS_NOSORTHEADER; else aOpt.style_remove |= LVS_NOSORTHEADER; // Testing shows it can't be changed after the control is created.\n\t\t\telse // Header is still clickable (unless above is *also* specified), but has no automatic sorting.\n\t\t\t{\n\t\t\t\taOpt.listview_no_auto_sort = adding;\n\t\t\t\tif (aControl.union_lv_attrib)\n\t\t\t\t\taControl.union_lv_attrib->no_auto_sort = adding;\n\t\t\t}\n\t\t}\n\t\telse if (aControl.type == GUI_CONTROL_LISTVIEW && !_tcsicmp(option, _T(\"Grid\")))\n\t\t\tif (adding) aOpt.listview_style |= LVS_EX_GRIDLINES; else aOpt.listview_style &= ~LVS_EX_GRIDLINES;\n\t\telse if (!_tcsnicmp(option, _T(\"Count\"), 5)) // Script should only provide the option for ListViews.\n\t\t\taOpt.limit = ATOI(option + 5); // For simplicity, the value of \"adding\" is ignored.\n\t\telse if (!_tcsnicmp(option, _T(\"LV\"), 2) && ParsePositiveInteger(option + 2, option_dword))\n\t\t\tif (adding) aOpt.listview_style |= option_dword; else aOpt.listview_style &= ~option_dword;\n\t\telse if (!_tcsnicmp(option, _T(\"ImageList\"), 9))\n\t\t{\n\t\t\tif (adding)\n\t\t\t\taOpt.himagelist = (HIMAGELIST)(size_t)ATOU(option + 9);\n\t\t\t//else removal not currently supported, since that would require detection of whether\n\t\t\t// to destroy the old imagelist, which is difficult to know because it might be in use\n\t\t\t// by other types of controls?\n\t\t}\n\n\t\t// Button\n\t\telse if (aControl.type == GUI_CONTROL_BUTTON && !_tcsicmp(option, _T(\"Default\")))\n\t\t\tif (adding) aOpt.style_add |= BS_DEFPUSHBUTTON; else aOpt.style_remove |= BS_DEFPUSHBUTTON;\n\t\telse if (aControl.type == GUI_CONTROL_CHECKBOX && !_tcsicmp(option, _T(\"Check3\"))) // Radios can't have the 3rd/gray state.\n\t\t\tif (adding) aOpt.style_add |= BS_AUTO3STATE; else aOpt.style_remove |= BS_AUTO3STATE;\n\n\t\t// Edit (and upper/lowercase for combobox/ddl, and others)\n\t\telse if (!_tcsicmp(option, _T(\"ReadOnly\")))\n\t\t{\n\t\t\tswitch (aControl.type)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\tif (aControl.hwnd) // Update the existing edit. Must use SendMessage() vs. changing the style.\n\t\t\t\t\tSendMessage(aControl.hwnd, EM_SETREADONLY, adding, 0);\n\t\t\t\telse\n\t\t\t\t\tif (adding) aOpt.style_add |= ES_READONLY; else aOpt.style_remove |= ES_READONLY;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\t\tif (adding) aOpt.style_add |= LBS_NOSEL; else aOpt.style_remove |= LBS_NOSEL;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_LISTVIEW:\n\t\t\t\tif (adding) aOpt.style_remove |= LVS_EDITLABELS; else aOpt.style_add |= LVS_EDITLABELS;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_TREEVIEW:\n\t\t\t\tif (adding) aOpt.style_remove |= TVS_EDITLABELS; else aOpt.style_add |= TVS_EDITLABELS;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\telse if (!_tcsicmp(option, _T(\"Multi\")))\n\t\t{\n\t\t\t// It was named \"multi\" vs. multiline and/or \"MultiSel\" because it seems easier to\n\t\t\t// remember in these cases. In fact, any time two styles can be combined into one\n\t\t\t// name whose actual function depends on the control type, it seems likely to make\n\t\t\t// things easier to remember.\n\t\t\tswitch(aControl.type)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\tif (adding) aOpt.style_add |= ES_MULTILINE; else aOpt.style_remove |= ES_MULTILINE;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\t\tif (adding) aOpt.style_add |= LBS_EXTENDEDSEL; else aOpt.style_remove |= LBS_EXTENDEDSEL;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_LISTVIEW:\n\t\t\t\tif (adding) aOpt.style_remove |= LVS_SINGLESEL; else aOpt.style_add |= LVS_SINGLESEL;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_MONTHCAL:\n\t\t\t\tif (adding) aOpt.style_add |= MCS_MULTISELECT; else aOpt.style_remove |= MCS_MULTISELECT;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\telse if (aControl.type == GUI_CONTROL_EDIT && !_tcsicmp(option, _T(\"WantReturn\")))\n\t\t\tif (adding) aOpt.style_add |= ES_WANTRETURN; else aOpt.style_remove |= ES_WANTRETURN;\n\t\telse if (aControl.type == GUI_CONTROL_EDIT && !_tcsicmp(option, _T(\"WantTab\")))\n\t\t\tif (adding) aControl.attrib |= GUI_CONTROL_ATTRIB_ALTBEHAVIOR; else aControl.attrib &= ~GUI_CONTROL_ATTRIB_ALTBEHAVIOR;\n\t\telse if (aControl.type == GUI_CONTROL_EDIT && !_tcsicmp(option, _T(\"WantCtrlA\"))) // v1.0.44: Presence of AltSubmit bit means DON'T want Ctrl-A.\n\t\t\tif (adding) aControl.attrib &= ~GUI_CONTROL_ATTRIB_ALTSUBMIT; else aControl.attrib |= GUI_CONTROL_ATTRIB_ALTSUBMIT;\n\t\telse if ((aControl.type == GUI_CONTROL_LISTVIEW || aControl.type == GUI_CONTROL_TREEVIEW)\n\t\t\t&& !_tcsicmp(option, _T(\"WantF2\"))) // v1.0.44: All an F2 keystroke to edit the focused item.\n\t\t\t// Since WantF2 is the initial default, a script will almost never specify WantF2. Therefore, it's\n\t\t\t// probably not worth the code size to put -ReadOnly into effect automatically for +WantF2.\n\t\t\tif (adding) aControl.attrib &= ~GUI_CONTROL_ATTRIB_ALTBEHAVIOR; else aControl.attrib |= GUI_CONTROL_ATTRIB_ALTBEHAVIOR;\n\t\telse if (aControl.type == GUI_CONTROL_EDIT && !_tcsicmp(option, _T(\"Number\")))\n\t\t\tif (adding) aOpt.style_add |= ES_NUMBER; else aOpt.style_remove |= ES_NUMBER;\n\t\telse if (!_tcsicmp(option, _T(\"Lowercase\")))\n\t\t{\n\t\t\tif (aControl.type == GUI_CONTROL_EDIT)\n\t\t\t\tif (adding) aOpt.style_add |= ES_LOWERCASE; else aOpt.style_remove |= ES_LOWERCASE;\n\t\t\telse if (aControl.type == GUI_CONTROL_COMBOBOX || aControl.type == GUI_CONTROL_DROPDOWNLIST)\n\t\t\t\tif (adding) aOpt.style_add |= CBS_LOWERCASE; else aOpt.style_remove |= CBS_LOWERCASE;\n\t\t}\n\t\telse if (!_tcsicmp(option, _T(\"Uppercase\")))\n\t\t{\n\t\t\tif (aControl.type == GUI_CONTROL_EDIT)\n\t\t\t\tif (adding) aOpt.style_add |= ES_UPPERCASE; else aOpt.style_remove |= ES_UPPERCASE;\n\t\t\telse if (aControl.type == GUI_CONTROL_COMBOBOX || aControl.type == GUI_CONTROL_DROPDOWNLIST)\n\t\t\t\tif (adding) aOpt.style_add |= CBS_UPPERCASE; else aOpt.style_remove |= CBS_UPPERCASE;\n\t\t}\n\t\telse if (aControl.type == GUI_CONTROL_EDIT && !_tcsnicmp(option, _T(\"Password\"), 8))\n\t\t{\n\t\t\t// Allow a space to be the masking character, since it's conceivable that might\n\t\t\t// be wanted in cases where someone doesn't want anyone to know they're typing a password.\n\t\t\t// Simplest to assign unconditionally, regardless of whether adding or removing:\n\t\t\taOpt.password_char = option[8]; // Can be '\\0', which indicates \"use OS default\".\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\taOpt.style_add |= ES_PASSWORD;\n\t\t\t\tif (aControl.hwnd) // Update the existing edit.\n\t\t\t\t{\n\t\t\t\t\t// Provide default since otherwise pass-char will be removed vs. added.\n\t\t\t\t\t// The encoding of the message's parameter depends on whether SendMessageW or SendMessageA is called.\n\t\t\t\t\t// 9679 corresponds to the default bullet character on XP and later (verified with EM_GETPASSWORDCHAR).\n\t\t\t\t\tif (!aOpt.password_char)\n\t\t\t\t\t\tSendMessageW(aControl.hwnd, EM_SETPASSWORDCHAR, 9679, 0);\n\t\t\t\t\telse\n\t\t\t\t\t\tSendMessage(aControl.hwnd, EM_SETPASSWORDCHAR, (WPARAM)aOpt.password_char, 0);\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\taOpt.style_remove |= ES_PASSWORD;\n\t\t\t\tif (aControl.hwnd) // Update the existing edit.\n\t\t\t\t\tSendMessage(aControl.hwnd, EM_SETPASSWORDCHAR, 0, 0);\n\t\t\t}\n\t\t\t// Despite what MSDN seems to say, the control is not redrawn when the EM_SETPASSWORDCHAR\n\t\t\t// message is received. This is required for the control to visibly update immediately:\n\t\t\tdo_invalidate_rect = true;\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"Limit\"), 5)) // This is used for Hotkey controls also.\n\t\t{\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tauto option_value = option + 5;\n\t\t\t\taOpt.limit = *option_value ? ATOI(option_value) : -1; // -1 signals it to limit input to visible width of field.\n\t\t\t\t// aOpt.limit will later be ignored for some control types.\n\t\t\t}\n\t\t\telse\n\t\t\t\taOpt.limit = INT_MIN; // Signal it to remove the limit.\n\t\t}\n\n\t\t// Combo/DropDownList/ListBox/ListView\n\t\telse if (aControl.type == GUI_CONTROL_COMBOBOX && !_tcsicmp(option, _T(\"Simple\"))) // DDL is not equipped to handle this style.\n\t\t\tif (adding) aOpt.style_add |= CBS_SIMPLE; else aOpt.style_remove |= CBS_SIMPLE;\n\t\telse if (!_tcsnicmp(option, _T(\"Sort\"), 4))\n\t\t{\n\t\t\tswitch(aControl.type)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\t\tif (adding) aOpt.style_add |= LBS_SORT; else aOpt.style_remove |= LBS_SORT;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_LISTVIEW: // LVS_SORTDESCENDING is not a named style due to rarity of use.\n\t\t\t\tif (adding)\n\t\t\t\t\taOpt.style_add |= _tcsicmp(option + 4, _T(\"Desc\")) ? LVS_SORTASCENDING : LVS_SORTDESCENDING;\n\t\t\t\telse\n\t\t\t\t\taOpt.style_remove |= LVS_SORTASCENDING|LVS_SORTDESCENDING;\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\t\tcase GUI_CONTROL_COMBOBOX:\n\t\t\t\tif (adding) aOpt.style_add |= CBS_SORT; else aOpt.style_remove |= CBS_SORT;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t\t// UpDown\n\t\telse if (aControl.type == GUI_CONTROL_UPDOWN && !_tcsicmp(option, _T(\"Horz\")))\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\taOpt.style_add |= UDS_HORZ;\n\t\t\t\taOpt.style_add &= ~UDS_AUTOBUDDY; // Doing it this way allows \"Horz +0x10\" to override Horz's lack of buddy.\n\t\t\t}\n\t\t\telse\n\t\t\t\taOpt.style_remove |= UDS_HORZ; // But don't add UDS_AUTOBUDDY since it seems undesirable most of the time.\n\n\t\t// Slider\n\t\telse if (aControl.type == GUI_CONTROL_SLIDER && !_tcsicmp(option, _T(\"Invert\"))) // Not called \"Reverse\" to avoid confusion with the non-functional style of that name.\n\t\t\tif (adding) aControl.attrib |= GUI_CONTROL_ATTRIB_ALTBEHAVIOR; else aControl.attrib &= ~GUI_CONTROL_ATTRIB_ALTBEHAVIOR;\n\t\telse if (aControl.type == GUI_CONTROL_SLIDER && !_tcsicmp(option, _T(\"NoTicks\")))\n\t\t\tif (adding) aOpt.style_add |= TBS_NOTICKS; else aOpt.style_remove |= TBS_NOTICKS;\n\t\telse if (aControl.type == GUI_CONTROL_SLIDER && !_tcsnicmp(option, _T(\"TickInterval\"), 12))\n\t\t{\n\t\t\taOpt.tick_interval_changed = true;\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\taOpt.style_add |= TBS_AUTOTICKS;\n\t\t\t\tauto option_value = option + 12;\n\t\t\t\taOpt.tick_interval_specified = *option_value;\n\t\t\t\taOpt.tick_interval = ATOI(option_value);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\taOpt.style_remove |= TBS_AUTOTICKS;\n\t\t\t\taOpt.tick_interval = -1; // Signal it to remove the ticks later below (if the window exists).\n\t\t\t}\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"Line\"), 4))\n\t\t{\n\t\t\tauto option_value = option + 4;\n\t\t\tif (aControl.type == GUI_CONTROL_SLIDER)\n\t\t\t{\n\t\t\t\tif (adding)\n\t\t\t\t\taOpt.line_size = ATOI(option_value);\n\t\t\t\t//else removal not supported.\n\t\t\t}\n\t\t\telse if (aControl.type == GUI_CONTROL_TREEVIEW && ctoupper(*option_value) == 'S')\n\t\t\t\t// Seems best to consider TVS_HASLINES|TVS_LINESATROOT to be an inseparable group since\n\t\t\t\t// one without the other is rare (script can always be overridden by specifying numeric styles):\n\t\t\t\tif (adding) aOpt.style_add |= TVS_HASLINES|TVS_LINESATROOT; else aOpt.style_remove |= TVS_HASLINES|TVS_LINESATROOT;\n\t\t}\n\t\telse if (aControl.type == GUI_CONTROL_SLIDER && !_tcsnicmp(option, _T(\"Page\"), 4))\n\t\t{\n\t\t\tif (adding)\n\t\t\t\taOpt.page_size = ATOI(option + 4);\n\t\t\t//else removal not supported.\n\t\t}\n\t\telse if (aControl.type == GUI_CONTROL_SLIDER && !_tcsnicmp(option, _T(\"Thick\"), 5))\n\t\t{\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\taOpt.style_add |= TBS_FIXEDLENGTH;\n\t\t\t\taOpt.thickness = ATOI(option + 5);\n\t\t\t}\n\t\t\telse // Removing the style is enough to reset its appearance on both XP Theme and Classic Theme.\n\t\t\t\taOpt.style_remove |= TBS_FIXEDLENGTH;\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"ToolTip\"), 7))\n\t\t{\n\t\t\tauto option_value = option + 7;\n\t\t\t// Below was commented out because the SBARS_TOOLTIPS doesn't seem to do much, if anything.\n\t\t\t// See bottom of BIF_StatusBar() for more comments.\n\t\t\t//if (aControl.type == GUI_CONTROL_STATUSBAR)\n\t\t\t//{\n\t\t\t//\tif (!*option_value)\n\t\t\t//\t\tif (adding) aOpt.style_add |= SBARS_TOOLTIPS; else aOpt.style_remove |= SBARS_TOOLTIPS;\n\t\t\t//}\n\t\t\t//else\n\t\t\tif (aControl.type == GUI_CONTROL_SLIDER)\n\t\t\t{\n\t\t\t\tif (adding)\n\t\t\t\t{\n\t\t\t\t\taOpt.tip_side = -1; // Set default.\n\t\t\t\t\tswitch(ctoupper(*option_value))\n\t\t\t\t\t{\n\t\t\t\t\tcase 'T': aOpt.tip_side = TBTS_TOP; break;\n\t\t\t\t\tcase 'L': aOpt.tip_side = TBTS_LEFT; break;\n\t\t\t\t\tcase 'B': aOpt.tip_side = TBTS_BOTTOM; break;\n\t\t\t\t\tcase 'R': aOpt.tip_side = TBTS_RIGHT; break;\n\t\t\t\t\t}\n\t\t\t\t\tif (aOpt.tip_side < 0)\n\t\t\t\t\t\taOpt.tip_side = 0; // Restore to the value that means \"use default side\".\n\t\t\t\t\telse\n\t\t\t\t\t\t++aOpt.tip_side; // Offset by 1, since zero is reserved as \"use default side\".\n\t\t\t\t\taOpt.style_add |= TBS_TOOLTIPS;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\taOpt.style_remove |= TBS_TOOLTIPS;\n\t\t\t}\n\t\t}\n\t\telse if (aControl.type == GUI_CONTROL_SLIDER && !_tcsnicmp(option, _T(\"Buddy\"), 5))\n\t\t{\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tauto option_value = option + 5;\n\t\t\t\tTCHAR which_buddy = *option_value;\n\t\t\t\tif (which_buddy) // i.e. it's not the zero terminator\n\t\t\t\t{\n\t\t\t\t\tGuiIndexType u = FindControl(option_value + 1);\n\t\t\t\t\tif (u < mControlCount)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (which_buddy == '1')\n\t\t\t\t\t\t\taOpt.buddy1 = mControl[u];\n\t\t\t\t\t\telse // assume '2'\n\t\t\t\t\t\t\taOpt.buddy2 = mControl[u];\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t//else removal not supported.\n\t\t}\n\n\t\t// Progress and Slider\n\t\telse if (!_tcsicmp(option, _T(\"Vertical\")))\n\t\t{\n\t\t\t// Seems best not to recognize Vertical for Tab controls since Left and Right\n\t\t\t// already cover it very well.\n\t\t\tif (aControl.type == GUI_CONTROL_SLIDER)\n\t\t\t\tif (adding) aOpt.style_add |= TBS_VERT; else aOpt.style_remove |= TBS_VERT;\n\t\t\telse if (aControl.type == GUI_CONTROL_PROGRESS)\n\t\t\t\tif (adding) aOpt.style_add |= PBS_VERTICAL; else aOpt.style_remove |= PBS_VERTICAL;\n\t\t\t//else do nothing, not a supported type\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"Range\"), 5)) // Caller should ignore aOpt.range_min/max if it isn't applicable for this control type.\n\t\t{\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tauto option_value = option + 5; // Helps with omitting the first minus sign, if any, below.\n\t\t\t\tif (*option_value) // Prevent reading beyond the zero terminator due to option_value+1 in some places below.\n\t\t\t\t{\n\t\t\t\t\tif (aControl.type == GUI_CONTROL_DATETIME || aControl.type == GUI_CONTROL_MONTHCAL)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Note: aOpt.range_changed is not set for these control types. aOpt.gdtr_range is used instead.\n\t\t\t\t\t\taOpt.gdtr_range = YYYYMMDDToSystemTime2(option_value, aOpt.sys_time_range);\n\t\t\t\t\t\tif (!aOpt.gdtr_range) // Must be invalid, since option_value was verified to be non-empty.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\terror_message = ERR_INVALID_OPTION;\n\t\t\t\t\t\t\tgoto return_error;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (aControl.hwnd) // Caller relies on us doing it now.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tSendMessage(aControl.hwnd // MCM_SETRANGE != DTM_SETRANGE\n\t\t\t\t\t\t\t\t, aControl.type == GUI_CONTROL_DATETIME ? DTM_SETRANGE : MCM_SETRANGE\n\t\t\t\t\t\t\t\t, aOpt.gdtr_range, (LPARAM)aOpt.sys_time_range);\n\t\t\t\t\t\t\t// Unlike GUI_CONTROL_DATETIME, GUI_CONTROL_MONTHCAL doesn't visibly update selection\n\t\t\t\t\t\t\t// when new range is applied, not even with InvalidateRect(). In fact, it doesn't\n\t\t\t\t\t\t\t// internally update either. This might be worked around by getting the selected\n\t\t\t\t\t\t\t// date (or range of dates) and reapplying them, but the need is rare enough that\n\t\t\t\t\t\t\t// code size reduction seems more important.\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\telse // Control types other than datetime/monthcal.\n\t\t\t\t\t{\n\t\t\t\t\t\taOpt.range_changed = true;\n\t\t\t\t\t\taOpt.range_min = ATOI(option_value);\n\t\t\t\t\t\tif (auto cp = _tcschr(option_value + 1, '-')) // +1 to omit the min's minus sign, if it has one.\n\t\t\t\t\t\t\taOpt.range_max = ATOI(cp + 1);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t//else the Range word is present but has nothing after it. Ignore it.\n\t\t\t}\n\t\t\t//else removing. Do nothing (not currently implemented).\n\t\t}\n\n\t\t// Progress\n\t\telse if (aControl.type == GUI_CONTROL_PROGRESS && !_tcsicmp(option, _T(\"Smooth\")))\n\t\t\tif (adding) aOpt.style_add |= PBS_SMOOTH; else aOpt.style_remove |= PBS_SMOOTH;\n\n\t\t// Tab control\n\t\telse if (!_tcsicmp(option, _T(\"Buttons\")))\n\t\t{\n\t\t\tif (aControl.type == GUI_CONTROL_TAB)\n\t\t\t\tif (adding) aOpt.style_add |= TCS_BUTTONS; else aOpt.style_remove |= TCS_BUTTONS;\n\t\t\telse if (aControl.type == GUI_CONTROL_TREEVIEW)\n\t\t\t\tif (adding) aOpt.style_add |= TVS_HASBUTTONS; else aOpt.style_remove |= TVS_HASBUTTONS;\n\t\t}\n\t\telse if (aControl.type == GUI_CONTROL_TAB && !_tcsicmp(option, _T(\"Bottom\")))\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\taOpt.style_add |= TCS_BOTTOM;\n\t\t\t\taOpt.style_remove |= TCS_VERTICAL;\n\t\t\t}\n\t\t\telse\n\t\t\t\taOpt.style_remove |= TCS_BOTTOM;\n\n\t\telse if (aControl.type == GUI_CONTROL_CUSTOM && !_tcsnicmp(option, _T(\"Class\"), 5))\n\t\t{\n\t\t\tWNDCLASSEX wc;\n\t\t\t// Retrieve the class atom (http://blogs.msdn.com/b/oldnewthing/archive/2004/10/11/240744.aspx)\n\t\t\taOpt.customClassAtom = (ATOM) GetClassInfoEx(g_hInstance, option + 5, &wc);\n\t\t\tif (aOpt.customClassAtom == 0)\n\t\t\t{\n\t\t\t\terror_message = _T(\"Unrecognized window class.\");\n\t\t\t\tgoto return_error;\n\t\t\t}\n\t\t}\n\n\t\t// Styles (alignment/justification):\n\t\telse if (!_tcsicmp(option, _T(\"Center\")))\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tswitch (aControl.type)\n\t\t\t\t{\n\t\t\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t\t\tif (adding) aOpt.style_add |= TBS_BOTH;\n\t\t\t\t\taOpt.style_remove |= TBS_LEFT;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TEXT:\n\t\t\t\t\taOpt.style_add |= SS_CENTER;\n\t\t\t\t\taOpt.style_remove |= (SS_TYPEMASK & ~SS_CENTER); // i.e. Zero out all type-bits except SS_CENTER's bit.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_GROUPBOX: // Changes alignment of its label.\n\t\t\t\tcase GUI_CONTROL_BUTTON: // Probably has no effect in this case, since it's centered by default?\n\t\t\t\tcase GUI_CONTROL_CHECKBOX: // Puts gap between box and label.\n\t\t\t\tcase GUI_CONTROL_RADIO:\n\t\t\t\t\taOpt.style_add |= BS_CENTER;\n\t\t\t\t\t// But don't remove BS_LEFT or BS_RIGHT since BS_CENTER is defined as a combination of them.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\t\taOpt.style_add |= ES_CENTER;\n\t\t\t\t\taOpt.style_remove |= ES_RIGHT; // Mutually exclusive since together they are (probably) invalid.\n\t\t\t\t\tbreak;\n\t\t\t\t// Not applicable for:\n\t\t\t\t//case GUI_CONTROL_PIC: SS_CENTERIMAGE is currently not used due to auto-pic-scaling/fitting.\n\t\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t\t//case GUI_CONTROL_UPDOWN:\n\t\t\t\t//case GUI_CONTROL_DATETIME:\n\t\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t\t//case GUI_CONTROL_LINK:\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // Removing.\n\t\t\t{\n\t\t\t\tswitch (aControl.type)\n\t\t\t\t{\n\t\t\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t\t\taOpt.style_remove |= TBS_BOTH;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TEXT:\n\t\t\t\t\taOpt.style_remove |= SS_TYPEMASK; // Revert to SS_LEFT because there's no way of knowing what the intended or previous value was.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\tcase GUI_CONTROL_CHECKBOX:\n\t\t\t\tcase GUI_CONTROL_RADIO:\n\t\t\t\t\t// BS_CENTER is a tricky one since it is a combination of BS_LEFT and BS_RIGHT.\n\t\t\t\t\t// If the control exists and has either BS_LEFT or BS_RIGHT (but not both), do\n\t\t\t\t\t// nothing:\n\t\t\t\t\tif (aControl.hwnd)\n\t\t\t\t\t{\n\t\t\t\t\t\t// v1.0.44.08: Fixed the following by adding \"== BS_CENTER\":\n\t\t\t\t\t\tif ((GetWindowLong(aControl.hwnd, GWL_STYLE) & BS_CENTER) == BS_CENTER) // i.e. it has both BS_LEFT and BS_RIGHT\n\t\t\t\t\t\t\taOpt.style_remove |= BS_CENTER;\n\t\t\t\t\t\t//else nothing needs to be done.\n\t\t\t\t\t}\n\t\t\t\t\telse // v1.0.44.08: Fixed the following by adding \"== BS_CENTER\":\n\t\t\t\t\t\tif ((aOpt.style_add & BS_CENTER) == BS_CENTER) // i.e. Both BS_LEFT and BS_RIGHT are set to be added.\n\t\t\t\t\t\t\taOpt.style_add &= ~BS_CENTER; // Undo it, which later helps avoid the need to apply style_add prior to style_remove.\n\t\t\t\t\t\t//else nothing needs to be done.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\t\taOpt.style_remove |= ES_CENTER;\n\t\t\t\t\tbreak;\n\t\t\t\t// Not applicable for:\n\t\t\t\t//case GUI_CONTROL_PIC: SS_CENTERIMAGE is currently not used due to auto-pic-scaling/fitting.\n\t\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t\t//case GUI_CONTROL_UPDOWN:\n\t\t\t\t//case GUI_CONTROL_DATETIME:\n\t\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t\t//case GUI_CONTROL_LINK:\n\t\t\t\t}\n\t\t\t}\n\n\t\telse if (!_tcsicmp(option, _T(\"Right\")))\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tswitch (aControl.type)\n\t\t\t\t{\n\t\t\t\tcase GUI_CONTROL_UPDOWN:\n\t\t\t\t\taOpt.style_remove |= UDS_ALIGNLEFT;\n\t\t\t\t\taOpt.style_add |= UDS_ALIGNRIGHT;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_DATETIME:\n\t\t\t\t\taOpt.style_add |= DTS_RIGHTALIGN;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t\t\taOpt.style_remove |= TBS_LEFT|TBS_BOTH;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TEXT:\n\t\t\t\t\taOpt.style_add |= SS_RIGHT;\n\t\t\t\t\taOpt.style_remove |= (SS_TYPEMASK & ~SS_RIGHT); // i.e. Zero out all type-bits except SS_RIGHT's bit.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\tcase GUI_CONTROL_CHECKBOX:\n\t\t\t\tcase GUI_CONTROL_RADIO:\n\t\t\t\t\taOpt.style_add |= BS_RIGHT;\n\t\t\t\t\t// Doing this indirectly removes BS_CENTER, and does it in a way that makes unimportant\n\t\t\t\t\t// the order in which style_add and style_remove are applied later:\n\t\t\t\t\taOpt.style_remove |= BS_LEFT;\n\t\t\t\t\t// And by default, put button itself to the right of its label since that seems\n\t\t\t\t\t// likely to be far more common/desirable (there can be a more obscure option\n\t\t\t\t\t// later to change this default):\n\t\t\t\t\tif (aControl.type == GUI_CONTROL_CHECKBOX || aControl.type == GUI_CONTROL_RADIO)\n\t\t\t\t\t\taOpt.style_add |= BS_RIGHTBUTTON;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\t\taOpt.style_add |= ES_RIGHT;\n\t\t\t\t\taOpt.style_remove |= ES_CENTER; // Mutually exclusive since together they are (probably) invalid.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TAB:\n\t\t\t\t\taOpt.style_add |= TCS_VERTICAL|TCS_MULTILINE|TCS_RIGHT;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_LINK:\n\t\t\t\t\taOpt.style_add |= LWS_RIGHT;\n\t\t\t\t\tbreak;\n\t\t\t\t// Not applicable for:\n\t\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t\t//case GUI_CONTROL_PIC: SS_RIGHTJUST is currently not used due to auto-pic-scaling/fitting.\n\t\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // Removing.\n\t\t\t{\n\t\t\t\tswitch (aControl.type)\n\t\t\t\t{\n\t\t\t\tcase GUI_CONTROL_DATETIME:\n\t\t\t\t\taOpt.style_remove |= DTS_RIGHTALIGN;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t\t\taOpt.style_add |= TBS_LEFT;\n\t\t\t\t\taOpt.style_remove |= TBS_BOTH; // Debatable.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TEXT:\n\t\t\t\t\taOpt.style_remove |= SS_TYPEMASK; // Revert to SS_LEFT because there's no way of knowing what the intended or previous value was.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\tcase GUI_CONTROL_CHECKBOX:\n\t\t\t\tcase GUI_CONTROL_RADIO:\n\t\t\t\t\t// BS_RIGHT is a tricky one since it is included inside BS_CENTER.\n\t\t\t\t\t// Thus, if the control exists and has BS_CENTER, do nothing since\n\t\t\t\t\t// BS_RIGHT can't be in effect if BS_CENTER already is:\n\t\t\t\t\tif (aControl.hwnd)\n\t\t\t\t\t{\n\t\t\t\t\t\tif ((GetWindowLong(aControl.hwnd, GWL_STYLE) & BS_CENTER) != BS_CENTER) // v1.0.44.08: Fixed by adding \"!= BS_CENTER\".\n\t\t\t\t\t\t\taOpt.style_remove |= BS_RIGHT;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tif ((aOpt.style_add & BS_CENTER) != BS_CENTER) // v1.0.44.08: Fixed by adding \"!= BS_CENTER\".\n\t\t\t\t\t\t\taOpt.style_add &= ~BS_RIGHT; // A little strange, but seems correct since control hasn't even been created yet.\n\t\t\t\t\t\t//else nothing needs to be done because BS_RIGHT is already in effect removed since\n\t\t\t\t\t\t//BS_CENTER makes BS_RIGHT impossible to manifest.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\t\taOpt.style_remove |= ES_RIGHT;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TAB:\n\t\t\t\t\taOpt.style_remove |= TCS_VERTICAL|TCS_RIGHT;\n\t\t\t\t\tbreak;\n\t\t\t\t// Not applicable for:\n\t\t\t\t//case GUI_CONTROL_UPDOWN: Removing \"right\" doesn't make much sense, so only adding \"left\" is supported.\n\t\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t\t//case GUI_CONTROL_PIC: SS_RIGHTJUST is currently not used due to auto-pic-scaling/fitting.\n\t\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t\t//case GUI_CONTROL_LINK:\n\t\t\t\t}\n\t\t\t}\n\n\t\telse if (!_tcsicmp(option, _T(\"Left\")))\n\t\t{\n\t\t\tif (adding)\n\t\t\t{\n\t\t\t\tswitch (aControl.type)\n\t\t\t\t{\n\t\t\t\tcase GUI_CONTROL_UPDOWN:\n\t\t\t\t\taOpt.style_remove |= UDS_ALIGNRIGHT;\n\t\t\t\t\taOpt.style_add |= UDS_ALIGNLEFT;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_DATETIME:\n\t\t\t\t\taOpt.style_remove |= DTS_RIGHTALIGN;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t\t\taOpt.style_add |= TBS_LEFT;\n\t\t\t\t\taOpt.style_remove |= TBS_BOTH;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TEXT:\n\t\t\t\t\taOpt.style_remove |= SS_TYPEMASK; // i.e. Zero out all type-bits to expose the default of 0, which is SS_LEFT.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_CHECKBOX:\n\t\t\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\tcase GUI_CONTROL_RADIO:\n\t\t\t\t\taOpt.style_add |= BS_LEFT;\n\t\t\t\t\t// Doing this indirectly removes BS_CENTER, and does it in a way that makes unimportant\n\t\t\t\t\t// the order in which style_add and style_remove are applied later:\n\t\t\t\t\taOpt.style_remove |= BS_RIGHT;\n\t\t\t\t\t// And by default, put button itself to the left of its label since that seems\n\t\t\t\t\t// likely to be far more common/desirable (there can be a more obscure option\n\t\t\t\t\t// later to change this default):\n\t\t\t\t\tif (aControl.type == GUI_CONTROL_CHECKBOX || aControl.type == GUI_CONTROL_RADIO)\n\t\t\t\t\t\taOpt.style_remove |= BS_RIGHTBUTTON;\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_EDIT:\n\t\t\t\t\taOpt.style_remove |= ES_RIGHT|ES_CENTER; // Removing these exposes the default of 0, which is LEFT.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TAB:\n\t\t\t\t\taOpt.style_add |= TCS_VERTICAL|TCS_MULTILINE;\n\t\t\t\t\taOpt.style_remove |= TCS_RIGHT;\n\t\t\t\t\tbreak;\n\t\t\t\t// Not applicable for:\n\t\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t\t//case GUI_CONTROL_PIC: SS_CENTERIMAGE is currently not used due to auto-pic-scaling/fitting.\n\t\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t\t//case GUI_CONTROL_LINK:\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // Removing.\n\t\t\t{\n\t\t\t\tswitch (aControl.type)\n\t\t\t\t{\n\t\t\t\tcase GUI_CONTROL_SLIDER:\n\t\t\t\t\taOpt.style_remove |= TBS_LEFT|TBS_BOTH; // Removing TBS_BOTH is debatable, but \"-left\" is pretty rare/obscure anyway.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\tcase GUI_CONTROL_CHECKBOX:\n\t\t\t\tcase GUI_CONTROL_RADIO:\n\t\t\t\t\t// BS_LEFT is a tricky one since it is included inside BS_CENTER.\n\t\t\t\t\t// Thus, if the control exists and has BS_CENTER, do nothing since\n\t\t\t\t\t// BS_LEFT can't be in effect if BS_CENTER already is:\n\t\t\t\t\tif (aControl.hwnd)\n\t\t\t\t\t{\n\t\t\t\t\t\tif ((GetWindowLong(aControl.hwnd, GWL_STYLE) & BS_CENTER) != BS_CENTER) // v1.0.44.08: Fixed by adding \"!= BS_CENTER\".\n\t\t\t\t\t\t\taOpt.style_remove |= BS_LEFT;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\tif ((aOpt.style_add & BS_CENTER) != BS_CENTER) // v1.0.44.08: Fixed by adding \"!= BS_CENTER\".\n\t\t\t\t\t\t\taOpt.style_add &= ~BS_LEFT; // A little strange, but seems correct since control hasn't even been created yet.\n\t\t\t\t\t\t//else nothing needs to be done because BS_LEFT is already in effect removed since\n\t\t\t\t\t\t//BS_CENTER makes BS_LEFT impossible to manifest.\n\t\t\t\t\tbreak;\n\t\t\t\tcase GUI_CONTROL_TAB:\n\t\t\t\t\taOpt.style_remove |= TCS_VERTICAL;\n\t\t\t\t\tbreak;\n\t\t\t\t// Not applicable for these since their LEFT attributes are zero and thus cannot be removed:\n\t\t\t\t//case GUI_CONTROL_UPDOWN: Removing \"left\" doesn't make much sense, so only adding \"right\" is supported.\n\t\t\t\t//case GUI_CONTROL_DATETIME: Removing \"left\" is not supported since it seems counterintuitive and too rarely needed.\n\t\t\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t\t\t//case GUI_CONTROL_TEXT:\n\t\t\t\t//case GUI_CONTROL_PIC:\n\t\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t\t//case GUI_CONTROL_EDIT:\n\t\t\t\t//case GUI_CONTROL_LINK:\n\t\t\t\t}\n\t\t\t}\n\t\t} // else if\n\n\t\telse\n\t\t{\n\t\t\t// THE BELOW SHOULD BE DONE LAST so that they don't steal phrases/words that should be detected\n\t\t\t// as option words above. An existing example is H for Hidden (above) or Height (below).\n\t\t\t// Additional examples:\n\t\t\t// if \"visible\" and \"resize\" ever become valid option words, the below would otherwise wrongly\n\t\t\t// detect them as variable=isible and row_count=esize, respectively.\n\n\t\t\tif (ParsePositiveInteger(option, option_dword)) // Above has already verified that *option can't be whitespace.\n\t\t\t{\n\t\t\t\t// Pure numbers are assumed to be style additions or removals:\n\t\t\t\tif (adding) aOpt.style_add |= option_dword; else aOpt.style_remove |= option_dword;\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tTCHAR option_char = ctoupper(*option);\n\t\t\tauto option_value = option + 1; // Above has already verified that option isn't the empty string.\n\n\t\t\tif (!*option_value)\n\t\t\t{\n\t\t\t\t// The option word consists of only one character, so consider it valid only if it doesn't\n\t\t\t\t// require an arg. Example: An isolated \"H\" should not cause the height to be set to zero.\n\t\t\t\tswitch (option_char)\n\t\t\t\t{\n\t\t\t\tcase 'C':\n\t\t\t\t\tif (!adding)\n\t\t\t\t\t\taOpt.color = CLR_DEFAULT; // i.e. use system default even if mCurrentColor is non-default.\n\t\t\t\t\tbreak;\n\t\t\t\tcase 'V':\n\t\t\t\t\tControlSetName(aControl, NULL);\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\t// Anything else is invalid.\n\t\t\t\t\terror_message = ERR_INVALID_OPTION;\n\t\t\t\t\tgoto return_error;\n\t\t\t\t}\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// Since above didn't \"continue\", there is text after the option letter, so take action accordingly.\n\n\t\t\tint option_int = 0; // Only valid for [XYWHTER].\n\t\t\tfloat option_float; // Only valid for R.\n\t\t\tTCHAR option_char2; // Only valid for [XYWH].\n\t\t\tbool use_margin_offset; // Only valid for [XY].\n\n\t\t\tif (_tcschr(_T(\"XYWHTER\"), option_char))\n\t\t\t{\n\t\t\t\toption_char2 = ctoupper(*option_value);\n\t\t\t\tswitch (option_char)\n\t\t\t\t{\n\t\t\t\tcase 'W':\n\t\t\t\tcase 'H':\n\t\t\t\t\tif (option_char2 == 'P')\n\t\t\t\t\t\t++option_value;\n\t\t\t\t\tbreak;\n\t\t\t\tcase 'X':\n\t\t\t\tcase 'Y':\n\t\t\t\t\tif (use_margin_offset = (*option_value == '+' && 'M' == ctoupper(option_value[1]))) // x+m or y+m.\n\t\t\t\t\t\toption_value += 2;\n\t\t\t\t\telse if (_tcschr(_T(\"MPS+\"), option_char2)) // Any other non-digit char should be picked up as an error via IsNumeric().\n\t\t\t\t\t\t++option_value;\t\t\t\t\t\t\t// Also skips over the '+' to allow, eg, x+-n\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\t// Allow both integer and floating-point for any numeric options.\n\t\t\t\tswitch (IsNumeric(option_value, TRUE, FALSE, TRUE))\n\t\t\t\t{\n\t\t\t\tcase PURE_INTEGER:\n\t\t\t\t\toption_float = float(option_int = ATOI(option_value)); // 'E' depends on this supporting the full range of DWORD.\n\t\t\t\t\tbreak;\n\t\t\t\tcase PURE_FLOAT:\n\t\t\t\t\toption_int = int(option_float = (float)_tstof(option_value)); // _tstof() vs. ATOF() because PURE_FLOAT is never hexadecimal.\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\tif (*option_value || !option_char2) // i.e. allow blank option_value if option_char2 was recognized above.\n\t\t\t\t\t\toption_char = 0; // Mark it as invalid for switch() below.\n\t\t\t\t}\n\t\t\t\tif ((option_char == 'X' || option_char == 'Y')\n\t\t\t\t\t|| (option_char == 'W' || option_char == 'H') && (option_int > 0 || option_char2 == 'P')) // Scale W/H unless it's negative, as some controls give special meaning to W-1 H-1 W-2.\n\t\t\t\t\toption_int = Scale(option_int);\n\t\t\t}\n\n\t\t\tswitch (option_char)\n\t\t\t{\n\t\t\tcase 'T': // Tabstop (the kind that exists inside a multi-line edit control or ListBox).\n\t\t\t\tif (aOpt.tabstop_count < GUI_MAX_TABSTOPS)\n\t\t\t\t\taOpt.tabstop[aOpt.tabstop_count++] = (UINT)option_int;\n\t\t\t\t//else ignore ones beyond the maximum.\n\t\t\t\tbreak;\n\n\t\t\tcase 'V': // Name (originally: Variable)\n\t\t\t\tswitch (ControlSetName(aControl, option_value))\n\t\t\t\t{\n\t\t\t\tcase FR_FAIL:\n\t\t\t\t\treturn FAIL;\n\t\t\t\tcase FR_E_OUTOFMEM:\n\t\t\t\t\treturn MemoryError();\n\t\t\t\t}\n\t\t\t\tbreak;\n\n\t\t\tcase 'C': // Color\n\t\t\t\tif (!ColorToBGR(option_value, aOpt.color))\n\t\t\t\t{\n\t\t\t\t\terror_message = ERR_INVALID_OPTION;\n\t\t\t\t\tgoto return_error;\n\t\t\t\t}\n\t\t\t\tbreak;\n\n\t\t\tcase 'W':\n\t\t\t\tif (option_char2 == 'P') // Use the previous control's value.\n\t\t\t\t\taOpt.width = mPrevWidth + option_int;\n\t\t\t\telse\n\t\t\t\t\taOpt.width = option_int;\n\t\t\t\tbreak;\n\n\t\t\tcase 'H':\n\t\t\t\tif (option_char2 == 'P') // Use the previous control's value.\n\t\t\t\t\taOpt.height = mPrevHeight + option_int;\n\t\t\t\telse\n\t\t\t\t\taOpt.height = option_int;\n\t\t\t\tbreak;\n\n\t\t\tcase 'X':\n\t\t\t\tif (option_char2 == '+')\n\t\t\t\t{\n\t\t\t\t\tint offset = (use_margin_offset ? mMarginX : 0) + option_int;\n\t\t\t\t\tif (tab_control = FindTabControl(aControl.tab_control_index)) // Assign.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Since this control belongs to a tab control and that tab control already exists,\n\t\t\t\t\t\t// Position it relative to the tab control's client area upper-left corner if this\n\t\t\t\t\t\t// is the first control on this particular tab/page:\n\t\t\t\t\t\tif (!GetControlCountOnTabPage(aControl.tab_control_index, aControl.tab_index))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tpt = GetPositionOfTabDisplayArea(*tab_control);\n\t\t\t\t\t\t\taOpt.x = pt.x + offset;\n\t\t\t\t\t\t\tif (aOpt.y == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\t\t\taOpt.y = pt.y + mMarginY;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// else fall through and do it the standard way.\n\t\t\t\t\t}\n\t\t\t\t\t// Since above didn't break, do it the standard way.\n\t\t\t\t\taOpt.x = mPrevX + mPrevWidth + offset;\n\t\t\t\t\tif (aOpt.y == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.y = mPrevY; // Since moving in the X direction, retain the same Y as previous control.\n\t\t\t\t}\n\t\t\t\t// For the M and P sub-options, note that the +/- prefix is optional. The number is simply\n\t\t\t\t// read in as-is (though the use of + is more self-documenting in this case than omitting\n\t\t\t\t// the sign entirely).\n\t\t\t\telse if (option_char2 == 'M') // Use the X margin\n\t\t\t\t{\n\t\t\t\t\taOpt.x = mMarginX + option_int;\n\t\t\t\t\tif (aOpt.y == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.y = mMaxExtentDown + mMarginY;\n\t\t\t\t}\n\t\t\t\telse if (option_char2 == 'P') // Use the previous control's X position.\n\t\t\t\t{\n\t\t\t\t\taOpt.x = mPrevX + option_int;\n\t\t\t\t\tif (aOpt.y == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.y = aOpt.x != mPrevX ? mPrevY // Since moving in the X direction, retain the same Y as previous control.\n\t\t\t\t\t\t\t: mPrevY + mPrevHeight + mMarginY; // Same X, so default to below the previous control.\n\t\t\t\t}\n\t\t\t\telse if (option_char2 == 'S') // Use the saved X position\n\t\t\t\t{\n\t\t\t\t\taOpt.x = mSectionX + option_int;\n\t\t\t\t\tif (aOpt.y == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.y = mMaxExtentDownSection + mMarginY; // In this case, mMarginY is the padding between controls.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\taOpt.x = option_int;\n\t\t\t\t\tif (aOpt.y == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.y = mMaxExtentDown + mMarginY;\n\t\t\t\t}\n\t\t\t\tbreak;\n\n\t\t\tcase 'Y':\n\t\t\t\tif (option_char2 == '+')\n\t\t\t\t{\n\t\t\t\t\tint offset = (use_margin_offset ? mMarginY : 0) + option_int;\n\t\t\t\t\tif (tab_control = FindTabControl(aControl.tab_control_index)) // Assign.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Since this control belongs to a tab control and that tab control already exists,\n\t\t\t\t\t\t// Position it relative to the tab control's client area upper-left corner if this\n\t\t\t\t\t\t// is the first control on this particular tab/page:\n\t\t\t\t\t\tif (!GetControlCountOnTabPage(aControl.tab_control_index, aControl.tab_index))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tpt = GetPositionOfTabDisplayArea(*tab_control);\n\t\t\t\t\t\t\taOpt.y = pt.y + offset;\n\t\t\t\t\t\t\tif (aOpt.x == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\t\t\taOpt.x = pt.x + mMarginX;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// else fall through and do it the standard way.\n\t\t\t\t\t}\n\t\t\t\t\t// Since above didn't break, do it the standard way.\n\t\t\t\t\taOpt.y = mPrevY + mPrevHeight + offset;\n\t\t\t\t\tif (aOpt.x == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.x = mPrevX; // Since moving in the Y direction, retain the same X as previous control.\n\t\t\t\t}\n\t\t\t\t// For the M and P sub-options, not that the +/- prefix is optional. The number is simply\n\t\t\t\t// read in as-is (though the use of + is more self-documenting in this case than omitting\n\t\t\t\t// the sign entirely).\n\t\t\t\telse if (option_char2 == 'M') // Use the Y margin\n\t\t\t\t{\n\t\t\t\t\taOpt.y = mMarginY + option_int;\n\t\t\t\t\tif (aOpt.x == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.x = mMaxExtentRight + mMarginX;\n\t\t\t\t}\n\t\t\t\telse if (option_char2 == 'P') // Use the previous control's Y position.\n\t\t\t\t{\n\t\t\t\t\taOpt.y = mPrevY + option_int;\n\t\t\t\t\tif (aOpt.x == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.x = aOpt.y != mPrevY ? mPrevX // Since moving in the Y direction, retain the same X as previous control.\n\t\t\t\t\t\t\t: mPrevX + mPrevWidth + mMarginY; // Same Y, so default to below the previous control.\n\t\t\t\t}\n\t\t\t\telse if (option_char2 == 'S') // Use the saved Y position\n\t\t\t\t{\n\t\t\t\t\taOpt.y = mSectionY + option_int;\n\t\t\t\t\tif (aOpt.x == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.x = mMaxExtentRightSection + mMarginX; // In this case, mMarginX is the padding between controls.\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\taOpt.y = option_int;\n\t\t\t\t\tif (aOpt.x == COORD_UNSPECIFIED) // Not yet explicitly set, so use default.\n\t\t\t\t\t\taOpt.x = mMaxExtentRight + mMarginX;\n\t\t\t\t}\n\t\t\t\tbreak;\n\n\t\t\tcase 'R': // The number of rows desired in the control (can be fractional).\n\t\t\t\taOpt.row_count = option_float;\n\t\t\t\tbreak;\n\n\t\t\tcase 'E': // Extended style additions or removals.\n\t\t\t\tif (adding)\n\t\t\t\t\taOpt.exstyle_add |= (DWORD)option_int;\n\t\t\t\telse\n\t\t\t\t\taOpt.exstyle_remove |= (DWORD)option_int;\n\t\t\t\tbreak;\n\n\t\t\tdefault:\n\t\t\t\t// Anything not already handled above is invalid.\n\t\t\t\terror_message = ERR_INVALID_OPTION;\n\t\t\t\tgoto return_error;\n\t\t\t} // switch()\n\t\t} // Final \"else\" in the \"else if\" ladder.\n\n\t\tcontinue;\n\t// This \"subroutine\" is used to reduce code size (needs to be re-verified):\n\treturn_error:\n\t\tif (!ValueError(error_message, option, FAIL_OR_OK))\n\t\t\treturn FAIL;\n\t\t// Otherwise, user wants to continue.\n\t} // for() each item in option list\n\t\n\t// If the control has already been created, apply the new style and exstyle here, if any:\n\tif (aControl.hwnd)\n\t{\n\t\tDWORD current_style = GetWindowLong(aControl.hwnd, GWL_STYLE);\n\t\tDWORD new_style = (current_style | aOpt.style_add) & ~aOpt.style_remove; // Some things such as GUI_CONTROL_TEXT+SS_TYPEMASK might rely on style_remove being applied *after* style_add.\n\t\tUINT current_value_uint; // Currently only used for Progress controls.\n\n\t\t// Fix for v1.0.24:\n\t\t// Certain styles can't be applied with a simple bit-or. The below section is a subset of\n\t\t// a similar section in AddControl() to make sure that these styles are properly handled:\n\t\tswitch (aControl.type)\n\t\t{\n\t\tcase GUI_CONTROL_PIC:\n\t\t\t// Fixed for v1.0.25.11 to prevent SS_ICON from getting changed to SS_BITMAP:\n\t\t\tnew_style = (new_style & ~0x0F) | (current_style & 0x0F); // Done to ensure the lowest four bits are pure.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\t// There doesn't seem to be any flexibility lost by forcing the buttons to be the right type,\n\t\t\t// and doing so improves maintainability and peace-of-mind:\n\t\t\tnew_style = (new_style & ~BS_TYPEMASK) | BS_GROUPBOX; // Force it to be the right type of button.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_BUTTON:\n\t\t\tif (new_style & BS_DEFPUSHBUTTON)\n\t\t\t\tnew_style = (new_style & ~BS_TYPEMASK) | BS_DEFPUSHBUTTON; // Done to ensure the lowest four bits are pure.\n\t\t\telse\n\t\t\t\tnew_style &= ~BS_TYPEMASK; // Force it to be the right type of button --> BS_PUSHBUTTON == 0\n\t\t\t// Fixed for v1.0.33.01:\n\t\t\t// The following must be done here rather than later because it's possible for the\n\t\t\t// button to lack the BS_DEFPUSHBUTTON style even when it is the default button (such as when\n\t\t\t// keyboard focus is on some other button). Consequently, no difference in style might be\n\t\t\t// detected further below, which is why it's done here:\n\t\t\tif (aControlIndex == mDefaultButtonIndex)\n\t\t\t{\n\t\t\t\tif (aOpt.style_remove & BS_DEFPUSHBUTTON)\n\t\t\t\t{\n\t\t\t\t\t// Remove the default button (rarely needed so that's why there is current no\n\t\t\t\t\t// \"Gui, NoDefaultButton\" command:\n\t\t\t\t\tmDefaultButtonIndex = -1;\n\t\t\t\t\t// This will alter the control id received via WM_COMMAND when the user presses ENTER:\n\t\t\t\t\tSendMessage(mHwnd, DM_SETDEFID, (WPARAM)IDOK, 0); // restore to default\n\t\t\t\t\t// Sometimes button visually has the default style even when GetWindowLong() says\n\t\t\t\t\t// it doesn't. Given how rare it is to not have a default button at all after having\n\t\t\t\t\t// one, rather than try to analyze exactly what circumstances this happens in,\n\t\t\t\t\t// unconditionally reset the style and redraw by indicating that current style is\n\t\t\t\t\t// different from the new style:\n\t\t\t\t\tcurrent_style |= BS_DEFPUSHBUTTON;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // This button isn't the default button yet, but is it becoming it?\n\t\t\t{\n\t\t\t\t// Remember that the default button doesn't always have the BS_DEFPUSHBUTTON, namely at\n\t\t\t\t// times when it shouldn't visually appear to be the default, such as when keyboard focus\n\t\t\t\t// is on some other button. Therefore, don't rely on new_style or current_style's\n\t\t\t\t// having or not having BS_DEFPUSHBUTTON as being a correct indicator.\n\t\t\t\tif (aOpt.style_add & BS_DEFPUSHBUTTON)\n\t\t\t\t{\n\t\t\t\t\t// First remove the style from the old default button, if there is one:\n if (mDefaultButtonIndex < mControlCount)\n\t\t\t\t\t\tSendMessage(mControl[mDefaultButtonIndex]->hwnd, BM_SETSTYLE\n\t\t\t\t\t\t\t, (WPARAM)LOWORD((GetWindowLong(mControl[mDefaultButtonIndex]->hwnd, GWL_STYLE) & ~BS_DEFPUSHBUTTON))\n\t\t\t\t\t\t\t, MAKELPARAM(TRUE, 0)); // Redraw = yes. It's probably smart enough not to do it if the window is hidden.\n\t\t\t\t\tmDefaultButtonIndex = aControlIndex;\n\t\t\t\t\t// This will alter the control id received via WM_COMMAND when the user presses ENTER:\n\t\t\t\t\tSendMessage(mHwnd, DM_SETDEFID, (WPARAM)GUI_INDEX_TO_ID(mDefaultButtonIndex), 0);\n\t\t\t\t\t// This button's visual/default appearance will be updated further below, if warranted.\n\t\t\t\t}\n\t\t\t}\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_CHECKBOX:\n\t\t\t// Note: BS_AUTO3STATE and BS_AUTOCHECKBOX are mutually exclusive due to their overlap within\n\t\t\t// the bit field:\n\t\t\tif ((new_style & BS_AUTO3STATE) == BS_AUTO3STATE) // Fixed for v1.0.45.03 to check if all the BS_AUTO3STATE bits are present, not just \"any\" of them. BS_TYPEMASK is not involved here because this is a purity check, and TYPEMASK would defeat the whole purpose.\n\t\t\t\tnew_style = (new_style & ~BS_TYPEMASK) | BS_AUTO3STATE; // Done to ensure the lowest four bits are pure.\n\t\t\telse\n\t\t\t\tnew_style = (new_style & ~BS_TYPEMASK) | BS_AUTOCHECKBOX; // Force it to be the right type of button.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_RADIO:\n\t\t\tnew_style = (new_style & ~BS_TYPEMASK) | BS_AUTORADIOBUTTON; // Force it to be the right type of button.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\t\tnew_style |= CBS_DROPDOWNLIST; // This works because CBS_DROPDOWNLIST == CBS_SIMPLE|CBS_DROPDOWN\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_COMBOBOX:\n\t\t\tif (new_style & CBS_SIMPLE) // i.e. CBS_SIMPLE has been added to the original default, so assume it is SIMPLE.\n\t\t\t\tnew_style = (new_style & ~0x0F) | CBS_SIMPLE; // Done to ensure the lowest four bits are pure.\n\t\t\telse\n\t\t\t\tnew_style = (new_style & ~0x0F) | CBS_DROPDOWN; // Done to ensure the lowest four bits are pure.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_LISTVIEW: // Being in the switch serves to verify control's type because it isn't verified in places where listview_view is set.\n\t\t\tif (aOpt.listview_view != -1) // A new view was explicitly specified.\n\t\t\t{\n\t\t\t\t// Fix for v1.0.36.04:\n\t\t\t\t// For XP, must always use ListView_SetView() because otherwise switching from Tile view back to\n\t\t\t\t// the *same* view that was in effect prior to tile view wouldn't work (since the the control's\n\t\t\t\t// style LVS_TYPEMASK bits would not have changed). This is because LV_VIEW_TILE is a special\n\t\t\t\t// view that cannot be set via style change.\n\t\t\t\tListView_SetView(aControl.hwnd, aOpt.listview_view);\n\t\t\t\t// Regardless of whether SetView was called above, adjust the style too so that the upcoming\n\t\t\t\t// style change won't undo what was just done above:\n\t\t\t\tif (aOpt.listview_view != LV_VIEW_TILE) // It was ensured earlier that listview_view can be set to LV_VIEW_TILE only for XP or later.\n\t\t\t\t\tnew_style = (new_style & ~LVS_TYPEMASK) | aOpt.listview_view;\n\t\t\t}\n\t\t\tbreak;\n\t\t// Nothing extra for these currently:\n\t\t//case GUI_CONTROL_LISTBOX: i.e. allow LBS_NOTIFY to be removed in case anyone really wants to do that.\n\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t//case GUI_CONTROL_EDIT:\n\t\t//case GUI_CONTROL_TEXT: Ensuring SS_BITMAP and such are absent seems too over-protective.\n\t\t//case GUI_CONTROL_LINK:\n\t\t//case GUI_CONTROL_DATETIME:\n\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t//case GUI_CONTROL_HOTKEY:\n\t\t//case GUI_CONTROL_UPDOWN:\n\t\t//case GUI_CONTROL_SLIDER:\n\t\t//case GUI_CONTROL_PROGRESS:\n\t\t//case GUI_CONTROL_TAB: i.e. allow WS_CLIPSIBLINGS to be removed (Rajat needs this) and also TCS_OWNERDRAWFIXED in case anyone really wants to.\n\t\t}\n\n\t\t// This needs to be done prior to applying the updated style since it sometimes adds\n\t\t// more style attributes:\n\t\tif (aOpt.limit) // A char length-limit was specified or de-specified for an edit/combo field.\n\t\t{\n\t\t\t// These styles are applied last so that multiline vs. singleline will already be resolved\n\t\t\t// and known, since all options have now been processed.\n\t\t\tif (aControl.type == GUI_CONTROL_EDIT)\n\t\t\t{\n\t\t\t\t// For the below, note that EM_LIMITTEXT == EM_SETLIMITTEXT.\n\t\t\t\tif (aOpt.limit < 0)\n\t\t\t\t{\n\t\t\t\t\t// Either limit to visible width of field, or remove existing limit.\n\t\t\t\t\t// In both cases, first remove the control's internal limit in case it\n\t\t\t\t\t// was something really small before:\n\t\t\t\t\tSendMessage(aControl.hwnd, EM_LIMITTEXT, 0, 0);\n\t\t\t\t\t// Limit > INT_MIN but less than zero is the signal to limit input length to visible\n\t\t\t\t\t// width of field. But it can only work if the edit isn't a multiline.\n\t\t\t\t\tif (aOpt.limit != INT_MIN && !(new_style & ES_MULTILINE))\n\t\t\t\t\t\tnew_style &= ~(WS_HSCROLL|ES_AUTOHSCROLL); // Enable the limit-to-visible-width style.\n\t\t\t\t}\n\t\t\t\telse // greater than zero, since zero itself it checked in one of the enclosing IFs above.\n\t\t\t\t\tSendMessage(aControl.hwnd, EM_LIMITTEXT, aOpt.limit, 0); // Set a hard limit.\n\t\t\t}\n\t\t\telse if (aControl.type == GUI_CONTROL_HOTKEY)\n\t\t\t{\n\t\t\t\tif (aOpt.limit < 0) // This is the signal to remove any existing limit.\n\t\t\t\t\tSendMessage(aControl.hwnd, HKM_SETRULES, 0, 0);\n\t\t\t\telse // greater than zero, since zero itself it checked in one of the enclosing IFs above.\n\t\t\t\t\tSendMessage(aControl.hwnd, HKM_SETRULES, aOpt.limit, MAKELPARAM(HOTKEYF_CONTROL|HOTKEYF_ALT, 0));\n\t\t\t\t\t// Above must also specify Ctrl+Alt or some other default, otherwise the restriction will have\n\t\t\t\t\t// no effect.\n\t\t\t}\n\t\t\t// Altering the limit after the control exists appears to be ineffective, so this is commented out:\n\t\t\t//else if (aControl.type == GUI_CONTROL_COMBOBOX)\n\t\t\t//\t// It has been verified that that EM_LIMITTEXT has no effect when sent directly\n\t\t\t//\t// to a ComboBox hwnd; however, it might work if sent to its edit-child.\n\t\t\t//\t// For now, a Combobox can only be limited to its visible width. Later, there might\n\t\t\t//\t// be a way to send a message to its child control to limit its width directly.\n\t\t\t//\tif (aOpt.limit == INT_MIN) // remove existing limit\n\t\t\t//\t\tnew_style |= CBS_AUTOHSCROLL;\n\t\t\t//\telse\n\t\t\t//\t\tnew_style &= ~CBS_AUTOHSCROLL;\n\t\t\t//\t// i.e. SetWindowLong() cannot manifest the above style after the window exists.\n\t\t}\n\n\t\tbool style_change_ok;\n\t\tbool style_needed_changing = false; // Set default.\n\n\t\tif (current_style != new_style)\n\t\t{\n\t\t\tstyle_needed_changing = true; // Either style or exstyle is changing.\n\t\t\tstyle_change_ok = false; // Starting assumption.\n\t\t\tswitch (aControl.type)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_BUTTON:\n\t\t\t\t// For some reason, the following must be done *after* removing the visual/default style from\n\t\t\t\t// the old default button and/or after doing DM_SETDEFID above.\n\t\t\t\t// BM_SETSTYLE is much more likely to have an effect for buttons than SetWindowLong().\n\t\t\t\t// Redraw = yes, though it seems to be ineffective sometimes. It's probably smart enough not to do\n\t\t\t\t// it if the window is hidden.\n\t\t\t\t// Fixed for v1.0.33.01: The HWND should be aControl.hwnd not mControl[mDefaultButtonIndex].hwnd\n\t\t\t\tSendMessage(aControl.hwnd, BM_SETSTYLE, (WPARAM)LOWORD(new_style), MAKELPARAM(TRUE, 0));\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\t\tif ((new_style & WS_HSCROLL) && !(current_style & WS_HSCROLL)) // Scroll bar being added.\n\t\t\t\t{\n\t\t\t\t\tif (aOpt.hscroll_pixels < 0) // Calculate a default based on control's width.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Since horizontal scrollbar is relatively rarely used, no fancy method\n\t\t\t\t\t\t// such as calculating scrolling-width via LB_GETTEXTLEN and current font's\n\t\t\t\t\t\t// average width is used.\n\t\t\t\t\t\tGetWindowRect(aControl.hwnd, &rect);\n\t\t\t\t\t\taOpt.hscroll_pixels = 3 * (rect.right - rect.left);\n\t\t\t\t\t}\n\t\t\t\t\t// If hscroll_pixels is now zero or smaller than the width of the control,\n\t\t\t\t\t// the scrollbar will not be shown:\n\t\t\t\t\tSendMessage(aControl.hwnd, LB_SETHORIZONTALEXTENT, (WPARAM)aOpt.hscroll_pixels, 0);\n\t\t\t\t}\n\t\t\t\telse if (!(new_style & WS_HSCROLL) && (current_style & WS_HSCROLL)) // Scroll bar being removed.\n\t\t\t\t\tSendMessage(aControl.hwnd, LB_SETHORIZONTALEXTENT, 0, 0);\n\t\t\t\tbreak;\n\t\t\tcase GUI_CONTROL_PROGRESS:\n\t\t\t\t// SetWindowLong with GWL_STYLE appears to reset the position,\n\t\t\t\t// so save the current position here to be restored later:\n\t\t\t\tcurrent_value_uint = (UINT)SendMessage(aControl.hwnd, PBM_GETPOS, 0, 0);\n\t\t\t\tbreak;\n\t\t\t} // switch()\n\t\t\tSetLastError(0); // Prior to SetWindowLong(), as recommended by MSDN.\n\t\t\t// Call this even for buttons because BM_SETSTYLE only handles the LOWORD part of the style:\n\t\t\tif (SetWindowLong(aControl.hwnd, GWL_STYLE, new_style) || !GetLastError()) // This is the precise way to detect success according to MSDN.\n\t\t\t{\n\t\t\t\t// Even if it indicated success, sometimes it failed anyway. Find out for sure:\n\t\t\t\tif (GetWindowLong(aControl.hwnd, GWL_STYLE) != current_style)\n\t\t\t\t\tstyle_change_ok = true; // Even a partial change counts as a success.\n\t\t\t}\n\t\t}\n\n\t\tDWORD current_exstyle = GetWindowLong(aControl.hwnd, GWL_EXSTYLE);\n\t\tDWORD new_exstyle = (current_exstyle | aOpt.exstyle_add) & ~aOpt.exstyle_remove;\n\t\tif (current_exstyle != new_exstyle)\n\t\t{\n\t\t\tif (!style_needed_changing)\n\t\t\t{\n\t\t\t\tstyle_needed_changing = true; // Either style or exstyle is changing.\n\t\t\t\tstyle_change_ok = false; // Starting assumption.\n\t\t\t}\n\t\t\t//ELSE don't change the value of style_change_ok because we want it to retain the value set by\n\t\t\t// the GWL_STYLE change above; i.e. a partial success on either style or exstyle counts as a full\n\t\t\t// success.\n\t\t\tSetLastError(0); // Prior to SetWindowLong(), as recommended by MSDN.\n\t\t\tif (SetWindowLong(aControl.hwnd, GWL_EXSTYLE, new_exstyle) || !GetLastError()) // This is the precise way to detect success according to MSDN.\n\t\t\t{\n\t\t\t\t// Even if it indicated success, sometimes it failed anyway. Find out for sure:\n\t\t\t\tif (GetWindowLong(aControl.hwnd, GWL_EXSTYLE) != current_exstyle)\n\t\t\t\t\tstyle_change_ok = true; // Even a partial change counts as a success.\n\t\t\t}\n\t\t}\n\n\t\tif (aControl.type == GUI_CONTROL_LISTVIEW)\n\t\t{\n\t\t\t// These ListView \"extended styles\" exist entirely separate from normal extended styles.\n\t\t\t// In other words, a ListView may have three types of styles: Normal, Extended, and its\n\t\t\t// own set of LV Extended styles.\n\t\t\tDWORD current_lv_style = ListView_GetExtendedListViewStyle(aControl.hwnd);\n\t\t\tif (current_lv_style != aOpt.listview_style)\n\t\t\t{\n\t\t\t\tif (!style_needed_changing)\n\t\t\t\t{\n\t\t\t\t\tstyle_needed_changing = true; // Either style, exstyle, or lv_exstyle is changing.\n\t\t\t\t\tstyle_change_ok = false; // Starting assumption.\n\t\t\t\t}\n\t\t\t\t//ELSE don't change the value of style_change_ok because we want it to retain the value set by\n\t\t\t\t// the GWL_STYLE or EXSTYLE change above; i.e. a partial success on either style or exstyle\n\t\t\t\t// counts as a full success.\n\t\t\t\tListView_SetExtendedListViewStyle(aControl.hwnd, aOpt.listview_style); // Has no return value.\n\t\t\t\tif (ListView_GetExtendedListViewStyle(aControl.hwnd) != current_lv_style)\n\t\t\t\t\tstyle_change_ok = true; // Even a partial change counts as a success.\n\t\t\t}\n\t\t}\n\n \t\t// Redrawing the controls is required in some cases, such as a checkbox losing its 3-state\n\t\t// style while it has a gray checkmark in it (which incidentally in this case only changes\n\t\t// the appearance of the control, not the internal stored value in this case).\n\t\tif (style_needed_changing && style_change_ok)\n\t\t\tdo_invalidate_rect = true;\n\n\t\t// Do the below only after applying the styles above since part of it requires that the style be\n\t\t// updated and applied above.\n\t\tswitch (aControl.type)\n\t\t{\n\t\tcase GUI_CONTROL_UPDOWN:\n\t\t\tControlSetUpDownOptions(aControl, aOpt);\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_SLIDER:\n\t\t\tControlSetSliderOptions(aControl, aOpt);\n\t\t\tif (aOpt.style_remove & TBS_TOOLTIPS)\n\t\t\t\tSendMessage(aControl.hwnd, TBM_SETTOOLTIPS, NULL, 0); // i.e. removing the TBS_TOOLTIPS style is not enough.\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_LISTVIEW:\n\t\t\tControlSetListViewOptions(aControl, aOpt);\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_TREEVIEW:\n\t\t\tControlSetTreeViewOptions(aControl, aOpt);\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_PROGRESS:\n\t\t\tControlSetProgressOptions(aControl, aOpt, new_style);\n\t\t\t// Above strips theme if required by new options. It also applies new colors.\n\t\t\tif (current_style != new_style)\n\t\t\t\t// SetWindowLong with GWL_STYLE resets the position, so restore it here.\n\t\t\t\tSendMessage(aControl.hwnd, PBM_SETPOS, current_value_uint, 0);\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_EDIT:\n\t\t\tif (aOpt.tabstop_count)\n\t\t\t{\n\t\t\t\tSendMessage(aControl.hwnd, EM_SETTABSTOPS, aOpt.tabstop_count, (LPARAM)aOpt.tabstop);\n\t\t\t\t// MSDN: \"If the application is changing the tab stops for text already in the edit control,\n\t\t\t\t// it should call the InvalidateRect function to redraw the edit control window.\"\n\t\t\t\tdo_invalidate_rect = true; // Override the default.\n\t\t\t}\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\tif (aOpt.tabstop_count)\n\t\t\t{\n\t\t\t\tSendMessage(aControl.hwnd, LB_SETTABSTOPS, aOpt.tabstop_count, (LPARAM)aOpt.tabstop);\n\t\t\t\tdo_invalidate_rect = true; // This is done for the same reason that EDIT (above) does it.\n\t\t\t}\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_STATUSBAR:\n\t\t\tif (aOpt.color_bk != CLR_INVALID) // Explicit color change was requested.\n\t\t\t\tSendMessage(aControl.hwnd, SB_SETBKCOLOR, 0, aOpt.color_bk);\n\t\t\tbreak;\n\t\t}\n\n\t\tif (aOpt.color != CLR_INVALID) // Explicit color change was requested.\n\t\t{\n\t\t\t// ListView and TreeView controls were already handled above, but are also supported here.\n\t\t\tControlSetTextColor(aControl, aOpt.color);\n\t\t\tdo_invalidate_rect = true;\n\t\t}\n\n\t\tif (aOpt.redraw)\n\t\t{\n\t\t\tSendMessage(aControl.hwnd, WM_SETREDRAW, aOpt.redraw == CONDITION_TRUE, 0);\n\t\t\tif (aOpt.redraw == CONDITION_TRUE // Since redrawing is being turned back on, invalidate the control so that it updates itself.\n\t\t\t\t&& aControl.type != GUI_CONTROL_TREEVIEW) // This type is documented not to need it; others like ListView are not, so might need it on some OSes or under some conditions.\n\t\t\t\tdo_invalidate_rect = true;\n\t\t}\n\n\t\tif (do_invalidate_rect)\n\t\t\tInvalidateRect(aControl.hwnd, NULL, TRUE); // Assume there's text in the control.\n\n\t\tif (style_needed_changing && !style_change_ok)\n\t\t\treturn g_script.ThrowRuntimeException(ERR_FAILED);\n\t} // aControl.hwnd is not NULL\n\n\treturn OK;\n}\n\n\n\nvoid GuiType::ControlInitOptions(GuiControlOptionsType &aOpt, GuiControlType &aControl)\n// Not done as class to avoid code-size overhead of initializer list, etc.\n{\n\tZeroMemory(&aOpt, sizeof(GuiControlOptionsType));\n\tif (aControl.type == GUI_CONTROL_LISTVIEW) // Since this doesn't have the _add and _remove components, must initialize.\n\t{\n\t\tif (aControl.hwnd)\n\t\t\taOpt.listview_style = ListView_GetExtendedListViewStyle(aControl.hwnd); // Will have no effect on 95/NT4 that lack comctl32.dll 4.70+ distributed with MSIE 3.x\n\t\taOpt.listview_view = -1; // Indicate \"unspecified\" so that changes can be detected.\n\t}\n\taOpt.x = aOpt.y = aOpt.width = aOpt.height = COORD_UNSPECIFIED;\n\taOpt.color = CLR_INVALID;\n\taOpt.color_bk = CLR_INVALID;\n\t// Above: If it stays unaltered, CLR_INVALID means \"leave color as it is\". This is for\n\t// use with \"GuiControl, +option\" so that ControlSetProgressOptions() and others know that\n\t// the \"+/-Background\" item was not among the options in the list. The reason this is needed\n\t// for background color but not bar color is that bar_color is stored as a control attribute,\n\t// but to save memory, background color is not. In addition, there is no good way to ask a\n\t// progress control what its background color currently is.\n}\n\n\n\nvoid GuiType::ControlAddItems(GuiControlType &aControl, Array *aObj)\n{\n\tif (!aObj)\n\t\treturn;\n\n\tUINT msg_add;\n\tint requested_index = 0;\n\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_TAB: // These cases must be listed anyway to do a break vs. return, so might as well init conditionally rather than unconditionally.\n\t\trequested_index = TabCtrl_GetItemCount(aControl.hwnd); // So that tabs are \"appended at the end of the control's list\", as documented for GuiControl.\n\t\t// Fall through:\n\tcase GUI_CONTROL_LISTVIEW:\n\t\tmsg_add = 0;\n\t\tbreak;\n\tcase GUI_CONTROL_DROPDOWNLIST:\n\tcase GUI_CONTROL_COMBOBOX:\n\t\tmsg_add = CB_ADDSTRING;\n\t\tbreak;\n\tcase GUI_CONTROL_LISTBOX:\n\t\tmsg_add = LB_ADDSTRING;\n\t\tbreak;\n\tdefault: // Do nothing for any other control type that somehow makes its way here.\n\t\treturn;\n\t}\n\n\tLRESULT item_index;\n\tTCHAR num_buf[MAX_NUMBER_SIZE];\n\tArray::index_t obj_index;\n\tExprTokenType tok;\n\n\t// For tab controls:\n\tTCITEM tci;\n\ttci.mask = TCIF_TEXT | TCIF_IMAGE; // Simpler just to init unconditionally rather than checking control type.\n\ttci.iImage = -1;\n\n\t// For ListView:\n\tLVCOLUMN lvc;\n\tlvc.mask = LVCF_TEXT; // Simpler just to init unconditionally rather than checking control type.\n\n\t// Check *this_field at the top too, in case list ends in delimiter.\n\tfor (obj_index = 0; aObj->ItemToToken(obj_index, tok); ++obj_index)\n\t{\n\t\tLPTSTR this_field = TokenToString(tok, num_buf);\n\n\t\t// Add the item:\n\t\tswitch (aControl.type)\n\t\t{\n\t\tcase GUI_CONTROL_TAB:\n\t\t\tif (requested_index > MAX_TABS_PER_CONTROL - 1) // Unlikely, but indicate failure if so.\n\t\t\t\titem_index = -1;\n\t\t\telse\n\t\t\t{\n\t\t\t\ttci.pszText = this_field;\n\t\t\t\titem_index = TabCtrl_InsertItem(aControl.hwnd, requested_index, &tci);\n\t\t\t\tif (item_index != -1) // item_index is used later below as an indicator of success.\n\t\t\t\t\t++requested_index;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase GUI_CONTROL_LISTVIEW:\n\t\t\tlvc.pszText = this_field;\n\t\t\titem_index = ListView_InsertColumn(aControl.hwnd, requested_index, &lvc);\n\t\t\tif (item_index != -1) // item_index is used later below as an indicator of success.\n\t\t\t\t++requested_index;\n\t\t\tbreak;\n\t\tdefault:\n\t\t\titem_index = SendMessage(aControl.hwnd, msg_add, 0, (LPARAM)this_field); // In this case, ignore any errors, namely CB_ERR/LB_ERR and CB_ERRSPACE).\n\t\t\t// For the above, item_index must be retrieved and used as the item's index because it might\n\t\t\t// be different than expected if the control's SORT style is in effect.\n\t\t}\n\t} // for()\n\n\tif (aControl.type == GUI_CONTROL_LISTVIEW)\n\t{\n\t\t// Fix for v1.0.36.03: requested_index is already one beyond the number of columns that were added\n\t\t// because it's always set up for the next column that would be added if there were any.\n\t\t// Therefore, there is no need to add one to it to get the column count.\n\t\taControl.union_lv_attrib->col_count = requested_index; // Keep track of column count, mostly so that LV_ModifyCol and such can properly maintain the array of columns).\n\t\t// It seems a useful default to do a basic auto-size upon creation, even though it won't take into\n\t\t// account contents of the rows or the later presence of a vertical scroll bar. The last column\n\t\t// will be overlapped when/if a v-scrollbar appears, which would produce an h-scrollbar too.\n\t\t// It seems best to retain this behavior rather than trying to shrink the last column to allow\n\t\t// room for a scroll bar because: 1) Having it use all available width is desirable at least\n\t\t// some of the time (such as times when there will be only a few rows; 2) It simplifies the code.\n\t\t// This method of auto-sizing each column to fit its text works much better than setting\n\t\t// lvc.cx to ListView_GetStringWidth upon creation of the column.\n\t\tif (ListView_GetView(aControl.hwnd) == LV_VIEW_DETAILS)\n\t\t\tfor (int i = 0; i < requested_index; ++i) // Auto-size each column.\n\t\t\t\tListView_SetColumnWidth(aControl.hwnd, i, LVSCW_AUTOSIZE_USEHEADER);\n\t}\n}\n\n\n\nvoid GuiType::ControlSetChoice(GuiControlType &aControl, int aChoice)\n{\n\t--aChoice; // Convert one-based to zero-based.\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_TAB:\n\t\t// MSDN: \"A tab control does not send a TCN_SELCHANGING or TCN_SELCHANGE notification message\n\t\t// when a tab is selected using the TCM_SETCURSEL message.\"\n\t\tTabCtrl_SetCurSel(aControl.hwnd, aChoice);\n\t\tbreak;\n\tcase GUI_CONTROL_DROPDOWNLIST:\n\tcase GUI_CONTROL_COMBOBOX:\n\t\tSendMessage(aControl.hwnd, CB_SETCURSEL, (WPARAM)aChoice, 0);\n\t\tbreak;\n\tcase GUI_CONTROL_LISTBOX:\n\t\t// Multi-select box requires a different message to have a cumulative effect:\n\t\tif (GetWindowLong(aControl.hwnd, GWL_STYLE) & (LBS_EXTENDEDSEL|LBS_MULTIPLESEL))\n\t\t\tSendMessage(aControl.hwnd, LB_SETSEL, (WPARAM)TRUE, (LPARAM)aChoice);\n\t\telse\n\t\t\tSendMessage(aControl.hwnd, LB_SETCURSEL, (WPARAM)aChoice, 0);\n\t\tbreak;\n\t}\n}\n\n\n\nResultType GuiType::ControlLoadPicture(GuiControlType &aControl, LPCTSTR aFilename, int aWidth, int aHeight, int aIconNumber)\n{\n\t// LoadPicture() uses CopyImage() to scale the image, which seems to provide better scaling\n\t// quality than using MoveWindow() (followed by redrawing the parent window) on the static\n\t// control that contains the image.\n\tint image_type;\n\tHBITMAP new_image = LoadPicture(aFilename, aWidth, aHeight, image_type, aIconNumber\n\t\t, aControl.attrib & GUI_CONTROL_ATTRIB_ALTSUBMIT);\n\tif (!new_image && *aFilename)\n\t\treturn FAIL; // Caller will report the error.\n\n\t// In light of the below, it seems best to delete the bitmaps whenever the control changes\n\t// to a new image or whenever the control is destroyed. Otherwise, if a control or its\n\t// parent window is destroyed and recreated many times, memory allocation would continue\n\t// to grow from all of the abandoned bitmaps/icons.\n\t// MSDN: \"When you are finished using a bitmap...loaded without specifying the LR_SHARED flag,\n\t// you can release its associated memory by calling...DeleteObject.\"\n\t// MSDN: \"The system automatically deletes these resources when the process that created them\n\t// terminates, however, calling the appropriate function saves memory and decreases the size\n\t// of the process's working set.\"\n\t// v1.0.40.12: For maintainability, destroy the handle returned by STM_SETIMAGE, even though it\n\t// should be identical to control.union_hbitmap (due to a call to STM_GETIMAGE in another section).\n\t// UPDATE: This is now done after LoadPicture() is called to reduce the length of time between\n\t// the background being erased and the new picture being drawn, which might decrease flicker.\n\t// It's still done as a separate step to setting the new bitmap due to uncertainty about how\n\t// the control handles changing the image type, and the notes below about animation.\n\tif (aControl.union_hbitmap)\n\t\tif (aControl.attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR) // union_hbitmap is an icon or cursor.\n\t\t\t// The control's image is set to NULL for the following reasons:\n\t\t\t// 1) It turns off the control's animation timer in case the new image is not animated.\n\t\t\t// 2) It feels a little bit safer to destroy the image only after it has been removed\n\t\t\t// from the control.\n\t\t\t// NOTE: IMAGE_ICON or IMAGE_CURSOR must be passed, not IMAGE_BITMAP. Otherwise the\n\t\t\t// animated property of the control (via a timer that the control created) will remain\n\t\t\t// in effect for the next image, even if it isn't animated, which results in a\n\t\t\t// flashing/redrawing effect:\n\t\t\tDestroyIcon((HICON)SendMessage(aControl.hwnd, STM_SETIMAGE, IMAGE_CURSOR, NULL));\n\t\t\t// DestroyIcon() works on cursors too. See notes in LoadPicture().\n\t\telse // union_hbitmap is a bitmap\n\t\t\tDeleteObject((HGDIOBJ)SendMessage(aControl.hwnd, STM_SETIMAGE, IMAGE_BITMAP, NULL));\n\taControl.union_hbitmap = new_image;\n\tif (!new_image)\n\t{\n\t\t// By design, no error is reported for a blank aFilename.\n\t\t// For simplicity, any existing SS_BITMAP/SS_ICON style bit is not removed.\n\t\treturn OK;\n\t}\n\tif (image_type == IMAGE_ICON && aControl.background_color == CLR_TRANSPARENT)\n\t{\n\t\t// Static controls don't appear to support background transparency with icons,\n\t\t// so convert the icon to a bitmap.\n\t\tif (HBITMAP hbitmap = IconToBitmap32((HICON)aControl.union_hbitmap, false))\n\t\t{\n\t\t\tDestroyIcon((HICON)aControl.union_hbitmap);\n\t\t\taControl.union_hbitmap = hbitmap;\n\t\t\timage_type = IMAGE_BITMAP;\n\t\t}\n\t}\n\t// For image to display correctly, must apply SS_ICON for cursors/icons and SS_BITMAP for bitmaps.\n\t// This style change is made *after* the control is created so that the act of creation doesn't\n\t// attempt to load the image from a resource (which as documented by SS_ICON/SS_BITMAP, would happen\n\t// since text is interpreted as the name of a bitmap in the resource file).\n\tDWORD style = GetWindowLong(aControl.hwnd, GWL_STYLE);\n\tDWORD style_image_type = style & 0x0F;\n\tstyle &= ~0x0F; // Purge the low-order four bits in case style-image-type needs to be altered below.\n\tif (image_type == IMAGE_BITMAP)\n\t{\n\t\tif (style_image_type != SS_BITMAP)\n\t\t\tSetWindowLong(aControl.hwnd, GWL_STYLE, style | SS_BITMAP);\n\t}\n\telse // Icon or Cursor.\n\t\tif (style_image_type != SS_ICON) // Must apply SS_ICON or such handles cannot be displayed.\n\t\t\tSetWindowLong(aControl.hwnd, GWL_STYLE, style | SS_ICON);\n\t// Above uses ~0x0F to ensure the lowest four/five bits are pure.\n\t// Also note that it does not seem correct to use SS_TYPEMASK if bitmaps/icons can also have\n\t// any of the following styles. MSDN confirms(?) this by saying that SS_TYPEMASK is out of date\n\t// and should not be used:\n\t//#define SS_ETCHEDHORZ 0x00000010L\n\t//#define SS_ETCHEDVERT 0x00000011L\n\t//#define SS_ETCHEDFRAME 0x00000012L\n\tSendMessage(aControl.hwnd, STM_SETIMAGE, (WPARAM)image_type, (LPARAM)aControl.union_hbitmap);\n\t// Fix for 1.0.40.12: The below was added because STM_SETIMAGE above may have caused the control to\n\t// create a new hbitmap (possibly only for alpha channel bitmaps on XP, but might also apply to icons),\n\t// in which case we now have two handles: the one inside the control and the one from which\n\t// it was copied. Task Manager confirms that the control does not delete the original\n\t// handle when it creates a new handle. Rather than waiting until later to delete the handle,\n\t// it seems best to do it here so that:\n\t// 1) The script uses less memory during the time that the picture control exists.\n\t// 2) Don't have to delete two handles (control.union_hbitmap and the one returned by STM_SETIMAGE)\n\t// when the time comes to change the image inside the control.\n\t//\n\t// MSDN: \"With Microsoft Windows XP, if the bitmap passed in the STM_SETIMAGE message contains pixels\n\t// with non-zero alpha, the static control takes a copy of the bitmap. This copied bitmap is returned\n\t// by the next STM_SETIMAGE message... if it does not check and release the bitmaps returned from\n\t// STM_SETIMAGE messages, the bitmaps are leaked.\"\n\tHBITMAP hbitmap_actual;\n\tif ((hbitmap_actual = (HBITMAP)SendMessage(aControl.hwnd, STM_GETIMAGE, image_type, 0)) // Assign\n\t\t&& hbitmap_actual != aControl.union_hbitmap) // The control decided to make a new handle.\n\t{\n\t\tif (image_type == IMAGE_BITMAP)\n\t\t\tDeleteObject(aControl.union_hbitmap);\n\t\telse // Icon or cursor.\n\t\t\tDestroyIcon((HICON)aControl.union_hbitmap); // Works on cursors too.\n\t\t// In additional to improving maintainability, the following might also be necessary to allow\n\t\t// Gui::Destroy() to avoid a memory leak when the picture control is destroyed as a result\n\t\t// of its parent being destroyed (though I've read that the control is supposed to destroy its\n\t\t// hbitmap when it was directly responsible for creating it originally [but not otherwise]):\n\t\taControl.union_hbitmap = hbitmap_actual;\n\t}\n\tif (image_type == IMAGE_BITMAP)\n\t\taControl.attrib &= ~GUI_CONTROL_ATTRIB_ALTBEHAVIOR; // Flag it as a bitmap so that DeleteObject vs. DestroyIcon will be called for it.\n\telse // Cursor or Icon, which are functionally identical for our purposes.\n\t\taControl.attrib |= GUI_CONTROL_ATTRIB_ALTBEHAVIOR;\n\treturn OK;\n}\n\n\n\nFResult GuiType::Show(optl<StrArg> aOptions)\n{\n\tGUI_MUST_HAVE_HWND;\n\n\t// In the future, it seems best to rely on mShowIsInProgress to prevent the Window Proc from ever\n\t// doing a MsgSleep() to launch a script subroutine. This is because if anything we do in this\n\t// function results in a launch of the Window Proc (such as MoveWindow and ShowWindow), our\n\t// activity here might be interrupted in a destructive way. For example, if a script subroutine\n\t// is launched while we're in the middle of something here, our activity is suspended until\n\t// the subroutine completes and the call stack collapses back to here. But if that subroutine\n\t// recursively calls us while the prior call is still in progress, the mShowIsInProgress would\n\t// be set to false when that layer completes, leaving it false when it really should be true\n\t// because our layer isn't done yet.\n\tmShowIsInProgress = true; // Signal WM_SIZE to queue the GuiSize launch. We'll unqueue via MsgSleep() when we're done.\n\n\t// Set defaults, to be overridden by the presence of zero or more options:\n\tint x = COORD_UNSPECIFIED;\n\tint y = COORD_UNSPECIFIED;\n\tint width = COORD_UNSPECIFIED;\n\tint height = COORD_UNSPECIFIED;\n\tbool auto_size = false;\n\n\tBOOL is_maximized = IsZoomed(mHwnd); // Safer to assume it's possible for both to be true simultaneously in\n\tBOOL is_minimized = IsIconic(mHwnd); // future/past OSes.\n\tint show_mode;\n\t// There is evidence that SW_SHOWNORMAL might be better than SW_SHOW for the first showing because\n\t// someone reported that a window appears centered on the screen for its first showing even if some\n\t// other position was specified. In addition, MSDN says (without explanation): \"An application should\n\t// specify [SW_SHOWNORMAL] when displaying the window for the first time.\" However, SW_SHOWNORMAL is\n\t// avoided after the first showing of the window because that would probably also do a \"restore\" on the\n\t// window if it was maximized previously. Note that the description of SW_SHOWNORMAL is virtually the\n\t// same as that of SW_RESTORE in MSDN. UPDATE: mGuiShowHasNeverBeenDone is used here instead of mFirstActivation\n\t// because it seems more flexible to have \"Gui Show\" behave consistently (SW_SHOW) every time after\n\t// the first use of \"Gui Show\". UPDATE: Since SW_SHOW seems to have no effect on minimized windows,\n\t// at least on XP, and since such a minimized window will be restored by action of SetForegroundWindowEx(),\n\t// it seems best to unconditionally use SW_SHOWNORMAL, rather than \"mGuiShowHasNeverBeenDone ? SW_SHOWNORMAL : SW_SHOW\".\n\t// This is done so that the window will be restored and thus have a better chance of being successfully\n\t// activated (and thus not requiring the call to SetForegroundWindowEx()).\n\t// v1.0.44.08: Fixed to default to SW_SHOW for currently-maximized windows so that they don't get unmaximized\n\t// by \"Gui Show\" (unless other options require it). Also, it's been observed that SW_SHOWNORMAL differs from\n\t// SW_RESTORE in at least one way: When the target is a minimized window, SW_SHOWNORMAL will both restore it\n\t// and unmaximize it. But SW_RESTORE unminimizes the window in a way that retains its maximized state (if\n\t// it was previously maximized). Therefore, SW_RESTORE is now the default if the window is currently minimized.\n\tif (is_minimized)\n\t\tshow_mode = SW_RESTORE; // See above comments. For backward compatibility, window is unminimized even if it was previously hidden (rather than simply showing its taskbar button and keeping it minimized).\n\telse if (is_maximized)\n\t\tshow_mode = SW_SHOW; // See above.\n\telse\n\t\tshow_mode = SW_SHOWNORMAL;\n\n\tfor (auto cp_end = aOptions.value_or_empty(), cp = cp_end; *cp; cp = cp_end)\n\t{\n\t\tswitch(ctoupper(*cp))\n\t\t{\n\t\t// For options such as W, H, X and Y: Use _ttoi() vs. ATOI() to avoid interpreting something like 0x01B\n\t\t// as hex when in fact the B was meant to be an option letter.\n\t\tcase ' ':\n\t\tcase '\\t':\n\t\t\t++cp_end;\n\t\t\tbreak;\n\t\tcase 'A':\n\t\t\tif (!_tcsnicmp(cp, _T(\"AutoSize\"), 8))\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 8;\n\t\t\t\tauto_size = true;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'C':\n\t\t\tif (!_tcsnicmp(cp, _T(\"Center\"), 6))\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 6;\n\t\t\t\tx = COORD_CENTERED;\n\t\t\t\ty = COORD_CENTERED;\n\t\t\t\t// If the window is currently maximized, show_mode isn't set to SW_RESTORE unconditionally here\n\t\t\t\t// due to obscurity and because it might reduce flexibility. If the window is currently minimized,\n\t\t\t\t// above has already set the default show_mode to SW_RESTORE to ensure correct operation of\n\t\t\t\t// something like \"Gui, Show, Center\".\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'M':\n\t\t\tif (!_tcsnicmp(cp, _T(\"Minimize\"), 8)) // Seems best to reserve \"Min\" for other things, such as Min W/H. \"Minimize\" is also more self-documenting.\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 8;\n\t\t\t\tshow_mode = SW_MINIMIZE; // Seems more typically useful/desirable than SW_SHOWMINIMIZED.\n\t\t\t}\n\t\t\telse if (!_tcsnicmp(cp, _T(\"Maximize\"), 8))\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 8;\n\t\t\t\tshow_mode = SW_MAXIMIZE; // SW_MAXIMIZE == SW_SHOWMAXIMIZED\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'N':\n\t\t\tif (!_tcsnicmp(cp, _T(\"NA\"), 2))\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 2;\n\t\t\t\tshow_mode = SW_SHOWNA;\n\t\t\t}\n\t\t\telse if (!_tcsnicmp(cp, _T(\"NoActivate\"), 10))\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 10;\n\t\t\t\tshow_mode = SW_SHOWNOACTIVATE;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'R':\n\t\t\tif (!_tcsnicmp(cp, _T(\"Restore\"), 7))\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 7;\n\t\t\t\tshow_mode = SW_RESTORE;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'X':\n\t\tcase 'Y':\n\t\t\tif (!_tcsnicmp(cp + 1, _T(\"Center\"), 6))\n\t\t\t{\n\t\t\t\tif (ctoupper(*cp) == 'X')\n\t\t\t\t\tx = COORD_CENTERED;\n\t\t\t\telse\n\t\t\t\t\ty = COORD_CENTERED;\n\t\t\t\tcp_end += 7; // 7 in this case since we're working with cp + 1\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// OTHERWISE, FALL THROUGH:\n\t\tcase 'W':\n\t\tcase 'H':\n\t\t\tif (!_tcsnicmp(cp, _T(\"Hide\"), 4))\n\t\t\t{\n\t\t\t\t// Skip over the text of the name so that it isn't interpreted as option letters.\n\t\t\t\tcp_end += 4;\n\t\t\t\tshow_mode = SW_HIDE;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t// Use _tcstod vs _tcstol to support common cases like % \"w\" A_ScreenWidth/4 even\n\t\t\t// when the current float format is something unusual. Something like \"w400.5\"\n\t\t\t// could be considered invalid, but is allowed for simplicity and convenience.\n\t\t\tint n = (int)_tcstod(cp + 1, const_cast<LPTSTR*>(&cp_end));\n\t\t\tif (cp_end == cp + 1) // No number.\n\t\t\t{\n\t\t\t\tcp_end = cp; // Flag it as invalid.\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tswitch (ctoupper(*cp))\n\t\t\t{\n\t\t\tcase 'X': x = n; break;\n\t\t\tcase 'Y': y = n; break;\n\t\t\t// Allow any width/height to be specified so that the window can be \"rolled up\" to its title bar:\n\t\t\tcase 'W': width = Scale(n); break;\n\t\t\tcase 'H': height = Scale(n); break;\n\t\t\t}\n\t\t\tbreak;\n\t\t} // switch()\n\t\tif (cp_end == cp)\n\t\t{\n\t\t\tif (!ValueError(ERR_INVALID_OPTION, cp, FAIL_OR_OK))\n\t\t\t\treturn FAIL;\n\t\t\t// Otherwise, user wants to continue. Ignore any invalid characters up to the next valid one.\n\t\t\tif (!(cp_end = StrChrAny(cp_end, _T(\"ACMNRXYWH\"))))\n\t\t\t\tbreak;\n\t\t}\n\t} // for()\n\n\tint width_orig = width;\n\tint height_orig = height;\n\n\t// The following section must be done prior to any calls to GetWindow/ClientRect(mHwnd) because\n\t// neither of them can retrieve the correct dimensions of a minimized window. Similarly, if\n\t// the window is maximized but is about to be restored, do that prior to getting any of mHwnd's\n\t// rectangles because we want to use the restored size as the basis for centering, resizing, etc.\n\t// If show_mode is \"hide\", move the window only after hiding it (to reduce screen flicker).\n\t// If the window is being restored from a minimized or maximized state, move the window only\n\t// after restoring it; otherwise, any resize to be done by the MoveWindow() might not take effect.\n\t// Note that SW_SHOWNOACTIVATE is very similar to SW_RESTORE in its effects.\n\tbool show_was_done = false;\n\tif (show_mode == SW_HIDE // Hiding a window or restoring a window known to be minimized/maximized.\n\t\t|| (show_mode == SW_RESTORE || show_mode == SW_SHOWNOACTIVATE) && (is_maximized || is_minimized)) // v1.0.44.08: Fixed missing \"show_mode ==\".\n\t{\n\t\tShowWindow(mHwnd, show_mode);\n\t\tshow_was_done = true;\n\t}\n\t// Note that SW_RESTORE and SW_SHOWNOACTIVATE will show a window if it's hidden. Therefore, just\n\t// because the window is not in need of restoring doesn't mean the ShowWindow() call is skipped.\n\t// That is why show_was_done is left false in such cases.\n\n\tif (mGuiShowHasNeverBeenDone)\n\t{\n\t\t// Ensure all Tab3 controls have been sized prior to autosizing or showing the GUI.\n\t\t// This has been confirmed to work even if IsIconic(), although that would require\n\t\t// calling WinMinimize or option +0x20000000, since SW_MINIMIZE hasn't been applied.\n\t\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t\t{\n\t\t\tif (mControl[u]->type == GUI_CONTROL_TAB)\n\t\t\t\tAutoSizeTabControl(*mControl[u]);\n\t\t}\n\t\t// For the rare case that Show is called before any controls are added or MarginX/Y\n\t\t// is queried, the following ensures mMarginx and mMarginY have usable values:\n\t\tSetDefaultMargins();\n\t}\n\n\t// Due to the checking above, if the window is minimized/maximized now, that means it will still be\n\t// minimized/maximized when this function is done. As a result, it's not really valid to call\n\t// MoveWindow() for any purpose (auto-centering, auto-sizing, new position, new size, etc.).\n\t// The below is especially necessary for minimized windows because it avoid calculating window\n\t// dimensions, auto-centering, etc. based on incorrect values returned by GetWindow/ClientRect(mHwnd).\n\t// Update: For flexibility, it seems best to allow a maximized window to be moved, which might be\n\t// valid on a multi-monitor system. This maintains flexibility and doesn't appear to give up\n\t// anything because the script can do an explicit \"Gui, Show, Restore\" prior to a\n\t// \"Gui, Show, x33 y44 w400\" to be sure the window is restored before the operation (or combine\n\t// both of those commands into one).\n\tbool allow_move_window;\n\tRECT rect;\n\n\tif (allow_move_window = !IsIconic(mHwnd)) // Call IsIconic() again in case above changed the window's state.\n\t{\n\t\tif (auto_size) // Check this one first so that it takes precedence over mGuiShowHasNeverBeenDone below.\n\t\t{\n\t\t\t// Find out a different set of max extents rather than using mMaxExtentRight/Down, which should\n\t\t\t// not be altered because they are used to position any subsequently added controls.\n\t\t\twidth = 0;\n\t\t\theight = 0;\n\t\t\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t\t\t{\n\t\t\t\tGuiControlType &control = *mControl[u];\n\t\t\t\tif (control.type != GUI_CONTROL_STATUSBAR // Status bar is compensated for in a diff. way.\n\t\t\t\t\t&& (control.tab_control_index == MAX_TAB_CONTROLS || GetParent(control.hwnd) == mHwnd) // Skip controls which are clipped by a parent control.\n\t\t\t\t\t&& GetWindowLong(control.hwnd, GWL_STYLE) & WS_VISIBLE) // Don't use IsWindowVisible() in case parent window is hidden.\n\t\t\t\t{\n\t\t\t\t\tGetWindowRect(control.hwnd, &rect);\n\t\t\t\t\tMapWindowPoints(NULL, mHwnd, (LPPOINT)&rect, 2); // Convert rect to client coordinates (not the same as GetClientRect()).\n\t\t\t\t\tif (rect.right > width)\n\t\t\t\t\t\twidth = rect.right;\n\t\t\t\t\tif (rect.bottom > height)\n\t\t\t\t\t\theight = rect.bottom;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (width > 0)\n\t\t\t\twidth += mMarginX;\n\t\t\tif (height > 0)\n\t\t\t\theight += mMarginY;\n\t\t\t// Don't use IsWindowVisible() because that would say that bar is hidden just because the parent\n\t\t\t// window is hidden. We want to know if the bar is truly hidden, separately from the window:\n\t\t\tif (mStatusBarHwnd && GetWindowLong(mStatusBarHwnd, GWL_STYLE) & WS_VISIBLE)\n\t\t\t{\n\t\t\t\tGetWindowRect(mStatusBarHwnd, &rect); // GetWindowRect vs. GetClientRect to include any borders it might have.\n\t\t\t\theight += rect.bottom - rect.top;\n\t\t\t}\n\t\t}\n\t\telse if (width == COORD_UNSPECIFIED || height == COORD_UNSPECIFIED)\n\t\t{\n\t\t\tif (mGuiShowHasNeverBeenDone) // By default, center the window if this is the first use of \"Gui Show\" (even \"Gui Show, Hide\").\n\t\t\t{\n\t\t\t\tif (width == COORD_UNSPECIFIED)\n\t\t\t\t\twidth = mMaxExtentRight + mMarginX;\n\t\t\t\tif (height == COORD_UNSPECIFIED)\n\t\t\t\t{\n\t\t\t\t\theight = mMaxExtentDown + mMarginY;\n\t\t\t\t\tif (mStatusBarHwnd && GetWindowLong(mStatusBarHwnd, GWL_STYLE) & WS_VISIBLE) // See comments in similar section above.\n\t\t\t\t\t{\n\t\t\t\t\t\tGetWindowRect(mStatusBarHwnd, &rect); // GetWindowRect vs. GetClientRect to include any borders it might have.\n\t\t\t\t\t\theight += rect.bottom - rect.top;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tGetClientRect(mHwnd, &rect);\n\t\t\t\tif (width == COORD_UNSPECIFIED) // Keep the current client width, as documented.\n\t\t\t\t\twidth = rect.right - rect.left;\n\t\t\t\tif (height == COORD_UNSPECIFIED) // Keep the current client height, as documented.\n\t\t\t\t\theight = rect.bottom - rect.top;\n\t\t\t}\n\t\t}\n\n\t\t// v1.0.44.13: For code size reasons and due to rarity-of-need, the following isn't done (also, it\n\t\t// can't catch all such situations; e.g. when \"Gui +MinSize\" can be used after \"Gui Show\".\n\t\t// Plus it might add a bit of flexibility to allow \"Gui Show\" to override min/max:\n\t\t// Older: The following prevents situations in which the window starts off at a size that's\n\t\t// too big or too small, which in turn causes it to snap to the min/max size the moment\n\t\t// the user tries to drag-move or drag-resize it:\n\t\t//if (mMinWidth >= 0 && width < mMinWidth) // mMinWidth >= 0 covers both COORD_UNSPECIFIED and COORD_CENTERED.\n\t\t//\twidth = mMinWidth;\n\t\t//else if (mMaxWidth >= 0 && width > mMaxWidth)\n\t\t//\twidth = mMaxWidth;\n\t\t//if (mMinHeight >= 0 && height < mMinHeight)\n\t\t//\theight = mMinHeight;\n\t\t//else if (mMaxHeight >= 0 && height > mMaxHeight)\n\t\t//\theight = mMaxHeight;\n\n\t} // if (allow_move_window)\n\n\tif (mGuiShowHasNeverBeenDone)\n\t{\n\t\t// Update any tab controls to show only their correct pane. This should only be necessary\n\t\t// upon the first \"Gui Show\" (even \"Gui, Show, Hide\") of the window because subsequent switches\n\t\t// of the control's tab should result in a TCN_SELCHANGE notification.\n\t\tif (mTabControlCount)\n\t\t\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t\t\t\tif (mControl[u]->type == GUI_CONTROL_TAB)\n\t\t\t\t\tControlUpdateCurrentTab(*mControl[u], false); // Pass false so that default/z-order focus is used across entire window.\n\t\t// By default, center the window if this is the first time it's being shown:\n\t\tif (x == COORD_UNSPECIFIED)\n\t\t\tx = COORD_CENTERED;\n\t\tif (y == COORD_UNSPECIFIED)\n\t\t\ty = COORD_CENTERED;\n\t}\n\n\tBOOL is_visible = IsWindowVisible(mHwnd);\n\n\tif (allow_move_window)\n\t{\n\t\t// The above has determined the height/width of the client area. From that area, determine\n\t\t// the window's new screen rect, including title bar, borders, etc.\n\t\t// If the window has a border or caption this also changes top & left *slightly* from zero.\n\t\tRECT rect = {0, 0, width, height}; // left,top,right,bottom\n\t\tLONG style = GetWindowLong(mHwnd, GWL_STYLE);\n\t\tBOOL has_menu = GetMenu(mHwnd) ? TRUE : FALSE;\n\t\tAdjustWindowRectEx(&rect, style, has_menu, GetWindowLong(mHwnd, GWL_EXSTYLE));\n\t\t// MSDN: \"The AdjustWindowRectEx function does not take the WS_VSCROLL or WS_HSCROLL styles into\n\t\t// account. To account for the scroll bars, call the GetSystemMetrics function with SM_CXVSCROLL\n\t\t// or SM_CYHSCROLL.\"\n\t\tif (style & WS_HSCROLL)\n\t\t\trect.bottom += GetSystemMetrics(SM_CYHSCROLL);\n\t\tif (style & WS_VSCROLL)\n\t\t\trect.right += GetSystemMetrics(SM_CXVSCROLL);\n\t\t// Compensate for menu wrapping: https://blogs.msdn.microsoft.com/oldnewthing/20030911-00/?p=42553/\n\t\tif (has_menu)\n\t\t{\n\t\t\tRECT rcTemp = rect;\n\t\t\trcTemp.bottom = 0x7FFF;\n\t\t\tSendMessage(mHwnd, WM_NCCALCSIZE, FALSE, (LPARAM)&rcTemp);\n\t\t\trect.bottom += rcTemp.top;\n\t\t}\n\n\t\tint nc_width = rect.right - rect.left - width;\n\t\tint nc_height = rect.bottom - rect.top - height;\n\n\t\twidth = rect.right - rect.left; // rect.left might be slightly less than zero.\n\t\theight = rect.bottom - rect.top; // rect.top might be slightly less than zero. A status bar is properly handled since it's inside the window's client area.\n\n\t\tRECT work_rect;\n\t\tbool is_child_window = mOwner && (style & WS_CHILD);\n\t\tif (is_child_window)\n\t\t\tGetClientRect(mOwner, &work_rect); // Center within parent window (our position is set relative to mOwner's client area, not in screen coordinates).\n\t\telse\n\t\t\tSystemParametersInfo(SPI_GETWORKAREA, 0, &work_rect, 0); // Get desktop rect excluding task bar.\n\t\tint work_width = work_rect.right - work_rect.left; // Note that \"left\" won't be zero if task bar is on left!\n\t\tint work_height = work_rect.bottom - work_rect.top; // Note that \"top\" won't be zero if task bar is on top!\n\n\t\t// Seems best to restrict window size to the size of the desktop whenever explicit sizes\n\t\t// weren't given, since most users would probably want that. But only on first use of\n\t\t// \"Gui Show\" (even \"Gui, Show, Hide\"):\n\t\tif (mGuiShowHasNeverBeenDone && !is_child_window)\n\t\t{\n\t\t\tif (width_orig == COORD_UNSPECIFIED && width > work_width)\n\t\t\t\twidth = work_width;\n\t\t\tif (height_orig == COORD_UNSPECIFIED && height > work_height)\n\t\t\t\theight = work_height;\n\t\t}\n\n\t\tif (x == COORD_CENTERED || y == COORD_CENTERED) // Center it, based on its dimensions determined above.\n\t\t{\n\t\t\t// This does not handle multi-monitor systems explicitly, and has no need to do so since\n\t\t\t// SPI_GETWORKAREA \"Retrieves the size of the work area on the primary display monitor\".\n\t\t\tif (x == COORD_CENTERED)\n\t\t\t\tx = work_rect.left + ((work_width - width) / 2);\n\t\t\tif (y == COORD_CENTERED)\n\t\t\t\ty = work_rect.top + ((work_height - height) / 2);\n\t\t}\n\n\t\tRECT old_rect;\n\t\tGetWindowRect(mHwnd, &old_rect);\n\t\tint old_width = old_rect.right - old_rect.left;\n\t\tint old_height = old_rect.bottom - old_rect.top;\n\n\t\t// Added for v1.0.44.13:\n\t\t// Below is done inside this block (allow_move_window) because that way, it should always\n\t\t// execute whenever mGuiShowHasNeverBeenDone (since the window shouldn't be iconic prior to\n\t\t// its first showing). In addition, below must be down prior to any ShowWindow() that does\n\t\t// a minimize or maximize because that would prevent GetWindowRect/GetClientRect calculations\n\t\t// below from working properly.\n\t\t// v1.1.34.03: It's now done before the MoveWindow call below, so that the initial size is\n\t\t// limited by the correct values. nc_width and nc_height are expected to be accurate, and\n\t\t// must be used rather than calling GetClientRect and calculating the difference, as that's\n\t\t// likely to be 0x0 prior to calling MoveWindow.\n\t\tif (mGuiShowHasNeverBeenDone) // This is the first showing of this window.\n\t\t{\n\t\t\t// Now that the window's style, edge type, title bar, menu bar, and other non-client attributes have\n\t\t\t// likely (but not certainly) been determined, adjust MinMaxSize values from client size to\n\t\t\t// entire-window size for use with WM_GETMINMAXINFO.\n\n\t\t\tif (mMinWidth == COORD_CENTERED) // COORD_CENTERED is the flag that means, \"use window's current, total width.\"\n\t\t\t\tmMinWidth = width;\n\t\t\telse if (mMinWidth != COORD_UNSPECIFIED)\n\t\t\t\tmMinWidth += nc_width;\n\n\t\t\tif (mMinHeight == COORD_CENTERED)\n\t\t\t\tmMinHeight = height;\n\t\t\telse if (mMinHeight != COORD_UNSPECIFIED)\n\t\t\t\tmMinHeight += nc_height;\n\n\t\t\tif (mMaxWidth == COORD_CENTERED)\n\t\t\t\tmMaxWidth = width;\n\t\t\telse if (mMaxWidth != COORD_UNSPECIFIED)\n\t\t\t\tmMaxWidth += nc_width;\n\n\t\t\tif (mMaxHeight == COORD_CENTERED)\n\t\t\t\tmMaxHeight = height;\n\t\t\telse if (mMaxHeight != COORD_UNSPECIFIED)\n\t\t\t\tmMaxHeight += nc_height;\n\t\t} // if (mGuiShowHasNeverBeenDone)\n\n\t\t// Avoid calling MoveWindow() if nothing changed because it might repaint/redraw even if window size/pos\n\t\t// didn't change:\n\t\tif (width != old_width || height != old_height || (x != COORD_UNSPECIFIED && x != old_rect.left)\n\t\t\t|| (y != COORD_UNSPECIFIED && y != old_rect.top)) // v1.0.45: Fixed to be old_rect.top not old_rect.bottom.\n\t\t{\n\t\t\t// v1.0.44.08: Window state gets messed up if it's resized without first unmaximizing it (for example,\n\t\t\t// it can't be resized by dragging its lower-right corner). So it seems best to unmaximize, perhaps\n\t\t\t// even when merely the position is changing rather than the size (even on a multimonitor system,\n\t\t\t// it might not be valid to reposition a maximized window without unmaximizing it?)\n\t\t\tif (IsZoomed(mHwnd)) // Call IsZoomed() again in case above changed the state. No need to check IsIconic() because above already set default show-mode to SW_RESTORE for such windows.\n\t\t\t\tShowWindow(mHwnd, SW_RESTORE); // But restore isn't done for something like \"Gui, Show, Center\" because it's too obscure and might reduce flexibility (debatable).\n\t\t\tif (is_child_window)\n\t\t\t\tScreenToClient(mOwner, (LPPOINT)&old_rect); // Make the old coords relative to parent.\n\t\t\tMoveWindow(mHwnd, x == COORD_UNSPECIFIED ? old_rect.left : x, y == COORD_UNSPECIFIED ? old_rect.top : y\n\t\t\t\t, width, height, is_visible); // Do repaint if window is visible.\n\t\t}\n\t} // if (allow_move_window)\n\n\t// Note that for SW_MINIMIZE and SW_MAXIMIZE, the MoveWindow() above should be done prior to ShowWindow()\n\t// so that the window will \"remember\" its new size upon being restored later.\n\tif (!show_was_done)\n\t{\n\t\tif (show_mode == SW_MINIMIZE && GetForegroundWindow() == mHwnd)\n\t\t{\n\t\t\t// Before minimizing the window, call DefDlgProc to save the handle of the focused control.\n\t\t\t// This is only necessary when minimizing an active GUI by calling ShowWindow(), as it is\n\t\t\t// normally done by DefDlgProc when WM_SYSCOMMAND, SC_MINIMIZE is received. Without this,\n\t\t\t// focus is reset to the first control with WS_TABSTOP when the window is restored.\n\t\t\t// We don't use WM_SYSCOMMAND to minimize the window because it would cause the \"minimize\"\n\t\t\t// system sound to be played, and that should probably only happen as a result of user action.\n\t\t\tDefDlgProc(mHwnd, WM_ACTIVATE, WA_INACTIVE, 0);\n\t\t}\n\t\tShowWindow(mHwnd, show_mode);\n\t}\n\tVisibilityChanged(); // AddRef() to keep the object alive while the window is visible.\n\n\tbool we_did_the_first_activation = false; // Set default.\n\n\tswitch(show_mode)\n\t{\n\tcase SW_SHOW:\n\tcase SW_SHOWNORMAL:\n\tcase SW_MAXIMIZE:\n\tcase SW_RESTORE:\n\t\tif (GetAncestor(mHwnd, GA_ROOT) != mHwnd) // It's a child window, perhaps due to the +Parent option.\n\t\t\t// Since this is a child window, SetForegroundWindowEx will fail and fall back to the \"two-alts\"\n\t\t\t// method of forcing activation, which causes some messages to be discarded due to the temporary\n\t\t\t// modal menu loop. So don't even try it.\n\t\t\tbreak;\n\t\tif (mHwnd != GetForegroundWindow())\n\t\t\tSetForegroundWindowEx(mHwnd); // In the above modes, try to force it to the foreground as documented.\n\t\tif (mFirstActivation)\n\t\t{\n\t\t\t// Since the window has never before been active, any of the above qualify as \"first activation\".\n\t\t\t// Thus, we are no longer at the first activation:\n\t\t\tmFirstActivation = false;\n\t\t\twe_did_the_first_activation = true; // And we're the ones who did the first activation.\n\t\t}\n\t\tbreak;\n\t// No action for these:\n\t//case SW_MINIMIZE:\n\t//case SW_SHOWNA:\n\t//case SW_SHOWNOACTIVATE:\n\t//case SW_HIDE:\n\t}\n\n\t// No attempt is made to handle the fact that Gui windows can be shown or activated via WinShow and\n\t// WinActivate. In such cases, if the tab control itself is focused, mFirstActivation will still focus\n\t// a control inside the tab rather than leaving the tab control focused. Similarly, if the window\n\t// was shown with NA or NOACTIVATE or MINIMIZE, when the first use of an activation mode of \"Gui Show\"\n\t// is done, even if it's far into the future, long after the user has activated and navigated in the\n\t// window, the same \"first activation\" behavior will be done anyway. This is documented here as a\n\t// known limitation, since fixing it would probably add an unreasonable amount of complexity.\n\tif (we_did_the_first_activation)\n\t{\n\t\tHWND focused_hwnd = GetFocus(); // Window probably must be visible and active for GetFocus() to work.\n\t\tif (focused_hwnd)\n\t\t{\n\t\t\tif (GuiControlType *focused_control = FindControl(focused_hwnd))\n\t\t\t{\n\t\t\t\t// Since this is the first activation, if the focus wound up on a tab control itself as a result\n\t\t\t\t// of the above, focus the first control of that tab since that is traditional. HOWEVER, do not\n\t\t\t\t// instead default tab controls to lacking WS_TABSTOP since it is traditional for them to have\n\t\t\t\t// that property, probably to aid accessibility.\n\t\t\t\tif (focused_control->type == GUI_CONTROL_TAB)\n\t\t\t\t{\n\t\t\t\t\t// v1.0.27: The following must be done, at least in some cases, because otherwise\n\t\t\t\t\t// controls outside of the tab control will not get drawn correctly. I suspect this\n\t\t\t\t\t// is because at the exact moment execution reaches the line below, the window is in\n\t\t\t\t\t// a transitional state, with some WM_PAINT and other messages waiting in the queue\n\t\t\t\t\t// for it. If those messages are not processed prior to ControlUpdateCurrentTab()'s\n\t\t\t\t\t// use of WM_SETREDRAW, they might get dropped out of the queue and lost.\n\t\t\t\t\tUpdateWindow(mHwnd);\n\t\t\t\t\tControlUpdateCurrentTab(*focused_control, true);\n\t\t\t\t}\n\t\t\t\telse if (focused_control->type == GUI_CONTROL_BUTTON)\n\t\t\t\t{\n\t\t\t\t\tif (mDefaultButtonIndex < mControlCount && mControl[mDefaultButtonIndex] != focused_control)\n\t\t\t\t\t{\n\t\t\t\t\t\t// There is a Default button, but some other button was focused instead (because it was\n\t\t\t\t\t\t// the first input-capable control). There are a few reasons to override this:\n\t\t\t\t\t\t// 1) It is counter-intuitive to have two different kinds of \"default button\".\n\t\t\t\t\t\t// 2) MsgBox (and maybe other system dialogs that have only buttons) focus the Default\n\t\t\t\t\t\t// button by default, even if it is not the first button.\n\t\t\t\t\t\t// 3) In most other cases, when a button is focused it also temporarily becomes Default,\n\t\t\t\t\t\t// so pressing Enter or Space will activate it; but due to the way the default message\n\t\t\t\t\t\t// processing focuses the initial control, it ends up being focused but not Default,\n\t\t\t\t\t\t// so Space and Enter click two different buttons. This lasts until the user changes\n\t\t\t\t\t\t// focus, even by switching to another window and back.\n\t\t\t\t\t\t// This inconsistency can be avoided by using WM_NEXTDLGCTL to \"refocus\" the button,\n\t\t\t\t\t\t// but then the button with \"Default\" option would only become the default once some\n\t\t\t\t\t\t// non-button control is focused, which seems unlikely to be what the author intended.\n\t\t\t\t\t\tSetFocus(mControl[mDefaultButtonIndex]->hwnd);\n\t\t\t\t\t\t// This is only done if a button was focused by default, as if some other type of control\n\t\t\t\t\t\t// is focused, the Default button can often still be activated with Enter. Most of the\n\t\t\t\t\t\t// time if there is an input field and a confirmation button, the input field should have\n\t\t\t\t\t\t// the initial focus. There are numerous examples of system and third-party dialogs that\n\t\t\t\t\t\t// behave this way.\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t//else focus has already been set appropriately, and nothing needs to be done.\n\t\t\t}\n\t\t}\n\t\telse // No window/control has keyboard focus (see comment below).\n\t\t\tSetFocus(mHwnd);\n\t\t\t// The above was added in v1.0.46.05 to fix the fact that a GUI window could be both active and\n\t\t\t// foreground yet not have keyboard focus. This occurs under the following circumstances (and\n\t\t\t// possibly others):\n\t\t\t// 1) A script with a menu item that shows a GUI window is reloaded via its tray menu item \"Reload\".\n\t\t\t// 2) The GUI window is shown via its custom tray menu item.\n\t\t\t// 3) The window becomes active and foreground, but doesn't have keyboard focus (not even its\n\t\t\t// GuiEscape label will work until you switch away from that window then back to it).\n\t\t\t// Note: Default handling of WM_SETFOCUS moves the focus to the first input-capable control.\n\t\t\t// This case should be unusual since default handling of WM_ACTIVATE is also to SetFocus().\n\t}\n\n\tmGuiShowHasNeverBeenDone = false;\n\t// It seems best to reset this prior to SLEEP below, but after the above line (for code clarity) since\n\t// otherwise it might get stuck in a true state if the SLEEP results in the launch of a script\n\t// subroutine that takes a long time to complete:\n\tmShowIsInProgress = false;\n\n\t// Update for v1.0.25: The below is now done last to prevent the GuiSize label (if any) from launching\n\t// while this function is still incomplete; in other words, don't allow the GuiSize label to launch\n\t// until after all of the above members and actions have been completed.\n\t// If this weren't done, whenever a command that blocks (fully uses) the main thread such as \"Drive Eject\"\n\t// immediately follows \"Gui Show\", the GUI window might not appear until afterward because our thread\n\t// never had a chance to call its WindowProc with all the messages needed to actually show the window:\n\tMsgSleep(-1);\n\t// UpdateWindow() would probably achieve the same effect as the above, but it feels safer to do\n\t// the above because it ensures that our message queue is empty prior to returning to our caller.\n\n\treturn OK;\n}\n\n\n\nFResult GuiType::Minimize()\n{\n\tGUI_MUST_HAVE_HWND;\n\tShowWindow(mHwnd, SW_MINIMIZE);\n\treturn OK;\n}\n\nFResult GuiType::Maximize()\n{\n\tGUI_MUST_HAVE_HWND;\n\tShowWindow(mHwnd, SW_MAXIMIZE);\n\treturn OK;\n}\n\nFResult GuiType::Restore()\n{\n\tGUI_MUST_HAVE_HWND;\n\tShowWindow(mHwnd, SW_RESTORE);\n\treturn OK;\n}\n\nFResult GuiType::Flash(optl<BOOL> aBlink)\n{\n\tGUI_MUST_HAVE_HWND;\n\tFlashWindow(mHwnd, aBlink.value_or(TRUE));\n\treturn OK;\n}\n\nFResult GuiType::Hide()\n{\n\tGUI_MUST_HAVE_HWND;\n\tCancel();\n\treturn OK;\n}\n\n\n\nvoid GuiType::Cancel()\n{\n\tif (mHwnd)\n\t{\n\t\tShowWindow(mHwnd, SW_HIDE);\n\t\tVisibilityChanged(); // This may Release() and indirectly Destroy() the Gui.\n\t}\n\t// If this Gui was the last thing keeping the script running, exit the script:\n\tg_script.ExitIfNotPersistent(EXIT_CLOSE);\n}\n\n\n\nvoid GuiType::Close()\n// If there is an OnClose event handler defined, launch it as a new thread.\n// In this case, don't close or hide the window. It's up to the handler to do that\n// if it wants to.\n// If there is no handler, treat it the same as Hide().\n{\n\tif (!IsMonitoring(GUI_EVENT_CLOSE))\n\t\treturn (void)Cancel();\n\tPOST_AHK_GUI_ACTION(mHwnd, NO_CONTROL_INDEX, GUI_EVENT_CLOSE, NO_EVENT_INFO);\n\t// MsgSleep() is not done because \"case AHK_GUI_ACTION\" in GuiWindowProc() takes care of it.\n\t// See its comments for why.\n}\n\n\n\nvoid GuiType::Escape() // Similar to close, except typically called when the user presses ESCAPE.\n// If there is an OnEscape event handler defined, launch it as a new thread.\n{\n\tif (!IsMonitoring(GUI_EVENT_ESCAPE)) // The user preference (via votes on forum poll) is to do nothing by default.\n\t\treturn;\n\t// See lengthy comments in Event() about this section:\n\tPOST_AHK_GUI_ACTION(mHwnd, NO_CONTROL_INDEX, GUI_EVENT_ESCAPE, NO_EVENT_INFO);\n\t// MsgSleep() is not done because \"case AHK_GUI_ACTION\" in GuiWindowProc() takes care of it.\n\t// See its comments for why.\n}\n\n\n\nvoid GuiType::VisibilityChanged()\n{\n\t// Adjust the ref count to reflect the fact that the user has a \"reference\" to the GUI;\n\t// that is, the user can interact with it, raising events which may cause callbacks into\n\t// script. The script doesn't need any other references to the GUI, since one will be\n\t// provided in the event callback.\n\t// In other words, the script is not required to keep a reference to the object while the\n\t// GUI is visible, but also isn't required to Destroy() it explicitly. Destroy() will be\n\t// called automatically when the last reference is released (which may be below).\n\tbool visible = IsWindowVisible(mHwnd);\n\tif (visible != mVisibleRefCounted) // Visibility really has changed.\n\t{\n\t\tmVisibleRefCounted = visible; // Change this first in case of recursion.\n\t\tif (visible)\n\t\t\tAddRef();\n\t\telse\n\t\t\tRelease();\n\t}\n}\n\n\n\nFResult GuiType::Submit(optl<BOOL> aHideIt, IObject *&aRetVal)\n// Caller has ensured that all controls have valid, non-NULL hwnds:\n{\n\tGUI_MUST_HAVE_HWND;\n\n\tObject* ret = Object::Create();\n\tif (!ret)\n\t\treturn FR_E_OUTOFMEM;\n\n\t// Handle all non-radio controls:\n\tGuiIndexType u;\n\tfor (u = 0; u < mControlCount; ++u)\n\t{\n\t\tGuiControlType& control = *mControl[u]; // For performance and readability.\n\t\tif (control.name == NULL) // Skip the control if it does not have a name\n\t\t\tcontinue;\n\t\t\n\t\tif (control.HasSubmittableValue())\n\t\t{\n\t\t\tTCHAR temp_buf[MAX_NUMBER_SIZE];\n\t\t\tResultToken value;\n\t\t\tvalue.InitResult(temp_buf);\n\n\t\t\tControlGetContents(value, control, Submit_Mode);\n\t\t\tif (value.Exited())\n\t\t\t{\n\t\t\t\tret->Release();\n\t\t\t\treturn FR_FAIL;\n\t\t\t}\n\t\t\tif (!ret->SetOwnProp(control.name, value))\n\t\t\t{\n\t\t\t\tvalue.Free();\n\t\t\t\tgoto outofmem;\n\t\t\t}\n\t\t\tvalue.Free();\n\t\t}\n\t}\n\n\t// Handle GUI_CONTROL_RADIO separately so that any radio group that has a single name\n\t// to share among all its members can be given special treatment:\n\tint group_radios = 0; // The number of radio buttons in the current group.\n\tint group_radios_with_name = 0; // The number of the above that have a name.\n\tLPTSTR group_name = NULL; // The last-found name of the current group.\n\tint selection_number = 0; // Which radio in the current group is selected (0 if none).\n\tLPTSTR output_name;\n\n\t// The below uses <= so that it goes one beyond the limit. This allows the final radio group\n\t// (if any) to be noticed in the case where the very last control in the window is a radio button.\n\t// This is because in such a case, there is no \"terminating control\" having the WS_GROUP style:\n\tfor (u = 0; u <= mControlCount; ++u)\n\t{\n\t\tGuiControlType& control = *mControl[u]; // For performance and readability.\n\n\t\t// WS_GROUP is used to determine where one group ends and the next begins -- rather than using\n\t\t// seeing if the control's type is radio -- because in the future it may be possible for a radio\n\t\t// group to have other controls interspersed within it and yet still be a group for the purpose\n\t\t// of \"auto radio button (only one selected at a time)\" behavior:\n\t\tif (u == mControlCount || GetWindowLong(control.hwnd, GWL_STYLE) & WS_GROUP) // New group. Relies on short-circuit boolean order.\n\t\t{\n\t\t\t// If the prior group had more than one radio in it but only one had a name, that\n\t\t\t// name is shared among all radios (as of v1.0.20). Otherwise:\n\t\t\t// 1) If it has zero radios and/or zero names: already fully handled by other logic.\n\t\t\t// 2) It has multiple names: the default values assigned in the loop are simply retained.\n\t\t\t// 3) It has exactly one radio in it and that radio has a name: same as above.\n\t\t\tif (group_radios_with_name == 1 && group_radios > 1)\n\t\t\t{\n\t\t\t\t// Multiple buttons selected. Since this is so rare, don't give it a distinct value.\n\t\t\t\t// Instead, treat this the same as \"none selected\". Update for v1.0.24: It is no longer\n\t\t\t\t// directly possible to have multiple radios selected by having the word \"checked\" in\n\t\t\t\t// more than one of their AddCtrl commands. However, there are probably other ways\n\t\t\t\t// to get multiple buttons checked (perhaps the Control command), so this handling\n\t\t\t\t// for multiple selections is left intact.\n\t\t\t\tif (selection_number == -1)\n\t\t\t\t\tselection_number = 0;\n\t\t\t\tif (!ret->SetOwnProp(group_name, selection_number)) // group_var should not be NULL since group_radios_with_name == 1\n\t\t\t\t\tgoto outofmem;\n\t\t\t}\n\t\t\tif (u == mControlCount) // The last control in the window is a radio and its group was just processed.\n\t\t\t\tbreak;\n\t\t\tgroup_radios = group_radios_with_name = selection_number = 0;\n\t\t}\n\t\tif (control.type == GUI_CONTROL_RADIO)\n\t\t{\n\t\t\t++group_radios;\n\t\t\tif (output_name = control.name) // Assign.\n\t\t\t{\n\t\t\t\t++group_radios_with_name;\n\t\t\t\tgroup_name = output_name; // If this group winds up having only one name, this will be it.\n\t\t\t}\n\t\t\tint control_is_checked = SendMessage(control.hwnd, BM_GETCHECK, 0, 0) == BST_CHECKED;\n\t\t\tif (control_is_checked)\n\t\t\t{\n\t\t\t\tif (selection_number) // Multiple buttons selected, so flag this as an indeterminate state.\n\t\t\t\t\tselection_number = -1;\n\t\t\t\telse\n\t\t\t\t\tselection_number = group_radios;\n\t\t\t}\n\t\t\tif (output_name)\n\t\t\t\tif (!ret->SetOwnProp(output_name, control_is_checked))\n\t\t\t\t\tgoto outofmem;\n\t\t}\n\t} // for()\n\n\tif (aHideIt.value_or(TRUE))\n\t\tCancel();\n\taRetVal = ret;\n\treturn OK;\n\noutofmem:\n\tret->Release();\n\treturn FR_E_OUTOFMEM;\n}\n\n\n\nvoid GuiType::ControlGetContents(ResultToken &aResultToken, GuiControlType &aControl, ValueModeType aMode)\n{\n\t// Control types for which Text and Value both have special handling:\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_DROPDOWNLIST: return ControlGetDDL(aResultToken, aControl, aMode);\n\tcase GUI_CONTROL_COMBOBOX: return ControlGetComboBox(aResultToken, aControl, aMode);\n\tcase GUI_CONTROL_LISTBOX: return ControlGetListBox(aResultToken, aControl, aMode);\n\tcase GUI_CONTROL_TAB: return ControlGetTab(aResultToken, aControl, aMode);\n\t\n\tcase GUI_CONTROL_TEXT: // See case GUI_CONTROL_TEXT in ControlSetContents() for the reasoning behind this.\n\tcase GUI_CONTROL_PIC: // The control's window text is usually the original filename.\n\t\taMode = Text_Mode; // Value and Text both return the window text.\n\t\tbreak;\n\t}\n\t// The remaining control types have no need for special handling of the Text property,\n\t// either because they have normal caption text, or because they have no \"text version\"\n\t// of the value, or no \"value\" at all.\n\tif (aMode == Text_Mode)\n\t{\n\t\tControlGetWindowText(aResultToken, aControl);\n\t\t_o_return_retval;\n\t}\n\t// Otherwise, it's the Value property or Submit method.\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_RADIO: // Same as below.\n\tcase GUI_CONTROL_CHECKBOX: return ControlGetCheck(aResultToken, aControl);\n\tcase GUI_CONTROL_EDIT: return ControlGetEdit(aResultToken, aControl);\n\tcase GUI_CONTROL_DATETIME: return ControlGetDateTime(aResultToken, aControl);\n\tcase GUI_CONTROL_MONTHCAL: return ControlGetMonthCal(aResultToken, aControl);\n\tcase GUI_CONTROL_HOTKEY: return ControlGetHotkey(aResultToken, aControl);\n\tcase GUI_CONTROL_UPDOWN: return ControlGetUpDown(aResultToken, aControl);\n\tcase GUI_CONTROL_SLIDER: return ControlGetSlider(aResultToken, aControl);\n\tcase GUI_CONTROL_PROGRESS: return ControlGetProgress(aResultToken, aControl);\n\n\tcase GUI_CONTROL_ACTIVEX:\n\t\taControl.union_object->AddRef();\n\t\t_o_return(aControl.union_object);\n\t\t\n\t// Already handled in the switch() above:\n\t//case GUI_CONTROL_DATETIME:\n\t//case GUI_CONTROL_DROPDOWNLIST:\n\t//case GUI_CONTROL_COMBOBOX:\n\t//case GUI_CONTROL_LISTBOX:\n\t//case GUI_CONTROL_TAB:\n\t//case GUI_CONTROL_PIC:\n\t//case GUI_CONTROL_TEXT:\n\n\tcase GUI_CONTROL_LINK:\n\tcase GUI_CONTROL_GROUPBOX:\n\tcase GUI_CONTROL_BUTTON:\n\tcase GUI_CONTROL_STATUSBAR:\n\t\t// Above: The control has no \"value\". GuiControl.Text should be used to get its text.\n\tcase GUI_CONTROL_LISTVIEW: // More flexible methods are available.\n\tcase GUI_CONTROL_TREEVIEW: // More flexible methods are available.\n\tcase GUI_CONTROL_CUSTOM: // Don't know what this control's \"value\" is or how to get it.\n\tdefault: // Should help code size by allowing the compiler to omit checks for the above cases.\n\t\t// The concept of a \"value\" does not apply to these controls. Value could be\n\t\t// an alias for Text in these cases, but that doesn't seem helpful/meaningful.\n\t\t// This also \"reserves\" Value for other possible future uses, such as assigning\n\t\t// an image to a Button control.\n\t\t_o_return_empty;\n\t}\n}\n\n\n\nGuiIndexType GuiType::FindControl(LPCTSTR aControlID)\n// Find the index of the control that matches the string, which can be either:\n// 1) HWND\n// 2) Name\n// 3) Class+NN\n// 4) Control's title/caption.\n// Returns -1 if not found.\n{\n\t// v1.0.44.08: Added the following check. Without it, ControlExist() (further below) would retrieve the\n\t// topmost child, which isn't very useful or intuitive. This currently affects only the following commands:\n\t// 1) GuiControl (but not GuiControlGet because it has special handling for a blank ControlID).\n\t// 2) Gui, ListView|TreeView, MyTree|MyList\n\tif (!*aControlID)\n\t\treturn -1;\n\tGuiIndexType u;\n\tUINT hwnd_uint;\n\tif (ParseInteger(aControlID, hwnd_uint)) // Allow negatives, for flexibility, but truncate to filter out sign-extended values.\n\t{\n\t\t// v1.1.04: Allow Gui controls to be referenced by HWND. There is some risk of breaking\n\t\t// scripts, but only if the text of one control contains the HWND of another control.\n\t\tu = FindControlIndex((HWND)(UINT_PTR)hwnd_uint);\n\t\tif (u < mControlCount)\n\t\t\treturn u;\n\t\t// Otherwise: no match was found, so fall back to considering it as text.\n\t}\n\t// Try to find the control with the specified name.\n\tfor (u = 0; u < mControlCount; ++u)\n\t\tif (mControl[u]->name && _tcsicmp(mControl[u]->name, aControlID) == 0)\n\t\t\treturn u;\n\t// Otherwise: No match found, so fall back to standard control class and/or text finding method.\n\tHWND control_hwnd = ControlExist(mHwnd, aControlID);\n\treturn FindControlIndex(control_hwnd);\n}\n\n\n\nint GuiType::FindGroup(GuiIndexType aControlIndex, GuiIndexType &aGroupStart, GuiIndexType &aGroupEnd)\n// Caller must provide a valid aControlIndex for an existing control.\n// Returns the number of radio buttons inside the group. In addition, it provides start and end\n// values to the caller via aGroupStart/End, where Start is the index of the first control in\n// the group and End is the index of the control *after* the last control in the group (if none,\n// aGroupEnd is set to mControlCount).\n// NOTE: This returns the range covering the entire group, and it is possible for the group\n// to contain non-radio type controls. Thus, the caller should check each control inside the\n// returned range to make sure it's a radio before operating upon it.\n{\n\t// Work backwards in the control array until the first member of the group is found or the\n\t// first array index, whichever comes first (the first array index is the top control in the\n\t// Z-Order and thus treated by the OS as an implicit start of a new group):\n\tint group_radios = 0; // This and next are both init'd to 0 not 1 because the first loop checks aControlIndex itself.\n\tfor (aGroupStart = aControlIndex;; --aGroupStart)\n\t{\n\t\tif (mControl[aGroupStart]->type == GUI_CONTROL_RADIO)\n\t\t\t++group_radios;\n\t\tif (!aGroupStart || GetWindowLong(mControl[aGroupStart]->hwnd, GWL_STYLE) & WS_GROUP)\n\t\t\tbreak;\n\t}\n\t// Now find the control after the last control (or mControlCount if none). Must start at +1\n\t// because if aControlIndex's control has the WS_GROUP style, we don't want to count that\n\t// as the end of the group (because in fact that would be the beginning of the group).\n\tfor (aGroupEnd = aControlIndex + 1; aGroupEnd < mControlCount; ++aGroupEnd)\n\t{\n\t\t// Unlike the previous loop, this one must do this check prior to the next one:\n\t\tif (GetWindowLong(mControl[aGroupEnd]->hwnd, GWL_STYLE) & WS_GROUP)\n\t\t\tbreak;\n\t\tif (mControl[aGroupEnd]->type == GUI_CONTROL_RADIO)\n\t\t\t++group_radios;\n\t}\n\treturn group_radios;\n}\n\n\n\nFResult GuiType::SetFont(optl<StrArg> aOptions, optl<StrArg> aFontName)\n{\n\tGUI_MUST_HAVE_HWND;\n\tCOLORREF color;\n\tint font_index = FindOrCreateFont(aOptions.value_or_empty(), aFontName.value_or_empty()\n\t\t, &sFont[mCurrentFontIndex], &color);\n\tif (color != CLR_NONE) // Even if the above call failed, it returns a color if one was specified.\n\t\tmCurrentColor = color;\n\tif (font_index > -1) // Success.\n\t{\n\t\tmCurrentFontIndex = font_index;\n\t\treturn OK;\n\t}\n\t// Failure of the above is rare because it falls back to default typeface if the one specified\n\t// isn't found. It will have already displayed the error:\n\treturn FAIL;\n}\n\n\n\nint GuiType::FindOrCreateFont(LPCTSTR aOptions, LPCTSTR aFontName, FontType *aFoundationFont, COLORREF *aColor)\n// Returns the index of existing or new font within the sFont array (an index is returned so that\n// caller can see that this is the default-gui-font whenever index 0 is returned). Returns -1\n// on error, but still sets *aColor to be the color name, if any was specified in aOptions.\n// To prevent a large number of font handles from being created (such as one for each control\n// that uses something other than GUI_DEFAULT_FONT), it seems best to conserve system resources\n// by creating new fonts only when called for. Therefore, this function will first check if\n// the specified font already exists within the array of fonts. If not found, a new font will\n// be added to the array.\n{\n\t// Set default output parameter in case of early return:\n\tif (aColor) // Caller wanted color returned in an output parameter.\n\t\t*aColor = CLR_NONE; // Because we want CLR_DEFAULT to indicate a real color.\n\n\tif (!*aOptions && !*aFontName)\n\t{\n\t\t// Relies on the fact that first item in the font array is always the default font.\n\t\t// If there are fonts, the default font should be the first one (index 0).\n\t\t// If not, we create it here:\n\t\tif (!sFontCount)\n\t\t{\n\t\t\t// sFont is created upon first use to conserve ~20 KB memory in non-GUI scripts.\n\t\t\tif ( !(sFont || (sFont = (FontType *)malloc(sizeof(FontType) * MAX_GUI_FONTS))) )\n\t\t\t\t// The allocation is small enough that failure would indicate it's unlikely the\n\t\t\t\t// program could continue for long, so it doesn't seem worth the added complication\n\t\t\t\t// to support recovering from this error:\n\t\t\t\tg_script.CriticalError(ERR_OUTOFMEM);\n\t\t\t// For simplifying other code sections, create an entry in the array for the default font\n\t\t\t// (GUI constructor relies on at least one font existing in the array).\n\t\t\t// Doesn't seem likely that DEFAULT_GUI_FONT face/size will change while a script is running,\n\t\t\t// or even while the system is running for that matter. I think it's always an 8 or 9 point\n\t\t\t// font regardless of desktop's appearance/theme settings.\n\t\t\t// MSDN: \"It is not necessary (but it is not harmful) to delete stock objects by calling DeleteObject.\"\n\t\t\tsFont[sFontCount].hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);\n\t\t\t// Get attributes of DEFAULT_GUI_FONT (name, size, etc.)\n\t\t\tFontGetAttributes(sFont[sFontCount]);\n\t\t\t++sFontCount;\n\t\t}\n\t\t// Tell caller to return to default color, since this is documented behavior when\n\t\t// returning to default font:\n\t\tif (aColor) // Caller wanted color returned in an output parameter.\n\t\t\t*aColor = CLR_DEFAULT;\n\t\treturn 0; // Always returns 0 since that is always the index of the default font.\n\t}\n\n\t// Otherwise, a non-default name/size, etc. is being requested. Find or create a font to match it.\n\tif (!aFoundationFont) // Caller didn't specify a font whose attributes should be used as default.\n\t{\n\t\tif (sFontCount > 0)\n\t\t\taFoundationFont = &sFont[0]; // Use default if it exists.\n\t\telse\n\t\t\treturn -1; // No error displayed since shouldn't happen if things are designed right.\n\t}\n\n\t// Copy the current default font's attributes into our local font structure.\n\t// The caller must ensure that mCurrentFontIndex array element exists:\n\tFontType font = *aFoundationFont;\n\tif (*aFontName)\n\t\ttcslcpy(font.lfFaceName, aFontName, _countof(font.lfFaceName));\n\tCOLORREF color = CLR_NONE; // Because we want to treat CLR_DEFAULT as a real color.\n\n\tint point_size = 0;\n\n\tTCHAR option[MAX_NUMBER_SIZE + 1];\n\tLPCTSTR next_option, option_end;\n\tfor (next_option = aOptions; *(next_option = omit_leading_whitespace(next_option)); next_option = option_end)\n\t{\n\t\t// Find the end of this option item:\n\t\tfor (option_end = next_option; *option_end && !IS_SPACE_OR_TAB(*option_end); ++option_end);\n\n\t\t// Make a copy to simplify comparisons below.\n\t\ttcslcpy(option, next_option, min((option_end - next_option) + 1, _countof(option)));\n\n\t\tif (!_tcsicmp(option, _T(\"Bold\")))\n\t\t\tfont.lfWeight = FW_BOLD;\n\t\telse if (!_tcsicmp(option, _T(\"italic\")))\n\t\t\tfont.lfItalic = true;\n\t\telse if (!_tcsicmp(option, _T(\"norm\")))\n\t\t{\n\t\t\tfont.lfItalic = false;\n\t\t\tfont.lfUnderline = false;\n\t\t\tfont.lfStrikeOut = false;\n\t\t\tfont.lfWeight = FW_NORMAL;\n\t\t}\n\t\telse if (!_tcsicmp(option, _T(\"underline\")))\n\t\t\tfont.lfUnderline = true;\n\t\telse if (!_tcsicmp(option, _T(\"strike\")))\n\t\t\tfont.lfStrikeOut = true;\n\t\telse\n\t\t{\n\t\t\t// All of the remaining options are single-letter followed by a value:\n\t\t\tTCHAR option_char = ctoupper(*option);\n\t\t\tLPTSTR option_value = option + 1;\n\t\t\tif (!*option_value // Does not have a value.\n\t\t\t\t|| _tcschr(_T(\"SWQ\"), option_char) // Or is a specific option...\n\t\t\t\t&& !IsNumeric(option_value, FALSE, FALSE, TRUE)) // and does not have a number.\n\t\t\t\tgoto invalid_option;\n\n\t\t\tswitch (option_char)\n\t\t\t{\n\t\t\tcase 'C':\n\t\t\t\tif (!ColorToBGR(option_value, color))\n\t\t\t\t\tgoto invalid_option;\n\t\t\t\tbreak;\n\t\t\tcase 'W': font.lfWeight = ATOI(option_value); break;\n\t\t\tcase 'S': point_size = (int)(_tstof(option_value) + 0.5); break; // Round to nearest int.\n\t\t\tcase 'Q': font.lfQuality = ATOI(option_value); break;\n\t\t\tdefault: goto invalid_option;\n\t\t\t}\n\t\t}\n\t}\n\n\tif (aColor) // Caller wanted color returned in an output parameter.\n\t\t*aColor = color;\n\n\tHDC hdc = GetDC(HWND_DESKTOP);\n\t// Fetch the value every time in case it can change while the system is running (e.g. due to changing\n\t// display to TV-Out, etc).\n\tint pixels_per_point_y = GetDeviceCaps(hdc, LOGPIXELSY);\n\t\n\t// MulDiv() is usually better because it has automatic rounding, getting the target font\n\t// closer to the size specified. This must be done prior to calling FindFont below:\n\tif (point_size)\n\t\tfont.lfHeight = -MulDiv(point_size, pixels_per_point_y, 72);\n\n\t// The reason it's done this way is that CreateFont() does not always (ever?) fail if given a\n\t// non-existent typeface:\n\tif (!FontExist(hdc, font.lfFaceName)) // Fall back to foundation font's type face, as documented.\n\t\t_tcscpy(font.lfFaceName, aFoundationFont ? aFoundationFont->lfFaceName : sFont[0].lfFaceName);\n\n\tReleaseDC(HWND_DESKTOP, hdc);\n\n\t// Now that the attributes of the requested font are known, see if such a font already\n\t// exists in the array:\n\tint font_index = FindFont(font);\n\tif (font_index != -1) // Match found.\n\t\treturn font_index;\n\n\t// Since above didn't return, create the font if there's room.\n\tif (sFontCount >= MAX_GUI_FONTS)\n\t{\n\t\tg_script.ScriptError(_T(\"Too many fonts.\")); // Short msg since so rare.\n\t\treturn -1;\n\t}\n\t\n\t// Set these parameters to defaults to ensure consistent results:\n\tfont.lfWidth = 0;\n\tfont.lfEscapement = 0;\n\tfont.lfOrientation = 0;\n\tfont.lfCharSet = DEFAULT_CHARSET;\n\tfont.lfOutPrecision = OUT_TT_PRECIS;\n\tfont.lfClipPrecision = CLIP_DEFAULT_PRECIS;\n\tfont.lfPitchAndFamily = FF_DONTCARE;\n\t\n\tif ( !(font.hfont = CreateFontIndirect(&font)) )\n\t{\n\t\tg_script.ScriptError(_T(\"Can't create font.\")); // Short msg since so rare.\n\t\treturn -1;\n\t}\n\n\tsFont[sFontCount++] = font; // Copy the newly created font's attributes into the next array element.\n\treturn sFontCount - 1; // The index of the newly created font.\n\n\t// This \"subroutine\" is used to reduce code size:\ninvalid_option:\n\tValueError(ERR_INVALID_OPTION, next_option, FAIL);\n\treturn -1;\n}\n\n\n\nvoid GuiType::FontGetAttributes(FontType &aFont)\n{\n\tGetObject(aFont.hfont, sizeof(LOGFONT), &aFont);\n}\n\n\n\nint GuiType::FindFont(FontType &aFont)\n{\n\tfor (int i = 0; i < sFontCount; ++i)\n\t\tif (!_tcsicmp(sFont[i].lfFaceName, aFont.lfFaceName) // lstrcmpi() is not used: 1) avoids breaking existing scripts; 2) provides consistent behavior across multiple locales.\n\t\t\t&& sFont[i].lfHeight == aFont.lfHeight // There's no risk of mismatch between cell height (positive) and character height (negative), since we always set it to the latter.\n\t\t\t&& sFont[i].lfWeight == aFont.lfWeight\n\t\t\t&& sFont[i].lfItalic == aFont.lfItalic\n\t\t\t&& sFont[i].lfUnderline == aFont.lfUnderline\n\t\t\t&& sFont[i].lfStrikeOut == aFont.lfStrikeOut\n\t\t\t&& sFont[i].lfQuality == aFont.lfQuality) // Match found.\n\t\t\treturn i;\n\treturn -1; // Indicate failure.\n}\n\n\n\nLRESULT CALLBACK GuiWindowProc(HWND hWnd, UINT iMsg, WPARAM wParam, LPARAM lParam)\n{\n\t// If a message pump other than our own is running -- such as that of a dialog like MsgBox -- it will\n\t// dispatch messages directly here. This is detected by means of !g_CalledByIsDialogMessageOrDispatch.\n\t// Such messages need to be checked here because MsgSleep hasn't seen the message and thus hasn't\n\t// done the check. The value of g_CalledByIsDialogMessageOrDispatch only needs to be retained between\n\t// the IsDialog/DispatchMessage call that dispatches the message and this or a similar check.\n\tMSG *pmsg = nullptr;\n\tLRESULT msg_reply;\n\tif (g_CalledByIsDialogMessageOrDispatch && g_CalledByIsDialogMessageOrDispatch->message == iMsg)\n\t\tswap(pmsg, g_CalledByIsDialogMessageOrDispatch); // Suppress this one message, not any other messages that could be sent due to recursion.\n\telse if (g_MsgMonitor.Count() && MsgMonitor(hWnd, iMsg, wParam, lParam, NULL, msg_reply)) // Count is checked here to avoid function-call overhead.\n\t\treturn msg_reply; // MsgMonitor has returned \"true\", indicating that this message should be omitted from further processing.\n\t// Known limitation: If the above launched a thread but the thread didn't cause it to return,\n\t// and iMsg is something like AHK_GUI_ACTION that will be reposted via PostMessage(), the monitor\n\t// will be launched again when MsgSleep is called in conjunction with the repost. Given the rarity\n\t// and the minimal consequences of this, no extra code (such as passing a new parameter to MsgSleep)\n\t// is added to handle this.\n\n\tGuiType *pgui;\n\tGuiControlType *pcontrol;\n\tGuiIndexType control_index;\n\tbool text_color_was_changed;\n\tTCHAR buf[1024];\n\n\tpgui = GuiType::FindGui(hWnd);\n\tif (!pgui) // This avoids numerous checks below.\n\t\treturn DefDlgProc(hWnd, iMsg, wParam, lParam);\n\n\tif (pgui->mEvents.IsMonitoring(iMsg, GUI_EVENTKIND_MESSAGE))\n\t{\n\t\tif (pgui->MsgMonitor(nullptr, iMsg, wParam, lParam, pmsg, (INT_PTR*)&msg_reply))\n\t\t\treturn msg_reply;\n\t}\n\n\tswitch (iMsg)\n\t{\n\t//case WM_CREATE:\n\t\t// The DefDlgProc() call above is sufficient.\n\t\t// This case wouldn't be executed because FindGui() won't work until after CreateWindowEx() has returned.\n\t\t// If it ever becomes necessary, the GuiType pointer could be passed as lpParam of CreateWindowEx().\n\n\tcase WM_SIZE: // Listed first for performance.\n\t\tpgui->mIsMinimized = wParam == SIZE_MINIMIZED; // See \"case WM_SETFOCUS\" for comments.\n\t\tif (pgui->mStatusBarHwnd)\n\t\t\t// Send the msg even if the bar is hidden because the OS typically knows not to do extra drawing work for\n\t\t\t// hidden controls. In addition, when the bar is shown again, it might be the wrong size if this isn't done.\n\t\t\t// Known/documented limitation: In spite of being in the right z-order position, any control that\n\t\t\t// overlaps the status bar might sometimes get drawn on top of it.\n\t\t\tSendMessage(pgui->mStatusBarHwnd, WM_SIZE, wParam, lParam); // It apparently ignores wParam and lParam, but just in case send it the actuals.\n\t\tswitch (wParam)\n\t\t{\n\t\tcase SIZE_RESTORED: wParam = 0; break;\n\t\tcase SIZE_MAXIMIZED: wParam = 1; break;\n\t\tcase SIZE_MINIMIZED: wParam = -1; break;\n\t\t//default:\n\t\t// Note that SIZE_MAXSHOW/SIZE_MAXHIDE don't seem to ever be received under the conditions\n\t\t// described at MSDN, even if the window has WS_POPUP style. They are probably relics from\n\t\t// 16-bit Windows. For simplicity (and because the window may have actually been resized)\n\t\t// let wParam have its current (unexpected) value, if that's ever possible.\n\t\t}\n\t\t// probably never contain those values, and as a result they are not documented in the help file.\n\t\tif (pgui->IsMonitoring(GUI_EVENT_RESIZE))\n\t\t\tPOST_AHK_GUI_ACTION(hWnd, NO_CONTROL_INDEX, MAKEWORD(GUI_EVENT_RESIZE, wParam), lParam);\n\t\t\t// MsgSleep() is not done because \"case AHK_GUI_ACTION\" in GuiWindowProc() takes care of it.\n\t\t\t// See its comments for why.\n\t\treturn 0; // \"If an application processes this message, it should return zero.\"\n\t\t// Testing shows that the window still resizes correctly (controls are revealed as the window\n\t\t// is expanded) even if the event isn't passed on to the default proc.\n\n\tcase WM_GETMINMAXINFO: // Added for v1.0.44.13.\n\t{\n\t\tMINMAXINFO &mmi = *(LPMINMAXINFO)lParam;\n\t\tif (pgui->mMinWidth >= 0) // This check covers both COORD_UNSPECIFIED and COORD_CENTERED.\n\t\t\tmmi.ptMinTrackSize.x = pgui->mMinWidth;\n\t\tif (pgui->mMinHeight >= 0)\n\t\t\tmmi.ptMinTrackSize.y = pgui->mMinHeight;\n\t\t// mmi.ptMaxSize.x/y aren't changed because it seems the OS automatically uses ptMaxTrackSize\n\t\t// for them, at least when ptMaxTrackSize is smaller than the system's default for mmi.ptMaxSize.\n\t\tif (pgui->mMaxWidth >= 0)\n\t\t{\n\t\t\tmmi.ptMaxTrackSize.x = pgui->mMaxWidth;\n\t\t\t// If the user applies a MaxSize less than MinSize, MinSize appears to take precedence except\n\t\t\t// that the window behaves oddly when dragging the left or top edge outward. This adjustment\n\t\t\t// removes the odd behaviour but does not visibly affect the size limits. The user-specified\n\t\t\t// MaxSize and MinSize are retained, so applying -MinSize lets MaxSize take effect.\n\t\t\tif (mmi.ptMaxTrackSize.x < mmi.ptMinTrackSize.x)\n\t\t\t\tmmi.ptMaxTrackSize.x = mmi.ptMinTrackSize.x;\n\t\t}\n\t\tif (pgui->mMaxHeight >= 0)\n\t\t{\n\t\t\tmmi.ptMaxTrackSize.y = pgui->mMaxHeight;\n\t\t\tif (mmi.ptMaxTrackSize.y < mmi.ptMinTrackSize.y) // See above for comments.\n\t\t\t\tmmi.ptMaxTrackSize.y = mmi.ptMinTrackSize.y;\n\t\t}\n\t\treturn 0; // \"If an application processes this message, it should return zero.\"\n\t}\n\n\tcase WM_COMMAND:\n\t{\n\t\tint id = LOWORD(wParam);\n\t\t// For maintainability, this is checked first because \"code\" (the HIWORD) is sometimes or always 0,\n\t\t// which falsely indicates that the message is from a menu:\n\t\tif (id == IDCANCEL) // IDCANCEL is a special Control ID. The user pressed esc.\n\t\t{\n\t\t\t// Known limitation:\n\t\t\t// Example:\n\t\t\t//Gui, Add, Text,, Gui1\n\t\t\t//Gui, Add, Text,, Gui2\n\t\t\t//Gui, Show, w333\n\t\t\t//GuiControl, Disable, Gui1\n\t\t\t//return\n\t\t\t//\n\t\t\t//GuiEscape:\n\t\t\t//MsgBox GuiEscape\n\t\t\t//return\n\t\t\t// It appears that in cases like the above, the OS doesn't send the WM_COMMAND+IDCANCEL message\n\t\t\t// to the program when you press Escape. Although it could be fixed by having the escape keystroke\n\t\t\t// unconditionally call the GuiEscape label, that might break existing features and scripts that\n\t\t\t// rely on escape's ability to perform other functions in a window. \n\t\t\t// I'm not sure whether such functions exist and how many of them there are. Examples might include\n\t\t\t// using escape to close a menu, drop-list, or other pop-up attribute of a control inside the window.\n\t\t\t// Escape also cancels a user's drag-move of the window (restoring the window to its pre-drag location).\n\t\t\t// If pressing escape were to unconditionally call the GuiEscape label, features like these might be\n\t\t\t// broken. So currently this behavior is documented in the help file as a known limitation.\n\t\t\tpgui->Escape();\n\t\t\treturn 0; // Might be necessary to prevent auto-window-close.\n\t\t\t// Note: It is not necessary to check for IDOK because:\n\t\t\t// 1) If there is no default button, the IDOK message is ignored.\n\t\t\t// 2) If there is a default button, we should never receive IDOK because BM_SETSTYLE (sent earlier)\n\t\t\t// will have altered the message we receive to be the ID of the actual default button.\n\t\t}\n\t\t// Since above didn't return:\n\t\tif (id >= ID_USER_FIRST)\n\t\t{\n\t\t\t// Since all control id's are less than ID_USER_FIRST, this message is either\n\t\t\t// a user defined menu item ID or a bogus message due to it corresponding to\n\t\t\t// a non-existent menu item or a main/tray menu item (which should never be\n\t\t\t// received or processed here).\n\t\t\tHandleMenuItem(hWnd, id, pgui->mHwnd);\n\t\t\treturn 0; // Indicate fully handled.\n\t\t}\n\t\t// Otherwise id should contain the ID of an actual control. Validate that in case of bogus msg.\n\t\t// Perhaps because this is a DialogProc rather than a WindowProc, the following does not appear\n\t\t// to be true: MSDN: \"The high-order word [of wParam] specifies the notification code if the message\n\t\t// is from a control. If the message is from an accelerator, [high order word] is 1. If the message\n\t\t// is from a menu, [high order word] is zero.\"\n\t\tGuiIndexType control_index = GUI_ID_TO_INDEX(id); // Convert from ID to array index. Relies on unsigned to flag as out-of-bounds.\n\t\tif (control_index < pgui->mControlCount // Relies on short-circuit boolean order.\n\t\t\t&& pgui->mControl[control_index]->hwnd == (HWND)lParam) // Handles match (this filters out bogus msgs).\n\t\t\tpgui->Event(control_index, HIWORD(wParam), GUI_EVENT_WM_COMMAND);\n\t\t\t// v1.0.35: And now pass it on to DefDlgProc() in case it needs to see certain types of messages.\n\t\tbreak;\n\t}\n\n\tcase WM_SYSCOMMAND:\n\t\tif (wParam == SC_CLOSE)\n\t\t{\n\t\t\tpgui->Close();\n\t\t\treturn 0;\n\t\t}\n\t\tbreak;\n\n\tcase WM_NOTIFY:\n\t{\n\t\tNMHDR &nmhdr = *(LPNMHDR)lParam;\n\t\tif (!nmhdr.idFrom)\n\t\t{\n\t\t\t// This might be the header of a ListView control. Although there may be some\n\t\t\t// risk of notification codes being ambiguous for custom controls (between the\n\t\t\t// actual control and any child controls), the ability to monitor a ListView's\n\t\t\t// header notifications seems useful enough to justify the risk.\n\t\t\tcontrol_index = pgui->FindControlIndex(nmhdr.hwndFrom);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tcontrol_index = (GuiIndexType)GUI_ID_TO_INDEX(nmhdr.idFrom); // Convert from ID to array index. Relies on unsigned to flag as out-of-bounds.\n\t\t}\n\t\tif (control_index >= pgui->mControlCount)\n\t\t\tbreak; // Invalid to us, but perhaps meaningful DefDlgProc(), so let it handle it.\n\t\tGuiControlType &control = *pgui->mControl[control_index]; // For performance and convenience.\n\t\tif (control.hwnd != nmhdr.hwndFrom && nmhdr.idFrom) // Ensure handles match (this filters out bogus msgs).\n\t\t\tbreak;\n\n\t\tINT_PTR retval;\n\t\tif (pgui->ControlWmNotify(control, &nmhdr, retval))\n\t\t\t// A handler was found for this notification and it returned a value.\n\t\t\treturn retval;\n\n\t\tUINT_PTR event_info = NO_EVENT_INFO; // Set default, to be possibly overridden below.\n\t\tUSHORT gui_event = GUI_EVENT_NONE;\n\t\tbool explicitly_return_true = false;\n\n\t\tswitch (control.type)\n\t\t{\n\t\t/////////////////////\n\t\t// LISTVIEW WM_NOTIFY\n\t\t/////////////////////\n\t\tcase GUI_CONTROL_LISTVIEW:\n\t\t\tswitch (nmhdr.code)\n\t\t\t{\n\t\t\t// MSDN: LVN_HOTTRACK: \"Return zero to allow the list view to perform its normal track select processing.\"\n\t\t\t// Also, LVN_HOTTRACK is listed first for performance since it arrives far more often than any other notification.\n\t\t\tcase LVN_HOTTRACK: // v1.0.36.04: No longer an event because it occurs so often: Due to single-thread limit, it was decreasing the reliability of AltSubmit ListViews' receipt of other events such as \"I\", such as Toralf's Icon Viewer.\n\t\t\tcase NM_CUSTOMDRAW: // Return CDRF_DODEFAULT (0). Occurs for every redraw, such as mouse cursor sliding over control or window activation.\n\t\t\tcase LVN_ITEMCHANGING: // Not yet supported (seems rarely needed), so always allow the change by returning 0 (FALSE).\n\t\t\tcase LVN_INSERTITEM: // Any ways other than ListView_InsertItem() to insert items?\n\t\t\tcase LVN_DELETEITEM: // Might be received for each individual (non-DeleteAll) deletion).\n\t\t\tcase LVN_GETINFOTIPW: // v1.0.44: Received even without LVS_EX_INFOTIP?. In any case, there's currently no point\n\t\t\tcase LVN_GETINFOTIPA: // in notifying the script because it would have no means of changing the tip (by altering the struct), except perhaps OnMessage.\n\t\t\t\treturn 0; // Return immediately to avoid calling Event() and DefDlgProc(). A return value of 0 is suitable for all of the above.\n\n\t\t\tcase LVN_ITEMCHANGED:\n\t\t\t{\n\t\t\t\t// This is received for selection/deselection, which means clicking a new item generates\n\t\t\t\t// at least two of them (in practice, it generates between 1 and 3 but not sure why).\n\t\t\t\t// It's also received for checking/unchecking an item. Extending a selection via Shift-ArrowKey\n\t\t\t\t// generates between 1 and 3 of them, perhaps at random? Maybe all we can count on is that you\n\t\t\t\t// get at least one when the selection has changed or a box is (un)checked.\n\t\t\t\tNMLISTVIEW &lv = *(LPNMLISTVIEW)lParam;\n\t\t\t\tevent_info = 1 + lv.iItem; // MSDN: If iItem is -1, the change has been applied to all items in the list view.\n\n\t\t\t\t// Although the OS sometimes generates focus+select together, that's only when the focus is\n\t\t\t\t// moving and selecting a single item; i.e. not by Ctrl/Shift and the mouse or arrow keys.\n\t\t\t\t// Also, de-focus and de-select seem to always be separate.\n\t\t\t\tUINT newly_changed = lv.uNewState ^ lv.uOldState; // uChanged doesn't seem accurate: it's always 8? So derive the \"correct\" value of which flags have actually changed.\n\t\t\t\tUINT newly_on = newly_changed & lv.uNewState;\n\t\t\t\tUINT newly_off = newly_changed & lv.uOldState;\n\t\t\t\t\n\t\t\t\t// If the focus and selection is changed with Shift and the arrow keys, the control sends the\n\t\t\t\t// selection change first, then focus change. So for consistency, report the selection change\n\t\t\t\t// first when the notification includes both.\n\t\t\t\tif (newly_changed & LVIS_SELECTED)\n\t\t\t\t\t// Pass the new selected state in the second byte of the event code. Passing 1 or 2 vs. boolean allows shared handling for ITEMSELECT and ITEMCHECK.\n\t\t\t\t\tpgui->Event(control_index, 0, GUI_EVENT_ITEMSELECT | ((newly_on & LVIS_SELECTED) ? 0x200 : 0x100), event_info);\n\n\t\t\t\tif (newly_on & LVIS_FOCUSED)\n\t\t\t\t\tpgui->Event(control_index, 0, GUI_EVENT_ITEMFOCUS, event_info);\n\n\t\t\t\tif (newly_changed & LVIS_STATEIMAGEMASK) // State image changed.\n\t\t\t\t{\n\t\t\t\t\tif (lv.uOldState & LVIS_STATEIMAGEMASK) // Image is changing from a non-blank image to a different non-blank image.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Pass the new state image index in the second byte of the event code.\n\t\t\t\t\t\t// If the control has checkboxes, these will be 1 (unchecked) or 2 (checked),\n\t\t\t\t\t\t// but doing it this way provides extra utility in case of other state images.\n\t\t\t\t\t\tpgui->Event(control_index, 0, GUI_EVENT_ITEMCHECK | ((lv.uNewState & LVIS_STATEIMAGEMASK) >> 4), event_info);\n\t\t\t\t\t}\n\t\t\t\t\t//else state image changed from blank/none to some new image. Omit this event because it seems to do more harm than good in 99% of cases (especially since it typically only occurs when the script calls LV_Add/Insert).\n\t\t\t\t}\n\t\t\t\treturn 0; // All recognised events for this notification have been handled above.\n\t\t\t}\n\n\t\t\tcase NM_SETFOCUS: gui_event = GUI_EVENT_FOCUS; break;\n\t\t\tcase NM_KILLFOCUS: gui_event = GUI_EVENT_LOSEFOCUS; break;\n\n\t\t\tcase LVN_KEYDOWN:\n\t\t\t\tif (((LPNMLVKEYDOWN)lParam)->wVKey == VK_F2 && !(control.attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR)) // WantF2 is in effect.\n\t\t\t\t{\n\t\t\t\t\tint focused_index = ListView_GetNextItem(control.hwnd, -1, LVNI_FOCUSED);\n\t\t\t\t\tif (focused_index != -1)\n\t\t\t\t\t\tSendMessage(control.hwnd, LVM_EDITLABEL, focused_index, 0); // Has no effect if the control is read-only.\n\t\t\t\t}\n\t\t\t\tbreak;\n\n\t\t\t// When alt-submit mode isn't in effect, it seems best to ignore all clicks except double-clicks, since\n\t\t\t// right-click should normally be handled via GuiContenxtMenu instead (to allow AppsKey to work, etc.);\n\t\t\t// and since left-clicks can be used to extend a selection (ctrl-click or shift-click), so are pretty\n\t\t\t// vague events that most scripts probably wouldn't have explicit handling for. A script that needs\n\t\t\t// to know when the selection changes can turn on AltSubmit to catch a wide variety of ways the\n\t\t\t// selection can change, the most all-encompassing of which is probably LVN_ITEMCHANGED.\n\t\t\tcase NM_CLICK:\n\t\t\t\t// v1.0.36.03: For NM_CLICK/NM_RCLICK, it's somewhat debatable to set event_info when the\n\t\t\t\t// ListView isn't single-select, but the usefulness seems to outweigh any confusion it might cause.\n\t\t\t\tgui_event = GUI_EVENT_CLICK;\n\t\t\t\tevent_info = 1 + ((LPNMITEMACTIVATE)lParam)->iItem;\n\t\t\t\tbreak;\n\t\t\tcase NM_RCLICK:\n\t\t\tcase NM_RDBLCLK:\n\t\t\t\tgui_event = GUI_EVENT_CONTEXTMENU;\n\t\t\t\tevent_info = 1 + ((LPNMITEMACTIVATE)lParam)->iItem;\n\t\t\t\t// Post the event unconditionally rather than calling Event(), so that the Gui's\n\t\t\t\t// ContextMenu handler can be called even if the control doesn't have one:\n\t\t\t\tPOST_AHK_GUI_ACTION(pgui->mHwnd, control_index, gui_event, event_info);\n\t\t\t\treturn TRUE; // To prevent a second ContextMenu event (which would lack the row number).\n\t\t\tcase NM_DBLCLK:\n\t\t\t\tgui_event = GUI_EVENT_DBLCLK;\n\t\t\t\tevent_info = 1 + ((LPNMITEMACTIVATE)lParam)->iItem;\n\t\t\t\tbreak;\n\n\t\t\tcase LVN_COLUMNCLICK:\n\t\t\t{\n\t\t\t\tgui_event = GUI_EVENT_COLCLK;\n\t\t\t\tNMLISTVIEW &lv = *(LPNMLISTVIEW)lParam;\n\t\t\t\tevent_info = 1 + lv.iSubItem; // The one-based column number that was clicked.\n\t\t\t\t// The following must be done here rather than in Event() in case the control has no g-label:\n\t\t\t\tif (!(control.union_lv_attrib->no_auto_sort)) // Automatic sorting is in effect.\n\t\t\t\t\tGuiType::LV_Sort(control, lv.iSubItem, true); // -1 to convert column index back to zero-based.\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\t// ItemEdit: It's seems more useful to filter out canceled edits by default, since\n\t\t\t// most scripts probably aren't interested in begin-edit and therefore would not be\n\t\t\t// expecting an end-edit without actual change. On top of begin-edit being rarely\n\t\t\t// needed, it seems best to require the script to use OnNotify() for it because it\n\t\t\t// might help avoid the case where script makes a change in response to begin-edit\n\t\t\t// but then fails to revert it because the user canceled. OnNotify() also allows\n\t\t\t// the script to indicate which rows are editable or which edits to accept.\n\t\t\t//case LVN_BEGINLABELEDITW: // Received even for non-Unicode apps, at least on XP. Even so, the text contained it the struct is apparently always ANSI vs. Unicode.\n\t\t\t//case LVN_BEGINLABELEDITA: // Never received, at least not on XP?\n\t\t\t//\tgui_event = 'E';\n\t\t\t//\tevent_info = 1 + ((NMLVDISPINFO *)lParam)->item.iItem;\n\t\t\t//\tbreak;\n\t\t\tcase LVN_ENDLABELEDITW: // See comment above.\n\t\t\tcase LVN_ENDLABELEDITA:\n\t\t\t\tif (!((NMLVDISPINFO *)lParam)->item.pszText) // Edit was cancelled (no change made).\n\t\t\t\t\t// Unless the script also subscribes to LVN_BEGINLABELEDIT (unlikely), it's very\n\t\t\t\t\t// unlikely that a script will want to know when a user has entered edit mode and\n\t\t\t\t\t// then canceled without actually changing the item.\n\t\t\t\t\tbreak;\n\t\t\t\tgui_event = GUI_EVENT_ITEMEDIT;\n\t\t\t\tevent_info = 1 + ((NMLVDISPINFO *)lParam)->item.iItem;\n\t\t\t\t// Must return TRUE explicitly because apparently DefDlgProc() would return FALSE,\n\t\t\t\t// which would cause the change to be rejected:\n\t\t\t\texplicitly_return_true = true;\n\t\t\t\tbreak;\n\n\t\t\tcase LVN_DELETEALLITEMS:\n\t\t\t\treturn TRUE; // For performance, tell it not to notify us as each individual item is deleted.\n\t\t\t} // switch(nmhdr.code).\n\t\t\tbreak;\n\n\t\t/////////////////////\n\t\t// TREEVIEW WM_NOTIFY\n\t\t/////////////////////\n\t\tcase GUI_CONTROL_TREEVIEW:\n\t\t\tswitch (nmhdr.code)\n\t\t\t{\n\t\t\tcase NM_SETCURSOR: // Received very often, every time the mouse moves while over the control.\n\t\t\tcase NM_CUSTOMDRAW: // Return CDRF_DODEFAULT (0). Occurs for every redraw, such as mouse cursor sliding over control or window activation.\n\t\t\tcase TVN_DELETEITEMW:\n\t\t\tcase TVN_DELETEITEMA:\n\t\t\t// TVN_SELCHANGING, TVN_ITEMEXPANDING, and TVN_SINGLEEXPAND are not reported to the script as events\n\t\t\t// because there is currently no support for vetoing the selection-change or expansion; plus these\n\t\t\t// notifications each have an \"-ED\" counterpart notification that is reported to the script (even\n\t\t\t// TVN_SINGLEEXPAND is followed by a TVN_ITEMEXPANDED notification).\n\t\t\tcase TVN_SELCHANGINGW: // Received even for non-Unicode apps, at least on XP.\n\t\t\tcase TVN_SELCHANGINGA:\n\t\t\tcase TVN_ITEMEXPANDINGW: // Received even for non-Unicode apps, at least on XP.\n\t\t\tcase TVN_ITEMEXPANDINGA:\n\t\t\tcase TVN_SINGLEEXPAND: // Note that TVNRET_DEFAULT==0. This is received only when style contains TVS_SINGLEEXPAND.\n\t\t\tcase TVN_GETINFOTIPA: // Received when TVS_INFOTIP is present. However, there's currently no point\n\t\t\tcase TVN_GETINFOTIPW: // in notifying the script because it would have no means of changing the tip (by altering the struct), except perhaps OnMessage.\n\t\t\t\treturn 0; // Return immediately to avoid calling Event() and DefDlgProc(). A return value of 0 is suitable for all of the above.\n\n\t\t\tcase TVN_SELCHANGEDW:\n\t\t\tcase TVN_SELCHANGEDA:\n\t\t\t\t// TreeViews are always single-select, so unlike ListView, each event always represents one\n\t\t\t\t// selection and (if there was a selection before) one deselection. It seems better to omit\n\t\t\t\t// the \"selected?\" parameter altogether than to always pass 1, so TreeView's ItemSelect is\n\t\t\t\t// like ListView's ItemFocus. Although focus and selection are the same for a TreeView,\n\t\t\t\t// it's probably best to stick with \"select\" because it's a more common term than \"focus\"\n\t\t\t\t// within the context of TreeView controls, and also for consistency with notifications/msgs\n\t\t\t\t// documented on MSDN (in case the user needs them).\n\t\t\t\tgui_event = GUI_EVENT_ITEMSELECT;\n\t\t\t\tevent_info = (UINT_PTR)((LPNMTREEVIEW)lParam)->itemNew.hItem;\n\t\t\t\tbreak;\n\n\t\t\tcase TVN_ITEMEXPANDEDW: // Received even for non-Unicode apps, at least on XP.\n\t\t\tcase TVN_ITEMEXPANDEDA:\n\t\t\t\t// The \"action\" flag is a bitwise value that should always contain either TVE_COLLAPSE or\n\t\t\t\t// TVE_EXPAND (testing shows that TVE_TOGGLE never occurs, as expected).\n\t\t\t\tgui_event = GUI_EVENT_ITEMEXPAND | ((((LPNMTREEVIEW)lParam)->action & TVE_EXPAND) ? 0x200 : 0x100);\n\t\t\t\t// It is especially important to store the HTREEITEM of this event for the TVS_SINGLEEXPAND style\n\t\t\t\t// because an item that wasn't even clicked on is collapsed to allow the new one to expand.\n\t\t\t\t// There might be no way to find out which item collapsed other than taking note of it here.\n\t\t\t\tevent_info = (UINT_PTR)((LPNMTREEVIEW)lParam)->itemNew.hItem;\n\t\t\t\tbreak;\n\n\t\t\tcase TVN_ITEMCHANGEDW:\n\t\t\tcase TVN_ITEMCHANGEDA:\n\t\t\t{\n\t\t\t\tNMTVITEMCHANGE &tv = *(NMTVITEMCHANGE*)lParam;\n\t\t\t\tif (tv.uChanged == TVIF_STATE && ((tv.uStateOld ^ tv.uStateNew) & TVIS_STATEIMAGEMASK)) // State image changed.\n\t\t\t\t{\n\t\t\t\t\t// Pass the new state image index in the second byte of the event code.\n\t\t\t\t\t// If the control has checkboxes, these will be 1 (unchecked) or 2 (checked),\n\t\t\t\t\t// but doing it this way provides extra utility in case of other state images.\n\t\t\t\t\tgui_event = GUI_EVENT_ITEMCHECK | ((tv.uStateNew & TVIS_STATEIMAGEMASK) >> 4);\n\t\t\t\t\tevent_info = (UINT)(size_t)tv.hItem;\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\t// ItemEdit: See comments in ListView section.\n\t\t\tcase TVN_BEGINLABELEDITW: // Received even for non-Unicode apps, at least on XP. Even so, the text contained it the struct is apparently always ANSI vs. Unicode.\n\t\t\tcase TVN_BEGINLABELEDITA: // Never received, at least not on XP?\n\t\t\t\t//gui_event = 'E';\n\t\t\t\t//event_info = (UINT_PTR)((LPNMTVDISPINFO)lParam)->item.hItem;\n\t\t\t\tGuiType::sTreeWithEditInProgress = control.hwnd;\n\t\t\t\tbreak;\n\t\t\tcase TVN_ENDLABELEDITW: // See comment above.\n\t\t\tcase TVN_ENDLABELEDITA:\n\t\t\t\tif (!((LPNMTVDISPINFO)lParam)->item.pszText) // Edit was cancelled (no change made).\n\t\t\t\t\t// Unless the script also subscribes to TVN_BEGINLABELEDIT (unlikely), it's very\n\t\t\t\t\t// unlikely that a script will want to know when a user has entered edit mode and\n\t\t\t\t\t// then canceled without actually changing the item.\n\t\t\t\t\tbreak;\n\t\t\t\tgui_event = GUI_EVENT_ITEMEDIT;\n\t\t\t\tevent_info = (UINT_PTR)((LPNMTVDISPINFO)lParam)->item.hItem;\n\t\t\t\tGuiType::sTreeWithEditInProgress = NULL;\n\t\t\t\t// Must return TRUE explicitly because apparently DefDlgProc() would return FALSE,\n\t\t\t\t// which would cause the change to be rejected:\n\t\t\t\texplicitly_return_true = true;\n\t\t\t\tbreak;\n\n\t\t\t// Since a left-click is just one method of changing selection (keyboard navigation is another),\n\t\t\t// it seems desirable for performance not to report such clicks except in alt-submit mode.\n\t\t\t// Similarly, right-clicks are reported only in alt-submit mode because GuiContextMenu should be used\n\t\t\t// to catch right-clicks (due to its additional handling for the AppsKey).\n\t\t\tcase NM_CLICK:\n\t\t\tcase NM_DBLCLK:\n\t\t\t//case NM_RCLICK: // Not handled because the default processing generates WM_CONTEXTMENU, which is what we want.\n\t\t\t//case NM_RDBLCLK: // As above, but NM_RDBLCLK is never actually generated by a TreeView (at least in some OS versions).\n\t\t\t\tswitch(nmhdr.code)\n\t\t\t\t{\n\t\t\t\tcase NM_CLICK: gui_event = GUI_EVENT_CLICK; break;\n\t\t\t\tcase NM_DBLCLK: gui_event = GUI_EVENT_DBLCLK; break;\n\t\t\t\t}\n\t\t\t\t// Since testing shows that none of the NMHDR members contains the HTREEITEM, must use\n\t\t\t\t// another method to discover it for the various mouse-click events.\n\t\t\t\tTVHITTESTINFO ht;\n\t\t\t\t// GetMessagePos() is used because it should be more accurate than GetCursorPos() in case a\n\t\t\t\t// the message was in the queue a long time. There is some concern due to GetMessagePos() being\n\t\t\t\t// documented to be valid only for GetMessage(): there's no certainty that all message pumps\n\t\t\t\t// (such as that of MsgBox) use GetMessage vs. PeekMessage, but its hard to imagine that\n\t\t\t\t// GetMessagePos() doesn't work for PeekMessage(). In any case, all message pumps by built-in\n\t\t\t\t// OS dialogs like MsgBox probably use GetMessage(). There's another concern: that this WM_NOTIFY\n\t\t\t\t// msg was sent (vs. posted) from our own thread somehow, in which case it never got queued so\n\t\t\t\t// GetMessagePos() might yield an inaccurate value. But until that is proven to be an actual\n\t\t\t\t// problem, it seems best to do it the \"correct\" way.\n\t\t\t\tDWORD pos;\n\t\t\t\tpos = GetMessagePos();\n\t\t\t\tht.pt.x = (short)LOWORD(pos);\n\t\t\t\tht.pt.y = (short)HIWORD(pos);\n\t\t\t\tScreenToClient(control.hwnd, &ht.pt);\n\t\t\t\tevent_info = (UINT_PTR)TreeView_HitTest(control.hwnd, &ht);\n\t\t\t\tbreak;\n\n\t\t\tcase NM_SETFOCUS: gui_event = GUI_EVENT_FOCUS; break;\n\t\t\tcase NM_KILLFOCUS: gui_event = GUI_EVENT_LOSEFOCUS; break;\n\n\t\t\tcase TVN_KEYDOWN:\n\t\t\t\tif (((LPNMTVKEYDOWN)lParam)->wVKey == VK_F2 && !(control.attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR)) // WantF2 is in effect.\n\t\t\t\t{\n\t\t\t\t\tHTREEITEM hitem;\n\t\t\t\t\tif (hitem = TreeView_GetSelection(control.hwnd))\n\t\t\t\t\t\tSendMessage(control.hwnd, TVM_EDITLABEL, 0, (LPARAM)hitem); // Has no effect if the control is read-only.\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t} // switch(nmhdr.code).\n\t\t\tbreak;\n\n\t\t//////////////////////\n\t\t// OTHER CONTROL TYPES\n\t\t//////////////////////\n\t\tcase GUI_CONTROL_DATETIME: // NMDATETIMECHANGE struct contains an NMHDR as it's first member.\n\t\t\t// Both MonthCal's year spinner (when year is clicked on) and DateTime's drop-down calendar\n\t\t\t// seem to start a new message pump. This is one of the reason things were redesigned to\n\t\t\t// avoid doing a MsgSleep(-1) after posting AHK_GUI_ACTION at the bottom of Event().\n\t\t\t// See its comments for details.\n\t\t\tswitch (nmhdr.code)\n\t\t\t{\n\t\t\tcase DTN_DATETIMECHANGE: gui_event = GUI_EVENT_CHANGE; break;\n\t\t\tcase NM_SETFOCUS: gui_event = GUI_EVENT_FOCUS; break;\n\t\t\tcase NM_KILLFOCUS: gui_event = GUI_EVENT_LOSEFOCUS; break;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_MONTHCAL:\n\t\t\t// Although the NMSELCHANGE notification struct contains the control's current date/time,\n\t\t\t// it simplifies the code to fetch it again (performance is probably good since the control\n\t\t\t// almost certainly just passes back a pointer to its self-maintained structs).\n\t\t\t// MCN_SELECT isn't used because it isn't sent when the user scrolls to a new month via the\n\t\t\t// calendar's arrow buttons, even though doing so sets a new date inside the control, or when\n\t\t\t// a new year or month is chosen by clicking directly on the month or year. MCN_SELCHANGE\n\t\t\t// seems to be superior in every way.\n\t\t\tif (nmhdr.code == MCN_SELCHANGE)\n\t\t\t\tgui_event = GUI_EVENT_CHANGE;\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_UPDOWN:\n\t\t\t// Now it just returns 0 for simplicity, but the following are kept for reference.\n\t\t\t//if (nmhdr.code == UDN_DELTAPOS) // No script control/intervention over this currently.\n\t\t\t//\treturn 0; // MSDN: \"Return nonzero to prevent the change in the control's position, or zero to allow the change.\"\n\t\t\t// Strangely, NM_RELEASEDCAPTURE never seems to be received. In fact, nothing other than\n\t\t\t// UDN_DELTAPOS is ever received. Therefore, WM_VSCROLL/WM_HSCROLL are relied upon instead.\n\t\t\treturn 0; // 0 is appropriate for all notifications in this case (no need to let DefDlgProc handle it).\n\n\t\tcase GUI_CONTROL_TAB:\n\t\t\tif (nmhdr.code == TCN_SELCHANGE)\n\t\t\t{\n\t\t\t\t// For code reduction and simplicity (and due to rarity of script needing it), A_EventInfo\n\t\t\t\t// is not set to the newly selected tab name (or number in the case of AltSubmit).\n\t\t\t\tpgui->ControlUpdateCurrentTab(control, true);\n\t\t\t\tgui_event = GUI_EVENT_CHANGE;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_LINK:\n\t\t\tif (nmhdr.code == NM_CLICK || nmhdr.code == NM_RETURN)\n\t\t\t{\n\t\t\t\tNMLINK &nmLink = *(PNMLINK)lParam;\n\t\t\t\tLITEM &item = nmLink.item;\n\t\t\t\t// If (and only if) the script is not monitoring the Click event,\n\t\t\t\t// attempt to execute the link's HREF attribute:\n\t\t\t\tif (*item.szUrl && !control.events.IsMonitoring(GUI_EVENT_CLICK))\n\t\t\t\t{\n\t\t\t\t\tg_script.ActionExec(item.szUrl, NULL, NULL, false);\n\t\t\t\t\treturn 0;\n\t\t\t\t}\n\t\t\t\tgui_event = GUI_EVENT_CLICK;\n\t\t\t\tevent_info = item.iLink + 1; // Convert to 1-based.\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_STATUSBAR:\n\t\t\tswitch(nmhdr.code)\n\t\t\t{\n\t\t\tcase NM_CLICK:\n\t\t\t\tgui_event = GUI_EVENT_CLICK;\n\t\t\t\t// Pass the one-based part number that was clicked. If the user clicked near the size grip,\n\t\t\t\t// apparently a large number is returned (at least on some OSes).\n\t\t\t\tevent_info = ((LPNMMOUSE)lParam)->dwItemSpec + 1;\n\t\t\t\tbreak;\n\t\t\tcase NM_DBLCLK:\n\t\t\t\tgui_event = GUI_EVENT_DBLCLK;\n\t\t\t\tevent_info = ((LPNMMOUSE)lParam)->dwItemSpec + 1;\n\t\t\t\tbreak;\n\t\t\tcase NM_RCLICK:\n\t\t\tcase NM_RDBLCLK:\n\t\t\t\t// Handling it here allows the ContextMenu event to receive the SB part number.\n\t\t\t\tgui_event = GUI_EVENT_CONTEXTMENU;\n\t\t\t\tevent_info = ((LPNMMOUSE)lParam)->dwItemSpec + 1;\n\t\t\t\t// Post the event unconditionally rather than calling Event(), so that the Gui's\n\t\t\t\t// ContextMenu handler can be called even if the control doesn't have one:\n\t\t\t\tPOST_AHK_GUI_ACTION(pgui->mHwnd, control_index, gui_event, event_info);\n\t\t\t\treturn TRUE; // To prevent a second ContextMenu event (which would lack the part number).\n\t\t\t} // switch(nmhdr.code)\n\t\t} // switch(control.type) within case WM_NOTIFY.\n\n\t\t// Raise any event identified above.\n\t\tif (gui_event)\n\t\t{\n\t\t\tpgui->Event(control_index, nmhdr.code, gui_event, event_info);\n\t\t\tif (explicitly_return_true)\n\t\t\t\treturn TRUE;\n\t\t}\n\n\t\tbreak; // outermost switch()\n\t}\n\n\tcase WM_VSCROLL: // These two should only be received for sliders and up-downs.\n\tcase WM_HSCROLL:\n\t\tpgui->Event(GUI_HWND_TO_INDEX((HWND)lParam), LOWORD(wParam), GUI_EVENT_NONE, HIWORD(wParam));\n\t\treturn 0; // \"If an application processes this message, it should return zero.\"\n\t\n\t//case WM_ERASEBKGND:\n\t//\tif (!pgui->mBackgroundBrushWin) // Let default proc handle it.\n\t//\t\tbreak;\n\t//\t// Can't use SetBkColor(), need an real brush to fill it.\n\t//\tGetClipBox((HDC)wParam, &rect);\n\t//\tFillRect((HDC)wParam, &rect, pgui->mBackgroundBrushWin);\n\t//\treturn 1; // \"An application should return nonzero if it erases the background.\"\n\n\t// The below seems to be the equivalent of the above (but MSDN indicates it will only work\n\t// if there is no WM_ERASEBKGND handler). It might perform a little better.\n\tcase WM_CTLCOLORDLG:\n\t\tif (!pgui->mBackgroundBrushWin) // Let default proc handle it.\n\t\t\tbreak;\n\t\tSetBkColor((HDC)wParam, pgui->mBackgroundColorWin);\n\t\treturn (LRESULT)pgui->mBackgroundBrushWin;\n\n\t// It seems that scrollbars belong to controls (such as Edit and ListBox) do not send us\n\t// WM_CTLCOLORSCROLLBAR (unlike the static messages we receive for radio and checkbox).\n\t// Therefore, this section is commented out since it has no effect (it might be useful\n\t// if a control's class window-proc is ever overridden with a new proc):\n\t//case WM_CTLCOLORSCROLLBAR:\n\t//\tif (pgui->mBackgroundBrushWin)\n\t//\t{\n\t//\t\t// Since we're processing this msg rather than passing it on to the default proc, must set\n\t//\t\t// background color unconditionally, otherwise plain white will likely be used:\n\t//\t\tSetTextColor((HDC)wParam, pgui->mBackgroundColorWin);\n\t//\t\tSetBkColor((HDC)wParam, pgui->mBackgroundColorWin);\n\t//\t\t// Always return a real HBRUSH so that Windows knows we altered the HDC for it to use:\n\t//\t\treturn (LRESULT)pgui->mBackgroundBrushWin;\n\t//\t}\n\t//\tbreak;\n\n\tcase WM_CTLCOLORSTATIC:\n\tcase WM_CTLCOLORLISTBOX:\n\tcase WM_CTLCOLOREDIT:\n\tcase WM_CTLCOLORBTN:\n\t\t// MSDN: Buttons with the BS_PUSHBUTTON, BS_DEFPUSHBUTTON, or BS_PUSHLIKE styles do not use the\n\t\t// returned brush. Buttons with these styles are always drawn with the default system colors.\n\t\t// This is because \"drawing push buttons requires several different brushes-face, highlight and\n\t\t// shadow\". In short, to provide a custom appearance for push buttons, use an owner-drawn button.\n\t\t// Thus, WM_CTLCOLORBTN not handled here because it doesn't seem to have any effect on the\n\t\t// types of buttons used so far. This has been confirmed: Even when a theme is in effect,\n\t\t// checkboxes, radios, and groupboxes do not receive WM_CTLCOLORBTN, but they do receive\n\t\t// WM_CTLCOLORSTATIC.\n\t\tif ( !(pcontrol = pgui->FindControl((HWND)lParam)) )\n\t\t\tbreak;\n\t\tif (text_color_was_changed = (pcontrol->type != GUI_CONTROL_PIC && pcontrol->union_color != CLR_DEFAULT))\n\t\t\tSetTextColor((HDC)wParam, pcontrol->union_color);\n\t\telse\n\t\t\t// Always set a text color in case a brush will be returned below. If this isn't done and\n\t\t\t// a brush is returned, the system will use whatever color was set before; probably black.\n\t\t\tSetTextColor((HDC)wParam, GetSysColor(COLOR_WINDOWTEXT));\n\n\t\tif (pcontrol->background_color == CLR_TRANSPARENT)\n\t\t{\n\t\t\tSetBkMode((HDC)wParam, TRANSPARENT);\n\t\t\treturn (LRESULT)GetStockObject(NULL_BRUSH);\n\t\t}\n\n\t\tHBRUSH bk_brush;\n\t\tCOLORREF bk_color;\n\t\tbool use_bg_color;\n\t\t// Use mBackgroundColorWin only for specific controls that have no apparent frame.\n\t\t// WM_CTLCOLORSTATIC can be received for Edit, DDL/ComboBox and TreeView (-Theme)\n\t\t// controls when they are disabled, but we use system default colors (or the\n\t\t// control's own background) in those cases for the following reasons:\n\t\t// - Consistency with ListBox, Hotkey, DateTime, MonthCal and ListView.\n\t\t// - TreeView looks bad (item backgrounds don't match the control).\n\t\t// - To match the control's text, which usually takes on the \"disabled\" color.\n\t\tuse_bg_color = iMsg == WM_CTLCOLORSTATIC && pcontrol->UsesGuiBgColor();\n\t\tpgui->ControlGetBkColor(*pcontrol, use_bg_color, bk_brush, bk_color);\n\t\t\n\t\tif (bk_brush)\n\t\t{\n\t\t\t// Since we're processing this msg rather than passing it on to the default proc, must set\n\t\t\t// background color unconditionally, otherwise plain white will likely be used:\n\t\t\tSetBkColor((HDC)wParam, bk_color);\n\t\t\t// Always return a real HBRUSH so that Windows knows we altered the HDC for it to use:\n\t\t\treturn (LRESULT)bk_brush;\n\t\t}\n\n\t\tif (!text_color_was_changed) // No need to return a brush since no changes are needed. Let def. proc. handle it.\n\t\t\tbreak;\n\t\tif (iMsg == WM_CTLCOLORSTATIC)\n\t\t{\n\t\t\tSetBkColor((HDC)wParam, GetSysColor(COLOR_BTNFACE)); // Use default window color for static controls.\n\t\t\treturn (LRESULT)GetSysColorBrush(COLOR_BTNFACE);\n\t\t}\n\t\telse\n\t\t{\n\t\t\tSetBkColor((HDC)wParam, GetSysColor(COLOR_WINDOW)); // Use default control-bkgnd color for others.\n\t\t\treturn (LRESULT)GetSysColorBrush(COLOR_WINDOW);\n\t\t}\n\t\tbreak;\n\n\n\tcase WM_DRAWITEM:\n\t{\n\t\t// WM_DRAWITEM msg is received by GUI windows that contain a tab control with custom tab\n\t\t// colors. The TCS_OWNERDRAWFIXED style is what causes this message to be received.\n\t\tLPDRAWITEMSTRUCT lpdis = (LPDRAWITEMSTRUCT)lParam;\n\t\t// Otherwise, it might be a tab control with custom tab colors:\n\t\tcontrol_index = (GuiIndexType)GUI_ID_TO_INDEX(lpdis->CtlID); // Convert from ID to array index. Relies on unsigned to flag as out-of-bounds.\n\t\tif (control_index >= pgui->mControlCount // Relies on short-circuit eval order.\n\t\t\t|| pgui->mControl[control_index]->hwnd != lpdis->hwndItem // Handles do not match (this filters out bogus msgs).\n\t\t\t|| pgui->mControl[control_index]->type != GUI_CONTROL_TAB) // In case this msg can be received for other types.\n\t\t\tbreak;\n\t\tGuiControlType &control = *pgui->mControl[control_index]; // For performance & convenience.\n\t\tHBRUSH bk_brush;\n\t\tCOLORREF bk_color;\n\t\tpgui->ControlGetBkColor(control, true, bk_brush, bk_color);\n\t\tif (bk_brush)\n\t\t{\n\t\t\tFillRect(lpdis->hDC, &lpdis->rcItem, bk_brush); // Fill the tab itself.\n\t\t\tSetBkColor(lpdis->hDC, bk_color); // Set the text's background color.\n\t\t}\n\t\telse // Must do this anyway, otherwise there is an unwanted thin white line and possibly other problems.\n\t\t\tFillRect(lpdis->hDC, &lpdis->rcItem, (HBRUSH)(size_t)GetClassLongPtr(control.hwnd, GCLP_HBRBACKGROUND));\n\t\t// else leave background colors to default, in the case where only the text itself has a custom color.\n\t\t// Get the stored name/caption of this tab:\n\t\tTCITEM tci;\n\t\ttci.mask = TCIF_TEXT;\n\t\ttci.pszText = buf;\n\t\ttci.cchTextMax = _countof(buf) - 1; // MSDN example uses -1.\n\t\t// Set text color if needed:\n COLORREF prev_color = CLR_INVALID;\n\t\tif (control.union_color != CLR_DEFAULT)\n\t\t\tprev_color = SetTextColor(lpdis->hDC, control.union_color);\n\t\t// Draw the text. Note that rcItem contains the dimensions of a tab that has already been sized\n\t\t// to handle the amount of text in the tab at the specified WM_SETFONT font size, which makes\n\t\t// this much easier.\n\t\tif (TabCtrl_GetItem(lpdis->hwndItem, lpdis->itemID, &tci))\n\t\t{\n\t\t\t// The text is centered horizontally and vertically because that seems to be how the\n\t\t\t// control acts without the TCS_OWNERDRAWFIXED style. DT_NOPREFIX is not specified\n\t\t\t// because that is not how the control acts without the TCS_OWNERDRAWFIXED style\n\t\t\t// (ampersands do cause underlined letters, even though they currently have no effect).\n\t\t\tif (TabCtrl_GetCurSel(control.hwnd) != lpdis->itemID)\n\t\t\t\tlpdis->rcItem.top += 3; // For some reason, the non-current tabs' rects are a little off.\n\t\t\tDrawText(lpdis->hDC, tci.pszText, (int)_tcslen(tci.pszText), &lpdis->rcItem\n\t\t\t\t, DT_CENTER|DT_VCENTER|DT_SINGLELINE); // DT_VCENTER requires DT_SINGLELINE.\n\t\t\t// Cruder method, probably not always accurate depending on theme/display-settings/etc.:\n\t\t\t//TextOut(lpdis->hDC, lpdis->rcItem.left + 5, lpdis->rcItem.top + 3, tci.pszText, (int)_tcslen(tci.pszText));\n\t\t}\n\t\tif (prev_color != CLR_INVALID) // Put the previous color back into effect for this DC.\n\t\t\tSetTextColor(lpdis->hDC, prev_color);\n\t\tbreak;\n\t}\n\n\tcase WM_SETFOCUS:\n\t\t// DefDlgProc \"Sets the input focus to the control identified by a previously saved control window\n\t\t// handle. If no such handle exists, the procedure sets the input focus to the first control ...\"\n\tcase WM_ACTIVATE:\n\t\t// DefDlgProc \"Restores the input focus to the control identified by the previously saved handle\n\t\t// if the dialog box is activated.\"\n\t\t// \"If the window is being activated and is not minimized, the DefWindowProc function sets the\n\t\t// keyboard focus to the window.\"\n\t\tif (pgui->mIsMinimized)\n\t\t\treturn 0;\n\t\t// The simple check above solves a problem caused by bad OS behaviour that I couldn't find any\n\t\t// mention of in all my searching, and that took hours to debug; so I'll be verbose:\n\t\t//\n\t\t// Without the suppression check, restoring a minimized GUI window (without activating it first)\n\t\t// causes focus to reset to the first control in the GUI, instead of the control that had focus\n\t\t// previously. The sequence of events is as follows:\n\t\t// - WM_ACTIVATE, WA_ACTIVE (window is active and already NOT MINIMIZED according to wParam)\n\t\t// DefDlgProc restores focus to the correct control.\n\t\t// - WM_SIZE, SIZE_RESTORED (now we're told the window has been restored)\n\t\t// - WM_SETFOCUS (the control has lost focus and the window itself has gained it)\n\t\t// DefDlgProc resets focus to the window's FIRST control.\n\t\t// - WM_ACTIVATE, WA_ACTIVE (again)\n\t\t//\n\t\t// My conclusion after debugging with Spy++, logging breakpoints and OnMessage, was that these\n\t\t// WM_ACTIVATE and WM_SETFOCUS messages are directly caused by whatever system function restores\n\t\t// the window. If only the first WM_ACTIVATE message is suppressed, the following occurs:\n\t\t// - WM_ACTIVATE, WA_ACTIVE (we don't call DefDlgProc)\n\t\t// - WM_SETFOCUS (this is sent after WM_ACTIVATE returns)\n\t\t// DefDlgProc restores focus to the correct control.\n\t\t// - WM_SIZE, SIZE_RESTORED\n\t\t// - WM_SETFOCUS\n\t\t// DefDlgProc resets focus to the window's FIRST control (as before).\n\t\t// - WM_ACTIVATE, WA_ACTIVE (again)\n\t\t//\n\t\t// So apparently if the window doesn't set focus in response to WM_ACTIVATE, the system calls\n\t\t// SetFocus(hWnd). But even though it does that, it calls SetFocus(hWnd) again afterward!\n\t\t//\n\t\t// Another attempted workaround was to have WM_SETFOCUS do SetFocus(wParam) if wParam was this\n\t\t// window's own control. This worked, but the focus changed several times each time the window\n\t\t// was restored, and for some controls this generates redundant focus and lost-focus events.\n\t\t//\n\t\t// To solve this we suppress both WM_ACTIVATE and WM_SETFOCUS in between WM_SIZE, SIZE_MINIMIZED\n\t\t// and the next WM_SIZE with any other parameter value. The end result is that when the window\n\t\t// is activated, the window itself is focused (which normally happens, temporarily) and then\n\t\t// focus changes only once, when WM_ACTIVATE is received after WM_SIZE. There is no second\n\t\t// WM_SETFOCUS, because hWnd already has the focus.\n\t\t//\n\t\t// WM_SIZE is tracked with mIsMinimized rather than using IsIconic(hWnd) because the iconic state\n\t\t// of the window changes before the transition is completed (which is probably why WM_ACTIVATE's\n\t\t// wParam doesn't indicate that the window is minimized).\n\t\t//\n\t\t// Note that this issue didn't occur in at least the following cases:\n\t\t// 1) If the window is activated before restoring it, WM_ACTIVATE is received while the window\n\t\t// is definitely in the minimized state (and not in transition), therefore DefDlgProc does\n\t\t// not handle it by changing the focus.\n\t\t// 2) If the window is restored via the taskbar button, it loses focus when the user clicks the\n\t\t// taskbar, so see above.\n\t\t// 3) If the window is minimized via the taskbar button, it can be restored even without first\n\t\t// activating it. This seems to be a consequence of some shonky handling by the system, as\n\t\t// it sends WM_ACTIVATE, 0x00200001 (WA_ACTIVE with upper word non-zero, meaning minimized),\n\t\t// even though the window IS NOT ACTIVE, and then when the window is activated, WM_ACTIVATE\n\t\t// is not sent (and without that message, there is no premature focus restoration).\n\t\t// I came across several mentions of this issue with WM_ACTIVATE and the taskbar in my searches.\n\t\t// Note that sending the bogus message manually produces a different result; i.e. WM_ACTIVATE\n\t\t// is still sent by the system when the window is restored.\n\t\tbreak;\n\n\tcase WM_CONTEXTMENU:\n\t\t{\n\t\t\tHWND clicked_hwnd = (HWND)wParam;\n\t\t\tbool from_keyboard; // Whether Context Menu was generated from keyboard (AppsKey or Shift-F10).\n\t\t\tif ( !(from_keyboard = (lParam == -1)) ) // Mouse click vs. keyboard event.\n\t\t\t{\n\t\t\t\t// If the click occurred above the client area, assume it was in title/menu bar or border.\n\t\t\t\t// Let default proc handle it.\n\t\t\t\tpoint_and_hwnd_type pah = {0};\n\t\t\t\tpah.pt.x = LOWORD(lParam);\n\t\t\t\tpah.pt.y = HIWORD(lParam);\n\t\t\t\tPOINT client_pt = pah.pt;\n\t\t\t\tif (!ScreenToClient(hWnd, &client_pt) || client_pt.y < 0)\n\t\t\t\t\tbreak; // Allows default proc to display standard system context menu for title bar.\n\t\t\t\t// v1.0.38.01: Recognize clicks on pictures and text controls as occurring in that control\n\t\t\t\t// (via A_GuiControl) rather than generically in the window:\n\t\t\t\tif (clicked_hwnd == pgui->mHwnd)\n\t\t\t\t{\n\t\t\t\t\t// v1.0.40.01: Rather than doing \"ChildWindowFromPoint(clicked_hwnd, client_pt)\" -- which fails to\n\t\t\t\t\t// detect text and picture controls (and perhaps others) when they're inside GroupBoxes and\n\t\t\t\t\t// Tab controls -- use the MouseGetPos() method, which seems much more accurate.\n\t\t\t\t\tEnumChildWindows(clicked_hwnd, EnumChildFindPoint, (LPARAM)&pah); // Find topmost control containing point.\n\t\t\t\t\tclicked_hwnd = pah.hwnd_found; // Okay if NULL; the next stage will handle it.\n\t\t\t\t}\n\t\t\t}\n\t\t\t// Finding control_index requires only GUI_HWND_TO_INDEX (not FindControl) since context menu message\n\t\t\t// never arrives for a ComboBox's Edit control (since that control has its own context menu).\n\t\t\tcontrol_index = GUI_HWND_TO_INDEX(clicked_hwnd); // Yields a small negative value on failure, which due to unsigned is seen as a large positive number.\n\t\t\tif (control_index >= pgui->mControlCount) // The user probably clicked the parent window rather than inside one of its controls.\n\t\t\t\tcontrol_index = NO_CONTROL_INDEX;\n\t\t\t\t// Above flags it as a non-control event. Must use NO_CONTROL_INDEX rather than something\n\t\t\t\t// like 0xFFFFFFFF so that high-order bit is preserved for use below.\n\t\t\tif (pgui->IsMonitoring(GUI_EVENT_CONTEXTMENU)\n\t\t\t\t|| control_index != NO_CONTROL_INDEX && pgui->mControl[control_index]->events.IsMonitoring(GUI_EVENT_CONTEXTMENU))\n\t\t\t\tPOST_AHK_GUI_ACTION(hWnd, control_index, MAKEWORD(GUI_EVENT_CONTEXTMENU, from_keyboard), NO_EVENT_INFO);\n\t\t\treturn 0; // Return value doesn't matter.\n\t\t}\n\t\t//else it's for some non-GUI window (probably impossible). Let DefDlgProc() handle it.\n\t\tbreak;\n\n\tcase WM_DROPFILES:\n\t{\n\t\tHDROP hdrop = (HDROP)wParam;\n\t\tif (pgui->mHdrop || !pgui->IsMonitoring(GUI_EVENT_DROPFILES))\n\t\t{\n\t\t\t// There is no event handler in the script, or this window is still processing a prior drop.\n\t\t\t// Ignore this drop and free its memory.\n\t\t\tDragFinish(hdrop);\n\t\t\treturn 0; // \"An application should return zero if it processes this message.\"\n\t\t}\n\t\t// Otherwise: Indicate that this window is now processing the drop. DragFinish() will be called later.\n\t\tpgui->mHdrop = hdrop;\n\t\tpoint_and_hwnd_type pah = {0};\n\t\t// DragQueryPoint()'s return value is non-zero if the drop occurred in the client area.\n\t\t// However, that info seems too rarely needed to justify storing it anywhere:\n\t\tDragQueryPoint(hdrop, &pah.pt);\n\t\tClientToScreen(hWnd, &pah.pt); // EnumChildFindPoint() requires screen coords.\n\t\tEnumChildWindows(hWnd, EnumChildFindPoint, (LPARAM)&pah); // Find topmost control containing point.\n\t\t// Look up the control in case the drop occurred in a child of a child, such as the edit portion\n\t\t// of a ComboBox (FindControl will take that into account):\n\t\tpcontrol = pah.hwnd_found ? pgui->FindControl(pah.hwnd_found) : NULL;\n\t\t// Finding control_index requires only GUI_HWND_TO_INDEX (not FindControl) since EnumChildFindPoint (above)\n\t\t// already properly resolves the Edit control of a ComboBox to be the ComboBox itself.\n\t\tcontrol_index = pcontrol ? GUI_HWND_TO_INDEX(pcontrol->hwnd) : NO_CONTROL_INDEX;\n\t\t// Above: NO_CONTROL_INDEX indicates to GetGuiControl() that there is no control in this case.\n\t\tPOST_AHK_GUI_ACTION(hWnd, control_index, GUI_EVENT_DROPFILES, NO_EVENT_INFO); // The HDROP is not passed via message so that it can be released (via the destructor) if the program closes during the drop operation.\n\t\t// MsgSleep() is not done because \"case AHK_GUI_ACTION\" in GuiWindowProc() takes care of it.\n\t\t// See its comments for why.\n\t\treturn 0; // \"An application should return zero if it processes this message.\"\n\t}\n\n\tcase AHK_GUI_ACTION:\n\tcase AHK_USER_MENU:\n\t\t// v1.0.36.03: The g_MenuIsVisible check was added as a means to discard the message. Otherwise\n\t\t// MSG_FILTER_MAX would result in a bouncing effect or something else that disrupts a popup menu,\n\t\t// namely a context menu shown by an AltSubmit ListView (regardless of whether it's shown by\n\t\t// GuiContextMenu or in response to a RightClick event). This is because a ListView apparently\n\t\t// generates the following notifications while the context menu is displayed:\n\t\t// C: release mouse capture\n\t\t// H: hottrack\n\t\t// f: lost focus\n\t\t// I think the issue here is that there are times when messages should be reposted and\n\t\t// other times when they should not be. The MonthCal and DateTime cases mentioned below are\n\t\t// times when they should, because the MSG_FILTER_MAX filter is not in effect then. But when a\n\t\t// script's own popup menu is displayed, any message subject to filtering (which includes\n\t\t// AHK_GUI_ACTION and AHK_USER_MENU) should probably never be reposted because that disrupts\n\t\t// the ability to select an item in the menu or dismiss it (possibly due to the theoretical\n\t\t// bouncing-around effect described below).\n\t\t// OLDER: I don't think the below is a complete explanation since it doesn't take into account\n\t\t// the fact that the message filter might be in effect due to a menu being visible, which if\n\t\t// true would prevent MsgSleep from processing the message.\n\t\t// OLDEST: MsgSleep() is the critical step. It forces our thread msg pump to handle the message now\n\t\t// because otherwise it would probably become a CPU-maxing loop wherein the dialog or MonthCal\n\t\t// msg pump that called us dispatches the above message right back to us, causing it to\n\t\t// bounce around thousands of times until that other msg pump finally finishes.\n\t\t// UPDATE: This will backfire if the script is uninterruptible.\n\t\tif (IsInterruptible())\n\t\t{\n\t\t\t// Handling these messages here by reposting them to our thread relieves the one who posted them\n\t\t\t// from ever having to do a MsgSleep(-1), which in turn allows it or its caller to acknowledge\n\t\t\t// its message in a timely fashion, which in turn prevents undesirable side-effects when a\n\t\t\t// g-labeled DateTime's drop-down is navigated via its arrow buttons (jumps ahead two months\n\t\t\t// instead of one, infinite loop with mouse button stuck down on some systems, etc.). Another\n\t\t\t// side-effect is the failure of a g-labeled MonthCal to be able to notify of date change when\n\t\t\t// the user clicks the year and uses the spinner to select a new year. This solves both of\n\t\t\t// those issues and almost certainly others:\n\t\t\tPostMessage(hWnd, iMsg, wParam, lParam);\n\t\t\tMsgSleep(-1, RETURN_AFTER_MESSAGES_SPECIAL_FILTER);\n\t\t}\n\t\treturn 0;\n\n\tcase WM_CLOSE: // For now, take the same action as SC_CLOSE.\n\t\tpgui->Close();\n\t\treturn 0;\n\n\tcase WM_DESTROY:\n\t\t// Update to below: If a GUI window is owned by the script's main window (via \"gui +owner\"),\n\t\t// it can be destroyed automatically. Because of this and the fact that it's difficult to\n\t\t// keep track of all the ways a window can be destroyed, it seems best for peace-of-mind to\n\t\t// have this WM_DESTROY handler \n\t\t// Older Note: Let default-proc handle WM_DESTROY because with the current design, it should\n\t\t// be impossible for a window to be destroyed without the object \"knowing about it\" and\n\t\t// updating itself (then destroying itself) accordingly. The object methods always\n\t\t// destroy (recursively) any windows it owns, so once again it \"knows about it\".\n\t\tif (!pgui->mDestroyWindowHasBeenCalled)\n\t\t{\n\t\t\tpgui->mDestroyWindowHasBeenCalled = true; // Tell it not to call DestroyWindow(), just clean up everything else.\n\t\t\tpgui->Destroy();\n\t\t}\n\t\t// Above: if mDestroyWindowHasBeenCalled==true, we were called by Destroy(), so don't call Destroy() again recursively.\n\t\t// And in any case, pass it on to DefDlgProc() in case it does any extra cleanup:\n\t\tbreak;\n\n\t// For WM_ENTERMENULOOP/WM_EXITMENULOOP, there is similar code in MainWindowProc(), so maintain them together.\n\t// g_MenuIsVisible is tracked for the purpose of preventing thread interruptions while the program\n\t// is in a modal menu loop, since the menu would become unresponsive until the interruption returns.\n\t// WM_ENTERMENULOOP is received both when entering a modal menu loop (due to a menu bar or popup menu)\n\t// and when a modeless menu is being displayed (in which case there's actually no menu loop).\n\t// WM_INITMENUPOPUP is handled to verify which situation this is, so that new threads can launch\n\t// while a modeless menu is being displayed. We use this combination of messages rather than just\n\t// the INIT messages because some scripts already suppress WM_ENTERMENULOOP to allow new threads.\n\t// \"break\" is used rather than \"return 0\" to let DefWindowProc()/DefDlgProc() take whatever action\n\t// it needs to do for these.\n\tcase WM_ENTERMENULOOP:\n\t\tg_MenuIsVisible = true;\n\t\tbreak;\n\tcase WM_EXITMENULOOP:\n\t\tg_MenuIsVisible = false; // See comments above.\n\t\tbreak;\n\tcase WM_INITMENUPOPUP:\n\t\tInitMenuPopup((HMENU)wParam);\n\t\tbreak;\n\tcase WM_UNINITMENUPOPUP:\n\t\t// This currently isn't needed in GuiWindowProc() because notifications for temp-modeless\n\t\t// menus are always sent to g_hWnd, but it is kept here for symmetry/maintainability:\n\t\tUninitMenuPopup((HMENU)wParam);\n\t\tbreak;\n\tcase WM_NCACTIVATE:\n\t\tif (!wParam && g_MenuIsTempModeless)\n\t\t{\n\t\t\t// The documentation is quite ambiguous, but it appears the return value of WM_NCACTIVATE\n\t\t\t// affects whether the actual change of foreground window goes ahead, whereas the appearance\n\t\t\t// of the nonclient area is controlled by whether or not DefDlgProc() is called.\n\t\t\treturn TRUE; // Allow change of foreground window, but appear to remain active.\n\t\t}\n\t\tbreak;\n\t} // switch()\n\t\n\t// This will handle anything not already fully handled and returned from above:\n\treturn DefDlgProc(hWnd, iMsg, wParam, lParam);\n}\n\n\n\nLRESULT CALLBACK ControlWindowProc(HWND hWnd, UINT iMsg, WPARAM wParam, LPARAM lParam, UINT_PTR uIdSubclass, DWORD_PTR dwRefData)\n{\n\tif (iMsg == WM_NCDESTROY)\n\t\tRemoveWindowSubclass(hWnd, ControlWindowProc, uIdSubclass);\n\n\tMSG *pmsg = nullptr;\n\tif (g_CalledByIsDialogMessageOrDispatch && g_CalledByIsDialogMessageOrDispatch->message == iMsg)\n\t\tswap(pmsg, g_CalledByIsDialogMessageOrDispatch);\n\n\tINT_PTR msg_reply;\n\tauto &control = *(GuiControlType*)uIdSubclass;\n\tif (control.events.IsMonitoring(iMsg, GUI_EVENTKIND_MESSAGE)\n\t\t&& control.gui->MsgMonitor(&control, iMsg, wParam, lParam, pmsg, &msg_reply))\n\t\treturn msg_reply;\n\n\treturn DefSubclassProc(hWnd, iMsg, wParam, lParam);\n}\n\n\n\nLRESULT CALLBACK TabWindowProc(HWND hWnd, UINT iMsg, WPARAM wParam, LPARAM lParam)\n{\n\t// Variables are kept separate up here for future expansion of this function (to handle\n\t// more iMsgs/cases, etc.):\n\tGuiType *pgui;\n\tGuiControlType *pcontrol;\n\tHWND parent_window;\n\tHBRUSH bk_brush;\n\tCOLORREF bk_color;\n\n\tswitch (iMsg)\n\t{\n\tcase WM_ERASEBKGND:\n\tcase WM_WINDOWPOSCHANGED:\n\t\tparent_window = GetParent(hWnd);\n\t\t// Relies on short-circuit boolean order:\n\t\tif ( !(pgui = GuiType::FindGui(parent_window)) || !(pcontrol = pgui->FindControl(hWnd)) )\n\t\t\tbreak;\n\t\tswitch (iMsg)\n\t\t{\n\t\tcase WM_ERASEBKGND:\n\t\t\tpgui->ControlGetBkColor(*pcontrol, true, bk_brush, bk_color);\n\t\t\tif (!bk_brush)\n\t\t\t\tbreak; // Let default proc handle it.\n\t\t\t// Can't use SetBkColor(), need a real brush to fill it.\n\t\t\tRECT clipbox;\n\t\t\tGetClipBox((HDC)wParam, &clipbox);\n\t\t\tFillRect((HDC)wParam, &clipbox, bk_brush);\n\t\t\treturn 1; // \"An application should return nonzero if it erases the background.\"\n\t\tcase WM_WINDOWPOSCHANGED:\n\t\t\tif ((LPWINDOWPOS(lParam)->flags & (SWP_NOMOVE | SWP_NOSIZE)) != (SWP_NOMOVE | SWP_NOSIZE)) // i.e. moved, resized or both.\n\t\t\t{\n\t\t\t\t// This appears to allow the tab control to update its row count:\n\t\t\t\tLRESULT r = CallWindowProc(g_TabClassProc, hWnd, iMsg, wParam, lParam);\n\t\t\t\t// Update this tab control's dialog, if it has one, to match the new size/position.\n\t\t\t\tpgui->UpdateTabDialog(hWnd);\n\t\t\t\treturn r;\n\t\t\t}\n\t\t}\n\t}\n\n\t// This will handle anything not already fully handled and returned from above:\n\treturn CallWindowProc(g_TabClassProc, hWnd, iMsg, wParam, lParam);\n}\n\n\n\nvoid GuiType::Event(GuiIndexType aControlIndex, UINT aNotifyCode, USHORT aGuiEvent, UINT_PTR aEventInfo)\n// Caller should pass GUI_EVENT_NONE (zero) for aGuiEvent if it wants us to determine aGuiEvent based on the\n// type of control and the incoming aNotifyCode.\n// This function handles events within a GUI window that caused one of its controls to change in a meaningful\n// way, or that is an event that could trigger an external action, such as clicking a button or icon.\n{\n\tif (aControlIndex >= mControlCount) // Caller probably already checked, but just to be safe.\n\t\treturn;\n\tGuiControlType &control = *mControl[aControlIndex];\n\tif (!control.events.Count()) // But don't check IsMonitoring(aGuiEvent) yet, because aGuiEvent may be undetermined.\n\t\treturn; // No event handlers associated with this control, so no action.\n\tif (control.attrib & GUI_CONTROL_ATTRIB_SUPPRESS_EVENTS)\n\t\treturn;\n\n\t// Update: The below is now checked by MsgSleep() at the time the launch actually would occur because\n\t// g_nThreads will be more accurate/timely then:\n\t// If this control already has a thread running in its label, don't create a new thread to avoid\n\t// problems of buried threads, or a stack of suspended threads that might be resumed later\n\t// at an unexpected time. Users of timer subs that take a long time to run should be aware, as\n\t// documented in the help file, that long interruptions are then possible.\n\t//if (g_nThreads >= g_MaxThreadsTotal || (aControl->attrib & GUI_CONTROL_ATTRIB_HANDLER_IS_RUNNING))\n\t//\tcontinue\n\n\tif (aGuiEvent == GUI_EVENT_WM_COMMAND) // Called by WM_COMMAND.\n\t{\n\t\tif (control.events.IsMonitoring(aNotifyCode, GUI_EVENTKIND_COMMAND))\n\t\t{\n\t\t\tPOST_AHK_GUI_ACTION(mHwnd, aControlIndex, aGuiEvent, aNotifyCode);\n\t\t\t// Do the rest as well, just in case this command corresponds to an event.\n\t\t}\n\t\taGuiEvent = GUI_EVENT_NONE; // Determine the actual event below.\n\t}\n\n\tif (aGuiEvent == GUI_EVENT_NONE) // Caller wants us to determine aGuiEvent based on control type and aNotifyCode.\n\t{\n\t\tswitch(control.type)\n\t\t{\n\t\tcase GUI_CONTROL_BUTTON:\n\t\tcase GUI_CONTROL_CHECKBOX:\n\t\tcase GUI_CONTROL_RADIO:\n\t\t\tswitch (aNotifyCode)\n\t\t\t{\n\t\t\tcase BN_CLICKED: // Must explicitly list this case since the default label below does a return.\n\t\t\t\t// Fix for v1.0.24: The below excludes from consideration messages from radios that are\n\t\t\t\t// being unchecked. This prevents a radio group's g-label from being fired twice when the\n\t\t\t\t// user navigates to a new radio via the arrow keys. It also filters out the BN_CLICKED that\n\t\t\t\t// occurs when the user tabs over to a radio group that lacks a selected button. This new\n\t\t\t\t// behavior seems like it would be desirable most of the time.\n\t\t\t\tif (control.type == GUI_CONTROL_RADIO && SendMessage(control.hwnd, BM_GETCHECK, 0, 0) == BST_UNCHECKED)\n\t\t\t\t\treturn;\n\t\t\t\taGuiEvent = GUI_EVENT_CLICK;\n\t\t\t\tbreak;\n\t\t\t// All three of these require BS_NOTIFY:\n\t\t\tcase BN_DBLCLK: aGuiEvent = GUI_EVENT_DBLCLK; break;\n\t\t\tcase BN_SETFOCUS: aGuiEvent = GUI_EVENT_FOCUS; break;\n\t\t\tcase BN_KILLFOCUS: aGuiEvent = GUI_EVENT_LOSEFOCUS; break;\n\t\t\tdefault:\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_DROPDOWNLIST:\n\t\tcase GUI_CONTROL_COMBOBOX:\n\t\t\tswitch (aNotifyCode)\n\t\t\t{\n\t\t\tcase CBN_SELCHANGE: // Must explicitly list this case since the default label does a return.\n\t\t\tcase CBN_EDITCHANGE: // Added for v1.0.24 to support detection of changes in a ComboBox's edit portion.\n\t\t\t\taGuiEvent = GUI_EVENT_CHANGE;\n\t\t\t\tbreak;\n\t\t\tcase CBN_DBLCLK: // Used by CBS_SIMPLE (i.e. list always visible).\n\t\t\t\taGuiEvent = GUI_EVENT_DBLCLK; // But due to rarity of use, the focused row number is not stored in aEventInfo.\n\t\t\t\tbreak;\n\t\t\tcase CBN_SETFOCUS: aGuiEvent = GUI_EVENT_FOCUS; break;\n\t\t\tcase CBN_KILLFOCUS: aGuiEvent = GUI_EVENT_LOSEFOCUS; break;\n\t\t\tdefault:\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_LISTBOX:\n\t\t\tswitch (aNotifyCode)\n\t\t\t{\n\t\t\tcase LBN_SELCHANGE: // Must explicitly list this case since the default label does a return.\n\t\t\t\taGuiEvent = GUI_EVENT_CHANGE;\n\t\t\t\tbreak;\n\t\t\tcase LBN_DBLCLK:\n\t\t\t\taGuiEvent = GUI_EVENT_DBLCLK;\n\t\t\t\taEventInfo = 1 + (UINT_PTR)SendMessage(control.hwnd, LB_GETCARETINDEX, 0, 0); // +1 to convert to one-based index.\n\t\t\t\tbreak;\n\t\t\tcase LBN_SETFOCUS: aGuiEvent = GUI_EVENT_FOCUS; break;\n\t\t\tcase LBN_KILLFOCUS: aGuiEvent = GUI_EVENT_LOSEFOCUS; break;\n\t\t\tdefault:\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_EDIT:\n\t\t\t// Seems more appropriate to check EN_CHANGE vs. EN_UPDATE since EN_CHANGE occurs only after\n\t\t\t// any redrawing of the control.\n\t\t\tswitch (aNotifyCode)\n\t\t\t{\n\t\t\tcase EN_CHANGE: aGuiEvent = GUI_EVENT_CHANGE; break;\n\t\t\tcase EN_SETFOCUS: aGuiEvent = GUI_EVENT_FOCUS; break;\n\t\t\tcase EN_KILLFOCUS: aGuiEvent = GUI_EVENT_LOSEFOCUS; break;\n\t\t\tdefault:\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_HOTKEY: // The only notification sent by the hotkey control is EN_CHANGE.\n\t\t\taGuiEvent = GUI_EVENT_CHANGE;\n\t\t\tbreak; // No action.\n\n\t\tcase GUI_CONTROL_TEXT:\n\t\tcase GUI_CONTROL_PIC:\n\t\t\t// Update: Unlike buttons, it's all-or-none for static controls. Testing shows that if\n\t\t\t// STN_DBLCLK is not checked for and the user clicks rapidly, half the clicks will be\n\t\t\t// ignored:\n\t\t\t// Based on experience with BN_DBLCLK, it's likely that STN_DBLCLK must be included or else\n\t\t\t// these control types won't be responsive to rapid consecutive clicks:\n\t\t\tswitch (aNotifyCode)\n\t\t\t{\n\t\t\tcase STN_CLICKED: // Must explicitly list this case since the default label does a return.\n\t\t\t\taGuiEvent = GUI_EVENT_CLICK;\n\t\t\t\tbreak;\n\t\t\tcase STN_DBLCLK:\n\t\t\t\taGuiEvent = GUI_EVENT_DBLCLK;\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase GUI_CONTROL_UPDOWN:\n\t\t\t// Due to the difficulty in distinguishing between clicking an arrow button and pressing an\n\t\t\t// arrow key on the keyboard, there is currently no GUI_CONTROL_ATTRIB_ALTSUBMIT mode for\n\t\t\t// up-downs. That mode could be reserved to allow the script to override the user's position\n\t\t\t// change of the up-down by means of the script returning 1 or 0 in response to UDN_DELTAPOS.\n\t\t\tif (aNotifyCode == SB_THUMBPOSITION)\n\t\t\t{\n\t\t\t\t// User has pressed arrow keys or clicked down on the mouse on one of the arrows.\n\t\t\t\taGuiEvent = GUI_EVENT_CHANGE;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// Otherwise, ignore all others. SB_ENDSCROLL is received when user has released mouse after\n\t\t\t// scrolling one of the arrows (never arrives for arrow keys, even when holding them down).\n\t\t\t// That event (and any others, but especially that one) is ignored because it would launch\n\t\t\t// the g-label twice: once for lbutton-down and once for up.\n\t\t\treturn;\n\n\t\tcase GUI_CONTROL_SLIDER:\n\t\t\tswitch (aNotifyCode)\n\t\t\t{\n\t\t\tcase TB_THUMBTRACK:\n\t\t\t\t// TB_THUMBTRACK is sent very frequently while the user is dragging the slider.\n\t\t\t\t// It seems best to disable it by default, and only call the g-label once the user\n\t\t\t\t// releases the mouse button (i.e. when TB_THUMBPOSITION is received).\n\t\t\tcase TB_ENDTRACK:\n\t\t\t\t// TB_ENDTRACK always follows some other event. Since it isn't generated when the user\n\t\t\t\t// uses the mouse wheel, filter it out by default so that the g-label is always called\n\t\t\t\t// only once when the slider moves, by default.\n\t\t\t\tif (!(control.attrib & GUI_CONTROL_ATTRIB_ALTSUBMIT)) // Ignore this event.\n\t\t\t\t\treturn;\n\t\t\t\t// Otherwise, continue:\n\t\t\tdefault:\n\t\t\t\t// Namely the following:\n\t\t\t\t//case TB_THUMBPOSITION: // Mouse wheel or WM_LBUTTONUP following a TB_THUMBTRACK notification message\n\t\t\t\t//case TB_LINEUP: // VK_LEFT or VK_UP\n\t\t\t\t//case TB_LINEDOWN: // VK_RIGHT or VK_DOWN\n\t\t\t\t//case TB_PAGEUP: // VK_PRIOR (the user clicked the channel above or to the left of the slider)\n\t\t\t\t//case TB_PAGEDOWN: // VK_NEXT (the user clicked the channel below or to the right of the slider)\n\t\t\t\t//case TB_TOP: // VK_HOME\n\t\t\t\t//case TB_BOTTOM: // VK_END\n\t\t\t\t// In most cases the script simply wants to know when the value changes,\n\t\t\t\t// so this is one event with a parameter rather than multiple events:\n\t\t\t\taGuiEvent = GUI_EVENT_CHANGE;\n\t\t\t\taEventInfo = aNotifyCode;\n\t\t\t}\n\t\t\tbreak;\n\n\t\t// The following need no handling in this section because aGuiEvent and aEventInfo\n\t\t// were given appropriate values by our caller (execution never reaches this point):\n\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t//case GUI_CONTROL_TAB: // aNotifyCode == TCN_SELCHANGE should be the only possibility.\n\t\t//case GUI_CONTROL_DATETIME:\n\t\t//case GUI_CONTROL_MONTHCAL:\n\t\t//case GUI_CONTROL_LINK:\n\t\t//\n\t\t// The following are not needed because execution never reaches this point. This is because these types\n\t\t// are forbidden from having event handlers, since they don't support raising any events.\n\t\t//case GUI_CONTROL_GROUPBOX:\n\t\t//case GUI_CONTROL_PROGRESS:\n\n\t\t} // switch(control.type)\n\t} // if (aGuiEvent == GUI_EVENT_NONE)\n\n\tif (!control.events.IsMonitoring(LOBYTE(aGuiEvent))) // Checked after possibly determining aGuiEvent above. LOBYTE() is needed for ListView 'I'.\n\t\treturn;\n\n\tPOST_AHK_GUI_ACTION(mHwnd, aControlIndex, aGuiEvent, (LPARAM)aEventInfo);\n\t// MsgSleep(-1, RETURN_AFTER_MESSAGES_SPECIAL_FILTER) is not done because \"case AHK_GUI_ACTION\" in GuiWindowProc()\n\t// takes care of it. See its comments for why.\n\n\t// BACKGROUND ABOUT THE ABOVE:\n\t// Rather than launching the thread directly from here, it seems best to always post it to our\n\t// thread to be handled there. Here are the reasons:\n\t// 1) We don't want to be in the situation where a thread launched here would return first\n\t// to a dialog's message pump rather than MsgSleep's pump. That's because our thread\n\t// might have queued messages that would then be misrouted or lost because the dialog's\n\t// dispatched them incorrectly, or didn't know what to do with them because they had a\n\t// NULL hwnd.\n\t// 2) If the script happens to be uninterruptible, we would want to \"re-queue\" the messages\n\t// in this fashion anyway (doing so avoids possible conflict if the current quasi-thread\n\t// is in the middle of a critical operation, such as trying to open the clipboard for \n\t// a command it is right in the middle of executing).\n\t// 3) \"Re-queuing\" this event *only* for case #2 might cause problems with losing the original\n\t// sequence of events that occurred in the GUI. For example, if some events were re-queued\n\t// due to uninterruptibility, but other more recent ones were not (because the thread became\n\t// interruptible again at a critical moment), the more recent events would take effect before\n\t// the older ones. Requeuing all events ensures that when they do take effect, they do so\n\t// in their original order.\n\t//\n\t// More explanation about Case #1 above. Consider this order of events: 1) Current thread is\n\t// waiting for dialog, thus that dialog's msg pump is running. 2) User presses a button on GUI\n\t// window, and then another while the prev. button's thread is still uninterruptible (perhaps\n\t// this happened due to automating the form with the Send command). 3) Due to uninterruptibility,\n\t// this event would be re-queued to the thread's msg queue. 4) If the first thread ends before any\n\t// call to MsgSleep(), we'll be back at the dialog's msg pump again, and thus the requeued message\n\t// would be misrouted or discarded due to automatic dispatching.\n\t//\n\t// Info about why events are buffered when script is uninterruptible:\n \t// It seems best to buffer GUI events that would trigger a new thread, rather than ignoring\n\t// them or allowing them to launch unconditionally. Ignoring them is bad because lost events\n\t// might cause a GUI to get out of sync with how its controls are designed to update and\n\t// interact with each other. Allowing them to launch anyway is bad in the case where\n\t// a critical operation for another thread is underway (such as attempting to open the\n\t// clipboard). Thus, post this event back to our thread so that even if a msg pump\n\t// other than our own is running (such as MsgBox or another dialog), the msg will stay\n\t// buffered (the msg might bounce around fiercely if we kept posting it to our WindowProc,\n\t// since any other msg pump would not have the buffering filter in place that ours has).\n\t//\n\t// UPDATE: I think some of the above might be obsolete now. Consider this order of events:\n\t// 1) Current thread is waiting for dialog, thus that dialog's msg pump is running. 2) User presses\n\t// a button on GUI window. 3) We receive that message here and post it below. 4) When we exit,\n\t// the dialog's msg pump receives the message and dispatches it to GuiWindowProc. 5) GuiWindowProc\n\t// posts the message and immediately does a MsgSleep to force our msg pump to handle the message.\n\t// 6) Everything is fine unless our msg pump leaves the message queued due to uninterruptibility,\n\t// in which case the msg will bounce around, possibly maxing the CPU, until either the dialog's msg\n\t// pump ends or the other thread becomes interruptible (which usually doesn't take more than 20 ms).\n\t// If the script is uninterruptible due to some long operation such as sending keystrokes or trying\n\t// to open the clipboard when it is locked, any dialog message pump underneath on the call stack\n\t// shouldn't be an issue because the long-operation (clipboard/Send) does not return to that\n\t// msg pump until the operation is complete; in other words, the message to stay queued rather than\n\t// bouncing around.\n\n\t// Although an additional WORD of info could be squeezed into the message by passing the control's HWND\n\t// instead of the parent window's (and the msg pump could then look up the parent window via\n\t// GetNonChildParent), it's probably not feasible because if some other message pump is running, it would\n\t// route AHK_GUI_ACTION messages to the window proc. of the control rather than the parent window, which\n\t// would prevent them from being re-posted back to the queue (see \"case AHK_GUI_ACTION\" in GuiWindowProc()).\n}\n\n\nbool GuiType::ControlWmNotify(GuiControlType &aControl, LPNMHDR aNmHdr, INT_PTR &aRetVal)\n{\n\t// See MsgMonitor() in application.cpp for comments, as this method is based on the beforementioned function.\n\n\tif (!INTERRUPTIBLE_IN_EMERGENCY)\n\t\treturn false;\n\n\tif (!aControl.events.IsMonitoring(aNmHdr->code, GUI_EVENTKIND_NOTIFY))\n\t\treturn false;\n\n\tif (g_nThreads >= g_MaxThreadsTotal)\n\t\treturn false;\n\n\tif (g->Priority > 0)\n\t\treturn false;\n\n\tInitNewThread(0, false, true);\n\tg_script.mLastPeekTime = GetTickCount();\n\tAddRef();\n\t\n\tExprTokenType param[] = { &aControl, (__int64)(DWORD_PTR)aNmHdr };\n\tResultType result = aControl.events.Call(param, _countof(param)\n\t\t, aNmHdr->code, GUI_EVENTKIND_NOTIFY, this, &aRetVal);\n\n\tRelease();\n\tResumeUnderlyingThread();\n\n\t// Consider this notification fully handled only if a non-empty value was returned.\n\treturn result == EARLY_RETURN;\n}\n\n\nbool GuiType::MsgMonitor(GuiControlType *aControl, UINT aMsg, WPARAM awParam, LPARAM alParam, MSG *apMsg, INT_PTR *aRetVal)\n{\n\tExprTokenType param[] = { aControl ? (IObject*)aControl : this, (__int64)awParam, (__int64)(DWORD_PTR)alParam, (__int64)aMsg };\n\tInitNewThread(0, false, true);\n\tg_script.mLastPeekTime = GetTickCount();\n\tif (apMsg)\n\t\tg->EventInfo = apMsg->time;\n\tauto &events = aControl ? aControl->events : this->mEvents;\n\tauto result = events.Call(param, 4, aMsg, GUI_EVENTKIND_MESSAGE, this, aRetVal);\n\tResumeUnderlyingThread();\n\treturn result == EARLY_RETURN;\n}\n\n\nWORD GuiType::TextToHotkey(LPCTSTR aText)\n// Returns a WORD compatible with the HKM_SETHOTKEY message:\n// LOBYTE is the virtual key.\n// HIBYTE is a set of modifiers:\n// HOTKEYF_ALT ALT key\n// HOTKEYF_CONTROL CONTROL key\n// HOTKEYF_SHIFT SHIFT key\n// HOTKEYF_EXT Extended key\n{\n\tif (!*aText)\n\t\treturn 0;\n\n\tBYTE modifiers = 0; // Set default.\n\tfor (; aText[1]; ++aText) // For each character except the last.\n\t{\n\t\tswitch (*aText)\n\t\t{\n\t\tcase '!': modifiers |= HOTKEYF_ALT; continue;\n\t\tcase '^': modifiers |= HOTKEYF_CONTROL; continue;\n\t\tcase '+': modifiers |= HOTKEYF_SHIFT; continue;\n\t\t//default: // Some other character type, so it marks the end of the modifiers.\n\t\t}\n\t\tbreak;\n\t}\n\n\t// For translating the virtual key below, the following notes apply:\n\t// The following extended keys are unlikely, and in any case don't have a non-extended counterpart,\n\t// so no special handling:\n\t// VK_CANCEL (Ctrl-break)\n\t// VK_SNAPSHOT (PrintScreen).\n\t//\n\t// These do not have a non-extended counterpart, i.e. their VK has only one possible scan code:\n\t// VK_DIVIDE (NumpadDivide/slash)\n\t// VK_NUMLOCK\n\t//\n\t// All of the following are handled properly via the scan code logic below:\n\t// VK_INSERT\n\t// VK_PRIOR\n\t// VK_NEXT\n\t// VK_HOME\n\t// VK_END\n\t// VK_UP\n\t// VK_DOWN\n\t// VK_LEFT\n\t// VK_RIGHT\n\t//\n\t// Same note as above but these cannot be typed by the user, only programmatically inserted via\n\t// initial value of \"Gui Add\" or via \"GuiControl,, MyHotkey, ^Delete\":\n\t// VK_DELETE\n\t// VK_RETURN\n\t// Note: NumpadEnter (not Enter) is extended, unlike Home/End/Pgup/PgDn/Arrows, which are\n\t// NON-extended on the keypad.\n\n\tmodLR_type mods = 0;\n\tBYTE vk = TextToVK(aText, &mods);\n\tif (!vk)\n\t\treturn 0; // Indicate total failure because the key text is invalid.\n\tif (mods & (MOD_LALT | MOD_RALT))\n\t\tmodifiers |= HOTKEYF_ALT;\n\tif (mods & (MOD_LCONTROL | MOD_RCONTROL))\n\t\tmodifiers |= HOTKEYF_CONTROL;\n\tif (mods & (MOD_LSHIFT | MOD_RSHIFT))\n\t\tmodifiers |= HOTKEYF_SHIFT;\n\t// Find out if the HOTKEYF_EXT flag should be set.\n\tsc_type sc = TextToSC(aText); // Better than vk_to_sc() since that has both an primary and secondary scan codes to choose from.\n\tif (!sc) // Since not found above, default to the primary scan code.\n\t\tsc = vk_to_sc(vk);\n\tif (sc & 0x100) // The scan code derived above is extended.\n\t\tmodifiers |= HOTKEYF_EXT;\n\treturn MAKEWORD(vk, modifiers);\n}\n\n\n\nLPTSTR GuiType::HotkeyToText(WORD aHotkey, LPTSTR aBuf)\n// Caller has ensured aBuf is large enough to hold any hotkey name.\n// Returns aBuf.\n{\n\tBYTE modifiers = HIBYTE(aHotkey); // In this case, both the VK and the modifiers are bytes, not words.\n\tLPTSTR cp = aBuf;\n\tif (modifiers & HOTKEYF_SHIFT)\n\t\t*cp++ = '+';\n\tif (modifiers & HOTKEYF_CONTROL)\n\t\t*cp++ = '^';\n\tif (modifiers & HOTKEYF_ALT)\n\t\t*cp++ = '!';\n\tBYTE vk = LOBYTE(aHotkey);\n\n\tif (modifiers & HOTKEYF_EXT) // Try to find the extended version of this VK if it has two versions.\n\t{\n\t\t// Fix for v1.0.37.03: A virtual key that has only one scan code should be resolved by VK\n\t\t// rather than SC. Otherwise, Numlock will wind up being SC145 and NumpadDiv something similar.\n\t\t// If a hotkey control could capture AppsKey, PrintScreen, Ctrl-Break (VK_CANCEL), which it can't, this\n\t\t// would also apply to them.\n\t\t// Fix for v1.1.26.02: Check sc2 != 0, not sc1 != sc2, otherwise the fix described above doesn't work.\n\t\tsc_type sc2 = vk_to_sc(vk, true); // Secondary scan code.\n\t\tif (sc2) // Non-zero means this key has two scan codes.\n\t\t{\n\t\t\tsc_type sc1 = vk_to_sc(vk); // Primary scan code for this virtual key.\n\t\t\tsc_type sc = (sc2 & 0x100) ? sc2 : sc1;\n\t\t\tif (sc & 0x100)\n\t\t\t{\n\t\t\t\tSCtoKeyName(sc, cp, 100);\n\t\t\t\treturn aBuf;\n\t\t\t}\n\t\t}\n\t}\n\t// Since above didn't return, use a simple lookup on VK, since it gives preference to non-extended keys.\n\treturn VKtoKeyName(vk, cp, 100);\n}\n\n\n\nvoid GuiType::ControlCheckRadioButton(GuiControlType &aControl, GuiIndexType aControlIndex, WPARAM aCheckType)\n{\n\tGuiIndexType radio_start, radio_end;\n\tFindGroup(aControlIndex, radio_start, radio_end); // Even if the return value is 1, do the below because it ensures things like tabstop are in the right state.\n\tif (aCheckType == BST_CHECKED)\n\t{\n\t\t// Testing shows that controls with different parent windows never behave as though they\n\t\t// are part of the same radio group. CheckRadioButton has been confirmed as working with\n\t\t// both non-dialog windows (such as Static/Text) and Tab3's tab dialog. This is required\n\t\t// for this function to work on Radio buttons within a Tab3 control:\n\t\tHWND hDlg = GetParent(aControl.hwnd);\n\t\t// This will check the specified button and uncheck all the others in the group.\n\t\t// There is at least one other reason to call CheckRadioButton() rather than doing something\n\t\t// manually: It prevents an unwanted firing of the radio's g-label upon WM_ACTIVATE,\n\t\t// at least when a radio group is first in the window's z-order and the radio group has\n\t\t// an initially selected button:\n\t\tCheckRadioButton(hDlg, GUI_INDEX_TO_ID(radio_start), GUI_INDEX_TO_ID(radio_end - 1), GUI_INDEX_TO_ID(aControlIndex));\n\t}\n\telse // Uncheck it.\n\t{\n\t\t// If the group was originally created with the tabstop style, unchecking the button that currently\n\t\t// has that style would also remove the tabstop style because apparently that's how radio buttons\n\t\t// respond to being unchecked. Compensate for this by giving the first radio in the group the\n\t\t// tabstop style. Update: The below no longer checks to see if the radio group has the tabstop style\n\t\t// because it's fairly pointless. This is because when the user checks/clicks a radio button,\n\t\t// the control automatically acquires the tabstop style. In other words, even though -Tabstop is\n\t\t// allowed in a radio's options, it will be overridden the first time a user selects a radio button.\n\t\tHWND first_radio_in_group = NULL;\n\t\t// Find the first radio in this control group:\n\t\tfor (GuiIndexType u = radio_start; u < radio_end; ++u)\n\t\t\tif (mControl[u]->type == GUI_CONTROL_RADIO) // Since a group can have non-radio controls in it.\n\t\t\t{\n\t\t\t\tfirst_radio_in_group = mControl[u]->hwnd;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t// The below can't be done until after the above because it would remove the tabstop style\n\t\t// if the specified radio happens to be the one that has the tabstop style. This is usually\n\t\t// the case since the button is usually on (since the script is now turning it off here),\n\t\t// and other logic has ensured that the on-button is the one with the tabstop style:\n\t\tSendMessage(aControl.hwnd, BM_SETCHECK, BST_UNCHECKED, 0);\n\t\tif (first_radio_in_group) // Apply the tabstop style to it.\n\t\t\tSetWindowLong(first_radio_in_group, GWL_STYLE, WS_TABSTOP | GetWindowLong(first_radio_in_group, GWL_STYLE));\n\t}\n}\n\n\n\nvoid GuiType::ControlSetUpDownOptions(GuiControlType &aControl, GuiControlOptionsType &aOpt)\n// Caller has ensured that aControl.type is an UpDown.\n{\n\tif (aOpt.range_changed)\n\t\tSendMessage(aControl.hwnd, UDM_SETRANGE32, aOpt.range_min, aOpt.range_max);\n}\n\n\n\nint GuiType::ControlGetDefaultSliderThickness(DWORD aStyle, int aThumbThickness)\n{\n\tif (aThumbThickness < 1)\n\t\taThumbThickness = 20; // Set default.\n\t// Provide a small margin on both sides, otherwise the bar is sometimes truncated.\n\taThumbThickness += 5; // 5 looks better than 4 in most styles/themes.\n\tif (aStyle & TBS_NOTICKS) // This takes precedence over TBS_BOTH (which if present will still make the thumb flat vs. pointed).\n\t\treturn DPIScale(aThumbThickness);\n\tif (aStyle & TBS_BOTH)\n\t\treturn DPIScale(aThumbThickness + 16);\n\treturn DPIScale(aThumbThickness + 8);\n}\n\n\n\nint GuiType::ControlInvertSliderIfNeeded(GuiControlType &aControl, int aPosition)\n// Caller has ensured that aControl.type is slider.\n{\n\treturn (aControl.attrib & GUI_CONTROL_ATTRIB_ALTBEHAVIOR)\n\t\t? ((int)SendMessage(aControl.hwnd, TBM_GETRANGEMAX, 0, 0) - aPosition) + (int)SendMessage(aControl.hwnd, TBM_GETRANGEMIN, 0, 0)\n\t\t: aPosition; // No inversion necessary.\n}\n\n\n\nvoid GuiType::ControlSetSliderOptions(GuiControlType &aControl, GuiControlOptionsType &aOpt)\n// Caller has ensured that aControl.type is slider.\n{\n\tif (aOpt.range_changed)\n\t{\n\t\t// Don't use TBM_SETRANGE because then only 16-bit values are supported:\n\t\tSendMessage(aControl.hwnd, TBM_SETRANGEMIN, FALSE, aOpt.range_min); // No redraw\n\t\tSendMessage(aControl.hwnd, TBM_SETRANGEMAX, TRUE, aOpt.range_max); // Redraw.\n\t}\n\tif (aOpt.tick_interval_changed)\n\t{\n\t\tif (aOpt.tick_interval < 0) // This is the signal to remove the existing tickmarks.\n\t\t\tSendMessage(aControl.hwnd, TBM_CLEARTICS, TRUE, 0);\n\t\telse if (aOpt.tick_interval_specified)\n\t\t\tSendMessage(aControl.hwnd, TBM_SETTICFREQ, aOpt.tick_interval, 0);\n\t\telse\n\t\t\t// +TickInterval without a value. TBS_AUTOTICKS was added, but doesn't take effect\n\t\t\t// until TBM_SETRANGE' or TBM_SETTICFREQ is sent. Since the script might have already\n\t\t\t// set an interval and there's no TBM_GETTICFREQ, use TBM_SETRANGEMAX to set the ticks.\n\t\t\tif (!aOpt.range_changed) // TBM_SETRANGEMAX wasn't already sent.\n\t\t\t{\n\t\t\t\tSendMessage(aControl.hwnd, TBM_SETRANGEMAX, TRUE\n\t\t\t\t\t, SendMessage(aControl.hwnd, TBM_GETRANGEMAX, 0, 0));\n\t\t\t}\n\t}\n\tif (aOpt.line_size > 0) // Removal is not supported, so only positive values are considered.\n\t\tSendMessage(aControl.hwnd, TBM_SETLINESIZE, 0, aOpt.line_size);\n\tif (aOpt.page_size > 0) // Removal is not supported, so only positive values are considered.\n\t\tSendMessage(aControl.hwnd, TBM_SETPAGESIZE, 0, aOpt.page_size);\n\tif (aOpt.thickness > 0)\n\t\tSendMessage(aControl.hwnd, TBM_SETTHUMBLENGTH, aOpt.thickness, 0);\n\tif (aOpt.tip_side)\n\t\tSendMessage(aControl.hwnd, TBM_SETTIPSIDE, aOpt.tip_side - 1, 0); // -1 to convert back to zero base.\n\n\t// Buddy positioning is left primitive and automatic even when auto-position of this slider\n\t// or the controls that come after it is in effect. This is because buddy controls seem too\n\t// rarely used (due to their lack of positioning options), which is the reason why extra code\n\t// isn't added here and in \"GuiControl Move\" to treat the buddies as part of the control rect\n\t// (i.e. as an entire unit), nor any code for auto-positioning the entire unit when the control\n\t// is created. If such code were added, it would require even more code if the slider itself\n\t// has an automatic position, because the positions of its buddies would have to be recorded,\n\t// then after they are set as buddies (which moves them) the slider is moved up or left to the\n\t// position where its buddies used to be. Otherwise, there would be a gap left during\n\t// auto-layout.\n\t// For these, removal is not supported, only changing, since removal seems too rarely needed:\n\tif (aOpt.buddy1)\n\t\tSendMessage(aControl.hwnd, TBM_SETBUDDY, TRUE, (LPARAM)aOpt.buddy1->hwnd); // Left/top\n\tif (aOpt.buddy2)\n\t\tSendMessage(aControl.hwnd, TBM_SETBUDDY, FALSE, (LPARAM)aOpt.buddy2->hwnd); // Right/bottom\n}\n\n\n\nvoid GuiType::ControlSetListViewOptions(GuiControlType &aControl, GuiControlOptionsType &aOpt)\n// Caller has ensured that aControl.type is ListView.\n// Caller has ensured that aOpt.color_bk is CLR_INVALID if no change should be made to the\n// current background color.\n{\n\tif (aOpt.limit)\n\t{\n\t\tif (ListView_GetItemCount(aControl.hwnd) > 0)\n\t\t\tSendMessage(aControl.hwnd, LVM_SETITEMCOUNT, aOpt.limit, 0); // Last parameter should be 0 for LVS_OWNERDATA (verified if you look at the definition of ListView_SetItemCount macro).\n\t\telse\n\t\t\t// When the control has no rows, work around the fact that LVM_SETITEMCOUNT delivers less than 20%\n\t\t\t// of its full benefit unless done after the first row is added (at least on XP SP1). The message\n\t\t\t// is deferred until later by setting this flag:\n\t\t\taControl.union_lv_attrib->row_count_hint = aOpt.limit;\n\t}\n\tif (aOpt.color != CLR_INVALID || aOpt.color_bk != CLR_INVALID)\n\t{\n\t\tif (aOpt.color != CLR_INVALID) // Explicit color change was requested.\n\t\t{\n\t\t\t// Although MSDN doesn't say, ListView_SetTextColor() appears to support CLR_DEFAULT.\n\t\t\tListView_SetTextColor(aControl.hwnd, aOpt.color);\n\t\t\taOpt.color = CLR_INVALID; // Let ControlParseOptions() know we handled it.\n\t\t}\n\t\tif (aOpt.color_bk != CLR_INVALID) // Explicit color change was requested.\n\t\t{\n\t\t\t// Making both the same seems the best default because BkColor only applies to the portion\n\t\t\t// of the control that doesn't have text in it, which is typically very little.\n\t\t\t// Unlike ListView_SetTextBkColor, ListView_SetBkColor() treats CLR_DEFAULT as black.\n\t\t\t// therefore, make them both GetSysColor(COLOR_WINDOW) for consistency. This color is\n\t\t\t// probably the default anyway:\n\t\t\tCOLORREF color = (aOpt.color_bk == CLR_DEFAULT) ? GetSysColor(COLOR_WINDOW) : aOpt.color_bk;\n\t\t\tListView_SetTextBkColor(aControl.hwnd, color);\n\t\t\tListView_SetBkColor(aControl.hwnd, color);\n\t\t}\n\t\t// It used to work without this; I don't know what conditions changed, but apparently it's needed\n\t\t// at least sometimes. The last param must be TRUE otherwise an space not filled by rows or columns\n\t\t// doesn't get updated:\n\t\tInvalidateRect(aControl.hwnd, NULL, TRUE);\n\t}\n}\n\n\n\nvoid GuiType::ControlSetTreeViewOptions(GuiControlType &aControl, GuiControlOptionsType &aOpt)\n// Caller has ensured that aControl.type is TreeView.\n// Caller has ensured that aOpt.color_bk is CLR_INVALID if no change should be made to the\n// current background color.\n{\n\tif (aOpt.color != CLR_INVALID) // Explicit color change was requested.\n\t{\n\t\tTreeView_SetTextColor(aControl.hwnd, aOpt.color == CLR_DEFAULT ? -1 : aOpt.color); // Must pass -1 rather than CLR_DEFAULT for TreeView controls.\n\t\taOpt.color = CLR_INVALID; // Let ControlParseOptions() know we handled it.\n\t}\n\tif (aOpt.color_bk != CLR_INVALID)\n\t\tTreeView_SetBkColor(aControl.hwnd, aOpt.color_bk == CLR_DEFAULT ? -1 : aOpt.color_bk);\n\t// Disabled because it apparently is not supported on XP:\n\t//if (aOpt.tabstop_count)\n\t//\t// Although TreeView_GetIndent() confirms that the following takes effect, it doesn't seem to \n\t//\t// cause any visible change, at least under XP SP2 (tried various style changes as well as Classic vs.\n\t//\t// XP theme, as well as the \"-Theme\" option.\n\t//\tTreeView_SetIndent(aControl.hwnd, aOpt.tabstop[0]);\n\n\t// Unlike ListView, seems not to be needed:\n\t//InvalidateRect(aControl.hwnd, NULL, TRUE);\n}\n\n\n\nvoid GuiType::ControlSetProgressOptions(GuiControlType &aControl, GuiControlOptionsType &aOpt, DWORD aStyle)\n// Caller has ensured that aControl.type is Progress.\n// Caller has ensured that aOpt.color_bk is CLR_INVALID if no change should be made to the\n// bar's current background color.\n{\n\t// If any options are present that cannot be manifest while a visual theme is in effect, ensure any\n\t// such theme is removed from the control (currently, once removed it is never put back on):\n\t// Override the default so that colors/smooth can be manifest even when non-classic theme is in effect.\n\tif ( IS_AN_ACTUAL_COLOR(aOpt.color)\n\t\t|| IS_AN_ACTUAL_COLOR(aOpt.color_bk)\n\t\t|| (aStyle & PBS_SMOOTH))\n\t\tSetWindowTheme(aControl.hwnd, L\"\", L\"\"); // Remove theme if options call for something theme can't show.\n\n\tif (aOpt.range_min || aOpt.range_max) // Must check like this because although it valid for one to be zero, both should not be.\n\t\tSendMessage(aControl.hwnd, PBM_SETRANGE32, aOpt.range_min, aOpt.range_max);\n\n\tif (aOpt.color != CLR_INVALID) // Explicit color change was requested.\n\t\tSendMessage(aControl.hwnd, PBM_SETBARCOLOR, 0, aOpt.color);\n\n\tif (aOpt.color_bk != CLR_INVALID) // Explicit color change was requested.\n\t\tSendMessage(aControl.hwnd, PBM_SETBKCOLOR, 0, aOpt.color_bk);\n}\n\n\n\nGuiControlType *GuiType::ControlOverrideBkColor(GuiControlType &aControl)\n// Caller has ensured that aControl.type is something for which the window's or tab control's background\n// should apply (e.g. Progress or Text).\n{\n\tGuiControlType *ptab_control;\n\tif (!mTabControlCount || !(ptab_control = FindTabControl(aControl.tab_control_index))\n\t\t|| ptab_control->background_color == CLR_INVALID) // Relies on short-circuit boolean order.\n\t\treturn NULL; // Override not needed because control isn't on a tab, or it's tab has same color as window.\n\tif (GetParent(aControl.hwnd) != mHwnd)\n\t\t// Even if the control doesn't lie entirely within the tab control's display area,\n\t\t// it is only visible within that area due to the parent-child relationship.\n\t\treturn ptab_control;\n\t// Does this control lie mostly inside the tab? Note that controls can belong to a tab page even though\n\t// they aren't physically located inside the page.\n\tRECT overlap_rect, tab_rect, control_rect;\n\tGetWindowRect(ptab_control->hwnd, &tab_rect);\n\tGetWindowRect(aControl.hwnd, &control_rect);\n\tIntersectRect(&overlap_rect, &tab_rect, &control_rect);\n\t// Returns true if more than 50% of control's area is inside the tab:\n\treturn (overlap_rect.right - overlap_rect.left) * (overlap_rect.bottom - overlap_rect.top)\n\t\t> 0.5 * (control_rect.right - control_rect.left) * (control_rect.bottom - control_rect.top)\n\t\t? ptab_control : NULL;\n}\n\n\n\nvoid GuiType::ControlGetBkColor(GuiControlType &aControl, bool aUseWindowColor, HBRUSH &aBrush, COLORREF &aColor)\n{\n\tif (aControl.background_color != CLR_INVALID)\n\t{\n\t\taBrush = aControl.background_brush;\n\t\taColor = aControl.background_color;\n\t}\n\telse if (aUseWindowColor)\n\t{\n\t\t// If this static control both belongs to a tab control and is within its physical boundaries,\n\t\t// match its background to the tab control's. This is only necessary if the tab control has\n\t\t// the +/-Background option, since otherwise its background would be the same as the window's:\n\t\tif (GuiControlType *tab_control = ControlOverrideBkColor(aControl))\n\t\t{\n\t\t\taBrush = tab_control->background_brush;\n\t\t\taColor = tab_control->background_color;\n\t\t}\n\t\telse\n\t\t{\n\t\t\taBrush = mBackgroundBrushWin;\n\t\t\taColor = mBackgroundColorWin;\n\t\t}\n\t}\n\telse\n\t{\n\t\t// Caller requires these initialised.\n\t\taBrush = NULL;\n\t\taColor = CLR_DEFAULT;\n\t}\n}\n\n\n\nvoid GuiType::ControlUpdateCurrentTab(GuiControlType &aTabControl, bool aFocusFirstControl)\n// Handles the selection of a new tab in a tab control.\n{\n\tint curr_tab_index = TabCtrl_GetCurSel(aTabControl.hwnd);\n\t// If there's no tab selected, any controls contained by the tab control should be hidden.\n\t// This can happen if all tabs are removed, such as by GuiControl,,TabCtl,|\n\t//if (curr_tab_index == -1) // No tab is selected.\n\t//\treturn;\n\n\t// Fix for v1.0.23:\n\t// If the tab control lacks the visible property, hide all its controls on all its tabs.\n\t// Don't use IsWindowVisible() because that would say that tab is hidden just because the parent\n\t// window is hidden, which is not desirable because then when the parent is shown, the shower\n\t// would always have to remember to call us. This \"hide all\" behavior is done here rather than\n\t// attempting to \"rely on everyone else to do their jobs of keeping the controls in the right state\"\n\t// because it improves maintainability:\n\tDWORD tab_style = GetWindowLong(aTabControl.hwnd, GWL_STYLE);\n\tbool hide_all = !(tab_style & WS_VISIBLE); // Regardless of whether mHwnd is visible or not.\n\tbool disable_all = (tab_style & WS_DISABLED); // Don't use IsWindowEnabled() because it might return false if parent is disabled?\n\t// Say that the focus was already set correctly if the entire tab control is hidden or caller said\n\t// not to focus it:\n\tbool focus_was_set;\n\tbool parent_is_visible = IsWindowVisible(mHwnd);\n\tbool parent_is_visible_and_not_minimized = parent_is_visible && !IsIconic(mHwnd);\n\tif (hide_all || disable_all)\n\t\tfocus_was_set = true; // Tell the below not to set focus, since all tab controls are hidden or disabled.\n\telse if (aFocusFirstControl) // Note that SetFocus() has an effect even if the parent window is hidden. i.e. next time the window is shown, the control will be focused.\n\t\tfocus_was_set = false; // Tell it to focus the first control on the new page.\n\telse\n\t{\n\t\tHWND focused_hwnd;\n\t\tGuiControlType *focused_control;\n\t\t// If the currently focused control is somewhere in this tab control (but not the tab control\n\t\t// itself, because arrow-key navigation relies on tabs stay focused while the user is pressing\n\t\t// left and right-arrow), override the fact that aFocusFirstControl is false so that when the\n\t\t// page changes, its first control will be focused:\n\t\tfocus_was_set = !( parent_is_visible && (focused_hwnd = GetFocus())\n\t\t\t&& (focused_control = FindControl(focused_hwnd))\n\t\t\t&& focused_control->tab_control_index == aTabControl.tab_index );\n\t}\n\n\tbool will_be_visible, will_be_enabled, has_visible_style, has_enabled_style, member_of_current_tab, control_state_altered;\n\tDWORD style;\n\tRECT rect, tab_rect;\n\tPOINT *rect_pt = (POINT *)▭ // i.e. have rect_pt be an array of the two points already within rect.\n\n\tGetWindowRect(aTabControl.hwnd, &tab_rect);\n\n\t// Update: Don't do the below because it causes a tab to look focused even when it isn't in cases\n\t// where a control was focused while drawing was suspended. This is because the below omits the\n\t// tab rows themselves from the InvalidateRect() further below:\n\t// Tabs on left (TCS_BUTTONS only) require workaround, at least on XP. Otherwise tab_rect.left will be\n\t// much too large. Because of this, include entire tab rect if it can't be \"deflated\" reliably:\n\t//if (!(tab_style & TCS_VERTICAL) || (tab_style & TCS_RIGHT) || !(tab_style & TCS_BUTTONS))\n\t//\tTabCtrl_AdjustRect(aTabControl.hwnd, FALSE, &tab_rect); // Reduce it to just the area without the tabs, since the tabs have already been redrawn.\n\n\tHWND tab_dialog = (HWND)GetProp(aTabControl.hwnd, _T(\"ahk_dlg\"));\n\tif (tab_dialog)\n\t\t// Hiding the tab dialog and showing after re-enabling redraw solves an issue with ActiveX\n\t\t// WebBrowser controls not being redrawn (seems to be a WM_SETREDRAW glitch).\n\t\tShowWindow(tab_dialog, SW_HIDE);\n\n\t// For a likely cleaner transition between tabs, disable redrawing until the switch is complete.\n\t// Doing it this way also serves to refresh a tab whose controls have just been disabled via\n\t// something like \"GuiControl, Disable, MyTab\", which would otherwise not happen because unlike\n\t// ShowWindow(), EnableWindow() apparently does not cause a repaint to occur.\n\t// Fix for v1.0.25.14: Don't send the message below (and its counterpart later on) because that\n\t// sometimes or always, as a side-effect, shows the window if it's hidden:\n\t// Fix for v1.1.27.07: WM_SETREDRAW appears to have the effect of clearing the update region\n\t// (causing any pending redraw, such as by a previous call to this function for a different tab\n\t// control, to be discarded). To work around this, save the current update region.\n\tRECT update_rect = {0}; // For simplicity, use GetUpdateRect() vs GetUpdateRgn().\n\tif (parent_is_visible_and_not_minimized)\n\t{\n\t\tGetUpdateRect(mHwnd, &update_rect, FALSE);\n\t\tSendMessage(mHwnd, WM_SETREDRAW, FALSE, 0);\n\t}\n\tbool invalidate_entire_parent = false; // Set default.\n\n\t// Even if mHwnd is hidden, set styles to Show/Hide and Enable/Disable any controls that need it.\n\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t{\n\t\t// Note aTabControl.tab_index stores aTabControl's tab_control_index (true only for type GUI_CONTROL_TAB).\n\t\tif (mControl[u]->tab_control_index != aTabControl.tab_index) // This control is not in this tab control.\n\t\t\tcontinue;\n\t\tGuiControlType &control = *mControl[u]; // Probably helps performance; certainly improves conciseness.\n\t\tmember_of_current_tab = (control.tab_index == curr_tab_index);\n\t\twill_be_visible = !hide_all && member_of_current_tab && !(control.attrib & GUI_CONTROL_ATTRIB_EXPLICITLY_HIDDEN);\n\t\twill_be_enabled = !disable_all && member_of_current_tab && !(control.attrib & GUI_CONTROL_ATTRIB_EXPLICITLY_DISABLED);\n\t\t// Above: Disabling the control when it's not on the current tab means that it can't be\n\t\t// activated, even by a keyboard shorcut - for instance, a button with text \"&Click me\"\n\t\t// could be activated by pressing Alt+C if the control was enabled but hidden.\n\t\t// Don't use IsWindowVisible() because if the parent window is hidden, I think that will\n\t\t// always say that the controls are hidden too. In any case, IsWindowVisible() does not\n\t\t// work correctly for this when the window is first shown:\n\t\tstyle = GetWindowLong(control.hwnd, GWL_STYLE);\n\t\thas_visible_style = style & WS_VISIBLE;\n\t\thas_enabled_style = !(style & WS_DISABLED);\n\t\t// Showing/hiding/enabling/disabling only when necessary might cut down on redrawing:\n\t\tcontrol_state_altered = false; // Set default.\n\t\tif (will_be_visible != has_visible_style)\n\t\t{\n\t\t\tShowWindow(control.hwnd, will_be_visible ? SW_SHOWNOACTIVATE : SW_HIDE);\n\t\t\tcontrol_state_altered = true;\n\t\t}\n\t\tif (will_be_enabled != has_enabled_style)\n\t\t{\n\t\t\t// Note that it seems to make sense to disable even text/pic/groupbox controls because\n\t\t\t// they can receive clicks and double clicks (except GroupBox).\n\t\t\tEnableWindow(control.hwnd, will_be_enabled);\n\t\t\tcontrol_state_altered = true;\n\t\t}\n\t\tif (control_state_altered)\n\t\t{\n\t\t\t// If this altered control lies at least partially outside the tab's interior,\n\t\t\t// set it up to do the full repaint of the parent window:\n\t\t\tGetWindowRect(control.hwnd, &rect);\n\t\t\tif (!(PtInRect(&tab_rect, rect_pt[0]) && PtInRect(&tab_rect, rect_pt[1])))\n\t\t\t\tinvalidate_entire_parent = true;\n\t\t}\n\t\t// The above's use of show/hide across a wide range of controls may be necessary to support things\n\t\t// such as the dynamic removal of tabs via \"GuiControl,, MyTab, |NewTabSet1|NewTabSet2\", i.e. if the\n\t\t// newly added removed tab was active, it's controls should now be hidden.\n\t\t// The below sets focus to the first input-capable control, which seems standard for the tab-control\n\t\t// dialogs I've seen.\n\t\tif (!focus_was_set && member_of_current_tab && will_be_visible && will_be_enabled)\n\t\t{\n\t\t\tswitch(control.type)\n\t\t\t{\n\t\t\tcase GUI_CONTROL_TEXT:\n\t\t\tcase GUI_CONTROL_PIC:\n\t\t\tcase GUI_CONTROL_GROUPBOX:\n\t\t\tcase GUI_CONTROL_PROGRESS:\n\t\t\tcase GUI_CONTROL_MONTHCAL:\n\t\t\tcase GUI_CONTROL_UPDOWN: // It appears that not even non-buddied up-downs can be focused.\n\t\t\t\tbreak; // Do nothing for the above types because they cannot be focused.\n\t\t\tdefault:\n\t\t\t//case GUI_CONTROL_STATUSBAR: Nothing needs to be done because other logic has ensured it can't be a member of any tab.\n\t\t\t//case GUI_CONTROL_BUTTON:\n\t\t\t//case GUI_CONTROL_CHECKBOX:\n\t\t\t//case GUI_CONTROL_RADIO:\n\t\t\t//case GUI_CONTROL_DROPDOWNLIST:\n\t\t\t//case GUI_CONTROL_COMBOBOX:\n\t\t\t//case GUI_CONTROL_LISTBOX:\n\t\t\t//case GUI_CONTROL_LISTVIEW:\n\t\t\t//case GUI_CONTROL_TREEVIEW:\n\t\t\t//case GUI_CONTROL_EDIT:\n\t\t\t//case GUI_CONTROL_DATETIME:\n\t\t\t//case GUI_CONTROL_HOTKEY:\n\t\t\t//case GUI_CONTROL_SLIDER:\n\t\t\t//case GUI_CONTROL_TAB:\n\t\t\t//case GUI_CONTROL_LINK:\n\t\t\t\t// Fix for v1.0.24: Don't check the return value of SetFocus() because sometimes it returns\n\t\t\t\t// NULL even when the call will wind up succeeding. For example, if the user clicks on\n\t\t\t\t// the second tab in a tab control, SetFocus() will probably return NULL because there\n\t\t\t\t// is not previously focused control at the instant the call is made. This is because\n\t\t\t\t// the control that had focus has likely already been hidden and thus lost focus before\n\t\t\t\t// we arrived at this stage:\n\t\t\t\tSetFocus(control.hwnd); // Note that this has an effect even if the parent window is hidden. i.e. next time the parent is shown, this control will be focused.\n\t\t\t\tfocus_was_set = true; // i.e. SetFocus() only for the FIRST control that meets the above criteria.\n\t\t\t}\n\t\t}\n\t}\n\n\tif (parent_is_visible_and_not_minimized) // Fix for v1.0.25.14. See further above for details.\n\t\tSendMessage(mHwnd, WM_SETREDRAW, TRUE, 0); // Re-enable drawing before below so that tab can be focused below.\n\n\tif (tab_dialog && !hide_all)\n\t\tShowWindow(tab_dialog, SW_SHOW);\n\n\t// In case tab is empty or there is no control capable of receiving focus, focus the tab itself\n\t// instead. This allows the Ctrl-Pgdn/Pgup keyboard shortcuts to continue to navigate within\n\t// this tab control rather than having the focus get kicked backed outside the tab control\n\t// -- which I think happens when the tab contains no controls or only text controls (pic controls\n\t// seem okay for some reason), i.e. if the control with focus is hidden, the dialog falls back to\n\t// giving the focus to the the first focus-capable control in the z-order.\n\tif (!focus_was_set)\n\t\tSetFocus(aTabControl.hwnd); // Note that this has an effect even if the parent window is hidden. i.e. next time the parent is shown, this control will be focused.\n\n\t// UPDATE: Below is now only done when necessary to cut down on flicker:\n\t// Seems best to invalidate the entire client area because otherwise, if any of the tab's controls lie\n\t// outside of its interior (this is common for TCS_BUTTONS style), they would not get repainted properly.\n\t// In addition, tab controls tend to occupy the majority of their parent's client area anyway:\n\tif (parent_is_visible_and_not_minimized)\n\t{\n\t\tif (invalidate_entire_parent)\n\t\t\tInvalidateRect(mHwnd, NULL, TRUE); // TRUE seems safer.\n\t\telse\n\t\t{\n\t\t\tif (update_rect.left != update_rect.right)\n\t\t\t\t// Reset the window's update region, which was likely cleared by WM_SETREDRAW.\n\t\t\t\t// Doing this separately to tab_rect might perform better than using UnionRect(),\n\t\t\t\t// which could cover a much larger area than necessary. The system should handle\n\t\t\t\t// the case where the two rects overlap (i.e. there won't be redundant repainting).\n\t\t\t\tInvalidateRect(mHwnd, &update_rect, TRUE);\n\t\t\tMapWindowPoints(NULL, mHwnd, (LPPOINT)&tab_rect, 2); // Convert rect to client coordinates (not the same as GetClientRect()).\n\t\t\tInvalidateRect(mHwnd, &tab_rect, TRUE); // Seems safer to use TRUE, not knowing all possible overlaps, etc.\n\t\t}\n\t}\n}\n\n\n\nGuiControlType *GuiType::FindTabControl(TabControlIndexType aTabControlIndex)\n{\n\tif (aTabControlIndex == MAX_TAB_CONTROLS)\n\t\t// This indicates it's not a member of a tab control. Callers rely on this check.\n\t\treturn NULL;\n\tTabControlIndexType tab_control_index = 0;\n\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t\tif (mControl[u]->type == GUI_CONTROL_TAB)\n\t\t\tif (tab_control_index == aTabControlIndex)\n\t\t\t\treturn mControl[u];\n\t\t\telse\n\t\t\t\t++tab_control_index;\n\treturn NULL; // Since above didn't return, indicate failure.\n}\n\n\n\nint GuiType::FindTabIndexByName(GuiControlType &aTabControl, LPTSTR aName, bool aExactMatch)\n// Find the first tab in this tab control whose leading-part-of-name matches aName.\n// Return int vs. TabIndexType so that failure can be indicated.\n{\n\tint tab_count = TabCtrl_GetItemCount(aTabControl.hwnd);\n\t// Although strictly performing a leading-part-of-name match should technically cause\n\t// an empty string to result in the first item (index 0), it seems unlikely that a user\n\t// would expect that. The caller should verify *aName != 0.\n\tif (!tab_count || !*aName)\n\t\treturn -1; // No match.\n\n\tTCITEM tci;\n\ttci.mask = TCIF_TEXT;\n\tTCHAR buf[1024];\n\ttci.pszText = buf;\n\ttci.cchTextMax = _countof(buf) - 1; // MSDN example uses -1.\n\n\tsize_t aName_length = _tcslen(aName);\n\tif (aName_length >= _countof(buf)) // Checking this early avoids having to check it in the loop.\n\t\treturn -1; // No match possible.\n\n\tfor (int i = 0; i < tab_count; ++i)\n\t{\n\t\tif (TabCtrl_GetItem(aTabControl.hwnd, i, &tci))\n\t\t{\n\t\t\tif (!aExactMatch)\n\t\t\t\ttci.pszText[aName_length] = '\\0'; // Facilitates checking of only the leading part like strncmp(). Buffer overflow is impossible due to a check higher above.\n\t\t\tif (!_tcsicmp(tci.pszText, aName)) // Match found.\n\t\t\t\treturn i;\n\t\t}\n\t}\n\n\t// Since above didn't return, no match found.\n\treturn -1;\n}\n\n\n\nint GuiType::GetControlCountOnTabPage(TabControlIndexType aTabControlIndex, TabIndexType aTabIndex)\n{\n\tint count = 0;\n\tfor (GuiIndexType u = 0; u < mControlCount; ++u)\n\t\tif (mControl[u]->tab_index == aTabIndex && mControl[u]->tab_control_index == aTabControlIndex) // This boolean order helps performance.\n\t\t\t++count;\n\treturn count;\n}\n\n\n\nvoid GuiType::GetTabDisplayAreaRect(HWND aTabControlHwnd, RECT &aRect)\n// Gets coordinates of tab control's display area relative to parent window's client area.\n{\n\tRECT rect;\n\tGetClientRect(aTabControlHwnd, &rect); // Used because the coordinates of its upper-left corner are (0,0).\n\tDWORD style = GetWindowLong(aTabControlHwnd, GWL_STYLE);\n\tif (style & TCS_BUTTONS) // Workarounds are needed for TCS_BUTTONS.\n\t{\n\t\tRECT item_rect;\n\t\tTabCtrl_GetItemRect(aTabControlHwnd, 0, &item_rect);\n\t\tint row_count = TabCtrl_GetRowCount(aTabControlHwnd);\n\t\tconst int offset = 3; // The margin between buttons seems to be 3 pixels.\n\t\tif (style & TCS_VERTICAL)\n\t\t{\n\t\t\t// TabCtrl_AdjustRect would not work for these cases.\n\t\t\tint width = (item_rect.right - item_rect.left + offset) * row_count;\n\t\t\tif (style & TCS_RIGHT)\n\t\t\t\trect.right -= width;\n\t\t\telse\n\t\t\t\trect.left += width;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tint height = (item_rect.bottom - item_rect.top + offset) * row_count;\n\t\t\tif (style & TCS_BOTTOM)\n\t\t\t\t// TabCtrl_AdjustRect would not work for this case.\n\t\t\t\trect.bottom -= height;\n\t\t\telse\n\t\t\t\t// TabCtrl_AdjustRect plus an adjustment of bottom += 3 would work,\n\t\t\t\t// but it's easier to handle this case alongside TCS_BOTTOM (above).\n\t\t\t\trect.top += height;\n\t\t}\n\t}\n\telse\n\t{\n\t\tTabCtrl_AdjustRect(aTabControlHwnd, FALSE, &rect); // Retrieve the area beneath the tabs.\n\t\trect.left -= 2; // Testing shows that X (but not Y) is off by exactly 2.\n\t}\n\tMapWindowPoints(aTabControlHwnd, mHwnd, (LPPOINT)&rect, 2); // Convert tab-control-relative coordinates to Gui-relative.\n\taRect.left = rect.left;\n\taRect.right = rect.right;\n\taRect.top = rect.top;\n\taRect.bottom = rect.bottom;\n}\n\n\n\nPOINT GuiType::GetPositionOfTabDisplayArea(GuiControlType &aTabControl)\n// Gets position of tab control's display area relative to parent window's client area.\n{\n\tRECT rect;\n\tGetTabDisplayAreaRect(aTabControl.hwnd, rect);\n\tPOINT pt = { rect.left, rect.top };\n\treturn pt;\n}\n\n\n\nResultType GuiType::SelectAdjacentTab(GuiControlType &aTabControl, bool aMoveToRight, bool aFocusFirstControl\n\t, bool aWrapAround)\n{\n\tint tab_count = TabCtrl_GetItemCount(aTabControl.hwnd);\n\tif (!tab_count)\n\t\treturn FAIL;\n\n\tint selected_tab = TabCtrl_GetCurSel(aTabControl.hwnd);\n\tif (selected_tab == -1) // Not sure how this can happen in this case (since it has at least one tab).\n\t\tselected_tab = aMoveToRight ? 0 : tab_count - 1; // Select the first or last tab.\n\telse\n\t{\n\t\tif (aMoveToRight) // e.g. Ctrl-PgDn or Ctrl-Tab, right-arrow\n\t\t{\n\t\t\t++selected_tab;\n\t\t\tif (selected_tab >= tab_count) // wrap around to the start\n\t\t\t{\n\t\t\t\tif (!aWrapAround)\n\t\t\t\t\treturn FAIL; // Indicate that tab was not selected due to non-wrap.\n\t\t\t\tselected_tab = 0;\n\t\t\t}\n\t\t}\n\t\telse // Ctrl-PgUp or Ctrl-Shift-Tab\n\t\t{\n\t\t\t--selected_tab;\n\t\t\tif (selected_tab < 0) // wrap around to the end\n\t\t\t{\n\t\t\t\tif (!aWrapAround)\n\t\t\t\t\treturn FAIL; // Indicate that tab was not selected due to non-wrap.\n\t\t\t\tselected_tab = tab_count - 1;\n\t\t\t}\n\t\t}\n\t}\n\t// MSDN: \"A tab control does not send a TCN_SELCHANGING or TCN_SELCHANGE notification message\n\t// when a tab is selected using the TCM_SETCURSEL message.\"\n\tTabCtrl_SetCurSel(aTabControl.hwnd, selected_tab);\n\tControlUpdateCurrentTab(aTabControl, aFocusFirstControl);\n\n\t// Fix for v1.0.35: Keyboard navigation of a tab control should still launch the tab's event handler\n\t// if it has one:\n\tEvent(GUI_HWND_TO_INDEX(aTabControl.hwnd), TCN_SELCHANGE, GUI_EVENT_CHANGE);\n\n\treturn OK;\n}\n\n\n\nvoid GuiType::AutoSizeTabControl(GuiControlType &aTabControl)\n{\n\tint autosize = (int)(INT_PTR)GetProp(aTabControl.hwnd, _T(\"ahk_autosize\"));\n\tif (!autosize)\n\t\treturn;\n\tRemoveProp(aTabControl.hwnd, _T(\"ahk_autosize\"));\n\n\t// Below: MUST NOT initialize to zero, since these are screen coordinates\n\t// and it is possible to position the GUI prior to this function being called.\n\tint tab_index = aTabControl.tab_index, right = INT_MIN, bottom = INT_MIN;\n\tRECT rc;\n\n\tfor (GuiIndexType i = 0; i < mControlCount; ++i)\n\t{\n\t\tif (mControl[i]->tab_control_index != tab_index)\n\t\t\tcontinue;\n\t\tGetWindowRect(mControl[i]->hwnd, &rc);\n\t\tif (right < rc.right)\n\t\t\tright = rc.right;\n\t\tif (bottom < rc.bottom)\n\t\t\tbottom = rc.bottom;\n\t}\n\n\t// Testing shows that -32768 is the minimum screen coordinate, but even if\n\t// that's not always the case, a right edge of INT_MIN would mean that the\n\t// controls have 0 width, since window positions are 32-bit at most.\n\tBOOL at_least_one_control = right != INT_MIN;\n\n\tRECT tab_rect;\n\tGetWindowRect(aTabControl.hwnd, &tab_rect);\n\tif ((autosize & TAB3_AUTOWIDTH) && at_least_one_control)\n\t\ttab_rect.right = right + mMarginX + 4;\n\tif ((autosize & TAB3_AUTOHEIGHT) && at_least_one_control)\n\t\ttab_rect.bottom = bottom + mMarginY + 4;\n\tMapWindowPoints(NULL, mHwnd, (LPPOINT)&tab_rect, 2); // Screen to GUI client.\n\tint width = tab_rect.right - tab_rect.left\n\t\t, height = tab_rect.bottom - tab_rect.top;\n\n\tDWORD style = GetWindowLong(aTabControl.hwnd, GWL_STYLE);\n\t\n\t// The number of \"rows\" of vertical buttons affect the tab control's width,\n\t// while horizontal buttons affect its height; so check the appropriate flag:\n\tbool adjust_for_rows = 0 != (autosize & ((style & TCS_VERTICAL) ? TAB3_AUTOWIDTH : TAB3_AUTOHEIGHT));\n\t// For TCS_RIGHT, we need to adjust even when there's only one row before and after:\n\tint rows_before = (!adjust_for_rows || (style & TCS_RIGHT)) ? 0 : TabCtrl_GetRowCount(aTabControl.hwnd);\n\t\n\t// Apply new size.\n\tMoveWindow(aTabControl.hwnd, tab_rect.left, tab_rect.top, width, height, TRUE);\n\n\tif (adjust_for_rows)\n\t{\n\t\tint rows_after = TabCtrl_GetRowCount(aTabControl.hwnd);\n\t\tif (rows_before != rows_after)\n\t\t{\n\t\t\t// Adjust for the newly added tab rows/columns.\n\t\t\tRECT item_rect;\n\t\t\tTabCtrl_GetItemRect(aTabControl.hwnd, 0, &item_rect);\n\t\t\tint offset = (style & TCS_BUTTONS) ? 3 : 0; // The margin between buttons seems to be 3 pixels.\n\t\t\tif (style & TCS_VERTICAL) // Tabs on left/right.\n\t\t\t{\n\t\t\t\twidth += (rows_after - rows_before) * (item_rect.right - item_rect.left + offset);\n\t\t\t\ttab_rect.right = tab_rect.left + width;\n\t\t\t}\n\t\t\telse // Tabs on top/bottom.\n\t\t\t{\n\t\t\t\theight += (rows_after - rows_before) * (item_rect.bottom - item_rect.top + offset);\n\t\t\t\ttab_rect.bottom = tab_rect.top + height;\n\t\t\t}\n\t\t\t// Apply size adjustment.\n\t\t\tMoveWindow(aTabControl.hwnd, tab_rect.left, tab_rect.top, width, height, TRUE);\n\t\t}\n\t}\n\t\n\tif (mControl[mControlCount-1]->tab_control_index == tab_index // The previous control belongs to this tab control.\n\t\t|| !at_least_one_control) // Empty Tab3. See below.\n\t{\n\t\t// Position next control relative to the tab control rather than its last child control.\n\t\tmPrevX = tab_rect.left;\n\t\tmPrevY = tab_rect.top;\n\t\tmPrevWidth = width;\n\t\tmPrevHeight = height;\n\t\t// This is used by some positioning modes, but is also required for auto-sizing of the Gui\n\t\t// to account for the auto-sized Tab3 control (even if it has retained its default size):\n\t\tif (mMaxExtentRight < tab_rect.right)\n\t\t\tmMaxExtentRight = tab_rect.right;\n\t\tif (mMaxExtentDown < tab_rect.bottom)\n\t\t\tmMaxExtentDown = tab_rect.bottom;\n\t}\n}\n\n\n\nResultType GuiType::CreateTabDialog(GuiControlType &aTabControl, GuiControlOptionsType &aOpt)\n// Creates a dialog to host controls for a tab control.\n{\n\tHWND tab_dialog;\n\tstruct MYDLG : DLGTEMPLATE\n\t{\n\t\tWORD wNoMenu;\n\t\tWORD wStdClass;\n\t\tWORD wNoTitle;\n\t};\n\tMYDLG dlg;\n\tZeroMemory(&dlg, sizeof(dlg));\n\tdlg.style = WS_VISIBLE | WS_CHILD | DS_CONTROL; // DS_CONTROL enables proper tab navigation and possibly other things.\n\t//dlg.dwExtendedStyle = WS_EX_CONTROLPARENT; // Redundant; DS_CONTROL causes this to be applied.\n\t// Create the dialog.\n\ttab_dialog = CreateDialogIndirect(g_hInstance, &dlg, mHwnd, TabDialogProc);\n\tif (!tab_dialog)\n\t\treturn FAIL;\n\tif (!SetProp(aTabControl.hwnd, _T(\"ahk_dlg\"), tab_dialog))\n\t{\n\t\tDestroyWindow(tab_dialog);\n\t\treturn FAIL;\n\t}\n\tLONG attrib = aTabControl.tab_index;\n\tif (aOpt.use_theme)\n\t{\n\t\t// Apply a tab control background to the tab dialog. This also affects\n\t\t// the backgrounds of some controls, such as Radio and Groupbox controls.\n\t\tEnableThemeDialogTexture(tab_dialog, 6); // ETDT_ENABLETAB = 6\n\t\tattrib |= TABDIALOG_ATTRIB_THEMED;\n\t}\n\tSetWindowLongPtr(tab_dialog, GWLP_USERDATA, attrib);\n\tif (!((mExStyle = GetWindowLong(mHwnd, GWL_EXSTYLE)) & WS_EX_CONTROLPARENT))\n\t\t// WS_EX_CONTROLPARENT must be applied to the parent window as well as the\n\t\t// tab dialog to allow tab navigation to work correctly. With it applied\n\t\t// only to the tab dialog, tabbing out of a multi-line edit control won't\n\t\t// work if it is the last control on a tab.\n\t\tSetWindowLong(mHwnd, GWL_EXSTYLE, mExStyle |= WS_EX_CONTROLPARENT);\n\treturn OK;\n}\n\n\n\nvoid GuiType::UpdateTabDialog(HWND aTabControlHwnd)\n// Positions a tab control's container dialog to fill the tab control's display area.\n{\n\tHWND tab_dialog = (HWND)GetProp(aTabControlHwnd, _T(\"ahk_dlg\"));\n\tif (tab_dialog) // It's a Tab3 control.\n\t{\n\t\tRECT rect;\n\t\tGetTabDisplayAreaRect(aTabControlHwnd, rect);\n\t\tMoveWindow(tab_dialog, rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, TRUE);\n\t}\n}\n\n\n\nHBRUSH CreateTabDialogBrush(HWND aDlg, HDC aCompatibleDC)\n{\n\tHBRUSH brush = NULL;\n\tRECT rect;\n\tGetClientRect(aDlg, &rect);\n\tif (HDC bitmap_dc = CreateCompatibleDC(aCompatibleDC))\n\t{\n\t\tif (HBITMAP bitmap = CreateCompatibleBitmap(aCompatibleDC, rect.right, rect.bottom))\n\t\t{\n\t\t\tHBITMAP prev_bitmap = (HBITMAP)SelectObject(bitmap_dc, bitmap);\n\n\t\t\t// Print the tab control into the bitmap.\n\t\t\tSendMessage(aDlg, WM_PRINTCLIENT, (WPARAM)bitmap_dc, PRF_CLIENT);\n\n\t\t\t// Create a brush from the bitmap.\n\t\t\tbrush = CreatePatternBrush(bitmap);\n\n\t\t\tSelectObject(bitmap_dc, prev_bitmap);\n\t\t\tDeleteObject(bitmap);\n\t\t}\n\t\tDeleteDC(bitmap_dc);\n\t}\n\treturn brush;\n}\n\n\n\nINT_PTR CALLBACK TabDialogProc(HWND hDlg, UINT uMsg, WPARAM wParam, LPARAM lParam)\n{\n\tswitch (uMsg)\n\t{\n\t// Messages to be forwarded to the main GUI window:\n\tcase WM_COMMAND:\n\tcase WM_NOTIFY:\n\tcase WM_VSCROLL: // These two should only be received for sliders and up-downs.\n\tcase WM_HSCROLL: //\n\tcase WM_CONTEXTMENU:\n\t//case WM_DROPFILES: // Not sent to the tab dialog since it doesn't accept drop.\n\tcase WM_CTLCOLOREDIT:\n\tcase WM_CTLCOLORLISTBOX:\n\tcase WM_CTLCOLORSTATIC:\n\tcase WM_CTLCOLORBTN: // Not used directly, but might be used by script.\n\tcase WM_CTLCOLORSCROLLBAR: // As above.\n\t\tif (GuiType *pgui = GuiType::FindGui(GetParent(hDlg)))\n\t\t{\n\t\t\t// For Slider and Link controls to look right in a themed tab control, this custom\n\t\t\t// handling is needed. This also handles other controls for simplicity, although\n\t\t\t// there are easier methods available for them:\n\t\t\t// - Text/Picture: BackgroundTrans works (and overrides this section)\n\t\t\t// - Check/Radio/Group: EnableThemeDialogTexture() is enough\n\t\t\t// Unlike IsThemeActive, IsAppThemed will return false if the \"Disable visual styles\"\n\t\t\t// compatibility setting is turned on for this script's EXE.\n\t\t\tGuiControlType *pcontrol;\n\t\t\tif ( uMsg == WM_CTLCOLORSTATIC\n\t\t\t\t&& (TABDIALOG_ATTRIB_THEMED & GetWindowLongPtr(hDlg, GWLP_USERDATA))\n\t\t\t\t&& (pcontrol = pgui->FindControl((HWND)lParam))\n\t\t\t\t&& (pcontrol->background_color != CLR_TRANSPARENT)\n\t\t\t\t&& IsAppThemed() )\n\t\t\t{\n\t\t\t\tHDC hdc = (HDC)wParam;\n\t\t\t\tHBRUSH brush = (HBRUSH)GetProp(hDlg, _T(\"br\"));\n\t\t\t\tif (!brush)\n\t\t\t\t{\n\t\t\t\t\t// Create a pattern brush based on a bitmap of this tab dialog's background.\n\t\t\t\t\tif (brush = CreateTabDialogBrush(hDlg, hdc))\n\t\t\t\t\t\tSetProp(hDlg, _T(\"br\"), brush);\n\t\t\t\t}\n\t\t\t\tif (brush)\n\t\t\t\t{\n\t\t\t\t\tif (pcontrol->type != GUI_CONTROL_PIC && pcontrol->union_color != CLR_DEFAULT)\n\t\t\t\t\t\tSetTextColor((HDC)wParam, pcontrol->union_color);\n\t\t\t\t\telse\n\t\t\t\t\t\tSetTextColor((HDC)wParam, GetSysColor(COLOR_WINDOWTEXT));\n\n\t\t\t\t\t// Tell the control to draw its background using our pattern brush.\n\t\t\t\t\tPOINT pt = { 0,0 };\n\t\t\t\t\tMapWindowPoints(hDlg, (HWND)lParam, &pt, 1);\n\t\t\t\t\tSetBrushOrgEx(hdc, pt.x, pt.y, NULL);\n\t\t\t\t\tSetBkMode(hdc, TRANSPARENT); // Affects text rendering.\n\t\t\t\t\treturn (INT_PTR)brush;\n\t\t\t\t}\n\t\t\t}\n\t\t\t// Forward this message to the GUI:\n\t\t\tLRESULT result = SendMessage(pgui->mHwnd, uMsg, wParam, lParam);\n\t\t\tif (uMsg >= WM_CTLCOLOREDIT && uMsg <= WM_CTLCOLORSTATIC)\n\t\t\t\treturn (INT_PTR)result;\n\t\t\t// Except for WM_CTLCOLOR messages and a few others, DialogProcs are expected to\n\t\t\t// return more specific results with SetWindowLong.\n\t\t\tSetWindowLongPtr(hDlg, DWLP_MSGRESULT, result);\n\t\t\treturn TRUE;\n\t\t}\n\t\tbreak;\n\t// Messages handled by the tab dialog:\n\tcase WM_CTLCOLORDLG:\n\t\tif (GuiType *pgui = GuiType::FindGui(GetParent(hDlg)))\n\t\t{\n\t\t\t// Apply the tab control's background color (which might be inherited from the Gui)\n\t\t\t// if any. A non-NULL brush implies -Theme, even if the background was inherited.\n\t\t\tLONG attrib = (LONG)GetWindowLongPtr(hDlg, GWLP_USERDATA);\n\t\t\tGuiControlType *ptab_control = pgui->FindTabControl(TABDIALOG_ATTRIB_INDEX(attrib));\n\t\t\tHBRUSH bk_brush;\n\t\t\tCOLORREF bk_color;\n\t\t\tpgui->ControlGetBkColor(*ptab_control, TRUE, bk_brush, bk_color);\n\t\t\tif (bk_brush)\n\t\t\t{\n\t\t\t\tSetBkColor((HDC)wParam, bk_color);\n\t\t\t\treturn (INT_PTR)bk_brush;\n\t\t\t}\n\t\t}\n\t\tbreak;\n\tcase WM_WINDOWPOSCHANGED: // Recreate the brush when the tab dialog is resized.\n\tcase WM_DESTROY: // Delete the brush when the window is destroyed.\n\t\tif (HBRUSH brush = (HBRUSH)GetProp(hDlg, _T(\"br\"))) // br was set by WM_CTLCOLORSTATIC above.\n\t\t{\n\t\t\tRemoveProp(hDlg, _T(\"br\"));\n\t\t\tDeleteObject(brush);\n\t\t}\n\t\tbreak;\n\t}\n\treturn FALSE;\n}\n\n\n\nvoid GuiType::ControlGetPosOfFocusedItem(GuiControlType &aControl, POINT &aPoint)\n// Caller has ensured that aControl is the focused control if the window has one. If not,\n// aControl can be any other control.\n// Based on the control type, the position of the focused subitem within the control is\n// returned (in screen coords) If the control has no focused item, the position of the\n// control's caret (which seems to work okay on all control types, even pictures) is returned.\n{\n\tLRESULT index;\n\tRECT rect;\n\trect.left = COORD_UNSPECIFIED; // Init to detect whether rect has been set yet.\n\n\tswitch (aControl.type)\n\t{\n\tcase GUI_CONTROL_LISTBOX: // Testing shows that GetCaret() doesn't report focused row's position.\n\t\tindex = SendMessage(aControl.hwnd, LB_GETCARETINDEX, 0, 0); // Testing shows that only one item at a time can have focus, even when multiple items are selected.\n\t\tif (index != LB_ERR) // LB_ERR == -1\n\t\t\tSendMessage(aControl.hwnd, LB_GETITEMRECT, index, (LPARAM)&rect);\n\t\t// If above didn't get the rect for either reason, a default method is used later below.\n\t\tbreak;\n\n\tcase GUI_CONTROL_LISTVIEW: // Testing shows that GetCaret() doesn't report focused row's position.\n\t\tindex = ListView_GetNextItem(aControl.hwnd, -1, LVNI_FOCUSED); // Testing shows that only one item at a time can have focus, even when multiple items are selected.\n\t\tif (index != -1)\n\t\t{\n\t\t\t// If the focused item happens to be beneath the viewable area, the context menu gets\n\t\t\t// displayed beneath the ListView, but this behavior seems okay because of the rarity\n\t\t\t// and because Windows Explorer behaves the same way.\n\t\t\t// Don't use the ListView_GetItemRect macro in this case (to cut down on its code size).\n\t\t\trect.left = LVIR_LABEL; // Seems better than LVIR_ICON in case icon is on right vs. left side of item.\n\t\t\tSendMessage(aControl.hwnd, LVM_GETITEMRECT, index, (LPARAM)&rect);\n\t\t}\n\t\t//else a default method is used later below, flagged by rect.left==COORD_UNSPECIFIED.\n\t\tbreak;\n\n\tcase GUI_CONTROL_TREEVIEW: // Testing shows that GetCaret() doesn't report focused row's position.\n\t\tHTREEITEM hitem;\n\t\tif (hitem = TreeView_GetSelection(aControl.hwnd)) // Same as SendMessage(aControl.hwnd, TVM_GETNEXTITEM, TVGN_CARET, NULL).\n\t\t\t// If the focused item happens to be beneath the viewable area, the context menu gets\n\t\t\t// displayed beneath the ListView, but this behavior seems okay because of the rarity\n\t\t\t// and because Windows Explorer behaves the same way.\n\t\t\t// Don't use the ListView_GetItemRect macro in this case (to cut down on its code size).\n\t\t\tTreeView_GetItemRect(aControl.hwnd, hitem, &rect, TRUE); // Pass TRUE because caller typically wants to display a context menu, and this gives a more precise location for it.\n\t\t//else a default method is used later below, flagged by rect.left==COORD_UNSPECIFIED.\n\t\tbreak;\n\n\tcase GUI_CONTROL_SLIDER: // GetCaretPos() doesn't retrieve thumb position, so it seems best to do so in case slider is very tall or long.\n\t\tSendMessage(aControl.hwnd, TBM_GETTHUMBRECT, 0, (WPARAM)&rect); // No return value.\n\t\tbreak;\n\t}\n\n\t// Notes about control types not handled above:\n\t//case GUI_CONTROL_STATUSBAR: For this and many others below, caller should never call it for this type.\n\t//case GUI_CONTROL_TEXT:\n\t//case GUI_CONTROL_LINK:\n\t//case GUI_CONTROL_PIC:\n\t//case GUI_CONTROL_GROUPBOX:\n\t//case GUI_CONTROL_BUTTON:\n\t//case GUI_CONTROL_CHECKBOX:\n\t//case GUI_CONTROL_RADIO:\n\t//case GUI_CONTROL_DROPDOWNLIST:\n\t//case GUI_CONTROL_COMBOBOX:\n\t//case GUI_CONTROL_EDIT: Has it's own context menu.\n\t//case GUI_CONTROL_DATETIME:\n\t//case GUI_CONTROL_MONTHCAL: Has it's own context menu. Can't be focused anyway.\n\t//case GUI_CONTROL_HOTKEY:\n\t//case GUI_CONTROL_UPDOWN:\n\t//case GUI_CONTROL_PROGRESS:\n\t//case GUI_CONTROL_TAB: For simplicity, just do basic reporting rather than trying to find pos. of focused tab.\n\n\tif (rect.left == COORD_UNSPECIFIED) // Control's rect hasn't yet been fetched, so fall back to default method.\n\t{\n\t\tGetWindowRect(aControl.hwnd, &rect);\n\t\t// Decided against this since it doesn't seem to matter for any current control types. If a custom\n\t\t// context menu is ever supported for Edit controls, maybe use GetCaretPos() for them.\n\t\t//GetCaretPos(&aPoint); // For some control types, this might give a more precise/appropriate position than GetWindowRect().\n\t\t//ClientToScreen(aControl.hwnd, &aPoint);\n\t\t//// A little nicer for most control types (such as DateTime) to shift it down a little so that popup/context\n\t\t//// menu or tooltip doesn't fully obstruct the control's contents.\n\t\t//aPoint.y += 10; // A constant 10 is used because varying it by font doesn't seem worthwhile given that menu/tooltip fonts are of fixed size.\n\t}\n\telse\n\t\tMapWindowPoints(aControl.hwnd, NULL, (LPPOINT)&rect, 2); // Convert rect from client coords to screen coords.\n\n\taPoint.x = rect.left;\n\taPoint.y = rect.top + 2 + (rect.bottom - rect.top)/2; // +2 to shift it down a tad, revealing more of the selected item.\n\t// Above: Moving it down a little by default seems desirable 95% of the time to prevent it\n\t// from covering up the focused row, the slider's thumb, a datetime's single row, etc.\n}\n\n\n\nstruct LV_SortType\n{\n\tLVFINDINFO lvfi;\n\tLVITEM lvi;\n\tHWND hwnd;\n\tlv_col_type col;\n\tTCHAR buf1[LV_TEXT_BUF_SIZE];\n\tTCHAR buf2[LV_TEXT_BUF_SIZE];\n\tbool sort_ascending;\n\tbool incoming_is_index;\n};\n\n\n\nint CALLBACK LV_GeneralSort(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort)\n// ListView sorting by field's text or something derived from the text for each call.\n{\n\tLV_SortType &lvs = *(LV_SortType *)lParamSort;\n\n\t// v1.0.44.12: Testing shows that LVM_GETITEMW automatically converts the ANSI contents of our ListView\n\t// into Unicode, which is nice because it avoids the overhead and code size of having to call\n\t// ToWideChar(), along with the extra/temp buffers it requires to receive the wide version.\n\tUINT msg_lvm_getitem = (lvs.col.case_sensitive == SCS_INSENSITIVE_LOGICAL && lvs.col.type == LV_COL_TEXT)\n\t\t? LVM_GETITEMW : LVM_GETITEM; // Both items above are checked so that SCS_INSENSITIVE_LOGICAL can be effect even for non-text columns because it allows a column to be later changed to TEXT and retain its \"logical-sort\" setting.\n\t// NOTE: It's safe to send a LVITEM struct rather than an LVITEMW with the LVM_GETITEMW message because\n\t// the only difference between them is the type \"LPWSTR pszText\", which is no problem as long as caller\n\t// has properly halved cchTextMax to reflect that wide-chars are twice as wide as 8-bit characters.\n\n\t// MSDN: \"During the sorting process, the list-view contents are unstable. If the [ListView_SortItems]\n\t// callback function sends any messages to the list-view control, the results are unpredictable (aside\n\t// from LVM_GETITEM, which is allowed by ListView_SortItemsEx but not ListView_SortItems).\"\n\t// Since SortItemsEx has become so much more common/available, the doubt about whether the non-Ex\n\t// ListView_SortItems actually allows LVM_GETITEM (which it probably does in spite of not being\n\t// documented) much less of a concern.\n\t// Older: It seems hard to believe that you shouldn't send ANY kind of message because how could you\n\t// ever use ListView_SortItems() without either having LVS_OWNERDATA or allocating temp memory for the\n\t// entire column (to whose rows lParam would point)?\n\t// UPDATE: The following seems to be one alternative:\n\t// Do a \"virtual qsort\" on this column's contents by having qsort() sort an array of row numbers according\n\t// to the contents of each particular row's field in that column (i.e. qsort's callback would call LV_GETITEM).\n\t// In other words, the array would start off in order (1,2,3) but afterward would contain the proper sort\n\t// (e.g. 3,1,2). Next, traverse the array and store the correct \"order number\" in the corresponding row's\n\t// special \"lParam container\" (for example, 3,1,2 would store 1 in row 3, 2 in row 1, and 3 in row 2, and 4 in...).\n\t// Then the ListView can be sorted via a method like the high performance LV_Int32Sort.\n\t// However, since the above would require TWO SORTS, it would probably be slower (though the second sort would\n\t// require only a tiny fraction of the time of the first).\n\tlvs.lvi.pszText = lvs.buf1; // lvi's other members were already set by the caller.\n\tif (lvs.incoming_is_index) // Serves to avoid the potentially high performance overhead of ListView_FindItem() where possible.\n\t{\n\t\tlvs.lvi.iItem = (int)lParam1;\n\t\tSendMessage(lvs.hwnd, msg_lvm_getitem, 0, (LPARAM)&lvs.lvi); // Use LVM_GETITEM vs. LVM_GETITEMTEXT because MSDN says that only LVM_GETITEM is safe during the sort.\n\t}\n\telse\n\t{\n\t\t// Unfortunately, lParam cannot be used as the index itself because apparently, the sorting\n\t\t// process puts the item indices into a state of flux. In other words, the indices are\n\t\t// changing while the sort progresses, so it's not possible to use an item's original index\n\t\t// as a way to uniquely identify it.\n\t\tlvs.lvfi.lParam = lParam1;\n\t\tlvs.lvi.iItem = ListView_FindItem(lvs.hwnd, -1, &lvs.lvfi);\n\t\tif (lvs.lvi.iItem < 0) // Not found. Impossible if caller set the LParam to a unique value.\n\t\t\t*lvs.buf1 = '\\0';\n\t\telse\n\t\t\tSendMessage(lvs.hwnd, msg_lvm_getitem, 0, (LPARAM)&lvs.lvi);\n\t}\n\n\t// Must use lvi.pszText vs. buf because MSDN says (for LVM_GETITEM, but it might also apply to\n\t// LVM_GETITEMTEXT even though it isn't documented): \"Applications should not assume that the text will\n\t// necessarily be placed in the specified buffer. The control may instead change the pszText member\n\t// of the structure to point to the new text rather than place it in the buffer.\"\n\tLPTSTR field1 = lvs.lvi.pszText; // Save value of pszText in case it no longer points to lvs.buf1.\n\n\t// Fetch Item #2 (see comments in #1 above):\n\tlvs.lvi.pszText = lvs.buf2; // lvi's other members were already set by the caller.\n\tif (lvs.incoming_is_index)\n\t{\n\t\tlvs.lvi.iItem = (int)lParam2;\n\t\tSendMessage(lvs.hwnd, msg_lvm_getitem, 0, (LPARAM)&lvs.lvi); // Use LVM_GETITEM vs. LVM_GETITEMTEXT because MSDN says that only LVM_GETITEM is safe during the sort.\n\t}\n\telse\n\t{\n\t\t// Set any lvfi members not already set by the caller. Note that lvi.mask was set to LVIF_TEXT by the caller.\n\t\tlvs.lvfi.lParam = lParam2;\n\t\tlvs.lvi.iItem = ListView_FindItem(lvs.hwnd, -1, &lvs.lvfi);\n\t\tif (lvs.lvi.iItem < 0) // Not found. Impossible if caller set the LParam to a unique value.\n\t\t\t*lvs.buf2 = '\\0';\n\t\telse\n\t\t\tSendMessage(lvs.hwnd, msg_lvm_getitem, 0, (LPARAM)&lvs.lvi);\n\t}\n\n\t// MSDN: \"return a negative value if the first item should precede the second\"\n\tint result;\n\tif (lvs.col.type == LV_COL_TEXT)\n\t{\n\t\tif (lvs.col.case_sensitive == SCS_INSENSITIVE_LOGICAL)\n\t\t\tresult = StrCmpLogicalW((LPCWSTR)field1, (LPCWSTR)lvs.lvi.pszText);\n\t\telse\n\t\t\tresult = tcscmp2(field1, lvs.lvi.pszText, lvs.col.case_sensitive); // Must not refer to buf1/buf2 directly, see above.\n\t}\n\telse\n\t{\n\t\t// Unlike ACT_SORT, supporting hex for an explicit-floating point column seems far too rare to\n\t\t// justify, hence _tstof() is used vs. ATOF(). v1.0.46.03: Fixed to sort properly (formerly, it just case the difference to an int, which isn't right).\n\t\tdouble f1 = _tstof(field1), f2 = _tstof(lvs.lvi.pszText); // Must not refer to buf1/buf2 directly, see above.\n\t\tresult = (f1 > f2) ? 1 : (f1 == f2 ? 0 : -1);\n\t}\n\treturn lvs.sort_ascending ? result : -result;\n}\n\n\n\nint CALLBACK LV_Int32Sort(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort)\n{\n\t// Caller-provided value of lParamSort is TRUE (non-zero) when ascending order is desired.\n\t// MSDN: \"return a negative value if the first item should precede the second\"\n\treturn (int)(lParamSort ? (lParam1 - lParam2) : (lParam2 - lParam1));\n}\n\n\n\nvoid GuiType::LV_Sort(GuiControlType &aControl, int aColumnIndex, bool aSortOnlyIfEnabled, TCHAR aForceDirection)\n// aForceDirection should be 'A' to force ascending, 'D' to force ascending, or '\\0' to use the column's\n// current default direction.\n{\n\tif (aColumnIndex < 0 || aColumnIndex >= LV_MAX_COLUMNS) // Invalid (avoids array access violation).\n\t\treturn;\n\tlv_attrib_type &lv_attrib = *aControl.union_lv_attrib;\n\tlv_col_type &col = lv_attrib.col[aColumnIndex];\n\n\tint item_count = ListView_GetItemCount(aControl.hwnd);\n\tif ((col.sort_disabled && aSortOnlyIfEnabled) || item_count < 2) // This column cannot be sorted or doesn't need to be.\n\t\treturn; // Below relies on having returned here when control is empty or contains 1 item.\n\n\t// Init any lvs members that are needed by both LV_Int32Sort and the other sorting functions.\n\t// The new sort order is determined by the column's primary order unless the user clicked the current\n\t// sort-column, in which case the direction is reversed (unless the column is unidirectional):\n\tLV_SortType lvs;\n\tif (aForceDirection)\n\t\tlvs.sort_ascending = (aForceDirection == 'A');\n\telse\n\t\tlvs.sort_ascending = (aColumnIndex == lv_attrib.sorted_by_col && !col.unidirectional)\n\t\t\t? !lv_attrib.is_now_sorted_ascending : !col.prefer_descending;\n\n\t// Init those members needed for LVM_GETITEM if it turns out to be needed. This section\n\t// also serves to permanently init cchTextMax for use by the sorting functions too:\n\tlvs.lvi.pszText = lvs.buf1;\n\tlvs.lvi.cchTextMax = LV_TEXT_BUF_SIZE - 1; // Set default. Subtracts 1 because of that nagging doubt about size vs. length. Some MSDN examples subtract one, such as TabCtrl_GetItem()'s cchTextMax.\n\n\tif (col.type == LV_COL_INTEGER)\n\t{\n\t\t// Testing indicates that the following approach is 25 times faster than the general-sort method.\n\t\t// Assign the 32-bit integer as the items lParam at this early stage rather than getting the text\n\t\t// and converting it to an integer for every call of the sort proc.\n\t\tfor (lvs.lvi.lParam = 0, lvs.lvi.iItem = 0; lvs.lvi.iItem < item_count; ++lvs.lvi.iItem)\n\t\t{\n\t\t\tlvs.lvi.mask = LVIF_TEXT;\n\t\t\tlvs.lvi.iSubItem = aColumnIndex; // Which field to fetch (must be reset each time since it's set to 0 below).\n\t\t\tlvs.lvi.lParam = SendMessage(aControl.hwnd, LVM_GETITEM, 0, (LPARAM)&lvs.lvi)\n\t\t\t\t? ATOI(lvs.lvi.pszText) : 0; // Must not refer to lvs.buf1 directly because MSDN says LVM_GETITEMTEXT might have changed pszText to point to some other string.\n\t\t\tlvs.lvi.mask = LVIF_PARAM;\n\t\t\tlvs.lvi.iSubItem = 0; // Indicate that an item vs. subitem is being operated on (subitems can't have an lParam).\n\t\t\tListView_SetItem(aControl.hwnd, &lvs.lvi);\n\t\t}\n\t\t// Always use non-Ex() for this one because it's likely to perform best due to the lParam setup above.\n\t\t// The value of iSubItem is not reset to aColumnIndex because LV_Int32Sort() doesn't use it.\n SendMessage(aControl.hwnd, LVM_SORTITEMS, lvs.sort_ascending, (LPARAM)LV_Int32Sort); // Should always succeed since it uses non-Ex() version.\n\t}\n\telse // It's LV_COL_TEXT or LV_COL_FLOAT.\n\t{\n\t\tif (col.type == LV_COL_TEXT && col.case_sensitive == SCS_INSENSITIVE_LOGICAL) // SCS_INSENSITIVE_LOGICAL can be in effect even when type isn't LV_COL_TEXT because it allows a column to be later changed to TEXT and retain its \"logical-sort\" setting.\n\t\t{\n\t\t\t// v1.0.44.12: Support logical sorting, which treats numeric strings as true numbers like Windows XP\n\t\t\t// Explorer's sorting. This is done here rather than in LV_ModifyCol() because it seems more\n\t\t\t// maintainable/robust (plus LV_GeneralSort() relies on us to do this check).\n\t\t\tlvs.lvi.cchTextMax = lvs.lvi.cchTextMax/2 - 1; // Buffer can hold only half as many Unicode characters as non-Unicode (subtract 1 for the extra-wide NULL terminator).\n\t\t}\n\t\t// Since LVM_SORTITEMSEX requires comctl32.dll version 5.80+, the non-Ex version is used\n\t\t// whenever the EX version fails to work. One reason to strongly prefer the Ex version\n\t\t// is that MSDN says the non-Ex version shouldn't query the control during the sort,\n\t\t// which although hard to believe, is a concern. Therefore:\n\t\t// Try to use the SortEx() method first. If it doesn't work, fall back to the non-Ex method under\n\t\t// the assumption that the OS doesn't support the Ex() method.\n\t\t// Initialize struct members as much as possible so that the sort callback function doesn't have to do it\n\t\t// the many times it's called. Some of the others were already initialized higher above for internal use here.\n\t\tlvs.hwnd = aControl.hwnd;\n\t\tlvs.lvi.iSubItem = aColumnIndex; // Zero-based column index to indicate whether the item or one of its sub-items should be retrieved.\n\t\tlvs.col = col; // Struct copy, which should enhance sorting performance over a pointer.\n\t\tlvs.incoming_is_index = true;\n\t\tlvs.lvi.pszText = NULL; // Serves to detect whether the sort-proc actually ran (it won't if this is Win95 or some other OS that lacks SortEx).\n\t\tlvs.lvi.mask = LVIF_TEXT;\n\t\tSendMessage(aControl.hwnd, LVM_SORTITEMSEX, (WPARAM)&lvs, (LPARAM)LV_GeneralSort);\n\t\tif (!lvs.lvi.pszText)\n\t\t{\n\t\t\t// Since SortEx() didn't run (above has already ensured that this wasn't because the control is empty),\n\t\t\t// fall back to Sort() method.\n\t\t\t// Use a simple sequential lParam to guarantee uniqueness. This must be done every time in case\n\t\t\t// rows have been inserted/deleted since the last time, in which case uniqueness would not be\n\t\t\t// certain otherwise:\n\t\t\tlvs.lvi.iSubItem = 0; // Indicate that an item vs. subitem is to be updated (subitems can't have an lParam).\n\t\t\tlvs.lvi.mask = LVIF_PARAM; // Indicate which member is to be updated.\n\t\t\tfor (lvs.lvi.lParam = 0, lvs.lvi.iItem = 0; lvs.lvi.iItem < item_count; ++lvs.lvi.lParam, ++lvs.lvi.iItem)\n\t\t\t\tListView_SetItem(aControl.hwnd, &lvs.lvi);\n\t\t\t// Initialize struct members as much as possible so that the sort callback function doesn't have to do it\n\t\t\t// each time it's called. Some of the others were already initialized higher above for internal use here.\n\t\t\tlvs.incoming_is_index = false;\n\t\t\tlvs.lvfi.flags = LVFI_PARAM; // This is the find-method; i.e. the sort function will find each item based on its LPARAM.\n\t\t\tlvs.lvi.mask = LVIF_TEXT; // Sort proc. uses LVIF_TEXT internally because the PARAM mask only applies to lvfi vs. lvi.\n\t\t\tlvs.lvi.iSubItem = aColumnIndex; // Zero-based column index to indicate whether the item or one of its sub-items should be retrieved.\n\t\t\tSendMessage(aControl.hwnd, LVM_SORTITEMS, (WPARAM)&lvs, (LPARAM)LV_GeneralSort);\n\t\t}\n\t}\n\n\t// For simplicity, ListView_SortItems()'s return value (TRUE/FALSE) is ignored since it shouldn't\n\t// realistically fail. Just update things to indicate the current sort-column and direction:\n\tlv_attrib.sorted_by_col = aColumnIndex;\n\tlv_attrib.is_now_sorted_ascending = lvs.sort_ascending;\n}\n\n\n\n#define MAX_ACCELERATORS 128\n\nvoid GuiType::UpdateAccelerators(UserMenu &aMenu)\n{\n\t// Destroy the old accelerator table, if any.\n\tRemoveAccelerators();\n\n\tint accel_count = 0;\n\tACCEL accel[MAX_ACCELERATORS];\n\n\t// Call recursive function to handle submenus.\n\tUpdateAccelerators(aMenu, accel, accel_count);\n\n\tif (accel_count)\n\t\tmAccel = CreateAcceleratorTable(accel, accel_count);\n}\n\nvoid GuiType::UpdateAccelerators(UserMenu &aMenu, LPACCEL aAccel, int &aAccelCount)\n{\n\tUserMenuItem *item;\n\tfor (item = aMenu.mFirstMenuItem; item && aAccelCount < MAX_ACCELERATORS; item = item->mNextMenuItem)\n\t{\n\t\tif (item->mSubmenu)\n\t\t{\n\t\t\t// Recursively process accelerators in submenus.\n\t\t\tUpdateAccelerators(*item->mSubmenu, aAccel, aAccelCount);\n\t\t}\n\t\telse if (LPTSTR tab = _tcschr(item->mName, '\\t'))\n\t\t{\n\t\t\tif (ConvertAccelerator(tab + 1, aAccel[aAccelCount]))\n\t\t\t{\n\t\t\t\t// This accelerator is valid.\n\t\t\t\taAccel[aAccelCount++].cmd = item->mMenuID;\n\t\t\t}\n\t\t\t// Otherwise, the text following '\\t' was an invalid accelerator or not an accelerator\n\t\t\t// at all. For simplicity, flexibility and backward-compatibility, just ignore it.\n\t\t}\n\t}\n}\n\nvoid GuiType::RemoveAccelerators()\n{\n\tif (mAccel)\n\t{\n\t\tDestroyAcceleratorTable(mAccel);\n\t\tmAccel = NULL;\n\t}\n}\n\nbool GuiType::ConvertAccelerator(LPTSTR aString, ACCEL &aAccel)\n{\n\taString = omit_leading_whitespace(aString);\n\tif (!*aString) // Multiple points below rely on this check.\n\t\treturn false;\n\n\t// Omitting FVIRTKEY and storing a character code instead of a vk code allows the\n\t// accelerator to be triggered by Alt+Numpad and perhaps IME or other means. However,\n\t// testing shows that it also causes the modifier key flags to be ignored, so this\n\t// approach can only be used if aString is a lone character:\n\tif (!aString[1])\n\t{\n\t\taAccel.key = (WORD)(TBYTE)*aString;\n\t\taAccel.fVirt = 0;\n\t\treturn true;\n\t}\n\n\taAccel.fVirt = FVIRTKEY; // Init.\n\n\tmodLR_type modLR = 0;\n\n\tLPTSTR cp;\n\twhile (cp = _tcschr(aString + 1, '+')) // For each modifier. +1 is used in case \"+\" is the key.\n\t{\n\t\tLPTSTR cp_end = omit_trailing_whitespace(aString, cp - 1);\n\t\tsize_t len = cp_end - aString + 1;\n\t\tif (!_tcsnicmp(aString, _T(\"Ctrl\"), len))\n\t\t\tmodLR |= MOD_LCONTROL;\n\t\telse if (!_tcsnicmp(aString, _T(\"Alt\"), len))\n\t\t\tmodLR |= MOD_LALT;\n\t\telse if (!_tcsnicmp(aString, _T(\"Shift\"), len))\n\t\t\tmodLR |= MOD_LSHIFT;\n\t\telse\n\t\t\treturn false;\n\t\taString = omit_leading_whitespace(cp + 1);\n\t\tif (!*aString) // Below relies on this check.\n\t\t\treturn false; // \"Modifier+\", but no key name.\n\t}\n\n\t// Now that any modifiers have been parsed and removed, convert the key name.\n\t// If only a single character remains, this may set additional modifiers.\n\tif (!aString[1])\n\t{\n\t\t// It seems preferable to treat \"Ctrl+O\" as ^o and not ^+o, so convert the character\n\t\t// to lower-case so that MOD_LSHIFT is added only for keys like \"@\". Seems best to use\n\t\t// the locale-dependent method, though somewhat debatable.\n\t\taAccel.key = CharToVKAndModifiers(ltolower(*aString), &modLR, GetKeyboardLayout(0));\n\t}\n\telse\n\t\taAccel.key = TextToVK(aString);\n\n\tif (modLR & MOD_LCONTROL)\n\t\taAccel.fVirt |= FCONTROL;\n\tif (modLR & MOD_LALT) // Not MOD_RALT, which would mean AltGr (unsupported).\n\t\taAccel.fVirt |= FALT;\n\tif (modLR & MOD_LSHIFT)\n\t\taAccel.fVirt |= FSHIFT;\n\n\treturn aAccel.key; // i.e. false if not a valid key name.\n}\n\n\n\nvoid GuiType::SetDefaultMargins()\n{\n\t// The original default mMarginX was documented as \"1.25 times font-height\", which is\n\t// confusing because font-height is in points while mMarginX is in pixels. It's kept\n\t// at this value anyway since it seems to work well. The calculation below uses a\n\t// factor relative to 72 vs. denominator of 96 to emulate pixel-to-point conversion.\n\t// 96 is used even when DPI != 100% so that the scaling performed by point-to-pixel\n\t// conversion is kept (lfHeight is already proportionate to screen DPI).\n\tif (mMarginX == COORD_UNSPECIFIED)\n\t\tmMarginX = MulDiv(sFont[mCurrentFontIndex].lfHeight, -90, 96); // Seems to be a good rule of thumb. Originally 1.25 * point_size.\n\tif (mMarginY == COORD_UNSPECIFIED)\n\t\tmMarginY = MulDiv(sFont[mCurrentFontIndex].lfHeight, -54, 96); // Also seems good. Originally 0.75 * point_size.\n}\n"},"size":{"kind":"number","value":521961,"string":"521,961"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":10159,"string":"10,159"},"avg_line_length":{"kind":"number","value":47.95590117137514,"string":"47.955901"},"max_line_length":{"kind":"number","value":318,"string":"318"},"alphanum_fraction":{"kind":"number","value":0.7219114597915618,"string":"0.721911"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11092,"cells":{"id":{"kind":"number","value":16082,"string":"16,082"},"file_name":{"kind":"string","value":"script2.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script2.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"qmath.h\" // Used by Transform() [math.h incurs 2k larger code size just for ceil() & floor()]\n#include \"script.h\"\n#include \"window.h\" // for IF_USE_FOREGROUND_WINDOW\n#include \"application.h\" // for MsgSleep()\n#include \"script_func_impl.h\"\n#include \"abi.h\"\n\n\n\n///////////////////////\n// GUI-related: Tray //\n///////////////////////\n\nResultType TrayTipParseOptions(LPCTSTR aOptions, NOTIFYICONDATA &nic)\n{\n\tif (!aOptions)\n\t\treturn OK;\n\tDWORD flag;\n\tLPCTSTR next_option, option_end;\n\tTCHAR option[1+MAX_NUMBER_SIZE];\n\tfor (next_option = omit_leading_whitespace(aOptions); ; next_option = omit_leading_whitespace(option_end))\n\t{\n\t\tif (!*next_option)\n\t\t\treturn OK;\n\n\t\t// Find the end of this option item:\n\t\tif ( !(option_end = StrChrAny(next_option, _T(\" \\t\"))) ) // Space or tab.\n\t\t\toption_end = next_option + _tcslen(next_option); // Set to position of zero terminator instead.\n\t\tsize_t option_length = option_end - next_option;\n\n\t\t// Make a terminated copy for simplicity and to reduce ambiguity:\n\t\tif (option_length + 1 > _countof(option))\n\t\t\tgoto invalid_option;\n\t\ttmemcpy(option, next_option, option_length);\n\t\toption[option_length] = '\\0';\n\n\t\tif (option_length <= 5 && !_tcsnicmp(option, _T(\"Icon\"), 4))\n\t\t{\n\t\t\tnic.dwInfoFlags &= ~NIIF_ICON_MASK;\n\t\t\tswitch (option[4])\n\t\t\t{\n\t\t\tcase 'x': case 'X': nic.dwInfoFlags |= NIIF_ERROR; break;\n\t\t\tcase '!': nic.dwInfoFlags |= NIIF_WARNING; break;\n\t\t\tcase 'i': case 'I': nic.dwInfoFlags |= NIIF_INFO; break;\n\t\t\tcase '\\0': break;\n\t\t\tdefault:\n\t\t\t\tgoto invalid_option;\n\t\t\t}\n\t\t}\n\t\telse if (!_tcsicmp(option, _T(\"Mute\")))\n\t\t{\n\t\t\tnic.dwInfoFlags |= NIIF_NOSOUND;\n\t\t}\n\t\telse if (ParseInteger(option, flag))\n\t\t{\n\t\t\tnic.dwInfoFlags |= flag;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tgoto invalid_option;\n\t\t}\n\t}\ninvalid_option:\n\treturn ValueError(ERR_INVALID_OPTION, next_option, FAIL_OR_OK);\n}\n\n\nbif_impl FResult TrayTip(optl<StrArg> aText, optl<StrArg> aTitle, optl<StrArg> aOptions)\n{\n\tNOTIFYICONDATA nic = {0};\n\tnic.cbSize = sizeof(nic);\n\tnic.uID = AHK_NOTIFYICON; // This must match our tray icon's uID or Shell_NotifyIcon() will return failure.\n\tnic.hWnd = g_hWnd;\n\tnic.uFlags = NIF_INFO;\n\t// nic.uTimeout is no longer used because it is valid only on Windows 2000 and Windows XP.\n\tif (!TrayTipParseOptions(aOptions.value_or_null(), nic))\n\t\treturn FR_FAIL;\n\tif (nic.dwInfoFlags & NIIF_USER)\n\t{\n\t\t// Windows 10 toast notifications display the small tray icon stretched to the\n\t\t// large size if NIIF_USER is passed but without NIIF_LARGE_ICON or hBalloonIcon.\n\t\t// If a large icon is passed without the flag, the notification does not show at all.\n\t\t// But since this could change, let the script pass 0x24 to use the large icon.\n\t\t//if (g_os.IsWin10OrLater())\n\t\t//\tnic.dwInfoFlags |= NIIF_LARGE_ICON;\n\t\tif (nic.dwInfoFlags & NIIF_LARGE_ICON)\n\t\t\tnic.hBalloonIcon = g_script.mCustomIcon ? g_script.mCustomIcon : g_IconLarge;\n\t\telse\n\t\t\tnic.hBalloonIcon = g_script.mCustomIconSmall ? g_script.mCustomIconSmall : g_IconSmall;\n\t}\n\tif (aTitle.has_value())\n\t\ttcslcpy(nic.szInfoTitle, aTitle.value(), _countof(nic.szInfoTitle));\n\telse\n\t\t*nic.szInfoTitle = '\\0'; // Empty title omits the title line entirely.\n\tif (aText.has_nonempty_value())\n\t\ttcslcpy(nic.szInfo, aText.value(), _countof(nic.szInfo));\n\telse if (aTitle.has_nonempty_value()) // Text was omitted or empty, but Title was specified.\n\t\t*nic.szInfo = ' ', nic.szInfo[1] = '\\0'; // Pass a non-empty string to ensure the notification is shown.\n\telse // Both parameters were omitted or empty.\n\t\t*nic.szInfo = '\\0'; // Empty text removes the notification (or tries to).\n\tif (!Shell_NotifyIcon(NIM_MODIFY, &nic) && (nic.dwInfoFlags & NIIF_USER))\n\t{\n\t\t// Passing NIIF_USER without NIIF_LARGE_ICON on Windows 10.0.19018 caused failure,\n\t\t// even though a small icon is displayed by default (without NIIF_USER), the docs\n\t\t// indicate it should work, and it works on Vista. There's a good chance that\n\t\t// removing the flag and trying again will produce the desired result, or at least\n\t\t// show a TrayTip without the icon, which is preferable to complete failure.\n\t\tnic.dwInfoFlags &= ~NIIF_USER;\n\t\tShell_NotifyIcon(NIM_MODIFY, &nic);\n\t}\n\treturn OK; // i.e. never a critical error if it fails.\n}\n\n\n\n/////////////////\n// Main Window //\n/////////////////\n\nLRESULT CALLBACK MainWindowProc(HWND hWnd, UINT iMsg, WPARAM wParam, LPARAM lParam)\n{\n\t// Detect Explorer crashes so that tray icon can be recreated. I think this only works on Win98\n\t// and beyond, since the feature was never properly implemented in Win95:\n\tstatic UINT WM_TASKBARCREATED = RegisterWindowMessage(_T(\"TaskbarCreated\"));\n\n\t// See GuiWindowProc() for details about this first section:\n\tLRESULT msg_reply;\n\tif (g_CalledByIsDialogMessageOrDispatch && g_CalledByIsDialogMessageOrDispatch->message == iMsg)\n\t\tg_CalledByIsDialogMessageOrDispatch = nullptr; // Suppress this one message, not any other messages that could be sent due to recursion.\n\telse if (g_MsgMonitor.Count() && MsgMonitor(hWnd, iMsg, wParam, lParam, NULL, msg_reply))\n\t\treturn msg_reply; // MsgMonitor has returned \"true\", indicating that this message should be omitted from further processing.\n\n\tTRANSLATE_AHK_MSG(iMsg, wParam)\n\t\n\tswitch (iMsg)\n\t{\n\tcase WM_COMMAND:\n\t\tif (HandleMenuItem(hWnd, LOWORD(wParam), NULL)) // It was handled fully. NULL flags it as a non-GUI menu item such as a tray menu or popup menu.\n\t\t\treturn 0; // If an application processes this message, it should return zero.\n\t\tbreak; // Otherwise, let DefWindowProc() try to handle it (this actually seems to happen normally sometimes).\n\n\tcase AHK_NOTIFYICON: // Tray icon clicked on.\n\t{\n switch(lParam)\n {\n// Don't allow the main window to be opened this way by a compiled EXE, since it will display\n// the lines most recently executed, and many people who compile scripts don't want their users\n// to see the contents of the script:\n\t\tcase WM_LBUTTONDOWN:\n\t\t\tif (g_script.mTrayMenu->mClickCount != 1) // Activating tray menu's default item requires double-click.\n\t\t\t\tbreak; // Let default proc handle it (since that's what used to happen, it seems safest).\n\t\t\t//else fall through to the next case.\n\t\tcase WM_LBUTTONDBLCLK:\n\t\t\tif (g_script.mTrayMenu->mDefault)\n\t\t\t\tPostMessage(hWnd, WM_COMMAND, g_script.mTrayMenu->mDefault->mMenuID, 0); // WM_COMMAND vs POST_AHK_USER_MENU to support the Standard menu items.\n\t\t\treturn 0;\n\t\tcase WM_RBUTTONUP:\n\t\t\t// v1.0.30.03:\n\t\t\t// Opening the menu upon UP vs. DOWN solves at least one set of problems: The fact that\n\t\t\t// when the right mouse button is remapped as shown in the example below, it prevents\n\t\t\t// the left button from being able to select a menu item from the tray menu. It might\n\t\t\t// solve other problems also, and it seems fairly common for other apps to open the\n\t\t\t// menu upon UP rather than down. Even Explorer's own context menus are like this.\n\t\t\t// The following example is trivial and serves only to illustrate the problem caused\n\t\t\t// by the old open-tray-on-mouse-down method:\n\t\t\t//MButton::Send {RButton down}\n\t\t\t//MButton up::Send {RButton up}\n\t\t\tg_script.mTrayMenu->Display();\n\t\t\treturn 0;\n\t\t} // Inner switch()\n\t\tbreak;\n\t} // case AHK_NOTIFYICON\n\n\tcase AHK_DIALOG: // User defined msg sent from our functions MsgBox() or FileSelect().\n\t{\n\t\t// Ensure that the app's top-most window (the modal dialog) is the system's\n\t\t// foreground window. This doesn't use FindWindow() since it can hang in rare\n\t\t// cases. And GetActiveWindow, GetTopWindow, GetWindow, etc. don't seem appropriate.\n\t\t// So EnumWindows is probably the way to do it:\n\t\tHWND top_box = FindOurTopDialog();\n\t\tif (top_box)\n\t\t{\n\n\t\t\t// v1.0.33: The following is probably reliable since the AHK_DIALOG should\n\t\t\t// be in front of any messages that would launch an interrupting thread. In other\n\t\t\t// words, the \"g\" struct should still be the one that owns this MsgBox/dialog window.\n\t\t\tg->DialogHWND = top_box; // This is used to work around an AHK_TIMEOUT issue in which a MsgBox that has only an OK button fails to deliver the Timeout indicator to the script.\n\n\t\t\tSetForegroundWindowEx(top_box);\n\n\t\t\t// Setting the big icon makes AutoHotkey dialogs more distinct in the Alt-tab menu.\n\t\t\t// Unfortunately, it seems that setting the big icon also indirectly sets the small\n\t\t\t// icon, or more precisely, that the dialog simply scales the large icon whenever\n\t\t\t// a small one isn't available. This results in the FileSelect dialog's title\n\t\t\t// being initially messed up (at least on WinXP) and also puts an unwanted icon in\n\t\t\t// the title bar of each MsgBox. So for now it's disabled:\n\t\t\t//LPARAM main_icon = (LPARAM)LoadImage(g_hInstance, MAKEINTRESOURCE(IDI_MAIN), IMAGE_ICON, 0, 0, LR_SHARED);\n\t\t\t//SendMessage(top_box, WM_SETICON, ICON_BIG, main_icon);\n\t\t\t//SendMessage(top_box, WM_SETICON, ICON_SMALL, 0); // Tried this to get rid of it, but it didn't help.\n\t\t\t// But don't set the small one, because it reduces the area available for title text\n\t\t\t// without adding any significant benefit:\n\t\t\t//SendMessage(top_box, WM_SETICON, ICON_SMALL, main_icon);\n\n\t\t\tUINT timeout = (UINT)lParam; // Caller has ensured that this is non-negative.\n\t\t\tif (timeout)\n\t\t\t\t// Caller told us to establish a timeout for this modal dialog (currently always MessageBox).\n\t\t\t\t// In addition to any other reasons, the first param of the below must not be NULL because\n\t\t\t\t// that would cause the 2nd param to be ignored. We want the 2nd param to be the actual\n\t\t\t\t// ID assigned to this timer.\n\t\t\t\tSetTimer(top_box, g_nMessageBoxes, (UINT)timeout, MsgBoxTimeout);\n\t\t}\n\t\t// else: if !top_box: no error reporting currently.\n\t\treturn 0;\n\t}\n\n\tcase AHK_USER_MENU:\n\t\t// Search for AHK_USER_MENU in GuiWindowProc() for comments about why this is done:\n\t\tif (IsInterruptible())\n\t\t{\n\t\t\tPostMessage(hWnd, iMsg, wParam, lParam);\n\t\t\tMsgSleep(-1, RETURN_AFTER_MESSAGES_SPECIAL_FILTER);\n\t\t}\n\t\treturn 0;\n\n\tcase WM_HOTKEY: // As a result of this app having previously called RegisterHotkey().\n\tcase AHK_HOOK_HOTKEY: // Sent from this app's keyboard or mouse hook.\n\tcase AHK_HOTSTRING: // Added for v1.0.36.02 so that hotstrings work even while an InputBox or other non-standard msg pump is running.\n\tcase AHK_CLIPBOARD_CHANGE: // Added for v1.0.44 so that clipboard notifications aren't lost while the script is displaying a MsgBox or other dialog.\n\tcase AHK_INPUT_END:\n\t\t// If the following facts are ever confirmed, there would be no need to post the message in cases where\n\t\t// the MsgSleep() won't be done:\n\t\t// 1) The mere fact that any of the above messages has been received here in MainWindowProc means that a\n\t\t// message pump other than our own main one is running (i.e. it is the closest pump on the call stack).\n\t\t// This is because our main message pump would never have dispatched the types of messages above because\n\t\t// it is designed to fully handle then discard them.\n\t\t// 2) All of these types of non-main message pumps would discard a message with a NULL hwnd.\n\t\t//\n\t\t// One source of confusion is that there are quite a few different types of message pumps that might\n\t\t// be running:\n\t\t// - InputBox/MsgBox, or other dialog\n\t\t// - Popup menu (tray menu, popup menu from Menu command, or context menu of an Edit/MonthCal, including\n\t\t// our main window's edit control g_hWndEdit).\n\t\t// - Probably others, such as ListView marquee-drag, that should be listed here as they are\n\t\t// remembered/discovered.\n\t\t//\n\t\t// Due to maintainability and the uncertainty over backward compatibility (see comments above), the\n\t\t// following message is posted even when INTERRUPTIBLE==false.\n\t\t// Post it with a NULL hwnd (update: also for backward compatibility) to avoid any chance that our\n\t\t// message pump will dispatch it back to us. We want these events to always be handled there,\n\t\t// where almost all new quasi-threads get launched. Update: Even if it were safe in terms of\n\t\t// backward compatibility to change NULL to gHwnd, testing shows it causes problems when a hotkey\n\t\t// is pressed while one of the script's menus is displayed (at least a menu bar). For example:\n\t\t// *LCtrl::Send {Blind}{Ctrl up}{Alt down}\n\t\t// *LCtrl up::Send {Blind}{Alt up}\n\t\tPostMessage(NULL, iMsg, wParam, lParam);\n\t\tif (IsInterruptible())\n\t\t\tMsgSleep(-1, RETURN_AFTER_MESSAGES_SPECIAL_FILTER);\n\t\t//else let the other pump discard this hotkey event since in most cases it would do more harm than good\n\t\t// (see comments above for why the message is posted even when it is 90% certain it will be discarded\n\t\t// in all cases where MsgSleep isn't done).\n\t\treturn 0;\n\n\tcase WM_TIMER:\n\t\t// MSDN: \"When you specify a TimerProc callback function, the default window procedure calls\n\t\t// the callback function when it processes WM_TIMER. Therefore, you need to dispatch messages\n\t\t// in the calling thread, even when you use TimerProc instead of processing WM_TIMER.\"\n\t\t// MSDN CONTRADICTION: \"You can process the message by providing a WM_TIMER case in the window\n\t\t// procedure. Otherwise, DispatchMessage will call the TimerProc callback function specified in\n\t\t// the call to the SetTimer function used to install the timer.\"\n\t\t// In light of the above, it seems best to let the default proc handle this message if it\n\t\t// has a non-NULL lparam:\n\t\tif (lParam)\n\t\t\tbreak;\n\t\t// Otherwise, it's the main timer, which is the means by which joystick hotkeys and script timers\n\t\t// created via the script command \"SetTimer\" continue to execute even while a dialog's message pump\n\t\t// is running. Even if the script is NOT INTERRUPTIBLE (which generally isn't possible, since\n\t\t// the mere fact that we're here means that a dialog's message pump dispatched a message to us\n\t\t// [since our msg pump would not dispatch this type of msg], which in turn means that the script\n\t\t// should be interruptible due to DIALOG_PREP), call MsgSleep() anyway so that joystick\n\t\t// hotkeys will be polled. If any such hotkeys are \"newly down\" right now, those events queued\n\t\t// will be buffered/queued for later, when the script becomes interruptible again. Also, don't\n\t\t// call CheckScriptTimers() or PollJoysticks() directly from here. See comments at the top of\n\t\t// those functions for why.\n\t\t// This is an older comment, but I think it might still apply, which is why MsgSleep() is not\n\t\t// called when a popup menu or a window's main menu is visible. We don't really want to run the\n\t\t// script's timed subroutines or monitor joystick hotkeys while a menu is displayed anyway:\n\t\t// Do not call MsgSleep() while a popup menu is visible because that causes long delays\n\t\t// sometime when the user is trying to select a menu (the user's click is ignored and the menu\n\t\t// stays visible). I think this is because MsgSleep()'s PeekMessage() intercepts the user's\n\t\t// clicks and is unable to route them to TrackPopupMenuEx()'s message loop, which is the only\n\t\t// place they can be properly processed. UPDATE: This also needs to be done when the MAIN MENU\n\t\t// is visible, because testing shows that that menu would otherwise become sluggish too, perhaps\n\t\t// more rarely, when timers are running.\n\t\t// Other background info:\n\t\t// Checking g_MenuIsVisible here prevents timed subroutines from running while the tray menu\n\t\t// or main menu is in use. This is documented behavior, and is desirable most of the time\n\t\t// anyway. But not to do this would produce strange effects because any timed subroutine\n\t\t// that took a long time to run might keep us away from the \"menu loop\", which would result\n\t\t// in the menu becoming temporarily unresponsive while the user is in it (and probably other\n\t\t// undesired effects).\n\t\tif (!g_MenuIsVisible)\n\t\t\tMsgSleep(-1, RETURN_AFTER_MESSAGES_SPECIAL_FILTER);\n\t\treturn 0;\n\n\tcase WM_SYSCOMMAND:\n\t\tif ((wParam == SC_CLOSE || wParam == SC_MINIMIZE) && hWnd == g_hWnd) // i.e. behave this way only for main window.\n\t\t{\n\t\t\t// The user has either clicked the window's \"X\" button, chosen \"Close\"\n\t\t\t// from the system (upper-left icon) menu, or pressed Alt-F4. In all\n\t\t\t// these cases, we want to hide the window rather than actually closing\n\t\t\t// it. If the user really wishes to exit the program, a File->Exit\n\t\t\t// menu option may be available, or use the Tray Icon, or launch another\n\t\t\t// instance which will close the previous, etc. UPDATE: SC_MINIMIZE is\n\t\t\t// now handled this way also so that owned windows won't be hidden when\n\t\t\t// the main window is hidden.\n\t\t\tShowWindow(g_hWnd, SW_HIDE);\n\t\t\treturn 0;\n\t\t}\n\t\tbreak;\n\n\tcase WM_CLOSE:\n\t\tif (hWnd == g_hWnd) // i.e. not anything other than the main window.\n\t\t{\n\t\t\t// Receiving this msg is fairly unusual since SC_CLOSE is intercepted and redefined above.\n\t\t\t// However, it does happen if an external app is asking us to close, such as another\n\t\t\t// instance of this same script during the Reload command. So treat it in a way similar\n\t\t\t// to the user having chosen Exit from the menu.\n\t\t\t//\n\t\t\t// Leave it up to ExitApp() to decide whether to terminate based upon whether\n\t\t\t// there is an OnExit function, whether that function is already running at\n\t\t\t// the time a new WM_CLOSE is received, etc. It's also its responsibility to call\n\t\t\t// DestroyWindow() upon termination so that the WM_DESTROY message winds up being\n\t\t\t// received and process in this function (which is probably necessary for a clean\n\t\t\t// termination of the app and all its windows):\n\t\t\tg_script.ExitApp(EXIT_CLOSE);\n\t\t\treturn 0; // Verified correct.\n\t\t}\n\t\t// Otherwise, some window of ours other than our main window was destroyed.\n\t\t// Let DefWindowProc() handle it:\n\t\tbreak;\n\n\tcase WM_ENDSESSION: // MSDN: \"A window receives this message through its WindowProc function.\"\n\t\tif (wParam) // The session is being ended.\n\t\t\tg_script.ExitApp((lParam & ENDSESSION_LOGOFF) ? EXIT_LOGOFF : EXIT_SHUTDOWN);\n\t\t//else a prior WM_QUERYENDSESSION was aborted; i.e. the session really isn't ending.\n\t\treturn 0; // Verified correct.\n\n\tcase AHK_EXIT_BY_RELOAD:\n\t\tg_script.ExitApp(EXIT_RELOAD);\n\t\treturn 0; // Whether ExitApp() terminates depends on whether there's an OnExit function and what it does.\n\n\tcase AHK_EXIT_BY_SINGLEINSTANCE:\n\t\tg_script.ExitApp(EXIT_SINGLEINSTANCE);\n\t\treturn 0; // Whether ExitApp() terminates depends on whether there's an OnExit function and what it does.\n\n\tcase WM_DESTROY:\n\t\tif (hWnd == g_hWnd) // i.e. not anything other than the main window.\n\t\t{\n\t\t\tif (!g_DestroyWindowCalled)\n\t\t\t\t// This is done because I believe it's possible for a WM_DESTROY message to be received\n\t\t\t\t// even though we didn't call DestroyWindow() ourselves (e.g. via DefWindowProc() receiving\n\t\t\t\t// and acting upon a WM_CLOSE or us calling DestroyWindow() directly) -- perhaps the window\n\t\t\t\t// is being forcibly closed or something else abnormal happened. Make a best effort to run\n\t\t\t\t// the OnExit function, if present, even without a main window (testing on an earlier\n\t\t\t\t// versions shows that most commands work fine without the window). For EXIT_DESTROY,\n\t\t\t\t// it always terminates after running the OnExit callback:\n\t\t\t\tg_script.ExitApp(EXIT_DESTROY);\n\t\t\t// Do not do PostQuitMessage() here because we don't know the proper exit code.\n\t\t\t// MSDN: \"The exit value returned to the system must be the wParam parameter of\n\t\t\t// the WM_QUIT message.\"\n\t\t\t// If we're here, it means our thread called DestroyWindow() directly or indirectly\n\t\t\t// (currently, it's only called directly). By returning, our thread should resume\n\t\t\t// execution at the statement after DestroyWindow() in whichever caller called that:\n\t\t\treturn 0; // \"If an application processes this message, it should return zero.\"\n\t\t}\n\t\t// Otherwise, some window of ours other than our main window was destroyed.\n\t\t// Let DefWindowProc() handle it:\n\t\tbreak;\n\n\tcase WM_CREATE:\n\t\t// MSDN: If an application processes this message, it should return zero to continue\n\t\t// creation of the window. If the application returns 1, the window is destroyed and\n\t\t// the CreateWindowEx or CreateWindow function returns a NULL handle.\n\t\treturn 0;\n\n\tcase WM_WINDOWPOSCHANGED:\n\t\tif (hWnd == g_hWnd && (LPWINDOWPOS(lParam)->flags & SWP_HIDEWINDOW) && g_script.mIsReadyToExecute)\n\t\t{\n\t\t\tg_script.ExitIfNotPersistent(EXIT_CLOSE);\n\t\t\treturn 0;\n\t\t}\n\t\tbreak; // Let DWP handle it.\n\n\tcase WM_SIZE:\n\t\tif (hWnd == g_hWnd)\n\t\t{\n\t\t\tif (wParam == SIZE_MINIMIZED)\n\t\t\t\t// Minimizing the main window hides it. This message generally doesn't arrive as a\n\t\t\t\t// result of user interaction, since WM_SYSCOMMAND, SC_MINIMIZE is handled as well.\n\t\t\t\t// However, this is necessary to keep the main window hidden when CreateWindows()\n\t\t\t\t// minimizes it during startup.\n\t\t\t\tShowWindow(g_hWnd, SW_HIDE);\n\t\t\telse\n\t\t\t\tMoveWindow(g_hWndEdit, 0, 0, LOWORD(lParam), HIWORD(lParam), TRUE);\n\t\t\treturn 0; // The correct return value for this msg.\n\t\t}\n\t\tbreak; // Let DWP handle it.\n\t\t\n\tcase WM_SETFOCUS:\n\t\tif (hWnd == g_hWnd)\n\t\t{\n\t\t\tSetFocus(g_hWndEdit); // Always focus the edit window, since it's the only navigable control.\n\t\t\treturn 0;\n\t\t}\n\t\tbreak;\n\n\tcase WM_CLIPBOARDUPDATE:\n\t\tif (g_script.mOnClipboardChange.Count()) // In case it's a bogus msg, it's our responsibility to avoid posting the msg if there's no function to call.\n\t\t\tPostMessage(g_hWnd, AHK_CLIPBOARD_CHANGE, 0, 0); // It's done this way to buffer it when the script is uninterruptible, etc. v1.0.44: Post to g_hWnd vs. NULL so that notifications aren't lost when script is displaying a MsgBox or other dialog.\n\t\treturn 0;\n\n\tcase AHK_GETWINDOWTEXT:\n\t\t// It's best to handle this msg here rather than in the main event loop in case a non-standard message\n\t\t// pump is running (such as MsgBox's), in which case this msg would be dispatched directly here.\n\t\tif (IsWindow((HWND)lParam)) // In case window has been destroyed since msg was posted.\n\t\t\tGetWindowText((HWND)lParam, (LPTSTR )wParam, KEY_HISTORY_WINDOW_TITLE_SIZE);\n\t\t// Probably best not to do the following because it could result in such \"low priority\" messages\n\t\t// getting out of step with each other, and could also introduce KeyHistory WinTitle \"lag\":\n\t\t// Could give low priority to AHK_GETWINDOWTEXT under the theory that sometimes the call takes a long\n\t\t// time to return: Upon receipt of such a message, repost it whenever Peek(specific_msg_range, PM_NOREMOVE)\n\t\t// detects a thread-starting event on the queue. However, Peek might be a high overhead call in some cases,\n\t\t// such as when/if it yields our timeslice upon returning FALSE (uncertain/unlikely, but in any case\n\t\t// it might do more harm than good).\n\t\treturn 0;\n\n\tcase AHK_HOT_IF_EVAL: // HotCriterionAllowsFiring uses this to ensure expressions are evaluated only on the main thread.\n\t\t// Ensure wParam is a valid criterion (might prevent shatter attacks):\n\t\tfor (HotkeyCriterion *cp = g_FirstHotExpr; cp; cp = cp->NextExpr)\n\t\t\tif ((WPARAM)cp == wParam)\n\t\t\t\treturn cp->Eval((LPTSTR)lParam);\n\t\treturn 0;\n\n\tcase WM_ENTERMENULOOP:\n\t\tCheckMenuItem(GetMenu(g_hWnd), ID_FILE_PAUSE, g->IsPaused ? MF_CHECKED : MF_UNCHECKED); // This is the menu bar in the main window; the tray menu's checkmark is updated only when the tray menu is actually displayed.\n\t\tg_MenuIsVisible = true; // See comments in similar code in GuiWindowProc().\n\t\tbreak;\n\tcase WM_EXITMENULOOP:\n\t\tg_MenuIsVisible = false; // See comments in similar code in GuiWindowProc().\n\t\tbreak;\n\tcase WM_INITMENUPOPUP:\n\t\tInitMenuPopup((HMENU)wParam);\n\t\tbreak;\n\tcase WM_UNINITMENUPOPUP:\n\t\tUninitMenuPopup((HMENU)wParam);\n\t\tbreak;\n\tcase WM_ACTIVATEAPP:\n\t\t// Modeless menus correctly cancel when losing focus to another window within the same process,\n\t\t// but not when losing focus to another app, so we handle that here if we made the menu modeless.\n\t\t// Don't do it if the script made the menu modeless since in that case the script might want it\n\t\t// to remain open. It appears that WM_ACTIVATEAPP is sent to all top-level windows, so there's\n\t\t// no need to handle this in GuiWindowProc().\n\t\tif (!wParam && g_MenuIsTempModeless)\n\t\t\tEndMenu();\n\t\tbreak;\n\tcase WM_MENUSELECT:\n\t\t// The following is a workaround for left click failing to activate a menu item in a modeless\n\t\t// menu if the mouse was moved quickly from the main menu into a submenu (reproduced on Windows\n\t\t// 7 and 11). Strangely, double-click still activates the item. Moving the selection restores\n\t\t// normal behaviour, so the workaround just deselects the item and allows it to be reselected.\n\t\t// Care must be taken to avoid a loop, because deselecting the item causes the parent menu to\n\t\t// be reselected, which causes WM_MENUSELECT to be sent.\n\t\tif (g_MenuIsTempModeless)\n\t\t{\n\t\t\tstatic HMENU sLastSelectedMenu = NULL; // Limits unnecessarily application of the workaround.\n\t\t\tstatic bool sRecursiveCall = false; // Prevents looping due to MN_SELECTITEM causing WM_MENUSELECT.\n\t\t\tif (sLastSelectedMenu != (HMENU)lParam && !sRecursiveCall)\n\t\t\t{\n\t\t\t\tsLastSelectedMenu = (HMENU)lParam; // Before SendMessage() below.\n\t\t\t\tconstexpr auto MF_WANTED = MF_MOUSESELECT | MF_HILITE; // Item selected by mouse.\n\t\t\t\tconstexpr auto MF_UNWANTED = MF_GRAYED | MF_DISABLED | MF_POPUP; // Items not needing the workaround.\n\t\t\t\tHWND fore_win;\n\t\t\t\tif ( (HMENU)lParam != g_MenuIsTempModeless // Only submenus need the workaround.\n\t\t\t\t\t&& (HIWORD(wParam) & (MF_WANTED | MF_UNWANTED)) == MF_WANTED\n\t\t\t\t\t&& (fore_win = GetForegroundWindow())\n\t\t\t\t\t&& SendMessage(fore_win, MN_GETHMENU, 0, 0) == lParam )\n\t\t\t\t{\n\t\t\t\t\tconstexpr auto Mn_SELECTITEM = 0x01E5; // Undocumented message?\n\t\t\t\t\tsRecursiveCall = true;\n\t\t\t\t\tSendMessage(fore_win, Mn_SELECTITEM, -1, 0);\n\t\t\t\t\tsRecursiveCall = false;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tbreak;\n\n#ifdef CONFIG_DEBUGGER\n\tcase AHK_CHECK_DEBUGGER:\n\t\t// This message is sent when data arrives on the debugger's socket. It allows the\n\t\t// debugger to respond to commands which are sent while the script is sleeping or\n\t\t// waiting for messages.\n\t\tif (g_Debugger.IsConnected() && (g_Debugger.HasPendingCommand() || LOWORD(lParam) == FD_CLOSE))\n\t\t\tg_Debugger.ProcessCommands();\n\t\tbreak;\n#endif\n\n\tdefault:\n\t\t// The following iMsg can't be in the switch() since it's not constant:\n\t\tif (iMsg == WM_TASKBARCREATED && !g_NoTrayIcon) // !g_NoTrayIcon --> the tray icon should be always visible.\n\t\t{\n\t\t\t// This message is sent by the system in two known cases:\n\t\t\t// 1) Explorer.exe has just started and the taskbar has been newly created.\n\t\t\t// In this case, the taskbar icon doesn't exist yet, so NIM_MODIFY would fail.\n\t\t\t// 2) The screen DPI has just changed. Our icon already exists, but has probably\n\t\t\t// been resized by the system. If we don't refresh it, it becomes blurry.\n\t\t\tg_script.UpdateTrayIcon(true);\n\t\t\t// And now pass this iMsg on to DefWindowProc() in case it does anything with it.\n\t\t}\n\t\t\n#ifdef CONFIG_DEBUGGER\n\t\tstatic UINT sAttachDebuggerMessage = RegisterWindowMessage(_T(\"AHK_ATTACH_DEBUGGER\"));\n\t\tif (iMsg == sAttachDebuggerMessage && !g_Debugger.IsConnected())\n\t\t{\n\t\t\tchar dbg_host[16] = \"localhost\"; // IPv4 max string len\n\t\t\tchar dbg_port[6] = \"9000\";\n\n\t\t\tif (wParam)\n\t\t\t{\t// Convert 32-bit address to string for Debugger::Connect().\n\t\t\t\tin_addr addr;\n\t\t\t\taddr.S_un.S_addr = (ULONG)wParam;\n\t\t\t\tchar *tmp = inet_ntoa(addr);\n\t\t\t\tif (tmp)\n\t\t\t\t\tstrcpy(dbg_host, tmp);\n\t\t\t}\n\t\t\tif (lParam)\n\t\t\t\t// Convert 16-bit port number to string for Debugger::Connect().\n\t\t\t\t_itoa(LOWORD(lParam), dbg_port, 10);\n\n\t\t\tif (g_Debugger.Connect(dbg_host, dbg_port) == DEBUGGER_E_OK)\n\t\t\t\tg_Debugger.Break();\n\t\t}\n#endif\n\n\t} // switch()\n\n\treturn DefWindowProc(hWnd, iMsg, wParam, lParam);\n}\n\n\n\nbool FindAutoHotkeyUtilSub(LPTSTR aFile, LPTSTR aDir)\n{\n\tSetCurrentDirectory(aDir);\n\treturn GetFileAttributes(aFile) != INVALID_FILE_ATTRIBUTES;\n}\n\nbool FindAutoHotkeyUtil(LPTSTR aFile, bool &aFoundOurs)\n{\n\t// Always try our directory first, in case it has different utils to the installed version.\n\tif ( !(aFoundOurs = FindAutoHotkeyUtilSub(aFile, g_script.mOurEXEDir)) )\n\t{\n\t\t// Try GetAHKInstallDir() so that compiled scripts running on machines that happen\n\t\t// to have AHK installed will still be able to fetch the help file and Window Spy:\n\t\tTCHAR installdir[MAX_PATH];\n\t\tif ( !GetAHKInstallDir(installdir)\n\t\t\t|| !FindAutoHotkeyUtilSub(aFile, installdir) )\n\t\t\treturn false;\n\t}\n\treturn true;\n}\n\nvoid LaunchAutoHotkeyUtil(LPTSTR aFile, bool aIsScript)\n{\n\tLPTSTR file = aFile, args = _T(\"\");\n\tbool our_file, result = false;\n\tif (!FindAutoHotkeyUtil(aFile, our_file))\n\t\treturn;\n#ifndef AUTOHOTKEYSC\n\t// If it's a script in our directory, use our EXE to run it.\n\tTCHAR buf[64]; // More than enough for \"/script WindowSpy.ahk\".\n\tif (aIsScript && our_file)\n\t{\n\t\tsntprintf(buf, _countof(buf), _T(\"/script %s\"), aFile);\n\t\tfile = g_script.mOurEXE;\n\t\targs = buf;\n\t}\n\t//else it's not a script or it's the installed copy of WindowSpy.ahk, so just run it.\n#endif\n\tif (!g_script.ActionExec(file, args, NULL, false))\n\t{\n\t\tTCHAR buf_file[64];\n\t\tsntprintf(buf_file, _countof(buf_file), _T(\"Could not launch %s\"), aFile);\n\t\tMsgBox(buf_file, MB_ICONERROR);\n\t}\n\tSetCurrentDirectory(g_WorkingDir); // Restore the proper working directory.\n}\n\nvoid LaunchWindowSpy()\n{\n\tLaunchAutoHotkeyUtil(_T(\"WindowSpy.ahk\"), true);\n}\n\nvoid LaunchAutoHotkeyHelp()\n{\n\tLaunchAutoHotkeyUtil(AHK_HELP_FILE, false);\n}\n\nbool HandleMenuItem(HWND aHwnd, WORD aMenuItemID, HWND aGuiHwnd)\n// See if an item was selected from the tray menu or main menu. Note that it is possible\n// for one of the standard menu items to be triggered from a GUI menu if the menu or one of\n// its submenus was modified with the \"menu, MenuName, Standard\" command.\n// Returns true if the message is fully handled here, false otherwise.\n{\n\tswitch (aMenuItemID)\n\t{\n\tcase ID_TRAY_OPEN:\n\t\tShowMainWindow();\n\t\treturn true;\n\tcase ID_TRAY_EDITSCRIPT:\n\tcase ID_FILE_EDITSCRIPT:\n\t\tg_script.Edit();\n\t\treturn true;\n\tcase ID_TRAY_RELOADSCRIPT:\n\tcase ID_FILE_RELOADSCRIPT:\n\t\tif (!g_script.Reload(false))\n\t\t\tMsgBox(_T(\"The script could not be reloaded.\"));\n\t\treturn true;\n\tcase ID_TRAY_WINDOWSPY:\n\tcase ID_FILE_WINDOWSPY:\n\t\tLaunchWindowSpy();\n\t\treturn true;\n\tcase ID_TRAY_HELP:\n\tcase ID_HELP_USERMANUAL:\n\t\tLaunchAutoHotkeyHelp();\n\t\treturn true;\n\tcase ID_TRAY_SUSPEND:\n\tcase ID_FILE_SUSPEND:\n\t\tToggleSuspendState();\n\t\treturn true;\n\tcase ID_TRAY_PAUSE:\n\tcase ID_FILE_PAUSE:\n\t\tif (g->IsPaused)\n\t\t\t--g_nPausedThreads;\n\t\telse\n\t\t\t++g_nPausedThreads; // For this purpose the idle thread is counted as a paused thread.\n\t\tg->IsPaused = !g->IsPaused;\n\t\tg_script.UpdateTrayIcon();\n\t\treturn true;\n\tcase ID_TRAY_EXIT:\n\tcase ID_FILE_EXIT:\n\t\tg_script.ExitApp(EXIT_MENU); // More reliable than PostQuitMessage(), which has been known to fail in rare cases.\n\t\treturn true; // If there is an OnExit function, the above might not actually exit.\n\tcase ID_VIEW_LINES:\n\t\tShowMainWindow(MAIN_MODE_LINES);\n\t\treturn true;\n\tcase ID_VIEW_VARIABLES:\n\t\tShowMainWindow(MAIN_MODE_VARS);\n\t\treturn true;\n\tcase ID_VIEW_HOTKEYS:\n\t\tShowMainWindow(MAIN_MODE_HOTKEYS);\n\t\treturn true;\n\tcase ID_VIEW_KEYHISTORY:\n\t\tShowMainWindow(MAIN_MODE_KEYHISTORY);\n\t\treturn true;\n\tcase ID_VIEW_REFRESH:\n\t\tShowMainWindow(MAIN_MODE_REFRESH);\n\t\treturn true;\n\tcase ID_HELP_WEBSITE:\n\t\tif (!g_script.ActionExec(_T(AHK_WEBSITE), _T(\"\"), NULL, false))\n\t\t\tMsgBox(_T(\"Could not open URL \") _T(AHK_WEBSITE) _T(\" in default browser.\"));\n\t\treturn true;\n\tdefault:\n\t\t// See if this command ID is one of the user's custom menu items. Due to the possibility\n\t\t// that some items have been deleted from the menu, can't rely on comparing\n\t\t// aMenuItemID to g_script.mMenuItemCount in any way. Just look up the ID to make sure\n\t\t// there really is a menu item for it:\n\t\tif (!g_script.FindMenuItemByID(aMenuItemID)) // Do nothing, let caller try to handle it some other way.\n\t\t\treturn false;\n\t\t// It seems best to treat the selection of a custom menu item in a way similar\n\t\t// to how hotkeys are handled by the hook. See comments near the definition of\n\t\t// POST_AHK_USER_MENU for more details.\n\t\tPOST_AHK_USER_MENU(aHwnd, aMenuItemID, (WPARAM)aGuiHwnd) // Send the menu's cmd ID and the window index (index is safer than pointer, since pointer might get deleted).\n\t\t// Try to maintain a list here of all the ways the script can be uninterruptible\n\t\t// at this moment in time, and whether that uninterruptibility should be overridden here:\n\t\t// 1) YES: g_MenuIsVisible is true (which in turn means that the script is marked\n\t\t// uninterruptible to prevent timed subroutines from running and possibly\n\t\t// interfering with menu navigation): Seems impossible because apparently \n\t\t// the WM_RBUTTONDOWN must first be returned from before we're called directly\n\t\t// with the WM_COMMAND message corresponding to the menu item chosen by the user.\n\t\t// In other words, g_MenuIsVisible will be false and the script thus will\n\t\t// not be uninterruptible, at least not solely for that reason.\n\t\t// 2) YES: A new hotkey or timed subroutine was just launched and it's still in its\n\t\t// grace period. In this case, ExecUntil()'s call of PeekMessage() every 10ms\n\t\t// or so will catch the item we just posted. But it seems okay to interrupt\n\t\t// here directly in most such cases. InitNewThread(): Newly launched\n\t\t// timed subroutine or hotkey subroutine.\n\t\t// 3) YES: Script is engaged in an uninterruptible activity such as SendKeys(). In this\n\t\t// case, since the user has managed to get the tray menu open, it's probably\n\t\t// best to process the menu item with the same priority as if any other menu\n\t\t// item had been selected, interrupting even a critical operation since that's\n\t\t// probably what the user would want. SLEEP_WITHOUT_INTERRUPTION: SendKeys,\n\t\t// Mouse input, Clipboard open, SetForegroundWindowEx().\n\t\t// 4) YES: AutoExecSection(): Since its grace period is only 100ms, doesn't seem to be\n\t\t// a problem. In any case, the timer would fire and briefly interrupt the menu\n\t\t// subroutine we're trying to launch here even if a menu item were somehow\n\t\t// activated in the first 100ms.\n\t\t//\n\t\t// IN LIGHT OF THE ABOVE, it seems best not to do the below. In addition, the msg\n\t\t// filtering done by MsgSleep when the script is uninterruptible now excludes the\n\t\t// AHK_USER_MENU message (i.e. that message is always retrieved and acted upon,\n\t\t// even when the script is uninterruptible):\n\t\t//if (!INTERRUPTIBLE)\n\t\t//\treturn true; // Leave the message buffered until later.\n\t\t// Now call the main loop to handle the message we just posted (and any others):\n\t\treturn true;\n\t} // switch()\n\treturn false; // Indicate that the message was NOT handled.\n}\n\n\n\nResultType ShowMainWindow(MainWindowModes aMode, bool aRestricted)\n// Always returns OK for caller convenience.\n{\n\t// v1.0.30.05: Increased from 32 KB to 64 KB, which is the maximum size of an Edit\n\t// in Win9x:\n\tTCHAR buf_temp[65534]; // Formerly 32767.\n\t*buf_temp = '\\0';\n\tbool jump_to_bottom = false; // Set default behavior for edit control.\n\tstatic MainWindowModes current_mode = MAIN_MODE_NO_CHANGE;\n\n\t// If we were called from a restricted place, such as via the Tray Menu or the Main Menu,\n\t// don't allow potentially sensitive info such as script lines and variables to be shown.\n\t// This is done so that scripts can be compiled more securely, making it difficult for anyone\n\t// to use ListLines to see the author's source code. Rather than make exceptions for things\n\t// like KeyHistory, it seems best to forbid all information reporting except in cases where\n\t// existing info in the main window -- which must have gotten there via an allowed function\n\t// such as ListLines encountered in the script -- is being refreshed. This is because in\n\t// that case, the script author has given de facto permission for that loophole (and it's\n\t// a pretty small one, not easy to exploit):\n\tif (aRestricted && !g_AllowMainWindow && (current_mode == MAIN_MODE_NO_CHANGE || aMode != MAIN_MODE_REFRESH))\n\t{\n\t\t// This used to set g_hWndEdit's text to an explanation for why the information will not\n\t\t// be shown, but it would never be seen unless the window was shown by some other means.\n\t\t// Since the menu items are disabled or removed, execution probably reached here as a\n\t\t// result of direct PostMessage to the script, so whoever did it can probably deal with\n\t\t// the lack of explanation (if the window was even visible). The explanation contained\n\t\t// obsolete syntax (Menu, Tray, MainWindow) and was removed rather than updated to reduce\n\t\t// code size. It seems unnecessary to even clear g_hWndEdit: either it's already empty,\n\t\t// or content was placed there deliberately and was already accessible.\n\t\t//SendMessage(g_hWndEdit, WM_SETTEXT, 0, (LPARAM)_T(\"Disabled\"));\n\t\treturn OK;\n\t}\n\n\t// If the window is empty, caller wants us to default it to showing the most recently\n\t// executed script lines:\n\tif (current_mode == MAIN_MODE_NO_CHANGE && (aMode == MAIN_MODE_NO_CHANGE || aMode == MAIN_MODE_REFRESH))\n\t\taMode = MAIN_MODE_LINES;\n\n\tswitch (aMode)\n\t{\n\t// case MAIN_MODE_NO_CHANGE: do nothing\n\tcase MAIN_MODE_LINES:\n\t\tLine::LogToText(buf_temp, _countof(buf_temp));\n\t\tjump_to_bottom = true;\n\t\tbreak;\n\tcase MAIN_MODE_VARS:\n\t\tg_script.ListVars(buf_temp, _countof(buf_temp));\n\t\tbreak;\n\tcase MAIN_MODE_HOTKEYS:\n\t\tHotkey::ListHotkeys(buf_temp, _countof(buf_temp));\n\t\tbreak;\n\tcase MAIN_MODE_KEYHISTORY:\n\t\tg_script.ListKeyHistory(buf_temp, _countof(buf_temp));\n\t\tbreak;\n\tcase MAIN_MODE_REFRESH:\n\t\t// Rather than do a recursive call to self, which might stress the stack if the script is heavily recursed:\n\t\tswitch (current_mode)\n\t\t{\n\t\tcase MAIN_MODE_LINES:\n\t\t\tLine::LogToText(buf_temp, _countof(buf_temp));\n\t\t\tjump_to_bottom = true;\n\t\t\tbreak;\n\t\tcase MAIN_MODE_VARS:\n\t\t\tg_script.ListVars(buf_temp, _countof(buf_temp));\n\t\t\tbreak;\n\t\tcase MAIN_MODE_HOTKEYS:\n\t\t\tHotkey::ListHotkeys(buf_temp, _countof(buf_temp));\n\t\t\tbreak;\n\t\tcase MAIN_MODE_KEYHISTORY:\n\t\t\tg_script.ListKeyHistory(buf_temp, _countof(buf_temp));\n\t\t\t// Special mode for when user refreshes, so that new keys can be seen without having\n\t\t\t// to scroll down again:\n\t\t\tjump_to_bottom = true;\n\t\t\tbreak;\n\t\t}\n\t\tbreak;\n\t}\n\n\tif (aMode != MAIN_MODE_REFRESH && aMode != MAIN_MODE_NO_CHANGE)\n\t\tcurrent_mode = aMode;\n\n\t// Update the text before displaying the window, since it might be a little less disruptive\n\t// and might also be quicker if the window is hidden or non-foreground.\n\t// Unlike SetWindowText(), this method seems to expand tab characters:\n\tif (aMode != MAIN_MODE_NO_CHANGE)\n\t\tSendMessage(g_hWndEdit, WM_SETTEXT, 0, (LPARAM)buf_temp);\n\n\tif (!IsWindowVisible(g_hWnd))\n\t{\n\t\tShowWindow(g_hWnd, SW_SHOW);\n\t\tif (IsIconic(g_hWnd)) // This happens whenever the window was last hidden via the minimize button.\n\t\t\tShowWindow(g_hWnd, SW_RESTORE);\n\t}\n\tif (g_hWnd != GetForegroundWindow())\n\t\tif (!SetForegroundWindow(g_hWnd))\n\t\t\tSetForegroundWindowEx(g_hWnd); // Only as a last resort, since it uses AttachThreadInput()\n\n\tif (jump_to_bottom)\n\t{\n\t\tSendMessage(g_hWndEdit, EM_LINESCROLL , 0, 999999);\n\t\t//SendMessage(g_hWndEdit, EM_SETSEL, -1, -1);\n\t\t//SendMessage(g_hWndEdit, EM_SCROLLCARET, 0, 0);\n\t}\n\treturn OK;\n}\n\n\n\nbif_impl void ListLines(optl<int> aMode, int &aRetVal)\n{\n\taRetVal = g->ListLinesIsEnabled;\n\tif (!aMode.has_value())\n\t{\n\t\tShowMainWindow(MAIN_MODE_LINES, false); // Pass \"unrestricted\" when the command is explicitly used in the script.\n\t\treturn;\n\t}\n\tif (g->ListLinesIsEnabled)\n\t{\n\t\t// Since ExecUntil() just logged this ListLines On/Off in the line history, remove it to avoid\n\t\t// cluttering the line history with distracting lines that the user probably wouldn't want to see.\n\t\t// Might be especially useful in cases where a timer fires frequently (even if such a timer used\n\t\t// \"ListLines 0\" as its top line, that line itself would appear very frequently in the line history).\n\t\tif (Line::sLogNext > 0)\n\t\t\t--Line::sLogNext;\n\t\telse\n\t\t\tLine::sLogNext = LINE_LOG_SIZE - 1;\n\t\tLine::sLog[Line::sLogNext] = NULL; // Without this, one of the lines in the history would be invalid due to the circular nature of the line history array, which would also cause the line history to show the wrong chronological order in some cases.\n\t}\n\t// aMode is defined as Int32 rather than Bool32 to avoid confusion\n\t// (ListLines(\"\") acting as ListLines(false) instead of ListLines())\n\t// and reserve string values for potential future use.\n\tg->ListLinesIsEnabled = *aMode != 0;\n}\n\n\n\nbif_impl void ListVars()\n{\n\tShowMainWindow(MAIN_MODE_VARS, false); // Pass \"unrestricted\" when the command is explicitly used in the script.\n}\n\n\n\nbif_impl void ListHotkeys()\n{\n\tShowMainWindow(MAIN_MODE_HOTKEYS, false); // Pass \"unrestricted\" when the command is explicitly used in the script.\n}\n\n\n\nbif_impl FResult KeyHistory(optl<int> aMaxEvents)\n{\n\tif (!aMaxEvents.has_value())\n\t{\n\t\tShowMainWindow(MAIN_MODE_KEYHISTORY, false); // Pass \"unrestricted\" when the command is explicitly used in the script.\n\t\treturn OK;\n\t}\n\tint value = *aMaxEvents;\n\tif (value < 0 || value > 500)\n\t\treturn FR_E_ARG(0);\n\t// GetHookStatus() only has a limited size buffer in which to transcribe the keystrokes.\n\t// 500 events is about what you would expect to fit in a 32 KB buffer (in the unlikely\n\t// event that the transcribed events create too much text, the text will be truncated,\n\t// so it's not dangerous anyway).\n\tif (g_KeybdHook || g_MouseHook)\n\t\tPostThreadMessage(g_HookThreadID, AHK_HOOK_SET_KEYHISTORY, value, 0);\n\telse\n\t\tSetKeyHistoryMax(value);\n\treturn OK;\n}\n\n\n\nDWORD GetAHKInstallDir(LPTSTR aBuf)\n// Caller must pass a buffer of MAX_PATH characters.\n// Returns the length of the string (0 if empty).\n{\n\tfor (HKEY key = HKEY_CURRENT_USER; ; key = HKEY_LOCAL_MACHINE)\n\t{\n#ifdef _WIN64\n\t\t// First try 64-bit registry, then 32-bit registry.\n\t\tfor (DWORD flag = 0; ; flag = KEY_WOW64_32KEY)\n#else\n\t\t// First try 32-bit registry, then 64-bit registry.\n\t\tfor (DWORD flag = 0; ; flag = KEY_WOW64_64KEY)\n#endif\n\t\t{\n\t\t\tDWORD length = ReadRegString(key, _T(\"SOFTWARE\\\\AutoHotkey\"), _T(\"InstallDir\"), aBuf, MAX_PATH, flag);\n\t\t\tif (length)\n\t\t\t\treturn length;\n\t\t\tif (flag)\n\t\t\t\tbreak;\n\t\t}\n\t\tif (key == HKEY_LOCAL_MACHINE)\n\t\t\treturn 0;\n\t}\n}\n\n\n\nLPTSTR Script::DefaultDialogTitle()\n{\n\t// If the script has set A_ScriptName, use that:\n\tif (mScriptName)\n\t\treturn mScriptName;\n\t// If available, the script's filename seems a much better title than the program name\n\t// in case the user has more than one script running:\n\treturn (mFileName && *mFileName) ? mFileName : T_AHK_NAME_VERSION;\n}\n\n\n\n/////////////////////////\n// GUI-related: MsgBox //\n/////////////////////////\n\n\nResultType MsgBoxParseOptions(LPCTSTR aOptions, int &aType, double &aTimeout, HWND &aOwner)\n{\n\taType = 0;\n\taTimeout = 0;\n\n\tif (!aOptions)\n\t\treturn OK;\n\n\t//int button_option = 0;\n\t//int icon_option = 0;\n\n\tint option_int;\n\tLPCTSTR next_option, option_end;\n\tTCHAR option[1+MAX_NUMBER_SIZE];\n\tfor (next_option = omit_leading_whitespace(aOptions); ; next_option = omit_leading_whitespace(option_end))\n\t{\n\t\tif (!*next_option)\n\t\t\treturn OK;\n\n\t\t// Find the end of this option item:\n\t\tif ( !(option_end = StrChrAny(next_option, _T(\" \\t\"))) ) // Space or tab.\n\t\t\toption_end = next_option + _tcslen(next_option); // Set to position of zero terminator instead.\n\t\tsize_t option_length = option_end - next_option;\n\n\t\t// Make a terminated copy for simplicity and to reduce ambiguity:\n\t\tif (option_length + 1 > _countof(option))\n\t\t\tgoto invalid_option;\n\t\ttmemcpy(option, next_option, option_length);\n\t\toption[option_length] = '\\0';\n\n\t\tif (option_length <= 5 && !_tcsnicmp(option, _T(\"Icon\"), 4))\n\t\t{\n\t\t\taType &= ~MB_ICONMASK;\n\t\t\tswitch (option[4])\n\t\t\t{\n\t\t\tcase 'x': case 'X': aType |= MB_ICONERROR; break;\n\t\t\tcase '?': aType |= MB_ICONQUESTION; break;\n\t\t\tcase '!': aType |= MB_ICONEXCLAMATION; break;\n\t\t\tcase 'i': case 'I': aType |= MB_ICONINFORMATION; break;\n\t\t\tcase '\\0': break;\n\t\t\tdefault:\n\t\t\t\tgoto invalid_option;\n\t\t\t}\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"Default\"), 7) && ParseInteger(option + 7, option_int))\n\t\t{\n\t\t\tif (option_int < 1 || option_int > 0xF) // Currently MsgBox can only have 4 buttons, but MB_DEFMASK may allow for up to this many in future.\n\t\t\t\tgoto invalid_option;\n\t\t\taType = (aType & ~MB_DEFMASK) | ((option_int - 1) << 8); // 1=0, 2=0x100, 3=0x200, 4=0x300\n\t\t}\n\t\telse if (toupper(*option) == 'T' && IsNumeric(option + 1, FALSE, FALSE, TRUE))\n\t\t{\n\t\t\taTimeout = ATOF(option + 1);\n\t\t}\n\t\telse if (!_tcsnicmp(option, _T(\"Owner\"), 5) && IsNumeric(option + 5, TRUE, TRUE, FALSE))\n\t\t{\n\t\t\taOwner = (HWND)ATOI64(option + 5); // This should be consistent with the Gui +Owner option.\n\t\t}\n\t\telse if (ParseInteger(option, option_int))\n\t\t{\n\t\t\t// Clear any conflicting options which were previously set.\n\t\t\tif (option_int & MB_TYPEMASK) aType &= ~MB_TYPEMASK;\n\t\t\tif (option_int & MB_ICONMASK) aType &= ~MB_ICONMASK;\n\t\t\tif (option_int & MB_DEFMASK) aType &= ~MB_DEFMASK;\n\t\t\tif (option_int & MB_MODEMASK) aType &= ~MB_MODEMASK;\n\t\t\t// All remaining options are bit flags (or not conflicting).\n\t\t\taType |= option_int;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tstatic LPCTSTR sButtonString[] = {\n\t\t\t\t_T(\"OK\"), _T(\"OKCancel\"), _T(\"AbortRetryIgnore\"), _T(\"YesNoCancel\"), _T(\"YesNo\"), _T(\"RetryCancel\"), _T(\"CancelTryAgainContinue\"),\n\t\t\t\t_T(\"O\"), _T(\"O/C\"), _T(\"A/R/I\"), _T(\"Y/N/C\"), _T(\"Y/N\"), _T(\"R/C\"), _T(\"C/T/C\"),\n\t\t\t\t_T(\"O\"), _T(\"OC\"), _T(\"ARI\"), _T(\"YNC\"), _T(\"YN\"), _T(\"RC\"), _T(\"CTC\")\n\t\t\t};\n\n\t\t\tfor (int i = 0; ; ++i)\n\t\t\t{\n\t\t\t\tif (i == _countof(sButtonString))\n\t\t\t\t\tgoto invalid_option;\n\n\t\t\t\tif (!_tcsicmp(option, sButtonString[i]))\n\t\t\t\t{\n\t\t\t\t\taType = (aType & ~MB_TYPEMASK) | (i % 7);\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\ninvalid_option:\n\treturn ValueError(ERR_INVALID_OPTION, next_option, FAIL_OR_OK);\n}\n\n\nLPTSTR MsgBoxResultString(int aResult)\n{\n\tswitch (aResult)\n\t{\n\tcase IDYES:\t\t\treturn _T(\"Yes\");\n\tcase IDNO:\t\t\treturn _T(\"No\");\n\tcase IDOK:\t\t\treturn _T(\"OK\");\n\tcase IDCANCEL:\t\treturn _T(\"Cancel\");\n\tcase IDABORT:\t\treturn _T(\"Abort\");\n\tcase IDIGNORE:\t\treturn _T(\"Ignore\");\n\tcase IDRETRY:\t\treturn _T(\"Retry\");\n\tcase IDCONTINUE:\treturn _T(\"Continue\");\n\tcase IDTRYAGAIN:\treturn _T(\"TryAgain\");\n\tcase AHK_TIMEOUT:\treturn _T(\"Timeout\");\n\tdefault:\t\t\treturn NULL;\n\t}\n}\n\n\nbif_impl FResult MsgBox(optl<StrArg> aText, optl<StrArg> aTitle, optl<StrArg> aOptions, StrRet &aRetVal)\n{\n\tint result;\n\tHWND dialog_owner = THREAD_DIALOG_OWNER; // Resolve macro only once to reduce code size.\n\t// dialog_owner is passed via parameter to avoid internally-displayed MsgBoxes from being\n\t// affected by script-thread's owner setting.\n\tint type;\n\tdouble timeout;\n\tif (!MsgBoxParseOptions(aOptions.value_or_null(), type, timeout, dialog_owner))\n\t\treturn FR_FAIL;\n\tSetLastError(0); // To differentiate MAX_MSGBOXES from invalid parameters.\n\tresult = MsgBox(aText.value_or_null(), type, aTitle.value_or_null(), timeout, dialog_owner);\n\t// If the MsgBox window can't be displayed for any reason, always return FAIL to\n\t// the caller because it would be unsafe to proceed with the execution of the\n\t// current script subroutine. For example, if the script contains an IfMsgBox after,\n\t// this line, it's result would be unpredictable and might cause the subroutine to perform\n\t// the opposite action from what was intended (e.g. Delete vs. don't delete a file).\n\t// v1.0.40.01: Rather than displaying another MsgBox in response to a failed attempt to display\n\t// a MsgBox, it seems better (less likely to cause trouble) just to abort the thread. This also\n\t// solves a double-msgbox issue when the maximum number of MsgBoxes is reached. In addition, the\n\t// max-msgbox limit is the most common reason for failure, in which case a warning dialog has\n\t// already been displayed, so there is no need to display another:\n\t//if (!result)\n\t//\t// It will fail if the text is too large (say, over 150K or so on XP), but that\n\t//\t// has since been fixed by limiting how much it tries to display.\n\t//\t// If there were too many message boxes displayed, it will already have notified\n\t//\t// the user of this via a final MessageBox dialog, so our call here will\n\t//\t// not have any effect. The below only takes effect if MsgBox()'s call to\n\t//\t// MessageBox() failed in some unexpected way:\n\t//\t_f_throw(\"The MsgBox could not be displayed.\");\n\n\t// Return a button name such as \"OK\", \"Yes\" or \"No\" if applicable.\n\tif (LPTSTR result_string = MsgBoxResultString(result))\n\t{\n\t\taRetVal.SetStatic(result_string);\n\t\treturn OK;\n\t}\n\tif (result == AHK_TOO_MANY_MSGBOXES)\n\t\t// Raise an error, since the MsgBox() might be intended to request approval or input from\n\t\t// the user, and continuing without doing so could be risky:\n\t\treturn FError(_T(\"The maximum number of MsgBoxes has been reached.\"));\n\tauto error = GetLastError();\n\treturn error == ERROR_INVALID_MSGBOX_STYLE ? FR_E_ARG(2) : FR_E_WIN32(error);\n}\n\n\n\n//////////////////////////\n// GUI-related: ToolTip //\n//////////////////////////\n\nbif_impl FResult ToolTip(optl<StrArg> aText, optl<int> aX, optl<int> aY, optl<int> aIndex, UINT &aRetVal)\n{\n\tint window_index = aIndex.value_or(1) - 1;\n\tif (window_index < 0 || window_index >= MAX_TOOLTIPS)\n\t\treturn FR_E_ARG(3);\n\n\tHWND tip_hwnd = g_hWndToolTip[window_index];\n\n\t// Destroy windows except the first (for performance) so that resources/mem are conserved.\n\t// The first window will be hidden by the TTM_UPDATETIPTEXT message if aText is blank.\n\t// UPDATE: For simplicity, destroy even the first in this way, because otherwise a script\n\t// that turns off a non-existent first tooltip window then later turns it on will cause\n\t// the window to appear in an incorrect position. Example:\n\t// ToolTip\n\t// ToolTip text, 388, 24\n\t// Sleep 1000\n\t// ToolTip text, 388, 24\n\tauto tip_text = aText.value_or_empty();\n\tif (!*tip_text)\n\t{\n\t\tif (tip_hwnd && IsWindow(tip_hwnd))\n\t\t\tDestroyWindow(tip_hwnd);\n\t\tg_hWndToolTip[window_index] = NULL;\n\t\taRetVal = 0;\n\t\treturn OK;\n\t}\n\t\n\tbool one_or_both_coords_unspecified = !aX.has_value() || !aY.has_value();\n\t\t \n\tPOINT pt, pt_cursor;\n\tif (one_or_both_coords_unspecified)\n\t{\n\t\t// Don't call GetCursorPos() unless absolutely needed because it seems to mess\n\t\t// up double-click timing, at least on XP. UPDATE: Is isn't GetCursorPos() that's\n\t\t// interfering with double clicks, so it seems it must be the displaying of the ToolTip\n\t\t// window itself.\n\t\tGetCursorPos(&pt_cursor);\n\t\tpt.x = pt_cursor.x + 16; // Set default spot to be near the mouse cursor.\n\t\tpt.y = pt_cursor.y + 16; // Use 16 to prevent the tooltip from overlapping large cursors.\n\t\t// Update: Below is no longer needed due to a better fix further down that handles multi-line tooltips.\n\t\t// 20 seems to be about the right amount to prevent it from \"warping\" to the top of the screen,\n\t\t// at least on XP:\n\t\t//if (pt.y > dtw.bottom - 20)\n\t\t//\tpt.y = dtw.bottom - 20;\n\t}\n\n\tPOINT origin = { 0 };\n\tif (aX.has_value() || aY.has_value()) // Need the offsets.\n\t\tCoordToScreen(origin, COORD_MODE_TOOLTIP);\n\n\t// This will also convert from relative to screen coordinates if appropriate:\n\tif (aX.has_value())\n\t\tpt.x = aX.value() + origin.x;\n\tif (aY.has_value())\n\t\tpt.y = aY.value() + origin.y;\n\tHMONITOR hmon = MonitorFromPoint(pt, MONITOR_DEFAULTTONEAREST);\n\tMONITORINFO mi;\n\tmi.cbSize = sizeof(mi);\n\tGetMonitorInfo(hmon, &mi);\n\t// v1.1.34: Use work area to avoid trying to overlap the taskbar on newer OSes, which otherwise\n\t// would cause the tooltip to appear at the top of the screen instead of the position we specify.\n\t// This was observed on Windows 10 and 11, and confirmed to not apply to Windows 7 or XP.\n\tRECT dtw = g_os.IsWin8orLater() ? mi.rcWork : mi.rcMonitor;\n\n\tTOOLINFO ti = { 0 };\n\tti.cbSize = sizeof(ti);\n\tti.uFlags = TTF_TRACK | TTF_ABSOLUTE;\n\tti.lpszText = const_cast<LPTSTR>(tip_text);\n\t// ti.hwnd is the window to which notification messages are sent. Set this to allow customization.\n\tti.hwnd = g_hWnd;\n\t// All of ti's other members are left at NULL/0, including the following:\n\t//ti.hinst = NULL;\n\t//ti.uId = 0;\n\t//ti.rect.left = ti.rect.top = ti.rect.right = ti.rect.bottom = 0;\n\n\t// My: This does more harm that good (it causes the cursor to warp from the right side to the left\n\t// if it gets to close to the right side), so for now, I did a different fix (above) instead:\n\t//ti.rect.bottom = dtw.bottom;\n\t//ti.rect.right = dtw.right;\n\t//ti.rect.top = dtw.top;\n\t//ti.rect.left = dtw.left;\n\n\t// No need to use SendMessageTimeout() since the ToolTip() is owned by our own thread, which\n\t// (since we're here) we know is not hung or heavily occupied.\n\n\t// v1.0.40.12: Added the IsWindow() check below to recreate the tooltip in cases where it was destroyed\n\t// by external means such as Alt-F4 or WinClose.\n\tbool newly_created = !tip_hwnd || !IsWindow(tip_hwnd);\n\tif (newly_created)\n\t{\n\t\t// This this window has no owner, it won't be automatically destroyed when its owner is.\n\t\t// Thus, it will be explicitly by the program's exit function.\n\t\ttip_hwnd = g_hWndToolTip[window_index] = CreateWindowEx(WS_EX_TOPMOST, TOOLTIPS_CLASS, NULL, TTS_NOPREFIX | TTS_ALWAYSTIP\n\t\t\t, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT, NULL, NULL, NULL, NULL);\n\t\tif (!tip_hwnd)\n\t\t\treturn FR_E_WIN32;\n\t\tSendMessage(tip_hwnd, TTM_ADDTOOL, 0, (LPARAM)(LPTOOLINFO)&ti);\n\t}\n\n\t// v1.1.34: Fixed to use the appropriate monitor, in case it's sized differently to the primary.\n\t// Also fixed to account for incorrect DPI scaling done by the tooltip control; i.e. a value of\n\t// n ends up allowing tooltips n*g_ScreenDPI/96 pixels wide. TTM_SETMAXTIPWIDTH seems to want\n\t// the max text width, not the max window width, so adjust for that. Do this every time since\n\t// the tooltip might be moving between screens of different sizes.\n\tRECT text_rect = dtw;\n\tSendMessage(tip_hwnd, TTM_ADJUSTRECT, FALSE, (LPARAM)&text_rect);\n\tSendMessage(tip_hwnd, TTM_SETMAXTIPWIDTH, 0, (LPARAM)((text_rect.right - text_rect.left) * 96 / g_ScreenDPI));\n\n\tif (newly_created)\n\t{\n\t\t// Must do these next two when the window is first created, otherwise GetWindowRect() below will retrieve\n\t\t// a tooltip window size that is quite a bit taller than it winds up being:\n\t\tSendMessage(tip_hwnd, TTM_TRACKPOSITION, 0, (LPARAM)MAKELONG(pt.x, pt.y));\n\t\tSendMessage(tip_hwnd, TTM_TRACKACTIVATE, TRUE, (LPARAM)&ti);\n\t}\n\t// Bugfix for v1.0.21: The below is now called unconditionally, even if the above newly created the window.\n\t// If this is not done, the tip window will fail to appear the first time it is invoked, at least when\n\t// all of the following are true:\n\t// 1) Windows XP;\n\t// 2) Common controls v6 (via manifest);\n\t// 3) \"Control Panel >> Display >> Effects >> Use transition >> Fade effect\" setting is in effect.\n\t// v1.1.34: Avoid TTM_UPDATETIPTEXT if the text hasn't changed, to reduce flicker. The behaviour described\n\t// above could not be replicated, EVEN ON WINDOWS XP. Whether it was ever observed on other OSes is unknown.\n\tif (!newly_created && !ToolTipTextEquals(tip_hwnd, tip_text))\n\t\tSendMessage(tip_hwnd, TTM_UPDATETIPTEXT, 0, (LPARAM)&ti);\n\n\tRECT ttw = { 0 };\n\tGetWindowRect(tip_hwnd, &ttw); // Must be called this late to ensure the tooltip has been created by above.\n\tint tt_width = ttw.right - ttw.left;\n\tint tt_height = ttw.bottom - ttw.top;\n\n\t// v1.0.21: Revised for multi-monitor support. I read somewhere that dtw.left can be negative (perhaps\n\t// if the secondary monitor is to the left of the primary). So it seems best to assume it is possible:\n\tif (pt.x + tt_width >= dtw.right)\n\t\tpt.x = dtw.right - tt_width - 1;\n\tif (pt.y + tt_height >= dtw.bottom)\n\t\tpt.y = dtw.bottom - tt_height - 1;\n\t// It seems best not to have each of the below paired with the above. This is because it allows\n\t// the flexibility to explicitly move the tooltip above or to the left of the screen. Such a feat\n\t// should only be possible if done via explicitly passed-in negative coordinates for aX and/or aY.\n\t// In other words, it should be impossible for a tooltip window to follow the mouse cursor somewhere\n\t// off the virtual screen because:\n\t// 1) The mouse cursor is normally trapped within the bounds of the virtual screen.\n\t// 2) The tooltip window defaults to appearing South-East of the cursor. It can only appear\n\t// in some other quadrant if jammed against the right or bottom edges of the screen, in which\n\t// case it can't be partially above or to the left of the virtual screen unless it's really\n\t// huge, which seems very unlikely given that it's limited to the maximum width of the\n\t// primary display as set by TTM_SETMAXTIPWIDTH above.\n\t//else if (pt.x < dtw.left) // Should be impossible for this to happen due to mouse being off the screen.\n\t//\tpt.x = dtw.left; // But could happen if user explicitly passed in a coord that was too negative.\n\t//...\n\t//else if (pt.y < dtw.top)\n\t//\tpt.y = dtw.top;\n\n\tif (one_or_both_coords_unspecified)\n\t{\n\t\t// Since Tooltip is being shown at the cursor's coordinates, try to ensure that the above\n\t\t// adjustment doesn't result in the cursor being inside the tooltip's window boundaries,\n\t\t// since that tends to cause problems such as blocking the tray area (which can make a\n\t\t// tooltip script impossible to terminate). Normally, that can only happen in this case\n\t\t// (one_or_both_coords_unspecified == true) when the cursor is near the bottom-right\n\t\t// corner of the screen (unless the mouse is moving more quickly than the script's\n\t\t// ToolTip update-frequency can cope with, but that seems inconsequential since it\n\t\t// will adjust when the cursor slows down):\n\t\tttw.left = pt.x;\n\t\tttw.top = pt.y;\n\t\tttw.right = ttw.left + tt_width;\n\t\tttw.bottom = ttw.top + tt_height;\n\t\tif (pt_cursor.x >= ttw.left && pt_cursor.x <= ttw.right && pt_cursor.y >= ttw.top && pt_cursor.y <= ttw.bottom)\n\t\t{\n\t\t\t// Push the tool tip to the upper-left side, since normally the only way the cursor can\n\t\t\t// be inside its boundaries (when one_or_both_coords_unspecified == true) is when the\n\t\t\t// cursor is near the bottom right corner of the screen.\n\t\t\tpt.x = pt_cursor.x - tt_width - 3; // Use a small offset since it can't overlap the cursor\n\t\t\tpt.y = pt_cursor.y - tt_height - 3; // when pushed to the the upper-left side of it.\n\t\t}\n\t}\n\n\t// These messages seem to cause a complete update of the tooltip, which is slow and causes flickering.\n\t// It is tempting to use SetWindowPos() instead to speed things up, but if TTM_TRACKPOSITION isn't\n\t// sent each time, the next TTM_UPDATETIPTEXT message will move it back to whatever position was set\n\t// with TTM_TRACKPOSITION last.\n\tSendMessage(tip_hwnd, TTM_TRACKPOSITION, 0, (LPARAM)MAKELONG(pt.x, pt.y));\n\t// And do a TTM_TRACKACTIVATE even if the tooltip window already existed upon entry to this function,\n\t// so that in case it was hidden or dismissed while its HWND still exists, it will be shown again:\n\tSendMessage(tip_hwnd, TTM_TRACKACTIVATE, TRUE, (LPARAM)&ti);\n\taRetVal = (UINT)(UINT_PTR)tip_hwnd;\n\treturn OK;\n}\n\n\n\n///////////////////\n// Misc internal //\n///////////////////\n\nVOID CALLBACK DerefTimeout(HWND hWnd, UINT uMsg, UINT_PTR idEvent, DWORD dwTime)\n{\n\tLine::FreeDerefBufIfLarge(); // It will also kill the timer, if appropriate.\n}\n\n\n\n/////////////////\n// MouseGetPos //\n/////////////////\n\nbif_impl FResult MouseGetPos(int *aX, int *aY, ResultToken *aParent, ResultToken *aChild, optl<int> aFlag)\n{\n\tPOINT point;\n\tif (!GetCursorPos(&point)) // fails when locked or sleeping\n\t\treturn FR_E_WIN32;\n\n\tPOINT origin = {0};\n\tCoordToScreen(origin, COORD_MODE_MOUSE);\n\n\tif (aX) *aX = point.x - origin.x;\n\tif (aY) *aY = point.y - origin.y;\n\n\tif (!aParent && !aChild)\n\t\treturn OK;\n\n\tint aOptions = aFlag.value_or(0);\n\n\t// This is the child window. Despite what MSDN says, WindowFromPoint() appears to fetch\n\t// a non-NULL value even when the mouse is hovering over a disabled control (at least on XP).\n\tHWND child_under_cursor = WindowFromPoint(point);\n\tif (!child_under_cursor)\n\t\treturn OK;\n\n\tHWND parent_under_cursor = GetNonChildParent(child_under_cursor); // Find the first ancestor that isn't a child.\n\tif (aParent)\n\t{\n\t\t// Testing reveals that an invisible parent window never obscures another window beneath it as seen by\n\t\t// WindowFromPoint(). In other words, the below never happens, so there's no point in having it as a\n\t\t// documented feature:\n\t\t//if (!g->DetectHiddenWindows && !IsWindowVisible(parent_under_cursor))\n\t\t//\treturn output_var_parent->Assign();\n\t\taParent->SetValue((UINT_PTR)parent_under_cursor);\n\t}\n\n\tif (!aChild)\n\t\treturn OK;\n\n\t// Doing it this way overcomes the limitations of WindowFromPoint() and ChildWindowFromPoint()\n\t// and also better matches the control that Window Spy would think is under the cursor:\n\tif (!(aOptions & 0x01)) // Not in simple mode, so find the control the normal/complex way.\n\t{\n\t\tpoint_and_hwnd_type pah = {0};\n\t\tpah.pt = point;\n\t\tEnumChildWindows(parent_under_cursor, EnumChildFindPoint, (LPARAM)&pah); // Find topmost control containing point.\n\t\tif (pah.hwnd_found)\n\t\t\tchild_under_cursor = pah.hwnd_found;\n\t}\n\t//else as of v1.0.25.10, leave child_under_cursor set the the value retrieved earlier from WindowFromPoint().\n\t// This allows MDI child windows to be reported correctly; i.e. that the window on top of the others\n\t// is reported rather than the one at the top of the z-order (the z-order of MDI child windows,\n\t// although probably constant, is not useful for determine which one is one top of the others).\n\n\tif (parent_under_cursor == child_under_cursor) // if there's no control per se, make it blank.\n\t\treturn OK;\n\n\tif (aOptions & 0x02) // v1.0.43.06: Bitwise flag that means \"return control's HWND vs. ClassNN\".\n\t{\n\t\taChild->SetValue((UINT_PTR)child_under_cursor);\n\t\treturn OK;\n\t}\n\n\tTCHAR class_nn[WINDOW_CLASS_NN_SIZE];\n\tauto fr = ControlGetClassNN(parent_under_cursor, child_under_cursor, class_nn, _countof(class_nn));\n\tif (fr != OK)\n\t\treturn fr;\n\tif (!TokenSetResult(*aChild, class_nn))\n\t\treturn aChild->Exited() ? FR_FAIL : FR_ABORTED;\n\treturn OK;\n}\n\n\n\nBOOL CALLBACK EnumChildFindPoint(HWND aWnd, LPARAM lParam)\n// This is called by more than one caller. It finds the most appropriate child window that contains\n// the specified point (the point should be in screen coordinates).\n{\n\tpoint_and_hwnd_type &pah = *(point_and_hwnd_type *)lParam; // For performance and convenience.\n\tif (!IsWindowVisible(aWnd) // Omit hidden controls, like Window Spy does.\n\t\t|| (pah.ignore_disabled_controls && !IsWindowEnabled(aWnd))) // For ControlClick, also omit disabled controls, since testing shows that the OS doesn't post mouse messages to them.\n\t\treturn TRUE;\n\tRECT rect;\n\tif (!GetWindowRect(aWnd, &rect))\n\t\treturn TRUE;\n\t// The given point must be inside aWnd's bounds. Then, if there is no hwnd found yet or if aWnd\n\t// is entirely contained within the previously found hwnd, update to a \"better\" found window like\n\t// Window Spy. This overcomes the limitations of WindowFromPoint() and ChildWindowFromPoint().\n\t// The pixel at (left, top) lies inside the control, whereas MSDN says \"the pixel at (right, bottom)\n\t// lies immediately outside the rectangle\" -- so use < instead of <= below:\n\tif (pah.pt.x >= rect.left && pah.pt.x < rect.right && pah.pt.y >= rect.top && pah.pt.y < rect.bottom)\n\t{\n\t\t// If the window's center is closer to the given point, break the tie and have it take\n\t\t// precedence. This solves the problem where a particular control from a set of overlapping\n\t\t// controls is chosen arbitrarily (based on Z-order) rather than based on something the\n\t\t// user would find more intuitive (the control whose center is closest to the mouse):\n\t\tdouble center_x = rect.left + (double)(rect.right - rect.left) / 2;\n\t\tdouble center_y = rect.top + (double)(rect.bottom - rect.top) / 2;\n\t\t// Taking the absolute value first is not necessary because it seems that qmathHypot()\n\t\t// takes the square root of the sum of the squares, which handles negatives correctly:\n\t\tdouble distance = qmathHypot(pah.pt.x - center_x, pah.pt.y - center_y);\n\t\t//double distance = qmathSqrt(qmathPow(pah.pt.x - center_x, 2) + qmathPow(pah.pt.y - center_y, 2));\n\t\tbool update_it = !pah.hwnd_found;\n\t\tif (!update_it)\n\t\t{\n\t\t\t// If the new window's rect is entirely contained within the old found-window's rect, update\n\t\t\t// even if the distance is greater. Conversely, if the new window's rect entirely encloses\n\t\t\t// the old window's rect, do not update even if the distance is less:\n\t\t\tif (rect.left >= pah.rect_found.left && rect.right <= pah.rect_found.right\n\t\t\t\t&& rect.top >= pah.rect_found.top && rect.bottom <= pah.rect_found.bottom)\n\t\t\t\tupdate_it = true; // New is entirely enclosed by old: update to the New.\n\t\t\telse if ( distance < pah.distance &&\n\t\t\t\t(pah.rect_found.left < rect.left || pah.rect_found.right > rect.right\n\t\t\t\t\t|| pah.rect_found.top < rect.top || pah.rect_found.bottom > rect.bottom) )\n\t\t\t\tupdate_it = true; // New doesn't entirely enclose old and new's center is closer to the point.\n\t\t}\n\t\tif (update_it)\n\t\t{\n\t\t\tpah.hwnd_found = aWnd;\n\t\t\tpah.rect_found = rect; // And at least one caller uses this returned rect.\n\t\t\tpah.distance = distance;\n\t\t}\n\t}\n\treturn TRUE; // Continue enumeration all the way through.\n}\n\n\n\n///////////////////////\n// Working Directory //\n///////////////////////\n\n\nFResult SetWorkingDir(LPCTSTR aNewDir)\n// This function was added in v1.0.45.01 for the reason described below.\n{\n\t// v1.0.45.01: Since A_ScriptDir omits the trailing backslash for roots of drives (such as C:),\n\t// and since that variable probably shouldn't be changed for backward compatibility, provide\n\t// the missing backslash to allow SetWorkingDir %A_ScriptDir% (and others) to work as expected\n\t// in the root of a drive.\n\t// Update in 2018: The reason it wouldn't by default is that \"C:\" is actually a reference to the\n\t// the current directory if it's on C: drive, otherwise a reference to the path contained by the\n\t// env var \"=C:\". Similarly, \"C:x\" is a reference to \"x\" inside that directory.\n\t// For details, see https://blogs.msdn.microsoft.com/oldnewthing/20100506-00/?p=14133\n\t// Although the override here creates inconsistency between SetWorkingDir and everything else\n\t// that can accept \"C:\", it is most likely what the user wants, and now there's also backward-\n\t// compatibility to consider since this workaround has been in place since 2006.\n\t// v1.1.31.00: Add the slash up-front instead of attempting SetCurrentDirectory(_T(\"C:\"))\n\t// and comparing the result, since the comparison would always yield \"not equal\" due to either\n\t// a trailing slash or the directory being incorrect.\n\tTCHAR drive_buf[4];\n\tif (aNewDir[0] && aNewDir[1] == ':' && !aNewDir[2])\n\t{\n\t\tdrive_buf[0] = aNewDir[0];\n\t\tdrive_buf[1] = aNewDir[1];\n\t\tdrive_buf[2] = '\\\\';\n\t\tdrive_buf[3] = '\\0';\n\t\taNewDir = drive_buf;\n\t}\n\n\tif (!SetCurrentDirectory(aNewDir)) // Caused by nonexistent directory, permission denied, etc.\n\t\treturn FR_E_WIN32;\n\t// Otherwise, the change to the working directory succeeded.\n\n\t// Other than during program startup, this should be the only place where the official\n\t// working dir can change. The exception is FileSelect(), which changes the working\n\t// dir as the user navigates from folder to folder. However, the whole purpose of\n\t// maintaining g_WorkingDir is to workaround that very issue.\n\tif (g_script.mIsReadyToExecute) // Callers want this done only during script runtime.\n\t\tUpdateWorkingDir(aNewDir);\n\treturn OK;\n}\n\n\n\nvoid UpdateWorkingDir(LPCTSTR aNewDir)\n// aNewDir is NULL or a path which was just passed to SetCurrentDirectory().\n{\n\tTCHAR buf[T_MAX_PATH]; // Windows 10 long path awareness enables working dir to exceed MAX_PATH.\n\t// GetCurrentDirectory() is called explicitly, in case aNewDir is a relative path.\n\t// We want to store the absolute path:\n\tif (GetCurrentDirectory(_countof(buf), buf)) // Might never fail in this case, but kept for backward compatibility.\n\t\taNewDir = buf;\n\tif (aNewDir)\n\t\tg_WorkingDir.SetString(aNewDir);\n}\n\n\n\nLPTSTR GetWorkingDir()\n// Allocate a copy of the working directory from the heap. This is used to support long\n// paths without adding 64KB of stack usage per recursive #include <> on Unicode builds.\n{\n\tTCHAR buf[T_MAX_PATH];\n\tif (GetCurrentDirectory(_countof(buf), buf))\n\t\treturn _tcsdup(buf);\n\treturn NULL;\n}\n\n\n\n/////////////////////////////\n// GUI-related: FileSelect //\n/////////////////////////////\n\nbif_impl FResult FileSelect(optl<StrArg> aOptions, optl<StrArg> aWorkingDir, optl<StrArg> aGreeting\n\t, optl<StrArg> aFilter, ResultToken &aResultToken)\n// Since other script threads can interrupt this command while it's running, it's important that\n// this command not refer to sArgDeref[] and sArgVar[] anytime after an interruption becomes possible.\n// This is because an interrupting thread usually changes the values to something inappropriate for this thread.\n{\n\tif (g_nFileDialogs >= MAX_FILEDIALOGS)\n\t{\n\t\t// Have a maximum to help prevent runaway hotkeys due to key-repeat feature, etc.\n\t\treturn FError(_T(\"The maximum number of File Dialogs has been reached.\"));\n\t}\n\t\n\tLPCTSTR default_file_name = _T(\"\");\n\tLPCTSTR initial_dir = nullptr;\n\tif (aWorkingDir.has_nonempty_value())\n\t{\n\t\tLPCTSTR dir_and_name = aWorkingDir.value();\n\t\tsize_t initial_dir_length = 0;\n\t\tDWORD attr = GetFileAttributes(dir_and_name);\n\t\tif ((attr != 0xFFFFFFFF) && (attr & FILE_ATTRIBUTE_DIRECTORY))\n\t\t{\n\t\t\t// Use the entire dir_and_name as the initial directory.\n\t\t\tinitial_dir = dir_and_name;\n\t\t\tinitial_dir_length = _tcslen(dir_and_name);\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Above condition indicates it's either an existing file that's not a folder, or a nonexistent\n\t\t\t// folder/filename. In either case, it seems best to assume it's a file because the user may want\n\t\t\t// to provide a default SAVE filename, and it would be normal for such a file not to already exist.\n\t\t\tLPCTSTR last_backslash = _tcsrchr(dir_and_name, '\\\\');\n\t\t\tif (!last_backslash)\n\t\t\t{\n\t\t\t\t// Use the entire dir_and_name as the default filename.\n\t\t\t\tdefault_file_name = dir_and_name;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tdefault_file_name = last_backslash + 1;\n\t\t\t\tinitial_dir = dir_and_name;\n\t\t\t\tinitial_dir_length = last_backslash - dir_and_name;\n\t\t\t}\n\t\t}\n\t\tif (initial_dir && initial_dir[initial_dir_length]) // Null termination required.\n\t\t{\n\t\t\tif (initial_dir_length < T_MAX_PATH) // Avoid stack overflow in case of bad data; anything longer wouldn't work anyway.\n\t\t\t{\n\t\t\t\tLPTSTR buf = (LPTSTR)_alloca(sizeof(TCHAR) * (initial_dir_length + 1));\n\t\t\t\tinitial_dir = tmemcpy(buf, initial_dir, initial_dir_length);\n\t\t\t\tbuf[initial_dir_length] = '\\0';\n\t\t\t}\n\t\t\telse\n\t\t\t\tinitial_dir = NULL;\n\t\t}\n\t}\n\n\tTCHAR pattern[1024];\n\t*pattern = '\\0'; // Set default.\n\tif (aFilter.has_nonempty_value())\n\t{\n\t\tauto pattern_start = _tcschr(aFilter.value(), '(');\n\t\tif (pattern_start)\n\t\t{\n\t\t\t// Make pattern a separate string because we want to remove any spaces from it.\n\t\t\t// For example, if the user specified Documents (*.txt; *.doc), the space after\n\t\t\t// the semicolon should be removed for the pattern string itself but not from\n\t\t\t// the displayed version of the pattern:\n\t\t\ttcslcpy(pattern, ++pattern_start, _countof(pattern));\n\t\t\tLPTSTR pattern_end = _tcsrchr(pattern, ')'); // strrchr() in case there are other literal parentheses.\n\t\t\tif (pattern_end)\n\t\t\t\t*pattern_end = '\\0'; // If parentheses are empty, this will set pattern to be the empty string.\n\t\t}\n\t\telse // No open-paren, so assume the entire string is the filter.\n\t\t\ttcslcpy(pattern, aFilter.value(), _countof(pattern));\n\t}\n\tUINT filter_count = 0;\n\tCOMDLG_FILTERSPEC filters[2];\n\tif (*pattern) // aFilter was not omitted or blank.\n\t{\n\t\t// Remove any spaces present in the pattern, such as a space after every semicolon\n\t\t// that separates the allowed file extensions. The API docs specify that there\n\t\t// should be no spaces in the pattern itself, even though it's okay if they exist\n\t\t// in the displayed name of the file-type:\n\t\t// Update by Lexikos: Don't remove spaces, since that gives incorrect behaviour for more\n\t\t// complex patterns like \"prefix *.ext\" (where the space should be considered part of the\n\t\t// pattern). Although the docs for OPENFILENAMEW say \"Do not include spaces\", it may be\n\t\t// just because spaces are considered part of the pattern. On the other hand, the docs\n\t\t// relating to IFileDialog::SetFileTypes() say nothing about spaces; and in fact, using a\n\t\t// pattern like \"*.cpp; *.h\" will work correctly (possibly due to how leading spaces work\n\t\t// with the file system).\n\t\t//StrReplace(pattern, _T(\" \"), _T(\"\"), SCS_SENSITIVE);\n\t\tfilters[0].pszName = aFilter.value();\n\t\tfilters[0].pszSpec = pattern;\n\t\t++filter_count;\n\t}\n\t// Always include the All Files (*.*) filter, since there doesn't seem to be much\n\t// point to making this an option. This is because the user could always type\n\t// *.* (or *) and press ENTER in the filename field and achieve the same result:\n\tfilters[filter_count].pszName = _T(\"All Files (*.*)\");\n\tfilters[filter_count].pszSpec = _T(\"*.*\");\n\t++filter_count;\n\n\t// v1.0.43.09: OFN_NODEREFERENCELINKS is now omitted by default because most people probably want a click\n\t// on a shortcut to navigate to the shortcut's target rather than select the shortcut and end the dialog.\n\t// v2: Testing on Windows 7 and 10 indicated IFileDialog doesn't change the working directory while the\n\t// user navigates, unlike GetOpenFileName/GetSaveFileName, and doesn't appear to affect the CWD at all.\n\tDWORD flags = FOS_NOCHANGEDIR; // FOS_NOCHANGEDIR according to MS: \"Don't change the current working directory.\"\n\n\t// For v1.0.25.05, the new \"M\" letter is used for a new multi-select method since the old multi-select\n\t// is faulty in the following ways:\n\t// 1) If the user selects a single file in a multi-select dialog, the result is inconsistent: it\n\t// contains the full path and name of that single file rather than the folder followed by the\n\t// single file name as most users would expect. To make matters worse, it includes a linefeed\n\t// after that full path in name, which makes it difficult for a script to determine whether\n\t// only a single file was selected.\n\t// 2) The last item in the list is terminated by a linefeed, which is not as easily used with a\n\t// parsing loop as shown in example in the help file.\n\tbool always_use_save_dialog = false; // Set default.\n\tauto options_str = aOptions.value_or_empty();\n\tswitch (ctoupper(*options_str))\n\t{\n\tcase 'D':\n\t\t++options_str;\n\t\tflags |= FOS_PICKFOLDERS;\n\t\tif (*pattern)\n\t\t\treturn FR_E_ARG(3);\n\t\tfilter_count = 0;\n\t\tbreak;\n\tcase 'M': // Multi-select.\n\t\t++options_str;\n\t\tflags |= FOS_ALLOWMULTISELECT;\n\t\tbreak;\n\tcase 'S': // Have a \"Save\" button rather than an \"Open\" button.\n\t\t++options_str;\n\t\talways_use_save_dialog = true;\n\t\tbreak;\n\t}\n\n\tTCHAR greeting[1024];\n\tif (aGreeting.has_nonempty_value())\n\t\ttcslcpy(greeting, aGreeting.value(), _countof(greeting));\n\telse\n\t\t// Use a more specific title so that the dialogs of different scripts can be distinguished\n\t\t// from one another, which may help script automation in rare cases:\n\t\tsntprintf(greeting, _countof(greeting), _T(\"Select %s - %s\")\n\t\t\t, (flags & FOS_PICKFOLDERS) ? _T(\"Folder\") : _T(\"File\"), g_script.DefaultDialogTitle());\n\n\tint options = ATOI(options_str);\n\tif (options & 0x20)\n\t\tflags |= FOS_NODEREFERENCELINKS;\n\tif (options & 0x10)\n\t\tflags |= FOS_OVERWRITEPROMPT;\n\tif (options & 0x08)\n\t\tflags |= FOS_CREATEPROMPT;\n\tif (options & 0x02)\n\t\tflags |= FOS_PATHMUSTEXIST;\n\tif (options & 0x01)\n\t\tflags |= FOS_FILEMUSTEXIST;\n\n\n\t// Despite old documentation indicating it was due to an \"OS quirk\", previous versions were specifically\n\t// designed to enable the Save button when OFN_OVERWRITEPROMPT is present but not OFN_CREATEPROMPT, since\n\t// the former requires the Save dialog while the latter requires the Open dialog. If both options are\n\t// present, the caller must specify or omit 'S' to choose the dialog type, and one option has no effect.\n\tif ((flags & FOS_OVERWRITEPROMPT) && !(flags & (FOS_CREATEPROMPT | FOS_PICKFOLDERS)))\n\t\talways_use_save_dialog = true;\n\n\tIFileDialog *pfd = NULL;\n\tHRESULT hr = CoCreateInstance(always_use_save_dialog ? CLSID_FileSaveDialog : CLSID_FileOpenDialog,\n\t\tNULL, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&pfd));\n\tif (FAILED(hr))\n\t\treturn hr;\n\n\tpfd->SetOptions(flags);\n\tpfd->SetTitle(greeting);\n\tif (filter_count)\n\t\tpfd->SetFileTypes(filter_count, filters);\n\tpfd->SetFileName(default_file_name);\n\n\tif (initial_dir)\n\t{\n\t\tIShellItem *psi;\n\t\tif (SUCCEEDED(SHCreateItemFromParsingName(initial_dir, nullptr, IID_PPV_ARGS(&psi))))\n\t\t{\n\t\t\tpfd->SetFolder(psi);\n\t\t\tpsi->Release();\n\t\t}\n\t}\n\n\t// At this point, we know a dialog will be displayed. See macro's comments for details:\n\tDIALOG_PREP\n\tPOST_AHK_DIALOG(0) // Do this only after the above. Must pass 0 for timeout in this case.\n\t++g_nFileDialogs;\n\tauto result = pfd->Show(THREAD_DIALOG_OWNER);\n\t--g_nFileDialogs;\n\tDIALOG_END\n\n\tif (flags & FOS_ALLOWMULTISELECT)\n\t{\n\t\tauto *files = Array::Create();\n\t\tIFileOpenDialog *pfod;\n\t\tif (SUCCEEDED(result) && SUCCEEDED(pfd->QueryInterface(&pfod)))\n\t\t{\n\t\t\tIShellItemArray *penum;\n\t\t\tif (SUCCEEDED(pfod->GetResults(&penum)))\n\t\t\t{\n\t\t\t\tDWORD count = 0;\n\t\t\t\tpenum->GetCount(&count);\n\t\t\t\tfor (DWORD i = 0; i < count; ++i)\n\t\t\t\t{\n\t\t\t\t\tIShellItem *psi;\n\t\t\t\t\tif (SUCCEEDED(penum->GetItemAt(i, &psi)))\n\t\t\t\t\t{\n\t\t\t\t\t\tLPWSTR filename;\n\t\t\t\t\t\tif (SUCCEEDED(psi->GetDisplayName(SIGDN_FILESYSPATH, &filename)))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tfiles->Append(filename);\n\t\t\t\t\t\t\tCoTaskMemFree(filename);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tpsi->Release();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tpenum->Release();\n\t\t\t}\n\t\t\tpfod->Release();\n\t\t}\n\t\tpfd->Release();\n\t\taResultToken.Return(files);\n\t\treturn OK;\n\t}\n\t\n\taResultToken.SetValue(_T(\"\"), 0); // Set default.\n\tIShellItem *psi;\n\tif (SUCCEEDED(result) && SUCCEEDED(pfd->GetResult(&psi)))\n\t{\n\t\tLPWSTR filename;\n\t\tif (SUCCEEDED(psi->GetDisplayName(SIGDN_FILESYSPATH, &filename)))\n\t\t{\n\t\t\taResultToken.Return(filename);\n\t\t\tCoTaskMemFree(filename);\n\t\t}\n\t\tpsi->Release();\n\t}\n\t//else: User pressed CANCEL vs. OK to dismiss the dialog or there was a problem displaying it.\n\tpfd->Release();\n\treturn result == HRESULT_FROM_WIN32(ERROR_CANCELLED) ? OK : result;\n}\n\n\n\n////////////////////////\n// Keyboard Functions //\n////////////////////////\n\nFResult SetToggleState(vk_type aVK, ToggleValueType &ForceLock, optl<StrArg> aToggleText)\n{\n\tToggleValueType toggle = Line::ConvertOnOffAlways(aToggleText.value_or_null(), NEUTRAL);\n\tswitch (toggle)\n\t{\n\tcase TOGGLED_ON:\n\tcase TOGGLED_OFF:\n\t\t// Turning it on or off overrides any prior AlwaysOn or AlwaysOff setting.\n\t\t// Probably need to change the setting BEFORE attempting to toggle the\n\t\t// key state, otherwise the hook may prevent the state from being changed\n\t\t// if it was set to be AlwaysOn or AlwaysOff:\n\t\tForceLock = NEUTRAL;\n\t\tToggleKeyState(aVK, toggle);\n\t\tbreak;\n\tcase ALWAYS_ON:\n\tcase ALWAYS_OFF:\n\t\tForceLock = (toggle == ALWAYS_ON) ? TOGGLED_ON : TOGGLED_OFF; // Must do this first.\n\t\tToggleKeyState(aVK, ForceLock);\n\t\t// The hook is currently needed to support keeping these keys AlwaysOn or AlwaysOff, though\n\t\t// there may be better ways to do it (such as registering them as a hotkey, but\n\t\t// that may introduce quite a bit of complexity):\n\t\tHotkey::InstallKeybdHook();\n\t\tbreak;\n\tcase NEUTRAL:\n\t\t// Note: No attempt is made to detect whether the keybd hook should be deinstalled\n\t\t// because it's no longer needed due to this change. That would require some \n\t\t// careful thought about the impact on the status variables in the Hotkey class, etc.,\n\t\t// so it can be left for a future enhancement:\n\t\tForceLock = NEUTRAL;\n\t\tbreak;\n\tdefault:\n\t\treturn FR_E_ARG(0);\n\t}\n\treturn OK;\n}\n\n\n\n////////////////////////////////\n// Misc lower level functions //\n////////////////////////////////\n\n\nResultType GetObjectIntProperty(IObject *aObject, LPTSTR aPropName, __int64 &aValue, ResultToken &aResultToken, bool aOptional)\n{\n\tFuncResult result_token;\n\tExprTokenType this_token = aObject;\n\n\tauto result = aObject->Invoke(result_token, IT_GET, aPropName, this_token, nullptr, 0);\n\n\tif (result_token.symbol != SYM_INTEGER)\n\t{\n\t\tresult_token.Free();\n\t\tif (result == FAIL || result == EARLY_EXIT)\n\t\t{\n\t\t\taResultToken.SetExitResult(result);\n\t\t\treturn FAIL;\n\t\t}\n\t\tif (result != INVOKE_NOT_HANDLED) // Property exists but is not an integer.\n\t\t\treturn aResultToken.Error(ERR_TYPE_MISMATCH, aPropName, ErrorPrototype::Type);\n\t\t//aValue = 0; // Caller should set default value for these cases.\n\t\tif (!aOptional)\n\t\t\treturn aResultToken.UnknownMemberError(ExprTokenType(aObject), IT_GET, aPropName);\n\t\treturn result; // Let caller know it wasn't found.\n\t}\n\n\taValue = result_token.value_int64;\n\treturn OK;\n}\n\nResultType SetObjectIntProperty(IObject *aObject, LPTSTR aPropName, __int64 aValue, ResultToken &aResultToken)\n{\n\tFuncResult result_token;\n\tExprTokenType this_token = aObject, value_token = aValue, *param = &value_token;\n\n\tauto result = aObject->Invoke(result_token, IT_SET, aPropName, this_token, ¶m, 1);\n\n\tresult_token.Free();\n\tif (result == FAIL || result == EARLY_EXIT)\n\t\treturn aResultToken.SetExitResult(result);\n\tif (result == INVOKE_NOT_HANDLED)\n\t\treturn aResultToken.UnknownMemberError(ExprTokenType(aObject), IT_GET, aPropName);\n\treturn OK;\n}\n\nResultType GetObjectPtrProperty(IObject *aObject, LPTSTR aPropName, UINT_PTR &aPtr, ResultToken &aResultToken, bool aOptional)\n{\n\t__int64 value = NULL;\n\tauto result = GetObjectIntProperty(aObject, aPropName, value, aResultToken, aOptional);\n\taPtr = (UINT_PTR)value;\n\treturn result;\n}\n\n\n\nbool Line::FileIsFilteredOut(LoopFilesStruct &aCurrentFile, FileLoopModeType aFileLoopMode)\n{\n\tif (aCurrentFile.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) // It's a folder.\n\t{\n\t\tif (aFileLoopMode == FILE_LOOP_FILES_ONLY\n\t\t\t|| aCurrentFile.cFileName[0] == '.' && (!aCurrentFile.cFileName[1] // Relies on short-circuit boolean order.\n\t\t\t\t|| aCurrentFile.cFileName[1] == '.' && !aCurrentFile.cFileName[2])) //\n\t\t\treturn true; // Exclude this folder by returning true.\n\t}\n\telse // it's not a folder.\n\t\tif (aFileLoopMode == FILE_LOOP_FOLDERS_ONLY)\n\t\t\treturn true; // Exclude this file by returning true.\n\n\t// Since file was found, also append the file's name to its directory for the caller:\n\t// Seems best to check length in advance because it allows a faster move/copy method further below\n\t// (in lieu of sntprintf(), which is probably quite a bit slower than the method here).\n\tsize_t name_length = _tcslen(aCurrentFile.cFileName);\n\tif (aCurrentFile.dir_length + name_length >= _countof(aCurrentFile.file_path)) // Should be impossible with current buffer sizes.\n\t\treturn true; // Exclude this file/folder.\n\ttmemcpy(aCurrentFile.file_path + aCurrentFile.dir_length, aCurrentFile.cFileName, name_length + 1); // +1 to include the terminator.\n\taCurrentFile.file_path_length = aCurrentFile.dir_length + name_length;\n\treturn false; // Indicate that this file is not to be filtered out.\n}\n\n\n\nLabel *Line::GetJumpTarget(bool aIsDereferenced)\n{\n\tLPTSTR target_label = aIsDereferenced ? ARG1 : RAW_ARG1;\n\tLabel *label = g_script.FindLabel(target_label);\n\tif (!label)\n\t{\n\t\tLineError(ERR_NO_LABEL, FAIL, target_label);\n\t\treturn NULL;\n\t}\n\t// If g->CurrentFunc, label is never outside the function since it would not\n\t// have been found by FindLabel(). So there's no need to check for that here.\n\tif (!aIsDereferenced)\n\t\tmRelatedLine = (Line *)label; // The script loader has ensured that label->mJumpToLine isn't NULL.\n\t// else don't update it, because that would permanently resolve the jump target, and we want it to stay dynamic.\n\treturn IsJumpValid(*label);\n\t// Any error msg was already displayed by the above call.\n}\n\n\n\nLabel *Line::IsJumpValid(Label &aTargetLabel, bool aSilent)\n// Returns aTargetLabel is the jump is valid, or NULL otherwise.\n{\n\t// aTargetLabel can be NULL if this Goto's target is the physical end of the script.\n\t// And such a destination is always valid, regardless of where aOrigin is.\n\t// UPDATE: It's no longer possible for the destination of a Goto to be\n\t// NULL because the script loader has ensured that the end of the script always has\n\t// an extra ACT_EXIT that serves as an anchor for any final labels in the script:\n\t//if (aTargetLabel == NULL)\n\t//\treturn OK;\n\t// The above check is also necessary to avoid dereferencing a NULL pointer below.\n\n\tif (!CheckValidFinallyJump(aTargetLabel.mJumpToLine, aSilent))\n\t\treturn NULL;\n\n\tLine *parent_line_of_label_line;\n\tif ( !(parent_line_of_label_line = aTargetLabel.mJumpToLine->mParentLine) )\n\t\t// A Goto can always jump to a point anywhere in the outermost layer\n\t\t// (i.e. outside all blocks) without restriction (except from inside a\n\t\t// function to outside, but in that case the label would not be found):\n\t\treturn &aTargetLabel; // Indicate success.\n\n\t// So now we know this Goto is attempting to jump into a block somewhere. Is that\n\t// block a legal place to jump?:\n\n\tfor (Line *ancestor = mParentLine; ancestor != NULL; ancestor = ancestor->mParentLine)\n\t\tif (parent_line_of_label_line == ancestor)\n\t\t\t// Since aTargetLabel is in the same block as the Goto line itself (or a block\n\t\t\t// that encloses that block), it's allowed:\n\t\t\treturn &aTargetLabel; // Indicate success.\n\t// This can happen if the Goto's target is at a deeper level than it, or if the target\n\t// is at a more shallow level but is in some block totally unrelated to it!\n\t// Returns FAIL by default, which is what we want because that value is zero:\n\tif (!aSilent)\n\t\tLineError(_T(\"A Goto must not jump into a block that doesn't enclose it.\"));\n\treturn NULL;\n}\n\n\nBOOL Line::CheckValidFinallyJump(Line* jumpTarget, bool aSilent)\n{\n\tLine* jumpParent = jumpTarget->mParentLine;\n\tfor (Line *ancestor = mParentLine; ancestor != NULL; ancestor = ancestor->mParentLine)\n\t{\n\t\tif (ancestor == jumpParent)\n\t\t\treturn TRUE; // We found the common ancestor.\n\t\tif (ancestor->mActionType == ACT_FINALLY)\n\t\t{\n\t\t\tif (!aSilent)\n\t\t\t\tLineError(ERR_BAD_JUMP_INSIDE_FINALLY);\n\t\t\treturn FALSE; // The common ancestor is outside the FINALLY block and thus this jump is invalid.\n\t\t}\n\t}\n\treturn TRUE; // The common ancestor is the root of the script.\n}\n\n\n////////////////////\n// Misc Functions //\n////////////////////\n\n\nbif_impl void Persistent(optl<BOOL> aNewValue, BOOL &aOldValue)\n{\n\t// Returning the old value might have some use, but if the caller doesn't want its value to change,\n\t// something awkward like \"Persistent(isPersistent := Persistent())\" is needed. Rather than just\n\t// returning the current status, Persistent() makes the script persistent because that's likely to\n\t// be its most common use by far, and it's what users familiar with the old #Persistent may expect.\n\taOldValue = g_persistent;\n\tg_persistent = aNewValue.value_or(TRUE);\n}\n\n\n\nstatic void InstallHook(optl<BOOL> aInstalling, optl<BOOL> aUseForce, HookType which_hook)\n{\n\tbool installing = aInstalling.value_or(true);\n\tbool use_force = aUseForce.value_or(false);\n\t// When the second parameter is true, unconditionally remove the hook. If the first parameter is\n\t// also true, the hook will be reinstalled fresh. Otherwise the hook will be left uninstalled,\n\t// until something happens to reinstall it, such as Hotkey::ManifestAllHotkeysHotstringsHooks().\n\tif (use_force)\n\t\tAddRemoveHooks(GetActiveHooks() & ~which_hook);\n\tHotkey::RequireHook(which_hook, installing);\n\tif (!use_force || installing)\n\t\tHotkey::ManifestAllHotkeysHotstringsHooks();\n}\n\nbif_impl void InstallKeybdHook(optl<BOOL> aInstalling, optl<BOOL> aUseForce)\n{\n\tInstallHook(aInstalling, aUseForce, HOOK_KEYBD);\n}\n\nbif_impl void InstallMouseHook(optl<BOOL> aInstalling, optl<BOOL> aUseForce)\n{\n\tInstallHook(aInstalling, aUseForce, HOOK_MOUSE);\n}\n\n\n\n////////////////////\n// Core Functions //\n////////////////////\n\n\nvoid ObjectToString(ResultToken &aResultToken, ExprTokenType &aThisToken, IObject *aObject)\n{\n\t// Something like this should be done for every TokenToString() call or\n\t// equivalent, but major changes are needed before that will be feasible.\n\t// For now, String(anytype) provides a limited workaround.\n\tswitch (aObject->Invoke(aResultToken, IT_CALL, _T(\"ToString\"), aThisToken, nullptr, 0))\n\t{\n\tcase INVOKE_NOT_HANDLED:\n\t\taResultToken.UnknownMemberError(aThisToken, IT_CALL, _T(\"ToString\"));\n\t\tbreak;\n\tcase FAIL:\n\t\taResultToken.SetExitResult(FAIL);\n\t\tbreak;\n\t}\n}\n\nBIF_DECL(BIF_String)\n{\n\t++aParam; // Skip `this`\n\taResultToken.symbol = SYM_STRING;\n\tswitch (aParam[0]->symbol)\n\t{\n\tcase SYM_STRING:\n\t\taResultToken.marker = aParam[0]->marker;\n\t\taResultToken.marker_length = aParam[0]->marker_length;\n\t\tbreak;\n\tcase SYM_VAR:\n\t\tif (aParam[0]->var->HasObject())\n\t\t{\n\t\t\tObjectToString(aResultToken, *aParam[0], aParam[0]->var->Object());\n\t\t\tbreak;\n\t\t}\n\t\taResultToken.marker = aParam[0]->var->Contents();\n\t\taResultToken.marker_length = aParam[0]->var->CharLength();\n\t\tbreak;\n\tcase SYM_INTEGER:\n\t\taResultToken.marker = ITOA64(aParam[0]->value_int64, _f_retval_buf);\n\t\tbreak;\n\tcase SYM_FLOAT:\n\t\taResultToken.marker = _f_retval_buf;\n\t\taResultToken.marker_length = FTOA(aParam[0]->value_double, aResultToken.marker, _f_retval_buf_size);\n\t\tbreak;\n\tcase SYM_OBJECT:\n\t\tObjectToString(aResultToken, *aParam[0], aParam[0]->object);\n\t\tbreak;\n\t// Impossible due to parameter count validation:\n\t//case SYM_MISSING:\n\t//\t_f_throw_value(ERR_PARAM1_REQUIRED);\n#ifdef _DEBUG\n\tdefault:\n\t\tMsgBox(_T(\"DEBUG: type not handled\"));\n\t\t_f_return_FAIL;\n#endif\n\t}\n}\n\n\n\n////////////////////\n// Core Functions //\n////////////////////\n\n\nbif_impl BOOL IsLabel(StrArg aName)\n{\n\treturn g_script.FindLabel(aName) ? 1 : 0;\n}\n\n\n\nBIF_DECL(BIF_IsTypeish)\n{\n\tauto variable_type = (VariableTypeType)_f_callee_id;\n\tbool if_condition;\n\tTCHAR *cp;\n\n\t// The first set of checks are for isNumber(), isInteger() and isFloat(), which permit pure numeric values.\n\tswitch (TypeOfToken(*aParam[0]))\n\t{\n\tcase SYM_INTEGER:\n\t\tswitch (variable_type)\n\t\t{\n\t\tcase VAR_TYPE_NUMBER:\n\t\tcase VAR_TYPE_INTEGER:\n\t\t\t_f_return_b(true);\n\t\tcase VAR_TYPE_FLOAT:\n\t\t\t_f_return_b(false);\n\t\tdefault:\n\t\t\t// Do not permit pure numbers for the other functions, since the results would not be intuitive.\n\t\t\t// For instance, isAlnum() would return false for negative values due to '-'; isXDigit() would\n\t\t\t// return true for positive integers even though they are always in decimal.\n\t\t\tgoto type_mismatch;\n\t\t}\n\tcase SYM_FLOAT:\n\t\tswitch (variable_type)\n\t\t{\n\t\tcase VAR_TYPE_NUMBER:\n\t\tcase VAR_TYPE_FLOAT:\n\t\t\t_f_return_b(true);\n\t\tcase VAR_TYPE_INTEGER:\n\t\t\t// Given that legacy \"if var is float\" required a decimal point in var and isFloat() is false for\n\t\t\t// integers which can be represented as float, it seems inappropriate for isInteger(1.0) to be true.\n\t\t\t// A function like isWholeNumber() could be added if that was needed.\n\t\t\t_f_return_b(false);\n\t\tdefault:\n\t\t\tgoto type_mismatch;\n\t\t}\n\tcase SYM_OBJECT:\n\t\tswitch (variable_type)\n\t\t{\n\t\tcase VAR_TYPE_NUMBER:\n\t\tcase VAR_TYPE_INTEGER:\n\t\tcase VAR_TYPE_FLOAT:\n\t\t\t_f_return_b(false);\n\t\tdefault:\n\t\t\tgoto type_mismatch;\n\t\t}\n\t}\n\t// Since above did not return or goto, the value is a string.\n\tLPTSTR aValueStr = ParamIndexToString(0);\n\tauto string_case_sense = ParamIndexToCaseSense(1); // For IsAlpha, IsAlnum, IsUpper, IsLower.\n\tswitch (string_case_sense)\n\t{\n\tcase SCS_INSENSITIVE: // This case also executes when the parameter is omitted, such as for functions which don't have this parameter.\n\tcase SCS_SENSITIVE: // Insensitive vs. sensitive doesn't mean anything for these functions, but seems fair to allow either, rather than requiring 0 or deviating from the CaseSense convention by requiring \"\".\n\tcase SCS_INSENSITIVE_LOCALE: // 'Locale'\n\t\tbreak;\n\tdefault:\n\t\t_f_throw_param(1);\n\t}\n\n\t// The remainder of this function is based on the original code for ACT_IFIS, which was removed\n\t// in commit 3382e6e2.\n\tswitch (variable_type)\n\t{\n\tcase VAR_TYPE_NUMBER:\n\t\tif_condition = IsNumeric(aValueStr, true, false, true);\n\t\tbreak;\n\tcase VAR_TYPE_INTEGER:\n\t\tif_condition = IsNumeric(aValueStr, true, false, false); // Passes false for aAllowFloat.\n\t\tbreak;\n\tcase VAR_TYPE_FLOAT:\n\t\tif_condition = (IsNumeric(aValueStr, true, false, true) == PURE_FLOAT);\n\t\tbreak;\n\tcase VAR_TYPE_TIME:\n\t{\n\t\tSYSTEMTIME st;\n\t\tif_condition = YYYYMMDDToSystemTime(aValueStr, st, true);\n\t\tbreak;\n\t}\n\tcase VAR_TYPE_DIGIT:\n\t\tif_condition = true;\n\t\tfor (cp = aValueStr; *cp; ++cp)\n\t\t\tif (*cp < '0' || *cp > '9') // Avoid iswdigit; as documented, only ASCII digits 0 .. 9 are permitted.\n\t\t\t{\n\t\t\t\tif_condition = false;\n\t\t\t\tbreak;\n\t\t\t}\n\t\tbreak;\n\tcase VAR_TYPE_XDIGIT:\n\t\tcp = aValueStr;\n\t\tif (!_tcsnicmp(cp, _T(\"0x\"), 2)) // Allow 0x prefix.\n\t\t\tcp += 2;\n\t\tif_condition = true;\n\t\tfor (; *cp; ++cp)\n\t\t\tif (!cisxdigit(*cp)) // Avoid iswxdigit; as documented, only ASCII xdigits are permitted.\n\t\t\t{\n\t\t\t\tif_condition = false;\n\t\t\t\tbreak;\n\t\t\t}\n\t\tbreak;\n\tcase VAR_TYPE_ALNUM:\n\t\tif_condition = true;\n\t\tfor (cp = aValueStr; *cp; ++cp)\n\t\t\tif (string_case_sense == SCS_INSENSITIVE_LOCALE ? !IsCharAlphaNumeric(*cp) : !cisalnum(*cp))\n\t\t\t{\n\t\t\t\tif_condition = false;\n\t\t\t\tbreak;\n\t\t\t}\n\t\tbreak;\n\tcase VAR_TYPE_ALPHA:\n\t\t// Like AutoIt3, the empty string is considered to be alphabetic, which is only slightly debatable.\n\t\tif_condition = true;\n\t\tfor (cp = aValueStr; *cp; ++cp)\n\t\t\tif (string_case_sense == SCS_INSENSITIVE_LOCALE ? !IsCharAlpha(*cp) : !cisalpha(*cp))\n\t\t\t{\n\t\t\t\tif_condition = false;\n\t\t\t\tbreak;\n\t\t\t}\n\t\tbreak;\n\tcase VAR_TYPE_UPPER:\n\t\tif_condition = true;\n\t\tfor (cp = aValueStr; *cp; ++cp)\n\t\t\tif (string_case_sense == SCS_INSENSITIVE_LOCALE ? !IsCharUpper(*cp) : !cisupper(*cp))\n\t\t\t{\n\t\t\t\tif_condition = false;\n\t\t\t\tbreak;\n\t\t\t}\n\t\tbreak;\n\tcase VAR_TYPE_LOWER:\n\t\tif_condition = true;\n\t\tfor (cp = aValueStr; *cp; ++cp)\n\t\t\tif (string_case_sense == SCS_INSENSITIVE_LOCALE ? !IsCharLower(*cp) : !cislower(*cp))\n\t\t\t{\n\t\t\t\tif_condition = false;\n\t\t\t\tbreak;\n\t\t\t}\n\t\tbreak;\n\tcase VAR_TYPE_SPACE:\n\t\tif_condition = true;\n\t\tfor (cp = aValueStr; *cp; ++cp)\n\t\t\tif (!_istspace(*cp))\n\t\t\t{\n\t\t\t\tif_condition = false;\n\t\t\t\tbreak;\n\t\t\t}\n\t\tbreak;\n#ifdef DEBUG\n\tdefault:\n\t\tMsgBox(_T(\"DEBUG: Unhandled IsXStr mode.\"));\n#endif\n\t}\n\t_f_return_b(if_condition);\n\ntype_mismatch:\n\t_f_throw_param(0, _T(\"String\"));\n}\n\n\n\nBIF_DECL(BIF_IsSet)\n{\n\tVar *var = ParamIndexToOutputVar(0);\n\t// var should always be non-null for IsSet due to load-time validation.\n\t// IsSetRef requires the additional check since general validation permits\n\t// objects which aren't VarRefs but could implement __value.\n\tif (!var)\n\t\t_f_throw_param(0, _T(\"VarRef\"));\n\t_f_return_b(!var->IsUninitializedNormalVar());\n}\n\n\n\n////////////////////////\n// Keyboard Functions //\n////////////////////////\n\n\nbif_impl FResult GetKeyState(StrArg key_name, optl<StrArg> aMode, ResultToken &aResultToken)\n{\n\tJoyControls joy;\n\tint joystick_id;\n\tvk_type vk = TextToVK(key_name);\n\tif (!vk)\n\t{\n\t\tif ( !(joy = (JoyControls)ConvertJoy(key_name, &joystick_id)) )\n\t\t{\n\t\t\t// It is neither a key name nor a joystick button/axis.\n\t\t\treturn FR_E_ARG(0);\n\t\t}\n\t\tScriptGetJoyState(joy, joystick_id, aResultToken, _f_retval_buf);\n\t\treturn OK;\n\t}\n\t// Since above didn't return: There is a virtual key (not a joystick control).\n\tKeyStateTypes key_state_type;\n\tswitch (aMode.has_value() ? ctoupper(*aMode.value()) : 'L') // Second parameter.\n\t{\n\tcase 'T': key_state_type = KEYSTATE_TOGGLE; break; // Whether a toggleable key such as CapsLock is currently turned on.\n\tcase 'P': key_state_type = KEYSTATE_PHYSICAL; break; // Physical state of key.\n\tcase 'L': key_state_type = KEYSTATE_LOGICAL; break;\n\tdefault: return FR_E_ARG(1);\n\t}\n\taResultToken.SetValue(ScriptGetKeyState(vk, key_state_type)); // 1 for down and 0 for up.\n\treturn OK;\n}\n\n\n\nbif_impl int GetKeyVK(StrArg aKeyName)\n{\n\tvk_type vk;\n\tsc_type sc;\n\tTextToVKandSC(aKeyName, vk, sc);\n\treturn vk ? vk : sc_to_vk(sc);\n}\n\n\nbif_impl int GetKeySC(StrArg aKeyName)\n{\n\tvk_type vk;\n\tsc_type sc;\n\tTextToVKandSC(aKeyName, vk, sc);\n\treturn sc ? sc : vk_to_sc(vk);\n}\n\n\nbif_impl void GetKeyName(StrArg aKeyName, StrRet &aRetVal)\n{\n\tvk_type vk;\n\tsc_type sc;\n\tTextToVKandSC(aKeyName, vk, sc);\n\taRetVal.SetTemp(GetKeyName(vk, sc, aRetVal.CallerBuf(), aRetVal.CallerBufSize, _T(\"\")));\n}\n\n\n\n////////////////////\n// Core Functions //\n////////////////////\n\n\nBIF_DECL(BIF_VarSetStrCapacity)\n// Returns: The variable's new capacity.\n// Parameters:\n// 1: Target variable (unquoted).\n// 2: Requested capacity.\n{\n\tVar *target_var = ParamIndexToOutputVar(0);\n\t// Need to check since prior validation might have allowed a non-Var output ref object:\n\tif (!target_var)\n\t\t_f_throw_param(0, _T(\"VarRef\"));\n\tVar &var = *target_var;\n\tASSERT(var.Type() == VAR_NORMAL); // Should always be true.\n\n\tif (aParamCount > 1) // Second parameter is present.\n\t{\n\t\t__int64 param1 = TokenToInt64(*aParam[1]);\n\t\t// Check for invalid values, in particular small negatives which end up large when converted\n\t\t// to unsigned. Var::AssignString used to have a similar check, but integer overflow caused\n\t\t// by \"* sizeof(TCHAR)\" allowed some errors to go undetected. For this same reason, we can't\n\t\t// simply rely on SetCapacity() calling malloc() and then detecting failure.\n\t\tif ((unsigned __int64)param1 > (MAXINT_PTR / sizeof(TCHAR)))\n\t\t{\n\t\t\tif (param1 == -1) // Adjust variable's internal length.\n\t\t\t{\n\t\t\t\tvar.SetLengthFromContents();\n\t\t\t\t// Seems more useful to report length vs. capacity in this special case. Scripts might be able\n\t\t\t\t// to use this to boost performance.\n\t\t\t\taResultToken.value_int64 = var.CharLength();\n\t\t\t\treturn;\n\t\t\t}\n\t\t\t// x64: it's negative but not -1.\n\t\t\t// x86: it's either >2GB or negative and not -1.\n\t\t\t_f_throw_param(1);\n\t\t}\n\t\t// Since above didn't return:\n\t\tsize_t new_capacity = (size_t)param1 * sizeof(TCHAR); // Chars to bytes.\n\t\tif (new_capacity)\n\t\t{\n\t\t\tif (!var.SetCapacity(new_capacity, true)) // This also destroys the variables contents.\n\t\t\t{\n\t\t\t\taResultToken.SetExitResult(FAIL); // ScriptError() was already called.\n\t\t\t\treturn;\n\t\t\t}\n\t\t\t// By design, Assign() has already set the length of the variable to reflect new_capacity.\n\t\t\t// This is not what is wanted in this case since it should be truly empty.\n\t\t\tvar.ByteLength() = 0;\n\t\t}\n\t\telse // ALLOC_SIMPLE, due to its nature, will not actually be freed, which is documented.\n\t\t\tvar.Free();\n\t} // if (aParamCount > 1)\n\telse\n\t{\n\t\t// RequestedCapacity was omitted, so the var is not altered; instead, the current capacity\n\t\t// is reported, which seems more intuitive/useful than having it do a Free(). In this case\n\t\t// it's an input var rather than an output var, so check if it contains a string.\n\t\tif (var.IsPureNumericOrObject())\n\t\t\t_f_throw_type(_T(\"String\"), *aParam[0]);\n\t}\n\n\t// Caller has set aResultToken.symbol to a default of SYM_INTEGER, so no need to set it here.\n\tif (aResultToken.value_int64 = var.CharCapacity()) // Don't subtract 1 here in lieu doing it below (avoids underflow).\n\t\taResultToken.value_int64 -= 1; // Omit the room for the zero terminator since script capacity is defined as length vs. size.\n}\n\n\n\nBIF_DECL(BIF_Integer)\n{\n\t++aParam; // Skip `this`\n\tThrow_if_Param_NaN(0);\n\t_f_return_i(ParamIndexToInt64(0));\n}\n\n\n\nBIF_DECL(BIF_Float)\n{\n\t++aParam; // Skip `this`\n\tThrow_if_Param_NaN(0);\n\t_f_return(ParamIndexToDouble(0));\n}\n\n\n\nBIF_DECL(BIF_Number)\n{\n\t++aParam; // Skip `this`\n\tif (!ParamIndexToNumber(0, aResultToken))\n\t\t_f_throw_param(0, _T(\"Number\"));\n}\n\n\n\n////////////////////\n// Misc Functions //\n////////////////////\n\n\nbif_impl FResult BIF_Hotkey(StrArg aName, ExprTokenType *aAction, optl<StrArg> aOptions)\n{\n\tResultType result = OK;\n\tIObject *functor = nullptr;\n\tHookActionType hook_action = 0;\n\tif (aAction)\n\t{\n\t\tauto action_string = TokenToString(*aAction);\n\t\tif ( !(functor = TokenToObject(*aAction)) && *action_string\n\t\t\t&& !(hook_action = Hotkey::ConvertAltTab(action_string, true)) )\n\t\t{\n\t\t\t// Search for a match in the hotkey variants' \"original callbacks\".\n\t\t\t// I.e., find the function implicitly defined by \"x::action\".\n\t\t\tfor (int i = 0; i < Hotkey::sHotkeyCount; ++i)\n\t\t\t{\n\t\t\t\tif (_tcscmp(Hotkey::shk[i]->mName, action_string))\n\t\t\t\t\tcontinue;\n\t\t\t\t\n\t\t\t\tfor (HotkeyVariant* v = Hotkey::shk[i]->mFirstVariant; v; v = v->mNextVariant)\n\t\t\t\t\tif (v->mHotCriterion == g->HotCriterion)\n\t\t\t\t\t{\n\t\t\t\t\t\tfunctor = v->mOriginalCallback.ToObject();\n\t\t\t\t\t\tgoto break_twice;\n\t\t\t\t\t}\n\t\t\t}\n\t\tbreak_twice:;\n\t\t\tif (!functor)\n\t\t\t\treturn FR_E_ARG(1);\n\t\t}\n\t\tif (!functor)\n\t\t\thook_action = Hotkey::ConvertAltTab(action_string, true);\n\t}\n\treturn Hotkey::Dynamic(aName, aOptions.value_or_empty(), functor, hook_action);\n}\n\n\n\nvoid SetHotIfReturnValue(ResultToken &aResultToken);\n\nbif_impl FResult HotIf(ExprTokenType *aCriterion, ResultToken &aResultToken)\n{\n\tTCHAR buf[MAX_NUMBER_SIZE];\n\tSetHotIfReturnValue(aResultToken);\n\tif (!aCriterion)\n\t{\n\t\tg->HotCriterion = nullptr;\n\t\treturn OK;\n\t}\n\telse if (auto obj = TokenToObject(*aCriterion))\n\t\treturn Hotkey::IfExpr(obj);\n\telse\n\t\treturn Hotkey::IfExpr(TokenToString(*aCriterion, buf));\n}\n\n\n\nbif_impl FResult HotIfWinActive(optl<StrArg> aWinTitle, optl<StrArg> aWinText, ResultToken &aResultToken)\n{\n\treturn SetHotkeyCriterion(HOT_IF_ACTIVE, aWinTitle.value_or_empty(), aWinText.value_or_empty(), aResultToken);\n}\n\nbif_impl FResult HotIfWinNotActive(optl<StrArg> aWinTitle, optl<StrArg> aWinText, ResultToken &aResultToken)\n{\n\treturn SetHotkeyCriterion(HOT_IF_NOT_ACTIVE, aWinTitle.value_or_empty(), aWinText.value_or_empty(), aResultToken);\n}\n\nbif_impl FResult HotIfWinExist(optl<StrArg> aWinTitle, optl<StrArg> aWinText, ResultToken &aResultToken)\n{\n\treturn SetHotkeyCriterion(HOT_IF_EXIST, aWinTitle.value_or_empty(), aWinText.value_or_empty(), aResultToken);\n}\n\nbif_impl FResult HotIfWinNotExist(optl<StrArg> aWinTitle, optl<StrArg> aWinText, ResultToken &aResultToken)\n{\n\treturn SetHotkeyCriterion(HOT_IF_NOT_EXIST, aWinTitle.value_or_empty(), aWinText.value_or_empty(), aResultToken);\n}\n\n\n\nbif_impl FResult SetTimer(optl<IObject*> aFunction, optl<__int64> aPeriod, optl<int> aPriority)\n{\n\tIObject *callback;\n\t// Note that only one timer per callback is allowed because the callback is the\n\t// unique identifier that allows us to update or delete an existing timer.\n\tif (!aFunction.has_value())\n\t{\n\t\tif (g->CurrentTimer)\n\t\t\t// Default to the timer which launched the current thread.\n\t\t\tcallback = g->CurrentTimer->mCallback.ToObject();\n\t\telse\n\t\t\tcallback = NULL;\n\t\tif (!callback)\n\t\t\t// Either the thread was not launched by a timer or the timer has been deleted.\n\t\t\treturn FR_E_ARG(0);\n\t}\n\telse\n\t{\n\t\tcallback = aFunction.value();\n\t\tauto fr = ValidateFunctor(callback, 0);\n\t\tif (fr != OK)\n\t\t\treturn fr;\n\t}\n\t__int64 period = DEFAULT_TIMER_PERIOD;\n\tint priority = 0;\n\tbool update_period = false, update_priority = false;\n\tif (aPeriod.has_value())\n\t{\n\t\tperiod = aPeriod.value();\n\t\tif (!period)\n\t\t{\n\t\t\tg_script.DeleteTimer(callback);\n\t\t\treturn OK;\n\t\t}\n\t\tupdate_period = true;\n\t}\n\tif (aPriority.has_value())\n\t{\n\t\tpriority = aPriority.value();\n\t\tupdate_priority = true;\n\t}\n\tg_script.UpdateOrCreateTimer(callback, update_period, period, update_priority, priority);\n\treturn OK;\n}\n\n\n\nbif_impl void ScriptSleep(int aDelay)\n{\n\tMsgSleep(aDelay);\n}\n\n\n\nbif_impl void Critical(optl<StrArg> aSetting, int &aRetVal)\n{\n\taRetVal = g->ThreadIsCritical ? g->PeekFrequency : 0;\n\t// v1.0.46: When the current thread is critical, have the script check messages less often to\n\t// reduce situations where an OnMessage or GUI message must be discarded due to \"thread already\n\t// running\". Using 16 rather than the default of 5 solves reliability problems in a custom-menu-draw\n\t// script and probably many similar scripts -- even when the system is under load (though 16 might not\n\t// be enough during an extreme load depending on the exact preemption/timeslice dynamics involved).\n\t// DON'T GO TOO HIGH because this setting reduces response time for ALL messages, even those that\n\t// don't launch script threads (especially painting/drawing and other screen-update events).\n\t// Some hardware has a tickcount granularity of 15 instead of 10, so this covers more variations.\n\tDWORD peek_frequency_when_critical_is_on = UNINTERRUPTIBLE_PEEK_FREQUENCY; // Set default. See below.\n\t// v1.0.48: Below supports \"Critical 0\" as meaning \"Off\" to improve compatibility with A_IsCritical.\n\t// In fact, for performance, only the following are no recognized as turning on Critical:\n\t// - \"On\"\n\t// - \"\"\n\t// - Integer other than 0.\n\t// Everything else is considered to be \"Off\", including \"Off\", any non-blank string that\n\t// doesn't start with a non-zero number, and zero itself.\n\tg->ThreadIsCritical = aSetting.is_blank_or_omitted() // i.e. omitted or blank is the same as \"ON\". See comments above.\n\t\t|| !_tcsicmp(aSetting.value(), _T(\"On\"))\n\t\t|| (peek_frequency_when_critical_is_on = ATOU(aSetting.value())); // Non-zero integer also turns it on. Relies on short-circuit boolean order.\n\tif (g->ThreadIsCritical) // Critical has been turned on. (For simplicity even if it was already on, the following is done.)\n\t{\n\t\tg->PeekFrequency = peek_frequency_when_critical_is_on;\n\t\tg->AllowThreadToBeInterrupted = false;\n\t\t// Ensure uninterruptibility never times out. IsInterruptible() relies on this to avoid the\n\t\t// need to check g->ThreadIsCritical, which in turn allows global_maximize_interruptibility()\n\t\t// and DialogPrep() to avoid resetting g->ThreadIsCritical, which allows it to reliably be\n\t\t// used as the default setting for new threads, even when the auto-execute thread itself\n\t\t// (or the idle thread) needs to be interruptible, such as while displaying a dialog->\n\t\t// In other words, g->ThreadIsCritical only represents the desired setting as set by the\n\t\t// script, and isn't the actual mechanism used to make the thread uninterruptible.\n\t\tg->UninterruptibleDuration = -1;\n\t}\n\telse // Critical has been turned off.\n\t{\n\t\t// Since Critical is being turned off, allow thread to be immediately interrupted regardless of\n\t\t// any \"Thread Interrupt\" settings.\n\t\tg->PeekFrequency = DEFAULT_PEEK_FREQUENCY;\n\t\tg->AllowThreadToBeInterrupted = true;\n\t}\n\t// The thread's interruptibility has been explicitly set; so the script is now in charge of\n\t// managing this thread's interruptibility.\n}\n\n\n\nbif_impl FResult Thread(StrArg aCommand, optl<int> aValue1, optl<int> aValue2)\n{\n\tswitch (Line::ConvertThreadCommand(aCommand))\n\t{\n\tcase THREAD_CMD_PRIORITY:\n\t\tif (aValue1.has_value())\n\t\t\tg->Priority = *aValue1;\n\t\treturn OK;\n\tcase THREAD_CMD_INTERRUPT:\n\t\t// If either one is blank, leave that setting as it was before.\n\t\tif (aValue1.has_value())\n\t\t\tg_script.mUninterruptibleTime = *aValue1; // 32-bit (for compatibility with DWORDs returned by GetTickCount).\n\t\tif (aValue2.has_value())\n\t\t\tg_script.mUninterruptedLineCountMax = *aValue2; // 32-bit also, to help performance (since huge values seem unnecessary).\n\t\treturn OK;\n\tcase THREAD_CMD_NOTIMERS:\n\t\tg->AllowTimers = (aValue1.has_value() && *aValue1 == 0); // Double-negative NoTimers=false -> allow timers.\n\t\treturn OK;\n\tdefault:\n\t\treturn FR_E_ARG(0);\n\t}\n}\n\n\n\nbif_impl void OutputDebug(StrArg aText)\n{\n#ifdef CONFIG_DEBUGGER\n\tif (!g_Debugger.OutputStdErr(aText))\n#endif\n\t\tOutputDebugString(aText);\n}\n\n\n\n//////////////////////////////\n// Event Handling Functions //\n//////////////////////////////\n\nbif_impl FResult OnMessage(UINT aNumber, IObject *aFunction, optl<int> aMaxThreads)\n{\n\t// Set defaults:\n\tbool mode_is_delete = false;\n\tint max_instances = 1;\n\tbool call_it_last = true;\n\n\tif (aMaxThreads.has_value())\n\t{\n\t\tmax_instances = aMaxThreads.value();\n\t\t// For backward-compatibility, values between MAX_INSTANCES+1 and SHORT_MAX must be supported.\n\t\tif (max_instances > MsgMonitorStruct::MAX_INSTANCES) // MAX_INSTANCES >= MAX_THREADS_LIMIT.\n\t\t\tmax_instances = MsgMonitorStruct::MAX_INSTANCES;\n\t\tif (max_instances < 0) // MaxThreads < 0 is a signal to assign this monitor the lowest priority.\n\t\t{\n\t\t\tcall_it_last = false; // Call it after any older monitors. No effect if already registered.\n\t\t\tmax_instances = -max_instances; // Convert to positive.\n\t\t}\n\t\telse if (max_instances == 0) // It would never be called, so this is used as a signal to delete the item.\n\t\t\tmode_is_delete = true;\n\t}\n\n\t// Check if this message already exists in the array:\n\tMsgMonitorStruct *pmonitor = g_MsgMonitor.Find(aNumber, aFunction);\n\tbool item_already_exists = (pmonitor != NULL);\n\tif (!item_already_exists)\n\t{\n\t\tif (mode_is_delete) // Delete a non-existent item.\n\t\t\treturn OK;\n\t\tauto fr = ValidateFunctor(aFunction, 4);\n\t\tif (fr != OK)\n\t\t\treturn fr;\n\t\t// From this point on, it is certain that an item will be added to the array.\n\t\tpmonitor = g_MsgMonitor.Add(aNumber, aFunction, call_it_last);\n\t\tif (!pmonitor)\n\t\t\treturn FR_E_OUTOFMEM;\n\t}\n\n\tMsgMonitorStruct &monitor = *pmonitor;\n\n\tif (item_already_exists)\n\t{\n\t\tif (mode_is_delete)\n\t\t{\n\t\t\t// The msg-monitor is deleted from the array for two reasons:\n\t\t\t// 1) It improves performance because every incoming message for the app now needs to be compared\n\t\t\t// to one less filter. If the count will now be zero, performance is improved even more because\n\t\t\t// the overhead of the call to MsgMonitor() is completely avoided for every incoming message.\n\t\t\t// 2) It conserves space in the array in a situation where the script creates hundreds of\n\t\t\t// msg-monitors and then later deletes them, then later creates hundreds of filters for entirely\n\t\t\t// different message numbers.\n\t\t\t// The main disadvantage to deleting message filters from the array is that the deletion might\n\t\t\t// occur while the monitor is currently running, which requires more complex handling within\n\t\t\t// MsgMonitor() (see its comments for details).\n\t\t\tg_MsgMonitor.Delete(pmonitor);\n\t\t\treturn OK;\n\t\t}\n\t\t// Otherwise, an existing item is being assigned a new function or MaxThreads limit.\n\t\t// Continue on to update this item's attributes.\n\t}\n\telse // This message was newly added to the array.\n\t{\n\t\t// The above already verified that callback is not NULL and there is room in the array.\n\t\tmonitor.instance_count = 0; // Reset instance_count only for new items since existing items might currently be running.\n\t\t// Continue on to the update-or-create logic below.\n\t}\n\n\t// Update those struct attributes that get the same treatment regardless of whether this is an update or creation.\n\tif (!item_already_exists || aMaxThreads.has_value())\n\t\tmonitor.max_instances = max_instances;\n\t// Otherwise, the parameter was omitted so leave max_instances at its current value.\n\treturn OK;\n}\n\n\nMsgMonitorStruct *MsgMonitorList::Find(UINT aMsg, IObject *aCallback, UCHAR aMsgType)\n{\n\tfor (int i = 0; i < mCount; ++i)\n\t\tif (mMonitor[i].msg == aMsg\n\t\t\t&& mMonitor[i].func == aCallback // No need to check is_method, since it's impossible for an object and string to exist at the same address.\n\t\t\t&& mMonitor[i].msg_type == aMsgType) // Checked last because it's nearly always true.\n\t\t\treturn mMonitor + i;\n\treturn NULL;\n}\n\n\nMsgMonitorStruct *MsgMonitorList::Find(UINT aMsg, LPTSTR aMethodName, UCHAR aMsgType)\n{\n\tfor (int i = 0; i < mCount; ++i)\n\t\tif (mMonitor[i].msg == aMsg\n\t\t\t&& mMonitor[i].is_method && !_tcsicmp(aMethodName, mMonitor[i].method_name)\n\t\t\t&& mMonitor[i].msg_type == aMsgType) // Checked last because it's nearly always true.\n\t\t\treturn mMonitor + i;\n\treturn NULL;\n}\n\n\nMsgMonitorStruct *MsgMonitorList::AddInternal(UINT aMsg, bool aAppend)\n{\n\tif (mCount == mCountMax)\n\t{\n\t\tint new_count = mCountMax ? mCountMax * mCountMax : 16;\n\t\tvoid *new_array = realloc(mMonitor, new_count * sizeof(MsgMonitorStruct));\n\t\tif (!new_array)\n\t\t\treturn NULL;\n\t\tmMonitor = (MsgMonitorStruct *)new_array;\n\t\tmCountMax = new_count;\n\t}\n\tMsgMonitorStruct *new_mon;\n\tif (!aAppend)\n\t{\n\t\tfor (MsgMonitorInstance *inst = mTop; inst; inst = inst->previous)\n\t\t{\n\t\t\tinst->index++; // Correct the index of each running monitor.\n\t\t\tinst->count++; // Iterate the same set of items which existed before.\n\t\t\t// By contrast, count isn't adjusted when adding at the end because we do not\n\t\t\t// want new items to be called by messages received before they were registered.\n\t\t}\n\t\t// Shift existing items to make room.\n\t\tmemmove(mMonitor + 1, mMonitor, mCount * sizeof(MsgMonitorStruct));\n\t\tnew_mon = mMonitor;\n\t}\n\telse\n\t\tnew_mon = mMonitor + mCount;\n\n\t++mCount;\n\tnew_mon->msg = aMsg;\n\tnew_mon->msg_type = 0; // Must be initialised to 0 for all callers except GUI.\n\t// These are initialised by OnMessage, since OnExit and OnClipboardChange don't use them:\n\t//new_mon->instance_count = 0;\n\t//new_mon->max_instances = 1;\n\treturn new_mon;\n}\n\n\nMsgMonitorStruct *MsgMonitorList::Add(UINT aMsg, IObject *aCallback, bool aAppend)\n{\n\tMsgMonitorStruct *new_mon = AddInternal(aMsg, aAppend);\n\tif (new_mon)\n\t{\n\t\taCallback->AddRef();\n\t\tnew_mon->func = aCallback;\n\t\tnew_mon->is_method = false;\n\t}\n\treturn new_mon;\n}\n\n\nMsgMonitorStruct *MsgMonitorList::Add(UINT aMsg, LPTSTR aMethodName, bool aAppend)\n{\n\tif ( !(aMethodName = _tcsdup(aMethodName)) )\n\t\treturn NULL;\n\tMsgMonitorStruct *new_mon = AddInternal(aMsg, aAppend);\n\tif (new_mon)\n\t{\n\t\tnew_mon->method_name = aMethodName;\n\t\tnew_mon->is_method = true;\n\t}\n\telse\n\t\tfree(aMethodName);\n\treturn new_mon;\n}\n\n\nvoid MsgMonitorList::Delete(MsgMonitorStruct *aMonitor)\n{\n\tASSERT(aMonitor >= mMonitor && aMonitor < mMonitor + mCount);\n\n\tint mon_index = int(aMonitor - mMonitor);\n\t// Adjust the index of any active message monitors affected by this deletion. This allows a\n\t// message monitor to delete older message monitors while still allowing any remaining monitors\n\t// of that message to be called (when there are multiple).\n\tfor (MsgMonitorInstance *inst = mTop; inst; inst = inst->previous)\n\t{\n\t\tinst->Delete(mon_index);\n\t}\n\t// Remove the item from the array.\n\t--mCount; // Must be done prior to the below.\n\tLPVOID release_me = aMonitor->union_value;\n\tbool is_method = aMonitor->is_method;\n\tif (mon_index < mCount) // An element other than the last is being removed. Shift the array to cover/delete it.\n\t\tmemmove(aMonitor, aMonitor + 1, (mCount - mon_index) * sizeof(MsgMonitorStruct));\n\tif (is_method)\n\t\tfree(release_me);\n\telse\n\t\treinterpret_cast<IObject *>(release_me)->Release(); // Must be called last in case it calls a __delete() meta-function.\n}\n\n\nBOOL MsgMonitorList::IsMonitoring(UINT aMsg, UCHAR aMsgType)\n{\n\tfor (int i = 0; i < mCount; ++i)\n\t\tif (mMonitor[i].msg == aMsg && mMonitor[i].msg_type == aMsgType)\n\t\t\treturn TRUE;\n\treturn FALSE;\n}\n\n\nBOOL MsgMonitorList::IsMonitoringGuiMsg()\n{\n\tfor (int i = 0; i < mCount; ++i)\n\t\tif (mMonitor[i].msg_type == GUI_EVENTKIND_MESSAGE)\n\t\t\treturn TRUE;\n\treturn FALSE;\n}\n\n\nBOOL MsgMonitorList::IsRunning(UINT aMsg, UCHAR aMsgType)\n// Returns true if there are any monitors for a message currently executing.\n{\n\tfor (MsgMonitorInstance *inst = mTop; inst; inst = inst->previous)\n\t\tif (!inst->deleted && mMonitor[inst->index].msg == aMsg && mMonitor[inst->index].msg_type == aMsgType)\n\t\t\treturn TRUE;\n\t//if (!mTop)\n\t//\treturn FALSE;\n\t//for (int i = 0; i < mCount; ++i)\n\t//\tif (mMonitor[i].msg == aMsg && mMonitor[i].instance_count)\n\t//\t\treturn TRUE;\n\treturn FALSE;\n}\n\n\nvoid MsgMonitorList::Dispose()\n{\n\t// Although other action taken by GuiType::Destroy() ensures the event list isn't\n\t// reachable from script once destruction begins, we take the careful approach and\n\t// decrement mCount at each iteration to ensure that if Release() executes external\n\t// code, this list is always in a valid state.\n\twhile (mCount)\n\t{\n\t\t--mCount;\n\t\tif (mMonitor[mCount].is_method)\n\t\t\tfree(mMonitor[mCount].method_name);\n\t\telse\n\t\t\tmMonitor[mCount].func->Release();\n\t}\n\tfree(mMonitor);\n\tmMonitor = nullptr;\n\tmCountMax = 0;\n\t// Dispose all iterator instances to ensure Call() does not continue iterating:\n\tfor (MsgMonitorInstance *inst = mTop; inst; inst = inst->previous)\n\t\tinst->Dispose();\n}\n\n\nstatic FResult OnScriptEvent(IObject *aFunction, optl<int> aAddRemove, MsgMonitorList &handlers, int aParamCount)\n{\n\tauto fr = ValidateFunctor(aFunction, aParamCount);\n\tif (fr != OK)\n\t\treturn fr;\n\t\n\tint mode = aAddRemove.value_or(1);\n\n\tMsgMonitorStruct *existing = handlers.Find(0, aFunction);\n\n\tswitch (mode)\n\t{\n\tcase 1:\n\tcase -1:\n\t\tif (!existing && !handlers.Add(0, aFunction, mode == 1))\n\t\t\treturn FR_E_OUTOFMEM;\n\t\tbreak;\n\tcase 0:\n\t\tif (existing)\n\t\t\thandlers.Delete(existing);\n\t\tbreak;\n\tdefault:\n\t\treturn FR_E_ARG(1);\n\t}\n\treturn OK;\n}\n\nbif_impl FResult OnClipboardChange(IObject *aFunction, optl<int> aAddRemove)\n{\n\tauto result = OnScriptEvent(aFunction, aAddRemove, g_script.mOnClipboardChange, 1);\n\t// Unlike SetClipboardViewer(), AddClipboardFormatListener() doesn't cause existing\n\t// listeners to be called, so we can simply enable or disable our listener based on\n\t// whether any handlers are registered. This has no effect if already enabled:\n\tg_script.EnableClipboardListener(g_script.mOnClipboardChange.Count() > 0);\n\treturn result;\n}\n\nbif_impl FResult OnError(IObject *aFunction, optl<int> aAddRemove)\n{\n\treturn OnScriptEvent(aFunction, aAddRemove, g_script.mOnError, 2);\n}\n\nbif_impl FResult OnExit(IObject *aFunction, optl<int> aAddRemove)\n{\n\treturn OnScriptEvent(aFunction, aAddRemove, g_script.mOnExit, 2);\n}\n\n\n\n///////////////////////\n// Interop Functions //\n///////////////////////\n\n\nbif_impl void MenuFromHandle(UINT_PTR aHandle, IObject *&aRetVal)\n{\n\tif (aRetVal = g_script.FindMenu((HMENU)aHandle))\n\t\taRetVal->AddRef();\n}\n\n\n\n//////////////////////\n// Gui & GuiControl //\n//////////////////////\n\n\nbif_impl UINT_PTR IL_Create(optl<int> aInitialCount, optl<int> aGrowCount, optl<BOOL> aLargeIcons)\n// Returns: Handle to the new image list, or 0 on failure.\n// Parameters:\n// 1: Initial image count (ImageList_Create() ignores values <=0, so no need for error checking).\n// 2: Grow count (testing shows it can grow multiple times, even when this is set <=0, so it's apparently only a performance aid)\n// 3: Width of each image (currently meaning small icon size when omitted or false, large icon size otherwise).\n// 4: Future: Height of each image [if this param is present and >0, it would mean param 3 is not being used in its TRUE/FALSE mode)\n// 5: Future: Flags/Color depth\n{\n\tBOOL large = aLargeIcons.value_or(FALSE);\n\treturn (UINT_PTR)ImageList_Create(\n\t\tGetSystemMetrics(large ? SM_CXICON : SM_CXSMICON),\n\t\tGetSystemMetrics(large ? SM_CYICON : SM_CYSMICON),\n\t\tILC_MASK | ILC_COLOR32, // ILC_COLOR32 or at least something higher than ILC_COLOR is necessary to support true-color icons.\n\t\taInitialCount.value_or(2), // 2 seems a better default than one, since it might be common to have only two icons in the list.\n\t\taGrowCount.value_or(5) // Somewhat arbitrary default.\n\t);\n}\n\n\n\nbif_impl BOOL IL_Destroy(UINT_PTR aImageList)\n// Returns: 1 on success and 0 on failure.\n// Parameters:\n// 1: HIMAGELIST obtained from somewhere such as IL_Create().\n{\n\t// Returns nonzero if successful, or zero otherwise, so force it to conform to TRUE/FALSE for\n\t// better consistency with other functions:\n\treturn ImageList_Destroy((HIMAGELIST)aImageList) ? 1 : 0;\n}\n\n\n\nbif_impl FResult IL_Add(UINT_PTR aImageList, StrArg aFilename, optl<int> aIconNumber, optl<BOOL> aResizeNonIcon, int &aIndex)\n// Returns: the one-based index of the newly added icon, or zero on failure.\n// Parameters:\n// 1: HIMAGELIST: Handle of an existing ImageList.\n// 2: Filename from which to load the icon or bitmap.\n// 3: Icon number within the filename (or mask color for non-icon images).\n// 4: The mere presence of this parameter indicates that param #3 is mask RGB-color vs. icon number.\n// This param's value should be \"true\" to resize the image to fit the image-list's size or false\n// to divide up the image into a series of separate images based on its width.\n// (this parameter could be overloaded to be the filename containing the mask image, or perhaps an HBITMAP\n// provided directly by the script)\n// 5: Future: can be the scaling height to go along with an overload of #4 as the width. However,\n// since all images in an image list are of the same size, the use of this would be limited to\n// only those times when the imagelist would be scaled prior to dividing it into separate images.\n// The parameters above (at least #4) can be overloaded in the future calling ImageList_GetImageInfo() to determine\n// whether the imagelist has a mask.\n{\n\tHIMAGELIST himl = (HIMAGELIST)aImageList;\n\tif (!himl)\n\t\treturn FR_E_ARG(0);\n\n\tint param3 = aIconNumber.value_or(0);\n\tint icon_number, width = 0, height = 0; // Zero width/height causes image to be loaded at its actual width/height.\n\tif (aResizeNonIcon.has_value()) // The presence of this parameter switches mode to be \"load a non-icon image\".\n\t{\n\t\ticon_number = 0; // Zero means \"load icon or bitmap (doesn't matter)\".\n\t\tif (aResizeNonIcon.value()) // A value of True indicates that the image should be scaled to fit the imagelist's image size.\n\t\t\tImageList_GetIconSize(himl, &width, &height); // Determine the width/height to which it should be scaled.\n\t\t//else retain defaults of zero for width/height, which loads the image at actual size, which in turn\n\t\t// lets ImageList_AddMasked() divide it up into separate images based on its width.\n\t}\n\telse\n\t{\n\t\ticon_number = param3; // LoadPicture() properly handles any wrong/negative value that might be here.\n\t\tImageList_GetIconSize(himl, &width, &height); // L19: Determine the width/height of images in the image list to ensure icons are loaded at the correct size.\n\t}\n\n\tint image_type;\n\tHBITMAP hbitmap = LoadPicture(aFilename, width, height, image_type, icon_number, false); // Defaulting to \"false\" for \"use GDIplus\" provides more consistent appearance across multiple OSes.\n\tif (!hbitmap)\n\t{\n\t\taIndex = 0;\n\t\treturn OK;\n\t}\n\n\tint index;\n\tif (image_type == IMAGE_BITMAP) // In this mode, param3 is always assumed to be an RGB color.\n\t{\n\t\t// Return the index of the new image or 0 on failure.\n\t\tindex = ImageList_AddMasked(himl, hbitmap, rgb_to_bgr((int)param3)) + 1; // +1 to convert to one-based.\n\t\tDeleteObject(hbitmap);\n\t}\n\telse // ICON or CURSOR.\n\t{\n\t\t// Return the index of the new image or 0 on failure.\n\t\tindex = ImageList_AddIcon(himl, (HICON)hbitmap) + 1; // +1 to convert to one-based.\n\t\tDestroyIcon((HICON)hbitmap); // Works on cursors too. See notes in LoadPicture().\n\t}\n\taIndex = index;\n\treturn OK;\n}\n\n\n\n////////////////////\n// Misc Functions //\n////////////////////\n\nbif_impl FResult LoadPicture(StrArg aFilename, optl<StrArg> aOptions, int *aImageType, UINT_PTR &aRetVal)\n{\n\tint width = -1;\n\tint height = -1;\n\tint icon_number = 0;\n\tbool use_gdi_plus = false;\n\n\tfor (auto cp = aOptions.value_or_null(); cp; cp = StrChrAny(cp, _T(\" \\t\")))\n\t{\n\t\tcp = omit_leading_whitespace(cp);\n\t\tif (tolower(*cp) == 'w')\n\t\t\twidth = ATOI(cp + 1);\n\t\telse if (tolower(*cp) == 'h')\n\t\t\theight = ATOI(cp + 1);\n\t\telse if (!_tcsnicmp(cp, _T(\"Icon\"), 4))\n\t\t\ticon_number = ATOI(cp + 4);\n\t\telse if (!_tcsnicmp(cp, _T(\"GDI+\"), 4))\n\t\t\t// GDI+ or GDI+1 to enable, GDI+0 to disable.\n\t\t\tuse_gdi_plus = cp[4] != '0';\n\t}\n\n\tif (width == -1 && height == -1)\n\t\twidth = 0;\n\n\tint image_type;\n\tHBITMAP hbm = LoadPicture(aFilename, width, height, image_type, icon_number, use_gdi_plus);\n\tif (aImageType)\n\t\t*aImageType = image_type;\n\telse if (image_type != IMAGE_BITMAP && hbm)\n\t\t// Always return a bitmap when the ImageType output var is omitted.\n\t\thbm = IconToBitmap32((HICON)hbm, true); // Also works for cursors.\n\taRetVal = (UINT_PTR)hbm;\n\treturn OK;\n}\n\n\n\n////////////////////\n// Core Functions //\n////////////////////\n\n\nBIF_DECL(BIF_Type)\n{\n\t_f_return_p(TokenTypeString(*aParam[0]));\n}\n\n// Returns the type name of the given value.\nLPTSTR TokenTypeString(ExprTokenType &aToken)\n{\n\tswitch (TypeOfToken(aToken))\n\t{\n\tcase SYM_STRING: return STRING_TYPE_STRING;\n\tcase SYM_INTEGER: return INTEGER_TYPE_STRING;\n\tcase SYM_FLOAT: return FLOAT_TYPE_STRING;\n\tcase SYM_OBJECT: return TokenToObject(aToken)->Type();\n\tdefault: return _T(\"\"); // For maintainability.\n\t}\n}\n\n\n\nvoid Object::Error__New(ResultToken &aResultToken, int aID, int aFlags, ExprTokenType *aParam[], int aParamCount)\n{\n\tLPTSTR message;\n\tTCHAR what_buf[MAX_NUMBER_SIZE], extra_buf[MAX_NUMBER_SIZE];\n\tLPCTSTR what = ParamIndexToOptionalString(1, what_buf);\n\tLine *line = g_script.mCurrLine;\n\n\tif (aID == M_OSError__New && (ParamIndexIsOmitted(0) || ParamIndexIsNumeric(0)))\n\t{\n\t\tDWORD error = ParamIndexIsOmitted(0) ? g->LastError : (DWORD)ParamIndexToInt64(0);\n\t\tSetOwnProp(_T(\"Number\"), error);\n\t\t\n\t\t// Determine message based on error number.\n\t\tDWORD message_buf_size = _f_retval_buf_size;\n\t\tmessage = _f_retval_buf;\n\t\tDWORD size = (DWORD)_sntprintf(message, message_buf_size, (int)error < 0 ? _T(\"(0x%X) \") : _T(\"(%i) \"), error);\n\t\tif (error) // Never show \"Error: (0) The operation completed successfully.\"\n\t\t\tsize += FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, error, 0, message + size, message_buf_size - size, NULL);\n\t\tif (size)\n\t\t{\n\t\t\tif (message[size - 1] == '\\n')\n\t\t\t\tmessage[--size] = '\\0';\n\t\t\tif (message[size - 1] == '\\r')\n\t\t\t\tmessage[--size] = '\\0';\n\t\t}\n\t}\n\telse\n\t\tmessage = ParamIndexIsOmitted(0) ? Type() : ParamIndexToString(0, _f_number_buf);\n\n#ifndef CONFIG_DEBUGGER\n\tif (ParamIndexIsOmitted(1) && g->CurrentFunc)\n\t\twhat = g->CurrentFunc->mName;\n\tSetOwnProp(_T(\"Stack\"), _T(\"\")); // Avoid \"unknown property\" in compiled scripts.\n#else\n\tDbgStack::Entry *stack_top = g_Debugger.mStack.mTop - 1;\n\t// I think this was originally intended to omit Exception(); doesn't seem to be needed anymore?\n\t//if (stack_top->type == DbgStack::SE_BIF && _tcsicmp(what, stack_top->func->mName))\n\t//\t--stack_top;\n\tif (g_script.mNewRuntimeException != this)\n\t{\n\t\t// This Error is likely being constructed by the script with a call like Error(),\n\t\t// but there may be additional calls to __new. Find the stack entry corresponding\n\t\t// to the initial call, so we have a predictable starting point for -What values\n\t\t// and a good default Line.\n\t\tfor (auto se = stack_top; se >= g_Debugger.mStack.mBottom; --se)\n\t\t{\n\t\t\tif (se->type == DbgStack::SE_BIF && se->func == Object::sObjectCall)\n\t\t\t{\n\t\t\t\tline = se->line;\n\t\t\t\tstack_top = se - 1;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// In order to avoid omitting any stack frames that aren't actually related to the\n\t\t\t// construction of this Error object, omit only frames where this == script's this.\n\t\t\t// Multiple instances of the same function on the stack will all report the same\n\t\t\t// value due to how UDFs work, but that's very unlikely to be an issue in practice.\n\t\t\t// This would bypass Object.Call: (Error.Prototype.__New)({base: Error.Prototype})\n\t\t\tif (se->type != DbgStack::SE_UDF || !se->udf->func->mClass || se->udf->func->mParam[0].var->ToObject() != this)\n\t\t\t\tbreak;\n\t\t}\n\t}\n\n\tif (ParamIndexIsOmitted(1)) // \"What\"\n\t{\n\t\tif (g->CurrentFunc)\n\t\t\twhat = g->CurrentFunc->mName;\n\t}\n\telse\n\t{\n\t\tint offset = ParamIndexIsNumeric(1) ? ParamIndexToInt(1) : 0;\n\t\tfor (auto se = stack_top; se >= g_Debugger.mStack.mBottom; --se)\n\t\t{\n\t\t\tif (++offset == 0 || *what && !_tcsicmp(se->Name(), what))\n\t\t\t{\n\t\t\t\tline = se > g_Debugger.mStack.mBottom ? se[-1].line : se->line;\n\t\t\t\t// se->line contains the line at the given offset from the top of the stack.\n\t\t\t\t// Rather than returning the name of the function or sub which contains that\n\t\t\t\t// line, return the name of the function or sub which that line called.\n\t\t\t\t// In other words, an offset of -1 gives the name of the current function and\n\t\t\t\t// the file and number of the line which it was called from.\n\t\t\t\twhat = se->Name();\n\t\t\t\tstack_top = se;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif (se->type == DbgStack::SE_Thread)\n\t\t\t\tbreak; // Look only within the current thread.\n\t\t}\n\t}\n\n\tTCHAR stack_buf[SCRIPT_STACK_BUF_SIZE];\n\tGetScriptStack(stack_buf, _countof(stack_buf), stack_top);\n\tSetOwnProp(_T(\"Stack\"), stack_buf);\n#endif\n\n\tLPTSTR extra = ParamIndexToOptionalString(2, extra_buf);\n\n\tSetOwnProp(_T(\"Message\"), message);\n\tSetOwnProp(_T(\"What\"), const_cast<LPTSTR>(what));\n\tSetOwnProp(_T(\"File\"), Line::sSourceFile[line->mFileIndex]);\n\tSetOwnProp(_T(\"Line\"), line->mLineNumber);\n\tSetOwnProp(_T(\"Extra\"), extra);\n}\n\n\n\n////////////////////////////////////////////////////////\n// HELPER FUNCTIONS FOR TOKENS AND BUILT-IN FUNCTIONS //\n////////////////////////////////////////////////////////\n\nBOOL ResultToBOOL(LPTSTR aResult)\n{\n\tUINT c1 = (UINT)*aResult; // UINT vs. UCHAR might squeeze a little more performance out of it.\n\tif (c1 > 48) // Any UCHAR greater than '0' can't be a space(32), tab(9), '+'(43), or '-'(45), or '.'(46)...\n\t\treturn TRUE; // ...so any string starting with c1>48 can't be anything that's false (e.g. \" 0\", \"+0\", \"-0\", \".0\", \"0\").\n\tif (!c1 // Besides performance, must be checked anyway because otherwise IsNumeric() would consider \"\" to be non-numeric and thus TRUE.\n\t\t|| c1 == 48 && !aResult[1]) // The string \"0\" seems common enough to detect explicitly, for performance.\n\t\treturn FALSE;\n\t// IsNumeric() is called below because there are many variants of a false string:\n\t// e.g. \"0\", \"0.0\", \"0x0\", \".0\", \"+0\", \"-0\", and \" 0\" (leading spaces/tabs).\n\tswitch (IsNumeric(aResult, true, false, true)) // It's purely numeric and not all whitespace (and due to earlier check, it's not blank).\n\t{\n\tcase PURE_INTEGER: return ATOI64(aResult) != 0; // Could call ATOF() for both integers and floats; but ATOI64() probably performs better, and a float comparison to 0.0 might be a slower than an integer comparison to 0.\n\tcase PURE_FLOAT: return _tstof(aResult) != 0.0; // _tstof() vs. ATOF() because PURE_FLOAT is never hexadecimal.\n\tdefault: // PURE_NOT_NUMERIC.\n\t\t// Even a string containing all whitespace would be considered non-numeric since it's a non-blank string\n\t\t// that isn't equal to 0.\n\t\treturn TRUE;\n\t}\n}\n\n\n\nBOOL VarToBOOL(Var &aVar)\n{\n\tif (!aVar.HasContents()) // Must be checked first because otherwise IsNumeric() would consider \"\" to be non-numeric and thus TRUE. For performance, it also exploits the binary number cache.\n\t\treturn FALSE;\n\tswitch (aVar.IsNumeric())\n\t{\n\tcase PURE_INTEGER:\n\t\treturn aVar.ToInt64() != 0;\n\tcase PURE_FLOAT:\n\t\treturn aVar.ToDouble() != 0.0;\n\tdefault:\n\t\t// Even a string containing all whitespace would be considered non-numeric since it's a non-blank string\n\t\t// that isn't equal to 0.\n\t\treturn TRUE;\n\t}\n}\n\n\n\nBOOL TokenToBOOL(ExprTokenType &aToken)\n{\n\tswitch (aToken.symbol)\n\t{\n\tcase SYM_INTEGER: // Probably the most common; e.g. both sides of \"if (x>3 and x<6)\" are the number 1/0.\n\t\treturn aToken.value_int64 != 0; // Force it to be purely 1 or 0.\n\tcase SYM_VAR:\n\t\treturn VarToBOOL(*aToken.var);\n\tcase SYM_FLOAT:\n\t\treturn aToken.value_double != 0.0;\n\tcase SYM_STRING:\n\t\treturn ResultToBOOL(aToken.marker)\n\t\t\t|| aToken.marker_length && !*aToken.marker; // Consider any non-empty string beginning with \\0 to be TRUE.\n\tdefault:\n\t\t// The only remaining valid symbol is SYM_OBJECT, which is always TRUE.\n\t\t// Check symbol anyway, in case SYM_MISSING or something else sneaks in.\n\t\treturn aToken.symbol == SYM_OBJECT;\n\t}\n}\n\n\n\nToggleValueType TokenToToggleValue(ExprTokenType &aToken)\n{\n\tif (TokenIsNumeric(aToken))\n\tswitch (TokenToInt64(aToken)) // Reserve other values for potential future use by requiring exact match.\n\t{\n\tcase 1: return TOGGLED_ON;\n\tcase 0: return TOGGLED_OFF;\n\tcase -1: return TOGGLE;\n\t}\n\treturn TOGGLE_INVALID;\n}\n\n\n\nSymbolType TokenIsNumeric(ExprTokenType &aToken)\n{\n\tswitch(aToken.symbol)\n\t{\n\tcase SYM_INTEGER:\n\tcase SYM_FLOAT:\n\t\treturn aToken.symbol;\n\tcase SYM_VAR: \n\t\treturn aToken.var->IsNumeric();\n\tcase SYM_STRING: // Callers of this function expect a \"numeric\" result for numeric strings.\n\t\treturn IsNumeric(aToken.marker, true, false, true);\n\tdefault: // SYM_MISSING or SYM_OBJECT\n\t\treturn PURE_NOT_NUMERIC;\n\t}\n}\n\n\nSymbolType TokenIsPureNumeric(ExprTokenType &aToken)\n{\n\tswitch (aToken.symbol)\n\t{\n\tcase SYM_INTEGER:\n\tcase SYM_FLOAT:\n\t\treturn aToken.symbol;\n\tcase SYM_VAR:\n\t\treturn aToken.var->IsPureNumeric();\n\tdefault:\n\t\treturn PURE_NOT_NUMERIC;\n\t}\n}\n\n\nSymbolType TokenIsPureNumeric(ExprTokenType &aToken, SymbolType &aNumType)\n// This function is called very frequently by ExpandExpression(), which needs to distinguish\n// between numeric strings and pure numbers, but still needs to know if the string is numeric.\n{\n\tswitch(aToken.symbol)\n\t{\n\tcase SYM_INTEGER:\n\tcase SYM_FLOAT:\n\t\treturn aNumType = aToken.symbol;\n\tcase SYM_VAR:\n\t\tif (aNumType = aToken.var->IsPureNumeric())\n\t\t\treturn aNumType; // This var contains a pure binary number.\n\t\t// Otherwise, it might be a numeric string (i.e. impure).\n\t\taNumType = aToken.var->IsNumeric(); // This also caches the PURE_NOT_NUMERIC result if applicable.\n\t\treturn PURE_NOT_NUMERIC;\n\tcase SYM_STRING:\n\t\taNumType = IsNumeric(aToken.marker, true, false, true);\n\t\treturn PURE_NOT_NUMERIC;\n\tdefault:\n\t\t// Only SYM_OBJECT and SYM_MISSING should be possible.\n\t\treturn aNumType = PURE_NOT_NUMERIC;\n\t}\n}\n\n\nBOOL TokenIsEmptyString(ExprTokenType &aToken)\n{\n\tswitch (aToken.symbol)\n\t{\n\tcase SYM_STRING:\n\t\treturn !*aToken.marker;\n\tcase SYM_VAR:\n\t\treturn !aToken.var->HasContents();\n\t//case SYM_MISSING: // This case is omitted because it currently should be\n\t\t// impossible for all callers except for ParamIndexIsOmittedOrEmpty(),\n\t\t// which checks for it explicitly.\n\t\t//return TRUE;\n\tdefault:\n\t\treturn FALSE;\n\t}\n}\n\n\n__int64 TokenToInt64(ExprTokenType &aToken)\n// Caller has ensured that any SYM_VAR's Type() is VAR_NORMAL.\n// Converts the contents of aToken to a 64-bit int.\n{\n\t// Some callers, such as those that cast our return value to UINT, rely on the use of 64-bit\n\t// to preserve unsigned values and also wrap any signed values into the unsigned domain.\n\tswitch (aToken.symbol)\n\t{\n\t\tcase SYM_INTEGER:\treturn aToken.value_int64;\n\t\tcase SYM_FLOAT:\t\treturn (__int64)aToken.value_double;\n\t\tcase SYM_VAR:\t\treturn aToken.var->ToInt64();\n\t\tcase SYM_STRING:\treturn ATOI64(aToken.marker);\n\t}\n\t// Since above didn't return, it can only be SYM_OBJECT or not an operand.\n\treturn 0;\n}\n\n\n\ndouble TokenToDouble(ExprTokenType &aToken, BOOL aCheckForHex)\n// Caller has ensured that any SYM_VAR's Type() is VAR_NORMAL.\n// Converts the contents of aToken to a double.\n{\n\tswitch (aToken.symbol)\n\t{\n\t\tcase SYM_FLOAT:\t\treturn aToken.value_double;\n\t\tcase SYM_INTEGER:\treturn (double)aToken.value_int64;\n\t\tcase SYM_VAR:\t\treturn aToken.var->ToDouble();\n\t\tcase SYM_STRING:\treturn aCheckForHex ? ATOF(aToken.marker) : _tstof(aToken.marker); // atof() omits the check for hexadecimal.\n\t}\n\t// Since above didn't return, it can only be SYM_OBJECT or not an operand.\n\treturn 0;\n}\n\n\n\nLPTSTR TokenToString(ExprTokenType &aToken, LPTSTR aBuf, size_t *aLength)\n// Returns \"\" on failure to simplify logic in callers. Otherwise, it returns either aBuf (if aBuf was needed\n// for the conversion) or the token's own string. aBuf may be NULL, in which case the caller presumably knows\n// that this token is SYM_STRING or SYM_VAR (or the caller wants \"\" back for anything other than those).\n// If aBuf is not NULL, caller has ensured that aBuf is at least MAX_NUMBER_SIZE in size.\n{\n\tLPTSTR result;\n\tswitch (aToken.symbol)\n\t{\n\tcase SYM_VAR: // Caller has ensured that any SYM_VAR's Type() is VAR_NORMAL.\n\t\tresult = aToken.var->Contents(); // Contents() vs. mCharContents in case mCharContents needs to be updated by Contents().\n\t\tif (aLength)\n\t\t\t*aLength = aToken.var->Length();\n\t\treturn result;\n\tcase SYM_STRING:\n\t\tresult = aToken.marker;\n\t\tif (aLength)\n\t\t{\n\t\t\tif (aToken.marker_length == -1)\n\t\t\t\tbreak; // Call _tcslen(result) below.\n\t\t\t*aLength = aToken.marker_length;\n\t\t}\n\t\treturn result;\n\tcase SYM_INTEGER:\n\t\tresult = aBuf ? ITOA64(aToken.value_int64, aBuf) : _T(\"\");\n\t\tbreak;\n\tcase SYM_FLOAT:\n\t\tif (aBuf)\n\t\t{\n\t\t\tint length = FTOA(aToken.value_double, aBuf, MAX_NUMBER_SIZE);\n\t\t\tif (aLength)\n\t\t\t\t*aLength = length;\n\t\t\treturn aBuf;\n\t\t}\n\t\t//else continue on to return the default at the bottom.\n\t//case SYM_OBJECT: // Treat objects as empty strings (or TRUE where appropriate).\n\t//case SYM_MISSING:\n\tdefault:\n\t\tresult = _T(\"\");\n\t}\n\tif (aLength) // Caller wants to know the string's length as well.\n\t\t*aLength = _tcslen(result);\n\treturn result;\n}\n\n\n\nResultType TokenToStringParam(ResultToken &aResultToken, ExprTokenType *aParam[], int aIndex, LPTSTR aBuf, LPTSTR &aString, size_t *aLength, bool aPermitObject)\n{\n\tExprTokenType &token = *aParam[aIndex];\n\tLPTSTR result = nullptr;\n\tswitch (token.symbol)\n\t{\n\tcase SYM_VAR:\n\t\tif (!aPermitObject && token.var->HasObject())\n\t\t\tbreak;\n\t\taString = token.var->Contents(); // Contents() vs. mCharContents in case mCharContents needs to be updated by Contents().\n\t\tif (aLength)\n\t\t\t*aLength = token.var->Length();\n\t\treturn OK;\n\tcase SYM_STRING:\n\t\taString = token.marker;\n\t\tif (aLength)\n\t\t\t*aLength = token.marker_length != -1 ? token.marker_length : _tcslen(token.marker);\n\t\treturn OK;\n\tcase SYM_INTEGER:\n\t\taString = ITOA64(token.value_int64, aBuf);\n\t\tif (aLength)\n\t\t\t*aLength = _tcslen(aBuf);\n\t\treturn OK;\n\tcase SYM_OBJECT:\n\t\tif (aPermitObject)\n\t\t{\n\t\t\taString = _T(\"\");\n\t\t\tif (aLength)\n\t\t\t\t*aLength = 0;\n\t\t\treturn OK;\n\t\t}\n\t\tbreak;\n\tcase SYM_FLOAT:\n\t\tint length = FTOA(token.value_double, aString = aBuf, MAX_NUMBER_SIZE);\n\t\tif (aLength)\n\t\t\t*aLength = length;\n\t\treturn OK;\n\t//case SYM_MISSING: // Caller should handle this case\n\t}\n\treturn aResultToken.ParamError(aIndex, aParam[aIndex], _T(\"String\"));\n}\n\n\n\nResultType TokenToDoubleOrInt64(const ExprTokenType &aInput, ExprTokenType &aOutput)\n// Converts aToken's contents to a numeric value, either int64 or double (whichever is more appropriate).\n// Returns FAIL when aToken isn't an operand or is but contains a string that isn't purely numeric.\n{\n\tLPTSTR str;\n\tswitch (aInput.symbol)\n\t{\n\t\tcase SYM_INTEGER:\n\t\tcase SYM_FLOAT:\n\t\t\taOutput.symbol = aInput.symbol;\n\t\t\taOutput.value_int64 = aInput.value_int64;\n\t\t\treturn OK;\n\t\tcase SYM_VAR:\n\t\t\treturn aInput.var->ToDoubleOrInt64(aOutput);\n\t\tcase SYM_STRING: // v1.0.40.06: Fixed to be listed explicitly so that \"default\" case can return failure.\n\t\t\tstr = aInput.marker;\n\t\t\tbreak;\n\t\t//case SYM_OBJECT: // L31: Treat objects as empty strings (or TRUE where appropriate).\n\t\t//case SYM_MISSING:\n\t\tdefault:\n\t\t\treturn FAIL;\n\t}\n\t// Since above didn't return, interpret \"str\" as a number.\n\tswitch (aOutput.symbol = IsNumeric(str, true, false, true))\n\t{\n\tcase PURE_INTEGER:\n\t\taOutput.value_int64 = ATOI64(str);\n\t\tbreak;\n\tcase PURE_FLOAT:\n\t\taOutput.value_double = _tstof(str); // _tstof() vs. ATOF() because PURE_FLOAT is never hexadecimal.\n\t\tbreak;\n\tdefault: // Not a pure number.\n\t\treturn FAIL;\n\t}\n\treturn OK; // Since above didn't return, indicate success.\n}\n\n\n\nStringCaseSenseType TokenToStringCase(ExprTokenType& aToken)\n{\n\t// Pure integers 1 and 0 corresponds to SCS_SENSITIVE and SCS_INSENSITIVE, respectively.\n\t// Pure floats returns SCS_INVALID.\n\t// For strings see Line::ConvertStringCaseSense.\n\tLPTSTR str = NULL;\n\t__int64 int_val = 0;\n\tswitch (aToken.symbol)\n\t{\n\tcase SYM_VAR:\n\t\tswitch (aToken.var->IsPureNumeric())\n\t\t{\n\t\tcase PURE_INTEGER: int_val = aToken.var->ToInt64(); break;\n\t\tcase PURE_NOT_NUMERIC: str = aToken.var->Contents(FALSE); break; // Pass FALSE because it's not numeric and can't be VAR_VIRTUAL in this context.\n\t\tcase PURE_FLOAT: \n\t\tdefault:\t\n\t\t\treturn SCS_INVALID;\n\t\t}\n\t\tbreak;\n\n\tcase SYM_INTEGER: int_val = TokenToInt64(aToken); break;\n\tcase SYM_FLOAT: return SCS_INVALID;\n\tdefault: str = TokenToString(aToken); break;\n\t}\n\tif (str)\n\t\treturn !_tcsicmp(str, _T(\"Logical\"))\t? SCS_INSENSITIVE_LOGICAL\n\t\t\t\t\t\t\t\t\t\t\t\t: Line::ConvertStringCaseSense(str);\n\treturn int_val == 1 ? SCS_SENSITIVE\t\t\t\t\t\t// 1\t- Sensitive\n\t\t\t\t\t\t: (int_val == 0 ? SCS_INSENSITIVE\t// 0\t- Insensitive\n\t\t\t\t\t\t\t\t\t\t: SCS_INVALID);\t\t// else - invalid.\n}\n\n\n\nbool TokenIsOutputVar(ExprTokenType &aToken)\n{\n\tif (aToken.IsOptimizedOutputVar())\n\t\treturn true;\n\treturn ObjectCanBeOutputVar(TokenToObject(aToken));\n}\n\n\n\nbool ObjectCanBeOutputVar(IObject *aObj)\n{\n\t// Permit VarRef (which always works) and ComValue (which doesn't support HasProp but could work).\n\treturn aObj && (!aObj->IsOfType(Object::sPrototype) || ((Object*)aObj)->HasProp(_T(\"__Value\")));\n}\n\n\n\nVar *TokenToOutputVar(ExprTokenType &aToken)\n{\n\tif (aToken.IsOptimizedOutputVar())\n\t\treturn aToken.var;\n\tauto obj = TokenToObject(aToken);\n\tif (obj && obj->Base() == Object::sVarRefPrototype)\n\t\treturn static_cast<VarRef *>(obj);\n\treturn nullptr;\n}\n\n\n\nIObject *TokenToObject(ExprTokenType &aToken)\n// L31: Returns IObject* from SYM_OBJECT or SYM_VAR (where var->HasObject()), NULL for other tokens.\n// Caller is responsible for calling AddRef() if that is appropriate.\n{\n\tif (aToken.symbol == SYM_OBJECT)\n\t\treturn aToken.object;\n\t\n\tif (aToken.symbol == SYM_VAR)\n\t\treturn aToken.var->ToObject();\n\n\treturn NULL;\n}\n\n\n\nFResult ValidateFunctor(IObject *aFunc, int aParamCount, int *aMinParams, bool aShowError)\n{\n\tResultToken result_token;\n\tresult_token.SetResult(OK);\n\treturn ValidateFunctor(aFunc, aParamCount, result_token, aMinParams, aShowError)\n\t\t? OK : result_token.Exited() ? FR_FAIL : FR_ABORTED;\n}\n\nResultType ValidateFunctor(IObject *aFunc, int aParamCount, ResultToken &aResultToken, int *aUseMinParams, bool aShowError)\n{\n\tASSERT(aFunc);\n\t__int64 min_params = 0, max_params = INT_MAX;\n\tauto min_result = aParamCount == -1 ? INVOKE_NOT_HANDLED\n\t\t: GetObjectIntProperty(aFunc, _T(\"MinParams\"), min_params, aResultToken, true);\n\tif (!min_result)\n\t\treturn FAIL;\n\tbool has_minparams = min_result != INVOKE_NOT_HANDLED; // For readability.\n\tif (aUseMinParams) // CallbackCreate's signal to default to MinParams.\n\t{\n\t\tif (!has_minparams)\n\t\t\treturn aShowError ? aResultToken.UnknownMemberError(ExprTokenType(aFunc), IT_GET, _T(\"MinParams\")) : CONDITION_FALSE;\n\t\t*aUseMinParams = aParamCount = (int)min_params;\n\t}\n\telse if (has_minparams && aParamCount < (int)min_params)\n\t\treturn aShowError ? aResultToken.ValueError(ERR_INVALID_FUNCTOR) : CONDITION_FALSE;\n\tauto max_result = (aParamCount <= 0 || has_minparams && min_params == aParamCount)\n\t\t? INVOKE_NOT_HANDLED // No need to check MaxParams in the above cases.\n\t\t: GetObjectIntProperty(aFunc, _T(\"MaxParams\"), max_params, aResultToken, true);\n\tif (!max_result)\n\t\treturn FAIL;\n\tif (max_result != INVOKE_NOT_HANDLED && aParamCount > (int)max_params)\n\t{\n\t\t__int64 is_variadic = 0;\n\t\tauto result = GetObjectIntProperty(aFunc, _T(\"IsVariadic\"), is_variadic, aResultToken, true);\n\t\tif (!result)\n\t\t\treturn FAIL;\n\t\tif (!is_variadic) // or not defined.\n\t\t\treturn aShowError ? aResultToken.ValueError(ERR_INVALID_FUNCTOR) : CONDITION_FALSE;\n\t}\n\t// If either MinParams or MaxParams was confirmed to exist, this is likely a valid\n\t// function object, so skip the following check for performance. Otherwise, catch\n\t// likely errors by checking that the object is callable.\n\tif (min_result == INVOKE_NOT_HANDLED && max_result == INVOKE_NOT_HANDLED)\n\t\tif (Object *obj = dynamic_cast<Object *>(aFunc))\n\t\t\tif (!obj->HasMethod(_T(\"Call\")))\n\t\t\t\treturn aShowError ? aResultToken.UnknownMemberError(ExprTokenType(aFunc), IT_CALL, _T(\"Call\")) : CONDITION_FALSE;\n\t\t// Otherwise: COM objects can be callable via DISPID_VALUE. There's probably\n\t\t// no way to determine whether the object supports that without invoking it.\n\treturn OK;\n}\n\n\n\nResultType TokenSetResult(ResultToken &aResultToken, LPCTSTR aValue, size_t aLength)\n// Utility function for handling memory allocation and return to callers of built-in functions; based on BIF_SubStr.\n// Returns FAIL if malloc failed, in which case our caller is responsible for returning a sensible default value.\n{\n\tif (aLength == -1)\n\t\taLength = _tcslen(aValue); // Caller must not pass NULL for aResult in this case.\n\tif (aLength <= MAX_NUMBER_LENGTH) // v1.0.46.01: Avoid malloc() for small strings. However, this improves speed by only 10% in a test where random 25-byte strings were extracted from a 700 KB string (probably because VC++'s malloc()/free() are very fast for small allocations).\n\t\taResultToken.marker = aResultToken.buf; // Store the address of the result for the caller.\n\telse\n\t{\n\t\t// Caller has provided a mem_to_free (initially NULL) as a means of passing back memory we allocate here.\n\t\t// So if we change \"result\" to be non-NULL, the caller will take over responsibility for freeing that memory.\n\t\tif ( !(aResultToken.mem_to_free = tmalloc(aLength + 1)) ) // Out of memory.\n\t\t\treturn aResultToken.MemoryError();\n\t\taResultToken.marker = aResultToken.mem_to_free; // Store the address of the result for the caller.\n\t}\n\tif (aValue) // Caller may pass NULL to retrieve a buffer of sufficient size.\n\t\ttmemcpy(aResultToken.marker, aValue, aLength);\n\taResultToken.marker[aLength] = '\\0'; // Must be done separately from the memcpy() because the memcpy() might just be taking a substring (i.e. long before result's terminator).\n\taResultToken.marker_length = aLength;\n\treturn OK;\n}\n\n\n\n// TypeOfToken: Similar result to TokenIsPureNumeric, but may return SYM_OBJECT.\nSymbolType TypeOfToken(ExprTokenType &aToken)\n{\n\tswitch (aToken.symbol)\n\t{\n\tcase SYM_VAR:\n\t\tswitch (aToken.var->IsPureNumericOrObject())\n\t\t{\n\t\tcase VAR_ATTRIB_IS_INT64: return SYM_INTEGER;\n\t\tcase VAR_ATTRIB_IS_DOUBLE: return SYM_FLOAT;\n\t\tcase VAR_ATTRIB_IS_OBJECT: return SYM_OBJECT;\n\t\t}\n\t\treturn SYM_STRING;\n\tdefault: // Providing a default case produces smaller code on release builds as the compiler can omit the other symbol checks.\n#ifdef _DEBUG\n\t\tMsgBox(_T(\"DEBUG: Unhandled symbol type.\"));\n#endif\n\tcase SYM_STRING:\n\tcase SYM_INTEGER:\n\tcase SYM_FLOAT:\n\tcase SYM_OBJECT:\n\tcase SYM_MISSING:\n\t\treturn aToken.symbol;\n\t}\n}\n\n\n\nResultType ResultToken::Return(LPTSTR aValue, size_t aLength)\n// Copy and return a string.\n{\n\tASSERT(aValue);\n\tsymbol = SYM_STRING;\n\treturn TokenSetResult(*this, aValue, aLength);\n}\n\n\n\nbool ColorToBGR(ExprTokenType &aColorNameOrRGB, COLORREF &aBGR)\n{\n\tswitch (TypeOfToken(aColorNameOrRGB))\n\t{\n\tcase SYM_INTEGER:\n\t\taBGR = rgb_to_bgr((COLORREF)TokenToInt64(aColorNameOrRGB));\n\t\treturn true;\n\tcase SYM_STRING:\n\t\treturn ColorToBGR(TokenToString(aColorNameOrRGB), aBGR);\n\tdefault:\n\t\taBGR = 0;\n\t\treturn false;\n\t}\n}\n\n\n\nint ConvertJoy(LPCTSTR aBuf, int *aJoystickID, bool aAllowOnlyButtons)\n// The caller TextToKey() currently relies on the fact that when aAllowOnlyButtons==true, a value\n// that can fit in a sc_type (USHORT) is returned, which is true since the joystick buttons\n// are very small numbers (JOYCTRL_1==12).\n{\n\tif (aJoystickID)\n\t\t*aJoystickID = 0; // Set default output value for the caller.\n\tif (!aBuf || !*aBuf) return JOYCTRL_INVALID;\n\tauto aBuf_orig = aBuf;\n\tfor (; *aBuf >= '0' && *aBuf <= '9'; ++aBuf); // self-contained loop to find the first non-digit.\n\tif (aBuf > aBuf_orig) // The string starts with a number.\n\t{\n\t\tint joystick_id = ATOI(aBuf_orig) - 1;\n\t\tif (joystick_id < 0 || joystick_id >= MAX_JOYSTICKS)\n\t\t\treturn JOYCTRL_INVALID;\n\t\tif (aJoystickID)\n\t\t\t*aJoystickID = joystick_id; // Use ATOI vs. atoi even though hex isn't supported yet.\n\t}\n\n\tif (!_tcsnicmp(aBuf, _T(\"Joy\"), 3))\n\t{\n\t\tint offset;\n\t\tif (ParseInteger(aBuf + 3, offset))\n\t\t{\n\t\t\tif (offset < 1 || offset > MAX_JOY_BUTTONS)\n\t\t\t\treturn JOYCTRL_INVALID;\n\t\t\treturn JOYCTRL_1 + offset - 1;\n\t\t}\n\t}\n\tif (aAllowOnlyButtons)\n\t\treturn JOYCTRL_INVALID;\n\n\t// Otherwise:\n\tif (!_tcsicmp(aBuf, _T(\"JoyX\"))) return JOYCTRL_XPOS;\n\tif (!_tcsicmp(aBuf, _T(\"JoyY\"))) return JOYCTRL_YPOS;\n\tif (!_tcsicmp(aBuf, _T(\"JoyZ\"))) return JOYCTRL_ZPOS;\n\tif (!_tcsicmp(aBuf, _T(\"JoyR\"))) return JOYCTRL_RPOS;\n\tif (!_tcsicmp(aBuf, _T(\"JoyU\"))) return JOYCTRL_UPOS;\n\tif (!_tcsicmp(aBuf, _T(\"JoyV\"))) return JOYCTRL_VPOS;\n\tif (!_tcsicmp(aBuf, _T(\"JoyPOV\"))) return JOYCTRL_POV;\n\tif (!_tcsicmp(aBuf, _T(\"JoyName\"))) return JOYCTRL_NAME;\n\tif (!_tcsicmp(aBuf, _T(\"JoyButtons\"))) return JOYCTRL_BUTTONS;\n\tif (!_tcsicmp(aBuf, _T(\"JoyAxes\"))) return JOYCTRL_AXES;\n\tif (!_tcsicmp(aBuf, _T(\"JoyInfo\"))) return JOYCTRL_INFO;\n\treturn JOYCTRL_INVALID;\n}\n\n\n\nbool ScriptGetKeyState(vk_type aVK, KeyStateTypes aKeyStateType)\n// Returns true if \"down\", false if \"up\".\n{\n if (!aVK) // Assume \"up\" if indeterminate.\n\t\treturn false;\n\n\tswitch (aKeyStateType)\n\t{\n\tcase KEYSTATE_TOGGLE: // Whether a toggleable key such as CapsLock is currently turned on.\n\t\treturn IsKeyToggledOn(aVK); // This also works for non-\"lock\" keys, but in that case the toggle state can be out of sync with other processes/threads.\n\tcase KEYSTATE_PHYSICAL: // Physical state of key.\n\t\tif (IsMouseVK(aVK)) // mouse button\n\t\t{\n\t\t\tif (g_MouseHook) // mouse hook is installed, so use it's tracking of physical state.\n\t\t\t\treturn g_PhysicalKeyState[aVK] & STATE_DOWN;\n\t\t\telse\n\t\t\t\treturn IsKeyDownAsync(aVK);\n\t\t}\n\t\telse // keyboard\n\t\t{\n\t\t\tif (g_KeybdHook)\n\t\t\t{\n\t\t\t\t// Since the hook is installed, use its value rather than that from\n\t\t\t\t// GetAsyncKeyState(), which doesn't seem to return the physical state.\n\t\t\t\t// But first, correct the hook modifier state if it needs it. See comments\n\t\t\t\t// in GetModifierLRState() for why this is needed:\n\t\t\t\tif (KeyToModifiersLR(aVK)) // It's a modifier.\n\t\t\t\t\tGetModifierLRState(true); // Correct hook's physical state if needed.\n\t\t\t\treturn g_PhysicalKeyState[aVK] & STATE_DOWN;\n\t\t\t}\n\t\t\telse\n\t\t\t\treturn IsKeyDownAsync(aVK);\n\t\t}\n\t} // switch()\n\n\t// Otherwise, use the default state-type: KEYSTATE_LOGICAL\n\t// On XP/2K at least, a key can be physically down even if it isn't logically down,\n\t// which is why the below specifically calls IsKeyDown() rather than some more\n\t// comprehensive method such as consulting the physical key state as tracked by the hook:\n\t// v1.0.42.01: For backward compatibility, the following hasn't been changed to IsKeyDownAsync().\n\t// One example is the journal playback hook: when a window owned by the script receives\n\t// such a keystroke, only GetKeyState() can detect the changed state of the key, not GetAsyncKeyState().\n\t// A new mode can be added to KeyWait & GetKeyState if Async is ever explicitly needed.\n\treturn IsKeyDown(aVK);\n}\n\n\n\nbool ScriptGetJoyState(JoyControls aJoy, int aJoystickID, ExprTokenType &aToken, LPTSTR aBuf)\n// Caller must ensure that aToken.marker is a buffer large enough to handle the longest thing put into\n// it here, which is currently jc.szPname (size=32). Caller has set aToken.symbol to be SYM_STRING.\n// aToken is used for the value being returned by GetKeyState() to the script, while this function's\n// bool return value is used only by KeyWait, so is false for \"up\" and true for \"down\".\n// If there was a problem determining the position/state, aToken is made blank and false is returned.\n{\n\t// Set default in case of early return.\n\taToken.symbol = SYM_STRING;\n\taToken.marker = aBuf;\n\t*aBuf = '\\0'; // Blank vs. string \"0\" serves as an indication of failure.\n\n\tif (!aJoy) // Currently never called this way.\n\t\treturn false; // And leave aToken set to blank.\n\n\tbool aJoy_is_button = IS_JOYSTICK_BUTTON(aJoy);\n\n\tJOYCAPS jc;\n\tif (!aJoy_is_button && aJoy != JOYCTRL_POV)\n\t{\n\t\t// Get the joystick's range of motion so that we can report position as a percentage.\n\t\tif (joyGetDevCaps(aJoystickID, &jc, sizeof(JOYCAPS)) != JOYERR_NOERROR)\n\t\t\tZeroMemory(&jc, sizeof(jc)); // Zero it on failure, for use of the zeroes later below.\n\t}\n\n\t// Fetch this struct's info only if needed:\n\tJOYINFOEX jie;\n\tif (aJoy != JOYCTRL_NAME && aJoy != JOYCTRL_BUTTONS && aJoy != JOYCTRL_AXES && aJoy != JOYCTRL_INFO)\n\t{\n\t\tjie.dwSize = sizeof(JOYINFOEX);\n\t\tjie.dwFlags = JOY_RETURNALL;\n\t\tif (joyGetPosEx(aJoystickID, &jie) != JOYERR_NOERROR)\n\t\t\treturn false; // And leave aToken set to blank.\n\t\tif (aJoy_is_button)\n\t\t{\n\t\t\tbool is_down = ((jie.dwButtons >> (aJoy - JOYCTRL_1)) & (DWORD)0x01);\n\t\t\taToken.symbol = SYM_INTEGER; // Override default type.\n\t\t\taToken.value_int64 = is_down; // Always 1 or 0, since it's \"bool\" (and if not for that, bitwise-and).\n\t\t\treturn is_down;\n\t\t}\n\t}\n\n\t// Otherwise:\n\tUINT range;\n\tLPTSTR buf_ptr;\n\tdouble result_double; // Not initialized to help catch bugs.\n\n\tswitch(aJoy)\n\t{\n\tcase JOYCTRL_XPOS:\n\t\trange = (jc.wXmax > jc.wXmin) ? jc.wXmax - jc.wXmin : 0;\n\t\tresult_double = range ? 100 * (double)jie.dwXpos / range : jie.dwXpos;\n\t\tbreak;\n\tcase JOYCTRL_YPOS:\n\t\trange = (jc.wYmax > jc.wYmin) ? jc.wYmax - jc.wYmin : 0;\n\t\tresult_double = range ? 100 * (double)jie.dwYpos / range : jie.dwYpos;\n\t\tbreak;\n\tcase JOYCTRL_ZPOS:\n\t\trange = (jc.wZmax > jc.wZmin) ? jc.wZmax - jc.wZmin : 0;\n\t\tresult_double = range ? 100 * (double)jie.dwZpos / range : jie.dwZpos;\n\t\tbreak;\n\tcase JOYCTRL_RPOS: // Rudder or 4th axis.\n\t\trange = (jc.wRmax > jc.wRmin) ? jc.wRmax - jc.wRmin : 0;\n\t\tresult_double = range ? 100 * (double)jie.dwRpos / range : jie.dwRpos;\n\t\tbreak;\n\tcase JOYCTRL_UPOS: // 5th axis.\n\t\trange = (jc.wUmax > jc.wUmin) ? jc.wUmax - jc.wUmin : 0;\n\t\tresult_double = range ? 100 * (double)jie.dwUpos / range : jie.dwUpos;\n\t\tbreak;\n\tcase JOYCTRL_VPOS: // 6th axis.\n\t\trange = (jc.wVmax > jc.wVmin) ? jc.wVmax - jc.wVmin : 0;\n\t\tresult_double = range ? 100 * (double)jie.dwVpos / range : jie.dwVpos;\n\t\tbreak;\n\n\tcase JOYCTRL_POV:\n\t\taToken.symbol = SYM_INTEGER; // Override default type.\n\t\tif (jie.dwPOV == JOY_POVCENTERED) // Need to explicitly compare against JOY_POVCENTERED because it's a WORD not a DWORD.\n\t\t{\n\t\t\taToken.value_int64 = -1;\n\t\t\treturn false;\n\t\t}\n\t\telse\n\t\t{\n\t\t\taToken.value_int64 = jie.dwPOV;\n\t\t\treturn true;\n\t\t}\n\t\t// No break since above always returns.\n\n\tcase JOYCTRL_NAME:\n\t\t_tcscpy(aToken.marker, jc.szPname);\n\t\treturn false; // Return value not used.\n\n\tcase JOYCTRL_BUTTONS:\n\t\taToken.symbol = SYM_INTEGER; // Override default type.\n\t\taToken.value_int64 = jc.wNumButtons; // wMaxButtons is the *driver's* max supported buttons.\n\t\treturn false; // Return value not used.\n\n\tcase JOYCTRL_AXES:\n\t\taToken.symbol = SYM_INTEGER; // Override default type.\n\t\taToken.value_int64 = jc.wNumAxes; // wMaxAxes is the *driver's* max supported axes.\n\t\treturn false; // Return value not used.\n\n\tcase JOYCTRL_INFO:\n\t\tbuf_ptr = aToken.marker;\n\t\tif (jc.wCaps & JOYCAPS_HASZ)\n\t\t\t*buf_ptr++ = 'Z';\n\t\tif (jc.wCaps & JOYCAPS_HASR)\n\t\t\t*buf_ptr++ = 'R';\n\t\tif (jc.wCaps & JOYCAPS_HASU)\n\t\t\t*buf_ptr++ = 'U';\n\t\tif (jc.wCaps & JOYCAPS_HASV)\n\t\t\t*buf_ptr++ = 'V';\n\t\tif (jc.wCaps & JOYCAPS_HASPOV)\n\t\t{\n\t\t\t*buf_ptr++ = 'P';\n\t\t\tif (jc.wCaps & JOYCAPS_POV4DIR)\n\t\t\t\t*buf_ptr++ = 'D';\n\t\t\tif (jc.wCaps & JOYCAPS_POVCTS)\n\t\t\t\t*buf_ptr++ = 'C';\n\t\t}\n\t\t*buf_ptr = '\\0'; // Final termination.\n\t\treturn false; // Return value not used.\n\t} // switch()\n\n\t// If above didn't return, the result should now be in result_double.\n\taToken.symbol = SYM_FLOAT; // Override default type.\n\taToken.value_double = result_double;\n\treturn result_double;\n}\n\n\n\n__int64 pow_ll(__int64 base, __int64 exp)\n{\n\t/*\n\tCaller must ensure exp >= 0\n\tBelow uses 'a^b' to denote 'raising a to the power of b'.\n\tComputes and returns base^exp. If the mathematical result doesn't fit in __int64, the result is undefined.\n\tBy convention, x^0 returns 1, even when x == 0,\tcaller should ensure base is non-zero when exp is zero to handle 0^0.\n\t*/\n\tif (exp == 0)\n\t\treturn 1ll;\n\n\t// based on: https://en.wikipedia.org/wiki/Exponentiation_by_squaring (2018-11-03)\n\t__int64 result = 1;\n\twhile (exp > 1)\n\t{\n\t\tif (exp % 2) // exp is odd\n\t\t\tresult *= base;\n\t\tbase *= base;\n\t\texp /= 2;\n\t}\n\treturn result * base;\n}\n"},"size":{"kind":"number","value":154135,"string":"154,135"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":3544,"string":"3,544"},"avg_line_length":{"kind":"number","value":40.7847065462754,"string":"40.784707"},"max_line_length":{"kind":"number","value":279,"string":"279"},"alphanum_fraction":{"kind":"number","value":0.7216773712123231,"string":"0.721677"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11093,"cells":{"id":{"kind":"number","value":16083,"string":"16,083"},"file_name":{"kind":"string","value":"globaldata.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/globaldata.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n// These includes should probably a superset of those in globaldata.h:\n#include \"hook.h\" // For KeyHistoryItem and probably other things.\n#include \"clipboard.h\" // For the global clipboard object\n#include \"script.h\" // For the global script object\n#include \"os_version.h\" // For the global OS_Version object\n\n#include \"Debugger.h\"\n\n// Since at least some of some of these (e.g. g_modifiersLR_logical) should not\n// be kept in the struct since it's not correct to save and restore their\n// state, don't keep anything in the global_struct except those things\n// which are necessary to save and restore (even though it would clean\n// up the code and might make maintaining it easier):\nHINSTANCE g_hInstance = NULL; // Set by WinMain().\nDWORD g_MainThreadID = GetCurrentThreadId();\nDWORD g_HookThreadID; // Not initialized by design because 0 itself might be a valid thread ID.\nCRITICAL_SECTION g_CriticalRegExCache;\n\nUINT g_DefaultScriptCodepage = CP_UTF8;\n\nbool g_DestroyWindowCalled = false;\nHWND g_hWnd = NULL;\nHWND g_hWndEdit = NULL;\nHFONT g_hFontEdit = NULL;\nHACCEL g_hAccelTable = NULL;\nMSG *g_CalledByIsDialogMessageOrDispatch = nullptr;\n\nWNDPROC g_TabClassProc = NULL;\n\nmodLR_type g_modifiersLR_logical = 0;\nmodLR_type g_modifiersLR_logical_non_ignored = 0;\nmodLR_type g_modifiersLR_physical = 0;\nmodLR_type g_modifiersLR_numpad_mask = 0;\nmodLR_type g_modifiersLR_ctrlaltdel_mask = 0;\nmodLR_type g_modifiersLR_last_pressed = 0;\nDWORD g_modifiersLR_last_pressed_time;\n\n#ifdef FUTURE_USE_MOUSE_BUTTONS_LOGICAL\nWORD g_mouse_buttons_logical = 0;\n#endif\n\n// Used by the hook to track physical state of all virtual keys, since GetAsyncKeyState() does\n// not retrieve the physical state of a key. Note that this array is sometimes used in a way that\n// requires its format to be the same as that returned from GetKeyboardState():\nBYTE g_PhysicalKeyState[VK_ARRAY_COUNT] = {0};\nbool g_BlockWinKeys = false;\nDWORD g_AltGrExtraInfo = 0;\n\nBYTE g_MenuMaskKeyVK = VK_CONTROL; // For #MenuMaskKey.\nUSHORT g_MenuMaskKeySC = SC_LCONTROL;\n\nint g_HotkeyModifierTimeout = 50; // Reduced from 100, which was a little too large for fast typists.\nint g_ClipboardTimeout = 1000; // v1.0.31\n\nHHOOK g_KeybdHook = NULL;\nHHOOK g_MouseHook = NULL;\nHHOOK g_PlaybackHook = NULL;\nbool g_ForceLaunch = false;\nbool g_WinActivateForce = false;\nWarnMode g_WarnMode = WARNMODE_MSGBOX;\nSingleInstanceType g_AllowOnlyOneInstance = SINGLE_INSTANCE_PROMPT;\nbool g_persistent = false; // Whether the script should stay running even after the auto-exec section finishes.\nbool g_NoTrayIcon = false;\n#ifdef AUTOHOTKEYSC\n\tbool g_AllowMainWindow = false;\n#else\n\tbool g_AllowMainWindow = true;\n#endif\nbool g_MainTimerExists = false;\nbool g_InputTimerExists = false;\nbool g_DerefTimerExists = false;\nbool g_SoundWasPlayed = false;\nbool g_IsSuspended = false; // Make this separate from g_AllowInterruption since that is frequently turned off & on.\nbool g_DeferMessagesForUnderlyingPump = false;\nbool g_OnExitIsRunning = false;\nBOOL g_AllowInterruption = TRUE; // BOOL vs. bool might improve performance a little for frequently-accessed variables.\nint g_nLayersNeedingTimer = 0;\nint g_nThreads = 0;\nint g_nPausedThreads = 0;\nint g_MaxHistoryKeys = 40;\nDWORD g_InputTimeoutAt = 0;\n\nUCHAR g_MaxThreadsPerHotkey = 1;\nint g_MaxThreadsTotal = MAX_THREADS_DEFAULT;\n// On my system, the repeat-rate (which is probably set to XP's default) is such that between 20\n// and 25 keys are generated per second. Therefore, 50 in 2000ms seems like it should allow the\n// key auto-repeat feature to work on most systems without triggering the warning dialog.\n// In any case, using auto-repeat with a hotkey is pretty rare for most people, so it's best\n// to keep these values conservative:\nUINT g_MaxHotkeysPerInterval = 70; // Increased to 70 because 60 was still causing the warning dialog for repeating keys sometimes. Increased from 50 to 60 for v1.0.31.02 since 50 would be triggered by keyboard auto-repeat when it is set to its fastest.\nUINT g_HotkeyThrottleInterval = 2000; // Milliseconds.\nbool g_MaxThreadsBuffer = false; // This feature usually does more harm than good, so it defaults to OFF.\nbool g_SuspendExempt = false; // #SuspendExempt, applies to hotkeys and hotstrings.\nbool g_SuspendExemptHS = false; // This is just to prevent #Hotstring \"S\" from affecting hotkeys.\nSendLevelType g_InputLevel = 0;\nHotkeyCriterion *g_FirstHotCriterion = NULL, *g_LastHotCriterion = NULL;\n\n// Global variables for #HotIf (expression).\nUINT g_HotExprTimeout = 1000; // Timeout for #HotIf (expression) evaluation, in milliseconds.\nHWND g_HotExprLFW = NULL; // Last Found Window of last #HotIf expression.\nHotkeyCriterion *g_FirstHotExpr = NULL, *g_LastHotExpr = NULL;\n\nstatic int GetScreenDPI()\n{\n\t// The DPI setting can be different for each screen axis, but\n\t// apparently it is such a rare situation that it is not worth\n\t// supporting it. So we just retrieve the X axis DPI.\n\n\tHDC hdc = GetDC(NULL);\n\tint dpi = GetDeviceCaps(hdc, LOGPIXELSX);\n\tReleaseDC(NULL, hdc);\n\treturn dpi;\n}\n\nint g_ScreenDPI = GetScreenDPI();\nbool g_MenuIsVisible = false;\nHMENU g_MenuIsTempModeless = NULL;\nbool g_MenuIsTempTopmost = false;\nint g_nMessageBoxes = 0;\nint g_nFileDialogs = 0;\nint g_nFolderDialogs = 0;\nGuiType *g_firstGui = NULL, *g_lastGui = NULL;\nHWND g_hWndToolTip[MAX_TOOLTIPS] = {NULL};\nMsgMonitorList g_MsgMonitor;\n\n// Init not needed for these:\nUCHAR g_SortCaseSensitive;\nbool g_SortNumeric;\nbool g_SortReverse;\nint g_SortColumnOffset;\nIObject *g_SortFunc;\nResultType g_SortFuncResult;\n\n// Hot-string vars (initialized when ResetHook() is first called):\nTCHAR g_HSBuf[HS_BUF_SIZE];\nint g_HSBufLength;\nHWND g_HShwnd;\n\n// Hot-string global settings:\nint g_HSPriority = 0; // default priority is always 0\nint g_HSKeyDelay = 0; // Fast sends are much nicer for auto-replace and auto-backspace.\nSendModes g_HSSendMode = SM_INPUT; // v1.0.43: New default for more reliable hotstrings.\nSendRawType g_HSSendRaw = SCM_NOT_RAW;\nbool g_HSCaseSensitive = false;\nbool g_HSConformToCase = true;\nbool g_HSDoBackspace = true;\nbool g_HSOmitEndChar = false;\nbool g_HSEndCharRequired = true;\nbool g_HSDetectWhenInsideWord = false;\nbool g_HSDoReset = false;\nbool g_HSResetUponMouseClick = true;\nbool g_HSSameLineAction = false;\nTCHAR g_EndChars[HS_MAX_END_CHARS + 1] = _T(\"-()[]{}:;'\\\"/\\\\,.?!\\n \\t\"); // Hotstring default end chars, including a space.\n// The following were considered but seemed too rare and/or too likely to result in undesirable replacements\n// (such as while programming or scripting, or in usernames or passwords): <>*+=_%^&|@#$|\n// Although dash/hyphen is used for multiple purposes, it seems to me that it is best (on average) to include it.\n// Jay D. Novak suggested ([{/ for things such as fl/nj or fl(nj) which might resolve to USA state names.\n// i.e. word(synonym) and/or word/synonym\n\n// Global objects:\ninput_type *g_input = NULL;\nint g_inputBeforeHotkeysCount = 0;\nScript g_script;\n// This made global for performance reasons (determining size of clipboard data then\n// copying contents in or out without having to close & reopen the clipboard in between):\nClipboard g_clip;\nOS_Version g_os; // OS version object, courtesy of AutoIt3.\n\nHICON g_IconSmall;\nHICON g_IconLarge;\n\nglobal_struct g_startup, *g_array;\nglobal_struct *g = &g_startup; // g_startup provides a non-NULL placeholder during script loading. Afterward it's replaced with an array.\n\n// I considered maintaining this on a per-quasi-thread basis (i.e. in global_struct), but the overhead\n// of having to check and restore the working directory when a suspended thread is resumed (especially\n// when the script has many high-frequency timers), and possibly changing the working directory\n// whenever a new thread is launched, doesn't seem worth it. This is because the need to change\n// the working directory is comparatively rare:\nCString g_WorkingDir;\nLPTSTR g_WorkingDirOrig = NULL; // Assigned a value in WinMain().\n\nbool g_ForceKeybdHook = false;\nToggleValueType g_ForceNumLock = NEUTRAL;\nToggleValueType g_ForceCapsLock = NEUTRAL;\nToggleValueType g_ForceScrollLock = NEUTRAL;\n\nToggleValueType g_BlockInputMode = TOGGLE_DEFAULT;\nbool g_BlockInput = false;\nbool g_BlockMouseMove = false;\n\n// The order of initialization here must match the order in the enum contained in defines.h\n// It's in there rather than in globaldata.h so that the action-type constants can be referred\n// to without having access to the global array itself (i.e. it avoids having to include\n// globaldata.h in modules that only need access to the enum's constants, which in turn prevents\n// many mutual dependency problems between modules). Note: Action names must not contain any\n// spaces or tabs because within a script, those characters can be used in lieu of a delimiter\n// to separate the action-type-name from the first parameter.\n\n// STEPS TO ADD A NEW COMMAND:\n// 1) Add an entry to the command enum in defines.h.\n// 2) Add an entry to the below array (it's position here MUST exactly match that in the enum).\n// The first item is the command name, the second is the minimum number of parameters (e.g.\n// if you enter 3, the first 3 args are mandatory) and the third is the maximum number of\n// parameters (the user need not escape commas within the last parameter).\n// Note: If you use a value for MinParams than is greater than zero, remember than any params\n// beneath that threshold will also be required to be non-blank (i.e. user can't omit them even\n// if later, non-blank params are provided).\n// 3) If the new command has any params that are output or input vars, change Line::ArgIsVar().\n// 4) Implement the command in Line::ExecUntil().\n// If the command waits for anything (e.g. calls MsgSleep()), be sure to make a local\n// copy of any ARG values that are needed during the wait period, because if another hotkey\n// subroutine suspends the current one while its waiting, it could also overwrite the ARG\n// deref buffer with its own values.\n\nAction g_act[] =\n{\n\t{_T(\"\"), 0, 0} // ACT_INVALID.\n\n\t// ASSIGNEXPR: Give it a name for Line::ToText().\n\t// 1st param is the target, 2nd (optional) is the value:\n\t, {_T(\":=\"), 2, 2}\n\n\t// ACT_EXPRESSION, which is a stand-alone expression outside of any IF or assignment-command;\n\t// e.g. fn1(123, fn2(y)) or x&=3\n\t// Its name should be \"\" so that Line::ToText() will properly display it.\n\t, {_T(\"\"), 1, 1}\n\n\t, {_T(\"{\"), 0, 0}\n\t, {_T(\"}\"), 0, 0}\n\n\t, {_T(\"#HotIf\"), 0, 1}\n\t, {_T(\";end\"), 0, 0} // ACT_EXIT\n\n\t, {_T(\"Static\"), 1, 1} // ACT_STATIC - executes once and then the Line is removed.\n\t, {_T(\"Export\"), 1, 1} // ACT_EXPORT - used only at load time.\n\t, {_T(\"Global\"), 1, 1} // ACT_GLOBAL - used only at load time.\n\t, {_T(\"Local\"), 1, 1} // ACT_LOCAL - used only at load time.\n\n\t, {_T(\"If\"), 1, 1}\n\t, {_T(\"Else\"), 0, 0} // No args; it has special handling to support same-line ELSE-actions (e.g. \"else if\").\n\t, {_T(\"Loop\"), 0, 1} // IterationCount\n\t, {_T(\"Loop Files\"), 1, 2} // FilePattern [, Mode] -- Files vs File for clarity.\n\t, {_T(\"Loop Reg\"), 1, 2} // Key [, Mode]\n\t, {_T(\"Loop Read\"), 1, 2} // InputFile [, OutputFile]\n\t, {_T(\"Loop Parse\"), 1, 3} // InputString [, Delimiters, OmitChars]\n\t, {_T(\"For\"), 0, MAX_ARGS} // For vars in expression\n\t, {_T(\"While\"), 1, 1} // LoopCondition. v1.0.48: Lexikos: Added g_act entry for ACT_WHILE.\n\t, {_T(\"Until\"), 1, 1} // Until expression (follows a Loop)\n\t, {_T(\"Break\"), 0, 1}\n\t, {_T(\"Continue\"), 0, 1}\n\t, {_T(\"Goto\"), 1, 1}\n\t, {_T(\"Return\"), 0, 1}\n\t, {_T(\"Try\"), 0, 0}\n\t, {_T(\"Catch\"), 0, 1}\n\t, {_T(\"Finally\"), 0, 0}\n\t, {_T(\"Switch\"), 0, 2}\n\t, {_T(\"Case\"), 1, MAX_ARGS}\n};\n// Below is the most maintainable way to determine the actual count?\n// Due to C++ lang. restrictions, can't easily make this a const because constants\n// automatically get static (internal) linkage, thus such a var could never be\n// used outside this module:\nint g_ActionCount = _countof(g_act);\n\n\nkey_to_vk_type g_key_to_vk[] =\n{ {_T(\"Numpad0\"), VK_NUMPAD0}\n, {_T(\"Numpad1\"), VK_NUMPAD1}\n, {_T(\"Numpad2\"), VK_NUMPAD2}\n, {_T(\"Numpad3\"), VK_NUMPAD3}\n, {_T(\"Numpad4\"), VK_NUMPAD4}\n, {_T(\"Numpad5\"), VK_NUMPAD5}\n, {_T(\"Numpad6\"), VK_NUMPAD6}\n, {_T(\"Numpad7\"), VK_NUMPAD7}\n, {_T(\"Numpad8\"), VK_NUMPAD8}\n, {_T(\"Numpad9\"), VK_NUMPAD9}\n, {_T(\"NumpadMult\"), VK_MULTIPLY}\n, {_T(\"NumpadDiv\"), VK_DIVIDE}\n, {_T(\"NumpadAdd\"), VK_ADD}\n, {_T(\"NumpadSub\"), VK_SUBTRACT}\n// , {_T(\"NumpadEnter\"), VK_RETURN} // Must do this one via scan code, see below for explanation.\n, {_T(\"NumpadDot\"), VK_DECIMAL}\n, {_T(\"Numlock\"), VK_NUMLOCK}\n, {_T(\"ScrollLock\"), VK_SCROLL}\n, {_T(\"CapsLock\"), VK_CAPITAL}\n\n, {_T(\"Escape\"), VK_ESCAPE} // So that VKtoKeyName() delivers consistent results, always have the preferred name first.\n, {_T(\"Esc\"), VK_ESCAPE}\n, {_T(\"Tab\"), VK_TAB}\n, {_T(\"Space\"), VK_SPACE}\n, {_T(\"Backspace\"), VK_BACK} // So that VKtoKeyName() delivers consistent results, always have the preferred name first.\n, {_T(\"BS\"), VK_BACK}\n\n// These keys each have a counterpart on the number pad with the same VK. Use the VK for these,\n// since they are probably more likely to be assigned to hotkeys (thus minimizing the use of the\n// keyboard hook, and use the scan code (SC) for their counterparts. UPDATE: To support handling\n// these keys with the hook (i.e. the sc_takes_precedence flag in the hook), do them by scan code\n// instead. This allows Numpad keys such as Numpad7 to be differentiated from NumpadHome, which\n// would otherwise be impossible since both of them share the same scan code (i.e. if the\n// sc_takes_precedence flag is set for the scan code of NumpadHome, that will effectively prevent\n// the hook from telling the difference between it and Numpad7 since the hook is currently set\n// to handle an incoming key by either vk or sc, but not both.\n\n// For VKs with multiple SCs, such as VK_RETURN, the keyboard hook is made mandatory unless the\n// user specifies the VK by number. This ensures that Enter:: and NumpadEnter::, for example,\n// only fire when the appropriate key is pressed.\n, {_T(\"Enter\"), VK_RETURN} // So that VKtoKeyName() delivers consistent results, always have the preferred name first.\n\n// See g_key_to_sc for why these Numpad keys are handled here:\n, {_T(\"NumpadDel\"), VK_DELETE}\n, {_T(\"NumpadIns\"), VK_INSERT}\n, {_T(\"NumpadClear\"), VK_CLEAR} // same physical key as Numpad5 on most keyboards?\n, {_T(\"NumpadUp\"), VK_UP}\n, {_T(\"NumpadDown\"), VK_DOWN}\n, {_T(\"NumpadLeft\"), VK_LEFT}\n, {_T(\"NumpadRight\"), VK_RIGHT}\n, {_T(\"NumpadHome\"), VK_HOME}\n, {_T(\"NumpadEnd\"), VK_END}\n, {_T(\"NumpadPgUp\"), VK_PRIOR}\n, {_T(\"NumpadPgDn\"), VK_NEXT}\n\n, {_T(\"PrintScreen\"), VK_SNAPSHOT}\n, {_T(\"CtrlBreak\"), VK_CANCEL} // Might want to verify this, and whether it has any peculiarities.\n, {_T(\"Pause\"), VK_PAUSE} // So that VKtoKeyName() delivers consistent results, always have the preferred name first.\n, {_T(\"Help\"), VK_HELP} // VK_HELP is probably not the extended HELP key. Not sure what this one is.\n, {_T(\"Sleep\"), VK_SLEEP}\n\n, {_T(\"AppsKey\"), VK_APPS}\n\n, {_T(\"LControl\"), VK_LCONTROL} // So that VKtoKeyName() delivers consistent results, always have the preferred name first.\n, {_T(\"RControl\"), VK_RCONTROL} // So that VKtoKeyName() delivers consistent results, always have the preferred name first.\n, {_T(\"LCtrl\"), VK_LCONTROL} // Abbreviated versions of the above.\n, {_T(\"RCtrl\"), VK_RCONTROL} //\n, {_T(\"LShift\"), VK_LSHIFT}\n, {_T(\"RShift\"), VK_RSHIFT}\n, {_T(\"LAlt\"), VK_LMENU}\n, {_T(\"RAlt\"), VK_RMENU}\n// These two are always left/right centric and I think their vk's are always supported by the various\n// Windows API calls, unlike VK_RSHIFT, etc. (which are seldom supported):\n, {_T(\"LWin\"), VK_LWIN}\n, {_T(\"RWin\"), VK_RWIN}\n\n, {_T(\"Control\"), VK_CONTROL} // So that VKtoKeyName() delivers consistent results, always have the preferred name first.\n, {_T(\"Ctrl\"), VK_CONTROL} // An alternate for convenience.\n, {_T(\"Alt\"), VK_MENU}\n, {_T(\"Shift\"), VK_SHIFT}\n\n, {_T(\"F1\"), VK_F1}\n, {_T(\"F2\"), VK_F2}\n, {_T(\"F3\"), VK_F3}\n, {_T(\"F4\"), VK_F4}\n, {_T(\"F5\"), VK_F5}\n, {_T(\"F6\"), VK_F6}\n, {_T(\"F7\"), VK_F7}\n, {_T(\"F8\"), VK_F8}\n, {_T(\"F9\"), VK_F9}\n, {_T(\"F10\"), VK_F10}\n, {_T(\"F11\"), VK_F11}\n, {_T(\"F12\"), VK_F12}\n, {_T(\"F13\"), VK_F13}\n, {_T(\"F14\"), VK_F14}\n, {_T(\"F15\"), VK_F15}\n, {_T(\"F16\"), VK_F16}\n, {_T(\"F17\"), VK_F17}\n, {_T(\"F18\"), VK_F18}\n, {_T(\"F19\"), VK_F19}\n, {_T(\"F20\"), VK_F20}\n, {_T(\"F21\"), VK_F21}\n, {_T(\"F22\"), VK_F22}\n, {_T(\"F23\"), VK_F23}\n, {_T(\"F24\"), VK_F24}\n\n// Mouse buttons:\n, {_T(\"LButton\"), VK_LBUTTON}\n, {_T(\"RButton\"), VK_RBUTTON}\n, {_T(\"MButton\"), VK_MBUTTON}\n, {_T(\"XButton1\"), VK_XBUTTON1}\n, {_T(\"XButton2\"), VK_XBUTTON2}\n// Custom/fake VKs for use by the mouse hook:\n, {_T(\"WheelDown\"), VK_WHEEL_DOWN}\n, {_T(\"WheelUp\"), VK_WHEEL_UP}\n, {_T(\"WheelLeft\"), VK_WHEEL_LEFT}\n, {_T(\"WheelRight\"), VK_WHEEL_RIGHT}\n\n, {_T(\"Browser_Back\"), VK_BROWSER_BACK}\n, {_T(\"Browser_Forward\"), VK_BROWSER_FORWARD}\n, {_T(\"Browser_Refresh\"), VK_BROWSER_REFRESH}\n, {_T(\"Browser_Stop\"), VK_BROWSER_STOP}\n, {_T(\"Browser_Search\"), VK_BROWSER_SEARCH}\n, {_T(\"Browser_Favorites\"), VK_BROWSER_FAVORITES}\n, {_T(\"Browser_Home\"), VK_BROWSER_HOME}\n, {_T(\"Volume_Mute\"), VK_VOLUME_MUTE}\n, {_T(\"Volume_Down\"), VK_VOLUME_DOWN}\n, {_T(\"Volume_Up\"), VK_VOLUME_UP}\n, {_T(\"Media_Next\"), VK_MEDIA_NEXT_TRACK}\n, {_T(\"Media_Prev\"), VK_MEDIA_PREV_TRACK}\n, {_T(\"Media_Stop\"), VK_MEDIA_STOP}\n, {_T(\"Media_Play_Pause\"), VK_MEDIA_PLAY_PAUSE}\n, {_T(\"Launch_Mail\"), VK_LAUNCH_MAIL}\n, {_T(\"Launch_Media\"), VK_LAUNCH_MEDIA_SELECT}\n, {_T(\"Launch_App1\"), VK_LAUNCH_APP1}\n, {_T(\"Launch_App2\"), VK_LAUNCH_APP2}\n\n// Probably safest to terminate it this way, with a flag value. (plus this makes it a little easier\n// to code some loops, maybe). Can also calculate how many elements are in the array using sizeof(array)\n// divided by sizeof(element). UPDATE: Decided not to do this in case ever decide to sort this array; don't\n// want to rely on the fact that this will wind up in the right position after the sort (even though it\n// should):\n//, {_T(\"\"), 0}\n};\n\n\n\n// For VKs with multiple SCs, one is handled by VK and one by SC. Since MapVirtualKey() prefers\n// non-extended keys, we treat extended keys as secondary and handle them by SC. This simplifies\n// the logic in vk_to_sc(). Another reason not to handle the Numlock-off Numpad keys here is that\n// extra logic would be required to prioritize the Numlock-on VKs. By contrast, handling the\n// non-Numpad keys here requires a little extra logic in GetKeyName() to have it return the generic\n// names when a generic VK (such as VK_END) is given without SC.\nkey_to_sc_type g_key_to_sc[] =\n{ {_T(\"NumpadEnter\"), SC_NUMPADENTER}\n\n, {_T(\"Delete\"), SC_DELETE}\n, {_T(\"Del\"), SC_DELETE}\n, {_T(\"Insert\"), SC_INSERT}\n, {_T(\"Ins\"), SC_INSERT}\n// , {_T(\"Clear\"), SC_CLEAR} // Seems unnecessary because there is no counterpart to the Numpad5 clear key?\n, {_T(\"Up\"), SC_UP}\n, {_T(\"Down\"), SC_DOWN}\n, {_T(\"Left\"), SC_LEFT}\n, {_T(\"Right\"), SC_RIGHT}\n, {_T(\"Home\"), SC_HOME}\n, {_T(\"End\"), SC_END}\n, {_T(\"PgUp\"), SC_PGUP}\n, {_T(\"PgDn\"), SC_PGDN}\n};\n\n\n// Can calc the counts only after the arrays are initialized above:\nint g_key_to_vk_count = _countof(g_key_to_vk);\nint g_key_to_sc_count = _countof(g_key_to_sc);\n\nKeyHistoryItem *g_KeyHistory = NULL; // Array is allocated during startup.\nint g_KeyHistoryNext = 0;\n\n// These must be global also, since both the keyboard and mouse hook functions,\n// in addition to KeyEvent() when it's logging keys with only the mouse hook installed,\n// MUST refer to the same variables. Otherwise, the elapsed time between keyboard and\n// and mouse events will be wrong:\nDWORD g_HistoryTickNow = 0;\nDWORD g_HistoryTickPrev = GetTickCount(); // So that the first logged key doesn't have a huge elapsed time.\nHWND g_HistoryHwndPrev = NULL;\n\n// Also hook related:\nDWORD g_TimeLastInputPhysical = GetTickCount();\nDWORD g_TimeLastInputKeyboard = g_TimeLastInputPhysical;\nDWORD g_TimeLastInputMouse = g_TimeLastInputPhysical;\n"},"size":{"kind":"number","value":20515,"string":"20,515"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":414,"string":"414"},"avg_line_length":{"kind":"number","value":48.292270531400966,"string":"48.292271"},"max_line_length":{"kind":"number","value":254,"string":"254"},"alphanum_fraction":{"kind":"number","value":0.7181713829415581,"string":"0.718171"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11094,"cells":{"id":{"kind":"number","value":16084,"string":"16,084"},"file_name":{"kind":"string","value":"WinGroup.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/WinGroup.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"WinGroup.h\"\n#include \"window.h\" // for several lower level window functions\n#include \"globaldata.h\" // for DoWinDelay\n#include \"application.h\" // for DoWinDelay's MsgSleep()\n\n// Define static members data:\nWinGroup *WinGroup::sGroupLastUsed = NULL;\nHWND *WinGroup::sAlreadyVisited = NULL;\nint WinGroup::sAlreadyVisitedCount = 0;\n\n\nResultType WinGroup::AddWindow(LPCTSTR aTitle, LPCTSTR aText, LPCTSTR aExcludeTitle, LPCTSTR aExcludeText)\n// Caller should ensure that at least one param isn't NULL/blank.\n// This function is not thread-safe because it adds an entry to the list of window specs.\n// In addition, if this function is being called by one thread while another thread is calling IsMember(),\n// the thread-safety notes in IsMember() apply.\n{\n\tif (!aTitle) aTitle = _T(\"\");\n\tif (!aText) aText = _T(\"\");\n\tif (!aExcludeTitle) aExcludeTitle = _T(\"\");\n\tif (!aExcludeText) aExcludeText = _T(\"\");\n\t// v1.0.41: If a window group can ever be deleted (or its window specs), that might defeat the\n\t// thread-safety of WinExist/WinActive.\n\t// v1.0.36.05: If all four window parameters are blank, allow it to be added but provide\n\t// a non-blank ExcludeTitle so that the window-finding routines won't see it as the\n\t// \"last found window\". 99.99% of the time, it is undesirable to have Program Manager\n\t// in a window group of any kind, so that is used as the placeholder:\n\tif (!(*aTitle || *aText || *aExcludeTitle || *aExcludeText))\n\t\taExcludeTitle = _T(\"Program Manager\");\n\n\t// Though the documentation is clear on this, some users will still probably execute\n\t// each GroupAdd statement more than once. Thus, to prevent more and more memory\n\t// from being allocated for duplicates, do not add the window specification if it\n\t// already exists in the group:\n\tif (mFirstWindow) // Traverse the circular linked-list to look for a match.\n\t\tfor (WindowSpec *win = mFirstWindow\n\t\t\t; win != NULL; win = (win->mNextWindow == mFirstWindow) ? NULL : win->mNextWindow)\n\t\t\tif (!_tcscmp(win->mTitle, aTitle) && !_tcscmp(win->mText, aText) // All are case sensitive.\n\t\t\t\t&& !_tcscmp(win->mExcludeTitle, aExcludeTitle) && !_tcscmp(win->mExcludeText, aExcludeText))\n\t\t\t\treturn OK;\n\n\t// SimpleHeap::Malloc() will set these new vars to the constant empty string if their\n\t// corresponding params are blank:\n\tLPTSTR new_title, new_text, new_exclude_title, new_exclude_text;\n\tif (!(new_title = SimpleHeap::Malloc(aTitle))) return FAIL; // It already displayed the error for us.\n\tif (!(new_text = SimpleHeap::Malloc(aText)))return FAIL;\n\tif (!(new_exclude_title = SimpleHeap::Malloc(aExcludeTitle))) return FAIL;\n\tif (!(new_exclude_text = SimpleHeap::Malloc(aExcludeText))) return FAIL;\n\n\t// The precise method by which the follows steps are done should be thread-safe even if\n\t// some other thread calls IsMember() in the middle of the operation. But any changes\n\t// must be carefully reviewed:\n\tWindowSpec *the_new_win = new WindowSpec(new_title, new_text, new_exclude_title, new_exclude_text);\n\tif (mFirstWindow == NULL)\n\t\tmFirstWindow = the_new_win;\n\telse\n\t\tmLastWindow->mNextWindow = the_new_win; // Formerly it pointed to First, so nothing is lost here.\n\t// This must be done after the above:\n\tmLastWindow = the_new_win;\n\t// Make it circular: Last always points to First. It's okay if it points to itself:\n\tmLastWindow->mNextWindow = mFirstWindow;\n\t++mWindowCount;\n\treturn OK;\n}\n\n\n\nvoid WinGroup::ActUponAll(BuiltInFunctionID aActionType, int aTimeToWaitForClose)\n{\n\t// A group should never be empty, since it is created by \"adding\" a set of criteria.\n\t//if (IsEmpty())\n\t//\treturn;\n\t// Don't need to call Update() in this case.\n\tWindowSearch ws;\n\tws.mFirstWinSpec = mFirstWindow; // Act upon all windows that match any WindowSpec in the group.\n\tws.mActionType = aActionType; // Set the type of action to be performed on each window.\n\tws.mTimeToWaitForClose = aTimeToWaitForClose; // Only relevant for WinClose and WinKill.\n\tEnumWindows(EnumParentActUponAll, (LPARAM)&ws);\n\tif (ws.mFoundParent) // It acted upon least one window.\n\t\tDoWinDelay;\n}\n\n\n\nvoid WinGroup::CloseAndGoToNext(bool aStartWithMostRecent)\n// If the foreground window is a member of this group, close it and activate\n// the next member.\n{\n\tif (IsEmpty())\n\t\treturn;\n\t// Otherwise:\n\t// Don't call Update(), let (De)Activate() do that.\n\n\tHWND fore_win = GetForegroundWindow();\n\t// Even if it's NULL, don't return since the legacy behavior is to continue on to the final part below.\n\n\tWindowSpec *win_spec = IsMember(fore_win, *g);\n\tif ( (mIsModeActivate && win_spec) || (!mIsModeActivate && !win_spec) )\n\t{\n\t\t// If the user is using a GroupActivate hotkey, we don't want to close\n\t\t// the foreground window if it's not a member of the group. Conversely,\n\t\t// if the user is using GroupDeactivate, we don't want to close a\n\t\t// member of the group. This precaution helps prevent accidental closing\n\t\t// of windows that suddenly pop up to the foreground just as you've\n\t\t// realized (too late) that you pressed the \"close\" hotkey.\n\t\t// MS Visual Studio/C++ gets messed up when it is directly sent a WM_CLOSE,\n\t\t// probably because the wrong window (it has two mains) is being sent the close.\n\t\t// But since that's the only app I've ever found that doesn't work right,\n\t\t// it seems best not to change our close method just for it because sending\n\t\t// keys is a fairly high overhead operation, and not without some risk due to\n\t\t// not knowing exactly what keys the user may have physically held down.\n\t\t// Also, we'd have to make this module dependent on the keyboard module,\n\t\t// which would be another drawback.\n\t\t// Try to wait for it to close, otherwise the same window may be activated\n\t\t// again before it has been destroyed, defeating the purpose of the\n\t\t// \"ActivateNext\" part of this function's job:\n\t\t// SendKeys(\"!{F4}\");\n\t\tif (fore_win)\n\t\t{\n\t\t\tWinClose(fore_win, 500);\n\t\t\tDoWinDelay;\n\t\t}\n\t\tif (mIsModeActivate)\n\t\t{\n\t\t\tHWND new_fore_win = GetForegroundWindow();\n\t\t\tif (new_fore_win != fore_win && IsMember(new_fore_win, *g))\n\t\t\t{\n\t\t\t\t// new_fore_win appears to have been activated as a result of closing fore_win.\n\t\t\t\t// Since new_fore_win belongs to the group, avoid activating some other window\n\t\t\t\t// even if !aStartWithMostRecent, since it would be a bit jarring. Historical\n\t\t\t\t// behaviour was to leave it active only if it belonged to the same *spec*,\n\t\t\t\t// which doesn't make a lot of sense.\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\t}\n\t//else do the activation below anyway, even though no close was done.\n\tif (mIsModeActivate)\n\t\tActivate(aStartWithMostRecent);\n\telse\n\t\tDeactivate(aStartWithMostRecent);\n}\n\n\n\nHWND WinGroup::Activate(bool aStartWithMostRecent)\n{\n\tif (IsEmpty())\n\t\treturn NULL;\n\tUpdate(true); // Update our private member vars.\n\tHWND active_window = GetForegroundWindow();\n\tbool group_is_active = IsMember(active_window, *g);\n\tif (!group_is_active) // Foreground window is not a member of this group.\n\t{\n\t\t// Reset the list of visited windows:\n\t\tsAlreadyVisitedCount = 0;\n\t}\n\n\t// Find the first/last unvisited window that matches any spec in the group.\n\tWindowSearch ws;\n\t// This next line is whether to find last or first match. We always find the oldest\n\t// (bottommost) match except when the user has specifically asked to start with the\n\t// most recent AND the group isn't currently active (i.e. we're starting fresh).\n\t// This allows the order to be the same each time the sequence repeats, instead of\n\t// reversing due to the nature of the window z-order.\n\tws.mFindLastMatch = !aStartWithMostRecent || group_is_active;\n\tws.mAlreadyVisited = sAlreadyVisited;\n\tws.mAlreadyVisitedCount = sAlreadyVisitedCount;\n\tws.SetCriteria(*g, *this);\n\n\tfor (bool retry_needed = sAlreadyVisitedCount > 0; ; retry_needed = false)\n\t{\n\t\tif (group_is_active) // Foreground window is a member of this group.\n\t\t{\n\t\t\t// Ensure the active window is excluded from both attempts to find a match.\n\t\t\tMarkAsVisited(active_window);\n\t\t}\n\t\tws.mAlreadyVisitedCount = sAlreadyVisitedCount;\n\t\tEnumWindows(EnumParentFind, (LPARAM)&ws);\n\t\tif (ws.mFoundParent)\n\t\t{\n\t\t\t// We found a window to activate, so we're done.\n\t\t\tSetForegroundWindowEx(ws.mFoundParent);\n\t\t\tMarkAsVisited(ws.mFoundParent);\n\t\t\tDoWinDelay;\n\t\t\treturn ws.mFoundParent;\n\t\t}\n\t\tif (!retry_needed)\n\t\t\tbreak;\n\t\t// Try again without excluding previously visited windows.\n\t\tsAlreadyVisitedCount = 0;\n\t}\n\t// No window was found to activate.\n\treturn NULL;\n}\n\n\n\nvoid WinGroup::Deactivate(bool aStartWithMostRecent)\n{\n\tUpdate(false); // Update our private member vars.\n\n\tHWND active_window = GetForegroundWindow();\n\t// Since EnumParentFindAnyExcept does not evaluate owned windows but one may have\n\t// been activated by a previous call, evaluate the owner of active_window, if any.\n\twhile (HWND owner = GetWindow(active_window, GW_OWNER))\n\t\tactive_window = owner;\n\tif (IsMember(active_window, *g))\n\t\tsAlreadyVisitedCount = 0;\n\n\t// Activate the next unvisited non-member:\n\tWindowSearch ws;\n\tws.mFindLastMatch = !aStartWithMostRecent || sAlreadyVisitedCount;\n\tws.mAlreadyVisited = sAlreadyVisited;\n\tws.mAlreadyVisitedCount = sAlreadyVisitedCount;\n\tws.mFirstWinSpec = mFirstWindow;\n\n\tEnumWindows(EnumParentFindAnyExcept, (LPARAM)&ws);\n\n\tif (ws.mFoundParent)\n\t{\n\t\t// Contrary to comments previously found here, a window that owns other windows can be\n\t\t// (and often is) activated, unless the window is also disabled. However, when the\n\t\t// window is activated via the Taskbar, Alt-Tab or due to closing or minimizing some\n\t\t// other window, the OS activates the *last active owned window* if it was active more\n\t\t// recently than the owner. Doing it this way will activate either the owner or one\n\t\t// of its owned windows, instead of the old way, activating *every one* of the owned\n\t\t// windows in turn and never the owner.\n\t\tSetForegroundWindowEx(GetLastActivePopup(ws.mFoundParent));\n\t\t// Probably best to do this before WinDelay in case another hotkey fires during the delay:\n\t\tMarkAsVisited(ws.mFoundParent); // Mark the found HWND, not necessarily the one that was activated.\n\t\tDoWinDelay;\n\t}\n\telse // No window was found to activate (they have all been visited).\n\t{\n\t\tif (sAlreadyVisitedCount)\n\t\t{\n\t\t\tbool wrap_around = (sAlreadyVisitedCount > 1);\n\t\t\tsAlreadyVisitedCount = 0;\n\t\t\tif (wrap_around)\n\t\t\t{\n\t\t\t\t// The user pressed a hotkey to do something, yet nothing has happened yet.\n\t\t\t\t// We want something to happen every time if there's a qualifying\n\t\t\t\t// \"something\" that we can do. And in this case there is: we can start\n\t\t\t\t// over again through the list, excluding the foreground window (which\n\t\t\t\t// the user has already had a chance to review):\n\t\t\t\tMarkAsVisited(active_window);\n\t\t\t\t// Make a recursive call to self. This can't result in an infinite\n\t\t\t\t// recursion (stack fault) because the called layer will only\n\t\t\t\t// recurse a second time if sAlreadyVisitedCount > 1, which is\n\t\t\t\t// impossible with the current logic:\n\t\t\t\tDeactivate(false); // Seems best to ignore aStartWithMostRecent in this case?\n\t\t\t}\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Since there are apparently no eligible windows, deactivate the window by\n\t\t\t// activating the taskbar, which is usually what happens when you minimize\n\t\t\t// the last non-minimized top-level window.\n\t\t\tSetForegroundWindowEx(FindWindow(_T(\"Shell_TrayWnd\"), nullptr));\n\t\t}\n\t}\n}\n\n\n\ninline void WinGroup::Update(bool aIsModeActivate)\n{\n\tmIsModeActivate = aIsModeActivate;\n\tif (sGroupLastUsed != this)\n\t{\n\t\tsGroupLastUsed = this;\n\t\tsAlreadyVisitedCount = 0; // Since it's a new group, reset the array to start fresh.\n\t}\n\tif (!sAlreadyVisited) // Allocate the array on first use.\n\t\t// Getting it from SimpleHeap reduces overhead for the avg. case (i.e. the first\n\t\t// block of SimpleHeap is usually never fully used, and this array won't even\n\t\t// be allocated for short scripts that don't even use window groups.\n\t\tsAlreadyVisited = SimpleHeap::Alloc<HWND>(MAX_ALREADY_VISITED);\n}\n\n\n\nWindowSpec *WinGroup::IsMember(HWND aWnd, ScriptThreadSettings &aSettings)\n// Thread-safety: This function is thread-safe even when the main thread happens to be calling AddWindow()\n// and changing the linked list while it's being traversed here by the hook thread. However, any subsequent\n// changes to this function or AddWindow() must be carefully reviewed.\n// Although our caller may be a WindowSearch method, and thus we might make\n// a recursive call back to that same method, things have been reviewed to ensure that\n// thread-safety is maintained, even if the calling thread is the hook.\n{\n\tif (!aWnd)\n\t\treturn NULL; // Some callers on this.\n\tWindowSearch ws;\n\tws.SetCandidate(aWnd);\n\tfor (WindowSpec *win = mFirstWindow; win != NULL;) // v1.0.41: \"win != NULL\" was added for thread-safety.\n\t{\n\t\tif (ws.SetCriteria(aSettings, win->mTitle, win->mText, win->mExcludeTitle, win->mExcludeText) && ws.IsMatch())\n\t\t\treturn win;\n\t\t// Otherwise, no match, so go onto the next one:\n\t\twin = win->mNextWindow;\n\t\tif (!win || win == mFirstWindow) // v1.0.41: The check of !win was added for thread-safety.\n\t\t\t// We've made one full circuit of the circular linked list,\n\t\t\t// discovering that the foreground window isn't a member\n\t\t\t// of the group:\n\t\t\tbreak;\n\t}\n\treturn NULL; // Because it would have returned already if a match was found.\n}\n\n\n/////////////////////////////////////////////////////////////////////////\n\n\nBOOL CALLBACK EnumParentFindAnyExcept(HWND aWnd, LPARAM lParam)\n// Find the first parent window that doesn't match any of the WindowSpecs in\n// the linked list, and that hasn't already been visited.\n{\n\t// Since the following two sections apply only to GroupDeactivate (since that's our only caller),\n\t// they both seem okay even in light of the ahk_group method.\n\n\tDWORD style = GetWindowLong(aWnd, GWL_STYLE);\n\tif (!(style & WS_VISIBLE) || (style & WS_DISABLED) && GetLastActivePopup(aWnd) == aWnd)\n\t\t// Skip hidden windows because we always want them to stay invisible, regardless\n\t\t// of the setting for g->DetectHiddenWindows. v2.0: Also skip disabled windows,\n\t\t// except those which own a popup window (such as a modal dialog).\n\t\t// Since these are top-level windows, IsWindowVisible() shouldn't be necessary.\n\t\treturn TRUE;\n\n\t// UPDATE: Because the window of class Shell_TrayWnd (the taskbar) is also always-on-top,\n\t// the below prevents it from ever being activated too, which is almost always desirable.\n\t// Skip always-on-top windows, such as SplashText, because probably shouldn't\n\t// be activated (especially in this mode, which is often used to visit the user's\n\t// \"non-favorite\" windows). In addition, they're already visible so the user already\n\t// knows about them, so there's no need to have them presented for review.\n\t// v2.0:\n\t// - Windows with WS_EX_NOACTIVATE are excluded because they probably aren't intended\n\t// to be activated. Past testing indicated they were omitted from Alt-Tab and/or\n\t// the taskbar on some OSes, but there must be some other factor as I currently can't\n\t// reproduce that. However, they are skipped by the Alt+Esc/Alt+Shift+Esc hotkeys.\n\t// - Windows with WS_EX_TOOLWINDOW but without WS_EX_APPWINDOW are excluded from the\n\t// taskbar and Alt-Tab. They are also usually owned anyway, except for the WorkerW\n\t// window which contains some of the Desktop content on Windows 10 (and 7, but it's\n\t// hidden there). Excluding this style avoids the need to check for WorkerW, which\n\t// also means we don't need to retrieve the window class.\n\tDWORD ex_style = GetWindowLong(aWnd, GWL_EXSTYLE);\n\tif ((ex_style & (WS_EX_TOPMOST | WS_EX_NOACTIVATE))\n\t\t|| (ex_style & (WS_EX_TOOLWINDOW | WS_EX_APPWINDOW)) == WS_EX_TOOLWINDOW)\n\t\treturn TRUE;\n\n\t// Exclude owned windows. The owner should be considered by a subsequent call.\n\t// If eligible, either the owner or its last active owned window will be activated.\n\tif (GetWindow(aWnd, GW_OWNER))\n\t\treturn TRUE;\n\n\tif (IsWindowCloaked(aWnd)) // This is probably higher cost than the style checks, so done after.\n\t\treturn TRUE;\n\t\n\t// Skip \"Program Manager\" (the Desktop) because the user probably doesn't want it\n\t// activated (although that would serve the purpose of deactivating any other window).\n\tif (aWnd == GetShellWindow())\n\t\treturn TRUE;\n\n\tWindowSearch &ws = *(WindowSearch *)lParam; // For performance and convenience.\n\tws.SetCandidate(aWnd);\n\n\t// Check this window's attributes against each set of criteria present in the group. If\n\t// it's a match for any set of criteria, it's a member of the group and thus should be\n\t// excluded since we want only NON-members:\n\tfor (WindowSpec *win = ws.mFirstWinSpec;;)\n\t{\n\t\t// For each window in the linked list, check if aWnd is a match for it:\n\t\tif (ws.SetCriteria(*g, win->mTitle, win->mText, win->mExcludeTitle, win->mExcludeText) && ws.IsMatch(true))\n\t\t\t// Match found, so aWnd is a member of the group. But we want to find non-members only,\n\t\t\t// so keep searching:\n\t\t\treturn TRUE;\n\t\t// Otherwise, no match, but keep checking until aWnd has been compared against\n\t\t// all the WindowSpecs in the group:\n\t\twin = win->mNextWindow;\n\t\tif (win == ws.mFirstWinSpec)\n\t\t{\n\t\t\t// We've made one full circuit of the circular linked list without\n\t\t\t// finding a match. So aWnd is the one we're looking for unless\n\t\t\t// it's in the list of exceptions:\n\t\t\tfor (int i = 0; i < ws.mAlreadyVisitedCount; ++i)\n\t\t\t\tif (aWnd == ws.mAlreadyVisited[i])\n\t\t\t\t\treturn TRUE; // It's an exception, so keep searching.\n\t\t\t// Otherwise, this window meets the criteria, so return it to the caller and\n\t\t\t// stop the enumeration. UPDATE: Rather than stopping the enumeration,\n\t\t\t// continue on through all windows so that the last match is found.\n\t\t\t// That makes things nicer because when the sequence wraps around to the\n\t\t\t// beginning, the windows will occur in the same order that they did\n\t\t\t// the first time, rather than going backwards through the sequence\n\t\t\t// (which is counterintuitive for the user):\n\t\t\tws.mFoundParent = aWnd; // No need to increment ws.mFoundCount in this case.\n\t\t\treturn ws.mFindLastMatch;\n\t\t}\n\t} // The loop above is infinite unless a \"return\" is encountered inside.\n}\n\n\n\nBOOL CALLBACK EnumParentActUponAll(HWND aWnd, LPARAM lParam)\n// Caller must have ensured that lParam isn't NULL and that it contains a non-NULL mFirstWinSpec.\n{\n\tWindowSearch &ws = *(WindowSearch *)lParam; // For performance and convenience.\n\n\t// Skip windows the command isn't supposed to detect. ACT_WINSHOW is exempt because\n\t// hidden windows are always detected by the WinShow command:\n\tif (!(ws.mActionType == FID_WinShow || g->DetectWindow(aWnd)))\n\t\treturn TRUE;\n\n\tint nCmdShow;\n\tws.SetCandidate(aWnd);\n\n\tfor (WindowSpec *win = ws.mFirstWinSpec;;)\n\t{\n\t\t// For each window in the linked list, check if aWnd is a match for it:\n\t\tif (ws.SetCriteria(*g, win->mTitle, win->mText, win->mExcludeTitle, win->mExcludeText) && ws.IsMatch())\n\t\t{\n\t\t\t// Match found, so aWnd is a member of the group. In addition, IsMatch() has set\n\t\t\t// the value of ws.mFoundParent to tell our caller that at least one window was acted upon.\n\t\t\t// See BIF_WinShow for comments about the following section.\n\t\t\tnCmdShow = SW_NONE; // Set default each time.\n\t\t\tswitch (ws.mActionType)\n\t\t\t{\n\t\t\tcase FID_WinClose:\n\t\t\tcase FID_WinKill:\n\t\t\t\t// mTimeToWaitForClose is not done in a very efficient way here: to keep code size\n\t\t\t\t// in check, it closes each window individually rather than sending WM_CLOSE to all\n\t\t\t\t// the windows simultaneously and then waiting until all have vanished:\n\t\t\t\tWinClose(aWnd, ws.mTimeToWaitForClose, ws.mActionType == FID_WinKill); // DoWinDelay is done by our caller.\n\t\t\t\treturn TRUE; // All done with the current window, so fetch the next one.\n\n\t\t\tcase FID_WinMinimize:\n\t\t\t\tif (IsWindowHung(aWnd))\n\t\t\t\t\tnCmdShow = SW_FORCEMINIMIZE;\n\t\t\t\telse\n\t\t\t\t\tnCmdShow = SW_MINIMIZE;\n\t\t\t\tbreak;\n\n\t\t\tcase FID_WinMaximize: if (!IsWindowHung(aWnd)) nCmdShow = SW_MAXIMIZE; break;\n\t\t\tcase FID_WinRestore: if (!IsWindowHung(aWnd)) nCmdShow = SW_RESTORE; break;\n\t\t\tcase FID_WinHide: nCmdShow = SW_HIDE; break;\n\t\t\tcase FID_WinShow: nCmdShow = SW_SHOW; break;\n\t\t\t}\n\n\t\t\tif (nCmdShow != SW_NONE)\n\t\t\t\tShowWindow(aWnd, nCmdShow);\n\t\t\t\t// DoWinDelay is not done here because our caller will do it once only, which\n\t\t\t\t// seems best when there are a lot of windows being acted upon here.\n\n\t\t\t// Now that this matching window has been acted upon (or avoided due to being hung),\n\t\t\t// continue the enumeration to get the next candidate window:\n\t\t\treturn TRUE;\n\t\t}\n\t\t// Otherwise, no match, keep checking until aWnd has been compared against all the WindowSpecs in the group:\n\t\twin = win->mNextWindow;\n\t\tif (win == ws.mFirstWinSpec)\n\t\t\t// We've made one full circuit of the circular linked list without\n\t\t\t// finding a match, so aWnd is not a member of the group and\n\t\t\t// should not be closed.\n\t\t\treturn TRUE; // Continue the enumeration.\n\t}\n}\n"},"size":{"kind":"number","value":21335,"string":"21,335"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":425,"string":"425"},"avg_line_length":{"kind":"number","value":47.4,"string":"47.4"},"max_line_length":{"kind":"number","value":112,"string":"112"},"alphanum_fraction":{"kind":"number","value":0.7396517818600412,"string":"0.739652"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11095,"cells":{"id":{"kind":"number","value":16085,"string":"16,085"},"file_name":{"kind":"string","value":"script_expression.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/script_expression.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n//////////////////////////////////////////////////////////////////////////////////////\n// v1.0.40.02: This is now a separate file to allow its compiler optimization settings\n// to be set independently of those of the other modules. In one benchmark, this\n// improved performance of expressions and function calls by 9% (that is, when the\n// other modules are set to \"minimize size\" such as for the AutoHotkeySC.bin file).\n// This gain in performance is at the cost of a 1.5 KB increase in the size of the\n// compressed code, which seems well worth it given how often expressions and\n// function-calls are used (such as in loops).\n//\n// ExpandArgs() and related functions were also put into this file because that\n// further improves performance across the board -- even for AutoHotkey.exe despite\n// the fact that the only thing that changed for it was the module move, not the\n// compiler settings. Apparently, the butterfly effect can cause even minor\n// modifications to impact the overall performance of the generated code by as much as\n// 7%. However, this might have more to do with cache hits and misses in the CPU than\n// with the nature of the code produced by the compiler.\n// UPDATE 10/18/2006: There's not much difference anymore -- in fact, using min size\n// for everything makes compiled scripts slightly faster in basic benchmarks, probably\n// due to the recent addition of the linker optimization that physically orders\n// functions in a better order inside the EXE. Therefore, script_expression.cpp no\n// longer has a separate \"favor fast code\" option.\n//////////////////////////////////////////////////////////////////////////////////////\n\n#include \"stdafx.h\" // pre-compiled headers\n#include \"script.h\"\n#include \"script_object.h\"\n#include \"globaldata.h\" // for a lot of things\n#include \"qmath.h\" // For ExpandExpression()\n\n// __forceinline: Decided against it for this function because although it's only called by one caller,\n// testing shows that it wastes stack space (room for its automatic variables would be unconditionally \n// reserved in the stack of its caller). Also, the performance benefit of inlining this is too slight.\n// Here's a simple way to verify wasted stack space in a caller that calls an inlined function:\n// DWORD stack\n// _asm mov stack, esp\n// MsgBox(stack);\nLPTSTR Line::ExpandExpression(int aArgIndex, ResultType &aResult, ResultToken *aResultToken\n\t\t, LPTSTR &aTarget, LPTSTR &aDerefBuf, size_t &aDerefBufSize, LPTSTR aArgDeref[], size_t aExtraSize)\n// Caller should ignore aResult unless this function returns NULL.\n// Returns a pointer to this expression's result, which can be one of the following:\n// 1) NULL, in which case aResult will be either FAIL or EARLY_EXIT to indicate the means by which the current\n// quasi-thread was terminated as a result of a function call.\n// 2) The constant empty string (\"\"), in which case we do not alter aTarget for our caller.\n// 3) Some persistent location not in aDerefBuf, namely the mContents of a variable or a literal string/number,\n// such as a function-call that returns \"abc\", 123, or a variable.\n// 4) At position aTarget inside aDerefBuf (note that aDerefBuf might have been reallocated by us).\n// aTarget is left unchanged except in case #4, in which case aTarget has been adjusted to the position after our\n// result-string's terminator. In addition, in case #4, aDerefBuf, aDerefBufSize, and aArgDeref[] have been adjusted\n// for our caller if aDerefBuf was too small and needed to be enlarged.\n//\n// Thanks to Joost Mulders for providing the expression evaluation code upon which this function is based.\n{\n\tLPTSTR target = aTarget; // \"target\" is used to track our usage (current position) within the aTarget buffer.\n\n\t// The following must be defined early so that to_free_count is initialized and the array is guaranteed to be\n\t// \"in scope\" in case of early \"goto\" (goto substantially boosts performance and reduces code size here).\n\tExprTokenType **to_free = (ExprTokenType **)_alloca(mArg[aArgIndex].max_alloc * sizeof(ExprTokenType *));\n\tint to_free_count = 0; // The actual number of items in use in the above array.\n\tLPTSTR result_to_return = _T(\"\"); // By contrast, NULL is used to tell the caller to abort the current thread.\n\tLPCTSTR error_msg = ERR_EXPR_EVAL, error_info = _T(\"\");\n\tExprTokenType *error_value;\n\tVar *output_var = (mActionType == ACT_ASSIGNEXPR) ? VAR(mArg[0]) : NULL; // Resolve early because it's similar in usage/scope to the above.\n\n\tExprTokenType **stack = (ExprTokenType **)_alloca(mArg[aArgIndex].max_stack * sizeof(ExprTokenType *));\n\tint stack_count = 0;\n\tExprTokenType *&postfix = mArg[aArgIndex].postfix;\n\n\t///////////////////////////////\n\t// EVALUATE POSTFIX EXPRESSION\n\t///////////////////////////////\n\tint i, delta;\n\tSymbolType right_is_number, left_is_number, right_is_pure_number, left_is_pure_number, result_symbol;\n\tdouble right_double, left_double;\n\t__int64 right_int64, left_int64;\n\tLPTSTR right_string, left_string;\n\tsize_t right_length, left_length;\n\tTCHAR left_buf[max(MAX_NUMBER_SIZE, _f_retval_buf_size)];\n\tTCHAR right_buf[MAX_NUMBER_SIZE];\n\tLPTSTR result; // \"result\" is used for return values and also the final result.\n\tVarSizeType result_length;\n\tsize_t result_size, alloca_usage = 0; // v1.0.45: Track amount of alloca mem to avoid stress on stack from extreme expressions (mostly theoretical).\n\tBOOL done, done_and_have_an_output_var, left_branch_is_true\n\t\t, left_was_negative, is_pre_op; // BOOL vs. bool benchmarks slightly faster, and is slightly smaller in code size (or maybe it's cp1's int vs. char that shrunk it).\n\tExprTokenType *this_postfix, *p_postfix;\n\tVar *sym_assign_var, *temp_var;\n\n\t// v1.0.44.06: EXPR_SMALL_MEM_LIMIT is the means by which _alloca() is used to boost performance a\n\t// little by avoiding the overhead of malloc+free for small strings. The limit should be something\n\t// small enough that the chance that even 10 of them would cause stack overflow is vanishingly small.\n\t#define EXPR_SMALL_MEM_LIMIT 4097 // The maximum size allowed for an item to qualify for alloca.\n\t#define EXPR_ALLOCA_LIMIT 40000 // The maximum amount of alloca memory for all items. v1.0.45: An extra precaution against stack stress in extreme/theoretical cases.\n\t#define EXPR_IS_DONE (!stack_count && this_postfix[1].symbol == SYM_INVALID) // True if we've used up the last of the operators & operands. Non-zero stack_count combined with SYM_INVALID would indicate an error (an exception will be thrown later, so don't take any shortcuts).\n\n\t// For each item in the postfix array: if it's an operand, push it onto stack; if it's an operator or\n\t// function call, evaluate it and push its result onto the stack. SYM_INVALID is the special symbol\n\t// that marks the end of the postfix array.\n\tfor (this_postfix = postfix; this_postfix->symbol != SYM_INVALID; ++this_postfix) // Using pointer vs. index (e.g. postfix[i]) reduces OBJ code size by ~122 and seems to perform at least as well.\n\t{\n\t\t// Set default early to simplify the code. All struct members may be needed. Also, this_token is used\n\t\t// almost everywhere further below in preference to this_postfix because:\n\t\t// 1) The various SYM_ASSIGN_* operators (e.g. SYM_ASSIGN_CONCAT) are changed to different operators\n\t\t// to simplify the code. So must use the changed/new value in this_token, not the original value in\n\t\t// this_postfix.\n\t\t// 2) Using a particular variable very frequently might help compiler to optimize that variable to\n\t\t// generate faster code.\n\t\t// 3) It might help performance due to locality of reference/CPU caching (this_token is on the stack).\n\t\tExprTokenType &this_token = *(ExprTokenType *)_alloca(sizeof(ExprTokenType)); // Saves a lot of stack space, and seems to perform just as well as something like the following (at the cost of ~82 byte increase in OBJ code size): ExprTokenType &this_token = new_token[new_token_count++]\n\t\tthis_token.CopyExprFrom(*this_postfix); // See comment section above.\n\n\t\tif (IS_OPERAND(this_token.symbol)) // If it's an operand, just push it onto stack for use by an operator in a future iteration.\n\t\t{\n\t\t\tif (this_token.symbol == SYM_DYNAMIC) // Dynamic variable reference.\n\t\t\t{\n\t\t\t\tif (!stack_count) // Prevent stack underflow.\n\t\t\t\t\tgoto abort_with_exception;\n\t\t\t\tExprTokenType &right = *STACK_POP;\n\t\t\t\tif (auto right_obj = TokenToObject(right))\n\t\t\t\t{\n\t\t\t\t\tif (right_obj->Base() == Object::sVarRefPrototype)\n\t\t\t\t\t\ttemp_var = static_cast<VarRef *>(right_obj);\n\t\t\t\t\telse\n\t\t\t\t\t\ttemp_var = new (_alloca(sizeof(Var))) Var(right_obj);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tright_string = TokenToString(right, right_buf, &right_length);\n\t\t\t\t\t// Do some basic validation to ensure a helpful error message is displayed on failure.\n\t\t\t\t\tif (right_length == 0)\n\t\t\t\t\t{\n\t\t\t\t\t\terror_msg = ERR_DYNAMIC_BLANK;\n\t\t\t\t\t\terror_info = mArg[aArgIndex].text;\n\t\t\t\t\t\tgoto abort_with_exception;\n\t\t\t\t\t}\n\t\t\t\t\t// v2.0: Use of FindVar() vs. FindOrAddVar() makes this check unnecessary.\n\t\t\t\t\t//if (right_length > MAX_VAR_NAME_LENGTH)\n\t\t\t\t\t//{\n\t\t\t\t\t//\terror_msg = ERR_DYNAMIC_TOO_LONG;\n\t\t\t\t\t//\terror_info = right_string;\n\t\t\t\t\t//\tgoto abort_with_exception;\n\t\t\t\t\t//}\n\t\t\t\t\t// v2.0: Dynamic creation of variables is not permitted, so FindOrAddVar() is not used.\n\t\t\t\t\tif (!(temp_var = g_script.FindVar(right_string, right_length\n\t\t\t\t\t\t, VARREF_IS_WRITE(this_token.var_usage) ? FINDVAR_FOR_WRITE : FINDVAR_FOR_READ)))\n\t\t\t\t\t{\n\t\t\t\t\t\tif (this_token.var_usage == VARREF_ISSET) // this_token is to be passed to IsSet().\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tASSERT(this_postfix[1].symbol == SYM_FUNC);\n\t\t\t\t\t\t\t++this_postfix; // Skip the actual IsSet call since we're pushing its result directly.\n\t\t\t\t\t\t\tthis_token.SetValue(FALSE);\n\t\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (this_token.var_usage == VARREF_READ_MAYBE)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tthis_token.symbol = SYM_MISSING;\n\t\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (g->CurrentFunc && g_script.FindGlobalVar(right_string, right_length))\n\t\t\t\t\t\t\terror_msg = ERR_DYNAMIC_BAD_GLOBAL;\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\terror_msg = ERR_DYNAMIC_NOT_FOUND;\n\t\t\t\t\t\terror_info = right_string;\n\t\t\t\t\t\tgoto abort_with_exception;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t// var_usage was already validated for non-dynamic variables. SYM_REF relies on this check.\n\t\t\t\t// It also flags invalid assignments, but those can be handled by Var::Assign() anyway.\n\t\t\t\tif (!ValidateVarUsage(temp_var, this_token.var_usage))\n\t\t\t\t\tgoto abort;\n\t\t\t\tthis_token.var = temp_var;\n\t\t\t\tthis_token.symbol = SYM_VAR;\n\t\t\t}\n\t\t\tif (this_token.symbol == SYM_VAR && (!VARREF_IS_WRITE(this_token.var_usage) || this_token.var_usage == VARREF_LVALUE_MAYBE))\n\t\t\t{\n\t\t\t\tif (this_token.var->IsVirtual() && VARREF_IS_READ(this_token.var_usage))\n\t\t\t\t{\n\t\t\t\t\t// FUTURE: This should be merged with the SYM_FUNC handling at some point to improve\n\t\t\t\t\t// maintainability, reduce code size, and take advantage of SYM_FUNC's optimizations.\n\t\t\t\t\tResultToken result_token;\n\t\t\t\t\tresult_token.InitResult(left_buf);\n\n\t\t\t\t\t// Call this virtual variable's getter.\n\t\t\t\t\tthis_token.var->Get(result_token);\n\n\t\t\t\t\tif (result_token.Exited())\n\t\t\t\t\t{\n\t\t\t\t\t\taResult = result_token.Result(); // See similar section under SYM_FUNC for comments.\n\t\t\t\t\t\tresult_to_return = NULL;\n\t\t\t\t\t\tgoto normal_end_skip_output_var;\n\t\t\t\t\t}\n\n\t\t\t\t\tif (result_token.symbol != SYM_STRING || result_token.marker_length == 0)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (result_token.symbol == SYM_MISSING && this_token.var_usage != VARREF_READ_MAYBE)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\terror_value = &this_token;\n\t\t\t\t\t\t\tgoto unset_var;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (result_token.symbol == SYM_OBJECT)\n\t\t\t\t\t\t\tto_free[to_free_count++] = &this_token; // A slot was reserved for this SYM_VAR.\n\t\t\t\t\t\tthis_token.CopyValueFrom(result_token);\n\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t}\n\n\t\t\t\t\tresult_length = result_token.marker_length;\n\t\t\t\t\tif (result_length == -1)\n\t\t\t\t\t\tresult_length = _tcslen(result_token.marker);\n\n\t\t\t\t\tif (result_token.marker != left_buf)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (result_token.mem_to_free) // Persistent memory was already allocated for the result.\n\t\t\t\t\t\t\tto_free[to_free_count++] = &this_token; // A slot was reserved for this SYM_VAR.\n\t\t\t\t\t\t\t// Also push the value, below.\n\t\t\t\t\t\t//else: Currently marker is assumed to point to persistent memory, such as a literal\n\t\t\t\t\t\t// string, which should be safe to use at least until expression evaluation completes.\n\t\t\t\t\t\tthis_token.SetValue(result_token.marker, result_length);\n\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t}\n\n\t\t\t\t\tresult_size = 1 + result_length;\n\t\t\t\t\tif (result_size <= (int)(aDerefBufSize - (target - aDerefBuf))) // There is room at the end of our deref buf, so use it.\n\t\t\t\t\t{\n\t\t\t\t\t\tresult = target; // Point result to its new, more persistent location.\n\t\t\t\t\t\ttarget += result_size; // Point it to the location where the next string would be written.\n\t\t\t\t\t}\n\t\t\t\t\telse // if (result_size < EXPR_SMALL_MEM_LIMIT && alloca_usage < EXPR_ALLOCA_LIMIT) // See comments at EXPR_SMALL_MEM_LIMIT.\n\t\t\t\t\t{\t// Above: Anything longer than MAX_NUMBER_SIZE can't be in left_buf and therefore\n\t\t\t\t\t\t// was already handled above. alloca_usage is a safeguard but not an absolute limit.\n\t\t\t\t\t\tresult = (LPTSTR)talloca(result_size);\n\t\t\t\t\t\talloca_usage += result_size; // This might put alloca_usage over the limit by as much as EXPR_SMALL_MEM_LIMIT, but that is fine because it's more of a guideline than a limit.\n\t\t\t\t\t}\n\t\t\t\t\ttmemcpy(result, result_token.marker, result_length + 1);\n\t\t\t\t\tthis_token.SetValue(result, result_length);\n\t\t\t\t\tgoto push_this_token;\n\t\t\t\t} // end if (reading a var of type VAR_VIRTUAL)\n\t\t\t\tif (this_token.var->IsUninitialized())\n\t\t\t\t{\n\t\t\t\t\tif (this_token.var->Type() == VAR_CONSTANT)\n\t\t\t\t\t{\n\t\t\t\t\t\tauto result = this_token.var->InitializeConstant();\n\t\t\t\t\t\tif (result != OK)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\taResult = result;\n\t\t\t\t\t\t\tresult_to_return = NULL;\n\t\t\t\t\t\t\tgoto normal_end_skip_output_var;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\telse if (this_token.var_usage == VARREF_READ)\n\t\t\t\t\t{\n\t\t\t\t\t\t// The expression is always aborted in this case, even if the user chooses to continue the thread.\n\t\t\t\t\t\t// If this is changed, check all other callers of unset_var and VarUnsetError() for consistency.\n\t\t\t\t\t\terror_value = &this_token;\n\t\t\t\t\t\tgoto unset_var;\n\t\t\t\t\t}\n\t\t\t\t\telse if (this_token.var_usage == VARREF_READ_MAYBE)\n\t\t\t\t\t{\n\t\t\t\t\t\tthis_token.symbol = SYM_MISSING;\n\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t}\n\t\t\t\t\telse if (this_token.var_usage == VARREF_LVALUE_MAYBE)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Skip the short-circuit operator and push the variable onto the stack for assignment.\n\t\t\t\t\t\t++this_postfix;\n\t\t\t\t\t\tASSERT(this_postfix->symbol == SYM_OR_MAYBE);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tgoto push_this_token;\n\t\t} // if (IS_OPERAND(this_token.symbol))\n\n\t\tif (this_token.symbol == SYM_FUNC)\n\t\t{\n\t\t\tIObject *func = this_token.callsite->func; // For convenience and because any modifications should not be persistent.\n\t\t\tauto member = this_token.callsite->member;\n\t\t\tauto flags = this_token.callsite->flags;\n\t\t\tauto param_count = this_token.callsite->param_count;\n\t\t\tif (param_count > stack_count) // Prevent stack underflow (probably impossible if actual_param_count is accurate).\n\t\t\t\tgoto abort_with_exception;\n\t\t\t// Adjust the stack early to simplify. Above already confirmed that the following won't underflow.\n\t\t\t// Pop the actual number of params involved in this function-call off the stack.\n\t\t\tint prev_stack_count = stack_count;\n\t\t\tstack_count -= param_count;\n\t\t\tExprTokenType **params = stack + stack_count;\n\t\t\tExprTokenType *func_token;\n\n\t\t\tif (flags & EIF_STACK_MEMBER)\n\t\t\t{\n\t\t\t\tif (!stack_count)\n\t\t\t\t\tgoto abort_with_exception;\n\t\t\t\tstack_count--;\n\t\t\t\tflags &= ~EIF_STACK_MEMBER;\n\t\t\t\tif (stack[stack_count]->symbol != SYM_MISSING)\n\t\t\t\t{\n\t\t\t\t\tmember = TokenToString(*stack[stack_count], right_buf);\n\t\t\t\t\tif (!*member && TokenToObject(*stack[stack_count]))\n\t\t\t\t\t{\n\t\t\t\t\t\terror_info = _T(\"String\");\n\t\t\t\t\t\terror_value = stack[stack_count];\n\t\t\t\t\t\tgoto type_mismatch;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (func)\n\t\t\t{\n\t\t\t\tfunc_token = (ExprTokenType *)_alloca(sizeof(ExprTokenType));\n\t\t\t\tfunc_token->SetValue(func);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// This is a dynamic function call.\n\t\t\t\tif (!stack_count)\n\t\t\t\t\tgoto abort_with_exception;\n\t\t\t\tstack_count--;\n\t\t\t\tfunc_token = stack[stack_count];\n\t\t\t\tfunc = TokenToObject(*func_token);\n\t\t\t\tif (!func)\n\t\t\t\t{\n\t\t\t\t\tif (func_token->symbol == SYM_SUPER)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Invoke the super-class but pass the current function's \"this\".\n\t\t\t\t\t\tASSERT(g->CurrentFunc && g->CurrentFunc->mClass);\n\t\t\t\t\t\tfunc = g->CurrentFunc->mClass->Base();\n\t\t\t\t\t\tASSERT(func);\n\t\t\t\t\t\tfunc_token->SetVar(g->CurrentFunc->mParam[0].var);\n\t\t\t\t\t\tflags |= IF_SUPER;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\t// Invoke a substitute object but pass func_token as \"this\".\n\t\t\t\t\t\tfunc = Object::ValueBase(*func_token);\n\t\t\t\t\t\tflags |= IF_SUBSTITUTE_THIS;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (!func) // Possible for SYM_MISSING in cases that currently can't be detected at load-time, like (a ? unset : b).\n\t\t\t\t\tgoto abort_with_exception;\n\t\t\t}\n\n\t\t\t// The following two steps are done for built-in functions inside Func::Call:\n\t\t\t//result_token.symbol = SYM_INTEGER; // Set default return type so that functions don't have to do it if they return INTs.\n\t\t\t//result_token.func = func; // Inform function of which built-in function called it (allows code sharing/reduction).\n\t\t\t\n\t\t\t// This is done by ResultToken below:\n\t\t\t//result_token.buf = left_buf; // mBIF() can use this to store a string result, and for other purposes.\n\t\t\t//result_token.mem_to_free = NULL; // Init to detect whether the called function allocates it.\n\t\t\t\n\t\t\tResultToken result_token;\n\t\t\tresult_token.InitResult(left_buf); // But we'll take charge of its contents INSTEAD of calling Free().\n\n\t\t\t// Invoke the function or object.\n\t\t\tbool keep_alive = func_token->symbol == SYM_VAR;\n\t\t\tif (keep_alive) // Might help performance to avoid these virtual calls in common cases.\n\t\t\t\tfunc->AddRef(); // Ensure the object isn't deleted during the call, by an assignment.\n\t\t\tResultType invoke_result;\n\t\t\tif (flags & EIF_VARIADIC)\n\t\t\t\tinvoke_result = VariadicCall(func, result_token, flags, member, *func_token, params, param_count);\n\t\t\telse\n\t\t\t\tinvoke_result = func->Invoke(result_token, flags, member, *func_token, params, param_count);\n\t\t\tif (keep_alive)\n\t\t\t\tfunc->Release();\n\n\t\t\tswitch (invoke_result)\n\t\t\t{\n\t\t\tcase FAIL:\n\t\t\tcase EARLY_EXIT:\n\t\t\t\taResult = invoke_result;\n\t\t\t\tresult_to_return = NULL; // Use NULL to inform our caller that this thread is finished (whether through normal means such as Exit or a critical error).\n\t\t\t\t// Above: The callers of this function know that the value of aResult (which already contains the\n\t\t\t\t// reason for early exit) should be considered valid/meaningful only if result_to_return is NULL.\n\t\t\t\tgoto normal_end_skip_output_var; // output_var is left unchanged in these cases.\n\t\t\tcase INVOKE_NOT_HANDLED:\n\t\t\t\tif (!(flags & EIF_UNSET_PROP))\n\t\t\t\t{\n\t\t\t\t\tresult_token.UnknownMemberError(*func_token, flags, member);\n\t\t\t\t\taResult = result_token.Result(); // FAIL to abort, OK if user or OnError requested continuation.\n\t\t\t\t\tgoto abort_if_result;\n\t\t\t\t}\n\t\t\t\t// For something like (a.b?) or (a.b ?? c), INVOKE_NOT_HANDLED is treated as unset.\n\t\t\t\tresult_token.symbol = SYM_MISSING;\n\t\t\t}\n\n\t\t\tg_script.mCurrLine = this; // For error-reporting.\n\t\t\t\n\t\t\tif ((flags & EIF_LEAVE_PARAMS)\n\t\t\t\t&& (!(flags & EIF_UNSET_RETURN) || result_token.symbol == SYM_MISSING))\n\t\t\t\t// Leave params on the stack for the next part of a compound assignment.\n\t\t\t\t// The combination of (EIF_LEAVE_PARAMS | EIF_UNSET_RETURN) implies this is\n\t\t\t\t// something like the `x.y` in `x.y ??= z`, which needs to take the params\n\t\t\t\t// off the stack if it's going to short-circuit (i.e. result is unset).\n\t\t\t\tstack_count = prev_stack_count;\n\t\t\t\n\t\t\tif (flags & IT_SET)\n\t\t\t{\n\t\t\t\tresult_token.Free();\n\t\t\t\tauto &value = *params[param_count - 1];\n\t\t\t\t// value came from a previous part of this expression, so it's already in to_free[]\n\t\t\t\t// if appropriate, and we can just push it back onto the stack.\n\t\t\t\tthis_token.CopyValueFrom(value);\n\t\t\t\tgoto push_this_token;\n\t\t\t}\n\n\t\t\tif (result_token.symbol != SYM_STRING)\n\t\t\t{\n\t\t\t\tif (result_token.symbol == SYM_MISSING && !(flags & EIF_UNSET_RETURN))\n\t\t\t\t{\n\t\t\t\t\tresult_token.Error(_T(\"No value was returned.\")\n\t\t\t\t\t\t, this_token.error_reporting_marker\n\t\t\t\t\t\t, (flags & IT_BITMASK) == IT_GET && !member ? ErrorPrototype::UnsetItem : ErrorPrototype::Unset);\n\t\t\t\t\taResult = result_token.Result(); // FAIL to abort, OK if user or OnError requested continuation.\n\t\t\t\t\tgoto abort_if_result;\n\t\t\t\t}\n\t\t\t\t// No need for make_result_persistent or early Assign(). Any numeric or object result can\n\t\t\t\t// be considered final because it's already stored in permanent memory (the token itself).\n\t\t\t\t// Additionally, this_token.mem_to_free is assumed to be NULL since the result is not\n\t\t\t\t// a string; i.e. the function would've had no need to return memory to us.\n\t\t\t\tthis_token.value_int64 = result_token.value_int64;\n\t\t\t\tthis_token.symbol = result_token.symbol;\n\t\t\t\tif (this_token.symbol == SYM_OBJECT)\n\t\t\t\t\tto_free[to_free_count++] = &this_token; // A slot was reserved for this SYM_FUNC.\n\t\t\t\tgoto push_this_token;\n\t\t\t}\n\t\t\t\n\t\t\tdone = EXPR_IS_DONE;\n\n\t\t\t// v1.0.45: If possible, take a shortcut for performance. Doing it this way saves at least\n\t\t\t// two memcpy's (one into deref buffer and then another back into the output_var by\n\t\t\t// ACT_ASSIGNEXPR itself). In some cases is also saves from having to expand the deref\n\t\t\t// buffer as well as the output_var (since it's current memory might be too small to hold\n\t\t\t// the new memory block). Thus we give it a new block directly to avoid all of that.\n\t\t\t// This should be a big boost to performance when long strings are involved.\n\t\t\tVar *internal_output_var;\n\t\t\tif (done) // i.e. we've now produced the final result.\n\t\t\t{\n\t\t\t\tif (mActionType == ACT_EXPRESSION) // Isolated expression: Outermost function call's result will be ignored, so no need to store it.\n\t\t\t\t{\n\t\t\t\t\tresult_token.Free(); // Since we're not taking charge of it in this case.\n\t\t\t\t\tgoto normal_end_skip_output_var; // No output_var is possible for ACT_EXPRESSION.\n\t\t\t\t}\n\t\t\t\tinternal_output_var = output_var; // NULL unless this is ACT_ASSIGNEXPR.\n\t\t\t}\n\t\t\t// It's fairly rare that the following optimization is even applicable because it requires\n\t\t\t// an assignment *internal* to an expression, such as \"if not var:=func()\", or \"a:=b, c:=func()\".\n\t\t\t// But it seems best to optimize these cases so that commas aren't penalized.\n\t\t\telse if (this_postfix[1].symbol == SYM_ASSIGN // Next operation is \":=\".\n\t\t\t\t\t&& stack_count && stack[stack_count-1]->symbol == SYM_VAR // i.e. let the next iteration handle errors instead of doing it here. Further below relies on this having been checked.\n\t\t\t\t\t&& stack[stack_count-1]->var->Type() == VAR_NORMAL) // Don't do VAR_VIRTUAL here; it mustn't become a SYM_VAR result, so the result would have to be made persistent anyway.\n\t\t\t\tinternal_output_var = stack[stack_count-1]->var;\n\t\t\telse\n\t\t\t\tinternal_output_var = NULL;\n\t\t\t\n\t\t\t// RELIES ON THE SYM_STRING CHECK above having been done first.\n\t\t\tresult = result_token.marker;\n\t\t\tresult_length = result_token.marker_length;\n\t\t\tif (result_length == -1)\n\t\t\t\tresult_length = (VarSizeType)_tcslen(result);\n\n\t\t\tif (internal_output_var)\n\t\t\t{\n\t\t\t\t// Check if the called function allocated some memory for its result and turned it over to us.\n\t\t\t\t// In most cases, the string stored in mem_to_free (if it has been set) is the same address as\n\t\t\t\t// this_token.marker (i.e. what is named \"result\" further below), because that's what the\n\t\t\t\t// built-in functions are normally using the memory for.\n\t\t\t\tif (result_token.mem_to_free)\n\t\t\t\t{\n\t\t\t\t\tASSERT(result_token.mem_to_free == result); // See similar line below for comments.\n\t\t\t\t\t// So now, turn over responsibility for this memory to the variable. The called function\n\t\t\t\t\t// is responsible for having stored the length of what's in the memory as an overload of\n\t\t\t\t\t// this_token.buf, but only when that memory is the result (currently might always be true).\n\t\t\t\t\t// AcceptNewMem() will shrink the memory for us, via _expand(), if there's a lot of\n\t\t\t\t\t// extra/unused space in it.\n\t\t\t\t\tinternal_output_var->AcceptNewMem(result_token.mem_to_free, result_token.marker_length);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\t// 1.0.46.06: If the UDF has stored its result in its deref buffer, take possession\n\t\t\t\t\t// of that buffer, which saves a memcpy of a potentially huge string. The cost\n\t\t\t\t\t// of this is that if there are any other UDF-calls pending after this one, the\n\t\t\t\t\t// code in their bodies will have to create another deref buffer if they need one.\n\t\t\t\t\tif (result == sDerefBuf && result_length >= MAX_ALLOC_SIMPLE) // Result is in their buffer and it's longer than what can fit in a SimpleHeap variable (avoids wasting SimpleHeap memory).\n\t\t\t\t\t{\n\t\t\t\t\t\tinternal_output_var->AcceptNewMem(result, result_length);\n\t\t\t\t\t\tNULLIFY_S_DEREF_BUF // Force any UDFs called subsequently by us to create a new deref buffer because this one was just taken over by a variable.\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\t// v1.0.45: This mode improves performance by avoiding the need to copy the result into\n\t\t\t\t\t\t// more persistent memory, then avoiding the need to copy it into the defer buffer (which\n\t\t\t\t\t\t// also avoids the possibility of needing to expand that buffer).\n\t\t\t\t\t\tif (!internal_output_var->Assign(result, result_length)) // Assign() contains an optimization that avoids actually doing the mem-copying if output_var is being assigned to itself (which can happen in cases like RegExMatch()).\n\t\t\t\t\t\t\tgoto abort;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif (done)\n\t\t\t\t\tgoto normal_end_skip_output_var; // No need to restore circuit_token because the expression is finished.\n\t\t\t\t// Next operation is \":=\" and above has verified the target is SYM_VAR and VAR_NORMAL.\n\t\t\t\t--stack_count; // STACK_POP;\n\t\t\t\tthis_token.SetVar(internal_output_var);\n\t\t\t\t++this_postfix; // We've fully handled the assignment.\n\t\t\t\tgoto push_this_token;\n\t\t\t}\n\t\t\t// Otherwise, there's no output_var or the expression isn't finished yet, so do normal processing.\n\t\t\t\t\n\t\t\tthis_token.symbol = SYM_STRING;\n\t\t\tthis_token.marker_length = result_length;\n\n\t\t\tif (result_token.mem_to_free) // The called function allocated some memory and turned it over to us.\n\t\t\t{\n\t\t\t\t// mem_to_free == result is checked only in debug mode because it should always be true.\n\t\t\t\t// Other sections rely on mem_to_free not needing to be freed if symbol != SYM_STRING,\n\t\t\t\t// so users of mem_to_free must never use it other than to return the result.\n\t\t\t\tASSERT(result_token.mem_to_free == result);\n\t\t\t\tif (done && aResultToken)\n\t\t\t\t{\n\t\t\t\t\t// Return this memory block to our caller. This is handled here rather than\n\t\t\t\t\t// at a later stage in order to avoid an unnecessary _tcslen() call.\n\t\t\t\t\taResultToken->AcceptMem(result_to_return = result, result_length);\n\t\t\t\t\tgoto normal_end_skip_output_var;\n\t\t\t\t}\n\t\t\t\t// Mark it to be freed at the time we return.\n\t\t\t\tto_free[to_free_count++] = &this_token; // A slot was reserved for this SYM_FUNC.\n\t\t\t\t// Invariant: any string token put in to_free must have marker set to the memory block\n\t\t\t\t// to be freed. marker = result is set further below, but only when result_length != 0.\n\t\t\t\tthis_token.marker = result;\n\t\t\t\tgoto push_this_token;\n\t\t\t}\n\t\t\t//else this_token.mem_to_free==NULL, so the BIF just called didn't allocate memory to give to us.\n\t\t\t\n\t\t\t// Empty strings are returned pretty often by UDFs, such as when they don't use \"return\"\n\t\t\t// at all. Therefore, handle them fully now, which should improve performance (since it\n\t\t\t// avoids all the other checking later on). It also doesn't hurt code size because this\n\t\t\t// check avoids having to check for empty string in other sections later on.\n\t\t\tif (result_length == 0) // Various make-persistent sections further below may rely on this check.\n\t\t\t{\n\t\t\t\tthis_token.marker = _T(\"\"); // Ensure it's a constant memory area, not a buf that might get overwritten soon.\n\t\t\t\tgoto push_this_token;\n\t\t\t}\n\n\t\t\tbool make_result_persistent;\n\t\t\t{\n\t\t\t\t// Since above didn't goto, the result may need to be copied to a more persistent location.\n\n\t\t\t\t// For BIFs, \"result\" can be any of the following (some of which were handled above):\n\t\t\t\t// - mem_to_free: Allocated by TokenSetResult().\n\t\t\t\t// - left_buf: Copied there by TokenSetResult() or via _f_retval_buf.\n\t\t\t\t// - Static memory, such as a literal string.\n\t\t\t\t// - Others that might be volatile.\n\n\t\t\t\t// For UDFs, \"result\" can be any of the following (some of which were handled above):\n\t\t\t\t//\t- mem_to_free: Passed back from some other function call.\n\t\t\t\t//\t- mem_to_free: The result of a concat (if other allocation methods were unavailable).\n\t\t\t\t//\t- mem_to_free: \"Stolen\" from a local var by ToReturnValue().\n\t\t\t\t//\t- left_buf: A local var's contents, copied into result_token.buf by ToReturnValue().\n\t\t\t\t//\t- sDerefBuf: Any other string result of ExpandExpression().\n\t\t\t\t//\t- sDerefBuf: A value copied from a variable by ExpandArgs(): return just_a_var\n\t\t\t\t//\t- A literal string which was optimized into a non-expression: return \"just a string\"\n\t\t\t\t//\t- The Contents() of a static or global variable, which ExpandArgs() determined did not need\n\t\t\t\t//\t to be dereferenced. Only applies when !is_expression; i.e. return static_var\n\n\t\t\t\t// Old method, not necessary to be so thorough because \"return\" always puts its result as the\n\t\t\t\t// very first item in its deref buf. So this is commented out in favor of the line below it:\n\t\t\t\t//if (result < sDerefBuf || result >= sDerefBuf + sDerefBufSize)\n\t\t\t\tif (result != sDerefBuf) // Not in their deref buffer (yields correct result even if sDerefBuf is NULL; also, see above.)\n\t\t\t\t\t// In this case, the result can probably only be left_buf or the Contents() of a var,\n\t\t\t\t\t// either of which may need to be made persistent if the expression isn't finished:\n\t\t\t\t\tmake_result_persistent = !done;\n\t\t\t\telse // The result must be in their deref buffer, perhaps due to something like \"return x+3\" or \"return bif()\" on their part.\n\t\t\t\t{\n\t\t\t\t\tmake_result_persistent = false; // Set default to be possibly overridden below.\n\t\t\t\t\tif (!done) // There are more operators/operands to be evaluated, but if there are no more function calls, we don't have to make it persistent since their deref buf won't be overwritten by anything during the time we need it.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Since there's more in the stack or postfix array to be evaluated, and since the return\n\t\t\t\t\t\t// value is in the new deref buffer, must copy result to somewhere non-volatile whenever\n\t\t\t\t\t\t// there's another function-call pending by us. Note that an empty-string result was\n\t\t\t\t\t\t// already checked and fully handled higher above.\n\t\t\t\t\t\t// If we don't have any more user-defined function calls pending, we can skip the\n\t\t\t\t\t\t// make-persistent section since this deref buffer will not be overwritten during the\n\t\t\t\t\t\t// period we need it.\n\t\t\t\t\t\tfor (p_postfix = this_postfix + 1; p_postfix->symbol != SYM_INVALID; ++p_postfix)\n\t\t\t\t\t\t\tif (p_postfix->symbol == SYM_FUNC)\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tmake_result_persistent = true;\n\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t//else done==true, so don't have to make it persistent here because the final stage will\n\t\t\t\t\t// copy it from their deref buf into ours (since theirs is only deleted later, by our caller).\n\t\t\t\t\t// In this case, leave make_result_persistent set to false.\n\t\t\t\t}\n\t\t\t\t// This is the end of the section that determines the value of \"make_result_persistent\" for UDFs.\n\t\t\t}\n\n\t\t\tif (make_result_persistent) // Both UDFs and built-in functions have ensured make_result_persistent is set.\n\t\t\t{\n\t\t\t\t// BELOW RELIES ON THE ABOVE ALWAYS HAVING VERIFIED AND FULLY HANDLED RESULT BEING AN EMPTY STRING.\n\t\t\t\t// So now we know result isn't an empty string, which in turn ensures that size > 1 and length > 0,\n\t\t\t\t// which might be relied upon by things further below.\n\t\t\t\tresult_size = result_length + 1;\n\t\t\t\t// Must cast to int to avoid loss of negative values:\n\t\t\t\tif (result_size <= aDerefBufSize - (target - aDerefBuf)) // There is room at the end of our deref buf, so use it.\n\t\t\t\t{\n\t\t\t\t\t// Make the token's result the new, more persistent location:\n\t\t\t\t\tthis_token.marker = tmemcpy(target, result, result_length); // Benches slightly faster than strcpy().\n\t\t\t\t\ttarget += result_size; // Point it to the location where the next string would be written.\n\t\t\t\t}\n\t\t\t\telse if (result_size < EXPR_SMALL_MEM_LIMIT && alloca_usage < EXPR_ALLOCA_LIMIT) // See comments at EXPR_SMALL_MEM_LIMIT.\n\t\t\t\t{\n\t\t\t\t\tthis_token.marker = tmemcpy(talloca(result_size), result, result_length); // Benches slightly faster than strcpy().\n\t\t\t\t\talloca_usage += result_size; // This might put alloca_usage over the limit by as much as EXPR_SMALL_MEM_LIMIT, but that is fine because it's more of a guideline than a limit.\n\t\t\t\t}\n\t\t\t\telse // Need to create some new persistent memory for our temporary use.\n\t\t\t\t{\n\t\t\t\t\t// In real-world scripts the need for additional memory allocation should be quite\n\t\t\t\t\t// rare because it requires a combination of worst-case situations:\n\t\t\t\t\t// - Called-function's return value is in their new deref buf (rare because return\n\t\t\t\t\t// values are more often literal numbers, true/false, or variables).\n\t\t\t\t\t// - We still have more functions to call here (which is somewhat atypical).\n\t\t\t\t\t// - There's insufficient room at the end of the deref buf to store the return value\n\t\t\t\t\t// (unusual because the deref buf expands in block-increments, and also because\n\t\t\t\t\t// return values are usually small, such as numbers).\n\t\t\t\t\tif ( !(this_token.marker = tmalloc(result_size)) )\n\t\t\t\t\t\tgoto outofmem;\n\t\t\t\t\ttmemcpy(this_token.marker, result, result_length); // Benches slightly faster than strcpy().\n\t\t\t\t\tto_free[to_free_count++] = &this_token; // A slot was reserved for this SYM_FUNC.\n\t\t\t\t}\n\t\t\t\t// Must be null-terminated because some built-in functions (such as MsgBox) still require it.\n\t\t\t\t// Explicit null-termination here (vs. including it in tmemcpy above) allows SubStr and others\n\t\t\t\t// to return a non-terminated substring.\n\t\t\t\tthis_token.marker[result_length] = '\\0';\n\t\t\t}\n\t\t\telse // make_result_persistent==false\n\t\t\t\tthis_token.marker = result;\n\n\t\t\tgoto push_this_token;\n\t\t} // if (this_token.symbol == SYM_FUNC)\n\n\t\tif (this_token.symbol == SYM_IFF_ELSE)\n\t\t{\n\t\t\t// SYM_IFF_ELSE is encountered only when a previous iteration has determined that the ternary's condition\n\t\t\t// is true. At this stage, the ternary's \"THEN\" branch has already been evaluated and stored at the top\n\t\t\t// of the stack. So skip over its \"else\" branch (short-circuit) because that doesn't need to be evaluated.\n\t\t\tthis_postfix = this_token.circuit_token; // The address in any circuit_token always points into the arg's postfix array (never any temporary array or token created here) due to the nature/definition of circuit_token.\n\t\t\t// And very soon, the outer loop will skip over the SYM_IFF_ELSE just found above.\n\t\t\tcontinue;\n\t\t}\n\n\t\t// Since the above didn't goto or continue, this token must be a unary or binary operator.\n\t\t// Get the first operand for this operator (for non-unary operators, this is the right-side operand):\n\t\tif (!stack_count) // Prevent stack underflow. An expression such as -*3 causes this.\n\t\t\tgoto abort_with_exception;\n\t\tExprTokenType &right = *STACK_POP;\n\t\tif (right.symbol == SYM_MISSING)\n\t\t{\n\t\t\tif (this_token.symbol == SYM_OR_MAYBE // SYM_MISSING is to ?? what False is to ||.\n\t\t\t\t|| this_token.symbol == SYM_COMMA) // The operand of a multi-statement comma is always ignored, so is not required to be a value.\n\t\t\t\tcontinue; // Continue on to evaluate the right branch.\n\t\t\tif (this_token.symbol == SYM_MAYBE)\n\t\t\t{\n\t\t\t\t++stack_count; // Put unset back on the stack.\n\t\t\t\tthis_postfix = this_token.circuit_token;\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tif (this_token.symbol != SYM_ASSIGN) // Anything other than := is not permitted.\n\t\t\t\tgoto abort_with_exception;\n\t\t}\n\n\t\tswitch (this_token.symbol)\n\t\t{\n\t\tcase SYM_ASSIGN: // These don't need \"right_is_number\" to be resolved. v1.0.48.01: Also avoid\n\t\tcase SYM_CONCAT: // resolving right_is_number for CONCAT because TokenIsPureNumeric() will take\n\t\tcase SYM_ASSIGN_CONCAT: // a long time if the string is very long and consists entirely of digits/whitespace.\n\t\tcase SYM_IS:\n\t\t\tright_is_pure_number = right_is_number = PURE_NOT_NUMERIC; // Init for convenience/maintainability.\n\t\tcase SYM_AND:\t\t\t// v2: These don't need it either since even numeric strings are considered \"true\".\n\t\tcase SYM_OR:\t\t\t// right_is_number isn't used at all in these cases since they are handled early.\n\t\tcase SYM_OR_MAYBE:\t\t//\n\t\tcase SYM_IFF_THEN:\t\t//\n\t\tcase SYM_LOWNOT:\t\t//\n\t\tcase SYM_HIGHNOT:\t\t//\n\t\tcase SYM_REF:\n\t\t\tbreak;\n\t\t\t\n\t\tcase SYM_COMMA: // This can only be a statement-separator comma, not a function comma, since function commas weren't put into the postfix array.\n\t\t\t// Do nothing other than discarding the operand that was just popped off the stack, which is the\n\t\t\t// result of the comma's left-hand sub-statement. At this point the right-hand sub-statement\n\t\t\t// has not yet been evaluated. Like C++ and other languages, but unlike AutoHotkey v1, the\n\t\t\t// rightmost operand is preserved, not the leftmost.\n\t\t\tcontinue;\n\n\t\tcase SYM_MAYBE:\n\t\t\t++stack_count; // right was already confirmed to not be SYM_MISSING, so just put it back on the stack.\n\t\t\tcontinue;\n\n\t\tdefault:\n\t\t\t// If the operand is still generic/undetermined, find out whether it is a string, integer, or float:\n\t\t\tright_is_pure_number = TokenIsPureNumeric(right, right_is_number); // If it's SYM_VAR, it can be the clipboard in this case, but it works even then.\n\t\t}\n\n\t\t// IF THIS IS A UNARY OPERATOR, we now have the single operand needed to perform the operation.\n\t\t// The cases in the switch() below are all unary operators. The other operators are handled\n\t\t// in the switch()'s default section:\n\t\tsym_assign_var = NULL; // Set default for use at the bottom of the following switch().\n\t\tswitch (this_token.symbol)\n\t\t{\n\t\tcase SYM_AND:\n\t\tcase SYM_OR:\n\t\tcase SYM_IFF_THEN:\n\t\t\t// this_token is the left branch of an AND/OR or the condition of a ternary op. Check for short-circuit.\n\t\t\tleft_branch_is_true = TokenToBOOL(right);\n\n\t\t\tif (left_branch_is_true == (this_token.symbol == SYM_OR))\n\t\t\t{\n\t\tcase SYM_OR_MAYBE: // This case skips the \"if\" above, since the false (SYM_MISSING) branch was already handled.\n\t\t\t\t// The ternary's condition is false or this AND/OR causes a short-circuit.\n\t\t\t\t// Discard the entire right branch of this AND/OR or \"then\" branch of this IFF:\n\t\t\t\tthis_postfix = this_token.circuit_token; // The address in any circuit_token always points into the arg's postfix array (never any temporary array or token created here) due to the nature/definition of circuit_token.\n\n\t\t\t\tif (this_token.symbol != SYM_IFF_THEN)\n\t\t\t\t{\n\t\t\t\t\t// This will be the final result of this AND/OR because it's right branch was\n\t\t\t\t\t// discarded above without having been evaluated nor any of its functions called:\n\t\t\t\t\t++stack_count; // It's already at stack[stack_count], so this \"puts it back\" on the stack.\n\t\t\t\t\t// Any SYM_OBJECT on our stack was already put into to_free[], so if this is SYM_OBJECT,\n\t\t\t\t\t// there's no need to do anything; we actually MUST NOT AddRef() unless we also put it\n\t\t\t\t\t// into to_free[].\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\t// AND/OR: This left branch is simply discarded (by means of the outer loop) because its\n\t\t\t\t//\tright branch will be the sole determination of whether this AND/OR is true or false.\n\t\t\t\t// IFF: The ternary's condition is true. Do nothing; just let subsequent iterations evaluate\n\t\t\t\t//\tthe THEN portion; the SYM_IFF_ELSE which follows it will jump over the ELSE branch.\n\t\t\t}\n\t\t\tcontinue;\n\n\t\tcase SYM_LOWNOT: // The operator-word \"not\".\n\t\tcase SYM_HIGHNOT: // The symbol '!'. Both NOTs are equivalent at this stage because precedence was already acted upon by infix-to-postfix.\n\t\t\tthis_token.SetValue(!TokenToBOOL(right)); // Result is always one or zero.\n\t\t\tbreak;\n\n\t\tcase SYM_NEGATIVE: // Unary-minus.\n\t\t\tif (right_is_number == PURE_INTEGER)\n\t\t\t\tthis_token.value_int64 = -TokenToInt64(right);\n\t\t\telse if (right_is_number == PURE_FLOAT)\n\t\t\t\tthis_token.value_double = -TokenToDouble(right, FALSE); // Pass FALSE for aCheckForHex since PURE_FLOAT is never hex.\n\t\t\telse // String. Seems best to consider the application of unary minus to a string to be a failure.\n\t\t\t{\n\t\t\t\terror_info = _T(\"Number\");\n\t\t\t\terror_value = &right;\n\t\t\t\tgoto type_mismatch;\n\t\t\t}\n\t\t\t// Since above didn't \"break\":\n\t\t\tthis_token.symbol = right_is_number;\n\t\t\tbreak;\n\n\t\tcase SYM_POSITIVE: // Added in v2 for symmetry with SYM_NEGATIVE; i.e. if -x produces NaN, so should +x.\n\t\t\tif (right_is_number)\n\t\t\t\tTokenToDoubleOrInt64(right, this_token);\n\t\t\telse\n\t\t\t{\n\t\t\t\terror_info = _T(\"Number\");\n\t\t\t\terror_value = &right;\n\t\t\t\tgoto type_mismatch; // For consistency with unary minus (see above).\n\t\t\t}\n\t\t\tbreak;\n\n\t\tcase SYM_REF:\n\t\t\tif (right.symbol != SYM_VAR) // Syntax error?\n\t\t\t\tgoto abort_with_exception;\n\t\t\tif (this_token.var_usage != VARREF_READ)\n\t\t\t{\n\t\t\t\tif (this_token.var_usage != VARREF_REF)\n\t\t\t\t{\n\t\t\t\t\t// VARREF_OUTPUT_VAR -> SYM_VAR\n\t\t\t\t\tthis_token.SetVarRef(right.var);\n\t\t\t\t\tgoto push_this_token;\n\t\t\t\t}\n\t\t\t\tVar *target_var = right.var->ResolveAlias();\n\t\t\t\tif (!target_var->IsNonStaticLocal()\n\t\t\t\t\t|| !this_token.object\n\t\t\t\t\t|| !((UserFunc *)this_token.object)->mInstances)\n\t\t\t\t{\n\t\t\t\t\t// target_var definitely isn't a local var of the function being called,\n\t\t\t\t\t// so it's safe to pass as SYM_VAR. Pass right.var and not target_var,\n\t\t\t\t\t// otherwise GetRef() won't be able to identify the existing VarRef and\n\t\t\t\t\t// may create a new VarRef and a circular reference.\n\t\t\t\t\tthis_token.SetVarRef(right.var);\n\t\t\t\t\tgoto push_this_token;\n\t\t\t\t}\n\t\t\t}\n\t\t\tASSERT(right.var->Type() == VAR_NORMAL || right.var->IsVirtual());\n\t\t\tthis_token.SetValue(right.var->GetRef());\n\t\t\tif (!this_token.object)\n\t\t\t\tgoto outofmem;\n\t\t\tto_free[to_free_count++] = &this_token;\n\t\t\tbreak;\n\n\t\tcase SYM_POST_INCREMENT: // These were added in v1.0.46. It doesn't seem worth translating them into\n\t\tcase SYM_POST_DECREMENT: // += and -= at load-time or during the tokenizing phase higher above because \n\t\tcase SYM_PRE_INCREMENT: // it might introduce precedence problems, plus the post-inc/dec's nature is\n\t\tcase SYM_PRE_DECREMENT: // unique among all the operators in that it pushes an operand before the evaluation.\n\t\t\tif (right.symbol != SYM_VAR) // Syntax error.\n\t\t\t\tgoto abort_with_exception;\n\t\t\tis_pre_op = SYM_INCREMENT_OR_DECREMENT_IS_PRE(this_token.symbol); // Store this early because its symbol will soon be overwritten.\n\t\t\tif (right_is_number == PURE_NOT_NUMERIC) // Not numeric: invalid operation.\n\t\t\t{\n\t\t\t\terror_info = _T(\"Number\");\n\t\t\t\terror_value = &right;\n\t\t\t\tgoto type_mismatch;\n\t\t\t}\n\n\t\t\t// DUE TO CODE SIZE AND PERFORMANCE decided not to support things like the following:\n\t\t\t// -> ++++i ; This one actually works because pre-ops produce a variable (usable by future pre-ops).\n\t\t\t// -> i++++ ; Fails because the first ++ produces an operand that isn't a variable. It could be\n\t\t\t// supported via a cascade loop here to pull all remaining consecutive post/pre ops out of\n\t\t\t// the postfix array and apply them to \"delta\", but it just doesn't seem worth it.\n\t\t\t// -> --Var++ ; Fails because ++ has higher precedence than --, but it produces an operand that isn't\n\t\t\t// a variable, so the \"--\" fails. Things like --Var++ seem pointless anyway because they seem\n\t\t\t// nearly identical to the sub-expression (Var+1)? Anyway, --Var++ could probably be supported\n\t\t\t// using the loop described in the previous example.\n\t\t\tdelta = (this_token.symbol == SYM_POST_INCREMENT || this_token.symbol == SYM_PRE_INCREMENT) ? 1 : -1;\n\t\t\tif (right_is_number == PURE_INTEGER)\n\t\t\t{\n\t\t\t\tthis_token.value_int64 = TokenToInt64(right);\n\t\t\t\tif (!right.var->Assign(this_token.value_int64 + delta))\n\t\t\t\t\tgoto abort;\n\t\t\t}\n\t\t\telse // right_is_number must be PURE_FLOAT because it's the only remaining alternative.\n\t\t\t{\n\t\t\t\tthis_token.value_double = TokenToDouble(right, FALSE); // Pass FALSE for aCheckForHex since PURE_FLOAT is never hex.\n\t\t\t\tif (!right.var->Assign(this_token.value_double + delta))\n\t\t\t\t\tgoto abort;\n\t\t\t}\n\t\t\tif (is_pre_op)\n\t\t\t{\n\t\t\t\t// Push the variable itself so that the operation will have already taken effect for whoever\n\t\t\t\t// uses this operand/result in the future (i.e. pre-op vs. post-op).\n\t\t\t\t// KNOWN LIMITATION: Although this behavior is convenient to have, I realize now\n\t\t\t\t// that it produces at least one weird effect: whenever a binary operator's operands\n\t\t\t\t// both use a pre-op on the same variable, or whenever two or more of a function-call's\n\t\t\t\t// parameters both do a pre-op on the same variable, that variable will have the same\n\t\t\t\t// value at the time the binary operator or function-call is evaluated. For example:\n\t\t\t\t// y = 1\n\t\t\t\t// x = ++y + ++y ; Yields 6 not 5.\n\t\t\t\t// However, if you think about the situations anyone would intentionally want to do\n\t\t\t\t// the above or a function-call with two or more pre-ops in its parameters, it seems\n\t\t\t\t// so extremely rare that retaining the existing behavior might be superior because of:\n\t\t\t\t// 1) Convenience: It allows ++x to be passed ByRef, it's address taken. Less importantly,\n\t\t\t\t// it also allows ++++x to work.\n\t\t\t\t// 2) Backward compatibility: Some existing scripts probably already rely on the fact that\n\t\t\t\t// ++x and --x produce an lvalue (though it's undocumented).\n\t\t\t\tif (right.var->Type() == VAR_NORMAL)\n\t\t\t\t{\n\t\t\t\t\tthis_token.SetVar(right.var);\n\t\t\t\t}\n\t\t\t\telse // VAR_VIRTUAL, which is allowed in only when it's the lvalue of an assignment or inc/dec.\n\t\t\t\t{\n\t\t\t\t\t// VAR_VIRTUAL isn't allowed as SYM_VAR beyond this point (to simplify the code and\n\t\t\t\t\t// improve maintainability). So use the new contents of the variable as the result,\n\t\t\t\t\t// rather than the variable itself.\n\t\t\t\t\tif (right_is_number == PURE_INTEGER)\n\t\t\t\t\t\tthis_token.value_int64 += delta;\n\t\t\t\t\telse // right_is_number must be PURE_FLOAT because it's the only alternative remaining.\n\t\t\t\t\t\tthis_token.value_double += delta;\n\t\t\t\t\tthis_token.symbol = right_is_number; // Set the symbol type to match the double or int64 that was already stored higher above.\n\t\t\t\t}\n\t\t\t}\n\t\t\telse // Post-inc/dec, so the non-delta version, which was already stored in this_token, should get pushed.\n\t\t\t\tthis_token.symbol = right_is_number; // Set the symbol type to match the double or int64 that was already stored higher above.\n\t\t\tbreak;\n\n\t\tcase SYM_BITNOT: // The tilde (~) operator.\n\t\t\tif (right_is_number != PURE_INTEGER) // String. Seems best to consider the application of '*' or '~' to a non-numeric string to be a failure.\n\t\t\t{\n\t\t\t\terror_info = _T(\"Number\");\n\t\t\t\terror_value = &right;\n\t\t\t\tgoto type_mismatch;\n\t\t\t}\n\t\t\t// Since above didn't \"goto\": right_is_number is PURE_INTEGER.\n\t\t\tright_int64 = TokenToInt64(right); // The slight performance reduction of calling TokenToInt64() is done for brevity.\n\t\t\t\n\t\t\t// Note that it is not legal to perform ~, &, |, or ^ on doubles. \n\t\t\t// Treat it as a 64-bit signed value, since no other aspects of the program\n\t\t\t// will recognize an unsigned 64 bit number.\n\t\t\tthis_token.value_int64 = ~right_int64;\n\t\t\tthis_token.symbol = SYM_INTEGER; // Must be done only after its old value was used above. v1.0.36.07: Fixed to be SYM_INTEGER vs. right_is_number for SYM_BITNOT.\n\t\t\tbreak;\n\n\t\tdefault: // NON-UNARY OPERATOR.\n\t\t\t// GET THE SECOND (LEFT-SIDE) OPERAND FOR THIS OPERATOR:\n\t\t\tif (!stack_count) // Prevent stack underflow.\n\t\t\t\tgoto abort_with_exception;\n\t\t\tExprTokenType &left = *STACK_POP; // i.e. the right operand always comes off the stack before the left.\n\t\t\tif (left.symbol == SYM_MISSING)\n\t\t\t\tgoto abort_with_exception;\n\t\t\t\n\t\t\tif (IS_ASSIGNMENT_EXCEPT_POST_AND_PRE(this_token.symbol)) // v1.0.46: Added support for various assignment operators.\n\t\t\t{\n\t\t\t\tif (left.symbol != SYM_VAR) // Syntax error.\n\t\t\t\t\tgoto abort_with_exception;\n\n\t\t\t\tswitch(this_token.symbol)\n\t\t\t\t{\n\t\t\t\tcase SYM_ASSIGN: // Listed first for performance (it's probably the most common because things like ++ and += aren't expressions when they're by themselves on a line).\n\t\t\t\t\tif (!left.var->Assign(right)) // left.var can be VAR_VIRTUAL in this case.\n\t\t\t\t\t\tgoto abort;\n\t\t\t\t\tif (left.var_usage == VARREF_LVALUE_ISSET) // this_token is to be passed to IsSet().\n\t\t\t\t\t\tthis_token.SetVar(left.var, VARREF_ISSET);\n\t\t\t\t\telse if (left.var->Type() != VAR_NORMAL // VAR_VIRTUAL should not yield SYM_VAR (as some sections of the code wouldn't handle it correctly).\n\t\t\t\t\t\t|| right.symbol == SYM_MISSING // Subsequent operators/calls (confirmed at load-time as being able to handle `unset`) need SYM_MISSING,\n\t\t\t\t\t\t\t&& this_postfix[1].symbol != SYM_REF) // except the reference operator, as in &x:=unset.\n\t\t\t\t\t\tthis_token.CopyValueFrom(right); // Doing it this way is more maintainable than other methods, and is unlikely to perform much worse.\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_token.SetVar(left.var);\n\t\t\t\t\tgoto push_this_token;\n\t\t\t\tcase SYM_ASSIGN_ADD:\t\t\t\t\tthis_token.symbol = SYM_ADD; break;\n\t\t\t\tcase SYM_ASSIGN_SUBTRACT:\t\t\t\tthis_token.symbol = SYM_SUBTRACT; break;\n\t\t\t\tcase SYM_ASSIGN_MULTIPLY:\t\t\t\tthis_token.symbol = SYM_MULTIPLY; break;\n\t\t\t\tcase SYM_ASSIGN_DIVIDE:\t\t\t\t\tthis_token.symbol = SYM_DIVIDE; break;\n\t\t\t\tcase SYM_ASSIGN_INTEGERDIVIDE:\t\t\tthis_token.symbol = SYM_INTEGERDIVIDE; break;\n\t\t\t\tcase SYM_ASSIGN_BITOR:\t\t\t\t\tthis_token.symbol = SYM_BITOR; break;\n\t\t\t\tcase SYM_ASSIGN_BITXOR:\t\t\t\t\tthis_token.symbol = SYM_BITXOR; break;\n\t\t\t\tcase SYM_ASSIGN_BITAND:\t\t\t\t\tthis_token.symbol = SYM_BITAND; break;\n\t\t\t\tcase SYM_ASSIGN_BITSHIFTLEFT:\t\t\tthis_token.symbol = SYM_BITSHIFTLEFT; break;\n\t\t\t\tcase SYM_ASSIGN_BITSHIFTRIGHT:\t\t\tthis_token.symbol = SYM_BITSHIFTRIGHT; break;\n\t\t\t\tcase SYM_ASSIGN_BITSHIFTRIGHT_LOGICAL:\tthis_token.symbol = SYM_BITSHIFTRIGHT_LOGICAL; break;\n\t\t\t\tcase SYM_ASSIGN_CONCAT:\t\t\t\t\tthis_token.symbol = SYM_CONCAT; break;\n\t\t\t\t}\n\t\t\t\t// Since above didn't goto or break out of the outer loop, this is an assignment other than\n\t\t\t\t// SYM_ASSIGN, so it needs further evaluation later below before the assignment will actually be made.\n\t\t\t\tsym_assign_var = left.var; // This tells the bottom of this switch() to do extra steps for this assignment.\n\t\t\t}\n\n\t\t\t// The following section needs done even for assignments such as += because the type of value\n\t\t\t// inside the target variable (integer vs. float vs. string) must be known, to determine how\n\t\t\t// the operation should proceed.\n\t\t\t// Since above didn't goto/break, this is a non-unary operator that needs further processing.\n\t\t\t// If the operand is still generic/undetermined, find out whether it is a string, integer, or float.\n\t\t\t// Fix for v1.0.48.01: For performance, call TokenIsPureNumeric(left) only as a last resort\n\t\t\t// because \"left\" could be a very long string consisting entirely of digits or whitespace, which\n\t\t\t// would make the call take a long time. \n\t\t\tif (right_is_number) // right_is_number is always PURE_NOT_NUMERIC for SYM_CONCAT.\n\t\t\t\tleft_is_pure_number = TokenIsPureNumeric(left, left_is_number);\n\t\t\t// Otherwise, leave left_is' uninitialized as below will short-circuit.\n\t\t\tif ( !(right_is_number && left_is_number) // i.e. they're not both numeric (or this is SYM_CONCAT).\n\t\t\t\t|| IS_EQUALITY_OPERATOR(this_token.symbol) && !right_is_pure_number && !left_is_pure_number ) // i.e. if both are strings, compare them alphabetically if the operator supports it.\n\t\t\t{\n\t\t\t\t// L31: Handle binary ops supported by objects (= == != !==).\n\t\t\t\tswitch (this_token.symbol)\n\t\t\t\t{\n\t\t\t\tcase SYM_EQUAL:\n\t\t\t\tcase SYM_EQUALCASE:\n\t\t\t\tcase SYM_NOTEQUAL:\n\t\t\t\tcase SYM_NOTEQUALCASE:\n\t\t\t\t\tIObject *right_obj = TokenToObject(right);\n\t\t\t\t\tIObject *left_obj = TokenToObject(left);\n\t\t\t\t\t// To support a future \"implicit default value\" feature, both operands must be objects.\n\t\t\t\t\t// Otherwise, an object operand will be treated as its default value, currently always \"\".\n\t\t\t\t\t// This is also consistent with unsupported operands such as < and > - i.e. because obj<\"\"\n\t\t\t\t\t// and obj>\"\" are always false and obj<=\"\" and obj>=\"\" are always true, obj must be \"\".\n\t\t\t\t\t// When the default value feature is implemented all operators (excluding =, ==, !== and !=\n\t\t\t\t\t// if both operands are objects) may use the default value of any object operand.\n\t\t\t\t\t// UPDATE: Above is not done because it seems more intuitive to document the other\n\t\t\t\t\t// comparison operators as unsupported than for (obj == \"\") to evaluate to true.\n\t\t\t\t\tif (right_obj || left_obj)\n\t\t\t\t\t{\n\t\t\t\t\t\tthis_token.SetValue((this_token.symbol != SYM_NOTEQUAL && this_token.symbol != SYM_NOTEQUALCASE) == (right_obj == left_obj));\n\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Above check has ensured that at least one of them is a string. But the other\n\t\t\t\t// one might be a number such as in 5+10=\"15\", in which 5+10 would be a numerical\n\t\t\t\t// result being compared to the raw string literal \"15\".\n\t\t\t\tright_string = TokenToString(right, right_buf, &right_length);\n\t\t\t\tleft_string = TokenToString(left, left_buf, &left_length);\n\t\t\t\tresult_symbol = SYM_INTEGER; // Set default. Boolean results are treated as integers.\n\t\t\t\tswitch(this_token.symbol)\n\t\t\t\t{\n\t\t\t\tcase SYM_EQUAL:\tthis_token.value_int64 = !_tcsicmp(left_string, right_string); break; // Case-insensitive string comparison.\n\t\t\t\t\n\t\t\t\tcase SYM_EQUALCASE: // Case sensitive. Also supports binary data.\n\t\t\t\t\t// Support basic equality checking of binary data by using tmemcmp rather than _tcscmp.\n\t\t\t\t\t// The results should be the same for strings, but faster. Length must be checked first\n\t\t\t\t\t// since tmemcmp wouldn't stop at the null-terminator (and that's why we're using it).\n\t\t\t\t\t// As a result, the comparison is much faster when the length differs.\n\t\t\t\t\tthis_token.value_int64 = (left_length == right_length) && !tmemcmp(left_string, right_string, left_length);\n\t\t\t\t\tbreak; \n\t\t\t\tcase SYM_NOTEQUAL:\tthis_token.value_int64 = !!_tcsicmp(left_string, right_string); break; // Same as SYM_EQUAL but inverted result, code copied for performance (assumed). Note the double !! instead of no !, it is for handling the strcmp functions returning -1.\n\n\t\t\t\tcase SYM_NOTEQUALCASE:\tthis_token.value_int64 = !((left_length == right_length)\t\t// Same as SYM_EQUALCASE but inverted result, code copied for performance (assumed).\t\t\n\t\t\t\t\t\t\t\t\t\t&& !tmemcmp(left_string, right_string, left_length) ); break;\n\t\t\t\t\n\t\t\t\tcase SYM_CONCAT:\n\t\t\t\t\tif (TokenToObject(left))\n\t\t\t\t\t{\n\t\t\t\t\t\terror_info = _T(\"String\");\n\t\t\t\t\t\terror_value = &left;\n\t\t\t\t\t\tgoto type_mismatch; // Treat this as an error, especially to catch `new classname`.\n\t\t\t\t\t}\n\t\t\t\t\tif (TokenToObject(right))\n\t\t\t\t\t{\n\t\t\t\t\t\terror_info = _T(\"String\");\n\t\t\t\t\t\terror_value = &right;\n\t\t\t\t\t\tgoto type_mismatch; // Treat this as an error, especially to catch `new classname`.\n\t\t\t\t\t}\n\t\t\t\t\t// Even if the left or right is \"\", must copy the result to temporary memory, at least\n\t\t\t\t\t// when integers and floats had to be converted to temporary strings above.\n\t\t\t\t\t// Binary clipboard is ignored because it's documented that except for certain features,\n\t\t\t\t\t// binary clipboard variables are seen only up to the first binary zero (mostly to\n\t\t\t\t\t// simplify the code).\n\t\t\t\t\tif (sym_assign_var && sym_assign_var->Type() == VAR_NORMAL) // Since \"right\" is being appended onto a variable (\"left\"), an optimization is possible.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Append() is particularly efficient when the var already has room to append the value,\n\t\t\t\t\t\t// but improves performance even in other cases by avoiding an extra memcpy and allocating\n\t\t\t\t\t\t// extra space for future expansion. It is necessary to completely handle this case here\n\t\t\t\t\t\t// because otherwise this_token might need to be put into to_mem[], in which case it must\n\t\t\t\t\t\t// not be converted to SYM_VAR.\n\t\t\t\t\t\tif (!sym_assign_var->Append(right_string, (VarSizeType)right_length))\n\t\t\t\t\t\t\tgoto abort;\n\t\t\t\t\t\tthis_token.SetVar(sym_assign_var);\n\t\t\t\t\t\tgoto push_this_token; // Skip over all other sections such as subsequent checks of sym_assign_var because it was all taken care of here.\n\t\t\t\t\t}\n\t\t\t\t\t// Otherwise, fall back to the other concat methods:\n\t\t\t\t\tresult_size = right_length + left_length + 1;\n\n\t\t\t\t\tif (sym_assign_var) // Fix for v1.0.48: These 2 lines were added, and they must take\n\t\t\t\t\t\ttemp_var = NULL; // precendence over the other checks below to allow an expression like the following to work: var := var2 .= \"abc\"\n\t\t\t\t\telse if (output_var && EXPR_IS_DONE) // i.e. this is ACT_ASSIGNEXPR and we're at the final operator, a concat.\n\t\t\t\t\t{\n\t\t\t\t\t\ttemp_var = output_var;\n\t\t\t\t\t\tdone_and_have_an_output_var = TRUE;\n\t\t\t\t\t}\n\t\t\t\t\telse if (this_postfix[1].symbol == SYM_ASSIGN // Next operation is \":=\".\n\t\t\t\t\t\t&& stack_count && stack[stack_count-1]->symbol == SYM_VAR // i.e. let the next iteration handle it instead of doing it here. Further below relies on this having been checked.\n\t\t\t\t\t\t&& stack[stack_count-1]->var->Type() == VAR_NORMAL) // Don't do VAR_VIRTUAL here; it mustn't become a SYM_VAR result, so the result would have to be made persistent anyway.\n\t\t\t\t\t{\n\t\t\t\t\t\ttemp_var = stack[stack_count-1]->var;\n\t\t\t\t\t\tdone_and_have_an_output_var = FALSE;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t\ttemp_var = NULL;\n\n\t\t\t\t\tif (temp_var)\n\t\t\t\t\t{\n\t\t\t\t\t\tresult = temp_var->Contents(FALSE); // No need to update the contents because we just want to know if the current address of mContents matches some other addresses.\n\t\t\t\t\t\tif (result == Var::sEmptyString) // Added in v1.1.09.03.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// One of the following is true:\n\t\t\t\t\t\t\t// 1) temp_var has zero capacity and is empty.\n\t\t\t\t\t\t\t// 2) temp_var has zero capacity and contains an unflushed binary number.\n\t\t\t\t\t\t\t// In the first case, AppendIfRoom() will always fail, so we want to skip it and use\n\t\t\t\t\t\t\t// the \"no overlap\" optimization below. In the second case, calling AppendIfRoom()\n\t\t\t\t\t\t\t// would produce the wrong result; e.g. (x := 0+1, x := y 0) would produce \"10\".\n\t\t\t\t\t\t\tresult = NULL;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (result == left_string) // This is something like x := x . y, so simplify it to x .= y\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// MUST DO THE ABOVE CHECK because the next section further below might free the\n\t\t\t\t\t\t\t// destination memory before doing the operation. Thus, if the destination is the\n\t\t\t\t\t\t\t// same as one of the sources, freeing it beforehand would obviously be a problem.\n\t\t\t\t\t\t\tif (temp_var->AppendIfRoom(right_string, (VarSizeType)right_length))\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tif (done_and_have_an_output_var) // Fix for v1.0.48: Checking \"temp_var == output_var\" would not be enough for cases like v := (v := v . \"a\") . \"b\"\n\t\t\t\t\t\t\t\t\tgoto normal_end_skip_output_var; // Nothing more to do because it has even taken care of output_var already.\n\t\t\t\t\t\t\t\telse // temp_var is from look-ahead to a future assignment.\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t++this_postfix;\n\t\t\t\t\t\t\t\t\tthis_token.SetVar(STACK_POP->var);\n\t\t\t\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t//else no optimizations are possible because: 1) No room; 2) The overlap between the\n\t\t\t\t\t\t\t// source and dest requires temporary memory. So fall through to the slower method.\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse if (result != right_string) // No overlap between the two sources and dest.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// The check above assumes that only a complete equality/overlap is possible,\n\t\t\t\t\t\t\t// not a partial overlap. A partial overlap between the memory of two variables\n\t\t\t\t\t\t\t// seems impossible for a script to produce. But if it ever does happen, the\n\t\t\t\t\t\t\t// Assign() below would free part or all of one of the sources before doing\n\t\t\t\t\t\t\t// the concat, which would corrupt the result.\n\t\t\t\t\t\t\t// Optimize by copying directly into the target variable rather than the intermediate\n\t\t\t\t\t\t\t// step of putting into temporary memory.\n\t\t\t\t\t\t\tif (!temp_var->AssignString(NULL, (VarSizeType)result_size - 1)) // Resize the destination, if necessary.\n\t\t\t\t\t\t\t\tgoto abort; // Above should have already reported the error.\n\t\t\t\t\t\t\tresult = temp_var->Contents(FALSE); // Call Contents() AGAIN because Assign() may have changed it. Update is never needed because above reset the contents. Passing FALSE reduces code size when inlined.\n\t\t\t\t\t\t\tif (left_length)\n\t\t\t\t\t\t\t\ttmemcpy(result, left_string, left_length); // Not +1 because don't need the zero terminator.\n\t\t\t\t\t\t\ttmemcpy(result + left_length, right_string, right_length + 1); // +1 to include its zero terminator.\n\t\t\t\t\t\t\ttemp_var->Close(); // Must be called after Assign(NULL, ...) or when Contents() has been altered because it updates the variable's attributes and properly handles VAR_VIRTUAL.\n\t\t\t\t\t\t\tif (done_and_have_an_output_var) // Fix for v1.0.48: Checking \"temp_var == output_var\" would not be enough for cases like v := (v := \"a\" . \"b\") . \"c\".\n\t\t\t\t\t\t\t\tgoto normal_end_skip_output_var; // Nothing more to do because it has even taken care of output_var already.\n\t\t\t\t\t\t\telse // temp_var is from look-ahead to a future assignment.\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t++this_postfix;\n\t\t\t\t\t\t\t\tthis_token.SetVar(STACK_POP->var);\n\t\t\t\t\t\t\t\tgoto push_this_token;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\t//else result==right_string (e.g. x := y . x). Although this could be optimized by \n\t\t\t\t\t\t// moving memory around inside output_var (if it has enough capacity), it seems more\n\t\t\t\t\t\t// complicated than it's worth given the rarity of this. It probably wouldn't save\n\t\t\t\t\t\t// much time anyway due to the memory-moves inside output_var. So just fall through\n\t\t\t\t\t\t// to the normal method.\n\t\t\t\t\t} // if (temp_var)\n\n\t\t\t\t\t// Since above didn't \"goto\", it didn't find a way to optimize this concat.\n\t\t\t\t\t// So fall back to the standard method.\n\t\t\t\t\t// The following section is similar to the one for \"symbol == SYM_FUNC\", so they\n\t\t\t\t\t// should be maintained together.\n\t\t\t\t\t// The following isn't done because there's a memcpy() further below which would also\n\t\t\t\t\t// have to check it, which hurts maintainability. This doesn't seem worth it since\n\t\t\t\t\t// it's unlikely to be the empty string in the case of concat.\n\t\t\t\t\t//if (result_size == 1)\n\t\t\t\t\t//\tthis_token.marker = \"\";\n\t\t\t\t\t//else\n\t\t\t\t\t// Must cast to int to avoid loss of negative values:\n\t\t\t\t\tif (result_size <= (int)(aDerefBufSize - (target - aDerefBuf))) // There is room at the end of our deref buf, so use it.\n\t\t\t\t\t{\n\t\t\t\t\t\tthis_token.marker = target;\n\t\t\t\t\t\ttarget += result_size; // Adjust target for potential future use by another concat or function call.\n\t\t\t\t\t}\n\t\t\t\t\telse if (result_size < EXPR_SMALL_MEM_LIMIT && alloca_usage < EXPR_ALLOCA_LIMIT) // See comments at EXPR_SMALL_MEM_LIMIT.\n\t\t\t\t\t{\n\t\t\t\t\t\tthis_token.marker = talloca(result_size);\n\t\t\t\t\t\talloca_usage += result_size; // This might put alloca_usage over the limit by as much as EXPR_SMALL_MEM_LIMIT, but that is fine because it's more of a guideline than a limit.\n\t\t\t\t\t}\n\t\t\t\t\telse // Need to create some new persistent memory for our temporary use.\n\t\t\t\t\t{\n\t\t\t\t\t\t// See the nearly identical section higher above for comments:\n\t\t\t\t\t\tif ( !(this_token.marker = tmalloc(result_size)) )\n\t\t\t\t\t\t\tgoto outofmem;\n\t\t\t\t\t\tto_free[to_free_count++] = &this_token; // A slot was reserved for this SYM_CONCAT.\n\t\t\t\t\t}\n\t\t\t\t\tif (left_length)\n\t\t\t\t\t\ttmemcpy(this_token.marker, left_string, left_length); // Not +1 because don't need the zero terminator.\n\t\t\t\t\ttmemcpy(this_token.marker + left_length, right_string, right_length + 1); // +1 to include its zero terminator.\n\t\t\t\t\tthis_token.marker_length = result_size - 1;\n\t\t\t\t\tresult_symbol = SYM_STRING;\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase SYM_IS:\n\t\t\t\t{\n\t\t\t\t\tif (Object *right_obj = dynamic_cast<Object *>(TokenToObject(right)))\n\t\t\t\t\t{\n\t\t\t\t\t\tif (IObject *prototype = right_obj->GetOwnPropObj(_T(\"Prototype\")))\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tthis_token.value_int64 = Object::HasBase(left, prototype);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t// Since \"break\" was not used, \"right\" is not a valid type object.\n\t\t\t\t\terror_info = _T(\"Class\");\n\t\t\t\t\terror_value = &right;\n\t\t\t\t\tgoto type_mismatch;\n\t\t\t\t}\n\n\t\t\t\tdefault:\n\t\t\t\t\t// All other operators do not support non-numeric operands.\n\t\t\t\t\terror_info = _T(\"Number\");\n\t\t\t\t\terror_value = right_is_number ? &left : &right; // Must use right_is_number since if it's false, left_is_number wasn't set.\n\t\t\t\t\tgoto type_mismatch;\n\t\t\t\t}\n\t\t\t\tthis_token.symbol = result_symbol; // Must be done only after the switch() above.\n\t\t\t}\n\n\t\t\telse if (right_is_number == PURE_INTEGER && left_is_number == PURE_INTEGER && this_token.symbol != SYM_DIVIDE)\n\t\t\t{\n\t\t\t\t// Because both are integers and the operation isn't division, the result is integer.\n\t\t\t\tright_int64 = TokenToInt64(right); // It can't be SYM_STRING because in here, both right and\n\t\t\t\tleft_int64 = TokenToInt64(left); // left are known to be numbers (otherwise an earlier \"else if\" would have executed instead of this one).\n\t\t\t\tresult_symbol = SYM_INTEGER; // Set default.\n\t\t\t\tswitch(this_token.symbol)\n\t\t\t\t{\n\t\t\t\t// The most common cases are kept up top to enhance performance if switch() is implemented as if-else ladder.\n\t\t\t\tcase SYM_ADD:\t\t\tthis_token.value_int64 = left_int64 + right_int64; break;\n\t\t\t\tcase SYM_SUBTRACT:\t\tthis_token.value_int64 = left_int64 - right_int64; break;\n\t\t\t\tcase SYM_MULTIPLY:\t\tthis_token.value_int64 = left_int64 * right_int64; break;\n\t\t\t\t// A look at K&R confirms that relational/comparison operations and logical-AND/OR/NOT\n\t\t\t\t// always yield a one or a zero rather than arbitrary non-zero values:\n\t\t\t\tcase SYM_EQUALCASE: // Same behavior as SYM_EQUAL for numeric operands.\n\t\t\t\tcase SYM_EQUAL:\t\t\tthis_token.value_int64 = left_int64 == right_int64; break;\n\t\t\t\tcase SYM_NOTEQUALCASE: // Same behavior as SYM_NOTEQUAL for numeric operands.\n\t\t\t\tcase SYM_NOTEQUAL:\t\tthis_token.value_int64 = left_int64 != right_int64; break;\n\t\t\t\tcase SYM_GT:\t\t\tthis_token.value_int64 = left_int64 > right_int64; break;\n\t\t\t\tcase SYM_LT:\t\t\tthis_token.value_int64 = left_int64 < right_int64; break;\n\t\t\t\tcase SYM_GTOE:\t\t\tthis_token.value_int64 = left_int64 >= right_int64; break;\n\t\t\t\tcase SYM_LTOE:\t\t\tthis_token.value_int64 = left_int64 <= right_int64; break;\n\t\t\t\tcase SYM_BITAND:\t\tthis_token.value_int64 = left_int64 & right_int64; break;\n\t\t\t\tcase SYM_BITOR:\t\t\tthis_token.value_int64 = left_int64 | right_int64; break;\n\t\t\t\tcase SYM_BITXOR:\t\tthis_token.value_int64 = left_int64 ^ right_int64; break;\n\t\t\t\tcase SYM_BITSHIFTLEFT:\n\t\t\t\tcase SYM_BITSHIFTRIGHT:\n\t\t\t\tcase SYM_BITSHIFTRIGHT_LOGICAL:\n\t\t\t\t\tif (right_int64 < 0 || right_int64 > 63)\n\t\t\t\t\t\tgoto abort_with_exception;\n\t\t\t\t\tif (this_token.symbol == SYM_BITSHIFTRIGHT_LOGICAL)\n\t\t\t\t\t\tthis_token.value_int64 = (unsigned __int64)left_int64 >> right_int64;\n\t\t\t\t\telse\n\t\t\t\t\t\tthis_token.value_int64 = this_token.symbol == SYM_BITSHIFTLEFT\n\t\t\t\t\t\t? left_int64 << right_int64\n\t\t\t\t\t\t: left_int64 >> right_int64;\n\t\t\t\t\tbreak;\n\t\t\t\tcase SYM_INTEGERDIVIDE:\n\t\t\t\t\tif (right_int64 == 0)\n\t\t\t\t\t\tgoto divide_by_zero;\n\t\t\t\t\tthis_token.value_int64 = left_int64 / right_int64;\n\t\t\t\t\tbreak;\n\t\t\t\tcase SYM_POWER:\n\t\t\t\t\tif (!left_int64 && right_int64 < 0) // In essence, this is divide-by-zero.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Throw an exception rather than returning something undefined:\n\t\t\t\t\t\tgoto divide_by_zero;\n\t\t\t\t\t}\n\t\t\t\t\telse if (left_int64 == 0 && right_int64 == 0)\t// 0**0, not defined.\n\t\t\t\t\t{\n\t\t\t\t\t\tgoto abort_with_exception;\n\t\t\t\t\t}\n\t\t\t\t\telse // We have a valid base and exponent and both are integers, so the calculation will always have a defined result.\n\t\t\t\t\t{\n\t\t\t\t\t\tif (right_int64 >= 0)\t// result is an integer.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tthis_token.value_int64 = pow_ll(left_int64, right_int64);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tresult_symbol = SYM_FLOAT; // Due to negative exponent, override to float.\n#ifdef USE_INLINE_ASM\t// see qmath.h\n\t\t\t\t\t\t// Note: The function pow() in math.h adds about 28 KB of code size (uncompressed)! That is why it's not used here.\n\t\t\t\t\t\t// v1.0.44.11: With Laszlo's help, negative integer bases are now supported.\n\t\t\t\t\t\tif (left_was_negative = (left_int64 < 0))\n\t\t\t\t\t\t\tleft_int64 = -left_int64; // Force a positive due to the limitations of qmathPow().\n\t\t\t\t\t\tthis_token.value_double = qmathPow((double)left_int64, (double)right_int64);\n\t\t\t\t\t\tif (left_was_negative && right_int64 % 2) // Negative base and odd exponent (not zero or even).\n\t\t\t\t\t\t\tthis_token.value_double = -this_token.value_double;\n#else\n\t\t\t\t\t\tthis_token.value_double = pow((double)left_int64, (double)right_int64);\n#endif\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tthis_token.symbol = result_symbol; // Must be done only after the switch() above.\n\t\t\t}\n\n\t\t\telse // Since one or both operands are floating point (or this is the division of two integers), the result will be floating point.\n\t\t\t{\n\t\t\t\tright_double = TokenToDouble(right, TRUE); // Pass TRUE for aCheckForHex in case one of them is an integer to\n\t\t\t\tleft_double = TokenToDouble(left, TRUE); // be converted to a float for the purpose of this calculation.\n\t\t\t\tresult_symbol = IS_RELATIONAL_OPERATOR(this_token.symbol) ? SYM_INTEGER : SYM_FLOAT; // Set default. v1.0.47.01: Changed relational operators to yield integers vs. floats because it's more intuitive and traditional (might also make relational operators perform better).\n\t\t\t\tswitch(this_token.symbol)\n\t\t\t\t{\n\t\t\t\tcase SYM_ADD: this_token.value_double = left_double + right_double; break;\n\t\t\t\tcase SYM_SUBTRACT: this_token.value_double = left_double - right_double; break;\n\t\t\t\tcase SYM_MULTIPLY: this_token.value_double = left_double * right_double; break;\n\t\t\t\tcase SYM_DIVIDE:\n\t\t\t\t\tif (right_double == 0.0)\n\t\t\t\t\t\tgoto divide_by_zero;\n\t\t\t\t\tthis_token.value_double = left_double / right_double;\n\t\t\t\t\tbreak;\n\t\t\t\tcase SYM_EQUALCASE: // Same behavior as SYM_EQUAL for numeric operands.\n\t\t\t\tcase SYM_EQUAL: this_token.value_int64 = left_double == right_double; break;\n\t\t\t\tcase SYM_NOTEQUALCASE: // Same behavior as SYM_NOTEQUAL for numeric operands.\n\t\t\t\tcase SYM_NOTEQUAL: this_token.value_int64 = left_double != right_double; break;\n\t\t\t\tcase SYM_GT: this_token.value_int64 = left_double > right_double; break;\n\t\t\t\tcase SYM_LT: this_token.value_int64 = left_double < right_double; break;\n\t\t\t\tcase SYM_GTOE: this_token.value_int64 = left_double >= right_double; break;\n\t\t\t\tcase SYM_LTOE: this_token.value_int64 = left_double <= right_double; break;\n\t\t\t\tcase SYM_POWER:\n\t\t\t\t\tif (left_double == 0.0 && right_double < 0) // In essence, this is divide-by-zero.\n\t\t\t\t\t\tgoto divide_by_zero;\n\t\t\t\t\tleft_was_negative = (left_double < 0);\n\t\t\t\t\tif ((left_was_negative && qmathFmod(right_double, 1.0) != 0.0)\t// Negative base, but exponent isn't close enough to being an integer: unsupported (to simplify code).\n\t\t\t\t\t\t|| (left_double == 0.0 && right_double == 0.0))\t\t\t\t// 0.0**0.0, not defined.\n\t\t\t\t\t\tgoto abort_with_exception;\n#ifdef USE_INLINE_ASM\t// see qmath.h\n\t\t\t\t\t// v1.0.44.11: With Laszlo's help, negative bases are now supported as long as the exponent is not fractional.\n\t\t\t\t\t// See the other SYM_POWER higher above for more details about below.\n\t\t\t\t\tif (left_was_negative)\n\t\t\t\t\t\tleft_double = -left_double; // Force a positive due to the limitations of qmathPow().\n\t\t\t\t\tthis_token.value_double = qmathPow(left_double, right_double);\n\t\t\t\t\tif (left_was_negative && qmathFabs(qmathFmod(right_double, 2.0)) == 1.0) // Negative base and exactly-odd exponent (otherwise, it can only be zero or even because if not it would have returned higher above).\n\t\t\t\t\t\tthis_token.value_double = -this_token.value_double;\n#else\n\t\t\t\t\tthis_token.value_double = pow(left_double, right_double);\n#endif\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\tif (IS_INTEGER_OPERATOR(this_token.symbol))\n\t\t\t\t\t{\n\t\t\t\t\t\terror_info = _T(\"Integer\");\n\t\t\t\t\t\terror_value = left_is_number == PURE_INTEGER ? &right : &left;\n\t\t\t\t\t\tgoto type_mismatch; // floats are not supported for the integer operators.\n\t\t\t\t\t}\n\t\t\t\t\t// this is should not be reachable.\n#ifdef _DEBUG\n\t\t\t\t\tLineError(_T(\"Unhandled float operation.\")); // To help catch bugs.\n\t\t\t\t\tgoto abort;\n#endif\n\t\t\t\t} // switch(this_token.symbol)\n\t\t\t\tthis_token.symbol = result_symbol; // Must be done only after the switch() above.\n\t\t\t} // Result is floating point.\n\t\t} // switch() operator type\n\n\t\tif (sym_assign_var) // Added in v1.0.46. There are some places higher above that handle sym_assign_var themselves and skip this section via goto.\n\t\t{\n\t\t\tif (!sym_assign_var->Assign(this_token)) // Assign the result (based on its type) to the target variable.\n\t\t\t\tgoto abort;\n\t\t\tif (sym_assign_var->Type() == VAR_NORMAL)\n\t\t\t\tthis_token.SetVar(sym_assign_var);\n\t\t\t//else its VAR_VIRTUAL, so just push this_token as-is because after its assignment is done,\n\t\t\t// it should no longer be a SYM_VAR. This is done to simplify the code, such as BIFs.\n\t\t\t//\n\t\t\t// Now fall through and push this_token onto the stack as an operand for use by future operators.\n\t\t\t// This is because by convention, an assignment like \"x+=1\" produces a usable operand.\n\t\t}\n\npush_this_token:\n\t\tASSERT(stack_count < mArg[aArgIndex].max_stack);\n\t\tSTACK_PUSH(&this_token); // Push the result onto the stack for use as an operand by a future operator.\n\t} // For each item in the postfix array.\n\n\tif (stack_count != 1) // Even for multi-statement expressions, the stack should have only one item left on it:\n\t\tgoto abort_with_exception; // the overall result. Any conditions that cause this *should* be detected at load time.\n\n\tExprTokenType &result_token = *stack[0]; // For performance and convenience. Even for multi-statement, the bottommost item on the stack is the final result so that things like var1:=1,var2:=2 work.\n\n\t// Although ACT_EXPRESSION was already checked higher above for function calls, there are other ways besides\n\t// an isolated function call to have ACT_EXPRESSION. For example: var&=3 (where &= is an operator that lacks\n\t// a corresponding command). Another example: true ? fn1() : fn2()\n\t// Also, there might be ways the function-call section didn't return for ACT_EXPRESSION, such as when somehow\n\t// there was more than one token on the stack even for the final function call, or maybe other unforeseen ways.\n\t// It seems best to avoid any chance of looking at the result since it might be invalid due to the above\n\t// having taken shortcuts (since it knew the result would be discarded).\n\tif (mActionType == ACT_EXPRESSION || mActionType == ACT_STATIC) // A stand-alone expression whose end result doesn't matter.\n\t\tgoto normal_end_skip_output_var; // Can't be any output_var for this action type. Also, leave result_to_return at its default of \"\".\n\n\tif (output_var)\n\t{\n\t\t// v1.0.45: Take a shortcut, which in the case of SYM_STRING/OPERAND/VAR avoids one memcpy\n\t\t// (into the deref buffer). In some cases, this also saves from having to expand the deref buffer.\n\t\tif (!output_var->Assign(result_token))\n\t\t\tgoto abort;\n\t\tgoto normal_end_skip_output_var; // result_to_return is left at its default of \"\", though its value doesn't matter as long as it isn't NULL.\n\t}\n\n\tif (mActionType == ACT_IF || mActionType == ACT_WHILE || mActionType == ACT_UNTIL)\n\t{\n\t\t// This is an optimization that improves the speed of ACT_IF by up to 50% (ACT_WHILE is\n\t\t// probably improved by only up-to-15%). Simple expressions like \"if (x < y)\" see the biggest\n\t\t// speedup.\n\t\tresult_to_return = TokenToBOOL(result_token) ? _T(\"1\") : _T(\"\"); // Return \"\" vs. \"0\" for FALSE for consistency with \"goto abnormal_end\" (which bypasses this section).\n\t\tgoto normal_end_skip_output_var; // ACT_IF never has an output_var.\n\t}\n\t\n\tif (aResultToken)\n\t{\n\t\tswitch (result_token.symbol)\n\t\t{\n\t\tcase SYM_INTEGER:\n\t\tcase SYM_FLOAT:\n\t\tcase SYM_OBJECT:\n\t\tcase SYM_MISSING: // return unset\n\t\t\t// Return numeric or object result as-is.\n\t\t\taResultToken->symbol = result_token.symbol;\n\t\t\taResultToken->value_int64 = result_token.value_int64; // Union copy.\n\t\t\tif (result_token.symbol == SYM_OBJECT)\n\t\t\t\tresult_token.object->AddRef();\n\t\t\tgoto normal_end_skip_output_var; // result_to_return is left at its default of \"\".\n\t\tcase SYM_VAR:\n\t\t\tif (result_token.var->IsPureNumericOrObject())\n\t\t\t{\n\t\t\t\tresult_token.var->ToToken(*aResultToken);\n\t\t\t\tgoto normal_end_skip_output_var; // result_to_return is left at its default of \"\".\n\t\t\t}\n\t\t\t// The following \"optimizations\" are avoided because of hidden complexity, most notably\n\t\t\t// unwanted consequences with try-finally (which allows the script to read or modify the\n\t\t\t// variable after we return):\n\t\t\t// - Return a local variable's string buffer directly, detaching it from the variable.\n\t\t\t// The idea was that the variable is about to be freed anyway, but there are exceptions.\n\t\t\t// - Return a static or global variable's string directly.\n\t\t\tbreak;\n\t\tcase SYM_STRING:\n\t\t\tif (to_free_count && to_free[to_free_count - 1] == &result_token)\n\t\t\t{\n\t\t\t\t// Pass this mem item back to caller instead of freeing it when we return.\n\t\t\t\taResultToken->AcceptMem(result_to_return = result_token.marker, result_token.marker_length);\n\t\t\t\t--to_free_count;\n\t\t\t\tgoto normal_end_skip_output_var;\n\t\t\t}\n\t\t}\n\t\t// Since above didn't return, the result is a string. Continue on below to copy it into persistent memory.\n\t}\n\t\n\tif (result_token.symbol == SYM_MISSING) // No valid cases permit this as a final result except those already handled above. Some sections below might not handle it.\n\t\tgoto abort_with_exception;\n\n\t//\n\t// Store the result of the expression in the deref buffer for the caller.\n\t//\n\tresult_to_return = aTarget; // Set default.\n\tswitch (result_token.symbol)\n\t{\n\tcase SYM_INTEGER:\n\t\t// SYM_INTEGER and SYM_FLOAT will fit into our deref buffer because an earlier stage has already ensured\n\t\t// that the buffer is large enough to hold at least one number. But a string/generic might not fit if it's\n\t\t// a concatenation and/or a large string returned from a called function.\n\t\taTarget += _tcslen(ITOA64(result_token.value_int64, aTarget)) + 1; // Store in hex or decimal format, as appropriate.\n\t\t// Above: +1 because that's what callers want; i.e. the position after the terminator.\n\t\tgoto normal_end_skip_output_var; // output_var was already checked higher above, so no need to consider it again.\n\tcase SYM_FLOAT:\n\t\taTarget += FTOA(result_token.value_double, aTarget, MAX_NUMBER_SIZE) + 1; // +1 because that's what callers want; i.e. the position after the terminator.\n\t\tgoto normal_end_skip_output_var; // output_var was already checked higher above, so no need to consider it again.\n\tdefault:\n\t\t// At this stage, we know the result has to go into our deref buffer because if a way existed to\n\t\t// avoid that, we would already have goto/returned higher above (e.g. for ACT_ASSIGNEXPR OR ACT_EXPRESSION.\n\t\t// Also, at this stage, the pending result can exist in one of several places:\n\t\t// 1) Our deref buf (due to being a single-deref, a function's return value that was copied to the\n\t\t// end of our buf because there was enough room, etc.)\n\t\t// 2) In a called function's deref buffer, namely sDerefBuf, which will be deleted by our caller\n\t\t// shortly after we return to it.\n\t\t// 3) In an area of memory we alloc'd for lack of any better place to put it.\n\t\tif (result_token.symbol == SYM_VAR)\n\t\t{\n\t\t\tresult = result_token.var->Contents();\n\t\t\tresult_length = result_token.var->Length();\n\t\t}\n\t\telse\n\t\t{\n\t\t\tresult = result_token.marker;\n\t\t\tresult_length = result_token.marker_length; // At this stage, marker_length should always be valid, not -1.\n\t\t}\n\t\tresult_size = result_length + 1;\n\n\t\t// Notes about the macro below:\n\t\t// Space is needed for whichever of the following is greater (since only one of the following is in\n\t\t// the deref buf at any given time; i.e. they can share the space by being in it at different times):\n\t\t// 1) All the expression's literal strings/numbers and double-derefs (e.g. \"Array%i%\" as a string).\n\t\t// Allowing room for this_arg.length plus a terminator seems enough for any conceivable\n\t\t// expression, even worst-cases and malformatted syntax-error expressions. This is because\n\t\t// every numeric literal or double-deref needs to have some kind of symbol or character\n\t\t// between it and the next one or it would never have been recognized as a separate operand\n\t\t// in the first place. And the final item uses the final terminator provided via +1 below.\n\t\t// 2) Any numeric result (i.e. MAX_NUMBER_LENGTH). If the expression needs to store a string\n\t\t// result, it will take care of expanding the deref buffer.\n\t\t#define EXPR_BUF_SIZE(raw_expr_len) (raw_expr_len < MAX_NUMBER_LENGTH \\\n\t\t\t? MAX_NUMBER_LENGTH : raw_expr_len) + 1 // +1 for the overall terminator.\n\n\t\t// If result is the empty string or a number, it should always fit because the size estimation\n\t\t// phase has ensured that capacity_of_our_buf_portion is large enough to hold those.\n\t\t// In addition, it doesn't matter if we already used target/aTarget for things higher above\n\t\t// because anything in there we're now done with, and memmove() vs. memcpy() later below\n\t\t// will allow overlap of the final result with intermediate results already in the buffer.\n\t\tsize_t capacity_of_our_buf_portion;\n\t\tcapacity_of_our_buf_portion = EXPR_BUF_SIZE(mArg[aArgIndex].length) + aExtraSize; // The initial amount of size available to write our final result.\n\t\tif (result_size > capacity_of_our_buf_portion)\n\t\t{\n\t\t\t// Do a simple expansion of our deref buffer to handle the fact that our actual result is bigger\n\t\t\t// than the size estimator could have calculated (due to a concatenation or a large string returned\n\t\t\t// from a called function). This performs poorly but seems justified by the fact that it typically\n\t\t\t// happens only in extreme cases.\n\t\t\tsize_t new_buf_size = aDerefBufSize + (result_size - capacity_of_our_buf_portion);\n\n\t\t\t// malloc() and free() are used instead of realloc() because in many cases, the overhead of\n\t\t\t// realloc()'s internal memcpy(entire contents) can be avoided because only part or\n\t\t\t// none of the contents needs to be copied (realloc's ability to do an in-place resize might\n\t\t\t// be unlikely for anything other than small blocks; see compiler's realloc.c):\n\t\t\tLPTSTR new_buf;\n\t\t\tif ( !(new_buf = tmalloc(new_buf_size)) )\n\t\t\t\tgoto outofmem;\n\t\t\tif (new_buf_size > LARGE_DEREF_BUF_SIZE)\n\t\t\t\t++sLargeDerefBufs; // And if the old deref buf was larger too, this value is decremented later below. SET_DEREF_TIMER() is handled by our caller because aDerefBufSize is updated further below, which the caller will see.\n\n\t\t\t// Copy only that portion of the old buffer that is in front of our portion of the buffer\n\t\t\t// because we no longer need our portion (except for result.marker if it happens to be\n\t\t\t// in the old buffer, but that is handled after this):\n\t\t\tsize_t aTarget_offset = aTarget - aDerefBuf;\n\t\t\tif (aTarget_offset) // aDerefBuf has contents that must be preserved.\n\t\t\t\ttmemcpy(new_buf, aDerefBuf, aTarget_offset); // This will also copy the empty string if the buffer first and only character is that.\n\t\t\taTarget = new_buf + aTarget_offset;\n\t\t\tresult_to_return = aTarget; // Update to reflect new value above.\n\t\t\t// NOTE: result_token.marker might extend too far to the right in our deref buffer and thus be\n\t\t\t// larger than capacity_of_our_buf_portion because other arg(s) exist in this line after ours\n\t\t\t// that will be using a larger total portion of the buffer than ours. Thus, the following must be\n\t\t\t// done prior to free(), but memcpy() vs. memmove() is safe in any case:\n\t\t\ttmemcpy(aTarget, result, result_length); // Copy from old location to the newly allocated one.\n\t\t\taTarget[result_length] = '\\0'; // Guarantee null-termination so it doesn't have to be done at an earlier stage.\n\n\t\t\tfree(aDerefBuf); // Free our original buffer since it's contents are no longer needed.\n\t\t\tif (aDerefBufSize > LARGE_DEREF_BUF_SIZE)\n\t\t\t\t--sLargeDerefBufs;\n\n\t\t\t// Now that the buffer has been enlarged, need to adjust any other pointers that pointed into\n\t\t\t// the old buffer:\n\t\t\tLPTSTR aDerefBuf_end = aDerefBuf + aDerefBufSize; // Point it to the character after the end of the old buf.\n\t\t\tfor (i = 0; i < aArgIndex; ++i) // Adjust each item beneath ours (if any). Our own is not adjusted because we'll be returning the right address to our caller.\n\t\t\t\tif (aArgDeref[i] >= aDerefBuf && aArgDeref[i] < aDerefBuf_end)\n\t\t\t\t\taArgDeref[i] = new_buf + (aArgDeref[i] - aDerefBuf); // Set for our caller.\n\t\t\t// The following isn't done because target isn't used anymore at this late a stage:\n\t\t\t//target = new_buf + (target - aDerefBuf);\n\t\t\taDerefBuf = new_buf; // Must be the last step, since the old address is used above. Set for our caller.\n\t\t\taDerefBufSize = new_buf_size; // Set for our caller.\n\t\t}\n\t\telse // Deref buf is already large enough to fit the string.\n\t\t{\n\t\t\ttmemmove(aTarget, result, result_length); // memmove() vs. memcpy() in this case, since source and dest might overlap (i.e. \"target\" may have been used to put temporary things into aTarget, but those things are no longer needed and now safe to overwrite).\n\t\t\taTarget[result_length] = '\\0'; // Guarantee null-termination so it doesn't have to be done at an earlier stage.\n\t\t}\n\t\tif (aResultToken)\n\t\t{\n\t\t\taResultToken->marker = aTarget;\n\t\t\taResultToken->marker_length = result_length;\n\t\t}\n\t\taTarget += result_size;\n\t\tgoto normal_end_skip_output_var; // output_var was already checked higher above, so no need to consider it again.\n\n\tcase SYM_OBJECT:\n\t\t// At this point we aren't capable of returning an object, otherwise above would have\n\t\t// already returned. So in other words, the caller wants a string, not an object.\n\t\terror_info = _T(\"String\");\n\t\terror_value = &result_token;\n\t\tgoto type_mismatch;\n\t} // switch (result_token.symbol)\n\n// ALL PATHS ABOVE SHOULD \"GOTO\". TO CATCH BUGS, ANY THAT DON'T FALL INTO \"ABORT\" BELOW.\nabort_with_exception:\n\taResult = LineError(error_msg, FAIL_OR_OK, error_info);\n\t// FALL THROUGH:\nabort_if_result:\n\tif (aResult != FAIL)\n\t{\n\t\tif (aResultToken)\n\t\t\taResultToken->symbol = SYM_MISSING;\n\t\tgoto normal_end_skip_output_var;\n\t}\n\t// FALL THROUGH:\nabort:\n\t// The callers of this function know that the value of aResult (which contains the reason\n\t// for early exit) should be considered valid/meaningful only if result_to_return is NULL.\n\tresult_to_return = NULL; // Use NULL to inform our caller that this entire thread is to be terminated.\n\taResult = FAIL; // Indicate reason to caller.\n\tgoto normal_end_skip_output_var; // output_var is skipped as part of standard abort behavior.\n\ntype_mismatch:\n\t{\n\t\tResultToken temp_result;\n\t\ttemp_result.SetResult(OK);\n\t\ttemp_result.TypeError(error_info, *error_value);\n\t\taResult = temp_result.Result(); // FAIL to abort, OK if user or OnError requested continuation.\n\t\tgoto abort_if_result;\n\t}\ndivide_by_zero:\n\taResult = g_script.RuntimeError(ERR_DIVIDEBYZERO, nullptr, FAIL_OR_OK, this, ErrorPrototype::ZeroDivision);\n\tgoto abort_if_result;\noutofmem:\n\taResult = MemoryError();\n\tgoto abort_if_result;\nunset_var:\n\taResult = g_script.VarUnsetError(error_value->var);\n\tgoto abort_if_result;\n\n//normal_end: // This isn't currently used, but is available for future-use and readability.\n\t// v1.0.45: ACT_ASSIGNEXPR relies on us to set the output_var (i.e. whenever it's ARG1's is_expression==true).\n\t// Our taking charge of output_var allows certain performance optimizations in other parts of this function,\n\t// such as avoiding excess memcpy's and malloc's during intermediate stages.\n\t// v2: Leave output_var unchanged in this case so that ACT_ASSIGNEXPR behaves the same as SYM_ASSIGN.\n\t//if (output_var && result_to_return) // i.e. don't assign if NULL to preserve backward compatibility with scripts that rely on the old value being changed in cases where an expression fails (unlikely).\n\t//\tif (!output_var->Assign(result_to_return))\n\t//\t\taResult = FAIL;\n\nnormal_end_skip_output_var:\n\tfor (i = to_free_count; i--;) // Free any temporary memory blocks that were used. Using reverse order might reduce memory fragmentation a little (depending on implementation of malloc).\n\t{\n\t\tif (to_free[i]->symbol == SYM_STRING)\n\t\t\tfree(to_free[i]->marker);\n\t\telse // SYM_OBJECT\n\t\t\tto_free[i]->object->Release();\n\t}\n\n\treturn result_to_return;\n}\n\n\n\nResultType Line::ExpandSingleArg(int aArgIndex, ResultToken &aResultToken, LPTSTR &aDerefBuf, size_t &aDerefBufSize)\n{\n\tExprTokenType *postfix = mArg[aArgIndex].postfix;\n\tif (postfix->symbol < SYM_DYNAMIC // i.e. any other operand type.\n\t\t&& postfix->symbol != SYM_VAR // Variables must be dereferenced.\n\t\t&& postfix[1].symbol == SYM_INVALID) // Exactly one token.\n\t{\n\t\taResultToken.symbol = postfix->symbol;\n\t\taResultToken.value_int64 = postfix->value_int64;\n#ifdef _WIN64\n\t\taResultToken.marker_length = postfix->marker_length;\n#endif\n\t\tif (aResultToken.symbol == SYM_OBJECT) // This can happen for VAR_CONSTANT.\n\t\t\taResultToken.object->AddRef();\n\t\treturn OK;\n\t}\n\n\tsize_t space_needed = EXPR_BUF_SIZE(mArg[aArgIndex].length);\n\n\tif (aDerefBufSize < space_needed)\n\t{\n\t\tif (aDerefBuf)\n\t\t{\n\t\t\tfree(aDerefBuf);\n\t\t\tif (aDerefBufSize > LARGE_DEREF_BUF_SIZE)\n\t\t\t\t--sLargeDerefBufs;\n\t\t}\n\t\tif ( !(aDerefBuf = tmalloc(space_needed)) )\n\t\t{\n\t\t\taDerefBufSize = 0;\n\t\t\treturn MemoryError();\n\t\t}\n\t\taDerefBufSize = space_needed;\n\t\tif (aDerefBufSize > LARGE_DEREF_BUF_SIZE)\n\t\t\t++sLargeDerefBufs;\n\t}\n\n\t// Use the whole buf:\n\tLPTSTR buf_marker = aDerefBuf;\n\tsize_t extra_size = aDerefBufSize - space_needed;\n\n\t// None of the previous args (if any) are needed, so pass an array of NULLs:\n\tLPTSTR arg_deref[MAX_ARGS];\n\tfor (int i = 0; i < aArgIndex; i++)\n\t\targ_deref[i] = NULL;\n\n\t// Initialize aResultToken so we can detect when ExpandExpression() uses it:\n\taResultToken.symbol = SYM_INVALID;\n\t\n\tResultType result;\n\tLPTSTR string_result = ExpandExpression(aArgIndex, result, &aResultToken, buf_marker, aDerefBuf, aDerefBufSize, arg_deref, extra_size);\n\tif (!string_result)\n\t\treturn result; // Should be EARLY_EXIT or FAIL.\n\n\tif (aResultToken.symbol == SYM_INVALID) // It wasn't set by ExpandExpression().\n\t{\n\t\taResultToken.symbol = SYM_STRING;\n\t\taResultToken.marker = string_result;\n\t}\n\treturn OK;\n}\n\n\n\nResultType VariadicCall(IObject *aObj, IObject_Invoke_PARAMS_DECL)\n{\n\tIObject *param_obj = nullptr; // Vararg object passed by caller.\n\tArray *param_array = nullptr; // Array of parameters, either the same as param_obj or the result of enumeration.\n\tExprTokenType* token = nullptr; // Used for variadic calls.\n\n\tExprTokenType *rvalue = IS_INVOKE_SET ? aParam[--aParamCount] : nullptr;\n\n\t--aParamCount; // Exclude param_obj from aParamCount, so it's the count of normal params.\n\tparam_obj = TokenToObject(*aParam[aParamCount]);\n\t// It might be more correct to use the enumerator even for Array, but that could be slow.\n\t// Future changes might enable efficient detection of a custom __Enum method, allowing\n\t// us to take the more efficient path most times, but still support custom enumeration.\n\tif (param_array = dynamic_cast<Array *>(param_obj))\n\t\tparam_array->AddRef();\n\telse\n\t\tif (!(param_array = Array::FromEnumerable(*aParam[aParamCount])))\n\t\t\treturn aResultToken.SetExitResult(FAIL);\n\tint extra_params = param_array->Length();\n\tif (extra_params > 0)\n\t{\n\t\t// Calculate space required for ...\n\t\tsize_t space_needed = extra_params * sizeof(ExprTokenType) // ... new param tokens\n\t\t\t+ (aParamCount + extra_params) * sizeof(ExprTokenType *); // ... existing and new param pointers\n\t\tif (rvalue)\n\t\t\tspace_needed += sizeof(rvalue); // ... extra slot for aRValue\n\t\t// Allocate new param list and tokens; tokens first for convenience.\n\t\ttoken = (ExprTokenType *)_malloca(space_needed);\n\t\tif (!token)\n\t\t\treturn aResultToken.MemoryError();\n\t\tExprTokenType **param_list = (ExprTokenType **)(token + extra_params);\n\t\t// Since built-in functions don't have variables we can directly assign to,\n\t\t// we need to expand the param object's contents into an array of tokens:\n\t\tparam_array->ToParams(token, param_list, aParam, aParamCount);\n\t\taParam = param_list;\n\t\taParamCount += extra_params;\n\t}\n\tif (rvalue)\n\t\taParam[aParamCount++] = rvalue; // In place of the variadic param.\n\n#ifdef ENABLE_HALF_BAKED_NAMED_PARAMS\n\taResultToken.named_params = param_obj;\n#endif\n\n\tauto result = aObj->Invoke(aResultToken, aFlags, aName, aThisToken, aParam, aParamCount);\n\n\tif (param_array)\n\t\tparam_array->Release();\n\tif (token)\n\t\t_freea(token);\n\t\n\treturn result;\n}\n\n\n\nbool Func::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (aParamCount > mParamCount && !mIsVariadic) // v2 policy.\n\t{\n\t\tfor ( ; aParamCount && aParam[aParamCount - 1]->symbol == SYM_MISSING; --aParamCount);\n\t\tif (aParamCount > mParamCount)\n\t\t{\n\t\t\taResultToken.Error(ERR_TOO_MANY_PARAMS, mName);\n\t\t\treturn false;\n\t\t}\n\t}\n\treturn true;\n}\n\nbool NativeFunc::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (!Func::Call(aResultToken, aParam, aParamCount))\n\t\treturn false;\n\n\t\t// mMinParams is validated at load-time where possible; so not for variadic or dynamic calls,\n\t\t// nor for calls via objects. This check could be avoided for normal calls by instead checking\n\t\t// in each of the above cases, but any performance gain would probably be marginal and not worth\n\t\t// the slightly larger code size and loss of maintainability. This check is not done for UDFS\n\t\t// since param_obj might contain the remaining parameters as name-value pairs. Missing required\n\t\t// parameters are instead detected by the absence of a default value.\n\t\tif (aParamCount < mMinParams)\n\t\t{\n\t\t\taResultToken.Error(ERR_TOO_FEW_PARAMS, mName);\n\t\t\treturn false; // Abort expression.\n\t\t}\n\t\t\n\t\tfor (int i = 0; i < mMinParams; ++i)\n\t\t{\n\t\t\tif (aParam[i]->symbol == SYM_MISSING\n\t\t\t\t&& !ArgIsOptional(i)) // BuiltInMethod requires this exception for some setters.\n\t\t\t{\n\t\t\t\taResultToken.Error(ERR_PARAM_REQUIRED);\n\t\t\t\treturn false; // Abort expression.\n\t\t\t}\n\t\t}\n\n\treturn true;\n}\n\nbool BuiltInFunc::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (!NativeFunc::Call(aResultToken, aParam, aParamCount))\n\t\treturn false;\n\n\taResultToken.func = this; // Inform function of which built-in function called it (allows code sharing/reduction).\n\n\t\t// Push an entry onto the debugger's stack. This has two purposes:\n\t\t// 1) Allow CreateRuntimeException() to know which function is throwing an exception.\n\t\t// 2) If a UDF is called before the BIF returns, it will show on the call stack.\n\t\t// e.g. DllCall(RegisterCallback(\"F\")) will show DllCall while F is running.\n\t\tDEBUGGER_STACK_PUSH(this)\n\n\t\taResultToken.symbol = SYM_INTEGER; // Set default return type so that functions don't have to do it if they return INTs.\n\t\tmBIF(aResultToken, aParam, aParamCount);\n\n\t\tDEBUGGER_STACK_POP()\n\t\t\n\t\t// There shouldn't be any need to check g->ThrownToken since built-in functions\n\t\t// currently throw exceptions via aResultToken.Error():\n\t\t//if (g->ThrownToken)\n\t\t//\taResultToken.SetExitResult(FAIL); // Abort thread.\n\n\treturn !aResultToken.Exited();\n}\n\nbool BuiltInMethod::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\tif (!NativeFunc::Call(aResultToken, aParam, aParamCount))\n\t\treturn false;\n\n\tDEBUGGER_STACK_PUSH(this) // See comments in BuiltInFunc::Call.\n\n\tauto obj = TokenToObject(*aParam[0]);\n\t// mClass is the prototype object of the class which this method is for, such as\n\t// Object.Prototype or Map.Prototype. IsOfType() takes care of ruling out derived\n\t// prototype objects, which are always really just Object.\n\tif (!obj || !obj->IsOfType(mClass))\n\t{\n\t\tLPCTSTR expected_type = mClass->GetOwnPropString(_T(\"__Class\"));\n\t\tif (!expected_type)\n\t\t\texpected_type = _T(\"?\"); // Script may have tampered with the prototype.\n\t\taResultToken.TypeError(expected_type, *aParam[0]);\n\t}\n\telse\n\t\t(obj->*mBIM)(aResultToken, mMID, mMIT, aParam + 1, aParamCount - 1);\n\n\tDEBUGGER_STACK_POP()\n\n\treturn !aResultToken.Exited();\n}\n\nbool UserFunc::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount)\n{\n\treturn Call(aResultToken, aParam, aParamCount, nullptr);\n}\n\nbool UserFunc::Call(ResultToken &aResultToken, ExprTokenType *aParam[], int aParamCount, FreeVars *aUpVars)\n{\n\tif (!Func::Call(aResultToken, aParam, aParamCount))\n\t\treturn false;\n\n\t\tUDFCallInfo recurse(this);\n\n\t\tint j, count_of_actuals_that_have_formals;\n\t\tcount_of_actuals_that_have_formals = (aParamCount > mParamCount)\n\t\t\t? mParamCount // Omit any actuals that lack formals (this can happen when a dynamic call passes too many parameters).\n\t\t\t: aParamCount;\n\t\t\n\t\t// If there are other instances of this function already running, either via recursion or\n\t\t// an interrupted quasi-thread, back up the local variables of the instance that lies immediately\n\t\t// beneath ours (in turn, that instance is responsible for backing up any instance that lies\n\t\t// beneath it, and so on, since when recursion collapses or threads resume, they always do so\n\t\t// in the reverse order in which they were created.\n\t\t//\n\t\t// I think the backup-and-restore approach to local variables might enhance performance over\n\t\t// other approaches, perhaps a lot. This is because most of the time there will be no other\n\t\t// instances of a given function on the call stack, thus no backup/restore is needed, and thus\n\t\t// the function's existing local variables can be reused as though they're globals (i.e.\n\t\t// memory allocation/deallocation overhead is often completely avoided for non-recursive calls\n\t\t// to a function after the first).\n\t\tif (mInstances > 0) // i.e. treat negatives as zero to help catch any bugs in the way mInstances is maintained.\n\t\t{\n\t\t\t// Backup/restore of function's variables is needed.\n\t\t\t// Only when a backup is needed is it possible for this function to be calling itself recursively,\n\t\t\t// either directly or indirectly by means of an intermediate function. As a consequence, it's\n\t\t\t// possible for this function to be passing one or more of its own params or locals to itself.\n\t\t\tfor (j = 0; j < aParamCount; ++j) // For each actual parameter.\n\t\t\t{\n\t\t\t\tExprTokenType &this_param_token = *aParam[j];\n\t\t\t\tif (this_param_token.symbol != SYM_VAR\n\t\t\t\t\t|| VARREF_IS_WRITE(this_param_token.var_usage)) // VARREF_REF indicates SYM_VAR is being passed ByRef.\n\t\t\t\t\tcontinue;\n\t\t\t\t// Since this SYM_VAR is being passed by value, convert it to a non-var to allow\n\t\t\t\t// the variables to be backed up and reset further below without corrupting any\n\t\t\t\t// SYM_VARs that happen to be locals or params of this very same function.\n\t\t\t\t// Skip AddRef() if this is an object because Release() won't be called, and\n\t\t\t\t// AddRef() will be called when the object is assigned to a parameter.\n\t\t\t\tthis_param_token.var->ToTokenSkipAddRef(this_param_token);\n\t\t\t}\n\t\t\t// BackupFunctionVars() will also clear each local variable and formal parameter so that\n\t\t\t// if that parameter or local var is assigned a value by any other means during our call\n\t\t\t// to it, new memory will be allocated to hold that value rather than overwriting the\n\t\t\t// underlying recursed/interrupted instance's memory, which it will need intact when it's resumed.\n\t\t\tif (!Var::BackupFunctionVars(*this, recurse.backup, recurse.backup_count)) // Out of memory.\n\t\t\t{\n\t\t\t\taResultToken.MemoryError();\n\t\t\t\treturn false;\n\t\t\t}\n\t\t} // if (func.mInstances > 0)\n\t\t//else backup is not needed because there are no other instances of this function on the call-stack.\n\t\t// So by definition, this function is not calling itself directly or indirectly, therefore there's no\n\t\t// need to do the conversion of SYM_VAR because those SYM_VARs can't be ones that were blanked out\n\t\t// due to a function exiting. In other words, it seems impossible for a there to be no other\n\t\t// instances of this function on the call-stack and yet SYM_VAR to be one of this function's own\n\t\t// locals or formal params because it would have no legitimate origin.\n\n\t\t// From this point on, mInstances must be decremented before returning, even on error:\n\t\t++mInstances;\n\t\t\n\t\tFreeVars *caller_free_vars = sFreeVars;\n\t\t// The following was originally used to support direct calls while the outer function is running,\n\t\t// but such calls should no longer be possible as the script can only refer to the function via a\n\t\t// Closure, which provides a non-null value for aUpVars:\n\t\t//if (sFreeVars && mOuterFunc && !aUpVars)\n\t\t//\taUpVars = sFreeVars->ForFunc(mOuterFunc);\n\n\t\tif (mDownVarCount)\n\t\t{\n\t\t\t// These local vars need to persist after the function returns (and be independent of\n\t\t\t// any other instances of this function). Since we really only have one set of local\n\t\t\t// vars for the lifetime of the script, make them aliases for newly allocated vars:\n\t\t\tsFreeVars = FreeVars::Alloc(*this, mDownVarCount, aUpVars);\n\t\t\tfor (int i = 0; i < mDownVarCount; ++i)\n\t\t\t\tmDownVar[i]->SetAliasDirect(sFreeVars->mVar + i);\n\t\t}\n\t\telse\n\t\t\tsFreeVars = NULL;\n\t\t\n\t\tif (mUpVarCount)\n\t\t{\n\t\t\tif (!aUpVars)\n\t\t\t{\n\t\t\t\t// No aUpVars, so it must be a direct call, and mOuterFunc wasn't found in the sFreeVars\n\t\t\t\t// linked list, so it's probably a direct call from something which doesn't support closures,\n\t\t\t\t// occurring after mOuterFunc returned.\n\t\t\t\taResultToken.Error(_T(\"Func out of scope.\"), mName); // Keep it short since this shouldn't be possible once the implementation is complete.\n\t\t\t\tgoto free_and_return;\n\t\t\t}\n\t\t\tfor (int i = 0; i < mUpVarCount; ++i)\n\t\t\t{\n\t\t\t\tVar *outer_free_var = aUpVars->mVar + mUpVarIndex[i];\n\t\t\t\tif (mUpVar[i]->Scope() & VAR_DOWNVAR) // This is both an upvar and a downvar.\n\t\t\t\t{\n\t\t\t\t\tVar *inner_free_var = mUpVar[i]->ResolveAlias(); // Retrieve the alias which was just set above.\n\t\t\t\t\tinner_free_var->UpdateAlias(outer_free_var); // Point the free var of our layer to the outer one for use by closures within this function.\n\t\t\t\t\t// mUpVar[i] is now a two-level alias (mUpVar[i] -> inner_free_var -> outer_free_var),\n\t\t\t\t\t// but that will be corrected below. Technically outer_free_var might also be an alias,\n\t\t\t\t\t// in which case inner_free_var is now an alias for outer_free_var->mAliasFor.\n\t\t\t\t}\n\t\t\t\tmUpVar[i]->UpdateAlias(outer_free_var);\n\t\t\t}\n\t\t}\n\n\t\tif (mClosureCount)\n\t\t{\n\t\t\tASSERT(sFreeVars);\n\t\t\tfor (int i = 0; i < mClosureCount; ++i)\n\t\t\t{\n\t\t\t\tauto closure = new Closure(mClosure[i].func, sFreeVars\n\t\t\t\t\t, mClosure[i].var->Scope() & VAR_DOWNVAR); // Closures in downvars have lifetime tied to sFreeVars.\n\t\t\t\tVar *var = mClosure[i].var->ResolveAlias();\n\t\t\t\tvar->AssignSkipAddRef(closure);\n\t\t\t\tvar->MakeReadOnly();\n\t\t\t}\n\t\t}\n\n\t\tint default_expr = mParamCount;\n\t\tfor (j = 0; j < mParamCount; ++j) // For each formal parameter.\n\t\t{\n\t\t\tFuncParam &this_formal_param = mParam[j]; // For performance and convenience.\n\n\t\t\t// Assignments below rely on ByRef parameters having already been reset to VAR_NORMAL\n\t\t\t// by Free() or Backup(), except when it's a downvar, which should be VAR_ALIAS.\n\t\t\tASSERT((this_formal_param.var->Scope() & VAR_DOWNVAR) ? (this_formal_param.var->ResolveAlias()->Scope() & ~VAR_VARREF) == 0\n\t\t\t\t: !this_formal_param.var->IsAlias());\n\n\t\t\tif (j >= aParamCount || aParam[j]->symbol == SYM_MISSING)\n\t\t\t{\n#ifdef ENABLE_HALF_BAKED_NAMED_PARAMS\n\t\t\t\tif (aResultToken.named_params)\n\t\t\t\t{\n\t\t\t\t\tFuncResult rt_item;\n\t\t\t\t\tExprTokenType t_this(aResultToken.named_params);\n\t\t\t\t\tauto r = aResultToken.named_params->Invoke(rt_item, IT_GET, this_formal_param.var->mName, t_this, nullptr, 0);\n\t\t\t\t\tif (r == FAIL || r == EARLY_EXIT)\n\t\t\t\t\t{\n\t\t\t\t\t\taResultToken.SetExitResult(r);\n\t\t\t\t\t\tgoto free_and_return;\n\t\t\t\t\t}\n\t\t\t\t\tif (r != INVOKE_NOT_HANDLED)\n\t\t\t\t\t{\n\t\t\t\t\t\tthis_formal_param.var->Assign(rt_item);\n\t\t\t\t\t\trt_item.Free();\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t}\n#endif\n\t\t\t\n\t\t\t\tswitch(this_formal_param.default_type)\n\t\t\t\t{\n\t\t\t\tcase PARAM_DEFAULT_STR: this_formal_param.var->Assign(this_formal_param.default_str); break;\n\t\t\t\tcase PARAM_DEFAULT_INT: this_formal_param.var->Assign(this_formal_param.default_int64); break;\n\t\t\t\tcase PARAM_DEFAULT_FLOAT: this_formal_param.var->Assign(this_formal_param.default_double); break;\n\t\t\t\tcase PARAM_DEFAULT_UNSET: this_formal_param.var->MarkUninitialized(); break;\n\t\t\t\tcase PARAM_DEFAULT_EXPR:\n\t\t\t\t\tthis_formal_param.var->MarkUninitialized();\n\t\t\t\t\tif (default_expr > j)\n\t\t\t\t\t\tdefault_expr = j; // Take note of the first param with a default expr.\n\t\t\t\t\tbreak;\n\t\t\t\tdefault: //case PARAM_DEFAULT_NONE:\n\t\t\t\t\t// No value has been supplied for this REQUIRED parameter.\n\t\t\t\t\taResultToken.Error(ERR_PARAM_REQUIRED, this_formal_param.var->mName); // Abort thread.\n\t\t\t\t\tgoto free_and_return;\n\t\t\t\t}\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tExprTokenType &token = *aParam[j];\n\t\t\t\n\t\t\tif (this_formal_param.is_byref)\n\t\t\t{\n\t\t\t\tif (token.symbol == SYM_VAR && VARREF_IS_WRITE(token.var_usage)) // An optimized &var ref.\n\t\t\t\t{\n\t\t\t\t\tif (this_formal_param.var->Scope() & VAR_DOWNVAR) // This parameter's var is referenced by one or more closures.\n\t\t\t\t\t{\n\t\t\t\t\t\t// Make sure the caller's var (token.var) points to a ref-counted freevar.\n\t\t\t\t\t\tauto ref = token.var->GetRef();\n\t\t\t\t\t\tif (!ref)\n\t\t\t\t\t\t\tgoto free_and_return;\n\t\t\t\t\t\tref->Release(); // token.var retains a reference; release ours.\n\t\t\t\t\t\t// Point our freevar to the caller's freevar, for use by our closures.\n\t\t\t\t\t\tthis_formal_param.var->GetAliasFor()->UpdateAlias(token.var);\n\t\t\t\t\t\t// Also update our local alias below.\n\t\t\t\t\t}\n\t\t\t\t\tthis_formal_param.var->UpdateAlias(token.var); // Set mAliasFor (and mObject only if var->GetRef() has been called).\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\telse if (IObject *refobj = TokenToObject(token))\n\t\t\t\t{\n\t\t\t\t\tif (refobj->Base() == Object::sVarRefPrototype) // Use the more efficient VAR_ALIAS for VarRef.\n\t\t\t\t\t{\n\t\t\t\t\t\tauto ref = static_cast<VarRef*>(refobj);\n\t\t\t\t\t\tif (this_formal_param.var->Scope() & VAR_DOWNVAR) // This parameter's var is referenced by one or more closures.\n\t\t\t\t\t\t\tthis_formal_param.var->GetAliasFor()->UpdateAlias(ref);\n\t\t\t\t\t\tthis_formal_param.var->UpdateAlias(ref); // Set mAliasFor and mObject.\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\telse if (ObjectCanBeOutputVar(refobj)) // use VAR_VIRTUAL_OBJ for any object except those known to lack __value.\n\t\t\t\t\t{\n\t\t\t\t\t\tif (this_formal_param.var->Scope() & VAR_DOWNVAR)\n\t\t\t\t\t\t\tthis_formal_param.var->GetAliasFor()->UpdateVirtualObj(refobj);\n\t\t\t\t\t\tthis_formal_param.var->UpdateVirtualObj(refobj);\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\taResultToken.ParamError(j - (mClass ? 1 : 0), &token, _T(\"variable reference\"), mName);\n\t\t\t\tgoto free_and_return;\n\t\t\t}\n\t\t\t//else // This parameter is passed \"by value\".\n\t\t\t// Assign actual parameter's value to the formal parameter (which is itself a\n\t\t\t// local variable in the function). \n\t\t\t// token.var's Type() is always VAR_NORMAL (never a built-in virtual variable).\n\t\t\t// A SYM_VAR token can still happen because the previous loop's conversion of all\n\t\t\t// by-value SYM_VAR operands into the appropriate operand symbol would not have\n\t\t\t// happened if no backup was needed for this function (which is usually the case).\n\t\t\tif (!this_formal_param.var->Assign(token))\n\t\t\t{\n\t\t\t\taResultToken.SetExitResult(FAIL); // Abort thread.\n\t\t\t\tgoto free_and_return;\n\t\t\t}\n\t\t} // for each formal parameter.\n\t\t\n\t\tif (mIsVariadic && mParam[mParamCount].var) // i.e. this function is capable of accepting excess params via an object/array.\n\t\t{\n\t\t\t// Unused named parameters in param_obj are currently discarded, pending completion of the\n\t\t\t// object redesign. Ultimately the named parameters (either key-value pairs or properties)\n\t\t\t// would be enumerated and added to vararg_obj or passed to the function some other way.\n\t\t\tauto vararg_obj = Array::Create();\n\t\t\tif (!vararg_obj)\n\t\t\t{\n\t\t\t\taResultToken.MemoryError();\n\t\t\t\tgoto free_and_return;\n\t\t\t}\n\t\t\tif (j < aParamCount)\n\t\t\t\t// Insert the excess parameters from the actual parameter list.\n\t\t\t\tvararg_obj->InsertAt(0, aParam + j, aParamCount - j);\n\t\t\t// Assign to the \"param*\" var:\n\t\t\tmParam[mParamCount].var->AssignSkipAddRef(vararg_obj);\n\t\t}\n\n\t\tDEBUGGER_STACK_PUSH(&recurse)\n\n\t\tauto prev_func = g->CurrentFunc; // This will be non-NULL when a function is called from inside another function.\n\t\tg->CurrentFunc = this;\n\n\t\tResultType result = OK;\n\t\t// Execute any default initializers that weren't simple constants. This is not done in\n\t\t// the loop above for two reasons:\n\t\t// 1) It needs to be after DEBUGGER_STACK_PUSH (which isn't moved because it probably\n\t\t// doesn't make sense for the other errors to include this function in the stack trace).\n\t\t// 2) To preserve the pre-v2.0.8 behaviour, which allows an initializer to refer to later\n\t\t// parameters if they are simple values.\n\t\tfor (j = default_expr; j < mParamCount; ++j)\n\t\t{\n\t\t\tif (j < aParamCount && aParam[j]->symbol != SYM_MISSING || mParam[j].default_type != PARAM_DEFAULT_EXPR)\n\t\t\t\tcontinue;\n\t\t\tresult = mParam[j].default_expr->ExecUntil(ONLY_ONE_LINE);\n\t\t\tif (result != OK)\n\t\t\t{\n\t\t\t\taResultToken.SetExitResult(result);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t\tif (result == OK)\n\t\t\tresult = Execute(&aResultToken); // Execute the body of the function.\n\n\t\t// Restore the original value in case this function is called from inside another function.\n\t\t// Due to the synchronous nature of recursion and recursion-collapse, this should keep\n\t\t// g->CurrentFunc accurate, even amidst the asynchronous saving and restoring of \"g\" itself:\n\t\tg->CurrentFunc = prev_func;\n\n#ifdef CONFIG_DEBUGGER\n\t\tDEBUGGER_STACK_POP()\n\t\tif (g_Debugger.IsConnected())\n\t\t\tg_Debugger.LeaveFunction();\n#endif\n\t\t\n\t\t// Setting this unconditionally isn't likely to perform any worse than checking for EXIT/FAIL,\n\t\t// and likely produces smaller code. Execute() takes care of translating EARLY_RETURN to OK.\n\t\taResultToken.SetResult(result);\n\nfree_and_return:\n\t\t// Free the memory of all the just-completed function's local variables. This is done in\n\t\t// both of the following cases:\n\t\t// 1) There are other instances of this function beneath us on the call-stack: Must free\n\t\t// the memory to prevent a memory leak for any variable that existed prior to the call\n\t\t// we just did. Although any local variables newly created as a result of our call\n\t\t// technically don't need to be freed, they are freed for simplicity of code and also\n\t\t// because not doing so might result in side-effects for instances of this function that\n\t\t// lie beneath ours that would expect such nonexistent variables to have blank contents\n\t\t// when *they* create it.\n\t\t// 2) No other instances of this function exist on the call stack: The memory is freed and\n\t\t// the contents made blank for these reasons:\n\t\t// a) Prevents locals from all being static in duration, and users coming to rely on that,\n\t\t// since in the future local variables might be implemented using a non-persistent method\n\t\t// such as hashing (rather than maintaining a permanent list of Var*'s for each function).\n\t\t// b) To conserve memory between calls (in case the function's locals use a lot of memory).\n\t\t// c) To yield results consistent with when the same function is called while other instances\n\t\t// of itself exist on the call stack. In other words, it would be inconsistent to make\n\t\t// all variables blank for case #1 above but not do it here in case #2.\n\t\tVar::FreeAndRestoreFunctionVars(*this, recurse.backup, recurse.backup_count);\n\n\t\t// mInstances must remain non-zero until this point to ensure that any recursive calls by an\n\t\t// object's __Delete meta-function receive fresh variables, and none partially-destructed.\n\t\t--mInstances;\n\n\t\tif (sFreeVars)\n\t\t\tsFreeVars->Release();\n\t\tsFreeVars = caller_free_vars;\n\treturn !aResultToken.Exited(); // i.e. aResultToken.SetExitResult() or aResultToken.Error() was not called.\n}\n\nFreeVars *UserFunc::sFreeVars = nullptr;\n\n\n\nResultType Line::ExpandArgs(ResultToken *aResultTokens)\n// aResultTokens is non-null if the caller wants results that aren't strings. Caller is\n// responsible for freeing the tokens either after successful use or before aborting, on failure.\n// Returns OK, FAIL, or EARLY_EXIT. EARLY_EXIT occurs when a function-call inside an expression\n// used the EXIT command to terminate the thread.\n{\n\t// The counterpart of sArgDeref kept on our stack to protect it from recursion caused by\n\t// the calling of functions in the script:\n\tLPTSTR arg_deref[MAX_ARGS];\n\tint i;\n\n\t// Make two passes through this line's arg list. This is done because the performance of\n\t// realloc() is worse than doing a free() and malloc() because the former often does a memcpy()\n\t// in addition to the latter's steps. In addition, realloc() as much as doubles the memory\n\t// load on the system during the brief time that both the old and the new blocks of memory exist.\n\t// First pass: determine how much space will be needed to do all the args and allocate\n\t// more memory if needed. Second pass: dereference the args into the buffer.\n\n\t// First pass. It takes into account the same things as 2nd pass.\n\tsize_t space_needed = GetExpandedArgSize();\n\tif (space_needed == VARSIZE_ERROR)\n\t\treturn FAIL; // It will have already displayed the error.\n\n\t// Only allocate the buf at the last possible moment, when it's sure the buffer will be used\n\t// (improves performance when only a short script with no derefs is being run):\n\tif (space_needed > sDerefBufSize)\n\t{\n\t\t// KNOWN LIMITATION: The memory utilization of *recursive* user-defined functions is rather high because\n\t\t// of the size of DEREF_BUF_EXPAND_INCREMENT, which is used to create a new deref buffer for each layer\n\t\t// of recursion. Due to limited stack space, the limit of recursion is about 300 to 800 layers depending\n\t\t// on the build. For 800 layers on Unicode, about 25MB (32KB*800) of memory would be temporarily allocated,\n\t\t// which in a worst-case scenario would cause swapping and kill performance. However, on most systems it\n\t\t// wouldn't be an issue, and the bigger problem is that recursion may be limited to ~300 layers.\n\t\tsize_t increments_needed = space_needed / DEREF_BUF_EXPAND_INCREMENT;\n\t\tif (space_needed % DEREF_BUF_EXPAND_INCREMENT) // Need one more if above division truncated it.\n\t\t\t++increments_needed;\n\t\tsize_t new_buf_size = increments_needed * DEREF_BUF_EXPAND_INCREMENT;\n\t\tif (sDerefBuf)\n\t\t{\n\t\t\t// Do a free() and malloc(), which should be far more efficient than realloc(), especially if\n\t\t\t// there is a large amount of memory involved here (realloc's ability to do an in-place resize\n\t\t\t// might be unlikely for anything other than small blocks; see compiler's realloc.c):\n\t\t\tfree(sDerefBuf);\n\t\t\tif (sDerefBufSize > LARGE_DEREF_BUF_SIZE)\n\t\t\t\t--sLargeDerefBufs;\n\t\t}\n\t\tif ( !(sDerefBuf = tmalloc(new_buf_size)) )\n\t\t{\n\t\t\t// Error msg was formerly: \"Ran out of memory while attempting to dereference this line's parameters.\"\n\t\t\tsDerefBufSize = 0; // Reset so that it can make another attempt, possibly smaller, next time.\n\t\t\treturn MemoryError();\n\t\t}\n\t\tsDerefBufSize = new_buf_size;\n\t\tif (sDerefBufSize > LARGE_DEREF_BUF_SIZE)\n\t\t\t++sLargeDerefBufs;\n\t}\n\n\t// Always init our_buf_marker even if zero iterations, because we want to enforce\n\t// the fact that its prior contents become invalid once we're called.\n\t// It's also necessary due to the fact that all the old memory is discarded by\n\t// the above if more space was needed to accommodate this line.\n\tLPTSTR our_buf_marker = sDerefBuf; // Prior contents of buffer will be overwritten in any case.\n\n\t// From this point forward, must not refer to sDerefBuf as our buffer since it might have been\n\t// given a new memory area by an expression's function-call within this line. In other words,\n\t// our_buf_marker is our recursion layer's buffer, but not necessarily sDerefBuf. To enforce\n\t// that, and keep responsibility here rather than in ExpandExpression(), set sDerefBuf to NULL\n\t// so that the zero or more calls to ExpandExpression() made in the loop below (each of which will\n\t// in turn call zero or more user-defined functions) will allocate and use a single new deref\n\t// buffer if any of them need it (they all share a single deref buffer because each UDF-call\n\t// in a particular expression of the current line creates a buf only if necessary, and it won't\n\t// be necessary if some prior UDF of this same expression or line already created a deref buffer\n\t// \"above\" ours because our layer here is the only one who ever frees that upper/extra buffer).\n\t// Note that it is not possible for a new quasi-thread to directly interrupt ExpandArgs() because\n\t// ExpandArgs() never calls MsgSleep(). Therefore, each ExpandArgs() layer on the call-stack\n\t// is safe from interrupting threads overwriting its deref buffer. It's true that a call to a\n\t// script function will usually result in MsgSleep(), and thus allow interruptions, but those\n\t// interruptions would hit some other deref buffer, not that of our layer.\n\tPRIVATIZE_S_DEREF_BUF;\n\n\tResultType result, result_to_return = OK; // Set default return value.\n\n\t{\n\t\tsize_t extra_size = our_deref_buf_size - space_needed;\n\t\tfor (i = 0; i < mArgc; ++i) // For each arg:\n\t\t{\n\t\t\tArgStruct &this_arg = mArg[i]; // For performance and convenience.\n\n\t\t\t// Load-time routines have already ensured that an arg can be an expression only if\n\t\t\t// it's not an input or output var.\n\t\t\tif (this_arg.is_expression)\n\t\t\t{\n\t\t\t\t// In addition to producing its return value, ExpandExpression() will alter our_buf_marker\n\t\t\t\t// to point to the place in our_deref_buf where the next arg should be written.\n\t\t\t\t// In addition, in some cases it will alter some of the other parameters that are arrays or\n\t\t\t\t// that are passed by-ref. Finally, it might temporarily use parts of the buffer beyond\n\t\t\t\t// extra_size plus what the size estimator provided for it, so we should be sure here that\n\t\t\t\t// everything in our_deref_buf to the right of our_buf_marker is available to it as temporary memory.\n\t\t\t\t// Note: It doesn't seem worthwhile to enhance ExpandExpression to give us back a variable\n\t\t\t\t// for use in arg_var[] (for performance) because only rarely does an expression yield\n\t\t\t\t// a variable other than some function's local variable (and a local's contents are no\n\t\t\t\t// longer valid due to having been freed after the call [unless it's static]).\n\t\t\t\targ_deref[i] = ExpandExpression(i, result, aResultTokens ? &aResultTokens[i] : NULL\n\t\t\t\t\t, our_buf_marker, our_deref_buf, our_deref_buf_size, arg_deref, extra_size);\n\t\t\t\textra_size = 0; // See comment below.\n\t\t\t\t// v1.0.46.01: The whole point of passing extra_size is to allow an expression to write\n\t\t\t\t// a large string to the deref buffer without having to expand it (i.e. if there happens to\n\t\t\t\t// be extra room in it that won't be used by ANY arg, including ones after THIS expression).\n\t\t\t\t// Since the expression just called above might have used some/all of the extra size,\n\t\t\t\t// the line above prevents subsequent expressions in this line from getting any extra size.\n\t\t\t\t// It's pretty rare to have more than one expression in a line anyway, and even when there\n\t\t\t\t// is there's hardly ever a need for the extra_size. As an alternative to setting it to\n\t\t\t\t// zero, above could check how much the expression wrote to the buffer (by comparing our_buf_marker\n\t\t\t\t// before and after the call above), and compare that to how much space was reserved for this\n\t\t\t\t// particular arg/expression (which is currently a standard formula for expressions).\n\t\t\t\tif (!arg_deref[i])\n\t\t\t\t{\n\t\t\t\t\t// A script-function-call inside the expression returned EARLY_EXIT or FAIL. Report \"result\"\n\t\t\t\t\t// to our caller (otherwise, the contents of \"result\" should be ignored since they're undefined).\n\t\t\t\t\tresult_to_return = result;\n\t\t\t\t\tgoto end;\n\t\t\t\t}\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tif (this_arg.type == ARG_TYPE_OUTPUT_VAR) // Don't bother wasting the mem to deref output var.\n\t\t\t{\n\t\t\t\t// In case its \"dereferenced\" contents are ever directly examined, set it to be\n\t\t\t\t// the empty string. This also allows the ARG to be passed a dummy param, which\n\t\t\t\t// makes things more convenient and maintainable in other places:\n\t\t\t\targ_deref[i] = _T(\"\");\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tif (this_arg.type != ARG_TYPE_INPUT_VAR)\n\t\t\t{\n\t\t\t\tif (aResultTokens && this_arg.postfix)\n\t\t\t\t{\n\t\t\t\t\t// Since above did not \"continue\", this arg must have been an expression which was\n\t\t\t\t\t// converted back to a plain value. *postfix is a single numeric or string literal.\n\t\t\t\t\taResultTokens[i].CopyValueFrom(*this_arg.postfix);\n\t\t\t\t}\n\t\t\t\t// Since above did not \"continue\" and arg_var[i] is NULL, this arg can't be an expression\n\t\t\t\t// or input/output var and must therefore be plain text.\n\t\t\t\targ_deref[i] = this_arg.text; // Point the dereferenced arg to the arg text itself.\n\t\t\t\tcontinue; // Don't need to use the deref buffer in this case.\n\t\t\t}\n\t\t\t// Since above didn't continue, this arg is a plain variable reference.\n\t\t\t// aResultTokens should currently always be NULL for ARG_TYPE_INPUT_VAR, so isn't filled.\n\n\t\t\tif (VAR(mArg[i])->IsUninitializedNormalVar())\n\t\t\t{\n\t\t\t\tresult_to_return = g_script.VarUnsetError(VAR(mArg[i]));\n\t\t\t\tgoto end;\n\t\t\t}\n\n\t\t\t// Some comments below might be obsolete. There was previously some logic here deciding\n\t\t\t// whether the variable needed to be dereferenced, but that's no longer ever necessary.\n\t\t\t// Previous stages have ensured the_only_var_of_this_arg is of type VAR_NORMAL.\n\t\t\t\t// This arg contains only a single dereference variable, and no\n\t\t\t\t// other text at all. So rather than copy the contents into the\n\t\t\t\t// temp buffer, it's much better for performance (especially for\n\t\t\t\t// potentially huge variables like %clipboard%) to simply set\n\t\t\t\t// the pointer to be the variable itself. However, this can only\n\t\t\t\t// be done if the var is the clipboard or a normal var.\n\t\t\t\t// Update: Changed it so that it will deref the clipboard if it contains only\n\t\t\t\t// files and no text, so that the files will be transcribed into the deref buffer.\n\t\t\t\t// This is because the clipboard object needs a memory area into which to write\n\t\t\t\t// the filespecs it translated:\n\t\t\t\t// Update #2: When possible, avoid calling Contents() because that flushes the\n\t\t\t\t// cached binary number, which some commands don't need to happen. Only the args that\n\t\t\t\t// are specifically written to be optimized should skip it. Otherwise there would be\n\t\t\t\t// problems in things like: date += 31, %Var% (where Var contains \"Days\")\n\t\t\t\t// Update #3: If an expression in an arg after this one causes the var's contents\n\t\t\t\t// to be reallocated, it would invalidate any pointer we could get from Contents()\n\t\t\t\t// in this iteration. So instead of calling Contents() here, store a NULL value\n\t\t\t\t// as a special indicator for the loop below to call Contents().\n\t\t\targ_deref[i] = // The following is ordered for short-circuit performance:\n\t\t\t\t( mActionType == ACT_ASSIGNEXPR && i == 1 // By contrast, for the below i==anything (all args):\n\t\t\t\t|| mActionType == ACT_IF\n\t\t\t\t//|| mActionType == ACT_WHILE // Not necessary to check this one because loadtime leaves ACT_WHILE as an expression in all common cases.\n\t\t\t\t) ? _T(\"\") : NULL; // See \"Update #2\" and later comments above.\n\t\t\t\n\t\t} // for each arg.\n\n\t\t// See \"Update #3\" comment above. This must be done separately to the loop below since Contents()\n\t\t// may cause a warning dialog, which in turn may cause a new thread to launch, thus potentially\n\t\t// corrupting sArgDeref.\n\t\tfor (i = 0; i < mArgc; ++i)\n\t\t\tif (arg_deref[i] == NULL)\n\t\t\t\targ_deref[i] = VAR(mArg[i])->Contents();\n\n\t\t// IT'S NOT SAFE to do the following until the above loops FULLY complete because any calls made above to\n\t\t// ExpandExpression() might call functions, which in turn might result in a recursive call to ExpandArgs(),\n\t\t// which in turn might change the values in the static array sArgDeref.\n\t\t// Also, only when the loop ends normally is the following needed, since otherwise it's a failure condition.\n\t\t// Now that any recursive calls to ExpandArgs() above us on the stack have collapsed back to us, it's\n\t\t// safe to set the args of this command for use by our caller, to whom we're about to return.\n\t\tfor (i = 0; i < mArgc; ++i) // Copying actual/used elements is probably faster than using memcpy to copy both entire arrays.\n\t\t\tsArgDeref[i] = arg_deref[i];\n\t} // redundant block\n\n\t// v1.0.40.02: The following loop was added to avoid the need for the ARGn macros to provide an empty\n\t// string when mArgc was too small (indicating that the parameter is absent). This saves quite a bit\n\t// of code size. Also, the slight performance loss caused by it is partially made up for by the fact\n\t// that all the other sections don't need to check mArgc anymore.\n\t// Benchmarks show that it doesn't help performance to try to tweak this with a pre-check such as\n\t// \"if (mArgc < max_params)\":\n\tint max_params = g_act[mActionType].MaxParams; // Resolve once for performance.\n\tfor (i = mArgc; i < max_params; ++i) // START AT mArgc. For performance, this only does the actual max args for THIS command, not MAX_ARGS.\n\t\tsArgDeref[i] = _T(\"\");\n\n\t// When the main/large loop above ends normally, it falls into the label below and uses the original/default\n\t// value of \"result_to_return\".\n\nend:\n\t// As of v1.0.31, there can be multiple deref buffers simultaneously if one or more called functions\n\t// requires a deref buffer of its own (separate from ours). In addition, if a called function is\n\t// interrupted by a new thread before it finishes, the interrupting thread will also use the\n\t// new/separate deref buffer. To minimize the amount of memory used in such cases,\n\t// each line containing one or more expression with one or more function call (rather than each\n\t// function call) will get up to one deref buffer of its own (i.e. only if its function body contains\n\t// commands that actually require a second deref buffer). This is achieved by saving sDerefBuf's\n\t// pointer and setting sDerefBuf to NULL, which effectively makes the original deref buffer private\n\t// until the line that contains the function-calling expressions finishes completely.\n\t// Description of recursion and usage of multiple deref buffers:\n\t// 1) ExpandArgs() receives a line with one or more expressions containing one or more calls to user functions.\n\t// 2) Worst-case: those function-calls create a new sDerefBuf automatically via us having set sDerefBuf to NULL.\n\t// 3) Even worse, the bodies of those functions call other functions, which ExpandArgs() receives, resulting in\n\t// a recursive leap back to step #1.\n\t// So the above shows how any number of new deref buffers can be created. But that's okay as long as the\n\t// recursion collapses in an orderly manner (or the program exits, in which case the OS frees all its memory\n\t// automatically). This is because prior to returning, each recursion layer properly frees any extra deref\n\t// buffer it was responsible for creating. It only has to free at most one such buffer because each layer of\n\t// ExpandArgs() on the call-stack can never be blamed for creating more than one extra buffer.\n\t// Must always restore the original buffer (if there was one), not keep the new one, because our\n\t// caller needs the arg_deref addresses, which point into the original buffer.\n\tDEPRIVATIZE_S_DEREF_BUF;\n\n\t// For v1.0.31, this is no done right before returning so that any script function calls\n\t// made by our calls to ExpandExpression() will now be done. There might still be layers\n\t// of ExpandArgs() beneath us on the call-stack, which is okay since they will keep the\n\t// largest of the two available deref bufs (as described above) and thus they should\n\t// reset the timer below right before they collapse/return. \n\t// (Re)set the timer unconditionally so that it starts counting again from time zero.\n\t// In other words, we only want the timer to fire when the large deref buffer has been\n\t// unused/idle for a straight 10 seconds. There is no danger of this timer freeing\n\t// the deref buffer at a critical moment because:\n\t// 1) The timer is reset with each call to ExpandArgs (this function);\n\t// 2) If our ExpandArgs() recursion layer takes a long time to finish, messages\n\t// won't be checked and thus the timer can't fire because it relies on the msg loop.\n\t// 3) If our ExpandArgs() recursion layer launches function-calls in ExpandExpression(),\n\t// those calls will call ExpandArgs() recursively and reset the timer if its\n\t// buffer (not necessarily the original buffer somewhere on the call-stack) is large\n\t// enough. In light of this, there is a chance that the timer might execute and free\n\t// a deref buffer other than the one it was originally intended for. But in real world\n\t// scenarios, that seems rare. In addition, the consequences seem to be limited to\n\t// some slight memory inefficiency.\n\t// It could be argued that the timer should only be activated when a hypothetical static\n\t// var sLayers that we maintain here indicates that we're the only layer. However, if that\n\t// were done and the launch of a script function creates (directly or through thread\n\t// interruption, indirectly) a large deref buffer, and that thread is waiting for something\n\t// such as WinWait, that large deref buffer would never get freed.\n\tif (sDerefBufSize > LARGE_DEREF_BUF_SIZE)\n\t{\n\t\t// SetTimer has a cost that adds up very quickly if ExpandArgs() is called in a tight loop\n\t\t// (potentially thousands or millions of times per second). There's no need for the timer\n\t\t// to be precise, so don't reset it more often than twice every second. (Even checking\n\t\t// now != sLastTimerReset is sufficient.)\n\t\tstatic DWORD sLastTimerReset = 0;\n\t\tDWORD now = GetTickCount();\n\t\tif (now - sLastTimerReset > 500 || !g_DerefTimerExists)\n\t\t{\n\t\t\tsLastTimerReset = now;\n\t\t\tSET_DEREF_TIMER(10000) // Reset the timer right before the deref buf is possibly about to become idle.\n\t\t}\n\t}\n\n\treturn result_to_return;\n}\n\n\t\n\nVarSizeType Line::GetExpandedArgSize()\n// Returns the size, or VARSIZE_ERROR if there was a problem.\n// This function can return a size larger than what winds up actually being needed\n// (e.g. caused by ScriptGetCursor()), so our callers should be aware that that can happen.\n{\n\tint i;\n\tVarSizeType space_needed;\n\t\n\t// Note: the below loop is similar to the one in ExpandArgs(), so the two should be maintained together:\n\tfor (i = 0, space_needed = 0; i < mArgc; ++i) // FOR EACH ARG:\n\t{\n\t\tArgStruct &this_arg = mArg[i]; // For performance and convenience.\n\t\t\n\t\tif (this_arg.is_expression)\n\t\t{\n\t\t\t// The length used below is more room than is strictly necessary, but given how little\n\t\t\t// space is typically wasted (and that only while the expression is being evaluated),\n\t\t\t// it doesn't seem worth worrying about it. See other comments at macro definition.\n\t\t\tspace_needed += EXPR_BUF_SIZE(this_arg.length);\n\t\t}\n\t\t// Since is_expression is false, it must be plain text or a non-dynamic input/output var.\n\t}\n\n\treturn space_needed;\n}\n\n\n"},"size":{"kind":"number","value":130215,"string":"130,215"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":2256,"string":"2,256"},"avg_line_length":{"kind":"number","value":53.29166666666666,"string":"53.291667"},"max_line_length":{"kind":"number","value":286,"string":"286"},"alphanum_fraction":{"kind":"number","value":0.7104997298122783,"string":"0.7105"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11096,"cells":{"id":{"kind":"number","value":16086,"string":"16,086"},"file_name":{"kind":"string","value":"ahkversion.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/ahkversion.cpp"},"content":{"kind":"string","value":"\n#include \"stdafx.h\"\n#include \"ahkversion.h\"\n\nLPSTR AHK_VERSION = RAW_AHK_VERSION;\nLPTSTR T_AHK_VERSION = _T(RAW_AHK_VERSION);\nLPTSTR T_AHK_NAME_VERSION = T_AHK_NAME _T(\" v\") _T(RAW_AHK_VERSION);\n"},"size":{"kind":"number","value":196,"string":"196"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":5,"string":"5"},"avg_line_length":{"kind":"number","value":37.8,"string":"37.8"},"max_line_length":{"kind":"number","value":68,"string":"68"},"alphanum_fraction":{"kind":"number","value":0.7195767195767195,"string":"0.719577"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":true,"string":"true"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11097,"cells":{"id":{"kind":"number","value":16092,"string":"16,092"},"file_name":{"kind":"string","value":"InputBox.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/lib/InputBox.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\"\n#include \"script.h\"\n#include \"window.h\"\n#include \"application.h\"\n#include \"resources/resource.h\"\n#include \"script_func_impl.h\"\n\n\n\nResultType InputBoxParseOptions(LPCTSTR aOptions, InputBoxType &aInputBox)\n{\n\tLPCTSTR next_option, option_end;\n\tfor (next_option = aOptions; ; next_option = omit_leading_whitespace(option_end))\n\t{\n\t\tif (!*next_option)\n\t\t\treturn OK; // All options parsed OK.\n\n\t\t// Find the end of this option item:\n\t\tfor (option_end = next_option; *option_end && !IS_SPACE_OR_TAB(*option_end); ++option_end);\n\n\t\t// The legacy InputBox command used \"Hide\", but \"Password\" seems clearer\n\t\t// and better for consistency with the equivalent Edit control option:\n\t\tif (!_tcsnicmp(next_option, _T(\"Password\"), 8))\n\t\t{\n\t\t\tif (next_option[8] && !IS_SPACE_OR_TAB(next_option[8]))\n\t\t\t{\n\t\t\t\tif (next_option[8] && (next_option[9] && !IS_SPACE_OR_TAB(next_option[9])))\n\t\t\t\t\tbreak; // More than one character - invalid.\n\t\t\t\taInputBox.password_char = next_option[8];\n\t\t\t}\n\t\t\telse\n\t\t\t\taInputBox.password_char = UorA(L'\\x25CF', '*');\n\t\t\tcontinue;\n\t\t}\n\n\t\t// All of the remaining options are a single letter followed by a number.\n\t\tTCHAR option_char = ctoupper(*next_option);\n\t\tLPTSTR n_end;\n\t\tauto value = _tcstod(next_option + 1, &n_end); // Supports hex with VC++ 2015 and later.\n\t\tif (*n_end && !IS_SPACE_OR_TAB(*n_end) // Invalid option or non-numeric suffix.\n\t\t\t|| value < 0 && !(option_char == 'X' || option_char == 'Y'))\n\t\t\tbreak; \n\t\t\n\t\tswitch (ctoupper(*next_option))\n\t\t{\n\t\tcase 'W': aInputBox.width = DPIScale((int)value); continue;\n\t\tcase 'H': aInputBox.height = DPIScale((int)value); continue;\n\t\tcase 'X': aInputBox.xpos = (int)value; continue;\n\t\tcase 'Y': aInputBox.ypos = (int)value; continue;\n\t\tcase 'T': aInputBox.timeout = (DWORD)(value * 1000); continue;\n\t\t}\n\t\tbreak;\n\t}\n\treturn ValueError(ERR_INVALID_OPTION, next_option, FAIL_OR_OK);\n}\n\n\n\nbif_impl FResult InputBox(optl<StrArg> aPrompt, optl<StrArg> aTitle, optl<StrArg> aOptions, optl<StrArg> aDefault, IObject *&aRetVal)\n{\n\tInputBoxType inputbox;\n\tinputbox.title = aTitle.has_value() ? aTitle.value() : g_script.DefaultDialogTitle();\n\tinputbox.text = aPrompt.value_or_empty();\n\tinputbox.default_string = aDefault.value_or_null();\n\tinputbox.return_string = nullptr;\n\t// Set defaults:\n\tinputbox.width = INPUTBOX_DEFAULT;\n\tinputbox.height = INPUTBOX_DEFAULT;\n\tinputbox.xpos = INPUTBOX_DEFAULT;\n\tinputbox.ypos = INPUTBOX_DEFAULT;\n\tinputbox.password_char = '\\0';\n\tinputbox.timeout = 0;\n\t// Parse options and override defaults:\n\tif (aOptions.has_value() && !InputBoxParseOptions(aOptions.value(), inputbox))\n\t\treturn FR_FAIL; // It already displayed the error.\n\n\t// At this point, we know a dialog will be displayed. See macro's comments for details:\n\tDIALOG_PREP\n\n\t// Specify NULL as the owner window since we want to be able to have the main window in the foreground even\n\t// if there are InputBox windows. Update: A GUI window can now be the parent if thread has that setting.\n\tINT_PTR result = DialogBoxParam(g_hInstance, MAKEINTRESOURCE(IDD_INPUTBOX), THREAD_DIALOG_OWNER\n\t\t, InputBoxProc, (LPARAM)&inputbox);\n\n\tDIALOG_END\n\n\tLPTSTR value = inputbox.return_string;\n\tLPTSTR reason;\n\t\n\tswitch (result)\n\t{\n\tcase AHK_TIMEOUT:\treason = _T(\"Timeout\");\tbreak;\n\tcase IDOK:\t\t\treason = _T(\"OK\");\t\tbreak;\n\tcase IDCANCEL:\t\treason = _T(\"Cancel\");\tbreak;\n\tdefault:\t\t\treason = nullptr;\t\tbreak;\n\t}\n\n\tFResult fresult;\n\tif (reason && value)\n\t{\n\t\tExprTokenType argt[] = { _T(\"Result\"), reason, _T(\"Value\"), value };\n\t\tExprTokenType *args[_countof(argt)] = { argt, argt+1, argt+2, argt+3 };\n\t\taRetVal = Object::Create(args, _countof(args));\n\t\tfresult = aRetVal ? OK : FR_E_OUTOFMEM;\n\t}\n\telse\n\t\tfresult = result == -1 ? FR_E_WIN32 : FR_E_FAILED;\n\tfree(value);\n\treturn fresult;\n}\n\n\n\nINT_PTR CALLBACK InputBoxProc(HWND hWndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam)\n// MSDN:\n// Typically, the dialog box procedure should return TRUE if it processed the message,\n// and FALSE if it did not. If the dialog box procedure returns FALSE, the dialog\n// manager performs the default dialog operation in response to the message.\n{\n\t// See GuiWindowProc() for details about this first part:\n\tLRESULT msg_reply;\n\tif (g_CalledByIsDialogMessageOrDispatch && g_CalledByIsDialogMessageOrDispatch->message == uMsg)\n\t\tg_CalledByIsDialogMessageOrDispatch = nullptr;\n\telse if (g_MsgMonitor.Count() && MsgMonitor(hWndDlg, uMsg, wParam, lParam, NULL, msg_reply))\n\t\treturn (BOOL)msg_reply; // MsgMonitor has returned \"true\", indicating that this message should be omitted from further processing.\n\n\tswitch(uMsg)\n\t{\n\tcase WM_INITDIALOG:\n\t{\n\t\tSetWindowLongPtr(hWndDlg, DWLP_USER, lParam); // Store it for later use.\n\t\tauto &CURR_INPUTBOX = *(InputBoxType *)lParam;\n\t\tCURR_INPUTBOX.hwnd = hWndDlg;\n\n\t\tif (CURR_INPUTBOX.password_char)\n\t\t\tSendDlgItemMessage(hWndDlg, IDC_INPUTEDIT, EM_SETPASSWORDCHAR, CURR_INPUTBOX.password_char, 0);\n\n\t\tSetWindowText(hWndDlg, CURR_INPUTBOX.title);\n\t\tSetDlgItemText(hWndDlg, IDC_INPUTPROMPT, CURR_INPUTBOX.text);\n\n\t\t// Use the system's current language for the button names:\n\t\ttypedef LPCWSTR(WINAPI*pfnUser)(int);\n\t\tHMODULE hMod = GetModuleHandle(_T(\"user32.dll\"));\n\t\tpfnUser mbString = (pfnUser)GetProcAddress(hMod, \"MB_GetString\");\n\t\tif (mbString)\n\t\t{\n\t\t\tSetDlgItemTextW(hWndDlg, IDOK, mbString(0));\n\t\t\tSetDlgItemTextW(hWndDlg, IDCANCEL, mbString(1));\n\t\t}\n\n\t\t// Don't do this check; instead allow the MoveWindow() to occur unconditionally so that\n\t\t// the new button positions and such will override those set in the dialog's resource\n\t\t// properties:\n\t\t//if (CURR_INPUTBOX.width != INPUTBOX_DEFAULT || CURR_INPUTBOX.height != INPUTBOX_DEFAULT\n\t\t//\t|| CURR_INPUTBOX.xpos != INPUTBOX_DEFAULT || CURR_INPUTBOX.ypos != INPUTBOX_DEFAULT)\n\t\tRECT rect;\n\t\tGetClientRect(hWndDlg, &rect);\n\t\tif (CURR_INPUTBOX.width != INPUTBOX_DEFAULT) rect.right = CURR_INPUTBOX.width;\n\t\tif (CURR_INPUTBOX.height != INPUTBOX_DEFAULT) rect.bottom = CURR_INPUTBOX.height;\n\t\tAdjustWindowRect(&rect, GetWindowLong(hWndDlg, GWL_STYLE), FALSE);\n\t\tint new_width = rect.right - rect.left;\n\t\tint new_height = rect.bottom - rect.top;\n\n\t\t// If a non-default size was specified, the box will need to be recentered; thus, we can't rely on\n\t\t// the dialog's DS_CENTER style in its template. The exception is when an explicit xpos or ypos is\n\t\t// specified, in which case centering is disabled for that dimension.\n\t\tint new_xpos, new_ypos;\n\t\tif (CURR_INPUTBOX.xpos != INPUTBOX_DEFAULT && CURR_INPUTBOX.ypos != INPUTBOX_DEFAULT)\n\t\t{\n\t\t\tnew_xpos = CURR_INPUTBOX.xpos;\n\t\t\tnew_ypos = CURR_INPUTBOX.ypos;\n\t\t}\n\t\telse\n\t\t{\n\t\t\tPOINT pt = CenterWindow(new_width, new_height);\n \t\t\tif (CURR_INPUTBOX.xpos == INPUTBOX_DEFAULT) // Center horizontally.\n\t\t\t\tnew_xpos = pt.x;\n\t\t\telse\n\t\t\t\tnew_xpos = CURR_INPUTBOX.xpos;\n \t\t\tif (CURR_INPUTBOX.ypos == INPUTBOX_DEFAULT) // Center vertically.\n\t\t\t\tnew_ypos = pt.y;\n\t\t\telse\n\t\t\t\tnew_ypos = CURR_INPUTBOX.ypos;\n\t\t}\n\n\t\tMoveWindow(hWndDlg, new_xpos, new_ypos, new_width, new_height, TRUE); // Do repaint.\n\t\t// This may also needed to make it redraw in some OSes or some conditions:\n\t\tGetClientRect(hWndDlg, &rect); // Not to be confused with GetWindowRect().\n\t\tSendMessage(hWndDlg, WM_SIZE, SIZE_RESTORED, rect.right + (rect.bottom<<16));\n\t\t\n\t\tif (CURR_INPUTBOX.default_string)\n\t\t\tSetDlgItemText(hWndDlg, IDC_INPUTEDIT, CURR_INPUTBOX.default_string);\n\n\t\tif (hWndDlg != GetForegroundWindow()) // Normally it will be foreground since the template has this property.\n\t\t\tSetForegroundWindowEx(hWndDlg); // Try to force it to the foreground.\n\n\t\t// Setting the small icon puts it in the upper left corner of the dialog window.\n\t\t// Setting the big icon makes the dialog show up correctly in the Alt-Tab menu.\n\t\t\n\t\t// L17: Use separate big/small icons for best results.\n\t\tLPARAM big_icon, small_icon;\n\t\tif (g_script.mCustomIcon)\n\t\t{\n\t\t\tbig_icon = (LPARAM)g_script.mCustomIcon;\n\t\t\tsmall_icon = (LPARAM)g_script.mCustomIconSmall; // Should always be non-NULL when mCustomIcon is non-NULL.\n\t\t}\n\t\telse\n\t\t{\n\t\t\tbig_icon = (LPARAM)g_IconLarge;\n\t\t\tsmall_icon = (LPARAM)g_IconSmall;\n\t\t}\n\n\t\tSendMessage(hWndDlg, WM_SETICON, ICON_SMALL, small_icon);\n\t\tSendMessage(hWndDlg, WM_SETICON, ICON_BIG, big_icon);\n\n\t\t// Regarding the timer ID: https://devblogs.microsoft.com/oldnewthing/20150924-00/?p=91521\n\t\t// Basically, timer IDs need only be non-zero and unique to the given HWND.\n\t\tif (CURR_INPUTBOX.timeout)\n\t\t\tSetTimer(hWndDlg, (UINT_PTR)&CURR_INPUTBOX, CURR_INPUTBOX.timeout, InputBoxTimeout);\n\n\t\treturn TRUE; // i.e. let the system set the keyboard focus to the first visible control.\n\t}\n\n\tcase WM_SIZE:\n\t{\n\t\t// Adapted from D.Nuttall's InputBox in the AutoIt3 source.\n\n\t\t// don't try moving controls if minimized\n\t\tif (wParam == SIZE_MINIMIZED)\n\t\t\treturn TRUE;\n\n\t\tint dlg_new_width = LOWORD(lParam);\n\t\tint dlg_new_height = HIWORD(lParam);\n\n\t\tint last_ypos = 0, curr_width, curr_height;\n\n\t\t// Changing these might cause weird effects when user resizes the window since the default size and\n\t\t// margins is about 5 (as stored in the dialog's resource properties). UPDATE: That's no longer\n\t\t// an issue since the dialog is resized when the dialog is first displayed to make sure everything\n\t\t// behaves consistently:\n\t\tconst int XMargin = 5, YMargin = 5;\n\n\t\tRECT rTmp;\n\n\t\t// start at the bottom - OK button\n\n\t\tHWND hbtOk = GetDlgItem(hWndDlg, IDOK);\n\t\tif (hbtOk != NULL)\n\t\t{\n\t\t\t// how big is the control?\n\t\t\tGetWindowRect(hbtOk, &rTmp);\n\t\t\tif (rTmp.left > rTmp.right)\n\t\t\t\tswap(rTmp.left, rTmp.right);\n\t\t\tif (rTmp.top > rTmp.bottom)\n\t\t\t\tswap(rTmp.top, rTmp.bottom);\n\t\t\tcurr_width = rTmp.right - rTmp.left;\n\t\t\tcurr_height = rTmp.bottom - rTmp.top;\n\t\t\tlast_ypos = dlg_new_height - YMargin - curr_height;\n\t\t\t// where to put the control?\n\t\t\tMoveWindow(hbtOk, dlg_new_width/4+(XMargin-curr_width)/2, last_ypos, curr_width, curr_height, FALSE);\n\t\t}\n\n\t\t// Cancel Button\n\t\tHWND hbtCancel = GetDlgItem(hWndDlg, IDCANCEL);\n\t\tif (hbtCancel != NULL)\n\t\t{\n\t\t\t// how big is the control?\n\t\t\tGetWindowRect(hbtCancel, &rTmp);\n\t\t\tif (rTmp.left > rTmp.right)\n\t\t\t\tswap(rTmp.left, rTmp.right);\n\t\t\tif (rTmp.top > rTmp.bottom)\n\t\t\t\tswap(rTmp.top, rTmp.bottom);\n\t\t\tcurr_width = rTmp.right - rTmp.left;\n\t\t\tcurr_height = rTmp.bottom - rTmp.top;\n\t\t\t// where to put the control?\n\t\t\tMoveWindow(hbtCancel, dlg_new_width*3/4-(XMargin+curr_width)/2, last_ypos, curr_width, curr_height, FALSE);\n\t\t}\n\n\t\t// Edit Box\n\t\tHWND hedText = GetDlgItem(hWndDlg, IDC_INPUTEDIT);\n\t\tif (hedText != NULL)\n\t\t{\n\t\t\t// how big is the control?\n\t\t\tGetWindowRect(hedText, &rTmp);\n\t\t\tif (rTmp.left > rTmp.right)\n\t\t\t\tswap(rTmp.left, rTmp.right);\n\t\t\tif (rTmp.top > rTmp.bottom)\n\t\t\t\tswap(rTmp.top, rTmp.bottom);\n\t\t\tcurr_width = rTmp.right - rTmp.left;\n\t\t\tcurr_height = rTmp.bottom - rTmp.top;\n\t\t\tlast_ypos -= 5 + curr_height; // Allows space between the buttons and the edit box.\n\t\t\t// where to put the control?\n\t\t\tMoveWindow(hedText, XMargin, last_ypos, dlg_new_width - XMargin*2\n\t\t\t\t, curr_height, FALSE);\n\t\t}\n\n\t\t// Static Box (Prompt)\n\t\tHWND hstPrompt = GetDlgItem(hWndDlg, IDC_INPUTPROMPT);\n\t\tif (hstPrompt != NULL)\n\t\t{\n\t\t\tlast_ypos -= 10; // Allows space between the edit box and the prompt (static text area).\n\t\t\t// where to put the control?\n\t\t\tMoveWindow(hstPrompt, XMargin, YMargin, dlg_new_width - XMargin*2\n\t\t\t\t, last_ypos, FALSE);\n\t\t}\n\t\tInvalidateRect(hWndDlg, NULL, TRUE);\t// force window to be redrawn\n\t\treturn TRUE; // i.e. completely handled here.\n\t}\n\n\tcase WM_GETMINMAXINFO:\n\t{\n\t\t// Increase the minimum width to prevent the buttons from overlapping:\n\t\tRECT rTmp;\n\t\tint min_width = 0;\n\t\tLPMINMAXINFO lpMMI = (LPMINMAXINFO)lParam;\n\t\tGetWindowRect(GetDlgItem(hWndDlg, IDOK), &rTmp);\n\t\tmin_width += rTmp.right - rTmp.left;\n\t\tGetWindowRect(GetDlgItem(hWndDlg, IDCANCEL), &rTmp);\n\t\tmin_width += rTmp.right - rTmp.left;\n\t\tlpMMI->ptMinTrackSize.x = min_width + 30;\n\t}\n\n\tcase WM_COMMAND:\n\t\tswitch (LOWORD(wParam))\n\t\t{\n\t\tcase IDOK:\n\t\tcase IDCANCEL:\n\t\t{\n\t\t\tauto &CURR_INPUTBOX = *(InputBoxType *)GetWindowLongPtr(hWndDlg, DWLP_USER);\n\t\t\t// The entered text is used even if the user pressed the cancel button. This allows the\n\t\t\t// cancel button to specify that a different operation should be performed on the text.\n\t\t\tWORD return_value = (WORD)FAIL;\n\t\t\tHWND hControl = GetDlgItem(hWndDlg, IDC_INPUTEDIT);\n\t\t\tif (hControl && CURR_INPUTBOX.UpdateResult(hControl))\n\t\t\t\treturn_value = LOWORD(wParam); // IDOK or IDCANCEL\n\t\t\t// Since the user pressed a button to dismiss the dialog:\n\t\t\t// Timers belonging to a window are destroyed automatically when the window is destroyed,\n\t\t\t// but it seems prudent to clean up; also, EndDialog may fail, perhaps as a result of the\n\t\t\t// script interfering via OnMessage.\n\t\t\tif (CURR_INPUTBOX.timeout) // It has a timer.\n\t\t\t\tKillTimer(hWndDlg, (UINT_PTR)&CURR_INPUTBOX);\n\t\t\tEndDialog(hWndDlg, return_value);\n\t\t\treturn TRUE;\n\t\t} // case\n\t\t} // Inner switch()\n\t} // Outer switch()\n\t// Otherwise, let the dialog handler do its default action:\n\treturn FALSE;\n}\n\n\n\nVOID CALLBACK InputBoxTimeout(HWND hWnd, UINT uMsg, UINT_PTR idEvent, DWORD dwTime)\n{\n\t// First check if the window has already been destroyed. There are quite a few ways this can\n\t// happen, and in all of them we want to make sure not to do things such as calling EndDialog()\n\t// again or updating the output variable. Reasons:\n\t// 1) The user has already pressed the OK or Cancel button (the timer isn't killed there because\n\t// it relies on us doing this check here). In this case, EndDialog() has already been called\n\t// (with the proper result value) and the script's output variable has already been set.\n\t// 2) Even if we were to kill the timer when the user presses a button to dismiss the dialog,\n\t// this IsWindow() check would still be needed here because TimerProc()'s are called via\n\t// WM_TIMER messages, some of which might still be in our msg queue even after the timer\n\t// has been killed. In other words, split second timing issues may cause this TimerProc()\n\t// to fire even if the timer were killed when the user dismissed the dialog.\n\t// UPDATE: For performance reasons, the timer is now killed when the user presses a button,\n\t// so case #1 is obsolete (but kept here for background/insight).\n\tif (IsWindow(hWnd))\n\t{\n\t\tauto &CURR_INPUTBOX = *(InputBoxType *)idEvent;\n\t\t// Even though the dialog has timed out, we still want to write anything the user\n\t\t// had a chance to enter into the output var. This is because it's conceivable that\n\t\t// someone might want a short timeout just to enter something quick and let the\n\t\t// timeout dismiss the dialog for them (i.e. so that they don't have to press enter\n\t\t// or a button:\n\t\tINT_PTR result = FAIL;\n\t\tHWND hControl = GetDlgItem(hWnd, IDC_INPUTEDIT);\n\t\tif (hControl && CURR_INPUTBOX.UpdateResult(hControl))\n\t\t\tresult = AHK_TIMEOUT;\n\t\tEndDialog(hWnd, result);\n\t}\n\tKillTimer(hWnd, idEvent);\n}\n\n\n\nResultType InputBoxType::UpdateResult(HWND hControl)\n{\n\tint space_needed = GetWindowTextLength(hControl) + 1;\n\t// Set up the result buffer.\n\tif ( !(return_string = tmalloc(space_needed)) )\n\t\treturn FAIL; // BIF_InputBox will display an error.\n\t// Write to the variable:\n\tsize_t len = (size_t)GetWindowText(hControl, return_string, space_needed);\n\tif (!len)\n\t\t// There was no text to get or GetWindowText() failed.\n\t\t*return_string = '\\0';\n\treturn OK;\n}\n"},"size":{"kind":"number","value":15791,"string":"15,791"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":359,"string":"359"},"avg_line_length":{"kind":"number","value":40.93314763231198,"string":"40.933148"},"max_line_length":{"kind":"number","value":133,"string":"133"},"alphanum_fraction":{"kind":"number","value":0.7256280098919693,"string":"0.725628"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11098,"cells":{"id":{"kind":"number","value":16093,"string":"16,093"},"file_name":{"kind":"string","value":"string.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/lib/string.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\"\n#include \"script.h\"\n#include \"globaldata.h\"\n#include \"script_func_impl.h\"\n#include <shlwapi.h> // StrCmpLogicalW\n\n\n\nBIF_DECL(BIF_FormatTime)\n// The compressed code size of this function is about 1 KB (2 KB uncompressed), which compares\n// favorably to using setlocale()+strftime(), which together are about 8 KB of compressed code\n// (setlocale() seems to be needed to put the user's or system's locale into effect for strftime()).\n// setlocale() weighs in at about 6.5 KB compressed (14 KB uncompressed).\n{\n\t_f_param_string_opt(aYYYYMMDD, 0);\n\t_f_param_string_opt(aFormat, 1);\n\n\t#define FT_MAX_INPUT_CHARS 2000\n\t// Input/format length is restricted since it must be translated and expanded into a new format\n\t// string that uses single quotes around non-alphanumeric characters such as punctuation:\n\tif (_tcslen(aFormat) > FT_MAX_INPUT_CHARS)\n\t\t_f_throw_param(1);\n\n\t// Worst case expansion: .d.d.d.d. (9 chars) --> '.'d'.'d'.'d'.'d'.' (19 chars)\n\t// Buffer below is sized to a little more than twice as big as the largest allowed format,\n\t// which avoids having to constantly check for buffer overflow while translating aFormat\n\t// into format_buf:\n\t#define FT_MAX_OUTPUT_CHARS (2*FT_MAX_INPUT_CHARS + 10)\n\tTCHAR format_buf[FT_MAX_OUTPUT_CHARS + 1];\n\tTCHAR output_buf[FT_MAX_OUTPUT_CHARS + 1]; // The size of this is somewhat arbitrary, but buffer overflow is checked so it's safe.\n\n\tTCHAR yyyymmdd[256]; // Large enough to hold date/time and any options that follow it (note that D and T options can appear multiple times).\n\t*yyyymmdd = '\\0';\n\n\tSYSTEMTIME st;\n\tLPTSTR options = NULL;\n\n\tif (!*aYYYYMMDD) // Use current local time by default.\n\t\tGetLocalTime(&st);\n\telse\n\t{\n\t\ttcslcpy(yyyymmdd, omit_leading_whitespace(aYYYYMMDD), _countof(yyyymmdd)); // Make a modifiable copy.\n\t\tif (*yyyymmdd < '0' || *yyyymmdd > '9') // First character isn't a digit, therefore...\n\t\t{\n\t\t\t// ... options are present without date (since yyyymmdd [if present] must come before options).\n\t\t\toptions = yyyymmdd;\n\t\t\tGetLocalTime(&st); // Use current local time by default.\n\t\t}\n\t\telse // Since the string starts with a digit, rules say it must be a YYYYMMDD string, possibly followed by options.\n\t\t{\n\t\t\t// Find first space or tab because YYYYMMDD portion might contain only the leading part of date/timestamp.\n\t\t\tif (options = StrChrAny(yyyymmdd, _T(\" \\t\"))) // Find space or tab.\n\t\t\t{\n\t\t\t\t*options = '\\0'; // Terminate yyyymmdd at the end of the YYYYMMDDHH24MISS string.\n\t\t\t\toptions = omit_leading_whitespace(++options); // Point options to the right place (can be empty string).\n\t\t\t}\n\t\t\t//else leave options set to NULL to indicate that there are none.\n\n\t\t\t// Pass \"false\" for validation so that times can still be reported even if the year\n\t\t\t// is prior to 1601. If the time and/or date is invalid, GetTimeFormat() and GetDateFormat()\n\t\t\t// will refuse to produce anything, which is documented behavior:\n\t\t\tif (!YYYYMMDDToSystemTime(yyyymmdd, st, false))\n\t\t\t\t_f_throw_param(0);\n\t\t}\n\t}\n\t\n\t// Set defaults. Some can be overridden by options (if there are any options).\n\tLCID lcid = LOCALE_USER_DEFAULT;\n\tDWORD date_flags = 0, time_flags = 0;\n\tbool date_flags_specified = false, time_flags_specified = false, reverse_date_time = false;\n\t#define FT_FORMAT_NONE 0\n\t#define FT_FORMAT_TIME 1\n\t#define FT_FORMAT_DATE 2\n\tint format_type1 = FT_FORMAT_NONE;\n\tLPTSTR format2_marker = NULL; // Will hold the location of the first char of the second format (if present).\n\tbool do_null_format2 = false; // Will be changed to true if a default date *and* time should be used.\n\n\tif (options) // Parse options.\n\t{\n\t\tLPTSTR option_end;\n\t\tTCHAR orig_char;\n\t\tfor (LPTSTR next_option = options; *next_option; next_option = omit_leading_whitespace(option_end))\n\t\t{\n\t\t\t// Find the end of this option item:\n\t\t\tif ( !(option_end = StrChrAny(next_option, _T(\" \\t\"))) ) // Space or tab.\n\t\t\t\toption_end = next_option + _tcslen(next_option); // Set to position of zero terminator instead.\n\n\t\t\t// Permanently terminate in between options to help eliminate ambiguity for words contained\n\t\t\t// inside other words, and increase confidence in decimal and hexadecimal conversion.\n\t\t\torig_char = *option_end;\n\t\t\t*option_end = '\\0';\n\n\t\t\t++next_option;\n\t\t\tswitch (_totupper(next_option[-1]))\n\t\t\t{\n\t\t\tcase 'D':\n\t\t\t\tdate_flags_specified = true;\n\t\t\t\tdate_flags |= ATOU(next_option); // ATOU() for unsigned.\n\t\t\t\tbreak;\n\t\t\tcase 'T':\n\t\t\t\ttime_flags_specified = true;\n\t\t\t\ttime_flags |= ATOU(next_option); // ATOU() for unsigned.\n\t\t\t\tbreak;\n\t\t\tcase 'R':\n\t\t\t\treverse_date_time = true;\n\t\t\t\tbreak;\n\t\t\tcase 'L':\n\t\t\t\tlcid = !_tcsicmp(next_option, _T(\"Sys\")) ? LOCALE_SYSTEM_DEFAULT : (LCID)ATOU(next_option);\n\t\t\t\tbreak;\n\t\t\t// If not one of the above, such as zero terminator or a number, just ignore it.\n\t\t\t}\n\n\t\t\t*option_end = orig_char; // Undo the temporary termination so that loop's omit_leading() will work.\n\t\t} // for() each item in option list\n\t} // Parse options.\n\n\tif (!*aFormat)\n\t{\n\t\taFormat = NULL; // Tell GetDateFormat() and GetTimeFormat() to use default for the specified locale.\n\t\tif (!date_flags_specified) // No preference was given, so use long (which seems generally more useful).\n\t\t\tdate_flags |= DATE_LONGDATE;\n\t\tif (!time_flags_specified)\n\t\t\ttime_flags |= TIME_NOSECONDS; // Seems more desirable/typical to default to no seconds.\n\t\t// Put the time first by default, though this is debatable (Metapad does it and I like it).\n\t\tformat_type1 = reverse_date_time ? FT_FORMAT_DATE : FT_FORMAT_TIME;\n\t\tdo_null_format2 = true;\n\t}\n\telse // aFormat is non-blank.\n\t{\n\t\t// Omit whitespace only for consideration of special keywords. Whitespace is later kept for\n\t\t// a normal format string such as \" MM/dd/yy\":\n\t\tLPTSTR candidate = omit_leading_whitespace(aFormat);\n\t\tif (!_tcsicmp(candidate, _T(\"YWeek\")))\n\t\t{\n\t\t\tGetISOWeekNumber(output_buf, st.wYear, GetYDay(st.wMonth, st.wDay, IS_LEAP_YEAR(st.wYear)), st.wDayOfWeek);\n\t\t\t_f_return(output_buf);\n\t\t}\n\t\tif (!_tcsicmp(candidate, _T(\"YDay\")) || !_tcsicmp(candidate, _T(\"YDay0\")))\n\t\t{\n\t\t\tint yday = GetYDay(st.wMonth, st.wDay, IS_LEAP_YEAR(st.wYear));\n\t\t\t// Format with leading zeroes if YDay0 was used.\n\t\t\t_stprintf(output_buf, candidate[4] == '0' ? _T(\"%03d\") : _T(\"%d\"), yday);\n\t\t\t_f_return(output_buf);\n\t\t}\n\t\tif (!_tcsicmp(candidate, _T(\"WDay\")))\n\t\t{\n\t\t\tLPTSTR buf = _f_retval_buf;\n\t\t\t*buf = '1' + st.wDayOfWeek; // '1' vs '0' to convert to 1-based for compatibility with A_WDay.\n\t\t\tbuf[1] = '\\0';\n\t\t\t_f_return_p(buf, 1);\n\t\t}\n\n\t\t// Since above didn't return, check for those that require a call to GetTimeFormat/GetDateFormat\n\t\t// further below:\n\t\tif (!_tcsicmp(candidate, _T(\"ShortDate\")))\n\t\t{\n\t\t\taFormat = NULL;\n\t\t\tdate_flags |= DATE_SHORTDATE;\n\t\t\tdate_flags &= ~(DATE_LONGDATE | DATE_YEARMONTH); // If present, these would prevent it from working.\n\t\t}\n\t\telse if (!_tcsicmp(candidate, _T(\"LongDate\")))\n\t\t{\n\t\t\taFormat = NULL;\n\t\t\tdate_flags |= DATE_LONGDATE;\n\t\t\tdate_flags &= ~(DATE_SHORTDATE | DATE_YEARMONTH); // If present, these would prevent it from working.\n\t\t}\n\t\telse if (!_tcsicmp(candidate, _T(\"YearMonth\")))\n\t\t{\n\t\t\taFormat = NULL;\n\t\t\tdate_flags |= DATE_YEARMONTH;\n\t\t\tdate_flags &= ~(DATE_SHORTDATE | DATE_LONGDATE); // If present, these would prevent it from working.\n\t\t}\n\t\telse if (!_tcsicmp(candidate, _T(\"Time\")))\n\t\t{\n\t\t\tformat_type1 = FT_FORMAT_TIME;\n\t\t\taFormat = NULL;\n\t\t\tif (!time_flags_specified)\n\t\t\t\ttime_flags |= TIME_NOSECONDS; // Seems more desirable/typical to default to no seconds.\n\t\t}\n\t\telse // Assume normal format string.\n\t\t{\n\t\t\tLPTSTR cp = aFormat, dp = format_buf; // Initialize source and destination pointers.\n\t\t\tbool inside_their_quotes = false; // Whether we are inside a single-quoted string in the source.\n\t\t\tbool inside_our_quotes = false; // Whether we are inside a single-quoted string of our own making in dest.\n\t\t\tfor (; *cp; ++cp) // Transcribe aFormat into format_buf and also check for which comes first: date or time.\n\t\t\t{\n\t\t\t\tif (*cp == '\\'') // Note that '''' (four consecutive quotes) is a single literal quote, which this logic handles okay.\n\t\t\t\t{\n\t\t\t\t\tif (inside_our_quotes)\n\t\t\t\t\t{\n\t\t\t\t\t\t// Upon encountering their quotes while we're still in ours, merge theirs with ours and\n\t\t\t\t\t\t// remark it as theirs. This is done to avoid having two back-to-back quoted sections,\n\t\t\t\t\t\t// which would result in an unwanted literal single quote. Example:\n\t\t\t\t\t\t// 'Some string'':' (the two quotes in the middle would be seen as a literal quote).\n\t\t\t\t\t\tinside_our_quotes = false;\n\t\t\t\t\t\tinside_their_quotes = true;\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\tif (inside_their_quotes)\n\t\t\t\t\t{\n\t\t\t\t\t\t// If next char needs to be quoted, don't close out this quote section because that\n\t\t\t\t\t\t// would introduce two consecutive quotes, which would be interpreted as a single\n\t\t\t\t\t\t// literal quote if its enclosed by two outer single quotes. Instead convert this\n\t\t\t\t\t\t// quoted section over to \"ours\":\n\t\t\t\t\t\tif (cp[1] && !IsCharAlphaNumeric(cp[1]) && cp[1] != '\\'') // Also consider single quotes to be theirs due to this example: dddd:''''y\n\t\t\t\t\t\t\tinside_our_quotes = true;\n\t\t\t\t\t\t\t// And don't do \"*dp++ = *cp\"\n\t\t\t\t\t\telse // there's no next-char or it's alpha-numeric, so it doesn't need to be inside quotes.\n\t\t\t\t\t\t\t*dp++ = *cp; // Close out their quoted section.\n\t\t\t\t\t}\n\t\t\t\t\telse // They're starting a new quoted section, so just transcribe this single quote as-is.\n\t\t\t\t\t\t*dp++ = *cp;\n\t\t\t\t\tinside_their_quotes = !inside_their_quotes; // Must be done after the above.\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t\t// Otherwise, it's not a single quote.\n\t\t\t\tif (inside_their_quotes) // *cp is inside a single-quoted string, so it can be part of format/picture\n\t\t\t\t\t*dp++ = *cp; // Transcribe as-is.\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tif (IsCharAlphaNumeric(*cp))\n\t\t\t\t\t{\n\t\t\t\t\t\tif (inside_our_quotes)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t*dp++ = '\\''; // Close out the previous quoted section, since this char should not be a part of it.\n\t\t\t\t\t\t\tinside_our_quotes = false;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (_tcschr(_T(\"dMyg\"), *cp)) // A format unique to Date is present.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (!format_type1)\n\t\t\t\t\t\t\t\tformat_type1 = FT_FORMAT_DATE;\n\t\t\t\t\t\t\telse if (format_type1 == FT_FORMAT_TIME && !format2_marker) // type2 should only be set if different than type1.\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t*dp++ = '\\0'; // Terminate the first section and (below) indicate that there's a second.\n\t\t\t\t\t\t\t\tformat2_marker = dp; // Point it to the location in format_buf where the split should occur.\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse if (_tcschr(_T(\"hHmst\"), *cp)) // A format unique to Time is present.\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (!format_type1)\n\t\t\t\t\t\t\t\tformat_type1 = FT_FORMAT_TIME;\n\t\t\t\t\t\t\telse if (format_type1 == FT_FORMAT_DATE && !format2_marker) // type2 should only be set if different than type1.\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t*dp++ = '\\0'; // Terminate the first section and (below) indicate that there's a second.\n\t\t\t\t\t\t\t\tformat2_marker = dp; // Point it to the location in format_buf where the split should occur.\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// For consistency, transcribe all AlphaNumeric chars not inside single quotes as-is\n\t\t\t\t\t\t// (numbers are transcribed in case they are ever used as part of pic/format).\n\t\t\t\t\t\t*dp++ = *cp;\n\t\t\t\t\t}\n\t\t\t\t\telse // Not alphanumeric, so enclose this and any other non-alphanumeric characters in single quotes.\n\t\t\t\t\t{\n\t\t\t\t\t\tif (!inside_our_quotes)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t*dp++ = '\\''; // Create a new quoted section of our own, since this char should be inside quotes to be understood.\n\t\t\t\t\t\t\tinside_our_quotes = true;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t*dp++ = *cp; // Add this character between the quotes, since it's of the right \"type\".\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} // for()\n\t\t\tif (inside_our_quotes)\n\t\t\t\t*dp++ = '\\''; // Close out our quotes.\n\t\t\t*dp = '\\0'; // Final terminator.\n\t\t\taFormat = format_buf; // Point it to the freshly translated format string, for use below.\n\t\t} // aFormat contains normal format/pic string.\n\t} // aFormat isn't blank.\n\n\t// If there are no date or time formats present, still do the transcription so that\n\t// any quoted strings and whatnot are resolved. This increases runtime flexibility.\n\t// The below is also relied upon by \"LongDate\" and \"ShortDate\" above:\n\tif (!format_type1)\n\t\tformat_type1 = FT_FORMAT_DATE;\n\n\t// MSDN: Time: \"The function checks each of the time values to determine that it is within the\n\t// appropriate range of values. If any of the time values are outside the correct range, the\n\t// function fails, and sets the last-error to ERROR_INVALID_PARAMETER. \n\t// Dates: \"...year, month, day, and day of week. If the day of the week is incorrect, the\n\t// function uses the correct value, and returns no error. If any of the other date values\n\t// are outside the correct range, the function fails, and sets the last-error to ERROR_INVALID_PARAMETER.\n\n\tif (format_type1 == FT_FORMAT_DATE) // DATE comes first.\n\t{\n\t\tif (!GetDateFormat(lcid, date_flags, &st, aFormat, output_buf, FT_MAX_OUTPUT_CHARS))\n\t\t\t*output_buf = '\\0'; // Ensure it's still the empty string, then try to continue to get the second half (if there is one).\n\t}\n\telse // TIME comes first.\n\t\tif (!GetTimeFormat(lcid, time_flags, &st, aFormat, output_buf, FT_MAX_OUTPUT_CHARS))\n\t\t\t*output_buf = '\\0'; // Ensure it's still the empty string, then try to continue to get the second half (if there is one).\n\n\tif (format2_marker || do_null_format2) // There is also a second format present.\n\t{\n\t\tsize_t output_buf_length = _tcslen(output_buf);\n\t\tLPTSTR output_buf_marker = output_buf + output_buf_length;\n\t\tLPTSTR format2;\n\t\tif (do_null_format2)\n\t\t{\n\t\t\tformat2 = NULL;\n\t\t\t*output_buf_marker++ = ' '; // Provide a space between time and date.\n\t\t\t++output_buf_length;\n\t\t}\n\t\telse\n\t\t\tformat2 = format2_marker;\n\n\t\tint buf_remaining_size = (int)(FT_MAX_OUTPUT_CHARS - output_buf_length);\n\t\tint result;\n\n\t\tif (format_type1 == FT_FORMAT_DATE) // DATE came first, so this one is TIME.\n\t\t\tresult = GetTimeFormat(lcid, time_flags, &st, format2, output_buf_marker, buf_remaining_size);\n\t\telse\n\t\t\tresult = GetDateFormat(lcid, date_flags, &st, format2, output_buf_marker, buf_remaining_size);\n\t\tif (!result)\n\t\t\toutput_buf[output_buf_length] = '\\0'; // Ensure the first part is still terminated and just return that rather than nothing.\n\t}\n\n\t_f_return(output_buf);\n}\n\n\n\nBIF_DECL(BIF_StrCase)\n{\n\tsize_t length;\n\t_f_param_string(contents, 0, &length);\n\n\t// Make a modifiable copy of the string to return:\n\tif (!TokenSetResult(aResultToken, contents, length))\n\t\treturn;\n\taResultToken.symbol = SYM_STRING;\n\tcontents = aResultToken.marker;\n\n\tif (_f_callee_id == FID_StrLower)\n\t\tCharLower(contents);\n\telse if (_f_callee_id == FID_StrUpper)\n\t\tCharUpper(contents);\n\telse // Convert to title case.\n\t\tStrToTitleCase(contents);\n}\n\n\n\nFResult StrReplace(ExprTokenType &aSource, StrArg aOldStr, optl<StrArg> aNewStr, ExprTokenType *aCaseSense, UINT *aCount, optl<UINT> aLimit\n\t, ResultToken &aRetVal)\n{\n\tsize_t length; // Going in to StrReplace(), it's the haystack length. Later (coming out), it's the result length. \n\tauto source = TokenToString(aSource, aRetVal.buf, &length);\n\tauto oldstr = const_cast<LPTSTR>(aOldStr);\n\tauto newstr = const_cast<LPTSTR>(aNewStr.value_or_empty());\n\n\t// Maintain this together with the equivalent section of BIF_InStr:\n\tStringCaseSenseType string_case_sense = aCaseSense ? TokenToStringCase(*aCaseSense) : SCS_INSENSITIVE;\n\tif (string_case_sense == SCS_INVALID \n\t\t|| string_case_sense == SCS_INSENSITIVE_LOGICAL) // Not supported, seems more useful to throw rather than using SCS_INSENSITIVE.\n\t\treturn FR_E_ARG(3);\n\n\tUINT replacement_limit = aLimit.value_or(UINT_MAX);\n\n\t// Note: The current implementation of StrReplace() should be able to handle any conceivable inputs\n\t// without an empty string causing an infinite loop and without going infinite due to finding the\n\t// search string inside of newly-inserted replace strings (e.g. replacing all occurrences\n\t// of b with bcd would not keep finding b in the newly inserted bcd, infinitely).\n\tLPTSTR dest;\n\tUINT found_count = StrReplace(source, oldstr, newstr, string_case_sense, replacement_limit, -1, &dest, &length); // Length of haystack is passed to improve performance because TokenToString() can often discover it instantaneously.\n\n\tif (!dest) // Failure due to out of memory.\n\t\treturn FR_E_OUTOFMEM;\n\n\tif (dest != source) // StrReplace() allocated new memory rather than returning \"source\" to us unaltered.\n\t{\n\t\t// Return the newly allocated memory directly to our caller. \n\t\taRetVal.AcceptMem(dest, length);\n\t}\n\telse // StrReplace gave us back \"source\" unaltered because no replacements were needed.\n\t{\n\t\taRetVal.SetValue(dest, length); \n\t}\n\n\tif (aCount)\n\t\t*aCount = found_count;\n\treturn OK;\n}\n\n\n\n// Array := StrSplit(String [, Delimiters, OmitChars, MaxParts])\nbif_impl FResult StrSplit(StrArg aInputString, ExprTokenType *aDelimiters, optl<StrArg> aOmitChars, optl<int> aMaxParts, IObject *&aRetVal)\n{\n\tLPTSTR *aDelimiterList = NULL;\n\tint aDelimiterCount = 0;\n\tauto aOmitList = aOmitChars.value_or_empty();\n\tint splits_left = -2;\n\n\tif (aDelimiters)\n\t{\n\t\tif (auto obj = TokenToObject(*aDelimiters))\n\t\t{\n\t\t\tauto arr = dynamic_cast<Array *>(obj);\n\t\t\tif (!arr)\n\t\t\t\treturn FR_E_ARG(1);\n\t\t\taDelimiterCount = arr->Length();\n\t\t\tif (!aDelimiterCount)\n\t\t\t\treturn FR_E_ARG(1);\n\t\t\taDelimiterList = (LPTSTR *)_alloca(aDelimiterCount * sizeof(LPTSTR *));\n\t\t\tif (!arr->ToStrings(aDelimiterList, aDelimiterCount, aDelimiterCount))\n\t\t\t\t// Array contains something other than a string.\n\t\t\t\treturn FR_E_ARG(1);\n\t\t\tfor (int i = 0; i < aDelimiterCount; ++i)\n\t\t\t\tif (!*aDelimiterList[i])\n\t\t\t\t\t// Empty string in delimiter list. Although it could be treated similarly to the\n\t\t\t\t\t// \"no delimiter\" case, it's far more likely to be an error. If ever this check\n\t\t\t\t\t// is removed, the loop below must be changed to support \"\" as a delimiter.\n\t\t\t\t\treturn FR_E_ARG(1);\n\t\t}\n\t\telse\n\t\t{\n\t\t\taDelimiterList = (LPTSTR *)_alloca(sizeof(LPTSTR *));\n\t\t\t*aDelimiterList = TokenToString(*aDelimiters);\n\t\t\taDelimiterCount = **aDelimiterList != '\\0'; // i.e. non-empty string.\n\t\t}\n\t}\n\tif (aMaxParts.has_value())\n\t\tsplits_left = aMaxParts.value() - 1;\n\t\n\tauto output_array = Array::Create();\n\tif (!output_array)\n\t\treturn FR_E_OUTOFMEM;\n\n\tif (!*aInputString // The input variable is blank, thus there will be zero elements.\n\t\t|| splits_left == -1) // The caller specified 0 parts.\n\t{\n\t\taRetVal = output_array;\n\t\treturn OK;\n\t}\n\t\n\tLPCTSTR contents_of_next_element, delimiter, new_starting_pos;\n\tsize_t element_length, delimiter_length;\n\n\tif (aDelimiterCount) // The user provided a list of delimiters, so process the input variable normally.\n\t{\n\t\tfor (contents_of_next_element = aInputString; ; )\n\t\t{\n\t\t\tif ( !splits_left // Limit reached.\n\t\t\t\t|| !(delimiter = InStrAny(contents_of_next_element, aDelimiterList, aDelimiterCount, delimiter_length)) ) // No delimiter found.\n\t\t\t\tbreak; // This is the only way out of the loop other than critical errors.\n\t\t\telement_length = delimiter - contents_of_next_element;\n\t\t\tif (*aOmitList && element_length > 0)\n\t\t\t{\n\t\t\t\tcontents_of_next_element = omit_leading_any(contents_of_next_element, aOmitList, element_length);\n\t\t\t\telement_length = delimiter - contents_of_next_element; // Update in case above changed it.\n\t\t\t\tif (element_length)\n\t\t\t\t\telement_length = omit_trailing_any(contents_of_next_element, aOmitList, delimiter - 1);\n\t\t\t}\n\t\t\t// If there are no chars to the left of the delim, or if they were all in the list of omitted\n\t\t\t// chars, the variable will be assigned the empty string:\n\t\t\tif (!output_array->Append(contents_of_next_element, element_length))\n\t\t\t\tgoto outofmem;\n\t\t\tcontents_of_next_element = delimiter + delimiter_length; // Omit the delimiter since it's never included in contents.\n\t\t\tif (splits_left > 0)\n\t\t\t\t--splits_left;\n\t\t}\n\t}\n\telse\n\t{\n\t\t// Otherwise aDelimiterList is empty, so store each char of aInputString in its own array element.\n\t\tLPCTSTR cp, dp;\n\t\tfor (cp = aInputString; ; ++cp)\n\t\t{\n\t\t\tif (!*cp)\n\t\t\t{\n\t\t\t\taRetVal = output_array;\n\t\t\t\treturn OK;\n\t\t\t}\n\t\t\tfor (dp = aOmitList; *dp; ++dp)\n\t\t\t\tif (*cp == *dp) // This char is a member of the omitted list, thus it is not included in the output array.\n\t\t\t\t\tbreak; // (inner loop)\n\t\t\tif (*dp) // Omitted.\n\t\t\t\tcontinue;\n\t\t\tif (!splits_left) // Limit reached (checked only after excluding omitted chars).\n\t\t\t\tbreak; // This is the only way out of the loop other than critical errors.\n\t\t\tif (splits_left > 0)\n\t\t\t\t--splits_left;\n\t\t\tif (!output_array->Append(cp, 1))\n\t\t\t\tgoto outofmem;\n\t\t}\n\t\tcontents_of_next_element = cp;\n\t}\n\t// Since above used break rather than goto or return, either the limit was reached or there are\n\t// no more delimiters, so store the remainder of the string minus any characters to be omitted.\n\telement_length = _tcslen(contents_of_next_element);\n\tif (*aOmitList && element_length > 0)\n\t{\n\t\tnew_starting_pos = omit_leading_any(contents_of_next_element, aOmitList, element_length);\n\t\telement_length -= (new_starting_pos - contents_of_next_element); // Update in case above changed it.\n\t\tcontents_of_next_element = new_starting_pos;\n\t\tif (element_length)\n\t\t\t// If this is true, the string must contain at least one char that isn't in the list\n\t\t\t// of omitted chars, otherwise omit_leading_any() would have already omitted them:\n\t\t\telement_length = omit_trailing_any(contents_of_next_element, aOmitList\n\t\t\t\t, contents_of_next_element + element_length - 1);\n\t}\n\t// If there are no chars to the left of the delim, or if they were all in the list of omitted\n\t// chars, the item will be an empty string:\n\tif (output_array->Append(contents_of_next_element, element_length))\n\t{\n\t\taRetVal = output_array;\n\t\treturn OK;\n\t}\n\t//else memory allocation failed, so fall through:\noutofmem:\n\t// The fact that this section is executing means that a memory allocation failed and caused the\n\t// loop to break, so throw an exception.\n\toutput_array->Release(); // Since we're not returning it.\n\treturn FR_E_OUTOFMEM;\n}\n\n\n\n// SplitPath outputs:\n// aName: non-null, either constant _T(\"\") or points into aFileSpec.\n// all others: null if no such component, otherwise points into aFileSpec.\nvoid SplitPath(LPCTSTR aFileSpec, LPCTSTR &aName, LPCTSTR &aExtDot, LPCTSTR &aDirEnd, LPCTSTR &aDriveEnd)\n{\n\t// For URLs, \"drive\" is defined as the server name, e.g. http://somedomain.com\n\tLPCTSTR name = _T(\"\"), name_delimiter = nullptr, drive_end = nullptr;\n\tLPCTSTR drive = omit_leading_whitespace(aFileSpec); // i.e. whitespace is considered for everything except the drive letter or server name, so that a pathless filename can have leading whitespace.\n\tLPCTSTR colon_double_slash = _tcsstr(aFileSpec, _T(\"://\"));\n\n\tif (colon_double_slash) // This is a URL such as ftp://... or http://...\n\t{\n\t\tif ( !(drive_end = _tcschr(colon_double_slash + 3, '/')) )\n\t\t{\n\t\t\tif ( !(drive_end = _tcschr(colon_double_slash + 3, '\\\\')) ) // Try backslash so that things like file://C:\\Folder\\File.txt are supported.\n\t\t\t\tdrive_end = colon_double_slash + _tcslen(colon_double_slash); // Set it to the position of the zero terminator instead.\n\t\t\t\t// And because there is no filename, leave name and name_delimiter set to their defaults.\n\t\t\t//else there is a backslash, e.g. file://C:\\Folder\\File.txt, so treat that backslash as the end of the drive name.\n\t\t}\n\t\tname_delimiter = drive_end; // Set default, to be possibly overridden below.\n\t\t// Above has set drive_end to one of the following:\n\t\t// 1) The slash that occurs to the right of the doubleslash in a URL.\n\t\t// 2) The backslash that occurs to the right of the doubleslash in a URL.\n\t\t// 3) The zero terminator if there is no slash or backslash to the right of the doubleslash.\n\t\tif (*drive_end) // A slash or backslash exists to the right of the server name.\n\t\t{\n\t\t\tif (*(drive_end + 1))\n\t\t\t{\n\t\t\t\t// Find the rightmost slash. At this stage, this is known to find the correct slash.\n\t\t\t\t// In the case of a file at the root of a domain such as http://domain.com/root_file.htm,\n\t\t\t\t// the directory consists of only the domain name, e.g. http://domain.com. This is because\n\t\t\t\t// the directory always the \"drive letter\" by design, since that is more often what the\n\t\t\t\t// caller wants. A script can use StringReplace to remove the drive/server portion from\n\t\t\t\t// the directory, if desired.\n\t\t\t\tname_delimiter = _tcsrchr(aFileSpec, '/');\n\t\t\t\tif (name_delimiter == colon_double_slash + 2) // To reach this point, it must have a backslash, something like file://c:\\folder\\file.txt\n\t\t\t\t\tname_delimiter = _tcsrchr(aFileSpec, '\\\\'); // Will always be found.\n\t\t\t\tname = name_delimiter + 1; // This will be the empty string for something like http://domain.com/dir/\n\t\t\t}\n\t\t\t//else something like http://domain.com/, so leave name and name_delimiter set to their defaults.\n\t\t}\n\t\t//else something like http://domain.com, so leave name and name_delimiter set to their defaults.\n\t}\n\telse // It's not a URL, just a file specification such as c:\\my folder\\my file.txt, or \\\\server01\\folder\\file.txt\n\t{\n\t\t// Differences between _splitpath() and the method used here:\n\t\t// _splitpath() doesn't include drive in output_var_dir, it includes a trailing\n\t\t// backslash, it includes the . in the extension, it considers \":\" to be a filename.\n\t\t// It doesn't support long paths.\n\n\t\t// Don't use _splitpath() since it supposedly doesn't handle UNC paths correctly,\n\t\t// and anyway we need more info than it provides. Also note that it is possible\n\t\t// for a file to begin with space(s) or a dot (if created programmatically), so\n\t\t// don't trim or omit leading space unless it's known to be an absolute path.\n\n\t\t// Note that \"C:Some File.txt\" is a valid filename in some contexts, which the below\n\t\t// tries to take into account. However, there will be no way for this command to\n\t\t// return a path that differentiates between \"C:Some File.txt\" and \"C:\\Some File.txt\"\n\t\t// since the first backslash is not included with the returned path, even if it's\n\t\t// the root directory (i.e. \"C:\" is returned in both cases). The \"C:Filename\"\n\t\t// convention is pretty rare, and anyway this trait can be detected via something like\n\t\t// IfInString, Filespec, :, IfNotInString, Filespec, :\\, MsgBox Drive with no absolute path.\n\n\t\t// UNCs are detected with this approach so that double sets of backslashes -- which sometimes\n\t\t// occur by accident in \"built filespecs\" and are tolerated by the OS -- are not falsely\n\t\t// detected as UNCs.\n\t\tif (drive[0] == '\\\\' && drive[1] == '\\\\') // Relies on short-circuit evaluation order.\n\t\t{\n\t\t\tif ( !(drive_end = _tcschr(drive + 2, '\\\\')) )\n\t\t\t\tdrive_end = drive + _tcslen(drive); // Set it to the position of the zero terminator instead.\n\t\t}\n\t\telse if (*(drive + 1) == ':') // It's an absolute path.\n\t\t\t// Assign letter and colon for consistency with server naming convention above.\n\t\t\t// i.e. so that server name and drive can be used without having to worry about\n\t\t\t// whether it needs a colon added or not.\n\t\t\tdrive_end = drive + 2;\n\t\telse\n\t\t{\n\t\t\t// It's debatable, but it seems best to return a blank drive if a aFileSpec is a relative path.\n\t\t\t// rather than trying to use GetFullPathName() on a potentially non-existent file/dir.\n\t\t\t// _splitpath() doesn't fetch the drive letter of relative paths either. This also reports\n\t\t\t// a blank drive for something like file://C:\\My Folder\\My File.txt, which seems too rarely\n\t\t\t// to justify a special mode.\n\t\t\t//drive_end = nullptr; // Already set by default.\n\t\t}\n\n\t\tif ( !(name_delimiter = _tcsrchr(aFileSpec, '\\\\')) ) // No backslash.\n\t\t\tif ( !(name_delimiter = _tcsrchr(aFileSpec, ':')) ) // No colon.\n\t\t\t\tname_delimiter = NULL; // Indicate that there is no directory.\n\n\t\tname = name_delimiter ? name_delimiter + 1 : aFileSpec; // If no delimiter, name is the entire string.\n\t}\n\n\t// The above has now set the following variables:\n\t// name: As an empty string or the actual name of the file, including extension.\n\t// name_delimiter: As NULL if there is no directory, otherwise, the end of the directory's name.\n\t// drive: As the start of the drive/server name, e.g. C:, \\\\Workstation01, http://domain.com, etc.\n\t// drive_end: As the position after the drive's last character, either a zero terminator, slash, or backslash.\n\n\taName = name;\n\t\n\taExtDot = _tcsrchr(name, '.');\n\t\n\taDriveEnd = drive_end;\n\t\n\tif (!name_delimiter || *name_delimiter == '\\\\' || *name_delimiter == '/')\n\t\taDirEnd = name_delimiter;\n\telse // *name_delimiter == ':', e.g. \"C:Some File.txt\". If aFileSpec starts with just \":\",\n\t\t // the dir returned here will also start with just \":\" since that's rare & illegal anyway.\n\t\taDirEnd = name_delimiter + 1;\n}\n\n\n\nFResult SplitPath(StrArg aPath, StrRet *aName, StrRet *aDir, StrRet *aExt, StrRet *aNameNoExt, StrRet *aDrive)\n{\n\tLPCTSTR name, ext_dot, dir_end, drive_end;\n\tSplitPath(aPath, name, ext_dot, dir_end, drive_end);\n\tif (aName)\n\t\taName->SetTemp(name);\n\tif (aDir && dir_end)\n\t\taDir->Copy(aPath, dir_end - aPath);\n\tif (aExt && ext_dot)\n\t\taExt->Copy(ext_dot + 1);\n\tif (aNameNoExt)\n\t\taNameNoExt->Copy(name, ext_dot ? ext_dot - name : _tcslen(name));\n\tif (aDrive && drive_end)\n\t\taDrive->Copy(aPath, drive_end - aPath);\n\treturn OK;\n}\n\n\n\nint SortWithOptions(const void *a1, const void *a2)\n// Decided to just have one sort function since there are so many permutations. The performance\n// will be a little bit worse, but it seems simpler to implement and maintain.\n// This function's input parameters are pointers to the elements of the array. Since those elements\n// are themselves pointers, the input parameters are therefore pointers to pointers (handles).\n{\n\tLPTSTR sort_item1 = *(LPTSTR *)a1;\n\tLPTSTR sort_item2 = *(LPTSTR *)a2;\n\tif (g_SortColumnOffset > 0)\n\t{\n\t\t// Adjust each string (even for numerical sort) to be the right column position,\n\t\t// or the position of its zero terminator if the column offset goes beyond its length:\n\t\tsize_t length = _tcslen(sort_item1);\n\t\tsort_item1 += (size_t)g_SortColumnOffset > length ? length : g_SortColumnOffset;\n\t\tlength = _tcslen(sort_item2);\n\t\tsort_item2 += (size_t)g_SortColumnOffset > length ? length : g_SortColumnOffset;\n\t}\n\tif (g_SortNumeric) // Takes precedence over g_SortCaseSensitive\n\t{\n\t\t// For now, assume both are numbers. If one of them isn't, it will be sorted as a zero.\n\t\t// Thus, all non-numeric items should wind up in a sequential, unsorted group.\n\t\t// Resolve only once since parts of the ATOF() macro are inline:\n\t\tdouble item1_minus_2 = ATOF(sort_item1) - ATOF(sort_item2);\n\t\tif (!item1_minus_2) // Exactly equal.\n\t\t\treturn (sort_item1 > sort_item2) ? 1 : -1; // Stable sort.\n\t\t// Otherwise, it's either greater or less than zero:\n\t\tint result = (item1_minus_2 > 0.0) ? 1 : -1;\n\t\treturn g_SortReverse ? -result : result;\n\t}\n\t// Otherwise, it's a non-numeric sort.\n\t// v1.0.43.03: Added support the new locale-insensitive mode.\n\tint result = (g_SortCaseSensitive != SCS_INSENSITIVE_LOGICAL)\n\t\t? tcscmp2(sort_item1, sort_item2, g_SortCaseSensitive) // Resolve large macro only once for code size reduction.\n\t\t: StrCmpLogicalW(sort_item1, sort_item2);\n\tif (!result)\n\t\tresult = (sort_item1 > sort_item2) ? 1 : -1; // Stable sort.\n\treturn g_SortReverse ? -result : result;\n}\n\n\n\nint SortByNakedFilename(const void *a1, const void *a2)\n// See comments in prior function for details.\n{\n\tLPTSTR sort_item1 = *(LPTSTR *)a1;\n\tLPTSTR sort_item2 = *(LPTSTR *)a2;\n\tLPTSTR cp;\n\tif (cp = _tcsrchr(sort_item1, '\\\\')) // Assign\n\t\tsort_item1 = cp + 1;\n\tif (cp = _tcsrchr(sort_item2, '\\\\')) // Assign\n\t\tsort_item2 = cp + 1;\n\t// v1.0.43.03: Added support the new locale-insensitive mode.\n\tint result = (g_SortCaseSensitive != SCS_INSENSITIVE_LOGICAL)\n\t\t? tcscmp2(sort_item1, sort_item2, g_SortCaseSensitive) // Resolve large macro only once for code size reduction.\n\t\t: StrCmpLogicalW(sort_item1, sort_item2);\n\tif (!result)\n\t\tresult = (sort_item1 > sort_item2) ? 1 : -1; // Stable sort.\n\treturn g_SortReverse ? -result : result;\n}\n\n\n\nstruct sort_rand_type\n{\n\tLPTSTR cp; // This must be the first member of the struct, otherwise the array trickery in PerformSort will fail.\n\tunion\n\t{\n\t\t// This must be the same size in bytes as the above, which is why it's maintained as a union with\n\t\t// a char* rather than a plain int.\n\t\tLPTSTR unused;\n\t\tint rand;\n\t};\n};\n\nint SortRandom(const void *a1, const void *a2)\n// See comments in prior functions for details.\n{\n\treturn ((sort_rand_type *)a1)->rand - ((sort_rand_type *)a2)->rand;\n}\n\nint SortUDF(const void *a1, const void *a2)\n// See comments in prior function for details.\n{\n\tif (!g_SortFuncResult || g_SortFuncResult == EARLY_EXIT)\n\t\treturn 0;\n\n\t// The following isn't necessary because by definition, the current thread isn't paused because it's the\n\t// thing that called the sort in the first place.\n\t//g_script.UpdateTrayIcon();\n\n\tLPTSTR aStr1 = *(LPTSTR *)a1;\n\tLPTSTR aStr2 = *(LPTSTR *)a2;\n\tExprTokenType param[] = { aStr1, aStr2, __int64(aStr2 - aStr1) };\n\t__int64 i64;\n\tg_SortFuncResult = CallMethod(g_SortFunc, g_SortFunc, nullptr, param, _countof(param), &i64);\n\t// An alternative to g_SortFuncResult using 'throw' to abort qsort() produced slightly\n\t// smaller code, but in release builds the program crashed with code 0xC0000409 and the\n\t// catch() block never executed.\n\n\tint returned_int;\n\tif (i64) // Maybe there's a faster/better way to do these checks. Can't simply typecast to an int because some large positives wrap into negative, maybe vice versa.\n\t\treturned_int = i64 < 0 ? -1 : 1;\n\telse // The result was 0 or \"\". Since returning 0 would make the results less predictable and doesn't seem to have any benefit,\n\t\treturned_int = aStr1 < aStr2 ? -1 : 1; // use the relative positions of the items as a tie-breaker.\n\n\treturn returned_int;\n}\n\n\n\nBIF_DECL(BIF_Sort)\n{\n\t// Set defaults in case of early goto:\n\tLPTSTR mem_to_free = NULL;\n\tLPTSTR *item = NULL; // The index/pointer list used for the sort.\n\tIObject *sort_func_orig = g_SortFunc; // Because UDFs can be interrupted by other threads -- and because UDFs can themselves call Sort with some other UDF (unlikely to be sure) -- backup & restore original g_SortFunc so that the \"collapsing in reverse order\" behavior will automatically ensure proper operation.\n\tResultType sort_func_result_orig = g_SortFuncResult;\n\tg_SortFunc = NULL; // Now that original has been saved above, reset to detect whether THIS sort uses a UDF.\n\tg_SortFuncResult = OK;\n\n\t_f_param_string(aContents, 0);\n\t_f_param_string_opt(aOptions, 1);\n\n\t// Resolve options. First set defaults for options:\n\tTCHAR delimiter = '\\n';\n\tg_SortCaseSensitive = SCS_INSENSITIVE;\n\tg_SortNumeric = false;\n\tg_SortReverse = false;\n\tg_SortColumnOffset = 0;\n\tbool trailing_delimiter_indicates_trailing_blank_item = false, terminate_last_item_with_delimiter = false\n\t\t, trailing_crlf_added_temporarily = false, sort_by_naked_filename = false, sort_random = false\n\t\t, omit_dupes = false;\n\tLPTSTR cp;\n\n\tfor (cp = aOptions; *cp; ++cp)\n\t{\n\t\tswitch(_totupper(*cp))\n\t\t{\n\t\tcase 'C':\n\t\t\tif (ctoupper(cp[1]) == 'L')\n\t\t\t{\n\t\t\t\tif (!_tcsnicmp(cp+2, _T(\"Logical\") + 1, 6)) // CLogical. Using \"Logical\" + 1 instead of \"ogical\" was confirmed to eliminate one string from the binary (due to string pooling).\n\t\t\t\t{\n\t\t\t\t\tcp += 7;\n\t\t\t\t\tg_SortCaseSensitive = SCS_INSENSITIVE_LOGICAL;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tif (!_tcsnicmp(cp+2, _T(\"Locale\") + 1, 5)) // CLocale\n\t\t\t\t\t\tcp += 6;\n\t\t\t\t\telse // CL\n\t\t\t\t\t\t++cp;\n\t\t\t\t\tg_SortCaseSensitive = SCS_INSENSITIVE_LOCALE;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (!_tcsnicmp(cp+1, _T(\"Off\"), 3)) // COff. Using ctoupper() here significantly increased code size.\n\t\t\t{\n\t\t\t\tcp += 3;\n\t\t\t\tg_SortCaseSensitive = SCS_INSENSITIVE;\n\t\t\t}\n\t\t\telse if (cp[1] == '0') // C0\n\t\t\t\tg_SortCaseSensitive = SCS_INSENSITIVE;\n\t\t\telse // C C1 COn\n\t\t\t{\n\t\t\t\tif (!_tcsnicmp(cp+1, _T(\"On\"), 2)) // COn. Using ctoupper() here significantly increased code size.\n\t\t\t\t\tcp += 2;\n\t\t\t\tg_SortCaseSensitive = SCS_SENSITIVE;\n\t\t\t}\n\t\t\tbreak;\n\t\tcase 'D':\n\t\t\tif (!cp[1]) // Avoids out-of-bounds when the loop's own ++cp is done.\n\t\t\t\tbreak;\n\t\t\t++cp;\n\t\t\tif (*cp)\n\t\t\t\tdelimiter = *cp;\n\t\t\tbreak;\n\t\tcase 'N':\n\t\t\tg_SortNumeric = true;\n\t\t\tbreak;\n\t\tcase 'P':\n\t\t\t// Use atoi() vs. ATOI() to avoid interpreting something like 0x01C as hex\n\t\t\t// when in fact the C was meant to be an option letter:\n\t\t\tg_SortColumnOffset = _ttoi(cp + 1);\n\t\t\tif (g_SortColumnOffset < 1)\n\t\t\t\tg_SortColumnOffset = 1;\n\t\t\t--g_SortColumnOffset; // Convert to zero-based.\n\t\t\tbreak;\n\t\tcase 'R':\n\t\t\tif (!_tcsnicmp(cp, _T(\"Random\"), 6))\n\t\t\t{\n\t\t\t\tsort_random = true;\n\t\t\t\tcp += 5; // Point it to the last char so that the loop's ++cp will point to the character after it.\n\t\t\t}\n\t\t\telse\n\t\t\t\tg_SortReverse = true;\n\t\t\tbreak;\n\t\tcase 'U': // Unique.\n\t\t\tomit_dupes = true;\n\t\t\tbreak;\n\t\tcase 'Z':\n\t\t\t// By setting this to true, the final item in the list, if it ends in a delimiter,\n\t\t\t// is considered to be followed by a blank item:\n\t\t\ttrailing_delimiter_indicates_trailing_blank_item = true;\n\t\t\tbreak;\n\t\tcase '\\\\':\n\t\t\tsort_by_naked_filename = true;\n\t\t}\n\t}\n\n\tif (!ParamIndexIsOmitted(2))\n\t{\n\t\tif ( !(g_SortFunc = ParamIndexToObject(2)) )\n\t\t{\n\t\t\taResultToken.ParamError(2, aParam[2]);\n\t\t\tgoto end;\n\t\t}\n\t\tg_SortFunc->AddRef(); // Must be done in case the parameter was SYM_VAR and that var gets reassigned.\n\t}\n\t\n\tif (!*aContents) // Input is empty, nothing to sort, return empty string.\n\t{\n\t\taResultToken.Return(_T(\"\"), 0);\n\t\tgoto end;\n\t}\n\t\n\tsize_t item_count;\n\n\t// Check how many delimiters are present:\n\tfor (item_count = 1, cp = aContents; *cp; ++cp) // Start at 1 since item_count is delimiter_count+1\n\t\tif (*cp == delimiter)\n\t\t\t++item_count;\n\tsize_t aContents_length = cp - aContents;\n\n\t// If the last character in the unsorted list is a delimiter then technically the final item\n\t// in the list is a blank item. However, if the options specify not to allow that, don't count that\n\t// blank item as an actual item (i.e. omit it from the list):\n\tif (!trailing_delimiter_indicates_trailing_blank_item && cp > aContents && cp[-1] == delimiter)\n\t{\n\t\tterminate_last_item_with_delimiter = true; // Have a later stage add the delimiter to the end of the sorted list so that the length and format of the sorted list is the same as the unsorted list.\n\t\t--item_count; // Indicate that the blank item at the end of the list isn't being counted as an item.\n\t}\n\telse // The final character isn't a delimiter or it is but there's a blank item to its right. Either way, the following is necessary (verified correct).\n\t{\n\t\tif (delimiter == '\\n')\n\t\t{\n\t\t\tLPTSTR first_delimiter = _tcschr(aContents, delimiter);\n\t\t\tif (first_delimiter && first_delimiter > aContents && first_delimiter[-1] == '\\r')\n\t\t\t{\n\t\t\t\t// v1.0.47.05:\n\t\t\t\t// Here the delimiter is effectively CRLF vs. LF. Therefore, signal a later section to append\n\t\t\t\t// an extra CRLF to simplify the code and fix bugs that existed prior to v1.0.47.05.\n\t\t\t\t// One such bug is that sorting \"x`r`nx\" in unique mode would previously produce two\n\t\t\t\t// x's rather than one because the first x is seen to have a `r to its right but the\n\t\t\t\t// second lacks it (due to the CRLF delimiter being simulated via LF-only).\n\t\t\t\t//\n\t\t\t\t// OLD/OBSOLETE comment from a section that was removed because it's now handled by this section:\n\t\t\t\t// Check if special handling is needed due to the following situation:\n\t\t\t\t// Delimiter is LF but the contents are lines delimited by CRLF, not just LF\n\t\t\t\t// and the original/unsorted list's last item was not terminated by an\n\t\t\t\t// \"allowed delimiter\". The symptoms of this are that after the sort, the\n\t\t\t\t// last item will end in \\r when it should end in no delimiter at all.\n\t\t\t\t// This happens pretty often, such as when the clipboard contains files.\n\t\t\t\t// In the future, an option letter can be added to turn off this workaround,\n\t\t\t\t// but it seems unlikely that anyone would ever want to.\n\t\t\t\ttrailing_crlf_added_temporarily = true;\n\t\t\t\tterminate_last_item_with_delimiter = true; // This is done to \"fool\" later sections into thinking the list ends in a CRLF that doesn't have a blank item to the right, which in turn simplifies the logic and/or makes it more understandable.\n\t\t\t}\n\t\t}\n\t}\n\n\tif (item_count == 1) // 1 item is already sorted, and no dupes are possible.\n\t{\n\t\taResultToken.Return(aContents, aContents_length);\n\t\tgoto end;\n\t}\n\n\t// v1.0.47.05: It simplifies the code a lot to allocate and/or improves understandability to allocate\n\t// memory for trailing_crlf_added_temporarily even though technically it's done only to make room to\n\t// append the extra CRLF at the end.\n\t// v2.0: Never modify the caller's aContents, since it may be a quoted literal string or variable.\n\t//if (g_SortFunc || trailing_crlf_added_temporarily) // Do this here rather than earlier with the options parsing in case the function-option is present twice (unlikely, but it would be a memory leak due to strdup below). Doing it here also avoids allocating if it isn't necessary.\n\t{\n\t\t// Comment is obsolete because if aContents is in a deref buffer, it has been privatized by ExpandArgs():\n\t\t// When g_SortFunc!=NULL, the copy of the string is needed because aContents may be in the deref buffer,\n\t\t// and that deref buffer is about to be overwritten by the execution of the script's UDF body.\n\t\tif ( !(mem_to_free = tmalloc(aContents_length + 3)) ) // +1 for terminator and +2 in case of trailing_crlf_added_temporarily.\n\t\t{\n\t\t\taResultToken.MemoryError();\n\t\t\tgoto end;\n\t\t}\n\t\ttmemcpy(mem_to_free, aContents, aContents_length + 1); // memcpy() usually benches a little faster than _tcscpy().\n\t\taContents = mem_to_free;\n\t\tif (trailing_crlf_added_temporarily)\n\t\t{\n\t\t\t// Must be added early so that the next stage will terminate at the \\n, leaving the \\r as\n\t\t\t// the ending character in this item.\n\t\t\t_tcscpy(aContents + aContents_length, _T(\"\\r\\n\"));\n\t\t\taContents_length += 2;\n\t\t}\n\t}\n\n\t// Create the array of pointers that points into aContents to each delimited item.\n\t// Use item_count + 1 to allow space for the last (blank) item in case\n\t// trailing_delimiter_indicates_trailing_blank_item is false:\n\tint unit_size = sort_random ? 2 : 1;\n\tsize_t item_size = unit_size * sizeof(LPTSTR);\n\titem = (LPTSTR *)malloc((item_count + 1) * item_size);\n\tif (!item)\n\t{\n\t\taResultToken.MemoryError();\n\t\tgoto end;\n\t}\n\n\t// If sort_random is in effect, the above has created an array twice the normal size.\n\t// This allows the random numbers to be interleaved inside the array as though it\n\t// were an array consisting of sort_rand_type (which it actually is when viewed that way).\n\t// Because of this, the array should be accessed through pointer addition rather than\n\t// indexing via [].\n\n\t// Scan aContents and do the following:\n\t// 1) Replace each delimiter with a terminator so that the individual items can be seen\n\t// as real strings by the SortWithOptions() and when copying the sorted results back\n\t// into the result.\n\t// 2) Store a marker/pointer to each item (string) in aContents so that we know where\n\t// each item begins for sorting and recopying purposes.\n\tLPTSTR *item_curr = item; // i.e. Don't use [] indexing for the reason in the paragraph previous to above.\n\tfor (item_count = 0, cp = *item_curr = aContents; *cp; ++cp)\n\t{\n\t\tif (*cp == delimiter) // Each delimiter char becomes the terminator of the previous key phrase.\n\t\t{\n\t\t\t*cp = '\\0'; // Terminate the item that appears before this delimiter.\n\t\t\t++item_count;\n\t\t\tif (sort_random)\n\t\t\t{\n\t\t\t\tauto &n = *(unsigned int *)(item_curr + 1); // i.e. the randoms are in the odd fields, the pointers in the even.\n\t\t\t\tGenRandom(&n, sizeof(n));\n\t\t\t\tn >>= 1;\n\t\t\t\t// For the above:\n\t\t\t\t// The random numbers given to SortRandom() must be within INT_MAX of each other, otherwise\n\t\t\t\t// integer overflow would cause the difference between two items to flip signs depending\n\t\t\t\t// on how far apart the numbers are, which would mean for some cases where A < B and B < C,\n\t\t\t\t// it's possible that C > A. Without n >>= 1, the problem can be proven via the following\n\t\t\t\t// script, which shows a sharply biased distribution:\n\t\t\t\t//count := 0\n\t\t\t\t//Loop total := 10000\n\t\t\t\t//{\n\t\t\t\t//\tvar := Sort(\"1`n2`n3`n4`n5`n\", \"Random\")\n\t\t\t\t//\tif SubStr(var, 1, 1) = 5\n\t\t\t\t//\t\tcount += 1\n\t\t\t\t//}\n\t\t\t\t//MsgBox Round(count / total * 100, 2) \"%\"\n\t\t\t}\n\t\t\titem_curr += unit_size; // i.e. Don't use [] indexing for the reason described above.\n\t\t\t*item_curr = cp + 1; // Make a pointer to the next item's place in aContents.\n\t\t}\n\t}\n\t// The above reset the count to 0 and recounted it. So now re-add the last item to the count unless it was\n\t// disqualified earlier. Verified correct:\n\tif (!terminate_last_item_with_delimiter) // i.e. either trailing_delimiter_indicates_trailing_blank_item==true OR the final character isn't a delimiter. Either way the final item needs to be added.\n\t{\n\t\t++item_count;\n\t\tif (sort_random) // Provide a random number for the last item.\n\t\t{\n\t\t\tauto &n = *(unsigned int *)(item_curr + 1); // i.e. the randoms are in the odd fields, the pointers in the even.\n\t\t\tGenRandom(&n, sizeof(n));\n\t\t\tn >>= 1;\n\t\t}\n\t}\n\telse // Since the final item is not included in the count, point item_curr to the one before the last, for use below.\n\t\titem_curr -= unit_size;\n\n\t// Now aContents has been divided up based on delimiter. Sort the array of pointers\n\t// so that they indicate the correct ordering to copy aContents into output_var:\n\tif (g_SortFunc) // Takes precedence other sorting methods.\n\t{\n\t\tqsort((void *)item, item_count, item_size, SortUDF);\n\t\tif (!g_SortFuncResult || g_SortFuncResult == EARLY_EXIT)\n\t\t{\n\t\t\taResultToken.SetExitResult(g_SortFuncResult);\n\t\t\tgoto end;\n\t\t}\n\t}\n\telse if (sort_random) // Takes precedence over all remaining options.\n\t\tqsort((void *)item, item_count, item_size, SortRandom);\n\telse\n\t\tqsort((void *)item, item_count, item_size, sort_by_naked_filename ? SortByNakedFilename : SortWithOptions);\n\n\t// Allocate space to store the result.\n\tif (!TokenSetResult(aResultToken, NULL, aContents_length))\n\t\tgoto end;\n\taResultToken.symbol = SYM_STRING;\n\n\t// Set default in case original last item is still the last item, or if last item was omitted due to being a dupe:\n\tsize_t i, item_count_minus_1 = item_count - 1;\n\tDWORD omit_dupe_count = 0;\n\tbool keep_this_item;\n\tLPTSTR source, dest;\n\tLPTSTR item_prev = NULL;\n\n\t// Copy the sorted result back into output_var. Do all except the last item, since the last\n\t// item gets special treatment depending on the options that were specified.\n\titem_curr = item; // i.e. Don't use [] indexing for the reason described higher above (same applies to item += unit_size below).\n\tfor (dest = aResultToken.marker, i = 0; i < item_count; ++i, item_curr += unit_size)\n\t{\n\t\tkeep_this_item = true; // Set default.\n\t\tif (omit_dupes && item_prev)\n\t\t{\n\t\t\t// Update to the comment below: Exact dupes will still be removed when sort_by_naked_filename\n\t\t\t// or g_SortColumnOffset is in effect because duplicate lines would still be adjacent to\n\t\t\t// each other even in these modes. There doesn't appear to be any exceptions, even if\n\t\t\t// some items in the list are sorted as blanks due to being shorter than the specified \n\t\t\t// g_SortColumnOffset.\n\t\t\t// As documented, special dupe-checking modes are not offered when sort_by_naked_filename\n\t\t\t// is in effect, or g_SortColumnOffset is greater than 1. That's because the need for such\n\t\t\t// a thing seems too rare (and the result too strange) to justify the extra code size.\n\t\t\t// However, adjacent dupes are still removed when any of the above modes are in effect,\n\t\t\t// or when the \"random\" mode is in effect. This might have some usefulness; for example,\n\t\t\t// if a list of songs is sorted in random order, but it contains \"favorite\" songs listed twice,\n\t\t\t// the dupe-removal feature would remove duplicate songs if they happen to be sorted\n\t\t\t// to lie adjacent to each other, which would be useful to prevent the same song from\n\t\t\t// playing twice in a row.\n\t\t\tif (g_SortNumeric && !g_SortColumnOffset)\n\t\t\t\t// if g_SortColumnOffset is zero, fall back to the normal dupe checking in case its\n\t\t\t\t// ever useful to anyone. This is done because numbers in an offset column are not supported\n\t\t\t\t// since the extra code size doensn't seem justified given the rarity of the need.\n\t\t\t\tkeep_this_item = (ATOF(*item_curr) != ATOF(item_prev)); // ATOF() ignores any trailing \\r in CRLF mode, so no extra logic is needed for that.\n\t\t\telse if (g_SortCaseSensitive == SCS_INSENSITIVE_LOGICAL)\n\t\t\t\tkeep_this_item = StrCmpLogicalW(*item_curr, item_prev);\n\t\t\telse\n\t\t\t\tkeep_this_item = tcscmp2(*item_curr, item_prev, g_SortCaseSensitive); // v1.0.43.03: Added support for locale-insensitive mode.\n\t\t\t\t// Permutations of sorting case sensitive vs. eliminating duplicates based on case sensitivity:\n\t\t\t\t// 1) Sort is not case sens, but dupes are: Won't work because sort didn't necessarily put\n\t\t\t\t// same-case dupes adjacent to each other.\n\t\t\t\t// 2) Converse: probably not reliable because there could be unrelated items in between\n\t\t\t\t// two strings that are duplicates but weren't sorted adjacently due to their case.\n\t\t\t\t// 3) Both are case sensitive: seems okay\n\t\t\t\t// 4) Both are not case sensitive: seems okay\n\t\t\t\t//\n\t\t\t\t// In light of the above, using the g_SortCaseSensitive flag to control the behavior of\n\t\t\t\t// both sorting and dupe-removal seems best.\n\t\t}\n\t\tif (keep_this_item)\n\t\t{\n\t\t\tfor (source = *item_curr; *source;)\n\t\t\t\t*dest++ = *source++;\n\t\t\t// If we're at the last item and the original list's last item had a terminating delimiter\n\t\t\t// and the specified options said to treat it not as a delimiter but as a final char of sorts,\n\t\t\t// include it after the item that is now last so that the overall layout is the same:\n\t\t\tif (i < item_count_minus_1 || terminate_last_item_with_delimiter)\n\t\t\t\t*dest++ = delimiter; // Put each item's delimiter back in so that format is the same as the original.\n\t\t\titem_prev = *item_curr; // Since the item just processed above isn't a dupe, save this item to compare against the next item.\n\t\t}\n\t\telse // This item is a duplicate of the previous item.\n\t\t{\n\t\t\t++omit_dupe_count; // But don't change the value of item_prev.\n\t\t\t// v1.0.47.05: The following section fixes the fact that the \"unique\" option would sometimes leave\n\t\t\t// a trailing delimiter at the end of the sorted list. For example, sorting \"x|x\" in unique mode\n\t\t\t// would formerly produce \"x|\":\n\t\t\tif (i == item_count_minus_1 && !terminate_last_item_with_delimiter) // This is the last item and its being omitted, so remove the previous item's trailing delimiter (unless a trailing delimiter is mandatory).\n\t\t\t\t--dest; // Remove the previous item's trailing delimiter there's nothing for it to delimit due to omission of this duplicate.\n\t\t}\n\t} // for()\n\n\t// Terminate the variable's contents.\n\tif (trailing_crlf_added_temporarily) // Remove the CRLF only after its presence was used above to simplify the code by reducing the number of types/cases.\n\t{\n\t\tdest[-2] = '\\0';\n\t\taResultToken.marker_length -= 2;\n\t}\n\telse\n\t\t*dest = '\\0';\n\n\tif (omit_dupes)\n\t{\n\t\tif (omit_dupe_count) // Update the length to actual whenever at least one dupe was omitted.\n\t\t{\n\t\t\taResultToken.marker_length = _tcslen(aResultToken.marker);\n\t\t}\n\t}\n\t//else it is not necessary to set the length here because its length hasn't\n\t// changed since it was originally set by the above call TokenSetResult.\n\nend:\n\tfree(item);\n\tfree(mem_to_free);\n\tif (g_SortFunc)\n\t\tg_SortFunc->Release();\n\tg_SortFunc = sort_func_orig;\n\tg_SortFuncResult = sort_func_result_orig;\n}\n\n\n\nBIF_DECL(BIF_StrCompare)\n{\n\t// In script:\n\t// Result := StrCompare(str1, str2 [, CaseSensitive := false])\n\t// str1, str2, the strings to compare, can be be pure numbers, such numbers are converted to strings before the comparison.\n\t// CaseSensitive, the case sensitive setting to use.\n\t// Result, the result of the comparison:\n\t//\t< 0,\tif str1 is less than str2.\n\t//\t0,\t\tif str1 is identical to str2.\n\t//\t> 0,\tif str1 is greater than str2.\n\t// Param 1 and 2, str1 and str2\n\t_f_param_string(str1, 0);\n\t_f_param_string(str2, 1);\n\t// Could return 0 here if str1 == str2, but it is probably rare to call StrCompare(str_var, str_var)\n\t// so for most cases that would just be an unnecessary cost, albeit low.\n\t// Param 3 - CaseSensitive\n\tStringCaseSenseType string_case_sense = ParamIndexToCaseSense(2);\n\tint result;\n\tswitch (string_case_sense)\t\t// Compare the strings according to the string_case_sense setting.\n\t{\n\tcase SCS_SENSITIVE:\t\t\t\tresult = _tcscmp(str1, str2); break;\n\tcase SCS_INSENSITIVE:\t\t\tresult = _tcsicmp(str1, str2); break;\n\tcase SCS_INSENSITIVE_LOCALE:\tresult = lstrcmpi(str1, str2); break;\n\tcase SCS_INSENSITIVE_LOGICAL:\tresult = StrCmpLogicalW(str1, str2); break;\n\tcase SCS_INVALID:\n\t\t_f_throw_param(2);\n\t}\n\t_f_return_i(result);\t\t\t// Return \n}\n\n\n\nBIF_DECL(BIF_StrLen)\n{\n\t// Caller has ensured that there's exactly one actual parameter.\n\tsize_t length;\n\t_f_param_string(value, 0, &length);\n\t_f_return_i(length);\n}\n\n\n\nBIF_DECL(BIF_SubStr) // Added in v1.0.46.\n{\n\t// Set default return value in case of early return.\n\t_f_set_retval_p(_T(\"\"), 0);\n\n\t// Get the first arg, which is the string used as the source of the extraction. Call it \"haystack\" for clarity.\n\tINT_PTR haystack_length;\n\t_f_param_string(haystack, 0, (size_t *)&haystack_length);\n\n\t// Load-time validation has ensured that at least the first two parameters are present:\n\tThrow_if_Param_NaN(1);\n\tINT_PTR starting_offset = (INT_PTR)ParamIndexToInt64(1); // The one-based starting position in haystack (if any).\n\tif (starting_offset > haystack_length || starting_offset == 0)\n\t\t_f_return_retval; // Yield the empty string (a default set higher above).\n\tif (starting_offset < 0) // Same convention as RegExMatch/Replace(): Treat negative StartingPos as a position relative to the end of the string.\n\t{\n\t\tstarting_offset += haystack_length;\n\t\tif (starting_offset < 0)\n\t\t\tstarting_offset = 0;\n\t}\n\telse\n\t\t--starting_offset; // Convert to zero-based.\n\n\tINT_PTR remaining_length_available = haystack_length - starting_offset;\n\tINT_PTR extract_length;\n\tif (ParamIndexIsOmitted(2)) // No length specified, so extract all the remaining length.\n\t\textract_length = remaining_length_available;\n\telse\n\t{\n\t\tThrow_if_Param_NaN(2);\n\t\tif ( !(extract_length = (INT_PTR)ParamIndexToInt64(2)) ) // It has asked to extract zero characters.\n\t\t\t_f_return_retval; // Yield the empty string (a default set higher above).\n\t\tif (extract_length < 0)\n\t\t{\n\t\t\textract_length += remaining_length_available; // Result is the number of characters to be extracted (i.e. after omitting the number of chars specified in extract_length).\n\t\t\tif (extract_length < 1) // It has asked to omit all characters.\n\t\t\t\t_f_return_retval; // Yield the empty string (a default set higher above).\n\t\t}\n\t\telse // extract_length > 0\n\t\t\tif (extract_length > remaining_length_available)\n\t\t\t\textract_length = remaining_length_available;\n\t}\n\n\t// Above has set extract_length to the exact number of characters that will actually be extracted.\n\tLPTSTR result = haystack + starting_offset; // This is the result except for the possible need to truncate it below.\n\n\t// No need for any copying or termination, just send back part of haystack.\n\t// Caller and Var::Assign() know that overlap is possible, so this seems safe.\n\t_f_return_p(result, extract_length);\n}\n\n\n\nBIF_DECL(BIF_InStr)\n{\n\t// Caller has already ensured that at least two actual parameters are present.\n\tINT_PTR haystack_length;\n\t_f_param_string(haystack, 0, (size_t *)&haystack_length);\n\tsize_t needle_length;\n\t_f_param_string(needle, 1, &needle_length);\n\tif (!needle_length) // Although arguably legitimate, this is more likely an error, so throw.\n\t\t_f_throw_param(1);\n\n\tStringCaseSenseType string_case_sense = ParamIndexToCaseSense(2);\n\tif (string_case_sense == SCS_INVALID\n\t\t|| string_case_sense == SCS_INSENSITIVE_LOGICAL) // Not supported, seems more useful to throw rather than using SCS_INSENSITIVE.\n\t\t_f_throw_param(2);\n\t// BIF_StrReplace sets string_case_sense similarly, maintain together.\n\n\tINT_PTR offset = 1;\n\tif (!ParamIndexIsOmitted(3))\n\t{\n\t\tThrow_if_Param_NaN(3);\n\t\toffset = ParamIndexToIntPtr(3);\n\t\tif (!offset)\n\t\t\t_f_throw_param(3);\n\t}\n\t\n\tint occurrence_number = 1;\n\tif (!ParamIndexIsOmitted(4))\n\t{\n\t\tThrow_if_Param_NaN(4);\n\t\toccurrence_number = ParamIndexToInt(4);\n\t\tif (!occurrence_number)\n\t\t\t_f_throw_param(4);\n\t}\n\n\tif (offset < 0)\n\t{\n\t\tif (ParamIndexIsOmitted(4))\n\t\t\toccurrence_number = -1; // Default to RTL.\n\t\toffset += haystack_length + 1; // Convert end-relative position to start-relative.\n\t}\n\tif (occurrence_number > 0)\n\t\t--offset; // Convert 1-based to 0-based.\n\tif (offset < 0) // To the left of the first character.\n\t\toffset = 0; // LTR: start at offset 0. RTL: search 0 characters.\n\telse if (offset > haystack_length) // To the right of the last character.\n\t\toffset = haystack_length; // LTR: start at null-terminator (omit all). RTL: search whole string.\n\n\tLPTSTR found_pos;\n\tif (occurrence_number < 0) // Special mode to search from the right side (RTL).\n\t{\n\t\tif (!ParamIndexIsOmitted(3)) // For this mode, offset is only relevant if specified by the caller.\n\t\t\thaystack_length = offset; // i.e. omit any characters to the right of the starting position.\n\t\tfound_pos = tcsrstr(haystack, haystack_length, needle, string_case_sense, -occurrence_number);\n\t\t_f_return_i(found_pos ? (found_pos - haystack + 1) : 0); // +1 to convert to 1-based, since 0 indicates \"not found\".\n\t}\n\t// Since above didn't return:\n\tint i;\n\tfor (i = 1, found_pos = haystack + offset; ; ++i, found_pos += needle_length)\n\t\tif (!(found_pos = tcsstr2(found_pos, needle, string_case_sense)) || i == occurrence_number)\n\t\t\tbreak;\n\t_f_return_i(found_pos ? (found_pos - haystack + 1) : 0);\n}\n\n\n\nBIF_DECL(BIF_Ord)\n{\n\t// Result will always be an integer (this simplifies scripts that work with binary zeros since an\n\t// empty string yields zero).\n\t_f_param_string(cp, 0);\n#ifndef UNICODE\n\t// This section could convert a single- or multi-byte character to a Unicode code point\n\t// for consistency, but since the ANSI build won't be officially supported that doesn't\n\t// seem necessary.\n#else\n\tif (IS_SURROGATE_PAIR(cp[0], cp[1]))\n\t\t_f_return_i(((cp[0] - 0xd800) << 10) + (cp[1] - 0xdc00) + 0x10000);\n\telse\n#endif\n\t\t_f_return_i((TBYTE)*cp);\n}\n\n\n\nBIF_DECL(BIF_Chr)\n{\n\tThrow_if_Param_NaN(0);\n\tint param1 = ParamIndexToInt(0); // Convert to INT vs. UINT so that negatives can be detected.\n\tLPTSTR cp = _f_retval_buf; // If necessary, it will be moved to a persistent memory location by our caller.\n\tint len;\n\tif (param1 < 0 || param1 > UorA(0x10FFFF, UCHAR_MAX))\n\t\t_f_throw_param(0);\n#ifdef UNICODE\n\telse if (param1 >= 0x10000)\n\t{\n\t\tparam1 -= 0x10000;\n\t\tcp[0] = 0xd800 + ((param1 >> 10) & 0x3ff);\n\t\tcp[1] = 0xdc00 + ( param1 & 0x3ff);\n\t\tcp[2] = '\\0';\n\t\tlen = 2;\n\t}\n#else\n\t// See #ifndef in BIF_Ord for related comment.\n#endif\n\telse\n\t{\n\t\tcp[0] = param1;\n\t\tcp[1] = '\\0';\n\t\tlen = 1; // Even if param1 == 0.\n\t}\n\t_f_return_p(cp, len);\n}\n\n\n\nBIF_DECL(BIF_Format)\n{\n\tif (TokenIsPureNumeric(*aParam[0]))\n\t\t_f_return_p(ParamIndexToString(0, _f_retval_buf));\n\n\tif (ParamIndexToObject(0))\n\t\t_f_throw_param(0, _T(\"String\"));\n\n\tLPCTSTR fmt = ParamIndexToString(0), lit, cp, cp_end, cp_spec;\n\tLPTSTR target = NULL;\n\tint size = 0, spec_len;\n\tint param, last_param;\n\tTCHAR number_buf[MAX_NUMBER_SIZE];\n\tTCHAR spec[12+MAX_INTEGER_LENGTH*2];\n\tTCHAR custom_format;\n\tExprTokenType value;\n\t*spec = '%';\n\n\tfor (;;)\n\t{\n\t\tlast_param = 0;\n\n\t\tfor (lit = cp = fmt;; )\n\t\t{\n\t\t\t// Find next placeholder.\n\t\t\tfor (cp_end = cp; *cp_end && *cp_end != '{'; ++cp_end);\n\t\t\tif (cp_end > lit)\n\t\t\t{\n\t\t\t\t// Handle literal text to the left of the placeholder.\n\t\t\t\tif (target)\n\t\t\t\t\ttmemcpy(target, lit, cp_end - lit), target += cp_end - lit;\n\t\t\t\telse\n\t\t\t\t\tsize += int(cp_end - lit);\n\t\t\t\tlit = cp_end; // Mark this as the next literal character (to be overridden below if it's a valid placeholder).\n\t\t\t}\n\t\t\tcp = cp_end;\n\t\t\tif (!*cp)\n\t\t\t\tbreak;\n\t\t\t// else: Implies *cp == '{'.\n\t\t\t++cp;\n\t\t\tif ((*cp == '{' || *cp == '}') && cp[1] == '}') // {{} or {}}\n\t\t\t{\n\t\t\t\tif (target)\n\t\t\t\t\t*target++ = *cp;\n\t\t\t\telse\n\t\t\t\t\t++size;\n\t\t\t\tcp += 2;\n\t\t\t\tlit = cp; // Mark this as the next literal character.\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\t\n\t\t\t// Index.\n\t\t\tfor (cp_end = cp; *cp_end >= '0' && *cp_end <= '9'; ++cp_end);\n\t\t\tif (cp_end > cp)\n\t\t\t\tparam = ATOI(cp), cp = cp_end;\n\t\t\telse\n\t\t\t\tparam = last_param + 1;\n\t\t\tif (param >= aParamCount || param < 1) // Invalid parameter index.\n\t\t\t\tcontinue;\n\n\t\t\tcustom_format = 0; // Set default.\n\n\t\t\t// Optional format specifier.\n\t\t\tif (*cp == ':')\n\t\t\t{\n\t\t\t\tcp_spec = ++cp;\n\t\t\t\t// Skip valid format specifier options.\n\t\t\t\tfor (cp = cp_spec; *cp && _tcschr(_T(\"-+0 #\"), *cp); ++cp); // flags\n\t\t\t\tfor ( ; *cp >= '0' && *cp <= '9'; ++cp); // width\n\t\t\t\tif (*cp == '.') do ++cp; while (*cp >= '0' && *cp <= '9'); // .precision\n\t\t\t\tspec_len = int(cp - cp_spec);\n\t\t\t\t// For now, size specifiers (h | l | ll | w | I | I32 | I64) are not supported.\n\t\t\t\t\n\t\t\t\tif (spec_len + 4 >= _countof(spec)) // Format specifier too long (probably invalid).\n\t\t\t\t\tcontinue;\n\t\t\t\t// Copy options, if any (+1 to leave the leading %).\n\t\t\t\ttmemcpy(spec + 1, cp_spec, spec_len);\n\t\t\t\t++spec_len; // Include the leading %.\n\n\t\t\t\tif (_tcschr(_T(\"diouxX\"), *cp))\n\t\t\t\t{\n\t\t\t\t\tspec[spec_len++] = 'I';\n\t\t\t\t\tspec[spec_len++] = '6';\n\t\t\t\t\tspec[spec_len++] = '4';\n\t\t\t\t\t// Integer value; apply I64 prefix to avoid truncation.\n\t\t\t\t\tvalue.symbol = SYM_INTEGER;\n\t\t\t\t\tspec[spec_len++] = *cp++;\n\t\t\t\t}\n\t\t\t\telse if (_tcschr(_T(\"eEfgGaA\"), *cp))\n\t\t\t\t{\n\t\t\t\t\tvalue.symbol = SYM_FLOAT;\n\t\t\t\t\tspec[spec_len++] = *cp++;\n\t\t\t\t}\n\t\t\t\telse if (_tcschr(_T(\"cCp\"), *cp))\n\t\t\t\t{\n\t\t\t\t\t// Input is an integer or pointer, but I64 prefix should not be applied.\n\t\t\t\t\tvalue.symbol = SYM_INTEGER;\n\t\t\t\t\tspec[spec_len++] = *cp++;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tvalue.symbol = SYM_STRING;\n\t\t\t\t\tspec[spec_len++] = 's'; // Default to string if not specified.\n\t\t\t\t\tif (_tcschr(_T(\"ULlTt\"), *cp))\n\t\t\t\t\t\tcustom_format = toupper(*cp++);\n\t\t\t\t\tif (*cp == 's')\n\t\t\t\t\t\t++cp;\n\t\t\t\t}\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tvalue.symbol = SYM_STRING;\n\t\t\t\t// spec[0] contains '%'.\n\t\t\t\tspec[1] = 's';\n\t\t\t\tspec_len = 2;\n\t\t\t}\n\t\t\tif (value.symbol == SYM_STRING)\n\t\t\t{\n\t\t\t\tif (ParamIndexToObject(param))\n\t\t\t\t\t_f_throw_param(param, _T(\"String\"));\n\t\t\t\tvalue.marker = ParamIndexToString(param, number_buf);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tif (!ParamIndexIsNumeric(param))\n\t\t\t\t\t_f_throw_param(param, _T(\"Number\"));\n\t\t\t\tif (value.symbol == SYM_INTEGER)\n\t\t\t\t\tvalue.value_int64 = ParamIndexToInt64(param);\n\t\t\t\telse\n\t\t\t\t\tvalue.value_double = ParamIndexToDouble(param);\n\t\t\t}\n\t\t\tspec[spec_len] = '\\0';\n\t\t\t\n\t\t\tif (*cp != '}') // Syntax error.\n\t\t\t\tcontinue;\n\t\t\t++cp;\n\t\t\tlit = cp; // Mark this as the next literal character.\n\n\t\t\t// Now that validation is complete, set last_param for use by the next {} or {:fmt}.\n\t\t\tlast_param = param;\n\t\t\t\n\t\t\tif (target)\n\t\t\t{\n\t\t\t\tint len = _stprintf(target, spec, value.value_int64);\n\t\t\t\tswitch (custom_format)\n\t\t\t\t{\n\t\t\t\tcase 0: break; // Might help performance to list this first.\n\t\t\t\tcase 'U': CharUpper(target); break;\n\t\t\t\tcase 'L': CharLower(target); break;\n\t\t\t\tcase 'T': StrToTitleCase(target); break;\n\t\t\t\t}\n\t\t\t\ttarget += len;\n\t\t\t}\n\t\t\telse\n\t\t\t\tsize += _sctprintf(spec, value.value_int64);\n\t\t}\n\t\tif (target)\n\t\t{\n\t\t\t// Finished second pass.\n\t\t\t*target = '\\0';\n\t\t\treturn;\n\t\t}\n\t\t// Finished first pass (calculating required size).\n\t\tif (!TokenSetResult(aResultToken, NULL, size))\n\t\t\treturn;\n\t\taResultToken.symbol = SYM_STRING;\n\t\ttarget = aResultToken.marker;\n\t}\n}\n\n\n\nBIF_DECL(BIF_Trim) // L31\n{\n\tif (ParamIndexToObject(0))\n\t\t_f_throw_param(0, _T(\"String\"));\n\n\tBuiltInFunctionID trim_type = _f_callee_id;\n\n\tLPTSTR buf = _f_retval_buf;\n\tsize_t extract_length;\n\tLPTSTR str = ParamIndexToString(0, buf, &extract_length);\n\n\t_f_param_string_opt_def(omit_list, 1, _T(\" \\t\")); // Default: space and tab.\n\n\tLPTSTR result = str;\n\tif (trim_type != FID_RTrim) // i.e. it's Trim() or LTrim()\n\t{\n\t\tresult = omit_leading_any(result, omit_list, extract_length);\n\t\textract_length -= (result - str); // Adjust for omitted characters.\n\t}\n\tif (extract_length && trim_type != FID_LTrim) // i.e. it's Trim() or RTrim(); THE LINE BELOW REQUIRES extract_length >= 1.\n\t\textract_length = omit_trailing_any(result, omit_list, result + extract_length - 1);\n\n\t_f_return_p(result, extract_length);\n}\n\n\n\nBIF_DECL(BIF_VerCompare)\n{\n\t_f_param_string(a, 0);\n\t_f_param_string(b, 1);\n\t_f_return_i(VersionSatisfies(a, b, true));\n}\n"},"size":{"kind":"number","value":64415,"string":"64,415"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1417,"string":"1,417"},"avg_line_length":{"kind":"number","value":42.05081157374735,"string":"42.050812"},"max_line_length":{"kind":"number","value":312,"string":"312"},"alphanum_fraction":{"kind":"number","value":0.6962827350155217,"string":"0.696283"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}},{"rowIdx":11099,"cells":{"id":{"kind":"number","value":16094,"string":"16,094"},"file_name":{"kind":"string","value":"vars.cpp"},"file_path":{"kind":"string","value":"AutoHotkey_AutoHotkey/source/lib/vars.cpp"},"content":{"kind":"string","value":"/*\nAutoHotkey\n\nCopyright 2003-2009 Chris Mallett (support@autohotkey.com)\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n*/\n\n#include \"stdafx.h\"\n#include \"script.h\"\n#include \"globaldata.h\"\n#include \"script_func_impl.h\"\n\n\n\nstatic LPTSTR sCoordModes[] = COORD_MODES;\n\n\nFResult CoordMode(StrArg aCommand, optl<StrArg> aMode, StrRet *aRetVal = nullptr)\n{\n\tCoordModeType mode = aMode.has_value() ? Line::ConvertCoordMode(aMode.value()) : COORD_MODE_SCREEN;\n\tCoordModeType shift = Line::ConvertCoordModeCmd(aCommand);\n\tif (shift == COORD_MODE_INVALID)\n\t\treturn FR_E_ARG(0);\n\tif (mode == COORD_MODE_INVALID)\n\t\treturn FR_E_ARG(1);\n\tif (aRetVal)\n\t\taRetVal->SetStatic(sCoordModes[(g->CoordMode >> shift) & COORD_MODE_MASK]);\n\tg->CoordMode = (g->CoordMode & ~(COORD_MODE_MASK << shift)) | (mode << shift);\n\treturn OK;\n}\n\nbif_impl FResult CoordMode(StrArg aCommand, optl<StrArg> aMode, StrRet &aRetVal)\n{\n\treturn CoordMode(aCommand, aMode, &aRetVal);\n}\n\n\nbif_impl FResult SendMode(StrArg aMode, ResultToken &aResultToken)\n{\n\tauto new_mode = Line::ConvertSendMode(aMode, SM_INVALID);\n\tif (new_mode == SM_INVALID)\n\t\treturn FR_E_ARG(0);\n\tBIV_SendMode(aResultToken, nullptr);\n\tg->SendMode = new_mode;\n\treturn OK;\n}\n\n\nbif_impl FResult SendLevel(int aLevel, int &aRetVal)\n{\n\tif (!SendLevelIsValid(aLevel))\n\t\treturn FR_E_ARG(0);\n\taRetVal = g->SendLevel;\n\tg->SendLevel = aLevel;\n\treturn OK;\n}\n\n\nbif_impl FResult SetDefaultMouseSpeed(int aSpeed, int &aRetVal)\n{\n\tif (aSpeed < 0 || aSpeed > MAX_MOUSE_SPEED)\n\t\treturn FR_E_ARG(0);\n\taRetVal = g->DefaultMouseSpeed;\n\tg->DefaultMouseSpeed = (UCHAR)aSpeed;\n\treturn OK;\n}\n\n\nbif_impl FResult SetKeyDelay(optl<int> aDelay, optl<int> aDuration, optl<StrArg> aMode)\n{\n\tif (aDelay.has_value() && *aDelay < -1)\n\t\treturn FR_E_ARG(0);\n\tif (aDuration.has_value() && *aDuration < -1)\n\t\treturn FR_E_ARG(1);\n\tif (aMode.has_value() && !_tcsicmp(aMode.value(), _T(\"Play\")))\n\t{\n\t\tif (aDelay.has_value())\n\t\t\tg->KeyDelayPlay = *aDelay;\n\t\tif (aDuration.has_value())\n\t\t\tg->PressDurationPlay = *aDuration;\n\t}\n\telse\n\t{\n\t\tif (aMode.has_nonempty_value()) // Anything other than \"Play\" or \"\" is invalid.\n\t\t\treturn FR_E_ARG(2);\n\t\tif (aDelay.has_value())\n\t\t\tg->KeyDelay = *aDelay;\n\t\tif (aDuration.has_value())\n\t\t\tg->PressDuration = *aDuration;\n\t}\n\treturn OK;\n}\n\n\nbif_impl FResult SetMouseDelay(int aDelay, optl<StrArg> aMode, int &aRetVal)\n{\n\tif (aDelay < -1)\n\t\treturn FR_E_ARG(0);\n\tif (aMode.has_value() && !_tcsicmp(aMode.value(), _T(\"Play\")))\n\t\taRetVal = g->MouseDelayPlay, g->MouseDelayPlay = aDelay;\n\telse if (aMode.has_nonempty_value()) // Anything other than \"Play\" or \"\" is invalid.\n\t\treturn FR_E_ARG(1);\n\telse\n\t\taRetVal = g->MouseDelay, g->MouseDelay = aDelay;\n\treturn OK;\n}\n\n\nbif_impl FResult SetWinDelay(int aDelay, int &aRetVal)\n{\n\tif (aDelay < -1)\n\t\treturn FR_E_ARG(0);\n\taRetVal = g->WinDelay;\n\tg->WinDelay = aDelay;\n\treturn OK;\n}\n\n\nbif_impl FResult SetControlDelay(int aDelay, int &aRetVal)\n{\n\tif (aDelay < -1)\n\t\treturn FR_E_ARG(0);\n\taRetVal = g->ControlDelay;\n\tg->ControlDelay = aDelay;\n\treturn OK;\n}\n\n\n\nBIV_DECL_R(BIV_Clipboard)\n{\n\tauto length = g_clip.Get();\n\tif (length == CLIPBOARD_FAILURE)\n\t\t_f_return_FAIL;\n\tif (TokenSetResult(aResultToken, nullptr, length))\n\t{\n\t\taResultToken.marker_length = g_clip.Get(aResultToken.marker);\n\t\tif (aResultToken.marker_length == CLIPBOARD_FAILURE)\n\t\t\taResultToken.SetExitResult(FAIL);\n\t\taResultToken.symbol = SYM_STRING;\n\t}\n\tg_clip.Close();\n}\n\nBIV_DECL_W(BIV_Clipboard_Set)\n{\n\tif (auto *obj = BivRValueToObject())\n\t{\n\t\tif (ClipboardAll *cba = dynamic_cast<ClipboardAll *>(obj))\n\t\t{\n\t\t\tif (!Var::SetClipboardAll(cba->Data(), cba->Size()))\n\t\t\t\t_f_return_FAIL;\n\t\t\treturn;\n\t\t}\n\t\t_f_throw_type(_T(\"ClipboardAll\"), ExprTokenType(obj));\n\t}\n\tsize_t aLength;\n\tLPTSTR aBuf = BivRValueToString(&aLength);\n\tif (!g_clip.Set(aBuf, aLength))\n\t\t_f_return_FAIL;\n}\n\n\nBIV_DECL_R(BIV_MMM_DDD)\n{\n\tLPTSTR format_str;\n\tswitch(ctoupper(aVarName[2]))\n\t{\n\t// Use the case-sensitive formats required by GetDateFormat():\n\tcase 'M': format_str = (aVarName[5] ? _T(\"MMMM\") : _T(\"MMM\")); break;\n\tcase 'D': format_str = (aVarName[5] ? _T(\"dddd\") : _T(\"ddd\")); break;\n\t}\n\t// Confirmed: The below will automatically use the local time (not UTC) when 3rd param is NULL.\n\tint len = GetDateFormatEx(LOCALE_NAME_USER_DEFAULT, 0, nullptr, format_str, _f_retval_buf, _f_retval_buf_size, nullptr);\n\tif (len && !_f_retval_buf[len - 1])\n\t\t--len; // \"Returns the number of characters written\" apparently includes the terminator.\n\t_f_return_p(_f_retval_buf, len);\n}\n\nVarSizeType GetDateTimeBIV(LPTSTR aBuf, LPTSTR aVarName)\n{\n\tif (!aBuf)\n\t\treturn 6; // Since only an estimate is needed in this mode, return the maximum length of any item.\n\n\taVarName += 2; // Skip past the \"A_\".\n\n\t// The current time is refreshed only if it's been a certain number of milliseconds since\n\t// the last fetch of one of these built-in time variables. This keeps the variables in\n\t// sync with one another when they are used consecutively such as this example:\n\t// Var := A_Hour ':' A_Min ':' A_Sec\n\t// Using GetTickCount() because it's very low overhead compared to the other time functions:\n\tstatic DWORD sLastUpdate = 0; // Static should be thread + recursion safe in this case.\n\tstatic SYSTEMTIME sST = {0}; // Init to detect when it's empty.\n\tBOOL is_msec = !_tcsicmp(aVarName, _T(\"MSec\")); // Always refresh if it's milliseconds, for better accuracy.\n\tDWORD now_tick = GetTickCount();\n\tif (is_msec || now_tick - sLastUpdate > 50 || !sST.wYear) // See comments above.\n\t{\n\t\tGetLocalTime(&sST);\n\t\tsLastUpdate = now_tick;\n\t}\n\n\tif (is_msec)\n\t\treturn _stprintf(aBuf, _T(\"%03d\"), sST.wMilliseconds);\n\n\tTCHAR second_letter = ctoupper(aVarName[1]);\n\tswitch(ctoupper(aVarName[0]))\n\t{\n\tcase 'Y':\n\t\tswitch(second_letter)\n\t\t{\n\t\tcase 'D': // A_YDay\n\t\t\treturn _stprintf(aBuf, _T(\"%d\"), GetYDay(sST.wMonth, sST.wDay, IS_LEAP_YEAR(sST.wYear)));\n\t\tcase 'W': // A_YWeek\n\t\t\treturn GetISOWeekNumber(aBuf, sST.wYear\n\t\t\t\t, GetYDay(sST.wMonth, sST.wDay, IS_LEAP_YEAR(sST.wYear))\n\t\t\t\t, sST.wDayOfWeek);\n\t\tdefault: // A_Year/A_YYYY\n\t\t\treturn _stprintf(aBuf, _T(\"%d\"), sST.wYear);\n\t\t}\n\t\t// No break because all cases above return:\n\t\t//break;\n\tcase 'M':\n\t\tswitch(second_letter)\n\t\t{\n\t\tcase 'D': // A_MDay (synonymous with A_DD)\n\t\t\treturn _stprintf(aBuf, _T(\"%02d\"), sST.wDay);\n\t\tcase 'I': // A_Min\n\t\t\treturn _stprintf(aBuf, _T(\"%02d\"), sST.wMinute);\n\t\tdefault: // A_MM and A_Mon (A_MSec was already completely handled higher above).\n\t\t\treturn _stprintf(aBuf, _T(\"%02d\"), sST.wMonth);\n\t\t}\n\t\t// No break because all cases above return:\n\t\t//break;\n\tcase 'D': // A_DD (synonymous with A_MDay)\n\t\treturn _stprintf(aBuf, _T(\"%02d\"), sST.wDay);\n\tcase 'W': // A_WDay\n\t\treturn _stprintf(aBuf, _T(\"%d\"), sST.wDayOfWeek + 1);\n\tcase 'H': // A_Hour\n\t\treturn _stprintf(aBuf, _T(\"%02d\"), sST.wHour);\n\tcase 'S': // A_Sec (A_MSec was already completely handled higher above).\n\t\treturn _stprintf(aBuf, _T(\"%02d\"), sST.wSecond);\n\t}\n\treturn 0; // Never reached, but avoids compiler warning.\n}\n\nBIV_DECL_R(BIV_DateTime)\n{\n\tGetDateTimeBIV(_f_retval_buf, aVarName);\n\t_f_return_p(_f_retval_buf);\n}\n\nBIV_DECL_R(BIV_ListLines)\n{\n\t_f_return_b(g->ListLinesIsEnabled);\n}\n\nBIV_DECL_W(BIV_ListLines_Set)\n{\n\tg->ListLinesIsEnabled = BivRValueToBOOL();\n}\n\nBIV_DECL_R(BIV_TitleMatchMode)\n{\n\tif (g->TitleMatchMode == FIND_REGEX) // v1.0.45.\n\t\t// For backward compatibility (due to possible use of case-sensitive comparison), never change the case used here:\n\t\t_f_return_p(_T(\"RegEx\"));\n\t// Otherwise, it's a numerical mode:\n\t_f_return_i(g->TitleMatchMode);\n}\n\nbif_impl FResult SetTitleMatchMode(StrArg aMode, ResultToken &aResultToken)\n{\n\taResultToken.symbol = SYM_INTEGER; // Set the default expected by BIV.\n\tauto mode = Line::ConvertTitleMatchMode(aMode);\n\tswitch (mode)\n\t{\n\tcase FIND_FAST:\n\tcase FIND_SLOW:\n\t\tBIV_TitleMatchModeSpeed(aResultToken, nullptr);\n\t\tg->TitleFindFast = (mode == FIND_FAST);\n\t\treturn OK;\n\tcase MATCHMODE_INVALID:\n\t\treturn FR_E_ARG(0);\n\tdefault:\n\t\tBIV_TitleMatchMode(aResultToken, nullptr);\n\t\tg->TitleMatchMode = mode;\n\t\treturn OK;\n\t}\n}\n\nBIV_DECL_W(BIV_TitleMatchMode_Set)\n{\n\tauto value = BivRValueToString();\n\tif (SetTitleMatchMode(value, aResultToken) != OK)\n\t\t_f_throw_value(ERR_INVALID_VALUE, value);\n}\n\nBIV_DECL_R(BIV_TitleMatchModeSpeed)\n{\n\t// For backward compatibility (due to possible use of case-sensitive comparison), never change the case used here:\n\t_f_return_p(g->TitleFindFast ? _T(\"Fast\") : _T(\"Slow\"));\n}\n\nBIV_DECL_R(BIV_DetectHiddenWindows)\n{\n\t_f_return_b(g->DetectHiddenWindows);\n}\n\nBIV_DECL_W(BIV_DetectHiddenWindows_Set)\n{\n\tg->DetectHiddenWindows = BivRValueToBOOL();\n}\n\nbif_impl void DetectHiddenWindows(BOOL aMode, BOOL &aRetVal)\n{\n\taRetVal = g->DetectHiddenWindows;\n\tg->DetectHiddenWindows = aMode;\n}\n\nBIV_DECL_R(BIV_DetectHiddenText)\n{\n\t_f_return_b(g->DetectHiddenText);\n}\n\nBIV_DECL_W(BIV_DetectHiddenText_Set)\n{\n\tg->DetectHiddenText = BivRValueToBOOL();\n}\n\nbif_impl void DetectHiddenText(BOOL aMode, BOOL &aRetVal)\n{\n\taRetVal = g->DetectHiddenText;\n\tg->DetectHiddenText = aMode;\n}\n\nint& BIV_xDelay(LPTSTR aVarName)\n{\n\tglobal_struct &g = *::g; // Reduces code size.\n\tswitch (ctoupper(aVarName[2])) // a_X...\n\t{\n\tcase 'K':\n\t\tif (ctolower(aVarName[6]) == 'e') // a_keydE...\n\t\t{\n\t\t\tif (aVarName[10]) // a_keydelayP...\n\t\t\t\treturn g.KeyDelayPlay;\n\t\t\telse\n\t\t\t\treturn g.KeyDelay;\n\t\t}\n\t\telse // a_keydU...\n\t\t{\n\t\t\tif (aVarName[13]) // a_keydurationP...\n\t\t\t\treturn g.PressDurationPlay;\n\t\t\telse\n\t\t\t\treturn g.PressDuration;\n\t\t}\n\tcase 'M':\n\t\tif (aVarName[12]) // a_mousedelayP...\n\t\t\treturn g.MouseDelayPlay;\n\t\telse\n\t\t\treturn g.MouseDelay;\n\tcase 'W':\n\t\treturn g.WinDelay;\n\t//case 'C':\n\tdefault:\n\t\treturn g.ControlDelay;\n\t}\n}\n\nBIV_DECL_R(BIV_xDelay)\n{\n\t_f_return_i(BIV_xDelay(aVarName));\n}\n\nBIV_DECL_W(BIV_xDelay_Set)\n{\n\tBIV_xDelay(aVarName) = (int)BivRValueToInt64();\n}\n\nBIV_DECL_R(BIV_DefaultMouseSpeed)\n{\n\t_f_return_i(g->DefaultMouseSpeed);\n}\n\nBIV_DECL_W(BIV_DefaultMouseSpeed_Set)\n{\n\tg->DefaultMouseSpeed = (int)BivRValueToInt64();\n}\n\nBIV_DECL_R(BIV_CoordMode)\n{\n\t_f_return_p(sCoordModes[(g->CoordMode >> Line::ConvertCoordModeCmd(aVarName + 11)) & COORD_MODE_MASK]);\n}\n\nBIV_DECL_W(BIV_CoordMode_Set)\n{\n\tauto value = BivRValueToString();\n\tif (FAILED(CoordMode(aVarName + 11, value))) // A_CoordMode is 11 chars.\n\t\t_f_throw_value(ERR_INVALID_VALUE, value);\n}\n\nBIV_DECL_R(BIV_SendMode)\n{\n\tstatic LPTSTR sSendModes[] = SEND_MODES;\n\t_f_return_p(sSendModes[g->SendMode]);\n}\n\nBIV_DECL_W(BIV_SendMode_Set)\n{\n\tauto value = BivRValueToString();\n\tif (FAILED(SendMode(value, aResultToken)))\n\t\t_f_throw_value(ERR_INVALID_VALUE, value);\n}\n\nBIV_DECL_R(BIV_SendLevel)\n{\n\t_f_return_i(g->SendLevel);\n}\n\nBIV_DECL_W(BIV_SendLevel_Set)\n{\n\tThrow_if_RValue_NaN();\n\tint unused;\n\tif (FAILED(SendLevel((int)BivRValueToInt64(), unused)))\n\t\t_f_throw_value(ERR_INVALID_VALUE, BivRValueToString());\n}\n\nBIV_DECL_R(BIV_StoreCapsLockMode)\n{\n\t_f_return_b(g->StoreCapslockMode);\n}\n\nBIV_DECL_W(BIV_StoreCapsLockMode_Set)\n{\n\tg->StoreCapslockMode = BivRValueToBOOL();\n}\n\nbif_impl void SetStoreCapsLockMode(BOOL aMode, BOOL &aRetVal)\n{\n\taRetVal = g->StoreCapslockMode;\n\tg->StoreCapslockMode = aMode;\n}\n\nBIV_DECL_R(BIV_KeybdHookInstalled)\n{\n\t_f_return_i((g_KeybdHook ? 1 : 0) | (SystemHasAnotherKeybdHook() ? 2 : 0));\n}\n\nBIV_DECL_R(BIV_MouseHookInstalled)\n{\n\t_f_return_i((g_MouseHook ? 1 : 0) | (SystemHasAnotherMouseHook() ? 2 : 0));\n}\n\nBIV_DECL_R(BIV_Hotkey)\n{\n\tif (aVarName[2] == 'M') // A_MaxHotkeysPerInterval\n\t\t_f_return_i(g_MaxHotkeysPerInterval);\n\tif (aVarName[8] == 'I') // A_HotkeyInterval\n\t\t_f_return_i(g_HotkeyThrottleInterval);\n\t// A_HotkeyModifierTimeout\n\t_f_return_i(g_HotkeyModifierTimeout);\n}\n\nBIV_DECL_W(BIV_Hotkey_Set)\n{\n\tThrow_if_RValue_NaN();\n\tint value = (int)BivRValueToInt64();\n\tif (aVarName[2] == 'M') // A_MaxHotkeysPerInterval\n\t{\n\t\tif (value < 1)\n\t\t\t_f_throw_value(ERR_INVALID_VALUE);\n\t\tg_MaxHotkeysPerInterval = value;\n\t}\n\telse if (aVarName[8] == 'I') // A_HotkeyInterval\n\t{\n\t\tif (value < 0)\n\t\t\t_f_throw_value(ERR_INVALID_VALUE);\n\t\tg_HotkeyThrottleInterval = value;\n\t}\n\telse // A_HotkeyModifierTimeout\n\t\tg_HotkeyModifierTimeout = value;\n}\n\nBIV_DECL_R(BIV_MenuMaskKey)\n{\n\tif (!g_MenuMaskKeyVK && !g_MenuMaskKeySC)\n\t\t_f_return_empty; // Return a \"false\" value to indicate there is no masking.\n\t// For uniformity, simplicity and to avoid any loss of information, always return vkNNscNNN.\n\tauto len = sntprintf(_f_retval_buf, _f_retval_buf_size, _T(\"vk%02Xsc%03X\"), g_MenuMaskKeyVK, g_MenuMaskKeySC);\n\t_f_return_p(_f_retval_buf, len);\n}\n\nBIV_DECL_W(BIV_MenuMaskKey_Set)\n{\n\tauto keyname = BivRValueToString();\n\tif (!*keyname) // Allow \"\" to mean \"no masking\".\n\t{\n\t\tg_MenuMaskKeyVK = 0;\n\t\tg_MenuMaskKeySC = 0;\n\t\treturn;\n\t}\n\tvk_type vk;\n\tsc_type sc;\n\t// Testing shows that sending an event with zero VK but non-zero SC fails to suppress\n\t// the Start menu (although it does suppress the window menu). However, allowing all\n\t// valid key strings seems more correct than requiring g_MenuMaskKeyVK != 0, and adds\n\t// flexibility at very little cost. Note that this use of TextToVKandSC()'s return\n\t// value (vs. checking VK|SC) allows vk00sc000 to turn off masking altogether.\n\tif (!TextToVKandSC(keyname, vk, sc))\n\t\t_f_throw_value(ERR_INVALID_VALUE);\n\tg_MenuMaskKeyVK = vk;\n\tg_MenuMaskKeySC = sc;\n}\n\nBIV_DECL_R(BIV_IsPaused) // v1.0.48: Lexikos: Added BIV_IsPaused and BIV_IsCritical.\n{\n\t// Although A_IsPaused could indicate how many threads are paused beneath the current thread,\n\t// that would be a problem because it would yield a non-zero value even when the underlying thread\n\t// isn't paused (i.e. other threads below it are paused), which would defeat the original purpose.\n\t// In addition, A_IsPaused probably won't be commonly used, so it seems best to keep it simple.\n\t// NAMING: A_IsPaused seems to be a better name than A_Pause or A_Paused due to:\n\t// Better readability.\n\t// Consistent with A_IsSuspended, which is strongly related to pause/unpause.\n\t// The fact that it wouldn't be likely for a function to turn off pause then turn it back on\n\t// (or vice versa), which was the main reason for storing \"Off\" and \"On\" in things like\n\t// A_DetectHiddenWindows.\n\t// Checking g>g_array avoids any chance of underflow, which might otherwise happen if this is\n\t// called by the AutoExec section or a threadless callback running in thread #0.\n\t_f_return_b(g > g_array && g[-1].IsPaused);\n}\n\nBIV_DECL_R(BIV_IsCritical) // v1.0.48: Lexikos: Added BIV_IsPaused and BIV_IsCritical.\n{\n\t// It seems more useful to return g->PeekFrequency than \"On\" or \"Off\" (Critical() ensures that\n\t// g->PeekFrequency!=0 whenever g->ThreadIsCritical==true). Also, the word \"Is\" in \"A_IsCritical\"\n\t// implies a value that can be used as a boolean such as \"if A_IsCritical\".\n\tif (g->ThreadIsCritical)\n\t\t_f_return_i(g->PeekFrequency); // Critical() ensures that g->PeekFrequency > 0 when critical is on.\n\t// Otherwise:\n\t_f_return_i(0);\n}\n\nBIV_DECL_R(BIV_IsSuspended)\n{\n\t_f_return_b(g_IsSuspended);\n}\n\n\n\nBIV_DECL_R(BIV_IsCompiled)\n{\n#ifdef AUTOHOTKEYSC\n\t_f_return_b(true);\n#else\n\t_f_return_b(g_script.mKind == Script::ScriptKindResource);\n#endif\n}\n\n\n\nBIV_DECL_R(BIV_FileEncoding)\n{\n\t// A similar section may be found under \"case Encoding:\" in FileObject::Invoke. Maintain that with this:\n\tLPTSTR enc;\n\tswitch (g->Encoding)\n\t{\n\t// Returning readable strings for these seems more useful than returning their numeric values, especially with CP_AHKNOBOM:\n\tcase CP_UTF8: enc = _T(\"UTF-8\"); break;\n\tcase CP_UTF8 | CP_AHKNOBOM: enc = _T(\"UTF-8-RAW\"); break;\n\tcase CP_UTF16: enc = _T(\"UTF-16\"); break;\n\tcase CP_UTF16 | CP_AHKNOBOM: enc = _T(\"UTF-16-RAW\"); break;\n\tdefault:\n\t {\n\t\tenc = _f_retval_buf;\n\t\tenc[0] = _T('C');\n\t\tenc[1] = _T('P');\n\t\t_itot(g->Encoding, enc + 2, 10);\n\t }\n\t}\n\t_f_return_p(enc);\n}\n\nbif_impl FResult FileEncoding(StrArg aEncoding, ResultToken &aResultToken)\n{\n\tUINT new_encoding = Line::ConvertFileEncoding(aEncoding);\n\tif (new_encoding == -1)\n\t\treturn FR_E_ARG(0);\n\tBIV_FileEncoding(aResultToken, nullptr);\n\tg->Encoding = new_encoding;\n\treturn OK;\n}\n\nBIV_DECL_W(BIV_FileEncoding_Set)\n{\n\tauto value = BivRValueToString();\n\tif (FileEncoding(value, aResultToken) != OK)\n\t\t_f_throw_value(ERR_INVALID_VALUE, value);\n}\n\n\n\nBIV_DECL_R(BIV_RegView)\n{\n\tLPTSTR value;\n\tswitch (g->RegView)\n\t{\n\tcase KEY_WOW64_32KEY: value = _T(\"32\"); break;\n\tcase KEY_WOW64_64KEY: value = _T(\"64\"); break;\n\tdefault: value = _T(\"Default\"); break;\n\t}\n\t_f_return_p(value);\n}\n\nbif_impl FResult SetRegView(StrArg aRegView, ResultToken &aResultToken)\n{\n\tDWORD reg_view = Line::RegConvertView(aRegView);\n\t// Validate the parameter even if it's not going to be used.\n\tif (reg_view == -1)\n\t\treturn FR_E_ARG(0);\n\tBIV_RegView(aResultToken, nullptr);\n\t// Since these flags cause the registry functions to fail on Win2k and have no effect on\n\t// any later 32-bit OS, ignore this command when the OS is 32-bit. Leave A_RegView = \"Default\".\n\tif (IsOS64Bit())\n\t\tg->RegView = reg_view;\n\treturn OK;\n}\n\nBIV_DECL_W(BIV_RegView_Set)\n{\n\tauto value = BivRValueToString();\n\tif (SetRegView(value, aResultToken) != OK)\n\t\t_f_throw_value(ERR_INVALID_VALUE, value);\n}\n\n\n\nBIV_DECL_R(BIV_LastError)\n{\n\t_f_return_i(g->LastError);\n}\n\nBIV_DECL_W(BIV_LastError_Set)\n{\n\tSetLastError(g->LastError = (DWORD)BivRValueToInt64());\n}\n\n\n\nBIV_DECL_R(BIV_PtrSize)\n{\n\t_f_return_i(sizeof(void *));\n}\n\n\n\nBIV_DECL_R(BIV_ScreenDPI)\n{\n\t_f_return_i(g_ScreenDPI);\n}\n\n\n\nBIV_DECL_R(BIV_TrayMenu)\n{\n\tif (!g_script.mTrayMenu)\n\t\t_f_return_unset;\n\tg_script.mTrayMenu->AddRef();\n\t_f_return(g_script.mTrayMenu);\n}\n\n\n\nBIV_DECL_R(BIV_AllowMainWindow)\n{\n\t_f_return_b(g_AllowMainWindow);\n}\n\nBIV_DECL_W(BIV_AllowMainWindow_Set)\n{\n\tg_script.AllowMainWindow(BivRValueToBOOL());\n}\n\n\n\nBIV_DECL_R(BIV_IconHidden)\n{\n\t_f_return_b(g_NoTrayIcon);\n}\n\nBIV_DECL_W(BIV_IconHidden_Set)\n{\n\tg_script.ShowTrayIcon(!BivRValueToBOOL());\n}\n\nvoid Script::ShowTrayIcon(bool aShow)\n{\n\tif (g_NoTrayIcon = !aShow) // Assign.\n\t{\n\t\tif (mNIC.hWnd) // Since it exists, destroy it.\n\t\t{\n\t\t\tShell_NotifyIcon(NIM_DELETE, &mNIC); // Remove it.\n\t\t\tmNIC.hWnd = NULL; // Set this as an indicator that tray icon is not installed.\n\t\t\t// but don't do DestroyMenu() on mTrayMenu->mMenu (if non-NULL) since it may have been\n\t\t\t// changed by the user to have the custom items on top of the standard items,\n\t\t\t// for example, and we don't want to lose that ordering in case the script turns\n\t\t\t// the icon back on at some future time during this session. Also, the script\n\t\t\t// may provide some other means of displaying the tray menu.\n\t\t}\n\t}\n\telse\n\t{\n\t\tif (!mNIC.hWnd) // The icon doesn't exist, so create it.\n\t\t{\n\t\t\tCreateTrayIcon();\n\t\t\tUpdateTrayIcon(true); // Force the icon into the correct pause/suspend state.\n\t\t}\n\t}\n}\n\nBIV_DECL_R(BIV_IconTip)\n{\n\t// Return the custom tip if any, otherwise the default tip.\n\t_f_return_p(g_script.mTrayIconTip ? g_script.mTrayIconTip : g_script.mFileName);\n}\n\nBIV_DECL_W(BIV_IconTip_Set)\n{\n\tg_script.SetTrayTip(BivRValueToString());\n}\n\nvoid Script::SetTrayTip(LPTSTR aText)\n{\n\t// Allocate mTrayIconTip on first use even if aText is empty, so that\n\t// it will override the use of mFileName as the tray tip text.\n\t// This allows the script to completely disable the tray tooltip.\n\tif (!mTrayIconTip)\n\t\tmTrayIconTip = SimpleHeap::Alloc<TCHAR>(_countof(mNIC.szTip)); // SimpleHeap improves avg. case mem load.\n\tif (mTrayIconTip)\n\t\ttcslcpy(mTrayIconTip, aText, _countof(mNIC.szTip));\n\tif (mNIC.hWnd) // i.e. only update the tip if the tray icon exists (can't work otherwise).\n\t{\n\t\tUPDATE_TIP_FIELD\n\t\tShell_NotifyIcon(NIM_MODIFY, &mNIC); // Currently not checking its result (e.g. in case a shell other than Explorer is running).\n\t}\n}\n\nBIV_DECL_R(BIV_IconFile)\n{\n\t_f_return_p(g_script.mCustomIconFile ? g_script.mCustomIconFile : _T(\"\"));\n}\n\nBIV_DECL_R(BIV_IconNumber)\n{\n\t_f_return_i(g_script.mCustomIconNumber);\n}\n\n\n\nBIV_DECL_R(BIV_PriorKey)\n{\n\tint validEventCount = 0;\n\t// Start at the current event (offset 1)\n\tfor (int iOffset = 1; iOffset <= g_MaxHistoryKeys; ++iOffset)\n\t{\n\t\t// Get index for circular buffer\n\t\tint i = (g_KeyHistoryNext + g_MaxHistoryKeys - iOffset) % g_MaxHistoryKeys;\n\t\t// Keep looking until we hit the second valid event\n\t\tif (g_KeyHistory[i].event_type != _T('i') // Not an ignored event.\n\t\t\t&& g_KeyHistory[i].event_type != _T('U') // Not a Unicode packet (SendInput/VK_PACKET).\n\t\t\t&& ++validEventCount > 1)\n\t\t{\n\t\t\t// Find the next most recent key-down\n\t\t\tif (!g_KeyHistory[i].key_up)\n\t\t\t{\n\t\t\t\tGetKeyName(g_KeyHistory[i].vk, g_KeyHistory[i].sc, _f_retval_buf, _f_retval_buf_size);\n\t\t\t\t_f_return_p(_f_retval_buf);\n\t\t\t}\n\t\t}\n\t}\n\t_f_return_empty;\n}\n\n\n\nLPTSTR GetExitReasonString(ExitReasons aExitReason)\n{\n\tLPTSTR str;\n\tswitch(aExitReason)\n\t{\n\tcase EXIT_LOGOFF: str = _T(\"Logoff\"); break;\n\tcase EXIT_SHUTDOWN: str = _T(\"Shutdown\"); break;\n\t// Since the below are all relatively rare, except WM_CLOSE perhaps, they are all included\n\t// as one word to cut down on the number of possible words (it's easier to write OnExit\n\t// functions to cover all possibilities if there are fewer of them).\n\tcase EXIT_CRITICAL:\n\tcase EXIT_DESTROY:\n\tcase EXIT_CLOSE: str = _T(\"Close\"); break;\n\tcase EXIT_ERROR: str = _T(\"Error\"); break;\n\tcase EXIT_MENU: str = _T(\"Menu\"); break; // Standard menu, not a user-defined menu.\n\tcase EXIT_EXIT: str = _T(\"Exit\"); break; // ExitApp or Exit command.\n\tcase EXIT_RELOAD: str = _T(\"Reload\"); break;\n\tcase EXIT_SINGLEINSTANCE: str = _T(\"Single\"); break;\n\tdefault: // EXIT_NONE or unknown value (unknown would be considered a bug if it ever happened).\n\t\tstr = _T(\"\");\n\t}\n\treturn str;\n}\n\n\n\nBIV_DECL_R(BIV_Space_Tab)\n{\n\t_f_return_p(aVarName[5] ? _T(\" \") : _T(\"\\t\"));\n}\n\nBIV_DECL_R(BIV_AhkVersion)\n{\n\t_f_return_p(T_AHK_VERSION);\n}\n\nBIV_DECL_R(BIV_AhkPath)\n{\n#ifdef AUTOHOTKEYSC\n\tTCHAR buf[MAX_PATH];\n\tsize_t length;\n\tif (length = GetAHKInstallDir(buf))\n\t\t// Name \"AutoHotkey.exe\" is assumed for code size reduction and because it's not stored in the registry:\n\t\ttcslcpy(buf + length, _T(\"\\\\AutoHotkey.exe\"), MAX_PATH - length); // tcslcpy() in case registry has a path that is too close to MAX_PATH to fit AutoHotkey.exe\n\t//else leave it blank as documented.\n\t_f_return(buf, length);\n#else\n\t_f_return_p(g_script.mOurEXE);\n#endif\n}\n\n\n\nBIV_DECL_R(BIV_TickCount)\n{\n\t_f_return(GetTickCount64());\n}\n\n\n\nBIV_DECL_R(BIV_Now)\n{\n\tSYSTEMTIME st;\n\tif (aVarName[5]) // A_Now[U]TC\n\t\tGetSystemTime(&st);\n\telse\n\t\tGetLocalTime(&st);\n\tSystemTimeToYYYYMMDD(_f_retval_buf, st);\n\t_f_return_p(_f_retval_buf);\n}\n\nBIV_DECL_R(BIV_OSVersion)\n{\n\t_f_return_p(const_cast<LPTSTR>(g_os.Version()));\n}\n\nBIV_DECL_R(BIV_Is64bitOS)\n{\n\t_f_return_b(IsOS64Bit());\n}\n\nBIV_DECL_R(BIV_Language)\n{\n\tLPTSTR aBuf = _f_retval_buf;\n\t_stprintf(aBuf, _T(\"%04hX\"), GetSystemDefaultUILanguage());\n\t_f_return_p(aBuf);\n}\n\nBIV_DECL_R(BIV_UserName_ComputerName)\n{\n\tTCHAR buf[MAX_PATH]; // Doesn't use MAX_COMPUTERNAME_LENGTH + 1 in case longer names are allowed in the future.\n\tDWORD buf_size = MAX_PATH; // Below: A_Computer[N]ame (N is the 11th char, index 10, which if present at all distinguishes between the two).\n\tif ( !(aVarName[10] ? GetComputerName(buf, &buf_size) : GetUserName(buf, &buf_size)) )\n\t\t*buf = '\\0';\n\t_f_return(buf);\n}\n\nBIV_DECL_R(BIV_WorkingDir)\n{\n\t// Use GetCurrentDirectory() vs. g_WorkingDir because any in-progress FileSelect()\n\t// dialog is able to keep functioning even when it's quasi-thread is suspended. The\n\t// dialog can thus change the current directory as seen by the active quasi-thread even\n\t// though g_WorkingDir hasn't been updated. It might also be possible for the working\n\t// directory to change in unusual circumstances such as a network drive being lost).\n\t// Update: FileSelectFile changing the current directory might be OS-specific;\n\t// I could not reproduce it on Windows 10.\n\tTCHAR buf[T_MAX_PATH]; // T_MAX_PATH vs. MAX_PATH only has an effect with Windows 10 long path awareness.\n\tDWORD length = GetCurrentDirectory(_countof(buf), buf);\n\t_f_return(buf, length);\n}\n\nBIV_DECL_W(BIV_WorkingDir_Set)\n{\n\tif (SetWorkingDir(BivRValueToString()) != OK)\n\t\t_f_throw_win32();\n}\n\nBIV_DECL_R(BIV_InitialWorkingDir)\n{\n\t_f_return_p(g_WorkingDirOrig);\n}\n\nBIV_DECL_R(BIV_WinDir)\n{\n\tTCHAR buf[MAX_PATH]; // MSDN (2018): The uSize parameter \"should be set to MAX_PATH.\"\n\tVarSizeType length = GetSystemWindowsDirectory(buf, _countof(buf));\n\t_f_return(buf, length);\n}\n\nBIV_DECL_R(BIV_Temp)\n{\n\tTCHAR buf[MAX_PATH+1]; // MSDN (2018): \"The maximum possible return value is MAX_PATH+1 (261).\"\n\tVarSizeType length = GetTempPath(_countof(buf), buf);\n\tif (length)\n\t\tif (buf[length - 1] == '\\\\') // Should always be true. MSDN: \"The returned string ends with a backslash\"\n\t\t\tbuf[--length] = '\\0'; // Omit the trailing backslash to improve friendliness/consistency.\n\t_f_return(buf, length);\n}\n\nBIV_DECL_R(BIV_ComSpec)\n{\n\tTCHAR buf_temp[1]; // Just a fake buffer to pass to some API functions in lieu of a NULL, to avoid any chance of misbehavior. Keep the size at 1 so that API functions will always fail to copy to buf.\n\tauto size_required = GetEnvironmentVariable(_T(\"ComSpec\"), buf_temp, 0);\n\tif (!TokenSetResult(aResultToken, nullptr, size_required)) // Avoids subtracting 1 to be conservative and to reduce code size (due to the need to otherwise check for zero and avoid subtracting 1 in that case).\n\t\treturn;\n\taResultToken.symbol = SYM_STRING;\n\taResultToken.marker_length = GetEnvVarReliable(_T(\"ComSpec\"), aResultToken.marker);\n}\n\nBIV_DECL_R(BIV_SpecialFolderPath)\n{\n\tTCHAR buf[MAX_PATH]; // One caller relies on this being explicitly limited to MAX_PATH.\n\t// SHGetFolderPath requires a buffer size of MAX_PATH, but the function was superseded\n\t// by SHGetKnownFolderPath in Windows Vista, and that function returns COM-allocated\n\t// memory of unknown length. However, it seems the shell still does not support long\n\t// paths as of 2018.\n\tint aFolder;\n\tswitch (ctoupper(aVarName[2]))\n\t{\n\tcase 'P': // A_[P]rogram...\n\t\tif (ctoupper(aVarName[9]) == 'S') // A_Programs(Common)\n\t\t\taFolder = aVarName[10] ? CSIDL_COMMON_PROGRAMS : CSIDL_PROGRAMS;\n\t\telse // A_Program[F]iles\n\t\t\taFolder = CSIDL_PROGRAM_FILES;\n\t\tbreak;\n\tcase 'A': // A_AppData(Common)\n\t\taFolder = aVarName[9] ? CSIDL_COMMON_APPDATA : CSIDL_APPDATA;\n\t\tbreak;\n\tcase 'D': // A_Desktop(Common)\n\t\taFolder = aVarName[9] ? CSIDL_COMMON_DESKTOPDIRECTORY : CSIDL_DESKTOPDIRECTORY;\n\t\tbreak;\n\tcase 'S':\n\t\tif (ctoupper(aVarName[7]) == 'M') // A_Start[M]enu(Common)\n\t\t\taFolder = aVarName[11] ? CSIDL_COMMON_STARTMENU : CSIDL_STARTMENU;\n\t\telse // A_Startup(Common)\n\t\t\taFolder = aVarName[9] ? CSIDL_COMMON_STARTUP : CSIDL_STARTUP;\n\t\tbreak;\n#ifdef _DEBUG\n\tdefault:\n\t\tASSERT(!_T(\"DEBUG: Unhandled SpecialFolderPath variable.\"));\n#endif\n\t}\n\tif (SHGetFolderPath(NULL, aFolder, NULL, SHGFP_TYPE_CURRENT, buf) != S_OK)\n\t\t*buf = '\\0';\n\t_f_return(buf);\n}\n\nBIV_DECL_R(BIV_MyDocuments) // Called by multiple callers.\n{\n\tTCHAR buf[MAX_PATH]; // SHGetFolderPath requires a buffer size of MAX_PATH. At least one caller relies on this.\n\tif (SHGetFolderPath(NULL, CSIDL_MYDOCUMENTS, NULL, SHGFP_TYPE_CURRENT, buf) != S_OK)\n\t\t*buf = '\\0';\n\t// Since it is common (such as in networked environments) to have My Documents on the root of a drive\n\t// (such as a mapped drive letter), remove the backslash from something like M:\\ because M: is more\n\t// appropriate for most uses:\n\tVarSizeType length = (VarSizeType)strip_trailing_backslash(buf);\n\t_f_return(buf, length);\n}\n\n\n\nBOOL CaretGetPos(ResultToken *aX, ResultToken *aY)\n{\n\t// I believe only the foreground window can have a caret position due to relationship with focused control.\n\tHWND target_window = GetForegroundWindow();\n\n\tGUITHREADINFO info;\n\tinfo.cbSize = sizeof(GUITHREADINFO);\n\tBOOL result = target_window // A window is in the foreground (usually true).\n\t\t&& GetGUIThreadInfo(GetWindowThreadProcessId(target_window, NULL), &info) // Got info okay...\n\t\t&& info.hwndCaret; // ...and there is a caret.\n\tif (!result)\n\t{\n\t\tif (aX) aX->SetValue(_T(\"\"), 0); // For backward-compatibility, these must be made \"blank\".\n\t\tif (aY) aY->SetValue(_T(\"\"), 0);\n\t\treturn FALSE;\n\t}\n\tPOINT pt;\n\tpt.x = info.rcCaret.left;\n\tpt.y = info.rcCaret.top;\n\t// Unconditionally convert to screen coordinates, for simplicity.\n\tClientToScreen(info.hwndCaret, &pt);\n\t// Now convert back to whatever is expected for the current mode.\n\tPOINT origin = {0};\n\tCoordToScreen(origin, COORD_MODE_CARET);\n\tpt.x -= origin.x;\n\tpt.y -= origin.y;\n\t\n\tif (aX) aX->SetValue(pt.x);\n\tif (aY) aY->SetValue(pt.y);\n\treturn TRUE;\n}\n\n\n\nBIV_DECL_R(BIV_Cursor)\n{\n\tHCURSOR current_cursor;\n\tCURSORINFO ci;\n\tci.cbSize = sizeof(CURSORINFO);\n\tcurrent_cursor = GetCursorInfo(&ci) ? ci.hCursor : NULL;\n\tif (!current_cursor)\n\t{\n\t\t#define CURSOR_UNKNOWN _T(\"Unknown\")\n\t\t_f_return_p(CURSOR_UNKNOWN);\n\t}\n\n\t// Static so that it's initialized on first use (should help performance after the first time):\n\tstatic HCURSOR sCursor[] = {LoadCursor(NULL, IDC_APPSTARTING), LoadCursor(NULL, IDC_ARROW)\n\t\t, LoadCursor(NULL, IDC_CROSS), LoadCursor(NULL, IDC_HELP), LoadCursor(NULL, IDC_IBEAM)\n\t\t, LoadCursor(NULL, IDC_ICON), LoadCursor(NULL, IDC_NO), LoadCursor(NULL, IDC_SIZE)\n\t\t, LoadCursor(NULL, IDC_SIZEALL), LoadCursor(NULL, IDC_SIZENESW), LoadCursor(NULL, IDC_SIZENS)\n\t\t, LoadCursor(NULL, IDC_SIZENWSE), LoadCursor(NULL, IDC_SIZEWE), LoadCursor(NULL, IDC_UPARROW)\n\t\t, LoadCursor(NULL, IDC_WAIT)}; // If IDC_HAND were added, it would break existing scripts that rely on Unknown being synonymous with Hand. If ever added, IDC_HAND should return NULL on Win95/NT.\n\tstatic const size_t cursor_count = _countof(sCursor);\n\t// The order in the below array must correspond to the order in the above array:\n\tstatic LPTSTR sCursorName[cursor_count + 1] = {_T(\"AppStarting\"), _T(\"Arrow\")\n\t\t, _T(\"Cross\"), _T(\"Help\"), _T(\"IBeam\")\n\t\t, _T(\"Icon\"), _T(\"No\"), _T(\"Size\")\n\t\t, _T(\"SizeAll\"), _T(\"SizeNESW\"), _T(\"SizeNS\") // NESW = NorthEast+SouthWest\n\t\t, _T(\"SizeNWSE\"), _T(\"SizeWE\"), _T(\"UpArrow\")\n\t\t, _T(\"Wait\"), CURSOR_UNKNOWN}; // The default item must be last.\n\n\tint i;\n\tfor (i = 0; i < cursor_count; ++i)\n\t\tif (sCursor[i] == current_cursor)\n\t\t\tbreak;\n\n\t_f_return_p(sCursorName[i]); // If i is out-of-bounds, \"Unknown\" will be used.\n}\n\nBIV_DECL_R(BIV_ScreenWidth_Height)\n{\n\t_f_return_i(GetSystemMetrics(aVarName[13] ? SM_CYSCREEN : SM_CXSCREEN));\n}\n\nBIV_DECL_R(BIV_ScriptName)\n{\n\t_f_return_p(g_script.mScriptName ? g_script.mScriptName : g_script.mFileName);\n}\n\nBIV_DECL_W(BIV_ScriptName_Set)\n{\n\t// For simplicity, a new buffer is allocated each time. It is not expected to be set frequently.\n\tLPTSTR script_name = _tcsdup(BivRValueToString());\n\tif (!script_name)\n\t\t_f_throw_oom;\n\tfree(g_script.mScriptName);\n\tg_script.mScriptName = script_name;\n}\n\nBIV_DECL_R(BIV_ScriptDir)\n{\n\t_f_return_p(g_script.mFileDir);\n}\n\nBIV_DECL_R(BIV_ScriptFullPath)\n{\n\t_f_return_p(g_script.mFileSpec);\n}\n\nBIV_DECL_R(BIV_ScriptHwnd)\n{\n\t_f_return((UINT_PTR)g_hWnd);\n}\n\n\nLineNumberType Script::CurrentLine()\n{\n\treturn mCurrLine ? mCurrLine->mLineNumber : mCombinedLineNumber;\n}\n\nBIV_DECL_R(BIV_LineNumber)\n{\n\t_f_return_i(g_script.CurrentLine());\n}\n\n\nLPTSTR Script::CurrentFile()\n{\n\treturn Line::sSourceFile[mCurrLine ? mCurrLine->mFileIndex : mCurrFileIndex];\n}\n\nBIV_DECL_R(BIV_LineFile)\n{\n\t_f_return_p(g_script.CurrentFile());\n}\n\n\nBIV_DECL_R(BIV_LoopFileName) // Called by multiple callers.\n{\n\tLPTSTR filename = _T(\"\"); // Set default.\n\tif (g->mLoopFile)\n\t{\n\t\t// cAlternateFileName can be blank if the file lacks a short name, but it can also be blank\n\t\t// if the file's proper name complies with all 8.3 requirements (not just length), so use\n\t\t// cFileName whenever cAlternateFileName is empty. GetShortPathName() also behaves this way.\n\t\tif ( ctoupper(aVarName[10]) != 'S' // It's not A_LoopFileShortName or ...\n\t\t\t|| !*(filename = g->mLoopFile->cAlternateFileName) ) // ... there's no alternate name (see above).\n\t\t\tfilename = g->mLoopFile->cFileName;\n\t}\n\t_f_return_p(filename);\n}\n\nBIV_DECL_R(BIV_LoopFileExt)\n{\n\tLPTSTR file_ext = _T(\"\"); // Set default.\n\tif (g->mLoopFile)\n\t{\n\t\tif (file_ext = _tcsrchr(g->mLoopFile->cFileName, '.'))\n\t\t\t++file_ext;\n\t\telse // Reset to empty string vs. NULL.\n\t\t\tfile_ext = _T(\"\");\n\t}\n\t_f_return_p(file_ext);\n}\n\nBIV_DECL_R(BIV_LoopFileDir)\n{\n\tif (!g->mLoopFile)\n\t\t_f_return_empty;\n\tLoopFilesStruct &lfs = *g->mLoopFile;\n\tLPTSTR dir_end = lfs.file_path + lfs.dir_length; // Start of the filename.\n\tsize_t suffix_length = dir_end - lfs.file_path_suffix; // Directory names\\ added since the loop started.\n\tsize_t total_length = lfs.orig_dir_length + suffix_length;\n\tif (total_length)\n\t\t--total_length; // Omit the trailing slash.\n\tif (!TokenSetResult(aResultToken, nullptr, total_length))\n\t\treturn;\n\taResultToken.symbol = SYM_STRING;\n\tLPTSTR buf = aResultToken.marker;\n\ttmemcpy(buf, lfs.orig_dir, lfs.orig_dir_length);\n\ttmemcpy(buf + lfs.orig_dir_length, lfs.file_path_suffix, suffix_length);\n\tbuf[total_length] = '\\0'; // This replaces the final character copied above, if any.\n}\n\nvoid FixLoopFilePath(LPTSTR aBuf, LPTSTR aPattern)\n// Fixes aBuf to account for \".\" and \"..\" as file patterns. These match the directory itself\n// or parent directory, so for example \"x\\y\\..\" returns a directory named \"x\" which appears to\n// be inside \"y\". Without the handling here, the invalid path \"x\\y\\x\" would be returned.\n// A small amount of temporary buffer space might be wasted compared to handling this in the BIV,\n// but this way minimizes code size (and these cases are rare anyway).\n{\n\tint count = 0;\n\tif (*aPattern == '.')\n\t{\n\t\tif (!aPattern[1])\n\t\t\tcount = 1; // aBuf \"x\\y\\y\" should be \"x\\y\" for \"x\\y\\.\".\n\t\telse if (aPattern[1] == '.' && !aPattern[2])\n\t\t\tcount = 2; // aBuf \"x\\y\\x\" should be \"x\" for \"x\\y\\..\".\n\t}\n\tfor ( ; count > 0; --count)\n\t{\n\t\tLPTSTR end = _tcsrchr(aBuf, '\\\\');\n\t\tif (end)\n\t\t\t*end = '\\0';\n\t\telse if (*aBuf && aBuf[1] == ':') // aBuf \"C:x\" should be \"C:\" for \"C:\" or \"C:.\".\n\t\t\taBuf[2] = '\\0';\n\t}\n}\n\nvoid ReturnLoopFilePath(ResultToken &aResultToken, LPTSTR aPattern, LPTSTR aPrefix, size_t aPrefixLen, LPTSTR aSuffix, size_t aSuffixLen)\n{\n\tif (!TokenSetResult(aResultToken, nullptr, aPrefixLen + aSuffixLen))\n\t\treturn;\n\taResultToken.symbol = SYM_STRING;\n\tLPTSTR buf = aResultToken.marker;\n\ttmemcpy(buf, aPrefix, aPrefixLen);\n\ttmemcpy(buf + aPrefixLen, aSuffix, aSuffixLen + 1); // +1 for \\0.\n\tFixLoopFilePath(buf, aPattern);\n\taResultToken.marker_length = -1; // Let caller determine actual length.\n}\n\nBIV_DECL_R(BIV_LoopFilePath)\n{\n\tif (!g->mLoopFile)\n\t\t_f_return_empty;\n\tLoopFilesStruct &lfs = *g->mLoopFile;\n\t// Combine the original directory specified by the script with the dynamic part of file_path\n\t// (i.e. the sub-directory and file names appended to it since the loop started):\n\tReturnLoopFilePath(aResultToken, lfs.pattern\n\t\t, lfs.orig_dir, lfs.orig_dir_length\n\t\t, lfs.file_path_suffix, lfs.file_path_length - (lfs.file_path_suffix - lfs.file_path));\n}\n\nBIV_DECL_R(BIV_LoopFileFullPath)\n{\n\tif (!g->mLoopFile)\n\t\t_f_return_empty;\n\t// GetFullPathName() is done in addition to ConvertFilespecToCorrectCase() for the following reasons:\n\t// 1) It's currently the only easy way to get the full path of the directory in which a file resides.\n\t// For example, if a script is passed a filename via command line parameter, that file could be\n\t// either an absolute path or a relative path. If relative, of course it's relative to A_WorkingDir.\n\t// The problem is, the script would have to manually detect this, which would probably take several\n\t// extra steps.\n\t// 2) A_LoopFileLongPath is mostly intended for the following cases, and in all of them it seems\n\t// preferable to have the full/absolute path rather than the relative path:\n\t// a) Files dragged onto a .ahk script when the drag-and-drop option has been enabled via the Installer.\n\t// b) Files passed into the script via command line.\n\t// Currently both are done by PerformLoopFilePattern(), for performance and in case the working\n\t// directory changes after the Loop begins.\n\tLoopFilesStruct &lfs = *g->mLoopFile;\n\t// Combine long_dir with the dynamic part of file_path:\n\tReturnLoopFilePath(aResultToken, lfs.pattern\n\t\t, lfs.long_dir, lfs.long_dir_length\n\t\t, lfs.file_path_suffix, lfs.file_path_length - (lfs.file_path_suffix - lfs.file_path));\n}\n\nBIV_DECL_R(BIV_LoopFileShortPath)\n// Unlike GetLoopFileShortName(), this function returns blank when there is no short path.\n// This is done so that there's a way for the script to more easily tell the difference between\n// an 8.3 name not being available (due to the being disabled in the registry) and the short\n// name simply being the same as the long name. For example, if short name creation is disabled\n// in the registry, A_LoopFileShortName would contain the long name instead, as documented.\n// But to detect if that short name is really a long name, A_LoopFileShortPath could be checked\n// and if it's blank, there is no short name available.\n{\n\tif (!g->mLoopFile)\n\t\t_f_return_empty;\n\tLoopFilesStruct &lfs = *g->mLoopFile;\n\t// MSDN says cAlternateFileName is empty if the file does not have a long name.\n\t// Testing and research shows that GetShortPathName() uses the long name for a directory\n\t// or file if no short name exists, so there's no check for the filename's length here.\n\tLPTSTR name = *lfs.cAlternateFileName ? lfs.cAlternateFileName : lfs.cFileName;\n\tReturnLoopFilePath(aResultToken, lfs.pattern\n\t\t, lfs.short_path, lfs.short_path_length\n\t\t, name, _tcslen(name));\n}\n\nBIV_DECL_R(BIV_LoopFileTime)\n{\n\tLPTSTR target_buf = _f_retval_buf;\n\t*target_buf = '\\0'; // Set default.\n\tif (g->mLoopFile)\n\t{\n\t\tFILETIME ft;\n\t\tswitch(ctoupper(aVarName[14])) // A_LoopFileTime[A]ccessed\n\t\t{\n\t\tcase 'M': ft = g->mLoopFile->ftLastWriteTime; break;\n\t\tcase 'C': ft = g->mLoopFile->ftCreationTime; break;\n\t\tdefault: ft = g->mLoopFile->ftLastAccessTime;\n\t\t}\n\t\tFileTimeToYYYYMMDD(target_buf, ft, true);\n\t}\n\t_f_return_p(target_buf);\n}\n\nBIV_DECL_R(BIV_LoopFileAttrib)\n{\n\tLPTSTR target_buf = _f_retval_buf;\n\t*target_buf = '\\0'; // Set default.\n\tif (g->mLoopFile)\n\t\tFileAttribToStr(target_buf, g->mLoopFile->dwFileAttributes);\n\t_f_return_p(target_buf);\n}\n\nBIV_DECL_R(BIV_LoopFileSize)\n{\n\tif (g->mLoopFile)\n\t{\n\t\tULARGE_INTEGER ul;\n\t\tul.HighPart = g->mLoopFile->nFileSizeHigh;\n\t\tul.LowPart = g->mLoopFile->nFileSizeLow;\n\t\tint divider;\n\t\tswitch (ctoupper(aVarName[14])) // A_LoopFileSize[K/M]B\n\t\t{\n\t\tcase 'K': divider = 1024; break;\n\t\tcase 'M': divider = 1024*1024; break;\n\t\tdefault: divider = 0;\n\t\t}\n\t\t_f_return_i(divider ? ((unsigned __int64)ul.QuadPart / divider) : ul.QuadPart);\n\t}\n\t_f_return_empty;\n}\n\nBIV_DECL_R(BIV_LoopRegType)\n{\n\t_f_return_p(g->mLoopRegItem ? Line::RegConvertValueType(g->mLoopRegItem->type) : _T(\"\"));\n}\n\nBIV_DECL_R(BIV_LoopRegKey)\n{\n\tLPTSTR rootkey = _T(\"\");\n\tLPTSTR subkey = _T(\"\");\n\tif (g->mLoopRegItem)\n\t{\n\t\t// Use root_key_type, not root_key (which might be a remote vs. local HKEY):\n\t\trootkey = Line::RegConvertRootKeyType(g->mLoopRegItem->root_key_type);\n\t\tsubkey = g->mLoopRegItem->subkey;\n\t}\n\tif (!TokenSetResult(aResultToken, nullptr, _tcslen(rootkey) + (*subkey != 0) + _tcslen(subkey)))\n\t\treturn;\n\t_stprintf(aResultToken.marker, _T(\"%s%s%s\"), rootkey, *subkey ? _T(\"\\\\\") : _T(\"\"), subkey);\n\taResultToken.symbol = SYM_STRING;\n}\n\nBIV_DECL_R(BIV_LoopRegName)\n{\n\t// This can be either the name of a subkey or the name of a value.\n\t_f_return_p(g->mLoopRegItem ? g->mLoopRegItem->name : _T(\"\"));\n}\n\nBIV_DECL_R(BIV_LoopRegTimeModified)\n{\n\tLPTSTR target_buf = _f_retval_buf;\n\t*target_buf = '\\0'; // Set default.\n\t// Only subkeys (not values) have a time.\n\tif (g->mLoopRegItem && g->mLoopRegItem->type == REG_SUBKEY)\n\t\tFileTimeToYYYYMMDD(target_buf, g->mLoopRegItem->ftLastWriteTime, true);\n\t_f_return_p(target_buf);\n}\n\nBIV_DECL_R(BIV_LoopReadLine)\n{\n\t_f_return_p(g->mLoopReadFile ? g->mLoopReadFile->mCurrentLine : _T(\"\"));\n}\n\nBIV_DECL_R(BIV_LoopField)\n{\n\t_f_return_p(g->mLoopField ? g->mLoopField : _T(\"\"));\n}\n\nBIV_DECL_R(BIV_LoopIndex)\n{\n\t_f_return_i(g->mLoopIteration);\n}\n\nBIV_DECL_W(BIV_LoopIndex_Set)\n{\n\tg->mLoopIteration = BivRValueToInt64();\n}\n\n\n\nBIV_DECL_R(BIV_ThisFunc)\n{\n\tLPCTSTR name;\n\tif (g->CurrentFunc)\n\t\tname = g->CurrentFunc->mName;\n\telse\n\t\tname = _T(\"\");\n\t_f_return_p(const_cast<LPTSTR>(name));\n}\n\nBIV_DECL_R(BIV_ThisHotkey)\n{\n\t_f_return_p(g_script.mThisHotkeyName);\n}\n\nBIV_DECL_R(BIV_PriorHotkey)\n{\n\t_f_return_p(g_script.mPriorHotkeyName);\n}\n\nBIV_DECL_R(BIV_TimeSinceThisHotkey)\n{\n\t// It must be the type of hotkey that has a label because we want the TimeSinceThisHotkey\n\t// value to be \"in sync\" with the value of ThisHotkey itself (i.e. use the same method\n\t// to determine which hotkey is the \"this\" hotkey):\n\tif (*g_script.mThisHotkeyName)\n\t\t// Even if GetTickCount()'s TickCount has wrapped around to zero and the timestamp hasn't,\n\t\t// DWORD subtraction still gives the right answer as long as the number of days between\n\t\t// isn't greater than about 49. See MyGetTickCount() for explanation of %d vs. %u.\n\t\t// Update: Using 64-bit ints now, so above is obsolete:\n\t\t//sntprintf(str, sizeof(str), \"%d\", (DWORD)(GetTickCount() - g_script.mThisHotkeyStartTime));\n\t\t_f_return_i((__int64)(GetTickCount() - g_script.mThisHotkeyStartTime));\n\telse\n\t\t_f_return_empty; // Cause any attempt at math to throw.\n}\n\nBIV_DECL_R(BIV_TimeSincePriorHotkey)\n{\n\tif (*g_script.mPriorHotkeyName)\n\t\t// See MyGetTickCount() for explanation for explanation:\n\t\t//sntprintf(str, sizeof(str), \"%d\", (DWORD)(GetTickCount() - g_script.mPriorHotkeyStartTime));\n\t\t_f_return_i((__int64)(GetTickCount() - g_script.mPriorHotkeyStartTime));\n\telse\n\t\t_f_return_empty; // Cause any attempt at math to throw.\n}\n\nBIV_DECL_R(BIV_EndChar)\n{\n\t_f_retval_buf[0] = g_script.mEndChar;\n\t_f_retval_buf[1] = '\\0';\n\t_f_return_p(_f_retval_buf);\n}\n\n\n\nvoid SetHotIfReturnValue(ResultToken &aResultToken);\nBIV_DECL_R(BIV_HotIf)\n{\n\tSetHotIfReturnValue(aResultToken);\n}\n\n\n\nBIV_DECL_R(BIV_EventInfo)\n// We're returning the length of the var's contents, not the size.\n{\n\t_f_return_i(g->EventInfo);\n}\n\nBIV_DECL_W(BIV_EventInfo_Set)\n{\n\tg->EventInfo = (EventInfoType)BivRValueToInt64();\n}\n\n\n\nBIV_DECL_R(BIV_TimeIdle)\n// This is here rather than in script.h with the others because it depends on\n// hotkey.h and globaldata.h, which can't be easily included in script.h due to\n// mutual dependency issues.\n{\n\tDWORD time_last_input = 0;\n\tswitch (toupper(aVarName[10]))\n\t{\n\tcase 'M': time_last_input = g_MouseHook ? g_TimeLastInputMouse : 0; break;\n\tcase 'K': time_last_input = g_KeybdHook ? g_TimeLastInputKeyboard : 0; break;\n\tcase 'P': time_last_input = (g_KeybdHook || g_MouseHook) ? g_TimeLastInputPhysical : 0; break;\n\t}\n\t// If the relevant hook is not active, default this to the same as the regular idle time:\n\tif (!time_last_input)\n\t{\n\t\tLASTINPUTINFO lii;\n\t\tlii.cbSize = sizeof(lii);\n\t\tif (GetLastInputInfo(&lii))\n\t\t\ttime_last_input = lii.dwTime;\n\t\telse // This is rare; the possibility isn't even documented as of 2020-06-11.\n\t\t\t_f_return_empty; // Cause any attempt at math to throw.\n\t}\n\t_f_return_i(GetTickCount() - time_last_input);\n}\n"},"size":{"kind":"number","value":43171,"string":"43,171"},"language":{"kind":"string","value":"C++"},"extension":{"kind":"string","value":".cpp"},"total_lines":{"kind":"number","value":1265,"string":"1,265"},"avg_line_length":{"kind":"number","value":32.02529644268775,"string":"32.025296"},"max_line_length":{"kind":"number","value":210,"string":"210"},"alphanum_fraction":{"kind":"number","value":0.7182081964461284,"string":"0.718208"},"repo_name":{"kind":"string","value":"AutoHotkey/AutoHotkey"},"repo_stars":{"kind":"number","value":9046,"string":"9,046"},"repo_forks":{"kind":"number","value":932,"string":"932"},"repo_open_issues":{"kind":"number","value":17,"string":"17"},"repo_license":{"kind":"string","value":"GPL-2.0"},"repo_extraction_date":{"kind":"string","value":"9/20/2024, 9:26:25 PM (Europe/Amsterdam)"},"exact_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"near_duplicates_redpajama":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"},"exact_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_githubcode":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv1":{"kind":"bool","value":false,"string":"false"},"near_duplicates_stackv2":{"kind":"bool","value":false,"string":"false"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":110,"numItemsPerPage":100,"numTotalItems":500000,"offset":11000,"length":100}},"jwt":"eyJhbGciOiJFZERTQSJ9.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc4MDA3MzU2OCwic3ViIjoiL2RhdGFzZXRzL0FJU0UtVFVEZWxmdC9TdGFja2xlc3NfQ1BQX1YyIiwiZXhwIjoxNzgwMDc3MTY4LCJpc3MiOiJodHRwczovL2h1Z2dpbmdmYWNlLmNvIn0.IWD9m0_XInSARx_NsUWBMqrkZnxq0Su6L9hrBpLfq6xXUau4z5bJhie7yclByx_cPhnpFD0CGOLm6NDO8-0nDQ","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":500000,"numBytesParquet":1315200245}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
id int64 0 755k | file_name stringlengths 3 109 | file_path stringlengths 13 185 | content stringlengths 31 9.38M | size int64 31 9.38M | language stringclasses 1
value | extension stringclasses 11
values | total_lines int64 1 340k | avg_line_length float64 2.18 149k | max_line_length int64 7 2.22M | alphanum_fraction float64 0 1 | repo_name stringlengths 6 65 | repo_stars int64 100 47.3k | repo_forks int64 0 12k | repo_open_issues int64 0 3.4k | repo_license stringclasses 9
values | repo_extraction_date stringclasses 92
values | exact_duplicates_redpajama bool 2
classes | near_duplicates_redpajama bool 2
classes | exact_duplicates_githubcode bool 2
classes | exact_duplicates_stackv2 bool 1
class | exact_duplicates_stackv1 bool 2
classes | near_duplicates_githubcode bool 2
classes | near_duplicates_stackv1 bool 2
classes | near_duplicates_stackv2 bool 1
class |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
15,979 | cheats_patches.h | shadps4-emu_shadPS4/src/qt_gui/cheats_patches.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef CHEATS_PATCHES_H
#define CHEATS_PATCHES_H
#include <QCheckBox>
#include <QComboBox>
#include <QGroupBox>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QLabel>
#incl... | 3,126 | C++ | .h | 96 | 27.729167 | 97 | 0.73672 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,980 | game_info.h | shadps4-emu_shadPS4/src/qt_gui/game_info.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QFutureWatcher>
#include <QtConcurrent>
#include "common/config.h"
#include "core/file_format/psf.h"
#include "game_list_utils.h"
class GameInfoClass : public QObject {
Q_OBJECT... | 2,844 | C++ | .h | 67 | 31.253731 | 95 | 0.536823 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,981 | game_list_frame.h | shadps4-emu_shadPS4/src/qt_gui/game_list_frame.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QScrollBar>
#include "background_music_player.h"
#include "game_info.h"
#include "game_list_utils.h"
#include "gui_context_menus.h"
class GameListFrame : public QTableWidget {
Q... | 3,113 | C++ | .h | 89 | 27.47191 | 100 | 0.636333 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,982 | check_update.h | shadps4-emu_shadPS4/src/qt_gui/check_update.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef CHECKUPDATE_H
#define CHECKUPDATE_H
#include <QCheckBox>
#include <QDialog>
#include <QNetworkAccessManager>
#include <QPushButton>
class CheckUpdate : public QDialog {
Q_OBJECT
public:
ex... | 1,136 | C++ | .h | 30 | 32.4 | 97 | 0.74108 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,983 | main_window.h | shadps4-emu_shadPS4/src/qt_gui/main_window.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QActionGroup>
#include <QDragEnterEvent>
#include <QTranslator>
#include "background_music_player.h"
#include "common/config.h"
#include "common/discord_rpc_handler.h"
#include "comm... | 3,612 | C++ | .h | 108 | 28.490741 | 92 | 0.705646 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,984 | pkg_viewer.h | shadps4-emu_shadPS4/src/qt_gui/pkg_viewer.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QFileDialog>
#include <QMenuBar>
#include <QStatusBar>
#include "common/io_file.h"
#include "core/file_format/pkg.h"
#include "core/file_format/pkg_type.h"
#include "core/file_format... | 1,648 | C++ | .h | 54 | 26.203704 | 91 | 0.693132 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,985 | main_window_ui.h | shadps4-emu_shadPS4/src/qt_gui/main_window_ui.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QMenuBar>
#include <QPushButton>
#include <QToolBar>
class Ui_MainWindow {
public:
QAction* bootInstallPkgAct;
QAction* bootGameAct;
QAction* addElfFolderAct;
QAction... | 18,635 | C++ | .h | 363 | 43.184573 | 100 | 0.707158 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,986 | background_music_player.h | shadps4-emu_shadPS4/src/qt_gui/background_music_player.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QAudioOutput>
#include <QMediaPlayer>
#include <QObject>
class BackgroundMusicPlayer : public QObject {
Q_OBJECT
public:
static BackgroundMusicPlayer& getInstance() {
... | 651 | C++ | .h | 22 | 25.727273 | 66 | 0.757235 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,987 | gui_context_menus.h | shadps4-emu_shadPS4/src/qt_gui/gui_context_menus.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QClipboard>
#include <QDesktopServices>
#include <QMenu>
#include <QMessageBox>
#include <QTreeWidget>
#include <QTreeWidgetItem>
#include "cheats_patches.h"
#include "game_info.h"
#... | 20,982 | C++ | .h | 431 | 34.262181 | 100 | 0.546444 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,988 | elf_viewer.h | shadps4-emu_shadPS4/src/qt_gui/elf_viewer.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QFileDialog>
#include "core/loader/elf.h"
#include "game_list_frame.h"
class ElfViewer : public QTableWidget {
Q_OBJECT
public:
explicit ElfViewer(QWidget* parent = nullptr)... | 1,722 | C++ | .h | 40 | 37.05 | 96 | 0.680838 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,989 | game_list_utils.h | shadps4-emu_shadPS4/src/qt_gui/game_list_utils.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "common/path_util.h"
struct GameInfo {
std::filesystem::path path; // root path of game directory
// (normally directory that contains eb... | 4,886 | C++ | .h | 137 | 25.635036 | 84 | 0.472381 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,990 | settings_dialog.h | shadps4-emu_shadPS4/src/qt_gui/settings_dialog.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <span>
#include <QDialog>
#include <QGroupBox>
#include <QPushButton>
#include "common/config.h"
#include "common/path_util.h"
namespace Ui {
class SettingsDialog;
}
class SettingsD... | 1,002 | C++ | .h | 32 | 28.03125 | 98 | 0.763845 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,991 | game_grid_frame.h | shadps4-emu_shadPS4/src/qt_gui/game_grid_frame.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QScrollBar>
#include "background_music_player.h"
#include "common/config.h"
#include "game_info.h"
#include "game_list_utils.h"
#include "gui_context_menus.h"
class GameGridFrame : ... | 1,282 | C++ | .h | 37 | 30.324324 | 100 | 0.747573 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,992 | game_install_dialog.h | shadps4-emu_shadPS4/src/qt_gui/game_install_dialog.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QDialog>
#include "common/config.h"
#include "common/path_util.h"
class QLineEdit;
class GameInstallDialog final : public QDialog {
public:
GameInstallDialog();
~GameInstal... | 628 | C++ | .h | 23 | 24.26087 | 66 | 0.767559 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,993 | trophy_viewer.h | shadps4-emu_shadPS4/src/qt_gui/trophy_viewer.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QApplication>
#include <QDir>
#include <QFileInfoList>
#include <QGraphicsBlurEffect>
#include <QHeaderView>
#include <QLabel>
#include <QMainWindow>
#include <QTableWidget>
#include ... | 1,131 | C++ | .h | 41 | 22.926829 | 78 | 0.692804 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,995 | install_dir_select.h | shadps4-emu_shadPS4/src/qt_gui/install_dir_select.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <QDialog>
#include <QListWidget>
#include "common/config.h"
#include "common/path_util.h"
class QLineEdit;
class InstallDirSelect final : public QDialog {
Q_OBJECT
public:
... | 630 | C++ | .h | 22 | 25.272727 | 66 | 0.756667 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,996 | version.h | shadps4-emu_shadPS4/src/common/version.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <string>
#include <string_view>
namespace Common {
constexpr char VERSION[] = "0.4.1 WIP";
constexpr bool isRelease = false;
} // namespace Common
| 286 | C++ | .h | 9 | 30.222222 | 66 | 0.779412 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,997 | native_clock.h | shadps4-emu_shadPS4/src/common/native_clock.h | // SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <chrono>
#include "common/types.h"
namespace Common {
class NativeClock final {
public:
explicit NativeClock();
u64 GetTscFrequency() const {
return rdtsc_frequency;
... | 651 | C++ | .h | 24 | 23.458333 | 63 | 0.717286 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,998 | endian.h | shadps4-emu_shadPS4/src/common/endian.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
/**
* (c) 2014-2016 Alexandro Sanchez Bach. All rights reserved.
* Released under GPL v2 license. Read LICENSE for more details.
* Some modifications for using with shadps4 by georgemoralis
*/
#pragma o... | 6,726 | C++ | .h | 218 | 25.018349 | 100 | 0.609963 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
15,999 | unique_function.h | shadps4-emu_shadPS4/src/common/unique_function.h | // SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <memory>
#include <utility>
namespace Common {
/// General purpose function wrapper similar to std::function.
/// Unlike std::function, the captured values don't have to be c... | 1,744 | C++ | .h | 46 | 31.521739 | 79 | 0.669664 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,001 | error.h | shadps4-emu_shadPS4/src/common/error.h | // SPDX-FileCopyrightText: 2013 Dolphin Emulator Project
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <string>
namespace Common {
// Generic function to get last error message.
// Call directly after the command or use the error num.
// Th... | 597 | C++ | .h | 15 | 38.4 | 62 | 0.777778 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,002 | discord_rpc_handler.h | shadps4-emu_shadPS4/src/common/discord_rpc_handler.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <cstdint>
#include <string>
#include <discord_rpc.h>
namespace DiscordRPCHandler {
enum class RPCStatus {
Idling,
Playing,
};
class RPC {
std::uint64_t startTimestamp;
... | 593 | C++ | .h | 23 | 22.73913 | 84 | 0.740675 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,003 | scm_rev.h | shadps4-emu_shadPS4/src/common/scm_rev.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
namespace Common {
extern const char g_scm_rev[];
extern const char g_scm_branch[];
extern const char g_scm_desc[];
extern const char g_scm_date[];
} // namespace Common
| 299 | C++ | .h | 9 | 31.777778 | 66 | 0.776224 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,004 | div_ceil.h | shadps4-emu_shadPS4/src/common/div_ceil.h | // SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <cstddef>
#include <type_traits>
namespace Common {
/// Ceiled integer division.
template <typename N, typename D>
requires std::is_integral_v<N> && std::is_unsigned_v<D... | 822 | C++ | .h | 19 | 39.789474 | 101 | 0.705436 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,005 | elf_info.h | shadps4-emu_shadPS4/src/common/elf_info.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <string>
#include <string_view>
#include "assert.h"
#include "singleton.h"
#include "types.h"
namespace Core {
class Emulator;
}
namespace Common {
class ElfInfo {
friend class... | 1,648 | C++ | .h | 56 | 24.5 | 66 | 0.673858 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,006 | object_pool.h | shadps4-emu_shadPS4/src/common/object_pool.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <memory>
#include <type_traits>
#include <utility>
#include <vector>
namespace Common {
template <typename T>
requires std::is_destructible_v<T>
class ObjectPool {
public:
ex... | 2,863 | C++ | .h | 88 | 24.659091 | 96 | 0.576197 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,007 | cstring.h | shadps4-emu_shadPS4/src/common/cstring.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <string_view>
#include "assert.h"
namespace Common {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wtautological-undefined-compare"
/**
* @brief A null-terminat... | 3,776 | C++ | .h | 137 | 20.437956 | 99 | 0.552135 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,008 | arch.h | shadps4-emu_shadPS4/src/common/arch.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#if defined(__x86_64__) || defined(_M_X64)
#define ARCH_X86_64 1
#elif defined(__aarch64__) || defined(_M_ARM64)
#define ARCH_ARM64 1
#endif
| 268 | C++ | .h | 8 | 32.25 | 66 | 0.744186 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,009 | concepts.h | shadps4-emu_shadPS4/src/common/concepts.h | // SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <concepts>
#include <iterator>
#include <type_traits>
namespace Common {
// Check if type satisfies the ContiguousContainer named requirement.
template <typename T>
concept IsContiguous... | 839 | C++ | .h | 21 | 38.47619 | 79 | 0.794554 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,010 | hash.h | shadps4-emu_shadPS4/src/common/hash.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "common/types.h"
[[nodiscard]] inline u64 HashCombine(const u64 seed, const u64 hash) {
return seed ^ (hash + 0x9e3779b9 + (seed << 12) + (seed >> 4));
}
[[nodiscard]] inline u32... | 435 | C++ | .h | 10 | 41.4 | 70 | 0.694313 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,011 | assert.h | shadps4-emu_shadPS4/src/common/assert.h | // SPDX-FileCopyrightText: 2013 Dolphin Emulator Project
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "common/logging/log.h"
// Sometimes we want to try to continue even after hitting an assert.
// However touching this file yields a global... | 4,903 | C++ | .h | 70 | 65.3 | 100 | 0.275161 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,013 | thread.h | shadps4-emu_shadPS4/src/common/thread.h | // SPDX-FileCopyrightText: 2013 Dolphin Emulator Project
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <chrono>
#include "common/types.h"
namespace Common {
enum class ThreadPriority : u32 {
Low = 0,
Normal = 1,
High = 2,
Ve... | 847 | C++ | .h | 27 | 28.259259 | 69 | 0.752169 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,014 | memory_patcher.h | shadps4-emu_shadPS4/src/common/memory_patcher.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <cstring>
#include <string>
#include <vector>
namespace MemoryPatcher {
extern uintptr_t g_eboot_address;
extern uint64_t g_eboot_image_size;
extern std::string g_game_serial;
extern ... | 1,208 | C++ | .h | 36 | 30.583333 | 100 | 0.767642 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,015 | types.h | shadps4-emu_shadPS4/src/common/types.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <array>
#include <cstdint>
using s8 = std::int8_t;
using s16 = std::int16_t;
using s32 = std::int32_t;
using s64 = std::int64_t;
using u8 = std::uint8_t;
using u16 = std::uint16_t;
u... | 932 | C++ | .h | 30 | 29.366667 | 66 | 0.725644 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,016 | debug.h | shadps4-emu_shadPS4/src/common/debug.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#ifdef _MSC_VER
#define BREAKPOINT __debugbreak
#elif defined(__GNUC__)
#define BREAKPOINT __builtin_trap
#else
#error What the fuck is this compiler
#endif
#include <tracy/Tracy.hpp>
static ... | 2,695 | C++ | .h | 46 | 53.956522 | 100 | 0.509484 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,017 | rdtsc.h | shadps4-emu_shadPS4/src/common/rdtsc.h | // SPDX-FileCopyrightText: Copyright 2023 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "common/arch.h"
#ifdef _MSC_VER
#include <intrin.h>
#endif
#include "common/types.h"
namespace Common {
#ifdef _MSC_VER
__forceinline static u64 FencedRDTSC() {
#ifdef ARCH_X86_64
... | 1,135 | C++ | .h | 46 | 20.152174 | 74 | 0.639223 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,018 | io_file.h | shadps4-emu_shadPS4/src/common/io_file.h | // SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <cstdio>
#include <filesystem>
#include <span>
#include <type_traits>
#include "common/concepts.h"
#include "common/types.h"
namespace Common::FS {
enum class FileAccessMode {
/**
... | 6,800 | C++ | .h | 177 | 31.372881 | 100 | 0.636557 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,019 | ntapi.h | shadps4-emu_shadPS4/src/common/ntapi.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#ifdef _WIN32
#include <windows.h>
#include "common/types.h"
typedef enum _FILE_INFORMATION_CLASS {
FileDirectoryInformation = 1,
FileFullDirectoryInformation = 2,
Fi... | 4,371 | C++ | .h | 113 | 32.362832 | 98 | 0.748347 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,020 | slot_vector.h | shadps4-emu_shadPS4/src/common/slot_vector.h | // SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <bit>
#include <compare>
#include <numeric>
#include <type_traits>
#include <utility>
#include <vector>
#include "common/assert.h"
#include "common/types.h"
namespace Common {
struct Sl... | 4,540 | C++ | .h | 134 | 26.402985 | 89 | 0.58097 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,021 | string_util.h | shadps4-emu_shadPS4/src/common/string_util.h | // SPDX-FileCopyrightText: 2013 Dolphin Emulator Project
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <string>
#include <vector>
namespace Common {
/// Make a string lowercase
[[nodiscard]] std::string ToLower(std::string_view str);
void ... | 605 | C++ | .h | 16 | 36.3125 | 77 | 0.776248 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,022 | number_utils.h | shadps4-emu_shadPS4/src/common/number_utils.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "common/types.h"
namespace NumberUtils {
float Uf11ToF32(u16 val);
float Uf10ToF32(u16 val);
float Uf16ToF32(u16 val);
float U2ToUnorm(u8 val);
float S2ToSnorm(s8 val);
float U4ToUno... | 643 | C++ | .h | 23 | 26.73913 | 66 | 0.8 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,023 | func_traits.h | shadps4-emu_shadPS4/src/common/func_traits.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <tuple>
namespace Common {
template <class Func>
struct FuncTraits {};
template <class ReturnType_, class... Args>
struct FuncTraits<ReturnType_ (*)(Args...)> {
using ReturnType... | 914 | C++ | .h | 23 | 37.043478 | 92 | 0.723864 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,024 | bounded_threadsafe_queue.h | shadps4-emu_shadPS4/src/common/bounded_threadsafe_queue.h | // SPDX-FileCopyrightText: Copyright 2023 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <atomic>
#include <condition_variable>
#include <cstddef>
#include <memory>
#include <mutex>
#include "common/polyfill_thread.h"
namespace Common {
namespace detail {
constexpr std::siz... | 6,954 | C++ | .h | 200 | 27.43 | 96 | 0.601998 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,025 | enum.h | shadps4-emu_shadPS4/src/common/enum.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <type_traits>
#include "common/types.h"
#define DECLARE_ENUM_FLAG_OPERATORS(type) \
[[nodiscard]] constexpr type operator|... | 7,308 | C++ | .h | 133 | 48.744361 | 100 | 0.316077 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,027 | fixed_value.h | shadps4-emu_shadPS4/src/common/fixed_value.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
/**
* @brief A template class that encapsulates a fixed, compile-time constant value.
*
* @tparam T The type of the value.
* @tparam Value The fixed value of type T.
*
* This class provid... | 957 | C++ | .h | 30 | 28.033333 | 95 | 0.695228 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,028 | decoder.h | shadps4-emu_shadPS4/src/common/decoder.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <Zydis/Zydis.h>
#include "common/singleton.h"
#include "common/types.h"
namespace Common {
class DecoderImpl {
public:
DecoderImpl();
~DecoderImpl();
std::string disasse... | 885 | C++ | .h | 23 | 32.913043 | 94 | 0.729508 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,029 | signal_context.h | shadps4-emu_shadPS4/src/common/signal_context.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "common/types.h"
namespace Common {
void* GetXmmPointer(void* ctx, u8 index);
void* GetRip(void* ctx);
void IncrementRip(void* ctx, u64 length);
bool IsWriteError(void* ctx);
} /... | 338 | C++ | .h | 10 | 32.1 | 66 | 0.781931 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,030 | path_util.h | shadps4-emu_shadPS4/src/common/path_util.h | // SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <filesystem>
#include <vector>
#ifdef ENABLE_QT_GUI
class QString; // to avoid including <QString> in this header
#endif
namespace Common::FS {
enum class PathType {
UserDir, ... | 3,704 | C++ | .h | 102 | 34.205882 | 97 | 0.735917 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,031 | polyfill_thread.h | shadps4-emu_shadPS4/src/common/polyfill_thread.h | // SPDX-FileCopyrightText: 2022 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
//
// TODO: remove this file when jthread is supported by all compilation targets
//
#pragma once
#include <version>
#ifdef __cpp_lib_jthread
#include <chrono>
#include <condition_variable>
#include <stop_token>
#inc... | 10,181 | C++ | .h | 305 | 27.344262 | 100 | 0.632572 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,032 | slot_array.h | shadps4-emu_shadPS4/src/common/slot_array.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
// #include <boost/icl/interval_set.hpp>
#include <limits>
#include <optional>
#include <shared_mutex>
#include <unordered_map>
#include <memory>
#include <numeric>
namespace Common {
template <class Ind... | 1,719 | C++ | .h | 52 | 27.115385 | 93 | 0.637681 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,033 | uint128.h | shadps4-emu_shadPS4/src/common/uint128.h | // SPDX-FileCopyrightText: Copyright 2019 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <utility>
#ifdef _MSC_VER
#ifndef __clang__
#define HAS_INTRINSICS
#include <intrin.h>
#pragma intrinsic(__umulh)
#pragma intrinsic(_umul128)
#pragma intrinsic(_udiv128)
#else
#endif
#el... | 3,423 | C++ | .h | 100 | 30.39 | 98 | 0.649335 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,035 | config.h | shadps4-emu_shadPS4/src/common/config.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <filesystem>
#include <vector>
#include "types.h"
namespace Config {
enum HideCursorState : s16 { Never, Idle, Always };
void load(const std::filesystem::path& path);
void save(cons... | 3,602 | C++ | .h | 109 | 31.87156 | 66 | 0.817501 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,036 | backend.h | shadps4-emu_shadPS4/src/common/logging/backend.h | // SPDX-FileCopyrightText: Copyright 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <string_view>
#include "common/logging/filter.h"
namespace Common::Log {
class Filter;
/// Initializes the logging system. This should be the first thing called in main.
void Initiali... | 718 | C++ | .h | 18 | 38.277778 | 95 | 0.78955 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,037 | filter.h | shadps4-emu_shadPS4/src/common/logging/filter.h | // SPDX-FileCopyrightText: Copyright 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <array>
#include <cstddef>
#include <string_view>
#include "common/logging/types.h"
namespace Common::Log {
/**
* Returns the name of the passed log class as a C-string. Subclasses ar... | 2,498 | C++ | .h | 53 | 43.509434 | 99 | 0.725329 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,038 | log_entry.h | shadps4-emu_shadPS4/src/common/logging/log_entry.h | // SPDX-FileCopyrightText: Copyright 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <chrono>
#include "common/logging/types.h"
namespace Common::Log {
/**
* A log entry. Log entries are store in a structured format to permit more varied output
* formatting on diffe... | 633 | C++ | .h | 20 | 28.8 | 89 | 0.741351 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,039 | text_formatter.h | shadps4-emu_shadPS4/src/common/logging/text_formatter.h | // SPDX-FileCopyrightText: Copyright 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <string>
namespace Common::Log {
struct Entry;
/// Formats a log entry into the provided text buffer.
std::string FormatLogMessage(const Entry& entry);
/// Formats and prints a log e... | 542 | C++ | .h | 13 | 40.076923 | 91 | 0.788868 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,040 | types.h | shadps4-emu_shadPS4/src/common/logging/types.h | // SPDX-FileCopyrightText: Copyright 2023 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "common/types.h"
namespace Common::Log {
/// Specifies the severity or level of detail of the log message.
enum class Level : u8 {
Trace, ///< Extremely detailed and repetitive deb... | 5,476 | C++ | .h | 95 | 52.989474 | 92 | 0.61872 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,041 | formatter.h | shadps4-emu_shadPS4/src/common/logging/formatter.h | // SPDX-FileCopyrightText: Copyright 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <type_traits>
#include <fmt/format.h>
// Adapted from https://github.com/fmtlib/fmt/issues/2704
// a generic formatter for enum classes
#if FMT_VERSION >= 80100
template <typename T>
st... | 1,331 | C++ | .h | 35 | 34.571429 | 97 | 0.690698 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,042 | log.h | shadps4-emu_shadPS4/src/common/logging/log.h | // SPDX-FileCopyrightText: Copyright 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <algorithm>
#include <array>
#include <string_view>
#include "common/logging/formatter.h"
#include "common/logging/types.h"
namespace Common::Log {
constexpr const char* TrimSourcePat... | 3,707 | C++ | .h | 59 | 52.389831 | 100 | 0.487215 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,043 | sdl_audio.h | shadps4-emu_shadPS4/src/audio_core/sdl_audio.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <shared_mutex>
#include <SDL3/SDL_audio.h>
#include "core/libraries/audio/audioout.h"
namespace Audio {
class SDLAudio {
public:
SDLAudio() = default;
virtual ~SDLAudio() = d... | 1,080 | C++ | .h | 32 | 28.375 | 79 | 0.67147 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,044 | imgui_config.h | shadps4-emu_shadPS4/src/imgui/imgui_config.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
// WARNING: All includes from this file must be relative to allow Dear_ImGui project to compile
// without having this project include paths.
#include <cstdint>
extern void assert_fa... | 1,448 | C++ | .h | 25 | 54.8 | 100 | 0.456153 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,045 | imgui_std.h | shadps4-emu_shadPS4/src/imgui/imgui_std.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <cmath>
#include <imgui.h>
#include "imgui_internal.h"
#define IM_COL32_GRAY(x) IM_COL32(x, x, x, 0xFF)
#define IMGUI_FONT_TEXT 0
#define IMGUI_FONT_MONO 1
namespace ImGui {
names... | 3,012 | C++ | .h | 73 | 36.931507 | 93 | 0.692229 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,046 | imgui_layer.h | shadps4-emu_shadPS4/src/imgui/imgui_layer.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
namespace ImGui {
class Layer {
public:
virtual ~Layer() = default;
static void AddLayer(Layer* layer);
static void RemoveLayer(Layer* layer);
virtual void Draw() = 0;
};
} /... | 337 | C++ | .h | 12 | 25.416667 | 66 | 0.738318 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,047 | imgui_texture.h | shadps4-emu_shadPS4/src/imgui/imgui_texture.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <filesystem>
#include <imgui.h>
namespace ImGui {
namespace Core::TextureManager {
struct Inner;
} // namespace Core::TextureManager
class RefCountedTexture {
Core::TextureManag... | 1,077 | C++ | .h | 30 | 31.766667 | 71 | 0.757986 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,048 | imgui_impl_sdl3.h | shadps4-emu_shadPS4/src/imgui/renderer/imgui_impl_sdl3.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
// Based on imgui_impl_sdl3.h from Dear ImGui repository
#pragma once
struct SDL_Window;
struct SDL_Renderer;
struct SDL_Gamepad;
typedef union SDL_Event SDL_Event;
namespace ImGui::Sdl {
bool Init(SDL_W... | 935 | C++ | .h | 24 | 36.333333 | 100 | 0.779867 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,049 | texture_manager.h | shadps4-emu_shadPS4/src/imgui/renderer/texture_manager.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <filesystem>
#include <vector>
#include "common/types.h"
#include "imgui/imgui_texture.h"
namespace vk {
class CommandBuffer;
}
namespace ImGui::Core::TextureManager {
struct Inner... | 544 | C++ | .h | 18 | 28.611111 | 66 | 0.790291 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,050 | imgui_core.h | shadps4-emu_shadPS4/src/imgui/renderer/imgui_core.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "video_core/renderer_vulkan/vk_instance.h"
#include "vulkan/vulkan_handles.hpp"
union SDL_Event;
namespace Vulkan {
struct Frame;
}
namespace ImGui::Core {
void Initialize(const Vu... | 723 | C++ | .h | 19 | 34.736842 | 84 | 0.758671 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,051 | imgui_impl_vulkan.h | shadps4-emu_shadPS4/src/imgui/renderer/imgui_impl_vulkan.h | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
// Based on imgui_impl_vulkan.h from Dear ImGui repository
#pragma once
#include "common/types.h"
#include "video_core/renderer_vulkan/vk_common.h"
struct ImDrawData;
namespace ImGui::Vulkan {
struct In... | 1,841 | C++ | .h | 46 | 35.021739 | 91 | 0.718539 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,054 | si_ci_vi_merged_pm4_it_opcodes.h | shadps4-emu_shadPS4/externals/gcn/include/gcn/si_ci_vi_merged_pm4_it_opcodes.h | /*
***********************************************************************************************************************
*
* Copyright (c) 2015-2021 Advanced Micro Devices, Inc. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associ... | 5,536 | C++ | .h | 113 | 44.884956 | 120 | 0.471489 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,056 | opcodes.inc | shadps4-emu_shadPS4/src/shader_recompiler/ir/opcodes.inc | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
// opcode name, return type, arg1 type, arg2 type, arg3 type, arg4 type, arg4 type, ...
OPCODE(Phi, ... | 49,287 | C++ | .inc | 331 | 147.830816 | 170 | 0.197315 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,057 | aerolib.inl | shadps4-emu_shadPS4/scripts/aerolib.inl | // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
// generated using ps4_names2stubs.py
STUB("++-URPJNZ18", _ZN9Inspector17ScriptDebugServer23removeBreakpointActionsEm)
STUB("++67uYkhqBU", _ZN7WebCore28InspectorFrontendClientLocal8Settings11getPropertyERKN3... | 9,375,906 | C++ | .inl | 171,519 | 51.820055 | 326 | 0.879546 | shadps4-emu/shadPS4 | 9,253 | 501 | 185 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,058 | StringConv.cpp | AutoHotkey_AutoHotkey/source/StringConv.cpp | #include "stdafx.h"
#include "KuString.h"
#include "StringConv.h"
#include "util.h"
#ifdef _WIN32
LPCWSTR StringUTF8ToWChar(LPCSTR sUTF8, CStringW &sWChar, int iChars/* = -1*/)
{
if (!sUTF8)
return NULL;
sWChar.Empty();
int iLen = MultiByteToWideChar(CP_UTF8, 0, sUTF8, iChars, NULL, 0);
if (iLen > 0) {
LPWSTR... | 3,178 | C++ | .cpp | 89 | 33.606742 | 128 | 0.703486 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | true | true | true | false |
16,059 | script_autoit.cpp | AutoHotkey_AutoHotkey/source/script_autoit.cpp | ///////////////////////////////////////////////////////////////////////////////
//
// AutoIt
//
// Copyright (C)1999-2006:
// - Jonathan Bennett <jon@hiddensoft.com>
// - Others listed at https://www.autoitscript.com/autoit3/docs/credits.htm
// - Chris Mallett (support@autohotkey.com): various enhancements and
/... | 72,149 | C++ | .cpp | 1,730 | 38.950867 | 366 | 0.720792 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,060 | script_com.cpp | AutoHotkey_AutoHotkey/source/script_com.cpp | #include "stdafx.h"
#include "globaldata.h"
#include "script.h"
#include "script_object.h"
#include "script_com.h"
#include "script_func_impl.h"
#include "script_gui.h"
#include <DispEx.h>
// IID__IObject -- .NET's System.Object:
const IID IID__Object = {0x65074F7F, 0x63C0, 0x304E, 0xAF, 0x0A, 0xD5, 0x17, 0x41, 0xCB,... | 55,191 | C++ | .cpp | 1,791 | 27.739252 | 220 | 0.699163 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,061 | script_menu.cpp | AutoHotkey_AutoHotkey/source/script_menu.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 53,000 | C++ | .cpp | 1,259 | 39.603654 | 251 | 0.732257 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,062 | Debugger.cpp | AutoHotkey_AutoHotkey/source/Debugger.cpp | /*
Debugger.cpp - Main body of AutoHotkey debugger engine.
Original code by Steve Gray.
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software f... | 96,794 | C++ | .cpp | 2,816 | 31.249645 | 207 | 0.688198 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,063 | script_object.cpp | AutoHotkey_AutoHotkey/source/script_object.cpp | #include "stdafx.h" // pre-compiled headers
#include "defines.h"
#include "globaldata.h"
#include "script.h"
#include "application.h"
#include "script_object.h"
#include "script_func_impl.h"
#include "script_gui.h"
#include "input_object.h"
#include <errno.h> // For ERANGE.
#include <initializer_list>
//
// CallMet... | 117,410 | C++ | .cpp | 3,465 | 31.266955 | 164 | 0.710887 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,065 | ahklib.cpp | AutoHotkey_AutoHotkey/source/ahklib.cpp | /*
ahklib.cpp
Original code by Steve Gray.
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applicat... | 17,436 | C++ | .cpp | 599 | 26.489149 | 134 | 0.728029 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,066 | application.cpp | AutoHotkey_AutoHotkey/source/application.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 121,366 | C++ | .cpp | 1,962 | 57.731906 | 349 | 0.728082 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,067 | error.cpp | AutoHotkey_AutoHotkey/source/error.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 45,549 | C++ | .cpp | 1,216 | 34.859375 | 159 | 0.726315 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,068 | script.cpp | AutoHotkey_AutoHotkey/source/script.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 566,893 | C++ | .cpp | 11,811 | 44.237744 | 449 | 0.697688 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,069 | script_registry.cpp | AutoHotkey_AutoHotkey/source/script_registry.cpp | ///////////////////////////////////////////////////////////////////////////////
//
// AutoIt
//
// Copyright (C)1999-2007:
// - Jonathan Bennett <jon@hiddensoft.com>
// - Others listed at http://www.autoitscript.com/autoit3/docs/credits.htm
// - Chris Mallett (support@autohotkey.com): adaptation of this file's
/... | 25,259 | C++ | .cpp | 636 | 36.545597 | 185 | 0.696145 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,070 | util.cpp | AutoHotkey_AutoHotkey/source/util.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 145,922 | C++ | .cpp | 3,032 | 45.109169 | 256 | 0.713335 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,071 | var.cpp | AutoHotkey_AutoHotkey/source/var.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 65,828 | C++ | .cpp | 1,276 | 48.918495 | 348 | 0.739044 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,072 | MdFunc.cpp | AutoHotkey_AutoHotkey/source/MdFunc.cpp |
#include "stdafx.h"
#include "MdFunc.h"
#include "abi.h"
#include "script_func_impl.h"
#include "window.h"
// internal to this file
struct MdFuncEntry
{
LPCTSTR name;
void *function;
MdType rettype;
MdType argtype[23];
};
#define md_mode decl
#include "lib\functions.h"
#undef md_mode
MdFuncEntry sMdFunc[]
{
... | 19,635 | C++ | .cpp | 684 | 25.526316 | 136 | 0.668167 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,073 | hotkey.cpp | AutoHotkey_AutoHotkey/source/hotkey.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 132,722 | C++ | .cpp | 2,585 | 48.28472 | 237 | 0.726936 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | true | true | false |
16,075 | input_object.cpp | AutoHotkey_AutoHotkey/source/input_object.cpp | #include "stdafx.h" // pre-compiled headers
#include "defines.h"
#include "globaldata.h"
#include "script.h"
#include "application.h"
#include "script_object.h"
#include "script_func_impl.h"
#include "input_object.h"
ObjectMemberMd InputObject::sMembers[] =
{
#define BOOL_OPTION(OPT) md_property(InputObject, OPT, ... | 5,999 | C++ | .cpp | 210 | 26.233333 | 120 | 0.712868 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,076 | AutoHotkey.cpp | AutoHotkey_AutoHotkey/source/AutoHotkey.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 13,826 | C++ | .cpp | 307 | 42.221498 | 189 | 0.732077 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,077 | script_module.cpp | AutoHotkey_AutoHotkey/source/script_module.cpp | #include "stdafx.h"
#include "script.h"
#include "globaldata.h"
Object *ScriptModule::sPrototype;
ResultType ScriptModule::Invoke(IObject_Invoke_PARAMS_DECL)
{
auto var = aName ? mVars.Find(aName) : nullptr;
if (!var && mIsBuiltinModule)
// This is a slight hack to support built-in vars which haven't been refer... | 7,653 | C++ | .cpp | 252 | 27.607143 | 94 | 0.69567 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,079 | window.cpp | AutoHotkey_AutoHotkey/source/window.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 91,677 | C++ | .cpp | 1,553 | 56.312299 | 276 | 0.746505 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,080 | script_object_bif.cpp | AutoHotkey_AutoHotkey/source/script_object_bif.cpp | #include "stdafx.h" // pre-compiled headers
#include "defines.h"
#include "globaldata.h"
#include "script.h"
#include "script_object.h"
#include "script_func_impl.h"
extern BuiltInFunc *OpFunc_GetProp, *OpFunc_GetItem, *OpFunc_SetProp, *OpFunc_SetItem;
//
// Object()
//
BIF_DECL(Op_Object)
{
IObject *obj = Object... | 8,143 | C++ | .cpp | 304 | 24.592105 | 127 | 0.705489 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,081 | script_gui.cpp | AutoHotkey_AutoHotkey/source/script_gui.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 521,961 | C++ | .cpp | 10,159 | 47.955901 | 318 | 0.721911 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,082 | script2.cpp | AutoHotkey_AutoHotkey/source/script2.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 154,135 | C++ | .cpp | 3,544 | 40.784707 | 279 | 0.721677 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,083 | globaldata.cpp | AutoHotkey_AutoHotkey/source/globaldata.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 20,515 | C++ | .cpp | 414 | 48.292271 | 254 | 0.718171 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,084 | WinGroup.cpp | AutoHotkey_AutoHotkey/source/WinGroup.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 21,335 | C++ | .cpp | 425 | 47.4 | 112 | 0.739652 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,085 | script_expression.cpp | AutoHotkey_AutoHotkey/source/script_expression.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 130,215 | C++ | .cpp | 2,256 | 53.291667 | 286 | 0.7105 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | true | false |
16,086 | ahkversion.cpp | AutoHotkey_AutoHotkey/source/ahkversion.cpp |
#include "stdafx.h"
#include "ahkversion.h"
LPSTR AHK_VERSION = RAW_AHK_VERSION;
LPTSTR T_AHK_VERSION = _T(RAW_AHK_VERSION);
LPTSTR T_AHK_NAME_VERSION = T_AHK_NAME _T(" v") _T(RAW_AHK_VERSION);
| 196 | C++ | .cpp | 5 | 37.8 | 68 | 0.719577 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | true | false | true | false |
16,092 | InputBox.cpp | AutoHotkey_AutoHotkey/source/lib/InputBox.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 15,791 | C++ | .cpp | 359 | 40.933148 | 133 | 0.725628 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,093 | string.cpp | AutoHotkey_AutoHotkey/source/lib/string.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 64,415 | C++ | .cpp | 1,417 | 42.050812 | 312 | 0.696283 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
16,094 | vars.cpp | AutoHotkey_AutoHotkey/source/lib/vars.cpp | /*
AutoHotkey
Copyright 2003-2009 Chris Mallett (support@autohotkey.com)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This... | 43,171 | C++ | .cpp | 1,265 | 32.025296 | 210 | 0.718208 | AutoHotkey/AutoHotkey | 9,046 | 932 | 17 | GPL-2.0 | 9/20/2024, 9:26:25 PM (Europe/Amsterdam) | false | false | false | false | false | false | false | false |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.