Skip to content

Record Dot Hover Types #3016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 19, 2022
Merged

Record Dot Hover Types #3016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
790421a
patch hieast
coltenwebb Jul 4, 2022
d0d7c66
add comments
coltenwebb Jul 16, 2022
7b71c0d
add hlint ignore
coltenwebb Jul 16, 2022
96e3546
update readme
coltenwebb Jul 17, 2022
2082248
add tests
coltenwebb Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions ghcide/test/data/hover/RecordDotSyntax.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 902
{-# LANGUAGE OverloadedRecordDot, DuplicateRecordFields, NoFieldSelectors #-}

module RecordDotSyntax ( module RecordDotSyntax) where

import qualified Data.Maybe as M

data MyRecord = MyRecord
{ a :: String
, b :: Integer
, c :: MyChild
} deriving (Eq, Show)

newtype MyChild = MyChild
{ z :: String
} deriving (Eq, Show)

x = MyRecord { a = "Hello", b = 12, c = MyChild { z = "there" } }
y = x.a ++ show x.b ++ x.c.z
#endif
2 changes: 1 addition & 1 deletion ghcide/test/data/hover/hie.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
cradle: {direct: {arguments: ["Foo", "Bar", "GotoHover"]}}
cradle: {direct: {arguments: ["Foo", "Bar", "GotoHover", "RecordDotSyntax"]}}
27 changes: 18 additions & 9 deletions ghcide/test/exe/Main.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4283,8 +4283,8 @@ canonicalizeLocation (Location uri range) = Location <$> canonicalizeUri uri <*>
findDefinitionAndHoverTests :: TestTree
findDefinitionAndHoverTests = let

tst :: (TextDocumentIdentifier -> Position -> Session a, a -> Session [Expect] -> Session ()) -> Position -> Session [Expect] -> String -> TestTree
tst (get, check) pos targetRange title = testSessionWithExtraFiles "hover" title $ \dir -> do
tst :: (TextDocumentIdentifier -> Position -> Session a, a -> Session [Expect] -> Session ()) -> Position -> String -> Session [Expect] -> String -> TestTree
tst (get, check) pos sfp targetRange title = testSessionWithExtraFiles "hover" title $ \dir -> do

-- Dirty the cache to check that definitions work even in the presence of iface files
liftIO $ runInDir dir $ do
Expand All @@ -4294,7 +4294,7 @@ findDefinitionAndHoverTests = let
_ <- getHover fooDoc $ Position 4 3
closeDoc fooDoc

doc <- openTestDataDoc (dir </> sourceFilePath)
doc <- openTestDataDoc (dir </> sfp)
waitForProgressDone
found <- get doc pos
check found targetRange
Expand Down Expand Up @@ -4352,16 +4352,25 @@ findDefinitionAndHoverTests = let
[ ( "GotoHover.hs", [(DsError, (62, 7), "Found hole: _")])
, ( "GotoHover.hs", [(DsError, (65, 8), "Found hole: _")])
]
, testGroup "type-definition" typeDefinitionTests ]

typeDefinitionTests = [ tst (getTypeDefinitions, checkDefs) aaaL14 (pure tcData) "Saturated data con"
, tst (getTypeDefinitions, checkDefs) aL20 (pure [ExpectNoDefinitions]) "Polymorphic variable"]
, testGroup "type-definition" typeDefinitionTests
, testGroup "hover-record-dot-syntax" recordDotSyntaxTests ]

typeDefinitionTests = [ tst (getTypeDefinitions, checkDefs) aaaL14 sourceFilePath (pure tcData) "Saturated data con"
, tst (getTypeDefinitions, checkDefs) aL20 sourceFilePath (pure [ExpectNoDefinitions]) "Polymorphic variable"]

recordDotSyntaxTests
| ghcVersion == GHC92 =
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, too late: should this check be more generous? We expect these tests to work on later versions also, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that's correct. I'll make a PR for that

[ tst (getHover, checkHover) (Position 19 24) (T.unpack "RecordDotSyntax.hs") (pure [ExpectHoverText ["x :: MyRecord"]]) "hover over parent"
, tst (getHover, checkHover) (Position 19 25) (T.unpack "RecordDotSyntax.hs") (pure [ExpectHoverText ["_ :: MyChild"]]) "hover over dot shows child"
, tst (getHover, checkHover) (Position 19 26) (T.unpack "RecordDotSyntax.hs") (pure [ExpectHoverText ["_ :: MyChild"]]) "hover over child"
]
| otherwise = []

test runDef runHover look expect = testM runDef runHover look (return expect)

testM runDef runHover look expect title =
( runDef $ tst def look expect title
, runHover $ tst hover look expect title ) where
( runDef $ tst def look sourceFilePath expect title
, runHover $ tst hover look sourceFilePath expect title ) where
def = (getDefinitions, checkDefs)
hover = (getHover , checkHover)

Expand Down
4 changes: 4 additions & 0 deletions hie-compat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@ Mainly a backport of [HIE
Files](https://gitlab.haskell.org/ghc/ghc/-/wikis/hie-files) for ghc 8.6, along
with a few other backports of fixes useful for `ghcide`

Also includes backport of record-dot-syntax support to 9.2.x

Fully compatible with `.hie` files natively produced by versions of GHC that support
them.

**THIS DOES NOT LET YOU READ HIE FILES WITH MISMATCHED VERSIONS OF GHC**

Backports included:

https://gitlab.haskell.org/ghc/ghc/-/merge_requests/8589

https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4037

https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4068
Expand Down
4 changes: 2 additions & 2 deletions hie-compat/hie-compat.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@ library
if (impl(ghc > 8.9) && impl(ghc < 8.11))
hs-source-dirs: src-ghc810 src-reexport
if (impl(ghc >= 9.0) && impl(ghc < 9.1) || flag(ghc-lib))
hs-source-dirs: src-reexport-ghc9
hs-source-dirs: src-ghc90 src-reexport-ghc9
if (impl(ghc >= 9.2) && impl(ghc < 9.3))
hs-source-dirs: src-reexport-ghc9
hs-source-dirs: src-ghc92 src-reexport-ghc9
0 ...compat/src-reexport-ghc9/Compat/HieAst.hs → hie-compat/src-ghc90/Compat/HieAst.hs
View file
Open in desktop
File renamed without changes.
Loading