CodeOutput.lhs 5.75 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 24
import TyCon		( TyCon )
import Id		( Id )
import Class		( Class )
25
import CoreSyn		( CoreBind )
26
import StgSyn		( StgBinding )
27
import AbsCSyn		( AbstractC )
28 29
import PprAbsC		( dumpRealC, writeRealC )
import UniqSupply	( UniqSupply )
30
import Module		( Module )
31
import CmdLineOpts
32
import ErrUtils		( dumpIfSet_dyn )
33
import Outputable
34 35 36
import CmdLineOpts	( DynFlags(..), HscLang(..) )
import TmpFiles		( newTmpName )

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


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

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

64
    -- Dunno if the above comment is still meaningful now.  JRS 001024.
65

66 67 68 69 70 71 72 73 74
    do stub_names <- outputForeignStubs c_code h_code
       case dopt_HscLang dflags of
          HscInterpreter -> return stub_names
          HscAsm  filenm -> outputAsm dflags filenm flat_abstractC ncg_uniqs
                            >> return stub_names
          HscC    filenm -> outputC dflags filenm flat_abstractC	
                            >> return stub_names
          HscJava filenm -> outputJava dflags filenm mod_name tycons core_binds
                            >> return stub_names
75

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


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

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


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

\begin{code}
106 107
outputAsm dflags filenm flat_absC ncg_uniqs

108
#ifndef OMIT_NATIVE_CODEGEN
109

110 111 112
  = do dumpIfSet_dyn Opt_D_dump_stix dflags "Final stix code" stix_final
       dumpIfSet_dyn Opt_D_dump_asm dflags "Asm code" ncg_output_d
       doOutput filenm ( \f -> printForAsm f ncg_output_d)
113 114 115 116 117
  where
    (stix_final, ncg_output_d) = nativeCodeGen flat_absC ncg_uniqs

#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 151 152 153 154
	dumpIfSet_dyn Opt_D_dump_foreign dflags 
                      "Foreign export header file" stub_h_output_d

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

156 157 158 159 160 161 162
	dumpIfSet_dyn Opt_D_dump_foreign dflags 
                      "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
outputForeignStubs_help is_header switch ""      = return Nothing
177
outputForeignStubs_help is_header switch doc_str =
sof's avatar
sof committed
178
  case switch of
179 180 181 182 183 184 185 186 187 188 189
    Nothing    -> return Nothing
    Just fname -> newTempName suffix >>= \ fname ->
                  writeFile fname (include_prefix ++ doc_str) >>
                  return (Just suffix)
  where
    suffix
       | is_header   = "h_stub"
       | otherwise   = "c_stub"
    include_prefix
       | is_header   = "#include \"Rts.h\"\n"
       | otherwise   = "#include \"RtsAPI.h\"\n"
190 191
\end{code}