1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2024 Jon Evans <jon@craftyjon.com>
* 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 <commit.h>
#include <kiid.h>
using namespace kiapi::common;
using kiapi::common::types::DocumentSpecifier;
using kiapi::common::types::ItemRequestStatus;
using kiapi::common::commands::ItemDeletionStatus;
class EDA_BASE_FRAME;
/**
* Base class for API handlers related to editor frames
*/
class API_HANDLER_EDITOR : public API_HANDLER
{
public:
API_HANDLER_EDITOR( EDA_BASE_FRAME* aFrame = nullptr );
protected:
/// If the header is valid, returns the item container
HANDLER_RESULT<std::optional<KIID>> validateItemHeaderDocument(
const kiapi::common::types::ItemHeader& aHeader );
HANDLER_RESULT<bool> validateDocument( const DocumentSpecifier& aDocument );
/**
* Checks if the editor can accept commands
* @return an error status if busy, std::nullopt if not busy
*/
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 );
/**
* Override this to create an appropriate COMMIT subclass for the frame in question
* @return a new COMMIT, bound to the editor frame
*/
virtual std::unique_ptr<COMMIT> createCommit() = 0;
/**
* Override this to specify which document type this editor handles
*/
virtual types::DocumentType thisDocumentType() const = 0;
/**
* @return true if the given document is valid for this editor and is currently open
*/
virtual bool validateDocumentInternal( const DocumentSpecifier& aDocument ) const = 0;
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;
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
|
