Copyright	disco team and contributors
Maintainer	byorgey@gmail.com
Safe Haskell	None
Language	Haskell2010

Disco.Names

Contents

Modules and their provenance
Names and their provenance
Name-related utilities

Description

Names for modules and identifiers.

Synopsis

data ModuleProvenance
- = Dir FilePath
- | Stdlib
data ModuleName
- = REPLModule
- | Named ModuleProvenance String
data NameProvenance
- = LocalName
- | QualifiedName ModuleName
data QName a = QName {
- qnameProvenance :: NameProvenance
- qname :: Name a
}
isFree :: QName a -> Bool
localName :: Name a -> QName a
(.-) :: ModuleName -> Name a -> QName a
fvQ :: (Data t, Typeable e) => Traversal' t (QName e)
substQ :: Subst b a => QName b -> b -> a -> a
substsQ :: Subst b a => [(QName b, b)] -> a -> a

Modules and their provenance

data ModuleProvenance Source #

Where did a module come from?

Constructors

Dir FilePath	From a particular directory (relative to cwd)
Stdlib	From the standard library

Instances

Instances details

Eq ModuleProvenance Source #
Instance details Defined in Disco.Names Methods (==) :: ModuleProvenance -> ModuleProvenance -> Bool # (/=) :: ModuleProvenance -> ModuleProvenance -> Bool #
Data ModuleProvenance Source #
Instance details Defined in Disco.Names Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleProvenance -> c ModuleProvenance # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleProvenance # toConstr :: ModuleProvenance -> Constr # dataTypeOf :: ModuleProvenance -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleProvenance) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleProvenance) # gmapT :: (forall b. Data b => b -> b) -> ModuleProvenance -> ModuleProvenance # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleProvenance -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleProvenance -> r # gmapQ :: (forall d. Data d => d -> u) -> ModuleProvenance -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleProvenance -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleProvenance -> m ModuleProvenance # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleProvenance -> m ModuleProvenance # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleProvenance -> m ModuleProvenance #
Ord ModuleProvenance Source #
Instance details Defined in Disco.Names Methods compare :: ModuleProvenance -> ModuleProvenance -> Ordering # (<) :: ModuleProvenance -> ModuleProvenance -> Bool # (<=) :: ModuleProvenance -> ModuleProvenance -> Bool # (>) :: ModuleProvenance -> ModuleProvenance -> Bool # (>=) :: ModuleProvenance -> ModuleProvenance -> Bool # max :: ModuleProvenance -> ModuleProvenance -> ModuleProvenance # min :: ModuleProvenance -> ModuleProvenance -> ModuleProvenance #
Show ModuleProvenance Source #
Instance details Defined in Disco.Names Methods showsPrec :: Int -> ModuleProvenance -> ShowS # show :: ModuleProvenance -> String # showList :: [ModuleProvenance] -> ShowS #
Generic ModuleProvenance Source #
Instance details Defined in Disco.Names Associated Types type Rep ModuleProvenance :: Type -> Type # Methods from :: ModuleProvenance -> Rep ModuleProvenance x # to :: Rep ModuleProvenance x -> ModuleProvenance #
Alpha ModuleProvenance Source #
Instance details Defined in Disco.Names Methods aeq' :: AlphaCtx -> ModuleProvenance -> ModuleProvenance -> Bool # fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> ModuleProvenance -> f ModuleProvenance # close :: AlphaCtx -> NamePatFind -> ModuleProvenance -> ModuleProvenance # open :: AlphaCtx -> NthPatFind -> ModuleProvenance -> ModuleProvenance # isPat :: ModuleProvenance -> DisjointSet AnyName # isTerm :: ModuleProvenance -> All # isEmbed :: ModuleProvenance -> Bool # nthPatFind :: ModuleProvenance -> NthPatFind # namePatFind :: ModuleProvenance -> NamePatFind # swaps' :: AlphaCtx -> Perm AnyName -> ModuleProvenance -> ModuleProvenance # lfreshen' :: LFresh m => AlphaCtx -> ModuleProvenance -> (ModuleProvenance -> Perm AnyName -> m b) -> m b # freshen' :: Fresh m => AlphaCtx -> ModuleProvenance -> m (ModuleProvenance, Perm AnyName) # acompare' :: AlphaCtx -> ModuleProvenance -> ModuleProvenance -> Ordering #
Subst Type ModuleProvenance Source #
Instance details Defined in Disco.Names Methods isvar :: ModuleProvenance -> Maybe (SubstName ModuleProvenance Type) # isCoerceVar :: ModuleProvenance -> Maybe (SubstCoerce ModuleProvenance Type) # subst :: Name Type -> Type -> ModuleProvenance -> ModuleProvenance # substs :: [(Name Type, Type)] -> ModuleProvenance -> ModuleProvenance #
type Rep ModuleProvenance Source #
Instance details Defined in Disco.Names type Rep ModuleProvenance = D1 ('MetaData "ModuleProvenance" "Disco.Names" "disco-0.1.5-Dj6M4uP9IofLLslCWcCyVQ" 'False) (C1 ('MetaCons "Dir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "Stdlib" 'PrefixI 'False) (U1 :: Type -> Type))

data ModuleName Source #

The name of a module.

Constructors

REPLModule	The special top-level "module" consisting of what has been entered at the REPL.
Named ModuleProvenance String	A named module, with its name and provenance.

Instances

Instances details

Eq ModuleName Source #
Instance details Defined in Disco.Names Methods (==) :: ModuleName -> ModuleName -> Bool # (/=) :: ModuleName -> ModuleName -> Bool #
Data ModuleName Source #
Instance details Defined in Disco.Names Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleName -> c ModuleName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleName # toConstr :: ModuleName -> Constr # dataTypeOf :: ModuleName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleName) # gmapT :: (forall b. Data b => b -> b) -> ModuleName -> ModuleName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQ :: (forall d. Data d => d -> u) -> ModuleName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName #
Ord ModuleName Source #
Instance details Defined in Disco.Names Methods compare :: ModuleName -> ModuleName -> Ordering # (<) :: ModuleName -> ModuleName -> Bool # (<=) :: ModuleName -> ModuleName -> Bool # (>) :: ModuleName -> ModuleName -> Bool # (>=) :: ModuleName -> ModuleName -> Bool # max :: ModuleName -> ModuleName -> ModuleName # min :: ModuleName -> ModuleName -> ModuleName #
Show ModuleName Source #
Instance details Defined in Disco.Names Methods showsPrec :: Int -> ModuleName -> ShowS # show :: ModuleName -> String # showList :: [ModuleName] -> ShowS #
Generic ModuleName Source #
Instance details Defined in Disco.Names Associated Types type Rep ModuleName :: Type -> Type # Methods from :: ModuleName -> Rep ModuleName x # to :: Rep ModuleName x -> ModuleName #
Alpha ModuleName Source #
Instance details Defined in Disco.Names Methods aeq' :: AlphaCtx -> ModuleName -> ModuleName -> Bool # fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> ModuleName -> f ModuleName # close :: AlphaCtx -> NamePatFind -> ModuleName -> ModuleName # open :: AlphaCtx -> NthPatFind -> ModuleName -> ModuleName # isPat :: ModuleName -> DisjointSet AnyName # isTerm :: ModuleName -> All # isEmbed :: ModuleName -> Bool # nthPatFind :: ModuleName -> NthPatFind # namePatFind :: ModuleName -> NamePatFind # swaps' :: AlphaCtx -> Perm AnyName -> ModuleName -> ModuleName # lfreshen' :: LFresh m => AlphaCtx -> ModuleName -> (ModuleName -> Perm AnyName -> m b) -> m b # freshen' :: Fresh m => AlphaCtx -> ModuleName -> m (ModuleName, Perm AnyName) # acompare' :: AlphaCtx -> ModuleName -> ModuleName -> Ordering #
Pretty ModuleName Source #
Instance details Defined in Disco.Names Methods pretty :: forall (r :: EffectRow). Members '[Reader PA, LFresh] r => ModuleName -> Sem r Doc Source #
Subst Type ModuleName Source #
Instance details Defined in Disco.Names Methods isvar :: ModuleName -> Maybe (SubstName ModuleName Type) # isCoerceVar :: ModuleName -> Maybe (SubstCoerce ModuleName Type) # subst :: Name Type -> Type -> ModuleName -> ModuleName # substs :: [(Name Type, Type)] -> ModuleName -> ModuleName #
type Rep ModuleName Source #
Instance details Defined in Disco.Names type Rep ModuleName = D1 ('MetaData "ModuleName" "Disco.Names" "disco-0.1.5-Dj6M4uP9IofLLslCWcCyVQ" 'False) (C1 ('MetaCons "REPLModule" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Named" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleProvenance) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

Names and their provenance

data NameProvenance Source #

Where did a name come from?

Constructors

LocalName	The name is locally bound
QualifiedName ModuleName	The name is exported by the given module

Instances

Instances details

Eq NameProvenance Source #
Instance details Defined in Disco.Names Methods (==) :: NameProvenance -> NameProvenance -> Bool # (/=) :: NameProvenance -> NameProvenance -> Bool #
Data NameProvenance Source #
Instance details Defined in Disco.Names Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NameProvenance -> c NameProvenance # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NameProvenance # toConstr :: NameProvenance -> Constr # dataTypeOf :: NameProvenance -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NameProvenance) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NameProvenance) # gmapT :: (forall b. Data b => b -> b) -> NameProvenance -> NameProvenance # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NameProvenance -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NameProvenance -> r # gmapQ :: (forall d. Data d => d -> u) -> NameProvenance -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> NameProvenance -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NameProvenance -> m NameProvenance # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NameProvenance -> m NameProvenance # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NameProvenance -> m NameProvenance #
Ord NameProvenance Source #
Instance details Defined in Disco.Names Methods compare :: NameProvenance -> NameProvenance -> Ordering # (<) :: NameProvenance -> NameProvenance -> Bool # (<=) :: NameProvenance -> NameProvenance -> Bool # (>) :: NameProvenance -> NameProvenance -> Bool # (>=) :: NameProvenance -> NameProvenance -> Bool # max :: NameProvenance -> NameProvenance -> NameProvenance # min :: NameProvenance -> NameProvenance -> NameProvenance #
Show NameProvenance Source #
Instance details Defined in Disco.Names Methods showsPrec :: Int -> NameProvenance -> ShowS # show :: NameProvenance -> String # showList :: [NameProvenance] -> ShowS #
Generic NameProvenance Source #
Instance details Defined in Disco.Names Associated Types type Rep NameProvenance :: Type -> Type # Methods from :: NameProvenance -> Rep NameProvenance x # to :: Rep NameProvenance x -> NameProvenance #
Alpha NameProvenance Source #
Instance details Defined in Disco.Names Methods aeq' :: AlphaCtx -> NameProvenance -> NameProvenance -> Bool # fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> NameProvenance -> f NameProvenance # close :: AlphaCtx -> NamePatFind -> NameProvenance -> NameProvenance # open :: AlphaCtx -> NthPatFind -> NameProvenance -> NameProvenance # isPat :: NameProvenance -> DisjointSet AnyName # isTerm :: NameProvenance -> All # isEmbed :: NameProvenance -> Bool # nthPatFind :: NameProvenance -> NthPatFind # namePatFind :: NameProvenance -> NamePatFind # swaps' :: AlphaCtx -> Perm AnyName -> NameProvenance -> NameProvenance # lfreshen' :: LFresh m => AlphaCtx -> NameProvenance -> (NameProvenance -> Perm AnyName -> m b) -> m b # freshen' :: Fresh m => AlphaCtx -> NameProvenance -> m (NameProvenance, Perm AnyName) # acompare' :: AlphaCtx -> NameProvenance -> NameProvenance -> Ordering #
Subst Type NameProvenance Source #
Instance details Defined in Disco.Names Methods isvar :: NameProvenance -> Maybe (SubstName NameProvenance Type) # isCoerceVar :: NameProvenance -> Maybe (SubstCoerce NameProvenance Type) # subst :: Name Type -> Type -> NameProvenance -> NameProvenance # substs :: [(Name Type, Type)] -> NameProvenance -> NameProvenance #
type Rep NameProvenance Source #
Instance details Defined in Disco.Names type Rep NameProvenance = D1 ('MetaData "NameProvenance" "Disco.Names" "disco-0.1.5-Dj6M4uP9IofLLslCWcCyVQ" 'False) (C1 ('MetaCons "LocalName" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "QualifiedName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)))

data QName a Source #

A QName, or qualified name, is a Name paired with its NameProvenance.

Constructors

QName
Fields qnameProvenance :: NameProvenance qname :: Name a

Instances

Instances details

Subst Type (QName a) Source #
Instance details Defined in Disco.Names Methods isvar :: QName a -> Maybe (SubstName (QName a) Type) # isCoerceVar :: QName a -> Maybe (SubstCoerce (QName a) Type) # subst :: Name Type -> Type -> QName a -> QName a # substs :: [(Name Type, Type)] -> QName a -> QName a #
Eq (QName a) Source #
Instance details Defined in Disco.Names Methods (==) :: QName a -> QName a -> Bool # (/=) :: QName a -> QName a -> Bool #
Data a => Data (QName a) Source #
Instance details Defined in Disco.Names Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QName a -> c (QName a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (QName a) # toConstr :: QName a -> Constr # dataTypeOf :: QName a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (QName a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (QName a)) # gmapT :: (forall b. Data b => b -> b) -> QName a -> QName a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QName a -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QName a -> r # gmapQ :: (forall d. Data d => d -> u) -> QName a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> QName a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> QName a -> m (QName a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QName a -> m (QName a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QName a -> m (QName a) #
Ord (QName a) Source #
Instance details Defined in Disco.Names Methods compare :: QName a -> QName a -> Ordering # (<) :: QName a -> QName a -> Bool # (<=) :: QName a -> QName a -> Bool # (>) :: QName a -> QName a -> Bool # (>=) :: QName a -> QName a -> Bool # max :: QName a -> QName a -> QName a # min :: QName a -> QName a -> QName a #
Show (QName a) Source #
Instance details Defined in Disco.Names Methods showsPrec :: Int -> QName a -> ShowS # show :: QName a -> String # showList :: [QName a] -> ShowS #
Generic (QName a) Source #
Instance details Defined in Disco.Names Associated Types type Rep (QName a) :: Type -> Type # Methods from :: QName a -> Rep (QName a) x # to :: Rep (QName a) x -> QName a #
Typeable a => Alpha (QName a) Source #
Instance details Defined in Disco.Names Methods aeq' :: AlphaCtx -> QName a -> QName a -> Bool # fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> QName a -> f (QName a) # close :: AlphaCtx -> NamePatFind -> QName a -> QName a # open :: AlphaCtx -> NthPatFind -> QName a -> QName a # isPat :: QName a -> DisjointSet AnyName # isTerm :: QName a -> All # isEmbed :: QName a -> Bool # nthPatFind :: QName a -> NthPatFind # namePatFind :: QName a -> NamePatFind # swaps' :: AlphaCtx -> Perm AnyName -> QName a -> QName a # lfreshen' :: LFresh m => AlphaCtx -> QName a -> (QName a -> Perm AnyName -> m b) -> m b # freshen' :: Fresh m => AlphaCtx -> QName a -> m (QName a, Perm AnyName) # acompare' :: AlphaCtx -> QName a -> QName a -> Ordering #
Pretty (QName a) Source #
Instance details Defined in Disco.Names Methods pretty :: forall (r :: EffectRow). Members '[Reader PA, LFresh] r => QName a -> Sem r Doc Source #
type Rep (QName a) Source #
Instance details Defined in Disco.Names type Rep (QName a) = D1 ('MetaData "QName" "Disco.Names" "disco-0.1.5-Dj6M4uP9IofLLslCWcCyVQ" 'False) (C1 ('MetaCons "QName" 'PrefixI 'True) (S1 ('MetaSel ('Just "qnameProvenance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NameProvenance) :*: S1 ('MetaSel ('Just "qname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Name a))))

isFree :: QName a -> Bool Source #

Does this name correspond to a free variable?

localName :: Name a -> QName a Source #

Create a locally bound qualified name.

(.-) :: ModuleName -> Name a -> QName a Source #

Create a module-bound qualified name.

Name-related utilities

fvQ :: (Data t, Typeable e) => Traversal' t (QName e) Source #

The unbound-generics library gives us free variables for free. But when dealing with typed and desugared ASTs, we want all the free QNames instead of just Names.

substQ :: Subst b a => QName b -> b -> a -> a Source #

substsQ :: Subst b a => [(QName b, b)] -> a -> a Source #