gpcb_plugin.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012-2020 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2012-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 _GPCB_PLUGIN_H_
#define _GPCB_PLUGIN_H_
 
#include <io_mgr.h>
#include <string>
 
 
class GPCB_FPL_CACHE;
 
 
class GPCB_PLUGIN : public PLUGIN
{
public:
 const wxString PluginName() const override
 {
 return wxT( "gEDA PCB" );
 }
 
 PLUGIN_FILE_DESC GetFootprintFileDesc() const override
 {
 return PLUGIN_FILE_DESC( _HKI( "gEDA PCB footprint file" ), { "fp" } );
 }
 
 PLUGIN_FILE_DESC GetFootprintLibDesc() const override
 {
 return PLUGIN_FILE_DESC( _HKI( "gEDA PCB footprint library directory" ), {}, { "fp" },
 false );
 }
 
 FOOTPRINT* ImportFootprint( const wxString& aFootprintPath, wxString& aFootprintNameOut,
 const STRING_UTF8_MAP* aProperties ) override;
 
 void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aLibraryPath,
 bool aBestEfforts,
 const STRING_UTF8_MAP* aProperties = nullptr ) override;
 
 const FOOTPRINT* GetEnumeratedFootprint( const wxString& aLibraryPath,
 const wxString& aFootprintName,
 const STRING_UTF8_MAP* aProperties = nullptr ) override;
 
 FOOTPRINT* FootprintLoad( const wxString& aLibraryPath, const wxString& aFootprintName,
 bool aKeepUUID = false,
 const STRING_UTF8_MAP* aProperties = nullptr ) override;
 
 void FootprintDelete( const wxString& aLibraryPath, const wxString& aFootprintName,
 const STRING_UTF8_MAP* aProperties = nullptr ) override;
 
 bool FootprintLibDelete( const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties = nullptr ) override;
 
 long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override;
 
 bool IsFootprintLibWritable( const wxString& aLibraryPath ) override;
 
 //-----</PLUGIN API>--------------------------------------------------------
 
 GPCB_PLUGIN();
 
 GPCB_PLUGIN( int aControlFlags );
 
 ~GPCB_PLUGIN();
 
private:
 void validateCache( const wxString& aLibraryPath, bool checkModified = true );
 
 const FOOTPRINT* getFootprint( const wxString& aLibraryPath, const wxString& aFootprintName,
 const STRING_UTF8_MAP* aProperties, bool checkModified );
 
 void init( const STRING_UTF8_MAP* aProperties );
 
 friend class GPCB_FPL_CACHE;
 
protected:
 wxString m_error; 
 const STRING_UTF8_MAP* m_props; 
 GPCB_FPL_CACHE* m_cache; 
 int m_ctl;
 LINE_READER* m_reader; 
 wxString m_filename; 
};
 
#endif // _GPCB_PLUGIN_H_