fp_lib_table.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010-2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2012 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2012-2021 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 FP_LIB_TABLE_H_
#define FP_LIB_TABLE_H_

#include <lib_table_base.h>
#include <io_mgr.h>

class FOOTPRINT;
class FP_LIB_TABLE_GRID;


class FP_LIB_TABLE_ROW : public LIB_TABLE_ROW
{
public:
 typedef IO_MGR::PCB_FILE_T LIB_T;

 FP_LIB_TABLE_ROW( const wxString& aNick, const wxString& aURI, const wxString& aType,
 const wxString& aOptions, const wxString& aDescr = wxEmptyString ) :
 LIB_TABLE_ROW( aNick, aURI, aOptions, aDescr )
 {
 SetType( aType );
 }

 FP_LIB_TABLE_ROW() :
 type( IO_MGR::KICAD_SEXP )
 {
 }

 bool operator==( const FP_LIB_TABLE_ROW& aRow ) const;

 bool operator!=( const FP_LIB_TABLE_ROW& aRow ) const { return !( *this == aRow ); }

 const wxString GetType() const override { return IO_MGR::ShowType( type ); }

 void SetType( const wxString& aType ) override;

protected:
 FP_LIB_TABLE_ROW( const FP_LIB_TABLE_ROW& aRow ) :
 LIB_TABLE_ROW( aRow ),
 type( aRow.type )
 {
 }

private:
 virtual LIB_TABLE_ROW* do_clone() const override
 {
 return new FP_LIB_TABLE_ROW( *this );
 }

 void setPlugin( PLUGIN* aPlugin )
 {
 plugin.set( aPlugin );
 }

 friend class FP_LIB_TABLE;

 PLUGIN::RELEASER plugin;
 LIB_T type;
};


class FP_LIB_TABLE : public LIB_TABLE
{
public:
 KICAD_T Type() override { return FP_LIB_TABLE_T; }

 virtual void Parse( LIB_TABLE_LEXER* aLexer ) override;

 virtual void Format( OUTPUTFORMATTER* aOutput, int aIndentLevel ) const override;

 FP_LIB_TABLE( FP_LIB_TABLE* aFallBackTable = nullptr );

 bool operator==( const FP_LIB_TABLE& aFpTable ) const;

 bool operator!=( const FP_LIB_TABLE& r ) const { return !( *this == r ); }

 const FP_LIB_TABLE_ROW* FindRow( const wxString& aNickName, bool aCheckIfEnabled = false );

 void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aNickname,
 bool aBestEfforts );

 long long GenerateTimestamp( const wxString* aNickname );

 void PrefetchLib( const wxString& aNickname );

 FOOTPRINT* FootprintLoad( const wxString& aNickname, const wxString& aFootprintName,
 bool aKeepUUID = false );

 bool FootprintExists( const wxString& aNickname, const wxString& aFootprintName );

 const FOOTPRINT* GetEnumeratedFootprint( const wxString& aNickname,
 const wxString& aFootprintName );
 enum SAVE_T
 {
 SAVE_OK,
 SAVE_SKIPPED,
 };

 SAVE_T FootprintSave( const wxString& aNickname, const FOOTPRINT* aFootprint,
 bool aOverwrite = true );

 void FootprintDelete( const wxString& aNickname, const wxString& aFootprintName );

 bool IsFootprintLibWritable( const wxString& aNickname );

 void FootprintLibDelete( const wxString& aNickname );

 void FootprintLibCreate( const wxString& aNickname );

 FOOTPRINT* FootprintLoadWithOptionalNickname( const LIB_ID& aFootprintId,
 bool aKeepUUID = false );

 static bool LoadGlobalTable( FP_LIB_TABLE& aTable );

 static wxString GetGlobalTableFileName();

 static const wxString GlobalPathEnvVariableName();

private:
 friend class FP_LIB_TABLE_GRID;
};


extern FP_LIB_TABLE GFootprintTable; // KIFACE scope.

#endif // FP_LIB_TABLE_H_