ghc-mod/Language/Haskell/GhcMod.hs

-- | The ghc-mod library.

module Language.Haskell.GhcMod (
  -- * Cradle
    Cradle(..)
  , Project(..)
  , findCradle
  -- * Options
  , Options(..)
  , LineSeparator(..)
  , OutputStyle(..)
  , FileMapping(..)
  , defaultOptions
  -- * Logging
  , GmLogLevel
  , increaseLogLevel
  , decreaseLogLevel
  , gmSetLogLevel
  , gmLog
  -- * Types
  , ModuleString
  , Expression(..)
  , GhcPkgDb
  , Symbol
  , SymbolDb
  , GhcModError(..)
  -- * Monad Types
  , GhcModT
  , IOish
  -- * Monad utilities
  , runGhcModT
  , withOptions
  , dropSession
  -- * 'GhcMod' utilities
  , boot
  , browse
  , check
  , checkSyntax
  , debugInfo
  , componentInfo
  , expandTemplate
  , info
  , lint
  , pkgDoc
  , rootInfo
  , types
  , test
  , splits
  , sig
  , refine
  , auto
  , modules
  , languages
  , flags
  , findSymbol
  , lookupSymbol
  , dumpSymbol
  -- * SymbolDb
  , loadSymbolDb
  , isOutdated
  -- * Output
  , gmPutStr
  , gmErrStr
  , gmPutStrLn
  , gmErrStrLn
  -- * FileMapping
  , loadMappedFile
  , loadMappedFileSource
  , unloadMappedFile
  ) where

import Language.Haskell.GhcMod.Boot
import Language.Haskell.GhcMod.Browse
import Language.Haskell.GhcMod.CaseSplit
import Language.Haskell.GhcMod.Check
import Language.Haskell.GhcMod.Cradle
import Language.Haskell.GhcMod.Debug
import Language.Haskell.GhcMod.FillSig
import Language.Haskell.GhcMod.Find
import Language.Haskell.GhcMod.Flag
import Language.Haskell.GhcMod.Info
import Language.Haskell.GhcMod.Lang
import Language.Haskell.GhcMod.Lint
import Language.Haskell.GhcMod.Logging
import Language.Haskell.GhcMod.Modules
import Language.Haskell.GhcMod.Monad
import Language.Haskell.GhcMod.PkgDoc
import Language.Haskell.GhcMod.Types
import Language.Haskell.GhcMod.Target
import Language.Haskell.GhcMod.Output
import Language.Haskell.GhcMod.FileMapping
import Language.Haskell.GhcMod.Test
fixing markup. 2013-05-21 12:38:19 +00:00			`-- \| The ghc-mod library.`

Changing GHCMod as a library. 2013-05-17 01:00:01 +00:00			`module Language.Haskell.GhcMod (`
Separating IO and Ghc. 2013-05-20 02:29:44 +00:00			`-- * Cradle`
			`Cradle(..)`
Fix race condition in stack support code 2015-09-11 01:48:52 +00:00			`, Project(..)`
Separating IO and Ghc. 2013-05-20 02:29:44 +00:00			`, findCradle`
			`-- * Options`
			`, Options(..)`
exporting LineSeparator. 2013-09-03 05:47:34 +00:00			`, LineSeparator(..)`
Separating IO and Ghc. 2013-05-20 02:29:44 +00:00			`, OutputStyle(..)`
Initial support for file redirection Rewrite, taking discussion into consideration 2015-05-31 08:32:46 +00:00			`, FileMapping(..)`
Separating IO and Ghc. 2013-05-20 02:29:44 +00:00			`, defaultOptions`
Refactoring to use cabal-helper-wrapper This turned out to be quite involved but save for this huge commit it's actually quite awesome and squashes quite a few bugs and nasty problems (hopefully). Most importantly we now have native cabal component support without the user having to do anything to get it! To do this we traverse imports starting from each component's entrypoints (library modules or Main source file for executables) and use this information to find which component's options each module will build with. Under the assumption that these modules have to build with every component they're used in we can now just pick one. Quite a few internal assumptions have been invalidated by this change. Most importantly the runGhcModT* family of cuntions now change the current working directory to `cradleRootDir`. 2015-03-03 20:12:43 +00:00			`-- * Logging`
			`, GmLogLevel`
			`, increaseLogLevel`
Add quiet option to decrease log level 2015-03-06 18:46:56 +00:00			`, decreaseLogLevel`
Refactoring to use cabal-helper-wrapper This turned out to be quite involved but save for this huge commit it's actually quite awesome and squashes quite a few bugs and nasty problems (hopefully). Most importantly we now have native cabal component support without the user having to do anything to get it! To do this we traverse imports starting from each component's entrypoints (library modules or Main source file for executables) and use this information to find which component's options each module will build with. Under the assumption that these modules have to build with every component they're used in we can now just pick one. Quite a few internal assumptions have been invalidated by this change. Most importantly the runGhcModT* family of cuntions now change the current working directory to `cradleRootDir`. 2015-03-03 20:12:43 +00:00			`, gmSetLogLevel`
			`, gmLog`
writing docs. 2013-05-20 05:28:56 +00:00			`-- * Types`
			`, ModuleString`
Transform ModuleString and Expression type synonyms into newtypes 2015-06-01 15:10:37 +00:00			`, Expression(..)`
Migrate the remaining parts of the exposed API to `GhcMod a` 2014-07-11 01:10:37 +00:00			`, GhcPkgDb`
deleting GhcMod.Ghc. 2014-07-17 05:04:28 +00:00			`, Symbol`
			`, SymbolDb`
docs: Move GhcModError to right export category in Monad.hs 2014-08-21 02:14:32 +00:00			`, GhcModError(..)`
export minimum Monad stuff from GhcMod. 2014-07-18 06:31:42 +00:00			`-- * Monad Types`
			`, GhcModT`
			`, IOish`
			`-- * Monad utilities`
			`, runGhcModT`
			`, withOptions`
Fix re-init of ghc-modi session after environment change Using `dropSession` instead of a weird exception cludge 2015-08-05 06:52:52 +00:00			`, dropSession`
Migrate the remaining parts of the exposed API to `GhcMod a` 2014-07-11 01:10:37 +00:00			`-- * 'GhcMod' utilities`
			`, boot`
Ghc -> GhcMod: Browse, Check 2014-05-10 13:10:34 +00:00			`, browse`
Migrate the remaining parts of the exposed API to `GhcMod a` 2014-07-11 01:10:37 +00:00			`, check`
Changing GHCMod as a library. 2013-05-17 01:00:01 +00:00			`, checkSyntax`
writing docs. 2013-05-20 05:28:56 +00:00			`, debugInfo`
Cleanup and some fixes 2015-03-28 01:33:42 +00:00			`, componentInfo`
Migrate the remaining parts of the exposed API to `GhcMod a` 2014-07-11 01:10:37 +00:00			`, expandTemplate`
			`, info`
			`, lint`
			`, pkgDoc`
			`, rootInfo`
			`, types`
Add 'test' command for running QuickCheck props 2015-12-15 23:25:15 +00:00			`, test`
Migrate the remaining parts of the exposed API to `GhcMod a` 2014-07-11 01:10:37 +00:00			`, splits`
			`, sig`
Include 'refine' again 2014-07-17 04:59:10 +00:00			`, refine`
First attempt to add auto 2014-08-01 15:08:23 +00:00			`, auto`
Migrate the remaining parts of the exposed API to `GhcMod a` 2014-07-11 01:10:37 +00:00			`, modules`
			`, languages`
			`, flags`
Internal exports extra Monad stuff. 2014-07-18 06:42:05 +00:00			`, findSymbol`
			`, lookupSymbol`
			`, dumpSymbol`
deleting GhcMod.Ghc. 2014-07-17 05:04:28 +00:00			`-- * SymbolDb`
			`, loadSymbolDb`
ghc-modi's "find" now catches up if packageDb is updated. 2014-09-20 03:25:46 +00:00			`, isOutdated`
Start implementing line-prefix stuff readProcess wrapper still missing from CabalHelper 2015-08-13 04:47:12 +00:00			`-- * Output`
			`, gmPutStr`
			`, gmErrStr`
			`, gmPutStrLn`
			`, gmErrStrLn`
Initial support for file redirection Rewrite, taking discussion into consideration 2015-05-31 08:32:46 +00:00			`-- * FileMapping`
[File-map] Export more user-friendly functions in public API 2015-08-11 16:39:23 +00:00			`, loadMappedFile`
Drop memory-mapped files, since ghc doesn't play well with those All files are now "redirected", either user-created, or created by ghc-mod itself. 2015-08-16 20:20:00 +00:00			`, loadMappedFileSource`
[File-map] Export more user-friendly functions in public API 2015-08-11 16:39:23 +00:00			`, unloadMappedFile`
Changing GHCMod as a library. 2013-05-17 01:00:01 +00:00			`) where`

bootInfo as API. 2014-04-30 01:49:25 +00:00			`import Language.Haskell.GhcMod.Boot`
Changing GHCMod as a library. 2013-05-17 01:00:01 +00:00			`import Language.Haskell.GhcMod.Browse`
Monad.hs is now exported by GhcMod.hs. 2014-07-17 05:30:42 +00:00			`import Language.Haskell.GhcMod.CaseSplit`
Changing GHCMod as a library. 2013-05-17 01:00:01 +00:00			`import Language.Haskell.GhcMod.Check`
			`import Language.Haskell.GhcMod.Cradle`
			`import Language.Haskell.GhcMod.Debug`
Monad.hs is now exported by GhcMod.hs. 2014-07-17 05:30:42 +00:00			`import Language.Haskell.GhcMod.FillSig`
ghc-mod find (#203). 2014-04-24 12:08:45 +00:00			`import Language.Haskell.GhcMod.Find`
Changing GHCMod as a library. 2013-05-17 01:00:01 +00:00			`import Language.Haskell.GhcMod.Flag`
			`import Language.Haskell.GhcMod.Info`
			`import Language.Haskell.GhcMod.Lang`
			`import Language.Haskell.GhcMod.Lint`
Refactoring to use cabal-helper-wrapper This turned out to be quite involved but save for this huge commit it's actually quite awesome and squashes quite a few bugs and nasty problems (hopefully). Most importantly we now have native cabal component support without the user having to do anything to get it! To do this we traverse imports starting from each component's entrypoints (library modules or Main source file for executables) and use this information to find which component's options each module will build with. Under the assumption that these modules have to build with every component they're used in we can now just pick one. Quite a few internal assumptions have been invalidated by this change. Most importantly the runGhcModT* family of cuntions now change the current working directory to `cradleRootDir`. 2015-03-03 20:12:43 +00:00			`import Language.Haskell.GhcMod.Logging`
Rename List.hs -> Modules.hs 2014-08-28 09:41:03 +00:00			`import Language.Haskell.GhcMod.Modules`
Refactoring to use cabal-helper-wrapper This turned out to be quite involved but save for this huge commit it's actually quite awesome and squashes quite a few bugs and nasty problems (hopefully). Most importantly we now have native cabal component support without the user having to do anything to get it! To do this we traverse imports starting from each component's entrypoints (library modules or Main source file for executables) and use this information to find which component's options each module will build with. Under the assumption that these modules have to build with every component they're used in we can now just pick one. Quite a few internal assumptions have been invalidated by this change. Most importantly the runGhcModT* family of cuntions now change the current working directory to `cradleRootDir`. 2015-03-03 20:12:43 +00:00			`import Language.Haskell.GhcMod.Monad`
packageDoc for sandbox. 2014-03-27 07:22:49 +00:00			`import Language.Haskell.GhcMod.PkgDoc`
Changing GHCMod as a library. 2013-05-17 01:00:01 +00:00			`import Language.Haskell.GhcMod.Types`
Fix re-init of ghc-modi session after environment change Using `dropSession` instead of a weird exception cludge 2015-08-05 06:52:52 +00:00			`import Language.Haskell.GhcMod.Target`
Start implementing line-prefix stuff readProcess wrapper still missing from CabalHelper 2015-08-13 04:47:12 +00:00			`import Language.Haskell.GhcMod.Output`
[File-map] Export more user-friendly functions in public API 2015-08-11 16:39:23 +00:00			`import Language.Haskell.GhcMod.FileMapping`
Add 'test' command for running QuickCheck props 2015-12-15 23:25:15 +00:00			`import Language.Haskell.GhcMod.Test`