Init.hs 29.3 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, (\\) )
38
import Data.Maybe
39 40 41 42
  ( fromMaybe, isJust, catMaybes )
import Data.Function
  ( on )
import qualified Data.Map as M
43 44
import Data.Traversable
  ( traverse )
45 46
import Control.Applicative
  ( (<$>) )
47
import Control.Monad
48
  ( when, unless, (>=>), join )
49
import Control.Arrow
EyalLotem's avatar
EyalLotem committed
50
  ( (&&&), (***) )
51

dterei's avatar
dterei committed
52
import Text.PrettyPrint hiding (mode, cat)
53 54 55 56

import Data.Version
  ( Version(..) )
import Distribution.Version
57 58 59 60
  ( orLaterVersion, withinVersion, VersionRange )
import Distribution.Verbosity
  ( Verbosity )
import Distribution.ModuleName
EyalLotem's avatar
EyalLotem committed
61
  ( ModuleName, fromString )  -- And for the Text instance
62 63 64
import Distribution.InstalledPackageInfo
  ( InstalledPackageInfo, sourcePackageId, exposed )
import qualified Distribution.Package as P
65
import Language.Haskell.Extension ( Language(..) )
66 67

import Distribution.Client.Init.Types
68
  ( InitFlags(..), PackageType(..), Category(..) )
69
import Distribution.Client.Init.Licenses
70
  ( bsd3, gplv2, gplv3, lgpl2, lgpl3, apache20 )
71 72 73 74 75 76 77 78 79 80
import Distribution.Client.Init.Heuristics
  ( guessPackageName, guessAuthorNameMail, SourceFileEntry(..), scanForModules, neededBuildPrograms )

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

import Distribution.ReadE
  ( runReadE, readP_to_E )
import Distribution.Simple.Setup
  ( Flag(..), flagToMaybe )
81 82 83 84 85 86 87 88
import Distribution.Simple.Configure
  ( getInstalledPackages )
import Distribution.Simple.Compiler
  ( PackageDBStack, Compiler )
import Distribution.Simple.Program
  ( ProgramConfiguration )
import Distribution.Simple.PackageIndex
  ( PackageIndex, moduleNameIndex )
89 90 91
import Distribution.Text
  ( display, Text(..) )

92 93 94 95 96 97 98 99 100 101
initCabal :: Verbosity
          -> PackageDBStack
          -> Compiler
          -> ProgramConfiguration
          -> InitFlags
          -> IO ()
initCabal verbosity packageDBs comp conf initFlags = do

  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf

102 103
  hSetBuffering stdout NoBuffering

104
  initFlags' <- extendFlags installedPkgIndex initFlags
105 106 107 108 109 110 111 112 113 114 115 116 117

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

  when success $ generateWarnings initFlags'

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

-- | Fill in more details by guessing, discovering, or prompting the
--   user.
118 119 120 121 122 123 124 125 126
extendFlags :: PackageIndex -> InitFlags -> IO InitFlags
extendFlags pkgIx =
      getPackageName
  >=> getVersion
  >=> getLicense
  >=> getAuthorInfo
  >=> getHomepage
  >=> getSynopsis
  >=> getCategory
127
  >=> getExtraSourceFiles
128
  >=> getLibOrExec
129
  >=> getLanguage
130 131 132
  >=> getGenComments
  >=> getSrcDir
  >=> getModulesBuildToolsAndDeps pkgIx
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 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)
              ?>> maybePrompt flags (promptStr "Package name" guess)
              ?>> return guess

  return $ flags { packageName = maybeToFlag pkgName' }

161 162
-- | Package version: use 0.1.0.0 as a last resort, but try prompting the user
--  if possible.
163 164
getVersion :: InitFlags -> IO InitFlags
getVersion flags = do
165
  let v = Just $ Version { versionBranch = [0,1,0,0], versionTags = [] }
166 167 168 169 170 171 172 173 174
  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)
175
         ?>> fmap (fmap (either UnknownLicense id) . join)
176
                  (maybePrompt flags
177
                    (promptListOptional "Please choose a license" listedLicenses))
178
  return $ flags { license = maybeToFlag lic }
179 180
  where
    listedLicenses =
181
      knownLicenses \\ [GPL Nothing, LGPL Nothing, Apache Nothing, OtherLicense]
182 183 184 185 186

-- | 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
187 188
  (authorName, authorEmail)  <-
    (flagToMaybe *** flagToMaybe) `fmap` guessAuthorNameMail
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  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)
206
         ?>> maybePrompt flags (promptStr "Project homepage URL" hp)
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
         ?>> 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)
230 231
         ?>> fmap join (maybePrompt flags
                         (promptListOptional "Project category" [Codec ..]))
232 233
  return $ flags { category = maybeToFlag cat }

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
-- | 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

258 259 260 261 262
-- | 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
263 264 265
                                   promptList "What does the package build"
                                   [Library, Executable]
                                   Nothing display False)
266 267 268 269
           ?>> return (Just Library)

  return $ flags { packageType = maybeToFlag isLib }

270 271 272 273 274 275
-- | 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
276 277 278
                  promptList "What base language is the package written in"
                  [Haskell2010, Haskell98]
                  (Just Haskell2010) display True)
279 280 281 282 283
          ?>> return (Just Haskell2010)

  return $ flags { language = maybeToFlag lang }

-- | Ask whether to generate explanatory comments.
284 285
getGenComments :: InitFlags -> IO InitFlags
getGenComments flags = do
EyalLotem's avatar
EyalLotem committed
286
  genComments <-     return (not <$> flagToMaybe (noComments flags))
287
                 ?>> maybePrompt flags (promptYesNo promptMsg (Just False))
288 289
                 ?>> return (Just False)
  return $ flags { noComments = maybeToFlag (fmap not genComments) }
290
  where
291
    promptMsg = "Include documentation on what each field means (y/n)"
292

293 294 295 296
-- | 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
297
             ?>> Just `fmap` guessSourceDirs flags
298 299 300

  return $ flags { sourceDirs = srcDirs }

301 302 303 304
-- | 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
305 306
  dir      <-
    maybe getCurrentDirectory return . flagToMaybe $ packageDir flags
307 308 309 310
  srcIsDir <- doesDirectoryExist (dir </> "src")
  if srcIsDir
    then return ["src"]
    else return []
311 312

-- | Get the list of exposed modules and extra tools needed to build them.
313 314
getModulesBuildToolsAndDeps :: PackageIndex -> InitFlags -> IO InitFlags
getModulesBuildToolsAndDeps pkgIx flags = do
EyalLotem's avatar
EyalLotem committed
315
  dir <- maybe getCurrentDirectory return . flagToMaybe $ packageDir flags
316 317 318 319

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

320
  Just mods <-      return (exposedModules flags)
321 322 323 324 325
           ?>> (return . Just . map moduleName $ sourceFiles)

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

326 327
  deps <-      return (dependencies flags)
           ?>> Just <$> importsToDeps flags
328 329 330 331 332 333 334 335
                        (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
                           )
                        )
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
                        pkgIx

  return $ flags { exposedModules = Just mods
                 , buildTools     = tools
                 , dependencies   = deps
                 }

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
380
                  message flags "You will need to pick one and manually add it to the Build-depends: field."
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
                  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
    pvpize v = withinVersion $ v { versionBranch = take 2 (versionBranch v) }
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

---------------------------------------------------------------------------
--  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

417 418 419 420 421 422 423 424 425 426 427 428
-- | 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"

429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
-- | 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
455 456
mkDefPrompt pr def = pr ++ "?" ++ defStr def
  where defStr Nothing  = " "
457 458 459 460 461 462 463 464 465 466 467
        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
468
    rearrange = either (Just . Left) (fmap Right)
469 470

-- | Create a prompt from a list of items.
471
promptList :: Eq t
472 473 474
           => String            -- ^ prompt
           -> [t]               -- ^ choices
           -> Maybe t           -- ^ optional default value
475
           -> (t -> String)     -- ^ show an item
476 477
           -> Bool              -- ^ whether to allow an 'other' option
           -> IO (Either String t)
478
promptList pr choices def displayItem other = do
479
  putStrLn $ pr ++ ":"
480
  let options1 = map (\c -> (Just c == def, displayItem c)) choices
481
      options2 = zip ([1..]::[Int])
EyalLotem's avatar
EyalLotem committed
482
                     (options1 ++ [(False, "Other (specify)") | other])
483
  mapM_ (putStrLn . \(n,(i,s)) -> showOption n i ++ s) options2
484
  promptList' displayItem (length options2) choices def other
485 486 487 488 489 490
 where showOption n i | n < 10 = " " ++ star i ++ " " ++ rest
                      | otherwise = " " ++ star i ++ rest
                  where rest = show n ++ ") "
                        star True = "*"
                        star False = " "

491 492 493
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)
494 495 496 497 498 499 500
  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."
501
                              promptList' displayItem numChoices choices def other
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
       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
519
  message flags "\nGenerating LICENSE..."
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
  year <- getYear
  let licenseFile =
        case license flags of
          Flag BSD3 -> Just $ bsd3 (fromMaybe "???"
                                  . flagToMaybe
                                  . author
                                  $ flags)
                              (show year)

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

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

          Flag (LGPL (Just (Version {versionBranch = [2]})))
            -> Just lgpl2

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

541 542 543
          Flag (Apache (Just (Version {versionBranch = [2, 0]})))
            -> Just apache20

544 545 546
          _ -> Nothing

  case licenseFile of
547
    Just licenseText -> writeFileSafe flags "LICENSE" licenseText
548 549 550 551 552 553 554 555 556 557 558 559 560
    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..."
561
  writeFileSafe flags "Setup.hs" setupFile
562 563
 where
  setupFile = unlines
564
    [ "import Distribution.Simple"
565 566 567 568 569 570 571 572 573 574
    , "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
  let cabalFileName = p ++ ".cabal"
  message flags $ "Generating " ++ cabalFileName ++ "..."
575
  writeFileSafe flags cabalFileName (generateCabalFile cabalFileName flags)
576 577
  return True

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
-- | 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

605 606 607 608 609 610 611 612 613
-- | 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
614 615
generateCabalFile fileName c =
  renderStyle style { lineLength = 79, ribbonsPerLine = 1.1 } $
EyalLotem's avatar
EyalLotem committed
616
  (if minimal c /= Flag True
617 618 619 620
    then showComment (Just $ "Initial " ++ fileName ++ " generated by cabal "
                          ++ "init.  For further documentation, see "
                          ++ "http://haskell.org/cabal/users-guide/")
         $$ text ""
621 622
    else empty)
  $$
623
  vcat [ fieldS "name"          (packageName   c)
624 625 626
                (Just "The name of the package.")
                True

627
       , field  "version"       (version       c)
628 629 630 631
                (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")
632 633
                True

634
       , fieldS "synopsis"      (synopsis      c)
635 636 637
                (Just "A short (one-line) description of the package.")
                True

638
       , fieldS "description"   NoFlag
639 640 641
                (Just "A longer description of the package.")
                True

642
       , fieldS "homepage"      (homepage     c)
643 644 645
                (Just "URL for the project homepage or repository.")
                False

646
       , fieldS "bug-reports"   NoFlag
647 648 649
                (Just "A URL where users can report bugs.")
                False

650
       , field  "license"       (license      c)
651 652 653
                (Just "The license under which the package is released.")
                True

654
       , fieldS "license-file" (Flag "LICENSE")
655 656 657
                (Just "The file containing the license text.")
                True

658
       , fieldS "author"        (author       c)
659 660 661
                (Just "The package author(s).")
                True

662
       , fieldS "maintainer"    (email        c)
663 664 665
                (Just "An email address to which users can send suggestions, bug reports, and patches.")
                True

666
       , fieldS "copyright"     NoFlag
667 668 669
                (Just "A copyright notice.")
                True

670
       , fieldS "category"      (either id display `fmap` category c)
671 672 673
                Nothing
                True

674
       , fieldS "build-type"    (Flag "Simple")
675 676 677
                Nothing
                True

678
       , fieldS "extra-source-files" (listFieldS (extraSrc c))
679
                (Just "Extra files to be distributed with the package, such as examples or a README.")
680
                True
681

682
       , field  "cabal-version" (Flag $ orLaterVersion (Version [1,10] []))
683 684 685 686 687
                (Just "Constraint on the version of Cabal needed to build this package.")
                False

       , case packageType c of
           Flag Executable ->
EyalLotem's avatar
EyalLotem committed
688
             text "\nexecutable" <+> text (fromMaybe "" . flagToMaybe $ packageName c) $$ nest 2 (vcat
689
             [ fieldS "main-is" NoFlag (Just ".hs or .lhs file containing the Main module.") True
690

691
             , generateBuildInfo Executable c
692
             ])
EyalLotem's avatar
EyalLotem committed
693
           Flag Library    -> text "\nlibrary" $$ nest 2 (vcat
694
             [ fieldS "exposed-modules" (listField (exposedModules c))
695 696 697
                      (Just "Modules exported by the library.")
                      True

698
             , generateBuildInfo Library c
699 700 701 702
             ])
           _               -> empty
       ]
 where
703 704 705 706 707 708
   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.")
709 710
              True

711 712
     , fieldS "build-depends" (listField (dependencies c'))
              (Just "Other library packages from which modules are imported.")
713 714 715
              True

     , fieldS "hs-source-dirs" (listFieldS (sourceDirs c'))
716
              (Just "Directories containing source files.")
717 718
              False

719
     , fieldS "build-tools" (listFieldS (buildTools c'))
720
              (Just "Extra tools (e.g. alex, hsc2hs, ...) needed to build the source.")
721
              False
722 723 724 725

     , field  "default-language" (language c')
              (Just "Base language which the package is written in.")
              True
726 727 728 729 730 731
     ]

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

   listFieldS :: Maybe [String] -> Flag String
732
   listFieldS = Flag . maybe "" (intercalate ", ")
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750

   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
751
                                <> text (replicate (20 - length s) ' ')
752 753 754 755 756 757
                                <> text (fromMaybe "" . flagToMaybe $ f)
   comment NoFlag    = text "-- "
   comment (Flag "") = text "-- "
   comment _         = text ""

   showComment :: Maybe String -> Doc
EyalLotem's avatar
EyalLotem committed
758 759
   showComment (Just t) = vcat
                        . map (text . ("-- "++)) . lines
760 761 762 763
                        . renderStyle style {
                            lineLength = 76,
                            ribbonsPerLine = 1.05
                          }
764 765 766 767
                        . vcat
                        . map (fcat . map text . breakLine)
                        . lines
                        $ t
768 769
   showComment Nothing  = text ""

770 771 772 773 774
   breakLine  [] = []
   breakLine  cs = case break (==' ') cs of (w,cs') -> w : breakLine' cs'
   breakLine' [] = []
   breakLine' cs = case span (==' ') cs of (w,cs') -> w : breakLine cs'

775 776 777 778 779 780 781 782 783 784 785 786 787 788
-- | 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
Duncan Coutts's avatar
Duncan Coutts committed
789