2 * Copyright (C) 2005-2013 Team XBMC
5 * This Program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2, or (at your option)
10 * This Program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with XBMC; see the file COPYING. If not, see
17 * <http://www.gnu.org/licenses/>.
21 #include "GUIIncludes.h"
22 #include "addons/Skin.h"
23 #include "GUIInfoManager.h"
24 #include "utils/log.h"
25 #include "utils/XBMCTinyXML.h"
26 #include "utils/StringUtils.h"
27 #include "interfaces/info/SkinVariable.h"
31 CGUIIncludes::CGUIIncludes()
33 m_constantAttributes.insert("x");
34 m_constantAttributes.insert("y");
35 m_constantAttributes.insert("width");
36 m_constantAttributes.insert("height");
37 m_constantAttributes.insert("center");
38 m_constantAttributes.insert("max");
39 m_constantAttributes.insert("min");
40 m_constantAttributes.insert("w");
41 m_constantAttributes.insert("h");
42 m_constantAttributes.insert("time");
43 m_constantAttributes.insert("acceleration");
44 m_constantAttributes.insert("delay");
45 m_constantAttributes.insert("start");
46 m_constantAttributes.insert("end");
47 m_constantAttributes.insert("center");
48 m_constantAttributes.insert("border");
50 m_constantNodes.insert("posx");
51 m_constantNodes.insert("posy");
52 m_constantNodes.insert("width");
53 m_constantNodes.insert("height");
54 m_constantNodes.insert("offsetx");
55 m_constantNodes.insert("offsety");
56 m_constantNodes.insert("textoffsetx");
57 m_constantNodes.insert("textoffsety");
58 m_constantNodes.insert("textwidth");
59 m_constantNodes.insert("spinposx");
60 m_constantNodes.insert("spinposy");
61 m_constantNodes.insert("spinwidth");
62 m_constantNodes.insert("spinheight");
63 m_constantNodes.insert("radioposx");
64 m_constantNodes.insert("radioposy");
65 m_constantNodes.insert("radiowidth");
66 m_constantNodes.insert("radioheight");
67 m_constantNodes.insert("markwidth");
68 m_constantNodes.insert("markheight");
69 m_constantNodes.insert("sliderwidth");
70 m_constantNodes.insert("sliderheight");
71 m_constantNodes.insert("itemgap");
72 m_constantNodes.insert("bordersize");
73 m_constantNodes.insert("timeperimage");
74 m_constantNodes.insert("fadetime");
75 m_constantNodes.insert("pauseatend");
78 CGUIIncludes::~CGUIIncludes()
82 void CGUIIncludes::ClearIncludes()
87 m_skinvariables.clear();
91 bool CGUIIncludes::LoadIncludes(const CStdString &includeFile)
93 // check to see if we already have this loaded
94 if (HasIncludeFile(includeFile))
98 if (!doc.LoadFile(includeFile))
100 CLog::Log(LOGINFO, "Error loading includes.xml file (%s): %s (row=%i, col=%i)", includeFile.c_str(), doc.ErrorDesc(), doc.ErrorRow(), doc.ErrorCol());
103 // success, load the tags
104 if (LoadIncludesFromXML(doc.RootElement()))
106 m_files.push_back(includeFile);
112 bool CGUIIncludes::LoadIncludesFromXML(const TiXmlElement *root)
114 if (!root || strcmpi(root->Value(), "includes"))
116 CLog::Log(LOGERROR, "Skin includes must start with the <includes> tag");
119 const TiXmlElement* node = root->FirstChildElement("include");
122 if (node->Attribute("name") && node->FirstChild())
124 CStdString tagName = node->Attribute("name");
125 m_includes.insert(pair<CStdString, TiXmlElement>(tagName, *node));
127 else if (node->Attribute("file"))
128 { // load this file in as well
129 LoadIncludes(g_SkinInfo->GetSkinPath(node->Attribute("file")));
131 node = node->NextSiblingElement("include");
134 node = root->FirstChildElement("default");
137 if (node->Attribute("type") && node->FirstChild())
139 CStdString tagName = node->Attribute("type");
140 m_defaults.insert(pair<CStdString, TiXmlElement>(tagName, *node));
142 node = node->NextSiblingElement("default");
144 // and finally constants
145 node = root->FirstChildElement("constant");
148 if (node->Attribute("name") && node->FirstChild())
150 CStdString tagName = node->Attribute("name");
151 m_constants.insert(make_pair(tagName, node->FirstChild()->ValueStr()));
153 node = node->NextSiblingElement("constant");
156 node = root->FirstChildElement("variable");
159 if (node->Attribute("name") && node->FirstChild())
161 CStdString tagName = node->Attribute("name");
162 m_skinvariables.insert(make_pair(tagName, *node));
164 node = node->NextSiblingElement("variable");
170 bool CGUIIncludes::HasIncludeFile(const CStdString &file) const
172 for (iFiles it = m_files.begin(); it != m_files.end(); ++it)
173 if (*it == file) return true;
177 void CGUIIncludes::ResolveIncludes(TiXmlElement *node, std::map<int, bool>* xmlIncludeConditions /* = NULL */)
181 ResolveIncludesForNode(node, xmlIncludeConditions);
183 TiXmlElement *child = node->FirstChildElement();
186 ResolveIncludes(child, xmlIncludeConditions);
187 child = child->NextSiblingElement();
191 void CGUIIncludes::ResolveIncludesForNode(TiXmlElement *node, std::map<int, bool>* xmlIncludeConditions /* = NULL */)
193 // we have a node, find any <include file="fileName">tagName</include> tags and replace
194 // recursively with their real includes
197 // First add the defaults if this is for a control
199 if (node->ValueStr() == "control")
201 type = node->Attribute("type");
202 map<CStdString, TiXmlElement>::const_iterator it = m_defaults.find(type);
203 if (it != m_defaults.end())
205 const TiXmlElement &element = (*it).second;
206 const TiXmlElement *tag = element.FirstChildElement();
209 // we insert at the end of block
210 node->InsertEndChild(*tag);
211 tag = tag->NextSiblingElement();
216 TiXmlElement *include = node->FirstChildElement("include");
217 while (include && include->FirstChild())
219 // have an include tag - grab it's tag name and replace it with the real tag contents
220 const char *file = include->Attribute("file");
222 { // we need to load this include from the alternative file
223 LoadIncludes(g_SkinInfo->GetSkinPath(file));
225 const char *condition = include->Attribute("condition");
227 { // check this condition
228 int conditionID = g_infoManager.Register(condition);
229 bool value = g_infoManager.GetBoolValue(conditionID);
231 if (xmlIncludeConditions)
232 (*xmlIncludeConditions)[conditionID] = value;
236 include = include->NextSiblingElement("include");
240 CStdString tagName = include->FirstChild()->Value();
241 map<CStdString, TiXmlElement>::const_iterator it = m_includes.find(tagName);
242 if (it != m_includes.end())
243 { // found the tag(s) to include - let's replace it
244 const TiXmlElement &element = (*it).second;
245 const TiXmlElement *tag = element.FirstChildElement();
248 // we insert before the <include> element to keep the correct
249 // order (we render in the order given in the xml file)
250 node->InsertBeforeChild(include, *tag);
251 tag = tag->NextSiblingElement();
253 // remove the <include>tagName</include> element
254 node->RemoveChild(include);
255 include = node->FirstChildElement("include");
259 CLog::Log(LOGWARNING, "Skin has invalid include: %s", tagName.c_str());
260 include = include->NextSiblingElement("include");
264 // run through this element's attributes, resolving any constants
265 TiXmlAttribute *attribute = node->FirstAttribute();
267 { // check the attribute against our set
268 if (m_constantAttributes.count(attribute->Name()))
269 attribute->SetValue(ResolveConstant(attribute->ValueStr()));
270 attribute = attribute->Next();
273 if (node->FirstChild() && node->FirstChild()->Type() == TiXmlNode::TINYXML_TEXT && m_constantNodes.count(node->ValueStr()))
274 node->FirstChild()->SetValue(ResolveConstant(node->FirstChild()->ValueStr()));
277 CStdString CGUIIncludes::ResolveConstant(const CStdString &constant) const
279 CStdStringArray values;
280 StringUtils::SplitString(constant, ",", values);
281 for (unsigned int i = 0; i < values.size(); ++i)
283 map<CStdString, CStdString>::const_iterator it = m_constants.find(values[i]);
284 if (it != m_constants.end())
285 values[i] = it->second;
288 StringUtils::JoinString(values, ",", value);
292 const INFO::CSkinVariableString* CGUIIncludes::CreateSkinVariable(const CStdString& name, int context)
294 map<CStdString, TiXmlElement>::const_iterator it = m_skinvariables.find(name);
295 if (it != m_skinvariables.end())
296 return INFO::CSkinVariable::CreateFromXML(it->second, context);