KiCad PCB EDA Suite
Loading...
Searching...
No Matches
kicad_manager_control.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) 2019 CERN
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
22#include <env_vars.h>
23#include <executable_names.h>
24#include <pgm_base.h>
25#include <pgm_kicad.h>
26#include <policy_keys.h>
27#include <kiway.h>
28#include <kicad_manager_frame.h>
29#include <kiplatform/policy.h>
30#include <kiplatform/secrets.h>
31#include <confirm.h>
32#include <kidialog.h>
37#include <tool/selection.h>
38#include <tool/tool_event.h>
39#include <tool/tool_manager.h>
40#include <tool/common_control.h>
47#include <gestfich.h>
48#include <paths.h>
49#include <wx/dir.h>
50#include <wx/filedlg.h>
52#include "dialog_pcm.h"
54#include <project_tree_pane.h>
55#include <project_tree.h>
56#include <launch_ext.h>
57
59
61 TOOL_INTERACTIVE( "kicad.Control" ),
62 m_frame( nullptr )
63{
64}
65
66
68{
69 m_frame = getEditFrame<KICAD_MANAGER_FRAME>();
70}
71
72
73wxFileName KICAD_MANAGER_CONTROL::newProjectDirectory( wxString* aFileName, bool isRepo )
74{
75 wxString default_filename = aFileName ? *aFileName : wxString();
76
77 wxString default_dir = m_frame->GetMruPath();
78 wxFileDialog dlg( m_frame, _( "Create New Project" ), default_dir, default_filename,
79 ( isRepo ? wxString( "" ) : FILEEXT::ProjectFileWildcard() ),
80 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
81
82 // Add a "Create a new directory" checkbox
83 FILEDLG_NEW_PROJECT newProjectHook;
84 dlg.SetCustomizeHook( newProjectHook );
85
86 if( dlg.ShowModal() == wxID_CANCEL )
87 return wxFileName();
88
89 wxFileName pro( dlg.GetPath() );
90
91 // wxFileName automatically extracts an extension. But if it isn't
92 // a .pro extension, we should keep it as part of the filename
93 if( !pro.GetExt().IsEmpty() && pro.GetExt().ToStdString() != FILEEXT::ProjectFileExtension )
94 pro.SetName( pro.GetName() + wxT( "." ) + pro.GetExt() );
95
96 pro.SetExt( FILEEXT::ProjectFileExtension ); // enforce extension
97
98 if( !pro.IsAbsolute() )
99 pro.MakeAbsolute();
100
101 // Append a new directory with the same name of the project file.
102 bool createNewDir = false;
103
104 createNewDir = newProjectHook.GetCreateNewDir();
105
106 if( createNewDir )
107 pro.AppendDir( pro.GetName() );
108
109 // Check if the project directory is empty if it already exists.
110 wxDir directory( pro.GetPath() );
111
112 if( !pro.DirExists() )
113 {
114 if( !pro.Mkdir() )
115 {
116 wxString msg;
117 msg.Printf( _( "Folder '%s' could not be created.\n\n"
118 "Make sure you have write permissions and try again." ),
119 pro.GetPath() );
121 return wxFileName();
122 }
123 }
124 else if( directory.HasFiles() )
125 {
126 wxString msg = _( "The selected folder is not empty. It is recommended that you "
127 "create projects in their own empty folder.\n\n"
128 "Do you want to continue?" );
129
130 if( !IsOK( m_frame, msg ) )
131 return wxFileName();
132 }
133
134 return pro;
135}
136
137
139{
140
141 wxFileName pro = newProjectDirectory();
142
143 if( !pro.IsOk() )
144 return -1;
145
147 m_frame->LoadProject( pro );
148
149 return 0;
150}
151
152
154{
155 DIALOG_GIT_REPOSITORY dlg( m_frame, nullptr );
156
157 dlg.SetTitle( _( "Clone Project from Git Repository" ) );
158
159 int ret = dlg.ShowModal();
160
161 if( ret != wxID_OK )
162 return -1;
163
164 wxString project_name = dlg.GetRepoName();
165 wxFileName pro = newProjectDirectory( &project_name, true );
166
167 if( !pro.IsOk() )
168 return -1;
169
170 PROJECT_TREE_PANE *pane = static_cast<PROJECT_TREE_PANE*>( m_frame->GetToolCanvas() );
171
172
173 GIT_CLONE_HANDLER cloneHandler( pane->m_TreeProject->GitCommon() );
174
175 cloneHandler.SetRemote( dlg.GetFullURL() );
176 cloneHandler.SetClonePath( pro.GetPath() );
177 cloneHandler.SetUsername( dlg.GetUsername() );
178 cloneHandler.SetPassword( dlg.GetPassword() );
179 cloneHandler.SetSSHKey( dlg.GetRepoSSHPath() );
180
181 cloneHandler.SetProgressReporter( std::make_unique<WX_PROGRESS_REPORTER>( m_frame, _( "Clone Repository" ), 1,
182 PR_NO_ABORT ) );
183
184 if( !cloneHandler.PerformClone() )
185 {
186 DisplayErrorMessage( m_frame, cloneHandler.GetErrorString() );
187 return -1;
188 }
189
190 std::vector<wxString> projects = cloneHandler.GetProjectDirs();
191
192 if( projects.empty() )
193 {
194 DisplayErrorMessage( m_frame, _( "No project files were found in the repository." ) );
195 return -1;
196 }
197
198 // Currently, we pick the first project file we find in the repository.
199 // TODO: Look into spare checkout to allow the user to pick a partial repository
200 wxString dest = pro.GetPath() + wxFileName::GetPathSeparator() + projects.front();
201 m_frame->LoadProject( dest );
202
206
210 Prj().GetLocalSettings().m_GitRepoType = "https";
211 else
212 Prj().GetLocalSettings().m_GitRepoType = "local";
213
214 return 0;
215}
216
217
219{
220 wxString default_dir = wxFileName( Prj().GetProjectFullName() ).GetPathWithSep();
221 wxFileDialog dlg( m_frame, _( "Create New Jobset" ), default_dir, wxEmptyString,
223 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
224
225 if( dlg.ShowModal() == wxID_CANCEL )
226 return -1;
227
228 wxFileName jobsetFn( dlg.GetPath() );
229
230 m_frame->OpenJobsFile( jobsetFn.GetFullPath(), true );
231
232 return 0;
233}
234
235
237{
238 KICAD_SETTINGS* settings = GetAppSettings<KICAD_SETTINGS>( "kicad" );
239 std::map<wxString, wxFileName> titleDirMap;
240 wxFileName templatePath;
241
242 // KiCad system template path.
243 std::optional<wxString> v = ENV_VAR::GetVersionedEnvVarValue( Pgm().GetLocalEnvVariables(),
244 wxT( "TEMPLATE_DIR" ) );
245
246 if( v && !v->IsEmpty() )
247 {
248 templatePath.AssignDir( *v );
249 titleDirMap.emplace( _( "System Templates" ), templatePath );
250 }
251
252 // User template path.
253 ENV_VAR_MAP_CITER it = Pgm().GetLocalEnvVariables().find( "KICAD_USER_TEMPLATE_DIR" );
254
255 if( it != Pgm().GetLocalEnvVariables().end() && it->second.GetValue() != wxEmptyString )
256 {
257 templatePath.AssignDir( it->second.GetValue() );
258 titleDirMap.emplace( _( "User Templates" ), templatePath );
259 }
260
262 settings->m_TemplateWindowSize, titleDirMap );
263
264 // Show the project template selector dialog
265 int result = ps.ShowModal();
266
267 settings->m_TemplateWindowPos = ps.GetPosition();
268 settings->m_TemplateWindowSize = ps.GetSize();
269
270 if( result != wxID_OK )
271 return -1;
272
273 if( !ps.GetSelectedTemplate() )
274 {
275 wxMessageBox( _( "No project template was selected. Cannot generate new project." ),
276 _( "Error" ), wxOK | wxICON_ERROR, m_frame );
277
278 return -1;
279 }
280
281 // Get project destination folder and project file name.
282 wxString default_dir = wxFileName( Prj().GetProjectFullName() ).GetPathWithSep();
283 wxString title = _( "New Project Folder" );
284 wxFileDialog dlg( m_frame, title, default_dir, wxEmptyString, FILEEXT::ProjectFileWildcard(),
285 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
286
287 // Add a "Create a new directory" checkbox
288 FILEDLG_NEW_PROJECT newProjectHook;
289 dlg.SetCustomizeHook( newProjectHook );
290
291 if( dlg.ShowModal() == wxID_CANCEL )
292 return -1;
293
294 wxFileName fn( dlg.GetPath() );
295
296 // wxFileName automatically extracts an extension. But if it isn't a .kicad_pro extension,
297 // we should keep it as part of the filename
298 if( !fn.GetExt().IsEmpty() && fn.GetExt().ToStdString() != FILEEXT::ProjectFileExtension )
299 fn.SetName( fn.GetName() + wxT( "." ) + fn.GetExt() );
300
302
303 if( !fn.IsAbsolute() )
304 fn.MakeAbsolute();
305
306 bool createNewDir = false;
307 createNewDir = newProjectHook.GetCreateNewDir();
308
309 // Append a new directory with the same name of the project file.
310 if( createNewDir )
311 fn.AppendDir( fn.GetName() );
312
313 // Check if the project directory is empty if it already exists.
314
315 if( !fn.DirExists() )
316 {
317 if( !fn.Mkdir() )
318 {
319 wxString msg;
320 msg.Printf( _( "Folder '%s' could not be created.\n\n"
321 "Make sure you have write permissions and try again." ),
322 fn.GetPath() );
324 return -1;
325 }
326 }
327
328 if( !fn.IsDirWritable() )
329 {
330 wxString msg;
331
332 msg.Printf( _( "Insufficient permissions to write to folder '%s'." ), fn.GetPath() );
333 wxMessageDialog msgDlg( m_frame, msg, _( "Error" ), wxICON_ERROR | wxOK | wxCENTER );
334 msgDlg.ShowModal();
335 return -1;
336 }
337
338 // Make sure we are not overwriting anything in the destination folder.
339 std::vector< wxFileName > destFiles;
340
341 if( ps.GetSelectedTemplate()->GetDestinationFiles( fn, destFiles ) )
342 {
343 std::vector<wxFileName> overwrittenFiles;
344
345 for( const wxFileName& file : destFiles )
346 {
347 if( file.FileExists() )
348 overwrittenFiles.push_back( file );
349 }
350
351 if( !overwrittenFiles.empty() )
352 {
353 wxString extendedMsg = _( "Overwriting files:" ) + "\n";
354
355 for( const wxFileName& file : overwrittenFiles )
356 extendedMsg += "\n" + file.GetFullName();
357
358 KIDIALOG msgDlg( m_frame,
359 _( "Similar files already exist in the destination folder." ),
360 _( "Confirmation" ),
361 wxOK | wxCANCEL | wxICON_WARNING );
362 msgDlg.SetExtendedMessage( extendedMsg );
363 msgDlg.SetOKLabel( _( "Overwrite" ) );
364 msgDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
365
366 if( msgDlg.ShowModal() == wxID_CANCEL )
367 return -1;
368 }
369 }
370
371 wxString errorMsg;
372
373 // The selected template widget contains the template we're attempting to use to
374 // create a project
375 if( !ps.GetSelectedTemplate()->CreateProject( fn, &errorMsg ) )
376 {
377 wxMessageDialog createDlg( m_frame,
378 _( "A problem occurred creating new project from template." ),
379 _( "Error" ),
380 wxOK | wxICON_ERROR );
381
382 if( !errorMsg.empty() )
383 createDlg.SetExtendedMessage( errorMsg );
384
385 createDlg.ShowModal();
386 return -1;
387 }
388
389 m_frame->CreateNewProject( fn.GetFullPath() );
390 m_frame->LoadProject( fn );
391 return 0;
392}
393
394
395int KICAD_MANAGER_CONTROL::openProject( const wxString& aDefaultDir )
396{
397 wxString wildcard = FILEEXT::AllProjectFilesWildcard()
400
401 wxFileDialog dlg( m_frame, _( "Open Existing Project" ), aDefaultDir, wxEmptyString, wildcard,
402 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
403
404 if( dlg.ShowModal() == wxID_CANCEL )
405 return -1;
406
407 wxFileName pro( dlg.GetPath() );
408
409 if( !pro.IsAbsolute() )
410 pro.MakeAbsolute();
411
412 if( !pro.FileExists() )
413 return -1;
414
415 m_frame->LoadProject( pro );
416
417 return 0;
418}
419
420
422{
424}
425
426
428{
429 return openProject( m_frame->GetMruPath() );
430}
431
432
434{
435 wxString default_dir = wxFileName( Prj().GetProjectFullName() ).GetPathWithSep();
436 wxFileDialog dlg( m_frame, _( "Open Jobset" ), default_dir, wxEmptyString,
437 FILEEXT::JobsetFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
438
439 if( dlg.ShowModal() == wxID_CANCEL )
440 return -1;
441
442 wxFileName jobsetFn( dlg.GetPath() );
443
444 m_frame->OpenJobsFile( jobsetFn.GetFullPath(), true );
445
446 return 0;
447}
448
449
451{
452 m_frame->CloseProject( true );
453 return 0;
454}
455
456
458{
459 if( aEvent.Parameter<wxString*>() )
460 m_frame->LoadProject( wxFileName( *aEvent.Parameter<wxString*>() ) );
461 return 0;
462}
463
464
466{
467 wxFileName fileName = m_frame->GetProjectFileName();
468
469 fileName.SetExt( FILEEXT::ArchiveFileExtension );
470
471 wxFileDialog dlg( m_frame, _( "Archive Project Files" ),
472 fileName.GetPath(), fileName.GetFullName(),
473 FILEEXT::ZipFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
474
475 if( dlg.ShowModal() == wxID_CANCEL )
476 return 0;
477
478 wxFileName zipFile = dlg.GetPath();
479
480 wxString currdirname = fileName.GetPathWithSep();
481 wxDir dir( currdirname );
482
483 if( !dir.IsOpened() ) // wxWidgets display a error message on issue.
484 return 0;
485
486 STATUSBAR_REPORTER reporter( m_frame->GetStatusBar(), 1 );
487 PROJECT_ARCHIVER archiver;
488
489 archiver.Archive( currdirname, zipFile.GetFullPath(), reporter, true, true );
490 return 0;
491}
492
493
495{
497 return 0;
498}
499
500
502{
503 // Open project directory in host OS's file explorer
504 LaunchExternal( Prj().GetProjectPath() );
505 return 0;
506}
507
508
510{
511 if( aEvent.Parameter<wxString*>() )
512 wxExecute( *aEvent.Parameter<wxString*>(), wxEXEC_ASYNC );
513 return 0;
514}
515
516class SAVE_AS_TRAVERSER : public wxDirTraverser
517{
518public:
520 const wxString& aSrcProjectDirPath,
521 const wxString& aSrcProjectName,
522 const wxString& aNewProjectDirPath,
523 const wxString& aNewProjectName ) :
524 m_frame( aFrame ),
525 m_projectDirPath( aSrcProjectDirPath ),
526 m_projectName( aSrcProjectName ),
527 m_newProjectDirPath( aNewProjectDirPath ),
528 m_newProjectName( aNewProjectName )
529 {
530 }
531
532 virtual wxDirTraverseResult OnFile( const wxString& aSrcFilePath ) override
533 {
534 // Recursion guard for a Save As to a location inside the source project.
535 if( aSrcFilePath.StartsWith( m_newProjectDirPath + wxFileName::GetPathSeparator() ) )
536 return wxDIR_CONTINUE;
537
538 wxFileName destFile( aSrcFilePath );
539 wxString ext = destFile.GetExt();
540 bool atRoot = destFile.GetPath() == m_projectDirPath;
541
545 {
546 wxString destPath = destFile.GetPath();
547
548 if( destPath.StartsWith( m_projectDirPath ) )
549 {
550 destPath.Replace( m_projectDirPath, m_newProjectDirPath, false );
551 destFile.SetPath( destPath );
552 }
553
554 if( destFile.GetName() == m_projectName )
555 {
556 destFile.SetName( m_newProjectName );
557
558 if( atRoot && ext != FILEEXT::ProjectLocalSettingsFileExtension )
559 m_newProjectFile = destFile;
560 }
561
563 {
564 // All paths in the settings file are relative so we can just do a straight copy
565 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), m_errors );
566 }
567 else if( ext == FILEEXT::ProjectFileExtension )
568 {
569 PROJECT_FILE projectFile( aSrcFilePath );
570 projectFile.LoadFromFile();
571 projectFile.SaveAs( destFile.GetPath(), destFile.GetName() );
572 }
574 {
575 PROJECT_LOCAL_SETTINGS projectLocalSettings( nullptr, aSrcFilePath );
576 projectLocalSettings.LoadFromFile();
577 projectLocalSettings.SaveAs( destFile.GetPath(), destFile.GetName() );
578 }
579 }
589 || destFile.GetName() == FILEEXT::SymbolLibraryTableFileName )
590 {
593 m_newProjectName, aSrcFilePath, m_errors );
594 }
595 else if( ext == FILEEXT::KiCadPcbFileExtension
601 || destFile.GetName() == FILEEXT::FootprintLibraryTableFileName )
602 {
605 m_newProjectName, aSrcFilePath, m_errors );
606 }
607 else if( ext == FILEEXT::DrawingSheetFileExtension )
608 {
611 m_newProjectName, aSrcFilePath, m_errors );
612 }
613 else if( ext == FILEEXT::GerberJobFileExtension
616 {
619 m_newProjectName, aSrcFilePath, m_errors );
620 }
621 else if( destFile.GetName().StartsWith( FILEEXT::LockFilePrefix )
623 {
624 // Ignore lock files
625 }
626 else
627 {
628 // Everything we don't recognize just gets a straight copy.
629 wxString destPath = destFile.GetPathWithSep();
630 wxString destName = destFile.GetName();
631 wxUniChar pathSep = wxFileName::GetPathSeparator();
632
633 wxString srcProjectFootprintLib = pathSep + m_projectName + ".pretty" + pathSep;
634 wxString newProjectFootprintLib = pathSep + m_newProjectName + ".pretty" + pathSep;
635
636 if( destPath.StartsWith( m_projectDirPath ) )
637 destPath.Replace( m_projectDirPath, m_newProjectDirPath, false );
638
639 destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib, true );
640
641 if( destName == m_projectName && ext != wxT( "zip" ) /* don't rename archives */ )
642 destFile.SetName( m_newProjectName );
643
644 destFile.SetPath( destPath );
645
646 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), m_errors );
647 }
648
649 return wxDIR_CONTINUE;
650 }
651
652 virtual wxDirTraverseResult OnDir( const wxString& aSrcDirPath ) override
653 {
654 // Recursion guard for a Save As to a location inside the source project.
655 if( aSrcDirPath.StartsWith( m_newProjectDirPath ) )
656 return wxDIR_CONTINUE;
657
658 wxFileName destDir( aSrcDirPath );
659 wxString destDirPath = destDir.GetPathWithSep();
660 wxUniChar pathSep = wxFileName::GetPathSeparator();
661
662 if( destDirPath.StartsWith( m_projectDirPath + pathSep )
663 || destDirPath.StartsWith( m_projectDirPath + PROJECT_BACKUPS_DIR_SUFFIX ) )
664 {
665 destDirPath.Replace( m_projectDirPath, m_newProjectDirPath, false );
666 destDir.SetPath( destDirPath );
667 }
668
669 if( destDir.GetName() == m_projectName )
670 {
671 if( destDir.GetExt() == "pretty" )
672 destDir.SetName( m_newProjectName );
673#if 0
674 // WAYNE STAMBAUGH TODO:
675 // If we end up with a symbol equivalent to ".pretty" we'll want to handle it here....
676 else if( destDir.GetExt() == "sym_lib_dir_extension" )
677 destDir.SetName( m_newProjectName );
678#endif
679 }
680
681 if( !wxMkdir( destDir.GetFullPath() ) )
682 {
683 wxString msg;
684
685 if( !m_errors.empty() )
686 m_errors += "\n";
687
688 msg.Printf( _( "Cannot copy folder '%s'." ), destDir.GetFullPath() );
689 m_errors += msg;
690 }
691
692 return wxDIR_CONTINUE;
693 }
694
695 wxString GetErrors() { return m_errors; }
696
697 wxFileName GetNewProjectFile() { return m_newProjectFile; }
698
699private:
701
706
708 wxString m_errors;
709};
710
711
713{
714 wxString msg;
715
716 wxFileName currentProjectFile( Prj().GetProjectFullName() );
717 wxString currentProjectDirPath = currentProjectFile.GetPath();
718 wxString currentProjectName = Prj().GetProjectName();
719
720 wxString default_dir = m_frame->GetMruPath();
721
722 Prj().GetProjectFile().SaveToFile( currentProjectDirPath );
723 Prj().GetLocalSettings().SaveToFile( currentProjectDirPath );
724
725 if( default_dir == currentProjectDirPath
726 || default_dir == currentProjectDirPath + wxFileName::GetPathSeparator() )
727 {
728 // Don't start within the current project
729 wxFileName default_dir_fn( default_dir );
730 default_dir_fn.RemoveLastDir();
731 default_dir = default_dir_fn.GetPath();
732 }
733
734 wxFileDialog dlg( m_frame, _( "Save Project To" ), default_dir, wxEmptyString, wxEmptyString,
735 wxFD_SAVE );
736
737 if( dlg.ShowModal() == wxID_CANCEL )
738 return -1;
739
740 wxFileName newProjectDir( dlg.GetPath(), wxEmptyString );
741
742 if( !newProjectDir.IsAbsolute() )
743 newProjectDir.MakeAbsolute();
744
745 if( wxDirExists( newProjectDir.GetFullPath() ) )
746 {
747 msg.Printf( _( "'%s' already exists." ), newProjectDir.GetFullPath() );
749 return -1;
750 }
751
752 if( !wxMkdir( newProjectDir.GetFullPath() ) )
753 {
754 msg.Printf( _( "Folder '%s' could not be created.\n\n"
755 "Please make sure you have write permissions and try again." ),
756 newProjectDir.GetPath() );
758 return -1;
759 }
760
761 if( !newProjectDir.IsDirWritable() )
762 {
763 msg.Printf( _( "Insufficient permissions to write to folder '%s'." ),
764 newProjectDir.GetFullPath() );
765 wxMessageDialog msgDlg( m_frame, msg, _( "Error!" ), wxICON_ERROR | wxOK | wxCENTER );
766 msgDlg.ShowModal();
767 return -1;
768 }
769
770 const wxString& newProjectDirPath = newProjectDir.GetFullPath();
771 const wxString& newProjectName = newProjectDir.GetDirs().Last();
772 wxDir currentProjectDir( currentProjectDirPath );
773
774 SAVE_AS_TRAVERSER traverser( m_frame, currentProjectDirPath, currentProjectName,
775 newProjectDirPath, newProjectName );
776
777 currentProjectDir.Traverse( traverser );
778
779 if( !traverser.GetErrors().empty() )
780 DisplayErrorMessage( m_frame, traverser.GetErrors() );
781
782 if( !traverser.GetNewProjectFile().FileExists() )
784
785 m_frame->LoadProject( traverser.GetNewProjectFile() );
786
787 return 0;
788}
789
790
792{
794 return 0;
795}
796
797
799{
800 ACTION_MENU* actionMenu = aEvent.Parameter<ACTION_MENU*>();
801 CONDITIONAL_MENU* conditionalMenu = dynamic_cast<CONDITIONAL_MENU*>( actionMenu );
802 SELECTION dummySel;
803
804 if( conditionalMenu )
805 conditionalMenu->Evaluate( dummySel );
806
807 if( actionMenu )
808 actionMenu->UpdateAll();
809
810 return 0;
811}
812
813
815{
816 FRAME_T playerType = aEvent.Parameter<FRAME_T>();
817 KIWAY_PLAYER* player;
818
819 if( playerType == FRAME_SCH && !m_frame->IsProjectActive() )
820 {
821 DisplayInfoMessage( m_frame, _( "Create (or open) a project to edit a schematic." ),
822 wxEmptyString );
823 return -1;
824 }
825 else if( playerType == FRAME_PCB_EDITOR && !m_frame->IsProjectActive() )
826 {
827 DisplayInfoMessage( m_frame, _( "Create (or open) a project to edit a pcb." ),
828 wxEmptyString );
829 return -1;
830 }
831
832 // Prevent multiple KIWAY_PLAYER loading at one time
833 if( !m_loading.try_lock() )
834 return -1;
835
836 const std::lock_guard<std::mutex> lock( m_loading, std::adopt_lock );
837
838 try
839 {
840 player = m_frame->Kiway().Player( playerType, true );
841 }
842 catch( const IO_ERROR& err )
843 {
844 wxLogError( _( "Application failed to load:\n" ) + err.What() );
845 return -1;
846 }
847
848 if ( !player )
849 {
850 wxLogError( _( "Application cannot start." ) );
851 return -1;
852 }
853
854 if( !player->IsVisible() ) // A hidden frame might not have the document loaded.
855 {
856 wxString filepath;
857
858 if( playerType == FRAME_SCH )
859 {
860 wxFileName kicad_schematic( m_frame->SchFileName() );
861 wxFileName legacy_schematic( m_frame->SchLegacyFileName() );
862
863 if( !legacy_schematic.FileExists() || kicad_schematic.FileExists() )
864 filepath = kicad_schematic.GetFullPath();
865 else
866 filepath = legacy_schematic.GetFullPath();
867 }
868 else if( playerType == FRAME_PCB_EDITOR )
869 {
870 wxFileName kicad_board( m_frame->PcbFileName() );
871 wxFileName legacy_board( m_frame->PcbLegacyFileName() );
872
873 if( !legacy_board.FileExists() || kicad_board.FileExists() )
874 filepath = kicad_board.GetFullPath();
875 else
876 filepath = legacy_board.GetFullPath();
877 }
878
879 if( !filepath.IsEmpty() )
880 {
881 std::vector<wxString> file_list{ filepath };
882
883 if( !player->OpenProjectFiles( file_list ) )
884 {
885 player->Destroy();
886 return -1;
887 }
888 }
889
890 wxBusyCursor busy;
891 player->Show( true );
892 }
893
894 // Needed on Windows, other platforms do not use it, but it creates no issue
895 if( player->IsIconized() )
896 player->Iconize( false );
897
898 player->Raise();
899
900 // Raising the window does not set the focus on Linux. This should work on
901 // any platform.
902 if( wxWindow::FindFocus() != player )
903 player->SetFocus();
904
905 // Save window state to disk now. Don't wait around for a crash.
906 if( Pgm().GetCommonSettings()->m_Session.remember_open_files
907 && !player->GetCurrentFileName().IsEmpty()
908 && Prj().GetLocalSettings().ShouldAutoSave() )
909 {
910 wxFileName rfn( player->GetCurrentFileName() );
911 rfn.MakeRelativeTo( Prj().GetProjectPath() );
912
913 WINDOW_SETTINGS windowSettings;
914 player->SaveWindowSettings( &windowSettings );
915
916 Prj().GetLocalSettings().SaveFileState( rfn.GetFullPath(), &windowSettings, true );
917 Prj().GetLocalSettings().SaveToFile( Prj().GetProjectPath() );
918 }
919
920 return 0;
921}
922
923
925{
926 wxString execFile;
927 wxString param;
928
930 execFile = GERBVIEW_EXE;
932 execFile = BITMAPCONVERTER_EXE;
934 execFile = PCB_CALCULATOR_EXE;
936 execFile = PL_EDITOR_EXE;
938 execFile = Pgm().GetTextEditor();
940 execFile = EESCHEMA_EXE;
942 execFile = PCBNEW_EXE;
943 else
944 wxFAIL_MSG( "Execute(): unexpected request" );
945
946 if( execFile.IsEmpty() )
947 return 0;
948
949 if( aEvent.Parameter<wxString*>() )
950 param = *aEvent.Parameter<wxString*>();
952 param = m_frame->Prj().GetProjectPath();
953
954 COMMON_CONTROL* commonControl = m_toolMgr->GetTool<COMMON_CONTROL>();
955 return commonControl->Execute( execFile, param );
956}
957
958
960{
962 {
963 // policy disables the plugin manager
964 return 0;
965 }
966
967 // For some reason, after a click or a double click the bitmap button calling
968 // PCM keeps the focus althougt the focus was not set to this button.
969 // This hack force removing the focus from this button
970 m_frame->SetFocus();
971 wxSafeYield();
972
973 if( !m_frame->GetPcm() )
975
976 DIALOG_PCM pcm( m_frame, m_frame->GetPcm() );
977 pcm.ShowModal();
978
979 const std::unordered_set<PCM_PACKAGE_TYPE>& changed = pcm.GetChangedPackageTypes();
980
981 if( changed.count( PCM_PACKAGE_TYPE::PT_PLUGIN ) || changed.count( PCM_PACKAGE_TYPE::PT_FAB ) )
982 {
983 std::string payload = "";
985 }
986
987 KICAD_SETTINGS* settings = GetAppSettings<KICAD_SETTINGS>( "kicad" );
988
989 if( changed.count( PCM_PACKAGE_TYPE::PT_LIBRARY )
990 && ( settings->m_PcmLibAutoAdd || settings->m_PcmLibAutoRemove ) )
991 {
992 // Reset project tables
994 Prj().SetElem( PROJECT::ELEM::FPTBL, nullptr );
996
997 KIWAY& kiway = m_frame->Kiway();
998
999 // Reset state containing global lib tables
1000 if( KIFACE* kiface = kiway.KiFACE( KIWAY::FACE_SCH, false ) )
1001 kiface->Reset();
1002
1003 if( KIFACE* kiface = kiway.KiFACE( KIWAY::FACE_PCB, false ) )
1004 kiface->Reset();
1005
1006 // Reload lib tables
1007 std::string payload = "";
1008
1011 kiway.ExpressMail( FRAME_CVPCB, MAIL_RELOAD_LIB, payload );
1013 kiway.ExpressMail( FRAME_SCH_VIEWER, MAIL_RELOAD_LIB, payload );
1014 }
1015
1016 if( changed.count( PCM_PACKAGE_TYPE::PT_COLORTHEME ) )
1018
1019 return 0;
1020}
1021
1022
1024{
1036
1040
1043
1053
1056
1058}
static TOOL_ACTION zoomRedraw
Definition: actions.h:131
static TOOL_ACTION saveAs
Definition: actions.h:59
static TOOL_ACTION updateMenu
Definition: actions.h:263
Define the structure of a menu based on ACTIONs.
Definition: action_menu.h:49
void UpdateAll()
Run update handlers for the menu and its submenus.
Handle actions that are shared between different applications.
int Execute(const TOOL_EVENT &aEvent)
const wxString & GetFullURL() const
KIGIT_COMMON::GIT_CONN_TYPE GetRepoType() const
wxString GetRepoSSHPath() const
wxString GetUsername() const
wxString GetRepoName() const
wxString GetPassword() const
Implementing pcm main dialog.
Definition: dialog_pcm.h:38
const std::unordered_set< PCM_PACKAGE_TYPE > & GetChangedPackageTypes() const
Definition: dialog_pcm.h:81
int ShowModal() override
PROJECT_TEMPLATE * GetSelectedTemplate()
wxString GetMruPath() const
bool GetCreateNewDir() const
void SetRemote(const wxString &aRemote)
void SetClonePath(const wxString &aPath)
void SetProgressReporter(std::unique_ptr< WX_PROGRESS_REPORTER > aProgressReporter)
Definition: git_progress.h:40
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
virtual bool LoadFromFile(const wxString &aDirectory="")
Loads the backing file from disk and then calls Load()
static TOOL_ACTION viewDroppedGerbers
static TOOL_ACTION openDemoProject
static TOOL_ACTION editPCB
static TOOL_ACTION unarchiveProject
static TOOL_ACTION loadProject
static TOOL_ACTION editOtherPCB
static TOOL_ACTION newProject
static TOOL_ACTION editOtherSch
static TOOL_ACTION editSchematic
static TOOL_ACTION openTextEditor
static TOOL_ACTION archiveProject
static TOOL_ACTION openProject
static TOOL_ACTION closeProject
static TOOL_ACTION convertImage
static TOOL_ACTION editDrawingSheet
static TOOL_ACTION openProjectDirectory
static TOOL_ACTION openJobsetFile
static TOOL_ACTION newJobsetFile
static TOOL_ACTION editFootprints
static TOOL_ACTION showPluginManager
static TOOL_ACTION showCalculator
static TOOL_ACTION viewGerbers
static TOOL_ACTION newFromRepository
static TOOL_ACTION newFromTemplate
static TOOL_ACTION editSymbols
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
int OpenProject(const TOOL_EVENT &aEvent)
int NewJobsetFile(const TOOL_EVENT &aEvent)
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
int OpenDemoProject(const TOOL_EVENT &aEvent)
int CloseProject(const TOOL_EVENT &aEvent)
int ArchiveProject(const TOOL_EVENT &aEvent)
int SaveProjectAs(const TOOL_EVENT &aEvent)
int NewProject(const TOOL_EVENT &aEvent)
int UnarchiveProject(const TOOL_EVENT &aEvent)
int ViewDroppedViewers(const TOOL_EVENT &aEvent)
Imports a non kicad project from a sch/pcb dropped file.
int NewFromTemplate(const TOOL_EVENT &aEvent)
int ShowPluginManager(const TOOL_EVENT &aEvent)
Set up handlers for various events.
int UpdateMenu(const TOOL_EVENT &aEvent)
int OpenJobsetFile(const TOOL_EVENT &aEvent)
wxFileName newProjectDirectory(wxString *aFileName=nullptr, bool isRepo=false)
int NewFromRepository(const TOOL_EVENT &aEvent)
int LoadProject(const TOOL_EVENT &aEvent)
KICAD_MANAGER_FRAME * m_frame
< Pointer to the currently used edit/draw frame.
int ExploreProject(const TOOL_EVENT &aEvent)
int ShowPlayer(const TOOL_EVENT &aEvent)
int Refresh(const TOOL_EVENT &aEvent)
int openProject(const wxString &aDefaultDir)
int Execute(const TOOL_EVENT &aEvent)
The main KiCad project manager frame.
void CreateNewProject(const wxFileName &aProjectFileName, bool aCreateStubFiles=true)
Creates a new project by setting up and initial project, schematic, and board files.
const wxString SchLegacyFileName()
wxWindow * GetToolCanvas() const override
Canvas access.
const wxString GetProjectFileName() const
const wxString SchFileName()
void OpenJobsFile(const wxFileName &aFileName, bool aCreate=false, bool aResaveProjectPreferences=true)
void LoadProject(const wxFileName &aProjectFileName)
std::shared_ptr< PLUGIN_CONTENT_MANAGER > GetPcm()
const wxString PcbLegacyFileName()
bool CloseProject(bool aSave)
Closes the project, and saves it if aSave is true;.
const wxString PcbFileName()
wxSize m_TemplateWindowSize
wxPoint m_TemplateWindowPos
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: kidialog.h:50
void DoNotShowCheckbox(wxString file, int line)
Shows the 'do not show again' checkbox.
Definition: kidialog.cpp:51
int ShowModal() override
Definition: kidialog.cpp:95
virtual void Reset() override
Reloads global state.
Definition: kiface_base.h:55
wxString GetErrorString()
void SetPassword(const wxString &aPassword)
Set the password.
std::vector< wxString > GetProjectDirs()
Get a list of project directories.
void SetUsername(const wxString &aUsername)
Set the username.
void SetSSHKey(const wxString &aSSHKey)
Set the SSH key.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:55
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:65
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:285
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:395
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
Definition: kiway.cpp:198
@ FACE_SCH
eeschema DSO
Definition: kiway.h:292
@ FACE_PL_EDITOR
Definition: kiway.h:296
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:293
@ FACE_GERBVIEW
Definition: kiway.h:295
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:499
static wxString GetStockDemosPath()
Gets the stock (install) demos path.
Definition: paths.cpp:413
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.cpp:802
virtual const wxString & GetTextEditor(bool aCanShowFileChooser=true)
Return the path to the preferred text editor application.
Definition: pgm_base.cpp:188
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:125
static bool Archive(const wxString &aSrcDir, const wxString &aDestFile, REPORTER &aReporter, bool aVerbose=true, bool aIncludeExtraFiles=false)
Create an archive of the project.
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:74
bool SaveAs(const wxString &aDirectory, const wxString &aFile)
bool SaveToFile(const wxString &aDirectory="", bool aForce=false) override
Calls Store() and then writes the contents of the JSON document to a file.
The project local settings are things that are attached to a particular project, but also might be pa...
bool SaveAs(const wxString &aDirectory, const wxString &aFile)
bool SaveToFile(const wxString &aDirectory="", bool aForce=false) override
Calls Store() and then writes the contents of the JSON document to a file.
void SaveFileState(const wxString &aFileName, const WINDOW_SETTINGS *aWindowCfg, bool aOpen)
size_t GetDestinationFiles(const wxFileName &aNewProjectPath, std::vector< wxFileName > &aDestFiles)
Fetch the list of destination files to be copied when the new project is created.
bool CreateProject(wxFileName &aNewProjectPath, wxString *aErrorMsg=nullptr)
Copies and renames all template files to create a new project.
PROJECT_TREE_PANE Window to display the tree files.
PROJECT_TREE * m_TreeProject
KIGIT_COMMON * GitCommon() const
Definition: project_tree.h:63
virtual void SetElem(PROJECT::ELEM aIndex, _ELEM *aElem)
Definition: project.cpp:361
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:148
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:160
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:210
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:204
KICAD_MANAGER_FRAME * m_frame
virtual wxDirTraverseResult OnFile(const wxString &aSrcFilePath) override
SAVE_AS_TRAVERSER(KICAD_MANAGER_FRAME *aFrame, const wxString &aSrcProjectDirPath, const wxString &aSrcProjectName, const wxString &aNewProjectDirPath, const wxString &aNewProjectName)
virtual wxDirTraverseResult OnDir(const wxString &aSrcDirPath) override
void ReloadColorSettings()
Re-scan the color themes directory, reloading any changes it finds.
A wrapper for reporting to a specific text location in a statusbar.
Definition: reporter.h:295
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:220
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:168
bool IsAction(const TOOL_ACTION *aAction) const
Test if the event contains an action issued upon activation of the given TOOL_ACTION.
Definition: tool_event.cpp:82
T Parameter() const
Return a parameter assigned to the event.
Definition: tool_event.h:465
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Define which state (aStateFunc) to go when a certain event arrives (aConditions).
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:260
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:231
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:203
This file is part of the common library.
#define _(s)
Functions related to environment variables, including help functions.
KiCad executable names.
const wxString EESCHEMA_EXE
const wxString GERBVIEW_EXE
const wxString PL_EDITOR_EXE
const wxString BITMAPCONVERTER_EXE
const wxString PCBNEW_EXE
const wxString PCB_CALCULATOR_EXE
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
@ FRAME_PCB_EDITOR
Definition: frame_type.h:42
@ FRAME_SCH_SYMBOL_EDITOR
Definition: frame_type.h:35
@ FRAME_FOOTPRINT_VIEWER
Definition: frame_type.h:45
@ FRAME_SCH_VIEWER
Definition: frame_type.h:36
@ FRAME_SCH
Definition: frame_type.h:34
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:43
@ FRAME_CVPCB
Definition: frame_type.h:52
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition: gestfich.cpp:290
static const std::string LegacySchematicFileExtension
static const std::string NetlistFileExtension
static const std::string SymbolLibraryTableFileName
static const std::string GerberJobFileExtension
static const std::string LockFileExtension
static const std::string ProjectFileExtension
static const std::string LegacyPcbFileExtension
static const std::string SchematicSymbolFileExtension
static const std::string LegacyProjectFileExtension
static const std::string ProjectLocalSettingsFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string LegacySymbolLibFileExtension
static const std::string LockFilePrefix
static const std::string KiCadSymbolLibFileExtension
static const std::string FootprintLibraryTableFileName
static const std::string DrawingSheetFileExtension
static const std::string BackupFileSuffix
static const std::string LegacyFootprintLibPathExtension
static const std::string LegacySymbolDocumentFileExtension
static const std::string FootprintAssignmentFileExtension
static const std::string DrillFileExtension
static const std::string KiCadFootprintFileExtension
static const std::string ArchiveFileExtension
static const std::string KiCadPcbFileExtension
static wxString ProjectFileWildcard()
static bool IsGerberFileExtension(const wxString &ext)
static wxString JobsetFileWildcard()
static wxString LegacyProjectFileWildcard()
static wxString AllProjectFilesWildcard()
static wxString ZipFileWildcard()
std::map< wxString, ENV_VAR_ITEM >::const_iterator ENV_VAR_MAP_CITER
PROJECT & Prj()
Definition: kicad.cpp:597
This file is part of the common library.
bool LaunchExternal(const wxString &aPath)
Launches the given file or folder in the host OS.
Definition: launch_ext.cpp:25
@ MAIL_RELOAD_PLUGINS
Definition: mail_type.h:58
@ MAIL_RELOAD_LIB
Definition: mail_type.h:57
KICOMMON_API std::optional< wxString > GetVersionedEnvVarValue(const std::map< wxString, ENV_VAR_ITEM > &aMap, const wxString &aBaseName)
Attempt to retrieve the value of a versioned environment variable, such as KICAD8_TEMPLATE_DIR.
Definition: env_vars.cpp:92
PBOOL GetPolicyBool(const wxString &aKey)
Definition: unix/policy.cpp:26
bool StoreSecret(const wxString &aService, const wxString &aKey, const wxString &aSecret)
PGM_BASE & Pgm()
The global program "get" accessor.
Definition: pgm_base.cpp:893
see class PGM_BASE
#define POLICY_KEY_PCM
Definition: policy_keys.h:31
#define PROJECT_BACKUPS_DIR_SUFFIX
Project settings path will be <projectname> + this.
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:152
virtual void SaveFileAs(const wxString &srcProjectBasePath, const wxString &srcProjectName, const wxString &newProjectBasePath, const wxString &newProjectName, const wxString &srcFilePath, wxString &aErrors)
Saving a file under a different name is delegated to the various KIFACEs because the project doesn't ...
Definition: kiway.h:217
Store the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:90
IFACE KIFACE_BASE kiface("pcb_test_frame", KIWAY::FACE_PCB)
VECTOR2I end
Definition of file extensions used in Kicad.
#define PR_NO_ABORT