43#include <wx/snglinst.h>
79#include <wx/stdpaths.h>
81#include <wx/filedlg.h>
82#include <wx/txtstrm.h>
83#include <wx/wfstream.h>
84#include <wx/zipstrm.h>
87#include "widgets/filedlg_hook_save_project.h"
90#define USE_INSTRUMENTATION 0
104 std::vector<IO_BASE::IO_FILE_DESC> descriptions;
117 wxCHECK( pi,
false );
124 descriptions.emplace_back( desc );
127 wxString fileFiltersStr;
128 std::vector<std::string> allExtensions;
129 std::set<wxString> allWildcardsSet;
133 if( !fileFiltersStr.IsEmpty() )
134 fileFiltersStr += wxChar(
'|' );
136 fileFiltersStr += desc.FileFilter();
138 for(
const std::string& ext : desc.m_FileExtensions )
140 allExtensions.emplace_back( ext );
145 wxString allWildcardsStr;
147 for(
const wxString& wildcard : allWildcardsSet )
148 allWildcardsStr << wildcard;
156 fileFiltersStr =
_(
"All supported formats" ) + wxT(
"|" ) + allWildcardsStr + wxT(
"|" )
160 wxFileName fileName( *aFileName );
164 if( fileName.FileExists() )
166 path = fileName.GetPath();
167 name = fileName.GetFullName();
180 wxFileDialog dlg( aParent,
181 kicadFormat ?
_(
"Open Board File" ) :
_(
"Import Non KiCad Board File" ),
182 path,
name, fileFiltersStr, wxFD_OPEN | wxFD_FILE_MUST_EXIST );
187 dlg.SetCustomizeHook( importOptions );
189 if( dlg.ShowModal() == wxID_OK )
191 *aFileName = dlg.GetPath();
192 aParent->
SetMruPath( wxFileName( dlg.GetPath() ).GetPath() );
218 wxFileName fn = *aFileName;
222 wxFileDialog dlg( aParent,
_(
"Save Board File As" ), fn.GetPath(), fn.GetFullName(), wildcard,
223 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
229 dlg.SetCustomizeHook( newProjectHook );
231 if( dlg.ShowModal() != wxID_OK )
234 *aFileName = dlg.GetPath();
240 *aCreateProject =
true;
252 if( !wxFileName::IsFileReadable( fn ) )
271 int id =
event.GetId();
285 if( !
Kiface().IsSingle() )
308 wxFileName fn = currfn;
311 fn.SetName( rec_name );
313 if( !fn.FileExists() )
315 msg.Printf(
_(
"Recovery file '%s' not found." ), fn.GetFullPath() );
320 msg.Printf(
_(
"OK to load recovery file '%s'?" ), fn.GetFullPath() );
322 if( !
IsOK(
this, msg ) )
342 msg.Printf(
_(
"Revert '%s' to last version saved?" ), fn.GetFullPath() );
344 if( !
IsOK(
this, msg ) )
357 if( !
Kiface().IsSingle() )
363 wxString saveMsg =
_(
"Current board will be closed, save changes to '%s' before "
369 return Files_io_from_id( ID_SAVE_BOARD );
377 if( !
IsOK(
this,
_(
"Current Board will be closed. Continue?" ) ) )
401 if( !
GetBoard()->GetFileName().IsEmpty() )
420 wxFileName::SplitPath(
GetBoard()->GetFileName(),
nullptr,
nullptr, &orig_name,
nullptr );
422 if( orig_name.IsEmpty() )
425 wxFileName savePath(
Prj().GetProjectFullName() );
427 if( !savePath.IsOk() || !savePath.IsDirWritable() )
431 if( !savePath.IsOk() || !savePath.IsDirWritable() )
436 wxString filename = fn.GetFullPath();
437 bool createProject =
false;
438 bool success =
false;
448 success =
SavePcbFile( filename, addToHistory, createProject );
474 for(
int i = 0; i < collector.
GetCount(); i++ )
478 int itemWidth =
static_cast<PCB_SHAPE*
>( collector[i] )->GetWidth();
480 if( edgeWidth != -1 && edgeWidth != itemWidth )
483 edgeWidth = std::max( edgeWidth, itemWidth );
487 edgeWidth = itemWidth;
492 if( mixed && aShowUserMsg )
496 _(
"If the zones on this board are refilled the Copper Edge "
497 "Clearance setting will be used (see Board Setup > Design "
498 "Rules > Constraints).\n This may result in different fills "
499 "from previous KiCad versions which used the line thicknesses "
500 "of the board boundary on the Edge Cuts layer." ) );
503 return std::max( 0, edgeWidth / 2 );
510 if( aFileSet.size() != 1 )
512 UTF8 msg =
StrPrintf(
"Pcbnew:%s() takes a single filename", __func__ );
517 wxString fullFileName( aFileSet[0] );
518 wxFileName wx_filename( fullFileName );
525 wxASSERT_MSG( wx_filename.IsAbsolute(), wxT(
"Path is not absolute!" ) );
527 std::unique_ptr<LOCKFILE> lock = std::make_unique<LOCKFILE>( fullFileName );
529 if( !lock->Valid() && lock->IsLockedByMe() )
535 if( !
Pgm().SingleInstance()->IsAnotherRunning() )
536 lock->OverrideLock();
541 msg.Printf(
_(
"PCB '%s' is already open by '%s' at '%s'." ),
542 wx_filename.GetFullName(),
544 lock->GetHostname() );
549 lock->OverrideLock();
564 wxFileName pro = fullFileName;
567 bool is_new = !wxFileName::IsFileReadable( fullFileName );
573 msg.Printf(
_(
"PCB '%s' does not exist. Do you wish to create it?" ), fullFileName );
575 if( !
IsOK(
this, msg ) )
583 :
_(
"Loading PCB" ), 1 );
595 progressReporter.Hide();
615 wxString
path = wxPathOnly(
Prj().GetProjectFullName() );
648 BOARD* loadedBoard =
nullptr;
654 this, std::placeholders::_1 ) );
661 std::placeholders::_1 ) );
675 bool failedLoad =
false;
685 std::map<std::string, UTF8> props;
694 pi->SetQueryUserCallback(
695 [&]( wxString aTitle,
int aIcon, wxString aMessage, wxString aAction ) ->
bool
697 KIDIALOG dlg(
nullptr, aMessage, aTitle, wxOK | wxCANCEL | aIcon );
699 if( !aAction.IsEmpty() )
700 dlg.SetOKLabel( aAction );
707#if USE_INSTRUMENTATION
711 if(
config()->m_System.show_import_issues )
716 pi->SetProgressReporter( &progressReporter );
717 loadedBoard = pi->LoadBoard( fullFileName,
nullptr, &props, &
Prj() );
719#if USE_INSTRUMENTATION
721 printf(
"PCB_IO::Load(): %u usecs\n", stopTime - startTime );
726 msg.Printf(
_(
"Error loading PCB '%s'." ), fullFileName );
727 progressReporter.Hide();
734 if( ioe.
Problem() != wxT(
"CANCEL" ) )
736 msg.Printf(
_(
"Error loading PCB '%s'." ), fullFileName );
737 progressReporter.Hide();
743 catch(
const std::bad_alloc& )
745 msg.Printf(
_(
"Memory exhausted loading PCB '%s'" ), fullFileName );
746 progressReporter.Hide();
752 if( failedLoad || !loadedBoard )
772 SetBoard( loadedBoard,
false, &progressReporter );
823 && loadedBoard->
GetGenerator().Lower() != wxT(
"gerbview" ) ) )
828 "It will be converted to the new format when saved." ),
838 wxFileName loadedBoardFn( fullFileName );
839 wxString libNickName = loadedBoardFn.GetName();
844 std::vector<FOOTPRINT*> loadedFootprints = pi->GetImportedCachedLibraryFootprints();
850 if( newLibPath.Length() > 0 )
854 for(
FOOTPRINT* footprint : loadedFootprints )
858 if( !footprint->GetFPID().GetLibItemName().empty() )
860 footprint->SetReference(
"REF**" );
861 piSexpr->FootprintSave( newLibPath, footprint );
867 wxLogError(
_(
"Error saving footprint %s to project specific library." )
869 footprint->GetFPID().GetUniStringLibItemName(),
876 wxString rel_path, env_path;
878 wxASSERT_MSG( wxGetEnv( project_env, &env_path ),
879 wxT(
"There is no project variable?" ) );
881 wxString result( newLibPath );
883 if( result.Replace( env_path, wxT(
"$(" ) + project_env + wxT(
")" ) ) )
887 wxT(
"KiCad" ), wxEmptyString );
898 wxLogError(
_(
"Error saving project specific footprint library table." )
906 LIB_ID libId = footprint->GetFPID();
912 footprint->SetFPID( libId );
921 fn.SetPath(
Prj().GetProjectPath() );
922 fn.SetName(
Prj().GetProjectName() );
925 wxString fname = fn.GetFullPath();
938 std::vector<ZONE*> toFill;
955#if 0 && defined(DEBUG)
979 bool aChangeProject )
982 wxFileName pcbFileName = aFileName;
992 wxString msg = wxString::Format(
_(
"Insufficient permissions to write file '%s'." ),
993 pcbFileName.GetFullPath() );
1000 wxFileName projectFile( pcbFileName );
1001 wxFileName rulesFile( pcbFileName );
1007 if( projectFile.FileExists() )
1011 else if( aChangeProject )
1019 if( currentRules.FileExists() && !rulesFile.FileExists() && aChangeProject )
1020 KiCopyFile( currentRules.GetFullPath(), rulesFile.GetFullPath(), msg );
1022 if( !msg.IsEmpty() )
1024 DisplayError(
this, wxString::Format(
_(
"Error saving custom rules file '%s'." ),
1025 rulesFile.GetFullPath() ) );
1028 if( projectFile.FileExists() )
1038 wxString tempFile = wxFileName::CreateTempFileName( wxS(
"pcbnew" ) );
1046 pi->SaveBoard( tempFile,
GetBoard(),
nullptr );
1050 DisplayError(
this, wxString::Format(
_(
"Error saving board file '%s'.\n%s" ),
1051 pcbFileName.GetFullPath(),
1054 lowerTxt.Printf(
_(
"Failed to create temporary file '%s'." ), tempFile );
1059 wxRemoveFile( tempFile );
1068 if( !wxRenameFile( tempFile, pcbFileName.GetFullPath() ) )
1070 DisplayError(
this, wxString::Format(
_(
"Error saving board file '%s'.\n"
1071 "Failed to rename temporary file '%s." ),
1072 pcbFileName.GetFullPath(),
1075 lowerTxt.Printf(
_(
"Failed to rename temporary file '%s'." ),
1083 if( !
Kiface().IsSingle() )
1094 LockFile( pcbFileName.GetFullPath() );
1101 wxFileName autoSaveFileName = pcbFileName;
1105 if( autoSaveFileName.FileExists() )
1106 wxRemoveFile( autoSaveFileName.GetFullPath() );
1108 lowerTxt.Printf(
_(
"File '%s' saved." ), pcbFileName.GetFullPath() );
1110 SetStatusText( lowerTxt, 0 );
1131 DisplayError(
this, wxString::Format(
_(
"Insufficient permissions to write file '%s'." ),
1132 pcbFileName.GetFullPath() ) );
1146 wxASSERT( pcbFileName.IsAbsolute() );
1148 pi->SaveBoard( pcbFileName.GetFullPath(),
GetBoard(),
nullptr );
1152 DisplayError(
this, wxString::Format(
_(
"Error saving board file '%s'.\n%s" ),
1153 pcbFileName.GetFullPath(),
1159 wxFileName projectFile( pcbFileName );
1160 wxFileName rulesFile( pcbFileName );
1166 if( aCreateProject && !projectFile.FileExists() )
1171 if( aCreateProject && currentRules.FileExists() && !rulesFile.FileExists() )
1172 KiCopyFile( currentRules.GetFullPath(), rulesFile.GetFullPath(), msg );
1174 if( !msg.IsEmpty() )
1176 DisplayError(
this, wxString::Format(
_(
"Error saving custom rules file '%s'." ),
1177 rulesFile.GetFullPath() ) );
1181 pcbFileName.GetFullPath() ) );
1189 wxFileName tmpFileName;
1195 wxString title = GetTitle();
1197 if(
GetBoard()->GetFileName().IsEmpty() )
1208 wxFileName autoSaveFileName = tmpFileName;
1213 if( !autoSaveFileName.IsOk() )
1218 if( !autoSaveFileName.IsDirWritable() )
1220 autoSaveFileName.SetPath( wxFileName::GetTempDir() );
1222 if( !autoSaveFileName.IsOk() || !autoSaveFileName.IsDirWritable() )
1227 wxT(
"Creating auto save file <" ) + autoSaveFileName.GetFullPath() + wxT(
">" ) );
1229 if(
SavePcbFile( autoSaveFileName.GetFullPath(),
false,
false ) )
1237 if( !
Kiface().IsSingle() &&
1257 const std::map<std::string, UTF8>* aProperties )
1291 if( pcbFileName.GetName().empty() )
1293 DisplayError(
this,
_(
"The board must be saved before generating IPC2581 file." ) );
1299 wxString msg = wxString::Format(
_(
"Insufficient permissions to write file '%s'." ),
1300 pcbFileName.GetFullPath() );
1306 wxString tempFile = wxFileName::CreateTempFileName( wxS(
"pcbnew_ipc" ) );
1310 std::map<std::string, UTF8> props;
1315 props[
"OEMRef"] = dlg.
GetOEM();
1316 props[
"mpn"] = dlg.
GetMPN();
1317 props[
"mfg"] = dlg.
GetMfg();
1318 props[
"dist"] = dlg.
GetDist();
1327 pi->SetProgressReporter( &reporter );
1328 pi->SaveBoard( tempFile,
GetBoard(), &props );
1333 DisplayError(
this, wxString::Format(
_(
"Error generating IPC2581 file '%s'.\n%s" ),
1334 pcbFileName.GetFullPath(), ioe.
What() ) );
1336 lowerTxt.Printf(
_(
"Failed to create temporary file '%s'." ), tempFile );
1341 wxRemoveFile( tempFile );
1348 auto ret =
tp.submit( saveFile );
1351 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
1353 while( status != std::future_status::ready )
1356 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
1364 catch(
const std::exception& e )
1366 wxLogError(
"Exception in IPC2581 generation: %s", e.what() );
1376 wxFileName tempfn = pcbFileName;
1378 wxFileName zipfn = tempFile;
1379 zipfn.SetExt(
"zip" );
1381 wxFFileOutputStream fnout( zipfn.GetFullPath() );
1382 wxZipOutputStream
zip( fnout );
1383 wxFFileInputStream fnin( tempFile );
1385 zip.PutNextEntry( tempfn.GetFullName() );
1390 wxRemoveFile( tempFile );
1391 tempFile = zipfn.GetFullPath();
1395 if( !wxRenameFile( tempFile, pcbFileName.GetFullPath() ) )
1397 DisplayError(
this, wxString::Format(
_(
"Error generating IPC2581 file '%s'.\n"
1398 "Failed to rename temporary file '%s." ),
1399 pcbFileName.GetFullPath(),
1402 lowerTxt.Printf(
_(
"Failed to rename temporary file '%s'." ),
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
void SetContentModified(bool aModified=true)
int m_CopperEdgeClearance
Information pertinent to a Pcbnew printed circuit board.
bool m_LegacyDesignSettingsLoaded
True if the legacy board design settings were loaded from a file.
GAL_SET m_LegacyVisibleItems
void SetFileName(const wxString &aFileName)
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
LSET m_LegacyVisibleLayers
Visibility settings stored in board prior to 6.0, only used for loading legacy files.
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
const wxString & GetFileName() const
int GetFileFormatVersionAtLoad() const
const wxString & GetGenerator() const
Adds an item to the container.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
bool m_LegacyCopperEdgeClearanceLoaded
int GetCount() const
Return the number of objects in the list.
wxString GetPrecision() const
wxString GetDistPN() const
wxString GetUnitsString() const
wxString GetOutputPath() const
static void GenerateODBPPFiles(const JOB_EXPORT_PCB_ODB &aJob, BOARD *aBoard, PCB_EDIT_FRAME *aParentFrame=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr, REPORTER *aErrorReporter=nullptr)
wxString GetOutputPath() const
wxString GetUnitsString() const
Class DIALOG_HTML_REPORTER.
WX_HTML_REPORT_BOX * m_Reporter
static std::vector< IMPORT_PROJECT_DESC > RunModal(wxWindow *aParent, const std::vector< IMPORT_PROJECT_DESC > &aProjectDesc)
Create and show a dialog (modal) and returns the data from it after completion.
static std::map< wxString, PCB_LAYER_ID > RunModal(wxWindow *aParent, const std::vector< INPUT_LAYER_DESC > &aLayerDesc)
Create and show a dialog (modal) and returns the data from it after completion.
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
void NewDisplay(bool aForceImmediateRedraw=false)
Reload and refresh (rebuild) the 3D scene.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
virtual void CheckForAutoSaveFile(const wxFileName &aFileName)
Check if an auto save file exists for aFileName and takes the appropriate action depending on the use...
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
void ClearFileHistory(FILE_HISTORY *aFileHistory=nullptr)
Removes all files from the file history.
wxString GetMruPath() const
virtual void DeleteAutoSaveFile(const wxFileName &aFileName)
bool IsWritable(const wxFileName &aFileName, bool aVerbose=true)
Checks if aFileName can be written.
wxString GetFileFromHistory(int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
Fetches the file name from the file history list.
void SetMruPath(const wxString &aPath)
WX_INFOBAR * GetInfoBar()
void ReleaseFile()
Release the current file marked in use.
std::unique_ptr< LOCKFILE > m_file_checker
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.
bool GetCreateNewProject() const
Gets if this hook has attached controls to a dialog box.
bool IsAttachedToDialog() const
bool GetShowIssues() const
Hold a record identifying a library accessed by the appropriate footprint library #PLUGIN object in t...
static const std::vector< KICAD_T > AllBoardItems
A scan list for all editable board items.
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 const wxString Problem() const
what was the problem?
ODB_COMPRESSION m_compressionMode
void SetOutputPath(const wxString &aPath)
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.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Plugin class for import plugins that support remappable layers.
A logical library item identifier and consists of various portions much like a URI.
int SetLibNickname(const UTF8 &aLibNickname)
Override the logical library name portion of the LIB_ID to aLibNickname.
const UTF8 & GetLibItemName() const
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
static REPORTER & GetInstance()
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
static TOOL_ACTION repairBoard
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
wxString CreateNewProjectLibrary(const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
const VECTOR2I GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
The main frame for Pcbnew.
void LoadDrawingSheet()
Load the drawing sheet file.
void ResolveDRCExclusions(bool aCreateMarkers)
If aCreateMarkers then create DRC exclusion markers from the serialized data.
void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void GenIPC2581File(wxCommandEvent &event)
Create and IPC2581 output file.
bool doAutoSave() override
Perform auto save when the board has been modified and not saved within the auto save interval.
void OnModify() override
Must be called after a board change to set the modified flag.
void OnClearFileHistory(wxCommandEvent &aEvent)
bool SavePcbCopy(const wxString &aFileName, bool aCreateProject=false)
Write the board data structures to aFileName.
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl=0) override
Load a KiCad board (.kicad_pcb) from aFileName.
void onBoardLoaded()
Update the state of the GUI after a new board is loaded or created.
void SaveProjectLocalSettings() override
Save changes to the project local settings.
bool Files_io_from_id(int aId)
Read and write board files according to aId.
void GenODBPPFiles(wxCommandEvent &event)
Create and Generate ODB++ output files.
bool IsContentModified() const override
Get if the current board has been modified but not saved.
bool LoadProjectSettings()
Load the current project's file configuration settings which are pertinent to this PCB_EDIT_FRAME ins...
bool Clear_Pcb(bool doAskAboutUnsavedChanges, bool aFinal=false)
Delete all and reinitialize the current board.
void Files_io(wxCommandEvent &event)
Call Files_io_from_id with the wxCommandEvent id.
void UpdateTitle()
Set the main window title bar text.
int inferLegacyEdgeClearance(BOARD *aBoard, bool aShowUserMsg=true)
const std::map< std::string, UTF8 > * m_importProperties
bool SavePcbFile(const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
Write the board data structures to a aFileName.
bool importFile(const wxString &aFileName, int aFileType, const std::map< std::string, UTF8 > *aProperties=nullptr)
Load the given filename but sets the path to the current project path.
void saveProjectSettings() override
Saves any design-related project settings associated with this frame.
void OnFileHistory(wxCommandEvent &event)
static PLUGIN_REGISTRY * Instance()
static PCB_IO * PluginFind(PCB_FILE_T aFileType)
Return a #PLUGIN which the caller can use to import, export, save, or load design documents.
PCB_FILE_T
The set of file types that the PCB_IO_MGR knows about, and for which there has been a plugin written,...
@ KICAD_SEXP
S-expression Pcbnew file format.
@ LEGACY
Legacy Pcbnew file formats prior to s-expression.
static PCB_FILE_T FindPluginTypeFromBoardPath(const wxString &aFileName, int aCtl=0)
Return a plugin type given a path for a board file.
Collect all BOARD_ITEM objects on a given layer.
void Collect(BOARD_ITEM *aBoard, const std::vector< KICAD_T > &aTypes)
Test a BOARD_ITEM using this class's Inspector method, which does the collection.
void SetLayerId(PCB_LAYER_ID aLayerId)
bool KeepRefreshing(bool aWait=false) override
Update the UI dialog.
Plugin class for import plugins that support choosing a project.
LSET m_VisibleLayers
Board settings.
GAL_SET m_VisibleItems
The GAL layers (aka items) that are turned on for viewing (.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
virtual void SetReadOnly(bool aReadOnly=true)
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
virtual const wxString FootprintLibTblName() const
Returns the path and filename of this project's footprint library table.
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
void SaveProjectAs(const wxString &aFullPath, PROJECT *aProject=nullptr)
Sets the currently loaded project path and saves it (pointers remain valid) Note that this will not m...
void SaveProjectCopy(const wxString &aFullPath, PROJECT *aProject=nullptr)
Saves a copy of the current project under the given path.
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 UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
static void ResolvePossibleSymlinks(wxFileName &aFilename)
void Flush()
Build the HTML messages page.
bool HasMessage() const override
Returns true if the reporter client is non-empty.
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
bool HasCloseButton() const
@ OUTDATED_SAVE
OUTDATED_SAVE Messages that should be cleared on save.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
MESSAGE_TYPE GetMessageType() const
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
A wrapper for reporting to a wxString object.
bool HasMessage() const override
Returns true if the reporter client is non-empty.
const wxString & GetMessages() const
wxString EnsureFileExtension(const wxString &aFilename, const wxString &aExtension)
It's annoying to throw up nag dialogs when the extension isn't right.
bool AskOverrideLock(wxWindow *aParent, const wxString &aMessage)
Display a dialog indicating the file is already open, with an option to reset the lock.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
Declaration of the eda_3d_viewer class.
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
#define WIN_STRING_DIR_SEP
#define UNIX_STRING_DIR_SEP
static const std::string ProjectFileExtension
static const std::string LegacyPcbFileExtension
static const std::string Ipc2581FileExtension
static const std::string AutoSaveFilePrefix
static const std::string DesignRulesFileExtension
static const std::string KiCadPcbFileExtension
static wxString PcbFileWildcard()
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
#define THROW_IO_ERROR(msg)
This file is part of the common library.
#define KICTL_CREATE
caller thinks requested project files may not exist.
#define KICTL_REVERT
reverting to a previously-saved (KiCad) file.
#define KICTL_IMPORT_LIB
import all footprints into a project library.
#define KICTL_KICAD_ONLY
chosen file is from KiCad according to user
#define KICTL_NONKICAD_ONLY
chosen file is non-KiCad according to user
@ GAL_LAYER_ID_BITMASK_END
This is the end of the layers used for visibility bit masks in legacy board files.
#define GAL_LAYER_INDEX(x)
Use this macro to convert a GAL layer to a 0-indexed offset from LAYER_VIAS.
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
#define SEXPR_BOARD_FILE_VERSION
Current s-expression file format version. 2 was the last legacy format version.
bool AskLoadBoardFileName(PCB_EDIT_FRAME *aParent, wxString *aFileName, int aCtl=0)
Show a wxFileDialog asking for a BOARD filename to open.
bool AskSaveBoardFileName(PCB_EDIT_FRAME *aParent, wxString *aFileName, bool *aCreateProject)
Put up a wxFileDialog asking for a BOARD filename to save.
@ ID_IMPORT_NON_KICAD_BOARD
@ ID_MENU_RECOVER_BOARD_AUTOSAVE
SETTINGS_MANAGER * GetSettingsManager()
PGM_BASE & Pgm()
The global Program "get" accessor.
int64_t GetRunningMicroSecs()
An alternate way to calculate an elapsed time (in microsecondes) to class PROF_COUNTER.
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
#define NAMELESS_PROJECT
default name for nameless projects
int StrPrintf(std::string *result, const char *format,...)
This is like sprintf() but the output is appended to a std::string instead of to a character array.
bool show_import_issues
Stored value for "show import issues" when importing non-KiCad designs to this application.
Container that describes file type info.
std::vector< std::string > m_FileExtensions
Filter used for file pickers if m_IsFile is true.
bool m_CanRead
Whether the IO can read this file type.
BS::thread_pool thread_pool
thread_pool & GetKiCadThreadPool()
Get a reference to the current thread pool.
wxLogTrace helper definitions.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
wxString AddFileExtListToFilter(const std::vector< std::string > &aExts)
Build the wildcard extension file dialog wildcard filter to add to the base message dialog.
wxString formatWildcardExt(const wxString &aWildcard)
Format wildcard extension to support case sensitive file dialogs.
Definition of file extensions used in Kicad.