Safe Haskell	None
Language	Haskell2010

Development.IDE.Import.DependencyInformation

Synopsis

data DependencyInformation = DependencyInformation {
- depErrorNodes :: !(FilePathIdMap (NonEmpty NodeError))
- depModuleNames :: !(FilePathIdMap ShowableModuleName)
- depModuleDeps :: !(FilePathIdMap FilePathIdSet)
- depPkgDeps :: !(FilePathIdMap (Set InstalledUnitId))
- depPathIdMap :: !PathIdMap
- depBootMap :: !BootIdMap
}
data ModuleImports = ModuleImports {
- moduleImports :: ![(Located ModuleName, Maybe FilePathId)]
- packageImports :: !(Set InstalledUnitId)
}
data RawDependencyInformation = RawDependencyInformation {
- rawImports :: !(FilePathIdMap (Either ModuleParseError ModuleImports))
- rawPathIdMap :: !PathIdMap
- rawBootMap :: !BootIdMap
}
data NodeError
- = PartOfCycle (Located ModuleName) [FilePathId]
- | FailedToLocateImport (Located ModuleName)
- | ParseError ModuleParseError
- | ParentOfErrorNode (Located ModuleName)
data ModuleParseError = ModuleParseError
data TransitiveDependencies = TransitiveDependencies {
- transitiveModuleDeps :: [NormalizedFilePath]
- transitiveNamedModuleDeps :: [NamedModuleDep]
- transitivePkgDeps :: [InstalledUnitId]
}
newtype FilePathId = FilePathId {
- getFilePathId :: Int
}
data NamedModuleDep = NamedModuleDep {
- nmdFilePath :: !NormalizedFilePath
- nmdModuleName :: !ModuleName
- nmdModLocation :: !ModLocation
}
data PathIdMap
emptyPathIdMap :: PathIdMap
getPathId :: ArtifactsLocation -> PathIdMap -> (FilePathId, PathIdMap)
lookupPathToId :: PathIdMap -> NormalizedFilePath -> Maybe FilePathId
insertImport :: FilePathId -> Either ModuleParseError ModuleImports -> RawDependencyInformation -> RawDependencyInformation
pathToId :: PathIdMap -> NormalizedFilePath -> FilePathId
idToPath :: PathIdMap -> FilePathId -> NormalizedFilePath
reachableModules :: DependencyInformation -> [NormalizedFilePath]
processDependencyInformation :: RawDependencyInformation -> DependencyInformation
transitiveDeps :: DependencyInformation -> NormalizedFilePath -> Maybe TransitiveDependencies
type BootIdMap = FilePathIdMap FilePathId
insertBootId :: FilePathId -> FilePathId -> BootIdMap -> BootIdMap

Documentation

data DependencyInformation Source #

Constructors

DependencyInformation

Fields

depErrorNodes :: !(FilePathIdMap (NonEmpty NodeError))
Nodes that cannot be processed correctly.
depModuleNames :: !(FilePathIdMap ShowableModuleName)
depModuleDeps :: !(FilePathIdMap FilePathIdSet)
For a non-error node, this contains the set of module immediate dependencies in the same package.
depPkgDeps :: !(FilePathIdMap (Set InstalledUnitId))
For a non-error node, this contains the set of immediate pkg deps.
depPathIdMap :: !PathIdMap
Map from FilePath to FilePathId
depBootMap :: !BootIdMap
Map from hs-boot file to the corresponding hs file

Instances

Show DependencyInformation Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> DependencyInformation -> ShowS # show :: DependencyInformation -> String # showList :: [DependencyInformation] -> ShowS #
Generic DependencyInformation Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Associated Types type Rep DependencyInformation :: Type -> Type # Methods from :: DependencyInformation -> Rep DependencyInformation x # to :: Rep DependencyInformation x -> DependencyInformation #
NFData DependencyInformation Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: DependencyInformation -> () #
type Rep DependencyInformation Source #
Instance details Defined in Development.IDE.Import.DependencyInformation type Rep DependencyInformation

data ModuleImports Source #

The imports for a given module.

Constructors

ModuleImports
Fields moduleImports :: ![(Located ModuleName, Maybe FilePathId)] Imports of a module in the current package and the file path of that module on disk (if we found it) packageImports :: !(Set InstalledUnitId) Transitive package dependencies unioned for all imports.

Instances

Show ModuleImports Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> ModuleImports -> ShowS # show :: ModuleImports -> String # showList :: [ModuleImports] -> ShowS #

data RawDependencyInformation Source #

Unprocessed results that we find by following imports recursively.

Constructors

RawDependencyInformation
Fields rawImports :: !(FilePathIdMap (Either ModuleParseError ModuleImports)) rawPathIdMap :: !PathIdMap rawBootMap :: !BootIdMap

Instances

Show RawDependencyInformation Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> RawDependencyInformation -> ShowS # show :: RawDependencyInformation -> String # showList :: [RawDependencyInformation] -> ShowS #

data NodeError Source #

An error attached to a node in the dependency graph.

Constructors

PartOfCycle (Located ModuleName) [FilePathId]	This module is part of an import cycle. The module name corresponds to the import that enters the cycle starting from this module. The list of filepaths represents the elements in the cycle in unspecified order.
FailedToLocateImport (Located ModuleName)	This module has an import that couldn’t be located.
ParseError ModuleParseError
ParentOfErrorNode (Located ModuleName)	This module is the parent of a module that cannot be processed (either it cannot be parsed, is part of a cycle or the parent of another error node).

Instances

Show NodeError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> NodeError -> ShowS # show :: NodeError -> String # showList :: [NodeError] -> ShowS #
Generic NodeError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Associated Types type Rep NodeError :: Type -> Type # Methods from :: NodeError -> Rep NodeError x # to :: Rep NodeError x -> NodeError #
NFData NodeError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: NodeError -> () #
type Rep NodeError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation type Rep NodeError = D1 (MetaData "NodeError" "Development.IDE.Import.DependencyInformation" "ghcide-0.3.0-Dfp4umcHt6s1wVYFQXPyfq" False) ((C1 (MetaCons "PartOfCycle" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Located ModuleName)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePathId])) :+: C1 (MetaCons "FailedToLocateImport" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Located ModuleName)))) :+: (C1 (MetaCons "ParseError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParseError)) :+: C1 (MetaCons "ParentOfErrorNode" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Located ModuleName)))))

data ModuleParseError Source #

This does not contain the actual parse error as that is already reported by GetParsedModule.

Constructors

ModuleParseError

Instances

Show ModuleParseError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> ModuleParseError -> ShowS # show :: ModuleParseError -> String # showList :: [ModuleParseError] -> ShowS #
Generic ModuleParseError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Associated Types type Rep ModuleParseError :: Type -> Type # Methods from :: ModuleParseError -> Rep ModuleParseError x # to :: Rep ModuleParseError x -> ModuleParseError #
NFData ModuleParseError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: ModuleParseError -> () #
type Rep ModuleParseError Source #
Instance details Defined in Development.IDE.Import.DependencyInformation type Rep ModuleParseError = D1 (MetaData "ModuleParseError" "Development.IDE.Import.DependencyInformation" "ghcide-0.3.0-Dfp4umcHt6s1wVYFQXPyfq" False) (C1 (MetaCons "ModuleParseError" PrefixI False) (U1 :: Type -> Type))

data TransitiveDependencies Source #

Constructors

TransitiveDependencies
Fields transitiveModuleDeps :: [NormalizedFilePath] Transitive module dependencies in topological order. The module itself is not included. transitiveNamedModuleDeps :: [NamedModuleDep] Transitive module dependencies in topological order. The module itself is not included. transitivePkgDeps :: [InstalledUnitId] Transitive pkg dependencies in unspecified order.

Instances

Eq TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods (==) :: TransitiveDependencies -> TransitiveDependencies -> Bool # (/=) :: TransitiveDependencies -> TransitiveDependencies -> Bool #
Show TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> TransitiveDependencies -> ShowS # show :: TransitiveDependencies -> String # showList :: [TransitiveDependencies] -> ShowS #
Generic TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Associated Types type Rep TransitiveDependencies :: Type -> Type # Methods from :: TransitiveDependencies -> Rep TransitiveDependencies x # to :: Rep TransitiveDependencies x -> TransitiveDependencies #
NFData TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: TransitiveDependencies -> () #
type Rep TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation type Rep TransitiveDependencies = D1 (MetaData "TransitiveDependencies" "Development.IDE.Import.DependencyInformation" "ghcide-0.3.0-Dfp4umcHt6s1wVYFQXPyfq" False) (C1 (MetaCons "TransitiveDependencies" PrefixI True) (S1 (MetaSel (Just "transitiveModuleDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [NormalizedFilePath]) :: (S1 (MetaSel (Just "transitiveNamedModuleDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [NamedModuleDep]) :: S1 (MetaSel (Just "transitivePkgDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [InstalledUnitId]))))

newtype FilePathId Source #

For processing dependency information, we need lots of maps and sets of filepaths. Comparing Strings is really slow, so we work with IntMap/IntSet instead and only convert at the edges.

Constructors

FilePathId
Fields getFilePathId :: Int

Instances

Eq FilePathId Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods (==) :: FilePathId -> FilePathId -> Bool # (/=) :: FilePathId -> FilePathId -> Bool #
Ord FilePathId Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods compare :: FilePathId -> FilePathId -> Ordering # (<) :: FilePathId -> FilePathId -> Bool # (<=) :: FilePathId -> FilePathId -> Bool # (>) :: FilePathId -> FilePathId -> Bool # (>=) :: FilePathId -> FilePathId -> Bool # max :: FilePathId -> FilePathId -> FilePathId # min :: FilePathId -> FilePathId -> FilePathId #
Show FilePathId Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> FilePathId -> ShowS # show :: FilePathId -> String # showList :: [FilePathId] -> ShowS #
NFData FilePathId Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: FilePathId -> () #

data NamedModuleDep Source #

Constructors

NamedModuleDep
Fields nmdFilePath :: !NormalizedFilePath nmdModuleName :: !ModuleName nmdModLocation :: !ModLocation

Instances

Eq NamedModuleDep Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods (==) :: NamedModuleDep -> NamedModuleDep -> Bool # (/=) :: NamedModuleDep -> NamedModuleDep -> Bool #
Show NamedModuleDep Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> NamedModuleDep -> ShowS # show :: NamedModuleDep -> String # showList :: [NamedModuleDep] -> ShowS #
Generic NamedModuleDep Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Associated Types type Rep NamedModuleDep :: Type -> Type # Methods from :: NamedModuleDep -> Rep NamedModuleDep x # to :: Rep NamedModuleDep x -> NamedModuleDep #
NFData NamedModuleDep Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: NamedModuleDep -> () #
type Rep NamedModuleDep Source #
Instance details Defined in Development.IDE.Import.DependencyInformation type Rep NamedModuleDep = D1 (MetaData "NamedModuleDep" "Development.IDE.Import.DependencyInformation" "ghcide-0.3.0-Dfp4umcHt6s1wVYFQXPyfq" False) (C1 (MetaCons "NamedModuleDep" PrefixI True) (S1 (MetaSel (Just "nmdFilePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NormalizedFilePath) :: (S1 (MetaSel (Just "nmdModuleName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ModuleName) :: S1 (MetaSel (Just "nmdModLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ModLocation))))

data PathIdMap Source #

Instances

Show PathIdMap Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> PathIdMap -> ShowS # show :: PathIdMap -> String # showList :: [PathIdMap] -> ShowS #
Generic PathIdMap Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Associated Types type Rep PathIdMap :: Type -> Type # Methods from :: PathIdMap -> Rep PathIdMap x # to :: Rep PathIdMap x -> PathIdMap #
NFData PathIdMap Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: PathIdMap -> () #
type Rep PathIdMap Source #
Instance details Defined in Development.IDE.Import.DependencyInformation type Rep PathIdMap

emptyPathIdMap :: PathIdMap Source #

getPathId :: ArtifactsLocation -> PathIdMap -> (FilePathId, PathIdMap) Source #

lookupPathToId :: PathIdMap -> NormalizedFilePath -> Maybe FilePathId Source #

insertImport :: FilePathId -> Either ModuleParseError ModuleImports -> RawDependencyInformation -> RawDependencyInformation Source #

pathToId :: PathIdMap -> NormalizedFilePath -> FilePathId Source #

idToPath :: PathIdMap -> FilePathId -> NormalizedFilePath Source #

reachableModules :: DependencyInformation -> [NormalizedFilePath] Source #

processDependencyInformation :: RawDependencyInformation -> DependencyInformation Source #

transitiveDeps :: DependencyInformation -> NormalizedFilePath -> Maybe TransitiveDependencies Source #

type BootIdMap = FilePathIdMap FilePathId Source #

insertBootId :: FilePathId -> FilePathId -> BootIdMap -> BootIdMap Source #