File: Utils.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 (82 lines) | stat: -rw-r--r-- 2,580 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 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

/// Lowercases the first word in the provided camelCase or PascalCase string.
/// EOF -> eof
/// IfKeyword -> ifKeyword
/// EOFToken -> eofToken
public func lowercaseFirstWord(name: String) -> String {
  var wordIndex = 0
  let thresholdIndex = 1

  for c in name {
    if c.isLowercase {
      if wordIndex > thresholdIndex {
        wordIndex -= 1
      }
      break

    }
    wordIndex += 1
  }

  if wordIndex == 0 {
    return name
  }

  return name.prefix(wordIndex).lowercased() + name[name.index(name.startIndex, offsetBy: wordIndex)..<name.endIndex]
}

// Helpers to create trivia pieces
extension SwiftSyntax.Trivia {
  /// Make a new trivia from a (possibly multi-line) string, prepending `///`
  /// to each line and creating a `.docLineComment` trivia piece for each line.
  public static func docCommentTrivia(from string: String?) -> Self {
    guard let string else { return [] }
    let lines = string.split(separator: "\n", omittingEmptySubsequences: false).map { "/// \($0)" }
    return .init(pieces: lines.flatMap { [.docLineComment($0), .newlines(1)] })
  }

  /// Make a new trivia by joining together ``SwiftSyntax/TriviaPiece``s from `joining`,
  /// and gluing them together with pieces from `separator`.
  public init(
    joining items: [SwiftSyntax.Trivia],
    separator: SwiftSyntax.Trivia = .init(pieces: [.docLineComment("///"), .newlines(1)])
  ) {
    self.init(pieces: items.filter { !$0.isEmpty }.joined(separator: separator))
  }
}

extension Collection {
  /// If the collection contains a single element, return it, otherwise `nil`.
  public var only: Element? {
    if !isEmpty && index(after: startIndex) == endIndex {
      return self.first!
    } else {
      return nil
    }
  }
}

extension TokenSyntax {
  public var backtickedIfNeeded: TokenSyntax {
    if Keyword.allCases.map(\.spec).contains(where: {
      $0.name == self.description && ($0.isLexerClassified || $0.name == "Type" || $0.name == "Protocol")
    }) {
      return "`\(self)`"
    } else {
      return self
    }
  }
}