File: Extract.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 (68 lines) | stat: -rw-r--r-- 2,792 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
/*
 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
*/

import Foundation
import Markdown

extension Semantic.Analyses {
    /**
     Separates `children` into directives whose names match `Child.directiveName` and those remaining, attempting to convert extracted children to the semantic `Child` type.
     */
    public struct ExtractAll<Child: Semantic & DirectiveConvertible>: SemanticAnalysis {
        public init() {}
        
        public func analyze(_ directive: BlockDirective, children: some Sequence<Markup>, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem]) -> ([Child], remainder: MarkupContainer) {
            return Semantic.Analyses.extractAll(
                childType: Child.self,
                children: children,
                source: source,
                for: bundle,
                in: context,
                problems: &problems
            ) as! ([Child], MarkupContainer)
        }
    }
    
    static func extractAll(
        childType: DirectiveConvertible.Type,
        children: some Sequence<Markup>,
        source: URL?,
        for bundle: DocumentationBundle,
        in context: DocumentationContext,
        problems: inout [Problem]
    ) -> ([DirectiveConvertible], remainder: MarkupContainer) {
        let (candidates, remainder) = children.categorize { child -> BlockDirective? in
            guard let childDirective = child as? BlockDirective,
                childType.canConvertDirective(childDirective) else {
                    return nil
            }
            return childDirective
        }
        let converted = candidates.compactMap {
            childType.init(from: $0, source: source, for: bundle, in: context, problems: &problems)
        }
        return (converted, remainder: MarkupContainer(remainder))
    }
    
    /**
     Separates `children` into markup elements that are of a specific type without performing any further analysis.
     */
    public struct ExtractAllMarkup<Child: Markup>: SemanticAnalysis {
        public init() {}
        
        public func analyze(_ directive: BlockDirective, children: some Sequence<Markup>, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem]) -> ([Child], remainder: MarkupContainer) {
            let (matches, remainder) = children.categorize {
                $0 as? Child
            }
            return (matches, remainder: MarkupContainer(remainder))
        }
    }
}