IFileSystem.h

/*
 * This file is part of Adblock Plus <https://adblockplus.org/>,
 * Copyright (C) 2006-present eyeo GmbH
 *
 * Adblock Plus is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * Adblock Plus is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ADBLOCK_PLUS_IFILE_SYSTEM_H
#define ADBLOCK_PLUS_IFILE_SYSTEM_H

#include <istream>
#include <cstdint>
#include <string>
#include <memory>
#include <vector>
#include <functional>

namespace AdblockPlus
{
  class IFileSystem
  {
  public:
    struct StatResult
    {
      StatResult()
      {
        exists = false;
        lastModified = 0;
      }

      bool exists;

      int64_t lastModified;
    };

    virtual ~IFileSystem() {}

    typedef std::vector<uint8_t> IOBuffer;

    typedef std::function<void(const std::string&)> Callback;

    typedef std::function<void(IOBuffer&&)> ReadCallback;

    virtual void Read(const std::string& fileName,
                      const ReadCallback& doneCallback,
                      const Callback& errorCallback) const = 0;

    virtual void Write(const std::string& fileName,
                       const IOBuffer& data,
                       const Callback& callback) = 0;

    virtual void Move(const std::string& fromFileName, const std::string& toFileName,
                      const Callback& callback) = 0;

    virtual void Remove(const std::string& fileName, const Callback& callback) = 0;

    typedef std::function<void(const StatResult&, const std::string&)> StatCallback;

    virtual void Stat(const std::string& fileName,
                      const StatCallback& callback) const = 0;
  };

  typedef std::unique_ptr<IFileSystem> FileSystemPtr;
}

#endif