aboutsummaryrefslogtreecommitdiff
path: root/src/HaskellCodeExplorer/AST/RenamedSource.hs
blob: 7f0301be6254fd876d31f2d4a77b46a8abb43ad7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE ViewPatterns #-}
{-# LANGUAGE StrictData #-}

module HaskellCodeExplorer.AST.RenamedSource
  ( NameOccurrence(..)
  , namesFromRenamedSource
  ) where

import           Data.Generics                  ( Data
                                                , everything
                                                , extQ
                                                , mkQ
                                                )
import           Data.Maybe                     ( mapMaybe )
import qualified Data.Text                     as T
                                                ( Text )
import           GHC                            ( AmbiguousFieldOcc(..)
                                                , ConDecl(..)
                                                , ConDeclField(..)
                                                , FamEqn(..)
                                                , FamilyDecl(..)
                                                , FieldOcc(..)
                                                , FixitySig(..)
                                                , ForeignDecl(..)
                                                , FunDep(..)
                                                , GenLocated(..)
                                                , HsBindLR(..)
                                                , HsBracket(..)
                                                , HsDataDefn(..)
                                                , HsExpr(..)
                                                , HsMatchContext(..)
                                                , HsPatSynDetails
                                                , HsRecField'(..)
                                                , HsTupleSort(..)
                                                , HsTyLit(..)
                                                , HsTyVarBndr(..)
                                                , HsType(..)
                                                , IE(..)
                                                , InjectivityAnn(..)
                                                , LHsBindLR
                                                , LHsExpr
                                                , LHsType
                                                , LPat
                                                , LSig
                                                , LTyClDecl
                                                , Located
                                                , Match(..)
                                                , MatchGroup(..)
                                                , Name
                                                , Pat(..)
                                                , PatSynBind(..)
                                                , RoleAnnotDecl(..)
                                                , Sig(..)
                                                , TyClDecl(..)
                                                , Type
                                                , getLocA
                                                , reLocN
                                                , unLoc
                                                )
import           GHC.Builtin.Types              ( naturalTy
                                                , nilDataConName
                                                , tupleTyConName
                                                , typeSymbolKind
                                                )
import           GHC.Data.BooleanFormula        ( BooleanFormula(..) )
import           GHC.Hs.Extension               ( GhcRn )
import           GHC.Types.Basic                ( TupleSort(..) )
import           GHC.Types.SrcLoc               ( SrcSpan(..)
                                                , mkRealSrcLoc
                                                , mkRealSrcSpan
                                                , realSrcSpanEnd
                                                , realSrcSpanStart
                                                , srcLocCol
                                                , srcLocFile
                                                , srcLocLine
                                                )
import           HaskellCodeExplorer.GhcUtils   ( hsPatSynDetails
                                                , ieLocNames
                                                )
import           Prelude                 hiding ( span )
data NameOccurrence
  = NameOccurrence { locatedName :: Located (Maybe Name)
                   , description :: T.Text
                   , isBinder :: Bool }
  | TyLitOccurrence { locatedName :: Located (Maybe Name)
                    , description :: T.Text
                    , kind :: Type }

-- | Here we are only interested in a small subset of all AST nodes, so it is
-- convenient to use generic functions
namesFromRenamedSource :: (Data a) => a -> [NameOccurrence]
namesFromRenamedSource = everything
  (++)
  (      []
  `mkQ`  hsExprNames
  `extQ` matchGroupNames
  `extQ` bindNames
  `extQ` patNames
  `extQ` sigNames
  `extQ` hsTypeNames
  `extQ` tyClDeclNames
  `extQ` familyDeclNames
  `extQ` familyEqNames
  `extQ` dataEqNames
  `extQ` conDeclNames
  `extQ` importNames
  `extQ` hsTyVarBndrNames
  `extQ` hsPatSynDetailsNames
  `extQ` conDeclFieldNames
  `extQ` hsRecFieldExprNames
  `extQ` hsRecAmbFieldExprNames
  `extQ` hsRecFieldPatNames
  `extQ` foreignDeclNames
  `extQ` roleAnnotationNames
  `extQ` injectivityAnnotationNames
  )

fieldOccName :: Bool -> FieldOcc GhcRn -> NameOccurrence
fieldOccName isBinder (FieldOcc name located) = NameOccurrence
  { locatedName = L (getLocA located) (Just name)
  , description = "FieldOcc"
  , isBinder    = isBinder
  }

conDeclFieldNames :: ConDeclField GhcRn -> [NameOccurrence]
conDeclFieldNames ConDeclField {..} =
  map (fieldOccName True . unLoc) cd_fld_names

hsRecFieldExprNames
  :: HsRecField' (FieldOcc GhcRn) (LHsExpr GhcRn) -> [NameOccurrence]
hsRecFieldExprNames HsRecField {..} =
  [fieldOccName False $ unLoc hsRecFieldLbl]

hsRecAmbFieldExprNames
  :: HsRecField' (AmbiguousFieldOcc GhcRn) (LHsExpr GhcRn) -> [NameOccurrence]
hsRecAmbFieldExprNames HsRecField {..} =
  let (L span recField) = hsRecFieldLbl
      mbName            = case recField of
        Ambiguous   _    _ -> Nothing
        Unambiguous name _ -> Just name
  in  [ NameOccurrence { locatedName = L span mbName
                       , description = "AmbiguousFieldOcc"
                       , isBinder    = False
                       }
      ]

hsRecFieldPatNames
  :: HsRecField' (FieldOcc GhcRn) (LPat GhcRn) -> [NameOccurrence]
hsRecFieldPatNames HsRecField {..} = [fieldOccName False $ unLoc hsRecFieldLbl]

hsExprNames :: LHsExpr GhcRn -> [NameOccurrence]
hsExprNames (L _span (HsVar _ name)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "HsVar"
                   , isBinder    = False
                   }
  ]
hsExprNames lhe@(L _ (ExplicitList _ exprs))
  | null exprs
  = [ NameOccurrence { locatedName = L (getLocA lhe) $ Just nilDataConName
                     , description = "ExplicitList"
                     , isBinder    = False
                     }
    ]
  | otherwise
  = []
hsExprNames (L _span (RecordCon _ name _)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "RecordCon"
                   , isBinder    = False
                   }
  ]
hsExprNames (L _span (HsRecFld _ (Unambiguous name located))) =
  [ NameOccurrence { locatedName = L (getLocA located) (Just name)
                   , description = "HsRecFld"
                   , isBinder    = False
                   }
  ]
hsExprNames (L _span (HsRecFld _ (Ambiguous _name located))) =
  [ NameOccurrence { locatedName = L (getLocA located) Nothing
                   , description = "HsRecFld"
                   , isBinder    = False
                   }
  ]
hsExprNames lhr@(L _ (HsRnBracketOut _ (VarBr _ quote name) _)) =
  case getLocA lhr of
    RealSrcSpan realSpan _ ->
      let
        start  = realSrcSpanStart realSpan
        end    = realSrcSpanEnd realSpan
        offset = if quote
          then 1 -- 'x
          else 2 -- ''T
        start' = mkRealSrcLoc (srcLocFile start)
                              (srcLocLine start)
                              (srcLocCol start + offset)
        span' = RealSrcSpan (mkRealSrcSpan start' end) Nothing
      in
        [ NameOccurrence { locatedName = L span' (Just $ unLoc name)
                         , description = "VarBr"
                         , isBinder    = False
                         }
        ]
    _ -> []
hsExprNames _ = []

matchGroupNames :: MatchGroup GhcRn (LHsExpr GhcRn) -> [NameOccurrence]
matchGroupNames =
  mapMaybe (fmap toNameOcc . matchContextName . m_ctxt . unLoc)
    . unLoc
    . mg_alts
 where
    --matchContextName :: HsMatchContext Name -> Maybe (Located Name)
  matchContextName (FunRhs name _ _bool) = Just name
  matchContextName _                     = Nothing
  --toNameOcc :: LIdP GhcRn -> NameOccurrence
  toNameOcc n = NameOccurrence { locatedName = Just <$> reLocN n
                               , description = "Match"
                               , isBinder    = True
                               }

bindNames :: LHsBindLR GhcRn GhcRn -> [NameOccurrence]
bindNames (L _span (PatSynBind _ PSB {..})) =
  [ NameOccurrence { locatedName = Just <$> reLocN psb_id
                   , description = "PatSynBind"
                   , isBinder    = True
                   }
  ]
bindNames _ = []

hsPatSynDetailsNames :: HsPatSynDetails GhcRn -> [NameOccurrence]
hsPatSynDetailsNames =
  map
      (\name -> NameOccurrence { locatedName = Just <$> name
                               , description = "HsPatSynDetails"
                               , isBinder    = True
                               }
      )
    . hsPatSynDetails

importNames :: IE GhcRn -> [NameOccurrence]
importNames =
  map
      (\name -> NameOccurrence { locatedName = Just <$> name
                               , description = "IE"
                               , isBinder    = False
                               }
      )
    . ieLocNames


patNames :: LPat GhcRn -> [NameOccurrence]
patNames (L _span (VarPat _ name)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "VarPat"
                   , isBinder    = True
                   }
  ]
patNames (L _span (ConPat _ name _)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "ConPatIn"
                   , isBinder    = False
                   }
  ]
patNames (L _span (AsPat _ name _)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "AsPat"
                   , isBinder    = True
                   }
  ]
patNames (L _span (NPlusKPat _ name _ _ _ _)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "NPlusKPat"
                   , isBinder    = True
                   }
  ]
patNames _ = []


sigNames :: LSig GhcRn -> [NameOccurrence]
sigNames (L _span (TypeSig _ names _)) = map
  (\n -> NameOccurrence { locatedName = Just <$> reLocN n
                        , description = "TypeSig"
                        , isBinder    = False
                        }
  )
  names

sigNames (L _span (PatSynSig _ names _)) =
  map (\name -> NameOccurrence (Just <$> reLocN name) "PatSynSig" False) names
sigNames (L _span (ClassOpSig _ _ names _)) = map
  (\n -> NameOccurrence { locatedName = Just <$> reLocN n
                        , description = "ClassOpSig"
                        , isBinder    = True
                        }
  )
  names
sigNames (L _span (FixSig _ (FixitySig _ names _))) = map
  (\n -> NameOccurrence { locatedName = Just <$> reLocN n
                        , description = "FixitySig"
                        , isBinder    = False
                        }
  )
  names
sigNames (L _span (InlineSig _ name _)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "InlineSig"
                   , isBinder    = False
                   }
  ]
sigNames (L _span (SpecSig _ name _ _)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "SpecSig"
                   , isBinder    = False
                   }
  ]
sigNames (L _span (MinimalSig _ _ (L _ boolFormula))) =
  map
      (\n -> NameOccurrence { locatedName = Just <$> reLocN n
                            , description = "MinimalSig"
                            , isBinder    = False
                            }
      )
    . boolFormulaNames
    $ boolFormula
 where
  boolFormulaNames :: BooleanFormula name -> [name]
  boolFormulaNames (Var    a      ) = [a]
  boolFormulaNames (And    fs     ) = concatMap (boolFormulaNames . unLoc) fs
  boolFormulaNames (Or     fs     ) = concatMap (boolFormulaNames . unLoc) fs
  boolFormulaNames (Parens (L _ f)) = boolFormulaNames f
sigNames (L _ _) = []

hsTypeNames :: LHsType GhcRn -> [NameOccurrence]
hsTypeNames (L _span (HsTyVar _ _promoted name)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "HsTyVar"
                   , isBinder    = False
                   }
  ]
hsTypeNames lht@(L _ (HsTyLit _ lit)) =
  let kind = case lit of
        HsNumTy  _ _ -> naturalTy
        HsStrTy  _ _ -> typeSymbolKind
        HsCharTy _ _ -> typeSymbolKind
  in  [ TyLitOccurrence { locatedName = L (getLocA lht) Nothing
                        , description = "HsTyLit"
                        , kind        = kind
                        }
      ]
hsTypeNames (L _span (HsOpTy _ _ name _)) =
  [ NameOccurrence { locatedName = Just <$> reLocN name
                   , description = "HsOpTy"
                   , isBinder    = False
                   }
  ]
hsTypeNames lht@(L _ (HsTupleTy _ tupleSort types))
  | null types
  = let sort = case tupleSort of
          HsUnboxedTuple           -> UnboxedTuple
          HsBoxedOrConstraintTuple -> BoxedTuple
    in  [ NameOccurrence
            { locatedName = L (getLocA lht) (Just $ tupleTyConName sort 0)
            , description = "HsTupleTy"
            , isBinder    = False
            }
        ]
  | otherwise
  = []
--https://ghc.haskell.org/trac/ghc/ticket/13737
--hsTypeNames (L span (HsExplicitListTy _kind types)) = ...
--hsTypeNames (L span (HsExplicitTupleTy _kind types)) = ...
hsTypeNames _ = []

-- the flag in HsTyVarBndr flag GhcRn can be either () (for visible
-- cases) or Specificity (for invisible cases).  I'm guessing we only
-- need to handle the visible cases, but it's trivial to replicate
-- this function for invisible cases
hsTyVarBndrNames :: HsTyVarBndr () GhcRn -> [NameOccurrence]
hsTyVarBndrNames (UserTyVar _ _ n) =
  [ NameOccurrence { locatedName = Just <$> reLocN n
                   , description = "UserTyVar"
                   , isBinder    = True
                   }
  ]
hsTyVarBndrNames (KindedTyVar _ _ n _) =
  [ NameOccurrence { locatedName = Just <$> reLocN n
                   , description = "KindedTyVar"
                   , isBinder    = True
                   }
  ]


tyClDeclNames :: LTyClDecl GhcRn -> [NameOccurrence]
tyClDeclNames (L _span DataDecl {..}) =
  [ NameOccurrence { locatedName = Just <$> reLocN tcdLName
                   , description = "DataDecl"
                   , isBinder    = True
                   }
  ]
tyClDeclNames (L _span SynDecl {..}) =
  [ NameOccurrence { locatedName = Just <$> reLocN tcdLName
                   , description = "SynDecl"
                   , isBinder    = True
                   }
  ]
tyClDeclNames (L _span ClassDecl {..}) =
  NameOccurrence { locatedName = Just <$> reLocN tcdLName
                 , description = "ClassDecl"
                 , isBinder    = True
                 }
    : concatMap (go . unLoc) tcdFDs
 where
    -- toNameOcc :: Located Name -> NameOccurrence
  toNameOcc n = NameOccurrence { locatedName = Just <$> reLocN n
                               , description = "FunDep"
                               , isBinder    = False
                               }
  go (FunDep _ names1 names2) = map toNameOcc names1 ++ map toNameOcc names2
  go _                        = []
tyClDeclNames _ = []

familyDeclNames :: FamilyDecl GhcRn -> [NameOccurrence]
familyDeclNames FamilyDecl {..} =
  [ NameOccurrence { locatedName = Just <$> reLocN fdLName
                   , description = "FamilyDecl"
                   , isBinder    = True
                   }
  ]

familyEqNames :: FamEqn GhcRn (LHsType GhcRn) -> [NameOccurrence]
familyEqNames FamEqn { feqn_tycon = tyCon } =
  [ NameOccurrence { locatedName = Just <$> reLocN tyCon
                   , description = "FamEqn"
                   , isBinder    = False
                   }
  ]
dataEqNames :: FamEqn GhcRn (HsDataDefn GhcRn) -> [NameOccurrence]
dataEqNames FamEqn { feqn_tycon = tyCon } =
  [ NameOccurrence { locatedName = Just <$> reLocN tyCon
                   , description = "FamEqn"
                   , isBinder    = False
                   }
  ]

conDeclNames :: ConDecl GhcRn -> [NameOccurrence]
conDeclNames con = case con of
  ConDeclGADT { con_names = names } -> map
    (\n -> NameOccurrence { locatedName = Just <$> reLocN n
                          , description = "ConDeclGADT"
                          , isBinder    = True
                          }
    )
    names
  ConDeclH98 { con_name = name } ->
    [ NameOccurrence { locatedName = Just <$> reLocN name
                     , description = "ConDeclH98"
                     , isBinder    = True
                     }
    ]

foreignDeclNames :: ForeignDecl GhcRn -> [NameOccurrence]
foreignDeclNames decl =
  [ NameOccurrence { locatedName = Just <$> reLocN (fd_name decl)
                   , description = "ForeignDecl"
                   , isBinder    = True
                   }
  ]

roleAnnotationNames :: RoleAnnotDecl GhcRn -> [NameOccurrence]
roleAnnotationNames (RoleAnnotDecl _ n _) =
  [ NameOccurrence { locatedName = Just <$> reLocN n
                   , description = "RoleAnnotDecl"
                   , isBinder    = False
                   }
  ]

injectivityAnnotationNames :: InjectivityAnn GhcRn -> [NameOccurrence]
injectivityAnnotationNames (InjectivityAnn _ lhsName rhsNames) =
  injAnnNameOcc lhsName : map injAnnNameOcc rhsNames
 where
    -- injAnnNameOcc :: GenLocated SrcSpan Name -> NameOccurrence
  injAnnNameOcc n = NameOccurrence { locatedName = Just <$> reLocN n
                                   , description = "InjectivityAnn"
                                   , isBinder    = False
                                   }