Regenerate .travis.yml
[hsc2hs.git] / Main.hs
diff --git a/Main.hs b/Main.hs
index bed632e..c3f63b6 100644 (file)
--- a/Main.hs
+++ b/Main.hs
@@ -1,5 +1,4 @@
-{-# OPTIONS -cpp #-}
-{-# LANGUAGE CPP, ForeignFunctionInterface #-}
+{-# LANGUAGE CPP #-}
 
 ------------------------------------------------------------------------
 -- Program for converting .hsc files to .hs files, by converting the
 --
 -- See the documentation in the Users' Guide for more details.
 
-#if defined(__GLASGOW_HASKELL__) && !defined(BUILD_NHC)
-#include "../../includes/ghcconfig.h"
-#endif
-
 import Control.Monad            ( liftM, forM_ )
 import Data.List                ( isSuffixOf )
 import System.Console.GetOpt
 
+-- If we ware building the hsc2hs
+-- binary for binary distribution
+-- in the GHC tree.  Obtain
+-- the path to the @$topdir/lib@
+-- folder, and try to locate the
+-- @template-hsc.h@ there.
+--
+-- XXX: Note this does not work
+--      on windows due to for
+--      symlinks. See Trac #14483.
+
 #if defined(mingw32_HOST_OS)
 import Foreign
 import Foreign.C.String
 #endif
 import System.Directory         ( doesFileExist, findExecutable )
-import System.Environment       ( getProgName, getArgs )
+import System.Environment       ( getProgName )
 import System.Exit              ( ExitCode(..), exitWith )
+import System.FilePath          ( normalise, splitFileName, splitExtension )
 import System.IO
 
 #ifdef BUILD_NHC
 import System.Directory         ( getCurrentDirectory )
 #else
-import Data.Version             ( showVersion )
 import Paths_hsc2hs as Main     ( getDataFileName, version )
+import Data.Version             ( showVersion )
+#endif
+#if defined(IN_GHC_TREE)
+import System.Environment       ( getExecutablePath )
+import System.FilePath          ( takeDirectory, (</>) )
+#endif
+#if MIN_VERSION_base(4,12,0)
+import GHC.ResponseFile         ( getArgsWithResponseFiles )
+#else
+import System.Environment       ( getArgs )
 #endif
 
 import Common
 import CrossCodegen
 import DirectCodegen
+import Flags
 import HSCParser
 
+#ifdef mingw32_HOST_OS
+# if defined(i386_HOST_ARCH)
+#  define WINDOWS_CCONV stdcall
+# elif defined(x86_64_HOST_ARCH)
+#  define WINDOWS_CCONV ccall
+# else
+#  error Unknown mingw32 arch
+# endif
+#endif
+
 #ifdef BUILD_NHC
 getDataFileName s = do here <- getCurrentDirectory
                        return (here++"/"++s)
-version = "0.67" -- TODO!!!
-showVersion = id
 #endif
 
 versionString :: String
 versionString = "hsc2hs version " ++ showVersion version ++ "\n"
 
-template_flag :: Flag -> Bool
-template_flag (Template _) = True
-template_flag _                   = False
-
-include :: String -> Flag
-include s@('\"':_) = Include s
-include s@('<' :_) = Include s
-include s          = Include ("\""++s++"\"")
-
-define :: String -> Flag
-define s = case break (== '=') s of
-    (name, [])      -> Define name Nothing
-    (name, _:value) -> Define name (Just value)
-
-options :: [OptDescr Flag]
-options = [
-    Option ['o'] ["output"]     (ReqArg Output     "FILE")
-        "name of main output file",
-    Option ['t'] ["template"]   (ReqArg Template   "FILE")
-        "template file",
-    Option ['c'] ["cc"]         (ReqArg Compiler   "PROG")
-        "C compiler to use",
-    Option ['l'] ["ld"]         (ReqArg Linker     "PROG")
-        "linker to use",
-    Option ['C'] ["cflag"]      (ReqArg CompFlag   "FLAG")
-        "flag to pass to the C compiler",
-    Option ['I'] []             (ReqArg (CompFlag . ("-I"++)) "DIR")
-        "passed to the C compiler",
-    Option ['L'] ["lflag"]      (ReqArg LinkFlag   "FLAG")
-        "flag to pass to the linker",
-    Option ['i'] ["include"]    (ReqArg include    "FILE")
-        "as if placed in the source",
-    Option ['D'] ["define"]     (ReqArg define "NAME[=VALUE]")
-        "as if placed in the source",
-    Option []    ["no-compile"] (NoArg  NoCompile)
-        "stop after writing *_hsc_make.c",
-    Option ['x'] ["cross-compile"] (NoArg CrossCompile)
-        "activate cross-compilation mode",
-    Option [] ["cross-safe"] (NoArg CrossSafe)
-        "restrict .hsc directives to those supported by --cross-compile",
-    Option ['k'] ["keep-files"] (NoArg KeepFiles)
-        "do not remove temporary files",
-    Option ['v'] ["verbose"]    (NoArg  Verbose)
-        "dump commands to stderr",
-    Option ['?'] ["help"]       (NoArg  Help)
-        "display this help and exit",
-    Option ['V'] ["version"]    (NoArg  Version)
-        "output version information and exit" ]
-
 main :: IO ()
 main = do
     prog <- getProgramName
     let header = "Usage: "++prog++" [OPTIONS] INPUT.hsc [...]\n"
         usage = usageInfo header options
+#if MIN_VERSION_base(4,12,0)
+    args <- getArgsWithResponseFiles
+#else
     args <- getArgs
-    let (flags, files, errs) = getOpt Permute options args
-    case (files, errs) of
-        (_, _)
-            | any isHelp    flags -> bye usage
-            | any isVersion flags -> bye versionString
-            where
-            isHelp    Help    = True; isHelp    _ = False
-            isVersion Version = True; isVersion _ = False
-        ((_:_), []) -> processFiles flags files usage
-        (_,     _ ) -> die (concat errs ++ usage)
+#endif
+    let (fs, files, errs) = getOpt Permute options args
+    let mode = foldl (.) id fs emptyMode
+    case mode of
+        Help     -> bye usage
+        Version  -> bye versionString
+        UseConfig config ->
+            case (files, errs) of
+            ((_:_), []) -> processFiles config files usage
+            (_,     _ ) -> die (concat errs ++ usage)
 
 getProgramName :: IO String
 getProgramName = liftM (`withoutSuffix` "-bin") getProgName
@@ -124,85 +103,33 @@ getProgramName = liftM (`withoutSuffix` "-bin") getProgName
 bye :: String -> IO a
 bye s = putStr s >> exitWith ExitSuccess
 
-processFiles :: [Flag] -> [FilePath] -> String -> IO ()
-processFiles flags files usage = do
+processFiles :: ConfigM Maybe -> [FilePath] -> String -> IO ()
+processFiles configM files usage = do
     mb_libdir <- getLibDir
 
-    -- If there's no template specified on the commandline, try to locate it
-    flags_w_tpl <- case filter template_flag flags of
-        [_] -> return flags
-        (_:_) -> -- take only the last --template flag on the cmd line
-                 let (before,tpl:after) = break template_flag (reverse flags)
-                 in return $ reverse (before ++ tpl : filter (not.template_flag) after)
-        [] -> do -- If there is no Template flag explicitly specified, try
-                 -- to find one. We first look near the executable.  This only
-                 -- works on Win32 or Hugs (getExecDir). If this finds a template
-                 -- file then it's certainly the one we want, even if hsc2hs isn't
-                 -- installed where we told Cabal it would be installed.
-                 --
-                 -- Next we try the location we told Cabal about.
-                 --
-                 -- If neither of the above work, then hopefully we're on Unix and
-                 -- there's a wrapper script which specifies an explicit template flag.
-                 mb_templ1 <-
-                   case mb_libdir of
-                   Nothing   -> return Nothing
-                   Just path -> do
-                   -- Euch, this is horrible. Unfortunately
-                   -- Paths_hsc2hs isn't too useful for a
-                   -- relocatable binary, though.
-                     let 
-#if defined(NEW_GHC_LAYOUT)
-                         templ1 = path ++ "/template-hsc.h"
-#else
-                         templ1 = path ++ "/hsc2hs-" ++ showVersion Main.version ++ "/template-hsc.h"
-#endif
-                         incl = path ++ "/include/"
-                     exists1 <- doesFileExist templ1
-                     if exists1
-                        then return $ Just (Template templ1,
-                                            CompFlag ("-I" ++ incl))
-                        else return Nothing
-                 case mb_templ1 of
-                     Just (templ1, incl) -> return (templ1 : flags ++ [incl])
-                     Nothing -> do
-                         templ2 <- getDataFileName "template-hsc.h"
-                         exists2 <- doesFileExist templ2
-                         if exists2 then return (Template templ2 : flags)
-                                    else die ("No template specified, and template-hsc.h not located.\n\n" ++ usage)
-
-    compiler <- case [c | Compiler c <- flags_w_tpl] of
-        []  -> do
-                  -- if this hsc2hs is part of a GHC installation on
-                  -- Windows, then we should use the mingw gcc that
-                  -- comes with GHC (#3929)
-                  case mb_libdir of
-                    Nothing -> search_path   
-                    Just d  -> do
-                      let inplace_gcc = d ++ "/../mingw/bin/gcc.exe"
-                      b <- doesFileExist inplace_gcc
-                      if b then return inplace_gcc else search_path
-            where
-                search_path = do
-                  mb_path <- findExecutable default_compiler
-                  case mb_path of
-                      Nothing -> die ("Can't find "++default_compiler++"\n")
-                      Just path -> return path
-        cs  -> return (last cs)
+    (template, extraFlags) <- findTemplate usage mb_libdir configM
+    compiler <- findCompiler mb_libdir configM
+    let linker = case cmLinker configM of
+                 Nothing -> compiler
+                 Just l -> l
+        config = Config {
+                     cmTemplate    = Id template,
+                     cmCompiler    = Id compiler,
+                     cmLinker      = Id linker,
+                     cKeepFiles    = cKeepFiles configM,
+                     cNoCompile    = cNoCompile configM,
+                     cCrossCompile = cCrossCompile configM,
+                     cViaAsm       = cViaAsm configM,
+                     cCrossSafe    = cCrossSafe configM,
+                     cColumn       = cColumn configM,
+                     cVerbose      = cVerbose configM,
+                     cFlags        = cFlags configM ++ extraFlags
+                 }
 
-    let crossCompiling = not $ null [() | CrossCompile <- flags_w_tpl]
-        beVerbose    = not $ null [() | Verbose <- flags_w_tpl]
-        keepFiles = not $ null [() | KeepFiles <- flags_w_tpl]
-
-    outputter <- if crossCompiling
-          then return (outputCross beVerbose keepFiles compiler flags_w_tpl)
-          else do linker <- case [l | Linker l <- flags_w_tpl] of
-                      []  -> return compiler
-                      ls  -> return (last ls)
-                  return (outputDirect flags_w_tpl beVerbose keepFiles compiler linker)
+    let outputter = if cCrossCompile config then outputCross else outputDirect
 
     forM_ files (\name -> do
-        (outName, outDir, outBase) <- case [f | Output f <- flags_w_tpl] of
+        (outName, outDir, outBase) <- case [f | Output f <- cFlags config] of
              [] -> if not (null ext) && last ext == 'c'
                       then return (dir++base++init ext,  dir, base)
                       else
@@ -210,16 +137,103 @@ processFiles flags files usage = do
                             then return (dir++base++"_out.hs", dir, base)
                             else return (dir++base++".hs",     dir, base)
                    where
-                    (dir,  file) = splitName name
-                    (base, ext)  = splitExt  file
+                    (dir,  file) = splitFileName  name
+                    (base, ext)  = splitExtension file
              [f] -> let
-                 (dir,  file) = splitName f
-                 (base, _)    = splitExt file
+                 (dir,  file) = splitFileName  f
+                 (base, _)    = splitExtension file
                  in return (f, dir, base)
              _ -> onlyOne "output file"
-        let file_name = dosifyPath name
+        let file_name = normalise name
         toks <- parseFile file_name
-        outputter outName outDir outBase file_name toks)
+        outputter config outName outDir outBase file_name toks)
+
+findTemplate :: String -> Maybe FilePath -> ConfigM Maybe
+             -> IO (FilePath, [Flag])
+findTemplate usage mb_libdir config
+ = -- If there's no template specified on the commandline, try to locate it
+   case cmTemplate config of
+   Just t ->
+       return (t, [])
+   Nothing -> do
+     -- If there is no Template flag explicitly specified, try
+     -- to find one. We first look near the executable.  This only
+     -- works on Win32 or Hugs (getExecDir). If this finds a template
+     -- file then it's certainly the one we want, even if hsc2hs isn't
+     -- installed where we told Cabal it would be installed.
+     --
+     -- Next we try the location we told Cabal about.
+     --
+     -- If IN_GHC_TREE is defined (-fin-ghc-tree), we also try to locate
+     -- the template in the `baseDir`, as provided by the `ghc-boot`
+     -- library. Note that this is a hack to work around only partial
+     -- relocatable support in cabal, and is here to allow the hsc2hs
+     -- built and shipped with ghc to be relocatable with the ghc
+     -- binary distribution it ships with.
+     --
+     -- If neither of the above work, then hopefully we're on Unix and
+     -- there's a wrapper script which specifies an explicit template flag.
+     mb_templ1 <-
+       case mb_libdir of
+       Nothing   -> return Nothing
+       Just path -> do
+       -- Euch, this is horrible. Unfortunately
+       -- Paths_hsc2hs isn't too useful for a
+       -- relocatable binary, though.
+         let
+             templ1 = path ++ "/template-hsc.h"
+             incl = path ++ "/include/"
+         exists1 <- doesFileExist templ1
+         if exists1
+            then return $ Just (templ1, CompFlag ("-I" ++ incl))
+            else return Nothing
+     mb_templ2 <- case mb_templ1 of
+         Just (templ1, incl) ->
+             return $ Just (templ1, [incl])
+         Nothing -> do
+             templ2 <- getDataFileName "template-hsc.h"
+             exists2 <- doesFileExist templ2
+             if exists2
+                then return $ Just (templ2, [])
+                else return Nothing
+     case mb_templ2 of
+         Just x -> return x
+#if defined(IN_GHC_TREE)
+         Nothing -> do
+             -- XXX: this will *not* work on windows for symlinks, until `getExecutablePath` in `base` is
+             --      fixed. The alternative would be to bring the whole logic from the SysTools module in here
+             --      which is rather excessive. See Trac #14483.
+             let getBaseDir = Just . (\p -> p </> "lib") . takeDirectory . takeDirectory <$> getExecutablePath
+             mb_templ3 <- fmap (</> "template-hsc.h") <$> getBaseDir
+             mb_exists3 <- mapM doesFileExist mb_templ3
+             case (mb_templ3, mb_exists3) of
+                 (Just templ3, Just True) -> return (templ3, [])
+                 _ -> die ("No template specified, and template-hsc.h not located.\n\n" ++ usage)
+#else
+         Nothing -> die ("No template specified, and template-hsc.h not located.\n\n" ++ usage)
+#endif
+
+findCompiler :: Maybe FilePath -> ConfigM Maybe -> IO FilePath
+findCompiler mb_libdir config
+ = case cmCompiler config of
+   Just c -> return c
+   Nothing ->
+       do let search_path = do
+                  mb_path <- findExecutable default_compiler
+                  case mb_path of
+                      Nothing ->
+                          die ("Can't find "++default_compiler++"\n")
+                      Just path -> return path
+              -- if this hsc2hs is part of a GHC installation on
+              -- Windows, then we should use the mingw gcc that
+              -- comes with GHC (#3929)
+              inplaceGccs = case mb_libdir of
+                            Nothing -> []
+                            Just d  -> [d ++ "/../mingw/bin/gcc.exe"]
+              search [] = search_path
+              search (x : xs) = do b <- doesFileExist x
+                                   if b then return x else search xs
+          search inplaceGccs
 
 parseFile :: String -> IO [Token]
 parseFile name
@@ -234,15 +248,11 @@ parseFile name
        let s' = filter ('\r' /=) s
        case runParser parser name s' of
          Success _ _ _ toks -> return toks
-         Failure (SourcePos name' line) msg ->
-           die (name'++":"++show line++": "++msg++"\n")
+         Failure (SourcePos name' line col) msg ->
+           die (name'++":"++show line++":"++show col++": "++msg++"\n")
 
 getLibDir :: IO (Maybe String)
-#if defined(NEW_GHC_LAYOUT)
 getLibDir = fmap (fmap (++ "/lib")) $ getExecDir "/bin/hsc2hs.exe"
-#else
-getLibDir = getExecDir "/bin/hsc2hs.exe"
-#endif
 
 -- (getExecDir cmd) returns the directory in which the current
 --                  executable, which should be called 'cmd', is running
@@ -252,19 +262,21 @@ getExecDir :: String -> IO (Maybe String)
 getExecDir cmd =
     getExecPath >>= maybe (return Nothing) removeCmdSuffix
     where initN n = reverse . drop n . reverse
-          removeCmdSuffix = return . Just . initN (length cmd) . unDosifyPath
+          removeCmdSuffix = return . Just . initN (length cmd) . normalise
 
 getExecPath :: IO (Maybe String)
 #if defined(mingw32_HOST_OS)
-getExecPath =
-     allocaArray len $ \buf -> do
-         ret <- getModuleFileName nullPtr buf len
-         if ret == 0 then return Nothing
-                    else liftM Just $ peekCString buf
-    where len = 2048 -- Plenty, PATH_MAX is 512 under Win32.
+getExecPath = try_size 2048 -- plenty, PATH_MAX is 512 under Win32.
+  where
+    try_size size = allocaArray (fromIntegral size) $ \buf -> do
+        ret <- c_GetModuleFileName nullPtr buf size
+        case ret of
+          0 -> return Nothing
+          _ | ret < size -> fmap Just $ peekCWString buf
+            | otherwise  -> try_size (size * 2)
 
-foreign import stdcall unsafe "GetModuleFileNameA"
-    getModuleFileName :: Ptr () -> CString -> Int -> IO Int32
+foreign import WINDOWS_CCONV unsafe "windows.h GetModuleFileNameW"
+  c_GetModuleFileName :: Ptr () -> CWString -> Word32 -> IO Word32
 #else
 getExecPath = return Nothing
 #endif