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) 2022 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
32WX_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 ) | wxPD_ELAPSED_TIME ),
43#if wxCHECK_VERSION( 3, 1, 0 )
44 m_appProgressIndicator( aParent ),
45#endif
46 m_messageWidth( 0 )
47{
48#if wxCHECK_VERSION( 3, 1, 0 )
49 // wxAppProgressIndicator doesn't like value > max, ever. However there are some risks
50 // with multithreaded setting of those values making a mess
51 // the cop out is just to set the progress to "indeterminate"
52 m_appProgressIndicator.Pulse();
53#endif
54}
55
56
58{
59}
60
61
63{
64 int cur = currentProgress();
65
66 if( cur < 0 || cur > 1000 )
67 cur = 0;
68
69 SetRange( 1000 );
70
71 wxString message;
72
73 {
74 std::lock_guard<std::mutex> guard( m_mutex );
75 message = m_rptMessage;
76 }
77
78 // Perhaps the window size is too small if the new message to display is bigger
79 // than the previous message. in this case, resize the WX_PROGRESS_REPORTER window
80 // GetTextExtent has probably bugs in wxWidgets < 3.1.6, so calling it only when
81 // the message has changed is mandatory
83 {
84 int newWidth = GetTextExtent( m_rptMessage ).x;
85
86 if( newWidth > m_messageWidth )
87 {
88 m_messageWidth = newWidth;
89 Fit();
90 }
91
92 m_messageChanged = false;
93 }
94
95 bool diag = wxProgressDialog::Update( cur, message );
96
97 return diag;
98}
99
100
101GAUGE_PROGRESS_REPORTER::GAUGE_PROGRESS_REPORTER( wxWindow* aParent, int aNumPhases ) :
102 PROGRESS_REPORTER_BASE( aNumPhases ),
103 wxGauge( aParent, wxID_ANY, 1000, wxDefaultPosition, wxDefaultSize, wxGA_HORIZONTAL,
104 wxDefaultValidator, wxGaugeNameStr )
105{
106}
107
108
110{
111 int cur = currentProgress();
112
113 if( cur < 0 || cur > 1000 )
114 cur = 0;
115
116 wxGauge::SetValue( cur );
117 wxEventLoopBase::GetActive()->YieldFor( wxEVT_CATEGORY_UI );
118
119 return true; // No cancel button on a wxGauge
120}
GAUGE_PROGRESS_REPORTER(wxWindow *aParent, int aNumPhases)
This implements all the tricky bits for thread safety, but the GUI is left to derived classes.
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.