WidgetTextInput.cpp 32 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114
  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 "WidgetTextInput.h"
  29. #include "ElementTextSelection.h"
  30. #include "../../Include/RmlUi/Core.h"
  31. #include "../../Include/RmlUi/Controls/ElementFormControl.h"
  32. #include "../../Include/RmlUi/Core/SystemInterface.h"
  33. #include "../../Include/RmlUi/Core/StringUtilities.h"
  34. #include "../Core/Clock.h"
  35. namespace Rml {
  36. namespace Controls {
  37. static const float CURSOR_BLINK_TIME = 0.7f;
  38. WidgetTextInput::WidgetTextInput(ElementFormControl* _parent) : internal_dimensions(0, 0), scroll_offset(0, 0), selection_geometry(_parent), cursor_position(0, 0), cursor_size(0, 0), cursor_geometry(_parent)
  39. {
  40. keyboard_showed = false;
  41. parent = _parent;
  42. parent->SetProperty(Core::PropertyId::WhiteSpace, Core::Property(Core::Style::WhiteSpace::Pre));
  43. parent->SetProperty(Core::PropertyId::OverflowX, Core::Property(Core::Style::Overflow::Hidden));
  44. parent->SetProperty(Core::PropertyId::OverflowY, Core::Property(Core::Style::Overflow::Hidden));
  45. parent->SetProperty(Core::PropertyId::Drag, Core::Property(Core::Style::Drag::Drag));
  46. parent->SetClientArea(Rml::Core::Box::CONTENT);
  47. parent->AddEventListener(Core::EventId::Keydown, this, true);
  48. parent->AddEventListener(Core::EventId::Textinput, this, true);
  49. parent->AddEventListener(Core::EventId::Focus, this, true);
  50. parent->AddEventListener(Core::EventId::Blur, this, true);
  51. parent->AddEventListener(Core::EventId::Mousedown, this, true);
  52. parent->AddEventListener(Core::EventId::Drag, this, true);
  53. Core::ElementPtr unique_text = Core::Factory::InstanceElement(parent, "#text", "#text", Rml::Core::XMLAttributes());
  54. text_element = dynamic_cast< Core::ElementText* >(unique_text.get());
  55. Core::ElementPtr unique_selected_text = Core::Factory::InstanceElement(parent, "#text", "#text", Rml::Core::XMLAttributes());
  56. selected_text_element = dynamic_cast< Core::ElementText* >(unique_selected_text.get());
  57. if (text_element)
  58. {
  59. text_element->SuppressAutoLayout();
  60. parent->AppendChild(std::move(unique_text), false);
  61. selected_text_element->SuppressAutoLayout();
  62. parent->AppendChild(std::move(unique_selected_text), false);
  63. }
  64. // Create the dummy selection element.
  65. Core::ElementPtr unique_selection = Core::Factory::InstanceElement(parent, "#selection", "selection", Rml::Core::XMLAttributes());
  66. if (ElementTextSelection* text_selection_element = dynamic_cast<ElementTextSelection*>(unique_selection.get()))
  67. {
  68. selection_element = text_selection_element;
  69. text_selection_element->SetWidget(this);
  70. parent->AppendChild(std::move(unique_selection), false);
  71. }
  72. edit_index = 0;
  73. absolute_cursor_index = 0;
  74. cursor_line_index = 0;
  75. cursor_character_index = 0;
  76. ideal_cursor_position = 0;
  77. max_length = -1;
  78. selection_anchor_index = 0;
  79. selection_begin_index = 0;
  80. selection_length = 0;
  81. last_update_time = 0;
  82. ShowCursor(false);
  83. }
  84. WidgetTextInput::~WidgetTextInput()
  85. {
  86. parent->RemoveEventListener(Core::EventId::Keydown, this, true);
  87. parent->RemoveEventListener(Core::EventId::Textinput, this, true);
  88. parent->RemoveEventListener(Core::EventId::Focus, this, true);
  89. parent->RemoveEventListener(Core::EventId::Blur, this, true);
  90. parent->RemoveEventListener(Core::EventId::Mousedown, this, true);
  91. parent->RemoveEventListener(Core::EventId::Drag, this, true);
  92. // Remove all the children added by the text widget.
  93. parent->RemoveChild(text_element);
  94. parent->RemoveChild(selected_text_element);
  95. parent->RemoveChild(selection_element);
  96. }
  97. // Sets the value of the text field.
  98. void WidgetTextInput::SetValue(const Core::String& value)
  99. {
  100. text_element->SetText(value);
  101. FormatElement();
  102. UpdateRelativeCursor();
  103. }
  104. // Sets the maximum length (in characters) of this text field.
  105. void WidgetTextInput::SetMaxLength(int _max_length)
  106. {
  107. if (max_length != _max_length)
  108. {
  109. max_length = _max_length;
  110. if (max_length >= 0)
  111. {
  112. Core::String value = GetElement()->GetAttribute< Rml::Core::String >("value", "");
  113. int num_characters = 0;
  114. size_t i_erase = value.size();
  115. for (auto it = Core::StringIteratorU8(value); it; ++it)
  116. {
  117. num_characters += 1;
  118. if (num_characters > max_length)
  119. {
  120. i_erase = size_t(it.Offset());
  121. break;
  122. }
  123. }
  124. if(i_erase < value.size())
  125. {
  126. value.erase(i_erase);
  127. GetElement()->SetAttribute("value", value);
  128. }
  129. }
  130. }
  131. }
  132. // Returns the maximum length (in characters) of this text field.
  133. int WidgetTextInput::GetMaxLength() const
  134. {
  135. return max_length;
  136. }
  137. int WidgetTextInput::GetLength() const
  138. {
  139. Core::String value = GetElement()->GetAttribute< Core::String >("value", "");
  140. size_t result = Core::StringUtilities::LengthUTF8(value);
  141. return (int)result;
  142. }
  143. // Update the colours of the selected text.
  144. void WidgetTextInput::UpdateSelectionColours()
  145. {
  146. // Determine what the colour of the selected text is. If our 'selection' element has the 'color'
  147. // attribute set, then use that. Otherwise, use the inverse of our own text colour.
  148. Rml::Core::Colourb colour;
  149. const Rml::Core::Property* colour_property = selection_element->GetLocalProperty("color");
  150. if (colour_property != nullptr)
  151. colour = colour_property->Get< Rml::Core::Colourb >();
  152. else
  153. {
  154. colour = parent->GetComputedValues().color;
  155. colour.red = 255 - colour.red;
  156. colour.green = 255 - colour.green;
  157. colour.blue = 255 - colour.blue;
  158. }
  159. // Set the computed text colour on the element holding the selected text.
  160. selected_text_element->SetProperty(Core::PropertyId::Color, Rml::Core::Property(colour, Rml::Core::Property::COLOUR));
  161. // If the 'background-color' property has been set on the 'selection' element, use that as the
  162. // background colour for the selected text. Otherwise, use the inverse of the selected text
  163. // colour.
  164. colour_property = selection_element->GetLocalProperty("background-color");
  165. if (colour_property != nullptr)
  166. selection_colour = colour_property->Get< Rml::Core::Colourb >();
  167. else
  168. selection_colour = Rml::Core::Colourb(255 - colour.red, 255 - colour.green, 255 - colour.blue, colour.alpha);
  169. }
  170. // Updates the cursor, if necessary.
  171. void WidgetTextInput::OnUpdate()
  172. {
  173. if (cursor_timer > 0)
  174. {
  175. double current_time = Core::Clock::GetElapsedTime();
  176. cursor_timer -= float(current_time - last_update_time);
  177. last_update_time = current_time;
  178. while (cursor_timer <= 0)
  179. {
  180. cursor_timer += CURSOR_BLINK_TIME;
  181. cursor_visible = !cursor_visible;
  182. }
  183. }
  184. }
  185. void WidgetTextInput::OnResize()
  186. {
  187. GenerateCursor();
  188. Rml::Core::Vector2f text_position = parent->GetBox().GetPosition(Core::Box::CONTENT);
  189. text_element->SetOffset(text_position, parent);
  190. selected_text_element->SetOffset(text_position, parent);
  191. Rml::Core::Vector2f new_internal_dimensions = parent->GetBox().GetSize(Core::Box::CONTENT);
  192. if (new_internal_dimensions != internal_dimensions)
  193. {
  194. internal_dimensions = new_internal_dimensions;
  195. FormatElement();
  196. UpdateCursorPosition();
  197. }
  198. }
  199. // Renders the cursor, if it is visible.
  200. void WidgetTextInput::OnRender()
  201. {
  202. Core::ElementUtilities::SetClippingRegion(text_element);
  203. Rml::Core::Vector2f text_translation = parent->GetAbsoluteOffset() - Rml::Core::Vector2f(parent->GetScrollLeft(), parent->GetScrollTop());
  204. selection_geometry.Render(text_translation);
  205. if (cursor_visible &&
  206. !parent->IsDisabled())
  207. {
  208. cursor_geometry.Render(text_translation + cursor_position);
  209. }
  210. }
  211. // Formats the widget's internal content.
  212. void WidgetTextInput::OnLayout()
  213. {
  214. FormatElement();
  215. parent->SetScrollLeft(scroll_offset.x);
  216. parent->SetScrollTop(scroll_offset.y);
  217. }
  218. // Returns the input element's underlying text element.
  219. Core::ElementText* WidgetTextInput::GetTextElement()
  220. {
  221. return text_element;
  222. }
  223. // Returns the input element's maximum allowed text dimensions.
  224. const Rml::Core::Vector2f& WidgetTextInput::GetTextDimensions() const
  225. {
  226. return internal_dimensions;
  227. }
  228. // Gets the parent element containing the widget.
  229. Core::Element* WidgetTextInput::GetElement() const
  230. {
  231. return parent;
  232. }
  233. // Dispatches a change event to the widget's element.
  234. void WidgetTextInput::DispatchChangeEvent(bool linebreak)
  235. {
  236. Rml::Core::Dictionary parameters;
  237. parameters["value"] = GetElement()->GetAttribute< Rml::Core::String >("value", "");
  238. parameters["linebreak"] = Core::Variant(linebreak);
  239. GetElement()->DispatchEvent(Core::EventId::Change, parameters);
  240. }
  241. // Processes the "keydown" and "textinput" event to write to the input field, and the "focus" and "blur" to set
  242. // the state of the cursor.
  243. void WidgetTextInput::ProcessEvent(Core::Event& event)
  244. {
  245. if (parent->IsDisabled())
  246. return;
  247. using Rml::Core::EventId;
  248. switch (event.GetId())
  249. {
  250. case EventId::Keydown:
  251. {
  252. Core::Input::KeyIdentifier key_identifier = (Core::Input::KeyIdentifier) event.GetParameter< int >("key_identifier", 0);
  253. bool numlock = event.GetParameter< int >("num_lock_key", 0) > 0;
  254. bool shift = event.GetParameter< int >("shift_key", 0) > 0;
  255. bool ctrl = event.GetParameter< int >("ctrl_key", 0) > 0;
  256. switch (key_identifier)
  257. {
  258. case Core::Input::KI_NUMPAD4: if (numlock) break;
  259. case Core::Input::KI_LEFT: MoveCursorHorizontal(ctrl ? CursorMovement::PreviousWord : CursorMovement::Left, shift); break;
  260. case Core::Input::KI_NUMPAD6: if (numlock) break;
  261. case Core::Input::KI_RIGHT: MoveCursorHorizontal(ctrl ? CursorMovement::NextWord : CursorMovement::Right, shift); break;
  262. case Core::Input::KI_NUMPAD8: if (numlock) break;
  263. case Core::Input::KI_UP: MoveCursorVertical(-1, shift); break;
  264. case Core::Input::KI_NUMPAD2: if (numlock) break;
  265. case Core::Input::KI_DOWN: MoveCursorVertical(1, shift); break;
  266. case Core::Input::KI_NUMPAD7: if (numlock) break;
  267. case Core::Input::KI_HOME: MoveCursorHorizontal(CursorMovement::BeginLine, shift); break;
  268. case Core::Input::KI_NUMPAD1: if (numlock) break;
  269. case Core::Input::KI_END: MoveCursorHorizontal(CursorMovement::EndLine, shift); break;
  270. case Core::Input::KI_BACK:
  271. {
  272. if (DeleteCharacter(true))
  273. {
  274. FormatElement();
  275. UpdateRelativeCursor();
  276. }
  277. ShowCursor(true);
  278. }
  279. break;
  280. case Core::Input::KI_DECIMAL: if (numlock) break;
  281. case Core::Input::KI_DELETE:
  282. {
  283. if (DeleteCharacter(false))
  284. {
  285. FormatElement();
  286. UpdateRelativeCursor();
  287. }
  288. ShowCursor(true);
  289. }
  290. break;
  291. case Core::Input::KI_NUMPADENTER:
  292. case Core::Input::KI_RETURN:
  293. {
  294. LineBreak();
  295. }
  296. break;
  297. case Core::Input::KI_C:
  298. {
  299. if (ctrl)
  300. CopySelection();
  301. }
  302. break;
  303. case Core::Input::KI_X:
  304. {
  305. if (ctrl)
  306. {
  307. CopySelection();
  308. DeleteSelection();
  309. }
  310. }
  311. break;
  312. case Core::Input::KI_V:
  313. {
  314. if (ctrl)
  315. {
  316. Core::String clipboard_text;
  317. Core::GetSystemInterface()->GetClipboardText(clipboard_text);
  318. // @performance: Can be made heaps faster.
  319. for (auto it = Core::StringIteratorU8(clipboard_text); it; ++it)
  320. {
  321. Core::Character character = *it;
  322. AddCharacter(character);
  323. }
  324. }
  325. }
  326. break;
  327. // Ignore tabs so input fields can be navigated through with keys.
  328. case Core::Input::KI_TAB:
  329. return;
  330. default:
  331. break;
  332. }
  333. event.StopPropagation();
  334. }
  335. break;
  336. case EventId::Textinput:
  337. {
  338. // Only process the text if no modifier keys are pressed.
  339. if (event.GetParameter< int >("ctrl_key", 0) == 0 &&
  340. event.GetParameter< int >("alt_key", 0) == 0 &&
  341. event.GetParameter< int >("meta_key", 0) == 0)
  342. {
  343. Core::String text = event.GetParameter("text", Core::String{});
  344. // @performance: Can be made heaps faster.
  345. for (auto it = Core::StringIteratorU8(text); it; ++it)
  346. {
  347. Core::Character character = *it;
  348. AddCharacter(character);
  349. }
  350. }
  351. ShowCursor(true);
  352. event.StopPropagation();
  353. }
  354. break;
  355. case EventId::Focus:
  356. {
  357. if (event.GetTargetElement() == parent)
  358. {
  359. UpdateSelection(false);
  360. ShowCursor(true, false);
  361. }
  362. }
  363. break;
  364. case EventId::Blur:
  365. {
  366. if (event.GetTargetElement() == parent)
  367. {
  368. ClearSelection();
  369. ShowCursor(false, false);
  370. }
  371. }
  372. break;
  373. case EventId::Mousedown:
  374. case EventId::Drag:
  375. {
  376. if (event.GetTargetElement() == parent)
  377. {
  378. Core::Vector2f mouse_position = Core::Vector2f(event.GetParameter< float >("mouse_x", 0), event.GetParameter< float >("mouse_y", 0));
  379. mouse_position -= text_element->GetAbsoluteOffset();
  380. cursor_line_index = CalculateLineIndex(mouse_position.y);
  381. cursor_character_index = CalculateCharacterIndex(cursor_line_index, mouse_position.x);
  382. UpdateAbsoluteCursor();
  383. MoveCursorToCharacterBoundaries(false);
  384. UpdateCursorPosition();
  385. ideal_cursor_position = cursor_position.x;
  386. UpdateSelection(event == Core::EventId::Drag || event.GetParameter< int >("shift_key", 0) > 0);
  387. ShowCursor(true);
  388. }
  389. }
  390. break;
  391. default:
  392. break;
  393. }
  394. }
  395. // Adds a new character to the string at the cursor position.
  396. bool WidgetTextInput::AddCharacter(Rml::Core::Character character)
  397. {
  398. if ((char32_t)character <= 127 && !IsCharacterValid(static_cast<char>(character)))
  399. return false;
  400. if (selection_length > 0)
  401. DeleteSelection();
  402. if (max_length >= 0 && GetLength() >= max_length)
  403. return false;
  404. Core::String value = GetElement()->GetAttribute< Rml::Core::String >("value", "");
  405. Core::String insert = Core::StringUtilities::ToUTF8(character);
  406. value.insert(GetCursorIndex(), insert);
  407. edit_index += (int)insert.size();
  408. GetElement()->SetAttribute("value", value);
  409. DispatchChangeEvent();
  410. UpdateSelection(false);
  411. return true;
  412. }
  413. // Deletes a character from the string.
  414. bool WidgetTextInput::DeleteCharacter(bool back)
  415. {
  416. // We set a selection of the next or previous character, and then delete it.
  417. // If we already have a selection, we delete that first.
  418. if (selection_length <= 0)
  419. MoveCursorHorizontal(back ? CursorMovement::Left : CursorMovement::Right, true);
  420. if (selection_length > 0)
  421. {
  422. DeleteSelection();
  423. DispatchChangeEvent();
  424. UpdateSelection(false);
  425. return true;
  426. }
  427. return false;
  428. }
  429. // Copies the selection (if any) to the clipboard.
  430. void WidgetTextInput::CopySelection()
  431. {
  432. const Core::String& value = GetElement()->GetAttribute< Rml::Core::String >("value", "");
  433. const Core::String snippet = value.substr(selection_begin_index, selection_length);
  434. Core::GetSystemInterface()->SetClipboardText(snippet);
  435. }
  436. // Returns the absolute index of the cursor.
  437. int WidgetTextInput::GetCursorIndex() const
  438. {
  439. return edit_index;
  440. }
  441. // Moves the cursor along the current line.
  442. void WidgetTextInput::MoveCursorHorizontal(CursorMovement movement, bool select)
  443. {
  444. const auto is_nonword_character = [](char c) -> bool {
  445. return Core::StringUtilities::IsWhitespace(c) || (c >= '!' && c <= '@');
  446. };
  447. // Whether to seek forward or back to align to utf8 boundaries later.
  448. bool seek_forward = false;
  449. switch (movement)
  450. {
  451. case CursorMovement::BeginLine:
  452. absolute_cursor_index -= cursor_character_index;
  453. break;
  454. case CursorMovement::PreviousWord:
  455. if (cursor_character_index <= 1)
  456. {
  457. absolute_cursor_index -= 1;
  458. }
  459. else
  460. {
  461. bool whitespace_found = false;
  462. const char* p_rend = lines[cursor_line_index].content.data();
  463. const char* p_rbegin = p_rend + cursor_character_index;
  464. const char* p = p_rbegin - 1;
  465. for (; p > p_rend; --p)
  466. {
  467. bool is_whitespace = is_nonword_character(*p);
  468. if(whitespace_found && !is_whitespace)
  469. break;
  470. else if(!whitespace_found && is_whitespace)
  471. whitespace_found = true;
  472. }
  473. if (p != p_rend) ++p;
  474. absolute_cursor_index += int(p - p_rbegin);
  475. }
  476. break;
  477. case CursorMovement::Left:
  478. absolute_cursor_index -= 1;
  479. break;
  480. case CursorMovement::Right:
  481. seek_forward = true;
  482. absolute_cursor_index += 1;
  483. break;
  484. case CursorMovement::NextWord:
  485. if (cursor_character_index >= lines[cursor_line_index].content_length)
  486. {
  487. absolute_cursor_index += 1;
  488. }
  489. else
  490. {
  491. bool whitespace_found = false;
  492. const char* p_begin = lines[cursor_line_index].content.data() + cursor_character_index;
  493. const char* p_end = lines[cursor_line_index].content.data() + lines[cursor_line_index].content_length;
  494. const char* p = p_begin;
  495. for (; p < p_end; ++p)
  496. {
  497. bool is_whitespace = is_nonword_character(*p);
  498. if (whitespace_found && !is_whitespace)
  499. break;
  500. else if (!whitespace_found && is_whitespace)
  501. whitespace_found = true;
  502. }
  503. absolute_cursor_index += int(p - p_begin);
  504. }
  505. break;
  506. case CursorMovement::EndLine:
  507. absolute_cursor_index += lines[cursor_line_index].content_length - cursor_character_index;
  508. break;
  509. default:
  510. break;
  511. }
  512. absolute_cursor_index = Rml::Core::Math::Max(0, absolute_cursor_index);
  513. UpdateRelativeCursor();
  514. MoveCursorToCharacterBoundaries(seek_forward);
  515. ideal_cursor_position = cursor_position.x;
  516. UpdateSelection(select);
  517. ShowCursor(true);
  518. }
  519. // Moves the cursor up and down the text field.
  520. void WidgetTextInput::MoveCursorVertical(int distance, bool select)
  521. {
  522. bool update_ideal_cursor_position = false;
  523. cursor_line_index += distance;
  524. if (cursor_line_index < 0)
  525. {
  526. cursor_line_index = 0;
  527. cursor_character_index = 0;
  528. update_ideal_cursor_position = true;
  529. }
  530. else if (cursor_line_index >= (int) lines.size())
  531. {
  532. cursor_line_index = (int) lines.size() - 1;
  533. cursor_character_index = (int) lines[cursor_line_index].content_length;
  534. update_ideal_cursor_position = true;
  535. }
  536. else
  537. cursor_character_index = CalculateCharacterIndex(cursor_line_index, ideal_cursor_position);
  538. UpdateAbsoluteCursor();
  539. MoveCursorToCharacterBoundaries(false);
  540. UpdateCursorPosition();
  541. if (update_ideal_cursor_position)
  542. ideal_cursor_position = cursor_position.x;
  543. UpdateSelection(select);
  544. ShowCursor(true);
  545. }
  546. void WidgetTextInput::MoveCursorToCharacterBoundaries(bool forward)
  547. {
  548. const char* p_line_begin = lines[cursor_line_index].content.data();
  549. const char* p_line_end = p_line_begin + lines[cursor_line_index].content_length;
  550. const char* p_cursor = p_line_begin + cursor_character_index;
  551. const char* p = p_cursor;
  552. if (forward)
  553. p = Core::StringUtilities::SeekForwardUTF8(p_cursor, p_line_end);
  554. else
  555. p = Core::StringUtilities::SeekBackwardUTF8(p_cursor, p_line_begin);
  556. if (p != p_cursor)
  557. {
  558. absolute_cursor_index += int(p - p_cursor);
  559. UpdateRelativeCursor();
  560. }
  561. }
  562. // Updates the absolute cursor index from the relative cursor indices.
  563. void WidgetTextInput::UpdateAbsoluteCursor()
  564. {
  565. RMLUI_ASSERT(cursor_line_index < (int) lines.size())
  566. absolute_cursor_index = cursor_character_index;
  567. edit_index = cursor_character_index;
  568. for (int i = 0; i < cursor_line_index; i++)
  569. {
  570. absolute_cursor_index += (int)lines[i].content.size();
  571. edit_index += (int)lines[i].content.size() + lines[i].extra_characters;
  572. }
  573. }
  574. // Updates the relative cursor indices from the absolute cursor index.
  575. void WidgetTextInput::UpdateRelativeCursor()
  576. {
  577. int num_characters = 0;
  578. edit_index = absolute_cursor_index;
  579. for (size_t i = 0; i < lines.size(); i++)
  580. {
  581. if (num_characters + lines[i].content_length >= absolute_cursor_index)
  582. {
  583. cursor_line_index = (int) i;
  584. cursor_character_index = absolute_cursor_index - num_characters;
  585. UpdateCursorPosition();
  586. return;
  587. }
  588. num_characters += (int) lines[i].content.size();
  589. edit_index += lines[i].extra_characters;
  590. }
  591. // We shouldn't ever get here; this means we actually couldn't find where the absolute cursor said it was. So we'll
  592. // just set the relative cursors to the very end of the text field, and update the absolute cursor to point here.
  593. cursor_line_index = (int) lines.size() - 1;
  594. cursor_character_index = lines[cursor_line_index].content_length;
  595. absolute_cursor_index = num_characters;
  596. edit_index = num_characters;
  597. UpdateCursorPosition();
  598. }
  599. // Calculates the line index under a specific vertical position.
  600. int WidgetTextInput::CalculateLineIndex(float position)
  601. {
  602. float line_height = parent->GetLineHeight();
  603. int line_index = Rml::Core::Math::RealToInteger(position / line_height);
  604. return Rml::Core::Math::Clamp(line_index, 0, (int) (lines.size() - 1));
  605. }
  606. // Calculates the character index along a line under a specific horizontal position.
  607. int WidgetTextInput::CalculateCharacterIndex(int line_index, float position)
  608. {
  609. int prev_offset = 0;
  610. float prev_line_width = 0;
  611. for(auto it = Core::StringIteratorU8(lines[line_index].content, 0, lines[line_index].content_length); it; )
  612. {
  613. ++it;
  614. int offset = (int)it.Offset();
  615. float line_width = (float) Core::ElementUtilities::GetStringWidth(text_element, lines[line_index].content.substr(0, offset));
  616. if (line_width > position)
  617. {
  618. if (position - prev_line_width < line_width - position)
  619. return prev_offset;
  620. else
  621. return offset;
  622. }
  623. prev_line_width = line_width;
  624. prev_offset = offset;
  625. }
  626. return prev_offset;
  627. }
  628. // Shows or hides the cursor.
  629. void WidgetTextInput::ShowCursor(bool show, bool move_to_cursor)
  630. {
  631. if (show)
  632. {
  633. cursor_visible = true;
  634. SetKeyboardActive(true);
  635. keyboard_showed = true;
  636. cursor_timer = CURSOR_BLINK_TIME;
  637. last_update_time = Core::GetSystemInterface()->GetElapsedTime();
  638. // Shift the cursor into view.
  639. if (move_to_cursor)
  640. {
  641. float minimum_scroll_top = (cursor_position.y + cursor_size.y) - parent->GetClientHeight();
  642. if (parent->GetScrollTop() < minimum_scroll_top)
  643. parent->SetScrollTop(minimum_scroll_top);
  644. else if (parent->GetScrollTop() > cursor_position.y)
  645. parent->SetScrollTop(cursor_position.y);
  646. float minimum_scroll_left = (cursor_position.x + cursor_size.x) - parent->GetClientWidth();
  647. if (parent->GetScrollLeft() < minimum_scroll_left)
  648. parent->SetScrollLeft(minimum_scroll_left);
  649. else if (parent->GetScrollLeft() > cursor_position.x)
  650. parent->SetScrollLeft(cursor_position.x);
  651. scroll_offset.x = parent->GetScrollLeft();
  652. scroll_offset.y = parent->GetScrollTop();
  653. }
  654. }
  655. else
  656. {
  657. cursor_visible = false;
  658. cursor_timer = -1;
  659. last_update_time = 0;
  660. if (keyboard_showed)
  661. {
  662. SetKeyboardActive(false);
  663. keyboard_showed = false;
  664. }
  665. }
  666. }
  667. // Formats the element, laying out the text and inserting scrollbars as appropriate.
  668. void WidgetTextInput::FormatElement()
  669. {
  670. using namespace Core::Style;
  671. Core::ElementScroll* scroll = parent->GetElementScroll();
  672. float width = parent->GetBox().GetSize(Core::Box::PADDING).x;
  673. Overflow x_overflow_property = parent->GetComputedValues().overflow_x;
  674. Overflow y_overflow_property = parent->GetComputedValues().overflow_y;
  675. if (x_overflow_property == Overflow::Scroll)
  676. scroll->EnableScrollbar(Core::ElementScroll::HORIZONTAL, width);
  677. else
  678. scroll->DisableScrollbar(Core::ElementScroll::HORIZONTAL);
  679. if (y_overflow_property == Overflow::Scroll)
  680. scroll->EnableScrollbar(Core::ElementScroll::VERTICAL, width);
  681. else
  682. scroll->DisableScrollbar(Core::ElementScroll::VERTICAL);
  683. // Format the text and determine its total area.
  684. Rml::Core::Vector2f content_area = FormatText();
  685. // If we're set to automatically generate horizontal scrollbars, check for that now.
  686. if (x_overflow_property == Overflow::Auto)
  687. {
  688. if (parent->GetClientWidth() < content_area.x)
  689. scroll->EnableScrollbar(Core::ElementScroll::HORIZONTAL, width);
  690. }
  691. // Now check for vertical overflow. If we do turn on the scrollbar, this will cause a reflow.
  692. if (y_overflow_property == Overflow::Auto)
  693. {
  694. if (parent->GetClientHeight() < content_area.y)
  695. {
  696. scroll->EnableScrollbar(Core::ElementScroll::VERTICAL, width);
  697. content_area = FormatText();
  698. if (x_overflow_property == Overflow::Auto &&
  699. parent->GetClientWidth() < content_area.y)
  700. {
  701. scroll->EnableScrollbar(Core::ElementScroll::HORIZONTAL, width);
  702. }
  703. }
  704. }
  705. parent->SetContentBox(Rml::Core::Vector2f(0, 0), content_area);
  706. scroll->FormatScrollbars();
  707. }
  708. // Formats the input element's text field.
  709. Rml::Core::Vector2f WidgetTextInput::FormatText()
  710. {
  711. absolute_cursor_index = edit_index;
  712. Rml::Core::Vector2f content_area(0, 0);
  713. // Clear the old lines, and all the lines in the text elements.
  714. lines.clear();
  715. text_element->ClearLines();
  716. selected_text_element->ClearLines();
  717. // Clear the selection background geometry, and get the vertices and indices so the new geo can
  718. // be generated.
  719. selection_geometry.Release(true);
  720. std::vector< Core::Vertex >& selection_vertices = selection_geometry.GetVertices();
  721. std::vector< int >& selection_indices = selection_geometry.GetIndices();
  722. // Determine the line-height of the text element.
  723. float line_height = parent->GetLineHeight();
  724. int line_begin = 0;
  725. Rml::Core::Vector2f line_position(0, 0);
  726. bool last_line = false;
  727. // Keep generating lines until all the text content is placed.
  728. do
  729. {
  730. Line line;
  731. line.extra_characters = 0;
  732. float line_width;
  733. // Generate the next line.
  734. last_line = text_element->GenerateLine(line.content, line.content_length, line_width, line_begin, parent->GetClientWidth() - cursor_size.x, 0, false);
  735. // If this line terminates in a soft-return, then the line may be leaving a space or two behind as an orphan.
  736. // If so, we must append the orphan onto the line even though it will push the line outside of the input
  737. // field's bounds.
  738. bool soft_return = false;
  739. if (!last_line &&
  740. (line.content.empty() ||
  741. line.content[line.content.size() - 1] != '\n'))
  742. {
  743. soft_return = true;
  744. const Core::String& text = text_element->GetText();
  745. Core::String orphan;
  746. for (int i = 1; i >= 0; --i)
  747. {
  748. int index = line_begin + line.content_length + i;
  749. if (index >= (int) text.size())
  750. continue;
  751. if (text[index] != ' ')
  752. {
  753. orphan.clear();
  754. continue;
  755. }
  756. int next_index = index + 1;
  757. if (!orphan.empty() ||
  758. next_index >= (int) text.size() ||
  759. text[next_index] != ' ')
  760. orphan += ' ';
  761. }
  762. if (!orphan.empty())
  763. {
  764. line.content += orphan;
  765. line.content_length += (int) orphan.size();
  766. line_width += Core::ElementUtilities::GetStringWidth(text_element, orphan);
  767. }
  768. }
  769. // Now that we have the string of characters appearing on the new line, we split it into
  770. // three parts; the unselected text appearing before any selected text on the line, the
  771. // selected text on the line, and any unselected text after the selection.
  772. Core::String pre_selection, selection, post_selection;
  773. GetLineSelection(pre_selection, selection, post_selection, line.content, line_begin);
  774. // The pre-selected text is placed, if there is any (if the selection starts on or before
  775. // the beginning of this line, then this will be empty).
  776. if (!pre_selection.empty())
  777. {
  778. text_element->AddLine(line_position, pre_selection);
  779. line_position.x += Core::ElementUtilities::GetStringWidth(text_element, pre_selection);
  780. }
  781. // If there is any selected text on this line, place it in the selected text element and
  782. // generate the geometry for its background.
  783. if (!selection.empty())
  784. {
  785. selected_text_element->AddLine(line_position, selection);
  786. int selection_width = Core::ElementUtilities::GetStringWidth(selected_text_element, selection);
  787. selection_vertices.resize(selection_vertices.size() + 4);
  788. selection_indices.resize(selection_indices.size() + 6);
  789. Core::GeometryUtilities::GenerateQuad(&selection_vertices[selection_vertices.size() - 4], &selection_indices[selection_indices.size() - 6], line_position, Rml::Core::Vector2f((float)selection_width, line_height), selection_colour, (int)selection_vertices.size() - 4);
  790. line_position.x += selection_width;
  791. }
  792. // If there is any unselected text after the selection on this line, place it in the
  793. // standard text element after the selected text.
  794. if (!post_selection.empty())
  795. text_element->AddLine(line_position, post_selection);
  796. // Update variables for the next line.
  797. line_begin += line.content_length;
  798. line_position.x = 0;
  799. line_position.y += line_height;
  800. // Grow the content area width-wise if this line is the longest so far, and push the
  801. // height out.
  802. content_area.x = Rml::Core::Math::Max(content_area.x, line_width + cursor_size.x);
  803. content_area.y = line_position.y;
  804. // Push a trailing '\r' token onto the back to indicate a soft return if necessary.
  805. if (soft_return)
  806. {
  807. line.content += '\r';
  808. line.extra_characters -= 1;
  809. if (edit_index >= line_begin)
  810. absolute_cursor_index += 1;
  811. }
  812. // Push the new line into our array of lines, but first check if its content length needs to be truncated to
  813. // dodge a trailing endline.
  814. if (!line.content.empty() &&
  815. line.content[line.content.size() - 1] == '\n')
  816. line.content_length -= 1;
  817. lines.push_back(line);
  818. }
  819. while (!last_line);
  820. return content_area;
  821. }
  822. // Generates the text cursor.
  823. void WidgetTextInput::GenerateCursor()
  824. {
  825. // Generates the cursor.
  826. cursor_geometry.Release();
  827. std::vector< Core::Vertex >& vertices = cursor_geometry.GetVertices();
  828. vertices.resize(4);
  829. std::vector< int >& indices = cursor_geometry.GetIndices();
  830. indices.resize(6);
  831. cursor_size.x = Core::ElementUtilities::GetDensityIndependentPixelRatio(text_element);
  832. cursor_size.y = text_element->GetLineHeight() + 2.0f;
  833. Core::GeometryUtilities::GenerateQuad(&vertices[0], &indices[0], Rml::Core::Vector2f(0, 0), cursor_size, parent->GetProperty< Rml::Core::Colourb >("color"));
  834. }
  835. void WidgetTextInput::UpdateCursorPosition()
  836. {
  837. if (text_element->GetFontFaceHandle() == 0)
  838. return;
  839. cursor_position.x = (float) Core::ElementUtilities::GetStringWidth(text_element, lines[cursor_line_index].content.substr(0, cursor_character_index));
  840. cursor_position.y = -1.f + (float)cursor_line_index * text_element->GetLineHeight();
  841. }
  842. // Expand the text selection to the position of the cursor.
  843. void WidgetTextInput::UpdateSelection(bool selecting)
  844. {
  845. if (!selecting)
  846. {
  847. selection_anchor_index = edit_index;
  848. ClearSelection();
  849. }
  850. else
  851. {
  852. int new_begin_index;
  853. int new_end_index;
  854. if (edit_index > selection_anchor_index)
  855. {
  856. new_begin_index = selection_anchor_index;
  857. new_end_index = edit_index;
  858. }
  859. else
  860. {
  861. new_begin_index = edit_index;
  862. new_end_index = selection_anchor_index;
  863. }
  864. if (new_begin_index != selection_begin_index ||
  865. new_end_index - new_begin_index != selection_length)
  866. {
  867. selection_begin_index = new_begin_index;
  868. selection_length = new_end_index - new_begin_index;
  869. FormatText();
  870. }
  871. }
  872. }
  873. // Removes the selection of text.
  874. void WidgetTextInput::ClearSelection()
  875. {
  876. if (selection_length > 0)
  877. {
  878. selection_length = 0;
  879. FormatElement();
  880. }
  881. }
  882. // Deletes all selected text and removes the selection.
  883. void WidgetTextInput::DeleteSelection()
  884. {
  885. if (selection_length > 0)
  886. {
  887. const Core::String& value = GetElement()->GetAttribute< Rml::Core::String >("value", "");
  888. Rml::Core::String new_value = value.substr(0, selection_begin_index) + value.substr(selection_begin_index + selection_length);
  889. GetElement()->SetAttribute("value", new_value);
  890. // Move the cursor to the beginning of the old selection.
  891. absolute_cursor_index = selection_begin_index;
  892. UpdateRelativeCursor();
  893. // Erase our record of the selection.
  894. ClearSelection();
  895. }
  896. }
  897. // Split one line of text into three parts, based on the current selection.
  898. void WidgetTextInput::GetLineSelection(Core::String& pre_selection, Core::String& selection, Core::String& post_selection, const Core::String& line, int line_begin)
  899. {
  900. // Check if we have any selection at all, and if so if the selection is on this line.
  901. if (selection_length <= 0 ||
  902. selection_begin_index + selection_length < line_begin ||
  903. selection_begin_index > line_begin + (int) line.size())
  904. {
  905. pre_selection = line;
  906. return;
  907. }
  908. int line_length = (int)line.size();
  909. using namespace Rml::Core::Math;
  910. // Split the line up into its three parts, depending on the size and placement of the selection.
  911. pre_selection = line.substr(0, Max(0, selection_begin_index - line_begin));
  912. selection = line.substr(Clamp(selection_begin_index - line_begin, 0, line_length), Max(0, selection_length + Min(0, selection_begin_index - line_begin)));
  913. post_selection = line.substr(Clamp(selection_begin_index + selection_length - line_begin, 0, line_length));
  914. }
  915. void WidgetTextInput::SetKeyboardActive(bool active)
  916. {
  917. Core::SystemInterface* system = Core::GetSystemInterface();
  918. if (system) {
  919. if (active)
  920. {
  921. system->ActivateKeyboard();
  922. } else
  923. {
  924. system->DeactivateKeyboard();
  925. }
  926. }
  927. }
  928. }
  929. }