-- |-- Module : OsString-- Copyright : © 2021 Julian Ospald-- License : MIT---- Maintainer : Julian Ospald <hasufell@posteo.de>-- Stability : experimental-- Portability : portable---- An implementation of platform specific short 'OsString', which is:---- 1. on windows wide char bytes (@[Word16]@)-- 2. on unix char bytes (@[Word8]@)---- It captures the notion of syscall specific encoding (or the lack thereof) to avoid roundtrip issues-- and memory fragmentation by using unpinned byte arrays. Bytes are not touched or interpreted.moduleSystem.OsString(-- * String typesOsString -- * OsString construction,encodeUtf ,unsafeEncodeUtf ,encodeWith ,encodeFS ,encodeLE ,osstr ,empty ,singleton ,pack -- * OsString deconstruction,decodeUtf ,decodeWith ,decodeFS ,decodeLE ,unpack -- * Word types,OsChar -- * Word construction,unsafeFromChar -- * Word deconstruction,toChar -- * Basic interface,snoc ,cons ,last ,tail ,uncons ,head ,init ,unsnoc ,null ,length -- * Transforming OsString,map ,reverse ,intercalate -- * Reducing OsStrings (folds),foldl ,foldl' ,foldl1 ,foldl1' ,foldr ,foldr' ,foldr1 ,foldr1' -- * Special folds,all ,any ,concat -- * Generating and unfolding OsStrings,replicate ,unfoldr ,unfoldrN -- * Substrings-- ** Breaking strings,take ,takeEnd ,takeWhileEnd ,takeWhile ,drop ,dropEnd ,dropWhileEnd ,dropWhile ,break ,breakEnd ,span ,spanEnd ,splitAt ,split ,splitWith ,stripSuffix ,stripPrefix -- * Predicates,isInfixOf ,isPrefixOf ,isSuffixOf -- ** Search for arbitrary susbstrings,breakSubstring -- * Searching OsStrings-- ** Searching by equality,elem ,find ,filter ,partition -- * Indexing OsStrings,index ,indexMaybe ,(!?) ,elemIndex ,elemIndices ,count ,findIndex ,findIndices -- * Coercions,coercionToPlatformTypes )whereimportSystem.OsString.Internal (unsafeFromChar ,toChar ,encodeUtf ,unsafeEncodeUtf ,encodeWith ,encodeLE ,osstr ,pack ,empty ,singleton ,decodeUtf ,decodeWith ,decodeLE ,unpack ,snoc ,cons ,last ,tail ,uncons ,head ,init ,unsnoc ,null ,length ,map ,reverse ,intercalate ,foldl ,foldl' ,foldl1 ,foldl1' ,foldr ,foldr' ,foldr1 ,foldr1' ,all ,any ,concat ,replicate ,unfoldr ,unfoldrN ,take ,takeEnd ,takeWhileEnd ,takeWhile ,drop ,dropEnd ,dropWhileEnd ,dropWhile ,break ,breakEnd ,span ,spanEnd ,splitAt ,split ,splitWith ,stripSuffix ,stripPrefix ,isInfixOf ,isPrefixOf ,isSuffixOf ,breakSubstring ,elem ,find ,filter ,partition ,index ,indexMaybe ,(!?) ,elemIndex ,elemIndices ,count ,findIndex ,findIndices )importqualifiedSystem.OsString.Internal asSOIimportSystem.OsString.Internal.Types (OsString ,OsChar ,coercionToPlatformTypes )importPrelude(String,IO){-# DEPRECATEDencodeFS"Use System.OsPath.encodeFS from filepath"#-}-- | Like 'encodeUtf', except this mimics the behavior of the base library when doing filesystem-- operations (usually filepaths), which is:---- 1. on unix, uses shady PEP 383 style encoding (based on the current locale,-- but PEP 383 only works properly on UTF-8 encodings, so good luck)-- 2. on windows does permissive UTF-16 encoding, where coding errors generate-- Chars in the surrogate range---- Looking up the locale requires IO. If you're not worried about calls-- to 'setFileSystemEncoding', then 'unsafePerformIO' may be feasible (make sure-- to deeply evaluate the result to catch exceptions).encodeFS ::String->IOOsString encodeFS :: String -> IO OsString
encodeFS =String -> IO OsString
SOI.encodeFS {-# DEPRECATEDdecodeFS"Use System.OsPath.encodeFS from filepath"#-}-- | Like 'decodeUtf', except this mimics the behavior of the base library when doing filesystem-- operations (usually filepaths), which is:---- 1. on unix, uses shady PEP 383 style encoding (based on the current locale,-- but PEP 383 only works properly on UTF-8 encodings, so good luck)-- 2. on windows does permissive UTF-16 encoding, where coding errors generate-- Chars in the surrogate range---- Looking up the locale requires IO. If you're not worried about calls-- to 'setFileSystemEncoding', then 'unsafePerformIO' may be feasible (make sure-- to deeply evaluate the result to catch exceptions).decodeFS ::OsString ->IOStringdecodeFS :: OsString -> IO String
decodeFS =OsString -> IO String
SOI.decodeFS