ghc/compiler/main/CodeOutput.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section{Code output phase}
   5
   6 \begin{code}
   7 module CodeOutput( codeOutput ) where
   8
   9 #include "HsVersions.h"
  10
  11 #ifndef OMIT_NATIVE_CODEGEN
  12 import AsmCodeGen       ( nativeCodeGen )
  13 #endif
  14
  15 #ifdef ILX
  16 import IlxGen           ( ilxGen )
  17 #endif
  18
  19 import JavaGen          ( javaGen )
  20 import qualified PrintJava
  21
  22 import TyCon            ( TyCon )
  23 import Id               ( Id )
  24 import Class            ( Class )
  25 import CoreSyn          ( CoreBind )
  26 import StgSyn           ( StgBinding )
  27 import AbsCSyn          ( AbstractC )
  28 import PprAbsC          ( dumpRealC, writeRealC )
  29 import UniqSupply       ( UniqSupply )
  30 import Module           ( Module )
  31 import CmdLineOpts
  32 import ErrUtils         ( dumpIfSet_dyn )
  33 import Outputable
  34 import CmdLineOpts      ( DynFlags, HscLang(..), dopt_OutName )
  35 import TmpFiles         ( newTempName )
  36
  37 import IO               ( IOMode(..), hClose, openFile, Handle )
  38 \end{code}
  39
  40
  41 %************************************************************************
  42 %*                                                                      *
  43 \subsection{Steering}
  44 %*                                                                      *
  45 %************************************************************************
  46
  47 \begin{code}
  48 codeOutput :: DynFlags
  49            -> Module
  50            -> [TyCon] -> [Class]        -- Local tycons and classes
  51            -> [CoreBind]                -- Core bindings
  52            -> [(StgBinding,[Id])]       -- The STG program with SRTs
  53            -> SDoc              -- C stubs for foreign exported functions
  54            -> SDoc              -- Header file prototype for foreign exported functions
  55            -> AbstractC         -- Compiled abstract C
  56            -> UniqSupply
  57            -> IO (Maybe FilePath, Maybe FilePath)
  58 codeOutput dflags mod_name tycons classes core_binds stg_binds
  59            c_code h_code flat_abstractC ncg_uniqs
  60   = -- You can have C (c_output) or assembly-language (ncg_output),
  61     -- but not both.  [Allowing for both gives a space leak on
  62     -- flat_abstractC.  WDP 94/10]
  63
  64     -- Dunno if the above comment is still meaningful now.  JRS 001024.
  65
  66     do let filenm = dopt_OutName dflags
  67        stub_names <- outputForeignStubs dflags c_code h_code
  68        case dopt_HscLang dflags of
  69           HscInterpreter -> return stub_names
  70           HscAsm         -> outputAsm dflags filenm flat_abstractC ncg_uniqs
  71                             >> return stub_names
  72           HscC           -> outputC dflags filenm flat_abstractC
  73                             >> return stub_names
  74           HscJava        -> outputJava dflags filenm mod_name tycons core_binds
  75                             >> return stub_names
  76
  77 doOutput :: String -> (Handle -> IO ()) -> IO ()
  78 doOutput filenm io_action
  79   = (do handle <- openFile filenm WriteMode
  80         io_action handle
  81         hClose handle)
  82     `catch` (\err -> pprPanic "Failed to open or write code output file"
  83                               (text filenm))
  84 \end{code}
  85
  86
  87 %************************************************************************
  88 %*                                                                      *
  89 \subsection{C}
  90 %*                                                                      *
  91 %************************************************************************
  92
  93 \begin{code}
  94 outputC dflags filenm flat_absC
  95   = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
  96        doOutput filenm (\ h -> writeRealC h flat_absC)
  97 \end{code}
  98
  99
 100 %************************************************************************
 101 %*                                                                      *
 102 \subsection{Assembler}
 103 %*                                                                      *
 104 %************************************************************************
 105
 106 \begin{code}
 107 outputAsm dflags filenm flat_absC ncg_uniqs
 108
 109 #ifndef OMIT_NATIVE_CODEGEN
 110
 111   = do dumpIfSet_dyn dflags Opt_D_dump_stix "Final stix code" stix_final
 112        dumpIfSet_dyn dflags Opt_D_dump_asm "Asm code" ncg_output_d
 113        doOutput filenm ( \f -> printForAsm f ncg_output_d)
 114   where
 115     (stix_final, ncg_output_d) = nativeCodeGen flat_absC ncg_uniqs
 116
 117 #else /* OMIT_NATIVE_CODEGEN */
 118
 119   = pprPanic "This compiler was built without a native code generator"
 120              (text "Use -fvia-C instead")
 121
 122 #endif
 123 \end{code}
 124
 125
 126 %************************************************************************
 127 %*                                                                      *
 128 \subsection{Java}
 129 %*                                                                      *
 130 %************************************************************************
 131
 132 \begin{code}
 133 outputJava dflags filenm mod tycons core_binds
 134   = doOutput filenm (\ f -> printForUser f pp_java)
 135         -- User style printing for now to keep indentation
 136   where
 137     java_code = javaGen mod [{- Should be imports-}] tycons core_binds
 138     pp_java   = PrintJava.compilationUnit java_code
 139 \end{code}
 140
 141
 142 %************************************************************************
 143 %*                                                                      *
 144 \subsection{Foreign import/export}
 145 %*                                                                      *
 146 %************************************************************************
 147
 148 \begin{code}
 149 outputForeignStubs dflags c_code h_code
 150   = do
 151         dumpIfSet_dyn dflags Opt_D_dump_foreign
 152                       "Foreign export header file" stub_h_output_d
 153
 154         maybe_stub_h_file
 155            <- outputForeignStubs_help True{-.h output-} stub_h_output_w
 156
 157         dumpIfSet_dyn dflags Opt_D_dump_foreign
 158                       "Foreign export stubs" stub_c_output_d
 159
 160         maybe_stub_c_file
 161            <- outputForeignStubs_help False{-not .h-} stub_c_output_w
 162
 163         return (maybe_stub_h_file, maybe_stub_c_file)
 164   where
 165     -- C stubs for "foreign export"ed functions.
 166     stub_c_output_d = pprCode CStyle c_code
 167     stub_c_output_w = showSDoc stub_c_output_d
 168
 169     -- Header file protos for "foreign export"ed functions.
 170     stub_h_output_d = pprCode CStyle h_code
 171     stub_h_output_w = showSDoc stub_h_output_d
 172
 173
 174 -- Don't use doOutput for dumping the f. export stubs
 175 -- since it is more than likely that the stubs file will
 176 -- turn out to be empty, in which case no file should be created.
 177 outputForeignStubs_help is_header ""      = return Nothing
 178 outputForeignStubs_help is_header doc_str
 179    = newTempName suffix >>= \ fname ->
 180      writeFile fname (include_prefix ++ doc_str) >>
 181      return (Just suffix)
 182   where
 183     suffix
 184        | is_header   = "h_stub"
 185        | otherwise   = "c_stub"
 186     include_prefix
 187        | is_header   = "#include \"Rts.h\"\n"
 188        | otherwise   = "#include \"RtsAPI.h\"\n"
 189 \end{code}
 190