Merge pull request #5409 from Textualize/arbitrary-select

WIP Arbitrary select

Author: willmcgugan

CHANGELOG.md

@@ -7,22 +7,34 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+### Changed
 
-### Fixed
-
-- Fixed `Pilot.click` not working with `times` parameter https://github.com/Textualize/textual/pull/5398
-- Fixed select refocusing itself too late https://github.com/Textualize/textual/pull/5420
+- Footer can now be scrolled horizontally without holding `shift` https://github.com/Textualize/textual/pull/5404
+- The content of an `Input` will now only be automatically selected when the widget is focused by the user, not when the app itself has regained focus (similar to web browsers). https://github.com/Textualize/textual/pull/5379
+- `Pilot.mouse_down` and `Pilot.mouse_up` now issue a prior `MouseMove` event, to more closely reflect real mouse actions. https://github.com/Textualize/textual/pull/5409
+- Snapshots tests now discard meta, which should reduce test breaking with no visual differences https://github.com/Textualize/textual/pull/5409
 
 ### Added
 
+- Added `Select.type_to_search` which allows you to type to move the cursor to a matching option https://github.com/Textualize/textual/pull/5403
+- Updated `TextArea` and `Input` behavior when there is a selection and the user presses left or right https://github.com/Textualize/textual/pull/5400
 - Added `from_app_focus` to `Focus` event to indicate if a widget is being focused because the app itself has regained focus or not https://github.com/Textualize/textual/pull/5379
-- - Added `Select.type_to_search` which allows you to type to move the cursor to a matching option https://github.com/Textualize/textual/pull/5403
+- Added `Offset.transpose` https://github.com/Textualize/textual/pull/5409
+- Added `screen--selection` component class to define style for selection https://github.com/Textualize/textual/pull/5409
+- Added `Widget.select_container` property https://github.com/Textualize/textual/pull/5409
+- Added `Widget.select_all` https://github.com/Textualize/textual/pull/5409
+- Added `Region.bottom_right_inclusive` https://github.com/Textualize/textual/pull/5409
+- Added double click to select, triple click to select all in container https://github.com/Textualize/textual/pull/5409
+- Added arbitrary text selection https://github.com/Textualize/textual/pull/5409
+- Added Widget.ALLOW_SELECT classvar for a per-widget switch to disable text selection https://github.com/Textualize/textual/pull/5409
+- Added Widget.allow_select method for programmatic control of text selection https://github.com/Textualize/textual/pull/5409
+- Added App.ALLOW_SELECT for a global switch to disable text selection https://github.com/Textualize/textual/pull/5409
+- Added `DOMNode.query_ancestor` https://github.com/Textualize/textual/pull/5409
 
-### Changed
+### Fixed
 
-- The content of an `Input` will now only be automatically selected when the widget is focused by the user, not when the app itself has regained focus (similar to web browsers). https://github.com/Textualize/textual/pull/5379
-- Updated `TextArea` and `Input` behavior when there is a selection and the user presses left or right https://github.com/Textualize/textual/pull/5400
-- Footer can now be scrolled horizontally without holding `shift` https://github.com/Textualize/textual/pull/5404
+- Fixed `Pilot.click` not working with `times` parameter https://github.com/Textualize/textual/pull/5398
+- Fixed select refocusing itself too late https://github.com/Textualize/textual/pull/5420
 
 
 ## [1.0.0] - 2024-12-12

poetry.lock

@@ -1,52 +1,71 @@
+from __future__ import annotations
+
 from rich.terminal_theme import TerminalTheme
 
+
+def rgb(red: int, green: int, blue: int) -> tuple[int, int, int]:
+    """Define an RGB color.
+
+    This exists mainly so that a VSCode extension can render the colors inline.
+
+    Args:
+        red: Red component.
+        green: Green component.
+        blue: Blue component.
+
+    Returns:
+        Color triplet.
+    """
+    return red, green, blue
+
+
 MONOKAI = TerminalTheme(
-    (12, 12, 12),
-    (217, 217, 217),
+    rgb(12, 12, 12),
+    rgb(217, 217, 217),
     [
-        (26, 26, 26),
-        (244, 0, 95),
-        (152, 224, 36),
-        (253, 151, 31),
-        (157, 101, 255),
-        (244, 0, 95),
-        (88, 209, 235),
-        (196, 197, 181),
-        (98, 94, 76),
+        rgb(26, 26, 26),
+        rgb(244, 0, 95),
+        rgb(152, 224, 36),
+        rgb(253, 151, 31),
+        rgb(157, 101, 255),
+        rgb(244, 0, 95),
+        rgb(88, 209, 235),
+        rgb(196, 197, 181),
+        rgb(98, 94, 76),
     ],
     [
-        (244, 0, 95),
-        (152, 224, 36),
-        (224, 213, 97),
-        (157, 101, 255),
-        (244, 0, 95),
-        (88, 209, 235),
-        (246, 246, 239),
+        rgb(244, 0, 95),
+        rgb(152, 224, 36),
+        rgb(224, 213, 97),
+        rgb(157, 101, 255),
+        rgb(244, 0, 95),
+        rgb(88, 209, 235),
+        rgb(246, 246, 239),
     ],
 )
 
 ALABASTER = TerminalTheme(
-    (247, 247, 247),
-    (0, 0, 0),
+    rgb(247, 247, 247),
+    rgb(0, 0, 0),
     [
-        (0, 0, 0),
-        (170, 55, 49),
-        (68, 140, 39),
-        (203, 144, 0),
-        (50, 92, 192),
-        (122, 62, 157),
-        (0, 131, 178),
-        (247, 247, 247),
-        (119, 119, 119),
+        rgb(0, 0, 0),
+        rgb(170, 55, 49),
+        rgb(68, 140, 39),
+        rgb(203, 144, 0),
+        rgb(50, 92, 192),
+        rgb(122, 62, 157),
+        rgb(0, 131, 178),
+        rgb(247, 247, 247),
+        rgb(119, 119, 119),
     ],
     [
-        (240, 80, 80),
-        (96, 203, 0),
-        (255, 188, 93),
-        (0, 122, 204),
-        (230, 76, 230),
-        (0, 170, 203),
-        (247, 247, 247),
+        rgb(240, 80, 80),
+        rgb(96, 203, 0),
+        rgb(255, 188, 93),
+        rgb(0, 122, 204),
+        rgb(230, 76, 230),
+        rgb(0, 170, 203),
+        rgb(247, 247, 247),
     ],
 )
 

src/textual/_ansi_theme.py

@@ -844,11 +844,11 @@ def get_style_at(self, x: int, y: int) -> Style:
         """Get the Style at the given cell or Style.null()
 
         Args:
-            x: X position within the Layout
-            y: Y position within the Layout
+            x: X position within the Layout.
+            y: Y position within the Layout.
 
         Returns:
-            The Style at the cell (x, y) within the Layout
+            The Style at the cell (x, y) within the Layout.
         """
         try:
             widget, region = self.get_widget_at(x, y)
@@ -866,12 +866,70 @@ def get_style_at(self, x: int, y: int) -> Style:
         if not lines:
             return Style.null()
         end = 0
+
         for segment in lines[0]:
             end += segment.cell_length
             if x < end:
                 return segment.style or Style.null()
+
         return Style.null()
 
+    def get_widget_and_offset_at(
+        self, x: int, y: int
+    ) -> tuple[Widget | None, Offset | None]:
+        """Get the Style at the given cell, the offset within the content.
+
+        Args:
+            x: X position within the Layout.
+            y: Y position within the Layout.
+
+        Returns:
+            A tuple of the widget at (x, y) and the offset within the widget.
+        """
+        try:
+            widget, region = self.get_widget_at(x, y)
+        except errors.NoWidget:
+            return None, None
+        if widget not in self.visible_widgets:
+            return None, None
+
+        if y >= widget.content_region.bottom:
+            x, y = widget.content_region.bottom_right_inclusive
+
+        x -= region.x
+        y -= region.y
+
+        visible_screen_stack.set(widget.app._background_screens)
+        lines = widget.render_lines(Region(0, y, region.width, 1))
+
+        if not lines:
+            return widget, None
+        end = 0
+        start = 0
+
+        offset_y: int | None = None
+        offset_x = 0
+        offset_x2 = 0
+
+        for segment in lines[0]:
+            end += segment.cell_length
+            style = segment.style
+            if style is not None and style._meta is not None:
+                meta = style.meta
+                if "offset" in meta:
+                    offset_x, offset_y = style.meta["offset"]
+                    offset_x2 = offset_x + segment.cell_length
+
+                    if x <= end:
+                        return widget, (
+                            None
+                            if offset_y is None
+                            else Offset(offset_x + (x - start), offset_y)
+                        )
+            start = end
+
+        return widget, (None if offset_y is None else Offset(offset_x2, offset_y))
+
     def find_widget(self, widget: Widget) -> MapGeometry:
         """Get information regarding the relative position of a widget in the Compositor.
 
@@ -1056,7 +1114,9 @@ def render_full_update(self, simplify: bool = False) -> LayoutUpdate:
         crop = screen_region
         chops = self._render_chops(crop, lambda y: True)
         if simplify:
-            render_strips = [Strip.join(chop.values()).simplify() for chop in chops]
+            render_strips = [
+                Strip.join(chop.values()).simplify().discard_meta() for chop in chops
+            ]
         else:
             render_strips = [Strip.join(chop.values()) for chop in chops]
 

src/textual/_compositor.py

@@ -7,6 +7,7 @@
 from rich.console import Console
 from rich.segment import Segment
 from rich.style import Style
+from rich.terminal_theme import TerminalTheme
 from rich.text import Text
 
 from textual import log
@@ -144,6 +145,7 @@ def render_widget(self, widget: Widget, crop: Region) -> list[Strip]:
             crop=crop,
             filters=widget.app._filters,
             opacity=widget.opacity,
+            ansi_theme=widget.app.ansi_theme,
         )
         if widget.auto_links:
             hover_style = widget.hover_style
@@ -176,6 +178,7 @@ def render(
         crop: Region | None = None,
         filters: Sequence[LineFilter] | None = None,
         opacity: float = 1.0,
+        ansi_theme: TerminalTheme = DEFAULT_TERMINAL_THEME,
     ) -> list[Strip]:
         """Render a widget content plus CSS styles.
 
@@ -231,6 +234,7 @@ def render(
                     border_title,
                     border_subtitle,
                     opacity,
+                    ansi_theme,
                 )
                 self._cache[y] = strip
             else:
@@ -267,6 +271,7 @@ def render_line(
         border_title: tuple[Text, Color, Color, Style] | None,
         border_subtitle: tuple[Text, Color, Color, Style] | None,
         opacity: float,
+        ansi_theme: TerminalTheme,
     ) -> Strip:
         """Render a styled line.
 
@@ -447,7 +452,9 @@ def post(segments: Iterable[Segment]) -> Iterable[Segment]:
             if inner:
                 line = Segment.apply_style(line, inner)
             if styles.text_opacity != 1.0:
-                line = TextOpacity.process_segments(line, styles.text_opacity)
+                line = TextOpacity.process_segments(
+                    line, styles.text_opacity, ansi_theme
+                )
             line = line_post(line_pad(line, pad_left, pad_right, inner))
 
             if border_left or border_right:

src/textual/_styles_cache.py

@@ -396,6 +396,12 @@ class MyApp(App[None]):
     Setting to `None` or `""` disables auto focus.
     """
 
+    ALLOW_SELECT: ClassVar[bool] = True
+    """A switch to toggle arbitrary text selection for the app.
+    
+    Note that this doesn't apply to Input and TextArea which have builtin support for selection.
+    """
+
     _BASE_PATH: str | None = None
     CSS_PATH: ClassVar[CSSPathType | None] = None
     """File paths to load CSS from."""
@@ -1531,7 +1537,6 @@ def copy_to_clipboard(self, text: str) -> None:
         self._clipboard = text
         if self._driver is None:
             return
-
         import base64
 
         base64_text = base64.b64encode(text.encode("utf-8")).decode("utf-8")

src/textual/app.py

@@ -177,6 +177,7 @@ def automatic(cls, alpha_percentage: float = 100.0) -> Color:
         return cls(0, 0, 0, alpha_percentage / 100.0, auto=True)
 
     @classmethod
+    @lru_cache(maxsize=1024)
     def from_rich_color(
         cls, rich_color: RichColor | None, theme: TerminalTheme | None = None
     ) -> Color:
@@ -192,7 +193,9 @@ def from_rich_color(
         if rich_color is None:
             return TRANSPARENT
         r, g, b = rich_color.get_truecolor(theme)
-        return cls(r, g, b)
+        return cls(
+            r, g, b, ansi=rich_color.number if rich_color.is_system_defined else None
+        )
 
     @classmethod
     def from_hsl(cls, h: float, s: float, l: float) -> Color: