api_handler_editor.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 Jon Evans <[email protected]>
 * Copyright The 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 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 KICAD_API_HANDLER_EDITOR_H
#define KICAD_API_HANDLER_EDITOR_H
 
#include <api/api_handler.h>
#include <api/common/commands/editor_commands.pb.h>
#include <base_units.h>
#include <commit.h>
#include <google/protobuf/empty.pb.h>
#include <kiid.h>
#include <page_info.h>
 
using namespace kiapi::common;
using kiapi::common::types::DocumentSpecifier;
using kiapi::common::types::ItemRequestStatus;
using kiapi::common::commands::ItemDeletionStatus;
 
class EDA_BASE_FRAME;
class TITLE_BLOCK;

class API_HANDLER_EDITOR : public API_HANDLER
{
public:
    API_HANDLER_EDITOR( EDA_BASE_FRAME* aFrame = nullptr );
 
protected:
    HANDLER_RESULT<std::optional<KIID>> validateItemHeaderDocument(
            const kiapi::common::types::ItemHeader& aHeader );
 
    HANDLER_RESULT<bool> validateDocument( const DocumentSpecifier& aDocument );

    virtual std::optional<ApiResponseStatus> checkForBusy();
 
    HANDLER_RESULT<commands::BeginCommitResponse> handleBeginCommit(
        const HANDLER_CONTEXT<commands::BeginCommit>& aCtx );
 
    HANDLER_RESULT<commands::EndCommitResponse> handleEndCommit(
        const HANDLER_CONTEXT<commands::EndCommit>& aCtx );
 
    COMMIT* getCurrentCommit( const std::string& aClientName );
 
    virtual void pushCurrentCommit( const std::string& aClientName, const wxString& aMessage );
 
    HANDLER_RESULT<commands::CreateItemsResponse> handleCreateItems(
        const HANDLER_CONTEXT<commands::CreateItems>& aCtx );
 
    HANDLER_RESULT<commands::UpdateItemsResponse> handleUpdateItems(
        const HANDLER_CONTEXT<commands::UpdateItems>& aCtx );
 
    HANDLER_RESULT<commands::DeleteItemsResponse> handleDeleteItems(
        const HANDLER_CONTEXT<commands::DeleteItems>& aCtx );
 
    HANDLER_RESULT<commands::HitTestResponse> handleHitTest(
        const HANDLER_CONTEXT<commands::HitTest>& aCtx );
 
    HANDLER_RESULT<types::TitleBlockInfo> handleGetTitleBlockInfo(
            const HANDLER_CONTEXT<commands::GetTitleBlockInfo>& aCtx );
 
    HANDLER_RESULT<google::protobuf::Empty> handleSetTitleBlockInfo(
            const HANDLER_CONTEXT<commands::SetTitleBlockInfo>& aCtx );
 
    HANDLER_RESULT<types::PageSettings> handleGetPageSettings(
            const HANDLER_CONTEXT<commands::GetPageSettings>& aCtx );
 
    HANDLER_RESULT<types::PageSettings> handleSetPageSettings(
            const HANDLER_CONTEXT<commands::SetPageSettings>& aCtx );

    virtual std::unique_ptr<COMMIT> createCommit() = 0;

    virtual types::DocumentType thisDocumentType() const = 0;

    virtual tl::expected<bool, ApiResponseStatus> validateDocumentInternal( const DocumentSpecifier& aDocument ) const = 0;

    virtual const EDA_IU_SCALE& getIuScale() const { return pcbIUScale; }
 
    virtual HANDLER_RESULT<ItemRequestStatus> handleCreateUpdateItemsInternal( bool aCreate,
        const std::string& aClientName,
        const types::ItemHeader &aHeader,
        const google::protobuf::RepeatedPtrField<google::protobuf::Any>& aItems,
        std::function<void( commands::ItemStatus, google::protobuf::Any )> aItemHandler ) = 0;
 
    virtual void deleteItemsInternal( std::map<KIID, ItemDeletionStatus>& aItemsToDelete,
                                      const std::string& aClientName ) = 0;
 
    virtual std::optional<EDA_ITEM*> getItemFromDocument( const DocumentSpecifier& aDocument,
                                                          const KIID& aId ) = 0;
 
    static std::vector<KICAD_T> parseRequestedItemTypes( const google::protobuf::RepeatedField<int>& aTypes );
 
    virtual std::optional<TITLE_BLOCK*> getTitleBlock() { return std::nullopt; }
 
    virtual std::optional<PAGE_INFO> getPageSettings() { return std::nullopt; }
 
    virtual bool setPageSettings( const PAGE_INFO& aPageInfo ) { return false; }
 
    virtual wxString getDrawingSheetFileName() { return wxEmptyString; }
 
    virtual void setDrawingSheetFileName( const wxString& aFileName ) {}
 
    virtual void onModified() {}
 
protected:
    std::map<std::string, std::pair<KIID, std::unique_ptr<COMMIT>>> m_commits;
 
    std::set<std::string> m_activeClients;
 
    EDA_BASE_FRAME* m_frame;
};
 
#endif //KICAD_API_HANDLER_EDITOR_H