WidgetTextInput.cpp 30 KB

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