Ghcitui.Loc

Code locations within a file

data SourceRange

Represents a multi-line range from one character to another in a source file.

Constructors

SourceRange

Fields

• startLine :: !(Maybe Int)

  Start of the source range, inclusive.

• startCol :: !(Maybe Int)

  Start column of the source range, inclusive.

• endLine :: !(Maybe Int)

  End of the source range, inclusive.

• endCol :: !(Maybe Int)

  End column of the source range, EXCLUSIVE.

Instances

Show SourceRange

Defined in Ghcitui.Loc

Methods

showsPrec :: Int -> SourceRange -> ShowS

show :: SourceRange -> String

showList :: [SourceRange] -> ShowS

Eq SourceRange

Defined in Ghcitui.Loc

Methods

(==) :: SourceRange -> SourceRange -> Bool

(/=) :: SourceRange -> SourceRange -> Bool

Ord SourceRange

Defined in Ghcitui.Loc

Methods

compare :: SourceRange -> SourceRange -> Ordering

(<) :: SourceRange -> SourceRange -> Bool

(<=) :: SourceRange -> SourceRange -> Bool

(>) :: SourceRange -> SourceRange -> Bool

(>=) :: SourceRange -> SourceRange -> Bool

max :: SourceRange -> SourceRange -> SourceRange

min :: SourceRange -> SourceRange -> SourceRange

class HasSourceRange a where

Methods

sourceRange :: a -> SourceRange

Retrieve the source range from this source location.

Instances

HasSourceRange FileLoc

Defined in Ghcitui.Loc

Methods

sourceRange :: FileLoc -> SourceRange

HasSourceRange ModuleLoc

Defined in Ghcitui.Loc

Methods

sourceRange :: ModuleLoc -> SourceRange

unknownSourceRange :: SourceRange

A source range that represents an unknown location.

isLineInside :: SourceRange -> Int -> Bool

Return whether a given line number lies within a given source range.

>>> let sr = (srFromLineNo 1) { endLine = 3 }
>>> isLineInside sr <$> [0, 1, 2, 3, 5]
[False, True, True, True, False]

srFromLineNo :: Int -> SourceRange

Create a source range from a single line number.

singleify :: SourceRange -> Maybe (Int, ColumnRange)

Convert a SourceRange to potentially a single line and ColumnRange.

type ColumnRange = (Maybe Int, Maybe Int)

Range, mapping start to end.

Code in files and modules

GHCi talks about code ranges in both files and modules inconsistently. ModuleLoc and FileLoc are types representing each code range. In general, locations as FileLocs are easier to manage.

data FileLoc

Location in a file (may not have a corresponding module).

Constructors

FileLoc

Fields

• filepath :: !FilePath
• fSourceRange :: !SourceRange

Instances

Show FileLoc

Defined in Ghcitui.Loc

Methods

showsPrec :: Int -> FileLoc -> ShowS

show :: FileLoc -> String

showList :: [FileLoc] -> ShowS

Eq FileLoc

Defined in Ghcitui.Loc

Methods

(==) :: FileLoc -> FileLoc -> Bool

(/=) :: FileLoc -> FileLoc -> Bool

Ord FileLoc

Defined in Ghcitui.Loc

Methods

compare :: FileLoc -> FileLoc -> Ordering

(<) :: FileLoc -> FileLoc -> Bool

(<=) :: FileLoc -> FileLoc -> Bool

(>) :: FileLoc -> FileLoc -> Bool

(>=) :: FileLoc -> FileLoc -> Bool

max :: FileLoc -> FileLoc -> FileLoc

min :: FileLoc -> FileLoc -> FileLoc

HasSourceRange FileLoc

Defined in Ghcitui.Loc

Methods

sourceRange :: FileLoc -> SourceRange

data ModuleLoc

Location in a module (may not have a corresponding source file).

Constructors

ModuleLoc

Fields

• modName :: !Text
• mSourceRange :: !SourceRange

Instances

Show ModuleLoc

Defined in Ghcitui.Loc

Methods

showsPrec :: Int -> ModuleLoc -> ShowS

show :: ModuleLoc -> String

showList :: [ModuleLoc] -> ShowS

Eq ModuleLoc

Defined in Ghcitui.Loc

Methods

(==) :: ModuleLoc -> ModuleLoc -> Bool

(/=) :: ModuleLoc -> ModuleLoc -> Bool

Ord ModuleLoc

Defined in Ghcitui.Loc

Methods

compare :: ModuleLoc -> ModuleLoc -> Ordering

(<) :: ModuleLoc -> ModuleLoc -> Bool

(<=) :: ModuleLoc -> ModuleLoc -> Bool

(>) :: ModuleLoc -> ModuleLoc -> Bool

(>=) :: ModuleLoc -> ModuleLoc -> Bool

max :: ModuleLoc -> ModuleLoc -> ModuleLoc

min :: ModuleLoc -> ModuleLoc -> ModuleLoc

HasSourceRange ModuleLoc

Defined in Ghcitui.Loc

Methods

sourceRange :: ModuleLoc -> SourceRange

toModuleLoc :: ModuleFileMap -> FileLoc -> Maybe ModuleLoc

Convert a FileLoc to a ModuleLoc.

toFileLoc :: ModuleFileMap -> ModuleLoc -> Maybe FileLoc

Convert a ModuleLoc to a FileLoc.

Converting between modules and source files

data ModuleFileMap

Instances

Monoid ModuleFileMap

Defined in Ghcitui.Loc

Methods

mempty :: ModuleFileMap

mappend :: ModuleFileMap -> ModuleFileMap -> ModuleFileMap

mconcat :: [ModuleFileMap] -> ModuleFileMap

Semigroup ModuleFileMap

Defined in Ghcitui.Loc

Methods

(<>) :: ModuleFileMap -> ModuleFileMap -> ModuleFileMap

sconcat :: NonEmpty ModuleFileMap -> ModuleFileMap

stimes :: Integral b => b -> ModuleFileMap -> ModuleFileMap

Show ModuleFileMap

Defined in Ghcitui.Loc

Methods

showsPrec :: Int -> ModuleFileMap -> ShowS

show :: ModuleFileMap -> String

showList :: [ModuleFileMap] -> ShowS

Eq ModuleFileMap

Defined in Ghcitui.Loc

Methods

(==) :: ModuleFileMap -> ModuleFileMap -> Bool

(/=) :: ModuleFileMap -> ModuleFileMap -> Bool

moduleFileMapFromList :: [(Text, FilePath)] -> ModuleFileMap

Create a ModuleFileMap from an association list.

moduleFileMapAssocs :: ModuleFileMap -> [(Text, FilePath)]

Return mappings between a module name and a filepath.

getPathOfModule :: ModuleFileMap -> Text -> Maybe FilePath

Convert a module to a FilePath.

getModuleOfPath :: ModuleFileMap -> FilePath -> Maybe Text

Convert a FilePath to a module name.