65#include <wx/filedlg.h>
67#include <wx/process.h>
72#include <../pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h>
77#include <ApplicationServices/ApplicationServices.h>
84#define SEP() wxFileName::GetPathSeparator()
121#include <wx/xml/xml.h>
124 const wxPoint& pos,
const wxSize& size ) :
127 m_leftWin( nullptr ),
128 m_launcher( nullptr ),
129 m_mainToolBar( nullptr ),
130 m_lastToolbarIconSize( 0 )
132 const int defaultLeftWinWidth = FromDIP( 250 );
134 m_active_project =
false;
135 m_leftWinWidth = defaultLeftWinWidth;
136 m_aboutTitle =
"KiCad";
151 CreateStatusBar( 1 );
158 wxIconBundle icon_bundle;
163 icon_bundle.AddIcon( icon );
165 icon_bundle.AddIcon( icon );
167 icon_bundle.AddIcon( icon );
169 icon_bundle.AddIcon( icon );
171 icon_bundle.AddIcon( icon );
176 icon_bundle.AddIcon( icon );
178 icon_bundle.AddIcon( icon );
180 icon_bundle.AddIcon( icon );
182 icon_bundle.AddIcon( icon );
184 icon_bundle.AddIcon( icon );
187 SetIcons( icon_bundle );
192 m_pcmButton =
nullptr;
193 m_pcmUpdateCount = 0;
203 RecreateBaseLeftToolbar();
206 m_auimgr.SetManagedWindow(
this );
207 m_auimgr.SetFlags( wxAUI_MGR_LIVE_RESIZE );
209 m_auimgr.AddPane( m_mainToolBar,
EDA_PANE().VToolbar().Name(
"MainToolbar" ).Left()
217 m_auimgr.AddPane( m_leftWin,
EDA_PANE().Palette().Name(
"ProjectTree" ).Left().Layer( 1 )
218 .Caption(
_(
"Project Files" ) ).PaneBorder(
false )
219 .MinSize( m_leftWinWidth, -1 ).BestSize( m_leftWinWidth, -1 ) );
221 m_auimgr.AddPane( m_launcher,
EDA_PANE().Canvas().Name(
"Launcher" ).Center()
222 .Caption(
_(
"Editors" ) ).PaneBorder(
false )
223 .MinSize( m_launcher->GetBestSize() ) );
228 m_auimgr.GetPane( m_leftWin ).MinSize( defaultLeftWinWidth, -1 );
230 wxSizer* mainSizer = GetSizer();
233 if( mainSizer &&
config()->m_Window.state.size_x == 0 &&
config()->m_Window.state.size_y == 0 )
234 mainSizer->Fit(
this );
237 SetTitle( wxT(
"KiCad" ) );
242 m_leftWin->SetFocus();
254 DragAcceptFiles(
true );
274 m_pcm->StopBackgroundUpdate();
285 const wxString&
name )
297 m_pcm = std::make_shared<PLUGIN_CONTENT_MANAGER>(
298 [
this](
int aUpdateCount )
302 if( aUpdateCount > 0 )
306 _(
"PCM Updates Available" ),
307 wxString::Format(
_(
"%d package update(s) avaliable" ), aUpdateCount ),
360#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
363 activeProjectCond.
Enable( activeProject );
406 wxString( wxEmptyString );
415 return fn.GetFullPath();
424 return fn.GetFullPath();
432 fn.SetExt( FILEEXT::PcbFileExtension );
433 return fn.GetFullPath();
442 return fn.GetFullPath();
487 wxString ext = fileName.GetExt();
491 wxString fn = fileName.GetFullPath();
499 wxString gerberFiles;
504 wxString ext = fileName.GetExt();
509 gerberFiles += wxT(
'\"' );
510 gerberFiles += fileName.GetFullPath() + wxT(
'\"' );
511 gerberFiles = gerberFiles.Pad( 1 );
515 wxString fn = fileName.GetFullPath();
521 if( !gerberFiles.IsEmpty() )
525 if( wxFileExists( fullEditorName ) )
527 wxString command = fullEditorName +
" " + gerberFiles;
545 aEvent.StopPropagation();
551 if( aEvent.CanVeto() )
569 static std::atomic<unsigned int> lock_close_event( 0 );
571 if( ++lock_close_event > 1 )
583 lock_close_event = 0;
596 if( !
Kiway().PlayersClose(
false ) )
624 if( !aProjectFileName.Exists() )
639 if( aProjectFileName.IsDirWritable() )
654 wxPostEvent(
this, cmd );
664 bool aCreateStubFiles )
666 wxCHECK_RET( aProjectFileName.DirExists() && aProjectFileName.IsDirWritable(),
667 "Project folder must exist and be writable to create a new project." );
670 if( !aProjectFileName.FileExists() )
672 wxFileName legacyPro( aProjectFileName );
675 if( legacyPro.FileExists() )
680 wxRemoveFile( legacyPro.GetFullPath() );
685 wxString srcFileName =
sys_search().FindValidPath(
"kicad.kicad_pro" );
687 wxFileName destFileName( aProjectFileName );
691 if( !wxFileName::FileExists( srcFileName )
692 || !wxCopyFile( srcFileName, destFileName.GetFullPath() ) )
694 wxFFile file( destFileName.GetFullPath(),
"wb" );
696 if( file.IsOpened() )
697 file.Write( wxT(
"{\n}\n") );
707 if( aCreateStubFiles )
709 wxFileName fn( aProjectFileName.GetFullPath() );
714 if( !fn.FileExists() )
716 wxFFile file( fn.GetFullPath(),
"wb" );
718 if( file.IsOpened() )
719 file.Write( wxString::Format(
"(kicad_sch (version %d) (generator \"eeschema\") (generator_version \"%s\")\n"
720 " (paper \"A4\")\n (lib_symbols)\n"
721 " (symbol_instances)\n)\n",
730 wxFileName leg_fn( fn );
733 if( !fn.FileExists() && !leg_fn.FileExists() )
735 wxFFile file( fn.GetFullPath(),
"wb" );
737 if( file.IsOpened() )
739 file.Write( wxString::Format(
"(kicad_pcb (version %d) (generator \"pcbnew\") (generator_version \"%s\")\n)",
762 wxFileDialog dlg(
this,
_(
"Edit File in Text Editor" ), default_dir, wxEmptyString, wildcard,
765 if( dlg.ShowModal() == wxID_CANCEL )
768 wxString filename = dlg.GetPath();
770 if( !dlg.GetPath().IsEmpty() && !
Pgm().GetTextEditor().IsEmpty() )
790 int id =
event.GetId();
812 if(
m_pcm && aEnvVarsChanged )
833 if( !file.IsEmpty() )
835 wxFileName fn( file );
837 title = fn.GetName();
839 if( !fn.IsDirWritable() )
840 title += wxS(
" " ) +
_(
"[Read Only]" );
844 title =
_(
"[no project loaded]" );
848 title += wxT(
" \u2014 " ) + wxString( wxS(
"KiCad" ) );
862 wxCHECK( settings, );
874 wxCHECK( settings, );
876 settings->m_LeftWinWidth =
m_leftWin->GetSize().x;
887 wxString status = wxString::Format(
_(
"Project: %s" ),
Prj().GetProjectFullName() );
911 if(
Pgm().GetCommonSettings()->m_Session.remember_open_files )
913 int previousOpenCount =
914 std::count_if(
Prj().GetLocalSettings().m_files.begin(),
915 Prj().GetLocalSettings().m_files.end(),
918 return !f.fileName.EndsWith( FILEEXT::ProjectFileExtension ) && f.open;
921 if( previousOpenCount > 0 )
924 previousOpenCount,
this );
927 std::set<wxString> openedFiles;
933 if( file.open && !openedFiles.count( file.fileName ) )
935 progressReporter.
Update( i++,
936 wxString::Format(
_(
"Restoring '%s'" ), file.fileName ) );
938 openedFiles.insert( file.fileName );
939 wxFileName fn( file.fileName );
963 if( !
Pgm().GetCommonSettings()->m_DoNotShowAgain.update_check_prompt )
977 m_pcm->RunBackgroundUpdate();
980#ifdef KICAD_UPDATE_CHECK
constexpr EDA_IU_SCALE unityScale
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
bool IsNightlyVersion()
Check if the build is meant to be nightly.
static TOOL_ACTION saveAs
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
wxProgressDialog with the option to also update the application progress on the taskbar
virtual bool Update(int aValue, const wxString &aNewMsg=wxEmptyString, bool *aSkip=nullptr) override
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
void UnregisterStatusBar(KISTATUSBAR *aStatusBar)
Removes status bar from handling.
void RegisterStatusBar(KISTATUSBAR *aStatusBar)
Add a status bar for handling.
Handle actions that are shared between different applications.
DO_NOT_SHOW_AGAIN m_DoNotShowAgain
The base frame for deriving all KiCad main window classes.
void LoadWindowState(const wxString &aFileName)
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
std::vector< wxFileName > m_AcceptedFiles
SETTINGS_MANAGER * GetSettingsManager() const
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associates files extensions with action to execute.
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Save common frame parameters to a configuration data file.
void SetMruPath(const wxString &aPath)
virtual void RegisterUIUpdateHandler(int aID, const ACTION_CONDITIONS &aConditions) override
Register a UI update handler for the control with ID aID.
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
Specialization of the wxAuiPaneInfo class for KiCad panels.
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
Calls Store() and then writes the contents of the JSON document to a file.
static TOOL_ACTION viewDroppedGerbers
static TOOL_ACTION editPCB
static TOOL_ACTION loadProject
static TOOL_ACTION editSchematic
static TOOL_ACTION openTextEditor
static TOOL_ACTION closeProject
Handle actions in the kicad manager frame.
The main KiCad project manager frame.
std::shared_ptr< PLUGIN_CONTENT_MANAGER > m_pcm
void language_change(wxCommandEvent &event)
void SetPcmButton(BITMAP_BUTTON *aButton)
void doCloseWindow() override
void CreateNewProject(const wxFileName &aProjectFileName, bool aCreateStubFiles=true)
Creates a new project by setting up and initial project, schematic, and board files.
void OnUnarchiveFiles(wxCommandEvent &event)
wxString m_FileWatcherInfo
const SEARCH_STACK & sys_search() override
Return a SEARCH_STACK pertaining to entire program.
void OnImportEasyEdaProFiles(wxCommandEvent &event)
Open dialog to import EasyEDA Pro schematic and board files.
void ProjectChanged() override
Notification event that the project has changed.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
const wxString SchLegacyFileName()
void RecreateBaseLeftToolbar()
(Re)Create the left vertical toolbar
wxWindow * GetToolCanvas() const override
Canvas access.
void OnImportEasyEdaFiles(wxCommandEvent &event)
Open dialog to import EasyEDA Std schematic and board files.
PROJECT_TREE_PANE * m_leftWin
const wxString GetProjectFileName() const
void updatePcmButtonBadge()
void OnBrowseInFileExplorer(wxCommandEvent &event)
KICAD_SETTINGS * kicadSettings() const
const wxString SchFileName()
void OnImportEagleFiles(wxCommandEvent &event)
Open dialog to import Eagle schematic and board files.
wxStatusBar * OnCreateStatusBar(int number, long style, wxWindowID id, const wxString &name) override
Create the status line (like a wxStatusBar).
void OnExit(wxCommandEvent &event)
void LoadProject(const wxFileName &aProjectFileName)
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
void OnSize(wxSizeEvent &event) override
virtual void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void DoWithAcceptedFiles() override
Execute action on accepted dropped file.
void OnOpenFileInTextEditor(wxCommandEvent &event)
APP_SETTINGS_BASE * config() const override
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
int m_lastToolbarIconSize
const wxString PcbLegacyFileName()
KICAD_MANAGER_FRAME(wxWindow *parent, const wxString &title, const wxPoint &pos, const wxSize &size)
bool CloseProject(bool aSave)
Closes the project, and saves it if aSave is true;.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
void OnIdle(wxIdleEvent &event)
void onToolbarSizeChanged()
void PrintPrjInfo()
Prints the current working directory name and the project name on the text panel.
ACTION_TOOLBAR * m_mainToolBar
void OnArchiveFiles(wxCommandEvent &event)
void OnImportCadstarArchiveFiles(wxCommandEvent &event)
Open dialog to import CADSTAR Schematic and PCB Archive files.
void RefreshProjectTree()
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
BITMAP_BUTTON * m_pcmButton
PANEL_KICAD_LAUNCHER * m_launcher
wxString help_name() override
const wxString PcbFileName()
std::unique_ptr< UPDATE_MANAGER > m_updateManager
std::vector< wxString > m_OpenProjects
std::vector< std::pair< wxString, wxString > > m_PcmRepositories
KISTATUSBAR is a wxStatusBar suitable for Kicad manager.
void SetEllipsedTextField(const wxString &aText, int aFieldId)
Set the text in a field using wxELLIPSIZE_MIDDLE option to adjust the text size to the field size (un...
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.
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
void RegisterStatusBar(KISTATUSBAR *aStatusBar)
Add a status bar for handling.
void CreateOrUpdate(const wxString &aKey, const wxString &aTitle, const wxString &aDescription, const wxString &aHref=wxEmptyString)
Creates a notification with the given parameters or updates an existing one with the same key.
void Remove(const wxString &aKey)
Remove a notification by key.
void UnregisterStatusBar(KISTATUSBAR *aStatusBar)
Removes status bar from handling.
static REPORTER & GetInstance()
virtual COMMON_SETTINGS * GetCommonSettings() const
virtual BACKGROUND_JOBS_MONITOR & GetBackgroundJobMonitor() const
virtual NOTIFICATIONS_MANAGER & GetNotificationsManager() const
virtual SETTINGS_MANAGER & GetSettingsManager() const
wxString GetHelpFileName()
SEARCH_STACK & SysSearch()
APP_SETTINGS_BASE * PgmSettings()
PROJECT_TREE_PANE Window to display the tree files.
void EmptyTreePrj()
Delete all m_TreeProject entries.
void ReCreateTreePrj()
Create or modify the tree showing project file names.
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
virtual const wxString GetProjectPath() const
Return the full path of the project.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Look for files in a number of paths.
static bool ShowNever(const SELECTION &aSelection)
Always returns false.
bool SaveProject(const wxString &aFullPath=wxEmptyString, PROJECT *aProject=nullptr)
Saves a loaded project.
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
bool IsProjectOpen() const
Helper for checking if we have a project open TODO: This should be deprecated along with Prj() once w...
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
std::vector< wxString > GetOpenProjects() const
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
Base window classes and related definitions.
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define KICAD_MANAGER_FRAME_NAME
const wxString GERBVIEW_EXE
wxString FindKicadFile(const wxString &shortname)
Search the executable file shortname in KiCad binary path and return full file name if found or short...
static const std::string LegacySchematicFileExtension
static const std::string GerberJobFileExtension
static const std::string GerberFileExtension
static const std::string ProjectFileExtension
static const std::string LegacyPcbFileExtension
static const std::string LegacyProjectFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string DrillFileExtension
static const std::string KiCadPcbFileExtension
static wxString AllFilesWildcard()
static bool IsGerberFileExtension(const wxString &ext)
IDs used in KiCad main frame foe menuitems and tools.
@ ID_IMPORT_EAGLE_PROJECT
@ ID_IMPORT_EASYEDAPRO_PROJECT
@ ID_IMPORT_CADSTAR_ARCHIVE_PROJECT
@ ID_EDIT_LOCAL_FILE_IN_TEXT_EDITOR
@ ID_IMPORT_EASYEDA_PROJECT
@ ID_BROWSE_IN_FILE_EXPLORER
EVT_MENU_RANGE(ID_LANGUAGE_CHOICE, ID_LANGUAGE_CHOICE_END, KICAD_MANAGER_FRAME::language_change) KICAD_MANAGER_FRAME
bool LaunchExternal(const wxString &aPath)
Launches the given file or folder in the host OS.
KICOMMON_API wxFont GetStatusFont(wxWindow *aWindow)
#define SEXPR_BOARD_FILE_VERSION
Current s-expression file format version. 2 was the last legacy format version.
PGM_BASE & Pgm()
The global Program "get" accessor.
#define SEXPR_SCHEMATIC_FILE_VERSION
Schematic file version.
KIWAY Kiway(KFCTL_STANDALONE)
std::vector< FAB_LAYER_COLOR > dummy
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
Definition of file extensions used in Kicad.