50#include <wx/filedlg.h>
63 m_inShowPlayer( false )
70 m_frame = getEditFrame<KICAD_MANAGER_FRAME>();
76 wxString default_filename = aFileName ? *aFileName : wxString();
79 wxFileDialog dlg(
m_frame,
_(
"Create New Project" ), default_dir, default_filename,
81 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
87 dlg.SetCustomizeHook( newProjectHook );
89 if( dlg.ShowModal() == wxID_CANCEL )
92 wxFileName pro( dlg.GetPath() );
97 pro.SetName( pro.GetName() + wxT(
"." ) + pro.GetExt() );
101 if( !pro.IsAbsolute() )
105 bool createNewDir =
false;
110 pro.AppendDir( pro.GetName() );
115 if( !pro.DirExists() )
120 msg.Printf(
_(
"Folder '%s' could not be created.\n\n"
121 "Make sure you have write permissions and try again." ),
129 wxString msg =
_(
"The selected folder is not empty. It is recommended that you "
130 "create projects in their own empty folder.\n\n"
131 "Do you want to continue?" );
159 dlg.SetTitle(
_(
"Clone Project from Git Repository" ) );
194 if( projects.empty() )
202 wxString dest = pro.GetPath() + wxFileName::GetPathSeparator() + projects.front();
222 wxString default_dir = wxFileName(
Prj().GetProjectFullName() ).GetPathWithSep();
224 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
226 if( dlg.ShowModal() == wxID_CANCEL )
229 wxFileName jobsetFn( dlg.GetPath() );
239 KICAD_SETTINGS* settings = GetAppSettings<KICAD_SETTINGS>(
"kicad" );
240 std::map<wxString, wxFileName> titleDirMap;
241 wxFileName templatePath;
245 wxT(
"TEMPLATE_DIR" ) );
247 if( v && !v->IsEmpty() )
249 templatePath.AssignDir( *v );
250 titleDirMap.emplace(
_(
"System Templates" ), templatePath );
256 if( it !=
Pgm().GetLocalEnvVariables().
end() && it->second.GetValue() != wxEmptyString )
258 templatePath.AssignDir( it->second.GetValue() );
259 titleDirMap.emplace(
_(
"User Templates" ), templatePath );
271 if( result != wxID_OK )
276 wxMessageBox(
_(
"No project template was selected. Cannot generate new project." ),
_(
"Error" ),
277 wxOK | wxICON_ERROR,
m_frame );
283 wxString default_dir = wxFileName(
Prj().GetProjectFullName() ).GetPathWithSep();
284 wxString title =
_(
"New Project Folder" );
286 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
292 dlg.SetCustomizeHook( newProjectHook );
294 if( dlg.ShowModal() == wxID_CANCEL )
297 wxFileName fn( dlg.GetPath() );
302 fn.SetName( fn.GetName() + wxT(
"." ) + fn.GetExt() );
306 if( !fn.IsAbsolute() )
309 bool createNewDir =
false;
314 fn.AppendDir( fn.GetName() );
317 if( !fn.DirExists() && !fn.Mkdir() )
320 "Make sure you have write permissions and try again." ),
325 if( !fn.IsDirWritable() )
333 std::vector< wxFileName > destFiles;
337 std::vector<wxFileName> overwrittenFiles;
339 for(
const wxFileName& file : destFiles )
341 if( file.FileExists() )
342 overwrittenFiles.push_back( file );
345 if( !overwrittenFiles.empty() )
347 wxString extendedMsg =
_(
"Overwriting files:" ) +
"\n";
349 for(
const wxFileName& file : overwrittenFiles )
350 extendedMsg +=
"\n" + file.GetFullName();
352 KIDIALOG msgDlg(
m_frame,
_(
"Similar files already exist in the destination folder." ),
353 _(
"Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
354 msgDlg.SetExtendedMessage( extendedMsg );
355 msgDlg.SetOKLabel(
_(
"Overwrite" ) );
385 wxFileDialog dlg(
m_frame,
_(
"Open Existing Project" ), aDefaultDir, wxEmptyString, wildcard,
386 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
390 if( dlg.ShowModal() == wxID_CANCEL )
393 wxFileName pro( dlg.GetPath() );
395 if( !pro.IsAbsolute() )
426 wxString default_dir = wxFileName(
Prj().GetProjectFullName() ).GetPathWithSep();
428 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
430 if( dlg.ShowModal() == wxID_CANCEL )
433 wxFileName jobsetFn( dlg.GetPath() );
462 wxFileDialog dlg(
m_frame,
_(
"Archive Project Files" ), fileName.GetPath(), fileName.GetFullName(),
465 if( dlg.ShowModal() == wxID_CANCEL )
468 wxFileName zipFile = dlg.GetPath();
470 wxString currdirname = fileName.GetPathWithSep();
471 wxDir dir( currdirname );
473 if( !dir.IsOpened() )
479 archiver.
Archive( currdirname, zipFile.GetFullPath(), reporter,
true,
true );
502 wxExecute( *aEvent.
Parameter<wxString*>(), wxEXEC_ASYNC );
510 const wxString& aSrcProjectDirPath,
511 const wxString& aSrcProjectName,
512 const wxString& aNewProjectDirPath,
513 const wxString& aNewProjectName ) :
522 virtual wxDirTraverseResult
OnFile(
const wxString& aSrcFilePath )
override
526 return wxDIR_CONTINUE;
528 wxFileName destFile( aSrcFilePath );
529 wxString ext = destFile.GetExt();
536 wxString destPath = destFile.GetPath();
541 destFile.SetPath( destPath );
561 projectFile.
SaveAs( destFile.GetPath(), destFile.GetName() );
567 projectLocalSettings.
SaveAs( destFile.GetPath(), destFile.GetName() );
619 wxString destPath = destFile.GetPathWithSep();
620 wxString destName = destFile.GetName();
621 wxUniChar pathSep = wxFileName::GetPathSeparator();
623 wxString srcProjectFootprintLib = pathSep +
m_projectName +
".pretty" + pathSep;
624 wxString newProjectFootprintLib = pathSep +
m_newProjectName +
".pretty" + pathSep;
629 destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib,
true );
634 destFile.SetPath( destPath );
639 return wxDIR_CONTINUE;
642 virtual wxDirTraverseResult
OnDir(
const wxString& aSrcDirPath )
override
646 return wxDIR_CONTINUE;
648 wxFileName destDir( aSrcDirPath );
649 wxString destDirPath = destDir.GetPathWithSep();
650 wxUniChar pathSep = wxFileName::GetPathSeparator();
656 destDir.SetPath( destDirPath );
661 if( destDir.GetExt() ==
"pretty" )
666 else if( destDir.GetExt() ==
"sym_lib_dir_extension" )
671 if( !wxMkdir( destDir.GetFullPath() ) )
678 msg.Printf(
_(
"Cannot copy folder '%s'." ), destDir.GetFullPath() );
682 return wxDIR_CONTINUE;
706 wxFileName currentProjectFile(
Prj().GetProjectFullName() );
707 wxString currentProjectDirPath = currentProjectFile.GetPath();
715 if( default_dir == currentProjectDirPath
716 || default_dir == currentProjectDirPath + wxFileName::GetPathSeparator() )
719 wxFileName default_dir_fn( default_dir );
720 default_dir_fn.RemoveLastDir();
721 default_dir = default_dir_fn.GetPath();
724 wxFileDialog dlg(
m_frame,
_(
"Save Project To" ), default_dir, wxEmptyString, wxEmptyString, wxFD_SAVE );
728 if( dlg.ShowModal() == wxID_CANCEL )
731 wxFileName newProjectDir( dlg.GetPath(), wxEmptyString );
733 if( !newProjectDir.IsAbsolute() )
734 newProjectDir.MakeAbsolute();
736 if( wxDirExists( newProjectDir.GetFullPath() ) )
738 msg.Printf(
_(
"'%s' already exists." ), newProjectDir.GetFullPath() );
743 if( !wxMkdir( newProjectDir.GetFullPath() ) )
746 "Please make sure you have sufficient permissions." ),
747 newProjectDir.GetPath() ) );
751 if( !newProjectDir.IsDirWritable() )
754 newProjectDir.GetFullPath() ) );
758 const wxString& newProjectDirPath = newProjectDir.GetFullPath();
759 const wxString& newProjectName = newProjectDir.GetDirs().Last();
760 wxDir currentProjectDir( currentProjectDirPath );
765 currentProjectDir.Traverse( traverser );
792 if( conditionalMenu )
793 conditionalMenu->Evaluate( dummySel );
829 wxLogError(
_(
"Application failed to load:\n" ) + err.
What() );
835 wxLogError(
_(
"Application cannot start." ) );
839 if( !player->IsVisible() )
848 if( !legacy_schematic.FileExists() || kicad_schematic.FileExists() )
849 filepath = kicad_schematic.GetFullPath();
851 filepath = legacy_schematic.GetFullPath();
858 if( !legacy_board.FileExists() || kicad_board.FileExists() )
859 filepath = kicad_board.GetFullPath();
861 filepath = legacy_board.GetFullPath();
864 if( !filepath.IsEmpty() )
866 std::vector<wxString> file_list{ filepath };
868 if( !player->OpenProjectFiles( file_list ) )
876 player->Show(
true );
880 if( player->IsIconized() )
881 player->Iconize(
false );
887 if( wxWindow::FindFocus() != player )
891 if(
Pgm().GetCommonSettings()->m_Session.remember_open_files
892 && !player->GetCurrentFileName().IsEmpty()
893 &&
Prj().GetLocalSettings().ShouldAutoSave() )
895 wxFileName rfn( player->GetCurrentFileName() );
896 rfn.MakeRelativeTo(
Prj().GetProjectPath() );
899 player->SaveWindowSettings( &windowSettings );
929 wxFAIL_MSG(
"Execute(): unexpected request" );
931 if( execFile.IsEmpty() )
940 return commonControl->
Execute( execFile, param );
966 if( changed.count( PCM_PACKAGE_TYPE::PT_PLUGIN ) || changed.count( PCM_PACKAGE_TYPE::PT_FAB ) )
968 std::string payload =
"";
972 KICAD_SETTINGS* settings = GetAppSettings<KICAD_SETTINGS>(
"kicad" );
974 if( changed.count( PCM_PACKAGE_TYPE::PT_LIBRARY )
992 std::string payload =
"";
1001 if( changed.count( PCM_PACKAGE_TYPE::PT_COLORTHEME ) )
static TOOL_ACTION zoomRedraw
static TOOL_ACTION saveAs
static TOOL_ACTION updateMenu
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 GetRepoURL() const
wxString GetUsername() const
wxString GetRepoName() const
wxString GetPassword() const
Implementing pcm main dialog.
const std::unordered_set< PCM_PACKAGE_TYPE > & GetChangedPackageTypes() const
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)
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
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)
bool m_inShowPlayer
Re-entrancy guard.
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;.
void RefreshProjectTree()
const wxString PcbFileName()
wxSize m_TemplateWindowSize
wxPoint m_TemplateWindowPos
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
void DoNotShowCheckbox(wxString file, int line)
Shows the 'do not show again' checkbox.
virtual void Reset() override
Reloads global state.
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.
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
static wxString GetStockDemosPath()
Gets the stock (install) demos path.
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
virtual const wxString & GetTextEditor(bool aCanShowFileChooser=true)
Return the path to the preferred text editor application.
virtual SETTINGS_MANAGER & GetSettingsManager() const
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.
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.
wxString m_GitRepoUsername
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
virtual void SetElem(PROJECT::ELEM aIndex, _ELEM *aElem)
virtual const wxString GetProjectPath() const
Return the full path of the project.
virtual const wxString GetProjectName() const
Return the short name of the project.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
virtual PROJECT_FILE & GetProjectFile() const
wxString m_newProjectName
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
wxString m_projectDirPath
wxFileName GetNewProjectFile()
wxString m_newProjectDirPath
wxFileName m_newProjectFile
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.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
Functions related to environment variables, including help functions.
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.
@ FRAME_SCH_SYMBOL_EDITOR
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
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
This file is part of the common library.
bool LaunchExternal(const wxString &aPath)
Launches the given file or folder in the host OS.
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.
PGM_BASE & Pgm()
The global program "get" accessor.
#define PROJECT_BACKUPS_DIR_SUFFIX
Project settings path will be <projectname> + this.
Implement a participant in the KIWAY alchemy.
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 ...
Store the common settings that are saved and loaded for each window / frame.
IFACE KIFACE_BASE kiface("pcb_test_frame", KIWAY::FACE_PCB)
Definition of file extensions used in Kicad.