3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
14 #include "XWorkArea.h"
17 #include "XFormsView.h"
18 #include "XLyXKeySym.h"
21 #include "funcrequest.h"
25 #include <boost/bind.hpp>
27 using boost::shared_ptr;
40 inline void waitForX(bool discard)
42 XSync(fl_get_display(), discard);
46 mouse_button::state x_button_state(unsigned int button)
48 mouse_button::state b = mouse_button::none;
51 b = mouse_button::button1;
54 b = mouse_button::button2;
57 b = mouse_button::button3;
60 b = mouse_button::button4;
63 b = mouse_button::button5;
70 key_modifier::state x_key_state(unsigned int state)
72 key_modifier::state k = key_modifier::none;
73 if (state & ControlMask)
74 k |= key_modifier::ctrl;
75 if (state & ShiftMask)
76 k |= key_modifier::shift;
78 k |= key_modifier::alt;
85 void C_scroll_cb(FL_OBJECT * ob, long)
87 XWorkArea * area = static_cast<XWorkArea *>(ob->u_vdata);
92 int C_work_area_handler(FL_OBJECT * ob, int event, FL_Coord, FL_Coord,
95 return XWorkArea::work_area_handler(ob, event, 0, 0, key, xev);
99 int C_event_cb(FL_FORM * form, void * xev)
101 XWorkArea * area = static_cast<XWorkArea *>(form->u_vdata);
102 return area->event_cb(static_cast<XEvent *>(xev));
109 XWorkArea::XWorkArea(LyXView & owner, int w, int h)
110 : workareapixmap(0), painter_(*this)
112 fl_freeze_all_forms();
117 // A frame around the work area.
118 frame = obj = fl_add_box(FL_BORDER_BOX, 0, 0, w, h, "");
119 fl_set_object_resize(obj, FL_RESIZE_ALL);
120 fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
122 unsigned int r, g, b;
123 if (getRGBColor(LColor::background, r, g, b)) {
124 fl_mapcolor(FL_FREE_COL12, r, g, b);
125 fl_set_object_color(obj, FL_FREE_COL12, FL_MCOL);
129 scrollbar = obj = fl_add_scrollbar(FL_VERT_SCROLLBAR, 0, 0, w, h, "");
130 fl_set_object_boxtype(obj, FL_UP_BOX);
131 fl_set_object_resize(obj, FL_RESIZE_ALL);
132 fl_set_object_gravity(obj, NorthEastGravity, SouthEastGravity);
134 fl_set_object_callback(obj, C_scroll_cb, 0);
135 fl_set_scrollbar_bounds(scrollbar, 0.0, 0.0);
136 fl_set_scrollbar_value(scrollbar, 0.0);
137 fl_set_scrollbar_size(scrollbar, scrollbar->h);
139 // The work area itself
140 work_area = obj = fl_add_free(FL_ALL_FREE, 0, 0, w, h, "",
141 C_work_area_handler);
142 obj->wantkey = FL_KEY_ALL;
145 fl_set_object_boxtype(obj,FL_DOWN_BOX);
146 fl_set_object_resize(obj, FL_RESIZE_ALL);
147 fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
149 // Hand control of the layout of these widgets to the
151 XFormsView & xview = dynamic_cast<XFormsView &>(owner);
152 BoxList & boxlist = xview.getBox(XFormsView::Center)->children();
154 wa_box_ = boxlist.push_back(Box(0,0));
155 wa_box_->set(Box::Horizontal);
157 shared_ptr<Box> frame_box = widgets_.add(frame, wa_box_->children(), 0, 0);
158 frame_box->set(Box::Expand);
160 int const bw = int(abs(fl_get_border_width()));
161 shared_ptr<Box> wa_box = embed(work_area, frame_box->children(), widgets_, bw);
162 wa_box->set(Box::Expand);
164 widgets_.add(scrollbar, wa_box_->children(), 17, 0);
166 xview.metricsUpdated.connect(boost::bind(&WidgetMap::updateMetrics,
169 /// X selection hook - xforms gets it wrong
170 fl_current_form->u_vdata = this;
171 fl_register_raw_callback(fl_current_form, FL_ALL_EVENT, C_event_cb);
173 fl_unfreeze_all_forms();
177 val.function = GXcopy;
178 copy_gc = XCreateGC(fl_get_display(), RootWindow(fl_get_display(), 0),
183 XWorkArea::~XWorkArea()
185 XFreeGC(fl_get_display(), copy_gc);
187 XFreePixmap(fl_get_display(), workareapixmap);
191 void XWorkArea::redraw(int width, int height)
193 static int cur_width = -1;
194 static int cur_height = -1;
196 if (cur_width == width && cur_height == height && workareapixmap) {
197 XCopyArea(fl_get_display(),
198 getPixmap(), getWin(), copy_gc,
199 0, 0, width, height, xpos(), ypos());
206 if (lyxerr.debugging(Debug::WORKAREA)) {
207 lyxerr << "(Re)creating pixmap ("
208 << width << 'x' << height << ')' << endl;
211 if (workareapixmap) {
212 XFreePixmap(fl_get_display(), workareapixmap);
215 workareapixmap = XCreatePixmap(fl_get_display(),
216 RootWindow(fl_get_display(), 0),
219 fl_get_visual_depth());
225 void XWorkArea::setScrollbarParams(int height, int pos, int line_height)
227 // we need to cache this for scroll_cb
228 doc_height_ = height;
231 fl_set_scrollbar_value(scrollbar, 0.0);
232 fl_set_scrollbar_size(scrollbar, scrollbar->h);
236 long const work_height = workHeight();
238 if (lyxerr.debugging(Debug::GUI)) {
239 lyxerr << "scroll: height now " << height << '\n'
240 << "scroll: work_height " << work_height << endl;
243 /* If the text is smaller than the working area, the scrollbar
244 * maximum must be the working area height. No scrolling will
246 if (height <= work_height) {
247 lyxerr[Debug::GUI] << "scroll: doc smaller than workarea !"
249 fl_set_scrollbar_bounds(scrollbar, 0.0, 0.0);
250 fl_set_scrollbar_value(scrollbar, pos);
251 fl_set_scrollbar_size(scrollbar, scrollbar->h);
255 fl_set_scrollbar_bounds(scrollbar, 0.0, height - work_height);
256 fl_set_scrollbar_increment(scrollbar, work_area->h - line_height, line_height);
258 fl_set_scrollbar_value(scrollbar, pos);
260 double const slider_size =
261 (height == 0) ? 1.0 : 1.0 / double(height);
263 fl_set_scrollbar_size(scrollbar, scrollbar->h * slider_size);
267 // callback for scrollbar slider
268 void XWorkArea::scroll_cb()
270 double const val = fl_get_scrollbar_value(scrollbar);
272 if (lyxerr.debugging(Debug::GUI)) {
273 lyxerr << "scroll: val: " << val << '\n'
274 << "scroll: height: " << scrollbar->h << '\n'
275 << "scroll: docheight: " << doc_height_ << endl;
278 scrollDocView(int(val));
283 int XWorkArea::work_area_handler(FL_OBJECT * ob, int event,
287 if (event != 10 && event != 11)
288 lyxerr[Debug::WORKAREA] << "Workarea event: EVENT: " << event << endl;
290 XEvent * ev = static_cast<XEvent*>(xev);
291 XWorkArea * area = static_cast<XWorkArea*>(ob->u_vdata);
299 if (!area->work_area || !area->work_area->form->visible)
301 lyxerr[Debug::WORKAREA] << "Workarea event: DRAW" << endl;
302 area->redraw(area->workWidth(), area->workHeight());
306 if (!ev || ev->xbutton.button == 0) break;
308 if (ev->xbutton.button == 4 || ev->xbutton.button == 5) {
309 static long last_wheel;
311 long cur_wheel = ev->xbutton.time;
312 if (last_wheel == cur_wheel)
315 last_wheel = cur_wheel;
318 fl_get_scrollbar_increment(area->scrollbar, &l, &r);
320 if (ev->xbutton.button == 4)
323 fl_set_scrollbar_value(
325 fl_get_scrollbar_value(area->scrollbar) + l);
331 // Should really have used xbutton.state
332 lyxerr[Debug::WORKAREA] << "Workarea event: PUSH" << endl;
334 FuncRequest(LFUN_MOUSE_PRESS,
335 ev->xbutton.x - ob->x,
336 ev->xbutton.y - ob->y,
337 x_button_state(key)));
341 if (!ev || ev->xbutton.button == 0) break;
342 // Should really have used xbutton.state
344 if (ev->xbutton.button == 4 || ev->xbutton.button == 5) {
345 // We ingnore wheel event here
349 lyxerr[Debug::WORKAREA] << "Workarea event: RELEASE" << endl;
352 FuncRequest(LFUN_MOUSE_RELEASE,
353 ev->xbutton.x - ob->x,
354 ev->xbutton.y - ob->y,
355 x_button_state(key)));
359 lyxerr[Debug::WORKAREA] << "Workarea event: DRAG 0" << endl;
361 if (!ev || !area->scrollbar)
364 int const drag_x = ev->xmotion.x;
365 int const drag_y = ev->xmotion.y;
366 int const area_y = ob->y;
367 int const area_h = ob->h;
369 // Check if the mouse is above or below the workarea
370 if (drag_y <= area_y || drag_y >= area_y + area_h) {
371 // The mouse button is depressed and we are outside the
372 // workarea. That means we are simultaneously selecting
373 // text and scrolling the view.
374 // Use a Timeout to react to a drag events only every
375 // 200ms. All intervening events are discarded,
376 // allowing the user to control position easily.
377 static int const discard_interval = 200;
378 static Timeout timeout(discard_interval);
380 if (timeout.running())
382 // The timeout is not running, so process the
383 // event, first starting the timeout to discard future
388 static int x_old = -1;
389 static int y_old = -1;
390 static double scrollbar_value_old = -1.0;
392 double const scrollbar_value =
393 fl_get_scrollbar_value(area->scrollbar);
395 if (drag_x != x_old || drag_y != y_old ||
396 scrollbar_value != scrollbar_value_old) {
399 scrollbar_value_old = scrollbar_value;
401 lyxerr[Debug::WORKAREA] << "Workarea event: DRAG"
404 // It transpires that ev->xbutton.button == 0 when
405 // the mouse is dragged, so it cannot be used to
406 // initialise x_button_state and hence FuncRequest.
408 // The 'key' that is passed into the function does
409 // contain the necessary info, however.
411 // It is for this reason that x_button_state has
412 // been modified to work with key
413 // rather than ev->xbutton.button.
415 // Angus 15 Oct 2002.
416 FuncRequest cmd(LFUN_MOUSE_MOTION,
417 ev->xbutton.x - ob->x,
418 ev->xbutton.y - ob->y,
419 x_button_state(key));
426 lyxerr[Debug::WORKAREA] << "Workarea event: KEYPRESS" << endl;
430 XKeyEvent * xke = reinterpret_cast<XKeyEvent *>(ev);
431 XLookupString(xke, dummy, 1, &keysym, 0);
433 if (lyxerr.debugging(Debug::KEY)) {
434 char const * const tmp = XKeysymToString(key);
435 char const * const tmp2 = XKeysymToString(keysym);
436 string const stm = (tmp ? tmp : string());
437 string const stm2 = (tmp2 ? tmp2 : string());
439 lyxerr << "XWorkArea: Key is `" << stm
440 << "' [" << key << "]\n"
441 << "XWorkArea: Keysym is `" << stm2
442 << "' [" << keysym << ']' << endl;
445 // Note that we need this handling because of a bug
446 // in XForms 0.89, if this bug is resolved in the way I hope
447 // we can just use the keysym directly without looking
448 // at key at all. (Lgb)
451 // We might have to add more keysyms here also,
452 // we will do that as the issues arise. (Lgb)
453 if (keysym == XK_space) {
455 lyxerr[Debug::KEY] << "Using keysym [A]"
460 // It seems that this was a bit optimistic...
461 // With this hacking things seems to be better (Lgb)
462 //if (!iscntrl(key)) {
464 // lyxerr[Debug::KEY]
465 // << "Using key [B]\n"
467 // << static_cast<unsigned char>(key)
470 ret_key = (keysym ? keysym : key);
471 lyxerr[Debug::KEY] << "Using keysym [B]"
476 unsigned int const ret_state = xke->state;
478 // If you have a better way to handle "wild-output" of
479 // characters after the key has been released than the one
480 // below, please contact me. (Lgb)
481 static Time last_time_pressed;
482 static unsigned int last_key_pressed;
483 static unsigned int last_state_pressed;
484 lyxerr[Debug::KEY] << "Workarea Diff: "
485 << xke->time - last_time_pressed
487 if (xke->time - last_time_pressed < 25 // should perhaps be tunable
488 && ret_state == last_state_pressed
489 && xke->keycode == last_key_pressed) {
491 << "Workarea: Purging X events." << endl;
492 //lyxerr << "Workarea Events: "
493 // << XEventsQueued(fl_get_display(), QueuedAlready)
495 if (XEventsQueued(fl_get_display(), QueuedAlready) > 0)
497 // This purge make f.ex. scrolling stop immediately when
498 // releasing the PageDown button. The question is if
499 // this purging of XEvents can cause any harm...
500 // after some testing I can see no problems, but
501 // I'd like other reports too.
504 last_time_pressed = xke->time;
505 last_key_pressed = xke->keycode;
506 last_state_pressed = ret_state;
508 XLyXKeySym * xlk = new XLyXKeySym;
509 xlk->initFromKeySym(ret_key);
511 area->workAreaKeyPress(LyXKeySymPtr(xlk),
512 x_key_state(ret_state));
517 lyxerr[Debug::WORKAREA] << "Workarea event: KEYRELEASE" << endl;
521 lyxerr[Debug::WORKAREA] << "Workarea event: ENTER" << endl;
522 fl_set_cursor(FL_ObjWin(area->work_area), XC_xterm);
526 lyxerr[Debug::WORKAREA] << "Workarea event: LEAVE" << endl;
527 // There should be no need for this. But there is.
528 fl_set_cursor(FL_ObjWin(area->work_area), FL_DEFAULT_CURSOR);
533 if (ev->xbutton.button == 4 || ev->xbutton.button == 5) {
534 // Ignore wheel events
539 lyxerr[Debug::WORKAREA] << "Workarea event: DBLCLICK" << endl;
540 FuncRequest cmd(LFUN_MOUSE_DOUBLE,
541 ev->xbutton.x - ob->x,
542 ev->xbutton.y - ob->y,
543 x_button_state(key));
550 if (ev->xbutton.button == 4 || ev->xbutton.button == 5) {
551 // Ignore wheel events
555 lyxerr[Debug::WORKAREA] << "Workarea event: TRPLCLICK" << endl;
556 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
557 ev->xbutton.x - ob->x,
558 ev->xbutton.y - ob->y,
559 x_button_state(key));
566 lyxerr[Debug::WORKAREA] << "Workarea event: OTHER" << endl;
576 string clipboard_selection;
577 bool clipboard_read = false;
581 int request_clipboard_cb(FL_OBJECT * /*ob*/, long /*type*/,
582 void const * data, long size)
584 clipboard_selection.erase();
587 clipboard_selection.reserve(size);
588 for (int i = 0; i < size; ++i)
589 clipboard_selection += static_cast<char const *>(data)[i];
590 clipboard_read = true;
598 int XWorkArea::event_cb(XEvent * xev)
601 case SelectionRequest:
602 lyxerr[Debug::GUI] << "X requested selection." << endl;
603 selectionRequested();
606 lyxerr[Debug::GUI] << "Lost selection." << endl;
614 void XWorkArea::haveSelection(bool yes) const
616 Window const owner = yes ? FL_ObjWin(work_area) : None;
617 XSetSelectionOwner(fl_get_display(), XA_PRIMARY, owner, CurrentTime);
621 string const XWorkArea::getClipboard() const
623 clipboard_read = false;
625 if (fl_request_clipboard(work_area, 0, request_clipboard_cb) == -1)
630 while (!clipboard_read) {
631 if (fl_check_forms() == FL_EVENT) {
633 lyxerr << "Received unhandled X11 event\n"
634 << "Type: 0x" << hex << ev.xany.type
635 << " Target: 0x" << hex << ev.xany.window
639 return clipboard_selection;
643 void XWorkArea::putClipboard(string const & s) const
648 fl_stuff_clipboard(work_area, 0, hold.data(), hold.size(), 0);
651 } // namespace frontend