/* 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 KOLIBRIOS_FS_H
#define KOLIBRIOS_FS_H

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

/**
 * Implementation of the ScummVM file system API based on KolibriOS.
 *
 * Parts of this class are documented in the base interface class, AbstractFSNode.
 */
class KolibriOSFilesystemNode : public AbstractFSNode {
public:
	/**
	 * Creates a KolibriOSFilesystemNode for a given path.
	 *
	 * @param path the path the new node should point to.
	 */
	KolibriOSFilesystemNode(const Common::String &path);

	bool exists() const override;
	Common::U32String getDisplayName() const override { return _displayName; }
	Common::String getName() const override { return _displayName; }
	Common::String getPath() const override { return _path; }
	static bool isDirectory(uint32 attrs) { return attrs & 0x18; }
	bool isDirectory() const override { return isDirectory(_attributes); }
	bool isReadable() const override;
	bool isWritable() const override;

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

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

protected:
	Common::String _displayName;
	Common::String _path;
	uint32 _attributes;
	bool _isValid;

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

	/**
	 * Plain constructor, for internal use only (hence protected).
	 */
	KolibriOSFilesystemNode() : _attributes(0), _isValid(false) {}

	/**
	 * Tests and sets the _isValid and _isDirectory flags, using the stat() function.
	 */
	virtual void setFlags();
};

namespace KolibriOS {

/**
 * Assure that a directory path exists.
 *
 * @param dir The path which is required to exist.
 * @param prefix An (optional) prefix which should not be created if non existent.
 *               prefix is prepended to dir if supplied.
 * @return true in case the directory exists (or was created), false otherwise.
 */
bool assureDirectoryExists(const Common::String &dir, const char *prefix = nullptr);

} // End of namespace KolibriOS

#endif