src/x11/app.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        app.cpp
   3 // Purpose:     wxApp
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13     #pragma implementation "app.h"
  14 #endif
  15
  16 #include "wx/frame.h"
  17 #include "wx/app.h"
  18 #include "wx/utils.h"
  19 #include "wx/gdicmn.h"
  20 #include "wx/pen.h"
  21 #include "wx/brush.h"
  22 #include "wx/cursor.h"
  23 #include "wx/icon.h"
  24 #include "wx/palette.h"
  25 #include "wx/dc.h"
  26 #include "wx/dialog.h"
  27 #include "wx/msgdlg.h"
  28 #include "wx/log.h"
  29 #include "wx/module.h"
  30 #include "wx/memory.h"
  31 #include "wx/log.h"
  32 #include "wx/intl.h"
  33 #include "wx/evtloop.h"
  34
  35 #if wxUSE_THREADS
  36     #include "wx/thread.h"
  37 #endif
  38
  39 #if wxUSE_WX_RESOURCES
  40     #include "wx/resource.h"
  41 #endif
  42
  43 #ifdef __VMS__
  44 #pragma message disable nosimpint
  45 #endif
  46 #include <X11/Xlib.h>
  47 #include <X11/Xutil.h>
  48 #include <X11/Xresource.h>
  49 #include <X11/Xatom.h>
  50 #ifdef __VMS__
  51 #pragma message enable nosimpint
  52 #endif
  53
  54 #include "wx/x11/private.h"
  55
  56 #include <string.h>
  57
  58 extern char *wxBuffer;
  59 extern wxList wxPendingDelete;
  60
  61 wxApp *wxTheApp = NULL;
  62
  63 wxHashTable *wxWidgetHashTable = NULL;
  64
  65 IMPLEMENT_DYNAMIC_CLASS(wxApp, wxEvtHandler)
  66
  67 BEGIN_EVENT_TABLE(wxApp, wxEvtHandler)
  68     EVT_IDLE(wxApp::OnIdle)
  69 END_EVENT_TABLE()
  70
  71 #ifdef __WXDEBUG__
  72 typedef int (*XErrorHandlerFunc)(Display *, XErrorEvent *);
  73
  74 XErrorHandlerFunc gs_pfnXErrorHandler = 0;
  75
  76 static int wxXErrorHandler(Display *dpy, XErrorEvent *xevent)
  77 {
  78     // just forward to the default handler for now
  79     return gs_pfnXErrorHandler(dpy, xevent);
  80 }
  81 #endif // __WXDEBUG__
  82
  83 long wxApp::sm_lastMessageTime = 0;
  84
  85 bool wxApp::Initialize()
  86 {
  87     wxBuffer = new char[BUFSIZ + 512];
  88
  89     wxClassInfo::InitializeClasses();
  90
  91     // GL: I'm annoyed ... I don't know where to put this and I don't want to
  92     // create a module for that as it's part of the core.
  93 #if wxUSE_THREADS
  94     wxPendingEventsLocker = new wxCriticalSection();
  95 #endif
  96
  97     wxTheColourDatabase = new wxColourDatabase(wxKEY_STRING);
  98     wxTheColourDatabase->Initialize();
  99
 100     wxInitializeStockLists();
 101     wxInitializeStockObjects();
 102
 103 #if wxUSE_WX_RESOURCES
 104     wxInitializeResourceSystem();
 105 #endif
 106
 107     wxBitmap::InitStandardHandlers();
 108
 109     wxWidgetHashTable = new wxHashTable(wxKEY_INTEGER);
 110
 111     wxModule::RegisterModules();
 112     if (!wxModule::InitializeModules()) return FALSE;
 113
 114     return TRUE;
 115 }
 116
 117 void wxApp::CleanUp()
 118 {
 119     delete wxWidgetHashTable;
 120     wxWidgetHashTable = NULL;
 121
 122     wxModule::CleanUpModules();
 123
 124 #if wxUSE_WX_RESOURCES
 125     wxCleanUpResourceSystem();
 126 #endif
 127
 128     wxDeleteStockObjects() ;
 129
 130     // Destroy all GDI lists, etc.
 131
 132     wxDeleteStockLists();
 133
 134     delete wxTheColourDatabase;
 135     wxTheColourDatabase = NULL;
 136
 137     wxBitmap::CleanUpHandlers();
 138
 139     delete[] wxBuffer;
 140     wxBuffer = NULL;
 141
 142     wxClassInfo::CleanUpClasses();
 143
 144     delete wxTheApp;
 145     wxTheApp = NULL;
 146
 147     // GL: I'm annoyed ... I don't know where to put this and I don't want to
 148     // create a module for that as it's part of the core.
 149 #if wxUSE_THREADS
 150     delete wxPendingEvents;
 151     delete wxPendingEventsLocker;
 152 #endif
 153
 154 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 155     // At this point we want to check if there are any memory
 156     // blocks that aren't part of the wxDebugContext itself,
 157     // as a special case. Then when dumping we need to ignore
 158     // wxDebugContext, too.
 159     if (wxDebugContext::CountObjectsLeft(TRUE) > 0)
 160     {
 161         wxLogDebug("There were memory leaks.\n");
 162         wxDebugContext::Dump();
 163         wxDebugContext::PrintStatistics();
 164     }
 165 #endif
 166
 167     // do it as the very last thing because everything else can log messages
 168     wxLog::DontCreateOnDemand();
 169     // do it as the very last thing because everything else can log messages
 170     delete wxLog::SetActiveTarget(NULL);
 171 }
 172
 173 int wxEntry( int argc, char *argv[] )
 174 {
 175 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 176     // This seems to be necessary since there are 'rogue'
 177     // objects present at this point (perhaps global objects?)
 178     // Setting a checkpoint will ignore them as far as the
 179     // memory checking facility is concerned.
 180     // Of course you may argue that memory allocated in globals should be
 181     // checked, but this is a reasonable compromise.
 182     wxDebugContext::SetCheckpoint();
 183 #endif
 184
 185     if (!wxApp::Initialize())
 186         return FALSE;
 187
 188     if (!wxTheApp)
 189     {
 190         if (!wxApp::GetInitializerFunction())
 191         {
 192             printf( "wxWindows error: No initializer - use IMPLEMENT_APP macro.\n" );
 193             return 0;
 194         };
 195
 196         wxTheApp = (wxApp*) (* wxApp::GetInitializerFunction()) ();
 197     };
 198
 199     if (!wxTheApp)
 200     {
 201         printf( "wxWindows error: wxTheApp == NULL\n" );
 202         return 0;
 203     };
 204
 205     wxTheApp->SetClassName(wxFileNameFromPath(argv[0]));
 206     wxTheApp->SetAppName(wxFileNameFromPath(argv[0]));
 207
 208     wxTheApp->argc = argc;
 209     wxTheApp->argv = argv;
 210
 211     // GUI-specific initialization, such as creating an app context.
 212     wxTheApp->OnInitGui();
 213
 214     // Here frames insert themselves automatically into wxTopLevelWindows by
 215     // getting created in OnInit().
 216
 217     int retValue = 0;
 218     if (wxTheApp->OnInit())
 219     {
 220         if (wxTheApp->Initialized()) retValue = wxTheApp->OnRun();
 221     }
 222
 223     // flush the logged messages if any
 224     wxLog *pLog = wxLog::GetActiveTarget();
 225     if ( pLog != NULL && pLog->HasPendingMessages() )
 226         pLog->Flush();
 227
 228     delete wxLog::SetActiveTarget(new wxLogStderr); // So dialog boxes aren't used
 229     // for further messages
 230
 231     if (wxTheApp->GetTopWindow())
 232     {
 233         delete wxTheApp->GetTopWindow();
 234         wxTheApp->SetTopWindow(NULL);
 235     }
 236
 237     wxTheApp->DeletePendingObjects();
 238
 239     wxTheApp->OnExit();
 240
 241     wxApp::CleanUp();
 242
 243     return retValue;
 244 };
 245
 246 // Static member initialization
 247 wxAppInitializerFunction wxAppBase::m_appInitFn = (wxAppInitializerFunction) NULL;
 248
 249 wxApp::wxApp()
 250 {
 251     m_topWindow = NULL;
 252     wxTheApp = this;
 253     m_className = "";
 254     m_wantDebugOutput = TRUE ;
 255     m_appName = "";
 256     argc = 0;
 257     argv = NULL;
 258     m_exitOnFrameDelete = TRUE;
 259     m_mainColormap = (WXColormap) NULL;
 260     m_topLevelWidget = (WXWindow) NULL;
 261     m_maxRequestSize = 0;
 262     m_initialDisplay = (WXDisplay*) 0;
 263     m_mainLoop = NULL;
 264 }
 265
 266 bool wxApp::Initialized()
 267 {
 268     if (GetTopWindow())
 269         return TRUE;
 270     else
 271         return FALSE;
 272 }
 273
 274 int wxApp::MainLoop()
 275 {
 276      int rt;
 277     m_mainLoop = new wxEventLoop;
 278
 279     rt = m_mainLoop->Run();
 280
 281     delete m_mainLoop;
 282     m_mainLoop = NULL;
 283     return rt;
 284 }
 285
 286 // Processes an X event.
 287 void wxApp::ProcessXEvent(WXEvent* _event)
 288 {
 289     XEvent* event = (XEvent*) _event;
 290
 291     wxWindow* win = NULL;
 292     Window window = event->xany.window;
 293     Window actualWindow = window;
 294
 295     // Find the first wxWindow that corresponds to this event window
 296     // TODO: may need to translate coordinates from actualWindow
 297     // to window, if the receiving window != wxWindow window
 298     while (window && !(win = wxGetWindowFromTable(window)))
 299         window = XGetParent(window);
 300
 301     // TODO: shouldn't all the ProcessEvents below
 302     // be win->GetEventHandler()->ProcessEvent?
 303     switch (event->type)
 304     {
 305         case KeyPress:
 306         {
 307             if (CheckForAccelerator(_event))
 308             {
 309                 // Do nothing! We intercepted and processed the event as an
 310                 // accelerator.
 311                 return;
 312             }
 313             else
 314             {
 315                 if (win)
 316                 {
 317                     wxKeyEvent keyEvent(wxEVT_KEY_DOWN);
 318                     wxTranslateKeyEvent(keyEvent, win, window, xEvent);
 319
 320                     // We didn't process wxEVT_KEY_DOWN, so send
 321                     // wxEVT_KEY_CHAR
 322                     if (!win->ProcessEvent( keyEvent ))
 323                     {
 324                         keyEvent.SetEventType(wxEVT_KEY_CHAR);
 325                         win->ProcessEvent( keyEvent );
 326                     }
 327
 328                     // We intercepted and processed the key down event
 329                     return;
 330                 }
 331             }
 332             return;
 333         }
 334         case KeyRelease:
 335         {
 336             if (win)
 337             {
 338                 wxKeyEvent keyEvent(wxEVT_KEY_UP);
 339                 wxTranslateKeyEvent(keyEvent, win, window, event);
 340
 341                 win->ProcessEvent( keyEvent );
 342             }
 343             return;
 344         }
 345         case PropertyNotify:
 346         {
 347             HandlePropertyChange(_event);
 348             return;
 349         }
 350         case ResizeRequest:
 351         {
 352             /* Terry Gitnick <terryg@scientech.com> - 1/21/98
 353             * If resize event, don't resize until the last resize event for this
 354             * window is recieved. Prevents flicker as windows are resized.
 355             */
 356
 357             Display *disp = wxGetDisplay();
 358             XEvent report;
 359
 360             //  to avoid flicker
 361             report = * event;
 362             while( XCheckTypedWindowEvent (disp, actualWindow, ResizeRequest, &report));
 363
 364             // TODO: when implementing refresh optimization, we can use
 365             // XtAddExposureToRegion to expand the window's paint region.
 366
 367             if (win)
 368             {
 369                 wxSize sz = win->GetSize();
 370                 wxSizeEvent sizeEvent(sz, win->GetId());
 371                 sizeEvent.SetEventObject(win);
 372
 373                 win->ProcessEvent( wxevent );
 374             }
 375
 376             return;
 377         }
 378         case Expose:
 379         {
 380             if (win)
 381             {
 382                 win->AddUpdateRect(event->xexpose.x, event->xexpose.y,
 383                                event->xexpose.width, event->xexpose.height);
 384
 385                 if (event -> xexpose.count == 0)
 386                 {
 387                     win->DoPaint();
 388                     win->ClearUpdateRects();
 389                 }
 390             }
 391
 392             return;
 393         }
 394         case EnterNotify:
 395         case LeaveNotify:
 396         case ButtonPress:
 397         case ButtonRelease:
 398         case MotionNotify:
 399         {
 400             if (win)
 401             {
 402                 wxMouseEvent wxevent;
 403                 wxTranslateMouseEvent(wxevent, win, window, event);
 404                 win->ProcessEvent( wxevent );
 405             }
 406             return;
 407         }
 408         case FocusIn:
 409             {
 410                 if (win && event->xfocus.detail != NotifyPointer)
 411                 {
 412                     wxFocusEvent focusEvent(wxEVT_SET_FOCUS, win->GetId());
 413                     focusEvent.SetEventObject(win);
 414                     win->ProcessEvent(focusEvent);
 415                 }
 416                 break;
 417             }
 418         case FocusOut:
 419             {
 420                 if (win && event->xfocus.detail != NotifyPointer)
 421                 {
 422                     wxFocusEvent focusEvent(wxEVT_KILL_FOCUS, win->GetId());
 423                     focusEvent.SetEventObject(win);
 424                     win->ProcessEvent(focusEvent);
 425                 }
 426                 break;
 427             }
 428         default:
 429         {
 430             break;
 431         }
 432     }
 433 }
 434
 435 // Returns TRUE if more time is needed.
 436 // Note that this duplicates wxEventLoopImpl::SendIdleEvent
 437 // but ProcessIdle may be needed by apps, so is kept.
 438 bool wxApp::ProcessIdle()
 439 {
 440     wxIdleEvent event;
 441     event.SetEventObject(this);
 442     ProcessEvent(event);
 443
 444     return event.MoreRequested();
 445 }
 446
 447 void wxApp::ExitMainLoop()
 448 {
 449     if (m_mainLoop)
 450         m_mainLoop->Exit(0);
 451 }
 452
 453 // Is a message/event pending?
 454 bool wxApp::Pending()
 455 {
 456     return wxEventLoop::GetActive()->Pending();
 457 }
 458
 459 // Dispatch a message.
 460 void wxApp::Dispatch()
 461 {
 462     wxEventLoop::GetActive()->Dispatch();
 463 }
 464
 465 // This should be redefined in a derived class for
 466 // handling property change events for XAtom IPC.
 467 void wxApp::HandlePropertyChange(WXEvent *event)
 468 {
 469     // by default do nothing special
 470     // TODO: what to do for X11
 471     // XtDispatchEvent((XEvent*) event); /* let Motif do the work */
 472 }
 473
 474 void wxApp::OnIdle(wxIdleEvent& event)
 475 {
 476     static bool inOnIdle = FALSE;
 477
 478     // Avoid recursion (via ProcessEvent default case)
 479     if (inOnIdle)
 480         return;
 481
 482     inOnIdle = TRUE;
 483
 484     // If there are pending events, we must process them: pending events
 485     // are either events to the threads other than main or events posted
 486     // with wxPostEvent() functions
 487     // GRG: I have moved this here so that all pending events are processed
 488     //   before starting to delete any objects. This behaves better (in
 489     //   particular, wrt wxPostEvent) and is coherent with wxGTK's current
 490     //   behaviour. Also removed the '#if wxUSE_THREADS' around it.
 491     //  Changed Mar/2000 before 2.1.14
 492
 493     // Flush pending events.
 494     ProcessPendingEvents();
 495
 496     // 'Garbage' collection of windows deleted with Close().
 497     DeletePendingObjects();
 498
 499     // flush the logged messages if any
 500     wxLog *pLog = wxLog::GetActiveTarget();
 501     if ( pLog != NULL && pLog->HasPendingMessages() )
 502         pLog->Flush();
 503
 504     // Send OnIdle events to all windows
 505     bool needMore = SendIdleEvents();
 506
 507     if (needMore)
 508         event.RequestMore(TRUE);
 509
 510     inOnIdle = FALSE;
 511 }
 512
 513 void wxWakeUpIdle()
 514 {
 515     // **** please implement me! ****
 516     // Wake up the idle handler processor, even if it is in another thread...
 517 }
 518
 519
 520 // Send idle event to all top-level windows
 521 bool wxApp::SendIdleEvents()
 522 {
 523     bool needMore = FALSE;
 524
 525     wxWindowList::Node* node = wxTopLevelWindows.GetFirst();
 526     while (node)
 527     {
 528         wxWindow* win = node->GetData();
 529         if (SendIdleEvents(win))
 530             needMore = TRUE;
 531         node = node->GetNext();
 532     }
 533
 534     return needMore;
 535 }
 536
 537 // Send idle event to window and all subwindows
 538 bool wxApp::SendIdleEvents(wxWindow* win)
 539 {
 540     bool needMore = FALSE;
 541
 542     wxIdleEvent event;
 543     event.SetEventObject(win);
 544     win->ProcessEvent(event);
 545
 546     if (event.MoreRequested())
 547         needMore = TRUE;
 548
 549     wxNode* node = win->GetChildren().First();
 550     while (node)
 551     {
 552         wxWindow* win = (wxWindow*) node->Data();
 553         if (SendIdleEvents(win))
 554             needMore = TRUE;
 555
 556         node = node->Next();
 557     }
 558     return needMore ;
 559 }
 560
 561 void wxApp::DeletePendingObjects()
 562 {
 563     wxNode *node = wxPendingDelete.First();
 564     while (node)
 565     {
 566         wxObject *obj = (wxObject *)node->Data();
 567
 568         delete obj;
 569
 570         if (wxPendingDelete.Member(obj))
 571             delete node;
 572
 573         // Deleting one object may have deleted other pending
 574         // objects, so start from beginning of list again.
 575         node = wxPendingDelete.First();
 576     }
 577 }
 578
 579 // Create an application context
 580 bool wxApp::OnInitGui()
 581 {
 582     // TODO: parse argv and get display to pass to XOpenDisplay
 583     Display* dpy = XOpenDisplay(NULL);
 584     m_initialDisplay = (WXDisplay*) dpy;
 585
 586     if (!dpy) {
 587         wxString className(wxTheApp->GetClassName());
 588         wxLogError(_("wxWindows could not open display for '%s': exiting."),
 589             (const char*) className);
 590         exit(-1);
 591     }
 592     XSelectInput(m_initialDisplay,
 593         XDefaultRootWindow(m_initialDisplay),
 594         PropertyChangeMask);
 595
 596 #ifdef __WXDEBUG__
 597     // install the X error handler
 598     gs_pfnXErrorHandler = XSetErrorHandler(wxXErrorHandler);
 599 #endif // __WXDEBUG__
 600
 601     GetMainColormap(dpy);
 602     m_maxRequestSize = XMaxRequestSize((Display*) dpy);
 603
 604     return TRUE;
 605 }
 606
 607 WXColormap wxApp::GetMainColormap(WXDisplay* display)
 608 {
 609     if (!display) /* Must be called first with non-NULL display */
 610         return m_mainColormap;
 611
 612     int defaultScreen = DefaultScreen((Display*) display);
 613     Screen* screen = XScreenOfDisplay((Display*) display, defaultScreen);
 614
 615     Colormap c = DefaultColormapOfScreen(screen);
 616
 617     if (!m_mainColormap)
 618         m_mainColormap = (WXColormap) c;
 619
 620     return (WXColormap) c;
 621 }
 622
 623 static Window XGetParent(Window window)
 624 {
 625     Window parent, root = 0;
 626     unsigned int noChildren = 0;
 627     if (XQueryTree(wxGetDisplay(), window, & root, & parent,
 628         NULL, & noChildren))
 629         return parent;
 630     else
 631         return (Window) 0;
 632 }
 633
 634 // Returns TRUE if an accelerator has been processed
 635 bool wxApp::CheckForAccelerator(WXEvent* event)
 636 {
 637     XEvent* xEvent = (XEvent*) event;
 638     if (xEvent->xany.type == KeyPress)
 639     {
 640         // Find a wxWindow for this window
 641         // TODO: should get display for the window, not the current display
 642         Window window = xEvent->xany.window;
 643         wxWindow* win = NULL;
 644
 645         // Find the first wxWindow that corresponds to this event window
 646         while (window && !(win = wxGetWindowFromTable(window)))
 647             window = XGetParent(window);
 648
 649         if (!window || !win)
 650             return FALSE;
 651
 652         wxKeyEvent keyEvent(wxEVT_CHAR);
 653         wxTranslateKeyEvent(keyEvent, win, (Window) 0, xEvent);
 654
 655         // Now we have a wxKeyEvent and we have a wxWindow.
 656         // Go up the hierarchy until we find a matching accelerator,
 657         // or we get to the top.
 658         while (win)
 659         {
 660             if (win->ProcessAccelerator(keyEvent))
 661                 return TRUE;
 662             win = win->GetParent();
 663         }
 664         return FALSE;
 665     }
 666     return FALSE;
 667 }
 668
 669 void wxExit()
 670 {
 671     int retValue = 0;
 672     if (wxTheApp)
 673         retValue = wxTheApp->OnExit();
 674
 675     wxApp::CleanUp();
 676     /*
 677     * Exit in some platform-specific way. Not recommended that the app calls this:
 678     * only for emergencies.
 679     */
 680     exit(retValue);
 681 }
 682
 683 // Yield to other processes
 684
 685 bool wxApp::Yield(bool onlyIfNeeded)
 686 {
 687     bool s_inYield = FALSE;
 688
 689     if ( s_inYield )
 690     {
 691         if ( !onlyIfNeeded )
 692         {
 693             wxFAIL_MSG( wxT("wxYield called recursively" ) );
 694         }
 695
 696         return FALSE;
 697     }
 698
 699     s_inYield = TRUE;
 700
 701     while (wxTheApp && wxTheApp->Pending())
 702         wxTheApp->Dispatch();
 703
 704     s_inYield = FALSE;
 705
 706     return TRUE;
 707 }
 708
 709 // TODO use XmGetPixmap (?) to get the really standard icons!
 710
 711 // XPM hack: make the arrays const
 712 #define static static const
 713
 714 #include "wx/generic/info.xpm"
 715 #include "wx/generic/error.xpm"
 716 #include "wx/generic/question.xpm"
 717 #include "wx/generic/warning.xpm"
 718
 719 #undef static
 720
 721 wxIcon
 722 wxApp::GetStdIcon(int which) const
 723 {
 724     switch(which)
 725     {
 726         case wxICON_INFORMATION:
 727             return wxIcon(info_xpm);
 728
 729         case wxICON_QUESTION:
 730             return wxIcon(question_xpm);
 731
 732         case wxICON_EXCLAMATION:
 733             return wxIcon(warning_xpm);
 734
 735         default:
 736             wxFAIL_MSG("requested non existent standard icon");
 737             // still fall through
 738
 739         case wxICON_HAND:
 740             return wxIcon(error_xpm);
 741     }
 742 }
 743
 744 // ----------------------------------------------------------------------------
 745 // accessors for C modules
 746 // ----------------------------------------------------------------------------
 747
 748 #if 0
 749 extern "C" XtAppContext wxGetAppContext()
 750 {
 751     return (XtAppContext)wxTheApp->GetAppContext();
 752 }
 753 #endif