File: SymbolKind.Swift.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 (39 lines) | stat: -rw-r--r-- 1,644 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
/*
 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 SymbolKit

extension SymbolGraph.Symbol.KindIdentifier {
    /// The list of Swift-specific symbol kinds that could possibly have other symbols as children.
    public var swiftSymbolCouldHaveChildren: Bool {
        switch self {
        case .associatedtype, .deinit, .case, .func, .operator, .`init`, .method, .property, .typeMethod, .typeProperty, .typealias, .var:
            return false
        default: return true
        }
    }
    
    /// Returns the kind identifier in the form expected when creating render models.
    ///
    /// Used for ``RenderNode`` and ``RenderIndex`` creation.
    var renderingIdentifier: String {
        // This code was originally added to remove `swift.` name-spacing.
        //
        // Since then, SymbolKit has removed language name-spacing from symbol kinds and introduced
        // some kinds that actually rely on name-spacing (like 'type.method' vs. 'method'
        // and 'func.op').
        //
        // However, existing clients are relying on this behavior so we should continue this way
        // for now until we can make a coordinate change to remove this logic and just use the
        // base identifier, including any dot-separated specifics.
        return identifier.components(separatedBy: ".").last ?? identifier
    }
}