KiCad PCB EDA Suite
wx_progress_reporters.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2017 CERN
5  * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * Author: Tomasz Wlostowski <[email protected]>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #include <wx/evtloop.h>
28 #include <thread>
30 
31 
32 WX_PROGRESS_REPORTER::WX_PROGRESS_REPORTER( wxWindow* aParent, const wxString& aTitle,
33  int aNumPhases, bool aCanAbort,
34  bool aReserveSpaceForMessage ) :
35  PROGRESS_REPORTER_BASE( aNumPhases ),
36  wxProgressDialog( aTitle, ( aReserveSpaceForMessage ? wxT( " " ) : wxT( "" ) ), 1, aParent,
37  // wxPD_APP_MODAL | // Don't use; messes up OSX when called from
38  // quasi-modal dialog
39  wxPD_AUTO_HIDE | // *MUST* use; otherwise wxWidgets will spin
40  // up another event loop on completion which
41  // causes all sorts of grief
42  ( aCanAbort ? wxPD_CAN_ABORT : 0 ) |
43  wxPD_ELAPSED_TIME )
44 #if wxCHECK_VERSION( 3, 1, 0 )
45  ,
46  m_appProgressIndicator( aParent )
47 #endif
48 {
49 #if wxCHECK_VERSION( 3, 1, 0 )
50  // wxAppProgressIndicator doesn't like value > max, ever. However there are some risks
51  // with multithreaded setting of those values making a mess
52  // the cop out is just to set the progress to "indeterminate"
53  m_appProgressIndicator.Pulse();
54 #endif
55 }
56 
57 
59 {
60 }
61 
62 
64 {
65  int cur = currentProgress();
66 
67  if( cur < 0 || cur > 1000 )
68  cur = 0;
69 
70  bool msgChanged = false;
71  wxString message;
72 
73  {
74  std::lock_guard<std::mutex> guard( m_mutex );
75  message = m_rptMessage;
76  msgChanged = m_msgChanged;
77  m_msgChanged = false;
78  }
79 
80  SetRange( 1000 );
81  bool diag = wxProgressDialog::Update( cur, message );
82 
83  if( msgChanged )
84  Fit();
85 
86  return diag;
87 }
88 
89 
90 GAUGE_PROGRESS_REPORTER::GAUGE_PROGRESS_REPORTER( wxWindow* aParent, int aNumPhases ) :
91  PROGRESS_REPORTER_BASE( aNumPhases ),
92  wxGauge( aParent, wxID_ANY, 1000, wxDefaultPosition, wxDefaultSize, wxGA_HORIZONTAL,
93  wxDefaultValidator, wxGaugeNameStr )
94 {
95 }
96 
97 
99 {
100  int cur = currentProgress();
101 
102  if( cur < 0 || cur > 1000 )
103  cur = 0;
104 
105  wxGauge::SetValue( cur );
106  wxEventLoopBase::GetActive()->YieldFor( wxEVT_CATEGORY_UI );
107 
108  return true; // No cancel button on a wxGauge
109 }
WX_PROGRESS_REPORTER(wxWindow *aParent, const wxString &aTitle, int aNumPhases, bool aCanAbort=true, bool aReserveSpaceForMessage=true)
The PROGRESS_REPORTER will stay on top of aParent.
GAUGE_PROGRESS_REPORTER(wxWindow *aParent, int aNumPhases)
This implements all the tricky bits for thread safety, but the GUI is left to derived classes.