Mercurial > fife-parpg
comparison 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 |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:4a0efb7baf70 |
---|---|
1 /*************************************************************************** | |
2 * Copyright (C) 2005-2008 by the FIFE team * | |
3 * http://www.fifengine.de * | |
4 * This file is part of FIFE. * | |
5 * * | |
6 * FIFE is free software; you can redistribute it and/or modify * | |
7 * it under the terms of the GNU General Public License as published by * | |
8 * the Free Software Foundation; either version 2 of the License, or * | |
9 * (at your option) any later version. * | |
10 * * | |
11 * This program is distributed in the hope that it will be useful, * | |
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of * | |
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * | |
14 * GNU General Public License for more details. * | |
15 * * | |
16 * You should have received a copy of the GNU General Public License * | |
17 * along with this program; if not, write to the * | |
18 * Free Software Foundation, Inc., * | |
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * | |
20 ***************************************************************************/ | |
21 | |
22 #ifndef FIFE_RESOURCE_LOCATION_H | |
23 #define FIFE_RESOURCE_LOCATION_H | |
24 | |
25 // Standard C++ library includes | |
26 #include <string> | |
27 | |
28 // 3rd party library includes | |
29 | |
30 // FIFE includes | |
31 // These includes are split up in two parts, separated by one empty line | |
32 // First block: files included from the FIFE root src directory | |
33 // Second block: files included from the same folder | |
34 | |
35 namespace FIFE { | |
36 | |
37 /** Contains information about the Location of a Resource | |
38 * | |
39 * This class is used to give ResoureProvider the information | |
40 * where to find the data. | |
41 */ | |
42 class ResourceLocation { | |
43 public: | |
44 | |
45 // LIFECYCLE | |
46 /** Default constructor. | |
47 */ | |
48 ResourceLocation(const std::string& filename): m_filename(filename) {} | |
49 | |
50 /** Destructor. | |
51 */ | |
52 virtual ~ResourceLocation() {}; | |
53 | |
54 /** Returns the filename. | |
55 * @return The filename. | |
56 */ | |
57 const std::string& getFilename() const { return m_filename; }; | |
58 | |
59 /** Compares two ResourceLocations for equality. | |
60 */ | |
61 virtual bool operator ==(const ResourceLocation& loc) const { | |
62 if (m_filename.length() != loc.m_filename.length()) { | |
63 return false; | |
64 } | |
65 if (!std::equal(m_filename.rbegin(), m_filename.rend(), loc.m_filename.rbegin())) { | |
66 return false; | |
67 } | |
68 return true; | |
69 } | |
70 | |
71 /** Compares two ResourceLocations | |
72 * This is needed as the locations should be stored in a \c std::map | |
73 */ | |
74 virtual bool operator <(const ResourceLocation& loc) const { | |
75 if (m_filename < loc.m_filename) { | |
76 return true; | |
77 } | |
78 if (m_filename != loc.m_filename) { | |
79 return false; | |
80 } | |
81 return true; | |
82 } | |
83 | |
84 /** Creates copy of this location | |
85 * All derived classes must implement this and return their corresponding instance | |
86 */ | |
87 virtual ResourceLocation* clone() const { | |
88 return new ResourceLocation(m_filename); | |
89 } | |
90 | |
91 private: | |
92 std::string m_filename; | |
93 }; | |
94 } //FIFE | |
95 | |
96 #endif |