api_handler_libraries.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 KICAD_API_HANDLER_LIBRARIES_H
#define KICAD_API_HANDLER_LIBRARIES_H
 
#include <functional>
#include <map>
#include <vector>
 
#include <api/api_handler.h>
#include <api/common/commands/editor_commands.pb.h>
#include <api/common/commands/library_commands.pb.h>
#include <libraries/library_table.h>
 
class LIB_ID;
class LIBRARY_MANAGER_ADAPTER;
class KIWAY;
struct KIFACE;
class PROJECT;

class API_HANDLER_LIBRARIES : public API_HANDLER
{
public:
    API_HANDLER_LIBRARIES( LIBRARY_TABLE_TYPE aType = LIBRARY_TABLE_TYPE::DESIGN_BLOCK );
 
    ~API_HANDLER_LIBRARIES() override;
 
    void SetKiway( KIWAY* aKiway ) { m_kiway = aKiway; }

    void SetLibraryHandlerRegistrar( std::function<void( KIFACE* )> aRegistrar )
    {
        m_handlerRegisterCallback = std::move( aRegistrar );
    }
 
 
protected:
    HANDLER_RESULT<kiapi::common::commands::LibraryItemsResponse>
    handleGetLibraryItems( const HANDLER_CONTEXT<kiapi::common::commands::GetLibraryItems>& aCtx );
 
    HANDLER_RESULT<kiapi::common::commands::LibraryStatusResponse>
    handleGetLibraryStatuses( const HANDLER_CONTEXT<kiapi::common::commands::GetLibraryStatuses>& aCtx );
 
    HANDLER_RESULT<kiapi::common::types::LibraryCommandStatus>
    handleReloadLibrary( const HANDLER_CONTEXT<kiapi::common::commands::ReloadLibrary>& aCtx );
 
    HANDLER_RESULT<kiapi::common::types::LibraryCommandStatus>
    handleLoadAllLibraries( const HANDLER_CONTEXT<kiapi::common::commands::LoadAllLibraries>& aCtx );

    kiapi::common::types::LibraryCommandStatus loadAllLibraries();
 
    HANDLER_RESULT<kiapi::common::commands::GetItemsResponse>
    handleGetItemsFromLibrary( const HANDLER_CONTEXT<kiapi::common::commands::GetItemsFromLibrary>& aCtx );
 
    virtual bool packLibraryItem( const LIB_ID& aId, google::protobuf::Any& aOutput ) const
    {
        return false;
    }
 
    LIBRARY_TABLE_TYPE libraryType() const { return m_type; }
 
    virtual LIBRARY_MANAGER_ADAPTER* adapterForProject( PROJECT& aProject ) const;

    virtual std::vector<wxString> getItemNames( LIBRARY_MANAGER_ADAPTER& aAdapter, const wxString& aNickname ) const;
 
private:
    LIBRARY_TABLE_TYPE m_type;

    KIWAY* m_kiway = nullptr;

    std::function<void( KIFACE* )> m_handlerRegisterCallback;
};
 
#endif //KICAD_API_HANDLER_LIBRARIES_H