Modules.hs 15.5 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
    Copyright   :  (c) 1999 - 2004 Wolfgang Lux
                       2005        Martin Engelke
                       2007        Sebastian Fischer
7
                       2011 - 2014 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
Björn Peemöller 's avatar
Björn Peemöller committed
18 19
  ( compileModule, loadAndCheckModule, loadModule, checkModule
  , parseModule, checkModuleHeader
20 21
  ) where

22 23 24 25 26 27 28 29 30 31 32
import qualified Control.Exception as C   (catch, IOException)
import           Control.Monad            (liftM, unless, when)
import qualified Data.Map          as Map (elems)
import           Data.Maybe               (fromMaybe)
import           System.Directory         (getTemporaryDirectory, removeFile)
import           System.Exit              (ExitCode (..))
import           System.FilePath          (normalise)
import           System.IO
   (IOMode (ReadMode), Handle, hClose, hGetContents, hPutStr, openFile
  , openTempFile)
import           System.Process           (system)
33 34

import Curry.Base.Ident
Björn Peemöller 's avatar
Björn Peemöller committed
35 36
import Curry.Base.Message (runMsg)
import Curry.Base.Position
Björn Peemöller 's avatar
Björn Peemöller committed
37
import Curry.Base.Pretty
38 39 40 41
import Curry.ExtendedFlat.InterfaceEquality (eqInterface)
import Curry.Files.Filenames
import Curry.Files.PathUtils

Björn Peemöller 's avatar
Björn Peemöller committed
42
import Base.Messages
43
import Env.Interface
44 45 46 47 48 49 50 51 52 53 54 55 56

-- 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
57
import InterfaceEquivalence
58 59 60 61 62 63
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
64
-- line options, it will emit either FlatCurry code (standard or in XML
65
-- representation) or AbstractCurry code (typed, untyped or with type
66 67 68
-- signatures) for the module
-- Usually, the first step is to check the module.
-- Then the code is translated into the intermediate
69
-- language. If necessary, this phase will also update the module's
70 71
-- interface file. The resulting code then is written out (in
-- FlatCurry or XML format) to the corresponding file.
72 73 74
-- 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.
75
--
76 77 78
-- The compiler automatically loads the prelude when compiling any
-- module, except for the prelude itself, by adding an appropriate import
-- declaration to the module.
Björn Peemöller 's avatar
Björn Peemöller committed
79
compileModule :: Options -> FilePath -> CYIO ()
80
compileModule opts fn = do
81 82 83 84 85
  (env, mdl) <- loadAndCheckModule opts fn
  liftIO $ writeOutput opts fn (env, mdl)

loadAndCheckModule :: Options -> FilePath -> CYIO (CompilerEnv, CS.Module)
loadAndCheckModule opts fn = do
Björn Peemöller 's avatar
Björn Peemöller committed
86
  (env, mdl) <- loadModule opts fn >>= checkModule opts
87
  warn (optWarnOpts opts) $ warnCheck opts env mdl
88
  return (env, mdl)
89 90 91 92 93

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

Björn Peemöller 's avatar
Björn Peemöller committed
94
loadModule :: Options -> FilePath -> CYIO (CompilerEnv, CS.Module)
95
loadModule opts fn = do
96
  parsed <- parseModule opts fn
Björn Peemöller 's avatar
Björn Peemöller committed
97 98 99 100
  -- check module header
  mdl    <- checkModuleHeader opts fn parsed
  -- load the imported interfaces into an InterfaceEnv
  iEnv   <- loadInterfaces (optImportPaths opts) mdl
101
  checkInterfaces opts iEnv
Björn Peemöller 's avatar
Björn Peemöller committed
102 103 104 105
  -- add information of imported modules
  cEnv   <- importModules opts mdl iEnv
  return (cEnv, mdl)

106 107
parseModule :: Options -> FilePath -> CYIO CS.Module
parseModule opts fn = do
Björn Peemöller 's avatar
Björn Peemöller committed
108
  mbSrc <- liftIO $ readModule fn
109
  case mbSrc of
Björn Peemöller 's avatar
Björn Peemöller committed
110
    Nothing  -> left [message $ text $ "Missing file: " ++ fn]
111
    Just src -> do
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
      case runMsg (CS.unlit fn src) of
        Left err      -> left [err]
        Right (ul, _) -> do
        prepd <- preprocess (optPrepOpts opts) fn ul
        -- parse module
        case runMsg (CS.parseModule fn prepd) of
          Left  err         -> left [err]
          Right (parsed, _) -> right parsed

preprocess :: PrepOpts -> FilePath -> String -> CYIO String
preprocess opts fn src
  | not (ppPreprocess opts) = return src
  | otherwise               = do
    res <- liftIO $ withTempFile $ \ inFn inHdl -> do
      hPutStr inHdl src
      hClose inHdl
      withTempFile $ \ outFn outHdl -> do
        hClose outHdl
        ec <- system $ unwords $
          [ppCmd opts, normalise fn, inFn, outFn] ++ ppOpts opts
        case ec of
          ExitFailure x -> return $ Left [message $ text $
              "Preprocessor exited with exit code " ++ show x]
          ExitSuccess   -> Right `liftM` readFile outFn
    either left right res

withTempFile :: (FilePath -> Handle -> IO a) -> IO a
withTempFile act = do
  tmp       <- getTemporaryDirectory
  (fn, hdl) <- openTempFile tmp "cymake.curry"
  res       <- act fn hdl
  hClose hdl
  removeFile fn
  return res
Björn Peemöller 's avatar
Björn Peemöller committed
146 147 148

checkModuleHeader :: Monad m => Options -> FilePath -> CS.Module
                  -> CYT m CS.Module
149
checkModuleHeader opts fn = checkModuleId fn
150
                          . importPrelude opts fn
151
                          . CS.patchModuleId fn
152 153

-- |Check whether the 'ModuleIdent' and the 'FilePath' fit together
Björn Peemöller 's avatar
Björn Peemöller committed
154 155
checkModuleId :: Monad m => FilePath -> CS.Module
              -> CYT m CS.Module
156
checkModuleId fn m@(CS.Module _ mid _ _ _)
157
  | last (midQualifiers mid) == takeBaseName fn
Björn Peemöller 's avatar
Björn Peemöller committed
158
  = right m
159
  | otherwise
Björn Peemöller 's avatar
Björn Peemöller committed
160
  = left [errModuleFileMismatch mid]
161 162 163 164 165 166

-- 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.

167
importPrelude :: Options -> FilePath -> CS.Module -> CS.Module
168
importPrelude opts fn m@(CS.Module ps mid es is ds)
169 170 171 172 173 174 175
    -- the Prelude itself
  | mid == preludeMIdent          = m
    -- disabled by compiler option
  | noImpPrelude                  = m
    -- already imported
  | preludeMIdent `elem` imported = m
    -- let's add it!
176
  | otherwise                     = CS.Module ps mid es (preludeImp : is) ds
177
  where
178
  noImpPrelude = NoImplicitPrelude `elem` optExtensions opts
179
                 || m `CS.hasLanguageExtension` NoImplicitPrelude
180
  preludeImp   = CS.ImportDecl (first fn) preludeMIdent
181 182 183 184
                  False   -- qualified?
                  Nothing -- no alias
                  Nothing -- no selection of types, functions, etc.
  imported     = [imp | (CS.ImportDecl _ imp _ _ _) <- is]
185

186 187 188 189 190 191
checkInterfaces :: Monad m => Options -> InterfaceEnv -> CYT m ()
checkInterfaces opts iEnv = mapM_ checkInterface (Map.elems iEnv)
  where
  checkInterface intf = do
    _ <- interfaceCheck opts (importInterfaces opts intf iEnv) intf
    return ()
192

193 194 195 196
-- ---------------------------------------------------------------------------
-- Checking a module
-- ---------------------------------------------------------------------------

197
-- TODO: The order of the checks should be improved!
198 199 200
-- 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.
201
checkModule :: Options -> (CompilerEnv, CS.Module)
Björn Peemöller 's avatar
Björn Peemöller committed
202
            -> CYIO (CompilerEnv, CS.Module)
203
checkModule opts (env, mdl) = do
204
  doDump debugOpts (DumpParsed       , env , show $ CS.ppModule mdl)
205
  (env1, kc) <- kindCheck   opts env mdl -- should be only syntax checking ?
206
  doDump debugOpts (DumpKindChecked  , env1, show $ CS.ppModule kc)
207
  (env2, sc) <- syntaxCheck opts env1 kc
208
  doDump debugOpts (DumpSyntaxChecked, env2, show $ CS.ppModule sc)
209
  (env3, pc) <- precCheck   opts env2 sc
210
  doDump debugOpts (DumpPrecChecked  , env3, show $ CS.ppModule pc)
211
  (env4, tc) <- if withTypeCheck
212
                   then typeCheck opts env3 pc >>= uncurry (exportCheck opts)
213
                   else return (env3, pc)
214
  doDump debugOpts (DumpTypeChecked  , env4, show $ CS.ppModule tc)
215
  return (env4, tc)
216
  where
217
  debugOpts = optDebugOpts opts
218 219
  withTypeCheck = any (`elem` optTargetTypes opts)
                      [FlatCurry, ExtendedFlatCurry, FlatXml, AbstractCurry]
220 221 222 223 224

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

225 226
type Dump = (DumpLevel, CompilerEnv, String)

227 228
-- |Translate FlatCurry into the intermediate language 'IL'
transModule :: Options -> CompilerEnv -> CS.Module
229
            -> (CompilerEnv, IL.Module, [Dump])
230 231
transModule opts env mdl = (env5, ilCaseComp, dumps)
  where
232
  flat' = FlatCurry `elem` optTargetTypes opts
233
  (desugared , env1) = desugar        mdl        env
234 235
  (simplified, env2) = simplify flat' desugared  env1
  (lifted    , env3) = lift           simplified env2
Björn Peemöller 's avatar
Björn Peemöller committed
236
  (il        , env4) = ilTrans  flat' lifted     env3
237
  (ilCaseComp, env5) = completeCase   il         env4
238 239 240 241 242
  dumps = [ (DumpDesugared    , env1, presentCS desugared )
          , (DumpSimplified   , env2, presentCS simplified)
          , (DumpLifted       , env3, presentCS lifted    )
          , (DumpTranslated   , env4, presentIL il        )
          , (DumpCaseCompleted, env5, presentIL ilCaseComp)
243
          ]
244 245 246
  presentCS = if dumpRaw then show else show . CS.ppModule
  presentIL = if dumpRaw then show else show . IL.ppModule
  dumpRaw   = dbDumpRaw (optDebugOpts opts)
247 248 249 250 251

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

252 253 254 255
writeOutput :: Options -> FilePath -> (CompilerEnv, CS.Module) -> IO ()
writeOutput opts fn (env, modul) = do
  writeParsed opts fn modul
  let (env1, qlfd) = qual opts env modul
256
  doDump (optDebugOpts opts) (DumpQualified, env1, show $ CS.ppModule qlfd)
257 258 259 260 261 262 263
  writeAbstractCurry opts fn env1 qlfd
  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)
    let (env2, il, dumps) = transModule opts env1 qlfd
    -- dump intermediate results
264
    mapM_ (doDump (optDebugOpts opts)) dumps
265 266 267 268 269 270 271 272 273 274
    -- generate interface file
    let intf = exportInterface env2 qlfd
    writeInterface opts fn intf
    -- generate target code
    let modSum = summarizeModule (tyConsEnv env2) intf qlfd
    writeFlat opts fn env2 modSum il
  where
  withFlat = any (`elem` optTargetTypes opts)
              [FlatCurry, FlatXml, ExtendedFlatCurry]

275 276 277 278
-- 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'
279
-- (depending on the compiler flag "force") and other modules importing this
280 281 282 283 284
-- 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 $
285
  writeModule useSubDir (sourceRepName fn) source
286
  where
287 288 289
  srcTarget  = Parsed `elem` optTargetTypes opts
  useSubDir  = optUseSubdir opts
  source     = CS.showModule modul
290

291 292
writeInterface :: Options -> FilePath -> CS.Interface -> IO ()
writeInterface opts fn intf
293 294 295 296
  | optForce opts = outputInterface
  | otherwise     = do
      equal <- C.catch (matchInterface interfaceFile intf) ignoreIOException
      unless equal outputInterface
297
  where
298 299 300
  ignoreIOException :: C.IOException -> IO Bool
  ignoreIOException _ = return False

301 302 303 304
  interfaceFile   = interfName fn
  outputInterface = writeModule (optUseSubdir opts) interfaceFile
                    (show $ CS.ppInterface intf)

305 306 307 308 309 310 311 312
matchInterface :: FilePath -> CS.Interface -> IO Bool
matchInterface ifn i = do
  hdl <- openFile ifn ReadMode
  src <- hGetContents hdl
  case runMsg (CS.parseInterface ifn src) of
    Left _        -> hClose hdl >> return False
    Right (i', _) -> return (i `intfEquiv` fixInterface i')

313
writeFlat :: Options -> FilePath -> CompilerEnv -> ModuleSummary -> IL.Module
314 315
          -> IO ()
writeFlat opts fn env modSum il = do
316 317
  when (extTarget || fcyTarget) $ do
    writeFlatCurry opts fn env modSum il
318
    writeFlatIntf  opts fn env modSum il
319
  when (xmlTarget) $ writeFlatXml opts fn modSum il
320 321 322 323
  where
  extTarget    = ExtendedFlatCurry `elem` optTargetTypes opts
  fcyTarget    = FlatCurry         `elem` optTargetTypes opts
  xmlTarget    = FlatXml           `elem` optTargetTypes opts
324 325 326 327 328

-- |Export an 'IL.Module' into a FlatCurry file
writeFlatCurry :: Options -> FilePath -> CompilerEnv -> ModuleSummary
               -> IL.Module -> IO ()
writeFlatCurry opts fn env modSum il = do
329
  warn (optWarnOpts opts) msgs
330
  when extTarget $ EF.writeExtendedFlat useSubDir (extFlatName fn) prog
331
  when fcyTarget $ EF.writeFlatCurry    useSubDir (flatName    fn) prog
332
  where
333 334 335 336
  extTarget    = ExtendedFlatCurry `elem` optTargetTypes opts
  fcyTarget    = FlatCurry         `elem` optTargetTypes opts
  useSubDir    = optUseSubdir opts
  (prog, msgs) = genFlatCurry opts modSum env il
337

338
-- |Export an 'IL.Module' into an XML file
339 340
writeFlatXml :: Options -> FilePath -> ModuleSummary -> IL.Module -> IO ()
writeFlatXml opts fn modSum il = writeModule useSubDir (xmlName fn) curryXml
341 342 343 344
  where
  useSubDir = optUseSubdir opts
  curryXml  = shows (IL.xmlModule (interface modSum) (infixDecls modSum) il) "\n"

345 346 347
writeFlatIntf :: Options -> FilePath -> CompilerEnv -> ModuleSummary
              -> IL.Module -> IO ()
writeFlatIntf opts fn env modSum il
348 349 350 351 352 353 354 355
  | 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
356 357 358 359
  targetFile = flatIntName fn
  emptyIntf = EF.Prog "" [] [] [] []
  (newInterface, intMsgs) = genFlatInterface opts modSum env il
  outputInterface = do
360
    warn (optWarnOpts opts) intMsgs
361
    EF.writeFlatCurry (optUseSubdir opts) targetFile newInterface
362 363 364 365 366 367 368 369

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
370 371 372
  acyTarget  = AbstractCurry        `elem` optTargetTypes opts
  uacyTarget = UntypedAbstractCurry `elem` optTargetTypes opts
  useSubDir  = optUseSubdir opts
373

374
-- |The 'dump' function writes the selected information to standard output.
375 376 377
doDump :: MonadIO m => DebugOpts -> Dump -> m ()
doDump opts (level, env, dump) = when (level `elem` dbDumpLevels opts) $ do
  when (dbDumpEnv opts) $ liftIO $ putStrLn $ showCompilerEnv env
378
  liftIO $ putStrLn $ unlines [header, replicate (length header) '=', dump]
379 380 381 382 383 384
  where
  header = lookupHeader dumpLevel
  lookupHeader []            = "Unknown dump level " ++ show level
  lookupHeader ((l,_,h):lhs)
    | level == l = h
    | otherwise  = lookupHeader lhs
385

386
errModuleFileMismatch :: ModuleIdent -> Message
387 388 389
errModuleFileMismatch mid = posMessage mid $ hsep $ map text
  [ "Module", moduleName mid, "must be in a file"
  , moduleName mid ++ ".(l)curry" ]