{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE TypeFamilies #-}
-- | Inspecing and modifying 'Pattern's, function parameters and
-- pattern elements.
module Futhark.Representation.AST.Attributes.Patterns
       (
         -- * Function parameters
         paramIdent
       , paramType
       , paramDeclType
         -- * Pattern elements
       , patElemIdent
       , patElemType
       , setPatElemLore
       , patternElements
       , patternIdents
       , patternContextIdents
       , patternValueIdents
       , patternNames
       , patternValueNames
       , patternContextNames
       , patternTypes
       , patternValueTypes
       , patternSize
       -- * Pattern construction
       , basicPattern
       )
       where

import Futhark.Representation.AST.Syntax
import Futhark.Representation.AST.Attributes.Types (Typed(..), DeclTyped(..))

-- | The 'Type' of a parameter.
paramType :: Typed attr => Param attr -> Type
paramType :: Param attr -> Type
paramType = Param attr -> Type
forall t. Typed t => t -> Type
typeOf

-- | The 'DeclType' of a parameter.
paramDeclType :: DeclTyped attr => Param attr -> DeclType
paramDeclType :: Param attr -> DeclType
paramDeclType = Param attr -> DeclType
forall t. DeclTyped t => t -> DeclType
declTypeOf

-- | An 'Ident' corresponding to a parameter.
paramIdent :: Typed attr => Param attr -> Ident
paramIdent :: Param attr -> Ident
paramIdent Param attr
param = VName -> Type -> Ident
Ident (Param attr -> VName
forall attr. Param attr -> VName
paramName Param attr
param) (Param attr -> Type
forall t. Typed t => t -> Type
typeOf Param attr
param)

-- | An 'Ident' corresponding to a pattern element.
patElemIdent :: Typed attr => PatElemT attr -> Ident
patElemIdent :: PatElemT attr -> Ident
patElemIdent PatElemT attr
pelem = VName -> Type -> Ident
Ident (PatElemT attr -> VName
forall attr. PatElemT attr -> VName
patElemName PatElemT attr
pelem) (PatElemT attr -> Type
forall t. Typed t => t -> Type
typeOf PatElemT attr
pelem)

-- | The type of a name bound by a 'PatElem'.
patElemType :: Typed attr => PatElemT attr -> Type
patElemType :: PatElemT attr -> Type
patElemType = PatElemT attr -> Type
forall t. Typed t => t -> Type
typeOf

-- | Set the lore of a 'PatElem'.
setPatElemLore :: PatElemT oldattr -> newattr -> PatElemT newattr
setPatElemLore :: PatElemT oldattr -> newattr -> PatElemT newattr
setPatElemLore PatElemT oldattr
pe newattr
x = (oldattr -> newattr) -> PatElemT oldattr -> PatElemT newattr
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (newattr -> oldattr -> newattr
forall a b. a -> b -> a
const newattr
x) PatElemT oldattr
pe

-- | All pattern elements in the pattern - context first, then values.
patternElements :: PatternT attr -> [PatElemT attr]
patternElements :: PatternT attr -> [PatElemT attr]
patternElements PatternT attr
pat = PatternT attr -> [PatElemT attr]
forall attr. PatternT attr -> [PatElemT attr]
patternContextElements PatternT attr
pat [PatElemT attr] -> [PatElemT attr] -> [PatElemT attr]
forall a. [a] -> [a] -> [a]
++ PatternT attr -> [PatElemT attr]
forall attr. PatternT attr -> [PatElemT attr]
patternValueElements PatternT attr
pat

-- | Return a list of the 'Ident's bound by the 'Pattern'.
patternIdents :: Typed attr => PatternT attr -> [Ident]
patternIdents :: PatternT attr -> [Ident]
patternIdents PatternT attr
pat = PatternT attr -> [Ident]
forall attr. Typed attr => PatternT attr -> [Ident]
patternContextIdents PatternT attr
pat [Ident] -> [Ident] -> [Ident]
forall a. [a] -> [a] -> [a]
++ PatternT attr -> [Ident]
forall attr. Typed attr => PatternT attr -> [Ident]
patternValueIdents PatternT attr
pat

-- | Return a list of the context 'Ident's bound by the 'Pattern'.
patternContextIdents :: Typed attr => PatternT attr -> [Ident]
patternContextIdents :: PatternT attr -> [Ident]
patternContextIdents = (PatElemT attr -> Ident) -> [PatElemT attr] -> [Ident]
forall a b. (a -> b) -> [a] -> [b]
map PatElemT attr -> Ident
forall attr. Typed attr => PatElemT attr -> Ident
patElemIdent ([PatElemT attr] -> [Ident])
-> (PatternT attr -> [PatElemT attr]) -> PatternT attr -> [Ident]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatternT attr -> [PatElemT attr]
forall attr. PatternT attr -> [PatElemT attr]
patternContextElements

-- | Return a list of the value 'Ident's bound by the 'Pattern'.
patternValueIdents :: Typed attr => PatternT attr -> [Ident]
patternValueIdents :: PatternT attr -> [Ident]
patternValueIdents = (PatElemT attr -> Ident) -> [PatElemT attr] -> [Ident]
forall a b. (a -> b) -> [a] -> [b]
map PatElemT attr -> Ident
forall attr. Typed attr => PatElemT attr -> Ident
patElemIdent ([PatElemT attr] -> [Ident])
-> (PatternT attr -> [PatElemT attr]) -> PatternT attr -> [Ident]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatternT attr -> [PatElemT attr]
forall attr. PatternT attr -> [PatElemT attr]
patternValueElements

-- | Return a list of the 'Name's bound by the 'Pattern'.
patternNames :: PatternT attr -> [VName]
patternNames :: PatternT attr -> [VName]
patternNames = (PatElemT attr -> VName) -> [PatElemT attr] -> [VName]
forall a b. (a -> b) -> [a] -> [b]
map PatElemT attr -> VName
forall attr. PatElemT attr -> VName
patElemName ([PatElemT attr] -> [VName])
-> (PatternT attr -> [PatElemT attr]) -> PatternT attr -> [VName]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatternT attr -> [PatElemT attr]
forall attr. PatternT attr -> [PatElemT attr]
patternElements

-- | Return a list of the 'Name's bound by the context part of the 'Pattern'.
patternContextNames :: PatternT attr -> [VName]
patternContextNames :: PatternT attr -> [VName]
patternContextNames = (PatElemT attr -> VName) -> [PatElemT attr] -> [VName]
forall a b. (a -> b) -> [a] -> [b]
map PatElemT attr -> VName
forall attr. PatElemT attr -> VName
patElemName ([PatElemT attr] -> [VName])
-> (PatternT attr -> [PatElemT attr]) -> PatternT attr -> [VName]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatternT attr -> [PatElemT attr]
forall attr. PatternT attr -> [PatElemT attr]
patternContextElements

-- | Return a list of the 'Name's bound by the value part of the 'Pattern'.
patternValueNames :: PatternT attr -> [VName]
patternValueNames :: PatternT attr -> [VName]
patternValueNames = (PatElemT attr -> VName) -> [PatElemT attr] -> [VName]
forall a b. (a -> b) -> [a] -> [b]
map PatElemT attr -> VName
forall attr. PatElemT attr -> VName
patElemName ([PatElemT attr] -> [VName])
-> (PatternT attr -> [PatElemT attr]) -> PatternT attr -> [VName]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatternT attr -> [PatElemT attr]
forall attr. PatternT attr -> [PatElemT attr]
patternValueElements

-- | Return a list of the 'types's bound by the 'Pattern'.
patternTypes :: Typed attr => PatternT attr -> [Type]
patternTypes :: PatternT attr -> [Type]
patternTypes = (Ident -> Type) -> [Ident] -> [Type]
forall a b. (a -> b) -> [a] -> [b]
map Ident -> Type
identType ([Ident] -> [Type])
-> (PatternT attr -> [Ident]) -> PatternT attr -> [Type]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatternT attr -> [Ident]
forall attr. Typed attr => PatternT attr -> [Ident]
patternIdents

-- | Return a list of the 'Types's bound by the value part of the 'Pattern'.
patternValueTypes :: Typed attr => PatternT attr -> [Type]
patternValueTypes :: PatternT attr -> [Type]
patternValueTypes = (Ident -> Type) -> [Ident] -> [Type]
forall a b. (a -> b) -> [a] -> [b]
map Ident -> Type
identType ([Ident] -> [Type])
-> (PatternT attr -> [Ident]) -> PatternT attr -> [Type]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatternT attr -> [Ident]
forall attr. Typed attr => PatternT attr -> [Ident]
patternValueIdents

-- | Return the number of names bound by the 'Pattern'.
patternSize :: PatternT attr -> Int
patternSize :: PatternT attr -> Int
patternSize (Pattern [PatElemT attr]
context [PatElemT attr]
values) = [PatElemT attr] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length [PatElemT attr]
context Int -> Int -> Int
forall a. Num a => a -> a -> a
+ [PatElemT attr] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length [PatElemT attr]
values

-- | Create a pattern using 'Type' as the attribute.
basicPattern :: [Ident] -> [Ident] -> PatternT Type
basicPattern :: [Ident] -> [Ident] -> PatternT Type
basicPattern [Ident]
context [Ident]
values =
  [PatElemT Type] -> [PatElemT Type] -> PatternT Type
forall attr. [PatElemT attr] -> [PatElemT attr] -> PatternT attr
Pattern ((Ident -> PatElemT Type) -> [Ident] -> [PatElemT Type]
forall a b. (a -> b) -> [a] -> [b]
map Ident -> PatElemT Type
patElem [Ident]
context) ((Ident -> PatElemT Type) -> [Ident] -> [PatElemT Type]
forall a b. (a -> b) -> [a] -> [b]
map Ident -> PatElemT Type
patElem [Ident]
values)
  where patElem :: Ident -> PatElemT Type
patElem (Ident VName
name Type
t) = VName -> Type -> PatElemT Type
forall attr. VName -> attr -> PatElemT attr
PatElem VName
name Type
t