KiCad PCB EDA Suite
pcbnew/files.cpp File Reference

Read and write board files. More...

#include <fctsys.h>
#include <class_drawpanel.h>
#include <confirm.h>
#include <kicad_string.h>
#include <gestfich.h>
#include <pcb_edit_frame.h>
#include <macros.h>
#include <3d_viewer/eda_3d_viewer.h>
#include <richio.h>
#include <filter_reader.h>
#include <pgm_base.h>
#include <msgpanel.h>
#include <fp_lib_table.h>
#include <ratsnest_data.h>
#include <kiway.h>
#include <kiway_player.h>
#include <trace_helpers.h>
#include <lockfile.cpp>
#include <pcbnew.h>
#include <pcbnew_id.h>
#include <io_mgr.h>
#include <wildcards_and_files_ext.h>
#include <class_board.h>
#include <build_version.h>
#include <wx/stdpaths.h>

Go to the source code of this file.

Macros

#define USE_INSTRUMENTATION   0
 

Functions

bool AskLoadBoardFileName (wxWindow *aParent, int *aCtl, wxString *aFileName, bool aKicadFilesOnly)
 Function AskLoadBoardFileName puts up a wxFileDialog asking for a BOARD filename to open. More...
 
bool AskSaveBoardFileName (wxWindow *aParent, wxString *aFileName)
 Function AskSaveBoardFileName puts up a wxFileDialog asking for a BOARD filename to save. More...
 
IO_MGR::PCB_FILE_T plugin_type (const wxString &aFileName, int aCtl)
 
static wxString create_backup_file (const wxString &aFileName)
 

Variables

static const wxChar backupSuffix [] = wxT( "-bak" )
 
static const wxChar autosavePrefix [] = wxT( "_autosave-" )
 

Detailed Description

Read and write board files.

Definition in file pcbnew/files.cpp.

Macro Definition Documentation

#define USE_INSTRUMENTATION   0

Definition at line 62 of file pcbnew/files.cpp.

Function Documentation

bool AskLoadBoardFileName ( wxWindow *  aParent,
int *  aCtl,
wxString *  aFileName,
bool  aKicadFilesOnly 
)

Function AskLoadBoardFileName puts up a wxFileDialog asking for a BOARD filename to open.

Parameters
aParentis a wxFrame passed to wxFileDialog.
aCtlis where to put the OpenProjectFiles() control bits.
aFileNameon entry is a probable choice, on return is the chosen filename.
aKicadFilesOnlytrue to list kiacad pcb files plugins only, false to list import plugins.
Returns
bool - true if chosen, else false if user aborted.

Definition at line 87 of file pcbnew/files.cpp.

References DIM, IO_MGR::EAGLE, EaglePcbFileWildcard(), fileFilters, IO_MGR::KICAD_SEXP, KICTL_EAGLE_BRD, IO_MGR::LEGACY, LegacyPcbFileWildcard(), name, IO_MGR::PCAD, PCadPcbFileWildcard(), and PcbFileWildcard().

Referenced by PCBNEW_CONTROL::AppendBoardFromFile(), PCB_EDIT_FRAME::Files_io_from_id(), and PCB_EDIT_FRAME::OnFileHistory().

88 {
89  // This is a subset of all PLUGINs which are trusted to be able to
90  // load a BOARD. User may occasionally use the wrong plugin to load a
91  // *.brd file (since both legacy and eagle use *.brd extension),
92  // but eventually *.kicad_pcb will be more common than legacy *.brd files.
93  static const struct
94  {
95  const wxString& filter;
96  IO_MGR::PCB_FILE_T pluginType;
97  } loaders[] =
98  {
99  { PcbFileWildcard(), IO_MGR::KICAD_SEXP }, // Current Kicad board files
100  { LegacyPcbFileWildcard(), IO_MGR::LEGACY }, // Old Kicad board files
101  { EaglePcbFileWildcard(), IO_MGR::EAGLE }, // Import board files
102  { PCadPcbFileWildcard(), IO_MGR::PCAD }, // Import board files
103  };
104 
105  wxFileName fileName( *aFileName );
106  wxString fileFilters;
107 
108  if( aKicadFilesOnly )
109  {
110  for( unsigned ii = 0; ii < 2; ++ii )
111  {
112  if( !fileFilters.IsEmpty() )
113  fileFilters += wxChar( '|' );
114 
115  fileFilters += wxGetTranslation( loaders[ii].filter );
116  }
117  }
118  else
119  {
120  for( unsigned ii = 2; ii < DIM( loaders ); ++ii )
121  {
122  if( !fileFilters.IsEmpty() )
123  fileFilters += wxChar( '|' );
124 
125  fileFilters += wxGetTranslation( loaders[ii].filter );
126  }
127  }
128 
129  wxString path;
130  wxString name;
131 
132  if( fileName.FileExists() )
133  {
134  path = fileName.GetPath();
135  name = fileName.GetFullName();
136  }
137  else
138  {
139  path = wxStandardPaths::Get().GetDocumentsDir();
140  // leave name empty
141  }
142 
143  wxFileDialog dlg( aParent,
144  aKicadFilesOnly ? _( "Open Board File" ) : _( "Import Non KiCad Board File" ),
145  path, name, fileFilters,
146  wxFD_OPEN | wxFD_FILE_MUST_EXIST );
147 
148  if( dlg.ShowModal() == wxID_OK )
149  {
150  // For import option, if Eagle (*.brd files), tell OpenProjectFiles() to use Eagle plugin.
151  // It's the only special case because of the duplicate use of the *.brd file extension.
152  // Other cases are clear because of unique file extensions.
153  *aCtl = aKicadFilesOnly ? 0 : KICTL_EAGLE_BRD;
154  *aFileName = dlg.GetPath();
155  return true;
156  }
157  else
158  return false;
159 }
#define DIM(x)
of elements in an array
Definition: macros.h:98
wxString EaglePcbFileWildcard()
#define KICTL_EAGLE_BRD
chosen *.brd file is Eagle according to user.
Definition: kiway_player.h:139
wxString LegacyPcbFileWildcard()
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:54
const char * name
Definition: DXF_plotter.cpp:61
wxString PcbFileWildcard()
static const struct @9 fileFilters[FILTER_COUNT]
PCB_FILE_T
Enum PCB_FILE_T is a set of file types that the IO_MGR knows about, and for which there has been a pl...
Definition: io_mgr.h:52
wxString PCadPcbFileWildcard()
S-expression Pcbnew file format.
Definition: io_mgr.h:55
bool AskSaveBoardFileName ( wxWindow *  aParent,
wxString *  aFileName 
)

Function AskSaveBoardFileName puts up a wxFileDialog asking for a BOARD filename to save.

Parameters
aParentis a wxFrame passed to wxFileDialog.
aFileNameon entry is a probable choice, on return is the chosen full filename (includes path).
Returns
bool - true if chosen, else false if user aborted.

Definition at line 172 of file pcbnew/files.cpp.

References KiCadPcbFileExtension, and PcbFileWildcard().

Referenced by PCB_EDIT_FRAME::Files_io_from_id().

173 {
174  wxString wildcard = PcbFileWildcard();
175  wxFileName fn = *aFileName;
176 
177  fn.SetExt( KiCadPcbFileExtension );
178 
179  wxFileDialog dlg( aParent,
180  _( "Save Board File As" ),
181  fn.GetPath(),
182  fn.GetFullName(),
183  wildcard,
184  wxFD_SAVE | wxFD_OVERWRITE_PROMPT
185  );
186 
187  if( dlg.ShowModal() != wxID_OK )
188  return false;
189 
190  fn = dlg.GetPath();
191 
192  // always enforce filename extension, user may not have entered it.
193  fn.SetExt( KiCadPcbFileExtension );
194 
195  *aFileName = fn.GetFullPath();
196 
197  return true;
198 }
const std::string KiCadPcbFileExtension
wxString PcbFileWildcard()
static wxString create_backup_file ( const wxString &  aFileName)
static

Definition at line 615 of file pcbnew/files.cpp.

References backupSuffix, DisplayError(), Format(), and GetChars().

Referenced by PCB_EDIT_FRAME::SavePcbFile().

616 {
617  wxFileName fn = aFileName;
618  wxFileName backupFileName = aFileName;
619 
620  backupFileName.SetExt( fn.GetExt() + backupSuffix );
621 
622  // If an old backup file exists, delete it. If an old board file exists,
623  // rename it to the backup file name.
624  if( fn.FileExists() )
625  {
626  // Remove the old file xxx.000 if it exists.
627  if( backupFileName.FileExists() )
628  wxRemoveFile( backupFileName.GetFullPath() );
629 
630  // Rename the current file from <xxx>.kicad_pcb to <xxx>.kicad_pcb-bak
631  if( !wxRenameFile( fn.GetFullPath(), backupFileName.GetFullPath() ) )
632  {
633  wxString msg = wxString::Format( _(
634  "Warning: unable to create backup file \"%s\"" ),
635  GetChars( backupFileName.GetFullPath() )
636  );
637  DisplayError( NULL, msg );
638  }
639  }
640  else
641  {
642  backupFileName.Clear();
643  }
644 
645  return backupFileName.GetFullPath();
646 }
static const wxChar backupSuffix[]
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:245
IO_MGR::PCB_FILE_T plugin_type ( const wxString &  aFileName,
int  aCtl 
)

Definition at line 369 of file pcbnew/files.cpp.

References backupSuffix, IO_MGR::EAGLE, IO_MGR::GetFileExtension(), IO_MGR::KICAD_SEXP, KICTL_EAGLE_BRD, IO_MGR::LEGACY, and IO_MGR::PCAD.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), PCBNEW_CONTROL::AppendBoardFromFile(), and PCB_EDIT_FRAME::OpenProjectFiles().

370 {
371  IO_MGR::PCB_FILE_T pluginType;
372 
373  wxFileName fn = aFileName;
374 
375  // Note: file extensions are expected to be in ower case.
376  // This is not always true, especially when importing files, so the string
377  // comparisons are case insensitive to try to find the suitable plugin.
378 
379  if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::LEGACY ) ) == 0 )
380  {
381  // both legacy and eagle share a common file extension.
382  pluginType = ( aCtl & KICTL_EAGLE_BRD ) ? IO_MGR::EAGLE : IO_MGR::LEGACY;
383  }
384  else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::LEGACY ) + backupSuffix ) == 0 )
385  {
386  pluginType = IO_MGR::LEGACY;
387  }
388  else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::PCAD ) ) == 0 )
389  {
390  pluginType = IO_MGR::PCAD;
391  }
392  else
393  {
394  pluginType = IO_MGR::KICAD_SEXP;
395  }
396 
397  return pluginType;
398 }
#define KICTL_EAGLE_BRD
chosen *.brd file is Eagle according to user.
Definition: kiway_player.h:139
static const wxChar backupSuffix[]
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:54
PCB_FILE_T
Enum PCB_FILE_T is a set of file types that the IO_MGR knows about, and for which there has been a pl...
Definition: io_mgr.h:52
S-expression Pcbnew file format.
Definition: io_mgr.h:55
static const wxString GetFileExtension(PCB_FILE_T aFileType)
Function GetFileExtension returns the file extension for aFileType.
Definition: io_mgr.cpp:109

Variable Documentation

const wxChar autosavePrefix[] = wxT( "_autosave-" )
static
const wxChar backupSuffix[] = wxT( "-bak" )
static