blob: dcadd0ef1a5ae36b6fffaaca345ee995880a70b9 [file] [log] [blame]
Pierre Ossmand50b3d12011-04-15 07:46:56 +00001/* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
2 * Copyright 2011 Pierre Ossman <ossman@cendio.se> for Cendio AB
3 *
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
20#include <assert.h>
21#include <stdio.h>
22#include <string.h>
23
Pierre Ossmand50b3d12011-04-15 07:46:56 +000024#include <rfb/CMsgWriter.h>
25#include <rfb/LogWriter.h>
26
27// FLTK can pull in the X11 headers on some systems
28#ifndef XK_VoidSymbol
29#define XK_MISCELLANY
30#define XK_XKB_KEYS
31#include <rfb/keysymdef.h>
32#endif
33
Pierre Ossmancb0cffe2011-05-20 14:55:10 +000034#ifndef XF86XK_ModeLock
35#include <rfb/XF86keysym.h>
36#endif
37
Pierre Ossmand50b3d12011-04-15 07:46:56 +000038#include "Viewport.h"
39#include "CConn.h"
Pierre Ossmand463b572011-05-16 12:04:43 +000040#include "OptionsDialog.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000041#include "i18n.h"
Pierre Ossmanc628ba42011-05-23 12:21:21 +000042#include "fltk_layout.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000043#include "parameters.h"
44#include "keysym2ucs.h"
Pierre Ossman39ceb502011-07-12 15:54:25 +000045#include "vncviewer.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000046
DRCb65bb932011-06-24 03:17:00 +000047#include <FL/fl_draw.H>
48#include <FL/fl_ask.H>
49
50#ifdef WIN32
51#include "win32.h"
52#endif
53
Pierre Ossmand50b3d12011-04-15 07:46:56 +000054using namespace rfb;
Pierre Ossman835b4ef2011-06-08 17:02:36 +000055using namespace rdr;
Pierre Ossmand50b3d12011-04-15 07:46:56 +000056
Pierre Ossmand50b3d12011-04-15 07:46:56 +000057static rfb::LogWriter vlog("Viewport");
58
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000059// Menu constants
60
Pierre Ossman4c613d32011-05-26 14:14:06 +000061enum { ID_EXIT, ID_FULLSCREEN, ID_CTRL, ID_ALT, ID_MENUKEY, ID_CTRLALTDEL,
Pierre Ossman2eb1d112011-05-16 12:18:08 +000062 ID_REFRESH, ID_OPTIONS, ID_INFO, ID_ABOUT, ID_DISMISS };
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000063
Pierre Ossmand50b3d12011-04-15 07:46:56 +000064Viewport::Viewport(int w, int h, const rfb::PixelFormat& serverPF, CConn* cc_)
65 : Fl_Widget(0, 0, w, h), cc(cc_), frameBuffer(NULL), pixelTrans(NULL),
Pierre Ossmanf3505452011-07-15 08:11:55 +000066 colourMapChange(false), lastPointerPos(0, 0), lastButtonMask(0),
67 cursor(NULL)
Pierre Ossmand50b3d12011-04-15 07:46:56 +000068{
Pierre Ossmanf8c5ef62011-05-13 12:47:54 +000069// FLTK STR #2599 must be fixed for proper dead keys support
70#ifdef HAVE_FLTK_DEAD_KEYS
71 set_simple_keyboard();
72#endif
73
Pierre Ossman4a6be4a2011-05-19 14:49:18 +000074// FLTK STR #2636 gives us the ability to monitor clipboard changes
75#ifdef HAVE_FLTK_CLIPBOARD
76 Fl::add_clipboard_notify(handleClipboardChange, this);
77#endif
78
Pierre Ossman132b3d02011-06-13 11:19:32 +000079 frameBuffer = new PlatformPixelBuffer(w, h);
Pierre Ossmand50b3d12011-04-15 07:46:56 +000080 assert(frameBuffer);
81
82 setServerPF(serverPF);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000083
84 contextMenu = new Fl_Menu_Button(0, 0, 0, 0);
Pierre Ossmanad9d1ae2011-05-26 14:16:02 +000085 // Setting box type to FL_NO_BOX prevents it from trying to draw the
86 // button component (which we don't want)
87 contextMenu->box(FL_NO_BOX);
88
Pierre Ossmanb043ad12011-06-01 09:26:57 +000089 // The (invisible) button associated with this widget can mess with
90 // things like Fl_Scroll so we need to get rid of any parents.
91 // Unfortunately that's not possible because of STR #2654, but
92 // reparenting to the current window works for most cases.
93 window()->add(contextMenu);
94
Pierre Ossman4e7271e2011-05-24 12:47:12 +000095 setMenuKey();
Peter Åstrand086359c2011-06-23 08:40:14 +000096 initContextMenu();
Pierre Ossman4e7271e2011-05-24 12:47:12 +000097
98 OptionsDialog::addCallback(handleOptions, this);
Pierre Ossmand50b3d12011-04-15 07:46:56 +000099}
100
101
102Viewport::~Viewport()
103{
104 // Unregister all timeouts in case they get a change tro trigger
105 // again later when this object is already gone.
106 Fl::remove_timeout(handleUpdateTimeout, this);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000107 Fl::remove_timeout(handlePointerTimeout, this);
108
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000109#ifdef HAVE_FLTK_CLIPBOARD
110 Fl::remove_clipboard_notify(handleClipboardChange);
111#endif
112
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000113 OptionsDialog::removeCallback(handleOptions);
114
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000115 delete frameBuffer;
116
117 if (pixelTrans)
118 delete pixelTrans;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000119
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000120 if (cursor) {
Pierre Ossmanf741d342011-06-09 08:32:49 +0000121 if (!cursor->alloc_array)
122 delete [] cursor->array;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000123 delete cursor;
124 }
125
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000126 // FLTK automatically deletes all child widgets, so we shouldn't touch
127 // them ourselves here
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000128}
129
130
131void Viewport::setServerPF(const rfb::PixelFormat& pf)
132{
133 if (pixelTrans)
134 delete pixelTrans;
135 pixelTrans = NULL;
136
137 if (pf.equal(getPreferredPF()))
138 return;
139
140 pixelTrans = new PixelTransformer();
141 pixelTrans->init(pf, &colourMap, getPreferredPF());
142}
143
144
145const rfb::PixelFormat &Viewport::getPreferredPF()
146{
Pierre Ossman132b3d02011-06-13 11:19:32 +0000147 return frameBuffer->getPF();
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000148}
149
150
151// setColourMapEntries() changes some of the entries in the colourmap.
Pierre Ossmanf3505452011-07-15 08:11:55 +0000152// We don't actually act on these changes until we need to. This is
153// because recalculating the internal translation table can be expensive.
154// This also solves the issue of silly servers sending colour maps in
155// multiple pieces.
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000156void Viewport::setColourMapEntries(int firstColour, int nColours,
157 rdr::U16* rgbs)
158{
159 for (int i = 0; i < nColours; i++)
160 colourMap.set(firstColour+i, rgbs[i*3], rgbs[i*3+1], rgbs[i*3+2]);
161
Pierre Ossmanf3505452011-07-15 08:11:55 +0000162 colourMapChange = true;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000163}
164
165
166// Copy the areas of the framebuffer that have been changed (damaged)
167// to the displayed window.
168
169void Viewport::updateWindow()
170{
171 Rect r;
172
173 Fl::remove_timeout(handleUpdateTimeout, this);
174
175 r = damage.get_bounding_rect();
Pierre Ossmana6e20772011-04-15 11:10:52 +0000176 Fl_Widget::damage(FL_DAMAGE_USER1, r.tl.x + x(), r.tl.y + y(), r.width(), r.height());
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000177
178 damage.clear();
179}
180
Pierre Ossmanf741d342011-06-09 08:32:49 +0000181#ifdef HAVE_FLTK_CURSOR
182static const char * dotcursor_xpm[] = {
183 "5 5 2 1",
184 ". c #000000",
185 " c #FFFFFF",
186 " ",
187 " ... ",
188 " ... ",
189 " ... ",
190 " "};
191#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000192
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000193void Viewport::setCursor(int width, int height, const Point& hotspot,
194 void* data, void* mask)
195{
196#ifdef HAVE_FLTK_CURSOR
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000197 if (cursor) {
Pierre Ossmanf741d342011-06-09 08:32:49 +0000198 if (!cursor->alloc_array)
199 delete [] cursor->array;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000200 delete cursor;
201 }
202
Pierre Ossmanf741d342011-06-09 08:32:49 +0000203 int mask_len = ((width+7)/8) * height;
204 int i;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000205
Pierre Ossmanf741d342011-06-09 08:32:49 +0000206 for (i = 0; i < mask_len; i++)
207 if (((rdr::U8*)mask)[i]) break;
208
Pierre Ossmana51574a2011-06-09 08:39:35 +0000209 if ((i == mask_len) && dotWhenNoCursor) {
210 vlog.debug("cursor is empty - using dot");
Pierre Ossmanf741d342011-06-09 08:32:49 +0000211
212 Fl_Pixmap pxm(dotcursor_xpm);
213 cursor = new Fl_RGB_Image(&pxm);
214 cursorHotspot.x = cursorHotspot.y = 2;
215 } else {
Pierre Ossman17a48f02011-06-09 08:42:04 +0000216 if ((width == 0) || (height == 0)) {
217 U8 *buffer = new U8[4];
218 memset(buffer, 0, 4);
219 cursor = new Fl_RGB_Image(buffer, 1, 1, 4);
220 cursorHotspot.x = cursorHotspot.y = 0;
221 } else {
222 U8 *buffer = new U8[width*height*4];
223 U8 *i, *o, *m;
224 int m_width;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000225
Pierre Ossman17a48f02011-06-09 08:42:04 +0000226 const PixelFormat &pf = frameBuffer->getPF();
Pierre Ossmanf741d342011-06-09 08:32:49 +0000227
Pierre Ossman17a48f02011-06-09 08:42:04 +0000228 i = (U8*)data;
229 o = buffer;
230 m = (U8*)mask;
231 m_width = (width+7)/8;
232 for (int y = 0;y < height;y++) {
233 for (int x = 0;x < width;x++) {
234 pf.rgbFromBuffer(o, i, 1, &colourMap);
Pierre Ossmanf741d342011-06-09 08:32:49 +0000235
Pierre Ossman17a48f02011-06-09 08:42:04 +0000236 if (m[(m_width*y)+(x/8)] & 0x80>>(x%8))
237 o[3] = 255;
238 else
239 o[3] = 0;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000240
Pierre Ossman17a48f02011-06-09 08:42:04 +0000241 o += 4;
242 i += pf.bpp/8;
243 }
Pierre Ossmanf741d342011-06-09 08:32:49 +0000244 }
Pierre Ossman17a48f02011-06-09 08:42:04 +0000245
246 cursor = new Fl_RGB_Image(buffer, width, height, 4);
247
248 cursorHotspot = hotspot;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000249 }
Pierre Ossmanf741d342011-06-09 08:32:49 +0000250 }
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000251
252 if (Fl::belowmouse() == this)
253 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
254#endif
255}
256
257
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000258void Viewport::draw()
259{
260 int X, Y, W, H;
261
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000262 // Check what actually needs updating
Pierre Ossmana6e20772011-04-15 11:10:52 +0000263 fl_clip_box(x(), y(), w(), h(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000264 if ((W == 0) || (H == 0))
265 return;
266
Pierre Ossman132b3d02011-06-13 11:19:32 +0000267 frameBuffer->draw(X - x(), Y - y(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000268}
269
270
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000271void Viewport::resize(int x, int y, int w, int h)
272{
Pierre Ossman132b3d02011-06-13 11:19:32 +0000273 PlatformPixelBuffer* newBuffer;
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000274 rfb::Rect rect;
275
Pierre Ossman132b3d02011-06-13 11:19:32 +0000276 // FIXME: Resize should probably be a feature of the pixel buffer itself
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000277
278 if ((w == frameBuffer->width()) && (h == frameBuffer->height()))
279 goto end;
280
Pierre Ossman132b3d02011-06-13 11:19:32 +0000281 newBuffer = new PlatformPixelBuffer(w, h);
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000282 assert(newBuffer);
283
284 rect.setXYWH(0, 0,
285 __rfbmin(newBuffer->width(), frameBuffer->width()),
286 __rfbmin(newBuffer->height(), frameBuffer->height()));
287 newBuffer->imageRect(rect, frameBuffer->data, frameBuffer->getStride());
288
289 // Black out any new areas
290
291 if (newBuffer->width() > frameBuffer->width()) {
292 rect.setXYWH(frameBuffer->width(), 0,
293 newBuffer->width() - frameBuffer->width(),
294 newBuffer->height());
295 newBuffer->fillRect(rect, 0);
296 }
297
298 if (newBuffer->height() > frameBuffer->height()) {
299 rect.setXYWH(0, frameBuffer->height(),
300 newBuffer->width(),
301 newBuffer->height() - frameBuffer->height());
302 newBuffer->fillRect(rect, 0);
303 }
304
305 delete frameBuffer;
306 frameBuffer = newBuffer;
307
308end:
309 Fl_Widget::resize(x, y, w, h);
310}
311
312
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000313int Viewport::handle(int event)
314{
Pierre Ossman689c4582011-05-26 15:39:41 +0000315 char *buffer;
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000316 int ret;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000317 int buttonMask, wheelMask;
318 DownMap::const_iterator iter;
319
320 switch (event) {
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000321 case FL_PASTE:
Pierre Ossman689c4582011-05-26 15:39:41 +0000322 buffer = new char[Fl::event_length() + 1];
323
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000324 // This is documented as to ASCII, but actually does to 8859-1
Pierre Ossman689c4582011-05-26 15:39:41 +0000325 ret = fl_utf8toa(Fl::event_text(), Fl::event_length(), buffer,
326 Fl::event_length() + 1);
327 assert(ret < (Fl::event_length() + 1));
328
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000329 vlog.debug("Sending clipboard data: '%s'", buffer);
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000330
331 try {
332 cc->writer()->clientCutText(buffer, ret);
333 } catch (rdr::Exception& e) {
334 vlog.error(e.str());
335 exit_vncviewer(e.str());
336 }
Pierre Ossman689c4582011-05-26 15:39:41 +0000337
338 delete [] buffer;
339
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000340 return 1;
Pierre Ossman689c4582011-05-26 15:39:41 +0000341
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000342 case FL_ENTER:
343 // Yes, we would like some pointer events please!
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000344#ifdef HAVE_FLTK_CURSOR
Pierre Ossman1f1f6fd2011-06-09 08:33:29 +0000345 if (cursor)
346 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000347#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000348 return 1;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000349
350 case FL_LEAVE:
351#ifdef HAVE_FLTK_CURSOR
352 window()->cursor(FL_CURSOR_DEFAULT);
353#endif
354 return 1;
355
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000356 case FL_PUSH:
357 case FL_RELEASE:
358 case FL_DRAG:
359 case FL_MOVE:
360 case FL_MOUSEWHEEL:
361 buttonMask = 0;
362 if (Fl::event_button1())
363 buttonMask |= 1;
364 if (Fl::event_button2())
365 buttonMask |= 2;
366 if (Fl::event_button3())
367 buttonMask |= 4;
368
369 if (event == FL_MOUSEWHEEL) {
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000370 wheelMask = 0;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000371 if (Fl::event_dy() < 0)
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000372 wheelMask |= 8;
373 if (Fl::event_dy() > 0)
374 wheelMask |= 16;
375 if (Fl::event_dx() < 0)
376 wheelMask |= 32;
377 if (Fl::event_dx() > 0)
378 wheelMask |= 64;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000379
380 // A quick press of the wheel "button", followed by a immediate
381 // release below
Pierre Ossman6a464be2011-04-15 12:57:31 +0000382 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()),
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000383 buttonMask | wheelMask);
384 }
385
Pierre Ossman6a464be2011-04-15 12:57:31 +0000386 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()), buttonMask);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000387 return 1;
388
389 case FL_FOCUS:
390 // Yes, we would like some focus please!
391 return 1;
392
393 case FL_UNFOCUS:
394 // Release all keys that were pressed as that generally makes most
395 // sense (e.g. Alt+Tab where we only see the Alt press)
Pierre Ossmanf8450ca2011-07-12 16:10:16 +0000396 while (!downKeySym.empty())
397 handleKeyEvent(downKeySym.begin()->first, downKeySym.begin()->first,
398 "", false);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000399 return 1;
400
401 case FL_KEYDOWN:
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000402 if (menuKeyCode && (Fl::event_key() == menuKeyCode)) {
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000403 popupContextMenu();
404 return 1;
405 }
406
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000407 handleKeyEvent(Fl::event_key(), Fl::event_original_key(),
408 Fl::event_text(), true);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000409 return 1;
410
411 case FL_KEYUP:
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000412 if (menuKeyCode && (Fl::event_key() == menuKeyCode))
413 return 1;
414
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000415 handleKeyEvent(Fl::event_key(), Fl::event_original_key(),
416 Fl::event_text(), false);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000417 return 1;
418 }
419
420 return Fl_Widget::handle(event);
421}
422
423
424void Viewport::handleUpdateTimeout(void *data)
425{
426 Viewport *self = (Viewport *)data;
427
428 assert(self);
429
430 self->updateWindow();
431}
432
433
Pierre Ossmanf3505452011-07-15 08:11:55 +0000434void Viewport::commitColourMap()
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000435{
Pierre Ossmanf3505452011-07-15 08:11:55 +0000436 if (pixelTrans == NULL)
437 return;
438 if (!colourMapChange)
439 return;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000440
Pierre Ossmanf3505452011-07-15 08:11:55 +0000441 colourMapChange = false;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000442
Pierre Ossmanf3505452011-07-15 08:11:55 +0000443 pixelTrans->setColourMapEntries(0, 0);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000444}
445
446
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000447void Viewport::handleClipboardChange(int source, void *data)
448{
449 Viewport *self = (Viewport *)data;
450
451 assert(self);
452
453 if (!sendPrimary && (source == 0))
454 return;
455
456 Fl::paste(*self, source);
457}
458
459
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000460void Viewport::handlePointerEvent(const rfb::Point& pos, int buttonMask)
461{
462 if (!viewOnly) {
463 if (pointerEventInterval == 0 || buttonMask != lastButtonMask) {
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000464 try {
465 cc->writer()->pointerEvent(pos, buttonMask);
466 } catch (rdr::Exception& e) {
467 vlog.error(e.str());
468 exit_vncviewer(e.str());
469 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000470 } else {
471 if (!Fl::has_timeout(handlePointerTimeout, this))
472 Fl::add_timeout((double)pointerEventInterval/1000.0,
473 handlePointerTimeout, this);
474 }
475 lastPointerPos = pos;
476 lastButtonMask = buttonMask;
477 }
478}
479
480
481void Viewport::handlePointerTimeout(void *data)
482{
483 Viewport *self = (Viewport *)data;
484
485 assert(self);
486
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000487 try {
488 self->cc->writer()->pointerEvent(self->lastPointerPos, self->lastButtonMask);
489 } catch (rdr::Exception& e) {
490 vlog.error(e.str());
491 exit_vncviewer(e.str());
492 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000493}
494
495
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000496rdr::U32 Viewport::translateKeyEvent(int keyCode, int origKeyCode, const char *keyText)
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000497{
498 unsigned ucs;
499
500 // First check for function keys
501 if ((keyCode > FL_F) && (keyCode <= FL_F_Last))
502 return XK_F1 + (keyCode - FL_F - 1);
503
504 // Numpad numbers
505 if ((keyCode >= (FL_KP + '0')) && (keyCode <= (FL_KP + '9')))
506 return XK_KP_0 + (keyCode - (FL_KP + '0'));
507
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000508 // FLTK does some special remapping of numpad keys when numlock is off
509 if ((origKeyCode >= FL_KP) && (origKeyCode <= FL_KP_Last)) {
510 switch (keyCode) {
511 case FL_F+1:
512 return XK_KP_F1;
513 case FL_F+2:
514 return XK_KP_F2;
515 case FL_F+3:
516 return XK_KP_F3;
517 case FL_F+4:
518 return XK_KP_F4;
519 case FL_Home:
520 return XK_KP_Home;
521 case FL_Left:
522 return XK_KP_Left;
523 case FL_Up:
524 return XK_KP_Up;
525 case FL_Right:
526 return XK_KP_Right;
527 case FL_Down:
528 return XK_KP_Down;
529 case FL_Page_Up:
530 return XK_KP_Page_Up;
531 case FL_Page_Down:
532 return XK_KP_Page_Down;
533 case FL_End:
534 return XK_KP_End;
535 case FL_Insert:
536 return XK_KP_Insert;
537 case FL_Delete:
538 return XK_KP_Delete;
539 }
540 }
541
Pierre Ossmanaa336be2011-07-14 13:35:48 +0000542#ifdef __APPLE__
543 // Alt on OS X behaves more like AltGr on other systems, and to get
544 // sane behaviour we should translate things in that manner for the
545 // remote VNC server. However that means we lose the ability to use
546 // Alt as a shortcut modifier. Do what RealVNC does and hijack the
547 // left command key as an Alt replacement.
548 switch (keyCode) {
549 case FL_Meta_L:
550 return XK_Alt_L;
551 case FL_Meta_R:
552 return XK_Super_L;
553 case FL_Alt_L:
554 case FL_Alt_R:
555 return XK_ISO_Level3_Shift;
556 }
557#endif
558
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000559 // Then other special keys
560 switch (keyCode) {
561 case FL_BackSpace:
562 return XK_BackSpace;
563 case FL_Tab:
564 return XK_Tab;
565 case FL_Enter:
566 return XK_Return;
567 case FL_Pause:
568 return XK_Pause;
569 case FL_Scroll_Lock:
570 return XK_Scroll_Lock;
571 case FL_Escape:
572 return XK_Escape;
573 case FL_Home:
574 return XK_Home;
575 case FL_Left:
576 return XK_Left;
577 case FL_Up:
578 return XK_Up;
579 case FL_Right:
580 return XK_Right;
581 case FL_Down:
582 return XK_Down;
583 case FL_Page_Up:
584 return XK_Page_Up;
585 case FL_Page_Down:
586 return XK_Page_Down;
587 case FL_End:
588 return XK_End;
589 case FL_Print:
590 return XK_Print;
591 case FL_Insert:
592 return XK_Insert;
593 case FL_Menu:
594 return XK_Menu;
595 case FL_Help:
596 return XK_Help;
597 case FL_Num_Lock:
598 return XK_Num_Lock;
599 case FL_Shift_L:
600 return XK_Shift_L;
601 case FL_Shift_R:
602 return XK_Shift_R;
603 case FL_Control_L:
604 return XK_Control_L;
605 case FL_Control_R:
606 return XK_Control_R;
607 case FL_Caps_Lock:
608 return XK_Caps_Lock;
609 case FL_Meta_L:
610 return XK_Super_L;
611 case FL_Meta_R:
612 return XK_Super_R;
613 case FL_Alt_L:
614 return XK_Alt_L;
615 case FL_Alt_R:
616 return XK_Alt_R;
617 case FL_Delete:
618 return XK_Delete;
619 case FL_KP_Enter:
620 return XK_KP_Enter;
621 case FL_KP + '=':
622 return XK_KP_Equal;
623 case FL_KP + '*':
624 return XK_KP_Multiply;
625 case FL_KP + '+':
626 return XK_KP_Add;
627 case FL_KP + ',':
628 return XK_KP_Separator;
629 case FL_KP + '-':
630 return XK_KP_Subtract;
631 case FL_KP + '.':
632 return XK_KP_Decimal;
633 case FL_KP + '/':
634 return XK_KP_Divide;
Pierre Ossmancb0cffe2011-05-20 14:55:10 +0000635#ifdef HAVE_FLTK_MEDIAKEYS
636 case FL_Volume_Down:
637 return XF86XK_AudioLowerVolume;
638 case FL_Volume_Mute:
639 return XF86XK_AudioMute;
640 case FL_Volume_Up:
641 return XF86XK_AudioRaiseVolume;
642 case FL_Media_Play:
643 return XF86XK_AudioPlay;
644 case FL_Media_Stop:
645 return XF86XK_AudioStop;
646 case FL_Media_Prev:
647 return XF86XK_AudioPrev;
648 case FL_Media_Next:
649 return XF86XK_AudioNext;
650 case FL_Home_Page:
651 return XF86XK_HomePage;
652 case FL_Mail:
653 return XF86XK_Mail;
654 case FL_Search:
655 return XF86XK_Search;
656 case FL_Back:
657 return XF86XK_Back;
658 case FL_Forward:
659 return XF86XK_Forward;
660 case FL_Stop:
661 return XF86XK_Stop;
662 case FL_Refresh:
663 return XF86XK_Refresh;
664 case FL_Sleep:
665 return XF86XK_Sleep;
666 case FL_Favorites:
667 return XF86XK_Favorites;
668#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000669 case XK_ISO_Level3_Shift:
670 // FLTK tends to let this one leak through on X11...
671 return XK_ISO_Level3_Shift;
Pierre Ossmana75f8f82011-04-29 11:12:02 +0000672 case XK_Multi_key:
673 // Same for this...
674 return XK_Multi_key;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000675 }
676
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000677 // Unknown special key?
678 if (keyText[0] == '\0') {
679 vlog.error(_("Unknown FLTK key code %d (0x%04x)"), keyCode, keyCode);
680 return XK_VoidSymbol;
681 }
682
683 // Look up the symbol the key produces and translate that from Unicode
684 // to a X11 keysym.
685 if (fl_utf_nb_char((const unsigned char*)keyText, strlen(keyText)) != 1) {
686 vlog.error(_("Multiple characters given for key code %d (0x%04x): '%s'"),
687 keyCode, keyCode, keyText);
688 return XK_VoidSymbol;
689 }
690
691 ucs = fl_utf8decode(keyText, NULL, NULL);
692 return ucs2keysym(ucs);
693}
694
695
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000696void Viewport::handleKeyEvent(int keyCode, int origKeyCode, const char *keyText, bool down)
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000697{
698 rdr::U32 keySym;
699
700 if (viewOnly)
701 return;
702
703 // Because of the way keyboards work, we cannot expect to have the same
704 // symbol on release as when pressed. This breaks the VNC protocol however,
705 // so we need to keep track of what keysym a key _code_ generated on press
706 // and send the same on release.
707 if (!down) {
708 DownMap::iterator iter;
709
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000710 iter = downKeySym.find(origKeyCode);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000711 if (iter == downKeySym.end()) {
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000712 vlog.error(_("Unexpected release of FLTK key code %d (0x%04x)"),
713 origKeyCode, origKeyCode);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000714 return;
715 }
716
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000717 vlog.debug("Key released: 0x%04x => 0x%04x", origKeyCode, iter->second);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000718
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000719 try {
720 cc->writer()->keyEvent(iter->second, false);
721 } catch (rdr::Exception& e) {
722 vlog.error(e.str());
723 exit_vncviewer(e.str());
724 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000725
726 downKeySym.erase(iter);
727
728 return;
729 }
730
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000731 keySym = translateKeyEvent(keyCode, origKeyCode, keyText);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000732 if (keySym == XK_VoidSymbol)
733 return;
734
Pierre Ossmanf0d92832011-07-13 17:56:26 +0000735#ifdef WIN32
736 // Ugly hack alert!
737 //
738 // Windows doesn't have a proper AltGr, but handles it using fake
739 // Ctrl+Alt. Unfortunately X11 doesn't generally like the combination
740 // Ctrl+Alt+AltGr, which we usually end up with when Xvnc tries to
741 // get everything in the correct state. Cheat and temporarily release
742 // Ctrl and Alt whenever we get a key with a symbol.
743 bool need_cheat = true;
744
745 if (keyText[0] == '\0')
746 need_cheat = false;
747 else if ((downKeySym.find(FL_Control_L) == downKeySym.end()) &&
748 (downKeySym.find(FL_Control_R) == downKeySym.end()))
749 need_cheat = false;
750 else if ((downKeySym.find(FL_Alt_L) == downKeySym.end()) &&
751 (downKeySym.find(FL_Alt_R) == downKeySym.end()))
752 need_cheat = false;
753
754 if (need_cheat) {
755 vlog.debug("Faking release of AltGr (Ctrl+Alt)");
756 try {
757 if (downKeySym.find(FL_Control_L) != downKeySym.end())
758 cc->writer()->keyEvent(XK_Control_L, false);
759 if (downKeySym.find(FL_Control_R) != downKeySym.end())
760 cc->writer()->keyEvent(XK_Control_R, false);
761 if (downKeySym.find(FL_Alt_L) != downKeySym.end())
762 cc->writer()->keyEvent(XK_Alt_L, false);
763 if (downKeySym.find(FL_Alt_R) != downKeySym.end())
764 cc->writer()->keyEvent(XK_Alt_R, false);
765 } catch (rdr::Exception& e) {
766 vlog.error(e.str());
767 exit_vncviewer(e.str());
768 }
769 }
770#endif
771
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000772 vlog.debug("Key pressed: 0x%04x (0x%04x) '%s' => 0x%04x",
773 origKeyCode, keyCode, keyText, keySym);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000774
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000775 downKeySym[origKeyCode] = keySym;
Pierre Ossman829cdeb2011-07-12 16:58:12 +0000776
777 try {
778 cc->writer()->keyEvent(keySym, down);
779 } catch (rdr::Exception& e) {
780 vlog.error(e.str());
781 exit_vncviewer(e.str());
782 }
Pierre Ossmanf0d92832011-07-13 17:56:26 +0000783
784#ifdef WIN32
785 // Ugly hack continued...
786 if (need_cheat) {
787 vlog.debug("Restoring AltGr state");
788 try {
789 if (downKeySym.find(FL_Control_L) != downKeySym.end())
790 cc->writer()->keyEvent(XK_Control_L, true);
791 if (downKeySym.find(FL_Control_R) != downKeySym.end())
792 cc->writer()->keyEvent(XK_Control_R, true);
793 if (downKeySym.find(FL_Alt_L) != downKeySym.end())
794 cc->writer()->keyEvent(XK_Alt_L, true);
795 if (downKeySym.find(FL_Alt_R) != downKeySym.end())
796 cc->writer()->keyEvent(XK_Alt_R, true);
797 } catch (rdr::Exception& e) {
798 vlog.error(e.str());
799 exit_vncviewer(e.str());
800 }
801 }
802#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000803}
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000804
805
806void Viewport::initContextMenu()
807{
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000808 contextMenu->clear();
809
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000810 contextMenu->add(_("Exit viewer"), 0, NULL, (void*)ID_EXIT, FL_MENU_DIVIDER);
811
Pierre Ossman4c613d32011-05-26 14:14:06 +0000812#ifdef HAVE_FLTK_FULLSCREEN
813 contextMenu->add(_("Full screen"), 0, NULL, (void*)ID_FULLSCREEN, FL_MENU_DIVIDER);
814#endif
815
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000816 contextMenu->add(_("Ctrl"), 0, NULL, (void*)ID_CTRL, FL_MENU_TOGGLE);
817 contextMenu->add(_("Alt"), 0, NULL, (void*)ID_ALT, FL_MENU_TOGGLE);
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000818
819 if (menuKeyCode) {
820 char sendMenuKey[64];
821 snprintf(sendMenuKey, 64, _("Send %s"), (const char *)menuKey);
822 contextMenu->add(sendMenuKey, 0, NULL, (void*)ID_MENUKEY, 0);
823 contextMenu->add("Secret shortcut menu key", menuKeyCode, NULL, (void*)ID_MENUKEY, FL_MENU_INVISIBLE);
824 }
825
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000826 contextMenu->add(_("Send Ctrl-Alt-Del"), 0, NULL, (void*)ID_CTRLALTDEL, FL_MENU_DIVIDER);
827
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000828 contextMenu->add(_("Refresh screen"), 0, NULL, (void*)ID_REFRESH, FL_MENU_DIVIDER);
829
Pierre Ossmand463b572011-05-16 12:04:43 +0000830 contextMenu->add(_("Options..."), 0, NULL, (void*)ID_OPTIONS, 0);
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000831 contextMenu->add(_("Connection info..."), 0, NULL, (void*)ID_INFO, 0);
Pierre Ossmanb8858222011-04-29 11:51:38 +0000832 contextMenu->add(_("About TigerVNC viewer..."), 0, NULL, (void*)ID_ABOUT, FL_MENU_DIVIDER);
833
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000834 contextMenu->add(_("Dismiss menu"), 0, NULL, (void*)ID_DISMISS, 0);
835}
836
837
838void Viewport::popupContextMenu()
839{
840 const Fl_Menu_Item *m;
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000841 char buffer[1024];
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000842
Pierre Ossmanb3ff4372011-06-03 11:45:15 +0000843 // Make sure the menu is reset to its initial state between goes or
844 // it will start up highlighting the previously selected entry.
845 contextMenu->value(-1);
846
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000847 m = contextMenu->popup();
848 if (m == NULL)
849 return;
850
851 switch (m->argument()) {
852 case ID_EXIT:
853 exit_vncviewer();
854 break;
Pierre Ossman4c613d32011-05-26 14:14:06 +0000855#ifdef HAVE_FLTK_FULLSCREEN
856 case ID_FULLSCREEN:
857 if (window()->fullscreen_active())
858 window()->fullscreen_off();
859 else
860 window()->fullscreen();
861 break;
862#endif
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000863 case ID_CTRL:
Pierre Ossman991b4fe2011-07-12 16:02:30 +0000864 handleKeyEvent(FL_Control_L, FL_Control_L, "", m->value());
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000865 break;
866 case ID_ALT:
Pierre Ossman991b4fe2011-07-12 16:02:30 +0000867 handleKeyEvent(FL_Alt_L, FL_Alt_L, "", m->value());
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000868 break;
869 case ID_MENUKEY:
Pierre Ossman991b4fe2011-07-12 16:02:30 +0000870 handleKeyEvent(menuKeyCode, menuKeyCode, "", true);
871 handleKeyEvent(menuKeyCode, menuKeyCode, "", false);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000872 break;
873 case ID_CTRLALTDEL:
Pierre Ossman991b4fe2011-07-12 16:02:30 +0000874 handleKeyEvent(FL_Control_L, FL_Control_L, "", true);
875 handleKeyEvent(FL_Alt_L, FL_Alt_L, "", true);
876 handleKeyEvent(FL_Delete, FL_Delete, "", true);
877
878 handleKeyEvent(FL_Delete, FL_Delete, "", false);
879 handleKeyEvent(FL_Alt_L, FL_Alt_L, "", false);
880 handleKeyEvent(FL_Control_L, FL_Control_L, "", false);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000881 break;
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000882 case ID_REFRESH:
883 cc->refreshFramebuffer();
884 break;
Pierre Ossmand463b572011-05-16 12:04:43 +0000885 case ID_OPTIONS:
886 OptionsDialog::showDialog();
887 break;
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000888 case ID_INFO:
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000889 if (fltk_escape(cc->connectionInfo(), buffer, sizeof(buffer)) < sizeof(buffer)) {
890 fl_message_title(_("VNC connection info"));
891 fl_message(buffer);
892 }
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000893 break;
Pierre Ossmanb8858222011-04-29 11:51:38 +0000894 case ID_ABOUT:
895 about_vncviewer();
896 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000897 case ID_DISMISS:
898 // Don't need to do anything
899 break;
900 }
901}
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000902
903
904void Viewport::setMenuKey()
905{
906 const char *menuKeyStr;
907
908 menuKeyCode = 0;
909
910 menuKeyStr = menuKey;
911 if (menuKeyStr[0] == 'F') {
912 int num = atoi(menuKeyStr + 1);
913 if ((num >= 1) && (num <= 12))
914 menuKeyCode = FL_F + num;
915 }
916
917 // Need to repopulate the context menu as it contains references to
918 // the menu key
919 initContextMenu();
920}
921
922
923void Viewport::handleOptions(void *data)
924{
925 Viewport *self = (Viewport*)data;
926
927 self->setMenuKey();
928}