Copyright	(C) 2012-2016 University of Twente 2017-2018 Google Inc. 2021 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	None
Language	Haskell2010

Clash.Core.Var

Description

Variables in CoreHW

Synopsis

data Var a
- = TyVar {
  - varName :: !(Name a)
  - varUniq :: !Unique
  - varType :: Kind
  }
- | Id {
  - varName :: !(Name a)
  - varUniq :: !Unique
  - varType :: Type
  - idScope :: IdScope
  }
data IdScope
- = GlobalId
- | LocalId
type Id = Var Term
type TyVar = Var Type
mkId :: Type -> IdScope -> TmName -> Id
mkLocalId :: Type -> TmName -> Id
mkGlobalId :: Type -> TmName -> Id
mkTyVar :: Kind -> TyName -> TyVar
setIdScope :: IdScope -> Var a -> Var a
modifyVarName :: (Name a -> Name a) -> Var a -> Var a
isGlobalId :: Var a -> Bool
isLocalId :: Var a -> Bool

Documentation

data Var a Source #

Variables in CoreHW

Constructors

TyVar	Constructor for type variables
Fields varName :: !(Name a) varUniq :: !Unique Invariant: forall x . varUniq x ~ nameUniq (varName x) varType :: Kind
Id	Constructor for term variables
Fields varName :: !(Name a) varUniq :: !Unique Invariant: forall x . varUniq x ~ nameUniq (varName x) varType :: Type idScope :: IdScope

Instances

Instances details

Binary (Var a) Source #

Instance details

Defined in Clash.Core.Var

Methods

put :: Var a -> Put

get :: Get (Var a)

putList :: [Var a] -> Put

HasType (Var a) Source #

Instance details

Defined in Clash.Core.HasType

Methods

coreTypeOf :: Var a -> Type Source #

PrettyPrec (Var a) Source #

Instance details

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Var a -> m ClashDoc Source #

pprPrec' :: Monad m => PrettyOptions -> Rational -> Var a -> m ClashDoc Source #

ClashPretty (Var a) Source #

Instance details

Defined in Clash.Core.Pretty

Methods

clashPretty :: Var a -> Doc () Source #

Uniquable (Var a) Source #

Instance details

Defined in Clash.Core.Var

Methods

getUnique :: Var a -> Unique Source #

setUnique :: Var a -> Unique -> Var a Source #

NFData (Var a) Source #

Instance details

Defined in Clash.Core.Var

Methods

rnf :: Var a -> ()

Generic (Var a) Source #

Instance details

Defined in Clash.Core.Var

Associated Types

type Rep (Var a)

Instance details

Defined in Clash.Core.Var

type Rep (Var a) = D1 ('MetaData "Var" "Clash.Core.Var" "clash-lib-1.8.4-LRerWkkgeHOGhsvLM5mWaX" 'False) (C1 ('MetaCons "TyVar" 'PrefixI 'True) (S1 ('MetaSel ('Just "varName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Name a)) :*: (S1 ('MetaSel ('Just "varUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: S1 ('MetaSel ('Just "varType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Kind))) :+: C1 ('MetaCons "Id" 'PrefixI 'True) ((S1 ('MetaSel ('Just "varName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Name a)) :*: S1 ('MetaSel ('Just "varUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique)) :*: (S1 ('MetaSel ('Just "varType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type) :*: S1 ('MetaSel ('Just "idScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IdScope))))

Methods

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

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

Show (Var a) Source #

Instance details

Defined in Clash.Core.Var

Methods

showsPrec :: Int -> Var a -> ShowS #

show :: Var a -> String #

showList :: [Var a] -> ShowS #

Eq (Var a) Source #

Instance details

Defined in Clash.Core.Var

Methods

(==) :: Var a -> Var a -> Bool #

(/=) :: Var a -> Var a -> Bool #

Ord (Var a) Source #

Instance details

Defined in Clash.Core.Var

Methods

compare :: Var a -> Var a -> Ordering #

(<) :: Var a -> Var a -> Bool #

(<=) :: Var a -> Var a -> Bool #

(>) :: Var a -> Var a -> Bool #

(>=) :: Var a -> Var a -> Bool #

max :: Var a -> Var a -> Var a #

min :: Var a -> Var a -> Var a #

Hashable (Var a) Source #

Instance details

Defined in Clash.Core.Var

Methods

hashWithSalt :: Int -> Var a -> Int Source #

hash :: Var a -> Int Source #

PrettyPrec (Id, Term) Source #

Instance details

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> (Id, Term) -> m ClashDoc Source #

pprPrec' :: Monad m => PrettyOptions -> Rational -> (Id, Term) -> m ClashDoc Source #

type Rep (Var a) Source #

Instance details

Defined in Clash.Core.Var

type Rep (Var a) = D1 ('MetaData "Var" "Clash.Core.Var" "clash-lib-1.8.4-LRerWkkgeHOGhsvLM5mWaX" 'False) (C1 ('MetaCons "TyVar" 'PrefixI 'True) (S1 ('MetaSel ('Just "varName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Name a)) :*: (S1 ('MetaSel ('Just "varUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: S1 ('MetaSel ('Just "varType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Kind))) :+: C1 ('MetaCons "Id" 'PrefixI 'True) ((S1 ('MetaSel ('Just "varName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Name a)) :*: S1 ('MetaSel ('Just "varUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique)) :*: (S1 ('MetaSel ('Just "varType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type) :*: S1 ('MetaSel ('Just "idScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IdScope))))

data IdScope Source #

Constructors

GlobalId
LocalId

Instances

Instances details

Binary IdScope Source #

Instance details

Defined in Clash.Core.Var

Methods

put :: IdScope -> Put

get :: Get IdScope

putList :: [IdScope] -> Put

NFData IdScope Source #

Instance details

Defined in Clash.Core.Var

Methods

rnf :: IdScope -> ()

Generic IdScope Source #

Instance details

Defined in Clash.Core.Var

Associated Types

type Rep IdScope
Instance details Defined in Clash.Core.Var type Rep IdScope = D1 ('MetaData "IdScope" "Clash.Core.Var" "clash-lib-1.8.4-LRerWkkgeHOGhsvLM5mWaX" 'False) (C1 ('MetaCons "GlobalId" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LocalId" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: IdScope -> Rep IdScope x

to :: Rep IdScope x -> IdScope

Show IdScope Source #

Instance details

Defined in Clash.Core.Var

Methods

showsPrec :: Int -> IdScope -> ShowS #

show :: IdScope -> String #

showList :: [IdScope] -> ShowS #

Eq IdScope Source #

Instance details

Defined in Clash.Core.Var

Methods

(==) :: IdScope -> IdScope -> Bool #

(/=) :: IdScope -> IdScope -> Bool #

Ord IdScope Source #

Instance details

Defined in Clash.Core.Var

Methods

compare :: IdScope -> IdScope -> Ordering #

(<) :: IdScope -> IdScope -> Bool #

(<=) :: IdScope -> IdScope -> Bool #

(>) :: IdScope -> IdScope -> Bool #

(>=) :: IdScope -> IdScope -> Bool #

max :: IdScope -> IdScope -> IdScope #

min :: IdScope -> IdScope -> IdScope #

Hashable IdScope Source #

Instance details

Defined in Clash.Core.Var

Methods

hashWithSalt :: Int -> IdScope -> Int Source #

hash :: IdScope -> Int Source #

type Rep IdScope Source #

Instance details

Defined in Clash.Core.Var

type Rep IdScope = D1 ('MetaData "IdScope" "Clash.Core.Var" "clash-lib-1.8.4-LRerWkkgeHOGhsvLM5mWaX" 'False) (C1 ('MetaCons "GlobalId" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LocalId" 'PrefixI 'False) (U1 :: Type -> Type))

type Id = Var Term Source #

Term variable

type TyVar = Var Type Source #

Type variable

mkId :: Type -> IdScope -> TmName -> Id Source #

Make a term variable

mkLocalId :: Type -> TmName -> Id Source #

mkGlobalId :: Type -> TmName -> Id Source #

mkTyVar :: Kind -> TyName -> TyVar Source #

Make a type variable

setIdScope :: IdScope -> Var a -> Var a Source #

modifyVarName :: (Name a -> Name a) -> Var a -> Var a Source #

Change the name of a variable

isGlobalId :: Var a -> Bool Source #

isLocalId :: Var a -> Bool Source #