2017-11-23 16:20:27 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2017 CERN
|
|
|
|
* 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>
|
2018-04-16 22:18:02 +00:00
|
|
|
#include <wx/evtloop.h>
|
2017-11-23 16:20:27 +00:00
|
|
|
#include <thread>
|
|
|
|
|
|
|
|
PROGRESS_REPORTER::PROGRESS_REPORTER( int aNumPhases ) :
|
|
|
|
m_phase( 0 ),
|
2017-12-04 18:25:12 +00:00
|
|
|
m_numPhases( aNumPhases ),
|
2017-12-05 00:37:26 +00:00
|
|
|
m_progress( 0 ),
|
2020-08-04 18:53:16 +00:00
|
|
|
m_maxProgress( 1 ),
|
|
|
|
m_cancelled( false )
|
2017-11-23 16:20:27 +00:00
|
|
|
{
|
2018-02-09 13:20:11 +00:00
|
|
|
}
|
|
|
|
|
2017-11-23 16:20:27 +00:00
|
|
|
|
|
|
|
void PROGRESS_REPORTER::BeginPhase( int aPhase )
|
|
|
|
{
|
2018-02-10 13:32:57 +00:00
|
|
|
m_phase.store( aPhase );
|
|
|
|
m_progress.store( 0 );
|
2017-11-23 16:20:27 +00:00
|
|
|
}
|
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
|
2017-11-23 16:20:27 +00:00
|
|
|
void PROGRESS_REPORTER::AdvancePhase( )
|
|
|
|
{
|
2018-02-10 13:32:57 +00:00
|
|
|
m_phase.fetch_add( 1 );
|
|
|
|
m_progress.store( 0 );
|
2017-11-23 16:20:27 +00:00
|
|
|
}
|
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
|
2017-11-23 16:20:27 +00:00
|
|
|
void PROGRESS_REPORTER::Report( const wxString& aMessage )
|
|
|
|
{
|
2018-02-10 13:32:57 +00:00
|
|
|
std::lock_guard<std::mutex> guard( m_mutex );
|
2018-02-09 13:20:11 +00:00
|
|
|
m_rptMessage = aMessage;
|
2017-11-23 16:20:27 +00:00
|
|
|
}
|
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
|
|
|
|
void PROGRESS_REPORTER::SetMaxProgress( int aMaxProgress )
|
2017-11-23 16:20:27 +00:00
|
|
|
{
|
2018-02-10 13:32:57 +00:00
|
|
|
m_maxProgress.store( aMaxProgress );
|
2017-11-23 16:20:27 +00:00
|
|
|
}
|
|
|
|
|
2020-06-18 16:54:58 +00:00
|
|
|
void PROGRESS_REPORTER::SetCurrentProgress( double aProgress )
|
|
|
|
{
|
|
|
|
m_maxProgress.store( 10000 );
|
|
|
|
m_progress.store( (int) (aProgress * 10000.0) );
|
|
|
|
}
|
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
|
|
|
|
void PROGRESS_REPORTER::AdvanceProgress()
|
2017-11-23 16:20:27 +00:00
|
|
|
{
|
2018-02-10 13:32:57 +00:00
|
|
|
m_progress.fetch_add( 1 );
|
2017-11-23 16:20:27 +00:00
|
|
|
}
|
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
|
2017-11-23 16:20:27 +00:00
|
|
|
int PROGRESS_REPORTER::currentProgress() const
|
|
|
|
{
|
2018-02-09 13:20:11 +00:00
|
|
|
double current = ( 1.0 / (double) m_numPhases ) *
|
2018-01-15 16:57:03 +00:00
|
|
|
( (double) m_phase + ( (double) m_progress.load() / (double) m_maxProgress ) );
|
2017-11-23 16:20:27 +00:00
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
return (int)( current * 1000 );
|
2017-11-23 16:20:27 +00:00
|
|
|
}
|
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
|
2018-02-10 13:32:57 +00:00
|
|
|
bool PROGRESS_REPORTER::KeepRefreshing( bool aWait )
|
|
|
|
{
|
|
|
|
if( aWait )
|
|
|
|
{
|
|
|
|
while( m_progress < m_maxProgress && m_maxProgress > 0 )
|
|
|
|
{
|
|
|
|
if( !updateUI() )
|
2020-08-04 18:53:16 +00:00
|
|
|
{
|
|
|
|
m_cancelled.store( true );
|
2018-02-10 13:32:57 +00:00
|
|
|
return false;
|
2020-08-04 18:53:16 +00:00
|
|
|
}
|
2018-02-10 13:32:57 +00:00
|
|
|
|
|
|
|
wxMilliSleep( 20 );
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2020-08-04 18:53:16 +00:00
|
|
|
if( !updateUI() )
|
|
|
|
{
|
|
|
|
m_cancelled.store( true );
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
2018-02-10 13:32:57 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
WX_PROGRESS_REPORTER::WX_PROGRESS_REPORTER( wxWindow* aParent, const wxString& aTitle,
|
2018-02-21 02:58:53 +00:00
|
|
|
int aNumPhases, bool aCanAbort ) :
|
2017-11-23 16:20:27 +00:00
|
|
|
PROGRESS_REPORTER( aNumPhases ),
|
2018-02-10 13:32:57 +00:00
|
|
|
wxProgressDialog( aTitle, 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
|
2018-02-21 02:58:53 +00:00
|
|
|
( aCanAbort ? wxPD_CAN_ABORT : 0 ) |
|
2018-01-15 16:57:03 +00:00
|
|
|
wxPD_ELAPSED_TIME )
|
2020-08-09 10:55:00 +00:00
|
|
|
#if wxCHECK_VERSION( 3, 1, 0 )
|
|
|
|
,m_appProgressIndicator( aParent )
|
|
|
|
#endif
|
2017-11-23 16:20:27 +00:00
|
|
|
{
|
2020-08-09 10:55:00 +00:00
|
|
|
#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
|
2017-11-23 16:20:27 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
WX_PROGRESS_REPORTER::~WX_PROGRESS_REPORTER()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2018-02-10 13:32:57 +00:00
|
|
|
bool WX_PROGRESS_REPORTER::updateUI()
|
2017-11-23 16:20:27 +00:00
|
|
|
{
|
|
|
|
int cur = currentProgress();
|
2017-12-04 18:25:12 +00:00
|
|
|
|
|
|
|
if( cur < 0 || cur > 1000 )
|
|
|
|
cur = 0;
|
|
|
|
|
2018-02-10 13:32:57 +00:00
|
|
|
wxString message;
|
|
|
|
{
|
|
|
|
std::lock_guard<std::mutex> guard( m_mutex );
|
|
|
|
message = m_rptMessage;
|
|
|
|
}
|
|
|
|
|
2017-11-23 16:20:27 +00:00
|
|
|
SetRange( 1000 );
|
2018-02-10 13:32:57 +00:00
|
|
|
return wxProgressDialog::Update( cur, message );
|
2017-12-05 00:37:26 +00:00
|
|
|
}
|
|
|
|
|
2018-02-09 13:20:11 +00:00
|
|
|
|
2018-04-16 22:18:02 +00:00
|
|
|
GAUGE_PROGRESS_REPORTER::GAUGE_PROGRESS_REPORTER( wxWindow* aParent, int aNumPhases ) :
|
|
|
|
PROGRESS_REPORTER( aNumPhases ),
|
|
|
|
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 );
|
|
|
|
wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI);
|
|
|
|
|
|
|
|
return true; // No cancel button on a wxGauge
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|