/* * This source file is part of RmlUi, the HTML/CSS Interface Middleware * * For the latest information, see http://github.com/mikke89/RmlUi * * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd * Copyright (c) 2019 The RmlUi Team, and contributors * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * */ #include "WidgetTextInput.h" #include "../../../Include/RmlUi/Core/ComputedValues.h" #include "../../../Include/RmlUi/Core/Core.h" #include "../../../Include/RmlUi/Core/ElementScroll.h" #include "../../../Include/RmlUi/Core/ElementText.h" #include "../../../Include/RmlUi/Core/ElementUtilities.h" #include "../../../Include/RmlUi/Core/Elements/ElementFormControl.h" #include "../../../Include/RmlUi/Core/Factory.h" #include "../../../Include/RmlUi/Core/GeometryUtilities.h" #include "../../../Include/RmlUi/Core/Input.h" #include "../../../Include/RmlUi/Core/Math.h" #include "../../../Include/RmlUi/Core/StringUtilities.h" #include "../../../Include/RmlUi/Core/SystemInterface.h" #include "../Clock.h" #include "ElementTextSelection.h" #include #include namespace Rml { static constexpr float CURSOR_BLINK_TIME = 0.7f; enum class CharacterClass { Word, Punctuation, Newline, Whitespace, Undefined }; static CharacterClass GetCharacterClass(char c) { if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '_' || ((unsigned char)c >= 128)) return CharacterClass::Word; if ((c >= '!' && c <= '/') || (c >= ':' && c <= '@') || (c >= '[' && c <= '`') || (c >= '{' && c <= '~')) return CharacterClass::Punctuation; if (c == '\n') return CharacterClass::Newline; return CharacterClass::Whitespace; } 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) { keyboard_showed = false; parent = _parent; parent->SetProperty(PropertyId::WhiteSpace, Property(Style::WhiteSpace::Pre)); parent->SetProperty(PropertyId::OverflowX, Property(Style::Overflow::Hidden)); parent->SetProperty(PropertyId::OverflowY, Property(Style::Overflow::Hidden)); parent->SetProperty(PropertyId::Drag, Property(Style::Drag::Drag)); parent->SetProperty(PropertyId::WordBreak, Property(Style::WordBreak::BreakWord)); parent->SetProperty(PropertyId::TextTransform, Property(Style::TextTransform::None)); parent->SetClientArea(Box::CONTENT); parent->AddEventListener(EventId::Keydown, this, true); parent->AddEventListener(EventId::Textinput, this, true); parent->AddEventListener(EventId::Focus, this, true); parent->AddEventListener(EventId::Blur, this, true); parent->AddEventListener(EventId::Mousedown, this, true); parent->AddEventListener(EventId::Dblclick, this, true); parent->AddEventListener(EventId::Drag, this, true); ElementPtr unique_text = Factory::InstanceElement(parent, "#text", "#text", XMLAttributes()); text_element = rmlui_dynamic_cast< ElementText* >(unique_text.get()); ElementPtr unique_selected_text = Factory::InstanceElement(parent, "#text", "#text", XMLAttributes()); selected_text_element = rmlui_dynamic_cast< ElementText* >(unique_selected_text.get()); if (text_element) { text_element->SuppressAutoLayout(); parent->AppendChild(std::move(unique_text), false); selected_text_element->SuppressAutoLayout(); parent->AppendChild(std::move(unique_selected_text), false); } // Create the dummy selection element. ElementPtr unique_selection = Factory::InstanceElement(parent, "#selection", "selection", XMLAttributes()); if (ElementTextSelection* text_selection_element = rmlui_dynamic_cast(unique_selection.get())) { selection_element = text_selection_element; text_selection_element->SetWidget(this); parent->AppendChild(std::move(unique_selection), false); } absolute_cursor_index = 0; cursor_wrap_down = false; ideal_cursor_position_to_the_right_of_cursor = true; cancel_next_drag = false; force_formatting_on_next_layout = false; ideal_cursor_position = 0; max_length = -1; selection_anchor_index = 0; selection_begin_index = 0; selection_length = 0; last_update_time = 0; ShowCursor(false); } WidgetTextInput::~WidgetTextInput() { parent->RemoveEventListener(EventId::Keydown, this, true); parent->RemoveEventListener(EventId::Textinput, this, true); parent->RemoveEventListener(EventId::Focus, this, true); parent->RemoveEventListener(EventId::Blur, this, true); parent->RemoveEventListener(EventId::Mousedown, this, true); parent->RemoveEventListener(EventId::Dblclick, this, true); parent->RemoveEventListener(EventId::Drag, this, true); // Remove all the children added by the text widget. parent->RemoveChild(text_element); parent->RemoveChild(selected_text_element); parent->RemoveChild(selection_element); } void WidgetTextInput::SetValue(String value) { const size_t initial_size = value.size(); SanitizeValue(value); if (initial_size != value.size()) { parent->SetAttribute("value", value); DispatchChangeEvent(); } else { TransformValue(value); RMLUI_ASSERTMSG(value.size() == initial_size, "TransformValue must not change the text length."); text_element->SetText(value); FormatElement(); } } void WidgetTextInput::TransformValue(String& /*value*/) {} // Sets the maximum length (in characters) of this text field. void WidgetTextInput::SetMaxLength(int _max_length) { if (max_length != _max_length) { max_length = _max_length; if (max_length >= 0) { String value = GetValue(); int num_characters = 0; size_t i_erase = value.size(); for (auto it = StringIteratorU8(value); it; ++it) { num_characters += 1; if (num_characters > max_length) { i_erase = size_t(it.offset()); break; } } if(i_erase < value.size()) { value.erase(i_erase); GetElement()->SetAttribute("value", value); } } } } // Returns the maximum length (in characters) of this text field. int WidgetTextInput::GetMaxLength() const { return max_length; } int WidgetTextInput::GetLength() const { size_t result = StringUtilities::LengthUTF8(GetValue()); return (int)result; } // Update the colours of the selected text. void WidgetTextInput::UpdateSelectionColours() { // Determine what the colour of the selected text is. If our 'selection' element has the 'color' // attribute set, then use that. Otherwise, use the inverse of our own text colour. Colourb colour; const Property* colour_property = selection_element->GetLocalProperty("color"); if (colour_property != nullptr) colour = colour_property->Get< Colourb >(); else { colour = parent->GetComputedValues().color(); colour.red = 255 - colour.red; colour.green = 255 - colour.green; colour.blue = 255 - colour.blue; } // Set the computed text colour on the element holding the selected text. selected_text_element->SetProperty(PropertyId::Color, Property(colour, Property::COLOUR)); // If the 'background-color' property has been set on the 'selection' element, use that as the // background colour for the selected text. Otherwise, use the inverse of the selected text // colour. colour_property = selection_element->GetLocalProperty("background-color"); if (colour_property != nullptr) selection_colour = colour_property->Get< Colourb >(); else selection_colour = Colourb(255 - colour.red, 255 - colour.green, 255 - colour.blue, colour.alpha); // Color may have changed, so we update the cursor geometry. GenerateCursor(); } // Updates the cursor, if necessary. void WidgetTextInput::OnUpdate() { if (cursor_timer > 0) { double current_time = Clock::GetElapsedTime(); cursor_timer -= float(current_time - last_update_time); last_update_time = current_time; while (cursor_timer <= 0) { cursor_timer += CURSOR_BLINK_TIME; cursor_visible = !cursor_visible; } } } void WidgetTextInput::OnResize() { GenerateCursor(); Vector2f text_position = parent->GetBox().GetPosition(Box::CONTENT); text_element->SetOffset(text_position, parent); selected_text_element->SetOffset(text_position, parent); ForceFormattingOnNextLayout(); } // Renders the cursor, if it is visible. void WidgetTextInput::OnRender() { ElementUtilities::SetClippingRegion(text_element); Vector2f text_translation = parent->GetAbsoluteOffset() - Vector2f(parent->GetScrollLeft(), parent->GetScrollTop()); selection_geometry.Render(text_translation); if (cursor_visible && !parent->IsDisabled()) { cursor_geometry.Render(text_translation + cursor_position); } } // Formats the widget's internal content. void WidgetTextInput::OnLayout() { if (force_formatting_on_next_layout) { internal_dimensions = parent->GetBox().GetSize(Box::CONTENT); FormatElement(); UpdateCursorPosition(true); force_formatting_on_next_layout = false; } parent->SetScrollLeft(scroll_offset.x); parent->SetScrollTop(scroll_offset.y); } // Gets the parent element containing the widget. Element* WidgetTextInput::GetElement() const { return parent; } // Dispatches a change event to the widget's element. void WidgetTextInput::DispatchChangeEvent(bool linebreak) { Dictionary parameters; parameters["value"] = GetAttributeValue(); parameters["linebreak"] = Variant(linebreak); GetElement()->DispatchEvent(EventId::Change, parameters); } // Processes the "keydown" and "textinput" event to write to the input field, and the "focus" and "blur" to set // the state of the cursor. void WidgetTextInput::ProcessEvent(Event& event) { if (parent->IsDisabled()) return; switch (event.GetId()) { case EventId::Keydown: { Input::KeyIdentifier key_identifier = (Input::KeyIdentifier) event.GetParameter< int >("key_identifier", 0); bool numlock = event.GetParameter< int >("num_lock_key", 0) > 0; bool shift = event.GetParameter< int >("shift_key", 0) > 0; bool ctrl = event.GetParameter< int >("ctrl_key", 0) > 0; switch (key_identifier) { case Input::KI_NUMPAD4: if (numlock) break; //-fallthrough case Input::KI_LEFT: MoveCursorHorizontal(ctrl ? CursorMovement::PreviousWord : CursorMovement::Left, shift); break; case Input::KI_NUMPAD6: if (numlock) break; //-fallthrough case Input::KI_RIGHT: MoveCursorHorizontal(ctrl ? CursorMovement::NextWord : CursorMovement::Right, shift); break; case Input::KI_NUMPAD8: if (numlock) break; //-fallthrough case Input::KI_UP: MoveCursorVertical(-1, shift); break; case Input::KI_NUMPAD2: if (numlock) break; //-fallthrough case Input::KI_DOWN: MoveCursorVertical(1, shift); break; case Input::KI_NUMPAD7: if (numlock) break; //-fallthrough case Input::KI_HOME: MoveCursorHorizontal(ctrl ? CursorMovement::Begin : CursorMovement::BeginLine, shift); break; case Input::KI_NUMPAD1: if (numlock) break; //-fallthrough case Input::KI_END: MoveCursorHorizontal(ctrl ? CursorMovement::End : CursorMovement::EndLine, shift); break; case Input::KI_NUMPAD9: if (numlock) break; //-fallthrough case Input::KI_PRIOR: MoveCursorVertical(-int(internal_dimensions.y / parent->GetLineHeight()) + 1, shift); break; case Input::KI_NUMPAD3: if (numlock) break; //-fallthrough case Input::KI_NEXT: MoveCursorVertical(int(internal_dimensions.y / parent->GetLineHeight()) - 1, shift); break; case Input::KI_BACK: { CursorMovement direction = (ctrl ? CursorMovement::PreviousWord : CursorMovement::Left); if (DeleteCharacters(direction)) FormatElement(); ShowCursor(true); } break; case Input::KI_DECIMAL: if (numlock) break; //-fallthrough case Input::KI_DELETE: { CursorMovement direction = (ctrl ? CursorMovement::NextWord : CursorMovement::Right); if (DeleteCharacters(direction)) FormatElement(); ShowCursor(true); } break; case Input::KI_NUMPADENTER: case Input::KI_RETURN: { LineBreak(); } break; case Input::KI_A: { if (ctrl) { MoveCursorHorizontal(CursorMovement::Begin, false); MoveCursorHorizontal(CursorMovement::End, true); } } break; case Input::KI_C: { if (ctrl && selection_length > 0) CopySelection(); } break; case Input::KI_X: { if (ctrl && selection_length > 0) { CopySelection(); DeleteSelection(); DispatchChangeEvent(); ShowCursor(true); } } break; case Input::KI_V: { if (ctrl) { String clipboard_text; GetSystemInterface()->GetClipboardText(clipboard_text); AddCharacters(clipboard_text); ShowCursor(true); } } break; // Ignore tabs so input fields can be navigated through with keys. case Input::KI_TAB: return; default: break; } event.StopPropagation(); } break; case EventId::Textinput: { // Only process the text if no modifier keys are pressed. if (event.GetParameter< int >("ctrl_key", 0) == 0 && event.GetParameter< int >("alt_key", 0) == 0 && event.GetParameter< int >("meta_key", 0) == 0) { String text = event.GetParameter("text", String{}); AddCharacters(text); } ShowCursor(true); event.StopPropagation(); } break; case EventId::Focus: { if (event.GetTargetElement() == parent) { UpdateSelection(false); ShowCursor(true, false); } } break; case EventId::Blur: { if (event.GetTargetElement() == parent) { ClearSelection(); ShowCursor(false, false); } } break; case EventId::Drag: if (cancel_next_drag) { // We currently ignore drag events right after a double click. They would need to be handled // specially by selecting whole words at a time, which is not yet implemented. break; } //-fallthrough case EventId::Mousedown: { if (event.GetTargetElement() == parent) { Vector2f mouse_position = Vector2f(event.GetParameter< float >("mouse_x", 0), event.GetParameter< float >("mouse_y", 0)); mouse_position -= text_element->GetAbsoluteOffset(); const int cursor_line_index = CalculateLineIndex(mouse_position.y); const int cursor_character_index = CalculateCharacterIndex(cursor_line_index, mouse_position.x); SetCursorFromRelativeIndices(cursor_line_index, cursor_character_index); MoveCursorToCharacterBoundaries(false); UpdateCursorPosition(true); UpdateSelection(event == EventId::Drag || event.GetParameter< int >("shift_key", 0) > 0); ShowCursor(true); cancel_next_drag = false; } } break; case EventId::Dblclick: { if (event.GetTargetElement() == parent) { ExpandSelection(); cancel_next_drag = true; } } break; default: break; } } // Adds a new character to the string at the cursor position. bool WidgetTextInput::AddCharacters(String string) { SanitizeValue(string); if (string.empty()) return false; if (selection_length > 0) DeleteSelection(); if (max_length >= 0 && GetLength() >= max_length) return false; String value = GetAttributeValue(); value.insert(std::min((size_t)absolute_cursor_index, value.size()), string); parent->SetAttribute("value", value); absolute_cursor_index += (int)string.size(); DispatchChangeEvent(); UpdateCursorPosition(true); UpdateSelection(false); return true; } // Deletes a character from the string. bool WidgetTextInput::DeleteCharacters(CursorMovement direction) { // We set a selection of characters according to direction, and then delete it. // If we already have a selection, we delete that first. if (selection_length <= 0) MoveCursorHorizontal(direction, true); if (selection_length > 0) { DeleteSelection(); DispatchChangeEvent(); return true; } return false; } // Copies the selection (if any) to the clipboard. void WidgetTextInput::CopySelection() { const String& value = GetValue(); const String snippet = value.substr(std::min((size_t)selection_begin_index, (size_t)value.size()), (size_t)selection_length); GetSystemInterface()->SetClipboardText(snippet); } // Moves the cursor along the current line. void WidgetTextInput::MoveCursorHorizontal(CursorMovement movement, bool select) { const String& value = GetValue(); int cursor_line_index = 0, cursor_character_index = 0; GetRelativeCursorIndices(cursor_line_index, cursor_character_index); // By default the cursor wraps down when located on softbreaks. This may be overridden by setting the cursor using relative indices. cursor_wrap_down = true; // Whether to seek forward or back to align to utf8 boundaries later. bool seek_forward = false; switch (movement) { case CursorMovement::Begin: absolute_cursor_index = 0; break; case CursorMovement::BeginLine: SetCursorFromRelativeIndices(cursor_line_index, 0); break; case CursorMovement::PreviousWord: { // First skip whitespace, then skip all characters of the same class as the first non-whitespace character. CharacterClass skip_character_class = CharacterClass::Whitespace; const char* p_rend = value.data(); const char* p_rbegin = p_rend + absolute_cursor_index; const char* p = p_rbegin - 1; for (; p > p_rend; --p) { const CharacterClass character_class = GetCharacterClass(*p); if (character_class != skip_character_class) { if (skip_character_class == CharacterClass::Whitespace) skip_character_class = character_class; else break; } } if (p != p_rend) ++p; absolute_cursor_index += int(p - p_rbegin); } break; case CursorMovement::Left: if (!select && selection_length > 0) absolute_cursor_index = selection_begin_index; else absolute_cursor_index -= 1; break; case CursorMovement::Right: seek_forward = true; if (!select && selection_length > 0) absolute_cursor_index = selection_begin_index + selection_length; else absolute_cursor_index += 1; break; case CursorMovement::NextWord: { // First skip all characters of the same class as the first character, then skip any whitespace. CharacterClass skip_character_class = CharacterClass::Undefined; const char* p_begin = value.data() + absolute_cursor_index; const char* p_end = value.data() + value.size(); const char* p = p_begin; for (; p < p_end; ++p) { const CharacterClass character_class = GetCharacterClass(*p); if (skip_character_class == CharacterClass::Undefined) skip_character_class = character_class; if (character_class != skip_character_class) { if (character_class == CharacterClass::Whitespace) skip_character_class = CharacterClass::Whitespace; else break; } } absolute_cursor_index += int(p - p_begin); } break; case CursorMovement::EndLine: SetCursorFromRelativeIndices(cursor_line_index, lines[cursor_line_index].editable_length); break; case CursorMovement::End: absolute_cursor_index = INT_MAX; break; default: break; } absolute_cursor_index = Math::Clamp(absolute_cursor_index, 0, (int)GetValue().size()); MoveCursorToCharacterBoundaries(seek_forward); UpdateCursorPosition(true); UpdateSelection(select); ShowCursor(true); } // Moves the cursor up and down the text field. void WidgetTextInput::MoveCursorVertical(int distance, bool select) { int cursor_line_index = 0, cursor_character_index = 0; GetRelativeCursorIndices(cursor_line_index, cursor_character_index); cursor_line_index += distance; if (cursor_line_index < 0) { cursor_line_index = 0; cursor_character_index = 0; } else if (cursor_line_index >= (int)lines.size()) { cursor_line_index = (int)lines.size() - 1; cursor_character_index = (int)lines[cursor_line_index].editable_length; } else cursor_character_index = CalculateCharacterIndex(cursor_line_index, ideal_cursor_position); SetCursorFromRelativeIndices(cursor_line_index, cursor_character_index); MoveCursorToCharacterBoundaries(false); UpdateCursorPosition(false); UpdateSelection(select); ShowCursor(true); } void WidgetTextInput::MoveCursorToCharacterBoundaries(bool forward) { const String& value = GetValue(); absolute_cursor_index = Math::Min(absolute_cursor_index, (int)value.size()); const char* p_begin = value.data(); const char* p_end = p_begin + value.size(); const char* p_cursor = p_begin + absolute_cursor_index; const char* p = p_cursor; if (forward) p = StringUtilities::SeekForwardUTF8(p_cursor, p_end); else p = StringUtilities::SeekBackwardUTF8(p_cursor, p_begin); if (p != p_cursor) absolute_cursor_index += int(p - p_cursor); } void WidgetTextInput::ExpandSelection() { const String& value = GetValue(); const char* const p_begin = value.data(); const char* const p_end = p_begin + value.size(); const char* const p_index = p_begin + absolute_cursor_index; // The first character encountered defines the character class to expand. CharacterClass expanding_character_class = CharacterClass::Undefined; auto character_is_wrong_type = [&expanding_character_class](const char* p) -> bool { const CharacterClass character_class = GetCharacterClass(*p); if (expanding_character_class == CharacterClass::Undefined) expanding_character_class = character_class; else if (character_class != expanding_character_class) return true; return false; }; auto search_left = [&]() -> const char* { const char* p = p_index; for (; p > p_begin; p--) if (character_is_wrong_type(p - 1)) break; return p; }; auto search_right = [&]() -> const char* { const char* p = p_index; for (; p < p_end; p++) if (character_is_wrong_type(p)) break; return p; }; const char* p_left = p_index; const char* p_right = p_index; if (ideal_cursor_position_to_the_right_of_cursor) { p_right = search_right(); p_left = search_left(); } else { p_left = search_left(); p_right = search_right(); } cursor_wrap_down = true; absolute_cursor_index -= int(p_index - p_left); MoveCursorToCharacterBoundaries(false); UpdateSelection(false); absolute_cursor_index += int(p_right - p_left); MoveCursorToCharacterBoundaries(true); UpdateSelection(true); UpdateCursorPosition(true); } const String& WidgetTextInput::GetValue() const { return text_element->GetText(); } String WidgetTextInput::GetAttributeValue() const { return parent->GetAttribute("value", String()); } void WidgetTextInput::GetRelativeCursorIndices(int& out_cursor_line_index, int& out_cursor_character_index) const { int line_begin = 0; for (size_t i = 0; i < lines.size(); i++) { const int cursor_relative_line_end = absolute_cursor_index - (line_begin + lines[i].editable_length); // Test if the absolute index is located on the editable part of this line, otherwise we wrap down to the next line. We may have additional // characters after the editable length, such as the newline character '\n'. We also wrap down if the cursor is located to the right of any // such characters. if (cursor_relative_line_end <= 0) { const bool soft_wrapped_line = (lines[i].editable_length == lines[i].size); // If we are located exactly on a soft break (due to word wrapping) then the cursor wrap state determines whether or not we wrap down. if (cursor_relative_line_end == 0 && soft_wrapped_line && cursor_wrap_down && (int)i + 1 < (int)lines.size()) { out_cursor_line_index = (int)i + 1; out_cursor_character_index = 0; } else { out_cursor_line_index = (int)i; out_cursor_character_index = Math::Max(absolute_cursor_index - line_begin, 0); } return; } line_begin += lines[i].size; } // We shouldn't ever get here; this means we actually couldn't find where the absolute cursor said it was. So we'll // just set the relative cursors to the very end of the text field. out_cursor_line_index = (int)lines.size() - 1; out_cursor_character_index = lines[out_cursor_line_index].editable_length; } void WidgetTextInput::SetCursorFromRelativeIndices(int cursor_line_index, int cursor_character_index) { RMLUI_ASSERT(cursor_line_index < (int)lines.size()) absolute_cursor_index = cursor_character_index; for (int i = 0; i < cursor_line_index; i++) absolute_cursor_index += lines[i].size; // Don't wrap down if we're located at the end of the line. cursor_wrap_down = !(cursor_character_index >= lines[cursor_line_index].editable_length); } // Calculates the line index under a specific vertical position. int WidgetTextInput::CalculateLineIndex(float position) const { float line_height = parent->GetLineHeight(); int line_index = Math::RealToInteger(position / line_height); return Math::Clamp(line_index, 0, (int) (lines.size() - 1)); } // Calculates the character index along a line under a specific horizontal position. int WidgetTextInput::CalculateCharacterIndex(int line_index, float position) { int prev_offset = 0; float prev_line_width = 0; ideal_cursor_position_to_the_right_of_cursor = true; const char* p_begin = GetValue().data() + lines[line_index].value_offset; for (auto it = StringIteratorU8(p_begin, p_begin, p_begin + lines[line_index].editable_length); it;) { ++it; const int offset = (int)it.offset(); const float line_width = (float)ElementUtilities::GetStringWidth(text_element, String(p_begin, (size_t)offset)); if (line_width > position) { if (position - prev_line_width < line_width - position) { return prev_offset; } else { ideal_cursor_position_to_the_right_of_cursor = false; return offset; } } prev_line_width = line_width; prev_offset = offset; } return prev_offset; } // Shows or hides the cursor. void WidgetTextInput::ShowCursor(bool show, bool move_to_cursor) { if (show) { cursor_visible = true; cursor_timer = CURSOR_BLINK_TIME; last_update_time = GetSystemInterface()->GetElapsedTime(); // Shift the cursor into view. if (move_to_cursor) { float minimum_scroll_top = (cursor_position.y + cursor_size.y) - parent->GetClientHeight(); if (parent->GetScrollTop() < minimum_scroll_top) parent->SetScrollTop(minimum_scroll_top); else if (parent->GetScrollTop() > cursor_position.y) parent->SetScrollTop(cursor_position.y); float minimum_scroll_left = (cursor_position.x + cursor_size.x) - parent->GetClientWidth(); if (parent->GetScrollLeft() < minimum_scroll_left) parent->SetScrollLeft(minimum_scroll_left); else if (parent->GetScrollLeft() > cursor_position.x) parent->SetScrollLeft(cursor_position.x); scroll_offset.x = parent->GetScrollLeft(); scroll_offset.y = parent->GetScrollTop(); } SetKeyboardActive(true); keyboard_showed = true; } else { cursor_visible = false; cursor_timer = -1; last_update_time = 0; if (keyboard_showed) { SetKeyboardActive(false); keyboard_showed = false; } } } // Formats the element, laying out the text and inserting scrollbars as appropriate. void WidgetTextInput::FormatElement() { using namespace Style; ElementScroll* scroll = parent->GetElementScroll(); float width = parent->GetBox().GetSize(Box::PADDING).x; Overflow x_overflow_property = parent->GetComputedValues().overflow_x(); Overflow y_overflow_property = parent->GetComputedValues().overflow_y(); if (x_overflow_property == Overflow::Scroll) scroll->EnableScrollbar(ElementScroll::HORIZONTAL, width); else scroll->DisableScrollbar(ElementScroll::HORIZONTAL); if (y_overflow_property == Overflow::Scroll) scroll->EnableScrollbar(ElementScroll::VERTICAL, width); else scroll->DisableScrollbar(ElementScroll::VERTICAL); // If the formatting produces scrollbars we need to format again later, this constraint enables early exit for the first formatting round. const float formatting_height_constraint = (y_overflow_property == Overflow::Auto ? parent->GetClientHeight() : FLT_MAX); // Format the text and determine its total area. Vector2f content_area = FormatText(formatting_height_constraint); // If we're set to automatically generate horizontal scrollbars, check for that now. if (x_overflow_property == Overflow::Auto && content_area.x > parent->GetClientWidth()) scroll->EnableScrollbar(ElementScroll::HORIZONTAL, width); // Now check for vertical overflow. If we do turn on the scrollbar, this will cause a reflow. if (y_overflow_property == Overflow::Auto && content_area.y > parent->GetClientHeight()) { scroll->EnableScrollbar(ElementScroll::VERTICAL, width); content_area = FormatText(); if (x_overflow_property == Overflow::Auto && content_area.x > parent->GetClientWidth()) scroll->EnableScrollbar(ElementScroll::HORIZONTAL, width); } parent->SetContentBox(Vector2f(0, 0), content_area); scroll->FormatScrollbars(); } Vector2f WidgetTextInput::FormatText(float height_constraint) { Vector2f content_area(0, 0); // Clear the old lines, and all the lines in the text elements. lines.clear(); text_element->ClearLines(); selected_text_element->ClearLines(); // Clear the selection background geometry, and get the vertices and indices so the new geo can // be generated. selection_geometry.Release(true); Vector< Vertex >& selection_vertices = selection_geometry.GetVertices(); Vector< int >& selection_indices = selection_geometry.GetIndices(); // Determine the line-height of the text element. const float line_height = parent->GetLineHeight(); // When the selection contains endlines we expand the selection area by this width. const int endline_selection_width = int(0.4f * parent->GetComputedValues().font_size()); const float client_width = parent->GetClientWidth(); int line_begin = 0; Vector2f line_position(0, 0); bool last_line = false; // Keep generating lines until all the text content is placed. do { if (client_width <= 0.f) { lines.push_back(Line{}); break; } Line line = {}; line.value_offset = line_begin; float line_width; String line_content; // Generate the next line. last_line = text_element->GenerateLine(line_content, line.size, line_width, line_begin, client_width - cursor_size.x, 0, false, false); // If this line terminates in a soft-return (word wrap), then the line may be leaving a space or two behind as an orphan. If so, we must // append the orphan onto the line even though it will push the line outside of the input field's bounds. if (!last_line && (line_content.empty() || line_content.back() != '\n')) { const String& text = GetValue(); String orphan; for (int i = 1; i >= 0; --i) { int index = line_begin + line.size + i; if (index >= (int)text.size()) continue; if (text[index] != ' ') { orphan.clear(); continue; } int next_index = index + 1; if (!orphan.empty() || next_index >= (int)text.size() || text[next_index] != ' ') orphan += ' '; } if (!orphan.empty()) { line_content += orphan; line.size += (int)orphan.size(); line_width += ElementUtilities::GetStringWidth(text_element, orphan); } } // Now that we have the string of characters appearing on the new line, we split it into // three parts; the unselected text appearing before any selected text on the line, the // selected text on the line, and any unselected text after the selection. String pre_selection, selection, post_selection; GetLineSelection(pre_selection, selection, post_selection, line_content, line_begin); // The pre-selected text is placed, if there is any (if the selection starts on or before // the beginning of this line, then this will be empty). if (!pre_selection.empty()) { text_element->AddLine(line_position, pre_selection); line_position.x += ElementUtilities::GetStringWidth(text_element, pre_selection); } // Return the extra kerning that would result in joining two strings. auto GetKerningBetween = [this](const String& left, const String& right) -> float { if (left.empty() || right.empty()) return 0.0f; // We could join the whole string, and compare the result of the joined width to the individual widths of each string. Instead, we take // the two neighboring characters from each string and compare the string width with and without kerning, which should be much faster. const Character left_back = StringUtilities::ToCharacter(StringUtilities::SeekBackwardUTF8(&left.back(), &left.front())); const String right_front_u8 = right.substr(0, size_t(StringUtilities::SeekForwardUTF8(right.c_str() + 1, right.c_str() + right.size()) - right.c_str())); const int width_kerning = ElementUtilities::GetStringWidth(text_element, right_front_u8, left_back); const int width_no_kerning = ElementUtilities::GetStringWidth(text_element, right_front_u8, Character::Null); return float(width_kerning - width_no_kerning); }; // Check if the editable length needs to be truncated to dodge a trailing endline. line.editable_length = (int)line_content.size(); if (!line_content.empty() && line_content.back() == '\n') line.editable_length -= 1; // If there is any selected text on this line, place it in the selected text element and // generate the geometry for its background. if (!selection.empty()) { line_position.x += GetKerningBetween(pre_selection, selection); selected_text_element->AddLine(line_position, selection); const int selection_width = ElementUtilities::GetStringWidth(selected_text_element, selection); const bool selection_contains_endline = (selection_begin_index + selection_length > line_begin + line.editable_length); const Vector2f selection_size(float(selection_width + (selection_contains_endline ? endline_selection_width : 0)), line_height); selection_vertices.resize(selection_vertices.size() + 4); selection_indices.resize(selection_indices.size() + 6); GeometryUtilities::GenerateQuad(&selection_vertices[selection_vertices.size() - 4], &selection_indices[selection_indices.size() - 6], line_position, selection_size, selection_colour, (int)selection_vertices.size() - 4); line_position.x += selection_width; } // If there is any unselected text after the selection on this line, place it in the // standard text element after the selected text. if (!post_selection.empty()) { line_position.x += GetKerningBetween(selection, post_selection); text_element->AddLine(line_position, post_selection); } // Update variables for the next line. line_begin += line.size; line_position.x = 0; line_position.y += line_height; // Grow the content area width-wise if this line is the longest so far, and push the height out. content_area.x = Math::Max(content_area.x, line_width + cursor_size.x); content_area.y = line_position.y; // Finally, push the new line into our array of lines. lines.push_back(std::move(line)); } while (!last_line && content_area.y < height_constraint); // Clamp the cursor to a valid range. absolute_cursor_index = Math::Min(absolute_cursor_index, (int)GetValue().size()); return content_area; } // Generates the text cursor. void WidgetTextInput::GenerateCursor() { // Generates the cursor. cursor_geometry.Release(); Vector< Vertex >& vertices = cursor_geometry.GetVertices(); vertices.resize(4); Vector< int >& indices = cursor_geometry.GetIndices(); indices.resize(6); cursor_size.x = Math::RoundFloat( ElementUtilities::GetDensityIndependentPixelRatio(text_element) ); cursor_size.y = text_element->GetLineHeight() + 2.0f; Colourb color = parent->GetComputedValues().color(); if (const Property* property = parent->GetProperty(PropertyId::CaretColor)) { if (property->unit == Property::COLOUR) color = property->Get(); } GeometryUtilities::GenerateQuad(&vertices[0], &indices[0], Vector2f(0, 0), cursor_size, color); } void WidgetTextInput::ForceFormattingOnNextLayout() { force_formatting_on_next_layout = true; } void WidgetTextInput::UpdateCursorPosition(bool update_ideal_cursor_position) { if (text_element->GetFontFaceHandle() == 0) return; int cursor_line_index = 0, cursor_character_index = 0; GetRelativeCursorIndices(cursor_line_index, cursor_character_index); cursor_position.x = (float)ElementUtilities::GetStringWidth(text_element, GetValue().substr(lines[cursor_line_index].value_offset, cursor_character_index)); cursor_position.y = -1.f + (float)cursor_line_index * text_element->GetLineHeight(); if (update_ideal_cursor_position) ideal_cursor_position = cursor_position.x; } // Expand the text selection to the position of the cursor. void WidgetTextInput::UpdateSelection(bool selecting) { if (!selecting) { selection_anchor_index = absolute_cursor_index; ClearSelection(); } else { int new_begin_index; int new_end_index; if (absolute_cursor_index > selection_anchor_index) { new_begin_index = selection_anchor_index; new_end_index = absolute_cursor_index; } else { new_begin_index = absolute_cursor_index; new_end_index = selection_anchor_index; } if (new_begin_index != selection_begin_index || new_end_index - new_begin_index != selection_length) { selection_begin_index = new_begin_index; selection_length = new_end_index - new_begin_index; FormatText(); } } } // Removes the selection of text. void WidgetTextInput::ClearSelection() { if (selection_length > 0) { selection_length = 0; FormatElement(); } } // Deletes all selected text and removes the selection. void WidgetTextInput::DeleteSelection() { if (selection_length > 0) { String new_value = GetAttributeValue(); const size_t selection_begin = std::min((size_t)selection_begin_index, (size_t)new_value.size()); new_value.erase(selection_begin, (size_t)selection_length); GetElement()->SetAttribute("value", new_value); // Move the cursor to the beginning of the old selection. absolute_cursor_index = selection_begin_index; UpdateCursorPosition(true); // Erase our record of the selection. UpdateSelection(false); } } // Split one line of text into three parts, based on the current selection. void WidgetTextInput::GetLineSelection(String& pre_selection, String& selection, String& post_selection, const String& line, int line_begin) const { const int selection_end = selection_begin_index + selection_length; // Check if we have any selection at all, and if so if the selection is on this line. if (selection_length <= 0 || selection_end < line_begin || selection_begin_index > line_begin + (int)line.size()) { pre_selection = line; return; } const int line_length = (int)line.size(); using namespace Math; // Split the line up into its three parts, depending on the size and placement of the selection. pre_selection = line.substr(0, Max(0, selection_begin_index - line_begin)); selection = line.substr(Clamp(selection_begin_index - line_begin, 0, line_length), Max(0, selection_length + Min(0, selection_begin_index - line_begin))); post_selection = line.substr(Clamp(selection_end - line_begin, 0, line_length)); } void WidgetTextInput::SetKeyboardActive(bool active) { if (SystemInterface* system = GetSystemInterface()) { if (active) { // Activate the keyboard and submit the cursor position and line height to enable clients to adjust the input method editor (IME). Note // that the cursor is extended by one pixel along the top and bottom, we reverse this extension here. const Vector2f element_offset = parent->GetAbsoluteOffset() - scroll_offset; const Vector2f absolute_cursor_position = element_offset + cursor_position + Vector2f(0, 1); const float line_height = cursor_size.y - 2.f; system->ActivateKeyboard(absolute_cursor_position, line_height); } else { system->DeactivateKeyboard(); } } } } // namespace Rml