/* Copyright 2012-2019 David Robillard Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ /** @file pugl_win.c Windows Pugl Implementation. */ #include "pugl/pugl_internal.h" #include "pugl/pugl_win.h" #ifdef PUGL_HAVE_GL #include "pugl/pugl_gl_backend.h" #endif #ifdef PUGL_HAVE_CAIRO #include "pugl/pugl_cairo_backend.h" #endif #include #include #include #include #include #include #ifndef WM_MOUSEWHEEL # define WM_MOUSEWHEEL 0x020A #endif #ifndef WM_MOUSEHWHEEL # define WM_MOUSEHWHEEL 0x020E #endif #ifndef WHEEL_DELTA # define WHEEL_DELTA 120 #endif #ifndef GWLP_USERDATA # define GWLP_USERDATA (-21) #endif #define PUGL_LOCAL_CLOSE_MSG (WM_USER + 50) #define PUGL_RESIZE_TIMER_ID 9461 #define PUGL_URGENT_TIMER_ID 9462 static const TCHAR* DEFAULT_CLASSNAME = "Pugl"; LRESULT CALLBACK wndProc(HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam); PuglInternals* puglInitInternals(void) { PuglInternals* impl = (PuglInternals*)calloc(1, sizeof(PuglInternals)); LARGE_INTEGER frequency; QueryPerformanceFrequency(&frequency); impl->timerFrequency = (double)frequency.QuadPart; return impl; } void puglEnterContext(PuglView* view, bool drawing) { view->impl->backend->enter(view, drawing); } void puglLeaveContext(PuglView* view, bool drawing) { view->impl->backend->leave(view, drawing); } int puglCreateWindow(PuglView* view, const char* title) { PuglInternals* impl = view->impl; const char* className = view->windowClass ? view->windowClass : DEFAULT_CLASSNAME; title = title ? title : "Window"; if (view->ctx_type == PUGL_GL) { #ifdef PUGL_HAVE_GL impl->backend = puglGlBackend(); #endif } if (view->ctx_type == PUGL_CAIRO) { #ifdef PUGL_HAVE_CAIRO impl->backend = puglCairoBackend(); #endif } // Get refresh rate for resize draw timer DEVMODEA devMode = {0}; EnumDisplaySettingsA(NULL, ENUM_CURRENT_SETTINGS, &devMode); view->impl->refreshRate = devMode.dmDisplayFrequency; // Register window class WNDCLASSEX wc; memset(&wc, 0, sizeof(wc)); wc.cbSize = sizeof(wc); wc.style = CS_OWNDC; wc.lpfnWndProc = wndProc; wc.hInstance = GetModuleHandle(NULL); wc.hIcon = LoadIcon(NULL, IDI_APPLICATION); // TODO: user-specified icon wc.hCursor = LoadCursor(NULL, IDC_ARROW); wc.hbrBackground = (HBRUSH)GetStockObject(BLACK_BRUSH); wc.lpszClassName = className; if (!RegisterClassEx(&wc)) { return 1; } if (!impl->backend->configure) { return 1; } int st = impl->backend->configure(view); if (st || !impl->surface) { return 2; } else if ((st = impl->backend->create(view))) { return 3; } SetWindowText(impl->hwnd, title); SetWindowLongPtr(impl->hwnd, GWLP_USERDATA, (LONG_PTR)view); return 0; } void puglShowWindow(PuglView* view) { PuglInternals* impl = view->impl; ShowWindow(impl->hwnd, SW_SHOWNORMAL); SetFocus(impl->hwnd); view->visible = true; } void puglHideWindow(PuglView* view) { PuglInternals* impl = view->impl; ShowWindow(impl->hwnd, SW_HIDE); view->visible = false; } void puglDestroy(PuglView* view) { if (view) { view->impl->backend->destroy(view); ReleaseDC(view->impl->hwnd, view->impl->hdc); DestroyWindow(view->impl->hwnd); UnregisterClass(view->windowClass ? view->windowClass : DEFAULT_CLASSNAME, NULL); free(view->windowClass); free(view->impl); free(view); } } static PuglKey keySymToSpecial(WPARAM sym) { switch (sym) { case VK_F1: return PUGL_KEY_F1; case VK_F2: return PUGL_KEY_F2; case VK_F3: return PUGL_KEY_F3; case VK_F4: return PUGL_KEY_F4; case VK_F5: return PUGL_KEY_F5; case VK_F6: return PUGL_KEY_F6; case VK_F7: return PUGL_KEY_F7; case VK_F8: return PUGL_KEY_F8; case VK_F9: return PUGL_KEY_F9; case VK_F10: return PUGL_KEY_F10; case VK_F11: return PUGL_KEY_F11; case VK_F12: return PUGL_KEY_F12; case VK_BACK: return PUGL_KEY_BACKSPACE; case VK_DELETE: return PUGL_KEY_DELETE; case VK_LEFT: return PUGL_KEY_LEFT; case VK_UP: return PUGL_KEY_UP; case VK_RIGHT: return PUGL_KEY_RIGHT; case VK_DOWN: return PUGL_KEY_DOWN; case VK_PRIOR: return PUGL_KEY_PAGE_UP; case VK_NEXT: return PUGL_KEY_PAGE_DOWN; case VK_HOME: return PUGL_KEY_HOME; case VK_END: return PUGL_KEY_END; case VK_INSERT: return PUGL_KEY_INSERT; case VK_SHIFT: case VK_LSHIFT: return PUGL_KEY_SHIFT_L; case VK_RSHIFT: return PUGL_KEY_SHIFT_R; case VK_CONTROL: case VK_LCONTROL: return PUGL_KEY_CTRL_L; case VK_RCONTROL: return PUGL_KEY_CTRL_R; case VK_MENU: case VK_LMENU: return PUGL_KEY_ALT_L; case VK_RMENU: return PUGL_KEY_ALT_R; case VK_LWIN: return PUGL_KEY_SUPER_L; case VK_RWIN: return PUGL_KEY_SUPER_R; case VK_CAPITAL: return PUGL_KEY_CAPS_LOCK; case VK_SCROLL: return PUGL_KEY_SCROLL_LOCK; case VK_NUMLOCK: return PUGL_KEY_NUM_LOCK; case VK_SNAPSHOT: return PUGL_KEY_PRINT_SCREEN; case VK_PAUSE: return PUGL_KEY_PAUSE; } return (PuglKey)0; } static uint32_t getModifiers(void) { return (((GetKeyState(VK_SHIFT) < 0) ? PUGL_MOD_SHIFT : 0u) | ((GetKeyState(VK_CONTROL) < 0) ? PUGL_MOD_CTRL : 0u) | ((GetKeyState(VK_MENU) < 0) ? PUGL_MOD_ALT : 0u) | ((GetKeyState(VK_LWIN) < 0) ? PUGL_MOD_SUPER : 0u) | ((GetKeyState(VK_RWIN) < 0) ? PUGL_MOD_SUPER : 0u)); } static void initMouseEvent(PuglEvent* event, PuglView* view, int button, bool press, LPARAM lParam) { POINT pt = { GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam) }; ClientToScreen(view->impl->hwnd, &pt); if (press) { SetCapture(view->impl->hwnd); } else { ReleaseCapture(); } event->button.time = GetMessageTime() / 1e3; event->button.type = press ? PUGL_BUTTON_PRESS : PUGL_BUTTON_RELEASE; event->button.x = GET_X_LPARAM(lParam); event->button.y = GET_Y_LPARAM(lParam); event->button.x_root = pt.x; event->button.y_root = pt.y; event->button.state = getModifiers(); event->button.button = (uint32_t)button; } static void initScrollEvent(PuglEvent* event, PuglView* view, LPARAM lParam) { POINT pt = { GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam) }; ScreenToClient(view->impl->hwnd, &pt); event->scroll.time = GetMessageTime() / 1e3; event->scroll.type = PUGL_SCROLL; event->scroll.x = pt.x; event->scroll.y = pt.y; event->scroll.x_root = GET_X_LPARAM(lParam); event->scroll.y_root = GET_Y_LPARAM(lParam); event->scroll.state = getModifiers(); event->scroll.dx = 0; event->scroll.dy = 0; } /** Return the code point for buf, or the replacement character on error. */ static uint32_t puglDecodeUTF16(const wchar_t* buf, const int len) { const uint32_t c0 = buf[0]; const uint32_t c1 = buf[0]; if (c0 >= 0xD800 && c0 < 0xDC00) { if (len < 2) { return 0xFFFD; // Surrogate, but length is only 1 } else if (c1 >= 0xDC00 && c1 <= 0xDFFF) { return ((c0 & 0x03FF) << 10) + (c1 & 0x03FF) + 0x10000; } return 0xFFFD; // Unpaired surrogates } return c0; } static void initKeyEvent(PuglEventKey* event, PuglView* view, bool press, WPARAM wParam, LPARAM lParam) { POINT rpos = { 0, 0 }; GetCursorPos(&rpos); POINT cpos = { rpos.x, rpos.y }; ScreenToClient(view->impl->hwnd, &rpos); const unsigned scode = (uint32_t)((lParam & 0xFF0000) >> 16); const unsigned vkey = ((wParam == VK_SHIFT) ? MapVirtualKey(scode, MAPVK_VSC_TO_VK_EX) : (unsigned)wParam); const unsigned vcode = MapVirtualKey(vkey, MAPVK_VK_TO_VSC); const unsigned kchar = MapVirtualKey(vkey, MAPVK_VK_TO_CHAR); const bool dead = kchar >> (sizeof(UINT) * 8 - 1) & 1; const bool ext = lParam & 0x01000000; event->type = press ? PUGL_KEY_PRESS : PUGL_KEY_RELEASE; event->time = GetMessageTime() / 1e3; event->state = getModifiers(); event->x_root = rpos.x; event->y_root = rpos.y; event->x = cpos.x; event->y = cpos.y; event->keycode = (uint32_t)((lParam & 0xFF0000) >> 16); event->key = 0; const PuglKey special = keySymToSpecial(vkey); if (special) { if (ext && (special == PUGL_KEY_CTRL || special == PUGL_KEY_ALT)) { event->key = special + 1u; // Right hand key } else { event->key = special; } } else if (!dead) { // Translate unshifted key BYTE keyboardState[256] = {0}; wchar_t buf[5] = {0}; const int ulen = ToUnicode(vkey, vcode, keyboardState, buf, 4, 1<<2); event->key = puglDecodeUTF16(buf, ulen); } } static void initCharEvent(PuglEvent* event, PuglView* view, WPARAM wParam, LPARAM lParam) { const wchar_t utf16[2] = { wParam & 0xFFFF, (wParam >> 16) & 0xFFFF }; initKeyEvent(&event->key, view, true, wParam, lParam); event->type = PUGL_TEXT; event->text.character = puglDecodeUTF16(utf16, 2); if (!WideCharToMultiByte( CP_UTF8, 0, utf16, 2, event->text.string, 8, NULL, NULL)) { memset(event->text.string, 0, 8); } } static bool ignoreKeyEvent(PuglView* view, LPARAM lParam) { return view->ignoreKeyRepeat && (lParam & (1 << 30)); } static RECT handleConfigure(PuglView* view, PuglEvent* event) { RECT rect; GetClientRect(view->impl->hwnd, &rect); view->width = rect.right - rect.left; view->height = rect.bottom - rect.top; event->configure.type = PUGL_CONFIGURE; event->configure.x = rect.left; event->configure.y = rect.top; event->configure.width = view->width; event->configure.height = view->height; view->impl->backend->resize(view, view->width, view->height); return rect; } static void handleCrossing(PuglView* view, const PuglEventType type, POINT pos) { POINT root_pos = pos; ClientToScreen(view->impl->hwnd, &root_pos); const PuglEventCrossing ev = { type, 0, GetMessageTime() / 1e3, (double)pos.x, (double)pos.y, (double)root_pos.x, (double)root_pos.y, getModifiers(), PUGL_CROSSING_NORMAL }; puglDispatchEvent(view, (const PuglEvent*)&ev); } static void stopFlashing(PuglView* view) { if (view->impl->flashing) { KillTimer(view->impl->hwnd, PUGL_URGENT_TIMER_ID); FlashWindow(view->impl->hwnd, FALSE); } } static void constrainAspect(const PuglView* const view, RECT* const size, const WPARAM wParam) { const float minAspect = view->min_aspect_x / (float)view->min_aspect_y; const float maxAspect = view->max_aspect_x / (float)view->max_aspect_y; const int w = size->right - size->left; const int h = size->bottom - size->top; const float a = w / (float)h; switch (wParam) { case WMSZ_TOP: size->top = (a < minAspect ? (LONG)(size->bottom - w * minAspect) : a > maxAspect ? (LONG)(size->bottom - w * maxAspect) : size->top); break; case WMSZ_TOPRIGHT: case WMSZ_RIGHT: case WMSZ_BOTTOMRIGHT: size->right = (a < minAspect ? (LONG)(size->left + h * minAspect) : a > maxAspect ? (LONG)(size->left + h * maxAspect) : size->right); break; case WMSZ_BOTTOM: size->bottom = (a < minAspect ? (LONG)(size->top + w * minAspect) : a > maxAspect ? (LONG)(size->top + w * maxAspect) : size->bottom); break; case WMSZ_BOTTOMLEFT: case WMSZ_LEFT: case WMSZ_TOPLEFT: size->left = (a < minAspect ? (LONG)(size->right - h * minAspect) : a > maxAspect ? (LONG)(size->right - h * maxAspect) : size->left); break; } } static LRESULT handleMessage(PuglView* view, UINT message, WPARAM wParam, LPARAM lParam) { PuglEvent event; void* dummy_ptr = NULL; RECT rect; MINMAXINFO* mmi; POINT pt; memset(&event, 0, sizeof(event)); event.any.type = PUGL_NOTHING; if (InSendMessageEx(dummy_ptr)) { event.any.flags |= PUGL_IS_SEND_EVENT; } switch (message) { case WM_SHOWWINDOW: rect = handleConfigure(view, &event); puglPostRedisplay(view); break; case WM_SIZE: rect = handleConfigure(view, &event); RedrawWindow(view->impl->hwnd, NULL, NULL, RDW_INVALIDATE|RDW_ALLCHILDREN|RDW_INTERNALPAINT| RDW_UPDATENOW); break; case WM_SIZING: if (view->min_aspect_x) { constrainAspect(view, (RECT*)lParam, wParam); return TRUE; } break; case WM_ENTERSIZEMOVE: view->impl->resizing = true; SetTimer(view->impl->hwnd, PUGL_RESIZE_TIMER_ID, 1000 / view->impl->refreshRate, NULL); break; case WM_TIMER: if (wParam == PUGL_RESIZE_TIMER_ID) { RedrawWindow(view->impl->hwnd, NULL, NULL, RDW_INVALIDATE|RDW_ALLCHILDREN|RDW_INTERNALPAINT); } else if (wParam == PUGL_URGENT_TIMER_ID) { FlashWindow(view->impl->hwnd, TRUE); } break; case WM_EXITSIZEMOVE: KillTimer(view->impl->hwnd, PUGL_RESIZE_TIMER_ID); view->impl->resizing = false; puglPostRedisplay(view); break; case WM_GETMINMAXINFO: mmi = (MINMAXINFO*)lParam; mmi->ptMinTrackSize.x = view->min_width; mmi->ptMinTrackSize.y = view->min_height; break; case WM_PAINT: GetUpdateRect(view->impl->hwnd, &rect, false); event.expose.type = PUGL_EXPOSE; event.expose.x = rect.left; event.expose.y = rect.top; event.expose.width = rect.right - rect.left; event.expose.height = rect.bottom - rect.top; event.expose.count = 0; break; case WM_ERASEBKGND: return true; case WM_MOUSEMOVE: pt.x = GET_X_LPARAM(lParam); pt.y = GET_Y_LPARAM(lParam); if (!view->impl->mouseTracked) { TRACKMOUSEEVENT tme = {0}; tme.cbSize = sizeof(tme); tme.dwFlags = TME_LEAVE; tme.hwndTrack = view->impl->hwnd; TrackMouseEvent(&tme); stopFlashing(view); handleCrossing(view, PUGL_ENTER_NOTIFY, pt); view->impl->mouseTracked = true; } ClientToScreen(view->impl->hwnd, &pt); event.motion.type = PUGL_MOTION_NOTIFY; event.motion.time = GetMessageTime() / 1e3; event.motion.x = GET_X_LPARAM(lParam); event.motion.y = GET_Y_LPARAM(lParam); event.motion.x_root = pt.x; event.motion.y_root = pt.y; event.motion.state = getModifiers(); event.motion.is_hint = false; break; case WM_MOUSELEAVE: GetCursorPos(&pt); ScreenToClient(view->impl->hwnd, &pt); handleCrossing(view, PUGL_LEAVE_NOTIFY, pt); view->impl->mouseTracked = false; break; case WM_LBUTTONDOWN: initMouseEvent(&event, view, 1, true, lParam); break; case WM_MBUTTONDOWN: initMouseEvent(&event, view, 2, true, lParam); break; case WM_RBUTTONDOWN: initMouseEvent(&event, view, 3, true, lParam); break; case WM_LBUTTONUP: initMouseEvent(&event, view, 1, false, lParam); break; case WM_MBUTTONUP: initMouseEvent(&event, view, 2, false, lParam); break; case WM_RBUTTONUP: initMouseEvent(&event, view, 3, false, lParam); break; case WM_MOUSEWHEEL: initScrollEvent(&event, view, lParam); event.scroll.dy = GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA; break; case WM_MOUSEHWHEEL: initScrollEvent(&event, view, lParam); event.scroll.dx = GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA; break; case WM_KEYDOWN: if (!ignoreKeyEvent(view, lParam)) { initKeyEvent(&event.key, view, true, wParam, lParam); } break; case WM_KEYUP: initKeyEvent(&event.key, view, false, wParam, lParam); break; case WM_CHAR: initCharEvent(&event, view, wParam, lParam); break; case WM_SETFOCUS: stopFlashing(view); event.type = PUGL_FOCUS_IN; break; case WM_KILLFOCUS: event.type = PUGL_FOCUS_OUT; break; case WM_SYSKEYDOWN: initKeyEvent(&event.key, view, true, wParam, lParam); break; case WM_SYSKEYUP: initKeyEvent(&event.key, view, false, wParam, lParam); break; case WM_SYSCHAR: return TRUE; case WM_QUIT: case PUGL_LOCAL_CLOSE_MSG: event.close.type = PUGL_CLOSE; break; default: return DefWindowProc(view->impl->hwnd, message, wParam, lParam); } puglDispatchEvent(view, &event); return 0; } void puglGrabFocus(PuglView* view) { SetFocus(view->impl->hwnd); } void puglRequestAttention(PuglView* view) { if (!view->impl->mouseTracked || GetFocus() != view->impl->hwnd) { FlashWindow(view->impl->hwnd, TRUE); SetTimer(view->impl->hwnd, PUGL_URGENT_TIMER_ID, 500, NULL); view->impl->flashing = true; } } PuglStatus puglWaitForEvent(PuglView* PUGL_UNUSED(view)) { WaitMessage(); return PUGL_SUCCESS; } PuglStatus puglProcessEvents(PuglView* view) { MSG msg; while (PeekMessage(&msg, view->impl->hwnd, 0, 0, PM_REMOVE)) { TranslateMessage(&msg); DispatchMessage(&msg); } return PUGL_SUCCESS; } LRESULT CALLBACK wndProc(HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam) { PuglView* view = (PuglView*)GetWindowLongPtr(hwnd, GWLP_USERDATA); switch (message) { case WM_CREATE: PostMessage(hwnd, WM_SHOWWINDOW, TRUE, 0); return 0; case WM_CLOSE: PostMessage(hwnd, PUGL_LOCAL_CLOSE_MSG, wParam, lParam); return 0; case WM_DESTROY: return 0; default: if (view && hwnd == view->impl->hwnd) { return handleMessage(view, message, wParam, lParam); } else { return DefWindowProc(hwnd, message, wParam, lParam); } } } double puglGetTime(PuglView* view) { LARGE_INTEGER count; QueryPerformanceCounter(&count); const double now = (double)count.QuadPart / view->impl->timerFrequency; return now - view->start_time; } void puglPostRedisplay(PuglView* view) { RedrawWindow(view->impl->hwnd, NULL, NULL, RDW_INVALIDATE|RDW_ALLCHILDREN|RDW_INTERNALPAINT); UpdateWindow(view->impl->hwnd); } PuglNativeWindow puglGetNativeWindow(PuglView* view) { return (PuglNativeWindow)view->impl->hwnd; } void* puglGetContext(PuglView* view) { return view->impl->backend->getContext(view); }