src/stc/ScintillaWX.cpp

   1 ////////////////////////////////////////////////////////////////////////////
   2 // Name:        ScintillaWX.cxx
   3 // Purpose:     A wxWindows implementation of Scintilla.  A class derived
   4 //              from ScintillaBase that uses the "wx platform" defined in
   5 //              PlatformWX.cxx  This class is one end of a bridge between
   6 //              the wx world and the Scintilla world.  It needs a peer
   7 //              object of type wxStyledTextCtrl to function.
   8 //
   9 // Author:      Robin Dunn
  10 //
  11 // Created:     13-Jan-2000
  12 // RCS-ID:      $Id$
  13 // Copyright:   (c) 2000 by Total Control Software
  14 // Licence:     wxWindows license
  15 /////////////////////////////////////////////////////////////////////////////
  16
  17 #include <ctype.h>
  18
  19 #include "ScintillaWX.h"
  20 #include "wx/stc/stc.h"
  21
  22
  23 //----------------------------------------------------------------------
  24
  25 const int H_SCROLL_MAX  = 2000;
  26 const int H_SCROLL_STEP = 20;
  27 const int H_SCROLL_PAGE = 200;
  28
  29 //----------------------------------------------------------------------
  30 // Helper classes
  31
  32 class wxSTCTimer : public wxTimer {
  33 public:
  34     wxSTCTimer(ScintillaWX* swx) {
  35         this->swx = swx;
  36     }
  37
  38     void Notify() {
  39         swx->DoTick();
  40     }
  41
  42 private:
  43     ScintillaWX* swx;
  44 };
  45
  46
  47
  48 bool wxSTCDropTarget::OnDropText(wxCoord x, wxCoord y, const wxString& data) {
  49     return swx->DoDropText(x, y, data);
  50 }
  51
  52 wxDragResult  wxSTCDropTarget::OnEnter(wxCoord x, wxCoord y, wxDragResult def) {
  53     return swx->DoDragEnter(x, y, def);
  54 }
  55
  56 wxDragResult  wxSTCDropTarget::OnDragOver(wxCoord x, wxCoord y, wxDragResult def) {
  57     return swx->DoDragOver(x, y, def);
  58 }
  59
  60 void  wxSTCDropTarget::OnLeave() {
  61     swx->DoDragLeave();
  62 }
  63
  64
  65 class wxSTCCallTip : public wxWindow {
  66 public:
  67     wxSTCCallTip(wxWindow* parent, int ID, CallTip* ct)
  68         : wxWindow(parent, ID)
  69         {
  70             m_ct = ct;
  71         }
  72
  73     void OnPaint(wxPaintEvent& evt) {
  74         wxPaintDC dc(this);
  75         Surface surfaceWindow;
  76         surfaceWindow.Init(&dc);
  77         m_ct->PaintCT(&surfaceWindow);
  78         surfaceWindow.Release();
  79     }
  80
  81     CallTip*    m_ct;
  82     DECLARE_EVENT_TABLE()
  83 };
  84
  85 BEGIN_EVENT_TABLE(wxSTCCallTip, wxWindow)
  86     EVT_PAINT(wxSTCCallTip::OnPaint)
  87 END_EVENT_TABLE()
  88
  89 //----------------------------------------------------------------------
  90 // Constructor/Destructor
  91
  92
  93 ScintillaWX::ScintillaWX(wxStyledTextCtrl* win) {
  94     capturedMouse = false;
  95     wMain = win;
  96     stc   = win;
  97     wheelRotation = 0;
  98     Initialise();
  99 }
 100
 101
 102 ScintillaWX::~ScintillaWX() {
 103     SetTicking(false);
 104 }
 105
 106 //----------------------------------------------------------------------
 107 // base class virtuals
 108
 109
 110 void ScintillaWX::Initialise() {
 111     //ScintillaBase::Initialise();
 112     dropTarget = new wxSTCDropTarget;
 113     dropTarget->SetScintilla(this);
 114     stc->SetDropTarget(dropTarget);
 115 }
 116
 117
 118 void ScintillaWX::Finalise() {
 119     ScintillaBase::Finalise();
 120 }
 121
 122
 123 void ScintillaWX::StartDrag() {
 124     wxDropSource        source(wMain.GetID());
 125     wxTextDataObject    data(dragChars);
 126     wxDragResult        result;
 127
 128     source.SetData(data);
 129     result = source.DoDragDrop(TRUE);
 130     if (result == wxDragMove && dropWentOutside)
 131         ClearSelection();
 132     inDragDrop = FALSE;
 133     SetDragPosition(invalidPosition);
 134 }
 135
 136
 137 void ScintillaWX::SetTicking(bool on) {
 138     wxSTCTimer* steTimer;
 139     if (timer.ticking != on) {
 140         timer.ticking = on;
 141         if (timer.ticking) {
 142             steTimer = new wxSTCTimer(this);
 143             steTimer->Start(timer.tickSize);
 144             timer.tickerID = (int)steTimer;
 145         } else {
 146             steTimer = (wxSTCTimer*)timer.tickerID;
 147             steTimer->Stop();
 148             delete steTimer;
 149             timer.tickerID = 0;
 150         }
 151     }
 152     timer.ticksToWait = caret.period;
 153 }
 154
 155
 156 void ScintillaWX::SetMouseCapture(bool on) {
 157     if (on && !capturedMouse)
 158         wMain.GetID()->CaptureMouse();
 159     else if (!on && capturedMouse)
 160         wMain.GetID()->ReleaseMouse();
 161     capturedMouse = on;
 162 }
 163
 164
 165 bool ScintillaWX::HaveMouseCapture() {
 166     return capturedMouse;
 167 }
 168
 169
 170 void ScintillaWX::ScrollText(int linesToMove) {
 171     int dy = vs.lineHeight * (linesToMove);
 172     wMain.GetID()->ScrollWindow(0, dy);
 173     wMain.GetID()->Update();
 174 }
 175
 176 void ScintillaWX::SetVerticalScrollPos() {
 177     wMain.GetID()->SetScrollPos(wxVERTICAL, topLine);
 178 }
 179
 180 void ScintillaWX::SetHorizontalScrollPos() {
 181     wMain.GetID()->SetScrollPos(wxHORIZONTAL, xOffset);
 182 }
 183
 184
 185 bool ScintillaWX::ModifyScrollBars(int nMax, int nPage) {
 186     bool modified = false;
 187     int  sbMax    = wMain.GetID()->GetScrollRange(wxVERTICAL);
 188     int  sbThumb  = wMain.GetID()->GetScrollThumb(wxVERTICAL);
 189     int  sbPos    = wMain.GetID()->GetScrollPos(wxVERTICAL);
 190
 191
 192     if (sbMax != nMax || sbThumb != nPage) {
 193         wMain.GetID()->SetScrollbar(wxVERTICAL, sbPos, nPage, nMax);
 194         modified = true;
 195     }
 196
 197     sbMax    = wMain.GetID()->GetScrollRange(wxHORIZONTAL);
 198     sbThumb  = wMain.GetID()->GetScrollThumb(wxHORIZONTAL);
 199     if ((sbMax != H_SCROLL_MAX) || (sbThumb != H_SCROLL_STEP)) {
 200         wMain.GetID()->SetScrollbar(wxHORIZONTAL, 0, H_SCROLL_STEP, H_SCROLL_MAX);
 201         modified = true;
 202     }
 203     return modified;
 204 }
 205
 206
 207 void ScintillaWX::NotifyChange() {
 208     stc->NotifyChange();
 209 }
 210
 211
 212 void ScintillaWX::NotifyParent(SCNotification scn) {
 213     stc->NotifyParent(&scn);
 214 }
 215
 216
 217
 218 void ScintillaWX::Copy() {
 219     if (currentPos != anchor) {
 220         char* text = CopySelectionRange();
 221         wxTheClipboard->Open();
 222         wxTheClipboard->SetData(new wxTextDataObject(text));
 223         wxTheClipboard->Close();
 224     }
 225 }
 226
 227
 228 void ScintillaWX::Paste() {
 229     pdoc->BeginUndoAction();
 230     ClearSelection();
 231
 232     wxTextDataObject data;
 233     bool canPaste;
 234
 235     wxTheClipboard->Open();
 236     canPaste = wxTheClipboard->GetData(data);
 237     wxTheClipboard->Close();
 238     if (canPaste) {
 239         wxString str = data.GetText();
 240         int      len = str.Length();
 241         pdoc->InsertString(currentPos, str.c_str(), len);
 242         SetEmptySelection(currentPos + len);
 243     }
 244
 245     pdoc->EndUndoAction();
 246     NotifyChange();
 247     Redraw();
 248 }
 249
 250
 251 bool ScintillaWX::CanPaste() {
 252     wxTextDataObject data;
 253     bool canPaste;
 254
 255     wxTheClipboard->Open();
 256     canPaste = wxTheClipboard->GetData(data);
 257     wxTheClipboard->Close();
 258
 259     return canPaste;
 260 }
 261
 262 void ScintillaWX::CreateCallTipWindow(PRectangle) {
 263     ct.wCallTip = new wxSTCCallTip(wMain.GetID(), -1, &ct);
 264     ct.wDraw = ct.wCallTip;
 265 }
 266
 267
 268 void ScintillaWX::AddToPopUp(const char *label, int cmd, bool enabled) {
 269     if (!label[0])
 270         popup.GetID()->AppendSeparator();
 271     else
 272         popup.GetID()->Append(cmd, label);
 273
 274     if (!enabled)
 275         popup.GetID()->Enable(cmd, enabled);
 276 }
 277
 278
 279 void ScintillaWX::ClaimSelection() {
 280
 281 }
 282
 283
 284 long ScintillaWX::DefWndProc(unsigned int /*iMessage*/, unsigned long /*wParam*/, long /*lParam*/) {
 285     return 0;
 286 }
 287
 288 long ScintillaWX::WndProc(unsigned int iMessage, unsigned long wParam, long lParam) {
 289 //      switch (iMessage) {
 290 //      case EM_CANPASTE:
 291 //          return CanPaste();
 292 //      default:
 293         return ScintillaBase::WndProc(iMessage, wParam, lParam);
 294 //      }
 295 //      return 0;
 296 }
 297
 298
 299
 300 //----------------------------------------------------------------------
 301 // Event delegates
 302
 303 void ScintillaWX::DoPaint(wxDC* dc, wxRect rect) {
 304
 305     paintState = painting;
 306     Surface surfaceWindow;
 307     surfaceWindow.Init(dc);
 308     PRectangle rcPaint = PRectangleFromwxRect(rect);
 309     dc->BeginDrawing();
 310     Paint(&surfaceWindow, rcPaint);
 311     dc->EndDrawing();
 312     surfaceWindow.Release();
 313     if (paintState == paintAbandoned) {
 314         // Painting area was insufficient to cover new styling or brace highlight positions
 315         FullPaint();
 316     }
 317     paintState = notPainting;
 318 #ifdef __WXGTK__
 319     // On wxGTK the editor window paints can overwrite the listbox...
 320     if (ac.Active())
 321         ((wxWindow*)ac.lb.GetID())->Refresh(TRUE);
 322 #endif
 323 }
 324
 325
 326 void ScintillaWX::DoHScroll(int type, int pos) {
 327     int xPos = xOffset;
 328     if (type == wxEVT_SCROLLWIN_LINEUP)
 329         xPos -= H_SCROLL_STEP;
 330     else if (type == wxEVT_SCROLLWIN_LINEDOWN)
 331         xPos += H_SCROLL_STEP;
 332     else if (type == wxEVT_SCROLLWIN_PAGEUP)
 333         xPos -= H_SCROLL_PAGE;
 334     else if (type == wxEVT_SCROLLWIN_PAGEDOWN)
 335         xPos += H_SCROLL_PAGE;
 336     else if (type == wxEVT_SCROLLWIN_TOP)
 337         xPos = 0;
 338     else if (type == wxEVT_SCROLLWIN_BOTTOM)
 339         xPos = H_SCROLL_MAX;
 340     else if (type == wxEVT_SCROLLWIN_THUMBTRACK)
 341         xPos = pos;
 342
 343     HorizontalScrollTo(xPos);
 344 }
 345
 346 void ScintillaWX::DoVScroll(int type, int pos) {
 347     int topLineNew = topLine;
 348     if (type == wxEVT_SCROLLWIN_LINEUP)
 349         topLineNew -= 1;
 350     else if (type == wxEVT_SCROLLWIN_LINEDOWN)
 351         topLineNew += 1;
 352     else if (type ==  wxEVT_SCROLLWIN_PAGEUP)
 353         topLineNew -= LinesToScroll();
 354     else if (type ==  wxEVT_SCROLLWIN_PAGEDOWN)
 355         topLineNew += LinesToScroll();
 356     else if (type ==  wxEVT_SCROLLWIN_TOP)
 357         topLineNew = 0;
 358     else if (type ==  wxEVT_SCROLLWIN_BOTTOM)
 359         topLineNew = MaxScrollPos();
 360     else if (type ==   wxEVT_SCROLLWIN_THUMBTRACK)
 361         topLineNew = pos;
 362
 363     ScrollTo(topLineNew);
 364 }
 365
 366
 367 void ScintillaWX::DoMouseWheel(int rotation, int delta, int linesPerAction, int ctrlDown) {
 368     int topLineNew = topLine;
 369     int lines;
 370
 371     if (ctrlDown) {  // Zoom the fonts if Ctrl key down
 372         if (rotation < 0) {
 373             KeyCommand(SCI_ZOOMIN);
 374         }
 375         else {
 376             KeyCommand(SCI_ZOOMOUT);
 377         }
 378     }
 379     else { // otherwise just scroll the window
 380         wheelRotation += rotation;
 381         lines = wheelRotation / delta;
 382         wheelRotation -= lines * delta;
 383         if (lines != 0) {
 384             lines *= linesPerAction;
 385             topLineNew -= lines;
 386             ScrollTo(topLineNew);
 387         }
 388     }
 389 }
 390
 391
 392 void ScintillaWX::DoSize(int width, int height) {
 393     PRectangle rcClient(0,0,width,height);
 394     SetScrollBarsTo(rcClient);
 395     DropGraphics();
 396 }
 397
 398 void ScintillaWX::DoLoseFocus(){
 399     SetFocusState(false);
 400 }
 401
 402 void ScintillaWX::DoGainFocus(){
 403     SetFocusState(true);
 404 }
 405
 406 void ScintillaWX::DoSysColourChange() {
 407     InvalidateStyleData();
 408 }
 409
 410 void ScintillaWX::DoButtonDown(Point pt, unsigned int curTime, bool shift, bool ctrl, bool alt) {
 411     ButtonDown(pt, curTime, shift, ctrl, alt);
 412 }
 413
 414 void ScintillaWX::DoButtonUp(Point pt, unsigned int curTime, bool ctrl) {
 415     ButtonUp(pt, curTime, ctrl);
 416 }
 417
 418 void ScintillaWX::DoButtonMove(Point pt) {
 419     ButtonMove(pt);
 420 }
 421
 422
 423 void ScintillaWX::DoAddChar(char ch) {
 424     //bool acActiveBeforeCharAdded = ac.Active();
 425     AddChar(ch);
 426     //if (acActiveBeforeCharAdded)
 427     //    AutoCompleteChanged(ch);
 428 }
 429
 430 int  ScintillaWX::DoKeyDown(int key, bool shift, bool ctrl, bool alt, bool* consumed) {
 431 #ifdef __WXGTK__
 432     // Ctrl chars (A-Z) end up with the wrong keycode on wxGTK...
 433     if (ctrl && key >= 1 && key <= 26)
 434         key += 'A' - 1;
 435 #endif
 436
 437     switch (key) {
 438     case WXK_DOWN: key = SCK_DOWN; break;
 439     case WXK_UP: key = SCK_UP; break;
 440     case WXK_LEFT: key = SCK_LEFT; break;
 441     case WXK_RIGHT: key = SCK_RIGHT; break;
 442     case WXK_HOME: key = SCK_HOME; break;
 443     case WXK_END: key = SCK_END; break;
 444     case WXK_PRIOR: key = SCK_PRIOR; break;
 445     case WXK_NEXT: key = SCK_NEXT; break;
 446     case WXK_DELETE: key = SCK_DELETE; break;
 447     case WXK_INSERT: key = SCK_INSERT; break;
 448     case WXK_ESCAPE: key = SCK_ESCAPE; break;
 449     case WXK_BACK: key = SCK_BACK; break;
 450     case WXK_TAB: key = SCK_TAB; break;
 451     case WXK_RETURN: key = SCK_RETURN; break;
 452     case WXK_ADD:
 453     case WXK_NUMPAD_ADD:
 454         key = SCK_ADD; break;
 455     case WXK_SUBTRACT:
 456     case WXK_NUMPAD_SUBTRACT:
 457         key = SCK_SUBTRACT; break;
 458     case WXK_DIVIDE:
 459     case WXK_NUMPAD_DIVIDE:
 460         key = SCK_DIVIDE; break;
 461     case WXK_CONTROL: key = 0; break;
 462     case WXK_ALT: key = 0; break;
 463     case WXK_SHIFT: key = 0; break;
 464     case WXK_MENU: key = 0; break;
 465     }
 466
 467     int rv = KeyDown(key, shift, ctrl, alt, consumed);
 468
 469 //      printf("key: %d  shift: %d  ctrl: %d  alt: %d  rv: %d  consumed: %d\n",
 470 //             key, shift, ctrl, alt, rv, *consumed);
 471
 472     if (key)
 473         return rv;
 474     else
 475         return 1;
 476 }
 477
 478
 479 void ScintillaWX::DoCommand(int ID) {
 480     Command(ID);
 481 }
 482
 483
 484 void ScintillaWX::DoContextMenu(Point pt) {
 485     ContextMenu(pt);
 486 }
 487
 488 void ScintillaWX::DoOnListBox() {
 489     AutoCompleteCompleted();
 490 }
 491
 492 //----------------------------------------------------------------------
 493
 494 bool ScintillaWX::DoDropText(long x, long y, const wxString& data) {
 495     SetDragPosition(invalidPosition);
 496     int movePos = PositionFromLocation(Point(x,y));
 497     DropAt(movePos, data, dragResult == wxDragMove, FALSE); // TODO: rectangular?
 498     return TRUE;
 499 }
 500
 501
 502 wxDragResult ScintillaWX::DoDragEnter(wxCoord x, wxCoord y, wxDragResult def) {
 503     return def;
 504 }
 505
 506
 507 wxDragResult ScintillaWX::DoDragOver(wxCoord x, wxCoord y, wxDragResult def) {
 508     SetDragPosition(PositionFromLocation(Point(x, y)));
 509     dragResult = def;
 510     return def;
 511 }
 512
 513
 514 void ScintillaWX::DoDragLeave() {
 515     SetDragPosition(invalidPosition);
 516 }
 517
 518 //----------------------------------------------------------------------
 519
 520 // Redraw all of text area. This paint will not be abandoned.
 521 void ScintillaWX::FullPaint() {
 522     paintState = painting;
 523     rcPaint = GetTextRectangle();
 524     paintingAllText = true;
 525     wxClientDC dc(wMain.GetID());
 526     Surface surfaceWindow;
 527     surfaceWindow.Init(&dc);
 528     Paint(&surfaceWindow, rcPaint);
 529     surfaceWindow.Release();
 530
 531 //     wMain.GetID()->Refresh(FALSE);
 532
 533     paintState = notPainting;
 534 }
 535
 536
 537 void ScintillaWX::DoScrollToLine(int line) {
 538     ScrollTo(line);
 539 }
 540
 541
 542 void ScintillaWX::DoScrollToColumn(int column) {
 543     HorizontalScrollTo(column * vs.spaceWidth);
 544 }
 545
 546
 547
 548 //----------------------------------------------------------------------
 549 //----------------------------------------------------------------------