KiCad PCB EDA Suite
Loading...
Searching...
No Matches
panel_packages_view.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) 2021 Andrew Lutsenko, anlutsenko at gmail dot com
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include "panel_packages_view.h"
22#include <grid_tricks.h>
23#include <widgets/html_window.h>
24#include <pgm_base.h>
25#include <kiplatform/ui.h>
29#include <string_utils.h>
30#include <widgets/wx_panel.h>
32
33#include <cmath>
34#include <fstream>
35#include <wx/filedlg.h>
36#include <wx/font.h>
37#include <wx/tokenzr.h>
38
39
40#define GRID_CELL_MARGIN 4
41
42
43std::unordered_map<PCM_PACKAGE_VERSION_STATUS, wxString> PANEL_PACKAGES_VIEW::STATUS_ENUM_TO_STR = {
44 { PVS_INVALID, wxS( "invalid" ) },
45 { PVS_STABLE, wxS( "stable" ) },
46 { PVS_TESTING, wxS( "testing" ) },
47 { PVS_DEVELOPMENT, wxS( "development" ) },
48 { PVS_DEPRECATED, wxS( "deprecated" ) }
49};
50
51
53 std::shared_ptr<PLUGIN_CONTENT_MANAGER> aPcm,
54 const ActionCallback& aActionCallback,
55 const PinCallback& aPinCallback ) :
57 m_actionCallback( aActionCallback ),
58 m_pinCallback( aPinCallback ),
59 m_pcm( aPcm )
60{
61 // Replace wxFormBuilder's sash initializer with one which will respect m_initialSashPos.
62 m_splitter1->Disconnect( wxEVT_IDLE,
64 NULL, this );
65 m_splitter1->Connect( wxEVT_IDLE, wxIdleEventHandler( PANEL_PACKAGES_VIEW::SetSashOnIdle ),
66 NULL, this );
67
68 m_splitter1->SetPaneMinimums( FromDIP( 350 ), FromDIP( 450 ) );
69
70#ifdef __WXGTK__
71 // wxSearchCtrl vertical height is not calculated correctly on some GTK setups
72 // See https://gitlab.com/kicad/code/kicad/-/issues/9019
73 m_searchCtrl->SetMinSize( wxSize( -1, GetTextExtent( wxT( "qb" ) ).y + 10 ) );
74#endif
75
77 m_searchCtrl->SetDescriptiveText( _( "Filter" ) );
78
79 m_panelList->SetBorders( false, true, false, false );
80
81 m_gridVersions->PushEventHandler( new GRID_TRICKS( m_gridVersions ) );
82
83 for( int col = 0; col < m_gridVersions->GetNumberCols(); col++ )
84 {
85 const wxString& heading = m_gridVersions->GetColLabelValue( col );
86 int headingWidth = GetTextExtent( heading ).x + 2 * GRID_CELL_MARGIN;
87
88 // Set the minimal width to the column label size.
89 m_gridVersions->SetColMinimalWidth( col, headingWidth );
90 m_gridVersions->SetColSize( col, m_gridVersions->GetVisibleWidth( col ) );
91 }
92
93 // Most likely should be changed to wxGridSelectNone once WxWidgets>=3.1.5 is mandatory.
94 m_gridVersions->SetSelectionMode( WX_GRID::wxGridSelectRows );
95
96 wxColor background = wxStaticText::GetClassDefaultAttributes().colBg;
97 m_panelList->SetBackgroundColour( background );
98 m_packageListWindow->SetBackgroundColour( background );
99 m_infoScrollWindow->SetBackgroundColour( background );
100 m_infoScrollWindow->EnableScrolling( false, true );
101
102 ClearData();
103}
104
105
107{
108 m_splitter1->Disconnect( wxEVT_IDLE, wxIdleEventHandler( PANEL_PACKAGES_VIEW::SetSashOnIdle ), nullptr, this );
109
111 cfg->m_PackageManager.sash_pos = m_splitter1->GetSashPosition();
112
113 m_gridVersions->PopEventHandler( true );
114}
115
116
118{
120
121 m_currentSelected = nullptr;
122 m_updateablePackages.clear();
123 m_packagePanels.clear();
124 m_packageInitialOrder.clear();
125 m_packageListWindow->GetSizer()->Clear( true ); // Delete panels
126 m_packageListWindow->GetSizer()->FitInside( m_packageListWindow );
127 m_packageListWindow->Layout();
128}
129
130
131void PANEL_PACKAGES_VIEW::SetData( const std::vector<PACKAGE_VIEW_DATA>& aPackageData )
132{
133 ClearData();
134
135 for( const PACKAGE_VIEW_DATA& data : aPackageData )
136 {
138 m_pinCallback, data );
139
140 package_panel->SetSelectCallback(
141 [package_panel, this] ()
142 {
143 if( m_currentSelected && m_currentSelected != package_panel )
144 m_currentSelected->SetSelected( false );
145
146 package_panel->SetSelected( true );
147 m_currentSelected = package_panel;
148 setPackageDetails( package_panel->GetPackageData() );
149
150 Layout();
151 } );
152
153 m_packagePanels.insert( { data.package.identifier, package_panel } );
154 m_packageInitialOrder.push_back( data.package.identifier );
155
156 if( data.state == PPS_UPDATE_AVAILABLE && !data.pinned )
157 m_updateablePackages.insert( data.package.identifier );
158 }
159
162}
163
164
166{
167 const PCM_PACKAGE& package = aPackageData.package;
168
169 // Details
170 wxString details;
171
172 details << wxT( "<h5>" ) + package.name + wxT( "</h5>" );
173
174 auto format_desc =
175 []( const wxString& text ) -> wxString
176 {
177 wxString result;
178 bool inURL = false;
179 wxString url;
180
181 for( unsigned i = 0; i < text.length(); ++i )
182 {
183 wxUniChar c = text[i];
184
185 if( inURL )
186 {
187 if( c == ' ' || c == '\n')
188 {
189 result += wxString::Format( wxT( "<a href='%s'>%s</a>" ), url, url );
190 inURL = false;
191
192 if( c == '\n' )
193 result += wxT( "</p><p>" );
194 else
195 result += c;
196 }
197 else
198 {
199 url += c;
200 }
201 }
202 else if( text.Mid( i, 5 ) == wxT( "http:" )
203 || text.Mid( i, 6 ) == wxT( "https:" ) )
204 {
205 url = c;
206 inURL = true;
207 }
208 else if( c == '\n' )
209 {
210 result += wxT( "</p><p>" );
211 }
212 else
213 {
214 result += c;
215 }
216 }
217
218 if( inURL )
219 result += wxString::Format( wxT( "<a href='%s'>%s</a>" ), url, url );
220
221 return result;
222 };
223
224 wxString desc = package.description_full;
225 details << wxT( "<p>" ) + format_desc( desc ) + wxT( "</p>" );
226
227 details << wxT( "<p><b>" ) + _( "Metadata" ) + wxT( "</b></p>" );
228 details << wxT( "<ul>" );
229 details << wxT( "<li>" ) + _( "Package identifier: " ) + package.identifier + wxT( "</li>" );
230 details << wxT( "<li>" ) + _( "License: " ) + package.license + wxT( "</li>" );
231
232 if( package.tags.size() > 0 )
233 {
234 wxString tags_str;
235
236 for( const std::string& tag : package.tags )
237 {
238 if( !tags_str.IsEmpty() )
239 tags_str += ", ";
240
241 tags_str += tag;
242 }
243
244 details << wxT( "<li>" ) + _( "Tags: " ) + tags_str + wxT( "</li>" );
245 }
246
247 auto format_entry =
248 []( const std::pair<const std::string, wxString>& entry ) -> wxString
249 {
250 wxString name = entry.first;
251 wxString url = EscapeHTML( entry.second );
252
253 if( name == wxT( "email" ) )
254 return wxString::Format( wxT( "<a href='mailto:%s'>%s</a>" ), url, url );
255 else if( url.StartsWith( wxT( "http:" ) ) || url.StartsWith( wxT( "https:" ) ) )
256 return wxString::Format( wxT( "<a href='%s'>%s</a>" ), url, url );
257 else
258 return entry.second;
259 };
260
261 auto write_contact =
262 [&]( const wxString& type, const PCM_CONTACT& contact )
263 {
264 details << wxT( "<li>" ) + type + wxT( ": " ) + contact.name + wxT( "<ul>" );
265
266 for( const std::pair<const std::string, wxString>& entry : contact.contact )
267 {
268 details << wxT( "<li>" );
269 details << entry.first << wxT( ": " ) + format_entry( entry );
270 details << wxT( "</li>" );
271 }
272
273 details << wxT( "</ul>" );
274 };
275
276 write_contact( _( "Author" ), package.author );
277
278 if( package.maintainer )
279 write_contact( _( "Maintainer" ), *package.maintainer );
280
281 if( package.resources.size() > 0 )
282 {
283 details << wxT( "<li>" ) + _( "Resources" ) + wxT( "<ul>" );
284
285 for( const std::pair<const std::string, wxString>& entry : package.resources )
286 {
287 details << wxT( "<li>" );
288 details << entry.first << wxT( ": " );
289 details << format_entry( entry ) + wxT( "</li>" );
290 }
291
292 details << wxT( "</ul>" );
293 }
294
295 details << wxT( "</ul>" );
296
297 m_infoText->SetPage( details );
298
299 wxSizeEvent dummy;
301
302 // Versions table
303 m_gridVersions->Freeze();
304 m_gridVersions->ClearRows();
305
306 int row = 0;
307 wxString current_version;
308
309 if( aPackageData.state == PPS_INSTALLED || aPackageData.state == PPS_UPDATE_AVAILABLE )
310 current_version = m_pcm->GetInstalledPackageVersion( package.identifier );
311
312 wxFont bold_font = m_gridVersions->GetDefaultCellFont().Bold();
313
314 for( const PACKAGE_VERSION& version : package.versions )
315 {
316 if( !version.compatible && !m_showAllVersions->IsChecked() )
317 continue;
318
319 m_gridVersions->InsertRows( row );
320
321 m_gridVersions->SetCellValue( row, COL_VERSION, version.version );
322 m_gridVersions->SetCellValue( row, COL_DOWNLOAD_SIZE, toHumanReadableSize( version.download_size ) );
323 m_gridVersions->SetCellValue( row, COL_INSTALL_SIZE, toHumanReadableSize( version.install_size ) );
324 m_gridVersions->SetCellValue( row, COL_COMPATIBILITY, version.compatible ? wxT( "\u2714" ) : wxEmptyString );
325 m_gridVersions->SetCellValue( row, COL_STATUS, STATUS_ENUM_TO_STR.at( version.status ) );
326
327 m_gridVersions->SetCellAlignment( row, COL_COMPATIBILITY, wxALIGN_CENTER, wxALIGN_CENTER );
328
329 if( current_version == version.version )
330 {
331 for( int col = 0; col < m_gridVersions->GetNumberCols(); col++ )
332 m_gridVersions->SetCellFont( row, col, bold_font );
333 }
334
335 row++;
336 }
337
338 for( int col = 0; col < m_gridVersions->GetNumberCols(); col++ )
339 {
340 // Set the width to see the full contents
341 m_gridVersions->SetColSize( col, m_gridVersions->GetVisibleWidth( col ) );
342 }
343
344 // Autoselect preferred or installed version
345 if( m_gridVersions->GetNumberRows() >= 1 )
346 {
347 wxString version = m_currentSelected->GetPackageData().current_version;
348
349 if( version.IsEmpty() )
350 version = m_currentSelected->GetPreferredVersion();
351
352 if( !version.IsEmpty() )
353 {
354 for( int i = 0; i < m_gridVersions->GetNumberRows(); i++ )
355 {
356 if( m_gridVersions->GetCellValue( i, COL_VERSION ) == version )
357 {
358 m_gridVersions->SelectRow( i );
359 m_gridVersions->SetGridCursor( i, COL_VERSION );
360 break;
361 }
362 }
363 }
364 else
365 {
366 // Fall back to first row.
367 m_gridVersions->SelectRow( 0 );
368 }
369 }
370
371 m_gridVersions->Thaw();
372
374
375 m_infoText->Show( true );
376 m_sizerVersions->Show( true );
377 m_sizerVersions->Layout();
378
379 wxSize size = m_infoScrollWindow->GetTargetWindow()->GetBestVirtualSize();
380 m_infoScrollWindow->SetVirtualSize( size );
381}
382
383
385{
386 m_infoText->SetPage( wxEmptyString );
387 m_infoText->Show( false );
388 m_sizerVersions->Show( false );
389
390 wxSize size = m_infoScrollWindow->GetTargetWindow()->GetBestVirtualSize();
391 m_infoScrollWindow->SetVirtualSize( size );
392
393 // Clean up grid just so we don't keep stale info around (it's already been hidden).
394 m_gridVersions->Freeze();
395 m_gridVersions->ClearRows();
396 m_gridVersions->Thaw();
397}
398
399
400wxString PANEL_PACKAGES_VIEW::toHumanReadableSize( const std::optional<uint64_t> size ) const
401{
402 if( !size )
403 return wxT( "-" );
404
405 uint64_t b = *size;
406
407 if( b >= 1024 * 1024 )
408 return wxString::Format( wxT( "%.1f MB" ), b / 1000.0 / 1000.0 );
409
410 if( b >= 1024 )
411 return wxString::Format( wxT( "%lld kB" ), b / 1000 );
412
413 return wxString::Format( wxT( "%lld B" ), b );
414}
415
416
418{
419 if( !m_currentSelected )
420 return false;
421
422 return m_gridVersions->GetNumberRows() == 1 || m_gridVersions->GetSelectedRows().size() == 1;
423}
424
425
427{
428 if( !m_currentSelected )
429 return false;
430
431 const PACKAGE_VIEW_DATA& packageData = m_currentSelected->GetPackageData();
432
433 switch( packageData.state )
434 {
437 case PPS_PENDING_UPDATE: return false;
438 default: break;
439 }
440
441 return m_gridVersions->GetNumberRows() == 1 || m_gridVersions->GetSelectedRows().size() == 1;
442}
443
444
445void PANEL_PACKAGES_VIEW::SetPackageState( const wxString& aPackageId, const PCM_PACKAGE_STATE aState,
446 const bool aPinned )
447{
448 auto it = m_packagePanels.find( aPackageId );
449
450 if( it != m_packagePanels.end() )
451 {
452 it->second->SetState( aState, aPinned );
453
454 if( m_currentSelected && m_currentSelected == it->second )
455 {
456 wxMouseEvent dummy;
457 m_currentSelected->OnClick( dummy );
458 }
459
460 if( aState == PPS_UPDATE_AVAILABLE && !aPinned )
461 m_updateablePackages.insert( aPackageId );
462 else
463 m_updateablePackages.erase( aPackageId );
464
466 }
467}
468
469
471{
472 m_gridVersions->ClearSelection();
473 m_gridVersions->SelectRow( event.GetRow() );
474
476}
477
478
480{
481 if( !canDownload() )
482 {
483 wxBell();
484 return;
485 }
486
487 if( m_gridVersions->GetNumberRows() == 1 )
488 m_gridVersions->SelectRow( 0 );
489
490 const wxArrayInt selectedRows = m_gridVersions->GetSelectedRows();
491
492 wxString version = m_gridVersions->GetCellValue( selectedRows[0], COL_VERSION );
493 const PCM_PACKAGE& package = m_currentSelected->GetPackageData().package;
494
495 auto ver_it = std::find_if( package.versions.begin(), package.versions.end(),
496 [&]( const PACKAGE_VERSION& ver )
497 {
498 return ver.version == version;
499 } );
500
501 wxASSERT_MSG( ver_it != package.versions.end(), "Could not find package version" );
502
503 if( !ver_it->download_url )
504 {
505 wxMessageBox( _( "Package download url is not specified" ), _( "Error downloading package" ),
506 wxICON_INFORMATION | wxOK, wxGetTopLevelParent( this ) );
507 return;
508 }
509
510 const wxString& url = *ver_it->download_url;
512
513 wxWindow* topLevelParent = wxGetTopLevelParent( this );
514 wxFileDialog dialog( topLevelParent, _( "Save Package" ), cfg->m_PcmLastDownloadDir,
515 wxString::Format( wxT( "%s_v%s.zip" ), package.identifier, version ),
516 wxT( "ZIP files (*.zip)|*.zip" ), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
517
518 if( dialog.ShowModal() == wxID_CANCEL )
519 return;
520
521 wxString path = dialog.GetPath();
522 cfg->m_PcmLastDownloadDir = wxPathOnly( path );
523
524 std::ofstream output( path.ToUTF8(), std::ios_base::binary );
525
526 WX_PROGRESS_REPORTER reporter( this, _( "Download Package" ), 1, PR_CAN_ABORT );
527
528 bool success = m_pcm->DownloadToStream( url, &output, &reporter, 0 );
529
530 output.close();
531
532 if( success )
533 {
534 if( ver_it->download_sha256 )
535 {
536 std::ifstream stream( path.ToUTF8(), std::ios_base::binary );
537
538 bool matches = m_pcm->VerifyHash( stream, *ver_it->download_sha256 );
539
540 stream.close();
541
542 if( !matches && wxMessageBox( _( "Integrity of the downloaded package could not be verified, hash "
543 "does not match. Are you sure you want to keep this file?" ),
544 _( "Keep downloaded file" ), wxICON_EXCLAMATION | wxYES_NO,
545 wxGetTopLevelParent( this ) )
546 == wxNO )
547 {
548 wxRemoveFile( path );
549 }
550 }
551 }
552 else
553 {
554 if( wxFileExists( path ) )
555 wxRemoveFile( path );
556 }
557}
558
559
561{
562 if( !canRunAction() )
563 {
564 wxBell();
565 return;
566 }
567
568 PCM_PACKAGE_ACTION action = getAction();
569
570 if( action == PPA_UNINSTALL )
571 {
573 m_currentSelected->GetPackageData().current_version );
574 return;
575 }
576
577 if( m_gridVersions->GetNumberRows() == 1 )
578 m_gridVersions->SelectRow( 0 );
579
580 const wxArrayInt selectedRows = m_gridVersions->GetSelectedRows();
581
582 wxString version = m_gridVersions->GetCellValue( selectedRows[0], COL_VERSION );
583 const PCM_PACKAGE& package = m_currentSelected->GetPackageData().package;
584
585 auto ver_it = std::find_if( package.versions.begin(), package.versions.end(),
586 [&]( const PACKAGE_VERSION& ver )
587 {
588 return ver.version == version;
589 } );
590
591 wxCHECK_RET( ver_it != package.versions.end(), "Could not find package version" );
592
593 if( !ver_it->compatible && wxMessageBox( _( "This package version is incompatible with your KiCad version or "
594 "platform. Are you sure you want to install it anyway?" ),
595 _( "Install package" ), wxICON_EXCLAMATION | wxYES_NO,
596 wxGetTopLevelParent( this ) )
597 == wxNO )
598 {
599 return;
600 }
601
602 m_actionCallback( m_currentSelected->GetPackageData(), action, version );
603}
604
605
607{
609 {
610 wxMouseEvent dummy;
611 m_currentSelected->OnClick( dummy );
612 }
613
615}
616
617
618void PANEL_PACKAGES_VIEW::OnSearchTextChanged( wxCommandEvent& event )
619{
621
623 m_currentSelected->SetSelected( false );
624
625 m_currentSelected = nullptr;
626
628}
629
630
632{
633 // Sort by descending rank, ascending index
634 std::vector<std::pair<int, int>> package_ranks;
635
636 const wxString search_term = m_searchCtrl->GetValue().Trim();
637
638 for( size_t index = 0; index < m_packageInitialOrder.size(); index++ )
639 {
640 int rank = 1;
641 const PCM_PACKAGE& pkg = m_packagePanels[m_packageInitialOrder[index]]->GetPackageData().package;
642
643 if( search_term.size() > 2 )
644 rank = m_pcm->GetPackageSearchRank( pkg, search_term );
645
646 // Packages with no versions are delisted and should not be shown
647 if( pkg.versions.size() == 0 )
648 rank = 0;
649
650 package_ranks.emplace_back( rank, index );
651 }
652
653 std::sort( package_ranks.begin(), package_ranks.end(),
654 []( const std::pair<int, int>& a, const std::pair<int, int>& b )
655 {
656 return a.first > b.first || ( a.first == b.first && a.second < b.second );
657 } );
658
659 // Rearrange panels, hide ones with 0 rank
660 wxSizer* sizer = m_packageListWindow->GetSizer();
661 sizer->Clear( false ); // Don't delete panels
662
663 for( const std::pair<int, int>& pair : package_ranks )
664 {
666
667 if( pair.first > 0 )
668 {
669 sizer->Add( panel, 0, wxEXPAND );
670 panel->Show();
671
672 if( !m_currentSelected )
673 {
674 wxMouseEvent dummy;
675 panel->OnClick( dummy );
676 }
677 }
678 else
679 {
680 panel->Hide();
681 }
682 }
683
684 m_packageListWindow->FitInside();
685 m_packageListWindow->SetScrollRate( 0, 15 );
686 m_packageListWindow->SendSizeEvent( wxSEND_EVENT_POST );
687}
688
689
691{
692 m_buttonDownload->Enable( canDownload() );
693
694 if( canRunAction() )
695 {
696 m_buttonAction->Enable();
697
698 PCM_PACKAGE_ACTION action = getAction();
699
700 switch( action )
701 {
702 case PPA_INSTALL: m_buttonAction->SetLabel( _( "Install" ) ); break;
703 case PPA_UNINSTALL: m_buttonAction->SetLabel( _( "Uninstall" ) ); break;
704 case PPA_UPDATE: m_buttonAction->SetLabel( _( "Update" ) ); break;
705 }
706 }
707 else
708 {
709 m_buttonAction->Disable();
710 m_buttonAction->SetLabel( _( "Pending" ) );
711 }
712}
713
714
716{
717 wxASSERT_MSG( m_gridVersions->GetNumberRows() == 1 || m_gridVersions->GetSelectedRows().size() == 1,
718 wxT( "getAction() called with ambiguous version selection" ) );
719
720 int selected_row = 0;
721
722 if( m_gridVersions->GetSelectedRows().size() == 1 )
723 selected_row = m_gridVersions->GetSelectedRows()[0];
724
725 wxString version = m_gridVersions->GetCellValue( selected_row, COL_VERSION );
726 const PACKAGE_VIEW_DATA& package = m_currentSelected->GetPackageData();
727
728 switch( package.state )
729 {
730 case PPS_AVAILABLE:
731 case PPS_UNAVAILABLE:
732 return PPA_INSTALL; // Only action for not installed package is to install it
733 case PPS_INSTALLED:
734 case PPS_UPDATE_AVAILABLE:
735 if( version == package.current_version )
736 return PPA_UNINSTALL;
737 else
738 return PPA_UPDATE;
739 default:
740 return PPA_INSTALL; // For pending states return value does not matter as button will be disabled
741 }
742}
743
744
745void PANEL_PACKAGES_VIEW::OnSizeInfoBox( wxSizeEvent& aEvent )
746{
747 wxSize infoSize = KIPLATFORM::UI::GetUnobscuredSize( m_infoText->GetParent() );
748 infoSize.x -= 10;
749 m_infoText->SetMinSize( infoSize );
750 m_infoText->SetMaxSize( infoSize );
751 m_infoText->SetSize( infoSize );
752 m_infoText->Layout();
753
754 infoSize.y = m_infoText->GetInternalRepresentation()->GetHeight() + 12;
755 m_infoText->SetMinSize( infoSize );
756 m_infoText->SetMaxSize( infoSize );
757 m_infoText->SetSize( infoSize );
758 m_infoText->Layout();
759
760 Refresh();
761}
762
763
764void PANEL_PACKAGES_VIEW::OnURLClicked( wxHtmlLinkEvent& aEvent )
765{
766 const wxHtmlLinkInfo& info = aEvent.GetLinkInfo();
767 ::wxLaunchDefaultBrowser( info.GetHref() );
768}
769
770
771void PANEL_PACKAGES_VIEW::OnInfoMouseWheel( wxMouseEvent& event )
772{
773 // Transfer scrolling from the info window to its parent scroll window
774 m_infoScrollWindow->HandleOnMouseWheel( event );
775}
776
777
778void PANEL_PACKAGES_VIEW::SetSashOnIdle( wxIdleEvent& aEvent )
779{
781 m_splitter1->SetSashPosition( cfg->m_PackageManager.sash_pos );
782
783 m_packageListWindow->FitInside();
784
785 m_splitter1->Disconnect( wxEVT_IDLE, wxIdleEventHandler( PANEL_PACKAGES_VIEW::SetSashOnIdle ), nullptr, this );
786}
787
788
793
794
795void PANEL_PACKAGES_VIEW::OnUpdateAllClicked( wxCommandEvent& event )
796{
797 // The map will be modified by the callback so we copy the list here
798 std::vector<wxString> packages;
799
800 std::copy( m_updateablePackages.begin(), m_updateablePackages.end(), std::back_inserter( packages ) );
801
802 for( const wxString& pkg_id : packages )
803 {
804 auto it = m_packagePanels.find( pkg_id );
805
806 if( it != m_packagePanels.end() )
807 {
808 const PACKAGE_VIEW_DATA& data = it->second->GetPackageData();
809
811 }
812 }
813}
int index
const char * name
PACKAGE_MANAGER m_PackageManager
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition grid_tricks.h:61
wxString m_PcmLastDownloadDir
void m_splitter1OnIdle(wxIdleEvent &)
PANEL_PACKAGES_VIEW_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxTAB_TRAVERSAL, const wxString &name=wxEmptyString)
void OnInfoMouseWheel(wxMouseEvent &event) override
Replacement of wxFormBuilder's ill-advised m_splitter1OnIdle.
std::unordered_set< wxString > m_updateablePackages
void OnUpdateAllClicked(wxCommandEvent &event) override
void ClearData()
Selects full row of the clicked cell.
void updateDetailsButtons()
Called when package state changes, currently used to calculate Update All button state.
void OnVersionActionClicked(wxCommandEvent &event) override
Shows all versions including incompatible ones.
void OnSizeInfoBox(wxSizeEvent &aEvent) override
Respond to a URL in the info window.
bool canDownload() const
Returns true if the package action can be performed.
void OnDownloadVersionClicked(wxCommandEvent &event) override
Schedules relevant action for selected package version.
wxString toHumanReadableSize(const std::optional< uint64_t > size) const
Returns true if it the download operation can be performed.
void OnSearchTextChanged(wxCommandEvent &event)
void updateCommonState()
Updates details panel.
void updatePackageList()
< Updates package listing according to search term
const ActionCallback & m_actionCallback
std::unordered_map< wxString, PANEL_PACKAGE * > m_packagePanels
void setPackageDetails(const PACKAGE_VIEW_DATA &aPackageData)
Clears details panel.
const PinCallback & m_pinCallback
std::shared_ptr< PLUGIN_CONTENT_MANAGER > m_pcm
PCM_PACKAGE_ACTION getAction() const
bool canRunAction() const
Returns implied action for the action button.
PANEL_PACKAGE * m_currentSelected
void unsetPackageDetails()
Bytes to Kb/Mb/Gb string or "-" if absent.
void SetData(const std::vector< PACKAGE_VIEW_DATA > &aPackageData)
Recreates package panels and displays data.
void OnVersionsCellClicked(wxGridEvent &event) override
Opens file chooser dialog and downloads selected package version archive.
void OnURLClicked(wxHtmlLinkEvent &event) override
Respond to scrolling over the window.
void SetSashOnIdle(wxIdleEvent &)
Enqueues all available package updates.
static std::unordered_map< PCM_PACKAGE_VERSION_STATUS, wxString > STATUS_ENUM_TO_STR
void SetPackageState(const wxString &aPackageId, const PCM_PACKAGE_STATE aState, const bool aPinned)
Set the state of package.
std::vector< wxString > m_packageInitialOrder
PANEL_PACKAGES_VIEW(wxWindow *parent, std::shared_ptr< PLUGIN_CONTENT_MANAGER > aPcm, const ActionCallback &aCallback, const PinCallback &aPinCallback)
void OnShowAllVersionsClicked(wxCommandEvent &event) override
Ranks packages for entered search term and rearranges/hides panels according to their rank.
void OnClick(wxMouseEvent &event) override
const PACKAGE_VIEW_DATA & GetPackageData() const
void SetSelected(bool aSelected)
void SetSelectCallback(const std::function< void()> &aCallback)
Marks panel as selected.
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition pgm_base.cpp:537
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
#define GRID_CELL_MARGIN
#define _(s)
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition wxgtk/ui.cpp:264
std::function< void(const wxString &aPackageId, const PCM_PACKAGE_STATE aState, const bool aPinned)> PinCallback
std::function< void(const PACKAGE_VIEW_DATA &aData, PCM_PACKAGE_ACTION aAction, const wxString &aVersion)> ActionCallback
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
PCM_PACKAGE_STATE
Definition pcm.h:58
@ PPS_INSTALLED
Definition pcm.h:61
@ PPS_PENDING_UPDATE
Definition pcm.h:65
@ PPS_UPDATE_AVAILABLE
Definition pcm.h:64
@ PPS_PENDING_UNINSTALL
Definition pcm.h:63
@ PPS_PENDING_INSTALL
Definition pcm.h:62
PCM_PACKAGE_ACTION
Definition pcm.h:71
@ PPA_UNINSTALL
Definition pcm.h:73
@ PPA_UPDATE
Definition pcm.h:74
@ PPA_INSTALL
Definition pcm.h:72
@ PVS_INVALID
Definition pcm_data.h:63
@ PVS_DEVELOPMENT
Definition pcm_data.h:66
@ PVS_STABLE
Definition pcm_data.h:64
@ PVS_TESTING
Definition pcm_data.h:65
@ PVS_DEPRECATED
Definition pcm_data.h:67
PGM_BASE & Pgm()
The global program "get" accessor.
Definition pgm_base.cpp:946
see class PGM_BASE
T * GetAppSettings(const char *aFilename)
std::vector< FAB_LAYER_COLOR > dummy
wxString EscapeHTML(const wxString &aString)
Return a new wxString escaped for embedding in HTML.
< Package version metadataPackage metadata
Definition pcm_data.h:92
std::optional< uint64_t > download_size
Definition pcm_data.h:97
std::optional< uint64_t > install_size
Definition pcm_data.h:98
wxString version
Definition pcm_data.h:93
PCM_PACKAGE_VERSION_STATUS status
Definition pcm_data.h:99
< Collection of data relevant to the package display panelCallback for (un)install button
wxString update_version
PCM_PACKAGE_STATE state
Repository reference to a resource.
Definition pcm_data.h:114
wxString name
Definition pcm_data.h:115
std::vector< PACKAGE_VERSION > versions
Definition pcm_data.h:127
std::string path
wxString result
Test unit parsing edge cases and error handling.
#define PR_CAN_ABORT