diff engine/core/util/resource/resource_location.h @ 0:4a0efb7baf70

* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/engine/core/util/resource/resource_location.h	Sun Jun 29 18:44:17 2008 +0000
@@ -0,0 +1,96 @@
+/***************************************************************************
+ *   Copyright (C) 2005-2008 by the FIFE team                              *
+ *   http://www.fifengine.de                                               *
+ *   This file is part of FIFE.                                            *
+ *                                                                         *
+ *   FIFE 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 2 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, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA              *
+ ***************************************************************************/
+
+#ifndef FIFE_RESOURCE_LOCATION_H
+#define FIFE_RESOURCE_LOCATION_H
+
+// Standard C++ library includes
+#include <string>
+
+// 3rd party library includes
+
+// FIFE includes
+// These includes are split up in two parts, separated by one empty line
+// First block: files included from the FIFE root src directory
+// Second block: files included from the same folder
+
+namespace FIFE {
+
+	/** Contains information about the Location of a Resource
+	 *
+	 *  This class is used to give ResoureProvider the information
+	 *  where to find the data. 
+	 */
+	class ResourceLocation {
+	public:
+
+		// LIFECYCLE
+		/** Default constructor.
+		 */
+		ResourceLocation(const std::string& filename): m_filename(filename) {}
+
+		/** Destructor.
+		 */
+		virtual ~ResourceLocation() {};
+
+		/** Returns the filename.
+		 * @return The filename.
+		 */
+		const std::string& getFilename() const { return m_filename; };
+
+		/** Compares two ResourceLocations for equality.
+		 */
+		virtual bool operator ==(const ResourceLocation& loc) const {
+			if (m_filename.length() != loc.m_filename.length()) {
+				return false;
+			}
+			if (!std::equal(m_filename.rbegin(), m_filename.rend(), loc.m_filename.rbegin())) {
+				return false;
+			}
+			return true;
+		}
+
+		/** Compares two ResourceLocations
+		 *  This is needed as the locations should be stored in a \c std::map
+		 */
+		virtual bool operator <(const ResourceLocation& loc) const {
+			if (m_filename < loc.m_filename) {
+				return true;
+			}
+			if (m_filename != loc.m_filename) {
+				return false;
+			}
+			return true;
+		}
+
+		/** Creates copy of this location
+		 *  All derived classes must implement this and return their corresponding instance
+		 */
+		virtual ResourceLocation* clone() const {
+			return new ResourceLocation(m_filename);
+		}
+
+	private:
+		std::string m_filename;
+	};
+} //FIFE
+
+#endif