implementation streamlined

[wxWidgets.git] / src / msw / main.cpp

diff --git a/src/msw/main.cpp b/src/msw/main.cpp
index 20a274a5dc2f72d9dc60563f86d8f18f19e8b212..712dc7234796d6488af22fc6b0f4f55f971ec508 100644 (file)
--- a/src/msw/main.cpp
+++ b/src/msw/main.cpp
@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -31,156 +27,379 @@
 #include "wx/event.h"
 #include "wx/app.h"
 #include "wx/cmdline.h"
 #include "wx/event.h"
 #include "wx/app.h"
 #include "wx/cmdline.h"

+#include "wx/scopeguard.h"

 
 #include "wx/msw/private.h"
 
 
 #include "wx/msw/private.h"
 

-// Don't implement WinMain if we're building an MFC/wxWindows hybrid app.
-#if wxUSE_MFC && !defined(NOMAIN)
-    #define NOMAIN 1
-#endif
+#if wxUSE_ON_FATAL_EXCEPTION
+    #include "wx/datetime.h"
+    #include "wx/msw/crashrpt.h"
+
+    #ifdef __VISUALC__
+        #include <eh.h>
+    #endif // __VISUALC__
+#endif // wxUSE_ON_FATAL_EXCEPTION
+
+#ifdef __WXWINCE__
+    // there is no ExitProcess() under CE but exiting the main thread has the
+    // same effect
+    #ifndef ExitProcess
+        #define ExitProcess ExitThread
+    #endif
+#endif // __WXWINCE__

 
 #ifdef __BORLANDC__
     // BC++ has to be special: its run-time expects the DLL entry point to be
     // named DllEntryPoint instead of the (more) standard DllMain
     #define DllMain DllEntryPoint
 
 #ifdef __BORLANDC__
     // BC++ has to be special: its run-time expects the DLL entry point to be
     // named DllEntryPoint instead of the (more) standard DllMain
     #define DllMain DllEntryPoint

-#endif
+#endif // __BORLANDC__

 
 #if defined(__WXMICROWIN__)
     #define HINSTANCE HANDLE
 #endif
 
 
 #if defined(__WXMICROWIN__)
     #define HINSTANCE HANDLE
 #endif
 

-#if wxUSE_GUI
-
-// ----------------------------------------------------------------------------
-// function prototypes
-// ----------------------------------------------------------------------------
-
-// from src/msw/app.cpp
-extern void WXDLLEXPORT wxEntryCleanup();
-
-static wxChar **ConvertToStandardCommandArgs(const wxChar *p, int& argc);
+// defined in common/init.cpp
+extern int wxEntryReal(int& argc, wxChar **argv);

 
 // ============================================================================
 // implementation: various entry points
 // ============================================================================
 
 
 // ============================================================================
 // implementation: various entry points
 // ============================================================================
 

+#if wxUSE_BASE
+
+#if wxUSE_ON_FATAL_EXCEPTION && defined(__VISUALC__) && !defined(__WXWINCE__)
+    // VC++ (at least from 4.0 up to version 7.1) is incredibly broken in that
+    // a "catch ( ... )" will *always* catch SEH exceptions in it even though
+    // it should have never been the case... to prevent such catches from
+    // stealing the exceptions from our wxGlobalSEHandler which is only called
+    // if the exception is not handled elsewhere, we have to also call it from
+    // a special SEH translator function which is called by VC CRT when a Win32
+    // exception occurs
+
+    // this warns that /EHa (async exceptions) should be used when using
+    // _set_se_translator but, in fact, this doesn't seem to change anything
+    // with VC++ up to 7.1 -- to be confirmed with VC++ 8
+    #if _MSC_VER <= 1310
+        #pragma warning(disable:4535)
+    #endif
+
+    // note that the SE translator must be called wxSETranslator!
+    #define DisableAutomaticSETranslator() _set_se_translator(wxSETranslator)
+#else // !__VISUALC__
+    #define DisableAutomaticSETranslator()
+#endif // __VISUALC__/!__VISUALC__
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// Windows-specific wxEntry
+// wrapper wxEntry catching all Win32 exceptions occurring in a wx program

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-int wxEntry(WXHINSTANCE hInstance,
-            WXHINSTANCE WXUNUSED(hPrevInstance),
-            char *pCmdLine,
-            int nCmdShow)
+// wrap real wxEntry in a try-except block to be able to call
+// OnFatalException() if necessary
+#if wxUSE_ON_FATAL_EXCEPTION
+
+// global pointer to exception information, only valid inside OnFatalException,
+// used by wxStackWalker and wxCrashReport
+extern EXCEPTION_POINTERS *wxGlobalSEInformation = NULL;
+
+// flag telling us whether the application wants to handle exceptions at all
+static bool gs_handleExceptions = false;
+
+static void wxFatalExit()

 {
 {

-    // remember the parameters Windows gave us
-    wxSetInstance((HINSTANCE)hInstance);
-    wxApp::m_nCmdShow = nCmdShow;
+    // use the same exit code as abort()
+    ::ExitProcess(3);
+}

 
 

-    // parse the command line
-    int argc;
-    wxChar **argv = ConvertToStandardCommandArgs(wxConvertMB2WX(pCmdLine), argc);
+unsigned long wxGlobalSEHandler(EXCEPTION_POINTERS *pExcPtrs)
+{
+    if ( gs_handleExceptions && wxTheApp )
+    {
+        // store the pointer to exception info
+        wxGlobalSEInformation = pExcPtrs;
+
+        // give the user a chance to do something special about this
+        __try
+        {
+            wxTheApp->OnFatalException();
+        }
+        __except ( EXCEPTION_EXECUTE_HANDLER )
+        {
+            // nothing to do here, just ignore the exception inside the
+            // exception handler
+            ;
+        }
+
+        wxGlobalSEInformation = NULL;
+
+        // this will execute our handler and terminate the process
+        return EXCEPTION_EXECUTE_HANDLER;
+    }

 
 

-    return wxEntry(argc, argv);
+    return EXCEPTION_CONTINUE_SEARCH;

 }
 
 }
 

-// May wish not to have a DllMain or WinMain, e.g. if we're programming
-// a Netscape plugin or if we're writing a console application
-#if !defined(NOMAIN)
+#ifdef __VISUALC__

 
 

-extern "C"
+static void wxSETranslator(unsigned int WXUNUSED(code), EXCEPTION_POINTERS *ep)

 {
 {

+    switch ( wxGlobalSEHandler(ep) )
+    {
+        default:
+            wxFAIL_MSG( _T("unexpected wxGlobalSEHandler() return value") );
+            // fall through

 
 

-// ----------------------------------------------------------------------------
-// WinMain
-// ----------------------------------------------------------------------------
+        case EXCEPTION_EXECUTE_HANDLER:
+            // if wxApp::OnFatalException() had been called we should exit the
+            // application -- but we shouldn't kill our host when we're a DLL
+#ifndef WXMAKINGDLL
+            wxFatalExit();
+#endif // not a DLL
+            break;

 
 

-// Note that WinMain is also defined in dummy.obj, which is linked to
-// an application that is using the DLL version of wxWindows.
+        case EXCEPTION_CONTINUE_SEARCH:
+            // we're called for each "catch ( ... )" and if we (re)throw from
+            // here, the catch handler body is not executed, so the effect is
+            // as if had inhibited translation of SE to C++ ones because the
+            // handler will never see any structured exceptions
+            throw;
+    }
+}

 
 

-#if !defined(_WINDLL)
+#endif // __VISUALC__

 
 

-int PASCAL WinMain(HINSTANCE hInstance,
-                   HINSTANCE hPrevInstance,
-                   LPSTR lpCmdLine,
-                   int nCmdShow)
+bool wxHandleFatalExceptions(bool doit)

 {
 {

-    return wxEntry((WXHINSTANCE) hInstance,
-                   (WXHINSTANCE) hPrevInstance,
-                   lpCmdLine,
-                   nCmdShow);
-}
+    // assume this can only be called from the main thread
+    gs_handleExceptions = doit;

 
 

-#else // _WINDLL
+#if wxUSE_CRASHREPORT
+    if ( doit )
+    {
+        // try to find a place where we can put out report file later
+        wxChar fullname[MAX_PATH];
+        if ( !::GetTempPath(WXSIZEOF(fullname), fullname) )
+        {
+            wxLogLastError(_T("GetTempPath"));
+
+            // when all else fails...
+            wxStrcpy(fullname, _T("c:\\"));
+        }
+
+        // use PID and date to make the report file name more unique
+        wxString name = wxString::Format
+                        (
+                            _T("%s_%s_%lu.dmp"),
+                            wxTheApp ? wxTheApp->GetAppName().c_str()
+                                     : _T("wxwindows"),
+                            wxDateTime::Now().Format(_T("%Y%m%dT%H%M%S")).c_str(),
+                            ::GetCurrentProcessId()
+                        );
+
+        wxStrncat(fullname, name, WXSIZEOF(fullname) - wxStrlen(fullname) - 1);
+
+        wxCrashReport::SetFileName(fullname);
+    }
+#endif // wxUSE_CRASHREPORT

 
 

-// DLL entry point
+    return true;
+}

 
 

-BOOL WINAPI
-DllMain(HANDLE hModule, DWORD fdwReason, LPVOID WXUNUSED(lpReserved))
+int wxEntry(int& argc, wxChar **argv)

 {
 {

-    // Only call wxEntry if the application itself is part of the DLL.
-    // If only the wxWindows library is in the DLL, then the
-    // initialisation will be called when the application implicitly
-    // calls WinMain.
-#ifndef WXMAKINGDLL
-    switch (fdwReason)
+    DisableAutomaticSETranslator();
+
+    __try
+    {
+        return wxEntryReal(argc, argv);
+    }
+    __except ( wxGlobalSEHandler(GetExceptionInformation()) )

     {
     {

-        case DLL_PROCESS_ATTACH:
-            return wxEntry((WXHINSTANCE) hModule);
+        wxFatalExit();

 
 

-        case DLL_PROCESS_DETACH:
-            wxEntryCleanup();
-            break;
+#if !defined(_MSC_VER) || defined(__WXDEBUG__) || (defined(_MSC_VER) && _MSC_VER <= 1200)
+        // this code is unreachable but put it here to suppress warnings in some compilers
+        // and disable for others to supress warnings too
+        return -1;
+#endif // !__VISUALC__ in release build
+    }
+}
+
+#else // !wxUSE_ON_FATAL_EXCEPTION
+
+#if defined(__VISUALC__) && !defined(__WXWINCE__)
+
+static void
+wxSETranslator(unsigned int WXUNUSED(code), EXCEPTION_POINTERS * WXUNUSED(ep))
+{
+    // see wxSETranslator() version for wxUSE_ON_FATAL_EXCEPTION above
+    throw;
+}
+
+#endif // __VISUALC__
+
+int wxEntry(int& argc, wxChar **argv)
+{
+    DisableAutomaticSETranslator();
+
+    return wxEntryReal(argc, argv);
+}
+
+#endif // wxUSE_ON_FATAL_EXCEPTION/!wxUSE_ON_FATAL_EXCEPTION
+
+#endif // wxUSE_BASE
+
+#if wxUSE_GUI && defined(__WXMSW__)
+
+#if wxUSE_UNICODE && !defined(__WXWINCE__)
+    #define NEED_UNICODE_CHECK
+#endif
+
+#ifdef NEED_UNICODE_CHECK
+
+// check whether Unicode is available
+static bool wxIsUnicodeAvailable()
+{
+    static const wchar_t *ERROR_STRING = L"wxWidgets Fatal Error";
+
+    if ( wxGetOsVersion() != wxWINDOWS_NT )
+    {
+        // we need to be built with MSLU support
+#if !wxUSE_UNICODE_MSLU 
+        // note that we can use MessageBoxW() as it's implemented even under
+        // Win9x - OTOH, we can't use wxGetTranslation() because the file APIs
+        // used by wxLocale are not
+        ::MessageBox
+        (
+         NULL,
+         L"This program uses Unicode and requires Windows NT/2000/XP.\n"
+         L"\n"
+         L"Program aborted.",
+         ERROR_STRING,
+         MB_ICONERROR | MB_OK
+        );
+
+        return false;
+#else // wxUSE_UNICODE_MSLU
+        // and the MSLU DLL must also be available
+        HMODULE hmod = ::LoadLibraryA("unicows.dll");
+        if ( !hmod )
+        {
+            ::MessageBox
+            (
+             NULL,
+             L"This program uses Unicode and requires unicows.dll to work "
+             L"under current operating system.\n"
+             L"\n"
+             L"Please install unicows.dll and relaunch the program.",
+             ERROR_STRING,
+             MB_ICONERROR | MB_OK
+            );
+            return false;
+        }
+
+        // this is not really necessary but be tidy
+        ::FreeLibrary(hmod);
+
+        // finally do the last check: has unicows.lib initialized correctly?
+        hmod = ::LoadLibraryW(L"unicows.dll");
+        if ( !hmod )
+        {
+            ::MessageBox
+            (
+             NULL,
+             L"This program uses Unicode but is not using unicows.dll\n"
+             L"correctly and so cannot work under current operating system.\n"
+             L"Please contact the program author for an updated version.\n"
+             L"\n"
+             L"Program aborted.",
+             ERROR_STRING,
+             MB_ICONERROR | MB_OK
+            );
+
+            return false;
+        }
+
+        ::FreeLibrary(hmod);
+#endif // !wxUSE_UNICODE_MSLU

     }
     }

-#else
-       (void)hModule;
-       (void)fdwReason;
-#endif // !WXMAKINGDLL

 
 

-    return TRUE;
+    return true;

 }
 
 }
 

-#endif // _WINDLL/!_WINDLL
+#endif // NEED_UNICODE_CHECK

 
 

-} // extern "C"
+// ----------------------------------------------------------------------------
+// Windows-specific wxEntry
+// ----------------------------------------------------------------------------

 
 

-#endif // !NOMAIN
+// helper function used to clean up in wxEntry() just below
+//
+// notice that argv elements are supposed to be allocated using malloc() while
+// argv array itself is allocated with new
+static void wxFreeArgs(int argc, wxChar **argv)
+{
+    for ( int i = 0; i < argc; i++ )
+    {
+        free(argv[i]);
+    }

 
 

-// ---------------------------------------------------------------------------
-// Convert Windows to argc, argv style
-// ---------------------------------------------------------------------------
+    delete [] argv;
+}

 
 

-wxChar **ConvertToStandardCommandArgs(const wxChar *p, int& argc)
+WXDLLEXPORT int wxEntry(HINSTANCE hInstance,
+                        HINSTANCE WXUNUSED(hPrevInstance),
+                        wxCmdLineArgType WXUNUSED(pCmdLine),
+                        int nCmdShow)

 {
 {

+    // the first thing to do is to check if we're trying to run an Unicode
+    // program under Win9x w/o MSLU emulation layer - if so, abort right now
+    // as it has no chance to work and has all chances to crash
+#ifdef NEED_UNICODE_CHECK
+    if ( !wxIsUnicodeAvailable() )
+        return -1;
+#endif // NEED_UNICODE_CHECK
+
+
+    // remember the parameters Windows gave us
+    wxSetInstance(hInstance);
+    wxApp::m_nCmdShow = nCmdShow;
+
+    // parse the command line: we can't use pCmdLine in Unicode build so it is
+    // simpler to never use it at all (this also results in a more correct
+    // argv[0])
+

     // break the command line in words
     wxArrayString args;
     // break the command line in words
     wxArrayString args;

-    if ( p )
+
+    const wxChar *cmdLine = ::GetCommandLine();
+    if ( cmdLine )

     {
     {

-        args = wxCmdLineParser::ConvertStringToArgs(p);
+        args = wxCmdLineParser::ConvertStringToArgs(cmdLine);

     }
 
     }
 

-    // +1 here for the program name
-    argc = args.GetCount() + 1;
-
-    // and +1 here for the terminating NULL
-    wxChar **argv = new wxChar *[argc + 1];
+#ifdef __WXWINCE__
+    // WinCE doesn't insert the program itself, so do it ourselves.
+    args.Insert(wxGetFullModuleName(), 0);
+#endif

 
 

-    argv[0] = new wxChar[MAX_PATH];
-    ::GetModuleFileName(wxhInstance, argv[0], MAX_PATH);
+    int argc = args.GetCount();

 
 

-    // copy all the other arguments to wxApp::argv[]
-    for ( int i = 1; i < argc; i++ )
+    // +1 here for the terminating NULL
+    wxChar **argv = new wxChar *[argc + 1];
+    for ( int i = 0; i < argc; i++ )

     {
     {

-        argv[i] = wxStrdup(args[i - 1]);
+        argv[i] = wxStrdup(args[i]);

     }
 
     // argv[] must be NULL-terminated
     argv[argc] = NULL;
 
     }
 
     // argv[] must be NULL-terminated
     argv[argc] = NULL;
 

-    return argv;
+    wxON_BLOCK_EXIT2(wxFreeArgs, argc, argv);
+
+    return wxEntry(argc, argv);

 }
 
 }
 

-#endif // wxUSE_GUI
+#endif // wxUSE_GUI && __WXMSW__

 
 // ----------------------------------------------------------------------------
 // global HINSTANCE
 
 // ----------------------------------------------------------------------------
 // global HINSTANCE


@@ -190,7 +409,7 @@ wxChar **ConvertToStandardCommandArgs(const wxChar *p, int& argc)
 
 HINSTANCE wxhInstance = 0;
 
 
 HINSTANCE wxhInstance = 0;
 

-HINSTANCE wxGetInstance()
+extern "C" HINSTANCE wxGetInstance()

 {
     return wxhInstance;
 }
 {
     return wxhInstance;
 }