io_mgr.h

Go to the documentation of this file.

#ifndef IO_MGR_H_
#define IO_MGR_H_
 
/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2011-2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2016-2020 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
 */
 
#include <richio.h>
#include <map>
#include <functional>
#include <wx/time.h>
 
#include <config.h>
 
class BOARD;
class PLUGIN;
class FOOTPRINT;
class STRING_UTF8_MAP;
class PROJECT;
class PROGRESS_REPORTER;
 
class IO_MGR
{
public:
 
 enum PCB_FILE_T
 {
 LEGACY, 
 KICAD_SEXP, 
 EAGLE,
 PCAD,
 FABMASTER,
 ALTIUM_DESIGNER,
 ALTIUM_CIRCUIT_STUDIO,
 ALTIUM_CIRCUIT_MAKER,
 CADSTAR_PCB_ARCHIVE,
 GEDA_PCB, 
 // add your type here.
 
 // etc.
 
 FILE_TYPE_NONE
 };
 
 class PLUGIN_REGISTRY
 {
 public:
 struct ENTRY
 {
 PCB_FILE_T m_type;
 std::function<PLUGIN*(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<PLUGIN*(void)> aCreateFunc )
 {
 ENTRY ent;
 ent.m_type = aType;
 ent.m_createFunc = aCreateFunc;
 ent.m_name = aName;
 m_plugins.push_back( ent );
 }
 
 PLUGIN* 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;
 };
 
 struct REGISTER_PLUGIN
 {
 REGISTER_PLUGIN( PCB_FILE_T aType, const wxString& aName,
 std::function<PLUGIN*(void)> aCreateFunc )
 {
 PLUGIN_REGISTRY::Instance()->Register( aType, aName, aCreateFunc );
 }
 };
 
 
 static PLUGIN* PluginFind( PCB_FILE_T aFileType );
 
 static void PluginRelease( PLUGIN* aPlugin );
 
 static const wxString ShowType( PCB_FILE_T aFileType );
 
 static PCB_FILE_T EnumFromStr( const wxString& aFileType );
 
 static const wxString GetFileExtension( PCB_FILE_T aFileType );
 
 static PCB_FILE_T GuessPluginTypeFromLibPath( const wxString& aLibPath );
 
 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 );
 
 static void Save( PCB_FILE_T aFileType, const wxString& aFileName, BOARD* aBoard,
 const STRING_UTF8_MAP* aProperties = nullptr );
};
 
 
class PLUGIN
{
public:
 virtual const wxString PluginName() const = 0;
 
 virtual const wxString GetFileExtension() const = 0;
 
 virtual void SetQueryUserCallback( std::function<bool( wxString aTitle, int aIcon,
 wxString aMessage,
 wxString aAction )> aCallback )
 { }
 
 virtual BOARD* Load( const wxString& aFileName, BOARD* aAppendToMe,
 const STRING_UTF8_MAP* aProperties = nullptr, PROJECT* aProject = nullptr,
 PROGRESS_REPORTER* aProgressReporter = nullptr );
 
 virtual std::vector<FOOTPRINT*> GetImportedCachedLibraryFootprints();
 
 virtual void Save( const wxString& aFileName, BOARD* aBoard,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aLibraryPath,
 bool aBestEfforts, const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual long long GetLibraryTimestamp( const wxString& aLibraryPath ) const = 0;
 
 virtual void PrefetchLib( const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual FOOTPRINT* FootprintLoad( const wxString& aLibraryPath,
 const wxString& aFootprintName,
 bool aKeepUUID = false,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual const FOOTPRINT* GetEnumeratedFootprint( const wxString& aLibraryPath,
 const wxString& aFootprintName,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual bool FootprintExists( const wxString& aLibraryPath, const wxString& aFootprintName,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void FootprintSave( const wxString& aLibraryPath, const FOOTPRINT* aFootprint,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void FootprintDelete( const wxString& aLibraryPath, const wxString& aFootprintName,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void FootprintLibCreate( const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual bool FootprintLibDelete( const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual bool IsFootprintLibWritable( const wxString& aLibraryPath );
 
 virtual void FootprintLibOptions( STRING_UTF8_MAP* aListToAppendTo ) const;
 
 virtual ~PLUGIN()
 {};
 
 
#ifndef SWIG
 class RELEASER
 {
 PLUGIN* plugin;
 
 // private assignment operator so it's illegal
 RELEASER& operator=( RELEASER& aOther ) { return *this; }
 
 // private copy constructor so it's illegal
 RELEASER( const RELEASER& aOther ) : plugin( nullptr ) {}
 
 public:
 RELEASER( PLUGIN* aPlugin = nullptr ) :
 plugin( aPlugin )
 {
 }
 
 ~RELEASER()
 {
 if( plugin )
 release();
 }
 
 void release()
 {
 IO_MGR::PluginRelease( plugin );
 plugin = nullptr;
 }
 
 void set( PLUGIN* aPlugin )
 {
 if( plugin )
 release();
 plugin = aPlugin;
 }
 
 operator PLUGIN* () const
 {
 return plugin;
 }
 
 PLUGIN* operator -> () const
 {
 return plugin;
 }
 };
#endif
};
 
#endif // IO_MGR_H_