]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/appbase.cpp
Add class factories for filter streams. Also filters now follow the convention
[wxWidgets.git] / src / common / appbase.cpp
index 96eb54acc1bfef64dcb7d3c56e6fb23bb0edd642..697aa2dd87964aa0ba8ab533bce10eae39d1727d 100644 (file)
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        common/base/appbase.cpp
+// Name:        src/common/appbase.cpp
 // Purpose:     implements wxAppConsole class
 // Author:      Vadim Zeitlin
 // Modified by:
 #endif
 
 #ifndef WX_PRECOMP
+    #ifdef __WXMSW__
+        #include  "wx/msw/wrapwin.h"  // includes windows.h for MessageBox()
+    #endif
+    #include "wx/list.h"
     #include "wx/app.h"
     #include "wx/intl.h"
-    #include "wx/list.h"
-    #if wxUSE_LOG
-        #include "wx/log.h"
-    #endif // wxUSE_LOG
+    #include "wx/log.h"
+    #include "wx/utils.h"
 #endif //WX_PRECOMP
 
 #include "wx/apptrait.h"
 #include "wx/cmdline.h"
 #include "wx/confbase.h"
-#if wxUSE_FILENAME
-    #include "wx/filename.h"
-#endif // wxUSE_FILENAME
-#if wxUSE_FONTMAP
-    #include "wx/fontmap.h"
-#endif // wxUSE_FONTMAP
+#include "wx/filename.h"
 #include "wx/msgout.h"
 #include "wx/tokenzr.h"
 
   #include  <signal.h>      // for SIGTRAP used by wxTrap()
 #endif  //Win/Unix
 
-#if defined(__WXMSW__)
-  #include  "wx/msw/private.h"  // includes windows.h for MessageBox()
+#if wxUSE_FONTMAP
+    #include "wx/fontmap.h"
+#endif // wxUSE_FONTMAP
+
+#if defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
+    // For MacTypes.h for Debugger function
+    #include <CoreFoundation/CFBase.h>
 #endif
 
 #if defined(__WXMAC__)
-    // VZ: MacTypes.h is enough under Mac OS X (where I could test it) but
-    //     I don't know which headers are needed under earlier systems so
-    //     include everything when in doubt
     #ifdef __DARWIN__
-        #include  "MacTypes.h"
+        #include  <CoreServices/CoreServices.h>
     #else
         #include  "wx/mac/private.h"  // includes mac headers
     #endif
 #endif // __WXMAC__
 
+#ifdef __WXDEBUG__
+    #if wxUSE_STACKWALKER
+        #include "wx/stackwalk.h"
+        #ifdef __WXMSW__
+            #include "wx/msw/debughlp.h"
+        #endif
+    #endif // wxUSE_STACKWALKER
+#endif // __WXDEBUG__
+
+// wxABI_VERSION can be defined when compiling applications but it should be
+// left undefined when compiling the library itself, it is then set to its
+// default value in version.h
+#if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99
+#error "wxABI_VERSION should not be defined when compiling the library"
+#endif
+
 // ----------------------------------------------------------------------------
 // private functions prototypes
 // ----------------------------------------------------------------------------
@@ -77,6 +92,7 @@
     static
     void ShowAssertDialog(const wxChar *szFile,
                           int nLine,
+                          const wxChar *szFunc,
                           const wxChar *szCond,
                           const wxChar *szMsg,
                           wxAppTraits *traits = NULL);
 // global vars
 // ----------------------------------------------------------------------------
 
-wxApp *wxTheApp = NULL;
+wxAppConsole *wxAppConsole::ms_appInstance = NULL;
 
 wxAppInitializerFunction wxAppConsole::ms_appInitFn = NULL;
 
@@ -105,10 +121,17 @@ wxAppConsole::wxAppConsole()
 {
     m_traits = NULL;
 
-    wxTheApp = (wxApp *)this;
+    ms_appInstance = this;
 
 #ifdef __WXDEBUG__
     SetTraceMasks();
+#if wxUSE_UNICODE
+    // In unicode mode the SetTraceMasks call can cause an apptraits to be
+    // created, but since we are still in the constructor the wrong kind will
+    // be created for GUI apps.  Destroy it so it can be created again later.
+    delete m_traits;
+    m_traits = NULL;
+#endif
 #endif
 }
 
@@ -121,21 +144,19 @@ wxAppConsole::~wxAppConsole()
 // initilization/cleanup
 // ----------------------------------------------------------------------------
 
-bool wxAppConsole::Initialize(int& argc, wxChar **argv)
+bool wxAppConsole::Initialize(int& argcOrig, wxChar **argvOrig)
 {
     // remember the command line arguments
-    this->argc = argc;
-    this->argv = argv;
+    argc = argcOrig;
+    argv = argvOrig;
 
+#ifndef __WXPALMOS__
     if ( m_appName.empty() && argv )
     {
         // the application name is, by default, the name of its executable file
-#if wxUSE_FILENAME
         wxFileName::SplitPath(argv[0], NULL, &m_appName, NULL);
-#else // !wxUSE_FILENAME
-        m_appName = argv[0];
-#endif // wxUSE_FILENAME/!wxUSE_FILENAME
     }
+#endif
 
     return true;
 }
@@ -156,7 +177,7 @@ bool wxAppConsole::OnInit()
     OnInitCmdLine(parser);
 
     bool cont;
-    switch ( parser.Parse(FALSE /* don't show usage */) )
+    switch ( parser.Parse(false /* don't show usage */) )
     {
         case -1:
             cont = OnCmdLineHelp(parser);
@@ -172,10 +193,10 @@ bool wxAppConsole::OnInit()
     }
 
     if ( !cont )
-        return FALSE;
+        return false;
 #endif // wxUSE_CMDLINE_PARSER
 
-    return TRUE;
+    return true;
 }
 
 int wxAppConsole::OnExit()
@@ -186,14 +207,6 @@ int wxAppConsole::OnExit()
     delete wxConfigBase::Set((wxConfigBase *) NULL);
 #endif // wxUSE_CONFIG
 
-#ifdef __WXUNIVERSAL__
-    delete wxTheme::Set(NULL);
-#endif // __WXUNIVERSAL__
-
-    // use Set(NULL) and not Get() to avoid creating a message output object on
-    // demand when we just want to delete it
-    delete wxMessageOutput::Set(NULL);
-
     return 0;
 }
 
@@ -208,7 +221,7 @@ void wxAppConsole::Exit()
 
 wxAppTraits *wxAppConsole::CreateTraits()
 {
-    return wxAppTraits::CreateConsole();
+    return new wxConsoleAppTraits;
 }
 
 wxAppTraits *wxAppConsole::GetTraits()
@@ -251,6 +264,11 @@ wxMessageOutput *wxAppConsole::CreateMessageOutput()
 
 void wxAppConsole::ProcessPendingEvents()
 {
+#if wxUSE_THREADS
+    if ( !wxPendingEventsLocker )
+        return;
+#endif
+
     // ensure that we're the only thread to modify the pending events list
     wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 
@@ -261,19 +279,38 @@ void wxAppConsole::ProcessPendingEvents()
     }
 
     // iterate until the list becomes empty
-    wxNode *node = wxPendingEvents->GetFirst();
+    wxList::compatibility_iterator node = wxPendingEvents->GetFirst();
+    
+    while (node && 
+           ((wxEvtHandler *)node->GetData())->IsEventHandlingInProgress() &&
+           ((wxEvtHandler *)node->GetData())->IsReentranceAllowed() == false)
+    {   
+        // skip over event
+        node = node->GetNext();
+    }
+    
     while (node)
     {
         wxEvtHandler *handler = (wxEvtHandler *)node->GetData();
-        delete node;
+        wxPendingEvents->Erase(node);
 
         // In ProcessPendingEvents(), new handlers might be add
         // and we can safely leave the critical section here.
         wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
+
         handler->ProcessPendingEvents();
+
         wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 
         node = wxPendingEvents->GetFirst();
+        
+        while (node && 
+               ((wxEvtHandler *)node->GetData())->IsEventHandlingInProgress() &&
+               ((wxEvtHandler *)node->GetData())->IsReentranceAllowed() == false)
+        {   
+            // skip over event
+            node = node->GetNext();
+        }
     }
 
     wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
@@ -285,6 +322,23 @@ int wxAppConsole::FilterEvent(wxEvent& WXUNUSED(event))
     return -1;
 }
 
+// ----------------------------------------------------------------------------
+// exception handling
+// ----------------------------------------------------------------------------
+
+#if wxUSE_EXCEPTIONS
+
+void
+wxAppConsole::HandleEvent(wxEvtHandler *handler,
+                          wxEventFunction func,
+                          wxEvent& event) const
+{
+    // by default, simply call the handler
+    (handler->*func)(event);
+}
+
+#endif // wxUSE_EXCEPTIONS
+
 // ----------------------------------------------------------------------------
 // cmd line parsing
 // ----------------------------------------------------------------------------
@@ -292,8 +346,6 @@ int wxAppConsole::FilterEvent(wxEvent& WXUNUSED(event))
 #if wxUSE_CMDLINE_PARSER
 
 #define OPTION_VERBOSE _T("verbose")
-#define OPTION_THEME   _T("theme")
-#define OPTION_MODE    _T("mode")
 
 void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser)
 {
@@ -312,7 +364,7 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser)
 #if wxUSE_LOG
         {
             wxCMD_LINE_SWITCH,
-            _T(""),
+            wxEmptyString,
             OPTION_VERBOSE,
             gettext_noop("generate verbose log messages"),
             wxCMD_LINE_VAL_NONE,
@@ -320,37 +372,12 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser)
         },
 #endif // wxUSE_LOG
 
-#ifdef __WXUNIVERSAL__
-        {
-            wxCMD_LINE_OPTION,
-            _T(""),
-            OPTION_THEME,
-            gettext_noop("specify the theme to use"),
-            wxCMD_LINE_VAL_STRING,
-            0x0
-        },
-#endif // __WXUNIVERSAL__
-
-#if defined(__WXMGL__)
-        // VS: this is not specific to wxMGL, all fullscreen (framebuffer) ports
-        //     should provide this option. That's why it is in common/appcmn.cpp
-        //     and not mgl/app.cpp
-        {
-            wxCMD_LINE_OPTION,
-            _T(""),
-            OPTION_MODE,
-            gettext_noop("specify display mode to use (e.g. 640x480-16)"),
-            wxCMD_LINE_VAL_STRING,
-            0x0
-        },
-#endif // __WXMGL__
-
         // terminator
         {
             wxCMD_LINE_NONE,
-            _T(""),
-            _T(""),
-            _T(""),
+            wxEmptyString,
+            wxEmptyString,
+            wxEmptyString,
             wxCMD_LINE_VAL_NONE,
             0x0
         }
@@ -364,58 +391,27 @@ bool wxAppConsole::OnCmdLineParsed(wxCmdLineParser& parser)
 #if wxUSE_LOG
     if ( parser.Found(OPTION_VERBOSE) )
     {
-        wxLog::SetVerbose(TRUE);
+        wxLog::SetVerbose(true);
     }
+#else
+    wxUnusedVar(parser);
 #endif // wxUSE_LOG
 
-#ifdef __WXUNIVERSAL__
-    wxString themeName;
-    if ( parser.Found(OPTION_THEME, &themeName) )
-    {
-        wxTheme *theme = wxTheme::Create(themeName);
-        if ( !theme )
-        {
-            wxLogError(_("Unsupported theme '%s'."), themeName.c_str());
-            return FALSE;
-        }
-
-        // Delete the defaultly created theme and set the new theme.
-        delete wxTheme::Get();
-        wxTheme::Set(theme);
-    }
-#endif // __WXUNIVERSAL__
-
-#if defined(__WXMGL__)
-    wxString modeDesc;
-    if ( parser.Found(OPTION_MODE, &modeDesc) )
-    {
-        unsigned w, h, bpp;
-        if ( wxSscanf(modeDesc.c_str(), _T("%ux%u-%u"), &w, &h, &bpp) != 3 )
-        {
-            wxLogError(_("Invalid display mode specification '%s'."), modeDesc.c_str());
-            return FALSE;
-        }
-
-        if ( !SetDisplayMode(wxDisplayModeInfo(w, h, bpp)) )
-            return FALSE;
-    }
-#endif // __WXMGL__
-
-    return TRUE;
+    return true;
 }
 
 bool wxAppConsole::OnCmdLineHelp(wxCmdLineParser& parser)
 {
     parser.Usage();
 
-    return FALSE;
+    return false;
 }
 
 bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser)
 {
     parser.Usage();
 
-    return FALSE;
+    return false;
 }
 
 #endif // wxUSE_CMDLINE_PARSER
@@ -425,60 +421,64 @@ bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser)
 // ----------------------------------------------------------------------------
 
 /* static */
-bool wxAppConsole::CheckBuildOptions(const wxBuildOptions& opts)
+bool wxAppConsole::CheckBuildOptions(const char *optionsSignature,
+                                     const char *componentName)
 {
-#define wxCMP(what)   (what == opts.m_ ## what)
-
-    bool
-#ifdef __WXDEBUG__
-    isDebug = TRUE;
-#else
-    isDebug = FALSE;
+#if 0 // can't use wxLogTrace, not up and running yet
+    printf("checking build options object '%s' (ptr %p) in '%s'\n",
+             optionsSignature, optionsSignature, componentName);
 #endif
 
-    int verMaj = wxMAJOR_VERSION,
-        verMin = wxMINOR_VERSION;
-
-    if ( !(wxCMP(isDebug) && wxCMP(verMaj) && wxCMP(verMin)) )
+    if ( strcmp(optionsSignature, WX_BUILD_OPTIONS_SIGNATURE) != 0 )
     {
+        wxString lib = wxString::FromAscii(WX_BUILD_OPTIONS_SIGNATURE);
+        wxString prog = wxString::FromAscii(optionsSignature);
+        wxString progName = wxString::FromAscii(componentName);
         wxString msg;
-        wxString libDebug, progDebug;
 
-        if (isDebug)
-            libDebug = wxT("debug");
-        else
-            libDebug = wxT("no debug");
+        msg.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %s,\nand %s used %s."),
+                   lib.c_str(), progName.c_str(), prog.c_str());
 
-        if (opts.m_isDebug)
-            progDebug = wxT("debug");
-        else
-            progDebug = wxT("no debug");
-        
-        msg.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %d.%d (%s), and your program used %d.%d (%s)."),
-                   verMaj, verMin, libDebug.c_str(), opts.m_verMaj, opts.m_verMin, progDebug.c_str());
-        
-        wxLogFatalError(msg);
+        wxLogFatalError(msg.c_str());
 
         // normally wxLogFatalError doesn't return
-        return FALSE;
+        return false;
     }
 #undef wxCMP
 
-    return TRUE;
+    return true;
 }
 
 #ifdef __WXDEBUG__
 
+void wxAppConsole::OnAssertFailure(const wxChar *file,
+                                   int line,
+                                   const wxChar *func,
+                                   const wxChar *cond,
+                                   const wxChar *msg)
+{
+    ShowAssertDialog(file, line, func, cond, msg, GetTraits());
+}
+
 void wxAppConsole::OnAssert(const wxChar *file,
                             int line,
                             const wxChar *cond,
                             const wxChar *msg)
 {
-    ShowAssertDialog(file, line, cond, msg, m_traits);
+    OnAssertFailure(file, line, NULL, cond, msg);
 }
 
 #endif // __WXDEBUG__
 
+#if WXWIN_COMPATIBILITY_2_4
+
+bool wxAppConsole::CheckBuildOptions(const wxBuildOptions& buildOptions)
+{
+    return CheckBuildOptions(buildOptions.m_signature, "your program");
+}
+
+#endif
+
 // ============================================================================
 // other classes implementations
 // ============================================================================
@@ -510,6 +510,12 @@ wxFontMapper *wxConsoleAppTraitsBase::CreateFontMapper()
 
 #endif // wxUSE_FONTMAP
 
+wxRendererNative *wxConsoleAppTraitsBase::CreateRenderer()
+{
+    // console applications don't use renderers
+    return NULL;
+}
+
 #ifdef __WXDEBUG__
 bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString& msg)
 {
@@ -533,6 +539,13 @@ void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject * WXUNUSED(object)
     // nothing to do
 }
 
+#if wxUSE_SOCKETS
+GSocketGUIFunctionsTable* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable()
+{
+    return NULL;
+}
+#endif
+
 // ----------------------------------------------------------------------------
 // wxAppTraits
 // ----------------------------------------------------------------------------
@@ -546,11 +559,6 @@ bool wxAppTraitsBase::ShowAssertDialog(const wxString& msg)
 
 #endif // __WXDEBUG__
 
-wxAppTraits *wxAppTraitsBase::CreateConsole()
-{
-    return new wxConsoleAppTraits;
-}
-
 // ============================================================================
 // global functions implementation
 // ============================================================================
@@ -596,6 +604,8 @@ void wxTrap()
     #else
         SysBreak();
     #endif
+#elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
+    Debugger();
 #elif defined(__UNIX__)
     raise(SIGTRAP);
 #else
@@ -603,50 +613,44 @@ void wxTrap()
 #endif // Win/Unix
 }
 
-void wxAssert(int cond,
-              const wxChar *szFile,
-              int nLine,
-              const wxChar *szCond,
-              const wxChar *szMsg) 
-{
-    if ( !cond )
-        wxOnAssert(szFile, nLine, szCond, szMsg);
-}
-
 // this function is called when an assert fails
 void wxOnAssert(const wxChar *szFile,
                 int nLine,
+                const char *szFunc,
                 const wxChar *szCond,
                 const wxChar *szMsg)
 {
     // FIXME MT-unsafe
-    static bool s_bInAssert = FALSE;
+    static bool s_bInAssert = false;
 
     if ( s_bInAssert )
     {
         // He-e-e-e-elp!! we're trapped in endless loop
         wxTrap();
 
-        s_bInAssert = FALSE;
+        s_bInAssert = false;
 
         return;
     }
 
-    s_bInAssert = TRUE;
+    s_bInAssert = true;
+
+    // __FUNCTION__ is always in ASCII, convert it to wide char if needed
+    const wxString strFunc = wxString::FromAscii(szFunc);
 
     if ( !wxTheApp )
     {
         // by default, show the assert dialog box -- we can't customize this
         // behaviour
-        ShowAssertDialog(szFile, nLine, szCond, szMsg);
+        ShowAssertDialog(szFile, nLine, strFunc, szCond, szMsg);
     }
     else
     {
         // let the app process it as it wants
-        wxTheApp->OnAssert(szFile, nLine, szCond, szMsg);
+        wxTheApp->OnAssertFailure(szFile, nLine, strFunc, szCond, szMsg);
     }
 
-    s_bInAssert = FALSE;
+    s_bInAssert = false;
 }
 
 #endif // __WXDEBUG__
@@ -682,7 +686,7 @@ bool DoShowAssertDialog(const wxString& msg)
               wxT("You can also choose [Cancel] to suppress ")
               wxT("further warnings.");
 
-    switch ( ::MessageBox(NULL, msgDlg, _T("wxWindows Debug Alert"),
+    switch ( ::MessageBox(NULL, msgDlg, _T("wxWidgets Debug Alert"),
                           MB_YESNOCANCEL | MB_ICONSTOP ) )
     {
         case IDYES:
@@ -707,16 +711,79 @@ bool DoShowAssertDialog(const wxString& msg)
     return false;
 }
 
+#if wxUSE_STACKWALKER
+static wxString GetAssertStackTrace()
+{
+    wxString stackTrace;
+
+    class StackDump : public wxStackWalker
+    {
+    public:
+        StackDump() { }
+
+        const wxString& GetStackTrace() const { return m_stackTrace; }
+
+    protected:
+        virtual void OnStackFrame(const wxStackFrame& frame)
+        {
+            m_stackTrace << wxString::Format
+                            (
+                              _T("[%02d] "),
+                              wx_truncate_cast(int, frame.GetLevel())
+                            );
+
+            wxString name = frame.GetName();
+            if ( !name.empty() )
+            {
+                m_stackTrace << wxString::Format(_T("%-40s"), name.c_str());
+            }
+            else
+            {
+                m_stackTrace << wxString::Format(_T("%p"), frame.GetAddress());
+            }
+
+            if ( frame.HasSourceLocation() )
+            {
+                m_stackTrace << _T('\t')
+                             << frame.GetFileName()
+                             << _T(':')
+                             << frame.GetLine();
+            }
+
+            m_stackTrace << _T('\n');
+        }
+
+    private:
+        wxString m_stackTrace;
+    };
+
+    StackDump dump;
+    dump.Walk(2); // don't show OnAssert() call itself
+    stackTrace = dump.GetStackTrace();
+
+    // don't show more than maxLines or we could get a dialog too tall to be
+    // shown on screen: 20 should be ok everywhere as even with 15 pixel high
+    // characters it is still only 300 pixels...
+    static const int maxLines = 20;
+    const int count = stackTrace.Freq(wxT('\n'));
+    for ( int i = 0; i < count - maxLines; i++ )
+        stackTrace = stackTrace.BeforeLast(wxT('\n'));
+
+    return stackTrace;
+}
+#endif // wxUSE_STACKWALKER
+
 // show the assert modal dialog
 static
 void ShowAssertDialog(const wxChar *szFile,
                       int nLine,
+                      const wxChar *szFunc,
                       const wxChar *szCond,
                       const wxChar *szMsg,
                       wxAppTraits *traits)
 {
     // this variable can be set to true to suppress "assert failure" messages
-    static bool s_bNoAsserts = FALSE;
+    static bool s_bNoAsserts = false;
 
     wxString msg;
     msg.reserve(2048);
@@ -726,6 +793,11 @@ void ShowAssertDialog(const wxChar *szFile,
     // the failed assert
     msg.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile, nLine, szCond);
 
+    // add the function name, if any
+    if ( szFunc && *szFunc )
+        msg << _T(" in ") << szFunc << _T("()");
+
+    // and the message itself
     if ( szMsg )
     {
         msg << _T(": ") << szMsg;
@@ -735,6 +807,14 @@ void ShowAssertDialog(const wxChar *szFile,
         msg << _T('.');
     }
 
+#if wxUSE_STACKWALKER
+    const wxString stackTrace = GetAssertStackTrace();
+    if ( !stackTrace.empty() )
+    {
+        msg << _T("\n\nCall stack:\n") << stackTrace;
+    }
+#endif // wxUSE_STACKWALKER
+
 #if wxUSE_THREADS
     // if we are not in the main thread, output the assert directly and trap
     // since dialogs cannot be displayed
@@ -753,12 +833,13 @@ void ShowAssertDialog(const wxChar *szFile,
         // He-e-e-e-elp!! we're asserting in a child thread
         wxTrap();
     }
+    else
 #endif // wxUSE_THREADS
 
     if ( !s_bNoAsserts )
     {
         // send it to the normal log destination
-        wxLogDebug(_T("%s"), msg);
+        wxLogDebug(_T("%s"), msg.c_str());
 
         if ( traits )
         {
@@ -774,4 +855,3 @@ void ShowAssertDialog(const wxChar *szFile,
 }
 
 #endif // __WXDEBUG__
-