Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-CLA-applies
       4              :  *
       5              :  * MuseScore
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2026 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 "modularity/imoduleinterface.h"
      25              : 
      26              : #include "global/types/ret.h"
      27              : 
      28              : #include "audiopluginstypes.h"
      29              : 
      30              : namespace muse::audioplugins {
      31              : /**
      32              :  * @brief Crash guard for in-process plugin loading.
      33              :  *
      34              :  * @details A plugin that passed validation may still bring the whole application down
      35              :  * when loaded later (e.g. after a licensing state change). Callers bracket
      36              :  * each in-process load with beginLoad()/endLoad(): beginLoad() persists the
      37              :  * plugin id to disk and endLoad() removes it once the load call has returned.
      38              :  * If the application dies in between, the id is still on disk at the next
      39              :  * launch and is reported by danglingLoads(), so the plugin can be marked as
      40              :  * broken instead of crashing the application again.
      41              :  */
      42              : class IAudioPluginsLoadGuard : MODULE_GLOBAL_INTERFACE
      43              : {
      44            0 :     INTERFACE_ID(IAudioPluginsLoadGuard)
      45              : 
      46              : public:
      47           21 :     virtual ~IAudioPluginsLoadGuard() = default;
      48              : 
      49              :     virtual Ret beginLoad(const PluginResourceId& resourceId) = 0;
      50              :     virtual void endLoad(const PluginResourceId& resourceId) = 0;
      51              : 
      52              :     //! Ids whose load never completed in a previous run
      53              :     virtual PluginResourceIdList danglingLoads() const = 0;
      54              :     virtual Ret clearDanglingLoads() = 0;
      55              : };
      56              : }