SourceFile Structure Reference


                    
                    
                    storage

The notional stored properties of self; distinguished for encoding/decoding purposes.

Note

the instance is owned by a global dictionary, Storage.allInstances.

Declaration

Swift

private unowned let storage: Storage

Show on GitHub


                    
                    
                    Index

A position in the source text.

Declaration

Swift

public typealias Index = String.Index

Show on GitHub


                    
                    
                    text

The contents of the source file.

Declaration

Swift

public var text: Substring { get }

Show on GitHub

url

The URL of the source file.

Declaration

Swift

public var url: URL { get }

Show on GitHub


                    
                    
                    lineStarts

The start position of each line.

Declaration

Swift

private var lineStarts: [Index] { get }

Show on GitHub


                    
                    
                    init(contentsOf:)

Creates an instance representing the file at filePath.

Declaration

Swift

public init(contentsOf filePath: URL) throws

Show on GitHub


                    
                    
                    init(at:)

Creates an instance representing the file at filePath.

Declaration

Swift

public init(at filePath: String) throws

Show on GitHub


                    
                    
                    init(diagnosableLiteral:swiftFile:startLine:)

Creates an instance for the text given by a multiline string literal in the given swiftFile, the literal’s textual content (the line after the opening quotes) being startLine.

The text of the instance will literally be what’s in the Swift file, including its indentation and any embedded special characters, even if the literal itself is not a raw literal or has had indentation stripped by the Swift compiler.

Declaration

Swift

fileprivate init(
  diagnosableLiteral text: String, swiftFile: String, startLine: Int
) throws

Show on GitHub


                    
                    
                    init(path:)

Creates an instance representing the at filePath.

Declaration

Swift

public init<S>(path filePath: S) throws where S : StringProtocol

Show on GitHub


                    
                    
                    init(synthesizedText:)

Creates a synthetic source file with the specified contents and base name.

Declaration

Swift

public init(synthesizedText text: String)

Show on GitHub


                    
                    
                    baseName

The name of the source file, sans path qualification or extension.

Declaration

Swift

public var baseName: String { get }

Show on GitHub


                    
                    
                    isSynthesized

true if self is synthesized.

Declaration

Swift

public var isSynthesized: Bool { get }

Show on GitHub


                    
                    
                    lineCount

The number of lines in the file.

Declaration

Swift

public var lineCount: Int { get }

Show on GitHub


                    
                    
                    wholeRange

A range covering the whole contents of this instance.

Declaration

Swift

public var wholeRange: SourceRange { get }

Show on GitHub


                    
                    
                    emptyRange(at:)

Returns a range starting and ending at index.

Declaration

Swift

public func emptyRange(at index: String.Index) -> SourceRange

Show on GitHub


                    
                    
                    subscript(_:)

Returns the contents of the file in the specified range.

Requires

The bounds of range are valid positions in self.

Declaration

Swift

public subscript(range: SourceRange) -> Substring { get }

Show on GitHub


                    
                    
                    position(_:)

Returns the position corresponding to i in text.

Requires

i is a valid index in text.

Declaration

Swift

public func position(_ i: Index) -> SourcePosition

Show on GitHub


                    
                    
                    position(before:)

Returns the position immediately before p.

Requires

p is a valid position in self.

Declaration

Swift

public func position(before p: SourcePosition) -> SourcePosition

Show on GitHub


                    
                    
                    position(line:column:)

Returns the position corresponding to the given 1-based line and column indices.

Requires

the line and column exist in self.

Declaration

Swift

public func position(line: Int, column: Int) -> SourcePosition

Show on GitHub


                    
                    
                    range(_:)

Returns the region of self corresponding to r.

Requires

r is a valid range in self.

Declaration

Swift

public func range(_ r: Range<Index>) -> SourceRange

Show on GitHub


                    
                    
                    line(containing:)

Returns the line containing i.

Requires

i is a valid index in contents.

Complexity

O(log N) where N is the number of lines in self.

Declaration

Swift

public func line(containing i: Index) -> SourceLine

Show on GitHub


                    
                    
                    line(_:)

Returns the line at 1-based index lineNumber.

Declaration

Swift

public func line(_ lineNumber: Int) -> SourceLine

Show on GitHub


                    
                    
                    bounds(of:)

The bounds of given line, including any trailing newline.

Declaration

Swift

public func bounds(of line: SourceLine) -> SourceRange

Show on GitHub


                    
                    
                    lineAndColumn(_:)

Returns the 1-based line and column numbers corresponding to i.

Requires

i is a valid index in contents.

Complexity

Declaration

Swift

func lineAndColumn(_ i: Index) -> (line: Int, column: Int)

Show on GitHub


                    
                    
                    index(line:column:)

Returns the index in text corresponding to line and column.

Requires

line and column describe a valid position in self.

Declaration

Swift

func index(line: Int, column: Int) -> Index

Show on GitHub


                    
                    
                    init(stringLiteral:)

Declaration

Swift

public init(stringLiteral text: String)

Show on GitHub


                    
                    
                    hash(into:)

Declaration

Swift

public func hash(into hasher: inout Hasher)

Show on GitHub


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (lhs: SourceFile, rhs: SourceFile) -> Bool

Show on GitHub


                    
                    
                    EncodingState

The state that must be maintained on behalf of SourceFiles while they are encoded.

Declaration

Swift

struct EncodingState : Sendable

Show on GitHub


                    
                    
                    DecodingState

The state that must be maintained on behalf of SourceFiles while they are decoded.

Declaration

Swift

struct DecodingState : Codable

Show on GitHub


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws

Show on GitHub


                    
                    
                    encode(to:)

Declaration

Swift

public func encode(to encoder: Encoder) throws

Show on GitHub


                    
                    
                    description

Declaration

Swift

public var description: String { get }

Show on GitHub


                    
                    
                    Storage

The shared, immutable storage of a SourceFile.

unowned Storage can be used safely anywhere, because every Storage instance is owned by a threadsafe global dictionary, Storage.allInstances, and never deallocated.

Declaration

Swift

public final class Storage : Codable, FactoryInitializable

Show on GitHub