Support AbstractFilePath

.github/workflows/ci.yaml

@@ -13,15 +13,14 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macOS-latest, windows-latest]
-        cabal: ["3.10"]
+        cabal: ["3.12"]
         ghc:
           # GHC versions listed as current stable releases
           - "9.2.8"
-          - "9.4.7"
-          - "9.6.3"
-        # GHC 9.8 only works with cabal-install >= 3.10.2.0, which is not
-        # available from haskell-actions/setup (or on Hackage)
-        # - "9.8.1"
+          - "9.4.8"
+          - "9.6.6"
+          - "9.8.2"
+          - "9.10.1"
 
     steps:
     - uses: actions/checkout@v4
@@ -41,11 +40,11 @@ jobs:
       run: |
         cabal freeze
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Cache ~/.cabal/store
       with:
         path: ${{ steps.setup-haskell-cabal.outputs.cabal-store }}
-        key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }}
+        key: ${{ runner.os }}-${{ matrix.ghc }}-cabal-${{ hashFiles('cabal.project.freeze') }}
 
     - name: Install dependencies
       run: |
@@ -63,36 +62,39 @@ jobs:
   #   run: |
   #     cabal test path:validity-test
 
-  # As of 2023-10-16, the GitHub-hosted runner on ubuntu-latest comes with
-  # Stack 2.13.1 and GHC 9.6.3.
+  # As of 2024-07-29, the GitHub-hosted runner on ubuntu-latest comes with
+  # Stack 2.15.7 and GHC 9.10.1.
   stack:
-    name: stack / ghc ${{ matrix.ghc }}
+    name: "stack / ghc ${{ matrix.ghc }} (${{ matrix.stack-yaml }})"
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ghc: ["9.6.3"]
+        ghc: ["9.10.1"]
+        stack-yaml:
+        - "stack.yaml"
+        - "stack.os-string.yaml"
 
     steps:
     - name: Clone project
       uses: actions/checkout@v4
 
     - name: Cache Stack root
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ~/.stack
-        key: ${{ runner.os }}-${{ matrix.ghc }}-stack
+        key: ${{ runner.os }}-${{ matrix.ghc }}-stack-${{ hashFiles(format('{0}.lock', matrix.stack-yaml)) }}
 
     - name: Install dependencies
       run: |
-        stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --only-dependencies
+        stack --stack-yaml "${{ matrix.stack-yaml }}" build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --only-dependencies
 
     - name: Build
       run: |
-        stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks
+        stack --stack-yaml "${{ matrix.stack-yaml }}" build --system-ghc --test --bench --no-run-tests --no-run-benchmarks
 
     - name: Test the test-suite test
       run: |
-        stack test path:test:test --system-ghc
+        stack --stack-yaml "${{ matrix.stack-yaml }}" test path:test:test --system-ghc
 
   # - name: Test the test-suite validity-test
   #   run: |

hie.yaml

@@ -0,0 +1,19 @@
+cradle:
+  cabal:
+    - path: "src"
+      component: "lib:path"
+
+    - path: "compat"
+      component: "path:lib:compat"
+
+    - path: "test"
+      component: "path:test:test"
+
+    - path: "test-ospath"
+      component: "path:test:test-ospath"
+
+    - path: "validity-test"
+      component: "path:test:validity-test"
+
+    - path: "validity-test-ospath"
+      component: "path:test:validity-test-ospath"

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

@@ -0,0 +1,139 @@
+-- This template expects CPP definitions for:
+--     PLATFORM_NAME = Posix | Windows
+--     PLATFORM_STRING = PosixString | WindowsString
+--     PLATFORM_CHAR = PosixChar | WindowsChar
+--     IS_WINDOWS = 0 | 1
+
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE StandaloneDeriving #-}
+
+{-# OPTIONS_GHC -Wno-deprecations #-}
+{-# OPTIONS_GHC -Wno-orphans #-}
+
+#define USE_os_string 0
+#if defined MIN_VERSION_os_string
+#if MIN_VERSION_os_string(2,0,0)
+#undef USE_os_string
+#define USE_os_string 1
+#endif
+#endif
+
+module System.OsString.Compat.PLATFORM_NAME
+#if USE_os_string
+  ( PLATFORM_STRING(..)
+  , PLATFORM_CHAR(..)
+  , module OsString
+  )
+#else
+  ( 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
+  , System.OsString.Compat.PLATFORM_NAME.dropWhileEnd
+  , System.OsString.Compat.PLATFORM_NAME.empty
+  , System.OsString.Compat.PLATFORM_NAME.init
+  , System.OsString.Compat.PLATFORM_NAME.isInfixOf
+  , System.OsString.Compat.PLATFORM_NAME.isPrefixOf
+  , System.OsString.Compat.PLATFORM_NAME.isSuffixOf
+  , System.OsString.Compat.PLATFORM_NAME.length
+  , System.OsString.Compat.PLATFORM_NAME.map
+  , System.OsString.Compat.PLATFORM_NAME.null
+  , System.OsString.Compat.PLATFORM_NAME.replicate
+  , System.OsString.Compat.PLATFORM_NAME.singleton
+  , System.OsString.Compat.PLATFORM_NAME.span
+  , System.OsString.Compat.PLATFORM_NAME.spanEnd
+  , System.OsString.Compat.PLATFORM_NAME.stripPrefix
+  , System.OsString.Compat.PLATFORM_NAME.uncons
+  )
+#endif
+  where
+
+import Data.Data (Data)
+import System.OsString.Internal.Types (PLATFORM_STRING(..), PLATFORM_CHAR(..))
+import System.OsString.PLATFORM_NAME as OsString
+
+#if !USE_os_string
+import Data.Coerce (coerce)
+
+#if IS_WINDOWS
+import qualified System.OsPath.Data.ByteString.Short.Word16 as BSP
+#else
+import qualified System.OsPath.Data.ByteString.Short as BSP
+#endif
+#endif
+
+deriving instance Data PLATFORM_STRING
+
+#if !USE_os_string
+all :: (PLATFORM_CHAR -> Bool) -> PLATFORM_STRING -> Bool
+all = coerce BSP.all
+
+any :: (PLATFORM_CHAR -> Bool) -> PLATFORM_STRING -> Bool
+any = coerce BSP.any
+
+break
+  :: (PLATFORM_CHAR -> Bool)
+  -> PLATFORM_STRING
+  -> (PLATFORM_STRING, PLATFORM_STRING)
+break = coerce BSP.break
+
+breakEnd
+  :: (PLATFORM_CHAR -> Bool)
+  -> PLATFORM_STRING
+  -> (PLATFORM_STRING, PLATFORM_STRING)
+breakEnd = coerce BSP.breakEnd
+
+dropWhileEnd :: (PLATFORM_CHAR -> Bool) -> PLATFORM_STRING -> PLATFORM_STRING
+dropWhileEnd = coerce BSP.dropWhileEnd
+
+empty :: PLATFORM_STRING
+empty = coerce BSP.empty
+
+init :: PLATFORM_STRING -> PLATFORM_STRING
+init = coerce BSP.init
+
+isInfixOf :: PLATFORM_STRING -> PLATFORM_STRING -> Bool
+isInfixOf = coerce BSP.isInfixOf
+
+isPrefixOf :: PLATFORM_STRING -> PLATFORM_STRING -> Bool
+isPrefixOf = coerce BSP.isPrefixOf
+
+isSuffixOf :: PLATFORM_STRING -> PLATFORM_STRING -> Bool
+isSuffixOf = coerce BSP.isSuffixOf
+
+length :: PLATFORM_STRING -> Int
+length = coerce BSP.length
+
+map :: (PLATFORM_CHAR -> PLATFORM_CHAR) -> PLATFORM_STRING -> PLATFORM_STRING
+map = coerce BSP.map
+
+null :: PLATFORM_STRING -> Bool
+null = coerce BSP.null
+
+replicate :: Int -> PLATFORM_CHAR -> PLATFORM_STRING
+replicate = coerce BSP.replicate
+
+singleton :: PLATFORM_CHAR -> PLATFORM_STRING
+singleton = coerce BSP.singleton
+
+span
+  :: (PLATFORM_CHAR -> Bool)
+  -> PLATFORM_STRING
+  -> (PLATFORM_STRING, PLATFORM_STRING)
+span = coerce BSP.span
+
+spanEnd
+  :: (PLATFORM_CHAR -> Bool)
+  -> PLATFORM_STRING
+  -> (PLATFORM_STRING, PLATFORM_STRING)
+spanEnd = coerce BSP.spanEnd
+
+stripPrefix :: PLATFORM_STRING -> PLATFORM_STRING -> Maybe PLATFORM_STRING
+stripPrefix = coerce BSP.stripPrefix
+
+uncons :: PLATFORM_STRING -> Maybe (PLATFORM_CHAR, PLATFORM_STRING)
+uncons = coerce BSP.uncons
+#endif

os-string-compat/System/OsString/Compat/Posix.hs

@@ -0,0 +1,6 @@
+{-# LANGUAGE CPP #-}
+#define PLATFORM_NAME        Posix
+#define PLATFORM_STRING      PosixString
+#define PLATFORM_CHAR        PosixChar
+#define IS_WINDOWS           0
+#include "Include.hs"

os-string-compat/System/OsString/Compat/Windows.hs

@@ -0,0 +1,6 @@
+{-# LANGUAGE CPP #-}
+#define PLATFORM_NAME        Windows
+#define PLATFORM_STRING      WindowsString
+#define PLATFORM_CHAR        WindowsChar
+#define IS_WINDOWS           1
+#include "Include.hs"