Add 'unsafeEncodeUtf' from os-string

haskell · Dec 15, 2023 · a2c6b3d · a2c6b3d
1 parent 4c813c0
commit a2c6b3d
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/System/OsPath/Common.hs b/System/OsPath/Common.hs
@@ -42,6 +42,7 @@ module System.OsPath
 #endif
   -- * Filepath construction
   , PS.encodeUtf
+  , PS.unsafeEncodeUtf
   , PS.encodeWith
   , PS.encodeFS
 #if defined(WINDOWS) || defined(POSIX)
@@ -117,6 +118,7 @@ import System.OsString.Windows as PS
     , decodeFS
     , pack
     , encodeUtf
+    , unsafeEncodeUtf
     , encodeWith
     , encodeFS
     , unpack
@@ -149,6 +151,7 @@ import System.OsString.Posix as PS
     , decodeFS
     , pack
     , encodeUtf
+    , unsafeEncodeUtf
     , encodeWith
     , encodeFS
     , unpack
@@ -165,6 +168,7 @@ import System.OsPath.Internal as PS
     , decodeFS
     , pack
     , encodeUtf
+    , unsafeEncodeUtf
     , encodeWith
     , encodeFS
     , unpack

diff --git a/System/OsPath/Internal.hs b/System/OsPath/Internal.hs
@@ -33,6 +33,7 @@ import GHC.IO.Encoding.UTF16 ( mkUTF16le )
 #else
 import qualified System.OsPath.Posix as PF
 import GHC.IO.Encoding.UTF8 ( mkUTF8 )
+import GHC.Stack (HasCallStack)
 #endif
 
 
@@ -42,10 +43,18 @@ import GHC.IO.Encoding.UTF8 ( mkUTF8 )
 -- On windows this encodes as UTF16-LE (strictly), which is a pretty good guess.
 -- On unix this encodes as UTF8 (strictly), which is a good guess.
 --
--- Throws a 'EncodingException' if encoding fails.
+-- Throws an 'EncodingException' if encoding fails. If the input does not
+-- contain surrogate chars, you can use 'unsafeEncodeUtf'.
 encodeUtf :: MonadThrow m => FilePath -> m OsPath
 encodeUtf = OS.encodeUtf
 
+-- | Unsafe unicode friendly encoding.
+--
+-- Like 'encodeUtf', except it crashes when the input contains
+-- surrogate chars. For sanitized input, this can be useful.
+unsafeEncodeUtf :: HasCallStack => String -> OsString
+unsafeEncodeUtf = OS.unsafeEncodeUtf
+
 -- | Encode a 'FilePath' with the specified encoding.
 encodeWith :: TextEncoding  -- ^ unix text encoding
            -> TextEncoding  -- ^ windows text encoding

diff --git a/cabal.project b/cabal.project
@@ -1 +1,2 @@
 packages: ./
+
diff --git a/filepath.cabal b/filepath.cabal
@@ -96,7 +96,7 @@ library
     , deepseq
     , exceptions
     , template-haskell
-    , os-string         >=2.0.0
+    , os-string         >=2.0.1
 
   ghc-options:      -Wall
 
@@ -116,7 +116,7 @@ test-suite filepath-tests
     , base
     , bytestring  >=0.11.3.0
     , filepath
-    , os-string   >=2.0.0
+    , os-string   >=2.0.1
     , QuickCheck  >=2.7      && <2.15
 
   default-language: Haskell2010
@@ -138,7 +138,7 @@ test-suite filepath-equivalent-tests
     , base
     , bytestring  >=0.11.3.0
     , filepath
-    , os-string   >=2.0.0
+    , os-string   >=2.0.1
     , QuickCheck  >=2.7      && <2.15
 
 test-suite abstract-filepath
@@ -157,7 +157,7 @@ test-suite abstract-filepath
     , bytestring  >=0.11.3.0
     , deepseq
     , filepath
-    , os-string   >=2.0.0
+    , os-string   >=2.0.1
     , QuickCheck  >=2.7      && <2.15
     , quickcheck-classes-base ^>=0.6.2
 
@@ -172,7 +172,7 @@ benchmark bench-filepath
     , bytestring  >=0.11.3.0
     , deepseq
     , filepath
-    , os-string   >=2.0.0
+    , os-string   >=2.0.1
     , tasty-bench
 
   ghc-options: -with-rtsopts=-A32m