Support AbstractFilePath

compat/System/OsString/Compat/Include.hs → os-string-compat/System/OsString/Compat/Include.hs

@@ -4,32 +4,23 @@
 --     PLATFORM_CHAR = PosixChar | WindowsChar
 --     IS_WINDOWS = 0 | 1
 
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE StandaloneDeriving #-}
+
 {-# OPTIONS_GHC -Wno-deprecations #-}
+{-# OPTIONS_GHC -Wno-orphans #-}
 
 module System.OsString.Compat.PLATFORM_NAME
 #if MIN_VERSION_os_string(2,0,0)
-  ( OsString.all
-  , OsString.any
-  , OsString.break
-  , OsString.breakEnd
-  , OsString.dropWhileEnd
-  , OsString.empty
-  , OsString.init
-  , OsString.isInfixOf
-  , OsString.isPrefixOf
-  , OsString.isSuffixOf
-  , OsString.length
-  , OsString.map
-  , OsString.null
-  , OsString.replicate
-  , OsString.singleton
-  , OsString.span
-  , OsString.spanEnd
-  , OsString.stripPrefix
-  , OsString.uncons
+  ( PLATFORM_STRING(..)
+  , PLATFORM_CHAR(..)
+  , module OsString
   )
 #else
-  ( System.OsString.Compat.PLATFORM_NAME.all
+  ( PLATFORM_STRING(..)
+  , PLATFORM_CHAR(..)
+  , OsString.pstr
+  , System.OsString.Compat.PLATFORM_NAME.all
   , System.OsString.Compat.PLATFORM_NAME.any
   , System.OsString.Compat.PLATFORM_NAME.break
   , System.OsString.Compat.PLATFORM_NAME.breakEnd
@@ -52,11 +43,12 @@ module System.OsString.Compat.PLATFORM_NAME
 #endif
   where
 
+import Data.Data (Data)
+import System.OsString.Internal.Types (PLATFORM_STRING(..), PLATFORM_CHAR(..))
 import System.OsString.PLATFORM_NAME as OsString
 
 #if !MIN_VERSION_os_string(2,0,0)
 import Data.Coerce (coerce)
-import System.OsString.Internal.Types (PLATFORM_STRING(..), PLATFORM_CHAR(..))
 
 #if IS_WINDOWS
 import qualified System.OsPath.Data.ByteString.Short.Word16 as BSP
@@ -65,6 +57,8 @@ import qualified System.OsPath.Data.ByteString.Short as BSP
 #endif
 #endif
 
+deriving instance Data PLATFORM_STRING
+
 #if !MIN_VERSION_os_string(2,0,0)
 all :: (PLATFORM_CHAR -> Bool) -> PLATFORM_STRING -> Bool
 all = coerce BSP.all

path.cabal

@@ -13,7 +13,7 @@ build-type:          Simple
 tested-with:         GHC==9.2.8, GHC==9.4.8, GHC==9.6.6, GHC==9.8.2, GHC==9.10.1
 extra-source-files:  README.md
                    , CHANGELOG
-                   , compat/System/OsString/Compat/Include.hs
+                   , os-string-compat/System/OsString/Compat/Include.hs
                    , src/Path/Include.hs
                    , src/Path/Internal/Include.hs
                    , src/OsPath/Include.hs
@@ -74,21 +74,15 @@ library
                    , deepseq
                    , exceptions >= 0.4     && < 0.11
                    , hashable   >= 1.2     && < 1.5
-                   , path:compat
+                   , path:os-string-compat
                    , text
                    , template-haskell
+                   , filepath   >= 1.4.100.0
 
-  if flag(old-os-string)
-    build-depends:   filepath   >= 1.4.100.0
-                   , os-string  < 2.0.0
-  else
-    build-depends:   filepath   >= 1.5.0.0
-                   , os-string  >= 2.0.0
-
-library compat
+library os-string-compat
   import: language
 
-  hs-source-dirs:    compat
+  hs-source-dirs:    os-string-compat
   visibility:        private
 
   exposed-modules:   System.OsString.Compat.Posix
@@ -100,8 +94,7 @@ library compat
     build-depends:   filepath   >= 1.4.100.0
                    , os-string  < 2.0.0
   else
-    build-depends:   filepath   >= 1.5.0.0
-                   , os-string  >= 2.0.0
+    build-depends:   os-string  >= 2.0.0
 
 test-suite test
   import: language
@@ -147,9 +140,8 @@ test-suite test-ospath
                    , exceptions
                    , filepath
                    , hspec      >= 2.0     && < 3
-                   , os-string
                    , path
-                   , path:compat
+                   , path:os-string-compat
                    , template-haskell
 
 test-suite validity-test
@@ -189,9 +181,8 @@ test-suite validity-test-ospath
                    , genvalidity >= 1.0
                    , genvalidity-hspec >= 0.7
                    , hspec      >= 2.0     && < 3
-                   , os-string
                    , path
-                   , path:compat
+                   , path:os-string-compat
                    , validity-bytestring >=0.4.1.0
 
 source-repository head

src/OsPath/Include.hs

@@ -27,8 +27,6 @@
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE RankNTypes #-}
 
-{-# OPTIONS_GHC -Wno-deprecations #-}
-
 module OsPath.PLATFORM_NAME
   (-- * Types
    Path
@@ -119,11 +117,10 @@ import           Language.Haskell.TH.Syntax (lift)
 import           Language.Haskell.TH.Quote (QuasiQuoter(..))
 import           System.OsPath.PLATFORM_NAME (PLATFORM_PATH)
 import qualified System.OsPath.PLATFORM_NAME as OsPath
-import           System.OsString.PLATFORM_NAME (PLATFORM_STRING)
-import qualified System.OsString.PLATFORM_NAME as OsString
 
 import           OsPath.Internal.PLATFORM_NAME
-import qualified System.OsString.Compat.PLATFORM_NAME as OsString.Compat
+import           System.OsString.Compat.PLATFORM_NAME (PLATFORM_STRING)
+import qualified System.OsString.Compat.PLATFORM_NAME as OsString
 
 --------------------------------------------------------------------------------
 -- Types
@@ -282,10 +279,10 @@ infixr 5 </>
 stripProperPrefix :: MonadThrow m
          => Path b Dir -> Path b t -> m (Path Rel t)
 stripProperPrefix (Path p) (Path l) =
-  case OsString.Compat.stripPrefix p l of
+  case OsString.stripPrefix p l of
     Nothing -> throwM (NotAProperPrefix p l)
     Just result
-      | OsString.Compat.null result -> throwM (NotAProperPrefix p l)
+      | OsString.null result -> throwM (NotAProperPrefix p l)
       | otherwise -> return (Path result)
 
 -- | Determines if the path in the first parameter is a proper prefix of the
@@ -329,7 +326,7 @@ replaceProperPrefix src dst fp = (dst </>) <$> stripProperPrefix src fp
 --
 parent :: Path b t -> Path b Dir
 parent (Path fp)
-  | OsString.Compat.null fp = Path OsString.Compat.empty
+  | OsString.null fp = Path OsString.empty
   | OsPath.isDrive fp = Path fp
   | otherwise =
       Path
@@ -342,7 +339,7 @@ parent (Path fp)
 splitDrive :: Path Abs t -> (Path Abs Dir, Maybe (Path Rel t))
 splitDrive (Path fp) =
     let (d, rest) = OsPath.splitDrive fp
-        mRest = if OsString.Compat.null rest then Nothing else Just (Path rest)
+        mRest = if OsString.null rest then Nothing else Just (Path rest)
     in  (Path d, mRest)
 
 -- | Get the drive from an absolute path. On POSIX, @/@ is a drive.
@@ -382,8 +379,8 @@ filename (Path l) =
 --
 dirname :: Path b Dir -> Path Rel Dir
 dirname (Path l)
-  | OsString.Compat.null l = Path OsString.Compat.empty
-  | OsPath.isDrive l = Path OsString.Compat.empty
+  | OsString.null l = Path OsString.empty
+  | OsPath.isDrive l = Path OsString.empty
   | otherwise = Path (last (OsPath.splitPath l))
 
 -- | 'splitExtension' is the inverse of 'addExtension'. It splits the given
@@ -420,28 +417,28 @@ dirname (Path l)
 -- @since 0.7.0
 splitExtension :: MonadThrow m => Path b File -> m (Path b File, PLATFORM_STRING)
 splitExtension (Path ospath) =
-    if OsString.Compat.null nameDot
-       || OsString.Compat.null name
-       || OsString.Compat.null ext
+    if OsString.null nameDot
+       || OsString.null name
+       || OsString.null ext
        || name == [OsString.pstr|.|]
        || name == [OsString.pstr|..|]
        then throwM $ HasNoExtension ospath
        else return ( Path (normalizeDrive drv <> dir <> name)
-                   , OsString.Compat.singleton OsPath.extSeparator <> ext
+                   , OsString.singleton OsPath.extSeparator <> ext
                    )
     where
 
     -- trailing separators are ignored for the split and considered part of the
     -- second component in the split.
     splitLast isSep str =
-        let (withoutTrailingSeps, trailingSeps) = OsString.Compat.spanEnd isSep str
-            (oneSep, rest) = OsString.Compat.breakEnd isSep withoutTrailingSeps
+        let (withoutTrailingSeps, trailingSeps) = OsString.spanEnd isSep str
+            (oneSep, rest) = OsString.breakEnd isSep withoutTrailingSeps
         in (oneSep, rest <> trailingSeps)
 
     (drv, ospathRel) = OsPath.splitDrive ospath
     (dir, file)      = splitLast OsPath.isPathSeparator ospathRel
     (nameDot, ext)   = splitLast OsPath.isExtSeparator file
-    name             = OsString.Compat.init nameDot
+    name             = OsString.init nameDot
 
 -- | Get extension from given file path. Throws 'HasNoExtension' exception if
 -- the file does not have an extension.  The following laws hold:
@@ -484,26 +481,26 @@ addExtension :: MonadThrow m
   -> Path b File       -- ^ Old file name
   -> m (Path b File)   -- ^ New file name with the desired extension added at the end
 addExtension ext (Path path) = do
-    (sep, xtn) <- case OsString.Compat.uncons ext of
+    (sep, xtn) <- case OsString.uncons ext of
         Nothing -> throwM $ InvalidExtension ext
         Just result -> pure result
 
-    let withoutTrailingSeps = OsString.Compat.dropWhileEnd OsPath.isExtSeparator xtn
+    let withoutTrailingSeps = OsString.dropWhileEnd OsPath.isExtSeparator xtn
 
     -- Has to start with a "."
     unless (OsPath.isExtSeparator sep) $
         throwM $ InvalidExtension ext
 
     -- Cannot have path separators
-    when (OsString.Compat.any OsPath.isPathSeparator xtn) $
+    when (OsString.any OsPath.isPathSeparator xtn) $
         throwM $ InvalidExtension ext
 
     -- All "."s is not a valid extension
-    when (OsString.Compat.null withoutTrailingSeps) $
+    when (OsString.null withoutTrailingSeps) $
         throwM $ InvalidExtension ext
 
     -- Cannot have "."s except in trailing position
-    when (OsString.Compat.any OsPath.isExtSeparator withoutTrailingSeps) $
+    when (OsString.any OsPath.isExtSeparator withoutTrailingSeps) $
         throwM $ InvalidExtension ext
 
     -- Must be valid as a filename