-
-
Notifications
You must be signed in to change notification settings - Fork 485
/
project_tree_pane.cpp
2430 lines (1912 loc) · 76.7 KB
/
project_tree_pane.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2012 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
*
* 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 <stack>
#include <git2.h>
#include <wx/regex.h>
#include <wx/stdpaths.h>
#include <wx/string.h>
#include <wx/msgdlg.h>
#include <wx/textdlg.h>
#include <advanced_config.h>
#include <bitmaps.h>
#include <bitmap_store.h>
#include <confirm.h>
#include <dialogs/git/dialog_git_commit.h>
#include <dialogs/git/dialog_git_switch.h>
#include <gestfich.h>
#include <macros.h>
#include <trace_helpers.h>
#include <wildcards_and_files_ext.h>
#include <kiplatform/environment.h>
#include <core/kicad_algo.h>
#include <paths.h>
#include <project/project_local_settings.h>
#include <scoped_set_reset.h>
#include <string_utils.h>
#include <launch_ext.h>
#include <wx/dcclient.h>
#include <wx/settings.h>
#include <git/git_commit_handler.h>
#include <git/git_pull_handler.h>
#include <git/git_push_handler.h>
#include <git/git_resolve_conflict_handler.h>
#include <git/git_revert_handler.h>
#include <git/git_switch_branch_handler.h>
#include <git/git_compare_handler.h>
#include <git/git_remove_vcs_handler.h>
#include <git/git_add_to_index_handler.h>
#include <git/git_remove_from_index_handler.h>
#include <git/git_sync_handler.h>
#include <git/git_clone_handler.h>
#include <git/kicad_git_compat.h>
#include <dialogs/git/dialog_git_repository.h>
#include "project_tree_item.h"
#include "project_tree.h"
#include "pgm_kicad.h"
#include "kicad_id.h"
#include "kicad_manager_frame.h"
#include "project_tree_pane.h"
#include <widgets/kistatusbar.h>
#include <kiplatform/io.h>
/* Note about the project tree build process:
* Building the project tree can be *very* long if there are a lot of subdirectories in the
* working directory. Unfortunately, this happens easily if the project file *.pro is in the
* user's home directory.
* So the tree project is built "on demand":
* First the tree is built from the current directory and shows files and subdirs.
* > First level subdirs trees are built (i.e subdirs contents are not read)
* > When expanding a subdir, each subdir contains is read, and the corresponding sub tree is
* populated on the fly.
*/
// list of files extensions listed in the tree project window
// Add extensions in a compatible regex format to see others files types
static const wxChar* s_allowedExtensionsToList[] = {
wxT( "^.*\\.pro$" ),
wxT( "^.*\\.kicad_pro$" ),
wxT( "^.*\\.pdf$" ),
wxT( "^.*\\.sch$" ), // Legacy Eeschema files
wxT( "^.*\\.kicad_sch$" ), // S-expr Eeschema files
wxT( "^[^$].*\\.brd$" ), // Legacy Pcbnew files
wxT( "^[^$].*\\.kicad_pcb$" ), // S format Pcbnew board files
wxT( "^[^$].*\\.kicad_dru$" ), // Design rule files
wxT( "^[^$].*\\.kicad_wks$" ), // S format kicad drawing sheet files
wxT( "^[^$].*\\.kicad_mod$" ), // S format kicad footprint files, currently not listed
wxT( "^.*\\.net$" ), // pcbnew netlist file
wxT( "^.*\\.cir$" ), // Spice netlist file
wxT( "^.*\\.lib$" ), // Legacy schematic library file
wxT( "^.*\\.kicad_sym$" ), // S-expr symbol libraries
wxT( "^.*\\.txt$" ), // Text files
wxT( "^.*\\.md$" ), // Markdown files
wxT( "^.*\\.pho$" ), // Gerber file (Old Kicad extension)
wxT( "^.*\\.gbr$" ), // Gerber file
wxT( "^.*\\.gbrjob$" ), // Gerber job file
wxT( "^.*\\.gb[alops]$" ), // Gerber back (or bottom) layer file (deprecated Protel ext)
wxT( "^.*\\.gt[alops]$" ), // Gerber front (or top) layer file (deprecated Protel ext)
wxT( "^.*\\.g[0-9]{1,2}$" ), // Gerber inner layer file (deprecated Protel ext)
wxT( "^.*\\.gm[0-9]{1,2}$" ), // Gerber mechanical layer file (deprecated Protel ext)
wxT( "^.*\\.gko$" ), // Gerber keepout layer file (deprecated Protel ext)
wxT( "^.*\\.odt$" ),
wxT( "^.*\\.htm$" ),
wxT( "^.*\\.html$" ),
wxT( "^.*\\.rpt$" ), // Report files
wxT( "^.*\\.csv$" ), // Report files in comma separated format
wxT( "^.*\\.pos$" ), // Footprint position files
wxT( "^.*\\.cmp$" ), // CvPcb cmp/footprint link files
wxT( "^.*\\.drl$" ), // Excellon drill files
wxT( "^.*\\.nc$" ), // Excellon NC drill files (alternate file ext)
wxT( "^.*\\.xnc$" ), // Excellon NC drill files (alternate file ext)
wxT( "^.*\\.svg$" ), // SVG print/plot files
wxT( "^.*\\.ps$" ), // PostScript plot files
wxT( "^.*\\.zip$" ), // Zip archive files
wxT( "^.*\\.kicad_jobset" ), // KiCad jobs file
nullptr // end of list
};
/**
* The frame that shows the tree list of files and subdirectories inside the working directory.
*
* Files are filtered (see s_allowedExtensionsToList) so only useful files are shown.
*/
BEGIN_EVENT_TABLE( PROJECT_TREE_PANE, wxSashLayoutWindow )
EVT_TREE_ITEM_ACTIVATED( ID_PROJECT_TREE, PROJECT_TREE_PANE::onSelect )
EVT_TREE_ITEM_EXPANDED( ID_PROJECT_TREE, PROJECT_TREE_PANE::onExpand )
EVT_TREE_ITEM_RIGHT_CLICK( ID_PROJECT_TREE, PROJECT_TREE_PANE::onRight )
EVT_MENU( ID_PROJECT_TXTEDIT, PROJECT_TREE_PANE::onOpenSelectedFileWithTextEditor )
EVT_MENU( ID_PROJECT_SWITCH_TO_OTHER, PROJECT_TREE_PANE::onSwitchToSelectedProject )
EVT_MENU( ID_PROJECT_NEWDIR, PROJECT_TREE_PANE::onCreateNewDirectory )
EVT_MENU( ID_PROJECT_OPEN_DIR, PROJECT_TREE_PANE::onOpenDirectory )
EVT_MENU( ID_PROJECT_DELETE, PROJECT_TREE_PANE::onDeleteFile )
EVT_MENU( ID_PROJECT_RENAME, PROJECT_TREE_PANE::onRenameFile )
EVT_MENU( ID_GIT_INITIALIZE_PROJECT, PROJECT_TREE_PANE::onGitInitializeProject )
EVT_MENU( ID_GIT_COMMIT_PROJECT, PROJECT_TREE_PANE::onGitCommit )
EVT_MENU( ID_GIT_COMMIT_FILE, PROJECT_TREE_PANE::onGitCommit )
EVT_MENU( ID_GIT_SYNC_PROJECT, PROJECT_TREE_PANE::onGitSyncProject )
EVT_MENU( ID_GIT_FETCH, PROJECT_TREE_PANE::onGitFetch )
EVT_MENU( ID_GIT_PUSH, PROJECT_TREE_PANE::onGitPushProject )
EVT_MENU( ID_GIT_PULL, PROJECT_TREE_PANE::onGitPullProject )
EVT_MENU( ID_GIT_RESOLVE_CONFLICT, PROJECT_TREE_PANE::onGitResolveConflict )
EVT_MENU( ID_GIT_REVERT_LOCAL, PROJECT_TREE_PANE::onGitRevertLocal )
EVT_MENU( ID_GIT_SWITCH_BRANCH, PROJECT_TREE_PANE::onGitSwitchBranch )
EVT_MENU( ID_GIT_COMPARE, PROJECT_TREE_PANE::onGitCompare )
EVT_MENU( ID_GIT_REMOVE_VCS, PROJECT_TREE_PANE::onGitRemoveVCS )
EVT_MENU( ID_GIT_ADD_TO_INDEX, PROJECT_TREE_PANE::onGitAddToIndex )
EVT_MENU( ID_GIT_REMOVE_FROM_INDEX, PROJECT_TREE_PANE::onGitRemoveFromIndex )
EVT_MENU( ID_JOBS_RUN, PROJECT_TREE_PANE::onRunSelectedJobsFile )
EVT_IDLE( PROJECT_TREE_PANE::onIdle )
EVT_PAINT( PROJECT_TREE_PANE::onPaint )
END_EVENT_TABLE()
PROJECT_TREE_PANE::PROJECT_TREE_PANE( KICAD_MANAGER_FRAME* parent ) :
wxSashLayoutWindow( parent, ID_LEFT_FRAME, wxDefaultPosition, wxDefaultSize,
wxNO_BORDER | wxTAB_TRAVERSAL )
{
m_Parent = parent;
m_TreeProject = nullptr;
m_isRenaming = false;
m_selectedItem = nullptr;
m_watcherNeedReset = false;
m_lastGitStatusUpdate = wxDateTime::Now();
m_gitLastError = GIT_ERROR_NONE;
m_watcher = nullptr;
Connect( wxEVT_FSWATCHER,
wxFileSystemWatcherEventHandler( PROJECT_TREE_PANE::onFileSystemEvent ) );
Bind( wxEVT_SYS_COLOUR_CHANGED,
wxSysColourChangedEventHandler( PROJECT_TREE_PANE::onThemeChanged ), this );
/*
* Filtering is now inverted: the filters are actually used to _enable_ support
* for a given file type.
*/
for( int ii = 0; s_allowedExtensionsToList[ii] != nullptr; ii++ )
m_filters.emplace_back( s_allowedExtensionsToList[ii] );
m_filters.emplace_back( wxT( "^no KiCad files found" ) );
ReCreateTreePrj();
}
PROJECT_TREE_PANE::~PROJECT_TREE_PANE()
{
Disconnect( wxEVT_FSWATCHER,
wxFileSystemWatcherEventHandler( PROJECT_TREE_PANE::onFileSystemEvent ) );
Unbind( wxEVT_SYS_COLOUR_CHANGED,
wxSysColourChangedEventHandler( PROJECT_TREE_PANE::onThemeChanged ), this );
shutdownFileWatcher();
}
void PROJECT_TREE_PANE::shutdownFileWatcher()
{
if( m_watcher )
{
m_watcher->RemoveAll();
m_watcher->SetOwner( nullptr );
delete m_watcher;
m_watcher = nullptr;
}
}
void PROJECT_TREE_PANE::onSwitchToSelectedProject( wxCommandEvent& event )
{
std::vector<PROJECT_TREE_ITEM*> tree_data = GetSelectedData();
if( tree_data.size() != 1 )
return;
wxString prj_filename = tree_data[0]->GetFileName();
m_Parent->LoadProject( prj_filename );
}
void PROJECT_TREE_PANE::onOpenDirectory( wxCommandEvent& event )
{
// Get the root directory name:
std::vector<PROJECT_TREE_ITEM*> tree_data = GetSelectedData();
for( PROJECT_TREE_ITEM* item_data : tree_data )
{
// Ask for the new sub directory name
wxString curr_dir = item_data->GetDir();
if( curr_dir.IsEmpty() )
{
// Use project path if the tree view path was empty.
curr_dir = wxPathOnly( m_Parent->GetProjectFileName() );
// As a last resort use the user's documents folder.
if( curr_dir.IsEmpty() || !wxFileName::DirExists( curr_dir ) )
curr_dir = PATHS::GetDefaultUserProjectsPath();
if( !curr_dir.IsEmpty() )
curr_dir += wxFileName::GetPathSeparator();
}
LaunchExternal( curr_dir );
}
}
void PROJECT_TREE_PANE::onCreateNewDirectory( wxCommandEvent& event )
{
// Get the root directory name:
std::vector<PROJECT_TREE_ITEM*> tree_data = GetSelectedData();
for( PROJECT_TREE_ITEM* item_data : tree_data )
{
wxString prj_dir = wxPathOnly( m_Parent->GetProjectFileName() );
// Ask for the new sub directory name
wxString curr_dir = item_data->GetDir();
if( curr_dir.IsEmpty() )
curr_dir = prj_dir;
wxString new_dir = wxGetTextFromUser( _( "Directory name:" ), _( "Create New Directory" ) );
if( new_dir.IsEmpty() )
return;
wxString full_dirname = curr_dir + wxFileName::GetPathSeparator() + new_dir;
if( !wxMkdir( full_dirname ) )
return;
addItemToProjectTree( full_dirname, item_data->GetId(), nullptr, false );
}
}
wxString PROJECT_TREE_PANE::GetFileExt( TREE_FILE_TYPE type )
{
switch( type )
{
case TREE_FILE_TYPE::LEGACY_PROJECT: return FILEEXT::LegacyProjectFileExtension;
case TREE_FILE_TYPE::JSON_PROJECT: return FILEEXT::ProjectFileExtension;
case TREE_FILE_TYPE::LEGACY_SCHEMATIC: return FILEEXT::LegacySchematicFileExtension;
case TREE_FILE_TYPE::SEXPR_SCHEMATIC: return FILEEXT::KiCadSchematicFileExtension;
case TREE_FILE_TYPE::LEGACY_PCB: return FILEEXT::LegacyPcbFileExtension;
case TREE_FILE_TYPE::SEXPR_PCB: return FILEEXT::KiCadPcbFileExtension;
case TREE_FILE_TYPE::GERBER: return FILEEXT::GerberFileExtensionsRegex;
case TREE_FILE_TYPE::GERBER_JOB_FILE: return FILEEXT::GerberJobFileExtension;
case TREE_FILE_TYPE::HTML: return FILEEXT::HtmlFileExtension;
case TREE_FILE_TYPE::PDF: return FILEEXT::PdfFileExtension;
case TREE_FILE_TYPE::TXT: return FILEEXT::TextFileExtension;
case TREE_FILE_TYPE::MD: return FILEEXT::MarkdownFileExtension;
case TREE_FILE_TYPE::NET: return FILEEXT::NetlistFileExtension;
case TREE_FILE_TYPE::NET_SPICE: return FILEEXT::SpiceFileExtension;
case TREE_FILE_TYPE::CMP_LINK: return FILEEXT::FootprintAssignmentFileExtension;
case TREE_FILE_TYPE::REPORT: return FILEEXT::ReportFileExtension;
case TREE_FILE_TYPE::FP_PLACE: return FILEEXT::FootprintPlaceFileExtension;
case TREE_FILE_TYPE::DRILL: return FILEEXT::DrillFileExtension;
case TREE_FILE_TYPE::DRILL_NC: return "nc";
case TREE_FILE_TYPE::DRILL_XNC: return "xnc";
case TREE_FILE_TYPE::SVG: return FILEEXT::SVGFileExtension;
case TREE_FILE_TYPE::DRAWING_SHEET: return FILEEXT::DrawingSheetFileExtension;
case TREE_FILE_TYPE::FOOTPRINT_FILE: return FILEEXT::KiCadFootprintFileExtension;
case TREE_FILE_TYPE::SCHEMATIC_LIBFILE: return FILEEXT::LegacySymbolLibFileExtension;
case TREE_FILE_TYPE::SEXPR_SYMBOL_LIB_FILE: return FILEEXT::KiCadSymbolLibFileExtension;
case TREE_FILE_TYPE::DESIGN_RULES: return FILEEXT::DesignRulesFileExtension;
case TREE_FILE_TYPE::ZIP_ARCHIVE: return FILEEXT::ArchiveFileExtension;
case TREE_FILE_TYPE::JOBSET_FILE: return FILEEXT::KiCadJobSetFileExtension;
case TREE_FILE_TYPE::ROOT:
case TREE_FILE_TYPE::UNKNOWN:
case TREE_FILE_TYPE::MAX:
case TREE_FILE_TYPE::DIRECTORY: break;
}
return wxEmptyString;
}
std::vector<wxString> getProjects( const wxDir& dir )
{
std::vector<wxString> projects;
wxString dir_filename;
bool haveFile = dir.GetFirst( &dir_filename );
while( haveFile )
{
wxFileName file( dir_filename );
if( file.GetExt() == FILEEXT::LegacyProjectFileExtension
|| file.GetExt() == FILEEXT::ProjectFileExtension )
projects.push_back( file.GetName() );
haveFile = dir.GetNext( &dir_filename );
}
return projects;
}
static git_repository* get_git_repository_for_file( const char* filename )
{
git_repository* repo = nullptr;
git_buf repo_path = GIT_BUF_INIT;
// Find the repository path for the given file
if( git_repository_discover( &repo_path, filename, 0, NULL ) )
{
#if 0
printf( "get_git_repository_for_file: %s\n", git_error_last()->message ); fflush( 0 );
#endif
return nullptr;
}
if( git_repository_open( &repo, repo_path.ptr ) )
{
git_buf_free( &repo_path );
return nullptr;
}
// Free the git_buf memory
git_buf_free( &repo_path );
return repo;
}
wxTreeItemId PROJECT_TREE_PANE::addItemToProjectTree( const wxString& aName,
const wxTreeItemId& aParent,
std::vector<wxString>* aProjectNames,
bool aRecurse )
{
TREE_FILE_TYPE type = TREE_FILE_TYPE::UNKNOWN;
wxFileName fn( aName );
if( KIPLATFORM::IO::IsFileHidden( aName ) )
return wxTreeItemId();
if( wxDirExists( aName ) )
{
type = TREE_FILE_TYPE::DIRECTORY;
}
else
{
// Filter
wxRegEx reg;
bool addFile = false;
for( const wxString& m_filter : m_filters )
{
wxCHECK2_MSG( reg.Compile( m_filter, wxRE_ICASE ), continue,
wxString::Format( "Regex %s failed to compile.", m_filter ) );
if( reg.Matches( aName ) )
{
addFile = true;
break;
}
}
if( !addFile )
return wxTreeItemId();
for( int i = static_cast<int>( TREE_FILE_TYPE::LEGACY_PROJECT );
i < static_cast<int>( TREE_FILE_TYPE::MAX ); i++ )
{
wxString ext = GetFileExt( (TREE_FILE_TYPE) i );
if( ext == wxT( "" ) )
continue;
if( reg.Compile( wxString::FromAscii( "^.*\\." ) + ext + wxString::FromAscii( "$" ),
wxRE_ICASE ) && reg.Matches( aName ) )
{
type = (TREE_FILE_TYPE) i;
break;
}
}
}
wxString file = wxFileNameFromPath( aName );
wxFileName currfile( file );
wxFileName project( m_Parent->GetProjectFileName() );
// Ignore legacy projects with the same name as the current project
if( ( type == TREE_FILE_TYPE::LEGACY_PROJECT )
&& ( currfile.GetName().CmpNoCase( project.GetName() ) == 0 ) )
{
return wxTreeItemId();
}
if( currfile.GetExt() == GetFileExt( TREE_FILE_TYPE::LEGACY_SCHEMATIC )
|| currfile.GetExt() == GetFileExt( TREE_FILE_TYPE::SEXPR_SCHEMATIC ) )
{
if( aProjectNames )
{
if( !alg::contains( *aProjectNames, currfile.GetName() ) )
return wxTreeItemId();
}
else
{
PROJECT_TREE_ITEM* parentTreeItem = GetItemIdData( aParent );
wxDir parentDir( parentTreeItem->GetDir() );
std::vector<wxString> projects = getProjects( parentDir );
if( !alg::contains( projects, currfile.GetName() ) )
return wxTreeItemId();
}
}
// also check to see if it is already there.
wxTreeItemIdValue cookie;
wxTreeItemId kid = m_TreeProject->GetFirstChild( aParent, cookie );
while( kid.IsOk() )
{
PROJECT_TREE_ITEM* itemData = GetItemIdData( kid );
if( itemData && itemData->GetFileName() == aName )
return itemData->GetId(); // well, we would have added it, but it is already here!
kid = m_TreeProject->GetNextChild( aParent, cookie );
}
// Only show current files if both legacy and current files are present
if( type == TREE_FILE_TYPE::LEGACY_PROJECT || type == TREE_FILE_TYPE::JSON_PROJECT
|| type == TREE_FILE_TYPE::LEGACY_SCHEMATIC || type == TREE_FILE_TYPE::SEXPR_SCHEMATIC )
{
kid = m_TreeProject->GetFirstChild( aParent, cookie );
while( kid.IsOk() )
{
PROJECT_TREE_ITEM* itemData = GetItemIdData( kid );
if( itemData )
{
wxFileName fname( itemData->GetFileName() );
if( fname.GetName().CmpNoCase( currfile.GetName() ) == 0 )
{
switch( type )
{
case TREE_FILE_TYPE::LEGACY_PROJECT:
if( itemData->GetType() == TREE_FILE_TYPE::JSON_PROJECT )
return wxTreeItemId();
break;
case TREE_FILE_TYPE::LEGACY_SCHEMATIC:
if( itemData->GetType() == TREE_FILE_TYPE::SEXPR_SCHEMATIC )
return wxTreeItemId();
break;
case TREE_FILE_TYPE::JSON_PROJECT:
if( itemData->GetType() == TREE_FILE_TYPE::LEGACY_PROJECT )
m_TreeProject->Delete( kid );
break;
case TREE_FILE_TYPE::SEXPR_SCHEMATIC:
if( itemData->GetType() == TREE_FILE_TYPE::LEGACY_SCHEMATIC )
m_TreeProject->Delete( kid );
break;
default:
break;
}
}
}
kid = m_TreeProject->GetNextChild( aParent, cookie );
}
}
// Append the item (only appending the filename not the full path):
wxTreeItemId newItemId = m_TreeProject->AppendItem( aParent, file );
PROJECT_TREE_ITEM* data = new PROJECT_TREE_ITEM( type, aName, m_TreeProject );
m_TreeProject->SetItemData( newItemId, data );
data->SetState( 0 );
// Mark root files (files which have the same aName as the project)
wxString fileName = currfile.GetName().Lower();
wxString projName = project.GetName().Lower();
if( fileName == projName || fileName.StartsWith( projName + "-" ) )
data->SetRootFile( true );
#ifndef __WINDOWS__
bool subdir_populated = false;
#endif
// This section adds dirs and files found in the subdirs
// in this case AddFile is recursive, but for the first level only.
if( TREE_FILE_TYPE::DIRECTORY == type && aRecurse )
{
wxDir dir( aName );
if( dir.IsOpened() ) // protected dirs will not open properly.
{
std::vector<wxString> projects = getProjects( dir );
wxString dir_filename;
bool haveFile = dir.GetFirst( &dir_filename );
data->SetPopulated( true );
#ifndef __WINDOWS__
subdir_populated = aRecurse;
#endif
while( haveFile )
{
// Add name in tree, but do not recurse
wxString path = aName + wxFileName::GetPathSeparator() + dir_filename;
addItemToProjectTree( path, newItemId, &projects, false );
haveFile = dir.GetNext( &dir_filename );
}
}
// Sort filenames by alphabetic order
m_TreeProject->SortChildren( newItemId );
}
#ifndef __WINDOWS__
if( subdir_populated )
m_watcherNeedReset = true;
#endif
return newItemId;
}
void PROJECT_TREE_PANE::ReCreateTreePrj()
{
wxString pro_dir = m_Parent->GetProjectFileName();
if( !m_TreeProject )
m_TreeProject = new PROJECT_TREE( this );
else
m_TreeProject->DeleteAllItems();
if( !pro_dir ) // This is empty from PROJECT_TREE_PANE constructor
return;
if( m_TreeProject->GetGitRepo() )
{
git_repository_free( m_TreeProject->GetGitRepo() );
m_TreeProject->SetGitRepo( nullptr );
}
wxFileName fn = pro_dir;
bool prjReset = false;
if( !fn.IsOk() )
{
fn.Clear();
fn.SetPath( PATHS::GetDefaultUserProjectsPath() );
fn.SetName( NAMELESS_PROJECT );
fn.SetExt( FILEEXT::ProjectFileExtension );
prjReset = true;
}
bool prjOpened = fn.FileExists();
// Bind the git repository to the project tree (if it exists)
if( ADVANCED_CFG::GetCfg().m_EnableGit )
{
m_TreeProject->SetGitRepo( get_git_repository_for_file( fn.GetPath().c_str() ) );
m_TreeProject->GitCommon()->SetPassword( Prj().GetLocalSettings().m_GitRepoPassword );
m_TreeProject->GitCommon()->SetUsername( Prj().GetLocalSettings().m_GitRepoUsername );
m_TreeProject->GitCommon()->SetSSHKey( Prj().GetLocalSettings().m_GitSSHKey );
wxString conn_type = Prj().GetLocalSettings().m_GitRepoType;
if( conn_type == "https" )
m_TreeProject->GitCommon()->SetConnType( KIGIT_COMMON::GIT_CONN_TYPE::GIT_CONN_HTTPS );
else if( conn_type == "ssh" )
m_TreeProject->GitCommon()->SetConnType( KIGIT_COMMON::GIT_CONN_TYPE::GIT_CONN_SSH );
else
m_TreeProject->GitCommon()->SetConnType( KIGIT_COMMON::GIT_CONN_TYPE::GIT_CONN_LOCAL );
}
// We may have opened a legacy project, in which case GetProjectFileName will return the
// name of the migrated (new format) file, which may not have been saved to disk yet.
if( !prjOpened && !prjReset )
{
fn.SetExt( FILEEXT::LegacyProjectFileExtension );
prjOpened = fn.FileExists();
// Set the ext back so that in the tree view we see the (not-yet-saved) new file
fn.SetExt( FILEEXT::ProjectFileExtension );
}
// root tree:
m_root = m_TreeProject->AddRoot( fn.GetFullName(), static_cast<int>( TREE_FILE_TYPE::ROOT ),
static_cast<int>( TREE_FILE_TYPE::ROOT ) );
m_TreeProject->SetItemBold( m_root, true );
// The main project file is now a JSON file
PROJECT_TREE_ITEM* data = new PROJECT_TREE_ITEM( TREE_FILE_TYPE::JSON_PROJECT,
fn.GetFullPath(), m_TreeProject );
m_TreeProject->SetItemData( m_root, data );
// Now adding all current files if available
if( prjOpened )
{
pro_dir = wxPathOnly( m_Parent->GetProjectFileName() );
wxDir dir( pro_dir );
if( dir.IsOpened() ) // protected dirs will not open, see "man opendir()"
{
std::vector<wxString> projects = getProjects( dir );
wxString filename;
bool haveFile = dir.GetFirst( &filename );
while( haveFile )
{
if( filename != fn.GetFullName() )
{
wxString name = dir.GetName() + wxFileName::GetPathSeparator() + filename;
// Add items living in the project directory, and populate the item
// if it is a directory (sub directories will be not populated)
addItemToProjectTree( name, m_root, &projects, true );
}
haveFile = dir.GetNext( &filename );
}
}
}
else
{
m_TreeProject->AppendItem( m_root, wxT( "Empty project" ) );
}
m_TreeProject->Expand( m_root );
// Sort filenames by alphabetic order
m_TreeProject->SortChildren( m_root );
updateGitStatusIcons();
}
bool PROJECT_TREE_PANE::hasChangedFiles()
{
git_repository* repo = m_TreeProject->GetGitRepo();
if( !repo )
return false;
git_status_options opts;
git_status_init_options( &opts, GIT_STATUS_OPTIONS_VERSION );
opts.show = GIT_STATUS_SHOW_INDEX_AND_WORKDIR;
opts.flags = GIT_STATUS_OPT_INCLUDE_UNTRACKED | GIT_STATUS_OPT_RENAMES_HEAD_TO_INDEX
| GIT_STATUS_OPT_SORT_CASE_SENSITIVELY;
git_status_list* status_list = nullptr;
int error = git_status_list_new( &status_list, repo, &opts );
if( error != GIT_OK )
return false;
bool has_changed_files = git_status_list_entrycount( status_list ) > 0;
git_status_list_free( status_list );
return has_changed_files;
}
void PROJECT_TREE_PANE::onRight( wxTreeEvent& Event )
{
wxTreeItemId curr_item = Event.GetItem();
// Ensure item is selected (Under Windows right click does not select the item)
m_TreeProject->SelectItem( curr_item );
std::vector<PROJECT_TREE_ITEM*> selection = GetSelectedData();
bool can_switch_to_project = true;
bool can_create_new_directory = true;
bool can_open_this_directory = true;
bool can_edit = true;
bool can_rename = true;
bool can_delete = true;
bool run_jobs = false;
bool vcs_has_repo = m_TreeProject->GetGitRepo() != nullptr;
bool vcs_can_commit = hasChangedFiles();
bool vcs_can_init = !vcs_has_repo;
bool vcs_can_remove = vcs_has_repo;
bool vcs_can_fetch = vcs_has_repo && m_TreeProject->GitCommon()->HasPushAndPullRemote();
bool vcs_can_push = vcs_can_fetch && m_TreeProject->GitCommon()->HasLocalCommits();
bool vcs_can_pull = vcs_can_fetch;
bool vcs_can_switch = vcs_has_repo;
bool vcs_menu = ADVANCED_CFG::GetCfg().m_EnableGit;
// Check if the libgit2 library has been successfully initialized
#if ( LIBGIT2_VER_MAJOR >= 1 ) || ( LIBGIT2_VER_MINOR >= 99 )
int major, minor, rev;
bool libgit_init = ( git_libgit2_version( &major, &minor, &rev ) == GIT_OK );
#else
//Work around libgit2 API change for supporting older platforms
bool libgit_init = true;
#endif
vcs_menu &= libgit_init;
if( selection.size() == 0 )
return;
// Remove things that don't make sense for multiple selections
if( selection.size() != 1 )
{
can_switch_to_project = false;
can_create_new_directory = false;
can_rename = false;
}
for( PROJECT_TREE_ITEM* item : selection )
{
// Check for empty project
if( !item )
{
can_switch_to_project = false;
can_edit = false;
can_rename = false;
continue;
}
can_delete = item->CanDelete();
can_rename = item->CanRename();
switch( item->GetType() )
{
case TREE_FILE_TYPE::JSON_PROJECT:
case TREE_FILE_TYPE::LEGACY_PROJECT:
can_rename = false;
if( item->GetId() == m_TreeProject->GetRootItem() )
{
can_switch_to_project = false;
}
else
{
can_create_new_directory = false;
can_open_this_directory = false;
}
break;
case TREE_FILE_TYPE::DIRECTORY:
can_switch_to_project = false;
can_edit = false;
break;
case TREE_FILE_TYPE::JOBSET_FILE:
run_jobs = true;
can_edit = false;
KI_FALLTHROUGH;
case TREE_FILE_TYPE::SEXPR_SCHEMATIC:
case TREE_FILE_TYPE::SEXPR_PCB:
KI_FALLTHROUGH;
default:
can_switch_to_project = false;
can_create_new_directory = false;
can_open_this_directory = false;
break;
}
}
wxMenu popup_menu;
wxString text;
wxString help_text;
if( can_switch_to_project )
{
KIUI::AddMenuItem( &popup_menu, ID_PROJECT_SWITCH_TO_OTHER, _( "Switch to this Project" ),
_( "Close all editors, and switch to the selected project" ),
KiBitmap( BITMAPS::open_project ) );
popup_menu.AppendSeparator();
}
if( can_create_new_directory )
{
KIUI::AddMenuItem( &popup_menu, ID_PROJECT_NEWDIR, _( "New Directory..." ),
_( "Create a New Directory" ), KiBitmap( BITMAPS::directory ) );
}
if( can_open_this_directory )
{
if( selection.size() == 1 )
{
#ifdef __APPLE__
text = _( "Reveal in Finder" );
help_text = _( "Reveals the directory in a Finder window" );
#else
text = _( "Open Directory in File Explorer" );
help_text = _( "Opens the directory in the default system file manager" );
#endif
}
else
{
#ifdef __APPLE__
text = _( "Reveal in Finder" );
help_text = _( "Reveals the directories in a Finder window" );
#else
text = _( "Open Directories in File Explorer" );
help_text = _( "Opens the directories in the default system file manager" );
#endif
}
KIUI::AddMenuItem( &popup_menu, ID_PROJECT_OPEN_DIR, text, help_text,
KiBitmap( BITMAPS::directory_browser ) );
}
if( can_edit )
{
if( selection.size() == 1 )
help_text = _( "Open the file in a Text Editor" );
else
help_text = _( "Open files in a Text Editor" );
KIUI::AddMenuItem( &popup_menu, ID_PROJECT_TXTEDIT, _( "Edit in a Text Editor" ), help_text,
KiBitmap( BITMAPS::editor ) );
}
if( run_jobs && selection.size() == 1 )
{
KIUI::AddMenuItem( &popup_menu, ID_JOBS_RUN, _( "Run Jobs" ), help_text,
KiBitmap( BITMAPS::exchange ) );
}
if( can_rename )
{
if( selection.size() == 1 )
{
text = _( "Rename File..." );
help_text = _( "Rename file" );
}
else
{
text = _( "Rename Files..." );
help_text = _( "Rename files" );
}
KIUI::AddMenuItem( &popup_menu, ID_PROJECT_RENAME, text, help_text,
KiBitmap( BITMAPS::right ) );
}
if( can_delete )
{
if( selection.size() == 1 )
help_text = _( "Delete the file and its content" );
else
help_text = _( "Delete the files and their contents" );
if( can_switch_to_project
|| can_create_new_directory
|| can_open_this_directory
|| can_edit
|| can_rename )
{
popup_menu.AppendSeparator();
}
#ifdef __WINDOWS__
KIUI::AddMenuItem( &popup_menu, ID_PROJECT_DELETE, _( "Delete" ), help_text,
KiBitmap( BITMAPS::trash ) );
#else
KIUI::AddMenuItem( &popup_menu, ID_PROJECT_DELETE, _( "Move to Trash" ), help_text,
KiBitmap( BITMAPS::trash ) );
#endif
}
if( vcs_menu )
{
wxMenu* vcs_submenu = new wxMenu();
wxMenu* branch_submenu = new wxMenu();
wxMenuItem* vcs_menuitem = nullptr;
vcs_menuitem = vcs_submenu->Append( ID_GIT_INITIALIZE_PROJECT,
_( "Add Project to Version Control..." ),
_( "Initialize a new repository" ) );
vcs_menuitem->Enable( vcs_can_init );
vcs_menuitem = vcs_submenu->Append( ID_GIT_COMMIT_PROJECT, _( "Commit Project..." ),
_( "Commit changes to the local repository" ) );
vcs_menuitem->Enable( vcs_can_commit );
vcs_menuitem = vcs_submenu->Append( ID_GIT_PUSH, _( "Push" ),
_( "Push committed local changes to remote repository" ) );
vcs_menuitem->Enable( vcs_can_push );
vcs_menuitem = vcs_submenu->Append( ID_GIT_PULL, _( "Pull" ),
_( "Pull changes from remote repository into local" ) );
vcs_menuitem->Enable( vcs_can_pull );
vcs_submenu->AppendSeparator();
vcs_menuitem = vcs_submenu->Append( ID_GIT_COMMIT_FILE, _( "Commit File..." ),
_( "Commit changes to the local repository" ) );
vcs_menuitem->Enable( vcs_can_commit );
vcs_submenu->AppendSeparator();
// vcs_menuitem = vcs_submenu->Append( ID_GIT_COMPARE, _( "Diff" ),
// _( "Show changes between the repository and working tree" ) );
// vcs_menuitem->Enable( vcs_can_diff );
std::vector<wxString> branchNames = m_TreeProject->GitCommon()->GetBranchNames();
// Skip the first one (that is the current branch)
for( size_t ii = 1; ii < branchNames.size() && ii < 6; ++ii )
{
wxString msg = _( "Switch to branch " ) + branchNames[ii];
vcs_menuitem = branch_submenu->Append( ID_GIT_SWITCH_BRANCH + ii, branchNames[ii], msg );
vcs_menuitem->Enable( vcs_can_switch );
}
vcs_menuitem = branch_submenu->Append( ID_GIT_SWITCH_BRANCH, _( "Other..." ),
_( "Switch to a different branch" ) );
vcs_menuitem->Enable( vcs_can_switch );
vcs_submenu->Append( ID_GIT_SWITCH_BRANCH, _( "Switch to Branch" ), branch_submenu );