Files
wxWidgets/src/common/appcmn.cpp
utelle 1c65e88221 Replace references to wxLocale by wxUILocale
Use newer wxUILocale class directly instead of using wxLocale functions
that forward to it anyhow.

No real changes.

Closes #22375.
2022-05-01 03:02:26 +02:00

599 lines
17 KiB
C++

/////////////////////////////////////////////////////////////////////////////
// Name: src/common/appcmn.cpp
// Purpose: wxAppBase methods common to all platforms
// Author: Vadim Zeitlin
// Modified by:
// Created: 18.10.99
// Copyright: (c) Vadim Zeitlin
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// declarations
// ============================================================================
// ---------------------------------------------------------------------------
// headers
// ---------------------------------------------------------------------------
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifndef WX_PRECOMP
#include "wx/app.h"
#include "wx/window.h"
#include "wx/bitmap.h"
#include "wx/log.h"
#include "wx/module.h"
#include "wx/msgdlg.h"
#include "wx/confbase.h"
#include "wx/utils.h"
#include "wx/wxcrtvararg.h"
#endif
#include "wx/apptrait.h"
#include "wx/cmdline.h"
#include "wx/msgout.h"
#include "wx/richmsgdlg.h"
#include "wx/thread.h"
#include "wx/vidmode.h"
#include "wx/evtloop.h"
#include "wx/uilocale.h"
#if wxUSE_FONTMAP
#include "wx/fontmap.h"
#endif // wxUSE_FONTMAP
// DLL options compatibility check:
#include "wx/build.h"
WX_CHECK_BUILD_OPTIONS("wxCore")
// ============================================================================
// wxAppBase implementation
// ============================================================================
// ----------------------------------------------------------------------------
// initialization
// ----------------------------------------------------------------------------
wxAppBase::wxAppBase()
{
m_topWindow = NULL;
m_useBestVisual = false;
m_forceTrueColour = false;
m_isActive = true;
// We don't want to exit the app if the user code shows a dialog from its
// OnInit() -- but this is what would happen if we set m_exitOnFrameDelete
// to Yes initially as this dialog would be the last top level window.
// OTOH, if we set it to No initially we'll have to overwrite it with Yes
// when we enter our OnRun() because we do want the default behaviour from
// then on. But this would be a problem if the user code calls
// SetExitOnFrameDelete(false) from OnInit().
//
// So we use the special "Later" value which is such that
// GetExitOnFrameDelete() returns false for it but which we know we can
// safely (i.e. without losing the effect of the users SetExitOnFrameDelete
// call) overwrite in OnRun()
m_exitOnFrameDelete = Later;
}
bool wxAppBase::Initialize(int& argcOrig, wxChar **argvOrig)
{
#ifdef __DARWIN__
// Mac OS X passes a process serial number command line argument when
// the application is launched from the Finder. This argument must be
// removed from the command line arguments before being handled by the
// application (otherwise applications would need to handle it)
//
// Notice that this has to be done for all ports that can be used under OS
// X (e.g. wxGTK) and not just wxOSX itself, hence this code is here and
// not in a port-specific file.
if ( argcOrig > 1 )
{
static const wxChar *ARG_PSN = wxT("-psn_");
if ( wxStrncmp(argvOrig[1], ARG_PSN, wxStrlen(ARG_PSN)) == 0 )
{
// remove this argument
--argcOrig;
memmove(argvOrig + 1, argvOrig + 2, argcOrig * sizeof(wxChar*));
}
}
#endif // __DARWIN__
if ( !wxAppConsole::Initialize(argcOrig, argvOrig) )
return false;
wxInitializeStockLists();
wxBitmap::InitStandardHandlers();
// for compatibility call the old initialization function too
if ( !OnInitGui() )
return false;
return true;
}
// ----------------------------------------------------------------------------
// cleanup
// ----------------------------------------------------------------------------
wxAppBase::~wxAppBase()
{
// this destructor is required for Darwin
}
void wxAppBase::DeleteAllTLWs()
{
// TLWs remove themselves from wxTopLevelWindows when destroyed, so iterate
// until none are left.
while ( !wxTopLevelWindows.empty() )
{
// do not use Destroy() here as it only puts the TLW in pending list
// but we want to delete them now
delete wxTopLevelWindows.GetFirst()->GetData();
}
}
void wxAppBase::CleanUp()
{
// Clean up any still pending objects. Normally there shouldn't any as we
// already do this in OnExit(), but this could happen if the user code has
// somehow managed to create more of them since then or just forgot to call
// the base class OnExit().
DeletePendingObjects();
// and any remaining TLWs
DeleteAllTLWs();
// undo everything we did in Initialize() above
wxBitmap::CleanUpHandlers();
wxStockGDI::DeleteAll();
wxDeleteStockLists();
wxDELETE(wxTheColourDatabase);
wxAppConsole::CleanUp();
}
// ----------------------------------------------------------------------------
// various accessors
// ----------------------------------------------------------------------------
wxWindow* wxAppBase::GetTopWindow() const
{
wxWindow* window = m_topWindow;
// If there is no top window or it is about to be destroyed,
// we need to search for the first TLW which is not pending delete
if ( !window || wxPendingDelete.Member(window) )
{
window = NULL;
wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
while ( node )
{
wxWindow* win = node->GetData();
if ( !wxPendingDelete.Member(win) )
{
window = win;
break;
}
node = node->GetNext();
}
}
return window;
}
/* static */
wxWindow* wxAppBase::GetMainTopWindow()
{
const wxAppBase* const app = GetGUIInstance();
return app ? app->GetTopWindow() : NULL;
}
wxVideoMode wxAppBase::GetDisplayMode() const
{
return wxVideoMode();
}
wxLayoutDirection wxAppBase::GetLayoutDirection() const
{
#if wxUSE_INTL
return wxUILocale::GetCurrent().GetLayoutDirection();
#else
// we don't know
return wxLayout_Default;
#endif // wxUSE_INTL
}
#if wxUSE_CMDLINE_PARSER
// ----------------------------------------------------------------------------
// GUI-specific command line options handling
// ----------------------------------------------------------------------------
#ifdef __WXUNIVERSAL__
#define OPTION_THEME "theme"
#endif
#if defined(__WXDFB__)
#define OPTION_MODE "mode"
#endif
void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
{
// first add the standard non GUI options
wxAppConsole::OnInitCmdLine(parser);
// the standard command line options
static const wxCmdLineEntryDesc cmdLineGUIDesc[] =
{
#ifdef __WXUNIVERSAL__
{
wxCMD_LINE_OPTION,
NULL,
OPTION_THEME,
gettext_noop("specify the theme to use"),
wxCMD_LINE_VAL_STRING,
0x0
},
#endif // __WXUNIVERSAL__
#if defined(__WXDFB__)
// VS: this is not specific to wxDFB, all fullscreen (framebuffer) ports
// should provide this option. That's why it is in common/appcmn.cpp
// and not dfb/app.cpp
{
wxCMD_LINE_OPTION,
NULL,
OPTION_MODE,
gettext_noop("specify display mode to use (e.g. 640x480-16)"),
wxCMD_LINE_VAL_STRING,
0x0
},
#endif // __WXDFB__
// terminator
wxCMD_LINE_DESC_END
};
parser.SetDesc(cmdLineGUIDesc);
}
bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
{
#ifdef __WXUNIVERSAL__
wxString themeName;
if ( parser.Found(OPTION_THEME, &themeName) )
{
wxTheme *theme = wxTheme::Create(themeName);
if ( !theme )
{
wxLogError(_("Unsupported theme '%s'."), themeName);
return false;
}
// Delete the defaultly created theme and set the new theme.
delete wxTheme::Get();
wxTheme::Set(theme);
}
#endif // __WXUNIVERSAL__
#if defined(__WXDFB__)
wxString modeDesc;
if ( parser.Found(OPTION_MODE, &modeDesc) )
{
unsigned w, h, bpp;
if ( wxSscanf(modeDesc, wxT("%ux%u-%u"), &w, &h, &bpp) != 3 )
{
wxLogError(_("Invalid display mode specification '%s'."), modeDesc);
return false;
}
if ( !SetDisplayMode(wxVideoMode(w, h, bpp)) )
return false;
}
#endif // __WXDFB__
return wxAppConsole::OnCmdLineParsed(parser);
}
#endif // wxUSE_CMDLINE_PARSER
// ----------------------------------------------------------------------------
// OnXXX() hooks
// ----------------------------------------------------------------------------
bool wxAppBase::OnInitGui()
{
#ifdef __WXUNIVERSAL__
if ( !wxTheme::Get() && !wxTheme::CreateDefault() )
return false;
#endif // __WXUNIVERSAL__
return true;
}
int wxAppBase::OnRun()
{
// see the comment in ctor: if the initial value hasn't been changed, use
// the default Yes from now on
if ( m_exitOnFrameDelete == Later )
{
m_exitOnFrameDelete = Yes;
}
//else: it has been changed, assume the user knows what he is doing
return wxAppConsole::OnRun();
}
int wxAppBase::OnExit()
{
#ifdef __WXUNIVERSAL__
delete wxTheme::Set(NULL);
#endif // __WXUNIVERSAL__
return wxAppConsole::OnExit();
}
wxAppTraits *wxAppBase::CreateTraits()
{
return new wxGUIAppTraits;
}
// ----------------------------------------------------------------------------
// misc
// ----------------------------------------------------------------------------
void wxAppBase::SetActive(bool active, wxWindow * WXUNUSED(lastFocus))
{
if ( active == m_isActive )
return;
m_isActive = active;
wxActivateEvent event(wxEVT_ACTIVATE_APP, active);
event.SetEventObject(this);
(void)ProcessEvent(event);
}
bool wxAppBase::SafeYield(wxWindow *win, bool onlyIfNeeded)
{
wxWindowDisabler wd(win);
wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
return loop && loop->Yield(onlyIfNeeded);
}
bool wxAppBase::SafeYieldFor(wxWindow *win, long eventsToProcess)
{
wxWindowDisabler wd(win);
wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
return loop && loop->YieldFor(eventsToProcess);
}
// ----------------------------------------------------------------------------
// idle handling
// ----------------------------------------------------------------------------
// Returns true if more time is needed.
bool wxAppBase::ProcessIdle()
{
// call the base class version first to send the idle event to wxTheApp
// itself
bool needMore = wxAppConsoleBase::ProcessIdle();
wxIdleEvent event;
wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
while (node)
{
wxWindow* win = node->GetData();
// Don't send idle events to the windows that are about to be destroyed
// anyhow, this is wasteful and unexpected.
if ( !wxPendingDelete.Member(win) && win->SendIdleEvents(event) )
needMore = true;
node = node->GetNext();
}
wxUpdateUIEvent::ResetUpdateTime();
return needMore;
}
// ----------------------------------------------------------------------------
// wxGUIAppTraitsBase
// ----------------------------------------------------------------------------
#if wxUSE_LOG
wxLog *wxGUIAppTraitsBase::CreateLogTarget()
{
#if wxUSE_LOGGUI
#ifndef __WXOSX_IPHONE__
return new wxLogGui;
#else
return new wxLogStderr;
#endif
#else
// we must have something!
return new wxLogStderr;
#endif
}
#endif // wxUSE_LOG
wxMessageOutput *wxGUIAppTraitsBase::CreateMessageOutput()
{
// The standard way of printing help on command line arguments (app --help)
// is (according to common practice):
// - console apps: to stderr (on any platform)
// - GUI apps: stderr on Unix platforms (!)
// stderr if available and message box otherwise on others
// (currently stderr only Windows if app running from console)
#ifdef __UNIX__
return new wxMessageOutputStderr;
#else // !__UNIX__
// wxMessageOutputMessageBox doesn't work under Motif
#ifdef __WXMOTIF__
return new wxMessageOutputLog;
#elif wxUSE_MSGDLG
return new wxMessageOutputBest(wxMSGOUT_PREFER_STDERR);
#else
return new wxMessageOutputStderr;
#endif
#endif // __UNIX__/!__UNIX__
}
#if wxUSE_FONTMAP
wxFontMapper *wxGUIAppTraitsBase::CreateFontMapper()
{
return new wxFontMapper;
}
#endif // wxUSE_FONTMAP
wxRendererNative *wxGUIAppTraitsBase::CreateRenderer()
{
// use the default native renderer by default
return NULL;
}
bool wxGUIAppTraitsBase::ShowAssertDialog(const wxString& msg)
{
#if wxDEBUG_LEVEL
// If possible, show the assert using a dialog allowing to hide the stack
// trace by default to avoid frightening people unnecessarily.
//
// Otherwise, show the assert using a basic message box, but under MSW
// we prefer to use the base class version using ::MessageBox() even if
// wxMessageBox() is available because it has less chances to double
// fault our app than our wxMessageBox()
//
// Notice that under DFB the message dialog is not always functional right
// now and, finally, we can't use wxMessageBox() if it wasn't compiled in.
#if wxUSE_RICHMSGDLG || \
(wxUSE_MSGDLG && !defined(__WXMSW__) && !defined(__WXDFB__))
// we can't (safely) show the GUI dialog from another thread, only do it
// for the asserts in the main thread
if ( wxIsMainThread() )
{
// Note that this and the other messages here are intentionally not
// translated -- they are for developers only.
static const wxStringCharType* caption = wxS("wxWidgets Debug Alert");
wxString msgDlg = wxS("A debugging check in this application ")
wxS("has failed.\n\n") + msg;
// "No" button means to continue execution, so it should be the default
// action as leaving the "Yes" button the default one would mean that
// accidentally pressing Space or Enter would trap and kill the program.
const int flags = wxYES_NO | wxNO_DEFAULT | wxICON_STOP;
#if wxUSE_STACKWALKER
const wxString stackTrace = GetAssertStackTrace();
#endif // wxUSE_STACKWALKER
#if wxUSE_RICHMSGDLG
wxRichMessageDialog dlg(NULL, msgDlg, caption, flags);
dlg.SetYesNoLabels("Stop", "Continue");
dlg.ShowCheckBox("Don't show this dialog again");
#if wxUSE_STACKWALKER
if ( !stackTrace.empty() )
dlg.ShowDetailedText(stackTrace);
#endif // wxUSE_STACKWALKER
#else // !wxUSE_RICHMSGDLG
#if wxUSE_STACKWALKER
if ( !stackTrace.empty() )
msgDlg << wxT("\n\nCall stack:\n") << stackTrace;
#endif // wxUSE_STACKWALKER
msgDlg += wxT("\nDo you want to stop the program?\n")
wxT("You can also choose [Cancel] to suppress ")
wxT("further warnings.");
wxMessageDialog dlg(NULL, msg, caption, flags);
#endif // wxUSE_RICHMSGDLG/!wxUSE_RICHMSGDLG
switch ( dlg.ShowModal() )
{
case wxID_YES:
// See the comment about using the same variable in
// DoShowAssertDialog().
wxTrapInAssert = true;
break;
case wxID_CANCEL:
// This button is used with the plain message dialog only to
// indicate that no more assert dialogs should be shown, as
// there is no other way to do it with it.
return true;
case wxID_NO:
#if wxUSE_RICHMSGDLG
if ( dlg.IsCheckBoxChecked() )
{
// With this dialog, the checkbox is used to indicate that
// the subsequent asserts should be skipped.
return true;
}
#endif // wxUSE_RICHMSGDLG
// Nothing to do otherwise.
break;
}
return false;
}
#endif // wxUSE_RICHMSGDLG || wxUSE_MSGDLG
#endif // wxDEBUG_LEVEL
return wxAppTraitsBase::ShowAssertDialog(msg);
}
bool wxGUIAppTraitsBase::HasStderr()
{
// we consider that under Unix stderr always goes somewhere, even if the
// user doesn't always see it under GUI desktops
#ifdef __UNIX__
return true;
#else
return false;
#endif
}
#ifndef __WIN32__
bool wxGUIAppTraitsBase::SafeMessageBox(const wxString& text,
const wxString& title)
{
// The modules are initialized only after a successful call to
// wxApp::Initialize() in wxEntryStart, so it can be used as a proxy for
// GUI availability (note that the mere existence of wxTheApp is not enough
// for this).
if ( !wxModule::AreInitialized() )
return false;
wxMessageBox(text, title, wxOK | wxICON_ERROR);
return true;
}
#endif // !__WIN32__