fsCODRFileUtils.h

Go to the documentation of this file.

/********************************************************************
 * File: fsCODRFileUtils.h
 * Purpose: Extension of file utils for the iOS ODR system
 ********************************************************************/
 
#ifndef FS_CODR_FILE_UTILS_H
#define FS_CODR_FILE_UTILS_H
 
// Use more specific includes to avoid namespace conflicts
#include <fsCore/fsBaseTypes.h>
#include "axmol.h"
#include <mutex>
#include <unordered_map>
 
 
// Forward declare Objective-C classes
#ifdef __OBJC__
@class NSBundleResourceRequest;
@class NSObject;
@class NSData;
@class NSBundle;
#else
typedef struct objc_object NSBundleResourceRequest;
typedef struct objc_object NSObject;
typedef struct objc_object NSData;
typedef struct objc_object NSBundle;
#endif
 
#include <platform/apple/FileUtils-apple.h>
 
class fsCODRFileUtils : public ax::FileUtilsApple {
public:
    static void install();
    
    virtual bool init() override;
    bool checkODRAvailability(std::string_view filename) const;
    void preloadResource(std::string_view filename,
                        const std::function<void(bool)>& callback);
    void cancelDownload(std::string_view filename);
    
    // Required pure virtual overrides from FileUtils
    virtual std::string getWritablePath() const override;
    virtual std::string getNativeWritableAbsolutePath() const override;
    virtual bool isFileExistInternal(std::string_view filename) const override;
 
    // FileUtils overrides for ODR functionality
    virtual FileUtils::Status getContents(std::string_view filename,
                                        ax::ResizableBuffer* buffer) const override;
    virtual std::string getStringFromFile(std::string_view filename) const override;
    virtual ax::Data getDataFromFile(std::string_view filename) const override;
    virtual bool writeStringToFile(std::string_view dataStr,
                                 std::string_view fullPath) const override;
    virtual bool writeDataToFile(const ax::Data& data,
                               std::string_view fullPath) const override;
    virtual bool writeValueMapToFile(const ax::ValueMap& dict,
                                   std::string_view fullPath) const override;
    virtual bool writeValueVectorToFile(const ax::ValueVector& vecData,
                                      std::string_view fullPath) const override;
    virtual bool isFileExist(std::string_view filename) const override;
    virtual bool isDirectoryExist(std::string_view dirPath) const override;
    virtual bool isAbsolutePath(std::string_view path) const override;
    std::string fullPathForFilename(std::string_view filename) const override;
    std::unique_ptr<ax::IFileStream> openFileStream(std::string_view filePath, ax::IFileStream::Mode mode) const override;
 
protected:
    fsCODRFileUtils();
    virtual ~fsCODRFileUtils();
 
private:
    struct ODRStatus {
        bool isDownloading{false};
        bool isDownloaded{false};
        NSBundleResourceRequest* request{nullptr};
    };
 
    mutable std::mutex _statusMutex;
    mutable std::unordered_map<std::string, ODRStatus> _odrResourceStatus;
    NSObject* _progressDelegate{nullptr};
    
    int extractChapterNumber(const std::string& path) const;
    std::string getODRTagForChapter(int chapterNum) const;
    bool waitForResource(std::string_view filename, float timeoutSeconds);
    std::string getODRPath(std::string_view filename) const;
 
    fsCODRFileUtils::ODRStatus& ODRStatusGet(const std::string& tagName) const;
    bool beginAccessingResources(const std::string& tagName) const;
    void endAccessingResources(const std::string& tagName) const;
    bool fileExistsInODR(const std::string& filename) const;
    std::vector<uint8_t> getFileData(const std::string& filename) const;
 
};
 
#endif // FS_CODR_FILE_UTILS_H