{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE PatternGuards, ViewPatterns, TupleSections #-}

module Development.Shake.Internal.FilePattern(
    -- * Primitive API, as exposed
    FilePattern, (?==), (<//>),
    -- * General API, used by other people.
    filePattern,
    -- * Optimisation opportunities
    simple, (?==*),
    -- * Multipattern file rules
    compatible, extract, substitute,
    -- * Accelerated searching
    Walk(..), walk,
    -- * Testing only
    internalTest, isRelativePath, isRelativePattern
    ) where

import Development.Shake.Internal.Errors
import System.FilePath(isPathSeparator)
import Data.List.Extra
import Control.Monad
import Data.Char
import Data.Maybe
import System.Info.Extra


-- | A type synonym for file patterns, containing @\/\/@ and @*@. For the syntax
--   and semantics of 'FilePattern' see '?=='.
--
--   Most 'normaliseEx'd 'FilePath' values are suitable as 'FilePattern' values which match
--   only that specific file. On Windows @\\@ is treated as equivalent to @\/@.
--
--   You can write 'FilePattern' values as a literal string, or build them
--   up using the operators 'Development.Shake.FilePath.<.>', 'Development.Shake.FilePath.</>'
--   and 'Development.Shake.<//>'. However, beware that:
--
-- * On Windows, use 'Development.Shake.FilePath.<.>' from "Development.Shake.FilePath" instead of from
--   "System.FilePath" - otherwise @\"\/\/*\" \<.\> exe@ results in @\"\/\/*\\\\.exe\"@.
--
-- * If the second argument of 'Development.Shake.FilePath.</>' has a leading path separator (namely @\/@)
--   then the second argument will be returned.
type FilePattern = String

infixr 5 <//>

-- | Join two 'FilePattern' values by inserting two @\/@ characters between them.
--   Will first remove any trailing path separators on the first argument, and any leading
--   separators on the second.
--
-- > "dir" <//> "*" == "dir//*"
(<//>) :: FilePattern -> FilePattern -> FilePattern
String
a <//> :: String -> String -> String
<//> String
b = forall a. (a -> Bool) -> [a] -> [a]
dropWhileEnd Char -> Bool
isPathSeparator String
a forall a. [a] -> [a] -> [a]
++ String
"//" forall a. [a] -> [a] -> [a]
++ forall a. (a -> Bool) -> [a] -> [a]
dropWhile Char -> Bool
isPathSeparator String
b


---------------------------------------------------------------------
-- PATTERNS

data Pat = Lit String -- ^ foo
         | Star   -- ^ /*/
         | Skip -- ^ //
         | Skip1 -- ^ //, but must be at least 1 element
         | Stars String [String] String -- ^ *foo*, prefix (fixed), infix floaters, suffix
                                        -- e.g. *foo*bar = Stars "" ["foo"] "bar"
            deriving (Int -> Pat -> String -> String
[Pat] -> String -> String
Pat -> String
forall a.
(Int -> a -> String -> String)
-> (a -> String) -> ([a] -> String -> String) -> Show a
showList :: [Pat] -> String -> String
$cshowList :: [Pat] -> String -> String
show :: Pat -> String
$cshow :: Pat -> String
showsPrec :: Int -> Pat -> String -> String
$cshowsPrec :: Int -> Pat -> String -> String
Show,Pat -> Pat -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Pat -> Pat -> Bool
$c/= :: Pat -> Pat -> Bool
== :: Pat -> Pat -> Bool
$c== :: Pat -> Pat -> Bool
Eq,Eq Pat
Pat -> Pat -> Bool
Pat -> Pat -> Ordering
Pat -> Pat -> Pat
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: Pat -> Pat -> Pat
$cmin :: Pat -> Pat -> Pat
max :: Pat -> Pat -> Pat
$cmax :: Pat -> Pat -> Pat
>= :: Pat -> Pat -> Bool
$c>= :: Pat -> Pat -> Bool
> :: Pat -> Pat -> Bool
$c> :: Pat -> Pat -> Bool
<= :: Pat -> Pat -> Bool
$c<= :: Pat -> Pat -> Bool
< :: Pat -> Pat -> Bool
$c< :: Pat -> Pat -> Bool
compare :: Pat -> Pat -> Ordering
$ccompare :: Pat -> Pat -> Ordering
Ord)

fromLit :: Pat -> Maybe String
fromLit :: Pat -> Maybe String
fromLit (Lit String
x) = forall a. a -> Maybe a
Just String
x
fromLit Pat
_ = forall a. Maybe a
Nothing


data Lexeme = Str String | Slash | SlashSlash

lexer :: FilePattern -> [Lexeme]
lexer :: String -> [Lexeme]
lexer String
"" = []
lexer (Char
x1:Char
x2:String
xs) | Char -> Bool
isPathSeparator Char
x1, Char -> Bool
isPathSeparator Char
x2 = Lexeme
SlashSlash forall a. a -> [a] -> [a]
: String -> [Lexeme]
lexer String
xs
lexer (Char
x1:String
xs) | Char -> Bool
isPathSeparator Char
x1 = Lexeme
Slash forall a. a -> [a] -> [a]
: String -> [Lexeme]
lexer String
xs
lexer String
xs = String -> Lexeme
Str String
a forall a. a -> [a] -> [a]
: String -> [Lexeme]
lexer String
b
    where (String
a,String
b) = forall a. (a -> Bool) -> [a] -> ([a], [a])
break Char -> Bool
isPathSeparator String
xs


-- | Parse a FilePattern. All optimisations I can think of are invalid because they change the extracted expressions.
parse :: FilePattern -> [Pat]
parse :: String -> [Pat]
parse = Bool -> Bool -> [Lexeme] -> [Pat]
f Bool
False Bool
True forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> [Lexeme]
lexer
    where
        -- str = I have ever seen a Str go past (equivalent to "can I be satisfied by no paths")
        -- slash = I am either at the start, or my previous character was Slash
        f :: Bool -> Bool -> [Lexeme] -> [Pat]
f Bool
str Bool
slash = \case
            [] -> [String -> Pat
Lit String
"" | Bool
slash]
            Str String
"**":[Lexeme]
xs -> Pat
Skip forall a. a -> [a] -> [a]
: Bool -> Bool -> [Lexeme] -> [Pat]
f Bool
True Bool
False [Lexeme]
xs
            Str String
x:[Lexeme]
xs -> String -> Pat
parseLit String
x forall a. a -> [a] -> [a]
: Bool -> Bool -> [Lexeme] -> [Pat]
f Bool
True Bool
False [Lexeme]
xs
            Lexeme
SlashSlash:Lexeme
Slash:[Lexeme]
xs | Bool -> Bool
not Bool
str -> Pat
Skip1 forall a. a -> [a] -> [a]
: Bool -> Bool -> [Lexeme] -> [Pat]
f Bool
str Bool
True [Lexeme]
xs
            Lexeme
SlashSlash:[Lexeme]
xs -> Pat
Skip forall a. a -> [a] -> [a]
: Bool -> Bool -> [Lexeme] -> [Pat]
f Bool
str Bool
False [Lexeme]
xs
            Lexeme
Slash:[Lexeme]
xs -> [String -> Pat
Lit String
"" | Bool -> Bool
not Bool
str] forall a. [a] -> [a] -> [a]
++ Bool -> Bool -> [Lexeme] -> [Pat]
f Bool
str Bool
True [Lexeme]
xs


parseLit :: String -> Pat
parseLit :: String -> Pat
parseLit String
"*" = Pat
Star
parseLit String
x = case forall a. (a -> Bool) -> [a] -> [[a]]
split (forall a. Eq a => a -> a -> Bool
== Char
'*') String
x of
    [String
x] -> String -> Pat
Lit String
x
    String
pre:[String]
xs | Just ([String]
mid,String
post) <- forall a. [a] -> Maybe ([a], a)
unsnoc [String]
xs -> String -> [String] -> String -> Pat
Stars String
pre [String]
mid String
post
    [String]
_ -> String -> Pat
Lit String
""


internalTest :: IO ()
internalTest :: IO ()
internalTest = do
    let String
x # :: String -> [Pat] -> f ()
# [Pat]
y =
            let p :: [Pat]
p = String -> [Pat]
parse String
x
            in forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when ([Pat]
p forall a. Eq a => a -> a -> Bool
/= [Pat]
y) forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a. MonadFail m => String -> m a
fail forall a b. (a -> b) -> a -> b
$ forall a. Show a => a -> String
show (String
"FilePattern.internalTest",String
x,[Pat]
p,[Pat]
y)
    String
"" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
""]
    String
"x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x"]
    String
"/" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"",String -> Pat
Lit String
""]
    String
"x/" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x",String -> Pat
Lit String
""]
    String
"/x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"",String -> Pat
Lit String
"x"]
    String
"x/y" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x",String -> Pat
Lit String
"y"]
    String
"//" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip]
    String
"**" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip]
    String
"//x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, String -> Pat
Lit String
"x"]
    String
"**/x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, String -> Pat
Lit String
"x"]
    String
"x//" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x", Pat
Skip]
    String
"x/**" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x", Pat
Skip]
    String
"x//y" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x",Pat
Skip, String -> Pat
Lit String
"y"]
    String
"x/**/y" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x",Pat
Skip, String -> Pat
Lit String
"y"]
    String
"///" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip1, String -> Pat
Lit String
""]
    String
"**/**" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip,Pat
Skip]
    String
"**/**/" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, Pat
Skip, String -> Pat
Lit String
""]
    String
"///x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip1, String -> Pat
Lit String
"x"]
    String
"**/x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, String -> Pat
Lit String
"x"]
    String
"x///" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x", Pat
Skip, String -> Pat
Lit String
""]
    String
"x/**/" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x", Pat
Skip, String -> Pat
Lit String
""]
    String
"x///y" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x",Pat
Skip, String -> Pat
Lit String
"y"]
    String
"x/**/y" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x",Pat
Skip, String -> Pat
Lit String
"y"]
    String
"////" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, Pat
Skip]
    String
"**/**/**" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, Pat
Skip, Pat
Skip]
    String
"////x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, Pat
Skip, String -> Pat
Lit String
"x"]
    String
"x////" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x", Pat
Skip, Pat
Skip]
    String
"x////y" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [String -> Pat
Lit String
"x",Pat
Skip, Pat
Skip, String -> Pat
Lit String
"y"]
    String
"**//x" forall {f :: * -> *}. MonadFail f => String -> [Pat] -> f ()
# [Pat
Skip, Pat
Skip, String -> Pat
Lit String
"x"]


-- | Optimisations that may change the matched expressions
optimise :: [Pat] -> [Pat]
optimise :: [Pat] -> [Pat]
optimise (Pat
Skip:Pat
Skip:[Pat]
xs) = [Pat] -> [Pat]
optimise forall a b. (a -> b) -> a -> b
$ Pat
Skipforall a. a -> [a] -> [a]
:[Pat]
xs
optimise (Pat
Skip:Pat
Star:[Pat]
xs) = [Pat] -> [Pat]
optimise forall a b. (a -> b) -> a -> b
$ Pat
Skip1forall a. a -> [a] -> [a]
:[Pat]
xs
optimise (Pat
Star:Pat
Skip:[Pat]
xs) = [Pat] -> [Pat]
optimise forall a b. (a -> b) -> a -> b
$ Pat
Skip1forall a. a -> [a] -> [a]
:[Pat]
xs
optimise (Pat
x:[Pat]
xs) = Pat
x forall a. a -> [a] -> [a]
: [Pat] -> [Pat]
optimise [Pat]
xs
optimise [] =[]


-- | A 'FilePattern' that will only match 'isRelativePath' values.
isRelativePattern :: FilePattern -> Bool
isRelativePattern :: String -> Bool
isRelativePattern (Char
'*':Char
'*':String
xs)
    | [] <- String
xs = Bool
True
    | Char
x:String
_ <- String
xs, Char -> Bool
isPathSeparator Char
x = Bool
True
isRelativePattern String
_ = Bool
False

-- | A non-absolute 'FilePath'.
isRelativePath :: FilePath -> Bool
isRelativePath :: String -> Bool
isRelativePath (Char
x:String
_) | Char -> Bool
isPathSeparator Char
x = Bool
False
isRelativePath (Char
x:Char
':':String
_) | Bool
isWindows, Char -> Bool
isAlpha Char
x = Bool
False
isRelativePath String
_ = Bool
True


-- | Given a pattern, and a list of path components, return a list of all matches
--   (for each wildcard in order, what the wildcard matched).
match :: [Pat] -> [String] -> [[String]]
match :: [Pat] -> [String] -> [[String]]
match (Pat
Skip:[Pat]
xs) (String
y:[String]
ys) = forall a b. (a -> b) -> [a] -> [b]
map (String
""forall a. a -> [a] -> [a]
:) ([Pat] -> [String] -> [[String]]
match [Pat]
xs (String
yforall a. a -> [a] -> [a]
:[String]
ys)) forall a. [a] -> [a] -> [a]
++ [Pat] -> [String] -> [[String]]
match (Pat
Skip1forall a. a -> [a] -> [a]
:[Pat]
xs) (String
yforall a. a -> [a] -> [a]
:[String]
ys)
match (Pat
Skip1:[Pat]
xs) (String
y:[String]
ys) = [(String
yforall a. [a] -> [a] -> [a]
++String
"/"forall a. [a] -> [a] -> [a]
++String
r)forall a. a -> [a] -> [a]
:[String]
rs | String
r:[String]
rs <- [Pat] -> [String] -> [[String]]
match (Pat
Skipforall a. a -> [a] -> [a]
:[Pat]
xs) [String]
ys]
match (Pat
Skip:[Pat]
xs) [] = forall a b. (a -> b) -> [a] -> [b]
map (String
""forall a. a -> [a] -> [a]
:) forall a b. (a -> b) -> a -> b
$ [Pat] -> [String] -> [[String]]
match [Pat]
xs []
match (Pat
Star:[Pat]
xs) (String
y:[String]
ys) = forall a b. (a -> b) -> [a] -> [b]
map (String
yforall a. a -> [a] -> [a]
:) forall a b. (a -> b) -> a -> b
$ [Pat] -> [String] -> [[String]]
match [Pat]
xs [String]
ys
match (Lit String
x:[Pat]
xs) (String
y:[String]
ys) = forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat forall a b. (a -> b) -> a -> b
$ [[Pat] -> [String] -> [[String]]
match [Pat]
xs [String]
ys | String
x forall a. Eq a => a -> a -> Bool
== String
y] forall a. [a] -> [a] -> [a]
++ [[Pat] -> [String] -> [[String]]
match [Pat]
xs (String
yforall a. a -> [a] -> [a]
:[String]
ys) | String
x forall a. Eq a => a -> a -> Bool
== String
"."]
match (x :: Pat
x@Stars{}:[Pat]
xs) (String
y:[String]
ys) | Just [String]
rs <- Pat -> String -> Maybe [String]
matchStars Pat
x String
y = forall a b. (a -> b) -> [a] -> [b]
map ([String]
rs forall a. [a] -> [a] -> [a]
++) forall a b. (a -> b) -> a -> b
$ [Pat] -> [String] -> [[String]]
match [Pat]
xs [String]
ys
match [] [] = [[]]
match [Pat]
_ [String]
_ = []


matchOne :: Pat -> String -> Bool
matchOne :: Pat -> String -> Bool
matchOne (Lit String
x) String
y = String
x forall a. Eq a => a -> a -> Bool
== String
y
matchOne x :: Pat
x@Stars{} String
y = forall a. Maybe a -> Bool
isJust forall a b. (a -> b) -> a -> b
$ Pat -> String -> Maybe [String]
matchStars Pat
x String
y
matchOne Pat
Star String
_ = Bool
True
matchOne Pat
p String
_ = forall a. SomeException -> a
throwImpure forall a b. (a -> b) -> a -> b
$ Partial => String -> SomeException
errorInternal forall a b. (a -> b) -> a -> b
$ String
"unreachablePattern, matchOne " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show Pat
p


-- Only return the first (all patterns left-most) valid star matching
matchStars :: Pat -> String -> Maybe [String]
matchStars :: Pat -> String -> Maybe [String]
matchStars (Stars String
pre [String]
mid String
post) String
x = do
    String
x <- forall a. Eq a => [a] -> [a] -> Maybe [a]
stripPrefix String
pre String
x
    String
x <- if forall (t :: * -> *) a. Foldable t => t a -> Bool
null String
post then forall a. a -> Maybe a
Just String
x else forall a. Eq a => [a] -> [a] -> Maybe [a]
stripSuffix String
post String
x
    forall {a}. Eq a => [[a]] -> [a] -> Maybe [[a]]
stripInfixes [String]
mid String
x
    where
        stripInfixes :: [[a]] -> [a] -> Maybe [[a]]
stripInfixes [] [a]
x = forall a. a -> Maybe a
Just [[a]
x]
        stripInfixes ([a]
m:[[a]]
ms) [a]
x = do
            ([a]
a,[a]
x) <- forall a. Eq a => [a] -> [a] -> Maybe ([a], [a])
stripInfix [a]
m [a]
x
            ([a]
aforall a. a -> [a] -> [a]
:) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> [[a]] -> [a] -> Maybe [[a]]
stripInfixes [[a]]
ms [a]
x
matchStars Pat
p String
_ = forall a. SomeException -> a
throwImpure forall a b. (a -> b) -> a -> b
$ Partial => String -> SomeException
errorInternal forall a b. (a -> b) -> a -> b
$ String
"unreachablePattern, matchStars " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show Pat
p

-- | Match a 'FilePattern' against a 'FilePath', There are three special forms:
--
-- * @*@ matches an entire path component, excluding any separators.
--
-- * @\/\/@ matches an arbitrary number of path components, including absolute path
--   prefixes.
--
-- * @**@ as a path component matches an arbitrary number of path components, but not
--   absolute path prefixes.
--   Currently considered experimental.
--
--   Some examples:
--
-- * @test.c@ matches @test.c@ and nothing else.
--
-- * @*.c@ matches all @.c@ files in the current directory, so @file.c@ matches,
--   but @file.h@ and @dir\/file.c@ don't.
--
-- * @\/\/*.c@ matches all @.c@ files anywhere on the filesystem,
--   so @file.c@, @dir\/file.c@, @dir1\/dir2\/file.c@ and @\/path\/to\/file.c@ all match,
--   but @file.h@ and @dir\/file.h@ don't.
--
-- * @dir\/*\/*@ matches all files one level below @dir@, so @dir\/one\/file.c@ and
--   @dir\/two\/file.h@ match, but @file.c@, @one\/dir\/file.c@, @dir\/file.h@
--   and @dir\/one\/two\/file.c@ don't.
--
--   Patterns with constructs such as @foo\/..\/bar@ will never match
--   normalised 'FilePath' values, so are unlikely to be correct.
(?==) :: FilePattern -> FilePath -> Bool
?== :: String -> String -> Bool
(?==) String
p = case [Pat] -> [Pat]
optimise forall a b. (a -> b) -> a -> b
$ String -> [Pat]
parse String
p of
    [Pat
x] | Pat
x forall a. Eq a => a -> a -> Bool
== Pat
Skip Bool -> Bool -> Bool
|| Pat
x forall a. Eq a => a -> a -> Bool
== Pat
Skip1 -> if Bool
rp then String -> Bool
isRelativePath else forall a b. a -> b -> a
const Bool
True
    [Pat]
p -> let f :: String -> Bool
f = Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) a. Foldable t => t a -> Bool
null forall b c a. (b -> c) -> (a -> b) -> a -> c
. [Pat] -> [String] -> [[String]]
match [Pat]
p forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. (a -> Bool) -> [a] -> [[a]]
split Char -> Bool
isPathSeparator
         in if Bool
rp then (\String
x -> String -> Bool
isRelativePath String
x Bool -> Bool -> Bool
&& String -> Bool
f String
x) else String -> Bool
f
    where rp :: Bool
rp = String -> Bool
isRelativePattern String
p

(?==*) :: [FilePattern] -> FilePath -> Bool
?==* :: [String] -> String -> Bool
(?==*) [String]
ps = \String
x -> forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any (forall a b. (a -> b) -> a -> b
$ String
x) [String -> Bool]
vs
    where vs :: [String -> Bool]
vs = forall a b. (a -> b) -> [a] -> [b]
map String -> String -> Bool
(?==) [String]
ps

-- | Like '?==', but returns 'Nothing' on if there is no match, otherwise 'Just' with the list
--   of fragments matching each wildcard. For example:
--
-- @
-- 'filePattern' \"**\/*.c\" \"test.txt\" == Nothing
-- 'filePattern' \"**\/*.c\" \"foo.c\" == Just [\"",\"foo\"]
-- 'filePattern' \"**\/*.c\" \"bar\/baz\/foo.c\" == Just [\"bar\/baz/\",\"foo\"]
-- @
--
--   Note that the @**@ will often contain a trailing @\/@, and even on Windows any
--   @\\@ separators will be replaced by @\/@.
filePattern :: FilePattern -> FilePath -> Maybe [String]
filePattern :: String -> String -> Maybe [String]
filePattern String
p = \String
x -> if String -> Bool
eq String
x then forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ String -> [String]
ex String
x else forall a. Maybe a
Nothing
    where eq :: String -> Bool
eq = String -> String -> Bool
(?==) String
p
          ex :: String -> [String]
ex = String -> String -> [String]
extract String
p

---------------------------------------------------------------------
-- MULTIPATTERN COMPATIBLE SUBSTITUTIONS

specials :: FilePattern -> [Pat]
specials :: String -> [Pat]
specials = forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap Pat -> [Pat]
f forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> [Pat]
parse
    where
        f :: Pat -> [Pat]
f Lit{} = []
        f Pat
Star = [Pat
Star]
        f Pat
Skip = [Pat
Skip]
        f Pat
Skip1 = [Pat
Skip]
        f (Stars String
_ [String]
xs String
_) = forall a. Int -> a -> [a]
replicate (forall (t :: * -> *) a. Foldable t => t a -> Int
length [String]
xs forall a. Num a => a -> a -> a
+ Int
1) Pat
Star

-- | Is the pattern free from any * and //.
simple :: FilePattern -> Bool
simple :: String -> Bool
simple = forall (t :: * -> *) a. Foldable t => t a -> Bool
null forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> [Pat]
specials

-- | Do they have the same * and // counts in the same order
compatible :: [FilePattern] -> Bool
compatible :: [String] -> Bool
compatible [] = Bool
True
compatible (String
x:[String]
xs) = forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
all (forall a. Eq a => a -> a -> Bool
(==) (String -> [Pat]
specials String
x) forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> [Pat]
specials) [String]
xs

-- | Extract the items that match the wildcards. The pair must match with '?=='.
extract :: FilePattern -> FilePath -> [String]
extract :: String -> String -> [String]
extract String
p = let pat :: [Pat]
pat = String -> [Pat]
parse String
p in \String
x ->
    case [Pat] -> [String] -> [[String]]
match [Pat]
pat (forall a. (a -> Bool) -> [a] -> [[a]]
split Char -> Bool
isPathSeparator String
x) of
        [] | String
p String -> String -> Bool
?== String
x -> forall a. SomeException -> a
throwImpure forall a b. (a -> b) -> a -> b
$ Partial => String -> SomeException
errorInternal forall a b. (a -> b) -> a -> b
$ String
"extract with " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show String
p forall a. [a] -> [a] -> [a]
++ String
" and " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show String
x
           | Bool
otherwise -> forall a. Partial => String -> a
error forall a b. (a -> b) -> a -> b
$ String
"Pattern " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show String
p forall a. [a] -> [a] -> [a]
++ String
" does not match " forall a. [a] -> [a] -> [a]
++ String
x forall a. [a] -> [a] -> [a]
++ String
", when trying to extract the FilePattern matches"
        [String]
ms:[[String]]
_ -> [String]
ms


-- | Given the result of 'extract', substitute it back in to a 'compatible' pattern.
--
-- > p '?==' x ==> substitute (extract p x) p == x
substitute :: [String] -> FilePattern -> FilePath
substitute :: [String] -> String -> String
substitute [String]
oms String
oxs = forall a. [a] -> [[a]] -> [a]
intercalate String
"/" forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat forall a b. (a -> b) -> a -> b
$ forall a b. (a, b) -> b
snd forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) s a b.
Traversable t =>
(s -> a -> (s, b)) -> s -> t a -> (s, t b)
mapAccumL [String] -> Pat -> ([String], [String])
f [String]
oms (String -> [Pat]
parse String
oxs)
    where
        f :: [String] -> Pat -> ([String], [String])
f [String]
ms (Lit String
x) = ([String]
ms, [String
x])
        f (String
m:[String]
ms) Pat
Star = ([String]
ms, [String
m])
        f (String
m:[String]
ms) Pat
Skip = ([String]
ms, String -> [String]
split String
m)
        f (String
m:[String]
ms) Pat
Skip1 = ([String]
ms, String -> [String]
split String
m)
        f [String]
ms (Stars String
pre [String]
mid String
post) = ([String]
ms2, [forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat forall a b. (a -> b) -> a -> b
$ String
pre forall a. a -> [a] -> [a]
: forall a b c. (a -> b -> c) -> [a] -> [b] -> [c]
zipWith forall a. [a] -> [a] -> [a]
(++) [String]
ms1 ([String]
midforall a. [a] -> [a] -> [a]
++[String
post])])
            where ([String]
ms1,[String]
ms2) = forall a. Int -> [a] -> ([a], [a])
splitAt (forall (t :: * -> *) a. Foldable t => t a -> Int
length [String]
mid forall a. Num a => a -> a -> a
+ Int
1) [String]
ms
        f [String]
_ Pat
_ = forall a. Partial => String -> a
error forall a b. (a -> b) -> a -> b
$ String
"Substitution failed into pattern " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show String
oxs forall a. [a] -> [a] -> [a]
++ String
" with " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show (forall (t :: * -> *) a. Foldable t => t a -> Int
length [String]
oms) forall a. [a] -> [a] -> [a]
++ String
" matches, namely " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show [String]
oms

        split :: String -> [String]
split = forall a. (a -> Bool) -> [a] -> [[a]]
linesBy (forall a. Eq a => a -> a -> Bool
== Char
'/')


---------------------------------------------------------------------
-- EFFICIENT PATH WALKING

-- | Given a list of files, return a list of things I can match in this directory
--   plus a list of subdirectories and walks that apply to them.
--   Use WalkTo when the list can be predicted in advance
data Walk = Walk ([String] -> ([String],[(String,Walk)]))
          | WalkTo            ([String],[(String,Walk)])

walk :: [FilePattern] -> (Bool, Walk)
walk :: [String] -> (Bool, Walk)
walk [String]
ps = (forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any (\[Pat]
p -> [Pat] -> Bool
isEmpty [Pat]
p Bool -> Bool -> Bool
|| Bool -> Bool
not (forall (t :: * -> *) a. Foldable t => t a -> Bool
null forall a b. (a -> b) -> a -> b
$ [Pat] -> [String] -> [[String]]
match [Pat]
p [String
""])) [[Pat]]
ps2, [[Pat]] -> Walk
f [[Pat]]
ps2)
    where
        ps2 :: [[Pat]]
ps2 = forall a b. (a -> b) -> [a] -> [b]
map (forall a. (a -> Bool) -> [a] -> [a]
filter (forall a. Eq a => a -> a -> Bool
/= String -> Pat
Lit String
".") forall b c a. (b -> c) -> (a -> b) -> a -> c
. [Pat] -> [Pat]
optimise forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> [Pat]
parse) [String]
ps

        f :: [[Pat]] -> Walk
f (forall a. Ord a => [a] -> [a]
nubOrd -> [[Pat]]
ps)
            | Just [String]
fin <- forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM Pat -> Maybe String
fromLit [Pat]
fin
            , Just [(String, Walk)]
nxt <- forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (\(Pat
a,[[Pat]]
b) -> (,[[Pat]] -> Walk
f [[Pat]]
b) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Pat -> Maybe String
fromLit Pat
a) [(Pat, [[Pat]])]
nxt
            = ([String], [(String, Walk)]) -> Walk
WalkTo ([String]
fin, [(String, Walk)]
nxt)
            | Bool
otherwise = ([String] -> ([String], [(String, Walk)])) -> Walk
Walk forall a b. (a -> b) -> a -> b
$ \[String]
xs ->
                (if Bool
finStar then [String]
xs else forall a. (a -> Bool) -> [a] -> [a]
filter (\String
x -> forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any (Pat -> String -> Bool
`matchOne` String
x) [Pat]
fin) [String]
xs
                ,[(String
x, [[Pat]] -> Walk
f [[Pat]]
ys) | String
x <- [String]
xs, let ys :: [[Pat]]
ys = forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [[[Pat]]
b | (Pat
a,[[Pat]]
b) <- [(Pat, [[Pat]])]
nxt, Pat -> String -> Bool
matchOne Pat
a String
x], Bool -> Bool
not forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) a. Foldable t => t a -> Bool
null [[Pat]]
ys])
            where
                finStar :: Bool
finStar = Pat
Star forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [Pat]
fin
                fin :: [Pat]
fin = forall a. Ord a => [a] -> [a]
nubOrd forall a b. (a -> b) -> a -> b
$ forall a b. (a -> Maybe b) -> [a] -> [b]
mapMaybe [Pat] -> Maybe Pat
final [[Pat]]
ps
                nxt :: [(Pat, [[Pat]])]
nxt = forall k v. Ord k => [(k, v)] -> [(k, [v])]
groupSort forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap [Pat] -> [(Pat, [Pat])]
next [[Pat]]
ps


next :: [Pat] -> [(Pat, [Pat])]
next :: [Pat] -> [(Pat, [Pat])]
next (Pat
Skip1:[Pat]
xs) = [(Pat
Star,Pat
Skipforall a. a -> [a] -> [a]
:[Pat]
xs)]
next (Pat
Skip:[Pat]
xs) = (Pat
Star,Pat
Skipforall a. a -> [a] -> [a]
:[Pat]
xs) forall a. a -> [a] -> [a]
: [Pat] -> [(Pat, [Pat])]
next [Pat]
xs
next (Pat
x:[Pat]
xs) = [(Pat
x,[Pat]
xs) | Bool -> Bool
not forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Pat]
xs]
next [] = []

final :: [Pat] -> Maybe Pat
final :: [Pat] -> Maybe Pat
final (Pat
Skip:[Pat]
xs) = if [Pat] -> Bool
isEmpty [Pat]
xs then forall a. a -> Maybe a
Just Pat
Star else [Pat] -> Maybe Pat
final [Pat]
xs
final (Pat
Skip1:[Pat]
xs) = if [Pat] -> Bool
isEmpty [Pat]
xs then forall a. a -> Maybe a
Just Pat
Star else forall a. Maybe a
Nothing
final (Pat
x:[Pat]
xs) = if [Pat] -> Bool
isEmpty [Pat]
xs then forall a. a -> Maybe a
Just Pat
x else forall a. Maybe a
Nothing
final [] = forall a. Maybe a
Nothing

isEmpty :: [Pat] -> Bool
isEmpty = forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
all (forall a. Eq a => a -> a -> Bool
== Pat
Skip)