Initial commit

backends/fs/n64/n64-fs-factory.cpp

@@ -0,0 +1,44 @@
+/* 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/>.
+ *
+ */
+
+#ifdef __N64__
+
+#include <n64utils.h>
+#include <romfs.h>
+
+#include "backends/fs/n64/n64-fs-factory.h"
+#include "backends/fs/n64/n64-fs.h"
+
+AbstractFSNode *N64FilesystemFactory::makeRootFileNode() const {
+	return new N64FilesystemNode();
+}
+
+AbstractFSNode *N64FilesystemFactory::makeCurrentDirectoryFileNode() const {
+	char buf[MAXPATHLEN];
+	return romfs_getcwd(buf, MAXPATHLEN) ? new N64FilesystemNode(Common::String(buf), false) : NULL;
+}
+
+AbstractFSNode *N64FilesystemFactory::makeFileNodePath(const Common::String &path) const {
+	assert(!path.empty());
+	return new N64FilesystemNode(path, false);
+}
+
+#endif

backends/fs/n64/n64-fs-factory.h

@@ -0,0 +1,38 @@
+/* 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 N64_FILESYSTEM_FACTORY_H
+#define N64_FILESYSTEM_FACTORY_H
+
+#include "backends/fs/fs-factory.h"
+
+/**
+ * Creates N64FilesystemNode objects.
+ *
+ * Parts of this class are documented in the base interface class, FilesystemFactory.
+ */
+class N64FilesystemFactory final : public FilesystemFactory {
+	AbstractFSNode *makeRootFileNode() const override;
+	AbstractFSNode *makeCurrentDirectoryFileNode() const override;
+	AbstractFSNode *makeFileNodePath(const Common::String &path) const override;
+};
+
+#endif /*N64_FILESYSTEM_FACTORY_H*/

backends/fs/n64/n64-fs.cpp

@@ -0,0 +1,167 @@
+/* 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/>.
+ *
+ */
+
+#ifdef __N64__
+
+#define FORBIDDEN_SYMBOL_EXCEPTION_unistd_h
+
+#include "backends/fs/n64/n64-fs.h"
+#include "backends/fs/n64/romfsstream.h"
+
+#include <romfs.h>
+#include <sys/param.h>
+#include <unistd.h>
+#include <n64utils.h>
+
+#define	ROOT_PATH	"/"
+
+N64FilesystemNode::N64FilesystemNode() {
+	_isDirectory = true;
+	_displayName = "Root";
+	_isValid = true;
+	_path = ROOT_PATH;
+}
+
+N64FilesystemNode::N64FilesystemNode(const Common::String &p, bool verify) {
+	assert(p.size() > 0);
+
+	_path = p;
+	_displayName = lastPathComponent(_path, '/');
+	_isValid = true;
+	_isDirectory = true;
+
+	// Check if it's a dir
+	ROMFILE *tmpfd = romfs_open(p.c_str(), "r");
+	if (tmpfd) {
+		_isDirectory = (tmpfd->type == 0 || tmpfd->type == 1);
+		romfs_close(tmpfd);
+	}
+}
+
+bool N64FilesystemNode::exists() const {
+	int ret = -1;
+
+	ret = romfs_access(_path.c_str(), F_OK);
+
+	return ret == 0;
+}
+
+bool N64FilesystemNode::isReadable() const {
+	int ret = -1;
+
+	ret = romfs_access(_path.c_str(), R_OK);
+
+	return ret == 0;
+}
+
+// We can't write on ROMFS!
+bool N64FilesystemNode::isWritable() const {
+	return false;
+}
+
+
+AbstractFSNode *N64FilesystemNode::getChild(const Common::String &n) const {
+	// FIXME: Pretty lame implementation! We do no error checking to speak
+	// of, do not check if this is a special node, etc.
+	assert(_isDirectory);
+
+	Common::String newPath(_path);
+	if (_path.lastChar() != '/')
+		newPath += '/';
+	newPath += n;
+
+	return new N64FilesystemNode(newPath, true);
+}
+
+bool N64FilesystemNode::getChildren(AbstractFSList &myList, ListMode mode, bool hidden) const {
+	assert(_isDirectory);
+	ROMDIR *dirp = romfs_opendir(_path.c_str());
+	romfs_dirent *dp;
+
+	if (dirp == NULL)
+		return false;
+
+	// loop over dir entries using readdir
+	while ((dp = romfs_readdir(dirp)) != NULL) {
+		// Skip 'invisible' files if necessary
+		if (dp->entryname[0] == '.' && !hidden) {
+			free(dp);
+			continue;
+		}
+		// Skip '.' and '..' to avoid cycles
+		if ((dp->entryname[0] == '.' && dp->entryname[1] == 0) || (dp->entryname[0] == '.' && dp->entryname[1] == '.')) {
+			free(dp);
+			continue;
+		}
+
+		// Start with a clone of this node, with the correct path set
+		N64FilesystemNode entry(*this);
+		entry._displayName = dp->entryname;
+		if (_path.lastChar() != '/')
+			entry._path += '/';
+		entry._path += entry._displayName;
+
+		// Force validity for now...
+		entry._isValid = 1;
+
+		entry._isDirectory = (dp->type == 0 || dp->type == 1);
+
+		// Honor the chosen mode
+		if ((mode == Common::FSNode::kListFilesOnly && entry._isDirectory) ||
+		        (mode == Common::FSNode::kListDirectoriesOnly && !entry._isDirectory)) {
+
+			free(dp);
+			continue;
+		}
+
+		myList.push_back(new N64FilesystemNode(entry));
+
+		free(dp);
+	}
+	romfs_closedir(dirp);
+
+	return true;
+}
+
+AbstractFSNode *N64FilesystemNode::getParent() const {
+	if (_path == ROOT_PATH)
+		return 0;
+
+	const char *start = _path.c_str();
+	const char *end = lastPathComponent(_path, '/');
+
+	return new N64FilesystemNode(Common::String(start, end - start), false);
+}
+
+Common::SeekableReadStream *N64FilesystemNode::createReadStream() {
+	return RomfsStream::makeFromPath(getPath(), false);
+}
+
+Common::SeekableWriteStream *N64FilesystemNode::createWriteStream(bool atomic) {
+	// TODO: Add atomic support if possible
+	return RomfsStream::makeFromPath(getPath(), true);
+}
+
+bool N64FilesystemNode::createDirectory() {
+	return _isValid && _isDirectory;
+}
+
+#endif //#ifdef __N64__

backends/fs/n64/n64-fs.h

@@ -0,0 +1,78 @@
+/* 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 N64_FILESYSTEM_H
+#define N64_FILESYSTEM_H
+
+#include "backends/fs/abstract-fs.h"
+
+/**
+ * Implementation of the ScummVM file system API based on N64 Hkz romfs.
+ *
+ * Parts of this class are documented in the base interface class, AbstractFSNode.
+ */
+class N64FilesystemNode final : public AbstractFSNode {
+protected:
+	Common::String _displayName;
+	Common::String _path;
+	bool _isDirectory;
+	bool _isValid;
+
+public:
+	/**
+	 * Creates a N64FilesystemNode with the root node as path.
+	 */
+	N64FilesystemNode();
+
+	/**
+	 * Creates a N64FilesystemNode for a given path.
+	 *
+	 * @param path Common::String with the path the new node should point to.
+	 * @param verify true if the isValid and isDirectory flags should be verified during the construction.
+	 */
+	N64FilesystemNode(const Common::String &p, bool verify = true);
+
+	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;
+	}
+	bool isDirectory() const override {
+		return _isDirectory;
+	}
+	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;
+};
+
+#endif

backends/fs/n64/romfsstream.cpp

@@ -0,0 +1,84 @@
+/* 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/>.
+ *
+ */
+
+#ifdef __N64__
+
+#include <romfs.h>
+#include "backends/fs/n64/romfsstream.h"
+
+RomfsStream::RomfsStream(void *handle) : _handle(handle) {
+	assert(handle);
+}
+
+RomfsStream::~RomfsStream() {
+	romfs_close((ROMFILE *)_handle);
+}
+
+bool RomfsStream::err() const {
+	return romfs_error((ROMFILE *)_handle) != 0;
+}
+
+void RomfsStream::clearErr() {
+	romfs_clearerr((ROMFILE *)_handle);
+}
+
+bool RomfsStream::eos() const {
+	return romfs_eof((ROMFILE *)_handle) != 0;
+}
+
+int64 RomfsStream::pos() const {
+	return romfs_tell((ROMFILE *)_handle);
+}
+
+int64 RomfsStream::size() const {
+	int64 oldPos = romfs_tell((ROMFILE *)_handle);
+	romfs_seek((ROMFILE *)_handle, 0, SEEK_END);
+	int64 length = romfs_tell((ROMFILE *)_handle);
+	romfs_seek((ROMFILE *)_handle, oldPos, SEEK_SET);
+
+	return length;
+}
+
+bool RomfsStream::seek(int64 offs, int whence) {
+	return romfs_seek((ROMFILE *)_handle, offs, whence) >= 0;
+}
+
+uint32 RomfsStream::read(void *ptr, uint32 len) {
+	return romfs_read((byte *)ptr, 1, len, (ROMFILE *)_handle);
+}
+
+uint32 RomfsStream::write(const void *ptr, uint32 len) {
+	return romfs_write(ptr, 1, len, (ROMFILE *)_handle);
+}
+
+bool RomfsStream::flush() {
+	return romfs_flush((ROMFILE *)_handle) == 0;
+}
+
+RomfsStream *RomfsStream::makeFromPath(const Common::String &path, bool writeMode) {
+	ROMFILE *handle = romfs_open(path.c_str(), writeMode ? "wb" : "rb");
+
+	if (handle)
+		return new RomfsStream(handle);
+	return 0;
+}
+
+#endif /* __N64__ */

backends/fs/n64/romfsstream.h

@@ -0,0 +1,58 @@
+/* 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 BACKENDS_FS_ROMFSSTREAM_H
+#define BACKENDS_FS_ROMFSSTREAM_H
+
+#include "common/scummsys.h"
+#include "common/noncopyable.h"
+#include "common/stream.h"
+#include "common/str.h"
+
+class RomfsStream final : public Common::SeekableReadStream, public Common::SeekableWriteStream, public Common::NonCopyable {
+protected:
+	/** File handle to the actual file. */
+	void *_handle;
+
+public:
+	/**
+	 * Given a path, invokes fopen on that path and wrap the result in a
+	 * RomfsStream instance.
+	 */
+	static RomfsStream *makeFromPath(const Common::String &path, bool writeMode);
+
+	RomfsStream(void *handle);
+	~RomfsStream() override;
+
+	bool err() const override;
+	void clearErr() override;
+	bool eos() const override;
+
+	uint32 write(const void *dataPtr, uint32 dataSize) override;
+	bool flush() override;
+
+	int64 pos() const override;
+	int64 size() const override;
+	bool seek(int64 offs, int whence = SEEK_SET) override;
+	uint32 read(void *dataPtr, uint32 dataSize) override;
+};
+
+#endif