Function WinActive

source/window.cpp:538–577

	
HWND WinActive(global_struct &aSettings, LPTSTR aTitle, LPTSTR aText, LPTSTR aExcludeTitle, LPTSTR aExcludeText
	, bool aUpdateLastUsed)
// This function must be kept thread-safe because it may be called (indirectly) by hook thread too.
// In addition, it must not change the value of anything in aSettings except when aUpdateLastUsed==true.
{
	HWND target_window;
	if (USE_FOREGROUND_WINDOW(aTitle, aText, aExcludeTitle, aExcludeText))
	{
		// User asked us if the "active" window is active, which is true if it's not a
		// hidden window, or if DetectHiddenWindows is ON:
		SET_TARGET_TO_ALLOWABLE_FOREGROUND(aSettings.DetectHiddenWindows)
		#define UPDATE_AND_RETURN_LAST_USED_WINDOW(hwnd) \
		{\
			if (aUpdateLastUsed && hwnd)\
				aSettings.hWndLastUsed = hwnd;\
			return hwnd;\
		}
		UPDATE_AND_RETURN_LAST_USED_WINDOW(target_window)
	}

	HWND fore_win = GetForegroundWindow();
	if (!fore_win)
		return NULL;

	if (!(*aTitle || *aText || *aExcludeTitle || *aExcludeText)) // Use the "last found" window.
		return (fore_win == GetValidLastUsedWindow(aSettings)) ? fore_win : NULL;

	// Only after the above check should the below be done.  This is because "IfWinActive" (with no params)
	// should be "true" if one of the script's GUI windows is active:
	if (!aSettings.DetectWindow(fore_win)) // In this case, the caller's window can't be active.
		return NULL;

	WindowSearch ws;
	ws.SetCandidate(fore_win);

	if (ws.SetCriteria(aSettings, aTitle, aText, aExcludeTitle, aExcludeText) && ws.IsMatch()) // aSettings.DetectHiddenWindows was already checked above.
		UPDATE_AND_RETURN_LAST_USED_WINDOW(fore_win) // This also does a "return".
	else // If the line above didn't return, indicate that the specified window is not active.
		return NULL;
}