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

Cryptol.Parser.AST

Contents

Names
Types
Declarations
Interactive
Expressions
Positions
Pretty-printing

Description

Synopsis

data Ident
mkIdent :: Text -> Ident
mkInfix :: Text -> Ident
isInfixIdent :: Ident -> Bool
nullIdent :: Ident -> Bool
identText :: Ident -> Text
data ModName
modRange :: Module name -> Range
data PName
- = UnQual' !Ident !NameSource
- | Qual !ModName !Ident
- | NewName !Pass !Int
getModName :: PName -> Maybe ModName
getIdent :: PName -> Ident
mkUnqual :: Ident -> PName
mkQual :: ModName -> Ident -> PName
data Named a = Named {
- name :: Located Ident
- value :: a
}
data Pass
- = NoPat
- | MonoValues
- | ExpandPropGuards String
data Assoc
- = LeftAssoc
- | RightAssoc
- | NonAssoc
data Schema n = Forall [TParam n] [Prop n] (Type n) (Maybe Range)
data TParam n = TParam {
- tpName :: n
- tpKind :: Maybe Kind
- tpRange :: Maybe Range
}
data Kind
- = KProp
- | KNum
- | KType
- | KFun Kind Kind
data Type n
- = TFun (Type n) (Type n)
- | TSeq (Type n) (Type n)
- | TBit
- | TNum Integer
- | TChar Char
- | TUser (Located n) [Type n]
- | TTyApp [Named (Type n)]
- | TRecord (Rec (Type n))
- | TTuple [Type n]
- | TWild
- | TLocated (Type n) Range
- | TParens (Type n) (Maybe Kind)
- | TInfix (Type n) (Located n) Fixity (Type n)
newtype Prop n = CType (Type n)
tsName :: TySyn name -> Located name
psName :: PropSyn name -> Located name
tsFixity :: TySyn name -> Maybe Fixity
psFixity :: PropSyn name -> Maybe Fixity
type Module = ModuleG ModName
data ModuleG mname name = Module {
- mName :: Located mname
- mDef :: ModuleDefinition name
- mInScope :: NamingEnv
- mDocTop :: Maybe (Located Text)
}
mDecls :: ModuleG mname name -> [TopDecl name]
mImports :: ModuleG mname name -> [Located Import]
mModParams :: ModuleG mname name -> [ModParam name]
mIsFunctor :: ModuleG mname nmae -> Bool
isParamDecl :: TopDecl a -> Bool
data ModuleDefinition name
- = NormalModule [TopDecl name]
- | FunctorInstance (Located (ImpName name)) (ModuleInstanceArgs name) (ModuleInstance name)
- | InterfaceModule (Signature name)
data ModuleInstanceArgs name
- = DefaultInstArg (Located (ModuleInstanceArg name))
- | DefaultInstAnonArg [TopDecl name]
- | NamedInstArgs [ModuleInstanceNamedArg name]
data ModuleInstanceNamedArg name = ModuleInstanceNamedArg (Located Ident) (Located (ModuleInstanceArg name))
data ModuleInstanceArg name
- = ModuleArg (ImpName name)
- | ParameterArg Ident
- | AddParams
type ModuleInstance name = Map name name
emptyModuleInstance :: Ord name => ModuleInstance name
newtype Program name = Program [TopDecl name]
data TopDecl name
- = Decl (TopLevel (Decl name))
- | DPrimType (TopLevel (PrimType name))
- | TDNewtype (TopLevel (Newtype name))
- | TDEnum (TopLevel (EnumDecl name))
- | Include (Located FilePath)
- | DParamDecl Range (Signature name)
- | DModule (TopLevel (NestedModule name))
- | DImport (Located (ImportG (ImpName name)))
- | DModParam (ModParam name)
- | DInterfaceConstraint (Maybe (Located Text)) (Located [Prop name])
data Decl name
- = DSignature [Located name] (Schema name)
- | DFixity !Fixity [Located name]
- | DPragma [Located name] Pragma
- | DBind (Bind name)
- | DRec [Bind name]
- | DPatBind (Pattern name) (Expr name)
- | DType (TySyn name)
- | DProp (PropSyn name)
- | DLocated (Decl name) Range
data Fixity = Fixity {
- fAssoc :: !Assoc
- fLevel :: !Int
}
defaultFixity :: Fixity
data FixityCmp
- = FCError
- | FCLeft
- | FCRight
compareFixity :: Fixity -> Fixity -> FixityCmp
data TySyn n = TySyn (Located n) (Maybe Fixity) [TParam n] (Type n)
data PropSyn n = PropSyn (Located n) (Maybe Fixity) [TParam n] [Prop n]
data Bind name = Bind {
- bName :: Located name
- bParams :: BindParams name
- bDef :: Located (BindDef name)
- bSignature :: Maybe (Located (Schema name))
- bInfix :: Bool
- bFixity :: Maybe Fixity
- bPragmas :: [Pragma]
- bMono :: Bool
- bDoc :: Maybe (Located Text)
- bExport :: !ExportType
}
bindParams :: Bind name -> [Pattern name]
bindHeaderLoc :: Bind name -> Maybe Range
data BindParams name
- = PatternParams [Pattern name]
- | DroppedParams (Maybe Range) Int
dropParams :: BindParams name -> BindParams name
noParams :: BindParams name
data BindDef name
- = DPrim
- | DForeign ForeignMode (Maybe (BindImpl name))
- | DImpl (BindImpl name)
type LBindDef = Located (BindDef PName)
data BindImpl name
- = DExpr (Expr name)
- | DPropGuards [PropGuardCase name]
bindImpl :: Bind name -> Maybe (BindImpl name)
exprDef :: Expr name -> BindDef name
data Pragma
- = PragmaNote String
- | PragmaProperty
data ExportType
- = Public
- | Private
data TopLevel a = TopLevel {
- tlExport :: ExportType
- tlDoc :: Maybe (Located Text)
- tlValue :: a
}
type Import = ImportG ModName
data ImportG mname = Import {
- iModule :: !(Located mname)
- iAs :: Maybe ModName
- iSpec :: Maybe ImportSpec
- iInst :: !(Maybe (ModuleInstanceArgs PName))
- iDoc :: Maybe (Located Text)
}
data ImportSpec
- = Hiding [Ident]
- | Only [Ident]
data ImpName name
- = ImpTop ModName
- | ImpNested name
impNameModPath :: ImpName Name -> ModPath
data Newtype name = Newtype {
- nName :: Located name
- nParams :: [TParam name]
- nConName :: !name
- nBody :: Rec (Type name)
- nDeriving :: [Located name]
}
data EnumDecl name = EnumDecl {
- eName :: Located name
- eParams :: [TParam name]
- eCons :: [TopLevel (EnumCon name)]
- eDeriving :: [Located name]
}
data EnumCon name = EnumCon {
- ecName :: Located name
- ecFields :: [Type name]
}
data PrimType name = PrimType {
- primTName :: Located name
- primTKind :: Located Kind
- primTCts :: ([TParam name], [Prop name])
- primTFixity :: Maybe Fixity
}
data ParameterType name = ParameterType {
- ptName :: Located name
- ptKind :: Kind
- ptDoc :: Maybe (Located Text)
- ptFixity :: Maybe Fixity
- ptNumber :: !Int
}
data ParameterFun name = ParameterFun {
- pfName :: Located name
- pfSchema :: Schema name
- pfDoc :: Maybe (Located Text)
- pfFixity :: Maybe Fixity
}
data ParameterConstraint name = ParameterConstraint {
- pcProps :: [Located (Prop name)]
- pcDoc :: Maybe (Located Text)
}
newtype NestedModule name = NestedModule (ModuleG name name)
data Signature name = Signature {
- sigImports :: ![Located (ImportG (ImpName name))]
- sigTypeParams :: [ParameterType name]
- sigConstraints :: [Located (Prop name)]
- sigDecls :: [SigDecl name]
- sigFunParams :: [ParameterFun name]
}
data SigDecl name
- = SigTySyn (TySyn name) (Maybe Text)
- | SigPropSyn (PropSyn name) (Maybe Text)
data ModParam name = ModParam {
- mpSignature :: Located (ImpName name)
- mpAs :: Maybe ModName
- mpName :: !Ident
- mpDoc :: Maybe (Located Text)
- mpRenaming :: !(Map name name)
}
data ParamDecl name
- = DParameterType (ParameterType name)
- | DParameterFun (ParameterFun name)
- | DParameterDecl (SigDecl name)
- | DParameterConstraint (ParameterConstraint name)
data PropGuardCase name = PropGuardCase {
- pgcProps :: [Located (Prop name)]
- pgcExpr :: Expr name
}
data ForeignMode
- = ForeignC
- | ForeignAbstract
data ReplInput name
- = ExprInput (Expr name)
- | LetInput [Decl name]
- | EmptyInput
data Expr n
- = EVar n
- | ELit Literal
- | EGenerate (Expr n)
- | ETuple [Expr n]
- | ERecord (Rec (Expr n))
- | ESel (Expr n) Selector
- | EUpd (Maybe (Expr n)) [UpdField n]
- | EList [Expr n]
- | EFromTo (Type n) (Maybe (Type n)) (Type n) (Maybe (Type n))
- | EFromToBy Bool (Type n) (Type n) (Type n) (Maybe (Type n))
- | EFromToDownBy Bool (Type n) (Type n) (Type n) (Maybe (Type n))
- | EFromToLessThan (Type n) (Type n) (Maybe (Type n))
- | EInfFrom (Expr n) (Maybe (Expr n))
- | EComp (Expr n) [[Match n]]
- | EApp (Expr n) (Expr n)
- | EAppT (Expr n) [TypeInst n]
- | EIf (Expr n) (Expr n) (Expr n)
- | ECase (Expr n) [CaseAlt n]
- | EWhere (Expr n) [Decl n]
- | ETyped (Expr n) (Type n)
- | ETypeVal (Type n)
- | EFun (FunDesc n) [Pattern n] (Expr n)
- | ELocated (Expr n) Range
- | ESplit (Expr n)
- | EParens (Expr n)
- | EInfix (Expr n) (Located n) Fixity (Expr n)
- | EPrefix PrefixOp (Expr n)
data Literal
- = ECNum Integer NumInfo
- | ECChar Char
- | ECFrac Rational FracInfo
- | ECString String
data NumInfo
- = BinLit Text Int
- | OctLit Text Int
- | DecLit Text
- | HexLit Text Int
- | PolyLit Int
data FracInfo
- = BinFrac Text
- | OctFrac Text
- | DecFrac Text
- | HexFrac Text
data Match name
- = Match (Pattern name) (Expr name)
- | MatchLet (Bind name)
data Pattern n
- = PVar (Located n)
- | PWild
- | PTuple [Pattern n]
- | PRecord (Rec (Pattern n))
- | PList [Pattern n]
- | PTyped (Pattern n) (Type n)
- | PSplit (Pattern n) (Pattern n)
- | PCon (Located n) [Pattern n]
- | PLocated (Pattern n) Range
data Selector
- = TupleSel Int (Maybe Int)
- | RecordSel Ident (Maybe [Ident])
- | ListSel Int (Maybe Int)
data CaseAlt n = CaseAlt (Pattern n) (Expr n)
data TypeInst name
- = NamedInst (Named (Type name))
- | PosInst (Type name)
data UpdField n = UpdField UpdHow [Located Selector] (Expr n)
data UpdHow
- = UpdSet
- | UpdFun
data FunDesc n = FunDesc {
- funDescrName :: Maybe n
- funDescrArgOffset :: Int
}
emptyFunDesc :: FunDesc n
data PrefixOp
- = PrefixNeg
- | PrefixComplement
prefixFixity :: PrefixOp -> Fixity
asEApps :: Expr n -> (Expr n, [Expr n])
data Located a = Located {
- srcRange :: !Range
- thing :: !a
}
type LPName = Located PName
type LString = Located String
type LIdent = Located Ident
class NoPos t where
- noPos :: t -> t
cppKind :: Kind -> Doc
ppSelector :: Selector -> Doc

Names

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
Instance details Defined in Cryptol.Utils.Ident type Rep Ident

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 #

ppPrecWithAnnot :: [([Int], PPAnnot)] -> 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

mkIdent :: Text -> Ident Source #

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

mkInfix :: Text -> Ident Source #

isInfixIdent :: Ident -> Bool Source #

nullIdent :: Ident -> Bool Source #

identText :: Ident -> Text 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
Instance details Defined in Cryptol.Utils.Ident type Rep ModName

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 #

ppPrecWithAnnot :: [([Int], PPAnnot)] -> 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

modRange :: Module name -> Range Source #

data PName Source #

Names that originate in the parser. Note here that other kinds of PName do not need this kind of flag because: (1) NewName are generated by the system, so these should never be user visible. (2) Qual names are user names use to refer to imported modules. Should these names names ever be used to refer to system names, then there make be a bug in the renamer that needs to be fixed.

Constructors

UnQual' !Ident !NameSource	Unqualified names like `x`, `Foo`, or `+`.
Qual !ModName !Ident	Qualified names like `Foo::bar` or `module::!`.
NewName !Pass !Int	Fresh names generated by a pass.

Instances

Instances details

Generic PName Source #

Instance details

Defined in Cryptol.Parser.Name

Associated Types

type Rep PName

Instance details

Defined in Cryptol.Parser.Name

type Rep PName = D1 ('MetaData "PName" "Cryptol.Parser.Name" "cryptol-3.5.0-HoSGjqdyafy4TMoEJgOBMg" 'False) (C1 ('MetaCons "UnQual'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Ident) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NameSource)) :+: (C1 ('MetaCons "Qual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ModName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Ident)) :+: C1 ('MetaCons "NewName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pass) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))))

Methods

from :: PName -> Rep PName x #

to :: Rep PName x -> PName #

Show PName Source #

Instance details

Defined in Cryptol.Parser.Name

Methods

showsPrec :: Int -> PName -> ShowS #

show :: PName -> String #

showList :: [PName] -> ShowS #

PP PName Source #

Instance details

Defined in Cryptol.Parser.Name

Methods

ppPrec :: Int -> PName -> Doc Source #

ppPrecWithAnnot :: [([Int], PPAnnot)] -> Int -> PName -> Doc Source #

PPName PName Source #

Instance details

Defined in Cryptol.Parser.Name

Methods

ppNameFixity :: PName -> Maybe Fixity Source #

ppPrefixName :: PName -> Doc Source #

ppInfixName :: PName -> Doc Source #

NFData PName Source #

Instance details

Defined in Cryptol.Parser.Name

Methods

rnf :: PName -> () #

Eq PName Source #

Instance details

Defined in Cryptol.Parser.Name

Methods

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

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

Ord PName Source #

Instance details

Defined in Cryptol.Parser.Name

Methods

compare :: PName -> PName -> Ordering #

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

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

(>) :: PName -> PName -> Bool #

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

max :: PName -> PName -> PName #

min :: PName -> PName -> PName #

BindsNames (InModule (Bind PName)) Source #

Introduce the name

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (Bind PName) -> BuildNamingEnv

BindsNames (InModule (Decl PName)) Source #

The naming environment for a single declaration.

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (Decl PName) -> BuildNamingEnv

BindsNames (InModule (EnumDecl PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (EnumDecl PName) -> BuildNamingEnv

BindsNames (InModule (NestedModule PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (NestedModule PName) -> BuildNamingEnv

BindsNames (InModule (Newtype PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (Newtype PName) -> BuildNamingEnv

BindsNames (InModule (ParameterFun PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (ParameterFun PName) -> BuildNamingEnv

BindsNames (InModule (ParameterType PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (ParameterType PName) -> BuildNamingEnv

BindsNames (InModule (PrimType PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (PrimType PName) -> BuildNamingEnv

BindsNames (InModule (SigDecl PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (SigDecl PName) -> BuildNamingEnv

BindsNames (InModule (TopDecl PName)) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: InModule (TopDecl PName) -> BuildNamingEnv

BindsNames (Pattern PName) Source #

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: Pattern PName -> BuildNamingEnv

BindsNames (Schema PName) Source #

Generate a type renaming environment from the parameters that are bound by this schema.

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: Schema PName -> BuildNamingEnv

BindsNames (TParam PName) Source #

Generate the naming environment for a type parameter.

Instance details

Defined in Cryptol.ModuleSystem.Binds

Methods

namingEnv :: TParam PName -> BuildNamingEnv

RemovePatterns (Expr PName) Source #

Instance details

Defined in Cryptol.Parser.NoPat

Methods

removePatterns :: Expr PName -> (Expr PName, [Error]) Source #

RemovePatterns (NestedModule PName) Source #

Instance details

Defined in Cryptol.Parser.NoPat

Methods

removePatterns :: NestedModule PName -> (NestedModule PName, [Error]) Source #

RemovePatterns (Program PName) Source #

Instance details

Defined in Cryptol.Parser.NoPat

Methods

removePatterns :: Program PName -> (Program PName, [Error]) Source #

RemovePatterns [Decl PName] Source #

Instance details

Defined in Cryptol.Parser.NoPat

Methods

removePatterns :: [Decl PName] -> ([Decl PName], [Error]) Source #

RemovePatterns (ModuleG mname PName) Source #

Instance details

Defined in Cryptol.Parser.NoPat

Methods

removePatterns :: ModuleG mname PName -> (ModuleG mname PName, [Error]) Source #

type Rep PName Source #

Instance details

Defined in Cryptol.Parser.Name

type Rep PName = D1 ('MetaData "PName" "Cryptol.Parser.Name" "cryptol-3.5.0-HoSGjqdyafy4TMoEJgOBMg" 'False) (C1 ('MetaCons "UnQual'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Ident) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NameSource)) :+: (C1 ('MetaCons "Qual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ModName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Ident)) :+: C1 ('MetaCons "NewName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pass) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))))

getModName :: PName -> Maybe ModName Source #

getIdent :: PName -> Ident Source #

mkUnqual :: Ident -> PName Source #

mkQual :: ModName -> Ident -> PName Source #

data Named a Source #

Constructors

Named
Fields name :: Located Ident value :: a

Instances

Instances details

Foldable Named Source #

Instance details

TParam
Fields tpName :: n tpKind :: Maybe Kind tpRange :: Maybe Range

TFun (Type n) (Type n)	[8] -> [8]
TSeq (Type n) (Type n)	[8] a
TBit	Bit
TNum Integer	10
TChar Char	`a`
TUser (Located n) [Type n]	A type variable or synonym
TTyApp [Named (Type n)]	`{ x = [8], y = Integer }
TRecord (Rec (Type n))	{ x : [8], y : [32] }
TTuple [Type n]	([8], [32])
TWild	`_`, just some type.
TLocated (Type n) Range	Location information
TParens (Type n) (Maybe Kind)	(ty)
TInfix (Type n) (Located n) Fixity (Type n)	ty + ty

NormalModule [TopDecl name]
FunctorInstance (Located (ImpName name)) (ModuleInstanceArgs name) (ModuleInstance name)	The instance is filled in by the renamer
InterfaceModule (Signature name)

DefaultInstArg (Located (ModuleInstanceArg name))	Single parameter instantitaion
DefaultInstAnonArg [TopDecl name]	Single parameter instantitaion using this anonymous module. (parser only)
NamedInstArgs [ModuleInstanceNamedArg name]

ModuleArg (ImpName name)	An argument that is a module
ParameterArg Ident	An argument that is a parameter
AddParams	Arguments adds extra parameters to decls. ("backtick" import)

Show name => Show (Program name) Source #
Instance details Defined in Cryptol.Parser.AST Methods showsPrec :: Int -> Program name -> ShowS # show :: Program name -> String # showList :: [Program name] -> ShowS #
NoPos (Program name) Source #
Instance details Defined in Cryptol.Parser.AST Methods noPos :: Program name -> Program name Source #
RemovePatterns (Program PName) Source #
Instance details Defined in Cryptol.Parser.NoPat Methods removePatterns :: Program PName -> (Program PName, [Error]) Source #
(Show name, PPName name) => PP (Program name) Source #
Instance details Defined in Cryptol.Parser.AST Methods ppPrec :: Int -> Program name -> Doc Source # ppPrecWithAnnot :: [([Int], PPAnnot)] -> Int -> Program name -> Doc Source #

Decl (TopLevel (Decl name))
DPrimType (TopLevel (PrimType name))
TDNewtype (TopLevel (Newtype name))	@newtype T as = t
TDEnum (TopLevel (EnumDecl name))	enum T as = cons
Include (Located FilePath)	`include File` (until NoInclude)
DParamDecl Range (Signature name)	`parameter ...` (parser only)
DModule (TopLevel (NestedModule name))	submodule M where ...
DImport (Located (ImportG (ImpName name)))	import X
DModParam (ModParam name)	import interface X ...
DInterfaceConstraint (Maybe (Located Text)) (Located [Prop name])	interface constraint

DSignature [Located name] (Schema name)	A type signature. Eliminated in NoPat--after NoPat signatures are in their associated Bind
DFixity !Fixity [Located name]	A fixity declaration. Eliminated in NoPat---after NoPat fixities are in their associated Bind
DPragma [Located name] Pragma	A pragma declaration. Eliminated in NoPat---after NoPat fixities are in their associated Bind
DBind (Bind name)	A non-recursive binding.
DRec [Bind name]	A group of recursive bindings. Introduced by the renamer.
DPatBind (Pattern name) (Expr name)	A pattern binding. Eliminated in NoPat---after NoPat fixities are in their associated Bind
DType (TySyn name)	A type synonym.
DProp (PropSyn name)	A constraint synonym.
DLocated (Decl name) Range	Keeps track of the location of a declaration.

Show FixityCmp Source #
Instance details Defined in Cryptol.Utils.Fixity Methods showsPrec :: Int -> FixityCmp -> ShowS # show :: FixityCmp -> String # showList :: [FixityCmp] -> ShowS #
Eq FixityCmp Source #
Instance details Defined in Cryptol.Utils.Fixity Methods (==) :: FixityCmp -> FixityCmp -> Bool # (/=) :: FixityCmp -> FixityCmp -> Bool #

PatternParams [Pattern name]	Parameters that appear in the LHS of a binding equation as patterns. e.g. `[a,b,c]` in `let f a b c = x -> ...`
DroppedParams (Maybe Range) Int	Represents zero parameters to a binding equation that originally had parameters, but was rewritten to have none (see `NoPat`). Retains the original source range, and number of dropped parameters (see `dropParams`).

DPrim
DForeign ForeignMode (Maybe (BindImpl name))	Foreign functions can have an optional cryptol implementation
DImpl (BindImpl name)

TopLevel
Fields tlExport :: ExportType tlDoc :: Maybe (Located Text) tlValue :: a

Import
Fields iModule :: !(Located mname) iAs :: Maybe ModName iSpec :: Maybe ImportSpec iInst :: !(Maybe (ModuleInstanceArgs PName)) `iInst` exists only during parsing iDoc :: Maybe (Located Text) optional documentation

ImpTop ModName	A top-level module
ImpNested name	The module in scope with the given name

Newtype
Fields nName :: Located name Type name nParams :: [TParam name] Type params nConName :: !name Constructor function name nBody :: Rec (Type name) Body nDeriving :: [Located name] Derived typeclasses

EnumDecl
Fields eName :: Located name Type name eParams :: [TParam name] Type params eCons :: [TopLevel (EnumCon name)] Value constructors eDeriving :: [Located name] Derived typeclasses

EnumCon
Fields ecName :: Located name ecFields :: [Type name]

PrimType
Fields primTName :: Located name primTKind :: Located Kind primTCts :: ([TParam name], [Prop name]) parameters are in the order used by the type constructor. primTFixity :: Maybe Fixity

ParameterType
Fields ptName :: Located name name of type parameter ptKind :: Kind kind of parameter ptDoc :: Maybe (Located Text) optional documentation ptFixity :: Maybe Fixity info for infix use ptNumber :: !Int number of the parameter

ParameterFun
Fields pfName :: Located name name of value parameter pfSchema :: Schema name schema for parameter pfDoc :: Maybe (Located Text) optional documentation pfFixity :: Maybe Fixity info for infix use

Names

Instances

Instances

Instances

Instances

Instances

Instances

Types

Instances

Instances

Instances

Instances

Instances

Declarations

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Interactive

Instances

Expressions

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Positions

Instances

Instances

Pretty-printing

ParameterConstraint
Fields pcProps :: [Located (Prop name)] constraints pcDoc :: Maybe (Located Text) optional documentation

Signature
Fields sigImports :: ![Located (ImportG (ImpName name))] Add things in scope sigTypeParams :: [ParameterType name] Type parameters sigConstraints :: [Located (Prop name)] Constraints on the type parameters and type synonyms. sigDecls :: [SigDecl name] Type and constraint synonyms sigFunParams :: [ParameterFun name] Value parameters

SigTySyn (TySyn name) (Maybe Text)
SigPropSyn (PropSyn name) (Maybe Text)

DParameterType (ParameterType name)	`parameter type T : #` (parser only)
DParameterFun (ParameterFun name)	`parameter someVal : [256]` (parser only)
DParameterDecl (SigDecl name)	A delcaration in an interface
DParameterConstraint (ParameterConstraint name)	parameter type constraint (fin T)

PropGuardCase
Fields pgcProps :: [Located (Prop name)] pgcExpr :: Expr name

ForeignC	Call using C-style marshalling
ForeignAbstract	Call using import/export objects

Show name => Show (ReplInput name) Source #
Instance details Defined in Cryptol.Parser.AST Methods showsPrec :: Int -> ReplInput name -> ShowS # show :: ReplInput name -> String # showList :: [ReplInput name] -> ShowS #
Eq name => Eq (ReplInput name) Source #
Instance details Defined in Cryptol.Parser.AST Methods (==) :: ReplInput name -> ReplInput name -> Bool # (/=) :: ReplInput name -> ReplInput name -> Bool #

EVar n	x
ELit Literal	0x10
EGenerate (Expr n)	generate f
ETuple [Expr n]	(1,2,3)
ERecord (Rec (Expr n))	{ x = 1, y = 2 }
ESel (Expr n) Selector	e.l
EUpd (Maybe (Expr n)) [UpdField n]	{ r \| x = e }
EList [Expr n]	[1,2,3]
EFromTo (Type n) (Maybe (Type n)) (Type n) (Maybe (Type n))	[1, 5 .. 117 : t]
EFromToBy Bool (Type n) (Type n) (Type n) (Maybe (Type n))	[1 .. 10 by 2 : t ]
EFromToDownBy Bool (Type n) (Type n) (Type n) (Maybe (Type n))	[10 .. 1 down by 2 : t ]
EFromToLessThan (Type n) (Type n) (Maybe (Type n))	[ 1 .. < 10 : t ]
EInfFrom
Fields (Expr n) (Maybe (Expr n)) [1, 3 ...]
EComp (Expr n) [[Match n]]	[ 1 \| x <- xs ]
EApp (Expr n) (Expr n)	f x
EAppT (Expr n) [TypeInst n]	f `{x = 8}, f`{8}
EIf (Expr n) (Expr n) (Expr n)	if ok then e1 else e2
ECase (Expr n) [CaseAlt n]	case e of { P -> e }
EWhere (Expr n) [Decl n]	1 + x where { x = 2 }
ETyped (Expr n) (Type n)	1 : [8]
ETypeVal (Type n)	`(x + 1), `x` is a type
EFun (FunDesc n) [Pattern n] (Expr n)	\x y -> x
ELocated (Expr n) Range	position annotation
ESplit (Expr n)	`splitAt x` (Introduced by NoPat)
EParens (Expr n)	`(e)` (Removed by Fixity)
EInfix
Fields (Expr n) (Located n) Fixity (Expr n) `a + b` (Removed by Fixity)
EPrefix PrefixOp (Expr n)	-1, ~1

ECNum Integer NumInfo	`0x10` (HexLit 2)
ECChar Char	`a`
ECFrac Rational FracInfo	1.2e3
ECString String	"hello"

BinLit Text Int	n-digit binary literal
OctLit Text Int	n-digit octal literal
DecLit Text	overloaded decimal literal
HexLit Text Int	n-digit hex literal
PolyLit Int	polynomial literal