KiCad PCB EDA Suite
footprint_libraries_utils.cpp File Reference
#include <wx/ffile.h>
#include <wx/stdpaths.h>
#include <fctsys.h>
#include <pgm_base.h>
#include <kiface_i.h>
#include <class_drawpanel.h>
#include <confirm.h>
#include <kicad_string.h>
#include <gestfich.h>
#include <pcb_edit_frame.h>
#include <dialog_helpers.h>
#include <filter_reader.h>
#include <macros.h>
#include <fp_lib_table.h>
#include <validators.h>
#include <dialog_text_entry.h>
#include <tool/tool_manager.h>
#include <tools/pcb_actions.h>
#include <class_board.h>
#include <class_module.h>
#include <board_commit.h>
#include <pcbnew.h>
#include <footprint_edit_frame.h>
#include <wildcards_and_files_ext.h>
#include <kicad_plugin.h>
#include <legacy_plugin.h>
#include <env_paths.h>
#include "footprint_viewer_frame.h"

Go to the source code of this file.

Macros

#define FMT_OK_DELETE   _( "OK to delete footprint \"%s\" in library \"%s\"" )
 
#define FMT_IMPORT_MODULE   _( "Import Footprint" )
 
#define FMT_FILE_NOT_FOUND   _( "File \"%s\" not found" )
 
#define FMT_NOT_MODULE   _( "Not a footprint file" )
 
#define FMT_MOD_NOT_FOUND   _( "Unable to find or load footprint \"%s\" from lib path \"%s\"" )
 
#define FMT_LIB_READ_ONLY   _( "Library \"%s\" is read only, not writable" )
 
#define FMT_EXPORT_MODULE   _( "Export Footprint" )
 
#define FMT_SAVE_MODULE   _( "Save Footprint" )
 
#define FMT_MOD_REF   _( "Enter footprint name:" )
 
#define FMT_EXPORTED   _( "Footprint exported to file \"%s\"" )
 
#define FMT_MOD_DELETED   _( "Footprint \"%s\" deleted from library \"%s\"" )
 
#define FMT_MOD_CREATE   _( "New Footprint" )
 
#define FMT_NO_REF_ABORTED   _( "No footprint name defined." )
 
#define FMT_SELECT_LIB   _( "Select Library" )
 
#define EXPORT_IMPORT_LASTPATH_KEY   wxT( "import_last_path" )
 

Functions

static const wxString INFO_LEGACY_LIB_WARN_EDIT (_("Writing/modifying legacy libraries (.mod files) is not allowed\n" "Please save the current library to the new .pretty format\n" "and update your footprint lib table\n" "to save your footprint (a .kicad_mod file) in the .pretty library folder"))
 
static const wxString INFO_LEGACY_LIB_WARN_DELETE (_("Modifying legacy libraries (.mod files) is not allowed\n" "Please save the current library under the new .pretty format\n" "and update your footprint lib table\n" "before deleting a footprint"))
 
static wxFileName getFootprintFilenameFromUser (wxWindow *aParent, const wxString &aLastPath)
 Prompt the user for a module file to open. More...
 
static IO_MGR::PCB_FILE_T detect_file_type (FILE *aFile, const wxFileName &aFileName, wxString *aName)
 Read a file to detect the type. More...
 
static MODULEparse_module_with_plugin (const wxFileName &aFileName, IO_MGR::PCB_FILE_T aFileType, const wxString &aName)
 Parse a footprint using a PLUGIN. More...
 
static MODULEparse_module_kicad (const wxFileName &aFileName)
 Parse a KICAD footprint. More...
 
MODULEtry_load_footprint (const wxFileName &aFileName, IO_MGR::PCB_FILE_T aFileType, const wxString &aName)
 Try to load a footprint, returning NULL if the file couldn't be accessed. More...
 

Macro Definition Documentation

◆ EXPORT_IMPORT_LASTPATH_KEY

#define EXPORT_IMPORT_LASTPATH_KEY   wxT( "import_last_path" )

Definition at line 92 of file footprint_libraries_utils.cpp.

◆ FMT_EXPORT_MODULE

#define FMT_EXPORT_MODULE   _( "Export Footprint" )

Definition at line 69 of file footprint_libraries_utils.cpp.

◆ FMT_EXPORTED

#define FMT_EXPORTED   _( "Footprint exported to file \"%s\"" )

Definition at line 72 of file footprint_libraries_utils.cpp.

◆ FMT_FILE_NOT_FOUND

#define FMT_FILE_NOT_FOUND   _( "File \"%s\" not found" )

Definition at line 64 of file footprint_libraries_utils.cpp.

◆ FMT_IMPORT_MODULE

#define FMT_IMPORT_MODULE   _( "Import Footprint" )

Definition at line 63 of file footprint_libraries_utils.cpp.

◆ FMT_LIB_READ_ONLY

#define FMT_LIB_READ_ONLY   _( "Library \"%s\" is read only, not writable" )

Definition at line 67 of file footprint_libraries_utils.cpp.

◆ FMT_MOD_CREATE

#define FMT_MOD_CREATE   _( "New Footprint" )

Definition at line 74 of file footprint_libraries_utils.cpp.

◆ FMT_MOD_DELETED

#define FMT_MOD_DELETED   _( "Footprint \"%s\" deleted from library \"%s\"" )

Definition at line 73 of file footprint_libraries_utils.cpp.

◆ FMT_MOD_NOT_FOUND

#define FMT_MOD_NOT_FOUND   _( "Unable to find or load footprint \"%s\" from lib path \"%s\"" )

Definition at line 66 of file footprint_libraries_utils.cpp.

◆ FMT_MOD_REF

#define FMT_MOD_REF   _( "Enter footprint name:" )

Definition at line 71 of file footprint_libraries_utils.cpp.

◆ FMT_NO_REF_ABORTED

#define FMT_NO_REF_ABORTED   _( "No footprint name defined." )

Definition at line 76 of file footprint_libraries_utils.cpp.

◆ FMT_NOT_MODULE

#define FMT_NOT_MODULE   _( "Not a footprint file" )

Definition at line 65 of file footprint_libraries_utils.cpp.

◆ FMT_OK_DELETE

#define FMT_OK_DELETE   _( "OK to delete footprint \"%s\" in library \"%s\"" )

Definition at line 62 of file footprint_libraries_utils.cpp.

◆ FMT_SAVE_MODULE

#define FMT_SAVE_MODULE   _( "Save Footprint" )

Definition at line 70 of file footprint_libraries_utils.cpp.

◆ FMT_SELECT_LIB

#define FMT_SELECT_LIB   _( "Select Library" )

Definition at line 77 of file footprint_libraries_utils.cpp.

Function Documentation

◆ detect_file_type()

static IO_MGR::PCB_FILE_T detect_file_type ( FILE *  aFile,
const wxFileName &  aFileName,
wxString *  aName 
)
static

Read a file to detect the type.

Parameters
aFile- open file to be read. File pointer will be closed.
aFileName- file name to be read
aName- wxString to receive the module name iff type is LEGACY

Definition at line 130 of file footprint_libraries_utils.cpp.

132 {
133  FILE_LINE_READER freader( aFile, aFileName.GetFullPath() );
134  WHITESPACE_FILTER_READER reader( freader );
135  IO_MGR::PCB_FILE_T file_type;
136 
137  wxASSERT( aName );
138 
139  reader.ReadLine();
140  char* line = reader.Line();
141 
142  if( !strncasecmp( line, "(module", strlen( "(module" ) ) )
143  {
144  file_type = IO_MGR::KICAD_SEXP;
145  *aName = aFileName.GetName();
146  }
147  else if( !strncasecmp( line, FOOTPRINT_LIBRARY_HEADER, FOOTPRINT_LIBRARY_HEADER_CNT ) )
148  {
149  file_type = IO_MGR::LEGACY;
150 
151  while( reader.ReadLine() )
152  {
153  if( !strncasecmp( line, "$MODULE", strlen( "$MODULE" ) ) )
154  {
155  *aName = FROM_UTF8( StrPurge( line + strlen( "$MODULE" ) ) );
156  break;
157  }
158  }
159  }
160  else if( !strncasecmp( line, "Element", strlen( "Element" ) ) )
161  {
162  file_type = IO_MGR::GEDA_PCB;
163  *aName = aFileName.GetName();
164  }
165  else
166  {
167  file_type = IO_MGR::FILE_TYPE_NONE;
168  }
169 
170  return file_type;
171 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:53
char * StrPurge(char *text)
Remove leading and training spaces, tabs and end of line chars in text.
Definition: string.cpp:269
Class WHITESPACE_FILTER_READER reads lines of text from another LINE_READER, but only returns non-com...
Definition: filter_reader.h:71
Geda PCB file formats.
Definition: io_mgr.h:60
#define FOOTPRINT_LIBRARY_HEADER
Definition: legacy_plugin.h:38
Class FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
#define FOOTPRINT_LIBRARY_HEADER_CNT
Definition: legacy_plugin.h:39
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:56
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:54
S-expression Pcbnew file format.
Definition: io_mgr.h:57

References IO_MGR::FILE_TYPE_NONE, FOOTPRINT_LIBRARY_HEADER, FOOTPRINT_LIBRARY_HEADER_CNT, FROM_UTF8(), IO_MGR::GEDA_PCB, IO_MGR::KICAD_SEXP, IO_MGR::LEGACY, and StrPurge().

Referenced by FOOTPRINT_EDIT_FRAME::Import_Module().

◆ getFootprintFilenameFromUser()

static wxFileName getFootprintFilenameFromUser ( wxWindow *  aParent,
const wxString &  aLastPath 
)
static

Prompt the user for a module file to open.

Parameters
aParent- parent window for the dialog
aLastPath- last opened path

Definition at line 100 of file footprint_libraries_utils.cpp.

101 {
102  static int lastFilterIndex = 0; // To store the last choice during a session.
103  wxString wildCard;
104 
105  wildCard << KiCadFootprintLibFileWildcard() << wxChar( '|' )
106  << ModLegacyExportFileWildcard() << wxChar( '|' )
107  << GedaPcbFootprintLibFileWildcard() << wxChar( '|' )
108  << AllFilesWildcard();
109 
110  wxFileDialog dlg( aParent, FMT_IMPORT_MODULE, aLastPath, wxEmptyString, wildCard,
111  wxFD_OPEN | wxFD_FILE_MUST_EXIST );
112 
113  dlg.SetFilterIndex( lastFilterIndex );
114 
115  if( dlg.ShowModal() == wxID_CANCEL )
116  return wxFileName();
117 
118  lastFilterIndex = dlg.GetFilterIndex();
119 
120  return wxFileName( dlg.GetPath() );
121 }
wxString AllFilesWildcard()
wxString ModLegacyExportFileWildcard()
#define FMT_IMPORT_MODULE
wxString KiCadFootprintLibFileWildcard()
wxString GedaPcbFootprintLibFileWildcard()

References AllFilesWildcard(), FMT_IMPORT_MODULE, GedaPcbFootprintLibFileWildcard(), KiCadFootprintLibFileWildcard(), and ModLegacyExportFileWildcard().

Referenced by FOOTPRINT_EDIT_FRAME::Import_Module().

◆ INFO_LEGACY_LIB_WARN_DELETE()

static const wxString INFO_LEGACY_LIB_WARN_DELETE ( _("Modifying legacy libraries (.mod files) is not allowed\n" "Please save the current library under the new .pretty format\n" "and update your footprint lib table\n" "before deleting a footprint")  )
static

◆ INFO_LEGACY_LIB_WARN_EDIT()

static const wxString INFO_LEGACY_LIB_WARN_EDIT ( _("Writing/modifying legacy libraries (.mod files) is not allowed\n" "Please save the current library to the new .pretty format\n" "and update your footprint lib table\n" "to save your footprint (a .kicad_mod file) in the .pretty library folder")  )
static

◆ parse_module_kicad()

static MODULE* parse_module_kicad ( const wxFileName &  aFileName)
static

Parse a KICAD footprint.

Parameters
aFileName- file name to parse

Definition at line 208 of file footprint_libraries_utils.cpp.

209 {
210  wxString fcontents;
211  PCB_IO pcb_io;
212  wxFFile f( aFileName.GetFullPath() );
213 
214  if( !f.IsOpened() )
215  return NULL;
216 
217  f.ReadAll( &fcontents );
218 
219  return dynamic_cast<MODULE*>( pcb_io.Parse( fcontents ) );
220 }
BOARD_ITEM * Parse(const wxString &aClipboardSourceInput)
Class PCB_IO is a PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.

References PCB_IO::Parse().

Referenced by try_load_footprint().

◆ parse_module_with_plugin()

static MODULE* parse_module_with_plugin ( const wxFileName &  aFileName,
IO_MGR::PCB_FILE_T  aFileType,
const wxString &  aName 
)
static

Parse a footprint using a PLUGIN.

Parameters
aFileName- file name to parse
aFileType- type of the file
aName- name of the footprint

Definition at line 180 of file footprint_libraries_utils.cpp.

183 {
184  wxString path;
185 
186  switch( aFileType )
187  {
188  case IO_MGR::GEDA_PCB:
189  path = aFileName.GetPath();
190  break;
191  case IO_MGR::LEGACY:
192  path = aFileName.GetFullPath();
193  break;
194  default:
195  wxFAIL_MSG( wxT( "unexpected IO_MGR::PCB_FILE_T" ) );
196  }
197 
198  PLUGIN::RELEASER pi( IO_MGR::PluginFind( aFileType ) );
199 
200  return pi->FootprintLoad( path, aName );
201 }
Geda PCB file formats.
Definition: io_mgr.h:60
Class RELEASER releases a PLUGIN in the context of a potential thrown exception, through its destruct...
Definition: io_mgr.h:568
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:56
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Function PluginFind returns a PLUGIN which the caller can use to import, export, save,...
Definition: io_mgr.cpp:58

References IO_MGR::GEDA_PCB, IO_MGR::LEGACY, and IO_MGR::PluginFind().

Referenced by try_load_footprint().

◆ try_load_footprint()

MODULE* try_load_footprint ( const wxFileName &  aFileName,
IO_MGR::PCB_FILE_T  aFileType,
const wxString &  aName 
)

Try to load a footprint, returning NULL if the file couldn't be accessed.

Parameters
aFileName- file name to load
aFileType- type of the file to load
aName- footprint name

Definition at line 229 of file footprint_libraries_utils.cpp.

231 {
232  MODULE* module;
233 
234  switch( aFileType )
235  {
236  case IO_MGR::GEDA_PCB:
237  case IO_MGR::LEGACY:
238  module = parse_module_with_plugin( aFileName, aFileType, aName );
239  break;
240 
241  case IO_MGR::KICAD_SEXP:
242  module = parse_module_kicad( aFileName );
243  break;
244 
245  default:
246  wxFAIL_MSG( wxT( "unexpected IO_MGR::PCB_FILE_T" ) );
247  module = NULL;
248  }
249 
250  return module;
251 }
Geda PCB file formats.
Definition: io_mgr.h:60
static MODULE * parse_module_kicad(const wxFileName &aFileName)
Parse a KICAD footprint.
static MODULE * parse_module_with_plugin(const wxFileName &aFileName, IO_MGR::PCB_FILE_T aFileType, const wxString &aName)
Parse a footprint using a PLUGIN.
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:56
S-expression Pcbnew file format.
Definition: io_mgr.h:57

References IO_MGR::GEDA_PCB, IO_MGR::KICAD_SEXP, IO_MGR::LEGACY, parse_module_kicad(), and parse_module_with_plugin().

Referenced by FOOTPRINT_EDIT_FRAME::Import_Module().