在 Swift 中使用 NSLayoutManager 隐藏 Markdown 字符
Hide Markdown Characters with NSLayoutManager in Swift
我正在使用 Markdown 语法的 Mac 应用程序中的富文本编辑器。我使用 NSTextStorage 来观察 Markdown 语法中的匹配项，然后像这样实时将样式应用于 NSAttributedString：
在这一点上，我已经在这方面不知所措，但我很高兴能取得进展。 :) This tutorial was very helpful.
作为下一步，我想在呈现 NSTextView 的字符串时 隐藏 Markdown 字符 。所以在上面的例子中，一旦输入最后一个星号，我希望 * * 字符被隐藏，只看到 sample 粗体。
我正在使用 NSLayoutManager 委托，我可以看到匹配的字符串，但我不清楚如何使用 shouldGenerateGlyphs 方法生成修改后的 glyphs/properties。这是我目前所拥有的：
func layoutManager(_: NSLayoutManager, shouldGenerateGlyphs _: UnsafePointer<CGGlyph>, properties _: UnsafePointer<NSLayoutManager.GlyphProperty>, characterIndexes _: UnsafePointer<Int>, font _: NSFont, forGlyphRange glyphRange: NSRange) -> Int {
let pattern = "(\*\w+(\s\w+)*\*)" // Look for stuff like *this*
do {
let regex = try NSRegularExpression(pattern: pattern)
regex.enumerateMatches(in: textView.string, range: glyphRange) {
match, _, _ in
// apply the style
if let matchRange = match?.range(at: 1) {
print(matchRange) <!-- This is the range of *sample*
// I am confused on how to provide the updated properties below...
// let newProps = NSLayoutManager.GlyphProperty.null
// layoutManager.setGlyphs(glyphs, properties: newProps, characterIndexes: charIndexes, font: aFont, forGlyphRange: glyphRange)
// return glyphRange.length
}
}
} catch {
print("\(error.localizedDescription)")
}
return 0
}
如何根据我发现隐藏星号的文本范围修改要传递给 setGlyphs 的内容？
2022 免责声明
虽然我在最初提交此答案时取得了一些不错的结果 运行 这段代码，但另一个 SO 用户 (Tim S.) 警告我在某些情况下应用 .null 字形属性某些字形会导致应用程序挂起或崩溃。
据我所知，这只发生在 .null 属性 和字形 8192 (2^13) 附近......我不知道为什么，老实说它看起来像TextKit 错误（或者至少不是 TextKit 工程师期望使用该框架的错误）。
对于现代应用程序，我建议您 take a look a TextKit 2，它应该抽象掉字形处理并简化所有这些东西（免责声明中的免责声明：我还没有尝试过）。
前言
我实现了这个方法来在我的应用程序中实现类似的功能。请记住，这个 API 的文档很少，所以我的解决方案是基于反复试验而不是对这里所有活动部分的深入理解。
简而言之：它应该有效，但使用风险自负 :)
另请注意，我在这个答案中介绍了很多细节，希望任何 Swift 开发人员都可以访问它，即使是没有 Objective-C 或 C 背景的开发人员。您可能已经知道了后面详述的一些东西。
关于 TextKit 和 Glyphs
要理解的一件重要事情是，字形是一个或多个字符的视觉表示，如 WWDC 2018 Session 221“TextKit 最佳实践”中所述：
我建议观看整个演讲。对于理解 layoutManager(_:shouldGenerateGlyphs:properties:characterIndexes:font:forGlyphRange:) 如何工作的特定情况，它并不是很有帮助，但它提供了大量有关 TextKit 一般工作方式的信息。
了解shouldGenerateGlyphs
所以。据我了解，每次 NSLayoutManager 在渲染它们之前要生成一个新的字形时，它都会给你一个机会通过调用 layoutManager(_:shouldGenerateGlyphs:properties:characterIndexes:font:forGlyphRange:).
来修改这个字形
修改字形
根据文档，如果您想修改字形，您应该通过调用 setGlyphs(_:properties:characterIndexes:font:forGlyphRange:).
在此方法中进行修改
幸运的是，setGlyphs 期望在 shouldGenerateGlyphs 中传递给我们的参数完全相同。这意味着理论上你可以通过调用 setGlyphs 来实现 shouldGenerateGlyphs 并且一切都会很好（但这不会非常有用）。
Return值
文档还说 shouldGenerateGlyphs 的 return 值应该是“存储在此方法中的实际字形范围”。它没有多大意义，因为预期的 return 类型是 Int 而不是人们可能期望的 NSRange 。从反复试验中，我认为框架希望我们在这里 return 传递的 glyphRange 中修改字形的数量，从索引 0 开始（稍后会详细介绍）。
此外，“此方法中存储的字形范围”指的是对 setGlyphs 的调用，它将在内部存储新生成的字形（我认为这是非常糟糕的措辞）。
一个不太有用的实现
所以这是 shouldGenerateGlyphs 的正确实现（...什么都不做）：
func layoutManager(_ layoutManager: NSLayoutManager, shouldGenerateGlyphs glyphs: UnsafePointer<CGGlyph>, properties: UnsafePointer<NSLayoutManager.GlyphProperty>, characterIndexes: UnsafePointer<Int>, font: UIFont, forGlyphRange glyphRange: NSRange) -> Int {
layoutManager.setGlyphs(glyphs, properties: fixedPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
return glyphRange.length
}
它也应该等同于 returning 0 来自方法：
By returning 0, it can indicate for the layout manager to do the default processing.
做点有用的事
那么现在，我们如何编辑我们的字形属性来让这个方法做一些有用的事情（比如隐藏字形）？
访问参数值
shouldGenerateGlyphs的大部分参数是UnsafePointer。那是 Swift 层中的 TextKit C API 泄漏，也是使实现此方法首先变得麻烦的原因之一。
一个关键点是这里所有UnsafePointer类型的参数都是数组（在C中，SomeType *——或者它的Swift等效的 UnsafePointer<SomeType> — 是我们表示数组的方式）， 并且这些数组的长度都是 glyphRange.length。 setGlyphs 方法中间接记录了这一点：
Each array has glyphRange.length items
这意味着苹果给了我们很好的UnsafePointer API，我们可以用这样的循环迭代这些数组的元素：
for i in 0 ..< glyphRange.length {
print(properties[i])
}
在幕后，UnsafePointer 将执行指针运算以在给定传递给下标的任何索引的情况下访问正确地址处的内存。我建议阅读 UnsafePointer 文档，这真的很酷。
传递对setGlyphs
有用的东西
我们现在可以打印参数的内容，并检查框架为每个字形提供的属性。现在，我们如何修改它们并将结果传递给 setGlyphs?
首先，重要的是要注意虽然我们可以直接修改 properties 参数，但这可能不是一个好主意，因为那块内存不属于我们，我们也不知道框架是什么一旦我们退出该方法，将处理此内存。
所以正确的方法是创建我们自己的字形属性数组，然后通过setGlyphs:
var modifiedGlyphProperties = [NSLayoutManager.GlyphProperty]()
for i in 0 ..< glyphRange.length {
// This contains the default properties for the glyph at index i set by the framework.
var glyphProperties = properties[i]
// We add the property we want to the mix. GlyphProperty is an OptionSet, we can use `.insert()` to do that.
glyphProperties.insert(.null)
// Append this glyph properties to our properties array.
modifiedGlyphProperties.append(glyphProperties)
}
// Convert our Swift array to the UnsafePointer `setGlyphs` expects.
modifiedGlyphProperties.withUnsafeBufferPointer { modifiedGlyphPropertiesBufferPointer in
guard let modifiedGlyphPropertiesPointer = modifiedGlyphPropertiesBufferPointer.baseAddress else {
fatalError("Could not get base address of modifiedGlyphProperties")
}
// Call setGlyphs with the modified array.
layoutManager.setGlyphs(glyphs, properties: modifiedGlyphPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
}
return glyphRange.length
重要的是从 properties 数组读取原始字形属性并 添加 您的自定义属性到此基值（使用 .insert() 方法） .否则你会覆盖字形的默认属性并且会发生奇怪的事情（例如，我已经看到 \n 字符不再插入视觉换行符）。
决定隐藏哪些字形
之前的实现应该可以正常工作，但现在我们无条件地隐藏所有生成的字形，如果我们可以只隐藏其中的一部分（在你的情况下字形是 *).
根据字符值隐藏
为此，您可能需要访问用于生成最终字形的字符。但是，该框架不会为您提供字符，而是为每个生成的字形提供它们在字符串中的索引。您需要遍历这些索引并查看您的 NSTextStorage 以找到相应的字符。
不幸的是，这不是一项微不足道的任务：Foundation 使用 UTF-16 代码单元在内部表示字符串（这就是 NSString 和 NSAttributedString 在后台使用的内容）。所以框架用characterIndexes给我们的并不是通常意义上的“字符”的索引，而是UTF-16编码单元的索引†.
大多数情况下，每个 UTF-16 代码单元将用于生成唯一的字形，但在某些情况下，多个代码单元将用于生成唯一的字形（这称为 UTF-16 代理项对，并且在处理带有表情符号的字符串时很常见）。我建议使用一些更“奇特”的字符串来测试您的代码，例如：
textView.text = "Officiellement nous () vivons dans un cha\u{0302}teau 海"
因此，为了能够比较我们的字符，我们首先需要将它们转换为我们通常所说的“字符”的简单表示：
/// Returns the extended grapheme cluster at `index` in an UTF16View, merging a UTF-16 surrogate pair if needed.
private func characterFromUTF16CodeUnits(_ utf16CodeUnits: String.UTF16View, at index: Int) -> Character {
let codeUnitIndex = utf16CodeUnits.index(utf16CodeUnits.startIndex, offsetBy: index)
let codeUnit = utf16CodeUnits[codeUnitIndex]
if UTF16.isLeadSurrogate(codeUnit) {
let nextCodeUnit = utf16CodeUnits[utf16CodeUnits.index(after: codeUnitIndex)]
let codeUnits = [codeUnit, nextCodeUnit]
let str = String(utf16CodeUnits: codeUnits, count: 2)
return Character(str)
} else if UTF16.isTrailSurrogate(codeUnit) {
let previousCodeUnit = utf16CodeUnits[utf16CodeUnits.index(before: codeUnitIndex)]
let codeUnits = [previousCodeUnit, codeUnit]
let str = String(utf16CodeUnits: codeUnits, count: 2)
return Character(str)
} else {
let unicodeScalar = UnicodeScalar(codeUnit)!
return Character(unicodeScalar)
}
}
然后我们可以使用这个函数从我们的textStorage中提取字符，并测试它们：
// First, make sure we'll be able to access the NSTextStorage.
guard let textStorage = layoutManager.textStorage else {
fatalError("No textStorage was associated to this layoutManager")
}
// Access the characters.
let utf16CodeUnits = textStorage.string.utf16
var modifiedGlyphProperties = [NSLayoutManager.GlyphProperty]()
for i in 0 ..< glyphRange.length {
var glyphProperties = properties[i]
let character = characterFromUTF16CodeUnits(utf16CodeUnits, at: characterIndex)
// Do something with `character`, e.g.:
if character == "*" {
glyphProperties.insert(.null)
}
modifiedGlyphProperties.append(glyphProperties)
}
// Convert our Swift array to the UnsafePointer `setGlyphs` expects.
modifiedGlyphProperties.withUnsafeBufferPointer { modifiedGlyphPropertiesBufferPointer in
guard let modifiedGlyphPropertiesPointer = modifiedGlyphPropertiesBufferPointer.baseAddress else {
fatalError("Could not get base address of modifiedGlyphProperties")
}
// Call setGlyphs with the modified array.
layoutManager.setGlyphs(glyphs, properties: modifiedGlyphPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
}
return glyphRange.length
请注意，在代理对的情况下，循环将执行两次（一次在引导代理上，一次在跟踪代理上），您最终会比较相同的结果字符两次。这很好，因为您需要对生成的字形的两个“部分”应用相同的修改。
根据 TextStorage 字符串属性隐藏
这不是您在问题中要求的，但为了完成（并且因为这是我在我的应用程序中所做的），在这里您可以如何访问您的 textStorage 字符串属性以隐藏一些字形（在本例中我将用超文本 link):
隐藏文本的所有部分
// First, make sure we'll be able to access the NSTextStorage.
guard let textStorage = layoutManager.textStorage else {
fatalError("No textStorage was associated to this layoutManager")
}
// Get the first and last characters indexes for this glyph range,
// and from that create the characters indexes range.
let firstCharIndex = characterIndexes[0]
let lastCharIndex = characterIndexes[glyphRange.length - 1]
let charactersRange = NSRange(location: firstCharIndex, length: lastCharIndex - firstCharIndex + 1)
var hiddenRanges = [NSRange]()
textStorage.enumerateAttributes(in: charactersRange, options: []) { attributes, range, _ in
for attribute in attributes where attribute.key == .link {
hiddenRanges.append(range)
}
}
var modifiedGlyphProperties = [NSLayoutManager.GlyphProperty]()
for i in 0 ..< glyphRange.length {
let characterIndex = characterIndexes[i]
var glyphProperties = properties[i]
let matchingHiddenRanges = hiddenRanges.filter { NSLocationInRange(characterIndex, [=16=]) }
if !matchingHiddenRanges.isEmpty {
glyphProperties.insert(.null)
}
modifiedGlyphProperties.append(glyphProperties)
}
// Convert our Swift array to the UnsafePointer `setGlyphs` expects.
modifiedGlyphProperties.withUnsafeBufferPointer { modifiedGlyphPropertiesBufferPointer in
guard let modifiedGlyphPropertiesPointer = modifiedGlyphPropertiesBufferPointer.baseAddress else {
fatalError("Could not get base address of modifiedGlyphProperties")
}
// Call setGlyphs with the modified array.
layoutManager.setGlyphs(glyphs, properties: modifiedGlyphPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
}
return glyphRange.length
† 要了解它们之间的区别，我建议阅读 the Swift Documentation on "Strings and Characters"。另请注意，框架在这里称为“字符”的是 而不是 与 Swift 称为 Character（或“扩展字素簇”）的相同。同样，TextKit 框架的“字符”是一个 UTF-16 代码单元（在 Swift 中由 Unicode.UTF16.CodeUnit 表示）。
2020-04-16更新：利用.withUnsafeBufferPointer将modifiedGlyphProperties数组转换为UnsafePointer。它不再需要数组的实例变量来使其在内存中保持活动状态。
我决定提交另一个解决方案，因为关于这个主题的信息很少，也许有人会觉得它有用。最初我完全被 layoutManager(_:shouldGenerateGlyphs:properties:characterIndexes:font:forGlyphRange:) 搞糊涂了，直到我发现 Guillaume Algis 的非常详尽的解释（上文）。连同 25'18" 处的幻灯片进入 WWDC 2018 演示文稿 "TextKit Best Practices" 并研究不安全指针的工作原理对我来说是个窍门。
我的解决方案不直接处理隐藏降价字符；相反，它会隐藏具有特定值 (DisplayType.excluded) 的自定义属性 (displayType) 的字符。 （这正是我所需要的。）但代码相当优雅，因此可能具有指导意义。
自定义属性定义如下：
extension NSAttributedString.Key { static let displayType = NSAttributedString.Key(rawValue: "displayType") }
要检查一些东西，可以进入视图控制器的 ViewDidLoad（设置为 NSLayoutManagerDelegate）：
textView.layoutManager.delegate = self
let text = NSMutableAttributedString(string: "This isn't easy!", attributes: [.font: UIFont.systemFont(ofSize: 24), .displayType: DisplayType.included])
let rangeToExclude = NSRange(location: 7, length: 3)
text.addAttribute(.displayType, value: DisplayType.excluded, range: rangeToExclude)
textView.attributedText = text
最后，这是完成所有工作的函数：
func layoutManager(_ layoutManager: NSLayoutManager, shouldGenerateGlyphs glyphs: UnsafePointer<CGGlyph>, properties props: UnsafePointer<NSLayoutManager.GlyphProperty>, characterIndexes charIndexes: UnsafePointer<Int>, font aFont: UIFont, forGlyphRange glyphRange: NSRange) -> Int {
// Make mutableProperties an optional to allow checking if it gets allocated
var mutableProperties: UnsafeMutablePointer<NSLayoutManager.GlyphProperty>? = nil
// Check the attributes value only at charIndexes.pointee, where this glyphRange begins
if let attribute = textView.textStorage.attribute(.displayType, at: charIndexes.pointee, effectiveRange: nil) as? DisplayType, attribute == .excluded {
// Allocate mutableProperties
mutableProperties = .allocate(capacity: glyphRange.length)
// Initialize each element of mutableProperties
for index in 0..<glyphRange.length { mutableProperties?[index] = .null }
}
// Update only if mutableProperties was allocated
if let mutableProperties = mutableProperties {
layoutManager.setGlyphs(glyphs, properties: mutableProperties, characterIndexes: charIndexes, font: aFont, forGlyphRange: glyphRange)
// Clean up this UnsafeMutablePointer
mutableProperties.deinitialize(count: glyphRange.length)
mutableProperties.deallocate()
return glyphRange.length
} else { return 0 }
}
对于字符和字形计数不匹配的情况，上面的代码似乎是可靠的：attribute(_:at:effectiveRange:) 仅使用 charIndexes，而 mutableProperties 仅使用 glyphRange.此外，由于 mutableProperties 在 main 函数中被赋予与 props 相同的类型（好吧，实际上，它是可变的和可选的），因此以后不需要转换它。
我正在使用 Markdown 语法的 Mac 应用程序中的富文本编辑器。我使用 NSTextStorage 来观察 Markdown 语法中的匹配项，然后像这样实时将样式应用于 NSAttributedString：
在这一点上，我已经在这方面不知所措，但我很高兴能取得进展。 :) This tutorial was very helpful.
作为下一步，我想在呈现 NSTextView 的字符串时 隐藏 Markdown 字符 。所以在上面的例子中，一旦输入最后一个星号，我希望 * * 字符被隐藏，只看到 sample 粗体。
我正在使用 NSLayoutManager 委托，我可以看到匹配的字符串，但我不清楚如何使用 shouldGenerateGlyphs 方法生成修改后的 glyphs/properties。这是我目前所拥有的：
func layoutManager(_: NSLayoutManager, shouldGenerateGlyphs _: UnsafePointer<CGGlyph>, properties _: UnsafePointer<NSLayoutManager.GlyphProperty>, characterIndexes _: UnsafePointer<Int>, font _: NSFont, forGlyphRange glyphRange: NSRange) -> Int {
let pattern = "(\*\w+(\s\w+)*\*)" // Look for stuff like *this*
do {
let regex = try NSRegularExpression(pattern: pattern)
regex.enumerateMatches(in: textView.string, range: glyphRange) {
match, _, _ in
// apply the style
if let matchRange = match?.range(at: 1) {
print(matchRange) <!-- This is the range of *sample*
// I am confused on how to provide the updated properties below...
// let newProps = NSLayoutManager.GlyphProperty.null
// layoutManager.setGlyphs(glyphs, properties: newProps, characterIndexes: charIndexes, font: aFont, forGlyphRange: glyphRange)
// return glyphRange.length
}
}
} catch {
print("\(error.localizedDescription)")
}
return 0
}
如何根据我发现隐藏星号的文本范围修改要传递给 setGlyphs 的内容？
2022 免责声明
虽然我在最初提交此答案时取得了一些不错的结果 运行 这段代码，但另一个 SO 用户 (Tim S.) 警告我在某些情况下应用 .null 字形属性某些字形会导致应用程序挂起或崩溃。
据我所知，这只发生在 .null 属性 和字形 8192 (2^13) 附近......我不知道为什么，老实说它看起来像TextKit 错误（或者至少不是 TextKit 工程师期望使用该框架的错误）。
对于现代应用程序，我建议您 take a look a TextKit 2，它应该抽象掉字形处理并简化所有这些东西（免责声明中的免责声明：我还没有尝试过）。
前言
我实现了这个方法来在我的应用程序中实现类似的功能。请记住，这个 API 的文档很少，所以我的解决方案是基于反复试验而不是对这里所有活动部分的深入理解。
简而言之：它应该有效，但使用风险自负 :)
另请注意，我在这个答案中介绍了很多细节，希望任何 Swift 开发人员都可以访问它，即使是没有 Objective-C 或 C 背景的开发人员。您可能已经知道了后面详述的一些东西。
关于 TextKit 和 Glyphs
要理解的一件重要事情是，字形是一个或多个字符的视觉表示，如 WWDC 2018 Session 221“TextKit 最佳实践”中所述：
我建议观看整个演讲。对于理解 layoutManager(_:shouldGenerateGlyphs:properties:characterIndexes:font:forGlyphRange:) 如何工作的特定情况，它并不是很有帮助，但它提供了大量有关 TextKit 一般工作方式的信息。
了解shouldGenerateGlyphs
所以。据我了解，每次 NSLayoutManager 在渲染它们之前要生成一个新的字形时，它都会给你一个机会通过调用 layoutManager(_:shouldGenerateGlyphs:properties:characterIndexes:font:forGlyphRange:).
修改字形
根据文档，如果您想修改字形，您应该通过调用 setGlyphs(_:properties:characterIndexes:font:forGlyphRange:).
幸运的是，setGlyphs 期望在 shouldGenerateGlyphs 中传递给我们的参数完全相同。这意味着理论上你可以通过调用 setGlyphs 来实现 shouldGenerateGlyphs 并且一切都会很好（但这不会非常有用）。
Return值
文档还说 shouldGenerateGlyphs 的 return 值应该是“存储在此方法中的实际字形范围”。它没有多大意义，因为预期的 return 类型是 Int 而不是人们可能期望的 NSRange 。从反复试验中，我认为框架希望我们在这里 return 传递的 glyphRange 中修改字形的数量，从索引 0 开始（稍后会详细介绍）。
此外，“此方法中存储的字形范围”指的是对 setGlyphs 的调用，它将在内部存储新生成的字形（我认为这是非常糟糕的措辞）。
一个不太有用的实现
所以这是 shouldGenerateGlyphs 的正确实现（...什么都不做）：
func layoutManager(_ layoutManager: NSLayoutManager, shouldGenerateGlyphs glyphs: UnsafePointer<CGGlyph>, properties: UnsafePointer<NSLayoutManager.GlyphProperty>, characterIndexes: UnsafePointer<Int>, font: UIFont, forGlyphRange glyphRange: NSRange) -> Int {
layoutManager.setGlyphs(glyphs, properties: fixedPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
return glyphRange.length
}
它也应该等同于 returning 0 来自方法：
By returning 0, it can indicate for the layout manager to do the default processing.
做点有用的事
那么现在，我们如何编辑我们的字形属性来让这个方法做一些有用的事情（比如隐藏字形）？
访问参数值
shouldGenerateGlyphs的大部分参数是UnsafePointer。那是 Swift 层中的 TextKit C API 泄漏，也是使实现此方法首先变得麻烦的原因之一。
一个关键点是这里所有UnsafePointer类型的参数都是数组（在C中，SomeType *——或者它的Swift等效的 UnsafePointer<SomeType> — 是我们表示数组的方式）， 并且这些数组的长度都是 glyphRange.length。 setGlyphs 方法中间接记录了这一点：
Each array has glyphRange.length items
这意味着苹果给了我们很好的UnsafePointer API，我们可以用这样的循环迭代这些数组的元素：
for i in 0 ..< glyphRange.length {
print(properties[i])
}
在幕后，UnsafePointer 将执行指针运算以在给定传递给下标的任何索引的情况下访问正确地址处的内存。我建议阅读 UnsafePointer 文档，这真的很酷。
传递对setGlyphs
我们现在可以打印参数的内容，并检查框架为每个字形提供的属性。现在，我们如何修改它们并将结果传递给 setGlyphs?
首先，重要的是要注意虽然我们可以直接修改 properties 参数，但这可能不是一个好主意，因为那块内存不属于我们，我们也不知道框架是什么一旦我们退出该方法，将处理此内存。
所以正确的方法是创建我们自己的字形属性数组，然后通过setGlyphs:
var modifiedGlyphProperties = [NSLayoutManager.GlyphProperty]()
for i in 0 ..< glyphRange.length {
// This contains the default properties for the glyph at index i set by the framework.
var glyphProperties = properties[i]
// We add the property we want to the mix. GlyphProperty is an OptionSet, we can use `.insert()` to do that.
glyphProperties.insert(.null)
// Append this glyph properties to our properties array.
modifiedGlyphProperties.append(glyphProperties)
}
// Convert our Swift array to the UnsafePointer `setGlyphs` expects.
modifiedGlyphProperties.withUnsafeBufferPointer { modifiedGlyphPropertiesBufferPointer in
guard let modifiedGlyphPropertiesPointer = modifiedGlyphPropertiesBufferPointer.baseAddress else {
fatalError("Could not get base address of modifiedGlyphProperties")
}
// Call setGlyphs with the modified array.
layoutManager.setGlyphs(glyphs, properties: modifiedGlyphPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
}
return glyphRange.length
重要的是从 properties 数组读取原始字形属性并 添加 您的自定义属性到此基值（使用 .insert() 方法） .否则你会覆盖字形的默认属性并且会发生奇怪的事情（例如，我已经看到 \n 字符不再插入视觉换行符）。
决定隐藏哪些字形
之前的实现应该可以正常工作，但现在我们无条件地隐藏所有生成的字形，如果我们可以只隐藏其中的一部分（在你的情况下字形是 *).
根据字符值隐藏
为此，您可能需要访问用于生成最终字形的字符。但是，该框架不会为您提供字符，而是为每个生成的字形提供它们在字符串中的索引。您需要遍历这些索引并查看您的 NSTextStorage 以找到相应的字符。
不幸的是，这不是一项微不足道的任务：Foundation 使用 UTF-16 代码单元在内部表示字符串（这就是 NSString 和 NSAttributedString 在后台使用的内容）。所以框架用characterIndexes给我们的并不是通常意义上的“字符”的索引，而是UTF-16编码单元的索引†.
大多数情况下，每个 UTF-16 代码单元将用于生成唯一的字形，但在某些情况下，多个代码单元将用于生成唯一的字形（这称为 UTF-16 代理项对，并且在处理带有表情符号的字符串时很常见）。我建议使用一些更“奇特”的字符串来测试您的代码，例如：
textView.text = "Officiellement nous () vivons dans un cha\u{0302}teau 海"
因此，为了能够比较我们的字符，我们首先需要将它们转换为我们通常所说的“字符”的简单表示：
/// Returns the extended grapheme cluster at `index` in an UTF16View, merging a UTF-16 surrogate pair if needed.
private func characterFromUTF16CodeUnits(_ utf16CodeUnits: String.UTF16View, at index: Int) -> Character {
let codeUnitIndex = utf16CodeUnits.index(utf16CodeUnits.startIndex, offsetBy: index)
let codeUnit = utf16CodeUnits[codeUnitIndex]
if UTF16.isLeadSurrogate(codeUnit) {
let nextCodeUnit = utf16CodeUnits[utf16CodeUnits.index(after: codeUnitIndex)]
let codeUnits = [codeUnit, nextCodeUnit]
let str = String(utf16CodeUnits: codeUnits, count: 2)
return Character(str)
} else if UTF16.isTrailSurrogate(codeUnit) {
let previousCodeUnit = utf16CodeUnits[utf16CodeUnits.index(before: codeUnitIndex)]
let codeUnits = [previousCodeUnit, codeUnit]
let str = String(utf16CodeUnits: codeUnits, count: 2)
return Character(str)
} else {
let unicodeScalar = UnicodeScalar(codeUnit)!
return Character(unicodeScalar)
}
}
然后我们可以使用这个函数从我们的textStorage中提取字符，并测试它们：
// First, make sure we'll be able to access the NSTextStorage.
guard let textStorage = layoutManager.textStorage else {
fatalError("No textStorage was associated to this layoutManager")
}
// Access the characters.
let utf16CodeUnits = textStorage.string.utf16
var modifiedGlyphProperties = [NSLayoutManager.GlyphProperty]()
for i in 0 ..< glyphRange.length {
var glyphProperties = properties[i]
let character = characterFromUTF16CodeUnits(utf16CodeUnits, at: characterIndex)
// Do something with `character`, e.g.:
if character == "*" {
glyphProperties.insert(.null)
}
modifiedGlyphProperties.append(glyphProperties)
}
// Convert our Swift array to the UnsafePointer `setGlyphs` expects.
modifiedGlyphProperties.withUnsafeBufferPointer { modifiedGlyphPropertiesBufferPointer in
guard let modifiedGlyphPropertiesPointer = modifiedGlyphPropertiesBufferPointer.baseAddress else {
fatalError("Could not get base address of modifiedGlyphProperties")
}
// Call setGlyphs with the modified array.
layoutManager.setGlyphs(glyphs, properties: modifiedGlyphPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
}
return glyphRange.length
请注意，在代理对的情况下，循环将执行两次（一次在引导代理上，一次在跟踪代理上），您最终会比较相同的结果字符两次。这很好，因为您需要对生成的字形的两个“部分”应用相同的修改。
根据 TextStorage 字符串属性隐藏
这不是您在问题中要求的，但为了完成（并且因为这是我在我的应用程序中所做的），在这里您可以如何访问您的 textStorage 字符串属性以隐藏一些字形（在本例中我将用超文本 link):
隐藏文本的所有部分// First, make sure we'll be able to access the NSTextStorage.
guard let textStorage = layoutManager.textStorage else {
fatalError("No textStorage was associated to this layoutManager")
}
// Get the first and last characters indexes for this glyph range,
// and from that create the characters indexes range.
let firstCharIndex = characterIndexes[0]
let lastCharIndex = characterIndexes[glyphRange.length - 1]
let charactersRange = NSRange(location: firstCharIndex, length: lastCharIndex - firstCharIndex + 1)
var hiddenRanges = [NSRange]()
textStorage.enumerateAttributes(in: charactersRange, options: []) { attributes, range, _ in
for attribute in attributes where attribute.key == .link {
hiddenRanges.append(range)
}
}
var modifiedGlyphProperties = [NSLayoutManager.GlyphProperty]()
for i in 0 ..< glyphRange.length {
let characterIndex = characterIndexes[i]
var glyphProperties = properties[i]
let matchingHiddenRanges = hiddenRanges.filter { NSLocationInRange(characterIndex, [=16=]) }
if !matchingHiddenRanges.isEmpty {
glyphProperties.insert(.null)
}
modifiedGlyphProperties.append(glyphProperties)
}
// Convert our Swift array to the UnsafePointer `setGlyphs` expects.
modifiedGlyphProperties.withUnsafeBufferPointer { modifiedGlyphPropertiesBufferPointer in
guard let modifiedGlyphPropertiesPointer = modifiedGlyphPropertiesBufferPointer.baseAddress else {
fatalError("Could not get base address of modifiedGlyphProperties")
}
// Call setGlyphs with the modified array.
layoutManager.setGlyphs(glyphs, properties: modifiedGlyphPropertiesPointer, characterIndexes: characterIndexes, font: font, forGlyphRange: glyphRange)
}
return glyphRange.length
† 要了解它们之间的区别，我建议阅读 the Swift Documentation on "Strings and Characters"。另请注意，框架在这里称为“字符”的是 而不是 与 Swift 称为 Character（或“扩展字素簇”）的相同。同样，TextKit 框架的“字符”是一个 UTF-16 代码单元（在 Swift 中由 Unicode.UTF16.CodeUnit 表示）。
2020-04-16更新：利用.withUnsafeBufferPointer将modifiedGlyphProperties数组转换为UnsafePointer。它不再需要数组的实例变量来使其在内存中保持活动状态。
我决定提交另一个解决方案，因为关于这个主题的信息很少，也许有人会觉得它有用。最初我完全被 layoutManager(_:shouldGenerateGlyphs:properties:characterIndexes:font:forGlyphRange:) 搞糊涂了，直到我发现 Guillaume Algis 的非常详尽的解释（上文）。连同 25'18" 处的幻灯片进入 WWDC 2018 演示文稿 "TextKit Best Practices" 并研究不安全指针的工作原理对我来说是个窍门。
我的解决方案不直接处理隐藏降价字符；相反，它会隐藏具有特定值 (DisplayType.excluded) 的自定义属性 (displayType) 的字符。 （这正是我所需要的。）但代码相当优雅，因此可能具有指导意义。
自定义属性定义如下：
extension NSAttributedString.Key { static let displayType = NSAttributedString.Key(rawValue: "displayType") }
要检查一些东西，可以进入视图控制器的 ViewDidLoad（设置为 NSLayoutManagerDelegate）：
textView.layoutManager.delegate = self
let text = NSMutableAttributedString(string: "This isn't easy!", attributes: [.font: UIFont.systemFont(ofSize: 24), .displayType: DisplayType.included])
let rangeToExclude = NSRange(location: 7, length: 3)
text.addAttribute(.displayType, value: DisplayType.excluded, range: rangeToExclude)
textView.attributedText = text
最后，这是完成所有工作的函数：
func layoutManager(_ layoutManager: NSLayoutManager, shouldGenerateGlyphs glyphs: UnsafePointer<CGGlyph>, properties props: UnsafePointer<NSLayoutManager.GlyphProperty>, characterIndexes charIndexes: UnsafePointer<Int>, font aFont: UIFont, forGlyphRange glyphRange: NSRange) -> Int {
// Make mutableProperties an optional to allow checking if it gets allocated
var mutableProperties: UnsafeMutablePointer<NSLayoutManager.GlyphProperty>? = nil
// Check the attributes value only at charIndexes.pointee, where this glyphRange begins
if let attribute = textView.textStorage.attribute(.displayType, at: charIndexes.pointee, effectiveRange: nil) as? DisplayType, attribute == .excluded {
// Allocate mutableProperties
mutableProperties = .allocate(capacity: glyphRange.length)
// Initialize each element of mutableProperties
for index in 0..<glyphRange.length { mutableProperties?[index] = .null }
}
// Update only if mutableProperties was allocated
if let mutableProperties = mutableProperties {
layoutManager.setGlyphs(glyphs, properties: mutableProperties, characterIndexes: charIndexes, font: aFont, forGlyphRange: glyphRange)
// Clean up this UnsafeMutablePointer
mutableProperties.deinitialize(count: glyphRange.length)
mutableProperties.deallocate()
return glyphRange.length
} else { return 0 }
}
对于字符和字形计数不匹配的情况，上面的代码似乎是可靠的：attribute(_:at:effectiveRange:) 仅使用 charIndexes，而 mutableProperties 仅使用 glyphRange.此外，由于 mutableProperties 在 main 函数中被赋予与 props 相同的类型（好吧，实际上，它是可变的和可选的），因此以后不需要转换它。