1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ====================================================== */
14 #pragma implementation
19 #include "frontends/LyXView.h"
20 #include "lyxrc.h" // lyxrc.show_banner
21 #include "version.h" // lyx_version
23 #if FL_REVISION < 89 || (FL_REVISION == 89 && FL_FIXLEVEL < 5)
24 #include "frontends/xforms/lyxlookup.h"
27 #include "support/filetools.h" // LibFileSearch
28 #include "support/lstrings.h"
29 #include "support/LAssert.h"
34 // xforms doesn't define this (but it should be in <forms.h>).
36 FL_APPEVENT_CB fl_set_preemptive_callback(Window, FL_APPEVENT_CB, void *);
47 XSync(fl_get_display(), 0);
51 mouse_button::state x_button_state(unsigned int button)
53 mouse_button::state b = mouse_button::none;
56 b = mouse_button::button1;
59 b = mouse_button::button2;
62 b = mouse_button::button3;
65 b = mouse_button::button4;
68 b = mouse_button::button5;
78 mouse_button::state x_motion_state(unsigned int state)
80 mouse_button::state b = mouse_button::none;
81 if (state & Button1MotionMask)
82 b |= mouse_button::button1;
83 if (state & Button2MotionMask)
84 b |= mouse_button::button2;
85 if (state & Button3MotionMask)
86 b |= mouse_button::button3;
87 if (state & Button4MotionMask)
88 b |= mouse_button::button4;
89 if (state & Button5MotionMask)
90 b |= mouse_button::button5;
95 key_modifier::state x_key_state(unsigned int state)
97 key_modifier::state k = key_modifier::none;
98 if (state & ControlMask)
99 k |= key_modifier::ctrl;
100 if (state & ShiftMask)
101 k |= key_modifier::shift;
102 if (state & Mod1Mask)
103 k |= key_modifier::alt;
112 // Just a bunch of C wrappers around static members of WorkArea
114 void C_WorkArea_scroll_cb(FL_OBJECT * ob, long buf)
116 WorkArea::scroll_cb(ob, buf);
121 int C_WorkArea_work_area_handler(FL_OBJECT * ob, int event,
125 return WorkArea::work_area_handler(ob, event,
130 int C_WorkAreaEventCB(FL_FORM * form, void * xev) {
131 WorkArea * wa = static_cast<WorkArea*>(form->u_vdata);
132 return wa->event_cb(static_cast<XEvent*>(xev));
137 WorkArea::WorkArea(int xpos, int ypos, int width, int height)
138 : splash_(0), splash_text_(0), workareapixmap(0), painter_(*this)
140 fl_freeze_all_forms();
142 if (lyxerr.debugging(Debug::WORKAREA))
143 lyxerr << "Creating work area: +"
144 << xpos << '+' << ypos << ' '
145 << width << 'x' << height << endl;
148 int const bw = int(abs(fl_get_border_width()));
151 if (lyxerr.debugging(Debug::WORKAREA))
152 lyxerr << "\tbackground box: +"
153 << xpos << '+' << ypos << ' '
154 << width - 15 << 'x' << height << endl;
155 backgroundbox = obj = fl_add_box(FL_BORDER_BOX,
159 fl_set_object_resize(obj, FL_RESIZE_ALL);
160 fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
162 // Add a splash screen to the centre of the work area
163 string const splash_file = (lyxrc.show_banner) ?
164 LibFileSearch("images", "banner", "xpm") : string();
166 if (!splash_file.empty()) {
167 int const splash_w = 425;
168 int const splash_h = 290;
169 int const splash_x = xpos + (width - 15 - splash_w) / 2;
170 int const splash_y = ypos + (height - splash_h) / 2;
172 fl_add_pixmapbutton(FL_NORMAL_BUTTON,
174 splash_w, splash_h, "");
175 fl_set_pixmapbutton_file(obj, splash_file.c_str());
176 fl_set_pixmapbutton_focus_outline(obj, 3);
177 fl_set_object_boxtype(obj, FL_NO_BOX);
179 int const text_x = splash_x + 260;
180 int const text_y = splash_y + 255;
182 fl_add_text(FL_NORMAL_TEXT, text_x, text_y, 160, 16,
184 fl_set_object_lsize(obj, FL_NORMAL_SIZE);
185 fl_mapcolor(FL_FREE_COL2, 0x2b, 0x47, 0x82);
186 fl_mapcolor(FL_FREE_COL3, 0xe1, 0xd2, 0x9b);
187 fl_set_object_color(obj, FL_FREE_COL2, FL_FREE_COL2);
188 fl_set_object_lcol(obj, FL_FREE_COL3);
189 fl_set_object_lalign(obj, FL_ALIGN_LEFT|FL_ALIGN_INSIDE);
190 fl_set_object_lstyle(obj, FL_BOLD_STYLE);
197 scrollbar = obj = fl_add_scrollbar(FL_VERT_SCROLLBAR,
199 ypos, 17, height, "");
200 fl_set_object_boxtype(obj, FL_UP_BOX);
201 fl_set_object_resize(obj, FL_RESIZE_ALL);
202 fl_set_object_gravity(obj, NorthEastGravity, SouthEastGravity);
204 fl_set_object_callback(obj, C_WorkArea_scroll_cb, 0);
205 setScrollbarBounds(0.0, 0.0);
210 // Create the workarea pixmap
211 createPixmap(width - 15 - 2 * bw, height - 2 * bw);
213 // We add this object as late as possible to avoit problems
215 if (lyxerr.debugging(Debug::WORKAREA))
216 lyxerr << "\tfree object: +"
217 << xpos + bw << '+' << ypos + bw << ' '
218 << width - 15 - 2 * bw << 'x'
219 << height - 2 * bw << endl;
221 work_area = obj = fl_add_free(FL_ALL_FREE,
222 xpos + bw, ypos + bw,
223 width - 15 - 2 * bw, // scrollbarwidth
225 C_WorkArea_work_area_handler);
226 obj->wantkey = FL_KEY_ALL;
227 obj->u_vdata = this; /* This is how we pass the WorkArea
228 to the work_area_handler. */
229 fl_set_object_boxtype(obj,FL_DOWN_BOX);
230 fl_set_object_resize(obj, FL_RESIZE_ALL);
231 fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
233 /// X selection hook - xforms gets it wrong
234 fl_current_form->u_vdata = this;
235 fl_register_raw_callback(fl_current_form, FL_ALL_EVENT, C_WorkAreaEventCB);
237 fl_unfreeze_all_forms();
241 WorkArea::~WorkArea()
244 XFreePixmap(fl_get_display(), workareapixmap);
248 bool WorkArea::belowMouse() const
252 fl_get_mouse(&x, &y, &button);
253 FL_Coord ulx = work_area->form->x + work_area->x;
254 FL_Coord uly = work_area->form->y + work_area->y;
255 FL_Coord w = work_area->w;
256 FL_Coord h = work_area->h;
257 if (x > ulx && y > uly && x < ulx + h && y < uly + w)
263 void WorkArea::resize(int xpos, int ypos, int width, int height)
265 fl_freeze_all_forms();
267 int const bw = int(abs(fl_get_border_width()));
270 fl_set_object_geometry(backgroundbox, xpos, ypos, width - 15, height);
275 fl_set_object_geometry(scrollbar, xpos + width - 15,
278 // Create the workarea pixmap
279 createPixmap(width - 15 - 2 * bw, height - 2 * bw);
282 fl_set_object_geometry(work_area, xpos + bw, ypos + bw,
286 fl_unfreeze_all_forms();
291 void destroy_object(FL_OBJECT * obj)
299 fl_delete_object(obj);
305 void WorkArea::createPixmap(int width, int height)
307 // Three calls to createPixmap are needed to draw the initial view
308 // of LyX. Any more and the splash is destroyed.
309 static int counter = 0;
310 if (++counter == 4) {
311 destroy_object(splash_);
313 destroy_object(splash_text_);
317 static int cur_width = -1;
318 static int cur_height = -1;
320 if (cur_width == width && cur_height == height && workareapixmap)
327 XFreePixmap(fl_get_display(), workareapixmap);
329 if (lyxerr.debugging(Debug::WORKAREA))
330 lyxerr << "Creating pixmap ("
331 << width << 'x' << height << ")" << endl;
333 workareapixmap = XCreatePixmap(fl_get_display(),
334 RootWindow(fl_get_display(), 0),
337 fl_get_visual_depth());
338 if (lyxerr.debugging(Debug::WORKAREA))
339 lyxerr << "\tpixmap=" << workareapixmap << endl;
343 void WorkArea::greyOut() const
346 fl_winset(FL_ObjWin(work_area));
347 fl_rectangle(1, work_area->x, work_area->y,
348 work_area->w, work_area->h, FL_GRAY63);
353 void WorkArea::setFocus() const
355 fl_set_focus_object(work_area->form, work_area);
359 void WorkArea::setScrollbar(double pos, double length_fraction) const
361 fl_set_scrollbar_value(scrollbar, pos);
362 fl_set_scrollbar_size(scrollbar, scrollbar->h * length_fraction);
366 void WorkArea::setScrollbarBounds(double l1, double l2) const
368 fl_set_scrollbar_bounds(scrollbar, l1, l2);
372 void WorkArea::setScrollbarIncrements(double inc) const
374 fl_set_scrollbar_increment(scrollbar, work_area->h - inc, inc);
378 // Callback for scrollbar slider
379 void WorkArea::scroll_cb(FL_OBJECT * ob, long)
381 WorkArea * area = static_cast<WorkArea*>(ob->u_vdata);
382 // If we really want the accellerating scroll we can do that
383 // from here. IMHO that is a waste of effort since we already
384 // have other ways to move fast around in the document. (Lgb)
385 area->scrollCB(fl_get_scrollbar_value(ob));
390 int WorkArea::work_area_handler(FL_OBJECT * ob, int event,
394 static int x_old = -1;
395 static int y_old = -1;
396 static long scrollbar_value_old = -1;
398 XEvent * ev = static_cast<XEvent*>(xev);
399 WorkArea * area = static_cast<WorkArea*>(ob->u_vdata);
405 if (!area->work_area ||
406 !area->work_area->form->visible)
408 lyxerr[Debug::WORKAREA] << "Workarea event: DRAW" << endl;
409 area->createPixmap(area->workWidth(), area->height());
410 area->workAreaExpose();
413 if (!ev || ev->xbutton.button == 0) break;
414 // Should really have used xbutton.state
415 lyxerr[Debug::WORKAREA] << "Workarea event: PUSH" << endl;
416 area->workAreaButtonPress(ev->xbutton.x - ob->x,
417 ev->xbutton.y - ob->y,
418 x_button_state(ev->xbutton.button));
421 if (!ev || ev->xbutton.button == 0) break;
422 // Should really have used xbutton.state
423 lyxerr[Debug::WORKAREA] << "Workarea event: RELEASE" << endl;
424 area->workAreaButtonRelease(ev->xbutton.x - ob->x,
425 ev->xbutton.y - ob->y,
426 x_button_state(ev->xbutton.button));
433 if (!ev || ! area->scrollbar) break;
434 if (ev->xmotion.x != x_old ||
435 ev->xmotion.y != y_old ||
436 fl_get_scrollbar_value(area->scrollbar) != scrollbar_value_old
438 lyxerr[Debug::WORKAREA] << "Workarea event: MOUSE" << endl;
439 area->workAreaMotionNotify(ev->xmotion.x - ob->x,
440 ev->xmotion.y - ob->y,
441 x_motion_state(ev->xbutton.state));
450 lyxerr[Debug::WORKAREA] << "Workarea event: KEYBOARD" << endl;
454 XKeyEvent * xke = reinterpret_cast<XKeyEvent *>(ev);
455 #if FL_REVISION < 89 || (FL_REVISION == 89 && FL_FIXLEVEL < 5)
456 // XForms < 0.89.5 does not have compose support
457 // so we are using our own compose support
458 LyXLookupString(ev, dummy, 1, &keysym);
460 XLookupString(xke, dummy, 1, &keysym, 0);
461 // int num_keys = XLookupString(xke, dummy, 10, &keysym, &xcs);
462 // lyxerr << "We have " << num_keys << " keys in the returned buffer" << endl;
463 // lyxerr << "Our dummy string is " << dummy << endl;
465 if (lyxerr.debugging(Debug::KEY)) {
466 char const * tmp = XKeysymToString(key);
467 char const * tmp2 = XKeysymToString(keysym);
468 string const stm = (tmp ? tmp : "");
469 string const stm2 = (tmp2 ? tmp2 : "");
471 lyxerr[Debug::KEY] << "WorkArea: Key is `" << stm << "' ["
472 << key << "]" << endl;
473 lyxerr[Debug::KEY] << "WorkArea: Keysym is `" << stm2 << "' ["
474 << keysym << "]" << endl;
477 #if FL_REVISION < 89 || (FL_REVISION == 89 && FL_FIXLEVEL < 5)
478 if (keysym == NoSymbol) {
480 << "Empty kdb action (probably composing)"
484 KeySym ret_key = keysym;
486 // Note that we need this handling because of a bug
487 // in XForms 0.89, if this bug is resolved in the way I hope
488 // we can just use the keysym directly with out looking
489 // at key at all. (Lgb)
492 // We migth have to add more keysyms here also,
493 // we will do that as the issues arise. (Lgb)
494 if (keysym == XK_space) {
496 lyxerr[Debug::KEY] << "Using keysym [A]"
501 // It seems that this was a bit optimistic...
502 // With this hacking things seems to be better (Lgb)
503 //if (!iscntrl(key)) {
505 // lyxerr[Debug::KEY]
506 // << "Using key [B]\n"
508 // << static_cast<unsigned char>(key)
511 ret_key = (keysym ? keysym : key);
512 lyxerr[Debug::KEY] << "Using keysym [B]"
518 unsigned int const ret_state = xke->state;
520 // If you have a better way to handle "wild-output" of
521 // characters after the key has been released than the one
522 // below, please contact me. (Lgb)
523 static Time last_time_pressed;
524 static unsigned int last_key_pressed;
525 static unsigned int last_state_pressed;
526 lyxerr[Debug::KEY] << "Workarea Diff: "
527 << xke->time - last_time_pressed
529 if (xke->time - last_time_pressed < 25 // should perhaps be tunable
530 && ret_state == last_state_pressed
531 && xke->keycode == last_key_pressed) {
533 << "Workarea: Purging X events." << endl;
534 //lyxerr << "Workarea Events: "
535 // << XEventsQueued(fl_get_display(), QueuedAlready)
537 if (XEventsQueued(fl_get_display(), QueuedAlready) > 0)
538 XSync(fl_get_display(), 1);
539 // This purge make f.ex. scrolling stop immidiatly when
540 // releasing the PageDown button. The question is if
541 // this purging of XEvents can cause any harm...
542 // after some testing I can see no problems, but
543 // I'd like other reports too.
546 last_time_pressed = xke->time;
547 last_key_pressed = xke->keycode;
548 last_state_pressed = ret_state;
550 area->workAreaKeyPress(ret_key, x_key_state(ret_state));
554 #if FL_REVISION >= 89
556 lyxerr[Debug::WORKAREA] << "Workarea event: KEYRELEASE" << endl;
561 lyxerr[Debug::WORKAREA] << "Workarea event: FOCUS" << endl;
562 area->workAreaFocus();
565 lyxerr[Debug::WORKAREA] << "Workarea event: UNFOCUS" << endl;
566 area->workAreaUnfocus();
569 lyxerr[Debug::WORKAREA] << "Workarea event: ENTER" << endl;
570 area->workAreaEnter();
573 lyxerr[Debug::WORKAREA] << "Workarea event: LEAVE" << endl;
574 area->workAreaLeave();
578 lyxerr[Debug::WORKAREA] << "Workarea event: DBLCLICK" << endl;
579 area->workAreaDoubleClick(ev->xbutton.x - ob->x,
580 ev->xbutton.y - ob->y,
581 x_button_state(ev->xbutton.button));
585 lyxerr[Debug::WORKAREA] << "Workarea event: TRPLCLICK" << endl;
586 area->workAreaTripleClick(ev->xbutton.x - ob->x,
587 ev->xbutton.y - ob->y,
588 x_button_state(ev->xbutton.button));
592 lyxerr[Debug::WORKAREA] << "Workarea event: OTHER" << endl;
602 string clipboard_selection;
603 bool clipboard_read = false;
608 int request_clipboard_cb(FL_OBJECT * /*ob*/, long /*type*/,
609 void const * data, long size)
611 clipboard_selection.erase();
614 clipboard_selection.reserve(size);
615 for (int i = 0; i < size; ++i)
616 clipboard_selection +=
617 static_cast<char const *>(data)[i];
618 clipboard_read = true;
627 int WorkArea::event_cb(XEvent * xev)
631 case SelectionRequest:
632 lyxerr[Debug::GUI] << "X requested selection." << endl;
633 selectionRequested.emit();
636 lyxerr[Debug::GUI] << "Lost selection." << endl;
637 selectionLost.emit();
644 void WorkArea::haveSelection(bool yes) const
647 XSetSelectionOwner(fl_get_display(), XA_PRIMARY, None, CurrentTime);
651 XSetSelectionOwner(fl_get_display(), XA_PRIMARY, FL_ObjWin(work_area), CurrentTime);
655 string const WorkArea::getClipboard() const
657 clipboard_read = false;
659 if (fl_request_clipboard(work_area, 0, request_clipboard_cb) == -1)
664 while (!clipboard_read) {
665 if (fl_check_forms() == FL_EVENT) {
667 lyxerr << "Received unhandled X11 event" << endl;
668 lyxerr << "Type: 0x" << hex << ev.xany.type <<
669 " Target: 0x" << hex << ev.xany.window << endl;
672 return clipboard_selection;
676 void WorkArea::putClipboard(string const & s) const
681 fl_stuff_clipboard(work_area, 0, hold.data(), hold.size(), 0);