Setup.hs 90 KB
Newer Older
1
{-# LANGUAGE CPP #-}
2
3
-----------------------------------------------------------------------------
-- |
4
-- Module      :  Distribution.Client.Setup
5
6
7
8
9
10
11
12
13
-- Copyright   :  (c) David Himmelstrup 2005
-- License     :  BSD-like
--
-- Maintainer  :  lemmih@gmail.com
-- Stability   :  provisional
-- Portability :  portable
--
--
-----------------------------------------------------------------------------
14
module Distribution.Client.Setup
15
    ( globalCommand, GlobalFlags(..), defaultGlobalFlags, globalRepos
16
    , configureCommand, ConfigFlags(..), filterConfigureFlags
17
18
    , configureExCommand, ConfigExFlags(..), defaultConfigExFlags
                        , configureExOptions
19
    , buildCommand, BuildFlags(..), BuildExFlags(..), SkipAddSourceDepsCheck(..)
20
    , replCommand, testCommand, benchmarkCommand
21
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
22
    , listCommand, ListFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
23
    , updateCommand
ijones's avatar
ijones committed
24
    , upgradeCommand
25
    , uninstallCommand
26
    , infoCommand, InfoFlags(..)
27
    , fetchCommand, FetchFlags(..)
28
    , freezeCommand, FreezeFlags(..)
29
    , getCommand, unpackCommand, GetFlags(..)
30
    , checkCommand
31
    , formatCommand
32
    , uploadCommand, UploadFlags(..)
33
    , reportCommand, ReportFlags(..)
refold's avatar
refold committed
34
    , runCommand
35
    , initCommand, IT.InitFlags(..)
36
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
37
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
38
    , actAsSetupCommand, ActAsSetupFlags(..)
refold's avatar
refold committed
39
    , sandboxCommand, defaultSandboxLocation, SandboxFlags(..)
40
    , execCommand, ExecFlags(..)
41
    , userConfigCommand, UserConfigFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
42
43

    , parsePackageArgs
44
45
46
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
47
    , readRepo
48
49
    ) where

50
import Distribution.Client.Types
51
         ( Username(..), Password(..), Repo(..), RemoteRepo(..), LocalRepo(..) )
52
53
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
54
import Distribution.Client.Dependency.Types
55
         ( AllowNewer(..), PreSolver(..) )
56
57
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
58
59
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
60
61
import Distribution.Utils.NubList
         ( NubList, toNubList, fromNubList)
62

63
import Distribution.Simple.Compiler (PackageDB)
64
65
import Distribution.Simple.Program
         ( defaultProgramConfiguration )
66
67
import Distribution.Simple.Command hiding (boolOpt, boolOpt')
import qualified Distribution.Simple.Command as Command
Duncan Coutts's avatar
Duncan Coutts committed
68
import qualified Distribution.Simple.Setup as Cabal
69
import Distribution.Simple.Setup
70
71
         ( ConfigFlags(..), BuildFlags(..), ReplFlags
         , TestFlags(..), BenchmarkFlags(..)
72
         , SDistFlags(..), HaddockFlags(..)
73
         , readPackageDbList, showPackageDbList
74
         , Flag(..), toFlag, fromFlag, flagToMaybe, flagToList
75
         , optionVerbosity, boolOpt, boolOpt', trueArg, falseArg, optionNumJobs )
76
import Distribution.Simple.InstallDirs
77
78
         ( PathTemplate, InstallDirs(sysconfdir)
         , toPathTemplate, fromPathTemplate )
79
import Distribution.Version
Duncan Coutts's avatar
Duncan Coutts committed
80
         ( Version(Version), anyVersion, thisVersion )
81
import Distribution.Package
82
         ( PackageIdentifier, packageName, packageVersion, Dependency(..) )
83
import Distribution.PackageDescription
84
         ( BuildType(..), RepoKind(..) )
85
import Distribution.Text
86
         ( Text(..), display )
87
import Distribution.ReadE
88
         ( ReadE(..), readP_to_E, succeedReadE )
89
import qualified Distribution.Compat.ReadP as Parse
90
         ( ReadP, readP_to_S, readS_to_P, char, munch1, pfail, sepBy1, (+++) )
91
92
import Distribution.Verbosity
         ( Verbosity, normal )
93
import Distribution.Simple.Utils
94
         ( wrapText, wrapLine )
95

96
97
import Data.Char
         ( isSpace, isAlphaNum )
98
import Data.List
99
         ( intercalate, deleteFirstsBy )
100
import Data.Maybe
101
         ( listToMaybe, maybeToList, fromMaybe )
102
#if !MIN_VERSION_base(4,8,0)
103
104
import Data.Monoid
         ( Monoid(..) )
105
#endif
106
107
108
109
110
111
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
112

113
114
115
116
117
118
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
119
120
121
122
    globalVersion           :: Flag Bool,
    globalNumericVersion    :: Flag Bool,
    globalConfigFile        :: Flag FilePath,
    globalSandboxConfigFile :: Flag FilePath,
123
    globalRemoteRepos       :: NubList RemoteRepo,     -- ^ Available Hackage servers.
124
    globalCacheDir          :: Flag FilePath,
125
    globalLocalRepos        :: NubList FilePath,
126
    globalLogsDir           :: Flag FilePath,
127
    globalWorldFile         :: Flag FilePath,
128
    globalRequireSandbox    :: Flag Bool,
129
130
    globalIgnoreSandbox     :: Flag Bool,
    globalHttpTransport     :: Flag String
131
  }
Duncan Coutts's avatar
Duncan Coutts committed
132

133
134
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
135
136
137
138
    globalVersion           = Flag False,
    globalNumericVersion    = Flag False,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
139
    globalRemoteRepos       = mempty,
140
141
142
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
143
    globalWorldFile         = mempty,
144
    globalRequireSandbox    = Flag False,
145
146
    globalIgnoreSandbox     = Flag False,
    globalHttpTransport     = mempty
147
148
  }

149
150
globalCommand :: [Command action] -> CommandUI GlobalFlags
globalCommand commands = CommandUI {
151
    commandName         = "",
152
153
    commandSynopsis     =
         "Command line interface to the Haskell Cabal infrastructure.",
154
155
156
157
    commandUsage        = \pname ->
         "See http://www.haskell.org/cabal/ for more information.\n"
      ++ "\n"
      ++ "Usage: " ++ pname ++ " [GLOBAL FLAGS] [COMMAND [FLAGS]]\n",
158
    commandDescription  = Just $ \pname ->
159
160
161
      let
        commands' = commands ++ [commandAddAction helpCommandUI undefined]
        cmdDescs = getNormalCommandDescriptions commands'
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
        -- if new commands are added, we want them to appear even if they
        -- are not included in the custom listing below. Thus, we calculate
        -- the `otherCmds` list and append it under the `other` category.
        -- Alternatively, a new testcase could be added that ensures that
        -- the set of commands listed here is equal to the set of commands
        -- that are actually available.
        otherCmds = deleteFirstsBy (==) (map fst cmdDescs)
          [ "help"
          , "update"
          , "install"
          , "fetch"
          , "list"
          , "info"
          , "user-config"
          , "get"
          , "init"
          , "configure"
          , "build"
          , "clean"
          , "run"
          , "repl"
          , "test"
          , "bench"
          , "check"
          , "sdist"
          , "upload"
          , "report"
          , "freeze"
          , "haddock"
          , "hscolour"
          , "copy"
          , "register"
          , "sandbox"
          , "exec"
          ]
197
198
        maxlen    = maximum $ [length name | (name, _) <- cmdDescs]
        align str = str ++ replicate (maxlen - length str) ' '
199
200
201
202
203
204
205
206
207
        startGroup n = " ["++n++"]"
        par          = ""
        addCmd n     = case lookup n cmdDescs of
                         Nothing -> ""
                         Just d -> "  " ++ align n ++ "    " ++ d
        addCmdCustom n d = case lookup n cmdDescs of -- make sure that the
                                                  -- command still exists.
                         Nothing -> ""
                         Just _ -> "  " ++ align n ++ "    " ++ d
208
209
      in
         "Commands:\n"
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
      ++ unlines (
        [ startGroup "global"
        , addCmd "update"
        , addCmd "install"
        , par
        , addCmd "help"
        , addCmd "info"
        , addCmd "list"
        , addCmd "fetch"
        , addCmd "user-config"
        , par
        , startGroup "package"
        , addCmd "get"
        , addCmd "init"
        , par
        , addCmd "configure"
        , addCmd "build"
        , addCmd "clean"
        , par
        , addCmd "run"
        , addCmd "repl"
        , addCmd "test"
        , addCmd "bench"
        , par
        , addCmd "check"
        , addCmd "sdist"
        , addCmd "upload"
        , addCmd "report"
        , par
        , addCmd "freeze"
        , addCmd "haddock"
        , addCmd "hscolour"
        , addCmd "copy"
        , addCmd "register"
        , par
        , startGroup "sandbox"
246
        , addCmd "sandbox"
247
248
249
250
251
        , addCmd "exec"
        , addCmdCustom "repl" "Open interpreter with access to sandbox packages."
        ] ++ if null otherCmds then [] else par
                                           :startGroup "other"
                                           :[addCmd n | n <- otherCmds])
252
253
      ++ "\n"
      ++ "For more information about a command use:\n"
254
255
      ++ "   " ++ pname ++ " COMMAND --help\n"
      ++ "or " ++ pname ++ " help COMMAND\n"
256
      ++ "\n"
257
      ++ "To install Cabal packages from hackage use:\n"
258
259
      ++ "  " ++ pname ++ " install foo [--dry-run]\n"
      ++ "\n"
260
261
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
262
    commandNotes = Nothing,
263
    commandDefaultFlags = mempty,
264
    commandOptions      = \showOrParseArgs ->
265
      (case showOrParseArgs of ShowArgs -> take 7; ParseArgs -> id)
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
      [option ['V'] ["version"]
         "Print version information"
         globalVersion (\v flags -> flags { globalVersion = v })
         trueArg

      ,option [] ["numeric-version"]
         "Print just the version number"
         globalNumericVersion (\v flags -> flags { globalNumericVersion = v })
         trueArg

      ,option [] ["config-file"]
         "Set an alternate location for the config file"
         globalConfigFile (\v flags -> flags { globalConfigFile = v })
         (reqArgFlag "FILE")

281
      ,option [] ["sandbox-config-file"]
282
         "Set an alternate location for the sandbox config file (default: './cabal.sandbox.config')"
283
284
285
         globalConfigFile (\v flags -> flags { globalSandboxConfigFile = v })
         (reqArgFlag "FILE")

286
      ,option [] ["require-sandbox"]
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
287
         "requiring the presence of a sandbox for sandbox-aware commands"
288
289
290
         globalRequireSandbox (\v flags -> flags { globalRequireSandbox = v })
         (boolOpt' ([], ["require-sandbox"]) ([], ["no-require-sandbox"]))

291
292
293
294
295
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

296
      ,option [] ["http-transport"]
297
         "Set a transport for http(s) requests. Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')"
298
299
300
         globalConfigFile (\v flags -> flags { globalHttpTransport = v })
         (reqArgFlag "HttpTransport")

301
302
303
      ,option [] ["remote-repo"]
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
304
         (reqArg' "NAME:URL" (toNubList . maybeToList . readRepo) (map showRepo . fromNubList))
305
306
307
308
309
310
311
312
313

      ,option [] ["remote-repo-cache"]
         "The location where downloads from all remote repos are cached"
         globalCacheDir (\v flags -> flags { globalCacheDir = v })
         (reqArgFlag "DIR")

      ,option [] ["local-repo"]
         "The location of a local repository"
         globalLocalRepos (\v flags -> flags { globalLocalRepos = v })
314
         (reqArg' "DIR" (\x -> toNubList [x]) fromNubList)
315

316
317
318
319
320
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

321
322
323
324
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
325
326
327
328
329
      ]
  }

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
330
331
332
333
334
335
336
337
    globalVersion           = mempty,
    globalNumericVersion    = mempty,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = mempty,
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
338
    globalWorldFile         = mempty,
339
    globalRequireSandbox    = mempty,
340
341
    globalIgnoreSandbox     = mempty,
    globalHttpTransport     = mempty
342
343
  }
  mappend a b = GlobalFlags {
344
345
346
347
348
349
350
351
    globalVersion           = combine globalVersion,
    globalNumericVersion    = combine globalNumericVersion,
    globalConfigFile        = combine globalConfigFile,
    globalSandboxConfigFile = combine globalConfigFile,
    globalRemoteRepos       = combine globalRemoteRepos,
    globalCacheDir          = combine globalCacheDir,
    globalLocalRepos        = combine globalLocalRepos,
    globalLogsDir           = combine globalLogsDir,
352
    globalWorldFile         = combine globalWorldFile,
353
    globalRequireSandbox    = combine globalRequireSandbox,
354
355
    globalIgnoreSandbox     = combine globalIgnoreSandbox,
    globalHttpTransport     = combine globalHttpTransport
Duncan Coutts's avatar
Duncan Coutts committed
356
  }
357
358
359
360
361
362
363
    where combine field = field a `mappend` field b

globalRepos :: GlobalFlags -> [Repo]
globalRepos globalFlags = remoteRepos ++ localRepos
  where
    remoteRepos =
      [ Repo (Left remote) cacheDir
364
      | remote <- fromNubList $ globalRemoteRepos globalFlags
365
366
367
368
      , let cacheDir = fromFlag (globalCacheDir globalFlags)
                   </> remoteRepoName remote ]
    localRepos =
      [ Repo (Right LocalRepo) local
369
      | local <- fromNubList $ globalLocalRepos globalFlags ]
370
371
372
373

-- ------------------------------------------------------------
-- * Config flags
-- ------------------------------------------------------------
Duncan Coutts's avatar
Duncan Coutts committed
374

375
configureCommand :: CommandUI ConfigFlags
376
377
configureCommand = c
  { commandDefaultFlags = mempty
378
379
380
  , commandNotes = Just $ \pname -> (case commandNotes c of
         Nothing -> ""
         Just n  -> n pname ++ "\n")
381
382
383
384
385
386
       ++ "Examples:\n"
       ++ "  " ++ pname ++ " configure\n"
       ++ "    Configure with defaults;\n"
       ++ "  " ++ pname ++ " configure --enable-tests -fcustomflag\n"
       ++ "    Configure building package including tests,\n"
       ++ "    with some package-specific flag.\n"
Duncan Coutts's avatar
Duncan Coutts committed
387
  }
388
389
 where
  c = Cabal.configureCommand defaultProgramConfiguration
Duncan Coutts's avatar
Duncan Coutts committed
390

391
392
393
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

394
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
395
filterConfigureFlags flags cabalLibVersion
396
  | cabalLibVersion >= Version [1,23,0] [] = flags_latest
397
  -- ^ NB: we expect the latest version to be the most common case.
398
399
400
  | cabalLibVersion <  Version [1,3,10] [] = flags_1_3_10
  | cabalLibVersion <  Version [1,10,0] [] = flags_1_10_0
  | cabalLibVersion <  Version [1,14,0] [] = flags_1_14_0
401
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
402
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
403
  | cabalLibVersion <  Version [1,19,2] [] = flags_1_19_1
404
  | cabalLibVersion <  Version [1,21,1] [] = flags_1_20_0
405
  | cabalLibVersion <  Version [1,22,0] [] = flags_1_21_0
406
  | cabalLibVersion <  Version [1,23,0] [] = flags_1_22_0
407
  | otherwise = flags_latest
408
  where
409
    -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
410
411
    flags_latest = flags        { configConstraints = [] }

412
413
414
415
    -- Cabal < 1.23 doesn't know about '--profiling-detail'.
    flags_1_22_0 = flags_latest { configProfDetail    = NoFlag
                                , configProfLibDetail = NoFlag }

416
    -- Cabal < 1.22 doesn't know about '--disable-debug-info'.
417
    flags_1_21_0 = flags_1_22_0 { configDebugInfo = NoFlag }
418

419
    -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
420
421
    -- Cabal < 1.21.1 doesn't know about 'enable-profiling'
    flags_1_20_0 =
422
      flags_1_21_0 { configRelocatable = NoFlag
423
424
425
426
                   , configProf = NoFlag
                   , configProfExe = configProf flags
                   , configProfLib =
                     mappend (configProf flags) (configProfLib flags)
427
428
                   , configCoverage = NoFlag
                   , configLibCoverage = configCoverage flags
429
                   }
430
431
432
433
    -- Cabal < 1.19.2 doesn't know about '--exact-configuration' and
    -- '--enable-library-stripping'.
    flags_1_19_1 = flags_1_20_0 { configExactConfiguration = NoFlag
                                , configStripLibs = NoFlag }
434
435
436
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
    flags_1_19_0 = flags_1_19_1 { configDependencies = []
                                , configConstraints  = configConstraints flags }
437
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
438
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = toNubList []
439
440
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
441
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
442
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
443
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
444
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
445
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
446
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
447

448
449
450
451
452
453
454
455
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
456
    configExConstraints:: [UserConstraint],
457
    configPreferences  :: [Dependency],
458
459
    configSolver       :: Flag PreSolver,
    configAllowNewer   :: Flag AllowNewer
460
461
462
  }

defaultConfigExFlags :: ConfigExFlags
463
464
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver
                              , configAllowNewer = Flag AllowNewerNone }
465
466
467
468
469

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
470
         liftOptions fst setFst
471
         (filter ((`notElem` ["constraint", "dependency", "exact-configuration"])
472
                  . optionName) $ configureOptions  showOrParseArgs)
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
      ++ liftOptions snd setSnd (configureExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

configureExOptions ::  ShowOrParseArgs -> [OptionField ConfigExFlags]
configureExOptions _showOrParseArgs =
  [ option [] ["cabal-lib-version"]
      ("Select which version of the Cabal lib to use to build packages "
      ++ "(useful for testing).")
      configCabalVersion (\v flags -> flags { configCabalVersion = v })
      (reqArg "VERSION" (readP_to_E ("Cannot parse cabal lib version: "++)
                                    (fmap toFlag parse))
                        (map display . flagToList))
488
489
490
491
492
493
  , option [] ["constraint"]
      "Specify constraints on a package (version, installed/source, flags)"
      configExConstraints (\v flags -> flags { configExConstraints = v })
      (reqArg "CONSTRAINT"
              (fmap (\x -> [x]) (ReadE readUserConstraint))
              (map display))
494
495
496
497

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
498
499
500
501
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
502
503

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
504
505

  , option [] ["allow-newer"]
cheecheeo's avatar
cheecheeo committed
506
    ("Ignore upper bounds in all dependencies or " ++ allowNewerArgument)
507
    configAllowNewer (\v flags -> flags { configAllowNewer = v})
cheecheeo's avatar
cheecheeo committed
508
    (optArg allowNewerArgument
509
510
511
     (fmap Flag allowNewerParser) (Flag AllowNewerAll)
     allowNewerPrinter)

512
  ]
cheecheeo's avatar
cheecheeo committed
513
  where allowNewerArgument = "DEPS"
514
515
516
517

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
518
    configExConstraints= mempty,
519
    configPreferences  = mempty,
520
521
    configSolver       = mempty,
    configAllowNewer   = mempty
522
523
524
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
525
    configExConstraints= combine configExConstraints,
526
    configPreferences  = combine configPreferences,
527
528
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
529
530
531
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
532
533
534
535
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

536
537
538
539
540
541
542
543
544
545
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
546
  option [] ["only"]
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
  "Don't reinstall add-source dependencies (sandbox-only)"
  buildOnly (\v flags -> flags { buildOnly = v })
  (noArg (Flag SkipAddSourceDepsCheck))

  : []

buildCommand :: CommandUI (BuildFlags, BuildExFlags)
buildCommand = parent {
    commandDefaultFlags = (commandDefaultFlags parent, mempty),
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (commandOptions parent showOrParseArgs)
                          ++
                          liftOptions snd setSnd (buildExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

    parent = Cabal.buildCommand defaultProgramConfiguration

instance Monoid BuildExFlags where
  mempty = BuildExFlags {
    buildOnly    = mempty
  }
  mappend a b = BuildExFlags {
    buildOnly    = combine buildOnly
  }
    where combine field = field a `mappend` field b

-- ------------------------------------------------------------
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
-- * Repl command
-- ------------------------------------------------------------

replCommand :: CommandUI (ReplFlags, BuildExFlags)
replCommand = parent {
    commandDefaultFlags = (commandDefaultFlags parent, mempty),
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (commandOptions parent showOrParseArgs)
                          ++
                          liftOptions snd setSnd (buildExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

    parent = Cabal.replCommand defaultProgramConfiguration

596
597
598
599
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

600
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
601
testCommand = parent {
602
603
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
604
  commandOptions      =
605
    \showOrParseArgs -> liftOptions get1 set1
606
607
                        (commandOptions parent showOrParseArgs)
                        ++
608
609
610
611
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
612
613
  }
  where
614
615
616
    get1 (a,_,_) = a; set1 a (_,b,c) = (a,b,c)
    get2 (_,b,_) = b; set2 b (a,_,c) = (a,b,c)
    get3 (_,_,c) = c; set3 c (a,b,_) = (a,b,c)
617

618
619
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
620
621
622
623
624

-- ------------------------------------------------------------
-- * Bench command
-- ------------------------------------------------------------

625
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
626
benchmarkCommand = parent {
627
628
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
629
  commandOptions      =
630
    \showOrParseArgs -> liftOptions get1 set1
631
632
                        (commandOptions parent showOrParseArgs)
                        ++
633
634
635
636
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
637
  }
638
  where
639
640
641
    get1 (a,_,_) = a; set1 a (_,b,c) = (a,b,c)
    get2 (_,b,_) = b; set2 b (a,_,c) = (a,b,c)
    get3 (_,_,c) = c; set3 c (a,b,_) = (a,b,c)
642

643
644
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
645

646
-- ------------------------------------------------------------
647
-- * Fetch command
648
-- ------------------------------------------------------------
649

650
651
652
653
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
654
      fetchSolver           :: Flag PreSolver,
655
656
657
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
658
      fetchShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
659
      fetchStrongFlags      :: Flag Bool,
660
661
662
663
664
665
666
667
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
668
669
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
670
    fetchReorderGoals     = Flag False,
671
    fetchIndependentGoals = Flag False,
672
    fetchShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
673
    fetchStrongFlags      = Flag False,
674
675
676
677
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
678
679
fetchCommand = CommandUI {
    commandName         = "fetch",
680
    commandSynopsis     = "Downloads packages for later installation.",
681
682
683
684
685
    commandUsage        = usageAlternatives "fetch" [ "[FLAGS] PACKAGES"
                                                    ],
    commandDescription  = Just $ \_ ->
          "Note that it currently is not possible to fetch the dependencies for a\n"
       ++ "package in the current directory.\n",
686
    commandNotes        = Nothing,
687
    commandDefaultFlags = defaultFetchFlags,
688
    commandOptions      = \ showOrParseArgs -> [
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
         optionVerbosity fetchVerbosity (\v flags -> flags { fetchVerbosity = v })

--     , option "o" ["output"]
--         "Put the package(s) somewhere specific rather than the usual cache."
--         fetchOutput (\v flags -> flags { fetchOutput = v })
--         (reqArgFlag "PATH")

       , option [] ["dependencies", "deps"]
           "Resolve and fetch dependencies (default)"
           fetchDeps (\v flags -> flags { fetchDeps = v })
           trueArg

       , option [] ["no-dependencies", "no-deps"]
           "Ignore dependencies"
           fetchDeps (\v flags -> flags { fetchDeps = v })
           falseArg

       , option [] ["dry-run"]
           "Do not install anything, only print what would be installed."
           fetchDryRun (\v flags -> flags { fetchDryRun = v })
           trueArg
710
711
712
713

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
714
715
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
716
717
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
718
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
719
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
720

Duncan Coutts's avatar
Duncan Coutts committed
721
722
  }

723
724
725
726
727
728
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
729
730
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
731
732
733
734
735
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
736
      freezeStrongFlags      :: Flag Bool,
737
738
739
740
741
742
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
743
744
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
745
746
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
747
    freezeReorderGoals     = Flag False,
748
749
    freezeIndependentGoals = Flag False,
    freezeShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
750
    freezeStrongFlags      = Flag False,
751
752
753
754
755
756
757
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
758
759
760
761
762
763
764
765
    commandDescription  = Just $ \_ -> wrapText $
         "Calculates a valid set of dependencies and their exact versions. "
      ++ "If successful, saves the result to the file `cabal.config`.\n"
      ++ "\n"
      ++ "The package versions specified in `cabal.config` will be used for "
      ++ "any future installs.\n"
      ++ "\n"
      ++ "An existing `cabal.config` is ignored and overwritten.\n",
766
    commandNotes        = Nothing,
767
    commandUsage        = usageFlags "freeze",
768
769
770
771
772
773
774
775
776
    commandDefaultFlags = defaultFreezeFlags,
    commandOptions      = \ showOrParseArgs -> [
         optionVerbosity freezeVerbosity (\v flags -> flags { freezeVerbosity = v })

       , option [] ["dry-run"]
           "Do not freeze anything, only print what would be frozen"
           freezeDryRun (\v flags -> flags { freezeDryRun = v })
           trueArg

777
778
779
780
781
782
783
784
785
786
       , option [] ["tests"]
           "freezing of the dependencies of any tests suites in the package description file."
           freezeTests (\v flags -> flags { freezeTests = v })
           (boolOpt [] [])

       , option [] ["benchmarks"]
           "freezing of the dependencies of any benchmarks suites in the package description file."
           freezeBenchmarks (\v flags -> flags { freezeBenchmarks = v })
           (boolOpt [] [])

787
788
789
790
791
792
793
794
       ] ++

       optionSolver      freezeSolver           (\v flags -> flags { freezeSolver           = v }) :
       optionSolverFlags showOrParseArgs
                         freezeMaxBackjumps     (\v flags -> flags { freezeMaxBackjumps     = v })
                         freezeReorderGoals     (\v flags -> flags { freezeReorderGoals     = v })
                         freezeIndependentGoals (\v flags -> flags { freezeIndependentGoals = v })
                         freezeShadowPkgs       (\v flags -> flags { freezeShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
795
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
796
797
798

  }

799
800
801
802
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

803
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
804
805
updateCommand = CommandUI {
    commandName         = "update",
806
    commandSynopsis     = "Updates list of known packages.",
807
808
809
    commandDescription  = Just $ \_ ->
      "For all known remote repositories, download the package list.\n",
    commandNotes        = Just $ \_ ->
810
811
812
      relevantConfigValuesText ["remote-repo"
                               ,"remote-repo-cache"
                               ,"local-repo"],
refold's avatar
refold committed
813
    commandUsage        = usageFlags "update",
814
    commandDefaultFlags = toFlag normal,
815
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
816
817
  }

818
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
819
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
820
    commandName         = "upgrade",
821
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
822
    commandDescription  = Nothing,
refold's avatar
refold committed
823
    commandUsage        = usageFlagsOrPackages "upgrade",
824
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
825
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
826
827
  }

Duncan Coutts's avatar
Duncan Coutts committed
828
829
830
831
832
833
834
835
836
837
838
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

839
840
841
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
842
    commandSynopsis     = "Check the package for common mistakes.",
843
844
845
846
847
848
    commandDescription  = Just $ \_ -> wrapText $
         "Expects a .cabal package file in the current directory.\n"
      ++ "\n"
      ++ "The checks correspond to the requirements to packages on Hackage. "
      ++ "If no errors and warnings are reported, Hackage will accept this "
      ++ "package.\n",
849
    commandNotes        = Nothing,
850
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
851
    commandDefaultFlags = toFlag normal,
852
    commandOptions      = \_ -> []
853
854
  }

855
856
857
858
859
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
860
    commandNotes        = Nothing,
861
    commandUsage        = usageAlternatives "format" ["[FILE]"],
862
863
864
865
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

866
867
868
869
870
871
872
873
874
875
876
uninstallCommand  :: CommandUI (Flag Verbosity)
uninstallCommand = CommandUI {
    commandName         = "uninstall",
    commandSynopsis     = "Warn about 'uninstall' not being implemented.",
    commandDescription  = Nothing,
    commandNotes        = Nothing,
    commandUsage        = usageAlternatives "uninstall" ["PACKAGES"],
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

877
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
878
879
runCommand = CommandUI {
    commandName         = "run",
880
    commandSynopsis     = "Builds and runs an executable.",
881
    commandDescription  = Just $ \pname -> wrapText $
882
883
         "Builds and then runs the specified executable. If no executable is "
      ++ "specified, but the package contains just one executable, that one "
884
885
886
887
      ++ "is built and executed.\n"
      ++ "\n"
      ++ "Use `" ++ pname ++ " test --show-details=streaming` to run a "
      ++ "test-suite and get its full output.\n",
888
889
890
891
    commandNotes        = Just $ \pname ->
          "Examples:\n"
       ++ "  " ++ pname ++ " run\n"
       ++ "    Run the only executable in the current package;\n"
892
893
       ++ "  " ++ pname ++ " run foo -- --fooflag\n"
       ++ "    Works similar to `./foo --fooflag`.\n",
894
895
    commandUsage        = usageAlternatives "run"
        ["[FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]"],
refold's avatar
refold committed
896
    commandDefaultFlags = mempty,
897
898
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
899
                          (commandOptions parent showOrParseArgs)
900
901
902
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
903
904
  }
  where
905
906
907
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

908
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
909

910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
-- ------------------------------------------------------------
-- * Report flags
-- ------------------------------------------------------------

data ReportFlags = ReportFlags {
    reportUsername  :: Flag Username,
    reportPassword  :: Flag Password,
    reportVerbosity :: Flag Verbosity
  }

defaultReportFlags :: ReportFlags
defaultReportFlags = ReportFlags {
    reportUsername  = mempty,
    reportPassword  = mempty,
    reportVerbosity = toFlag normal
  }

reportCommand :: CommandUI ReportFlags
928
929
930
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
931
932
    commandDescription  = Nothing,
    commandNotes        = Just $ \_ ->
933
         "You can store your Hackage login in the ~/.cabal/config file\n",
934
    commandUsage        = usageAlternatives "report" ["[FLAGS]"],
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
    commandDefaultFlags = defaultReportFlags,
    commandOptions      = \_ ->
      [optionVerbosity reportVerbosity (\v flags -> flags { reportVerbosity = v })

      ,option ['u'] ["username"]
        "Hackage username."
        reportUsername (\v flags -> flags { reportUsername = v })
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))

      ,option ['p'] ["password"]
        "Hackage password."
        reportPassword (\v flags -> flags { reportPassword = v })
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
      ]
951
952
  }

953
954
955
956
957
958
959
960
961
962
963
964
965
instance Monoid ReportFlags where
  mempty = ReportFlags {
    reportUsername  = mempty,
    reportPassword  = mempty,
    reportVerbosity = mempty
  }
  mappend a b = ReportFlags {
    reportUsername  = combine reportUsername,
    reportPassword  = combine reportPassword,
    reportVerbosity = combine reportVerbosity
  }
    where combine field = field a `mappend` field b

966
-- ------------------------------------------------------------
967
-- * Get flags
968
969
-- ------------------------------------------------------------

970
971
972
973
974
975
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
976

977
978
979
980
981
982
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
983
984
   }

985
986
987
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
988
989
    commandSynopsis     = "Download/Extract a package's source code (repository).",
    commandDescription  = Just $ \_ -> wrapText $
990
991
992
993
          "Creates a local copy of a package's source code. By default it gets "
       ++ "the source\ntarball and unpacks it in a local subdirectory. "
       ++ "Alternatively, with -s it will\nget the code from the source "
       ++ "repository specified by the package.\n",
994
995
996
997
    commandNotes        = Just $ \pname ->
          "Examples:\n"
       ++ "  " ++ pname ++ " get hlint\n"
       ++ "    Download the latest stable version of hlint;\n"
998
       ++ "  " ++ pname ++ " get lens --source-repository=head\n"
999
       ++ "    Download the source repository (i.e. git clone from github).\n",
1000
    commandUsage        = usagePackages "get",