File: ClosureCompletionFormat.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (68 lines) | stat: -rw-r--r-- 2,353 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) 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
//
//===----------------------------------------------------------------------===//

public import SwiftBasicFormat
public import SwiftSyntax

/// A specialization of `BasicFormat` for closure literals in a code completion
/// context.
///
/// This is more conservative about newline insertion: unless the closure has
/// multiple statements in its body it will not be reformatted to multiple
/// lines.
@_spi(Testing)
public class ClosureCompletionFormat: BasicFormat {
  @_spi(Testing)
  public override func requiresNewline(
    between first: TokenSyntax?,
    and second: TokenSyntax?
  ) -> Bool {
    if let first, isEndOfSmallClosureSignature(first) {
      return false
    } else if let first, isSmallClosureDelimiter(first, kind: \.leftBrace) {
      return false
    } else if let second, isSmallClosureDelimiter(second, kind: \.rightBrace) {
      return false
    } else {
      return super.requiresNewline(between: first, and: second)
    }
  }

  /// Returns `true` if `token` is an opening or closing brace (according to
  /// `kind`) of a closure, and that closure has no more than one statement in
  /// its body.
  private func isSmallClosureDelimiter(
    _ token: TokenSyntax,
    kind: KeyPath<ClosureExprSyntax, TokenSyntax>
  ) -> Bool {
    guard token.keyPathInParent == kind,
      let closure = token.parent?.as(ClosureExprSyntax.self)
    else {
      return false
    }

    return closure.statements.count <= 1
  }

  /// Returns `true` if `token` is the last token in the signature of a closure,
  /// and that closure has no more than one statement in its body.
  private func isEndOfSmallClosureSignature(_ token: TokenSyntax) -> Bool {
    guard
      token.keyPathInParent == \ClosureSignatureSyntax.inKeyword,
      let closure = token.ancestorOrSelf(mapping: { $0.as(ClosureExprSyntax.self) })
    else {
      return false
    }

    return closure.statements.count <= 1
  }
}