kicad/libs/kiplatform/msw/app.cpp

196 lines
6.1 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Mark Roszko <mark.roszko@gmail.com>
* Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <kiplatform/app.h>
#include <wx/log.h>
#include <wx/string.h>
#include <wx/window.h>
#include <windows.h>
#include <strsafe.h>
#include <config.h>
#include <VersionHelpers.h>
#include <iostream>
#include <cstdio>
#if defined( _MSC_VER )
#include <werapi.h> // issues on msys2
#endif
bool KIPLATFORM::APP::Init()
{
#if defined( _MSC_VER ) && defined( DEBUG )
// wxWidgets turns on leak dumping in debug but its "flawed" and will falsely dump
// for half a hour _CRTDBG_ALLOC_MEM_DF is the usual default for MSVC.
_CrtSetDbgFlag( _CRTDBG_ALLOC_MEM_DF );
#endif
#if defined( DEBUG )
// undo wxwidgets trying to hide errors
SetErrorMode( 0 );
#else
SetErrorMode( SEM_FAILCRITICALERRORS | SEM_NOOPENFILEERRORBOX );
#endif
// remove CWD from the dll search paths
// just the smallest of security tweaks as we do load DLLs on demand
SetDllDirectory( wxT( "" ) );
// Moves the CWD to the end of the search list for spawning processes
SetSearchPathMode( BASE_SEARCH_PATH_ENABLE_SAFE_SEARCHMODE | BASE_SEARCH_PATH_PERMANENT );
// In order to support GUI and CLI
// Let's attach to console when it's possible, or allocate if requested.
bool tryAlloc = wxGetEnv( wxS( "KICAD_ALLOC_CONSOLE" ), nullptr );
HANDLE handle;
if( AttachConsole( ATTACH_PARENT_PROCESS ) || ( tryAlloc && AllocConsole() ) )
{
#if !defined( __MINGW32__ ) // These redirections create problems on mingw:
// Nothing is printed to the console
if( GetStdHandle( STD_INPUT_HANDLE ) != INVALID_HANDLE_VALUE )
{
freopen( "CONIN$", "r", stdin );
setvbuf( stdin, NULL, _IONBF, 0 );
}
if( GetStdHandle( STD_OUTPUT_HANDLE ) != INVALID_HANDLE_VALUE )
{
freopen( "CONOUT$", "w", stdout );
setvbuf( stdout, NULL, _IONBF, 0 );
}
if( GetStdHandle( STD_ERROR_HANDLE ) != INVALID_HANDLE_VALUE )
{
freopen( "CONOUT$", "w", stderr );
setvbuf( stderr, NULL, _IONBF, 0 );
}
#endif
std::ios::sync_with_stdio( true );
std::wcout.clear();
std::cout.clear();
std::wcerr.clear();
std::cerr.clear();
std::wcin.clear();
std::cin.clear();
}
// It may be useful to log up to traces in a console, but in Release builds the log level changes to Info
// Also we have to force the active target to stderr or else it goes to the void
bool forceLog = wxGetEnv( wxS( "KICAD_FORCE_CONSOLE_TRACE" ), nullptr );
if( forceLog )
{
wxLog::EnableLogging( true );
#ifndef DEBUG
wxLog::SetLogLevel( wxLOG_Trace );
#endif;
wxLog::SetActiveTarget( new wxLogStderr );
}
return true;
}
bool KIPLATFORM::APP::IsOperatingSystemUnsupported()
{
#if defined( PYTHON_VERSION_MAJOR ) && ( ( PYTHON_VERSION_MAJOR == 3 && PYTHON_VERSION_MINOR >= 8 ) \
|| PYTHON_VERSION_MAJOR > 3 )
// Python 3.8 switched to Windows 8+ API, we do not support Windows 7 and will not
// attempt to hack around it. A normal user will never get here because the Python DLL
// is missing dependencies - and because it is not dynamically loaded, KiCad will not even
// start without patching Python or its WinAPI dependency. This is just to create a nag dialog
// for those who run patched Python and prevent them from submitting bug reports.
return !IsWindows8OrGreater();
#else
return false;
#endif
}
bool KIPLATFORM::APP::RegisterApplicationRestart( const wxString& aCommandLine )
{
// Command line arguments with spaces require quotes.
wxString restartCmd = wxS( "\"" ) + aCommandLine + wxS( "\"" );
// Ensure we don't exceed the maximum allowable size
if( restartCmd.length() > RESTART_MAX_CMD_LINE - 1 )
{
return false;
}
HRESULT hr = S_OK;
hr = ::RegisterApplicationRestart( restartCmd.wc_str(), RESTART_NO_PATCH );
return SUCCEEDED( hr );
}
bool KIPLATFORM::APP::UnregisterApplicationRestart()
{
// Note, this isn't required to be used on Windows if you are just closing the program
return SUCCEEDED( ::UnregisterApplicationRestart() );
}
bool KIPLATFORM::APP::SupportsShutdownBlockReason()
{
return true;
}
void KIPLATFORM::APP::RemoveShutdownBlockReason( wxWindow* aWindow )
{
// Destroys any block reason that may have existed
ShutdownBlockReasonDestroy( aWindow->GetHandle() );
}
void KIPLATFORM::APP::SetShutdownBlockReason( wxWindow* aWindow, const wxString& aReason )
{
// Sets up the pretty message on the shutdown page on why it's being "blocked"
// This is used in conjunction with handling WM_QUERYENDSESSION (wxCloseEvent)
// ShutdownBlockReasonCreate does not block by itself
ShutdownBlockReasonDestroy( aWindow->GetHandle() ); // Destroys any existing or nonexisting reason
ShutdownBlockReasonCreate( aWindow->GetHandle(), aReason.wc_str() );
}
void KIPLATFORM::APP::ForceTimerMessagesToBeCreatedIfNecessary()
{
// Taken from https://devblogs.microsoft.com/oldnewthing/20191108-00/?p=103080
MSG msg;
PeekMessage( &msg, nullptr, WM_TIMER, WM_TIMER, PM_NOREMOVE );
}
void KIPLATFORM::APP::AddDynamicLibrarySearchPath( const wxString& aPath )
{
SetDllDirectory( aPath.c_str() );
}