kicad/common/widgets/progress_reporter_base.cpp

140 lines
3.2 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2017 CERN
* Copyright (C) 2021-2022 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 <wx/evtloop.h>
#include <thread>
#include <widgets/progress_reporter_base.h>
PROGRESS_REPORTER_BASE::PROGRESS_REPORTER_BASE( int aNumPhases ) :
PROGRESS_REPORTER(),
m_phase( 0 ),
m_numPhases( aNumPhases ),
m_progress( 0 ),
m_maxProgress( 1000 ),
m_cancelled( false )
{
}
void PROGRESS_REPORTER_BASE::BeginPhase( int aPhase )
{
m_phase.store( aPhase );
m_progress.store( 0 );
}
void PROGRESS_REPORTER_BASE::AdvancePhase()
{
m_phase.fetch_add( 1 );
m_progress.store( 0 );
}
void PROGRESS_REPORTER_BASE::AdvancePhase( const wxString& aMessage )
{
AdvancePhase();
Report( aMessage );
}
void PROGRESS_REPORTER_BASE::Report( const wxString& aMessage )
{
std::lock_guard<std::mutex> guard( m_mutex );
m_rptMessage = aMessage;
}
void PROGRESS_REPORTER_BASE::SetMaxProgress( int aMaxProgress )
{
m_maxProgress.store( aMaxProgress );
}
void PROGRESS_REPORTER_BASE::SetCurrentProgress( double aProgress )
{
m_maxProgress.store( 1000 );
m_progress.store( (int) ( aProgress * 1000.0 ) );
}
void PROGRESS_REPORTER_BASE::AdvanceProgress()
{
m_progress.fetch_add( 1 );
}
void PROGRESS_REPORTER_BASE::SetNumPhases( int aNumPhases )
{
m_numPhases = aNumPhases;
}
void PROGRESS_REPORTER_BASE::AddPhases( int aNumPhases )
{
m_numPhases += aNumPhases;
}
int PROGRESS_REPORTER_BASE::currentProgress() const
{
double current = ( 1.0 / (double) m_numPhases ) *
( (double) m_phase + ( (double) m_progress.load() / (double) m_maxProgress ) );
return (int)( current * 1000 );
}
bool PROGRESS_REPORTER_BASE::KeepRefreshing( bool aWait )
{
if( aWait )
{
while( m_progress.load() < m_maxProgress && m_maxProgress > 0 )
{
if( !updateUI() )
{
m_cancelled.store( true );
return false;
}
wxMilliSleep( 33 /* 30 FPS refresh rate */ );
}
return true;
}
else
{
if( !updateUI() )
{
m_cancelled.store( true );
return false;
}
return true;
}
}