/*
   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/*
  ArduPilot filesystem backend interface.
 */
#pragma once

#include <stdint.h>
#include <AP_HAL/AP_HAL_Boards.h>

#include "AP_Filesystem_Available.h"

#if HAVE_FILESYSTEM_SUPPORT
class AP_Filesystem_Backend {

public:
    // functions that closely match the equivalent posix calls
    virtual int open(const char *fname, int flags) = 0;
    virtual int close(int fd) = 0;
    virtual ssize_t read(int fd, void *buf, size_t count) = 0;
    virtual ssize_t write(int fd, const void *buf, size_t count) = 0;
    virtual int fsync(int fd) = 0;
    virtual off_t lseek(int fd, off_t offset, int whence) = 0;
    virtual int stat(const char *pathname, struct stat *stbuf) = 0;
    virtual int unlink(const char *pathname) = 0;
    virtual int mkdir(const char *pathname) = 0;
    virtual void *opendir(const char *pathname) = 0;
    virtual struct dirent *readdir(void *dirp) = 0;
    virtual int closedir(void *dirp) = 0;

    // return free disk space in bytes, -1 on error
    virtual int64_t disk_free(const char *path) = 0;

    // return total disk space in bytes, -1 on error
    virtual int64_t disk_space(const char *path) = 0;

    // set modification time on a file
    virtual bool set_mtime(const char *filename, const time_t mtime_sec) = 0;
};

#endif // HAVE_FILESYSTEM_SUPPORT