Add local definitions to outline #4312

sgillespie · 2024-06-11T14:35:05Z

Addresses #3628. Adds all local symbols (functions/vars) as children to function document symbols.

There are a few potential issues:

The position/range points to the toplevel function
getFuzzyScope might be abused here (should I create another function like getLocalScope?)

Thoughts?

sgillespie · 2024-06-11T14:36:03Z

This is what the outline looks like in emacs (via imenu-list)

For a bit of extra context, here is one of the definitions:

f :: a -> a
f x = g x
  where
    g = id
    h = id

soulomoon · 2024-06-12T07:45:36Z

ghcide/src/Development/IDE/LSP/Outline.hs

+getRefMap :: HieAstResult -> RefMap Type
+getRefMap HAR{refMap=refMap, hieKind=hieKind} =
+  case hieKind of
+    HieFromDisk _ -> mempty


I have a question, why we use mempty for HieFromDisk here

This is mostly because I needed a RefMap Type, and I didn't know how to get there from RefMap TypeIndex. If this is important, I can keep hacking.

Maybe you can find some inspiration for how to recover full types here?

haskell-language-server/ghcide/src/Development/IDE/Spans/AtPoint.hs

Lines 298 to 299 in c11f32b

HieFresh -> printOutputable t

HieFromDisk full_file -> printOutputable $ hieTypeToIface $ recoverFullType t (hie_types full_file)

michaelpj · 2024-06-12T12:23:37Z

ghcide/src/Development/IDE/LSP/Outline.hs

@@ -41,11 +45,13 @@ moduleOutline ideState _ DocumentSymbolParams{ _textDocument = TextDocumentIdent
  = liftIO $ case uriToFilePath uri of
    Just (toNormalizedFilePath' -> fp) -> do
      mb_decls <- fmap fst <$> runAction "Outline" ideState (useWithStale GetParsedModule fp)
+      mb_hieAst <- fmap fst <$> runAction "Outline" ideState (useWithStale GetHieAst fp)


Hmmm, these are both ignoring the position mapping, which is probably risky? It means we might create document symbols with out-of-date locations.

michaelpj · 2024-06-13T10:20:24Z

ghcide/src/Development/IDE/LSP/Outline.hs

@@ -282,4 +305,11 @@ hsConDeclsBinders cons
             -> [LFieldOcc GhcPs]
    get_flds flds = concatMap (cd_fld_names . unLoc) (unLoc flds)

-
+getLocalBindings :: RefMap Type -> LHsDecl GhcPs -> [Name]


This could do with some explanation: I'm not sure reading this why this is the right way to get the local bindings.

What is confusing? Is it the use of getFuzzyScope or is it something else?

I guess I'm just rather unsure why this is the right thing to do? Why is it okay to use getFuzzyScope rather than getLocalScope? What's going on with position mapping?

According to my testing, getLocalScope only returns symbols at the current start point (the start of the given function), which does not appear to have the locals in scope. getFuzzyScope returns all symbols that have intersecting scopes. This makes sense to me when I look at the docs for IntervalMap.FingerTree's dominator (getLocalScope) and intersections (getFuzzyScope):

dominators:

O(k log (n/k)). All intervals that contain the given interval, in lexicographical order.

intersections

O(k log (n/k)). All intervals that intersect with the given interval, in lexicographical order.

It's clear that there at least needs a comment there, but maybe it would be better to create a new function with a clearer name?

According to my testing, getLocalScope only returns symbols at the current start point (the start of the given function), which does not appear to have the locals in scope.

I feel confused about what getLocalScope is for then, if not this? Are we using it wrong?

michaelpj · 2024-06-13T10:21:19Z

ghcide/src/Development/IDE/LSP/Outline.hs

+getLocalBindings refmap (L (locA -> (RealSrcSpan l _)) _) =
+  nubOrdOn getOccFS . filter isVarName . map fst $ locals
+  where
+    locals = getFuzzyScope (bindings refmap) start end


This doesn't recurse, right? So presumably this won't handle something like:

f = ... where g = ... where h = ...

?

Worth adding as a test case even if we don't support it, but also maybe we just can support it?

It actually does recurse, I've just pushed an update that adds this and the other test case below

michaelpj · 2024-06-14T09:49:01Z

A test case I'd like to see

f 1 = g
  where g = 2
f _ = g 
  where g = 3

michaelpj

Tests are helpful! I think the results look a bit off?

michaelpj · 2024-06-17T08:45:56Z

ghcide/test/exe/OutlineTests.hs

+            (R 0 0 0 34)
+            [ docSymbol "x" SymbolKind_Function (R 0 0 0 34)
+            , docSymbol "g" SymbolKind_Function (R 0 0 0 34)
+            , docSymbol "h" SymbolKind_Function (R 0 0 0 34)


These locations are wrong? They all have the range of the original binding?

Also, shouldn't h be a child of g, not of a?

michaelpj · 2024-06-17T08:46:35Z

ghcide/test/exe/OutlineTests.hs

+            "f"
+            SymbolKind_Function
+            (R 0 0 1 19)
+            [docSymbol "g" SymbolKind_Function (R 0 0 1 19)]


This seems wrong, there should be two gs?

sgillespie requested a review from wz1000 as a code owner June 11, 2024 14:35

Add local definitions to outline

62fb5c1

sgillespie force-pushed the feature/doc-local-defs branch from 1cb369c to 62fb5c1 Compare June 11, 2024 14:37

soulomoon reviewed Jun 12, 2024

View reviewed changes

michaelpj reviewed Jun 13, 2024

View reviewed changes

Add more outline test cases for local definitions

1c3a1ae

michaelpj reviewed Jun 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add local definitions to outline #4312

Add local definitions to outline #4312

sgillespie commented Jun 11, 2024

sgillespie commented Jun 11, 2024 •

edited

Loading

soulomoon Jun 12, 2024

sgillespie Jun 13, 2024

jhrcek Jun 13, 2024

michaelpj Jun 12, 2024

michaelpj Jun 13, 2024

sgillespie Jun 13, 2024

michaelpj Jun 14, 2024

sgillespie Jun 15, 2024

michaelpj Jun 17, 2024

michaelpj Jun 13, 2024

sgillespie Jun 15, 2024

michaelpj commented Jun 14, 2024

michaelpj left a comment

michaelpj Jun 17, 2024

michaelpj Jun 17, 2024

michaelpj Jun 17, 2024

	HieFresh -> printOutputable t
	HieFromDisk full_file -> printOutputable $ hieTypeToIface $ recoverFullType t (hie_types full_file)

Add local definitions to outline #4312

Are you sure you want to change the base?

Add local definitions to outline #4312

Conversation

sgillespie commented Jun 11, 2024

sgillespie commented Jun 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelpj commented Jun 14, 2024

michaelpj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sgillespie commented Jun 11, 2024 •

edited

Loading