1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: common/base/appbase.cpp
3 // Purpose: implements wxAppConsole class
4 // Author: Vadim Zeitlin
6 // Created: 19.06.2003 (extracted from common/appcmn.cpp)
8 // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9 // License: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
35 #include "wx/apptrait.h"
36 #include "wx/cmdline.h"
37 #include "wx/confbase.h"
38 #include "wx/filename.h"
39 #include "wx/msgout.h"
40 #include "wx/tokenzr.h"
42 #if !defined(__WXMSW__) || defined(__WXMICROWIN__)
43 #include <signal.h> // for SIGTRAP used by wxTrap()
46 #if defined(__WXMSW__)
47 #include "wx/msw/wrapwin.h" // includes windows.h for MessageBox()
51 #include "wx/fontmap.h"
52 #endif // wxUSE_FONTMAP
54 #if defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
55 // For MacTypes.h for Debugger function
56 #include <CoreFoundation/CFBase.h>
59 #if defined(__WXMAC__)
61 #include <CoreServices/CoreServices.h>
63 #include "wx/mac/private.h" // includes mac headers
69 #include "wx/stackwalk.h"
71 #include "wx/msw/debughlp.h"
73 #endif // wxUSE_STACKWALKER
76 // wxABI_VERSION can be defined when compiling applications but it should be
77 // left undefined when compiling the library itself, it is then set to its
78 // default value in version.h
79 #if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99
80 #error "wxABI_VERSION should not be defined when compiling the library"
83 // ----------------------------------------------------------------------------
84 // private functions prototypes
85 // ----------------------------------------------------------------------------
88 // really just show the assert dialog
89 static bool DoShowAssertDialog(const wxString
& msg
);
91 // prepare for showing the assert dialog, use the given traits or
92 // DoShowAssertDialog() as last fallback to really show it
94 void ShowAssertDialog(const wxChar
*szFile
,
98 wxAppTraits
*traits
= NULL
);
100 // turn on the trace masks specified in the env variable WXTRACE
101 static void LINKAGEMODE
SetTraceMasks();
102 #endif // __WXDEBUG__
104 // ----------------------------------------------------------------------------
106 // ----------------------------------------------------------------------------
108 wxAppConsole
*wxAppConsole::ms_appInstance
= NULL
;
110 wxAppInitializerFunction
wxAppConsole::ms_appInitFn
= NULL
;
112 // ============================================================================
113 // wxAppConsole implementation
114 // ============================================================================
116 // ----------------------------------------------------------------------------
118 // ----------------------------------------------------------------------------
120 wxAppConsole::wxAppConsole()
124 ms_appInstance
= this;
129 // In unicode mode the SetTraceMasks call can cause an apptraits to be
130 // created, but since we are still in the constructor the wrong kind will
131 // be created for GUI apps. Destroy it so it can be created again later.
138 wxAppConsole::~wxAppConsole()
143 // ----------------------------------------------------------------------------
144 // initilization/cleanup
145 // ----------------------------------------------------------------------------
147 bool wxAppConsole::Initialize(int& argcOrig
, wxChar
**argvOrig
)
149 // remember the command line arguments
154 if ( m_appName
.empty() && argv
)
156 // the application name is, by default, the name of its executable file
157 wxFileName::SplitPath(argv
[0], NULL
, &m_appName
, NULL
);
164 void wxAppConsole::CleanUp()
168 // ----------------------------------------------------------------------------
170 // ----------------------------------------------------------------------------
172 bool wxAppConsole::OnInit()
174 #if wxUSE_CMDLINE_PARSER
175 wxCmdLineParser
parser(argc
, argv
);
177 OnInitCmdLine(parser
);
180 switch ( parser
.Parse(false /* don't show usage */) )
183 cont
= OnCmdLineHelp(parser
);
187 cont
= OnCmdLineParsed(parser
);
191 cont
= OnCmdLineError(parser
);
197 #endif // wxUSE_CMDLINE_PARSER
202 int wxAppConsole::OnExit()
205 // delete the config object if any (don't use Get() here, but Set()
206 // because Get() could create a new config object)
207 delete wxConfigBase::Set((wxConfigBase
*) NULL
);
208 #endif // wxUSE_CONFIG
213 void wxAppConsole::Exit()
218 // ----------------------------------------------------------------------------
220 // ----------------------------------------------------------------------------
222 wxAppTraits
*wxAppConsole::CreateTraits()
224 return new wxConsoleAppTraits
;
227 wxAppTraits
*wxAppConsole::GetTraits()
229 // FIXME-MT: protect this with a CS?
232 m_traits
= CreateTraits();
234 wxASSERT_MSG( m_traits
, _T("wxApp::CreateTraits() failed?") );
240 // we must implement CreateXXX() in wxApp itself for backwards compatibility
241 #if WXWIN_COMPATIBILITY_2_4
245 wxLog
*wxAppConsole::CreateLogTarget()
247 wxAppTraits
*traits
= GetTraits();
248 return traits
? traits
->CreateLogTarget() : NULL
;
253 wxMessageOutput
*wxAppConsole::CreateMessageOutput()
255 wxAppTraits
*traits
= GetTraits();
256 return traits
? traits
->CreateMessageOutput() : NULL
;
259 #endif // WXWIN_COMPATIBILITY_2_4
261 // ----------------------------------------------------------------------------
263 // ----------------------------------------------------------------------------
265 void wxAppConsole::ProcessPendingEvents()
268 if ( !wxPendingEventsLocker
)
272 // ensure that we're the only thread to modify the pending events list
273 wxENTER_CRIT_SECT( *wxPendingEventsLocker
);
275 if ( !wxPendingEvents
)
277 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker
);
281 // iterate until the list becomes empty
282 wxList::compatibility_iterator node
= wxPendingEvents
->GetFirst();
285 wxEvtHandler
*handler
= (wxEvtHandler
*)node
->GetData();
286 wxPendingEvents
->Erase(node
);
288 // In ProcessPendingEvents(), new handlers might be add
289 // and we can safely leave the critical section here.
290 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker
);
292 handler
->ProcessPendingEvents();
294 wxENTER_CRIT_SECT( *wxPendingEventsLocker
);
296 node
= wxPendingEvents
->GetFirst();
299 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker
);
302 int wxAppConsole::FilterEvent(wxEvent
& WXUNUSED(event
))
304 // process the events normally by default
308 // ----------------------------------------------------------------------------
309 // exception handling
310 // ----------------------------------------------------------------------------
315 wxAppConsole::HandleEvent(wxEvtHandler
*handler
,
316 wxEventFunction func
,
317 wxEvent
& event
) const
319 // by default, simply call the handler
320 (handler
->*func
)(event
);
323 #endif // wxUSE_EXCEPTIONS
325 // ----------------------------------------------------------------------------
327 // ----------------------------------------------------------------------------
329 #if wxUSE_CMDLINE_PARSER
331 #define OPTION_VERBOSE _T("verbose")
333 void wxAppConsole::OnInitCmdLine(wxCmdLineParser
& parser
)
335 // the standard command line options
336 static const wxCmdLineEntryDesc cmdLineDesc
[] =
342 gettext_noop("show this help message"),
344 wxCMD_LINE_OPTION_HELP
352 gettext_noop("generate verbose log messages"),
369 parser
.SetDesc(cmdLineDesc
);
372 bool wxAppConsole::OnCmdLineParsed(wxCmdLineParser
& parser
)
375 if ( parser
.Found(OPTION_VERBOSE
) )
377 wxLog::SetVerbose(true);
386 bool wxAppConsole::OnCmdLineHelp(wxCmdLineParser
& parser
)
393 bool wxAppConsole::OnCmdLineError(wxCmdLineParser
& parser
)
400 #endif // wxUSE_CMDLINE_PARSER
402 // ----------------------------------------------------------------------------
404 // ----------------------------------------------------------------------------
407 bool wxAppConsole::CheckBuildOptions(const char *optionsSignature
,
408 const char *componentName
)
410 #if 0 // can't use wxLogTrace, not up and running yet
411 printf("checking build options object '%s' (ptr %p) in '%s'\n",
412 optionsSignature
, optionsSignature
, componentName
);
415 if ( strcmp(optionsSignature
, WX_BUILD_OPTIONS_SIGNATURE
) != 0 )
417 wxString lib
= wxString::FromAscii(WX_BUILD_OPTIONS_SIGNATURE
);
418 wxString prog
= wxString::FromAscii(optionsSignature
);
419 wxString progName
= wxString::FromAscii(componentName
);
422 msg
.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %s,\nand %s used %s."),
423 lib
.c_str(), progName
.c_str(), prog
.c_str());
425 wxLogFatalError(msg
.c_str());
427 // normally wxLogFatalError doesn't return
437 void wxAppConsole::OnAssert(const wxChar
*file
,
442 ShowAssertDialog(file
, line
, cond
, msg
, GetTraits());
445 #endif // __WXDEBUG__
447 #if WXWIN_COMPATIBILITY_2_4
449 bool wxAppConsole::CheckBuildOptions(const wxBuildOptions
& buildOptions
)
451 return CheckBuildOptions(buildOptions
.m_signature
, "your program");
456 // ============================================================================
457 // other classes implementations
458 // ============================================================================
460 // ----------------------------------------------------------------------------
461 // wxConsoleAppTraitsBase
462 // ----------------------------------------------------------------------------
466 wxLog
*wxConsoleAppTraitsBase::CreateLogTarget()
468 return new wxLogStderr
;
473 wxMessageOutput
*wxConsoleAppTraitsBase::CreateMessageOutput()
475 return new wxMessageOutputStderr
;
480 wxFontMapper
*wxConsoleAppTraitsBase::CreateFontMapper()
482 return (wxFontMapper
*)new wxFontMapperBase
;
485 #endif // wxUSE_FONTMAP
487 wxRendererNative
*wxConsoleAppTraitsBase::CreateRenderer()
489 // console applications don't use renderers
494 bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString
& msg
)
496 return wxAppTraitsBase::ShowAssertDialog(msg
);
500 bool wxConsoleAppTraitsBase::HasStderr()
502 // console applications always have stderr, even under Mac/Windows
506 void wxConsoleAppTraitsBase::ScheduleForDestroy(wxObject
*object
)
511 void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject
* WXUNUSED(object
))
517 GSocketGUIFunctionsTable
* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable()
523 // ----------------------------------------------------------------------------
525 // ----------------------------------------------------------------------------
529 bool wxAppTraitsBase::ShowAssertDialog(const wxString
& msg
)
531 return DoShowAssertDialog(msg
);
534 #endif // __WXDEBUG__
536 // ============================================================================
537 // global functions implementation
538 // ============================================================================
548 // what else can we do?
557 wxTheApp
->WakeUpIdle();
559 //else: do nothing, what can we do?
565 bool wxAssertIsEqual(int x
, int y
)
570 // break into the debugger
573 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
575 #elif defined(__WXMAC__) && !defined(__DARWIN__)
581 #elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
583 #elif defined(__UNIX__)
590 void wxAssert(int cond
,
591 const wxChar
*szFile
,
593 const wxChar
*szCond
,
597 wxOnAssert(szFile
, nLine
, szCond
, szMsg
);
600 // this function is called when an assert fails
601 void wxOnAssert(const wxChar
*szFile
,
603 const wxChar
*szCond
,
607 static bool s_bInAssert
= false;
611 // He-e-e-e-elp!! we're trapped in endless loop
623 // by default, show the assert dialog box -- we can't customize this
625 ShowAssertDialog(szFile
, nLine
, szCond
, szMsg
);
629 // let the app process it as it wants
630 wxTheApp
->OnAssert(szFile
, nLine
, szCond
, szMsg
);
636 #endif // __WXDEBUG__
638 // ============================================================================
639 // private functions implementation
640 // ============================================================================
644 static void LINKAGEMODE
SetTraceMasks()
648 if ( wxGetEnv(wxT("WXTRACE"), &mask
) )
650 wxStringTokenizer
tkn(mask
, wxT(",;:"));
651 while ( tkn
.HasMoreTokens() )
652 wxLog::AddTraceMask(tkn
.GetNextToken());
657 bool DoShowAssertDialog(const wxString
& msg
)
659 // under MSW we can show the dialog even in the console mode
660 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
661 wxString
msgDlg(msg
);
663 // this message is intentionally not translated -- it is for
665 msgDlg
+= wxT("\nDo you want to stop the program?\n")
666 wxT("You can also choose [Cancel] to suppress ")
667 wxT("further warnings.");
669 switch ( ::MessageBox(NULL
, msgDlg
, _T("wxWidgets Debug Alert"),
670 MB_YESNOCANCEL
| MB_ICONSTOP
) )
680 //case IDNO: nothing to do
683 wxFprintf(stderr
, wxT("%s\n"), msg
.c_str());
686 // TODO: ask the user to enter "Y" or "N" on the console?
688 #endif // __WXMSW__/!__WXMSW__
690 // continue with the asserts
694 #if wxUSE_STACKWALKER
695 static wxString
GetAssertStackTrace()
699 class StackDump
: public wxStackWalker
704 const wxString
& GetStackTrace() const { return m_stackTrace
; }
707 virtual void OnStackFrame(const wxStackFrame
& frame
)
709 m_stackTrace
<< wxString::Format
712 wx_truncate_cast(int, frame
.GetLevel())
715 wxString name
= frame
.GetName();
718 m_stackTrace
<< wxString::Format(_T("%-40s"), name
.c_str());
722 m_stackTrace
<< wxString::Format(_T("%p"), frame
.GetAddress());
725 if ( frame
.HasSourceLocation() )
727 m_stackTrace
<< _T('\t')
728 << frame
.GetFileName()
733 m_stackTrace
<< _T('\n');
737 wxString m_stackTrace
;
741 dump
.Walk(5); // don't show OnAssert() call itself
742 stackTrace
= dump
.GetStackTrace();
744 // don't show more than maxLines or we could get a dialog too tall to be
745 // shown on screen: 20 should be ok everywhere as even with 15 pixel high
746 // characters it is still only 300 pixels...
747 static const int maxLines
= 20;
748 const int count
= stackTrace
.Freq(wxT('\n'));
749 for ( int i
= 0; i
< count
- maxLines
; i
++ )
750 stackTrace
= stackTrace
.BeforeLast(wxT('\n'));
754 #endif // wxUSE_STACKWALKER
756 // show the assert modal dialog
758 void ShowAssertDialog(const wxChar
*szFile
,
760 const wxChar
*szCond
,
764 // this variable can be set to true to suppress "assert failure" messages
765 static bool s_bNoAsserts
= false;
770 // make life easier for people using VC++ IDE by using this format: like
771 // this, clicking on the message will take us immediately to the place of
773 msg
.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile
, nLine
, szCond
);
777 msg
<< _T(": ") << szMsg
;
779 else // no message given
784 #if wxUSE_STACKWALKER
785 const wxString stackTrace
= GetAssertStackTrace();
786 if ( !stackTrace
.empty() )
788 msg
<< _T("\n\nCall stack:\n") << stackTrace
;
790 #endif // wxUSE_STACKWALKER
793 // if we are not in the main thread, output the assert directly and trap
794 // since dialogs cannot be displayed
795 if ( !wxThread::IsMain() )
797 msg
+= wxT(" [in child thread]");
799 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
801 OutputDebugString(msg
);
804 wxFprintf(stderr
, wxT("%s\n"), msg
.c_str());
807 // He-e-e-e-elp!! we're asserting in a child thread
811 #endif // wxUSE_THREADS
815 // send it to the normal log destination
816 wxLogDebug(_T("%s"), msg
.c_str());
820 // delegate showing assert dialog (if possible) to that class
821 s_bNoAsserts
= traits
->ShowAssertDialog(msg
);
823 else // no traits object
825 // fall back to the function of last resort
826 s_bNoAsserts
= DoShowAssertDialog(msg
);
831 #endif // __WXDEBUG__