blob: 7b3487c4686169b84a61d7965fc1e4442dca6767 [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,
183 void* data, void* mask)
184{
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000185 if (cursor) {
Pierre Ossmanf741d342011-06-09 08:32:49 +0000186 if (!cursor->alloc_array)
187 delete [] cursor->array;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000188 delete cursor;
189 }
190
Pierre Ossmanf741d342011-06-09 08:32:49 +0000191 int mask_len = ((width+7)/8) * height;
192 int i;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000193
Pierre Ossmanf741d342011-06-09 08:32:49 +0000194 for (i = 0; i < mask_len; i++)
195 if (((rdr::U8*)mask)[i]) break;
196
Pierre Ossmana51574a2011-06-09 08:39:35 +0000197 if ((i == mask_len) && dotWhenNoCursor) {
198 vlog.debug("cursor is empty - using dot");
Pierre Ossmanf741d342011-06-09 08:32:49 +0000199
200 Fl_Pixmap pxm(dotcursor_xpm);
201 cursor = new Fl_RGB_Image(&pxm);
202 cursorHotspot.x = cursorHotspot.y = 2;
203 } else {
Pierre Ossman17a48f02011-06-09 08:42:04 +0000204 if ((width == 0) || (height == 0)) {
205 U8 *buffer = new U8[4];
206 memset(buffer, 0, 4);
207 cursor = new Fl_RGB_Image(buffer, 1, 1, 4);
208 cursorHotspot.x = cursorHotspot.y = 0;
209 } else {
210 U8 *buffer = new U8[width*height*4];
211 U8 *i, *o, *m;
212 int m_width;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000213
Pierre Ossmand8f84872011-07-15 08:26:51 +0000214 const PixelFormat *pf;
215
Pierre Ossman0c9bd4b2014-07-09 16:44:11 +0200216 pf = &cc->cp.pf();
Pierre Ossmanf741d342011-06-09 08:32:49 +0000217
Pierre Ossman17a48f02011-06-09 08:42:04 +0000218 i = (U8*)data;
219 o = buffer;
220 m = (U8*)mask;
221 m_width = (width+7)/8;
222 for (int y = 0;y < height;y++) {
223 for (int x = 0;x < width;x++) {
Pierre Ossmanb6b4dc62014-01-20 15:05:21 +0100224 pf->rgbFromBuffer(o, i, 1);
Pierre Ossmanf741d342011-06-09 08:32:49 +0000225
Pierre Ossman17a48f02011-06-09 08:42:04 +0000226 if (m[(m_width*y)+(x/8)] & 0x80>>(x%8))
227 o[3] = 255;
228 else
229 o[3] = 0;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000230
Pierre Ossman17a48f02011-06-09 08:42:04 +0000231 o += 4;
Pierre Ossmand8f84872011-07-15 08:26:51 +0000232 i += pf->bpp/8;
Pierre Ossman17a48f02011-06-09 08:42:04 +0000233 }
Pierre Ossmanf741d342011-06-09 08:32:49 +0000234 }
Pierre Ossman17a48f02011-06-09 08:42:04 +0000235
236 cursor = new Fl_RGB_Image(buffer, width, height, 4);
237
238 cursorHotspot = hotspot;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000239 }
Pierre Ossmanf741d342011-06-09 08:32:49 +0000240 }
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000241
242 if (Fl::belowmouse() == this)
243 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000244}
245
246
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000247void Viewport::draw()
248{
249 int X, Y, W, H;
250
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000251 // Check what actually needs updating
Pierre Ossmana6e20772011-04-15 11:10:52 +0000252 fl_clip_box(x(), y(), w(), h(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000253 if ((W == 0) || (H == 0))
254 return;
255
Pierre Ossman132b3d02011-06-13 11:19:32 +0000256 frameBuffer->draw(X - x(), Y - y(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000257}
258
259
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000260void Viewport::resize(int x, int y, int w, int h)
261{
Pierre Ossman9f273e92015-11-09 16:34:54 +0100262 if ((w != frameBuffer->width()) || (h != frameBuffer->height())) {
263 vlog.debug("Resizing framebuffer from %dx%d to %dx%d",
264 frameBuffer->width(), frameBuffer->height(), w, h);
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000265
Pierre Ossman403ac272017-01-02 17:00:41 +0100266 frameBuffer = new PlatformPixelBuffer(w, h);
Pierre Ossman9f273e92015-11-09 16:34:54 +0100267 assert(frameBuffer);
268 cc->setFramebuffer(frameBuffer);
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000269 }
270
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000271 Fl_Widget::resize(x, y, w, h);
272}
273
274
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000275int Viewport::handle(int event)
276{
Pierre Ossman689c4582011-05-26 15:39:41 +0000277 char *buffer;
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000278 int ret;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000279 int buttonMask, wheelMask;
280 DownMap::const_iterator iter;
281
282 switch (event) {
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000283 case FL_PASTE:
Pierre Ossman689c4582011-05-26 15:39:41 +0000284 buffer = new char[Fl::event_length() + 1];
285
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000286 // This is documented as to ASCII, but actually does to 8859-1
Pierre Ossman689c4582011-05-26 15:39:41 +0000287 ret = fl_utf8toa(Fl::event_text(), Fl::event_length(), buffer,
288 Fl::event_length() + 1);
289 assert(ret < (Fl::event_length() + 1));
290
Pierre Ossmanfb450fb2015-03-03 16:34:56 +0100291 vlog.debug("Sending clipboard data (%d bytes)", (int)strlen(buffer));
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000292
293 try {
294 cc->writer()->clientCutText(buffer, ret);
295 } catch (rdr::Exception& e) {
Pierre Ossmanad8609a2012-04-26 09:04:14 +0000296 vlog.error("%s", e.str());
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000297 exit_vncviewer(e.str());
298 }
Pierre Ossman689c4582011-05-26 15:39:41 +0000299
300 delete [] buffer;
301
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000302 return 1;
Pierre Ossman689c4582011-05-26 15:39:41 +0000303
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000304 case FL_ENTER:
Pierre Ossman1f1f6fd2011-06-09 08:33:29 +0000305 if (cursor)
306 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossman56610fb2015-01-27 16:28:15 +0100307 // Yes, we would like some pointer events please!
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000308 return 1;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000309
310 case FL_LEAVE:
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000311 window()->cursor(FL_CURSOR_DEFAULT);
Pierre Ossman164865a2011-11-10 13:30:39 +0000312 // Fall through as we want a last move event to help trigger edge stuff
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000313 case FL_PUSH:
314 case FL_RELEASE:
315 case FL_DRAG:
316 case FL_MOVE:
317 case FL_MOUSEWHEEL:
318 buttonMask = 0;
319 if (Fl::event_button1())
320 buttonMask |= 1;
321 if (Fl::event_button2())
322 buttonMask |= 2;
323 if (Fl::event_button3())
324 buttonMask |= 4;
325
326 if (event == FL_MOUSEWHEEL) {
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000327 wheelMask = 0;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000328 if (Fl::event_dy() < 0)
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000329 wheelMask |= 8;
330 if (Fl::event_dy() > 0)
331 wheelMask |= 16;
332 if (Fl::event_dx() < 0)
333 wheelMask |= 32;
334 if (Fl::event_dx() > 0)
335 wheelMask |= 64;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000336
337 // A quick press of the wheel "button", followed by a immediate
338 // release below
Pierre Ossman6a464be2011-04-15 12:57:31 +0000339 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()),
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000340 buttonMask | wheelMask);
341 }
342
Pierre Ossman6a464be2011-04-15 12:57:31 +0000343 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()), buttonMask);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000344 return 1;
345
346 case FL_FOCUS:
Pierre Ossman48ef54d2014-08-19 14:08:04 +0200347 Fl::disable_im();
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000348 // Yes, we would like some focus please!
349 return 1;
350
351 case FL_UNFOCUS:
352 // Release all keys that were pressed as that generally makes most
353 // sense (e.g. Alt+Tab where we only see the Alt press)
Pierre Ossmanf8450ca2011-07-12 16:10:16 +0000354 while (!downKeySym.empty())
Pierre Ossman25188c42014-07-21 16:30:08 +0200355 handleKeyRelease(downKeySym.begin()->first);
Pierre Ossman48ef54d2014-08-19 14:08:04 +0200356 Fl::enable_im();
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000357 return 1;
358
359 case FL_KEYDOWN:
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000360 case FL_KEYUP:
Pierre Ossman56610fb2015-01-27 16:28:15 +0100361 // Just ignore these as keys were handled in the event handler
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000362 return 1;
363 }
364
365 return Fl_Widget::handle(event);
366}
367
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000368void Viewport::handleClipboardChange(int source, void *data)
369{
370 Viewport *self = (Viewport *)data;
371
372 assert(self);
373
Pierre Ossmana432b582017-01-02 15:16:58 +0100374 if (!sendClipboard)
375 return;
376
Pierre Ossmanf7fef922015-12-10 21:24:08 +0100377#if !defined(WIN32) && !defined(__APPLE__)
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000378 if (!sendPrimary && (source == 0))
379 return;
Pierre Ossmanf7fef922015-12-10 21:24:08 +0100380#endif
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000381
382 Fl::paste(*self, source);
383}
384
385
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000386void Viewport::handlePointerEvent(const rfb::Point& pos, int buttonMask)
387{
388 if (!viewOnly) {
389 if (pointerEventInterval == 0 || buttonMask != lastButtonMask) {
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000390 try {
391 cc->writer()->pointerEvent(pos, buttonMask);
392 } catch (rdr::Exception& e) {
Pierre Ossmanad8609a2012-04-26 09:04:14 +0000393 vlog.error("%s", e.str());
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000394 exit_vncviewer(e.str());
395 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000396 } else {
397 if (!Fl::has_timeout(handlePointerTimeout, this))
398 Fl::add_timeout((double)pointerEventInterval/1000.0,
399 handlePointerTimeout, this);
400 }
401 lastPointerPos = pos;
402 lastButtonMask = buttonMask;
403 }
404}
405
406
407void Viewport::handlePointerTimeout(void *data)
408{
409 Viewport *self = (Viewport *)data;
410
411 assert(self);
412
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000413 try {
414 self->cc->writer()->pointerEvent(self->lastPointerPos, self->lastButtonMask);
415 } catch (rdr::Exception& e) {
Pierre Ossmanad8609a2012-04-26 09:04:14 +0000416 vlog.error("%s", e.str());
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000417 exit_vncviewer(e.str());
418 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000419}
420
421
Pierre Ossman25188c42014-07-21 16:30:08 +0200422void Viewport::handleKeyPress(int keyCode, rdr::U32 keySym)
423{
424 static bool menuRecursion = false;
425
426 // Prevent recursion if the menu wants to send its own
427 // activation key.
428 if (menuKeySym && (keySym == menuKeySym) && !menuRecursion) {
429 menuRecursion = true;
430 popupContextMenu();
431 menuRecursion = false;
432 return;
433 }
434
435 if (viewOnly)
436 return;
437
438#ifdef __APPLE__
439 // Alt on OS X behaves more like AltGr on other systems, and to get
440 // sane behaviour we should translate things in that manner for the
441 // remote VNC server. However that means we lose the ability to use
442 // Alt as a shortcut modifier. Do what RealVNC does and hijack the
443 // left command key as an Alt replacement.
444 switch (keySym) {
445 case XK_Super_L:
446 keySym = XK_Alt_L;
447 break;
448 case XK_Super_R:
449 keySym = XK_Super_L;
450 break;
451 case XK_Alt_L:
Pierre Ossman38fcebb2014-08-21 13:44:28 +0200452 keySym = XK_Mode_switch;
453 break;
Pierre Ossman25188c42014-07-21 16:30:08 +0200454 case XK_Alt_R:
455 keySym = XK_ISO_Level3_Shift;
456 break;
457 }
458#endif
459
460#ifdef WIN32
461 // Ugly hack alert!
462 //
463 // Windows doesn't have a proper AltGr, but handles it using fake
464 // Ctrl+Alt. Unfortunately X11 doesn't generally like the combination
465 // Ctrl+Alt+AltGr, which we usually end up with when Xvnc tries to
466 // get everything in the correct state. Cheat and temporarily release
467 // Ctrl and Alt when we send some other symbol.
468 bool ctrlPressed, altPressed;
469 DownMap::iterator iter;
470
471 ctrlPressed = false;
472 altPressed = false;
473 for (iter = downKeySym.begin();iter != downKeySym.end();++iter) {
474 if (iter->second == XK_Control_L)
475 ctrlPressed = true;
476 else if (iter->second == XK_Alt_R)
477 altPressed = true;
478 }
479
480 if (ctrlPressed && altPressed) {
481 vlog.debug("Faking release of AltGr (Ctrl_L+Alt_R)");
482 try {
483 cc->writer()->keyEvent(XK_Control_L, false);
484 cc->writer()->keyEvent(XK_Alt_R, false);
485 } catch (rdr::Exception& e) {
486 vlog.error("%s", e.str());
487 exit_vncviewer(e.str());
488 }
489 }
490#endif
491
492 // Because of the way keyboards work, we cannot expect to have the same
493 // symbol on release as when pressed. This breaks the VNC protocol however,
494 // so we need to keep track of what keysym a key _code_ generated on press
495 // and send the same on release.
496 downKeySym[keyCode] = keySym;
497
498#if defined(WIN32) || defined(__APPLE__)
499 vlog.debug("Key pressed: 0x%04x => 0x%04x", keyCode, keySym);
500#else
501 vlog.debug("Key pressed: 0x%04x => XK_%s (0x%04x)",
502 keyCode, XKeysymToString(keySym), keySym);
503#endif
504
505 try {
506 cc->writer()->keyEvent(keySym, true);
507 } catch (rdr::Exception& e) {
508 vlog.error("%s", e.str());
509 exit_vncviewer(e.str());
510 }
511
512#ifdef WIN32
513 // Ugly hack continued...
514 if (ctrlPressed && altPressed) {
515 vlog.debug("Restoring AltGr state");
516 try {
517 cc->writer()->keyEvent(XK_Control_L, true);
518 cc->writer()->keyEvent(XK_Alt_R, true);
519 } catch (rdr::Exception& e) {
520 vlog.error("%s", e.str());
521 exit_vncviewer(e.str());
522 }
523 }
524#endif
525}
526
527
528void Viewport::handleKeyRelease(int keyCode)
529{
530 DownMap::iterator iter;
531
532 if (viewOnly)
533 return;
534
535 iter = downKeySym.find(keyCode);
536 if (iter == downKeySym.end()) {
537 // These occur somewhat frequently so let's not spam them unless
538 // logging is turned up.
539 vlog.debug("Unexpected release of key code %d", keyCode);
540 return;
541 }
542
543#if defined(WIN32) || defined(__APPLE__)
544 vlog.debug("Key released: 0x%04x => 0x%04x", keyCode, iter->second);
545#else
546 vlog.debug("Key released: 0x%04x => XK_%s (0x%04x)",
547 keyCode, XKeysymToString(iter->second), iter->second);
548#endif
549
550 try {
551 cc->writer()->keyEvent(iter->second, false);
552 } catch (rdr::Exception& e) {
553 vlog.error("%s", e.str());
554 exit_vncviewer(e.str());
555 }
556
557 downKeySym.erase(iter);
558}
559
560
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200561int Viewport::handleSystemEvent(void *event, void *data)
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200562{
563 Viewport *self = (Viewport *)data;
564 Fl_Widget *focus;
565
566 assert(self);
567
568 focus = Fl::grab();
569 if (!focus)
570 focus = Fl::focus();
571 if (!focus)
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200572 return 0;
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200573
574 if (focus != self)
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200575 return 0;
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200576
577 assert(event);
578
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200579#if defined(WIN32)
580 MSG *msg = (MSG*)event;
581
582 if ((msg->message == WM_KEYDOWN) || (msg->message == WM_SYSKEYDOWN)) {
583 UINT vKey;
584 bool isExtended;
585 int keyCode;
586 rdr::U32 keySym;
587
588 vKey = msg->wParam;
589 isExtended = (msg->lParam & (1 << 24)) != 0;
590
591 keyCode = ((msg->lParam >> 16) & 0xff);
592
593 // Windows sets the scan code to 0x00 for multimedia keys, so we
594 // have to do a reverse lookup based on the vKey.
595 if (keyCode == 0x00) {
596 keyCode = MapVirtualKey(vKey, MAPVK_VK_TO_VSC);
597 if (keyCode == 0x00) {
Pierre Ossmanf05f3552014-09-22 12:19:52 +0200598 if (isExtended)
599 vlog.error(_("No scan code for extended virtual key 0x%02x"), (int)vKey);
600 else
601 vlog.error(_("No scan code for virtual key 0x%02x"), (int)vKey);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200602 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200603 }
604 }
605
606 if (isExtended)
607 keyCode |= 0x100;
608
Pierre Ossmana7d3dc72014-09-30 17:03:28 +0200609 // VK_SNAPSHOT sends different scan codes depending on the state of
610 // Alt. This means that we can get different scan codes on press and
611 // release. Force it to be something standard.
612 if (vKey == VK_SNAPSHOT)
613 keyCode = 0x137;
614
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200615 keySym = win32_vkey_to_keysym(vKey, isExtended);
616 if (keySym == NoSymbol) {
Pierre Ossmanf05f3552014-09-22 12:19:52 +0200617 if (isExtended)
618 vlog.error(_("No symbol for extended virtual key 0x%02x"), (int)vKey);
619 else
620 vlog.error(_("No symbol for virtual key 0x%02x"), (int)vKey);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200621 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200622 }
623
624 self->handleKeyPress(keyCode, keySym);
625
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200626 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200627 } else if ((msg->message == WM_KEYUP) || (msg->message == WM_SYSKEYUP)) {
628 UINT vKey;
629 bool isExtended;
630 int keyCode;
631
632 vKey = msg->wParam;
633 isExtended = (msg->lParam & (1 << 24)) != 0;
634
635 keyCode = ((msg->lParam >> 16) & 0xff);
636 if (keyCode == 0x00)
637 keyCode = MapVirtualKey(vKey, MAPVK_VK_TO_VSC);
638 if (isExtended)
639 keyCode |= 0x100;
Pierre Ossmana7d3dc72014-09-30 17:03:28 +0200640 if (vKey == VK_SNAPSHOT)
641 keyCode = 0x137;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200642
643 self->handleKeyRelease(keyCode);
644
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200645 return 1;
Pierre Ossman2e9684f2014-07-21 16:46:22 +0200646 }
Pierre Ossman6b743d02014-07-21 16:48:43 +0200647#elif defined(__APPLE__)
648 if (cocoa_is_keyboard_event(event)) {
649 int keyCode;
650
651 keyCode = cocoa_event_keycode(event);
652
653 if (cocoa_is_key_press(event)) {
654 rdr::U32 keySym;
655
656 keySym = cocoa_event_keysym(event);
657 if (keySym == NoSymbol) {
658 vlog.error(_("No symbol for key code 0x%02x (in the current state)"),
659 (int)keyCode);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200660 return 1;
Pierre Ossman6b743d02014-07-21 16:48:43 +0200661 }
662
663 self->handleKeyPress(keyCode, keySym);
664
665 // We don't get any release events for CapsLock, so we have to
666 // send the release right away.
667 if (keySym == XK_Caps_Lock)
668 self->handleKeyRelease(keyCode);
669 } else {
670 self->handleKeyRelease(keyCode);
671 }
672
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200673 return 1;
Pierre Ossman6b743d02014-07-21 16:48:43 +0200674 }
675#else
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200676 XEvent *xevent = (XEvent*)event;
677
678 if (xevent->type == KeyPress) {
679 char str;
680 KeySym keysym;
681
682 XLookupString(&xevent->xkey, &str, 1, &keysym, NULL);
683 if (keysym == NoSymbol) {
684 vlog.error(_("No symbol for key code %d (in the current state)"),
685 (int)xevent->xkey.keycode);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200686 return 1;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200687 }
688
689 switch (keysym) {
690 // For the first few years, there wasn't a good consensus on what the
691 // Windows keys should be mapped to for X11. So we need to help out a
692 // bit and map all variants to the same key...
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200693 case XK_Hyper_L:
694 keysym = XK_Super_L;
695 break;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200696 case XK_Hyper_R:
697 keysym = XK_Super_R;
698 break;
699 // There has been several variants for Shift-Tab over the years.
700 // RFB states that we should always send a normal tab.
701 case XK_ISO_Left_Tab:
702 keysym = XK_Tab;
703 break;
704 }
705
706 self->handleKeyPress(xevent->xkey.keycode, keysym);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200707 return 1;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200708 } else if (xevent->type == KeyRelease) {
709 self->handleKeyRelease(xevent->xkey.keycode);
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200710 return 1;
Pierre Ossman6b9622d2014-07-21 16:42:12 +0200711 }
712#endif
713
Pierre Ossman64ff1ca2014-09-11 10:48:29 +0200714 return 0;
Pierre Ossman4f3ac692014-08-22 15:10:22 +0200715}
716
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000717void Viewport::initContextMenu()
718{
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100719 contextMenu->clear();
720
Pierre Ossmanff626f82015-09-23 16:39:54 +0200721 fltk_menu_add(contextMenu, p_("ContextMenu|", "E&xit viewer"),
722 0, NULL, (void*)ID_EXIT, FL_MENU_DIVIDER);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000723
Pierre Ossmanff626f82015-09-23 16:39:54 +0200724 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Full screen"),
725 0, NULL, (void*)ID_FULLSCREEN,
Pierre Ossman245c8022015-02-25 11:27:49 +0100726 FL_MENU_TOGGLE | (window()->fullscreen_active()?FL_MENU_VALUE:0));
Pierre Ossmanff626f82015-09-23 16:39:54 +0200727 fltk_menu_add(contextMenu, p_("ContextMenu|", "Minimi&ze"),
728 0, NULL, (void*)ID_MINIMIZE, 0);
729 fltk_menu_add(contextMenu, p_("ContextMenu|", "Resize &window to session"),
730 0, NULL, (void*)ID_RESIZE,
Pierre Ossman245c8022015-02-25 11:27:49 +0100731 (window()->fullscreen_active()?FL_MENU_INACTIVE:0) |
Pierre Ossman245c8022015-02-25 11:27:49 +0100732 FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100733
Pierre Ossmanff626f82015-09-23 16:39:54 +0200734 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Ctrl"),
735 0, NULL, (void*)ID_CTRL,
Pierre Ossman245c8022015-02-25 11:27:49 +0100736 FL_MENU_TOGGLE | (menuCtrlKey?FL_MENU_VALUE:0));
Pierre Ossmanff626f82015-09-23 16:39:54 +0200737 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Alt"),
738 0, NULL, (void*)ID_ALT,
Pierre Ossman245c8022015-02-25 11:27:49 +0100739 FL_MENU_TOGGLE | (menuAltKey?FL_MENU_VALUE:0));
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100740
741 if (menuKeySym) {
742 char sendMenuKey[64];
Pierre Ossmanff626f82015-09-23 16:39:54 +0200743 snprintf(sendMenuKey, 64, p_("ContextMenu|", "Send %s"), (const char *)menuKey);
Pierre Ossman245c8022015-02-25 11:27:49 +0100744 fltk_menu_add(contextMenu, sendMenuKey, 0, NULL, (void*)ID_MENUKEY, 0);
745 fltk_menu_add(contextMenu, "Secret shortcut menu key", menuKeyCode, NULL,
746 (void*)ID_MENUKEY, FL_MENU_INVISIBLE);
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000747 }
748
Pierre Ossmanff626f82015-09-23 16:39:54 +0200749 fltk_menu_add(contextMenu, p_("ContextMenu|", "Send Ctrl-Alt-&Del"),
750 0, NULL, (void*)ID_CTRLALTDEL, FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100751
Pierre Ossmanff626f82015-09-23 16:39:54 +0200752 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Refresh screen"),
753 0, NULL, (void*)ID_REFRESH, FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100754
Pierre Ossmanff626f82015-09-23 16:39:54 +0200755 fltk_menu_add(contextMenu, p_("ContextMenu|", "&Options..."),
756 0, NULL, (void*)ID_OPTIONS, 0);
757 fltk_menu_add(contextMenu, p_("ContextMenu|", "Connection &info..."),
758 0, NULL, (void*)ID_INFO, 0);
759 fltk_menu_add(contextMenu, p_("ContextMenu|", "About &TigerVNC viewer..."),
760 0, NULL, (void*)ID_ABOUT, FL_MENU_DIVIDER);
Pierre Ossmanb5b0ea52015-02-25 10:35:03 +0100761
Pierre Ossmanff626f82015-09-23 16:39:54 +0200762 fltk_menu_add(contextMenu, p_("ContextMenu|", "Dismiss &menu"),
763 0, NULL, (void*)ID_DISMISS, 0);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000764}
765
766
767void Viewport::popupContextMenu()
768{
769 const Fl_Menu_Item *m;
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000770 char buffer[1024];
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000771
Pierre Ossmanb3ff4372011-06-03 11:45:15 +0000772 // Make sure the menu is reset to its initial state between goes or
773 // it will start up highlighting the previously selected entry.
774 contextMenu->value(-1);
775
Henrik Anderssonabd70ce2011-09-14 06:31:06 +0000776 // initialize context menu before display
777 initContextMenu();
778
Pierre Ossmanfd177f32012-01-05 12:37:04 +0000779 // Unfortunately FLTK doesn't reliably restore the mouse pointer for
780 // menus, so we have to help it out.
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000781 if (Fl::belowmouse() == this)
782 window()->cursor(FL_CURSOR_DEFAULT);
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000783
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000784 m = contextMenu->popup();
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000785
Pierre Ossmanfd177f32012-01-05 12:37:04 +0000786 // Back to our proper mouse pointer.
Pierre Ossmande1a3b92014-03-17 14:29:49 +0100787 if ((Fl::belowmouse() == this) && cursor)
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000788 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossmanbfbdb102012-01-05 12:32:03 +0000789
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000790 if (m == NULL)
791 return;
792
793 switch (m->argument()) {
794 case ID_EXIT:
795 exit_vncviewer();
796 break;
Pierre Ossman4c613d32011-05-26 14:14:06 +0000797 case ID_FULLSCREEN:
798 if (window()->fullscreen_active())
799 window()->fullscreen_off();
Pierre Ossman275284f2012-07-04 11:37:48 +0000800 else
Pierre Ossmanaae38912012-07-13 11:22:55 +0000801 ((DesktopWindow*)window())->fullscreen_on();
Pierre Ossman4c613d32011-05-26 14:14:06 +0000802 break;
Joel Teichroeba7494ac2015-07-13 14:46:22 -0700803 case ID_MINIMIZE:
804 window()->iconize();
Joel Teichroeb1f9e45a2015-07-18 07:09:24 -0700805 break;
Pierre Ossman8dc8bca2012-07-04 11:37:10 +0000806 case ID_RESIZE:
Pierre Ossman8dc8bca2012-07-04 11:37:10 +0000807 if (window()->fullscreen_active())
808 break;
Pierre Ossman8dc8bca2012-07-04 11:37:10 +0000809 window()->size(w(), h());
810 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000811 case ID_CTRL:
Pierre Ossman25188c42014-07-21 16:30:08 +0200812 if (m->value())
813 handleKeyPress(fakeKeyBase + 0, XK_Control_L);
814 else
815 handleKeyRelease(fakeKeyBase + 0);
Henrik Anderssonabd70ce2011-09-14 06:31:06 +0000816 menuCtrlKey = !menuCtrlKey;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000817 break;
818 case ID_ALT:
Pierre Ossman25188c42014-07-21 16:30:08 +0200819 if (m->value())
820 handleKeyPress(fakeKeyBase + 1, XK_Alt_L);
821 else
822 handleKeyRelease(fakeKeyBase + 1);
Henrik Anderssonabd70ce2011-09-14 06:31:06 +0000823 menuAltKey = !menuAltKey;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000824 break;
825 case ID_MENUKEY:
Pierre Ossman25188c42014-07-21 16:30:08 +0200826 handleKeyPress(fakeKeyBase + 2, menuKeySym);
827 handleKeyRelease(fakeKeyBase + 2);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000828 break;
829 case ID_CTRLALTDEL:
Pierre Ossman25188c42014-07-21 16:30:08 +0200830 handleKeyPress(fakeKeyBase + 3, XK_Control_L);
831 handleKeyPress(fakeKeyBase + 4, XK_Alt_L);
832 handleKeyPress(fakeKeyBase + 5, XK_Delete);
Pierre Ossman991b4fe2011-07-12 16:02:30 +0000833
Pierre Ossman25188c42014-07-21 16:30:08 +0200834 handleKeyRelease(fakeKeyBase + 5);
835 handleKeyRelease(fakeKeyBase + 4);
836 handleKeyRelease(fakeKeyBase + 3);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000837 break;
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000838 case ID_REFRESH:
839 cc->refreshFramebuffer();
840 break;
Pierre Ossmand463b572011-05-16 12:04:43 +0000841 case ID_OPTIONS:
842 OptionsDialog::showDialog();
843 break;
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000844 case ID_INFO:
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000845 if (fltk_escape(cc->connectionInfo(), buffer, sizeof(buffer)) < sizeof(buffer)) {
846 fl_message_title(_("VNC connection info"));
Pierre Ossmanf52740e2012-04-25 15:43:56 +0000847 fl_message("%s", buffer);
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000848 }
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000849 break;
Pierre Ossmanb8858222011-04-29 11:51:38 +0000850 case ID_ABOUT:
851 about_vncviewer();
852 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000853 case ID_DISMISS:
854 // Don't need to do anything
855 break;
856 }
857}
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000858
859
860void Viewport::setMenuKey()
861{
Pierre Ossman25188c42014-07-21 16:30:08 +0200862 getMenuKey(&menuKeyCode, &menuKeySym);
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000863}
864
865
866void Viewport::handleOptions(void *data)
867{
868 Viewport *self = (Viewport*)data;
869
870 self->setMenuKey();
871}