File: RenderSection%2BTextIndexing.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (392 lines) | stat: -rw-r--r-- 12,448 bytes parent folder | download
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See https://swift.org/LICENSE.txt for license information
 See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

extension IntroRenderSection {
    public var headings: [String] {
        // An Intro's title becomes the top-level page's title, so it doesn't need to be included as a heading here. It doesn't get its own index record.
        return content.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return content.rawIndexableTextContent(references: references)
    }
}

extension VolumeRenderSection {
    public var headings: [String] {
        return name.map { [$0] } ?? [] +
            (content.map { $0.headings } ?? []) +
            chapters.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return content.map { $0.rawIndexableTextContent(references: references) } ?? ""
    }
}

extension ResourcesRenderSection {
    public var headings: [String] {
        return tiles.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return content.rawIndexableTextContent(references: references)
    }
}

extension RenderTile {
    public var headings: [String] {
        return [title] +
            content.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return content.rawIndexableTextContent(references: references)
    }
}

extension CallToActionSection {
    public var headings: [String] {
        // A call-to-action's title is effectively an H2 on the page. It doesn't get its own index record.
        return [title]
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return abstract.rawIndexableTextContent(references: references)
    }
}

extension ContentAndMediaGroupSection {
    public var headings: [String] {
        return sections.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return sections.map { $0.rawIndexableTextContent(references: references) }.joined(separator: " ")
    }
}

extension ContentAndMediaSection {
    public var headings: [String] {
        // A ContentAndMedia's title is effectively an H2 on the page. It doesn't get its own index record.
        return (title.map { [$0] } ?? []) + content.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return content.rawIndexableTextContent(references: references)
    }
}

extension TutorialAssessmentsRenderSection {
    public var headings: [String] {
        return assessments.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return assessments.map { $0.rawIndexableTextContent(references: references) }.joined(separator: " ")
    }
}

extension TutorialAssessmentsRenderSection.Assessment {
    public var headings: [String] {
        // An assessment's title effectively becomes an H2 on the page. It doesn't get its own index record.
        // Title content shouldn't have references, so none need to be inlined, hence the empty references dictionary here.
        return [title.rawIndexableTextContent(references: [:])]
            + (self.content?.headings ?? [])
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return content.map {
            $0.rawIndexableTextContent(references: references)
        } ?? ""
    }
}

extension TutorialSectionsRenderSection {
    public var headings: [String] {
        return tasks.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return tasks.map { $0.rawIndexableTextContent(references: references) }.joined(separator: " ")
    }
}

extension TutorialSectionsRenderSection.Section {
    public var headings: [String] {
        return contentSection.headings +
            stepsSection.flatMap { $0.headings }
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return contentSection.rawIndexableTextContent(references: references) + " " +
        stepsSection.map { $0.rawIndexableTextContent(references: references) }.joined(separator: " ")
    }
}

extension TutorialArticleSection {
    public var headings: [String] {
        return content.headings
    }
    
    public func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return content.rawIndexableTextContent(references: references)
    }
}

extension ContentRenderSection {
    public var headings: [String] {
        return content.headings
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return content.rawIndexableTextContent(references: references)
    }
}

extension ParametersRenderSection {
    public var headings: [String] {
        return parameters.flatMap {
            return $0.headings
        }
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return parameters.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ")
    }
}

extension ParameterRenderSection {
    public var headings: [String] {
        return content.headings
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return content.rawIndexableTextContent(references: references)
    }
}

extension RelationshipsRenderSection {
    public var headings: [String] {
        return [title]
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return title
    }
}

extension TaskGroupRenderSection {
    public var headings: [String] {
        guard let title else { return [] }
        return [title]
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return title ?? ""
    }
}

extension RESTParametersRenderSection {
    public var headings: [String] {
        return items.flatMap {
            return $0.headings
        }
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return items.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ")
    }
}

extension RenderProperty {
    public var headings: [String] {
        return [name]
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return content?.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ") ?? ""
    }
}

extension RESTResponse {
    public var headings: [String] {
        return reason.map({ [$0] }) ?? []
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return content?.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ") ?? ""
    }
}

extension RESTResponseRenderSection {
    public var headings: [String] {
        return items.flatMap {
            return $0.headings
        }
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return items.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ")
    }
}

extension RESTEndpointRenderSection {
    public var headings: [String] {
        return [title]
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return title
    }
}

extension RESTBodyRenderSection {
    public var headings: [String] {
        return [title] + (parameters?.flatMap {
            return $0.headings
        } ?? [])
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        let contentText = (content?.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ")) ?? ""

        let parametersText = (parameters?.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ")) ?? ""

        return contentText + " " + parametersText
    }
}

extension PropertiesRenderSection {
    public var headings: [String] {
        return items.flatMap {
            return $0.headings
        }
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return items.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ")
    }
}

extension RenderAttribute {
    public var headings: [String] {
        return [title]
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        switch self {
        case .default(let value): return value
        case .maximum(let value): return value
        case .maximumExclusive(let value): return value
        case .maximumLength(let value): return value
        case .minimum(let value): return value
        case .minimumExclusive(let value): return value
        case .minimumLength(let value): return value
        case .allowedValues(let values): return values.joined(separator: " ")
        case .allowedTypes(let values): return values.map { return $0.map { $0.text }.joined() }.joined(separator: " ")
        }
    }
}

extension AttributesRenderSection {
    public var headings: [String] {
        return attributes?.flatMap {
            return $0.headings
        } ?? []
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return attributes?.map {
            return $0.rawIndexableTextContent(references: references)
        }.joined(separator: " ") ?? ""
    }
}

extension PlistDetailsRenderSection {
    public var headings: [String] {
        if let displayName = details.displayName {
            return [details.rawKey, displayName]
        } else {
            return [details.rawKey]
        }
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return [details.rawKey, details.displayName ?? ""].joined(separator: " ")
    }
}

extension PossibleValuesRenderSection {
    public var headings: [String] {
        return []
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return values.map { namedValue -> String in
            let content = namedValue.content?.rawIndexableTextContent(references: references) ?? ""
            return namedValue.name + " " + content
        }.joined(separator: " ")
    }
}

extension SampleDownloadSection {
    public var headings: [String] {
        return []
    }
    
    public func rawIndexableTextContent(references: [String : RenderReference]) -> String {
        return ""
    }
}

extension Sequence<ContentLayout> {
    func rawIndexableTextContent(references: [String: RenderReference]) -> String {
        return map { layout -> String in
            switch layout {
            case .fullWidth(let content):
                return content.rawIndexableTextContent(references: references)
            case .contentAndMedia(let content):
                return content.rawIndexableTextContent(references: references)
            case .columns(let content):
                return content.map { $0.rawIndexableTextContent(references: references) }.joined(separator: " ")
            }
        }.joined(separator: " ")
    }
    
    var headings: [String] {
        return flatMap { layout -> [String] in
            switch layout {
            case .fullWidth(let content):
                return content.headings
            case .contentAndMedia(let content):
                return content.headings
            case .columns(let content):
                return content.headings
            }
        }
    }
}