Commit `cfb37bd8ac`

cfb37bd8ac1997e58fa785317197bbb0959d1d0b

parent: cf97b142ee

Verified · cmc

cmc <hello@cleberg.net> · 2026-10-05 18:55 UTC

Shaded band behind blocks

Blocks and fixed-width lines sit on a band the width of the view, as
Emacs extends org-block, instead of a background behind the glyphs.

Layout: unified · split

Sources/OrgEditorAppKit/OrgEditor.swift +27 −1

     let hidden = HiddenRanges()
     let folded = FoldedHeadings()
+    /// Blocks drawn on a shaded band.
+    let shaded = HiddenRanges()
     let theme = Theme()
     private var isLoading = false
     private var previousSelection = 0
         textLayoutManager.delegate = self
         textContentStorage.delegate = self
+        if isOrg { shaded.set(Presentation.shadedBlocks(document.tree)) }
         load(document.text)
         if isOrg, let startup = Presentation.startupFoldState(document.tree) { setFolds(startup) }
     }
         let delta = edit.replacement.utf16.count - edit.range.count
         let oldMapped = oldAffected.lowerBound..<(oldAffected.upperBound >= edit.range.upperBound ? oldAffected.upperBound + delta : newEnd)
         restyle(min(oldMapped.lowerBound, newAffected.lowerBound)..<min(max(oldMapped.upperBound, newAffected.upperBound), newText.length), in: storage)
-        if hidden.all != oldHidden.map({ mapRange($0, through: edit) }) {
+        let oldShaded = shaded.all
+        if isOrg { shaded.set(Presentation.shadedBlocks(document.tree)) }
+        if hidden.all != oldHidden.map({ mapRange($0, through: edit) })
+            || shaded.all != oldShaded.map({ mapRange($0, through: edit) }) {
             textLayoutManager.invalidateLayout(for: textLayoutManager.documentRange)
         }
         onEditTiming?(clock.now - start)
         if let range, let manager = textLayoutManager.textContentManager {
             let offset = manager.offset(from: manager.documentRange.location, to: range.location)
             if folded.contains(offset) { return FoldedHeadingFragment(textElement: textElement, range: range) }
+            if shaded.containing(offset) != nil { return ShadedFragment(textElement: textElement, range: range) }
         }
         return NSTextLayoutFragment(textElement: textElement, range: range)
     }
 }
+/// A line of a block, on a band across the whole width of the view, as Emacs extends the
+/// `org-block` face.
+final class ShadedFragment: NSTextLayoutFragment, @unchecked Sendable {
+    private var band: CGRect {
+        let width = textLayoutManager?.textContainer?.size.width ?? layoutFragmentFrame.width
+        return CGRect(x: -layoutFragmentFrame.minX, y: 0, width: width, height: layoutFragmentFrame.height)
+    }
+    override var renderingSurfaceBounds: CGRect { super.renderingSurfaceBounds.union(band) }
+    override func draw(at point: CGPoint, in context: CGContext) {
+        context.saveGState()
+        context.setFillColor(Theme.blockBackground.cgColor)
+        context.fill(band.offsetBy(dx: point.x, dy: point.y))
+        context.restoreGState()
+        super.draw(at: point, in: context)
+    }
+}
 /// A heading line drawn with an ellipsis after it, like org's folded headings.
 final class FoldedHeadingFragment: NSTextLayoutFragment, @unchecked Sendable {
     override func draw(at point: CGPoint, in context: CGContext) {

Sources/OrgEditorAppKit/Theme.swift +6 −3

         ("0" as NSString).size(withAttributes: [.font: font]).width
     }
+    /// The band behind blocks.
+    nonisolated(unsafe) static let blockBackground = NSColor(name: nil) { appearance in
+        appearance.bestMatch(from: [.aqua, .darkAqua]) == .darkAqua ? NSColor(white: 1, alpha: 0.06) : NSColor(white: 0, alpha: 0.045)
+    }
     /// Markup hidden from view: no width, no color.
     var hidden: [NSAttributedString.Key: Any] {
         [.font: NSFont.monospacedSystemFont(ofSize: 0.01, weight: .regular), .foregroundColor: NSColor.clear]
             storage.addAttribute(.foregroundColor, value: NSColor.systemPurple, range: range)
         case .footnote, .cookie, .target, .macro, .latex:
             storage.addAttribute(.foregroundColor, value: NSColor.systemTeal, range: range)
-        case .block:
+        case .block, .table, .rule:
-            storage.addAttribute(.backgroundColor, value: NSColor.quaternarySystemFill, range: range)
-        case .table, .rule:
             break
         case .syntax(let category):
             if let color = Self.color(category) { storage.addAttribute(.foregroundColor, value: color, range: range) }

Sources/OrgPresentation/Presentation.swift +20

	@@ -187,6 +187,26 @@ public enum Presentation {
187	}	187	}
188	}	188	}
189		189
		190	/// Blocks and fixed-width areas, drawn on a shaded band the width of the view. Sorted.
		191	public static func shadedBlocks(_ tree: OrgTree) -> [Range<Int>] {
		192	var ranges: [Range<Int>] = []
		193	func walk(_ node: SyntaxNode) {
		194	for child in node.children {
		195	switch child.kind {
		196	case .block, .dynamicBlock, .fixedWidth:
		197	// Without the blank lines org counts as part of the element.
		198	let text = child.text
		199	let trimmed = text.utf16.count - String(text.reversed().prefix { $0.isWhitespace }).utf16.count
		200	ranges.append(child.range.lowerBound..<(child.range.lowerBound + trimmed))
		201	case .paragraph, .table, .heading, .planning, .propertyDrawer, .drawer, .keyword, .comment: continue
		202	default: walk(child)
		203	}
		204	}
		205	}
		206	walk(tree.root)
		207	return ranges
		208	}
		209
190	/// Ranges to hide. A heading in `folds` hides everything after its line to the end of its	210	/// Ranges to hide. A heading in `folds` hides everything after its line to the end of its
191	/// section; one in `bodyFolds` hides only its own body, up to its first child heading.	211	/// section; one in `bodyFolds` hides only its own body, up to its first child heading.
192	/// Sorted, without nested duplicates.	212	/// Sorted, without nested duplicates.

Tests/OrgPresentationTests/PresentationTests.swift +10

	@@ -1,3 +1,4 @@
		1	import Foundation
1	import OrgCore	2	import OrgCore
2	import Testing	3	import Testing
3	@testable import OrgPresentation	4	@testable import OrgPresentation
	@@ -67,6 +68,15 @@ struct FoldTests {
67	#expect(Presentation.hiddenRanges(OrgParser.parse("* a"), folds: [0]).isEmpty)	68	#expect(Presentation.hiddenRanges(OrgParser.parse("* a"), folds: [0]).isEmpty)
68	}	69	}
69		70
		71	@Test func shadedBlocks() {
		72	let text = "* a\n#+begin_src sh\nls\n#+end_src\n\n- item\n #+begin_quote\n q\n #+end_quote\n: fixed\n"
		73	let ns = text as NSString
		74	let ranges = Presentation.shadedBlocks(OrgParser.parse(text))
		75	#expect(ranges.map { ns.substring(with: NSRange($0)) } == [
		76	"#+begin_src sh\nls\n#+end_src", " #+begin_quote\n q\n #+end_quote", ": fixed",
		77	])
		78	}
		79
70	@Test func headingContaining() {	80	@Test func headingContaining() {
71	let tree = OrgParser.parse(text)	81	let tree = OrgParser.parse(text)
72	#expect(Presentation.heading(containing: 2, in: tree) == 0)	82	#expect(Presentation.heading(containing: 2, in: tree) == 0)

Commit cfb37bd8ac

Commit `cfb37bd8ac`