X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8e40ed8535894eb47af679ad2b08e777c3605dd0..9ab7ff537d1ead0f0b07c14841474203c7fa59ba:/include/wx/app.h diff --git a/include/wx/app.h b/include/wx/app.h index 1a9a083f5e..965ffaf723 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -22,12 +22,12 @@ #include "wx/cmdargs.h" // for wxCmdLineArgsArray used by wxApp::argv #include "wx/init.h" // we must declare wxEntry() #include "wx/intl.h" // for wxLayoutDirection +#include "wx/log.h" // for wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD() class WXDLLIMPEXP_FWD_BASE wxAppConsole; class WXDLLIMPEXP_FWD_BASE wxAppTraits; class WXDLLIMPEXP_FWD_BASE wxCmdLineParser; class WXDLLIMPEXP_FWD_BASE wxEventLoopBase; -class WXDLLIMPEXP_FWD_BASE wxLog; class WXDLLIMPEXP_FWD_BASE wxMessageOutput; #if wxUSE_GUI @@ -35,6 +35,11 @@ class WXDLLIMPEXP_FWD_BASE wxMessageOutput; class WXDLLIMPEXP_FWD_CORE wxWindow; #endif +// this macro should be used in any main() or equivalent functions defined in wx +#define wxDISABLE_DEBUG_SUPPORT() \ + wxDISABLE_ASSERTS_IN_RELEASE_BUILD(); \ + wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD() + // ---------------------------------------------------------------------------- // typedefs // ---------------------------------------------------------------------------- @@ -52,6 +57,15 @@ enum wxPRINT_POSTSCRIPT = 2 }; +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +// use of this list is strongly deprecated, use wxApp ScheduleForDestruction() +// and IsScheduledForDestruction() methods instead of this list directly, it +// is here for compatibility purposes only +extern WXDLLIMPEXP_DATA_BASE(wxList) wxPendingDelete; + // ---------------------------------------------------------------------------- // wxAppConsoleBase: wxApp for non-GUI applications // ---------------------------------------------------------------------------- @@ -127,22 +141,17 @@ public: // be argv[0] // set/get the application name - wxString GetAppName() const - { - return m_appName.empty() ? m_className : m_appName; - } + wxString GetAppName() const; void SetAppName(const wxString& name) { m_appName = name; } // set/get the application display name: the display name is the name // shown to the user in titles, reports, etc while the app name is // used for paths, config, and other places the user doesn't see // - // so the app name could be myapp while display name could be "My App" - wxString GetAppDisplayName() const - { - return m_appDisplayName.empty() ? GetAppName().Capitalize() - : m_appDisplayName; - } + // by default the display name is the same as app name or a capitalized + // version of the program if app name was not set neither but it's + // usually better to set it explicitly to something nicer + wxString GetAppDisplayName() const; void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; } @@ -313,10 +322,34 @@ public: //to the list of the handlers with _delayed_ pending events void DelayPendingEventHandler(wxEvtHandler* toDelay); + // deletes the current pending events + void DeletePendingEvents(); + + + // delayed destruction + // ------------------- + + // If an object may have pending events for it, it shouldn't be deleted + // immediately as this would result in a crash when trying to handle these + // events: instead, it should be scheduled for destruction and really + // destroyed only after processing all pending events. + // + // Notice that this is only possible if we have a running event loop, + // otherwise the object is just deleted directly by ScheduleForDestruction() + // and IsScheduledForDestruction() always returns false. + + // schedule the object for destruction in the near future + void ScheduleForDestruction(wxObject *object); + + // return true if the object is scheduled for destruction + bool IsScheduledForDestruction(wxObject *object) const; + - // wxEventLoop redirections - // ------------------------ + // wxEventLoop-related methods + // --------------------------- + // all these functions are forwarded to the corresponding methods of the + // currently active event loop -- and do nothing if there is none virtual bool Pending(); virtual bool Dispatch(); @@ -326,13 +359,25 @@ public: bool Yield(bool onlyIfNeeded = false); virtual void WakeUpIdle(); + + // this method is called by the active event loop when there are no events + // to process + // + // by default it generates the idle events and if you override it in your + // derived class you should call the base class version to ensure that idle + // events are still sent out virtual bool ProcessIdle(); + // this virtual function is overridden in GUI wxApp to always return true + // as GUI applications always have an event loop -- but console ones may + // have it or not, so it simply returns true if already have an event loop + // running but false otherwise + virtual bool UsesEventLoop() const; + // debugging support // ----------------- -#ifdef __WXDEBUG__ // this function is called when an assert failure occurs, the base class // version does the normal processing (i.e. shows the usual assert failure // dialog box) @@ -352,7 +397,6 @@ public: int line, const wxChar *cond, const wxChar *msg); -#endif // __WXDEBUG__ // check that the wxBuildOptions object (constructed in the application // itself, usually the one from IMPLEMENT_APP() macro) matches the build @@ -391,6 +435,11 @@ public: #endif protected: + // delete all objects in wxPendingDelete list + // + // called from ProcessPendingEvents() + void DeletePendingObjects(); + // the function which creates the traits object when GetTraits() needs it // for the first time virtual wxAppTraits *CreateTraits(); @@ -420,11 +469,17 @@ protected: // been started yet or has already terminated) wxEventLoopBase *m_mainLoop; + + // pending events management vars: + // the array of the handlers with pending events which needs to be processed // inside ProcessPendingEvents() wxEvtHandlerArray m_handlersWithPendingEvents; - // helper array used by ProcessPendingEvents() + // helper array used by ProcessPendingEvents() to store the event handlers + // which have pending events but of these events none can be processed right now + // (because of a call to wxEventLoop::YieldFor() which asked to selectively process + // pending events) wxEvtHandlerArray m_handlersWithPendingDelayedEvents; #if wxUSE_THREADS @@ -432,6 +487,9 @@ protected: wxCriticalSection m_handlersWithPendingEventsLocker; #endif + // flag modified by Suspend/ResumeProcessingOfPendingEvents() + bool m_bDoPendingEventProcessing; + friend class WXDLLIMPEXP_FWD_BASE wxEvtHandler; // the application object is a singleton anyhow, there is no sense in @@ -508,6 +566,9 @@ public: // Returns true if more idle time is requested. virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event); + // override base class version: GUI apps always use an event loop + virtual bool UsesEventLoop() const { return true; } + // top level window functions // -------------------------- @@ -589,9 +650,6 @@ public: #endif // WXWIN_COMPATIBILITY_2_6 protected: - // delete all objects in wxPendingDelete list - void DeletePendingObjects(); - // override base class method to use GUI traits virtual wxAppTraits *CreateTraits(); @@ -719,8 +777,13 @@ public: // your compiler really, really wants main() to be in your main program (e.g. // hello.cpp). Now IMPLEMENT_APP should add this code if required. -#define IMPLEMENT_WXWIN_MAIN_CONSOLE \ - int main(int argc, char **argv) { return wxEntry(argc, argv); } +#define IMPLEMENT_WXWIN_MAIN_CONSOLE \ + int main(int argc, char **argv) \ + { \ + wxDISABLE_DEBUG_SUPPORT(); \ + \ + return wxEntry(argc, argv); \ + } // port-specific header could have defined it already in some special way #ifndef IMPLEMENT_WXWIN_MAIN