Factory.cpp 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  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 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/EventListenerInstancer.h"
  37. #include "../../Include/RmlUi/Core/StreamMemory.h"
  38. #include "../../Include/RmlUi/Core/StyleSheet.h"
  39. #include "../../Include/RmlUi/Core/StyleSheetContainer.h"
  40. #include "../../Include/RmlUi/Core/SystemInterface.h"
  41. #include "../../Include/RmlUi/Core/Elements/ElementForm.h"
  42. #include "../../Include/RmlUi/Core/Elements/ElementFormControlInput.h"
  43. #include "../../Include/RmlUi/Core/Elements/ElementFormControlDataSelect.h"
  44. #include "../../Include/RmlUi/Core/Elements/ElementFormControlSelect.h"
  45. #include "../../Include/RmlUi/Core/Elements/ElementFormControlSelect.h"
  46. #include "../../Include/RmlUi/Core/Elements/ElementFormControlTextArea.h"
  47. #include "../../Include/RmlUi/Core/Elements/ElementTabSet.h"
  48. #include "../../Include/RmlUi/Core/Elements/ElementProgress.h"
  49. #include "../../Include/RmlUi/Core/Elements/ElementDataGrid.h"
  50. #include "../../Include/RmlUi/Core/Elements/ElementDataGridExpandButton.h"
  51. #include "../../Include/RmlUi/Core/Elements/ElementDataGridCell.h"
  52. #include "../../Include/RmlUi/Core/Elements/ElementDataGridRow.h"
  53. #include "ContextInstancerDefault.h"
  54. #include "DataControllerDefault.h"
  55. #include "DataViewDefault.h"
  56. #include "DecoratorTiledBoxInstancer.h"
  57. #include "DecoratorTiledHorizontalInstancer.h"
  58. #include "DecoratorTiledImageInstancer.h"
  59. #include "DecoratorTiledVerticalInstancer.h"
  60. #include "DecoratorNinePatch.h"
  61. #include "DecoratorGradient.h"
  62. #include "ElementHandle.h"
  63. #include "EventInstancerDefault.h"
  64. #include "FontEffectBlur.h"
  65. #include "FontEffectGlow.h"
  66. #include "FontEffectOutline.h"
  67. #include "FontEffectShadow.h"
  68. #include "PluginRegistry.h"
  69. #include "StreamFile.h"
  70. #include "StyleSheetFactory.h"
  71. #include "TemplateCache.h"
  72. #include "XMLNodeHandlerBody.h"
  73. #include "XMLNodeHandlerDefault.h"
  74. #include "XMLNodeHandlerHead.h"
  75. #include "XMLNodeHandlerTemplate.h"
  76. #include "XMLParseTools.h"
  77. #include "Elements/ElementImage.h"
  78. #include "Elements/ElementLabel.h"
  79. #include "Elements/ElementTextSelection.h"
  80. #include "Elements/XMLNodeHandlerDataGrid.h"
  81. #include "Elements/XMLNodeHandlerSelect.h"
  82. #include "Elements/XMLNodeHandlerTabSet.h"
  83. #include "Elements/XMLNodeHandlerTextArea.h"
  84. #include <algorithm>
  85. namespace Rml {
  86. // Element instancers.
  87. using ElementInstancerMap = UnorderedMap< String, ElementInstancer* >;
  88. static ElementInstancerMap element_instancers;
  89. // Decorator instancers.
  90. using DecoratorInstancerMap = UnorderedMap< String, DecoratorInstancer* >;
  91. static DecoratorInstancerMap decorator_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<ElementFormControlDataSelect> dataselect;
  126. ElementInstancerGeneric<ElementFormControlSelect> select;
  127. ElementInstancerGeneric<ElementLabel> element_label;
  128. ElementInstancerGeneric<ElementFormControlTextArea> textarea;
  129. ElementInstancerGeneric<ElementTextSelection> selection;
  130. ElementInstancerGeneric<ElementTabSet> tabset;
  131. ElementInstancerGeneric<ElementProgress> progress;
  132. ElementInstancerGeneric<ElementDataGrid> datagrid;
  133. ElementInstancerGeneric<ElementDataGridExpandButton> datagrid_expand;
  134. ElementInstancerGeneric<ElementDataGridCell> datagrid_cell;
  135. ElementInstancerGeneric<ElementDataGridRow> datagrid_row;
  136. // Decorators
  137. DecoratorTiledHorizontalInstancer decorator_tiled_horizontal;
  138. DecoratorTiledVerticalInstancer decorator_tiled_vertical;
  139. DecoratorTiledBoxInstancer decorator_tiled_box;
  140. DecoratorTiledImageInstancer decorator_image;
  141. DecoratorNinePatchInstancer decorator_ninepatch;
  142. DecoratorGradientInstancer decorator_gradient;
  143. // Font effects
  144. FontEffectBlurInstancer font_effect_blur;
  145. FontEffectGlowInstancer font_effect_glow;
  146. FontEffectOutlineInstancer font_effect_outline;
  147. FontEffectShadowInstancer font_effect_shadow;
  148. // Data binding views
  149. DataViewInstancerDefault<DataViewAttribute> data_view_attribute;
  150. DataViewInstancerDefault<DataViewAttributeIf> data_view_attribute_if;
  151. DataViewInstancerDefault<DataViewClass> data_view_class;
  152. DataViewInstancerDefault<DataViewIf> data_view_if;
  153. DataViewInstancerDefault<DataViewVisible> data_view_visible;
  154. DataViewInstancerDefault<DataViewRml> data_view_rml;
  155. DataViewInstancerDefault<DataViewStyle> data_view_style;
  156. DataViewInstancerDefault<DataViewText> data_view_text;
  157. DataViewInstancerDefault<DataViewValue> data_view_value;
  158. DataViewInstancerDefault<DataViewChecked> data_view_checked;
  159. DataViewInstancerDefault<DataViewAlias> data_view_alias;
  160. DataViewInstancerDefault<DataViewFor> structural_data_view_for;
  161. // Data binding controllers
  162. DataControllerInstancerDefault<DataControllerEvent> data_controller_event;
  163. DataControllerInstancerDefault<DataControllerValue> data_controller_value;
  164. };
  165. static UniquePtr<DefaultInstancers> default_instancers;
  166. Factory::Factory()
  167. {
  168. }
  169. Factory::~Factory()
  170. {
  171. }
  172. bool Factory::Initialise()
  173. {
  174. default_instancers = MakeUnique<DefaultInstancers>();
  175. // Default context instancer
  176. if (!context_instancer)
  177. {
  178. default_instancers->context_default = MakeUnique<ContextInstancerDefault>();
  179. context_instancer = default_instancers->context_default.get();
  180. }
  181. // Default event instancer
  182. if (!event_instancer)
  183. {
  184. default_instancers->event_default = MakeUnique<EventInstancerDefault>();
  185. event_instancer = default_instancers->event_default.get();
  186. }
  187. // No default event listener instancer
  188. if (!event_listener_instancer)
  189. event_listener_instancer = nullptr;
  190. // Basic element instancers
  191. RegisterElementInstancer("*", &default_instancers->element_default);
  192. RegisterElementInstancer("img", &default_instancers->element_img);
  193. RegisterElementInstancer("#text", &default_instancers->element_text);
  194. RegisterElementInstancer("handle", &default_instancers->element_handle);
  195. RegisterElementInstancer("body", &default_instancers->element_body);
  196. // Control element instancers
  197. RegisterElementInstancer("form", &default_instancers->form);
  198. RegisterElementInstancer("input", &default_instancers->input);
  199. RegisterElementInstancer("dataselect", &default_instancers->dataselect);
  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. RegisterElementInstancer("datagrid", &default_instancers->datagrid);
  208. RegisterElementInstancer("datagridexpand", &default_instancers->datagrid_expand);
  209. RegisterElementInstancer("#rmlctl_datagridcell", &default_instancers->datagrid_cell);
  210. RegisterElementInstancer("#rmlctl_datagridrow", &default_instancers->datagrid_row);
  211. // Decorator instancers
  212. RegisterDecoratorInstancer("tiled-horizontal", &default_instancers->decorator_tiled_horizontal);
  213. RegisterDecoratorInstancer("tiled-vertical", &default_instancers->decorator_tiled_vertical);
  214. RegisterDecoratorInstancer("tiled-box", &default_instancers->decorator_tiled_box);
  215. RegisterDecoratorInstancer("image", &default_instancers->decorator_image);
  216. RegisterDecoratorInstancer("ninepatch", &default_instancers->decorator_ninepatch);
  217. RegisterDecoratorInstancer("gradient", &default_instancers->decorator_gradient);
  218. // Font effect instancers
  219. RegisterFontEffectInstancer("blur", &default_instancers->font_effect_blur);
  220. RegisterFontEffectInstancer("glow", &default_instancers->font_effect_glow);
  221. RegisterFontEffectInstancer("outline", &default_instancers->font_effect_outline);
  222. RegisterFontEffectInstancer("shadow", &default_instancers->font_effect_shadow);
  223. // Data binding views
  224. RegisterDataViewInstancer(&default_instancers->data_view_attribute, "attr", false);
  225. RegisterDataViewInstancer(&default_instancers->data_view_attribute_if, "attrif", false);
  226. RegisterDataViewInstancer(&default_instancers->data_view_class, "class", false);
  227. RegisterDataViewInstancer(&default_instancers->data_view_if, "if", false);
  228. RegisterDataViewInstancer(&default_instancers->data_view_visible, "visible", false);
  229. RegisterDataViewInstancer(&default_instancers->data_view_rml, "rml", false);
  230. RegisterDataViewInstancer(&default_instancers->data_view_style, "style", false);
  231. RegisterDataViewInstancer(&default_instancers->data_view_text, "text", false);
  232. RegisterDataViewInstancer(&default_instancers->data_view_value, "value", false);
  233. RegisterDataViewInstancer(&default_instancers->data_view_checked, "checked", false);
  234. RegisterDataViewInstancer(&default_instancers->data_view_alias, "alias", false);
  235. RegisterDataViewInstancer(&default_instancers->structural_data_view_for, "for", true );
  236. // Data binding controllers
  237. RegisterDataControllerInstancer(&default_instancers->data_controller_value, "checked");
  238. RegisterDataControllerInstancer(&default_instancers->data_controller_event, "event");
  239. RegisterDataControllerInstancer(&default_instancers->data_controller_value, "value");
  240. // XML node handlers
  241. XMLParser::RegisterNodeHandler("", MakeShared<XMLNodeHandlerDefault>());
  242. XMLParser::RegisterNodeHandler("body", MakeShared<XMLNodeHandlerBody>());
  243. XMLParser::RegisterNodeHandler("head", MakeShared<XMLNodeHandlerHead>());
  244. XMLParser::RegisterNodeHandler("template", MakeShared<XMLNodeHandlerTemplate>());
  245. // XML node handlers for control elements
  246. XMLParser::RegisterNodeHandler("datagrid", MakeShared<XMLNodeHandlerDataGrid>());
  247. XMLParser::RegisterNodeHandler("tabset", MakeShared<XMLNodeHandlerTabSet>());
  248. XMLParser::RegisterNodeHandler("textarea", MakeShared<XMLNodeHandlerTextArea>());
  249. XMLParser::RegisterNodeHandler("select", MakeShared<XMLNodeHandlerSelect>());
  250. return true;
  251. }
  252. void Factory::Shutdown()
  253. {
  254. element_instancers.clear();
  255. decorator_instancers.clear();
  256. font_effect_instancers.clear();
  257. data_controller_instancers.clear();
  258. data_view_instancers.clear();
  259. structural_data_view_instancers.clear();
  260. structural_data_view_attribute_names.clear();
  261. context_instancer = nullptr;
  262. event_listener_instancer = nullptr;
  263. event_instancer = nullptr;
  264. XMLParser::ReleaseHandlers();
  265. default_instancers.reset();
  266. }
  267. // Registers the instancer to use when instancing contexts.
  268. void Factory::RegisterContextInstancer(ContextInstancer* instancer)
  269. {
  270. context_instancer = instancer;
  271. }
  272. // Instances a new context.
  273. ContextPtr Factory::InstanceContext(const String& name)
  274. {
  275. ContextPtr new_context = context_instancer->InstanceContext(name);
  276. if (new_context)
  277. new_context->SetInstancer(context_instancer);
  278. return new_context;
  279. }
  280. void Factory::RegisterElementInstancer(const String& name, ElementInstancer* instancer)
  281. {
  282. element_instancers[StringUtilities::ToLower(name)] = instancer;
  283. }
  284. // Looks up the instancer for the given element
  285. ElementInstancer* Factory::GetElementInstancer(const String& tag)
  286. {
  287. ElementInstancerMap::iterator instancer_iterator = element_instancers.find(tag);
  288. if (instancer_iterator == element_instancers.end())
  289. {
  290. instancer_iterator = element_instancers.find("*");
  291. if (instancer_iterator == element_instancers.end())
  292. return nullptr;
  293. }
  294. return instancer_iterator->second;
  295. }
  296. // Instances a single element.
  297. ElementPtr Factory::InstanceElement(Element* parent, const String& instancer_name, const String& tag, const XMLAttributes& attributes)
  298. {
  299. if (ElementInstancer* instancer = GetElementInstancer(instancer_name))
  300. {
  301. if (ElementPtr element = instancer->InstanceElement(parent, tag, attributes))
  302. {
  303. element->SetInstancer(instancer);
  304. element->SetAttributes(attributes);
  305. PluginRegistry::NotifyElementCreate(element.get());
  306. return element;
  307. }
  308. }
  309. return nullptr;
  310. }
  311. // Instances a single text element containing a string.
  312. bool Factory::InstanceElementText(Element* parent, const String& in_text)
  313. {
  314. RMLUI_ASSERT(parent);
  315. String text;
  316. if (SystemInterface* system_interface = GetSystemInterface())
  317. system_interface->TranslateString(text, in_text);
  318. // If this text node only contains white-space we don't want to construct it.
  319. const bool only_white_space = std::all_of(text.begin(), text.end(), &StringUtilities::IsWhitespace);
  320. if (only_white_space)
  321. return true;
  322. // See if we need to parse it as RML, and whether the text contains data expressions (curly brackets).
  323. bool parse_as_rml = false;
  324. bool has_data_expression = false;
  325. bool inside_brackets = false;
  326. bool inside_string = false;
  327. char previous = 0;
  328. for (const char c : text)
  329. {
  330. const char* error_str = XMLParseTools::ParseDataBrackets(inside_brackets, inside_string, c, previous);
  331. if (error_str)
  332. {
  333. Log::Message(Log::LT_WARNING, "Failed to instance text element '%s'. %s", text.c_str(), error_str);
  334. return false;
  335. }
  336. if (inside_brackets)
  337. has_data_expression = true;
  338. else if (c == '<')
  339. parse_as_rml = true;
  340. previous = c;
  341. }
  342. // If the text contains RML elements then run it through the XML parser again.
  343. if (parse_as_rml)
  344. {
  345. RMLUI_ZoneScopedNC("InstanceStream", 0xDC143C);
  346. auto stream = MakeUnique<StreamMemory>(text.size() + 32);
  347. Context* context = parent->GetContext();
  348. String tag = context ? context->GetDocumentsBaseTag() : "body";
  349. String open_tag = "<" + tag + ">";
  350. String close_tag = "</" + tag + ">";
  351. stream->Write(open_tag.c_str(), open_tag.size());
  352. stream->Write(text);
  353. stream->Write(close_tag.c_str(), close_tag.size());
  354. stream->Seek(0, SEEK_SET);
  355. InstanceElementStream(parent, stream.get());
  356. }
  357. else
  358. {
  359. RMLUI_ZoneScopedNC("InstanceText", 0x8FBC8F);
  360. // Attempt to instance the element.
  361. XMLAttributes attributes;
  362. // If we have curly brackets in the text, we tag the element so that the appropriate data view (DataViewText) is constructed.
  363. if (has_data_expression)
  364. attributes.emplace("data-text", Variant());
  365. ElementPtr element = Factory::InstanceElement(parent, "#text", "#text", attributes);
  366. if (!element)
  367. {
  368. Log::Message(Log::LT_ERROR, "Failed to instance text element '%s', instancer returned nullptr.", text.c_str());
  369. return false;
  370. }
  371. // Assign the element its text value.
  372. ElementText* text_element = rmlui_dynamic_cast< ElementText* >(element.get());
  373. if (!text_element)
  374. {
  375. Log::Message(Log::LT_ERROR, "Failed to instance text element '%s'. Found type '%s', was expecting a derivative of ElementText.", text.c_str(), rmlui_type_name(*element));
  376. return false;
  377. }
  378. // Unescape any escaped entities or unicode symbols
  379. text = StringUtilities::DecodeRml(text);
  380. text_element->SetText(text);
  381. // Add to active node.
  382. parent->AppendChild(std::move(element));
  383. }
  384. return true;
  385. }
  386. // Instances a element tree based on the stream
  387. bool Factory::InstanceElementStream(Element* parent, Stream* stream)
  388. {
  389. XMLParser parser(parent);
  390. parser.Parse(stream);
  391. return true;
  392. }
  393. // Instances a element tree based on the stream
  394. ElementPtr Factory::InstanceDocumentStream(Context* context, Stream* stream, const String& document_base_tag)
  395. {
  396. RMLUI_ZoneScoped;
  397. ElementPtr element = Factory::InstanceElement(nullptr, document_base_tag, document_base_tag, XMLAttributes());
  398. if (!element)
  399. {
  400. Log::Message(Log::LT_ERROR, "Failed to instance document, instancer returned nullptr.");
  401. return nullptr;
  402. }
  403. ElementDocument* document = rmlui_dynamic_cast< ElementDocument* >(element.get());
  404. if (!document)
  405. {
  406. Log::Message(Log::LT_ERROR, "Failed to instance document element. Found type '%s', was expecting derivative of ElementDocument.", rmlui_type_name(*element));
  407. return nullptr;
  408. }
  409. document->context = context;
  410. XMLParser parser(element.get());
  411. parser.Parse(stream);
  412. return element;
  413. }
  414. // Registers an instancer that will be used to instance decorators.
  415. void Factory::RegisterDecoratorInstancer(const String& name, DecoratorInstancer* instancer)
  416. {
  417. RMLUI_ASSERT(instancer);
  418. decorator_instancers[StringUtilities::ToLower(name)] = instancer;
  419. }
  420. // Retrieves a decorator instancer registered with the factory.
  421. DecoratorInstancer* Factory::GetDecoratorInstancer(const String& name)
  422. {
  423. auto iterator = decorator_instancers.find(name);
  424. if (iterator == decorator_instancers.end())
  425. return nullptr;
  426. return iterator->second;
  427. }
  428. // Registers an instancer that will be used to instance font effects.
  429. void Factory::RegisterFontEffectInstancer(const String& name, FontEffectInstancer* instancer)
  430. {
  431. RMLUI_ASSERT(instancer);
  432. font_effect_instancers[StringUtilities::ToLower(name)] = instancer;
  433. }
  434. FontEffectInstancer* Factory::GetFontEffectInstancer(const String& name)
  435. {
  436. auto iterator = font_effect_instancers.find(name);
  437. if (iterator == font_effect_instancers.end())
  438. return nullptr;
  439. return iterator->second;
  440. }
  441. // Creates a style sheet containing the passed in styles.
  442. SharedPtr<StyleSheetContainer> Factory::InstanceStyleSheetString(const String& string)
  443. {
  444. auto memory_stream = MakeUnique<StreamMemory>((const byte*) string.c_str(), string.size());
  445. return InstanceStyleSheetStream(memory_stream.get());
  446. }
  447. // Creates a style sheet from a file.
  448. SharedPtr<StyleSheetContainer> Factory::InstanceStyleSheetFile(const String& file_name)
  449. {
  450. auto file_stream = MakeUnique<StreamFile>();
  451. file_stream->Open(file_name);
  452. return InstanceStyleSheetStream(file_stream.get());
  453. }
  454. // Creates a style sheet from an Stream.
  455. SharedPtr<StyleSheetContainer> Factory::InstanceStyleSheetStream(Stream* stream)
  456. {
  457. SharedPtr<StyleSheetContainer> style_sheet_container = MakeShared<StyleSheetContainer>();
  458. if (style_sheet_container->LoadStyleSheetContainer(stream))
  459. {
  460. return style_sheet_container;
  461. }
  462. return nullptr;
  463. }
  464. // Clears the style sheet cache. This will force style sheets to be reloaded.
  465. void Factory::ClearStyleSheetCache()
  466. {
  467. StyleSheetFactory::ClearStyleSheetCache();
  468. }
  469. /// Clears the template cache. This will force templates to be reloaded.
  470. void Factory::ClearTemplateCache()
  471. {
  472. TemplateCache::Clear();
  473. }
  474. // Registers an instancer for all RmlEvents
  475. void Factory::RegisterEventInstancer(EventInstancer* instancer)
  476. {
  477. event_instancer = instancer;
  478. }
  479. // Instance an event object.
  480. EventPtr Factory::InstanceEvent(Element* target, EventId id, const String& type, const Dictionary& parameters, bool interruptible)
  481. {
  482. EventPtr event = event_instancer->InstanceEvent(target, id, type, parameters, interruptible);
  483. if (event)
  484. event->instancer = event_instancer;
  485. return event;
  486. }
  487. // Register an instancer for all event listeners
  488. void Factory::RegisterEventListenerInstancer(EventListenerInstancer* instancer)
  489. {
  490. event_listener_instancer = instancer;
  491. }
  492. // Instance an event listener with the given string
  493. EventListener* Factory::InstanceEventListener(const String& value, Element* element)
  494. {
  495. // If we have an event listener instancer, use it
  496. if (event_listener_instancer)
  497. return event_listener_instancer->InstanceEventListener(value, element);
  498. return nullptr;
  499. }
  500. void Factory::RegisterDataViewInstancer(DataViewInstancer* instancer, const String& name, bool is_structural_view)
  501. {
  502. bool inserted = false;
  503. if (is_structural_view)
  504. {
  505. inserted = structural_data_view_instancers.emplace(name, instancer).second;
  506. if (inserted)
  507. structural_data_view_attribute_names.push_back(String("data-") + name);
  508. }
  509. else
  510. {
  511. inserted = data_view_instancers.emplace(name, instancer).second;
  512. }
  513. if (!inserted)
  514. Log::Message(Log::LT_WARNING, "Could not register data view instancer '%s'. The given name is already registered.", name.c_str());
  515. }
  516. void Factory::RegisterDataControllerInstancer(DataControllerInstancer* instancer, const String& name)
  517. {
  518. bool inserted = data_controller_instancers.emplace(name, instancer).second;
  519. if (!inserted)
  520. Log::Message(Log::LT_WARNING, "Could not register data controller instancer '%s'. The given name is already registered.", name.c_str());
  521. }
  522. DataViewPtr Factory::InstanceDataView(const String& type_name, Element* element, bool is_structural_view)
  523. {
  524. RMLUI_ASSERT(element);
  525. if (is_structural_view)
  526. {
  527. auto it = structural_data_view_instancers.find(type_name);
  528. if (it != structural_data_view_instancers.end())
  529. return it->second->InstanceView(element);
  530. }
  531. else
  532. {
  533. auto it = data_view_instancers.find(type_name);
  534. if (it != data_view_instancers.end())
  535. return it->second->InstanceView(element);
  536. }
  537. return nullptr;
  538. }
  539. DataControllerPtr Factory::InstanceDataController(const String& type_name, Element* element)
  540. {
  541. auto it = data_controller_instancers.find(type_name);
  542. if (it != data_controller_instancers.end())
  543. return it->second->InstanceController(element);
  544. return DataControllerPtr();
  545. }
  546. bool Factory::IsStructuralDataView(const String& type_name)
  547. {
  548. return structural_data_view_instancers.find(type_name) != structural_data_view_instancers.end();
  549. }
  550. const StringList& Factory::GetStructuralDataViewAttributeNames()
  551. {
  552. return structural_data_view_attribute_names;
  553. }
  554. } // namespace Rml