panel_fp_lib_table.cpp File Reference

#include <set>
#include <wx/dir.h>
#include <wx/regex.h>
#include <wx/grid.h>
#include <wx/dirdlg.h>
#include <wx/filedlg.h>
#include <project.h>
#include <3d_viewer/eda_3d_viewer_frame.h>
#include <panel_fp_lib_table.h>
#include <lib_id.h>
#include <fp_lib_table.h>
#include <lib_table_lexer.h>
#include <invoke_pcb_dialog.h>
#include <bitmaps.h>
#include <lib_table_grid_tricks.h>
#include <widgets/wx_grid.h>
#include <widgets/std_bitmap_button.h>
#include <confirm.h>
#include <lib_table_grid.h>
#include <wildcards_and_files_ext.h>
#include <pgm_base.h>
#include <pcb_edit_frame.h>
#include <env_paths.h>
#include <dialogs/dialog_edit_library_tables.h>
#include <footprint_viewer_frame.h>
#include <footprint_edit_frame.h>
#include <kiway.h>
#include <kiway_express.h>
#include <widgets/grid_readonly_text_helpers.h>
#include <widgets/grid_text_button_helpers.h>
#include <pcbnew_id.h>
#include <settings/settings_manager.h>
#include <paths.h>
#include <macros.h>

Go to the source code of this file.

Classes
struct	SUPPORTED_FILE_TYPE
	Container that describes file type info for the add a library options. More...
class	LIBRARY_TRAVERSER
	Traverser implementation that looks to find any and all "folder" libraries by looking for files with a specific extension inside folders. More...
class	FP_LIB_TABLE_GRID
	This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object. More...
class	FP_GRID_TRICKS

Macros
#define	MYID_OPTIONS_EDITOR   15151

Enumerations
enum	{   ID_PANEL_FPLIB_ADD_KICADMOD = ID_PCBNEW_END_LIST , ID_PANEL_FPLIB_ADD_ALTIUM , ID_PANEL_FPLIB_ADD_EAGLE6 , ID_PANEL_FPLIB_ADD_KICADLEGACY ,   ID_PANEL_FPLIB_ADD_GEDA }
	Event IDs for the menu items in the split button menu for add a library. More...

Functions
static const std::map< int, SUPPORTED_FILE_TYPE > &	fileTypes ()
	Map with event id as the key to supported file types that will be listed for the add a library option. More...
void	InvokePcbLibTableEditor (KIWAY *aKiway, wxWindow *aCaller)
	Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the global and project library tables. More...

Macro Definition Documentation

MYID_OPTIONS_EDITOR

#define MYID_OPTIONS_EDITOR   15151

Definition at line 247 of file panel_fp_lib_table.cpp.

Enumeration Type Documentation

anonymous enum

anonymous enum

Event IDs for the menu items in the split button menu for add a library.

Enumerator
ID_PANEL_FPLIB_ADD_KICADMOD
ID_PANEL_FPLIB_ADD_ALTIUM
ID_PANEL_FPLIB_ADD_EAGLE6
ID_PANEL_FPLIB_ADD_KICADLEGACY
ID_PANEL_FPLIB_ADD_GEDA

Definition at line 86 of file panel_fp_lib_table.cpp.

 {
 ID_PANEL_FPLIB_ADD_KICADMOD = ID_PCBNEW_END_LIST,
 ID_PANEL_FPLIB_ADD_ALTIUM,
 ID_PANEL_FPLIB_ADD_EAGLE6,
 ID_PANEL_FPLIB_ADD_KICADLEGACY,
 ID_PANEL_FPLIB_ADD_GEDA,
};

Function Documentation

fileTypes()

static const std::map< int, SUPPORTED_FILE_TYPE > & fileTypes ( )

static

Map with event id as the key to supported file types that will be listed for the add a library option.

Definition at line 99 of file panel_fp_lib_table.cpp.

{
 /*
 * TODO(C++20): Clean this up
 * This is wrapped inside a function to prevent a static initialization order fiasco
 * with the file extension variables. Once C++20 is allowed in KiCad code, those file
 * extensions can be made constexpr and this can be removed from a function call and
 * placed in the file normally.
 */
 static const std::map<int, SUPPORTED_FILE_TYPE> fileTypes =
 {
 { ID_PANEL_FPLIB_ADD_KICADMOD,
 {
 wxT( "KiCad (folder with .kicad_mod files)" ), wxT( "" ),
 KiCadFootprintFileExtension, false, IO_MGR::KICAD_SEXP
 }
 },
 { ID_PANEL_FPLIB_ADD_ALTIUM,
 {
 "Altium (*.PcbLib)", AltiumFootprintLibPathWildcard(), "", true, IO_MGR::ALTIUM_DESIGNER
 }
 },
 { ID_PANEL_FPLIB_ADD_EAGLE6,
 {
 wxT( "Eagle 6.x (*.lbr)" ), EagleFootprintLibPathWildcard(), wxT( "" ),
 true, IO_MGR::EAGLE
 }
 },
 { ID_PANEL_FPLIB_ADD_KICADLEGACY,
 {
 wxT( "KiCad legacy (*.mod)" ), LegacyFootprintLibPathWildcard(), wxT( "" ),
 true, IO_MGR::LEGACY
 }
 },
 { ID_PANEL_FPLIB_ADD_GEDA,
 {
 wxT( "Geda (folder with *.fp files)" ), wxT( "" ),
 GedaPcbFootprintLibFileExtension, false, IO_MGR::GEDA_PCB
 }
 },
 };
 
 return fileTypes;
}

References IO_MGR::ALTIUM_DESIGNER, AltiumFootprintLibPathWildcard(), IO_MGR::EAGLE, EagleFootprintLibPathWildcard(), fileTypes(), IO_MGR::GEDA_PCB, GedaPcbFootprintLibFileExtension, ID_PANEL_FPLIB_ADD_ALTIUM, ID_PANEL_FPLIB_ADD_EAGLE6, ID_PANEL_FPLIB_ADD_GEDA, ID_PANEL_FPLIB_ADD_KICADLEGACY, ID_PANEL_FPLIB_ADD_KICADMOD, IO_MGR::KICAD_SEXP, KiCadFootprintFileExtension, IO_MGR::LEGACY, and LegacyFootprintLibPathWildcard().

Referenced by PANEL_FP_LIB_TABLE::browseLibrariesHandler(), fileTypes(), and PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE().

InvokePcbLibTableEditor()

void InvokePcbLibTableEditor	(	KIWAY *	aKiway,
		wxWindow *	aCaller
	)

Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the global and project library tables.

Parameters

aCaller

is the wxWindow which is invoking the dialog.

Returns

true if either table changed.

Definition at line 1086 of file panel_fp_lib_table.cpp.

{
 FP_LIB_TABLE* globalTable = &GFootprintTable;
 wxString globalTablePath = FP_LIB_TABLE::GetGlobalTableFileName();
 FP_LIB_TABLE* projectTable = aKiway->Prj().PcbFootprintLibs();
 wxString projectTablePath = aKiway->Prj().FootprintLibTblName();
 wxString msg;
 
 DIALOG_EDIT_LIBRARY_TABLES dlg( aCaller, _( "Footprint Libraries" ) );
 dlg.SetKiway( &dlg, aKiway );
 
 if( aKiway->Prj().IsNullProject() )
 projectTable = nullptr;
 
 dlg.InstallPanel( new PANEL_FP_LIB_TABLE( &dlg, globalTable, globalTablePath,
 projectTable, projectTablePath,
 aKiway->Prj().GetProjectPath() ) );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return;
 
 if( dlg.m_GlobalTableChanged )
 {
 try
 {
 globalTable->Save( globalTablePath );
 }
 catch( const IO_ERROR& ioe )
 {
 msg.Printf( _( "Error saving global library table:\n\n%s" ), ioe.What() );
 wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
 }
 }
 
 if( projectTable && dlg.m_ProjectTableChanged )
 {
 try
 {
 projectTable->Save( projectTablePath );
 }
 catch( const IO_ERROR& ioe )
 {
 msg.Printf( _( "Error saving project-specific library table:\n\n%s" ), ioe.What() );
 wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
 }
 }
 
 std::string payload = "";
 aKiway->ExpressMail( FRAME_FOOTPRINT_EDITOR, MAIL_RELOAD_LIB, payload );
 aKiway->ExpressMail( FRAME_FOOTPRINT_VIEWER, MAIL_RELOAD_LIB, payload );
 aKiway->ExpressMail( FRAME_CVPCB, MAIL_RELOAD_LIB, payload );
}

References _, KIWAY::ExpressMail(), PROJECT::FootprintLibTblName(), FRAME_CVPCB, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, FP_LIB_TABLE::GetGlobalTableFileName(), PROJECT::GetProjectPath(), GFootprintTable, DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), PROJECT::IsNullProject(), DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, MAIL_RELOAD_LIB, PROJECT::PcbFootprintLibs(), KIWAY::Prj(), LIB_TABLE::Save(), KIWAY_HOLDER::SetKiway(), and IO_ERROR::What().

Referenced by PCB::IFACE::CreateKiWindow().