src/common/appbase.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/appbase.cpp
   3 // Purpose:     implements wxAppConsoleBase class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     19.06.2003 (extracted from common/appcmn.cpp)
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
   9 // License:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // for compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #ifndef WX_PRECOMP
  28     #ifdef __WXMSW__
  29         #include  "wx/msw/wrapwin.h"  // includes windows.h for MessageBox()
  30     #endif
  31     #include "wx/list.h"
  32     #include "wx/app.h"
  33     #include "wx/intl.h"
  34     #include "wx/log.h"
  35     #include "wx/utils.h"
  36     #include "wx/wxcrtvararg.h"
  37 #endif //WX_PRECOMP
  38
  39 #include "wx/apptrait.h"
  40 #include "wx/cmdline.h"
  41 #include "wx/confbase.h"
  42 #include "wx/evtloop.h"
  43 #include "wx/filename.h"
  44 #include "wx/msgout.h"
  45 #include "wx/ptr_scpd.h"
  46 #include "wx/tokenzr.h"
  47 #include "wx/thread.h"
  48
  49 #if wxUSE_EXCEPTIONS && wxUSE_STL
  50     #include <exception>
  51     #include <typeinfo>
  52 #endif
  53
  54 #if !defined(__WXMSW__) || defined(__WXMICROWIN__)
  55   #include  <signal.h>      // for SIGTRAP used by wxTrap()
  56 #endif  //Win/Unix
  57
  58 #include <locale.h>
  59
  60 #if wxUSE_FONTMAP
  61     #include "wx/fontmap.h"
  62 #endif // wxUSE_FONTMAP
  63
  64 #if defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
  65     // For MacTypes.h for Debugger function
  66     #include <CoreFoundation/CFBase.h>
  67 #endif
  68
  69 #if defined(__WXMAC__)
  70     #ifdef __DARWIN__
  71         #include  <CoreServices/CoreServices.h>
  72     #else
  73         #include  "wx/mac/private.h"  // includes mac headers
  74     #endif
  75 #endif // __WXMAC__
  76
  77 #ifdef __WXDEBUG__
  78     #if wxUSE_STACKWALKER
  79         #include "wx/stackwalk.h"
  80         #ifdef __WXMSW__
  81             #include "wx/msw/debughlp.h"
  82         #endif
  83     #endif // wxUSE_STACKWALKER
  84 #endif // __WXDEBUG__
  85
  86 // wxABI_VERSION can be defined when compiling applications but it should be
  87 // left undefined when compiling the library itself, it is then set to its
  88 // default value in version.h
  89 #if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99
  90 #error "wxABI_VERSION should not be defined when compiling the library"
  91 #endif
  92
  93 // ----------------------------------------------------------------------------
  94 // private functions prototypes
  95 // ----------------------------------------------------------------------------
  96
  97 #ifdef __WXDEBUG__
  98     // really just show the assert dialog
  99     static bool DoShowAssertDialog(const wxString& msg);
 100
 101     // prepare for showing the assert dialog, use the given traits or
 102     // DoShowAssertDialog() as last fallback to really show it
 103     static
 104     void ShowAssertDialog(const wxString& szFile,
 105                           int nLine,
 106                           const wxString& szFunc,
 107                           const wxString& szCond,
 108                           const wxString& szMsg,
 109                           wxAppTraits *traits = NULL);
 110
 111     // turn on the trace masks specified in the env variable WXTRACE
 112     static void LINKAGEMODE SetTraceMasks();
 113 #endif // __WXDEBUG__
 114
 115 // ----------------------------------------------------------------------------
 116 // global vars
 117 // ----------------------------------------------------------------------------
 118
 119 wxAppConsole *wxAppConsoleBase::ms_appInstance = NULL;
 120
 121 wxAppInitializerFunction wxAppConsoleBase::ms_appInitFn = NULL;
 122
 123 // ----------------------------------------------------------------------------
 124 // wxEventLoopPtr
 125 // ----------------------------------------------------------------------------
 126
 127 // this defines wxEventLoopPtr
 128 wxDEFINE_TIED_SCOPED_PTR_TYPE(wxEventLoopBase)
 129
 130 // ============================================================================
 131 // wxAppConsoleBase implementation
 132 // ============================================================================
 133
 134 // ----------------------------------------------------------------------------
 135 // ctor/dtor
 136 // ----------------------------------------------------------------------------
 137
 138 wxAppConsoleBase::wxAppConsoleBase()
 139 {
 140     m_traits = NULL;
 141     m_mainLoop = NULL;
 142
 143     ms_appInstance = wx_static_cast(wxAppConsole *, this);
 144
 145 #ifdef __WXDEBUG__
 146     SetTraceMasks();
 147 #if wxUSE_UNICODE
 148     // In unicode mode the SetTraceMasks call can cause an apptraits to be
 149     // created, but since we are still in the constructor the wrong kind will
 150     // be created for GUI apps.  Destroy it so it can be created again later.
 151     delete m_traits;
 152     m_traits = NULL;
 153 #endif
 154 #endif
 155 }
 156
 157 wxAppConsoleBase::~wxAppConsoleBase()
 158 {
 159     delete m_traits;
 160 }
 161
 162 // ----------------------------------------------------------------------------
 163 // initilization/cleanup
 164 // ----------------------------------------------------------------------------
 165
 166 bool wxAppConsoleBase::Initialize(int& argcOrig, wxChar **argvOrig)
 167 {
 168 #if wxUSE_INTL
 169     GetTraits()->SetLocale();
 170 #endif // wxUSE_INTL
 171
 172     // remember the command line arguments
 173     argc = argcOrig;
 174     argv = argvOrig;
 175
 176 #if wxUSE_THREADS
 177     wxPendingEventsLocker = new wxCriticalSection;
 178 #endif
 179
 180 #ifndef __WXPALMOS__
 181     if ( m_appName.empty() && argv )
 182     {
 183         // the application name is, by default, the name of its executable file
 184         wxFileName::SplitPath(argv[0], NULL, &m_appName, NULL);
 185     }
 186 #endif // !__WXPALMOS__
 187
 188     return true;
 189 }
 190
 191 wxEventLoopBase *wxAppConsoleBase::CreateMainLoop()
 192 {
 193     return GetTraits()->CreateEventLoop();
 194 }
 195
 196 void wxAppConsoleBase::CleanUp()
 197 {
 198     if ( m_mainLoop )
 199     {
 200         delete m_mainLoop;
 201         m_mainLoop = NULL;
 202     }
 203
 204     delete wxPendingEvents;
 205     wxPendingEvents = NULL;
 206
 207 #if wxUSE_THREADS
 208     delete wxPendingEventsLocker;
 209     wxPendingEventsLocker = NULL;
 210 #endif // wxUSE_THREADS
 211 }
 212
 213 // ----------------------------------------------------------------------------
 214 // OnXXX() callbacks
 215 // ----------------------------------------------------------------------------
 216
 217 bool wxAppConsoleBase::OnInit()
 218 {
 219 #if wxUSE_CMDLINE_PARSER
 220     wxCmdLineParser parser(argc, argv);
 221
 222     OnInitCmdLine(parser);
 223
 224     bool cont;
 225     switch ( parser.Parse(false /* don't show usage */) )
 226     {
 227         case -1:
 228             cont = OnCmdLineHelp(parser);
 229             break;
 230
 231         case 0:
 232             cont = OnCmdLineParsed(parser);
 233             break;
 234
 235         default:
 236             cont = OnCmdLineError(parser);
 237             break;
 238     }
 239
 240     if ( !cont )
 241         return false;
 242 #endif // wxUSE_CMDLINE_PARSER
 243
 244     return true;
 245 }
 246
 247 int wxAppConsoleBase::OnRun()
 248 {
 249     return MainLoop();
 250 }
 251
 252 int wxAppConsoleBase::OnExit()
 253 {
 254 #if wxUSE_CONFIG
 255     // delete the config object if any (don't use Get() here, but Set()
 256     // because Get() could create a new config object)
 257     delete wxConfigBase::Set((wxConfigBase *) NULL);
 258 #endif // wxUSE_CONFIG
 259
 260     return 0;
 261 }
 262
 263 void wxAppConsoleBase::Exit()
 264 {
 265     if (m_mainLoop != NULL)
 266         ExitMainLoop();
 267     else
 268         exit(-1);
 269 }
 270
 271 // ----------------------------------------------------------------------------
 272 // traits stuff
 273 // ----------------------------------------------------------------------------
 274
 275 wxAppTraits *wxAppConsoleBase::CreateTraits()
 276 {
 277     return new wxConsoleAppTraits;
 278 }
 279
 280 wxAppTraits *wxAppConsoleBase::GetTraits()
 281 {
 282     // FIXME-MT: protect this with a CS?
 283     if ( !m_traits )
 284     {
 285         m_traits = CreateTraits();
 286
 287         wxASSERT_MSG( m_traits, _T("wxApp::CreateTraits() failed?") );
 288     }
 289
 290     return m_traits;
 291 }
 292
 293 // ----------------------------------------------------------------------------
 294 // event processing
 295 // ----------------------------------------------------------------------------
 296
 297 int wxAppConsoleBase::MainLoop()
 298 {
 299     wxEventLoopBaseTiedPtr mainLoop(&m_mainLoop, CreateMainLoop());
 300
 301     return m_mainLoop ? m_mainLoop->Run() : -1;
 302 }
 303
 304 void wxAppConsoleBase::ExitMainLoop()
 305 {
 306     // we should exit from the main event loop, not just any currently active
 307     // (e.g. modal dialog) event loop
 308     if ( m_mainLoop && m_mainLoop->IsRunning() )
 309     {
 310         m_mainLoop->Exit(0);
 311     }
 312 }
 313
 314 bool wxAppConsoleBase::Pending()
 315 {
 316     // use the currently active message loop here, not m_mainLoop, because if
 317     // we're showing a modal dialog (with its own event loop) currently the
 318     // main event loop is not running anyhow
 319     wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
 320
 321     return loop && loop->Pending();
 322 }
 323
 324 bool wxAppConsoleBase::Dispatch()
 325 {
 326     // see comment in Pending()
 327     wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
 328
 329     return loop && loop->Dispatch();
 330 }
 331
 332 bool wxAppConsoleBase::HasPendingEvents() const
 333 {
 334     wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 335
 336     bool has = wxPendingEvents && !wxPendingEvents->IsEmpty();
 337
 338     wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
 339
 340     return has;
 341 }
 342
 343 /* static */
 344 bool wxAppConsoleBase::IsMainLoopRunning()
 345 {
 346     const wxAppConsole * const app = GetInstance();
 347
 348     return app && app->m_mainLoop != NULL;
 349 }
 350
 351 void wxAppConsoleBase::ProcessPendingEvents()
 352 {
 353 #if wxUSE_THREADS
 354     if ( !wxPendingEventsLocker )
 355         return;
 356 #endif
 357
 358     wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 359
 360     if (wxPendingEvents)
 361     {
 362         // iterate until the list becomes empty
 363         wxList::compatibility_iterator node = wxPendingEvents->GetFirst();
 364         while (node)
 365         {
 366             wxEvtHandler *handler = (wxEvtHandler *)node->GetData();
 367             wxPendingEvents->Erase(node);
 368
 369             // In ProcessPendingEvents(), new handlers might be add
 370             // and we can safely leave the critical section here.
 371             wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
 372
 373             handler->ProcessPendingEvents();
 374
 375             wxENTER_CRIT_SECT( *wxPendingEventsLocker );
 376
 377             node = wxPendingEvents->GetFirst();
 378         }
 379     }
 380
 381     wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
 382 }
 383
 384 void wxAppConsoleBase::WakeUpIdle()
 385 {
 386     if ( m_mainLoop )
 387         m_mainLoop->WakeUp();
 388 }
 389
 390 bool wxAppConsoleBase::ProcessIdle()
 391 {
 392     wxIdleEvent event;
 393
 394     event.SetEventObject(this);
 395     ProcessEvent(event);
 396     return event.MoreRequested();
 397 }
 398
 399 int wxAppConsoleBase::FilterEvent(wxEvent& WXUNUSED(event))
 400 {
 401     // process the events normally by default
 402     return -1;
 403 }
 404
 405 // ----------------------------------------------------------------------------
 406 // exception handling
 407 // ----------------------------------------------------------------------------
 408
 409 #if wxUSE_EXCEPTIONS
 410
 411 void
 412 wxAppConsoleBase::HandleEvent(wxEvtHandler *handler,
 413                               wxEventFunction func,
 414                               wxEvent& event) const
 415 {
 416     // by default, simply call the handler
 417     (handler->*func)(event);
 418 }
 419
 420 void wxAppConsoleBase::OnUnhandledException()
 421 {
 422 #ifdef __WXDEBUG__
 423     // we're called from an exception handler so we can re-throw the exception
 424     // to recover its type
 425     wxString what;
 426     try
 427     {
 428         throw;
 429     }
 430 #if wxUSE_STL
 431     catch ( std::exception& e )
 432     {
 433         what.Printf("std::exception of type \"%s\", what() = \"%s\"",
 434                     typeid(e).name(), e.what());
 435     }
 436 #endif // wxUSE_STL
 437     catch ( ... )
 438     {
 439         what = "unknown exception";
 440     }
 441
 442     wxMessageOutputBest().Printf(
 443         "*** Caught unhandled %s; terminating\n", what
 444     );
 445 #endif // __WXDEBUG__
 446 }
 447
 448 // ----------------------------------------------------------------------------
 449 // exceptions support
 450 // ----------------------------------------------------------------------------
 451
 452 bool wxAppConsoleBase::OnExceptionInMainLoop()
 453 {
 454     throw;
 455
 456     // some compilers are too stupid to know that we never return after throw
 457 #if defined(__DMC__) || (defined(_MSC_VER) && _MSC_VER < 1200)
 458     return false;
 459 #endif
 460 }
 461
 462 #endif // wxUSE_EXCEPTIONS
 463
 464 // ----------------------------------------------------------------------------
 465 // cmd line parsing
 466 // ----------------------------------------------------------------------------
 467
 468 #if wxUSE_CMDLINE_PARSER
 469
 470 #define OPTION_VERBOSE "verbose"
 471
 472 void wxAppConsoleBase::OnInitCmdLine(wxCmdLineParser& parser)
 473 {
 474     // the standard command line options
 475     static const wxCmdLineEntryDesc cmdLineDesc[] =
 476     {
 477         {
 478             wxCMD_LINE_SWITCH,
 479             "h",
 480             "help",
 481             gettext_noop("show this help message"),
 482             wxCMD_LINE_VAL_NONE,
 483             wxCMD_LINE_OPTION_HELP
 484         },
 485
 486 #if wxUSE_LOG
 487         {
 488             wxCMD_LINE_SWITCH,
 489             NULL,
 490             OPTION_VERBOSE,
 491             gettext_noop("generate verbose log messages"),
 492             wxCMD_LINE_VAL_NONE,
 493             0x0
 494         },
 495 #endif // wxUSE_LOG
 496
 497         // terminator
 498         wxCMD_LINE_DESC_END
 499     };
 500
 501     parser.SetDesc(cmdLineDesc);
 502 }
 503
 504 bool wxAppConsoleBase::OnCmdLineParsed(wxCmdLineParser& parser)
 505 {
 506 #if wxUSE_LOG
 507     if ( parser.Found(OPTION_VERBOSE) )
 508     {
 509         wxLog::SetVerbose(true);
 510     }
 511 #else
 512     wxUnusedVar(parser);
 513 #endif // wxUSE_LOG
 514
 515     return true;
 516 }
 517
 518 bool wxAppConsoleBase::OnCmdLineHelp(wxCmdLineParser& parser)
 519 {
 520     parser.Usage();
 521
 522     return false;
 523 }
 524
 525 bool wxAppConsoleBase::OnCmdLineError(wxCmdLineParser& parser)
 526 {
 527     parser.Usage();
 528
 529     return false;
 530 }
 531
 532 #endif // wxUSE_CMDLINE_PARSER
 533
 534 // ----------------------------------------------------------------------------
 535 // debugging support
 536 // ----------------------------------------------------------------------------
 537
 538 /* static */
 539 bool wxAppConsoleBase::CheckBuildOptions(const char *optionsSignature,
 540                                          const char *componentName)
 541 {
 542 #if 0 // can't use wxLogTrace, not up and running yet
 543     printf("checking build options object '%s' (ptr %p) in '%s'\n",
 544              optionsSignature, optionsSignature, componentName);
 545 #endif
 546
 547     if ( strcmp(optionsSignature, WX_BUILD_OPTIONS_SIGNATURE) != 0 )
 548     {
 549         wxString lib = wxString::FromAscii(WX_BUILD_OPTIONS_SIGNATURE);
 550         wxString prog = wxString::FromAscii(optionsSignature);
 551         wxString progName = wxString::FromAscii(componentName);
 552         wxString msg;
 553
 554         msg.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %s,\nand %s used %s."),
 555                    lib.c_str(), progName.c_str(), prog.c_str());
 556
 557         wxLogFatalError(msg.c_str());
 558
 559         // normally wxLogFatalError doesn't return
 560         return false;
 561     }
 562 #undef wxCMP
 563
 564     return true;
 565 }
 566
 567 #ifdef __WXDEBUG__
 568
 569 void wxAppConsoleBase::OnAssertFailure(const wxChar *file,
 570                                        int line,
 571                                        const wxChar *func,
 572                                        const wxChar *cond,
 573                                        const wxChar *msg)
 574 {
 575     ShowAssertDialog(file, line, func, cond, msg, GetTraits());
 576 }
 577
 578 void wxAppConsoleBase::OnAssert(const wxChar *file,
 579                                 int line,
 580                                 const wxChar *cond,
 581                                 const wxChar *msg)
 582 {
 583     OnAssertFailure(file, line, NULL, cond, msg);
 584 }
 585
 586 #endif // __WXDEBUG__
 587
 588 // ============================================================================
 589 // other classes implementations
 590 // ============================================================================
 591
 592 // ----------------------------------------------------------------------------
 593 // wxConsoleAppTraitsBase
 594 // ----------------------------------------------------------------------------
 595
 596 #if wxUSE_LOG
 597
 598 wxLog *wxConsoleAppTraitsBase::CreateLogTarget()
 599 {
 600     return new wxLogStderr;
 601 }
 602
 603 #endif // wxUSE_LOG
 604
 605 wxMessageOutput *wxConsoleAppTraitsBase::CreateMessageOutput()
 606 {
 607     return new wxMessageOutputStderr;
 608 }
 609
 610 #if wxUSE_FONTMAP
 611
 612 wxFontMapper *wxConsoleAppTraitsBase::CreateFontMapper()
 613 {
 614     return (wxFontMapper *)new wxFontMapperBase;
 615 }
 616
 617 #endif // wxUSE_FONTMAP
 618
 619 wxRendererNative *wxConsoleAppTraitsBase::CreateRenderer()
 620 {
 621     // console applications don't use renderers
 622     return NULL;
 623 }
 624
 625 #ifdef __WXDEBUG__
 626 bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString& msg)
 627 {
 628     return wxAppTraitsBase::ShowAssertDialog(msg);
 629 }
 630 #endif
 631
 632 bool wxConsoleAppTraitsBase::HasStderr()
 633 {
 634     // console applications always have stderr, even under Mac/Windows
 635     return true;
 636 }
 637
 638 void wxConsoleAppTraitsBase::ScheduleForDestroy(wxObject *object)
 639 {
 640     delete object;
 641 }
 642
 643 void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject * WXUNUSED(object))
 644 {
 645     // nothing to do
 646 }
 647
 648 // ----------------------------------------------------------------------------
 649 // wxAppTraits
 650 // ----------------------------------------------------------------------------
 651
 652 #if wxUSE_INTL
 653 void wxAppTraitsBase::SetLocale()
 654 {
 655     wxSetlocale(LC_ALL, "");
 656     wxUpdateLocaleIsUtf8();
 657 }
 658 #endif
 659
 660 #if wxUSE_THREADS
 661 void wxMutexGuiEnterImpl();
 662 void wxMutexGuiLeaveImpl();
 663
 664 void wxAppTraitsBase::MutexGuiEnter()
 665 {
 666     wxMutexGuiEnterImpl();
 667 }
 668
 669 void wxAppTraitsBase::MutexGuiLeave()
 670 {
 671     wxMutexGuiLeaveImpl();
 672 }
 673
 674 void WXDLLIMPEXP_BASE wxMutexGuiEnter()
 675 {
 676     wxAppConsoleBase::GetInstance()->GetTraits()->MutexGuiEnter();
 677 }
 678
 679 void WXDLLIMPEXP_BASE wxMutexGuiLeave()
 680 {
 681     wxAppConsoleBase::GetInstance()->GetTraits()->MutexGuiLeave();
 682 }
 683 #endif // wxUSE_THREADS
 684
 685 #ifdef __WXDEBUG__
 686
 687 bool wxAppTraitsBase::ShowAssertDialog(const wxString& msgOriginal)
 688 {
 689     wxString msg = msgOriginal;
 690
 691 #if wxUSE_STACKWALKER
 692 #if !defined(__WXMSW__)
 693     // on Unix stack frame generation may take some time, depending on the
 694     // size of the executable mainly... warn the user that we are working
 695     wxFprintf(stderr, wxT("[Debug] Generating a stack trace... please wait"));
 696     fflush(stderr);
 697 #endif
 698
 699     const wxString stackTrace = GetAssertStackTrace();
 700     if ( !stackTrace.empty() )
 701         msg << _T("\n\nCall stack:\n") << stackTrace;
 702 #endif // wxUSE_STACKWALKER
 703
 704     return DoShowAssertDialog(msg);
 705 }
 706
 707 #if wxUSE_STACKWALKER
 708 wxString wxAppTraitsBase::GetAssertStackTrace()
 709 {
 710     wxString stackTrace;
 711
 712     class StackDump : public wxStackWalker
 713     {
 714     public:
 715         StackDump() { }
 716
 717         const wxString& GetStackTrace() const { return m_stackTrace; }
 718
 719     protected:
 720         virtual void OnStackFrame(const wxStackFrame& frame)
 721         {
 722             m_stackTrace << wxString::Format
 723                             (
 724                               _T("[%02d] "),
 725                               wx_truncate_cast(int, frame.GetLevel())
 726                             );
 727
 728             wxString name = frame.GetName();
 729             if ( !name.empty() )
 730             {
 731                 m_stackTrace << wxString::Format(_T("%-40s"), name.c_str());
 732             }
 733             else
 734             {
 735                 m_stackTrace << wxString::Format(_T("%p"), frame.GetAddress());
 736             }
 737
 738             if ( frame.HasSourceLocation() )
 739             {
 740                 m_stackTrace << _T('\t')
 741                              << frame.GetFileName()
 742                              << _T(':')
 743                              << frame.GetLine();
 744             }
 745
 746             m_stackTrace << _T('\n');
 747         }
 748
 749     private:
 750         wxString m_stackTrace;
 751     };
 752
 753     // don't show more than maxLines or we could get a dialog too tall to be
 754     // shown on screen: 20 should be ok everywhere as even with 15 pixel high
 755     // characters it is still only 300 pixels...
 756     static const int maxLines = 20;
 757
 758     StackDump dump;
 759     dump.Walk(2, maxLines); // don't show OnAssert() call itself
 760     stackTrace = dump.GetStackTrace();
 761
 762     const int count = stackTrace.Freq(wxT('\n'));
 763     for ( int i = 0; i < count - maxLines; i++ )
 764         stackTrace = stackTrace.BeforeLast(wxT('\n'));
 765
 766     return stackTrace;
 767 }
 768 #endif // wxUSE_STACKWALKER
 769
 770
 771 #endif // __WXDEBUG__
 772
 773 // ============================================================================
 774 // global functions implementation
 775 // ============================================================================
 776
 777 void wxExit()
 778 {
 779     if ( wxTheApp )
 780     {
 781         wxTheApp->Exit();
 782     }
 783     else
 784     {
 785         // what else can we do?
 786         exit(-1);
 787     }
 788 }
 789
 790 void wxWakeUpIdle()
 791 {
 792     if ( wxTheApp )
 793     {
 794         wxTheApp->WakeUpIdle();
 795     }
 796     //else: do nothing, what can we do?
 797 }
 798
 799 #ifdef  __WXDEBUG__
 800
 801 // wxASSERT() helper
 802 bool wxAssertIsEqual(int x, int y)
 803 {
 804     return x == y;
 805 }
 806
 807 // break into the debugger
 808 void wxTrap()
 809 {
 810 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
 811     DebugBreak();
 812 #elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
 813     Debugger();
 814 #elif defined(__UNIX__)
 815     raise(SIGTRAP);
 816 #else
 817     // TODO
 818 #endif // Win/Unix
 819 }
 820
 821 // this function is called when an assert fails
 822 static void wxDoOnAssert(const wxString& szFile,
 823                          int nLine,
 824                          const wxString& szFunc,
 825                          const wxString& szCond,
 826                          const wxString& szMsg = wxEmptyString)
 827 {
 828     // FIXME MT-unsafe
 829     static bool s_bInAssert = false;
 830
 831     if ( s_bInAssert )
 832     {
 833         // He-e-e-e-elp!! we're trapped in endless loop
 834         wxTrap();
 835
 836         s_bInAssert = false;
 837
 838         return;
 839     }
 840
 841     s_bInAssert = true;
 842
 843     if ( !wxTheApp )
 844     {
 845         // by default, show the assert dialog box -- we can't customize this
 846         // behaviour
 847         ShowAssertDialog(szFile, nLine, szFunc, szCond, szMsg);
 848     }
 849     else
 850     {
 851         // let the app process it as it wants
 852         // FIXME-UTF8: use wc_str(), not c_str(), when ANSI build is removed
 853         wxTheApp->OnAssertFailure(szFile.c_str(), nLine, szFunc.c_str(),
 854                                   szCond.c_str(), szMsg.c_str());
 855     }
 856
 857     s_bInAssert = false;
 858 }
 859
 860 void wxOnAssert(const wxString& szFile,
 861                 int nLine,
 862                 const wxString& szFunc,
 863                 const wxString& szCond,
 864                 const wxString& szMsg)
 865 {
 866     wxDoOnAssert(szFile, nLine, szFunc, szCond, szMsg);
 867 }
 868
 869 void wxOnAssert(const wxString& szFile,
 870                 int nLine,
 871                 const wxString& szFunc,
 872                 const wxString& szCond)
 873 {
 874     wxDoOnAssert(szFile, nLine, szFunc, szCond);
 875 }
 876
 877 void wxOnAssert(const wxChar *szFile,
 878                 int nLine,
 879                 const char *szFunc,
 880                 const wxChar *szCond,
 881                 const wxChar *szMsg)
 882 {
 883     wxDoOnAssert(szFile, nLine, szFunc, szCond, szMsg);
 884 }
 885
 886 void wxOnAssert(const char *szFile,
 887                 int nLine,
 888                 const char *szFunc,
 889                 const char *szCond,
 890                 const wxString& szMsg)
 891 {
 892     wxDoOnAssert(szFile, nLine, szFunc, szCond, szMsg);
 893 }
 894
 895 void wxOnAssert(const char *szFile,
 896                 int nLine,
 897                 const char *szFunc,
 898                 const char *szCond,
 899                 const wxCStrData& msg)
 900 {
 901     wxDoOnAssert(szFile, nLine, szFunc, szCond, msg);
 902 }
 903
 904 #if wxUSE_UNICODE
 905 void wxOnAssert(const char *szFile,
 906                 int nLine,
 907                 const char *szFunc,
 908                 const char *szCond)
 909 {
 910     wxDoOnAssert(szFile, nLine, szFunc, szCond);
 911 }
 912
 913 void wxOnAssert(const char *szFile,
 914                 int nLine,
 915                 const char *szFunc,
 916                 const char *szCond,
 917                 const char *szMsg)
 918 {
 919     wxDoOnAssert(szFile, nLine, szFunc, szCond, szMsg);
 920 }
 921
 922 void wxOnAssert(const char *szFile,
 923                 int nLine,
 924                 const char *szFunc,
 925                 const char *szCond,
 926                 const wxChar *szMsg)
 927 {
 928     wxDoOnAssert(szFile, nLine, szFunc, szCond, szMsg);
 929 }
 930 #endif // wxUSE_UNICODE
 931
 932 #endif // __WXDEBUG__
 933
 934 // ============================================================================
 935 // private functions implementation
 936 // ============================================================================
 937
 938 #ifdef __WXDEBUG__
 939
 940 static void LINKAGEMODE SetTraceMasks()
 941 {
 942 #if wxUSE_LOG
 943     wxString mask;
 944     if ( wxGetEnv(wxT("WXTRACE"), &mask) )
 945     {
 946         wxStringTokenizer tkn(mask, wxT(",;:"));
 947         while ( tkn.HasMoreTokens() )
 948             wxLog::AddTraceMask(tkn.GetNextToken());
 949     }
 950 #endif // wxUSE_LOG
 951 }
 952
 953 static
 954 bool DoShowAssertDialog(const wxString& msg)
 955 {
 956     // under MSW we can show the dialog even in the console mode
 957 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
 958     wxString msgDlg(msg);
 959
 960     // this message is intentionally not translated -- it is for
 961     // developpers only
 962     msgDlg += wxT("\nDo you want to stop the program?\n")
 963               wxT("You can also choose [Cancel] to suppress ")
 964               wxT("further warnings.");
 965
 966     switch ( ::MessageBox(NULL, msgDlg.wx_str(), _T("wxWidgets Debug Alert"),
 967                           MB_YESNOCANCEL | MB_ICONSTOP ) )
 968     {
 969         case IDYES:
 970             wxTrap();
 971             break;
 972
 973         case IDCANCEL:
 974             // stop the asserts
 975             return true;
 976
 977         //case IDNO: nothing to do
 978     }
 979 #else // !__WXMSW__
 980     wxFprintf(stderr, wxT("%s\n"), msg.c_str());
 981     fflush(stderr);
 982
 983     // TODO: ask the user to enter "Y" or "N" on the console?
 984     wxTrap();
 985 #endif // __WXMSW__/!__WXMSW__
 986
 987     // continue with the asserts
 988     return false;
 989 }
 990
 991 // show the assert modal dialog
 992 static
 993 void ShowAssertDialog(const wxString& szFile,
 994                       int nLine,
 995                       const wxString& szFunc,
 996                       const wxString& szCond,
 997                       const wxString& szMsg,
 998                       wxAppTraits *traits)
 999 {
1000     // this variable can be set to true to suppress "assert failure" messages
1001     static bool s_bNoAsserts = false;
1002
1003     wxString msg;
1004     msg.reserve(2048);
1005
1006     // make life easier for people using VC++ IDE by using this format: like
1007     // this, clicking on the message will take us immediately to the place of
1008     // the failed assert
1009     msg.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile, nLine, szCond);
1010
1011     // add the function name, if any
1012     if ( !szFunc.empty() )
1013         msg << _T(" in ") << szFunc << _T("()");
1014
1015     // and the message itself
1016     if ( !szMsg.empty() )
1017     {
1018         msg << _T(": ") << szMsg;
1019     }
1020     else // no message given
1021     {
1022         msg << _T('.');
1023     }
1024
1025 #if wxUSE_THREADS
1026     // if we are not in the main thread, output the assert directly and trap
1027     // since dialogs cannot be displayed
1028     if ( !wxThread::IsMain() )
1029     {
1030         msg += wxT(" [in child thread]");
1031
1032 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
1033         msg << wxT("\r\n");
1034         OutputDebugString(msg.wx_str());
1035 #else
1036         // send to stderr
1037         wxFprintf(stderr, wxT("%s\n"), msg.c_str());
1038         fflush(stderr);
1039 #endif
1040         // He-e-e-e-elp!! we're asserting in a child thread
1041         wxTrap();
1042     }
1043     else
1044 #endif // wxUSE_THREADS
1045
1046     if ( !s_bNoAsserts )
1047     {
1048         // send it to the normal log destination
1049         wxLogDebug(_T("%s"), msg.c_str());
1050
1051         if ( traits )
1052         {
1053             // delegate showing assert dialog (if possible) to that class
1054             s_bNoAsserts = traits->ShowAssertDialog(msg);
1055         }
1056         else // no traits object
1057         {
1058             // fall back to the function of last resort
1059             s_bNoAsserts = DoShowAssertDialog(msg);
1060         }
1061     }
1062 }
1063
1064 #endif // __WXDEBUG__