kicad/common/widgets/progress_reporter.cpp

218 lines
5.4 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2017 CERN
2021-07-14 19:47:32 +00:00
* Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
*
* Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* 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 2
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <widgets/progress_reporter.h>
#include <wx/evtloop.h>
#include <thread>
PROGRESS_REPORTER::PROGRESS_REPORTER( int aNumPhases ) :
m_msgChanged( false ),
m_phase( 0 ),
m_numPhases( aNumPhases ),
m_progress( 0 ),
m_maxProgress( 1000 ),
m_cancelled( false )
{
2018-02-09 13:20:11 +00:00
}
void PROGRESS_REPORTER::BeginPhase( int aPhase )
{
m_phase.store( aPhase );
m_progress.store( 0 );
}
2018-02-09 13:20:11 +00:00
2020-09-14 17:54:14 +00:00
void PROGRESS_REPORTER::AdvancePhase()
{
m_phase.fetch_add( 1 );
m_progress.store( 0 );
}
2018-02-09 13:20:11 +00:00
2020-09-14 17:54:14 +00:00
void PROGRESS_REPORTER::AdvancePhase( const wxString& aMessage )
{
AdvancePhase();
Report( aMessage );
}
void PROGRESS_REPORTER::Report( const wxString& aMessage )
{
std::lock_guard<std::mutex> guard( m_mutex );
2018-02-09 13:20:11 +00:00
m_rptMessage = aMessage;
m_msgChanged = true;
}
2018-02-09 13:20:11 +00:00
void PROGRESS_REPORTER::SetMaxProgress( int aMaxProgress )
{
m_maxProgress.store( aMaxProgress );
}
void PROGRESS_REPORTER::SetCurrentProgress( double aProgress )
{
m_maxProgress.store( 1000 );
2021-07-14 19:47:32 +00:00
m_progress.store( (int) ( aProgress * 1000.0 ) );
}
2018-02-09 13:20:11 +00:00
void PROGRESS_REPORTER::AdvanceProgress()
{
m_progress.fetch_add( 1 );
}
2018-02-09 13:20:11 +00:00
void PROGRESS_REPORTER::SetNumPhases( int aNumPhases )
{
m_numPhases = aNumPhases;
}
2020-09-14 17:54:14 +00:00
void PROGRESS_REPORTER::AddPhases( int aNumPhases )
{
m_numPhases += aNumPhases;
}
int PROGRESS_REPORTER::currentProgress() const
{
2018-02-09 13:20:11 +00:00
double current = ( 1.0 / (double) m_numPhases ) *
( (double) m_phase + ( (double) m_progress.load() / (double) m_maxProgress ) );
2018-02-09 13:20:11 +00:00
return (int)( current * 1000 );
}
2018-02-09 13:20:11 +00:00
bool PROGRESS_REPORTER::KeepRefreshing( bool aWait )
{
if( aWait )
{
while( m_progress.load() < m_maxProgress && m_maxProgress > 0 )
{
if( !updateUI() )
{
m_cancelled.store( true );
return false;
}
wxMilliSleep( 20 );
}
2021-07-14 19:47:32 +00:00
return true;
}
else
{
if( !updateUI() )
{
m_cancelled.store( true );
return false;
}
return true;
}
}
WX_PROGRESS_REPORTER::WX_PROGRESS_REPORTER( wxWindow* aParent, const wxString& aTitle,
int aNumPhases, bool aCanAbort,
bool aReserveSpaceForMessage ) :
PROGRESS_REPORTER( aNumPhases ),
wxProgressDialog( aTitle, ( aReserveSpaceForMessage ? wxT( " " ) : wxT( "" ) ), 1, aParent,
// wxPD_APP_MODAL | // Don't use; messes up OSX when called from
// quasi-modal dialog
wxPD_AUTO_HIDE | // *MUST* use; otherwise wxWidgets will spin
// up another event loop on completion which
// causes all sorts of grief
( aCanAbort ? wxPD_CAN_ABORT : 0 ) |
wxPD_ELAPSED_TIME )
#if wxCHECK_VERSION( 3, 1, 0 )
2020-11-07 21:40:56 +00:00
,
m_appProgressIndicator( aParent )
#endif
{
#if wxCHECK_VERSION( 3, 1, 0 )
// wxAppProgressIndicator doesn't like value > max, ever. However there are some risks
// with multithreaded setting of those values making a mess
// the cop out is just to set the progress to "indeterminate"
m_appProgressIndicator.Pulse();
#endif
}
WX_PROGRESS_REPORTER::~WX_PROGRESS_REPORTER()
{
}
bool WX_PROGRESS_REPORTER::updateUI()
{
int cur = currentProgress();
if( cur < 0 || cur > 1000 )
cur = 0;
bool msgChanged = false;
wxString message;
2021-07-14 19:47:32 +00:00
{
std::lock_guard<std::mutex> guard( m_mutex );
message = m_rptMessage;
msgChanged = m_msgChanged;
m_msgChanged = false;
}
SetRange( 1000 );
bool diag = wxProgressDialog::Update( cur, message );
if( msgChanged )
Fit();
return diag;
}
2018-02-09 13:20:11 +00:00
GAUGE_PROGRESS_REPORTER::GAUGE_PROGRESS_REPORTER( wxWindow* aParent, int aNumPhases ) :
PROGRESS_REPORTER( aNumPhases ),
2020-11-07 21:40:56 +00:00
wxGauge( aParent, wxID_ANY, 1000, wxDefaultPosition, wxDefaultSize, wxGA_HORIZONTAL,
wxDefaultValidator, wxGaugeNameStr )
{
}
bool GAUGE_PROGRESS_REPORTER::updateUI()
{
int cur = currentProgress();
if( cur < 0 || cur > 1000 )
cur = 0;
wxGauge::SetValue( cur );
2021-07-14 19:47:32 +00:00
wxEventLoopBase::GetActive()->YieldFor( wxEVT_CATEGORY_UI );
return true; // No cancel button on a wxGauge
}