(hacky->principled)StringIgnoreContext

Author: Anton-Latukha

src/Nix/Builtins.hs

@@ -392,7 +392,7 @@ unsafeGetAttrPos
   -> m (NValue t f m)
 unsafeGetAttrPos x y = demand x $ \x' -> demand y $ \y' -> case (x', y') of
   (NVStr ns, NVSet _ apos) ->
-    case M.lookup (hackyStringIgnoreContext ns) apos of
+    case M.lookup (principledStringIgnoreContext ns) apos of
       Nothing    -> pure $ nvConstant NNull
       Just delta -> toValue delta
   (x, y) ->
@@ -866,7 +866,7 @@ instance Comonad f => Eq (WValue t f m) where
   WValue (NVConstant (NFloat x)) == WValue (NVConstant (NFloat y)) = x == y
   WValue (NVPath     x         ) == WValue (NVPath     y         ) = x == y
   WValue (NVStr x) == WValue (NVStr y) =
-    hackyStringIgnoreContext x == hackyStringIgnoreContext y
+    principledStringIgnoreContext x == principledStringIgnoreContext y
   _ == _ = False
 
 instance Comonad f => Ord (WValue t f m) where
@@ -878,7 +878,7 @@ instance Comonad f => Ord (WValue t f m) where
   WValue (NVConstant (NFloat x)) <= WValue (NVConstant (NFloat y)) = x <= y
   WValue (NVPath     x         ) <= WValue (NVPath     y         ) = x <= y
   WValue (NVStr x) <= WValue (NVStr y) =
-    hackyStringIgnoreContext x <= hackyStringIgnoreContext y
+    principledStringIgnoreContext x <= principledStringIgnoreContext y
   _ <= _ = False
 
 genericClosure
@@ -1019,7 +1019,7 @@ toFile name s = do
   -- runtime references of the resulting file.
   -- See prim_toFile in nix/src/libexpr/primops.cc
   mres  <- toFile_ (Text.unpack name')
-                   (Text.unpack $ hackyStringIgnoreContext s')
+                   (Text.unpack $ principledStringIgnoreContext s')
   let t  = Text.pack $ unStorePath mres
       sc = StringContext t DirectPath
   toValue $ principledMakeNixStringWithSingletonContext t sc
@@ -1030,7 +1030,7 @@ toPath = fromValue @Path >=> toValue @Path
 pathExists_ :: MonadNix e t f m => NValue t f m -> m (NValue t f m)
 pathExists_ path = demand path $ \case
   NVPath p  -> toValue =<< pathExists p
-  NVStr  ns -> toValue =<< pathExists (Text.unpack (hackyStringIgnoreContext ns))
+  NVStr  ns -> toValue =<< pathExists (Text.unpack (principledStringIgnoreContext ns))
   v ->
     throwError
       $  ErrorCall
@@ -1248,7 +1248,7 @@ placeHolder = fromValue >=> fromStringNoContext >=> \t -> do
 absolutePathFromValue :: MonadNix e t f m => NValue t f m -> m FilePath
 absolutePathFromValue = \case
   NVStr ns -> do
-    let path = Text.unpack $ hackyStringIgnoreContext ns
+    let path = Text.unpack $ principledStringIgnoreContext ns
     unless (isAbsolute path)
       $  throwError
       $  ErrorCall
@@ -1272,7 +1272,7 @@ findFile_
 findFile_ aset filePath = demand aset $ \aset' -> demand filePath $ \filePath' ->
   case (aset', filePath') of
     (NVList x, NVStr ns) -> do
-      mres <- findPath @t @f @m x (Text.unpack (hackyStringIgnoreContext ns))
+      mres <- findPath @t @f @m x (Text.unpack (principledStringIgnoreContext ns))
       pure $ nvPath mres
     (NVList _, y) ->
       throwError $ ErrorCall $ "expected a string, got " ++ show y
@@ -1393,7 +1393,7 @@ exec_ xs = do
   -- TODO Still need to do something with the context here
   -- See prim_exec in nix/src/libexpr/primops.cc
   -- Requires the implementation of EvalState::realiseContext
-  exec (map (Text.unpack . hackyStringIgnoreContext) xs)
+  exec (map (Text.unpack . principledStringIgnoreContext) xs)
 
 fetchurl
   :: forall e t f m . MonadNix e t f m => NValue t f m -> m (NValue t f m)

src/Nix/Effects/Basic.hs

@@ -137,7 +137,7 @@ findPathBy finder ls name = do
         Nothing -> tryPath path Nothing
         Just pf -> demand pf $ fromValueMay >=> \case
           Just (nsPfx :: NixString) ->
-            let pfx = hackyStringIgnoreContext nsPfx
+            let pfx = principledStringIgnoreContext nsPfx
             in  if not (Text.null pfx)
                   then tryPath path (Just (Text.unpack pfx))
                   else tryPath path Nothing
@@ -174,7 +174,7 @@ fetchTarball = flip demand $ \case
  where
   go :: Maybe (NValue t f m) -> NValue t f m -> m (NValue t f m)
   go msha = \case
-    NVStr ns -> fetch (hackyStringIgnoreContext ns) msha
+    NVStr ns -> fetch (principledStringIgnoreContext ns) msha
     v ->
       throwError
         $  ErrorCall
@@ -197,7 +197,7 @@ fetchTarball = flip demand $ \case
   fetch uri Nothing =
     nixInstantiateExpr $ "builtins.fetchTarball \"" ++ Text.unpack uri ++ "\""
   fetch url (Just t) = demand t $ fromValue >=> \nsSha ->
-    let sha = hackyStringIgnoreContext nsSha
+    let sha = principledStringIgnoreContext nsSha
     in  nixInstantiateExpr
           $  "builtins.fetchTarball { "
           ++ "url    = \""

src/Nix/Eval.hs

@@ -355,7 +355,7 @@ evalSetterKeyName = \case
   StaticKey k -> pure (Just k)
   DynamicKey k ->
     runAntiquoted "\n" assembleString (>>= fromValueMay) k <&> \case
-      Just ns -> Just (hackyStringIgnoreContext ns)
+      Just ns -> Just (principledStringIgnoreContext ns)
       _       -> Nothing
 
 assembleString

src/Nix/Exec.hs

@@ -210,7 +210,7 @@ instance MonadNix e t f m => MonadEval (NValue t f m) m where
       pure $ nvStrP
         (Provenance
           scope
-          (NStr_ span (DoubleQuoted [Plain (hackyStringIgnoreContext ns)]))
+          (NStr_ span (DoubleQuoted [Plain (principledStringIgnoreContext ns)]))
         )
         ns
     Nothing -> nverr $ ErrorCall "Failed to assemble string"

src/Nix/Pretty.hs

@@ -330,7 +330,7 @@ valueToExpr = iterNValue (\_ _ -> thk) phi
   phi (NVBuiltin' name _) = Fix . NSym . pack $ "builtins." ++ name
   phi _                   = error "Pattern synonyms foil completeness check"
 
-  mkStr ns = Fix $ NStr $ DoubleQuoted [Plain (hackyStringIgnoreContext ns)]
+  mkStr ns = Fix $ NStr $ DoubleQuoted [Plain (principledStringIgnoreContext ns)]
 
 prettyNValue
   :: forall t f m ann . MonadDataContext f m => NValue t f m -> Doc ann
@@ -390,7 +390,7 @@ printNix = iterNValue (\_ _ -> thk) phi
 
   phi :: NValue' t f m String -> String
   phi (NVConstant' a ) = unpack $ atomText a
-  phi (NVStr'      ns) = show $ hackyStringIgnoreContext ns
+  phi (NVStr'      ns) = show $ principledStringIgnoreContext ns
   phi (NVList'     l ) = "[ " ++ unwords l ++ " ]"
   phi (NVSet' s _) =
     "{ "

src/Nix/String.hs

@@ -169,10 +169,6 @@ principledGetStringNoContext (NixString s c) | null c    = Just s
 principledStringIgnoreContext :: NixString -> Text
 principledStringIgnoreContext (NixString s _) = s
 
--- | Extract the string contents from a NixString even if the NixString has an associated context
-hackyStringIgnoreContext :: NixString -> Text
-hackyStringIgnoreContext (NixString s _) = s
-
 -- | Returns True if the NixString has an associated context
 stringHasContext :: NixString -> Bool
 stringHasContext (NixString _ c) = not (null c)
@@ -252,3 +248,7 @@ hackyStringMConcat = foldr principledStringMappend (NixString mempty mempty)
 hackyMakeNixStringWithoutContext :: Text -> NixString
 hackyMakeNixStringWithoutContext = principledMakeNixStringWithoutContext
 
+-- | Extract the string contents from a NixString even if the NixString has an associated context
+hackyStringIgnoreContext :: NixString -> Text
+hackyStringIgnoreContext = principledStringIgnoreContext
+

src/Nix/Value.hs

@@ -85,7 +85,7 @@ instance Foldable (NValueF p m) where
 instance Show r => Show (NValueF p m r) where
   showsPrec = flip go   where
     go (NVConstantF atom  ) = showsCon1 "NVConstant" atom
-    go (NVStrF      ns    ) = showsCon1 "NVStr" (hackyStringIgnoreContext ns)
+    go (NVStrF      ns    ) = showsCon1 "NVStr" (principledStringIgnoreContext ns)
     go (NVListF     lst   ) = showsCon1 "NVList" lst
     go (NVSetF     attrs _) = showsCon1 "NVSet" attrs
     go (NVClosureF p     _) = showsCon1 "NVClosure" p
@@ -176,7 +176,7 @@ instance Comonad f => Show1 (NValue' t f m) where
   liftShowsPrec sp sl p = \case
     NVConstant' atom  -> showsUnaryWith showsPrec "NVConstantF" p atom
     NVStr' ns ->
-      showsUnaryWith showsPrec "NVStrF" p (hackyStringIgnoreContext ns)
+      showsUnaryWith showsPrec "NVStrF" p (principledStringIgnoreContext ns)
     NVList' lst       -> showsUnaryWith (liftShowsPrec sp sl) "NVListF" p lst
     NVSet' attrs _    -> showsUnaryWith (liftShowsPrec sp sl) "NVSetF" p attrs
     NVPath' path      -> showsUnaryWith showsPrec "NVPathF" p path

tests/Main.hs

@@ -59,7 +59,7 @@ ensureNixpkgsCanParse =
           time <- getCurrentTime
           runWithBasicEffectsIO (defaultOptions time) $
             Nix.nixEvalExprLoc Nothing expr
-        let dir = hackyStringIgnoreContext ns
+        let dir = principledStringIgnoreContext ns
         exists <- fileExist (unpack dir)
         unless exists $
           errorWithoutStackTrace $