Merge pull request #99 from everythingfunctional/MakefileSupport

Add support for Makefiles and generic build scripts

Author: everythingfunctional

PACKAGING.md

@@ -12,6 +12,8 @@ for it to successfully build with the Fortran Package Manager (FPM).
   - [Multi-level library](#multi-level-library)
   - [Be more explicit](#be-more-explicit)
   - [Add some tests](#add-some-tests)
+  - [Adding dependencies](#adding-dependencies)
+  - [Custom build scripts](#custom-build-scripts)
 
 ## What kind of package can FPM build?
 
@@ -662,3 +664,38 @@ You can even specify the path to another folder, if for example you've got anoth
 fpm package in the same repository. Like this: `helloff = { path = "helloff" }`.
 Note that you should *not* specify paths outside of your repository, or things
 won't work for your users.
+
+### Custom Build Scripts
+
+If there is something special about your library that makes fpm unable to build
+it, you can provide your own build script. fpm will then simply call your
+build script to build the library.
+
+To specify a build script to be used, put it in the library section of your
+`fpm.toml` file, like:
+
+```toml
+[library]
+source-dir="src"
+build-script="my_build_script"
+```
+
+fpm will set the following environment variables to specify some parameters to
+the build script.
+
+* `FC` - The Fortran compiler to be used
+* `FFLAGS` - The flags that should be passed to the Fortran compiler
+* `BUILD_DIR` - Where the compiled files should be placed
+* `INCLUDE_DIRS` - The folders where any dependencies can be found, space seperated.
+    It is then the responsibility of the build script to generate the appropriate
+    include flags.
+
+Additionally, script will be called with the name of the archive (`*.a` file)
+that should be produced as the command line argument.
+
+> Note: If the name of the build script is `Makefile` or ends with `.mk`, then
+> the make program will be used to run it. Not the the archive file is explicitly
+> specified as the target to be built
+
+> Note: All file and directory names are specified with their full canonical
+> path.

package.yaml

@@ -25,6 +25,7 @@ dependencies:
 - directory
 - extra
 - filepath
+- MissingH
 - optparse-applicative
 - process
 - shake

src/Build.hs

@@ -1,6 +1,8 @@
+{-# LANGUAGE MultiWayIf #-}
 module Build
   ( buildLibrary
   , buildProgram
+  , buildWithScript
   )
 where
 
@@ -10,7 +12,10 @@ import           Data.Char                      ( isAsciiLower
                                                 , isDigit
                                                 , toLower
                                                 )
-import           Data.List                      ( intercalate )
+import           Data.List                      ( intercalate
+                                                , isSuffixOf
+                                                )
+import           Data.List.Utils                ( replace )
 import qualified Data.Map                      as Map
 import           Data.Maybe                     ( fromMaybe
                                                 , mapMaybe
@@ -42,8 +47,13 @@ import           Development.Shake.FilePath     ( dropExtension
                                                 , (<.>)
                                                 , (-<.>)
                                                 )
-import           System.Directory               ( makeAbsolute )
+import           System.Directory               ( createDirectoryIfMissing
+                                                , makeAbsolute
+                                                , withCurrentDirectory
+                                                )
+import           System.Environment             ( setEnv )
 import           System.FilePath                ( splitDirectories )
+import           System.Process                 ( system )
 import           Text.ParserCombinators.ReadP   ( ReadP
                                                 , char
                                                 , eof
@@ -359,3 +369,52 @@ digit = satisfy isDigit
 
 underscore :: ReadP Char
 underscore = char '_'
+
+buildWithScript
+  :: String
+  -> FilePath
+  -> FilePath
+  -> FilePath
+  -> [String]
+  -> String
+  -> [FilePath]
+  -> IO (FilePath)
+buildWithScript script projectDirectory buildDirectory compiler flags libraryName otherLibraryDirectories
+  = do
+    absoluteBuildDirectory <- makeAbsolute buildDirectory
+    createDirectoryIfMissing True absoluteBuildDirectory
+    absoluteLibraryDirectories <- mapM makeAbsolute otherLibraryDirectories
+    setEnv "FC"     compiler
+    setEnv "FFLAGS" (intercalate " " flags)
+    setEnv "BUILD_DIR" $ unWindowsPath absoluteBuildDirectory
+    setEnv
+      "INCLUDE_DIRS"
+      (intercalate " " (map unWindowsPath absoluteLibraryDirectories))
+    let archiveFile =
+          (unWindowsPath absoluteBuildDirectory)
+            ++ "/lib"
+            ++  libraryName
+            <.> "a"
+    withCurrentDirectory
+      projectDirectory
+      if
+        | isMakefile script -> system
+          ("make -f " ++ script ++ " " ++ archiveFile)
+        | otherwise -> system (script ++ " " ++ archiveFile)
+    return archiveFile
+
+isMakefile :: String -> Bool
+isMakefile script | script == "Makefile"      = True
+                  | script == "makefile"      = True
+                  | ".mk" `isSuffixOf` script = True
+                  | otherwise                 = False
+
+unWindowsPath :: String -> String
+unWindowsPath = changeSeparators . removeDriveLetter
+
+removeDriveLetter :: String -> String
+removeDriveLetter path | ':' `elem` path = (tail . dropWhile (/= ':')) path
+                       | otherwise       = path
+
+changeSeparators :: String -> String
+changeSeparators = replace "\\" "/"

src/Fpm.hs

@@ -11,9 +11,13 @@ where
 
 import           Build                          ( buildLibrary
                                                 , buildProgram
+                                                , buildWithScript
                                                 )
 import           Control.Monad.Extra            ( concatMapM )
-import           Data.List                      (isSuffixOf,  find, nub )
+import           Data.List                      ( isSuffixOf
+                                                , find
+                                                , nub
+                                                )
 import qualified Data.Map                      as Map
 import qualified Data.Text.IO                  as TIO
 import           Development.Shake              ( FilePattern
@@ -79,7 +83,7 @@ data AppSettings = AppSettings {
     , appSettingsDevDependencies :: (Map.Map String Version)
 }
 
-data Library = Library { librarySourceDir :: String }
+data Library = Library { librarySourceDir :: String, libraryBuildScript :: Maybe String }
 
 data Executable = Executable {
       executableSourceDir :: String
@@ -102,6 +106,7 @@ data DependencyTree = Dependency {
       dependencyName :: String
     , dependencyPath :: FilePath
     , dependencySourcePath :: FilePath
+    , dependencyBuildScript :: Maybe String
     , dependencyDependencies :: [DependencyTree]
 }
 
@@ -117,8 +122,8 @@ start args = do
 
 app :: Arguments -> AppSettings -> IO ()
 app args settings = case command' args of
-  Build     -> build settings
-  Run whichOne  -> do
+  Build        -> build settings
+  Run whichOne -> do
     build settings
     let buildPrefix = appSettingsBuildPrefix settings
     let
@@ -133,13 +138,15 @@ app args settings = case command' args of
     case canonicalExecutables of
       [] -> putStrLn "No Executables Found"
       _  -> case whichOne of
-        "" -> mapM_ system (map (++ " " ++ commandArguments args) canonicalExecutables)
+        "" -> mapM_
+          system
+          (map (++ " " ++ commandArguments args) canonicalExecutables)
         name -> do
-            case find (name `isSuffixOf`) canonicalExecutables of
-              Nothing -> putStrLn "Executable Not Found"
-              Just specified -> do
-                  system (specified ++ " " ++ (commandArguments args))
-                  return ()
+          case find (name `isSuffixOf`) canonicalExecutables of
+            Nothing        -> putStrLn "Executable Not Found"
+            Just specified -> do
+              system (specified ++ " " ++ (commandArguments args))
+              return ()
   Test whichOne -> do
     build settings
     let buildPrefix = appSettingsBuildPrefix settings
@@ -155,13 +162,15 @@ app args settings = case command' args of
     case canonicalExecutables of
       [] -> putStrLn "No Tests Found"
       _  -> case whichOne of
-        "" -> mapM_ system (map (++ " " ++ commandArguments args) canonicalExecutables)
+        "" -> mapM_
+          system
+          (map (++ " " ++ commandArguments args) canonicalExecutables)
         name -> do
-            case find (name `isSuffixOf`) canonicalExecutables of
-              Nothing -> putStrLn "Test Not Found"
-              Just specified -> do
-                  system (specified ++ " " ++ (commandArguments args))
-                  return ()
+          case find (name `isSuffixOf`) canonicalExecutables of
+            Nothing        -> putStrLn "Test Not Found"
+            Just specified -> do
+              system (specified ++ " " ++ (commandArguments args))
+              return ()
 
 build :: AppSettings -> IO ()
 build settings = do
@@ -183,15 +192,24 @@ build settings = do
             { dependencyName         = projectName
             , dependencyPath         = "."
             , dependencySourcePath   = librarySourceDir'
+            , dependencyBuildScript  = libraryBuildScript librarySettings
             , dependencyDependencies = mainDependencyTrees
             }
-      thisArchive <- buildLibrary librarySourceDir'
-                                  [".f90", ".f", ".F", ".F90", ".f95", ".f03"]
-                                  (buildPrefix </> projectName)
-                                  compiler
-                                  flags
-                                  projectName
-                                  (map fst builtDependencies)
+      thisArchive <- case libraryBuildScript librarySettings of
+        Just script -> buildWithScript script
+                                       "."
+                                       (buildPrefix </> projectName)
+                                       compiler
+                                       flags
+                                       projectName
+                                       (map fst builtDependencies)
+        Nothing -> buildLibrary librarySourceDir'
+                                [".f90", ".f", ".F", ".F90", ".f95", ".f03"]
+                                (buildPrefix </> projectName)
+                                compiler
+                                flags
+                                projectName
+                                (map fst builtDependencies)
       return
         $ ( (buildPrefix </> projectName, thisArchive) : builtDependencies
           , Just thisDependencyTree
@@ -263,13 +281,18 @@ arguments =
                      (info buildArguments (progDesc "Build the executable"))
           )
     <*> switch (long "release" <> help "Build in release mode")
-    <*> strOption (long "args" <> metavar "ARGS" <> value "" <> help "Arguments to pass to executables/tests")
+    <*> strOption
+          (long "args" <> metavar "ARGS" <> value "" <> help
+            "Arguments to pass to executables/tests"
+          )
 
 runArguments :: Parser Command
-runArguments = Run <$> strArgument (metavar "EXE" <> value "" <> help "Which executable to run")
+runArguments = Run <$> strArgument
+  (metavar "EXE" <> value "" <> help "Which executable to run")
 
 testArguments :: Parser Command
-testArguments = Test <$> strArgument (metavar "TEST" <> value "" <> help "Which test to run")
+testArguments =
+  Test <$> strArgument (metavar "TEST" <> value "" <> help "Which test to run")
 
 buildArguments :: Parser Command
 buildArguments = pure Build
@@ -297,7 +320,12 @@ settingsCodec =
     .=  tomlSettingsDevDependencies
 
 libraryCodec :: TomlCodec Library
-libraryCodec = Library <$> Toml.string "source-dir" .= librarySourceDir
+libraryCodec =
+  Library
+    <$> Toml.string "source-dir"
+    .=  librarySourceDir
+    <*> Toml.dioptional (Toml.string "build-script")
+    .=  libraryBuildScript
 
 executableCodec :: TomlCodec Executable
 executableCodec =
@@ -419,7 +447,10 @@ getLibrarySettings maybeSettings = case maybeSettings of
   Nothing       -> do
     defaultExists <- doesDirectoryExist "src"
     if defaultExists
-      then return (Just (Library { librarySourceDir = "src" }))
+      then return
+        (Just
+          (Library { librarySourceDir = "src", libraryBuildScript = Nothing })
+        )
       else return Nothing
 
 getExecutableSettings :: [Executable] -> String -> IO [Executable]
@@ -490,6 +521,7 @@ fetchDependencies dependencies = do
           { dependencyName         = name
           , dependencyPath         = path
           , dependencySourcePath   = path </> (librarySourceDir librarySettings)
+          , dependencyBuildScript  = libraryBuildScript librarySettings
           , dependencyDependencies = newDependencies
           }
       Nothing -> do
@@ -500,7 +532,7 @@ fetchExecutableDependencies
   :: (Maybe DependencyTree) -> Map.Map String Version -> IO [DependencyTree]
 fetchExecutableDependencies maybeProjectTree dependencies =
   case maybeProjectTree of
-    Just projectTree@(Dependency name _ _ _) ->
+    Just projectTree@(Dependency name _ _ _ _) ->
       if name `Map.member` dependencies {- map contains this project-}
         then fmap (projectTree :)
                   (fetchDependencies (Map.delete name dependencies)) {- fetch the other dependencies and include the project tree in the result -}
@@ -524,6 +556,7 @@ fetchExecutableDependencies maybeProjectTree dependencies =
           { dependencyName         = name
           , dependencyPath         = path
           , dependencySourcePath   = path </> (librarySourceDir librarySettings)
+          , dependencyBuildScript  = libraryBuildScript librarySettings
           , dependencyDependencies = newDependencies
           }
       Nothing -> do
@@ -573,18 +606,26 @@ buildDependencies buildPrefix compiler flags dependencies = do
 
 buildDependency
   :: String -> String -> [String] -> DependencyTree -> IO [(FilePath, FilePath)]
-buildDependency buildPrefix compiler flags (Dependency name path sourcePath dependencies)
+buildDependency buildPrefix compiler flags (Dependency name path sourcePath mBuildScript dependencies)
   = do
     transitiveDependencies <- buildDependencies buildPrefix
                                                 compiler
                                                 flags
                                                 dependencies
     let buildPath = buildPrefix </> name
-    thisArchive <- buildLibrary sourcePath
-                                [".f90", ".f", ".F", ".F90", ".f95", ".f03"]
-                                buildPath
-                                compiler
-                                flags
-                                name
-                                (map fst transitiveDependencies)
+    thisArchive <- case mBuildScript of
+      Just script -> buildWithScript script
+                                     path
+                                     buildPath
+                                     compiler
+                                     flags
+                                     name
+                                     (map fst transitiveDependencies)
+      Nothing -> buildLibrary sourcePath
+                              [".f90", ".f", ".F", ".F90", ".f95", ".f03"]
+                              buildPath
+                              compiler
+                              flags
+                              name
+                              (map fst transitiveDependencies)
     return $ (buildPath, thisArchive) : transitiveDependencies

test/Spec.hs

@@ -13,6 +13,8 @@ main = do
   testHelloComplex
   testHelloFpm
   testCircular
+  testWithMakefile
+  testMakefileComplex
 
 testHelloWorld :: IO ()
 testHelloWorld =
@@ -29,3 +31,11 @@ testHelloFpm =
 testCircular :: IO ()
 testCircular =
     withCurrentDirectory (example_path </> "circular_example") $ start $ Arguments (Test "") False ""
+
+testWithMakefile :: IO ()
+testWithMakefile =
+    withCurrentDirectory (example_path </> "with_makefile") $ start $ Arguments (Build) False ""
+
+testMakefileComplex :: IO ()
+testMakefileComplex =
+    withCurrentDirectory (example_path </> "makefile_complex") $ start $ Arguments (Run "") False ""

test/example_packages/makefile_complex/.gitignore

@@ -0,0 +1 @@
+build/*