summaryrefslogtreecommitdiff
path: root/compiler
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2016-03-04 23:15:34 +0100
committerBen Gamari <ben@smart-cactus.org>2016-03-05 00:25:31 +0100
commit15517f3c4444e5bf5cb3da1bf909c2d418eaf741 (patch)
tree21f4f83fbc0f05944bbdfdd1c643189bb8628081 /compiler
parent91a6a9cb94172a4c2235e6b2f9001df982bed4cc (diff)
downloadhaskell-15517f3c4444e5bf5cb3da1bf909c2d418eaf741.tar.gz
SimplEnv: Add Haddock headings to export list
Diffstat (limited to 'compiler')
-rw-r--r--compiler/simplCore/SimplEnv.hs12
1 files changed, 8 insertions, 4 deletions
diff --git a/compiler/simplCore/SimplEnv.hs b/compiler/simplCore/SimplEnv.hs
index 53fe9f4c38..da829437ad 100644
--- a/compiler/simplCore/SimplEnv.hs
+++ b/compiler/simplCore/SimplEnv.hs
@@ -7,14 +7,15 @@
{-# LANGUAGE CPP #-}
module SimplEnv (
+ -- * Basic types
InId, InBind, InExpr, InAlt, InArg, InType, InBndr, InVar,
OutId, OutTyVar, OutBind, OutExpr, OutAlt, OutArg, OutType, OutBndr, OutVar,
InCoercion, OutCoercion,
- -- The simplifier mode
+ -- * The simplifier mode
setMode, getMode, updMode,
- -- Environments
+ -- * Environments
SimplEnv(..), StaticEnv, pprSimplEnv, -- Temp not abstract
mkSimplEnv, extendIdSubst,
SimplEnv.extendTvSubst, SimplEnv.extendCvSubst,
@@ -22,14 +23,16 @@ module SimplEnv (
getInScope, setInScope, setInScopeSet, modifyInScope, addNewInScopeIds,
getSimplRules,
+ -- * Substitution results
SimplSR(..), mkContEx, substId, lookupRecBndr, refineFromInScope,
+ -- * Simplifying 'Id' binders
simplNonRecBndr, simplRecBndrs,
simplBinder, simplBinders,
substTy, substTyVar, getTCvSubst,
substCo, substCoVar,
- -- Floats
+ -- * Floats
Floats, emptyFloats, isEmptyFloats, addNonRec, addFloats, extendFloats,
wrapFloats, setFloats, zapFloats, addRecFloats, mapFloats,
doFloatFromRhs, getFloatBinds
@@ -38,7 +41,7 @@ module SimplEnv (
#include "HsVersions.h"
import SimplMonad
-import CoreMonad ( SimplifierMode(..) )
+import CoreMonad ( SimplifierMode(..) )
import CoreSyn
import CoreUtils
import Var
@@ -139,6 +142,7 @@ pprSimplEnv env
type SimplIdSubst = IdEnv SimplSR -- IdId |--> OutExpr
-- See Note [Extending the Subst] in CoreSubst
+-- | A substitution result.
data SimplSR
= DoneEx OutExpr -- Completed term
| DoneId OutId -- Completed term variable