Desugar.hs 50.5 KB
Newer Older
1
{- |
2
3
4
5
6
  Module      :  $Header$
  Description :  Desugaring Curry Expressions
  Copyright   :  (c) 2001 - 2004 Wolfgang Lux
                                 Martin Engelke
                     2011 - 2015 Björn Peemöller
7
                     2015        Jan Tikovsky
Finn Teegen's avatar
Finn Teegen committed
8
                     2016        Finn Teegen
9
10
11
12
13
14
  License     :  OtherLicense

  Maintainer  :  bjp@informatik.uni-kiel.de
  Stability   :  experimental
  Portability :  portable

15
16
  The desugaring pass removes all syntactic sugar from the module.
  In particular, the output of the desugarer will have the following
17
18
  properties.

19
20
21
22
  * No guarded right hand sides occur in equations, pattern declarations,
    and case alternatives. In addition, the declaration lists (`where`-blocks)
    of the right hand sides are empty; local declarations are transformed
    into let expressions.
23
24
25
26
27

  * Patterns in equations and case alternatives are composed only of
    - literals,
    - variables,
    - constructor applications, and
28
    - as patterns applied to literals or constructor applications.
29
30
31
32
33
34

  * Expressions are composed only of
    - literals,
    - variables,
    - constructors,
    - (binary) applications,
35
    - case expressions,
36
    - let expressions, and
37
    - expressions with a type signature.
38
39
40
41
42
43
44
45
46
47
48

  * Applications 'N x' in patterns and expressions, where 'N' is a
    newtype constructor, are replaced by a 'x'. Note that neither the
    newtype declaration itself nor partial applications of newtype
    constructors are changed.
    It were possible to replace partial applications of newtype constructor
    by 'Prelude.id'.
    However, our solution yields a more accurate output when the result
    of a computation includes partial applications.

  * Functional patterns are replaced by variables and are integrated
49
    in a guarded right hand side using the (=:<=) operator.
50

51
52
53
54
55
56
57
58
59
  * Records are transformed into ordinary data types by removing the fields.
    Record construction and pattern matching are represented using solely the
    record constructor. Record selections are represented using selector
    functions which are generated for each record declaration, and record
    updated are represented using case-expressions that perform the update.

  * The type environment will be extended by new function declarations for:
    - Record selections, and
    - Converted lambda expressions.
60
61
62

  As we are going to insert references to real prelude entities,
  all names must be properly qualified before calling this module.
63
-}
64
{-# LANGUAGE CPP #-}
65
66
module Transformations.Desugar (desugar) where

67
#if __GLASGOW_HASKELL__ < 710
68
import           Control.Applicative        ((<$>), (<*>))
69
#endif
70
import           Control.Arrow              (first, second)
Finn Teegen's avatar
Finn Teegen committed
71
72
73
import           Control.Monad              (liftM2, mplus)
import           Control.Monad.Extra        (concatMapM)
import           Control.Monad.ListM        (mapAccumM)
74
import qualified Control.Monad.State as S   (State, runState, gets, modify)
75
import           Data.Foldable              (foldrM)
Finn Teegen's avatar
Finn Teegen committed
76
77
import           Data.List                  ( (\\), elemIndex, nub, partition
                                            , tails )
78
import           Data.Maybe                 (fromMaybe)
79
80
81
82
83
84
85
import qualified Data.Set            as Set (Set, empty, member, insert)

import Curry.Base.Ident
import Curry.Base.Position hiding (first)
import Curry.Syntax

import Base.Expr
Finn Teegen's avatar
Finn Teegen committed
86
import Base.CurryTypes
87
import Base.Messages (internalError)
Finn Teegen's avatar
Finn Teegen committed
88
import Base.TypeExpansion
89
import Base.Types
Finn Teegen's avatar
Finn Teegen committed
90
import Base.TypeSubst
91
import Base.Typing
Finn Teegen's avatar
Finn Teegen committed
92
import Base.Utils (fst3)
93

Finn Teegen's avatar
Finn Teegen committed
94
import Env.TypeConstructor (TCEnv, TypeInfo (..), qualLookupTypeInfo)
95
import Env.Value (ValueEnv, ValueInfo (..), qualLookupValue)
96

97
98
99
100
-- The desugaring phase keeps only the type, function, and value
-- declarations of the module, i.e., type signatures are discarded.
-- While record declarations are transformed into ordinary data/newtype
-- declarations, the remaining type declarations are not desugared.
Finn Teegen's avatar
Finn Teegen committed
101
-- Since they cannot occur in local declaration groups, they are filtered
102
103
104
-- out separately. Actually, the transformation is slightly more general than
-- necessary as it allows value declarations at the top-level of a module.

Finn Teegen's avatar
Finn Teegen committed
105
106
107
desugar :: [KnownExtension] -> ValueEnv -> TCEnv -> Module PredType
        -> (Module PredType, ValueEnv)
desugar xs vEnv tcEnv (Module ps m es is ds)
108
109
  = (Module ps m es is ds', valueEnv s')
  where (ds', s') = S.runState (desugarModuleDecls ds)
Finn Teegen's avatar
Finn Teegen committed
110
                               (DesugarState m xs tcEnv vEnv 1)
111
112
113
114
115
116
117
118
119

-- ---------------------------------------------------------------------------
-- Desugaring monad and accessor functions
-- ---------------------------------------------------------------------------

-- New identifiers may be introduced while desugaring pattern declarations,
-- case and lambda-expressions, list comprehensions, and record selections
-- and updates. As usual, we use a state monad transformer for generating
-- unique names. In addition, the state is also used for passing through the
120
121
122
123
124
125
126
-- type environment, which must be augmented with the types of these new
-- variables.

data DesugarState = DesugarState
  { moduleIdent :: ModuleIdent      -- read-only
  , extensions  :: [KnownExtension] -- read-only
  , tyConsEnv   :: TCEnv            -- read-only
127
128
  , valueEnv    :: ValueEnv         -- will be extended
  , nextId      :: Integer          -- counter
129
130
131
132
133
134
135
  }

type DsM a = S.State DesugarState a

getModuleIdent :: DsM ModuleIdent
getModuleIdent = S.gets moduleIdent

136
137
checkNegativeLitsExtension :: DsM Bool
checkNegativeLitsExtension = S.gets (\s -> NegativeLiterals `elem` extensions s)
138
139
140
141
142
143
144
145
146
147

getTyConsEnv :: DsM TCEnv
getTyConsEnv = S.gets tyConsEnv

getValueEnv :: DsM ValueEnv
getValueEnv = S.gets valueEnv

getNextId :: DsM Integer
getNextId = do
  nid <- S.gets nextId
Finn Teegen's avatar
Finn Teegen committed
148
  S.modify $ \s -> s { nextId = succ nid }
149
150
151
152
153
154
  return nid

-- ---------------------------------------------------------------------------
-- Generation of fresh names
-- ---------------------------------------------------------------------------

155
-- Create a fresh variable ident for a given prefix with a monomorphic type
Finn Teegen's avatar
Finn Teegen committed
156
157
158
159
freshVar :: Typeable t => String -> t -> DsM (PredType, Ident)
freshVar prefix t = do
  v <- (mkIdent . (prefix ++) . show) <$> getNextId
  return (predType $ typeOf t, v)
160

161
162
163
-- ---------------------------------------------------------------------------
-- Desugaring
-- ---------------------------------------------------------------------------
164

Finn Teegen's avatar
Finn Teegen committed
165
desugarModuleDecls :: [Decl PredType] -> DsM [Decl PredType]
166
desugarModuleDecls ds = do
Finn Teegen's avatar
Finn Teegen committed
167
168
169
  ds'   <- concatMapM dsRecordDecl ds -- convert record decls to data decls
  ds''  <- mapM dsClassAndInstanceDecl ds'
  ds''' <- dsDeclGroup ds''
170
  return $ filter (not . liftM2 (||) isValueDecl isTypeSig) ds'' ++ ds'''
Finn Teegen's avatar
Finn Teegen committed
171
172
173
174
175
176
177
178
179
180
181
182

-- -----------------------------------------------------------------------------
-- Desugaring of class and instance declarations
-- -----------------------------------------------------------------------------

dsClassAndInstanceDecl :: Decl PredType -> DsM (Decl PredType)
dsClassAndInstanceDecl (ClassDecl p cx cls tv ds) =
  ClassDecl p cx cls tv . (tds ++) <$> dsDeclGroup vds
  where (tds, vds) = partition isTypeSig ds
dsClassAndInstanceDecl (InstanceDecl p cx cls ty ds) =
  InstanceDecl p cx cls ty <$> dsDeclGroup ds
dsClassAndInstanceDecl d = return d
183

184
185
186
187
188
189
190
191
192
-- -----------------------------------------------------------------------------
-- Desugaring of type declarations: records
-- -----------------------------------------------------------------------------

-- As an extension to the Curry language, the compiler supports Haskell's
-- record syntax, which introduces field labels for data and renaming types.
-- Field labels can be used in constructor declarations, patterns,
-- and expressions. For further convenience, an implicit selector
-- function is introduced for each field label.
193

194
195
-- Generate selector functions for record labels and replace record
-- constructor declarations by ordinary constructor declarations.
Finn Teegen's avatar
Finn Teegen committed
196
dsRecordDecl :: Decl PredType -> DsM [Decl PredType]
Finn Teegen's avatar
Finn Teegen committed
197
dsRecordDecl (DataDecl p tc tvs cs clss) = do
198
199
200
  m <- getModuleIdent
  let qcs = map (qualifyWith m . constrId) cs
  selFuns <- mapM (genSelFun p qcs) (nub $ concatMap recordLabels cs)
Finn Teegen's avatar
Finn Teegen committed
201
202
  return $ DataDecl p tc tvs (map unlabelConstr cs) clss : selFuns
dsRecordDecl (NewtypeDecl p tc tvs nc clss) = do
203
204
205
  m <- getModuleIdent
  let qc = qualifyWith m (nconstrId nc)
  selFun <- mapM (genSelFun p [qc]) (nrecordLabels nc)
Finn Teegen's avatar
Finn Teegen committed
206
  return $ NewtypeDecl p tc tvs (unlabelNewConstr nc) clss : selFun
Finn Teegen's avatar
Finn Teegen committed
207
dsRecordDecl d = return [d]
208
209

-- Generate a selector function for a single record label
Finn Teegen's avatar
Finn Teegen committed
210
211
212
213
214
215
genSelFun :: Position -> [QualIdent] -> Ident -> DsM (Decl PredType)
genSelFun p qcs l = do
  m <- getModuleIdent
  vEnv <- getValueEnv
  let ForAll _ pty = varType (qualifyWith m l) vEnv
  FunctionDecl p pty l <$> concatMapM (genSelEqn p l) qcs
216
217
218

-- Generate a selector equation for a label and a constructor if the label
-- is applicable, otherwise the empty list is returned.
Finn Teegen's avatar
Finn Teegen committed
219
genSelEqn :: Position -> Ident -> QualIdent -> DsM [Equation PredType]
220
genSelEqn p l qc = do
Finn Teegen's avatar
Finn Teegen committed
221
222
223
  vEnv <- getValueEnv
  let (ls, ty) = conType qc vEnv
      (tys, ty0) = arrowUnapply (instType ty)
224
  case elemIndex l ls of
Finn Teegen's avatar
Finn Teegen committed
225
226
227
228
    Just n  -> do
      vs <- mapM (freshVar "_#rec") tys
      let pat = constrPattern (predType ty0) qc vs
      return [mkEquation p l [pat] (uncurry mkVar (vs !! n))]
229
230
231
232
    Nothing -> return []

-- Remove any labels from a data constructor declaration
unlabelConstr :: ConstrDecl -> ConstrDecl
Finn Teegen's avatar
Finn Teegen committed
233
unlabelConstr (RecordDecl p evs cx c fs) = ConstrDecl p evs cx c tys
234
  where tys = [ty | FieldDecl _ ls ty <- fs, _ <- ls]
Finn Teegen's avatar
Finn Teegen committed
235
unlabelConstr c                          = c
236
237
238

-- Remove any labels from a newtype constructor declaration
unlabelNewConstr :: NewConstrDecl -> NewConstrDecl
Finn Teegen's avatar
Finn Teegen committed
239
240
unlabelNewConstr (NewRecordDecl p nc (_, ty)) = NewConstrDecl p nc ty
unlabelNewConstr c                            = c
241
242
243
244
245
246
247
248
249

-- -----------------------------------------------------------------------------
-- Desugaring of value declarations
-- -----------------------------------------------------------------------------

-- Within a declaration group, all type signatures are discarded. First,
-- the patterns occurring in the left hand sides of pattern declarations
-- and external declarations are desugared. Due to lazy patterns, the former
-- may add further declarations to the group that must be desugared as well.
Finn Teegen's avatar
Finn Teegen committed
250
dsDeclGroup :: [Decl PredType] -> DsM [Decl PredType]
251
dsDeclGroup ds = concatMapM dsDeclLhs (filter isValueDecl ds) >>= mapM dsDeclRhs
252

Finn Teegen's avatar
Finn Teegen committed
253
dsDeclLhs :: Decl PredType -> DsM [Decl PredType]
254
dsDeclLhs (PatternDecl p t rhs) = do
255
  (ds', t') <- dsPat p [] t
256
257
  dss'      <- mapM dsDeclLhs ds'
  return $ PatternDecl p t' rhs : concat dss'
Finn Teegen's avatar
Finn Teegen committed
258
dsDeclLhs (ExternalDecl   p vs) = return $ map (genForeignDecl p) vs
259
260
dsDeclLhs d                     = return [d]

Finn Teegen's avatar
Finn Teegen committed
261
262
263
264
genForeignDecl :: Position -> Var PredType -> Decl PredType
genForeignDecl p (Var pty v) =
  ForeignDecl p CallConvPrimitive (Just $ idName v) pty v $
    fromType identSupply $ typeOf pty
265

266
-- TODO: Check if obsolete and remove
267
268
269
270
271
272
273
274
275
-- After desugaring its right hand side, each equation is eta-expanded
-- by adding as many variables as necessary to the argument list and
-- applying the right hand side to those variables (Note: eta-expansion
-- is disabled in the version for PAKCS).
-- Furthermore every occurrence of a record type within the type of a function
-- is simplified to the corresponding type constructor from the record
-- declaration. This is possible because currently records must not be empty
-- and a record label belongs to only one record declaration.

276
-- Desugaring of the right-hand-side of declarations
Finn Teegen's avatar
Finn Teegen committed
277
278
279
280
281
282
dsDeclRhs :: Decl PredType -> DsM (Decl PredType)
dsDeclRhs (FunctionDecl     p pty f eqs) =
  FunctionDecl p pty f <$> mapM dsEquation eqs
dsDeclRhs (PatternDecl          p t rhs) = PatternDecl p t <$> dsRhs p id rhs
dsDeclRhs (ForeignDecl p cc ie pty f ty) =
  return $ ForeignDecl p cc ie' pty f ty
283
  where ie' = ie `mplus` Just (idName f)
Finn Teegen's avatar
Finn Teegen committed
284
285
286
dsDeclRhs fs@(FreeDecl              _ _) = return fs
dsDeclRhs _                              =
  error "Desugar.dsDeclRhs: no pattern match"
287

288
-- Desugaring of an equation
Finn Teegen's avatar
Finn Teegen committed
289
dsEquation :: Equation PredType -> DsM (Equation PredType)
290
dsEquation (Equation p lhs rhs) = do
291
292
293
294
295
296
  (     cs1, ts1) <- dsNonLinearity         ts
  (ds1, cs2, ts2) <- dsFunctionalPatterns p ts1
  (ds2,      ts3) <- mapAccumM (dsPat p) [] ts2
  rhs'            <- dsRhs p (constrain cs2 . constrain cs1)
                             (addDecls (ds1 ++ ds2) rhs)
  return $ Equation p (FunLhs f ts3) rhs'
297
298
  where (f, ts) = flatLhs lhs

299
300
301
-- Constrain an expression by a list of constraints.
-- @constrain []  e  ==  e@
-- @constrain c_n e  ==  (c_1 & ... & c_n) &> e@
Finn Teegen's avatar
Finn Teegen committed
302
constrain :: [Expression PredType] -> Expression PredType -> Expression PredType
303
constrain cs e = if null cs then e else foldr1 (&) cs &> e
304
305
306
307
308
309
310
311
312
313
314
315
316

-- -----------------------------------------------------------------------------
-- Desugaring of right-hand sides
-- -----------------------------------------------------------------------------

-- A list of boolean guards is expanded into a nested if-then-else
-- expression, whereas a constraint guard is replaced by a case
-- expression. Note that if the guard type is 'Success' only a
-- single guard is allowed for each equation (This change was
-- introduced in version 0.8 of the Curry report.). We check for the
-- type 'Bool' of the guard because the guard's type defaults to
-- 'Success' if it is not restricted by the guard expression.

Finn Teegen's avatar
Finn Teegen committed
317
318
dsRhs :: Position -> (Expression PredType -> Expression PredType)
      -> Rhs PredType -> DsM (Rhs PredType)
319
dsRhs p f rhs =     expandRhs (prelFailed (typeOf rhs)) f rhs
320
321
322
323
                >>= dsExpr pRhs
                >>= return . simpleRhs pRhs
  where
  pRhs = fromMaybe p (getRhsPosition rhs)
324

Finn Teegen's avatar
Finn Teegen committed
325
326
expandRhs :: Expression PredType -> (Expression PredType -> Expression PredType)
          -> Rhs PredType -> DsM (Expression PredType)
327
328
329
expandRhs _  f (SimpleRhs _ e ds) = return $ Let ds (f e)
expandRhs e0 f (GuardedRhs es ds) = (Let ds . f) <$> expandGuards e0 es

Finn Teegen's avatar
Finn Teegen committed
330
331
332
333
expandGuards :: Expression PredType -> [CondExpr PredType]
             -> DsM (Expression PredType)
expandGuards e0 es =
  return $ if boolGuards es then foldr mkIfThenElse e0 es else mkCond es
334
335
  where
  mkIfThenElse (CondExpr p g e) = IfThenElse (srcRefOf p) g e
336
  mkCond [CondExpr _ g e] = g &> e
337
338
  mkCond _                = error "Desugar.expandGuards.mkCond: non-unary list"

Finn Teegen's avatar
Finn Teegen committed
339
340
341
boolGuards :: [CondExpr PredType] -> Bool
boolGuards []                    = False
boolGuards (CondExpr _ g _ : es) = not (null es) || typeOf g == boolType
342
343

-- Add additional declarations to a right-hand side
Finn Teegen's avatar
Finn Teegen committed
344
addDecls :: [Decl PredType] -> Rhs PredType -> Rhs PredType
345
346
347
addDecls ds (SimpleRhs p e ds') = SimpleRhs p e (ds ++ ds')
addDecls ds (GuardedRhs es ds') = GuardedRhs es (ds ++ ds')

348
getRhsPosition :: Rhs a -> Maybe Position
349
getRhsPosition (SimpleRhs p _ _) = Just p
350
getRhsPosition (GuardedRhs  _ _) = Nothing
351

352
353
354
355
-- -----------------------------------------------------------------------------
-- Desugaring of non-linear patterns
-- -----------------------------------------------------------------------------

356
357
358
359
-- The desugaring traverses a pattern in depth-first order and collects
-- all variables. If it encounters a variable which has been previously
-- introduced, the second occurrence is changed to a fresh variable
-- and a new pair (newvar, oldvar) is saved to generate constraints later.
360
-- Non-linear patterns inside single functional patterns are not desugared,
361
-- as this special case is handled later.
Finn Teegen's avatar
Finn Teegen committed
362
363
dsNonLinearity :: [Pattern PredType]
               -> DsM ([Expression PredType], [Pattern PredType])
364
365
366
367
dsNonLinearity ts = do
  ((_, cs), ts') <- mapAccumM dsNonLinear (Set.empty, []) ts
  return (reverse cs, ts')

Finn Teegen's avatar
Finn Teegen committed
368
type NonLinearEnv = (Set.Set Ident, [Expression PredType])
369

Finn Teegen's avatar
Finn Teegen committed
370
371
372
373
374
dsNonLinear :: NonLinearEnv -> Pattern PredType
            -> DsM (NonLinearEnv, Pattern PredType)
dsNonLinear env l@(LiteralPattern        _ _) = return (env, l)
dsNonLinear env n@(NegativePattern     _ _ _) = return (env, n)
dsNonLinear env t@(VariablePattern       _ v)
375
  | isAnonId v         = return (env, t)
376
  | v `Set.member` vis = do
Finn Teegen's avatar
Finn Teegen committed
377
378
    v' <- freshVar "_#nonlinear" t
    return ((vis, mkStrictEquality v v' : eqs), uncurry VariablePattern v')
379
380
  | otherwise          = return ((Set.insert v vis, eqs), t)
  where (vis, eqs) = env
Finn Teegen's avatar
Finn Teegen committed
381
382
383
dsNonLinear env (ConstructorPattern pty c ts) = second (ConstructorPattern pty c)
                                                <$> mapAccumM dsNonLinear env ts
dsNonLinear env (InfixPattern   pty t1 op t2) = do
384
385
  (env1, t1') <- dsNonLinear env  t1
  (env2, t2') <- dsNonLinear env1 t2
Finn Teegen's avatar
Finn Teegen committed
386
  return (env2, InfixPattern pty t1' op t2')
387
388
dsNonLinear env (ParenPattern            t) = second ParenPattern
                                              <$> dsNonLinear env t
Finn Teegen's avatar
Finn Teegen committed
389
390
391
392
393
394
dsNonLinear env (RecordPattern      pty c fs) =
  second (RecordPattern pty c) <$> mapAccumM (dsField dsNonLinear) env fs
dsNonLinear env (TuplePattern         pos ts) = second (TuplePattern pos)
                                                <$> mapAccumM dsNonLinear env ts
dsNonLinear env (ListPattern      pty pos ts) = second (ListPattern pty pos)
                                                <$> mapAccumM dsNonLinear env ts
395
dsNonLinear env (AsPattern             v t) = do
Finn Teegen's avatar
Finn Teegen committed
396
397
398
  let pty = predType $ typeOf t
  (env1, VariablePattern _ v') <- dsNonLinear env (VariablePattern pty v)
  (env2, t') <- dsNonLinear env1 t
399
  return (env2, AsPattern v' t')
Finn Teegen's avatar
Finn Teegen committed
400
401
402
403
dsNonLinear env (LazyPattern             r t) = second (LazyPattern r)
                                                <$> dsNonLinear env t
dsNonLinear env fp@(FunctionPattern    _ _ _) = dsNonLinearFuncPat env fp
dsNonLinear env fp@(InfixFuncPattern _ _ _ _) = dsNonLinearFuncPat env fp
404

Finn Teegen's avatar
Finn Teegen committed
405
406
dsNonLinearFuncPat :: NonLinearEnv -> Pattern PredType
                   -> DsM (NonLinearEnv, Pattern PredType)
407
dsNonLinearFuncPat (vis, eqs) fp = do
Finn Teegen's avatar
Finn Teegen committed
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
  let fpVars = map (\(v, _, pty) -> (pty, v)) $ patternVars fp
      vs     = filter ((`Set.member` vis) . snd) fpVars
  vs' <- mapM (freshVar "_#nonlinear" . uncurry VariablePattern) vs
  let vis' = foldr (Set.insert . snd) vis fpVars
      fp'  = substPat (zip (map snd vs) (map snd vs')) fp
  return ((vis', zipWith mkStrictEquality (map snd vs) vs' ++ eqs), fp')

mkStrictEquality :: Ident -> (PredType, Ident) -> Expression PredType
mkStrictEquality x (pty, y) = mkVar pty x =:= mkVar pty y

substPat :: [(Ident, Ident)] -> Pattern a -> Pattern a
substPat _ l@(LiteralPattern        _ _) = l
substPat _ n@(NegativePattern     _ _ _) = n
substPat s (VariablePattern         a v) = VariablePattern a
                                         $ fromMaybe v (lookup v s)
substPat s (ConstructorPattern   a c ps) = ConstructorPattern a c
                                         $ map (substPat s) ps
substPat s (InfixPattern     a p1 op p2) = InfixPattern a (substPat s p1) op
                                                        (substPat s p2)
substPat s (ParenPattern              p) = ParenPattern (substPat s p)
substPat s (RecordPattern        a c fs) = RecordPattern a c (map substField fs)
429
  where substField (Field pos l pat) = Field pos l (substPat s pat)
Finn Teegen's avatar
Finn Teegen committed
430
431
432
433
434
435
436
437
438
439
440
substPat s (TuplePattern         pos ps) = TuplePattern pos
                                         $ map (substPat s) ps
substPat s (ListPattern        a pos ps) = ListPattern a pos
                                         $ map (substPat s) ps
substPat s (AsPattern               v p) = AsPattern (fromMaybe v (lookup v s))
                                                     (substPat s p)
substPat s (LazyPattern             r p) = LazyPattern r (substPat s p)
substPat s (FunctionPattern      a f ps) = FunctionPattern a f
                                         $ map (substPat s) ps
substPat s (InfixFuncPattern a p1 op p2) = InfixFuncPattern a (substPat s p1) op
                                                            (substPat s p2)
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459

-- -----------------------------------------------------------------------------
-- Desugaring of functional patterns
-- -----------------------------------------------------------------------------

-- Desugaring of functional patterns works in the following way:
--  1. The patterns are recursively traversed from left to right
--     to extract every functional pattern (note that functional patterns
--     can not be nested).
--     Each pattern is replaced by a fresh variable and a pair
--     (variable, functional pattern) is generated.
--  2. The variable-pattern pairs of the form @(v, p)@ are collected and
--     transformed into additional constraints of the form @p =:<= v@,
--     where the pattern @p@ is converted to the corresponding expression.
--     In addition, any variable occurring in @p@ is declared as a fresh
--     free variable.
--     Multiple constraints will later be combined using the @&>@-operator
--     such that the patterns are evaluated from left to right.

Finn Teegen's avatar
Finn Teegen committed
460
461
462
dsFunctionalPatterns
  :: Position -> [Pattern PredType]
  -> DsM ([Decl PredType], [Expression PredType], [Pattern PredType])
463
464
465
466
dsFunctionalPatterns p ts = do
  -- extract functional patterns
  (bs, ts') <- mapAccumM elimFP [] ts
  -- generate declarations of free variables and constraints
Finn Teegen's avatar
Finn Teegen committed
467
  let (ds, cs) = genFPExpr p (concatMap patternVars ts') (reverse bs)
468
469
470
  -- return (declarations, constraints, desugared patterns)
  return (ds, cs, ts')

Finn Teegen's avatar
Finn Teegen committed
471
type LazyBinding = (Pattern PredType, (PredType, Ident))
472

Finn Teegen's avatar
Finn Teegen committed
473
474
475
476
477
478
479
480
elimFP :: [LazyBinding] -> Pattern PredType
       -> DsM ([LazyBinding], Pattern PredType)
elimFP bs p@(LiteralPattern        _ _) = return (bs, p)
elimFP bs p@(NegativePattern     _ _ _) = return (bs, p)
elimFP bs p@(VariablePattern       _ _) = return (bs, p)
elimFP bs (ConstructorPattern pty c ts) = second (ConstructorPattern pty c)
                                          <$> mapAccumM elimFP bs ts
elimFP bs (InfixPattern   pty t1 op t2) = do
481
482
  (bs1, t1') <- elimFP bs  t1
  (bs2, t2') <- elimFP bs1 t2
Finn Teegen's avatar
Finn Teegen committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
  return (bs2, InfixPattern pty t1' op t2')
elimFP bs (ParenPattern              t) = second ParenPattern <$> elimFP bs t
elimFP bs (RecordPattern      pty c fs) = second (RecordPattern pty c)
                                          <$> mapAccumM (dsField elimFP) bs fs
elimFP bs (TuplePattern         pos ts) = second (TuplePattern pos)
                                          <$> mapAccumM elimFP bs ts
elimFP bs (ListPattern      pty pos ts) = second (ListPattern pty pos)
                                          <$> mapAccumM elimFP bs ts
elimFP bs (AsPattern               v t) = second (AsPattern   v) <$> elimFP bs t
elimFP bs (LazyPattern             r t) = second (LazyPattern r) <$> elimFP bs t
elimFP bs p@(FunctionPattern     _ _ _) = do
 (pty, v) <- freshVar "_#funpatt" p
 return ((p, (pty, v)) : bs, VariablePattern pty v)
elimFP bs p@(InfixFuncPattern  _ _ _ _) = do
 (pty, v) <- freshVar "_#funpatt" p
 return ((p, (pty, v)) : bs, VariablePattern pty v)

genFPExpr :: Position -> [(Ident, Int, PredType)] -> [LazyBinding]
          -> ([Decl PredType], [Expression PredType])
502
503
504
genFPExpr p vs bs
  | null bs   = ([]               , [])
  | null free = ([]               , cs)
Finn Teegen's avatar
Finn Teegen committed
505
  | otherwise = ([FreeDecl p (map (\(v, _, pty) -> Var pty v) free)], cs)
506
  where
Finn Teegen's avatar
Finn Teegen committed
507
508
509
510
511
512
513
514
515
516
517
  mkLB (t, (pty, v)) = let (t', es) = fp2Expr t
                       in  (t' =:<= mkVar pty v) : es
  cs   = concatMap mkLB bs
  free = nub $ filter (not . isAnonId . fst3) $
                 concatMap patternVars (map fst bs) \\ vs

fp2Expr :: Pattern PredType -> (Expression PredType, [Expression PredType])
fp2Expr (LiteralPattern          pty l) = (Literal pty l, [])
fp2Expr (NegativePattern       pty _ l) = (Literal pty (negateLiteral l), [])
fp2Expr (VariablePattern         pty v) = (mkVar pty v, [])
fp2Expr (ConstructorPattern   pty c ts) =
518
  let (ts', ess) = unzip $ map fp2Expr ts
Finn Teegen's avatar
Finn Teegen committed
519
520
  in  (apply (Constructor pty c) ts', concat ess)
fp2Expr (InfixPattern   pty t1 op t2) =
521
522
  let (t1', es1) = fp2Expr t1
      (t2', es2) = fp2Expr t2
Finn Teegen's avatar
Finn Teegen committed
523
524
525
526
      pty' = predType $ TypeArrow (typeOf t1') $ TypeArrow (typeOf t2') $ unpredType pty
  in  (InfixApply t1' (InfixConstr pty' op) t2', es1 ++ es2)
fp2Expr (ParenPattern                t) = first Paren (fp2Expr t)
fp2Expr (TuplePattern             r ts) =
527
528
  let (ts', ess) = unzip $ map fp2Expr ts
  in  (Tuple r ts', concat ess)
Finn Teegen's avatar
Finn Teegen committed
529
fp2Expr (ListPattern         pty rs ts) =
530
  let (ts', ess) = unzip $ map fp2Expr ts
Finn Teegen's avatar
Finn Teegen committed
531
532
  in  (List pty rs ts', concat ess)
fp2Expr (FunctionPattern      pty f ts) =
533
  let (ts', ess) = unzip $ map fp2Expr ts
Finn Teegen's avatar
Finn Teegen committed
534
535
  in  (apply (Variable pty f) ts', concat ess)
fp2Expr (InfixFuncPattern pty t1 op t2) =
536
537
  let (t1', es1) = fp2Expr t1
      (t2', es2) = fp2Expr t2
Finn Teegen's avatar
Finn Teegen committed
538
539
540
      pty' = predType $ TypeArrow (typeOf t1') $ TypeArrow (typeOf t2') $ unpredType pty
  in  (InfixApply t1' (InfixOp pty' op) t2', es1 ++ es2)
fp2Expr (AsPattern                 v t) =
541
  let (t', es) = fp2Expr t
Finn Teegen's avatar
Finn Teegen committed
542
543
544
      pty = predType $ typeOf t
  in  (mkVar pty v, (t' =:<= mkVar pty v) : es)
fp2Expr (RecordPattern        pty c fs) =
545
546
  let (fs', ess) = unzip [ (Field p f e, es) | Field p f t <- fs
                                             , let (e, es) = fp2Expr t]
Finn Teegen's avatar
Finn Teegen committed
547
548
  in  (Record pty c fs', concat ess)
fp2Expr t                               = internalError $
549
550
551
  "Desugar.fp2Expr: Unexpected constructor term: " ++ show t

-- -----------------------------------------------------------------------------
552
-- Desugaring of ordinary patterns
553
-- -----------------------------------------------------------------------------
554
555
556
557
558
559
560
561

-- The transformation of patterns is straight forward except for lazy
-- patterns. A lazy pattern '~t' is replaced by a fresh
-- variable 'v' and a new local declaration 't = v' in the
-- scope of the pattern. In addition, as-patterns 'v@t' where
-- 't' is a variable or an as-pattern are replaced by 't' in combination
-- with a local declaration for 'v'.

562
563
564
565
566
567
568
569
570
571
572
573
574
-- Record patterns are transformed into normal constructor patterns by
-- rearranging fields in the order of the record's declaration, adding
-- fresh variables in place of omitted fields, and discarding the field
-- labels.

-- Note: By rearranging fields here we loose the ability to comply
-- strictly with the Haskell 98 pattern matching semantics, which matches
-- fields of a record pattern in the order of their occurrence in the
-- pattern. However, keep in mind that Haskell matches alternatives from
-- top to bottom and arguments within an equation or alternative from
-- left to right, which is not the case in Curry except for rigid case
-- expressions.

Finn Teegen's avatar
Finn Teegen committed
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
dsLiteralPat :: PredType -> Literal
             -> Either (Pattern PredType) (Pattern PredType)
dsLiteralPat pty c@(Char _ _) = Right (LiteralPattern pty c)
dsLiteralPat pty (Int ref i) =
  Right (LiteralPattern pty (fixLiteral (unpredType pty)))
  where fixLiteral (TypeConstrained tys _) = fixLiteral (head tys)
        fixLiteral ty
          | ty == floatType = Float ref $ fromInteger i
          | otherwise = Int ref i
dsLiteralPat pty f@(Float _ _) = Right (LiteralPattern pty f)
dsLiteralPat pty (String (SrcRef [i]) cs) =
  Left $ ListPattern pty (consRefs i cs) $
    map (LiteralPattern pty') $ zipWith (Char . SrcRef . (:[])) [i, i + 2 ..] cs
  where pty' = predType $ elemType $ unpredType pty
        -- TODO: Share with 'dsLiteral'
        consRefs r []     = [SrcRef [r]]
        consRefs r (_:xs) = let r' = r + 2
                            in  r' `seq` (SrcRef [r'] : consRefs r' xs)
dsLiteralPat _ (String _ _) = internalError $
  "Desugar.dsLiteralPat: wrong source ref for string"

dsPat :: Position -> [Decl PredType] -> Pattern PredType
      -> DsM ([Decl PredType], Pattern PredType)
dsPat _ ds v@(VariablePattern     _ _) = return (ds, v)
dsPat p ds (LiteralPattern      pty l) =
  either (dsPat p ds) (return . (,) ds) (dsLiteralPat pty l)
dsPat p ds (NegativePattern   pty _ l) =
  dsPat p ds (LiteralPattern pty (negateLiteral l))
dsPat p ds (ConstructorPattern pty c [t]) = do
604
605
  isNc <- isNewtypeConstr c
  if isNc then dsPat p ds t else second (constrPat c) <$> dsPat p ds t
Finn Teegen's avatar
Finn Teegen committed
606
607
608
609
610
  where constrPat c' t' = ConstructorPattern pty c' [t']
dsPat p ds (ConstructorPattern pty c ts) =
  second (ConstructorPattern pty c) <$> mapAccumM (dsPat p) ds ts
dsPat p ds (InfixPattern  pty t1 op t2) =
  dsPat p ds (ConstructorPattern pty op [t1, t2])
611
dsPat p ds (ParenPattern           t) = dsPat p ds t
Finn Teegen's avatar
Finn Teegen committed
612
613
614
615
616
617
618
619
620
dsPat p ds (RecordPattern   pty c fs) = do
  vEnv <- getValueEnv
  --TODO: Rework
  let (ls, tys) = argumentTypes (unpredType pty) c vEnv
      tsMap = map field2Tuple fs
      anonTs = map (flip VariablePattern anonId . predType) tys
      maybeTs = map (flip lookup tsMap) ls
      ts = zipWith fromMaybe anonTs maybeTs
  dsPat p ds (ConstructorPattern pty c ts)
621
dsPat p ds (TuplePattern      pos ts) =
Finn Teegen's avatar
Finn Teegen committed
622
623
624
  dsPat p ds (ConstructorPattern pty (addRef pos $ qTupleId $ length ts) ts)
  where pty = predType (tupleType (map typeOf ts))
dsPat p ds (ListPattern      pty pos ts) =
625
  second (dsList pos cons nil) <$> mapAccumM (dsPat p) ds ts
Finn Teegen's avatar
Finn Teegen committed
626
627
  where nil  p' = ConstructorPattern pty (addRef p' qNilId) []
        cons p' t ts' = ConstructorPattern pty (addRef p' qConsId) [t, ts']
628
629
dsPat p ds (AsPattern            v t) = dsAs p v <$> dsPat p ds t
dsPat p ds (LazyPattern          r t) = dsLazy r p ds t
Finn Teegen's avatar
Finn Teegen committed
630
dsPat p ds (FunctionPattern    pty f ts) = second (FunctionPattern pty f)
631
                                        <$> mapAccumM (dsPat p) ds ts
Finn Teegen's avatar
Finn Teegen committed
632
633
dsPat p ds (InfixFuncPattern pty t1 f t2) =
  dsPat p ds (FunctionPattern pty f [t1, t2])
634

Finn Teegen's avatar
Finn Teegen committed
635
636
dsAs :: Position -> Ident -> ([Decl PredType], Pattern PredType)
     -> ([Decl PredType], Pattern PredType)
637
dsAs p v (ds, t) = case t of
Finn Teegen's avatar
Finn Teegen committed
638
639
640
641
  VariablePattern pty v' -> (varDecl p pty v (mkVar pty v') : ds, t)
  AsPattern        v' t' -> (varDecl p pty' v (mkVar pty' v') : ds, t)
    where pty' = predType $ typeOf t'
  _                      -> (ds, AsPattern v t)
642

Finn Teegen's avatar
Finn Teegen committed
643
644
dsLazy :: SrcRef -> Position -> [Decl PredType] -> Pattern PredType
       -> DsM ([Decl PredType], Pattern PredType)
645
dsLazy pos p ds t = case t of
Finn Teegen's avatar
Finn Teegen committed
646
  VariablePattern _ _ -> return (ds, t)
647
  ParenPattern     t' -> dsLazy pos p ds t'
648
  AsPattern      v t' -> dsAs p v <$> dsLazy pos p ds t'
649
650
  LazyPattern pos' t' -> dsLazy pos' p ds t'
  _                   -> do
Finn Teegen's avatar
Finn Teegen committed
651
652
653
654
    (pty, v'') <- freshVar "_#lazy" t
    v' <- addPositionIdent (AST pos) <$> return v''
    return ( patDecl p { astRef = pos } t (mkVar pty v') : ds
           , VariablePattern pty v' )
655

Finn Teegen's avatar
Finn Teegen committed
656
{-
657
658
659
-- -----------------------------------------------------------------------------
-- Desugaring of expressions
-- -----------------------------------------------------------------------------
660

661
662
-- Record construction expressions are transformed into normal
-- constructor applications by rearranging fields in the order of the
663
-- record's declaration, passing `Prelude.unknown` in place of
664
665
666
667
668
669
-- omitted fields, and discarding the field labels. The transformation of
-- record update expressions is a bit more involved as we must match the
-- updated expression with all valid constructors of the expression's
-- type. As stipulated by the Haskell 98 Report, a record update
-- expression @e { l_1 = e_1, ..., l_k = e_k }@ succeeds only if @e@ reduces to
-- a value @C e'_1 ... e'_n@ such that @C@'s declaration contains all
670
671
-- field labels @l_1,...,l_k@. In contrast to Haskell, we do not report
-- an error if this is not the case, but call failed instead.
Finn Teegen's avatar
Finn Teegen committed
672
673
674
675
676
677
-}
dsExpr :: Position -> Expression PredType -> DsM (Expression PredType)
dsExpr p (Literal     pty l) =
  either (dsExpr p) return (dsLiteral pty l)
dsExpr _ var@(Variable pty v)
  | isAnonId (unqualify v)   = return $ prelUnknown $ unpredType pty
678
  | otherwise                = return var
Finn Teegen's avatar
Finn Teegen committed
679
dsExpr _ c@(Constructor _ _) = return c
680
dsExpr p (Paren           e) = dsExpr p e
Finn Teegen's avatar
Finn Teegen committed
681
682
683
684
685
686
687
688
689
690
dsExpr p (Typed       e qty) = Typed <$> dsExpr p e <*> dsQualTypeExpr qty
dsExpr p (Record   pty c fs) = do
  vEnv <- getValueEnv
  --TODO: Rework
  let (ls, tys) = argumentTypes (unpredType pty) c vEnv
      esMap = map field2Tuple fs
      unknownEs = map prelUnknown tys
      maybeEs = map (flip lookup esMap) ls
      es = zipWith fromMaybe unknownEs maybeEs
  dsExpr p (applyConstr pty c tys es)
691
dsExpr p (RecordUpdate e fs) = do
Finn Teegen's avatar
Finn Teegen committed
692
  alts  <- constructors tc >>= concatMapM updateAlt
693
  dsExpr p $ Case (srcRefOf p) Flex e (map (uncurry (caseAlt p)) alts)
Finn Teegen's avatar
Finn Teegen committed
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
  where ty = typeOf e
        pty = predType ty
        TypeConstructor tc = arrowBase ty
        updateAlt (RecordConstr c _ _ ls tys)
          | all (`elem` qls) (map fieldLabel fs)= do
            vs <- mapM (freshVar "_#rec") tys
            let qc = qualifyLike tc c
                pat = constrPattern pty qc vs
                esMap = map field2Tuple fs
                originalEs = map (uncurry mkVar) vs
                maybeEs = map (flip lookup esMap) qls
                es = zipWith fromMaybe originalEs maybeEs
            return [(pat, applyConstr pty qc tys es)]
          where qls = map (qualifyLike tc) ls
        updateAlt _ = return []
dsExpr p (Tuple      ref es) = apply (Constructor pty $ addRef ref $ qTupleId $ length es) <$> mapM (dsExpr p) es
  where pty = predType (foldr TypeArrow (tupleType tys) tys)
        tys = map typeOf es
dsExpr p (List   pty refs es) = dsList refs cons nil <$> mapM (dsExpr p) es
  where nil  p' = Constructor pty (addRef p' qNilId)
        cons p' = Apply . Apply (Constructor (predType $ consType $ elemType $ unpredType pty) (addRef p' qConsId))
715
dsExpr p (ListCompr        r e qs) = dsListComp p r e qs
Finn Teegen's avatar
Finn Teegen committed
716
717
718
dsExpr p (EnumFrom              e) = Apply (prelEnumFrom (typeOf e))
                                     <$> dsExpr p e
dsExpr p (EnumFromThen      e1 e2) = apply (prelEnumFromThen (typeOf e1))
719
                                     <$> mapM (dsExpr p) [e1, e2]
Finn Teegen's avatar
Finn Teegen committed
720
dsExpr p (EnumFromTo        e1 e2) = apply (prelEnumFromTo (typeOf e1))
721
                                     <$> mapM (dsExpr p) [e1, e2]
Finn Teegen's avatar
Finn Teegen committed
722
dsExpr p (EnumFromThenTo e1 e2 e3) = apply (prelEnumFromThenTo (typeOf e1))
723
                                     <$> mapM (dsExpr p) [e1, e2, e3]
Finn Teegen's avatar
Finn Teegen committed
724
dsExpr p (UnaryMinus          _ e) = do
725
  e' <- dsExpr p e
726
727
  negativeLitsEnabled <- checkNegativeLitsExtension
  return $ case e' of
Finn Teegen's avatar
Finn Teegen committed
728
729
730
    Literal pty l | negativeLitsEnabled -> Literal pty $ negateLiteral l
    _                                   -> Apply (prelNegate $ typeOf e') e'
dsExpr p (Apply (Constructor pty c) e) = do
731
  isNc <- isNewtypeConstr c
Finn Teegen's avatar
Finn Teegen committed
732
  if isNc then dsExpr p e else Apply (Constructor pty c) <$> dsExpr p e
733
dsExpr p (Apply e1 e2) = Apply <$> dsExpr p e1 <*> dsExpr p e2
734
735
736
737
738
dsExpr p (InfixApply e1 op e2) = do
  op' <- dsExpr p (infixOp op)
  e1' <- dsExpr p e1
  e2' <- dsExpr p e2
  return $ apply op' [e1', e2']
739
dsExpr p (LeftSection  e op) = Apply <$> dsExpr p (infixOp op) <*> dsExpr p e
740
741
dsExpr p (RightSection op e) = do
  op' <- dsExpr p (infixOp op)
742
  e'  <- dsExpr p e
Finn Teegen's avatar
Finn Teegen committed
743
744
  return $ apply (prelFlip ty1 ty2 ty3) [op', e']
  where TypeArrow ty1 (TypeArrow ty2 ty3) = typeOf (infixOp op)
745
dsExpr p expr@(Lambda r ts e) = do
Finn Teegen's avatar
Finn Teegen committed
746
747
  (pty, f) <- freshVar "_#lambda" expr
  dsExpr p $ Let [funDecl (AST r) pty f ts e] $ mkVar pty f
748
749
dsExpr p (Let ds e) = do
  ds' <- dsDeclGroup ds
750
  e'  <- dsExpr p e
751
  return (if null ds' then e' else Let ds' e')
752
dsExpr p (Do              sts e) = dsDo sts e >>= dsExpr p
753
754
755
756
dsExpr p (IfThenElse r e1 e2 e3) = do
  e1' <- dsExpr p e1
  e2' <- dsExpr p e2
  e3' <- dsExpr p e3
757
  return $ Case r Rigid e1' [caseAlt p truePat e2', caseAlt p falsePat e3']
758
dsExpr p (Case r ct e alts) = dsCase p r ct e alts
759

Finn Teegen's avatar
Finn Teegen committed
760
761
762
763
764
765
766
767
-- We ignore the context in the type signature of a typed expression, since
-- there should be no possibility to provide an non-empty context without
-- scoped type-variables.
-- TODO: Verify

dsQualTypeExpr :: QualTypeExpr -> DsM QualTypeExpr
dsQualTypeExpr (QualTypeExpr cx ty) = QualTypeExpr cx <$> dsTypeExpr ty

768
769
dsTypeExpr :: TypeExpr -> DsM TypeExpr
dsTypeExpr ty = do
Finn Teegen's avatar
Finn Teegen committed
770
  m <- getModuleIdent
771
  tcEnv <- getTyConsEnv
Finn Teegen's avatar
Finn Teegen committed
772
  return $ fromType (typeVariables ty) (expandType m tcEnv (toType [] ty))
773

774
775
776
-- -----------------------------------------------------------------------------
-- Desugaring of case expressions
-- -----------------------------------------------------------------------------
777

778
779
780
781
782
783
784
785
-- If an alternative in a case expression has boolean guards and all of
-- these guards return 'False', the enclosing case expression does
-- not fail but continues to match the remaining alternatives against the
-- selector expression. In order to implement this semantics, which is
-- compatible with Haskell, we expand an alternative with boolean guards
-- such that it evaluates a case expression with the remaining cases that
-- are compatible with the matched pattern when the guards fail.

Finn Teegen's avatar
Finn Teegen committed
786
787
dsCase :: Position -> SrcRef -> CaseType -> Expression PredType
       -> [Alt PredType] -> DsM (Expression PredType)
788
dsCase p r ct e alts
Finn Teegen's avatar
Finn Teegen committed
789
  | null alts = internalError "Desugar.dsCase: empty list of alternatives"
790
791
792
  | otherwise = do
    m  <- getModuleIdent
    e' <- dsExpr p e
Finn Teegen's avatar
Finn Teegen committed
793
    v  <- freshVar "_#case" e
794
795
796
797
    alts'  <- mapM dsAltLhs alts
    alts'' <- mapM (expandAlt v ct) (init (tails alts')) >>= mapM dsAltRhs
    return (mkCase m v e' alts'')
  where
Finn Teegen's avatar
Finn Teegen committed
798
799
  mkCase m (pty, v) e' bs
    | v `elem` qfv m bs = Let [varDecl p pty v e'] (Case r ct (mkVar pty v) bs)
800
801
    | otherwise         = Case r ct e' bs

Finn Teegen's avatar
Finn Teegen committed
802
dsAltLhs :: Alt PredType -> DsM (Alt PredType)
803
dsAltLhs (Alt p t rhs) = do
804
  (ds', t') <- dsPat p [] t
805
806
  return $ Alt p t' (addDecls ds' rhs)

Finn Teegen's avatar
Finn Teegen committed
807
dsAltRhs :: Alt PredType -> DsM (Alt PredType)
808
dsAltRhs (Alt p t rhs) = Alt p t <$> dsRhs p id rhs
809

Finn Teegen's avatar
Finn Teegen committed
810
811
expandAlt :: (PredType, Ident) -> CaseType -> [Alt PredType]
          -> DsM (Alt PredType)
812
expandAlt _ _  []                   = error "Desugar.expandAlt: empty list"
813
expandAlt v ct (Alt p t rhs : alts) = caseAlt p t <$> expandRhs e0 id rhs
814
  where
Finn Teegen's avatar
Finn Teegen committed
815
816
817
  e0 | ct == Flex || null compAlts = prelFailed (typeOf rhs)
     | otherwise = Case (srcRefOf p) ct (uncurry mkVar v) compAlts
  compAlts = filter (isCompatible t . altPattern) alts
818
819
  altPattern (Alt _ t1 _) = t1

Finn Teegen's avatar
Finn Teegen committed
820
821
822
823
824
825
isCompatible :: Pattern a -> Pattern a -> Bool
isCompatible (VariablePattern _ _) _ = True
isCompatible _ (VariablePattern _ _) = True
isCompatible (AsPattern _ t1) t2 = isCompatible t1 t2
isCompatible t1 (AsPattern _ t2) = isCompatible t1 t2
isCompatible (ConstructorPattern _ c1 ts1) (ConstructorPattern _ c2 ts2)
826
  = and ((c1 == c2) : zipWith isCompatible ts1 ts2)
Finn Teegen's avatar
Finn Teegen committed
827
828
isCompatible (LiteralPattern _ l1) (LiteralPattern _ l2) = l1 == l2
isCompatible _ _ = False
829

830
-- -----------------------------------------------------------------------------
831
-- Desugaring of do-Notation
832
-- -----------------------------------------------------------------------------
833

834
835
836
837
-- The do-notation is desugared in the following way:
--
-- `dsDo([]         , e)` -> `e`
-- `dsDo(e'     ; ss, e)` -> `e' >>        dsDo(ss, e)`
838
839
840
-- `dsDo(p <- e'; ss, e)` -> `e' >>= \v -> case v of
--                                           p -> dsDo(ss, e)
--                                           _ -> fail "..."`
841
-- `dsDo(let ds ; ss, e)` -> `let ds in    dsDo(ss, e)`
842
843
dsDo :: [Statement PredType] -> Expression PredType -> DsM (Expression PredType)
dsDo sts e = foldrM dsStmt e sts
Finn Teegen's avatar
Finn Teegen committed
844

845
dsStmt :: Statement PredType -> Expression PredType -> DsM (Expression PredType)
Finn Teegen's avatar
Finn Teegen committed
846
dsStmt (StmtExpr r   e1) e' =
847
848
849
850
851
852
853
854
855
856
857
858
859
860
  return $ apply (prelBind_ (typeOf e1) (typeOf e') r) [e1, e']
dsStmt (StmtBind r t e1) e' = do
  v <- freshVar "_#var" t
  let func = Lambda r [uncurry VariablePattern v] $
               Case noRef Rigid (uncurry mkVar v)
                 [ caseAlt NoPos t e'
                 , caseAlt NoPos (uncurry VariablePattern v)
                     (failedPatternMatch $ typeOf e')
                 ]
  return $ apply (prelBind (typeOf e1) (typeOf t) (typeOf e') r) [e1, func]
  where failedPatternMatch ty = --TODO: Fix wrong SrcRef
          apply (prelFail ty)
            [Literal predStringType $ String (srcRef 0) "Pattern match failed!"]
dsStmt (StmtDecl     ds) e' = return $ Let ds e'
861

862
-- -----------------------------------------------------------------------------
863
-- Desugaring of List Comprehensions
864
865
-- -----------------------------------------------------------------------------

866
867
868
869
870
871
872
873
874
875
876
877
878
879
-- In general, a list comprehension of the form
-- '[e | t <- l, qs]'
-- is transformed into an expression 'foldr f [] l' where 'f'
-- is a new function defined as
--
--     f x xs =
--       case x of
--           t -> [e | qs] ++ xs
--           _ -> xs
--
-- Note that this translation evaluates the elements of 'l' rigidly,
-- whereas the translation given in the Curry report is flexible.
-- However, it does not seem very useful to have the comprehension
-- generate instances of 't' which do not contribute to the list.
880
-- TODO: Unfortunately, this is incorrect.
881
882
883
884
885
886
887
888
889
890
891

-- Actually, we generate slightly better code in a few special cases.
-- When 't' is a plain variable, the 'case' expression degenerates
-- into a let-binding and the auxiliary function thus becomes an alias
-- for '(++)'. Instead of 'foldr (++)' we use the
-- equivalent prelude function 'concatMap'. In addition, if the
-- remaining list comprehension in the body of the auxiliary function has
-- no qualifiers -- i.e., if it is equivalent to '[e]' -- we
-- avoid the construction of the singleton list by calling '(:)'
-- instead of '(++)' and 'map' in place of 'concatMap', respectively.

Finn Teegen's avatar
Finn Teegen committed
892
893
894
895
dsListComp :: Position -> SrcRef -> Expression PredType -> [Statement PredType]
           -> DsM (Expression PredType)
dsListComp p r e []     =
  dsExpr p (List (predType $ listType $ typeOf e) [r,r] [e])
896
897
dsListComp p r e (q:qs) = dsQual p q (ListCompr r e qs)

Finn Teegen's avatar
Finn Teegen committed
898
899
900
901
dsQual :: Position -> Statement PredType -> Expression PredType
       -> DsM (Expression PredType)
dsQual p (StmtExpr   r b) e =
  dsExpr p (IfThenElse r b e (List (predType $ typeOf e) [r] []))
902
903
dsQual p (StmtDecl    ds) e = dsExpr p (Let ds e)
dsQual p (StmtBind r t l) e
Finn Teegen's avatar
Finn Teegen committed
904
905
906
907
908
909
910
  | isVariablePattern t = dsExpr p (qualExpr t e l)
  | otherwise = do
    v <- freshVar "_#var" t
    l' <- freshVar "_#var" e
    --TODO: Add SrcRefs (old version below)
    --v   <- addRefId r <$> freshVar "_#var" t
    --l'  <- addRefId r <$> freshVar "_#var" e
911
912
    dsExpr p (apply (prelFoldr (typeOf t) (typeOf e) r)
      [foldFunct v l' e, List (predType $ typeOf e) [r] [], l])
913
  where
Finn Teegen's avatar
Finn Teegen committed
914
915
916
917
  qualExpr v (ListCompr _ e1 []) l1
    = apply (prelMap (typeOf v) (typeOf e1) r) [Lambda r [v] e1, l1]
  qualExpr v e1                  l1
    = apply (prelConcatMap (typeOf v) (elemType $ typeOf e1) r) [Lambda r [v] e1, l1]
918
  foldFunct v l1 e1
Finn Teegen's avatar
Finn Teegen committed
919
920
921
922
    = Lambda r (map (uncurry VariablePattern) [v, l1])
       (Case r Rigid (uncurry mkVar v)
          [ caseAlt p t (append e1 (uncurry mkVar l1))
          , caseAlt p (uncurry VariablePattern v) (uncurry mkVar l1)])
923

Finn Teegen's avatar
Finn Teegen committed
924
925
926
  append (ListCompr _ e1 []) l1 = apply (prelCons (typeOf e1)) [e1, l1]
  append e1                  l1 = apply (prelAppend (elemType $ typeOf e1) r) [e1, l1]
  prelCons ty                   = Constructor (predType $ consType ty) $ addRef r $ qConsId
927

928
929
930
931
932
-- -----------------------------------------------------------------------------
-- Desugaring of Lists, labels, fields, and literals
-- -----------------------------------------------------------------------------

dsList :: [SrcRef] -> (SrcRef -> b -> b -> b) -> (SrcRef -> b) -> [b] -> b
Finn Teegen's avatar
Finn Teegen committed
933
934
935
936
937
938
--TODO: Fix SrcRefs here (old version below)
dsList pos cons nil xs = foldr cons' nil' xs
  where rNil : _   = reverse pos
        nil'       = nil rNil
        cons' t ts = cons rNil t ts
{-dsList pos cons nil xs = snd (foldr cons' nil' xs)
939
940
941
  where rNil : rCs = reverse pos
        nil'                 = (rCs , nil rNil)
        cons' t (rC:rCs',ts) = (rCs', cons rC t ts)
Finn Teegen's avatar
Finn Teegen committed
942
        cons' _ ([],_) = error "Desugar.dsList.cons': empty list"-}
943

Finn Teegen's avatar
Finn Teegen committed
944
945
--dsLabel :: a -> [(QualIdent, a)] -> QualIdent -> a
--dsLabel def fs l = fromMaybe def (lookup l fs)
946
947
948
949

dsField :: (a -> b -> DsM (a, b)) -> a -> Field b -> DsM (a, Field b)
dsField ds z (Field p l x) = second (Field p l) <$> (ds z x)

Finn Teegen's avatar
Finn Teegen committed
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
dsLiteral :: PredType -> Literal
          -> Either (Expression PredType) (Expression PredType)
dsLiteral pty (Char ref c) = Right $ Literal pty $ Char ref c
dsLiteral pty (Int ref i) = Right $ fixLiteral (unpredType pty)
  where fixLiteral (TypeConstrained tys _) = fixLiteral (head tys)
        fixLiteral ty
          | ty == intType = Literal pty $ Int ref i
          | ty == floatType = Literal pty $ Float ref $ fromInteger i
          | otherwise = Apply (prelFromInteger $ unpredType pty) $
                          Literal predIntType $ Int ref i
dsLiteral pty f@(Float _ _) = Right $ fixLiteral (unpredType pty)
  where fixLiteral (TypeConstrained tys _) = fixLiteral (head tys)
        fixLiteral ty
          | ty == floatType = Literal pty f
          | otherwise = Apply (prelFromRational $ unpredType pty) $
                          Literal predFloatType f
dsLiteral pty (String (SrcRef [i]) cs) =
  Left $ List pty (consRefs i cs) $
    map (Literal pty') $ zipWith (Char . SrcRef . (:[])) [i, i + 2 ..] cs
  where pty' = predType $ elemType $ unpredType pty
        -- TODO: Share with 'dsLiteralPat'
        consRefs r []     = [SrcRef [r]]
972
973
        consRefs r (_:xs) = let r' = r + 2
                            in  r' `seq` (SrcRef [r'] : consRefs r' xs)
Finn Teegen's avatar
Finn Teegen committed
974
975
dsLiteral _ (String _ _) = internalError $
  "Desugar.dsLiteral: wrong source ref for string"
976
977

negateLiteral :: Literal -> Literal
Finn Teegen's avatar
Finn Teegen committed
978
979
980
negateLiteral (Int ref i) = Int ref (-i)
negateLiteral (Float ref f) = Float ref (-f)
negateLiteral _ = internalError "Desugar.negateLiteral"
981

982
983
984
985
-- ---------------------------------------------------------------------------
-- Prelude entities
-- ---------------------------------------------------------------------------

Finn Teegen's avatar
Finn Teegen committed
986
987
988
prel :: [Type] -> Type -> String -> SrcRef -> Expression PredType
prel tys ty s r =
  Variable (predType $ foldr TypeArrow ty tys) $ addRef r $ preludeIdent s
989

Finn Teegen's avatar
Finn Teegen committed
990
991
preludeFun :: [Type] -> Type -> String -> Expression PredType
preludeFun tys ty = Variable (predType $ foldr TypeArrow ty tys) . preludeIdent
992
993
994
995

preludeIdent :: String -> QualIdent
preludeIdent = qualifyWith preludeMIdent . mkIdent

Finn Teegen's avatar
Finn Teegen committed
996
997
prelBind :: Type -> Type -> Type -> SrcRef -> Expression PredType
prelBind ma a mb = prel [ma, TypeArrow a mb] mb ">>="
998

Finn Teegen's avatar
Finn Teegen committed
999
1000
prelBind_ :: Type -> Type -> SrcRef -> Expression PredType
prelBind_ ma mb = prel [ma, mb] mb ">>"
1001

Finn Teegen's avatar
Finn Teegen committed
1002
1003
prelFlip :: Type -> Type -> Type -> Expression PredType
prelFlip a b c = preludeFun [TypeArrow a (TypeArrow b c), b, a] c "flip"
1004

Finn Teegen's avatar
Finn Teegen committed
1005
1006
prelFromInteger :: Type -> Expression PredType
prelFromInteger a = preludeFun [intType] a "fromInteger"
1007

Finn Teegen's avatar
Finn Teegen committed
1008
1009
prelFromRational :: Type -> Expression PredType
prelFromRational a = preludeFun [floatType] a "fromRational"
1010

Finn Teegen's avatar
Finn Teegen committed
1011
1012
prelEnumFrom :: Type -> Expression PredType
prelEnumFrom a = preludeFun [a] (listType a) "enumFrom"
1013

Finn Teegen's avatar
Finn Teegen committed
1014
1015
prelEnumFromTo :: Type -> Expression PredType
prelEnumFromTo a = preludeFun [a, a] (listType a) "enumFromTo"
1016

Finn Teegen's avatar
Finn Teegen committed
1017
1018
prelEnumFromThen :: Type -> Expression PredType
prelEnumFromThen a = preludeFun [a, a] (listType a) "enumFromThen"
1019

Finn Teegen's avatar
Finn Teegen committed
1020
1021
prelEnumFromThenTo :: Type -> Expression PredType
prelEnumFromThenTo a = preludeFun [a, a, a] (listType a) "enumFromThenTo"
1022

Finn Teegen's avatar
Finn Teegen committed
1023
1024
prelNegate :: Type -> Expression PredType
prelNegate a = preludeFun [a] a "negate"
1025

1026
1027
1028
prelFail :: Type -> Expression PredType
prelFail ma = preludeFun [stringType] ma "fail"

Finn Teegen's avatar
Finn Teegen committed
1029
1030
prelFailed :: Type -> Expression PredType
prelFailed a = preludeFun [] a "failed"
1031

Finn Teegen's avatar
Finn Teegen committed
1032
1033
prelUnknown :: Type -> Expression PredType
prelUnknown a = preludeFun [] a "unknown"
1034

Finn Teegen's avatar
Finn Teegen committed
1035
1036
prelMap :: Type -> Type -> SrcRef -> Expression PredType
prelMap a b = prel [TypeArrow a b, listType a] (listType b) "map"
1037

Finn Teegen's avatar
Finn Teegen committed
1038
1039
prelFoldr :: Type -> Type -> SrcRef -> Expression PredType
prelFoldr a b = prel [TypeArrow a (TypeArrow b b), b, listType a] b "foldr"
1040

Finn Teegen's avatar
Finn Teegen committed
1041
1042
prelAppend :: Type -> SrcRef -> Expression PredType
prelAppend a = prel [listType a, listType a] (listType a) "++"
1043

Finn Teegen's avatar
Finn Teegen committed
1044
1045
1046
prelConcatMap :: Type -> Type -> SrcRef -> Expression PredType
prelConcatMap a b =
  prel [TypeArrow a (listType b), listType a] (listType b) "concatMap"
1047

Finn Teegen's avatar
Finn Teegen committed
1048
1049
(=:<=) :: Expression PredType -> Expression PredType -> Expression PredType
e1 =:<= e2 = apply (preludeFun [typeOf e1, typeOf e2] boolType "=:<=") [e1, e2]