File: LoopProgressCondition.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 (73 lines) | stat: -rw-r--r-- 2,742 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

#if swift(>=6)
@_spi(RawSyntax) internal import SwiftSyntax
#else
@_spi(RawSyntax) import SwiftSyntax
#endif

/// A type that can be used to make sure that a loop in the parser makes process.
///
/// See `TokenConsumer.hasProgressed` for details.
struct LoopProgressCondition {
  var currentToken: Lexer.Lexeme?

  init() {}

  /// Implementation of the above `evaluate` methods.
  fileprivate mutating func evaluate(_ currentToken: Lexer.Lexeme) -> Bool {
    defer {
      self.currentToken = currentToken
    }

    guard let previousToken = self.currentToken else {
      return true
    }
    let hasMadeProgress = currentToken.cursor.hasProgressed(comparedTo: previousToken.cursor)
    assert(hasMadeProgress, "Loop should always make progress")
    return hasMadeProgress
  }
}

// Implementing the extension separately on `Parser` and `Parser.Lookahead` is
// ~1.5% faster than implementing it on `TokenConsumer`.

extension Parser {
  /// Check that the token consumer has made progress since `hasProgress` was
  /// called the last time with this `loopProgress`.
  ///
  /// In assert builds, this traps if the loop has not made any parser progress
  /// in between two iterations, ie. it checks if the parser's `currentToken`
  /// has changed in between two calls to `evaluate`.
  /// In non-assert builds, `evaluate()` returns `false` if the loop has not made
  /// progress, thus aborting the loop.
  @inline(__always)
  func hasProgressed(_ loopProgress: inout LoopProgressCondition) -> Bool {
    return loopProgress.evaluate(self.currentToken)
  }
}

extension Parser.Lookahead {
  /// Check that the token consumer has made progress since `hasProgress` was
  /// called the last time with this `loopProgress`.
  ///
  /// In assert builds, this traps if the loop has not made any parser progress
  /// in between two iterations, ie. it checks if the parser's `currentToken`
  /// has changed in between two calls to `evaluate`.
  /// In non-assert builds, `evaluate()` returns `false` if the loop has not made
  /// progress, thus aborting the loop.
  @inline(__always)
  func hasProgressed(_ loopProgress: inout LoopProgressCondition) -> Bool {
    return loopProgress.evaluate(self.currentToken)
  }
}