Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2024 MuseScore Limited and others
       9              :  *
      10              :  * This program is free software: you can redistribute it and/or modify
      11              :  * it under the terms of the GNU General Public License version 3 as
      12              :  * published by the Free Software Foundation.
      13              :  *
      14              :  * This program is distributed in the hope that it will be useful,
      15              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      16              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17              :  * GNU General Public License for more details.
      18              :  *
      19              :  * You should have received a copy of the GNU General Public License
      20              :  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
      21              :  */
      22              : #pragma once
      23              : 
      24              : #include <memory>
      25              : 
      26              : #include "modularity/imoduleinterface.h"
      27              : 
      28              : #include "global/types/ret.h"
      29              : #include "global/async/notification.h"
      30              : #include "global/async/channel.h"
      31              : 
      32              : #include "extensionstypes.h"
      33              : 
      34              : namespace muse::extensions {
      35              : class IExtensionSession;
      36              : 
      37              : class IExtensionsProvider : MODULE_CONTEXT_INTERFACE
      38              : {
      39            0 :     INTERFACE_ID(IExtensionsProvider)
      40              : public:
      41              : 
      42            0 :     virtual ~IExtensionsProvider() = default;
      43              : 
      44              :     virtual void reloadExtensions() = 0;
      45              :     virtual ManifestList manifestList(Filter filter = Filter::All) const = 0;
      46              :     virtual async::Notification manifestListChanged() const = 0;
      47              : 
      48              :     virtual bool exists(const ExtensionUri& uri) const = 0;
      49              :     virtual const Manifest& manifest(const ExtensionUri& uri) const = 0;
      50              : 
      51              :     virtual void setEnabled(const ExtensionUri& uri, bool enabled) = 0;
      52              :     virtual bool isEnabled(const ExtensionUri& uri) const = 0;
      53              :     virtual async::Channel<ExtensionUri> enabledChanged() const = 0;
      54              : 
      55              :     virtual Ret perform(const ExtensionUri& uri, const ExtensionActionCode& action) = 0;
      56              :     virtual async::Channel<ExtensionUri, ExtensionActionCode> dockRequested() const = 0;
      57              :     virtual Ret run(const ExtensionUri& uri, const ExtensionActionCode& action) = 0;
      58              : 
      59              :     virtual std::unique_ptr<IExtensionSession> newSession(const ExtensionUri& uri, const io::path_t& relativeScriptPath) const = 0;
      60              : };
      61              : }