Use pretty printing context when expanding records (#4917)

* Add reproducer

* Utilize pretty print context when expanding records

* Address review feedback

* Add explicit-record test with unicode fields

* Move `formatOutputable` to `Utils` and rename

Author: crtschin

ghcide/src/Development/IDE/GHC/Compat/Outputable.hs

@@ -100,8 +100,6 @@ printSDocQualifiedUnsafe unqual doc =
     sty  = mkUserStyle unqual AllTheWay
     doc' = pprWithUnitState emptyUnitState doc
 
-
-
 formatErrorWithQual :: DynFlags -> MsgEnvelope DecoratedSDoc -> String
 formatErrorWithQual dflags e =
   showSDoc dflags (pprNoLocMsgEnvelope e)

ghcide/src/Development/IDE/GHC/Util.hs

@@ -28,6 +28,7 @@ module Development.IDE.GHC.Util(
     disableWarningsAsErrors,
     printOutputable,
     printOutputableOneLine,
+    printOutputableQualified,
     getExtensions,
     getExtensionsSet,
     stripOccNamePrefix,
@@ -271,6 +272,10 @@ printOutputable = printOutputable' printWithoutUniques
 printOutputableOneLine :: Outputable a => a -> T.Text
 printOutputableOneLine = printOutputable' printWithoutUniquesOneLine
 
+printOutputableQualified :: Outputable a => PrintUnqualified -> a -> T.Text
+printOutputableQualified ctx =
+    printOutputable' (printSDocQualifiedUnsafe ctx . ppr)
+
 printOutputable' :: Outputable a => (a -> String) -> a -> T.Text
 printOutputable' print =
     -- IfaceTyLit from GHC.Iface.Type implements Outputable with 'show'.

plugins/hls-explicit-record-fields-plugin/src/Ide/Plugin/ExplicitFields.hs

@@ -38,8 +38,10 @@ test = testGroup "explicit-fields"
     , mkTestNoAction "Prefix" "Prefix" 10 11 10 28
     , mkTestNoAction "PartiallyAppliedCon" "PartiallyAppliedCon" 7 8 7 12
     , mkConversionTest "PolymorphicRecordConstruction" "PolymorphicRecordConstruction" 15 5 15 15
+    , mkConversionTest "QualifiedPositionalConstruction" "QualifiedPositionalConstruction" 9 10 9 15
     , mkConversionTest "CursorAwarePositional" "CursorPositional" 15 26 15 34
     , mkExpansionTest "CursorAwareRecords" "CursorRecords" 9 40 9 40
+    , mkConversionTest "UnicodeStrings" "UnicodeStrings" 10 12 10 17
     ]
   , testGroup "inlay hints"
     [ mkInlayHintsTest "Construction" Nothing 16 $ \ih -> do
@@ -294,6 +296,24 @@ test = testGroup "explicit-fields"
                          , _paddingLeft = Nothing
                          }
           ]
+    , mkInlayHintsTest "UnicodeStrings" Nothing 10 $ \ih -> do
+        let mkLabelPart' = mkLabelPartOffsetLengthSub1 "UnicodeStrings"
+        name  <- mkLabelPart' 5 4 "αβγa="
+        count <- mkLabelPart' 6 4 "count="
+        (@?=) ih
+          [ defInlayHint { _position = Position 10 18
+                         , _label = InR [ name ]
+                         , _textEdits = Just [ mkLineTextEdit "MyRec { αβγa = \"αβγ\", count = 42 }" 10 12 26 ]
+                         , _tooltip = Just $ InL "Convert to traditional record syntax"
+                         , _paddingLeft = Nothing
+                         }
+          , defInlayHint { _position = Position 10 24
+                         , _label = InR [ count ]
+                         , _textEdits = Just [ mkLineTextEdit "MyRec { αβγa = \"αβγ\", count = 42 }" 10 12 26 ]
+                         , _tooltip = Just $ InL "Convert to traditional record syntax"
+                         , _paddingLeft = Nothing
+                         }
+          ]
     , mkInlayHintsTest "CursorRecords" Nothing 9 $ \ih -> do
         let mkLabelPart' = mkLabelPartOffsetLength "CursorRecords"
         a0  <- mkLabelPart' 3 14 "a0"

plugins/hls-explicit-record-fields-plugin/test/Main.hs

@@ -0,0 +1,10 @@
+{-# LANGUAGE Haskell2010 #-}
+
+module QualifiedPositionalConstruction where
+
+import qualified Data.Foldable as Foldable
+
+data Foo = Foo { bar :: [Int] }
+
+foo :: Foo
+foo = Foo { bar = (Foldable.toList [1, 2, 3]) }

plugins/hls-explicit-record-fields-plugin/test/testdata/QualifiedPositionalConstruction.expected.hs

@@ -0,0 +1,10 @@
+{-# LANGUAGE Haskell2010 #-}
+
+module QualifiedPositionalConstruction where
+
+import qualified Data.Foldable as Foldable
+
+data Foo = Foo { bar :: [Int] }
+
+foo :: Foo
+foo = Foo (Foldable.toList [1, 2, 3])

plugins/hls-explicit-record-fields-plugin/test/testdata/QualifiedPositionalConstruction.hs

@@ -0,0 +1,11 @@
+{-# LANGUAGE Haskell2010 #-}
+
+module UnicodeStrings where
+
+data MyRec = MyRec
+  { αβγa  :: String
+  , count :: Int
+  }
+
+convertMe :: MyRec
+convertMe = MyRec { αβγa = "αβγ", count = 42 }

plugins/hls-explicit-record-fields-plugin/test/testdata/UnicodeStrings.expected.hs

@@ -0,0 +1,11 @@
+{-# LANGUAGE Haskell2010 #-}
+
+module UnicodeStrings where
+
+data MyRec = MyRec
+  { αβγa  :: String
+  , count :: Int
+  }
+
+convertMe :: MyRec
+convertMe = MyRec "αβγ" 42