Implement the HIE Bios

.azure/linux-stack.yml

@@ -64,7 +64,6 @@ jobs:
       source .azure/linux.bashrc
       stack build --stack-yaml $(YAML_FILE) --test --bench --only-dependencies
       stack install --stack-yaml $(YAML_FILE) # `hie` binary required for tests
-      stack --stack-yaml $(YAML_FILE) exec hoogle generate
     displayName: Build Test-dependencies
   - bash: |
       sudo apt update

.azure/macos-stack.yml

@@ -60,7 +60,6 @@ jobs:
       source .azure/macos.bashrc
       stack build --stack-yaml $(YAML_FILE) --test --bench --only-dependencies
       stack install --stack-yaml $(YAML_FILE) # `hie` binary required for tests
-      stack --stack-yaml $(YAML_FILE) exec hoogle generate
     displayName: Build Test-dependencies
   - bash: |
       ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

.azure/windows-stack.yml

@@ -62,7 +62,6 @@ jobs:
       source .azure/windows.bashrc
       stack build --stack-yaml $(YAML_FILE) --test --bench --only-dependencies
       stack install --stack-yaml $(YAML_FILE) # `hie` binary required for tests
-      stack exec --stack-yaml $(YAML_FILE) hoogle generate
     displayName: Build Test-dependencies
   - bash: |
       # TODO: try to install automatically (`choco install z3` fails and pacman is not installed)

.circleci/config.yml

@@ -26,9 +26,9 @@ defaults: &defaults
           - stack-cache-{{ .Environment.HIE_CACHE }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}
           - stack-cache-{{ .Environment.HIE_CACHE }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "resolver.txt" }}
 
-    # - run:
-    #     name: Stack upgrade
-    #     command: stack upgrade
+    - run:
+        name: Stack upgrade
+        command: stack upgrade
 
     - run:
         name: Stack setup

.gitignore

@@ -74,3 +74,6 @@ _build/
 # stack 2.1 stack.yaml lock files
 stack*.yaml.lock
 shake.yaml.lock
+
+# ignore hie.yaml's for testdata 
+test/**/*.yaml

.gitmodules

@@ -10,20 +10,12 @@
 #     rm -rf path_to_submodule
 
 
-[submodule "submodules/HaRe"]
-	path = submodules/HaRe
-	# url = https://github.com/bubba/HaRe.git
-	url = https://github.com/alanz/HaRe.git
-
 [submodule "submodules/cabal-helper"]
 	path = submodules/cabal-helper
-	# url = https://github.com/arbor/cabal-helper.git
-	url = https://github.com/alanz/cabal-helper.git
 	# url = https://github.com/DanielG/cabal-helper.git
+	# Change this back once https://github.com/DanielG/cabal-helper/pull/85/ merged
+	url = https://github.com/bubba/cabal-helper.git
 
 [submodule "submodules/ghc-mod"]
 	path = submodules/ghc-mod
-	# url = https://github.com/arbor/ghc-mod.git
-	# url = https://github.com/bubba/ghc-mod.git
-	url = https://github.com/alanz/ghc-mod.git
-
+	url = https://github.com/fendor/ghc-mod.git

README.md

@@ -30,16 +30,18 @@ we talk to clients.__
       - [Windows-specific pre-requirements](#windows-specific-pre-requirements)
       - [Download the source code](#download-the-source-code)
       - [Building](#building)
+        - [Install via cabal](#install-via-cabal)
         - [Install specific GHC Version](#install-specific-ghc-version)
         - [Multiple versions of HIE (optional)](#multiple-versions-of-hie-optional)
   - [Configuration](#configuration)
+  - [Explicit Configuration](#explicit-configuration)
   - [Editor Integration](#editor-integration)
     - [Using HIE with VS Code](#using-hie-with-vs-code)
       - [Using VS Code with Nix](#using-vs-code-with-nix)
     - [Using HIE with Sublime Text](#using-hie-with-sublime-text)
     - [Using HIE with Vim or Neovim](#using-hie-with-vim-or-neovim)
-      - [Coc](#Coc)
-      - [LanguageClient-neovim](#LanguageClient-neovim)
+      - [Coc](#coc)
+      - [LanguageClient-neovim](#languageclient-neovim)
         - [vim-plug](#vim-plug)
         - [Clone the LanguageClient-neovim repo](#clone-the-languageclient-neovim-repo)
         - [Sample `~/.vimrc`](#sample-vimrc)
@@ -303,6 +305,100 @@ There are some settings that can be configured via a `settings.json` file:
 - VS Code: These settings will show up in the settings window
 - LanguageClient-neovim: Create this file in `$projectdir/.vim/settings.json` or set `g:LanguageClient_settingsPath`
 
+## Explicit Configuration
+
+**For a full explanation of possible configuration, we refer to [hie-bios/README](https://github.com/mpickering/hie-bios/blob/master/README.md).**
+
+The user can place a `hie.yaml` file in the root of the workspace which
+describes how to setup the environment. For example, to explicitly state
+that you want to use `stack` then the configuration file would look like:
+
+```yaml
+cradle: {stack}
+```
+
+If you use `cabal` then you probably need to specify which component you want
+to use.
+
+```yaml
+cradle:
+  cabal:
+    component: "lib:haskell-ide-engine"
+```
+
+Or you can explicitly state the program which should be used to collect
+the options by supplying the path to the program. It is interpreted
+relative to the current working directory if it is not an absolute path.
+
+```yaml
+cradle:
+  bios:
+    program: ".hie-bios"
+```
+
+The complete configuration is a subset of
+
+```yaml
+cradle:
+  cabal:
+    component: "optional component name"
+  stack:
+  bazel:
+  obelisk:
+  bios:
+    program: "program to run"
+    dependency-program: "optional program to run"
+  direct:
+    arguments: ["list","of","ghc","arguments"]
+  default:
+  none:
+
+dependencies:
+  - someDep
+```
+
+There is also support for multiple cradles in a single `hie.yaml`. An example configuration for Haskell IDE Engine:
+
+```yaml
+cradle:
+  multi:
+    - path: ./test/dispatcher/
+      config:
+        cradle:
+          cabal:
+            component: "test:dispatcher-test"
+    - path: ./test/functional/
+      config:
+        cradle:
+          cabal:
+            component: "test:func-test"
+    - path: ./test/unit/
+      config:
+        cradle:
+          cabal:
+            component: "test:unit-test"
+    - path: ./hie-plugin-api/
+      config:
+        cradle:
+          cabal:
+            component: "lib:hie-plugin-api"
+    - path: ./app/MainHie.hs
+      config:
+        cradle:
+          cabal:
+            component: "exe:hie"
+    - path: ./app/HieWrapper.hs
+      config:
+        cradle:
+          cabal:
+            component: "exe:hie-wrapper"
+    - path: ./
+      config:
+        cradle:
+          cabal:
+            component: "lib:haskell-ide-engine"
+```
+
 ## Editor Integration
 
 Note to editor integrators: there is now a `hie-wrapper` executable, which is installed alongside the `hie` executable.  When this is invoked in the project root directory, it attempts to work out the GHC version used in the project, and then launch the matching `hie` executable.
@@ -659,3 +755,39 @@ can happen because cabal-helper compiles and runs above executable at runtime wi
 
 Liquid Haskell requires an SMT solver on the path. We do not take care of installing one, thus, Liquid Haskell will not run until one is installed.
 The recommended SMT solver is [z3](https://github.com/Z3Prover/z3). To run the tests, it is also required to have an SMT solver on the path, otherwise the tests will fail for Liquid Haskell.
+
+### Profiling `haskell-ide-engine`.
+
+If you think `haskell-ide-engine` is using a lot of memory then the most useful
+thing you can do is prepare a profile of the memory usage whilst you're using
+the program.
+
+1. Add `profiling: True` to the cabal.project file of `haskell-ide-engine`
+2. `cabal new-build hie`
+3. (IMPORTANT) Add `profiling: True` to the `cabal.project` file of the project you want to profile.
+4. Make a wrapper script which calls the `hie` you built in step 2 with the additional options `+RTS -hd -l-au`
+5. Modify your editor settings to call this wrapper script instead of looking for `hie` on the path
+6. Try using `h-i-e` as normal and then process the `*.eventlog` which will be created using  [`eventlog2html`](http://hackage.haskell.org/package/eventlog2html).
+7. Repeat the process again using different profiling options if you like.
+
+#### Using `ghc-events-analyze`
+
+`haskell-ide-engine` contains the necessary tracing functions to work with [`ghc-events-analyze`](http://www.well-typed.com/blog/2014/02/ghc-events-analyze/). Each
+request which is made will emit an event to the eventlog when it starts and finishes. This way you
+can see if there are any requests which are taking a long time to complete or are blocking.
+
+1. Make sure that `hie` is linked with the `-eventlog` option. This can be achieved by adding the flag
+to the `ghc-options` field in the cabal file.
+2. Run `hie` as normal but with the addition of `+RTS -l`. This will produce an eventlog called `hie.eventlog`.
+3. Run `ghc-events-analyze` on the `hie.eventlog` file to produce the rendered SVG. Warning, this might take a while and produce a big SVG file.
+
+The default options for `ghc-events-analyze` will produce quite a wide chart which is difficult to view. You can try using less buckets in order
+to make the chart quicker to generate and faster to render.
+
+```
+ghc-events-analyze hie.eventlog -b 100
+```
+
+This support is similar to the logging capabilities [built into GHC](https://www.haskell.org/ghc/blog/20190924-eventful-ghc.html).
+
+

app/HieWrapper.hs

@@ -9,10 +9,9 @@ import           Data.Semigroup
 import           Data.List
 import           Data.Foldable
 import           Data.Version                          (showVersion)
-import qualified GhcMod.Monad                          as GM
-import qualified GhcMod.Monad.Types                    as GM
-import qualified GhcMod.Types                          as GM
+import           HIE.Bios
 import           Haskell.Ide.Engine.MonadFunctions
+import           Haskell.Ide.Engine.Cradle (findLocalCradle)
 import           Haskell.Ide.Engine.Options
 import           Haskell.Ide.Engine.Plugin.Base
 import qualified Language.Haskell.LSP.Core             as Core
@@ -23,6 +22,7 @@ import           System.Environment
 import qualified System.Log.Logger as L
 import           System.Process
 import           System.Info
+import           System.FilePath
 
 -- ---------------------------------------------------------------------
 
@@ -73,15 +73,13 @@ run opts = do
   logm $ "Current directory:" ++ d
   logm $ "Operating system:" ++ os
 
-  -- Get the cabal directory from the ghc-mod cradle
-  (mcr,_) <- GM.runGhcModT GM.defaultOptions GM.cradle
-  dir <- case mcr of
-    Left err -> error (show err)
-    Right cr -> return $ GM.cradleRootDir cr
+  -- Get the cabal directory from the cradle
+  cradle <- findLocalCradle (d </> "File.hs")
+  let dir = cradleRootDir cradle
   logm $ "Cradle directory:" ++ dir
   setCurrentDirectory dir
 
-  ghcVersion <- getProjectGhcVersion
+  ghcVersion <- getProjectGhcVersion cradle
   logm $ "Project GHC version:" ++ ghcVersion
 
   let

app/MainHie.hs

@@ -17,17 +17,18 @@ import qualified Paths_haskell_ide_engine              as Meta
 import           System.Directory
 import           System.Environment
 import qualified System.Log.Logger                     as L
+import           HIE.Bios.Types
+import           System.IO
 
 -- ---------------------------------------------------------------------
 -- plugins
 
 import           Haskell.Ide.Engine.Plugin.ApplyRefact
 import           Haskell.Ide.Engine.Plugin.Base
 import           Haskell.Ide.Engine.Plugin.Brittany
-import           Haskell.Ide.Engine.Plugin.Build
 import           Haskell.Ide.Engine.Plugin.Example2
-import           Haskell.Ide.Engine.Plugin.GhcMod
-import           Haskell.Ide.Engine.Plugin.HaRe
+import           Haskell.Ide.Engine.Plugin.Bios
+-- import           Haskell.Ide.Engine.Plugin.HaRe
 import           Haskell.Ide.Engine.Plugin.Haddock
 import           Haskell.Ide.Engine.Plugin.HfaAlign
 import           Haskell.Ide.Engine.Plugin.Hoogle
@@ -36,6 +37,7 @@ import           Haskell.Ide.Engine.Plugin.Liquid
 import           Haskell.Ide.Engine.Plugin.Package
 import           Haskell.Ide.Engine.Plugin.Pragmas
 import           Haskell.Ide.Engine.Plugin.Floskell
+import           Haskell.Ide.Engine.Plugin.Generic
 
 -- ---------------------------------------------------------------------
 
@@ -50,16 +52,16 @@ plugins includeExamples = pluginDescToIdePlugins allPlugins
       [ applyRefactDescriptor "applyrefact"
       , baseDescriptor        "base"
       , brittanyDescriptor    "brittany"
-      , buildPluginDescriptor "build"
-      , ghcmodDescriptor      "ghcmod"
       , haddockDescriptor     "haddock"
-      , hareDescriptor        "hare"
+      -- , hareDescriptor        "hare"
       , hoogleDescriptor      "hoogle"
       , hsimportDescriptor    "hsimport"
       , liquidDescriptor      "liquid"
       , packageDescriptor     "package"
       , pragmasDescriptor     "pragmas"
       , floskellDescriptor    "floskell"
+      , biosDescriptor        "bios"
+      , genericDescriptor     "generic"
       ]
     examplePlugins =
       [example2Descriptor "eg2"
@@ -98,39 +100,33 @@ main = do
 
 run :: GlobalOpts -> IO ()
 run opts = do
+  hSetBuffering stderr LineBuffering
   let mLogFileName = optLogFile opts
 
       logLevel = if optDebugOn opts
                    then L.DEBUG
                    else L.INFO
 
-  Core.setupLogger mLogFileName ["hie"] logLevel
-
-  projGhcVersion <- getProjectGhcVersion
-  when (projGhcVersion /= hieGhcVersion) $
-    warningm $ "Mismatching GHC versions: Project is " ++ projGhcVersion
-            ++ ", HIE is " ++ hieGhcVersion
+  Core.setupLogger mLogFileName ["hie", "hie-bios"] logLevel
 
   origDir <- getCurrentDirectory
 
   maybe (pure ()) setCurrentDirectory $ projectRoot opts
 
   progName <- getProgName
   logm $  "Run entered for HIE(" ++ progName ++ ") " ++ version
-  d <- getCurrentDirectory
-  logm $ "Current directory:" ++ d
+  logm $ "Current directory:" ++ origDir
   args <- getArgs
   logm $ "args:" ++ show args
 
-  let vomitOptions = defaultOptions { boLogging = BlVomit}
-  let defaultOpts = if optGhcModVomit opts then vomitOptions else defaultOptions
-      -- Running HIE on projects with -Werror breaks most of the features since all warnings
-      -- will be treated with the same severity of type errors. In order to offer a more useful
-      -- experience, we make sure warnings are always reported as warnings by setting -Wwarn
-      biosOptions = defaultOpts { boGhcUserOptions = ["-Wwarn"] }
+  let initOpts = defaultCradleOpts { cradleOptsVerbosity = verbosity }
+      verbosity = if optBiosVerbose opts then Verbose else Silent
+      -- biosLogLevel = if optBiosVerbose opts then L.DEBUG else L.INFO
+
+  -- Core.setupLogger mLogFileName ["hie-bios"] biosLogLevel
 
-  when (optGhcModVomit opts) $
-    logm "Enabling --vomit for ghc-mod. Output will be on stderr"
+  when (optBiosVerbose opts) $
+    logm "Enabling verbose mode for hie-bios. This option currently doesn't do anything."
 
   when (optExamplePlugin opts) $
     logm "Enabling Example2 plugin, will insert constant diagnostics etc."
@@ -139,8 +135,8 @@ run opts = do
 
   -- launch the dispatcher.
   if optJson opts then do
-    scheduler <- newScheduler plugins' biosOptions
+    scheduler <- newScheduler plugins' initOpts
     jsonStdioTransport scheduler
   else do
-    scheduler <- newScheduler plugins' biosOptions
+    scheduler <- newScheduler plugins' initOpts
     lspStdioTransport scheduler origDir plugins' (optCaptureFile opts)