blob: 6a23526a919264b0bc5e3869a6360791b593aad7 [file] [log] [blame]
Pierre Ossmand50b3d12011-04-15 07:46:56 +00001/* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
Pierre Ossmanff9eb5a2014-01-30 17:47:31 +01002 * Copyright 2011-2014 Pierre Ossman for Cendio AB
Pierre Ossmand50b3d12011-04-15 07:46:56 +00003 *
4 * This is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This software is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this software; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
17 * USA.
18 */
19
Peter Åstrandc359f362011-08-23 12:04:46 +000020#ifdef HAVE_CONFIG_H
21#include <config.h>
22#endif
23
Pierre Ossmand50b3d12011-04-15 07:46:56 +000024#include <assert.h>
25#include <stdio.h>
26#include <string.h>
27
Pierre Ossmand50b3d12011-04-15 07:46:56 +000028#include <rfb/CMsgWriter.h>
29#include <rfb/LogWriter.h>
Pierre Ossmand1a853b2014-10-10 13:37:35 +020030#include <rfb/Exception.h>
Pierre Ossmand50b3d12011-04-15 07:46:56 +000031
32// FLTK can pull in the X11 headers on some systems
33#ifndef XK_VoidSymbol
Pierre Ossman13a809a2014-08-22 15:09:54 +020034#define XK_LATIN1
Pierre Ossmand50b3d12011-04-15 07:46:56 +000035#define XK_MISCELLANY
36#define XK_XKB_KEYS
37#include <rfb/keysymdef.h>
38#endif
39
Pierre Ossmancb0cffe2011-05-20 14:55:10 +000040#ifndef XF86XK_ModeLock
41#include <rfb/XF86keysym.h>
42#endif
43
Pierre Ossman7b8bff62014-07-21 16:17:23 +020044#ifndef NoSymbol
45#define NoSymbol 0
46#endif
47
Pierre Ossman2e9684f2014-07-21 16:46:22 +020048// Missing in at least some versions of MinGW
49#ifndef MAPVK_VK_TO_VSC
50#define MAPVK_VK_TO_VSC 0
51#endif
52
Pierre Ossmand50b3d12011-04-15 07:46:56 +000053#include "Viewport.h"
54#include "CConn.h"
Pierre Ossmand463b572011-05-16 12:04:43 +000055#include "OptionsDialog.h"
Pierre Ossman947b48d2014-01-27 16:52:35 +010056#include "DesktopWindow.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000057#include "i18n.h"
Pierre Ossmanc628ba42011-05-23 12:21:21 +000058#include "fltk_layout.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000059#include "parameters.h"
60#include "keysym2ucs.h"
Martin Koegler498ef462011-09-04 07:04:43 +000061#include "menukey.h"
Pierre Ossman39ceb502011-07-12 15:54:25 +000062#include "vncviewer.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000063
Pierre Ossmanac13abe2014-02-07 14:46:26 +010064#include "PlatformPixelBuffer.h"
Pierre Ossman947b48d2014-01-27 16:52:35 +010065
DRCb65bb932011-06-24 03:17:00 +000066#include <FL/fl_draw.H>
67#include <FL/fl_ask.H>
68
Pierre Ossman769963f2014-01-20 14:43:52 +010069#include <FL/Fl_Menu.H>
70#include <FL/Fl_Menu_Button.H>
71
Pierre Ossman6b743d02014-07-21 16:48:43 +020072#ifdef __APPLE__
73#include "cocoa.h"
74#endif
75
DRCb65bb932011-06-24 03:17:00 +000076#ifdef WIN32
77#include "win32.h"
78#endif
79
Pierre Ossman6b743d02014-07-21 16:48:43 +020080
Pierre Ossmand50b3d12011-04-15 07:46:56 +000081using namespace rfb;
Pierre Ossman835b4ef2011-06-08 17:02:36 +000082using namespace rdr;
Pierre Ossmand50b3d12011-04-15 07:46:56 +000083
Pierre Ossmand50b3d12011-04-15 07:46:56 +000084static rfb::LogWriter vlog("Viewport");
85
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000086// Menu constants
87
Joel Teichroeba7494ac2015-07-13 14:46:22 -070088enum { ID_EXIT, ID_FULLSCREEN, ID_MINIMIZE, ID_RESIZE,
Pierre Ossman8dc8bca2012-07-04 11:37:10 +000089 ID_CTRL, ID_ALT, ID_MENUKEY, ID_CTRLALTDEL,
Pierre Ossman2eb1d112011-05-16 12:18:08 +000090 ID_REFRESH, ID_OPTIONS, ID_INFO, ID_ABOUT, ID_DISMISS };
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000091
Pierre Ossman25188c42014-07-21 16:30:08 +020092// Fake key presses use this value and above
93static const int fakeKeyBase = 0x200;
94
Pierre Ossmand50b3d12011-04-15 07:46:56 +000095Viewport::Viewport(int w, int h, const rfb::PixelFormat& serverPF, CConn* cc_)
Pierre Ossman0c9bd4b2014-07-09 16:44:11 +020096 : Fl_Widget(0, 0, w, h), cc(cc_), frameBuffer(NULL),
Pierre Ossmanb6b4dc62014-01-20 15:05:21 +010097 lastPointerPos(0, 0), lastButtonMask(0),
Pierre Ossmanb1cd6ca2015-03-03 16:37:43 +010098 menuCtrlKey(false), menuAltKey(false), cursor(NULL)
Pierre Ossmand50b3d12011-04-15 07:46:56 +000099{
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000100 Fl::add_clipboard_notify(handleClipboardChange, this);
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000101
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200102 // We need to intercept keyboard events early
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200103 Fl::add_system_handler(handleSystemEvent, this);
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200104
Pierre Ossman403ac272017-01-02 17:00:41 +0100105 frameBuffer = new PlatformPixelBuffer(w, h);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000106 assert(frameBuffer);
Pierre Ossman9f273e92015-11-09 16:34:54 +0100107 cc->setFramebuffer(frameBuffer);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000108
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000109 contextMenu = new Fl_Menu_Button(0, 0, 0, 0);
Pierre Ossmanad9d1ae2011-05-26 14:16:02 +0000110 // Setting box type to FL_NO_BOX prevents it from trying to draw the
111 // button component (which we don't want)
112 contextMenu->box(FL_NO_BOX);
113
Pierre Ossmanb043ad12011-06-01 09:26:57 +0000114 // The (invisible) button associated with this widget can mess with
115 // things like Fl_Scroll so we need to get rid of any parents.
116 // Unfortunately that's not possible because of STR #2654, but
117 // reparenting to the current window works for most cases.
118 window()->add(contextMenu);
119
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000120 setMenuKey();
121
122 OptionsDialog::addCallback(handleOptions, this);
Pierre Ossmande673132011-11-10 14:59:24 +0000123
124 // Send a fake pointer event so that the server will stop rendering
125 // a server-side cursor. Ideally we'd like to send the actual pointer
126 // position, but we can't really tell when the window manager is done
127 // placing us so we don't have a good time for that.
128 handlePointerEvent(Point(w/2, h/2), 0);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000129}
130
131
132Viewport::~Viewport()
133{
134 // Unregister all timeouts in case they get a change tro trigger
135 // again later when this object is already gone.
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000136 Fl::remove_timeout(handlePointerTimeout, this);
137
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200138 Fl::remove_system_handler(handleSystemEvent);
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200139
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000140 Fl::remove_clipboard_notify(handleClipboardChange);
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000141
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000142 OptionsDialog::removeCallback(handleOptions);
143
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000144 if (cursor) {
Pierre Ossmanf741d342011-06-09 08:32:49 +0000145 if (!cursor->alloc_array)
146 delete [] cursor->array;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000147 delete cursor;
148 }
149
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000150 // FLTK automatically deletes all child widgets, so we shouldn't touch
151 // them ourselves here
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000152}
153
154
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000155const rfb::PixelFormat &Viewport::getPreferredPF()
156{
Pierre Ossman132b3d02011-06-13 11:19:32 +0000157 return frameBuffer->getPF();
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000158}
159
160
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000161// Copy the areas of the framebuffer that have been changed (damaged)
162// to the displayed window.
163
164void Viewport::updateWindow()
165{
166 Rect r;
167
Pierre Ossman0c9bd4b2014-07-09 16:44:11 +0200168 r = frameBuffer->getDamage();
169 damage(FL_DAMAGE_USER1, r.tl.x + x(), r.tl.y + y(), r.width(), r.height());
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000170}
171
Pierre Ossmanf741d342011-06-09 08:32:49 +0000172static const char * dotcursor_xpm[] = {
173 "5 5 2 1",
174 ". c #000000",
175 " c #FFFFFF",
176 " ",
177 " ... ",
178 " ... ",
179 " ... ",
180 " "};
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000181
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000182void Viewport::setCursor(int width, int height, const Point& hotspot,
Pierre Ossman6a1a0d02017-02-19 15:48:17 +0100183 const rdr::U8* data)
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000184{
Pierre Ossman6a1a0d02017-02-19 15:48:17 +0100185 int i;
186
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000187 if (cursor) {
Pierre Ossmanf741d342011-06-09 08:32:49 +0000188 if (!cursor->alloc_array)
189 delete [] cursor->array;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000190 delete cursor;
191 }
192
Pierre Ossman6a1a0d02017-02-19 15:48:17 +0100193 for (i = 0; i < width*height; i++)
194 if (data[i*4 + 3] != 0) break;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000195
Pierre Ossman6a1a0d02017-02-19 15:48:17 +0100196 if ((i == width*height) && dotWhenNoCursor) {
Pierre Ossmana51574a2011-06-09 08:39:35 +0000197 vlog.debug("cursor is empty - using dot");
Pierre Ossmanf741d342011-06-09 08:32:49 +0000198
199 Fl_Pixmap pxm(dotcursor_xpm);
200 cursor = new Fl_RGB_Image(&pxm);
201 cursorHotspot.x = cursorHotspot.y = 2;
202 } else {
Pierre Ossman17a48f02011-06-09 08:42:04 +0000203 if ((width == 0) || (height == 0)) {
204 U8 *buffer = new U8[4];
205 memset(buffer, 0, 4);
206 cursor = new Fl_RGB_Image(buffer, 1, 1, 4);
207 cursorHotspot.x = cursorHotspot.y = 0;
208 } else {
Pierre Ossman6a1a0d02017-02-19 15:48:17 +0100209 U8 *buffer = new U8[width * height * 4];
210 memcpy(buffer, data, width * height * 4);
Pierre Ossman17a48f02011-06-09 08:42:04 +0000211 cursor = new Fl_RGB_Image(buffer, width, height, 4);
Pierre Ossman17a48f02011-06-09 08:42:04 +0000212 cursorHotspot = hotspot;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000213 }
Pierre Ossmanf741d342011-06-09 08:32:49 +0000214 }
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000215
216 if (Fl::belowmouse() == this)
217 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000218}
219
220
Pierre Ossman3d74d882017-01-02 19:49:52 +0100221void Viewport::draw(Surface* dst)
222{
223 int X, Y, W, H;
224
225 // Check what actually needs updating
226 fl_clip_box(x(), y(), w(), h(), X, Y, W, H);
227 if ((W == 0) || (H == 0))
228 return;
229
230 frameBuffer->draw(dst, X - x(), Y - y(), X, Y, W, H);
231}
232
233
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000234void Viewport::draw()
235{
236 int X, Y, W, H;
237
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000238 // Check what actually needs updating
Pierre Ossmana6e20772011-04-15 11:10:52 +0000239 fl_clip_box(x(), y(), w(), h(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000240 if ((W == 0) || (H == 0))
241 return;
242
Pierre Ossman132b3d02011-06-13 11:19:32 +0000243 frameBuffer->draw(X - x(), Y - y(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000244}
245
246
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000247void Viewport::resize(int x, int y, int w, int h)
248{
Pierre Ossman9f273e92015-11-09 16:34:54 +0100249 if ((w != frameBuffer->width()) || (h != frameBuffer->height())) {
250 vlog.debug("Resizing framebuffer from %dx%d to %dx%d",
251 frameBuffer->width(), frameBuffer->height(), w, h);
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000252
Pierre Ossman403ac272017-01-02 17:00:41 +0100253 frameBuffer = new PlatformPixelBuffer(w, h);
Pierre Ossman9f273e92015-11-09 16:34:54 +0100254 assert(frameBuffer);
255 cc->setFramebuffer(frameBuffer);
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000256 }
257
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000258 Fl_Widget::resize(x, y, w, h);
259}
260
261
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000262int Viewport::handle(int event)
263{
Pierre Ossman689c4582011-05-26 15:39:41 +0000264 char *buffer;
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000265 int ret;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000266 int buttonMask, wheelMask;
267 DownMap::const_iterator iter;
268
269 switch (event) {
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000270 case FL_PASTE:
Pierre Ossman689c4582011-05-26 15:39:41 +0000271 buffer = new char[Fl::event_length() + 1];
272
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000273 // This is documented as to ASCII, but actually does to 8859-1
Pierre Ossman689c4582011-05-26 15:39:41 +0000274 ret = fl_utf8toa(Fl::event_text(), Fl::event_length(), buffer,
275 Fl::event_length() + 1);
276 assert(ret < (Fl::event_length() + 1));
277
Pierre Ossmanfb450fb2015-03-03 16:34:56 +0100278 vlog.debug("Sending clipboard data (%d bytes)", (int)strlen(buffer));
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000279
280 try {
281 cc->writer()->clientCutText(buffer, ret);
282 } catch (rdr::Exception& e) {
Pierre Ossmanad8609a2012-04-26 09:04:14 +0000283 vlog.error("%s", e.str());
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000284 exit_vncviewer(e.str());
285 }
Pierre Ossman689c4582011-05-26 15:39:41 +0000286
287 delete [] buffer;
288
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000289 return 1;
Pierre Ossman689c4582011-05-26 15:39:41 +0000290
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000291 case FL_ENTER:
Pierre Ossman1f1f6fd2011-06-09 08:33:29 +0000292 if (cursor)
293 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossman56610fb2015-01-27 16:28:15 +0100294 // Yes, we would like some pointer events please!
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000295 return 1;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000296
297 case FL_LEAVE:
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000298 window()->cursor(FL_CURSOR_DEFAULT);
Pierre Ossman164865a2011-11-10 13:30:39 +0000299 // Fall through as we want a last move event to help trigger edge stuff
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000300 case FL_PUSH:
301 case FL_RELEASE:
302 case FL_DRAG:
303 case FL_MOVE:
304 case FL_MOUSEWHEEL:
305 buttonMask = 0;
306 if (Fl::event_button1())
307 buttonMask |= 1;
308 if (Fl::event_button2())
309 buttonMask |= 2;
310 if (Fl::event_button3())
311 buttonMask |= 4;
312
313 if (event == FL_MOUSEWHEEL) {
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000314 wheelMask = 0;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000315 if (Fl::event_dy() < 0)
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000316 wheelMask |= 8;
317 if (Fl::event_dy() > 0)
318 wheelMask |= 16;
319 if (Fl::event_dx() < 0)
320 wheelMask |= 32;
321 if (Fl::event_dx() > 0)
322 wheelMask |= 64;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000323
324 // A quick press of the wheel "button", followed by a immediate
325 // release below
Pierre Ossman6a464be2011-04-15 12:57:31 +0000326 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()),
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000327 buttonMask | wheelMask);
328 }
329
Pierre Ossman6a464be2011-04-15 12:57:31 +0000330 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()), buttonMask);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000331 return 1;
332
333 case FL_FOCUS:
Pierre Ossman48ef54d2014-08-19 14:08:04 +0200334 Fl::disable_im();
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000335 // Yes, we would like some focus please!
336 return 1;
337
338 case FL_UNFOCUS:
339 // Release all keys that were pressed as that generally makes most
340 // sense (e.g. Alt+Tab where we only see the Alt press)
Pierre Ossmanf8450ca2011-07-12 16:10:16 +0000341 while (!downKeySym.empty())
Pierre Ossman25188c42014-07-21 16:30:08 +0200342 handleKeyRelease(downKeySym.begin()->first);
Pierre Ossman48ef54d2014-08-19 14:08:04 +0200343 Fl::enable_im();
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000344 return 1;
345
346 case FL_KEYDOWN:
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000347 case FL_KEYUP:
Pierre Ossman56610fb2015-01-27 16:28:15 +0100348 // Just ignore these as keys were handled in the event handler
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000349 return 1;
350 }
351
352 return Fl_Widget::handle(event);
353}
354
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000355void Viewport::handleClipboardChange(int source, void *data)
356{
357 Viewport *self = (Viewport *)data;
358
359 assert(self);
360
Pierre Ossmana432b582017-01-02 15:16:58 +0100361 if (!sendClipboard)
362 return;
363
Pierre Ossmanf7fef922015-12-10 21:24:08 +0100364#if !defined(WIN32) && !defined(__APPLE__)
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000365 if (!sendPrimary && (source == 0))
366 return;
Pierre Ossmanf7fef922015-12-10 21:24:08 +0100367#endif
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000368
369 Fl::paste(*self, source);
370}
371
372
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000373void Viewport::handlePointerEvent(const rfb::Point& pos, int buttonMask)
374{
375 if (!viewOnly) {
376 if (pointerEventInterval == 0 || buttonMask != lastButtonMask) {
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000377 try {
378 cc->writer()->pointerEvent(pos, buttonMask);
379 } catch (rdr::Exception& e) {
Pierre Ossmanad8609a2012-04-26 09:04:14 +0000380 vlog.error("%s", e.str());
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000381 exit_vncviewer(e.str());
382 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000383 } else {
384 if (!Fl::has_timeout(handlePointerTimeout, this))
385 Fl::add_timeout((double)pointerEventInterval/1000.0,
386 handlePointerTimeout, this);
387 }
388 lastPointerPos = pos;
389 lastButtonMask = buttonMask;
390 }
391}
392
393
394void Viewport::handlePointerTimeout(void *data)
395{
396 Viewport *self = (Viewport *)data;
397
398 assert(self);
399
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000400 try {
401 self->cc->writer()->pointerEvent(self->lastPointerPos, self->lastButtonMask);
402 } catch (rdr::Exception& e) {
Pierre Ossmanad8609a2012-04-26 09:04:14 +0000403 vlog.error("%s", e.str());
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000404 exit_vncviewer(e.str());
405 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000406}
407
408
Pierre Ossman25188c42014-07-21 16:30:08 +0200409void Viewport::handleKeyPress(int keyCode, rdr::U32 keySym)
410{
411 static bool menuRecursion = false;
412
413 // Prevent recursion if the menu wants to send its own
414 // activation key.
415 if (menuKeySym && (keySym == menuKeySym) && !menuRecursion) {
416 menuRecursion = true;
417 popupContextMenu();
418 menuRecursion = false;
419 return;
420 }
421
422 if (viewOnly)
423 return;
424
425#ifdef __APPLE__
426 // Alt on OS X behaves more like AltGr on other systems, and to get
427 // sane behaviour we should translate things in that manner for the
428 // remote VNC server. However that means we lose the ability to use
429 // Alt as a shortcut modifier. Do what RealVNC does and hijack the
430 // left command key as an Alt replacement.
431 switch (keySym) {
432 case XK_Super_L:
433 keySym = XK_Alt_L;
434 break;
435 case XK_Super_R:
436 keySym = XK_Super_L;
437 break;
438 case XK_Alt_L:
Pierre Ossman38fcebb2014-08-21 13:44:28 +0200439 keySym = XK_Mode_switch;
440 break;
Pierre Ossman25188c42014-07-21 16:30:08 +0200441 case XK_Alt_R:
442 keySym = XK_ISO_Level3_Shift;
443 break;
444 }
445#endif
446
447#ifdef WIN32
448 // Ugly hack alert!
449 //
450 // Windows doesn't have a proper AltGr, but handles it using fake
451 // Ctrl+Alt. Unfortunately X11 doesn't generally like the combination
452 // Ctrl+Alt+AltGr, which we usually end up with when Xvnc tries to
453 // get everything in the correct state. Cheat and temporarily release
454 // Ctrl and Alt when we send some other symbol.
455 bool ctrlPressed, altPressed;
456 DownMap::iterator iter;
457
458 ctrlPressed = false;
459 altPressed = false;
460 for (iter = downKeySym.begin();iter != downKeySym.end();++iter) {
461 if (iter->second == XK_Control_L)
462 ctrlPressed = true;
463 else if (iter->second == XK_Alt_R)
464 altPressed = true;
465 }
466
467 if (ctrlPressed && altPressed) {
468 vlog.debug("Faking release of AltGr (Ctrl_L+Alt_R)");
469 try {
470 cc->writer()->keyEvent(XK_Control_L, false);
471 cc->writer()->keyEvent(XK_Alt_R, false);
472 } catch (rdr::Exception& e) {
473 vlog.error("%s", e.str());
474 exit_vncviewer(e.str());
475 }
476 }
477#endif
478
479 // Because of the way keyboards work, we cannot expect to have the same
480 // symbol on release as when pressed. This breaks the VNC protocol however,
481 // so we need to keep track of what keysym a key _code_ generated on press
482 // and send the same on release.
483 downKeySym[keyCode] = keySym;
484
485#if defined(WIN32) || defined(__APPLE__)
486 vlog.debug("Key pressed: 0x%04x => 0x%04x", keyCode, keySym);
487#else
488 vlog.debug("Key pressed: 0x%04x => XK_%s (0x%04x)",
489 keyCode, XKeysymToString(keySym), keySym);
490#endif
491
492 try {
493 cc->writer()->keyEvent(keySym, true);
494 } catch (rdr::Exception& e) {
495 vlog.error("%s", e.str());
496 exit_vncviewer(e.str());
497 }
498
499#ifdef WIN32
500 // Ugly hack continued...
501 if (ctrlPressed && altPressed) {
502 vlog.debug("Restoring AltGr state");
503 try {
504 cc->writer()->keyEvent(XK_Control_L, true);
505 cc->writer()->keyEvent(XK_Alt_R, true);
506 } catch (rdr::Exception& e) {
507 vlog.error("%s", e.str());
508 exit_vncviewer(e.str());
509 }
510 }
511#endif
512}
513
514
515void Viewport::handleKeyRelease(int keyCode)
516{
517 DownMap::iterator iter;
518
519 if (viewOnly)
520 return;
521
522 iter = downKeySym.find(keyCode);
523 if (iter == downKeySym.end()) {
524 // These occur somewhat frequently so let's not spam them unless
525 // logging is turned up.
526 vlog.debug("Unexpected release of key code %d", keyCode);
527 return;
528 }
529
530#if defined(WIN32) || defined(__APPLE__)
531 vlog.debug("Key released: 0x%04x => 0x%04x", keyCode, iter->second);
532#else
533 vlog.debug("Key released: 0x%04x => XK_%s (0x%04x)",
534 keyCode, XKeysymToString(iter->second), iter->second);
535#endif
536
537 try {
538 cc->writer()->keyEvent(iter->second, false);
539 } catch (rdr::Exception& e) {
540 vlog.error("%s", e.str());
541 exit_vncviewer(e.str());
542 }
543
544 downKeySym.erase(iter);
545}
546
547
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200548int Viewport::handleSystemEvent(void *event, void *data)
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200549{
550 Viewport *self = (Viewport *)data;
551 Fl_Widget *focus;
552
553 assert(self);
554
555 focus = Fl::grab();
556 if (!focus)
557 focus = Fl::focus();
558 if (!focus)
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200559 return 0;
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200560
561 if (focus != self)
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200562 return 0;
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200563
564 assert(event);
565
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200566#if defined(WIN32)
567 MSG *msg = (MSG*)event;
568
569 if ((msg->message == WM_KEYDOWN) || (msg->message == WM_SYSKEYDOWN)) {
570 UINT vKey;
571 bool isExtended;
572 int keyCode;
573 rdr::U32 keySym;
574
575 vKey = msg->wParam;
576 isExtended = (msg->lParam & (1 << 24)) != 0;
577
578 keyCode = ((msg->lParam >> 16) & 0xff);
579
580 // Windows sets the scan code to 0x00 for multimedia keys, so we
581 // have to do a reverse lookup based on the vKey.
582 if (keyCode == 0x00) {
583 keyCode = MapVirtualKey(vKey, MAPVK_VK_TO_VSC);
584 if (keyCode == 0x00) {
Pierre Ossmanf05f3552014-09-22 12:19:52 +0200585 if (isExtended)
586 vlog.error(_("No scan code for extended virtual key 0x%02x"), (int)vKey);
587 else
588 vlog.error(_("No scan code for virtual key 0x%02x"), (int)vKey);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200589 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200590 }
591 }
592
593 if (isExtended)
594 keyCode |= 0x100;
595
Pierre Ossmana7d3dc72014-09-30 17:03:28 +0200596 // VK_SNAPSHOT sends different scan codes depending on the state of
597 // Alt. This means that we can get different scan codes on press and
598 // release. Force it to be something standard.
599 if (vKey == VK_SNAPSHOT)
600 keyCode = 0x137;
601
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200602 keySym = win32_vkey_to_keysym(vKey, isExtended);
603 if (keySym == NoSymbol) {
Pierre Ossmanf05f3552014-09-22 12:19:52 +0200604 if (isExtended)
605 vlog.error(_("No symbol for extended virtual key 0x%02x"), (int)vKey);
606 else
607 vlog.error(_("No symbol for virtual key 0x%02x"), (int)vKey);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200608 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200609 }
610
611 self->handleKeyPress(keyCode, keySym);
612
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200613 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200614 } else if ((msg->message == WM_KEYUP) || (msg->message == WM_SYSKEYUP)) {
615 UINT vKey;
616 bool isExtended;
617 int keyCode;
618
619 vKey = msg->wParam;
620 isExtended = (msg->lParam & (1 << 24)) != 0;
621
622 keyCode = ((msg->lParam >> 16) & 0xff);
623 if (keyCode == 0x00)
624 keyCode = MapVirtualKey(vKey, MAPVK_VK_TO_VSC);
625 if (isExtended)
626 keyCode |= 0x100;
Pierre Ossmana7d3dc72014-09-30 17:03:28 +0200627 if (vKey == VK_SNAPSHOT)
628 keyCode = 0x137;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200629
630 self->handleKeyRelease(keyCode);
631
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200632 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200633 }
Pierre Ossman6b743d02014-07-21 16:48:43 +0200634#elif defined(__APPLE__)
635 if (cocoa_is_keyboard_event(event)) {
636 int keyCode;
637
638 keyCode = cocoa_event_keycode(event);
639
640 if (cocoa_is_key_press(event)) {
641 rdr::U32 keySym;
642
643 keySym = cocoa_event_keysym(event);
644 if (keySym == NoSymbol) {
645 vlog.error(_("No symbol for key code 0x%02x (in the current state)"),
646 (int)keyCode);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200647 return 1;
Pierre Ossman6b743d02014-07-21 16:48:43 +0200648 }
649
650 self->handleKeyPress(keyCode, keySym);
651
652 // We don't get any release events for CapsLock, so we have to
653 // send the release right away.
654 if (keySym == XK_Caps_Lock)
655 self->handleKeyRelease(keyCode);
656 } else {
657 self->handleKeyRelease(keyCode);
658 }
659
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200660 return 1;
Pierre Ossman6b743d02014-07-21 16:48:43 +0200661 }
662#else
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200663 XEvent *xevent = (XEvent*)event;
664
665 if (xevent->type == KeyPress) {
666 char str;
667 KeySym keysym;
668
669 XLookupString(&xevent->xkey, &str, 1, &keysym, NULL);
670 if (keysym == NoSymbol) {
671 vlog.error(_("No symbol for key code %d (in the current state)"),
672 (int)xevent->xkey.keycode);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200673 return 1;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200674 }
675
676 switch (keysym) {
677 // For the first few years, there wasn't a good consensus on what the
678 // Windows keys should be mapped to for X11. So we need to help out a
679 // bit and map all variants to the same key...
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200680 case XK_Hyper_L:
681 keysym = XK_Super_L;
682 break;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200683 case XK_Hyper_R:
684 keysym = XK_Super_R;
685 break;
686 // There has been several variants for Shift-Tab over the years.
687 // RFB states that we should always send a normal tab.
688 case XK_ISO_Left_Tab:
689 keysym = XK_Tab;
690 break;
691 }
692
693 self->handleKeyPress(xevent->xkey.keycode, keysym);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200694 return 1;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200695 } else if (xevent->type == KeyRelease) {
696 self->handleKeyRelease(xevent->xkey.keycode);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200697 return 1;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200698 }
699#endif
700
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200701 return 0;
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200702}
703
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000704void Viewport::initContextMenu()
705{
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100706 contextMenu->clear();
707
Pierre Ossmanff626f82015-09-23 16:39:54 +0200708 fltk_menu_add(contextMenu, p_("ContextMenu|", "E&xit viewer"),
709 0, NULL, (void*)ID_EXIT, FL_MENU_DIVIDER);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000710
Pierre Ossmanff626f82015-09-23 16:39:54 +0200711 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Full screen"),
712 0, NULL, (void*)ID_FULLSCREEN,
Pierre Ossman245c8022015-02-25 11:27:49 +0100713 FL_MENU_TOGGLE | (window()->fullscreen_active()?FL_MENU_VALUE:0));
Pierre Ossmanff626f82015-09-23 16:39:54 +0200714 fltk_menu_add(contextMenu, p_("ContextMenu|", "Minimi&ze"),
715 0, NULL, (void*)ID_MINIMIZE, 0);
716 fltk_menu_add(contextMenu, p_("ContextMenu|", "Resize &window to session"),
717 0, NULL, (void*)ID_RESIZE,
Pierre Ossman245c8022015-02-25 11:27:49 +0100718 (window()->fullscreen_active()?FL_MENU_INACTIVE:0) |
Pierre Ossman245c8022015-02-25 11:27:49 +0100719 FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100720
Pierre Ossmanff626f82015-09-23 16:39:54 +0200721 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Ctrl"),
722 0, NULL, (void*)ID_CTRL,
Pierre Ossman245c8022015-02-25 11:27:49 +0100723 FL_MENU_TOGGLE | (menuCtrlKey?FL_MENU_VALUE:0));
Pierre Ossmanff626f82015-09-23 16:39:54 +0200724 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Alt"),
725 0, NULL, (void*)ID_ALT,
Pierre Ossman245c8022015-02-25 11:27:49 +0100726 FL_MENU_TOGGLE | (menuAltKey?FL_MENU_VALUE:0));
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100727
728 if (menuKeySym) {
729 char sendMenuKey[64];
Pierre Ossmanff626f82015-09-23 16:39:54 +0200730 snprintf(sendMenuKey, 64, p_("ContextMenu|", "Send %s"), (const char *)menuKey);
Pierre Ossman245c8022015-02-25 11:27:49 +0100731 fltk_menu_add(contextMenu, sendMenuKey, 0, NULL, (void*)ID_MENUKEY, 0);
732 fltk_menu_add(contextMenu, "Secret shortcut menu key", menuKeyCode, NULL,
733 (void*)ID_MENUKEY, FL_MENU_INVISIBLE);
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000734 }
735
Pierre Ossmanff626f82015-09-23 16:39:54 +0200736 fltk_menu_add(contextMenu, p_("ContextMenu|", "Send Ctrl-Alt-&Del"),
737 0, NULL, (void*)ID_CTRLALTDEL, FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100738
Pierre Ossmanff626f82015-09-23 16:39:54 +0200739 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Refresh screen"),
740 0, NULL, (void*)ID_REFRESH, FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100741
Pierre Ossmanff626f82015-09-23 16:39:54 +0200742 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Options..."),
743 0, NULL, (void*)ID_OPTIONS, 0);
744 fltk_menu_add(contextMenu, p_("ContextMenu|", "Connection &info..."),
745 0, NULL, (void*)ID_INFO, 0);
746 fltk_menu_add(contextMenu, p_("ContextMenu|", "About &TigerVNC viewer..."),
747 0, NULL, (void*)ID_ABOUT, FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100748
Pierre Ossmanff626f82015-09-23 16:39:54 +0200749 fltk_menu_add(contextMenu, p_("ContextMenu|", "Dismiss &menu"),
750 0, NULL, (void*)ID_DISMISS, 0);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000751}
752
753
754void Viewport::popupContextMenu()
755{
756 const Fl_Menu_Item *m;
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000757 char buffer[1024];
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000758
Pierre Ossmanb3ff4372011-06-03 11:45:15 +0000759 // Make sure the menu is reset to its initial state between goes or
760 // it will start up highlighting the previously selected entry.
761 contextMenu->value(-1);
762
Henrik Anderssonabd70ce2011-09-14 06:31:06 +0000763 // initialize context menu before display
764 initContextMenu();
765
Pierre Ossmanfd177f32012-01-05 12:37:04 +0000766 // Unfortunately FLTK doesn't reliably restore the mouse pointer for
767 // menus, so we have to help it out.
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000768 if (Fl::belowmouse() == this)
769 window()->cursor(FL_CURSOR_DEFAULT);
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000770
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000771 m = contextMenu->popup();
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000772
Pierre Ossmanfd177f32012-01-05 12:37:04 +0000773 // Back to our proper mouse pointer.
Pierre Ossmande1a3b92014-03-17 14:29:49 +0100774 if ((Fl::belowmouse() == this) && cursor)
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000775 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000776
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000777 if (m == NULL)
778 return;
779
780 switch (m->argument()) {
781 case ID_EXIT:
782 exit_vncviewer();
783 break;
Pierre Ossman4c613d32011-05-26 14:14:06 +0000784 case ID_FULLSCREEN:
785 if (window()->fullscreen_active())
786 window()->fullscreen_off();
Pierre Ossman275284f2012-07-04 11:37:48 +0000787 else
Pierre Ossmanaae38912012-07-13 11:22:55 +0000788 ((DesktopWindow*)window())->fullscreen_on();
Pierre Ossman4c613d32011-05-26 14:14:06 +0000789 break;
Joel Teichroeba7494ac2015-07-13 14:46:22 -0700790 case ID_MINIMIZE:
791 window()->iconize();
Joel Teichroeb1f9e45a2015-07-18 07:09:24 -0700792 break;
Pierre Ossman8dc8bca2012-07-04 11:37:10 +0000793 case ID_RESIZE:
Pierre Ossman8dc8bca2012-07-04 11:37:10 +0000794 if (window()->fullscreen_active())
795 break;
Pierre Ossman8dc8bca2012-07-04 11:37:10 +0000796 window()->size(w(), h());
797 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000798 case ID_CTRL:
Pierre Ossman25188c42014-07-21 16:30:08 +0200799 if (m->value())
800 handleKeyPress(fakeKeyBase + 0, XK_Control_L);
801 else
802 handleKeyRelease(fakeKeyBase + 0);
Henrik Anderssonabd70ce2011-09-14 06:31:06 +0000803 menuCtrlKey = !menuCtrlKey;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000804 break;
805 case ID_ALT:
Pierre Ossman25188c42014-07-21 16:30:08 +0200806 if (m->value())
807 handleKeyPress(fakeKeyBase + 1, XK_Alt_L);
808 else
809 handleKeyRelease(fakeKeyBase + 1);
Henrik Anderssonabd70ce2011-09-14 06:31:06 +0000810 menuAltKey = !menuAltKey;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000811 break;
812 case ID_MENUKEY:
Pierre Ossman25188c42014-07-21 16:30:08 +0200813 handleKeyPress(fakeKeyBase + 2, menuKeySym);
814 handleKeyRelease(fakeKeyBase + 2);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000815 break;
816 case ID_CTRLALTDEL:
Pierre Ossman25188c42014-07-21 16:30:08 +0200817 handleKeyPress(fakeKeyBase + 3, XK_Control_L);
818 handleKeyPress(fakeKeyBase + 4, XK_Alt_L);
819 handleKeyPress(fakeKeyBase + 5, XK_Delete);
Pierre Ossman991b4fe2011-07-12 16:02:30 +0000820
Pierre Ossman25188c42014-07-21 16:30:08 +0200821 handleKeyRelease(fakeKeyBase + 5);
822 handleKeyRelease(fakeKeyBase + 4);
823 handleKeyRelease(fakeKeyBase + 3);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000824 break;
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000825 case ID_REFRESH:
826 cc->refreshFramebuffer();
827 break;
Pierre Ossmand463b572011-05-16 12:04:43 +0000828 case ID_OPTIONS:
829 OptionsDialog::showDialog();
830 break;
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000831 case ID_INFO:
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000832 if (fltk_escape(cc->connectionInfo(), buffer, sizeof(buffer)) < sizeof(buffer)) {
833 fl_message_title(_("VNC connection info"));
Pierre Ossmanf52740e2012-04-25 15:43:56 +0000834 fl_message("%s", buffer);
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000835 }
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000836 break;
Pierre Ossmanb8858222011-04-29 11:51:38 +0000837 case ID_ABOUT:
838 about_vncviewer();
839 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000840 case ID_DISMISS:
841 // Don't need to do anything
842 break;
843 }
844}
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000845
846
847void Viewport::setMenuKey()
848{
Pierre Ossman25188c42014-07-21 16:30:08 +0200849 getMenuKey(&menuKeyCode, &menuKeySym);
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000850}
851
852
853void Viewport::handleOptions(void *data)
854{
855 Viewport *self = (Viewport*)data;
856
857 self->setMenuKey();
858}