44#include <wx/checkbox.h>
46#include <wx/filedlg.h>
64 m_frame = getEditFrame<KICAD_MANAGER_FRAME>();
70 wxString default_filename = aFileName ? *aFileName : wxString();
73 wxFileDialog dlg(
m_frame,
_(
"Create New Project" ), default_dir, default_filename,
75 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
79 dlg.SetCustomizeHook( newProjectHook );
81 if( dlg.ShowModal() == wxID_CANCEL )
84 wxFileName pro( dlg.GetPath() );
89 pro.SetName( pro.GetName() + wxT(
"." ) + pro.GetExt() );
93 if( !pro.IsAbsolute() )
97 bool createNewDir =
false;
102 pro.AppendDir( pro.GetName() );
107 if( !pro.DirExists() )
112 msg.Printf(
_(
"Folder '%s' could not be created.\n\n"
113 "Make sure you have write permissions and try again." ),
121 wxString msg =
_(
"The selected folder is not empty. It is recommended that you "
122 "create projects in their own empty folder.\n\n"
123 "Do you want to continue?" );
152 dlg.SetTitle(
_(
"Clone Project from Git Repository" ) );
154 int ret = dlg.ShowModal();
184 if( projects.empty() )
192 wxString dest = pro.GetPath() + wxFileName::GetPathSeparator() + projects.front();
214 wxFileName templatePath;
218 wxT(
"TEMPLATE_DIR" ) );
220 if( v && !v->IsEmpty() )
222 templatePath.AssignDir( *v );
229 if( it !=
Pgm().GetLocalEnvVariables().end() && it->second.GetValue() != wxEmptyString )
231 templatePath.AssignDir( it->second.GetValue() );
236 if( ps->ShowModal() != wxID_OK )
241 wxMessageBox(
_(
"No project template was selected. Cannot generate new project." ),
242 _(
"Error" ), wxOK | wxICON_ERROR,
m_frame );
248 wxString default_dir = wxFileName(
Prj().GetProjectFullName() ).GetPathWithSep();
249 wxString title =
_(
"New Project Folder" );
251 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
255 dlg.SetCustomizeHook( newProjectHook );
257 if( dlg.ShowModal() == wxID_CANCEL )
260 wxFileName fn( dlg.GetPath() );
265 fn.SetName( fn.GetName() + wxT(
"." ) + fn.GetExt() );
269 if( !fn.IsAbsolute() )
272 bool createNewDir =
false;
277 fn.AppendDir( fn.GetName() );
281 if( !fn.DirExists() )
286 msg.Printf(
_(
"Folder '%s' could not be created.\n\n"
287 "Make sure you have write permissions and try again." ),
294 if( !fn.IsDirWritable() )
298 msg.Printf(
_(
"Insufficient permissions to write to folder '%s'." ), fn.GetPath() );
299 wxMessageDialog msgDlg(
m_frame, msg,
_(
"Error" ), wxICON_ERROR | wxOK | wxCENTER );
305 std::vector< wxFileName > destFiles;
309 std::vector<wxFileName> overwrittenFiles;
311 for(
const wxFileName& file : destFiles )
313 if( file.FileExists() )
314 overwrittenFiles.push_back( file );
317 if( !overwrittenFiles.empty() )
319 wxString extendedMsg =
_(
"Overwriting files:" ) +
"\n";
321 for(
const wxFileName& file : overwrittenFiles )
322 extendedMsg +=
"\n" + file.GetFullName();
325 _(
"Similar files already exist in the destination folder." ),
327 wxOK | wxCANCEL | wxICON_WARNING );
328 msgDlg.SetExtendedMessage( extendedMsg );
329 msgDlg.SetOKLabel(
_(
"Overwrite" ) );
343 wxMessageDialog createDlg(
m_frame,
344 _(
"A problem occurred creating new project from template." ),
346 wxOK | wxICON_ERROR );
348 if( !errorMsg.empty() )
349 createDlg.SetExtendedMessage( errorMsg );
351 createDlg.ShowModal();
367 wxFileDialog dlg(
m_frame,
_(
"Open Existing Project" ), aDefaultDir, wxEmptyString, wildcard,
368 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
370 if( dlg.ShowModal() == wxID_CANCEL )
373 wxFileName pro( dlg.GetPath() );
375 if( !pro.IsAbsolute() )
378 if( !pro.FileExists() )
416 wxExecute( *aEvent.
Parameter<wxString*>(), wxEXEC_ASYNC );
424 const wxString& aSrcProjectDirPath,
425 const wxString& aSrcProjectName,
426 const wxString& aNewProjectDirPath,
427 const wxString& aNewProjectName ) :
436 virtual wxDirTraverseResult
OnFile(
const wxString& aSrcFilePath )
override
440 return wxDIR_CONTINUE;
442 wxFileName destFile( aSrcFilePath );
443 wxString ext = destFile.GetExt();
450 wxString destPath = destFile.GetPath();
455 destFile.SetPath( destPath );
475 projectFile.
SaveAs( destFile.GetPath(), destFile.GetName() );
481 projectLocalSettings.
SaveAs( destFile.GetPath(), destFile.GetName() );
493 || destFile.GetName() ==
"sym-lib-table" )
505 || destFile.GetName() ==
"fp-lib-table" )
533 wxString destPath = destFile.GetPathWithSep();
534 wxString destName = destFile.GetName();
535 wxUniChar pathSep = wxFileName::GetPathSeparator();
537 wxString srcProjectFootprintLib = pathSep +
m_projectName +
".pretty" + pathSep;
538 wxString newProjectFootprintLib = pathSep +
m_newProjectName +
".pretty" + pathSep;
543 destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib,
true );
548 destFile.SetPath( destPath );
553 return wxDIR_CONTINUE;
556 virtual wxDirTraverseResult
OnDir(
const wxString& aSrcDirPath )
override
560 return wxDIR_CONTINUE;
562 wxFileName destDir( aSrcDirPath );
563 wxString destDirPath = destDir.GetPathWithSep();
564 wxUniChar pathSep = wxFileName::GetPathSeparator();
570 destDir.SetPath( destDirPath );
575 if( destDir.GetExt() ==
"pretty" )
580 else if( destDir.GetExt() ==
"sym_lib_dir_extension" )
585 if( !wxMkdir( destDir.GetFullPath() ) )
592 msg.Printf(
_(
"Cannot copy folder '%s'." ), destDir.GetFullPath() );
596 return wxDIR_CONTINUE;
620 wxFileName currentProjectFile(
Prj().GetProjectFullName() );
621 wxString currentProjectDirPath = currentProjectFile.GetPath();
629 if( default_dir == currentProjectDirPath
630 || default_dir == currentProjectDirPath + wxFileName::GetPathSeparator() )
633 wxFileName default_dir_fn( default_dir );
634 default_dir_fn.RemoveLastDir();
635 default_dir = default_dir_fn.GetPath();
638 wxFileDialog dlg(
m_frame,
_(
"Save Project To" ), default_dir, wxEmptyString, wxEmptyString,
641 if( dlg.ShowModal() == wxID_CANCEL )
644 wxFileName newProjectDir( dlg.GetPath(), wxEmptyString );
646 if( !newProjectDir.IsAbsolute() )
647 newProjectDir.MakeAbsolute();
649 if( wxDirExists( newProjectDir.GetFullPath() ) )
651 msg.Printf(
_(
"'%s' already exists." ), newProjectDir.GetFullPath() );
656 if( !wxMkdir( newProjectDir.GetFullPath() ) )
658 msg.Printf(
_(
"Folder '%s' could not be created.\n\n"
659 "Please make sure you have write permissions and try again." ),
660 newProjectDir.GetPath() );
665 if( !newProjectDir.IsDirWritable() )
667 msg.Printf(
_(
"Insufficient permissions to write to folder '%s'." ),
668 newProjectDir.GetFullPath() );
669 wxMessageDialog msgDlg(
m_frame, msg,
_(
"Error!" ), wxICON_ERROR | wxOK | wxCENTER );
674 const wxString& newProjectDirPath = newProjectDir.GetFullPath();
675 const wxString& newProjectName = newProjectDir.GetDirs().Last();
676 wxDir currentProjectDir( currentProjectDirPath );
679 newProjectDirPath, newProjectName );
681 currentProjectDir.Traverse( traverser );
708 if( conditionalMenu )
709 conditionalMenu->Evaluate( dummySel );
740 const std::lock_guard<std::mutex> lock(
m_loading, std::adopt_lock );
748 wxLogError(
_(
"Application failed to load:\n" ) + err.
What() );
754 wxLogError(
_(
"Application cannot start." ) );
758 if( !player->IsVisible() )
767 if( !legacy_schematic.FileExists() || kicad_schematic.FileExists() )
768 filepath = kicad_schematic.GetFullPath();
770 filepath = legacy_schematic.GetFullPath();
777 if( !legacy_board.FileExists() || kicad_board.FileExists() )
778 filepath = kicad_board.GetFullPath();
780 filepath = legacy_board.GetFullPath();
783 if( !filepath.IsEmpty() )
785 std::vector<wxString> file_list{ filepath };
787 if( !player->OpenProjectFiles( file_list ) )
795 player->Show(
true );
799 if( player->IsIconized() )
800 player->Iconize(
false );
806 if( wxWindow::FindFocus() != player )
810 if(
Pgm().GetCommonSettings()->m_Session.remember_open_files
811 && !player->GetCurrentFileName().IsEmpty() )
813 wxFileName rfn( player->GetCurrentFileName() );
814 rfn.MakeRelativeTo(
Prj().GetProjectPath() );
817 player->SaveWindowSettings( &windowSettings );
854 execFile =
Pgm().GetTextEditor();
860 wxFAIL_MSG(
"Execute(): unexpected request" );
862 if( execFile.IsEmpty() )
872 long pid =
ExecuteFile( execFile, param, callback );
877 wxString script = wxString::Format( wxS(
"tell application \"System Events\"\n"
878 " set frontmost of the first process whose unix id is %l to true\n"
883 wxExecute( wxString::Format(
"osascript -e '%s'", script ) );
918 if( changed.count( PCM_PACKAGE_TYPE::PT_PLUGIN ) )
920 std::string payload =
"";
926 if( changed.count( PCM_PACKAGE_TYPE::PT_LIBRARY )
943 std::string payload =
"";
952 if( changed.count( PCM_PACKAGE_TYPE::PT_COLORTHEME ) )
953 Pgm().GetSettingsManager().ReloadColorSettings();
static TOOL_ACTION zoomRedraw
static TOOL_ACTION saveAs
static TOOL_ACTION updateMenu
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
void AddTemplatesPage(const wxString &aTitle, wxFileName &aPath)
Add a new page with aTitle, populated with templates from aPath.
PROJECT_TEMPLATE * GetSelectedTemplate()
wxString GetMruPath() const
bool GetCreateNewDir() const
void SetURL(const wxString &aURL)
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 loadProject
static TOOL_ACTION editOtherPCB
static TOOL_ACTION newProject
static TOOL_ACTION editOtherSch
static TOOL_ACTION editSchematic
static TOOL_ACTION openTextEditor
static TOOL_ACTION openProject
static TOOL_ACTION closeProject
static TOOL_ACTION convertImage
static TOOL_ACTION editDrawingSheet
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)
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 SaveProjectAs(const TOOL_EVENT &aEvent)
int NewProject(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)
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 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()
const wxString SchFileName()
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()
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
void DoNotShowCheckbox(wxString file, int line)
Checks the 'do not show again' setting for the dialog.
virtual void Reset() override
Reloads global state.
void SetConnType(GIT_CONN_TYPE aConnType)
void SetSSHKey(const wxString &aSSHKey)
void SetUsername(const wxString &aUsername)
std::vector< wxString > GetProjectDirs()
Return a vector of project files in the repository.
void SetPassword(const wxString &aPassword)
wxString GetErrorString()
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 GetStockDemosPath()
Gets the stock (install) demos path.
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)
wxString m_GitRepoPassword
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.
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
virtual void SetElem(ELEM_T aIndex, _ELEM *aElem)
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 OnTerminate(int pid, int status) override
TERMINATE_HANDLER(const wxString &appName)
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)
int ExecuteFile(const wxString &aEditorName, const wxString &aFileName, wxProcess *aCallback, bool aFileForKicad)
Call the executable file aEditorName with the parameter aFileName.
static const std::string LegacySchematicFileExtension
static const std::string NetlistFileExtension
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 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 KiCadPcbFileExtension
static wxString ProjectFileWildcard()
static bool IsGerberFileExtension(const wxString &ext)
static wxString LegacyProjectFileWildcard()
static wxString AllProjectFilesWildcard()
std::map< wxString, ENV_VAR_ITEM >::const_iterator ENV_VAR_MAP_CITER
This file contains miscellaneous commonly used macros and functions.
std::optional< wxString > GetVersionedEnvVarValue(const std::map< wxString, ENV_VAR_ITEM > &aMap, const wxString &aBaseName)
Attempts to retrieve the value of a versioned environment variable, such as KICAD8_TEMPLATE_DIR.
#define PROJECT_BACKUPS_DIR_SUFFIX
Project settings path will be <projectname> + this.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
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 ...
Stores 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.