api_server.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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_API_SERVER_H
#define KICAD_API_SERVER_H
 
#include <atomic>
#include <functional>
#include <memory>
#include <set>
#include <string>
 
#include <wx/event.h>
#include <wx/filename.h>
 
#include <kicommon.h>
#include <api/common/types/base_types.pb.h>
 
class API_HANDLER;
class KINNG_REQUEST_SERVER;
class wxEvtHandler;
 
 
wxDECLARE_EVENT( API_REQUEST_EVENT, wxCommandEvent );
 
 
class KICOMMON_API KICAD_API_SERVER : public wxEvtHandler
{
public:
    KICAD_API_SERVER( bool aAutoStart = true );
 
    ~KICAD_API_SERVER();
 
    void Start();
 
    void Stop();
 
    bool Running() const;

    void RegisterHandler( API_HANDLER* aHandler );
 
    void DeregisterHandler( API_HANDLER* aHandler );
 
    void SetReadyToReply( bool aReady = true )
    {
        m_readyToReply.store( aReady, std::memory_order_release );
    }
 
    void SetSocketPath( const wxString& aSocketPath )
    {
        m_socketPathOverride = aSocketPath;
    }
 
    std::string SocketPath() const;
 
    const std::string& Token() const { return m_token; }

    static wxFileName StandardSocketPath();

    static std::string StandardSocketUrl();

    void NotifyNetSettingsChanged();

    void NotifyDocumentRenamed( kiapi::common::types::DocumentType aType, const wxString& aOldPath,
                                const wxString& aNewPath );

    void SetRenameListener( std::function<void( kiapi::common::types::DocumentType,
                                                const wxString&, const wxString& )> aListener )
    {
        m_renameListener = std::move( aListener );
    }
 
private:

    void onApiRequest( std::string* aRequest );

    void handleApiEvent( wxCommandEvent& aEvent );
 
    void handleApiRequestString( std::string& aRequestString );
 
    void log( const std::string& aOutput );
 
    std::unique_ptr<KINNG_REQUEST_SERVER> m_server;
 
    std::set<API_HANDLER*> m_handlers;
 
    std::string m_token;
 
    std::atomic<bool> m_readyToReply;
 
    std::function<void( kiapi::common::types::DocumentType, const wxString&, const wxString& )> m_renameListener;
 
    wxString m_socketPathOverride;
 
    static wxString s_logFileName;
 
    wxFileName m_logFilePath;
};
 
#endif //KICAD_API_SERVER_H