Rename "extend" to "join" in Path module

Author: harendra-kumar

core/src/Streamly/FileSystem/Path.hs

@@ -103,9 +103,9 @@ module Streamly.FileSystem.Path
     , isUnrooted
 
     -- * Joining
-    , unsafeExtend
-    , extend
-    , extendByString
+    , unsafeJoin
+    , join
+    , joinStr
 
     -- * Splitting root
     , splitRoot

core/src/Streamly/FileSystem/Path/Node.hs

@@ -30,7 +30,7 @@ module Streamly.FileSystem.Path.Node
     , fileE
 
     -- * Operations
-    , extend
+    , join
     )
 where
 

core/src/Streamly/FileSystem/Path/Seg.hs

@@ -30,7 +30,7 @@ module Streamly.FileSystem.Path.Seg
     , urE
 
     -- * Operations
-    , extend
+    , join
     )
 where
 

core/src/Streamly/FileSystem/Path/SegNode.hs

@@ -30,7 +30,7 @@ module Streamly.FileSystem.Path.SegNode
     , urfileE
 
     -- * Operations
-    , extend
+    , join
     )
 where
 

core/src/Streamly/Internal/FileSystem/DirIO.hs

@@ -314,7 +314,7 @@ toStreamWithBufferOf chunkSize h = AS.concat $ toChunksWithBufferOf chunkSize h
 eitherReaderPaths ::(MonadIO m, MonadCatch m) => (ReadOptions -> ReadOptions) ->
     Unfold m Path (Either Path Path)
 eitherReaderPaths f =
-    let (</>) = Path.extend
+    let (</>) = Path.join
      in UF.mapM2 (\dir -> return . bimap (dir </>) (dir </>)) (eitherReader f)
 
 --
@@ -359,7 +359,7 @@ readEither f = S.unfold (eitherReader f)
 readEitherPaths :: (MonadIO m, MonadCatch m) => (ReadOptions -> ReadOptions) ->
     Path -> Stream m (Either Path Path)
 readEitherPaths f dir =
-    let (</>) = Path.extend
+    let (</>) = Path.join
      in fmap (bimap (dir </>) (dir </>)) $ readEither f dir
 
 #if defined(mingw32_HOST_OS) || defined(__MINGW32__)

core/src/Streamly/Internal/FileSystem/Posix/ReadDir.hsc

@@ -931,7 +931,7 @@ readEitherByteChunksAt confMod (ppath, alldirs) =
                             {-
                             if ndirs > 64
                             then do
-                                let fpath = Path.unsafeExtend ppath curdir
+                                let fpath = Path.unsafeJoin ppath curdir
                                 return $ Yield
                                     (Left (fpath, dirs1))
                                     (ByteChunksAtLoop pfd dirp curdir xs [] 0 mbarr pos1)
@@ -961,7 +961,7 @@ readEitherByteChunksAt confMod (ppath, alldirs) =
                     -- help parallelize more in IO bound case.
                     if ndirs > 0
                     then do
-                        let fpath = Path.unsafeExtend ppath curdir
+                        let fpath = Path.unsafeJoin ppath curdir
                         return $ Yield
                             (Left (fpath, dirs))
                             (ByteChunksAtInit pfd xs mbarr pos)

core/src/Streamly/Internal/FileSystem/PosixPath.hs

@@ -159,19 +159,19 @@ module Streamly.Internal.FileSystem.OS_PATH_TYPE
     , isUnrooted
 
     -- * Joining
-    , extendByString
+    , joinStr
  -- , concat
-    , unsafeExtend
+    , unsafeJoin
 #ifndef IS_WINDOWS
-    , extendByCString
-    , extendByCString'
+    , joinCStr
+    , joinCStr'
 #endif
-    , extend
-    , extendDir
+    , join
+    , joinDir
     , unsafeJoinPaths
 
     -- * Splitting
-    -- | Note: you can use 'unsafeExtend' as a replacement for the joinDrive
+    -- | Note: you can use 'unsafeJoin' as a replacement for the joinDrive
     -- function in the filepath package.
     , splitRoot
     , splitPath
@@ -417,9 +417,9 @@ addTrailingSeparator p@(OS_PATH _arr) =
 #ifdef IS_WINDOWS
     if Array.unsafeGetIndexRev 0 _arr == Common.charToWord ':'
     then p
-    else unsafeExtend p sep
+    else unsafeJoin p sep
 #else
-    unsafeExtend p sep
+    unsafeJoin p sep
 #endif
 
     where
@@ -717,13 +717,13 @@ fromString_ x =
             Left e -> throw e
             Right v -> v
 
--- | Extend a path by adding a separator followed by the supplied string to it.
+-- | Append a separator followed by the supplied string to a path.
 --
 --  Throws 'InvalidPath' if the resulting path is not a valid path as per
 --  'validatePath'.
 --
-extendByString :: OS_PATH_TYPE -> [Char] -> OS_PATH_TYPE
-extendByString (OS_PATH a) b =
+joinStr :: OS_PATH_TYPE -> [Char] -> OS_PATH_TYPE
+joinStr (OS_PATH a) b =
     OS_PATH $
         Common.append Common.OS_NAME
             (Common.toString Unicode.UNICODE_DECODER) a (encodeString b)
@@ -891,9 +891,9 @@ isUnrooted :: OS_PATH_TYPE -> Bool
 isUnrooted = not . isRooted
 
 #ifndef IS_WINDOWS
--- | Like 'extend' but does not check if the second path is rooted.
+-- | Like 'join' but does not check if the second path is rooted.
 --
--- >>> f a b = Path.toString $ Path.unsafeExtend (Path.fromString_ a) (Path.fromString_ b)
+-- >>> f a b = Path.toString $ Path.unsafeJoin (Path.fromString_ a) (Path.fromString_ b)
 --
 -- >>> f "x" "y"
 -- "x/y"
@@ -904,21 +904,21 @@ isUnrooted = not . isRooted
 -- >>> f "x/" "/y"
 -- "x/y"
 --
-{-# INLINE unsafeExtend #-}
-unsafeExtend :: OS_PATH_TYPE -> OS_PATH_TYPE -> OS_PATH_TYPE
-unsafeExtend (OS_PATH a) (OS_PATH b) =
+{-# INLINE unsafeJoin #-}
+unsafeJoin :: OS_PATH_TYPE -> OS_PATH_TYPE -> OS_PATH_TYPE
+unsafeJoin (OS_PATH a) (OS_PATH b) =
     OS_PATH
         $ Common.unsafeAppend
             Common.OS_NAME (Common.toString Unicode.UNICODE_DECODER) a b
 
 -- If you want to avoid runtime failure use the typesafe
 -- Streamly.FileSystem.OS_PATH_TYPE.Seg module.
 
--- | Extend a OS_PATH_TYPE by adding a separator followed by another path to
--- it. Fails if the second path is a rooted path. Use 'unsafeExtend' to avoid
--- failure if you know it is ok to append the rooted path.
+-- | Append a separator followed by another path to a OS_PATH_TYPE. Fails if
+-- the second path is a rooted path. Use 'unsafeJoin' to avoid failure if you
+-- know it is ok to append the rooted path.
 --
--- >>> f a b = Path.toString $ Path.extend a b
+-- >>> f a b = Path.toString $ Path.join a b
 --
 -- >>> f [path|/usr|] [path|bin|]
 -- "/usr/bin"
@@ -927,23 +927,23 @@ unsafeExtend (OS_PATH a) (OS_PATH b) =
 -- >>> fails (f [path|/usr|] [path|/bin|])
 -- True
 --
-extend :: OS_PATH_TYPE -> OS_PATH_TYPE -> OS_PATH_TYPE
-extend (OS_PATH a) (OS_PATH b) =
+join :: OS_PATH_TYPE -> OS_PATH_TYPE -> OS_PATH_TYPE
+join (OS_PATH a) (OS_PATH b) =
     OS_PATH
         $ Common.append
             Common.OS_NAME (Common.toString Unicode.UNICODE_DECODER) a b
 
--- | A stricter version of 'extend' which requires the first path to be a
+-- | A stricter version of 'join' which requires the first path to be a
 -- directory like path i.e. having a trailing separator.
 --
--- >>> f a b = Path.toString $ Path.extendDir a b
+-- >>> f a b = Path.toString $ Path.joinDir a b
 --
 -- >>> fails $ f [path|/usr|] [path|bin|]
 -- True
 --
-extendDir ::
+joinDir ::
     OS_PATH_TYPE -> OS_PATH_TYPE -> OS_PATH_TYPE
-extendDir
+joinDir
     (OS_PATH a) (OS_PATH b) =
     OS_PATH
         $ Common.append'
@@ -954,21 +954,21 @@ extendDir
 -- XXX add appendCWString for Windows?
 
 #ifndef IS_WINDOWS
--- | Append a separator and a CString to the Array. This is like 'unsafeExtend'
+-- | Append a separator and a CString to the Array. This is like 'unsafeJoin'
 -- but always inserts a separator between the two paths even if the first path
 -- has a trailing separator or second path has a leading separator.
 --
-extendByCString :: OS_PATH_TYPE -> CString -> IO OS_PATH_TYPE
-extendByCString (OS_PATH a) str =
+joinCStr :: OS_PATH_TYPE -> CString -> IO OS_PATH_TYPE
+joinCStr (OS_PATH a) str =
     fmap OS_PATH
         $ Common.appendCString
             Common.OS_NAME a str
 
--- | Like 'appendCString' but creates a pinned path.
+-- | Like 'joinCStr' but creates a pinned path.
 --
-extendByCString' ::
+joinCStr' ::
     OS_PATH_TYPE -> CString -> IO OS_PATH_TYPE
-extendByCString'
+joinCStr'
     (OS_PATH a) str =
     fmap OS_PATH
         $ Common.appendCString'
@@ -998,7 +998,7 @@ unsafeJoinPaths = undefined
 -- Some filepath package equivalent idioms:
 --
 -- >>> splitDrive = Path.splitRoot
--- >>> joinDrive = Path.unsafeExtend
+-- >>> joinDrive = Path.unsafeJoin
 -- >>> takeDrive = fmap fst . Path.splitRoot
 -- >>> dropDrive x = Path.splitRoot x >>= snd
 -- >>> hasDrive = isJust . Path.splitRoot
@@ -1360,7 +1360,7 @@ replaceExtension (OS_PATH _a) = undefined
 -- present.
 --
 -- >>> takeFileName = fmap snd . Path.splitFile
--- >>> replaceDirectory p x = fmap (flip Path.extend x) (takeFileName p)
+-- >>> replaceDirectory p x = fmap (flip Path.join x) (takeFileName p)
 --
 -- >>> fmap Path.toString $ Path.takeFileName [path|/home/user/file.txt|]
 -- Just "file.txt"
@@ -1394,7 +1394,7 @@ takeFileBase = fmap dropExtension . takeFileName
 -- | Returns the parent directory of the given OS_PATH_TYPE, if any.
 --
 -- >>> takeDirectory x = Path.splitFile x >>= fst
--- >>> replaceFileName p x = fmap (flip Path.extend x) (takeDirectory p)
+-- >>> replaceFileName p x = fmap (flip Path.join x) (takeDirectory p)
 --
 -- To get an equivalent to takeDirectory from filepath use
 -- 'dropTrailingSeparators' on the result.

core/src/Streamly/Internal/FileSystem/PosixPath/Node.hs

@@ -42,7 +42,7 @@ module Streamly.Internal.FileSystem.OS_PATH.Node
     , fileE
 
     -- * Operations
-    , extend
+    , join
     )
 where
 
@@ -147,15 +147,15 @@ file = mkQ fileE
 
 -- | Append a 'Dir' or 'File' path to a 'Dir' path.
 --
--- >>> Path.toString (Node.extend [dir|/usr|] [dir|bin|] :: Dir PosixPath)
+-- >>> Path.toString (Node.join [dir|/usr|] [dir|bin|] :: Dir PosixPath)
 -- "/usr/bin"
--- >>> Path.toString (Node.extend [dir|/usr|] [file|bin|] :: File PosixPath)
+-- >>> Path.toString (Node.join [dir|/usr|] [file|bin|] :: File PosixPath)
 -- "/usr/bin"
 --
 -- Fails if the second path is a specific location and not a path segment.
 --
-{-# INLINE extend #-}
-extend :: (IsPath OS_PATH (a OS_PATH), IsNode (a OS_PATH)) =>
+{-# INLINE join #-}
+join :: (IsPath OS_PATH (a OS_PATH), IsNode (a OS_PATH)) =>
     Dir OS_PATH -> a OS_PATH -> a OS_PATH
-extend (Dir a) b =
-    unsafeFromPath $ OsPath.unsafeExtend (toPath a) (toPath b)
+join (Dir a) b =
+    unsafeFromPath $ OsPath.unsafeJoin (toPath a) (toPath b)

core/src/Streamly/Internal/FileSystem/PosixPath/Seg.hs

@@ -47,7 +47,7 @@ module Streamly.Internal.FileSystem.OS_PATH.Seg
     , urE
 
     -- * Operations
-    , extend
+    , join
     )
 where
 
@@ -156,16 +156,16 @@ ur = mkQ urE
 
 -- | Append a 'Unrooted' type path to a 'Rooted' path or 'Unrooted' path.
 --
--- >>> Path.toString (Seg.extend [rt|/usr|] [ur|bin|] :: Rooted PosixPath)
+-- >>> Path.toString (Seg.join [rt|/usr|] [ur|bin|] :: Rooted PosixPath)
 -- "/usr/bin"
--- >>> Path.toString (Seg.extend [ur|usr|] [ur|bin|] :: Unrooted PosixPath)
+-- >>> Path.toString (Seg.join [ur|usr|] [ur|bin|] :: Unrooted PosixPath)
 -- "usr/bin"
 --
-{-# INLINE extend #-}
-extend ::
+{-# INLINE join #-}
+join ::
     (
       IsSeg (a OS_PATH)
     , IsPath OS_PATH (a OS_PATH)
     ) => a OS_PATH -> Unrooted OS_PATH -> a OS_PATH
-extend a (Unrooted c) =
-    unsafeFromPath $ OsPath.unsafeExtend (toPath a) (toPath c)
+join a (Unrooted c) =
+    unsafeFromPath $ OsPath.unsafeJoin (toPath a) (toPath c)