toga-code-editor 0.1.1__py3-none-any.whl

toga_code_editor/platforms/cocoa.py

@@ -0,0 +1,264 @@
+from bisect import bisect_right
+
+from rubicon.objc import (
+    SEL,
+    NSPoint,
+    NSRange,
+    NSRect,
+    ObjCClass,
+    objc_method,
+    objc_property,
+)
+from toga_cocoa.colors import native_color
+from toga_cocoa.libs import (
+    NSAttributedString,
+    NSBezelBorder,
+    NSColor,
+    NSFontAttributeName,
+    NSFontManager,
+    NSForegroundColorAttributeName,
+    NSMutableDictionary,
+    NSNotificationCenter,
+    NSScrollView,
+    NSViewBoundsDidChangeNotification,
+    NSViewHeightSizable,
+    NSViewWidthSizable,
+)
+from toga_cocoa.widgets.multilinetextinput import MultilineTextInput, TogaTextView
+
+from ..highlighting import to_utf16_spans, utf16_line_starts
+
+NSRulerView = ObjCClass("NSRulerView")
+
+# NSRulerOrientation
+NSVerticalRuler = 1
+# NSFontTraitMask
+NSItalicFontMask = 1 << 0
+NSBoldFontMask = 1 << 1
+
+GUTTER_PADDING = 6
+
+
+class TogaCodeTextView(TogaTextView):
+    @objc_method
+    def textDidChange_(self, notification) -> None:
+        self.interface._schedule_rehighlight()
+        self.interface.on_change()
+        self.impl.text_changed()
+
+
+class TogaLineNumberView(NSRulerView):
+    impl = objc_property(object, weak=True)
+
+    @objc_method
+    def boundsDidChange_(self, notification) -> None:
+        # The text scrolled; the visible line numbers changed with it.
+        self.setNeedsDisplay(True)
+
+    @objc_method
+    def drawHashMarksAndLabelsInRect_(self, rect: NSRect) -> None:
+        self.impl.draw_line_numbers()
+
+
+class CodeEditor(MultilineTextInput):
+    def create(self):
+        # Mirrors toga_cocoa's MultilineTextInput.create(), swapping in
+        # TogaCodeTextView, turning off prose features, and adding a ruler.
+        self.native = NSScrollView.alloc().init()
+        self.native.hasVerticalScroller = True
+        self.native.hasHorizontalScroller = False
+        self.native.autohidesScrollers = False
+        self.native.borderType = NSBezelBorder
+
+        self.native_text = TogaCodeTextView.alloc().init()
+        self.native_text.interface = self.interface
+        self.native_text.impl = self
+        self.native_text.delegate = self.native_text
+
+        self.native_text.editable = True
+        self.native_text.selectable = True
+        self.native_text.allowsUndo = True
+        self.native_text.verticallyResizable = True
+        self.native_text.horizontallyResizable = False
+        self.native_text.usesAdaptiveColorMappingForDarkAppearance = True
+        self.native_text.setAutomaticQuoteSubstitutionEnabled(False)
+        self.native_text.setAutomaticDashSubstitutionEnabled(False)
+        # Code is not prose.
+        self.native_text.setContinuousSpellCheckingEnabled(False)
+        self.native_text.setGrammarCheckingEnabled(False)
+        self.native_text.setAutomaticSpellingCorrectionEnabled(False)
+        self.native_text.setAutomaticTextReplacementEnabled(False)
+        self.native_text.setAutomaticTextCompletionEnabled(False)
+
+        self.native_text.autoresizingMask = NSViewWidthSizable | NSViewHeightSizable
+        self.native.documentView = self.native_text
+
+        # Reading layoutManager opts the view into TextKit 1, which is what the
+        # gutter's line-fragment queries need. Do it once, up front.
+        self.layout_manager = self.native_text.layoutManager
+
+        self.ruler = TogaLineNumberView.alloc().initWithScrollView(
+            self.native, orientation=NSVerticalRuler
+        )
+        self.ruler.impl = self
+        self.ruler.clientView = self.native_text
+        self.ruler.reservedThicknessForMarkers = 0
+        self.ruler.reservedThicknessForAccessoryView = 0
+        # Since macOS 14 views no longer clip by default, and AppKit hands the ruler
+        # a dirty rect that reaches the window's top edge, so its rule line would be
+        # drawn above the scroll view. Earlier systems always clip.
+        if self.ruler.respondsToSelector_(SEL("setClipsToBounds:")):
+            self.ruler.clipsToBounds = True
+        self.native.hasVerticalRuler = True
+        self.native.verticalRulerView = self.ruler
+        self.native.rulersVisible = True
+
+        # Redraw the gutter whenever the clip view scrolls.
+        self.native.contentView.postsBoundsChangedNotifications = True
+        NSNotificationCenter.defaultCenter.addObserver(
+            self.ruler,
+            selector=SEL("boundsDidChange:"),
+            name=NSViewBoundsDidChangeNotification,
+            object=self.native.contentView,
+        )
+
+        # NSTextView.font and .textColor read back the *first character's* attributes
+        # once the storage is styled, so the base style is tracked here instead.
+        self.base_font = self.native_text.font
+        self.base_color = NSColor.textColor
+
+        self.theme = {}
+        self.attributes = {}
+        self.spans = []
+        self.line_starts = [0]
+
+        self.add_constraints()
+
+    # Inherited MultilineTextInput methods that must keep the gutter and colors in sync
+
+    def set_value(self, value):
+        super().set_value(value)
+        self.text_changed()
+
+    def set_font(self, font):
+        super().set_font(font)
+        self.base_font = font._impl.native
+        self.rebuild_attributes()
+        self.apply_highlights()
+        self.text_changed()
+
+    def set_color(self, value):
+        super().set_color(value)
+        self.base_color = native_color(value) or NSColor.textColor
+        self.apply_highlights()
+
+    # CodeEditor backend contract
+
+    def set_theme(self, theme):
+        self.theme = theme
+        self.rebuild_attributes()
+
+    def set_highlights(self, spans):
+        self.spans = spans
+        self.apply_highlights()
+
+    def set_show_line_numbers(self, value):
+        self.native.rulersVisible = value
+
+    # Highlighting
+
+    def rebuild_attributes(self):
+        base_font = self.base_font
+        manager = NSFontManager.sharedFontManager
+        self.attributes = {}
+        for kind, style in self.theme.items():
+            attributes = NSMutableDictionary.alloc().init()
+            attributes[NSForegroundColorAttributeName] = native_color(style.color)
+            traits = 0
+            if style.bold:
+                traits |= NSBoldFontMask
+            if style.italic:
+                traits |= NSItalicFontMask
+            if traits:
+                attributes[NSFontAttributeName] = manager.convertFont(
+                    base_font, toHaveTrait=traits
+                )
+            self.attributes[kind] = attributes
+
+    def apply_highlights(self):
+        storage = self.native_text.textStorage
+        length = storage.length()
+        full_range = NSRange(0, length)
+        # Between a native edit and the debounced re-highlight the spans describe the
+        # previous text, so clamp them: a range past the end raises NSRangeException
+        # inside AppKit, which cannot be caught from Python. Convert before editing
+        # so a Python error cannot leave the storage mid-edit either.
+        spans = [
+            (span.start, min(span.end, length), self.attributes.get(span.kind))
+            for span in to_utf16_spans(self.get_value(), self.spans)
+            if span.start < length
+        ]
+        storage.beginEditing()
+        # Reset to the base font and color, then paint each span.
+        storage.addAttribute(
+            NSFontAttributeName, value=self.base_font, range=full_range
+        )
+        storage.addAttribute(
+            NSForegroundColorAttributeName, value=self.base_color, range=full_range
+        )
+        for start, end, attributes in spans:
+            if attributes is not None and end > start:
+                storage.addAttributes(attributes, range=NSRange(start, end - start))
+        storage.endEditing()
+
+    # Gutter
+
+    def text_changed(self):
+        self.line_starts = utf16_line_starts(self.get_value())
+        digits = len(str(len(self.line_starts)))
+        label = self.gutter_label("0" * digits)
+        thickness = label.size().width + 2 * GUTTER_PADDING
+        if self.ruler.ruleThickness != thickness:
+            self.ruler.ruleThickness = thickness
+        self.ruler.setNeedsDisplay(True)
+
+    def gutter_label(self, text):
+        attributes = NSMutableDictionary.alloc().init()
+        attributes[NSFontAttributeName] = self.base_font
+        attributes[NSForegroundColorAttributeName] = NSColor.secondaryLabelColor
+        return NSAttributedString.alloc().initWithString(text, attributes=attributes)
+
+    def draw_line_numbers(self):
+        layout = self.layout_manager
+        container = self.native_text.textContainer
+        visible = self.native_text.visibleRect
+        inset = self.native_text.textContainerInset
+        text_length = self.native_text.textStorage.length()
+
+        glyph_range = layout.glyphRangeForBoundingRect(
+            visible, inTextContainer=container
+        )
+        char_range = layout.characterRangeForGlyphRange(
+            glyph_range, actualGlyphRange=None
+        )
+        first_line = max(bisect_right(self.line_starts, char_range.location) - 1, 0)
+        last_char = char_range.location + char_range.length
+        thickness = self.ruler.ruleThickness
+
+        for number, start in enumerate(
+            self.line_starts[first_line:], start=first_line + 1
+        ):
+            if start > last_char:
+                break
+            if start == text_length:
+                # The empty line after a trailing newline, or an empty document.
+                fragment = layout.extraLineFragmentRect
+            else:
+                glyph = layout.glyphIndexForCharacterAtIndex(start)
+                fragment = layout.lineFragmentRectForGlyphAtIndex(
+                    glyph, effectiveRange=None
+                )
+            label = self.gutter_label(str(number))
+            x = thickness - GUTTER_PADDING - label.size().width
+            y = fragment.origin.y - visible.origin.y + inset.height
+            label.drawAtPoint(NSPoint(x, y))

toga_code_editor/platforms/dummy.py

@@ -0,0 +1,21 @@
+from toga_dummy.widgets.multilinetextinput import MultilineTextInput
+
+
+class CodeEditor(MultilineTextInput):
+    def create(self):
+        self._action("create CodeEditor")
+
+    def set_theme(self, theme):
+        self._set_value("theme", theme)
+
+    def set_highlights(self, spans):
+        self._set_value("highlights", spans)
+
+    def set_show_line_numbers(self, value):
+        self._set_value("show_line_numbers", value)
+
+    def simulate_change(self):
+        # Mirror the real backends: the re-highlight is scheduled before the
+        # user's handler runs.
+        self.interface._schedule_rehighlight()
+        self.interface.on_change()

toga_code_editor/platforms/iOS.py

@@ -0,0 +1,314 @@
+from bisect import bisect_right
+
+from rubicon.objc import (
+    CGPoint,
+    CGRect,
+    NSMutableDictionary,
+    NSRange,
+    objc_method,
+    send_message,
+    send_super,
+)
+from rubicon.objc.types import NSInteger, UIEdgeInsets
+from toga_iOS.colors import native_color
+from toga_iOS.libs import (
+    NSAttributedString,
+    NSFontAttributeName,
+    NSForegroundColorAttributeName,
+    NSLayoutAttributeBottom,
+    NSLayoutAttributeLeading,
+    NSLayoutAttributeTop,
+    NSLayoutAttributeTrailing,
+    NSLayoutConstraint,
+    NSLayoutRelationEqual,
+    UIColor,
+    UIFont,
+    UIFontDescriptorTraitBold,
+    UIFontDescriptorTraitItalic,
+    UILabel,
+)
+from toga_iOS.widgets.multilinetextinput import (
+    MultilineTextInput,
+    TogaMultilineTextView,
+)
+
+from ..highlighting import to_utf16_spans, utf16_line_starts
+
+UIColor.declare_class_property("labelColor")
+UIColor.declare_class_property("secondaryLabelColor")
+
+# UIViewContentMode
+UIViewContentModeRedraw = 3
+# UITextAutocapitalizationType / UITextAutocorrectionType / UITextSpellCheckingType /
+# UITextSmartQuotesType / UITextSmartDashesType / UITextSmartInsertDeleteType
+UITextAutocapitalizationTypeNone = 0
+UITextAutocorrectionTypeNo = 1
+UITextSpellCheckingTypeNo = 1
+UITextSmartQuotesTypeNo = 1
+UITextSmartDashesTypeNo = 1
+UITextSmartInsertDeleteTypeNo = 1
+
+GUTTER_PADDING = 6
+PLACEHOLDER_LEADING = 4.0
+
+
+class TogaCodeTextView(TogaMultilineTextView):
+    @objc_method
+    def textViewDidChange_(self, text_view):
+        self.interface._schedule_rehighlight()
+        self.interface.on_change()
+        self.impl.text_changed()
+
+    @objc_method
+    def drawRect_(self, rect: CGRect) -> None:
+        send_super(__class__, self, "drawRect:", rect, argtypes=[CGRect])
+        self.impl.draw_line_numbers()
+
+
+class CodeEditor(MultilineTextInput):
+    def create(self):
+        # Mirrors toga_iOS's MultilineTextInput.create(), swapping in
+        # TogaCodeTextView and turning off prose features.
+        self.native = TogaCodeTextView.alloc().init()
+        self.native.interface = self.interface
+        self.native.impl = self
+        self.native.delegate = self.native
+        self.native.contentMode = UIViewContentModeRedraw
+        # UITextView forwards its UITextInputTraits setters to an internal object, so
+        # rubicon cannot see them as properties and attribute assignment is silently
+        # dropped. Send the messages directly.
+        for selector, value in (
+            ("setAutocapitalizationType:", UITextAutocapitalizationTypeNone),
+            ("setAutocorrectionType:", UITextAutocorrectionTypeNo),
+            ("setSpellCheckingType:", UITextSpellCheckingTypeNo),
+            ("setSmartQuotesType:", UITextSmartQuotesTypeNo),
+            ("setSmartDashesType:", UITextSmartDashesTypeNo),
+            ("setSmartInsertDeleteType:", UITextSmartInsertDeleteTypeNo),
+        ):
+            send_message(
+                self.native, selector, value, restype=None, argtypes=[NSInteger]
+            )
+
+        # Reading layoutManager opts the view into TextKit 1, which is what the
+        # gutter's line-fragment queries need. Do it once, up front.
+        self.layout_manager = self.native.layoutManager
+
+        # Placeholder isn't natively supported, so we create our own
+        self.placeholder_label = UILabel.alloc().init()
+        self.placeholder_label.translatesAutoresizingMaskIntoConstraints = False
+        self.placeholder_label.font = self.native.font
+        self.placeholder_label.alpha = 0.5
+        self.native.addSubview(self.placeholder_label)
+        self.constrain_placeholder_label()
+        self.native.placeholder_label = self.placeholder_label
+
+        # UITextView.font and .textColor read back the *first character's* attributes
+        # once the storage is styled, so the base style is tracked here instead.
+        self.base_font = self.native.font
+        self.base_color = UIColor.labelColor
+
+        self.theme = {}
+        self.attributes = {}
+        self.spans = []
+        self.line_starts = [0]
+        self.show_line_numbers = True
+        self.gutter_width = 0
+        self.default_inset = self.native.textContainerInset
+
+        self.add_constraints()
+        self.text_changed()
+
+    def constrain_placeholder_label(self):
+        # Same constraints as toga_iOS, but keeping a reference to the leading one
+        # so the gutter can push the placeholder right.
+        self.placeholder_leading = NSLayoutConstraint.constraintWithItem(
+            self.placeholder_label,
+            attribute__1=NSLayoutAttributeLeading,
+            relatedBy=NSLayoutRelationEqual,
+            toItem=self.native,
+            attribute__2=NSLayoutAttributeLeading,
+            multiplier=1.0,
+            constant=PLACEHOLDER_LEADING,
+        )
+        trailing_constraint = NSLayoutConstraint.constraintWithItem(
+            self.placeholder_label,
+            attribute__1=NSLayoutAttributeTrailing,
+            relatedBy=NSLayoutRelationEqual,
+            toItem=self.native,
+            attribute__2=NSLayoutAttributeTrailing,
+            multiplier=1.0,
+            constant=0,
+        )
+        top_constraint = NSLayoutConstraint.constraintWithItem(
+            self.placeholder_label,
+            attribute__1=NSLayoutAttributeTop,
+            relatedBy=NSLayoutRelationEqual,
+            toItem=self.native,
+            attribute__2=NSLayoutAttributeTop,
+            multiplier=1.0,
+            constant=8.0,
+        )
+        bottom_constraint = NSLayoutConstraint.constraintWithItem(
+            self.placeholder_label,
+            attribute__1=NSLayoutAttributeBottom,
+            relatedBy=NSLayoutRelationEqual,
+            toItem=self.native,
+            attribute__2=NSLayoutAttributeBottom,
+            multiplier=1.0,
+            constant=0,
+        )
+        self.native.addConstraints(
+            [
+                self.placeholder_leading,
+                trailing_constraint,
+                top_constraint,
+                bottom_constraint,
+            ]
+        )
+
+    # Inherited MultilineTextInput methods that must keep the gutter and colors in sync
+
+    def set_value(self, value):
+        super().set_value(value)
+        self.text_changed()
+
+    def set_font(self, font):
+        super().set_font(font)
+        self.base_font = font._impl.native
+        self.rebuild_attributes()
+        self.apply_highlights()
+        self.text_changed()
+
+    def set_color(self, value):
+        super().set_color(value)
+        self.base_color = native_color(value) or UIColor.labelColor
+        self.apply_highlights()
+
+    # CodeEditor backend contract
+
+    def set_theme(self, theme):
+        self.theme = theme
+        self.rebuild_attributes()
+
+    def set_highlights(self, spans):
+        self.spans = spans
+        self.apply_highlights()
+
+    def set_show_line_numbers(self, value):
+        self.show_line_numbers = value
+        self.text_changed()
+
+    # Highlighting
+
+    def rebuild_attributes(self):
+        base_font = self.base_font
+        self.attributes = {}
+        for kind, style in self.theme.items():
+            attributes = NSMutableDictionary.alloc().init()
+            attributes[NSForegroundColorAttributeName] = native_color(style.color)
+            traits = 0
+            if style.bold:
+                traits |= UIFontDescriptorTraitBold
+            if style.italic:
+                traits |= UIFontDescriptorTraitItalic
+            if traits and base_font is not None:
+                # If there is no font with the requested traits, this returns None.
+                font = UIFont.fontWithDescriptor(
+                    base_font.fontDescriptor.fontDescriptorWithSymbolicTraits(traits),
+                    size=base_font.pointSize,
+                )
+                if font is not None:
+                    attributes[NSFontAttributeName] = font
+            self.attributes[kind] = attributes
+
+    def apply_highlights(self):
+        storage = self.native.textStorage
+        length = storage.length()
+        full_range = NSRange(0, length)
+        # Between a native edit and the debounced re-highlight the spans describe the
+        # previous text, so clamp them: a range past the end raises NSRangeException
+        # inside UIKit, which cannot be caught from Python.
+        spans = [
+            (span.start, min(span.end, length), self.attributes.get(span.kind))
+            for span in to_utf16_spans(self.get_value(), self.spans)
+            if span.start < length
+        ]
+        storage.beginEditing()
+        # Reset to the base font and color, then paint each span.
+        if self.base_font is not None:
+            storage.addAttribute(
+                NSFontAttributeName, value=self.base_font, range=full_range
+            )
+        storage.addAttribute(
+            NSForegroundColorAttributeName, value=self.base_color, range=full_range
+        )
+        for start, end, attributes in spans:
+            if attributes is not None and end > start:
+                storage.addAttributes(attributes, range=NSRange(start, end - start))
+        storage.endEditing()
+
+    # Gutter
+
+    def text_changed(self):
+        self.line_starts = utf16_line_starts(self.get_value())
+        if self.show_line_numbers:
+            digits = len(str(len(self.line_starts)))
+            width = self.gutter_label("0" * digits).size().width + 2 * GUTTER_PADDING
+        else:
+            width = 0
+        if width != self.gutter_width:
+            self.gutter_width = width
+            inset = self.default_inset
+            self.native.textContainerInset = UIEdgeInsets(
+                inset.top, inset.left + width, inset.bottom, inset.right
+            )
+            self.placeholder_leading.constant = PLACEHOLDER_LEADING + width
+        self.native.setNeedsDisplay()
+
+    def gutter_label(self, text):
+        attributes = NSMutableDictionary.alloc().init()
+        if self.base_font is not None:
+            attributes[NSFontAttributeName] = self.base_font
+        attributes[NSForegroundColorAttributeName] = UIColor.secondaryLabelColor
+        return NSAttributedString.alloc().initWithString(text, attributes=attributes)
+
+    def draw_line_numbers(self):
+        if not self.show_line_numbers:
+            return
+        layout = self.layout_manager
+        container = self.native.textContainer
+        inset = self.native.textContainerInset
+        text_length = self.native.textStorage.length()
+
+        # bounds.origin is the scroll offset; the container is inset within it.
+        bounds = self.native.bounds
+        visible = CGRect(
+            CGPoint(bounds.origin.x - inset.left, bounds.origin.y - inset.top),
+            bounds.size,
+        )
+        glyph_range = layout.glyphRangeForBoundingRect(
+            visible, inTextContainer=container
+        )
+        char_range = layout.characterRangeForGlyphRange(
+            glyph_range, actualGlyphRange=None
+        )
+        first_line = max(bisect_right(self.line_starts, char_range.location) - 1, 0)
+        last_char = char_range.location + char_range.length
+
+        for number, start in enumerate(
+            self.line_starts[first_line:], start=first_line + 1
+        ):
+            if start > last_char:
+                break
+            if start == text_length:
+                # The empty line after a trailing newline, or an empty document.
+                fragment = layout.extraLineFragmentRect
+            else:
+                glyph = layout.glyphIndexForCharacterAtIndex(start)
+                fragment = layout.lineFragmentRectForGlyphAtIndex(
+                    glyph, effectiveRange=None
+                )
+            label = self.gutter_label(str(number))
+            x = self.gutter_width - GUTTER_PADDING - label.size().width
+            y = fragment.origin.y + inset.top
+            label.drawAtPoint(CGPoint(x, y))