File FileSystem.h¶

// Copyright (c) 2021-present Sparky Studios. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#ifndef _AM_IO_FILESYSTEM_H
#define _AM_IO_FILESYSTEM_H

#include <SparkyStudios/Audio/Amplitude/IO/File.h>

#include <memory>
#include <vector>

namespace SparkyStudios::Audio::Amplitude
{
    class AM_API_PUBLIC FileSystem
    {
    public:
        virtual ~FileSystem() = default;

        virtual void SetBasePath(const AmOsString& basePath) = 0;

        [[nodiscard]] virtual const AmOsString& GetBasePath() const = 0;

        [[nodiscard]] virtual AmOsString ResolvePath(const AmOsString& path) const = 0;

        [[nodiscard]] virtual bool Exists(const AmOsString& path) const = 0;

        [[nodiscard]] virtual bool IsDirectory(const AmOsString& path) const = 0;

        [[nodiscard]] virtual AmOsString Join(const std::vector<AmOsString>& parts) const = 0;

        [[nodiscard]] virtual std::shared_ptr<File> OpenFile(const AmOsString& path, eFileOpenMode mode = eFileOpenMode_Read) const = 0;

        virtual void StartOpenFileSystem() = 0;

        virtual bool TryFinalizeOpenFileSystem() = 0;

        virtual void StartCloseFileSystem() = 0;

        virtual bool TryFinalizeCloseFileSystem() = 0;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_IO_FILESYSTEM_H