Setup.hs 34.4 KB
Newer Older
1
2
-----------------------------------------------------------------------------
-- |
3
-- Module      :  Distribution.Client.Setup
4
5
6
7
8
9
10
11
12
-- Copyright   :  (c) David Himmelstrup 2005
-- License     :  BSD-like
--
-- Maintainer  :  lemmih@gmail.com
-- Stability   :  provisional
-- Portability :  portable
--
--
-----------------------------------------------------------------------------
13
module Distribution.Client.Setup
14
    ( globalCommand, GlobalFlags(..), globalRepos
15
    , configureCommand, ConfigFlags(..), filterConfigureFlags
16
17
    , configureExCommand, ConfigExFlags(..), defaultConfigExFlags
                        , configureExOptions
18
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
19
    , listCommand, ListFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
20
    , updateCommand
ijones's avatar
ijones committed
21
    , upgradeCommand
22
    , infoCommand, InfoFlags(..)
23
    , fetchCommand, FetchFlags(..)
24
    , checkCommand
25
    , uploadCommand, UploadFlags(..)
26
    , reportCommand
27
    , unpackCommand, UnpackFlags(..)
28
    , initCommand, IT.InitFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
29
30

    , parsePackageArgs
31
32
33
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
34
35
    ) where

36
import Distribution.Client.Types
37
         ( Username(..), Password(..), Repo(..), RemoteRepo(..), LocalRepo(..) )
38
39
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
40
41
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
42
43
44

import Distribution.Simple.Program
         ( defaultProgramConfiguration )
45
46
import Distribution.Simple.Command hiding (boolOpt)
import qualified Distribution.Simple.Command as Command
Duncan Coutts's avatar
Duncan Coutts committed
47
import qualified Distribution.Simple.Setup as Cabal
48
49
50
         ( configureCommand )
import Distribution.Simple.Setup
         ( ConfigFlags(..) )
51
import Distribution.Simple.Setup
Duncan Coutts's avatar
Duncan Coutts committed
52
         ( Flag(..), toFlag, fromFlag, flagToList, flagToMaybe
53
         , optionVerbosity, trueArg, falseArg )
54
55
import Distribution.Simple.InstallDirs
         ( PathTemplate, toPathTemplate, fromPathTemplate )
56
import Distribution.Version
Duncan Coutts's avatar
Duncan Coutts committed
57
         ( Version(Version), anyVersion, thisVersion )
58
import Distribution.Package
59
         ( PackageIdentifier, packageName, packageVersion, Dependency(..) )
60
61
62
import Distribution.Text
         ( Text(parse), display )
import Distribution.ReadE
63
64
65
         ( readP_to_E, succeedReadE )
import qualified Distribution.Compat.ReadP as Parse
         ( ReadP, readP_to_S, char, munch1, pfail, (+++) )
66
67
import Distribution.Verbosity
         ( Verbosity, normal )
68
69
import Distribution.Simple.Utils
         ( wrapText )
70

71
72
73
import Data.Char
         ( isSpace, isAlphaNum )
import Data.Maybe
74
         ( listToMaybe, maybeToList, fromMaybe )
75
76
77
78
79
80
81
82
import Data.Monoid
         ( Monoid(..) )
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
83

84
85
86
87
88
89
90
91
92
93
94
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
    globalVersion        :: Flag Bool,
    globalNumericVersion :: Flag Bool,
    globalConfigFile     :: Flag FilePath,
    globalRemoteRepos    :: [RemoteRepo],     -- ^Available Hackage servers.
    globalCacheDir       :: Flag FilePath,
95
    globalLocalRepos     :: [FilePath],
96
    globalLogsDir        :: Flag FilePath,
97
    globalWorldFile      :: Flag FilePath
98
  }
Duncan Coutts's avatar
Duncan Coutts committed
99

100
101
102
103
104
105
106
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
    globalVersion        = Flag False,
    globalNumericVersion = Flag False,
    globalConfigFile     = mempty,
    globalRemoteRepos    = [],
    globalCacheDir       = mempty,
107
    globalLocalRepos     = mempty,
108
    globalLogsDir        = mempty,
109
    globalWorldFile      = mempty
110
111
112
113
114
115
  }

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
116
117
118
119
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
120
    commandDescription  = Just $ \pname ->
121
122
123
124
125
126
         "For more information about a command use:\n"
      ++ "  " ++ pname ++ " COMMAND --help\n\n"
      ++ "To install Cabal packages from hackage use:\n"
      ++ "  " ++ pname ++ " install foo [--dry-run]\n\n"
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
    commandDefaultFlags = defaultGlobalFlags,
    commandOptions      = \showOrParseArgs ->
      (case showOrParseArgs of ShowArgs -> take 2; ParseArgs -> id)
      [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")

      ,option [] ["remote-repo"]
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
         (reqArg' "NAME:URL" (maybeToList . readRepo) (map showRepo))

      ,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 })
         (reqArg' "DIR" (\x -> [x]) id)
159

160
161
162
163
164
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

165
166
167
168
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
169
170
171
172
173
174
175
176
177
178
      ]
  }

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
    globalVersion        = mempty,
    globalNumericVersion = mempty,
    globalConfigFile     = mempty,
    globalRemoteRepos    = mempty,
    globalCacheDir       = mempty,
179
    globalLocalRepos     = mempty,
180
    globalLogsDir        = mempty,
181
    globalWorldFile      = mempty
182
183
184
185
186
187
188
  }
  mappend a b = GlobalFlags {
    globalVersion        = combine globalVersion,
    globalNumericVersion = combine globalNumericVersion,
    globalConfigFile     = combine globalConfigFile,
    globalRemoteRepos    = combine globalRemoteRepos,
    globalCacheDir       = combine globalCacheDir,
189
    globalLocalRepos     = combine globalLocalRepos,
190
    globalLogsDir        = combine globalLogsDir,
191
    globalWorldFile      = combine globalWorldFile
Duncan Coutts's avatar
Duncan Coutts committed
192
  }
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
    where combine field = field a `mappend` field b

globalRepos :: GlobalFlags -> [Repo]
globalRepos globalFlags = remoteRepos ++ localRepos
  where
    remoteRepos =
      [ Repo (Left remote) cacheDir
      | remote <- globalRemoteRepos globalFlags
      , let cacheDir = fromFlag (globalCacheDir globalFlags)
                   </> remoteRepoName remote ]
    localRepos =
      [ Repo (Right LocalRepo) local
      | local <- globalLocalRepos globalFlags ]

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

211
configureCommand :: CommandUI ConfigFlags
212
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
213
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
214
215
  }

216
217
218
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

219
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
220
221
222
filterConfigureFlags flags cabalLibVersion
  | cabalLibVersion >= Version [1,3,10] [] = flags
    -- older Cabal does not grok the constraints flag:
223
  | otherwise = flags { configConstraints = [] }
224

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
    configPreferences  :: [Dependency]
  }

defaultConfigExFlags :: ConfigExFlags
defaultConfigExFlags = mempty

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
         liftOptions fst setFst (configureOptions   showOrParseArgs)
      ++ 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))

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

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
    configPreferences  = mempty
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
    configPreferences  = combine configPreferences
  }
    where combine field = field a `mappend` field b

280
-- ------------------------------------------------------------
281
-- * Fetch command
282
-- ------------------------------------------------------------
283

284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
300
301
fetchCommand = CommandUI {
    commandName         = "fetch",
302
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
303
304
    commandDescription  = Nothing,
    commandUsage        = usagePackages "fetch",
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
    commandDefaultFlags = defaultFetchFlags,
    commandOptions      = \_ -> [
         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
       ]
Duncan Coutts's avatar
Duncan Coutts committed
329
330
  }

331
332
333
334
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

335
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
336
337
338
339
340
updateCommand = CommandUI {
    commandName         = "update",
    commandSynopsis     = "Updates list of known packages",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "update",
341
    commandDefaultFlags = toFlag normal,
342
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
343
344
  }

345
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags)
346
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
347
    commandName         = "upgrade",
348
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
349
    commandDescription  = Nothing,
350
    commandUsage        = usagePackages "upgrade",
351
    commandDefaultFlags = (mempty, mempty, mempty),
352
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
353
354
  }

Duncan Coutts's avatar
Duncan Coutts committed
355
356
357
358
359
360
361
362
363
364
365
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

366
367
368
369
370
371
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
    commandSynopsis     = "Check the package for common mistakes",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
372
    commandDefaultFlags = toFlag normal,
373
    commandOptions      = \_ -> []
374
375
376
377
378
379
380
381
382
  }

reportCommand :: CommandUI (Flag Verbosity)
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " report\n",
    commandDefaultFlags = toFlag normal,
383
    commandOptions      = \_ -> [optionVerbosity id const]
384
385
  }

386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
-- ------------------------------------------------------------
-- * Unpack flags
-- ------------------------------------------------------------

data UnpackFlags = UnpackFlags {
      unpackDestDir :: Flag FilePath,
      unpackVerbosity :: Flag Verbosity
    }

defaultUnpackFlags :: UnpackFlags
defaultUnpackFlags = UnpackFlags {
    unpackDestDir = mempty,
    unpackVerbosity = toFlag normal
   }

unpackCommand :: CommandUI UnpackFlags
unpackCommand = CommandUI {
    commandName         = "unpack",
    commandSynopsis     = "Unpacks packages for user inspection.",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "unpack",
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
        optionVerbosity unpackVerbosity (\v flags -> flags { unpackVerbosity = v })

       ,option "d" ["destdir"]
         "where to unpack the packages, defaults to the current directory."
         unpackDestDir (\v flags -> flags { unpackDestDir = v })
         (reqArgFlag "PATH")
       ]
  }

instance Monoid UnpackFlags where
  mempty = defaultUnpackFlags
  mappend a b = UnpackFlags {
     unpackDestDir = combine unpackDestDir
    ,unpackVerbosity = combine unpackVerbosity
  }
    where combine field = field a `mappend` field b

426
427
428
429
430
431
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
432
    listSimpleOutput :: Flag Bool,
433
434
435
436
437
438
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
439
    listSimpleOutput = Flag False,
440
441
442
443
444
445
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
446
    commandSynopsis     = "List packages matching a search string.",
447
448
    commandDescription  = Nothing,
    commandUsage        = usagePackages "list",
449
    commandDefaultFlags = defaultListFlags,
450
    commandOptions      = \_ -> [
451
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
452

453
        , option [] ["installed"]
454
455
456
457
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

458
459
460
461
462
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

463
464
465
466
467
468
469
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
470
    listSimpleOutput = combine listSimpleOutput,
471
472
473
474
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

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
504
505
506
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
    infoVerbosity :: Flag Verbosity
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
    infoVerbosity = toFlag normal
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "info",
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
        ]
  }

instance Monoid InfoFlags where
  mempty = defaultInfoFlags
  mappend a b = InfoFlags {
    infoVerbosity = combine infoVerbosity
  }
    where combine field = field a `mappend` field b

507
508
509
510
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

511
512
-- | Install takes the same flags as configure along with a few extras.
--
513
data InstallFlags = InstallFlags {
514
    installDocumentation:: Flag Bool,
515
    installHaddockIndex :: Flag PathTemplate,
516
    installDryRun       :: Flag Bool,
517
    installReinstall    :: Flag Bool,
518
    installUpgradeDeps  :: Flag Bool,
519
    installOnly         :: Flag Bool,
520
    installOnlyDeps     :: Flag Bool,
521
    installRootCmd      :: Flag String,
522
523
524
    installSummaryFile  :: [PathTemplate],
    installLogFile      :: Flag PathTemplate,
    installBuildReports :: Flag ReportLevel,
525
526
    installSymlinkBinDir:: Flag FilePath,
    installOneShot      :: Flag Bool
527
528
529
530
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
531
    installDocumentation= Flag False,
532
    installHaddockIndex = Flag docIndexFile,
533
    installDryRun       = Flag False,
534
    installReinstall    = Flag False,
535
    installUpgradeDeps  = Flag False,
536
    installOnly         = Flag False,
537
    installOnlyDeps     = Flag False,
538
    installRootCmd      = mempty,
539
    installSummaryFile  = mempty,
540
    installLogFile      = mempty,
541
    installBuildReports = Flag NoReports,
542
543
    installSymlinkBinDir= mempty,
    installOneShot      = Flag False
544
  }
545
546
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
547

548
549
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags)
installCommand = CommandUI {
550
551
552
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
  commandUsage        = usagePackages "install",
553
554
555
556
557
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
558
     ++ "Examples:\n"
559
560
561
562
563
564
565
566
     ++ "  " ++ pname ++ " install                 "
     ++ "    Package in the current directory\n"
     ++ "  " ++ pname ++ " install foo             "
     ++ "    Package from the hackage server\n"
     ++ "  " ++ pname ++ " install foo-1.0         "
     ++ "    Specific version of a package\n"
     ++ "  " ++ pname ++ " install 'foo < 2'       "
     ++ "    Constrained package version\n",
567
  commandDefaultFlags = (mempty, mempty, mempty),
568
  commandOptions      = \showOrParseArgs ->
569
570
571
       liftOptions get1 set1 (configureOptions   showOrParseArgs)
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
572
  }
573
574
575
576
  where
    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)
577
578
579
580

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
581
582
583
584
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

585
586
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
587
588
589
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
590

591
      , option [] ["dry-run"]
592
593
594
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
595

596
597
598
599
600
      , option [] ["reinstall"]
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
          trueArg

601
602
603
604
605
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
          trueArg

606
607
608
609
610
611
612

      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
          trueArg


613
614
615
616
617
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

618
619
620
621
622
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

623
624
625
626
627
628
      , option [] ["build-summary"]
          "Save build summaries to file (name template can use $pkgid, $compiler, $os, $arch)"
          installSummaryFile (\v flags -> flags { installSummaryFile = v })
          (reqArg' "TEMPLATE" (\x -> [toPathTemplate x]) (map fromPathTemplate))

      , option [] ["build-log"]
Duncan Coutts's avatar
Duncan Coutts committed
629
630
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
631
632
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
633

634
635
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
636
          installBuildReports (\v flags -> flags { installBuildReports = v })
637
638
639
640
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
641

642
643
644
645
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
          trueArg
646
647
648
649
650
651
652
      ] ++ case showOrParseArgs of      -- TODO: remove when "cabal install" avoids
          ParseArgs ->
            option [] ["only"]
              "Only installs the package in the current directory."
              installOnly (\v flags -> flags { installOnly = v })
              trueArg
             : []
653
          _ -> []
654
655

instance Monoid InstallFlags where
656
657
  mempty = InstallFlags {
    installDocumentation= mempty,
658
    installHaddockIndex = mempty,
659
660
    installDryRun       = mempty,
    installReinstall    = mempty,
661
    installUpgradeDeps  = mempty,
662
    installOnly         = mempty,
663
    installOnlyDeps     = mempty,
664
    installRootCmd      = mempty,
665
    installSummaryFile  = mempty,
666
667
    installLogFile      = mempty,
    installBuildReports = mempty,
668
669
    installSymlinkBinDir= mempty,
    installOneShot      = mempty
670
  }
671
  mappend a b = InstallFlags {
672
    installDocumentation= combine installDocumentation,
673
    installHaddockIndex = combine installHaddockIndex,
674
    installDryRun       = combine installDryRun,
675
    installReinstall    = combine installReinstall,
676
    installUpgradeDeps  = combine installUpgradeDeps,
677
    installOnly         = combine installOnly,
678
    installOnlyDeps     = combine installOnlyDeps,
679
    installRootCmd      = combine installRootCmd,
680
    installSummaryFile  = combine installSummaryFile,
681
    installLogFile      = combine installLogFile,
682
    installBuildReports = combine installBuildReports,
683
684
    installSymlinkBinDir= combine installSymlinkBinDir,
    installOneShot      = combine installOneShot
685
686
687
  }
    where combine field = field a `mappend` field b

688
689
690
691
692
693
694
695
696
-- ------------------------------------------------------------
-- * Upload flags
-- ------------------------------------------------------------

data UploadFlags = UploadFlags {
    uploadCheck     :: Flag Bool,
    uploadUsername  :: Flag Username,
    uploadPassword  :: Flag Password,
    uploadVerbosity :: Flag Verbosity
697
  }
698
699
700
701
702
703
704
705
706
707
708
709
710
711

defaultUploadFlags :: UploadFlags
defaultUploadFlags = UploadFlags {
    uploadCheck     = toFlag False,
    uploadUsername  = mempty,
    uploadPassword  = mempty,
    uploadVerbosity = toFlag normal
  }

uploadCommand :: CommandUI UploadFlags
uploadCommand = CommandUI {
    commandName         = "upload",
    commandSynopsis     = "Uploads source packages to Hackage",
    commandDescription  = Just $ \_ ->
712
         "You can store your Hackage login in the ~/.cabal/config file\n",
713
714
715
716
717
    commandUsage        = \pname ->
         "Usage: " ++ pname ++ " upload [FLAGS] [TARFILES]\n\n"
      ++ "Flags for upload:",
    commandDefaultFlags = defaultUploadFlags,
    commandOptions      = \_ ->
718
      [optionVerbosity uploadVerbosity (\v flags -> flags { uploadVerbosity = v })
719
720
721
722

      ,option ['c'] ["check"]
         "Do not upload, just do QA checks."
        uploadCheck (\v flags -> flags { uploadCheck = v })
723
        trueArg
724
725
726
727

      ,option ['u'] ["username"]
        "Hackage username."
        uploadUsername (\v flags -> flags { uploadUsername = v })
728
729
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))
730
731
732
733

      ,option ['p'] ["password"]
        "Hackage password."
        uploadPassword (\v flags -> flags { uploadPassword = v })
734
735
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
      ]
  }

instance Monoid UploadFlags where
  mempty = UploadFlags {
    uploadCheck     = mempty,
    uploadUsername  = mempty,
    uploadPassword  = mempty,
    uploadVerbosity = mempty
  }
  mappend a b = UploadFlags {
    uploadCheck     = combine uploadCheck,
    uploadUsername  = combine uploadUsername,
    uploadPassword  = combine uploadPassword,
    uploadVerbosity = combine uploadVerbosity
  }
    where combine field = field a `mappend` field b

754
755
756
757
758
759
760
761
762
763
764
765
766
767
-- ------------------------------------------------------------
-- * Init flags
-- ------------------------------------------------------------

emptyInitFlags :: IT.InitFlags
emptyInitFlags  = mempty

defaultInitFlags :: IT.InitFlags
defaultInitFlags  = emptyInitFlags

initCommand :: CommandUI IT.InitFlags
initCommand = CommandUI {
    commandName = "init",
    commandSynopsis = "Interactively create a .cabal file.",
768
769
770
771
772
773
774
775
776
777
778
779
    commandDescription = Just $ \_ -> wrapText $
         "Cabalise a project by creating a .cabal, Setup.hs, and "
      ++ "optionally a LICENSE file.\n\n"
      ++ "Calling init with no arguments (recommended) uses an "
      ++ "interactive mode, which will try to guess as much as "
      ++ "possible and prompt you for the rest.  Command-line "
      ++ "arguments are provided for scripting purposes. "
      ++ "If you don't want interactive mode, be sure to pass "
      ++ "the -n flag.\n",
    commandUsage = \pname ->
         "Usage: " ++ pname ++ " init [FLAGS]\n\n"
      ++ "Flags for init:",
780
781
    commandDefaultFlags = defaultInitFlags,
    commandOptions = \_ ->
782
      [ option ['n'] ["non-interactive"]
783
784
785
786
787
788
789
790
791
        "Non-interactive mode."
        IT.nonInteractive (\v flags -> flags { IT.nonInteractive = v })
        trueArg

      , option ['q'] ["quiet"]
        "Do not generate log messages to stdout."
        IT.quiet (\v flags -> flags { IT.quiet = v })
        trueArg

792
      , option [] ["no-comments"]
793
794
795
796
797
        "Do not generate explanatory comments in the .cabal file."
        IT.noComments (\v flags -> flags { IT.noComments = v })
        trueArg

      , option ['m'] ["minimal"]
798
        "Generate a minimal .cabal file, that is, do not include extra empty fields.  Also implies --no-comments."
799
800
801
        IT.minimal (\v flags -> flags { IT.minimal = v })
        trueArg

802
      , option [] ["package-dir"]
803
804
805
806
        "Root directory of the package (default = current directory)."
        IT.packageDir (\v flags -> flags { IT.packageDir = v })
        (reqArgFlag "DIRECTORY")

807
      , option ['p'] ["package-name"]
808
809
810
811
812
813
814
815
816
817
818
        "Name of the Cabal package to create."
        IT.packageName (\v flags -> flags { IT.packageName = v })
        (reqArgFlag "PACKAGE")

      , option [] ["version"]
        "Initial version of the package."
        IT.version (\v flags -> flags { IT.version = v })
        (reqArg "VERSION" (readP_to_E ("Cannot parse package version: "++)
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))

819
      , option [] ["cabal-version"]
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
        "Required version of the Cabal library."
        IT.cabalVersion (\v flags -> flags { IT.cabalVersion = v })
        (reqArg "VERSION_RANGE" (readP_to_E ("Cannot parse Cabal version range: "++)
                                            (toFlag `fmap` parse))
                                (flagToList . fmap display))

      , option ['l'] ["license"]
        "Project license."
        IT.license (\v flags -> flags { IT.license = v })
        (reqArg "LICENSE" (readP_to_E ("Cannot parse license: "++)
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))

      , option ['a'] ["author"]
        "Name of the project's author."
        IT.author (\v flags -> flags { IT.author = v })
        (reqArgFlag "NAME")

      , option ['e'] ["email"]
        "Email address of the maintainer."
        IT.email (\v flags -> flags { IT.email = v })
        (reqArgFlag "EMAIL")

      , option ['u'] ["homepage"]
        "Project homepage and/or repository."
        IT.homepage (\v flags -> flags { IT.homepage = v })
        (reqArgFlag "URL")

      , option ['s'] ["synopsis"]
        "Short project synopsis."
        IT.synopsis (\v flags -> flags { IT.synopsis = v })
        (reqArgFlag "TEXT")

      , option ['c'] ["category"]
        "Project category."
        IT.category (\v flags -> flags { IT.category = v })
        (reqArg' "CATEGORY" (\s -> toFlag $ maybe (Left s) Right (readMaybe s))
                            (flagToList . fmap (either id show)))

859
      , option [] ["is-library"]
860
861
862
863
        "Build a library."
        IT.packageType (\v flags -> flags { IT.packageType = v })
        (noArg (Flag IT.Library))

864
      , option [] ["is-executable"]
865
866
867
868
869
        "Build an executable."
        IT.packageType
        (\v flags -> flags { IT.packageType = v })
        (noArg (Flag IT.Executable))

870
      , option ['o'] ["expose-module"]
871
872
873
874
875
876
877
878
879
880
881
882
883
884
        "Export a module from the package."
        IT.exposedModules
        (\v flags -> flags { IT.exposedModules = v })
        (reqArg "MODULE" (readP_to_E ("Cannot parse module name: "++)
                                     ((Just . (:[])) `fmap` parse))
                         (fromMaybe [] . fmap (fmap display)))

      , option ['d'] ["dependency"]
        "Package dependency."
        IT.dependencies (\v flags -> flags { IT.dependencies = v })
        (reqArg "PACKAGE" (readP_to_E ("Cannot parse dependency: "++)
                                      ((Just . (:[])) `fmap` parse))
                          (fromMaybe [] . fmap (fmap display)))

885
      , option [] ["source-dir"]
886
887
888
889
890
        "Directory containing package source."
        IT.sourceDirs (\v flags -> flags { IT.sourceDirs = v })
        (reqArg' "DIR" (Just . (:[]))
                       (fromMaybe []))

891
      , option [] ["build-tool"]
892
893
894
895
896
897
898
899
        "Required external build tool."
        IT.buildTools (\v flags -> flags { IT.buildTools = v })
        (reqArg' "TOOL" (Just . (:[]))
                        (fromMaybe []))
      ]
  }
  where readMaybe s = case reads s of
                        [(x,"")]  -> Just x
900
                        _         -> Nothing
901

902
903
904
905
-- ------------------------------------------------------------
-- * GetOpt Utils
-- ------------------------------------------------------------

906
907
908
boolOpt :: SFlags -> SFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
boolOpt  = Command.boolOpt  flagToMaybe Flag

909
910
911
912
reqArgFlag :: ArgPlaceHolder -> SFlags -> LFlags -> Description ->
              (b -> Flag String) -> (Flag String -> b -> b) -> OptDescr b
reqArgFlag ad = reqArg ad (succeedReadE Flag) flagToList

913
914
915
916
liftOptions :: (b -> a) -> (a -> b -> b)
            -> [OptionField a] -> [OptionField b]
liftOptions get set = map (liftOption get set)

Duncan Coutts's avatar
Duncan Coutts committed
917
usagePackages :: String -> String -> String
918
usagePackages name pname =
Duncan Coutts's avatar
Duncan Coutts committed
919
920
921
922
     "Usage: " ++ pname ++ " " ++ name ++ " [FLAGS]\n"
  ++ "   or: " ++ pname ++ " " ++ name ++ " [PACKAGES]\n\n"
  ++ "Flags for " ++ name ++ ":"

923
924
--TODO: do we want to allow per-package flags?
parsePackageArgs :: [String] -> Either String [Dependency]
Duncan Coutts's avatar
Duncan Coutts committed
925
926
927
928
929
parsePackageArgs = parsePkgArgs []
  where
    parsePkgArgs ds [] = Right (reverse ds)
    parsePkgArgs ds (arg:args) =
      case readPToMaybe parseDependencyOrPackageId arg of
930
        Just dep -> parsePkgArgs (dep:ds) args
931
932
933
        Nothing  -> Left $
         show arg ++ " is not valid syntax for a package name or"
                  ++ " package dependency."
934

935
936
937
readPToMaybe :: Parse.ReadP a a -> String -> Maybe a
readPToMaybe p str = listToMaybe [ r | (r,s) <- Parse.readP_to_S p str
                                     , all isSpace s ]
938

939
940
parseDependencyOrPackageId :: Parse.ReadP r Dependency
parseDependencyOrPackageId = parse Parse.+++ liftM pkgidToDependency parse
941
942
943
  where
    pkgidToDependency :: PackageIdentifier -> Dependency
    pkgidToDependency p = case packageVersion p of
Duncan Coutts's avatar
Duncan Coutts committed
944
945
      Version [] _ -> Dependency (packageName p) anyVersion
      version      -> Dependency (packageName p) (thisVersion version)
946
947
948
949
950
951
952
953
954
955
956

showRepo :: RemoteRepo -> String
showRepo repo = remoteRepoName repo ++ ":"
             ++ uriToString id (remoteRepoURI repo) []

readRepo :: String -> Maybe RemoteRepo
readRepo = readPToMaybe parseRepo

parseRepo :: Parse.ReadP r RemoteRepo
parseRepo = do
  name <- Parse.munch1 (\c -> isAlphaNum c || c `elem` "_-.")
957
  _ <- Parse.char ':'
958
959
960
961
962
963
  uriStr <- Parse.munch1 (\c -> isAlphaNum c || c `elem` "+-=._/*()@'$:;&!?~")
  uri <- maybe Parse.pfail return (parseAbsoluteURI uriStr)
  return $ RemoteRepo {
    remoteRepoName = name,
    remoteRepoURI  = uri
  }