Clash.Core.Name

Names

Documentation

data NameSort

Constructors

User

System

Internal

Instances

Eq NameSort

Methods

(==) :: NameSort -> NameSort -> Bool

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

Ord NameSort

Methods

compare :: NameSort -> NameSort -> Ordering

(<) :: NameSort -> NameSort -> Bool

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

(>) :: NameSort -> NameSort -> Bool

(>=) :: NameSort -> NameSort -> Bool

max :: NameSort -> NameSort -> NameSort

min :: NameSort -> NameSort -> NameSort

Show NameSort

Methods

showsPrec :: Int -> NameSort -> ShowS

show :: NameSort -> String

showList :: [NameSort] -> ShowS

Generic NameSort

Associated Types

type Rep NameSort :: * -> *

Methods

from :: NameSort -> Rep NameSort x

to :: Rep NameSort x -> NameSort

Hashable NameSort

Methods

hashWithSalt :: Int -> NameSort -> Int

hash :: NameSort -> Int

NFData NameSort

Methods

rnf :: NameSort -> ()

Alpha NameSort

Methods

aeq' :: AlphaCtx -> NameSort -> NameSort -> Bool

fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> NameSort -> f NameSort

close :: AlphaCtx -> NamePatFind -> NameSort -> NameSort

open :: AlphaCtx -> NthPatFind -> NameSort -> NameSort

isPat :: NameSort -> DisjointSet AnyName

isTerm :: NameSort -> All

isEmbed :: NameSort -> Bool

nthPatFind :: NameSort -> NthPatFind

namePatFind :: NameSort -> NamePatFind

swaps' :: AlphaCtx -> Perm AnyName -> NameSort -> NameSort

lfreshen' :: LFresh m => AlphaCtx -> NameSort -> (NameSort -> Perm AnyName -> m b) -> m b

freshen' :: Fresh m => AlphaCtx -> NameSort -> m (NameSort, Perm AnyName)

acompare' :: AlphaCtx -> NameSort -> NameSort -> Ordering

type Rep NameSort

type Rep NameSort = D1 (MetaData "NameSort" "Clash.Core.Name" "clash-lib-0.99.3-inplace" False) (C1 (MetaCons "User" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "System" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Internal" PrefixI False) (U1 :: * -> *)))

type OccName a = Name a

data Name a

Constructors

Name

Fields

• nameSort :: NameSort
• nameOcc :: OccName a
• nameLoc :: !SrcSpan

Instances

Subst b (Name a)

Methods

isvar :: Name a -> Maybe (SubstName (Name a) b)

isCoerceVar :: Name a -> Maybe (SubstCoerce (Name a) b)

subst :: Name0 b -> b -> Name a -> Name a

substs :: [(Name0 b, b)] -> Name a -> Name a

Eq (Name a)

Methods

(==) :: Name a -> Name a -> Bool

(/=) :: Name a -> Name a -> Bool

Ord (Name a)

Methods

compare :: Name a -> Name a -> Ordering

(<) :: Name a -> Name a -> Bool

(<=) :: Name a -> Name a -> Bool

(>) :: Name a -> Name a -> Bool

(>=) :: Name a -> Name a -> Bool

max :: Name a -> Name a -> Name a

min :: Name a -> Name a -> Name a

Show (Name a)

Methods

showsPrec :: Int -> Name a -> ShowS

show :: Name a -> String

showList :: [Name a] -> ShowS

Generic (Name a)

Associated Types

type Rep (Name a) :: * -> *

Methods

from :: Name a -> Rep (Name a) x

to :: Rep (Name a) x -> Name a

Hashable (Name a)

Methods

hashWithSalt :: Int -> Name a -> Int

hash :: Name a -> Int

NFData (Name a)

Methods

rnf :: Name a -> ()

Typeable a => Alpha (Name a)

Methods

aeq' :: AlphaCtx -> Name a -> Name a -> Bool

fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> Name a -> f (Name a)

close :: AlphaCtx -> NamePatFind -> Name a -> Name a

open :: AlphaCtx -> NthPatFind -> Name a -> Name a

isPat :: Name a -> DisjointSet AnyName

isTerm :: Name a -> All

isEmbed :: Name a -> Bool

nthPatFind :: Name a -> NthPatFind

namePatFind :: Name a -> NamePatFind

swaps' :: AlphaCtx -> Perm AnyName -> Name a -> Name a

lfreshen' :: LFresh m => AlphaCtx -> Name a -> (Name a -> Perm AnyName -> m b) -> m b

freshen' :: Fresh m => AlphaCtx -> Name a -> m (Name a, Perm AnyName)

acompare' :: AlphaCtx -> Name a -> Name a -> Ordering

Pretty (Name a)

Methods

ppr :: LFresh m => Name a -> m Doc

pprPrec :: LFresh m => Rational -> Name a -> m Doc

type Rep (Name a)

type Rep (Name a) = D1 (MetaData "Name" "Clash.Core.Name" "clash-lib-0.99.3-inplace" False) (C1 (MetaCons "Name" PrefixI True) (S1 (MetaSel (Just "nameSort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NameSort) :*: (S1 (MetaSel (Just "nameOcc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (OccName a)) :*: S1 (MetaSel (Just "nameLoc") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SrcSpan))))

name2String :: Name a -> String

name2Integer :: Name a -> Integer

string2OccName :: String -> OccName a

string2SystemName :: String -> Name a

string2InternalName :: String -> Name a

makeOccName :: String -> Integer -> OccName a

makeSystemName :: String -> Integer -> Name a

coerceName :: Name a -> Name b

appendToName :: Name a -> String -> Name a

noSrcSpan :: SrcSpan

Built-in "bad" SrcSpans for common sources of location uncertainty