Rename to IdeDurableState

Author: purefunctor

src/Language/PureScript/Ide/State.hs

@@ -65,7 +65,8 @@ import System.Directory (getModificationTime)
 resetIdeState :: Ide m => m ()
 resetIdeState = do
   ideVar <- ideStateVar <$> ask
-  liftIO (atomically (writeTVar ideVar emptyIdeState))
+  durableState <- getDurableState
+  liftIO (atomically (writeTVar ideVar (emptyIdeState { ideDurableState = durableState })))
 
 getOutputDirectory :: Ide m => m FilePath
 getOutputDirectory = do
@@ -145,21 +146,21 @@ setVolatileStateSTM ref vs = do
     x {ideVolatileState = vs}
   pure ()
 
--- | Retrieves the ModifierState from the State.
-getModifierState :: Ide m => m IdeModifierState
-getModifierState = do
+-- | Retrieves the DurableState from the State.
+getDurableState :: Ide m => m IdeDurableState
+getDurableState = do
   st <- ideStateVar <$> ask
-  liftIO (atomically (getModifierStateSTM st))
+  liftIO (atomically (getDurableStateSTM st))
 
--- | STM version of getModifierState
-getModifierStateSTM :: TVar IdeState -> STM IdeModifierState
-getModifierStateSTM ref = ideModifierState <$> readTVar ref
+-- | STM version of getDurableState
+getDurableStateSTM :: TVar IdeState -> STM IdeDurableState
+getDurableStateSTM ref = ideDurableState <$> readTVar ref
 
--- | Sets the ModifierState inside Ide's state
-setModifierStateSTM :: TVar IdeState -> IdeModifierState -> STM ()
-setModifierStateSTM ref md = do
+-- | Sets the DurableState inside Ide's state
+setDurableStateSTM :: TVar IdeState -> IdeDurableState -> STM ()
+setDurableStateSTM ref md = do
   modifyTVar ref $ \x ->
-    x {ideModifierState = md}
+    x {ideDurableState = md}
   pure ()
 
 -- | Checks if the given ModuleName matches the last rebuild cache and if it
@@ -474,7 +475,7 @@ resolveDataConstructorsForModule decls =
 
 getFocusedModules :: Ide m => m (Set P.ModuleName)
 getFocusedModules = do
-  IdeModifierState{mdFocusedModules = focusedModules} <- getModifierState
+  IdeDurableState{drFocusedModules = focusedModules} <- getDurableState
   pure focusedModules
 
 setFocusedModules :: Ide m => [P.ModuleName] -> m ()
@@ -484,5 +485,4 @@ setFocusedModules modulesToFocus = do
 
 setFocusedModulesSTM :: TVar IdeState -> [P.ModuleName] -> STM ()
 setFocusedModulesSTM ref modulesToFocus = do
-  IdeModifierState{} <- getModifierStateSTM ref
-  setModifierStateSTM ref (IdeModifierState (Set.fromList modulesToFocus))
+  setDurableStateSTM ref (IdeDurableState (Set.fromList modulesToFocus))

src/Language/PureScript/Ide/Types.hs

@@ -15,6 +15,7 @@ import Data.Aeson qualified as Aeson
 import Data.IORef (IORef)
 import Data.Time.Clock (UTCTime)
 import Data.Map.Lazy qualified as M
+import Data.Set qualified as S
 import Language.PureScript qualified as P
 import Language.PureScript.Errors.JSON qualified as P
 import Language.PureScript.Ide.Filter.Declaration (DeclarationType(..))
@@ -178,20 +179,20 @@ type Ide m = (MonadIO m, MonadReader IdeEnvironment m)
 data IdeState = IdeState
   { ideFileState :: IdeFileState
   , ideVolatileState :: IdeVolatileState
-  , ideModifierState :: IdeModifierState
+  , ideDurableState :: IdeDurableState
   } deriving (Show)
 
 emptyIdeState :: IdeState
-emptyIdeState = IdeState emptyFileState emptyVolatileState emptyModifierState
+emptyIdeState = IdeState emptyFileState emptyVolatileState emptyDurableState
 
 emptyFileState :: IdeFileState
 emptyFileState = IdeFileState M.empty M.empty
 
 emptyVolatileState :: IdeVolatileState
 emptyVolatileState = IdeVolatileState (AstData M.empty) M.empty Nothing
 
-emptyModifierState :: IdeModifierState
-emptyModifierState = IdeModifierState mempty
+emptyDurableState :: IdeDurableState
+emptyDurableState = IdeDurableState S.empty
 
 -- | @IdeFileState@ holds data that corresponds 1-to-1 to an entity on the
 -- filesystem. Externs correspond to the ExternsFiles the compiler emits into
@@ -216,8 +217,13 @@ data IdeVolatileState = IdeVolatileState
   , vsCachedRebuild :: Maybe (P.ModuleName, P.ExternsFile)
   } deriving (Show)
 
-data IdeModifierState = IdeModifierState
-  { mdFocusedModules :: Set P.ModuleName
+-- | @IdeDurableState@ holds data that persists across resets of the @IdeState@.
+-- This is particularly useful for configuration variables that can be modified
+-- during runtime. For instance, the module names for the "focus" feature are 
+-- stored in the drFocusedModules field, which the client populates using the
+-- @Focus@ command to specify only which modules to load.
+data IdeDurableState = IdeDurableState
+  { drFocusedModules :: Set P.ModuleName
   } deriving (Show)
 
 newtype Match a = Match (P.ModuleName, a)