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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2021-2022 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
//
//===----------------------------------------------------------------------===//
extension Source {
/// The location in the input of a parsed entity, presented as a region over the input
public struct Location: Hashable {
public var range: Range<Source.Position>
public var start: Source.Position { range.lowerBound }
/// The open end
public var end: Source.Position { range.upperBound }
public init(_ r: Range<Source.Position>) {
self.range = r
}
public init<R: RangeExpression>(
_ r: R, in input: Source
) where R.Bound == Source.Position {
self.init(r.relative(to: input.input))
}
public init(from sub: Input.SubSequence) {
self.init(sub.startIndex ..< sub.endIndex)
}
/// NOTE: This is a temporary measure to unblock DSL efforts and
/// incremental source location tracking. This shouldn't be called from
/// within the parser's module...
public static var fake: Self {
.init("".startIndex ..< "".startIndex)
}
public var isFake: Bool { self == Self.fake }
public var isReal: Bool { !isFake }
/// Whether this location covers an empty range. This includes `isFake`.
public var isEmpty: Bool { start == end }
/// Returns the smallest location that contains both this location and
/// another.
public func union(with other: Location) -> SourceLocation {
.init(min(start, other.start) ..< max(end, other.end))
}
}
}
public typealias SourceLocation = Source.Location
extension Source {
var currentPosition: Position { bounds.lowerBound }
}
public protocol LocatedErrorProtocol: Error {
var location: SourceLocation { get }
var _typeErasedError: Error { get }
}
extension Source {
/// An error that includes information about the location in source code.
public struct LocatedError<E: Error>: Error, LocatedErrorProtocol {
public let error: E
public let location: SourceLocation
init(_ e: E, _ r: SourceLocation) {
self.error = e
self.location = r
}
public init(_ v: E, _ r: Range<Source.Position>) {
self.error = v
self.location = Location(r)
}
}
/// A value wrapped with a source range.
///
/// Note: Source location is part of value identity so that, for example, the
/// same `Character` value appearing twice can be stored in a data structure
/// distinctly. To ignore source locations, use `.value` directly.
public struct Located<T> {
public var value: T
public var location: SourceLocation
public init(_ v: T, _ r: SourceLocation) {
self.value = v
self.location = r
}
public init(_ v: T, _ r: Range<Source.Position>) {
self.value = v
self.location = Location(r)
}
/// NOTE: This is a temporary measure to unblock DSL efforts and
/// incremental source location tracking. This shouldn't be called from
/// within the parser's module...
public init(faking v: T) {
// TODO: any way to assert or guarantee this is called
// externally?
self.init(v, .fake)
}
public func map<U>(_ fn: (T) throws -> U) rethrows -> Located<U> {
Located<U>(try fn(value), location)
}
}
}
extension AST {
public typealias Located = Source.Located
}
extension AST.Located: Equatable where T: Equatable {}
extension AST.Located: Hashable where T: Hashable {}
extension Source.LocatedError: CustomStringConvertible {
public var description: String {
// Just return the underlying error's description, which is currently how
// we present the message to the compiler.
"\(error)"
}
public var _typeErasedError: Error {
return error
}
}
extension Error {
func addingLocation(_ loc: Range<Source.Position>) -> Error {
// If we're already a LocatedError, don't change the location.
if self is LocatedErrorProtocol {
return self
}
return Source.LocatedError<Self>(self, loc)
}
}
|