implement DiskMountPoint

engine/core/filesystem/DiskMountPoint.cpp

@@ -0,0 +1,166 @@
+/*
+Copyright (c) 2013 Daniele Bartolini, Michele Rossi
+Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#include "DiskMountPoint.h"
+#include "Assert.h"
+#include "DiskFile.h"
+#include "StringUtils.h"
+
+namespace crown
+{
+
+//-----------------------------------------------------------------------------
+DiskMountPoint::DiskMountPoint(const char* root_path) :
+	MountPoint(DISK_TYPE)
+{
+	CE_ASSERT(root_path != NULL, "Root path must be != NULL");
+	CE_ASSERT(os::is_absolute_path(root_path), "Root path must be absolute");
+
+	string::strncpy(m_root_path, root_path, MAX_PATH_LENGTH);
+}
+
+//-----------------------------------------------------------------------------
+File* DiskMountPoint::open(const char* relative_path, FileOpenMode mode)
+{
+	CE_ASSERT(exists(relative_path), "File does not exist: %s", relative_path);
+	CE_ASSERT(is_file(relative_path), "File is not a regular file: %s", relative_path);
+
+	return CE_NEW(m_allocator, DiskFile)(mode, os_path(relative_path));
+}
+
+//-----------------------------------------------------------------------------
+void DiskMountPoint::close(File* file)
+{
+	CE_DELETE(m_allocator, file);
+}
+
+//-----------------------------------------------------------------------------
+const char*	DiskMountPoint::root_path() const
+{
+	return m_root_path;
+}
+
+//-----------------------------------------------------------------------------
+bool DiskMountPoint::exists(const char* relative_path)
+{
+	MountPointEntry info;
+
+	return get_info(relative_path, info);	
+}
+//-----------------------------------------------------------------------------
+bool DiskMountPoint::get_info(const char* relative_path, MountPointEntry& info)
+{
+	// Entering OS-DEPENDENT-PATH-MODE
+	// (i.e. os_path is of the form: C:\foo\relative_path or /foo/relative_path)
+
+	const char* os_path = build_os_path(m_root_path, relative_path);
+
+	string::strncpy(info.os_path, os_path, MAX_PATH_LENGTH);
+	string::strncpy(info.relative_path, relative_path, MAX_PATH_LENGTH);
+
+	if (os::is_reg(os_path))
+	{
+		info.type = MountPointEntry::FILE;
+		return true;
+	}
+	else if (os::is_dir(os_path))
+	{
+		info.type = MountPointEntry::DIRECTORY;
+		return true;
+	}
+	
+	info.type = MountPointEntry::UNKNOWN;
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+bool DiskMountPoint::is_file(const char* relative_path)
+{
+	MountPointEntry info;
+
+	if (get_info(relative_path, info))
+	{
+		return info.type == MountPointEntry::FILE;
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+bool DiskMountPoint::is_dir(const char* relative_path)
+{
+	MountPointEntry info;
+
+	if (get_info(relative_path, info))
+	{
+		return info.type == MountPointEntry::DIRECTORY;
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+const char* DiskMountPoint::os_path(const char* relative_path)
+{
+	static char os_path[MAX_PATH_LENGTH];
+
+	MountPointEntry entry;
+
+	get_info(relative_path, entry);
+
+	string::strncpy(os_path, entry.os_path, MAX_PATH_LENGTH);
+
+	return os_path;
+}
+
+//-----------------------------------------------------------------------------
+const char* DiskMountPoint::build_os_path(const char* base_path, const char* relative_path)
+{
+	static char os_path[MAX_PATH_LENGTH];
+
+	string::strncpy(os_path, base_path, MAX_PATH_LENGTH);
+
+	size_t base_path_len = string::strlen(base_path);
+
+	os_path[base_path_len] = PATH_SEPARATOR;
+	os_path[base_path_len + 1] = '\0';
+
+	string::strcat(os_path, relative_path);
+
+	// FIXME FIXME FIXME Replace Crown-specific path separator with OS-specific one
+	for (size_t j = 0; j < string::strlen(os_path); j++)
+	{
+		if (os_path[j] == '/')
+		{
+			os_path[j] = PATH_SEPARATOR;
+		}
+	}
+
+	return os_path;
+}
+
+} // namespace crown

engine/core/filesystem/DiskMountPoint.h

@@ -0,0 +1,77 @@
+/*
+Copyright (c) 2013 Daniele Bartolini, Michele Rossi
+Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#pragma once
+
+#include "MountPoint.h"
+#include "HeapAllocator.h"
+
+namespace crown
+{
+
+class DiskMountPoint : public MountPoint
+{
+public:
+						DiskMountPoint(const char* root_path);
+
+	File*				open(const char* relative_path, FileOpenMode mode);
+
+	void				close(File* file);
+
+	/// Returns the root path of the mount point
+	const char*			root_path() const;
+
+	bool				exists(const char* relative_path);
+
+	/// Returns whether the @a relative_path exists and fills @a info with
+	/// with informations about the given @a relative_path path
+	bool				get_info(const char* relative_path, MountPointEntry& info);
+	
+	/// Returns whether @a relative_path is a regular file
+	bool				is_file(const char* relative_path);
+
+	/// Returns whether @a relative_path is a directory
+	bool				is_dir(const char* relative_path);
+
+	/// Returns the os-specific path which @a relative_path refers to.
+	/// @note
+	/// In general, you typically do not want to use it for normal
+	/// file interactions. Prefer using the other methods whenever possible.
+	const char*			os_path(const char* relative_path);
+
+protected:
+
+	// Builds the OS-dependent path from base_path and relative_path
+	const char*			build_os_path(const char* base_path, const char* relative_path);
+
+protected:
+
+	HeapAllocator		m_allocator;
+
+	char				m_root_path[MAX_PATH_LENGTH];
+};
+
+} // namespace crown