96 lines
3.6 KiB
Swift
96 lines
3.6 KiB
Swift
import Foundation
|
|
import SourceKittenFramework
|
|
|
|
/// The placement of a segment of Swift in a collection of source files.
|
|
public struct Location: CustomStringConvertible, Comparable, Codable {
|
|
/// The file path on disk for this location.
|
|
public let file: String?
|
|
/// The line offset in the file for this location. 1-indexed.
|
|
public let line: Int?
|
|
/// The character offset in the file for this location. 1-indexed.
|
|
public let character: Int?
|
|
|
|
/// A lossless printable description of this location.
|
|
public var description: String {
|
|
// Xcode likes warnings and errors in the following format:
|
|
// {full_path_to_file}{:line}{:character}: {error,warning}: {content}
|
|
let fileString: String = file ?? "<nopath>"
|
|
let lineString: String = ":\(line ?? 1)"
|
|
let charString: String = ":\(character ?? 1)"
|
|
return [fileString, lineString, charString].joined()
|
|
}
|
|
|
|
/// The file path for this location relative to the current working directory.
|
|
public var relativeFile: String? {
|
|
return file?.replacingOccurrences(of: FileManager.default.currentDirectoryPath + "/", with: "")
|
|
}
|
|
|
|
/// Creates a `Location` by specifying its properties directly.
|
|
///
|
|
/// - parameter file: The file path on disk for this location.
|
|
/// - parameter line: The line offset in the file for this location. 1-indexed.
|
|
/// - parameter character: The character offset in the file for this location. 1-indexed.
|
|
public init(file: String?, line: Int? = nil, character: Int? = nil) {
|
|
self.file = file
|
|
self.line = line
|
|
self.character = character
|
|
}
|
|
|
|
/// Creates a `Location` based on a `SwiftLintFile` and a byte-offset into the file.
|
|
/// Fails if tthe specified offset was not a valid location in the file.
|
|
///
|
|
/// - parameter file: The file for this location.
|
|
/// - parameter offset: The offset in bytes into the file for this location.
|
|
public init(file: SwiftLintFile, byteOffset offset: Int) {
|
|
self.file = file.path
|
|
if let lineAndCharacter = file.stringView.lineAndCharacter(forByteOffset: offset) {
|
|
line = lineAndCharacter.line
|
|
character = lineAndCharacter.character
|
|
} else {
|
|
line = nil
|
|
character = nil
|
|
}
|
|
}
|
|
|
|
/// Creates a `Location` based on a `SwiftLintFile` and a UTF8 character-offset into the file.
|
|
/// Fails if tthe specified offset was not a valid location in the file.
|
|
///
|
|
/// - parameter file: The file for this location.
|
|
/// - parameter offset: The offset in UTF8 fragments into the file for this location.
|
|
public init(file: SwiftLintFile, characterOffset offset: Int) {
|
|
self.file = file.path
|
|
if let lineAndCharacter = file.stringView.lineAndCharacter(forCharacterOffset: offset) {
|
|
line = lineAndCharacter.line
|
|
character = lineAndCharacter.character
|
|
} else {
|
|
line = nil
|
|
character = nil
|
|
}
|
|
}
|
|
|
|
// MARK: Comparable
|
|
|
|
public static func < (lhs: Location, rhs: Location) -> Bool {
|
|
if lhs.file != rhs.file {
|
|
return lhs.file < rhs.file
|
|
}
|
|
if lhs.line != rhs.line {
|
|
return lhs.line < rhs.line
|
|
}
|
|
return lhs.character < rhs.character
|
|
}
|
|
}
|
|
|
|
private extension Optional where Wrapped: Comparable {
|
|
static func < (lhs: Optional, rhs: Optional) -> Bool {
|
|
switch (lhs, rhs) {
|
|
case let (lhs?, rhs?):
|
|
return lhs < rhs
|
|
case (nil, _?):
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
}
|