Fix lint - use nubOrd on the values map keys

Author: pepeiborra

ghcide/src/Development/IDE/Core/FileExists.hs

@@ -102,7 +102,7 @@ modifyFileExists state changes = do
 type instance RuleResult GetFileExists = Bool
 
 data GetFileExists = GetFileExists
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 
 instance NFData   GetFileExists
 instance Hashable GetFileExists

ghcide/src/Development/IDE/Core/OfInterest.hs

@@ -40,7 +40,7 @@ instance IsIdeGlobal OfInterestVar
 type instance RuleResult GetFilesOfInterest = HashMap NormalizedFilePath FileOfInterestStatus
 
 data GetFilesOfInterest = GetFilesOfInterest
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetFilesOfInterest
 instance NFData   GetFilesOfInterest
 instance Binary   GetFilesOfInterest

ghcide/src/Development/IDE/Core/RuleTypes.hs

@@ -73,13 +73,13 @@ type instance RuleResult GetKnownTargets = KnownTargets
 type instance RuleResult GenerateCore = ModGuts
 
 data GenerateCore = GenerateCore
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GenerateCore
 instance NFData   GenerateCore
 instance Binary   GenerateCore
 
 data GetImportMap = GetImportMap
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetImportMap
 instance NFData   GetImportMap
 instance Binary   GetImportMap
@@ -197,7 +197,7 @@ type instance RuleResult GetModIfaceWithoutLinkable = HiFileResult
 type instance RuleResult GetFileContents = (FileVersion, Maybe Text)
 
 -- The Shake key type for getModificationTime queries
-data GetModificationTime = GetModificationTime_
+newtype GetModificationTime = GetModificationTime_
     { missingFileDiagnostics :: Bool
       -- ^ If false, missing file diagnostics are not reported
     }
@@ -208,6 +208,11 @@ instance Eq GetModificationTime where
     -- independent from the 'missingFileDiagnostics' field
     _ == _ = True
 
+instance Ord GetModificationTime where
+    -- Since the diagnostics are not part of the answer, the query identity is
+    -- independent from the 'missingFileDiagnostics' field
+    compare _ _ = EQ
+
 instance Hashable GetModificationTime where
     -- Since the diagnostics are not part of the answer, the query identity is
     -- independent from the 'missingFileDiagnostics' field
@@ -236,20 +241,20 @@ vfsVersion (VFSVersion i) = Just i
 vfsVersion ModificationTime{} = Nothing
 
 data GetFileContents = GetFileContents
-    deriving (Eq, Show, Generic)
+    deriving (Eq, Ord, Show, Generic)
 instance Hashable GetFileContents
 instance NFData   GetFileContents
 instance Binary   GetFileContents
 
 
 data FileOfInterestStatus = OnDisk | Modified
-  deriving (Eq, Show, Typeable, Generic)
+  deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable FileOfInterestStatus
 instance NFData   FileOfInterestStatus
 instance Binary   FileOfInterestStatus
 
 data IsFileOfInterestResult = NotFOI | IsFOI FileOfInterestStatus
-  deriving (Eq, Show, Typeable, Generic)
+  deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable IsFileOfInterestResult
 instance NFData   IsFileOfInterestResult
 instance Binary   IsFileOfInterestResult
@@ -265,13 +270,13 @@ type instance RuleResult GetModSummary = (ModSummary,[LImportDecl GhcPs])
 type instance RuleResult GetModSummaryWithoutTimestamps = (ModSummary,[LImportDecl GhcPs])
 
 data GetParsedModule = GetParsedModule
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetParsedModule
 instance NFData   GetParsedModule
 instance Binary   GetParsedModule
 
 data GetLocatedImports = GetLocatedImports
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetLocatedImports
 instance NFData   GetLocatedImports
 instance Binary   GetLocatedImports
@@ -280,109 +285,109 @@ instance Binary   GetLocatedImports
 type instance RuleResult NeedsCompilation = Bool
 
 data NeedsCompilation = NeedsCompilation
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable NeedsCompilation
 instance NFData   NeedsCompilation
 instance Binary   NeedsCompilation
 
 data GetDependencyInformation = GetDependencyInformation
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetDependencyInformation
 instance NFData   GetDependencyInformation
 instance Binary   GetDependencyInformation
 
 data GetModuleGraph = GetModuleGraph
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetModuleGraph
 instance NFData   GetModuleGraph
 instance Binary   GetModuleGraph
 
 data ReportImportCycles = ReportImportCycles
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable ReportImportCycles
 instance NFData   ReportImportCycles
 instance Binary   ReportImportCycles
 
 data GetDependencies = GetDependencies
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetDependencies
 instance NFData   GetDependencies
 instance Binary   GetDependencies
 
 data TypeCheck = TypeCheck
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable TypeCheck
 instance NFData   TypeCheck
 instance Binary   TypeCheck
 
 data GetDocMap = GetDocMap
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetDocMap
 instance NFData   GetDocMap
 instance Binary   GetDocMap
 
 data GetHieAst = GetHieAst
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetHieAst
 instance NFData   GetHieAst
 instance Binary   GetHieAst
 
 data GetBindings = GetBindings
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetBindings
 instance NFData   GetBindings
 instance Binary   GetBindings
 
 data GhcSession = GhcSession
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GhcSession
 instance NFData   GhcSession
 instance Binary   GhcSession
 
-data GhcSessionDeps = GhcSessionDeps deriving (Eq, Show, Typeable, Generic)
+data GhcSessionDeps = GhcSessionDeps deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GhcSessionDeps
 instance NFData   GhcSessionDeps
 instance Binary   GhcSessionDeps
 
 data GetModIfaceFromDisk = GetModIfaceFromDisk
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetModIfaceFromDisk
 instance NFData   GetModIfaceFromDisk
 instance Binary   GetModIfaceFromDisk
 
 data GetModIface = GetModIface
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetModIface
 instance NFData   GetModIface
 instance Binary   GetModIface
 
 data GetModIfaceWithoutLinkable = GetModIfaceWithoutLinkable
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetModIfaceWithoutLinkable
 instance NFData   GetModIfaceWithoutLinkable
 instance Binary   GetModIfaceWithoutLinkable
 
 data IsFileOfInterest = IsFileOfInterest
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable IsFileOfInterest
 instance NFData   IsFileOfInterest
 instance Binary   IsFileOfInterest
 
 data GetModSummaryWithoutTimestamps = GetModSummaryWithoutTimestamps
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetModSummaryWithoutTimestamps
 instance NFData   GetModSummaryWithoutTimestamps
 instance Binary   GetModSummaryWithoutTimestamps
 
 data GetModSummary = GetModSummary
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetModSummary
 instance NFData   GetModSummary
 instance Binary   GetModSummary
 
 -- | Get the vscode client settings stored in the ide state
 data GetClientSettings = GetClientSettings
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetClientSettings
 instance NFData   GetClientSettings
 instance Binary   GetClientSettings
@@ -394,7 +399,7 @@ type instance RuleResult GetClientSettings = Hashed (Maybe Value)
 -- https://github.com/digital-asset/daml/pull/2808#issuecomment-529639547
 type instance RuleResult GhcSessionIO = IdeGhcSession
 
-data GhcSessionIO = GhcSessionIO deriving (Eq, Show, Typeable, Generic)
+data GhcSessionIO = GhcSessionIO deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GhcSessionIO
 instance NFData   GhcSessionIO
 instance Binary   GhcSessionIO

ghcide/src/Development/IDE/Core/Rules.hs

@@ -973,7 +973,7 @@ mainRule = do
 -- corresponding `.hi` file is stable, that is, if it is newer
 --   than the src file, and all its dependencies are stable too.
 data IsHiFileStable = IsHiFileStable
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable IsHiFileStable
 instance NFData   IsHiFileStable
 instance Binary   IsHiFileStable

ghcide/src/Development/IDE/Core/Shake.hs

@@ -266,6 +266,7 @@ mappingForVersion allMappings file ver =
 type IdeRule k v =
   ( Shake.RuleResult k ~ v
   , Shake.ShakeValue k
+  , Ord k
   , Show v
   , Typeable v
   , NFData v
@@ -320,7 +321,7 @@ setValues state key file val = modifyVar_ state $ \vals -> do
 
 -- | Delete the value stored for a given ide build key
 deleteValue
-  :: (Typeable k, Hashable k, Eq k, Show k)
+  :: (Typeable k, Hashable k, Ord k, Show k)
   => IdeState
   -> k
   -> NormalizedFilePath
@@ -910,7 +911,7 @@ data OnDiskRule = OnDiskRule
 -- The reason why this code lives in ghcide and in particular in this module is that it depends quite heavily on
 -- the internals of this module that we do not want to expose.
 defineOnDisk
-  :: (Shake.ShakeValue k, RuleResult k ~ ())
+  :: (Shake.ShakeValue k, RuleResult k ~ (), Ord k)
   => (k -> NormalizedFilePath -> OnDiskRule)
   -> Rules ()
 defineOnDisk act = addBuiltinRule noLint noIdentity $

ghcide/src/Development/IDE/Core/Tracing.hs

@@ -111,7 +111,7 @@ performMeasurement logger stateRef instrumentFor mapCountInstrument = do
         `catch` \(e::SomeException) ->
         logInfo logger ("MEMORY PROFILING ERROR: " <> fromString (show e))
 
-{-# ANN startTelemetry ("HLint: ignore Use nubOrd" :: String) #-}
+{-# ANN performMeasurement ("HLint: ignore Use nubOrd" :: String) #-}
 
 type OurValueObserver = Int -> IO ()
 

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

@@ -229,6 +229,9 @@ instance Show HscEnvEq where
 instance Eq HscEnvEq where
   a == b = envUnique a == envUnique b
 
+instance Ord HscEnvEq where
+  a `compare` b = envUnique a `compare` envUnique b
+
 instance NFData HscEnvEq where
   rnf (HscEnvEq a b c d) = rnf (hashUnique a) `seq` b `seq` c `seq` rnf d
 

ghcide/src/Development/IDE/Plugin/CodeAction/RuleTypes.hs

@@ -17,7 +17,7 @@ import GHC.Generics (Generic)
 type instance RuleResult PackageExports = ExportsMap
 
 newtype PackageExports = PackageExports HscEnvEq
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 
 instance Hashable PackageExports
 instance NFData   PackageExports

ghcide/src/Development/IDE/Plugin/Completions.hs

@@ -97,19 +97,19 @@ type instance RuleResult LocalCompletions = CachedCompletions
 type instance RuleResult NonLocalCompletions = CachedCompletions
 
 data ProduceCompletions = ProduceCompletions
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable ProduceCompletions
 instance NFData   ProduceCompletions
 instance Binary   ProduceCompletions
 
 data LocalCompletions = LocalCompletions
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable LocalCompletions
 instance NFData   LocalCompletions
 instance Binary   LocalCompletions
 
 data NonLocalCompletions = NonLocalCompletions
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable NonLocalCompletions
 instance NFData   NonLocalCompletions
 instance Binary   NonLocalCompletions

ghcide/src/Development/IDE/Types/Shake.hs

@@ -28,7 +28,7 @@ currentValue Failed = Nothing
 type Values = HashMap (NormalizedFilePath, Key) (Value Dynamic)
 
 -- | Key type
-data Key = forall k . (Typeable k, Hashable k, Eq k, Show k) => Key k
+data Key = forall k . (Typeable k, Hashable k, Ord k, Show k) => Key k
 
 instance Show Key where
   show (Key k) = show k
@@ -37,5 +37,10 @@ instance Eq Key where
     Key k1 == Key k2 | Just k2' <- cast k2 = k1 == k2'
                      | otherwise = False
 
+instance Ord Key where
+    Key k1 `compare` Key k2 | Just k2' <- cast k2 = k1 `compare` k2'
+                            | otherwise = compare (typeOf k1) (typeOf k2)
+
+
 instance Hashable Key where
     hashWithSalt salt (Key key) = hashWithSalt salt (typeOf key, key)

plugins/default/src/Ide/Plugin/Example.hs

@@ -59,7 +59,7 @@ blah _ (Position line col)
 -- ---------------------------------------------------------------------
 
 data Example = Example
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable Example
 instance NFData   Example
 instance Binary   Example

plugins/default/src/Ide/Plugin/Example2.hs

@@ -58,7 +58,7 @@ blah _ (Position line col)
 -- ---------------------------------------------------------------------
 
 data Example2 = Example2
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable Example2
 instance NFData   Example2
 instance Binary   Example2

plugins/hls-hlint-plugin/src/Ide/Plugin/Hlint.hs

@@ -77,7 +77,7 @@ descriptor plId = (defaultPluginDescriptor plId)
 -- This rule only exists for generating file diagnostics
 -- so the RuleResult is empty
 data GetHlintDiagnostics = GetHlintDiagnostics
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetHlintDiagnostics
 instance NFData   GetHlintDiagnostics
 instance Binary   GetHlintDiagnostics
@@ -214,7 +214,7 @@ data HlintUsage
   deriving Show
 
 data GetHlintSettings = GetHlintSettings
-    deriving (Eq, Show, Typeable, Generic)
+    deriving (Eq, Ord, Show, Typeable, Generic)
 instance Hashable GetHlintSettings
 instance NFData   GetHlintSettings
 instance NFData Hint where rnf = rwhnf