Factory.cpp 23 KB

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