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     switch (event->type)
 300     {
 301         case KeyPress:
 302         {
 303             if (win && !win->IsEnabled())
 304                 return;
 305
 306             {
 307                 if (win)
 308                 {
 309                     wxKeyEvent keyEvent(wxEVT_KEY_DOWN);
 310                     wxTranslateKeyEvent(keyEvent, win, window, event);
 311
 312                     // We didn't process wxEVT_KEY_DOWN, so send
 313                     // wxEVT_CHAR
 314                     if (!win->GetEventHandler()->ProcessEvent( keyEvent ))
 315                     {
 316                         keyEvent.SetEventType(wxEVT_CHAR);
 317                         win->GetEventHandler()->ProcessEvent( keyEvent );
 318                     }
 319
 320                     // We intercepted and processed the key down event
 321                     return;
 322                 }
 323             }
 324             return;
 325         }
 326         case KeyRelease:
 327         {
 328             if (win && !win->IsEnabled())
 329                 return;
 330
 331             if (win)
 332             {
 333                 wxKeyEvent keyEvent(wxEVT_KEY_UP);
 334                 wxTranslateKeyEvent(keyEvent, win, window, event);
 335
 336                 win->GetEventHandler()->ProcessEvent( keyEvent );
 337             }
 338             return;
 339         }
 340         case PropertyNotify:
 341         {
 342             HandlePropertyChange(_event);
 343             return;
 344         }
 345         case ClientMessage:
 346         {
 347             Atom wm_delete_window = XInternAtom(wxGlobalDisplay(), "WM_DELETE_WINDOW", True);;
 348             Atom wm_protocols = XInternAtom(wxGlobalDisplay(), "WM_PROTOCOLS", True);;
 349
 350             if (event->xclient.message_type == wm_protocols)
 351             {
 352                 if ((Atom) (event->xclient.data.l[0]) == wm_delete_window)
 353                 {
 354                     if (win)
 355                     {
 356                         win->Close(FALSE);
 357                     }
 358                 }
 359             }
 360             return;
 361         }
 362         case ResizeRequest:
 363         {
 364             /* Terry Gitnick <terryg@scientech.com> - 1/21/98
 365             * If resize event, don't resize until the last resize event for this
 366             * window is recieved. Prevents flicker as windows are resized.
 367             */
 368
 369             Display *disp = (Display*) wxGetDisplay();
 370             XEvent report;
 371
 372             //  to avoid flicker
 373             report = * event;
 374             while( XCheckTypedWindowEvent (disp, actualWindow, ResizeRequest, &report));
 375
 376             // TODO: when implementing refresh optimization, we can use
 377             // XtAddExposureToRegion to expand the window's paint region.
 378
 379             if (win)
 380             {
 381                 wxSize sz = win->GetSize();
 382                 wxSizeEvent sizeEvent(sz, win->GetId());
 383                 sizeEvent.SetEventObject(win);
 384
 385                 win->GetEventHandler()->ProcessEvent( sizeEvent );
 386             }
 387
 388             return;
 389         }
 390         case Expose:
 391         {
 392             if (win)
 393             {
 394                 win->GetUpdateRegion().Union( event->xexpose.x, event->xexpose.y,
 395                                               event->xexpose.width, event->xexpose.height);
 396                 if (event->xexpose.count == 0)
 397                 {
 398                     win->X11SendPaintEvents();  // TODO let an idle handler do that
 399                 }
 400             }
 401
 402             return;
 403         }
 404         case EnterNotify:
 405         case LeaveNotify:
 406         case ButtonPress:
 407         case ButtonRelease:
 408         case MotionNotify:
 409         {
 410             if (win && !win->IsEnabled())
 411                 return;
 412
 413             if (win)
 414             {
 415                 wxMouseEvent wxevent;
 416                 wxTranslateMouseEvent(wxevent, win, window, event);
 417                 win->GetEventHandler()->ProcessEvent( wxevent );
 418             }
 419             return;
 420         }
 421         case FocusIn:
 422             {
 423                 if (win && event->xfocus.detail != NotifyPointer)
 424                 {
 425                     wxFocusEvent focusEvent(wxEVT_SET_FOCUS, win->GetId());
 426                     focusEvent.SetEventObject(win);
 427                     win->GetEventHandler()->ProcessEvent(focusEvent);
 428                 }
 429                 break;
 430             }
 431         case FocusOut:
 432             {
 433                 if (win && event->xfocus.detail != NotifyPointer)
 434                 {
 435                     wxFocusEvent focusEvent(wxEVT_KILL_FOCUS, win->GetId());
 436                     focusEvent.SetEventObject(win);
 437                     win->GetEventHandler()->ProcessEvent(focusEvent);
 438                 }
 439                 break;
 440             }
 441         case DestroyNotify:
 442             {
 443                 // Do we want to process this (for top-level windows)?
 444                 // But we want to be able to veto closes, anyway
 445                 break;
 446             }
 447         default:
 448         {
 449             break;
 450         }
 451     }
 452 }
 453
 454 // Returns TRUE if more time is needed.
 455 // Note that this duplicates wxEventLoopImpl::SendIdleEvent
 456 // but ProcessIdle may be needed by apps, so is kept.
 457 bool wxApp::ProcessIdle()
 458 {
 459     wxIdleEvent event;
 460     event.SetEventObject(this);
 461     ProcessEvent(event);
 462
 463     return event.MoreRequested();
 464 }
 465
 466 void wxApp::ExitMainLoop()
 467 {
 468     if (m_mainLoop)
 469         m_mainLoop->Exit(0);
 470 }
 471
 472 // Is a message/event pending?
 473 bool wxApp::Pending()
 474 {
 475     return wxEventLoop::GetActive()->Pending();
 476 }
 477
 478 // Dispatch a message.
 479 void wxApp::Dispatch()
 480 {
 481     wxEventLoop::GetActive()->Dispatch();
 482 }
 483
 484 // This should be redefined in a derived class for
 485 // handling property change events for XAtom IPC.
 486 void wxApp::HandlePropertyChange(WXEvent *event)
 487 {
 488     // by default do nothing special
 489     // TODO: what to do for X11
 490     // XtDispatchEvent((XEvent*) event); /* let Motif do the work */
 491 }
 492
 493 void wxApp::OnIdle(wxIdleEvent& event)
 494 {
 495     static bool inOnIdle = FALSE;
 496
 497     // Avoid recursion (via ProcessEvent default case)
 498     if (inOnIdle)
 499         return;
 500
 501     inOnIdle = TRUE;
 502
 503     // If there are pending events, we must process them: pending events
 504     // are either events to the threads other than main or events posted
 505     // with wxPostEvent() functions
 506     // GRG: I have moved this here so that all pending events are processed
 507     //   before starting to delete any objects. This behaves better (in
 508     //   particular, wrt wxPostEvent) and is coherent with wxGTK's current
 509     //   behaviour. Also removed the '#if wxUSE_THREADS' around it.
 510     //  Changed Mar/2000 before 2.1.14
 511
 512     // Flush pending events.
 513     ProcessPendingEvents();
 514
 515     // 'Garbage' collection of windows deleted with Close().
 516     DeletePendingObjects();
 517
 518     // flush the logged messages if any
 519     wxLog *pLog = wxLog::GetActiveTarget();
 520     if ( pLog != NULL && pLog->HasPendingMessages() )
 521         pLog->Flush();
 522
 523     // Send OnIdle events to all windows
 524     bool needMore = SendIdleEvents();
 525
 526     if (needMore)
 527         event.RequestMore(TRUE);
 528
 529     inOnIdle = FALSE;
 530 }
 531
 532 void wxWakeUpIdle()
 533 {
 534     // **** please implement me! ****
 535     // Wake up the idle handler processor, even if it is in another thread...
 536 }
 537
 538
 539 // Send idle event to all top-level windows
 540 bool wxApp::SendIdleEvents()
 541 {
 542     bool needMore = FALSE;
 543
 544     wxWindowList::Node* node = wxTopLevelWindows.GetFirst();
 545     while (node)
 546     {
 547         wxWindow* win = node->GetData();
 548         if (SendIdleEvents(win))
 549             needMore = TRUE;
 550         node = node->GetNext();
 551     }
 552
 553     return needMore;
 554 }
 555
 556 // Send idle event to window and all subwindows
 557 bool wxApp::SendIdleEvents(wxWindow* win)
 558 {
 559     bool needMore = FALSE;
 560
 561     wxIdleEvent event;
 562     event.SetEventObject(win);
 563     win->ProcessEvent(event);
 564
 565     if (event.MoreRequested())
 566         needMore = TRUE;
 567
 568     wxNode* node = win->GetChildren().First();
 569     while (node)
 570     {
 571         wxWindow* win = (wxWindow*) node->Data();
 572         if (SendIdleEvents(win))
 573             needMore = TRUE;
 574
 575         node = node->Next();
 576     }
 577     return needMore ;
 578 }
 579
 580 void wxApp::DeletePendingObjects()
 581 {
 582     wxNode *node = wxPendingDelete.First();
 583     while (node)
 584     {
 585         wxObject *obj = (wxObject *)node->Data();
 586
 587         delete obj;
 588
 589         if (wxPendingDelete.Member(obj))
 590             delete node;
 591
 592         // Deleting one object may have deleted other pending
 593         // objects, so start from beginning of list again.
 594         node = wxPendingDelete.First();
 595     }
 596 }
 597
 598 // Create an application context
 599 bool wxApp::OnInitGui()
 600 {
 601     if (!wxAppBase::OnInitGui())
 602         return FALSE;
 603
 604     // TODO: parse argv and get display to pass to XOpenDisplay
 605     Display* dpy = XOpenDisplay(NULL);
 606     m_initialDisplay = (WXDisplay*) dpy;
 607
 608     if (!dpy) {
 609         wxString className(wxTheApp->GetClassName());
 610         wxLogError(_("wxWindows could not open display for '%s': exiting."),
 611             (const char*) className);
 612         exit(-1);
 613     }
 614     XSelectInput((Display*) m_initialDisplay,
 615         XDefaultRootWindow((Display*) m_initialDisplay),
 616         PropertyChangeMask);
 617
 618 #ifdef __WXDEBUG__
 619     // install the X error handler
 620     gs_pfnXErrorHandler = XSetErrorHandler(wxXErrorHandler);
 621 #endif // __WXDEBUG__
 622
 623     GetMainColormap(dpy);
 624     m_maxRequestSize = XMaxRequestSize((Display*) dpy);
 625
 626     return TRUE;
 627 }
 628
 629 WXColormap wxApp::GetMainColormap(WXDisplay* display)
 630 {
 631     if (!display) /* Must be called first with non-NULL display */
 632         return m_mainColormap;
 633
 634     int defaultScreen = DefaultScreen((Display*) display);
 635     Screen* screen = XScreenOfDisplay((Display*) display, defaultScreen);
 636
 637     Colormap c = DefaultColormapOfScreen(screen);
 638
 639     if (!m_mainColormap)
 640         m_mainColormap = (WXColormap) c;
 641
 642     return (WXColormap) c;
 643 }
 644
 645 Window wxGetWindowParent(Window window)
 646 {
 647     Window parent, root = 0;
 648     unsigned int noChildren = 0;
 649     Window* children = NULL;
 650     int res = XQueryTree((Display*) wxGetDisplay(), window, & root, & parent,
 651                          & children, & noChildren);
 652     if (children)
 653         XFree(children);
 654     if (res)
 655         return parent;
 656     else
 657         return (Window) 0;
 658 }
 659
 660 void wxExit()
 661 {
 662     int retValue = 0;
 663     if (wxTheApp)
 664         retValue = wxTheApp->OnExit();
 665
 666     wxApp::CleanUp();
 667     /*
 668     * Exit in some platform-specific way. Not recommended that the app calls this:
 669     * only for emergencies.
 670     */
 671     exit(retValue);
 672 }
 673
 674 // Yield to other processes
 675
 676 bool wxApp::Yield(bool onlyIfNeeded)
 677 {
 678     bool s_inYield = FALSE;
 679
 680     if ( s_inYield )
 681     {
 682         if ( !onlyIfNeeded )
 683         {
 684             wxFAIL_MSG( wxT("wxYield called recursively" ) );
 685         }
 686
 687         return FALSE;
 688     }
 689
 690     s_inYield = TRUE;
 691
 692     while (wxTheApp && wxTheApp->Pending())
 693         wxTheApp->Dispatch();
 694
 695     s_inYield = FALSE;
 696
 697     return TRUE;
 698 }
 699
 700 // TODO use XmGetPixmap (?) to get the really standard icons!
 701
 702 // XPM hack: make the arrays const
 703 #define static static const
 704
 705 #include "wx/generic/info.xpm"
 706 #include "wx/generic/error.xpm"
 707 #include "wx/generic/question.xpm"
 708 #include "wx/generic/warning.xpm"
 709
 710 #undef static
 711
 712 wxIcon
 713 wxApp::GetStdIcon(int which) const
 714 {
 715     switch(which)
 716     {
 717         case wxICON_INFORMATION:
 718             return wxIcon(info_xpm);
 719
 720         case wxICON_QUESTION:
 721             return wxIcon(question_xpm);
 722
 723         case wxICON_EXCLAMATION:
 724             return wxIcon(warning_xpm);
 725
 726         default:
 727             wxFAIL_MSG("requested non existent standard icon");
 728             // still fall through
 729
 730         case wxICON_HAND:
 731             return wxIcon(error_xpm);
 732     }
 733 }
 734
 735 // ----------------------------------------------------------------------------
 736 // accessors for C modules
 737 // ----------------------------------------------------------------------------
 738
 739 #if 0
 740 extern "C" XtAppContext wxGetAppContext()
 741 {
 742     return (XtAppContext)wxTheApp->GetAppContext();
 743 }
 744 #endif