Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expose combineAlways and hasLeadingPathSeparator #97

Open
wants to merge 2 commits into
base: 1.5.0.0
Choose a base branch
from
Open

Expose combineAlways and hasLeadingPathSeparator #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4808d14
Add/expose hasLeadingPathSeparator, addLeadingPathSeparator, dropLead…
hasufell Dec 3, 2021
80157ac
Expose/add combineAlways and (</>)
hasufell Dec 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Generate.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ qualify pw str
where
prelude = ["elem","uncurry","snd","fst","not","null","if","then","else"
,"True","False","Just","Nothing","fromJust","concat","isPrefixOf","isSuffixOf","any","foldr"]
fpops = ["</>","<.>","-<.>"]
fpops = ["<\\>", "</>","<.>","-<.>"]


---------------------------------------------------------------------
Expand Down
12 changes: 12 additions & 0 deletions System/FilePath.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,18 @@ module System.FilePath(
takeBaseName, replaceBaseName,
takeDirectory, replaceDirectory,
combine, (</>),
combineAlways, (<\>),
splitPath, joinPath, splitDirectories,

-- * Drive functions
splitDrive, joinDrive,
takeDrive, hasDrive, dropDrive, isDrive,

-- * Leading slash functions
hasLeadingPathSeparator,
addLeadingPathSeparator,
dropLeadingPathSeparator,

-- * Trailing slash functions
hasTrailingPathSeparator,
addTrailingPathSeparator,
Expand Down Expand Up @@ -126,12 +132,18 @@ module System.FilePath(
takeBaseName, replaceBaseName,
takeDirectory, replaceDirectory,
combine, (</>),
combineAlways, (<\>),
splitPath, joinPath, splitDirectories,

-- * Drive functions
splitDrive, joinDrive,
takeDrive, hasDrive, dropDrive, isDrive,

-- * Leading slash functions
hasLeadingPathSeparator,
addLeadingPathSeparator,
dropLeadingPathSeparator,

-- * Trailing slash functions
hasTrailingPathSeparator,
addTrailingPathSeparator,
Expand Down
53 changes: 53 additions & 0 deletions System/FilePath/Internal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,18 @@ module System.FilePath.MODULE_NAME
takeBaseName, replaceBaseName,
takeDirectory, replaceDirectory,
combine, (</>),
combineAlways, (<\>),
splitPath, joinPath, splitDirectories,

-- * Drive functions
splitDrive, joinDrive,
takeDrive, hasDrive, dropDrive, isDrive,

-- * Leading slash functions
hasLeadingPathSeparator,
addLeadingPathSeparator,
dropLeadingPathSeparator,

-- * Trailing slash functions
hasTrailingPathSeparator,
addTrailingPathSeparator,
Expand All @@ -112,6 +118,7 @@ import System.Environment(getEnv)

infixr 7 <.>, -<.>
infixr 5 </>
infixr 5 <\>



Expand Down Expand Up @@ -599,10 +606,38 @@ hasTrailingPathSeparator "" = False
hasTrailingPathSeparator x = isPathSeparator (last x)


-- | Does the item have a leading path separator?
--
-- On unix, this is equivalent to 'isAbsolute', on Windows it isn't.
--
-- > Posix: hasLeadingPathSeparator x == isAbsolute x
-- > hasLeadingPathSeparator "test" == False
-- > hasLeadingPathSeparator "/test" == True
hasLeadingPathSeparator :: FilePath -> Bool
hasLeadingPathSeparator "" = False
hasLeadingPathSeparator x = isPathSeparator (head x)

-- | Add a leading file path separator if one is not already present.
--
-- > hasLeadingPathSeparator (addLeadingPathSeparator x)
-- > hasLeadingPathSeparator x ==> addLeadingPathSeparator x == x
-- > Posix: addLeadingPathSeparator "test/rest" == "/test/rest"
addLeadingPathSeparator :: FilePath -> FilePath
addLeadingPathSeparator x = if hasLeadingPathSeparator x then x else pathSeparator:x

-- | Remove any leading path separators
--
-- > dropLeadingPathSeparator "//file/test/" == "file/test/"
-- > dropLeadingPathSeparator "/" == "/"
-- > Windows: dropLeadingPathSeparator "\\" == "\\"
-- > Posix: not (hasLeadingPathSeparator (dropLeadingPathSeparator x)) || isDrive x
dropLeadingPathSeparator :: FilePath -> FilePath
dropLeadingPathSeparator x =
if hasLeadingPathSeparator x && not (isDrive x)
then let x' = dropWhile isPathSeparator x
in if null x' then [last x] else x'
Comment on lines +636 to +638
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not too sure about this.

else x


-- | Add a trailing file path separator if one is not already present.
--
Expand Down Expand Up @@ -711,6 +746,24 @@ combineAlways a b | null a = b
(</>) = combine


-- | Combine two paths, assuming rhs is NOT absolute.
--
-- > Posix: "/directory" <\> "file.ext" == "/directory/file.ext"
-- > Windows: "/directory" <\> "file.ext" == "/directory\\file.ext"
-- > Valid x => (takeDirectory x <\> takeFileName x) `equalFilePath` x
-- > Posix: "/" <\> "test" == "/test"
-- > Posix: "home" <\> "bob" == "home/bob"
-- > Posix: "x:" <\> "foo" == "x:/foo"
-- > Windows: "C:\\foo" <\> "bar" == "C:\\foo\\bar"
-- > Windows: "home" <\> "bob" == "home\\bob"
-- > Posix: "home" <\> "/bob" == "home//bob"
-- > Windows: "home" <\> "C:\\bob" == "home\\C:\\bob"
-- > Windows: "D:\\foo" <\> "C:bar" == "D:\\foo\\C:bar"
-- > Windows: "C:\\foo" <\> "C:bar" == "C:\\foo\\C:bar"
(<\>) :: FilePath -> FilePath -> FilePath
(<\>) = combineAlways


-- | Split a path by the directory separator.
--
-- > splitPath "/directory/file.ext" == ["/","directory/","file.ext"]
Expand Down
53 changes: 53 additions & 0 deletions System/FilePath/Posix.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,18 @@ module System.FilePath.Posix
takeBaseName, replaceBaseName,
takeDirectory, replaceDirectory,
combine, (</>),
combineAlways, (<\>),
splitPath, joinPath, splitDirectories,

-- * Drive functions
splitDrive, joinDrive,
takeDrive, hasDrive, dropDrive, isDrive,

-- * Leading slash functions
hasLeadingPathSeparator,
addLeadingPathSeparator,
dropLeadingPathSeparator,

-- * Trailing slash functions
hasTrailingPathSeparator,
addTrailingPathSeparator,
Expand All @@ -112,6 +118,7 @@ import System.Environment(getEnv)

infixr 7 <.>, -<.>
infixr 5 </>
infixr 5 <\>



Expand Down Expand Up @@ -599,10 +606,38 @@ hasTrailingPathSeparator "" = False
hasTrailingPathSeparator x = isPathSeparator (last x)


-- | Does the item have a leading path separator?
--
-- On unix, this is equivalent to 'isAbsolute', on Windows it isn't.
--
-- > Posix: hasLeadingPathSeparator x == isAbsolute x
-- > hasLeadingPathSeparator "test" == False
-- > hasLeadingPathSeparator "/test" == True
hasLeadingPathSeparator :: FilePath -> Bool
hasLeadingPathSeparator "" = False
hasLeadingPathSeparator x = isPathSeparator (head x)

-- | Add a leading file path separator if one is not already present.
--
-- > hasLeadingPathSeparator (addLeadingPathSeparator x)
-- > hasLeadingPathSeparator x ==> addLeadingPathSeparator x == x
-- > Posix: addLeadingPathSeparator "test/rest" == "/test/rest"
addLeadingPathSeparator :: FilePath -> FilePath
addLeadingPathSeparator x = if hasLeadingPathSeparator x then x else pathSeparator:x

-- | Remove any leading path separators
--
-- > dropLeadingPathSeparator "//file/test/" == "file/test/"
-- > dropLeadingPathSeparator "/" == "/"
-- > Windows: dropLeadingPathSeparator "\\" == "\\"
-- > Posix: not (hasLeadingPathSeparator (dropLeadingPathSeparator x)) || isDrive x
dropLeadingPathSeparator :: FilePath -> FilePath
dropLeadingPathSeparator x =
if hasLeadingPathSeparator x && not (isDrive x)
then let x' = dropWhile isPathSeparator x
in if null x' then [last x] else x'
else x


-- | Add a trailing file path separator if one is not already present.
--
Expand Down Expand Up @@ -711,6 +746,24 @@ combineAlways a b | null a = b
(</>) = combine


-- | Combine two paths, assuming rhs is NOT absolute.
--
-- > Posix: "/directory" <\> "file.ext" == "/directory/file.ext"
-- > Windows: "/directory" <\> "file.ext" == "/directory\\file.ext"
-- > Valid x => (takeDirectory x <\> takeFileName x) `equalFilePath` x
-- > Posix: "/" <\> "test" == "/test"
-- > Posix: "home" <\> "bob" == "home/bob"
-- > Posix: "x:" <\> "foo" == "x:/foo"
-- > Windows: "C:\\foo" <\> "bar" == "C:\\foo\\bar"
-- > Windows: "home" <\> "bob" == "home\\bob"
-- > Posix: "home" <\> "/bob" == "home//bob"
-- > Windows: "home" <\> "C:\\bob" == "home\\C:\\bob"
-- > Windows: "D:\\foo" <\> "C:bar" == "D:\\foo\\C:bar"
-- > Windows: "C:\\foo" <\> "C:bar" == "C:\\foo\\C:bar"
(<\>) :: FilePath -> FilePath -> FilePath
(<\>) = combineAlways


-- | Split a path by the directory separator.
--
-- > splitPath "/directory/file.ext" == ["/","directory/","file.ext"]
Expand Down
53 changes: 53 additions & 0 deletions System/FilePath/Windows.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,18 @@ module System.FilePath.Windows
takeBaseName, replaceBaseName,
takeDirectory, replaceDirectory,
combine, (</>),
combineAlways, (<\>),
splitPath, joinPath, splitDirectories,

-- * Drive functions
splitDrive, joinDrive,
takeDrive, hasDrive, dropDrive, isDrive,

-- * Leading slash functions
hasLeadingPathSeparator,
addLeadingPathSeparator,
dropLeadingPathSeparator,

-- * Trailing slash functions
hasTrailingPathSeparator,
addTrailingPathSeparator,
Expand All @@ -112,6 +118,7 @@ import System.Environment(getEnv)

infixr 7 <.>, -<.>
infixr 5 </>
infixr 5 <\>



Expand Down Expand Up @@ -599,10 +606,38 @@ hasTrailingPathSeparator "" = False
hasTrailingPathSeparator x = isPathSeparator (last x)


-- | Does the item have a leading path separator?
--
-- On unix, this is equivalent to 'isAbsolute', on Windows it isn't.
--
-- > Posix: hasLeadingPathSeparator x == isAbsolute x
-- > hasLeadingPathSeparator "test" == False
-- > hasLeadingPathSeparator "/test" == True
hasLeadingPathSeparator :: FilePath -> Bool
hasLeadingPathSeparator "" = False
hasLeadingPathSeparator x = isPathSeparator (head x)

-- | Add a leading file path separator if one is not already present.
--
-- > hasLeadingPathSeparator (addLeadingPathSeparator x)
-- > hasLeadingPathSeparator x ==> addLeadingPathSeparator x == x
-- > Posix: addLeadingPathSeparator "test/rest" == "/test/rest"
addLeadingPathSeparator :: FilePath -> FilePath
addLeadingPathSeparator x = if hasLeadingPathSeparator x then x else pathSeparator:x

-- | Remove any leading path separators
--
-- > dropLeadingPathSeparator "//file/test/" == "file/test/"
-- > dropLeadingPathSeparator "/" == "/"
-- > Windows: dropLeadingPathSeparator "\\" == "\\"
-- > Posix: not (hasLeadingPathSeparator (dropLeadingPathSeparator x)) || isDrive x
dropLeadingPathSeparator :: FilePath -> FilePath
dropLeadingPathSeparator x =
if hasLeadingPathSeparator x && not (isDrive x)
then let x' = dropWhile isPathSeparator x
in if null x' then [last x] else x'
else x


-- | Add a trailing file path separator if one is not already present.
--
Expand Down Expand Up @@ -711,6 +746,24 @@ combineAlways a b | null a = b
(</>) = combine


-- | Combine two paths, assuming rhs is NOT absolute.
--
-- > Posix: "/directory" <\> "file.ext" == "/directory/file.ext"
-- > Windows: "/directory" <\> "file.ext" == "/directory\\file.ext"
-- > Valid x => (takeDirectory x <\> takeFileName x) `equalFilePath` x
-- > Posix: "/" <\> "test" == "/test"
-- > Posix: "home" <\> "bob" == "home/bob"
-- > Posix: "x:" <\> "foo" == "x:/foo"
-- > Windows: "C:\\foo" <\> "bar" == "C:\\foo\\bar"
-- > Windows: "home" <\> "bob" == "home\\bob"
-- > Posix: "home" <\> "/bob" == "home//bob"
-- > Windows: "home" <\> "C:\\bob" == "home\\C:\\bob"
-- > Windows: "D:\\foo" <\> "C:bar" == "D:\\foo\\C:bar"
-- > Windows: "C:\\foo" <\> "C:bar" == "C:\\foo\\C:bar"
(<\>) :: FilePath -> FilePath -> FilePath
(<\>) = combineAlways


-- | Split a path by the directory separator.
--
-- > splitPath "/directory/file.ext" == ["/","directory/","file.ext"]
Expand Down
29 changes: 29 additions & 0 deletions tests/TestGen.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,22 @@ tests =
,("W.hasTrailingPathSeparator \"test\" == False", property $ W.hasTrailingPathSeparator "test" == False)
,("P.hasTrailingPathSeparator \"test/\" == True", property $ P.hasTrailingPathSeparator "test/" == True)
,("W.hasTrailingPathSeparator \"test/\" == True", property $ W.hasTrailingPathSeparator "test/" == True)
,("P.hasLeadingPathSeparator x == P.isAbsolute x", property $ \(QFilePath x) -> P.hasLeadingPathSeparator x == P.isAbsolute x)
,("P.hasLeadingPathSeparator \"test\" == False", property $ P.hasLeadingPathSeparator "test" == False)
,("W.hasLeadingPathSeparator \"test\" == False", property $ W.hasLeadingPathSeparator "test" == False)
,("P.hasLeadingPathSeparator \"/test\" == True", property $ P.hasLeadingPathSeparator "/test" == True)
,("W.hasLeadingPathSeparator \"/test\" == True", property $ W.hasLeadingPathSeparator "/test" == True)
,("P.hasLeadingPathSeparator (P.addLeadingPathSeparator x)", property $ \(QFilePath x) -> P.hasLeadingPathSeparator (P.addLeadingPathSeparator x))
,("W.hasLeadingPathSeparator (W.addLeadingPathSeparator x)", property $ \(QFilePath x) -> W.hasLeadingPathSeparator (W.addLeadingPathSeparator x))
,("P.hasLeadingPathSeparator x ==> P.addLeadingPathSeparator x == x", property $ \(QFilePath x) -> P.hasLeadingPathSeparator x ==> P.addLeadingPathSeparator x == x)
,("W.hasLeadingPathSeparator x ==> W.addLeadingPathSeparator x == x", property $ \(QFilePath x) -> W.hasLeadingPathSeparator x ==> W.addLeadingPathSeparator x == x)
,("P.addLeadingPathSeparator \"test/rest\" == \"/test/rest\"", property $ P.addLeadingPathSeparator "test/rest" == "/test/rest")
,("P.dropLeadingPathSeparator \"//file/test/\" == \"file/test/\"", property $ P.dropLeadingPathSeparator "//file/test/" == "file/test/")
,("W.dropLeadingPathSeparator \"//file/test/\" == \"file/test/\"", property $ W.dropLeadingPathSeparator "//file/test/" == "file/test/")
,("P.dropLeadingPathSeparator \"/\" == \"/\"", property $ P.dropLeadingPathSeparator "/" == "/")
,("W.dropLeadingPathSeparator \"/\" == \"/\"", property $ W.dropLeadingPathSeparator "/" == "/")
,("W.dropLeadingPathSeparator \"\\\\\" == \"\\\\\"", property $ W.dropLeadingPathSeparator "\\" == "\\")
,("not (P.hasLeadingPathSeparator (P.dropLeadingPathSeparator x)) || P.isDrive x", property $ \(QFilePath x) -> not (P.hasLeadingPathSeparator (P.dropLeadingPathSeparator x)) || P.isDrive x)
,("P.hasTrailingPathSeparator (P.addTrailingPathSeparator x)", property $ \(QFilePath x) -> P.hasTrailingPathSeparator (P.addTrailingPathSeparator x))
,("W.hasTrailingPathSeparator (W.addTrailingPathSeparator x)", property $ \(QFilePath x) -> W.hasTrailingPathSeparator (W.addTrailingPathSeparator x))
,("P.hasTrailingPathSeparator x ==> P.addTrailingPathSeparator x == x", property $ \(QFilePath x) -> P.hasTrailingPathSeparator x ==> P.addTrailingPathSeparator x == x)
Expand Down Expand Up @@ -320,6 +336,19 @@ tests =
,("\"C:\\\\home\" W.</> \"\\\\bob\" == \"\\\\bob\"", property $ "C:\\home" W.</> "\\bob" == "\\bob")
,("\"D:\\\\foo\" W.</> \"C:bar\" == \"C:bar\"", property $ "D:\\foo" W.</> "C:bar" == "C:bar")
,("\"C:\\\\foo\" W.</> \"C:bar\" == \"C:bar\"", property $ "C:\\foo" W.</> "C:bar" == "C:bar")
,("\"/directory\" P.<\\> \"file.ext\" == \"/directory/file.ext\"", property $ "/directory" P.<\> "file.ext" == "/directory/file.ext")
,("\"/directory\" W.<\\> \"file.ext\" == \"/directory\\\\file.ext\"", property $ "/directory" W.<\> "file.ext" == "/directory\\file.ext")
,("(P.takeDirectory x P.<\\> P.takeFileName x) `P.equalFilePath` x", property $ \(QFilePathValidP x) -> (P.takeDirectory x P.<\> P.takeFileName x) `P.equalFilePath` x)
,("(W.takeDirectory x W.<\\> W.takeFileName x) `W.equalFilePath` x", property $ \(QFilePathValidW x) -> (W.takeDirectory x W.<\> W.takeFileName x) `W.equalFilePath` x)
,("\"/\" P.<\\> \"test\" == \"/test\"", property $ "/" P.<\> "test" == "/test")
,("\"home\" P.<\\> \"bob\" == \"home/bob\"", property $ "home" P.<\> "bob" == "home/bob")
,("\"x:\" P.<\\> \"foo\" == \"x:/foo\"", property $ "x:" P.<\> "foo" == "x:/foo")
,("\"C:\\\\foo\" W.<\\> \"bar\" == \"C:\\\\foo\\\\bar\"", property $ "C:\\foo" W.<\> "bar" == "C:\\foo\\bar")
,("\"home\" W.<\\> \"bob\" == \"home\\\\bob\"", property $ "home" W.<\> "bob" == "home\\bob")
,("\"home\" P.<\\> \"/bob\" == \"home//bob\"", property $ "home" P.<\> "/bob" == "home//bob")
,("\"home\" W.<\\> \"C:\\\\bob\" == \"home\\\\C:\\\\bob\"", property $ "home" W.<\> "C:\\bob" == "home\\C:\\bob")
,("\"D:\\\\foo\" W.<\\> \"C:bar\" == \"D:\\\\foo\\\\C:bar\"", property $ "D:\\foo" W.<\> "C:bar" == "D:\\foo\\C:bar")
,("\"C:\\\\foo\" W.<\\> \"C:bar\" == \"C:\\\\foo\\\\C:bar\"", property $ "C:\\foo" W.<\> "C:bar" == "C:\\foo\\C:bar")
,("P.splitPath \"/directory/file.ext\" == [\"/\", \"directory/\", \"file.ext\"]", property $ P.splitPath "/directory/file.ext" == ["/", "directory/", "file.ext"])
,("W.splitPath \"/directory/file.ext\" == [\"/\", \"directory/\", \"file.ext\"]", property $ W.splitPath "/directory/file.ext" == ["/", "directory/", "file.ext"])
,("concat (P.splitPath x) == x", property $ \(QFilePath x) -> concat (P.splitPath x) == x)
Expand Down