/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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/>.
 *
 */

#ifndef LIBRETRO_FILESYSTEM_H
#define LIBRETRO_FILESYSTEM_H

#include "backends/fs/abstract-fs.h"

#ifdef MACOSX
#include <sys/types.h>
#endif
#include <unistd.h>

/**
 * Implementation of the ScummVM file system API based on LibRetro.
 *
 * Parts of this class are documented in the base interface class, AbstractFSNode.
 */
class LibRetroFilesystemNode : public AbstractFSNode {
protected:
	Common::String _displayName;
	Common::String _path;
	bool _isDirectory;
	bool _isValid;
	bool _isReadable;
	bool _isWritable;

	virtual AbstractFSNode *makeNode(const Common::String &path) const {
		return new LibRetroFilesystemNode(path);
	}

	/**
	 * Plain constructor, for internal use only (hence protected).
	 */
	LibRetroFilesystemNode() : _isDirectory(false), _isValid(false) {}

public:
	/**
	 * Creates a LibRetroFilesystemNode for a given path.
	 *
	 * @param path the path the new node should point to.
	 */
	LibRetroFilesystemNode(const Common::String &path);

	virtual bool exists() const {
		return access(_path.c_str(), F_OK) == 0;
	}
	virtual Common::U32String getDisplayName() const {
		return _displayName;
	}
	virtual Common::String getName() const {
		return _displayName;
	}
	virtual Common::String getPath() const {
		return _path;
	}
	virtual bool isDirectory() const {
		return _isDirectory && _isReadable;
	}
	virtual bool isReadable() const {
		return _isReadable;
	}
	virtual bool isWritable() const {
		return _isWritable;
	}

	virtual AbstractFSNode *getChild(const Common::String &n) const;
	virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const;
	virtual AbstractFSNode *getParent() const;

	virtual Common::SeekableReadStream *createReadStream();
	virtual Common::SeekableWriteStream *createWriteStream(bool atomic);
	virtual bool createDirectory();

	static Common::String getHomeDir(void);
private:
	/**
	 * Tests and sets the _isValid and _isDirectory flags, using the stat() function.
	 */
	virtual void setFlags();
};

#endif