1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/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"
29 #include "wx/msw/wrapwin.h" // includes windows.h for MessageBox()
38 #include "wx/apptrait.h"
39 #include "wx/cmdline.h"
40 #include "wx/confbase.h"
41 #include "wx/filename.h"
42 #include "wx/msgout.h"
43 #include "wx/tokenzr.h"
45 #if !defined(__WXMSW__) || defined(__WXMICROWIN__)
46 #include <signal.h> // for SIGTRAP used by wxTrap()
50 #include "wx/fontmap.h"
51 #endif // wxUSE_FONTMAP
53 #if defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
54 // For MacTypes.h for Debugger function
55 #include <CoreFoundation/CFBase.h>
58 #if defined(__WXMAC__)
60 #include <CoreServices/CoreServices.h>
62 #include "wx/mac/private.h" // includes mac headers
68 #include "wx/stackwalk.h"
70 #include "wx/msw/debughlp.h"
72 #endif // wxUSE_STACKWALKER
75 // wxABI_VERSION can be defined when compiling applications but it should be
76 // left undefined when compiling the library itself, it is then set to its
77 // default value in version.h
78 #if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99
79 #error "wxABI_VERSION should not be defined when compiling the library"
82 // ----------------------------------------------------------------------------
83 // private functions prototypes
84 // ----------------------------------------------------------------------------
87 // really just show the assert dialog
88 static bool DoShowAssertDialog(const wxString
& msg
);
90 // prepare for showing the assert dialog, use the given traits or
91 // DoShowAssertDialog() as last fallback to really show it
93 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::OnAssertFailure(const wxChar
*file
,
443 ShowAssertDialog(file
, line
, func
, cond
, msg
, GetTraits());
446 void wxAppConsole::OnAssert(const wxChar
*file
,
451 OnAssertFailure(file
, line
, NULL
, cond
, msg
);
454 #endif // __WXDEBUG__
456 #if WXWIN_COMPATIBILITY_2_4
458 bool wxAppConsole::CheckBuildOptions(const wxBuildOptions
& buildOptions
)
460 return CheckBuildOptions(buildOptions
.m_signature
, "your program");
465 // ============================================================================
466 // other classes implementations
467 // ============================================================================
469 // ----------------------------------------------------------------------------
470 // wxConsoleAppTraitsBase
471 // ----------------------------------------------------------------------------
475 wxLog
*wxConsoleAppTraitsBase::CreateLogTarget()
477 return new wxLogStderr
;
482 wxMessageOutput
*wxConsoleAppTraitsBase::CreateMessageOutput()
484 return new wxMessageOutputStderr
;
489 wxFontMapper
*wxConsoleAppTraitsBase::CreateFontMapper()
491 return (wxFontMapper
*)new wxFontMapperBase
;
494 #endif // wxUSE_FONTMAP
496 wxRendererNative
*wxConsoleAppTraitsBase::CreateRenderer()
498 // console applications don't use renderers
503 bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString
& msg
)
505 return wxAppTraitsBase::ShowAssertDialog(msg
);
509 bool wxConsoleAppTraitsBase::HasStderr()
511 // console applications always have stderr, even under Mac/Windows
515 void wxConsoleAppTraitsBase::ScheduleForDestroy(wxObject
*object
)
520 void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject
* WXUNUSED(object
))
526 GSocketGUIFunctionsTable
* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable()
532 // ----------------------------------------------------------------------------
534 // ----------------------------------------------------------------------------
538 bool wxAppTraitsBase::ShowAssertDialog(const wxString
& msgOriginal
)
540 wxString msg
= msgOriginal
;
542 #if wxUSE_STACKWALKER
543 #if !defined(__WXMSW__)
544 // on Unix stack frame generation may take some time, depending on the
545 // size of the executable mainly... warn the user that we are working
546 wxFprintf(stderr
, wxT("[Debug] Generating a stack trace... please wait"));
550 const wxString stackTrace
= GetAssertStackTrace();
551 if ( !stackTrace
.empty() )
552 msg
<< _T("\n\nCall stack:\n") << stackTrace
;
553 #endif // wxUSE_STACKWALKER
555 return DoShowAssertDialog(msg
);
558 #if wxUSE_STACKWALKER
559 wxString
wxAppTraitsBase::GetAssertStackTrace()
563 class StackDump
: public wxStackWalker
568 const wxString
& GetStackTrace() const { return m_stackTrace
; }
571 virtual void OnStackFrame(const wxStackFrame
& frame
)
573 m_stackTrace
<< wxString::Format
576 wx_truncate_cast(int, frame
.GetLevel())
579 wxString name
= frame
.GetName();
582 m_stackTrace
<< wxString::Format(_T("%-40s"), name
.c_str());
586 m_stackTrace
<< wxString::Format(_T("%p"), frame
.GetAddress());
589 if ( frame
.HasSourceLocation() )
591 m_stackTrace
<< _T('\t')
592 << frame
.GetFileName()
597 m_stackTrace
<< _T('\n');
601 wxString m_stackTrace
;
604 // don't show more than maxLines or we could get a dialog too tall to be
605 // shown on screen: 20 should be ok everywhere as even with 15 pixel high
606 // characters it is still only 300 pixels...
607 static const int maxLines
= 20;
610 dump
.Walk(2, maxLines
); // don't show OnAssert() call itself
611 stackTrace
= dump
.GetStackTrace();
613 const int count
= stackTrace
.Freq(wxT('\n'));
614 for ( int i
= 0; i
< count
- maxLines
; i
++ )
615 stackTrace
= stackTrace
.BeforeLast(wxT('\n'));
619 #endif // wxUSE_STACKWALKER
622 #endif // __WXDEBUG__
624 // ============================================================================
625 // global functions implementation
626 // ============================================================================
636 // what else can we do?
645 wxTheApp
->WakeUpIdle();
647 //else: do nothing, what can we do?
653 bool wxAssertIsEqual(int x
, int y
)
658 // break into the debugger
661 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
663 #elif defined(__WXMAC__) && !defined(__DARWIN__)
669 #elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
671 #elif defined(__UNIX__)
678 // this function is called when an assert fails
679 void wxOnAssert(const wxChar
*szFile
,
682 const wxChar
*szCond
,
686 static bool s_bInAssert
= false;
690 // He-e-e-e-elp!! we're trapped in endless loop
700 // __FUNCTION__ is always in ASCII, convert it to wide char if needed
701 const wxString strFunc
= wxString::FromAscii(szFunc
);
705 // by default, show the assert dialog box -- we can't customize this
707 ShowAssertDialog(szFile
, nLine
, strFunc
, szCond
, szMsg
);
711 // let the app process it as it wants
712 wxTheApp
->OnAssertFailure(szFile
, nLine
, strFunc
, szCond
, szMsg
);
718 #endif // __WXDEBUG__
720 // ============================================================================
721 // private functions implementation
722 // ============================================================================
726 static void LINKAGEMODE
SetTraceMasks()
730 if ( wxGetEnv(wxT("WXTRACE"), &mask
) )
732 wxStringTokenizer
tkn(mask
, wxT(",;:"));
733 while ( tkn
.HasMoreTokens() )
734 wxLog::AddTraceMask(tkn
.GetNextToken());
739 bool DoShowAssertDialog(const wxString
& msg
)
741 // under MSW we can show the dialog even in the console mode
742 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
743 wxString
msgDlg(msg
);
745 // this message is intentionally not translated -- it is for
747 msgDlg
+= wxT("\nDo you want to stop the program?\n")
748 wxT("You can also choose [Cancel] to suppress ")
749 wxT("further warnings.");
751 switch ( ::MessageBox(NULL
, msgDlg
, _T("wxWidgets Debug Alert"),
752 MB_YESNOCANCEL
| MB_ICONSTOP
) )
762 //case IDNO: nothing to do
765 wxFprintf(stderr
, wxT("%s\n"), msg
.c_str());
768 // TODO: ask the user to enter "Y" or "N" on the console?
770 #endif // __WXMSW__/!__WXMSW__
772 // continue with the asserts
776 // show the assert modal dialog
778 void ShowAssertDialog(const wxChar
*szFile
,
780 const wxChar
*szFunc
,
781 const wxChar
*szCond
,
785 // this variable can be set to true to suppress "assert failure" messages
786 static bool s_bNoAsserts
= false;
791 // make life easier for people using VC++ IDE by using this format: like
792 // this, clicking on the message will take us immediately to the place of
794 msg
.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile
, nLine
, szCond
);
796 // add the function name, if any
797 if ( szFunc
&& *szFunc
)
798 msg
<< _T(" in ") << szFunc
<< _T("()");
800 // and the message itself
803 msg
<< _T(": ") << szMsg
;
805 else // no message given
811 // if we are not in the main thread, output the assert directly and trap
812 // since dialogs cannot be displayed
813 if ( !wxThread::IsMain() )
815 msg
+= wxT(" [in child thread]");
817 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
819 OutputDebugString(msg
);
822 wxFprintf(stderr
, wxT("%s\n"), msg
.c_str());
825 // He-e-e-e-elp!! we're asserting in a child thread
829 #endif // wxUSE_THREADS
833 // send it to the normal log destination
834 wxLogDebug(_T("%s"), msg
.c_str());
838 // delegate showing assert dialog (if possible) to that class
839 s_bNoAsserts
= traits
->ShowAssertDialog(msg
);
841 else // no traits object
843 // fall back to the function of last resort
844 s_bNoAsserts
= DoShowAssertDialog(msg
);
849 #endif // __WXDEBUG__