footprint_library_adapter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Jon Evans <[email protected]>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef FOOTPRINT_LIBRARY_ADAPTER_H
#define FOOTPRINT_LIBRARY_ADAPTER_H
 
#include <lib_id.h>
#include <libraries/library_manager.h>
#include <pcb_io/pcb_io.h>
#include <project.h>
 
class FOOTPRINT;
 

class FOOTPRINT_LIBRARY_ADAPTER : public LIBRARY_MANAGER_ADAPTER, public PROJECT::_ELEM
{
public:
    FOOTPRINT_LIBRARY_ADAPTER( LIBRARY_MANAGER& aManager );
 
    LIBRARY_TABLE_TYPE Type() const override { return LIBRARY_TABLE_TYPE::FOOTPRINT; }
 
    PROJECT::ELEM ProjectElementType() override { return PROJECT::ELEM::FPTBL; }
 
    static wxString GlobalPathEnvVariableName();
 
    void AsyncLoad() override;

    std::optional<LIB_STATUS> LoadOne( const wxString& aNickname );

    std::optional<LIB_STATUS> GetLibraryStatus( const wxString& aNickname ) const override;

    std::vector<FOOTPRINT*> GetFootprints( const wxString& aNickname, bool aBestEfforts = false );

    std::vector<wxString> GetFootprintNames( const wxString& aNickname, bool aBestEfforts = false );

    long long GenerateTimestamp( const wxString* aNickname );
 
    bool FootprintExists( const wxString& aNickname, const wxString& aName );

    FOOTPRINT* LoadFootprint( const wxString& aNickname, const wxString& aName, bool aKeepUUID );
 
    FOOTPRINT* LoadFootprint( const LIB_ID& aLibId, bool aKeepUUID )
    {
        return LoadFootprint( aLibId.GetLibNickname(), aLibId.GetLibItemName(), aKeepUUID );
    }

    FOOTPRINT* LoadFootprintWithOptionalNickname( const LIB_ID& aFootprintId, bool aKeepUUID );
 
    // TODO(JE) library tables - hoist out?
    enum SAVE_T
    {
        SAVE_OK,
        SAVE_SKIPPED,
    };

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

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

    bool IsFootprintLibWritable( const wxString& aNickname );
 
    std::optional<LIBRARY_ERROR> LibraryError( const wxString& aNickname ) const override;
 
protected:
 
    std::map<wxString, LIB_DATA>& globalLibs() override { return GlobalLibraries; }
    std::map<wxString, LIB_DATA>& globalLibs() const override { return GlobalLibraries; }
    std::mutex& globalLibsMutex() override { return GlobalLibraryMutex; }
 
    LIBRARY_RESULT<IO_BASE*> createPlugin( const LIBRARY_TABLE_ROW* row ) override;
 
    IO_BASE* plugin( const LIB_DATA* aRow ) override { return pcbplugin( aRow ); }
 
private:
    static PCB_IO* pcbplugin( const LIB_DATA* aRow );
 
    // The global libraries, potentially shared between multiple different open
    // projects, each of which has their own instance of this adapter class
    static std::map<wxString, LIB_DATA> GlobalLibraries;
 
    static std::mutex GlobalLibraryMutex;
};
 
#endif //FOOTPRINT_LIBRARY_ADAPTER_H