/*
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2011-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2016-2023 Kicad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef PCB_IO_MGR_H_
#define PCB_IO_MGR_H_
#include <cstdint>
#include <config.h>
#include <vector>
#include <wx/arrstr.h>
#include <i18n_utility.h>
#include <io/io_base.h>
#include <io/io_mgr.h>
class BOARD;
class PCB_IO;
class FOOTPRINT;
class STRING_UTF8_MAP;
class PROJECT;
class PROGRESS_REPORTER;
/**
* A factory which returns an instance of a #PLUGIN.
*/
class PCB_IO_MGR : public IO_MGR
{
public:
/**
* The set of file types that the PCB_IO_MGR knows about, and for which there has been a
* plugin written, in alphabetical order.
*/
enum PCB_FILE_T
{
PCB_FILE_UNKNOWN = 0, ///< 0 is not a legal menu id on Mac
KICAD_SEXP, ///< S-expression Pcbnew file format.
LEGACY, ///< Legacy Pcbnew file formats prior to s-expression.
ALTIUM_CIRCUIT_MAKER,
ALTIUM_CIRCUIT_STUDIO,
ALTIUM_DESIGNER,
CADSTAR_PCB_ARCHIVE,
EAGLE,
EASYEDA,
EASYEDAPRO,
FABMASTER,
GEDA_PCB, ///< Geda PCB file formats.
PCAD,
SOLIDWORKS_PCB,
IPC2581,
// add your type here.
// etc.
FILE_TYPE_NONE
};
/**
* Hold a list of available plugins, created using a singleton REGISTER_PLUGIN object.
* This way, plugins can be added link-time.
*/
class PLUGIN_REGISTRY
{
public:
struct ENTRY
{
PCB_FILE_T m_type;
std::function<PCB_IO*(void)> m_createFunc;
wxString m_name;
};
static PLUGIN_REGISTRY *Instance()
{
static PLUGIN_REGISTRY *self = nullptr;
if( !self )
{
self = new PLUGIN_REGISTRY;
}
return self;
}
void Register( PCB_FILE_T aType, const wxString& aName,
std::function<PCB_IO*(void)> aCreateFunc )
{
ENTRY ent;
ent.m_type = aType;
ent.m_createFunc = aCreateFunc;
ent.m_name = aName;
m_plugins.push_back( ent );
}
PCB_IO* Create( PCB_FILE_T aFileType ) const
{
for( auto& ent : m_plugins )
{
if ( ent.m_type == aFileType )
{
return ent.m_createFunc();
}
}
return nullptr;
}
const std::vector<ENTRY>& AllPlugins() const
{
return m_plugins;
}
private:
std::vector<ENTRY> m_plugins;
};
/**
* Register a plugin.
*
* Declare as a static variable in an anonymous namespace.
*
* @param aType type of the plugin
* @param aName name of the file format
* @param aCreateFunc function that creates a new object for the plugin.
*/
struct REGISTER_PLUGIN
{
REGISTER_PLUGIN( PCB_FILE_T aType, const wxString& aName,
std::function<PCB_IO*(void)> aCreateFunc )
{
PLUGIN_REGISTRY::Instance()->Register( aType, aName, aCreateFunc );
}
};
/**
* Return a #PLUGIN which the caller can use to import, export, save, or load
* design documents.
*
* @note The caller owns the returned object.
*
* @param aFileType is from #PCB_FILE_T and tells which plugin to find.
* @return the plug in corresponding to \a aFileType or NULL if not found.
*/
static PCB_IO* PluginFind( PCB_FILE_T aFileType );
/**
* Return a brief name for a plugin given \a aFileType enum.
*/
static const wxString ShowType( PCB_FILE_T aFileType );
/**
* Return the #PCB_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc.
*/
static PCB_FILE_T EnumFromStr( const wxString& aFileType );
/**
* Return a plugin type given a path for a board file. FILE_TYPE_NONE if the file is not known.
*/
static PCB_FILE_T FindPluginTypeFromBoardPath( const wxString& aFileName, int aCtl = 0 );
/**
* Return a plugin type given a footprint library's libPath.
*/
static PCB_FILE_T GuessPluginTypeFromLibPath( const wxString& aLibPath, int aCtl = 0 );
/**
* Find the requested #PLUGIN and if found, calls the #PLUGIN::LoadBoard() function
* on it using the arguments passed to this function. After the #PLUGIN::LoadBoard()
* function returns, the #PLUGIN is Released() as part of this call.
*
* @param aFileType is the #PCB_FILE_T of file to load.
* @param aFileName is the name of the file to load.
* @param aAppendToMe is an existing BOARD to append to, use NULL if fresh
* board load is wanted.
* @param aProperties is an associative array that allows the caller to
* pass additional tuning parameters to the PLUGIN.
* @param aProject is the optional #PROJECT object primarily used by third party
* importers.
* @return the loaded #BOARD object. The caller owns it an it will never NULL because
* exception thrown if error.
*
* @throw IO_ERROR if the #PLUGIN cannot be found, file cannot be found, or file cannot
* be loaded.
*/
static BOARD* Load( PCB_FILE_T aFileType, const wxString& aFileName,
BOARD* aAppendToMe = nullptr, const STRING_UTF8_MAP* aProperties = nullptr,
PROJECT* aProject = nullptr,
PROGRESS_REPORTER* aProgressReporter = nullptr );
/**
* Write either a full \a aBoard to a storage file in a format that this implementation
* knows about, or it can be used to write a portion of\a aBoard to a special kind of
* export file.
*
* @param aFileType is the #PCB_FILE_T of file to save.
* @param aFileName is the name of a file to save to on disk.
* @param aBoard is the #BOARD document (data tree) to save or export to disk.
* @param aBoard is the in memory document tree from which to extract information when
* writing to \a aFileName. The caller continues to own the #BOARD, and
* the plugin should refrain from modifying the #BOARD if possible.
* @param aProperties is an associative array that can be used to tell the saver how to
* save the file, because it can take any number of additional named
* tuning arguments that the plugin is known to support. The caller
* continues to own this object (plugin may not delete it), and plugins
* should expect it to be optionally NULL.
*
* @throw IO_ERROR if there is a problem saving or exporting.
*/
static void Save( PCB_FILE_T aFileType, const wxString& aFileName, BOARD* aBoard,
const STRING_UTF8_MAP* aProperties = nullptr );
/**
* Convert a schematic symbol library to the latest KiCad format
*/
static bool ConvertLibrary( STRING_UTF8_MAP* aOldFileProps, const wxString& aOldFilePath,
const wxString& aNewFilePath );
};
#endif // PCB_IO_MGR_H_