module Agda.Interaction.Imports where
import Prelude
import Control.Arrow
import Control.Monad.Error
import Control.Monad.Reader
import Control.Monad.State
import qualified Control.Exception as E
import Data.Function (on)
import qualified Data.Map as Map
import qualified Data.List as List
import qualified Data.Set as Set
import qualified Data.Foldable as Fold (toList)
import qualified Data.ByteString.Lazy as BS
import Data.List
import Data.Maybe
import Data.Monoid (mempty, mappend)
import Data.Map (Map)
import Data.Set (Set)
import System.Directory (doesFileExist, getModificationTime, removeFile)
import System.FilePath hiding (splitPath)
import Agda.Syntax.Position
import qualified Agda.Syntax.Abstract as A
import qualified Agda.Syntax.Concrete as C
import Agda.Syntax.Abstract.Name
import Agda.Syntax.Parser
import Agda.Syntax.Scope.Base
import Agda.Syntax.Scope.Monad
import Agda.Syntax.Translation.ConcreteToAbstract
import Agda.Syntax.Internal
import Agda.Termination.TermCheck
import Agda.TypeChecking.Errors
import Agda.TypeChecking.Reduce
import Agda.TypeChecking.Monad
import Agda.TypeChecking.Monad.Builtin
import Agda.TypeChecking.Serialise
import Agda.TypeChecking.Primitive
import Agda.TypeChecker
import Agda.Interaction.EmacsCommand
import Agda.Interaction.FindFile
import Agda.Interaction.Options
import Agda.Interaction.Response (Response(Resp_RunningInfo))
import Agda.Interaction.Highlighting.Precise (HighlightingInfo)
import Agda.Interaction.Highlighting.Generate
import Agda.Interaction.Highlighting.Vim
import qualified Agda.Interaction.Highlighting.Range as R
import Agda.Utils.FileName
import Agda.Utils.Monad
import Agda.Utils.IO.Binary
import Agda.Utils.Pretty
import Agda.Utils.Fresh
import Agda.Utils.Time
import Agda.Utils.Impossible
#include "../undefined.h"
mergeInterface :: Interface -> TCM ()
mergeInterface i = do
let sig = iSignature i
builtin = Map.toList $ iBuiltin i
prim = [ x | (_,Prim x) <- builtin ]
bi = Map.fromList [ (x,Builtin t) | (x,Builtin t) <- builtin ]
bs <- gets stBuiltinThings
reportSLn "import.iface.merge" 10 $ "Merging interface"
reportSLn "import.iface.merge" 20 $
" Current builtins " ++ show (Map.keys bs) ++ "\n" ++
" New builtins " ++ show (Map.keys bi)
let check b = case (b1, b2) of
(Builtin x, Builtin y)
| x == y -> return ()
| otherwise -> typeError $ DuplicateBuiltinBinding b x y
_ -> __IMPOSSIBLE__
where
Just b1 = Map.lookup b bs
Just b2 = Map.lookup b bi
mapM_ check (map fst $ Map.toList $ Map.intersection bs bi)
addImportedThings sig bi (iHaskellImports i) (iPatternSyns i)
reportSLn "import.iface.merge" 20 $
" Rebinding primitives " ++ show prim
prim <- Map.fromList <$> mapM rebind prim
modify $ \st -> st { stImportedBuiltins = stImportedBuiltins st `Map.union` prim
}
where
rebind (x, q) = do
PrimImpl _ pf <- lookupPrimitiveFunction x
return (x, Prim $ pf { primFunName = q })
addImportedThings ::
Signature -> BuiltinThings PrimFun -> Set String -> A.PatternSynDefns -> TCM ()
addImportedThings isig ibuiltin hsImports patsyns =
modify $ \st -> st
{ stImports = unionSignatures [stImports st, isig]
, stImportedBuiltins = Map.union (stImportedBuiltins st) ibuiltin
, stHaskellImports = Set.union (stHaskellImports st) hsImports
, stPatternSynImports = Map.union (stPatternSynImports st) patsyns
}
scopeCheckImport :: ModuleName -> TCM (ModuleName, Map ModuleName Scope)
scopeCheckImport x = do
reportSLn "import.scope" 5 $ "Scope checking " ++ show x
verboseS "import.scope" 10 $ do
visited <- Map.keys <$> getVisitedModules
reportSLn "" 0 $
" visited: " ++ intercalate ", " (map (render . pretty) visited)
i <- fst <$> getInterface x
addImport x
return (iModuleName i `withRangesOfQ` mnameToConcrete x, iScope i)
alreadyVisited :: C.TopLevelModuleName ->
TCM (Interface, Either Warnings ClockTime) ->
TCM (Interface, Either Warnings ClockTime)
alreadyVisited x getIface = do
mm <- getVisitedModule x
case mm of
Just mi | not (miWarnings mi) -> do
reportSLn "import.visit" 10 $ " Already visited " ++ render (pretty x)
return (miInterface mi, Right $ miTimeStamp mi)
_ -> do
reportSLn "import.visit" 5 $ " Getting interface for " ++ render (pretty x)
r@(i, wt) <- getIface
reportSLn "import.visit" 5 $ " Now we've looked at " ++ render (pretty x)
case wt of
Left _ -> do
t <- liftIO getClockTime
visitModule $ ModuleInfo
{ miInterface = i
, miWarnings = True
, miTimeStamp = t
}
Right t ->
visitModule $ ModuleInfo
{ miInterface = i
, miWarnings = False
, miTimeStamp = t
}
return r
typeCheck :: AbsolutePath -> TCM (Interface, Maybe Warnings)
typeCheck f = do
m <- moduleName f
(i, wt) <- getInterface' m True
return (i, case wt of
Left w -> Just w
Right _ -> Nothing)
getInterface :: ModuleName -> TCM (Interface, ClockTime)
getInterface x = do
(i, wt) <- getInterface' (toTopLevelModuleName x) False
case wt of
Left w -> typeError $ warningsToError w
Right t -> return (i, t)
getInterface' :: C.TopLevelModuleName
-> Bool
-> TCM (Interface, Either Warnings ClockTime)
getInterface' x includeStateChanges =
withIncreasedModuleNestingLevel $
bracket_ (stPragmaOptions <$> get)
(unless includeStateChanges . setPragmaOptions) $ do
setCommandLineOptions . stPersistentOptions . stPersistent =<< get
alreadyVisited x $ addImportCycleCheck x $ do
file <- findFile x
reportSLn "import.iface" 10 $ " Check for cycle"
checkForImportCycle
uptodate <- do
ignore <- ignoreInterfaces
cached <- isCached file
newer <- liftIO $ filePath (toIFile file) `isNewerThan` filePath file
return $ newer && (not ignore || cached)
reportSLn "import.iface" 5 $
" " ++ render (pretty x) ++ " is " ++
(if uptodate then "" else "not ") ++ "up-to-date."
(stateChangesIncluded, (i, wt)) <-
if uptodate then skip file else typeCheck file
let topLevelName = toTopLevelModuleName $ iModuleName i
unless (topLevelName == x) $ do
checkModuleName topLevelName file
typeError $ OverlappingProjects file topLevelName x
visited <- isVisited x
reportSLn "import.iface" 5 $ if visited then " We've been here. Don't merge."
else " New module. Let's check it out."
unless (visited || stateChangesIncluded) $ do
mergeInterface i
ifTopLevelAndHighlightingLevelIs NonInteractive $
highlightFromInterface i file
modify (\s -> s { stCurrentModule = Just $ iModuleName i })
case wt of
Left w -> return ()
Right t -> storeDecodedModule i t
return (i, wt)
where
isCached file = do
let ifile = filePath $ toIFile file
exist <- liftIO $ doesFileExistCaseSensitive ifile
if not exist
then return False
else do
t <- liftIO $ getModificationTime ifile
mm <- getDecodedModule x
return $ case mm of
Just (mi, mt) | mt >= t -> True
_ -> False
chaseMsg kind file = do
nesting <- envModuleNestingLevel <$> ask
let s = genericReplicate nesting ' ' ++ kind ++
" " ++ render (pretty x) ++
case file of
Nothing -> "."
Just f -> " (" ++ f ++ ")."
ifM (envEmacs <$> ask)
(get >>= \st -> stInteractionOutputCallback st $ Resp_RunningInfo s)
(reportSLn "" 1 s)
skip file = do
let ifile = filePath $ toIFile file
t <- liftIO $ getModificationTime ifile
mm <- getDecodedModule x
(cached, mi) <- case mm of
Just (mi, mt) ->
if mt < t
then do dropDecodedModule x
reportSLn "import.iface" 5 $ " file is newer, re-reading " ++ ifile
(,) False <$> readInterface ifile
else do reportSLn "import.iface" 5 $ " using stored version of " ++ ifile
return (True, Just mi)
Nothing -> do
reportSLn "import.iface" 5 $ " no stored version, reading " ++ ifile
(,) False <$> readInterface ifile
case mi of
Nothing -> do
reportSLn "import.iface" 5 $ " bad interface, re-type checking"
typeCheck file
Just i -> do
reportSLn "import.iface" 5 $ " imports: " ++ show (iImportedModules i)
ts <- map snd <$> mapM getInterface (iImportedModules i)
if any (> t) ts
then do
typeCheck file
else do
unless cached $ chaseMsg "Skipping" (Just ifile)
mapM_ setOptionsFromPragma (iPragmaOptions i)
return (False, (i, Right t))
typeCheck file = do
let withMsgs m = do
chaseMsg "Checking" (Just $ filePath file)
x <- m
chaseMsg "Finished" Nothing
return x
if includeStateChanges then do
r <- withMsgs $ createInterface file x
sig <- getSignature
patsyns <- getPatternSyns
addImportedThings sig Map.empty Set.empty patsyns
setSignature emptySignature
setPatternSyns Map.empty
return (True, r)
else do
ms <- getImportPath
emacs <- envEmacs <$> ask
nesting <- envModuleNestingLevel <$> ask
mf <- stModuleToSource <$> get
vs <- getVisitedModules
ds <- getDecodedModules
opts <- stPersistentOptions . stPersistent <$> get
isig <- getImportedSignature
ibuiltin <- gets stImportedBuiltins
ipatsyns <- getPatternSynImports
ho <- stInteractionOutputCallback <$> get
r <- liftIO $ runTCM $
withImportPath ms $
local (\e -> e { envEmacs = emacs
, envModuleNestingLevel = nesting
}) $ do
setDecodedModules ds
setCommandLineOptions opts
modify $ \s -> s { stModuleToSource = mf
, stInteractionOutputCallback = ho
}
setVisitedModules vs
addImportedThings isig ibuiltin Set.empty ipatsyns
r <- withMsgs $ createInterface file x
mf <- stModuleToSource <$> get
ds <- getDecodedModules
return (r, do
modify $ \s -> s { stModuleToSource = mf }
setDecodedModules ds
case r of
(i, Right t) -> storeDecodedModule i t
_ -> return ()
)
case r of
Left err -> throwError err
Right (r, update) -> do
update
case r of
(_, Right _) ->
skip file
_ -> return (False, r)
highlightFromInterface
:: Interface
-> AbsolutePath
-> TCM ()
highlightFromInterface i file = do
reportSLn "import.iface" 5 $
"Generating syntax info for " ++ filePath file ++
" (read from interface)."
printHighlightingInfo (iHighlighting i)
readInterface :: FilePath -> TCM (Maybe Interface)
readInterface file = do
(s, close) <- liftIO $ readBinaryFile' file
do i <- liftIO . E.evaluate =<< decode s
liftIO close
return i
`catchError` \e -> liftIO close >> handler e
`catchError` handler
where
handler e = case e of
IOException _ e -> do
reportSLn "" 0 $ "IO exception: " ++ show e
return Nothing
_ -> throwError e
writeInterface :: FilePath -> Interface -> TCM ClockTime
writeInterface file i = do
reportSLn "import.iface.write" 5 $ "Writing interface file " ++ file ++ "."
encodeFile file i
reportSLn "import.iface.write" 5 "Wrote interface file."
liftIO $ getModificationTime file
`catchError` \e -> do
reportSLn "" 1 $
"Failed to write interface " ++ file ++ "."
liftIO $
whenM (doesFileExist file) $ removeFile file
throwError e
createInterface
:: AbsolutePath
-> C.TopLevelModuleName
-> TCM (Interface, Either Warnings ClockTime)
createInterface file mname =
local (\e -> e { envCurrentPath = file }) $ do
modFile <- stModuleToSource <$> get
fileTokenInfo <- generateTokenInfo file
modify $ \st -> st { stTokens = fileTokenInfo }
reportSLn "import.iface.create" 5 $
"Creating interface for " ++ render (pretty mname) ++ "."
verboseS "import.iface.create" 10 $ do
visited <- Map.keys <$> getVisitedModules
reportSLn "" 0 $
" visited: " ++ intercalate ", " (map (render . pretty) visited)
previousHsImports <- getHaskellImports
(pragmas, top) <- liftIO $ parseFile' moduleParser file
pragmas <- concat <$> concreteToAbstract_ pragmas
let getOptions (A.OptionsPragma opts) = Just opts
getOptions _ = Nothing
options = catMaybes $ map getOptions pragmas
mapM_ setOptionsFromPragma options
topLevel <- concreteToAbstract_ (TopLevel top)
let ds = topLevelDecls topLevel
ifTopLevelAndHighlightingLevelIs NonInteractive $ do
printHighlightingInfo fileTokenInfo
mapM_ (\d -> generateAndPrintSyntaxInfo d Partial) ds
catchError (checkDecls ds) $ \e -> do
ifTopLevelAndHighlightingLevelIs NonInteractive $
printErrorInfo e
throwError e
unfreezeMetas
verboseS "profile.metas" 10 $ do
MetaId n <- fresh
tickN "metas" (fromIntegral n)
ifTopLevelAndHighlightingLevelIs NonInteractive $
printHighlightingInfo . stTokens =<< get
modify $ \st ->
st { stTokens = mempty
, stSyntaxInfo = stSyntaxInfo st `mappend` stTokens st
}
whenM (optGenerateVimFile <$> commandLineOptions) $
withScope_ (insideScope topLevel) $ generateVimFile $ filePath file
setScope $ outsideScope topLevel
reportSLn "scope.top" 50 $ "SCOPE " ++ show (insideScope topLevel)
syntaxInfo <- stSyntaxInfo <$> get
i <- buildInterface topLevel syntaxInfo previousHsImports options
termErrs <- Fold.toList <$> stTermErrs <$> get
unsolvedMetas <- List.nub <$> (mapM getMetaRange =<< getOpenMetas)
unsolvedConstraints <- getAllConstraints
ifTopLevelAndHighlightingLevelIs NonInteractive $
printUnsolvedInfo
r <- if and [ null termErrs, null unsolvedMetas, null unsolvedConstraints ]
then do
let ifile = filePath $ toIFile file
t <- writeInterface ifile i
return (i, Right t)
else
return (i, Left $ Warnings termErrs unsolvedMetas unsolvedConstraints)
stats <- Map.toList <$> getStatistics
case stats of
[] -> return ()
_ -> reportS "profile" 1 $ unlines $
[ "Ticks for " ++ show (pretty mname) ] ++
[ " " ++ s ++ " = " ++ show n
| (s, n) <- sortBy (compare `on` snd) stats ]
return r
buildInterface :: TopLevelInfo
-> HighlightingInfo
-> Set String
-> [OptionsPragma]
-> TCM Interface
buildInterface topLevel syntaxInfo previousHsImports pragmas = do
reportSLn "import.iface" 5 "Building interface..."
scope' <- getScope
let scope = scope' { scopeCurrent = m }
sig <- getSignature
builtin <- gets stLocalBuiltins
ms <- getImports
hsImps <- getHaskellImports
patsyns <- getPatternSyns
let builtin' = Map.mapWithKey (\x b -> fmap (\pf -> (x, primFunName pf)) b) builtin
reportSLn "import.iface" 7 " instantiating all meta variables"
i <- instantiateFull $ Interface
{ iImportedModules = Set.toList ms
, iModuleName = m
, iScope = publicModules scope
, iInsideScope = insideScope topLevel
, iSignature = sig
, iBuiltin = builtin'
, iHaskellImports = Set.difference hsImps
previousHsImports
, iHighlighting = syntaxInfo
, iPragmaOptions = pragmas
, iPatternSyns = patsyns
}
reportSLn "import.iface" 7 " interface complete"
return i
where m = topLevelModuleName topLevel
isNewerThan :: FilePath -> FilePath -> IO Bool
isNewerThan new old = do
newExist <- doesFileExist new
oldExist <- doesFileExist old
if not (newExist && oldExist)
then return newExist
else do
newT <- getModificationTime new
oldT <- getModificationTime old
return $ newT >= oldT