Language.Haskell.Tools.Refactor.GetModules

Representation and operations for module collections (libraries, executables, ...) in the framework.

Documentation

data ModuleCollection

The modules of a library, executable, test or benchmark. A package contains one or more module collection.

Constructors

ModuleCollection

Fields

• _mcId :: ModuleCollectionId
• _mcRoot :: FilePath
• _mcSourceDirs :: [FilePath]
• _mcModules :: Map SourceFileKey ModuleRecord
• _mcFlagSetup :: DynFlags -> IO DynFlags

  Sets up the ghc environment for compiling the modules of this collection

• _mcLoadFlagSetup :: DynFlags -> IO DynFlags

  Sets up the ghc environment for dependency analysis

• _mcDependencies :: [ModuleCollectionId]

Instances

Eq ModuleCollection

Methods

(==) :: ModuleCollection -> ModuleCollection -> Bool

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

Show ModuleCollection

Methods

showsPrec :: Int -> ModuleCollection -> ShowS

show :: ModuleCollection -> String

showList :: [ModuleCollection] -> ShowS

containingMC :: FilePath -> Simple Traversal [ModuleCollection] ModuleCollection

data ModuleRecord

The state of a module.

Constructors

ModuleNotLoaded

Fields

• _recModuleWillNeedCode :: Bool

ModuleParsed

Fields

• _parsedRecModule :: UnnamedModule (Dom RdrName)
• _modRecMS :: ModSummary

ModuleRenamed

Fields

• _renamedRecModule :: UnnamedModule (Dom Name)
• _modRecMS :: ModSummary

ModuleTypeChecked

Fields

• _typedRecModule :: UnnamedModule IdDom
• _modRecMS :: ModSummary

ModuleCodeGenerated

Fields

• _typedRecModule :: UnnamedModule IdDom
• _modRecMS :: ModSummary

Instances

Show ModuleRecord

Methods

showsPrec :: Int -> ModuleRecord -> ShowS

show :: ModuleRecord -> String

showList :: [ModuleRecord] -> ShowS

data ModuleCollectionId

This data structure identifies a module collection.

Constructors

DirectoryMC FilePath

LibraryMC String

ExecutableMC String String

TestSuiteMC String String

BenchmarkMC String String

Instances

Eq ModuleCollectionId

Methods

(==) :: ModuleCollectionId -> ModuleCollectionId -> Bool

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

Ord ModuleCollectionId

Methods

compare :: ModuleCollectionId -> ModuleCollectionId -> Ordering

(<) :: ModuleCollectionId -> ModuleCollectionId -> Bool

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

(>) :: ModuleCollectionId -> ModuleCollectionId -> Bool

(>=) :: ModuleCollectionId -> ModuleCollectionId -> Bool

max :: ModuleCollectionId -> ModuleCollectionId -> ModuleCollectionId

min :: ModuleCollectionId -> ModuleCollectionId -> ModuleCollectionId

Show ModuleCollectionId

Methods

showsPrec :: Int -> ModuleCollectionId -> ShowS

show :: ModuleCollectionId -> String

showList :: [ModuleCollectionId] -> ShowS

moduleCollectionIdString :: ModuleCollectionId -> String

moduleCollectionPkgId :: ModuleCollectionId -> Maybe String

mcSourceDirs :: Lens ModuleCollection ModuleCollection [FilePath] [FilePath]

mcRoot :: Lens ModuleCollection ModuleCollection FilePath FilePath

mcModules :: Lens ModuleCollection ModuleCollection (Map SourceFileKey ModuleRecord) (Map SourceFileKey ModuleRecord)

mcLoadFlagSetup :: Lens ModuleCollection ModuleCollection (DynFlags -> IO DynFlags) (DynFlags -> IO DynFlags)

mcId :: Lens ModuleCollection ModuleCollection ModuleCollectionId ModuleCollectionId

mcFlagSetup :: Lens ModuleCollection ModuleCollection (DynFlags -> IO DynFlags) (DynFlags -> IO DynFlags)

mcDependencies :: Lens ModuleCollection ModuleCollection [ModuleCollectionId] [ModuleCollectionId]

typedRecModule :: Partial ModuleRecord ModuleRecord (UnnamedModule IdDom) (UnnamedModule IdDom)

renamedRecModule :: Partial ModuleRecord ModuleRecord (UnnamedModule (Dom Name)) (UnnamedModule (Dom Name))

recModuleWillNeedCode :: Partial ModuleRecord ModuleRecord Bool Bool

parsedRecModule :: Partial ModuleRecord ModuleRecord (UnnamedModule (Dom RdrName)) (UnnamedModule (Dom RdrName))

modRecMS :: Partial ModuleRecord ModuleRecord ModSummary ModSummary

lookupModuleColl :: String -> [ModuleCollection] -> Maybe ModuleCollection

Find the module collection where the given module is.

lookupModInSCs :: SourceFileKey -> [ModuleCollection] -> Maybe (SourceFileKey, ModuleRecord)

removeModule :: String -> [ModuleCollection] -> [ModuleCollection]

hasGeneratedCode :: SourceFileKey -> [ModuleCollection] -> Bool

needsGeneratedCode :: SourceFileKey -> [ModuleCollection] -> Bool

codeGeneratedFor :: SourceFileKey -> [ModuleCollection] -> [ModuleCollection]

isAlreadyLoaded :: SourceFileKey -> [ModuleCollection] -> Bool

getAllModules :: [FilePath] -> IO [ModuleCollection]

Gets all ModuleCollections from a list of source directories. It also orders the source directories that are package roots so that they can be loaded in the order they are defined (no backward imports). This matters in those cases because for them there can be special compilation flags.

orderMCs :: [ModuleCollection] -> [ModuleCollection]

Sorts model collection in an order to remove all backward references. Works because module collections defined by directories cannot be recursive.

getModules :: FilePath -> IO [ModuleCollection]

Get modules of the project with the indicated root directory. If there is a cabal file, it uses that, otherwise it just scans the directory recursively for haskell sourcefiles. Only returns the non-boot haskell modules, the boot modules will be found during loading.

modulesFromDirectory :: FilePath -> FilePath -> IO [String]

Load the module giving a directory. All modules loaded from the folder and subfolders.

srcDirFromRoot :: FilePath -> String -> FilePath

modulesFromCabalFile :: FilePath -> FilePath -> IO [ModuleCollection]

Load the module using a cabal file. The modules described in the cabal file will be loaded. The flags and extensions set in the cabal file will be used by default.

class ToModuleCollection t where

Minimal complete definition

mkModuleCollKey, getBuildInfo, getModuleNames

Methods

mkModuleCollKey :: PackageName -> t -> ModuleCollectionId

getBuildInfo :: t -> BuildInfo

getModuleNames :: t -> [ModuleName]

Instances

ToModuleCollection Library

Methods

mkModuleCollKey :: PackageName -> Library -> ModuleCollectionId

getBuildInfo :: Library -> BuildInfo

getModuleNames :: Library -> [ModuleName]

ToModuleCollection Executable

Methods

mkModuleCollKey :: PackageName -> Executable -> ModuleCollectionId

getBuildInfo :: Executable -> BuildInfo

getModuleNames :: Executable -> [ModuleName]

ToModuleCollection TestSuite

Methods

mkModuleCollKey :: PackageName -> TestSuite -> ModuleCollectionId

getBuildInfo :: TestSuite -> BuildInfo

getModuleNames :: TestSuite -> [ModuleName]

ToModuleCollection Benchmark

Methods

mkModuleCollKey :: PackageName -> Benchmark -> ModuleCollectionId

getBuildInfo :: Benchmark -> BuildInfo

getModuleNames :: Benchmark -> [ModuleName]

isDirectoryMC :: ModuleCollection -> Bool

compileInContext :: ModuleCollection -> [ModuleCollection] -> DynFlags -> IO DynFlags

applyDependencies :: [ModuleCollection] -> [ModuleCollectionId] -> DynFlags -> DynFlags

onlyUseEnabled :: DynFlags -> DynFlags

dependencyToPkgFlag :: [ModuleCollection] -> ModuleCollectionId -> Maybe PackageFlag

setupLoadFlags :: [ModuleCollection] -> DynFlags -> IO DynFlags

breaks :: [a] -> [(a, [a])]

loadFlagsFromBuildInfo :: BuildInfo -> DynFlags -> IO DynFlags

flagsFromBuildInfo :: BuildInfo -> DynFlags -> IO DynFlags

Not imported from DynFlags.hs, so I copied it here

setExtensionFlag' :: Extension -> DynFlags -> DynFlags

unSetExtensionFlag' :: Extension -> DynFlags -> DynFlags

turnOn :: Bool

turnOff :: Bool

impliedXFlags :: [(Extension, Bool, Extension)]

Mapping of Cabal haskell extensions to their GHC counterpart

translateExtension :: KnownExtension -> Maybe Extension

Map the cabal extensions to the ones that GHC recognizes