git.iko.soy/Idris-dev
on aa8aefd help sign in
Idris-dev/src/Core/CaseTree.hs
469 lines 18 kB history raw
1{-# LANGUAGE PatternGuards, DeriveFunctor, TypeSynonymInstances #-}
3module Core.CaseTree(CaseDef(..), SC, SC'(..), CaseAlt, CaseAlt'(..),
4 Phase(..), CaseTree,
5 simpleCase, small, namesUsed, findCalls, findUsedArgs) where
7import Core.TT
9import Control.Monad.State
10import Data.Maybe
11import Data.List hiding (partition)
12import Debug.Trace
14data CaseDef = CaseDef [Name] SC [Term]
15 deriving Show
17data SC' t = Case Name [CaseAlt' t] -- invariant: lowest tags first
18 | ProjCase t [CaseAlt' t] -- special case for projections
19 | STerm t
20 | UnmatchedCase String -- error message
21 | ImpossibleCase -- already checked to be impossible
22 deriving (Eq, Ord, Functor)
23{-!
24deriving instance Binary SC
25!-}
27type SC = SC' Term
29data CaseAlt' t = ConCase Name Int [Name] (SC' t)
30 | ConstCase Const (SC' t)
31 | DefaultCase (SC' t)
32 deriving (Show, Eq, Ord, Functor)
33{-!
34deriving instance Binary CaseAlt
35!-}
37type CaseAlt = CaseAlt' Term
39instance Show t => Show (SC' t) where
40 show sc = show' 1 sc
41 where
42 show' i (Case n alts) = "case " ++ show n ++ " of\n" ++ indent i ++
43 showSep ("\n" ++ indent i) (map (showA i) alts)
44 show' i (ProjCase tm alts) = "case " ++ show tm ++ " of " ++
45 showSep ("\n" ++ indent i) (map (showA i) alts)
46 show' i (STerm tm) = show tm
47 show' i (UnmatchedCase str) = "error " ++ show str
48 show' i ImpossibleCase = "impossible"
50 indent i = concat $ take i (repeat " ")
52 showA i (ConCase n t args sc)
53 = show n ++ "(" ++ showSep (", ") (map show args) ++ ") => "
54 ++ show' (i+1) sc
55 showA i (ConstCase t sc)
56 = show t ++ " => " ++ show' (i+1) sc
57 showA i (DefaultCase sc)
58 = "_ => " ++ show' (i+1) sc
61type CaseTree = SC
62type Clause = ([Pat], (Term, Term))
63type CS = ([Term], Int)
65instance TermSize SC where
66 termsize n (Case n' as) = termsize n as
67 termsize n (STerm t) = termsize n t
68 termsize n _ = 1
70instance TermSize CaseAlt where
71 termsize n (ConCase _ _ _ s) = termsize n s
72 termsize n (ConstCase _ s) = termsize n s
73 termsize n (DefaultCase s) = termsize n s
75-- simple terms can be inlined trivially - good for primitives in particular
76-- To avoid duplicating work, don't inline something which uses one
77-- of its arguments in more than one place
79small :: Name -> [Name] -> SC -> Bool
80small n args t = let as = findAllUsedArgs t args in
81 length as == length (nub as) &&
82 termsize n t < 20
84namesUsed :: SC -> [Name]
85namesUsed sc = nub $ nu' [] sc where
86 nu' ps (Case n alts) = nub (concatMap (nua ps) alts) \\ [n]
87 nu' ps (ProjCase t alts) = nub $ (nut ps t ++
88 (concatMap (nua ps) alts))
89 nu' ps (STerm t) = nub $ nut ps t
90 nu' ps _ = []
92 nua ps (ConCase n i args sc) = nub (nu' (ps ++ args) sc) \\ args
93 nua ps (ConstCase _ sc) = nu' ps sc
94 nua ps (DefaultCase sc) = nu' ps sc
96 nut ps (P _ n _) | n `elem` ps = []
97 | otherwise = [n]
98 nut ps (App f a) = nut ps f ++ nut ps a
99 nut ps (Proj t _) = nut ps t
100 nut ps (Bind n (Let t v) sc) = nut ps v ++ nut (n:ps) sc
101 nut ps (Bind n b sc) = nut (n:ps) sc
102 nut ps _ = []
104-- Return all called functions, and which arguments are used in each argument position
105-- for the call, in order to help reduce compilation time, and trace all unused
106-- arguments
108findCalls :: SC -> [Name] -> [(Name, [[Name]])]
109findCalls sc topargs = nub $ nu' topargs sc where
110 nu' ps (Case n alts) = nub (concatMap (nua (n : ps)) alts)
111 nu' ps (ProjCase t alts) = nub (nut ps t ++ concatMap (nua ps) alts)
112 nu' ps (STerm t) = nub $ nut ps t
113 nu' ps _ = []
115 nua ps (ConCase n i args sc) = nub (nu' (ps ++ args) sc)
116 nua ps (ConstCase _ sc) = nu' ps sc
117 nua ps (DefaultCase sc) = nu' ps sc
119 nut ps (P Ref n _) | n `elem` ps = []
120 | otherwise = [(n, [])] -- tmp
121 nut ps fn@(App f a)
122 | (P Ref n _, args) <- unApply fn
123 = if n `elem` ps then nut ps f ++ nut ps a
124 else [(n, map argNames args)] ++ concatMap (nut ps) args
125 | otherwise = nut ps f ++ nut ps a
126 nut ps (Bind n (Let t v) sc) = nut ps v ++ nut (n:ps) sc
127 nut ps (Proj t _) = nut ps t
128 nut ps (Bind n b sc) = nut (n:ps) sc
129 nut ps _ = []
131 argNames tm = let ns = directUse tm in
132 filter (\x -> x `elem` ns) topargs
134-- Find names which are used directly (i.e. not in a function call) in a term
136directUse :: Eq n => TT n -> [n]
137directUse (P _ n _) = [n]
138directUse (Bind n (Let t v) sc) = nub $ directUse v ++ (directUse sc \\ [n])
139 ++ directUse t
140directUse (Bind n b sc) = nub $ directUse (binderTy b) ++ (directUse sc \\ [n])
141directUse fn@(App f a)
142 | (P Ref n _, args) <- unApply fn = [] -- need to know what n does with them
143 | otherwise = nub $ directUse f ++ directUse a
144directUse (Proj x i) = nub $ directUse x
145directUse _ = []
147-- Find all directly used arguments (i.e. used but not in function calls)
149findUsedArgs :: SC -> [Name] -> [Name]
150findUsedArgs sc topargs = nub (findAllUsedArgs sc topargs)
152findAllUsedArgs sc topargs = filter (\x -> x `elem` topargs) (nu' sc) where
153 nu' (Case n alts) = n : concatMap nua alts
154 nu' (ProjCase t alts) = directUse t ++ concatMap nua alts
155 nu' (STerm t) = directUse t
156 nu' _ = []
158 nua (ConCase n i args sc) = nu' sc
159 nua (ConstCase _ sc) = nu' sc
160 nua (DefaultCase sc) = nu' sc
162data Phase = CompileTime | RunTime
163 deriving (Show, Eq)
165-- Generate a simple case tree
166-- Work Right to Left
168simpleCase :: Bool -> Bool -> Phase -> FC -> [([Name], Term, Term)] ->
169 TC CaseDef
170simpleCase tc cover phase fc []
171 = return $ CaseDef [] (UnmatchedCase "No pattern clauses") []
172simpleCase tc cover phase fc cs
173 = let proj = phase == RunTime
174 pats = map (\ (avs, l, r) ->
175 (avs, toPats tc l, (l, r))) cs
176 chkPats = mapM chkAccessible pats in
177 case chkPats of
178 OK pats ->
179 let numargs = length (fst (head pats))
180 ns = take numargs args
181 (ns', ps') = order ns pats
182 (tree, st) = runState
183 (match ns' ps' (defaultCase cover)) ([], numargs)
184 t = CaseDef ns (prune proj (depatt ns' tree)) (fst st) in
185 if proj then return (stripLambdas t) else return t
186 Error err -> Error (At fc err)
187 where args = map (\i -> MN i "e") [0..]
188 defaultCase True = STerm Erased
189 defaultCase False = UnmatchedCase "Error"
191 chkAccessible (avs, l, c)
192 | phase == RunTime = return (l, c)
193 | otherwise = do mapM_ (acc l) avs
194 return (l, c)
196 acc [] n = Error (Inaccessible n)
197 acc (PV x : xs) n | x == n = OK ()
198 acc (PCon _ _ ps : xs) n = acc (ps ++ xs) n
199 acc (_ : xs) n = acc xs n
201data Pat = PCon Name Int [Pat]
202 | PConst Const
203 | PV Name
204 | PAny
205 deriving Show
207-- If there are repeated variables, take the *last* one (could be name shadowing
208-- in a where clause, so take the most recent).
210toPats :: Bool -> Term -> [Pat]
211toPats tc f = reverse (toPat tc (getArgs f)) where
212 getArgs (App f a) = a : getArgs f
213 getArgs _ = []
215toPat :: Bool -> [Term] -> [Pat]
216toPat tc tms = evalState (mapM (\x -> toPat' x []) tms) []
217 where
218 toPat' (P (DCon t a) n _) args = do args' <- mapM (\x -> toPat' x []) args
219 return $ PCon n t args'
220 -- Typecase
221 toPat' (P (TCon t a) n _) args | tc
222 = do args' <- mapM (\x -> toPat' x []) args
223 return $ PCon n t args'
224 toPat' (Constant IType) [] | tc = return $ PCon (UN "Int") 1 []
225 toPat' (Constant FlType) [] | tc = return $ PCon (UN "Float") 2 []
226 toPat' (Constant ChType) [] | tc = return $ PCon (UN "Char") 3 []
227 toPat' (Constant StrType) [] | tc = return $ PCon (UN "String") 4 []
228 toPat' (Constant PtrType) [] | tc = return $ PCon (UN "Ptr") 5 []
229 toPat' (Constant BIType) [] | tc = return $ PCon (UN "Integer") 6 []
230 toPat' (Constant B8Type) [] | tc = return $ PCon (UN "Bits8") 7 []
231 toPat' (Constant B16Type) [] | tc = return $ PCon (UN "Bits16") 8 []
232 toPat' (Constant B32Type) [] | tc = return $ PCon (UN "Bits32") 9 []
233 toPat' (Constant B64Type) [] | tc = return $ PCon (UN "Bits64") 10 []
235 toPat' (P Bound n _) [] = do ns <- get
236 if n `elem` ns
237 then return PAny
238 else do put (n : ns)
239 return (PV n)
240 toPat' (App f a) args = toPat' f (a : args)
241 toPat' (Constant x) [] = return $ PConst x
242 toPat' _ _ = return PAny
245data Partition = Cons [Clause]
246 | Vars [Clause]
247 deriving Show
249isVarPat (PV _ : ps , _) = True
250isVarPat (PAny : ps , _) = True
251isVarPat _ = False
253isConPat (PCon _ _ _ : ps, _) = True
254isConPat (PConst _ : ps, _) = True
255isConPat _ = False
257partition :: [Clause] -> [Partition]
258partition [] = []
259partition ms@(m : _)
260 | isVarPat m = let (vars, rest) = span isVarPat ms in
261 Vars vars : partition rest
262 | isConPat m = let (cons, rest) = span isConPat ms in
263 Cons cons : partition rest
264partition xs = error $ "Partition " ++ show xs
266-- reorder the patterns so that the one with most distinct names
267-- comes next. Take rightmost first, otherwise (i.e. pick value rather
268-- than dependency)
270order :: [Name] -> [Clause] -> ([Name], [Clause])
271order [] cs = ([], cs)
272order ns [] = (ns, [])
273order ns cs = let patnames = transpose (map (zip ns) (map fst cs))
274 pats' = transpose (sortBy moreDistinct (reverse patnames)) in
275 (getNOrder pats', zipWith rebuild pats' cs)
276 where
277 getNOrder [] = error $ "Failed order on " ++ show (ns, cs)
278 getNOrder (c : _) = map fst c
280 rebuild patnames clause = (map snd patnames, snd clause)
282 moreDistinct xs ys = compare (numNames [] (map snd ys))
283 (numNames [] (map snd xs))
285 numNames xs (PCon n _ _ : ps)
286 | not (Left n `elem` xs) = numNames (Left n : xs) ps
287 numNames xs (PConst c : ps)
288 | not (Right c `elem` xs) = numNames (Right c : xs) ps
289 numNames xs (_ : ps) = numNames xs ps
290 numNames xs [] = length xs
292match :: [Name] -> [Clause] -> SC -- error case
293 -> State CS SC
294match [] (([], ret) : xs) err
295 = do (ts, v) <- get
296 put (ts ++ (map (fst.snd) xs), v)
297 case snd ret of
298 Impossible -> return ImpossibleCase
299 tm -> return $ STerm tm -- run out of arguments
300match vs cs err = do let ps = partition cs
301 mixture vs ps err
303mixture :: [Name] -> [Partition] -> SC -> State CS SC
304mixture vs [] err = return err
305mixture vs (Cons ms : ps) err = do fallthrough <- mixture vs ps err
306 conRule vs ms fallthrough
307mixture vs (Vars ms : ps) err = do fallthrough <- mixture vs ps err
308 varRule vs ms fallthrough
310data ConType = CName Name Int -- named constructor
311 | CConst Const -- constant, not implemented yet
313data Group = ConGroup ConType -- Constructor
314 [([Pat], Clause)] -- arguments and rest of alternative
316conRule :: [Name] -> [Clause] -> SC -> State CS SC
317conRule (v:vs) cs err = do groups <- groupCons cs
318 caseGroups (v:vs) groups err
320caseGroups :: [Name] -> [Group] -> SC -> State CS SC
321caseGroups (v:vs) gs err = do g <- altGroups gs
322 return $ Case v (sort g)
323 where
324 altGroups [] = return [DefaultCase err]
325 altGroups (ConGroup (CName n i) args : cs)
326 = do g <- altGroup n i args
327 rest <- altGroups cs
328 return (g : rest)
329 altGroups (ConGroup (CConst c) args : cs)
330 = do g <- altConstGroup c args
331 rest <- altGroups cs
332 return (g : rest)
334 altGroup n i gs = do (newArgs, nextCs) <- argsToAlt gs
335 matchCs <- match (newArgs ++ vs) nextCs err
336 return $ ConCase n i newArgs matchCs
337 altConstGroup n gs = do (_, nextCs) <- argsToAlt gs
338 matchCs <- match vs nextCs err
339 return $ ConstCase n matchCs
341argsToAlt :: [([Pat], Clause)] -> State CS ([Name], [Clause])
342argsToAlt [] = return ([], [])
343argsToAlt rs@((r, m) : rest)
344 = do newArgs <- getNewVars r
345 return (newArgs, addRs rs)
346 where
347 getNewVars [] = return []
348 getNewVars ((PV n) : ns) = do v <- getVar
349 nsv <- getNewVars ns
350 return (v : nsv)
351 getNewVars (_ : ns) = do v <- getVar
352 nsv <- getNewVars ns
353 return (v : nsv)
354 addRs [] = []
355 addRs ((r, (ps, res)) : rs) = ((r++ps, res) : addRs rs)
357 uniq i (UN n) = MN i n
358 uniq i n = n
360getVar :: State CS Name
361getVar = do (t, v) <- get; put (t, v+1); return (MN v "e")
363groupCons :: [Clause] -> State CS [Group]
364groupCons cs = gc [] cs
365 where
366 gc acc [] = return acc
367 gc acc ((p : ps, res) : cs) =
368 do acc' <- addGroup p ps res acc
369 gc acc' cs
370 addGroup p ps res acc = case p of
371 PCon con i args -> return $ addg con i args (ps, res) acc
372 PConst cval -> return $ addConG cval (ps, res) acc
373 pat -> fail $ show pat ++ " is not a constructor or constant (can't happen)"
375 addg con i conargs res [] = [ConGroup (CName con i) [(conargs, res)]]
376 addg con i conargs res (g@(ConGroup (CName n j) cs):gs)
377 | i == j = ConGroup (CName n i) (cs ++ [(conargs, res)]) : gs
378 | otherwise = g : addg con i conargs res gs
380 addConG con res [] = [ConGroup (CConst con) [([], res)]]
381 addConG con res (g@(ConGroup (CConst n) cs) : gs)
382 | con == n = ConGroup (CConst n) (cs ++ [([], res)]) : gs
383 | otherwise = g : addConG con res gs
385varRule :: [Name] -> [Clause] -> SC -> State CS SC
386varRule (v : vs) alts err =
387 do let alts' = map (repVar v) alts
388 match vs alts' err
389 where
390 repVar v (PV p : ps , (lhs, res)) = (ps, (lhs, subst p (P Bound v Erased) res))
391 repVar v (PAny : ps , res) = (ps, res)
393-- fix: case e of S k -> f (S k) ==> case e of S k -> f e
394depatt :: [Name] -> SC -> SC
395depatt ns tm = dp [] tm
396 where
397 dp ms (STerm tm) = STerm (applyMaps ms tm)
398 dp ms (Case x alts) = Case x (map (dpa ms x) alts)
399 dp ms sc = sc
401 dpa ms x (ConCase n i args sc)
402 = ConCase n i args (dp ((x, (n, args)) : ms) sc)
403 dpa ms x (ConstCase c sc) = ConstCase c (dp ms sc)
404 dpa ms x (DefaultCase sc) = DefaultCase (dp ms sc)
406 applyMaps ms f@(App _ _)
407 | (P nt cn pty, args) <- unApply f
408 = let args' = map (applyMaps ms) args in
409 applyMap ms nt cn pty args'
410 where
411 applyMap [] nt cn pty args' = mkApp (P nt cn pty) args'
412 applyMap ((x, (n, args)) : ms) nt cn pty args'
413 | and ((length args == length args') :
414 (n == cn) : zipWith same args args') = P Ref x Erased
415 | otherwise = applyMap ms nt cn pty args'
416 same n (P _ n' _) = n == n'
417 same _ _ = False
418 applyMaps ms (App f a) = App (applyMaps ms f) (applyMaps ms a)
419 applyMaps ms t = t
421prune :: Bool -> -- ^ Convert single branches to projections (only useful at runtime)
422 SC -> SC
423prune proj (Case n alts)
424 = let alts' = filter notErased (map pruneAlt alts) in
425 case alts' of
426 [] -> ImpossibleCase
427 as@[ConCase cn i args sc] -> if proj then mkProj n 0 args sc
428 else Case n as
429 as -> Case n as
430 where pruneAlt (ConCase cn i ns sc) = ConCase cn i ns (prune proj sc)
431 pruneAlt (ConstCase c sc) = ConstCase c (prune proj sc)
432 pruneAlt (DefaultCase sc) = DefaultCase (prune proj sc)
434 notErased (DefaultCase (STerm Erased)) = False
435 notErased (DefaultCase ImpossibleCase) = False
436 notErased _ = True
438 mkProj n i [] sc = sc
439 mkProj n i (x : xs) sc = mkProj n (i + 1) xs (projRep x n i sc)
441 projRep :: Name -> Name -> Int -> SC -> SC
442 projRep arg n i (Case x alts)
443 | x == arg = ProjCase (Proj (P Bound n Erased) i)
444 (map (projRepAlt arg n i) alts)
445 | otherwise = Case x (map (projRepAlt arg n i) alts)
446 projRep arg n i (ProjCase t alts)
447 = ProjCase (projRepTm arg n i t) (map (projRepAlt arg n i) alts)
448 projRep arg n i (STerm t) = STerm (projRepTm arg n i t)
449 projRep arg n i c = c -- unmatched
451 projRepAlt arg n i (ConCase cn t args rhs)
452 = ConCase cn t args (projRep arg n i rhs)
453 projRepAlt arg n i (ConstCase t rhs)
454 = ConstCase t (projRep arg n i rhs)
455 projRepAlt arg n i (DefaultCase rhs)
456 = DefaultCase (projRep arg n i rhs)
458 projRepTm arg n i t = subst arg (Proj (P Bound n Erased) i) t
460prune _ t = t
462stripLambdas :: CaseDef -> CaseDef
463stripLambdas (CaseDef ns (STerm (Bind x (Lam _) sc)) tm)
464 = stripLambdas (CaseDef (ns ++ [x]) (STerm (instantiate (P Bound x Erased) sc)) tm)
465stripLambdas x = x