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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

--------------------------------------------------------------------------
--- A tool to analyze the residuation behavior of a module.
--- It can just show the results, making some statistics, or writes
--- the results into a file which can be used by PAKCS to optimize
--- the implementation of non-residuating operations.
---
--- @author Michael Hanus
--- @version December 2020
--------------------------------------------------------------------------

import Control.Monad        ( when, unless )
import Data.List            ( intercalate, partition )
import System.Environment   ( getArgs )

import Analysis.ProgInfo    ( progInfo2Lists )
import Analysis.Residuation
import CASS.Server          ( analyzeGeneric )
import FlatCurry.Types      ( QName, showQName )
import System.CurryPath     ( addCurrySubdir, lookupModuleSourceInLoadPath
                            , modNameToPath )
import System.Directory     ( createDirectoryIfMissing )
import System.FilePath      ( (</>), takeDirectory )
import Text.CSV             ( showCSV )

import ToolOptions

------------------------------------------------------------------------

banner :: String
 = unlines [bannerLine,bannerText,bannerLine]
 where
   bannerText = "Residuation Analysis Tool for Curry (Version of 18/12/20)"
   bannerLine = take (length bannerText) (repeat '=')

---------------------------------------------------------------------------

main :: IO ()
main = do
  args <- getArgs
  (opts,mods) <- processOptions banner args
  if null mods
    then putStrLn "ERROR: wrong arguments (try `--help' option)"
    else if optShowStats opts
           then countResOps2CSV mods
           else mapM_ (genResInfo opts) mods

--- Returns the residuation information of all operations defined
--- in a module.
residuationInfoOf :: String -> IO [(QName,ResiduationInfo)]
residuationInfoOf modname = do
  analyzeGeneric residuationAnalysis modname
    >>= return . either (\pi -> let (i1,i2) = progInfo2Lists pi in i1 ++ i2)
                        error

genResInfo :: Options -> String -> IO ()
genResInfo opts mname =
  lookupModuleSourceInLoadPath mname >>=
  maybe (error $ "Source of module '" ++ mname ++ "' not found!")
    (\_ -> do
      printWhenStatus opts $ "Analyzing module " ++ mname ++ "..."
      resinfos <- residuationInfoOf mname
      when (optShow opts) $ putStrLn $
        "Analysis results (non-residuating if arguments...):\n" ++
        unlines (map showFunRI resinfos)
      when (optShowResOpts opts) $ putStrLn $
        "Possibly residuating operations: " ++ unwords (allResOps resinfos)
      unless (null (optOutput opts)) (writeResInfoFile opts resinfos)
    )
 where
  showFunRI (qn,ri) = snd qn ++ " " ++ showRI ri

  showRI MayResiduate       = "residuate"
  showRI NoResInfo          = "residuate"
  showRI (NoResiduateIf xs) = intercalate "," (map show xs)

--- Writes a file containing residuation information in Curry term format.
--- The term is a list of pairs consisting of the qualified function name
--- together with the list of argument positions which must be ground values
--- to ensure that the function call does not residuate and yields a
--- ground value. If the function might always residuate, the argument
--- position list is [0].
writeResInfoFile :: Options -> [(QName,ResiduationInfo)] -> IO ()
writeResInfoFile opts resinfo = do
  let rifile = optOutput opts
  createDirectoryIfMissing True (takeDirectory rifile)
  writeFile rifile (show (map fri2term resinfo) ++ "\n")
  printWhenStatus opts $ "Residuation info written into '" ++ rifile ++ "'"
 where
  fri2term (qn,ri) = (showQName qn,  ri2term ri)
   where
    ri2term MayResiduate       = [0]
    ri2term NoResInfo          = [0]
    ri2term (NoResiduateIf xs) = xs

--- Returns the list of possibly residuating operations.
allResOps :: [(QName,ResiduationInfo)] -> [String]
allResOps resinfo =
  map (snd . fst)
      (filter (\ (_,i) -> i==MayResiduate || i==NoResInfo) resinfo)

--- Counts all possibly residuating and non-residuating operations.
countResOps :: String -> IO [String]
countResOps mname = do
  resinfo <- residuationInfoOf mname
  let (nonresops,resops,unknowns) = foldr select ([],[],[]) resinfo
  return $ mname : map (show . length) [nonresops,resops,unknowns]
 where
  select (f,i) (nrs,res,unk) = case i of
    NoResiduateIf _ -> (f:nrs,res,unk)
    MayResiduate    -> (nrs,f:res,unk)
    NoResInfo       -> (nrs,res,f:unk)

countResOps2CSV :: [String] -> IO ()
countResOps2CSV mods = do
  stats <- mapM countResOps mods
  let table = ["Module", "Non-residuating", "Residuating", "Unknown"] : stats
  putStr (showCSV table)