Difference between revisions of "Keywords"
EdaNhaskell (talk  contribs) m (→proc) 
m (→case, of) 

Line 408:  Line 408:  
<haskell> 
<haskell> 

−  +   g1 > e1 

−  +  ... 

−  +   gm > em 

−  +  where decls 

</haskell> 
</haskell> 

Revision as of 07:47, 3 August 2012
This page lists all Haskell keywords, feel free to edit. Hoogle searches will return results from this page. Please respect the Anchor macros.
For additional information you might want to look at the Haskell 98 report.
Contents
 1 !
 2 '
 3 ''
 4 
 5 
 6 <
 7 <<
 8 >
 9 ::
 10 ;
 11 <
 12 =
 13 =>
 14 >
 15 ?
 16 ??
 17 #
 18 (#)
 19 *
 20 @
 21 [, ]
 22 \
 23 _
 24 `
 25 {, }
 26 {, }
 27 
 28 ~
 29 as
 30 case, of
 31 class
 32 data
 33 data family
 34 data instance
 35 default
 36 deriving
 37 deriving instance
 38 do
 39 forall
 40 foreign
 41 hiding
 42 if, then, else
 43 import
 44 infix, infixl, infixr
 45 instance
 46 let, in
 47 mdo
 48 module
 49 newtype
 50 proc
 51 qualified
 52 rec
 53 type
 54 type family
 55 type instance
 56 where
!
Whenever a data constructor is applied, each argument to the constructor is evaluated if and only if the corresponding type in the algebraic datatype declaration has a strictness flag, denoted by an exclamation point. For example:
data STList a
= STCons a !(STList a)  the second argument to STCons will be
 evaluated before STCons is applied
 STNil
to illustrate the difference between strict versus lazy constructor application, consider the following:
stList = STCons 1 undefined
lzList = (:) 1 undefined
stHead (STCons h _) = h  this evaluates to undefined when applied to stList
lzHead (h : _) = h  this evaluates to 1 when applied to lzList
! is also used in the "bang patterns" (GHC extension), to indicate strictness in patterns:
f !x !y = x + y
'
 Character literal:
'a'
 Template Haskell: Name of a (value) variable or data constructor:
'length
,'Left
''
 Template Haskell: Name of a type constructor or class:
''Int
,''Either
,''Show

This operator token is magic/irregular in the sense that
( 1)
is parsed as the negative integer 1, rather than as an operator section, as it would be for any other operator:
(* 1) :: Num a => a > a
(++ "foo") :: String > String
It is syntactic sugar for the negate
function in Prelude. See unary operator.
If you want the section, you can use the subtract
function or (+(1))
.

Starts a singleline comment, unless immediately followed by an operator character other than 
:
main = print "hello world"  this is a comment
this is a comment as well
this too
foobar + this_is_the_second_argument_of_the_dash_dash_plus_operator
The multiline variant for comments is { comment }
.
<
<<
>
 The function type constructor:
length :: [a] > Int
 In lambda functions:
\x > x + 1
 To denote alternatives in case statements:
case Just 3 of
Nothing > False
Just x > True
 On the kind level (GHC specific):
ghci> :kind (>)
(>) :: ?? > ? > *
 This examples assumes that each type 'c' can "contain" only one type
 i.e. type 'c' uniquely determines type 'elt'
class Contains c elt  c > elt where
...
::
Read as "has type":
length :: [a] > Int
"Length has type listof'a' to Int"
Or "has kind" (GHC specific):
Either :: * > * > *
;
 Statement separator in an explicit block (see layout)
<
 In donotation, "draw from":
do x < getChar
putChar x
 In list comprehension generators, "is drawn from":
[ (x,y)  x < [1..10], y < ['a'..'z'] ]
 In pattern guards, "matches":
f x y  Just z < g x = True
 otherwise = False
=
Used in definitions.
x = 4
=>
Used to indicate instance contexts, for example:
sort :: Ord a => [a] > [a]
>
In a Bird's style Literate Haskell file, the > character is used to introduce a code line.
comment line
> main = print "hello world"
?
ghci> :t ?foo ++ "bar"
?foo ++ "bar" :: (?foo::[Char]) => [Char]
 On the kind level: The union of
??
and(#)
(GHCspecific)
ghci> :kind (>)
(>) :: ?? > ? > *
??
 Is an ordinary operator name on the value level and on the type level
 On the kind level: The union of
*
and#
(GHCspecific)
ghci> :kind (>)
(>) :: ?? > ? > *
#
ghci> :m +GHC.Prim
ghci> :set XMagicHash
ghci> :kind Int#
Int# :: #
(#)
ghci> :set XMagicHash XUnboxedTuples
ghci> ghci> :k (# Char,Int #)
(# Char,Int #) :: (#)
*
 Is an ordinary operator name on the value level
 On the kind level: The kind of boxed types (GHCspecific)
ghci> :kind Int
Int :: *
@
Patterns of the form var@pat are called aspatterns, and allow one to use var as a name for the value being matched by pat. For example:
case e of { xs@(x:rest) > if x==0 then rest else xs }
is equivalent to:
let { xs = e } in
case xs of { (x:rest) > if x==0 then rest else xs }
[, ]
 Template Haskell
 Expression quotation:
[ print 1 ]
 Declaration quotation:
[d main = print 1 ]
 Type quotation:
[t Either Int () ]
 Pattern quotation:
[p (x,y) ]
 Quasiquotation:
[nameOfQuasiQuoter ... ]
 Expression quotation:
\
The backslash "\" is used
 in multiline strings
"foo\
\bar"
 in lambda functions
\x > x + 1
_
Patterns of the form _ are wildcards and are useful when some part of a pattern is not referenced on the righthandside. It is as if an identifier not used elsewhere were put in its place. For example,
case e of { [x,_,_] > if x==0 then True else False }
is equivalent to:
case e of { [x,y,z] > if x==0 then True else False }
`
A function enclosed in back ticks "`" can be used as an infix operator.
2 `subtract` 10
is the same as
subtract 2 10
{, }
 Explicit block (disable layout), possibly with ";" .
 Record update notation
changePrice :: Thing > Price > Thing
changePrice x new = x { price = new }
 Comments (see below)
{, }
Everything between "{" followed by a space and "}" is a block comment.
{
hello
world
}

The "pipe" is used in several places
 Data type definitions, "or"
data Maybe a = Just a  Nothing
 List comprehensions, "where"
squares = [a*a  a < [1..]]
 Guards, "when"
safeTail x  null x = []
 otherwise = tail x
 Functional dependencies, "where"
class Contains c elt  c > elt where
...
~
 Lazy pattern bindings. Matching the pattern ~pat against a value always
suceeds, and matching will only diverge when one of the variables bound in the pattern is used.
f1,f2 :: Maybe Int > String;
(+++),(++++) :: (a>b)>(c>d)>(a,c)>(b,d);
f1 x = case x of {Just n > "Got it"};
f2 x = case x of {~(Just n) > "Got it"};
(f +++ g) ~(x,y) = (f x , g y);
(f ++++ g) (x,y) = (f x , g y);
Then we have:
f1 Nothing
Exception: Nonexhaustive patterns in case
f2 Nothing
"Got it"
(const 1 +++ const 2) undefined
(1,2)
(const 1 ++++ const 2) undefined
Exception: Prelude.undefined
For more details see the Haskell Wikibook.
 Equality constraints. Assert that two types in a context must be the same:
example :: F a ~ b => a > b
Here the type "F a" must be the same as the type "b", which allows one to constrain polymorphism (especially where type families are involved), but to a lesser extent than functional dependencies. See Type Families.
as
Renaming module imports. Like qualified
and hiding
, as
is not a reserved word but may be used as function or variable name.
import qualified Data.Map as M
main = print (M.empty :: M.Map Int ())
case, of
A case expression has the general form
case e of { p1 match1 ; ... ; pn matchn }
where each match
_{i} is of the general form
 g1 > e1
...
 gm > em
where decls
Each alternative consists of patterns p
_{i} and their matches, match
_{i}. Each
match
_{i} in turn consists of a sequence of pairs of guards g
_{ij} and bodies e
_{ij}
(expressions), followed by optional bindings (decls
_{i}) that scope over all
of the guards and expressions of the alternative. An alternative of the
form
pat > exp where decls
is treated as shorthand for:
pat  True > exp
where decls
A case expression must have at least one alternative and each alternative must have at least one body. Each body must have the same type, and the type of the whole expression is that type.
A case expression is evaluated by pattern matching the expression e
against the individual alternatives. The alternatives are tried
sequentially, from top to bottom. If e
matches the pattern in the
alternative, the guards for that alternative are tried sequentially from
top to bottom, in the environment of the case expression extended first
by the bindings created during the matching of the pattern, and then by
the decls
_{i} in the where
clause associated with that alternative. If one
of the guards evaluates to True
, the corresponding righthand side is
evaluated in the same environment as the guard. If all the guards
evaluate to False
, matching continues with the next alternative. If no
match succeeds, the result is __.
class
A class declaration introduces a new type class and the overloaded operations that must be supported by any type that is an instance of that class.
class Num a where
(+) :: a > a > a
negate :: a > a
data
The data declaration is how one introduces new algebraic data types into Haskell. For example:
data Set a = NilSet
 ConsSet a (Set a)
Another example, to create a datatype to hold an abstract syntax tree for an expression, one could use:
data Exp = Ebin Operator Exp Exp
 Eunary Operator Exp
 Efun FunctionIdentifier [Exp]
 Eid SimpleIdentifier
where the types Operator, FunctionIdentifier
and SimpleIdentifier
are defined elsewhere.
See the page on types for more information, links and examples.
data family
Declares a datatype family (see type families). GHC language extension.
data instance
Declares a datatype family instance (see type families). GHC language extension.
default
Ambiguities in the class Num are most common, so Haskell provides a way to resolve themwith a default declaration:
default (Int)
Only one default declaration is permitted per module, and its effect is limited to that module. If no default declaration is given in a module then it assumed to be:
default (Integer, Double)
deriving
data and newtype declarations contain an optional deriving form. If the form is included, then derived instance declarations are automatically generated for the datatype in each of the named classes.
Derived instances provide convenient commonlyused operations for userdefined datatypes. For example, derived instances for datatypes in the class Eq define the operations == and /=, freeing the programmer from the need to define them.
data T = A
 B
 C
deriving (Eq, Ord, Show)
In the case of newtypes, GHC extends this mechanism to Cunning Newtype Deriving.
deriving instance
Standalone deriving (GHC language extension).
{# LANGUAGE StandaloneDeriving #}
data A = A
deriving instance Show A
do
Syntactic sugar for use with monadic expressions. For example:
do { x ; result < y ; foo result }
is shorthand for:
x >>
y >>= \result >
foo result
forall
This is a GHC/Hugs extension, and as such is not portable Haskell 98. It is only a reserved word within types.
Type variables in a Haskell type expression are all assumed to be
universally quantified; there is no explicit syntax for universal
quantification, in standard Haskell 98. For example, the type expression
a > a
denotes the type forall a. a >a
.
For clarity, however, we often write quantification explicitly when
discussing the types of Haskell programs. When we write an explicitly
quantified type, the scope of the forall extends as far to the right as
possible; for example,
forall a. a > a
means
forall a. (a > a)
GHC introduces a forall
keyword, allowing explicit quantification, for example, to encode
existential types:
data Foo = forall a. MkFoo a (a > Bool)
 Nil
MkFoo :: forall a. a > (a > Bool) > Foo
Nil :: Foo
[MkFoo 3 even, MkFoo 'c' isUpper] :: [Foo]
foreign
A keyword for the Foreign Function Interface (commonly called the FFI) that introduces either a foreign import
declaration, which makes a function from a nonHaskell library available in a Haskell program, or a foreign export
declaration, which allows a function from a Haskell module to be called in nonHaskell contexts.
hiding
When importing modules, without introducing a name into scope, entities can be excluded by using the form
hiding (import1 , ... , importn )
which specifies that all entities exported by the named module should be imported except for those named in the list.
For example:
import Prelude hiding (lookup,filter,foldr,foldl,null,map)
if, then, else
A conditional expression has the form:
if e1 then e2 else e3
and returns the value of e2 if the value of e1 is True, e3 if e1 is False, and __ otherwise.
max a b = if a > b then a else b
import
Modules may reference other modules via explicit import declarations, each giving the name of a module to be imported and specifying its entities to be imported.
For example:
module Main where
import A
import B
main = A.f >> B.f
module A where
f = ...
module B where
f = ...
See also as, hiding , qualified and the page Import
infix, infixl, infixr
A fixity declaration gives the fixity and binding precedence of one or more operators. The integer in a fixity declaration must be in the range 0 to 9. A fixity declaration may appear anywhere that a type signature appears and, like a type signature, declares a property of a particular operator.
There are three kinds of fixity, non, left and rightassociativity (infix, infixl, and infixr, respectively), and ten precedence levels, 0 to 9 inclusive (level 0 binds least tightly, and level 9 binds most tightly).
module Bar where
infixr 7 `op`
op = ...
instance
An instance declaration declares that a type is an instance of a class and includes the definitions of the overloaded operations  called class methods  instantiated on the named type.
instance Num Int where
x + y = addInt x y
negate x = negateInt x
let, in
Let expressions have the general form:
let { d1 ; ... ; dn } in e
They introduce a nested, lexicallyscoped, mutuallyrecursive list of declarations (let is often called letrec in other languages). The scope of the declarations is the expression e and the right hand side of the declarations.
Within do
blocks or list comprehensions let { d1 ; ... ; dn }
without in
serves to indroduce local bindings.
mdo
The recursive do
keyword enabled by fglasgowexts
module
Taken from: A Gentle Introduction to Haskell, Version 98
Technically speaking, a module is really just one big declaration which begins with the keyword module; here's an example for a module whose name is Tree:
module Tree ( Tree(Leaf,Branch), fringe ) where
data Tree a = Leaf a  Branch (Tree a) (Tree a)
fringe :: Tree a > [a]
fringe (Leaf x) = [x]
fringe (Branch left right) = fringe left ++ fringe right
newtype
The newtype
declaration is how one introduces a renaming for an algebraic data type into Haskell. This is different from type
below, as a newtype
requires a new constructor as well. As an example, when writing a compiler
one sometimes further qualifies Identifier
s to assist in type safety checks:
newtype SimpleIdentifier = SimpleIdentifier Identifier newtype FunctionIdentifier = FunctionIdentifier Identifier
Most often, one supplies smart constructors and destructors for these to ease working with them.
See the page on types for more information, links and examples.
For the differences between newtype
and data
, see Newtype.
proc
proc (arrow abstraction) is a kind of lambda, except that it constructs an arrow instead of a function.
qualified
Used to import a module, but not introduce a name into scope. For example, Data.Map exports lookup, which would clash with the Prelude version of lookup, to fix this:
import qualified Data.Map
f x = lookup x  use the Prelude version
g x = Data.Map.lookup x  use the Data.Map version
Of course, Data.Map is a bit of a mouthful, so qualified also allows the use of as.
import qualified Data.Map as M
f x = lookup x  use Prelude version
g x = M.lookup x  use Data.Map version
rec
The rec keyword can be used when the XDoRec
flag is given; it allows recursive bindings in a doblock.
{# LANGUAGE DoRec #}
justOnes = do { rec { xs < Just (1:xs) }
; return (map negate xs) }
type
The type
declaration is how one introduces an alias for an algebraic data type into Haskell. As an example, when writing a compiler
one often creates an alias for identifiers:
type Identifier = String
This allows you to use Identifer
wherever you had used String
and if something is of type Identifier
it
may be used wherever a String
is expected.
See the page on types for more information, links and examples.
Some common type
declarations in the Prelude include:
type FilePath = String
type String = [Char]
type Rational = Ratio Integer
type ReadS a = String > [(a,String)]
type ShowS = String > String
type family
Declares a type synonym family (see type families). GHC language extension.
type instance
Declares a type synonym family instance (see type families). GHC language extension.
where
Used to introduce a module, instance, class or GADT:
module Main where
class Num a where
...
instance Num Int where
...
data Something a where
...
And to bind local variables:
f x = y
where y = x * 2
g z  z > 2 = y
where y = x * 2