FreeRDP/client/Windows/wf_event.c

/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Event Handling
 *
 * Copyright 2009-2011 Jay Sorg
 * Copyright 2010-2011 Vic Lee
 * Copyright 2010-2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdio.h>

#include <freerdp/freerdp.h>

#include "wf_client.h"

#include "wf_gdi.h"
#include "wf_event.h"

#include <freerdp/event.h>

static HWND g_focus_hWnd;

#define X_POS(lParam) ((UINT16) (lParam & 0xFFFF))
#define Y_POS(lParam) ((UINT16) ((lParam >> 16) & 0xFFFF))

static BOOL wf_scale_blt(wfContext* wfc, HDC hdc, int x, int y, int w, int h,
                         HDC hdcSrc, int x1, int y1, DWORD rop);
static BOOL wf_scale_mouse_event(wfContext* wfc, rdpInput* input, UINT16 flags,
                                 UINT16 x, UINT16 y);

static BOOL g_flipping_in;
static BOOL g_flipping_out;

static BOOL alt_ctrl_down()
{
	return ((GetAsyncKeyState(VK_CONTROL) & 0x8000) ||
	        (GetAsyncKeyState(VK_MENU) & 0x8000));
}

LRESULT CALLBACK wf_ll_kbd_proc(int nCode, WPARAM wParam, LPARAM lParam)
{
	wfContext* wfc;
	DWORD rdp_scancode;
	rdpInput* input;
	PKBDLLHOOKSTRUCT p;
	DEBUG_KBD("Low-level keyboard hook, hWnd %X nCode %X wParam %X", g_focus_hWnd,
	          nCode, wParam);

	if (g_flipping_in)
	{
		if (!alt_ctrl_down())
			g_flipping_in = FALSE;

		return CallNextHookEx(NULL, nCode, wParam, lParam);
	}

	if (g_focus_hWnd && (nCode == HC_ACTION))
	{
		switch (wParam)
		{
			case WM_KEYDOWN:
			case WM_SYSKEYDOWN:
			case WM_KEYUP:
			case WM_SYSKEYUP:
				wfc = (wfContext*) GetWindowLongPtr(g_focus_hWnd, GWLP_USERDATA);
				p = (PKBDLLHOOKSTRUCT) lParam;

				if (!wfc || !p)
					return 1;

				input = wfc->context.input;
				rdp_scancode = MAKE_RDP_SCANCODE((BYTE) p->scanCode, p->flags & LLKHF_EXTENDED);
				DEBUG_KBD("keydown %d scanCode %04X flags %02X vkCode %02X",
				          (wParam == WM_KEYDOWN), (BYTE) p->scanCode, p->flags, p->vkCode);

				if (wfc->fs_toggle &&
				    ((p->vkCode == VK_RETURN) || (p->vkCode == VK_CANCEL)) &&
				    (GetAsyncKeyState(VK_CONTROL) & 0x8000) &&
				    (GetAsyncKeyState(VK_MENU) & 0x8000)) /* could also use flags & LLKHF_ALTDOWN */
				{
					if (wParam == WM_KEYDOWN)
					{
						wf_toggle_fullscreen(wfc);
						return 1;
					}
				}

				if (rdp_scancode == RDP_SCANCODE_NUMLOCK_EXTENDED)
				{
					/* Windows sends NumLock as extended - rdp doesn't */
					DEBUG_KBD("hack: NumLock (x45) should not be extended");
					rdp_scancode = RDP_SCANCODE_NUMLOCK;
				}
				else if (rdp_scancode == RDP_SCANCODE_NUMLOCK)
				{
					/* Windows sends Pause as if it was a RDP NumLock (handled above).
						 * It must however be sent as a one-shot Ctrl+NumLock */
					if (wParam == WM_KEYDOWN)
					{
						DEBUG_KBD("Pause, sent as Ctrl+NumLock");
						freerdp_input_send_keyboard_event_ex(input, TRUE, RDP_SCANCODE_LCONTROL);
						freerdp_input_send_keyboard_event_ex(input, TRUE, RDP_SCANCODE_NUMLOCK);
						freerdp_input_send_keyboard_event_ex(input, FALSE, RDP_SCANCODE_LCONTROL);
						freerdp_input_send_keyboard_event_ex(input, FALSE, RDP_SCANCODE_NUMLOCK);
					}
					else
					{
						DEBUG_KBD("Pause up");
					}

					return 1;
				}
				else if (rdp_scancode == RDP_SCANCODE_RSHIFT_EXTENDED)
				{
					DEBUG_KBD("right shift (x36) should not be extended");
					rdp_scancode = RDP_SCANCODE_RSHIFT;
				}

				freerdp_input_send_keyboard_event_ex(input, !(p->flags & LLKHF_UP),
				                                     rdp_scancode);

				if (p->vkCode == VK_NUMLOCK || p->vkCode == VK_CAPITAL
				    || p->vkCode == VK_SCROLL || p->vkCode == VK_KANA)
					DEBUG_KBD("lock keys are processed on client side too to toggle their indicators");
				else
					return 1;

				break;
		}
	}

	if (g_flipping_out)
	{
		if (!alt_ctrl_down())
		{
			g_flipping_out = FALSE;
			g_focus_hWnd = NULL;
		}
	}

	return CallNextHookEx(NULL, nCode, wParam, lParam);
}

void wf_event_focus_in(wfContext* wfc)
{
	UINT16 syncFlags;
	rdpInput* input;
	POINT pt;
	RECT rc;
	input = wfc->context.input;
	syncFlags = 0;

	if (GetKeyState(VK_NUMLOCK))
		syncFlags |= KBD_SYNC_NUM_LOCK;

	if (GetKeyState(VK_CAPITAL))
		syncFlags |= KBD_SYNC_CAPS_LOCK;

	if (GetKeyState(VK_SCROLL))
		syncFlags |= KBD_SYNC_SCROLL_LOCK;

	if (GetKeyState(VK_KANA))
		syncFlags |= KBD_SYNC_KANA_LOCK;

	input->FocusInEvent(input, syncFlags);
	/* send pointer position if the cursor is currently inside our client area */
	GetCursorPos(&pt);
	ScreenToClient(wfc->hwnd, &pt);
	GetClientRect(wfc->hwnd, &rc);

	if (pt.x >= rc.left && pt.x < rc.right && pt.y >= rc.top && pt.y < rc.bottom)
		input->MouseEvent(input, PTR_FLAGS_MOVE, (UINT16)pt.x, (UINT16)pt.y);
}

static int wf_event_process_WM_MOUSEWHEEL(wfContext* wfc, HWND hWnd, UINT Msg,
        WPARAM wParam, LPARAM lParam)
{
	int delta;
	int flags;
	rdpInput* input;
	DefWindowProc(hWnd, Msg, wParam, lParam);
	input = wfc->context.input;
	delta = ((signed short) HIWORD(wParam)); /* GET_WHEEL_DELTA_WPARAM(wParam); */

	if (delta > 0)
	{
		flags = PTR_FLAGS_WHEEL | 0x0078;
	}
	else
	{
		flags = PTR_FLAGS_WHEEL | PTR_FLAGS_WHEEL_NEGATIVE | 0x0088;
	}

	input->MouseEvent(input, flags, 0, 0);
	return 0;
}

static void wf_sizing(wfContext* wfc, WPARAM wParam, LPARAM lParam)
{
	rdpSettings* settings = wfc->context.settings;
	// Holding the CTRL key down while resizing the window will force the desktop aspect ratio.
	LPRECT rect;

	if (settings->SmartSizing && (GetAsyncKeyState(VK_CONTROL) & 0x8000))
	{
		rect = (LPRECT) wParam;

		switch (lParam)
		{
			case WMSZ_LEFT:
			case WMSZ_RIGHT:
			case WMSZ_BOTTOMRIGHT:
				// Adjust height
				rect->bottom = rect->top + settings->DesktopHeight * (rect->right -
				               rect->left) / settings->DesktopWidth;
				break;

			case WMSZ_TOP:
			case WMSZ_BOTTOM:
			case WMSZ_TOPRIGHT:
				// Adjust width
				rect->right = rect->left + settings->DesktopWidth * (rect->bottom - rect->top) /
				              settings->DesktopHeight;
				break;

			case WMSZ_BOTTOMLEFT:
			case WMSZ_TOPLEFT:
				// adjust width
				rect->left = rect->right - (settings->DesktopWidth * (rect->bottom -
				                            rect->top) / settings->DesktopHeight);
				break;
		}
	}
}

LRESULT CALLBACK wf_event_proc(HWND hWnd, UINT Msg, WPARAM wParam,
                               LPARAM lParam)
{
	HDC hdc;
	LONG_PTR ptr;
	wfContext* wfc;
	int x, y, w, h;
	PAINTSTRUCT ps;
	BOOL processed;
	RECT windowRect;
	MINMAXINFO* minmax;
	SCROLLINFO si;
	processed = TRUE;
	ptr = GetWindowLongPtr(hWnd, GWLP_USERDATA);
	wfc = (wfContext*) ptr;

	if (wfc != NULL)
	{
		rdpInput* input = wfc->context.input;
		rdpSettings* settings = wfc->context.settings;

		switch (Msg)
		{
			case WM_MOVE:
				if (!wfc->disablewindowtracking)
				{
					int x = (int)(short) LOWORD(lParam);
					int y = (int)(short) HIWORD(lParam);
					wfc->client_x = x;
					wfc->client_y = y;
				}

				break;

			case WM_GETMINMAXINFO:
				if (wfc->context.settings->SmartSizing)
				{
					processed = FALSE;
				}
				else
				{
					// Set maximum window size for resizing
					minmax = (MINMAXINFO*) lParam;

					//always use the last determined canvas diff, because it could be
					//that the window is minimized when this gets called
					//wf_update_canvas_diff(wfc);

					if (!wfc->fullscreen)
					{
						// add window decoration
						minmax->ptMaxTrackSize.x = settings->DesktopWidth + wfc->diff.x;
						minmax->ptMaxTrackSize.y = settings->DesktopHeight + wfc->diff.y;
					}
				}

				break;

			case WM_SIZING:
				wf_sizing(wfc, lParam, wParam);
				break;

			case WM_SIZE:
				GetWindowRect(wfc->hwnd, &windowRect);

				if (!wfc->fullscreen)
				{
					wfc->client_width = LOWORD(lParam);
					wfc->client_height = HIWORD(lParam);
					wfc->client_x = windowRect.left;
					wfc->client_y = windowRect.top;
				}

				if (wfc->client_width && wfc->client_height)
				{
					wf_size_scrollbars(wfc, LOWORD(lParam), HIWORD(lParam));

					// Workaround: when the window is maximized, the call to "ShowScrollBars" returns TRUE but has no effect.
					if (wParam == SIZE_MAXIMIZED && !wfc->fullscreen)
						SetWindowPos(wfc->hwnd, HWND_TOP, 0, 0, windowRect.right - windowRect.left,
						             windowRect.bottom - windowRect.top, SWP_NOMOVE | SWP_FRAMECHANGED);
				}

				break;

			case WM_EXITSIZEMOVE:
				wf_size_scrollbars(wfc, wfc->client_width, wfc->client_height);
				break;

			case WM_ERASEBKGND:
				/* Say we handled it - prevents flickering */
				return (LRESULT) 1;

			case WM_PAINT:
				hdc = BeginPaint(hWnd, &ps);
				x = ps.rcPaint.left;
				y = ps.rcPaint.top;
				w = ps.rcPaint.right - ps.rcPaint.left + 1;
				h = ps.rcPaint.bottom - ps.rcPaint.top + 1;
				wf_scale_blt(wfc, hdc, x, y, w, h, wfc->primary->hdc,
				             x - wfc->offset_x + wfc->xCurrentScroll,
				             y - wfc->offset_y + wfc->yCurrentScroll, SRCCOPY);
				EndPaint(hWnd, &ps);
				break;

			case WM_LBUTTONDOWN:
				wf_scale_mouse_event(wfc, input, PTR_FLAGS_DOWN | PTR_FLAGS_BUTTON1,
				                     X_POS(lParam) - wfc->offset_x, Y_POS(lParam) - wfc->offset_y);
				break;

			case WM_LBUTTONUP:
				wf_scale_mouse_event(wfc, input, PTR_FLAGS_BUTTON1,
				                     X_POS(lParam) - wfc->offset_x, Y_POS(lParam) - wfc->offset_y);
				break;

			case WM_RBUTTONDOWN:
				wf_scale_mouse_event(wfc, input, PTR_FLAGS_DOWN | PTR_FLAGS_BUTTON2,
				                     X_POS(lParam) - wfc->offset_x, Y_POS(lParam) - wfc->offset_y);
				break;

			case WM_RBUTTONUP:
				wf_scale_mouse_event(wfc, input, PTR_FLAGS_BUTTON2,
				                     X_POS(lParam) - wfc->offset_x, Y_POS(lParam) - wfc->offset_y);
				break;

			case WM_MOUSEMOVE:
				wf_scale_mouse_event(wfc, input, PTR_FLAGS_MOVE, X_POS(lParam) - wfc->offset_x,
				                     Y_POS(lParam) - wfc->offset_y);
				break;

			case WM_MOUSEWHEEL:
				wf_event_process_WM_MOUSEWHEEL(wfc, hWnd, Msg, wParam, lParam);
				break;

			case WM_SETCURSOR:
				if (LOWORD(lParam) == HTCLIENT)
					SetCursor(wfc->cursor);
				else
					DefWindowProc(hWnd, Msg, wParam, lParam);

				break;

			case WM_HSCROLL:
				{
					int xDelta;     // xDelta = new_pos - current_pos
					int xNewPos;    // new position
					int yDelta = 0;

					switch (LOWORD(wParam))
					{
						// User clicked the scroll bar shaft left of the scroll box.
						case SB_PAGEUP:
							xNewPos = wfc->xCurrentScroll - 50;
							break;

						// User clicked the scroll bar shaft right of the scroll box.
						case SB_PAGEDOWN:
							xNewPos = wfc->xCurrentScroll + 50;
							break;

						// User clicked the left arrow.
						case SB_LINEUP:
							xNewPos = wfc->xCurrentScroll - 5;
							break;

						// User clicked the right arrow.
						case SB_LINEDOWN:
							xNewPos = wfc->xCurrentScroll + 5;
							break;

						// User dragged the scroll box.
						case SB_THUMBPOSITION:
							xNewPos = HIWORD(wParam);

						// user is dragging the scrollbar
						case SB_THUMBTRACK :
							xNewPos = HIWORD(wParam);
							break;

						default:
							xNewPos = wfc->xCurrentScroll;
					}

					// New position must be between 0 and the screen width.
					xNewPos = MAX(0, xNewPos);
					xNewPos = MIN(wfc->xMaxScroll, xNewPos);

					// If the current position does not change, do not scroll.
					if (xNewPos == wfc->xCurrentScroll)
						break;

					// Determine the amount scrolled (in pixels).
					xDelta = xNewPos - wfc->xCurrentScroll;
					// Reset the current scroll position.
					wfc->xCurrentScroll = xNewPos;
					// Scroll the window. (The system repaints most of the
					// client area when ScrollWindowEx is called; however, it is
					// necessary to call UpdateWindow in order to repaint the
					// rectangle of pixels that were invalidated.)
					ScrollWindowEx(wfc->hwnd, -xDelta, -yDelta, (CONST RECT*) NULL,
					               (CONST RECT*) NULL, (HRGN) NULL, (PRECT) NULL,
					               SW_INVALIDATE);
					UpdateWindow(wfc->hwnd);
					// Reset the scroll bar.
					si.cbSize = sizeof(si);
					si.fMask  = SIF_POS;
					si.nPos   = wfc->xCurrentScroll;
					SetScrollInfo(wfc->hwnd, SB_HORZ, &si, TRUE);
				}
				break;

			case WM_VSCROLL:
				{
					int xDelta = 0;
					int yDelta;     // yDelta = new_pos - current_pos
					int yNewPos;    // new position

					switch (LOWORD(wParam))
					{
						// User clicked the scroll bar shaft above the scroll box.
						case SB_PAGEUP:
							yNewPos = wfc->yCurrentScroll - 50;
							break;

						// User clicked the scroll bar shaft below the scroll box.
						case SB_PAGEDOWN:
							yNewPos = wfc->yCurrentScroll + 50;
							break;

						// User clicked the top arrow.
						case SB_LINEUP:
							yNewPos = wfc->yCurrentScroll - 5;
							break;

						// User clicked the bottom arrow.
						case SB_LINEDOWN:
							yNewPos = wfc->yCurrentScroll + 5;
							break;

						// User dragged the scroll box.
						case SB_THUMBPOSITION:
							yNewPos = HIWORD(wParam);
							break;

						// user is dragging the scrollbar
						case SB_THUMBTRACK :
							yNewPos = HIWORD(wParam);
							break;

						default:
							yNewPos = wfc->yCurrentScroll;
					}

					// New position must be between 0 and the screen height.
					yNewPos = MAX(0, yNewPos);
					yNewPos = MIN(wfc->yMaxScroll, yNewPos);

					// If the current position does not change, do not scroll.
					if (yNewPos == wfc->yCurrentScroll)
						break;

					// Determine the amount scrolled (in pixels).
					yDelta = yNewPos - wfc->yCurrentScroll;
					// Reset the current scroll position.
					wfc->yCurrentScroll = yNewPos;
					// Scroll the window. (The system repaints most of the
					// client area when ScrollWindowEx is called; however, it is
					// necessary to call UpdateWindow in order to repaint the
					// rectangle of pixels that were invalidated.)
					ScrollWindowEx(wfc->hwnd, -xDelta, -yDelta, (CONST RECT*) NULL,
					               (CONST RECT*) NULL, (HRGN) NULL, (PRECT) NULL,
					               SW_INVALIDATE);
					UpdateWindow(wfc->hwnd);
					// Reset the scroll bar.
					si.cbSize = sizeof(si);
					si.fMask  = SIF_POS;
					si.nPos   = wfc->yCurrentScroll;
					SetScrollInfo(wfc->hwnd, SB_VERT, &si, TRUE);
				}
				break;

			case WM_SYSCOMMAND:
				{
					if (wParam == SYSCOMMAND_ID_SMARTSIZING)
					{
						HMENU hMenu = GetSystemMenu(wfc->hwnd, FALSE);
						freerdp_set_param_bool(wfc->context.settings, FreeRDP_SmartSizing,
						                       !wfc->context.settings->SmartSizing);
						CheckMenuItem(hMenu, SYSCOMMAND_ID_SMARTSIZING,
						              wfc->context.settings->SmartSizing ? MF_CHECKED : MF_UNCHECKED);
					}
					else
					{
						processed = FALSE;
					}
				}
				break;

			default:
				processed = FALSE;
				break;
		}
	}
	else
	{
		processed = FALSE;
	}

	if (processed)
		return 0;

	switch (Msg)
	{
		case WM_DESTROY:
			PostQuitMessage(WM_QUIT);
			break;

		case WM_SETCURSOR:
			if (LOWORD(lParam) == HTCLIENT)
				SetCursor(wfc->hDefaultCursor);
			else
				DefWindowProc(hWnd, Msg, wParam, lParam);

			break;

		case WM_SETFOCUS:
			DEBUG_KBD("getting focus %X", hWnd);

			if (alt_ctrl_down())
				g_flipping_in = TRUE;

			g_focus_hWnd = hWnd;
			freerdp_set_focus(wfc->context.instance);
			break;

		case WM_KILLFOCUS:
			if (g_focus_hWnd == hWnd && wfc && !wfc->fullscreen)
			{
				DEBUG_KBD("loosing focus %X", hWnd);

				if (alt_ctrl_down())
					g_flipping_out = TRUE;
				else
					g_focus_hWnd = NULL;
			}

			break;

		case WM_ACTIVATE:
			{
				int activate = (int)(short) LOWORD(wParam);

				if (activate != WA_INACTIVE)
				{
					if (alt_ctrl_down())
						g_flipping_in = TRUE;

					g_focus_hWnd = hWnd;
				}
				else
				{
					if (alt_ctrl_down())
						g_flipping_out = TRUE;
					else
						g_focus_hWnd = NULL;
				}
			}

		default:
			return DefWindowProc(hWnd, Msg, wParam, lParam);
			break;
	}

	return 0;
}

BOOL wf_scale_blt(wfContext* wfc, HDC hdc, int x, int y, int w, int h,
                  HDC hdcSrc, int x1, int y1, DWORD rop)
{
	rdpSettings* settings;
	UINT32 ww, wh, dw, dh;
	settings = wfc->context.settings;

	if (!wfc->client_width)
		wfc->client_width = settings->DesktopWidth;

	if (!wfc->client_height)
		wfc->client_height = settings->DesktopHeight;

	ww = wfc->client_width;
	wh = wfc->client_height;
	dw = settings->DesktopWidth;
	dh = settings->DesktopHeight;

	if (!ww)
		ww = dw;

	if (!wh)
		wh = dh;

	if (wfc->fullscreen || !wfc->context.settings->SmartSizing || (ww == dw
	        && wh == dh))
	{
		return BitBlt(hdc, x, y, w, h, wfc->primary->hdc, x1, y1, SRCCOPY);
	}
	else
	{
		SetStretchBltMode(hdc, HALFTONE);
		SetBrushOrgEx(hdc, 0, 0, NULL);
		return StretchBlt(hdc, 0, 0, ww, wh, wfc->primary->hdc, 0, 0, dw, dh, SRCCOPY);
	}

	return TRUE;
}

static BOOL wf_scale_mouse_event(wfContext* wfc, rdpInput* input, UINT16 flags,
                                 UINT16 x, UINT16 y)
{
	int ww, wh, dw, dh;
	rdpContext* context;
	rdpSettings* settings = wfc->context.settings;
	MouseEventEventArgs eventArgs;

	if (!wfc->client_width)
		wfc->client_width = settings->DesktopWidth;

	if (!wfc->client_height)
		wfc->client_height = settings->DesktopHeight;

	ww = wfc->client_width;
	wh = wfc->client_height;
	dw = settings->DesktopWidth;
	dh = settings->DesktopHeight;

	if (!settings->SmartSizing || ((ww == dw) && (wh == dh)))
		input->MouseEvent(input, flags, x + wfc->xCurrentScroll,
		                  y + wfc->yCurrentScroll);
	else
		input->MouseEvent(input, flags, x * dw / ww + wfc->xCurrentScroll,
		                  y * dh / wh + wfc->yCurrentScroll);

	eventArgs.flags = flags;
	eventArgs.x = x;
	eventArgs.y = y;
	context = (rdpContext*) wfc;
	PubSub_OnMouseEvent(context->pubSub, context, &eventArgs);
	return TRUE;
}