{-# LANGUAGE CPP #-} module Pkg.Package where import System.Process import System.Directory import System.Exit import System.IO import System.FilePath ((), addTrailingPathSeparator, takeFileName, takeDirectory, normalise) import System.Directory (createDirectoryIfMissing, copyFile) import Util.System import Control.Monad import Control.Monad.Trans.State.Strict (execStateT) import Control.Monad.Trans.Except (runExceptT) import Data.List import Data.List.Split(splitOn) import Idris.Core.TT import Idris.REPL import Idris.Parser (loadModule) import Idris.Output (pshow) import Idris.AbsSyntax import Idris.IdrisDoc import Idris.IBC import Idris.Output import Idris.Imports import Pkg.PParser import IRTS.System -- To build a package: -- * read the package description -- * check all the library dependencies exist -- * invoke the makefile if there is one -- * invoke idris on each module, with idris_opts -- * install everything into datadir/pname, if install flag is set -- | Run the package through the idris compiler. buildPkg :: Bool -> (Bool, FilePath) -> IO () buildPkg warnonly (install, fp) = do pkgdesc <- parseDesc fp dir <- getCurrentDirectory let idx = PkgIndex (pkgIndex (pkgname pkgdesc)) ok <- mapM (testLib warnonly (pkgname pkgdesc)) (libdeps pkgdesc) when (and ok) $ do m_ist <- inPkgDir pkgdesc $ do make (makefile pkgdesc) case (execout pkgdesc) of Nothing -> buildMods (idx : NoREPL : Verbose : idris_opts pkgdesc) (modules pkgdesc) Just o -> do let exec = dir o buildMods (idx : NoREPL : Verbose : Output exec : idris_opts pkgdesc) [idris_main pkgdesc] case m_ist of Nothing -> exitWith (ExitFailure 1) Just ist -> do -- Quit with error code if there was a problem case errSpan ist of Just _ -> exitWith (ExitFailure 1) _ -> return () when install $ installPkg pkgdesc -- | Type check packages only -- -- This differs from build in that executables are not built, if the -- package contains an executable. checkPkg :: Bool -- ^ Show Warnings -> Bool -- ^ quit on failure -> FilePath -- ^ Path to ipkg file. -> IO () checkPkg warnonly quit fpath = do pkgdesc <- parseDesc fpath ok <- mapM (testLib warnonly (pkgname pkgdesc)) (libdeps pkgdesc) when (and ok) $ do res <- inPkgDir pkgdesc $ do make (makefile pkgdesc) buildMods (NoREPL : Verbose : idris_opts pkgdesc) (modules pkgdesc) when quit $ case res of Nothing -> exitWith (ExitFailure 1) Just res' -> do case errSpan res' of Just _ -> exitWith (ExitFailure 1) _ -> return () -- | Check a package and start a REPL replPkg :: FilePath -> Idris () replPkg fp = do orig <- getIState runIO $ checkPkg False False fp pkgdesc <- runIO $ parseDesc fp -- bzzt, repetition! let opts = idris_opts pkgdesc let mod = idris_main pkgdesc let f = toPath (showCG mod) putIState orig dir <- runIO $ getCurrentDirectory runIO $ setCurrentDirectory $ dir sourcedir pkgdesc if (f /= "") then idrisMain ((Filename f) : opts) else iputStrLn "Can't start REPL: no main module given" runIO $ setCurrentDirectory dir where toPath n = foldl1' () $ splitOn "." n -- | Clean Package build files cleanPkg :: FilePath -- ^ Path to ipkg file. -> IO () cleanPkg fp = do pkgdesc <- parseDesc fp dir <- getCurrentDirectory inPkgDir pkgdesc $ do clean (makefile pkgdesc) mapM_ rmIBC (modules pkgdesc) rmIdx (pkgname pkgdesc) case execout pkgdesc of Nothing -> return () Just s -> rmFile $ dir s -- | Generate IdrisDoc for package -- TODO: Handle case where module does not contain a matching namespace -- E.g. from prelude.ipkg: IO, Prelude.Chars, Builtins -- -- Issue number #1572 on the issue tracker -- https://github.com/idris-lang/Idris-dev/issues/1572 documentPkg :: FilePath -- ^ Path to .ipkg file. -> IO () documentPkg fp = do pkgdesc <- parseDesc fp cd <- getCurrentDirectory let pkgDir = cd takeDirectory fp outputDir = cd pkgname pkgdesc ++ "_doc" opts = NoREPL : Verbose : idris_opts pkgdesc mods = modules pkgdesc fs = map (foldl1' () . splitOn "." . showCG) mods setCurrentDirectory $ pkgDir sourcedir pkgdesc make (makefile pkgdesc) setCurrentDirectory pkgDir let run l = runExceptT . execStateT l load [] = return () load (f:fs) = do loadModule f; load fs loader = do idrisMain opts; addImportDir (sourcedir pkgdesc); load fs idrisInstance <- run loader idrisInit setCurrentDirectory cd case idrisInstance of Left err -> do putStrLn $ pshow idrisInit err; exitWith (ExitFailure 1) Right ist -> do docRes <- generateDocs ist mods outputDir case docRes of Right _ -> return () Left msg -> do putStrLn msg exitWith (ExitFailure 1) -- | Build a package with a sythesized main function that runs the tests testPkg :: FilePath -> IO () testPkg fp = do pkgdesc <- parseDesc fp ok <- mapM (testLib True (pkgname pkgdesc)) (libdeps pkgdesc) when (and ok) $ do m_ist <- inPkgDir pkgdesc $ do make (makefile pkgdesc) -- Get a temporary file to save the tests' source in (tmpn, tmph) <- tempIdr hPutStrLn tmph $ "module Test_______\n" ++ concat ["import " ++ show m ++ "\n" | m <- modules pkgdesc] ++ "namespace Main\n" ++ " main : IO ()\n" ++ " main = do " ++ concat [show t ++ "\n " | t <- idris_tests pkgdesc] hClose tmph (tmpn', tmph') <- tempfile hClose tmph' m_ist <- idris (Filename tmpn : NoREPL : Verbose : Output tmpn' : idris_opts pkgdesc) rawSystem tmpn' [] return m_ist case m_ist of Nothing -> exitWith (ExitFailure 1) Just ist -> do -- Quit with error code if problem building case errSpan ist of Just _ -> exitWith (ExitFailure 1) _ -> return () where tempIdr :: IO (FilePath, Handle) tempIdr = do dir <- getTemporaryDirectory openTempFile (normalise dir) "idristests.idr" -- | Install package installPkg :: PkgDesc -> IO () installPkg pkgdesc = inPkgDir pkgdesc $ do case (execout pkgdesc) of Nothing -> do mapM_ (installIBC (pkgname pkgdesc)) (modules pkgdesc) installIdx (pkgname pkgdesc) Just o -> return () -- do nothing, keep executable locally, for noe mapM_ (installObj (pkgname pkgdesc)) (objs pkgdesc) -- ---------------------------------------------------------- [ Helper Methods ] -- Methods for building, testing, installing, and removal of idris -- packages. buildMods :: [Opt] -> [Name] -> IO (Maybe IState) buildMods opts ns = do let f = map (toPath . showCG) ns idris (map Filename f ++ opts) where toPath n = foldl1' () $ splitOn "." n testLib :: Bool -> String -> String -> IO Bool testLib warn p f = do d <- getDataDir gcc <- getCC (tmpf, tmph) <- tempfile hClose tmph let libtest = d "rts" "libtest.c" e <- rawSystem gcc [libtest, "-l" ++ f, "-o", tmpf] case e of ExitSuccess -> return True _ -> do if warn then do putStrLn $ "Not building " ++ p ++ " due to missing library " ++ f return False else fail $ "Missing library " ++ f rmIBC :: Name -> IO () rmIBC m = rmFile $ toIBCFile m rmIdx :: String -> IO () rmIdx p = do let f = pkgIndex p ex <- doesFileExist f when ex $ rmFile f toIBCFile (UN n) = str n ++ ".ibc" toIBCFile (NS n ns) = foldl1' () (reverse (toIBCFile n : map str ns)) installIBC :: String -> Name -> IO () installIBC p m = do let f = toIBCFile m d <- getTargetDir let destdir = d p getDest m putStrLn $ "Installing " ++ f ++ " to " ++ destdir createDirectoryIfMissing True destdir copyFile f (destdir takeFileName f) return () where getDest (UN n) = "" getDest (NS n ns) = foldl1' () (reverse (getDest n : map str ns)) installIdx :: String -> IO () installIdx p = do d <- getTargetDir let f = pkgIndex p let destdir = d p putStrLn $ "Installing " ++ f ++ " to " ++ destdir createDirectoryIfMissing True destdir copyFile f (destdir takeFileName f) return () installObj :: String -> String -> IO () installObj p o = do d <- getTargetDir let destdir = addTrailingPathSeparator (d p) putStrLn $ "Installing " ++ o ++ " to " ++ destdir createDirectoryIfMissing True destdir copyFile o (destdir takeFileName o) return () #ifdef mingw32_HOST_OS mkDirCmd = "mkdir " #else mkDirCmd = "mkdir -p " #endif inPkgDir :: PkgDesc -> IO a -> IO a inPkgDir pkgdesc action = do dir <- getCurrentDirectory when (sourcedir pkgdesc /= "") $ do putStrLn $ "Entering directory `" ++ ("." sourcedir pkgdesc) ++ "'" setCurrentDirectory $ dir sourcedir pkgdesc res <- action when (sourcedir pkgdesc /= "") $ do putStrLn $ "Leaving directory `" ++ ("." sourcedir pkgdesc) ++ "'" setCurrentDirectory dir return res -- ------------------------------------------------------- [ Makefile Commands ] -- | Invoke a Makefile's default target. make :: Maybe String -> IO () make Nothing = return () make (Just s) = do rawSystem "make" ["-f", s] return () -- | Invoke a Makefile's clean target. clean :: Maybe String -> IO () clean Nothing = return () clean (Just s) = do rawSystem "make" ["-f", s, "clean"] return () -- --------------------------------------------------------------------- [ EOF ]