1 | /* |
---|
2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
3 | * > www.orxonox.net < |
---|
4 | * |
---|
5 | * |
---|
6 | * License notice: |
---|
7 | * |
---|
8 | * This program is free software; you can redistribute it and/or |
---|
9 | * modify it under the terms of the GNU General Public License |
---|
10 | * as published by the Free Software Foundation; either version 2 |
---|
11 | * of the License, or (at your option) any later version. |
---|
12 | * |
---|
13 | * This program is distributed in the hope that it will be useful, |
---|
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
16 | * GNU General Public License for more details. |
---|
17 | * |
---|
18 | * You should have received a copy of the GNU General Public License |
---|
19 | * along with this program; if not, write to the Free Software |
---|
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
21 | * |
---|
22 | * Author: |
---|
23 | * Damian 'Mozork' Frick |
---|
24 | * Co-authors: |
---|
25 | * ... |
---|
26 | * |
---|
27 | */ |
---|
28 | |
---|
29 | #include "LevelInfo.h" |
---|
30 | |
---|
31 | #include <sstream> |
---|
32 | #include <vector> |
---|
33 | |
---|
34 | #include "util/SubString.h" |
---|
35 | #include "core/CoreIncludes.h" |
---|
36 | #include "core/XMLPort.h" |
---|
37 | |
---|
38 | #include "LevelManager.h" |
---|
39 | |
---|
40 | namespace orxonox |
---|
41 | { |
---|
42 | |
---|
43 | // LevelInfoItem |
---|
44 | |
---|
45 | //! The list of allowed tags. |
---|
46 | /*static*/ std::set<std::string> LevelInfoItem::possibleTags_s = std::set<std::string>(); |
---|
47 | |
---|
48 | /** |
---|
49 | @brief |
---|
50 | Default constructor. |
---|
51 | */ |
---|
52 | LevelInfoItem::LevelInfoItem() |
---|
53 | { |
---|
54 | |
---|
55 | } |
---|
56 | |
---|
57 | /** |
---|
58 | @brief |
---|
59 | Constructor. Initializes the object. |
---|
60 | @param name |
---|
61 | The name of the Level. |
---|
62 | @param filename |
---|
63 | The XML-filename of the Level. |
---|
64 | */ |
---|
65 | LevelInfoItem::LevelInfoItem(const std::string& name, const std::string filename) |
---|
66 | { |
---|
67 | this->setName(name); |
---|
68 | this->setXMLFilename(filename); |
---|
69 | } |
---|
70 | |
---|
71 | /** |
---|
72 | @brief |
---|
73 | Destructor. |
---|
74 | */ |
---|
75 | LevelInfoItem::~LevelInfoItem() |
---|
76 | { |
---|
77 | |
---|
78 | } |
---|
79 | |
---|
80 | /** |
---|
81 | @brief |
---|
82 | Initialize the set of allowed tags. |
---|
83 | */ |
---|
84 | /*static*/ void LevelInfoItem::initializeTags(void) |
---|
85 | { |
---|
86 | if(!LevelInfoItem::initialized_s) |
---|
87 | { |
---|
88 | LevelInfoItem::possibleTags_s.insert("test"); |
---|
89 | LevelInfoItem::possibleTags_s.insert("singleplayer"); |
---|
90 | LevelInfoItem::possibleTags_s.insert("multiplayer"); |
---|
91 | LevelInfoItem::possibleTags_s.insert("showcase"); |
---|
92 | LevelInfoItem::possibleTags_s.insert("tutorial"); |
---|
93 | LevelInfoItem::possibleTags_s.insert("presentation"); |
---|
94 | } |
---|
95 | } |
---|
96 | |
---|
97 | /** |
---|
98 | @brief |
---|
99 | Set the tags the Level is tagged with. |
---|
100 | @param tags |
---|
101 | A comma-seperated string of all the tags to be set. |
---|
102 | */ |
---|
103 | void LevelInfoItem::setTags(const std::string& tags) |
---|
104 | { |
---|
105 | SubString substr = SubString(tags, ",", " "); // Split the string into tags. |
---|
106 | const std::vector<std::string>& strings = substr.getAllStrings(); |
---|
107 | for(std::vector<std::string>::const_iterator it = strings.begin(); it != strings.end(); it++) |
---|
108 | this->addTag(*it, false); |
---|
109 | |
---|
110 | this->tagsUpdated(); |
---|
111 | } |
---|
112 | |
---|
113 | /** |
---|
114 | @brief |
---|
115 | Add a tag to the set of tags the Level is tagged with. |
---|
116 | @param tag |
---|
117 | The tag to be added. |
---|
118 | @param update |
---|
119 | Whether the comma-seperated string of all tags should be updated. Default is true. |
---|
120 | @return |
---|
121 | Returns true if the tag was successfully added, if the tag was already present it returns false. |
---|
122 | */ |
---|
123 | bool LevelInfoItem::addTag(const std::string& tag, bool update) |
---|
124 | { |
---|
125 | if(!this->validateTag(tag)) |
---|
126 | { |
---|
127 | COUT(2) << "Bad LevelInfo tag '" << tag << "' in " << this->getXMLFilename() << ". Ignoring..." << std::endl; |
---|
128 | return false; |
---|
129 | } |
---|
130 | bool success = this->tags_.insert(*LevelInfoItem::possibleTags_s.find(tag)).second; |
---|
131 | if(update && success) |
---|
132 | this->tagsUpdated(); |
---|
133 | return success; |
---|
134 | } |
---|
135 | |
---|
136 | /** |
---|
137 | @brief |
---|
138 | Updates the comma-seperated string of all tags, if the set of tags has changed. |
---|
139 | */ |
---|
140 | void LevelInfoItem::tagsUpdated(void) |
---|
141 | { |
---|
142 | std::stringstream stream; |
---|
143 | std::set<std::string>::iterator temp; |
---|
144 | for(std::set<std::string>::iterator it = this->tags_.begin(); it != this->tags_.end(); ) |
---|
145 | { |
---|
146 | temp = it; |
---|
147 | if(++it == this->tags_.end()) // If this is the last tag we don't add a comma. |
---|
148 | stream << *temp; |
---|
149 | else |
---|
150 | stream << *temp << ", "; |
---|
151 | } |
---|
152 | |
---|
153 | this->tagsString_ = std::string(stream.str()); |
---|
154 | } |
---|
155 | |
---|
156 | // LevelInfo |
---|
157 | |
---|
158 | CreateFactory(LevelInfo); |
---|
159 | |
---|
160 | /** |
---|
161 | @brief |
---|
162 | |
---|
163 | @param creator |
---|
164 | The creator of this object. |
---|
165 | */ |
---|
166 | LevelInfo::LevelInfo(BaseObject* creator) : BaseObject(creator) |
---|
167 | { |
---|
168 | RegisterObject(LevelInfo); |
---|
169 | |
---|
170 | this->xmlfilename_ = this->getFilename(); |
---|
171 | } |
---|
172 | |
---|
173 | /** |
---|
174 | @brief |
---|
175 | Destructor. |
---|
176 | */ |
---|
177 | LevelInfo::~LevelInfo() |
---|
178 | { |
---|
179 | |
---|
180 | } |
---|
181 | |
---|
182 | /** |
---|
183 | @brief |
---|
184 | Creates a LevelInfo object through XML. |
---|
185 | */ |
---|
186 | void LevelInfo::XMLPort(Element& xmlelement, XMLPort::Mode mode) |
---|
187 | { |
---|
188 | SUPER(LevelInfo, XMLPort, xmlelement, mode); |
---|
189 | |
---|
190 | XMLPortParam(LevelInfo, "description", setDescription, getDescription, xmlelement, mode); |
---|
191 | XMLPortParam(LevelInfo, "tags", setTags, getTags, xmlelement, mode); |
---|
192 | } |
---|
193 | |
---|
194 | /** |
---|
195 | @brief |
---|
196 | Copies the contents of this LevelInfo object to a new LevelInfoItem object. |
---|
197 | This is needed, because a LeveInfo object is only created within the scope of the XML-file it is loaded with and is destroyed once that is unloaded. |
---|
198 | @return |
---|
199 | Returns a new LevelInfoItem with the same contents as the LevelInfo object. |
---|
200 | */ |
---|
201 | LevelInfoItem* LevelInfo::copy(void) |
---|
202 | { |
---|
203 | LevelInfoItem* info = new LevelInfoItem(this->BaseObject::getName(), this->getXMLFilename()); |
---|
204 | info->setDescription(this->getDescription()); |
---|
205 | info->setTags(this->getTags()); |
---|
206 | return info; |
---|
207 | } |
---|
208 | |
---|
209 | } |
---|
210 | |
---|