| ... |
... |
@@ -52,175 +52,6 @@ import GHC.Internal.ForeignSrcLang |
|
52
|
52
|
import GHC.Internal.LanguageExtensions
|
|
53
|
53
|
import GHC.Internal.TH.Syntax
|
|
54
|
54
|
|
|
55
|
|
------------------------------------------------------
|
|
56
|
|
---
|
|
57
|
|
--- The Quasi class
|
|
58
|
|
---
|
|
59
|
|
------------------------------------------------------
|
|
60
|
|
-
|
|
61
|
|
-class (MonadIO m, MonadFail m) => Quasi m where
|
|
62
|
|
- qRunQ :: Q a -> m a
|
|
63
|
|
- -- | Fresh names. See 'newName'.
|
|
64
|
|
- qNewName :: String -> m Name
|
|
65
|
|
-
|
|
66
|
|
- ------- Error reporting and recovery -------
|
|
67
|
|
- -- | Report an error (True) or warning (False)
|
|
68
|
|
- -- ...but carry on; use 'fail' to stop. See 'report'.
|
|
69
|
|
- qReport :: Bool -> String -> m ()
|
|
70
|
|
-
|
|
71
|
|
- -- | See 'recover'.
|
|
72
|
|
- qRecover :: m a -- ^ the error handler
|
|
73
|
|
- -> m a -- ^ action which may fail
|
|
74
|
|
- -> m a -- ^ Recover from the monadic 'fail'
|
|
75
|
|
-
|
|
76
|
|
- ------- Inspect the type-checker's environment -------
|
|
77
|
|
- -- | True <=> type namespace, False <=> value namespace. See 'lookupName'.
|
|
78
|
|
- qLookupName :: Bool -> String -> m (Maybe Name)
|
|
79
|
|
- -- | See 'reify'.
|
|
80
|
|
- qReify :: Name -> m Info
|
|
81
|
|
- -- | See 'reifyFixity'.
|
|
82
|
|
- qReifyFixity :: Name -> m (Maybe Fixity)
|
|
83
|
|
- -- | See 'reifyType'.
|
|
84
|
|
- qReifyType :: Name -> m Type
|
|
85
|
|
- -- | Is (n tys) an instance? Returns list of matching instance Decs (with
|
|
86
|
|
- -- empty sub-Decs) Works for classes and type functions. See 'reifyInstances'.
|
|
87
|
|
- qReifyInstances :: Name -> [Type] -> m [Dec]
|
|
88
|
|
- -- | See 'reifyRoles'.
|
|
89
|
|
- qReifyRoles :: Name -> m [Role]
|
|
90
|
|
- -- | See 'reifyAnnotations'.
|
|
91
|
|
- qReifyAnnotations :: Data a => AnnLookup -> m [a]
|
|
92
|
|
- -- | See 'reifyModule'.
|
|
93
|
|
- qReifyModule :: Module -> m ModuleInfo
|
|
94
|
|
- -- | See 'reifyConStrictness'.
|
|
95
|
|
- qReifyConStrictness :: Name -> m [DecidedStrictness]
|
|
96
|
|
-
|
|
97
|
|
- -- | See 'location'.
|
|
98
|
|
- qLocation :: m Loc
|
|
99
|
|
-
|
|
100
|
|
- -- | Input/output (dangerous). See 'runIO'.
|
|
101
|
|
- qRunIO :: IO a -> m a
|
|
102
|
|
- qRunIO = liftIO
|
|
103
|
|
- -- | See 'getPackageRoot'.
|
|
104
|
|
- qGetPackageRoot :: m FilePath
|
|
105
|
|
-
|
|
106
|
|
- -- | See 'addDependentFile'.
|
|
107
|
|
- qAddDependentFile :: FilePath -> m ()
|
|
108
|
|
-
|
|
109
|
|
- -- | See 'addDependentDirectory'.
|
|
110
|
|
- qAddDependentDirectory :: FilePath -> m ()
|
|
111
|
|
-
|
|
112
|
|
- -- | See 'addTempFile'.
|
|
113
|
|
- qAddTempFile :: String -> m FilePath
|
|
114
|
|
-
|
|
115
|
|
- -- | See 'addTopDecls'.
|
|
116
|
|
- qAddTopDecls :: [Dec] -> m ()
|
|
117
|
|
-
|
|
118
|
|
- -- | See 'addForeignFilePath'.
|
|
119
|
|
- qAddForeignFilePath :: ForeignSrcLang -> String -> m ()
|
|
120
|
|
-
|
|
121
|
|
- -- | See 'addModFinalizer'.
|
|
122
|
|
- qAddModFinalizer :: Q () -> m ()
|
|
123
|
|
-
|
|
124
|
|
- -- | See 'addCorePlugin'.
|
|
125
|
|
- qAddCorePlugin :: String -> m ()
|
|
126
|
|
-
|
|
127
|
|
- -- | See 'getQ'.
|
|
128
|
|
- qGetQ :: Typeable a => m (Maybe a)
|
|
129
|
|
-
|
|
130
|
|
- -- | See 'putQ'.
|
|
131
|
|
- qPutQ :: Typeable a => a -> m ()
|
|
132
|
|
-
|
|
133
|
|
- -- | See 'isExtEnabled'.
|
|
134
|
|
- qIsExtEnabled :: Extension -> m Bool
|
|
135
|
|
- -- | See 'extsEnabled'.
|
|
136
|
|
- qExtsEnabled :: m [Extension]
|
|
137
|
|
-
|
|
138
|
|
- -- | See 'putDoc'.
|
|
139
|
|
- qPutDoc :: DocLoc -> String -> m ()
|
|
140
|
|
- -- | See 'getDoc'.
|
|
141
|
|
- qGetDoc :: DocLoc -> m (Maybe String)
|
|
142
|
|
-
|
|
143
|
|
------------------------------------------------------
|
|
144
|
|
--- The IO instance of Quasi
|
|
145
|
|
------------------------------------------------------
|
|
146
|
|
-
|
|
147
|
|
--- | This instance is used only when running a Q
|
|
148
|
|
--- computation in the IO monad, usually just to
|
|
149
|
|
--- print the result. There is no interesting
|
|
150
|
|
--- type environment, so reification isn't going to
|
|
151
|
|
--- work.
|
|
152
|
|
-instance Quasi IO where
|
|
153
|
|
- qRunQ (Q m) = m metaHandlersIO
|
|
154
|
|
- qNewName = newNameIO
|
|
155
|
|
-
|
|
156
|
|
- qReport True msg = hPutStrLn stderr ("Template Haskell error: " ++ msg)
|
|
157
|
|
- qReport False msg = hPutStrLn stderr ("Template Haskell error: " ++ msg)
|
|
158
|
|
-
|
|
159
|
|
- qLookupName _ _ = badIO "lookupName"
|
|
160
|
|
- qReify _ = badIO "reify"
|
|
161
|
|
- qReifyFixity _ = badIO "reifyFixity"
|
|
162
|
|
- qReifyType _ = badIO "reifyFixity"
|
|
163
|
|
- qReifyInstances _ _ = badIO "reifyInstances"
|
|
164
|
|
- qReifyRoles _ = badIO "reifyRoles"
|
|
165
|
|
- qReifyAnnotations _ = badIO "reifyAnnotations"
|
|
166
|
|
- qReifyModule _ = badIO "reifyModule"
|
|
167
|
|
- qReifyConStrictness _ = badIO "reifyConStrictness"
|
|
168
|
|
- qLocation = badIO "currentLocation"
|
|
169
|
|
- qRecover _ _ = badIO "recover" -- Maybe we could fix this?
|
|
170
|
|
- qGetPackageRoot = badIO "getProjectRoot"
|
|
171
|
|
- qAddDependentFile _ = badIO "addDependentFile"
|
|
172
|
|
- qAddTempFile _ = badIO "addTempFile"
|
|
173
|
|
- qAddTopDecls _ = badIO "addTopDecls"
|
|
174
|
|
- qAddForeignFilePath _ _ = badIO "addForeignFilePath"
|
|
175
|
|
- qAddModFinalizer _ = badIO "addModFinalizer"
|
|
176
|
|
- qAddCorePlugin _ = badIO "addCorePlugin"
|
|
177
|
|
- qGetQ = badIO "getQ"
|
|
178
|
|
- qPutQ _ = badIO "putQ"
|
|
179
|
|
- qIsExtEnabled _ = badIO "isExtEnabled"
|
|
180
|
|
- qExtsEnabled = badIO "extsEnabled"
|
|
181
|
|
- qPutDoc _ _ = badIO "putDoc"
|
|
182
|
|
- qGetDoc _ = badIO "getDoc"
|
|
183
|
|
- qAddDependentDirectory _ = badIO "AddDependentDirectory"
|
|
184
|
|
-
|
|
185
|
|
-metaHandlersIO :: MetaHandlers IO
|
|
186
|
|
-metaHandlersIO = MetaHandlers {
|
|
187
|
|
- mFail = fail
|
|
188
|
|
- , mNewName = newNameIO
|
|
189
|
|
- , mReport = \b msg ->
|
|
190
|
|
- if b then
|
|
191
|
|
- hPutStrLn stderr ("Template Haskell error: " ++ msg)
|
|
192
|
|
- else
|
|
193
|
|
- hPutStrLn stderr ("Template Haskell error: " ++ msg) -- TODO: should this be different from above?
|
|
194
|
|
- , mLookupName = \ _ _ -> badIO "lookupName"
|
|
195
|
|
- , mReify = \_ -> badIO "reify"
|
|
196
|
|
- , mReifyFixity = \_ -> badIO "reifyFixity"
|
|
197
|
|
- , mReifyType = \_ -> badIO "reifyFixity"
|
|
198
|
|
- , mReifyInstances = \_ _ -> badIO "reifyInstances"
|
|
199
|
|
- , mReifyRoles = \_ -> badIO "reifyRoles"
|
|
200
|
|
- , mReifyAnnotations = \_ -> badIO "reifyAnnotations"
|
|
201
|
|
- , mReifyModule = \_ -> badIO "reifyModule"
|
|
202
|
|
- , mReifyConStrictness = \_ -> badIO "reifyConStrictness"
|
|
203
|
|
- , mLocation = badIO "currentLocation"
|
|
204
|
|
- , mRecover = \_ _ -> badIO "recover" -- Maybe we could fix this?
|
|
205
|
|
- , mGetPackageRoot = badIO "getProjectRoot"
|
|
206
|
|
- , mAddDependentFile = \_ -> badIO "addDependentFile"
|
|
207
|
|
- , mAddTempFile = \_ -> badIO "addTempFile"
|
|
208
|
|
- , mAddTopDecls = \_ -> badIO "addTopDecls"
|
|
209
|
|
- , mAddForeignFilePath = \_ _ -> badIO "addForeignFilePath"
|
|
210
|
|
- , mAddModFinalizer = \_ -> badIO "addModFinalizer"
|
|
211
|
|
- , mAddCorePlugin = \_ -> badIO "addCorePlugin"
|
|
212
|
|
- , mGetQ = badIO "getQ"
|
|
213
|
|
- , mPutQ = \_ -> badIO "putQ"
|
|
214
|
|
- , mIsExtEnabled = \_ -> badIO "isExtEnabled"
|
|
215
|
|
- , mExtsEnabled = badIO "extsEnabled"
|
|
216
|
|
- , mPutDoc = \_ _ -> badIO "putDoc"
|
|
217
|
|
- , mGetDoc = \_ -> badIO "getDoc"
|
|
218
|
|
- , mAddDependentDirectory = \_ -> badIO "AddDependentDirectory"
|
|
219
|
|
- }
|
|
220
|
|
-
|
|
221
|
|
-instance Quote IO where
|
|
222
|
|
- newName = newNameIO
|
|
223
|
|
-
|
|
224
|
55
|
data MetaHandlers m = MetaHandlers {
|
|
225
|
56
|
mFail :: forall a. String -> m a
|
|
226
|
57
|
-- | Fresh names. See 'newName'.
|
| ... |
... |
@@ -301,15 +132,55 @@ data MetaHandlers m = MetaHandlers { |
|
301
|
132
|
, mGetDoc :: DocLoc -> m (Maybe String)
|
|
302
|
133
|
}
|
|
303
|
134
|
|
|
|
135
|
+badIO :: String -> IO a
|
|
|
136
|
+badIO op = do { hPutStrLn stderr ("Can't do `" ++ op ++ "' in the IO monad")
|
|
|
137
|
+ ; fail "Template Haskell failure" }
|
|
|
138
|
+
|
|
|
139
|
+metaHandlersIO :: MetaHandlers IO
|
|
|
140
|
+metaHandlersIO = MetaHandlers {
|
|
|
141
|
+ mFail = fail
|
|
|
142
|
+ , mNewName = newNameIO
|
|
|
143
|
+ , mReport = \b msg ->
|
|
|
144
|
+ if b then
|
|
|
145
|
+ hPutStrLn stderr ("Template Haskell error: " ++ msg)
|
|
|
146
|
+ else
|
|
|
147
|
+ hPutStrLn stderr ("Template Haskell error: " ++ msg) -- TODO: should this be different from above?
|
|
|
148
|
+ , mLookupName = \ _ _ -> badIO "lookupName"
|
|
|
149
|
+ , mReify = \_ -> badIO "reify"
|
|
|
150
|
+ , mReifyFixity = \_ -> badIO "reifyFixity"
|
|
|
151
|
+ , mReifyType = \_ -> badIO "reifyFixity"
|
|
|
152
|
+ , mReifyInstances = \_ _ -> badIO "reifyInstances"
|
|
|
153
|
+ , mReifyRoles = \_ -> badIO "reifyRoles"
|
|
|
154
|
+ , mReifyAnnotations = \_ -> badIO "reifyAnnotations"
|
|
|
155
|
+ , mReifyModule = \_ -> badIO "reifyModule"
|
|
|
156
|
+ , mReifyConStrictness = \_ -> badIO "reifyConStrictness"
|
|
|
157
|
+ , mLocation = badIO "currentLocation"
|
|
|
158
|
+ , mRecover = \_ _ -> badIO "recover" -- Maybe we could fix this?
|
|
|
159
|
+ , mGetPackageRoot = badIO "getProjectRoot"
|
|
|
160
|
+ , mAddDependentFile = \_ -> badIO "addDependentFile"
|
|
|
161
|
+ , mAddTempFile = \_ -> badIO "addTempFile"
|
|
|
162
|
+ , mAddTopDecls = \_ -> badIO "addTopDecls"
|
|
|
163
|
+ , mAddForeignFilePath = \_ _ -> badIO "addForeignFilePath"
|
|
|
164
|
+ , mAddModFinalizer = \_ -> badIO "addModFinalizer"
|
|
|
165
|
+ , mAddCorePlugin = \_ -> badIO "addCorePlugin"
|
|
|
166
|
+ , mGetQ = badIO "getQ"
|
|
|
167
|
+ , mPutQ = \_ -> badIO "putQ"
|
|
|
168
|
+ , mIsExtEnabled = \_ -> badIO "isExtEnabled"
|
|
|
169
|
+ , mExtsEnabled = badIO "extsEnabled"
|
|
|
170
|
+ , mPutDoc = \_ _ -> badIO "putDoc"
|
|
|
171
|
+ , mGetDoc = \_ -> badIO "getDoc"
|
|
|
172
|
+ , mAddDependentDirectory = \_ -> badIO "AddDependentDirectory"
|
|
|
173
|
+ }
|
|
|
174
|
+
|
|
|
175
|
+instance Quote IO where
|
|
|
176
|
+ newName = newNameIO
|
|
|
177
|
+
|
|
|
178
|
+
|
|
304
|
179
|
|
|
305
|
180
|
newNameIO :: String -> IO Name
|
|
306
|
181
|
newNameIO s = do { n <- atomicModifyIORef' counter (\x -> (x + 1, x))
|
|
307
|
182
|
; pure (mkNameU s n) }
|
|
308
|
183
|
|
|
309
|
|
-badIO :: String -> IO a
|
|
310
|
|
-badIO op = do { qReport True ("Can't do `" ++ op ++ "' in the IO monad")
|
|
311
|
|
- ; fail "Template Haskell failure" }
|
|
312
|
|
-
|
|
313
|
184
|
-- Global variable to generate unique symbols
|
|
314
|
185
|
counter :: IORef Uniq
|
|
315
|
186
|
{-# NOINLINE counter #-}
|
| ... |
... |
@@ -334,20 +205,6 @@ counter = unsafePerformIO (newIORef 0) |
|
334
|
205
|
-- fufilled by an concrete 'Quasi' instance, internal to GHC.
|
|
335
|
206
|
newtype Q a = Q { unQ :: MetaHandlers IO -> IO a }
|
|
336
|
207
|
|
|
337
|
|
--- | \"Runs\" the 'Q' monad. Normal users of Template Haskell
|
|
338
|
|
--- should not need this function, as the splice brackets @$( ... )@
|
|
339
|
|
--- are the usual way of running a 'Q' computation.
|
|
340
|
|
---
|
|
341
|
|
--- This function is primarily used in GHC internals, and for debugging
|
|
342
|
|
--- splices by running them in 'IO'.
|
|
343
|
|
---
|
|
344
|
|
--- Note that many functions in 'Q', such as 'reify' and other compiler
|
|
345
|
|
--- queries, are not supported when running 'Q' in 'IO'; these operations
|
|
346
|
|
--- simply fail at runtime. Indeed, the only operations guaranteed to succeed
|
|
347
|
|
--- are 'newName', 'runIO', 'reportError' and 'reportWarning'.
|
|
348
|
|
-runQ :: Quasi m => Q a -> m a
|
|
349
|
|
-runQ = qRunQ
|
|
350
|
|
-
|
|
351
|
208
|
instance Monad Q where
|
|
352
|
209
|
Q m >>= k = Q $ \h -> (m h >>= \x -> unQ (k x) h)
|
|
353
|
210
|
(>>) = (*>)
|
| ... |
... |
@@ -430,14 +287,17 @@ class Monad m => Quote m where |
|
430
|
287
|
-}
|
|
431
|
288
|
newName :: String -> m Name
|
|
432
|
289
|
|
|
|
290
|
+-- | Utility function for lifting a 0-ary method of 'MetaHandlers' into 'Q'
|
|
433
|
291
|
runHandler :: (forall m. MetaHandlers m -> m a) -> Q a
|
|
434
|
|
-runHandler op = Q $ \h -> (op h)
|
|
|
292
|
+runHandler op = Q $ \h -> op h
|
|
435
|
293
|
|
|
|
294
|
+-- | Utility function for lifting a 1-ary method of 'MetaHandlers' into 'Q'
|
|
436
|
295
|
runHandler1 :: (forall m. MetaHandlers m -> a -> m b) -> a -> Q b
|
|
437
|
|
-runHandler1 op = \x -> Q $ \h -> (op h x)
|
|
|
296
|
+runHandler1 op = \x -> Q $ \h -> op h x
|
|
438
|
297
|
|
|
|
298
|
+-- | Utility function for lifting a 2-ary method of 'MetaHandlers' into 'Q'
|
|
439
|
299
|
runHandler2 :: (forall m. MetaHandlers m -> a -> b -> m c) -> a -> b -> Q c
|
|
440
|
|
-runHandler2 op = \x y -> Q $ \h -> (op h x y)
|
|
|
300
|
+runHandler2 op = \x y -> Q $ \h -> op h x y
|
|
441
|
301
|
|
|
442
|
302
|
instance Quote Q where
|
|
443
|
303
|
newName = runHandler1 mNewName
|
| ... |
... |
@@ -658,15 +518,15 @@ recover rec main = Q $ \h -> mRecover h rec main |
|
658
|
518
|
-- We don't export lookupName; the Bool isn't a great API
|
|
659
|
519
|
-- Instead we export lookupTypeName, lookupValueName
|
|
660
|
520
|
lookupName :: Bool -> String -> Q (Maybe Name)
|
|
661
|
|
-lookupName ns s = runHandler2 mLookupName ns s
|
|
|
521
|
+lookupName = runHandler2 mLookupName
|
|
662
|
522
|
|
|
663
|
523
|
-- | Look up the given name in the (type namespace of the) current splice's scope. See "Language.Haskell.TH.Syntax#namelookup" for more details.
|
|
664
|
524
|
lookupTypeName :: String -> Q (Maybe Name)
|
|
665
|
|
-lookupTypeName s = runHandler2 mLookupName True s
|
|
|
525
|
+lookupTypeName = runHandler2 mLookupName True
|
|
666
|
526
|
|
|
667
|
527
|
-- | Look up the given name in the (value namespace of the) current splice's scope. See "Language.Haskell.TH.Syntax#namelookup" for more details.
|
|
668
|
528
|
lookupValueName :: String -> Q (Maybe Name)
|
|
669
|
|
-lookupValueName s = runHandler2 mLookupName False s
|
|
|
529
|
+lookupValueName = runHandler2 mLookupName False
|
|
670
|
530
|
|
|
671
|
531
|
{-
|
|
672
|
532
|
Note [Name lookup]
|
| ... |
... |
@@ -850,7 +710,7 @@ has some discussion around this. |
|
850
|
710
|
|
|
851
|
711
|
-}
|
|
852
|
712
|
reifyInstances :: Name -> [Type] -> Q [InstanceDec]
|
|
853
|
|
-reifyInstances cls tys = runHandler2 mReifyInstances cls tys
|
|
|
713
|
+reifyInstances = runHandler2 mReifyInstances
|
|
854
|
714
|
|
|
855
|
715
|
{- | @reifyRoles nm@ returns the list of roles associated with the parameters
|
|
856
|
716
|
(both visible and invisible) of
|
| ... |
... |
@@ -869,20 +729,20 @@ and @reifyRoles Proxy@, we will get @['NominalR', 'PhantomR']@. The 'NominalR' i |
|
869
|
729
|
the role of the invisible @k@ parameter. Kind parameters are always nominal.
|
|
870
|
730
|
-}
|
|
871
|
731
|
reifyRoles :: Name -> Q [Role]
|
|
872
|
|
-reifyRoles nm = runHandler1 mReifyRoles nm
|
|
|
732
|
+reifyRoles = runHandler1 mReifyRoles
|
|
873
|
733
|
|
|
874
|
734
|
-- | @reifyAnnotations target@ returns the list of annotations
|
|
875
|
735
|
-- associated with @target@. Only the annotations that are
|
|
876
|
736
|
-- appropriately typed is returned. So if you have @Int@ and @String@
|
|
877
|
737
|
-- annotations for the same target, you have to call this function twice.
|
|
878
|
738
|
reifyAnnotations :: Data a => AnnLookup -> Q [a]
|
|
879
|
|
-reifyAnnotations an = runHandler1 mReifyAnnotations an
|
|
|
739
|
+reifyAnnotations = runHandler1 mReifyAnnotations
|
|
880
|
740
|
|
|
881
|
741
|
-- | @reifyModule mod@ looks up information about module @mod@. To
|
|
882
|
742
|
-- look up the current module, call this function with the return
|
|
883
|
743
|
-- value of 'Language.Haskell.TH.Lib.thisModule'.
|
|
884
|
744
|
reifyModule :: Module -> Q ModuleInfo
|
|
885
|
|
-reifyModule m = runHandler1 mReifyModule m
|
|
|
745
|
+reifyModule = runHandler1 mReifyModule
|
|
886
|
746
|
|
|
887
|
747
|
-- | @reifyConStrictness nm@ looks up the strictness information for the fields
|
|
888
|
748
|
-- of the constructor with the name @nm@. Note that the strictness information
|
| ... |
... |
@@ -897,7 +757,7 @@ reifyModule m = runHandler1 mReifyModule m |
|
897
|
757
|
-- circumstances, but it would return @['DecidedStrict', DecidedStrict]@ if the
|
|
898
|
758
|
-- @-XStrictData@ language extension was enabled.
|
|
899
|
759
|
reifyConStrictness :: Name -> Q [DecidedStrictness]
|
|
900
|
|
-reifyConStrictness n = runHandler1 mReifyConStrictness n
|
|
|
760
|
+reifyConStrictness = runHandler1 mReifyConStrictness
|
|
901
|
761
|
|
|
902
|
762
|
-- | Is the list of instances returned by 'reifyInstances' nonempty?
|
|
903
|
763
|
--
|
| ... |
... |
@@ -951,7 +811,7 @@ getPackageRoot = runHandler mGetPackageRoot |
|
951
|
811
|
-- * The state of the directory is read at the interface generation time,
|
|
952
|
812
|
-- not at the time of the function call.
|
|
953
|
813
|
addDependentDirectory :: FilePath -> Q ()
|
|
954
|
|
-addDependentDirectory dp = runHandler1 mAddDependentDirectory dp
|
|
|
814
|
+addDependentDirectory = runHandler1 mAddDependentDirectory
|
|
955
|
815
|
|
|
956
|
816
|
-- | Record external files that runIO is using (dependent upon).
|
|
957
|
817
|
-- The compiler can then recognize that it should re-compile the Haskell file
|
| ... |
... |
@@ -965,17 +825,17 @@ addDependentDirectory dp = runHandler1 mAddDependentDirectory dp |
|
965
|
825
|
--
|
|
966
|
826
|
-- * The dependency is based on file content, not a modification time
|
|
967
|
827
|
addDependentFile :: FilePath -> Q ()
|
|
968
|
|
-addDependentFile fp = runHandler1 mAddDependentFile fp
|
|
|
828
|
+addDependentFile = runHandler1 mAddDependentFile
|
|
969
|
829
|
|
|
970
|
830
|
-- | Obtain a temporary file path with the given suffix. The compiler will
|
|
971
|
831
|
-- delete this file after compilation.
|
|
972
|
832
|
addTempFile :: String -> Q FilePath
|
|
973
|
|
-addTempFile suffix = runHandler1 mAddTempFile suffix
|
|
|
833
|
+addTempFile = runHandler1 mAddTempFile
|
|
974
|
834
|
|
|
975
|
835
|
-- | Add additional top-level declarations. The added declarations will be type
|
|
976
|
836
|
-- checked along with the current declaration group.
|
|
977
|
837
|
addTopDecls :: [Dec] -> Q ()
|
|
978
|
|
-addTopDecls ds = runHandler1 mAddTopDecls ds
|
|
|
838
|
+addTopDecls = runHandler1 mAddTopDecls
|
|
979
|
839
|
|
|
980
|
840
|
-- | Same as 'addForeignSource', but expects to receive a path pointing to the
|
|
981
|
841
|
-- foreign file instead of a 'String' of its contents. Consider using this in
|
| ... |
... |
@@ -984,7 +844,7 @@ addTopDecls ds = runHandler1 mAddTopDecls ds |
|
984
|
844
|
-- This is a good alternative to 'addForeignSource' when you are trying to
|
|
985
|
845
|
-- directly link in an object file.
|
|
986
|
846
|
addForeignFilePath :: ForeignSrcLang -> FilePath -> Q ()
|
|
987
|
|
-addForeignFilePath lang fp = runHandler2 mAddForeignFilePath lang fp
|
|
|
847
|
+addForeignFilePath = runHandler2 mAddForeignFilePath
|
|
988
|
848
|
|
|
989
|
849
|
-- | Add a finalizer that will run in the Q monad after the current module has
|
|
990
|
850
|
-- been type checked. This only makes sense when run within a top-level splice.
|
| ... |
... |
@@ -993,7 +853,7 @@ addForeignFilePath lang fp = runHandler2 mAddForeignFilePath lang fp |
|
993
|
853
|
-- 'reify' is able to find the local definitions when executed inside the
|
|
994
|
854
|
-- finalizer.
|
|
995
|
855
|
addModFinalizer :: Q () -> Q ()
|
|
996
|
|
-addModFinalizer act = runHandler1 mAddModFinalizer act
|
|
|
856
|
+addModFinalizer = runHandler1 mAddModFinalizer
|
|
997
|
857
|
|
|
998
|
858
|
-- | Adds a core plugin to the compilation pipeline.
|
|
999
|
859
|
--
|
| ... |
... |
@@ -1003,7 +863,7 @@ addModFinalizer act = runHandler1 mAddModFinalizer act |
|
1003
|
863
|
-- to tell the compiler that we needed to compile first a plugin module in the
|
|
1004
|
864
|
-- current package.
|
|
1005
|
865
|
addCorePlugin :: String -> Q ()
|
|
1006
|
|
-addCorePlugin plugin = runHandler1 mAddCorePlugin plugin
|
|
|
866
|
+addCorePlugin = runHandler1 mAddCorePlugin
|
|
1007
|
867
|
|
|
1008
|
868
|
-- | Get state from the 'Q' monad. The state maintained by 'Q' is isomorphic to
|
|
1009
|
869
|
-- a type-indexed finite map. That is,
|
| ... |
... |
@@ -1022,11 +882,11 @@ getQ = runHandler mGetQ |
|
1022
|
882
|
-- | Replace the state in the 'Q' monad. Note that the state is local to the
|
|
1023
|
883
|
-- Haskell module in which the Template Haskell expression is executed.
|
|
1024
|
884
|
putQ :: Typeable a => a -> Q ()
|
|
1025
|
|
-putQ x = runHandler1 mPutQ x
|
|
|
885
|
+putQ = runHandler1 mPutQ
|
|
1026
|
886
|
|
|
1027
|
887
|
-- | Determine whether the given language extension is enabled in the 'Q' monad.
|
|
1028
|
888
|
isExtEnabled :: Extension -> Q Bool
|
|
1029
|
|
-isExtEnabled ext = runHandler1 mIsExtEnabled ext
|
|
|
889
|
+isExtEnabled = runHandler1 mIsExtEnabled
|
|
1030
|
890
|
|
|
1031
|
891
|
-- | List all enabled language extensions.
|
|
1032
|
892
|
extsEnabled :: Q [Extension]
|
| ... |
... |
@@ -1049,49 +909,18 @@ extsEnabled = runHandler mExtsEnabled |
|
1049
|
909
|
-- Adding documentation to anything outside of the current module will cause an
|
|
1050
|
910
|
-- error.
|
|
1051
|
911
|
putDoc :: DocLoc -> String -> Q ()
|
|
1052
|
|
-putDoc t s = runHandler2 mPutDoc t s
|
|
|
912
|
+putDoc = runHandler2 mPutDoc
|
|
1053
|
913
|
|
|
1054
|
914
|
-- | Retrieves the Haddock documentation at the specified location, if one
|
|
1055
|
915
|
-- exists.
|
|
1056
|
916
|
-- It can be used to read documentation on things defined outside of the current
|
|
1057
|
917
|
-- module, provided that those modules were compiled with the @-haddock@ flag.
|
|
1058
|
918
|
getDoc :: DocLoc -> Q (Maybe String)
|
|
1059
|
|
-getDoc n = runHandler1 mGetDoc n
|
|
|
919
|
+getDoc = runHandler1 mGetDoc
|
|
1060
|
920
|
|
|
1061
|
921
|
instance MonadIO Q where
|
|
1062
|
922
|
liftIO = runIO
|
|
1063
|
923
|
|
|
1064
|
|
-instance Quasi Q where
|
|
1065
|
|
- qRunQ = id
|
|
1066
|
|
- qNewName = newName
|
|
1067
|
|
- qReport = report
|
|
1068
|
|
- qRecover = recover
|
|
1069
|
|
- qReify = reify
|
|
1070
|
|
- qReifyFixity = reifyFixity
|
|
1071
|
|
- qReifyType = reifyType
|
|
1072
|
|
- qReifyInstances = reifyInstances
|
|
1073
|
|
- qReifyRoles = reifyRoles
|
|
1074
|
|
- qReifyAnnotations = reifyAnnotations
|
|
1075
|
|
- qReifyModule = reifyModule
|
|
1076
|
|
- qReifyConStrictness = reifyConStrictness
|
|
1077
|
|
- qLookupName = lookupName
|
|
1078
|
|
- qLocation = location
|
|
1079
|
|
- qGetPackageRoot = getPackageRoot
|
|
1080
|
|
- qAddDependentFile = addDependentFile
|
|
1081
|
|
- qAddDependentDirectory = addDependentDirectory
|
|
1082
|
|
- qAddTempFile = addTempFile
|
|
1083
|
|
- qAddTopDecls = addTopDecls
|
|
1084
|
|
- qAddForeignFilePath = addForeignFilePath
|
|
1085
|
|
- qAddModFinalizer = addModFinalizer
|
|
1086
|
|
- qAddCorePlugin = addCorePlugin
|
|
1087
|
|
- qGetQ = getQ
|
|
1088
|
|
- qPutQ = putQ
|
|
1089
|
|
- qIsExtEnabled = isExtEnabled
|
|
1090
|
|
- qExtsEnabled = extsEnabled
|
|
1091
|
|
- qPutDoc = putDoc
|
|
1092
|
|
- qGetDoc = getDoc
|
|
1093
|
|
-
|
|
1094
|
|
-
|
|
1095
|
924
|
----------------------------------------------------
|
|
1096
|
925
|
-- The following operations are used solely in GHC.HsToCore.Quote when
|
|
1097
|
926
|
-- desugaring brackets. They are not necessary for the user, who can use
|