Language.Haskell.Tools.Refactor

Defines common utilities for using refactorings. Provides an interface for both demo, command line and integrated tools.

Documentation

useDirs :: [FilePath] -> Ghc ()

Use the given source directories

useFlags :: [String] -> Ghc [String]

Set the given flags for the GHC session

initGhcFlags :: Ghc ()

Initialize GHC flags to default values that support refactoring

toFileName :: String -> String -> FilePath

Translates module name and working directory into the name of the file where the given module should be defined

toBootFileName :: String -> String -> FilePath

Translates module name and working directory into the name of the file where the boot module should be defined

loadModule :: String -> String -> Ghc ModSummary

Load the summary of a module given by the working directory and module name.

type TypedModule = Ann Module IdDom SrcTemplateStage

The final version of our AST, with type infromation added

parseTyped :: ModSummary -> Ghc TypedModule

Get the typed representation from a type-correct program.

performCommand

Arguments

:: (HasModuleInfo dom, DomGenerateExports dom, OrganizeImportsDomain dom, DomainRenameDefinition dom, ExtractBindingDomain dom, GenerateSignatureDomain dom)

=> RefactorCommand

-> ModuleDom dom

The module in which the refactoring is performed

-> [ModuleDom dom]

Other modules

-> Ghc (Either String [RefactorChange dom])

Executes a given command on the selected module and given other modules

data RefactorCommand

A refactoring command

Constructors

NoRefactor

OrganizeImports

GenerateExports

GenerateSignature RealSrcSpan

RenameDefinition RealSrcSpan String

ExtractBinding RealSrcSpan String

Instances

Show RefactorCommand

Methods

showsPrec :: Int -> RefactorCommand -> ShowS

show :: RefactorCommand -> String

showList :: [RefactorCommand] -> ShowS

readCommand :: String -> String -> RefactorCommand

analyzeCommand :: String -> String -> [String] -> RefactorCommand

readSrcSpan :: String -> String -> RealSrcSpan

readSrcLoc :: String -> String -> RealSrcLoc

data IsBoot

Constructors

NormalHs

IsHsBoot

Instances

Eq IsBoot

Methods

(==) :: IsBoot -> IsBoot -> Bool

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

Ord IsBoot

Methods

compare :: IsBoot -> IsBoot -> Ordering

(<) :: IsBoot -> IsBoot -> Bool

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

(>) :: IsBoot -> IsBoot -> Bool

(>=) :: IsBoot -> IsBoot -> Bool

max :: IsBoot -> IsBoot -> IsBoot

min :: IsBoot -> IsBoot -> IsBoot

Show IsBoot

Methods

showsPrec :: Int -> IsBoot -> ShowS

show :: IsBoot -> String

showList :: [IsBoot] -> ShowS

tryRefactor :: Refactoring IdDom -> String -> IO ()