KiCad PCB EDA Suite
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
project_tree.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) 2004-2012 Jean-Pierre Charras
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25
26#include <bitmaps.h>
27#include <git/kicad_git_common.h>
28#include <wx/settings.h>
29
30#include "project_tree_item.h"
31#include "project_tree_pane.h"
32#include "project_tree.h"
33#include "kicad_id.h"
34
35
36IMPLEMENT_ABSTRACT_CLASS( PROJECT_TREE, wxTreeCtrl )
37
38
39#ifdef __WXMSW__
40#define PLATFORM_STYLE wxTR_LINES_AT_ROOT
41#else
42#define PLATFORM_STYLE wxTR_NO_LINES
43#endif
44
45PROJECT_TREE::PROJECT_TREE( PROJECT_TREE_PANE* parent ) :
46 wxTreeCtrl( parent, ID_PROJECT_TREE, wxDefaultPosition, wxDefaultSize,
47 PLATFORM_STYLE | wxTR_HAS_BUTTONS | wxTR_MULTIPLE, wxDefaultValidator,
48 wxT( "EDATreeCtrl" ) ),
49 m_imageList( nullptr ),
50 m_statusImageList( nullptr )
51{
52 m_projectTreePane = parent;
53 m_gitCommon = std::make_unique<KIGIT_COMMON>( nullptr );
54
55 // Make sure the GUI font scales properly on GTK
56 SetFont( KIUI::GetControlFont( this ) );
57
58 LoadIcons();
59}
60
61
62PROJECT_TREE::~PROJECT_TREE()
63{
64 delete m_imageList;
65 delete m_statusImageList;
66}
67
68
69void PROJECT_TREE::LoadIcons()
70{
71 // KiCad for macOS currently has backported high-DPI support for this control
72 // that is not in a released version of wxWidgets 3.2 yet. This can become the
73 // main codepath once wxWidgets 3.4 is released.
74#ifdef __WXMAC__
75 wxVector<wxBitmapBundle> images;
76 images.push_back( KiBitmapBundle( BITMAPS::project ) ); // TREE_LEGACY_PROJECT
77 images.push_back( KiBitmapBundle( BITMAPS::project_kicad ) ); // TREE_JSON_PROJECT
78 images.push_back( KiBitmapBundle( BITMAPS::icon_eeschema_24 ) ); // TREE_LEGACY_SCHEMATIC
79 images.push_back( KiBitmapBundle( BITMAPS::icon_eeschema_24 ) ); // TREE_SEXPR_SCHEMATIC
80 images.push_back( KiBitmapBundle( BITMAPS::icon_pcbnew_24 ) ); // TREE_LEGACY_PCB
81 images.push_back( KiBitmapBundle( BITMAPS::icon_pcbnew_24 ) ); // TREE_SEXPR_PCB
82 images.push_back( KiBitmapBundle( BITMAPS::icon_gerbview_24 ) ); // TREE_GERBER
83 images.push_back( KiBitmapBundle( BITMAPS::file_gerber_job ) ); // TREE_GERBER_JOB_FILE (.gbrjob)
84 images.push_back( KiBitmapBundle( BITMAPS::file_html ) ); // TREE_HTML
85 images.push_back( KiBitmapBundle( BITMAPS::file_pdf ) ); // TREE_PDF
86 images.push_back( KiBitmapBundle( BITMAPS::editor ) ); // TREE_TXT
87 images.push_back( KiBitmapBundle( BITMAPS::editor ) ); // TREE_MD
88 images.push_back( KiBitmapBundle( BITMAPS::netlist ) ); // TREE_NET
89 images.push_back( KiBitmapBundle( BITMAPS::file_cir ) ); // TREE_NET_SPICE
90 images.push_back( KiBitmapBundle( BITMAPS::unknown ) ); // TREE_UNKNOWN
91 images.push_back( KiBitmapBundle( BITMAPS::directory ) ); // TREE_DIRECTORY
92 images.push_back( KiBitmapBundle( BITMAPS::icon_cvpcb_24 ) ); // TREE_CMP_LINK
93 images.push_back( KiBitmapBundle( BITMAPS::tools ) ); // TREE_REPORT
94 images.push_back( KiBitmapBundle( BITMAPS::file_pos ) ); // TREE_POS
95 images.push_back( KiBitmapBundle( BITMAPS::file_drl ) ); // TREE_DRILL
96 images.push_back( KiBitmapBundle( BITMAPS::file_drl ) ); // TREE_DRILL_NC (similar TREE_DRILL)
97 images.push_back( KiBitmapBundle( BITMAPS::file_drl ) ); // TREE_DRILL_XNC (similar TREE_DRILL)
98 images.push_back( KiBitmapBundle( BITMAPS::file_svg ) ); // TREE_SVG
99 images.push_back( KiBitmapBundle( BITMAPS::icon_pagelayout_editor_24 ) ); // TREE_PAGE_LAYOUT_DESCR
100 images.push_back( KiBitmapBundle( BITMAPS::module ) ); // TREE_FOOTPRINT_FILE
101 images.push_back( KiBitmapBundle( BITMAPS::library ) ); // TREE_SCHEMATIC_LIBFILE
102 images.push_back( KiBitmapBundle( BITMAPS::library ) ); // TREE_SEXPR_SYMBOL_LIB_FILE
103 images.push_back( KiBitmapBundle( BITMAPS::editor ) ); // DESIGN_RULES
104 images.push_back( KiBitmapBundle( BITMAPS::zip ) ); // ZIP_ARCHIVE
105 images.push_back( KiBitmapBundle( BITMAPS::editor ) ); // JOBSET_FILE
106 SetImages( images );
107
108 wxVector<wxBitmapBundle> stateImages;
109 stateImages.push_back( wxBitmapBundle( wxBitmap( 16, 16 ) ) ); // GIT_STATUS_UNTRACKED
110 stateImages.push_back( KiBitmapBundle( BITMAPS::git_good_check ) ); // GIT_STATUS_CURRENT
111 stateImages.push_back( KiBitmapBundle( BITMAPS::git_modified ) ); // GIT_STATUS_MODIFIED
112 stateImages.push_back( KiBitmapBundle( BITMAPS::git_add ) ); // GIT_STATUS_ADDED
113 stateImages.push_back( KiBitmapBundle( BITMAPS::git_delete ) ); // GIT_STATUS_DELETED
114 stateImages.push_back( KiBitmapBundle( BITMAPS::git_out_of_date ) ); // GIT_STATUS_BEHIND
115 stateImages.push_back( KiBitmapBundle( BITMAPS::git_changed_ahead ) ); // GIT_STATUS_AHEAD
116 stateImages.push_back( KiBitmapBundle( BITMAPS::git_conflict ) ); // GIT_STATUS_CONFLICTED
117 stateImages.push_back( wxBitmapBundle( wxBitmap( 16, 16 ) ) ); // GIT_STATUS_IGNORED
118
119 SetStateImages( stateImages );
120#else
121 delete m_imageList;
122
123 // Make an image list containing small icons
124 int logicSize = 24 * GetDPIScaleFactor() / GetContentScaleFactor(); // Cross-platform way
125 int physSize = ToPhys( logicSize ); // aka *GetContentScaleFactor()
126
127 if( physSize >= 64 )
128 physSize = 64;
129 else if( physSize >= 48 )
130 physSize = 48;
131 else if( physSize >= 32 )
132 physSize = 32;
133 else
134 physSize = 24;
135
136 logicSize = std::min( logicSize, physSize );
137 int bmpsf = std::max( 1, physSize / logicSize );
138
139 logicSize = physSize / bmpsf;
140
141 auto toBitmap = [&]( BITMAPS aBmps )
142 {
143 wxBitmap bmp = KiBitmap( aBmps, physSize );
144 bmp.SetScaleFactor( bmpsf );
145 wxASSERT(bmp.IsOk());
146 return bmp;
147 };
148
149 m_imageList = new wxImageList( logicSize, logicSize, true,
150 static_cast<int>( TREE_FILE_TYPE::MAX ) );
151
152 m_imageList->Add( toBitmap( BITMAPS::project ) ); // TREE_LEGACY_PROJECT
153 m_imageList->Add( toBitmap( BITMAPS::project_kicad ) ); // TREE_JSON_PROJECT
154 m_imageList->Add( toBitmap( BITMAPS::icon_eeschema_24 ) ); // TREE_LEGACY_SCHEMATIC
155 m_imageList->Add( toBitmap( BITMAPS::icon_eeschema_24 ) ); // TREE_SEXPR_SCHEMATIC
156 m_imageList->Add( toBitmap( BITMAPS::icon_pcbnew_24 ) ); // TREE_LEGACY_PCB
157 m_imageList->Add( toBitmap( BITMAPS::icon_pcbnew_24 ) ); // TREE_SEXPR_PCB
158 m_imageList->Add( toBitmap( BITMAPS::icon_gerbview_24 ) ); // TREE_GERBER
159 m_imageList->Add( toBitmap( BITMAPS::file_gerber_job ) ); // TREE_GERBER_JOB_FILE (.gbrjob)
160 m_imageList->Add( toBitmap( BITMAPS::file_html ) ); // TREE_HTML
161 m_imageList->Add( toBitmap( BITMAPS::file_pdf ) ); // TREE_PDF
162 m_imageList->Add( toBitmap( BITMAPS::editor ) ); // TREE_TXT
163 m_imageList->Add( toBitmap( BITMAPS::editor ) ); // TREE_MD
164 m_imageList->Add( toBitmap( BITMAPS::netlist ) ); // TREE_NET
165 m_imageList->Add( toBitmap( BITMAPS::file_cir ) ); // TREE_NET_SPICE
166 m_imageList->Add( toBitmap( BITMAPS::unknown ) ); // TREE_UNKNOWN
167 m_imageList->Add( toBitmap( BITMAPS::directory ) ); // TREE_DIRECTORY
168 m_imageList->Add( toBitmap( BITMAPS::icon_cvpcb_24 ) ); // TREE_CMP_LINK
169 m_imageList->Add( toBitmap( BITMAPS::tools ) ); // TREE_REPORT
170 m_imageList->Add( toBitmap( BITMAPS::file_pos ) ); // TREE_POS
171 m_imageList->Add( toBitmap( BITMAPS::file_drl ) ); // TREE_DRILL
172 m_imageList->Add( toBitmap( BITMAPS::file_drl ) ); // TREE_DRILL_NC (similar TREE_DRILL)
173 m_imageList->Add( toBitmap( BITMAPS::file_drl ) ); // TREE_DRILL_XNC (similar TREE_DRILL)
174 m_imageList->Add( toBitmap( BITMAPS::file_svg ) ); // TREE_SVG
175 m_imageList->Add( toBitmap( BITMAPS::icon_pagelayout_editor_24 ) ); // TREE_PAGE_LAYOUT_DESCR
176 m_imageList->Add( toBitmap( BITMAPS::module ) ); // TREE_FOOTPRINT_FILE
177 m_imageList->Add( toBitmap( BITMAPS::library ) ); // TREE_SCHEMATIC_LIBFILE
178 m_imageList->Add( toBitmap( BITMAPS::library ) ); // TREE_SEXPR_SYMBOL_LIB_FILE
179 m_imageList->Add( toBitmap( BITMAPS::editor ) ); // DESIGN_RULES
180 m_imageList->Add( toBitmap( BITMAPS::zip ) ); // ZIP_ARCHIVE
181 m_imageList->Add( toBitmap( BITMAPS::editor ) ); // JOBSET_FILE
182
183 SetImageList( m_imageList );
184
185 // Make an image list containing small icons
186 int size = 16;
187
188 wxBitmap blank_bitmap( size, size );
189
190 delete m_statusImageList;
191 m_statusImageList = new wxImageList( size, size, true,
192 static_cast<int>( KIGIT_COMMON::GIT_STATUS::GIT_STATUS_LAST ) );
193
194 m_statusImageList->Add( blank_bitmap ); // GIT_STATUS_UNTRACKED
195 m_statusImageList->Add( KiBitmap( BITMAPS::git_good_check, size ) ); // GIT_STATUS_CURRENT
196 m_statusImageList->Add( KiBitmap( BITMAPS::git_modified, size ) ); // GIT_STATUS_MODIFIED
197 m_statusImageList->Add( KiBitmap( BITMAPS::git_add, size ) ); // GIT_STATUS_ADDED
198 m_statusImageList->Add( KiBitmap( BITMAPS::git_delete, size ) ); // GIT_STATUS_DELETED
199 m_statusImageList->Add( KiBitmap( BITMAPS::git_out_of_date, size ) ); // GIT_STATUS_BEHIND
200 m_statusImageList->Add( KiBitmap( BITMAPS::git_changed_ahead, size ) ); // GIT_STATUS_AHEAD
201 m_statusImageList->Add( KiBitmap( BITMAPS::git_conflict, size ) ); // GIT_STATUS_CONFLICTED
202 m_statusImageList->Add( blank_bitmap ); // GIT_STATUS_IGNORED
203
204 SetStateImageList( m_statusImageList );
205#endif
206
207}
208
209
210int PROJECT_TREE::OnCompareItems( const wxTreeItemId& item1, const wxTreeItemId& item2 )
211{
212 PROJECT_TREE_ITEM* myitem1 = (PROJECT_TREE_ITEM*) GetItemData( item1 );
213 PROJECT_TREE_ITEM* myitem2 = (PROJECT_TREE_ITEM*) GetItemData( item2 );
214
215 if( !myitem1 || !myitem2 )
216 return 0;
217
218 if( myitem1->GetType() == TREE_FILE_TYPE::DIRECTORY
219 && myitem2->GetType() != TREE_FILE_TYPE::DIRECTORY )
220 return -1;
221
222 if( myitem2->GetType() == TREE_FILE_TYPE::DIRECTORY
223 && myitem1->GetType() != TREE_FILE_TYPE::DIRECTORY )
224 return 1;
225
226 if( myitem1->IsRootFile() && !myitem2->IsRootFile() )
227 return -1;
228
229 if( myitem2->IsRootFile() && !myitem1->IsRootFile() )
230 return 1;
231
232 return myitem1->GetFileName().CmpNoCase( myitem2->GetFileName() );
233}
KiBitmap
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104
KiBitmapBundle
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition: bitmap.cpp:110
BITMAPS
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
KIGIT_COMMON::GIT_STATUS::GIT_STATUS_LAST
@ GIT_STATUS_LAST
PROJECT_TREE_ITEM
Handle one item (a file or a directory name) for the tree file.
Definition: project_tree_item.h:40
PROJECT_TREE_ITEM::GetFileName
const wxString & GetFileName() const
Definition: project_tree_item.h:61
PROJECT_TREE_ITEM::GetType
TREE_FILE_TYPE GetType() const
Definition: project_tree_item.h:58
PROJECT_TREE_ITEM::IsRootFile
bool IsRootFile() const
Definition: project_tree_item.h:64
PROJECT_TREE_PANE
PROJECT_TREE_PANE Window to display the tree files.
Definition: project_tree_pane.h:55
PROJECT_TREE
PROJECT_TREE This is the class to show (as a tree) the files in the project directory.
Definition: project_tree.h:43
PROJECT_TREE::~PROJECT_TREE
~PROJECT_TREE()
Definition: project_tree.cpp:62
PROJECT_TREE::m_projectTreePane
PROJECT_TREE_PANE * m_projectTreePane
Definition: project_tree.h:47
PROJECT_TREE::OnCompareItems
int OnCompareItems(const wxTreeItemId &item1, const wxTreeItemId &item2) override
Definition: project_tree.cpp:210
PROJECT_TREE::m_statusImageList
wxImageList * m_statusImageList
Definition: project_tree.h:49
PROJECT_TREE::PROJECT_TREE
PROJECT_TREE(PROJECT_TREE_PANE *parent)
Definition: project_tree.cpp:45
PROJECT_TREE::m_gitCommon
std::unique_ptr< KIGIT_COMMON > m_gitCommon
Definition: project_tree.h:50
PROJECT_TREE::LoadIcons
void LoadIcons()
Definition: project_tree.cpp:69
PROJECT_TREE::m_imageList
wxImageList * m_imageList
Definition: project_tree.h:48
kicad_git_common.h
kicad_id.h
IDs used in KiCad main frame foe menuitems and tools.
ID_PROJECT_TREE
@ ID_PROJECT_TREE
Definition: kicad_id.h:58
KIUI::GetControlFont
KICOMMON_API wxFont GetControlFont(wxWindow *aWindow)
Definition: ui_common.cpp:162
PLATFORM_STYLE
#define PLATFORM_STYLE
Definition: project_tree.cpp:42
project_tree.h
project_tree_item.h
project_tree_pane.h