Copyright	(c) 2015-2016 Galois Inc.
License	BSD3
Maintainer	cryptol@galois.com
Stability	provisional
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Cryptol.Utils.Ident

Contents

Module names
Identifiers
Identifiers for primitives

Description

Synopsis

data ModName
modNameToText :: ModName -> Text
textToModName :: Text -> ModName
modNameChunks :: ModName -> [String]
packModName :: [Text] -> ModName
preludeName :: ModName
preludeReferenceName :: ModName
floatName :: ModName
suiteBName :: ModName
arrayName :: ModName
primeECName :: ModName
interactiveName :: ModName
noModuleName :: ModName
exprModName :: ModName
isParamInstModName :: ModName -> Bool
paramInstModName :: ModName -> ModName
notParamInstModName :: ModName -> ModName
data Ident
packIdent :: String -> Ident
packInfix :: String -> Ident
unpackIdent :: Ident -> String
mkIdent :: Text -> Ident
mkInfix :: Text -> Ident
isInfixIdent :: Ident -> Bool
nullIdent :: Ident -> Bool
identText :: Ident -> Text
modParamIdent :: Ident -> Ident
data PrimIdent = PrimIdent ModName Text
prelPrim :: Text -> PrimIdent
floatPrim :: Text -> PrimIdent
arrayPrim :: Text -> PrimIdent
suiteBPrim :: Text -> PrimIdent
primeECPrim :: Text -> PrimIdent

Module names

data ModName Source #

Module names are just text.

Instances

Instances details

Eq ModName Source #
Instance details Defined in Cryptol.Utils.Ident Methods (==) :: ModName -> ModName -> Bool # (/=) :: ModName -> ModName -> Bool #
Ord ModName Source #
Instance details Defined in Cryptol.Utils.Ident Methods compare :: ModName -> ModName -> Ordering # (<) :: ModName -> ModName -> Bool # (<=) :: ModName -> ModName -> Bool # (>) :: ModName -> ModName -> Bool # (>=) :: ModName -> ModName -> Bool # max :: ModName -> ModName -> ModName # min :: ModName -> ModName -> ModName #
Show ModName Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> ModName -> ShowS # show :: ModName -> String # showList :: [ModName] -> ShowS #
Generic ModName Source #
Instance details Defined in Cryptol.Utils.Ident Associated Types type Rep ModName :: Type -> Type # Methods from :: ModName -> Rep ModName x # to :: Rep ModName x -> ModName #
NFData ModName Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: ModName -> () #
PP ModName Source #
Instance details Defined in Cryptol.Utils.PP Methods ppPrec :: Int -> ModName -> Doc Source #
type Rep ModName Source #
Instance details Defined in Cryptol.Utils.Ident type Rep ModName = D1 ('MetaData "ModName" "Cryptol.Utils.Ident" "cryptol-2.10.0-Bsi6VMfJ6GCFlOdda30jWW" 'False) (C1 ('MetaCons "ModName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

modNameToText :: ModName -> Text Source #

textToModName :: Text -> ModName Source #

modNameChunks :: ModName -> [String] Source #

packModName :: [Text] -> ModName Source #

preludeName :: ModName Source #

preludeReferenceName :: ModName Source #

floatName :: ModName Source #

suiteBName :: ModName Source #

arrayName :: ModName Source #

primeECName :: ModName Source #

interactiveName :: ModName Source #

noModuleName :: ModName Source #

exprModName :: ModName Source #

isParamInstModName :: ModName -> Bool Source #

paramInstModName :: ModName -> ModName Source #

Convert a parameterized module's name to the name of the module containing the same definitions but with explicit parameters on each definition.

notParamInstModName :: ModName -> ModName Source #

Identifiers

data Ident Source #

Identifiers, along with a flag that indicates whether or not they're infix operators. The boolean is present just as cached information from the lexer, and never used during comparisons.

Instances

Instances details

Eq Ident Source #
Instance details Defined in Cryptol.Utils.Ident Methods (==) :: Ident -> Ident -> Bool # (/=) :: Ident -> Ident -> Bool #
Ord Ident Source #
Instance details Defined in Cryptol.Utils.Ident Methods compare :: Ident -> Ident -> Ordering # (<) :: Ident -> Ident -> Bool # (<=) :: Ident -> Ident -> Bool # (>) :: Ident -> Ident -> Bool # (>=) :: Ident -> Ident -> Bool # max :: Ident -> Ident -> Ident # min :: Ident -> Ident -> Ident #
Show Ident Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> Ident -> ShowS # show :: Ident -> String # showList :: [Ident] -> ShowS #
IsString Ident Source #
Instance details Defined in Cryptol.Utils.Ident Methods fromString :: String -> Ident #
Generic Ident Source #
Instance details Defined in Cryptol.Utils.Ident Associated Types type Rep Ident :: Type -> Type # Methods from :: Ident -> Rep Ident x # to :: Rep Ident x -> Ident #
NFData Ident Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: Ident -> () #
PP Ident Source #
Instance details Defined in Cryptol.Utils.PP Methods ppPrec :: Int -> Ident -> Doc Source #
ShowParseable Ident Source #
Instance details Defined in Cryptol.TypeCheck.Parseable Methods showParseable :: Ident -> Doc Source #
type Rep Ident Source #
Instance details Defined in Cryptol.Utils.Ident type Rep Ident = D1 ('MetaData "Ident" "Cryptol.Utils.Ident" "cryptol-2.10.0-Bsi6VMfJ6GCFlOdda30jWW" 'False) (C1 ('MetaCons "Ident" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

packIdent :: String -> Ident Source #

packInfix :: String -> Ident Source #

unpackIdent :: Ident -> String Source #

mkIdent :: Text -> Ident Source #

mkInfix :: Text -> Ident Source #

isInfixIdent :: Ident -> Bool Source #

nullIdent :: Ident -> Bool Source #

identText :: Ident -> Text Source #

modParamIdent :: Ident -> Ident Source #

Identifiers for primitives

data PrimIdent Source #

A way to identify primitives: we used to use just Ident, but this isn't good anymore as now we have primitives in multiple modules. This is used as a key when we need to lookup details about a specific primitive. Also, this is intended to mostly be used internally, so we don't store the fixity flag of the Ident

Constructors

PrimIdent ModName Text

Instances

Instances details

Eq PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident Methods (==) :: PrimIdent -> PrimIdent -> Bool # (/=) :: PrimIdent -> PrimIdent -> Bool #
Ord PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident Methods compare :: PrimIdent -> PrimIdent -> Ordering # (<) :: PrimIdent -> PrimIdent -> Bool # (<=) :: PrimIdent -> PrimIdent -> Bool # (>) :: PrimIdent -> PrimIdent -> Bool # (>=) :: PrimIdent -> PrimIdent -> Bool # max :: PrimIdent -> PrimIdent -> PrimIdent # min :: PrimIdent -> PrimIdent -> PrimIdent #
Show PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> PrimIdent -> ShowS # show :: PrimIdent -> String # showList :: [PrimIdent] -> ShowS #
Generic PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident Associated Types type Rep PrimIdent :: Type -> Type # Methods from :: PrimIdent -> Rep PrimIdent x # to :: Rep PrimIdent x -> PrimIdent #
NFData PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: PrimIdent -> () #
type Rep PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident type Rep PrimIdent = D1 ('MetaData "PrimIdent" "Cryptol.Utils.Ident" "cryptol-2.10.0-Bsi6VMfJ6GCFlOdda30jWW" 'False) (C1 ('MetaCons "PrimIdent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

prelPrim :: Text -> PrimIdent Source #

A shortcut to make (non-infix) primitives in the prelude.

floatPrim :: Text -> PrimIdent Source #

arrayPrim :: Text -> PrimIdent Source #

suiteBPrim :: Text -> PrimIdent Source #

primeECPrim :: Text -> PrimIdent Source #