Init.hs 30 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
  ( orLaterVersion, earlierVersion, intersectVersionRanges, VersionRange )
58 59 60
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
import Distribution.Client.Init.Heuristics
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
72 73
  ( guessPackageName, guessAuthorNameMail, SourceFileEntry(..),
    scanForModules, neededBuildPrograms )
74 75 76 77 78 79 80 81

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

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

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

  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf

103 104
  hSetBuffering stdout NoBuffering

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

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

  when success $ generateWarnings initFlags'

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

-- | Fill in more details by guessing, discovering, or prompting the
--   user.
119 120 121 122 123 124 125 126 127
extendFlags :: PackageIndex -> InitFlags -> IO InitFlags
extendFlags pkgIx =
      getPackageName
  >=> getVersion
  >=> getLicense
  >=> getAuthorInfo
  >=> getHomepage
  >=> getSynopsis
  >=> getCategory
128
  >=> getExtraSourceFiles
129
  >=> getLibOrExec
130
  >=> getLanguage
131 132 133
  >=> getGenComments
  >=> getSrcDir
  >=> getModulesBuildToolsAndDeps pkgIx
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 161

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

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

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

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

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

  return $ flags { packageType = maybeToFlag isLib }

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

  return $ flags { language = maybeToFlag lang }

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

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

  return $ flags { sourceDirs = srcDirs }

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

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

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

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

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

327 328
  deps <-      return (dependencies flags)
           ?>> Just <$> importsToDeps flags
329 330 331 332 333 334 335 336
                        (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
                           )
                        )
337 338
                        pkgIx

339 340 341
  exts <-     return (otherExts flags)
          ?>> (return . Just . nub . concatMap extensions $ sourceFiles)

342 343 344
  return $ flags { exposedModules = Just mods
                 , buildTools     = tools
                 , dependencies   = deps
345
                 , otherExts      = exts
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 380 381 382 383 384
                 }

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
385
                  message flags "You will need to pick one and manually add it to the Build-depends: field."
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
                  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
403 404 405 406 407 408 409 410 411 412 413 414
    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
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432

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

433 434 435 436 437 438 439 440 441 442 443 444
-- | 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"

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
-- | 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
471 472
mkDefPrompt pr def = pr ++ "?" ++ defStr def
  where defStr Nothing  = " "
473 474 475 476 477 478 479 480 481 482 483
        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
484
    rearrange = either (Just . Left) (fmap Right)
485 486

-- | Create a prompt from a list of items.
487
promptList :: Eq t
488 489 490
           => String            -- ^ prompt
           -> [t]               -- ^ choices
           -> Maybe t           -- ^ optional default value
491
           -> (t -> String)     -- ^ show an item
492 493
           -> Bool              -- ^ whether to allow an 'other' option
           -> IO (Either String t)
494
promptList pr choices def displayItem other = do
495
  putStrLn $ pr ++ ":"
496
  let options1 = map (\c -> (Just c == def, displayItem c)) choices
497
      options2 = zip ([1..]::[Int])
EyalLotem's avatar
EyalLotem committed
498
                     (options1 ++ [(False, "Other (specify)") | other])
499
  mapM_ (putStrLn . \(n,(i,s)) -> showOption n i ++ s) options2
500
  promptList' displayItem (length options2) choices def other
501 502 503 504 505 506
 where showOption n i | n < 10 = " " ++ star i ++ " " ++ rest
                      | otherwise = " " ++ star i ++ rest
                  where rest = show n ++ ") "
                        star True = "*"
                        star False = " "

507 508 509
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)
510 511 512 513 514 515 516
  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."
517
                              promptList' displayItem numChoices choices def other
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
       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
535
  message flags "\nGenerating LICENSE..."
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
  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

557 558 559
          Flag (Apache (Just (Version {versionBranch = [2, 0]})))
            -> Just apache20

560 561 562
          _ -> Nothing

  case licenseFile of
563
    Just licenseText -> writeFileSafe flags "LICENSE" licenseText
564 565 566 567 568 569 570 571 572 573 574 575 576
    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..."
577
  writeFileSafe flags "Setup.hs" setupFile
578 579
 where
  setupFile = unlines
580
    [ "import Distribution.Simple"
581 582 583 584 585 586 587 588 589 590
    , "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 ++ "..."
591
  writeFileSafe flags cabalFileName (generateCabalFile cabalFileName flags)
592 593
  return True

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
-- | 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

621 622 623 624 625 626 627 628 629
-- | 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
630 631
generateCabalFile fileName c =
  renderStyle style { lineLength = 79, ribbonsPerLine = 1.1 } $
EyalLotem's avatar
EyalLotem committed
632
  (if minimal c /= Flag True
633 634 635 636
    then showComment (Just $ "Initial " ++ fileName ++ " generated by cabal "
                          ++ "init.  For further documentation, see "
                          ++ "http://haskell.org/cabal/users-guide/")
         $$ text ""
637 638
    else empty)
  $$
639
  vcat [ fieldS "name"          (packageName   c)
640 641 642
                (Just "The name of the package.")
                True

643
       , field  "version"       (version       c)
644 645 646 647
                (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")
648 649
                True

650
       , fieldS "synopsis"      (synopsis      c)
651 652 653
                (Just "A short (one-line) description of the package.")
                True

654
       , fieldS "description"   NoFlag
655 656 657
                (Just "A longer description of the package.")
                True

658
       , fieldS "homepage"      (homepage     c)
659 660 661
                (Just "URL for the project homepage or repository.")
                False

662
       , fieldS "bug-reports"   NoFlag
663 664 665
                (Just "A URL where users can report bugs.")
                False

666
       , field  "license"       (license      c)
667 668 669
                (Just "The license under which the package is released.")
                True

670
       , fieldS "license-file" (Flag "LICENSE")
671 672 673
                (Just "The file containing the license text.")
                True

674
       , fieldS "author"        (author       c)
675 676 677
                (Just "The package author(s).")
                True

678
       , fieldS "maintainer"    (email        c)
679 680 681
                (Just "An email address to which users can send suggestions, bug reports, and patches.")
                True

682
       , fieldS "copyright"     NoFlag
683 684 685
                (Just "A copyright notice.")
                True

686
       , fieldS "category"      (either id display `fmap` category c)
687 688 689
                Nothing
                True

690
       , fieldS "build-type"    (Flag "Simple")
691 692 693
                Nothing
                True

694
       , fieldS "extra-source-files" (listFieldS (extraSrc c))
695
                (Just "Extra files to be distributed with the package, such as examples or a README.")
696
                True
697

698
       , field  "cabal-version" (Flag $ orLaterVersion (Version [1,10] []))
699 700 701 702 703
                (Just "Constraint on the version of Cabal needed to build this package.")
                False

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

707
             , generateBuildInfo Executable c
708
             ])
EyalLotem's avatar
EyalLotem committed
709
           Flag Library    -> text "\nlibrary" $$ nest 2 (vcat
710
             [ fieldS "exposed-modules" (listField (exposedModules c))
711 712 713
                      (Just "Modules exported by the library.")
                      True

714
             , generateBuildInfo Library c
715 716 717 718
             ])
           _               -> empty
       ]
 where
719 720 721 722 723 724
   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.")
725 726
              True

727 728 729 730
     , fieldS "other-extensions" (listField (otherExts c'))
              (Just "LANGUAGE extensions used by modules in this package.")
              True

731 732
     , fieldS "build-depends" (listField (dependencies c'))
              (Just "Other library packages from which modules are imported.")
733 734 735
              True

     , fieldS "hs-source-dirs" (listFieldS (sourceDirs c'))
736
              (Just "Directories containing source files.")
737
              True
738

739
     , fieldS "build-tools" (listFieldS (buildTools c'))
740
              (Just "Extra tools (e.g. alex, hsc2hs, ...) needed to build the source.")
741
              False
742 743 744 745

     , field  "default-language" (language c')
              (Just "Base language which the package is written in.")
              True
746 747 748 749 750 751
     ]

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

   listFieldS :: Maybe [String] -> Flag String
752
   listFieldS = Flag . maybe "" (intercalate ", ")
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770

   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
771
                                <> text (replicate (20 - length s) ' ')
772 773 774 775 776 777
                                <> text (fromMaybe "" . flagToMaybe $ f)
   comment NoFlag    = text "-- "
   comment (Flag "") = text "-- "
   comment _         = text ""

   showComment :: Maybe String -> Doc
EyalLotem's avatar
EyalLotem committed
778 779
   showComment (Just t) = vcat
                        . map (text . ("-- "++)) . lines
780 781 782 783
                        . renderStyle style {
                            lineLength = 76,
                            ribbonsPerLine = 1.05
                          }
784 785 786 787
                        . vcat
                        . map (fcat . map text . breakLine)
                        . lines
                        $ t
788 789
   showComment Nothing  = text ""

790 791 792 793 794
   breakLine  [] = []
   breakLine  cs = case break (==' ') cs of (w,cs') -> w : breakLine' cs'
   breakLine' [] = []
   breakLine' cs = case span (==' ') cs of (w,cs') -> w : breakLine cs'

795 796 797 798 799 800 801 802 803 804 805 806 807 808
-- | 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