Initial commit

Author: Apple

.gitignore

@@ -0,0 +1,21 @@
+# See LICENSE folder for this sample’s licensing information.
+#
+# Apple sample code gitignore configuration.
+
+# Finder
+.DS_Store
+
+# Xcode - User files
+xcuserdata/
+
+**/*.xcodeproj/project.xcworkspace/*
+!**/*.xcodeproj/project.xcworkspace/xcshareddata
+
+**/*.xcodeproj/project.xcworkspace/xcshareddata/*
+!**/*.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
+
+**/*.playground/playground.xcworkspace/*
+!**/*.playground/playground.xcworkspace/xcshareddata
+
+**/*.playground/playground.xcworkspace/xcshareddata/*
+!**/*.playground/playground.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings

Configuration/SampleCode.xcconfig

@@ -0,0 +1,13 @@
+//
+// See LICENSE folder for this sample’s licensing information.
+//
+// SampleCode.xcconfig
+//
+
+// The `SAMPLE_CODE_DISAMBIGUATOR` configuration is to make it easier to build
+// and run a sample code project. Once you set your project's development team,
+// you'll have a unique bundle identifier. This is because the bundle identifier
+// is derived based on the 'SAMPLE_CODE_DISAMBIGUATOR' value. Do not use this
+// approach in your own projects—it's only useful for sample code projects because
+// they are frequently downloaded and don't have a development team set.
+SAMPLE_CODE_DISAMBIGUATOR=${DEVELOPMENT_TEAM}

LICENSE/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright © 2022 Apple Inc.
+
+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.
+

README.md

@@ -0,0 +1,7 @@
+# Enriching your text in text views
+
+Add exclusion paths, text attachments, and text lists to your text, and render it with text views.
+
+## Overview
+
+- Note: This sample code project is associated with WWDC22 session [10090: What's new in TextKit and text views](https://developer.apple.com/wwdc22/10090/).

Shared/AttachmentSample.rtf

@@ -0,0 +1,57 @@
+{\rtf1\ansi\ansicpg1252\cocoartf2682
+\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fnil\fcharset0 HelveticaNeue;\f1\fnil\fcharset0 Menlo-Regular;}
+{\colortbl;\red255\green255\blue255;\red0\green0\blue0;}
+{\*\expandedcolortbl;;\csgray\c0\c0;}
+\margl1440\margr1440\vieww10920\viewh7800\viewkind0
+\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
+
+\f0\fs28 \cf0 View-based text attachments became available in iOS 15 and macOS Monterey.  With view-based text attachments, you can use a 
+\f1 UIView
+\f0  or an 
+\f1 NSView
+\f0  as the text attachment.  Events can be handled directly by the attachment view.  This makes event handling with text attachments a whole lot easier, and it's only possible with TextKit 2.\
+\
+This code sample demonstrates how to use the text attachment view provider APIs with 
+\f1 UITextView
+\f0  and 
+\f1 NSTextView
+\f0 .  The text view must be backed by TextKit 2 for this to work.  \
+\
+Create a subclass of 
+\f1 NSTextAttachmentViewProvider
+\f0  and overload its 
+\f1 loadView() 
+\f0 method to create your view-based attachment.  \
+\
+In this override, provide the bounds of your view and set the property 
+\f1 tracksTextAttachmentViewBounds
+\f0  to true, so that the framework consults the text attachment view provider to determine the bounds of the attachment.\
+\
+The 
+\f1 intrinsicContentSize
+\f0  is used to determine the attachment bounds, so make sure your attachment view provides this value.\
+\
+Additionally, create a subclass of 
+\f1 NSTextAttachment
+\f0  and override: \
+\
+\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
+
+\f1\fs24 \cf0 \cb2 viewProvider(for:location:textContainer:)
+\f0  
+\fs28 \cb1 \
+\
+to return an instance of your custom 
+\f1 NSTextAttachmentViewProvider
+\f0 .  \
+\
+Also override: \
+\
+
+\f1\fs24 image(bounds:attributes:location:textContainer:)
+\f0  
+\fs28 \
+\
+to return 
+\f1 nil
+\f0 .  }

Shared/ExclusionPath.swift

@@ -0,0 +1,58 @@
+/*
+See LICENSE folder for this sample’s licensing information.
+
+Abstract:
+A utility that hosts the exclusion paths.
+*/
+
+import Foundation
+#if os(iOS)
+import UIKit
+#else
+import AppKit
+#endif
+
+// Generate a bezier path for the image.
+struct ExclusionPath {
+#if os(iOS)
+    static var uiBezierPath: UIBezierPath {
+        let bezierPath = UIBezierPath()
+        bezierPath.move(to: CGPoint(x: 24.5, y: 59.5))
+        bezierPath.addCurve(to: CGPoint(x: -1.5, y: 154.5), controlPoint1: CGPoint(x: -9.24, y: 101.69), controlPoint2: CGPoint(x: -1.5, y: 154.5))
+        bezierPath.addLine(to: CGPoint(x: 111.5, y: 154.5))
+        bezierPath.addLine(to: CGPoint(x: 139.5, y: 183.5))
+        bezierPath.addLine(to: CGPoint(x: 236.5, y: 88.5))
+        bezierPath.addLine(to: CGPoint(x: 259.5, y: 110.5))
+        bezierPath.addLine(to: CGPoint(x: 298.5, y: 75.5))
+        bezierPath.addCurve(to: CGPoint(x: 244.5, y: 19.5), controlPoint1: CGPoint(x: 298.5, y: 75.5), controlPoint2: CGPoint(x: 255.5, y: 30.5))
+        bezierPath.addCurve(to: CGPoint(x: 161.5, y: 14.5), controlPoint1: CGPoint(x: 237.74, y: 12.74), controlPoint2: CGPoint(x: 215.5, y: -4.5))
+        bezierPath.addCurve(to: CGPoint(x: 111.5, y: 14.5), controlPoint1: CGPoint(x: 161.5, y: 14.5), controlPoint2: CGPoint(x: 119.21, y: 14.5))
+        bezierPath.addCurve(to: CGPoint(x: 24.5, y: 59.5), controlPoint1: CGPoint(x: 76.19, y: 14.86), controlPoint2: CGPoint(x: 43.21, y: 36.11))
+        bezierPath.close()
+        var transform = CGAffineTransform.identity
+        transform = transform.translatedBy(x: 45, y: 30)
+        bezierPath.apply(transform)
+        return bezierPath
+    }
+#else
+    static var nsBezierPath: NSBezierPath {
+        let bezierPath = NSBezierPath()
+        bezierPath.move(to: NSPoint(x: 25.5, y: 58.5))
+        bezierPath.curve(to: NSPoint(x: -0.5, y: 153.5), controlPoint1: NSPoint(x: -8.24, y: 100.69), controlPoint2: NSPoint(x: -0.5, y: 153.5))
+        bezierPath.line(to: NSPoint(x: 112.5, y: 153.5))
+        bezierPath.line(to: NSPoint(x: 140.5, y: 182.5))
+        bezierPath.line(to: NSPoint(x: 237.5, y: 87.5))
+        bezierPath.line(to: NSPoint(x: 260.5, y: 109.5))
+        bezierPath.line(to: NSPoint(x: 299.5, y: 74.5))
+        bezierPath.curve(to: NSPoint(x: 245.5, y: 18.5), controlPoint1: NSPoint(x: 299.5, y: 74.5), controlPoint2: NSPoint(x: 256.5, y: 29.5))
+        bezierPath.curve(to: NSPoint(x: 165.5, y: 23.5), controlPoint1: NSPoint(x: 234.5, y: 7.5), controlPoint2: NSPoint(x: 188.5, y: -6.5))
+        bezierPath.curve(to: NSPoint(x: 112.5, y: 13.5), controlPoint1: NSPoint(x: 154.5, y: 15), controlPoint2: NSPoint(x: 132.5, y: 13.5))
+        bezierPath.curve(to: NSPoint(x: 25.5, y: 58.5), controlPoint1: NSPoint(x: 77.19, y: 13.86), controlPoint2: NSPoint(x: 44.21, y: 35.11))
+        bezierPath.close()
+        var transform = AffineTransform.identity
+        transform.translate(x: 45, y: 65)
+        bezierPath.transform(using: transform)
+        return bezierPath
+    }
+#endif
+}

Shared/ExclusionPathSample.rtf

@@ -0,0 +1,16 @@
+{\rtf1\ansi\ansicpg1252\cocoartf2682
+\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fnil\fcharset0 Futura-Medium;\f1\fnil\fcharset0 Apple-Chancery;\f2\fnil\fcharset0 Georgia;
+\f3\fnil\fcharset0 HelveticaNeue;}
+{\colortbl;\red255\green255\blue255;\red0\green0\blue0;}
+{\*\expandedcolortbl;;\cssrgb\c0\c0\c0\cname textColor;}
+\margl1440\margr1440\vieww14160\viewh11760\viewkind0
+\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\qc\partightenfactor0
+
+\f0\fs40 \cf2 Choosing the Right Extension Approach
+\f1 \
+\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\qj\partightenfactor0
+
+\f2\fs24 \cf2 \
+\pard\pardeftab560\slleading20\qj\partightenfactor0
+
+\f3\fs26 \cf0 We\'92ve looked at the built-in text controls, the components in the TextKit stack, and how to configure those components to achieve different effects.  There\'92s a lot you can do with that knowledge already, but if you need even more, you\'92ll need to extend parts of TextKit.  So now we\'92ll talk a little bit about choosing the right approach for that.  And choosing the right approach is like building up your text toolbox.  It\'92s like going to the hardware store because you need a hammer, and then when you get there, there\'92s this giant wall of hammers to choose from.  You want to pick the hammer that can do the job, and the least expensive one that will do what you need.  So these are the hammers that are available to us.  Delegation is like your standard hammer with the claw on the end, it\'92s useful for multiple tasks.  The delegates have a lot of commonly desired customization hooks and most of the time it\'92ll get the job done.  Notifications is like a ball-peen hammer, which has a ball on the end instead of a claw.  It\'92s more specialized and better suited for certain tasks than the standard hammer of delegation, but it\'92s not quite as versatile.  And finally, subclassing is your sledgehammer.  You can use the sledgehammer for just about anything you\'92d need a hammer for, but it\'92s probably overkill for a lot of things.}

Shared/ListSample.txt

@@ -0,0 +1,20 @@
+Egg Sandwich 
+Egg Sandwich No. 2 
+Fried Egg Sandwich 
+Ribbon Sandwich 
+Egg and Lettuce Sandwich 
+Egg and Olive Sandwich 
+Egg and Cucumber Sandwich 
+Egg and Brown Bread Sandwich 
+Puritan Sandwich 
+Cold Sandwich 
+Montpelier Sandwich 
+Japanese Egg Sandwich 
+Brown Egg Sandwich 
+Easter Sandwich 
+Outing Sandwich 
+Traveller's Sandwich 
+Curried Egg and Oyster Sandwiches
+Watercress and Egg Sandwich 
+Watercress and Egg Sandwich No. 2  
+Green Pepper and Egg Sandwich

Shared/NSTextStorage+SampleText.swift

@@ -0,0 +1,100 @@
+/*
+See LICENSE folder for this sample’s licensing information.
+
+Abstract:
+The extension that loads the sample text.
+*/
+
+#if os(iOS)
+import UIKit
+private let textColor = UIColor.label
+#else
+import AppKit
+private let textColor = NSColor.textColor
+#endif
+
+extension NSTextStorage {
+    // Load the surrounding text for the exclusion path.
+    func loadExclusionPathSampleText() {
+        guard let fileURL = Bundle.main.url(forResource: "ExclusionPathSample", withExtension: "rtf") else {
+            fatalError("Failed to find ExclusionPathSample.rtf in the app bundle.")
+        }
+        let options = [NSAttributedString.DocumentReadingOptionKey.documentType: NSAttributedString.DocumentType.rtf]
+        guard let sampleText = try? NSAttributedString(url: fileURL, options: options, documentAttributes: nil) else {
+            fatalError("Failed to load sample text.")
+        }
+        replaceCharacters(in: NSRange(location: 0, length: length), with: sampleText)
+        addAttribute(.foregroundColor, value: textColor, range: NSRange(location: 0, length: length))
+    }
+    
+    // Set up a view-based text attachment.
+    func loadAttachmentSampleText(textLayoutManager: NSTextLayoutManager) {
+        
+        guard let fileURL = Bundle.main.url(forResource: "AttachmentSample", withExtension: "rtf") else {
+            fatalError("Failed to find AttachmentSample.rtf in the app bundle.")
+        }
+        let options = [NSAttributedString.DocumentReadingOptionKey.documentType: NSAttributedString.DocumentType.rtf]
+        guard let sampleText = try? NSAttributedString(url: fileURL, options: options, documentAttributes: nil) else {
+            fatalError("Failed to load sample text.")
+        }
+        replaceCharacters(in: NSRange(location: 0, length: length), with: sampleText)
+        addAttribute(.foregroundColor, value: textColor, range: NSRange(location: 0, length: length))
+
+        let attachment = Attachment()
+        attachment.allowsTextAttachmentView = true
+        attachment.textLayoutManager = textLayoutManager
+        let attachmentAttributedString = NSAttributedString(attachment: attachment)
+        append(attachmentAttributedString)
+    }
+    
+    // Set up a sample list.
+    func loadListSampleText() {
+        guard let fileURL = Bundle.main.url(forResource: "ListSample", withExtension: "txt") else {
+            fatalError("Failed to find ListSample.txt in the app bundle.")
+        }
+        guard let sampleText = try? String(String(contentsOf: fileURL)) else {
+            fatalError("Failed to load sample text.")
+        }
+        let sampleContents = NSAttributedString(string: sampleText)
+        replaceCharacters(in: NSRange(location: 0, length: length), with: sampleContents)
+    
+        guard let paragraphStyle = NSParagraphStyle.default.mutableCopy() as? NSMutableParagraphStyle else {
+            return
+        }
+        let textList = NSTextList(markerFormat: .decimal, options: 0)
+        paragraphStyle.textLists = [textList]
+
+        let attributes: [NSAttributedString.Key: Any] = [
+            .paragraphStyle: paragraphStyle,
+            .foregroundColor: textColor
+        ]
+
+        let listAttributedString = NSAttributedString(string: string, attributes: attributes)
+        replaceCharacters(in: NSRange(location: 0, length: length), with: listAttributedString)
+    }
+    
+    // Change the list marker style for the text lists, if any.
+    func setListMarkerStyle(styleIndex: Int) {
+        guard styleIndex >= 0 && styleIndex < 3 else {
+            return
+        }
+        let markerFormats: [NSTextList.MarkerFormat] = [.decimal, .disc, .square]
+        let newMarkerFormat = markerFormats[styleIndex]
+
+        var pos = 0
+        while pos < length {
+            var pstyleRange = NSRange(location: NSNotFound, length: 0)
+            let searchRange = NSRange(location: pos, length: length - pos)
+            let value = attribute(.paragraphStyle, at: pos, longestEffectiveRange: &pstyleRange, in: searchRange)
+            if let pstyle = value as? NSParagraphStyle {
+                if !pstyle.textLists.isEmpty, let mutablePstyle = pstyle.mutableCopy() as? NSMutableParagraphStyle {
+                    mutablePstyle.textLists = mutablePstyle.textLists.map { textList in
+                        NSTextList(markerFormat: newMarkerFormat, options: 0)
+                    }
+                    addAttribute(.paragraphStyle, value: mutablePstyle, range: pstyleRange)
+                }
+            }
+            pos = NSMaxRange(pstyleRange)
+        }
+    }
+}