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) 2021 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              : #ifndef MUSE_WORKSPACE_IWORKSPACE_H
      23              : #define MUSE_WORKSPACE_IWORKSPACE_H
      24              : 
      25              : #include <memory>
      26              : #include <QByteArray>
      27              : 
      28              : #include "types/retval.h"
      29              : #include "workspacetypes.h"
      30              : #include "async/channel.h"
      31              : 
      32              : namespace muse::workspace {
      33              : class IWorkspace
      34              : {
      35              : public:
      36            4 :     virtual ~IWorkspace() = default;
      37              : 
      38              :     virtual std::string name() const = 0;
      39              : 
      40              :     virtual bool isBuiltin() const = 0;
      41              :     virtual bool isEdited() const = 0;
      42              :     virtual bool isNeedSave() const = 0;
      43              : 
      44              :     virtual RetVal<QByteArray> rawData(const DataKey& key) const = 0;
      45              :     virtual Ret setRawData(const DataKey& key, const QByteArray& data) = 0;
      46              : 
      47              :     virtual void reset() = 0;
      48              :     virtual void assignNewName(const std::string& newName) = 0;
      49              : 
      50              :     virtual async::Notification reloadNotification() = 0;
      51              : };
      52              : 
      53              : using IWorkspacePtr = std::shared_ptr<IWorkspace>;
      54              : using IWorkspacePtrList = std::vector<IWorkspacePtr>;
      55              : }
      56              : 
      57              : #endif // MUSE_WORKSPACE_IWORKSPACE_H