ghcide 1.0.0.0 → 1.1.0.0

raw patch · 82 files changed

+23969/−22772 lines, 82 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +288/−265
• LICENSE +201/−201
• README.md +358/−358
• bench/exe/Main.hs +59/−59
• bench/hist/Main.hs +192/−192
• bench/lib/Experiments.hs +574/−573
• bench/lib/Experiments/Types.hs +70/−70
• cbits/getmodtime.c +21/−21
• exe/Arguments.hs +52/−52
• exe/Main.hs +121/−117
• ghcide.cabal +427/−425
• include/ghc-api-version.h +12/−12
• session-loader/Development/IDE/Session.hs +876/−862
• session-loader/Development/IDE/Session/VersionCheck.hs +17/−17
• src/Control/Concurrent/Strict.hs +34/−0
• src/Development/IDE.hs +53/−50
• src/Development/IDE/Core/Compile.hs +987/−973
• src/Development/IDE/Core/Debouncer.hs +59/−57
• src/Development/IDE/Core/FileExists.hs +248/−239
• src/Development/IDE/Core/FileStore.hs +312/−242
• src/Development/IDE/Core/IdeConfiguration.hs +91/−91
• src/Development/IDE/Core/OfInterest.hs +119/−121
• src/Development/IDE/Core/PositionMapping.hs +213/−213
• src/Development/IDE/Core/Preprocessor.hs +229/−227
• src/Development/IDE/Core/RuleTypes.hs +517/−472
• src/Development/IDE/Core/Rules.hs +1157/−1140
• src/Development/IDE/Core/Service.hs +80/−82
• src/Development/IDE/Core/Shake.hs +1185/−1153
• src/Development/IDE/Core/Tracing.hs +236/−217
• src/Development/IDE/GHC/CPP.hs +231/−228
• src/Development/IDE/GHC/Compat.hs +311/−311
• src/Development/IDE/GHC/Error.hs +218/−218
• src/Development/IDE/GHC/ExactPrint.hs +584/−448
• src/Development/IDE/GHC/Orphans.hs +153/−153
• src/Development/IDE/GHC/Util.hs +280/−263
• src/Development/IDE/GHC/Warnings.hs +48/−48
• src/Development/IDE/Import/DependencyInformation.hs +381/−377
• src/Development/IDE/Import/FindImports.hs +179/−179
• src/Development/IDE/LSP/HoverDefinition.hs +88/−88
• src/Development/IDE/LSP/LanguageServer.hs +216/−210
• src/Development/IDE/LSP/Notifications.hs +140/−144
• src/Development/IDE/LSP/Outline.hs +221/−225
• src/Development/IDE/LSP/Server.hs +61/−61
• src/Development/IDE/Main.hs +242/−225
• src/Development/IDE/Plugin.hs +21/−21
• src/Development/IDE/Plugin/CodeAction.hs +1503/−1444
• src/Development/IDE/Plugin/CodeAction/Args.hs +292/−0
• src/Development/IDE/Plugin/CodeAction/ExactPrint.hs +500/−435
• src/Development/IDE/Plugin/CodeAction/PositionIndexed.hs +140/−140
• src/Development/IDE/Plugin/Completions.hs +204/−204
• src/Development/IDE/Plugin/Completions/Logic.hs +761/−758
• src/Development/IDE/Plugin/Completions/Types.hs +78/−78
• src/Development/IDE/Plugin/HLS.hs +186/−186
• src/Development/IDE/Plugin/HLS/GhcIde.hs +48/−48
• src/Development/IDE/Plugin/Test.hs +123/−123
• src/Development/IDE/Plugin/TypeLenses.hs +277/−117
• src/Development/IDE/Spans/AtPoint.hs +371/−371
• src/Development/IDE/Spans/Common.hs +191/−192
• src/Development/IDE/Spans/Documentation.hs +223/−223
• src/Development/IDE/Spans/LocalBindings.hs +134/−134
• src/Development/IDE/Types/Action.hs +88/−88
• src/Development/IDE/Types/Diagnostics.hs +150/−151
• src/Development/IDE/Types/Exports.hs +101/−101
• src/Development/IDE/Types/HscEnvEq.hs +165/−159
• src/Development/IDE/Types/KnownTargets.hs +24/−24
• src/Development/IDE/Types/Location.hs +113/−112
• src/Development/IDE/Types/Logger.hs +54/−54
• src/Development/IDE/Types/Options.hs +182/−175
• src/Development/IDE/Types/Shake.hs +134/−133
• test/cabal/Development/IDE/Test/Runfiles.hs +9/−9
• test/data/hover/Bar.hs +4/−4
• test/data/hover/Foo.hs +6/−6
• test/data/hover/GotoHover.hs +63/−63
• test/data/multi/a/A.hs +3/−3
• test/data/multi/a/a.cabal +9/−9
• test/data/multi/b/B.hs +3/−3
• test/data/multi/b/b.cabal +9/−9
• test/data/multi/cabal.project +1/−1
• test/data/multi/hie.yaml +6/−6
• test/exe/Main.hs +5440/−5298
• test/preprocessor/Main.hs +10/−10
• test/src/Development/IDE/Test.hs +202/−201

@@ -1,265 +1,288 @@-### 0.7.5 (2021-02-??)
-* Tone down some logInfos to logDebug (#1385) - Pepe Iborra
-* Show window message when auto extending import lists (#1371) - Potato Hatsue
-* Catch GHC errors in listing module names (#1367) - Potato Hatsue
-* Upgrade to lsp-1.0 (#1284) - wz1000
-* Added Development.IDE.Main (#1338) - Pepe Iborra
-* Fix completion snippets on DuplicateRecordFields (#1360) - Potato Hatsue
-* Add code action for hiding shadowed identifiers from imports (#1322) - Potato Hatsue
-* Make find-definition work better with multi-components (#1357) - wz1000
-* Index files on first open (#1358) - wz1000
-* Fix code actions regression (#1349) - Pepe Iborra
-
-### 0.7.4 (2021-02-08)
-* Support for references via hiedb (#704) - wz1000
-* Fix space leak on cradle reloads (#1316) - Pepe Iborra
-* Trigger extending import only when the item is not in scope (#1309) - Potato Hatsue
-* Don't extend the import list with child if the parent has already been imported as (..) (#1302) - Potato Hatsue
-* FindImports typo (minor) (#1291) - Andy
-* Reenable auto extend imports and drop snippets for infix completions (#1266) - Pepe Iborra
-* ghcide: Implements a CodeAction to disambiguate ambiguous symbols (#1264) - Hiromi Ishii
-* Restore code actions order (#1273) - Pepe Iborra
-
-### 0.7.3 (2021-02-04)
-* Add custom cache layer for session loading (#1197) - (fendor)
-* Remove invalid exports (#1193) - (Kostas Dermentzis)
-* Use exact print to suggestExtendImport - (Potato Hatsue)
-* Add code actions for disabling a warning in the current file (#1235) - (George Thomas)
-* Limit completions to top 40 (#1218) - (Pepe Iborra)
-* Add traces for HLS providers (#1222) - (Pepe Iborra)
-* Use exact print for suggest missing constraint code actions (#1221) - (Pepe Iborra)
-* Parenthesise type operators when extending import lists (#1212) - (Thomas Winant)
-
-### 0.7.2 (2021-01-14)
-* Expose shakeOptions used - (Pepe Iborra)
-
-### 0.7.1 (2021-01-13)
-* Fix sticky diagnostics bug (#1188) - (Pepe Iborra)
-* Use completionSnippetsOn flag (#1195) - (Yuya Kono)
-* Update tested-with GHC in cabal config - (jneira)
-* Do not disable parallel GC by default (#1190) - (Pepe Iborra)
-* Fix module outline becoming stale after switching branches (#1189) - (Pepe Iborra)
-* Make adding missing constraint work in presence of 'forall' (fixes #1164) (#1177) - (Jan Hrcek)
-* Bump haskell-lsp to 0.23 (#1146) - (Potato Hatsue)
-* Fix #723 (Instance declarations in hs-boot files result in GHC errors) (#781) - (Ben Simms)
-* Also suggest importing methods without parent class (#766) - (Thomas Winant)
-* Update links to issues/PRs in ghcide tests. (#1142) - (Peter Wicks Stringfield)
-* fix suggestAddTypeAnnotation regex (#760) - (Kostas Dermentzis)
-
-### 0.7.0 (2021-01-03)
-* Ghcide now loads HLS plugins internally - (Pepe Iborra)
-* Retry a failed cradle if the cradle descriptor changes (#762) - (Pepe Iborra)
-* Fix extend imports regression (#769) - (Pepe Iborra)
-* Perform memory measurement on SIGUSR1 (#761) - (Pepe Iborra)
-
-### 0.6.0.2 (2020-12-26)
-* Fix disappearing diagnostics bug (#959) - (Pepe Iborra)
-* Deduplicate module not found diagnostics (#952) - (Pepe Iborra)
-* Use qualified module name from diagnostics in suggestNewImport (#945) - (Potato Hatsue)
-* Disable auto extend import snippets in completions (these need a bit more work)
-
-### 0.6.0.1 (2020-12-13)
-* Fix build with GHC 8.8.2 and 8.8.3 - (Javier Neira)
-* Update old URLs still pointing to digital-asset - (Jan Hrcek)
-
-### 0.6.0 (2020-12-06)
-* Completions: extend explicit import list automatically (#930) - (Guru Devanla)
-* Completions for identifiers not in explicit import lists (#919) - (Guru Devanla)
-* Completions for record fields (#900) - (Guru Devanla)
-* Bugfix: add constructors to import lists correctly (#916) - (Potato Hatsue)
-* Bugfix: respect qualified identifiers (#938) - (Pepe Iborra)
-* Bugfix: partial `pathToId` (#926) - (Samuel Ainsworth)
-* Bugfix: import suggestions when there's more than one option (#913) - (Guru Devanla)
-* Bugfix: parenthesize operators when exporting (#906) - (Potato Hatsue)
-* Opentelemetry traces and heapsize memory analysis (#922) - (Michalis Pardalos / Pepe Iborra)
-* Make Filetargets absolute before continue using them (#914) - (fendor)
-* Do not enable every "unnecessary" warning by default (#907) - (Alejandro Serrano)
-* Update implicit-hie to 0.3.0 (#905) - (Avi Dessauer)
-
-### 0.5.0 (2020-11-07)
-* Use implicit-hie-0.1.2.0 (#880) - (Javier Neira)
-* Clarify and downgrade implicit-hie message (#883) - (Avi Dessauer)
-* Switch back to bytecode (#873) - (wz1000)
-* Add code action for remove all redundant imports (#867) - (Potato Hatsue)
-* Fix pretty printer for diagnostic ranges (#871) - (Martin Huschenbett)
-* Canonicalize import dirs (#870) - (Pepe Iborra)
-* Do not show internal hole names (#852) - (Alejandro Serrano)
-* Downgrade file watch debug log to logDebug from logInfo (#848) - (Matthew Pickering)
-* Pull in local bindings (#845) - (Sandy Maguire)
-* Use object code for Template Haskell, emit desugarer warnings (#836) - (wz1000)
-* Fix code action for adding missing constraints to type signatures (#839) - (Jan Hrcek)
-* Fix duplicated completions (#837) - (Vitalii)
-* FileExists: set one watcher instead of thousands (#831) - (Michael Peyton Jones)
-* Drop 8.4 support (#834) - (wz1000)
-* Add GetHieAsts rule, Replace SpanInfo, add support for DocumentHighlight and scope-aware completions for local variables (#784) - (wz1000)
-* Tag unused warning as such (#815) - (Alejandro Serrano)
-* Update instructions for stty error in windows (#825) - (Javier Neira)
-* Fix docs tooltip for base libraries on Windows (#814) - (Nick Dunets)
-* Fix documentation (or source) link when html file is less specific than module (#766) - (Nick Dunets)
-* Add completion tests for records. (#804) - (Guru Devanla)
-* Restore identifiers missing from hi file (#741) - (maralorn)
-* Fix import suggestions when dot is typed (#800) - (Marcelo Lazaroni)
-
-### 0.4.0 (2020-09-15)
-* Fixes for GHC source plugins: dotpreprocessor works now - (srid)
-* Use implicit-hie when no explicit hie.yaml (#782) - (Javier Neira)
-* Extend position mapping with fuzzy ranges (#785) - (wz1000)
-* Sort import suggestions (#793) - (Pepe Iborra)
-* Save source files with HIE files (#701) - (fendor)
-* Fully asynchronous request handling (#767) - (Pepe Iborra)
-* Refinement holes (#748) - (Pepe Iborra)
-* Fix haddock to markdown conversion (#757) - (George Thomas)
-* Expose `getCompletionsLSP` to allow completions in hls (#756) - (wz1000)
-* Suggestions for missing imports from local modules (#739) - (Pepe Iborra)
-* Dynamically load libm on Linux for each new session (#723) - (Luke Lau)
-* Use InitializeParams.rootUri for initial session setup (#713) - (shaurya gupta)
-* Show documentation on hover for symbols defined in the same module (#691) - (wz1000)
-* Suggest open imports (#740) - (Pepe Iborra)
-* module Development.IDE (#724) - (Pepe Iborra)
-* Ignore -Werror (#738) - (Pepe Iborra)
-* Fix issue #710: fix suggest delete binding  (#728) - (Ray Shih)
-* Generate doc file URL via LSP (to fix it for Windows) (#721) - (Nick Dunets)
-* Fix `.hie` file location for `.hs-boot` files (#690) - (wz1000)
-* Use argsVerbose to determine log level in test mode (#717) - (Ziyang Liu)
-* output which cradle files were found (#716) - (Adam Sandberg Eriksson)
-* Typecheck entire project on Initial Load and typecheck reverse dependencies of a file on saving (#688) - (wz1000)
-
-### 0.3.0 (2020-09-02)
-
-* CI: remove (internal) DA Slack notifications (#750) - (Gary Verhaegen)
-* Add session-loader to hie.yaml (#714) - (Luke Lau)
-* Codeaction for exporting unused top-level bindings (#711) - (shaurya gupta)
-* Add links to haddock and hscolour pages in documentation (#699) - (Luke Lau)
-* Expose GHC.Compat module (#709) - (Pepe Iborra)
-* Move session loading logic into ghcide library (#697) - (Luke Lau)
-* Code action: remove redundant constraints for type signature (#692) - (Denis Frezzato)
-* Fix Binary instance of Q to handle empty file paths (#707) - (Moritz Kiefer)
-* Populate ms_hs_date in GetModSummary rule (#694) - (Pepe Iborra)
-* Allow GHC plugins to be called with an updated StringBuffer (#698) - (Alfredo Di Napoli)
-* Relax upper bounds for GHC 8.10.1 (#705) - (Pepe Iborra)
-* Obtain the GHC libdir at runtime (#696) - (Luke Lau)
-* Expect bench experiments to fail with Cabal (#704) - (Pepe Iborra)
-* Bump lodash from 4.17.15 to 4.17.19 in /extension (#702) - (dependabot[bot])
-* Update to hie-bios 0.6.1 (#693) - (fendor)
-* Backport HIE files to GHC 8.6 (#689) - (wz1000)
-* Performance improvements for GetSpanInfo (#681) - (Pepe Iborra)
-* Code action add default type annotation to remove `-Wtype-defaults` warning (#680) - (Serhii)
-* Use a global namecache to read `.hie` files (#677) - (wz1000)
-* Completions need not depend on typecheck of the current file (#670) - (Pepe Iborra)
-* Fix spaninfo Haddocks for local modules (#678) - (Pepe Iborra)
-* Avoid excessive retypechecking of TH codebases (#673) - (Pepe Iborra)
-* Use stale information if it's available to answer requests quickly (#624) - (Matthew Pickering)
-* Code action: add constraint (#653) - (Denis Frezzato)
-* Make BenchHist non buildable by default and save logs (#666) - (Pepe Iborra)
-* Delete unused top level binding code action (#657) - (Serhii)
-* stack810.yaml: bump (#651) - (Domen Kozar)
-* Fix debouncer for 0 delay (#662) - (Pepe Iborra)
-* Interface file fixes (#645) - (Pepe Iborra)
-* Retry GHC 8.10 on Windows (#661) - (Moritz Kiefer)
-* Finer dependencies for GhcSessionFun (#643) - (Pepe Iborra)
-* Send WorkDoneProgressEnd only when work is done (#649) - (Pepe Iborra)
-* Add a note on differential benchmarks (#647) - (Pepe Iborra)
-* Cache a ghc session per file of interest (#630) - (Pepe Iborra)
-* Remove `Strict` from the language extensions used for code actions (#638) - (Torsten Schmits)
-* Report progress when setting up cradle (#644) - (Luke Lau)
-* Fix crash when writing to a Barrier more than once (#637) - (Pepe Iborra)
-* Write a cabal.project file in the benchmark example (#640) - (Pepe Iborra)
-* Performance analysis over time (#629) - (Pepe Iborra)
-* More benchmarks (#625) - (Pepe Iborra)
-* Canonicalize the locations in the cradle tests (#628) - (Luke Lau)
-* Add hie.yaml.stack and use none cradle for test data (#626) - (Javier Neira)
-* Fix a bug in getHiFileRule (#623) - (Pepe Iborra)
-* ghc initialization error handling (#609) - (Pepe Iborra)
-* Fix regression in getSpanInfoRule (#622) - (Pepe Iborra)
-* Restore Shake profiling (#621) - (Pepe Iborra)
-* Use a better noRange (#612) - (Neil Mitchell)
-* Add back a .ghci file (#607) - (Neil Mitchell)
-* #573, make haddock errors warnings with the word Haddock in front (#608) - (Neil Mitchell)
-* Implement Goto Type Definition (#533) - (Matthew Pickering)
-* remove unnecessary FileExists dependency in GetHiFile (#589) - (Pepe Iborra)
-* ShakeSession and shakeEnqueue (#554) - (Pepe Iborra)
-* Benchmark suite (#590) - (Pepe Iborra)
-
-### 0.2.0 (2020-06-02)
-
-* Multi-component support (thanks @mpickering)
-* Support for GHC 8.10 (thanks @sheaf and @chshersh)
-* Fix some TH issues (thanks @mpickering)
-* Automatically pick up changes to cradle dependencies (e.g. cabal
-  files) (thanks @jinwoo)
-* Track dependencies when using `qAddDependentFile` (thanks @mpickering)
-* Add record fields to document symbols outline (thanks @bubba)
-* Fix some space leaks (thanks @mpickering)
-* Strip redundant path information from diagnostics (thanks @tek)
-* Fix import suggestions for operators (thanks @eddiemundo)
-* Significant reductions in memory usage by using interfaces and `.hie` files (thanks
-  @pepeiborra)
-* Minor improvements to completions
-* More comprehensive suggestions for missing imports (thanks @pepeiborra)
-* Group imports in document outline (thanks @fendor)
-* Upgrade to haskell-lsp-0.22 (thanks @bubba)
-* Upgrade to hie-bios 0.5 (thanks @fendor)
-
-### 0.1.0 (2020-02-04)
-
-* Code action for inserting new definitions (see #309).
-* Better default GC settings (see #329 and #333).
-* Various performance improvements (see #322 and #384).
-* Improvements to hover information (see #317 and #338).
-* Support GHC 8.8.2 (see #355).
-* Include keywords in completions (see #351).
-* Fix some issues with aborted requests (see #353).
-* Use hie-bios 0.4.0 (see #382).
-* Avoid stuck progress reporting (see #400).
-* Only show progress notifications after 0.1s (see #392).
-* Progress reporting is now in terms of the number of files rather
-  than the number of shake rules (see #379).
-
-### 0.0.6 (2020-01-10)
-
-* Fix type in hover information for do-notation and list
-  comprehensions (see #243).
-* Fix hover and goto-definition for multi-clause definitions (see #252).
-* Upgrade to `hie-bios-0.3` (see #257)
-* Upgrade to `haskell-lsp-0.19` (see #254)
-* Code lenses for missing signatures are displayed even if the warning
-  has not been enabled. The warning itself will not be shown if it is
-  not enabled. (see #232)
-* Define `__GHCIDE__` when running CPP to allow for `ghcide`-specific
-  workarounds. (see #264)
-* Fix some filepath normalization issues. (see #266)
-* Fix build with `shake-0.18.4` (see #272)
-* Fix hover for type constructors and type classes. (see #267)
-* Support custom preprocessors (see #282)
-* Add support for code completions (see #227)
-* Code action for removing redundant symbols from imports (see #290)
-* Support document symbol requests (see #293)
-* Show CPP errors as diagnostics (see #296)
-* Code action for adding suggested imports (see #295)
-
-### 0.0.5 (2019-12-12)
-
-* Support for GHC plugins (see #192)
-* Update to haskell-lsp 0.18 (see #203)
-* Initial support for `TemplateHaskell` (see #222)
-* Code lenses for missing signatures. These are only shown if
-  `-Wmissing-signatures` is enabled. (see #224)
-* Fix path normalisation on Windows (see #225)
-* Fix flickering of the progress indicator (see #230)
-
-### 0.0.4 (2019-10-20)
-
-* Add a ``--version`` cli option (thanks @jacg)
-* Update to use progress reporting as defined in LSP 3.15. The VSCode
-  extension has also been updated and should now be making use of
-  this.
-* Properly declare that we should support code actions. This helps
-  with some clients that rely on this information to enable code
-  actions (thanks @jacg).
-* Fix a race condition caused by sharing the finder cache between
-  concurrent compilations.
-* Avoid normalizing include dirs. This avoids issues where the same
-  file ends up twice in the module graph, e.g., with different casing
-  for drive letters.
-
-### 0.0.3 (2019-09-21)
+### 1.1.0 (2021-03-09)+* Add an option to control progress reporting (#1513) - Pepe Iborra+* Fix missing parens of auto extending imports (#1526) - Potato Hatsue+* Avoid redundant work in diagnostics pass (#1514) - Pepe Iborra+* Avoid always rerunning GetModificationTime for interface files too (#1506) - Pepe Iborra+* Demote implicit cradle warn to logging (#1511) - Javier Neira+* Drive GetModificationTime using watched file events (#1487) - Pepe Iborra+* Make type lenses plugin configurable (#1491) - Potato Hatsue+* Context-aware ExactPrint grafting for HsExpr (#1489) - Sandy Maguire+* Register IDE configuration when called via the command line (#1495) - wz1000+* Faster ModSummary fingerprints (#1485) - Pepe Iborra+* Make sure to give the correct DynFlags to the recompilation checker (#1459) - Pepe Iborra+* Customize the unitId used for the fake internal component (#1435) - Pepe Iborra+* Extract the qualified name from already imported module (#1445) - Potato Hatsue+* Add code action for importing class methods (#1428) - Potato Hatsue+* Reformat all files (#1439) - Junyoung/Clare Jang+* Minor performance optimizations (#1432) - Pepe Iborra++### 1.0.0 (2021-03-04)+* Fix the handling of default HLS config again (#1419) - Pepe Iborra+* Hlint hints. (#1227) - Peter Wicks Stringfield+* Use object code for TH+UnboxedTuples/Sums (#1382) - wz1000+* Add a pre commit hook for code formatting (#1384) - Junyoung/Clare Jang+### 0.7.5 (2021-02-17)+* Tone down some logInfos to logDebug (#1385) - Pepe Iborra+* Show window message when auto extending import lists (#1371) - Potato Hatsue+* Catch GHC errors in listing module names (#1367) - Potato Hatsue+* Upgrade to lsp-1.0 (#1284) - wz1000+* Added Development.IDE.Main (#1338) - Pepe Iborra+* Fix completion snippets on DuplicateRecordFields (#1360) - Potato Hatsue+* Add code action for hiding shadowed identifiers from imports (#1322) - Potato Hatsue+* Make find-definition work better with multi-components (#1357) - wz1000+* Index files on first open (#1358) - wz1000+* Fix code actions regression (#1349) - Pepe Iborra++### 0.7.4 (2021-02-08)+* Support for references via hiedb (#704) - wz1000+* Fix space leak on cradle reloads (#1316) - Pepe Iborra+* Trigger extending import only when the item is not in scope (#1309) - Potato Hatsue+* Don't extend the import list with child if the parent has already been imported as (..) (#1302) - Potato Hatsue+* FindImports typo (minor) (#1291) - Andy+* Reenable auto extend imports and drop snippets for infix completions (#1266) - Pepe Iborra+* ghcide: Implements a CodeAction to disambiguate ambiguous symbols (#1264) - Hiromi Ishii+* Restore code actions order (#1273) - Pepe Iborra++### 0.7.3 (2021-02-04)+* Add custom cache layer for session loading (#1197) - (fendor)+* Remove invalid exports (#1193) - (Kostas Dermentzis)+* Use exact print to suggestExtendImport - (Potato Hatsue)+* Add code actions for disabling a warning in the current file (#1235) - (George Thomas)+* Limit completions to top 40 (#1218) - (Pepe Iborra)+* Add traces for HLS providers (#1222) - (Pepe Iborra)+* Use exact print for suggest missing constraint code actions (#1221) - (Pepe Iborra)+* Parenthesise type operators when extending import lists (#1212) - (Thomas Winant)++### 0.7.2 (2021-01-14)+* Expose shakeOptions used - (Pepe Iborra)++### 0.7.1 (2021-01-13)+* Fix sticky diagnostics bug (#1188) - (Pepe Iborra)+* Use completionSnippetsOn flag (#1195) - (Yuya Kono)+* Update tested-with GHC in cabal config - (jneira)+* Do not disable parallel GC by default (#1190) - (Pepe Iborra)+* Fix module outline becoming stale after switching branches (#1189) - (Pepe Iborra)+* Make adding missing constraint work in presence of 'forall' (fixes #1164) (#1177) - (Jan Hrcek)+* Bump haskell-lsp to 0.23 (#1146) - (Potato Hatsue)+* Fix #723 (Instance declarations in hs-boot files result in GHC errors) (#781) - (Ben Simms)+* Also suggest importing methods without parent class (#766) - (Thomas Winant)+* Update links to issues/PRs in ghcide tests. (#1142) - (Peter Wicks Stringfield)+* fix suggestAddTypeAnnotation regex (#760) - (Kostas Dermentzis)++### 0.7.0 (2021-01-03)+* Ghcide now loads HLS plugins internally - (Pepe Iborra)+* Retry a failed cradle if the cradle descriptor changes (#762) - (Pepe Iborra)+* Fix extend imports regression (#769) - (Pepe Iborra)+* Perform memory measurement on SIGUSR1 (#761) - (Pepe Iborra)++### 0.6.0.2 (2020-12-26)+* Fix disappearing diagnostics bug (#959) - (Pepe Iborra)+* Deduplicate module not found diagnostics (#952) - (Pepe Iborra)+* Use qualified module name from diagnostics in suggestNewImport (#945) - (Potato Hatsue)+* Disable auto extend import snippets in completions (these need a bit more work)++### 0.6.0.1 (2020-12-13)+* Fix build with GHC 8.8.2 and 8.8.3 - (Javier Neira)+* Update old URLs still pointing to digital-asset - (Jan Hrcek)++### 0.6.0 (2020-12-06)+* Completions: extend explicit import list automatically (#930) - (Guru Devanla)+* Completions for identifiers not in explicit import lists (#919) - (Guru Devanla)+* Completions for record fields (#900) - (Guru Devanla)+* Bugfix: add constructors to import lists correctly (#916) - (Potato Hatsue)+* Bugfix: respect qualified identifiers (#938) - (Pepe Iborra)+* Bugfix: partial `pathToId` (#926) - (Samuel Ainsworth)+* Bugfix: import suggestions when there's more than one option (#913) - (Guru Devanla)+* Bugfix: parenthesize operators when exporting (#906) - (Potato Hatsue)+* Opentelemetry traces and heapsize memory analysis (#922) - (Michalis Pardalos / Pepe Iborra)+* Make Filetargets absolute before continue using them (#914) - (fendor)+* Do not enable every "unnecessary" warning by default (#907) - (Alejandro Serrano)+* Update implicit-hie to 0.3.0 (#905) - (Avi Dessauer)++### 0.5.0 (2020-11-07)+* Use implicit-hie-0.1.2.0 (#880) - (Javier Neira)+* Clarify and downgrade implicit-hie message (#883) - (Avi Dessauer)+* Switch back to bytecode (#873) - (wz1000)+* Add code action for remove all redundant imports (#867) - (Potato Hatsue)+* Fix pretty printer for diagnostic ranges (#871) - (Martin Huschenbett)+* Canonicalize import dirs (#870) - (Pepe Iborra)+* Do not show internal hole names (#852) - (Alejandro Serrano)+* Downgrade file watch debug log to logDebug from logInfo (#848) - (Matthew Pickering)+* Pull in local bindings (#845) - (Sandy Maguire)+* Use object code for Template Haskell, emit desugarer warnings (#836) - (wz1000)+* Fix code action for adding missing constraints to type signatures (#839) - (Jan Hrcek)+* Fix duplicated completions (#837) - (Vitalii)+* FileExists: set one watcher instead of thousands (#831) - (Michael Peyton Jones)+* Drop 8.4 support (#834) - (wz1000)+* Add GetHieAsts rule, Replace SpanInfo, add support for DocumentHighlight and scope-aware completions for local variables (#784) - (wz1000)+* Tag unused warning as such (#815) - (Alejandro Serrano)+* Update instructions for stty error in windows (#825) - (Javier Neira)+* Fix docs tooltip for base libraries on Windows (#814) - (Nick Dunets)+* Fix documentation (or source) link when html file is less specific than module (#766) - (Nick Dunets)+* Add completion tests for records. (#804) - (Guru Devanla)+* Restore identifiers missing from hi file (#741) - (maralorn)+* Fix import suggestions when dot is typed (#800) - (Marcelo Lazaroni)++### 0.4.0 (2020-09-15)+* Fixes for GHC source plugins: dotpreprocessor works now - (srid)+* Use implicit-hie when no explicit hie.yaml (#782) - (Javier Neira)+* Extend position mapping with fuzzy ranges (#785) - (wz1000)+* Sort import suggestions (#793) - (Pepe Iborra)+* Save source files with HIE files (#701) - (fendor)+* Fully asynchronous request handling (#767) - (Pepe Iborra)+* Refinement holes (#748) - (Pepe Iborra)+* Fix haddock to markdown conversion (#757) - (George Thomas)+* Expose `getCompletionsLSP` to allow completions in hls (#756) - (wz1000)+* Suggestions for missing imports from local modules (#739) - (Pepe Iborra)+* Dynamically load libm on Linux for each new session (#723) - (Luke Lau)+* Use InitializeParams.rootUri for initial session setup (#713) - (shaurya gupta)+* Show documentation on hover for symbols defined in the same module (#691) - (wz1000)+* Suggest open imports (#740) - (Pepe Iborra)+* module Development.IDE (#724) - (Pepe Iborra)+* Ignore -Werror (#738) - (Pepe Iborra)+* Fix issue #710: fix suggest delete binding  (#728) - (Ray Shih)+* Generate doc file URL via LSP (to fix it for Windows) (#721) - (Nick Dunets)+* Fix `.hie` file location for `.hs-boot` files (#690) - (wz1000)+* Use argsVerbose to determine log level in test mode (#717) - (Ziyang Liu)+* output which cradle files were found (#716) - (Adam Sandberg Eriksson)+* Typecheck entire project on Initial Load and typecheck reverse dependencies of a file on saving (#688) - (wz1000)++### 0.3.0 (2020-09-02)++* CI: remove (internal) DA Slack notifications (#750) - (Gary Verhaegen)+* Add session-loader to hie.yaml (#714) - (Luke Lau)+* Codeaction for exporting unused top-level bindings (#711) - (shaurya gupta)+* Add links to haddock and hscolour pages in documentation (#699) - (Luke Lau)+* Expose GHC.Compat module (#709) - (Pepe Iborra)+* Move session loading logic into ghcide library (#697) - (Luke Lau)+* Code action: remove redundant constraints for type signature (#692) - (Denis Frezzato)+* Fix Binary instance of Q to handle empty file paths (#707) - (Moritz Kiefer)+* Populate ms_hs_date in GetModSummary rule (#694) - (Pepe Iborra)+* Allow GHC plugins to be called with an updated StringBuffer (#698) - (Alfredo Di Napoli)+* Relax upper bounds for GHC 8.10.1 (#705) - (Pepe Iborra)+* Obtain the GHC libdir at runtime (#696) - (Luke Lau)+* Expect bench experiments to fail with Cabal (#704) - (Pepe Iborra)+* Bump lodash from 4.17.15 to 4.17.19 in /extension (#702) - (dependabot[bot])+* Update to hie-bios 0.6.1 (#693) - (fendor)+* Backport HIE files to GHC 8.6 (#689) - (wz1000)+* Performance improvements for GetSpanInfo (#681) - (Pepe Iborra)+* Code action add default type annotation to remove `-Wtype-defaults` warning (#680) - (Serhii)+* Use a global namecache to read `.hie` files (#677) - (wz1000)+* Completions need not depend on typecheck of the current file (#670) - (Pepe Iborra)+* Fix spaninfo Haddocks for local modules (#678) - (Pepe Iborra)+* Avoid excessive retypechecking of TH codebases (#673) - (Pepe Iborra)+* Use stale information if it's available to answer requests quickly (#624) - (Matthew Pickering)+* Code action: add constraint (#653) - (Denis Frezzato)+* Make BenchHist non buildable by default and save logs (#666) - (Pepe Iborra)+* Delete unused top level binding code action (#657) - (Serhii)+* stack810.yaml: bump (#651) - (Domen Kozar)+* Fix debouncer for 0 delay (#662) - (Pepe Iborra)+* Interface file fixes (#645) - (Pepe Iborra)+* Retry GHC 8.10 on Windows (#661) - (Moritz Kiefer)+* Finer dependencies for GhcSessionFun (#643) - (Pepe Iborra)+* Send WorkDoneProgressEnd only when work is done (#649) - (Pepe Iborra)+* Add a note on differential benchmarks (#647) - (Pepe Iborra)+* Cache a ghc session per file of interest (#630) - (Pepe Iborra)+* Remove `Strict` from the language extensions used for code actions (#638) - (Torsten Schmits)+* Report progress when setting up cradle (#644) - (Luke Lau)+* Fix crash when writing to a Barrier more than once (#637) - (Pepe Iborra)+* Write a cabal.project file in the benchmark example (#640) - (Pepe Iborra)+* Performance analysis over time (#629) - (Pepe Iborra)+* More benchmarks (#625) - (Pepe Iborra)+* Canonicalize the locations in the cradle tests (#628) - (Luke Lau)+* Add hie.yaml.stack and use none cradle for test data (#626) - (Javier Neira)+* Fix a bug in getHiFileRule (#623) - (Pepe Iborra)+* ghc initialization error handling (#609) - (Pepe Iborra)+* Fix regression in getSpanInfoRule (#622) - (Pepe Iborra)+* Restore Shake profiling (#621) - (Pepe Iborra)+* Use a better noRange (#612) - (Neil Mitchell)+* Add back a .ghci file (#607) - (Neil Mitchell)+* #573, make haddock errors warnings with the word Haddock in front (#608) - (Neil Mitchell)+* Implement Goto Type Definition (#533) - (Matthew Pickering)+* remove unnecessary FileExists dependency in GetHiFile (#589) - (Pepe Iborra)+* ShakeSession and shakeEnqueue (#554) - (Pepe Iborra)+* Benchmark suite (#590) - (Pepe Iborra)++### 0.2.0 (2020-06-02)++* Multi-component support (thanks @mpickering)+* Support for GHC 8.10 (thanks @sheaf and @chshersh)+* Fix some TH issues (thanks @mpickering)+* Automatically pick up changes to cradle dependencies (e.g. cabal+  files) (thanks @jinwoo)+* Track dependencies when using `qAddDependentFile` (thanks @mpickering)+* Add record fields to document symbols outline (thanks @bubba)+* Fix some space leaks (thanks @mpickering)+* Strip redundant path information from diagnostics (thanks @tek)+* Fix import suggestions for operators (thanks @eddiemundo)+* Significant reductions in memory usage by using interfaces and `.hie` files (thanks+  @pepeiborra)+* Minor improvements to completions+* More comprehensive suggestions for missing imports (thanks @pepeiborra)+* Group imports in document outline (thanks @fendor)+* Upgrade to haskell-lsp-0.22 (thanks @bubba)+* Upgrade to hie-bios 0.5 (thanks @fendor)++### 0.1.0 (2020-02-04)++* Code action for inserting new definitions (see #309).+* Better default GC settings (see #329 and #333).+* Various performance improvements (see #322 and #384).+* Improvements to hover information (see #317 and #338).+* Support GHC 8.8.2 (see #355).+* Include keywords in completions (see #351).+* Fix some issues with aborted requests (see #353).+* Use hie-bios 0.4.0 (see #382).+* Avoid stuck progress reporting (see #400).+* Only show progress notifications after 0.1s (see #392).+* Progress reporting is now in terms of the number of files rather+  than the number of shake rules (see #379).++### 0.0.6 (2020-01-10)++* Fix type in hover information for do-notation and list+  comprehensions (see #243).+* Fix hover and goto-definition for multi-clause definitions (see #252).+* Upgrade to `hie-bios-0.3` (see #257)+* Upgrade to `haskell-lsp-0.19` (see #254)+* Code lenses for missing signatures are displayed even if the warning+  has not been enabled. The warning itself will not be shown if it is+  not enabled. (see #232)+* Define `__GHCIDE__` when running CPP to allow for `ghcide`-specific+  workarounds. (see #264)+* Fix some filepath normalization issues. (see #266)+* Fix build with `shake-0.18.4` (see #272)+* Fix hover for type constructors and type classes. (see #267)+* Support custom preprocessors (see #282)+* Add support for code completions (see #227)+* Code action for removing redundant symbols from imports (see #290)+* Support document symbol requests (see #293)+* Show CPP errors as diagnostics (see #296)+* Code action for adding suggested imports (see #295)++### 0.0.5 (2019-12-12)++* Support for GHC plugins (see #192)+* Update to haskell-lsp 0.18 (see #203)+* Initial support for `TemplateHaskell` (see #222)+* Code lenses for missing signatures. These are only shown if+  `-Wmissing-signatures` is enabled. (see #224)+* Fix path normalisation on Windows (see #225)+* Fix flickering of the progress indicator (see #230)++### 0.0.4 (2019-10-20)++* Add a ``--version`` cli option (thanks @jacg)+* Update to use progress reporting as defined in LSP 3.15. The VSCode+  extension has also been updated and should now be making use of+  this.+* Properly declare that we should support code actions. This helps+  with some clients that rely on this information to enable code+  actions (thanks @jacg).+* Fix a race condition caused by sharing the finder cache between+  concurrent compilations.+* Avoid normalizing include dirs. This avoids issues where the same+  file ends up twice in the module graph, e.g., with different casing+  for drive letters.++### 0.0.3 (2019-09-21)

@@ -1,201 +1,201 @@-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2019 Digital Asset (Switzerland) GmbH and/or its affiliates
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright 2019 Digital Asset (Switzerland) GmbH and/or its affiliates++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.

@@ -1,358 +1,358 @@-# `ghcide` - A library for building Haskell IDE tooling
-
-Our vision is that you should build an IDE by combining:
-
-![vscode](https://raw.githubusercontent.com/haskell/ghcide/master/img/vscode2.png)
-
-* [`hie-bios`](https://github.com/mpickering/hie-bios) for determining where your files are, what are their dependencies, what extensions are enabled and so on;
-* `ghcide` (i.e. this library) for defining how to type check, when to type check, and producing diagnostic messages;
-* A bunch of plugins that haven't yet been written, e.g. [`hie-hlint`](https://github.com/ndmitchell/hlint) and [`hie-ormolu`](https://github.com/tweag/ormolu), to choose which features you want;
-* [`haskell-lsp`](https://github.com/alanz/haskell-lsp) for sending those messages to a [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) server;
-* An LSP client for your editor.
-
-There are more details about our approach [in this blog post](https://4ta.uk/p/shaking-up-the-ide).
-
-## Features
-
-`ghcide` already exports the following features via the lsp protocol:
-
-| Feature | LSP name |
-| - | - |
-| Display error messages (parse errors, typecheck errors, etc.) and enabled warnings. | diagnostics |
-| Go to definition in local package | definition  |
-| Display type and source module of values | hover |
-| Remove redundant imports, replace suggested typos for values and module imports, fill type holes, insert missing type signatures, add suggested ghc extensions  | codeAction (quickfix) |
-
-
-## Limitations to Multi-Component support
-
-`ghcide` supports loading multiple components into the same session so that
-features such as go-to definition work across components. However, there are
-some limitations to this.
-
-1. You will get much better results currently manually specifying the hie.yaml file.
-Until tools like cabal and stack provide the right interface to support multi-component
-projects, it is always advised to specify explicitly how your project partitions.
-2. Cross-component features only work if you have loaded at least one file
-from each component.
-3. There is a known issue where if you have three components, such that A depends on B which depends on C
-then if you load A and C into the session but not B then under certain situations you
-can get strange errors about a type coming from two different places. See [this repo](https://github.com/fendor/ghcide-bad-interface-files) for
-a simple reproduction of the bug.
-
-## Using it
-
-`ghcide` is not an end-user tool, [don't use `ghcide`](https://neilmitchell.blogspot.com/2020/09/dont-use-ghcide-anymore-directly.html) directly (more about the rationale [here](https://github.com/haskell/ghcide/pull/939)).
-
- [`haskell-language-server`](http://github.com/haskell/haskell-language-server) is an LSP server built on top of `ghcide` with additional features and a user friendly deployment model. To get it, simply install the [Haskell extension](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) in VS Code, or download prebuilt binaries from the [haskell-language-server](https://github.com/haskell/haskell-language-server) project page.
-
-
-The instructions below are meant for developers interested in setting up ghcide as an LSP server for testing purposes.
-
-### Install `ghcide`
-
-#### With Nix
-
-Note that you need to compile `ghcide` with the same `ghc` as the project you are working on.
-
-1. If the `ghc` you are using matches the version (or better is) from `nixpkgs` it‘s easiest to use the `ghcide` from `nixpkgs`. You can do so via
-   ```
-   nix-env -iA haskellPackages.ghcide
-   ```
-   or e.g. including `pkgs.haskellPackages.ghcide` in your projects `shell.nix`.
-   Depending on your `nixpkgs` channel that might not be the newest `ghcide`, though.
-
-2. If your `ghc` does not match nixpkgs you should try the [ghcide-nix repository](https://github.com/cachix/ghcide-nix)
-   which provides a `ghcide` via the `haskell.nix` infrastructure.
-
-#### With Cabal or Stack
-
-First install the `ghcide` binary using `stack` or `cabal`, e.g.
-
-1. `git clone https://github.com/haskell/ghcide.git`
-2. `cd ghcide`
-3. `cabal install` or `stack install` (and make sure `~/.local/bin` is on your `$PATH`)
-
-It's important that `ghcide` is compiled with the same compiler you use to build your projects.
-
-### Test `ghcide`
-
-Next, check that `ghcide` is capable of loading your code. Change to the project directory and run `ghcide`, which will try and load everything using the same code as the IDE, but in a way that's much easier to understand. For example, taking the example of [`shake`](https://github.com/ndmitchell/shake), running `ghcide` gives some error messages and warnings before reporting at the end:
-
-```console
-Files that failed:
- * .\model\Main.hs
- * .\model\Model.hs
- * .\model\Test.hs
- * .\model\Util.hs
- * .\output\docs\Main.hs
- * .\output\docs\Part_Architecture_md.hs
-Completed (152 worked, 6 failed)
-```
-
-Of the 158 files in Shake, as of this moment, 152 can be loaded by the IDE, but 6 can't (error messages for the reasons they can't be loaded are given earlier). The failing files are all prototype work or test output, meaning I can confidently use Shake.
-
-The `ghcide` executable mostly relies on [`hie-bios`](https://github.com/mpickering/hie-bios) to do the difficult work of setting up your GHC environment. If it doesn't work, see [the `hie-bios` manual](https://github.com/mpickering/hie-bios#readme) to get it working. My default fallback is to figure it out by hand and create a `direct` style [`hie.yaml`](https://github.com/ndmitchell/shake/blob/master/hie.yaml) listing the command line arguments to load the project.
-
-If you can't get `ghcide` working outside the editor, see [this setup troubleshooting guide](docs/Setup.md). Once you have got `ghcide` working outside the editor, the next step is to pick which editor to integrate with.
-
-### Optimal project setup
-
-`ghcide` has been designed to handle projects with hundreds or thousands of modules. If `ghci` can handle it, then `ghcide` should be able to handle it. The only caveat is that this currently requires GHC >= 8.6, and that the first time a module is loaded in the editor will trigger generation of support files in the background if those do not already exist.
-
-### Configuration
-
-`ghcide` accepts the following lsp configuration options:
-
-```typescript
-{
-  // When to check the dependents of a module
-  // AlwaysCheck means retypechecking them on every change
-  // CheckOnSave means dependent/parent modules will only be checked when you save
-  // "CheckOnSaveAndClose" by default
-  checkParents : "NeverCheck" | "CheckOnClose" | "CheckOnSaveAndClose" | "AlwaysCheck" | ,
-  // Whether to check the entire project on initial load
-  // true by default
-  checkProject : boolean
-
-}
-```
-
-### Using with VS Code
-
-The [Haskell](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) extension has a setting for ghcide.
-
-### Using with Atom
-
-You can follow the [instructions](https://github.com/moodmosaic/ide-haskell-ghcide#readme) to install with `apm`.
-
-### Using with Sublime Text
-
-* Install [LSP](https://packagecontrol.io/packages/LSP)
-* Press Ctrl+Shift+P or Cmd+Shift+P in Sublime Text and search for *Preferences: LSP Settings*, then paste these settings
-```
-{
-  "clients":
-  {
-    "ghcide":
-    {
-      "enabled"   : true,
-      "languageId": "haskell",
-      "command"   : ["ghcide", "--lsp"],
-      "scopes"    : ["source.haskell"],
-      "syntaxes"  : ["Packages/Haskell/Haskell.sublime-syntax"]
-    }
-  }
-}
-```
-
-### Using with Emacs
-
-If you don't already have [MELPA](https://melpa.org/#/) package installation configured, visit MELPA [getting started](https://melpa.org/#/getting-started) page to get set up. Then, install [`use-package`](https://melpa.org/#/use-package).
-
-Now you have a choice of two different Emacs packages which can be used to communicate with the `ghcide` LSP server:
-
-+ `lsp-ui`
-+ `eglot` (requires Emacs 26.1+)
-
-In each case, you can enable support by adding the shown lines to your `.emacs`:
-
-#### lsp-ui
-
-```elisp
-;; LSP
-(use-package flycheck
-  :ensure t
-  :init
-  (global-flycheck-mode t))
-(use-package yasnippet
-  :ensure t)
-(use-package lsp-mode
-  :ensure t
-  :hook (haskell-mode . lsp)
-  :commands lsp)
-(use-package lsp-ui
-  :ensure t
-  :commands lsp-ui-mode)
-(use-package lsp-haskell
- :ensure t
- :config
- (setq lsp-haskell-process-path-hie "ghcide")
- (setq lsp-haskell-process-args-hie '())
- ;; Comment/uncomment this line to see interactions between lsp client/server.
- ;;(setq lsp-log-io t)
-)
-```
-
-#### eglot
-
-````elisp
-(use-package eglot
-  :ensure t
-  :config
-  (add-to-list 'eglot-server-programs '(haskell-mode . ("ghcide" "--lsp"))))
-````
-
-### Using with Vim/Neovim
-
-#### LanguageClient-neovim
-Install [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim)
-
-Add this to your vim config:
-```vim
-let g:LanguageClient_rootMarkers = ['*.cabal', 'stack.yaml']
-let g:LanguageClient_serverCommands = {
-    \ 'rust': ['rls'],
-    \ 'haskell': ['ghcide', '--lsp'],
-    \ }
-```
-
-Refer to `:he LanguageClient` for more details on usage and configuration.
-
-#### vim-lsp
-Install [vim-lsp](https://github.com/prabirshrestha/vim-lsp).
-
-Add this to your vim config:
-
-```vim
-au User lsp_setup call lsp#register_server({
-    \ 'name': 'ghcide',
-    \ 'cmd': {server_info->['/your/path/to/ghcide', '--lsp']},
-    \ 'whitelist': ['haskell'],
-    \ })
-```
-
-To verify it works move your cursor over a symbol and run `:LspHover`.
-
-### coc.nvim
-
-Install [coc.nvim](https://github.com/neoclide/coc.nvim)
-
-Add this to your coc-settings.json (which you can edit with :CocConfig):
-
-```json
-{
-  "languageserver": {
-    "haskell": {
-      "command": "ghcide",
-      "args": [
-        "--lsp"
-      ],
-      "rootPatterns": [
-        ".stack.yaml",
-        ".hie-bios",
-        "BUILD.bazel",
-        "cabal.config",
-        "package.yaml"
-      ],
-      "filetypes": [
-        "hs",
-        "lhs",
-        "haskell"
-      ]
-    }
-  }
-}
-```
-
-Here's a nice article on setting up neovim and coc: [Vim and Haskell in
-2019](http://marco-lopes.com/articles/Vim-and-Haskell-in-2019/) (this is actually for haskell-ide, not ghcide)
-
-Here is a Docker container that pins down the build and configuration for
-Neovim and ghcide on a minimal Debian 10 base system:
-[docker-ghcide-neovim](https://github.com/carlohamalainen/docker-ghcide-neovim/).
-
-### SpaceVim
-
-In the `autocomplete` layer, add the `autocomplete_method` option to force the use of `coc`:
-
-```toml
-[[layers]]
-  name = 'autocomplete'
-  auto-completion-return-key-behavior = "complete"
-  auto-completion-tab-key-behavior = "smart"
-  [options]
-    autocomplete_method = "coc"
-```
-
-Add this to your coc-settings.json (which you can edit with :CocConfig):
-
-```json
-{
-  "languageserver": {
-    "haskell": {
-      "command": "ghcide",
-      "args": [
-        "--lsp"
-      ],
-      "rootPatterns": [
-        ".stack.yaml",
-        ".hie-bios",
-        "BUILD.bazel",
-        "cabal.config",
-        "package.yaml"
-      ],
-      "filetypes": [
-        "hs",
-        "lhs",
-        "haskell"
-      ]
-    }
-  }
-}
-```
-
-This example above describes a setup in which `ghcide` is installed
-using `stack install ghcide` within a project.
-
-### Using with Kakoune
-
-Install [kak-lsp](https://github.com/ul/kak-lsp).
-
-Change `kak-lsp.toml` to include this:
-
-```toml
-[language.haskell]
-filetypes = ["haskell"]
-roots = ["Setup.hs", "stack.yaml", "*.cabal", "cabal.project", "hie.yaml"]
-command = "ghcide"
-args = ["--lsp"]
-```
-
-## Hacking on ghcide
-
-To build and work on `ghcide` itself, you should use cabal, e.g.,
-running `cabal test` will execute the test suite. You can use `stack test` too, but
-note that some tests will fail, and none of the maintainers are currently using `stack`.
-
-If you are using Nix, there is a Cachix nix-shell cache for all the supported platforms: `cachix use haskell-ghcide`.
-
-If you are using Windows, you should disable the `auto.crlf` setting and configure your editor to use LF line endings, directly or making it use the existing `.editor-config`.
-
-If you are chasing down test failures, you can use the tasty-rerun feature by running tests as
-
-    cabal test --test-options"--rerun"
-
-This writes a log file called `.tasty-rerun-log` of the failures, and only runs those.
-See the [tasty-rerun](https://hackage.haskell.org/package/tasty-rerun-1.1.17/docs/Test-Tasty-Ingredients-Rerun.html) documentation for other options.
-
-If you are touching performance sensitive code, take the time to run a differential
-benchmark between HEAD and master using the benchHist script. This assumes that
-"master" points to the upstream master.
-
-Run the benchmarks with `cabal bench`.
-
-It should take around 15 minutes and the results will be stored in the `bench-results` folder. To interpret the results, see the comments in the `bench/hist/Main.hs` module.
-
-More details in [bench/README](bench/README.md)
-
-
-## History and relationship to other Haskell IDE's
-
-The teams behind this project and the [`haskell-ide-engine`](https://github.com/haskell/haskell-ide-engine#readme) have agreed to join forces under the [`haskell-language-server` project](https://github.com/haskell/haskell-language-server), see the [original announcement](https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-them-all.html). The technical work is ongoing, with the likely model being that this project serves as the core, while plugins and integrations are kept in the [`haskell-language-server` project](https://github.com/haskell/haskell-language-server).
-
-The code behind `ghcide` was originally developed by [Digital Asset](https://digitalasset.com/) as part of the [DAML programming language](https://github.com/digital-asset/daml). DAML is a smart contract language targeting distributed-ledger runtimes, based on [GHC](https://www.haskell.org/ghc/) with custom language extensions. The DAML programming language has [an IDE](https://webide.daml.com/), and work was done to separate off a reusable Haskell-only IDE (what is now `ghcide`) which the [DAML IDE then builds upon](https://github.com/digital-asset/daml/tree/master/compiler/damlc). Since that time, there have been various [non-Digital Asset contributors](https://github.com/haskell/ghcide/graphs/contributors), in addition to continued investment by Digital Asset. The project has been handed over to Haskell.org as of September 2020.
-
-The Haskell community [has](https://github.com/DanielG/ghc-mod) [various](https://github.com/chrisdone/intero) [IDE](https://github.com/rikvdkleij/intellij-haskell) [choices](http://leksah.org/), but the one that had been gathering momentum is [`haskell-ide-engine`](https://github.com/haskell/haskell-ide-engine#readme). Our project owes a debt of gratitude to the `haskell-ide-engine`. We reuse libraries from their ecosystem, including [`hie-bios`](https://github.com/mpickering/hie-bios#readme) (a likely future environment setup layer in `haskell-ide-engine`), [`haskell-lsp`](https://github.com/alanz/haskell-lsp#readme) and [`lsp-test`](https://github.com/bubba/lsp-test#readme) (the `haskell-ide-engine` [LSP protocol](https://microsoft.github.io/language-server-protocol/) pieces). We make heavy use of their contributions to GHC itself, in particular the work to make GHC take string buffers rather than files.
-
-The best summary of the architecture of `ghcide` is available [this talk](https://www.youtube.com/watch?v=cijsaeWNf2E&list=PLxxF72uPfQVRdAsvj7THoys-nVj-oc4Ss) ([slides](https://ndmitchell.com/downloads/slides-making_a_haskell_ide-07_sep_2019.pdf)), given at [MuniHac 2019](https://munihac.de/2019.html). However, since that talk the project has renamed from `hie-core` to `ghcide`, and the repo has moved to [this location](https://github.com/haskell/ghcide/).
+# `ghcide` - A library for building Haskell IDE tooling++Our vision is that you should build an IDE by combining:++![vscode](https://raw.githubusercontent.com/haskell/ghcide/master/img/vscode2.png)++* [`hie-bios`](https://github.com/mpickering/hie-bios) for determining where your files are, what are their dependencies, what extensions are enabled and so on;+* `ghcide` (i.e. this library) for defining how to type check, when to type check, and producing diagnostic messages;+* A bunch of plugins that haven't yet been written, e.g. [`hie-hlint`](https://github.com/ndmitchell/hlint) and [`hie-ormolu`](https://github.com/tweag/ormolu), to choose which features you want;+* [`haskell-lsp`](https://github.com/alanz/haskell-lsp) for sending those messages to a [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) server;+* An LSP client for your editor.++There are more details about our approach [in this blog post](https://4ta.uk/p/shaking-up-the-ide).++## Features++`ghcide` already exports the following features via the lsp protocol:++| Feature | LSP name |+| - | - |+| Display error messages (parse errors, typecheck errors, etc.) and enabled warnings. | diagnostics |+| Go to definition in local package | definition  |+| Display type and source module of values | hover |+| Remove redundant imports, replace suggested typos for values and module imports, fill type holes, insert missing type signatures, add suggested ghc extensions  | codeAction (quickfix) |+++## Limitations to Multi-Component support++`ghcide` supports loading multiple components into the same session so that+features such as go-to definition work across components. However, there are+some limitations to this.++1. You will get much better results currently manually specifying the hie.yaml file.+Until tools like cabal and stack provide the right interface to support multi-component+projects, it is always advised to specify explicitly how your project partitions.+2. Cross-component features only work if you have loaded at least one file+from each component.+3. There is a known issue where if you have three components, such that A depends on B which depends on C+then if you load A and C into the session but not B then under certain situations you+can get strange errors about a type coming from two different places. See [this repo](https://github.com/fendor/ghcide-bad-interface-files) for+a simple reproduction of the bug.++## Using it++`ghcide` is not an end-user tool, [don't use `ghcide`](https://neilmitchell.blogspot.com/2020/09/dont-use-ghcide-anymore-directly.html) directly (more about the rationale [here](https://github.com/haskell/ghcide/pull/939)).++ [`haskell-language-server`](http://github.com/haskell/haskell-language-server) is an LSP server built on top of `ghcide` with additional features and a user friendly deployment model. To get it, simply install the [Haskell extension](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) in VS Code, or download prebuilt binaries from the [haskell-language-server](https://github.com/haskell/haskell-language-server) project page.+++The instructions below are meant for developers interested in setting up ghcide as an LSP server for testing purposes.++### Install `ghcide`++#### With Nix++Note that you need to compile `ghcide` with the same `ghc` as the project you are working on.++1. If the `ghc` you are using matches the version (or better is) from `nixpkgs` it‘s easiest to use the `ghcide` from `nixpkgs`. You can do so via+   ```+   nix-env -iA haskellPackages.ghcide+   ```+   or e.g. including `pkgs.haskellPackages.ghcide` in your projects `shell.nix`.+   Depending on your `nixpkgs` channel that might not be the newest `ghcide`, though.++2. If your `ghc` does not match nixpkgs you should try the [ghcide-nix repository](https://github.com/cachix/ghcide-nix)+   which provides a `ghcide` via the `haskell.nix` infrastructure.++#### With Cabal or Stack++First install the `ghcide` binary using `stack` or `cabal`, e.g.++1. `git clone https://github.com/haskell/ghcide.git`+2. `cd ghcide`+3. `cabal install` or `stack install` (and make sure `~/.local/bin` is on your `$PATH`)++It's important that `ghcide` is compiled with the same compiler you use to build your projects.++### Test `ghcide`++Next, check that `ghcide` is capable of loading your code. Change to the project directory and run `ghcide`, which will try and load everything using the same code as the IDE, but in a way that's much easier to understand. For example, taking the example of [`shake`](https://github.com/ndmitchell/shake), running `ghcide` gives some error messages and warnings before reporting at the end:++```console+Files that failed:+ * .\model\Main.hs+ * .\model\Model.hs+ * .\model\Test.hs+ * .\model\Util.hs+ * .\output\docs\Main.hs+ * .\output\docs\Part_Architecture_md.hs+Completed (152 worked, 6 failed)+```++Of the 158 files in Shake, as of this moment, 152 can be loaded by the IDE, but 6 can't (error messages for the reasons they can't be loaded are given earlier). The failing files are all prototype work or test output, meaning I can confidently use Shake.++The `ghcide` executable mostly relies on [`hie-bios`](https://github.com/mpickering/hie-bios) to do the difficult work of setting up your GHC environment. If it doesn't work, see [the `hie-bios` manual](https://github.com/mpickering/hie-bios#readme) to get it working. My default fallback is to figure it out by hand and create a `direct` style [`hie.yaml`](https://github.com/ndmitchell/shake/blob/master/hie.yaml) listing the command line arguments to load the project.++If you can't get `ghcide` working outside the editor, see [this setup troubleshooting guide](docs/Setup.md). Once you have got `ghcide` working outside the editor, the next step is to pick which editor to integrate with.++### Optimal project setup++`ghcide` has been designed to handle projects with hundreds or thousands of modules. If `ghci` can handle it, then `ghcide` should be able to handle it. The only caveat is that this currently requires GHC >= 8.6, and that the first time a module is loaded in the editor will trigger generation of support files in the background if those do not already exist.++### Configuration++`ghcide` accepts the following lsp configuration options:++```typescript+{+  // When to check the dependents of a module+  // AlwaysCheck means retypechecking them on every change+  // CheckOnSave means dependent/parent modules will only be checked when you save+  // "CheckOnSaveAndClose" by default+  checkParents : "NeverCheck" | "CheckOnClose" | "CheckOnSaveAndClose" | "AlwaysCheck" | ,+  // Whether to check the entire project on initial load+  // true by default+  checkProject : boolean++}+```++### Using with VS Code++The [Haskell](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) extension has a setting for ghcide.++### Using with Atom++You can follow the [instructions](https://github.com/moodmosaic/ide-haskell-ghcide#readme) to install with `apm`.++### Using with Sublime Text++* Install [LSP](https://packagecontrol.io/packages/LSP)+* Press Ctrl+Shift+P or Cmd+Shift+P in Sublime Text and search for *Preferences: LSP Settings*, then paste these settings+```+{+  "clients":+  {+    "ghcide":+    {+      "enabled"   : true,+      "languageId": "haskell",+      "command"   : ["ghcide", "--lsp"],+      "scopes"    : ["source.haskell"],+      "syntaxes"  : ["Packages/Haskell/Haskell.sublime-syntax"]+    }+  }+}+```++### Using with Emacs++If you don't already have [MELPA](https://melpa.org/#/) package installation configured, visit MELPA [getting started](https://melpa.org/#/getting-started) page to get set up. Then, install [`use-package`](https://melpa.org/#/use-package).++Now you have a choice of two different Emacs packages which can be used to communicate with the `ghcide` LSP server:+++ `lsp-ui`++ `eglot` (requires Emacs 26.1+)++In each case, you can enable support by adding the shown lines to your `.emacs`:++#### lsp-ui++```elisp+;; LSP+(use-package flycheck+  :ensure t+  :init+  (global-flycheck-mode t))+(use-package yasnippet+  :ensure t)+(use-package lsp-mode+  :ensure t+  :hook (haskell-mode . lsp)+  :commands lsp)+(use-package lsp-ui+  :ensure t+  :commands lsp-ui-mode)+(use-package lsp-haskell+ :ensure t+ :config+ (setq lsp-haskell-process-path-hie "ghcide")+ (setq lsp-haskell-process-args-hie '())+ ;; Comment/uncomment this line to see interactions between lsp client/server.+ ;;(setq lsp-log-io t)+)+```++#### eglot++````elisp+(use-package eglot+  :ensure t+  :config+  (add-to-list 'eglot-server-programs '(haskell-mode . ("ghcide" "--lsp"))))+````++### Using with Vim/Neovim++#### LanguageClient-neovim+Install [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim)++Add this to your vim config:+```vim+let g:LanguageClient_rootMarkers = ['*.cabal', 'stack.yaml']+let g:LanguageClient_serverCommands = {+    \ 'rust': ['rls'],+    \ 'haskell': ['ghcide', '--lsp'],+    \ }+```++Refer to `:he LanguageClient` for more details on usage and configuration.++#### vim-lsp+Install [vim-lsp](https://github.com/prabirshrestha/vim-lsp).++Add this to your vim config:++```vim+au User lsp_setup call lsp#register_server({+    \ 'name': 'ghcide',+    \ 'cmd': {server_info->['/your/path/to/ghcide', '--lsp']},+    \ 'whitelist': ['haskell'],+    \ })+```++To verify it works move your cursor over a symbol and run `:LspHover`.++### coc.nvim++Install [coc.nvim](https://github.com/neoclide/coc.nvim)++Add this to your coc-settings.json (which you can edit with :CocConfig):++```json+{+  "languageserver": {+    "haskell": {+      "command": "ghcide",+      "args": [+        "--lsp"+      ],+      "rootPatterns": [+        ".stack.yaml",+        ".hie-bios",+        "BUILD.bazel",+        "cabal.config",+        "package.yaml"+      ],+      "filetypes": [+        "hs",+        "lhs",+        "haskell"+      ]+    }+  }+}+```++Here's a nice article on setting up neovim and coc: [Vim and Haskell in+2019](http://marco-lopes.com/articles/Vim-and-Haskell-in-2019/) (this is actually for haskell-ide, not ghcide)++Here is a Docker container that pins down the build and configuration for+Neovim and ghcide on a minimal Debian 10 base system:+[docker-ghcide-neovim](https://github.com/carlohamalainen/docker-ghcide-neovim/).++### SpaceVim++In the `autocomplete` layer, add the `autocomplete_method` option to force the use of `coc`:++```toml+[[layers]]+  name = 'autocomplete'+  auto-completion-return-key-behavior = "complete"+  auto-completion-tab-key-behavior = "smart"+  [options]+    autocomplete_method = "coc"+```++Add this to your coc-settings.json (which you can edit with :CocConfig):++```json+{+  "languageserver": {+    "haskell": {+      "command": "ghcide",+      "args": [+        "--lsp"+      ],+      "rootPatterns": [+        ".stack.yaml",+        ".hie-bios",+        "BUILD.bazel",+        "cabal.config",+        "package.yaml"+      ],+      "filetypes": [+        "hs",+        "lhs",+        "haskell"+      ]+    }+  }+}+```++This example above describes a setup in which `ghcide` is installed+using `stack install ghcide` within a project.++### Using with Kakoune++Install [kak-lsp](https://github.com/ul/kak-lsp).++Change `kak-lsp.toml` to include this:++```toml+[language.haskell]+filetypes = ["haskell"]+roots = ["Setup.hs", "stack.yaml", "*.cabal", "cabal.project", "hie.yaml"]+command = "ghcide"+args = ["--lsp"]+```++## Hacking on ghcide++To build and work on `ghcide` itself, you should use cabal, e.g.,+running `cabal test` will execute the test suite. You can use `stack test` too, but+note that some tests will fail, and none of the maintainers are currently using `stack`.++If you are using Nix, there is a Cachix nix-shell cache for all the supported platforms: `cachix use haskell-ghcide`.++If you are using Windows, you should disable the `auto.crlf` setting and configure your editor to use LF line endings, directly or making it use the existing `.editor-config`.++If you are chasing down test failures, you can use the tasty-rerun feature by running tests as++    cabal test --test-options"--rerun"++This writes a log file called `.tasty-rerun-log` of the failures, and only runs those.+See the [tasty-rerun](https://hackage.haskell.org/package/tasty-rerun-1.1.17/docs/Test-Tasty-Ingredients-Rerun.html) documentation for other options.++If you are touching performance sensitive code, take the time to run a differential+benchmark between HEAD and master using the benchHist script. This assumes that+"master" points to the upstream master.++Run the benchmarks with `cabal bench`.++It should take around 15 minutes and the results will be stored in the `bench-results` folder. To interpret the results, see the comments in the `bench/hist/Main.hs` module.++More details in [bench/README](bench/README.md)+++## History and relationship to other Haskell IDE's++The teams behind this project and the [`haskell-ide-engine`](https://github.com/haskell/haskell-ide-engine#readme) have agreed to join forces under the [`haskell-language-server` project](https://github.com/haskell/haskell-language-server), see the [original announcement](https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-them-all.html). The technical work is ongoing, with the likely model being that this project serves as the core, while plugins and integrations are kept in the [`haskell-language-server` project](https://github.com/haskell/haskell-language-server).++The code behind `ghcide` was originally developed by [Digital Asset](https://digitalasset.com/) as part of the [DAML programming language](https://github.com/digital-asset/daml). DAML is a smart contract language targeting distributed-ledger runtimes, based on [GHC](https://www.haskell.org/ghc/) with custom language extensions. The DAML programming language has [an IDE](https://webide.daml.com/), and work was done to separate off a reusable Haskell-only IDE (what is now `ghcide`) which the [DAML IDE then builds upon](https://github.com/digital-asset/daml/tree/master/compiler/damlc). Since that time, there have been various [non-Digital Asset contributors](https://github.com/haskell/ghcide/graphs/contributors), in addition to continued investment by Digital Asset. The project has been handed over to Haskell.org as of September 2020.++The Haskell community [has](https://github.com/DanielG/ghc-mod) [various](https://github.com/chrisdone/intero) [IDE](https://github.com/rikvdkleij/intellij-haskell) [choices](http://leksah.org/), but the one that had been gathering momentum is [`haskell-ide-engine`](https://github.com/haskell/haskell-ide-engine#readme). Our project owes a debt of gratitude to the `haskell-ide-engine`. We reuse libraries from their ecosystem, including [`hie-bios`](https://github.com/mpickering/hie-bios#readme) (a likely future environment setup layer in `haskell-ide-engine`), [`haskell-lsp`](https://github.com/alanz/haskell-lsp#readme) and [`lsp-test`](https://github.com/bubba/lsp-test#readme) (the `haskell-ide-engine` [LSP protocol](https://microsoft.github.io/language-server-protocol/) pieces). We make heavy use of their contributions to GHC itself, in particular the work to make GHC take string buffers rather than files.++The best summary of the architecture of `ghcide` is available [this talk](https://www.youtube.com/watch?v=cijsaeWNf2E&list=PLxxF72uPfQVRdAsvj7THoys-nVj-oc4Ss) ([slides](https://ndmitchell.com/downloads/slides-making_a_haskell_ide-07_sep_2019.pdf)), given at [MuniHac 2019](https://munihac.de/2019.html). However, since that talk the project has renamed from `hie-core` to `ghcide`, and the repo has moved to [this location](https://github.com/haskell/ghcide/).

@@ -1,59 +1,59 @@-{- An automated benchmark built around the simple experiment described in:
-
-  > https://neilmitchell.blogspot.com/2020/05/fixing-space-leaks-in-ghcide.html
-
-  As an example project, it unpacks Cabal-3.2.0.0 in the local filesystem and
-  loads the module 'Distribution.Simple'. The rationale for this choice is:
-
-    - It's convenient to download with `cabal unpack Cabal-3.2.0.0`
-    - It has very few dependencies, and all are already needed to build ghcide
-    - Distribution.Simple has 235 transitive module dependencies, so non trivial
-
-  The experiments are sequences of lsp commands scripted using lsp-test.
-  A more refined approach would be to record and replay real IDE interactions,
-  once the replay functionality is available in lsp-test.
-  A more declarative approach would be to reuse ide-debug-driver:
-
-  > https://github.com/digital-asset/daml/blob/master/compiler/damlc/ide-debug-driver/README.md
-
-  The result of an experiment is a total duration in seconds after a preset
-  number of iterations. There is ample room for improvement:
-     - Statistical analysis to detect outliers and auto infer the number of iterations needed
-     - GC stats analysis (currently -S is printed as part of the experiment)
-     - Analyisis of performance over the commit history of the project
-
-  How to run:
-     1. `cabal exec cabal run ghcide-bench -- -- ghcide-bench-options`
-     1. `stack build ghcide:ghcide-bench && stack exec ghcide-bench -- -- ghcide-bench-options`
-
-  Note that the package database influences the response times of certain actions,
-  e.g. code actions, and therefore the two methods above do not necessarily
-  produce the same results.
-
- -}
-
-{-# LANGUAGE ImplicitParams #-}
-
-import Control.Exception.Safe
-import Experiments
-import Options.Applicative
-import System.IO
-import           Control.Monad
-
-optsP :: Parser (Config, Bool)
-optsP = (,) <$> configP <*> switch (long "no-clean")
-
-main :: IO ()
-main = do
-  hSetBuffering stdout LineBuffering
-  hSetBuffering stderr LineBuffering
-  (config, noClean) <- execParser $ info (optsP <**> helper) fullDesc
-  let ?config = config
-
-  hPrint stderr config
-
-  output "starting test"
-
-  SetupResult{..} <- setup
-
-  runBenchmarks experiments `finally` unless noClean cleanUp
+{- An automated benchmark built around the simple experiment described in:++  > https://neilmitchell.blogspot.com/2020/05/fixing-space-leaks-in-ghcide.html++  As an example project, it unpacks Cabal-3.2.0.0 in the local filesystem and+  loads the module 'Distribution.Simple'. The rationale for this choice is:++    - It's convenient to download with `cabal unpack Cabal-3.2.0.0`+    - It has very few dependencies, and all are already needed to build ghcide+    - Distribution.Simple has 235 transitive module dependencies, so non trivial++  The experiments are sequences of lsp commands scripted using lsp-test.+  A more refined approach would be to record and replay real IDE interactions,+  once the replay functionality is available in lsp-test.+  A more declarative approach would be to reuse ide-debug-driver:++  > https://github.com/digital-asset/daml/blob/master/compiler/damlc/ide-debug-driver/README.md++  The result of an experiment is a total duration in seconds after a preset+  number of iterations. There is ample room for improvement:+     - Statistical analysis to detect outliers and auto infer the number of iterations needed+     - GC stats analysis (currently -S is printed as part of the experiment)+     - Analyisis of performance over the commit history of the project++  How to run:+     1. `cabal exec cabal run ghcide-bench -- -- ghcide-bench-options`+     1. `stack build ghcide:ghcide-bench && stack exec ghcide-bench -- -- ghcide-bench-options`++  Note that the package database influences the response times of certain actions,+  e.g. code actions, and therefore the two methods above do not necessarily+  produce the same results.++ -}++{-# LANGUAGE ImplicitParams #-}++import           Control.Exception.Safe+import           Control.Monad+import           Experiments+import           Options.Applicative+import           System.IO++optsP :: Parser (Config, Bool)+optsP = (,) <$> configP <*> switch (long "no-clean")++main :: IO ()+main = do+  hSetBuffering stdout LineBuffering+  hSetBuffering stderr LineBuffering+  (config, noClean) <- execParser $ info (optsP <**> helper) fullDesc+  let ?config = config++  hPrint stderr config++  output "starting test"++  SetupResult{..} <- setup++  runBenchmarks experiments `finally` unless noClean cleanUp

@@ -1,192 +1,192 @@-{-  Bench history
-
-    A Shake script to analyze the performance of ghcide over the git history of the project
-
-    Driven by a config file `bench/config.yaml` containing the list of Git references to analyze.
-
-    Builds each one of them and executes a set of experiments using the ghcide-bench suite.
-
-    The results of the benchmarks and the analysis are recorded in the file
-    system with the following structure:
-
-    bench-results
-    ├── <git-reference>
-    │   ├── ghc.path                          - path to ghc used to build the binary
-    │   ├── ghcide                            - binary for this version
-    ├─ <example>
-    │   ├── results.csv                           - aggregated results for all the versions
-    │   └── <git-reference>
-    │       ├── <experiment>.gcStats.log          - RTS -s output
-    │       ├── <experiment>.csv                  - stats for the experiment
-    │       ├── <experiment>.svg                  - Graph of bytes over elapsed time
-    │       ├── <experiment>.diff.svg             - idem, including the previous version
-    │       ├── <experiment>.log                  - ghcide-bench output
-    │       └── results.csv                       - results of all the experiments for the example
-    ├── results.csv        - aggregated results of all the experiments and versions
-    └── <experiment>.svg   - graph of bytes over elapsed time, for all the included versions
-
-   For diff graphs, the "previous version" is the preceding entry in the list of versions
-   in the config file. A possible improvement is to obtain this info via `git rev-list`.
-
-   To execute the script:
-
-   > cabal/stack bench
-
-   To build a specific analysis, enumerate the desired file artifacts
-
-   > stack bench --ba "bench-results/HEAD/results.csv bench-results/HEAD/edit.diff.svg"
-   > cabal bench --benchmark-options "bench-results/HEAD/results.csv bench-results/HEAD/edit.diff.svg"
-
- -}
-{-# LANGUAGE DeriveAnyClass    #-}
-{-# LANGUAGE DerivingStrategies#-}
-{-# LANGUAGE TypeFamilies      #-}
-{-# OPTIONS -Wno-orphans #-}
-
-import Data.Foldable (find)
-import Data.Yaml (FromJSON (..), decodeFileThrow)
-import Development.Benchmark.Rules
-import Development.Shake
-import Experiments.Types (Example, exampleToOptions)
-import qualified Experiments.Types as E
-import GHC.Generics (Generic)
-import Numeric.Natural (Natural)
-import Development.Shake.Classes
-import System.Console.GetOpt
-import Data.Maybe
-import Control.Monad.Extra
-import System.FilePath
-
-
-configPath :: FilePath
-configPath = "bench/config.yaml"
-
-configOpt :: OptDescr (Either String FilePath)
-configOpt = Option [] ["config"] (ReqArg Right configPath) "config file"
-
--- | Read the config without dependency
-readConfigIO :: FilePath -> IO (Config BuildSystem)
-readConfigIO = decodeFileThrow
-
-instance IsExample Example where getExampleName = E.getExampleName
-type instance RuleResult GetExample = Maybe Example
-type instance RuleResult GetExamples = [Example]
-
-shakeOpts :: ShakeOptions
-shakeOpts =
-    shakeOptions{shakeChange = ChangeModtimeAndDigestInput, shakeThreads = 0}
-
-main :: IO ()
-main = shakeArgsWith shakeOpts [configOpt] $ \configs wants -> pure $ Just $ do
-  let config = fromMaybe configPath $ listToMaybe configs
-  _configStatic <- createBuildSystem config
-  case wants of
-      [] -> want ["all"]
-      _ -> want wants
-
-ghcideBuildRules :: MkBuildRules BuildSystem
-ghcideBuildRules = MkBuildRules findGhcForBuildSystem "ghcide" projectDepends buildGhcide
-  where
-      projectDepends = do
-        need . map ("src" </>) =<< getDirectoryFiles "src" ["//*.hs"]
-        need . map ("session-loader" </>) =<< getDirectoryFiles "session-loader" ["//*.hs"]
-        need =<< getDirectoryFiles "." ["*.cabal"]
-
---------------------------------------------------------------------------------
-
-data Config buildSystem = Config
-  { experiments :: [Unescaped String],
-    examples :: [Example],
-    samples :: Natural,
-    versions :: [GitCommit],
-    -- | Output folder ('foo' works, 'foo/bar' does not)
-    outputFolder :: String,
-    buildTool :: buildSystem,
-    profileInterval :: Maybe Double
-  }
-  deriving (Generic, Show)
-  deriving anyclass (FromJSON)
-
-createBuildSystem :: FilePath -> Rules (Config BuildSystem )
-createBuildSystem config = do
-  readConfig <- newCache $ \fp -> need [fp] >> liftIO (readConfigIO fp)
-
-  _ <- addOracle $ \GetExperiments {} -> experiments <$> readConfig config
-  _ <- addOracle $ \GetVersions {} -> versions <$> readConfig config
-  _ <- versioned 1 $ addOracle $ \GetExamples{} -> examples <$> readConfig config
-  _ <- versioned 1 $ addOracle $ \(GetExample name) -> find (\e -> getExampleName e == name) . examples <$> readConfig config
-  _ <- addOracle $ \GetBuildSystem {} -> buildTool <$> readConfig config
-  _ <- addOracle $ \GetSamples{} -> samples <$> readConfig config
-
-  configStatic <- liftIO $ readConfigIO config
-  let build = outputFolder configStatic
-
-  buildRules build ghcideBuildRules
-  benchRules build (MkBenchRules (askOracle $ GetSamples ()) benchGhcide warmupGhcide "ghcide")
-  csvRules build
-  svgRules build
-  heapProfileRules build
-  phonyRules "" "ghcide" NoProfiling build (examples configStatic)
-
-  whenJust (profileInterval configStatic) $ \i -> do
-    phonyRules "profiled-" "ghcide" (CheapHeapProfiling i) build (examples configStatic)
-
-  return configStatic
-
-newtype GetSamples = GetSamples () deriving newtype (Binary, Eq, Hashable, NFData, Show)
-type instance RuleResult GetSamples = Natural
-
---------------------------------------------------------------------------------
-
-buildGhcide :: BuildSystem -> [CmdOption] -> FilePath -> Action ()
-buildGhcide Cabal args out = do
-    command_ args "cabal"
-        ["install"
-        ,"exe:ghcide"
-        ,"--installdir=" ++ out
-        ,"--install-method=copy"
-        ,"--overwrite-policy=always"
-        ,"--ghc-options=-rtsopts"
-        ,"--ghc-options=-eventlog"
-        ]
-
-buildGhcide Stack args out =
-    command_ args "stack"
-        ["--local-bin-path=" <> out
-        ,"build"
-        ,"ghcide:ghcide"
-        ,"--copy-bins"
-        ,"--ghc-options=-rtsopts"
-        ,"--ghc-options=-eventlog"
-        ]
-
-benchGhcide
-  :: Natural -> BuildSystem -> [CmdOption] -> BenchProject Example -> Action ()
-benchGhcide samples buildSystem args BenchProject{..} = do
-  command_ args "ghcide-bench" $
-    [ "--timeout=300",
-      "--no-clean",
-        "-v",
-        "--samples=" <> show samples,
-        "--csv="     <> outcsv,
-        "--ghcide="  <> exePath,
-        "--ghcide-options=" <> unwords exeExtraArgs,
-        "--select",
-        unescaped (unescapeExperiment experiment)
-    ] ++
-    exampleToOptions example ++
-    [ "--stack" | Stack == buildSystem
-    ]
-
-warmupGhcide :: BuildSystem -> FilePath -> [CmdOption] -> Example -> Action ()
-warmupGhcide buildSystem exePath args example = do
-  command args "ghcide-bench" $
-    [ "--no-clean",
-      "-v",
-      "--samples=1",
-      "--ghcide=" <> exePath,
-      "--select=hover"
-    ] ++
-    exampleToOptions example ++
-    [ "--stack" | Stack == buildSystem
-    ]
+{-  Bench history++    A Shake script to analyze the performance of ghcide over the git history of the project++    Driven by a config file `bench/config.yaml` containing the list of Git references to analyze.++    Builds each one of them and executes a set of experiments using the ghcide-bench suite.++    The results of the benchmarks and the analysis are recorded in the file+    system with the following structure:++    bench-results+    ├── <git-reference>+    │   ├── ghc.path                          - path to ghc used to build the binary+    │   ├── ghcide                            - binary for this version+    ├─ <example>+    │   ├── results.csv                           - aggregated results for all the versions+    │   └── <git-reference>+    │       ├── <experiment>.gcStats.log          - RTS -s output+    │       ├── <experiment>.csv                  - stats for the experiment+    │       ├── <experiment>.svg                  - Graph of bytes over elapsed time+    │       ├── <experiment>.diff.svg             - idem, including the previous version+    │       ├── <experiment>.log                  - ghcide-bench output+    │       └── results.csv                       - results of all the experiments for the example+    ├── results.csv        - aggregated results of all the experiments and versions+    └── <experiment>.svg   - graph of bytes over elapsed time, for all the included versions++   For diff graphs, the "previous version" is the preceding entry in the list of versions+   in the config file. A possible improvement is to obtain this info via `git rev-list`.++   To execute the script:++   > cabal/stack bench++   To build a specific analysis, enumerate the desired file artifacts++   > stack bench --ba "bench-results/HEAD/results.csv bench-results/HEAD/edit.diff.svg"+   > cabal bench --benchmark-options "bench-results/HEAD/results.csv bench-results/HEAD/edit.diff.svg"++ -}+{-# LANGUAGE DeriveAnyClass     #-}+{-# LANGUAGE DerivingStrategies #-}+{-# LANGUAGE TypeFamilies       #-}+{-# OPTIONS -Wno-orphans #-}++import           Control.Monad.Extra+import           Data.Foldable               (find)+import           Data.Maybe+import           Data.Yaml                   (FromJSON (..), decodeFileThrow)+import           Development.Benchmark.Rules+import           Development.Shake+import           Development.Shake.Classes+import           Experiments.Types           (Example, exampleToOptions)+import qualified Experiments.Types           as E+import           GHC.Generics                (Generic)+import           Numeric.Natural             (Natural)+import           System.Console.GetOpt+import           System.FilePath+++configPath :: FilePath+configPath = "bench/config.yaml"++configOpt :: OptDescr (Either String FilePath)+configOpt = Option [] ["config"] (ReqArg Right configPath) "config file"++-- | Read the config without dependency+readConfigIO :: FilePath -> IO (Config BuildSystem)+readConfigIO = decodeFileThrow++instance IsExample Example where getExampleName = E.getExampleName+type instance RuleResult GetExample = Maybe Example+type instance RuleResult GetExamples = [Example]++shakeOpts :: ShakeOptions+shakeOpts =+    shakeOptions{shakeChange = ChangeModtimeAndDigestInput, shakeThreads = 0}++main :: IO ()+main = shakeArgsWith shakeOpts [configOpt] $ \configs wants -> pure $ Just $ do+  let config = fromMaybe configPath $ listToMaybe configs+  _configStatic <- createBuildSystem config+  case wants of+      [] -> want ["all"]+      _  -> want wants++ghcideBuildRules :: MkBuildRules BuildSystem+ghcideBuildRules = MkBuildRules findGhcForBuildSystem "ghcide" projectDepends buildGhcide+  where+      projectDepends = do+        need . map ("src" </>) =<< getDirectoryFiles "src" ["//*.hs"]+        need . map ("session-loader" </>) =<< getDirectoryFiles "session-loader" ["//*.hs"]+        need =<< getDirectoryFiles "." ["*.cabal"]++--------------------------------------------------------------------------------++data Config buildSystem = Config+  { experiments     :: [Unescaped String],+    examples        :: [Example],+    samples         :: Natural,+    versions        :: [GitCommit],+    -- | Output folder ('foo' works, 'foo/bar' does not)+    outputFolder    :: String,+    buildTool       :: buildSystem,+    profileInterval :: Maybe Double+  }+  deriving (Generic, Show)+  deriving anyclass (FromJSON)++createBuildSystem :: FilePath -> Rules (Config BuildSystem )+createBuildSystem config = do+  readConfig <- newCache $ \fp -> need [fp] >> liftIO (readConfigIO fp)++  _ <- addOracle $ \GetExperiments {} -> experiments <$> readConfig config+  _ <- addOracle $ \GetVersions {} -> versions <$> readConfig config+  _ <- versioned 1 $ addOracle $ \GetExamples{} -> examples <$> readConfig config+  _ <- versioned 1 $ addOracle $ \(GetExample name) -> find (\e -> getExampleName e == name) . examples <$> readConfig config+  _ <- addOracle $ \GetBuildSystem {} -> buildTool <$> readConfig config+  _ <- addOracle $ \GetSamples{} -> samples <$> readConfig config++  configStatic <- liftIO $ readConfigIO config+  let build = outputFolder configStatic++  buildRules build ghcideBuildRules+  benchRules build (MkBenchRules (askOracle $ GetSamples ()) benchGhcide warmupGhcide "ghcide")+  csvRules build+  svgRules build+  heapProfileRules build+  phonyRules "" "ghcide" NoProfiling build (examples configStatic)++  whenJust (profileInterval configStatic) $ \i -> do+    phonyRules "profiled-" "ghcide" (CheapHeapProfiling i) build (examples configStatic)++  return configStatic++newtype GetSamples = GetSamples () deriving newtype (Binary, Eq, Hashable, NFData, Show)+type instance RuleResult GetSamples = Natural++--------------------------------------------------------------------------------++buildGhcide :: BuildSystem -> [CmdOption] -> FilePath -> Action ()+buildGhcide Cabal args out = do+    command_ args "cabal"+        ["install"+        ,"exe:ghcide"+        ,"--installdir=" ++ out+        ,"--install-method=copy"+        ,"--overwrite-policy=always"+        ,"--ghc-options=-rtsopts"+        ,"--ghc-options=-eventlog"+        ]++buildGhcide Stack args out =+    command_ args "stack"+        ["--local-bin-path=" <> out+        ,"build"+        ,"ghcide:ghcide"+        ,"--copy-bins"+        ,"--ghc-options=-rtsopts"+        ,"--ghc-options=-eventlog"+        ]++benchGhcide+  :: Natural -> BuildSystem -> [CmdOption] -> BenchProject Example -> Action ()+benchGhcide samples buildSystem args BenchProject{..} = do+  command_ args "ghcide-bench" $+    [ "--timeout=300",+      "--no-clean",+        "-v",+        "--samples=" <> show samples,+        "--csv="     <> outcsv,+        "--ghcide="  <> exePath,+        "--ghcide-options=" <> unwords exeExtraArgs,+        "--select",+        unescaped (unescapeExperiment experiment)+    ] +++    exampleToOptions example +++    [ "--stack" | Stack == buildSystem+    ]++warmupGhcide :: BuildSystem -> FilePath -> [CmdOption] -> Example -> Action ()+warmupGhcide buildSystem exePath args example = do+  command args "ghcide-bench" $+    [ "--no-clean",+      "-v",+      "--samples=1",+      "--ghcide=" <> exePath,+      "--select=hover"+    ] +++    exampleToOptions example +++    [ "--stack" | Stack == buildSystem+    ]

@@ -1,573 +1,574 @@-{-# LANGUAGE ConstraintKinds #-}
-{-# LANGUAGE GADTs #-}
-{-# LANGUAGE ExistentialQuantification #-}
-{-# LANGUAGE ImplicitParams #-}
-{-# LANGUAGE ImpredicativeTypes #-}
-{-# OPTIONS_GHC -Wno-deprecations -Wno-unticked-promoted-constructors #-}
-
-module Experiments
-( Bench(..)
-, BenchRun(..)
-, Config(..)
-, Verbosity(..)
-, CabalStack(..)
-, SetupResult(..)
-, Example(..)
-, experiments
-, configP
-, defConfig
-, output
-, setup
-, runBench
-, exampleToOptions
-) where
-import Control.Applicative.Combinators (skipManyTill)
-import Control.Exception.Safe (IOException, handleAny, try)
-import Control.Monad.Extra
-import Control.Monad.IO.Class
-import Data.Aeson (Value(Null), toJSON)
-import Data.List
-import Data.Maybe
-import qualified Data.Text as T
-import Data.Version
-import Development.IDE.Plugin.Test
-import Experiments.Types
-import Language.LSP.Test
-import Language.LSP.Types
-import Language.LSP.Types.Capabilities
-import Numeric.Natural
-import Options.Applicative
-import System.Directory
-import System.Environment.Blank (getEnv)
-import System.FilePath ((</>), (<.>))
-import System.Process
-import System.Time.Extra
-import Text.ParserCombinators.ReadP (readP_to_S)
-import Development.Shake (cmd_, CmdOption (Cwd, FileStdout))
-
-charEdit :: Position -> TextDocumentContentChangeEvent
-charEdit p =
-    TextDocumentContentChangeEvent
-    { _range = Just (Range p p),
-      _rangeLength = Nothing,
-      _text = "a"
-    }
-
-data DocumentPositions = DocumentPositions {
-    identifierP :: Maybe Position,
-    stringLiteralP :: !Position,
-    doc :: !TextDocumentIdentifier
-}
-
-allWithIdentifierPos :: Monad m => (DocumentPositions -> m Bool) -> [DocumentPositions] -> m Bool
-allWithIdentifierPos f docs = allM f (filter (isJust . identifierP) docs)
-
-experiments :: [Bench]
-experiments =
-    [ ---------------------------------------------------------------------------------------
-      bench "hover" $ allWithIdentifierPos $ \DocumentPositions{..} ->
-        isJust <$> getHover doc (fromJust identifierP),
-      ---------------------------------------------------------------------------------------
-      bench "edit" $ \docs -> do
-        forM_ docs $ \DocumentPositions{..} ->
-          changeDoc doc [charEdit stringLiteralP]
-        waitForProgressDone -- TODO check that this waits for all of them
-        return True,
-      ---------------------------------------------------------------------------------------
-      bench "hover after edit" $ \docs -> do
-        forM_ docs $ \DocumentPositions{..} ->
-          changeDoc doc [charEdit stringLiteralP]
-        flip allWithIdentifierPos docs $ \DocumentPositions{..} ->
-          isJust <$> getHover doc (fromJust identifierP),
-      ---------------------------------------------------------------------------------------
-      bench "getDefinition" $ allWithIdentifierPos $ \DocumentPositions{..} ->
-        either (not . null) (not . null) . toEither <$> getDefinitions doc (fromJust identifierP),
-      ---------------------------------------------------------------------------------------
-      bench "getDefinition after edit" $ \docs -> do
-          forM_ docs $ \DocumentPositions{..} ->
-            changeDoc doc [charEdit stringLiteralP]
-          flip allWithIdentifierPos docs $ \DocumentPositions{..} ->
-            either (not . null) (not . null) . toEither <$> getDefinitions doc (fromJust identifierP),
-      ---------------------------------------------------------------------------------------
-      bench "documentSymbols" $ allM $ \DocumentPositions{..} -> do
-        fmap (either (not . null) (not . null)) . getDocumentSymbols $ doc,
-      ---------------------------------------------------------------------------------------
-      bench "documentSymbols after edit" $ \docs -> do
-        forM_ docs $ \DocumentPositions{..} ->
-          changeDoc doc [charEdit stringLiteralP]
-        flip allM docs $ \DocumentPositions{..} ->
-          either (not . null) (not . null) <$> getDocumentSymbols doc,
-      ---------------------------------------------------------------------------------------
-      bench "completions" $ \docs -> do
-        flip allWithIdentifierPos docs $ \DocumentPositions{..} ->
-          not . null <$> getCompletions doc (fromJust identifierP),
-      ---------------------------------------------------------------------------------------
-      bench "completions after edit" $ \docs -> do
-        forM_ docs $ \DocumentPositions{..} ->
-          changeDoc doc [charEdit stringLiteralP]
-        flip allWithIdentifierPos docs $ \DocumentPositions{..} ->
-          not . null <$> getCompletions doc (fromJust identifierP),
-      ---------------------------------------------------------------------------------------
-      benchWithSetup
-        "code actions"
-        ( \docs -> do
-            unless (any (isJust . identifierP) docs) $
-                error "None of the example modules is suitable for this experiment"
-            forM_ docs $ \DocumentPositions{..} ->
-                forM_ identifierP $ \p -> changeDoc doc [charEdit p]
-            waitForProgressDone
-        )
-        ( \docs -> not . null . catMaybes <$> forM docs (\DocumentPositions{..} ->
-            forM identifierP $ \p ->
-              getCodeActions doc (Range p p))
-        ),
-      ---------------------------------------------------------------------------------------
-      benchWithSetup
-        "code actions after edit"
-        ( \docs -> do
-            unless (any (isJust . identifierP) docs) $
-                error "None of the example modules is suitable for this experiment"
-            forM_ docs $ \DocumentPositions{..} ->
-                forM_ identifierP $ \p -> changeDoc doc [charEdit p]
-        )
-        ( \docs -> do
-            forM_ docs $ \DocumentPositions{..} ->
-              changeDoc doc [charEdit stringLiteralP]
-            waitForProgressDone
-            not . null . catMaybes <$> forM docs (\DocumentPositions{..} -> do
-              forM identifierP $ \p ->
-                getCodeActions doc (Range p p))
-        ),
-      ---------------------------------------------------------------------------------------
-      benchWithSetup
-        "code actions after cradle edit"
-        ( \docs -> do
-            unless (any (isJust . identifierP) docs) $
-                error "None of the example modules is suitable for this experiment"
-            forM_ docs $ \DocumentPositions{..} ->
-                forM_ identifierP $ \p -> changeDoc doc [charEdit p]
-        )
-        ( \docs -> do
-            Just hieYaml <- uriToFilePath <$> getDocUri "hie.yaml"
-            liftIO $ appendFile hieYaml "##\n"
-            sendNotification SWorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams $
-                List [ FileEvent (filePathToUri "hie.yaml") FcChanged ]
-            forM_ docs $ \DocumentPositions{..} ->
-              changeDoc doc [charEdit stringLiteralP]
-            waitForProgressDone
-            not . null . catMaybes <$> forM docs (\DocumentPositions{..} -> do
-              forM identifierP $ \p ->
-                getCodeActions doc (Range p p))
-        ),
-      ---------------------------------------------------------------------------------------
-      bench
-        "hover after cradle edit"
-        (\docs -> do
-            Just hieYaml <- uriToFilePath <$> getDocUri "hie.yaml"
-            liftIO $ appendFile hieYaml "##\n"
-            sendNotification SWorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams $
-                List [ FileEvent (filePathToUri "hie.yaml") FcChanged ]
-            flip allWithIdentifierPos docs $ \DocumentPositions{..} -> isJust <$> getHover doc (fromJust identifierP)
-        )
-    ]
-
----------------------------------------------------------------------------------------------
-
-examplesPath :: FilePath
-examplesPath = "bench/example"
-
-defConfig :: Config
-Success defConfig = execParserPure defaultPrefs (info configP fullDesc) []
-
-quiet, verbose :: Config -> Bool
-verbose = (== All) . verbosity
-quiet   = (== Quiet) . verbosity
-
-type HasConfig = (?config :: Config)
-
-configP :: Parser Config
-configP =
-  Config
-    <$> (flag' All (short 'v' <> long "verbose")
-         <|> flag' Quiet (short 'q' <> long "quiet")
-         <|> pure Normal
-        )
-    <*> optional (strOption (long "shake-profiling" <> metavar "PATH"))
-    <*> optional (strOption (long "ot-profiling" <> metavar "DIR" <> help "Enable OpenTelemetry and write eventlog for each benchmark in DIR"))
-    <*> strOption (long "csv" <> metavar "PATH" <> value "results.csv" <> showDefault)
-    <*> flag Cabal Stack (long "stack" <> help "Use stack (by default cabal is used)")
-    <*> many (strOption (long "ghcide-options" <> help "additional options for ghcide"))
-    <*> many (strOption (short 's' <> long "select" <> help "select which benchmarks to run"))
-    <*> optional (option auto (long "samples" <> metavar "NAT" <> help "override sampling count"))
-    <*> strOption (long "ghcide" <> metavar "PATH" <> help "path to ghcide" <> value "ghcide")
-    <*> option auto (long "timeout" <> value 60 <> help "timeout for waiting for a ghcide response")
-    <*> ( GetPackage <$> strOption (long "example-package-name" <> value "Cabal")
-               <*> (some moduleOption <|> pure ["Distribution/Simple.hs"])
-               <*> option versionP (long "example-package-version" <> value (makeVersion [3,2,0,0]))
-         <|>
-          UsePackage <$> strOption (long "example-path")
-                     <*> some moduleOption
-         )
-  where
-      moduleOption = strOption (long "example-module" <> metavar "PATH")
-
-versionP :: ReadM Version
-versionP = maybeReader $ extract . readP_to_S parseVersion
-  where
-      extract parses = listToMaybe [ res | (res,"") <- parses]
-
-output :: (MonadIO m, HasConfig) => String -> m ()
-output = if quiet?config then (\_ -> pure ()) else liftIO . putStrLn
-
----------------------------------------------------------------------------------------
-
-type Experiment = [DocumentPositions] -> Session Bool
-
-data Bench =
-  Bench
-  { name :: !String,
-    enabled :: !Bool,
-    samples :: !Natural,
-    benchSetup :: [DocumentPositions] -> Session (),
-    experiment :: Experiment
-  }
-
-select :: HasConfig => Bench -> Bool
-select Bench {name, enabled} =
-  enabled && (null mm || name `elem` mm)
-  where
-    mm = matches ?config
-
-benchWithSetup ::
-  String ->
-  ([DocumentPositions] -> Session ()) ->
-  Experiment ->
-  Bench
-benchWithSetup name benchSetup experiment = Bench {..}
-  where
-    enabled = True
-    samples = 100
-
-bench :: String -> Experiment -> Bench
-bench name = benchWithSetup name (const $ pure ())
-
-runBenchmarksFun :: HasConfig => FilePath -> [Bench] -> IO ()
-runBenchmarksFun dir allBenchmarks = do
-  let benchmarks = [ b{samples = fromMaybe 100 (repetitions ?config) }
-                   | b <- allBenchmarks
-                   , select b ]
-
-  whenJust (otMemoryProfiling ?config) $ \eventlogDir ->
-      createDirectoryIfMissing True eventlogDir
-
-  results <- forM benchmarks $ \b@Bench{name} -> do
-                let run = runSessionWithConfig conf (cmd name dir) lspTestCaps dir
-                (b,) <$> runBench run b
-
-  -- output raw data as CSV
-  let headers =
-        [ "name"
-        , "success"
-        , "samples"
-        , "startup"
-        , "setup"
-        , "userTime"
-        , "delayedTime"
-        , "totalTime"
-        ]
-      rows =
-        [ [ name,
-            show success,
-            show samples,
-            show startup,
-            show runSetup',
-            show userWaits,
-            show delayedWork,
-            show runExperiment
-          ]
-          | (Bench {name, samples}, BenchRun {..}) <- results,
-            let runSetup' = if runSetup < 0.01 then 0 else runSetup
-        ]
-      csv = unlines $ map (intercalate ", ") (headers : rows)
-  writeFile (outputCSV ?config) csv
-
-  -- print a nice table
-  let pads = map (maximum . map length) (transpose (headers : rowsHuman))
-      paddedHeaders = zipWith pad pads headers
-      outputRow = putStrLn . intercalate " | "
-      rowsHuman =
-        [ [ name,
-            show success,
-            show samples,
-            showDuration startup,
-            showDuration runSetup',
-            showDuration userWaits,
-            showDuration delayedWork,
-            showDuration runExperiment
-          ]
-          | (Bench {name, samples}, BenchRun {..}) <- results,
-            let runSetup' = if runSetup < 0.01 then 0 else runSetup
-        ]
-  outputRow paddedHeaders
-  outputRow $ (map . map) (const '-') paddedHeaders
-  forM_ rowsHuman $ \row -> outputRow $ zipWith pad pads row
-  where
-    ghcideCmd dir =
-        [ ghcide ?config,
-          "--lsp",
-          "--test",
-          "--cwd",
-          dir,
-          "+RTS"
-        ]
-    cmd name dir =
-      unwords $
-            ghcideCmd dir
-          ++ case otMemoryProfiling ?config of
-            Just dir -> ["-l", "-ol" ++ (dir </> map (\c -> if c == ' ' then '-' else c) name <.> "eventlog")]
-            Nothing -> []
-          ++ [ "-RTS" ]
-          ++ ghcideOptions ?config
-          ++ concat
-            [ ["--shake-profiling", path] | Just path <- [shakeProfiling ?config]
-            ]
-          ++ ["--verbose" | verbose ?config]
-          ++ ["--ot-memory-profiling" | Just _ <- [otMemoryProfiling ?config]]
-    lspTestCaps =
-      fullCaps {_window = Just $ WindowClientCapabilities $ Just True}
-    conf =
-      defaultConfig
-        { logStdErr = verbose ?config,
-          logMessages = verbose ?config,
-          logColor = False,
-          messageTimeout = timeoutLsp ?config
-        }
-
-data BenchRun = BenchRun
-  { startup :: !Seconds,
-    runSetup :: !Seconds,
-    runExperiment :: !Seconds,
-    userWaits :: !Seconds,
-    delayedWork :: !Seconds,
-    success :: !Bool
-  }
-
-badRun :: BenchRun
-badRun = BenchRun 0 0 0 0 0 False
-
--- | Wait for all progress to be done
--- Needs at least one progress done notification to return
-waitForProgressDone :: Session ()
-waitForProgressDone = loop
-  where
-    loop = do
-      ~() <- skipManyTill anyMessage $ satisfyMaybe $ \case
-        FromServerMess SProgress (NotificationMessage _ _ (ProgressParams _ (End _))) -> Just ()
-        _ -> Nothing
-      done <- null <$> getIncompleteProgressSessions
-      unless done loop
-
-runBench ::
-  (?config :: Config) =>
-  (Session BenchRun -> IO BenchRun) ->
-  Bench ->
-  IO BenchRun
-runBench runSess b = handleAny (\e -> print e >> return badRun)
-  $ runSess
-  $ do
-    case b of
-     Bench{..} -> do
-      (startup, docs) <- duration $ do
-        (d, docs) <- duration $ setupDocumentContents ?config
-        output $ "Setting up document contents took " <> showDuration d
-        -- wait again, as the progress is restarted once while loading the cradle
-        -- make an edit, to ensure this doesn't block
-        let DocumentPositions{..} = head docs
-        changeDoc doc [charEdit stringLiteralP]
-        waitForProgressDone
-        return docs
-
-      liftIO $ output $ "Running " <> name <> " benchmark"
-      (runSetup, ()) <- duration $ benchSetup docs
-      let loop !userWaits !delayedWork 0 = return $ Just (userWaits, delayedWork)
-          loop !userWaits !delayedWork n = do
-            (t, res) <- duration $ experiment docs
-            if not res
-              then return Nothing
-            else do
-                output (showDuration t)
-                -- Wait for the delayed actions to finish
-                let m = SCustomMethod "test"
-                waitId <- sendRequest m (toJSON WaitForShakeQueue)
-                (td, resp) <- duration $ skipManyTill anyMessage $ responseForId m waitId
-                case resp of
-                    ResponseMessage{_result=Right Null} -> do
-                      loop (userWaits+t) (delayedWork+td) (n -1)
-                    _ ->
-                    -- Assume a ghcide build lacking the WaitForShakeQueue command
-                      loop (userWaits+t) delayedWork (n -1)
-
-      (runExperiment, result) <- duration $ loop 0 0 samples
-      let success = isJust result
-          (userWaits, delayedWork) = fromMaybe (0,0) result
-
-      return BenchRun {..}
-
-data SetupResult = SetupResult {
-    runBenchmarks :: [Bench] -> IO (),
-    -- | Path to the setup benchmark example
-    benchDir :: FilePath,
-    cleanUp :: IO ()
-}
-
-callCommandLogging :: HasConfig => String -> IO ()
-callCommandLogging cmd = do
-    output cmd
-    callCommand cmd
-
-setup :: HasConfig => IO SetupResult
-setup = do
---   when alreadyExists $ removeDirectoryRecursive examplesPath
-  benchDir <- case example ?config of
-      UsePackage{..} -> do
-          let hieYamlPath = examplePath </> "hie.yaml"
-          alreadyExists <- doesFileExist hieYamlPath
-          unless alreadyExists $
-                cmd_ (Cwd examplePath) (FileStdout hieYamlPath) ("gen-hie"::String)
-          return examplePath
-      GetPackage{..} -> do
-        let path = examplesPath </> package
-            package = exampleName <> "-" <> showVersion exampleVersion
-            hieYamlPath = path </> "hie.yaml"
-        alreadySetup <- doesDirectoryExist path
-        unless alreadySetup $
-          case buildTool ?config of
-            Cabal -> do
-                let cabalVerbosity = "-v" ++ show (fromEnum (verbose ?config))
-                callCommandLogging $ "cabal get " <> cabalVerbosity <> " " <> package <> " -d " <> examplesPath
-                let hieYamlPath = path </> "hie.yaml"
-                cmd_ (Cwd path) (FileStdout hieYamlPath) ("gen-hie"::String)
-                -- Need this in case there is a parent cabal.project somewhere
-                writeFile
-                    (path </> "cabal.project")
-                    "packages: ."
-                writeFile
-                    (path </> "cabal.project.local")
-                    ""
-            Stack -> do
-                let stackVerbosity = case verbosity ?config of
-                        Quiet -> "--silent"
-                        Normal -> ""
-                        All -> "--verbose"
-                callCommandLogging $ "stack " <> stackVerbosity <> " unpack " <> package <> " --to " <> examplesPath
-                -- Generate the stack descriptor to match the one used to build ghcide
-                stack_yaml <- fromMaybe "stack.yaml" <$> getEnv "STACK_YAML"
-                stack_yaml_lines <- lines <$> readFile stack_yaml
-                writeFile (path </> stack_yaml)
-                        (unlines $
-                        "packages: [.]" :
-                            [ l
-                            | l <- stack_yaml_lines
-                            , any (`isPrefixOf` l)
-                                ["resolver"
-                                ,"allow-newer"
-                                ,"compiler"]
-                            ]
-                        )
-
-                cmd_ (Cwd path) (FileStdout hieYamlPath) ("gen-hie"::String) ["--stack"::String]
-        return path
-
-  whenJust (shakeProfiling ?config) $ createDirectoryIfMissing True
-
-  let cleanUp = case example ?config of
-        GetPackage{} -> removeDirectoryRecursive examplesPath
-        UsePackage{} -> return ()
-
-      runBenchmarks = runBenchmarksFun benchDir
-
-  return SetupResult{..}
-
-setupDocumentContents :: Config -> Session [DocumentPositions]
-setupDocumentContents config =
-        forM (exampleModules $ example config) $ \m -> do
-        doc <- openDoc m "haskell"
-
-        -- Setup the special positions used by the experiments
-        lastLine <- length . T.lines <$> documentContents doc
-        changeDoc doc [TextDocumentContentChangeEvent
-            { _range = Just (Range (Position lastLine 0) (Position lastLine 0))
-            , _rangeLength = Nothing
-            , _text = T.unlines [ "_hygienic = \"hygienic\"" ]
-            }]
-        let
-        -- Points to a string in the target file,
-        -- convenient for hygienic edits
-            stringLiteralP = Position lastLine 15
-
-        -- Find an identifier defined in another file in this project
-        symbols <- getDocumentSymbols doc
-        let endOfImports = case symbols of
-                Left symbols | Just x <- findEndOfImports symbols -> x
-                _ -> error $ "symbols: " <> show symbols
-        contents <- documentContents doc
-        identifierP <- searchSymbol doc contents endOfImports
-        return $ DocumentPositions{..}
-
-findEndOfImports :: [DocumentSymbol] -> Maybe Position
-findEndOfImports (DocumentSymbol{_kind = SkModule, _name = "imports", _range} : _) =
-    Just $ Position (succ $ _line $ _end _range) 4
-findEndOfImports [DocumentSymbol{_kind = SkFile, _children = Just (List cc)}] =
-    findEndOfImports cc
-findEndOfImports (DocumentSymbol{_range} : _) =
-    Just $ _start _range
-findEndOfImports _ = Nothing
-
---------------------------------------------------------------------------------------------
-
-pad :: Int -> String -> String
-pad n [] = replicate n ' '
-pad 0 _ = error "pad"
-pad n (x:xx) = x : pad (n-1) xx
-
--- | Search for a position where:
---     - get definition works and returns a uri other than this file
---     - get completions returns a non empty list
-searchSymbol :: TextDocumentIdentifier -> T.Text -> Position -> Session (Maybe Position)
-searchSymbol doc@TextDocumentIdentifier{_uri} fileContents pos = do
-    -- this search is expensive, so we cache the result on disk
-    let cachedPath = fromJust (uriToFilePath _uri) <.> "identifierPosition"
-    cachedRes <- liftIO $ try @_ @IOException $ read <$> readFile cachedPath
-    case cachedRes of
-        Left _ -> do
-            result <- loop pos
-            liftIO $ writeFile cachedPath $ show result
-            return result
-        Right res ->
-            return res
-  where
-      loop pos
-        | _line pos >= lll =
-            return Nothing
-        | _character pos >= lengthOfLine (_line pos) =
-            loop (nextLine pos)
-        | otherwise = do
-                checks <- checkDefinitions pos &&^ checkCompletions pos
-                if checks
-                    then return $ Just pos
-                    else loop (nextIdent pos)
-
-      nextIdent p = p{_character = _character p + 2}
-      nextLine p = Position (_line p + 1) 4
-
-      lengthOfLine n = if n >= lll then 0 else T.length (ll !! n)
-      ll = T.lines fileContents
-      lll = length ll
-
-      checkDefinitions pos = do
-        defs <- getDefinitions doc pos
-        case defs of
-            (InL [Location uri _]) -> return $ uri /= _uri
-            _ -> return False
-      checkCompletions pos =
-        not . null <$> getCompletions doc pos
+{-# LANGUAGE ConstraintKinds           #-}+{-# LANGUAGE ExistentialQuantification #-}+{-# LANGUAGE GADTs                     #-}+{-# LANGUAGE ImplicitParams            #-}+{-# LANGUAGE ImpredicativeTypes        #-}+{-# OPTIONS_GHC -Wno-deprecations -Wno-unticked-promoted-constructors #-}++module Experiments+( Bench(..)+, BenchRun(..)+, Config(..)+, Verbosity(..)+, CabalStack(..)+, SetupResult(..)+, Example(..)+, experiments+, configP+, defConfig+, output+, setup+, runBench+, exampleToOptions+) where+import           Control.Applicative.Combinators (skipManyTill)+import           Control.Exception.Safe          (IOException, handleAny, try)+import           Control.Monad.Extra+import           Control.Monad.IO.Class+import           Data.Aeson                      (Value (Null), toJSON)+import           Data.List+import           Data.Maybe+import qualified Data.Text                       as T+import           Data.Version+import           Development.IDE.Plugin.Test+import           Development.Shake               (CmdOption (Cwd, FileStdout),+                                                  cmd_)+import           Experiments.Types+import           Language.LSP.Test+import           Language.LSP.Types+import           Language.LSP.Types.Capabilities+import           Numeric.Natural+import           Options.Applicative+import           System.Directory+import           System.Environment.Blank        (getEnv)+import           System.FilePath                 ((<.>), (</>))+import           System.Process+import           System.Time.Extra+import           Text.ParserCombinators.ReadP    (readP_to_S)++charEdit :: Position -> TextDocumentContentChangeEvent+charEdit p =+    TextDocumentContentChangeEvent+    { _range = Just (Range p p),+      _rangeLength = Nothing,+      _text = "a"+    }++data DocumentPositions = DocumentPositions {+    identifierP    :: Maybe Position,+    stringLiteralP :: !Position,+    doc            :: !TextDocumentIdentifier+}++allWithIdentifierPos :: Monad m => (DocumentPositions -> m Bool) -> [DocumentPositions] -> m Bool+allWithIdentifierPos f docs = allM f (filter (isJust . identifierP) docs)++experiments :: [Bench]+experiments =+    [ ---------------------------------------------------------------------------------------+      bench "hover" $ allWithIdentifierPos $ \DocumentPositions{..} ->+        isJust <$> getHover doc (fromJust identifierP),+      ---------------------------------------------------------------------------------------+      bench "edit" $ \docs -> do+        forM_ docs $ \DocumentPositions{..} ->+          changeDoc doc [charEdit stringLiteralP]+        waitForProgressDone -- TODO check that this waits for all of them+        return True,+      ---------------------------------------------------------------------------------------+      bench "hover after edit" $ \docs -> do+        forM_ docs $ \DocumentPositions{..} ->+          changeDoc doc [charEdit stringLiteralP]+        flip allWithIdentifierPos docs $ \DocumentPositions{..} ->+          isJust <$> getHover doc (fromJust identifierP),+      ---------------------------------------------------------------------------------------+      bench "getDefinition" $ allWithIdentifierPos $ \DocumentPositions{..} ->+        either (not . null) (not . null) . toEither <$> getDefinitions doc (fromJust identifierP),+      ---------------------------------------------------------------------------------------+      bench "getDefinition after edit" $ \docs -> do+          forM_ docs $ \DocumentPositions{..} ->+            changeDoc doc [charEdit stringLiteralP]+          flip allWithIdentifierPos docs $ \DocumentPositions{..} ->+            either (not . null) (not . null) . toEither <$> getDefinitions doc (fromJust identifierP),+      ---------------------------------------------------------------------------------------+      bench "documentSymbols" $ allM $ \DocumentPositions{..} -> do+        fmap (either (not . null) (not . null)) . getDocumentSymbols $ doc,+      ---------------------------------------------------------------------------------------+      bench "documentSymbols after edit" $ \docs -> do+        forM_ docs $ \DocumentPositions{..} ->+          changeDoc doc [charEdit stringLiteralP]+        flip allM docs $ \DocumentPositions{..} ->+          either (not . null) (not . null) <$> getDocumentSymbols doc,+      ---------------------------------------------------------------------------------------+      bench "completions" $ \docs -> do+        flip allWithIdentifierPos docs $ \DocumentPositions{..} ->+          not . null <$> getCompletions doc (fromJust identifierP),+      ---------------------------------------------------------------------------------------+      bench "completions after edit" $ \docs -> do+        forM_ docs $ \DocumentPositions{..} ->+          changeDoc doc [charEdit stringLiteralP]+        flip allWithIdentifierPos docs $ \DocumentPositions{..} ->+          not . null <$> getCompletions doc (fromJust identifierP),+      ---------------------------------------------------------------------------------------+      benchWithSetup+        "code actions"+        ( \docs -> do+            unless (any (isJust . identifierP) docs) $+                error "None of the example modules is suitable for this experiment"+            forM_ docs $ \DocumentPositions{..} ->+                forM_ identifierP $ \p -> changeDoc doc [charEdit p]+            waitForProgressDone+        )+        ( \docs -> not . null . catMaybes <$> forM docs (\DocumentPositions{..} ->+            forM identifierP $ \p ->+              getCodeActions doc (Range p p))+        ),+      ---------------------------------------------------------------------------------------+      benchWithSetup+        "code actions after edit"+        ( \docs -> do+            unless (any (isJust . identifierP) docs) $+                error "None of the example modules is suitable for this experiment"+            forM_ docs $ \DocumentPositions{..} ->+                forM_ identifierP $ \p -> changeDoc doc [charEdit p]+        )+        ( \docs -> do+            forM_ docs $ \DocumentPositions{..} ->+              changeDoc doc [charEdit stringLiteralP]+            waitForProgressDone+            not . null . catMaybes <$> forM docs (\DocumentPositions{..} -> do+              forM identifierP $ \p ->+                getCodeActions doc (Range p p))+        ),+      ---------------------------------------------------------------------------------------+      benchWithSetup+        "code actions after cradle edit"+        ( \docs -> do+            unless (any (isJust . identifierP) docs) $+                error "None of the example modules is suitable for this experiment"+            forM_ docs $ \DocumentPositions{..} ->+                forM_ identifierP $ \p -> changeDoc doc [charEdit p]+        )+        ( \docs -> do+            Just hieYaml <- uriToFilePath <$> getDocUri "hie.yaml"+            liftIO $ appendFile hieYaml "##\n"+            sendNotification SWorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams $+                List [ FileEvent (filePathToUri "hie.yaml") FcChanged ]+            forM_ docs $ \DocumentPositions{..} ->+              changeDoc doc [charEdit stringLiteralP]+            waitForProgressDone+            not . null . catMaybes <$> forM docs (\DocumentPositions{..} -> do+              forM identifierP $ \p ->+                getCodeActions doc (Range p p))+        ),+      ---------------------------------------------------------------------------------------+      bench+        "hover after cradle edit"+        (\docs -> do+            Just hieYaml <- uriToFilePath <$> getDocUri "hie.yaml"+            liftIO $ appendFile hieYaml "##\n"+            sendNotification SWorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams $+                List [ FileEvent (filePathToUri "hie.yaml") FcChanged ]+            flip allWithIdentifierPos docs $ \DocumentPositions{..} -> isJust <$> getHover doc (fromJust identifierP)+        )+    ]++---------------------------------------------------------------------------------------------++examplesPath :: FilePath+examplesPath = "bench/example"++defConfig :: Config+Success defConfig = execParserPure defaultPrefs (info configP fullDesc) []++quiet, verbose :: Config -> Bool+verbose = (== All) . verbosity+quiet   = (== Quiet) . verbosity++type HasConfig = (?config :: Config)++configP :: Parser Config+configP =+  Config+    <$> (flag' All (short 'v' <> long "verbose")+         <|> flag' Quiet (short 'q' <> long "quiet")+         <|> pure Normal+        )+    <*> optional (strOption (long "shake-profiling" <> metavar "PATH"))+    <*> optional (strOption (long "ot-profiling" <> metavar "DIR" <> help "Enable OpenTelemetry and write eventlog for each benchmark in DIR"))+    <*> strOption (long "csv" <> metavar "PATH" <> value "results.csv" <> showDefault)+    <*> flag Cabal Stack (long "stack" <> help "Use stack (by default cabal is used)")+    <*> many (strOption (long "ghcide-options" <> help "additional options for ghcide"))+    <*> many (strOption (short 's' <> long "select" <> help "select which benchmarks to run"))+    <*> optional (option auto (long "samples" <> metavar "NAT" <> help "override sampling count"))+    <*> strOption (long "ghcide" <> metavar "PATH" <> help "path to ghcide" <> value "ghcide")+    <*> option auto (long "timeout" <> value 60 <> help "timeout for waiting for a ghcide response")+    <*> ( GetPackage <$> strOption (long "example-package-name" <> value "Cabal")+               <*> (some moduleOption <|> pure ["Distribution/Simple.hs"])+               <*> option versionP (long "example-package-version" <> value (makeVersion [3,2,0,0]))+         <|>+          UsePackage <$> strOption (long "example-path")+                     <*> some moduleOption+         )+  where+      moduleOption = strOption (long "example-module" <> metavar "PATH")++versionP :: ReadM Version+versionP = maybeReader $ extract . readP_to_S parseVersion+  where+      extract parses = listToMaybe [ res | (res,"") <- parses]++output :: (MonadIO m, HasConfig) => String -> m ()+output = if quiet?config then (\_ -> pure ()) else liftIO . putStrLn++---------------------------------------------------------------------------------------++type Experiment = [DocumentPositions] -> Session Bool++data Bench =+  Bench+  { name       :: !String,+    enabled    :: !Bool,+    samples    :: !Natural,+    benchSetup :: [DocumentPositions] -> Session (),+    experiment :: Experiment+  }++select :: HasConfig => Bench -> Bool+select Bench {name, enabled} =+  enabled && (null mm || name `elem` mm)+  where+    mm = matches ?config++benchWithSetup ::+  String ->+  ([DocumentPositions] -> Session ()) ->+  Experiment ->+  Bench+benchWithSetup name benchSetup experiment = Bench {..}+  where+    enabled = True+    samples = 100++bench :: String -> Experiment -> Bench+bench name = benchWithSetup name (const $ pure ())++runBenchmarksFun :: HasConfig => FilePath -> [Bench] -> IO ()+runBenchmarksFun dir allBenchmarks = do+  let benchmarks = [ b{samples = fromMaybe 100 (repetitions ?config) }+                   | b <- allBenchmarks+                   , select b ]++  whenJust (otMemoryProfiling ?config) $ \eventlogDir ->+      createDirectoryIfMissing True eventlogDir++  results <- forM benchmarks $ \b@Bench{name} -> do+                let run = runSessionWithConfig conf (cmd name dir) lspTestCaps dir+                (b,) <$> runBench run b++  -- output raw data as CSV+  let headers =+        [ "name"+        , "success"+        , "samples"+        , "startup"+        , "setup"+        , "userTime"+        , "delayedTime"+        , "totalTime"+        ]+      rows =+        [ [ name,+            show success,+            show samples,+            show startup,+            show runSetup',+            show userWaits,+            show delayedWork,+            show runExperiment+          ]+          | (Bench {name, samples}, BenchRun {..}) <- results,+            let runSetup' = if runSetup < 0.01 then 0 else runSetup+        ]+      csv = unlines $ map (intercalate ", ") (headers : rows)+  writeFile (outputCSV ?config) csv++  -- print a nice table+  let pads = map (maximum . map length) (transpose (headers : rowsHuman))+      paddedHeaders = zipWith pad pads headers+      outputRow = putStrLn . intercalate " | "+      rowsHuman =+        [ [ name,+            show success,+            show samples,+            showDuration startup,+            showDuration runSetup',+            showDuration userWaits,+            showDuration delayedWork,+            showDuration runExperiment+          ]+          | (Bench {name, samples}, BenchRun {..}) <- results,+            let runSetup' = if runSetup < 0.01 then 0 else runSetup+        ]+  outputRow paddedHeaders+  outputRow $ (map . map) (const '-') paddedHeaders+  forM_ rowsHuman $ \row -> outputRow $ zipWith pad pads row+  where+    ghcideCmd dir =+        [ ghcide ?config,+          "--lsp",+          "--test",+          "--cwd",+          dir,+          "+RTS"+        ]+    cmd name dir =+      unwords $+            ghcideCmd dir+          ++ case otMemoryProfiling ?config of+            Just dir -> ["-l", "-ol" ++ (dir </> map (\c -> if c == ' ' then '-' else c) name <.> "eventlog")]+            Nothing -> []+          ++ [ "-RTS" ]+          ++ ghcideOptions ?config+          ++ concat+            [ ["--shake-profiling", path] | Just path <- [shakeProfiling ?config]+            ]+          ++ ["--verbose" | verbose ?config]+          ++ ["--ot-memory-profiling" | Just _ <- [otMemoryProfiling ?config]]+    lspTestCaps =+      fullCaps {_window = Just $ WindowClientCapabilities $ Just True}+    conf =+      defaultConfig+        { logStdErr = verbose ?config,+          logMessages = verbose ?config,+          logColor = False,+          messageTimeout = timeoutLsp ?config+        }++data BenchRun = BenchRun+  { startup       :: !Seconds,+    runSetup      :: !Seconds,+    runExperiment :: !Seconds,+    userWaits     :: !Seconds,+    delayedWork   :: !Seconds,+    success       :: !Bool+  }++badRun :: BenchRun+badRun = BenchRun 0 0 0 0 0 False++-- | Wait for all progress to be done+-- Needs at least one progress done notification to return+waitForProgressDone :: Session ()+waitForProgressDone = loop+  where+    loop = do+      ~() <- skipManyTill anyMessage $ satisfyMaybe $ \case+        FromServerMess SProgress (NotificationMessage _ _ (ProgressParams _ (End _))) -> Just ()+        _ -> Nothing+      done <- null <$> getIncompleteProgressSessions+      unless done loop++runBench ::+  (?config :: Config) =>+  (Session BenchRun -> IO BenchRun) ->+  Bench ->+  IO BenchRun+runBench runSess b = handleAny (\e -> print e >> return badRun)+  $ runSess+  $ do+    case b of+     Bench{..} -> do+      (startup, docs) <- duration $ do+        (d, docs) <- duration $ setupDocumentContents ?config+        output $ "Setting up document contents took " <> showDuration d+        -- wait again, as the progress is restarted once while loading the cradle+        -- make an edit, to ensure this doesn't block+        let DocumentPositions{..} = head docs+        changeDoc doc [charEdit stringLiteralP]+        waitForProgressDone+        return docs++      liftIO $ output $ "Running " <> name <> " benchmark"+      (runSetup, ()) <- duration $ benchSetup docs+      let loop !userWaits !delayedWork 0 = return $ Just (userWaits, delayedWork)+          loop !userWaits !delayedWork n = do+            (t, res) <- duration $ experiment docs+            if not res+              then return Nothing+            else do+                output (showDuration t)+                -- Wait for the delayed actions to finish+                let m = SCustomMethod "test"+                waitId <- sendRequest m (toJSON WaitForShakeQueue)+                (td, resp) <- duration $ skipManyTill anyMessage $ responseForId m waitId+                case resp of+                    ResponseMessage{_result=Right Null} -> do+                      loop (userWaits+t) (delayedWork+td) (n -1)+                    _ ->+                    -- Assume a ghcide build lacking the WaitForShakeQueue command+                      loop (userWaits+t) delayedWork (n -1)++      (runExperiment, result) <- duration $ loop 0 0 samples+      let success = isJust result+          (userWaits, delayedWork) = fromMaybe (0,0) result++      return BenchRun {..}++data SetupResult = SetupResult {+    runBenchmarks :: [Bench] -> IO (),+    -- | Path to the setup benchmark example+    benchDir      :: FilePath,+    cleanUp       :: IO ()+}++callCommandLogging :: HasConfig => String -> IO ()+callCommandLogging cmd = do+    output cmd+    callCommand cmd++setup :: HasConfig => IO SetupResult+setup = do+--   when alreadyExists $ removeDirectoryRecursive examplesPath+  benchDir <- case example ?config of+      UsePackage{..} -> do+          let hieYamlPath = examplePath </> "hie.yaml"+          alreadyExists <- doesFileExist hieYamlPath+          unless alreadyExists $+                cmd_ (Cwd examplePath) (FileStdout hieYamlPath) ("gen-hie"::String)+          return examplePath+      GetPackage{..} -> do+        let path = examplesPath </> package+            package = exampleName <> "-" <> showVersion exampleVersion+            hieYamlPath = path </> "hie.yaml"+        alreadySetup <- doesDirectoryExist path+        unless alreadySetup $+          case buildTool ?config of+            Cabal -> do+                let cabalVerbosity = "-v" ++ show (fromEnum (verbose ?config))+                callCommandLogging $ "cabal get " <> cabalVerbosity <> " " <> package <> " -d " <> examplesPath+                let hieYamlPath = path </> "hie.yaml"+                cmd_ (Cwd path) (FileStdout hieYamlPath) ("gen-hie"::String)+                -- Need this in case there is a parent cabal.project somewhere+                writeFile+                    (path </> "cabal.project")+                    "packages: ."+                writeFile+                    (path </> "cabal.project.local")+                    ""+            Stack -> do+                let stackVerbosity = case verbosity ?config of+                        Quiet  -> "--silent"+                        Normal -> ""+                        All    -> "--verbose"+                callCommandLogging $ "stack " <> stackVerbosity <> " unpack " <> package <> " --to " <> examplesPath+                -- Generate the stack descriptor to match the one used to build ghcide+                stack_yaml <- fromMaybe "stack.yaml" <$> getEnv "STACK_YAML"+                stack_yaml_lines <- lines <$> readFile stack_yaml+                writeFile (path </> stack_yaml)+                        (unlines $+                        "packages: [.]" :+                            [ l+                            | l <- stack_yaml_lines+                            , any (`isPrefixOf` l)+                                ["resolver"+                                ,"allow-newer"+                                ,"compiler"]+                            ]+                        )++                cmd_ (Cwd path) (FileStdout hieYamlPath) ("gen-hie"::String) ["--stack"::String]+        return path++  whenJust (shakeProfiling ?config) $ createDirectoryIfMissing True++  let cleanUp = case example ?config of+        GetPackage{} -> removeDirectoryRecursive examplesPath+        UsePackage{} -> return ()++      runBenchmarks = runBenchmarksFun benchDir++  return SetupResult{..}++setupDocumentContents :: Config -> Session [DocumentPositions]+setupDocumentContents config =+        forM (exampleModules $ example config) $ \m -> do+        doc <- openDoc m "haskell"++        -- Setup the special positions used by the experiments+        lastLine <- length . T.lines <$> documentContents doc+        changeDoc doc [TextDocumentContentChangeEvent+            { _range = Just (Range (Position lastLine 0) (Position lastLine 0))+            , _rangeLength = Nothing+            , _text = T.unlines [ "_hygienic = \"hygienic\"" ]+            }]+        let+        -- Points to a string in the target file,+        -- convenient for hygienic edits+            stringLiteralP = Position lastLine 15++        -- Find an identifier defined in another file in this project+        symbols <- getDocumentSymbols doc+        let endOfImports = case symbols of+                Left symbols | Just x <- findEndOfImports symbols -> x+                _ -> error $ "symbols: " <> show symbols+        contents <- documentContents doc+        identifierP <- searchSymbol doc contents endOfImports+        return $ DocumentPositions{..}++findEndOfImports :: [DocumentSymbol] -> Maybe Position+findEndOfImports (DocumentSymbol{_kind = SkModule, _name = "imports", _range} : _) =+    Just $ Position (succ $ _line $ _end _range) 4+findEndOfImports [DocumentSymbol{_kind = SkFile, _children = Just (List cc)}] =+    findEndOfImports cc+findEndOfImports (DocumentSymbol{_range} : _) =+    Just $ _start _range+findEndOfImports _ = Nothing++--------------------------------------------------------------------------------------------++pad :: Int -> String -> String+pad n []     = replicate n ' '+pad 0 _      = error "pad"+pad n (x:xx) = x : pad (n-1) xx++-- | Search for a position where:+--     - get definition works and returns a uri other than this file+--     - get completions returns a non empty list+searchSymbol :: TextDocumentIdentifier -> T.Text -> Position -> Session (Maybe Position)+searchSymbol doc@TextDocumentIdentifier{_uri} fileContents pos = do+    -- this search is expensive, so we cache the result on disk+    let cachedPath = fromJust (uriToFilePath _uri) <.> "identifierPosition"+    cachedRes <- liftIO $ try @_ @IOException $ read <$> readFile cachedPath+    case cachedRes of+        Left _ -> do+            result <- loop pos+            liftIO $ writeFile cachedPath $ show result+            return result+        Right res ->+            return res+  where+      loop pos+        | _line pos >= lll =+            return Nothing+        | _character pos >= lengthOfLine (_line pos) =+            loop (nextLine pos)+        | otherwise = do+                checks <- checkDefinitions pos &&^ checkCompletions pos+                if checks+                    then return $ Just pos+                    else loop (nextIdent pos)++      nextIdent p = p{_character = _character p + 2}+      nextLine p = Position (_line p + 1) 4++      lengthOfLine n = if n >= lll then 0 else T.length (ll !! n)+      ll = T.lines fileContents+      lll = length ll++      checkDefinitions pos = do+        defs <- getDefinitions doc pos+        case defs of+            (InL [Location uri _]) -> return $ uri /= _uri+            _                      -> return False+      checkCompletions pos =+        not . null <$> getCompletions doc pos

@@ -1,70 +1,70 @@-{-# LANGUAGE DeriveAnyClass #-}
-{-# LANGUAGE DerivingStrategies #-}
-{-# LANGUAGE OverloadedStrings #-}
-module Experiments.Types (module Experiments.Types ) where
-
-import Data.Aeson
-import Data.Version
-import Numeric.Natural
-import System.FilePath (isPathSeparator)
-import Development.Shake.Classes
-import GHC.Generics
-
-data CabalStack = Cabal | Stack
-  deriving (Eq, Show)
-
-data Verbosity = Quiet | Normal | All
-  deriving (Eq, Show)
-data Config = Config
-  { verbosity :: !Verbosity,
-    -- For some reason, the Shake profile files are truncated and won't load
-    shakeProfiling :: !(Maybe FilePath),
-    otMemoryProfiling :: !(Maybe FilePath),
-    outputCSV :: !FilePath,
-    buildTool :: !CabalStack,
-    ghcideOptions :: ![String],
-    matches :: ![String],
-    repetitions :: Maybe Natural,
-    ghcide :: FilePath,
-    timeoutLsp :: Int,
-    example :: Example
-  }
-  deriving (Eq, Show)
-
-data Example
-    = GetPackage {exampleName :: !String, exampleModules :: [FilePath], exampleVersion :: Version}
-    | UsePackage {examplePath :: FilePath, exampleModules :: [FilePath]}
-  deriving (Eq, Generic, Show)
-  deriving anyclass (Binary, Hashable, NFData)
-
-getExampleName :: Example -> String
-getExampleName UsePackage{examplePath} = map replaceSeparator examplePath
-  where
-      replaceSeparator x
-        | isPathSeparator x = '_'
-        | otherwise = x
-getExampleName GetPackage{exampleName, exampleVersion} =
-    exampleName <> "-" <> showVersion exampleVersion
-
-instance FromJSON Example where
-    parseJSON = withObject "example" $ \x -> do
-        exampleModules <- x .: "modules"
-
-        path <- x .:? "path"
-        case path of
-            Just examplePath -> return UsePackage{..}
-            Nothing -> do
-                exampleName <- x .: "name"
-                exampleVersion <- x .: "version"
-                return GetPackage {..}
-
-exampleToOptions :: Example -> [String]
-exampleToOptions GetPackage{..} =
-    ["--example-package-name", exampleName
-    ,"--example-package-version", showVersion exampleVersion
-    ] ++
-    ["--example-module=" <> m | m <- exampleModules]
-exampleToOptions UsePackage{..} =
-    ["--example-path", examplePath
-    ] ++
-    ["--example-module=" <> m | m <- exampleModules]
+{-# LANGUAGE DeriveAnyClass     #-}+{-# LANGUAGE DerivingStrategies #-}+{-# LANGUAGE OverloadedStrings  #-}+module Experiments.Types (module Experiments.Types ) where++import           Data.Aeson+import           Data.Version+import           Development.Shake.Classes+import           GHC.Generics+import           Numeric.Natural+import           System.FilePath           (isPathSeparator)++data CabalStack = Cabal | Stack+  deriving (Eq, Show)++data Verbosity = Quiet | Normal | All+  deriving (Eq, Show)+data Config = Config+  { verbosity         :: !Verbosity,+    -- For some reason, the Shake profile files are truncated and won't load+    shakeProfiling    :: !(Maybe FilePath),+    otMemoryProfiling :: !(Maybe FilePath),+    outputCSV         :: !FilePath,+    buildTool         :: !CabalStack,+    ghcideOptions     :: ![String],+    matches           :: ![String],+    repetitions       :: Maybe Natural,+    ghcide            :: FilePath,+    timeoutLsp        :: Int,+    example           :: Example+  }+  deriving (Eq, Show)++data Example+    = GetPackage {exampleName :: !String, exampleModules :: [FilePath], exampleVersion :: Version}+    | UsePackage {examplePath :: FilePath, exampleModules :: [FilePath]}+  deriving (Eq, Generic, Show)+  deriving anyclass (Binary, Hashable, NFData)++getExampleName :: Example -> String+getExampleName UsePackage{examplePath} = map replaceSeparator examplePath+  where+      replaceSeparator x+        | isPathSeparator x = '_'+        | otherwise = x+getExampleName GetPackage{exampleName, exampleVersion} =+    exampleName <> "-" <> showVersion exampleVersion++instance FromJSON Example where+    parseJSON = withObject "example" $ \x -> do+        exampleModules <- x .: "modules"++        path <- x .:? "path"+        case path of+            Just examplePath -> return UsePackage{..}+            Nothing -> do+                exampleName <- x .: "name"+                exampleVersion <- x .: "version"+                return GetPackage {..}++exampleToOptions :: Example -> [String]+exampleToOptions GetPackage{..} =+    ["--example-package-name", exampleName+    ,"--example-package-version", showVersion exampleVersion+    ] +++    ["--example-module=" <> m | m <- exampleModules]+exampleToOptions UsePackage{..} =+    ["--example-path", examplePath+    ] +++    ["--example-module=" <> m | m <- exampleModules]

@@ -1,21 +1,21 @@-// Copyright (c) 2019 The DAML Authors. All rights reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-#include <sys/stat.h>
-#include <time.h>
-int getmodtime(const char* pathname, time_t* sec, long* nsec) {
-    struct stat s;
-    int r = stat(pathname, &s);
-    if (r != 0) {
-        return r;
-    }
-#ifdef __APPLE__
-    *sec = s.st_mtimespec.tv_sec;
-    *nsec = s.st_mtimespec.tv_nsec;
-#else
-    *sec = s.st_mtim.tv_sec;
-    *nsec = s.st_mtim.tv_nsec;
-#endif
-    return 0;
-}
-
+// Copyright (c) 2019 The DAML Authors. All rights reserved.+// SPDX-License-Identifier: Apache-2.0++#include <sys/stat.h>+#include <time.h>+int getmodtime(const char* pathname, time_t* sec, long* nsec) {+    struct stat s;+    int r = stat(pathname, &s);+    if (r != 0) {+        return r;+    }+#ifdef __APPLE__+    *sec = s.st_mtimespec.tv_sec;+    *nsec = s.st_mtimespec.tv_nsec;+#else+    *sec = s.st_mtim.tv_sec;+    *nsec = s.st_mtim.tv_nsec;+#endif+    return 0;+}+

@@ -1,52 +1,52 @@--- Copyright (c) 2019 The DAML Authors. All rights reserved.
--- SPDX-License-Identifier: Apache-2.0
-
-module Arguments(Arguments, Arguments'(..), getArguments, IdeCmd(..)) where
-
-import Options.Applicative
-import HieDb.Run
-
-type Arguments = Arguments' IdeCmd
-
-data IdeCmd = Typecheck [FilePath] | DbCmd Options Command | LSP
-
-data Arguments' a = Arguments
-    {argLSP :: Bool
-    ,argsCwd :: Maybe FilePath
-    ,argsVersion :: Bool
-    ,argsShakeProfiling :: Maybe FilePath
-    ,argsOTMemoryProfiling :: Bool
-    ,argsTesting :: Bool
-    ,argsDisableKick :: Bool
-    ,argsThreads :: Int
-    ,argsVerbose :: Bool
-    ,argFilesOrCmd :: a
-    }
-
-getArguments :: IO Arguments
-getArguments = execParser opts
-  where
-    opts = info (arguments <**> helper)
-      ( fullDesc
-     <> header "ghcide - the core of a Haskell IDE")
-
-arguments :: Parser Arguments
-arguments = Arguments
-      <$> switch (long "lsp" <> help "Start talking to an LSP client")
-      <*> optional (strOption $ long "cwd" <> metavar "DIR" <> help "Change to this directory")
-      <*> switch (long "version" <> help "Show ghcide and GHC versions")
-      <*> optional (strOption $ long "shake-profiling" <> metavar "DIR" <> help "Dump profiling reports to this directory")
-      <*> switch (long "ot-memory-profiling" <> help "Record OpenTelemetry info to the eventlog. Needs the -l RTS flag to have an effect")
-      <*> switch (long "test" <> help "Enable additional lsp messages used by the testsuite")
-      <*> switch (long "test-no-kick" <> help "Disable kick. Useful for testing cancellation")
-      <*> option auto (short 'j' <> help "Number of threads (0: automatic)" <> metavar "NUM" <> value 0 <> showDefault)
-      <*> switch (long "verbose" <> help "Include internal events in logging output")
-      <*> ( hsubparser (command "typecheck" (info (Typecheck <$> fileCmd) fileInfo)
-                   <> command "hiedb" (info (DbCmd <$> optParser "" True <*> cmdParser <**> helper) hieInfo)
-                   <> command "lsp" (info (pure LSP <**> helper) lspInfo)  )
-         <|> Typecheck <$> fileCmd )
-  where
-    fileCmd = many (argument str (metavar "FILES/DIRS..."))
-    lspInfo = fullDesc <> progDesc "Start talking to an LSP client"
-    fileInfo = fullDesc <> progDesc "Used as a test bed to check your IDE will work"
-    hieInfo = fullDesc <> progDesc "Query .hie files"
+-- Copyright (c) 2019 The DAML Authors. All rights reserved.+-- SPDX-License-Identifier: Apache-2.0++module Arguments(Arguments, Arguments'(..), getArguments, IdeCmd(..)) where++import           HieDb.Run+import           Options.Applicative++type Arguments = Arguments' IdeCmd++data IdeCmd = Typecheck [FilePath] | DbCmd Options Command | LSP++data Arguments' a = Arguments+    {argLSP                :: Bool+    ,argsCwd               :: Maybe FilePath+    ,argsVersion           :: Bool+    ,argsShakeProfiling    :: Maybe FilePath+    ,argsOTMemoryProfiling :: Bool+    ,argsTesting           :: Bool+    ,argsDisableKick       :: Bool+    ,argsThreads           :: Int+    ,argsVerbose           :: Bool+    ,argFilesOrCmd         :: a+    }++getArguments :: IO Arguments+getArguments = execParser opts+  where+    opts = info (arguments <**> helper)+      ( fullDesc+     <> header "ghcide - the core of a Haskell IDE")++arguments :: Parser Arguments+arguments = Arguments+      <$> switch (long "lsp" <> help "Start talking to an LSP client")+      <*> optional (strOption $ long "cwd" <> metavar "DIR" <> help "Change to this directory")+      <*> switch (long "version" <> help "Show ghcide and GHC versions")+      <*> optional (strOption $ long "shake-profiling" <> metavar "DIR" <> help "Dump profiling reports to this directory")+      <*> switch (long "ot-memory-profiling" <> help "Record OpenTelemetry info to the eventlog. Needs the -l RTS flag to have an effect")+      <*> switch (long "test" <> help "Enable additional lsp messages used by the testsuite")+      <*> switch (long "test-no-kick" <> help "Disable kick. Useful for testing cancellation")+      <*> option auto (short 'j' <> help "Number of threads (0: automatic)" <> metavar "NUM" <> value 0 <> showDefault)+      <*> switch (long "verbose" <> help "Include internal events in logging output")+      <*> ( hsubparser (command "typecheck" (info (Typecheck <$> fileCmd) fileInfo)+                   <> command "hiedb" (info (DbCmd <$> optParser "" True <*> cmdParser <**> helper) hieInfo)+                   <> command "lsp" (info (pure LSP <**> helper) lspInfo)  )+         <|> Typecheck <$> fileCmd )+  where+    fileCmd = many (argument str (metavar "FILES/DIRS..."))+    lspInfo = fullDesc <> progDesc "Start talking to an LSP client"+    fileInfo = fullDesc <> progDesc "Used as a test bed to check your IDE will work"+    hieInfo = fullDesc <> progDesc "Query .hie files"

@@ -1,117 +1,121 @@--- Copyright (c) 2019 The DAML Authors. All rights reserved.
--- SPDX-License-Identifier: Apache-2.0
-{-# OPTIONS_GHC -Wno-dodgy-imports #-} -- GHC no longer exports def in GHC 8.6 and above
-{-# LANGUAGE TemplateHaskell #-}
-
-module Main(main) where
-
-import Arguments ( Arguments'(..), IdeCmd(..), getArguments )
-import Control.Concurrent.Extra ( newLock, withLock )
-import Control.Monad.Extra ( unless, when, whenJust )
-import Data.Default ( Default(def) )
-import Data.List.Extra ( upper )
-import Data.Maybe (fromMaybe)
-import qualified Data.Text as T
-import qualified Data.Text.IO as T
-import Data.Version ( showVersion )
-import Development.GitRev ( gitHash )
-import Development.IDE ( Logger(Logger), Priority(Info), action )
-import Development.IDE.Core.OfInterest (kick)
-import Development.IDE.Core.Rules (mainRule)
-import qualified Development.IDE.Plugin.HLS.GhcIde as GhcIde
-import qualified Development.IDE.Plugin.Test as Test
-import Development.IDE.Session (setInitialDynFlags, getHieDbLoc)
-import Development.IDE.Types.Options
-import qualified Development.IDE.Main as Main
-import Development.Shake (ShakeOptions(shakeThreads))
-import Ide.Plugin.Config (Config(checkParents, checkProject))
-import Ide.PluginUtils (pluginDescToIdePlugins)
-import HieDb.Run (Options(..), runCommand)
-import Paths_ghcide ( version )
-import qualified System.Directory.Extra as IO
-import System.Environment ( getExecutablePath )
-import System.Exit ( ExitCode(ExitFailure), exitSuccess, exitWith )
-import System.Info ( compilerVersion )
-import System.IO ( stderr, hPutStrLn )
-
-ghcideVersion :: IO String
-ghcideVersion = do
-  path <- getExecutablePath
-  let gitHashSection = case $(gitHash) of
-        x | x == "UNKNOWN" -> ""
-        x -> " (GIT hash: " <> x <> ")"
-  return $ "ghcide version: " <> showVersion version
-             <> " (GHC: " <> showVersion compilerVersion
-             <> ") (PATH: " <> path <> ")"
-             <> gitHashSection
-
-main :: IO ()
-main = do
-    -- WARNING: If you write to stdout before runLanguageServer
-    --          then the language server will not work
-    Arguments{..} <- getArguments
-
-    if argsVersion then ghcideVersion >>= putStrLn >> exitSuccess
-    else hPutStrLn stderr {- see WARNING above -} =<< ghcideVersion
-
-    whenJust argsCwd IO.setCurrentDirectory
-
-    -- lock to avoid overlapping output on stdout
-    lock <- newLock
-    let logger = Logger $ \pri msg -> when (pri >= logLevel) $ withLock lock $
-            T.putStrLn $ T.pack ("[" ++ upper (show pri) ++ "] ") <> msg
-        logLevel = if argsVerbose then minBound else Info
-
-    case argFilesOrCmd of
-      DbCmd opts cmd -> do
-        dir <- IO.getCurrentDirectory
-        dbLoc <- getHieDbLoc dir
-        mlibdir <- setInitialDynFlags def
-        case mlibdir of
-          Nothing -> exitWith $ ExitFailure 1
-          Just libdir -> runCommand libdir opts{database = dbLoc} cmd
-
-      _ -> do
-
-          case argFilesOrCmd of
-              LSP -> do
-                hPutStrLn stderr "Starting LSP server..."
-                hPutStrLn stderr "If you are seeing this in a terminal, you probably should have run ghcide WITHOUT the --lsp option!"
-              _ -> return ()
-
-          Main.defaultMain def
-            {Main.argFiles = case argFilesOrCmd of
-                Typecheck x | not argLSP -> Just x
-                _ -> Nothing
-
-            ,Main.argsLogger = logger
-
-            ,Main.argsRules = do
-                -- install the main and ghcide-plugin rules
-                mainRule
-                -- install the kick action, which triggers a typecheck on every
-                -- Shake database restart, i.e. on every user edit.
-                unless argsDisableKick $
-                    action kick
-
-            ,Main.argsHlsPlugins =
-                pluginDescToIdePlugins $
-                GhcIde.descriptors
-                ++ [Test.blockCommandDescriptor "block-command" | argsTesting]
-
-            ,Main.argsGhcidePlugin = if argsTesting
-                then Test.plugin
-                else mempty
-
-            ,Main.argsIdeOptions = \(fromMaybe def -> config) sessionLoader ->
-                let defOptions = defaultIdeOptions sessionLoader
-                in defOptions
-                  { optShakeProfiling = argsShakeProfiling
-                  , optOTMemoryProfiling = IdeOTMemoryProfiling argsOTMemoryProfiling
-                  , optTesting = IdeTesting argsTesting
-                  , optShakeOptions = (optShakeOptions defOptions){shakeThreads = argsThreads}
-                  , optCheckParents = pure $ checkParents config
-                  , optCheckProject = pure $ checkProject config
-                  }
-            }
-
+-- Copyright (c) 2019 The DAML Authors. All rights reserved.+-- SPDX-License-Identifier: Apache-2.0+{-# OPTIONS_GHC -Wno-dodgy-imports #-} -- GHC no longer exports def in GHC 8.6 and above+{-# LANGUAGE TemplateHaskell #-}++module Main(main) where++import           Arguments                         (Arguments' (..),+                                                    IdeCmd (..), getArguments)+import           Control.Concurrent.Extra          (newLock, withLock)+import           Control.Monad.Extra               (unless, when, whenJust)+import           Data.Default                      (Default (def))+import           Data.List.Extra                   (upper)+import           Data.Maybe                        (fromMaybe)+import qualified Data.Text                         as T+import qualified Data.Text.IO                      as T+import           Data.Version                      (showVersion)+import           Development.GitRev                (gitHash)+import           Development.IDE                   (Logger (Logger),+                                                    Priority (Info), action)+import           Development.IDE.Core.OfInterest   (kick)+import           Development.IDE.Core.Rules        (mainRule)+import qualified Development.IDE.Main              as Main+import qualified Development.IDE.Plugin.HLS.GhcIde as GhcIde+import qualified Development.IDE.Plugin.Test       as Test+import           Development.IDE.Session           (getHieDbLoc,+                                                    setInitialDynFlags)+import           Development.IDE.Types.Options+import           Development.Shake                 (ShakeOptions (shakeThreads))+import           HieDb.Run                         (Options (..), runCommand)+import           Ide.Plugin.Config                 (Config (checkParents, checkProject))+import           Ide.PluginUtils                   (pluginDescToIdePlugins)+import           Paths_ghcide                      (version)+import qualified System.Directory.Extra            as IO+import           System.Environment                (getExecutablePath)+import           System.Exit                       (ExitCode (ExitFailure),+                                                    exitSuccess, exitWith)+import           System.IO                         (hPutStrLn, stderr)+import           System.Info                       (compilerVersion)++ghcideVersion :: IO String+ghcideVersion = do+  path <- getExecutablePath+  let gitHashSection = case $(gitHash) of+        x | x == "UNKNOWN" -> ""+        x                  -> " (GIT hash: " <> x <> ")"+  return $ "ghcide version: " <> showVersion version+             <> " (GHC: " <> showVersion compilerVersion+             <> ") (PATH: " <> path <> ")"+             <> gitHashSection++main :: IO ()+main = do+    -- WARNING: If you write to stdout before runLanguageServer+    --          then the language server will not work+    Arguments{..} <- getArguments++    if argsVersion then ghcideVersion >>= putStrLn >> exitSuccess+    else hPutStrLn stderr {- see WARNING above -} =<< ghcideVersion++    whenJust argsCwd IO.setCurrentDirectory++    -- lock to avoid overlapping output on stdout+    lock <- newLock+    let logger = Logger $ \pri msg -> when (pri >= logLevel) $ withLock lock $+            T.putStrLn $ T.pack ("[" ++ upper (show pri) ++ "] ") <> msg+        logLevel = if argsVerbose then minBound else Info++    case argFilesOrCmd of+      DbCmd opts cmd -> do+        dir <- IO.getCurrentDirectory+        dbLoc <- getHieDbLoc dir+        mlibdir <- setInitialDynFlags def+        case mlibdir of+          Nothing     -> exitWith $ ExitFailure 1+          Just libdir -> runCommand libdir opts{database = dbLoc} cmd++      _ -> do++          case argFilesOrCmd of+              LSP -> do+                hPutStrLn stderr "Starting LSP server..."+                hPutStrLn stderr "If you are seeing this in a terminal, you probably should have run ghcide WITHOUT the --lsp option!"+              _ -> return ()++          Main.defaultMain def+            {Main.argFiles = case argFilesOrCmd of+                Typecheck x | not argLSP -> Just x+                _                        -> Nothing++            ,Main.argsLogger = pure logger++            ,Main.argsRules = do+                -- install the main and ghcide-plugin rules+                mainRule+                -- install the kick action, which triggers a typecheck on every+                -- Shake database restart, i.e. on every user edit.+                unless argsDisableKick $+                    action kick++            ,Main.argsHlsPlugins =+                pluginDescToIdePlugins $+                GhcIde.descriptors+                ++ [Test.blockCommandDescriptor "block-command" | argsTesting]++            ,Main.argsGhcidePlugin = if argsTesting+                then Test.plugin+                else mempty++            ,Main.argsIdeOptions = \(fromMaybe def -> config) sessionLoader ->+                let defOptions = defaultIdeOptions sessionLoader+                in defOptions+                  { optShakeProfiling = argsShakeProfiling+                  , optOTMemoryProfiling = IdeOTMemoryProfiling argsOTMemoryProfiling+                  , optTesting = IdeTesting argsTesting+                  , optShakeOptions = (optShakeOptions defOptions){shakeThreads = argsThreads}+                  , optCheckParents = pure $ checkParents config+                  , optCheckProject = pure $ checkProject config+                  }+            }+

@@ -1,425 +1,427 @@-cabal-version:      2.2
-build-type:         Simple
-category:           Development
-name:               ghcide
-version:            1.0.0.0
-license:            Apache-2.0
-license-file:       LICENSE
-author:             Digital Asset and Ghcide contributors
-maintainer:         Ghcide contributors
-copyright:          Digital Asset and Ghcide contributors 2018-2020
-synopsis:           The core of an IDE
-description:
-    A library for building Haskell IDE's on top of the GHC API.
-homepage:           https://github.com/haskell/ghcide#readme
-bug-reports:        https://github.com/haskell/ghcide/issues
-tested-with:        GHC == 8.6.4 || == 8.6.5 || == 8.8.2 || == 8.8.3 || == 8.8.4 || == 8.10.2 || == 8.10.3 || == 8.10.4
-extra-source-files: include/ghc-api-version.h README.md CHANGELOG.md
-                    test/data/hover/*.hs
-                    test/data/multi/cabal.project
-                    test/data/multi/hie.yaml
-                    test/data/multi/a/a.cabal
-                    test/data/multi/a/*.hs
-                    test/data/multi/b/b.cabal
-                    test/data/multi/b/*.hs
-
-source-repository head
-    type:     git
-    location: https://github.com/haskell/ghcide.git
-
-flag ghc-patched-unboxed-bytecode
-    description: The GHC version we link against supports unboxed sums and tuples in bytecode
-    default:     False
-    manual:      True
-
-library
-    default-language:   Haskell2010
-    build-depends:
-        aeson,
-        array,
-        async,
-        base == 4.*,
-        binary,
-        bytestring,
-        case-insensitive,
-        containers,
-        data-default,
-        deepseq,
-        directory,
-        dependent-map,
-        dependent-sum,
-        dlist,
-        extra >= 1.7.4,
-        fuzzy,
-        filepath,
-        fingertree,
-        ghc-exactprint,
-        Glob,
-        haddock-library >= 1.8 && < 1.10,
-        hashable,
-        hie-compat ^>= 0.1.0.0,
-        hls-plugin-api ^>= 1.0.0.0,
-        lens,
-        hiedb == 0.3.0.1,
-        lsp-types == 1.1.*,
-        lsp == 1.1.1.0,
-        mtl,
-        network-uri,
-        parallel,
-        prettyprinter-ansi-terminal,
-        prettyprinter-ansi-terminal,
-        prettyprinter,
-        regex-tdfa >= 1.3.1.0,
-        retrie,
-        rope-utf16-splay,
-        safe,
-        safe-exceptions,
-        shake >= 0.18.4,
-        sorted-list,
-        sqlite-simple,
-        stm,
-        syb,
-        text,
-        time,
-        transformers,
-        unordered-containers >= 0.2.10.0,
-        utf8-string,
-        vector,
-        hslogger,
-        Diff,
-        vector,
-        bytestring-encoding,
-        opentelemetry >=0.6.1,
-        heapsize ==0.3.*,
-        unliftio,
-        unliftio-core,
-        ghc-boot-th,
-        ghc-boot,
-        ghc >= 8.6,
-        ghc-check >=0.5.0.1,
-        ghc-paths,
-        cryptohash-sha1 >=0.11.100 && <0.12,
-        hie-bios >= 0.7.1 && < 0.8.0,
-        implicit-hie-cradle >= 0.3.0.2 && < 0.4,
-        base16-bytestring >=0.1.1 && <0.2
-    if os(windows)
-      build-depends:
-        Win32
-    else
-      build-depends:
-        unix
-      c-sources:
-        cbits/getmodtime.c
-
-    default-extensions:
-        BangPatterns
-        DeriveFunctor
-        DeriveGeneric
-        FlexibleContexts
-        GeneralizedNewtypeDeriving
-        LambdaCase
-        NamedFieldPuns
-        OverloadedStrings
-        RecordWildCards
-        ScopedTypeVariables
-        StandaloneDeriving
-        TupleSections
-        TypeApplications
-        ViewPatterns
-        DataKinds
-        TypeOperators
-        KindSignatures
-
-    hs-source-dirs:
-        src
-        session-loader
-    include-dirs:
-        include
-    exposed-modules:
-        Development.IDE
-        Development.IDE.Main
-        Development.IDE.Core.Debouncer
-        Development.IDE.Core.FileStore
-        Development.IDE.Core.IdeConfiguration
-        Development.IDE.Core.OfInterest
-        Development.IDE.Core.PositionMapping
-        Development.IDE.Core.Preprocessor
-        Development.IDE.Core.Rules
-        Development.IDE.Core.RuleTypes
-        Development.IDE.Core.Service
-        Development.IDE.Core.Shake
-        Development.IDE.Core.Tracing
-        Development.IDE.GHC.Compat
-        Development.IDE.Core.Compile
-        Development.IDE.GHC.Error
-        Development.IDE.GHC.ExactPrint
-        Development.IDE.GHC.Orphans
-        Development.IDE.GHC.Util
-        Development.IDE.Import.DependencyInformation
-        Development.IDE.Import.FindImports
-        Development.IDE.LSP.HoverDefinition
-        Development.IDE.LSP.LanguageServer
-        Development.IDE.LSP.Outline
-        Development.IDE.LSP.Server
-        Development.IDE.Session
-        Development.IDE.Spans.Common
-        Development.IDE.Spans.Documentation
-        Development.IDE.Spans.AtPoint
-        Development.IDE.Spans.LocalBindings
-        Development.IDE.Types.Diagnostics
-        Development.IDE.Types.Exports
-        Development.IDE.Types.HscEnvEq
-        Development.IDE.Types.KnownTargets
-        Development.IDE.Types.Location
-        Development.IDE.Types.Logger
-        Development.IDE.Types.Options
-        Development.IDE.Types.Shake
-        Development.IDE.Plugin
-        Development.IDE.Plugin.Completions
-        Development.IDE.Plugin.Completions.Types
-        Development.IDE.Plugin.CodeAction
-        Development.IDE.Plugin.CodeAction.ExactPrint
-        Development.IDE.Plugin.HLS
-        Development.IDE.Plugin.HLS.GhcIde
-        Development.IDE.Plugin.Test
-        Development.IDE.Plugin.TypeLenses
-
-    other-modules:
-        Development.IDE.Core.FileExists
-        Development.IDE.GHC.CPP
-        Development.IDE.GHC.Warnings
-        Development.IDE.LSP.Notifications
-        Development.IDE.Plugin.CodeAction.PositionIndexed
-        Development.IDE.Plugin.Completions.Logic
-        Development.IDE.Session.VersionCheck
-        Development.IDE.Types.Action
-    ghc-options: -Wall -Wno-name-shadowing -Wincomplete-uni-patterns -Wno-unticked-promoted-constructors
-
-    if flag(ghc-patched-unboxed-bytecode)
-      cpp-options: -DGHC_PATCHED_UNBOXED_BYTECODE
-
-executable ghcide-test-preprocessor
-    default-language: Haskell2010
-    hs-source-dirs: test/preprocessor
-    ghc-options: -Wall -Wno-name-shadowing
-    main-is: Main.hs
-    build-depends:
-        base == 4.*
-
-benchmark benchHist
-    type: exitcode-stdio-1.0
-    default-language: Haskell2010
-    ghc-options: -Wall -Wno-name-shadowing -threaded
-    main-is: Main.hs
-    hs-source-dirs: bench/hist bench/lib
-    other-modules: Experiments.Types
-    build-tool-depends:
-        ghcide:ghcide-bench,
-        hp2pretty:hp2pretty,
-        implicit-hie:gen-hie
-    default-extensions:
-        BangPatterns
-        DeriveFunctor
-        DeriveGeneric
-        FlexibleContexts
-        GeneralizedNewtypeDeriving
-        LambdaCase
-        NamedFieldPuns
-        RecordWildCards
-        ScopedTypeVariables
-        StandaloneDeriving
-        TupleSections
-        TypeApplications
-        ViewPatterns
-
-    build-depends:
-        aeson,
-        base == 4.*,
-        shake-bench == 0.1.*,
-        directory,
-        extra,
-        filepath,
-        optparse-applicative,
-        shake,
-        text,
-        yaml
-
-executable ghcide
-    default-language:   Haskell2010
-    include-dirs:
-        include
-    hs-source-dirs:     exe
-    ghc-options:
-                -threaded
-                -Wall
-                -Wincomplete-uni-patterns
-                -Wno-name-shadowing
-                -- allow user RTS overrides
-                -rtsopts
-                -- disable idle GC
-                -- increase nursery size
-                "-with-rtsopts=-I0 -A128M"
-    main-is: Main.hs
-    build-depends:
-        hiedb,
-        aeson,
-        base == 4.*,
-        data-default,
-        directory,
-        extra,
-        filepath,
-        gitrev,
-        safe-exceptions,
-        ghc,
-        hashable,
-        lsp,
-        lsp-types,
-        heapsize,
-        hie-bios,
-        hls-plugin-api,
-        ghcide,
-        lens,
-        optparse-applicative,
-        shake,
-        text,
-        unordered-containers
-    other-modules:
-        Arguments
-        Paths_ghcide
-    autogen-modules:
-        Paths_ghcide
-
-    default-extensions:
-        BangPatterns
-        DeriveFunctor
-        DeriveGeneric
-        FlexibleContexts
-        GeneralizedNewtypeDeriving
-        LambdaCase
-        NamedFieldPuns
-        OverloadedStrings
-        RecordWildCards
-        ScopedTypeVariables
-        StandaloneDeriving
-        TupleSections
-        TypeApplications
-        ViewPatterns
-
-test-suite ghcide-tests
-    type: exitcode-stdio-1.0
-    default-language: Haskell2010
-    build-tool-depends:
-        ghcide:ghcide,
-        ghcide:ghcide-test-preprocessor,
-        implicit-hie:gen-hie
-    build-depends:
-        aeson,
-        base,
-        binary,
-        bytestring,
-        containers,
-        data-default,
-        directory,
-        extra,
-        filepath,
-        --------------------------------------------------------------
-        -- The MIN_GHC_API_VERSION macro relies on MIN_VERSION pragmas
-        -- which require depending on ghc. So the tests need to depend
-        -- on ghc if they need to use MIN_GHC_API_VERSION. Maybe a
-        -- better solution can be found, but this is a quick solution
-        -- which works for now.
-        ghc,
-        --------------------------------------------------------------
-        ghcide,
-        ghc-typelits-knownnat,
-        haddock-library,
-        lsp,
-        lsp-types,
-        hls-plugin-api,
-        network-uri,
-        lens,
-        lsp-test == 0.13.0.0,
-        optparse-applicative,
-        process,
-        QuickCheck,
-        quickcheck-instances,
-        rope-utf16-splay,
-        safe,
-        safe-exceptions,
-        shake,
-        tasty,
-        tasty-expected-failure,
-        tasty-hunit,
-        tasty-quickcheck,
-        tasty-rerun,
-        text
-    if (impl(ghc >= 8.6))
-      build-depends:
-          record-dot-preprocessor,
-          record-hasfield
-    hs-source-dirs: test/cabal test/exe test/src bench/lib
-    include-dirs: include
-    ghc-options: -threaded -Wall -Wno-name-shadowing -O0 -Wno-unticked-promoted-constructors
-    main-is: Main.hs
-    other-modules:
-        Development.IDE.Test
-        Development.IDE.Test.Runfiles
-        Experiments
-        Experiments.Types
-    default-extensions:
-        BangPatterns
-        DeriveFunctor
-        DeriveGeneric
-        FlexibleContexts
-        GeneralizedNewtypeDeriving
-        LambdaCase
-        NamedFieldPuns
-        OverloadedStrings
-        RecordWildCards
-        ScopedTypeVariables
-        StandaloneDeriving
-        TupleSections
-        TypeApplications
-        ViewPatterns
-
-executable ghcide-bench
-    default-language: Haskell2010
-    build-tool-depends:
-        ghcide:ghcide
-    build-depends:
-        aeson,
-        base,
-        bytestring,
-        containers,
-        directory,
-        extra,
-        filepath,
-        ghcide,
-        lsp-test == 0.13.0.0,
-        optparse-applicative,
-        process,
-        safe-exceptions,
-        shake,
-        text
-    hs-source-dirs: bench/lib bench/exe
-    include-dirs: include
-    ghc-options: -threaded -Wall -Wno-name-shadowing -rtsopts
-    main-is: Main.hs
-    other-modules:
-        Experiments
-        Experiments.Types
-    default-extensions:
-        BangPatterns
-        DeriveFunctor
-        DeriveGeneric
-        FlexibleContexts
-        GeneralizedNewtypeDeriving
-        LambdaCase
-        NamedFieldPuns
-        OverloadedStrings
-        RecordWildCards
-        ScopedTypeVariables
-        StandaloneDeriving
-        TupleSections
-        TypeApplications
-        ViewPatterns
+cabal-version:      2.2+build-type:         Simple+category:           Development+name:               ghcide+version:            1.1.0.0+license:            Apache-2.0+license-file:       LICENSE+author:             Digital Asset and Ghcide contributors+maintainer:         Ghcide contributors+copyright:          Digital Asset and Ghcide contributors 2018-2020+synopsis:           The core of an IDE+description:+    A library for building Haskell IDE's on top of the GHC API.+homepage:           https://github.com/haskell/ghcide#readme+bug-reports:        https://github.com/haskell/ghcide/issues+tested-with:        GHC == 8.6.4 || == 8.6.5 || == 8.8.2 || == 8.8.3 || == 8.8.4 || == 8.10.2 || == 8.10.3 || == 8.10.4+extra-source-files: include/ghc-api-version.h README.md CHANGELOG.md+                    test/data/hover/*.hs+                    test/data/multi/cabal.project+                    test/data/multi/hie.yaml+                    test/data/multi/a/a.cabal+                    test/data/multi/a/*.hs+                    test/data/multi/b/b.cabal+                    test/data/multi/b/*.hs++source-repository head+    type:     git+    location: https://github.com/haskell/ghcide.git++flag ghc-patched-unboxed-bytecode+    description: The GHC version we link against supports unboxed sums and tuples in bytecode+    default:     False+    manual:      True++library+    default-language:   Haskell2010+    build-depends:+        aeson,+        array,+        async,+        base == 4.*,+        binary,+        bytestring,+        case-insensitive,+        containers,+        data-default,+        deepseq,+        directory,+        dependent-map,+        dependent-sum,+        dlist,+        extra >= 1.7.4,+        fuzzy,+        filepath,+        fingertree,+        ghc-exactprint,+        Glob,+        haddock-library >= 1.8 && < 1.10,+        hashable,+        hie-compat ^>= 0.1.0.0,+        hls-plugin-api ^>= 1.0.0.0,+        lens,+        hiedb == 0.3.0.1,+        lsp-types == 1.1.*,+        lsp == 1.1.1.0,+        mtl,+        network-uri,+        parallel,+        prettyprinter-ansi-terminal,+        prettyprinter-ansi-terminal,+        prettyprinter,+        regex-tdfa >= 1.3.1.0,+        retrie,+        rope-utf16-splay,+        safe,+        safe-exceptions,+        shake >= 0.18.4,+        sorted-list,+        sqlite-simple,+        stm,+        syb,+        text,+        time,+        transformers,+        unordered-containers >= 0.2.10.0,+        utf8-string,+        vector,+        hslogger,+        Diff,+        vector,+        bytestring-encoding,+        opentelemetry >=0.6.1,+        heapsize ==0.3.*,+        unliftio,+        unliftio-core,+        ghc-boot-th,+        ghc-boot,+        ghc >= 8.6,+        ghc-check >=0.5.0.1,+        ghc-paths,+        cryptohash-sha1 >=0.11.100 && <0.12,+        hie-bios >= 0.7.1 && < 0.8.0,+        implicit-hie-cradle >= 0.3.0.2 && < 0.4,+        base16-bytestring >=0.1.1 && <0.2+    if os(windows)+      build-depends:+        Win32+    else+      build-depends:+        unix+      c-sources:+        cbits/getmodtime.c++    default-extensions:+        BangPatterns+        DeriveFunctor+        DeriveGeneric+        FlexibleContexts+        GeneralizedNewtypeDeriving+        LambdaCase+        NamedFieldPuns+        OverloadedStrings+        RecordWildCards+        ScopedTypeVariables+        StandaloneDeriving+        TupleSections+        TypeApplications+        ViewPatterns+        DataKinds+        TypeOperators+        KindSignatures++    hs-source-dirs:+        src+        session-loader+    include-dirs:+        include+    exposed-modules:+        Control.Concurrent.Strict+        Development.IDE+        Development.IDE.Main+        Development.IDE.Core.Debouncer+        Development.IDE.Core.FileStore+        Development.IDE.Core.IdeConfiguration+        Development.IDE.Core.OfInterest+        Development.IDE.Core.PositionMapping+        Development.IDE.Core.Preprocessor+        Development.IDE.Core.Rules+        Development.IDE.Core.RuleTypes+        Development.IDE.Core.Service+        Development.IDE.Core.Shake+        Development.IDE.Core.Tracing+        Development.IDE.GHC.Compat+        Development.IDE.Core.Compile+        Development.IDE.GHC.Error+        Development.IDE.GHC.ExactPrint+        Development.IDE.GHC.Orphans+        Development.IDE.GHC.Util+        Development.IDE.Import.DependencyInformation+        Development.IDE.Import.FindImports+        Development.IDE.LSP.HoverDefinition+        Development.IDE.LSP.LanguageServer+        Development.IDE.LSP.Outline+        Development.IDE.LSP.Server+        Development.IDE.Session+        Development.IDE.Spans.Common+        Development.IDE.Spans.Documentation+        Development.IDE.Spans.AtPoint+        Development.IDE.Spans.LocalBindings+        Development.IDE.Types.Diagnostics+        Development.IDE.Types.Exports+        Development.IDE.Types.HscEnvEq+        Development.IDE.Types.KnownTargets+        Development.IDE.Types.Location+        Development.IDE.Types.Logger+        Development.IDE.Types.Options+        Development.IDE.Types.Shake+        Development.IDE.Plugin+        Development.IDE.Plugin.Completions+        Development.IDE.Plugin.Completions.Types+        Development.IDE.Plugin.CodeAction+        Development.IDE.Plugin.CodeAction.ExactPrint+        Development.IDE.Plugin.HLS+        Development.IDE.Plugin.HLS.GhcIde+        Development.IDE.Plugin.Test+        Development.IDE.Plugin.TypeLenses++    other-modules:+        Development.IDE.Core.FileExists+        Development.IDE.GHC.CPP+        Development.IDE.GHC.Warnings+        Development.IDE.LSP.Notifications+        Development.IDE.Plugin.CodeAction.PositionIndexed+        Development.IDE.Plugin.CodeAction.Args+        Development.IDE.Plugin.Completions.Logic+        Development.IDE.Session.VersionCheck+        Development.IDE.Types.Action+    ghc-options: -Wall -Wno-name-shadowing -Wincomplete-uni-patterns -Wno-unticked-promoted-constructors++    if flag(ghc-patched-unboxed-bytecode)+      cpp-options: -DGHC_PATCHED_UNBOXED_BYTECODE++executable ghcide-test-preprocessor+    default-language: Haskell2010+    hs-source-dirs: test/preprocessor+    ghc-options: -Wall -Wno-name-shadowing+    main-is: Main.hs+    build-depends:+        base == 4.*++benchmark benchHist+    type: exitcode-stdio-1.0+    default-language: Haskell2010+    ghc-options: -Wall -Wno-name-shadowing -threaded+    main-is: Main.hs+    hs-source-dirs: bench/hist bench/lib+    other-modules: Experiments.Types+    build-tool-depends:+        ghcide:ghcide-bench,+        hp2pretty:hp2pretty,+        implicit-hie:gen-hie+    default-extensions:+        BangPatterns+        DeriveFunctor+        DeriveGeneric+        FlexibleContexts+        GeneralizedNewtypeDeriving+        LambdaCase+        NamedFieldPuns+        RecordWildCards+        ScopedTypeVariables+        StandaloneDeriving+        TupleSections+        TypeApplications+        ViewPatterns++    build-depends:+        aeson,+        base == 4.*,+        shake-bench == 0.1.*,+        directory,+        extra,+        filepath,+        optparse-applicative,+        shake,+        text,+        yaml++executable ghcide+    default-language:   Haskell2010+    include-dirs:+        include+    hs-source-dirs:     exe+    ghc-options:+                -threaded+                -Wall+                -Wincomplete-uni-patterns+                -Wno-name-shadowing+                -- allow user RTS overrides+                -rtsopts+                -- disable idle GC+                -- increase nursery size+                "-with-rtsopts=-I0 -A128M"+    main-is: Main.hs+    build-depends:+        hiedb,+        aeson,+        base == 4.*,+        data-default,+        directory,+        extra,+        filepath,+        gitrev,+        safe-exceptions,+        ghc,+        hashable,+        lsp,+        lsp-types,+        heapsize,+        hie-bios,+        hls-plugin-api,+        ghcide,+        lens,+        optparse-applicative,+        shake,+        text,+        unordered-containers+    other-modules:+        Arguments+        Paths_ghcide+    autogen-modules:+        Paths_ghcide++    default-extensions:+        BangPatterns+        DeriveFunctor+        DeriveGeneric+        FlexibleContexts+        GeneralizedNewtypeDeriving+        LambdaCase+        NamedFieldPuns+        OverloadedStrings+        RecordWildCards+        ScopedTypeVariables+        StandaloneDeriving+        TupleSections+        TypeApplications+        ViewPatterns++test-suite ghcide-tests+    type: exitcode-stdio-1.0+    default-language: Haskell2010+    build-tool-depends:+        ghcide:ghcide,+        ghcide:ghcide-test-preprocessor,+        implicit-hie:gen-hie+    build-depends:+        aeson,+        base,+        binary,+        bytestring,+        containers,+        data-default,+        directory,+        extra,+        filepath,+        --------------------------------------------------------------+        -- The MIN_GHC_API_VERSION macro relies on MIN_VERSION pragmas+        -- which require depending on ghc. So the tests need to depend+        -- on ghc if they need to use MIN_GHC_API_VERSION. Maybe a+        -- better solution can be found, but this is a quick solution+        -- which works for now.+        ghc,+        --------------------------------------------------------------+        ghcide,+        ghc-typelits-knownnat,+        haddock-library,+        lsp,+        lsp-types,+        hls-plugin-api,+        network-uri,+        lens,+        lsp-test == 0.13.0.0,+        optparse-applicative,+        process,+        QuickCheck,+        quickcheck-instances,+        rope-utf16-splay,+        safe,+        safe-exceptions,+        shake,+        tasty,+        tasty-expected-failure,+        tasty-hunit,+        tasty-quickcheck,+        tasty-rerun,+        text+    if (impl(ghc >= 8.6))+      build-depends:+          record-dot-preprocessor,+          record-hasfield+    hs-source-dirs: test/cabal test/exe test/src bench/lib+    include-dirs: include+    ghc-options: -threaded -Wall -Wno-name-shadowing -O0 -Wno-unticked-promoted-constructors+    main-is: Main.hs+    other-modules:+        Development.IDE.Test+        Development.IDE.Test.Runfiles+        Experiments+        Experiments.Types+    default-extensions:+        BangPatterns+        DeriveFunctor+        DeriveGeneric+        FlexibleContexts+        GeneralizedNewtypeDeriving+        LambdaCase+        NamedFieldPuns+        OverloadedStrings+        RecordWildCards+        ScopedTypeVariables+        StandaloneDeriving+        TupleSections+        TypeApplications+        ViewPatterns++executable ghcide-bench+    default-language: Haskell2010+    build-tool-depends:+        ghcide:ghcide+    build-depends:+        aeson,+        base,+        bytestring,+        containers,+        directory,+        extra,+        filepath,+        ghcide,+        lsp-test == 0.13.0.0,+        optparse-applicative,+        process,+        safe-exceptions,+        shake,+        text+    hs-source-dirs: bench/lib bench/exe+    include-dirs: include+    ghc-options: -threaded -Wall -Wno-name-shadowing -rtsopts+    main-is: Main.hs+    other-modules:+        Experiments+        Experiments.Types+    default-extensions:+        BangPatterns+        DeriveFunctor+        DeriveGeneric+        FlexibleContexts+        GeneralizedNewtypeDeriving+        LambdaCase+        NamedFieldPuns+        OverloadedStrings+        RecordWildCards+        ScopedTypeVariables+        StandaloneDeriving+        TupleSections+        TypeApplications+        ViewPatterns

@@ -1,12 +1,12 @@-#ifndef GHC_API_VERSION_H
-#define GHC_API_VERSION_H
-
-#ifdef GHC_LIB
-#define MIN_GHC_API_VERSION(x,y,z) MIN_VERSION_ghc_lib(x,y,z)
-#define GHC_API_VERSION VERSION_ghc_lib
-#else
-#define MIN_GHC_API_VERSION(x,y,z) MIN_VERSION_ghc(x,y,z)
-#define GHC_API_VERSION VERSION_ghc
-#endif
-
-#endif
+#ifndef GHC_API_VERSION_H+#define GHC_API_VERSION_H++#ifdef GHC_LIB+#define MIN_GHC_API_VERSION(x,y,z) MIN_VERSION_ghc_lib(x,y,z)+#define GHC_API_VERSION VERSION_ghc_lib+#else+#define MIN_GHC_API_VERSION(x,y,z) MIN_VERSION_ghc(x,y,z)+#define GHC_API_VERSION VERSION_ghc+#endif++#endif

@@ -1,862 +1,876 @@-{-# LANGUAGE TypeFamilies #-}
-{-# LANGUAGE CPP #-}
-#include "ghc-api-version.h"
-
-{-|
-The logic for setting up a ghcide session by tapping into hie-bios.
--}
-module Development.IDE.Session
-  (SessionLoadingOptions(..)
-  ,CacheDirs(..)
-  ,loadSession
-  ,loadSessionWithOptions
-  ,setInitialDynFlags
-  ,getHieDbLoc
-  ,runWithDb
-  ) where
-
--- Unfortunately, we cannot use loadSession with ghc-lib since hie-bios uses
--- the real GHC library and the types are incompatible. Furthermore, when
--- building with ghc-lib we need to make this Haskell agnostic, so no hie-bios!
-
-import Control.Concurrent.Async
-import Control.Concurrent.Extra
-import Control.Exception.Safe
-import Control.Monad
-import Control.Monad.Extra
-import Control.Monad.IO.Class
-import qualified Crypto.Hash.SHA1 as H
-import qualified Data.ByteString.Char8 as B
-import qualified Data.HashMap.Strict as HM
-import qualified Data.Map.Strict as Map
-import qualified Data.Text as T
-import Data.Aeson
-import Data.Bifunctor
-import qualified Data.ByteString.Base16 as B16
-import Data.Default
-import Data.Either.Extra
-import Data.Function
-import Data.Hashable
-import Data.List
-import Data.IORef
-import Data.Maybe
-import Data.Time.Clock
-import Data.Version
-import Development.IDE.Core.Shake
-import Development.IDE.Core.RuleTypes
-import Development.IDE.GHC.Compat hiding (Target, TargetModule, TargetFile)
-import qualified Development.IDE.GHC.Compat as GHC
-import Development.IDE.GHC.Util
-import Development.IDE.Session.VersionCheck
-import Development.IDE.Types.Diagnostics
-import Development.IDE.Types.Exports
-import Development.IDE.Types.HscEnvEq (HscEnvEq, newHscEnvEqPreserveImportPaths, newHscEnvEq)
-import Development.IDE.Types.Location
-import Development.IDE.Types.Logger
-import Development.IDE.Types.Options
-import Development.Shake (Action)
-import GHC.Check
-import qualified HIE.Bios as HieBios
-import HIE.Bios.Environment hiding (getCacheDir)
-import HIE.Bios.Types
-import Hie.Implicit.Cradle (loadImplicitHieCradle)
-import Language.LSP.Server
-import Language.LSP.Types
-import System.Directory
-import qualified System.Directory.Extra as IO
-import System.FilePath
-import System.Info
-import System.IO
-
-import GHCi
-import HscTypes (ic_dflags, hsc_IC, hsc_dflags, hsc_NC)
-import Linker
-import Module
-import NameCache
-import Packages
-import Control.Exception (evaluate)
-import Data.Void
-import Control.Applicative (Alternative((<|>)))
-
-import HieDb.Create
-import HieDb.Types
-import HieDb.Utils
-import Database.SQLite.Simple
-import Control.Concurrent.STM.TQueue
-import Control.Concurrent.STM (atomically)
-import Maybes (MaybeT(runMaybeT))
-import HIE.Bios.Cradle (yamlConfig)
-
-
-data CacheDirs = CacheDirs
-  { hiCacheDir, hieCacheDir, oCacheDir :: Maybe FilePath}
-
-data SessionLoadingOptions = SessionLoadingOptions
-  { findCradle :: FilePath -> IO (Maybe FilePath)
-  , loadCradle :: FilePath -> IO (HieBios.Cradle Void)
-  -- | Given the project name and a set of command line flags,
-  --   return the path for storing generated GHC artifacts,
-  --   or 'Nothing' to respect the cradle setting
-  , getCacheDirs :: String -> [String] -> IO CacheDirs
-  -- | Return the GHC lib dir to use for the 'unsafeGlobalDynFlags'
-  , getInitialGhcLibDir :: IO (Maybe LibDir)
-  }
-
-instance Default SessionLoadingOptions where
-    def = SessionLoadingOptions
-        {findCradle = HieBios.findCradle
-        ,loadCradle = HieBios.loadCradle
-        ,getCacheDirs = getCacheDirsDefault
-        ,getInitialGhcLibDir = getInitialGhcLibDirDefault
-        }
-
-getInitialGhcLibDirDefault :: IO (Maybe LibDir)
-getInitialGhcLibDirDefault = do
-  dir <- IO.getCurrentDirectory
-  hieYaml <- runMaybeT $ yamlConfig dir
-  cradle <- maybe (loadImplicitHieCradle $ addTrailingPathSeparator dir) HieBios.loadCradle hieYaml
-  hPutStrLn stderr $ "setInitialDynFlags cradle: " ++ show cradle
-  libDirRes <- getRuntimeGhcLibDir cradle
-  case libDirRes of
-      CradleSuccess libdir -> pure $ Just $ LibDir libdir
-      CradleFail err -> do
-        hPutStrLn stderr $ "Couldn't load cradle for libdir: " ++ show (err,dir,hieYaml,cradle)
-        pure Nothing
-      CradleNone -> do
-        hPutStrLn stderr "Couldn't load cradle (CradleNone)"
-        pure Nothing
-
--- | Sets `unsafeGlobalDynFlags` on using the hie-bios cradle and returns the GHC libdir
-setInitialDynFlags :: SessionLoadingOptions -> IO (Maybe LibDir)
-setInitialDynFlags SessionLoadingOptions{..} = do
-  libdir <- getInitialGhcLibDir
-  dynFlags <- mapM dynFlagsForPrinting libdir
-  mapM_ setUnsafeGlobalDynFlags dynFlags
-  pure libdir
-
--- | Wraps `withHieDb` to provide a database connection for reading, and a `HieWriterChan` for
--- writing. Actions are picked off one by one from the `HieWriterChan` and executed in serial
--- by a worker thread using a dedicated database connection.
--- This is done in order to serialize writes to the database, or else SQLite becomes unhappy
-runWithDb :: FilePath -> (HieDb -> IndexQueue -> IO ()) -> IO ()
-runWithDb fp k = do
-  -- Delete the database if it has an incompatible schema version
-  withHieDb fp (const $ pure ())
-    `catch` \IncompatibleSchemaVersion{} -> removeFile fp
-  withHieDb fp $ \writedb -> do
-    initConn writedb
-    chan <- newTQueueIO
-    withAsync (writerThread writedb chan) $ \_ -> do
-      withHieDb fp (flip k chan)
-  where
-    writerThread db chan = do
-      -- Clear the index of any files that might have been deleted since the last run
-      deleteMissingRealFiles db
-      _ <- garbageCollectTypeNames db
-      forever $ do
-        k <- atomically $ readTQueue chan
-        k db
-          `catch` \e@SQLError{} -> do
-            hPutStrLn stderr $ "SQLite error in worker, ignoring: " ++ show e
-          `catchAny` \e -> do
-            hPutStrLn stderr $ "Uncaught error in database worker, ignoring: " ++ show e
-
-
-getHieDbLoc :: FilePath -> IO FilePath
-getHieDbLoc dir = do
-  let db = dirHash++"-"++takeBaseName dir++"-"++VERSION_ghc <.> "hiedb"
-      dirHash = B.unpack $ B16.encode $ H.hash $ B.pack dir
-  cDir <- IO.getXdgDirectory IO.XdgCache cacheDir
-  createDirectoryIfMissing True cDir
-  pure (cDir </> db)
-
--- | Given a root directory, return a Shake 'Action' which setups an
--- 'IdeGhcSession' given a file.
--- Some of the many things this does:
---
--- * Find the cradle for the file
--- * Get the session options,
--- * Get the GHC lib directory
--- * Make sure the GHC compiletime and runtime versions match
--- * Restart the Shake session
---
--- This is the key function which implements multi-component support. All
--- components mapping to the same hie.yaml file are mapped to the same
--- HscEnv which is updated as new components are discovered.
-loadSession :: FilePath -> IO (Action IdeGhcSession)
-loadSession = loadSessionWithOptions def
-
-loadSessionWithOptions :: SessionLoadingOptions -> FilePath -> IO (Action IdeGhcSession)
-loadSessionWithOptions SessionLoadingOptions{..} dir = do
-  -- Mapping from hie.yaml file to HscEnv, one per hie.yaml file
-  hscEnvs <- newVar Map.empty :: IO (Var HieMap)
-  -- Mapping from a Filepath to HscEnv
-  fileToFlags <- newVar Map.empty :: IO (Var FlagsMap)
-  -- Mapping from a Filepath to its 'hie.yaml' location.
-  -- Should hold the same Filepaths as 'fileToFlags', otherwise
-  -- they are inconsistent. So, everywhere you modify 'fileToFlags',
-  -- you have to modify 'filesMap' as well.
-  filesMap <- newVar HM.empty :: IO (Var FilesMap)
-  -- Version of the mappings above
-  version <- newVar 0
-  let returnWithVersion fun = IdeGhcSession fun <$> liftIO (readVar version)
-  let invalidateShakeCache = do
-        modifyVar_ version (return . succ)
-  -- This caches the mapping from Mod.hs -> hie.yaml
-  cradleLoc <- liftIO $ memoIO $ \v -> do
-      res <- findCradle v
-      -- Sometimes we get C:, sometimes we get c:, and sometimes we get a relative path
-      -- try and normalise that
-      -- e.g. see https://github.com/haskell/ghcide/issues/126
-      res' <- traverse makeAbsolute res
-      return $ normalise <$> res'
-
-  dummyAs <- async $ return (error "Uninitialised")
-  runningCradle <- newVar dummyAs :: IO (Var (Async (IdeResult HscEnvEq,[FilePath])))
-
-  return $ do
-    extras@ShakeExtras{logger, restartShakeSession, ideNc, knownTargetsVar, lspEnv
-                      } <- getShakeExtras
-
-    IdeOptions{ optTesting = IdeTesting optTesting
-              , optCheckProject = getCheckProject
-              , optCustomDynFlags
-              , optExtensions
-              } <- getIdeOptions
-
-        -- populate the knownTargetsVar with all the
-        -- files in the project so that `knownFiles` can learn about them and
-        -- we can generate a complete module graph
-    let extendKnownTargets newTargets = do
-          knownTargets <- forM newTargets $ \TargetDetails{..} ->
-            case targetTarget of
-              TargetFile f -> pure (targetTarget, [f])
-              TargetModule _ -> do
-                found <- filterM (IO.doesFileExist . fromNormalizedFilePath) targetLocations
-                return (targetTarget, found)
-          modifyVar_ knownTargetsVar $ traverseHashed $ \known -> do
-            let known' = HM.unionWith (<>) known $ HM.fromList knownTargets
-            when (known /= known') $
-                logDebug logger $ "Known files updated: " <>
-                    T.pack(show $ (HM.map . map) fromNormalizedFilePath known')
-            evaluate known'
-
-    -- Create a new HscEnv from a hieYaml root and a set of options
-    -- If the hieYaml file already has an HscEnv, the new component is
-    -- combined with the components in the old HscEnv into a new HscEnv
-    -- which contains the union.
-    let packageSetup :: (Maybe FilePath, NormalizedFilePath, ComponentOptions, FilePath)
-                     -> IO (HscEnv, ComponentInfo, [ComponentInfo])
-        packageSetup (hieYaml, cfp, opts, libDir) = do
-          -- Parse DynFlags for the newly discovered component
-          hscEnv <- emptyHscEnv ideNc libDir
-          (df, targets) <- evalGhcEnv hscEnv $
-              first optCustomDynFlags <$> setOptions opts (hsc_dflags hscEnv)
-          let deps = componentDependencies opts ++ maybeToList hieYaml
-          dep_info <- getDependencyInfo deps
-          -- Now lookup to see whether we are combining with an existing HscEnv
-          -- or making a new one. The lookup returns the HscEnv and a list of
-          -- information about other components loaded into the HscEnv
-          -- (unitId, DynFlag, Targets)
-          modifyVar hscEnvs $ \m -> do
-              -- Just deps if there's already an HscEnv
-              -- Nothing is it's the first time we are making an HscEnv
-              let oldDeps = Map.lookup hieYaml m
-              let -- Add the raw information about this component to the list
-                  -- We will modify the unitId and DynFlags used for
-                  -- compilation but these are the true source of
-                  -- information.
-                  new_deps = RawComponentInfo (thisInstalledUnitId df) df targets cfp opts dep_info
-                                : maybe [] snd oldDeps
-                  -- Get all the unit-ids for things in this component
-                  inplace = map rawComponentUnitId new_deps
-
-              new_deps' <- forM new_deps $ \RawComponentInfo{..} -> do
-                  -- Remove all inplace dependencies from package flags for
-                  -- components in this HscEnv
-                  let (df2, uids) = removeInplacePackages inplace rawComponentDynFlags
-                  let prefix = show rawComponentUnitId
-                  -- See Note [Avoiding bad interface files]
-                  let hscComponents = sort $ map show uids
-                      cacheDirOpts = hscComponents ++ componentOptions opts
-                  cacheDirs <- liftIO $ getCacheDirs prefix cacheDirOpts
-                  processed_df <- setCacheDirs logger cacheDirs df2
-                  -- The final component information, mostly the same but the DynFlags don't
-                  -- contain any packages which are also loaded
-                  -- into the same component.
-                  pure $ ComponentInfo rawComponentUnitId
-                                       processed_df
-                                       uids
-                                       rawComponentTargets
-                                       rawComponentFP
-                                       rawComponentCOptions
-                                       rawComponentDependencyInfo
-              -- Make a new HscEnv, we have to recompile everything from
-              -- scratch again (for now)
-              -- It's important to keep the same NameCache though for reasons
-              -- that I do not fully understand
-              logInfo logger (T.pack ("Making new HscEnv" ++ show inplace))
-              hscEnv <- emptyHscEnv ideNc libDir
-              newHscEnv <-
-                -- Add the options for the current component to the HscEnv
-                evalGhcEnv hscEnv $ do
-                  _ <- setSessionDynFlags df
-                  getSession
-
-              -- Modify the map so the hieYaml now maps to the newly created
-              -- HscEnv
-              -- Returns
-              -- . the new HscEnv so it can be used to modify the
-              --   FilePath -> HscEnv map (fileToFlags)
-              -- . The information for the new component which caused this cache miss
-              -- . The modified information (without -inplace flags) for
-              --   existing packages
-              pure (Map.insert hieYaml (newHscEnv, new_deps) m, (newHscEnv, head new_deps', tail new_deps'))
-
-
-    let session :: (Maybe FilePath, NormalizedFilePath, ComponentOptions, FilePath)
-                -> IO (IdeResult HscEnvEq,[FilePath])
-        session args@(hieYaml, _cfp, _opts, _libDir) = do
-          (hscEnv, new, old_deps) <- packageSetup args
-
-          -- Whenever we spin up a session on Linux, dynamically load libm.so.6
-          -- in. We need this in case the binary is statically linked, in which
-          -- case the interactive session will fail when trying to load
-          -- ghc-prim, which happens whenever Template Haskell is being
-          -- evaluated or haskell-language-server's eval plugin tries to run
-          -- some code. If the binary is dynamically linked, then this will have
-          -- no effect.
-          -- See https://github.com/haskell/haskell-language-server/issues/221
-          when (os == "linux") $ do
-            initObjLinker hscEnv
-            res <- loadDLL hscEnv "libm.so.6"
-            case res of
-              Nothing -> pure ()
-              Just err -> hPutStrLn stderr $
-                "Error dynamically loading libm.so.6:\n" <> err
-
-          -- Make a map from unit-id to DynFlags, this is used when trying to
-          -- resolve imports. (especially PackageImports)
-          let uids = map (\ci -> (componentUnitId ci, componentDynFlags ci)) (new : old_deps)
-
-          -- For each component, now make a new HscEnvEq which contains the
-          -- HscEnv for the hie.yaml file but the DynFlags for that component
-
-          -- New HscEnv for the component in question, returns the new HscEnvEq and
-          -- a mapping from FilePath to the newly created HscEnvEq.
-          let new_cache = newComponentCache logger optExtensions hieYaml _cfp hscEnv uids
-          (cs, res) <- new_cache new
-          -- Modified cache targets for everything else in the hie.yaml file
-          -- which now uses the same EPS and so on
-          cached_targets <- concatMapM (fmap fst . new_cache) old_deps
-
-          let all_targets = cs ++ cached_targets
-
-          modifyVar_ fileToFlags $ \var -> do
-              pure $ Map.insert hieYaml (HM.fromList (concatMap toFlagsMap all_targets)) var
-          modifyVar_ filesMap $ \var -> do
-              evaluate $ HM.union var (HM.fromList (zip (map fst $ concatMap toFlagsMap all_targets) (repeat hieYaml)))
-
-          extendKnownTargets all_targets
-
-          -- Invalidate all the existing GhcSession build nodes by restarting the Shake session
-          invalidateShakeCache
-          restartShakeSession []
-
-          -- Typecheck all files in the project on startup
-          checkProject <- getCheckProject
-          unless (null cs || not checkProject) $ do
-                cfps' <- liftIO $ filterM (IO.doesFileExist . fromNormalizedFilePath) (concatMap targetLocations cs)
-                void $ shakeEnqueue extras $ mkDelayedAction "InitialLoad" Debug $ void $ do
-                    mmt <- uses GetModificationTime cfps'
-                    let cs_exist = catMaybes (zipWith (<$) cfps' mmt)
-                    modIfaces <- uses GetModIface cs_exist
-                    -- update exports map
-                    extras <- getShakeExtras
-                    let !exportsMap' = createExportsMap $ mapMaybe (fmap hirModIface) modIfaces
-                    liftIO $ modifyVar_ (exportsMap extras) $ evaluate . (exportsMap' <>)
-
-          return (second Map.keys res)
-
-    let consultCradle :: Maybe FilePath -> FilePath -> IO (IdeResult HscEnvEq, [FilePath])
-        consultCradle hieYaml cfp = do
-           lfp <- flip makeRelative cfp <$> getCurrentDirectory
-           logInfo logger $ T.pack ("Consulting the cradle for " <> show lfp)
-
-           when (isNothing hieYaml) $ mRunLspT lspEnv $
-             sendNotification SWindowShowMessage $ notifyUserImplicitCradle lfp
-
-           cradle <- maybe (loadImplicitHieCradle $ addTrailingPathSeparator dir) loadCradle hieYaml
-
-           when optTesting $ mRunLspT lspEnv $
-            sendNotification (SCustomMethod "ghcide/cradle/loaded") (toJSON cfp)
-
-           -- Display a user friendly progress message here: They probably don't know what a cradle is
-           let progMsg = "Setting up " <> T.pack (takeBaseName (cradleRootDir cradle))
-                         <> " (for " <> T.pack lfp <> ")"
-           eopts <- mRunLspTCallback lspEnv (withIndefiniteProgress progMsg NotCancellable) $
-              cradleToOptsAndLibDir cradle cfp
-
-           logDebug logger $ T.pack ("Session loading result: " <> show eopts)
-           case eopts of
-             -- The cradle gave us some options so get to work turning them
-             -- into and HscEnv.
-             Right (opts, libDir) -> do
-               installationCheck <- ghcVersionChecker libDir
-               case installationCheck of
-                 InstallationNotFound{..} ->
-                     error $ "GHC installation not found in libdir: " <> libdir
-                 InstallationMismatch{..} ->
-                     return (([renderPackageSetupException cfp GhcVersionMismatch{..}], Nothing),[])
-                 InstallationChecked _compileTime _ghcLibCheck ->
-                   session (hieYaml, toNormalizedFilePath' cfp, opts, libDir)
-             -- Failure case, either a cradle error or the none cradle
-             Left err -> do
-               dep_info <- getDependencyInfo (maybeToList hieYaml)
-               let ncfp = toNormalizedFilePath' cfp
-               let res = (map (renderCradleError ncfp) err, Nothing)
-               modifyVar_ fileToFlags $ \var -> do
-                 pure $ Map.insertWith HM.union hieYaml (HM.singleton ncfp (res, dep_info)) var
-               modifyVar_ filesMap $ \var -> do
-                 evaluate $ HM.insert ncfp hieYaml var
-               return (res, maybe [] pure hieYaml ++ concatMap cradleErrorDependencies err)
-
-    -- This caches the mapping from hie.yaml + Mod.hs -> [String]
-    -- Returns the Ghc session and the cradle dependencies
-    let sessionOpts :: (Maybe FilePath, FilePath)
-                    -> IO (IdeResult HscEnvEq, [FilePath])
-        sessionOpts (hieYaml, file) = do
-          v <- fromMaybe HM.empty . Map.lookup hieYaml <$> readVar fileToFlags
-          cfp <- canonicalizePath file
-          case HM.lookup (toNormalizedFilePath' cfp) v of
-            Just (opts, old_di) -> do
-              deps_ok <- checkDependencyInfo old_di
-              if not deps_ok
-                then do
-                  -- If the dependencies are out of date then clear both caches and start
-                  -- again.
-                  modifyVar_ fileToFlags (const (return Map.empty))
-                  -- Keep the same name cache
-                  modifyVar_ hscEnvs (return . Map.adjust (\(h, _) -> (h, [])) hieYaml )
-                  consultCradle hieYaml cfp
-                else return (opts, Map.keys old_di)
-            Nothing -> consultCradle hieYaml cfp
-
-    -- The main function which gets options for a file. We only want one of these running
-    -- at a time. Therefore the IORef contains the currently running cradle, if we try
-    -- to get some more options then we wait for the currently running action to finish
-    -- before attempting to do so.
-    let getOptions :: FilePath -> IO (IdeResult HscEnvEq, [FilePath])
-        getOptions file = do
-            ncfp <- toNormalizedFilePath' <$> canonicalizePath file
-            cachedHieYamlLocation <- HM.lookup ncfp <$> readVar filesMap
-            hieYaml <- cradleLoc file
-            sessionOpts (join cachedHieYamlLocation <|> hieYaml, file) `catch` \e ->
-                return (([renderPackageSetupException file e], Nothing), maybe [] pure hieYaml)
-
-    returnWithVersion $ \file -> do
-      opts <- liftIO $ join $ mask_ $ modifyVar runningCradle $ \as -> do
-        -- If the cradle is not finished, then wait for it to finish.
-        void $ wait as
-        as <- async $ getOptions file
-        return (as, wait as)
-      pure opts
-
--- | Run the specific cradle on a specific FilePath via hie-bios.
--- This then builds dependencies or whatever based on the cradle, gets the
--- GHC options/dynflags needed for the session and the GHC library directory
-
-cradleToOptsAndLibDir :: Show a => Cradle a -> FilePath
-                      -> IO (Either [CradleError] (ComponentOptions, FilePath))
-cradleToOptsAndLibDir cradle file = do
-    -- Start off by getting the session options
-    let showLine s = hPutStrLn stderr ("> " ++ s)
-    hPutStrLn stderr $ "Output from setting up the cradle " <> show cradle
-    cradleRes <- runCradle (cradleOptsProg cradle) showLine file
-    case cradleRes of
-        CradleSuccess r -> do
-            -- Now get the GHC lib dir
-            libDirRes <- getRuntimeGhcLibDir cradle
-            case libDirRes of
-                -- This is the successful path
-                CradleSuccess libDir -> pure (Right (r, libDir))
-                CradleFail err -> return (Left [err])
-                -- For the None cradle perhaps we still want to report an Info
-                -- message about the fact that the file is being ignored.
-                CradleNone -> return (Left [])
-
-        CradleFail err -> return (Left [err])
-        -- Same here
-        CradleNone -> return (Left [])
-
-emptyHscEnv :: IORef NameCache -> FilePath -> IO HscEnv
-emptyHscEnv nc libDir = do
-    env <- runGhc (Just libDir) getSession
-    initDynLinker env
-    pure $ setNameCache nc env{ hsc_dflags = (hsc_dflags env){useUnicode = True } }
-
-data TargetDetails = TargetDetails
-  {
-      targetTarget :: !Target,
-      targetEnv :: !(IdeResult HscEnvEq),
-      targetDepends :: !DependencyInfo,
-      targetLocations :: ![NormalizedFilePath]
-  }
-
-fromTargetId :: [FilePath]          -- ^ import paths
-             -> [String]            -- ^ extensions to consider
-             -> TargetId
-             -> IdeResult HscEnvEq
-             -> DependencyInfo
-             -> IO [TargetDetails]
--- For a target module we consider all the import paths
-fromTargetId is exts (GHC.TargetModule mod) env dep = do
-    let fps = [i </> moduleNameSlashes mod -<.> ext <> boot
-              | ext <- exts
-              , i <- is
-              , boot <- ["", "-boot"]
-              ]
-    locs <- mapM (fmap toNormalizedFilePath' . canonicalizePath) fps
-    return [TargetDetails (TargetModule mod) env dep locs]
--- For a 'TargetFile' we consider all the possible module names
-fromTargetId _ _ (GHC.TargetFile f _) env deps = do
-    nf <- toNormalizedFilePath' <$> canonicalizePath f
-    return [TargetDetails (TargetFile nf) env deps [nf]]
-
-toFlagsMap :: TargetDetails -> [(NormalizedFilePath, (IdeResult HscEnvEq, DependencyInfo))]
-toFlagsMap TargetDetails{..} =
-    [ (l, (targetEnv, targetDepends)) | l <-  targetLocations]
-
-
-setNameCache :: IORef NameCache -> HscEnv -> HscEnv
-setNameCache nc hsc = hsc { hsc_NC = nc }
-
--- | Create a mapping from FilePaths to HscEnvEqs
-newComponentCache
-         :: Logger
-         -> [String]       -- File extensions to consider
-         -> Maybe FilePath -- Path to cradle
-         -> NormalizedFilePath -- Path to file that caused the creation of this component
-         -> HscEnv
-         -> [(InstalledUnitId, DynFlags)]
-         -> ComponentInfo
-         -> IO ( [TargetDetails], (IdeResult HscEnvEq, DependencyInfo))
-newComponentCache logger exts cradlePath cfp hsc_env uids ci = do
-    let df = componentDynFlags ci
-    let hscEnv' = hsc_env { hsc_dflags = df
-                          , hsc_IC = (hsc_IC hsc_env) { ic_dflags = df } }
-
-    let newFunc = maybe newHscEnvEqPreserveImportPaths newHscEnvEq cradlePath
-    henv <- newFunc hscEnv' uids
-    let targetEnv = ([], Just henv)
-        targetDepends = componentDependencyInfo ci
-        res = (targetEnv, targetDepends)
-    logDebug logger ("New Component Cache HscEnvEq: " <> T.pack (show res))
-
-    let mk t = fromTargetId (importPaths df) exts (targetId t) targetEnv targetDepends
-    ctargets <- concatMapM mk (componentTargets ci)
-
-    -- A special target for the file which caused this wonderful
-    -- component to be created. In case the cradle doesn't list all the targets for
-    -- the component, in which case things will be horribly broken anyway.
-    -- Otherwise, we will immediately attempt to reload this module which
-    -- causes an infinite loop and high CPU usage.
-    let special_target = TargetDetails (TargetFile cfp) targetEnv targetDepends [componentFP ci]
-    return (special_target:ctargets, res)
-
-{- Note [Avoiding bad interface files]
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Originally, we set the cache directory for the various components once
-on the first occurrence of the component.
-This works fine if these components have no references to each other,
-but you have components that depend on each other, the interface files are
-updated for each component.
-After restarting the session and only opening the component that depended
-on the other, suddenly the interface files of this component are stale.
-However, from the point of view of `ghcide`, they do not look stale,
-thus, not regenerated and the IDE shows weird errors such as:
-```
-typecheckIface
-Declaration for Rep_ClientRunFlags
-Axiom branches Rep_ClientRunFlags:
-  Failed to load interface for ‘Distribution.Simple.Flag’
-  Use -v to see a list of the files searched for.
-```
-and
-```
-expectJust checkFamInstConsistency
-CallStack (from HasCallStack):
-  error, called at compiler\\utils\\Maybes.hs:55:27 in ghc:Maybes
-  expectJust, called at compiler\\typecheck\\FamInst.hs:461:30 in ghc:FamInst
-```
-
-To mitigate this, we set the cache directory for each component dependent
-on the components of the current `HscEnv`, additionally to the component options
-of the respective components.
-Assume two components, c1, c2, where c2 depends on c1, and the options of the
-respective components are co1, co2.
-If we want to load component c2, followed by c1, we set the cache directory for
-each component in this way:
-
-  * Load component c2
-    * (Cache Directory State)
-        - name of c2 + co2
-  * Load component c1
-    * (Cache Directory State)
-        - name of c2 + name of c1 + co2
-        - name of c2 + name of c1 + co1
-
-Overall, we created three cache directories. If we opened c1 first, then we
-create a fourth cache directory.
-This makes sure that interface files are always correctly updated.
-
-Since this causes a lot of recompilation, we only update the cache-directory,
-if the dependencies of a component have really changed.
-E.g. when you load two executables, they can not depend on each other. They
-should be filtered out, such that we dont have to re-compile everything.
--}
-
--- | Set the cache-directory based on the ComponentOptions and a list of
--- internal packages.
--- For the exact reason, see Note [Avoiding bad interface files].
-setCacheDirs :: MonadIO m => Logger -> CacheDirs -> DynFlags -> m DynFlags
-setCacheDirs logger CacheDirs{..} dflags = do
-    liftIO $ logInfo logger $ "Using interface files cache dir: " <> T.pack (fromMaybe cacheDir hiCacheDir)
-    pure $ dflags
-          & maybe id setHiDir hiCacheDir
-          & maybe id setHieDir hieCacheDir
-          & maybe id setODir oCacheDir
-
-
-renderCradleError :: NormalizedFilePath -> CradleError -> FileDiagnostic
-renderCradleError nfp (CradleError _ _ec t) =
-  ideErrorWithSource (Just "cradle") (Just DsError) nfp (T.unlines (map T.pack t))
-
--- See Note [Multi Cradle Dependency Info]
-type DependencyInfo = Map.Map FilePath (Maybe UTCTime)
-type HieMap = Map.Map (Maybe FilePath) (HscEnv, [RawComponentInfo])
--- | Maps a "hie.yaml" location to all its Target Filepaths and options.
-type FlagsMap = Map.Map (Maybe FilePath) (HM.HashMap NormalizedFilePath (IdeResult HscEnvEq, DependencyInfo))
--- | Maps a Filepath to its respective "hie.yaml" location.
--- It aims to be the reverse of 'FlagsMap'.
-type FilesMap = HM.HashMap NormalizedFilePath (Maybe FilePath)
-
--- This is pristine information about a component
-data RawComponentInfo = RawComponentInfo
-  { rawComponentUnitId :: InstalledUnitId
-  -- | Unprocessed DynFlags. Contains inplace packages such as libraries.
-  -- We do not want to use them unprocessed.
-  , rawComponentDynFlags :: DynFlags
-  -- | All targets of this components.
-  , rawComponentTargets :: [GHC.Target]
-  -- | Filepath which caused the creation of this component
-  , rawComponentFP :: NormalizedFilePath
-  -- | Component Options used to load the component.
-  , rawComponentCOptions :: ComponentOptions
-  -- | Maps cradle dependencies, such as `stack.yaml`, or `.cabal` file
-  -- to last modification time. See Note [Multi Cradle Dependency Info].
-  , rawComponentDependencyInfo :: DependencyInfo
-  }
-
--- This is processed information about the component, in particular the dynflags will be modified.
-data ComponentInfo = ComponentInfo
-  { componentUnitId :: InstalledUnitId
-  -- | Processed DynFlags. Does not contain inplace packages such as local
-  -- libraries. Can be used to actually load this Component.
-  , componentDynFlags :: DynFlags
-  -- | Internal units, such as local libraries, that this component
-  -- is loaded with. These have been extracted from the original
-  -- ComponentOptions.
-  , _componentInternalUnits :: [InstalledUnitId]
-  -- | All targets of this components.
-  , componentTargets :: [GHC.Target]
-  -- | Filepath which caused the creation of this component
-  , componentFP :: NormalizedFilePath
-  -- | Component Options used to load the component.
-  , _componentCOptions :: ComponentOptions
-  -- | Maps cradle dependencies, such as `stack.yaml`, or `.cabal` file
-  -- to last modification time. See Note [Multi Cradle Dependency Info]
-  , componentDependencyInfo :: DependencyInfo
-  }
-
--- | Check if any dependency has been modified lately.
-checkDependencyInfo :: DependencyInfo -> IO Bool
-checkDependencyInfo old_di = do
-  di <- getDependencyInfo (Map.keys old_di)
-  return (di == old_di)
-
--- Note [Multi Cradle Dependency Info]
--- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--- Why do we implement our own file modification tracking here?
--- The primary reason is that the custom caching logic is quite complicated and going into shake
--- adds even more complexity and more indirection. I did try for about 5 hours to work out how to
--- use shake rules rather than IO but eventually gave up.
-
--- | Computes a mapping from a filepath to its latest modification date.
--- See Note [Multi Cradle Dependency Info] why we do this ourselves instead
--- of letting shake take care of it.
-getDependencyInfo :: [FilePath] -> IO DependencyInfo
-getDependencyInfo fs = Map.fromList <$> mapM do_one fs
-
-  where
-    tryIO :: IO a -> IO (Either IOException a)
-    tryIO = try
-
-    do_one :: FilePath -> IO (FilePath, Maybe UTCTime)
-    do_one fp = (fp,) . eitherToMaybe <$> tryIO (getModificationTime fp)
-
--- | This function removes all the -package flags which refer to packages we
--- are going to deal with ourselves. For example, if a executable depends
--- on a library component, then this function will remove the library flag
--- from the package flags for the executable
---
--- There are several places in GHC (for example the call to hptInstances in
--- tcRnImports) which assume that all modules in the HPT have the same unit
--- ID. Therefore we create a fake one and give them all the same unit id.
-removeInplacePackages :: [InstalledUnitId] -> DynFlags -> (DynFlags, [InstalledUnitId])
-removeInplacePackages us df = (df { packageFlags = ps
-                                  , thisInstalledUnitId = fake_uid }, uids)
-  where
-    (uids, ps) = partitionEithers (map go (packageFlags df))
-    fake_uid = toInstalledUnitId (stringToUnitId "fake_uid")
-    go p@(ExposePackage _ (UnitIdArg u) _) = if toInstalledUnitId u `elem` us
-                                                  then Left (toInstalledUnitId u)
-                                                  else Right p
-    go p = Right p
-
--- | Memoize an IO function, with the characteristics:
---
---   * If multiple people ask for a result simultaneously, make sure you only compute it once.
---
---   * If there are exceptions, repeatedly reraise them.
---
---   * If the caller is aborted (async exception) finish computing it anyway.
-memoIO :: Ord a => (a -> IO b) -> IO (a -> IO b)
-memoIO op = do
-    ref <- newVar Map.empty
-    return $ \k -> join $ mask_ $ modifyVar ref $ \mp ->
-        case Map.lookup k mp of
-            Nothing -> do
-                res <- onceFork $ op k
-                return (Map.insert k res mp, res)
-            Just res -> return (mp, res)
-
--- | Throws if package flags are unsatisfiable
-setOptions :: GhcMonad m => ComponentOptions -> DynFlags -> m (DynFlags, [GHC.Target])
-setOptions (ComponentOptions theOpts compRoot _) dflags = do
-    (dflags', targets') <- addCmdOpts theOpts dflags
-    let targets = makeTargetsAbsolute compRoot targets'
-    let dflags'' =
-          disableWarningsAsErrors $
-          -- disabled, generated directly by ghcide instead
-          flip gopt_unset Opt_WriteInterface $
-          -- disabled, generated directly by ghcide instead
-          -- also, it can confuse the interface stale check
-          dontWriteHieFiles $
-          setIgnoreInterfacePragmas $
-          setLinkerOptions $
-          disableOptimisation $
-          setUpTypedHoles $
-          makeDynFlagsAbsolute compRoot dflags'
-    -- initPackages parses the -package flags and
-    -- sets up the visibility for each component.
-    -- Throws if a -package flag cannot be satisfied.
-    (final_df, _) <- liftIO $ wrapPackageSetupException $ initPackages dflags''
-    return (final_df, targets)
-
-
--- we don't want to generate object code so we compile to bytecode
--- (HscInterpreted) which implies LinkInMemory
--- HscInterpreted
-setLinkerOptions :: DynFlags -> DynFlags
-setLinkerOptions df = df {
-    ghcLink   = LinkInMemory
-  , hscTarget = HscNothing
-  , ghcMode = CompManager
-  }
-
-setIgnoreInterfacePragmas :: DynFlags -> DynFlags
-setIgnoreInterfacePragmas df =
-    gopt_set (gopt_set df Opt_IgnoreInterfacePragmas) Opt_IgnoreOptimChanges
-
-disableOptimisation :: DynFlags -> DynFlags
-disableOptimisation df = updOptLevel 0 df
-
-setHiDir :: FilePath -> DynFlags -> DynFlags
-setHiDir f d =
-    -- override user settings to avoid conflicts leading to recompilation
-    d { hiDir      = Just f}
-
-setODir :: FilePath -> DynFlags -> DynFlags
-setODir f d =
-    -- override user settings to avoid conflicts leading to recompilation
-    d { objectDir = Just f}
-
-getCacheDirsDefault :: String -> [String] -> IO CacheDirs
-getCacheDirsDefault prefix opts = do
-    dir <- Just <$> getXdgDirectory XdgCache (cacheDir </> prefix ++ "-" ++ opts_hash)
-    return $ CacheDirs dir dir dir
-    where
-        -- Create a unique folder per set of different GHC options, assuming that each different set of
-        -- GHC options will create incompatible interface files.
-        opts_hash = B.unpack $ B16.encode $ H.finalize $ H.updates H.init (map B.pack opts)
-
--- | Sub directory for the cache path
-cacheDir :: String
-cacheDir = "ghcide"
-
-notifyUserImplicitCradle:: FilePath -> ShowMessageParams
-notifyUserImplicitCradle fp =ShowMessageParams MtWarning $
-  "No [cradle](https://github.com/mpickering/hie-bios#hie-bios) found for "
-  <> T.pack fp <>
-  ".\n Proceeding with [implicit cradle](https://hackage.haskell.org/package/implicit-hie).\n"<>
-  "You should ignore this message, unless you see a 'Multi Cradle: No prefixes matched' error."
-----------------------------------------------------------------------------------------------------
-
-data PackageSetupException
-    = PackageSetupException
-        { message     :: !String
-        }
-    | GhcVersionMismatch
-        { compileTime :: !Version
-        , runTime     :: !Version
-        }
-    | PackageCheckFailed !NotCompatibleReason
-    deriving (Eq, Show, Typeable)
-
-instance Exception PackageSetupException
-
--- | Wrap any exception as a 'PackageSetupException'
-wrapPackageSetupException :: IO a -> IO a
-wrapPackageSetupException = handleAny $ \case
-  e | Just (pkgE :: PackageSetupException) <- fromException e -> throwIO pkgE
-  e -> (throwIO . PackageSetupException . show) e
-
-showPackageSetupException :: PackageSetupException -> String
-showPackageSetupException GhcVersionMismatch{..} = unwords
-    ["ghcide compiled against GHC"
-    ,showVersion compileTime
-    ,"but currently using"
-    ,showVersion runTime
-    ,"\nThis is unsupported, ghcide must be compiled with the same GHC version as the project."
-    ]
-showPackageSetupException PackageSetupException{..} = unwords
-    [ "ghcide compiled by GHC", showVersion compilerVersion
-    , "failed to load packages:", message <> "."
-    , "\nPlease ensure that ghcide is compiled with the same GHC installation as the project."]
-showPackageSetupException (PackageCheckFailed PackageVersionMismatch{..}) = unwords
-    ["ghcide compiled with package "
-    , packageName <> "-" <> showVersion compileTime
-    ,"but project uses package"
-    , packageName <> "-" <> showVersion runTime
-    ,"\nThis is unsupported, ghcide must be compiled with the same GHC installation as the project."
-    ]
-showPackageSetupException (PackageCheckFailed BasePackageAbiMismatch{..}) = unwords
-    ["ghcide compiled with base-" <> showVersion compileTime <> "-" <> compileTimeAbi
-    ,"but project uses base-" <> showVersion compileTime <> "-" <> runTimeAbi
-    ,"\nThis is unsupported, ghcide must be compiled with the same GHC installation as the project."
-    ]
-
-renderPackageSetupException :: FilePath -> PackageSetupException -> (NormalizedFilePath, ShowDiagnostic, Diagnostic)
-renderPackageSetupException fp e =
-    ideErrorWithSource (Just "cradle") (Just DsError) (toNormalizedFilePath' fp) (T.pack $ showPackageSetupException e)
+{-# LANGUAGE CPP          #-}+{-# LANGUAGE TypeFamilies #-}+#include "ghc-api-version.h"++{-|+The logic for setting up a ghcide session by tapping into hie-bios.+-}+module Development.IDE.Session+  (SessionLoadingOptions(..)+  ,CacheDirs(..)+  ,loadSession+  ,loadSessionWithOptions+  ,setInitialDynFlags+  ,getHieDbLoc+  ,runWithDb+  ) where++-- Unfortunately, we cannot use loadSession with ghc-lib since hie-bios uses+-- the real GHC library and the types are incompatible. Furthermore, when+-- building with ghc-lib we need to make this Haskell agnostic, so no hie-bios!++import           Control.Concurrent.Async+import           Control.Concurrent.Strict+import           Control.Exception.Safe+import           Control.Monad+import           Control.Monad.Extra+import           Control.Monad.IO.Class+import qualified Crypto.Hash.SHA1                     as H+import           Data.Aeson+import           Data.Bifunctor+import qualified Data.ByteString.Base16               as B16+import qualified Data.ByteString.Char8                as B+import           Data.Default+import           Data.Either.Extra+import           Data.Function+import qualified Data.HashMap.Strict                  as HM+import           Data.Hashable+import           Data.IORef+import           Data.List+import qualified Data.Map.Strict                      as Map+import           Data.Maybe+import qualified Data.Text                            as T+import           Data.Time.Clock+import           Data.Version+import           Development.IDE.Core.RuleTypes+import           Development.IDE.Core.Shake+import           Development.IDE.GHC.Compat           hiding (Target,+                                                       TargetFile, TargetModule)+import qualified Development.IDE.GHC.Compat           as GHC+import           Development.IDE.GHC.Util+import           Development.IDE.Session.VersionCheck+import           Development.IDE.Types.Diagnostics+import           Development.IDE.Types.Exports+import           Development.IDE.Types.HscEnvEq       (HscEnvEq, newHscEnvEq,+                                                       newHscEnvEqPreserveImportPaths)+import           Development.IDE.Types.Location+import           Development.IDE.Types.Logger+import           Development.IDE.Types.Options+import           Development.Shake                    (Action)+import           GHC.Check+import qualified HIE.Bios                             as HieBios+import           HIE.Bios.Environment                 hiding (getCacheDir)+import           HIE.Bios.Types+import           Hie.Implicit.Cradle                  (loadImplicitHieCradle)+import           Language.LSP.Server+import           Language.LSP.Types+import           System.Directory+import qualified System.Directory.Extra               as IO+import           System.FilePath+import           System.IO+import           System.Info++import           Control.Applicative                  (Alternative ((<|>)))+import           Control.Exception                    (evaluate)+import           Data.Void+import           GHCi+import           HscTypes                             (hsc_IC, hsc_NC,+                                                       hsc_dflags, ic_dflags)+import           Linker+import           Module+import           NameCache+import           Packages++import           Control.Concurrent.STM               (atomically)+import           Control.Concurrent.STM.TQueue+import           Database.SQLite.Simple+import           HIE.Bios.Cradle                      (yamlConfig)+import           HieDb.Create+import           HieDb.Types+import           HieDb.Utils+import           Maybes                               (MaybeT (runMaybeT))++-- | Bump this version number when making changes to the format of the data stored in hiedb+hiedbDataVersion :: String+hiedbDataVersion = "1"++data CacheDirs = CacheDirs+  { hiCacheDir, hieCacheDir, oCacheDir :: Maybe FilePath}++data SessionLoadingOptions = SessionLoadingOptions+  { findCradle          :: FilePath -> IO (Maybe FilePath)+  , loadCradle          :: FilePath -> IO (HieBios.Cradle Void)+  -- | Given the project name and a set of command line flags,+  --   return the path for storing generated GHC artifacts,+  --   or 'Nothing' to respect the cradle setting+  , getCacheDirs        :: String -> [String] -> IO CacheDirs+  -- | Return the GHC lib dir to use for the 'unsafeGlobalDynFlags'+  , getInitialGhcLibDir :: IO (Maybe LibDir)+  , fakeUid             :: InstalledUnitId+    -- ^ unit id used to tag the internal component built by ghcide+    --   To reuse external interface files the unit ids must match,+    --   thus make sure to build them with `--this-unit-id` set to the+    --   same value as the ghcide fake uid+  }++instance Default SessionLoadingOptions where+    def = SessionLoadingOptions+        {findCradle = HieBios.findCradle+        ,loadCradle = HieBios.loadCradle+        ,getCacheDirs = getCacheDirsDefault+        ,getInitialGhcLibDir = getInitialGhcLibDirDefault+        ,fakeUid = toInstalledUnitId (stringToUnitId "main")+        }++getInitialGhcLibDirDefault :: IO (Maybe LibDir)+getInitialGhcLibDirDefault = do+  dir <- IO.getCurrentDirectory+  hieYaml <- runMaybeT $ yamlConfig dir+  cradle <- maybe (loadImplicitHieCradle $ addTrailingPathSeparator dir) HieBios.loadCradle hieYaml+  hPutStrLn stderr $ "setInitialDynFlags cradle: " ++ show cradle+  libDirRes <- getRuntimeGhcLibDir cradle+  case libDirRes of+      CradleSuccess libdir -> pure $ Just $ LibDir libdir+      CradleFail err -> do+        hPutStrLn stderr $ "Couldn't load cradle for libdir: " ++ show (err,dir,hieYaml,cradle)+        pure Nothing+      CradleNone -> do+        hPutStrLn stderr "Couldn't load cradle (CradleNone)"+        pure Nothing++-- | Sets `unsafeGlobalDynFlags` on using the hie-bios cradle and returns the GHC libdir+setInitialDynFlags :: SessionLoadingOptions -> IO (Maybe LibDir)+setInitialDynFlags SessionLoadingOptions{..} = do+  libdir <- getInitialGhcLibDir+  dynFlags <- mapM dynFlagsForPrinting libdir+  mapM_ setUnsafeGlobalDynFlags dynFlags+  pure libdir++-- | Wraps `withHieDb` to provide a database connection for reading, and a `HieWriterChan` for+-- writing. Actions are picked off one by one from the `HieWriterChan` and executed in serial+-- by a worker thread using a dedicated database connection.+-- This is done in order to serialize writes to the database, or else SQLite becomes unhappy+runWithDb :: FilePath -> (HieDb -> IndexQueue -> IO ()) -> IO ()+runWithDb fp k = do+  -- Delete the database if it has an incompatible schema version+  withHieDb fp (const $ pure ())+    `catch` \IncompatibleSchemaVersion{} -> removeFile fp+  withHieDb fp $ \writedb -> do+    initConn writedb+    chan <- newTQueueIO+    withAsync (writerThread writedb chan) $ \_ -> do+      withHieDb fp (flip k chan)+  where+    writerThread db chan = do+      -- Clear the index of any files that might have been deleted since the last run+      deleteMissingRealFiles db+      _ <- garbageCollectTypeNames db+      forever $ do+        k <- atomically $ readTQueue chan+        k db+          `catch` \e@SQLError{} -> do+            hPutStrLn stderr $ "SQLite error in worker, ignoring: " ++ show e+          `catchAny` \e -> do+            hPutStrLn stderr $ "Uncaught error in database worker, ignoring: " ++ show e+++getHieDbLoc :: FilePath -> IO FilePath+getHieDbLoc dir = do+  let db = intercalate "-" [dirHash, takeBaseName dir, VERSION_ghc, hiedbDataVersion] <.> "hiedb"+      dirHash = B.unpack $ B16.encode $ H.hash $ B.pack dir+  cDir <- IO.getXdgDirectory IO.XdgCache cacheDir+  createDirectoryIfMissing True cDir+  pure (cDir </> db)++-- | Given a root directory, return a Shake 'Action' which setups an+-- 'IdeGhcSession' given a file.+-- Some of the many things this does:+--+-- * Find the cradle for the file+-- * Get the session options,+-- * Get the GHC lib directory+-- * Make sure the GHC compiletime and runtime versions match+-- * Restart the Shake session+--+-- This is the key function which implements multi-component support. All+-- components mapping to the same hie.yaml file are mapped to the same+-- HscEnv which is updated as new components are discovered.+loadSession :: FilePath -> IO (Action IdeGhcSession)+loadSession = loadSessionWithOptions def++loadSessionWithOptions :: SessionLoadingOptions -> FilePath -> IO (Action IdeGhcSession)+loadSessionWithOptions SessionLoadingOptions{..} dir = do+  -- Mapping from hie.yaml file to HscEnv, one per hie.yaml file+  hscEnvs <- newVar Map.empty :: IO (Var HieMap)+  -- Mapping from a Filepath to HscEnv+  fileToFlags <- newVar Map.empty :: IO (Var FlagsMap)+  -- Mapping from a Filepath to its 'hie.yaml' location.+  -- Should hold the same Filepaths as 'fileToFlags', otherwise+  -- they are inconsistent. So, everywhere you modify 'fileToFlags',+  -- you have to modify 'filesMap' as well.+  filesMap <- newVar HM.empty :: IO (Var FilesMap)+  -- Version of the mappings above+  version <- newVar 0+  let returnWithVersion fun = IdeGhcSession fun <$> liftIO (readVar version)+  let invalidateShakeCache = do+        void $ modifyVar' version succ+  -- This caches the mapping from Mod.hs -> hie.yaml+  cradleLoc <- liftIO $ memoIO $ \v -> do+      res <- findCradle v+      -- Sometimes we get C:, sometimes we get c:, and sometimes we get a relative path+      -- try and normalise that+      -- e.g. see https://github.com/haskell/ghcide/issues/126+      res' <- traverse makeAbsolute res+      return $ normalise <$> res'++  dummyAs <- async $ return (error "Uninitialised")+  runningCradle <- newVar dummyAs :: IO (Var (Async (IdeResult HscEnvEq,[FilePath])))++  return $ do+    extras@ShakeExtras{logger, restartShakeSession, ideNc, knownTargetsVar, lspEnv+                      } <- getShakeExtras++    IdeOptions{ optTesting = IdeTesting optTesting+              , optCheckProject = getCheckProject+              , optCustomDynFlags+              , optExtensions+              } <- getIdeOptions++        -- populate the knownTargetsVar with all the+        -- files in the project so that `knownFiles` can learn about them and+        -- we can generate a complete module graph+    let extendKnownTargets newTargets = do+          knownTargets <- forM newTargets $ \TargetDetails{..} ->+            case targetTarget of+              TargetFile f -> pure (targetTarget, [f])+              TargetModule _ -> do+                found <- filterM (IO.doesFileExist . fromNormalizedFilePath) targetLocations+                return (targetTarget, found)+          modifyVarIO' knownTargetsVar $ traverseHashed $ \known -> do+            let known' = HM.unionWith (<>) known $ HM.fromList knownTargets+            when (known /= known') $+                logDebug logger $ "Known files updated: " <>+                    T.pack(show $ (HM.map . map) fromNormalizedFilePath known')+            pure known'++    -- Create a new HscEnv from a hieYaml root and a set of options+    -- If the hieYaml file already has an HscEnv, the new component is+    -- combined with the components in the old HscEnv into a new HscEnv+    -- which contains the union.+    let packageSetup :: (Maybe FilePath, NormalizedFilePath, ComponentOptions, FilePath)+                     -> IO (HscEnv, ComponentInfo, [ComponentInfo])+        packageSetup (hieYaml, cfp, opts, libDir) = do+          -- Parse DynFlags for the newly discovered component+          hscEnv <- emptyHscEnv ideNc libDir+          (df, targets) <- evalGhcEnv hscEnv $+              first optCustomDynFlags <$> setOptions opts (hsc_dflags hscEnv)+          let deps = componentDependencies opts ++ maybeToList hieYaml+          dep_info <- getDependencyInfo deps+          -- Now lookup to see whether we are combining with an existing HscEnv+          -- or making a new one. The lookup returns the HscEnv and a list of+          -- information about other components loaded into the HscEnv+          -- (unitId, DynFlag, Targets)+          modifyVar hscEnvs $ \m -> do+              -- Just deps if there's already an HscEnv+              -- Nothing is it's the first time we are making an HscEnv+              let oldDeps = Map.lookup hieYaml m+              let -- Add the raw information about this component to the list+                  -- We will modify the unitId and DynFlags used for+                  -- compilation but these are the true source of+                  -- information.+                  new_deps = RawComponentInfo (thisInstalledUnitId df) df targets cfp opts dep_info+                                : maybe [] snd oldDeps+                  -- Get all the unit-ids for things in this component+                  inplace = map rawComponentUnitId new_deps++              new_deps' <- forM new_deps $ \RawComponentInfo{..} -> do+                  -- Remove all inplace dependencies from package flags for+                  -- components in this HscEnv+                  let (df2, uids) = removeInplacePackages fakeUid inplace rawComponentDynFlags+                  let prefix = show rawComponentUnitId+                  -- See Note [Avoiding bad interface files]+                  let hscComponents = sort $ map show uids+                      cacheDirOpts = hscComponents ++ componentOptions opts+                  cacheDirs <- liftIO $ getCacheDirs prefix cacheDirOpts+                  processed_df <- setCacheDirs logger cacheDirs df2+                  -- The final component information, mostly the same but the DynFlags don't+                  -- contain any packages which are also loaded+                  -- into the same component.+                  pure $ ComponentInfo rawComponentUnitId+                                       processed_df+                                       uids+                                       rawComponentTargets+                                       rawComponentFP+                                       rawComponentCOptions+                                       rawComponentDependencyInfo+              -- Make a new HscEnv, we have to recompile everything from+              -- scratch again (for now)+              -- It's important to keep the same NameCache though for reasons+              -- that I do not fully understand+              logInfo logger (T.pack ("Making new HscEnv" ++ show inplace))+              hscEnv <- emptyHscEnv ideNc libDir+              newHscEnv <-+                -- Add the options for the current component to the HscEnv+                evalGhcEnv hscEnv $ do+                  _ <- setSessionDynFlags df+                  getSession++              -- Modify the map so the hieYaml now maps to the newly created+              -- HscEnv+              -- Returns+              -- . the new HscEnv so it can be used to modify the+              --   FilePath -> HscEnv map (fileToFlags)+              -- . The information for the new component which caused this cache miss+              -- . The modified information (without -inplace flags) for+              --   existing packages+              pure (Map.insert hieYaml (newHscEnv, new_deps) m, (newHscEnv, head new_deps', tail new_deps'))+++    let session :: (Maybe FilePath, NormalizedFilePath, ComponentOptions, FilePath)+                -> IO (IdeResult HscEnvEq,[FilePath])+        session args@(hieYaml, _cfp, _opts, _libDir) = do+          (hscEnv, new, old_deps) <- packageSetup args++          -- Whenever we spin up a session on Linux, dynamically load libm.so.6+          -- in. We need this in case the binary is statically linked, in which+          -- case the interactive session will fail when trying to load+          -- ghc-prim, which happens whenever Template Haskell is being+          -- evaluated or haskell-language-server's eval plugin tries to run+          -- some code. If the binary is dynamically linked, then this will have+          -- no effect.+          -- See https://github.com/haskell/haskell-language-server/issues/221+          when (os == "linux") $ do+            initObjLinker hscEnv+            res <- loadDLL hscEnv "libm.so.6"+            case res of+              Nothing -> pure ()+              Just err -> hPutStrLn stderr $+                "Error dynamically loading libm.so.6:\n" <> err++          -- Make a map from unit-id to DynFlags, this is used when trying to+          -- resolve imports. (especially PackageImports)+          let uids = map (\ci -> (componentUnitId ci, componentDynFlags ci)) (new : old_deps)++          -- For each component, now make a new HscEnvEq which contains the+          -- HscEnv for the hie.yaml file but the DynFlags for that component++          -- New HscEnv for the component in question, returns the new HscEnvEq and+          -- a mapping from FilePath to the newly created HscEnvEq.+          let new_cache = newComponentCache logger optExtensions hieYaml _cfp hscEnv uids+          (cs, res) <- new_cache new+          -- Modified cache targets for everything else in the hie.yaml file+          -- which now uses the same EPS and so on+          cached_targets <- concatMapM (fmap fst . new_cache) old_deps++          let all_targets = cs ++ cached_targets++          void $ modifyVar' fileToFlags $+              Map.insert hieYaml (HM.fromList (concatMap toFlagsMap all_targets))+          void $ modifyVar' filesMap $+              flip HM.union (HM.fromList (zip (map fst $ concatMap toFlagsMap all_targets) (repeat hieYaml)))++          void $ extendKnownTargets all_targets++          -- Invalidate all the existing GhcSession build nodes by restarting the Shake session+          invalidateShakeCache+          restartShakeSession []++          -- Typecheck all files in the project on startup+          checkProject <- getCheckProject+          unless (null cs || not checkProject) $ do+                cfps' <- liftIO $ filterM (IO.doesFileExist . fromNormalizedFilePath) (concatMap targetLocations cs)+                void $ shakeEnqueue extras $ mkDelayedAction "InitialLoad" Debug $ void $ do+                    mmt <- uses GetModificationTime cfps'+                    let cs_exist = catMaybes (zipWith (<$) cfps' mmt)+                    modIfaces <- uses GetModIface cs_exist+                    -- update exports map+                    extras <- getShakeExtras+                    let !exportsMap' = createExportsMap $ mapMaybe (fmap hirModIface) modIfaces+                    liftIO $ modifyVar_ (exportsMap extras) $ evaluate . (exportsMap' <>)++          return (second Map.keys res)++    let consultCradle :: Maybe FilePath -> FilePath -> IO (IdeResult HscEnvEq, [FilePath])+        consultCradle hieYaml cfp = do+           lfp <- flip makeRelative cfp <$> getCurrentDirectory+           logInfo logger $ T.pack ("Consulting the cradle for " <> show lfp)++           when (isNothing hieYaml) $+             logWarning logger $ implicitCradleWarning lfp++           cradle <- maybe (loadImplicitHieCradle $ addTrailingPathSeparator dir) loadCradle hieYaml++           when optTesting $ mRunLspT lspEnv $+            sendNotification (SCustomMethod "ghcide/cradle/loaded") (toJSON cfp)++           -- Display a user friendly progress message here: They probably don't know what a cradle is+           let progMsg = "Setting up " <> T.pack (takeBaseName (cradleRootDir cradle))+                         <> " (for " <> T.pack lfp <> ")"+           eopts <- mRunLspTCallback lspEnv (withIndefiniteProgress progMsg NotCancellable) $+              cradleToOptsAndLibDir cradle cfp++           logDebug logger $ T.pack ("Session loading result: " <> show eopts)+           case eopts of+             -- The cradle gave us some options so get to work turning them+             -- into and HscEnv.+             Right (opts, libDir) -> do+               installationCheck <- ghcVersionChecker libDir+               case installationCheck of+                 InstallationNotFound{..} ->+                     error $ "GHC installation not found in libdir: " <> libdir+                 InstallationMismatch{..} ->+                     return (([renderPackageSetupException cfp GhcVersionMismatch{..}], Nothing),[])+                 InstallationChecked _compileTime _ghcLibCheck ->+                   session (hieYaml, toNormalizedFilePath' cfp, opts, libDir)+             -- Failure case, either a cradle error or the none cradle+             Left err -> do+               dep_info <- getDependencyInfo (maybeToList hieYaml)+               let ncfp = toNormalizedFilePath' cfp+               let res = (map (renderCradleError ncfp) err, Nothing)+               void $ modifyVar' fileToFlags $+                    Map.insertWith HM.union hieYaml (HM.singleton ncfp (res, dep_info))+               void $ modifyVar' filesMap $ HM.insert ncfp hieYaml+               return (res, maybe [] pure hieYaml ++ concatMap cradleErrorDependencies err)++    -- This caches the mapping from hie.yaml + Mod.hs -> [String]+    -- Returns the Ghc session and the cradle dependencies+    let sessionOpts :: (Maybe FilePath, FilePath)+                    -> IO (IdeResult HscEnvEq, [FilePath])+        sessionOpts (hieYaml, file) = do+          v <- fromMaybe HM.empty . Map.lookup hieYaml <$> readVar fileToFlags+          cfp <- canonicalizePath file+          case HM.lookup (toNormalizedFilePath' cfp) v of+            Just (opts, old_di) -> do+              deps_ok <- checkDependencyInfo old_di+              if not deps_ok+                then do+                  -- If the dependencies are out of date then clear both caches and start+                  -- again.+                  modifyVar_ fileToFlags (const (return Map.empty))+                  -- Keep the same name cache+                  modifyVar_ hscEnvs (return . Map.adjust (\(h, _) -> (h, [])) hieYaml )+                  consultCradle hieYaml cfp+                else return (opts, Map.keys old_di)+            Nothing -> consultCradle hieYaml cfp++    -- The main function which gets options for a file. We only want one of these running+    -- at a time. Therefore the IORef contains the currently running cradle, if we try+    -- to get some more options then we wait for the currently running action to finish+    -- before attempting to do so.+    let getOptions :: FilePath -> IO (IdeResult HscEnvEq, [FilePath])+        getOptions file = do+            ncfp <- toNormalizedFilePath' <$> canonicalizePath file+            cachedHieYamlLocation <- HM.lookup ncfp <$> readVar filesMap+            hieYaml <- cradleLoc file+            sessionOpts (join cachedHieYamlLocation <|> hieYaml, file) `catch` \e ->+                return (([renderPackageSetupException file e], Nothing), maybe [] pure hieYaml)++    returnWithVersion $ \file -> do+      opts <- liftIO $ join $ mask_ $ modifyVar runningCradle $ \as -> do+        -- If the cradle is not finished, then wait for it to finish.+        void $ wait as+        as <- async $ getOptions file+        return (as, wait as)+      pure opts++-- | Run the specific cradle on a specific FilePath via hie-bios.+-- This then builds dependencies or whatever based on the cradle, gets the+-- GHC options/dynflags needed for the session and the GHC library directory++cradleToOptsAndLibDir :: Show a => Cradle a -> FilePath+                      -> IO (Either [CradleError] (ComponentOptions, FilePath))+cradleToOptsAndLibDir cradle file = do+    -- Start off by getting the session options+    let showLine s = hPutStrLn stderr ("> " ++ s)+    hPutStrLn stderr $ "Output from setting up the cradle " <> show cradle+    cradleRes <- runCradle (cradleOptsProg cradle) showLine file+    case cradleRes of+        CradleSuccess r -> do+            -- Now get the GHC lib dir+            libDirRes <- getRuntimeGhcLibDir cradle+            case libDirRes of+                -- This is the successful path+                CradleSuccess libDir -> pure (Right (r, libDir))+                CradleFail err       -> return (Left [err])+                -- For the None cradle perhaps we still want to report an Info+                -- message about the fact that the file is being ignored.+                CradleNone           -> return (Left [])++        CradleFail err -> return (Left [err])+        -- Same here+        CradleNone -> return (Left [])++emptyHscEnv :: IORef NameCache -> FilePath -> IO HscEnv+emptyHscEnv nc libDir = do+    env <- runGhc (Just libDir) getSession+    initDynLinker env+    pure $ setNameCache nc env{ hsc_dflags = (hsc_dflags env){useUnicode = True } }++data TargetDetails = TargetDetails+  {+      targetTarget    :: !Target,+      targetEnv       :: !(IdeResult HscEnvEq),+      targetDepends   :: !DependencyInfo,+      targetLocations :: ![NormalizedFilePath]+  }++fromTargetId :: [FilePath]          -- ^ import paths+             -> [String]            -- ^ extensions to consider+             -> TargetId+             -> IdeResult HscEnvEq+             -> DependencyInfo+             -> IO [TargetDetails]+-- For a target module we consider all the import paths+fromTargetId is exts (GHC.TargetModule mod) env dep = do+    let fps = [i </> moduleNameSlashes mod -<.> ext <> boot+              | ext <- exts+              , i <- is+              , boot <- ["", "-boot"]+              ]+    locs <- mapM (fmap toNormalizedFilePath' . canonicalizePath) fps+    return [TargetDetails (TargetModule mod) env dep locs]+-- For a 'TargetFile' we consider all the possible module names+fromTargetId _ _ (GHC.TargetFile f _) env deps = do+    nf <- toNormalizedFilePath' <$> canonicalizePath f+    return [TargetDetails (TargetFile nf) env deps [nf]]++toFlagsMap :: TargetDetails -> [(NormalizedFilePath, (IdeResult HscEnvEq, DependencyInfo))]+toFlagsMap TargetDetails{..} =+    [ (l, (targetEnv, targetDepends)) | l <-  targetLocations]+++setNameCache :: IORef NameCache -> HscEnv -> HscEnv+setNameCache nc hsc = hsc { hsc_NC = nc }++-- | Create a mapping from FilePaths to HscEnvEqs+newComponentCache+         :: Logger+         -> [String]       -- File extensions to consider+         -> Maybe FilePath -- Path to cradle+         -> NormalizedFilePath -- Path to file that caused the creation of this component+         -> HscEnv+         -> [(InstalledUnitId, DynFlags)]+         -> ComponentInfo+         -> IO ( [TargetDetails], (IdeResult HscEnvEq, DependencyInfo))+newComponentCache logger exts cradlePath cfp hsc_env uids ci = do+    let df = componentDynFlags ci+    let hscEnv' = hsc_env { hsc_dflags = df+                          , hsc_IC = (hsc_IC hsc_env) { ic_dflags = df } }++    let newFunc = maybe newHscEnvEqPreserveImportPaths newHscEnvEq cradlePath+    henv <- newFunc hscEnv' uids+    let targetEnv = ([], Just henv)+        targetDepends = componentDependencyInfo ci+        res = (targetEnv, targetDepends)+    logDebug logger ("New Component Cache HscEnvEq: " <> T.pack (show res))++    let mk t = fromTargetId (importPaths df) exts (targetId t) targetEnv targetDepends+    ctargets <- concatMapM mk (componentTargets ci)++    -- A special target for the file which caused this wonderful+    -- component to be created. In case the cradle doesn't list all the targets for+    -- the component, in which case things will be horribly broken anyway.+    -- Otherwise, we will immediately attempt to reload this module which+    -- causes an infinite loop and high CPU usage.+    let special_target = TargetDetails (TargetFile cfp) targetEnv targetDepends [componentFP ci]+    return (special_target:ctargets, res)++{- Note [Avoiding bad interface files]+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+Originally, we set the cache directory for the various components once+on the first occurrence of the component.+This works fine if these components have no references to each other,+but you have components that depend on each other, the interface files are+updated for each component.+After restarting the session and only opening the component that depended+on the other, suddenly the interface files of this component are stale.+However, from the point of view of `ghcide`, they do not look stale,+thus, not regenerated and the IDE shows weird errors such as:+```+typecheckIface+Declaration for Rep_ClientRunFlags+Axiom branches Rep_ClientRunFlags:+  Failed to load interface for ‘Distribution.Simple.Flag’+  Use -v to see a list of the files searched for.+```+and+```+expectJust checkFamInstConsistency+CallStack (from HasCallStack):+  error, called at compiler\\utils\\Maybes.hs:55:27 in ghc:Maybes+  expectJust, called at compiler\\typecheck\\FamInst.hs:461:30 in ghc:FamInst+```++To mitigate this, we set the cache directory for each component dependent+on the components of the current `HscEnv`, additionally to the component options+of the respective components.+Assume two components, c1, c2, where c2 depends on c1, and the options of the+respective components are co1, co2.+If we want to load component c2, followed by c1, we set the cache directory for+each component in this way:++  * Load component c2+    * (Cache Directory State)+        - name of c2 + co2+  * Load component c1+    * (Cache Directory State)+        - name of c2 + name of c1 + co2+        - name of c2 + name of c1 + co1++Overall, we created three cache directories. If we opened c1 first, then we+create a fourth cache directory.+This makes sure that interface files are always correctly updated.++Since this causes a lot of recompilation, we only update the cache-directory,+if the dependencies of a component have really changed.+E.g. when you load two executables, they can not depend on each other. They+should be filtered out, such that we dont have to re-compile everything.+-}++-- | Set the cache-directory based on the ComponentOptions and a list of+-- internal packages.+-- For the exact reason, see Note [Avoiding bad interface files].+setCacheDirs :: MonadIO m => Logger -> CacheDirs -> DynFlags -> m DynFlags+setCacheDirs logger CacheDirs{..} dflags = do+    liftIO $ logInfo logger $ "Using interface files cache dir: " <> T.pack (fromMaybe cacheDir hiCacheDir)+    pure $ dflags+          & maybe id setHiDir hiCacheDir+          & maybe id setHieDir hieCacheDir+          & maybe id setODir oCacheDir+++renderCradleError :: NormalizedFilePath -> CradleError -> FileDiagnostic+renderCradleError nfp (CradleError _ _ec t) =+  ideErrorWithSource (Just "cradle") (Just DsError) nfp (T.unlines (map T.pack t))++-- See Note [Multi Cradle Dependency Info]+type DependencyInfo = Map.Map FilePath (Maybe UTCTime)+type HieMap = Map.Map (Maybe FilePath) (HscEnv, [RawComponentInfo])+-- | Maps a "hie.yaml" location to all its Target Filepaths and options.+type FlagsMap = Map.Map (Maybe FilePath) (HM.HashMap NormalizedFilePath (IdeResult HscEnvEq, DependencyInfo))+-- | Maps a Filepath to its respective "hie.yaml" location.+-- It aims to be the reverse of 'FlagsMap'.+type FilesMap = HM.HashMap NormalizedFilePath (Maybe FilePath)++-- This is pristine information about a component+data RawComponentInfo = RawComponentInfo+  { rawComponentUnitId         :: InstalledUnitId+  -- | Unprocessed DynFlags. Contains inplace packages such as libraries.+  -- We do not want to use them unprocessed.+  , rawComponentDynFlags       :: DynFlags+  -- | All targets of this components.+  , rawComponentTargets        :: [GHC.Target]+  -- | Filepath which caused the creation of this component+  , rawComponentFP             :: NormalizedFilePath+  -- | Component Options used to load the component.+  , rawComponentCOptions       :: ComponentOptions+  -- | Maps cradle dependencies, such as `stack.yaml`, or `.cabal` file+  -- to last modification time. See Note [Multi Cradle Dependency Info].+  , rawComponentDependencyInfo :: DependencyInfo+  }++-- This is processed information about the component, in particular the dynflags will be modified.+data ComponentInfo = ComponentInfo+  { componentUnitId         :: InstalledUnitId+  -- | Processed DynFlags. Does not contain inplace packages such as local+  -- libraries. Can be used to actually load this Component.+  , componentDynFlags       :: DynFlags+  -- | Internal units, such as local libraries, that this component+  -- is loaded with. These have been extracted from the original+  -- ComponentOptions.+  , _componentInternalUnits :: [InstalledUnitId]+  -- | All targets of this components.+  , componentTargets        :: [GHC.Target]+  -- | Filepath which caused the creation of this component+  , componentFP             :: NormalizedFilePath+  -- | Component Options used to load the component.+  , _componentCOptions      :: ComponentOptions+  -- | Maps cradle dependencies, such as `stack.yaml`, or `.cabal` file+  -- to last modification time. See Note [Multi Cradle Dependency Info]+  , componentDependencyInfo :: DependencyInfo+  }++-- | Check if any dependency has been modified lately.+checkDependencyInfo :: DependencyInfo -> IO Bool+checkDependencyInfo old_di = do+  di <- getDependencyInfo (Map.keys old_di)+  return (di == old_di)++-- Note [Multi Cradle Dependency Info]+-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+-- Why do we implement our own file modification tracking here?+-- The primary reason is that the custom caching logic is quite complicated and going into shake+-- adds even more complexity and more indirection. I did try for about 5 hours to work out how to+-- use shake rules rather than IO but eventually gave up.++-- | Computes a mapping from a filepath to its latest modification date.+-- See Note [Multi Cradle Dependency Info] why we do this ourselves instead+-- of letting shake take care of it.+getDependencyInfo :: [FilePath] -> IO DependencyInfo+getDependencyInfo fs = Map.fromList <$> mapM do_one fs++  where+    tryIO :: IO a -> IO (Either IOException a)+    tryIO = try++    do_one :: FilePath -> IO (FilePath, Maybe UTCTime)+    do_one fp = (fp,) . eitherToMaybe <$> tryIO (getModificationTime fp)++-- | This function removes all the -package flags which refer to packages we+-- are going to deal with ourselves. For example, if a executable depends+-- on a library component, then this function will remove the library flag+-- from the package flags for the executable+--+-- There are several places in GHC (for example the call to hptInstances in+-- tcRnImports) which assume that all modules in the HPT have the same unit+-- ID. Therefore we create a fake one and give them all the same unit id.+removeInplacePackages+    :: InstalledUnitId     -- ^ fake uid to use for our internal component+    -> [InstalledUnitId]+    -> DynFlags+    -> (DynFlags, [InstalledUnitId])+removeInplacePackages fake_uid us df = (df { packageFlags = ps+                                  , thisInstalledUnitId = fake_uid }, uids)+  where+    (uids, ps) = partitionEithers (map go (packageFlags df))+    go p@(ExposePackage _ (UnitIdArg u) _) = if toInstalledUnitId u `elem` us+                                                  then Left (toInstalledUnitId u)+                                                  else Right p+    go p = Right p++-- | Memoize an IO function, with the characteristics:+--+--   * If multiple people ask for a result simultaneously, make sure you only compute it once.+--+--   * If there are exceptions, repeatedly reraise them.+--+--   * If the caller is aborted (async exception) finish computing it anyway.+memoIO :: Ord a => (a -> IO b) -> IO (a -> IO b)+memoIO op = do+    ref <- newVar Map.empty+    return $ \k -> join $ mask_ $ modifyVar ref $ \mp ->+        case Map.lookup k mp of+            Nothing -> do+                res <- onceFork $ op k+                return (Map.insert k res mp, res)+            Just res -> return (mp, res)++-- | Throws if package flags are unsatisfiable+setOptions :: GhcMonad m => ComponentOptions -> DynFlags -> m (DynFlags, [GHC.Target])+setOptions (ComponentOptions theOpts compRoot _) dflags = do+    (dflags', targets') <- addCmdOpts theOpts dflags+    let targets = makeTargetsAbsolute compRoot targets'+    let dflags'' =+          disableWarningsAsErrors $+          -- disabled, generated directly by ghcide instead+          flip gopt_unset Opt_WriteInterface $+          -- disabled, generated directly by ghcide instead+          -- also, it can confuse the interface stale check+          dontWriteHieFiles $+          setIgnoreInterfacePragmas $+          setLinkerOptions $+          disableOptimisation $+          setUpTypedHoles $+          makeDynFlagsAbsolute compRoot dflags'+    -- initPackages parses the -package flags and+    -- sets up the visibility for each component.+    -- Throws if a -package flag cannot be satisfied.+    (final_df, _) <- liftIO $ wrapPackageSetupException $ initPackages dflags''+    return (final_df, targets)+++-- we don't want to generate object code so we compile to bytecode+-- (HscInterpreted) which implies LinkInMemory+-- HscInterpreted+setLinkerOptions :: DynFlags -> DynFlags+setLinkerOptions df = df {+    ghcLink   = LinkInMemory+  , hscTarget = HscNothing+  , ghcMode = CompManager+  }++setIgnoreInterfacePragmas :: DynFlags -> DynFlags+setIgnoreInterfacePragmas df =+    gopt_set (gopt_set df Opt_IgnoreInterfacePragmas) Opt_IgnoreOptimChanges++disableOptimisation :: DynFlags -> DynFlags+disableOptimisation df = updOptLevel 0 df++setHiDir :: FilePath -> DynFlags -> DynFlags+setHiDir f d =+    -- override user settings to avoid conflicts leading to recompilation+    d { hiDir      = Just f}++setODir :: FilePath -> DynFlags -> DynFlags+setODir f d =+    -- override user settings to avoid conflicts leading to recompilation+    d { objectDir = Just f}++getCacheDirsDefault :: String -> [String] -> IO CacheDirs+getCacheDirsDefault prefix opts = do+    dir <- Just <$> getXdgDirectory XdgCache (cacheDir </> prefix ++ "-" ++ opts_hash)+    return $ CacheDirs dir dir dir+    where+        -- Create a unique folder per set of different GHC options, assuming that each different set of+        -- GHC options will create incompatible interface files.+        opts_hash = B.unpack $ B16.encode $ H.finalize $ H.updates H.init (map B.pack opts)++-- | Sub directory for the cache path+cacheDir :: String+cacheDir = "ghcide"++implicitCradleWarning :: FilePath -> T.Text+implicitCradleWarning fp =+  "No [cradle](https://github.com/mpickering/hie-bios#hie-bios) found for "+  <> T.pack fp <>+  ".\n Proceeding with [implicit cradle](https://hackage.haskell.org/package/implicit-hie).\n"<>+  "You should ignore this message, unless you see a 'Multi Cradle: No prefixes matched' error."+----------------------------------------------------------------------------------------------------++data PackageSetupException+    = PackageSetupException+        { message     :: !String+        }+    | GhcVersionMismatch+        { compileTime :: !Version+        , runTime     :: !Version+        }+    | PackageCheckFailed !NotCompatibleReason+    deriving (Eq, Show, Typeable)++instance Exception PackageSetupException++-- | Wrap any exception as a 'PackageSetupException'+wrapPackageSetupException :: IO a -> IO a+wrapPackageSetupException = handleAny $ \case+  e | Just (pkgE :: PackageSetupException) <- fromException e -> throwIO pkgE+  e -> (throwIO . PackageSetupException . show) e++showPackageSetupException :: PackageSetupException -> String+showPackageSetupException GhcVersionMismatch{..} = unwords+    ["ghcide compiled against GHC"+    ,showVersion compileTime+    ,"but currently using"+    ,showVersion runTime+    ,"\nThis is unsupported, ghcide must be compiled with the same GHC version as the project."+    ]+showPackageSetupException PackageSetupException{..} = unwords+    [ "ghcide compiled by GHC", showVersion compilerVersion+    , "failed to load packages:", message <> "."+    , "\nPlease ensure that ghcide is compiled with the same GHC installation as the project."]+showPackageSetupException (PackageCheckFailed PackageVersionMismatch{..}) = unwords+    ["ghcide compiled with package "+    , packageName <> "-" <> showVersion compileTime+    ,"but project uses package"+    , packageName <> "-" <> showVersion runTime+    ,"\nThis is unsupported, ghcide must be compiled with the same GHC installation as the project."+    ]+showPackageSetupException (PackageCheckFailed BasePackageAbiMismatch{..}) = unwords+    ["ghcide compiled with base-" <> showVersion compileTime <> "-" <> compileTimeAbi+    ,"but project uses base-" <> showVersion compileTime <> "-" <> runTimeAbi+    ,"\nThis is unsupported, ghcide must be compiled with the same GHC installation as the project."+    ]++renderPackageSetupException :: FilePath -> PackageSetupException -> (NormalizedFilePath, ShowDiagnostic, Diagnostic)+renderPackageSetupException fp e =+    ideErrorWithSource (Just "cradle") (Just DsError) (toNormalizedFilePath' fp) (T.pack $ showPackageSetupException e)

@@ -1,17 +1,17 @@-{-# LANGUAGE TemplateHaskell #-}
-
--- | This module exists to circumvent a compile time exception on Windows with
--- Stack and GHC 8.10.1. It's just been pulled out from Development.IDE.Session.
--- See https://github.com/haskell/ghcide/pull/697
-module Development.IDE.Session.VersionCheck (ghcVersionChecker) where
-
-import Data.Maybe
-import GHC.Check
--- Only use this for checking against the compile time GHC libDir!
--- Use getRuntimeGhcLibDir from hie-bios instead for everything else
--- otherwise binaries will not be distributable since paths will be baked into them
-import qualified GHC.Paths
-import System.Environment
-
-ghcVersionChecker :: GhcVersionChecker
-ghcVersionChecker = $$(makeGhcVersionChecker (fromMaybe GHC.Paths.libdir <$> lookupEnv "NIX_GHC_LIBDIR"))
+{-# LANGUAGE TemplateHaskell #-}++-- | This module exists to circumvent a compile time exception on Windows with+-- Stack and GHC 8.10.1. It's just been pulled out from Development.IDE.Session.+-- See https://github.com/haskell/ghcide/pull/697+module Development.IDE.Session.VersionCheck (ghcVersionChecker) where++import           Data.Maybe+import           GHC.Check+-- Only use this for checking against the compile time GHC libDir!+-- Use getRuntimeGhcLibDir from hie-bios instead for everything else+-- otherwise binaries will not be distributable since paths will be baked into them+import qualified GHC.Paths+import           System.Environment++ghcVersionChecker :: GhcVersionChecker+ghcVersionChecker = $$(makeGhcVersionChecker (fromMaybe GHC.Paths.libdir <$> lookupEnv "NIX_GHC_LIBDIR"))

@@ -0,0 +1,34 @@+module Control.Concurrent.Strict+    (modifyVar', modifyVarIO'+    ,modifyVar, modifyVar_+    ,module Control.Concurrent.Extra+    ) where++import Control.Concurrent.Extra hiding (modifyVar, modifyVar_)+import qualified Control.Concurrent.Extra as Extra+import Control.Exception (evaluate)+import Data.Tuple.Extra (dupe)+import Control.Monad (void)++-- | Strict modification that returns the new value+modifyVar' :: Var a -> (a -> a) -> IO a+modifyVar' var upd = modifyVarIO' var (pure . upd)++-- | Strict modification that returns the new value+modifyVarIO' :: Var a -> (a -> IO a) -> IO a+modifyVarIO' var upd = do+    res <- Extra.modifyVar var $ \v -> do+        v' <- upd v+        pure $ dupe v'+    evaluate res++modifyVar :: Var a -> (a -> IO (a, b)) -> IO b+modifyVar var upd = do+    (new, res) <- Extra.modifyVar var $ \old -> do+        (new,res) <- upd old+        return (new, (new, res))+    void $ evaluate new+    return res++modifyVar_ :: Var a -> (a -> IO a) -> IO ()+modifyVar_ var upd = void $ modifyVarIO' var upd

@@ -1,50 +1,53 @@-module Development.IDE
-(
-    -- TODO It would be much nicer to enumerate all the exports
-    -- and organize them in sections
-    module X
-
-) where
-
-import           Development.IDE.Core.FileExists       as X (getFileExists)
-import           Development.IDE.Core.FileStore        as X (getFileContents)
-import           Development.IDE.Core.IdeConfiguration as X (IdeConfiguration (..),
-                                                             isWorkspaceFile)
-import           Development.IDE.Core.OfInterest       as X (getFilesOfInterest)
-import           Development.IDE.Core.RuleTypes        as X
-import           Development.IDE.Core.Rules            as X (getAtPoint,
-                                                             getClientConfigAction,
-                                                             getDefinition,
-                                                             getParsedModule,
-                                                             getTypeDefinition)
-import           Development.IDE.Core.Service          as X (runAction)
-import           Development.IDE.Core.Shake            as X (FastResult (..),
-                                                             IdeAction (..),
-                                                             IdeRule, IdeState,
-                                                             ShakeExtras,
-                                                             actionLogger,
-                                                             define,
-                                                             defineEarlyCutoff,
-                                                             getClientConfig,
-                                                             getPluginConfig,
-                                                             ideLogger,
-                                                             runIdeAction,
-                                                             shakeExtras, use,
-                                                             useNoFile,
-                                                             useNoFile_,
-                                                             useWithStale,
-                                                             useWithStaleFast,
-                                                             useWithStaleFast',
-                                                             useWithStale_,
-                                                             use_, uses, uses_)
-import           Development.IDE.GHC.Error             as X
-import           Development.IDE.GHC.Util              as X
-import           Development.IDE.Plugin                as X
-import           Development.IDE.Types.Diagnostics     as X
-import           Development.IDE.Types.HscEnvEq        as X (HscEnvEq (..),
-                                                             hscEnv,
-                                                             hscEnvWithImportPaths)
-import           Development.IDE.Types.Location        as X
-import           Development.IDE.Types.Logger          as X
-import           Development.Shake                     as X (Action, RuleResult,
-                                                             Rules, action)
+module Development.IDE+(+    -- TODO It would be much nicer to enumerate all the exports+    -- and organize them in sections+    module X++) where++import           Development.IDE.Core.FileExists       as X (getFileExists)+import           Development.IDE.Core.FileStore        as X (getFileContents)+import           Development.IDE.Core.IdeConfiguration as X (IdeConfiguration (..),+                                                             isWorkspaceFile)+import           Development.IDE.Core.OfInterest       as X (getFilesOfInterest)+import           Development.IDE.Core.RuleTypes        as X+import           Development.IDE.Core.Rules            as X (IsHiFileStable (..),+                                                             getAtPoint,+                                                             getClientConfigAction,+                                                             getDefinition,+                                                             getParsedModule,+                                                             getTypeDefinition)+import           Development.IDE.Core.Service          as X (runAction)+import           Development.IDE.Core.Shake            as X (FastResult (..),+                                                             IdeAction (..),+                                                             IdeRule, IdeState,+                                                             RuleBody (..),+                                                             ShakeExtras,+                                                             actionLogger,+                                                             define,+                                                             defineEarlyCutoff,+                                                             defineNoDiagnostics,+                                                             getClientConfig,+                                                             getPluginConfig,+                                                             ideLogger,+                                                             runIdeAction,+                                                             shakeExtras, use,+                                                             useNoFile,+                                                             useNoFile_,+                                                             useWithStale,+                                                             useWithStaleFast,+                                                             useWithStaleFast',+                                                             useWithStale_,+                                                             use_, uses, uses_)+import           Development.IDE.GHC.Error             as X+import           Development.IDE.GHC.Util              as X+import           Development.IDE.Plugin                as X+import           Development.IDE.Types.Diagnostics     as X+import           Development.IDE.Types.HscEnvEq        as X (HscEnvEq (..),+                                                             hscEnv,+                                                             hscEnvWithImportPaths)+import           Development.IDE.Types.Location        as X+import           Development.IDE.Types.Logger          as X+import           Development.Shake                     as X (Action, RuleResult,+                                                             Rules, action)

@@ -1,973 +1,987 @@--- Copyright (c) 2019 The DAML Authors. All rights reserved.
--- SPDX-License-Identifier: Apache-2.0
-
-{-# LANGUAGE RankNTypes #-}
-{-# LANGUAGE GADTs #-}
-{-# LANGUAGE CPP #-}
-#include "ghc-api-version.h"
-
--- | Based on https://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/API.
---   Given a list of paths to find libraries, and a file to compile, produce a list of 'CoreModule' values.
-module Development.IDE.Core.Compile
-  ( TcModuleResult(..)
-  , RunSimplifier(..)
-  , compileModule
-  , parseModule
-  , typecheckModule
-  , computePackageDeps
-  , addRelativeImport
-  , mkHiFileResultCompile
-  , mkHiFileResultNoCompile
-  , generateObjectCode
-  , generateByteCode
-  , generateHieAsts
-  , writeAndIndexHieFile
-  , indexHieFile
-  , writeHiFile
-  , getModSummaryFromImports
-  , loadHieFile
-  , loadInterface
-  , loadModulesHome
-  , setupFinderCache
-  , getDocsBatch
-  , lookupName
-  ) where
-
-import Development.IDE.Core.RuleTypes
-import Development.IDE.Core.Preprocessor
-import Development.IDE.Core.Shake
-import Development.IDE.GHC.Error
-import Development.IDE.GHC.Warnings
-import Development.IDE.Spans.Common
-import Development.IDE.Types.Diagnostics
-import Development.IDE.GHC.Orphans()
-import Development.IDE.GHC.Util
-import Development.IDE.Types.Options
-import Development.IDE.Types.Location
-import Outputable hiding ((<>))
-
-import HieDb
-
-import Language.LSP.Types (DiagnosticTag(..))
-
-import LoadIface (loadModuleInterface)
-import DriverPhases
-import HscTypes
-import DriverPipeline hiding (unP)
-
-import qualified Parser
-import           Lexer
-#if MIN_GHC_API_VERSION(8,10,0)
-import Control.DeepSeq (force, rnf)
-#else
-import Control.DeepSeq (rnf)
-import ErrUtils
-#endif
-
-import           Finder
-import           Development.IDE.GHC.Compat hiding (parseModule, typecheckModule, writeHieFile)
-import qualified Development.IDE.GHC.Compat     as GHC
-import qualified Development.IDE.GHC.Compat     as Compat
-import           GhcMonad
-import           GhcPlugins                     as GHC hiding (fst3, (<>))
-import           HscMain                        (makeSimpleDetails, hscDesugar, hscTypecheckRename, hscSimplify, hscGenHardCode, hscInteractive)
-import           MkIface
-import           StringBuffer                   as SB
-import           TcRnMonad                      hiding (newUnique)
-import           TcIface                        (typecheckIface)
-import           TidyPgm
-import           Hooks
-import           TcSplice
-
-import Control.Exception.Safe
-import Control.Lens hiding (List)
-import Control.Monad.Extra
-import Control.Monad.Except
-import Control.Monad.Trans.Except
-import Data.Bifunctor                           (first, second)
-import qualified Data.ByteString as BS
-import qualified Data.Text as T
-import           Data.IORef
-import           Data.List.Extra
-import           Data.Maybe
-import qualified Data.Map.Strict                          as Map
-import           System.FilePath
-import           System.Directory
-import System.IO.Extra ( fixIO, newTempFileWithin )
-import Control.Exception (evaluate)
-import TcEnv (tcLookup)
-import qualified Data.DList as DL
-import Data.Time (UTCTime, getCurrentTime)
-import Bag
-import Linker (unload)
-import qualified GHC.LanguageExtensions as LangExt
-import PrelNames
-import HeaderInfo
-import Maybes (orElse)
-
-import qualified Data.HashMap.Strict as HashMap
-import qualified Language.LSP.Types as LSP
-import qualified Language.LSP.Server as LSP
-import Control.Concurrent.STM hiding (orElse)
-import Control.Concurrent.Extra
-import Data.Functor
-import Data.Unique
-import GHC.Fingerprint
-import Data.Coerce
-import Data.Aeson (toJSON)
-import Data.Tuple.Extra (dupe)
-
--- | Given a string buffer, return the string (after preprocessing) and the 'ParsedModule'.
-parseModule
-    :: IdeOptions
-    -> HscEnv
-    -> FilePath
-    -> ModSummary
-    -> IO (IdeResult ParsedModule)
-parseModule IdeOptions{..} env filename ms =
-    fmap (either (, Nothing) id) $
-    runExceptT $ do
-        (diag, modu) <- parseFileContents env optPreprocessor filename ms
-        return (diag, Just modu)
-
-
--- | Given a package identifier, what packages does it depend on
-computePackageDeps
-    :: HscEnv
-    -> InstalledUnitId
-    -> IO (Either [FileDiagnostic] [InstalledUnitId])
-computePackageDeps env pkg = do
-    let dflags = hsc_dflags env
-    case lookupInstalledPackage dflags pkg of
-        Nothing -> return $ Left [ideErrorText (toNormalizedFilePath' noFilePath) $
-            T.pack $ "unknown package: " ++ show pkg]
-        Just pkgInfo -> return $ Right $ depends pkgInfo
-
-typecheckModule :: IdeDefer
-                -> HscEnv
-                -> [Linkable] -- ^ linkables not to unload
-                -> ParsedModule
-                -> IO (IdeResult TcModuleResult)
-typecheckModule (IdeDefer defer) hsc keep_lbls pm = do
-    fmap (either (,Nothing) id) $
-      catchSrcErrors (hsc_dflags hsc) "typecheck" $ do
-
-        let modSummary = pm_mod_summary pm
-            dflags = ms_hspp_opts modSummary
-
-        modSummary' <- initPlugins hsc modSummary
-        (warnings, tcm) <- withWarnings "typecheck" $ \tweak ->
-            tcRnModule hsc keep_lbls $ enableTopLevelWarnings
-                                     $ demoteIfDefer pm{pm_mod_summary = tweak modSummary'}
-        let errorPipeline = unDefer . hideDiag dflags . tagDiag
-            diags = map errorPipeline warnings
-            deferedError = any fst diags
-        return (map snd diags, Just $ tcm{tmrDeferedError = deferedError})
-    where
-        demoteIfDefer = if defer then demoteTypeErrorsToWarnings else id
-
--- | Add a Hook to the DynFlags which captures and returns the
--- typechecked splices before they are run. This information
--- is used for hover.
-captureSplices :: DynFlags -> (DynFlags -> IO a) -> IO (a, Splices)
-captureSplices dflags k = do
-  splice_ref <- newIORef mempty
-  res <- k (dflags { hooks = addSpliceHook splice_ref (hooks dflags)})
-  splices <- readIORef splice_ref
-  return (res, splices)
-  where
-    addSpliceHook :: IORef Splices -> Hooks -> Hooks
-    addSpliceHook var h = h { runMetaHook = Just (splice_hook (runMetaHook h) var) }
-
-    splice_hook :: Maybe (MetaHook TcM) -> IORef Splices -> MetaHook TcM
-    splice_hook (fromMaybe defaultRunMeta -> hook) var metaReq e = case metaReq of
-        (MetaE f) -> do
-            expr' <- metaRequestE hook e
-            liftIO $ modifyIORef' var $ exprSplicesL %~ ((e, expr') :)
-            pure $ f expr'
-        (MetaP f) -> do
-            pat' <- metaRequestP hook e
-            liftIO $ modifyIORef' var $ patSplicesL %~ ((e, pat') :)
-            pure $ f pat'
-        (MetaT f) -> do
-            type' <- metaRequestT hook e
-            liftIO $ modifyIORef' var $ typeSplicesL %~ ((e, type') :)
-            pure $ f type'
-        (MetaD f) -> do
-            decl' <- metaRequestD hook e
-            liftIO $ modifyIORef' var $ declSplicesL %~ ((e, decl') :)
-            pure $ f decl'
-        (MetaAW f) -> do
-            aw' <- metaRequestAW hook e
-            liftIO $ modifyIORef' var $ awSplicesL %~ ((e, aw') :)
-            pure $ f aw'
-
-
-tcRnModule :: HscEnv -> [Linkable] -> ParsedModule -> IO TcModuleResult
-tcRnModule hsc_env keep_lbls pmod = do
-  let ms = pm_mod_summary pmod
-      hsc_env_tmp = hsc_env { hsc_dflags = ms_hspp_opts ms }
-
-  unload hsc_env_tmp keep_lbls
-
-  ((tc_gbl_env, mrn_info), splices)
-      <- liftIO $ captureSplices (ms_hspp_opts ms) $ \dflags ->
-             do  let hsc_env_tmp = hsc_env { hsc_dflags = dflags }
-                 hscTypecheckRename hsc_env_tmp ms $
-                          HsParsedModule { hpm_module = parsedSource pmod,
-                                           hpm_src_files = pm_extra_src_files pmod,
-                                           hpm_annotations = pm_annotations pmod }
-  let rn_info = case mrn_info of
-        Just x -> x
-        Nothing -> error "no renamed info tcRnModule"
-  pure (TcModuleResult pmod rn_info tc_gbl_env splices False)
-
-mkHiFileResultNoCompile :: HscEnv -> TcModuleResult -> IO HiFileResult
-mkHiFileResultNoCompile session tcm = do
-  let hsc_env_tmp = session { hsc_dflags = ms_hspp_opts ms }
-      ms = pm_mod_summary $ tmrParsed tcm
-      tcGblEnv = tmrTypechecked tcm
-  details <- makeSimpleDetails hsc_env_tmp tcGblEnv
-  sf <- finalSafeMode (ms_hspp_opts ms) tcGblEnv
-#if MIN_GHC_API_VERSION(8,10,0)
-  iface <- mkIfaceTc session sf details tcGblEnv
-#else
-  (iface, _) <- mkIfaceTc session Nothing sf details tcGblEnv
-#endif
-  let mod_info = HomeModInfo iface details Nothing
-  pure $! HiFileResult ms mod_info
-
-mkHiFileResultCompile
-    :: HscEnv
-    -> TcModuleResult
-    -> ModGuts
-    -> LinkableType -- ^ use object code or byte code?
-    -> IO (IdeResult HiFileResult)
-mkHiFileResultCompile session' tcm simplified_guts ltype = catchErrs $ do
-  let session = session' { hsc_dflags = ms_hspp_opts ms }
-      ms = pm_mod_summary $ tmrParsed tcm
-      tcGblEnv = tmrTypechecked tcm
-
-  let genLinkable = case ltype of
-        ObjectLinkable -> generateObjectCode
-        BCOLinkable -> generateByteCode
-
-  (linkable, details, diags) <-
-    if mg_hsc_src simplified_guts == HsBootFile
-    then do
-        -- give variables unique OccNames
-        details <- mkBootModDetailsTc session tcGblEnv
-        pure (Nothing, details, [])
-    else do
-        -- give variables unique OccNames
-        (guts, details) <- tidyProgram session simplified_guts
-        (diags, linkable) <- genLinkable session ms guts
-        pure (linkable, details, diags)
-#if MIN_GHC_API_VERSION(8,10,0)
-  let !partial_iface = force (mkPartialIface session details simplified_guts)
-  final_iface <- mkFullIface session partial_iface
-#else
-  (final_iface,_) <- mkIface session Nothing details simplified_guts
-#endif
-  let mod_info = HomeModInfo final_iface details linkable
-  pure (diags, Just $! HiFileResult ms mod_info)
-
-  where
-    dflags = hsc_dflags session'
-    source = "compile"
-    catchErrs x = x `catches`
-      [ Handler $ return . (,Nothing) . diagFromGhcException source dflags
-      , Handler $ return . (,Nothing) . diagFromString source DsError (noSpan "<internal>")
-      . (("Error during " ++ T.unpack source) ++) . show @SomeException
-      ]
-
-initPlugins :: HscEnv -> ModSummary -> IO ModSummary
-initPlugins session modSummary = do
-    dflags <- liftIO $ initializePlugins session $ ms_hspp_opts modSummary
-    return modSummary{ms_hspp_opts = dflags}
-
--- | Whether we should run the -O0 simplifier when generating core.
---
--- This is required for template Haskell to work but we disable this in DAML.
--- See #256
-newtype RunSimplifier = RunSimplifier Bool
-
--- | Compile a single type-checked module to a 'CoreModule' value, or
--- provide errors.
-compileModule
-    :: RunSimplifier
-    -> HscEnv
-    -> ModSummary
-    -> TcGblEnv
-    -> IO (IdeResult ModGuts)
-compileModule (RunSimplifier simplify) session ms tcg =
-    fmap (either (, Nothing) (second Just)) $
-        catchSrcErrors (hsc_dflags session) "compile" $ do
-            (warnings,desugared_guts) <- withWarnings "compile" $ \tweak -> do
-               let ms' = tweak ms
-                   session' = session{ hsc_dflags = ms_hspp_opts ms'}
-               desugar <- hscDesugar session' ms' tcg
-               if simplify
-               then do
-                 plugins <- readIORef (tcg_th_coreplugins tcg)
-                 hscSimplify session' plugins desugar
-               else pure desugar
-            return (map snd warnings, desugared_guts)
-
-generateObjectCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable)
-generateObjectCode session summary guts = do
-    fmap (either (, Nothing) (second Just)) $
-          catchSrcErrors (hsc_dflags session) "object" $ do
-              let dot_o =  ml_obj_file (ms_location summary)
-                  mod = ms_mod summary
-                  fp = replaceExtension dot_o "s"
-              createDirectoryIfMissing True (takeDirectory fp)
-              (warnings, dot_o_fp) <-
-                withWarnings "object" $ \_tweak -> do
-                      let summary' = _tweak summary
-#if MIN_GHC_API_VERSION(8,10,0)
-                          target = defaultObjectTarget $ hsc_dflags session
-#else
-                          target = defaultObjectTarget $ targetPlatform $ hsc_dflags session
-#endif
-                          session' = session { hsc_dflags = updOptLevel 0 $ (ms_hspp_opts summary') { outputFile = Just dot_o , hscTarget = target}}
-                      (outputFilename, _mStub, _foreign_files) <- hscGenHardCode session' guts
-#if MIN_GHC_API_VERSION(8,10,0)
-                                (ms_location summary')
-#else
-                                summary'
-#endif
-                                fp
-                      compileFile session' StopLn (outputFilename, Just (As False))
-              let unlinked = DotO dot_o_fp
-              -- Need time to be the modification time for recompilation checking
-              t <- liftIO $ getModificationTime dot_o_fp
-              let linkable = LM t mod [unlinked]
-
-              pure (map snd warnings, linkable)
-
-generateByteCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable)
-generateByteCode hscEnv summary guts = do
-    fmap (either (, Nothing) (second Just)) $
-          catchSrcErrors (hsc_dflags hscEnv) "bytecode" $ do
-              (warnings, (_, bytecode, sptEntries)) <-
-                withWarnings "bytecode" $ \_tweak -> do
-                      let summary' = _tweak summary
-                          session = hscEnv { hsc_dflags = ms_hspp_opts summary' }
-                      hscInteractive session guts
-#if MIN_GHC_API_VERSION(8,10,0)
-                                (ms_location summary')
-#else
-                                summary'
-#endif
-              let unlinked = BCOs bytecode sptEntries
-              time <- liftIO getCurrentTime
-              let linkable = LM time (ms_mod summary) [unlinked]
-
-              pure (map snd warnings, linkable)
-
-demoteTypeErrorsToWarnings :: ParsedModule -> ParsedModule
-demoteTypeErrorsToWarnings =
-  (update_pm_mod_summary . update_hspp_opts) demoteTEsToWarns where
-
-  demoteTEsToWarns :: DynFlags -> DynFlags
-  -- convert the errors into warnings, and also check the warnings are enabled
-  demoteTEsToWarns = (`wopt_set` Opt_WarnDeferredTypeErrors)
-                   . (`wopt_set` Opt_WarnTypedHoles)
-                   . (`wopt_set` Opt_WarnDeferredOutOfScopeVariables)
-                   . (`gopt_set` Opt_DeferTypeErrors)
-                   . (`gopt_set` Opt_DeferTypedHoles)
-                   . (`gopt_set` Opt_DeferOutOfScopeVariables)
-
-enableTopLevelWarnings :: ParsedModule -> ParsedModule
-enableTopLevelWarnings =
-  (update_pm_mod_summary . update_hspp_opts)
-  ((`wopt_set` Opt_WarnMissingPatternSynonymSignatures) .
-   (`wopt_set` Opt_WarnMissingSignatures))
-  -- the line below would show also warnings for let bindings without signature
-  -- ((`wopt_set` Opt_WarnMissingSignatures) . (`wopt_set` Opt_WarnMissingLocalSignatures)))
-
-update_hspp_opts :: (DynFlags -> DynFlags) -> ModSummary -> ModSummary
-update_hspp_opts up ms = ms{ms_hspp_opts = up $ ms_hspp_opts ms}
-
-update_pm_mod_summary :: (ModSummary -> ModSummary) -> ParsedModule -> ParsedModule
-update_pm_mod_summary up pm =
-  pm{pm_mod_summary = up $ pm_mod_summary pm}
-
-unDefer :: (WarnReason, FileDiagnostic) -> (Bool, FileDiagnostic)
-unDefer (Reason Opt_WarnDeferredTypeErrors         , fd) = (True, upgradeWarningToError fd)
-unDefer (Reason Opt_WarnTypedHoles                 , fd) = (True, upgradeWarningToError fd)
-unDefer (Reason Opt_WarnDeferredOutOfScopeVariables, fd) = (True, upgradeWarningToError fd)
-unDefer ( _                                        , fd) = (False, fd)
-
-upgradeWarningToError :: FileDiagnostic -> FileDiagnostic
-upgradeWarningToError (nfp, sh, fd) =
-  (nfp, sh, fd{_severity = Just DsError, _message = warn2err $ _message fd}) where
-  warn2err :: T.Text -> T.Text
-  warn2err = T.intercalate ": error:" . T.splitOn ": warning:"
-
-hideDiag :: DynFlags -> (WarnReason, FileDiagnostic) -> (WarnReason, FileDiagnostic)
-hideDiag originalFlags (Reason warning, (nfp, _sh, fd))
-  | not (wopt warning originalFlags)
-  = (Reason warning, (nfp, HideDiag, fd))
-hideDiag _originalFlags t = t
-
--- | Warnings which lead to a diagnostic tag
-unnecessaryDeprecationWarningFlags :: [WarningFlag]
-unnecessaryDeprecationWarningFlags
-  = [ Opt_WarnUnusedTopBinds
-    , Opt_WarnUnusedLocalBinds
-    , Opt_WarnUnusedPatternBinds
-    , Opt_WarnUnusedImports
-    , Opt_WarnUnusedMatches
-    , Opt_WarnUnusedTypePatterns
-    , Opt_WarnUnusedForalls
-#if MIN_GHC_API_VERSION(8,10,0)
-    , Opt_WarnUnusedRecordWildcards
-#endif
-    , Opt_WarnInaccessibleCode
-    , Opt_WarnWarningsDeprecations
-    ]
-
--- | Add a unnecessary/deprecated tag to the required diagnostics.
-tagDiag :: (WarnReason, FileDiagnostic) -> (WarnReason, FileDiagnostic)
-tagDiag (Reason warning, (nfp, sh, fd))
-  | Just tag <- requiresTag warning
-  = (Reason warning, (nfp, sh, fd { _tags = addTag tag (_tags fd) }))
-  where
-    requiresTag :: WarningFlag -> Maybe DiagnosticTag
-    requiresTag Opt_WarnWarningsDeprecations
-      = Just DtDeprecated
-    requiresTag wflag  -- deprecation was already considered above
-      | wflag `elem` unnecessaryDeprecationWarningFlags
-      = Just DtUnnecessary
-    requiresTag _ = Nothing
-    addTag :: DiagnosticTag -> Maybe (List DiagnosticTag) -> Maybe (List DiagnosticTag)
-    addTag t Nothing          = Just (List [t])
-    addTag t (Just (List ts)) = Just (List (t : ts))
--- other diagnostics are left unaffected
-tagDiag t = t
-
-addRelativeImport :: NormalizedFilePath -> ModuleName -> DynFlags -> DynFlags
-addRelativeImport fp modu dflags = dflags
-    {importPaths = nubOrd $ maybeToList (moduleImportPath fp modu) ++ importPaths dflags}
-
-atomicFileWrite :: FilePath -> (FilePath -> IO a) -> IO ()
-atomicFileWrite targetPath write = do
-  let dir = takeDirectory targetPath
-  createDirectoryIfMissing True dir
-  (tempFilePath, cleanUp) <- newTempFileWithin dir
-  (write tempFilePath >> renameFile tempFilePath targetPath) `onException` cleanUp
-
-generateHieAsts :: HscEnv -> TcModuleResult -> IO ([FileDiagnostic], Maybe (HieASTs Type))
-generateHieAsts hscEnv tcm =
-  handleGenerationErrors' dflags "extended interface generation" $ runHsc hscEnv $ do
-    -- These varBinds use unitDataConId but it could be anything as the id name is not used
-    -- during the hie file generation process. It's a workaround for the fact that the hie modules
-    -- don't export an interface which allows for additional information to be added to hie files.
-    let fake_splice_binds = listToBag (map (mkVarBind unitDataConId) (spliceExpresions $ tmrTopLevelSplices tcm))
-        real_binds = tcg_binds $ tmrTypechecked tcm
-    Just <$> GHC.enrichHie (fake_splice_binds `unionBags` real_binds) (tmrRenamed tcm)
-  where
-    dflags = hsc_dflags hscEnv
-
-spliceExpresions :: Splices -> [LHsExpr GhcTc]
-spliceExpresions Splices{..} =
-    DL.toList $ mconcat
-        [ DL.fromList $ map fst exprSplices
-        , DL.fromList $ map fst patSplices
-        , DL.fromList $ map fst typeSplices
-        , DL.fromList $ map fst declSplices
-        , DL.fromList $ map fst awSplices
-        ]
-
--- | In addition to indexing the `.hie` file, this function is responsible for
--- maintaining the 'IndexQueue' state and notfiying the user about indexing
--- progress.
---
--- We maintain a record of all pending index operations in the 'indexPending'
--- TVar.
--- When 'indexHieFile' is called, it must check to ensure that the file hasn't
--- already be queued up for indexing. If it has, then we can just skip it
---
--- Otherwise, we record the current file as pending and write an indexing
--- operation to the queue
---
--- When the indexing operation is picked up and executed by the worker thread,
--- the first thing it does is ensure that a newer index for the same file hasn't
--- been scheduled by looking at 'indexPending'. If a newer index has been
--- scheduled, we can safely skip this one
---
--- Otherwise, we start or continue a progress reporting session, telling it
--- about progress so far and the current file we are attempting to index. Then
--- we can go ahead and call in to hiedb to actually do the indexing operation
---
--- Once this completes, we have to update the 'IndexQueue' state. First, we
--- must remove the just indexed file from 'indexPending' Then we check if
--- 'indexPending' is now empty. In that case, we end the progress session and
--- report the total number of file indexed. We also set the 'indexCompleted'
--- TVar to 0 in order to set it up for a fresh indexing session. Otherwise, we
--- can just increment the 'indexCompleted' TVar and exit.
---
-indexHieFile :: ShakeExtras -> ModSummary -> NormalizedFilePath -> Fingerprint -> Compat.HieFile -> IO ()
-indexHieFile se mod_summary srcPath hash hf = atomically $ do
-  pending <- readTVar indexPending
-  case HashMap.lookup srcPath pending of
-    Just pendingHash | pendingHash == hash -> pure () -- An index is already scheduled
-    _ -> do
-      modifyTVar' indexPending $ HashMap.insert srcPath hash
-      writeTQueue indexQueue $ \db -> do
-        -- We are now in the worker thread
-        -- Check if a newer index of this file has been scheduled, and if so skip this one
-        newerScheduled <- atomically $ do
-          pending <- readTVar indexPending
-          pure $ case HashMap.lookup srcPath pending of
-            Nothing -> False
-            -- If the hash in the pending list doesn't match the current hash, then skip
-            Just pendingHash -> pendingHash /= hash
-        unless newerScheduled $ do
-          pre
-          addRefsFromLoaded db targetPath (RealFile $ fromNormalizedFilePath srcPath) hash hf
-          post
-  where
-    mod_location    = ms_location mod_summary
-    targetPath      = Compat.ml_hie_file mod_location
-    HieDbWriter{..} = hiedbWriter se
-
-    -- Get a progress token to report progress and update it for the current file
-    pre = do
-      tok <- modifyVar indexProgressToken $ fmap dupe . \case
-        x@(Just _) -> pure x
-        -- Create a token if we don't already have one
-        Nothing -> do
-          case lspEnv se of
-            Nothing -> pure Nothing
-            Just env -> LSP.runLspT env $ do
-              u <- LSP.ProgressTextToken . T.pack . show . hashUnique <$> liftIO newUnique
-              -- TODO: Wait for the progress create response to use the token
-              _ <- LSP.sendRequest LSP.SWindowWorkDoneProgressCreate (LSP.WorkDoneProgressCreateParams u) (const $ pure ())
-              LSP.sendNotification LSP.SProgress $ LSP.ProgressParams u $
-                LSP.Begin $ LSP.WorkDoneProgressBeginParams
-                  { _title = "Indexing references from:"
-                  , _cancellable = Nothing
-                  , _message = Nothing
-                  , _percentage = Nothing
-                  }
-              pure (Just u)
-
-      (!done, !remaining) <- atomically $ do
-        done <- readTVar indexCompleted
-        remaining <- HashMap.size <$> readTVar indexPending
-        pure (done, remaining)
-
-      let progress = " (" <> T.pack (show done) <> "/" <> T.pack (show $ done + remaining) <> ")..."
-
-      whenJust (lspEnv se) $ \env -> whenJust tok $ \tok -> LSP.runLspT env $
-        LSP.sendNotification LSP.SProgress $ LSP.ProgressParams tok $
-          LSP.Report $ LSP.WorkDoneProgressReportParams
-            { _cancellable = Nothing
-            , _message = Just $ T.pack (show srcPath) <> progress
-            , _percentage = Nothing
-            }
-
-    -- Report the progress once we are done indexing this file
-    post = do
-      mdone <- atomically $ do
-        -- Remove current element from pending
-        pending <- stateTVar indexPending $
-          dupe . HashMap.update (\pendingHash -> guard (pendingHash /= hash) $> pendingHash) srcPath
-        modifyTVar' indexCompleted (+1)
-        -- If we are done, report and reset completed
-        whenMaybe (HashMap.null pending) $
-          swapTVar indexCompleted 0
-      whenJust (lspEnv se) $ \env -> LSP.runLspT env $
-        when (coerce $ ideTesting se) $
-          LSP.sendNotification (LSP.SCustomMethod "ghcide/reference/ready") $
-            toJSON $ fromNormalizedFilePath srcPath
-      whenJust mdone $ \done ->
-        modifyVar_ indexProgressToken $ \tok -> do
-          whenJust (lspEnv se) $ \env -> LSP.runLspT env $
-            whenJust tok $ \tok ->
-              LSP.sendNotification LSP.SProgress $ LSP.ProgressParams tok $
-                LSP.End $ LSP.WorkDoneProgressEndParams
-                  { _message = Just $ "Finished indexing " <> T.pack (show done) <> " files"
-                  }
-          -- We are done with the current indexing cycle, so destroy the token
-          pure Nothing
-
-writeAndIndexHieFile :: HscEnv -> ShakeExtras -> ModSummary -> NormalizedFilePath -> [GHC.AvailInfo] -> HieASTs Type -> BS.ByteString -> IO [FileDiagnostic]
-writeAndIndexHieFile hscEnv se mod_summary srcPath exports ast source =
-  handleGenerationErrors dflags "extended interface write/compression" $ do
-    hf <- runHsc hscEnv $
-      GHC.mkHieFile' mod_summary exports ast source
-    atomicFileWrite targetPath $ flip GHC.writeHieFile hf
-    hash <- getFileHash targetPath
-    indexHieFile se mod_summary srcPath hash hf
-  where
-    dflags       = hsc_dflags hscEnv
-    mod_location = ms_location mod_summary
-    targetPath   = Compat.ml_hie_file mod_location
-
-writeHiFile :: HscEnv -> HiFileResult -> IO [FileDiagnostic]
-writeHiFile hscEnv tc =
-  handleGenerationErrors dflags "interface write" $ do
-    atomicFileWrite targetPath $ \fp ->
-      writeIfaceFile dflags fp modIface
-  where
-    modIface = hm_iface $ hirHomeMod tc
-    targetPath = ml_hi_file $ ms_location $ hirModSummary tc
-    dflags = hsc_dflags hscEnv
-
-handleGenerationErrors :: DynFlags -> T.Text -> IO () -> IO [FileDiagnostic]
-handleGenerationErrors dflags source action =
-  action >> return [] `catches`
-    [ Handler $ return . diagFromGhcException source dflags
-    , Handler $ return . diagFromString source DsError (noSpan "<internal>")
-    . (("Error during " ++ T.unpack source) ++) . show @SomeException
-    ]
-
-handleGenerationErrors' :: DynFlags -> T.Text -> IO (Maybe a) -> IO ([FileDiagnostic], Maybe a)
-handleGenerationErrors' dflags source action =
-  fmap ([],) action `catches`
-    [ Handler $ return . (,Nothing) . diagFromGhcException source dflags
-    , Handler $ return . (,Nothing) . diagFromString source DsError (noSpan "<internal>")
-    . (("Error during " ++ T.unpack source) ++) . show @SomeException
-    ]
-
--- | Initialise the finder cache, dependencies should be topologically
--- sorted.
-setupFinderCache :: [ModSummary] -> HscEnv -> IO HscEnv
-setupFinderCache mss session = do
-
-    -- Make modules available for others that import them,
-    -- by putting them in the finder cache.
-    let ims  = map (InstalledModule (thisInstalledUnitId $ hsc_dflags session) . moduleName . ms_mod) mss
-        ifrs = zipWith (\ms -> InstalledFound (ms_location ms)) mss ims
-    -- set the target and module graph in the session
-        graph = mkModuleGraph mss
-
-    -- We have to create a new IORef here instead of modifying the existing IORef as
-    -- it is shared between concurrent compilations.
-    prevFinderCache <- readIORef $ hsc_FC session
-    let newFinderCache =
-            foldl'
-                (\fc (im, ifr) -> GHC.extendInstalledModuleEnv fc im ifr) prevFinderCache
-                $ zip ims ifrs
-    newFinderCacheVar <- newIORef $! newFinderCache
-
-    pure $ session { hsc_FC = newFinderCacheVar, hsc_mod_graph = graph }
-
-
--- | Load modules, quickly. Input doesn't need to be desugared.
--- A module must be loaded before dependent modules can be typechecked.
--- This variant of loadModuleHome will *never* cause recompilation, it just
--- modifies the session.
--- The order modules are loaded is important when there are hs-boot files.
--- In particular you should make sure to load the .hs version of a file after the
--- .hs-boot version.
-loadModulesHome
-    :: [HomeModInfo]
-    -> HscEnv
-    -> HscEnv
-loadModulesHome mod_infos e =
-    e { hsc_HPT = addListToHpt (hsc_HPT e) [(mod_name x, x) | x <- mod_infos]
-      , hsc_type_env_var = Nothing }
-    where
-      mod_name = moduleName . mi_module . hm_iface
-
-withBootSuffix :: HscSource -> ModLocation -> ModLocation
-withBootSuffix HsBootFile = addBootSuffixLocnOut
-withBootSuffix _ = id
-
--- | Given a buffer, env and filepath, produce a module summary by parsing only the imports.
---   Runs preprocessors as needed.
-getModSummaryFromImports
-  :: HscEnv
-  -> FilePath
-  -> UTCTime
-  -> Maybe SB.StringBuffer
-  -> ExceptT [FileDiagnostic] IO (ModSummary,[LImportDecl GhcPs])
-getModSummaryFromImports env fp modTime contents = do
-    (contents, dflags) <- preprocessor env fp contents
-
-    -- The warns will hopefully be reported when we actually parse the module
-    (_warns, L main_loc hsmod) <- parseHeader dflags fp contents
-
-    -- Copied from `HeaderInfo.getImports`, but we also need to keep the parsed imports
-    let mb_mod = hsmodName hsmod
-        imps = hsmodImports hsmod
-
-        mod = fmap unLoc mb_mod `orElse` mAIN_NAME
-
-        (src_idecls, ord_idecls) = partition (ideclSource.unLoc) imps
-
-        -- GHC.Prim doesn't exist physically, so don't go looking for it.
-        ordinary_imps = filter ((/= moduleName gHC_PRIM) . unLoc
-                                . ideclName . unLoc)
-                               ord_idecls
-
-        implicit_prelude = xopt LangExt.ImplicitPrelude dflags
-        implicit_imports = mkPrelImports mod main_loc
-                                         implicit_prelude imps
-        convImport (L _ i) = (fmap sl_fs (ideclPkgQual i)
-                                         , ideclName i)
-
-        srcImports = map convImport src_idecls
-        textualImports = map convImport (implicit_imports ++ ordinary_imps)
-
-        allImps = implicit_imports ++ imps
-
-    -- Force bits that might keep the string buffer and DynFlags alive unnecessarily
-    liftIO $ evaluate $ rnf srcImports
-    liftIO $ evaluate $ rnf textualImports
-
-    modLoc <- liftIO $ mkHomeModLocation dflags mod fp
-
-    let modl = mkModule (thisPackage dflags) mod
-        sourceType = if "-boot" `isSuffixOf` takeExtension fp then HsBootFile else HsSrcFile
-        summary =
-            ModSummary
-                { ms_mod          = modl
-#if MIN_GHC_API_VERSION(8,8,0)
-                , ms_hie_date     = Nothing
-#endif
-                , ms_hs_date      = modTime
-                , ms_hsc_src      = sourceType
-                -- The contents are used by the GetModSummary rule
-                , ms_hspp_buf     = Just contents
-                , ms_hspp_file    = fp
-                , ms_hspp_opts    = dflags
-                , ms_iface_date   = Nothing
-                , ms_location     = withBootSuffix sourceType modLoc
-                , ms_obj_date     = Nothing
-                , ms_parsed_mod   = Nothing
-                , ms_srcimps      = srcImports
-                , ms_textual_imps = textualImports
-                }
-    return (summary, allImps)
-
--- | Parse only the module header
-parseHeader
-       :: Monad m
-       => DynFlags -- ^ flags to use
-       -> FilePath  -- ^ the filename (for source locations)
-       -> SB.StringBuffer -- ^ Haskell module source text (full Unicode is supported)
-       -> ExceptT [FileDiagnostic] m ([FileDiagnostic], Located(HsModule GhcPs))
-parseHeader dflags filename contents = do
-   let loc  = mkRealSrcLoc (mkFastString filename) 1 1
-   case unP Parser.parseHeader (mkPState dflags contents loc) of
-#if MIN_GHC_API_VERSION(8,10,0)
-     PFailed pst ->
-        throwE $ diagFromErrMsgs "parser" dflags $ getErrorMessages pst dflags
-#else
-     PFailed _ locErr msgErr ->
-        throwE $ diagFromErrMsg "parser" dflags $ mkPlainErrMsg dflags locErr msgErr
-#endif
-     POk pst rdr_module -> do
-        let (warns, errs) = getMessages pst dflags
-        -- Just because we got a `POk`, it doesn't mean there
-        -- weren't errors! To clarify, the GHC parser
-        -- distinguishes between fatal and non-fatal
-        -- errors. Non-fatal errors are the sort that don't
-        -- prevent parsing from continuing (that is, a parse
-        -- tree can still be produced despite the error so that
-        -- further errors/warnings can be collected). Fatal
-        -- errors are those from which a parse tree just can't
-        -- be produced.
-        unless (null errs) $
-            throwE $ diagFromErrMsgs "parser" dflags errs
-
-        let warnings = diagFromErrMsgs "parser" dflags warns
-        return (warnings, rdr_module)
-
--- | Given a buffer, flags, and file path, produce a
--- parsed module (or errors) and any parse warnings. Does not run any preprocessors
--- ModSummary must contain the (preprocessed) contents of the buffer
-parseFileContents
-       :: HscEnv
-       -> (GHC.ParsedSource -> IdePreprocessedSource)
-       -> FilePath  -- ^ the filename (for source locations)
-       -> ModSummary
-       -> ExceptT [FileDiagnostic] IO ([FileDiagnostic], ParsedModule)
-parseFileContents env customPreprocessor filename ms = do
-   let loc  = mkRealSrcLoc (mkFastString filename) 1 1
-       dflags = ms_hspp_opts ms
-       contents = fromJust $ ms_hspp_buf ms
-   case unP Parser.parseModule (mkPState dflags contents loc) of
-#if MIN_GHC_API_VERSION(8,10,0)
-     PFailed pst -> throwE $ diagFromErrMsgs "parser" dflags $ getErrorMessages pst dflags
-#else
-     PFailed _ locErr msgErr ->
-      throwE $ diagFromErrMsg "parser" dflags $ mkPlainErrMsg dflags locErr msgErr
-#endif
-     POk pst rdr_module ->
-         let hpm_annotations =
-               (Map.fromListWith (++) $ annotations pst,
-                 Map.fromList ((noSrcSpan,comment_q pst)
-                                  :annotations_comments pst))
-             (warns, errs) = getMessages pst dflags
-         in
-           do
-               -- Just because we got a `POk`, it doesn't mean there
-               -- weren't errors! To clarify, the GHC parser
-               -- distinguishes between fatal and non-fatal
-               -- errors. Non-fatal errors are the sort that don't
-               -- prevent parsing from continuing (that is, a parse
-               -- tree can still be produced despite the error so that
-               -- further errors/warnings can be collected). Fatal
-               -- errors are those from which a parse tree just can't
-               -- be produced.
-               unless (null errs) $
-                 throwE $ diagFromErrMsgs "parser" dflags errs
-
-               -- Ok, we got here. It's safe to continue.
-               let IdePreprocessedSource preproc_warns errs parsed = customPreprocessor rdr_module
-
-               unless (null errs) $
-                  throwE $ diagFromStrings "parser" DsError errs
-
-               let preproc_warnings = diagFromStrings "parser" DsWarning preproc_warns
-               parsed' <- liftIO $ applyPluginsParsedResultAction env dflags ms hpm_annotations parsed
-
-               -- To get the list of extra source files, we take the list
-               -- that the parser gave us,
-               --   - eliminate files beginning with '<'.  gcc likes to use
-               --     pseudo-filenames like "<built-in>" and "<command-line>"
-               --   - normalise them (eliminate differences between ./f and f)
-               --   - filter out the preprocessed source file
-               --   - filter out anything beginning with tmpdir
-               --   - remove duplicates
-               --   - filter out the .hs/.lhs source filename if we have one
-               --
-               let n_hspp  = normalise filename
-                   srcs0 = nubOrd $ filter (not . (tmpDir dflags `isPrefixOf`))
-                                  $ filter (/= n_hspp)
-                                  $ map normalise
-                                  $ filter (not . isPrefixOf "<")
-                                  $ map unpackFS
-                                  $ srcfiles pst
-                   srcs1 = case ml_hs_file (ms_location ms) of
-                             Just f  -> filter (/= normalise f) srcs0
-                             Nothing -> srcs0
-
-               -- sometimes we see source files from earlier
-               -- preprocessing stages that cannot be found, so just
-               -- filter them out:
-               srcs2 <- liftIO $ filterM doesFileExist srcs1
-
-               let pm =
-                     ParsedModule {
-                         pm_mod_summary = ms
-                       , pm_parsed_source = parsed'
-                       , pm_extra_src_files = srcs2
-                       , pm_annotations = hpm_annotations
-                      }
-                   warnings = diagFromErrMsgs "parser" dflags warns
-               pure (warnings ++ preproc_warnings, pm)
-
-loadHieFile :: Compat.NameCacheUpdater -> FilePath -> IO GHC.HieFile
-loadHieFile ncu f = do
-  GHC.hie_file_result <$> GHC.readHieFile ncu f
-
--- | Retuns an up-to-date module interface, regenerating if needed.
---   Assumes file exists.
---   Requires the 'HscEnv' to be set up with dependencies
-loadInterface
-  :: MonadIO m => HscEnv
-  -> ModSummary
-  -> SourceModified
-  -> Maybe LinkableType
-  -> (Maybe LinkableType -> m ([FileDiagnostic], Maybe HiFileResult)) -- ^ Action to regenerate an interface
-  -> m ([FileDiagnostic], Maybe HiFileResult)
-loadInterface session ms sourceMod linkableNeeded regen = do
-    res <- liftIO $ checkOldIface session ms sourceMod Nothing
-    case res of
-          (UpToDate, Just iface)
-            -- If the module used TH splices when it was last
-            -- compiled, then the recompilation check is not
-            -- accurate enough (https://gitlab.haskell.org/ghc/ghc/-/issues/481)
-            -- and we must ignore
-            -- it.  However, if the module is stable (none of
-            -- the modules it depends on, directly or
-            -- indirectly, changed), then we *can* skip
-            -- recompilation. This is why the SourceModified
-            -- type contains SourceUnmodifiedAndStable, and
-            -- it's pretty important: otherwise ghc --make
-            -- would always recompile TH modules, even if
-            -- nothing at all has changed. Stability is just
-            -- the same check that make is doing for us in
-            -- one-shot mode.
-            | not (mi_used_th iface) || SourceUnmodifiedAndStable == sourceMod
-            -> do
-             linkable <- case linkableNeeded of
-               Just ObjectLinkable -> liftIO $ findObjectLinkableMaybe (ms_mod ms) (ms_location ms)
-               _ -> pure Nothing
-
-             -- We don't need to regenerate if the object is up do date, or we don't need one
-             let objUpToDate = isNothing linkableNeeded || case linkable of
-                   Nothing -> False
-                   Just (LM obj_time _ _) -> obj_time > ms_hs_date ms
-             if objUpToDate
-             then do
-               hmi <- liftIO $ mkDetailsFromIface session iface linkable
-               return ([], Just $ HiFileResult ms hmi)
-             else regen linkableNeeded
-          (_reason, _) -> regen linkableNeeded
-
-mkDetailsFromIface :: HscEnv -> ModIface -> Maybe Linkable -> IO HomeModInfo
-mkDetailsFromIface session iface linkable = do
-  details <- liftIO $ fixIO $ \details -> do
-    let hsc' = session { hsc_HPT = addToHpt (hsc_HPT session) (moduleName $ mi_module iface) (HomeModInfo iface details linkable) }
-    initIfaceLoad hsc' (typecheckIface iface)
-  return (HomeModInfo iface details linkable)
-
--- | Non-interactive, batch version of 'InteractiveEval.getDocs'.
---   The interactive paths create problems in ghc-lib builds
---- and leads to fun errors like "Cannot continue after interface file error".
-getDocsBatch
-  :: HscEnv
-  -> Module  -- ^ a moudle where the names are in scope
-  -> [Name]
-  -> IO [Either String (Maybe HsDocString, Map.Map Int HsDocString)]
-getDocsBatch hsc_env _mod _names = do
-    ((_warns,errs), res) <- initTc hsc_env HsSrcFile False _mod fakeSpan $ forM _names $ \name ->
-        case nameModule_maybe name of
-            Nothing -> return (Left $ NameHasNoModule name)
-            Just mod -> do
-             ModIface { mi_doc_hdr = mb_doc_hdr
-                      , mi_decl_docs = DeclDocMap dmap
-                      , mi_arg_docs = ArgDocMap amap
-                      } <- loadModuleInterface "getModuleInterface" mod
-             if isNothing mb_doc_hdr && Map.null dmap && Map.null amap
-               then pure (Left (NoDocsInIface mod $ compiled name))
-               else pure (Right ( Map.lookup name dmap
-                                , Map.findWithDefault Map.empty name amap))
-    case res of
-        Just x -> return $ map (first $ T.unpack . showGhc) x
-        Nothing -> throwErrors errs
-  where
-    throwErrors = liftIO . throwIO . mkSrcErr
-    compiled n =
-      -- TODO: Find a more direct indicator.
-      case nameSrcLoc n of
-        RealSrcLoc {} -> False
-        UnhelpfulLoc {} -> True
-
-fakeSpan :: RealSrcSpan
-fakeSpan = realSrcLocSpan $ mkRealSrcLoc (fsLit "<ghcide>") 1 1
-
--- | Non-interactive, batch version of 'InteractiveEval.lookupNames'.
---   The interactive paths create problems in ghc-lib builds
---- and leads to fun errors like "Cannot continue after interface file error".
-lookupName :: HscEnv
-           -> Module -- ^ A module where the Names are in scope
-           -> Name
-           -> IO (Maybe TyThing)
-lookupName hsc_env mod name = do
-    (_messages, res) <- initTc hsc_env HsSrcFile False mod fakeSpan $ do
-        tcthing <- tcLookup name
-        case tcthing of
-            AGlobal thing    -> return thing
-            ATcId{tct_id=id} -> return (AnId id)
-            _ -> panic "tcRnLookupName'"
-    return res
+-- Copyright (c) 2019 The DAML Authors. All rights reserved.+-- SPDX-License-Identifier: Apache-2.0++{-# LANGUAGE CPP        #-}+{-# LANGUAGE GADTs      #-}+{-# LANGUAGE RankNTypes #-}+#include "ghc-api-version.h"++-- | Based on https://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/API.+--   Given a list of paths to find libraries, and a file to compile, produce a list of 'CoreModule' values.+module Development.IDE.Core.Compile+  ( TcModuleResult(..)+  , RunSimplifier(..)+  , compileModule+  , parseModule+  , typecheckModule+  , computePackageDeps+  , addRelativeImport+  , mkHiFileResultCompile+  , mkHiFileResultNoCompile+  , generateObjectCode+  , generateByteCode+  , generateHieAsts+  , writeAndIndexHieFile+  , indexHieFile+  , writeHiFile+  , getModSummaryFromImports+  , loadHieFile+  , loadInterface+  , loadModulesHome+  , setupFinderCache+  , getDocsBatch+  , lookupName+  ) where++import           Development.IDE.Core.Preprocessor+import           Development.IDE.Core.RuleTypes+import           Development.IDE.Core.Shake+import           Development.IDE.GHC.Error+import           Development.IDE.GHC.Orphans       ()+import           Development.IDE.GHC.Util+import           Development.IDE.GHC.Warnings+import           Development.IDE.Spans.Common+import           Development.IDE.Types.Diagnostics+import           Development.IDE.Types.Location+import           Development.IDE.Types.Options+import           Outputable                        hiding ((<>))++import           HieDb++import           Language.LSP.Types                (DiagnosticTag (..))++import           DriverPhases+import           DriverPipeline                    hiding (unP)+import           HscTypes+import           LoadIface                         (loadModuleInterface)++import           Lexer+import qualified Parser+#if MIN_GHC_API_VERSION(8,10,0)+import           Control.DeepSeq                   (force, rnf)+#else+import           Control.DeepSeq                   (rnf)+import           ErrUtils+#endif++import           Development.IDE.GHC.Compat        hiding (parseModule,+                                                    typecheckModule,+                                                    writeHieFile)+import qualified Development.IDE.GHC.Compat        as Compat+import qualified Development.IDE.GHC.Compat        as GHC+import           Finder+import           GhcMonad+import           GhcPlugins                        as GHC hiding (fst3, (<>))+import           Hooks+import           HscMain                           (hscDesugar, hscGenHardCode,+                                                    hscInteractive, hscSimplify,+                                                    hscTypecheckRename,+                                                    makeSimpleDetails)+import           MkIface+import           StringBuffer                      as SB+import           TcIface                           (typecheckIface)+import           TcRnMonad                         hiding (newUnique)+import           TcSplice+import           TidyPgm++import           Bag+import           Control.Exception                 (evaluate)+import           Control.Exception.Safe+import           Control.Lens                      hiding (List)+import           Control.Monad.Except+import           Control.Monad.Extra+import           Control.Monad.Trans.Except+import           Data.Bifunctor                    (first, second)+import qualified Data.ByteString                   as BS+import qualified Data.DList                        as DL+import           Data.IORef+import           Data.List.Extra+import qualified Data.Map.Strict                   as Map+import           Data.Maybe+import qualified Data.Text                         as T+import           Data.Time                         (UTCTime, getCurrentTime)+import qualified GHC.LanguageExtensions            as LangExt+import           HeaderInfo+import           Linker                            (unload)+import           Maybes                            (orElse)+import           PrelNames+import           System.Directory+import           System.FilePath+import           System.IO.Extra                   (fixIO, newTempFileWithin)+import           TcEnv                             (tcLookup)++import           Control.Concurrent.Extra+import           Control.Concurrent.STM            hiding (orElse)+import           Data.Aeson                        (toJSON)+import           Data.Binary+import           Data.Coerce+import           Data.Functor+import qualified Data.HashMap.Strict               as HashMap+import           Data.Tuple.Extra                  (dupe)+import           Data.Unique+import           GHC.Fingerprint+import qualified Language.LSP.Server               as LSP+import qualified Language.LSP.Types                as LSP++-- | Given a string buffer, return the string (after preprocessing) and the 'ParsedModule'.+parseModule+    :: IdeOptions+    -> HscEnv+    -> FilePath+    -> ModSummary+    -> IO (IdeResult ParsedModule)+parseModule IdeOptions{..} env filename ms =+    fmap (either (, Nothing) id) $+    runExceptT $ do+        (diag, modu) <- parseFileContents env optPreprocessor filename ms+        return (diag, Just modu)+++-- | Given a package identifier, what packages does it depend on+computePackageDeps+    :: HscEnv+    -> InstalledUnitId+    -> IO (Either [FileDiagnostic] [InstalledUnitId])+computePackageDeps env pkg = do+    let dflags = hsc_dflags env+    case lookupInstalledPackage dflags pkg of+        Nothing -> return $ Left [ideErrorText (toNormalizedFilePath' noFilePath) $+            T.pack $ "unknown package: " ++ show pkg]+        Just pkgInfo -> return $ Right $ depends pkgInfo++typecheckModule :: IdeDefer+                -> HscEnv+                -> [Linkable] -- ^ linkables not to unload+                -> ParsedModule+                -> IO (IdeResult TcModuleResult)+typecheckModule (IdeDefer defer) hsc keep_lbls pm = do+    fmap (either (,Nothing) id) $+      catchSrcErrors (hsc_dflags hsc) "typecheck" $ do++        let modSummary = pm_mod_summary pm+            dflags = ms_hspp_opts modSummary++        modSummary' <- initPlugins hsc modSummary+        (warnings, tcm) <- withWarnings "typecheck" $ \tweak ->+            tcRnModule hsc keep_lbls $ demoteIfDefer pm{pm_mod_summary = tweak modSummary'}+        let errorPipeline = unDefer . hideDiag dflags . tagDiag+            diags = map errorPipeline warnings+            deferedError = any fst diags+        return (map snd diags, Just $ tcm{tmrDeferedError = deferedError})+    where+        demoteIfDefer = if defer then demoteTypeErrorsToWarnings else id++-- | Add a Hook to the DynFlags which captures and returns the+-- typechecked splices before they are run. This information+-- is used for hover.+captureSplices :: DynFlags -> (DynFlags -> IO a) -> IO (a, Splices)+captureSplices dflags k = do+  splice_ref <- newIORef mempty+  res <- k (dflags { hooks = addSpliceHook splice_ref (hooks dflags)})+  splices <- readIORef splice_ref+  return (res, splices)+  where+    addSpliceHook :: IORef Splices -> Hooks -> Hooks+    addSpliceHook var h = h { runMetaHook = Just (splice_hook (runMetaHook h) var) }++    splice_hook :: Maybe (MetaHook TcM) -> IORef Splices -> MetaHook TcM+    splice_hook (fromMaybe defaultRunMeta -> hook) var metaReq e = case metaReq of+        (MetaE f) -> do+            expr' <- metaRequestE hook e+            liftIO $ modifyIORef' var $ exprSplicesL %~ ((e, expr') :)+            pure $ f expr'+        (MetaP f) -> do+            pat' <- metaRequestP hook e+            liftIO $ modifyIORef' var $ patSplicesL %~ ((e, pat') :)+            pure $ f pat'+        (MetaT f) -> do+            type' <- metaRequestT hook e+            liftIO $ modifyIORef' var $ typeSplicesL %~ ((e, type') :)+            pure $ f type'+        (MetaD f) -> do+            decl' <- metaRequestD hook e+            liftIO $ modifyIORef' var $ declSplicesL %~ ((e, decl') :)+            pure $ f decl'+        (MetaAW f) -> do+            aw' <- metaRequestAW hook e+            liftIO $ modifyIORef' var $ awSplicesL %~ ((e, aw') :)+            pure $ f aw'+++tcRnModule :: HscEnv -> [Linkable] -> ParsedModule -> IO TcModuleResult+tcRnModule hsc_env keep_lbls pmod = do+  let ms = pm_mod_summary pmod+      hsc_env_tmp = hsc_env { hsc_dflags = ms_hspp_opts ms }++  unload hsc_env_tmp keep_lbls++  ((tc_gbl_env, mrn_info), splices)+      <- liftIO $ captureSplices (ms_hspp_opts ms) $ \dflags ->+             do  let hsc_env_tmp = hsc_env { hsc_dflags = dflags }+                 hscTypecheckRename hsc_env_tmp ms $+                          HsParsedModule { hpm_module = parsedSource pmod,+                                           hpm_src_files = pm_extra_src_files pmod,+                                           hpm_annotations = pm_annotations pmod }+  let rn_info = case mrn_info of+        Just x  -> x+        Nothing -> error "no renamed info tcRnModule"+  pure (TcModuleResult pmod rn_info tc_gbl_env splices False)++mkHiFileResultNoCompile :: HscEnv -> TcModuleResult -> IO HiFileResult+mkHiFileResultNoCompile session tcm = do+  let hsc_env_tmp = session { hsc_dflags = ms_hspp_opts ms }+      ms = pm_mod_summary $ tmrParsed tcm+      tcGblEnv = tmrTypechecked tcm+  details <- makeSimpleDetails hsc_env_tmp tcGblEnv+  sf <- finalSafeMode (ms_hspp_opts ms) tcGblEnv+#if MIN_GHC_API_VERSION(8,10,0)+  iface <- mkIfaceTc hsc_env_tmp sf details tcGblEnv+#else+  (iface, _) <- mkIfaceTc hsc_env_tmp Nothing sf details tcGblEnv+#endif+  let mod_info = HomeModInfo iface details Nothing+  pure $! mkHiFileResult ms mod_info++mkHiFileResultCompile+    :: HscEnv+    -> TcModuleResult+    -> ModGuts+    -> LinkableType -- ^ use object code or byte code?+    -> IO (IdeResult HiFileResult)+mkHiFileResultCompile session' tcm simplified_guts ltype = catchErrs $ do+  let session = session' { hsc_dflags = ms_hspp_opts ms }+      ms = pm_mod_summary $ tmrParsed tcm+      tcGblEnv = tmrTypechecked tcm++  let genLinkable = case ltype of+        ObjectLinkable -> generateObjectCode+        BCOLinkable    -> generateByteCode++  (linkable, details, diags) <-+    if mg_hsc_src simplified_guts == HsBootFile+    then do+        -- give variables unique OccNames+        details <- mkBootModDetailsTc session tcGblEnv+        pure (Nothing, details, [])+    else do+        -- give variables unique OccNames+        (guts, details) <- tidyProgram session simplified_guts+        (diags, linkable) <- genLinkable session ms guts+        pure (linkable, details, diags)+#if MIN_GHC_API_VERSION(8,10,0)+  let !partial_iface = force (mkPartialIface session details simplified_guts)+  final_iface <- mkFullIface session partial_iface+#else+  (final_iface,_) <- mkIface session Nothing details simplified_guts+#endif+  let mod_info = HomeModInfo final_iface details linkable+  pure (diags, Just $! mkHiFileResult ms mod_info)++  where+    dflags = hsc_dflags session'+    source = "compile"+    catchErrs x = x `catches`+      [ Handler $ return . (,Nothing) . diagFromGhcException source dflags+      , Handler $ return . (,Nothing) . diagFromString source DsError (noSpan "<internal>")+      . (("Error during " ++ T.unpack source) ++) . show @SomeException+      ]++initPlugins :: HscEnv -> ModSummary -> IO ModSummary+initPlugins session modSummary = do+    dflags <- liftIO $ initializePlugins session $ ms_hspp_opts modSummary+    return modSummary{ms_hspp_opts = dflags}++-- | Whether we should run the -O0 simplifier when generating core.+--+-- This is required for template Haskell to work but we disable this in DAML.+-- See #256+newtype RunSimplifier = RunSimplifier Bool++-- | Compile a single type-checked module to a 'CoreModule' value, or+-- provide errors.+compileModule+    :: RunSimplifier+    -> HscEnv+    -> ModSummary+    -> TcGblEnv+    -> IO (IdeResult ModGuts)+compileModule (RunSimplifier simplify) session ms tcg =+    fmap (either (, Nothing) (second Just)) $+        catchSrcErrors (hsc_dflags session) "compile" $ do+            (warnings,desugared_guts) <- withWarnings "compile" $ \tweak -> do+               let ms' = tweak ms+                   session' = session{ hsc_dflags = ms_hspp_opts ms'}+               desugar <- hscDesugar session' ms' tcg+               if simplify+               then do+                 plugins <- readIORef (tcg_th_coreplugins tcg)+                 hscSimplify session' plugins desugar+               else pure desugar+            return (map snd warnings, desugared_guts)++generateObjectCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable)+generateObjectCode session summary guts = do+    fmap (either (, Nothing) (second Just)) $+          catchSrcErrors (hsc_dflags session) "object" $ do+              let dot_o =  ml_obj_file (ms_location summary)+                  mod = ms_mod summary+                  fp = replaceExtension dot_o "s"+              createDirectoryIfMissing True (takeDirectory fp)+              (warnings, dot_o_fp) <-+                withWarnings "object" $ \_tweak -> do+                      let summary' = _tweak summary+#if MIN_GHC_API_VERSION(8,10,0)+                          target = defaultObjectTarget $ hsc_dflags session+#else+                          target = defaultObjectTarget $ targetPlatform $ hsc_dflags session+#endif+                          session' = session { hsc_dflags = updOptLevel 0 $ (ms_hspp_opts summary') { outputFile = Just dot_o , hscTarget = target}}+                      (outputFilename, _mStub, _foreign_files) <- hscGenHardCode session' guts+#if MIN_GHC_API_VERSION(8,10,0)+                                (ms_location summary')+#else+                                summary'+#endif+                                fp+                      compileFile session' StopLn (outputFilename, Just (As False))+              let unlinked = DotO dot_o_fp+              -- Need time to be the modification time for recompilation checking+              t <- liftIO $ getModificationTime dot_o_fp+              let linkable = LM t mod [unlinked]++              pure (map snd warnings, linkable)++generateByteCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable)+generateByteCode hscEnv summary guts = do+    fmap (either (, Nothing) (second Just)) $+          catchSrcErrors (hsc_dflags hscEnv) "bytecode" $ do+              (warnings, (_, bytecode, sptEntries)) <-+                withWarnings "bytecode" $ \_tweak -> do+                      let summary' = _tweak summary+                          session = hscEnv { hsc_dflags = ms_hspp_opts summary' }+                      hscInteractive session guts+#if MIN_GHC_API_VERSION(8,10,0)+                                (ms_location summary')+#else+                                summary'+#endif+              let unlinked = BCOs bytecode sptEntries+              time <- liftIO getCurrentTime+              let linkable = LM time (ms_mod summary) [unlinked]++              pure (map snd warnings, linkable)++demoteTypeErrorsToWarnings :: ParsedModule -> ParsedModule+demoteTypeErrorsToWarnings =+  (update_pm_mod_summary . update_hspp_opts) demoteTEsToWarns where++  demoteTEsToWarns :: DynFlags -> DynFlags+  -- convert the errors into warnings, and also check the warnings are enabled+  demoteTEsToWarns = (`wopt_set` Opt_WarnDeferredTypeErrors)+                   . (`wopt_set` Opt_WarnTypedHoles)+                   . (`wopt_set` Opt_WarnDeferredOutOfScopeVariables)+                   . (`gopt_set` Opt_DeferTypeErrors)+                   . (`gopt_set` Opt_DeferTypedHoles)+                   . (`gopt_set` Opt_DeferOutOfScopeVariables)++update_hspp_opts :: (DynFlags -> DynFlags) -> ModSummary -> ModSummary+update_hspp_opts up ms = ms{ms_hspp_opts = up $ ms_hspp_opts ms}++update_pm_mod_summary :: (ModSummary -> ModSummary) -> ParsedModule -> ParsedModule+update_pm_mod_summary up pm =+  pm{pm_mod_summary = up $ pm_mod_summary pm}++unDefer :: (WarnReason, FileDiagnostic) -> (Bool, FileDiagnostic)+unDefer (Reason Opt_WarnDeferredTypeErrors         , fd) = (True, upgradeWarningToError fd)+unDefer (Reason Opt_WarnTypedHoles                 , fd) = (True, upgradeWarningToError fd)+unDefer (Reason Opt_WarnDeferredOutOfScopeVariables, fd) = (True, upgradeWarningToError fd)+unDefer ( _                                        , fd) = (False, fd)++upgradeWarningToError :: FileDiagnostic -> FileDiagnostic+upgradeWarningToError (nfp, sh, fd) =+  (nfp, sh, fd{_severity = Just DsError, _message = warn2err $ _message fd}) where+  warn2err :: T.Text -> T.Text+  warn2err = T.intercalate ": error:" . T.splitOn ": warning:"++hideDiag :: DynFlags -> (WarnReason, FileDiagnostic) -> (WarnReason, FileDiagnostic)+hideDiag originalFlags (Reason warning, (nfp, _sh, fd))+  | not (wopt warning originalFlags)+  = (Reason warning, (nfp, HideDiag, fd))+hideDiag _originalFlags t = t++-- | Warnings which lead to a diagnostic tag+unnecessaryDeprecationWarningFlags :: [WarningFlag]+unnecessaryDeprecationWarningFlags+  = [ Opt_WarnUnusedTopBinds+    , Opt_WarnUnusedLocalBinds+    , Opt_WarnUnusedPatternBinds+    , Opt_WarnUnusedImports+    , Opt_WarnUnusedMatches+    , Opt_WarnUnusedTypePatterns+    , Opt_WarnUnusedForalls+#if MIN_GHC_API_VERSION(8,10,0)+    , Opt_WarnUnusedRecordWildcards+#endif+    , Opt_WarnInaccessibleCode+    , Opt_WarnWarningsDeprecations+    ]++-- | Add a unnecessary/deprecated tag to the required diagnostics.+tagDiag :: (WarnReason, FileDiagnostic) -> (WarnReason, FileDiagnostic)+tagDiag (Reason warning, (nfp, sh, fd))+  | Just tag <- requiresTag warning+  = (Reason warning, (nfp, sh, fd { _tags = addTag tag (_tags fd) }))+  where+    requiresTag :: WarningFlag -> Maybe DiagnosticTag+    requiresTag Opt_WarnWarningsDeprecations+      = Just DtDeprecated+    requiresTag wflag  -- deprecation was already considered above+      | wflag `elem` unnecessaryDeprecationWarningFlags+      = Just DtUnnecessary+    requiresTag _ = Nothing+    addTag :: DiagnosticTag -> Maybe (List DiagnosticTag) -> Maybe (List DiagnosticTag)+    addTag t Nothing          = Just (List [t])+    addTag t (Just (List ts)) = Just (List (t : ts))+-- other diagnostics are left unaffected+tagDiag t = t++addRelativeImport :: NormalizedFilePath -> ModuleName -> DynFlags -> DynFlags+addRelativeImport fp modu dflags = dflags+    {importPaths = nubOrd $ maybeToList (moduleImportPath fp modu) ++ importPaths dflags}++atomicFileWrite :: FilePath -> (FilePath -> IO a) -> IO ()+atomicFileWrite targetPath write = do+  let dir = takeDirectory targetPath+  createDirectoryIfMissing True dir+  (tempFilePath, cleanUp) <- newTempFileWithin dir+  (write tempFilePath >> renameFile tempFilePath targetPath) `onException` cleanUp++generateHieAsts :: HscEnv -> TcModuleResult -> IO ([FileDiagnostic], Maybe (HieASTs Type))+generateHieAsts hscEnv tcm =+  handleGenerationErrors' dflags "extended interface generation" $ runHsc hscEnv $ do+    -- These varBinds use unitDataConId but it could be anything as the id name is not used+    -- during the hie file generation process. It's a workaround for the fact that the hie modules+    -- don't export an interface which allows for additional information to be added to hie files.+    let fake_splice_binds = listToBag (map (mkVarBind unitDataConId) (spliceExpresions $ tmrTopLevelSplices tcm))+        real_binds = tcg_binds $ tmrTypechecked tcm+    Just <$> GHC.enrichHie (fake_splice_binds `unionBags` real_binds) (tmrRenamed tcm)+  where+    dflags = hsc_dflags hscEnv++spliceExpresions :: Splices -> [LHsExpr GhcTc]+spliceExpresions Splices{..} =+    DL.toList $ mconcat+        [ DL.fromList $ map fst exprSplices+        , DL.fromList $ map fst patSplices+        , DL.fromList $ map fst typeSplices+        , DL.fromList $ map fst declSplices+        , DL.fromList $ map fst awSplices+        ]++-- | In addition to indexing the `.hie` file, this function is responsible for+-- maintaining the 'IndexQueue' state and notfiying the user about indexing+-- progress.+--+-- We maintain a record of all pending index operations in the 'indexPending'+-- TVar.+-- When 'indexHieFile' is called, it must check to ensure that the file hasn't+-- already be queued up for indexing. If it has, then we can just skip it+--+-- Otherwise, we record the current file as pending and write an indexing+-- operation to the queue+--+-- When the indexing operation is picked up and executed by the worker thread,+-- the first thing it does is ensure that a newer index for the same file hasn't+-- been scheduled by looking at 'indexPending'. If a newer index has been+-- scheduled, we can safely skip this one+--+-- Otherwise, we start or continue a progress reporting session, telling it+-- about progress so far and the current file we are attempting to index. Then+-- we can go ahead and call in to hiedb to actually do the indexing operation+--+-- Once this completes, we have to update the 'IndexQueue' state. First, we+-- must remove the just indexed file from 'indexPending' Then we check if+-- 'indexPending' is now empty. In that case, we end the progress session and+-- report the total number of file indexed. We also set the 'indexCompleted'+-- TVar to 0 in order to set it up for a fresh indexing session. Otherwise, we+-- can just increment the 'indexCompleted' TVar and exit.+--+indexHieFile :: ShakeExtras -> ModSummary -> NormalizedFilePath -> Fingerprint -> Compat.HieFile -> IO ()+indexHieFile se mod_summary srcPath hash hf = atomically $ do+  pending <- readTVar indexPending+  case HashMap.lookup srcPath pending of+    Just pendingHash | pendingHash == hash -> pure () -- An index is already scheduled+    _ -> do+      modifyTVar' indexPending $ HashMap.insert srcPath hash+      writeTQueue indexQueue $ \db -> do+        -- We are now in the worker thread+        -- Check if a newer index of this file has been scheduled, and if so skip this one+        newerScheduled <- atomically $ do+          pending <- readTVar indexPending+          pure $ case HashMap.lookup srcPath pending of+            Nothing          -> False+            -- If the hash in the pending list doesn't match the current hash, then skip+            Just pendingHash -> pendingHash /= hash+        unless newerScheduled $ do+          pre+          addRefsFromLoaded db targetPath (RealFile $ fromNormalizedFilePath srcPath) hash hf+          post+  where+    mod_location    = ms_location mod_summary+    targetPath      = Compat.ml_hie_file mod_location+    HieDbWriter{..} = hiedbWriter se++    -- Get a progress token to report progress and update it for the current file+    pre = do+      tok <- modifyVar indexProgressToken $ fmap dupe . \case+        x@(Just _) -> pure x+        -- Create a token if we don't already have one+        Nothing -> do+          case lspEnv se of+            Nothing -> pure Nothing+            Just env -> LSP.runLspT env $ do+              u <- LSP.ProgressTextToken . T.pack . show . hashUnique <$> liftIO newUnique+              -- TODO: Wait for the progress create response to use the token+              _ <- LSP.sendRequest LSP.SWindowWorkDoneProgressCreate (LSP.WorkDoneProgressCreateParams u) (const $ pure ())+              LSP.sendNotification LSP.SProgress $ LSP.ProgressParams u $+                LSP.Begin $ LSP.WorkDoneProgressBeginParams+                  { _title = "Indexing references from:"+                  , _cancellable = Nothing+                  , _message = Nothing+                  , _percentage = Nothing+                  }+              pure (Just u)++      (!done, !remaining) <- atomically $ do+        done <- readTVar indexCompleted+        remaining <- HashMap.size <$> readTVar indexPending+        pure (done, remaining)++      let progress = " (" <> T.pack (show done) <> "/" <> T.pack (show $ done + remaining) <> ")..."++      whenJust (lspEnv se) $ \env -> whenJust tok $ \tok -> LSP.runLspT env $+        LSP.sendNotification LSP.SProgress $ LSP.ProgressParams tok $+          LSP.Report $ LSP.WorkDoneProgressReportParams+            { _cancellable = Nothing+            , _message = Just $ T.pack (fromNormalizedFilePath srcPath) <> progress+            , _percentage = Nothing+            }++    -- Report the progress once we are done indexing this file+    post = do+      mdone <- atomically $ do+        -- Remove current element from pending+        pending <- stateTVar indexPending $+          dupe . HashMap.update (\pendingHash -> guard (pendingHash /= hash) $> pendingHash) srcPath+        modifyTVar' indexCompleted (+1)+        -- If we are done, report and reset completed+        whenMaybe (HashMap.null pending) $+          swapTVar indexCompleted 0+      whenJust (lspEnv se) $ \env -> LSP.runLspT env $+        when (coerce $ ideTesting se) $+          LSP.sendNotification (LSP.SCustomMethod "ghcide/reference/ready") $+            toJSON $ fromNormalizedFilePath srcPath+      whenJust mdone $ \done ->+        modifyVar_ indexProgressToken $ \tok -> do+          whenJust (lspEnv se) $ \env -> LSP.runLspT env $+            whenJust tok $ \tok ->+              LSP.sendNotification LSP.SProgress $ LSP.ProgressParams tok $+                LSP.End $ LSP.WorkDoneProgressEndParams+                  { _message = Just $ "Finished indexing " <> T.pack (show done) <> " files"+                  }+          -- We are done with the current indexing cycle, so destroy the token+          pure Nothing++writeAndIndexHieFile :: HscEnv -> ShakeExtras -> ModSummary -> NormalizedFilePath -> [GHC.AvailInfo] -> HieASTs Type -> BS.ByteString -> IO [FileDiagnostic]+writeAndIndexHieFile hscEnv se mod_summary srcPath exports ast source =+  handleGenerationErrors dflags "extended interface write/compression" $ do+    hf <- runHsc hscEnv $+      GHC.mkHieFile' mod_summary exports ast source+    atomicFileWrite targetPath $ flip GHC.writeHieFile hf+    hash <- getFileHash targetPath+    indexHieFile se mod_summary srcPath hash hf+  where+    dflags       = hsc_dflags hscEnv+    mod_location = ms_location mod_summary+    targetPath   = Compat.ml_hie_file mod_location++writeHiFile :: HscEnv -> HiFileResult -> IO [FileDiagnostic]+writeHiFile hscEnv tc =+  handleGenerationErrors dflags "interface write" $ do+    atomicFileWrite targetPath $ \fp ->+      writeIfaceFile dflags fp modIface+  where+    modIface = hm_iface $ hirHomeMod tc+    targetPath = ml_hi_file $ ms_location $ hirModSummary tc+    dflags = hsc_dflags hscEnv++handleGenerationErrors :: DynFlags -> T.Text -> IO () -> IO [FileDiagnostic]+handleGenerationErrors dflags source action =+  action >> return [] `catches`+    [ Handler $ return . diagFromGhcException source dflags+    , Handler $ return . diagFromString source DsError (noSpan "<internal>")+    . (("Error during " ++ T.unpack source) ++) . show @SomeException+    ]++handleGenerationErrors' :: DynFlags -> T.Text -> IO (Maybe a) -> IO ([FileDiagnostic], Maybe a)+handleGenerationErrors' dflags source action =+  fmap ([],) action `catches`+    [ Handler $ return . (,Nothing) . diagFromGhcException source dflags+    , Handler $ return . (,Nothing) . diagFromString source DsError (noSpan "<internal>")+    . (("Error during " ++ T.unpack source) ++) . show @SomeException+    ]++-- | Initialise the finder cache, dependencies should be topologically+-- sorted.+setupFinderCache :: [ModSummary] -> HscEnv -> IO HscEnv+setupFinderCache mss session = do++    -- Make modules available for others that import them,+    -- by putting them in the finder cache.+    let ims  = map (InstalledModule (thisInstalledUnitId $ hsc_dflags session) . moduleName . ms_mod) mss+        ifrs = zipWith (\ms -> InstalledFound (ms_location ms)) mss ims+    -- set the target and module graph in the session+        graph = mkModuleGraph mss++    -- We have to create a new IORef here instead of modifying the existing IORef as+    -- it is shared between concurrent compilations.+    prevFinderCache <- readIORef $ hsc_FC session+    let newFinderCache =+            foldl'+                (\fc (im, ifr) -> GHC.extendInstalledModuleEnv fc im ifr) prevFinderCache+                $ zip ims ifrs+    newFinderCacheVar <- newIORef $! newFinderCache++    pure $ session { hsc_FC = newFinderCacheVar, hsc_mod_graph = graph }+++-- | Load modules, quickly. Input doesn't need to be desugared.+-- A module must be loaded before dependent modules can be typechecked.+-- This variant of loadModuleHome will *never* cause recompilation, it just+-- modifies the session.+-- The order modules are loaded is important when there are hs-boot files.+-- In particular you should make sure to load the .hs version of a file after the+-- .hs-boot version.+loadModulesHome+    :: [HomeModInfo]+    -> HscEnv+    -> HscEnv+loadModulesHome mod_infos e =+    e { hsc_HPT = addListToHpt (hsc_HPT e) [(mod_name x, x) | x <- mod_infos]+      , hsc_type_env_var = Nothing }+    where+      mod_name = moduleName . mi_module . hm_iface++withBootSuffix :: HscSource -> ModLocation -> ModLocation+withBootSuffix HsBootFile = addBootSuffixLocnOut+withBootSuffix _          = id++-- | Given a buffer, env and filepath, produce a module summary by parsing only the imports.+--   Runs preprocessors as needed.+getModSummaryFromImports+  :: HscEnv+  -> FilePath+  -> UTCTime+  -> Maybe SB.StringBuffer+  -> ExceptT [FileDiagnostic] IO ModSummaryResult+getModSummaryFromImports env fp modTime contents = do+    (contents, opts, dflags) <- preprocessor env fp contents++    -- The warns will hopefully be reported when we actually parse the module+    (_warns, L main_loc hsmod) <- parseHeader dflags fp contents++    -- Copied from `HeaderInfo.getImports`, but we also need to keep the parsed imports+    let mb_mod = hsmodName hsmod+        imps = hsmodImports hsmod++        mod = fmap unLoc mb_mod `orElse` mAIN_NAME++        (src_idecls, ord_idecls) = partition (ideclSource.unLoc) imps++        -- GHC.Prim doesn't exist physically, so don't go looking for it.+        ordinary_imps = filter ((/= moduleName gHC_PRIM) . unLoc+                                . ideclName . unLoc)+                               ord_idecls++        implicit_prelude = xopt LangExt.ImplicitPrelude dflags+        implicit_imports = mkPrelImports mod main_loc+                                         implicit_prelude imps+        convImport (L _ i) = (fmap sl_fs (ideclPkgQual i)+                                         , ideclName i)++        srcImports = map convImport src_idecls+        textualImports = map convImport (implicit_imports ++ ordinary_imps)++        msrImports = implicit_imports ++ imps++    -- Force bits that might keep the string buffer and DynFlags alive unnecessarily+    liftIO $ evaluate $ rnf srcImports+    liftIO $ evaluate $ rnf textualImports++    modLoc <- liftIO $ mkHomeModLocation dflags mod fp++    let modl = mkModule (thisPackage dflags) mod+        sourceType = if "-boot" `isSuffixOf` takeExtension fp then HsBootFile else HsSrcFile+        msrModSummary =+            ModSummary+                { ms_mod          = modl+#if MIN_GHC_API_VERSION(8,8,0)+                , ms_hie_date     = Nothing+#endif+                , ms_hs_date      = modTime+                , ms_hsc_src      = sourceType+                -- The contents are used by the GetModSummary rule+                , ms_hspp_buf     = Just contents+                , ms_hspp_file    = fp+                , ms_hspp_opts    = dflags+                , ms_iface_date   = Nothing+                , ms_location     = withBootSuffix sourceType modLoc+                , ms_obj_date     = Nothing+                , ms_parsed_mod   = Nothing+                , ms_srcimps      = srcImports+                , ms_textual_imps = textualImports+                }++    msrFingerprint <- liftIO $ computeFingerprint opts msrModSummary+    return ModSummaryResult{..}+    where+        -- Compute a fingerprint from the contents of `ModSummary`,+        -- eliding the timestamps, the preprocessed source and other non relevant fields+        computeFingerprint opts ModSummary{..} = do+            fingerPrintImports <- fingerprintFromPut $ do+                  put $ uniq $ moduleNameFS $ moduleName ms_mod+                  forM_ (ms_srcimps ++ ms_textual_imps) $ \(mb_p, m) -> do+                    put $ uniq $ moduleNameFS $ unLoc m+                    whenJust mb_p $ put . uniq+            return $! fingerprintFingerprints $+                    [ fingerprintString fp+                    , fingerPrintImports+                    ] ++ map fingerprintString opts+++-- | Parse only the module header+parseHeader+       :: Monad m+       => DynFlags -- ^ flags to use+       -> FilePath  -- ^ the filename (for source locations)+       -> SB.StringBuffer -- ^ Haskell module source text (full Unicode is supported)+       -> ExceptT [FileDiagnostic] m ([FileDiagnostic], Located(HsModule GhcPs))+parseHeader dflags filename contents = do+   let loc  = mkRealSrcLoc (mkFastString filename) 1 1+   case unP Parser.parseHeader (mkPState dflags contents loc) of+#if MIN_GHC_API_VERSION(8,10,0)+     PFailed pst ->+        throwE $ diagFromErrMsgs "parser" dflags $ getErrorMessages pst dflags+#else+     PFailed _ locErr msgErr ->+        throwE $ diagFromErrMsg "parser" dflags $ mkPlainErrMsg dflags locErr msgErr+#endif+     POk pst rdr_module -> do+        let (warns, errs) = getMessages pst dflags+        -- Just because we got a `POk`, it doesn't mean there+        -- weren't errors! To clarify, the GHC parser+        -- distinguishes between fatal and non-fatal+        -- errors. Non-fatal errors are the sort that don't+        -- prevent parsing from continuing (that is, a parse+        -- tree can still be produced despite the error so that+        -- further errors/warnings can be collected). Fatal+        -- errors are those from which a parse tree just can't+        -- be produced.+        unless (null errs) $+            throwE $ diagFromErrMsgs "parser" dflags errs++        let warnings = diagFromErrMsgs "parser" dflags warns+        return (warnings, rdr_module)++-- | Given a buffer, flags, and file path, produce a+-- parsed module (or errors) and any parse warnings. Does not run any preprocessors+-- ModSummary must contain the (preprocessed) contents of the buffer+parseFileContents+       :: HscEnv+       -> (GHC.ParsedSource -> IdePreprocessedSource)+       -> FilePath  -- ^ the filename (for source locations)+       -> ModSummary+       -> ExceptT [FileDiagnostic] IO ([FileDiagnostic], ParsedModule)+parseFileContents env customPreprocessor filename ms = do+   let loc  = mkRealSrcLoc (mkFastString filename) 1 1+       dflags = ms_hspp_opts ms+       contents = fromJust $ ms_hspp_buf ms+   case unP Parser.parseModule (mkPState dflags contents loc) of+#if MIN_GHC_API_VERSION(8,10,0)+     PFailed pst -> throwE $ diagFromErrMsgs "parser" dflags $ getErrorMessages pst dflags+#else+     PFailed _ locErr msgErr ->+      throwE $ diagFromErrMsg "parser" dflags $ mkPlainErrMsg dflags locErr msgErr+#endif+     POk pst rdr_module ->+         let hpm_annotations =+               (Map.fromListWith (++) $ annotations pst,+                 Map.fromList ((noSrcSpan,comment_q pst)+                                  :annotations_comments pst))+             (warns, errs) = getMessages pst dflags+         in+           do+               -- Just because we got a `POk`, it doesn't mean there+               -- weren't errors! To clarify, the GHC parser+               -- distinguishes between fatal and non-fatal+               -- errors. Non-fatal errors are the sort that don't+               -- prevent parsing from continuing (that is, a parse+               -- tree can still be produced despite the error so that+               -- further errors/warnings can be collected). Fatal+               -- errors are those from which a parse tree just can't+               -- be produced.+               unless (null errs) $+                 throwE $ diagFromErrMsgs "parser" dflags errs++               -- Ok, we got here. It's safe to continue.+               let IdePreprocessedSource preproc_warns errs parsed = customPreprocessor rdr_module++               unless (null errs) $+                  throwE $ diagFromStrings "parser" DsError errs++               let preproc_warnings = diagFromStrings "parser" DsWarning preproc_warns+               parsed' <- liftIO $ applyPluginsParsedResultAction env dflags ms hpm_annotations parsed++               -- To get the list of extra source files, we take the list+               -- that the parser gave us,+               --   - eliminate files beginning with '<'.  gcc likes to use+               --     pseudo-filenames like "<built-in>" and "<command-line>"+               --   - normalise them (eliminate differences between ./f and f)+               --   - filter out the preprocessed source file+               --   - filter out anything beginning with tmpdir+               --   - remove duplicates+               --   - filter out the .hs/.lhs source filename if we have one+               --+               let n_hspp  = normalise filename+                   srcs0 = nubOrd $ filter (not . (tmpDir dflags `isPrefixOf`))+                                  $ filter (/= n_hspp)+                                  $ map normalise+                                  $ filter (not . isPrefixOf "<")+                                  $ map unpackFS+                                  $ srcfiles pst+                   srcs1 = case ml_hs_file (ms_location ms) of+                             Just f  -> filter (/= normalise f) srcs0+                             Nothing -> srcs0++               -- sometimes we see source files from earlier+               -- preprocessing stages that cannot be found, so just+               -- filter them out:+               srcs2 <- liftIO $ filterM doesFileExist srcs1++               let pm =+                     ParsedModule {+                         pm_mod_summary = ms+                       , pm_parsed_source = parsed'+                       , pm_extra_src_files = srcs2+                       , pm_annotations = hpm_annotations+                      }+                   warnings = diagFromErrMsgs "parser" dflags warns+               pure (warnings ++ preproc_warnings, pm)++loadHieFile :: Compat.NameCacheUpdater -> FilePath -> IO GHC.HieFile+loadHieFile ncu f = do+  GHC.hie_file_result <$> GHC.readHieFile ncu f++-- | Retuns an up-to-date module interface, regenerating if needed.+--   Assumes file exists.+--   Requires the 'HscEnv' to be set up with dependencies+loadInterface+  :: MonadIO m => HscEnv+  -> ModSummary+  -> SourceModified+  -> Maybe LinkableType+  -> (Maybe LinkableType -> m ([FileDiagnostic], Maybe HiFileResult)) -- ^ Action to regenerate an interface+  -> m ([FileDiagnostic], Maybe HiFileResult)+loadInterface session ms sourceMod linkableNeeded regen = do+    let sessionWithMsDynFlags = session{hsc_dflags = ms_hspp_opts ms}+    res <- liftIO $ checkOldIface sessionWithMsDynFlags ms sourceMod Nothing+    case res of+          (UpToDate, Just iface)+            -- If the module used TH splices when it was last+            -- compiled, then the recompilation check is not+            -- accurate enough (https://gitlab.haskell.org/ghc/ghc/-/issues/481)+            -- and we must ignore+            -- it.  However, if the module is stable (none of+            -- the modules it depends on, directly or+            -- indirectly, changed), then we *can* skip+            -- recompilation. This is why the SourceModified+            -- type contains SourceUnmodifiedAndStable, and+            -- it's pretty important: otherwise ghc --make+            -- would always recompile TH modules, even if+            -- nothing at all has changed. Stability is just+            -- the same check that make is doing for us in+            -- one-shot mode.+            | not (mi_used_th iface) || SourceUnmodifiedAndStable == sourceMod+            -> do+             linkable <- case linkableNeeded of+               Just ObjectLinkable -> liftIO $ findObjectLinkableMaybe (ms_mod ms) (ms_location ms)+               _ -> pure Nothing++             -- We don't need to regenerate if the object is up do date, or we don't need one+             let objUpToDate = isNothing linkableNeeded || case linkable of+                   Nothing                -> False+                   Just (LM obj_time _ _) -> obj_time > ms_hs_date ms+             if objUpToDate+             then do+               hmi <- liftIO $ mkDetailsFromIface sessionWithMsDynFlags iface linkable+               return ([], Just $ mkHiFileResult ms hmi)+             else regen linkableNeeded+          (_reason, _) -> regen linkableNeeded++mkDetailsFromIface :: HscEnv -> ModIface -> Maybe Linkable -> IO HomeModInfo+mkDetailsFromIface session iface linkable = do+  details <- liftIO $ fixIO $ \details -> do+    let hsc' = session { hsc_HPT = addToHpt (hsc_HPT session) (moduleName $ mi_module iface) (HomeModInfo iface details linkable) }+    initIfaceLoad hsc' (typecheckIface iface)+  return (HomeModInfo iface details linkable)++-- | Non-interactive, batch version of 'InteractiveEval.getDocs'.+--   The interactive paths create problems in ghc-lib builds+--- and leads to fun errors like "Cannot continue after interface file error".+getDocsBatch+  :: HscEnv+  -> Module  -- ^ a moudle where the names are in scope+  -> [Name]+  -> IO [Either String (Maybe HsDocString, Map.Map Int HsDocString)]+getDocsBatch hsc_env _mod _names = do+    ((_warns,errs), res) <- initTc hsc_env HsSrcFile False _mod fakeSpan $ forM _names $ \name ->+        case nameModule_maybe name of+            Nothing -> return (Left $ NameHasNoModule name)+            Just mod -> do+             ModIface { mi_doc_hdr = mb_doc_hdr+                      , mi_decl_docs = DeclDocMap dmap+                      , mi_arg_docs = ArgDocMap amap+                      } <- loadModuleInterface "getModuleInterface" mod+             if isNothing mb_doc_hdr && Map.null dmap && Map.null amap+               then pure (Left (NoDocsInIface mod $ compiled name))+               else pure (Right ( Map.lookup name dmap+                                , Map.findWithDefault Map.empty name amap))+    case res of+        Just x  -> return $ map (first $ T.unpack . showGhc) x+        Nothing -> throwErrors errs+  where+    throwErrors = liftIO . throwIO . mkSrcErr+    compiled n =+      -- TODO: Find a more direct indicator.+      case nameSrcLoc n of+        RealSrcLoc {}   -> False+        UnhelpfulLoc {} -> True++fakeSpan :: RealSrcSpan+fakeSpan = realSrcLocSpan $ mkRealSrcLoc (fsLit "<ghcide>") 1 1++-- | Non-interactive, batch version of 'InteractiveEval.lookupNames'.+--   The interactive paths create problems in ghc-lib builds+--- and leads to fun errors like "Cannot continue after interface file error".+lookupName :: HscEnv+           -> Module -- ^ A module where the Names are in scope+           -> Name+           -> IO (Maybe TyThing)+lookupName hsc_env mod name = do+    (_messages, res) <- initTc hsc_env HsSrcFile False mod fakeSpan $ do+        tcthing <- tcLookup name+        case tcthing of+            AGlobal thing    -> return thing+            ATcId{tct_id=id} -> return (AnId id)+            _                -> panic "tcRnLookupName'"+    return res