curses-syntax-highlighting 0.1.0__tar.gz

curses_syntax_highlighting-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Grim
+
+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.

curses_syntax_highlighting-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE README.md
+recursive-include examples *.py

curses_syntax_highlighting-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: curses-syntax-highlighting
+Version: 0.1.0
+Summary: Syntax highlighting for Python curses applications using Pygments
+Home-page: https://github.com/grimandgreedy/python_curses_syntax_highlighting
+Author: Grim
+License: MIT License
+        
+        Copyright (c) 2025 Grim
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/GITHUB_USERNAME/python_curses_syntax_highlighting
+Project-URL: Repository, https://github.com/GITHUB_USERNAME/python_curses_syntax_highlighting
+Project-URL: Issues, https://github.com/GITHUB_USERNAME/python_curses_syntax_highlighting/issues
+Keywords: curses,syntax,highlighting,terminal,tui,pygments
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Terminals
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygments>=2.0.0
+Requires-Dist: wcwidth>=0.2.0
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Python Curses Syntax Highlighting
+
+A Python library for displaying syntax-highlighted code in terminal applications using Python's curses library and Pygments for lexical analysis.
+
+## Features
+
+- **Syntax Highlighting**: Uses Pygments to support hundreds of programming languages
+- **File and String Input**: Display a file by path or pass a string directly
+- **Efficient Large File Handling**: Lazy loading with block-based caching
+- **Theme**: Light/dark theme support
+- **Optional Features**: Line numbers, indent guides, configurable display area, line wrapping or truncation
+- **Character Width Aware**: Properly handles special characters using wcwidth
+
+## Installation
+
+```bash
+pip install curses-syntax-highlighting
+```
+
+## Two Input Modes
+
+| | Function | Input | Lexer detection |
+|---|---|---|---|
+| **File** | `preview_text(stdscr, filepath)` | Path to a file on disk | Automatic (from filename + content) |
+| **String** | `preview_string(stdscr, text, language=)` | A string variable | You supply the language name |
+
+Use `preview_text` when rendering files. Use `preview_string` when the code comes from a variable - fetched from an API, generated at runtime, stored in a database, etc.
+
+## Quick Start
+
+```python
+import curses
+from curses_syntax_highlighting import preview_text, preview_string
+
+def main(stdscr):
+    # From a file - lexer detected automatically
+    preview_text(stdscr, 'example.py', show_line_numbers=True, theme='dark')
+    stdscr.getch()
+
+    # From a string - language supplied explicitly
+    code = open('example.rs').read()
+    preview_string(stdscr, code, language='rust', show_line_numbers=True)
+    stdscr.getch()
+
+curses.wrapper(main)
+```
+
+Both functions accept the same options: `code_x`, `code_y`, `code_w`, `code_h`, `show_line_numbers`, `indent_guides`, `theme` (`'dark'`/`'light'`), `wrap`, `bg_color`, `scroll_offset`. They return a viewer with a `total_lines` attribute useful for implementing scroll bounds.
+
+## Pure Renderer - No Key Stealing
+
+The library never calls `getch()`. Every function is a draw call that renders and returns immediately, leaving all input handling to your application:
+
+```python
+while True:
+    preview_text(stdscr, filepath, scroll_offset=scroll)
+    key = stdscr.getch()          # your app owns all input
+    if key == curses.KEY_DOWN:
+        scroll += 1
+```
+
+## API Reference
+
+### High-Level Functions
+
+#### `preview_text(stdscr, filepath, **options) → LazyFileViewer`
+
+Display a syntax-highlighted **file**. Lexer is detected automatically. Loads lazily in blocks - suitable for large files. Returns `None` if the file is not found.
+
+#### `preview_string(stdscr, text, language=None, **options) → TextViewer`
+
+Display a syntax-highlighted **string**. `language` is a Pygments alias (`'python'`, `'rust'`, `'javascript'`, …); pass `None` for plain text. The string is tokenized upfront and held in memory.
+
+#### `display_code(stdscr, viewer, token_to_color, code_x, code_y, code_w, code_h, show_line_numbers, indent_guides, scroll_offset=0, wrap=False)`
+
+Low-level renderer. Accepts any viewer with a `get_lines(start, count)` method and a `total_lines` attribute.
+
+#### `init_colors(theme_name='dark', start_color_id=200, bg_color=None)`
+
+Initialize curses color pairs for a theme. Must be called after `curses.initscr()`. Color pair IDs start at 200 by default, leaving 1–199 free for your application.
+
+### Classes
+
+#### `LazyFileViewer(filepath, lexer, block_size=50)` · `TextViewer(text, lexer)`
+
+Both expose `get_lines(start, count)` and `total_lines`. `LazyFileViewer` reads the file in blocks on demand; `TextViewer` tokenizes the full string upfront. Pass either to `display_code()`.
+
+#### `get_lexer(filepath)` · `get_lexer_for_language(language)`
+
+Detect a lexer from a file path or a language alias respectively.
+
+## Themes
+
+Two built-in themes: `'dark'` and `'light'`. Both default to the terminal's background color. Customize by editing `THEMES` in `curses_syntax_highlighting/themes.py`.
+
+## Requirements
+
+- Python 3.7+
+- pygments >= 2.0.0
+- wcwidth >= 0.2.0

curses_syntax_highlighting-0.1.0/README.md

@@ -0,0 +1,100 @@
+# Python Curses Syntax Highlighting
+
+A Python library for displaying syntax-highlighted code in terminal applications using Python's curses library and Pygments for lexical analysis.
+
+## Features
+
+- **Syntax Highlighting**: Uses Pygments to support hundreds of programming languages
+- **File and String Input**: Display a file by path or pass a string directly
+- **Efficient Large File Handling**: Lazy loading with block-based caching
+- **Theme**: Light/dark theme support
+- **Optional Features**: Line numbers, indent guides, configurable display area, line wrapping or truncation
+- **Character Width Aware**: Properly handles special characters using wcwidth
+
+## Installation
+
+```bash
+pip install curses-syntax-highlighting
+```
+
+## Two Input Modes
+
+| | Function | Input | Lexer detection |
+|---|---|---|---|
+| **File** | `preview_text(stdscr, filepath)` | Path to a file on disk | Automatic (from filename + content) |
+| **String** | `preview_string(stdscr, text, language=)` | A string variable | You supply the language name |
+
+Use `preview_text` when rendering files. Use `preview_string` when the code comes from a variable - fetched from an API, generated at runtime, stored in a database, etc.
+
+## Quick Start
+
+```python
+import curses
+from curses_syntax_highlighting import preview_text, preview_string
+
+def main(stdscr):
+    # From a file - lexer detected automatically
+    preview_text(stdscr, 'example.py', show_line_numbers=True, theme='dark')
+    stdscr.getch()
+
+    # From a string - language supplied explicitly
+    code = open('example.rs').read()
+    preview_string(stdscr, code, language='rust', show_line_numbers=True)
+    stdscr.getch()
+
+curses.wrapper(main)
+```
+
+Both functions accept the same options: `code_x`, `code_y`, `code_w`, `code_h`, `show_line_numbers`, `indent_guides`, `theme` (`'dark'`/`'light'`), `wrap`, `bg_color`, `scroll_offset`. They return a viewer with a `total_lines` attribute useful for implementing scroll bounds.
+
+## Pure Renderer - No Key Stealing
+
+The library never calls `getch()`. Every function is a draw call that renders and returns immediately, leaving all input handling to your application:
+
+```python
+while True:
+    preview_text(stdscr, filepath, scroll_offset=scroll)
+    key = stdscr.getch()          # your app owns all input
+    if key == curses.KEY_DOWN:
+        scroll += 1
+```
+
+## API Reference
+
+### High-Level Functions
+
+#### `preview_text(stdscr, filepath, **options) → LazyFileViewer`
+
+Display a syntax-highlighted **file**. Lexer is detected automatically. Loads lazily in blocks - suitable for large files. Returns `None` if the file is not found.
+
+#### `preview_string(stdscr, text, language=None, **options) → TextViewer`
+
+Display a syntax-highlighted **string**. `language` is a Pygments alias (`'python'`, `'rust'`, `'javascript'`, …); pass `None` for plain text. The string is tokenized upfront and held in memory.
+
+#### `display_code(stdscr, viewer, token_to_color, code_x, code_y, code_w, code_h, show_line_numbers, indent_guides, scroll_offset=0, wrap=False)`
+
+Low-level renderer. Accepts any viewer with a `get_lines(start, count)` method and a `total_lines` attribute.
+
+#### `init_colors(theme_name='dark', start_color_id=200, bg_color=None)`
+
+Initialize curses color pairs for a theme. Must be called after `curses.initscr()`. Color pair IDs start at 200 by default, leaving 1–199 free for your application.
+
+### Classes
+
+#### `LazyFileViewer(filepath, lexer, block_size=50)` · `TextViewer(text, lexer)`
+
+Both expose `get_lines(start, count)` and `total_lines`. `LazyFileViewer` reads the file in blocks on demand; `TextViewer` tokenizes the full string upfront. Pass either to `display_code()`.
+
+#### `get_lexer(filepath)` · `get_lexer_for_language(language)`
+
+Detect a lexer from a file path or a language alias respectively.
+
+## Themes
+
+Two built-in themes: `'dark'` and `'light'`. Both default to the terminal's background color. Customize by editing `THEMES` in `curses_syntax_highlighting/themes.py`.
+
+## Requirements
+
+- Python 3.7+
+- pygments >= 2.0.0
+- wcwidth >= 0.2.0

curses_syntax_highlighting-0.1.0/curses_syntax_highlighting/__init__.py

@@ -0,0 +1,37 @@
+"""Python Curses Syntax Highlighting
+
+A library for displaying syntax-highlighted code in terminal applications
+using Python's curses library and Pygments for lexing.
+
+Basic usage:
+    import curses
+    from curses_syntax_highlighting import preview_text
+
+    def main(stdscr):
+        preview_text(stdscr, 'myfile.py', show_line_numbers=True)
+
+    curses.wrapper(main)
+"""
+
+__version__ = '0.1.0'
+__author__ = 'Grim'
+
+# Public API
+from .themes import THEMES, get_theme
+from .highlighter import init_colors, get_color_for_token
+from .viewer import LazyFileViewer, TextViewer, get_lexer, get_lexer_for_language
+from .display import display_code, preview_text, preview_string
+
+__all__ = [
+    'THEMES',
+    'get_theme',
+    'init_colors',
+    'get_color_for_token',
+    'LazyFileViewer',
+    'TextViewer',
+    'get_lexer',
+    'get_lexer_for_language',
+    'display_code',
+    'preview_text',
+    'preview_string',
+]

curses_syntax_highlighting-0.1.0/curses_syntax_highlighting/display.py

@@ -0,0 +1,341 @@
+"""Display functions for rendering syntax-highlighted code in curses.
+
+This module provides high-level functions for displaying syntax-highlighted
+code in a curses window, with optional features like line numbers and indent guides.
+"""
+
+import curses
+import os
+from wcwidth import wcwidth
+
+from .highlighter import init_colors, get_color_for_token
+from .viewer import LazyFileViewer, TextViewer, get_lexer, get_lexer_for_language
+from pygments.token import Comment, Literal
+
+_BRACKETS = frozenset('()[]{}')
+
+
+def _get_char_color(ch, ttype, token_to_color):
+    if ch in _BRACKETS and not (ttype is Comment or ttype in Comment or ttype in Literal.String):
+        bracket_color = token_to_color.get("bracket")
+        if bracket_color is not None:
+            return bracket_color
+    return get_color_for_token(ttype, token_to_color)
+
+
+def display_code(
+    stdscr,
+    viewer,
+    token_to_color,
+    code_x,
+    code_y,
+    code_w,
+    code_h,
+    show_line_numbers,
+    indent_guides,
+    scroll_offset=0,
+    wrap=False
+):
+    """Display syntax-highlighted code in a curses window.
+
+    Args:
+        stdscr: Curses window object
+        viewer: LazyFileViewer instance
+        token_to_color: Token-to-color mapping from init_colors()
+        code_x: X coordinate of display area
+        code_y: Y coordinate of display area
+        code_w: Width of display area
+        code_h: Height of display area
+        show_line_numbers: Whether to show line numbers
+        indent_guides: Whether to show indent guides
+        scroll_offset: Line number to start displaying from (default: 0)
+        wrap: Whether to wrap long lines (default: False, truncate instead)
+    """
+    curses.curs_set(0)
+    max_y, max_x = stdscr.getmaxyx()
+
+    # Get background color for clearing display area
+    bg_color_attr = token_to_color.get("background", curses.color_pair(0))
+
+    # Clear the display area with the background color
+    for i in range(code_h):
+        try:
+            stdscr.addstr(code_y + i, code_x, ' ' * min(code_w, max_x - code_x), bg_color_attr)
+        except curses.error:
+            pass
+
+    # Calculate line number width
+    num_lines = viewer.total_lines
+    line_num_width = (len(str(num_lines)) + 2) if show_line_numbers else 0
+
+    # Calculate available width for code content
+    content_width = code_w - line_num_width
+
+    # Get visible lines
+    visible = viewer.get_lines(scroll_offset, code_h)
+
+    display_row = 0  # Track which display row we're on
+
+    for idx, line in enumerate(visible):
+        if display_row >= code_h:
+            break
+
+        y = code_y + display_row
+        if y >= max_y or y >= code_y + code_h:
+            break
+
+        x = code_x
+
+        # Draw line numbers (only on first row of wrapped line)
+        if show_line_numbers:
+            ln = str(scroll_offset + idx + 1).rjust(line_num_width - 1) + " "
+            ln_color = token_to_color.get("line_number", curses.color_pair(0))
+            try:
+                stdscr.addstr(y, x, ln[:min(line_num_width, max_x - x)], ln_color)
+            except curses.error:
+                pass
+            x += line_num_width
+
+        # Draw code with syntax highlighting
+        if wrap:
+            # Wrapping mode: continue on next lines if content exceeds width
+            col = 0
+            char_idx = 0
+            in_leading_whitespace = True  # Track if we're still in leading whitespace
+
+            while char_idx < len(line):
+                if display_row >= code_h:
+                    break
+
+                y = code_y + display_row
+                if y >= max_y or y >= code_y + code_h:
+                    break
+
+                # For continuation lines, fill line number area with spaces
+                if col >= content_width and char_idx < len(line):
+                    display_row += 1
+                    col = 0
+                    in_leading_whitespace = False  # Wrapped lines are not leading whitespace
+                    if display_row >= code_h:
+                        break
+                    y = code_y + display_row
+                    if y >= max_y or y >= code_y + code_h:
+                        break
+                    x = code_x
+
+                    # Draw empty line number area for wrapped continuation
+                    if show_line_numbers:
+                        try:
+                            stdscr.addstr(y, x, " " * line_num_width, bg_color_attr)
+                        except curses.error:
+                            pass
+                        x += line_num_width
+
+                if char_idx >= len(line):
+                    break
+
+                ch, ttype = line[char_idx]
+                width = wcwidth(ch)
+                if width < 0:
+                    width = 0  # unprintable
+
+                # Check if character fits in current line
+                if col + width > content_width:
+                    # Move to next line
+                    display_row += 1
+                    col = 0
+                    in_leading_whitespace = False  # Wrapped content is not leading whitespace
+                    continue
+
+                # Track leading whitespace - once we see a non-space, we're done
+                if ch != ' ' and ch != '\t':
+                    in_leading_whitespace = False
+
+                try:
+                    # Only draw indent guides in leading whitespace
+                    if indent_guides and in_leading_whitespace and ch == ' ' and (col % 4 == 0) and col + width <= content_width:
+                        guide = token_to_color.get("indent_guide", curses.color_pair(0))
+                        stdscr.addstr(y, x + col, '│', guide)
+                    else:
+                        color = _get_char_color(ch, ttype, token_to_color)
+                        stdscr.addstr(y, x + col, ch, color)
+                except curses.error:
+                    pass
+
+                col += width
+                char_idx += 1
+
+            display_row += 1
+
+        else:
+            # Truncate mode: stop at width boundary
+            col = 0
+            in_leading_whitespace = True  # Track if we're still in leading whitespace
+
+            for ch, ttype in line:
+                width = wcwidth(ch)
+                if width < 0:
+                    width = 0  # unprintable
+
+                # Check boundary: respect code_w, not max_x
+                if col + width > content_width:
+                    break
+
+                # Track leading whitespace - once we see a non-space, we're done
+                if ch != ' ' and ch != '\t':
+                    in_leading_whitespace = False
+
+                try:
+                    # Only draw indent guides in leading whitespace
+                    if indent_guides and in_leading_whitespace and ch == ' ' and (col % 4 == 0):
+                        guide = token_to_color.get("indent_guide", curses.color_pair(0))
+                        stdscr.addstr(y, x + col, '│', guide)
+                    else:
+                        color = _get_char_color(ch, ttype, token_to_color)
+                        stdscr.addstr(y, x + col, ch, color)
+                except curses.error:
+                    pass
+
+                col += width
+
+            display_row += 1
+
+    stdscr.refresh()
+
+
+def preview_text(
+    stdscr,
+    filepath,
+    code_x=0,
+    code_y=0,
+    code_w=None,
+    code_h=None,
+    show_line_numbers=False,
+    indent_guides=False,
+    theme="dark",
+    wrap=False,
+    bg_color=None,
+    scroll_offset=0
+):
+    """Display a syntax-highlighted preview of a text file.
+
+    This is the main high-level function for displaying a file with
+    syntax highlighting.
+
+    Args:
+        stdscr: Curses window object
+        filepath: Path to the file to preview
+        code_x: X coordinate of display area (default: 0)
+        code_y: Y coordinate of display area (default: 0)
+        code_w: Width of display area (default: remaining width)
+        code_h: Height of display area (default: remaining height)
+        show_line_numbers: Whether to show line numbers (default: False)
+        indent_guides: Whether to show indent guides (default: False)
+        theme: Color theme to use ('dark' or 'light', default: 'dark')
+        wrap: Whether to wrap long lines (default: False, truncate instead)
+        bg_color: Optional background color override. Use -1 for terminal
+                  default (recommended), or a curses color number (0-255).
+                  If None, uses theme default (-1 for terminal background).
+        scroll_offset: Line number to start displaying from (default: 0)
+
+    Returns:
+        LazyFileViewer: The viewer instance (access viewer.total_lines for line count)
+                        Returns None on error (file not found, etc.)
+    """
+    try:
+        if not os.path.isfile(filepath):
+            return None
+
+        lexer = get_lexer(filepath)
+
+        max_y, max_x = stdscr.getmaxyx()
+
+        if code_w is None:
+            code_w = max_x - code_x
+        if code_h is None:
+            code_h = max_y - code_y
+
+        viewer = LazyFileViewer(filepath, lexer, block_size=code_h)
+        token_to_color = init_colors(theme, bg_color=bg_color)
+
+        display_code(
+            stdscr=stdscr,
+            viewer=viewer,
+            token_to_color=token_to_color,
+            code_x=code_x,
+            code_y=code_y,
+            code_w=code_w,
+            code_h=code_h,
+            show_line_numbers=show_line_numbers,
+            indent_guides=indent_guides,
+            scroll_offset=scroll_offset,
+            wrap=wrap,
+        )
+
+        return viewer
+    except Exception:
+        return None
+
+
+def preview_string(
+    stdscr,
+    text,
+    language=None,
+    code_x=0,
+    code_y=0,
+    code_w=None,
+    code_h=None,
+    show_line_numbers=False,
+    indent_guides=False,
+    theme="dark",
+    wrap=False,
+    bg_color=None,
+    scroll_offset=0,
+):
+    """Display a syntax-highlighted preview of a plain-text string.
+
+    Args:
+        stdscr: Curses window object.
+        text: The source text to display.
+        language: Pygments language alias for syntax highlighting, e.g. 'python',
+                  'rust', 'javascript'. Pass None for plain text with no highlighting.
+        code_x: X coordinate of display area (default: 0).
+        code_y: Y coordinate of display area (default: 0).
+        code_w: Width of display area (default: remaining width).
+        code_h: Height of display area (default: remaining height).
+        show_line_numbers: Whether to show line numbers (default: False).
+        indent_guides: Whether to show indent guides (default: False).
+        theme: Color theme ('dark' or 'light', default: 'dark').
+        wrap: Whether to wrap long lines (default: False).
+        bg_color: Background color override. Use -1 or None for terminal default.
+        scroll_offset: Line number to start displaying from (default: 0).
+
+    Returns:
+        TextViewer: The viewer instance (access viewer.total_lines for line count).
+    """
+    lexer = get_lexer_for_language(language)
+
+    max_y, max_x = stdscr.getmaxyx()
+    if code_w is None:
+        code_w = max_x - code_x
+    if code_h is None:
+        code_h = max_y - code_y
+
+    viewer = TextViewer(text, lexer)
+    token_to_color = init_colors(theme, bg_color=bg_color)
+
+    display_code(
+        stdscr=stdscr,
+        viewer=viewer,
+        token_to_color=token_to_color,
+        code_x=code_x,
+        code_y=code_y,
+        code_w=code_w,
+        code_h=code_h,
+        show_line_numbers=show_line_numbers,
+        indent_guides=indent_guides,
+        scroll_offset=scroll_offset,
+        wrap=wrap,
+    )
+
+    return viewer