Factory.cpp 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681
  1. /*
  2. * This source file is part of RmlUi, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://github.com/mikke89/RmlUi
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. * Copyright (c) 2019-2023 The RmlUi Team, and contributors
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. *
  27. */
  28. #include "../../Include/RmlUi/Core/Factory.h"
  29. #include "../../Include/RmlUi/Core/Context.h"
  30. #include "../../Include/RmlUi/Core/ContextInstancer.h"
  31. #include "../../Include/RmlUi/Core/Core.h"
  32. #include "../../Include/RmlUi/Core/ElementDocument.h"
  33. #include "../../Include/RmlUi/Core/ElementInstancer.h"
  34. #include "../../Include/RmlUi/Core/ElementText.h"
  35. #include "../../Include/RmlUi/Core/ElementUtilities.h"
  36. #include "../../Include/RmlUi/Core/Elements/ElementForm.h"
  37. #include "../../Include/RmlUi/Core/Elements/ElementFormControlInput.h"
  38. #include "../../Include/RmlUi/Core/Elements/ElementFormControlSelect.h"
  39. #include "../../Include/RmlUi/Core/Elements/ElementFormControlTextArea.h"
  40. #include "../../Include/RmlUi/Core/Elements/ElementProgress.h"
  41. #include "../../Include/RmlUi/Core/Elements/ElementTabSet.h"
  42. #include "../../Include/RmlUi/Core/EventListenerInstancer.h"
  43. #include "../../Include/RmlUi/Core/StreamMemory.h"
  44. #include "../../Include/RmlUi/Core/StyleSheet.h"
  45. #include "../../Include/RmlUi/Core/StyleSheetContainer.h"
  46. #include "../../Include/RmlUi/Core/SystemInterface.h"
  47. #include "ContextInstancerDefault.h"
  48. #include "DataControllerDefault.h"
  49. #include "DataViewDefault.h"
  50. #include "DecoratorGradient.h"
  51. #include "DecoratorNinePatch.h"
  52. #include "DecoratorShader.h"
  53. #include "DecoratorTiledBox.h"
  54. #include "DecoratorTiledHorizontal.h"
  55. #include "DecoratorTiledImage.h"
  56. #include "DecoratorTiledVertical.h"
  57. #include "ElementHandle.h"
  58. #include "Elements/ElementImage.h"
  59. #include "Elements/ElementLabel.h"
  60. #include "Elements/ElementTextSelection.h"
  61. #include "Elements/XMLNodeHandlerSelect.h"
  62. #include "Elements/XMLNodeHandlerTabSet.h"
  63. #include "Elements/XMLNodeHandlerTextArea.h"
  64. #include "EventInstancerDefault.h"
  65. #include "FilterBasic.h"
  66. #include "FilterBlur.h"
  67. #include "FilterDropShadow.h"
  68. #include "FontEffectBlur.h"
  69. #include "FontEffectGlow.h"
  70. #include "FontEffectOutline.h"
  71. #include "FontEffectShadow.h"
  72. #include "PluginRegistry.h"
  73. #include "StreamFile.h"
  74. #include "StyleSheetFactory.h"
  75. #include "TemplateCache.h"
  76. #include "XMLNodeHandlerBody.h"
  77. #include "XMLNodeHandlerDefault.h"
  78. #include "XMLNodeHandlerHead.h"
  79. #include "XMLNodeHandlerTemplate.h"
  80. #include "XMLParseTools.h"
  81. #include <algorithm>
  82. namespace Rml {
  83. // Element instancers.
  84. using ElementInstancerMap = UnorderedMap<String, ElementInstancer*>;
  85. static ElementInstancerMap element_instancers;
  86. // Decorator instancers.
  87. using DecoratorInstancerMap = UnorderedMap<String, DecoratorInstancer*>;
  88. static DecoratorInstancerMap decorator_instancers;
  89. // Filter instancers.
  90. using FilterInstancerMap = UnorderedMap<String, FilterInstancer*>;
  91. static FilterInstancerMap filter_instancers;
  92. // Font effect instancers.
  93. using FontEffectInstancerMap = UnorderedMap<String, FontEffectInstancer*>;
  94. static FontEffectInstancerMap font_effect_instancers;
  95. // Data view instancers.
  96. using DataViewInstancerMap = UnorderedMap<String, DataViewInstancer*>;
  97. static DataViewInstancerMap data_view_instancers;
  98. // Data controller instancers.
  99. using DataControllerInstancerMap = UnorderedMap<String, DataControllerInstancer*>;
  100. static DataControllerInstancerMap data_controller_instancers;
  101. // Structural data view instancers.
  102. using StructuralDataViewInstancerMap = SmallUnorderedMap<String, DataViewInstancer*>;
  103. static StructuralDataViewInstancerMap structural_data_view_instancers;
  104. // Structural data view names.
  105. static StringList structural_data_view_attribute_names;
  106. // The context instancer.
  107. static ContextInstancer* context_instancer = nullptr;
  108. // The event instancer
  109. static EventInstancer* event_instancer = nullptr;
  110. // Event listener instancer.
  111. static EventListenerInstancer* event_listener_instancer = nullptr;
  112. // Default instancers are constructed and destroyed on Initialise and Shutdown, respectively.
  113. struct DefaultInstancers {
  114. UniquePtr<ContextInstancer> context_default;
  115. UniquePtr<EventInstancer> event_default;
  116. // Basic elements
  117. ElementInstancerElement element_default;
  118. ElementInstancerText element_text;
  119. ElementInstancerGeneric<ElementImage> element_img;
  120. ElementInstancerGeneric<ElementHandle> element_handle;
  121. ElementInstancerGeneric<ElementDocument> element_body;
  122. // Control elements
  123. ElementInstancerGeneric<ElementForm> form;
  124. ElementInstancerGeneric<ElementFormControlInput> input;
  125. ElementInstancerGeneric<ElementFormControlSelect> select;
  126. ElementInstancerGeneric<ElementLabel> element_label;
  127. ElementInstancerGeneric<ElementFormControlTextArea> textarea;
  128. ElementInstancerGeneric<ElementTextSelection> selection;
  129. ElementInstancerGeneric<ElementTabSet> tabset;
  130. ElementInstancerGeneric<ElementProgress> progress;
  131. // Decorators
  132. DecoratorTiledHorizontalInstancer decorator_tiled_horizontal;
  133. DecoratorTiledVerticalInstancer decorator_tiled_vertical;
  134. DecoratorTiledBoxInstancer decorator_tiled_box;
  135. DecoratorTiledImageInstancer decorator_image;
  136. DecoratorNinePatchInstancer decorator_ninepatch;
  137. DecoratorShaderInstancer decorator_shader;
  138. DecoratorStraightGradientInstancer decorator_straight_gradient;
  139. DecoratorLinearGradientInstancer decorator_linear_gradient;
  140. DecoratorRadialGradientInstancer decorator_radial_gradient;
  141. DecoratorConicGradientInstancer decorator_conic_gradient;
  142. // Filters
  143. FilterBasicInstancer filter_hue_rotate = {FilterBasicInstancer::ValueType::Angle, "0rad"};
  144. FilterBasicInstancer filter_basic_d0 = {FilterBasicInstancer::ValueType::NumberPercent, "0"};
  145. FilterBasicInstancer filter_basic_d1 = {FilterBasicInstancer::ValueType::NumberPercent, "1"};
  146. FilterBlurInstancer filter_blur;
  147. FilterDropShadowInstancer filter_drop_shadow;
  148. // Font effects
  149. FontEffectBlurInstancer font_effect_blur;
  150. FontEffectGlowInstancer font_effect_glow;
  151. FontEffectOutlineInstancer font_effect_outline;
  152. FontEffectShadowInstancer font_effect_shadow;
  153. // Data binding views
  154. DataViewInstancerDefault<DataViewAttribute> data_view_attribute;
  155. DataViewInstancerDefault<DataViewAttributeIf> data_view_attribute_if;
  156. DataViewInstancerDefault<DataViewClass> data_view_class;
  157. DataViewInstancerDefault<DataViewIf> data_view_if;
  158. DataViewInstancerDefault<DataViewVisible> data_view_visible;
  159. DataViewInstancerDefault<DataViewRml> data_view_rml;
  160. DataViewInstancerDefault<DataViewStyle> data_view_style;
  161. DataViewInstancerDefault<DataViewText> data_view_text;
  162. DataViewInstancerDefault<DataViewValue> data_view_value;
  163. DataViewInstancerDefault<DataViewChecked> data_view_checked;
  164. DataViewInstancerDefault<DataViewAlias> data_view_alias;
  165. DataViewInstancerDefault<DataViewFor> structural_data_view_for;
  166. // Data binding controllers
  167. DataControllerInstancerDefault<DataControllerEvent> data_controller_event;
  168. DataControllerInstancerDefault<DataControllerValue> data_controller_value;
  169. };
  170. static UniquePtr<DefaultInstancers> default_instancers;
  171. Factory::Factory() {}
  172. Factory::~Factory() {}
  173. bool Factory::Initialise()
  174. {
  175. default_instancers = MakeUnique<DefaultInstancers>();
  176. // Default context instancer
  177. if (!context_instancer)
  178. {
  179. default_instancers->context_default = MakeUnique<ContextInstancerDefault>();
  180. context_instancer = default_instancers->context_default.get();
  181. }
  182. // Default event instancer
  183. if (!event_instancer)
  184. {
  185. default_instancers->event_default = MakeUnique<EventInstancerDefault>();
  186. event_instancer = default_instancers->event_default.get();
  187. }
  188. // No default event listener instancer
  189. if (!event_listener_instancer)
  190. event_listener_instancer = nullptr;
  191. // Basic element instancers
  192. RegisterElementInstancer("*", &default_instancers->element_default);
  193. RegisterElementInstancer("img", &default_instancers->element_img);
  194. RegisterElementInstancer("#text", &default_instancers->element_text);
  195. RegisterElementInstancer("handle", &default_instancers->element_handle);
  196. RegisterElementInstancer("body", &default_instancers->element_body);
  197. // Control element instancers
  198. RegisterElementInstancer("form", &default_instancers->form);
  199. RegisterElementInstancer("input", &default_instancers->input);
  200. RegisterElementInstancer("select", &default_instancers->select);
  201. RegisterElementInstancer("label", &default_instancers->element_label);
  202. RegisterElementInstancer("textarea", &default_instancers->textarea);
  203. RegisterElementInstancer("#selection", &default_instancers->selection);
  204. RegisterElementInstancer("tabset", &default_instancers->tabset);
  205. RegisterElementInstancer("progress", &default_instancers->progress);
  206. RegisterElementInstancer("progressbar", &default_instancers->progress);
  207. // Decorator instancers
  208. RegisterDecoratorInstancer("tiled-horizontal", &default_instancers->decorator_tiled_horizontal);
  209. RegisterDecoratorInstancer("tiled-vertical", &default_instancers->decorator_tiled_vertical);
  210. RegisterDecoratorInstancer("tiled-box", &default_instancers->decorator_tiled_box);
  211. RegisterDecoratorInstancer("image", &default_instancers->decorator_image);
  212. RegisterDecoratorInstancer("ninepatch", &default_instancers->decorator_ninepatch);
  213. RegisterDecoratorInstancer("shader", &default_instancers->decorator_shader);
  214. RegisterDecoratorInstancer("gradient", &default_instancers->decorator_straight_gradient);
  215. RegisterDecoratorInstancer("horizontal-gradient", &default_instancers->decorator_straight_gradient);
  216. RegisterDecoratorInstancer("vertical-gradient", &default_instancers->decorator_straight_gradient);
  217. RegisterDecoratorInstancer("linear-gradient", &default_instancers->decorator_linear_gradient);
  218. RegisterDecoratorInstancer("repeating-linear-gradient", &default_instancers->decorator_linear_gradient);
  219. RegisterDecoratorInstancer("radial-gradient", &default_instancers->decorator_radial_gradient);
  220. RegisterDecoratorInstancer("repeating-radial-gradient", &default_instancers->decorator_radial_gradient);
  221. RegisterDecoratorInstancer("conic-gradient", &default_instancers->decorator_conic_gradient);
  222. RegisterDecoratorInstancer("repeating-conic-gradient", &default_instancers->decorator_conic_gradient);
  223. // Filter instancers
  224. RegisterFilterInstancer("hue-rotate", &default_instancers->filter_hue_rotate);
  225. RegisterFilterInstancer("brightness", &default_instancers->filter_basic_d1);
  226. RegisterFilterInstancer("contrast", &default_instancers->filter_basic_d1);
  227. RegisterFilterInstancer("grayscale", &default_instancers->filter_basic_d0);
  228. RegisterFilterInstancer("invert", &default_instancers->filter_basic_d0);
  229. RegisterFilterInstancer("opacity", &default_instancers->filter_basic_d1);
  230. RegisterFilterInstancer("saturate", &default_instancers->filter_basic_d1);
  231. RegisterFilterInstancer("sepia", &default_instancers->filter_basic_d0);
  232. RegisterFilterInstancer("blur", &default_instancers->filter_blur);
  233. RegisterFilterInstancer("drop-shadow", &default_instancers->filter_drop_shadow);
  234. // Font effect instancers
  235. RegisterFontEffectInstancer("blur", &default_instancers->font_effect_blur);
  236. RegisterFontEffectInstancer("glow", &default_instancers->font_effect_glow);
  237. RegisterFontEffectInstancer("outline", &default_instancers->font_effect_outline);
  238. RegisterFontEffectInstancer("shadow", &default_instancers->font_effect_shadow);
  239. // Data binding views
  240. // clang-format off
  241. RegisterDataViewInstancer(&default_instancers->data_view_attribute, "attr", false);
  242. RegisterDataViewInstancer(&default_instancers->data_view_attribute_if, "attrif", false);
  243. RegisterDataViewInstancer(&default_instancers->data_view_class, "class", false);
  244. RegisterDataViewInstancer(&default_instancers->data_view_if, "if", false);
  245. RegisterDataViewInstancer(&default_instancers->data_view_visible, "visible", false);
  246. RegisterDataViewInstancer(&default_instancers->data_view_rml, "rml", false);
  247. RegisterDataViewInstancer(&default_instancers->data_view_style, "style", false);
  248. RegisterDataViewInstancer(&default_instancers->data_view_text, "text", false);
  249. RegisterDataViewInstancer(&default_instancers->data_view_value, "value", false);
  250. RegisterDataViewInstancer(&default_instancers->data_view_checked, "checked", false);
  251. RegisterDataViewInstancer(&default_instancers->data_view_alias, "alias", false);
  252. RegisterDataViewInstancer(&default_instancers->structural_data_view_for, "for", true );
  253. // clang-format on
  254. // Data binding controllers
  255. RegisterDataControllerInstancer(&default_instancers->data_controller_value, "checked");
  256. RegisterDataControllerInstancer(&default_instancers->data_controller_event, "event");
  257. RegisterDataControllerInstancer(&default_instancers->data_controller_value, "value");
  258. // XML node handlers
  259. XMLParser::RegisterNodeHandler("", MakeShared<XMLNodeHandlerDefault>());
  260. XMLParser::RegisterNodeHandler("body", MakeShared<XMLNodeHandlerBody>());
  261. XMLParser::RegisterNodeHandler("head", MakeShared<XMLNodeHandlerHead>());
  262. XMLParser::RegisterNodeHandler("template", MakeShared<XMLNodeHandlerTemplate>());
  263. // XML node handlers for control elements
  264. XMLParser::RegisterNodeHandler("tabset", MakeShared<XMLNodeHandlerTabSet>());
  265. XMLParser::RegisterNodeHandler("textarea", MakeShared<XMLNodeHandlerTextArea>());
  266. XMLParser::RegisterNodeHandler("select", MakeShared<XMLNodeHandlerSelect>());
  267. return true;
  268. }
  269. void Factory::Shutdown()
  270. {
  271. element_instancers.clear();
  272. decorator_instancers.clear();
  273. font_effect_instancers.clear();
  274. data_controller_instancers.clear();
  275. data_view_instancers.clear();
  276. structural_data_view_instancers.clear();
  277. structural_data_view_attribute_names.clear();
  278. context_instancer = nullptr;
  279. event_listener_instancer = nullptr;
  280. event_instancer = nullptr;
  281. XMLParser::ReleaseHandlers();
  282. default_instancers.reset();
  283. }
  284. void Factory::RegisterContextInstancer(ContextInstancer* instancer)
  285. {
  286. context_instancer = instancer;
  287. }
  288. ContextPtr Factory::InstanceContext(const String& name, RenderManager* render_manager)
  289. {
  290. ContextPtr new_context = context_instancer->InstanceContext(name, render_manager);
  291. if (new_context)
  292. new_context->SetInstancer(context_instancer);
  293. return new_context;
  294. }
  295. void Factory::RegisterElementInstancer(const String& name, ElementInstancer* instancer)
  296. {
  297. element_instancers[StringUtilities::ToLower(name)] = instancer;
  298. }
  299. ElementInstancer* Factory::GetElementInstancer(const String& tag)
  300. {
  301. ElementInstancerMap::iterator instancer_iterator = element_instancers.find(tag);
  302. if (instancer_iterator == element_instancers.end())
  303. {
  304. instancer_iterator = element_instancers.find("*");
  305. if (instancer_iterator == element_instancers.end())
  306. return nullptr;
  307. }
  308. return instancer_iterator->second;
  309. }
  310. ElementPtr Factory::InstanceElement(Element* parent, const String& instancer_name, const String& tag, const XMLAttributes& attributes)
  311. {
  312. if (ElementInstancer* instancer = GetElementInstancer(instancer_name))
  313. {
  314. if (ElementPtr element = instancer->InstanceElement(parent, tag, attributes))
  315. {
  316. element->SetInstancer(instancer);
  317. element->SetAttributes(attributes);
  318. PluginRegistry::NotifyElementCreate(element.get());
  319. return element;
  320. }
  321. }
  322. return nullptr;
  323. }
  324. bool Factory::InstanceElementText(Element* parent, const String& in_text)
  325. {
  326. RMLUI_ASSERT(parent);
  327. String text;
  328. if (SystemInterface* system_interface = GetSystemInterface())
  329. system_interface->TranslateString(text, in_text);
  330. // If this text node only contains white-space we don't want to construct it.
  331. const bool only_white_space = std::all_of(text.begin(), text.end(), &StringUtilities::IsWhitespace);
  332. if (only_white_space)
  333. return true;
  334. // See if we need to parse it as RML, and whether the text contains data expressions (curly brackets).
  335. bool parse_as_rml = false;
  336. bool has_data_expression = false;
  337. bool inside_brackets = false;
  338. bool inside_string = false;
  339. char previous = 0;
  340. for (const char c : text)
  341. {
  342. const char* error_str = XMLParseTools::ParseDataBrackets(inside_brackets, inside_string, c, previous);
  343. if (error_str)
  344. {
  345. Log::Message(Log::LT_WARNING, "Failed to instance text element '%s'. %s", text.c_str(), error_str);
  346. return false;
  347. }
  348. if (inside_brackets)
  349. has_data_expression = true;
  350. else if (c == '<')
  351. parse_as_rml = true;
  352. previous = c;
  353. }
  354. // If the text contains RML elements then run it through the XML parser again.
  355. if (parse_as_rml)
  356. {
  357. RMLUI_ZoneScopedNC("InstanceStream", 0xDC143C);
  358. auto stream = MakeUnique<StreamMemory>(text.size() + 32);
  359. Context* context = parent->GetContext();
  360. String tag = context ? context->GetDocumentsBaseTag() : "body";
  361. String open_tag = "<" + tag + ">";
  362. String close_tag = "</" + tag + ">";
  363. stream->Write(open_tag.c_str(), open_tag.size());
  364. stream->Write(text);
  365. stream->Write(close_tag.c_str(), close_tag.size());
  366. stream->Seek(0, SEEK_SET);
  367. InstanceElementStream(parent, stream.get());
  368. }
  369. else
  370. {
  371. RMLUI_ZoneScopedNC("InstanceText", 0x8FBC8F);
  372. // Attempt to instance the element.
  373. XMLAttributes attributes;
  374. // If we have curly brackets in the text, we tag the element so that the appropriate data view (DataViewText) is constructed.
  375. if (has_data_expression)
  376. attributes.emplace("data-text", Variant());
  377. ElementPtr element = Factory::InstanceElement(parent, "#text", "#text", attributes);
  378. if (!element)
  379. {
  380. Log::Message(Log::LT_ERROR, "Failed to instance text element '%s', instancer returned nullptr.", text.c_str());
  381. return false;
  382. }
  383. // Assign the element its text value.
  384. ElementText* text_element = rmlui_dynamic_cast<ElementText*>(element.get());
  385. if (!text_element)
  386. {
  387. Log::Message(Log::LT_ERROR, "Failed to instance text element '%s'. Found type '%s', was expecting a derivative of ElementText.",
  388. text.c_str(), rmlui_type_name(*element));
  389. return false;
  390. }
  391. // Unescape any escaped entities or unicode symbols
  392. text = StringUtilities::DecodeRml(text);
  393. text_element->SetText(text);
  394. // Add to active node.
  395. parent->AppendChild(std::move(element));
  396. }
  397. return true;
  398. }
  399. bool Factory::InstanceElementStream(Element* parent, Stream* stream)
  400. {
  401. XMLParser parser(parent);
  402. parser.Parse(stream);
  403. return true;
  404. }
  405. ElementPtr Factory::InstanceDocumentStream(Context* context, Stream* stream, const String& document_base_tag)
  406. {
  407. RMLUI_ZoneScoped;
  408. ElementPtr element = Factory::InstanceElement(nullptr, document_base_tag, document_base_tag, XMLAttributes());
  409. if (!element)
  410. {
  411. Log::Message(Log::LT_ERROR, "Failed to instance document, instancer returned nullptr.");
  412. return nullptr;
  413. }
  414. ElementDocument* document = rmlui_dynamic_cast<ElementDocument*>(element.get());
  415. if (!document)
  416. {
  417. Log::Message(Log::LT_ERROR, "Failed to instance document element. Found type '%s', was expecting derivative of ElementDocument.",
  418. rmlui_type_name(*element));
  419. return nullptr;
  420. }
  421. document->context = context;
  422. XMLParser parser(element.get());
  423. parser.Parse(stream);
  424. return element;
  425. }
  426. void Factory::RegisterDecoratorInstancer(const String& name, DecoratorInstancer* instancer)
  427. {
  428. RMLUI_ASSERT(instancer);
  429. decorator_instancers[StringUtilities::ToLower(name)] = instancer;
  430. }
  431. DecoratorInstancer* Factory::GetDecoratorInstancer(const String& name)
  432. {
  433. auto iterator = decorator_instancers.find(name);
  434. if (iterator == decorator_instancers.end())
  435. return nullptr;
  436. return iterator->second;
  437. }
  438. void Factory::RegisterFilterInstancer(const String& name, FilterInstancer* instancer)
  439. {
  440. RMLUI_ASSERT(instancer);
  441. filter_instancers[StringUtilities::ToLower(name)] = instancer;
  442. }
  443. FilterInstancer* Factory::GetFilterInstancer(const String& name)
  444. {
  445. auto iterator = filter_instancers.find(name);
  446. if (iterator == filter_instancers.end())
  447. return nullptr;
  448. return iterator->second;
  449. }
  450. void Factory::RegisterFontEffectInstancer(const String& name, FontEffectInstancer* instancer)
  451. {
  452. RMLUI_ASSERT(instancer);
  453. font_effect_instancers[StringUtilities::ToLower(name)] = instancer;
  454. }
  455. FontEffectInstancer* Factory::GetFontEffectInstancer(const String& name)
  456. {
  457. auto iterator = font_effect_instancers.find(name);
  458. if (iterator == font_effect_instancers.end())
  459. return nullptr;
  460. return iterator->second;
  461. }
  462. SharedPtr<StyleSheetContainer> Factory::InstanceStyleSheetString(const String& string)
  463. {
  464. auto memory_stream = MakeUnique<StreamMemory>((const byte*)string.c_str(), string.size());
  465. return InstanceStyleSheetStream(memory_stream.get());
  466. }
  467. SharedPtr<StyleSheetContainer> Factory::InstanceStyleSheetFile(const String& file_name)
  468. {
  469. auto file_stream = MakeUnique<StreamFile>();
  470. file_stream->Open(file_name);
  471. return InstanceStyleSheetStream(file_stream.get());
  472. }
  473. SharedPtr<StyleSheetContainer> Factory::InstanceStyleSheetStream(Stream* stream)
  474. {
  475. SharedPtr<StyleSheetContainer> style_sheet_container = MakeShared<StyleSheetContainer>();
  476. if (style_sheet_container->LoadStyleSheetContainer(stream))
  477. {
  478. return style_sheet_container;
  479. }
  480. return nullptr;
  481. }
  482. void Factory::ClearStyleSheetCache()
  483. {
  484. StyleSheetFactory::ClearStyleSheetCache();
  485. }
  486. void Factory::ClearTemplateCache()
  487. {
  488. TemplateCache::Clear();
  489. }
  490. void Factory::RegisterEventInstancer(EventInstancer* instancer)
  491. {
  492. event_instancer = instancer;
  493. }
  494. EventPtr Factory::InstanceEvent(Element* target, EventId id, const String& type, const Dictionary& parameters, bool interruptible)
  495. {
  496. EventPtr event = event_instancer->InstanceEvent(target, id, type, parameters, interruptible);
  497. if (event)
  498. event->instancer = event_instancer;
  499. return event;
  500. }
  501. void Factory::RegisterEventListenerInstancer(EventListenerInstancer* instancer)
  502. {
  503. event_listener_instancer = instancer;
  504. }
  505. EventListener* Factory::InstanceEventListener(const String& value, Element* element)
  506. {
  507. // If we have an event listener instancer, use it
  508. if (event_listener_instancer)
  509. return event_listener_instancer->InstanceEventListener(value, element);
  510. return nullptr;
  511. }
  512. void Factory::RegisterDataViewInstancer(DataViewInstancer* instancer, const String& name, bool is_structural_view)
  513. {
  514. bool inserted = false;
  515. if (is_structural_view)
  516. {
  517. inserted = structural_data_view_instancers.emplace(name, instancer).second;
  518. if (inserted)
  519. structural_data_view_attribute_names.push_back(String("data-") + name);
  520. }
  521. else
  522. {
  523. inserted = data_view_instancers.emplace(name, instancer).second;
  524. }
  525. if (!inserted)
  526. Log::Message(Log::LT_WARNING, "Could not register data view instancer '%s'. The given name is already registered.", name.c_str());
  527. }
  528. void Factory::RegisterDataControllerInstancer(DataControllerInstancer* instancer, const String& name)
  529. {
  530. bool inserted = data_controller_instancers.emplace(name, instancer).second;
  531. if (!inserted)
  532. Log::Message(Log::LT_WARNING, "Could not register data controller instancer '%s'. The given name is already registered.", name.c_str());
  533. }
  534. DataViewPtr Factory::InstanceDataView(const String& type_name, Element* element, bool is_structural_view)
  535. {
  536. RMLUI_ASSERT(element);
  537. if (is_structural_view)
  538. {
  539. auto it = structural_data_view_instancers.find(type_name);
  540. if (it != structural_data_view_instancers.end())
  541. return it->second->InstanceView(element);
  542. }
  543. else
  544. {
  545. auto it = data_view_instancers.find(type_name);
  546. if (it != data_view_instancers.end())
  547. return it->second->InstanceView(element);
  548. }
  549. return nullptr;
  550. }
  551. DataControllerPtr Factory::InstanceDataController(const String& type_name, Element* element)
  552. {
  553. auto it = data_controller_instancers.find(type_name);
  554. if (it != data_controller_instancers.end())
  555. return it->second->InstanceController(element);
  556. return DataControllerPtr();
  557. }
  558. bool Factory::IsStructuralDataView(const String& type_name)
  559. {
  560. return structural_data_view_instancers.find(type_name) != structural_data_view_instancers.end();
  561. }
  562. const StringList& Factory::GetStructuralDataViewAttributeNames()
  563. {
  564. return structural_data_view_attribute_names;
  565. }
  566. } // namespace Rml