""" The compositor handles combining widgets in to a single screen (i.e. compositing). It also stores the results of that process, so that Textual knows the widgets on the screen and their locations. The compositor uses this information to answer queries regarding the widget under an offset, or the style under an offset. Additionally, the compositor can render portions of the screen which may have updated, without having to render the entire screen. """ from __future__ import annotations import sys from itertools import chain from operator import itemgetter from typing import TYPE_CHECKING, Callable, Iterable, NamedTuple, cast import rich.repr from rich.console import Console, ConsoleOptions, RenderableType, RenderResult from rich.control import Control from rich.segment import Segment from rich.style import Style from . import errors from ._cells import cell_len from ._loop import loop_last from ._profile import timer from ._types import Lines from .geometry import Offset, Region, Size if sys.version_info >= (3, 10): from typing import TypeAlias else: # pragma: no cover from typing_extensions import TypeAlias if TYPE_CHECKING: from .widget import Widget class ReflowResult(NamedTuple): """The result of a reflow operation. Describes the chances to widgets.""" hidden: set[Widget] # Widgets that are hidden shown: set[Widget] # Widgets that are shown resized: set[Widget] # Widgets that have been resized class MapGeometry(NamedTuple): """Defines the absolute location of a Widget.""" region: Region # The (screen) region occupied by the widget order: tuple[tuple[int, ...], ...] # A tuple of ints defining the painting order clip: Region # A region to clip the widget by (if a Widget is within a container) virtual_size: Size # The virtual size (scrollable region) of a widget if it is a container container_size: Size # The container size (area not occupied by scrollbars) virtual_region: Region # The region relative to the container (but not necessarily visible) @property def visible_region(self) -> Region: """The Widget region after clipping.""" return self.clip.intersection(self.region) # Maps a widget on to its geometry (information that describes its position in the composition) CompositorMap: TypeAlias = "dict[Widget, MapGeometry]" @rich.repr.auto(angular=True) class LayoutUpdate: """A renderable containing the result of a render for a given region.""" def __init__(self, lines: Lines, region: Region) -> None: self.lines = lines self.region = region def __rich_console__( self, console: Console, options: ConsoleOptions ) -> RenderResult: x = self.region.x new_line = Segment.line() move_to = Control.move_to for last, (y, line) in loop_last(enumerate(self.lines, self.region.y)): yield move_to(x, y) yield from line if not last: yield new_line def __rich_repr__(self) -> rich.repr.Result: yield self.region @rich.repr.auto(angular=True) class ChopsUpdate: """A renderable that applies updated spans to the screen.""" def __init__( self, chops: list[dict[int, list[Segment] | None]], spans: list[tuple[int, int, int]], chop_ends: list[list[int]], ) -> None: """A renderable which updates chops (fragments of lines). Args: chops (list[dict[int, list[Segment] | None]]): A mapping of offsets to list of segments, per line. crop (Region): Region to restrict update to. chop_ends (list[list[int]]): A list of the end offsets for each line """ self.chops = chops self.spans = spans self.chop_ends = chop_ends def __rich_console__( self, console: Console, options: ConsoleOptions ) -> RenderResult: move_to = Control.move_to new_line = Segment.line() chops = self.chops chop_ends = self.chop_ends last_y = self.spans[-1][0] _cell_len = cell_len for y, x1, x2 in self.spans: line = chops[y] ends = chop_ends[y] for end, (x, segments) in zip(ends, line.items()): # TODO: crop to x extents if segments is None: continue if x > x2 or end <= x1: continue if x2 > x >= x1 and end <= x2: yield move_to(x, y) yield from segments continue iter_segments = iter(segments) if x < x1: for segment in iter_segments: next_x = x + _cell_len(segment.text) if next_x > x1: yield move_to(x, y) yield segment break x = next_x else: yield move_to(x, y) if end <= x2: yield from iter_segments else: for segment in iter_segments: if x >= x2: break yield segment x += _cell_len(segment.text) if y != last_y: yield new_line def __rich_repr__(self) -> rich.repr.Result: return yield @rich.repr.auto(angular=True) class Compositor: """Responsible for storing information regarding the relative positions of Widgets and rendering them.""" def __init__(self) -> None: # A mapping of Widget on to its "render location" (absolute position / depth) self.map: CompositorMap = {} self._layers: list[tuple[Widget, MapGeometry]] | None = None # All widgets considered in the arrangement # Note this may be a superset of self.map.keys() as some widgets may be invisible for various reasons self.widgets: set[Widget] = set() # Mapping of visible widgets on to their region, and clip region self._visible_widgets: dict[Widget, tuple[Region, Region]] | None = None # The top level widget self.root: Widget | None = None # Dimensions of the arrangement self.size = Size(0, 0) # The points in each line where the line bisects the left and right edges of the widget self._cuts: list[list[int]] | None = None # Regions that require an update self._dirty_regions: set[Region] = set() # Mapping of line numbers on to lists of widget and regions self._layers_visible: list[list[tuple[Widget, Region, Region]]] | None = None @classmethod def _regions_to_spans( cls, regions: Iterable[Region] ) -> Iterable[tuple[int, int, int]]: """Converts the regions to horizontal spans. Spans will be combined if they overlap or are contiguous to produce optimal non-overlapping spans. Args: regions (Iterable[Region]): An iterable of Regions. Returns: Iterable[tuple[int, int, int]]: Yields tuples of (Y, X1, X2) """ inline_ranges: dict[int, list[tuple[int, int]]] = {} setdefault = inline_ranges.setdefault for region_x, region_y, width, height in regions: span = (region_x, region_x + width) for y in range(region_y, region_y + height): setdefault(y, []).append(span) slice_remaining = slice(1, None) for y, ranges in sorted(inline_ranges.items()): if len(ranges) == 1: # Special case of 1 span yield (y, *ranges[0]) else: ranges.sort() x1, x2 = ranges[0] for next_x1, next_x2 in ranges[slice_remaining]: if next_x1 <= x2: if next_x2 > x2: x2 = next_x2 else: yield (y, x1, x2) x1 = next_x1 x2 = next_x2 yield (y, x1, x2) def __rich_repr__(self) -> rich.repr.Result: yield "size", self.size yield "widgets", self.widgets def reflow(self, parent: Widget, size: Size) -> ReflowResult: """Reflow (layout) widget and its children. Args: parent (Widget): The root widget. size (Size): Size of the area to be filled. Returns: ReflowResult: Hidden shown and resized widgets """ self._cuts = None self._layers = None self._layers_visible = None self._visible_widgets = None self.root = parent self.size = size # Keep a copy of the old map because we're going to compare it with the update old_map = self.map.copy() old_widgets = old_map.keys() map, widgets = self._arrange_root(parent, size) new_widgets = map.keys() # Newly visible widgets shown_widgets = new_widgets - old_widgets # Newly hidden widgets hidden_widgets = old_widgets - new_widgets # Replace map and widgets self.map = map self.widgets = widgets screen = size.region # Widgets with changed size resized_widgets = { widget for widget, (region, *_) in map.items() if widget in old_widgets and old_map[widget].region.size != region.size } # Gets pairs of tuples of (Widget, MapGeometry) which have changed # i.e. if something is moved / deleted / added if screen not in self._dirty_regions: crop_screen = screen.intersection changes = map.items() ^ old_map.items() regions = { region for region in ( crop_screen(map_geometry.visible_region) for _, map_geometry in changes ) if region } self._dirty_regions.update(regions) return ReflowResult( hidden=hidden_widgets, shown=shown_widgets, resized=resized_widgets, ) @property def visible_widgets(self) -> dict[Widget, tuple[Region, Region]]: """Get a mapping of widgets on to region and clip. Returns: dict[Widget, tuple[Region, Region]]: visible widget mapping. """ if self._visible_widgets is None: screen = self.size.region in_screen = screen.overlaps overlaps = Region.overlaps # Widgets and regions in render order visible_widgets = [ (order, widget, region, clip) for widget, (region, order, clip, _, _, _) in self.map.items() if in_screen(region) and overlaps(clip, region) ] visible_widgets.sort(key=itemgetter(0), reverse=True) self._visible_widgets = { widget: (region, clip) for _, widget, region, clip in visible_widgets } return self._visible_widgets def _arrange_root( self, root: Widget, size: Size ) -> tuple[CompositorMap, set[Widget]]: """Arrange a widgets children based on its layout attribute. Args: root (Widget): Top level widget. Returns: tuple[CompositorMap, set[Widget]]: Compositor map and set of widgets. """ ORIGIN = Offset(0, 0) map: CompositorMap = {} widgets: set[Widget] = set() layer_order: int = 0 def add_widget( widget: Widget, virtual_region: Region, region: Region, order: tuple[tuple[int, ...], ...], layer_order: int, clip: Region, ) -> None: """Called recursively to place a widget and its children in the map. Args: widget (Widget): The widget to add. region (Region): The region the widget will occupy. order (tuple[int, ...]): A tuple of ints to define the order. clip (Region): The clipping region (i.e. the viewport which contains it). """ widgets.add(widget) styles_offset = widget.styles.offset layout_offset = ( styles_offset.resolve(region.size, clip.size) if styles_offset else ORIGIN ) # Container region is minus border container_region = region.shrink(widget.styles.gutter) container_size = container_region.size # Widgets with scrollbars (containers or scroll view) require additional processing if widget.is_scrollable: # The region that contains the content (container region minus scrollbars) child_region = widget._get_scrollable_region(container_region) # Adjust the clip region accordingly sub_clip = clip.intersection(child_region) # The region covered by children relative to parent widget total_region = child_region.reset_offset if widget.is_container: # Arrange the layout placements, arranged_widgets, spacing = widget._arrange( child_region.size ) widgets.update(arranged_widgets) # An offset added to all placements placement_offset = container_region.offset + layout_offset placement_scroll_offset = placement_offset - widget.scroll_offset _layers = widget.layers layers_to_index = { layer_name: index for index, layer_name in enumerate(_layers) } get_layer_index = layers_to_index.get # Add all the widgets for sub_region, margin, sub_widget, z, fixed in reversed( placements ): # Combine regions with children to calculate the "virtual size" if fixed: widget_region = sub_region + placement_offset else: total_region = total_region.union( sub_region.grow(spacing + margin) ) widget_region = sub_region + placement_scroll_offset widget_order = order + ( (get_layer_index(sub_widget.layer, 0), z, layer_order), ) add_widget( sub_widget, sub_region, widget_region, widget_order, layer_order, sub_clip, ) layer_order -= 1 # Add any scrollbars for chrome_widget, chrome_region in widget._arrange_scrollbars( container_region ): map[chrome_widget] = MapGeometry( chrome_region + layout_offset, order, clip, container_size, container_size, chrome_region, ) map[widget] = MapGeometry( region + layout_offset, order, clip, total_region.size, container_size, virtual_region, ) else: # Add the widget to the map map[widget] = MapGeometry( region + layout_offset, order, clip, region.size, container_size, virtual_region, ) # Add top level (root) widget add_widget(root, size.region, size.region, ((0,),), layer_order, size.region) return map, widgets @property def layers(self) -> list[tuple[Widget, MapGeometry]]: """Get widgets and geometry in layer order.""" if self._layers is None: self._layers = sorted( self.map.items(), key=lambda item: item[1].order, reverse=True ) return self._layers @property def layers_visible(self) -> list[list[tuple[Widget, Region, Region]]]: """Visible widgets and regions in layers order.""" if self._layers_visible is None: layers_visible: list[list[tuple[Widget, Region, Region]]] layers_visible = [[] for y in range(self.size.height)] layers_visible_appends = [layer.append for layer in layers_visible] intersection = Region.intersection _range = range for widget, (region, clip) in self.visible_widgets.items(): cropped_region = intersection(region, clip) _x, region_y, _width, region_height = cropped_region if region_height: widget_location = (widget, cropped_region, region) for y in _range(region_y, region_y + region_height): layers_visible_appends[y](widget_location) self._layers_visible = layers_visible return self._layers_visible def get_offset(self, widget: Widget) -> Offset: """Get the offset of a widget.""" try: return self.map[widget].region.offset except KeyError: raise errors.NoWidget("Widget is not in layout") def get_widget_at(self, x: int, y: int) -> tuple[Widget, Region]: """Get the widget under a given coordinate. Args: x (int): X Coordinate. y (int): Y Coordinate. Raises: errors.NoWidget: If there is not widget underneath (x, y). Returns: tuple[Widget, Region]: A tuple of the widget and its region. """ contains = Region.contains if len(self.layers_visible) > y >= 0: for widget, cropped_region, region in self.layers_visible[y]: if contains(cropped_region, x, y) and widget.visible: return widget, region raise errors.NoWidget(f"No widget under screen coordinate ({x}, {y})") def get_widgets_at(self, x: int, y: int) -> Iterable[tuple[Widget, Region]]: """Get all widgets under a given coordinate. Args: x (int): X coordinate. y (int): Y coordinate. Returns: Iterable[tuple[Widget, Region]]: Sequence of (WIDGET, REGION) tuples. """ contains = Region.contains for widget, cropped_region, region in self.layers_visible[y]: if contains(cropped_region, x, y) and widget.visible: yield widget, region def get_style_at(self, x: int, y: int) -> Style: """Get the Style at the given cell or Style.null() Args: x (int): X position within the Layout y (int): Y position within the Layout Returns: Style: The Style at the cell (x, y) within the Layout """ try: widget, region = self.get_widget_at(x, y) except errors.NoWidget: return Style.null() if widget not in self.visible_widgets: return Style.null() x -= region.x y -= region.y lines = widget.render_lines(Region(0, y, region.width, 1)) 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 find_widget(self, widget: Widget) -> MapGeometry: """Get information regarding the relative position of a widget in the Compositor. Args: widget (Widget): The Widget in this layout you wish to know the Region of. Raises: NoWidget: If the Widget is not contained in this Layout. Returns: MapGeometry: Widget's composition information. """ try: region = self.map[widget] except KeyError: raise errors.NoWidget("Widget is not in layout") else: return region @property def cuts(self) -> list[list[int]]: """Get vertical cuts. A cut is every point on a line where a widget starts or ends. Returns: list[list[int]]: A list of cuts for every line. """ if self._cuts is not None: return self._cuts width, height = self.size screen_region = self.size.region cuts = [[0, width] for _ in range(height)] intersection = Region.intersection extend = list.extend for region, clip in self.visible_widgets.values(): region = intersection(region, clip) if region and (region in screen_region): x, y, region_width, region_height = region region_cuts = (x, x + region_width) for cut in cuts[y : y + region_height]: extend(cut, region_cuts) # Sort the cuts for each line self._cuts = [sorted(set(line_cuts)) for line_cuts in cuts] return self._cuts def _get_renders( self, crop: Region | None = None ) -> Iterable[tuple[Region, Region, Lines]]: """Get rendered widgets (lists of segments) in the composition. Returns: Iterable[tuple[Region, Region, Lines]]: An iterable of , , and """ # If a renderable throws an error while rendering, the user likely doesn't care about the traceback # up to this point. _rich_traceback_guard = True if not self.map: return def is_visible(widget: Widget) -> bool: """Return True if the widget is (literally) visible by examining various properties which affect whether it can be seen or not.""" return ( widget.visible and not widget.is_transparent and widget.styles.opacity > 0 ) _Region = Region visible_widgets = self.visible_widgets if crop: crop_overlaps = crop.overlaps widget_regions = [ (widget, region, clip) for widget, (region, clip) in visible_widgets.items() if crop_overlaps(clip) and is_visible(widget) ] else: widget_regions = [ (widget, region, clip) for widget, (region, clip) in visible_widgets.items() if is_visible(widget) ] intersection = _Region.intersection contains_region = _Region.contains_region for widget, region, clip in widget_regions: if contains_region(clip, region): yield region, clip, widget.render_lines( _Region(0, 0, region.width, region.height) ) else: clipped_region = intersection(region, clip) if not clipped_region: continue new_x, new_y, new_width, new_height = clipped_region delta_x = new_x - region.x delta_y = new_y - region.y yield region, clip, widget.render_lines( _Region(delta_x, delta_y, new_width, new_height) ) @classmethod def _assemble_chops( cls, chops: list[dict[int, list[Segment] | None]] ) -> list[list[Segment]]: """Combine chops in to lines.""" from_iterable = chain.from_iterable segment_lines: list[list[Segment]] = [ list(from_iterable(line for line in bucket.values() if line is not None)) for bucket in chops ] return segment_lines def render(self, full: bool = False) -> RenderableType | None: """Render a layout. Returns: SegmentLines: A renderable """ width, height = self.size screen_region = Region(0, 0, width, height) if full: update_regions: set[Region] = set() else: update_regions = self._dirty_regions.copy() if screen_region in update_regions: # If one of the updates is the entire screen, then we only need one update full = True self._dirty_regions.clear() if full: crop = screen_region spans = [] is_rendered_line = lambda y: True elif update_regions: # Create a crop regions that surrounds all updates crop = Region.from_union(update_regions).intersection(screen_region) spans = list(self._regions_to_spans(update_regions)) is_rendered_line = {y for y, _, _ in spans}.__contains__ else: return None divide = Segment.divide # Maps each cut on to a list of segments cuts = self.cuts # dict.fromkeys is a callable which takes a list of ints returns a dict which maps ints on to a list of Segments or None. fromkeys = cast( "Callable[[list[int]], dict[int, list[Segment] | None]]", dict.fromkeys ) # A mapping of cut index to a list of segments for each line chops: list[dict[int, list[Segment] | None]] chops = [fromkeys(cut_set[:-1]) for cut_set in cuts] cut_segments: Iterable[list[Segment]] # Go through all the renders in reverse order and fill buckets with no render renders = self._get_renders(crop) intersection = Region.intersection for region, clip, lines in renders: render_region = intersection(region, clip) for y, line in zip(render_region.line_range, lines): if not is_rendered_line(y): continue chops_line = chops[y] first_cut, last_cut = render_region.column_span cuts_line = cuts[y] final_cuts = [ cut for cut in cuts_line if (last_cut >= cut >= first_cut) ] if len(final_cuts) <= 2: # Two cuts, which means the entire line cut_segments = [line] else: render_x = render_region.x relative_cuts = [cut - render_x for cut in final_cuts[1:]] cut_segments = divide(line, relative_cuts) # Since we are painting front to back, the first segments for a cut "wins" for cut, segments in zip(final_cuts, cut_segments): if chops_line[cut] is None: chops_line[cut] = segments if full: render_lines = self._assemble_chops(chops) return LayoutUpdate(render_lines, screen_region) else: chop_ends = [cut_set[1:] for cut_set in cuts] return ChopsUpdate(chops, spans, chop_ends) def __rich_console__( self, console: Console, options: ConsoleOptions ) -> RenderResult: if self._dirty_regions: yield self.render() def update_widgets(self, widgets: set[Widget]) -> None: """Update a given widget in the composition. Args: console (Console): Console instance. widget (Widget): Widget to update. """ regions: list[Region] = [] add_region = regions.append get_widget = self.visible_widgets.__getitem__ for widget in self.visible_widgets.keys() & widgets: region, clip = get_widget(widget) offset = region.offset intersection = clip.intersection for dirty_region in widget._exchange_repaint_regions(): update_region = intersection(dirty_region.translate(offset)) if update_region: add_region(update_region) self._dirty_regions.update(regions)