-- | Label-set analysis which annotates all the statements in the script
-- with their label sets according to ECMAScript specification,
-- section 12.12. The result of this analysis are useful for building
-- control-flow graphs.

module Language.ECMAScript3.Analysis.LabelSets
       {-# DEPRECATED "Use 'Language.ECMAScript3.Analysis.LabelSet'\
                      \ from package 'language-ecmascript-analysis'" #-}
       (annotateLabelSets 
       ,Label(..)) where

import Language.ECMAScript3.Syntax
import Language.ECMAScript3.Syntax.Annotations
import Data.Set (Set)
import qualified Data.Set as Set
import Data.Generics.Uniplate.Data
import Data.Data (Data)
import Control.Applicative
import Data.Typeable (Typeable)

-- | Labels are either strings (identifiers) or /empty/ (see 12.12 of
-- the spec)
data Label = Label String
           | EmptyLabel
             deriving (Eq Label
Eq Label
-> (Label -> Label -> Ordering)
-> (Label -> Label -> Bool)
-> (Label -> Label -> Bool)
-> (Label -> Label -> Bool)
-> (Label -> Label -> Bool)
-> (Label -> Label -> Label)
-> (Label -> Label -> Label)
-> Ord Label
Label -> Label -> Bool
Label -> Label -> Ordering
Label -> Label -> Label
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: Label -> Label -> Ordering
compare :: Label -> Label -> Ordering
$c< :: Label -> Label -> Bool
< :: Label -> Label -> Bool
$c<= :: Label -> Label -> Bool
<= :: Label -> Label -> Bool
$c> :: Label -> Label -> Bool
> :: Label -> Label -> Bool
$c>= :: Label -> Label -> Bool
>= :: Label -> Label -> Bool
$cmax :: Label -> Label -> Label
max :: Label -> Label -> Label
$cmin :: Label -> Label -> Label
min :: Label -> Label -> Label
Ord, Label -> Label -> Bool
(Label -> Label -> Bool) -> (Label -> Label -> Bool) -> Eq Label
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Label -> Label -> Bool
== :: Label -> Label -> Bool
$c/= :: Label -> Label -> Bool
/= :: Label -> Label -> Bool
Eq, Int -> Label -> ShowS
[Label] -> ShowS
Label -> String
(Int -> Label -> ShowS)
-> (Label -> String) -> ([Label] -> ShowS) -> Show Label
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Label -> ShowS
showsPrec :: Int -> Label -> ShowS
$cshow :: Label -> String
show :: Label -> String
$cshowList :: [Label] -> ShowS
showList :: [Label] -> ShowS
Show, Typeable Label
Typeable Label
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> Label -> c Label)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c Label)
-> (Label -> Constr)
-> (Label -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c Label))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Label))
-> ((forall b. Data b => b -> b) -> Label -> Label)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r)
-> (forall u. (forall d. Data d => d -> u) -> Label -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> Label -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> Label -> m Label)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> Label -> m Label)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> Label -> m Label)
-> Data Label
Label -> Constr
Label -> DataType
(forall b. Data b => b -> b) -> Label -> Label
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> Label -> u
forall u. (forall d. Data d => d -> u) -> Label -> [u]
forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r
forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Label -> m Label
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Label -> m Label
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Label
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Label -> c Label
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Label)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Label)
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Label -> c Label
gfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Label -> c Label
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Label
gunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Label
$ctoConstr :: Label -> Constr
toConstr :: Label -> Constr
$cdataTypeOf :: Label -> DataType
dataTypeOf :: Label -> DataType
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Label)
dataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Label)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Label)
dataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Label)
$cgmapT :: (forall b. Data b => b -> b) -> Label -> Label
gmapT :: (forall b. Data b => b -> b) -> Label -> Label
$cgmapQl :: forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r
gmapQl :: forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r
$cgmapQr :: forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r
gmapQr :: forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Label -> r
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> Label -> [u]
gmapQ :: forall u. (forall d. Data d => d -> u) -> Label -> [u]
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> Label -> u
gmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> Label -> u
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Label -> m Label
gmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Label -> m Label
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Label -> m Label
gmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Label -> m Label
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Label -> m Label
gmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Label -> m Label
Data, Typeable)

-- | Annotates statements with their label sets; example use:
--
-- >>> let jsa = reannotate (\a -> (a, Set.empty))
-- >>> in  annotateLabelSets jsa snd (\labs (a, ls) -> (a, labs `Set.union` ls))
annotateLabelSets :: Data a =>
                     (a -> Set Label) -- ^ annotation read function
                  -> (Set Label -> a -> a) -- ^ annotation write function
                  -> JavaScript a  -- ^ the script to annotate
                  -> JavaScript a
annotateLabelSets :: forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> JavaScript a -> JavaScript a
annotateLabelSets a -> Set Label
r Set Label -> a -> a
w = (Statement a -> Statement a) -> JavaScript a -> JavaScript a
forall from to. Biplate from to => (to -> to) -> from -> from
transformBi ((a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateFuncStmtBodies a -> Set Label
r Set Label -> a -> a
w)
                      (JavaScript a -> JavaScript a)
-> (JavaScript a -> JavaScript a) -> JavaScript a -> JavaScript a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Expression a -> Expression a) -> JavaScript a -> JavaScript a
forall from to. Biplate from to => (to -> to) -> from -> from
transformBi ((a -> Set Label)
-> (Set Label -> a -> a) -> Expression a -> Expression a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Expression a -> Expression a
annotateFuncExprBodies a -> Set Label
r Set Label -> a -> a
w)
                      (JavaScript a -> JavaScript a)
-> (JavaScript a -> JavaScript a) -> JavaScript a -> JavaScript a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Statement a -> Statement a) -> JavaScript a -> JavaScript a
forall from to. Biplate from to => (to -> to) -> from -> from
descendBi   ((a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w)

annotateFuncStmtBodies :: Data a => 
                          (a -> Set Label)
                       -> (Set Label -> a -> a) 
                       -> Statement a
                       -> Statement a
annotateFuncStmtBodies :: forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateFuncStmtBodies a -> Set Label
r Set Label -> a -> a
w Statement a
s = case Statement a
s of
  FunctionStmt a
a Id a
name [Id a]
params [Statement a]
body -> 
    let newbody :: [Statement a]
newbody = (Statement a -> Statement a) -> [Statement a] -> [Statement a]
forall a b. (a -> b) -> [a] -> [b]
map ((Statement a -> Statement a) -> Statement a -> Statement a
forall on. Uniplate on => (on -> on) -> on -> on
descend ((a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w)) [Statement a]
body
    in  a -> Id a -> [Id a] -> [Statement a] -> Statement a
forall a. a -> Id a -> [Id a] -> [Statement a] -> Statement a
FunctionStmt a
a Id a
name [Id a]
params [Statement a]
newbody
  Statement a
_ -> Statement a
s
                       
annotateFuncExprBodies :: Data a => 
                          (a -> Set Label)
                       -> (Set Label -> a -> a) 
                       -> Expression a 
                       -> Expression a
annotateFuncExprBodies :: forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Expression a -> Expression a
annotateFuncExprBodies a -> Set Label
r Set Label -> a -> a
w Expression a
e = case Expression a
e of
  FuncExpr a
a Maybe (Id a)
mname [Id a]
params [Statement a]
body -> 
    let newbody :: [Statement a]
newbody = (Statement a -> Statement a) -> [Statement a] -> [Statement a]
forall a b. (a -> b) -> [a] -> [b]
map ((Statement a -> Statement a) -> Statement a -> Statement a
forall on. Uniplate on => (on -> on) -> on -> on
descend ((a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w)) [Statement a]
body
    in  a -> Maybe (Id a) -> [Id a] -> [Statement a] -> Expression a
forall a.
a -> Maybe (Id a) -> [Id a] -> [Statement a] -> Expression a
FuncExpr a
a Maybe (Id a)
mname [Id a]
params [Statement a]
newbody
  Expression a
_ -> Expression a
e

-- | 12.12 ECMA262: the production /Identifier/ : /Statement/ is
-- evaluated by adding /Identifier/ to the label ser of /Statement/
-- and then evluating /Statement/. If the /LabelledStatement/ itsef
-- has a non-empty label set, these labels are also added to the label
-- set of /Statement/ before evaluating it. ... Prior to evaluation of
-- a /LabelledStatement/, the contained /Statement/ is regarded as
-- possessing an empty label set, unless it is an /IterationStatement/
-- or a /SwitchStatement/, in which case it is regarded as possessing
-- a label set consisting of the single element, @empty@.
annotateStatement :: Data a => 
                     (a -> Set Label)
                  -> (Set Label -> a -> a)
                  -> Statement a   
                  -> Statement a
annotateStatement :: forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w Statement a
s = case Statement a
s of
  LabelledStmt a
ann Id a
lab Statement a
stmt -> 
    let labelset :: Set Label
labelset = Label -> Set Label -> Set Label
forall a. Ord a => a -> Set a -> Set a
Set.insert (Id a -> Label
forall a. Id a -> Label
id2Label Id a
lab) (a -> Set Label
r a
ann) 
        newstmt :: Statement a
newstmt  = (a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w (Statement a -> Statement a) -> Statement a -> Statement a
forall a b. (a -> b) -> a -> b
$ Set Label -> a -> a
w Set Label
labelset (a -> a) -> Statement a -> Statement a
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Statement a
stmt
    in  a -> Id a -> Statement a -> Statement a
forall a. a -> Id a -> Statement a -> Statement a
LabelledStmt a
ann Id a
lab Statement a
newstmt
  SwitchStmt {} -> 
    let labelset :: Set Label
labelset = Label -> Set Label -> Set Label
forall a. Ord a => a -> Set a -> Set a
Set.insert Label
EmptyLabel (a -> Set Label
r (a -> Set Label) -> a -> Set Label
forall a b. (a -> b) -> a -> b
$ Statement a -> a
forall b. Statement b -> b
forall (a :: * -> *) b. HasAnnotation a => a b -> b
getAnnotation Statement a
s)
    in  (Statement a -> Statement a) -> Statement a -> Statement a
forall on. Uniplate on => (on -> on) -> on -> on
descend ((a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w) (Set Label -> a -> a
w Set Label
labelset (a -> a) -> Statement a -> Statement a
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Statement a
s)
  Statement a
_ | Statement a -> Bool
forall a. Statement a -> Bool
isIterationStmt Statement a
s ->
    let labelset :: Set Label
labelset = Label -> Set Label -> Set Label
forall a. Ord a => a -> Set a -> Set a
Set.insert Label
EmptyLabel (a -> Set Label
r (a -> Set Label) -> a -> Set Label
forall a b. (a -> b) -> a -> b
$ Statement a -> a
forall b. Statement b -> b
forall (a :: * -> *) b. HasAnnotation a => a b -> b
getAnnotation Statement a
s)
    in  (Statement a -> Statement a) -> Statement a -> Statement a
forall on. Uniplate on => (on -> on) -> on -> on
descend ((a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w) (Set Label -> a -> a
w Set Label
labelset (a -> a) -> Statement a -> Statement a
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Statement a
s)
  Statement a
_                     -> (Statement a -> Statement a) -> Statement a -> Statement a
forall on. Uniplate on => (on -> on) -> on -> on
descend ((a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
forall a.
Data a =>
(a -> Set Label)
-> (Set Label -> a -> a) -> Statement a -> Statement a
annotateStatement a -> Set Label
r Set Label -> a -> a
w) Statement a
s

id2Label :: Id a -> Label
id2Label :: forall a. Id a -> Label
id2Label = String -> Label
Label (String -> Label) -> (Id a -> String) -> Id a -> Label
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Id a -> String
forall a. Id a -> String
unId