forked from alexaubry/HTMLString
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHTMLString.swift
More file actions
178 lines (133 loc) · 5.31 KB
/
HTMLString.swift
File metadata and controls
178 lines (133 loc) · 5.31 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
import Foundation
// MARK: Escaping
public extension String {
///
/// Returns a copy of the current `String` where every character incompatible with HTML Unicode
/// encoding (UTF-16 or UTF-8) is replaced by a decimal HTML entity.
///
/// ### Examples
///
/// | String | Result | Format |
/// |--------|--------|--------|
/// | `&` | `&` | Decimal entity (part of the Unicode special characters) |
/// | `Σ` | `Σ` | Not escaped (Unicode compliant) |
/// | `🇺🇸` | `🇺🇸` | Not escaped (Unicode compliant) |
/// | `a` | `a` | Not escaped (alphanumerical) |
///
public var addingUnicodeEntities: String {
return unicodeScalars.reduce("") { $0 + $1.escapingIfNeeded }
}
///
/// Returns a copy of the current `String` where every character incompatible with HTML ASCII
/// encoding is replaced by a decimal HTML entity.
///
/// ### Examples
///
/// | String | Result | Format |
/// |--------|--------|--------|
/// | `&` | `&` | Decimal entity |
/// | `Σ` | `Σ` | Decimal entity |
/// | `🇺🇸` | `🇺🇸` | Combined decimal entities (extented grapheme cluster) |
/// | `a` | `a` | Not escaped (alphanumerical) |
///
/// ### Performance
///
/// If your webpage is unicode encoded (UTF-16 or UTF-8) use `addingUnicodeEntities` instead,
/// as it is faster and produces a less bloated and more readable HTML.
///
public var addingASCIIEntities: String {
return unicodeScalars.reduce("") { $0 + $1.escapingForASCII }
}
}
// MARK: - Unescaping
extension String {
///
/// Returns a copy of the current `String` where every HTML entity is replaced with the matching
/// Unicode character.
///
/// ### Examples
///
/// | String | Result | Format |
/// |--------|--------|--------|
/// | `&` | `&` | Keyword entity |
/// | `Σ` | `Σ` | Decimal entity |
/// | `č` | `č` | Hexadecimal entity |
/// | `🇺🇸` | `🇺🇸` | Combined decimal entities (extented grapheme cluster) |
/// | `a` | `a` | Not an entity |
/// | `&` | `&` | Not an entity |
///
public var removingHTMLEntities: String {
guard self.contains("&") else {
return self
}
var result = String()
var cursorPosition = startIndex
while let delimiterRange = range(of: "&", range: cursorPosition ..< endIndex) {
// Avoid unnecessary operations
let head = self[cursorPosition ..< delimiterRange.lowerBound]
result += head
guard let semicolonRange = range(of: ";", range: delimiterRange.upperBound ..< endIndex) else {
result += "&"
cursorPosition = delimiterRange.upperBound
break
}
let escapableContent = self[delimiterRange.upperBound ..< semicolonRange.lowerBound]
let escapableContentString = String(escapableContent)
let replacementString: String
if escapableContentString.hasPrefix("#") {
guard let unescapedNumber = escapableContentString.unescapeAsNumber() else {
result += self[delimiterRange.lowerBound ..< semicolonRange.upperBound]
cursorPosition = semicolonRange.upperBound
continue
}
replacementString = unescapedNumber
} else {
guard let unescapedCharacter = HTMLUnescapingTable[escapableContentString] else {
result += self[delimiterRange.lowerBound ..< semicolonRange.upperBound]
cursorPosition = semicolonRange.upperBound
continue
}
replacementString = unescapedCharacter
}
result += replacementString
cursorPosition = semicolonRange.upperBound
}
// Append unprocessed data, if unprocessed data there is
let tail = self[cursorPosition ..< endIndex]
result += tail
return result
}
private func unescapeAsNumber() -> String? {
let isHexadecimal = hasPrefix("#X") || hasPrefix("#x")
let radix = isHexadecimal ? 16 : 10
let numberStartIndex = index(startIndex, offsetBy: isHexadecimal ? 2 : 1)
let numberString = self[numberStartIndex ..< endIndex]
guard let codePoint = UInt32(numberString, radix: radix),
let scalar = UnicodeScalar(codePoint) else {
return nil
}
return String(scalar)
}
}
// MARK: - UnicodeScalar+Escape
extension UnicodeScalar {
/// Returns the decimal HTML entity for this Unicode scalar.
public var htmlEscaped: String {
return "&#" + String(value) + ";"
}
/// The scalar escaped for ASCII encoding.
fileprivate var escapingForASCII: String {
return isASCII ? escapingIfNeeded : htmlEscaped
}
///
/// Escapes the scalar only if it needs to be escaped for Unicode pages.
///
/// [Reference](http://wonko.com/post/html-escaping)
///
fileprivate var escapingIfNeeded: String {
switch value {
case 33, 34, 36, 37, 38, 39, 43, 44, 60, 61, 62, 64, 91, 93, 96, 123, 125: return htmlEscaped
default: return String(self)
}
}
}