Skip to content

Fix completion snippets on DuplicateRecordFields #1360

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 3 commits into from
Feb 13, 2021
Merged

Fix completion snippets on DuplicateRecordFields #1360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
791add2
Use par_lbl rather than gre_name for field selectors
berberman Feb 12, 2021
05d81a2
Add test
berberman Feb 13, 2021
e5ca4ad
Merge branch 'master' into fix-completion
berberman Feb 13, 2021
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
25 changes: 10 additions & 15 deletions ghcide/src/Development/IDE/Plugin/Completions/Logic.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,13 @@ mkAdditionalEditsCommand :: PluginId -> ExtendImport -> IO Command
mkAdditionalEditsCommand pId edits =
mkLspCommand pId (CommandId extendImportCommandId) "extend import" (Just [toJSON edits])

mkNameCompItem :: Uri -> Maybe T.Text -> Name -> ModuleName -> Maybe Type -> Maybe Backtick -> SpanDoc -> Maybe (LImportDecl GhcPs) -> CompItem
mkNameCompItem :: Uri -> Maybe T.Text -> OccName -> ModuleName -> Maybe Type -> Maybe Backtick -> SpanDoc -> Maybe (LImportDecl GhcPs) -> CompItem
mkNameCompItem doc thingParent origName origMod thingType isInfix docs !imp = CI {..}
where
compKind = occNameToComKind typeText $ occName origName
compKind = occNameToComKind typeText origName
importedFrom = Right $ showModName origMod
isTypeCompl = isTcOcc $ occName origName
label = showGhc origName
isTypeCompl = isTcOcc origName
label = stripPrefix $ showGhc origName
insertText = case isInfix of
Nothing -> case getArgText <$> thingType of
Nothing -> label
Expand Down Expand Up @@ -345,10 +345,10 @@ cacheDataProducer uri packageState curMod globalEnv inScopeEnv limports deps = d
toCompItem :: Parent -> Module -> ModuleName -> Name -> Maybe (LImportDecl GhcPs) -> IO [CompItem]
toCompItem par m mn n imp' = do
docs <- getDocumentationTryGhc packageState curMod deps n
let mbParent = case par of
NoParent -> Nothing
ParentIs n -> Just (showNameWithoutUniques n)
FldParent n _ -> Just (showNameWithoutUniques n)
let (mbParent, originName) = case par of
NoParent -> (Nothing, nameOccName n)
ParentIs n' -> (Just $ showNameWithoutUniques n', nameOccName n)
FldParent n' lbl -> (Just $ showNameWithoutUniques n', maybe (nameOccName n) mkVarOccFS lbl)
tys <- catchSrcErrors (hsc_dflags packageState) "completion" $ do
name' <- lookupName packageState m n
return ( name' >>= safeTyThingType
Expand All @@ -361,7 +361,7 @@ cacheDataProducer uri packageState curMod globalEnv inScopeEnv limports deps = d
[mkRecordSnippetCompItem uri mbParent ctxStr flds (ppr mn) docs imp']
_ -> []

return $ mkNameCompItem uri mbParent n mn ty Nothing docs imp'
return $ mkNameCompItem uri mbParent originName mn ty Nothing docs imp'
: recordCompls

(unquals,quals) <- getCompls rdrElts
Expand Down Expand Up @@ -588,7 +588,7 @@ getCompletions plId ideOpts CC {allModNamesAsNS, unqualCompls, qualCompls, impor
-> return $ filtPragmaCompls (pragmaSuffix fullLine)
| otherwise -> do
let uniqueFiltCompls = nubOrdOn insertText filtCompls
compls <- mapM (mkCompl plId ideOpts . stripAutoGenerated) uniqueFiltCompls
compls <- mapM (mkCompl plId ideOpts) uniqueFiltCompls
return $ filtModNameCompls
++ filtKeywordCompls
++ map ( toggleSnippets caps withSnippets) compls
Expand Down Expand Up @@ -657,16 +657,11 @@ openingBacktick line prefixModule prefixText Position { _character }

-- | Under certain circumstance GHC generates some extra stuff that we
-- don't want in the autocompleted symbols
stripAutoGenerated :: CompItem -> CompItem
stripAutoGenerated ci =
ci {label = stripPrefix (label ci)}
{- When e.g. DuplicateRecordFields is enabled, compiler generates
names like "$sel:accessor:One" and "$sel:accessor:Two" to disambiguate record selectors
https://ghc.haskell.org/trac/ghc/wiki/Records/OverloadedRecordFields/DuplicateRecordFields#Implementation
-}

-- TODO: Turn this into an alex lexer that discards prefixes as if they were whitespace.

stripPrefix :: T.Text -> T.Text
stripPrefix name = T.takeWhile (/=':') $ go prefixes
where
Expand Down
21 changes: 21 additions & 0 deletions ghcide/test/exe/Main.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3948,6 +3948,27 @@ otherCompletionTests = [
(Position 3 11)
[("Integer", CiStruct, "Integer ", True, True, Nothing)],

testSession "duplicate record fields" $ do
void $
createDoc "B.hs" "haskell" $
T.unlines
[ "{-# LANGUAGE DuplicateRecordFields #-}",
"module B where",
"newtype Foo = Foo { member :: () }",
"newtype Bar = Bar { member :: () }"
]
docA <-
createDoc "A.hs" "haskell" $
T.unlines
[ "module A where",
"import B",
"memb"
]
_ <- waitForDiagnostics
compls <- getCompletions docA $ Position 2 4
let compls' = [txt | CompletionItem {_insertText = Just txt, ..} <- compls, _label == "member"]
liftIO $ compls' @?= ["member ${1:Foo}", "member ${1:Bar}"],

testSessionWait "maxCompletions" $ do
doc <- createDoc "A.hs" "haskell" $ T.unlines
[ "{-# OPTIONS_GHC -Wunused-binds #-}",
Expand Down