File: LifetimeTracker.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 (60 lines) | stat: -rw-r--r-- 2,025 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

/// Tracks the life times of `LifetimeTracked` instances, providing a method
/// to validate checkpoints where no instances should exist.
///
/// - Note: `LifetimeTracker` is not designed for multithreaded use. Trying to
///     instantiate or deinitialize instances belonging to the same tracker
///     from multiple concurrent threads (or reentrantly) will lead to
///     exclusivity violations and therefore undefined behavior.
public class LifetimeTracker {
  public internal(set) var instances = 0
  var _nextSerialNumber = 0

  public init() {}

  deinit {
    check()
  }

  public func check(file: StaticString = #file, line: UInt = #line) {
    expectEqual(instances, 0,
                "Potential leak of \(instances) objects",
                file: file, line: line)
  }

  public func instance<Payload>(for payload: Payload) -> LifetimeTracked<Payload> {
    LifetimeTracked(payload, for: self)
  }

  public func instances<S: Sequence>(for items: S) -> [LifetimeTracked<S.Element>] {
    return items.map { LifetimeTracked($0, for: self) }
  }

  public func instances<S: Sequence, T>(
    for items: S, by transform: (S.Element) -> T
  ) -> [LifetimeTracked<T>] {
    items.map { instance(for: transform($0)) }
  }
}

@inlinable
public func withLifetimeTracking<R>(
  file: StaticString = #file,
  line: UInt = #line,
  _ body: (LifetimeTracker) throws -> R
) rethrows -> R {
  let tracker = LifetimeTracker()
  defer { tracker.check(file: file, line: line) }
  return try body(tracker)
}