Copyright	(C) 2017 Google Inc.
License	BSD2 (see the file LICENSE)
Maintainer	Christiaan Baaij <christiaan.baaij@gmail.com>
Safe Haskell	Safe-Inferred
Language	Haskell2010

Clash.Core.Name

Description

Names

Synopsis

data Name a = Name {
- nameSort :: NameSort
- nameOcc :: !OccName
- nameUniq :: !Unique
- nameLoc :: !SrcSpan
}
type OccName = Text
data NameSort
- = User
- | System
- | Internal
eqName :: Name a -> Name a -> Bool
ordName :: Name a -> Name a -> Ordering
mkUnsafeInternalName :: Text -> Unique -> Name a
mkUnsafeSystemName :: Text -> Unique -> Name a
appendToName :: Name a -> Text -> Name a
mkUnsafeName :: NameSort -> Text -> Unique -> Name a
noSrcSpan :: SrcSpan

Documentation

data Name a Source #

Constructors

Name
Fields nameSort :: NameSort nameOcc :: !OccName nameUniq :: !Unique nameLoc :: !SrcSpan

Instances

Instances details

Generic (Name a) Source #
Instance details Defined in Clash.Core.Name Associated Types type Rep (Name a) :: Type -> Type # Methods from :: Name a -> Rep (Name a) x # to :: Rep (Name a) x -> Name a #
Show (Name a) Source #
Instance details Defined in Clash.Core.Name Methods showsPrec :: Int -> Name a -> ShowS # show :: Name a -> String # showList :: [Name a] -> ShowS #
Binary (Name a) Source #
Instance details Defined in Clash.Core.Name Methods put :: Name a -> Put # get :: Get (Name a) # putList :: [Name a] -> Put #
PrettyPrec (Name a) Source #
Instance details Defined in Clash.Core.Pretty Methods pprPrec :: Monad m => Rational -> Name a -> m ClashDoc Source # pprPrec' :: Monad m => PrettyOptions -> Rational -> Name a -> m ClashDoc Source #
ClashPretty (Name a) Source #
Instance details Defined in Clash.Core.Pretty Methods clashPretty :: Name a -> Doc () Source #
Uniquable (Name a) Source #
Instance details Defined in Clash.Core.Name Methods getUnique :: Name a -> Unique Source # setUnique :: Name a -> Unique -> Name a Source #
NFData (Name a) Source #
Instance details Defined in Clash.Core.Name Methods rnf :: Name a -> () #
Eq (Name a) Source #	N.B.: Equality checking only compares uniques, which only identify a name within one scope. If you want structural equality, use `eqName`.
Instance details Defined in Clash.Core.Name Methods (==) :: Name a -> Name a -> Bool # (/=) :: Name a -> Name a -> Bool #
Ord (Name a) Source #	N.B.: Comparison only looks at uniques, which only identify a name within one scope. If you want structural comparison, use `ordName`.
Instance details Defined in Clash.Core.Name 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 #
Hashable (Name a) Source #
Instance details Defined in Clash.Core.Name Methods hashWithSalt :: Int -> Name a -> Int # hash :: Name a -> Int #
type Rep (Name a) Source #
Instance details Defined in Clash.Core.Name type Rep (Name a) = D1 ('MetaData "Name" "Clash.Core.Name" "clash-lib-1.11.0-inplace" 'False) (C1 ('MetaCons "Name" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nameSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NameSort) :: S1 ('MetaSel ('Just "nameOcc") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OccName)) :: (S1 ('MetaSel ('Just "nameUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: S1 ('MetaSel ('Just "nameLoc") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SrcSpan))))

type OccName = Text Source #

data NameSort Source #

Constructors

User
System
Internal

Instances

Instances details

Generic NameSort Source #
Instance details Defined in Clash.Core.Name Associated Types type Rep NameSort :: Type -> Type # Methods from :: NameSort -> Rep NameSort x # to :: Rep NameSort x -> NameSort #
Show NameSort Source #
Instance details Defined in Clash.Core.Name Methods showsPrec :: Int -> NameSort -> ShowS # show :: NameSort -> String # showList :: [NameSort] -> ShowS #
Binary NameSort Source #
Instance details Defined in Clash.Core.Name Methods put :: NameSort -> Put # get :: Get NameSort # putList :: [NameSort] -> Put #
NFData NameSort Source #
Instance details Defined in Clash.Core.Name Methods rnf :: NameSort -> () #
Eq NameSort Source #
Instance details Defined in Clash.Core.Name Methods (==) :: NameSort -> NameSort -> Bool # (/=) :: NameSort -> NameSort -> Bool #
Ord NameSort Source #
Instance details Defined in Clash.Core.Name 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 #
Hashable NameSort Source #
Instance details Defined in Clash.Core.Name Methods hashWithSalt :: Int -> NameSort -> Int # hash :: NameSort -> Int #
type Rep NameSort Source #
Instance details Defined in Clash.Core.Name type Rep NameSort = D1 ('MetaData "NameSort" "Clash.Core.Name" "clash-lib-1.11.0-inplace" 'False) (C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "System" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Internal" 'PrefixI 'False) (U1 :: Type -> Type)))

eqName :: Name a -> Name a -> Bool Source #

Structural equality on Names. See ordName.

ordName :: Name a -> Name a -> Ordering Source #

Structural comparison on Names: on top of the Ord instance, which only compares uniques, this compares every other field too.

SrcSpans are compared with leftmost_smallest, which treats all unhelpful spans alike, matching how they are hashed in Clash.Core.Subst.

mkUnsafeInternalName :: Text -> Unique -> Name a Source #

mkUnsafeSystemName :: Text -> Unique -> Name a Source #

appendToName :: Name a -> Text -> Name a Source #

mkUnsafeName :: NameSort -> Text -> Unique -> Name a Source #

noSrcSpan :: SrcSpan #

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