Modules.hs 13 KB
Newer Older
1 2 3
{- |
    Module      :  $Header$
    Description :  Compilation of a single module
Björn Peemöller 's avatar
Björn Peemöller committed
4 5 6 7
    Copyright   :  (c) 1999 - 2004 Wolfgang Lux
                       2005        Martin Engelke
                       2007        Sebastian Fischer
                       2011 - 2013 Björn Peemöller
8 9 10 11 12 13 14 15 16 17
    License     :  OtherLicense

    Maintainer  :  bjp@informatik.uni-kiel.de
    Stability   :  experimental
    Portability :  portable

    This module controls the compilation of modules.
-}

module Modules
18
  ( compileModule, loadModule, checkModuleHeader, checkModule, writeOutput
19 20
  ) where

21
import Control.Monad (unless, when)
22 23
import Control.Monad.IO.Class
import Control.Monad.Trans.Either
24
import Data.Maybe (fromMaybe)
25
import Text.PrettyPrint
26 27

import Curry.Base.Ident
Björn Peemöller 's avatar
Björn Peemöller committed
28 29
import Curry.Base.Message (runMsg)
import Curry.Base.Position
30 31 32 33
import Curry.ExtendedFlat.InterfaceEquality (eqInterface)
import Curry.Files.Filenames
import Curry.Files.PathUtils

Björn Peemöller 's avatar
Björn Peemöller committed
34 35
import Base.Messages
  (Message, message, posMessage, warn, abortWithMessages)
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

-- source representations
import qualified Curry.AbstractCurry as AC
import qualified Curry.ExtendedFlat.Type as EF
import qualified Curry.Syntax as CS
import qualified IL as IL

import Checks
import CompilerEnv
import CompilerOpts
import Exports
import Generators
import Imports
import Interfaces
import ModuleSummary
import Transformations

-- The function 'compileModule' is the main entry-point of this
-- module for compiling a Curry source module. Depending on the command
-- line options it will emit either C code or FlatCurry code (standard
-- or in XML
-- representation) or AbstractCurry code (typed, untyped or with type
-- signatures) for the module. Usually the first step is to
-- check the module. Then the code is translated into the intermediate
-- language. If necessary, this phase will also update the module's
-- interface file. The resulting code then is either written out (in
-- FlatCurry or XML format) or translated further into C code.
-- The untyped  AbstractCurry representation is written
-- out directly after parsing and simple checking the source file.
-- The typed AbstractCurry code is written out after checking the module.
66
--
67 68 69
-- The compiler automatically loads the prelude when compiling any
-- module, except for the prelude itself, by adding an appropriate import
-- declaration to the module.
70
--
71 72 73 74 75 76 77
-- Since this modified version of the Muenster Curry Compiler is used
-- as a frontend for PAKCS, all functions for evaluating goals and generating
-- C code are obsolete and commented out.

compileModule :: Options -> FilePath -> IO ()
compileModule opts fn = do
  loaded <- loadModule opts fn
78 79 80 81
  checked <- runEitherT $ checkModule opts loaded
  case checked of
    Left errs -> abortWithMessages errs
    Right (env, mdl) -> do
82
      warn opts $ warnCheck opts env mdl
83
      writeParsed opts fn mdl
84
      writeOutput opts fn (env, mdl)
85 86 87

writeOutput :: Options -> FilePath -> (CompilerEnv, CS.Module) -> IO ()
writeOutput opts fn (env, modul) = do
88 89 90
  let (env1, qlfd) = qual opts env modul
  doDump opts (DumpQualified, env1, show $ CS.ppModule qlfd)
  writeAbstractCurry opts fn env1 qlfd
91 92 93 94
  when withFlat $ do
    -- checkModule checks types, and then transModule introduces new
    -- functions (by lambda lifting in 'desugar'). Consequence: The
    -- types of the newly introduced functions are not inferred (hsi)
95
    let (env2, il, dumps) = transModule opts env1 qlfd
96 97 98
    -- dump intermediate results
    mapM_ (doDump opts) dumps
    -- generate target code
99 100
    let intf = exportInterface env2 qlfd
    let modSum = summarizeModule (tyConsEnv env2) intf qlfd
101 102 103 104
    writeFlat opts fn env2 modSum il
  where
  withFlat = any (`elem` optTargetTypes opts)
              [FlatCurry, FlatXml, ExtendedFlatCurry]
105 106 107 108 109 110 111

-- ---------------------------------------------------------------------------
-- Loading a module
-- ---------------------------------------------------------------------------

loadModule :: Options -> FilePath -> IO (CompilerEnv, CS.Module)
loadModule opts fn = do
112 113
  mbSrc <- readModule fn
  case mbSrc of
Björn Peemöller 's avatar
Björn Peemöller committed
114
    Nothing  -> abortWithMessages [message $ text $ "Missing file: " ++ fn] -- TODO
115 116
    Just src -> do
      -- parse module
117
      case runMsg $ CS.parseModule fn src of
Björn Peemöller 's avatar
Björn Peemöller committed
118 119 120 121 122 123 124 125 126 127 128 129
        Left err -> abortWithMessages [err]
        Right (parsed, _) -> do
          -- check module header
          let (mdl, hdrErrs) = checkModuleHeader opts fn parsed
          unless (null hdrErrs) $ abortWithMessages hdrErrs -- TODO
          -- load the imported interfaces into an InterfaceEnv
          (iEnv, intfErrs) <- loadInterfaces (optImportPaths opts) mdl
          unless (null intfErrs) $ abortWithMessages intfErrs -- TODO
          -- add information of imported modules
          let (env, impErrs) = importModules opts mdl iEnv
          unless (null impErrs) $ abortWithMessages impErrs -- TODO
          return (env, mdl)
130

131
checkModuleHeader :: Options -> FilePath -> CS.Module -> (CS.Module, [Message])
132
checkModuleHeader opts fn = checkModuleId fn
133
                          . importPrelude opts fn
134
                          . CS.patchModuleId fn
135 136

-- |Check whether the 'ModuleIdent' and the 'FilePath' fit together
137
checkModuleId :: FilePath -> CS.Module -> (CS.Module, [Message])
138
checkModuleId fn m@(CS.Module mid _ _ _)
139
  | last (midQualifiers mid) == takeBaseName fn
140 141 142 143 144 145 146 147 148
  = (m, [])
  | otherwise
  = (m, [errModuleFileMismatch mid])

-- An implicit import of the prelude is added to the declarations of
-- every module, except for the prelude itself, or when the import is disabled
-- by a compiler option. If no explicit import for the prelude is present,
-- the prelude is imported unqualified, otherwise a qualified import is added.

149 150
importPrelude :: Options -> FilePath -> CS.Module -> CS.Module
importPrelude opts fn m@(CS.Module mid es is ds)
151 152 153 154 155 156 157 158 159
    -- the Prelude itself
  | mid == preludeMIdent          = m
    -- disabled by compiler option
  | noImpPrelude                  = m
    -- already imported
  | preludeMIdent `elem` imported = m
    -- let's add it!
  | otherwise                     = CS.Module mid es (preludeImp : is) ds
  where
160
  noImpPrelude = NoImplicitPrelude `elem` optExtensions opts
161
  preludeImp   = CS.ImportDecl (first fn) preludeMIdent
162 163 164 165
                  False   -- qualified?
                  Nothing -- no alias
                  Nothing -- no selection of types, functions, etc.
  imported     = [imp | (CS.ImportDecl _ imp _ _ _) <- is]
166 167 168 169 170

-- ---------------------------------------------------------------------------
-- Checking a module
-- ---------------------------------------------------------------------------

171
-- TODO: The order of the checks should be improved!
172 173 174
-- TODO (2012-01-05, bjp): The export specification check for untyped
--   AbstractCurry is deactivated as it requires the value information
--   collected by the type checker.
175
checkModule :: Options -> (CompilerEnv, CS.Module)
176
            -> EitherT [Message] IO (CompilerEnv, CS.Module)
177
checkModule opts (env, mdl) = do
178 179 180
  doDump opts (DumpParsed       , env , show $ CS.ppModule mdl)
  (env1, kc) <- kindCheck   opts env mdl -- should be only syntax checking ?
  doDump opts (DumpKindChecked  , env1, show $ CS.ppModule kc)
181
  (env2, sc) <- syntaxCheck opts env1 kc
182 183 184
  doDump opts (DumpSyntaxChecked, env2, show $ CS.ppModule sc)
  (env3, pc) <- precCheck   opts env2 sc
  doDump opts (DumpPrecChecked  , env3, show $ CS.ppModule pc)
185
  (env4, tc) <- if withTypeCheck
186
                   then typeCheck opts env3 pc >>= uncurry (exportCheck opts)
187
                   else return (env3, pc)
188
  doDump opts (DumpTypeChecked  , env4, show $ CS.ppModule tc)
189
  return (env4, tc)
190
  where
191 192
  withTypeCheck = any (`elem` optTargetTypes opts)
                      [FlatCurry, ExtendedFlatCurry, FlatXml, AbstractCurry]
193 194 195 196 197

-- ---------------------------------------------------------------------------
-- Translating a module
-- ---------------------------------------------------------------------------

198 199
type Dump = (DumpLevel, CompilerEnv, String)

200 201
-- |Translate FlatCurry into the intermediate language 'IL'
transModule :: Options -> CompilerEnv -> CS.Module
202
            -> (CompilerEnv, IL.Module, [Dump])
203 204
transModule opts env mdl = (env5, ilCaseComp, dumps)
  where
205
  flat' = FlatCurry `elem` optTargetTypes opts
206
  (desugared , env1) = desugar        mdl        env
207 208
  (simplified, env2) = simplify flat' desugared  env1
  (lifted    , env3) = lift           simplified env2
Björn Peemöller 's avatar
Björn Peemöller committed
209
  (il        , env4) = ilTrans  flat' lifted     env3
210
  (ilCaseComp, env5) = completeCase   il         env4
211 212 213 214 215
  dumps = [ (DumpDesugared    , env1, presentCS desugared )
          , (DumpSimplified   , env2, presentCS simplified)
          , (DumpLifted       , env3, presentCS lifted    )
          , (DumpTranslated   , env4, presentIL il        )
          , (DumpCaseCompleted, env5, presentIL ilCaseComp)
216
          ]
217 218
  presentCS = if optDumpRaw opts then show else show . CS.ppModule
  presentIL = if optDumpRaw opts then show else show . IL.ppModule
219 220 221 222 223 224 225 226 227

-- ---------------------------------------------------------------------------
-- Writing output
-- ---------------------------------------------------------------------------

-- The functions \texttt{genFlat} and \texttt{genAbstract} generate
-- flat and abstract curry representations depending on the specified option.
-- If the interface of a modified Curry module did not change, the
-- corresponding file name will be returned within the result of 'genFlat'
228
-- (depending on the compiler flag "force") and other modules importing this
229 230 231 232 233 234 235
-- module won't be dependent on it any longer.

-- |Output the parsed 'Module' on request
writeParsed :: Options -> FilePath -> CS.Module -> IO ()
writeParsed opts fn modul = when srcTarget $
  writeModule useSubDir targetFile source
  where
236 237 238 239
  srcTarget  = Parsed `elem` optTargetTypes opts
  useSubDir  = optUseSubdir opts
  targetFile = fromMaybe (sourceRepName fn) (optOutput opts)
  source     = CS.showModule modul
240

241
writeFlat :: Options -> FilePath -> CompilerEnv -> ModuleSummary -> IL.Module
242 243
          -> IO ()
writeFlat opts fn env modSum il = do
244 245 246 247 248 249 250 251
  when (extTarget || fcyTarget) $ do
    writeFlatCurry opts fn env modSum il
    writeInterface opts fn env modSum il
  when (xmlTarget) $ writeXML opts fn modSum il
  where
  extTarget    = ExtendedFlatCurry `elem` optTargetTypes opts
  fcyTarget    = FlatCurry         `elem` optTargetTypes opts
  xmlTarget    = FlatXml           `elem` optTargetTypes opts
252 253 254 255 256

-- |Export an 'IL.Module' into a FlatCurry file
writeFlatCurry :: Options -> FilePath -> CompilerEnv -> ModuleSummary
               -> IL.Module -> IO ()
writeFlatCurry opts fn env modSum il = do
Björn Peemöller 's avatar
Björn Peemöller committed
257
  warn opts msgs
258
  when extTarget $ EF.writeExtendedFlat useSubDir (extFlatName fn) prog
259
  when fcyTarget $ EF.writeFlatCurry    useSubDir (flatName    fn) prog
260
  where
261 262 263 264
  extTarget    = ExtendedFlatCurry `elem` optTargetTypes opts
  fcyTarget    = FlatCurry         `elem` optTargetTypes opts
  useSubDir    = optUseSubdir opts
  (prog, msgs) = genFlatCurry opts modSum env il
265

266 267 268 269 270 271 272
-- |Export an 'IL.Module' into an XML file
writeXML :: Options -> FilePath -> ModuleSummary -> IL.Module -> IO ()
writeXML opts fn modSum il = writeModule useSubDir (xmlName fn) curryXml
  where
  useSubDir = optUseSubdir opts
  curryXml  = shows (IL.xmlModule (interface modSum) (infixDecls modSum) il) "\n"

273 274 275 276 277 278 279 280 281 282 283
writeInterface :: Options -> FilePath -> CompilerEnv -> ModuleSummary
               -> IL.Module -> IO ()
writeInterface opts fn env modSum il
  | not (optInterface opts) = return ()
  | optForce opts           = outputInterface
  | otherwise               = do
      mfint <- EF.readFlatInterface targetFile
      let oldInterface = fromMaybe emptyIntf mfint
      when (mfint == mfint) $ return () -- necessary to close file -- TODO
      unless (oldInterface `eqInterface` newInterface) $ outputInterface
  where
284 285 286 287
  targetFile = flatIntName fn
  emptyIntf = EF.Prog "" [] [] [] []
  (newInterface, intMsgs) = genFlatInterface opts modSum env il
  outputInterface = do
Björn Peemöller 's avatar
Björn Peemöller committed
288
    warn opts intMsgs
289
    EF.writeFlatCurry (optUseSubdir opts) targetFile newInterface
290 291 292 293 294 295 296 297

writeAbstractCurry :: Options -> FilePath -> CompilerEnv -> CS.Module -> IO ()
writeAbstractCurry opts fname env modul = do
  when  acyTarget $ AC.writeCurry useSubDir (acyName fname)
                  $ genTypedAbstractCurry env modul
  when uacyTarget $ AC.writeCurry useSubDir (uacyName fname)
                  $ genUntypedAbstractCurry env modul
  where
298 299 300
  acyTarget  = AbstractCurry        `elem` optTargetTypes opts
  uacyTarget = UntypedAbstractCurry `elem` optTargetTypes opts
  useSubDir  = optUseSubdir opts
301

302
-- |The 'dump' function writes the selected information to standard output.
303
doDump :: MonadIO m => Options -> Dump -> m ()
Björn Peemöller 's avatar
Björn Peemöller committed
304
doDump opts (level, env, dump) = when (level `elem` optDumps opts) $ do
305 306
  when (optDumpEnv opts) $ liftIO $ putStrLn $ showCompilerEnv env
  liftIO $ putStrLn $ unlines [header, replicate (length header) '=', dump]
307 308 309 310 311 312
  where
  header = lookupHeader dumpLevel
  lookupHeader []            = "Unknown dump level " ++ show level
  lookupHeader ((l,_,h):lhs)
    | level == l = h
    | otherwise  = lookupHeader lhs
313

314
errModuleFileMismatch :: ModuleIdent -> Message
315 316 317
errModuleFileMismatch mid = posMessage mid $ hsep $ map text
  [ "Module", moduleName mid, "must be in a file"
  , moduleName mid ++ ".(l)curry" ]