Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-Studio-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2022 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              : 
      23              : #pragma once
      24              : 
      25              : #include "modularity/imoduleinterface.h"
      26              : #include "async/notification.h"
      27              : #include "async/promise.h"
      28              : #include "io/path.h"
      29              : #include "rcommand/commandtypes.h"
      30              : #include "types/ret.h"
      31              : #include "types/uri.h"
      32              : 
      33              : #include "types/projecttypes.h"
      34              : #include "types/projectfile.h"
      35              : 
      36              : namespace mu::project {
      37              : class IOpenProjectScenario : MODULE_CONTEXT_INTERFACE
      38              : {
      39            0 :     INTERFACE_ID(IOpenProjectScenario)
      40              : 
      41              : public:
      42          112 :     virtual ~IOpenProjectScenario() = default;
      43              : 
      44              :     virtual bool isUrlSupported(const QUrl& url) const = 0;
      45              :     virtual bool isFileSupported(const muse::io::path_t& path) const = 0;
      46              : 
      47              :     virtual muse::async::Promise<muse::Ret> openProject(const ProjectFile& file) = 0;
      48              :     virtual muse::async::Promise<muse::Ret> openProject(const muse::io::path_t& path, const QString& displayNameOverride = QString()) = 0;
      49              :     virtual muse::async::Promise<muse::Ret> openProject(const muse::rcommand::Params& params) = 0;
      50              : 
      51              :     virtual muse::async::Promise<muse::Ret> revertToLastSaved() = 0;
      52              : 
      53              :     virtual muse::Ret finishOpening() = 0;
      54              : 
      55              :     //! The page to show the currently opened project on: the normal notation page,
      56              :     //! or the review page if it's a converted score still awaiting a quality review
      57              :     virtual muse::Uri resolveNotationPageUri() const = 0;
      58              : 
      59              :     virtual const ProjectBeingDownloaded& projectBeingDownloaded() const = 0;
      60              :     virtual muse::async::Notification projectBeingDownloadedChanged() const = 0;
      61              : 
      62              :     virtual bool isBusy(BusyStatus status) const = 0;
      63              :     virtual muse::async::Notification busyChanged() const = 0;
      64              : };
      65              : }