aboutsummaryrefslogtreecommitdiff
path: root/src/HaskellCodeExplorer/PackageInfo.hs
blob: 295f1cbf23ffbf5b151e82bb738f435844023fcb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE Rank2Types #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}

module HaskellCodeExplorer.PackageInfo
  ( createPackageInfo
  , testCreatePkgInfo
  , ghcVersion
  ) where
import           Control.DeepSeq                ( deepseq )
import           Control.Exception              ( IOException
                                                , SomeAsyncException
                                                , SomeException
                                                , fromException
                                                , throw
                                                , try
                                                )
import           Control.Monad                  ( foldM
                                                , unless
                                                , when
                                                )
import           Control.Monad.Catch            ( handle )
import           Control.Monad.Extra            ( anyM
                                                , findM
                                                )
import           Control.Monad.Logger           ( LoggingT(..)
                                                , MonadLogger(..)
                                                , MonadLoggerIO(..)
                                                , logDebugN
                                                , logErrorN
                                                , logInfoN
                                                , logWarnN
                                                , runStdoutLoggingT
                                                )
import qualified Data.ByteString               as BS
import qualified Data.HashMap.Strict           as HM
import           Data.IORef                     ( readIORef )
import qualified Data.IntMap.Strict            as IM
import qualified Data.List                     as L
import qualified Data.List.NonEmpty            as NE
import qualified Data.Map                      as Map
import           Data.Maybe                     ( fromMaybe
                                                , isJust
                                                , mapMaybe
                                                , maybeToList
                                                )
import qualified Data.Set                      as S
import qualified Data.Text                     as T
import qualified Data.Text.Encoding            as TE
import           Data.Version                   ( Version(..)
                                                , makeVersion
                                                , showVersion
                                                )
import           Distribution.Helper            ( ChComponentInfo(..)
                                                , ChComponentName(..)
                                                , ChEntrypoint(..)
                                                , ChModuleName(..)
                                                , DistDir(..)
                                                , ProjLoc(..)
                                                , SCabalProjType(..)
                                                , UnitInfo(..)
                                                , allUnits
                                                , mkQueryEnv
                                                , pPackageName
                                                , pSourceDir
                                                , pUnits
                                                , projectPackages
                                                , runQuery
                                                , uComponentName
                                                )
import           GHC                            ( Backend(..)
                                                , DynFlags(..)
                                                , GeneralFlag(..)
                                                , GhcLink(..)
                                                , GhcMode(..)
                                                , LoadHowMuch(..)
                                                , ModLocation(..)
                                                , ModSummary(..)
                                                , getModuleGraph
                                                , getSession
                                                , getSessionDynFlags
                                                , guessTarget
                                                , load
                                                , moduleName
                                                , moduleNameString
                                                , noLoc
                                                , parseModule
                                                , runGhcT
                                                , setSessionDynFlags
                                                , setTargets
                                                , topSortModuleGraph
                                                , typecheckModule
                                                )
import           GHC.Data.Graph.Directed        ( flattenSCCs )
import           GHC.Driver.Env                 ( hsc_EPS
                                                , hsc_HPT
                                                , hsc_units
                                                )
import           GHC.Driver.Monad               ( GhcT(..)
                                                , liftIO
                                                )
import           GHC.Driver.Session             ( gopt_set
                                                , parseDynamicFlagsCmdLine
                                                )
import           GHC.Paths                      ( libdir )
import           GHC.Unit.Module.Graph          ( filterToposortToModules )
import           GHC.Utils.Exception            ( ExceptionMonad )
import           HaskellCodeExplorer.GhcUtils   ( isHsBoot
                                                , toText
                                                )
import           HaskellCodeExplorer.ModuleInfo ( ModuleDependencies
                                                , createModuleInfo
                                                )
import qualified HaskellCodeExplorer.Types     as HCE
import           Prelude                 hiding ( id )
import           System.Directory               ( canonicalizePath
                                                , doesFileExist
                                                , findExecutable
                                                , getCurrentDirectory
                                                , getDirectoryContents
                                                , makeAbsolute
                                                , setCurrentDirectory
                                                )
import qualified System.Directory.Tree         as DT
import           System.Exit                    ( exitFailure )
import           System.FilePath                ( (</>)
                                                , addTrailingPathSeparator
                                                , joinPath
                                                , normalise
                                                , replaceExtension
                                                , splitDirectories
                                                , splitPath
                                                , takeBaseName
                                                , takeDirectory
                                                , takeExtension
                                                , takeFileName
                                                )
import           System.FilePath.Find           ( (==?)
                                                , always
                                                , fileName
                                                , find
                                                )
import           System.Process                 ( readProcess )

testCreatePkgInfo :: FilePath -> IO (HCE.PackageInfo HCE.ModuleInfo)
testCreatePkgInfo pkgPath = runStdoutLoggingT
  $ createPackageInfo pkgPath Nothing HCE.AfterPreprocessing [] []

createPackageInfo
  :: FilePath -- ^ Path to a Cabal package
  -> Maybe FilePath -- ^ Relative path to a dist directory
  -> HCE.SourceCodePreprocessing -- ^ Before or after preprocessor
  -> [String] -- ^ Options for GHC
  -> [String] -- ^ Directories to ignore
  -> LoggingT IO (HCE.PackageInfo HCE.ModuleInfo)
createPackageInfo packageDirectoryPath mbDistDirRelativePath sourceCodePreprocessing additionalGhcOptions ignoreDirectories
  = do
    packageDirectoryAbsPath <- liftIO $ makeAbsolute packageDirectoryPath
    currentDirectory        <- liftIO getCurrentDirectory
    liftIO $ setCurrentDirectory packageDirectoryAbsPath
    distDir <- case mbDistDirRelativePath of
      Just path -> return $ packageDirectoryAbsPath </> path
      Nothing   -> return $ packageDirectoryAbsPath </> "dist-newstyle"
    cabalFiles <-
      liftIO
      $   length
      .   filter
            (\path ->
              takeFileName path /= ".cabal" && takeExtension path == ".cabal"
            )
      <$> getDirectoryContents packageDirectoryAbsPath
    _ <- if cabalFiles == 0
      then do
        logErrorN $ T.concat
          ["No .cabal file found in ", T.pack packageDirectoryAbsPath]
        liftIO exitFailure
      else when (cabalFiles >= 2) $ do
        logErrorN
          $ T.concat
              [ "Found more than one .cabal file in "
              , T.pack packageDirectoryAbsPath
              ]
        liftIO exitFailure
    cabalHelperQueryEnv <- liftIO $ mkQueryEnv
      (ProjLocV2Dir packageDirectoryAbsPath)
      (DistDirCabal SCV2 distDir)
    packages <-
      liftIO $ NE.toList <$> runQuery projectPackages cabalHelperQueryEnv
    logDebugN
      $  "packages: "
      <> (T.pack $ show $ zip3
           (pPackageName <$> packages)
           (pSourceDir <$> packages)
           ((mapMaybe uComponentName . NE.toList . pUnits) <$> packages)
         )
    mbPackage <- liftIO $ findM
      (\pkg -> do
        dir1 <- (canonicalizePath . pSourceDir) pkg
        dir2 <- canonicalizePath packageDirectoryAbsPath
        return $ dir1 == dir2
      )
      packages
    package <- case mbPackage of
      Just package' -> return package'
      Nothing       -> do
        logWarnN
          $  "Cannot find a package with sourceDir in the same directory ("
          <> T.pack (packageDirectoryAbsPath </> "")
          <> "), indexing the first package by default."
          <> "Alternatively, try using absolute path for -p."
        return $ head packages
    units <-
      liftIO
      $   (filter (\((pkgName, _), _, _) -> pkgName == pPackageName package))
      .   NE.toList
      <$> runQuery
            (allUnits
              (\unit ->
                ( uiPackageId unit
                , uiCompilerId unit
                , map
                    (\comp ->
                      ( (ciGhcOptions comp , ciComponentName comp)
                      , (ciEntrypoints comp, ciComponentName comp)
                      , (ciSourceDirs comp , ciComponentName comp)
                      )
                    )
                  $ (Map.elems . uiComponents) unit
                )
              )
            )
            cabalHelperQueryEnv
    -- TODO: we are assuming all pakcageVersion and packageCompilerVersion are the same
    let ((packageName, packageVersion), (_, packageCompilerVersion), _) =
          head units
        compInfo         = concatMap (\(_, _, comp) -> comp) units
        currentPackageId = HCE.PackageId (T.pack packageName) packageVersion
    logDebugN $ "compinfo: " <> (T.pack $ show compInfo)
    unless
        (  take 3 (versionBranch packageCompilerVersion)
        == take 3 (versionBranch ghcVersion)
        )
      $ do
          logErrorN $ T.concat
            [ "GHC version mismatch. haskell-code-indexer: "
            , T.pack $ showVersion ghcVersion
            , ", package: "
            , T.pack $ showVersion packageCompilerVersion
            ]
          liftIO exitFailure
    logInfoN $ T.append "Indexing " $ HCE.packageIdToText currentPackageId
    let buildComponents =
          L.map
              (\((options, compName), (entrypoint, _), (srcDirs, _)) ->
                ( chComponentNameToComponentId compName
                , options
                , chEntrypointsToModules entrypoint
                , srcDirs
                , chComponentNameToComponentType compName
                )
              )
            . L.sortBy
                (\((_, compName1), _, _) ((_, compName2), _, _) ->
                  compare compName1 compName2
                )
            $ compInfo
        libSrcDirs =
          concatMap (\(_, _, _, srcDirs, _) -> srcDirs)
            . filter (\(_, _, _, _, compType) -> HCE.isLibrary compType)
            $ buildComponents
    (indexedModules, (_fileMapResult, _defSiteMapResult, modNameMapResult)) <-
      foldM
        (\(modules, (fileMap, defSiteMap, modNameMap)) (compId, options, (mbMain, moduleNames), srcDirs, _) ->
          do
            mbMainPath <- case mbMain of
              Just mainPath ->
                liftIO
                  $ findM doesFileExist
                  $ mainPath
                  : map (\srcDir -> normalise $ srcDir </> mainPath) srcDirs
              Nothing -> return Nothing
            (modules', (fileMap', defSiteMap', modNameMap')) <-
              indexBuildComponent
                sourceCodePreprocessing
                currentPackageId
                compId
                (fileMap, defSiteMap, modNameMap)
                srcDirs
                libSrcDirs
                (options ++ additionalGhcOptions)
                (maybe moduleNames (: moduleNames) mbMainPath)
            return (modules ++ modules', (fileMap', defSiteMap', modNameMap'))
        )
        ([], (HM.empty, HM.empty, HM.empty))
        buildComponents
    let modId = HCE.id :: HCE.ModuleInfo -> HCE.HaskellModulePath
        moduleMap =
          HM.fromList
            . map (\modInfo -> (modId modInfo, modInfo))
            $ indexedModules
        references = L.foldl' addReferencesFromModule HM.empty indexedModules
        moduleId   = HCE.id :: HCE.ModuleInfo -> HCE.HaskellModulePath
        topLevelIdentifiersTrie =
          L.foldl' addTopLevelIdentifiersFromModule HCE.emptyTrie
            . L.filter (not . isHsBoot . moduleId)
            $ indexedModules
    directoryTree <- liftIO $ buildDirectoryTree
      packageDirectoryAbsPath
      ignoreDirectories
      (\path -> HM.member (HCE.HaskellModulePath . T.pack $ path) moduleMap)
    liftIO $ setCurrentDirectory currentDirectory
    return HCE.PackageInfo { id                = currentPackageId
                           , moduleMap         = moduleMap
                           , moduleNameMap     = modNameMapResult
                           , directoryTree     = directoryTree
                           , externalIdOccMap  = references
                           , externalIdInfoMap = topLevelIdentifiersTrie
                           }
 where
  chEntrypointsToModules :: ChEntrypoint -> (Maybe String, [String])
  chEntrypointsToModules (ChLibEntrypoint modules otherModules signatures) =
    ( Nothing
    , L.map chModuleToString modules
      ++ L.map chModuleToString otherModules
      ++ L.map chModuleToString signatures
    )
  chEntrypointsToModules (ChExeEntrypoint mainModule _otherModules) =
    (Just mainModule, [])
  chEntrypointsToModules (ChSetupEntrypoint _) = (Nothing, [])
  chModuleToString :: ChModuleName -> String
  chModuleToString (ChModuleName n) = n
  chComponentNameToComponentType :: ChComponentName -> HCE.ComponentType
  chComponentNameToComponentType ChSetupHsName      = HCE.Setup
  chComponentNameToComponentType (ChLibName   _   ) = HCE.Lib
  chComponentNameToComponentType (ChFLibName  name) = HCE.FLib $ T.pack name
  chComponentNameToComponentType (ChExeName   name) = HCE.Exe $ T.pack name
  chComponentNameToComponentType (ChTestName  name) = HCE.Test $ T.pack name
  chComponentNameToComponentType (ChBenchName name) = HCE.Bench $ T.pack name
  chComponentNameToComponentId :: ChComponentName -> HCE.ComponentId
  chComponentNameToComponentId (ChLibName _) = HCE.ComponentId "lib"
  chComponentNameToComponentId (ChFLibName name) =
    HCE.ComponentId . T.append "flib-" . T.pack $ name
  chComponentNameToComponentId (ChExeName name) =
    HCE.ComponentId . T.append "exe-" . T.pack $ name
  chComponentNameToComponentId (ChTestName name) =
    HCE.ComponentId . T.append "test-" . T.pack $ name
  chComponentNameToComponentId (ChBenchName name) =
    HCE.ComponentId . T.append "bench-" . T.pack $ name
  chComponentNameToComponentId ChSetupHsName = HCE.ComponentId "setup"


ghcVersion :: Version
ghcVersion = makeVersion [9, 2, 2, 0]

buildDirectoryTree
  :: FilePath -> [FilePath] -> (FilePath -> Bool) -> IO HCE.DirTree
buildDirectoryTree path ignoreDirectories isHaskellModule = do
  (_dir DT.:/ tree) <- DT.readDirectoryWith (const . return $ ()) path
  -- Tuple up the complete file path with the file contents, by building up the path,
  -- trie-style, from the root. The filepath will be relative to "anchored" directory.
  let treeWithPaths = DT.zipPaths ("" DT.:/ DT.filterDir (not . ignore) tree)
  return $ toDirTree (removeTopDir . fst <$> treeWithPaths)
 where
  ignore :: DT.DirTree a -> Bool
  ignore (DT.Dir dirName _) | "." `L.isPrefixOf` dirName = True
                            | dirName == "dist"          = True
                            | dirName == "dist-newstyle" = True
                            | dirName == "tmp"           = True
                            | otherwise = dirName `elem` ignoreDirectories
  ignore (DT.Failed _ _) = True
  ignore _               = False
  removeTopDir :: FilePath -> FilePath
  removeTopDir p = case splitPath p of
    _x : xs -> joinPath xs
    []      -> ""
  toDirTree :: DT.DirTree FilePath -> HCE.DirTree
  toDirTree (DT.Dir name contents) =
    HCE.Dir name (map toDirTree . filter (not . DT.failed) $ contents)
  toDirTree (DT.File name filePath) =
    HCE.File name filePath (isHaskellModule filePath)
  toDirTree (DT.Failed name err) =
    HCE.File (name ++ " : " ++ show err) "" False

addTopLevelIdentifiersFromModule
  :: HCE.Trie Char HCE.ExternalIdentifierInfo
  -> HCE.ModuleInfo
  -> HCE.Trie Char HCE.ExternalIdentifierInfo
addTopLevelIdentifiersFromModule trieIdInfo HCE.ModuleInfo {..} = L.foldl'
  (\trie idInfo@(HCE.ExternalIdentifierInfo HCE.IdentifierInfo {..}) ->
    HCE.insertToTrie S.insert (T.unpack demangledOccName) idInfo trie
  )
  trieIdInfo
  externalIds

addReferencesFromModule
  :: HM.HashMap HCE.ExternalId (S.Set HCE.IdentifierSrcSpan)
  -> HCE.ModuleInfo
  -> HM.HashMap HCE.ExternalId (S.Set HCE.IdentifierSrcSpan)
addReferencesFromModule references modInfo@HCE.ModuleInfo {..} =
  eachIdentifierOccurrence
    references
    modInfo
    (\occMap lineNumber startCol endCol occ ->
      let mbIdExternalId = HCE.externalId =<< maybe
            Nothing
            (`HM.lookup` idInfoMap)
            (HCE.internalId (occ :: HCE.IdentifierOccurrence))
          idSrcSpan = HCE.IdentifierSrcSpan { modulePath  = id
                                            , line        = lineNumber
                                            , startColumn = startCol
                                            , endColumn   = endCol
                                            }
      in  case mbIdExternalId of
            Just externalId ->
              HM.insertWith S.union externalId (S.singleton idSrcSpan) occMap
            Nothing -> occMap
    )


eachIdentifierOccurrence
  :: forall a
   . a
  -> HCE.ModuleInfo
  -> (a -> IM.Key -> Int -> Int -> HCE.IdentifierOccurrence -> a)
  -> a
eachIdentifierOccurrence accumulator HCE.ModuleInfo {..} f = IM.foldlWithKey'
  (\acc lineNumber occurences -> L.foldl'
    (\a ((startCol, endCol), occ) -> f a lineNumber startCol endCol occ)
    acc
    occurences
  )
  accumulator
  idOccMap

instance MonadLoggerIO (GhcT (LoggingT IO)) where
  askLoggerIO = GhcT $ const askLoggerIO

instance MonadLogger (GhcT (LoggingT IO)) where
  monadLoggerLog loc source level =
    GhcT . const . monadLoggerLog loc source level

gtrySync :: (ExceptionMonad m) => m a -> m (Either SomeException a)
gtrySync action = ghandleSync (return . Left) (fmap Right action)

ghandleSync :: (ExceptionMonad m) => (SomeException -> m a) -> m a -> m a
ghandleSync onError = handle
  (\ex -> case fromException ex of
    Just (asyncEx :: SomeAsyncException) -> throw asyncEx
    _ -> onError ex
  )

indexBuildComponent
  :: HCE.SourceCodePreprocessing -- ^ Before or after preprocessor
  -> HCE.PackageId -- ^ Current package id
  -> HCE.ComponentId -- ^ Current component id
  -> ModuleDependencies -- ^ Already indexed modules
  -> [FilePath] -- ^ Src dirs
  -> [FilePath] -- ^ Src dirs of libraries
  -> [String] -- ^ Command-line options for GHC
  -> [String] -- ^ Modules to compile
  -> LoggingT IO ([HCE.ModuleInfo], ModuleDependencies)
indexBuildComponent sourceCodePreprocessing currentPackageId componentId deps@(fileMap, defSiteMap, modNameMap) srcDirs libSrcDirs options modules
  = do
    let onError ex = do
          logErrorN $ T.concat
            [ "Error while indexing component "
            , HCE.getComponentId componentId
            , " : "
            , T.pack . show $ ex
            ]
          return ([], deps)
    ghandleSync onError $ runGhcT (Just libdir) $ do
      logDebugN (T.append "Component id : " $ HCE.getComponentId componentId)
      logDebugN (T.append "Modules : " $ T.pack $ show modules)
      logDebugN
        (T.append "GHC command line options : " $ T.pack $ L.unwords
          (options ++ modules)
        )
      flags          <- getSessionDynFlags
      (flags', _, _) <- parseDynamicFlagsCmdLine
        flags
        (L.map noLoc . L.filter ("-Werror" /=) $ options) -- -Werror flag makes warnings fatal
      let mbTmpDir = case hiDir flags' of
            Just buildDir ->
              Just $ buildDir </> (takeBaseName buildDir ++ "-tmp")
            Nothing -> Nothing
      -- initUnits happens here
      _ <- setSessionDynFlags $ L.foldl'
        gopt_set
        (flags' { backend     = NCG
                , ghcLink     = LinkInMemory
                , ghcMode     = CompManager
                , importPaths = importPaths flags' ++ maybeToList mbTmpDir
                }
        )
        [Opt_Haddock]
      targets <- mapM (`guessTarget` Nothing) modules
      setTargets targets
      _        <- load LoadAllTargets
      modGraph <- getModuleGraph
      let topSortMods = flattenSCCs $ filterToposortToModules
            (topSortModuleGraph False modGraph Nothing)
          buildDir =
            addTrailingPathSeparator . normalise . fromMaybe "" . hiDir $ flags'
          pathsModuleName = "Paths_" ++ map
            (\c -> if c == '-' then '_' else c)
            (T.unpack (HCE.name (currentPackageId :: HCE.PackageId)))
      (modSumWithPath, modulesNotFound) <-
        (\(mods, notFound) ->
          ( L.reverse
            . L.foldl'
                (\acc (mbPath, modSum) -> case mbPath of
                  Just path | not $ HM.member path defSiteMap ->
                    (path, modSum) : acc
                  _ -> acc
                )
                []
            $ mods
          , map snd notFound
          )
        )
        .   L.partition (\(mbPath, _) -> isJust mbPath)
        <$> mapM
              (\modSum ->
                liftIO
                  $   (, modSum)
                  <$> findHaskellModulePath buildDir
                                            (srcDirs ++ libSrcDirs)
                                            modSum
              )
              (filter
                (\modSum ->
                  pathsModuleName
                    /= (moduleNameString . moduleName $ ms_mod modSum)
                )
                topSortMods
              )
      unless (null modulesNotFound) $ logErrorN $ T.append
        "Cannot find module path : "
        (toText flags' $ map ms_mod modulesNotFound)
      foldM
        (\(indexedModules, (fileMap', defSiteMap', modNameMap')) (modulePath, modSum) ->
          do
            result <- indexModule sourceCodePreprocessing
                                  componentId
                                  currentPackageId
                                  flags'
                                  (fileMap', defSiteMap', modNameMap')
                                  (modulePath, modSum)
            case result of
              Right (modInfo, (fileMap'', defSiteMap'', modNameMap'')) ->
                return
                  ( modInfo : indexedModules
                  , (fileMap'', defSiteMap'', modNameMap'')
                  )
              Left exception -> do
                logErrorN $ T.concat
                  [ "Error while indexing "
                  , T.pack . show $ modulePath
                  , " : "
                  , T.pack . show $ exception
                  ]
                return (indexedModules, (fileMap', defSiteMap', modNameMap'))
        )
        ([], (fileMap, defSiteMap, modNameMap))
        modSumWithPath

findHaskellModulePath
  :: FilePath -> [FilePath] -> ModSummary -> IO (Maybe HCE.HaskellModulePath)
findHaskellModulePath buildDir srcDirs modSum =
  case normalise <$> (ml_hs_file . ms_location $ modSum) of
    Just modulePath ->
      let toHaskellModulePath = return . Just . HCE.HaskellModulePath . T.pack
          removeTmpDir path = case splitDirectories path of
            parent : rest ->
              if "-tmp" `L.isSuffixOf` parent then joinPath rest else path
            _ -> path
      in  case removeTmpDir <$> L.stripPrefix buildDir modulePath of
            -- File is in the build directory
            Just path
              | takeExtension path == ".hs-boot" -> do
                let possiblePaths = path : map (</> path) srcDirs
                mbFoundPath <- findM doesFileExist possiblePaths
                case mbFoundPath of
                  Just p -> toHaskellModulePath p
                  _      -> return Nothing
              | takeExtension path == ".hs" -> do
                let
                  paths = map (replaceExtension path)
                              HCE.haskellPreprocessorExtensions
                  possiblePaths =
                    paths
                      ++ concatMap (\srcDir -> map (srcDir </>) paths) srcDirs
                mbFoundPath <- findM doesFileExist possiblePaths
                case mbFoundPath of
                  Just p -> toHaskellModulePath p
                  _      -> return Nothing
              | otherwise -> return Nothing
            Nothing -> toHaskellModulePath modulePath
    Nothing -> return Nothing

indexModule
  :: HCE.SourceCodePreprocessing
  -> HCE.ComponentId
  -> HCE.PackageId
  -> DynFlags
  -> ModuleDependencies
  -> (HCE.HaskellModulePath, ModSummary)
  -> GhcT
       (LoggingT IO)
       ( Either
           SomeException
           (HCE.ModuleInfo, ModuleDependencies)
       )
indexModule sourceCodePreprocessing componentId currentPackageId flags deps (modulePath, modSum)
  = gtrySync $ do
    logDebugN (T.append "Indexing " $ HCE.getHaskellModulePath modulePath)
    parsedModule         <- parseModule modSum
    typecheckedModule    <- typecheckModule parsedModule
    hscEnv               <- getSession
    externalPackageState <- liftIO . readIORef . hsc_EPS $ hscEnv
    originalSourceCode   <-
      liftIO $ T.replace "\t" "        " . TE.decodeUtf8 <$> BS.readFile
        (T.unpack . HCE.getHaskellModulePath $ modulePath)
    let (modInfo, (fileMap', exportMap', moduleNameMap'), typeErrors) =
          createModuleInfo
            deps
            ( flags
            , hsc_units hscEnv
            , typecheckedModule
            , hsc_HPT hscEnv
            , externalPackageState
            , modSum
            )
            modulePath
            currentPackageId
            componentId
            (originalSourceCode, sourceCodePreprocessing)
    unless (null typeErrors)
      $ logInfoN
      $ T.append "Type errors : "
      $ T.pack
      $ show typeErrors
    deepseq modInfo $ return (modInfo, (fileMap', exportMap', moduleNameMap'))