| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Language.PureScript
Description
The main compiler module
Synopsis
- data Text
- type HasCallStack = ?callStack :: CallStack
- type Supply = SupplyT Identity
- newtype SupplyT m a = SupplyT {}
- runSupplyT :: Integer -> SupplyT m a -> m (a, Integer)
- evalSupplyT :: Functor m => Integer -> SupplyT m a -> m a
- runSupply :: Integer -> Supply a -> (a, Integer)
- data Comment
- data SourceSpan = SourceSpan {}
- data SourcePos = SourcePos {}
- type SourceAnn = (SourceSpan, [Comment])
- pattern NullSourceAnn :: SourceAnn
- pattern NullSourceSpan :: SourceSpan
- displaySourcePos :: SourcePos -> Text
- displaySourcePosShort :: SourcePos -> Text
- displayStartEndPos :: SourceSpan -> Text
- displayStartEndPosShort :: SourceSpan -> Text
- displaySourceSpan :: FilePath -> SourceSpan -> Text
- internalModuleSourceSpan :: String -> SourceSpan
- nullSourceSpan :: SourceSpan
- nullSourceAnn :: SourceAnn
- nonEmptySpan :: SourceAnn -> Maybe SourceSpan
- widenSourceSpan :: SourceSpan -> SourceSpan -> SourceSpan
- widenSourceAnn :: SourceAnn -> SourceAnn -> SourceAnn
- internalError :: HasCallStack => String -> a
- data Fixity = Fixity Associativity Precedence
- data Associativity
- type Precedence = Integer
- showAssoc :: Associativity -> String
- readAssoc :: String -> Associativity
- data Qualified a = Qualified QualifiedBy a
- data QualifiedBy
- newtype ModuleName = ModuleName Text
- data ProperNameType
- newtype ProperName (a :: ProperNameType) = ProperName {}
- data OpNameType
- newtype OpName (a :: OpNameType) = OpName {}
- data Ident
- data InternalIdentData
- data Name
- pattern ByNullSourcePos :: QualifiedBy
- getIdentName :: Name -> Maybe Ident
- getValOpName :: Name -> Maybe (OpName 'ValueOpName)
- getTypeName :: Name -> Maybe (ProperName 'TypeName)
- getTypeOpName :: Name -> Maybe (OpName 'TypeOpName)
- getDctorName :: Name -> Maybe (ProperName 'ConstructorName)
- getClassName :: Name -> Maybe (ProperName 'ClassName)
- unusedIdent :: Text
- runIdent :: Ident -> Text
- showIdent :: Ident -> Text
- freshIdent :: MonadSupply m => Text -> m Ident
- freshIdent' :: MonadSupply m => m Ident
- isPlainIdent :: Ident -> Bool
- showOp :: OpName a -> Text
- eraseOpName :: OpName a -> OpName 'AnyOpName
- coerceOpName :: OpName a -> OpName b
- coerceProperName :: ProperName a -> ProperName b
- runModuleName :: ModuleName -> Text
- moduleNameFromString :: Text -> ModuleName
- isBuiltinModuleName :: ModuleName -> Bool
- isBySourcePos :: QualifiedBy -> Bool
- byMaybeModuleName :: Maybe ModuleName -> QualifiedBy
- toMaybeModuleName :: QualifiedBy -> Maybe ModuleName
- showQualified :: (a -> Text) -> Qualified a -> Text
- getQual :: Qualified a -> Maybe ModuleName
- qualify :: ModuleName -> Qualified a -> (ModuleName, a)
- mkQualified :: a -> ModuleName -> Qualified a
- disqualify :: Qualified a -> a
- disqualifyFor :: Maybe ModuleName -> Qualified a -> Maybe a
- isQualified :: Qualified a -> Bool
- isUnqualified :: Qualified a -> Bool
- isQualifiedWith :: ModuleName -> Qualified a -> Bool
- data CodegenTarget
- = JS
- | JSSourceMap
- | CoreFn
- | Docs
- data Options = Options {}
- defaultOptions :: Options
- codegenTargets :: Map String CodegenTarget
- prettyPrintString :: PSString -> Text
- data Literal a
- = NumericLiteral (Either Integer Double)
- | StringLiteral PSString
- | CharLiteral Char
- | BooleanLiteral Bool
- | ArrayLiteral [a]
- | ObjectLiteral [(PSString, a)]
- data Role
- displayRole :: Role -> Text
- data RowListItem a = RowListItem {
- rowListAnn :: a
- rowListLabel :: Label
- rowListType :: Type a
- data Constraint a = Constraint {
- constraintAnn :: a
- constraintClass :: Qualified (ProperName 'ClassName)
- constraintKindArgs :: [Type a]
- constraintArgs :: [Type a]
- constraintData :: Maybe ConstraintData
- data ConstraintData = PartialConstraintData [[Text]] Bool
- data Type a
- = TUnknown a Int
- | TypeVar a Text
- | TypeLevelString a PSString
- | TypeLevelInt a Integer
- | TypeWildcard a WildcardData
- | TypeConstructor a (Qualified (ProperName 'TypeName))
- | TypeOp a (Qualified (OpName 'TypeOpName))
- | TypeApp a (Type a) (Type a)
- | KindApp a (Type a) (Type a)
- | ForAll a Text (Maybe (Type a)) (Type a) (Maybe SkolemScope)
- | ConstrainedType a (Constraint a) (Type a)
- | Skolem a Text (Maybe (Type a)) Int SkolemScope
- | REmpty a
- | RCons a Label (Type a) (Type a)
- | KindedType a (Type a) (Type a)
- | BinaryNoParensType a (Type a) (Type a) (Type a)
- | ParensInType a (Type a)
- data WildcardData
- newtype SkolemScope = SkolemScope {}
- type SourceConstraint = Constraint SourceAnn
- type SourceType = Type SourceAnn
- pattern REmptyKinded :: forall a. a -> Maybe (Type a) -> Type a
- srcTUnknown :: Int -> SourceType
- srcTypeVar :: Text -> SourceType
- srcTypeLevelString :: PSString -> SourceType
- srcTypeLevelInt :: Integer -> SourceType
- srcTypeWildcard :: SourceType
- srcTypeConstructor :: Qualified (ProperName 'TypeName) -> SourceType
- srcTypeApp :: SourceType -> SourceType -> SourceType
- srcKindApp :: SourceType -> SourceType -> SourceType
- srcForAll :: Text -> Maybe SourceType -> SourceType -> Maybe SkolemScope -> SourceType
- srcConstrainedType :: SourceConstraint -> SourceType -> SourceType
- srcREmpty :: SourceType
- srcRCons :: Label -> SourceType -> SourceType -> SourceType
- srcKindedType :: SourceType -> SourceType -> SourceType
- toREmptyKinded :: forall a. Type a -> Maybe (a, Maybe (Type a))
- isREmpty :: forall a. Type a -> Bool
- srcConstraint :: Qualified (ProperName 'ClassName) -> [SourceType] -> [SourceType] -> Maybe ConstraintData -> SourceConstraint
- mapConstraintArgs :: ([Type a] -> [Type a]) -> Constraint a -> Constraint a
- overConstraintArgs :: Functor f => ([Type a] -> f [Type a]) -> Constraint a -> f (Constraint a)
- mapConstraintArgsAll :: ([Type a] -> [Type a]) -> Constraint a -> Constraint a
- overConstraintArgsAll :: Applicative f => ([Type a] -> f [Type a]) -> Constraint a -> f (Constraint a)
- constraintDataToJSON :: ConstraintData -> Value
- constraintToJSON :: (a -> Value) -> Constraint a -> Value
- typeToJSON :: forall a. (a -> Value) -> Type a -> Value
- constraintDataFromJSON :: Value -> Parser ConstraintData
- constraintFromJSON :: forall a. Parser a -> (Value -> Parser a) -> Value -> Parser (Constraint a)
- typeFromJSON :: forall a. Parser a -> (Value -> Parser a) -> Value -> Parser (Type a)
- srcRowListItem :: Label -> SourceType -> RowListItem SourceAnn
- rowToList :: Type a -> ([RowListItem a], Type a)
- rowToSortedList :: Type a -> ([RowListItem a], Type a)
- rowFromList :: ([RowListItem a], Type a) -> Type a
- alignRowsWith :: (Label -> Type a -> Type a -> r) -> Type a -> Type a -> ([r], (([RowListItem a], Type a), ([RowListItem a], Type a)))
- isMonoType :: Type a -> Bool
- mkForAll :: [(a, (Text, Maybe (Type a)))] -> Type a -> Type a
- replaceTypeVars :: Text -> Type a -> Type a -> Type a
- replaceAllTypeVars :: [(Text, Type a)] -> Type a -> Type a
- usedTypeVariables :: Type a -> [Text]
- freeTypeVariables :: Type a -> [Text]
- completeBinderList :: Type a -> Maybe ([(a, (Text, Type a))], Type a)
- quantify :: Type a -> Type a
- moveQuantifiersToFront :: Type a -> Type a
- containsForAll :: Type a -> Bool
- unknowns :: Type a -> IntSet
- containsUnknowns :: Type a -> Bool
- eraseKindApps :: Type a -> Type a
- eraseForAllKindAnnotations :: Type a -> Type a
- unapplyTypes :: Type a -> (Type a, [Type a], [Type a])
- unapplyConstraints :: Type a -> ([Constraint a], Type a)
- srcInstanceType :: SourceSpan -> [(Text, SourceType)] -> Qualified (ProperName 'ClassName) -> [SourceType] -> SourceType
- everywhereOnTypes :: (Type a -> Type a) -> Type a -> Type a
- everywhereOnTypesM :: Monad m => (Type a -> m (Type a)) -> Type a -> m (Type a)
- everywhereOnTypesTopDownM :: Monad m => (Type a -> m (Type a)) -> Type a -> m (Type a)
- everythingOnTypes :: (r -> r -> r) -> (Type a -> r) -> Type a -> r
- everythingWithContextOnTypes :: s -> r -> (r -> r -> r) -> (s -> Type a -> (s, r)) -> Type a -> r
- annForType :: Lens' (Type a) a
- getAnnForType :: Type a -> a
- setAnnForType :: a -> Type a -> Type a
- eqType :: Type a -> Type b -> Bool
- eqMaybeType :: Maybe (Type a) -> Maybe (Type b) -> Bool
- compareType :: Type a -> Type b -> Ordering
- compareMaybeType :: Maybe (Type a) -> Maybe (Type b) -> Ordering
- eqConstraint :: Constraint a -> Constraint b -> Bool
- compareConstraint :: Constraint a -> Constraint b -> Ordering
- data DataDeclType
- data TypeKind
- = DataType DataDeclType [(Text, Maybe SourceType, Role)] [(ProperName 'ConstructorName, [SourceType])]
- | TypeSynonym
- | ExternData [Role]
- | LocalTypeVariable
- | ScopedTypeVar
- data NameKind
- data NameVisibility
- type Frontier = Map IntSet (First (IntMap (NonEmpty IntSet)))
- data FunctionalDependency = FunctionalDependency {
- fdDeterminers :: [Int]
- fdDetermined :: [Int]
- data TypeClassData = TypeClassData {}
- data Environment = Environment {
- names :: Map (Qualified Ident) (SourceType, NameKind, NameVisibility)
- types :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- dataConstructors :: Map (Qualified (ProperName 'ConstructorName)) (DataDeclType, ProperName 'TypeName, SourceType, [Ident])
- typeSynonyms :: Map (Qualified (ProperName 'TypeName)) ([(Text, Maybe SourceType)], SourceType)
- typeClassDictionaries :: Map QualifiedBy (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))
- typeClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- initEnvironment :: Environment
- makeTypeClassData :: [(Text, Maybe SourceType)] -> [(Ident, SourceType)] -> [SourceConstraint] -> [FunctionalDependency] -> Bool -> TypeClassData
- computeCoveringSets :: Int -> [FunctionalDependency] -> (Set Int, Set (Set Int))
- showDataDeclType :: DataDeclType -> Text
- kindType :: SourceType
- kindConstraint :: SourceType
- kindSymbol :: SourceType
- kindDoc :: SourceType
- kindOrdering :: SourceType
- kindRowList :: SourceType -> SourceType
- kindRow :: SourceType -> SourceType
- kindOfREmpty :: SourceType
- tyFunction :: SourceType
- tyString :: SourceType
- tyChar :: SourceType
- tyNumber :: SourceType
- tyInt :: SourceType
- tyBoolean :: SourceType
- tyArray :: SourceType
- tyRecord :: SourceType
- tyVar :: Text -> SourceType
- tyForall :: Text -> SourceType -> SourceType -> SourceType
- function :: SourceType -> SourceType -> SourceType
- (-:>) :: SourceType -> SourceType -> SourceType
- primClass :: Qualified (ProperName 'ClassName) -> (SourceType -> SourceType) -> [(Qualified (ProperName 'TypeName), (SourceType, TypeKind))]
- primTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- allPrimTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primBooleanTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primCoerceTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primOrderingTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primRowTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primRowListTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primSymbolTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primIntTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primTypeErrorTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- primClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- allPrimClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- primCoerceClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- primRowClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- primRowListClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- primSymbolClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- primIntClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- primTypeErrorClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData
- lookupConstructor :: Environment -> Qualified (ProperName 'ConstructorName) -> (DataDeclType, ProperName 'TypeName, SourceType, [Ident])
- lookupValue :: Environment -> Qualified Ident -> Maybe (SourceType, NameKind, NameVisibility)
- dictTypeName' :: Text -> Text
- dictTypeName :: ProperName a -> ProperName a
- isDictTypeName :: ProperName a -> Bool
- nominalRolesForKind :: Type a -> [Role]
- kindArity :: Type a -> Int
- unapplyKinds :: Type a -> ([Type a], Type a)
- data Binder
- = NullBinder
- | LiteralBinder SourceSpan (Literal Binder)
- | VarBinder SourceSpan Ident
- | ConstructorBinder SourceSpan (Qualified (ProperName 'ConstructorName)) [Binder]
- | OpBinder SourceSpan (Qualified (OpName 'ValueOpName))
- | BinaryNoParensBinder Binder Binder Binder
- | ParensInBinder Binder
- | NamedBinder SourceSpan Ident Binder
- | PositionedBinder SourceSpan [Comment] Binder
- | TypedBinder SourceType Binder
- binderNames :: Binder -> [Ident]
- binderNamesWithSpans :: Binder -> [(SourceSpan, Ident)]
- isIrrefutable :: Binder -> Bool
- newtype AssocList k t = AssocList {
- runAssocList :: [(k, t)]
- data PathNode t
- newtype PathTree t = PathTree (AssocList PSString (PathNode t))
- data DoNotationElement
- data CaseAlternative = CaseAlternative {}
- data WhereProvenance
- data Expr
- = Literal SourceSpan (Literal Expr)
- | UnaryMinus SourceSpan Expr
- | BinaryNoParens Expr Expr Expr
- | Parens Expr
- | Accessor PSString Expr
- | ObjectUpdate Expr [(PSString, Expr)]
- | ObjectUpdateNested Expr (PathTree Expr)
- | Abs Binder Expr
- | App Expr Expr
- | Unused Expr
- | Var SourceSpan (Qualified Ident)
- | Op SourceSpan (Qualified (OpName 'ValueOpName))
- | IfThenElse Expr Expr Expr
- | Constructor SourceSpan (Qualified (ProperName 'ConstructorName))
- | Case [Expr] [CaseAlternative]
- | TypedValue Bool Expr SourceType
- | Let WhereProvenance [Declaration] Expr
- | Do (Maybe ModuleName) [DoNotationElement]
- | Ado (Maybe ModuleName) [DoNotationElement] Expr
- | TypeClassDictionary SourceConstraint (Map QualifiedBy (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))) [ErrorMessageHint]
- | DeferredDictionary (Qualified (ProperName 'ClassName)) [SourceType]
- | DerivedInstancePlaceholder (Qualified (ProperName 'ClassName)) InstanceDerivationStrategy
- | AnonymousArgument
- | Hole Text
- | PositionedValue SourceSpan [Comment] Expr
- data GuardedExpr = GuardedExpr [Guard] Expr
- data Guard
- data KindSignatureFor
- data TypeInstanceBody
- data InstanceDerivationStrategy
- data TypeFixity = TypeFixity Fixity (Qualified (ProperName 'TypeName)) (OpName 'TypeOpName)
- data ValueFixity = ValueFixity Fixity (Qualified (Either Ident (ProperName 'ConstructorName))) (OpName 'ValueOpName)
- data Declaration
- = DataDeclaration SourceAnn DataDeclType (ProperName 'TypeName) [(Text, Maybe SourceType)] [DataConstructorDeclaration]
- | DataBindingGroupDeclaration (NonEmpty Declaration)
- | TypeSynonymDeclaration SourceAnn (ProperName 'TypeName) [(Text, Maybe SourceType)] SourceType
- | KindDeclaration SourceAnn KindSignatureFor (ProperName 'TypeName) SourceType
- | RoleDeclaration !RoleDeclarationData
- | TypeDeclaration !TypeDeclarationData
- | ValueDeclaration !(ValueDeclarationData [GuardedExpr])
- | BoundValueDeclaration SourceAnn Binder Expr
- | BindingGroupDeclaration (NonEmpty ((SourceAnn, Ident), NameKind, Expr))
- | ExternDeclaration SourceAnn Ident SourceType
- | ExternDataDeclaration SourceAnn (ProperName 'TypeName) SourceType
- | FixityDeclaration SourceAnn (Either ValueFixity TypeFixity)
- | ImportDeclaration SourceAnn ModuleName ImportDeclarationType (Maybe ModuleName)
- | TypeClassDeclaration SourceAnn (ProperName 'ClassName) [(Text, Maybe SourceType)] [SourceConstraint] [FunctionalDependency] [Declaration]
- | TypeInstanceDeclaration SourceAnn SourceAnn ChainId Integer (Either Text Ident) [SourceConstraint] (Qualified (ProperName 'ClassName)) [SourceType] TypeInstanceBody
- data DataConstructorDeclaration = DataConstructorDeclaration {
- dataCtorAnn :: !SourceAnn
- dataCtorName :: !(ProperName 'ConstructorName)
- dataCtorFields :: ![(Ident, SourceType)]
- data ValueDeclarationData a = ValueDeclarationData {
- valdeclSourceAnn :: !SourceAnn
- valdeclIdent :: !Ident
- valdeclName :: !NameKind
- valdeclBinders :: ![Binder]
- valdeclExpression :: !a
- data TypeDeclarationData = TypeDeclarationData {
- tydeclSourceAnn :: !SourceAnn
- tydeclIdent :: !Ident
- tydeclType :: !SourceType
- data RoleDeclarationData = RoleDeclarationData {
- rdeclSourceAnn :: !SourceAnn
- rdeclIdent :: !(ProperName 'TypeName)
- rdeclRoles :: ![Role]
- data ImportDeclarationType
- data ExportSource = ExportSource {}
- data DeclarationRef
- = TypeClassRef SourceSpan (ProperName 'ClassName)
- | TypeOpRef SourceSpan (OpName 'TypeOpName)
- | TypeRef SourceSpan (ProperName 'TypeName) (Maybe [ProperName 'ConstructorName])
- | ValueRef SourceSpan Ident
- | ValueOpRef SourceSpan (OpName 'ValueOpName)
- | TypeInstanceRef SourceSpan Ident NameSource
- | ModuleRef SourceSpan ModuleName
- | ReExportRef SourceSpan ExportSource DeclarationRef
- data NameSource
- data Module = Module SourceSpan [Comment] ModuleName [Declaration] (Maybe [DeclarationRef])
- data HintCategory
- data ErrorMessageHint
- = ErrorUnifyingTypes SourceType SourceType
- | ErrorInExpression Expr
- | ErrorInModule ModuleName
- | ErrorInInstance (Qualified (ProperName 'ClassName)) [SourceType]
- | ErrorInSubsumption SourceType SourceType
- | ErrorInRowLabel Label
- | ErrorCheckingAccessor Expr PSString
- | ErrorCheckingType Expr SourceType
- | ErrorCheckingKind SourceType SourceType
- | ErrorCheckingGuard
- | ErrorInferringType Expr
- | ErrorInferringKind SourceType
- | ErrorInApplication Expr SourceType Expr
- | ErrorInDataConstructor (ProperName 'ConstructorName)
- | ErrorInTypeConstructor (ProperName 'TypeName)
- | ErrorInBindingGroup (NonEmpty Ident)
- | ErrorInDataBindingGroup [ProperName 'TypeName]
- | ErrorInTypeSynonym (ProperName 'TypeName)
- | ErrorInValueDeclaration Ident
- | ErrorInTypeDeclaration Ident
- | ErrorInTypeClassDeclaration (ProperName 'ClassName)
- | ErrorInKindDeclaration (ProperName 'TypeName)
- | ErrorInRoleDeclaration (ProperName 'TypeName)
- | ErrorInForeignImport Ident
- | ErrorInForeignImportData (ProperName 'TypeName)
- | ErrorSolvingConstraint SourceConstraint
- | MissingConstructorImportForCoercible (Qualified (ProperName 'ConstructorName))
- | PositionedError (NonEmpty SourceSpan)
- | RelatedPositions (NonEmpty SourceSpan)
- data TypeSearch
- = TSBefore Environment
- | TSAfter {
- tsAfterIdentifiers :: [(Qualified Text, SourceType)]
- tsAfterRecordFields :: Maybe [(Label, SourceType)]
- type Context = [(Ident, SourceType)]
- pattern MkUnguarded :: Expr -> GuardedExpr
- pattern TypeFixityDeclaration :: SourceAnn -> Fixity -> Qualified (ProperName 'TypeName) -> OpName 'TypeOpName -> Declaration
- pattern ValueFixityDeclaration :: SourceAnn -> Fixity -> Qualified (Either Ident (ProperName 'ConstructorName)) -> OpName 'ValueOpName -> Declaration
- pattern ValueDecl :: SourceAnn -> Ident -> NameKind -> [Binder] -> [GuardedExpr] -> Declaration
- onTypeSearchTypes :: (SourceType -> SourceType) -> TypeSearch -> TypeSearch
- onTypeSearchTypesM :: Applicative m => (SourceType -> m SourceType) -> TypeSearch -> m TypeSearch
- getModuleName :: Module -> ModuleName
- getModuleSourceSpan :: Module -> SourceSpan
- getModuleDeclarations :: Module -> [Declaration]
- addDefaultImport :: Qualified ModuleName -> Module -> Module
- importPrim :: Module -> Module
- declRefSourceSpan :: DeclarationRef -> SourceSpan
- declRefName :: DeclarationRef -> Name
- getTypeRef :: DeclarationRef -> Maybe (ProperName 'TypeName, Maybe [ProperName 'ConstructorName])
- getTypeOpRef :: DeclarationRef -> Maybe (OpName 'TypeOpName)
- getValueRef :: DeclarationRef -> Maybe Ident
- getValueOpRef :: DeclarationRef -> Maybe (OpName 'ValueOpName)
- getTypeClassRef :: DeclarationRef -> Maybe (ProperName 'ClassName)
- isModuleRef :: DeclarationRef -> Bool
- isExplicit :: ImportDeclarationType -> Bool
- getTypeDeclaration :: Declaration -> Maybe TypeDeclarationData
- unwrapTypeDeclaration :: TypeDeclarationData -> (Ident, SourceType)
- getValueDeclaration :: Declaration -> Maybe (ValueDeclarationData [GuardedExpr])
- mapDataCtorFields :: ([(Ident, SourceType)] -> [(Ident, SourceType)]) -> DataConstructorDeclaration -> DataConstructorDeclaration
- traverseDataCtorFields :: Monad m => ([(Ident, SourceType)] -> m [(Ident, SourceType)]) -> DataConstructorDeclaration -> m DataConstructorDeclaration
- mapTypeInstanceBody :: ([Declaration] -> [Declaration]) -> TypeInstanceBody -> TypeInstanceBody
- traverseTypeInstanceBody :: Applicative f => ([Declaration] -> f [Declaration]) -> TypeInstanceBody -> f TypeInstanceBody
- declSourceAnn :: Declaration -> SourceAnn
- declSourceSpan :: Declaration -> SourceSpan
- declName :: Declaration -> Maybe Name
- isValueDecl :: Declaration -> Bool
- isDataDecl :: Declaration -> Bool
- isTypeSynonymDecl :: Declaration -> Bool
- isImportDecl :: Declaration -> Bool
- isRoleDecl :: Declaration -> Bool
- isExternDataDecl :: Declaration -> Bool
- isFixityDecl :: Declaration -> Bool
- getFixityDecl :: Declaration -> Maybe (Either ValueFixity TypeFixity)
- isExternDecl :: Declaration -> Bool
- isTypeClassInstanceDecl :: Declaration -> Bool
- isTypeClassDecl :: Declaration -> Bool
- isKindDecl :: Declaration -> Bool
- flattenDecls :: [Declaration] -> [Declaration]
- isTrueExpr :: Expr -> Bool
- isAnonymousArgument :: Expr -> Bool
- data ScopedIdent
- guardedExprM :: Applicative m => (Guard -> m Guard) -> (Expr -> m Expr) -> GuardedExpr -> m GuardedExpr
- mapGuardedExpr :: (Guard -> Guard) -> (Expr -> Expr) -> GuardedExpr -> GuardedExpr
- litM :: Monad m => (a -> m a) -> Literal a -> m (Literal a)
- everywhereOnValues :: (Declaration -> Declaration) -> (Expr -> Expr) -> (Binder -> Binder) -> (Declaration -> Declaration, Expr -> Expr, Binder -> Binder)
- everywhereOnValuesTopDownM :: forall m. Monad m => (Declaration -> m Declaration) -> (Expr -> m Expr) -> (Binder -> m Binder) -> (Declaration -> m Declaration, Expr -> m Expr, Binder -> m Binder)
- everywhereOnValuesM :: forall m. Monad m => (Declaration -> m Declaration) -> (Expr -> m Expr) -> (Binder -> m Binder) -> (Declaration -> m Declaration, Expr -> m Expr, Binder -> m Binder)
- everythingOnValues :: forall r. (r -> r -> r) -> (Declaration -> r) -> (Expr -> r) -> (Binder -> r) -> (CaseAlternative -> r) -> (DoNotationElement -> r) -> (Declaration -> r, Expr -> r, Binder -> r, CaseAlternative -> r, DoNotationElement -> r)
- everythingWithContextOnValues :: forall s r. s -> r -> (r -> r -> r) -> (s -> Declaration -> (s, r)) -> (s -> Expr -> (s, r)) -> (s -> Binder -> (s, r)) -> (s -> CaseAlternative -> (s, r)) -> (s -> DoNotationElement -> (s, r)) -> (Declaration -> r, Expr -> r, Binder -> r, CaseAlternative -> r, DoNotationElement -> r)
- everywhereWithContextOnValues :: forall s. s -> (s -> Declaration -> (s, Declaration)) -> (s -> Expr -> (s, Expr)) -> (s -> Binder -> (s, Binder)) -> (s -> CaseAlternative -> (s, CaseAlternative)) -> (s -> DoNotationElement -> (s, DoNotationElement)) -> (s -> Guard -> (s, Guard)) -> (Declaration -> Declaration, Expr -> Expr, Binder -> Binder, CaseAlternative -> CaseAlternative, DoNotationElement -> DoNotationElement, Guard -> Guard)
- everywhereWithContextOnValuesM :: forall m s. Monad m => s -> (s -> Declaration -> m (s, Declaration)) -> (s -> Expr -> m (s, Expr)) -> (s -> Binder -> m (s, Binder)) -> (s -> CaseAlternative -> m (s, CaseAlternative)) -> (s -> DoNotationElement -> m (s, DoNotationElement)) -> (s -> Guard -> m (s, Guard)) -> (Declaration -> m Declaration, Expr -> m Expr, Binder -> m Binder, CaseAlternative -> m CaseAlternative, DoNotationElement -> m DoNotationElement, Guard -> m Guard)
- inScope :: Ident -> Set ScopedIdent -> Bool
- everythingWithScope :: forall r. Monoid r => (Set ScopedIdent -> Declaration -> r) -> (Set ScopedIdent -> Expr -> r) -> (Set ScopedIdent -> Binder -> r) -> (Set ScopedIdent -> CaseAlternative -> r) -> (Set ScopedIdent -> DoNotationElement -> r) -> (Set ScopedIdent -> Declaration -> r, Set ScopedIdent -> Expr -> r, Set ScopedIdent -> Binder -> r, Set ScopedIdent -> CaseAlternative -> r, Set ScopedIdent -> DoNotationElement -> r)
- accumTypes :: Monoid r => (SourceType -> r) -> (Declaration -> r, Expr -> r, Binder -> r, CaseAlternative -> r, DoNotationElement -> r)
- overTypes :: (SourceType -> SourceType) -> Expr -> Expr
- exportedDeclarations :: Module -> [Declaration]
- isExported :: Maybe [DeclarationRef] -> Declaration -> Bool
- desugarLetPatternModule :: Module -> Module
- type PrettyPrintConstraint = (Qualified (ProperName 'ClassName), [PrettyPrintType], [PrettyPrintType])
- data PrettyPrintType
- = PPTUnknown Int
- | PPTypeVar Text (Maybe Text)
- | PPTypeLevelString PSString
- | PPTypeLevelInt Integer
- | PPTypeWildcard (Maybe Text)
- | PPTypeConstructor (Qualified (ProperName 'TypeName))
- | PPTypeOp (Qualified (OpName 'TypeOpName))
- | PPSkolem Text Int
- | PPTypeApp PrettyPrintType PrettyPrintType
- | PPKindArg PrettyPrintType
- | PPConstrainedType PrettyPrintConstraint PrettyPrintType
- | PPKindedType PrettyPrintType PrettyPrintType
- | PPBinaryNoParensType PrettyPrintType PrettyPrintType PrettyPrintType
- | PPParensInType PrettyPrintType
- | PPForAll [(Text, Maybe PrettyPrintType)] PrettyPrintType
- | PPFunction PrettyPrintType PrettyPrintType
- | PPRecord [(Label, PrettyPrintType)] (Maybe PrettyPrintType)
- | PPRow [(Label, PrettyPrintType)] (Maybe PrettyPrintType)
- | PPTruncated
- convertPrettyPrintType :: Int -> Type a -> PrettyPrintType
- typeAtomAsBox :: Int -> Type a -> Box
- prettyPrintTypeAtom :: Int -> Type a -> String
- typeAsBox :: Int -> Type a -> Box
- typeDiffAsBox :: Int -> Type a -> Box
- prettyPrintType :: Int -> Type a -> String
- prettyPrintTypeWithUnicode :: Int -> Type a -> String
- prettyPrintSuggestedType :: Type a -> String
- prettyPrintLabel :: Label -> Text
- prettyPrintObjectKey :: PSString -> Text
- prettyPrintValue :: Int -> Expr -> Box
- prettyPrintBinderAtom :: Binder -> Text
- prettyPrintBinder :: Binder -> Text
- data PPEOptions = PPEOptions {
- ppeCodeColor :: Maybe (ColorIntensity, Color)
- ppeFull :: Bool
- ppeLevel :: Level
- ppeShowDocs :: Bool
- ppeRelativeDirectory :: FilePath
- ppeFileContents :: [(FilePath, Text)]
- data Level
- data TypeMap = TypeMap {
- umSkolemMap :: Map Int (String, Int, Maybe SourceSpan)
- umUnknownMap :: Map Int Int
- umNextIndex :: Int
- newtype MultipleErrors = MultipleErrors {}
- newtype ErrorSuggestion = ErrorSuggestion Text
- data ErrorMessage = ErrorMessage [ErrorMessageHint] SimpleErrorMessage
- data SimpleErrorMessage
- = InternalCompilerError Text Text
- | ModuleNotFound ModuleName
- | ErrorParsingFFIModule FilePath (Maybe ErrorMessage)
- | ErrorParsingCSTModule ParserError
- | WarningParsingCSTModule ParserWarning
- | MissingFFIModule ModuleName
- | UnnecessaryFFIModule ModuleName FilePath
- | MissingFFIImplementations ModuleName [Ident]
- | UnusedFFIImplementations ModuleName [Ident]
- | InvalidFFIIdentifier ModuleName Text
- | DeprecatedFFIPrime ModuleName Text
- | DeprecatedFFICommonJSModule ModuleName FilePath
- | UnsupportedFFICommonJSExports ModuleName [Text]
- | UnsupportedFFICommonJSImports ModuleName [Text]
- | FileIOError Text IOError
- | InfiniteType SourceType
- | InfiniteKind SourceType
- | MultipleValueOpFixities (OpName 'ValueOpName)
- | MultipleTypeOpFixities (OpName 'TypeOpName)
- | OrphanTypeDeclaration Ident
- | OrphanKindDeclaration (ProperName 'TypeName)
- | OrphanRoleDeclaration (ProperName 'TypeName)
- | RedefinedIdent Ident
- | OverlappingNamesInLet Ident
- | UnknownName (Qualified Name)
- | UnknownImport ModuleName Name
- | UnknownImportDataConstructor ModuleName (ProperName 'TypeName) (ProperName 'ConstructorName)
- | UnknownExport Name
- | UnknownExportDataConstructor (ProperName 'TypeName) (ProperName 'ConstructorName)
- | ScopeConflict Name [ModuleName]
- | ScopeShadowing Name (Maybe ModuleName) [ModuleName]
- | DeclConflict Name Name
- | ExportConflict (Qualified Name) (Qualified Name)
- | DuplicateModule ModuleName
- | DuplicateTypeClass (ProperName 'ClassName) SourceSpan
- | DuplicateInstance Ident SourceSpan
- | DuplicateTypeArgument Text
- | InvalidDoBind
- | InvalidDoLet
- | CycleInDeclaration Ident
- | CycleInTypeSynonym (NonEmpty (ProperName 'TypeName))
- | CycleInTypeClassDeclaration (NonEmpty (Qualified (ProperName 'ClassName)))
- | CycleInKindDeclaration (NonEmpty (Qualified (ProperName 'TypeName)))
- | CycleInModules (NonEmpty ModuleName)
- | NameIsUndefined Ident
- | UndefinedTypeVariable (ProperName 'TypeName)
- | PartiallyAppliedSynonym (Qualified (ProperName 'TypeName))
- | EscapedSkolem Text (Maybe SourceSpan) SourceType
- | TypesDoNotUnify SourceType SourceType
- | KindsDoNotUnify SourceType SourceType
- | ConstrainedTypeUnified SourceType SourceType
- | OverlappingInstances (Qualified (ProperName 'ClassName)) [SourceType] [Qualified (Either SourceType Ident)]
- | NoInstanceFound SourceConstraint [Qualified (Either SourceType Ident)] Bool
- | AmbiguousTypeVariables SourceType [(Text, Int)]
- | UnknownClass (Qualified (ProperName 'ClassName))
- | PossiblyInfiniteInstance (Qualified (ProperName 'ClassName)) [SourceType]
- | PossiblyInfiniteCoercibleInstance
- | CannotDerive (Qualified (ProperName 'ClassName)) [SourceType]
- | InvalidDerivedInstance (Qualified (ProperName 'ClassName)) [SourceType] Int
- | ExpectedTypeConstructor (Qualified (ProperName 'ClassName)) [SourceType] SourceType
- | InvalidNewtypeInstance (Qualified (ProperName 'ClassName)) [SourceType]
- | MissingNewtypeSuperclassInstance (Qualified (ProperName 'ClassName)) (Qualified (ProperName 'ClassName)) [SourceType]
- | UnverifiableSuperclassInstance (Qualified (ProperName 'ClassName)) (Qualified (ProperName 'ClassName)) [SourceType]
- | CannotFindDerivingType (ProperName 'TypeName)
- | DuplicateLabel Label (Maybe Expr)
- | DuplicateValueDeclaration Ident
- | ArgListLengthsDiffer Ident
- | OverlappingArgNames (Maybe Ident)
- | MissingClassMember (NonEmpty (Ident, SourceType))
- | ExtraneousClassMember Ident (Qualified (ProperName 'ClassName))
- | ExpectedType SourceType SourceType
- | IncorrectConstructorArity (Qualified (ProperName 'ConstructorName)) Int Int
- | ExprDoesNotHaveType Expr SourceType
- | PropertyIsMissing Label
- | AdditionalProperty Label
- | OrphanInstance Ident (Qualified (ProperName 'ClassName)) (Set ModuleName) [SourceType]
- | InvalidNewtype (ProperName 'TypeName)
- | InvalidInstanceHead SourceType
- | TransitiveExportError DeclarationRef [DeclarationRef]
- | TransitiveDctorExportError DeclarationRef [ProperName 'ConstructorName]
- | HiddenConstructors DeclarationRef (Qualified (ProperName 'ClassName))
- | ShadowedName Ident
- | ShadowedTypeVar Text
- | UnusedTypeVar Text
- | UnusedName Ident
- | UnusedDeclaration Ident
- | WildcardInferredType SourceType Context
- | HoleInferredType Text SourceType Context (Maybe TypeSearch)
- | MissingTypeDeclaration Ident SourceType
- | MissingKindDeclaration KindSignatureFor (ProperName 'TypeName) SourceType
- | OverlappingPattern [[Binder]] Bool
- | IncompleteExhaustivityCheck
- | ImportHidingModule ModuleName
- | UnusedImport ModuleName (Maybe ModuleName)
- | UnusedExplicitImport ModuleName [Name] (Maybe ModuleName) [DeclarationRef]
- | UnusedDctorImport ModuleName (ProperName 'TypeName) (Maybe ModuleName) [DeclarationRef]
- | UnusedDctorExplicitImport ModuleName (ProperName 'TypeName) [ProperName 'ConstructorName] (Maybe ModuleName) [DeclarationRef]
- | DuplicateSelectiveImport ModuleName
- | DuplicateImport ModuleName ImportDeclarationType (Maybe ModuleName)
- | DuplicateImportRef Name
- | DuplicateExportRef Name
- | IntOutOfRange Integer Text Integer Integer
- | ImplicitQualifiedImport ModuleName ModuleName [DeclarationRef]
- | ImplicitQualifiedImportReExport ModuleName ModuleName [DeclarationRef]
- | ImplicitImport ModuleName [DeclarationRef]
- | HidingImport ModuleName [DeclarationRef]
- | CaseBinderLengthDiffers Int [Binder]
- | IncorrectAnonymousArgument
- | InvalidOperatorInBinder (Qualified (OpName 'ValueOpName)) (Qualified Ident)
- | CannotGeneralizeRecursiveFunction Ident SourceType
- | CannotDeriveNewtypeForData (ProperName 'TypeName)
- | ExpectedWildcard (ProperName 'TypeName)
- | CannotUseBindWithDo Ident
- | ClassInstanceArityMismatch Ident (Qualified (ProperName 'ClassName)) Int Int
- | UserDefinedWarning SourceType
- | UnusableDeclaration Ident [[Text]]
- | CannotDefinePrimModules ModuleName
- | MixedAssociativityError (NonEmpty (Qualified (OpName 'AnyOpName), Associativity))
- | NonAssociativeError (NonEmpty (Qualified (OpName 'AnyOpName)))
- | QuantificationCheckFailureInKind Text
- | QuantificationCheckFailureInType [Int] SourceType
- | VisibleQuantificationCheckFailureInType Text
- | UnsupportedTypeInKind SourceType
- | RoleMismatch Text Role Role
- | InvalidCoercibleInstanceDeclaration [SourceType]
- | UnsupportedRoleDeclaration
- | RoleDeclarationArityMismatch (ProperName 'TypeName) Int Int
- | DuplicateRoleDeclaration (ProperName 'TypeName)
- | CannotDeriveInvalidConstructorArg (Qualified (ProperName 'ClassName)) [Qualified (ProperName 'ClassName)] Bool
- errorSpan :: ErrorMessage -> Maybe (NonEmpty SourceSpan)
- errorModule :: ErrorMessage -> Maybe ModuleName
- findHint :: (ErrorMessageHint -> Maybe a) -> ErrorMessage -> Maybe a
- stripModuleAndSpan :: ErrorMessage -> ErrorMessage
- errorCode :: ErrorMessage -> Text
- nonEmpty :: MultipleErrors -> Bool
- errorMessage :: SimpleErrorMessage -> MultipleErrors
- errorMessage' :: SourceSpan -> SimpleErrorMessage -> MultipleErrors
- errorMessage'' :: NonEmpty SourceSpan -> SimpleErrorMessage -> MultipleErrors
- errorMessage''' :: [SourceSpan] -> SimpleErrorMessage -> MultipleErrors
- singleError :: ErrorMessage -> MultipleErrors
- onErrorMessages :: (ErrorMessage -> ErrorMessage) -> MultipleErrors -> MultipleErrors
- addHint :: ErrorMessageHint -> MultipleErrors -> MultipleErrors
- addHints :: [ErrorMessageHint] -> MultipleErrors -> MultipleErrors
- defaultUnknownMap :: TypeMap
- unwrapErrorMessage :: ErrorMessage -> SimpleErrorMessage
- replaceUnknowns :: SourceType -> State TypeMap SourceType
- onTypesInErrorMessage :: (SourceType -> SourceType) -> ErrorMessage -> ErrorMessage
- onTypesInErrorMessageM :: Applicative m => (SourceType -> m SourceType) -> ErrorMessage -> m ErrorMessage
- errorDocUri :: ErrorMessage -> Text
- errorSuggestion :: SimpleErrorMessage -> Maybe ErrorSuggestion
- suggestionSpan :: ErrorMessage -> Maybe SourceSpan
- showSuggestion :: SimpleErrorMessage -> Text
- ansiColor :: (ColorIntensity, Color) -> String
- ansiColorReset :: String
- colorCode :: Maybe (ColorIntensity, Color) -> Text -> Text
- colorCodeBox :: Maybe (ColorIntensity, Color) -> Box -> Box
- commasAndConjunction :: Text -> [Text] -> Text
- defaultCodeColor :: (ColorIntensity, Color)
- defaultPPEOptions :: PPEOptions
- prettyPrintSingleError :: PPEOptions -> ErrorMessage -> Box
- prettyPrintExport :: DeclarationRef -> Text
- prettyPrintImport :: ModuleName -> ImportDeclarationType -> Maybe ModuleName -> Text
- prettyPrintRef :: DeclarationRef -> Maybe Text
- prettyPrintKindSignatureFor :: KindSignatureFor -> Text
- prettyPrintSuggestedTypeSimplified :: Type a -> String
- prettyPrintMultipleErrors :: PPEOptions -> MultipleErrors -> String
- prettyPrintMultipleWarnings :: PPEOptions -> MultipleErrors -> String
- prettyPrintMultipleWarningsBox :: PPEOptions -> MultipleErrors -> [Box]
- prettyPrintMultipleErrorsBox :: PPEOptions -> MultipleErrors -> [Box]
- prettyPrintMultipleErrorsWith :: PPEOptions -> String -> String -> MultipleErrors -> [Box]
- line :: Text -> Box
- lineS :: String -> Box
- renderBox :: Box -> String
- toTypelevelString :: Type a -> Maybe Box
- rethrow :: MonadError e m => (e -> e) -> m a -> m a
- warnAndRethrow :: (MonadError e m, MonadWriter e m) => (e -> e) -> m a -> m a
- rethrowWithPosition :: MonadError MultipleErrors m => SourceSpan -> m a -> m a
- warnWithPosition :: MonadWriter MultipleErrors m => SourceSpan -> m a -> m a
- warnAndRethrowWithPosition :: (MonadError MultipleErrors m, MonadWriter MultipleErrors m) => SourceSpan -> m a -> m a
- withPosition :: SourceSpan -> ErrorMessage -> ErrorMessage
- withoutPosition :: ErrorMessage -> ErrorMessage
- positionedError :: SourceSpan -> ErrorMessageHint
- escalateWarningWhen :: (MonadWriter MultipleErrors m, MonadError MultipleErrors m) => (ErrorMessage -> Bool) -> m a -> m a
- parU :: forall m a b. MonadError MultipleErrors m => [a] -> (a -> m b) -> m [b]
- internalCompilerError :: (MonadError MultipleErrors m, HasCallStack) => Text -> m a
- lookupRoles :: Environment -> Qualified (ProperName 'TypeName) -> [Role]
- checkRoles :: forall m. MonadError MultipleErrors m => [(Text, Maybe SourceType, Role)] -> [Role] -> m ()
- checkRoleDeclarationArity :: forall m. MonadError MultipleErrors m => ProperName 'TypeName -> [Role] -> Int -> m ()
- inferRoles :: Environment -> ModuleName -> ProperName 'TypeName -> [(Text, Maybe SourceType)] -> [DataConstructorDeclaration] -> [Role]
- inferDataBindingGroupRoles :: Environment -> ModuleName -> [RoleDeclarationData] -> [DataDeclaration] -> ProperName 'TypeName -> [(Text, Maybe SourceType)] -> [Role]
- type Unknown = Int
- data CheckState = CheckState {
- checkEnv :: Environment
- checkNextType :: Int
- checkNextSkolem :: Int
- checkNextSkolemScope :: Int
- checkCurrentModule :: Maybe ModuleName
- checkCurrentModuleImports :: [(SourceAnn, ModuleName, ImportDeclarationType, Maybe ModuleName, Map (ProperName 'TypeName) ([ProperName 'ConstructorName], ExportSource))]
- checkSubstitution :: Substitution
- checkHints :: [ErrorMessageHint]
- checkConstructorImportsForCoercible :: Set (ModuleName, Qualified (ProperName 'ConstructorName))
- data Substitution = Substitution {
- substType :: Map Int SourceType
- substUnsolved :: Map Int (UnkLevel, SourceType)
- substNames :: Map Int Text
- newtype UnkLevel = UnkLevel (NonEmpty Unknown)
- insertUnkName :: MonadState CheckState m => Unknown -> Text -> m ()
- lookupUnkName :: MonadState CheckState m => Unknown -> m (Maybe Text)
- emptySubstitution :: Substitution
- emptyCheckState :: Environment -> CheckState
- bindNames :: MonadState CheckState m => Map (Qualified Ident) (SourceType, NameKind, NameVisibility) -> m a -> m a
- bindTypes :: MonadState CheckState m => Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) -> m a -> m a
- withScopedTypeVars :: (MonadState CheckState m, MonadWriter MultipleErrors m) => ModuleName -> [(Text, SourceType)] -> m a -> m a
- withErrorMessageHint :: (MonadState CheckState m, MonadError MultipleErrors m) => ErrorMessageHint -> m a -> m a
- getHints :: MonadState CheckState m => m [ErrorMessageHint]
- rethrowWithPositionTC :: (MonadState CheckState m, MonadError MultipleErrors m) => SourceSpan -> m a -> m a
- warnAndRethrowWithPositionTC :: (MonadState CheckState m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => SourceSpan -> m a -> m a
- withTypeClassDictionaries :: MonadState CheckState m => [NamedDict] -> m a -> m a
- getTypeClassDictionaries :: MonadState CheckState m => m (Map QualifiedBy (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict))))
- lookupTypeClassDictionaries :: MonadState CheckState m => QualifiedBy -> m (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))
- lookupTypeClassDictionariesForClass :: MonadState CheckState m => QualifiedBy -> Qualified (ProperName 'ClassName) -> m (Map (Qualified Ident) (NonEmpty NamedDict))
- bindLocalVariables :: MonadState CheckState m => [(SourceSpan, Ident, SourceType, NameVisibility)] -> m a -> m a
- bindLocalTypeVariables :: MonadState CheckState m => ModuleName -> [(ProperName 'TypeName, SourceType)] -> m a -> m a
- makeBindingGroupVisible :: MonadState CheckState m => m ()
- withBindingGroupVisible :: MonadState CheckState m => m a -> m a
- preservingNames :: MonadState CheckState m => m a -> m a
- lookupVariable :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => Qualified Ident -> m SourceType
- getVisibility :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => Qualified Ident -> m NameVisibility
- checkVisibility :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => Qualified Ident -> m ()
- lookupTypeVariable :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => ModuleName -> Qualified (ProperName 'TypeName) -> m SourceType
- getEnv :: MonadState CheckState m => m Environment
- getLocalContext :: MonadState CheckState m => m Context
- putEnv :: MonadState CheckState m => Environment -> m ()
- modifyEnv :: MonadState CheckState m => (Environment -> Environment) -> m ()
- runCheck :: Functor m => CheckState -> StateT CheckState m a -> m (a, Environment)
- guardWith :: MonadError e m => e -> Bool -> m ()
- capturingSubstitution :: MonadState CheckState m => (a -> Substitution -> b) -> m a -> m b
- withFreshSubstitution :: MonadState CheckState m => m a -> m a
- withoutWarnings :: MonadWriter w m => m a -> m (a, w)
- unsafeCheckCurrentModule :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => m ModuleName
- debugEnv :: Environment -> [String]
- debugType :: Type a -> String
- debugConstraint :: Constraint a -> String
- debugTypes :: Environment -> [String]
- debugNames :: Environment -> [String]
- debugDataConstructors :: Environment -> [String]
- debugTypeSynonyms :: Environment -> [String]
- debugTypeClassDictionaries :: Environment -> [String]
- debugTypeClasses :: Environment -> [String]
- debugValue :: Expr -> String
- debugSubstitution :: Substitution -> [String]
- type KindMap = Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind)
- type SynonymMap = Map (Qualified (ProperName 'TypeName)) ([(Text, Maybe SourceType)], SourceType)
- replaceAllTypeSynonyms :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => SourceType -> m SourceType
- replaceAllTypeSynonymsM :: MonadError MultipleErrors m => SynonymMap -> KindMap -> SourceType -> m SourceType
- freshKind :: MonadState CheckState m => SourceSpan -> m SourceType
- freshKindWithKind :: MonadState CheckState m => SourceSpan -> SourceType -> m SourceType
- unknownsWithKinds :: forall m. (MonadState CheckState m, MonadError MultipleErrors m, HasCallStack) => [Unknown] -> m [(Unknown, SourceType)]
- inferKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (SourceType, SourceType)
- checkKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m SourceType
- instantiateKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => (SourceType, SourceType) -> SourceType -> m SourceType
- subsumesKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m ()
- unifyKinds :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m ()
- unifyKinds' :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m ()
- checkTypeKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m ()
- elaborateKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m SourceType
- kindOfWithUnknowns :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (([(Unknown, SourceType)], SourceType), SourceType)
- kindOf :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (SourceType, SourceType)
- kindOfWithScopedVars :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (([(Text, SourceType)], SourceType), SourceType)
- kindOfData :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> DataDeclarationArgs -> m DataDeclarationResult
- kindOfTypeSynonym :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> TypeDeclarationArgs -> m TypeDeclarationResult
- kindOfClass :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> ClassDeclarationArgs -> m ClassDeclarationResult
- checkConstraint :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => SourceConstraint -> m SourceConstraint
- checkInstanceDeclaration :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> InstanceDeclarationArgs -> m InstanceDeclarationResult
- checkKindDeclaration :: forall m. (MonadSupply m, MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> SourceType -> m SourceType
- kindsOfAll :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> [TypeDeclarationArgs] -> [DataDeclarationArgs] -> [ClassDeclarationArgs] -> m ([TypeDeclarationResult], [DataDeclarationResult], [ClassDeclarationResult])
- desugarTypeDeclarationsModule :: forall m. MonadError MultipleErrors m => Module -> m Module
- desugarObjectConstructors :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module
- desugarDecl :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Declaration -> m Declaration
- type Env = Map ModuleName (SourceSpan, Imports, Exports)
- data Exports = Exports {
- exportedTypes :: Map (ProperName 'TypeName) ([ProperName 'ConstructorName], ExportSource)
- exportedTypeOps :: Map (OpName 'TypeOpName) ExportSource
- exportedTypeClasses :: Map (ProperName 'ClassName) ExportSource
- exportedValues :: Map Ident ExportSource
- exportedValueOps :: Map (OpName 'ValueOpName) ExportSource
- data Imports = Imports {
- importedTypes :: ImportMap (ProperName 'TypeName)
- importedTypeOps :: ImportMap (OpName 'TypeOpName)
- importedDataConstructors :: ImportMap (ProperName 'ConstructorName)
- importedTypeClasses :: ImportMap (ProperName 'ClassName)
- importedValues :: ImportMap Ident
- importedValueOps :: ImportMap (OpName 'ValueOpName)
- importedModules :: Set ModuleName
- importedQualModules :: Set ModuleName
- importedKinds :: ImportMap (ProperName 'TypeName)
- data ImportProvenance
- data ImportRecord a = ImportRecord {}
- primEnv :: Env
- desugarDoModule :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module
- desugarCasesModule :: (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module
- desugarCaseGuards :: forall m. (MonadSupply m, MonadError MultipleErrors m) => [Declaration] -> m [Declaration]
- desugarCases :: forall m. (MonadSupply m, MonadError MultipleErrors m) => [Declaration] -> m [Declaration]
- createBindingGroupsModule :: MonadError MultipleErrors m => Module -> m Module
- createBindingGroups :: forall m. MonadError MultipleErrors m => ModuleName -> [Declaration] -> m [Declaration]
- collapseBindingGroups :: [Declaration] -> [Declaration]
- desugarAdoModule :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module
- data DependencyDepth
- = Direct
- | Transitive
- data ModuleSignature = ModuleSignature {}
- type ModuleGraph = [(ModuleName, [ModuleName])]
- sortModules :: forall m a. MonadError MultipleErrors m => DependencyDepth -> (a -> ModuleSignature) -> [a] -> m ([a], ModuleGraph)
- moduleSignature :: Module -> ModuleSignature
- type UsedImports = Map ModuleName [Qualified Name]
- lintImports :: forall m. MonadWriter MultipleErrors m => Module -> Env -> UsedImports -> m ()
- checkExhaustiveExpr :: forall m. MonadWriter MultipleErrors m => SourceSpan -> Environment -> ModuleName -> Expr -> m Expr
- lint :: forall m. MonadWriter MultipleErrors m => Module -> m ()
- renameInModule :: Module Ann -> (Map Ident Ident, Module Ann)
- data ExternsDeclaration
- = EDType { }
- | EDTypeSynonym { }
- | EDDataConstructor { }
- | EDValue { }
- | EDClass { }
- | EDInstance {
- edInstanceClassName :: Qualified (ProperName 'ClassName)
- edInstanceName :: Ident
- edInstanceForAll :: [(Text, SourceType)]
- edInstanceKinds :: [SourceType]
- edInstanceTypes :: [SourceType]
- edInstanceConstraints :: Maybe [SourceConstraint]
- edInstanceChain :: Maybe ChainId
- edInstanceChainIndex :: Integer
- edInstanceNameSource :: NameSource
- edInstanceSourceSpan :: SourceSpan
- data ExternsTypeFixity = ExternsTypeFixity {}
- data ExternsFixity = ExternsFixity {}
- data ExternsImport = ExternsImport {}
- data ExternsFile = ExternsFile {}
- externsIsCurrentVersion :: ExternsFile -> Bool
- applyExternsFileToEnvironment :: ExternsFile -> Environment -> Environment
- moduleToExternsFile :: Module -> Environment -> Map Ident Ident -> ExternsFile
- externsFileName :: FilePath
- desugarTypeClasses :: (MonadSupply m, MonadError MultipleErrors m) => [ExternsFile] -> Module -> m Module
- typeClassMemberName :: Declaration -> Text
- superClassDictionaryNames :: [Constraint a] -> [Text]
- data BindingGroupType
- typesOf :: (MonadSupply m, MonadState CheckState m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => BindingGroupType -> ModuleName -> [((SourceAnn, Ident), Expr)] -> m [((SourceAnn, Ident), (Expr, SourceType))]
- checkNewtype :: forall m. MonadError MultipleErrors m => ProperName 'TypeName -> [DataConstructorDeclaration] -> m (DataConstructorDeclaration, (Ident, SourceType))
- typeCheckModule :: forall m. (MonadSupply m, MonadState CheckState m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => Map ModuleName Exports -> Module -> m Module
- deriveInstances :: forall m. (MonadError MultipleErrors m, MonadSupply m) => Module -> m Module
- data RebracketCaller
- desugarSignedLiterals :: Module -> Module
- rebracket :: forall m. MonadError MultipleErrors m => MonadSupply m => [ExternsFile] -> Module -> m Module
- rebracketFiltered :: forall m. MonadError MultipleErrors m => MonadSupply m => RebracketCaller -> (Declaration -> Bool) -> [ExternsFile] -> Module -> m Module
- checkFixityExports :: forall m. MonadError MultipleErrors m => Module -> m Module
- desugarImports :: forall m. (MonadError MultipleErrors m, MonadWriter MultipleErrors m, MonadState (Env, UsedImports) m) => Module -> m Module
- externsEnv :: forall m. (MonadError MultipleErrors m, MonadWriter MultipleErrors m) => Env -> ExternsFile -> m Env
- desugar :: MonadSupply m => MonadError MultipleErrors m => MonadWriter MultipleErrors m => MonadState (Env, UsedImports) m => [ExternsFile] -> Module -> m Module
- newtype Make a = Make {}
- runMake :: Options -> Make a -> IO (Either MultipleErrors a, MultipleErrors)
- makeIO :: (MonadIO m, MonadError MultipleErrors m) => Text -> IO a -> m a
- getTimestamp :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m UTCTime
- getTimestampMaybe :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m (Maybe UTCTime)
- readTextFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m Text
- readJSONFile :: (MonadIO m, MonadError MultipleErrors m) => FromJSON a => FilePath -> m (Maybe a)
- readJSONFileIO :: FromJSON a => FilePath -> IO (Maybe a)
- readCborFile :: (MonadIO m, MonadError MultipleErrors m) => Serialise a => FilePath -> m (Maybe a)
- readCborFileIO :: Serialise a => FilePath -> IO (Maybe a)
- readExternsFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m (Maybe ExternsFile)
- hashFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m ContentHash
- writeTextFile :: FilePath -> ByteString -> Make ()
- writeJSONFile :: (MonadIO m, MonadError MultipleErrors m) => ToJSON a => FilePath -> a -> m ()
- writeCborFile :: (MonadIO m, MonadError MultipleErrors m) => Serialise a => FilePath -> a -> m ()
- writeCborFileIO :: Serialise a => FilePath -> a -> IO ()
- copyFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> FilePath -> m ()
- data MakeActions m = MakeActions {
- getInputTimestampsAndHashes :: ModuleName -> m (Either RebuildPolicy (Map FilePath (UTCTime, m ContentHash)))
- getOutputTimestamp :: ModuleName -> m (Maybe UTCTime)
- readExterns :: ModuleName -> m (FilePath, Maybe ExternsFile)
- codegen :: Module Ann -> Module -> ExternsFile -> SupplyT m ()
- ffiCodegen :: Module Ann -> m ()
- progress :: ProgressMessage -> m ()
- readCacheDb :: m CacheDb
- writeCacheDb :: CacheDb -> m ()
- writePackageJson :: m ()
- outputPrimDocs :: m ()
- data ProgressMessage = CompilingModule ModuleName (Maybe (Int, Int))
- data RebuildPolicy
- renderProgressMessage :: Text -> ProgressMessage -> Text
- cacheDbFile :: FilePath -> FilePath
- readCacheDb' :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m CacheDb
- writeCacheDb' :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> CacheDb -> m ()
- buildMakeActions :: FilePath -> Map ModuleName (Either RebuildPolicy FilePath) -> Map ModuleName FilePath -> Bool -> MakeActions Make
- checkForeignDecls :: Module ann -> FilePath -> Make (Either MultipleErrors (ForeignModuleType, Set Ident))
- ffiCodegen' :: Map ModuleName FilePath -> Set CodegenTarget -> Maybe (ModuleName -> String -> FilePath) -> Module Ann -> Make ()
- rebuildModule :: forall m. (MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> [ExternsFile] -> Module -> m ExternsFile
- rebuildModule' :: forall m. (MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> Env -> [ExternsFile] -> Module -> m ExternsFile
- make :: forall m. (MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> [PartialResult Module] -> m [ExternsFile]
- inferForeignModules :: forall m. MonadIO m => Map ModuleName (Either RebuildPolicy FilePath) -> m (Map ModuleName FilePath)
- graph :: [FilePath] -> IO (Either MultipleErrors Value, MultipleErrors)
- version :: Version
Documentation
A space efficient, packed, unboxed Unicode text type.
Instances
type HasCallStack = ?callStack :: CallStack #
Request a CallStack.
NOTE: The implicit parameter ?callStack :: CallStack is an
implementation detail and should not be considered part of the
CallStack API, we may decide to change the implementation in the
future.
Since: base-4.9.0.0
Instances
| MonadTrans SupplyT Source # | |
Defined in Control.Monad.Supply | |
| MonadError e m => MonadError e (SupplyT m) Source # | |
Defined in Control.Monad.Supply Methods throwError :: e -> SupplyT m a # catchError :: SupplyT m a -> (e -> SupplyT m a) -> SupplyT m a # | |
| MonadReader r m => MonadReader r (SupplyT m) Source # | |
| MonadWriter w m => MonadWriter w (SupplyT m) Source # | |
| MonadPlus m => Alternative (SupplyT m) Source # | |
| Monad m => Applicative (SupplyT m) Source # | |
| Functor m => Functor (SupplyT m) Source # | |
| Monad m => Monad (SupplyT m) Source # | |
| MonadPlus m => MonadPlus (SupplyT m) Source # | |
| Monad m => MonadSupply (SupplyT m) Source # | |
Constructors
| LineComment Text | |
| BlockComment Text |
Instances
data SourceSpan Source #
Constructors
| SourceSpan | |
Instances
Source position information
Constructors
| SourcePos | |
Fields
| |
Instances
| FromJSON SourcePos Source # | |
| ToJSON SourcePos Source # | |
Defined in Language.PureScript.AST.SourcePos | |
| Generic SourcePos Source # | |
| Show SourcePos Source # | |
| NFData SourcePos Source # | |
Defined in Language.PureScript.AST.SourcePos | |
| Eq SourcePos Source # | |
| Ord SourcePos Source # | |
Defined in Language.PureScript.AST.SourcePos | |
| Serialise SourcePos Source # | |
| type Rep SourcePos Source # | |
Defined in Language.PureScript.AST.SourcePos type Rep SourcePos = D1 ('MetaData "SourcePos" "Language.PureScript.AST.SourcePos" "purescript-0.15.9-73KndBh0GamC7RCYwFLhcE" 'False) (C1 ('MetaCons "SourcePos" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourcePosLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "sourcePosColumn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) | |
type SourceAnn = (SourceSpan, [Comment]) Source #
Source annotation - position information and comments.
pattern NullSourceAnn :: SourceAnn Source #
pattern NullSourceSpan :: SourceSpan Source #
displaySourcePos :: SourcePos -> Text Source #
displayStartEndPos :: SourceSpan -> Text Source #
displaySourceSpan :: FilePath -> SourceSpan -> Text Source #
nonEmptySpan :: SourceAnn -> Maybe SourceSpan Source #
widenSourceSpan :: SourceSpan -> SourceSpan -> SourceSpan Source #
internalError :: HasCallStack => String -> a Source #
Exit with an error message and a crash report link.
Fixity data for infix operators
Constructors
| Fixity Associativity Precedence |
Instances
| ToJSON Fixity Source # | |
Defined in Language.PureScript.AST.Operators | |
| Generic Fixity Source # | |
| Show Fixity Source # | |
| NFData Fixity Source # | |
Defined in Language.PureScript.AST.Operators | |
| Eq Fixity Source # | |
| Ord Fixity Source # | |
| Serialise Fixity Source # | |
| type Rep Fixity Source # | |
Defined in Language.PureScript.AST.Operators type Rep Fixity = D1 ('MetaData "Fixity" "Language.PureScript.AST.Operators" "purescript-0.15.9-73KndBh0GamC7RCYwFLhcE" 'False) (C1 ('MetaCons "Fixity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Associativity) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Precedence))) | |
data Associativity Source #
Associativity for infix operators
Instances
type Precedence = Integer Source #
A precedence level for an infix operator
showAssoc :: Associativity -> String Source #
readAssoc :: String -> Associativity Source #
A qualified name, i.e. a name with an optional module name
Constructors
| Qualified QualifiedBy a |
Instances
data QualifiedBy Source #
Constructors
| BySourcePos SourcePos | |
| ByModuleName ModuleName |
Instances
newtype ModuleName Source #
Module names
Constructors
| ModuleName Text |
Instances
data ProperNameType Source #
The closed set of proper name types.
Constructors
| TypeName | |
| ConstructorName | |
| ClassName | |
| Namespace |
newtype ProperName (a :: ProperNameType) Source #
Proper names, i.e. capitalized names for e.g. module names, type//data constructors.
Constructors
| ProperName | |
Fields | |
Instances
data OpNameType Source #
The closed set of operator alias types.
Constructors
| ValueOpName | |
| TypeOpName | |
| AnyOpName |
newtype OpName (a :: OpNameType) Source #
Operator alias names.
Instances
| FromJSON (OpName a) Source # | |
| ToJSON (OpName a) Source # | |
Defined in Language.PureScript.Names | |
| Generic (OpName a) Source # | |
| Show (OpName a) Source # | |
| NFData (OpName a) Source # | |
Defined in Language.PureScript.Names | |
| Eq (OpName a) Source # | |
| Ord (OpName a) Source # | |
Defined in Language.PureScript.Names | |
| Serialise (OpName a) Source # | |
| type Rep (OpName a) Source # | |
Defined in Language.PureScript.Names | |
Names for value identifiers
Constructors
| Ident Text | An alphanumeric identifier |
| GenIdent (Maybe Text) Integer | A generated name for an identifier |
| UnusedIdent | A generated name used only for type-checking |
| InternalIdent !InternalIdentData | A generated name used only for internal transformations |
Instances
data InternalIdentData Source #
This type is meant to be extended with any new uses for idents that come
along. Adding constructors to this type is cheaper than adding them to
Ident because functions that match on Ident can ignore all
InternalIdents with a single pattern, and thus don't have to change if
a new InternalIdentData constructor is created.
Constructors
| RuntimeLazyFactory | |
| Lazy !Text |
Instances
A sum of the possible name types, useful for error and lint messages.
Constructors
Instances
pattern ByNullSourcePos :: QualifiedBy Source #
getValOpName :: Name -> Maybe (OpName 'ValueOpName) Source #
getTypeName :: Name -> Maybe (ProperName 'TypeName) Source #
getTypeOpName :: Name -> Maybe (OpName 'TypeOpName) Source #
getDctorName :: Name -> Maybe (ProperName 'ConstructorName) Source #
getClassName :: Name -> Maybe (ProperName 'ClassName) Source #
unusedIdent :: Text Source #
freshIdent :: MonadSupply m => Text -> m Ident Source #
freshIdent' :: MonadSupply m => m Ident Source #
isPlainIdent :: Ident -> Bool Source #
coerceOpName :: OpName a -> OpName b Source #
coerceProperName :: ProperName a -> ProperName b Source #
Coerces a ProperName from one ProperNameType to another. This should be used with care, and is primarily used to convert ClassNames into TypeNames after classes have been desugared.
runModuleName :: ModuleName -> Text Source #
isBuiltinModuleName :: ModuleName -> Bool Source #
isBySourcePos :: QualifiedBy -> Bool Source #
qualify :: ModuleName -> Qualified a -> (ModuleName, a) Source #
Provide a default module name, if a name is unqualified
mkQualified :: a -> ModuleName -> Qualified a Source #
Makes a qualified value from a name and module name.
disqualify :: Qualified a -> a Source #
Remove the module name from a qualified name
disqualifyFor :: Maybe ModuleName -> Qualified a -> Maybe a Source #
Remove the qualification from a value when it is qualified with a particular module name.
isQualified :: Qualified a -> Bool Source #
Checks whether a qualified value is actually qualified with a module reference
isUnqualified :: Qualified a -> Bool Source #
Checks whether a qualified value is not actually qualified with a module reference
isQualifiedWith :: ModuleName -> Qualified a -> Bool Source #
Checks whether a qualified value is qualified with a particular module
data CodegenTarget Source #
Constructors
| JS | |
| JSSourceMap | |
| CoreFn | |
| Docs |
Instances
| Show CodegenTarget Source # | |
Defined in Language.PureScript.Options Methods showsPrec :: Int -> CodegenTarget -> ShowS # show :: CodegenTarget -> String # showList :: [CodegenTarget] -> ShowS # | |
| Eq CodegenTarget Source # | |
Defined in Language.PureScript.Options Methods (==) :: CodegenTarget -> CodegenTarget -> Bool # (/=) :: CodegenTarget -> CodegenTarget -> Bool # | |
| Ord CodegenTarget Source # | |
Defined in Language.PureScript.Options Methods compare :: CodegenTarget -> CodegenTarget -> Ordering # (<) :: CodegenTarget -> CodegenTarget -> Bool # (<=) :: CodegenTarget -> CodegenTarget -> Bool # (>) :: CodegenTarget -> CodegenTarget -> Bool # (>=) :: CodegenTarget -> CodegenTarget -> Bool # max :: CodegenTarget -> CodegenTarget -> CodegenTarget # min :: CodegenTarget -> CodegenTarget -> CodegenTarget # | |
The data type of compiler options
Constructors
| Options | |
Fields
| |
prettyPrintString :: PSString -> Text Source #
Pretty print a PSString, using PureScript escape sequences.
Data type for literal values. Parameterised so it can be used for Exprs and Binders.
Constructors
| NumericLiteral (Either Integer Double) | A numeric literal |
| StringLiteral PSString | A string literal |
| CharLiteral Char | A character literal |
| BooleanLiteral Bool | A boolean literal |
| ArrayLiteral [a] | An array literal |
| ObjectLiteral [(PSString, a)] | An object literal |
Instances
| Functor Literal Source # | |
| Show a => Show (Literal a) Source # | |
| Eq a => Eq (Literal a) Source # | |
| Ord a => Ord (Literal a) Source # | |
Defined in Language.PureScript.AST.Literals | |
The role of a type constructor's parameter.
Constructors
| Nominal | This parameter's identity affects the representation of the type it is parameterising. |
| Representational | This parameter's representation affects the representation of the type it is parameterising. |
| Phantom | This parameter has no effect on the representation of the type it is parameterising. |
Instances
| FromJSON Role Source # | |
| ToJSON Role Source # | |
Defined in Language.PureScript.Roles | |
| Generic Role Source # | |
| Show Role Source # | |
| NFData Role Source # | |
Defined in Language.PureScript.Roles | |
| Eq Role Source # | |
| Ord Role Source # | |
| Serialise Role Source # | |
| type Rep Role Source # | |
Defined in Language.PureScript.Roles type Rep Role = D1 ('MetaData "Role" "Language.PureScript.Roles" "purescript-0.15.9-73KndBh0GamC7RCYwFLhcE" 'False) (C1 ('MetaCons "Nominal" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Representational" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Phantom" 'PrefixI 'False) (U1 :: Type -> Type))) | |
displayRole :: Role -> Text Source #
data RowListItem a Source #
Constructors
| RowListItem | |
Fields
| |
Instances
data Constraint a Source #
A typeclass constraint
Constructors
| Constraint | |
Fields
| |
Instances
data ConstraintData Source #
Additional data relevant to type class constraints
Constructors
| PartialConstraintData [[Text]] Bool | Data to accompany a Partial constraint generated by the exhaustivity checker.
It contains (rendered) binder information for those binders which were
not matched, and a flag indicating whether the list was truncated or not.
Note: we use |
Instances
The type of types
Constructors
| TUnknown a Int | A unification variable of type Type |
| TypeVar a Text | A named type variable |
| TypeLevelString a PSString | A type-level string |
| TypeLevelInt a Integer | A type-level natural |
| TypeWildcard a WildcardData | A type wildcard, as would appear in a partial type synonym |
| TypeConstructor a (Qualified (ProperName 'TypeName)) | A type constructor |
| TypeOp a (Qualified (OpName 'TypeOpName)) | A type operator. This will be desugared into a type constructor during the "operators" phase of desugaring. |
| TypeApp a (Type a) (Type a) | A type application |
| KindApp a (Type a) (Type a) | Explicit kind application |
| ForAll a Text (Maybe (Type a)) (Type a) (Maybe SkolemScope) | Forall quantifier |
| ConstrainedType a (Constraint a) (Type a) | A type with a set of type class constraints |
| Skolem a Text (Maybe (Type a)) Int SkolemScope | A skolem constant |
| REmpty a | An empty row |
| RCons a Label (Type a) (Type a) | A non-empty row |
| KindedType a (Type a) (Type a) | A type with a kind annotation |
| BinaryNoParensType a (Type a) (Type a) (Type a) | Binary operator application. During the rebracketing phase of desugaring, this data constructor will be removed. |
| ParensInType a (Type a) | Explicit parentheses. During the rebracketing phase of desugaring, this data constructor will be removed. Note: although it seems this constructor is not used, it _is_ useful, since it prevents certain traversals from matching. |
Instances
data WildcardData Source #
Describes how a TypeWildcard should be presented to the user during type checking: holes (?foo) are always emitted as errors, whereas unnamed wildcards (_) default to warnings, but are ignored entirely if they are contained by a binding with a complete (wildcard-free) type signature.
Constructors
| HoleWildcard Text | |
| UnnamedWildcard | |
| IgnoredWildcard |
Instances
newtype SkolemScope Source #
An identifier for the scope of a skolem variable
Constructors
| SkolemScope | |
Fields | |
Instances
type SourceConstraint = Constraint SourceAnn Source #
type SourceType = Type SourceAnn Source #
srcTUnknown :: Int -> SourceType Source #
srcTypeVar :: Text -> SourceType Source #
srcTypeLevelInt :: Integer -> SourceType Source #
srcTypeApp :: SourceType -> SourceType -> SourceType Source #
srcKindApp :: SourceType -> SourceType -> SourceType Source #
srcForAll :: Text -> Maybe SourceType -> SourceType -> Maybe SkolemScope -> SourceType Source #
srcRCons :: Label -> SourceType -> SourceType -> SourceType Source #
srcKindedType :: SourceType -> SourceType -> SourceType Source #
srcConstraint :: Qualified (ProperName 'ClassName) -> [SourceType] -> [SourceType] -> Maybe ConstraintData -> SourceConstraint Source #
mapConstraintArgs :: ([Type a] -> [Type a]) -> Constraint a -> Constraint a Source #
overConstraintArgs :: Functor f => ([Type a] -> f [Type a]) -> Constraint a -> f (Constraint a) Source #
mapConstraintArgsAll :: ([Type a] -> [Type a]) -> Constraint a -> Constraint a Source #
overConstraintArgsAll :: Applicative f => ([Type a] -> f [Type a]) -> Constraint a -> f (Constraint a) Source #
constraintToJSON :: (a -> Value) -> Constraint a -> Value Source #
constraintFromJSON :: forall a. Parser a -> (Value -> Parser a) -> Value -> Parser (Constraint a) Source #
srcRowListItem :: Label -> SourceType -> RowListItem SourceAnn Source #
rowToList :: Type a -> ([RowListItem a], Type a) Source #
Convert a row to a list of pairs of labels and types
rowToSortedList :: Type a -> ([RowListItem a], Type a) Source #
Convert a row to a list of pairs of labels and types, sorted by the labels.
rowFromList :: ([RowListItem a], Type a) -> Type a Source #
Convert a list of labels and types to a row
alignRowsWith :: (Label -> Type a -> Type a -> r) -> Type a -> Type a -> ([r], (([RowListItem a], Type a), ([RowListItem a], Type a))) Source #
Align two rows of types, splitting them into three parts:
- Those types which appear in both rows
- Those which appear only on the left
- Those which appear only on the right
Note: importantly, we preserve the order of the types with a given label.
isMonoType :: Type a -> Bool Source #
Check whether a type is a monotype
replaceTypeVars :: Text -> Type a -> Type a -> Type a Source #
Replace a type variable, taking into account variable shadowing
replaceAllTypeVars :: [(Text, Type a)] -> Type a -> Type a Source #
Replace named type variables with types
usedTypeVariables :: Type a -> [Text] Source #
Collect all type variables appearing in a type
freeTypeVariables :: Type a -> [Text] Source #
Collect all free type variables appearing in a type
completeBinderList :: Type a -> Maybe ([(a, (Text, Type a))], Type a) Source #
Collect a complete set of kind-annotated quantifiers at the front of a type.
quantify :: Type a -> Type a Source #
Universally quantify over all type variables appearing free in a type
moveQuantifiersToFront :: Type a -> Type a Source #
Move all universal quantifiers to the front of a type
containsForAll :: Type a -> Bool Source #
Check if a type contains forall
containsUnknowns :: Type a -> Bool Source #
Check if a type contains unknowns in a position that is relevant to constraint solving. (Kinds are not.)
eraseKindApps :: Type a -> Type a Source #
eraseForAllKindAnnotations :: Type a -> Type a Source #
unapplyConstraints :: Type a -> ([Constraint a], Type a) Source #
srcInstanceType :: SourceSpan -> [(Text, SourceType)] -> Qualified (ProperName 'ClassName) -> [SourceType] -> SourceType Source #
Construct the type of an instance declaration from its parts. Used in error messages describing unnamed instances.
everythingOnTypes :: (r -> r -> r) -> (Type a -> r) -> Type a -> r Source #
everythingWithContextOnTypes :: s -> r -> (r -> r -> r) -> (s -> Type a -> (s, r)) -> Type a -> r Source #
annForType :: Lens' (Type a) a Source #
getAnnForType :: Type a -> a Source #
setAnnForType :: a -> Type a -> Type a Source #
eqConstraint :: Constraint a -> Constraint b -> Bool Source #
compareConstraint :: Constraint a -> Constraint b -> Ordering Source #
data DataDeclType Source #
The type ('data' or 'newtype') of a data type declaration
Instances
The kinds of a type
Constructors
| DataType DataDeclType [(Text, Maybe SourceType, Role)] [(ProperName 'ConstructorName, [SourceType])] | Data type |
| TypeSynonym | Type synonym |
| ExternData [Role] | Foreign data |
| LocalTypeVariable | A local type variable |
| ScopedTypeVar | A scoped type variable |
Instances
A flag for whether a name is for an private or public value - only public values will be included in a generated externs file.
Constructors
| Private | A private value introduced as an artifact of code generation (class instances, class member accessors, etc.) |
| Public | A public value for a module member or foreign import declaration |
| External | A name for member introduced by foreign import |
Instances
| Generic NameKind Source # | |
| Show NameKind Source # | |
| NFData NameKind Source # | |
Defined in Language.PureScript.Environment | |
| Eq NameKind Source # | |
| Serialise NameKind Source # | |
| type Rep NameKind Source # | |
Defined in Language.PureScript.Environment type Rep NameKind = D1 ('MetaData "NameKind" "Language.PureScript.Environment" "purescript-0.15.9-73KndBh0GamC7RCYwFLhcE" 'False) (C1 ('MetaCons "Private" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Public" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "External" 'PrefixI 'False) (U1 :: Type -> Type))) | |
data NameVisibility Source #
The visibility of a name in scope
Constructors
| Undefined | The name is defined in the current binding group, but is not visible |
| Defined | The name is defined in the another binding group, or has been made visible by a function binder |
Instances
data FunctionalDependency Source #
A functional dependency indicates a relationship between two sets of type arguments in a class declaration.
Constructors
| FunctionalDependency | |
Fields
| |
Instances
data TypeClassData Source #
Information about a type class
Constructors
| TypeClassData | |
Fields
| |
Instances
data Environment Source #
The Environment defines all values and types which are currently in scope:
Constructors
| Environment | |
Fields
| |
Instances
initEnvironment :: Environment Source #
The initial environment with no values and only the default javascript types defined
makeTypeClassData :: [(Text, Maybe SourceType)] -> [(Ident, SourceType)] -> [SourceConstraint] -> [FunctionalDependency] -> Bool -> TypeClassData Source #
A constructor for TypeClassData that computes which type class arguments are fully determined and argument covering sets. Fully determined means that this argument cannot be used when selecting a type class instance. A covering set is a minimal collection of arguments that can be used to find an instance and therefore determine all other type arguments.
An example of the difference between determined and fully determined would be with the class:
```class C a b c | a -> b, b -> a, b -> c```
In this case, a must differ when b differs, and vice versa - each is determined by the other.
Both a and b can be used in selecting a type class instance. However, c cannot - it is
fully determined by a and b.
Define a graph of type class arguments with edges being fundep determiners to determined. Each argument also has a self looping edge. An argument is fully determined if doesn't appear at the start of a path of strongly connected components. An argument is not fully determined otherwise.
The way we compute this is by saying: an argument X is fully determined if there are arguments that determine X that X does not determine. This is the same thing: everything X determines includes everything in its SCC, and everything determining X is either before it in an SCC path, or in the same SCC.
computeCoveringSets :: Int -> [FunctionalDependency] -> (Set Int, Set (Set Int)) Source #
showDataDeclType :: DataDeclType -> Text Source #
kindType :: SourceType Source #
Kind of ground types
kindDoc :: SourceType Source #
kindRowList :: SourceType -> SourceType Source #
kindRow :: SourceType -> SourceType Source #
tyFunction :: SourceType Source #
Type constructor for functions
tyString :: SourceType Source #
Type constructor for strings
tyChar :: SourceType Source #
Type constructor for strings
tyNumber :: SourceType Source #
Type constructor for numbers
tyInt :: SourceType Source #
Type constructor for integers
tyBoolean :: SourceType Source #
Type constructor for booleans
tyArray :: SourceType Source #
Type constructor for arrays
tyRecord :: SourceType Source #
Type constructor for records
tyVar :: Text -> SourceType Source #
tyForall :: Text -> SourceType -> SourceType -> SourceType Source #
function :: SourceType -> SourceType -> SourceType Source #
Smart constructor for function types
(-:>) :: SourceType -> SourceType -> SourceType infixr 4 Source #
primClass :: Qualified (ProperName 'ClassName) -> (SourceType -> SourceType) -> [(Qualified (ProperName 'TypeName), (SourceType, TypeKind))] Source #
primTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
The primitive types in the external environment with their
associated kinds. There are also pseudo Fail, Warn, and Partial types
that correspond to the classes with the same names.
allPrimTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
This Map contains all of the prim types from all Prim modules.
primBooleanTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primCoerceTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primOrderingTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primRowTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primRowListTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primSymbolTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primIntTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primTypeErrorTypes :: Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
primClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData Source #
The primitive class map. This just contains the Partial class.
Partial is used as a kind of magic constraint for partial functions.
allPrimClasses :: Map (Qualified (ProperName 'ClassName)) TypeClassData Source #
This contains all of the type classes from all Prim modules.
lookupConstructor :: Environment -> Qualified (ProperName 'ConstructorName) -> (DataDeclType, ProperName 'TypeName, SourceType, [Ident]) Source #
Finds information about data constructors from the current environment.
lookupValue :: Environment -> Qualified Ident -> Maybe (SourceType, NameKind, NameVisibility) Source #
Finds information about values from the current environment.
dictTypeName' :: Text -> Text Source #
dictTypeName :: ProperName a -> ProperName a Source #
isDictTypeName :: ProperName a -> Bool Source #
nominalRolesForKind :: Type a -> [Role] Source #
Given the kind of a type, generate a list Nominal roles. This is used for
opaque foreign types as well as type classes.
Data type for binders
Constructors
| NullBinder | Wildcard binder |
| LiteralBinder SourceSpan (Literal Binder) | A binder which matches a literal |
| VarBinder SourceSpan Ident | A binder which binds an identifier |
| ConstructorBinder SourceSpan (Qualified (ProperName 'ConstructorName)) [Binder] | A binder which matches a data constructor |
| OpBinder SourceSpan (Qualified (OpName 'ValueOpName)) | A operator alias binder. During the rebracketing phase of desugaring, this data constructor will be removed. |
| BinaryNoParensBinder Binder Binder Binder | Binary operator application. During the rebracketing phase of desugaring, this data constructor will be removed. |
| ParensInBinder Binder | Explicit parentheses. During the rebracketing phase of desugaring, this data constructor will be removed. Note: although it seems this constructor is not used, it _is_ useful, since it prevents certain traversals from matching. |
| NamedBinder SourceSpan Ident Binder | A binder which binds its input to an identifier |
| PositionedBinder SourceSpan [Comment] Binder | A binder with source position information |
| TypedBinder SourceType Binder | A binder with a type annotation |
binderNames :: Binder -> [Ident] Source #
Collect all names introduced in binders in an expression
binderNamesWithSpans :: Binder -> [(SourceSpan, Ident)] Source #
isIrrefutable :: Binder -> Bool Source #
newtype AssocList k t Source #
Constructors
| AssocList | |
Fields
| |
Instances
Instances
| Foldable PathNode Source # | |
Defined in Language.PureScript.AST.Declarations Methods fold :: Monoid m => PathNode m -> m # foldMap :: Monoid m => (a -> m) -> PathNode a -> m # foldMap' :: Monoid m => (a -> m) -> PathNode a -> m # foldr :: (a -> b -> b) -> b -> PathNode a -> b # foldr' :: (a -> b -> b) -> b -> PathNode a -> b # foldl :: (b -> a -> b) -> b -> PathNode a -> b # foldl' :: (b -> a -> b) -> b -> PathNode a -> b # foldr1 :: (a -> a -> a) -> PathNode a -> a # foldl1 :: (a -> a -> a) -> PathNode a -> a # elem :: Eq a => a -> PathNode a -> Bool # maximum :: Ord a => PathNode a -> a # minimum :: Ord a => PathNode a -> a # | |
| Traversable PathNode Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Functor PathNode Source # | |
| Show t => Show (PathNode t) Source # | |
| Eq t => Eq (PathNode t) Source # | |
| Ord t => Ord (PathNode t) Source # | |
Defined in Language.PureScript.AST.Declarations | |
Instances
| Foldable PathTree Source # | |
Defined in Language.PureScript.AST.Declarations Methods fold :: Monoid m => PathTree m -> m # foldMap :: Monoid m => (a -> m) -> PathTree a -> m # foldMap' :: Monoid m => (a -> m) -> PathTree a -> m # foldr :: (a -> b -> b) -> b -> PathTree a -> b # foldr' :: (a -> b -> b) -> b -> PathTree a -> b # foldl :: (b -> a -> b) -> b -> PathTree a -> b # foldl' :: (b -> a -> b) -> b -> PathTree a -> b # foldr1 :: (a -> a -> a) -> PathTree a -> a # foldl1 :: (a -> a -> a) -> PathTree a -> a # elem :: Eq a => a -> PathTree a -> Bool # maximum :: Ord a => PathTree a -> a # minimum :: Ord a => PathTree a -> a # | |
| Traversable PathTree Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Functor PathTree Source # | |
| Show t => Show (PathTree t) Source # | |
| Eq t => Eq (PathTree t) Source # | |
| Ord t => Ord (PathTree t) Source # | |
Defined in Language.PureScript.AST.Declarations | |
data DoNotationElement Source #
A statement in a do-notation block
Constructors
| DoNotationValue Expr | A monadic value without a binder |
| DoNotationBind Binder Expr | A monadic value with a binder |
| DoNotationLet [Declaration] | A let statement, i.e. a pure value with a binder |
| PositionedDoNotationElement SourceSpan [Comment] DoNotationElement | A do notation element with source position information |
Instances
| Show DoNotationElement Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> DoNotationElement -> ShowS # show :: DoNotationElement -> String # showList :: [DoNotationElement] -> ShowS # | |
data CaseAlternative Source #
An alternative in a case statement
Constructors
| CaseAlternative | |
Fields
| |
Instances
| Show CaseAlternative Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> CaseAlternative -> ShowS # show :: CaseAlternative -> String # showList :: [CaseAlternative] -> ShowS # | |
data WhereProvenance Source #
Metadata that tells where a let binding originated
Constructors
| FromWhere | The let binding was originally a where clause |
| FromLet | The let binding was always a let binding |
Instances
| Show WhereProvenance Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> WhereProvenance -> ShowS # show :: WhereProvenance -> String # showList :: [WhereProvenance] -> ShowS # | |
Data type for expressions and terms
Constructors
| Literal SourceSpan (Literal Expr) | A literal value |
| UnaryMinus SourceSpan Expr | A prefix -, will be desugared |
| BinaryNoParens Expr Expr Expr | Binary operator application. During the rebracketing phase of desugaring, this data constructor will be removed. |
| Parens Expr | Explicit parentheses. During the rebracketing phase of desugaring, this data constructor will be removed. Note: although it seems this constructor is not used, it _is_ useful, since it prevents certain traversals from matching. |
| Accessor PSString Expr | An record property accessor expression (e.g. `obj.x` or `_.x`). Anonymous arguments will be removed during desugaring and expanded into a lambda that reads a property from a record. |
| ObjectUpdate Expr [(PSString, Expr)] | Partial record update |
| ObjectUpdateNested Expr (PathTree Expr) | Object updates with nested support: `x { foo { bar = e } }`
Replaced during desugaring into a |
| Abs Binder Expr | Function introduction |
| App Expr Expr | Function application |
| Unused Expr | Hint that an expression is unused.
This is used to ignore type class dictionaries that are necessarily empty.
The inner expression lets us solve subgoals before eliminating the whole expression.
The code gen will render this as |
| Var SourceSpan (Qualified Ident) | Variable |
| Op SourceSpan (Qualified (OpName 'ValueOpName)) | An operator. This will be desugared into a function during the "operators" phase of desugaring. |
| IfThenElse Expr Expr Expr | Conditional (if-then-else expression) |
| Constructor SourceSpan (Qualified (ProperName 'ConstructorName)) | A data constructor |
| Case [Expr] [CaseAlternative] | A case expression. During the case expansion phase of desugaring, top-level binders will get desugared into case expressions, hence the need for guards and multiple binders per branch here. |
| TypedValue Bool Expr SourceType | A value with a type annotation |
| Let WhereProvenance [Declaration] Expr | A let binding |
| Do (Maybe ModuleName) [DoNotationElement] | A do-notation block |
| Ado (Maybe ModuleName) [DoNotationElement] Expr | An ado-notation block |
| TypeClassDictionary SourceConstraint (Map QualifiedBy (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))) [ErrorMessageHint] | A placeholder for a type class dictionary to be inserted later. At the end of type checking, these placeholders will be replaced with actual expressions representing type classes dictionaries which can be evaluated at runtime. The constructor arguments represent (in order): whether or not to look at superclass implementations when searching for a dictionary, the type class name and instance type, and the type class dictionaries in scope. |
| DeferredDictionary (Qualified (ProperName 'ClassName)) [SourceType] | A placeholder for a superclass dictionary to be turned into a TypeClassDictionary during typechecking |
| DerivedInstancePlaceholder (Qualified (ProperName 'ClassName)) InstanceDerivationStrategy | A placeholder for a type class instance to be derived during typechecking |
| AnonymousArgument | A placeholder for an anonymous function argument |
| Hole Text | A typed hole that will be turned into a hint/error during typechecking |
| PositionedValue SourceSpan [Comment] Expr | A value with source position information |
data GuardedExpr Source #
The right hand side of a binder in value declarations and case expressions.
Constructors
| GuardedExpr [Guard] Expr |
Instances
| Show GuardedExpr Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> GuardedExpr -> ShowS # show :: GuardedExpr -> String # showList :: [GuardedExpr] -> ShowS # | |
A guard is just a boolean-valued expression that appears alongside a set of binders
Constructors
| ConditionGuard Expr | |
| PatternGuard Binder Expr |
data KindSignatureFor Source #
What sort of declaration the kind signature applies to.
Constructors
| DataSig | |
| NewtypeSig | |
| TypeSynonymSig | |
| ClassSig |
Instances
data TypeInstanceBody Source #
The members of a type class instance declaration
Constructors
| DerivedInstance | This is a derived instance |
| NewtypeInstance | This is an instance derived from a newtype |
| ExplicitInstance [Declaration] | This is a regular (explicit) instance |
Instances
| Show TypeInstanceBody Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeInstanceBody -> ShowS # show :: TypeInstanceBody -> String # showList :: [TypeInstanceBody] -> ShowS # | |
data InstanceDerivationStrategy Source #
Constructors
| KnownClassStrategy | |
| NewtypeStrategy |
Instances
| Show InstanceDerivationStrategy Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> InstanceDerivationStrategy -> ShowS # show :: InstanceDerivationStrategy -> String # showList :: [InstanceDerivationStrategy] -> ShowS # | |
data TypeFixity Source #
Constructors
| TypeFixity Fixity (Qualified (ProperName 'TypeName)) (OpName 'TypeOpName) |
Instances
| Show TypeFixity Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeFixity -> ShowS # show :: TypeFixity -> String # showList :: [TypeFixity] -> ShowS # | |
| Eq TypeFixity Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Ord TypeFixity Source # | |
Defined in Language.PureScript.AST.Declarations Methods compare :: TypeFixity -> TypeFixity -> Ordering # (<) :: TypeFixity -> TypeFixity -> Bool # (<=) :: TypeFixity -> TypeFixity -> Bool # (>) :: TypeFixity -> TypeFixity -> Bool # (>=) :: TypeFixity -> TypeFixity -> Bool # max :: TypeFixity -> TypeFixity -> TypeFixity # min :: TypeFixity -> TypeFixity -> TypeFixity # | |
data ValueFixity Source #
Constructors
| ValueFixity Fixity (Qualified (Either Ident (ProperName 'ConstructorName))) (OpName 'ValueOpName) |
Instances
| Show ValueFixity Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ValueFixity -> ShowS # show :: ValueFixity -> String # showList :: [ValueFixity] -> ShowS # | |
| Eq ValueFixity Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Ord ValueFixity Source # | |
Defined in Language.PureScript.AST.Declarations Methods compare :: ValueFixity -> ValueFixity -> Ordering # (<) :: ValueFixity -> ValueFixity -> Bool # (<=) :: ValueFixity -> ValueFixity -> Bool # (>) :: ValueFixity -> ValueFixity -> Bool # (>=) :: ValueFixity -> ValueFixity -> Bool # max :: ValueFixity -> ValueFixity -> ValueFixity # min :: ValueFixity -> ValueFixity -> ValueFixity # | |
data Declaration Source #
The data type of declarations
Constructors
| DataDeclaration SourceAnn DataDeclType (ProperName 'TypeName) [(Text, Maybe SourceType)] [DataConstructorDeclaration] | A data type declaration (data or newtype, name, arguments, data constructors) |
| DataBindingGroupDeclaration (NonEmpty Declaration) | A minimal mutually recursive set of data type declarations |
| TypeSynonymDeclaration SourceAnn (ProperName 'TypeName) [(Text, Maybe SourceType)] SourceType | A type synonym declaration (name, arguments, type) |
| KindDeclaration SourceAnn KindSignatureFor (ProperName 'TypeName) SourceType | A kind signature declaration |
| RoleDeclaration !RoleDeclarationData | A role declaration (name, roles) |
| TypeDeclaration !TypeDeclarationData | A type declaration for a value (name, ty) |
| ValueDeclaration !(ValueDeclarationData [GuardedExpr]) | A value declaration (name, top-level binders, optional guard, value) |
| BoundValueDeclaration SourceAnn Binder Expr | A declaration paired with pattern matching in let-in expression (binder, optional guard, value) |
| BindingGroupDeclaration (NonEmpty ((SourceAnn, Ident), NameKind, Expr)) | A minimal mutually recursive set of value declarations |
| ExternDeclaration SourceAnn Ident SourceType | A foreign import declaration (name, type) |
| ExternDataDeclaration SourceAnn (ProperName 'TypeName) SourceType | A data type foreign import (name, kind) |
| FixityDeclaration SourceAnn (Either ValueFixity TypeFixity) | A fixity declaration |
| ImportDeclaration SourceAnn ModuleName ImportDeclarationType (Maybe ModuleName) | A module import (module name, qualifiedunqualifiedhiding, optional "qualified as" name) |
| TypeClassDeclaration SourceAnn (ProperName 'ClassName) [(Text, Maybe SourceType)] [SourceConstraint] [FunctionalDependency] [Declaration] | A type class declaration (name, argument, implies, member declarations) |
| TypeInstanceDeclaration SourceAnn SourceAnn ChainId Integer (Either Text Ident) [SourceConstraint] (Qualified (ProperName 'ClassName)) [SourceType] TypeInstanceBody | A type instance declaration (instance chain, chain index, name, dependencies, class name, instance types, member declarations) The first |
Instances
| Show Declaration Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS # | |
data DataConstructorDeclaration Source #
Constructors
| DataConstructorDeclaration | |
Fields
| |
Instances
| Show DataConstructorDeclaration Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> DataConstructorDeclaration -> ShowS # show :: DataConstructorDeclaration -> String # showList :: [DataConstructorDeclaration] -> ShowS # | |
| Eq DataConstructorDeclaration Source # | |
Defined in Language.PureScript.AST.Declarations Methods (==) :: DataConstructorDeclaration -> DataConstructorDeclaration -> Bool # (/=) :: DataConstructorDeclaration -> DataConstructorDeclaration -> Bool # | |
data ValueDeclarationData a Source #
A value declaration assigns a name and potential binders, to an expression (or multiple guarded expressions).
double x = x + x
In this example double is the identifier, x is a binder and x + x is the expression.
Constructors
| ValueDeclarationData | |
Fields
| |
Instances
data TypeDeclarationData Source #
A type declaration assigns a type to an identifier, eg:
identity :: forall a. a -> a
In this example identity is the identifier and forall a. a -> a the type.
Constructors
| TypeDeclarationData | |
Fields
| |
Instances
| Show TypeDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeDeclarationData -> ShowS # show :: TypeDeclarationData -> String # showList :: [TypeDeclarationData] -> ShowS # | |
| Eq TypeDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods (==) :: TypeDeclarationData -> TypeDeclarationData -> Bool # (/=) :: TypeDeclarationData -> TypeDeclarationData -> Bool # | |
data RoleDeclarationData Source #
A role declaration assigns a list of roles to a type constructor's parameters, e.g.:
type role T representational phantom
In this example, T is the identifier and [representational, phantom] is
the list of roles (T presumably having two parameters).
Constructors
| RoleDeclarationData | |
Fields
| |
Instances
| Show RoleDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> RoleDeclarationData -> ShowS # show :: RoleDeclarationData -> String # showList :: [RoleDeclarationData] -> ShowS # | |
| Eq RoleDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods (==) :: RoleDeclarationData -> RoleDeclarationData -> Bool # (/=) :: RoleDeclarationData -> RoleDeclarationData -> Bool # | |
data ImportDeclarationType Source #
The data type which specifies type of import declaration
Constructors
| Implicit | An import with no explicit list: `import M`. |
| Explicit [DeclarationRef] | An import with an explicit list of references to import: `import M (foo)` |
| Hiding [DeclarationRef] | An import with a list of references to hide: `import M hiding (foo)` |
Instances
data ExportSource Source #
Constructors
| ExportSource | |
Instances
data DeclarationRef Source #
An item in a list of explicit imports or exports
Constructors
| TypeClassRef SourceSpan (ProperName 'ClassName) | A type class |
| TypeOpRef SourceSpan (OpName 'TypeOpName) | A type operator |
| TypeRef SourceSpan (ProperName 'TypeName) (Maybe [ProperName 'ConstructorName]) | A type constructor with data constructors |
| ValueRef SourceSpan Ident | A value |
| ValueOpRef SourceSpan (OpName 'ValueOpName) | A value-level operator |
| TypeInstanceRef SourceSpan Ident NameSource | A type class instance, created during typeclass desugaring |
| ModuleRef SourceSpan ModuleName | A module, in its entirety |
| ReExportRef SourceSpan ExportSource DeclarationRef | A value re-exported from another module. These will be inserted during elaboration in name desugaring. |
Instances
data NameSource Source #
Constructors
| UserNamed | |
| CompilerNamed |
Instances
A module declaration, consisting of comments about the module, a module name, a list of declarations, and a list of the declarations that are explicitly exported. If the export list is Nothing, everything is exported.
Constructors
| Module SourceSpan [Comment] ModuleName [Declaration] (Maybe [DeclarationRef]) |
data HintCategory Source #
Categories of hints
Constructors
| ExprHint | |
| KindHint | |
| CheckHint | |
| PositionHint | |
| SolverHint | |
| DeclarationHint | |
| OtherHint |
Instances
| Show HintCategory Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> HintCategory -> ShowS # show :: HintCategory -> String # showList :: [HintCategory] -> ShowS # | |
| Eq HintCategory Source # | |
Defined in Language.PureScript.AST.Declarations | |
data ErrorMessageHint Source #
Error message hints, providing more detailed information about failure.
Constructors
Instances
| Show ErrorMessageHint Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ErrorMessageHint -> ShowS # show :: ErrorMessageHint -> String # showList :: [ErrorMessageHint] -> ShowS # | |
data TypeSearch Source #
Holds the data necessary to do type directed search for typed holes
Constructors
| TSBefore Environment | An Environment captured for later consumption by type directed search |
| TSAfter | Results of applying type directed search to the previously captured Environment |
Fields
| |
Instances
| Show TypeSearch Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeSearch -> ShowS # show :: TypeSearch -> String # showList :: [TypeSearch] -> ShowS # | |
type Context = [(Ident, SourceType)] Source #
A map of locally-bound names in scope.
pattern MkUnguarded :: Expr -> GuardedExpr Source #
pattern TypeFixityDeclaration :: SourceAnn -> Fixity -> Qualified (ProperName 'TypeName) -> OpName 'TypeOpName -> Declaration Source #
pattern ValueFixityDeclaration :: SourceAnn -> Fixity -> Qualified (Either Ident (ProperName 'ConstructorName)) -> OpName 'ValueOpName -> Declaration Source #
pattern ValueDecl :: SourceAnn -> Ident -> NameKind -> [Binder] -> [GuardedExpr] -> Declaration Source #
onTypeSearchTypes :: (SourceType -> SourceType) -> TypeSearch -> TypeSearch Source #
onTypeSearchTypesM :: Applicative m => (SourceType -> m SourceType) -> TypeSearch -> m TypeSearch Source #
getModuleName :: Module -> ModuleName Source #
Return a module's name.
getModuleSourceSpan :: Module -> SourceSpan Source #
Return a module's source span.
getModuleDeclarations :: Module -> [Declaration] Source #
Return a module's declarations.
addDefaultImport :: Qualified ModuleName -> Module -> Module Source #
Add an import declaration for a module if it does not already explicitly import it.
Will not import an unqualified module if that module has already been imported qualified. (See #2197)
importPrim :: Module -> Module Source #
Adds import declarations to a module for an implicit Prim import and Prim | qualified as Prim, as necessary.
declRefName :: DeclarationRef -> Name Source #
getTypeRef :: DeclarationRef -> Maybe (ProperName 'TypeName, Maybe [ProperName 'ConstructorName]) Source #
getTypeOpRef :: DeclarationRef -> Maybe (OpName 'TypeOpName) Source #
getValueRef :: DeclarationRef -> Maybe Ident Source #
getValueOpRef :: DeclarationRef -> Maybe (OpName 'ValueOpName) Source #
getTypeClassRef :: DeclarationRef -> Maybe (ProperName 'ClassName) Source #
isModuleRef :: DeclarationRef -> Bool Source #
mapDataCtorFields :: ([(Ident, SourceType)] -> [(Ident, SourceType)]) -> DataConstructorDeclaration -> DataConstructorDeclaration Source #
traverseDataCtorFields :: Monad m => ([(Ident, SourceType)] -> m [(Ident, SourceType)]) -> DataConstructorDeclaration -> m DataConstructorDeclaration Source #
mapTypeInstanceBody :: ([Declaration] -> [Declaration]) -> TypeInstanceBody -> TypeInstanceBody Source #
traverseTypeInstanceBody :: Applicative f => ([Declaration] -> f [Declaration]) -> TypeInstanceBody -> f TypeInstanceBody Source #
A traversal for TypeInstanceBody
declSourceAnn :: Declaration -> SourceAnn Source #
isValueDecl :: Declaration -> Bool Source #
Test if a declaration is a value declaration
isDataDecl :: Declaration -> Bool Source #
Test if a declaration is a data type declaration
isTypeSynonymDecl :: Declaration -> Bool Source #
Test if a declaration is a type synonym declaration
isImportDecl :: Declaration -> Bool Source #
Test if a declaration is a module import
isRoleDecl :: Declaration -> Bool Source #
Test if a declaration is a role declaration
isExternDataDecl :: Declaration -> Bool Source #
Test if a declaration is a data type foreign import
isFixityDecl :: Declaration -> Bool Source #
Test if a declaration is a fixity declaration
isExternDecl :: Declaration -> Bool Source #
Test if a declaration is a foreign import
isTypeClassInstanceDecl :: Declaration -> Bool Source #
Test if a declaration is a type class instance declaration
isTypeClassDecl :: Declaration -> Bool Source #
Test if a declaration is a type class declaration
isKindDecl :: Declaration -> Bool Source #
Test if a declaration is a kind signature declaration.
flattenDecls :: [Declaration] -> [Declaration] Source #
Recursively flatten data binding groups in the list of declarations
isTrueExpr :: Expr -> Bool Source #
isAnonymousArgument :: Expr -> Bool Source #
data ScopedIdent Source #
Constructors
| LocalIdent Ident | |
| ToplevelIdent Ident |
Instances
| Show ScopedIdent Source # | |
Defined in Language.PureScript.AST.Traversals Methods showsPrec :: Int -> ScopedIdent -> ShowS # show :: ScopedIdent -> String # showList :: [ScopedIdent] -> ShowS # | |
| Eq ScopedIdent Source # | |
Defined in Language.PureScript.AST.Traversals | |
| Ord ScopedIdent Source # | |
Defined in Language.PureScript.AST.Traversals Methods compare :: ScopedIdent -> ScopedIdent -> Ordering # (<) :: ScopedIdent -> ScopedIdent -> Bool # (<=) :: ScopedIdent -> ScopedIdent -> Bool # (>) :: ScopedIdent -> ScopedIdent -> Bool # (>=) :: ScopedIdent -> ScopedIdent -> Bool # max :: ScopedIdent -> ScopedIdent -> ScopedIdent # min :: ScopedIdent -> ScopedIdent -> ScopedIdent # | |
guardedExprM :: Applicative m => (Guard -> m Guard) -> (Expr -> m Expr) -> GuardedExpr -> m GuardedExpr Source #
mapGuardedExpr :: (Guard -> Guard) -> (Expr -> Expr) -> GuardedExpr -> GuardedExpr Source #
everywhereOnValues :: (Declaration -> Declaration) -> (Expr -> Expr) -> (Binder -> Binder) -> (Declaration -> Declaration, Expr -> Expr, Binder -> Binder) Source #
everywhereOnValuesTopDownM :: forall m. Monad m => (Declaration -> m Declaration) -> (Expr -> m Expr) -> (Binder -> m Binder) -> (Declaration -> m Declaration, Expr -> m Expr, Binder -> m Binder) Source #
everywhereOnValuesM :: forall m. Monad m => (Declaration -> m Declaration) -> (Expr -> m Expr) -> (Binder -> m Binder) -> (Declaration -> m Declaration, Expr -> m Expr, Binder -> m Binder) Source #
everythingOnValues :: forall r. (r -> r -> r) -> (Declaration -> r) -> (Expr -> r) -> (Binder -> r) -> (CaseAlternative -> r) -> (DoNotationElement -> r) -> (Declaration -> r, Expr -> r, Binder -> r, CaseAlternative -> r, DoNotationElement -> r) Source #
everythingWithContextOnValues :: forall s r. s -> r -> (r -> r -> r) -> (s -> Declaration -> (s, r)) -> (s -> Expr -> (s, r)) -> (s -> Binder -> (s, r)) -> (s -> CaseAlternative -> (s, r)) -> (s -> DoNotationElement -> (s, r)) -> (Declaration -> r, Expr -> r, Binder -> r, CaseAlternative -> r, DoNotationElement -> r) Source #
everywhereWithContextOnValues :: forall s. s -> (s -> Declaration -> (s, Declaration)) -> (s -> Expr -> (s, Expr)) -> (s -> Binder -> (s, Binder)) -> (s -> CaseAlternative -> (s, CaseAlternative)) -> (s -> DoNotationElement -> (s, DoNotationElement)) -> (s -> Guard -> (s, Guard)) -> (Declaration -> Declaration, Expr -> Expr, Binder -> Binder, CaseAlternative -> CaseAlternative, DoNotationElement -> DoNotationElement, Guard -> Guard) Source #
everywhereWithContextOnValuesM :: forall m s. Monad m => s -> (s -> Declaration -> m (s, Declaration)) -> (s -> Expr -> m (s, Expr)) -> (s -> Binder -> m (s, Binder)) -> (s -> CaseAlternative -> m (s, CaseAlternative)) -> (s -> DoNotationElement -> m (s, DoNotationElement)) -> (s -> Guard -> m (s, Guard)) -> (Declaration -> m Declaration, Expr -> m Expr, Binder -> m Binder, CaseAlternative -> m CaseAlternative, DoNotationElement -> m DoNotationElement, Guard -> m Guard) Source #
everythingWithScope :: forall r. Monoid r => (Set ScopedIdent -> Declaration -> r) -> (Set ScopedIdent -> Expr -> r) -> (Set ScopedIdent -> Binder -> r) -> (Set ScopedIdent -> CaseAlternative -> r) -> (Set ScopedIdent -> DoNotationElement -> r) -> (Set ScopedIdent -> Declaration -> r, Set ScopedIdent -> Expr -> r, Set ScopedIdent -> Binder -> r, Set ScopedIdent -> CaseAlternative -> r, Set ScopedIdent -> DoNotationElement -> r) Source #
accumTypes :: Monoid r => (SourceType -> r) -> (Declaration -> r, Expr -> r, Binder -> r, CaseAlternative -> r, DoNotationElement -> r) Source #
overTypes :: (SourceType -> SourceType) -> Expr -> Expr Source #
Map a function over type annotations appearing inside a value
exportedDeclarations :: Module -> [Declaration] Source #
Return a list of all declarations which are exported from a module. This function descends into data declarations to filter out unexported data constructors, and also filters out type instance declarations if they refer to classes or types which are not themselves exported.
Note that this function assumes that the module has already had its imports
desugared using desugarImports. It will
produce incorrect results if this is not the case - for example, type class
instances will be incorrectly removed in some cases.
The returned declarations are in the same order as they appear in the export list, unless there is no export list, in which case they appear in the same order as they do in the source file.
Kind signatures declarations are also exported if their associated declaration is exported.
isExported :: Maybe [DeclarationRef] -> Declaration -> Bool Source #
Test if a declaration is exported, given a module's export list. Note that
this function does not account for type instance declarations of
non-exported types, or non-exported data constructors. Therefore, you should
prefer exportedDeclarations to this function, where possible.
desugarLetPatternModule :: Module -> Module Source #
Replace every BoundValueDeclaration in Let expressions with Case
expressions.
type PrettyPrintConstraint = (Qualified (ProperName 'ClassName), [PrettyPrintType], [PrettyPrintType]) Source #
data PrettyPrintType Source #
Constructors
convertPrettyPrintType :: Int -> Type a -> PrettyPrintType Source #
prettyPrintTypeAtom :: Int -> Type a -> String Source #
Generate a pretty-printed string representing a Type, as it should appear inside parentheses
prettyPrintType :: Int -> Type a -> String Source #
Generate a pretty-printed string representing a Type
prettyPrintTypeWithUnicode :: Int -> Type a -> String Source #
Generate a pretty-printed string representing a Type using unicode
symbols where applicable
prettyPrintSuggestedType :: Type a -> String Source #
Generate a pretty-printed string representing a suggested Type
prettyPrintLabel :: Label -> Text Source #
prettyPrintObjectKey :: PSString -> Text Source #
prettyPrintBinderAtom :: Binder -> Text Source #
prettyPrintBinder :: Binder -> Text Source #
Generate a pretty-printed string representing a Binder
data PPEOptions Source #
prettyPrintSingleError Options
Constructors
| PPEOptions | |
Fields
| |
How critical the issue is
A map from rigid type variable name/unknown variable pairs to new variables.
Constructors
| TypeMap | |
Fields
| |
newtype MultipleErrors Source #
A stack trace for an error
Constructors
| MultipleErrors | |
Fields | |
Instances
newtype ErrorSuggestion Source #
Constructors
| ErrorSuggestion Text |
data ErrorMessage Source #
Constructors
| ErrorMessage [ErrorMessageHint] SimpleErrorMessage |
Instances
| Show ErrorMessage Source # | |
Defined in Language.PureScript.Errors Methods showsPrec :: Int -> ErrorMessage -> ShowS # show :: ErrorMessage -> String # showList :: [ErrorMessage] -> ShowS # | |
data SimpleErrorMessage Source #
A type of error messages
Constructors
Instances
| Show SimpleErrorMessage Source # | |
Defined in Language.PureScript.Errors Methods showsPrec :: Int -> SimpleErrorMessage -> ShowS # show :: SimpleErrorMessage -> String # showList :: [SimpleErrorMessage] -> ShowS # | |
errorSpan :: ErrorMessage -> Maybe (NonEmpty SourceSpan) Source #
Get the source span for an error
errorModule :: ErrorMessage -> Maybe ModuleName Source #
Get the module name for an error
findHint :: (ErrorMessageHint -> Maybe a) -> ErrorMessage -> Maybe a Source #
stripModuleAndSpan :: ErrorMessage -> ErrorMessage Source #
Remove the module name and span hints from an error
errorCode :: ErrorMessage -> Text Source #
Get the error code for a particular error type
nonEmpty :: MultipleErrors -> Bool Source #
Check whether a collection of errors is empty or not.
errorMessage :: SimpleErrorMessage -> MultipleErrors Source #
Create an error set from a single simple error message
errorMessage' :: SourceSpan -> SimpleErrorMessage -> MultipleErrors Source #
Create an error set from a single simple error message and source annotation
errorMessage'' :: NonEmpty SourceSpan -> SimpleErrorMessage -> MultipleErrors Source #
Create an error set from a single simple error message and source annotations
errorMessage''' :: [SourceSpan] -> SimpleErrorMessage -> MultipleErrors Source #
Create an error from multiple (possibly empty) source spans, reversed sorted.
singleError :: ErrorMessage -> MultipleErrors Source #
Create an error set from a single error message
onErrorMessages :: (ErrorMessage -> ErrorMessage) -> MultipleErrors -> MultipleErrors Source #
Lift a function on ErrorMessage to a function on MultipleErrors
addHint :: ErrorMessageHint -> MultipleErrors -> MultipleErrors Source #
Add a hint to an error message
addHints :: [ErrorMessageHint] -> MultipleErrors -> MultipleErrors Source #
Add hints to an error message
unwrapErrorMessage :: ErrorMessage -> SimpleErrorMessage Source #
Extract nested error messages from wrapper errors
onTypesInErrorMessage :: (SourceType -> SourceType) -> ErrorMessage -> ErrorMessage Source #
onTypesInErrorMessageM :: Applicative m => (SourceType -> m SourceType) -> ErrorMessage -> m ErrorMessage Source #
errorDocUri :: ErrorMessage -> Text Source #
colorCodeBox :: Maybe (ColorIntensity, Color) -> Box -> Box Source #
defaultCodeColor :: (ColorIntensity, Color) Source #
Default color intensity and color for code
defaultPPEOptions :: PPEOptions Source #
Default options for PPEOptions
prettyPrintSingleError :: PPEOptions -> ErrorMessage -> Box Source #
Pretty print a single error, simplifying if necessary
prettyPrintImport :: ModuleName -> ImportDeclarationType -> Maybe ModuleName -> Text Source #
prettyPrintRef :: DeclarationRef -> Maybe Text Source #
prettyPrintMultipleErrors :: PPEOptions -> MultipleErrors -> String Source #
Pretty print multiple errors
prettyPrintMultipleWarnings :: PPEOptions -> MultipleErrors -> String Source #
Pretty print multiple warnings
prettyPrintMultipleWarningsBox :: PPEOptions -> MultipleErrors -> [Box] Source #
Pretty print warnings as a Box
prettyPrintMultipleErrorsBox :: PPEOptions -> MultipleErrors -> [Box] Source #
Pretty print errors as a Box
prettyPrintMultipleErrorsWith :: PPEOptions -> String -> String -> MultipleErrors -> [Box] Source #
rethrow :: MonadError e m => (e -> e) -> m a -> m a Source #
Rethrow an error with a more detailed error message in the case of failure
warnAndRethrow :: (MonadError e m, MonadWriter e m) => (e -> e) -> m a -> m a Source #
rethrowWithPosition :: MonadError MultipleErrors m => SourceSpan -> m a -> m a Source #
Rethrow an error with source position information
warnWithPosition :: MonadWriter MultipleErrors m => SourceSpan -> m a -> m a Source #
warnAndRethrowWithPosition :: (MonadError MultipleErrors m, MonadWriter MultipleErrors m) => SourceSpan -> m a -> m a Source #
withPosition :: SourceSpan -> ErrorMessage -> ErrorMessage Source #
escalateWarningWhen :: (MonadWriter MultipleErrors m, MonadError MultipleErrors m) => (ErrorMessage -> Bool) -> m a -> m a Source #
Runs a computation listening for warnings and then escalating any warnings that match the predicate to error status.
parU :: forall m a b. MonadError MultipleErrors m => [a] -> (a -> m b) -> m [b] Source #
Collect errors in in parallel
internalCompilerError :: (MonadError MultipleErrors m, HasCallStack) => Text -> m a Source #
lookupRoles :: Environment -> Qualified (ProperName 'TypeName) -> [Role] Source #
Lookup the roles for a type in the environment. If the type does not have roles (e.g. is a type synonym or a type variable), then this function returns an empty list.
Arguments
| :: forall m. MonadError MultipleErrors m | |
| => [(Text, Maybe SourceType, Role)] | type parameters for the data type whose roles we are checking |
| -> [Role] | roles declared for the data type |
| -> m () |
Compares the inferred roles to the explicitly declared roles and ensures that the explicitly declared roles are not more permissive than the inferred ones.
checkRoleDeclarationArity :: forall m. MonadError MultipleErrors m => ProperName 'TypeName -> [Role] -> Int -> m () Source #
Arguments
| :: Environment | |
| -> ModuleName | |
| -> ProperName 'TypeName | The name of the data type whose roles we are checking |
| -> [(Text, Maybe SourceType)] | type parameters for the data type whose roles we are checking |
| -> [DataConstructorDeclaration] | constructors of the data type whose roles we are checking |
| -> [Role] |
Infers roles for the given data type declaration.
inferDataBindingGroupRoles :: Environment -> ModuleName -> [RoleDeclarationData] -> [DataDeclaration] -> ProperName 'TypeName -> [(Text, Maybe SourceType)] -> [Role] Source #
data CheckState Source #
State required for type checking
Constructors
| CheckState | |
Fields
| |
data Substitution Source #
A substitution of unification variables for types.
Constructors
| Substitution | |
Fields
| |
insertUnkName :: MonadState CheckState m => Unknown -> Text -> m () Source #
lookupUnkName :: MonadState CheckState m => Unknown -> m (Maybe Text) Source #
emptySubstitution :: Substitution Source #
An empty substitution
emptyCheckState :: Environment -> CheckState Source #
Create an empty CheckState
bindNames :: MonadState CheckState m => Map (Qualified Ident) (SourceType, NameKind, NameVisibility) -> m a -> m a Source #
Temporarily bind a collection of names to values
bindTypes :: MonadState CheckState m => Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) -> m a -> m a Source #
Temporarily bind a collection of names to types
withScopedTypeVars :: (MonadState CheckState m, MonadWriter MultipleErrors m) => ModuleName -> [(Text, SourceType)] -> m a -> m a Source #
Temporarily bind a collection of names to types
withErrorMessageHint :: (MonadState CheckState m, MonadError MultipleErrors m) => ErrorMessageHint -> m a -> m a Source #
getHints :: MonadState CheckState m => m [ErrorMessageHint] Source #
These hints are added at the front, so the most nested hint occurs at the front, but the simplifier assumes the reverse order.
rethrowWithPositionTC :: (MonadState CheckState m, MonadError MultipleErrors m) => SourceSpan -> m a -> m a Source #
warnAndRethrowWithPositionTC :: (MonadState CheckState m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => SourceSpan -> m a -> m a Source #
withTypeClassDictionaries :: MonadState CheckState m => [NamedDict] -> m a -> m a Source #
Temporarily make a collection of type class dictionaries available
getTypeClassDictionaries :: MonadState CheckState m => m (Map QualifiedBy (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))) Source #
Get the currently available map of type class dictionaries
lookupTypeClassDictionaries :: MonadState CheckState m => QualifiedBy -> m (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict))) Source #
Lookup type class dictionaries in a module.
lookupTypeClassDictionariesForClass :: MonadState CheckState m => QualifiedBy -> Qualified (ProperName 'ClassName) -> m (Map (Qualified Ident) (NonEmpty NamedDict)) Source #
Lookup type class dictionaries in a module.
bindLocalVariables :: MonadState CheckState m => [(SourceSpan, Ident, SourceType, NameVisibility)] -> m a -> m a Source #
Temporarily bind a collection of names to local variables
bindLocalTypeVariables :: MonadState CheckState m => ModuleName -> [(ProperName 'TypeName, SourceType)] -> m a -> m a Source #
Temporarily bind a collection of names to local type variables
makeBindingGroupVisible :: MonadState CheckState m => m () Source #
Update the visibility of all names to Defined
withBindingGroupVisible :: MonadState CheckState m => m a -> m a Source #
Update the visibility of all names to Defined in the scope of the provided action
preservingNames :: MonadState CheckState m => m a -> m a Source #
Perform an action while preserving the names from the Environment.
lookupVariable :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => Qualified Ident -> m SourceType Source #
Lookup the type of a value by name in the Environment
getVisibility :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => Qualified Ident -> m NameVisibility Source #
Lookup the visibility of a value by name in the Environment
checkVisibility :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => Qualified Ident -> m () Source #
Assert that a name is visible
lookupTypeVariable :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => ModuleName -> Qualified (ProperName 'TypeName) -> m SourceType Source #
Lookup the kind of a type by name in the Environment
getEnv :: MonadState CheckState m => m Environment Source #
Get the current Environment
getLocalContext :: MonadState CheckState m => m Context Source #
Get locally-bound names in context, to create an error message.
putEnv :: MonadState CheckState m => Environment -> m () Source #
Update the Environment
modifyEnv :: MonadState CheckState m => (Environment -> Environment) -> m () Source #
Modify the Environment
runCheck :: Functor m => CheckState -> StateT CheckState m a -> m (a, Environment) Source #
Run a computation in the typechecking monad, failing with an error, or succeeding with a return value and the final Environment.
guardWith :: MonadError e m => e -> Bool -> m () Source #
Make an assertion, failing with an error message
capturingSubstitution :: MonadState CheckState m => (a -> Substitution -> b) -> m a -> m b Source #
withFreshSubstitution :: MonadState CheckState m => m a -> m a Source #
withoutWarnings :: MonadWriter w m => m a -> m (a, w) Source #
unsafeCheckCurrentModule :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => m ModuleName Source #
debugEnv :: Environment -> [String] Source #
debugConstraint :: Constraint a -> String Source #
debugTypes :: Environment -> [String] Source #
debugNames :: Environment -> [String] Source #
debugDataConstructors :: Environment -> [String] Source #
debugTypeSynonyms :: Environment -> [String] Source #
debugTypeClasses :: Environment -> [String] Source #
debugValue :: Expr -> String Source #
debugSubstitution :: Substitution -> [String] Source #
type KindMap = Map (Qualified (ProperName 'TypeName)) (SourceType, TypeKind) Source #
type SynonymMap = Map (Qualified (ProperName 'TypeName)) ([(Text, Maybe SourceType)], SourceType) Source #
Type synonym information (arguments with kinds, aliased type), indexed by name
replaceAllTypeSynonyms :: (e ~ MultipleErrors, MonadState CheckState m, MonadError e m) => SourceType -> m SourceType Source #
Replace fully applied type synonyms
replaceAllTypeSynonymsM :: MonadError MultipleErrors m => SynonymMap -> KindMap -> SourceType -> m SourceType Source #
Replace fully applied type synonyms by explicitly providing a SynonymMap.
freshKind :: MonadState CheckState m => SourceSpan -> m SourceType Source #
freshKindWithKind :: MonadState CheckState m => SourceSpan -> SourceType -> m SourceType Source #
unknownsWithKinds :: forall m. (MonadState CheckState m, MonadError MultipleErrors m, HasCallStack) => [Unknown] -> m [(Unknown, SourceType)] Source #
inferKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (SourceType, SourceType) Source #
checkKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m SourceType Source #
instantiateKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => (SourceType, SourceType) -> SourceType -> m SourceType Source #
subsumesKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m () Source #
unifyKinds :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m () Source #
unifyKinds' :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m () Source #
Does not attach positions to the error node, instead relies on the | local position context. This is useful when invoking kind unification | outside of kind checker internals.
checkTypeKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> SourceType -> m () Source #
Check the kind of a type, failing if it is not of kind *.
elaborateKind :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m SourceType Source #
kindOfWithUnknowns :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (([(Unknown, SourceType)], SourceType), SourceType) Source #
kindOf :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (SourceType, SourceType) Source #
Infer the kind of a single type
kindOfWithScopedVars :: (MonadError MultipleErrors m, MonadState CheckState m, HasCallStack) => SourceType -> m (([(Text, SourceType)], SourceType), SourceType) Source #
Infer the kind of a single type, returning the kinds of any scoped type variables
kindOfData :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> DataDeclarationArgs -> m DataDeclarationResult Source #
kindOfTypeSynonym :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> TypeDeclarationArgs -> m TypeDeclarationResult Source #
kindOfClass :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> ClassDeclarationArgs -> m ClassDeclarationResult Source #
checkConstraint :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => SourceConstraint -> m SourceConstraint Source #
checkInstanceDeclaration :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> InstanceDeclarationArgs -> m InstanceDeclarationResult Source #
checkKindDeclaration :: forall m. (MonadSupply m, MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> SourceType -> m SourceType Source #
kindsOfAll :: forall m. (MonadError MultipleErrors m, MonadState CheckState m) => ModuleName -> [TypeDeclarationArgs] -> [DataDeclarationArgs] -> [ClassDeclarationArgs] -> m ([TypeDeclarationResult], [DataDeclarationResult], [ClassDeclarationResult]) Source #
desugarTypeDeclarationsModule :: forall m. MonadError MultipleErrors m => Module -> m Module Source #
Replace all top level type declarations in a module with type annotations
desugarObjectConstructors :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module Source #
desugarDecl :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Declaration -> m Declaration Source #
type Env = Map ModuleName (SourceSpan, Imports, Exports) Source #
The imports and exports for a collection of modules. The SourceSpan is used
to store the source location of the module with a given name, used to provide
useful information when there is a duplicate module definition.
The exported declarations from a module.
Constructors
| Exports | |
Fields
| |
The imported declarations for a module, including the module's own members.
Constructors
| Imports | |
Fields
| |
data ImportProvenance Source #
Used to track how an import was introduced into scope. This allows us to handle the one-open-import special case that allows a name conflict to become a warning rather than being an unresolvable situation.
Constructors
| FromImplicit | |
| FromExplicit | |
| Local | |
| Prim |
Instances
| Show ImportProvenance Source # | |
Defined in Language.PureScript.Sugar.Names.Env Methods showsPrec :: Int -> ImportProvenance -> ShowS # show :: ImportProvenance -> String # showList :: [ImportProvenance] -> ShowS # | |
| Eq ImportProvenance Source # | |
Defined in Language.PureScript.Sugar.Names.Env Methods (==) :: ImportProvenance -> ImportProvenance -> Bool # (/=) :: ImportProvenance -> ImportProvenance -> Bool # | |
| Ord ImportProvenance Source # | |
Defined in Language.PureScript.Sugar.Names.Env Methods compare :: ImportProvenance -> ImportProvenance -> Ordering # (<) :: ImportProvenance -> ImportProvenance -> Bool # (<=) :: ImportProvenance -> ImportProvenance -> Bool # (>) :: ImportProvenance -> ImportProvenance -> Bool # (>=) :: ImportProvenance -> ImportProvenance -> Bool # max :: ImportProvenance -> ImportProvenance -> ImportProvenance # min :: ImportProvenance -> ImportProvenance -> ImportProvenance # | |
data ImportRecord a Source #
The details for an import: the name of the thing that is being imported
(x if importing from A), the module that the thing was originally
defined in (for re-export resolution), and the import provenance (see below).
Constructors
| ImportRecord | |
Fields | |
Instances
| Show a => Show (ImportRecord a) Source # | |
Defined in Language.PureScript.Sugar.Names.Env Methods showsPrec :: Int -> ImportRecord a -> ShowS # show :: ImportRecord a -> String # showList :: [ImportRecord a] -> ShowS # | |
| Eq a => Eq (ImportRecord a) Source # | |
Defined in Language.PureScript.Sugar.Names.Env Methods (==) :: ImportRecord a -> ImportRecord a -> Bool # (/=) :: ImportRecord a -> ImportRecord a -> Bool # | |
| Ord a => Ord (ImportRecord a) Source # | |
Defined in Language.PureScript.Sugar.Names.Env Methods compare :: ImportRecord a -> ImportRecord a -> Ordering # (<) :: ImportRecord a -> ImportRecord a -> Bool # (<=) :: ImportRecord a -> ImportRecord a -> Bool # (>) :: ImportRecord a -> ImportRecord a -> Bool # (>=) :: ImportRecord a -> ImportRecord a -> Bool # max :: ImportRecord a -> ImportRecord a -> ImportRecord a # min :: ImportRecord a -> ImportRecord a -> ImportRecord a # | |
desugarDoModule :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module Source #
Replace all DoNotationBind and DoNotationValue constructors with
applications of the bind function in scope, and all DoNotationLet
constructors with let expressions.
desugarCasesModule :: (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module Source #
Replace all top-level binders in a module with case expressions.
desugarCaseGuards :: forall m. (MonadSupply m, MonadError MultipleErrors m) => [Declaration] -> m [Declaration] Source #
desugarCases :: forall m. (MonadSupply m, MonadError MultipleErrors m) => [Declaration] -> m [Declaration] Source #
Replace all top-level binders with case expressions.
createBindingGroupsModule :: MonadError MultipleErrors m => Module -> m Module Source #
Replace all sets of mutually-recursive declarations in a module with binding groups
createBindingGroups :: forall m. MonadError MultipleErrors m => ModuleName -> [Declaration] -> m [Declaration] Source #
collapseBindingGroups :: [Declaration] -> [Declaration] Source #
Collapse all binding groups to individual declarations
desugarAdoModule :: forall m. (MonadSupply m, MonadError MultipleErrors m) => Module -> m Module Source #
Replace all AdoNotationBind and AdoNotationValue constructors with
applications of the pure and apply functions in scope, and all AdoNotationLet
constructors with let expressions.
data DependencyDepth Source #
Constructors
| Direct | |
| Transitive |
data ModuleSignature Source #
A module signature for sorting dependencies.
Constructors
| ModuleSignature | |
Fields
| |
type ModuleGraph = [(ModuleName, [ModuleName])] Source #
A list of modules with their transitive dependencies
sortModules :: forall m a. MonadError MultipleErrors m => DependencyDepth -> (a -> ModuleSignature) -> [a] -> m ([a], ModuleGraph) Source #
Sort a collection of modules based on module dependencies.
Reports an error if the module graph contains a cycle.
type UsedImports = Map ModuleName [Qualified Name] Source #
Map of module name to list of imported names from that module which have been used.
lintImports :: forall m. MonadWriter MultipleErrors m => Module -> Env -> UsedImports -> m () Source #
Find and warn on:
- Unused import statements (qualified or unqualified)
- Unused references in an explicit import list
- Implicit imports of modules
- Implicit imports into a virtual module (unless the virtual module only has members from one module imported)
- Imports using
hiding(this is another form of implicit importing)
checkExhaustiveExpr :: forall m. MonadWriter MultipleErrors m => SourceSpan -> Environment -> ModuleName -> Expr -> m Expr Source #
Exhaustivity checking
lint :: forall m. MonadWriter MultipleErrors m => Module -> m () Source #
Lint the PureScript AST. | | Right now, this pass performs a shadowing check and a check for unused bindings.
renameInModule :: Module Ann -> (Map Ident Ident, Module Ann) Source #
Renames within each declaration in a module. Returns the map of renamed identifiers in the top-level scope, so that they can be renamed in the externs files as well.
data ExternsDeclaration Source #
A type or value declaration appearing in an externs file
Constructors
| EDType | A type declaration |
Fields | |
| EDTypeSynonym | A type synonym |
Fields | |
| EDDataConstructor | A data constructor |
| EDValue | A value declaration |
Fields | |
| EDClass | A type class declaration |
Fields
| |
| EDInstance | An instance declaration |
Fields
| |
Instances
data ExternsTypeFixity Source #
A type fixity declaration in an externs file
Constructors
| ExternsTypeFixity | |
Fields
| |
Instances
data ExternsFixity Source #
A fixity declaration in an externs file
Constructors
| ExternsFixity | |
Fields
| |
Instances
data ExternsImport Source #
A module import in an externs file
Constructors
| ExternsImport | |
Fields
| |
Instances
data ExternsFile Source #
The data which will be serialized to an externs file
Constructors
| ExternsFile | |
Fields
| |
Instances
externsIsCurrentVersion :: ExternsFile -> Bool Source #
Check whether the version in an externs file matches the currently running version.
applyExternsFileToEnvironment :: ExternsFile -> Environment -> Environment Source #
Convert an externs file back into a module
moduleToExternsFile :: Module -> Environment -> Map Ident Ident -> ExternsFile Source #
Generate an externs file for all declarations in a module.
The `Map Ident Ident` argument should contain any top-level GenIdents that
were rewritten to Idents when the module was compiled; this rewrite only
happens in the CoreFn, not the original module AST, so it needs to be
applied to the exported names here also. (The appropriate map is returned by
renameInModule.)
desugarTypeClasses :: (MonadSupply m, MonadError MultipleErrors m) => [ExternsFile] -> Module -> m Module Source #
Add type synonym declarations for type class dictionary types, and value declarations for type class instance dictionary expressions.
superClassDictionaryNames :: [Constraint a] -> [Text] Source #
data BindingGroupType Source #
Constructors
| RecursiveBindingGroup | |
| NonRecursiveBindingGroup |
Instances
| Show BindingGroupType Source # | |
Defined in Language.PureScript.TypeChecker.Types Methods showsPrec :: Int -> BindingGroupType -> ShowS # show :: BindingGroupType -> String # showList :: [BindingGroupType] -> ShowS # | |
| Eq BindingGroupType Source # | |
Defined in Language.PureScript.TypeChecker.Types Methods (==) :: BindingGroupType -> BindingGroupType -> Bool # (/=) :: BindingGroupType -> BindingGroupType -> Bool # | |
| Ord BindingGroupType Source # | |
Defined in Language.PureScript.TypeChecker.Types Methods compare :: BindingGroupType -> BindingGroupType -> Ordering # (<) :: BindingGroupType -> BindingGroupType -> Bool # (<=) :: BindingGroupType -> BindingGroupType -> Bool # (>) :: BindingGroupType -> BindingGroupType -> Bool # (>=) :: BindingGroupType -> BindingGroupType -> Bool # max :: BindingGroupType -> BindingGroupType -> BindingGroupType # min :: BindingGroupType -> BindingGroupType -> BindingGroupType # | |
typesOf :: (MonadSupply m, MonadState CheckState m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => BindingGroupType -> ModuleName -> [((SourceAnn, Ident), Expr)] -> m [((SourceAnn, Ident), (Expr, SourceType))] Source #
Infer the types of multiple mutually-recursive values, and return elaborated values including type class dictionaries and type annotations.
checkNewtype :: forall m. MonadError MultipleErrors m => ProperName 'TypeName -> [DataConstructorDeclaration] -> m (DataConstructorDeclaration, (Ident, SourceType)) Source #
Check that a newtype has just one data constructor with just one field, or
throw an error. If the newtype is valid, this function returns the single
data constructor declaration and the single field, as a proof that the
newtype was indeed a valid newtype.
typeCheckModule :: forall m. (MonadSupply m, MonadState CheckState m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => Map ModuleName Exports -> Module -> m Module Source #
Type check an entire module and ensure all types and classes defined within the module that are required by exported members are also exported.
deriveInstances :: forall m. (MonadError MultipleErrors m, MonadSupply m) => Module -> m Module Source #
Elaborates deriving instance declarations by code generation.
data RebracketCaller Source #
Indicates whether the rebracketModule
is being called with the full desugar pass
run via `purs compile` or whether
only the partial desugar pass is run
via `purs docs`.
This indication is needed to prevent
a `purs docs` error when using
`case _ of` syntax in a type class instance.
Constructors
| CalledByCompile | |
| CalledByDocs |
Instances
| Show RebracketCaller Source # | |
Defined in Language.PureScript.Sugar.Operators Methods showsPrec :: Int -> RebracketCaller -> ShowS # show :: RebracketCaller -> String # showList :: [RebracketCaller] -> ShowS # | |
| Eq RebracketCaller Source # | |
Defined in Language.PureScript.Sugar.Operators Methods (==) :: RebracketCaller -> RebracketCaller -> Bool # (/=) :: RebracketCaller -> RebracketCaller -> Bool # | |
desugarSignedLiterals :: Module -> Module Source #
Removes unary negation operators and replaces them with calls to negate.
rebracket :: forall m. MonadError MultipleErrors m => MonadSupply m => [ExternsFile] -> Module -> m Module Source #
Remove explicit parentheses and reorder binary operator applications.
This pass requires name desugaring and export elaboration to have run first.
rebracketFiltered :: forall m. MonadError MultipleErrors m => MonadSupply m => RebracketCaller -> (Declaration -> Bool) -> [ExternsFile] -> Module -> m Module Source #
A version of rebracket which allows you to choose which declarations
should be affected. This is used in docs generation, where we want to
desugar type operators in instance declarations to ensure that instances are
paired up with their types correctly, but we don't want to desugar type
operators in value declarations.
checkFixityExports :: forall m. MonadError MultipleErrors m => Module -> m Module Source #
Checks all the fixity exports within a module to ensure that members aliased by the operators are also exported from the module.
This pass requires name desugaring and export elaboration to have run first.
desugarImports :: forall m. (MonadError MultipleErrors m, MonadWriter MultipleErrors m, MonadState (Env, UsedImports) m) => Module -> m Module Source #
Replaces all local names with qualified names.
externsEnv :: forall m. (MonadError MultipleErrors m, MonadWriter MultipleErrors m) => Env -> ExternsFile -> m Env Source #
Create an environment from a collection of externs files
desugar :: MonadSupply m => MonadError MultipleErrors m => MonadWriter MultipleErrors m => MonadState (Env, UsedImports) m => [ExternsFile] -> Module -> m Module Source #
The desugaring pipeline proceeds as follows:
- Remove signed literals in favour of
negateapplications - Desugar object literals with wildcards into lambdas
- Desugar operator sections
- Desugar do-notation
- Desugar ado-notation
- Desugar top-level case declarations into explicit case expressions
- Desugar type declarations into value declarations with explicit type annotations
- Qualify any unqualified names and types
- Rebracket user-defined binary operators
- Introduce newtypes for type class dictionaries and value declarations for instances
- Group mutually recursive value and data declarations into binding groups.
A monad for running make actions
Constructors
| Make | |
Fields | |
Instances
| MonadIO Make Source # | |
Defined in Language.PureScript.Make.Monad | |
| Applicative Make Source # | |
| Functor Make Source # | |
| Monad Make Source # | |
| MonadBaseControl IO Make Source # | |
| MonadError MultipleErrors Make Source # | |
Defined in Language.PureScript.Make.Monad Methods throwError :: MultipleErrors -> Make a # catchError :: Make a -> (MultipleErrors -> Make a) -> Make a # | |
| MonadReader Options Make Source # | |
| MonadWriter MultipleErrors Make Source # | |
Defined in Language.PureScript.Make.Monad Methods writer :: (a, MultipleErrors) -> Make a # tell :: MultipleErrors -> Make () # listen :: Make a -> Make (a, MultipleErrors) # pass :: Make (a, MultipleErrors -> MultipleErrors) -> Make a # | |
| MonadBase IO Make Source # | |
Defined in Language.PureScript.Make.Monad | |
| type StM Make a Source # | |
Defined in Language.PureScript.Make.Monad | |
runMake :: Options -> Make a -> IO (Either MultipleErrors a, MultipleErrors) Source #
Execute a Make monad, returning either errors, or the result of the compile plus any warnings.
makeIO :: (MonadIO m, MonadError MultipleErrors m) => Text -> IO a -> m a Source #
getTimestamp :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m UTCTime Source #
Get a file's modification time in the Make monad, capturing any errors
using the MonadError instance.
getTimestampMaybe :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m (Maybe UTCTime) Source #
Get a file's modification time in the Make monad, returning Nothing if
the file does not exist.
readTextFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m Text Source #
Read a text file strictly in the Make monad, capturing any errors using
the MonadError instance.
readJSONFile :: (MonadIO m, MonadError MultipleErrors m) => FromJSON a => FilePath -> m (Maybe a) Source #
Read a JSON file in the Make monad, returning Nothing if the file does
not exist or could not be parsed. Errors are captured using the MonadError
instance.
readCborFile :: (MonadIO m, MonadError MultipleErrors m) => Serialise a => FilePath -> m (Maybe a) Source #
Read a Cbor encoded file in the Make monad, returning
Nothing if the file does not exist or could not be parsed. Errors
are captured using the MonadError instance.
readExternsFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m (Maybe ExternsFile) Source #
Read an externs file, returning Nothing if the file does not exist,
could not be parsed, or was generated by a different version of the
compiler.
hashFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> m ContentHash Source #
writeTextFile :: FilePath -> ByteString -> Make () Source #
Write a text file in the Make monad, capturing any errors using the
MonadError instance.
writeJSONFile :: (MonadIO m, MonadError MultipleErrors m) => ToJSON a => FilePath -> a -> m () Source #
Write a JSON file in the Make monad, capturing any errors using the
MonadError instance.
writeCborFile :: (MonadIO m, MonadError MultipleErrors m) => Serialise a => FilePath -> a -> m () Source #
copyFile :: (MonadIO m, MonadError MultipleErrors m) => FilePath -> FilePath -> m () Source #
Copy a file in the Make monad, capturing any errors using the
MonadError instance.
data MakeActions m Source #
Actions that require implementations when running in "make" mode.
This type exists to make two things abstract:
- The particular backend being used (JavaScript, C++11, etc.)
- The details of how files are read/written etc.
Constructors
| MakeActions | |
Fields
| |
data ProgressMessage Source #
Progress messages from the make process
Constructors
| CompilingModule ModuleName (Maybe (Int, Int)) | Compilation started for the specified module |
Instances
| Show ProgressMessage Source # | |
Defined in Language.PureScript.Make.Actions Methods showsPrec :: Int -> ProgressMessage -> ShowS # show :: ProgressMessage -> String # showList :: [ProgressMessage] -> ShowS # | |
| Eq ProgressMessage Source # | |
Defined in Language.PureScript.Make.Actions Methods (==) :: ProgressMessage -> ProgressMessage -> Bool # (/=) :: ProgressMessage -> ProgressMessage -> Bool # | |
| Ord ProgressMessage Source # | |
Defined in Language.PureScript.Make.Actions Methods compare :: ProgressMessage -> ProgressMessage -> Ordering # (<) :: ProgressMessage -> ProgressMessage -> Bool # (<=) :: ProgressMessage -> ProgressMessage -> Bool # (>) :: ProgressMessage -> ProgressMessage -> Bool # (>=) :: ProgressMessage -> ProgressMessage -> Bool # max :: ProgressMessage -> ProgressMessage -> ProgressMessage # min :: ProgressMessage -> ProgressMessage -> ProgressMessage # | |
data RebuildPolicy Source #
Determines when to rebuild a module
Constructors
| RebuildNever | Never rebuild this module |
| RebuildAlways | Always rebuild this module |
Instances
| Show RebuildPolicy Source # | |
Defined in Language.PureScript.Make.Actions Methods showsPrec :: Int -> RebuildPolicy -> ShowS # show :: RebuildPolicy -> String # showList :: [RebuildPolicy] -> ShowS # | |
| Eq RebuildPolicy Source # | |
Defined in Language.PureScript.Make.Actions Methods (==) :: RebuildPolicy -> RebuildPolicy -> Bool # (/=) :: RebuildPolicy -> RebuildPolicy -> Bool # | |
| Ord RebuildPolicy Source # | |
Defined in Language.PureScript.Make.Actions Methods compare :: RebuildPolicy -> RebuildPolicy -> Ordering # (<) :: RebuildPolicy -> RebuildPolicy -> Bool # (<=) :: RebuildPolicy -> RebuildPolicy -> Bool # (>) :: RebuildPolicy -> RebuildPolicy -> Bool # (>=) :: RebuildPolicy -> RebuildPolicy -> Bool # max :: RebuildPolicy -> RebuildPolicy -> RebuildPolicy # min :: RebuildPolicy -> RebuildPolicy -> RebuildPolicy # | |
renderProgressMessage :: Text -> ProgressMessage -> Text Source #
Render a progress message
cacheDbFile :: FilePath -> FilePath Source #
Given the output directory, determines the location for the CacheDb file
Arguments
| :: (MonadIO m, MonadError MultipleErrors m) | |
| => FilePath | The path to the output directory |
| -> m CacheDb |
Arguments
| :: (MonadIO m, MonadError MultipleErrors m) | |
| => FilePath | The path to the output directory |
| -> CacheDb | The CacheDb to be written |
| -> m () |
Arguments
| :: FilePath | the output directory |
| -> Map ModuleName (Either RebuildPolicy FilePath) | a map between module names and paths to the file containing the PureScript module |
| -> Map ModuleName FilePath | a map between module name and the file containing the foreign javascript for the module |
| -> Bool | Generate a prefix comment? |
| -> MakeActions Make |
A set of make actions that read and write modules from the given directory.
checkForeignDecls :: Module ann -> FilePath -> Make (Either MultipleErrors (ForeignModuleType, Set Ident)) Source #
Check that the declarations in a given PureScript module match with those in its corresponding foreign module.
ffiCodegen' :: Map ModuleName FilePath -> Set CodegenTarget -> Maybe (ModuleName -> String -> FilePath) -> Module Ann -> Make () Source #
FFI check and codegen action. If path maker is supplied copies foreign module to the output.
rebuildModule :: forall m. (MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> [ExternsFile] -> Module -> m ExternsFile Source #
Rebuild a single module.
This function is used for fast-rebuild workflows (PSCi and psc-ide are examples).
rebuildModule' :: forall m. (MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> Env -> [ExternsFile] -> Module -> m ExternsFile Source #
make :: forall m. (MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> [PartialResult Module] -> m [ExternsFile] Source #
Compiles in "make" mode, compiling each module separately to a .js file and an externs.cbor file.
If timestamps or hashes have not changed, existing externs files can be used to provide upstream modules' types without having to typecheck those modules again.
inferForeignModules :: forall m. MonadIO m => Map ModuleName (Either RebuildPolicy FilePath) -> m (Map ModuleName FilePath) Source #
Infer the module name for a module by looking for the same filename with a .js extension.
graph :: [FilePath] -> IO (Either MultipleErrors Value, MultipleErrors) Source #
Given a set of filepaths, try to build the dependency graph and return that as its JSON representation (or a bunch of errors, if any)