blob: 89a3d517897f85cda0afd339da04ae2e95b3317b [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
37#include "Viewport.h"
38#include "CConn.h"
Pierre Ossmand463b572011-05-16 12:04:43 +000039#include "OptionsDialog.h"
Pierre Ossmand50b3d12011-04-15 07:46:56 +000040#include "i18n.h"
41#include "parameters.h"
42#include "keysym2ucs.h"
43
Pierre Ossmand50b3d12011-04-15 07:46:56 +000044using namespace rfb;
45
46#ifdef __APPLE__
47extern "C" const char *osx_event_string(void);
48#endif
49
50extern void exit_vncviewer();
Pierre Ossmanb8858222011-04-29 11:51:38 +000051extern void about_vncviewer();
Pierre Ossmand50b3d12011-04-15 07:46:56 +000052
53static rfb::LogWriter vlog("Viewport");
54
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000055// Menu constants
56
Pierre Ossmand4c61ce2011-04-29 11:18:12 +000057enum { ID_EXIT, ID_CTRL, ID_ALT, ID_MENUKEY, ID_CTRLALTDEL,
Pierre Ossman2eb1d112011-05-16 12:18:08 +000058 ID_REFRESH, ID_OPTIONS, ID_INFO, ID_ABOUT, ID_DISMISS };
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000059
Pierre Ossmand50b3d12011-04-15 07:46:56 +000060Viewport::Viewport(int w, int h, const rfb::PixelFormat& serverPF, CConn* cc_)
61 : Fl_Widget(0, 0, w, h), cc(cc_), frameBuffer(NULL), pixelTrans(NULL),
62 lastPointerPos(0, 0), lastButtonMask(0)
63{
Pierre Ossmanf8c5ef62011-05-13 12:47:54 +000064// FLTK STR #2599 must be fixed for proper dead keys support
65#ifdef HAVE_FLTK_DEAD_KEYS
66 set_simple_keyboard();
67#endif
68
Pierre Ossman4a6be4a2011-05-19 14:49:18 +000069// FLTK STR #2636 gives us the ability to monitor clipboard changes
70#ifdef HAVE_FLTK_CLIPBOARD
71 Fl::add_clipboard_notify(handleClipboardChange, this);
72#endif
73
Pierre Ossmand50b3d12011-04-15 07:46:56 +000074 frameBuffer = new ManagedPixelBuffer(getPreferredPF(), w, h);
75 assert(frameBuffer);
76
77 setServerPF(serverPF);
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +000078
79 contextMenu = new Fl_Menu_Button(0, 0, 0, 0);
80 initContextMenu();
Pierre Ossmand50b3d12011-04-15 07:46:56 +000081}
82
83
84Viewport::~Viewport()
85{
86 // Unregister all timeouts in case they get a change tro trigger
87 // again later when this object is already gone.
88 Fl::remove_timeout(handleUpdateTimeout, this);
89 Fl::remove_timeout(handleColourMap, this);
90 Fl::remove_timeout(handlePointerTimeout, this);
91
Pierre Ossman4a6be4a2011-05-19 14:49:18 +000092#ifdef HAVE_FLTK_CLIPBOARD
93 Fl::remove_clipboard_notify(handleClipboardChange);
94#endif
95
Pierre Ossmand50b3d12011-04-15 07:46:56 +000096 delete frameBuffer;
97
98 if (pixelTrans)
99 delete pixelTrans;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000100
101 // FLTK automatically deletes all child widgets, so we shouldn't touch
102 // them ourselves here
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000103}
104
105
106void Viewport::setServerPF(const rfb::PixelFormat& pf)
107{
108 if (pixelTrans)
109 delete pixelTrans;
110 pixelTrans = NULL;
111
112 if (pf.equal(getPreferredPF()))
113 return;
114
115 pixelTrans = new PixelTransformer();
116 pixelTrans->init(pf, &colourMap, getPreferredPF());
117}
118
119
120const rfb::PixelFormat &Viewport::getPreferredPF()
121{
122 static PixelFormat prefPF(32, 24, false, true, 255, 255, 255, 0, 8, 16);
123
124 return prefPF;
125}
126
127
128// setColourMapEntries() changes some of the entries in the colourmap.
129// Unfortunately these messages are often sent one at a time, so we delay the
130// settings taking effect by 100ms. This is because recalculating the internal
131// translation table can be expensive.
132void Viewport::setColourMapEntries(int firstColour, int nColours,
133 rdr::U16* rgbs)
134{
135 for (int i = 0; i < nColours; i++)
136 colourMap.set(firstColour+i, rgbs[i*3], rgbs[i*3+1], rgbs[i*3+2]);
137
138 if (!Fl::has_timeout(handleColourMap, this))
139 Fl::add_timeout(0.100, handleColourMap, this);
140}
141
142
143// Copy the areas of the framebuffer that have been changed (damaged)
144// to the displayed window.
145
146void Viewport::updateWindow()
147{
148 Rect r;
149
150 Fl::remove_timeout(handleUpdateTimeout, this);
151
152 r = damage.get_bounding_rect();
Pierre Ossmana6e20772011-04-15 11:10:52 +0000153 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 +0000154
155 damage.clear();
156}
157
158
159void Viewport::draw()
160{
161 int X, Y, W, H;
162
163 int pixel_bytes, stride_bytes;
164 const uchar *buf_start;
165
166 // Check what actually needs updating
Pierre Ossmana6e20772011-04-15 11:10:52 +0000167 fl_clip_box(x(), y(), w(), h(), X, Y, W, H);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000168 if ((W == 0) || (H == 0))
169 return;
170
171 pixel_bytes = frameBuffer->getPF().bpp/8;
172 stride_bytes = pixel_bytes * frameBuffer->getStride();
173 buf_start = frameBuffer->data +
Pierre Ossmana6e20772011-04-15 11:10:52 +0000174 pixel_bytes * (X - x()) +
175 stride_bytes * (Y - y());
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000176
177 // FIXME: Check how efficient this thing really is
178 fl_draw_image(buf_start, X, Y, W, H, pixel_bytes, stride_bytes);
179}
180
181
182int Viewport::handle(int event)
183{
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000184 char buffer[1024];
185 int ret;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000186 int buttonMask, wheelMask;
187 DownMap::const_iterator iter;
188
189 switch (event) {
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000190 case FL_PASTE:
191 // This is documented as to ASCII, but actually does to 8859-1
192 ret = fl_utf8toa(Fl::event_text(), Fl::event_length(), buffer, sizeof(buffer));
193 if (ret >= sizeof(buffer)) {
194 vlog.error(_("Clipboard buffer overflow!"));
195 return 1;
196 }
197 vlog.debug("Sending clipboard data: '%s'", buffer);
198 cc->writer()->clientCutText(buffer, ret);
199 return 1;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000200 case FL_ENTER:
201 // Yes, we would like some pointer events please!
202 return 1;
203 case FL_PUSH:
204 case FL_RELEASE:
205 case FL_DRAG:
206 case FL_MOVE:
207 case FL_MOUSEWHEEL:
208 buttonMask = 0;
209 if (Fl::event_button1())
210 buttonMask |= 1;
211 if (Fl::event_button2())
212 buttonMask |= 2;
213 if (Fl::event_button3())
214 buttonMask |= 4;
215
216 if (event == FL_MOUSEWHEEL) {
217 if (Fl::event_dy() < 0)
218 wheelMask = 8;
219 else
220 wheelMask = 16;
221
222 // A quick press of the wheel "button", followed by a immediate
223 // release below
Pierre Ossman6a464be2011-04-15 12:57:31 +0000224 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()),
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000225 buttonMask | wheelMask);
226 }
227
Pierre Ossman6a464be2011-04-15 12:57:31 +0000228 handlePointerEvent(Point(Fl::event_x() - x(), Fl::event_y() - y()), buttonMask);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000229 return 1;
230
231 case FL_FOCUS:
232 // Yes, we would like some focus please!
233 return 1;
234
235 case FL_UNFOCUS:
236 // Release all keys that were pressed as that generally makes most
237 // sense (e.g. Alt+Tab where we only see the Alt press)
Pierre Ossman71f295a2011-05-19 14:55:12 +0000238 for (iter = downKeySym.begin();iter != downKeySym.end();++iter) {
239 vlog.debug("Key released: 0x%04x => 0x%04x", iter->first, iter->second);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000240 cc->writer()->keyEvent(iter->second, false);
Pierre Ossman71f295a2011-05-19 14:55:12 +0000241 }
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000242 downKeySym.clear();
243 return 1;
244
245 case FL_KEYDOWN:
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000246 if (Fl::event_key() == (FL_F + 8)) {
247 popupContextMenu();
248 return 1;
249 }
250
Pierre Ossmanf8c5ef62011-05-13 12:47:54 +0000251 handleKeyEvent(Fl::event_key(), Fl::event_text(), true);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000252 return 1;
253
254 case FL_KEYUP:
Pierre Ossmanf8c5ef62011-05-13 12:47:54 +0000255 handleKeyEvent(Fl::event_key(), Fl::event_text(), false);
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000256 return 1;
257 }
258
259 return Fl_Widget::handle(event);
260}
261
262
263void Viewport::handleUpdateTimeout(void *data)
264{
265 Viewport *self = (Viewport *)data;
266
267 assert(self);
268
269 self->updateWindow();
270}
271
272
273void Viewport::handleColourMap(void *data)
274{
275 Viewport *self = (Viewport *)data;
276
277 assert(self);
278
279 if (self->pixelTrans != NULL)
280 self->pixelTrans->setColourMapEntries(0, 0);
281
282 self->Fl_Widget::damage(FL_DAMAGE_ALL);
283}
284
285
Pierre Ossman4a6be4a2011-05-19 14:49:18 +0000286void Viewport::handleClipboardChange(int source, void *data)
287{
288 Viewport *self = (Viewport *)data;
289
290 assert(self);
291
292 if (!sendPrimary && (source == 0))
293 return;
294
295 Fl::paste(*self, source);
296}
297
298
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000299void Viewport::handlePointerEvent(const rfb::Point& pos, int buttonMask)
300{
301 if (!viewOnly) {
302 if (pointerEventInterval == 0 || buttonMask != lastButtonMask) {
303 cc->writer()->pointerEvent(pos, buttonMask);
304 } else {
305 if (!Fl::has_timeout(handlePointerTimeout, this))
306 Fl::add_timeout((double)pointerEventInterval/1000.0,
307 handlePointerTimeout, this);
308 }
309 lastPointerPos = pos;
310 lastButtonMask = buttonMask;
311 }
312}
313
314
315void Viewport::handlePointerTimeout(void *data)
316{
317 Viewport *self = (Viewport *)data;
318
319 assert(self);
320
321 self->cc->writer()->pointerEvent(self->lastPointerPos, self->lastButtonMask);
322}
323
324
325rdr::U32 Viewport::translateKeyEvent(int keyCode, const char *keyText)
326{
327 unsigned ucs;
328
329 // First check for function keys
330 if ((keyCode > FL_F) && (keyCode <= FL_F_Last))
331 return XK_F1 + (keyCode - FL_F - 1);
332
333 // Numpad numbers
334 if ((keyCode >= (FL_KP + '0')) && (keyCode <= (FL_KP + '9')))
335 return XK_KP_0 + (keyCode - (FL_KP + '0'));
336
337 // Then other special keys
338 switch (keyCode) {
339 case FL_BackSpace:
340 return XK_BackSpace;
341 case FL_Tab:
342 return XK_Tab;
343 case FL_Enter:
344 return XK_Return;
345 case FL_Pause:
346 return XK_Pause;
347 case FL_Scroll_Lock:
348 return XK_Scroll_Lock;
349 case FL_Escape:
350 return XK_Escape;
351 case FL_Home:
352 return XK_Home;
353 case FL_Left:
354 return XK_Left;
355 case FL_Up:
356 return XK_Up;
357 case FL_Right:
358 return XK_Right;
359 case FL_Down:
360 return XK_Down;
361 case FL_Page_Up:
362 return XK_Page_Up;
363 case FL_Page_Down:
364 return XK_Page_Down;
365 case FL_End:
366 return XK_End;
367 case FL_Print:
368 return XK_Print;
369 case FL_Insert:
370 return XK_Insert;
371 case FL_Menu:
372 return XK_Menu;
373 case FL_Help:
374 return XK_Help;
375 case FL_Num_Lock:
376 return XK_Num_Lock;
377 case FL_Shift_L:
378 return XK_Shift_L;
379 case FL_Shift_R:
380 return XK_Shift_R;
381 case FL_Control_L:
382 return XK_Control_L;
383 case FL_Control_R:
384 return XK_Control_R;
385 case FL_Caps_Lock:
386 return XK_Caps_Lock;
387 case FL_Meta_L:
388 return XK_Super_L;
389 case FL_Meta_R:
390 return XK_Super_R;
391 case FL_Alt_L:
392 return XK_Alt_L;
393 case FL_Alt_R:
394 return XK_Alt_R;
395 case FL_Delete:
396 return XK_Delete;
397 case FL_KP_Enter:
398 return XK_KP_Enter;
399 case FL_KP + '=':
400 return XK_KP_Equal;
401 case FL_KP + '*':
402 return XK_KP_Multiply;
403 case FL_KP + '+':
404 return XK_KP_Add;
405 case FL_KP + ',':
406 return XK_KP_Separator;
407 case FL_KP + '-':
408 return XK_KP_Subtract;
409 case FL_KP + '.':
410 return XK_KP_Decimal;
411 case FL_KP + '/':
412 return XK_KP_Divide;
413 case XK_ISO_Level3_Shift:
414 // FLTK tends to let this one leak through on X11...
415 return XK_ISO_Level3_Shift;
Pierre Ossmana75f8f82011-04-29 11:12:02 +0000416 case XK_Multi_key:
417 // Same for this...
418 return XK_Multi_key;
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000419 }
420
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000421 // Unknown special key?
422 if (keyText[0] == '\0') {
423 vlog.error(_("Unknown FLTK key code %d (0x%04x)"), keyCode, keyCode);
424 return XK_VoidSymbol;
425 }
426
427 // Look up the symbol the key produces and translate that from Unicode
428 // to a X11 keysym.
429 if (fl_utf_nb_char((const unsigned char*)keyText, strlen(keyText)) != 1) {
430 vlog.error(_("Multiple characters given for key code %d (0x%04x): '%s'"),
431 keyCode, keyCode, keyText);
432 return XK_VoidSymbol;
433 }
434
435 ucs = fl_utf8decode(keyText, NULL, NULL);
436 return ucs2keysym(ucs);
437}
438
439
440void Viewport::handleKeyEvent(int keyCode, const char *keyText, bool down)
441{
442 rdr::U32 keySym;
443
444 if (viewOnly)
445 return;
446
447 // Because of the way keyboards work, we cannot expect to have the same
448 // symbol on release as when pressed. This breaks the VNC protocol however,
449 // so we need to keep track of what keysym a key _code_ generated on press
450 // and send the same on release.
451 if (!down) {
452 DownMap::iterator iter;
453
454 iter = downKeySym.find(keyCode);
455 if (iter == downKeySym.end()) {
456 vlog.error(_("Unexpected release of FLTK key code %d (0x%04x)"), keyCode, keyCode);
457 return;
458 }
459
Pierre Ossman71f295a2011-05-19 14:55:12 +0000460 vlog.debug("Key released: 0x%04x => 0x%04x", keyCode, iter->second);
461
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000462 cc->writer()->keyEvent(iter->second, false);
463
464 downKeySym.erase(iter);
465
466 return;
467 }
468
469 keySym = translateKeyEvent(keyCode, keyText);
470 if (keySym == XK_VoidSymbol)
471 return;
472
Pierre Ossman71f295a2011-05-19 14:55:12 +0000473 vlog.debug("Key pressed: 0x%04x '%s' => 0x%04x", keyCode, keyText, keySym);
474
Pierre Ossmand50b3d12011-04-15 07:46:56 +0000475 downKeySym[keyCode] = keySym;
476 cc->writer()->keyEvent(keySym, down);
477}
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000478
479
480void Viewport::initContextMenu()
481{
482 contextMenu->add(_("Exit viewer"), 0, NULL, (void*)ID_EXIT, FL_MENU_DIVIDER);
483
484 contextMenu->add(_("Ctrl"), 0, NULL, (void*)ID_CTRL, FL_MENU_TOGGLE);
485 contextMenu->add(_("Alt"), 0, NULL, (void*)ID_ALT, FL_MENU_TOGGLE);
486 CharArray menuKeyStr(menuKey.getData());
487 CharArray sendMenuKey(64);
488 snprintf(sendMenuKey.buf, 64, _("Send %s"), "F8"); // FIXME
489 contextMenu->add(sendMenuKey.buf, 0, NULL, (void*)ID_MENUKEY, 0);
490 contextMenu->add("Secret shortcut menu key", FL_F + 8, NULL, (void*)ID_MENUKEY, FL_MENU_INVISIBLE); // Broken, see STR2613
491 contextMenu->add(_("Send Ctrl-Alt-Del"), 0, NULL, (void*)ID_CTRLALTDEL, FL_MENU_DIVIDER);
492
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000493 contextMenu->add(_("Refresh screen"), 0, NULL, (void*)ID_REFRESH, FL_MENU_DIVIDER);
494
Pierre Ossmand463b572011-05-16 12:04:43 +0000495 contextMenu->add(_("Options..."), 0, NULL, (void*)ID_OPTIONS, 0);
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000496 contextMenu->add(_("Connection info..."), 0, NULL, (void*)ID_INFO, 0);
Pierre Ossmanb8858222011-04-29 11:51:38 +0000497 contextMenu->add(_("About TigerVNC viewer..."), 0, NULL, (void*)ID_ABOUT, FL_MENU_DIVIDER);
498
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000499 contextMenu->add(_("Dismiss menu"), 0, NULL, (void*)ID_DISMISS, 0);
500}
501
502
503void Viewport::popupContextMenu()
504{
505 const Fl_Menu_Item *m;
506
507 contextMenu->position(Fl::event_x(), Fl::event_y());
508
509 m = contextMenu->popup();
510 if (m == NULL)
511 return;
512
513 switch (m->argument()) {
514 case ID_EXIT:
515 exit_vncviewer();
516 break;
517 case ID_CTRL:
518 if (!viewOnly)
519 cc->writer()->keyEvent(XK_Control_L, m->value());
520 break;
521 case ID_ALT:
522 if (!viewOnly)
523 cc->writer()->keyEvent(XK_Alt_L, m->value());
524 break;
525 case ID_MENUKEY:
526 if (!viewOnly) {
527 // FIXME
528 cc->writer()->keyEvent(XK_F8, true);
529 cc->writer()->keyEvent(XK_F8, false);
530 }
531 break;
532 case ID_CTRLALTDEL:
533 if (!viewOnly) {
534 cc->writer()->keyEvent(XK_Control_L, true);
535 cc->writer()->keyEvent(XK_Alt_L, true);
536 cc->writer()->keyEvent(XK_Delete, true);
537 cc->writer()->keyEvent(XK_Delete, false);
538 cc->writer()->keyEvent(XK_Alt_L, false);
539 cc->writer()->keyEvent(XK_Control_L, false);
540 }
541 break;
Pierre Ossmand4c61ce2011-04-29 11:18:12 +0000542 case ID_REFRESH:
543 cc->refreshFramebuffer();
544 break;
Pierre Ossmand463b572011-05-16 12:04:43 +0000545 case ID_OPTIONS:
546 OptionsDialog::showDialog();
547 break;
Pierre Ossman2eb1d112011-05-16 12:18:08 +0000548 case ID_INFO:
549 fl_message_title(_("VNC connection info"));
550 fl_message(cc->connectionInfo());
551 break;
Pierre Ossmanb8858222011-04-29 11:51:38 +0000552 case ID_ABOUT:
553 about_vncviewer();
554 break;
Pierre Ossmanc7bfaac2011-04-29 11:08:11 +0000555 case ID_DISMISS:
556 // Don't need to do anything
557 break;
558 }
559}