blob: 14feaf88119709e6f46a2ad829ee0c837556586d [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
210 if (i == mask_len) {
211 if (dotWhenNoCursor)
212 vlog.debug("cursor is empty - using dot");
213
214 Fl_Pixmap pxm(dotcursor_xpm);
215 cursor = new Fl_RGB_Image(&pxm);
216 cursorHotspot.x = cursorHotspot.y = 2;
217 } else {
218 U8 *buffer = new U8[width*height*4];
219 U8 *i, *o, *m;
220 int m_width;
221
222 const PixelFormat &pf = frameBuffer->getPF();
223
224 i = (U8*)data;
225 o = buffer;
226 m = (U8*)mask;
227 m_width = (width+7)/8;
228 for (int y = 0;y < height;y++) {
229 for (int x = 0;x < width;x++) {
230 pf.rgbFromBuffer(o, i, 1, &colourMap);
231
232 if (m[(m_width*y)+(x/8)] & 0x80>>(x%8))
233 o[3] = 255;
234 else
235 o[3] = 0;
236
237 o += 4;
238 i += pf.bpp/8;
239 }
240 }
241
242 cursor = new Fl_RGB_Image(buffer, width, height, 4);
243
244 cursorHotspot = hotspot;
245 }
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000246
247 if (Fl::belowmouse() == this)
248 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
249#endif
250}
251
252
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000253void Viewport::draw()
254{
255 int X, Y, W, H;
256
257 int pixel_bytes, stride_bytes;
258 const uchar *buf_start;
259
260 // Check what actually needs updating
Pierre Ossmana6e20772011-04-15 11:10:52 +0000261 fl_clip_box(x(), y(), w(), h(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000262 if ((W == 0) || (H == 0))
263 return;
264
265 pixel_bytes = frameBuffer->getPF().bpp/8;
266 stride_bytes = pixel_bytes * frameBuffer->getStride();
267 buf_start = frameBuffer->data +
Pierre Ossmana6e20772011-04-15 11:10:52 +0000268 pixel_bytes * (X - x()) +
269 stride_bytes * (Y - y());
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000270
271 // FIXME: Check how efficient this thing really is
272 fl_draw_image(buf_start, X, Y, W, H, pixel_bytes, stride_bytes);
273}
274
275
Pierre Ossmane00f0aa2011-06-01 09:31:53 +0000276void Viewport::resize(int x, int y, int w, int h)
277{
278 rfb::ManagedPixelBuffer* newBuffer;
279 rfb::Rect rect;
280
281 // FIXME: Resize should probably be a feature of ManagedPixelBuffer
282
283 if ((w == frameBuffer->width()) && (h == frameBuffer->height()))
284 goto end;
285
286 newBuffer = new ManagedPixelBuffer(frameBuffer->getPF(), w, h);
287 assert(newBuffer);
288
289 rect.setXYWH(0, 0,
290 __rfbmin(newBuffer->width(), frameBuffer->width()),
291 __rfbmin(newBuffer->height(), frameBuffer->height()));
292 newBuffer->imageRect(rect, frameBuffer->data, frameBuffer->getStride());
293
294 // Black out any new areas
295
296 if (newBuffer->width() > frameBuffer->width()) {
297 rect.setXYWH(frameBuffer->width(), 0,
298 newBuffer->width() - frameBuffer->width(),
299 newBuffer->height());
300 newBuffer->fillRect(rect, 0);
301 }
302
303 if (newBuffer->height() > frameBuffer->height()) {
304 rect.setXYWH(0, frameBuffer->height(),
305 newBuffer->width(),
306 newBuffer->height() - frameBuffer->height());
307 newBuffer->fillRect(rect, 0);
308 }
309
310 delete frameBuffer;
311 frameBuffer = newBuffer;
312
313end:
314 Fl_Widget::resize(x, y, w, h);
315}
316
317
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000318int Viewport::handle(int event)
319{
Pierre Ossman689c4582011-05-26 15:39:41 +0000320 char *buffer;
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000321 int ret;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000322 int buttonMask, wheelMask;
323 DownMap::const_iterator iter;
324
325 switch (event) {
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000326 case FL_PASTE:
Pierre Ossman689c4582011-05-26 15:39:41 +0000327 buffer = new char[Fl::event_length() + 1];
328
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000329 // This is documented as to ASCII, but actually does to 8859-1
Pierre Ossman689c4582011-05-26 15:39:41 +0000330 ret = fl_utf8toa(Fl::event_text(), Fl::event_length(), buffer,
331 Fl::event_length() + 1);
332 assert(ret < (Fl::event_length() + 1));
333
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000334 vlog.debug("Sending clipboard data: '%s'", buffer);
335 cc->writer()->clientCutText(buffer, ret);
Pierre Ossman689c4582011-05-26 15:39:41 +0000336
337 delete [] buffer;
338
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000339 return 1;
Pierre Ossman689c4582011-05-26 15:39:41 +0000340
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000341 case FL_ENTER:
342 // Yes, we would like some pointer events please!
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000343#ifdef HAVE_FLTK_CURSOR
Pierre Ossman1f1f6fd2011-06-09 08:33:29 +0000344 if (cursor)
345 window()->cursor(cursor, cursorHotspot.x, cursorHotspot.y);
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000346#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000347 return 1;
Pierre Ossman835b4ef2011-06-08 17:02:36 +0000348
349 case FL_LEAVE:
350#ifdef HAVE_FLTK_CURSOR
351 window()->cursor(FL_CURSOR_DEFAULT);
352#endif
353 return 1;
354
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000355 case FL_PUSH:
356 case FL_RELEASE:
357 case FL_DRAG:
358 case FL_MOVE:
359 case FL_MOUSEWHEEL:
360 buttonMask = 0;
361 if (Fl::event_button1())
362 buttonMask |= 1;
363 if (Fl::event_button2())
364 buttonMask |= 2;
365 if (Fl::event_button3())
366 buttonMask |= 4;
367
368 if (event == FL_MOUSEWHEEL) {
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000369 wheelMask = 0;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000370 if (Fl::event_dy() < 0)
Pierre Ossmandf0ed9f2011-05-24 11:33:43 +0000371 wheelMask |= 8;
372 if (Fl::event_dy() > 0)
373 wheelMask |= 16;
374 if (Fl::event_dx() < 0)
375 wheelMask |= 32;
376 if (Fl::event_dx() > 0)
377 wheelMask |= 64;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000378
379 // A quick press of the wheel "button", followed by a immediate
380 // release below
Pierre Ossman6a464be2011-04-15 12:57:31 +0000381 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()),
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000382 buttonMask | wheelMask);
383 }
384
Pierre Ossman6a464be2011-04-15 12:57:31 +0000385 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()), buttonMask);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000386 return 1;
387
388 case FL_FOCUS:
389 // Yes, we would like some focus please!
390 return 1;
391
392 case FL_UNFOCUS:
393 // Release all keys that were pressed as that generally makes most
394 // sense (e.g. Alt+Tab where we only see the Alt press)
Pierre Ossman71f295a2011-05-19 14:55:12 +0000395 for (iter = downKeySym.begin();iter != downKeySym.end();++iter) {
396 vlog.debug("Key released: 0x%04x => 0x%04x", iter->first, iter->second);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000397 cc->writer()->keyEvent(iter->second, false);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000398 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000399 downKeySym.clear();
400 return 1;
401
402 case FL_KEYDOWN:
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000403 if (menuKeyCode && (Fl::event_key() == menuKeyCode)) {
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000404 popupContextMenu();
405 return 1;
406 }
407
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000408 handleKeyEvent(Fl::event_key(), Fl::event_original_key(),
409 Fl::event_text(), true);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000410 return 1;
411
412 case FL_KEYUP:
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000413 if (menuKeyCode && (Fl::event_key() == menuKeyCode))
414 return 1;
415
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000416 handleKeyEvent(Fl::event_key(), Fl::event_original_key(),
417 Fl::event_text(), false);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000418 return 1;
419 }
420
421 return Fl_Widget::handle(event);
422}
423
424
425void Viewport::handleUpdateTimeout(void *data)
426{
427 Viewport *self = (Viewport *)data;
428
429 assert(self);
430
431 self->updateWindow();
432}
433
434
435void Viewport::handleColourMap(void *data)
436{
437 Viewport *self = (Viewport *)data;
438
439 assert(self);
440
441 if (self->pixelTrans != NULL)
442 self->pixelTrans->setColourMapEntries(0, 0);
443
444 self->Fl_Widget::damage(FL_DAMAGE_ALL);
445}
446
447
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000448void Viewport::handleClipboardChange(int source, void *data)
449{
450 Viewport *self = (Viewport *)data;
451
452 assert(self);
453
454 if (!sendPrimary && (source == 0))
455 return;
456
457 Fl::paste(*self, source);
458}
459
460
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000461void Viewport::handlePointerEvent(const rfb::Point& pos, int buttonMask)
462{
463 if (!viewOnly) {
464 if (pointerEventInterval == 0 || buttonMask != lastButtonMask) {
465 cc->writer()->pointerEvent(pos, buttonMask);
466 } else {
467 if (!Fl::has_timeout(handlePointerTimeout, this))
468 Fl::add_timeout((double)pointerEventInterval/1000.0,
469 handlePointerTimeout, this);
470 }
471 lastPointerPos = pos;
472 lastButtonMask = buttonMask;
473 }
474}
475
476
477void Viewport::handlePointerTimeout(void *data)
478{
479 Viewport *self = (Viewport *)data;
480
481 assert(self);
482
483 self->cc->writer()->pointerEvent(self->lastPointerPos, self->lastButtonMask);
484}
485
486
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000487rdr::U32 Viewport::translateKeyEvent(int keyCode, int origKeyCode, const char *keyText)
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000488{
489 unsigned ucs;
490
491 // First check for function keys
492 if ((keyCode > FL_F) && (keyCode <= FL_F_Last))
493 return XK_F1 + (keyCode - FL_F - 1);
494
495 // Numpad numbers
496 if ((keyCode >= (FL_KP + '0')) && (keyCode <= (FL_KP + '9')))
497 return XK_KP_0 + (keyCode - (FL_KP + '0'));
498
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000499 // FLTK does some special remapping of numpad keys when numlock is off
500 if ((origKeyCode >= FL_KP) && (origKeyCode <= FL_KP_Last)) {
501 switch (keyCode) {
502 case FL_F+1:
503 return XK_KP_F1;
504 case FL_F+2:
505 return XK_KP_F2;
506 case FL_F+3:
507 return XK_KP_F3;
508 case FL_F+4:
509 return XK_KP_F4;
510 case FL_Home:
511 return XK_KP_Home;
512 case FL_Left:
513 return XK_KP_Left;
514 case FL_Up:
515 return XK_KP_Up;
516 case FL_Right:
517 return XK_KP_Right;
518 case FL_Down:
519 return XK_KP_Down;
520 case FL_Page_Up:
521 return XK_KP_Page_Up;
522 case FL_Page_Down:
523 return XK_KP_Page_Down;
524 case FL_End:
525 return XK_KP_End;
526 case FL_Insert:
527 return XK_KP_Insert;
528 case FL_Delete:
529 return XK_KP_Delete;
530 }
531 }
532
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000533 // Then other special keys
534 switch (keyCode) {
535 case FL_BackSpace:
536 return XK_BackSpace;
537 case FL_Tab:
538 return XK_Tab;
539 case FL_Enter:
540 return XK_Return;
541 case FL_Pause:
542 return XK_Pause;
543 case FL_Scroll_Lock:
544 return XK_Scroll_Lock;
545 case FL_Escape:
546 return XK_Escape;
547 case FL_Home:
548 return XK_Home;
549 case FL_Left:
550 return XK_Left;
551 case FL_Up:
552 return XK_Up;
553 case FL_Right:
554 return XK_Right;
555 case FL_Down:
556 return XK_Down;
557 case FL_Page_Up:
558 return XK_Page_Up;
559 case FL_Page_Down:
560 return XK_Page_Down;
561 case FL_End:
562 return XK_End;
563 case FL_Print:
564 return XK_Print;
565 case FL_Insert:
566 return XK_Insert;
567 case FL_Menu:
568 return XK_Menu;
569 case FL_Help:
570 return XK_Help;
571 case FL_Num_Lock:
572 return XK_Num_Lock;
573 case FL_Shift_L:
574 return XK_Shift_L;
575 case FL_Shift_R:
576 return XK_Shift_R;
577 case FL_Control_L:
578 return XK_Control_L;
579 case FL_Control_R:
580 return XK_Control_R;
581 case FL_Caps_Lock:
582 return XK_Caps_Lock;
583 case FL_Meta_L:
584 return XK_Super_L;
585 case FL_Meta_R:
586 return XK_Super_R;
587 case FL_Alt_L:
588 return XK_Alt_L;
589 case FL_Alt_R:
590 return XK_Alt_R;
591 case FL_Delete:
592 return XK_Delete;
593 case FL_KP_Enter:
594 return XK_KP_Enter;
595 case FL_KP + '=':
596 return XK_KP_Equal;
597 case FL_KP + '*':
598 return XK_KP_Multiply;
599 case FL_KP + '+':
600 return XK_KP_Add;
601 case FL_KP + ',':
602 return XK_KP_Separator;
603 case FL_KP + '-':
604 return XK_KP_Subtract;
605 case FL_KP + '.':
606 return XK_KP_Decimal;
607 case FL_KP + '/':
608 return XK_KP_Divide;
Pierre Ossmancb0cffe2011-05-20 14:55:10 +0000609#ifdef HAVE_FLTK_MEDIAKEYS
610 case FL_Volume_Down:
611 return XF86XK_AudioLowerVolume;
612 case FL_Volume_Mute:
613 return XF86XK_AudioMute;
614 case FL_Volume_Up:
615 return XF86XK_AudioRaiseVolume;
616 case FL_Media_Play:
617 return XF86XK_AudioPlay;
618 case FL_Media_Stop:
619 return XF86XK_AudioStop;
620 case FL_Media_Prev:
621 return XF86XK_AudioPrev;
622 case FL_Media_Next:
623 return XF86XK_AudioNext;
624 case FL_Home_Page:
625 return XF86XK_HomePage;
626 case FL_Mail:
627 return XF86XK_Mail;
628 case FL_Search:
629 return XF86XK_Search;
630 case FL_Back:
631 return XF86XK_Back;
632 case FL_Forward:
633 return XF86XK_Forward;
634 case FL_Stop:
635 return XF86XK_Stop;
636 case FL_Refresh:
637 return XF86XK_Refresh;
638 case FL_Sleep:
639 return XF86XK_Sleep;
640 case FL_Favorites:
641 return XF86XK_Favorites;
642#endif
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000643 case XK_ISO_Level3_Shift:
644 // FLTK tends to let this one leak through on X11...
645 return XK_ISO_Level3_Shift;
Pierre Ossmana75f8f82011-04-29 11:12:02 +0000646 case XK_Multi_key:
647 // Same for this...
648 return XK_Multi_key;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000649 }
650
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000651 // Unknown special key?
652 if (keyText[0] == '\0') {
653 vlog.error(_("Unknown FLTK key code %d (0x%04x)"), keyCode, keyCode);
654 return XK_VoidSymbol;
655 }
656
657 // Look up the symbol the key produces and translate that from Unicode
658 // to a X11 keysym.
659 if (fl_utf_nb_char((const unsigned char*)keyText, strlen(keyText)) != 1) {
660 vlog.error(_("Multiple characters given for key code %d (0x%04x): '%s'"),
661 keyCode, keyCode, keyText);
662 return XK_VoidSymbol;
663 }
664
665 ucs = fl_utf8decode(keyText, NULL, NULL);
666 return ucs2keysym(ucs);
667}
668
669
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000670void Viewport::handleKeyEvent(int keyCode, int origKeyCode, const char *keyText, bool down)
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000671{
672 rdr::U32 keySym;
673
674 if (viewOnly)
675 return;
676
677 // Because of the way keyboards work, we cannot expect to have the same
678 // symbol on release as when pressed. This breaks the VNC protocol however,
679 // so we need to keep track of what keysym a key _code_ generated on press
680 // and send the same on release.
681 if (!down) {
682 DownMap::iterator iter;
683
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000684 iter = downKeySym.find(origKeyCode);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000685 if (iter == downKeySym.end()) {
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000686 vlog.error(_("Unexpected release of FLTK key code %d (0x%04x)"),
687 origKeyCode, origKeyCode);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000688 return;
689 }
690
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000691 vlog.debug("Key released: 0x%04x => 0x%04x", origKeyCode, iter->second);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000692
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000693 cc->writer()->keyEvent(iter->second, false);
694
695 downKeySym.erase(iter);
696
697 return;
698 }
699
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000700 keySym = translateKeyEvent(keyCode, origKeyCode, keyText);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000701 if (keySym == XK_VoidSymbol)
702 return;
703
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000704 vlog.debug("Key pressed: 0x%04x (0x%04x) '%s' => 0x%04x",
705 origKeyCode, keyCode, keyText, keySym);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000706
Pierre Ossmancd6ddef2011-05-20 12:05:20 +0000707 downKeySym[origKeyCode] = keySym;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000708 cc->writer()->keyEvent(keySym, down);
709}
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000710
711
712void Viewport::initContextMenu()
713{
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000714 contextMenu->clear();
715
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000716 contextMenu->add(_("Exit viewer"), 0, NULL, (void*)ID_EXIT, FL_MENU_DIVIDER);
717
Pierre Ossman4c613d32011-05-26 14:14:06 +0000718#ifdef HAVE_FLTK_FULLSCREEN
719 contextMenu->add(_("Full screen"), 0, NULL, (void*)ID_FULLSCREEN, FL_MENU_DIVIDER);
720#endif
721
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000722 contextMenu->add(_("Ctrl"), 0, NULL, (void*)ID_CTRL, FL_MENU_TOGGLE);
723 contextMenu->add(_("Alt"), 0, NULL, (void*)ID_ALT, FL_MENU_TOGGLE);
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000724
725 if (menuKeyCode) {
726 char sendMenuKey[64];
727 snprintf(sendMenuKey, 64, _("Send %s"), (const char *)menuKey);
728 contextMenu->add(sendMenuKey, 0, NULL, (void*)ID_MENUKEY, 0);
729 contextMenu->add("Secret shortcut menu key", menuKeyCode, NULL, (void*)ID_MENUKEY, FL_MENU_INVISIBLE);
730 }
731
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000732 contextMenu->add(_("Send Ctrl-Alt-Del"), 0, NULL, (void*)ID_CTRLALTDEL, FL_MENU_DIVIDER);
733
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000734 contextMenu->add(_("Refresh screen"), 0, NULL, (void*)ID_REFRESH, FL_MENU_DIVIDER);
735
Pierre Ossmand463b572011-05-16 12:04:43 +0000736 contextMenu->add(_("Options..."), 0, NULL, (void*)ID_OPTIONS, 0);
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000737 contextMenu->add(_("Connection info..."), 0, NULL, (void*)ID_INFO, 0);
Pierre Ossmanb8858222011-04-29 11:51:38 +0000738 contextMenu->add(_("About TigerVNC viewer..."), 0, NULL, (void*)ID_ABOUT, FL_MENU_DIVIDER);
739
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000740 contextMenu->add(_("Dismiss menu"), 0, NULL, (void*)ID_DISMISS, 0);
741}
742
743
744void Viewport::popupContextMenu()
745{
746 const Fl_Menu_Item *m;
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000747 char buffer[1024];
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000748
Pierre Ossman407a5c32011-05-26 14:48:29 +0000749 // FIXME: Hacky workaround for the fact that menus grab and ungrab the
750 // keyboard. Releasing focus here triggers some events on ungrab
751 // that DesktopWindow can catch and trigger some voodoo.
752 // See DesktopWindow::handle().
753 if (window()->contains(Fl::focus()))
754 Fl::focus(NULL);
755
Pierre Ossmanb3ff4372011-06-03 11:45:15 +0000756 // Make sure the menu is reset to its initial state between goes or
757 // it will start up highlighting the previously selected entry.
758 contextMenu->value(-1);
759
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000760 m = contextMenu->popup();
761 if (m == NULL)
762 return;
763
764 switch (m->argument()) {
765 case ID_EXIT:
766 exit_vncviewer();
767 break;
Pierre Ossman4c613d32011-05-26 14:14:06 +0000768#ifdef HAVE_FLTK_FULLSCREEN
769 case ID_FULLSCREEN:
770 if (window()->fullscreen_active())
771 window()->fullscreen_off();
772 else
773 window()->fullscreen();
774 break;
775#endif
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000776 case ID_CTRL:
777 if (!viewOnly)
778 cc->writer()->keyEvent(XK_Control_L, m->value());
779 break;
780 case ID_ALT:
781 if (!viewOnly)
782 cc->writer()->keyEvent(XK_Alt_L, m->value());
783 break;
784 case ID_MENUKEY:
785 if (!viewOnly) {
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000786 handleKeyEvent(menuKeyCode, menuKeyCode, "", true);
787 handleKeyEvent(menuKeyCode, menuKeyCode, "", false);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000788 }
789 break;
790 case ID_CTRLALTDEL:
791 if (!viewOnly) {
792 cc->writer()->keyEvent(XK_Control_L, true);
793 cc->writer()->keyEvent(XK_Alt_L, true);
794 cc->writer()->keyEvent(XK_Delete, true);
795 cc->writer()->keyEvent(XK_Delete, false);
796 cc->writer()->keyEvent(XK_Alt_L, false);
797 cc->writer()->keyEvent(XK_Control_L, false);
798 }
799 break;
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000800 case ID_REFRESH:
801 cc->refreshFramebuffer();
802 break;
Pierre Ossmand463b572011-05-16 12:04:43 +0000803 case ID_OPTIONS:
804 OptionsDialog::showDialog();
805 break;
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000806 case ID_INFO:
Pierre Ossmanc628ba42011-05-23 12:21:21 +0000807 if (fltk_escape(cc->connectionInfo(), buffer, sizeof(buffer)) < sizeof(buffer)) {
808 fl_message_title(_("VNC connection info"));
809 fl_message(buffer);
810 }
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000811 break;
Pierre Ossmanb8858222011-04-29 11:51:38 +0000812 case ID_ABOUT:
813 about_vncviewer();
814 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000815 case ID_DISMISS:
816 // Don't need to do anything
817 break;
818 }
819}
Pierre Ossman4e7271e2011-05-24 12:47:12 +0000820
821
822void Viewport::setMenuKey()
823{
824 const char *menuKeyStr;
825
826 menuKeyCode = 0;
827
828 menuKeyStr = menuKey;
829 if (menuKeyStr[0] == 'F') {
830 int num = atoi(menuKeyStr + 1);
831 if ((num >= 1) && (num <= 12))
832 menuKeyCode = FL_F + num;
833 }
834
835 // Need to repopulate the context menu as it contains references to
836 // the menu key
837 initContextMenu();
838}
839
840
841void Viewport::handleOptions(void *data)
842{
843 Viewport *self = (Viewport*)data;
844
845 self->setMenuKey();
846}