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