Main.curry 55.5 KB
Newer Older
Michael Hanus's avatar
Michael Hanus committed
1
2
3
4
5
6
--------------------------------------------------------------------------------
--- This is the main module of the Curry Package Manager.
--------------------------------------------------------------------------------

module CPM.Main where

Michael Hanus's avatar
Michael Hanus committed
7
import Char         ( toLower )
Michael Hanus's avatar
Michael Hanus committed
8
9
import CSV          ( showCSV )
import Directory    ( doesFileExist, getAbsolutePath, doesDirectoryExist
Michael Hanus's avatar
Michael Hanus committed
10
                    , copyFile, createDirectory, createDirectoryIfMissing
Michael Hanus's avatar
Michael Hanus committed
11
12
                    , getCurrentDirectory, getDirectoryContents
                    , getModificationTime
Michael Hanus's avatar
Michael Hanus committed
13
                    , renameFile, removeFile, setCurrentDirectory )
Michael Hanus's avatar
Michael Hanus committed
14
import Distribution ( stripCurrySuffix, addCurrySubdir )
Michael Hanus's avatar
Michael Hanus committed
15
import Either
Michael Hanus's avatar
Michael Hanus committed
16
import FilePath     ( (</>), splitSearchPath, replaceExtension, takeExtension )
Michael Hanus's avatar
Michael Hanus committed
17
import IO           ( hFlush, stdout )
Michael Hanus's avatar
Michael Hanus committed
18
import List         ( groupBy, intercalate, isSuffixOf, nub, split, splitOn )
Michael Hanus's avatar
Michael Hanus committed
19
import Sort         ( sortBy )
Michael Hanus's avatar
Michael Hanus committed
20
21
import System       ( getArgs, getEnviron, setEnviron, unsetEnviron, exitWith
                    , system )
Michael Hanus's avatar
Michael Hanus committed
22
23
24
25
26

import Boxes (table, render)
import OptParse
import CPM.ErrorLogger
import CPM.FileUtil ( fileInPath, joinSearchPath, safeReadFile, whenFileExists
Michael Hanus's avatar
Michael Hanus committed
27
                    , ifFileExists, inDirectory, removeDirectoryComplete
Michael Hanus's avatar
Michael Hanus committed
28
                    , copyDirectory, quote )
Michael Hanus's avatar
Michael Hanus committed
29
import CPM.Config   ( Config (..)
30
                    , readConfigurationWithDefault, showCompilerVersion )
Michael Hanus's avatar
Michael Hanus committed
31
32
33
34
import CPM.PackageCache.Global ( GlobalCache, readInstalledPackagesFromDir
                               , installFromZip, checkoutPackage
                               , uninstallPackage )
import CPM.Package
35
import CPM.Resolution ( isCompatibleToCompiler, showResult )
Michael Hanus's avatar
Michael Hanus committed
36
import CPM.Repository ( Repository, readRepository, findVersion, listPackages
Michael Hanus's avatar
Michael Hanus committed
37
38
                      , findLatestVersion, updateRepository, searchPackages
                      , updateRepositoryCache )
Michael Hanus's avatar
Michael Hanus committed
39
40
41
42
import CPM.PackageCache.Runtime ( dependencyPathsSeparate, writePackageConfig )
import CPM.PackageCopy
import CPM.Diff.API as APIDiff
import qualified CPM.Diff.Behavior as BDiff
Michael Hanus's avatar
Michael Hanus committed
43
import CPM.ConfigPackage (packagePath)
Michael Hanus's avatar
Michael Hanus committed
44
45
46
47
48
49

-- Banner of this tool:
cpmBanner :: String
cpmBanner = unlines [bannerLine,bannerText,bannerLine]
 where
 bannerText =
Michael Hanus's avatar
Michael Hanus committed
50
  "Curry Package Manager <curry-language.org/tools/cpm> (version of 17/07/2017)"
Michael Hanus's avatar
Michael Hanus committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 bannerLine = take (length bannerText) (repeat '-')

main :: IO ()
main = do
  args <- getArgs
  parseResult <- return $ parse (intercalate " " args) optionParser "cpm"
  case parseResult of
    Left err -> do putStrLn cpmBanner
                   putStrLn err
                   putStrLn "(use option -h for usage information)"
                   exitWith 1
    Right  r -> case applyParse r of
      Left err   -> do putStrLn cpmBanner
                       --printUsage "cpm" 80 optionParser
                       putStrLn err
                       exitWith 1
      Right opts -> runWithArgs opts

runWithArgs :: Options -> IO ()
runWithArgs opts = do
Michael Hanus's avatar
Michael Hanus committed
71
  setWithShowTime (optWithTime opts)
Michael Hanus's avatar
Michael Hanus committed
72
73
74
75
76
77
78
79
80
81
82
  missingExecutables <- checkExecutables
  unless (null missingExecutables) $ do
      putStrLn $ "The following programs could not be found on the PATH " ++
                 "(they are required for cpm to work):\n" ++
                 intercalate ", " missingExecutables
      exitWith 1
  config <- readConfigurationWithDefault (optDefConfig opts) >>= \c ->
   case c of
    Left err -> do putStrLn $ "Error reading .cpmrc settings: " ++ err
                   exitWith 1
    Right c' -> return c'
Michael Hanus's avatar
Michael Hanus committed
83
  let getRepoGC = readRepository config >>= \repo ->
Michael Hanus's avatar
Michael Hanus committed
84
                  getGlobalCache config repo >>= \gc -> return (repo,gc)
Michael Hanus's avatar
Michael Hanus committed
85
86
87
88
  setLogLevel $ optLogLevel opts
  (msgs, result) <- case optCommand opts of
    NoCommand   -> failIO "NoCommand"
    Update      -> updateRepository config
Michael Hanus's avatar
Michael Hanus committed
89
90
91
92
93
94
95
    Compiler o  -> compiler  o config getRepoGC
    Exec o      -> exec      o config getRepoGC
    Doc  o      -> docCmd    o config getRepoGC
    Test o      -> testCmd   o config getRepoGC
    Uninstall o -> uninstall o config getRepoGC
    Link o      -> linkCmd   o config
    Add  o      -> addCmd    o config
Michael Hanus's avatar
Michael Hanus committed
96
    Clean       -> cleanPackage Info
Michael Hanus's avatar
Michael Hanus committed
97
    New o       -> newPackage o
Michael Hanus's avatar
Michael Hanus committed
98
    _ -> do repo <- readRepository config
Michael Hanus's avatar
Michael Hanus committed
99
            case optCommand opts of
Michael Hanus's avatar
Michael Hanus committed
100
101
              List   o -> listCmd    o config repo
              Search o -> searchCmd  o config repo
Michael Hanus's avatar
Michael Hanus committed
102
              _ -> do globalCache <- getGlobalCache config repo
Michael Hanus's avatar
Michael Hanus committed
103
104
                      case optCommand opts of
                        Deps         -> deps         config repo globalCache
Michael Hanus's avatar
Michael Hanus committed
105
                        PkgInfo o    -> infoCmd    o config repo globalCache
Michael Hanus's avatar
Michael Hanus committed
106
                        Checkout o   -> checkout   o config repo globalCache
Michael Hanus's avatar
Michael Hanus committed
107
                        InstallApp o -> installapp o config repo globalCache
Michael Hanus's avatar
Michael Hanus committed
108
109
110
111
112
113
114
115
116
117
118
                        Install o    -> install    o config repo globalCache
                        Diff o       -> diff       o config repo globalCache
                        Upgrade o    -> upgrade    o config repo globalCache
                        _ -> error "Internal command processing error!"
  mapIO showLogEntry msgs
  let allOk =  all (levelGte Info) (map logLevelOf msgs) &&
               either (\le -> levelGte Info (logLevelOf le))
                      (const True)
                      result
  exitWith (if allOk then 0 else 1)

Michael Hanus's avatar
Michael Hanus committed
119
120
121
getGlobalCache :: Config -> Repository -> IO GlobalCache
getGlobalCache config repo = do
  maybeGC <- readInstalledPackagesFromDir repo $ packageInstallDir config
Michael Hanus's avatar
Michael Hanus committed
122
123
124
125
126
127
128
129
  case maybeGC of
    Left err -> do putStrLn $ "Error reading global package cache: " ++ err
                   exitWith 1
    Right gc -> return gc

data Options = Options
  { optLogLevel  :: LogLevel
  , optDefConfig :: [(String,String)]
Michael Hanus's avatar
Michael Hanus committed
130
  , optWithTime  :: Bool
Michael Hanus's avatar
Michael Hanus committed
131
132
133
134
135
136
  , optCommand   :: Command }

data Command 
  = Deps 
  | NoCommand
  | Checkout   CheckoutOptions
Michael Hanus's avatar
Michael Hanus committed
137
  | InstallApp CheckoutOptions
Michael Hanus's avatar
Michael Hanus committed
138
139
140
141
142
143
144
145
146
  | Install    InstallOptions
  | Uninstall  UninstallOptions
  | PkgInfo    InfoOptions
  | Compiler   CompilerOptions
  | Update
  | List       ListOptions
  | Search     SearchOptions
  | Upgrade    UpgradeOptions
  | Link       LinkOptions
Michael Hanus's avatar
Michael Hanus committed
147
  | Add        AddOptions
Michael Hanus's avatar
Michael Hanus committed
148
  | Exec       ExecOptions
149
  | Doc        DocOptions
Michael Hanus's avatar
Michael Hanus committed
150
151
  | Test       TestOptions
  | Diff       DiffOptions
Michael Hanus's avatar
Michael Hanus committed
152
  | New        NewOptions
Michael Hanus's avatar
Michael Hanus committed
153
  | Clean
Michael Hanus's avatar
Michael Hanus committed
154
155
156
157
158
159
160
161
162

data CheckoutOptions = CheckoutOptions
  { coPackage    :: String
  , coVersion    :: Maybe Version
  , coPrerelease :: Bool }

data InstallOptions = InstallOptions
  { instTarget     :: Maybe String
  , instVersion    :: Maybe Version
Michael Hanus's avatar
Michael Hanus committed
163
  , instPrerelease :: Bool
Michael Hanus's avatar
Michael Hanus committed
164
165
  , instExecutable :: Bool
  , instExecOnly   :: Bool }
Michael Hanus's avatar
Michael Hanus committed
166
167
168
169
170
171
172
173

data UninstallOptions = UninstallOptions
  { uninstPackage :: Maybe String
  , uninstVersion :: Maybe Version }

data InfoOptions = InfoOptions
  { infoPackage :: Maybe String
  , infoVersion :: Maybe Version
Michael Hanus's avatar
Michael Hanus committed
174
175
176
  , infoAll     :: Bool
  , infoPlain   :: Bool  -- plain output, no bold/color
  }
Michael Hanus's avatar
Michael Hanus committed
177
178

data ListOptions = ListOptions
Michael Hanus's avatar
Michael Hanus committed
179
  { listVers :: Bool   -- list all versions of each package
Michael Hanus's avatar
Michael Hanus committed
180
181
  , listCSV  :: Bool   -- list in CSV format
  , listCat  :: Bool   -- list all categories
182
  }
Michael Hanus's avatar
Michael Hanus committed
183
184

data SearchOptions = SearchOptions
Michael Hanus's avatar
Michael Hanus committed
185
186
187
  { searchQuery  :: String -- the term to search for
  , searchModule :: Bool   -- search for some module?
  , searchExec   :: Bool   -- search for some executable?
Michael Hanus's avatar
Michael Hanus committed
188
  }
Michael Hanus's avatar
Michael Hanus committed
189
190
191
192
193
194
195

data UpgradeOptions = UpgradeOptions
  { upgrTarget :: Maybe String }

data LinkOptions = LinkOptions
  { lnkSource :: String }

Michael Hanus's avatar
Michael Hanus committed
196
197
198
199
200
data AddOptions = AddOptions
  { addSource :: String
  , forceAdd  :: Bool
  }

Michael Hanus's avatar
Michael Hanus committed
201
202
203
data NewOptions = NewOptions
  { projectName :: String }

Michael Hanus's avatar
Michael Hanus committed
204
205
206
207
208
209
210
211
data ExecOptions = ExecOptions
  { exeCommand :: String   -- command to be executed
  , exePath    :: [String] -- additional load path
  }

data CompilerOptions = CompilerOptions
  { comCommand :: String }

212
data DocOptions = DocOptions
Michael Hanus's avatar
Michael Hanus committed
213
214
215
216
  { docDir      :: Maybe String    -- documentation directory
  , docModules  :: Maybe [String]  -- modules to be documented
  , docPrograms :: Bool            -- generate documentation for programs
  , docManual   :: Bool            -- generate manual (if specified)
217
218
  }

Michael Hanus's avatar
Michael Hanus committed
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
data TestOptions = TestOptions
  { testModules :: Maybe [String] }

data DiffOptions = DiffOptions
  { diffVersion  :: Maybe Version
  , diffModules  :: Maybe [String]
  , diffAPI      :: Bool
  , diffBehavior :: Bool
  , diffUseAna   :: Bool }

checkoutOpts :: Options -> CheckoutOptions
checkoutOpts s = case optCommand s of
  Checkout opts -> opts
  _             -> CheckoutOptions "" Nothing False

installOpts :: Options -> InstallOptions
installOpts s = case optCommand s of
  Install opts -> opts
Michael Hanus's avatar
Michael Hanus committed
237
  _            -> InstallOptions Nothing Nothing False True False
Michael Hanus's avatar
Michael Hanus committed
238
239
240
241
242
243
244
245
246

uninstallOpts :: Options -> UninstallOptions
uninstallOpts s = case optCommand s of
  Uninstall opts -> opts
  _              -> UninstallOptions Nothing Nothing

infoOpts :: Options -> InfoOptions
infoOpts s = case optCommand s of
  PkgInfo opts -> opts
Michael Hanus's avatar
Michael Hanus committed
247
  _            -> InfoOptions Nothing Nothing False False
Michael Hanus's avatar
Michael Hanus committed
248
249
250
251

listOpts :: Options -> ListOptions
listOpts s = case optCommand s of
  List opts -> opts
252
  _         -> ListOptions False False False
Michael Hanus's avatar
Michael Hanus committed
253
254
255
256

searchOpts :: Options -> SearchOptions
searchOpts s = case optCommand s of
  Search opts -> opts
Michael Hanus's avatar
Michael Hanus committed
257
  _           -> SearchOptions "" False False
Michael Hanus's avatar
Michael Hanus committed
258
259
260
261
262
263
264
265
266
267
268

upgradeOpts :: Options -> UpgradeOptions
upgradeOpts s = case optCommand s of
  Upgrade opts -> opts
  _            -> UpgradeOptions Nothing

linkOpts :: Options -> LinkOptions
linkOpts s = case optCommand s of
  Link opts -> opts
  _         -> LinkOptions ""

Michael Hanus's avatar
Michael Hanus committed
269
270
271
272
273
addOpts :: Options -> AddOptions
addOpts s = case optCommand s of
  Add opts -> opts
  _        -> AddOptions "" False

Michael Hanus's avatar
Michael Hanus committed
274
275
276
277
278
newOpts :: Options -> NewOptions
newOpts s = case optCommand s of
  New opts -> opts
  _        -> NewOptions ""

Michael Hanus's avatar
Michael Hanus committed
279
280
281
282
283
284
285
286
287
288
execOpts :: Options -> ExecOptions
execOpts s = case optCommand s of
  Exec opts -> opts
  _         -> ExecOptions "" []

compOpts :: Options -> CompilerOptions
compOpts s = case optCommand s of
  Compiler opts -> opts
  _             -> CompilerOptions ""

289
290
291
docOpts :: Options -> DocOptions
docOpts s = case optCommand s of
  Doc opts -> opts
Michael Hanus's avatar
Michael Hanus committed
292
  _        -> DocOptions Nothing Nothing True True
293

Michael Hanus's avatar
Michael Hanus committed
294
295
296
297
298
299
300
301
302
303
304
testOpts :: Options -> TestOptions
testOpts s = case optCommand s of
  Test opts -> opts
  _         -> TestOptions Nothing

diffOpts :: Options -> DiffOptions
diffOpts s = case optCommand s of
  Diff opts -> opts
  _         -> DiffOptions Nothing Nothing True True True

readLogLevel :: String -> Either String LogLevel
Michael Hanus's avatar
Michael Hanus committed
305
306
307
308
readLogLevel s = case map toLower s of
  "debug" -> Right Debug
  "info"  -> Right Info
  _       -> Left $ "Illegal verbosity value: " ++ s
Michael Hanus's avatar
Michael Hanus committed
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329

readRcOption :: String -> Either String (String,String)
readRcOption s =
  let (option,value) = break (=='=') s
  in if null value then Left $ "Error in option definition: '=' missing"
                   else Right $ (option, tail value)

readVersion' :: String -> Either String Version
readVersion' s = case readVersion s of
  Nothing -> Left $ "'" ++ s ++ "' is not a valid version"
  Just  v -> Right v

applyEither :: [Options -> Either String Options] -> Options -> Either String Options
applyEither [] z = Right z
applyEither (f:fs) z = case f z of
  Left err -> Left err
  Right z' -> applyEither fs z'

applyParse :: [Options -> Either String Options] -> Either String Options
applyParse fs = applyEither fs defaultOpts
 where
Michael Hanus's avatar
Michael Hanus committed
330
  defaultOpts = Options Info [] False NoCommand
Michael Hanus's avatar
Michael Hanus committed
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349

(>.>) :: Either String a -> (a -> b) -> Either String b
a >.> f = case a of 
  Left err -> Left err
  Right  v -> Right $ f v

optionParser :: ParseSpec (Options -> Either String Options)
optionParser = optParser 
  (   option (\s a -> readLogLevel s >.> \ll -> a { optLogLevel = ll })
        (  long "verbosity"
        <> short "v"
        <> metavar "LEVEL"
        <> help "Log level for the application. Valid values are 'info' and 'debug'." )
  <.> option (\s a -> readRcOption s >.> \kv ->
                      a { optDefConfig = optDefConfig a ++ [kv] })
        (  long "define"
        <> short "d"
        <> metavar "DEFINITION"
        <> help "Overwrite definition of cpmrc file with 'option=value'." )
Michael Hanus's avatar
Michael Hanus committed
350
351
352
353
  <.> flag (\a -> Right $ a { optWithTime = True })
        (  long "time"
        <> short "t"
        <> help "Show elapsed time with every log output" )
Michael Hanus's avatar
Michael Hanus committed
354
355
  <.> commands (metavar "COMMAND")
        (   command "checkout" (help "Checkout a package.") Right
Michael Hanus's avatar
Michael Hanus committed
356
                    (checkoutArgs Checkout)
Michael Hanus's avatar
Michael Hanus committed
357
        <|> command "install" (help "Install a package with its dependencies.")
Michael Hanus's avatar
Michael Hanus committed
358
                     (\a -> Right $ a { optCommand = Install (installOpts a) })
Michael Hanus's avatar
Michael Hanus committed
359
                     installArgs
Michael Hanus's avatar
Michael Hanus committed
360
        <|> command "uninstall" (help "Uninstall a package")
Michael Hanus's avatar
Michael Hanus committed
361
362
                 (\a -> Right $ a { optCommand = Uninstall (uninstallOpts a) })
                 uninstallArgs
Michael Hanus's avatar
Michael Hanus committed
363
364
365
366
        <|> command "installapp"
                     (help "Install the application provided by a package (depreacted).") 
                     Right
                     (checkoutArgs InstallApp)
Michael Hanus's avatar
Michael Hanus committed
367
368
369
370
        <|> command "deps" (help "Calculate dependencies")
                           (\a -> Right $ a { optCommand = Deps }) [] 
        <|> command "clean" (help "Clean the current package")
                          (\a -> Right $ a { optCommand = Clean }) []
Michael Hanus's avatar
Michael Hanus committed
371
        <|> command "new" (help "Create a new package") Right newArgs
Michael Hanus's avatar
Michael Hanus committed
372
373
        <|> command "update" (help "Update the package index")
                             (\a -> Right $ a { optCommand = Update }) []
Michael Hanus's avatar
Michael Hanus committed
374
375
376
377
378
379
380
381
        <|> command "curry"
           (help "Load package spec and start Curry with correct dependencies.")
                    (\a -> Right $ a { optCommand = Compiler (compOpts a) })
                    curryArgs
        <|> command "exec"
                    (help "Execute a command with the CURRYPATH set")
                    (\a -> Right $ a { optCommand = Exec (execOpts a) })
                    execArgs
Michael Hanus's avatar
Michael Hanus committed
382
        <|> command "info" (help "Print package information")
Michael Hanus's avatar
Michael Hanus committed
383
384
                    (\a -> Right $ a { optCommand = PkgInfo (infoOpts a) })
                    infoArgs
385
386
387
388
        <|> command "doc"
           (help "Generation documentation for current package (with CurryDoc)")
                    (\a -> Right $ a { optCommand = Doc (docOpts a) })
                    docArgs
Michael Hanus's avatar
Michael Hanus committed
389
390
        <|> command "test" (help "Test the current package (with CurryCheck)")
                    (\a -> Right $ a { optCommand = Test (testOpts a) })
Michael Hanus's avatar
Michael Hanus committed
391
                    testArgs
Michael Hanus's avatar
Michael Hanus committed
392
393
394
        <|> command "diff"
                    (help "Diff the current package against another version")
                    (\a -> Right $ a { optCommand = Diff (diffOpts a) })
Michael Hanus's avatar
Michael Hanus committed
395
                    diffArgs
Michael Hanus's avatar
Michael Hanus committed
396
        <|> command "list" (help "List all packages of the repository")
Michael Hanus's avatar
Michael Hanus committed
397
398
                    (\a -> Right $ a { optCommand = List (listOpts a) })
                    listArgs
Michael Hanus's avatar
Michael Hanus committed
399
        <|> command "search" (help "Search the package repository") Right
Michael Hanus's avatar
Michael Hanus committed
400
                    searchArgs
Michael Hanus's avatar
Michael Hanus committed
401
402
        <|> command "upgrade" (help "Upgrade one or more packages")
                    (\a -> Right $ a { optCommand = Upgrade (upgradeOpts a) })
Michael Hanus's avatar
Michael Hanus committed
403
                    upgradeArgs
Michael Hanus's avatar
Michael Hanus committed
404
        <|> command "link" (help "Link a package to the local cache") Right
Michael Hanus's avatar
Michael Hanus committed
405
406
407
                    linkArgs
        <|> command "add" (help "Add a package to the local repository") Right
                    addArgs ) )
Michael Hanus's avatar
Michael Hanus committed
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 where
  checkoutArgs cmd =
        arg (\s a -> Right $ a { optCommand = cmd (checkoutOpts a)
                                                  { coPackage = s } })
          (  metavar "PACKAGE"
          <> help "The package name" )
    <.> arg (\s a -> readVersion' s >.> \v ->
                     a { optCommand = cmd (checkoutOpts a)
                                          { coVersion = Just v } })
          (  metavar "VERSION"
          <> help "The package version"
          <> optional)
    <.> flag (\a -> Right $ a { optCommand = cmd (checkoutOpts a)
                                                 { coPrerelease = True } })
          (  short "p"
          <> long "pre"
          <> help "Try pre-release versions when searching for newest version.")

  installArgs =
        arg (\s a -> Right $ a { optCommand = Install (installOpts a)
                                                      { instTarget = Just s } })
          (  metavar "TARGET"
          <> help "A package name or the path to a file"
          <> optional)
    <.> arg (\s a -> readVersion' s >.> \v ->
             a { optCommand = Install (installOpts a) { instVersion = Just v } })
          (  metavar "VERSION"
          <> help "The package version"
          <> optional)
    <.> flag (\a -> Right $ a { optCommand = Install (installOpts a)
                                               { instPrerelease = True } })
          (  short "p"
          <> long "pre"
          <> help "Try pre-release versions when searching for newest version.")
    <.> flag (\a -> Right $ a { optCommand = Install (installOpts a)
                                               { instExecutable = False } })
          (  short "n"
          <> long "noexec"
          <> help "Do not install executable.")
Michael Hanus's avatar
Michael Hanus committed
447
448
449
450
451
    <.> flag (\a -> Right $ a { optCommand = Install (installOpts a)
                                               { instExecOnly = True } })
          (  short "x"
          <> long "exec"
          <> help "Install executable only (do not re-install dependencies).")
Michael Hanus's avatar
Michael Hanus committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503

  uninstallArgs =
        arg (\s a -> Right $ a { optCommand =
             Uninstall (uninstallOpts a) { uninstPackage = Just s } })
          (  metavar "PACKAGE"
          <> help "The package to be uninstalled"
          <> optional)
    <.> arg (\s a -> readVersion' s >.> \v ->
                     a { optCommand = Uninstall (uninstallOpts a)
                                                { uninstVersion = Just v } })
          (  metavar "VERSION"
          <> help "The version to be uninstalled"
          <> optional)

  newArgs =
   arg (\s a -> Right $ a { optCommand = New (newOpts a)
                                             { projectName = s } })
       (  metavar "PROJECT"
       <> help "The name of the new project" )

  curryArgs =
    rest (\s a -> Right $ a { optCommand = Compiler (compOpts a)
                                                    { comCommand = s } })
         (  metavar "ARGS"
         <> help "The options to pass to the compiler"
         <> optional )

  execArgs =
    rest (\s a -> Right $ a { optCommand = Exec (execOpts a)
                                                { exeCommand = s } })
         (  metavar "CMD"
         <> help "The command to execute. Don't forget the quotes!"
         <> optional )

  infoArgs =
        arg (\s a -> Right $ a { optCommand = PkgInfo (infoOpts a)
                                                { infoPackage = Just s } })
          (  metavar "PACKAGE"
          <> help ("The package name. If no name is specified, cpm tries " ++
                   "to read a package specification in the current directory.")
          <> optional) 
    <.> arg (\s a -> readVersion' s >.> \v -> a
                                 { optCommand = PkgInfo (infoOpts a)
                                                  { infoVersion = Just v } })
          (  metavar "VERSION"
          <> help ("The package version. If no version is specified, " ++
                   "cpm uses the latest version of the specified package.")
          <> optional )
    <.> flag (\a -> Right $ a { optCommand = PkgInfo (infoOpts a)
                                               { infoAll = True } })
          (  short "a"
          <> long "all"
Michael Hanus's avatar
Michael Hanus committed
504
505
506
507
508
509
          <> help "Show all infos" )
    <.> flag (\a -> Right $ a { optCommand = PkgInfo (infoOpts a)
                                               { infoPlain = True } })
          (  short "p"
          <> long "plain"
          <> help "Plain output (no control characters for bold or colors)"
Michael Hanus's avatar
Michael Hanus committed
510
511
          <> optional )

512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
  docArgs =
    option (\s a -> Right $ a { optCommand =
                                  Doc (docOpts a) { docDir = Just $ s } })
          (  long "docdir"
          <> short "d"
          <> help "The documentation directory (default: 'cdoc')"
          <> optional )
    <.>
    option (\s a -> Right $ a { optCommand = Doc (docOpts a)
                                      { docModules = Just $ splitOn "," s } })
          (  long "modules"
          <> short "m"
          <> help ("The modules to be documented, " ++
                   "separate multiple modules by comma")
          <> optional )
Michael Hanus's avatar
Michael Hanus committed
527
528
529
530
531
532
533
534
535
536
537
538
    <.> flag (\a -> Right $ a { optCommand = Doc (docOpts a)
                                               { docManual = False } })
          (  short "p"
          <> long "programs"
          <> help "Generate only program documentation (with CurryDoc)"
          <> optional )
    <.> flag (\a -> Right $ a { optCommand = Doc (docOpts a)
                                               { docPrograms = False } })
          (  short "t"
          <> long "text"
          <> help "Generate only manual (according to package specification)"
          <> optional )
539

Michael Hanus's avatar
Michael Hanus committed
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
  testArgs =
    option (\s a -> Right $ a { optCommand = Test (testOpts a)
                                      { testModules = Just $ splitOn "," s } })
          (  long "modules"
          <> short "m"
          <> help "The modules to be tested, separate multiple modules by comma"
          <> optional )

  diffArgs =
       arg (\s a -> readVersion' s >.> \v ->
                 a { optCommand = Diff (diffOpts a) { diffVersion = Just v } })
           (  metavar "VERSION"
           <> help ("The other package version. If no version is specified, " ++
                    "cpm diffs against the latest repository version.")
           <> optional )
   <.> option (\s a -> Right $ a { optCommand = Diff (diffOpts a)
                                     { diffModules = Just $ splitOn "," s } })
         (  long "modules"
         <> short "m"
         <> help "The modules to compare, separate multiple modules by comma"
         <> optional )
   <.> flag (\a -> Right $ a { optCommand = Diff (diffOpts a)
                          { diffAPI = True, diffBehavior = False } })
         (  long "api-only"
         <> short "a"
         <> help "Diff only the API")
   <.> flag (\a -> Right $ a { optCommand = Diff (diffOpts a)
                          { diffAPI = False, diffBehavior = True } })
         (  long "behavior-only"
         <> short "b"
         <> help "Diff only the behavior")
   <.> flag (\a -> Right $ a { optCommand = Diff (diffOpts a)
                                            { diffUseAna = False } })
         (  long "unsafe"
         <> short "u"
         <> help
         "Do not use automatic termination analysis for safe behavior checking")

  listArgs =
Michael Hanus's avatar
Michael Hanus committed
579
        flag (\a -> Right $ a { optCommand =
Michael Hanus's avatar
Michael Hanus committed
580
581
582
                                  List (listOpts a) { listVers = True } })
          (  short "v"
          <> long "versions"
Michael Hanus's avatar
Michael Hanus committed
583
          <> help "Show all versions" ) 
Michael Hanus's avatar
Michael Hanus committed
584
585
    <.> flag (\a -> Right $ a { optCommand =
                                  List (listOpts a) { listCSV = True } })
Michael Hanus's avatar
Michael Hanus committed
586
587
588
          (  short "t"
          <> long "csv"
          <> help "Show in CSV table format" )
Michael Hanus's avatar
Michael Hanus committed
589
590
    <.> flag (\a -> Right $ a { optCommand =
                                  List (listOpts a) { listCat = True } })
Michael Hanus's avatar
Michael Hanus committed
591
592
593
594
595
          (  short "c"
          <> long "category"
          <> help "Show all categories" )

  searchArgs =
Michael Hanus's avatar
Michael Hanus committed
596
597
598
599
        flag (\a -> Right $ a { optCommand = Search (searchOpts a)
                                               { searchModule = True } })
             (  short "m"
             <> long "module"
Michael Hanus's avatar
Michael Hanus committed
600
601
602
603
604
605
             <> help "Search for an exported module" )
    <.> flag (\a -> Right $ a { optCommand = Search (searchOpts a)
                                               { searchExec = True } })
             (  short "x"
             <> long "exec"
             <> help "Search for the name of an executable" )
Michael Hanus's avatar
Michael Hanus committed
606
607
608
609
    <.> arg (\s a -> Right $ a { optCommand = Search (searchOpts a)
                                                { searchQuery = s } }) 
            (  metavar "QUERY"
            <> help "The search term" )
Michael Hanus's avatar
Michael Hanus committed
610
611
612
613
614
615
616
617
618
619
620
621

  upgradeArgs =
    arg (\s a -> Right $ a { optCommand = Upgrade (upgradeOpts a)
                                            { upgrTarget = Just s } })
        (  metavar "PACKAGE"
        <> help "The package to upgrade" 
        <> optional )

  linkArgs =
    arg (\s a -> Right $ a { optCommand = Link (linkOpts a) { lnkSource = s } })
        (  metavar "SOURCE"
        <> help "The directory to link" )
Michael Hanus's avatar
Michael Hanus committed
622

Michael Hanus's avatar
Michael Hanus committed
623
624
625
626
627
628
629
630
631
632
633
  addArgs =
       flag (\a -> Right $ a { optCommand =
                                 Add (addOpts a) { forceAdd = True } })
            (  short "f"
            <> long "force"
            <> help "Force, i.e., overwrite existing package" )
   <.> arg (\s a -> Right $ a { optCommand =
                                  Add (addOpts a) { addSource = s } })
           (  metavar "SOURCE"
           <> help "The directory to add to the local repository" )

Michael Hanus's avatar
Michael Hanus committed
634
635
-- Check if operating system executables we depend on are present on the
-- current system.
Michael Hanus's avatar
Michael Hanus committed
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
checkExecutables :: IO [String]
checkExecutables = do
  present <- mapIO fileInPath listOfExecutables
  return $ map fst $ filter (not . snd) (zip listOfExecutables present)
 where
  listOfExecutables = 
    [ "curl"  
    , "git"   
    , "unzip" 
    , "cp"
    , "rm"
    , "ln"
    , "readlink" ]

deps :: Config -> Repository -> GlobalCache -> IO (ErrorLogger ())
deps cfg repo gc =
  tryFindLocalPackageSpec "." |>= \specDir ->
  resolveDependencies cfg repo gc specDir |>= \result ->
  putStrLn (showResult result) >> succeedIO ()

Michael Hanus's avatar
Michael Hanus committed
656
infoCmd :: InfoOptions -> Config -> Repository -> GlobalCache
Michael Hanus's avatar
Michael Hanus committed
657
     -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
658
infoCmd (InfoOptions Nothing Nothing allinfos plain) _ _ gc =
Michael Hanus's avatar
Michael Hanus committed
659
  tryFindLocalPackageSpec "." |>= \specDir ->
Michael Hanus's avatar
Michael Hanus committed
660
  loadPackageSpec specDir |>= printInfo allinfos plain gc
Michael Hanus's avatar
Michael Hanus committed
661
infoCmd (InfoOptions (Just pkg) Nothing allinfos plain) cfg repo gc =
662
  case findLatestVersion cfg repo pkg False of
Michael Hanus's avatar
Michael Hanus committed
663
664
   Nothing -> failIO $
                "Package '" ++ pkg ++ "' not found in package repository."
Michael Hanus's avatar
Michael Hanus committed
665
   Just p  -> printInfo allinfos plain gc p
Michael Hanus's avatar
Michael Hanus committed
666
infoCmd (InfoOptions (Just pkg) (Just v) allinfos plain) _ repo gc =
Michael Hanus's avatar
Michael Hanus committed
667
 case findVersion repo pkg v of
Michael Hanus's avatar
Michael Hanus committed
668
   Nothing -> failIO $ "Package '" ++ pkg ++ "-" ++ showVersion v ++
Michael Hanus's avatar
Michael Hanus committed
669
                       "' not found in package repository."
Michael Hanus's avatar
Michael Hanus committed
670
   Just p  -> printInfo allinfos plain gc p
Michael Hanus's avatar
Michael Hanus committed
671
infoCmd (InfoOptions Nothing (Just _) _ _) _ _ _ =
Michael Hanus's avatar
Michael Hanus committed
672
  failIO "Must specify package name"
Michael Hanus's avatar
Michael Hanus committed
673

Michael Hanus's avatar
Michael Hanus committed
674
675
676
677
printInfo :: Bool -> Bool -> GlobalCache -> Package
          -> IO (ErrorLogger ())
printInfo allinfos plain gc pkg =
  putStrLn (renderPackageInfo allinfos plain gc pkg) >> succeedIO ()
Michael Hanus's avatar
Michael Hanus committed
678
679


Michael Hanus's avatar
Michael Hanus committed
680
compiler :: CompilerOptions -> Config -> IO (Repository,GlobalCache)
Michael Hanus's avatar
Michael Hanus committed
681
         -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
682
compiler o cfg getRepoGC =
683
684
685
686
687
  tryFindLocalPackageSpec "." |>= \pkgdir ->
  loadPackageSpec pkgdir |>= \pkg ->
  checkCompiler cfg pkg >>
  loadCurryPathFromCache pkgdir |>=
  maybe (computePackageLoadPath pkgdir pkg) succeedIO |>= \currypath ->
Michael Hanus's avatar
Michael Hanus committed
688
689
  log Info ("Starting '" ++ currybin ++ "' with") |>
  log Info ("CURRYPATH=" ++ currypath) |>
Michael Hanus's avatar
Michael Hanus committed
690
  do setEnviron "CURRYPATH" $ currypath
Michael Hanus's avatar
Michael Hanus committed
691
     ecode <- showExecCmd $ currybin ++ " " ++ comCommand o
Michael Hanus's avatar
Michael Hanus committed
692
693
694
695
     unsetEnviron "CURRYPATH"
     unless (ecode==0) (exitWith ecode)
     succeedIO ()
 where
Michael Hanus's avatar
Michael Hanus committed
696
697
  currybin = curryExec cfg

698
  computePackageLoadPath pkgdir pkg =
Michael Hanus's avatar
Michael Hanus committed
699
    getRepoGC >>= \ (repo,gc) ->
Michael Hanus's avatar
Michael Hanus committed
700
    resolveAndCopyDependenciesForPackage cfg repo gc pkgdir pkg |>= \pkgs ->
Michael Hanus's avatar
Michael Hanus committed
701
    getAbsolutePath pkgdir >>= \abs -> succeedIO () |>
Michael Hanus's avatar
Michael Hanus committed
702
703
    let srcdirs = map (abs </>) (sourceDirsOf pkg)
        currypath = joinSearchPath (srcdirs ++ dependencyPathsSeparate pkgs abs)
Michael Hanus's avatar
Michael Hanus committed
704
705
706
707
708
709
    in saveCurryPathToCache pkgdir currypath >> succeedIO currypath


checkout :: CheckoutOptions -> Config -> Repository -> GlobalCache
         -> IO (ErrorLogger ())
checkout (CheckoutOptions pkg Nothing pre) cfg repo gc =
710
 case findLatestVersion cfg repo pkg pre of
Michael Hanus's avatar
Michael Hanus committed
711
712
713
714
715
716
717
718
719
720
721
  Nothing -> failIO $ "Package '" ++ pkg ++
                      "' not found in package repository."
  Just  p -> acquireAndInstallPackageWithDependencies cfg repo gc p |>
             checkoutPackage cfg repo gc p
checkout (CheckoutOptions pkg (Just ver) _) cfg repo gc =
 case findVersion repo pkg ver of
  Nothing -> failIO $ "Package '" ++ pkg ++ "-" ++ showVersion ver ++
                      "' not found in package repository."
  Just  p -> acquireAndInstallPackageWithDependencies cfg repo gc p |>
             checkoutPackage cfg repo gc p

Michael Hanus's avatar
Michael Hanus committed
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
install :: InstallOptions -> Config -> Repository -> GlobalCache
        -> IO (ErrorLogger ())
install (InstallOptions Nothing Nothing _ instexec False) cfg repo gc =
  tryFindLocalPackageSpec "." |>= \pkgdir ->
  cleanCurryPathCache pkgdir |>
  installLocalDependencies cfg repo gc pkgdir |>= \ (pkg,_) ->
  writePackageConfig cfg pkgdir pkg |>
  if instexec then installExecutable cfg repo pkg else succeedIO ()
-- Install executable only:
install (InstallOptions Nothing Nothing _ _ True) cfg repo _ =
  tryFindLocalPackageSpec "." |>= \pkgdir ->
  loadPackageSpec pkgdir |>= \pkg ->
  installExecutable cfg repo pkg
install (InstallOptions (Just pkg) vers pre _ _) cfg repo gc = do
  fileExists <- doesFileExist pkg
  if fileExists
    then installFromZip cfg pkg
    else installapp (CheckoutOptions pkg vers pre) cfg repo gc
install (InstallOptions Nothing (Just _) _ _ _) _ _ _ =
  failIO "Must specify package name"

Michael Hanus's avatar
Michael Hanus committed
743
--- Installs the application (i.e., binary) provided by a package.
Michael Hanus's avatar
Michael Hanus committed
744
745
--- This is done by checking out the package into CPM's application packages
--- cache (default: $HOME/.cpm/app_packages, see APP_PACKAGE_PATH
746
747
--- in .cpmrc configuration file) and then install this package.
---
Michael Hanus's avatar
Michael Hanus committed
748
--- Internal note: the installed package should not be cleaned or removed
749
750
--- after the installation since its execution might refer (via the
--- config module) to some data stored in the package.
Michael Hanus's avatar
Michael Hanus committed
751
installapp :: CheckoutOptions -> Config -> Repository -> GlobalCache
Michael Hanus's avatar
Michael Hanus committed
752
           -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
753
installapp opts cfg repo gc = do
Michael Hanus's avatar
Michael Hanus committed
754
755
756
  let apppkgdir = appPackageDir cfg
      copkgdir  = apppkgdir </> coPackage opts
  curdir <- getCurrentDirectory
Michael Hanus's avatar
Michael Hanus committed
757
  removeDirectoryComplete copkgdir
Michael Hanus's avatar
Michael Hanus committed
758
759
  debugMessage ("Change into directory " ++ apppkgdir)
  inDirectory apppkgdir
Michael Hanus's avatar
Michael Hanus committed
760
761
762
763
764
765
766
767
768
769
770
771
    ( checkout opts cfg repo gc |>
      log Debug ("Change into directory " ++ copkgdir) |>
      (setCurrentDirectory copkgdir >> succeedIO ()) |>
      loadPackageSpec "." |>= \pkg ->
      maybe (setCurrentDirectory curdir >>
             removeDirectoryComplete copkgdir >>
             failIO ("Package '" ++ name pkg ++
                     "' does not contain an executable, nothing installed."))
            (\_ -> install (InstallOptions Nothing Nothing False True False)
                           cfg repo gc)
            (executableSpec pkg)
    )
Michael Hanus's avatar
Michael Hanus committed
772

773
774
775
776
777
778
--- Checks the compiler compatibility.
checkCompiler :: Config -> Package -> IO ()
checkCompiler cfg pkg =
  unless (isCompatibleToCompiler cfg pkg)
    (error $ "Incompatible compiler: " ++ showCompilerVersion cfg)

Michael Hanus's avatar
Michael Hanus committed
779
780
--- Installs the executable specified in the package in the
--- bin directory of CPM (compare .cpmrc).
Michael Hanus's avatar
Michael Hanus committed
781
782
installExecutable :: Config -> Repository -> Package -> IO (ErrorLogger ())
installExecutable cfg repo pkg =
783
  checkCompiler cfg pkg >>
Michael Hanus's avatar
Michael Hanus committed
784
785
  -- we read the global cache again since it might be modified by
  -- the installation of the package:
Michael Hanus's avatar
Michael Hanus committed
786
  getGlobalCache cfg repo >>= \gc ->
Michael Hanus's avatar
Michael Hanus committed
787
  maybe (succeedIO ())
Michael Hanus's avatar
Michael Hanus committed
788
        (\ (PackageExecutable name mainmod eopts) ->
Michael Hanus's avatar
Michael Hanus committed
789
790
791
           getLogLevel >>= \lvl ->
           getEnviron "PATH" >>= \path ->
           log Info ("Compiling main module: " ++ mainmod) |>
Michael Hanus's avatar
Michael Hanus committed
792
793
794
795
796
           let (cmpname,_,_) = compilerVersion cfg
               cmd = unwords $
                       [":set", if levelGte Debug lvl then "v1" else "v0"
                       , maybe "" id (lookup cmpname eopts)
                       , ":load", mainmod, ":save", ":quit"]
Michael Hanus's avatar
Michael Hanus committed
797
798
               bindir     = binInstallDir cfg
               binexec    = bindir </> name
799
           in compiler CompilerOptions { comCommand = cmd }
Michael Hanus's avatar
Michael Hanus committed
800
                       cfg (return (repo,gc)) |>
Michael Hanus's avatar
Michael Hanus committed
801
802
803
              log Info ("Installing executable '" ++ name ++ "' into '" ++
                        bindir ++ "'") |>
              (whenFileExists binexec (backupExistingBin binexec) >>
Michael Hanus's avatar
Michael Hanus committed
804
               -- renaming might not work across file systems, hence we move:
Michael Hanus's avatar
Michael Hanus committed
805
               showExecCmd (unwords ["mv", mainmod, binexec]) >>
Michael Hanus's avatar
Michael Hanus committed
806
807
808
809
810
               checkPath path bindir))
        (executableSpec pkg)
 where
  backupExistingBin binexec = do
    let binexecbak = binexec ++ ".bak"
Michael Hanus's avatar
Michael Hanus committed
811
    showExecCmd $ "rm -f " ++ binexecbak
Michael Hanus's avatar
Michael Hanus committed
812
813
814
815
816
817
818
819
820
821
    renameFile binexec binexecbak
    infoMessage $ "Existing executable '" ++ binexec ++ "' saved to '" ++
                  binexecbak ++ "'."

  checkPath path bindir =
    if bindir `elem` splitSearchPath path
      then succeedIO ()
      else log Info $ "It is recommended to add '" ++bindir++ "' to your path!"


Michael Hanus's avatar
Michael Hanus committed
822
uninstall :: UninstallOptions -> Config -> IO (Repository,GlobalCache)
Michael Hanus's avatar
Michael Hanus committed
823
          -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
824
825
826
827
828
829
830
831
832
833
834
835
836
uninstall (UninstallOptions (Just pkgname) (Just ver)) cfg getRepoGC =
  getRepoGC >>= \ (repo,gc) -> uninstallPackage cfg repo gc pkgname ver
--- uninstalls an application (i.e., binary) provided by a package:
uninstall (UninstallOptions (Just pkgname) Nothing) cfg _ = do
  let copkgdir  = appPackageDir cfg </> pkgname
  codirexists <- doesDirectoryExist copkgdir
  if codirexists
    then loadPackageSpec copkgdir |>= uninstallPackageExecutable cfg |>
         removeDirectoryComplete copkgdir >>
         log Info ("Package '" ++ pkgname ++
                   "' uninstalled from application package cache.")
    else failIO $ "Package '" ++ pkgname ++ "' is not installed."
uninstall (UninstallOptions Nothing (Just _)) _ _ =
Michael Hanus's avatar
Michael Hanus committed
837
  log Error "Please provide a package and version number!"
Michael Hanus's avatar
Michael Hanus committed
838
uninstall (UninstallOptions Nothing Nothing) cfg _ =
839
  tryFindLocalPackageSpec "." |>= \pkgdir ->
Michael Hanus's avatar
Michael Hanus committed
840
841
842
843
  loadPackageSpec pkgdir |>= uninstallPackageExecutable cfg

uninstallPackageExecutable :: Config -> Package -> IO (ErrorLogger ())
uninstallPackageExecutable cfg pkg =
Michael Hanus's avatar
Michael Hanus committed
844
  maybe (succeedIO ())
Michael Hanus's avatar
Michael Hanus committed
845
        (\ (PackageExecutable name _ _) ->
Michael Hanus's avatar
Michael Hanus committed
846
847
848
849
850
851
852
853
854
855
856
857
858
           let binexec = binInstallDir cfg </> name
           in ifFileExists binexec
                (removeFile binexec >>
                 log Info ("Executable '" ++ binexec ++ "' removed"))
                (log Info $ "Executable '" ++ binexec ++ "' not installed"))
        (executableSpec pkg)

tryFindVersion :: String -> Version -> Repository -> IO (ErrorLogger Package)
tryFindVersion pkg ver repo = case findVersion repo pkg ver of
  Nothing -> failIO $ "Package '" ++ pkg ++ "-" ++ (showVersion ver) ++
                      "' not found in package repository."
  Just  p -> succeedIO $ p

Michael Hanus's avatar
Michael Hanus committed
859
860
--- Lists all (compiler-compatible if `lall` is false) packages
--- in the given repository.
Michael Hanus's avatar
Michael Hanus committed
861
listCmd :: ListOptions -> Config -> Repository -> IO (ErrorLogger ())
862
listCmd (ListOptions lv csv cat) cfg repo =
Michael Hanus's avatar
Michael Hanus committed
863
  let listresult = if cat then renderCats catgroups
864
                          else renderPkgs allpkgs
Michael Hanus's avatar
Michael Hanus committed
865
  in putStr listresult >> succeedIO ()
Michael Hanus's avatar
Michael Hanus committed
866
 where
867
  -- all packages (and versions if `lv`)
Michael Hanus's avatar
Michael Hanus committed
868
  allpkgs = concatMap (if lv then id else ((:[]) . filterCompatPkgs cfg))
Michael Hanus's avatar
Michael Hanus committed
869
                      (sortBy (\ps1 ps2 -> name (head ps1) <= name (head ps2))
Michael Hanus's avatar
Michael Hanus committed
870
                              (listPackages repo))
Michael Hanus's avatar
Michael Hanus committed
871

872
873
  -- all categories together with their package names:
  catgroups =
Michael Hanus's avatar
Michael Hanus committed
874
    let pkgid p = name p ++ '-' : showVersionIfCompatible cfg p
Michael Hanus's avatar
Michael Hanus committed
875
        newpkgs = map (filterCompatPkgs cfg) (listPackages repo)
Michael Hanus's avatar
Michael Hanus committed
876
877
878
        catpkgs = concatMap (\p -> map (\c -> (c, pkgid p)) (category p))
                            newpkgs
        nocatps = map pkgid (filter (null . category) newpkgs)
879
880
881
882
883
884
    in map (\cg -> (fst (head cg), map snd cg))
           (groupBy (\ (c1,_) (c2,_) -> c1==c2) (nub $ sortBy (<=) catpkgs)) ++
       if null nocatps then []
                       else [("???", nub $ sortBy (<=) nocatps)]

  renderPkgs pkgs =
Michael Hanus's avatar
Michael Hanus committed
885
    let (colsizes,rows) = packageVersionAsTable cfg pkgs
Michael Hanus's avatar
Michael Hanus committed
886
    in renderTable colsizes rows
887
888

  renderCats catgrps =
Michael Hanus's avatar
Michael Hanus committed
889
    let namelen = foldl max 8 $ map (length . fst) catgrps
890
891
        header = [ ["Category", "Packages"]
                 , ["--------", "--------"]]
Michael Hanus's avatar
Michael Hanus committed
892
        rows   = header ++ map (\ (c,ns) -> [c, unwords ns]) catgrps
Michael Hanus's avatar
Michael Hanus committed
893
    in renderTable [namelen + 2, 78 - namelen] rows
894
  
Michael Hanus's avatar
Michael Hanus committed
895
896
897
898
  renderTable colsizes rows =
    if csv then showCSV (head rows : drop 2 rows)
           else unlines [render (table rows colsizes), cpmInfo, cpmUpdate]

Michael Hanus's avatar
Michael Hanus committed
899
900
901
902
903
904
905
906
--- Returns the first package of a list of packages compatible to the
--- current compiler (according to the given configuration).
--- If there is no compatible package, returns the first one.
filterCompatPkgs :: Config -> [Package] -> Package
filterCompatPkgs cfg pkgs =
  let comppkgs = filter (isCompatibleToCompiler cfg) pkgs
  in if null comppkgs then head pkgs else head comppkgs

Michael Hanus's avatar
Michael Hanus committed
907
908
-- Format a list of packages by showing their names, synopsis, and versions
-- as table rows. Returns also the column sizes.
Michael Hanus's avatar
Michael Hanus committed
909
910
packageVersionAsTable :: Config -> [Package] -> ([Int],[[String]])
packageVersionAsTable cfg pkgs = (colsizes, rows)
Michael Hanus's avatar
Michael Hanus committed
911
 where
Michael Hanus's avatar
Michael Hanus committed
912
  namelen = foldl max 4 $ map (length . name) pkgs
Michael Hanus's avatar
Michael Hanus committed
913
  colsizes = [namelen + 2, 68 - namelen, 10]
Michael Hanus's avatar
Michael Hanus committed
914
915
916
  header  = [ ["Name", "Synopsis", "Version"]
            , ["----", "--------", "-------"]]
  rows    = header ++ map formatPkg pkgs
Michael Hanus's avatar
Michael Hanus committed
917
918
919
  formatPkg p = [name p, synopsis p, showVersionIfCompatible cfg p]

--- Shows the version of a package if it is compatible with the
Michael Hanus's avatar
Michael Hanus committed
920
--- current compiler, otherwise shows the version in brackets.
Michael Hanus's avatar
Michael Hanus committed
921
922
showVersionIfCompatible :: Config -> Package -> String
showVersionIfCompatible cfg p =
Michael Hanus's avatar
Michael Hanus committed
923
924
  let s = showVersion (version p)
  in if isCompatibleToCompiler cfg p then s else '(' : s ++ ")"
Michael Hanus's avatar
Michael Hanus committed
925

Michael Hanus's avatar
Michael Hanus committed
926
927
cpmInfo :: String
cpmInfo = "Use 'cpm info PACKAGE' for more information about a package."
Michael Hanus's avatar
Michael Hanus committed
928

Michael Hanus's avatar
Michael Hanus committed
929
930
cpmUpdate :: String
cpmUpdate = "Use 'cpm update' to download the newest package index."
Michael Hanus's avatar
Michael Hanus committed
931
932


Michael Hanus's avatar
Michael Hanus committed
933
--- Search in all (compiler-compatible) packages in the given repository.
Michael Hanus's avatar
Michael Hanus committed
934
935
936
searchCmd :: SearchOptions -> Config -> Repository -> IO (ErrorLogger ())
searchCmd (SearchOptions q smod sexec) cfg repo =
  putStr rendered >> succeedIO ()
Michael Hanus's avatar
Michael Hanus committed
937
 where
Michael Hanus's avatar
Michael Hanus committed
938
939
940
  results = sortBy (\p1 p2 -> name p1 <= name p2)
                   (map (filterCompatPkgs cfg)
                        (searchPackages repo smod sexec q))
Michael Hanus's avatar
Michael Hanus committed
941
  (colsizes,rows) = packageVersionAsTable cfg results
Michael Hanus's avatar
Michael Hanus committed
942
943
  rendered = unlines $
               if null results
Michael Hanus's avatar
Michael Hanus committed
944
                 then ["No packages found for '" ++ q ++ "'", cpmUpdate]
Michael Hanus's avatar
Michael Hanus committed
945
                 else [ render (table rows colsizes), cpmInfo, cpmUpdate ]
Michael Hanus's avatar
Michael Hanus committed
946

Michael Hanus's avatar
Michael Hanus committed
947
948

--- `upgrade` command.
Michael Hanus's avatar
Michael Hanus committed
949
950
upgrade :: UpgradeOptions -> Config -> Repository -> GlobalCache
        -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
951
952
953
954
upgrade (UpgradeOptions Nothing) cfg repo gc =
  tryFindLocalPackageSpec "." |>= \specDir ->
  cleanCurryPathCache specDir |>
  log Info "Upgrading all packages" |>
Michael Hanus's avatar
Michael Hanus committed
955
956
  upgradeAllPackages cfg repo gc specDir
upgrade (UpgradeOptions (Just pkg)) cfg repo gc =
Michael Hanus's avatar
Michael Hanus committed
957
958
  tryFindLocalPackageSpec "." |>= \specDir ->
  log Info ("Upgrade " ++ pkg) |>
Michael Hanus's avatar
Michael Hanus committed
959
960
961
  upgradeSinglePackage cfg repo gc specDir pkg


Michael Hanus's avatar
Michael Hanus committed
962
--- `link` command.
Michael Hanus's avatar
Michael Hanus committed
963
964
linkCmd :: LinkOptions -> Config -> IO (ErrorLogger ())
linkCmd (LinkOptions src) _ =
Michael Hanus's avatar
Michael Hanus committed
965
966
  tryFindLocalPackageSpec "." |>= \specDir ->
  cleanCurryPathCache specDir |>
Michael Hanus's avatar
Michael Hanus committed
967
  log Info ("Linking '" ++ src ++ "' into local package cache...") |>
Michael Hanus's avatar
Michael Hanus committed
968
969
  linkToLocalCache src specDir

Michael Hanus's avatar
Michael Hanus committed
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
--- `add` command: copy the given package to the repository index
--- and package installation directory so that it is available as
--- any other package.
addCmd :: AddOptions -> Config -> IO (ErrorLogger ())
addCmd (AddOptions pkgdir force) config = do
  dirExists <- doesDirectoryExist pkgdir
  if dirExists
    then loadPackageSpec pkgdir |>= \pkgSpec ->
         (copyPackage pkgSpec >> succeedIO ()) |>
         log Info ("Package in directory '" ++ pkgdir ++
                   "' installed into local repository")
    else log Critical ("Directory '" ++ pkgdir ++ "' does not exist.") |>
         succeedIO ()
 where
  copyPackage pkg = do
    let pkgName          = name pkg
        pkgVersion       = version pkg
        pkgIndexDir      = pkgName </> showVersion pkgVersion
        pkgRepositoryDir = repositoryDir config </> pkgIndexDir
        pkgInstallDir    = packageInstallDir config </> packageId pkg
    exrepodir <- doesDirectoryExist pkgRepositoryDir
    when (exrepodir && not force) $ error $
      "Package repository directory '" ++
      pkgRepositoryDir ++ "' already exists!\n" ++ useForce
    expkgdir <- doesDirectoryExist pkgInstallDir
    when expkgdir $
      if force then removeDirectoryComplete pkgInstallDir
               else error $ "Package installation directory '" ++
                            pkgInstallDir ++ "' already exists!\n" ++ useForce
    infoMessage $ "Create directory: " ++ pkgRepositoryDir
    createDirectoryIfMissing True pkgRepositoryDir
    copyFile (pkgdir </> "package.json") (pkgRepositoryDir </> "package.json")
    copyDirectory pkgdir pkgInstallDir
    updateRepositoryCache config

  useForce = "Use option '-f' or '--force' to overwrite it."

Michael Hanus's avatar
Michael Hanus committed
1007
------------------------------------------------------------------------------
1008
1009
1010
1011
--- `doc` command: run `curry doc` on the modules provided as an argument
--- or, if they are not given, on exported modules (if specified in the
--- package), on the main executable (if specified in the package),
--- or on all source modules of the package.
Michael Hanus's avatar
Michael Hanus committed
1012
docCmd :: DocOptions -> Config -> IO (Repository,GlobalCache)
1013
       -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
1014
docCmd opts cfg getRepoGC =
1015
1016
  tryFindLocalPackageSpec "." |>= \specDir ->
  loadPackageSpec specDir |>= \pkg -> do
Michael Hanus's avatar
Michael Hanus committed
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
  let docdir = maybe "cdoc" id (docDir opts)
  absdocdir <- getAbsolutePath docdir
  createDirectoryIfMissing True absdocdir
  (if docManual opts then genPackageManual opts cfg getRepoGC pkg absdocdir
                     else succeedIO ()) |>
    (if docPrograms opts then genDocForPrograms opts cfg getRepoGC specDir pkg
                         else succeedIO ())

--- Generate manual according to  documentation specification of package.
genPackageManual :: DocOptions -> Config -> IO (Repository,GlobalCache)
                 -> Package -> String -> IO (ErrorLogger ())
genPackageManual _ _ _ pkg outputdir = case documentation pkg of
    Nothing -> succeedIO ()
    Just (PackageDocumentation docdir docmain doccmd) -> do
      let formatcmd = replaceSubString "OUTDIR" outputdir $
                        if null doccmd then formatCmd docmain
                                       else doccmd
      if null formatcmd
        then infoMessage $ "Cannot format documentation file '" ++
                           docmain ++ "' (unknown kind)"
        else do
          debugMessage $ "Executing command: " ++ formatcmd
          inDirectory docdir $ system formatcmd
          let outfile = outputdir </> replaceExtension docmain ".pdf"
          system ("chmod -f 644 " ++ quote outfile) -- make it readable
          infoMessage $ "Package documentation written to '" ++ outfile ++ "'."
      succeedIO ()
 where
  formatCmd docmain
    | ".tex" `isSuffixOf` docmain
    = let formatcmd = "pdflatex -output-directory=\"OUTDIR\" " ++ docmain
      in formatcmd ++ " && " ++ formatcmd
    | ".md" `isSuffixOf` docmain
    = "pandoc " ++ docmain ++
      " -o \"OUTDIR" </> replaceExtension docmain ".pdf" ++ "\""
    | otherwise = ""

--- Replace every occurrence of the first argument by the second argument
--- in a string (third argument).
replaceSubString :: String -> String -> String -> String
replaceSubString sub newsub s = replString s
1058
 where
Michael Hanus's avatar
Michael Hanus committed
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
  sublen = length sub

  replString [] = []
  replString ccs@(c:cs) =
    if take sublen ccs == sub
      then newsub ++ replString (drop sublen ccs)
      else c : replString cs

--- Generate program documentation:
--- run `curry doc` on the modules provided as an argument
--- or, if they are not given, on exported modules (if specified in the
--- package), on the main executable (if specified in the package),
--- or on all source modules of the package.
genDocForPrograms :: DocOptions -> Config -> IO (Repository,GlobalCache)
                  -> String -> Package -> IO (ErrorLogger ())
genDocForPrograms opts cfg getRepoGC specDir pkg = do
  checkCompiler cfg pkg
  let docdir  = maybe "cdoc" id (docDir opts)
      exports = exportedModules pkg
      mainmod = maybe Nothing
                      (\ (PackageExecutable _ emain _) -> Just emain)
                      (executableSpec pkg)
  (docmods,apidoc) <-
     maybe (if null exports
              then maybe (curryModulesInDir (specDir </> "src") >>=
                          \ms -> return (ms,True))
                         (\m -> return ([m],False))
                         mainmod
              else return (exports,True))
           (\ms -> return (ms,True))
           (docModules opts)
  if null docmods
    then putStrLn "No modules to be documented!" >> succeedIO ()
    else
      if apidoc
        then foldEL (\_ -> docModule specDir docdir) () docmods |>
             runDocCmd specDir
                       ([currydoc, "--title", apititle, "--onlyindexhtml",
                         docdir] ++ docmods) |>
             log Info ("Documentation generated in '"++docdir++"'")
        else runDocCmd specDir [currydoc, docdir, head docmods]
 where
  apititle = "\"API Documentation of Package '" ++ name pkg ++ "'\""
Michael Hanus's avatar
Michael Hanus committed
1102

1103
1104
1105
1106
1107
1108
1109
1110
  currydoc = curryExec cfg ++ " doc"

  docModule pkgdir docdir mod =
    runDocCmd pkgdir [currydoc, "--noindexhtml", docdir, mod]

  runDocCmd pkgdir doccmd = do
    let cmd = unwords doccmd
    infoMessage $ "Running CurryDoc: " ++ cmd
Michael Hanus's avatar
Michael Hanus committed
1111
    execWithPkgDir (ExecOptions cmd []) cfg getRepoGC pkgdir
1112

Michael Hanus's avatar
Michael Hanus committed
1113
1114

------------------------------------------------------------------------------
1115
1116
1117
--- `test` command: run `curry check` on the modules provided as an argument
--- or, if they are not provided, on the exported (if specified)
--- or all source modules of the package.
Michael Hanus's avatar
Michael Hanus committed
1118
1119
1120
testCmd :: TestOptions -> Config -> IO (Repository,GlobalCache)
        -> IO (ErrorLogger ())
testCmd opts cfg getRepoGC =
Michael Hanus's avatar
Michael Hanus committed
1121
  tryFindLocalPackageSpec "." |>= \specDir ->
1122
1123
  loadPackageSpec specDir |>= \pkg -> do
    checkCompiler cfg pkg
Michael Hanus's avatar
Michael Hanus committed
1124
1125
    aspecDir <- getAbsolutePath specDir
    mainprogs <- curryModulesInDir (aspecDir </> "src")
1126
    let tests = testsuites pkg mainprogs
Michael Hanus's avatar
Michael Hanus committed
1127
1128
1129
1130
    if null tests
      then putStrLn "No modules to be tested!" >> succeedIO ()
      else foldEL (\_ -> execTest aspecDir) () tests
 where
Michael Hanus's avatar
Michael Hanus committed
1131
1132
  currycheck = curryExec cfg ++ " check"
  
Michael Hanus's avatar
Michael Hanus committed
1133
  execTest apkgdir (PackageTest dir mods ccopts script) = do
1134
1135
    let scriptcmd = "CURRYBIN=" ++ curryExec cfg ++ " && export CURRYBIN && " ++
                    "." </> script ++ if null ccopts then "" else ' ' : ccopts
Michael Hanus's avatar
Michael Hanus committed
1136
1137
1138
1139
1140
1141
        checkcmd  = currycheck ++ if null ccopts then "" else ' ' : ccopts
    unless (null mods) $ putStrLn $
      "Running CurryCheck (" ++ checkcmd ++ ")\n" ++
      "(in directory '" ++ dir ++ "', showing raw output) on modules:\n" ++
      unwords mods ++ "\n"
    unless (null script) $ putStrLn $
1142
      "Executing test script with command:\n" ++ scriptcmd ++ "\n" ++
Michael Hanus's avatar
Michael Hanus committed
1143
      "(in directory '" ++ dir ++ "', showing raw output):\n"
Michael Hanus's avatar
Michael Hanus committed
1144
    let currysubdir = apkgdir </> addCurrySubdir dir
Michael Hanus's avatar
Michael Hanus committed
1145
1146
1147
        testcmd = if not (null mods)
                    then unwords (checkcmd : mods)
                    else scriptcmd
Michael Hanus's avatar
Michael Hanus committed
1148
    debugMessage $ "Removing directory: " ++ currysubdir
Michael Hanus's avatar
Michael Hanus committed
1149
    showExecCmd (unwords ["rm", "-rf", currysubdir])
Michael Hanus's avatar
Michael Hanus committed
1150
    inDirectory (apkgdir </> dir) $
Michael Hanus's avatar
Michael Hanus committed
1151
      execWithPkgDir (ExecOptions testcmd []) cfg getRepoGC apkgdir
Michael Hanus's avatar
Michael Hanus committed
1152
1153
1154
1155
1156
1157

  testsuites spec mainprogs = case testModules opts of
    Nothing -> maybe (let exports = exportedModules spec
                      in if null exports
                           then if null mainprogs
                                  then []
Michael Hanus's avatar
Michael Hanus committed
1158
1159
                                  else [PackageTest "src" mainprogs "" ""]
                           else [PackageTest "src" exports "" ""])
Michael Hanus's avatar
Michael Hanus committed
1160
                     id
Michael Hanus's avatar
Michael Hanus committed
1161
                     (testSuite spec)
Michael Hanus's avatar
Michael Hanus committed
1162
    Just ms -> [PackageTest "src" ms "" ""]
Michael Hanus's avatar
Michael Hanus committed
1163

1164
--- Get the names of all Curry modules contained in a directory.
Michael Hanus's avatar
Michael Hanus committed
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
--- Modules in subdirectories are returned as hierarchical modules.
curryModulesInDir :: String -> IO [String]
curryModulesInDir dir = getModules "" dir
 where
  getModules p d = do
    entries <- getDirectoryContents d
    let realentries = filter (\f -> length f >= 1 && head f /= '.') entries
        newprogs    = filter (\f -> takeExtension f == ".curry") realentries
    subdirs <- mapIO (\e -> doesDirectoryExist (d </> e) >>=
                            \b -> return $ if b then [e] else []) realentries
               >>= return . concat
    subdirentries <- mapIO (\s -> getModules (p ++ s ++ ".") (d </> s)) subdirs
    return $ map ((p ++) . stripCurrySuffix) newprogs ++ concat subdirentries


diff :: DiffOptions -> Config -> Repository -> GlobalCache
     -> IO (ErrorLogger ())
diff opts cfg repo gc =
  tryFindLocalPackageSpec "." |>= \specDir ->
  loadPackageSpec specDir     |>= \localSpec ->
  let localname  = name localSpec
      localv     = version localSpec
      showlocalv = showVersion localv
  in
  getDiffVersion localname |>= \diffv ->
  if diffv == localv
    then failIO $ "Cannot diff identical package versions " ++ showlocalv
    else putStrLn ("Comparing local version " ++ showlocalv ++
                   " and repository version " ++ showVersion diffv ++ ":\n") >>
         diffAPIIfEnabled      specDir localSpec diffv |> 
         diffBehaviorIfEnabled specDir localSpec diffv
 where
  getDiffVersion localname = case diffVersion opts of
1198
    Nothing -> case findLatestVersion cfg repo localname False of
Michael Hanus's avatar
Michael Hanus committed
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
                 Nothing -> failIO $ "No other version of local package '" ++
                                 localname ++ "' found in package repository."
                 Just p  -> succeedIO (version p)
    Just v  -> succeedIO v
 
  diffAPIIfEnabled specDir localSpec diffversion =
    if diffAPI opts
    then (putStrLn "Running API diff...\n" >> succeedIO ()) |>
         APIDiff.compareModulesFromPackageAndDir cfg repo gc specDir
                          (name localSpec) diffversion (diffModules opts) |>=
         \diffResults ->
         let diffOut = APIDiff.showDifferences (map snd diffResults)
                                             (version localSpec) diffversion
         in unless (null diffOut) (putStrLn diffOut >> putStrLn "") >>
            succeedIO ()
    else succeedIO () 

  diffBehaviorIfEnabled specDir localSpec diffversion =
    if diffBehavior opts
      then (putStrLn "Preparing behavior diff...\n" >> succeedIO ()) |>
           BDiff.preparePackageAndDir cfg repo gc specDir (name localSpec)
                                                          diffversion |>=
           \i -> BDiff.diffBehavior cfg repo gc i (diffUseAna opts)
                                    (diffModules opts)
      else succeedIO ()


Michael Hanus's avatar
Michael Hanus committed
1226
exec :: ExecOptions -> Config -> IO (Repository,GlobalCache)
Michael Hanus's avatar
Michael Hanus committed
1227
     -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
1228
1229
exec o cfg getRepoGC =
  tryFindLocalPackageSpec "." |>= execWithPkgDir o cfg getRepoGC
Michael Hanus's avatar
Michael Hanus committed
1230

Michael Hanus's avatar
Michael Hanus committed
1231
execWithPkgDir :: ExecOptions -> Config -> IO (Repository,GlobalCache)
Michael Hanus's avatar
Michael Hanus committed
1232
               -> String -> IO (ErrorLogger ())
Michael Hanus's avatar
Michael Hanus committed
1233
execWithPkgDir o cfg getRepoGC specDir =
Michael Hanus's avatar
Michael Hanus committed
1234
1235
1236
1237
1238
  loadCurryPathFromCache specDir |>=
  maybe (computePackageLoadPath specDir) succeedIO |>= \currypath ->
  let execpath = joinSearchPath (exePath o ++ splitSearchPath currypath)
  in log Debug ("Setting CURRYPATH to " ++ execpath) |>
  do setEnviron "CURRYPATH" execpath
Michael Hanus's avatar
Michael Hanus committed
1239
     ecode <- showExecCmd (exeCommand o)
Michael Hanus's avatar
Michael Hanus committed
1240
1241
1242
1243
1244
     unsetEnviron "CURRYPATH"
     unless (ecode==0) (exitWith ecode)
     succeedIO ()
 where
  computePackageLoadPath pkgdir =
Michael Hanus's avatar
Michael Hanus committed
1245
    getRepoGC >>= \ (repo,gc) ->
Michael Hanus's avatar
Michael Hanus committed
1246
1247
    loadPackageSpec pkgdir |>= \pkg ->
    resolveAndCopyDependenciesForPackage cfg repo gc pkgdir pkg |>= \pkgs ->
Michael Hanus's avatar
Michael Hanus committed
1248
    getAbsolutePath pkgdir >>= \abs -> succeedIO () |>
Michael Hanus's avatar
Michael Hanus committed
1249
1250
    let srcdirs = map (abs </>) (sourceDirsOf pkg)
        currypath = joinSearchPath (srcdirs ++ dependencyPathsSeparate pkgs abs)
Michael Hanus's avatar
Michael Hanus committed
1251
1252
1253
1254
1255
1256
1257
1258
1259
    in saveCurryPathToCache pkgdir currypath >> succeedIO currypath


-- Clean auxiliary files in the current package
cleanPackage :: LogLevel -> IO (ErrorLogger ())
cleanPackage ll =
  tryFindLocalPackageSpec "." |>= \specDir ->
  loadPackageSpec specDir     |>= \pkg ->
  let dotcpm   = specDir </> ".cpm"
Michael Hanus's avatar
Michael Hanus committed
1260
1261
1262
      srcdirs  = map (specDir </>) (sourceDirsOf pkg)
      testdirs = map (specDir </>)
                     (maybe []
Michael Hanus's avatar
Michael Hanus committed
1263
                            (map (\ (PackageTest m _ _ _) -> m))
Michael Hanus's avatar
Michael Hanus committed
1264
                            (testSuite pkg))
Michael Hanus's avatar
Michael Hanus committed
1265
      rmdirs   = nub (dotcpm : map addCurrySubdir (srcdirs ++ testdirs))
Michael Hanus's avatar
Michael Hanus committed
1266
  in log ll ("Removing directories: " ++ unwords rmdirs) |>
Michael Hanus's avatar
Michael Hanus committed
1267
     (showExecCmd (unwords $ ["rm", "-rf"] ++ rmdirs) >> succeedIO ())
Michael Hanus's avatar
Michael Hanus committed
1268
1269

--- Creates a new package by asking some questions.
Michael Hanus's avatar
Michael Hanus committed
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
newPackage :: NewOptions -> IO (ErrorLogger ())
newPackage (NewOptions pname) = do
  exists <- doesDirectoryExist pname
  when exists $ do
    putStrLn $ "There is already a directory with the new project name. " ++
               "I cannot create new project!"
    exitWith 1
  let emptyAuthor   = "YOUR NAME <YOUR EMAIL ADDRESS>"
      emptySynopsis = "PLEASE PROVIDE A ONE-LINE SUMMARY ABOUT THE PACKAGE"
  createDirectory pname
  let pkgSpec = emptyPackage { name            = pname
                             , version         = initialVersion
                             , author          = emptyAuthor
                             , synopsis        = emptySynopsis
                             , category        = ["Programming"]
                             , dependencies    = [] 
Michael Hanus's avatar
Michael Hanus committed
1286
                             , exportedModules = []
Michael Hanus's avatar
Michael Hanus committed
1287
1288
                             , license         = Just "BSD-3-Clause"
                             , licenseFile     = Just "LICENSE"
Michael Hanus's avatar
Michael Hanus committed
1289
                             }
Michael Hanus's avatar
Michael Hanus committed
1290
1291
1292
1293
1294
1295
1296
  writePackageSpec pkgSpec (pname </> "package.json")
  copyFile (packagePath </> "templates" </> "LICENSE") (pname </> "LICENSE")
  createDirectory (pname </> "src")
  let cmain = "Main.curry"
  copyFile (packagePath </> "templates" </> cmain) (pname </> "src" </> cmain)
  writeFile (pname </> "README.md") readme
  putStr $ unlines todo
Michael Hanus's avatar
Michael Hanus committed
1297
1298
  succeedIO ()
 where
Michael Hanus's avatar
Michael Hanus committed
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
  readme = unlines [pname, take (length pname) (repeat '=')]

  todo =
    [ "A new package in the directory '" ++ pname ++ "' has been created!"
    , ""
    , "Please go into this directory and edit the file 'package.json':"
    , "- enter correct values for the fields 'author', 'synopsis', 'category'"
    , "- add dependencies in the field 'dependencies'"
    , "- add further fields (e.g., 'description')"
    , "- review field 'license' (and adapt file 'LICENSE')"
    , ""
    , "Then run 'cpm install' to install all dependencies and"
    , "put your program code in directory 'src'"
    , "(where you find a template file 'Main.curry')"
    , ""
    , "Run the main program with:"
    , "> cpm curry :load Main :eval main :quit"
    ]
Michael Hanus's avatar
Michael Hanus committed
1317
1318
1319
1320
1321

---------------------------------------------------------------------------
-- Caching the current CURRYPATH of a package for faster startup.

--- The name of the cache file in a package directory.
Michael Hanus's avatar
Michael Hanus committed
1322
1323
curryPathCacheFile :: String -> String
curryPathCacheFile pkgdir = pkgdir </> ".cpm" </> "currypath_cache"
Michael Hanus's avatar
Michael Hanus committed
1324
1325
1326
1327
1328
1329

--- Saves package CURRYPATH in local cache file in the given package dir.
saveCurryPathToCache :: String -> String -> IO ()
saveCurryPathToCache pkgdir path = do
  let cpmdir = pkgdir </> ".cpm"
  createDirectoryIfMissing False cpmdir
Michael Hanus's avatar
Michael Hanus committed
1330
  writeFile (curryPathCacheFile pkgdir) (path ++ "\n")
Michael Hanus's avatar
Michael Hanus committed
1331
1332

--- Restores package CURRYPATH from local cache file in the given package dir,
Michael Hanus's avatar
Michael Hanus committed
1333
1334
--- if it is still up-to-date, i.e., it exists and is newer than the package
--- specification.
Michael Hanus's avatar
Michael Hanus committed
1335
1336
loadCurryPathFromCache :: String -> IO (ErrorLogger (Maybe String))
loadCurryPathFromCache pkgdir = do
Michael Hanus's avatar
Michael Hanus committed
1337
  let cachefile = curryPathCacheFile pkgdir
Michael Hanus's avatar
Michael Hanus committed
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
  excache <- doesFileExist cachefile
  if excache
    then do
      cftime <- getModificationTime cachefile
      pftime <- getModificationTime (pkgdir </> "package.json")
      if cftime > pftime
        then do cnt <- safeReadFile cachefile
                let ls = either (const []) lines cnt
                succeedIO $ if null ls then Nothing
                                       else Just (head ls)
        else succeedIO Nothing
    else succeedIO Nothing

Michael Hanus's avatar
Michael Hanus committed
1351
1352
1353
1354
1355
1356
1357
1358
--- Cleans the local cache file for CURRYPATH. This might be necessary
--- for upgrade/install/link commands.
cleanCurryPathCache :: String -> IO (ErrorLogger ())
cleanCurryPathCache pkgdir = do
  let cachefile = curryPathCacheFile pkgdir
  whenFileExists cachefile $ removeFile cachefile
  succeedIO ()

Michael Hanus's avatar
Michael Hanus committed
1359
---------------------------------------------------------------------------