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
17 #include "XWorkArea.h"
19 #include "frontends/LyXView.h"
20 #include "lyxrc.h" // lyxrc.show_banner
21 #include "version.h" // lyx_version
23 #if FL_VERSION < 1 && (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 x, int y, int w, int h)
138 : splash_(0), splash_text_(0), workareapixmap(0), painter_(*this)
140 fl_freeze_all_forms();
146 if (lyxerr.debugging(Debug::WORKAREA))
147 lyxerr << "\tbackground box: +"
148 << x << '+' << y << ' '
149 << w - 15 << 'x' << h << endl;
150 backgroundbox = obj = fl_add_box(FL_BORDER_BOX,
154 fl_set_object_resize(obj, FL_RESIZE_ALL);
155 fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
157 // Add a splash screen to the centre of the work area
158 string const splash_file = (lyxrc.show_banner) ?
159 LibFileSearch("images", "banner", "xpm") : string();
161 if (!splash_file.empty()) {
162 int const splash_w = 425;
163 int const splash_h = 290;
164 int const splash_x = x + (w - 15 - splash_w) / 2;
165 int const splash_y = y + (h - splash_h) / 2;
167 fl_add_pixmapbutton(FL_NORMAL_BUTTON,
169 splash_w, splash_h, "");
170 fl_set_pixmapbutton_file(obj, splash_file.c_str());
171 fl_set_pixmapbutton_focus_outline(obj, 3);
172 fl_set_object_boxtype(obj, FL_NO_BOX);
174 int const text_x = splash_x + 260;
175 int const text_y = splash_y + 255;
177 fl_add_text(FL_NORMAL_TEXT, text_x, text_y, 160, 16,
179 fl_set_object_lsize(obj, FL_NORMAL_SIZE);
180 fl_mapcolor(FL_FREE_COL2, 0x2b, 0x47, 0x82);
181 fl_mapcolor(FL_FREE_COL3, 0xe1, 0xd2, 0x9b);
182 fl_set_object_color(obj, FL_FREE_COL2, FL_FREE_COL2);
183 fl_set_object_lcol(obj, FL_FREE_COL3);
184 fl_set_object_lalign(obj, FL_ALIGN_LEFT|FL_ALIGN_INSIDE);
185 fl_set_object_lstyle(obj, FL_BOLD_STYLE);
188 scrollbar = obj = fl_add_scrollbar(FL_VERT_SCROLLBAR,
191 fl_set_object_boxtype(obj, FL_UP_BOX);
192 fl_set_object_resize(obj, FL_RESIZE_ALL);
193 fl_set_object_gravity(obj, NorthEastGravity, SouthEastGravity);
195 fl_set_object_callback(obj, C_WorkArea_scroll_cb, 0);
196 setScrollbarBounds(0.0, 0.0);
201 int const bw = int(abs(fl_get_border_width()));
203 // Create the workarea pixmap
204 createPixmap(w - 15 - 2 * bw, h - 2 * bw);
206 // We add this object as late as possible to avoit problems
208 if (lyxerr.debugging(Debug::WORKAREA))
209 lyxerr << "\tfree object: +"
210 << x + bw << '+' << y + bw << ' '
211 << w - 15 - 2 * bw << 'x'
212 << h - 2 * bw << endl;
214 work_area = obj = fl_add_free(FL_ALL_FREE,
216 w - 15 - 2 * bw, // scrollbarwidth
218 C_WorkArea_work_area_handler);
219 obj->wantkey = FL_KEY_ALL;
220 obj->u_vdata = this; /* This is how we pass the WorkArea
221 to the work_area_handler. */
222 fl_set_object_boxtype(obj,FL_DOWN_BOX);
223 fl_set_object_resize(obj, FL_RESIZE_ALL);
224 fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
226 /// X selection hook - xforms gets it wrong
227 fl_current_form->u_vdata = this;
228 fl_register_raw_callback(fl_current_form, FL_ALL_EVENT, C_WorkAreaEventCB);
230 fl_unfreeze_all_forms();
234 WorkArea::~WorkArea()
237 XFreePixmap(fl_get_display(), workareapixmap);
241 void WorkArea::resize(int xpos, int ypos, int width, int height)
243 fl_freeze_all_forms();
245 int const bw = int(abs(fl_get_border_width()));
248 fl_set_object_geometry(backgroundbox, xpos, ypos, width - 15, height);
253 fl_set_object_geometry(scrollbar, xpos + width - 15,
256 // Create the workarea pixmap
257 createPixmap(width - 15 - 2 * bw, height - 2 * bw);
260 fl_set_object_geometry(work_area, xpos + bw, ypos + bw,
264 fl_unfreeze_all_forms();
269 void destroy_object(FL_OBJECT * obj)
277 fl_delete_object(obj);
283 void WorkArea::createPixmap(int width, int height)
285 // Three calls to createPixmap are needed to draw the initial view
286 // of LyX. Any more and the splash is destroyed.
287 static int counter = 0;
288 if (++counter == 4) {
289 destroy_object(splash_);
291 destroy_object(splash_text_);
295 static int cur_width = -1;
296 static int cur_height = -1;
298 if (cur_width == width && cur_height == height && workareapixmap)
305 XFreePixmap(fl_get_display(), workareapixmap);
307 if (lyxerr.debugging(Debug::WORKAREA))
308 lyxerr << "Creating pixmap ("
309 << width << 'x' << height << ")" << endl;
311 workareapixmap = XCreatePixmap(fl_get_display(),
312 RootWindow(fl_get_display(), 0),
315 fl_get_visual_depth());
316 if (lyxerr.debugging(Debug::WORKAREA))
317 lyxerr << "\tpixmap=" << workareapixmap << endl;
321 void WorkArea::greyOut() const
324 fl_winset(FL_ObjWin(work_area));
325 fl_rectangle(1, work_area->x, work_area->y,
326 work_area->w, work_area->h, FL_GRAY63);
331 void WorkArea::setFocus() const
333 fl_set_focus_object(work_area->form, work_area);
337 void WorkArea::setScrollbar(double pos, double length_fraction) const
339 fl_set_scrollbar_value(scrollbar, pos);
340 fl_set_scrollbar_size(scrollbar, scrollbar->h * length_fraction);
344 void WorkArea::setScrollbarBounds(double l1, double l2) const
346 fl_set_scrollbar_bounds(scrollbar, l1, l2);
350 void WorkArea::setScrollbarIncrements(double inc) const
352 fl_set_scrollbar_increment(scrollbar, work_area->h - inc, inc);
356 // Callback for scrollbar slider
357 void WorkArea::scroll_cb(FL_OBJECT * ob, long)
359 WorkArea * area = static_cast<WorkArea*>(ob->u_vdata);
360 // If we really want the accellerating scroll we can do that
361 // from here. IMHO that is a waste of effort since we already
362 // have other ways to move fast around in the document. (Lgb)
363 area->scrollCB(fl_get_scrollbar_value(ob));
368 int WorkArea::work_area_handler(FL_OBJECT * ob, int event,
372 static int x_old = -1;
373 static int y_old = -1;
374 static long scrollbar_value_old = -1;
376 XEvent * ev = static_cast<XEvent*>(xev);
377 WorkArea * area = static_cast<WorkArea*>(ob->u_vdata);
383 if (!area->work_area ||
384 !area->work_area->form->visible)
386 lyxerr[Debug::WORKAREA] << "Workarea event: DRAW" << endl;
387 area->createPixmap(area->workWidth(), area->workHeight());
388 area->workAreaExpose();
391 if (!ev || ev->xbutton.button == 0) break;
392 // Should really have used xbutton.state
393 lyxerr[Debug::WORKAREA] << "Workarea event: PUSH" << endl;
394 area->workAreaButtonPress(ev->xbutton.x - ob->x,
395 ev->xbutton.y - ob->y,
396 x_button_state(ev->xbutton.button));
399 if (!ev || ev->xbutton.button == 0) break;
400 // Should really have used xbutton.state
401 lyxerr[Debug::WORKAREA] << "Workarea event: RELEASE" << endl;
402 area->workAreaButtonRelease(ev->xbutton.x - ob->x,
403 ev->xbutton.y - ob->y,
404 x_button_state(ev->xbutton.button));
406 #if FL_VERSION < 1 && FL_REVISION < 89
411 if (!ev || ! area->scrollbar) break;
412 if (ev->xmotion.x != x_old ||
413 ev->xmotion.y != y_old ||
414 fl_get_scrollbar_value(area->scrollbar) != scrollbar_value_old
416 lyxerr[Debug::WORKAREA] << "Workarea event: MOUSE" << endl;
417 area->workAreaMotionNotify(ev->xmotion.x - ob->x,
418 ev->xmotion.y - ob->y,
419 x_motion_state(ev->xbutton.state));
422 #if FL_VERSION < 1 && FL_REVISION < 89
428 lyxerr[Debug::WORKAREA] << "Workarea event: KEYBOARD" << endl;
432 XKeyEvent * xke = reinterpret_cast<XKeyEvent *>(ev);
433 #if FL_VERSION < 1 && (FL_REVISION < 89 || (FL_REVISION == 89 && FL_FIXLEVEL < 5))
434 // XForms < 0.89.5 does not have compose support
435 // so we are using our own compose support
436 LyXLookupString(ev, dummy, 1, &keysym);
438 XLookupString(xke, dummy, 1, &keysym, 0);
439 // int num_keys = XLookupString(xke, dummy, 10, &keysym, &xcs);
440 // lyxerr << "We have " << num_keys << " keys in the returned buffer" << endl;
441 // lyxerr << "Our dummy string is " << dummy << endl;
443 if (lyxerr.debugging(Debug::KEY)) {
444 char const * tmp = XKeysymToString(key);
445 char const * tmp2 = XKeysymToString(keysym);
446 string const stm = (tmp ? tmp : "");
447 string const stm2 = (tmp2 ? tmp2 : "");
449 lyxerr[Debug::KEY] << "WorkArea: Key is `" << stm << "' ["
450 << key << "]" << endl;
451 lyxerr[Debug::KEY] << "WorkArea: Keysym is `" << stm2 << "' ["
452 << keysym << "]" << endl;
455 #if FL_VERSION < 1 && (FL_REVISION < 89 || (FL_REVISION == 89 && FL_FIXLEVEL < 5))
456 if (keysym == NoSymbol) {
458 << "Empty kdb action (probably composing)"
462 KeySym ret_key = keysym;
464 // Note that we need this handling because of a bug
465 // in XForms 0.89, if this bug is resolved in the way I hope
466 // we can just use the keysym directly with out looking
467 // at key at all. (Lgb)
470 // We migth have to add more keysyms here also,
471 // we will do that as the issues arise. (Lgb)
472 if (keysym == XK_space) {
474 lyxerr[Debug::KEY] << "Using keysym [A]"
479 // It seems that this was a bit optimistic...
480 // With this hacking things seems to be better (Lgb)
481 //if (!iscntrl(key)) {
483 // lyxerr[Debug::KEY]
484 // << "Using key [B]\n"
486 // << static_cast<unsigned char>(key)
489 ret_key = (keysym ? keysym : key);
490 lyxerr[Debug::KEY] << "Using keysym [B]"
496 unsigned int const ret_state = xke->state;
498 // If you have a better way to handle "wild-output" of
499 // characters after the key has been released than the one
500 // below, please contact me. (Lgb)
501 static Time last_time_pressed;
502 static unsigned int last_key_pressed;
503 static unsigned int last_state_pressed;
504 lyxerr[Debug::KEY] << "Workarea Diff: "
505 << xke->time - last_time_pressed
507 if (xke->time - last_time_pressed < 25 // should perhaps be tunable
508 && ret_state == last_state_pressed
509 && xke->keycode == last_key_pressed) {
511 << "Workarea: Purging X events." << endl;
512 //lyxerr << "Workarea Events: "
513 // << XEventsQueued(fl_get_display(), QueuedAlready)
515 if (XEventsQueued(fl_get_display(), QueuedAlready) > 0)
516 XSync(fl_get_display(), 1);
517 // This purge make f.ex. scrolling stop immidiatly when
518 // releasing the PageDown button. The question is if
519 // this purging of XEvents can cause any harm...
520 // after some testing I can see no problems, but
521 // I'd like other reports too.
524 last_time_pressed = xke->time;
525 last_key_pressed = xke->keycode;
526 last_state_pressed = ret_state;
528 area->workAreaKeyPress(ret_key, x_key_state(ret_state));
532 #if FL_VERSION > 0 || FL_REVISION >= 89
534 lyxerr[Debug::WORKAREA] << "Workarea event: KEYRELEASE" << endl;
539 lyxerr[Debug::WORKAREA] << "Workarea event: FOCUS" << endl;
540 area->workAreaFocus();
543 lyxerr[Debug::WORKAREA] << "Workarea event: UNFOCUS" << endl;
544 area->workAreaUnfocus();
547 lyxerr[Debug::WORKAREA] << "Workarea event: ENTER" << endl;
550 lyxerr[Debug::WORKAREA] << "Workarea event: LEAVE" << endl;
554 lyxerr[Debug::WORKAREA] << "Workarea event: DBLCLICK" << endl;
555 area->workAreaDoubleClick(ev->xbutton.x - ob->x,
556 ev->xbutton.y - ob->y,
557 x_button_state(ev->xbutton.button));
561 lyxerr[Debug::WORKAREA] << "Workarea event: TRPLCLICK" << endl;
562 area->workAreaTripleClick(ev->xbutton.x - ob->x,
563 ev->xbutton.y - ob->y,
564 x_button_state(ev->xbutton.button));
568 lyxerr[Debug::WORKAREA] << "Workarea event: OTHER" << endl;
578 string clipboard_selection;
579 bool clipboard_read = false;
584 int request_clipboard_cb(FL_OBJECT * /*ob*/, long /*type*/,
585 void const * data, long size)
587 clipboard_selection.erase();
590 clipboard_selection.reserve(size);
591 for (int i = 0; i < size; ++i)
592 clipboard_selection +=
593 static_cast<char const *>(data)[i];
594 clipboard_read = true;
603 int WorkArea::event_cb(XEvent * xev)
607 case SelectionRequest:
608 lyxerr[Debug::GUI] << "X requested selection." << endl;
609 selectionRequested();
612 lyxerr[Debug::GUI] << "Lost selection." << endl;
620 void WorkArea::haveSelection(bool yes) const
623 XSetSelectionOwner(fl_get_display(), XA_PRIMARY, None, CurrentTime);
627 XSetSelectionOwner(fl_get_display(), XA_PRIMARY, FL_ObjWin(work_area), CurrentTime);
631 string const WorkArea::getClipboard() const
633 clipboard_read = false;
635 if (fl_request_clipboard(work_area, 0, request_clipboard_cb) == -1)
640 while (!clipboard_read) {
641 if (fl_check_forms() == FL_EVENT) {
643 lyxerr << "Received unhandled X11 event" << endl;
644 lyxerr << "Type: 0x" << hex << ev.xany.type <<
645 " Target: 0x" << hex << ev.xany.window << endl;
648 return clipboard_selection;
652 void WorkArea::putClipboard(string const & s) const
657 fl_stuff_clipboard(work_area, 0, hold.data(), hold.size(), 0);