fix memory leak (coverity checker CID 53)

[wxWidgets.git] / src / common / appbase.cpp

diff --git a/src/common/appbase.cpp b/src/common/appbase.cpp
index 9b7e921da874a3499ae7fcc6711a71f48e67e467..fd408ab0d95aee5ac8c709687e25a03a0d68aa69 100644 (file)
--- a/src/common/appbase.cpp
+++ b/src/common/appbase.cpp
@@ -28,9 +28,7 @@
     #include "wx/app.h"
     #include "wx/intl.h"
     #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"

 #endif //WX_PRECOMP
 
 #include "wx/utils.h"
 #endif //WX_PRECOMP
 
 #include "wx/utils.h"


@@ -46,24 +44,42 @@
 #endif  //Win/Unix
 
 #if defined(__WXMSW__)
 #endif  //Win/Unix
 
 #if defined(__WXMSW__)

-  #include  "wx/msw/private.h"  // includes windows.h for MessageBox()
+  #include  "wx/msw/wrapwin.h"  // includes windows.h for MessageBox()

 #endif
 
 #if wxUSE_FONTMAP
     #include "wx/fontmap.h"
 #endif // wxUSE_FONTMAP
 
 #endif
 
 #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__)
 #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__
     #ifdef __DARWIN__

-        #include  "MacTypes.h"
+        #include  <CoreServices/CoreServices.h>

     #else
         #include  "wx/mac/private.h"  // includes mac headers
     #endif
 #endif // __WXMAC__
 
     #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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // private functions prototypes
 // ----------------------------------------------------------------------------


@@ -109,6 +125,13 @@ wxAppConsole::wxAppConsole()
 
 #ifdef __WXDEBUG__
     SetTraceMasks();
 
 #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
 }
 
 #endif
 }
 


@@ -121,17 +144,19 @@ wxAppConsole::~wxAppConsole()
 // initilization/cleanup
 // ----------------------------------------------------------------------------
 
 // initilization/cleanup
 // ----------------------------------------------------------------------------
 

-bool wxAppConsole::Initialize(int& argc, wxChar **argv)
+bool wxAppConsole::Initialize(int& argcOrig, wxChar **argvOrig)

 {
     // remember the command line arguments
 {
     // 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
         wxFileName::SplitPath(argv[0], NULL, &m_appName, NULL);
     }
     if ( m_appName.empty() && argv )
     {
         // the application name is, by default, the name of its executable file
         wxFileName::SplitPath(argv[0], NULL, &m_appName, NULL);
     }

+#endif

 
     return true;
 }
 
     return true;
 }


@@ -152,7 +177,7 @@ bool wxAppConsole::OnInit()
     OnInitCmdLine(parser);
 
     bool cont;
     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);
     {
         case -1:
             cont = OnCmdLineHelp(parser);


@@ -168,10 +193,10 @@ bool wxAppConsole::OnInit()
     }
 
     if ( !cont )
     }
 
     if ( !cont )

-        return FALSE;
+        return false;

 #endif // wxUSE_CMDLINE_PARSER
 
 #endif // wxUSE_CMDLINE_PARSER
 

-    return TRUE;
+    return true;

 }
 
 int wxAppConsole::OnExit()
 }
 
 int wxAppConsole::OnExit()


@@ -182,10 +207,6 @@ int wxAppConsole::OnExit()
     delete wxConfigBase::Set((wxConfigBase *) NULL);
 #endif // wxUSE_CONFIG
 
     delete wxConfigBase::Set((wxConfigBase *) NULL);
 #endif // wxUSE_CONFIG
 

-    // 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;
 }
 
     return 0;
 }
 


@@ -243,6 +264,11 @@ wxMessageOutput *wxAppConsole::CreateMessageOutput()
 
 void wxAppConsole::ProcessPendingEvents()
 {
 
 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 );
 
     // ensure that we're the only thread to modify the pending events list
     wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 


@@ -262,7 +288,9 @@ void wxAppConsole::ProcessPendingEvents()
         // In ProcessPendingEvents(), new handlers might be add
         // and we can safely leave the critical section here.
         wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
         // In ProcessPendingEvents(), new handlers might be add
         // and we can safely leave the critical section here.
         wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );

+        

         handler->ProcessPendingEvents();
         handler->ProcessPendingEvents();

+

         wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 
         node = wxPendingEvents->GetFirst();
         wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 
         node = wxPendingEvents->GetFirst();


@@ -277,6 +305,23 @@ int wxAppConsole::FilterEvent(wxEvent& WXUNUSED(event))
     return -1;
 }
 
     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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // cmd line parsing
 // ----------------------------------------------------------------------------


@@ -302,7 +347,7 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser)
 #if wxUSE_LOG
         {
             wxCMD_LINE_SWITCH,
 #if wxUSE_LOG
         {
             wxCMD_LINE_SWITCH,

-            _T(""),
+            wxEmptyString,

             OPTION_VERBOSE,
             gettext_noop("generate verbose log messages"),
             wxCMD_LINE_VAL_NONE,
             OPTION_VERBOSE,
             gettext_noop("generate verbose log messages"),
             wxCMD_LINE_VAL_NONE,


@@ -313,9 +358,9 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser)
         // terminator
         {
             wxCMD_LINE_NONE,
         // terminator
         {
             wxCMD_LINE_NONE,

-            _T(""),
-            _T(""),
-            _T(""),
+            wxEmptyString,
+            wxEmptyString,
+            wxEmptyString,

             wxCMD_LINE_VAL_NONE,
             0x0
         }
             wxCMD_LINE_VAL_NONE,
             0x0
         }


@@ -329,25 +374,27 @@ bool wxAppConsole::OnCmdLineParsed(wxCmdLineParser& parser)
 #if wxUSE_LOG
     if ( parser.Found(OPTION_VERBOSE) )
     {
 #if wxUSE_LOG
     if ( parser.Found(OPTION_VERBOSE) )
     {

-        wxLog::SetVerbose(TRUE);
+        wxLog::SetVerbose(true);

     }
     }

+#else
+    wxUnusedVar(parser);

 #endif // wxUSE_LOG
 
 #endif // wxUSE_LOG
 

-    return TRUE;
+    return true;

 }
 
 bool wxAppConsole::OnCmdLineHelp(wxCmdLineParser& parser)
 {
     parser.Usage();
 
 }
 
 bool wxAppConsole::OnCmdLineHelp(wxCmdLineParser& parser)
 {
     parser.Usage();
 

-    return FALSE;
+    return false;

 }
 
 bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser)
 {
     parser.Usage();
 
 }
 
 bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser)
 {
     parser.Usage();
 

-    return FALSE;
+    return false;

 }
 
 #endif // wxUSE_CMDLINE_PARSER
 }
 
 #endif // wxUSE_CMDLINE_PARSER


@@ -371,18 +418,18 @@ bool wxAppConsole::CheckBuildOptions(const char *optionsSignature,
         wxString prog = wxString::FromAscii(optionsSignature);
         wxString progName = wxString::FromAscii(componentName);
         wxString msg;
         wxString prog = wxString::FromAscii(optionsSignature);
         wxString progName = wxString::FromAscii(componentName);
         wxString msg;

-        
-        msg.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %s, and %s used %s."),
+
+        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());
                    lib.c_str(), progName.c_str(), prog.c_str());

-        
-        wxLogFatalError(msg);
+
+        wxLogFatalError(msg.c_str());

 
         // normally wxLogFatalError doesn't return
 
         // normally wxLogFatalError doesn't return

-        return FALSE;
+        return false;

     }
 #undef wxCMP
 
     }
 #undef wxCMP
 

-    return TRUE;
+    return true;

 }
 
 #ifdef __WXDEBUG__
 }
 
 #ifdef __WXDEBUG__


@@ -392,11 +439,20 @@ void wxAppConsole::OnAssert(const wxChar *file,
                             const wxChar *cond,
                             const wxChar *msg)
 {
                             const wxChar *cond,
                             const wxChar *msg)
 {

-    ShowAssertDialog(file, line, cond, msg, m_traits);
+    ShowAssertDialog(file, line, cond, msg, GetTraits());

 }
 
 #endif // __WXDEBUG__
 
 }
 
 #endif // __WXDEBUG__
 

+#if WXWIN_COMPATIBILITY_2_4
+
+bool wxAppConsole::CheckBuildOptions(const wxBuildOptions& buildOptions)
+{
+    return CheckBuildOptions(buildOptions.m_signature, "your program");
+}
+
+#endif
+

 // ============================================================================
 // other classes implementations
 // ============================================================================
 // ============================================================================
 // other classes implementations
 // ============================================================================


@@ -456,7 +512,7 @@ void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject * WXUNUSED(object)
 {
     // nothing to do
 }
 {
     // nothing to do
 }

-    
+

 #if wxUSE_SOCKETS
 GSocketGUIFunctionsTable* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable()
 {
 #if wxUSE_SOCKETS
 GSocketGUIFunctionsTable* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable()
 {


@@ -522,6 +578,8 @@ void wxTrap()
     #else
         SysBreak();
     #endif
     #else
         SysBreak();
     #endif

+#elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
+    Debugger();

 #elif defined(__UNIX__)
     raise(SIGTRAP);
 #else
 #elif defined(__UNIX__)
     raise(SIGTRAP);
 #else


@@ -533,7 +591,7 @@ void wxAssert(int cond,
               const wxChar *szFile,
               int nLine,
               const wxChar *szCond,
               const wxChar *szFile,
               int nLine,
               const wxChar *szCond,

-              const wxChar *szMsg) 
+              const wxChar *szMsg)

 {
     if ( !cond )
         wxOnAssert(szFile, nLine, szCond, szMsg);
 {
     if ( !cond )
         wxOnAssert(szFile, nLine, szCond, szMsg);


@@ -546,19 +604,19 @@ void wxOnAssert(const wxChar *szFile,
                 const wxChar *szMsg)
 {
     // FIXME MT-unsafe
                 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();
 
 
     if ( s_bInAssert )
     {
         // He-e-e-e-elp!! we're trapped in endless loop
         wxTrap();
 

-        s_bInAssert = FALSE;
+        s_bInAssert = false;

 
         return;
     }
 
 
         return;
     }
 

-    s_bInAssert = TRUE;
+    s_bInAssert = true;

 
     if ( !wxTheApp )
     {
 
     if ( !wxTheApp )
     {


@@ -572,7 +630,7 @@ void wxOnAssert(const wxChar *szFile,
         wxTheApp->OnAssert(szFile, nLine, szCond, szMsg);
     }
 
         wxTheApp->OnAssert(szFile, nLine, szCond, szMsg);
     }
 

-    s_bInAssert = FALSE;
+    s_bInAssert = false;

 }
 
 #endif // __WXDEBUG__
 }
 
 #endif // __WXDEBUG__


@@ -608,7 +666,7 @@ bool DoShowAssertDialog(const wxString& msg)
               wxT("You can also choose [Cancel] to suppress ")
               wxT("further warnings.");
 
               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:
                           MB_YESNOCANCEL | MB_ICONSTOP ) )
     {
         case IDYES:


@@ -633,6 +691,68 @@ bool DoShowAssertDialog(const wxString& msg)
     return false;
 }
 
     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(5); // 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,
 // show the assert modal dialog
 static
 void ShowAssertDialog(const wxChar *szFile,


@@ -642,7 +762,7 @@ void ShowAssertDialog(const wxChar *szFile,
                       wxAppTraits *traits)
 {
     // this variable can be set to true to suppress "assert failure" messages
                       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);
 
     wxString msg;
     msg.reserve(2048);


@@ -661,6 +781,14 @@ void ShowAssertDialog(const wxChar *szFile,
         msg << _T('.');
     }
 
         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
 #if wxUSE_THREADS
     // if we are not in the main thread, output the assert directly and trap
     // since dialogs cannot be displayed


@@ -679,6 +807,7 @@ void ShowAssertDialog(const wxChar *szFile,
         // He-e-e-e-elp!! we're asserting in a child thread
         wxTrap();
     }
         // He-e-e-e-elp!! we're asserting in a child thread
         wxTrap();
     }

+    else

 #endif // wxUSE_THREADS
 
     if ( !s_bNoAsserts )
 #endif // wxUSE_THREADS
 
     if ( !s_bNoAsserts )