src/frontends/xforms/XWorkArea.C

   1 /**
   2  * \file XWorkArea.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author unknown
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "XWorkArea.h"
  15
  16 #include "Color.h"
  17 #include "XFormsView.h"
  18 #include "XLyXKeySym.h"
  19
  20 #include "debug.h"
  21 #include "funcrequest.h"
  22 #include "LColor.h"
  23 #include "Timeout.h"
  24
  25 #include <boost/bind.hpp>
  26
  27 using std::abs;
  28 using std::dec;
  29 using std::endl;
  30 using std::hex;
  31 using std::string;
  32
  33 namespace lyx {
  34 namespace frontend {
  35
  36 namespace {
  37
  38 inline void waitForX(bool discard)
  39 {
  40         XSync(fl_get_display(), discard);
  41 }
  42
  43
  44 mouse_button::state x_button_state(unsigned int button)
  45 {
  46         mouse_button::state b = mouse_button::none;
  47         switch (button) {
  48         case FL_MBUTTON1:
  49                 b = mouse_button::button1;
  50                 break;
  51         case FL_MBUTTON2:
  52                 b = mouse_button::button2;
  53                 break;
  54         case FL_MBUTTON3:
  55                 b = mouse_button::button3;
  56                 break;
  57         case FL_MBUTTON4:
  58                 b = mouse_button::button4;
  59                 break;
  60         case FL_MBUTTON5:
  61                 b = mouse_button::button5;
  62                 break;
  63         }
  64         return b;
  65 }
  66
  67
  68 key_modifier::state x_key_state(unsigned int state)
  69 {
  70         key_modifier::state k = key_modifier::none;
  71         if (state & ControlMask)
  72                 k |= key_modifier::ctrl;
  73         if (state & ShiftMask)
  74                 k |= key_modifier::shift;
  75         if (state & Mod1Mask)
  76                 k |= key_modifier::alt;
  77         return k;
  78 }
  79
  80
  81 extern "C" {
  82
  83 void C_scroll_cb(FL_OBJECT * ob, long)
  84 {
  85         XWorkArea * area = static_cast<XWorkArea *>(ob->u_vdata);
  86         area->scroll_cb();
  87 }
  88
  89
  90 int C_work_area_handler(FL_OBJECT * ob, int event, FL_Coord, FL_Coord,
  91                         int key, void * xev)
  92 {
  93         return XWorkArea::work_area_handler(ob, event, 0, 0, key, xev);
  94 }
  95
  96
  97 int C_event_cb(FL_FORM * form, void * xev)
  98 {
  99         XWorkArea * area = static_cast<XWorkArea *>(form->u_vdata);
 100         return area->event_cb(static_cast<XEvent *>(xev));
 101 }
 102
 103 } // extern "C"
 104 } // namespace anon
 105
 106
 107 XWorkArea::XWorkArea(LyXView & owner, int w, int h)
 108         : workareapixmap(0), painter_(*this)
 109 {
 110         fl_freeze_all_forms();
 111
 112         FL_OBJECT * obj;
 113         FL_OBJECT * frame;
 114
 115         // A frame around the work area.
 116         frame = obj = fl_add_box(FL_BORDER_BOX, 0, 0, w, h, "");
 117         fl_set_object_resize(obj, FL_RESIZE_ALL);
 118         fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
 119
 120         unsigned int r, g, b;
 121         if (getRGBColor(LColor::background, r, g, b)) {
 122                 fl_mapcolor(FL_FREE_COL12, r, g, b);
 123                 fl_set_object_color(obj, FL_FREE_COL12, FL_MCOL);
 124         }
 125
 126         // The scrollbar.
 127         scrollbar = obj = fl_add_scrollbar(FL_VERT_SCROLLBAR, 0, 0, w, h, "");
 128         fl_set_object_boxtype(obj, FL_UP_BOX);
 129         fl_set_object_resize(obj, FL_RESIZE_ALL);
 130         fl_set_object_gravity(obj, NorthEastGravity, SouthEastGravity);
 131         obj->u_vdata = this;
 132         fl_set_object_callback(obj, C_scroll_cb, 0);
 133         fl_set_scrollbar_bounds(scrollbar, 0.0, 0.0);
 134         fl_set_scrollbar_value(scrollbar, 0.0);
 135         fl_set_scrollbar_size(scrollbar, scrollbar->h);
 136
 137         // The work area itself
 138         work_area = obj = fl_add_free(FL_ALL_FREE, 0, 0, w, h, "",
 139                                       C_work_area_handler);
 140         obj->wantkey = FL_KEY_ALL;
 141         obj->u_vdata = this;
 142
 143         fl_set_object_boxtype(obj,FL_DOWN_BOX);
 144         fl_set_object_resize(obj, FL_RESIZE_ALL);
 145         fl_set_object_gravity(obj, NorthWestGravity, SouthEastGravity);
 146
 147         // Hand control of the layout of these widgets to the
 148         // Layout Engine.
 149         XFormsView & xview = dynamic_cast<XFormsView &>(owner);
 150         BoxList & boxlist = xview.getBox(XFormsView::Center).children();
 151
 152         wa_box_ = &boxlist.push_back(Box(0,0));
 153         wa_box_->set(Box::Horizontal);
 154
 155         Box & frame_box = widgets_.add(frame, wa_box_->children(), 0, 0);
 156         frame_box.set(Box::Expand);
 157
 158         int const bw = int(abs(fl_get_border_width()));
 159         Box & wa_box = embed(work_area, frame_box.children(), widgets_, bw);
 160         wa_box.set(Box::Expand);
 161
 162         widgets_.add(scrollbar, wa_box_->children(), 17, 0);
 163
 164         xview.metricsUpdated.connect(boost::bind(&WidgetMap::updateMetrics,
 165                                                  &widgets_));
 166
 167         /// X selection hook - xforms gets it wrong
 168         fl_current_form->u_vdata = this;
 169         fl_register_raw_callback(fl_current_form, FL_ALL_EVENT, C_event_cb);
 170
 171         fl_unfreeze_all_forms();
 172
 173         XGCValues val;
 174
 175         val.function = GXcopy;
 176         val.graphics_exposures = false;
 177         copy_gc = XCreateGC(fl_get_display(), RootWindow(fl_get_display(), 0),
 178                             GCFunction | GCGraphicsExposures, &val);
 179 }
 180
 181
 182 XWorkArea::~XWorkArea()
 183 {
 184         XFreeGC(fl_get_display(), copy_gc);
 185         if (workareapixmap)
 186                 XFreePixmap(fl_get_display(), workareapixmap);
 187 }
 188
 189
 190 void XWorkArea::updateGeometry(int width, int height)
 191 {
 192         static int cur_width = -1;
 193         static int cur_height = -1;
 194
 195         if (cur_width == width && cur_height == height && workareapixmap)
 196                 return;
 197
 198         cur_width = width;
 199         cur_height = height;
 200
 201         if (lyxerr.debugging(Debug::WORKAREA)) {
 202                 lyxerr << "(Re)creating pixmap ("
 203                        << width << 'x' << height << ')' << endl;
 204         }
 205
 206         if (workareapixmap) {
 207                 XFreePixmap(fl_get_display(), workareapixmap);
 208         }
 209
 210         workareapixmap = XCreatePixmap(fl_get_display(),
 211                                        RootWindow(fl_get_display(), 0),
 212                                        width,
 213                                        height,
 214                                        fl_get_visual_depth());
 215
 216         workAreaResize();
 217 }
 218
 219
 220 void XWorkArea::paint(int x, int y, int w, int h)
 221 {
 222         lyxerr[Debug::WORKAREA]
 223                 << "XWorkarea::paint " << w << 'x' << h
 224                 << '+' << x << '+' << y << endl;
 225
 226         updateGeometry(workWidth(), workHeight());
 227         XCopyArea(fl_get_display(),
 228                   getPixmap(), getWin(),
 229                   copy_gc, x, y, w, h,
 230                   work_area->x + x, work_area->y + y);
 231 }
 232
 233
 234 void XWorkArea::setScrollbarParams(int height, int pos, int line_height)
 235 {
 236         // we need to cache this for scroll_cb
 237         doc_height_ = height;
 238
 239         if (height == 0) {
 240                 fl_set_scrollbar_value(scrollbar, 0.0);
 241                 fl_set_scrollbar_size(scrollbar, scrollbar->h);
 242                 return;
 243         }
 244
 245         long const work_height = workHeight();
 246
 247         if (lyxerr.debugging(Debug::GUI)) {
 248                 lyxerr << "scroll: height now " << height << '\n'
 249                        << "scroll: work_height " << work_height << endl;
 250         }
 251
 252         /* If the text is smaller than the working area, the scrollbar
 253          * maximum must be the working area height. No scrolling will
 254          * be possible */
 255         if (height <= work_height) {
 256                 lyxerr[Debug::GUI] << "scroll: doc smaller than workarea !"
 257                                    << endl;
 258                 fl_set_scrollbar_bounds(scrollbar, 0.0, 0.0);
 259                 fl_set_scrollbar_value(scrollbar, pos);
 260                 fl_set_scrollbar_size(scrollbar, scrollbar->h);
 261                 return;
 262         }
 263
 264         fl_set_scrollbar_bounds(scrollbar, 0.0, height - work_height);
 265         fl_set_scrollbar_increment(scrollbar, work_area->h - line_height, line_height);
 266
 267         fl_set_scrollbar_value(scrollbar, pos);
 268
 269         double const slider_size =
 270                 (height == 0) ? 1.0 : 1.0 / double(height);
 271
 272         fl_set_scrollbar_size(scrollbar, scrollbar->h * slider_size);
 273 }
 274
 275
 276 // callback for scrollbar slider
 277 void XWorkArea::scroll_cb()
 278 {
 279         double const val = fl_get_scrollbar_value(scrollbar);
 280
 281         if (lyxerr.debugging(Debug::GUI)) {
 282                 lyxerr << "scroll: val: " << val << '\n'
 283                        << "scroll: height: " << scrollbar->h << '\n'
 284                        << "scroll: docheight: " << doc_height_ << endl;
 285         }
 286
 287         scrollDocView(int(val));
 288         waitForX(false);
 289 }
 290
 291
 292 int XWorkArea::work_area_handler(FL_OBJECT * ob, int event,
 293                                  FL_Coord, FL_Coord,
 294                                  int key, void * xev)
 295 {
 296         XEvent * ev = static_cast<XEvent*>(xev);
 297         XWorkArea * area = static_cast<XWorkArea*>(ob->u_vdata);
 298
 299         if (!area)
 300                 return 1;
 301
 302         switch (event) {
 303
 304         case FL_DRAW: {
 305                 if (!area->work_area || !area->work_area->form->visible)
 306                         return 1;
 307
 308                 if (ev) {
 309                         lyxerr[Debug::WORKAREA]
 310                                 << "work_area_handler, handling X11 "
 311                                 "expose event "
 312                                 << ev->xexpose.width << 'x'
 313                                 << ev->xexpose.height << '+'
 314                                 << ev->xexpose.x << '+'
 315                                 << ev->xexpose.y << endl;
 316
 317                         // X11 generates XEvents with x, y relative to the
 318                         // top left corner of the window.
 319                         // XScreen::expose emulates this behaviour.
 320                         // We therefore need to remove this offset before
 321                         // generating the pixmap.
 322                          int const x = ev->xexpose.x - ob->x;
 323                          int const y = ev->xexpose.y - ob->y;
 324
 325                         area->paint(x, y,
 326                                     ev->xexpose.width, ev->xexpose.height);
 327                 } else
 328                         area->paint(0, 0,
 329                                     area->workWidth(), area->workHeight());
 330
 331                 break;
 332         }
 333
 334         case FL_PUSH:
 335                 if (!ev || ev->xbutton.button == 0) break;
 336                 // Should really have used xbutton.state
 337                 lyxerr[Debug::WORKAREA] << "Workarea event: PUSH" << endl;
 338                 area->dispatch(
 339                         FuncRequest(LFUN_MOUSE_PRESS,
 340                                     ev->xbutton.x - ob->x,
 341                                     ev->xbutton.y - ob->y,
 342                                     x_button_state(key)));
 343                 break;
 344
 345         case FL_RELEASE:
 346                 if (!ev || ev->xbutton.button == 0) break;
 347                 // Should really have used xbutton.state
 348                 lyxerr[Debug::WORKAREA] << "Workarea event: RELEASE" << endl;
 349                 area->dispatch(
 350                         FuncRequest(LFUN_MOUSE_RELEASE,
 351                                     ev->xbutton.x - ob->x,
 352                                     ev->xbutton.y - ob->y,
 353                                     x_button_state(key)));
 354                 break;
 355
 356         case FL_DRAG: {
 357                 if (!ev || !area->scrollbar)
 358                         break;
 359
 360                 int const drag_x = ev->xmotion.x;
 361                 int const drag_y = ev->xmotion.y;
 362                 int const area_y = ob->y;
 363                 int const area_h = ob->h;
 364
 365                 // Check if the mouse is above or below the workarea
 366                 if (drag_y <= area_y || drag_y >= area_y + area_h) {
 367                         // The mouse button is depressed and we are outside the
 368                         // workarea. That means we are simultaneously selecting
 369                         // text and scrolling the view.
 370                         // Use a Timeout to react to a drag events only every
 371                         // 200ms. All intervening events are discarded,
 372                         // allowing the user to control position easily.
 373                         static int const discard_interval = 200;
 374                         static Timeout timeout(discard_interval);
 375
 376                         if (timeout.running())
 377                                 break;
 378                         // The timeout is not running, so process the
 379                         // event, first starting the timeout to discard future
 380                         // events.
 381                         timeout.start();
 382                 }
 383
 384                 static int x_old = -1;
 385                 static int y_old = -1;
 386                 static double scrollbar_value_old = -1.0;
 387
 388                 double const scrollbar_value =
 389                         fl_get_scrollbar_value(area->scrollbar);
 390
 391                 if (drag_x != x_old || drag_y != y_old ||
 392                     scrollbar_value != scrollbar_value_old) {
 393                         x_old = drag_x;
 394                         y_old = drag_y;
 395                         scrollbar_value_old = scrollbar_value;
 396
 397                         lyxerr[Debug::WORKAREA] << "Workarea event: DRAG"
 398                                                 << endl;
 399
 400                         // It transpires that ev->xbutton.button == 0 when
 401                         // the mouse is dragged, so it cannot be used to
 402                         // initialise x_button_state and hence FuncRequest.
 403
 404                         // The 'key' that is passed into the function does
 405                         // contain the necessary info, however.
 406
 407                         // It is for this reason that x_button_state has
 408                         // been modified to work with key
 409                         // rather than ev->xbutton.button.
 410
 411                         // Angus 15 Oct 2002.
 412                         FuncRequest cmd(LFUN_MOUSE_MOTION,
 413                                         ev->xbutton.x - ob->x,
 414                                         ev->xbutton.y - ob->y,
 415                                         x_button_state(key));
 416                         area->dispatch(cmd);
 417                 }
 418                 break;
 419         }
 420
 421         case FL_KEYPRESS: {
 422                 lyxerr[Debug::WORKAREA] << "Workarea event: KEYPRESS" << endl;
 423
 424                 KeySym keysym = 0;
 425                 char dummy[1];
 426                 XKeyEvent * xke = reinterpret_cast<XKeyEvent *>(ev);
 427                 XLookupString(xke, dummy, 1, &keysym, 0);
 428
 429                 if (lyxerr.debugging(Debug::KEY)) {
 430                         char const * const tmp  = XKeysymToString(key);
 431                         char const * const tmp2 = XKeysymToString(keysym);
 432                         string const stm  = (tmp ? tmp : string());
 433                         string const stm2 = (tmp2 ? tmp2 : string());
 434
 435                         lyxerr << "XWorkArea: Key is `" << stm
 436                                << "' [" << key << "]\n"
 437                                << "XWorkArea: Keysym is `" << stm2
 438                                << "' [" << keysym << ']' << endl;
 439                 }
 440
 441                 // Note that we need this handling because of a bug
 442                 // in XForms 0.89, if this bug is resolved in the way I hope
 443                 // we can just use the keysym directly without looking
 444                 // at key at all. (Lgb)
 445                 KeySym ret_key = 0;
 446                 if (!key) {
 447                         // We might have to add more keysyms here also,
 448                         // we will do that as the issues arise. (Lgb)
 449                         if (keysym == XK_space) {
 450                                 ret_key = keysym;
 451                                 lyxerr[Debug::KEY] << "Using keysym [A]"
 452                                                    << endl;
 453                         } else
 454                                 break;
 455                 } else {
 456                         // It seems that this was a bit optimistic...
 457                         // With this hacking things seems to be better (Lgb)
 458                         //if (!iscntrl(key)) {
 459                         //      ret_key = key;
 460                         //      lyxerr[Debug::KEY]
 461                         //              << "Using key [B]\n"
 462                         //              << "Uchar["
 463                         //              << static_cast<unsigned char>(key)
 464                         //              << endl;
 465                         //} else {
 466                         ret_key = (keysym ? keysym : key);
 467                         lyxerr[Debug::KEY] << "Using keysym [B]"
 468                                            << endl;
 469                                 //}
 470                 }
 471
 472                 unsigned int const ret_state = xke->state;
 473
 474                 // If you have a better way to handle "wild-output" of
 475                 // characters after the key has been released than the one
 476                 // below, please contact me. (Lgb)
 477                 static Time last_time_pressed;
 478                 static unsigned int last_key_pressed;
 479                 static unsigned int last_state_pressed;
 480                 lyxerr[Debug::KEY] << "Workarea Diff: "
 481                                    << xke->time - last_time_pressed
 482                                    << endl;
 483                 if (xke->time - last_time_pressed < 25 // should perhaps be tunable
 484                     && ret_state == last_state_pressed
 485                     && xke->keycode == last_key_pressed) {
 486                         lyxerr[Debug::KEY]
 487                                 << "Workarea: Purging X events." << endl;
 488                         //lyxerr << "Workarea Events: "
 489                         //       << XEventsQueued(fl_get_display(), QueuedAlready)
 490                         //       << endl;
 491                         if (XEventsQueued(fl_get_display(), QueuedAlready) > 0)
 492                                 waitForX(true);
 493                         // This purge make f.ex. scrolling stop immediately when
 494                         // releasing the PageDown button. The question is if
 495                         // this purging of XEvents can cause any harm...
 496                         // after some testing I can see no problems, but
 497                         // I'd like other reports too.
 498                         break;
 499                 }
 500                 last_time_pressed = xke->time;
 501                 last_key_pressed = xke->keycode;
 502                 last_state_pressed = ret_state;
 503
 504                 XLyXKeySym * xlk = new XLyXKeySym;
 505                 xlk->initFromKeySym(ret_key);
 506
 507                 area->workAreaKeyPress(LyXKeySymPtr(xlk),
 508                                        x_key_state(ret_state));
 509                 break;
 510         }
 511
 512         case FL_KEYRELEASE:
 513                 lyxerr[Debug::WORKAREA] << "Workarea event: KEYRELEASE" << endl;
 514                 break;
 515
 516         case FL_ENTER:
 517                 lyxerr[Debug::WORKAREA] << "Workarea event: ENTER" << endl;
 518                 fl_set_cursor(FL_ObjWin(area->work_area), XC_xterm);
 519                 break;
 520
 521         case FL_LEAVE:
 522                 lyxerr[Debug::WORKAREA] << "Workarea event: LEAVE" << endl;
 523                 // There should be no need for this. But there is.
 524                 fl_set_cursor(FL_ObjWin(area->work_area), FL_DEFAULT_CURSOR);
 525                 break;
 526
 527         case FL_DBLCLICK:
 528                 if (ev) {
 529                         lyxerr[Debug::WORKAREA] << "Workarea event: DBLCLICK" << endl;
 530                         FuncRequest cmd(LFUN_MOUSE_DOUBLE,
 531                                         ev->xbutton.x - ob->x,
 532                                         ev->xbutton.y - ob->y,
 533                                         x_button_state(key));
 534                         area->dispatch(cmd);
 535                 }
 536                 break;
 537
 538         case FL_TRPLCLICK:
 539                 if (ev) {
 540                         lyxerr[Debug::WORKAREA] << "Workarea event: TRPLCLICK" << endl;
 541                         FuncRequest cmd(LFUN_MOUSE_TRIPLE,
 542                                         ev->xbutton.x - ob->x,
 543                                         ev->xbutton.y - ob->y,
 544                                         x_button_state(key));
 545                         area->dispatch(cmd);
 546                 }
 547                 break;
 548
 549         case FL_OTHER:
 550                 if (ev)
 551                         lyxerr[Debug::WORKAREA] << "Workarea event: OTHER" << endl;
 552                 break;
 553         }
 554
 555         return 1;
 556 }
 557
 558
 559 namespace {
 560
 561 string clipboard_selection;
 562 bool clipboard_read = false;
 563
 564 extern "C" {
 565
 566 int request_clipboard_cb(FL_OBJECT * /*ob*/, long /*type*/,
 567                          void const * data, long size)
 568 {
 569         clipboard_selection.erase();
 570
 571         if (size > 0)
 572                 clipboard_selection.reserve(size);
 573         for (int i = 0; i < size; ++i)
 574                 clipboard_selection += static_cast<char const *>(data)[i];
 575         clipboard_read = true;
 576         return 0;
 577 }
 578
 579 } // extern "C"
 580 } // namespace anon
 581
 582
 583 int XWorkArea::event_cb(XEvent * xev)
 584 {
 585         switch (xev->type) {
 586         case SelectionRequest:
 587                 lyxerr[Debug::GUI] << "X requested selection." << endl;
 588                 selectionRequested();
 589                 break;
 590         case SelectionClear:
 591                 lyxerr[Debug::GUI] << "Lost selection." << endl;
 592                 selectionLost();
 593                 break;
 594         }
 595         return 0;
 596 }
 597
 598
 599 void XWorkArea::haveSelection(bool yes) const
 600 {
 601         Window const owner = yes ? FL_ObjWin(work_area) : None;
 602         XSetSelectionOwner(fl_get_display(), XA_PRIMARY, owner, CurrentTime);
 603 }
 604
 605
 606 string const XWorkArea::getClipboard() const
 607 {
 608         clipboard_read = false;
 609
 610         if (fl_request_clipboard(work_area, 0, request_clipboard_cb) == -1)
 611                 return string();
 612
 613         XEvent ev;
 614
 615         while (!clipboard_read) {
 616                 if (fl_check_forms() == FL_EVENT) {
 617                         fl_XNextEvent(&ev);
 618                         lyxerr << "Received unhandled X11 event\n"
 619                                << "Type: 0x" << hex << ev.xany.type
 620                                << " Target: 0x" << hex << ev.xany.window
 621                                << dec << endl;
 622                 }
 623         }
 624         return clipboard_selection;
 625 }
 626
 627
 628 void XWorkArea::putClipboard(string const & s) const
 629 {
 630         static string hold;
 631         hold = s;
 632
 633         fl_stuff_clipboard(work_area, 0, hold.data(), hold.size(), 0);
 634 }
 635
 636 } // namespace frontend
 637 } // namespace lyx