blob: d3c21edb7e4b400324c93c625293d4b37edf18b8 [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
24#include <FL/fl_draw.H>
Pierre Ossman2eb1d112011-05-16 12:18:08 +000025#include <FL/fl_ask.H>
Pierre Ossmand50b3d12011-04-15 07:46:56 +000026
27#include <rfb/CMsgWriter.h>
28#include <rfb/LogWriter.h>
29
30// FLTK can pull in the X11 headers on some systems
31#ifndef XK_VoidSymbol
32#define XK_MISCELLANY
33#define XK_XKB_KEYS
34#include <rfb/keysymdef.h>
35#endif
36
Pierre Ossmancb0cffe2011-05-20 14:55:10 +000037#ifndef XF86XK_ModeLock
38#include <rfb/XF86keysym.h>
39#endif
40
Pierre Ossmand50b3d12011-04-15 07:46:56 +000041#include "Viewport.h"
42#include "CConn.h"
Pierre Ossmand463b572011-05-16 12:04:43 +000043#include "OptionsDialog.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000044#include "i18n.h"
Pierre Ossmanc628ba42011-05-23 12:21:21 +000045#include "fltk_layout.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000046#include "parameters.h"
47#include "keysym2ucs.h"
48
Pierre Ossmand50b3d12011-04-15 07:46:56 +000049using namespace rfb;
Pierre Ossman835b4ef2011-06-08 17:02:36 +000050using namespace rdr;
Pierre Ossmand50b3d12011-04-15 07:46:56 +000051
Pierre Ossmand50b3d12011-04-15 07:46:56 +000052extern void exit_vncviewer();
Pierre Ossmanb8858222011-04-29 11:51:38 +000053extern void about_vncviewer();
Pierre Ossmand50b3d12011-04-15 07:46:56 +000054
55static rfb::LogWriter vlog("Viewport");
56
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000057// Menu constants
58
Pierre Ossman4c613d32011-05-26 14:14:06 +000059enum { ID_EXIT, ID_FULLSCREEN, ID_CTRL, ID_ALT, ID_MENUKEY, ID_CTRLALTDEL,
Pierre Ossman2eb1d112011-05-16 12:18:08 +000060 ID_REFRESH, ID_OPTIONS, ID_INFO, ID_ABOUT, ID_DISMISS };
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000061
Pierre Ossmand50b3d12011-04-15 07:46:56 +000062Viewport::Viewport(int w, int h, const rfb::PixelFormat& serverPF, CConn* cc_)
63 : Fl_Widget(0, 0, w, h), cc(cc_), frameBuffer(NULL), pixelTrans(NULL),
Pierre Ossman835b4ef2011-06-08 17:02:36 +000064 lastPointerPos(0, 0), lastButtonMask(0), cursor(NULL)
Pierre Ossmand50b3d12011-04-15 07:46:56 +000065{
Pierre Ossmanf8c5ef62011-05-13 12:47:54 +000066// FLTK STR #2599 must be fixed for proper dead keys support
67#ifdef HAVE_FLTK_DEAD_KEYS
68 set_simple_keyboard();
69#endif
70
Pierre Ossman4a6be4a2011-05-19 14:49:18 +000071// FLTK STR #2636 gives us the ability to monitor clipboard changes
72#ifdef HAVE_FLTK_CLIPBOARD
73 Fl::add_clipboard_notify(handleClipboardChange, this);
74#endif
75
Pierre Ossmand50b3d12011-04-15 07:46:56 +000076 frameBuffer = new ManagedPixelBuffer(getPreferredPF(), w, h);
77 assert(frameBuffer);
78
79 setServerPF(serverPF);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000080
81 contextMenu = new Fl_Menu_Button(0, 0, 0, 0);
Pierre Ossmanad9d1ae2011-05-26 14:16:02 +000082 // Setting box type to FL_NO_BOX prevents it from trying to draw the
83 // button component (which we don't want)
84 contextMenu->box(FL_NO_BOX);
85
Pierre Ossmanb043ad12011-06-01 09:26:57 +000086 // The (invisible) button associated with this widget can mess with
87 // things like Fl_Scroll so we need to get rid of any parents.
88 // Unfortunately that's not possible because of STR #2654, but
89 // reparenting to the current window works for most cases.
90 window()->add(contextMenu);
91
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000092 initContextMenu();
Pierre Ossman4e7271e2011-05-24 12:47:12 +000093
94 setMenuKey();
95
96 OptionsDialog::addCallback(handleOptions, this);
Pierre Ossmand50b3d12011-04-15 07:46:56 +000097}
98
99
100Viewport::~Viewport()
101{
102 // Unregister all timeouts in case they get a change tro trigger
103 // again later when this object is already gone.
104 Fl::remove_timeout(handleUpdateTimeout, this);
105 Fl::remove_timeout(handleColourMap, this);
106 Fl::remove_timeout(handlePointerTimeout, this);
107
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000108#ifdef HAVE_FLTK_CLIPBOARD
109 Fl::remove_clipboard_notify(handleClipboardChange);
110#endif
111
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000112 OptionsDialog::removeCallback(handleOptions);
113
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000114 delete frameBuffer;
115
116 if (pixelTrans)
117 delete pixelTrans;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000118
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000119 if (cursor) {
Pierre Ossmanf741d342011-06-09 08:32:49 +0000120 if (!cursor->alloc_array)
121 delete [] cursor->array;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000122 delete cursor;
123 }
124
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000125 // FLTK automatically deletes all child widgets, so we shouldn't touch
126 // them ourselves here
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000127}
128
129
130void Viewport::setServerPF(const rfb::PixelFormat& pf)
131{
132 if (pixelTrans)
133 delete pixelTrans;
134 pixelTrans = NULL;
135
136 if (pf.equal(getPreferredPF()))
137 return;
138
139 pixelTrans = new PixelTransformer();
140 pixelTrans->init(pf, &colourMap, getPreferredPF());
141}
142
143
144const rfb::PixelFormat &Viewport::getPreferredPF()
145{
146 static PixelFormat prefPF(32, 24, false, true, 255, 255, 255, 0, 8, 16);
147
148 return prefPF;
149}
150
151
152// setColourMapEntries() changes some of the entries in the colourmap.
153// Unfortunately these messages are often sent one at a time, so we delay the
154// settings taking effect by 100ms. This is because recalculating the internal
155// translation table can be expensive.
156void 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
162 if (!Fl::has_timeout(handleColourMap, this))
163 Fl::add_timeout(0.100, handleColourMap, this);
164}
165
166
167// Copy the areas of the framebuffer that have been changed (damaged)
168// to the displayed window.
169
170void Viewport::updateWindow()
171{
172 Rect r;
173
174 Fl::remove_timeout(handleUpdateTimeout, this);
175
176 r = damage.get_bounding_rect();
Pierre Ossmana6e20772011-04-15 11:10:52 +0000177 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 +0000178
179 damage.clear();
180}
181
Pierre Ossmanf741d342011-06-09 08:32:49 +0000182#ifdef HAVE_FLTK_CURSOR
183static const char * dotcursor_xpm[] = {
184 "5 5 2 1",
185 ". c #000000",
186 " c #FFFFFF",
187 " ",
188 " ... ",
189 " ... ",
190 " ... ",
191 " "};
192#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000193
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000194void Viewport::setCursor(int width, int height, const Point& hotspot,
195 void* data, void* mask)
196{
197#ifdef HAVE_FLTK_CURSOR
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000198 if (cursor) {
Pierre Ossmanf741d342011-06-09 08:32:49 +0000199 if (!cursor->alloc_array)
200 delete [] cursor->array;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000201 delete cursor;
202 }
203
Pierre Ossmanf741d342011-06-09 08:32:49 +0000204 int mask_len = ((width+7)/8) * height;
205 int i;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000206
Pierre Ossmanf741d342011-06-09 08:32:49 +0000207 for (i = 0; i < mask_len; i++)
208 if (((rdr::U8*)mask)[i]) break;
209
Pierre Ossmana51574a2011-06-09 08:39:35 +0000210 if ((i == mask_len) && dotWhenNoCursor) {
211 vlog.debug("cursor is empty - using dot");
Pierre Ossmanf741d342011-06-09 08:32:49 +0000212
213 Fl_Pixmap pxm(dotcursor_xpm);
214 cursor = new Fl_RGB_Image(&pxm);
215 cursorHotspot.x = cursorHotspot.y = 2;
216 } else {
Pierre Ossman17a48f02011-06-09 08:42:04 +0000217 if ((width == 0) || (height == 0)) {
218 U8 *buffer = new U8[4];
219 memset(buffer, 0, 4);
220 cursor = new Fl_RGB_Image(buffer, 1, 1, 4);
221 cursorHotspot.x = cursorHotspot.y = 0;
222 } else {
223 U8 *buffer = new U8[width*height*4];
224 U8 *i, *o, *m;
225 int m_width;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000226
Pierre Ossman17a48f02011-06-09 08:42:04 +0000227 const PixelFormat &pf = frameBuffer->getPF();
Pierre Ossmanf741d342011-06-09 08:32:49 +0000228
Pierre Ossman17a48f02011-06-09 08:42:04 +0000229 i = (U8*)data;
230 o = buffer;
231 m = (U8*)mask;
232 m_width = (width+7)/8;
233 for (int y = 0;y < height;y++) {
234 for (int x = 0;x < width;x++) {
235 pf.rgbFromBuffer(o, i, 1, &colourMap);
Pierre Ossmanf741d342011-06-09 08:32:49 +0000236
Pierre Ossman17a48f02011-06-09 08:42:04 +0000237 if (m[(m_width*y)+(x/8)] & 0x80>>(x%8))
238 o[3] = 255;
239 else
240 o[3] = 0;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000241
Pierre Ossman17a48f02011-06-09 08:42:04 +0000242 o += 4;
243 i += pf.bpp/8;
244 }
Pierre Ossmanf741d342011-06-09 08:32:49 +0000245 }
Pierre Ossman17a48f02011-06-09 08:42:04 +0000246
247 cursor = new Fl_RGB_Image(buffer, width, height, 4);
248
249 cursorHotspot = hotspot;
Pierre Ossmanf741d342011-06-09 08:32:49 +0000250 }
Pierre Ossmanf741d342011-06-09 08:32:49 +0000251 }
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000252
253 if (Fl::belowmouse() == this)
254 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
255#endif
256}
257
258
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000259void Viewport::draw()
260{
261 int X, Y, W, H;
262
263 int pixel_bytes, stride_bytes;
264 const uchar *buf_start;
265
266 // Check what actually needs updating
Pierre Ossmana6e20772011-04-15 11:10:52 +0000267 fl_clip_box(x(), y(), w(), h(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000268 if ((W == 0) || (H == 0))
269 return;
270
271 pixel_bytes = frameBuffer->getPF().bpp/8;
272 stride_bytes = pixel_bytes * frameBuffer->getStride();
273 buf_start = frameBuffer->data +
Pierre Ossmana6e20772011-04-15 11:10:52 +0000274 pixel_bytes * (X - x()) +
275 stride_bytes * (Y - y());
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000276
277 // FIXME: Check how efficient this thing really is
278 fl_draw_image(buf_start, X, Y, W, H, pixel_bytes, stride_bytes);
279}
280
281
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000282void Viewport::resize(int x, int y, int w, int h)
283{
284 rfb::ManagedPixelBuffer* newBuffer;
285 rfb::Rect rect;
286
287 // FIXME: Resize should probably be a feature of ManagedPixelBuffer
288
289 if ((w == frameBuffer->width()) && (h == frameBuffer->height()))
290 goto end;
291
292 newBuffer = new ManagedPixelBuffer(frameBuffer->getPF(), w, h);
293 assert(newBuffer);
294
295 rect.setXYWH(0, 0,
296 __rfbmin(newBuffer->width(), frameBuffer->width()),
297 __rfbmin(newBuffer->height(), frameBuffer->height()));
298 newBuffer->imageRect(rect, frameBuffer->data, frameBuffer->getStride());
299
300 // Black out any new areas
301
302 if (newBuffer->width() > frameBuffer->width()) {
303 rect.setXYWH(frameBuffer->width(), 0,
304 newBuffer->width() - frameBuffer->width(),
305 newBuffer->height());
306 newBuffer->fillRect(rect, 0);
307 }
308
309 if (newBuffer->height() > frameBuffer->height()) {
310 rect.setXYWH(0, frameBuffer->height(),
311 newBuffer->width(),
312 newBuffer->height() - frameBuffer->height());
313 newBuffer->fillRect(rect, 0);
314 }
315
316 delete frameBuffer;
317 frameBuffer = newBuffer;
318
319end:
320 Fl_Widget::resize(x, y, w, h);
321}
322
323
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000324int Viewport::handle(int event)
325{
Pierre Ossman689c4582011-05-26 15:39:41 +0000326 char *buffer;
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000327 int ret;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000328 int buttonMask, wheelMask;
329 DownMap::const_iterator iter;
330
331 switch (event) {
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000332 case FL_PASTE:
Pierre Ossman689c4582011-05-26 15:39:41 +0000333 buffer = new char[Fl::event_length() + 1];
334
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000335 // This is documented as to ASCII, but actually does to 8859-1
Pierre Ossman689c4582011-05-26 15:39:41 +0000336 ret = fl_utf8toa(Fl::event_text(), Fl::event_length(), buffer,
337 Fl::event_length() + 1);
338 assert(ret < (Fl::event_length() + 1));
339
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000340 vlog.debug("Sending clipboard data: '%s'", buffer);
341 cc->writer()->clientCutText(buffer, ret);
Pierre Ossman689c4582011-05-26 15:39:41 +0000342
343 delete [] buffer;
344
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000345 return 1;
Pierre Ossman689c4582011-05-26 15:39:41 +0000346
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000347 case FL_ENTER:
348 // Yes, we would like some pointer events please!
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000349#ifdef HAVE_FLTK_CURSOR
Pierre Ossman1f1f6fd2011-06-09 08:33:29 +0000350 if (cursor)
351 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000352#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000353 return 1;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000354
355 case FL_LEAVE:
356#ifdef HAVE_FLTK_CURSOR
357 window()->cursor(FL_CURSOR_DEFAULT);
358#endif
359 return 1;
360
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000361 case FL_PUSH:
362 case FL_RELEASE:
363 case FL_DRAG:
364 case FL_MOVE:
365 case FL_MOUSEWHEEL:
366 buttonMask = 0;
367 if (Fl::event_button1())
368 buttonMask |= 1;
369 if (Fl::event_button2())
370 buttonMask |= 2;
371 if (Fl::event_button3())
372 buttonMask |= 4;
373
374 if (event == FL_MOUSEWHEEL) {
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000375 wheelMask = 0;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000376 if (Fl::event_dy() < 0)
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000377 wheelMask |= 8;
378 if (Fl::event_dy() > 0)
379 wheelMask |= 16;
380 if (Fl::event_dx() < 0)
381 wheelMask |= 32;
382 if (Fl::event_dx() > 0)
383 wheelMask |= 64;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000384
385 // A quick press of the wheel "button", followed by a immediate
386 // release below
Pierre Ossman6a464be2011-04-15 12:57:31 +0000387 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()),
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000388 buttonMask | wheelMask);
389 }
390
Pierre Ossman6a464be2011-04-15 12:57:31 +0000391 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()), buttonMask);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000392 return 1;
393
394 case FL_FOCUS:
395 // Yes, we would like some focus please!
396 return 1;
397
398 case FL_UNFOCUS:
399 // Release all keys that were pressed as that generally makes most
400 // sense (e.g. Alt+Tab where we only see the Alt press)
Pierre Ossman71f295a2011-05-19 14:55:12 +0000401 for (iter = downKeySym.begin();iter != downKeySym.end();++iter) {
402 vlog.debug("Key released: 0x%04x => 0x%04x", iter->first, iter->second);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000403 cc->writer()->keyEvent(iter->second, false);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000404 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000405 downKeySym.clear();
406 return 1;
407
408 case FL_KEYDOWN:
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000409 if (menuKeyCode && (Fl::event_key() == menuKeyCode)) {
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000410 popupContextMenu();
411 return 1;
412 }
413
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000414 handleKeyEvent(Fl::event_key(), Fl::event_original_key(),
415 Fl::event_text(), true);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000416 return 1;
417
418 case FL_KEYUP:
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000419 if (menuKeyCode && (Fl::event_key() == menuKeyCode))
420 return 1;
421
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000422 handleKeyEvent(Fl::event_key(), Fl::event_original_key(),
423 Fl::event_text(), false);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000424 return 1;
425 }
426
427 return Fl_Widget::handle(event);
428}
429
430
431void Viewport::handleUpdateTimeout(void *data)
432{
433 Viewport *self = (Viewport *)data;
434
435 assert(self);
436
437 self->updateWindow();
438}
439
440
441void Viewport::handleColourMap(void *data)
442{
443 Viewport *self = (Viewport *)data;
444
445 assert(self);
446
447 if (self->pixelTrans != NULL)
448 self->pixelTrans->setColourMapEntries(0, 0);
449
450 self->Fl_Widget::damage(FL_DAMAGE_ALL);
451}
452
453
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000454void Viewport::handleClipboardChange(int source, void *data)
455{
456 Viewport *self = (Viewport *)data;
457
458 assert(self);
459
460 if (!sendPrimary && (source == 0))
461 return;
462
463 Fl::paste(*self, source);
464}
465
466
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000467void Viewport::handlePointerEvent(const rfb::Point& pos, int buttonMask)
468{
469 if (!viewOnly) {
470 if (pointerEventInterval == 0 || buttonMask != lastButtonMask) {
471 cc->writer()->pointerEvent(pos, buttonMask);
472 } else {
473 if (!Fl::has_timeout(handlePointerTimeout, this))
474 Fl::add_timeout((double)pointerEventInterval/1000.0,
475 handlePointerTimeout, this);
476 }
477 lastPointerPos = pos;
478 lastButtonMask = buttonMask;
479 }
480}
481
482
483void Viewport::handlePointerTimeout(void *data)
484{
485 Viewport *self = (Viewport *)data;
486
487 assert(self);
488
489 self->cc->writer()->pointerEvent(self->lastPointerPos, self->lastButtonMask);
490}
491
492
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000493rdr::U32 Viewport::translateKeyEvent(int keyCode, int origKeyCode, const char *keyText)
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000494{
495 unsigned ucs;
496
497 // First check for function keys
498 if ((keyCode > FL_F) && (keyCode <= FL_F_Last))
499 return XK_F1 + (keyCode - FL_F - 1);
500
501 // Numpad numbers
502 if ((keyCode >= (FL_KP + '0')) && (keyCode <= (FL_KP + '9')))
503 return XK_KP_0 + (keyCode - (FL_KP + '0'));
504
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000505 // FLTK does some special remapping of numpad keys when numlock is off
506 if ((origKeyCode >= FL_KP) && (origKeyCode <= FL_KP_Last)) {
507 switch (keyCode) {
508 case FL_F+1:
509 return XK_KP_F1;
510 case FL_F+2:
511 return XK_KP_F2;
512 case FL_F+3:
513 return XK_KP_F3;
514 case FL_F+4:
515 return XK_KP_F4;
516 case FL_Home:
517 return XK_KP_Home;
518 case FL_Left:
519 return XK_KP_Left;
520 case FL_Up:
521 return XK_KP_Up;
522 case FL_Right:
523 return XK_KP_Right;
524 case FL_Down:
525 return XK_KP_Down;
526 case FL_Page_Up:
527 return XK_KP_Page_Up;
528 case FL_Page_Down:
529 return XK_KP_Page_Down;
530 case FL_End:
531 return XK_KP_End;
532 case FL_Insert:
533 return XK_KP_Insert;
534 case FL_Delete:
535 return XK_KP_Delete;
536 }
537 }
538
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000539 // Then other special keys
540 switch (keyCode) {
541 case FL_BackSpace:
542 return XK_BackSpace;
543 case FL_Tab:
544 return XK_Tab;
545 case FL_Enter:
546 return XK_Return;
547 case FL_Pause:
548 return XK_Pause;
549 case FL_Scroll_Lock:
550 return XK_Scroll_Lock;
551 case FL_Escape:
552 return XK_Escape;
553 case FL_Home:
554 return XK_Home;
555 case FL_Left:
556 return XK_Left;
557 case FL_Up:
558 return XK_Up;
559 case FL_Right:
560 return XK_Right;
561 case FL_Down:
562 return XK_Down;
563 case FL_Page_Up:
564 return XK_Page_Up;
565 case FL_Page_Down:
566 return XK_Page_Down;
567 case FL_End:
568 return XK_End;
569 case FL_Print:
570 return XK_Print;
571 case FL_Insert:
572 return XK_Insert;
573 case FL_Menu:
574 return XK_Menu;
575 case FL_Help:
576 return XK_Help;
577 case FL_Num_Lock:
578 return XK_Num_Lock;
579 case FL_Shift_L:
580 return XK_Shift_L;
581 case FL_Shift_R:
582 return XK_Shift_R;
583 case FL_Control_L:
584 return XK_Control_L;
585 case FL_Control_R:
586 return XK_Control_R;
587 case FL_Caps_Lock:
588 return XK_Caps_Lock;
589 case FL_Meta_L:
590 return XK_Super_L;
591 case FL_Meta_R:
592 return XK_Super_R;
593 case FL_Alt_L:
594 return XK_Alt_L;
595 case FL_Alt_R:
596 return XK_Alt_R;
597 case FL_Delete:
598 return XK_Delete;
599 case FL_KP_Enter:
600 return XK_KP_Enter;
601 case FL_KP + '=':
602 return XK_KP_Equal;
603 case FL_KP + '*':
604 return XK_KP_Multiply;
605 case FL_KP + '+':
606 return XK_KP_Add;
607 case FL_KP + ',':
608 return XK_KP_Separator;
609 case FL_KP + '-':
610 return XK_KP_Subtract;
611 case FL_KP + '.':
612 return XK_KP_Decimal;
613 case FL_KP + '/':
614 return XK_KP_Divide;
Pierre Ossmancb0cffe2011-05-20 14:55:10 +0000615#ifdef HAVE_FLTK_MEDIAKEYS
616 case FL_Volume_Down:
617 return XF86XK_AudioLowerVolume;
618 case FL_Volume_Mute:
619 return XF86XK_AudioMute;
620 case FL_Volume_Up:
621 return XF86XK_AudioRaiseVolume;
622 case FL_Media_Play:
623 return XF86XK_AudioPlay;
624 case FL_Media_Stop:
625 return XF86XK_AudioStop;
626 case FL_Media_Prev:
627 return XF86XK_AudioPrev;
628 case FL_Media_Next:
629 return XF86XK_AudioNext;
630 case FL_Home_Page:
631 return XF86XK_HomePage;
632 case FL_Mail:
633 return XF86XK_Mail;
634 case FL_Search:
635 return XF86XK_Search;
636 case FL_Back:
637 return XF86XK_Back;
638 case FL_Forward:
639 return XF86XK_Forward;
640 case FL_Stop:
641 return XF86XK_Stop;
642 case FL_Refresh:
643 return XF86XK_Refresh;
644 case FL_Sleep:
645 return XF86XK_Sleep;
646 case FL_Favorites:
647 return XF86XK_Favorites;
648#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000649 case XK_ISO_Level3_Shift:
650 // FLTK tends to let this one leak through on X11...
651 return XK_ISO_Level3_Shift;
Pierre Ossmana75f8f82011-04-29 11:12:02 +0000652 case XK_Multi_key:
653 // Same for this...
654 return XK_Multi_key;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000655 }
656
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000657 // Unknown special key?
658 if (keyText[0] == '\0') {
659 vlog.error(_("Unknown FLTK key code %d (0x%04x)"), keyCode, keyCode);
660 return XK_VoidSymbol;
661 }
662
663 // Look up the symbol the key produces and translate that from Unicode
664 // to a X11 keysym.
665 if (fl_utf_nb_char((const unsigned char*)keyText, strlen(keyText)) != 1) {
666 vlog.error(_("Multiple characters given for key code %d (0x%04x): '%s'"),
667 keyCode, keyCode, keyText);
668 return XK_VoidSymbol;
669 }
670
671 ucs = fl_utf8decode(keyText, NULL, NULL);
672 return ucs2keysym(ucs);
673}
674
675
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000676void Viewport::handleKeyEvent(int keyCode, int origKeyCode, const char *keyText, bool down)
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000677{
678 rdr::U32 keySym;
679
680 if (viewOnly)
681 return;
682
683 // Because of the way keyboards work, we cannot expect to have the same
684 // symbol on release as when pressed. This breaks the VNC protocol however,
685 // so we need to keep track of what keysym a key _code_ generated on press
686 // and send the same on release.
687 if (!down) {
688 DownMap::iterator iter;
689
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000690 iter = downKeySym.find(origKeyCode);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000691 if (iter == downKeySym.end()) {
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000692 vlog.error(_("Unexpected release of FLTK key code %d (0x%04x)"),
693 origKeyCode, origKeyCode);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000694 return;
695 }
696
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000697 vlog.debug("Key released: 0x%04x => 0x%04x", origKeyCode, iter->second);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000698
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000699 cc->writer()->keyEvent(iter->second, false);
700
701 downKeySym.erase(iter);
702
703 return;
704 }
705
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000706 keySym = translateKeyEvent(keyCode, origKeyCode, keyText);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000707 if (keySym == XK_VoidSymbol)
708 return;
709
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000710 vlog.debug("Key pressed: 0x%04x (0x%04x) '%s' => 0x%04x",
711 origKeyCode, keyCode, keyText, keySym);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000712
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000713 downKeySym[origKeyCode] = keySym;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000714 cc->writer()->keyEvent(keySym, down);
715}
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000716
717
718void Viewport::initContextMenu()
719{
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000720 contextMenu->clear();
721
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000722 contextMenu->add(_("Exit viewer"), 0, NULL, (void*)ID_EXIT, FL_MENU_DIVIDER);
723
Pierre Ossman4c613d32011-05-26 14:14:06 +0000724#ifdef HAVE_FLTK_FULLSCREEN
725 contextMenu->add(_("Full screen"), 0, NULL, (void*)ID_FULLSCREEN, FL_MENU_DIVIDER);
726#endif
727
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000728 contextMenu->add(_("Ctrl"), 0, NULL, (void*)ID_CTRL, FL_MENU_TOGGLE);
729 contextMenu->add(_("Alt"), 0, NULL, (void*)ID_ALT, FL_MENU_TOGGLE);
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000730
731 if (menuKeyCode) {
732 char sendMenuKey[64];
733 snprintf(sendMenuKey, 64, _("Send %s"), (const char *)menuKey);
734 contextMenu->add(sendMenuKey, 0, NULL, (void*)ID_MENUKEY, 0);
735 contextMenu->add("Secret shortcut menu key", menuKeyCode, NULL, (void*)ID_MENUKEY, FL_MENU_INVISIBLE);
736 }
737
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000738 contextMenu->add(_("Send Ctrl-Alt-Del"), 0, NULL, (void*)ID_CTRLALTDEL, FL_MENU_DIVIDER);
739
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000740 contextMenu->add(_("Refresh screen"), 0, NULL, (void*)ID_REFRESH, FL_MENU_DIVIDER);
741
Pierre Ossmand463b572011-05-16 12:04:43 +0000742 contextMenu->add(_("Options..."), 0, NULL, (void*)ID_OPTIONS, 0);
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000743 contextMenu->add(_("Connection info..."), 0, NULL, (void*)ID_INFO, 0);
Pierre Ossmanb8858222011-04-29 11:51:38 +0000744 contextMenu->add(_("About TigerVNC viewer..."), 0, NULL, (void*)ID_ABOUT, FL_MENU_DIVIDER);
745
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000746 contextMenu->add(_("Dismiss menu"), 0, NULL, (void*)ID_DISMISS, 0);
747}
748
749
750void Viewport::popupContextMenu()
751{
752 const Fl_Menu_Item *m;
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000753 char buffer[1024];
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000754
Pierre Ossman407a5c32011-05-26 14:48:29 +0000755 // FIXME: Hacky workaround for the fact that menus grab and ungrab the
756 // keyboard. Releasing focus here triggers some events on ungrab
757 // that DesktopWindow can catch and trigger some voodoo.
758 // See DesktopWindow::handle().
759 if (window()->contains(Fl::focus()))
760 Fl::focus(NULL);
761
Pierre Ossmanb3ff4372011-06-03 11:45:15 +0000762 // Make sure the menu is reset to its initial state between goes or
763 // it will start up highlighting the previously selected entry.
764 contextMenu->value(-1);
765
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000766 m = contextMenu->popup();
767 if (m == NULL)
768 return;
769
770 switch (m->argument()) {
771 case ID_EXIT:
772 exit_vncviewer();
773 break;
Pierre Ossman4c613d32011-05-26 14:14:06 +0000774#ifdef HAVE_FLTK_FULLSCREEN
775 case ID_FULLSCREEN:
776 if (window()->fullscreen_active())
777 window()->fullscreen_off();
778 else
779 window()->fullscreen();
780 break;
781#endif
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000782 case ID_CTRL:
783 if (!viewOnly)
784 cc->writer()->keyEvent(XK_Control_L, m->value());
785 break;
786 case ID_ALT:
787 if (!viewOnly)
788 cc->writer()->keyEvent(XK_Alt_L, m->value());
789 break;
790 case ID_MENUKEY:
791 if (!viewOnly) {
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000792 handleKeyEvent(menuKeyCode, menuKeyCode, "", true);
793 handleKeyEvent(menuKeyCode, menuKeyCode, "", false);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000794 }
795 break;
796 case ID_CTRLALTDEL:
797 if (!viewOnly) {
798 cc->writer()->keyEvent(XK_Control_L, true);
799 cc->writer()->keyEvent(XK_Alt_L, true);
800 cc->writer()->keyEvent(XK_Delete, true);
801 cc->writer()->keyEvent(XK_Delete, false);
802 cc->writer()->keyEvent(XK_Alt_L, false);
803 cc->writer()->keyEvent(XK_Control_L, false);
804 }
805 break;
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000806 case ID_REFRESH:
807 cc->refreshFramebuffer();
808 break;
Pierre Ossmand463b572011-05-16 12:04:43 +0000809 case ID_OPTIONS:
810 OptionsDialog::showDialog();
811 break;
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000812 case ID_INFO:
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000813 if (fltk_escape(cc->connectionInfo(), buffer, sizeof(buffer)) < sizeof(buffer)) {
814 fl_message_title(_("VNC connection info"));
815 fl_message(buffer);
816 }
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000817 break;
Pierre Ossmanb8858222011-04-29 11:51:38 +0000818 case ID_ABOUT:
819 about_vncviewer();
820 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000821 case ID_DISMISS:
822 // Don't need to do anything
823 break;
824 }
825}
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000826
827
828void Viewport::setMenuKey()
829{
830 const char *menuKeyStr;
831
832 menuKeyCode = 0;
833
834 menuKeyStr = menuKey;
835 if (menuKeyStr[0] == 'F') {
836 int num = atoi(menuKeyStr + 1);
837 if ((num >= 1) && (num <= 12))
838 menuKeyCode = FL_F + num;
839 }
840
841 // Need to repopulate the context menu as it contains references to
842 // the menu key
843 initContextMenu();
844}
845
846
847void Viewport::handleOptions(void *data)
848{
849 Viewport *self = (Viewport*)data;
850
851 self->setMenuKey();
852}