Sample CodeiOS, iPadOS, Mac Catalyst, macOSReviewed 2026-07-21View on Apple Developer

Using TextKit 2 to interact with text

At a glance

Item Summary
Purpose Interact with text by managing text selection and inserting custom text elements.
App architecture A Swift sample bundle with entry-bearing project variants iOS, macOS, each leading to UIKit APIs.
Main patterns View-controller organization, Delegate or data-source callbacks
Project style 15 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries.
Execution model No structured execution marker indexed; callback threading requires source review.
State/event model Source-visible mechanisms: NotificationCenter.
Key frameworks/packages Cocoa, UIKit, CoreGraphics, Foundation; these are source dependencies, not architecture labels.

Project structure

Source bundle/
├── iOS/
│   ├── AppDelegate.swift
│   ├── TextDocumentView.swift
│   ├── CommentPopoverViewController.swift
│   ├── SceneDelegate.swift
│   └── TextDocumentViewController.swift
├── macOS/
│   ├── AppDelegate.swift
│   ├── TextDocumentView.swift
│   ├── CommentPopoverViewController.swift
│   ├── Document.swift
│   ├── TextDocumentViewController.swift
│   └── WindowController.swift
└── Shared/
    └── BubbleLayoutFragment.swift

Structure observations

  • Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
  • Primary languages: Swift.
  • The verified tree contains 9 project/configuration file(s) and 17 source declaration(s).

Overall architecture

Reference code

iOS/AppDelegate.swift:10 — architecture anchor

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        return true
    }

    // MARK: UISceneSession Lifecycle

    func application(_ application: UIApplication,
                     configurationForConnecting connectingSceneSession: UISceneSession,
                     options: UIScene.ConnectionOptions) -> UISceneConfiguration {
        // Called by iOS when a new scene session is being created.
        // Use this method to select a configuration to create the new scene with.
        return UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
    }

    func application(_ application: UIApplication,
                     didDiscardSceneSessions sceneSessions: Set<UISceneSession>) {
        // Called by iOS when the user discards a scene session.
        // If any sessions were discarded while the application was not running,
        // this will be called shortly after application:didFinishLaunchingWithOptions.
        // Use this method to release any resources that were specific to the discarded scenes, as they will not return.
    }

}

Interpretation

The branches represent separate entry-bearing project variants in the downloaded bundle, not runtime calls between those variants. Each branch is intentionally collapsed at the documented framework boundary; the detailed target-local flow remains in the cited files. Ownership is claimed only where the next section cites a stored property or assignment.

Ownership and state

Ownership evidence

iOS/TextDocumentView.swift:141 — stored dependency or nearest verified ownership anchor

class TextDocumentView: UIScrollView,
                        NSTextViewportLayoutControllerDelegate,
                        NSTextLayoutManagerDelegate,
                        UIGestureRecognizerDelegate {
    // ...
}
Owner Object or state Relationship Mutation authority
TextDocumentView CALayer (contentLayer) stores or receives Owning lexical scope
TextDocumentView CALayer (selectionLayer) stores or receives Owning lexical scope
TextDocumentView NSMapTable (fragmentLayerMap) stores or receives Owning lexical scope
TextDocumentView CGFloat (padding) owns value state Owning lexical scope

Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.

Concurrency, scheduling, and thread safety

Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.

No source-visible execution, scheduling, or synchronization boundary was found in the indexed source.

@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.

State propagation, frameworks, and dependencies

Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.

Category Mechanism or module Verified role Evidence
State propagation NotificationCenter NotificationCenter distributes named process-local events. macOS/TextDocumentView.swift:74
Source import Cocoa The cited file imports this module; runtime use and architectural role are not inferred. Shared/BubbleLayoutFragment.swift:11
Source import UIKit The cited file imports this module; runtime use and architectural role are not inferred. Shared/BubbleLayoutFragment.swift:9
Source import CoreGraphics The cited file imports this module; runtime use and architectural role are not inferred. Shared/BubbleLayoutFragment.swift:13
Source import Foundation The cited file imports this module; runtime use and architectural role are not inferred. Shared/CommentUtils.swift:8

receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.

Class and protocol design

iOS/AppDelegate.swift:11 — representative type boundary

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    // ...
        return true
    // ...
}
Type Responsibility Depends on or conforms to
AppDelegate Receives callback-driven events UIResponder, UIApplicationDelegate
AppDelegate Receives callback-driven events NSObject, NSApplicationDelegate
TextDocumentView User-interface presentation and input forwarding UIScrollView
TextDocumentView User-interface presentation and input forwarding NSView, CALayerDelegate, NSTextViewportLayoutControllerDelegate, NSTextLayoutManagerDelegate
CommentPopoverViewController View lifecycle, callbacks, and feature coordination UIViewController, UITextFieldDelegate
SceneDelegate Receives callback-driven events UIResponder, UIWindowSceneDelegate
TextDocumentViewController View lifecycle, callbacks, and feature coordination UIViewController
CommentPopoverViewController View lifecycle, callbacks, and feature coordination NSViewController, NSPopoverDelegate
Document Owns document data or lifecycle behavior NSDocument
TextDocumentViewController View lifecycle, callbacks, and feature coordination NSViewController, NSTextContentManagerDelegate, NSTextContentStorageDelegate

No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.

Access control

Symbol Access Verified effect Likely rationale
tightTextBounds (Shared/BubbleLayoutFragment.swift:23) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
bubbleRect (Shared/BubbleLayoutFragment.swift:37) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
bubbleCornerRadius (Shared/BubbleLayoutFragment.swift:39) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
bubbleColor (Shared/BubbleLayoutFragment.swift:41) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.

Reference code

Shared/BubbleLayoutFragment.swift:23 — representative boundary

    private var tightTextBounds: CGRect {
        var fragmentTextBounds = CGRect.null
        // ...
    }

Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.

Logic ownership and placement

Logic Owning type or file Placement rationale
View lifecycle, callbacks, and feature coordination CommentPopoverViewController, TextDocumentViewController, WindowController The source’s Controller suffix makes this role explicit.
Receives callback-driven events AppDelegate, SceneDelegate The source’s Delegate suffix makes this role explicit.
Owns document data or lifecycle behavior Document The source’s Document suffix makes this role explicit.
User-interface presentation and input forwarding TextDocumentView The source’s View suffix makes this role explicit.

Design patterns

Pattern Source evidence Purpose or tradeoff
View-controller organization iOS/CommentPopoverViewController.swift:10 A controller is the verified coordination boundary; this is MVC-style only where a separate model is present.
Delegate or data-source callbacks iOS/AppDelegate.swift:11 Callback protocols invert event delivery back into the sample’s owner.

Naming conventions

  • Types: Controller: CommentPopoverViewController, TextDocumentViewController, WindowController; Delegate: AppDelegate, SceneDelegate; Document: Document; View: TextDocumentView.
  • Protocols: no local protocol declaration in the scanned source.
  • Methods: application, applicationDidFinishLaunching, applicationWillTerminate, defaultAction, viewportBounds, viewportAnchor, textViewportLayoutControllerWillLayout, animate.
  • Files: iOS/AppDelegate.swift, macOS/AppDelegate.swift, iOS/TextDocumentView.swift, macOS/TextDocumentView.swift, iOS/CommentPopoverViewController.swift, iOS/SceneDelegate.swift.

Architecture takeaways

  • AppDelegate is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches Cocoa, UIKit, CoreGraphics through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
  • Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
  • Access-control conclusions separate verified language visibility from the likely design rationale.
  • The source does not justify labeling the design protocol-oriented.

Source map

Source file Relevant symbols
iOS/AppDelegate.swift Cited implementation, AppDelegate
iOS/TextDocumentView.swift Cited implementation, TextDocumentLayer, TextDocumentView
Shared/BubbleLayoutFragment.swift Cited implementation, Cocoa, UIKit, CoreGraphics, BubbleLayoutFragment
iOS/CommentPopoverViewController.swift CommentPopoverViewController
macOS/TextDocumentView.swift NotificationCenter, TextDocumentLayer, TextDocumentView
Shared/CommentUtils.swift Foundation, Reaction
macOS/AppDelegate.swift AppDelegate
iOS/SceneDelegate.swift SceneDelegate
iOS/TextDocumentViewController.swift TextDocumentViewController
macOS/CommentPopoverViewController.swift CommentPopoverViewController
macOS/Document.swift Document
macOS/TextDocumentViewController.swift TextDocumentViewController
macOS/WindowController.swift WindowController
Shared/TextLayoutFragmentLayer.swift TextLayoutFragmentLayer
macOS/ReactionButton.swift ReactionButton