Init.hs 32.1 KB
Newer Older
Duncan Coutts's avatar
Duncan Coutts committed
1
{-# LANGUAGE CPP #-}
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
-----------------------------------------------------------------------------
-- |
-- Module      :  Distribution.Client.Init
-- Copyright   :  (c) Brent Yorgey 2009
-- License     :  BSD-like
--
-- Maintainer  :  cabal-devel@haskell.org
-- Stability   :  provisional
-- Portability :  portable
--
-- Implementation of the 'cabal init' command, which creates an initial .cabal
-- file for a project.
--
-----------------------------------------------------------------------------

module Distribution.Client.Init (

    -- * Commands
    initCabal

  ) where

import System.IO
  ( hSetBuffering, stdout, BufferMode(..) )
import System.Directory
27 28
  ( getCurrentDirectory, doesDirectoryExist, doesFileExist, copyFile
  , getDirectoryContents )
29
import System.FilePath
30
  ( (</>), (<.>), takeBaseName )
31 32 33
import Data.Time
  ( getCurrentTime, utcToLocalTime, toGregorian, localDay, getCurrentTimeZone )

34 35
import Data.Char
  ( toUpper )
36
import Data.List
37
  ( intercalate, nub, groupBy, (\\), sortBy, isInfixOf, isSuffixOf )
38
import Data.Maybe
39 40 41 42 43
  ( fromMaybe, isJust, catMaybes, listToMaybe )
import Data.Ord
  ( comparing )
import Data.Monoid
  ( mappend )
44 45 46
import Data.Function
  ( on )
import qualified Data.Map as M
47 48
import Data.Traversable
  ( traverse )
49 50
import Control.Applicative
  ( (<$>) )
51
import Control.Monad
52
  ( when, unless, (>=>), join )
53
import Control.Arrow
EyalLotem's avatar
EyalLotem committed
54
  ( (&&&), (***) )
55

dterei's avatar
dterei committed
56
import Text.PrettyPrint hiding (mode, cat)
57 58 59 60

import Data.Version
  ( Version(..) )
import Distribution.Version
61
  ( orLaterVersion, earlierVersion, intersectVersionRanges, VersionRange )
62 63 64
import Distribution.Verbosity
  ( Verbosity )
import Distribution.ModuleName
EyalLotem's avatar
EyalLotem committed
65
  ( ModuleName, fromString )  -- And for the Text instance
66 67 68
import Distribution.InstalledPackageInfo
  ( InstalledPackageInfo, sourcePackageId, exposed )
import qualified Distribution.Package as P
69
import Language.Haskell.Extension ( Language(..) )
70 71

import Distribution.Client.Init.Types
72
  ( InitFlags(..), PackageType(..), Category(..) )
73
import Distribution.Client.Init.Licenses
74
  ( bsd2, bsd3, gplv2, gplv3, lgpl21, lgpl3, agplv3, apache20, mit, mpl20 )
75
import Distribution.Client.Init.Heuristics
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
76 77
  ( guessPackageName, guessAuthorNameMail, SourceFileEntry(..),
    scanForModules, neededBuildPrograms )
78 79 80 81 82 83 84 85

import Distribution.License
  ( License(..), knownLicenses )

import Distribution.ReadE
  ( runReadE, readP_to_E )
import Distribution.Simple.Setup
  ( Flag(..), flagToMaybe )
86 87 88 89 90 91 92 93
import Distribution.Simple.Configure
  ( getInstalledPackages )
import Distribution.Simple.Compiler
  ( PackageDBStack, Compiler )
import Distribution.Simple.Program
  ( ProgramConfiguration )
import Distribution.Simple.PackageIndex
  ( PackageIndex, moduleNameIndex )
94 95 96
import Distribution.Text
  ( display, Text(..) )

97 98 99 100 101 102 103 104 105 106
initCabal :: Verbosity
          -> PackageDBStack
          -> Compiler
          -> ProgramConfiguration
          -> InitFlags
          -> IO ()
initCabal verbosity packageDBs comp conf initFlags = do

  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf

107 108
  hSetBuffering stdout NoBuffering

109
  initFlags' <- extendFlags installedPkgIndex initFlags
110 111 112 113 114 115 116 117 118 119 120 121 122

  writeLicense initFlags'
  writeSetupFile initFlags'
  success <- writeCabalFile initFlags'

  when success $ generateWarnings initFlags'

---------------------------------------------------------------------------
--  Flag acquisition  -----------------------------------------------------
---------------------------------------------------------------------------

-- | Fill in more details by guessing, discovering, or prompting the
--   user.
123 124 125 126 127 128 129 130 131
extendFlags :: PackageIndex -> InitFlags -> IO InitFlags
extendFlags pkgIx =
      getPackageName
  >=> getVersion
  >=> getLicense
  >=> getAuthorInfo
  >=> getHomepage
  >=> getSynopsis
  >=> getCategory
132
  >=> getExtraSourceFiles
133
  >=> getLibOrExec
134
  >=> getLanguage
135 136 137
  >=> getGenComments
  >=> getSrcDir
  >=> getModulesBuildToolsAndDeps pkgIx
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

-- | Combine two actions which may return a value, preferring the first. That
--   is, run the second action only if the first doesn't return a value.
infixr 1 ?>>
(?>>) :: IO (Maybe a) -> IO (Maybe a) -> IO (Maybe a)
f ?>> g = do
  ma <- f
  if isJust ma
    then return ma
    else g

-- | Witness the isomorphism between Maybe and Flag.
maybeToFlag :: Maybe a -> Flag a
maybeToFlag = maybe NoFlag Flag

-- | Get the package name: use the package directory (supplied, or the current
--   directory by default) as a guess.
getPackageName :: InitFlags -> IO InitFlags
getPackageName flags = do
  guess    <-     traverse guessPackageName (flagToMaybe $ packageDir flags)
              ?>> Just `fmap` (getCurrentDirectory >>= guessPackageName)

  pkgName' <-     return (flagToMaybe $ packageName flags)
Ian D. Bollinger's avatar
Ian D. Bollinger committed
161
              ?>> maybePrompt flags (prompt "Package name" guess)
162 163 164 165
              ?>> return guess

  return $ flags { packageName = maybeToFlag pkgName' }

166 167
-- | Package version: use 0.1.0.0 as a last resort, but try prompting the user
--  if possible.
168 169
getVersion :: InitFlags -> IO InitFlags
getVersion flags = do
170
  let v = Just $ Version { versionBranch = [0,1,0,0], versionTags = [] }
171 172 173 174 175 176 177 178 179
  v' <-     return (flagToMaybe $ version flags)
        ?>> maybePrompt flags (prompt "Package version" v)
        ?>> return v
  return $ flags { version = maybeToFlag v' }

-- | Choose a license.
getLicense :: InitFlags -> IO InitFlags
getLicense flags = do
  lic <-     return (flagToMaybe $ license flags)
180
         ?>> fmap (fmap (either UnknownLicense id) . join)
181
                  (maybePrompt flags
182
                    (promptListOptional "Please choose a license" listedLicenses))
183
  return $ flags { license = maybeToFlag lic }
184 185
  where
    listedLicenses =
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
186 187
      knownLicenses \\ [GPL Nothing, LGPL Nothing, AGPL Nothing
                       , Apache Nothing, OtherLicense]
188 189 190 191 192

-- | The author's name and email. Prompt, or try to guess from an existing
--   darcs repo.
getAuthorInfo :: InitFlags -> IO InitFlags
getAuthorInfo flags = do
EyalLotem's avatar
EyalLotem committed
193 194
  (authorName, authorEmail)  <-
    (flagToMaybe *** flagToMaybe) `fmap` guessAuthorNameMail
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
  authorName'  <-     return (flagToMaybe $ author flags)
                  ?>> maybePrompt flags (promptStr "Author name" authorName)
                  ?>> return authorName

  authorEmail' <-     return (flagToMaybe $ email flags)
                  ?>> maybePrompt flags (promptStr "Maintainer email" authorEmail)
                  ?>> return authorEmail

  return $ flags { author = maybeToFlag authorName'
                 , email  = maybeToFlag authorEmail'
                 }

-- | Prompt for a homepage URL.
getHomepage :: InitFlags -> IO InitFlags
getHomepage flags = do
  hp  <- queryHomepage
  hp' <-     return (flagToMaybe $ homepage flags)
212
         ?>> maybePrompt flags (promptStr "Project homepage URL" hp)
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
         ?>> return hp

  return $ flags { homepage = maybeToFlag hp' }

-- | Right now this does nothing, but it could be changed to do some
--   intelligent guessing.
queryHomepage :: IO (Maybe String)
queryHomepage = return Nothing     -- get default remote darcs repo?

-- | Prompt for a project synopsis.
getSynopsis :: InitFlags -> IO InitFlags
getSynopsis flags = do
  syn <-     return (flagToMaybe $ synopsis flags)
         ?>> maybePrompt flags (promptStr "Project synopsis" Nothing)

  return $ flags { synopsis = maybeToFlag syn }

-- | Prompt for a package category.
--   Note that it should be possible to do some smarter guessing here too, i.e.
--   look at the name of the top level source directory.
getCategory :: InitFlags -> IO InitFlags
getCategory flags = do
  cat <-     return (flagToMaybe $ category flags)
236 237
         ?>> fmap join (maybePrompt flags
                         (promptListOptional "Project category" [Codec ..]))
238 239
  return $ flags { category = maybeToFlag cat }

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
-- | Try to guess extra source files (don't prompt the user).
getExtraSourceFiles :: InitFlags -> IO InitFlags
getExtraSourceFiles flags = do
  extraSrcFiles <-     return (extraSrc flags)
                   ?>> Just `fmap` guessExtraSourceFiles flags

  return $ flags { extraSrc = extraSrcFiles }

-- | Try to guess things to include in the extra-source-files field.
--   For now, we just look for things in the root directory named
--   'readme', 'changes', or 'changelog', with any sort of
--   capitalization and any extension.
guessExtraSourceFiles :: InitFlags -> IO [FilePath]
guessExtraSourceFiles flags = do
  dir <-
    maybe getCurrentDirectory return . flagToMaybe $ packageDir flags
  files <- getDirectoryContents dir
  return $ filter isExtra files

  where
    isExtra = (`elem` ["README", "CHANGES", "CHANGELOG"])
            . map toUpper
            . takeBaseName

264 265 266 267 268
-- | Ask whether the project builds a library or executable.
getLibOrExec :: InitFlags -> IO InitFlags
getLibOrExec flags = do
  isLib <-     return (flagToMaybe $ packageType flags)
           ?>> maybePrompt flags (either (const Library) id `fmap`
EyalLotem's avatar
EyalLotem committed
269 270 271
                                   promptList "What does the package build"
                                   [Library, Executable]
                                   Nothing display False)
272
           ?>> return (Just Library)
273 274 275
  mainFile <- if isLib /= Just Executable then return Nothing else
                    return (mainIs flags)
                ?>> guessAndPromptMainFile flags
276

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
  return $ flags { packageType = maybeToFlag isLib
                 , mainIs = mainFile
                 }

-- | Try to guess the main file of the executable, and prompt the user to
--   choose one of them.  Top-level modules including the word 'Main' will
--   be candidates, and shorter filenames will be preferred.
guessAndPromptMainFile :: InitFlags -> IO (Maybe FilePath)
guessAndPromptMainFile flags = do
  dir <-
    maybe getCurrentDirectory return . flagToMaybe $ packageDir flags
  files <- getDirectoryContents dir
  let existingCandidates = filter isMain files
      -- We always want to give the user at least one default choice.  If
      -- either Main.hs or Main.lhs has already been created, then we don't
      -- want to suggest the other; however, if neither has been
      -- created, then we suggest both.
      newCandidates =
        if any (`elem` existingCandidates) ["Main.hs", "Main.lhs"]
        then []
        else ["Main.hs", "Main.lhs"]
      candidates =
        sortBy (\x y -> comparing (length . either id id) x y `mappend` compare x y)
               (map Left newCandidates ++ map Right existingCandidates)
      showCandidate = either (++" (does not yet exist)") id
      defaultFile = listToMaybe candidates
  maybePrompt flags (either id (either id id) `fmap`
                      promptList "What is the main module of the executable"
                      candidates
                      defaultFile showCandidate True)
    ?>> return (fmap (either id id) defaultFile)

  where
    isMain f =    isInfixOf "Main" f
               && (isSuffixOf ".hs" f || isSuffixOf ".lhs" f)
312

313 314 315 316 317 318
-- | Ask for the base language of the package.
getLanguage :: InitFlags -> IO InitFlags
getLanguage flags = do
  lang <-     return (flagToMaybe $ language flags)
          ?>> maybePrompt flags
                (either UnknownLanguage id `fmap`
EyalLotem's avatar
EyalLotem committed
319 320 321
                  promptList "What base language is the package written in"
                  [Haskell2010, Haskell98]
                  (Just Haskell2010) display True)
322 323 324 325 326
          ?>> return (Just Haskell2010)

  return $ flags { language = maybeToFlag lang }

-- | Ask whether to generate explanatory comments.
327 328
getGenComments :: InitFlags -> IO InitFlags
getGenComments flags = do
EyalLotem's avatar
EyalLotem committed
329
  genComments <-     return (not <$> flagToMaybe (noComments flags))
330
                 ?>> maybePrompt flags (promptYesNo promptMsg (Just False))
331 332
                 ?>> return (Just False)
  return $ flags { noComments = maybeToFlag (fmap not genComments) }
333
  where
334
    promptMsg = "Include documentation on what each field means (y/n)"
335

336 337 338 339
-- | Try to guess the source root directory (don't prompt the user).
getSrcDir :: InitFlags -> IO InitFlags
getSrcDir flags = do
  srcDirs <-     return (sourceDirs flags)
EyalLotem's avatar
EyalLotem committed
340
             ?>> Just `fmap` guessSourceDirs flags
341 342 343

  return $ flags { sourceDirs = srcDirs }

344 345 346 347
-- | Try to guess source directories.  Could try harder; for the
--   moment just looks to see whether there is a directory called 'src'.
guessSourceDirs :: InitFlags -> IO [String]
guessSourceDirs flags = do
EyalLotem's avatar
EyalLotem committed
348 349
  dir      <-
    maybe getCurrentDirectory return . flagToMaybe $ packageDir flags
350 351 352 353
  srcIsDir <- doesDirectoryExist (dir </> "src")
  if srcIsDir
    then return ["src"]
    else return []
354 355

-- | Get the list of exposed modules and extra tools needed to build them.
356 357
getModulesBuildToolsAndDeps :: PackageIndex -> InitFlags -> IO InitFlags
getModulesBuildToolsAndDeps pkgIx flags = do
EyalLotem's avatar
EyalLotem committed
358
  dir <- maybe getCurrentDirectory return . flagToMaybe $ packageDir flags
359 360 361 362

  -- XXX really should use guessed source roots.
  sourceFiles <- scanForModules dir

363
  Just mods <-      return (exposedModules flags)
364 365 366 367 368
           ?>> (return . Just . map moduleName $ sourceFiles)

  tools <-     return (buildTools flags)
           ?>> (return . Just . neededBuildPrograms $ sourceFiles)

369 370
  deps <-      return (dependencies flags)
           ?>> Just <$> importsToDeps flags
371 372 373 374 375 376 377 378
                        (fromString "Prelude" :  -- to ensure we get base as a dep
                           (   nub   -- only need to consider each imported package once
                             . filter (`notElem` mods)  -- don't consider modules from
                                                        -- this package itself
                             . concatMap imports
                             $ sourceFiles
                           )
                        )
379 380
                        pkgIx

381 382 383
  exts <-     return (otherExts flags)
          ?>> (return . Just . nub . concatMap extensions $ sourceFiles)

384 385 386
  return $ flags { exposedModules = Just mods
                 , buildTools     = tools
                 , dependencies   = deps
387
                 , otherExts      = exts
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 426
                 }

importsToDeps :: InitFlags -> [ModuleName] -> PackageIndex -> IO [P.Dependency]
importsToDeps flags mods pkgIx = do

  let modMap :: M.Map ModuleName [InstalledPackageInfo]
      modMap  = M.map (filter exposed) $ moduleNameIndex pkgIx

      modDeps :: [(ModuleName, Maybe [InstalledPackageInfo])]
      modDeps = map (id &&& flip M.lookup modMap) mods

  message flags "\nGuessing dependencies..."
  nub . catMaybes <$> mapM (chooseDep flags) modDeps

-- Given a module and a list of installed packages providing it,
-- choose a dependency (i.e. package + version range) to use for that
-- module.
chooseDep :: InitFlags -> (ModuleName, Maybe [InstalledPackageInfo])
          -> IO (Maybe P.Dependency)

chooseDep flags (m, Nothing)
  = message flags ("\nWarning: no package found providing " ++ display m ++ ".")
    >> return Nothing

chooseDep flags (m, Just [])
  = message flags ("\nWarning: no package found providing " ++ display m ++ ".")
    >> return Nothing

    -- We found some packages: group them by name.
chooseDep flags (m, Just ps)
  = case pkgGroups of
      -- if there's only one group, i.e. multiple versions of a single package,
      -- we make it into a dependency, choosing the latest-ish version (see toDep).
      [grp] -> Just <$> toDep grp
      -- otherwise, we refuse to choose between different packages and make the user
      -- do it.
      grps  -> do message flags ("\nWarning: multiple packages found providing "
                                 ++ display m
                                 ++ ": " ++ intercalate ", " (map (display . P.pkgName . head) grps))
EyalLotem's avatar
EyalLotem committed
427
                  message flags "You will need to pick one and manually add it to the Build-depends: field."
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
                  return Nothing
  where
    pkgGroups = groupBy ((==) `on` P.pkgName) (map sourcePackageId ps)

    -- Given a list of available versions of the same package, pick a dependency.
    toDep :: [P.PackageIdentifier] -> IO P.Dependency

    -- If only one version, easy.  We change e.g. 0.4.2  into  0.4.*
    toDep [pid] = return $ P.Dependency (P.pkgName pid) (pvpize . P.pkgVersion $ pid)

    -- Otherwise, choose the latest version and issue a warning.
    toDep pids  = do
      message flags ("\nWarning: multiple versions of " ++ display (P.pkgName . head $ pids) ++ " provide " ++ display m ++ ", choosing the latest.")
      return $ P.Dependency (P.pkgName . head $ pids)
                            (pvpize . maximum . map P.pkgVersion $ pids)

    pvpize :: Version -> VersionRange
445 446 447 448 449 450 451 452 453 454 455 456
    pvpize v = orLaterVersion v'
               `intersectVersionRanges`
               earlierVersion (incVersion 1 v')
      where v' = (v { versionBranch = take 2 (versionBranch v) })

incVersion :: Int -> Version -> Version
incVersion n (Version vlist tags) = Version (incVersion' n vlist) tags
  where
    incVersion' 0 []     = [1]
    incVersion' 0 (v:_)  = [v+1]
    incVersion' m []     = replicate m 0 ++ [1]
    incVersion' m (v:vs) = v : incVersion' (m-1) vs
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474

---------------------------------------------------------------------------
--  Prompting/user interaction  -------------------------------------------
---------------------------------------------------------------------------

-- | Run a prompt or not based on the nonInteractive flag of the
--   InitFlags structure.
maybePrompt :: InitFlags -> IO t -> IO (Maybe t)
maybePrompt flags p =
  case nonInteractive flags of
    Flag True -> return Nothing
    _         -> Just `fmap` p

-- | Create a prompt with optional default value that returns a
--   String.
promptStr :: String -> Maybe String -> IO String
promptStr = promptDefault' Just id

475 476 477 478 479 480 481 482 483 484 485 486
-- | Create a yes/no prompt with optional default value.
--
promptYesNo :: String -> Maybe Bool -> IO Bool
promptYesNo =
    promptDefault' recogniseYesNo showYesNo
  where
    recogniseYesNo s | s == "y" || s == "Y" = Just True
                     | s == "n" || s == "N" = Just False
                     | otherwise            = Nothing
    showYesNo True  = "y"
    showYesNo False = "n"

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
-- | Create a prompt with optional default value that returns a value
--   of some Text instance.
prompt :: Text t => String -> Maybe t -> IO t
prompt = promptDefault'
           (either (const Nothing) Just . runReadE (readP_to_E id parse))
           display

-- | Create a prompt with an optional default value.
promptDefault' :: (String -> Maybe t)       -- ^ parser
               -> (t -> String)             -- ^ pretty-printer
               -> String                    -- ^ prompt message
               -> Maybe t                   -- ^ optional default value
               -> IO t
promptDefault' parser pretty pr def = do
  putStr $ mkDefPrompt pr (pretty `fmap` def)
  inp <- getLine
  case (inp, def) of
    ("", Just d)  -> return d
    _  -> case parser inp of
            Just t  -> return t
            Nothing -> do putStrLn $ "Couldn't parse " ++ inp ++ ", please try again!"
                          promptDefault' parser pretty pr def

-- | Create a prompt from a prompt string and a String representation
--   of an optional default value.
mkDefPrompt :: String -> Maybe String -> String
513 514
mkDefPrompt pr def = pr ++ "?" ++ defStr def
  where defStr Nothing  = " "
515 516 517 518 519 520 521 522 523 524 525
        defStr (Just s) = " [default: " ++ s ++ "] "

promptListOptional :: (Text t, Eq t)
                   => String            -- ^ prompt
                   -> [t]               -- ^ choices
                   -> IO (Maybe (Either String t))
promptListOptional pr choices =
    fmap rearrange
  $ promptList pr (Nothing : map Just choices) (Just Nothing)
               (maybe "(none)" display) True
  where
EyalLotem's avatar
EyalLotem committed
526
    rearrange = either (Just . Left) (fmap Right)
527 528

-- | Create a prompt from a list of items.
529
promptList :: Eq t
530 531 532
           => String            -- ^ prompt
           -> [t]               -- ^ choices
           -> Maybe t           -- ^ optional default value
533
           -> (t -> String)     -- ^ show an item
534 535
           -> Bool              -- ^ whether to allow an 'other' option
           -> IO (Either String t)
536
promptList pr choices def displayItem other = do
537
  putStrLn $ pr ++ ":"
538
  let options1 = map (\c -> (Just c == def, displayItem c)) choices
539
      options2 = zip ([1..]::[Int])
EyalLotem's avatar
EyalLotem committed
540
                     (options1 ++ [(False, "Other (specify)") | other])
541
  mapM_ (putStrLn . \(n,(i,s)) -> showOption n i ++ s) options2
542
  promptList' displayItem (length options2) choices def other
543 544 545 546 547 548
 where showOption n i | n < 10 = " " ++ star i ++ " " ++ rest
                      | otherwise = " " ++ star i ++ rest
                  where rest = show n ++ ") "
                        star True = "*"
                        star False = " "

549 550 551
promptList' :: (t -> String) -> Int -> [t] -> Maybe t -> Bool -> IO (Either String t)
promptList' displayItem numChoices choices def other = do
  putStr $ mkDefPrompt "Your choice" (displayItem `fmap` def)
552 553 554 555 556 557 558
  inp <- getLine
  case (inp, def) of
    ("", Just d) -> return $ Right d
    _  -> case readMaybe inp of
            Nothing -> invalidChoice inp
            Just n  -> getChoice n
 where invalidChoice inp = do putStrLn $ inp ++ " is not a valid choice."
559
                              promptList' displayItem numChoices choices def other
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
       getChoice n | n < 1 || n > numChoices = invalidChoice (show n)
                   | n < numChoices ||
                     (n == numChoices && not other)
                                  = return . Right $ choices !! (n-1)
                   | otherwise    = Left `fmap` promptStr "Please specify" Nothing

readMaybe :: (Read a) => String -> Maybe a
readMaybe s = case reads s of
                [(a,"")] -> Just a
                _        -> Nothing

---------------------------------------------------------------------------
--  File generation  ------------------------------------------------------
---------------------------------------------------------------------------

writeLicense :: InitFlags -> IO ()
writeLicense flags = do
577
  message flags "\nGenerating LICENSE..."
578 579
  year <- show <$> getYear
  let authors = fromMaybe "???" . flagToMaybe . author $ flags
580 581
  let licenseFile =
        case license flags of
582 583 584 585 586
          Flag BSD2
            -> Just $ bsd2 authors year

          Flag BSD3
            -> Just $ bsd3 authors year
587 588 589 590 591 592 593

          Flag (GPL (Just (Version {versionBranch = [2]})))
            -> Just gplv2

          Flag (GPL (Just (Version {versionBranch = [3]})))
            -> Just gplv3

594 595
          Flag (LGPL (Just (Version {versionBranch = [2, 1]})))
            -> Just lgpl21
596 597 598 599

          Flag (LGPL (Just (Version {versionBranch = [3]})))
            -> Just lgpl3

600 601 602
          Flag (AGPL (Just (Version {versionBranch = [3]})))
            -> Just agplv3

603 604 605
          Flag (Apache (Just (Version {versionBranch = [2, 0]})))
            -> Just apache20

606 607 608
          Flag MIT
            -> Just $ mit authors year

609 610 611
          Flag (MPL (Version {versionBranch = [2, 0]}))
            -> Just mpl20

612 613 614
          _ -> Nothing

  case licenseFile of
615
    Just licenseText -> writeFileSafe flags "LICENSE" licenseText
616 617 618 619 620 621 622 623 624 625 626 627 628
    Nothing -> message flags "Warning: unknown license type, you must put a copy in LICENSE yourself."

getYear :: IO Integer
getYear = do
  u <- getCurrentTime
  z <- getCurrentTimeZone
  let l = utcToLocalTime z u
      (y, _, _) = toGregorian $ localDay l
  return y

writeSetupFile :: InitFlags -> IO ()
writeSetupFile flags = do
  message flags "Generating Setup.hs..."
629
  writeFileSafe flags "Setup.hs" setupFile
630 631
 where
  setupFile = unlines
632
    [ "import Distribution.Simple"
633 634 635 636 637 638 639 640
    , "main = defaultMain"
    ]

writeCabalFile :: InitFlags -> IO Bool
writeCabalFile flags@(InitFlags{packageName = NoFlag}) = do
  message flags "Error: no package name provided."
  return False
writeCabalFile flags@(InitFlags{packageName = Flag p}) = do
Ian D. Bollinger's avatar
Ian D. Bollinger committed
641
  let cabalFileName = display p ++ ".cabal"
642
  message flags $ "Generating " ++ cabalFileName ++ "..."
643
  writeFileSafe flags cabalFileName (generateCabalFile cabalFileName flags)
644 645
  return True

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
-- | Write a file \"safely\", backing up any existing version (unless
--   the overwrite flag is set).
writeFileSafe :: InitFlags -> FilePath -> String -> IO ()
writeFileSafe flags fileName content = do
  moveExistingFile flags fileName
  writeFile fileName content

-- | Move an existing file, if there is one, and the overwrite flag is
--   not set.
moveExistingFile :: InitFlags -> FilePath -> IO ()
moveExistingFile flags fileName =
  unless (overwrite flags == Flag True) $ do
    e <- doesFileExist fileName
    when e $ do
      newName <- findNewName fileName
      message flags $ "Warning: " ++ fileName ++ " already exists, backing up old version in " ++ newName
      copyFile fileName newName

findNewName :: FilePath -> IO FilePath
findNewName oldName = findNewName' 0
  where
    findNewName' :: Integer -> IO FilePath
    findNewName' n = do
      let newName = oldName <.> ("save" ++ show n)
      e <- doesFileExist newName
      if e then findNewName' (n+1) else return newName

673 674 675 676 677 678 679 680 681
-- | Generate a .cabal file from an InitFlags structure.  NOTE: this
--   is rather ad-hoc!  What we would REALLY like is to have a
--   standard low-level AST type representing .cabal files, which
--   preserves things like comments, and to write an *inverse*
--   parser/pretty-printer pair between .cabal files and this AST.
--   Then instead of this ad-hoc code we could just map an InitFlags
--   structure onto a low-level AST structure and use the existing
--   pretty-printing code to generate the file.
generateCabalFile :: String -> InitFlags -> String
682 683
generateCabalFile fileName c =
  renderStyle style { lineLength = 79, ribbonsPerLine = 1.1 } $
EyalLotem's avatar
EyalLotem committed
684
  (if minimal c /= Flag True
685 686 687 688
    then showComment (Just $ "Initial " ++ fileName ++ " generated by cabal "
                          ++ "init.  For further documentation, see "
                          ++ "http://haskell.org/cabal/users-guide/")
         $$ text ""
689 690
    else empty)
  $$
Ian D. Bollinger's avatar
Ian D. Bollinger committed
691
  vcat [ field  "name"          (packageName   c)
692 693 694
                (Just "The name of the package.")
                True

695
       , field  "version"       (version       c)
696 697 698 699
                (Just $ "The package version.  See the Haskell package versioning policy (PVP) for standards guiding when and how versions should be incremented.\nhttp://www.haskell.org/haskellwiki/Package_versioning_policy\n"
                ++ "PVP summary:      +-+------- breaking API changes\n"
                ++ "                  | | +----- non-breaking API additions\n"
                ++ "                  | | | +--- code changes with no API change")
700 701
                True

702
       , fieldS "synopsis"      (synopsis      c)
703 704 705
                (Just "A short (one-line) description of the package.")
                True

706
       , fieldS "description"   NoFlag
707 708 709
                (Just "A longer description of the package.")
                True

710
       , fieldS "homepage"      (homepage     c)
711 712 713
                (Just "URL for the project homepage or repository.")
                False

714
       , fieldS "bug-reports"   NoFlag
715 716 717
                (Just "A URL where users can report bugs.")
                False

718
       , field  "license"       (license      c)
719 720 721
                (Just "The license under which the package is released.")
                True

722
       , fieldS "license-file" (Flag "LICENSE")
723 724 725
                (Just "The file containing the license text.")
                True

726
       , fieldS "author"        (author       c)
727 728 729
                (Just "The package author(s).")
                True

730
       , fieldS "maintainer"    (email        c)
731 732 733
                (Just "An email address to which users can send suggestions, bug reports, and patches.")
                True

734
       , fieldS "copyright"     NoFlag
735 736 737
                (Just "A copyright notice.")
                True

738
       , fieldS "category"      (either id display `fmap` category c)
739 740 741
                Nothing
                True

742
       , fieldS "build-type"    (Flag "Simple")
743 744 745
                Nothing
                True

746
       , fieldS "extra-source-files" (listFieldS (extraSrc c))
747
                (Just "Extra files to be distributed with the package, such as examples or a README.")
748
                True
749

750
       , field  "cabal-version" (Flag $ orLaterVersion (Version [1,10] []))
751 752 753 754 755
                (Just "Constraint on the version of Cabal needed to build this package.")
                False

       , case packageType c of
           Flag Executable ->
Ian D. Bollinger's avatar
Ian D. Bollinger committed
756 757 758
             text "\nexecutable" <+>
             text (maybe "" display . flagToMaybe $ packageName c) $$
             nest 2 (vcat
759
             [ fieldS "main-is" (maybeToFlag $ mainIs c) (Just ".hs or .lhs file containing the Main module.") True
760

761
             , generateBuildInfo Executable c
762
             ])
EyalLotem's avatar
EyalLotem committed
763
           Flag Library    -> text "\nlibrary" $$ nest 2 (vcat
764
             [ fieldS "exposed-modules" (listField (exposedModules c))
765 766 767
                      (Just "Modules exported by the library.")
                      True

768
             , generateBuildInfo Library c
769 770 771 772
             ])
           _               -> empty
       ]
 where
773 774 775 776 777 778
   generateBuildInfo :: PackageType -> InitFlags -> Doc
   generateBuildInfo pkgtype c' = vcat
     [ fieldS "other-modules" (listField (otherModules c'))
              (Just $ case pkgtype of
                 Library    -> "Modules included in this library but not exported."
                 Executable -> "Modules included in this executable, other than Main.")
779 780
              True

781 782 783 784
     , fieldS "other-extensions" (listField (otherExts c'))
              (Just "LANGUAGE extensions used by modules in this package.")
              True

785 786
     , fieldS "build-depends" (listField (dependencies c'))
              (Just "Other library packages from which modules are imported.")
787 788 789
              True

     , fieldS "hs-source-dirs" (listFieldS (sourceDirs c'))
790
              (Just "Directories containing source files.")
791
              True
792

793
     , fieldS "build-tools" (listFieldS (buildTools c'))
794
              (Just "Extra tools (e.g. alex, hsc2hs, ...) needed to build the source.")
795
              False
796 797 798 799

     , field  "default-language" (language c')
              (Just "Base language which the package is written in.")
              True
800 801 802 803 804 805
     ]

   listField :: Text s => Maybe [s] -> Flag String
   listField = listFieldS . fmap (map display)

   listFieldS :: Maybe [String] -> Flag String
806
   listFieldS = Flag . maybe "" (intercalate ", ")
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824

   field :: Text t => String -> Flag t -> Maybe String -> Bool -> Doc
   field s f = fieldS s (fmap display f)

   fieldS :: String        -- ^ Name of the field
          -> Flag String   -- ^ Field contents
          -> Maybe String  -- ^ Comment to explain the field
          -> Bool          -- ^ Should the field be included (commented out) even if blank?
          -> Doc
   fieldS _ NoFlag _    inc | not inc || (minimal c == Flag True) = empty
   fieldS _ (Flag "") _ inc | not inc || (minimal c == Flag True) = empty
   fieldS s f com _ = case (isJust com, noComments c, minimal c) of
                        (_, _, Flag True) -> id
                        (_, Flag True, _) -> id
                        (True, _, _)      -> (showComment com $$) . ($$ text "")
                        (False, _, _)     -> ($$ text "")
                      $
                      comment f <> text s <> colon
EyalLotem's avatar
EyalLotem committed
825
                                <> text (replicate (20 - length s) ' ')
826 827 828 829 830 831
                                <> text (fromMaybe "" . flagToMaybe $ f)
   comment NoFlag    = text "-- "
   comment (Flag "") = text "-- "
   comment _         = text ""

   showComment :: Maybe String -> Doc
EyalLotem's avatar
EyalLotem committed
832 833
   showComment (Just t) = vcat
                        . map (text . ("-- "++)) . lines
834 835 836 837
                        . renderStyle style {
                            lineLength = 76,
                            ribbonsPerLine = 1.05
                          }
838 839 840 841
                        . vcat
                        . map (fcat . map text . breakLine)
                        . lines
                        $ t
842 843
   showComment Nothing  = text ""

844 845 846 847 848
   breakLine  [] = []
   breakLine  cs = case break (==' ') cs of (w,cs') -> w : breakLine' cs'
   breakLine' [] = []
   breakLine' cs = case span (==' ') cs of (w,cs') -> w : breakLine cs'

849 850 851 852 853 854 855 856 857 858 859 860 861 862
-- | Generate warnings for missing fields etc.
generateWarnings :: InitFlags -> IO ()
generateWarnings flags = do
  message flags ""
  when (synopsis flags `elem` [NoFlag, Flag ""])
       (message flags "Warning: no synopsis given. You should edit the .cabal file and add one.")

  message flags "You may want to edit the .cabal file and add a Description field."

-- | Possibly generate a message to stdout, taking into account the
--   --quiet flag.
message :: InitFlags -> String -> IO ()
message (InitFlags{quiet = Flag True}) _ = return ()
message _ s = putStrLn s