File: RemoveAutomaticallyCuratedSeeAlsoSectionsTransformation.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 (44 lines) | stat: -rw-r--r-- 2,067 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
/*
 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
*/

/// A transformation that removes automatically curated See Also sections.
public struct RemoveAutomaticallyCuratedSeeAlsoSectionsTransformation: RenderNodeTransforming {
    /// Creates a new transformer.
    public init() {}
    
    /// Removes automatically curated See Also sections from the given render node.
    ///
    /// Applying this transformation will also decrease the reference count in the returned transformation context
    /// for all the references in the removed See Also sections.
    ///
    /// - Parameters:
    ///   - renderNode: The render node from which this transformation removes automatically curated See Also sections.
    ///   - context: The context that tracks the number of times each reference is referenced in the render node's content.
    /// - Returns: The transformed render node and context with updated reference counts.
    public func transform(renderNode: RenderNode, context: RenderNodeTransformationContext)
        -> RenderNodeTransformationResult {
        var (renderNode, context) = (renderNode, context)
        // Remove automatically curated See Also sections.
        let generatedIndex = renderNode.seeAlsoSections.partition { $0.generated }
        let generatedSeeAlsoSections = renderNode.seeAlsoSections[generatedIndex...]
        let authoredSeeAlsoSections = renderNode.seeAlsoSections[..<generatedIndex]

        renderNode.seeAlsoSections = Array(authoredSeeAlsoSections)

        // Remove unused references.
        for generatedSeeAlsoSection in generatedSeeAlsoSections {
            for identifier in generatedSeeAlsoSection.identifiers {
                context.referencesCount[identifier]? -= 1
            }
        }

        return (renderNode, context)
    }
}