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
Namespaces
Original names
Identifiers for primitives

Description

Synopsis

data ModPath
- = TopModule ModName
- | Nested ModPath Ident
apPathRoot :: (ModName -> ModName) -> ModPath -> ModPath
modPathCommon :: ModPath -> ModPath -> Maybe (ModPath, [Ident], [Ident])
modPathIsOrContains :: ModPath -> ModPath -> Bool
topModuleFor :: ModPath -> ModName
modPathSplit :: ModPath -> (ModName, [Ident])
modPathIsNormal :: ModPath -> Bool
data ModName
modNameToText :: ModName -> Text
textToModName :: Text -> ModName
modNameChunks :: ModName -> [String]
modNameChunksText :: ModName -> [Text]
packModName :: [Text] -> ModName
identToModName :: Ident -> ModName
preludeName :: ModName
preludeReferenceName :: ModName
undefinedModName :: ModName
floatName :: ModName
suiteBName :: ModName
arrayName :: ModName
primeECName :: ModName
interactiveName :: ModName
noModuleName :: ModName
exprModName :: ModName
modNameArg :: ModName -> ModName
modNameIfaceMod :: ModName -> ModName
modNameToNormalModName :: ModName -> ModName
modNameIsNormal :: ModName -> Bool
data Ident
packIdent :: String -> Ident
packInfix :: String -> Ident
unpackIdent :: Ident -> String
mkIdent :: Text -> Ident
mkInfix :: Text -> Ident
isInfixIdent :: Ident -> Bool
isUpperIdent :: Ident -> Bool
nullIdent :: Ident -> Bool
identText :: Ident -> Text
modParamIdent :: Ident -> Ident
identAnonArg :: Ident -> Ident
identAnonIfaceMod :: Ident -> Ident
identIsNormal :: Ident -> Bool
data Namespace
- = NSValue
- | NSConstructor
- | NSType
- | NSModule
allNamespaces :: [Namespace]
data OrigName = OrigName {
- ogNamespace :: Namespace
- ogModule :: ModPath
- ogSource :: OrigSource
- ogName :: Ident
- ogFromParam :: !(Maybe Ident)
}
data OrigSource
- = FromDefinition
- | FromFunctorInst
- | FromModParam
ogIsModParam :: OrigName -> Bool
data PrimIdent = PrimIdent ModName Text
prelPrim :: Text -> PrimIdent
floatPrim :: Text -> PrimIdent
arrayPrim :: Text -> PrimIdent
suiteBPrim :: Text -> PrimIdent
primeECPrim :: Text -> PrimIdent

Module names

data ModPath Source #

Idnetifies a possibly nested module

Constructors

TopModule ModName
Nested ModPath Ident

Instances

Instances details

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

apPathRoot :: (ModName -> ModName) -> ModPath -> ModPath Source #

modPathCommon :: ModPath -> ModPath -> Maybe (ModPath, [Ident], [Ident]) Source #

Compute a common prefix between two module paths, if any. This is basically "anti-unification" of the two paths, where we compute the longest common prefix, and the remaining differences for each module.

modPathIsOrContains :: ModPath -> ModPath -> Bool Source #

Does the first module path contain the second? This returns true if the paths are the same.

topModuleFor :: ModPath -> ModName Source #

modPathSplit :: ModPath -> (ModName, [Ident]) Source #

modPathIsNormal :: ModPath -> Bool Source #

data ModName Source #

Top-level Module names are just text.

Instances

Instances details

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 #
Show ModName Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> ModName -> ShowS # show :: ModName -> String # showList :: [ModName] -> ShowS #
PP ModName Source #
Instance details Defined in Cryptol.Utils.PP Methods ppPrec :: Int -> ModName -> Doc Source #
PPName ModName Source #
Instance details Defined in Cryptol.Utils.PP Methods ppNameFixity :: ModName -> Maybe Fixity Source # ppPrefixName :: ModName -> Doc Source # ppInfixName :: ModName -> Doc Source #
NFData ModName Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: ModName -> () #
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 #
type Rep ModName Source #
Instance details Defined in Cryptol.Utils.Ident type Rep ModName

modNameToText :: ModName -> Text Source #

textToModName :: Text -> ModName Source #

Make a normal module name out of text.

modNameChunks :: ModName -> [String] Source #

Break up a module name on the separators, String version

modNameChunksText :: ModName -> [Text] Source #

Break up a module name on the separators, Text version.

packModName :: [Text] -> ModName Source #

identToModName :: Ident -> ModName Source #

preludeName :: ModName Source #

preludeReferenceName :: ModName Source #

undefinedModName :: ModName Source #

floatName :: ModName Source #

suiteBName :: ModName Source #

arrayName :: ModName Source #

primeECName :: ModName Source #

interactiveName :: ModName Source #

noModuleName :: ModName Source #

exprModName :: ModName Source #

modNameArg :: ModName -> ModName Source #

Change a normal module name to a module name to be used for an anonnymous argument.

modNameIfaceMod :: ModName -> ModName Source #

Change a normal module name to a module name to be used for an anonnymous interface.

modNameToNormalModName :: ModName -> ModName Source #

This is used when we check that the name of a module matches the file where it is defined.

modNameIsNormal :: ModName -> Bool Source #

This is useful when we want to hide anonymous modules.

Identifiers

data Ident Source #

The type of identifiers. * The boolean flag indicates whether or not they're infix operators. The boolean is present just as cached information from the lexer, and never used during comparisons. * The MaybeAnon indicates if this is an anonymous name

Instances

Instances details

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 #
Show Ident Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> Ident -> ShowS # show :: Ident -> String # showList :: [Ident] -> ShowS #
ShowParseable Ident Source #
Instance details Defined in Cryptol.TypeCheck.Parseable Methods showParseable :: Ident -> Doc Void Source #
PP Ident Source #
Instance details Defined in Cryptol.Utils.PP Methods ppPrec :: Int -> Ident -> Doc Source #
NFData Ident Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: Ident -> () #
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 #
type Rep Ident Source #
Instance details Defined in Cryptol.Utils.Ident type Rep Ident

packIdent :: String -> Ident Source #

Make a normal (i.e., not anonymous) identifier

packInfix :: String -> Ident Source #

Make a normal (i.e., not anonymous) identifier

unpackIdent :: Ident -> String Source #

mkIdent :: Text -> Ident Source #

Make a normal (i.e., not anonymous) identifier

mkInfix :: Text -> Ident Source #

isInfixIdent :: Ident -> Bool Source #

isUpperIdent :: Ident -> Bool Source #

nullIdent :: Ident -> Bool Source #

identText :: Ident -> Text Source #

modParamIdent :: Ident -> Ident Source #

identAnonArg :: Ident -> Ident Source #

Make an anonymous identifier for the module corresponding to a `where` block in a functor instantiation.

identAnonIfaceMod :: Ident -> Ident Source #

Make an anonymous identifier for the interface corresponding to a parameter declaration.

identIsNormal :: Ident -> Bool Source #

Namespaces

data Namespace Source #

Namespaces for names

Constructors

NSValue
NSConstructor	This is for enum and newtype constructors
NSType
NSModule

Instances

Instances details

Bounded Namespace Source #
Instance details Defined in Cryptol.Utils.Ident Methods minBound :: Namespace # maxBound :: Namespace #
Enum Namespace Source #
Instance details Defined in Cryptol.Utils.Ident Methods succ :: Namespace -> Namespace # pred :: Namespace -> Namespace # toEnum :: Int -> Namespace # fromEnum :: Namespace -> Int # enumFrom :: Namespace -> [Namespace] # enumFromThen :: Namespace -> Namespace -> [Namespace] # enumFromTo :: Namespace -> Namespace -> [Namespace] # enumFromThenTo :: Namespace -> Namespace -> Namespace -> [Namespace] #
Generic Namespace Source #
Instance details Defined in Cryptol.Utils.Ident Associated Types type Rep Namespace :: Type -> Type # Methods from :: Namespace -> Rep Namespace x # to :: Rep Namespace x -> Namespace #
Show Namespace Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> Namespace -> ShowS # show :: Namespace -> String # showList :: [Namespace] -> ShowS #
PP Namespace Source #
Instance details Defined in Cryptol.Utils.PP Methods ppPrec :: Int -> Namespace -> Doc Source #
NFData Namespace Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: Namespace -> () #
Eq Namespace Source #
Instance details Defined in Cryptol.Utils.Ident Methods (==) :: Namespace -> Namespace -> Bool # (/=) :: Namespace -> Namespace -> Bool #
Ord Namespace Source #
Instance details Defined in Cryptol.Utils.Ident Methods compare :: Namespace -> Namespace -> Ordering # (<) :: Namespace -> Namespace -> Bool # (<=) :: Namespace -> Namespace -> Bool # (>) :: Namespace -> Namespace -> Bool # (>=) :: Namespace -> Namespace -> Bool # max :: Namespace -> Namespace -> Namespace # min :: Namespace -> Namespace -> Namespace #
type Rep Namespace Source #
Instance details Defined in Cryptol.Utils.Ident type Rep Namespace = D1 ('MetaData "Namespace" "Cryptol.Utils.Ident" "cryptol-3.1.0-276efOa9Q2aIFSEzDdp2Mp" 'False) ((C1 ('MetaCons "NSValue" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NSConstructor" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NSType" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NSModule" 'PrefixI 'False) (U1 :: Type -> Type)))

allNamespaces :: [Namespace] Source #

Original names

data OrigName Source #

Identifies an entitiy

Constructors

OrigName
Fields ogNamespace :: Namespace ogModule :: ModPath ogSource :: OrigSource ogName :: Ident ogFromParam :: !(Maybe Ident) Does this name come from a module parameter

Instances

Instances details

Generic OrigName Source #
Instance details Defined in Cryptol.Utils.Ident Associated Types type Rep OrigName :: Type -> Type # Methods from :: OrigName -> Rep OrigName x # to :: Rep OrigName x -> OrigName #
Show OrigName Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> OrigName -> ShowS # show :: OrigName -> String # showList :: [OrigName] -> ShowS #
PP OrigName Source #
Instance details Defined in Cryptol.Utils.PP Methods ppPrec :: Int -> OrigName -> Doc Source #
NFData OrigName Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: OrigName -> () #
Eq OrigName Source #
Instance details Defined in Cryptol.Utils.Ident Methods (==) :: OrigName -> OrigName -> Bool # (/=) :: OrigName -> OrigName -> Bool #
Ord OrigName Source #
Instance details Defined in Cryptol.Utils.Ident Methods compare :: OrigName -> OrigName -> Ordering # (<) :: OrigName -> OrigName -> Bool # (<=) :: OrigName -> OrigName -> Bool # (>) :: OrigName -> OrigName -> Bool # (>=) :: OrigName -> OrigName -> Bool # max :: OrigName -> OrigName -> OrigName # min :: OrigName -> OrigName -> OrigName #
type Rep OrigName Source #
Instance details Defined in Cryptol.Utils.Ident type Rep OrigName = D1 ('MetaData "OrigName" "Cryptol.Utils.Ident" "cryptol-3.1.0-276efOa9Q2aIFSEzDdp2Mp" 'False) (C1 ('MetaCons "OrigName" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ogNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace) :: S1 ('MetaSel ('Just "ogModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModPath)) :: (S1 ('MetaSel ('Just "ogSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OrigSource) :: (S1 ('MetaSel ('Just "ogName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Ident) :: S1 ('MetaSel ('Just "ogFromParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Ident))))))

data OrigSource Source #

Describes where a top-level name came from

Constructors

FromDefinition
FromFunctorInst
FromModParam

Instances

Instances details

Generic OrigSource Source #
Instance details Defined in Cryptol.Utils.Ident Associated Types type Rep OrigSource :: Type -> Type # Methods from :: OrigSource -> Rep OrigSource x # to :: Rep OrigSource x -> OrigSource #
Show OrigSource Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> OrigSource -> ShowS # show :: OrigSource -> String # showList :: [OrigSource] -> ShowS #
NFData OrigSource Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: OrigSource -> () #
Eq OrigSource Source #
Instance details Defined in Cryptol.Utils.Ident Methods (==) :: OrigSource -> OrigSource -> Bool # (/=) :: OrigSource -> OrigSource -> Bool #
Ord OrigSource Source #
Instance details Defined in Cryptol.Utils.Ident Methods compare :: OrigSource -> OrigSource -> Ordering # (<) :: OrigSource -> OrigSource -> Bool # (<=) :: OrigSource -> OrigSource -> Bool # (>) :: OrigSource -> OrigSource -> Bool # (>=) :: OrigSource -> OrigSource -> Bool # max :: OrigSource -> OrigSource -> OrigSource # min :: OrigSource -> OrigSource -> OrigSource #
type Rep OrigSource Source #
Instance details Defined in Cryptol.Utils.Ident type Rep OrigSource = D1 ('MetaData "OrigSource" "Cryptol.Utils.Ident" "cryptol-3.1.0-276efOa9Q2aIFSEzDdp2Mp" 'False) (C1 ('MetaCons "FromDefinition" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "FromFunctorInst" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FromModParam" 'PrefixI 'False) (U1 :: Type -> Type)))

ogIsModParam :: OrigName -> Bool Source #

Returns true iff the ogSource of the given OrigName is FromModParam

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

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 #
Show PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident Methods showsPrec :: Int -> PrimIdent -> ShowS # show :: PrimIdent -> String # showList :: [PrimIdent] -> ShowS #
PP PrimIdent Source #
Instance details Defined in Cryptol.Utils.PP Methods ppPrec :: Int -> PrimIdent -> Doc Source #
NFData PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident Methods rnf :: PrimIdent -> () #
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 #
type Rep PrimIdent Source #
Instance details Defined in Cryptol.Utils.Ident type Rep PrimIdent = D1 ('MetaData "PrimIdent" "Cryptol.Utils.Ident" "cryptol-3.1.0-276efOa9Q2aIFSEzDdp2Mp" '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 #