File: IdentifierConvertible.swift

package info (click to toggle)
swiftlang 6.1.3-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,791,748 kB
  • sloc: cpp: 9,901,738; ansic: 2,201,433; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (58 lines) | stat: -rw-r--r-- 1,896 bytes parent folder | download | duplicates (2)
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2024 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 the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import SwiftSyntax

/// Instances of a conforming type should provide an identifier to be used in code generation.
public protocol IdentifierConvertible {
  /// The name of the instance as an identifer.
  var identifier: TokenSyntax {
    get
  }
}

public extension IdentifierConvertible {
  /// ``identifier`` escaped as a base name suitable for call sites.
  var baseCallName: TokenSyntax {
    identifier.declNameOrVarCallName
  }

  /// ``identifier`` escaped as an enum case name suitable for call sites.
  var enumCaseCallName: TokenSyntax {
    memberCallName
  }

  /// ``identifier`` escaped as a member name suitable for call sites.
  var memberCallName: TokenSyntax {
    identifier.nonVarCallNameOrLabelDeclName
  }

  /// ``identifier`` escaped as an enum case name suitable for declaration sites.
  var enumCaseDeclName: TokenSyntax {
    identifier.declNameOrVarCallName
  }

  /// ``identifier`` escaped as a function name suitable for declaration sites.
  var funcDeclName: TokenSyntax {
    identifier.declNameOrVarCallName
  }

  /// ``identifier`` escaped as an argument label name suitable for declaration sites.
  var labelDeclName: TokenSyntax {
    identifier.nonVarCallNameOrLabelDeclName
  }

  /// ``identifier`` escaped as a variable name suitable for declaration sites.
  var varDeclName: TokenSyntax {
    identifier.declNameOrVarCallName
  }
}