swift-mirror/SwiftCompilerSources/Sources/Basic/SourceLoc.swift

//===--- SourceLoc.swift - SourceLoc bridging utilities ------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2022 - 2025 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 BasicBridging

/// Represents a location in source code.
/// It is basically a pointer into a buffer of the loaded source file (managed by `DiagnosticEngine`).
/// In contrast to just having a filename+line+column, this allows displaying the context around
/// the location when printing diagnostics.
public struct SourceLoc {
  public let bridged: swift.SourceLoc

  public init?(bridged: swift.SourceLoc) {
    guard bridged.isValid() else {
      return nil
    }
    self.bridged = bridged
  }
}

extension Optional<SourceLoc> {
  // TODO: This can go back to being 'bridged' once we upgrade to a toolchain
  // where https://github.com/swiftlang/swift/issues/82609 is fixed.
  public var bridgedLocation: swift.SourceLoc {
    self?.bridged ?? .init()
  }
}

public struct SourceRange {
  public let bridged: swift.SourceRange

  public init(start: SourceLoc?) {
    self.bridged = swift.SourceRange(start: start.bridgedLocation)
  }
}

public struct CharSourceRange {
  public let start: SourceLoc
  public let byteLength: UInt32

  public init(start: SourceLoc, byteLength: UInt32) {
    self.start = start
    self.byteLength = byteLength
  }

  public init?(bridgedStart: swift.SourceLoc, byteLength: UInt32) {
    guard let start = SourceLoc(bridged: bridgedStart) else {
      return nil
    }
    self.init(start: start, byteLength: byteLength)
  }
}