CodeOutput.lhs 5.67 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
%
% (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
%
\section{Code output phase}

\begin{code}
module CodeOutput( codeOutput ) where

#include "HsVersions.h"

11
#ifndef OMIT_NATIVE_CODEGEN
12 13
import AsmCodeGen	( nativeCodeGen )
#endif
14

15 16 17
#ifdef ILX
import IlxGen		( ilxGen )
#endif
18

19 20 21
import JavaGen		( javaGen )
import qualified PrintJava

22 23
import TyCon		( TyCon )
import Id		( Id )
24
import CoreSyn		( CoreBind )
25
import StgSyn		( StgBinding )
26
import AbsCSyn		( AbstractC )
27
import PprAbsC		( dumpRealC, writeRealC )
28
import Module		( Module )
29
import CmdLineOpts
30
import ErrUtils		( dumpIfSet_dyn )
31
import Outputable
32 33
import CmdLineOpts	( DynFlags, HscLang(..), dopt_OutName )
import TmpFiles		( newTempName )
34
import UniqSupply	( mkSplitUniqSupply )
35

36
import IO		( IOMode(..), hClose, openFile, Handle )
37 38 39
\end{code}


40 41 42 43 44 45
%************************************************************************
%*									*
\subsection{Steering}
%*									*
%************************************************************************

46
\begin{code}
47 48
codeOutput :: DynFlags
	   -> Module
49
	   -> [TyCon]			-- Local tycons
50
	   -> [CoreBind]		-- Core bindings
51
	   -> [(StgBinding,[Id])]	-- The STG program with SRTs
52 53 54
	   -> SDoc 		-- C stubs for foreign exported functions
	   -> SDoc		-- Header file prototype for foreign exported functions
	   -> AbstractC		-- Compiled abstract C
55
	   -> IO (Maybe FilePath, Maybe FilePath)
56 57
codeOutput dflags mod_name tycons core_binds stg_binds 
	   c_code h_code flat_abstractC
58 59 60 61
  = -- 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]

62
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
63

64 65
    do let filenm = dopt_OutName dflags 
       stub_names <- outputForeignStubs dflags c_code h_code
66
       case dopt_HscLang dflags of
67
          HscInterpreted -> return stub_names
68
          HscAsm         -> outputAsm dflags filenm flat_abstractC
69
                            >> return stub_names
70
          HscC           -> outputC dflags filenm flat_abstractC	
71
                            >> return stub_names
72
          HscJava        -> outputJava dflags filenm mod_name tycons core_binds
73
                            >> return stub_names
74

75
doOutput :: String -> (Handle -> IO ()) -> IO ()
76 77
doOutput filenm io_action
  = (do	handle <- openFile filenm WriteMode
78 79
	io_action handle
	hClose handle)
80 81
    `catch` (\err -> pprPanic "Failed to open or write code output file" 
			      (text filenm))
82 83 84 85 86 87 88 89 90 91
\end{code}


%************************************************************************
%*									*
\subsection{C}
%*									*
%************************************************************************

\begin{code}
92
outputC dflags filenm flat_absC
93
  = do dumpIfSet_dyn dflags Opt_D_dump_realC "Real C" (dumpRealC flat_absC)
94
       doOutput filenm (\ h -> writeRealC h flat_absC)
95 96 97 98 99 100 101 102 103 104
\end{code}


%************************************************************************
%*									*
\subsection{Assembler}
%*									*
%************************************************************************

\begin{code}
105
outputAsm dflags filenm flat_absC
106

107
#ifndef OMIT_NATIVE_CODEGEN
108

109
  = do ncg_uniqs <- mkSplitUniqSupply 'n'
110
       let (stix_final, ncg_output_d) = nativeCodeGen flat_absC ncg_uniqs
111
       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 115 116 117
  where

#else /* OMIT_NATIVE_CODEGEN */

118 119
  = pprPanic "This compiler was built without a native code generator"
	     (text "Use -fvia-C instead")
120 121 122

#endif
\end{code}
123 124


125 126 127 128 129
%************************************************************************
%*									*
\subsection{Java}
%*									*
%************************************************************************
130

131
\begin{code}
132 133
outputJava dflags filenm mod tycons core_binds
  = doOutput filenm (\ f -> printForUser f pp_java)
134
	-- User style printing for now to keep indentation
135
  where
136 137 138
    java_code = javaGen mod [{- Should be imports-}] tycons core_binds
    pp_java   = PrintJava.compilationUnit java_code
\end{code}
139

140 141 142 143 144 145 146 147

%************************************************************************
%*									*
\subsection{Foreign import/export}
%*									*
%************************************************************************

\begin{code}
148
outputForeignStubs dflags c_code h_code
149
  = do
150
	dumpIfSet_dyn dflags Opt_D_dump_foreign
151 152 153 154
                      "Foreign export header file" stub_h_output_d

	maybe_stub_h_file
           <- outputForeignStubs_help True{-.h output-} stub_h_output_w
155

156
	dumpIfSet_dyn dflags Opt_D_dump_foreign
157 158 159 160 161 162
                      "Foreign export stubs" stub_c_output_d

        maybe_stub_c_file
           <- outputForeignStubs_help False{-not .h-} stub_c_output_w

        return (maybe_stub_h_file, maybe_stub_c_file)
163
  where
164 165 166 167 168 169 170 171 172
    -- C stubs for "foreign export"ed functions.
    stub_c_output_d = pprCode CStyle c_code
    stub_c_output_w = showSDoc stub_c_output_d

    -- Header file protos for "foreign export"ed functions.
    stub_h_output_d = pprCode CStyle h_code
    stub_h_output_w = showSDoc stub_h_output_d


173 174 175
-- 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.
176 177 178 179 180
outputForeignStubs_help is_header ""      = return Nothing
outputForeignStubs_help is_header doc_str 
   = newTempName suffix >>= \ fname ->
     writeFile fname (include_prefix ++ doc_str) >>
     return (Just suffix)
181 182 183 184 185
  where
    suffix
       | is_header   = "h_stub"
       | otherwise   = "c_stub"
    include_prefix
186
       | is_header   = "#include \"HsFFI.h\"\n"
187
       | otherwise   = "#include \"RtsAPI.h\"\n"
188 189
\end{code}