\section{Code output phase}
\begin{code}
-module CodeOutput( codeOutput ) where
+module CodeOutput( codeOutput, outputForeignStubs ) where
#include "HsVersions.h"
-#if ! OMIT_NATIVE_CODEGEN
+#ifndef OMIT_NATIVE_CODEGEN
+import UniqSupply ( mkSplitUniqSupply )
import AsmCodeGen ( nativeCodeGen )
#endif
-import AbsCSyn ( AbstractC, absCNop )
+#ifdef ILX
+import IlxGen ( ilxGen )
+#endif
+
+#ifdef JAVA
+import JavaGen ( javaGen )
+import OccurAnal ( occurAnalyseBinds )
+import qualified PrintJava
+import OccurAnal ( occurAnalyseBinds )
+#endif
+
+import Packages
+import DriverState ( getExplicitPackagesAnd, getPackageCIncludes )
+import FastString ( unpackFS )
+import AbsCSyn ( AbstractC )
import PprAbsC ( dumpRealC, writeRealC )
-import UniqSupply ( UniqSupply )
-import Module ( Module, moduleString )
+import HscTypes
import CmdLineOpts
-import Maybes ( maybeToBool )
-import ErrUtils ( doIfSet, dumpIfSet )
+import ErrUtils ( dumpIfSet_dyn, showPass )
import Outputable
-import IO ( IOMode(..), hPutStr, hClose, openFile, stderr )
+import Pretty ( Mode(..), printDoc )
+import Module ( Module )
+import ListSetOps ( removeDupsEq )
+
+import System.Directory ( doesFileExist )
+import Monad ( when )
+import IO
\end{code}
+%************************************************************************
+%* *
+\subsection{Steering}
+%* *
+%************************************************************************
+
\begin{code}
-codeOutput :: Module
- -> SDoc -- C stubs for foreign exported functions
- -> SDoc -- Header file prototype for foreign exported functions
- -> AbstractC -- Compiled abstract C
- -> UniqSupply
- -> IO ()
-codeOutput mod_name c_code h_code flat_abstractC ncg_uniqs
- = -- You can have C (c_output) or assembly-language (ncg_output),
+codeOutput :: DynFlags
+ -> Module
+ -> ForeignStubs
+ -> Dependencies
+ -> AbstractC -- Compiled abstract C
+ -> IO (Bool{-stub_h_exists-}, Bool{-stub_c_exists-})
+
+codeOutput dflags this_mod foreign_stubs deps flat_abstractC
+ =
+ -- You can have C (c_output) or assembly-language (ncg_output),
-- but not both. [Allowing for both gives a space leak on
-- flat_abstractC. WDP 94/10]
- dumpIfSet opt_D_dump_asm "Asm code" ncg_output_d >>
- doOutput opt_ProduceS ncg_output_w >>
+ -- Dunno if the above comment is still meaningful now. JRS 001024.
+
+ do { showPass dflags "CodeOutput"
+ ; let filenm = dopt_OutName dflags
+ ; stubs_exist <- outputForeignStubs dflags foreign_stubs
+ ; case dopt_HscLang dflags of {
+ HscInterpreted -> return ();
+ HscAsm -> outputAsm dflags filenm flat_abstractC;
+ HscC -> outputC dflags filenm flat_abstractC stubs_exist
+ deps foreign_stubs;
+ HscJava ->
+#ifdef JAVA
+ outputJava dflags filenm mod_name tycons core_binds;
+#else
+ panic "Java support not compiled into this ghc";
+#endif
+ HscILX ->
+#ifdef ILX
+ let tycons = typeEnvTyCons type_env in
+ outputIlx dflags filenm mod_name tycons stg_binds;
+#else
+ panic "ILX support not compiled into this ghc";
+#endif
+ }
+ ; return stubs_exist
+ }
+
+doOutput :: String -> (Handle -> IO ()) -> IO ()
+doOutput filenm io_action = bracket (openFile filenm WriteMode) hClose io_action
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{C}
+%* *
+%************************************************************************
+
+\begin{code}
+outputC dflags filenm flat_absC
+ (stub_h_exists, _) dependencies foreign_stubs
+ = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
+
+ -- figure out which header files to #include in the generated .hc file:
+ --
+ -- * extra_includes from packages
+ -- * -#include options from the cmdline and OPTIONS pragmas
+ -- * the _stub.h file, if there is one.
+ --
+ let packages = dep_pkgs dependencies
+ pkg_configs <- getExplicitPackagesAnd packages
+ let pkg_names = map name pkg_configs
+
+ c_includes <- getPackageCIncludes pkg_configs
+ let cmdline_includes = cmdlineHcIncludes dflags -- -#include options
+
+ ffi_decl_headers
+ = case foreign_stubs of
+ NoStubs -> []
+ ForeignStubs _ _ fdhs _ -> map unpackFS (fst (removeDupsEq fdhs))
+ -- Remove duplicates, because distinct foreign import decls
+ -- may cite the same #include. Order doesn't matter.
+
+ all_headers = c_includes
+ ++ reverse cmdline_includes
+ ++ ffi_decl_headers
+
+ let cc_injects = unlines (map mk_include all_headers)
+ mk_include h_file =
+ case h_file of
+ '"':_{-"-} -> "#include "++h_file
+ '<':_ -> "#include "++h_file
+ _ -> "#include \""++h_file++"\""
+
+ doOutput filenm $ \ h -> do
+ hPutStr h ("/* GHC_PACKAGES " ++ unwords pkg_names ++ "\n*/\n")
+ hPutStr h cc_injects
+ when stub_h_exists $
+ hPutStrLn h ("#include \"" ++ (hscStubHOutName dflags) ++ "\"")
+ writeRealC h flat_absC
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{Assembler}
+%* *
+%************************************************************************
+
+\begin{code}
+outputAsm dflags filenm flat_absC
+
+#ifndef OMIT_NATIVE_CODEGEN
- dumpIfSet opt_D_dump_foreign "Foreign export header file" stub_h_output_d >>
- outputHStub opt_ProduceExportHStubs stub_h_output_w >>
+ = do ncg_uniqs <- mkSplitUniqSupply 'n'
+ let (stix_final, ncg_output_d) = _scc_ "NativeCodeGen"
+ nativeCodeGen flat_absC ncg_uniqs
+ dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
+ dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" (docToSDoc ncg_output_d)
+ _scc_ "OutputAsm" doOutput filenm $
+ \f -> printDoc LeftMode f ncg_output_d
+ where
+
+#else /* OMIT_NATIVE_CODEGEN */
+
+ = pprPanic "This compiler was built without a native code generator"
+ (text "Use -fvia-C instead")
+
+#endif
+\end{code}
- dumpIfSet opt_D_dump_foreign "Foreign export stubs" stub_c_output_d >>
- outputCStub mod_name opt_ProduceExportCStubs stub_c_output_w >>
- dumpIfSet opt_D_dump_realC "Real C" c_output_d >>
- doOutput opt_ProduceC c_output_w
+%************************************************************************
+%* *
+\subsection{Java}
+%* *
+%************************************************************************
+\begin{code}
+#ifdef JAVA
+outputJava dflags filenm mod tycons core_binds
+ = doOutput filenm (\ f -> printForUser f alwaysQualify pp_java)
+ -- User style printing for now to keep indentation
where
- (flat_absC_c, flat_absC_ncg) =
- case (maybeToBool opt_ProduceC || opt_D_dump_realC,
- maybeToBool opt_ProduceS || opt_D_dump_asm) of
- (True, False) -> (flat_abstractC, absCNop)
- (False, True) -> (absCNop, flat_abstractC)
- (False, False) -> (absCNop, absCNop)
- (True, True) -> error "ERROR: Can't do both .hc and .s at the same time"
+ occ_anal_binds = occurAnalyseBinds core_binds
+ -- Make sure we have up to date dead-var information
+ java_code = javaGen mod [{- Should be imports-}] tycons occ_anal_binds
+ pp_java = PrintJava.compilationUnit java_code
+#endif
+\end{code}
+
+%************************************************************************
+%* *
+\subsection{Ilx}
+%* *
+%************************************************************************
+
+\begin{code}
+#ifdef ILX
+outputIlx dflags filename mod tycons stg_binds
+ = doOutput filename (\ f -> printForC f pp_ilx)
+ where
+ pp_ilx = ilxGen mod tycons stg_binds
+#endif
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{Foreign import/export}
+%* *
+%************************************************************************
+
+\begin{code}
+outputForeignStubs :: DynFlags -> ForeignStubs
+ -> IO (Bool, -- Header file created
+ Bool) -- C file created
+outputForeignStubs dflags NoStubs = do
+-- When compiling External Core files, may need to use stub files from a
+-- previous compilation
+ hFileExists <- doesFileExist (hscStubHOutName dflags)
+ cFileExists <- doesFileExist (hscStubCOutName dflags)
+ return (hFileExists, cFileExists)
+outputForeignStubs dflags (ForeignStubs h_code c_code _ _)
+ = do
+ dumpIfSet_dyn dflags Opt_D_dump_foreign
+ "Foreign export header file" stub_h_output_d
+
+ -- we need the #includes from the rts package for the stub files
+ rts_pkgs <- getPackageDetails [rtsPackage]
+ let rts_includes = concatMap mk_include (concatMap c_includes rts_pkgs)
+ mk_include i = "#include \"" ++ i ++ "\"\n"
+
+ stub_h_file_exists
+ <- outputForeignStubs_help (hscStubHOutName dflags) stub_h_output_w
+ ("#include \"HsFFI.h\"\n" ++ cplusplus_hdr) cplusplus_ftr
+
+ dumpIfSet_dyn dflags Opt_D_dump_foreign
+ "Foreign export stubs" stub_c_output_d
+
+ stub_c_file_exists
+ <- outputForeignStubs_help (hscStubCOutName dflags) stub_c_output_w
+ ("#define IN_STG_CODE 0\n" ++
+ "#include \"RtsAPI.h\"\n" ++
+ rts_includes ++
+ cplusplus_hdr)
+ cplusplus_ftr
+ -- We're adding the default hc_header to the stub file, but this
+ -- isn't really HC code, so we need to define IN_STG_CODE==0 to
+ -- avoid the register variables etc. being enabled.
+
+ return (stub_h_file_exists, stub_c_file_exists)
+ where
-- C stubs for "foreign export"ed functions.
stub_c_output_d = pprCode CStyle c_code
stub_c_output_w = showSDoc stub_c_output_d
stub_h_output_d = pprCode CStyle h_code
stub_h_output_w = showSDoc stub_h_output_d
- c_output_d = dumpRealC flat_absC_c
- c_output_w = (\ f -> writeRealC f flat_absC_c)
-
- -- Native code generation done here!
-#if OMIT_NATIVE_CODEGEN
- ncg_output_d = error "*** GHC not built with a native-code generator ***"
- ncg_output_w = ncg_output_d
-#else
- ncg_output_d = nativeCodeGen flat_absC_ncg ncg_uniqs
- ncg_output_w = (\ f -> printForAsm f ncg_output_d)
-#endif
-
+cplusplus_hdr = "#ifdef __cplusplus\nextern \"C\" {\n#endif\n"
+cplusplus_ftr = "#ifdef __cplusplus\n}\n#endif\n"
- -- don't use doOutput for dumping the f. export stubs
- -- since it is more than likely that the stubs file will
- -- turn out to be empty, in which case no file should be created.
-outputCStub mod_name switch ""
- = return ()
-outputCStub mod_name switch doc_str
- = case switch of
- Nothing -> return ()
- Just fname -> writeFile fname ("#include \"Rts.h\"\n#include \"RtsAPI.h\"\n"++rest)
- where
- rest = "#include "++show (moduleString mod_name ++ "_stub.h") ++ '\n':doc_str
-
-outputHStub switch ""
- = return ()
-outputHStub switch doc_str
- = case switch of
- Nothing -> return ()
- Just fname -> writeFile fname ("#include \"Rts.h\"\n"++doc_str)
-
-doOutput switch io_action
- = case switch of
- Nothing -> return ()
- Just fname ->
- openFile fname WriteMode >>= \ handle ->
- io_action handle >>
- hClose handle
+-- Don't use doOutput for dumping the f. export stubs
+-- since it is more than likely that the stubs file will
+-- turn out to be empty, in which case no file should be created.
+outputForeignStubs_help fname "" header footer = return False
+outputForeignStubs_help fname doc_str header footer
+ = do writeFile fname (header ++ doc_str ++ '\n':footer ++ "\n")
+ return True
\end{code}