design_block_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 <https://www.gnu.org/licenses/>.
 */
 
 
#ifndef DESIGN_BLOCK_LIBRARY_ADAPTER_H
#define DESIGN_BLOCK_LIBRARY_ADAPTER_H
 
#include <kicommon.h>
#include <lib_id.h>
#include <core/leak_at_exit.h>
#include <libraries/library_manager.h>
 
class DESIGN_BLOCK;
class DESIGN_BLOCK_IO;
class PROJECT;
 
 
class KICOMMON_API DESIGN_BLOCK_LIBRARY_ADAPTER : public LIBRARY_MANAGER_ADAPTER
{
public:
    DESIGN_BLOCK_LIBRARY_ADAPTER( LIBRARY_MANAGER& aManager );
 
    ~DESIGN_BLOCK_LIBRARY_ADAPTER() override;
 
    LIBRARY_TABLE_TYPE Type() const override { return LIBRARY_TABLE_TYPE::DESIGN_BLOCK; }
 
    static wxString GlobalPathEnvVariableName();
 
    std::optional<LIB_STATUS> LoadOne( LIB_DATA* aLib ) override;
 
    std::optional<LIB_STATUS> LoadOne( const wxString& nickname );

    std::vector<DESIGN_BLOCK*> GetDesignBlocks( const wxString& aNickname );

    std::vector<wxString> GetDesignBlockNames( const wxString& aNickname );

    DESIGN_BLOCK* LoadDesignBlock( const wxString& aNickname, const wxString& aDesignBlockName,
                                   bool aKeepUUID = false );

    bool DesignBlockExists( const wxString& aNickname, const wxString& aDesignBlockName );

    // TODO(JE) library tables -- do we still need this?
    const DESIGN_BLOCK* GetEnumeratedDesignBlock( const wxString& aNickname, const wxString& aDesignBlockName );

    enum SAVE_T
    {
        SAVE_OK,
        SAVE_SKIPPED,
    };

    SAVE_T SaveDesignBlock( const wxString& aNickname, const DESIGN_BLOCK* aDesignBlock,
                            bool aOverwrite = true );

    void DeleteDesignBlock( const wxString& aNickname, const wxString& aDesignBlockName );

    bool IsDesignBlockLibWritable( const wxString& aNickname );

    DESIGN_BLOCK* DesignBlockLoadWithOptionalNickname( const LIB_ID& aDesignBlockId,
                                                       bool          aKeepUUID = false );
 
protected:
 
    std::map<wxString, LIB_DATA>& globalLibs() override { return GlobalLibraries.Get(); }
    std::map<wxString, LIB_DATA>& globalLibs() const override { return GlobalLibraries.Get(); }
    std::shared_mutex& globalLibsMutex() override { return GlobalLibraryMutex.Get(); }
    std::shared_mutex& globalLibsMutex() const override { return GlobalLibraryMutex.Get(); }
 
    void enumerateLibrary( LIB_DATA* aLib, const wxString& aUri ) override;
 
    LIBRARY_RESULT<IO_BASE*> createPlugin( const LIBRARY_TABLE_ROW* row ) override;
 
    IO_BASE* plugin( const LIB_DATA* aRow ) override;
 
private:

    static DESIGN_BLOCK_IO* dbplugin( 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.
    // Wrapped in LEAK_AT_EXIT to skip destruction at program exit for faster shutdown.
    static LEAK_AT_EXIT<std::map<wxString, LIB_DATA>> GlobalLibraries;
 
    // Leaked like GlobalLibraries so adapter destructors can still lock it to evict their entries
    // even when they run during static teardown.
    static LEAK_AT_EXIT<std::shared_mutex> GlobalLibraryMutex;
};
 
 
 
#endif //DESIGN_BLOCK_LIBRARY_ADAPTER_H