Build on Nixpkgs/NixOS

INSTALL.md

@@ -122,4 +122,21 @@ encounter this then the fix is to augment the `PKG_CONFIG_PATH` for
 
 ```
 PKG_CONFIG_PATH=/usr/local/opt/libffi/lib/pkgconfig stack build
-``` 
+```
+
+## Experimental Support for Building on NixOS or systems with Nixpkgs
+
+To run the full build process:
+
+    nix-build
+
+The resulting build should be on the `result` directory.
+
+If you wish to install it to your environment:
+
+    nix-env -f default.nix -i idris
+
+For local development with Cabal:
+
+    nix-shell
+    cabal install # or build/test/whatever

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build configure doc install linecount nodefault pinstall lib_clean relib fast test_js test_c stylize test test_clean lib_doc lib_doc_clean user_doc_html user_doc_pdf user_docs
+.PHONY: build configure doc install linecount nodefault pinstall lib_clean relib fast test_js test_c stylize test test_clean lib_doc lib_doc_clean user_doc_html user_doc_pdf user_docs rts rts_clean
 
 ARGS=
 TEST-JOBS=
@@ -7,6 +7,10 @@ TEST-ARGS=
 include config.mk
 -include custom.mk
 
+IDRIS ?= $(CURDIR)/dist/build/idris/idris
+CB=env IDRIS=$(IDRIS) $(CABAL)
+MK=+env IDRIS=$(IDRIS) $(MAKE)
+
 ifdef CI
 CABALFLAGS += -f CI
 ifndef APPVEYOR
@@ -15,68 +19,86 @@ endif
 endif
 
 install:
-	$(CABAL) install $(CABALFLAGS)
+	$(CB) install $(CABALFLAGS)
 
 pinstall: CABALFLAGS += --enable-executable-profiling
 pinstall: dist/setup-config
-	$(CABAL) install $(CABALFLAGS)
+	$(CB) install $(CABALFLAGS)
 
 build: dist/setup-config
-	$(CABAL) build $(CABALFLAGS)
+	$(CB) build
+
+$(IDRIS): dist/setup-config
+	$(CB) build "exe:idris"
 
 test: doc test_c stylize
 
 stylize:
 	./stylize.sh
 
 test_c:
-	$(CABAL) test $(ARGS) --test-options \
+	$(CB) test $(ARGS) --test-options \
 		"$(TEST-ARGS) --rerun-update +RTS -N$(TEST-JOBS) -RTS"
 
 test_js:
-	$(CABAL) test $(ARGS) --test-options \
+	$(CB) test $(ARGS) --test-options \
 		"$(TEST-ARGS) --node --rerun-update +RTS -N$(TEST-JOBS) -RTS"
 
 test_update:
-	$(CABAL) test $(ARGS) --test-options \
+	$(CB) test $(ARGS) --test-options \
 		"$(TEST-ARGS) --accept +RTS -N$(TEST-JOBS) -RTS"
 
 test_clean:
 	rm -f test/*~
 	rm -f test/*/output
 
+rts:
+	$(MK) -C rts
+
+rts_install:
+	$(MK) -C rts install
+
+rts_clean:
+	$(MK) -C rts clean
+
+lib:
+	$(MK) -C libs
+
+lib_install:
+	$(MK) -C libs install
+
 lib_clean:
-	$(MAKE) -C libs IDRIS=../../dist/build/idris/idris RTS=../../dist/build/rts/libidris_rts clean
+	$(MK) -C libs clean
+
+lib_doc:
+	+$(MK) -C libs doc
+
+lib_doc_clean:
+	+$(MK) -C libs doc_clean
 
 relib: lib_clean
-	$(CABAL) install $(CABALFLAGS)
+	$(CB) install $(CABALFLAGS)
 
 linecount:
 	wc -l src/Idris/*.hs src/Idris/Elab/*.hs src/Idris/Core/*.hs src/IRTS/*.hs src/Pkg/*.hs src/Util/*.hs
 
 #Note: this doesn't yet link to Hackage properly
 doc: dist/setup-config
-	$(CABAL) haddock --hyperlink-source --html --hoogle --html-location="http://hackage.haskell.org/packages/archive/\$$pkg/latest/doc/html" --haddock-options="--title Idris"
-
-lib_doc:
-	$(MAKE) -C libs IDRIS=../../dist/build/idris/idris doc
-
-lib_doc_clean:
-	$(MAKE) -C libs IDRIS=../../dist/build/idris/idris doc_clean
+	$(CB) haddock --hyperlink-source --html --hoogle --html-location="http://hackage.haskell.org/packages/archive/\$$pkg/latest/doc/html" --haddock-options="--title Idris"
 
 user_docs: user_doc_html user_doc_pdf
 
 user_doc_clean:
-	$(MAKE) -C docs clean
+	$(MK) -C docs clean
 
 user_doc_html:
-	$(MAKE) -C docs html
+	$(MK) -C docs html
 
 user_doc_pdf:
-	$(MAKE) -C docs latexpdf
+	$(MK) -C docs latexpdf
 
 fast:
-	$(CABAL) install $(CABALFLAGS) --ghc-option=-O0
+	$(CB) install $(CABALFLAGS) --ghc-option=-O0
 
 dist/setup-config:
-	$(CABAL) configure $(CABALFLAGS)
+	$(CB) configure $(CABALFLAGS)

Setup.hs

@@ -6,6 +6,8 @@
 
 import Control.Monad
 import Data.IORef
+import Data.Maybe (fromMaybe)
+import Data.List (nub, isInfixOf)
 import Control.Exception (SomeException, catch)
 
 import Distribution.Simple
@@ -36,14 +38,11 @@ import Distribution.Types.UnqualComponentName
 
 -- -----------------------------------------------------------------------------
 -- Idris Command Path
+idrisCmd local = Px.joinPath $ splitDirectories $ ".." </> ".." </> buildDir local </> "idris" </> "idris"
+
+
+shinvoke verbosity cmd = P.runProgramInvocation verbosity . P.simpleProgramInvocation cmd
 
--- make on mingw32 exepects unix style separators
-#ifdef mingw32_HOST_OS
-(<//>) = (Px.</>)
-idrisCmd local = Px.joinPath $ splitDirectories $ ".." <//> ".." <//> buildDir local <//> "idris" <//> "idris"
-#else
-idrisCmd local = ".." </> ".." </>  buildDir local </>  "idris" </>  "idris"
-#endif
 
 -- -----------------------------------------------------------------------------
 -- Make Commands
@@ -55,42 +54,32 @@ mymake = "gmake"
 #else
 mymake = "make"
 #endif
-make verbosity =
-   P.runProgramInvocation verbosity . P.simpleProgramInvocation mymake
+make verbosity = shinvoke verbosity mymake
 
 #ifdef mingw32_HOST_OS
 windres verbosity = P.runProgramInvocation verbosity . P.simpleProgramInvocation "windres"
 #endif
 -- -----------------------------------------------------------------------------
 -- Flags
 
-usesGMP :: S.ConfigFlags -> Bool
-usesGMP flags =
-  case lookupFlagAssignment (mkFlagName "gmp") (S.configConfigurationsFlags flags) of
+
+flag nm flags = case lookupFlagAssignment (mkFlagName nm) (S.configConfigurationsFlags flags) of
     Just True -> True
     Just False -> False
     Nothing -> False
 
+
+usesGMP :: S.ConfigFlags -> Bool
+usesGMP = flag "gmp"
+
 execOnly :: S.ConfigFlags -> Bool
-execOnly flags =
-  case lookupFlagAssignment (mkFlagName "execonly") (S.configConfigurationsFlags flags) of
-    Just True -> True
-    Just False -> False
-    Nothing -> False
+execOnly = flag "execonly"
 
 isRelease :: S.ConfigFlags -> Bool
-isRelease flags =
-    case lookupFlagAssignment (mkFlagName "release") (S.configConfigurationsFlags flags) of
-      Just True -> True
-      Just False -> False
-      Nothing -> False
+isRelease = flag "release"
 
 isFreestanding :: S.ConfigFlags -> Bool
-isFreestanding flags =
-  case lookupFlagAssignment (mkFlagName "freestanding") (S.configConfigurationsFlags flags) of
-    Just True -> True
-    Just False -> False
-    Nothing -> False
+isFreestanding = flag "freestanding"
 
 #if !(MIN_VERSION_Cabal(2,0,0))
 mkFlagName :: String -> FlagName
@@ -105,13 +94,12 @@ lookupFlagAssignment = lookup
 -- -----------------------------------------------------------------------------
 -- Clean
 
-idrisClean _ flags _ _ = cleanStdLib
+idrisClean _ flags _ _ = cleanStdLib >> cleanRts
    where
       verbosity = S.fromFlag $ S.cleanVerbosity flags
 
-      cleanStdLib = makeClean "libs"
-
-      makeClean dir = make verbosity [ "-C", dir, "clean", "IDRIS=idris" ]
+      cleanStdLib = make verbosity ["lib_clean"]
+      cleanRts = make verbosity ["rts_clean"]
 
 -- -----------------------------------------------------------------------------
 -- Configure
@@ -183,12 +171,16 @@ generateToolchainModule verbosity srcDir toolDir = do
     createDirectoryIfMissingVerbose verbosity True srcDir
     rewriteFileEx verbosity toolPath (commonContent ++ toolContent)
 
-idrisConfigure _ flags pkgdesc local = do
+idrisPostConf _ flags pkgdesc local = do
+    nixLDFLAGS <- lookupEnv "NIX_LDFLAGS"
     configureRTS
     withLibLBI pkgdesc local $ \lib libcfg -> do
       let libAutogenDir = autogenComponentModulesDir local libcfg
       let libDirs = extraLibDirs $ libBuildInfo lib
-      generateBuildFlagsModule verbosity libAutogenDir libDirs
+      let nixLibDirs = map (drop 2)
+            $ filter ("-gmp-" `isInfixOf`)
+            $ words $ fromMaybe "" nixLDFLAGS
+      generateBuildFlagsModule verbosity libAutogenDir (nub $ libDirs ++ nixLibDirs)
       generateVersionModule verbosity libAutogenDir (isRelease (configFlags local))
       if isFreestanding $ configFlags local
           then do
@@ -209,7 +201,7 @@ idrisConfigure _ flags pkgdesc local = do
       -- installing but shouldn't be in the distribution. And it won't make the
       -- distribution if it's not there, so instead I just delete
       -- the file after configure.
-      configureRTS = make verbosity ["-C", "rts", "clean"]
+      configureRTS = make verbosity ["rts_clean"]
 
 #if !(MIN_VERSION_Cabal(2,0,0))
       autogenComponentModulesDir lbi _ = autogenModulesDir lbi
@@ -273,27 +265,34 @@ idrisPreBuild args flags = do
         verbosity = S.fromFlag $ S.buildVerbosity flags
         dir = S.fromFlagOrDefault "dist" $ S.buildDistPref flags
 #else
-        return (Nothing, [])
+        preBuild simpleUserHooks args flags
 #endif
 
-idrisBuild _ flags _ local
+idrisBuildHook pd lbi hooks flags = do
+   let exe = ("exe:" ++) . unUnqualComponentName . exeName
+       exes = map exe (executables pd)
+       nflags = case S.buildArgs flags of
+         orig@["regression-and-feature-tests"] ->
+           flags { S.buildArgs = exes ++ orig }
+         _ -> flags
+   buildHook simpleUserHooks pd lbi hooks nflags
+
+
+idrisPostBuild _ flags _ local
    = if (execOnly (configFlags local)) then buildRTS
         else do buildStdLib
                 buildRTS
    where
       verbosity = S.fromFlag $ S.buildVerbosity flags
-
       buildStdLib = do
-            putStrLn "Building libraries..."
-            makeBuild "libs"
-         where
-            makeBuild dir = make verbosity [ "-C", dir, "build" , "IDRIS=" ++ idrisCmd local]
-
-      buildRTS = make verbosity (["-C", "rts", "build"] ++
-                                   gmpflag (usesGMP (configFlags local)))
-
+        putStrLn "Building libraries..."
+        make verbosity [ "-j8", "lib", "IDRIS=" ++ idrisCmd local]
+      buildRTS = do
+        putStrLn "Building runtime..."
+        make verbosity $ ["rts"] ++ gmp
       gmpflag False = []
       gmpflag True = ["GMP=-DIDRIS_GMP"]
+      gmp = gmpflag (usesGMP (configFlags local))
 
 -- -----------------------------------------------------------------------------
 -- Copy/Install
@@ -307,22 +306,22 @@ idrisInstall verbosity copy pkg local
       target = datadir $ L.absoluteInstallDirs pkg local copy
 
       installStdLib = do
-        let target' = target -- </> "libs"
-        putStrLn $ "Installing libraries in " ++ target'
-        makeInstall "libs" target'
+         let target' = target -- </> "libs"
+         putStrLn $ "Installing libraries in " ++ target'
+         make' "lib_install" target'
 
       installRTS = do
          let target' = target </> "rts"
          putStrLn $ "Installing run time system in " ++ target'
-         makeInstall "rts" target'
+         make' "rts_install" target'
 
       installManPage = do
          let mandest = mandir (L.absoluteInstallDirs pkg local copy) ++ "/man1"
          notice verbosity $ unwords ["Copying man page to", mandest]
          installOrdinaryFiles verbosity mandest [("man", "idris.1")]
 
-      makeInstall src target =
-         make verbosity [ "-C", src, "install" , "TARGET=" ++ target, "IDRIS=" ++ idrisCmd local]
+      make' x target =
+         make verbosity [ x, "TARGET=" ++ target, "IDRIS=" ++ idrisCmd local]
 
 -- -----------------------------------------------------------------------------
 -- Test
@@ -335,7 +334,10 @@ fixPkg pkg target = pkg { dataDir = target }
 
 idrisTestHook args pkg local hooks flags = do
   let target = datadir $ L.absoluteInstallDirs pkg local NoCopyDest
-  testHook simpleUserHooks args (fixPkg pkg target) local hooks flags
+  idris <- canonicalizePath (buildDir local </> "idris" </> "idris")
+  setEnv "IDRIS" idris
+--  testHook simpleUserHooks args (fixPkg pkg target) local hooks flags
+  testHook simpleUserHooks args pkg local hooks flags
 
 -- -----------------------------------------------------------------------------
 -- Main
@@ -344,9 +346,10 @@ idrisTestHook args pkg local hooks flags = do
 -- See https://github.com/haskell/cabal/issues/709
 main = defaultMainWithHooks $ simpleUserHooks
    { postClean = idrisClean
-   , postConf  = idrisConfigure
+   , postConf  = idrisPostConf
    , preBuild = idrisPreBuild
-   , postBuild = idrisBuild
+   , buildHook = idrisBuildHook
+   , postBuild = idrisPostBuild
    , postCopy = \_ flags pkg local ->
                   idrisInstall (S.fromFlag $ S.copyVerbosity flags)
                                (S.fromFlag $ S.copyDest flags) pkg local

default.nix

@@ -0,0 +1,2 @@
+{ nixpkgs ? import <nixpkgs> {}, compiler ? "ghc822" }:
+nixpkgs.pkgs.haskell.packages.${compiler}.callPackage ./idris.nix { }

idris.cabal

@@ -108,12 +108,12 @@ custom-setup
 
 Flag FFI
   Description:  Build support for libffi
-  Default:      False
+  Default:      True
   manual:       True
 
 Flag GMP
   Description:  Use GMP for Integers
-  Default:      False
+  Default:      True
   manual:       True
 
 -- This flag determines whether to show Git hashes in version strings