api_handler_common.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_API_HANDLER_COMMON_H
#define KICAD_API_HANDLER_COMMON_H
 
#include <functional>
 
#include <google/protobuf/empty.pb.h>
 
#include <api/api_handler.h>
#include <api/common/commands/base_commands.pb.h>
#include <api/common/commands/project_commands.pb.h>
 
using namespace kiapi::common;
using kiapi::common::types::ProjectSpecifier;
using google::protobuf::Empty;
 
class API_HANDLER_COMMON : public API_HANDLER
{
public:
    using OPEN_DOCUMENT_HANDLER = std::function<HANDLER_RESULT<commands::OpenDocumentResponse>(
            const commands::OpenDocument& )>;
    using CREATE_DOCUMENT_HANDLER = std::function<HANDLER_RESULT<commands::OpenDocumentResponse>(
            const commands::CreateDocument& )>;
    using CLOSE_DOCUMENT_HANDLER = std::function<HANDLER_RESULT<Empty>(
            const commands::CloseDocument& )>;
    using CLOSE_ALL_DOCUMENTS_HANDLER = std::function<HANDLER_RESULT<Empty>(
            const commands::CloseAllDocuments& )>;
 
 
    API_HANDLER_COMMON();
 
    ~API_HANDLER_COMMON() override {}
 
    void SetOpenDocumentHandler( OPEN_DOCUMENT_HANDLER aHandler )
    {
        m_openDocumentHandler = std::move( aHandler );
    }
 
    void SetCloseDocumentHandler( CLOSE_DOCUMENT_HANDLER aHandler )
    {
        m_closeDocumentHandler = std::move( aHandler );
    }
 
    void SetCloseAllDocumentsHandler( CLOSE_ALL_DOCUMENTS_HANDLER aHandler )
    {
        m_closeAllDocumentsHandler = std::move( aHandler );
    }
 
    void SetCreateDocumentHandler( CREATE_DOCUMENT_HANDLER aHandler )
    {
        m_createDocumentHandler = std::move( aHandler );
    }
 
private:
    HANDLER_RESULT<commands::GetVersionResponse> handleGetVersion(
        const HANDLER_CONTEXT<commands::GetVersion>& aCtx );
 
    HANDLER_RESULT<commands::PathResponse> handleGetKiCadBinaryPath(
        const HANDLER_CONTEXT<commands::GetKiCadBinaryPath>& aCtx );
 
    HANDLER_RESULT<commands::GetPathsResponse> handleGetPaths(
        const HANDLER_CONTEXT<commands::GetPaths>& aCtx );
 
    HANDLER_RESULT<commands::NetClassesResponse> handleGetNetClasses(
        const HANDLER_CONTEXT<commands::GetNetClasses>& aCtx );
 
    HANDLER_RESULT<Empty> handleSetNetClasses(
        const HANDLER_CONTEXT<commands::SetNetClasses>& aCtx );
 
    HANDLER_RESULT<commands::NetClassAssignmentsResponse> handleGetNetClassAssignments(
        const HANDLER_CONTEXT<commands::GetNetClassAssignments>& aCtx );
 
    HANDLER_RESULT<Empty> handleSetNetClassAssignments(
        const HANDLER_CONTEXT<commands::SetNetClassAssignments>& aCtx );
 
    HANDLER_RESULT<Empty> handlePing( const HANDLER_CONTEXT<commands::Ping>& aCtx );
 
    HANDLER_RESULT<types::Box2> handleGetTextExtents(
        const HANDLER_CONTEXT<commands::GetTextExtents>& aCtx );
 
    HANDLER_RESULT<commands::GetTextAsShapesResponse> handleGetTextAsShapes(
        const HANDLER_CONTEXT<commands::GetTextAsShapes>& aCtx );
 
    HANDLER_RESULT<commands::ExpandTextVariablesResponse> handleExpandTextVariables(
        const HANDLER_CONTEXT<commands::ExpandTextVariables>& aCtx );
 
    HANDLER_RESULT<commands::StringResponse> handleGetPluginSettingsPath(
        const HANDLER_CONTEXT<commands::GetPluginSettingsPath>& aCtx );
 
    HANDLER_RESULT<project::TextVariables> handleGetTextVariables(
        const HANDLER_CONTEXT<commands::GetTextVariables>& aCtx );
 
    HANDLER_RESULT<Empty> handleSetTextVariables(
        const HANDLER_CONTEXT<commands::SetTextVariables>& aCtx );
 
    HANDLER_RESULT<commands::OpenDocumentResponse> handleOpenDocument(
        const HANDLER_CONTEXT<commands::OpenDocument>& aCtx );
 
    HANDLER_RESULT<commands::OpenDocumentResponse> handleCreateDocument(
        const HANDLER_CONTEXT<commands::CreateDocument>& aCtx );
 
    HANDLER_RESULT<Empty> handleCloseDocument(
        const HANDLER_CONTEXT<commands::CloseDocument>& aCtx );
 
    HANDLER_RESULT<Empty> handleCloseAllDocuments(
        const HANDLER_CONTEXT<commands::CloseAllDocuments>& aCtx );
 
private:
    static tl::expected<bool, ApiResponseStatus> validateProject( const ProjectSpecifier& aProject,
                                                                  bool aAllowEmpty = false );
 
    OPEN_DOCUMENT_HANDLER m_openDocumentHandler;
    CLOSE_ALL_DOCUMENTS_HANDLER m_closeAllDocumentsHandler;
    CLOSE_DOCUMENT_HANDLER m_closeDocumentHandler;
    CREATE_DOCUMENT_HANDLER m_createDocumentHandler;
};
 
#endif //KICAD_API_HANDLER_COMMON_H