Safe Haskell | None |
---|
This module defines the notion of a scope and operations on scopes.
- data Scope = Scope {}
- data NameSpaceId
- = PrivateNS
- | PublicNS
- | ImportedNS
- | OnlyQualifiedNS
- localNameSpace :: Access -> NameSpaceId
- nameSpaceAccess :: NameSpaceId -> Access
- scopeNameSpace :: NameSpaceId -> Scope -> NameSpace
- data ScopeInfo = ScopeInfo {}
- type LocalVars = [(Name, Name)]
- modifyScopeLocals :: (LocalVars -> LocalVars) -> ScopeInfo -> ScopeInfo
- setScopeLocals :: LocalVars -> ScopeInfo -> ScopeInfo
- data NameSpace = NameSpace {}
- type ThingsInScope a = Map Name [a]
- type NamesInScope = ThingsInScope AbstractName
- type ModulesInScope = ThingsInScope AbstractModule
- data InScopeTag a where
- class Eq a => InScope a where
- inScopeTag :: InScopeTag a
- inNameSpace :: forall a. InScope a => NameSpace -> ThingsInScope a
- data KindOfName
- = ConName
- | FldName
- | DefName
- | PatternSynName
- allKindsOfNames :: [KindOfName]
- data WhyInScope
- data AbstractName = AbsName {}
- data AbstractModule = AbsModule {}
- mergeNames :: Eq a => ThingsInScope a -> ThingsInScope a -> ThingsInScope a
- emptyNameSpace :: NameSpace
- mapNameSpace :: (NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope) -> NameSpace -> NameSpace
- zipNameSpace :: (NamesInScope -> NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope -> ModulesInScope) -> NameSpace -> NameSpace -> NameSpace
- mapNameSpaceM :: Monad m => (NamesInScope -> m NamesInScope) -> (ModulesInScope -> m ModulesInScope) -> NameSpace -> m NameSpace
- emptyScope :: Scope
- emptyScopeInfo :: ScopeInfo
- mapScope :: (NameSpaceId -> NamesInScope -> NamesInScope) -> (NameSpaceId -> ModulesInScope -> ModulesInScope) -> Scope -> Scope
- mapScope_ :: (NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope) -> Scope -> Scope
- mapScopeM :: (Functor m, Monad m) => (NameSpaceId -> NamesInScope -> m NamesInScope) -> (NameSpaceId -> ModulesInScope -> m ModulesInScope) -> Scope -> m Scope
- mapScopeM_ :: (Functor m, Monad m) => (NamesInScope -> m NamesInScope) -> (ModulesInScope -> m ModulesInScope) -> Scope -> m Scope
- zipScope :: (NameSpaceId -> NamesInScope -> NamesInScope -> NamesInScope) -> (NameSpaceId -> ModulesInScope -> ModulesInScope -> ModulesInScope) -> Scope -> Scope -> Scope
- zipScope_ :: (NamesInScope -> NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope -> ModulesInScope) -> Scope -> Scope -> Scope
- filterScope :: (Name -> Bool) -> (Name -> Bool) -> Scope -> Scope
- allNamesInScope :: InScope a => Scope -> ThingsInScope a
- allNamesInScope' :: InScope a => Scope -> ThingsInScope (a, Access)
- exportedNamesInScope :: InScope a => Scope -> ThingsInScope a
- namesInScope :: InScope a => [NameSpaceId] -> Scope -> ThingsInScope a
- allThingsInScope :: Scope -> NameSpace
- thingsInScope :: [NameSpaceId] -> Scope -> NameSpace
- mergeScope :: Scope -> Scope -> Scope
- mergeScopes :: [Scope] -> Scope
- setScopeAccess :: NameSpaceId -> Scope -> Scope
- setNameSpace :: NameSpaceId -> NameSpace -> Scope -> Scope
- addNamesToScope :: NameSpaceId -> Name -> [AbstractName] -> Scope -> Scope
- addNameToScope :: NameSpaceId -> Name -> AbstractName -> Scope -> Scope
- addModuleToScope :: NameSpaceId -> Name -> AbstractModule -> Scope -> Scope
- applyImportDirective :: ImportDirective -> Scope -> Scope
- renameCanonicalNames :: Map QName QName -> Map ModuleName ModuleName -> Scope -> Scope
- restrictPrivate :: Scope -> Scope
- removeOnlyQualified :: Scope -> Scope
- inScopeBecause :: (WhyInScope -> WhyInScope) -> Scope -> Scope
- publicModules :: ScopeInfo -> Map ModuleName Scope
- everythingInScope :: ScopeInfo -> NameSpace
- flattenScope :: [[Name]] -> ScopeInfo -> Map QName [AbstractName]
- scopeLookup :: InScope a => QName -> ScopeInfo -> [a]
- scopeLookup' :: forall a. InScope a => QName -> ScopeInfo -> [(a, Access)]
- inverseScopeLookup :: Either ModuleName QName -> ScopeInfo -> Maybe QName
- inverseScopeLookupName :: QName -> ScopeInfo -> Maybe QName
- inverseScopeLookupModule :: ModuleName -> ScopeInfo -> Maybe QName
- blockOfLines :: String -> [String] -> [String]
Scope representation
A scope is a named collection of names partitioned into public and private names.
Scope | |
|
data NameSpaceId Source
scopeNameSpace :: NameSpaceId -> Scope -> NameSpaceSource
The complete information about the scope at a particular program point includes the scope stack, the local variables, and the context precedence.
modifyScopeLocals :: (LocalVars -> LocalVars) -> ScopeInfo -> ScopeInfoSource
Lens for scopeLocals
.
setScopeLocals :: LocalVars -> ScopeInfo -> ScopeInfoSource
Name spaces
A NameSpace
contains the mappings from concrete names that the user can
write to the abstract fully qualified names that the type checker wants to
read.
NameSpace | |
|
type ThingsInScope a = Map Name [a]Source
data InScopeTag a whereSource
Set of types consisting of exactly AbstractName
and AbstractModule
.
A GADT just for some dependent-types trickery.
inNameSpace :: forall a. InScope a => NameSpace -> ThingsInScope aSource
inNameSpace
selects either the name map or the module name map from
a NameSpace
. What is selected is determined by result type
(using the dependent-type trickery).
Decorated names
data KindOfName Source
For the sake of parsing left-hand sides, we distinguish constructor and record field names from defined names.
ConName | Constructor name. |
FldName | Record field name. |
DefName | Ordinary defined name. |
PatternSynName | Name of a pattern synonym. |
allKindsOfNames :: [KindOfName]Source
A list containing all name kinds.
data WhyInScope Source
Where does a name come from?
This information is solely for reporting to the user,
see whyInScope
.
Defined | Defined in this module. |
Opened QName WhyInScope | Imported from another module. |
Applied QName WhyInScope | Imported by a module application. |
data AbstractName Source
A decoration of QName
.
AbsName | |
|
data AbstractModule Source
A decoration of abstract syntax module names.
AbsModule | |
|
Operations on name and module maps.
mergeNames :: Eq a => ThingsInScope a -> ThingsInScope a -> ThingsInScope aSource
Operations on name spaces
emptyNameSpace :: NameSpaceSource
The empty name space.
mapNameSpace :: (NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope) -> NameSpace -> NameSpaceSource
Map functions over the names and modules in a name space.
zipNameSpace :: (NamesInScope -> NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope -> ModulesInScope) -> NameSpace -> NameSpace -> NameSpaceSource
Zip together two name spaces.
mapNameSpaceM :: Monad m => (NamesInScope -> m NamesInScope) -> (ModulesInScope -> m ModulesInScope) -> NameSpace -> m NameSpaceSource
Map monadic function over a namespace.
General operations on scopes
The empty scope.
emptyScopeInfo :: ScopeInfoSource
The empty scope info.
mapScope :: (NameSpaceId -> NamesInScope -> NamesInScope) -> (NameSpaceId -> ModulesInScope -> ModulesInScope) -> Scope -> ScopeSource
Map functions over the names and modules in a scope.
mapScope_ :: (NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope) -> Scope -> ScopeSource
Same as mapScope
but applies the same function to all name spaces.
mapScopeM :: (Functor m, Monad m) => (NameSpaceId -> NamesInScope -> m NamesInScope) -> (NameSpaceId -> ModulesInScope -> m ModulesInScope) -> Scope -> m ScopeSource
Map monadic functions over the names and modules in a scope.
mapScopeM_ :: (Functor m, Monad m) => (NamesInScope -> m NamesInScope) -> (ModulesInScope -> m ModulesInScope) -> Scope -> m ScopeSource
Same as mapScopeM
but applies the same function to both the public and
private name spaces.
zipScope :: (NameSpaceId -> NamesInScope -> NamesInScope -> NamesInScope) -> (NameSpaceId -> ModulesInScope -> ModulesInScope -> ModulesInScope) -> Scope -> Scope -> ScopeSource
Zip together two scopes. The resulting scope has the same name as the first scope.
zipScope_ :: (NamesInScope -> NamesInScope -> NamesInScope) -> (ModulesInScope -> ModulesInScope -> ModulesInScope) -> Scope -> Scope -> ScopeSource
Same as zipScope
but applies the same function to both the public and
private name spaces.
filterScope :: (Name -> Bool) -> (Name -> Bool) -> Scope -> ScopeSource
Filter a scope keeping only concrete names matching the predicates. The first predicate is applied to the names and the second to the modules.
allNamesInScope :: InScope a => Scope -> ThingsInScope aSource
Return all names in a scope.
allNamesInScope' :: InScope a => Scope -> ThingsInScope (a, Access)Source
exportedNamesInScope :: InScope a => Scope -> ThingsInScope aSource
Returns the scope's non-private names.
namesInScope :: InScope a => [NameSpaceId] -> Scope -> ThingsInScope aSource
thingsInScope :: [NameSpaceId] -> Scope -> NameSpaceSource
mergeScope :: Scope -> Scope -> ScopeSource
Merge two scopes. The result has the name of the first scope.
mergeScopes :: [Scope] -> ScopeSource
Merge a non-empty list of scopes. The result has the name of the first scope in the list.
Specific operations on scopes
setScopeAccess :: NameSpaceId -> Scope -> ScopeSource
Move all names in a scope to the given name space (except never move from Imported to Public).
setNameSpace :: NameSpaceId -> NameSpace -> Scope -> ScopeSource
addNamesToScope :: NameSpaceId -> Name -> [AbstractName] -> Scope -> ScopeSource
Add names to a scope.
addNameToScope :: NameSpaceId -> Name -> AbstractName -> Scope -> ScopeSource
Add a name to a scope.
addModuleToScope :: NameSpaceId -> Name -> AbstractModule -> Scope -> ScopeSource
Add a module to a scope.
applyImportDirective :: ImportDirective -> Scope -> ScopeSource
Apply an ImportDirective
to a scope.
renameCanonicalNames :: Map QName QName -> Map ModuleName ModuleName -> Scope -> ScopeSource
Rename the abstract names in a scope.
restrictPrivate :: Scope -> ScopeSource
Restrict the private name space of a scope
removeOnlyQualified :: Scope -> ScopeSource
Remove names that can only be used qualified (when opening a scope)
inScopeBecause :: (WhyInScope -> WhyInScope) -> Scope -> ScopeSource
Add an explanation to why things are in scope.
publicModules :: ScopeInfo -> Map ModuleName ScopeSource
Get the public parts of the public modules of a scope
flattenScope :: [[Name]] -> ScopeInfo -> Map QName [AbstractName]Source
Compute a flattened scope. Only include unqualified names or names qualified by modules in the first argument.
scopeLookup :: InScope a => QName -> ScopeInfo -> [a]Source
Look up a name in the scope
Inverse look-up
inverseScopeLookup :: Either ModuleName QName -> ScopeInfo -> Maybe QNameSource
Find the shortest concrete name that maps (uniquely) to a given abstract name.
inverseScopeLookupName :: QName -> ScopeInfo -> Maybe QNameSource
Takes the first component of inverseScopeLookup
.
inverseScopeLookupModule :: ModuleName -> ScopeInfo -> Maybe QNameSource
Takes the second component of inverseScopeLookup
.
(Debug) printing
blockOfLines :: String -> [String] -> [String]Source
Add first string only if list is non-empty.