Loading...
Searching...
No Matches
juce_FileSearchPath.cpp
/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2022 - Raw Material Software Limited
JUCE is an open source library subject to commercial or open-source
licensing.
The code included in this file is provided under the terms of the ISC license
http://www.isc.org/downloads/software-support-policy/isc-license. Permission
To use, copy, modify, and/or distribute this software for any purpose with or
without fee is hereby granted provided that the above copyright notice and
this permission notice appear in all copies.
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.
==============================================================================
*/
namespace juce
{
FileSearchPath::FileSearchPath (const String& path)
{
init (path);
}
FileSearchPath::FileSearchPath (const FileSearchPath& other)
: directories (other.directories)
{
}
FileSearchPath& FileSearchPath::operator= (const FileSearchPath& other)
{
directories = other.directories;
return *this;
}
FileSearchPath& FileSearchPath::operator= (const String& path)
{
init (path);
return *this;
}
void FileSearchPath::init (const String& path)
{
directories.clear();
directories.addTokens (path, ";", "\"");
directories.trim();
directories.removeEmptyStrings();
for (auto& d : directories)
d = d.unquoted();
}
int FileSearchPath::getNumPaths() const
{
return directories.size();
}
File FileSearchPath::operator[] (int index) const
{
return File (getRawString (index));
}
String FileSearchPath::getRawString (int index) const
{
return directories[index];
}
String FileSearchPath::toString() const
{
return toStringWithSeparator (";");
}
String FileSearchPath::toStringWithSeparator (StringRef separator) const
{
auto dirs = directories;
for (auto& d : dirs)
if (d.contains (separator))
d = d.quoted();
return dirs.joinIntoString (separator);
}
void FileSearchPath::add (const File& dir, int insertIndex)
{
directories.insert (insertIndex, dir.getFullPathName());
}
bool FileSearchPath::addIfNotAlreadyThere (const File& dir)
{
for (auto& d : directories)
if (File (d) == dir)
return false;
add (dir);
return true;
}
void FileSearchPath::remove (int index)
{
directories.remove (index);
}
void FileSearchPath::addPath (const FileSearchPath& other)
{
for (int i = 0; i < other.getNumPaths(); ++i)
addIfNotAlreadyThere (other[i]);
}
void FileSearchPath::removeRedundantPaths()
{
std::vector<String> reduced;
for (const auto& directory : directories)
{
const auto checkedIsChildOf = [&] (const auto& a, const auto& b)
{
return File::isAbsolutePath (a) && File::isAbsolutePath (b) && File (a).isAChildOf (b);
};
const auto fContainsDirectory = [&] (const auto& f)
{
return f == directory || checkedIsChildOf (directory, f);
};
if (std::find_if (reduced.begin(), reduced.end(), fContainsDirectory) != reduced.end())
continue;
const auto directoryContainsF = [&] (const auto& f) { return checkedIsChildOf (f, directory); };
reduced.erase (std::remove_if (reduced.begin(), reduced.end(), directoryContainsF), reduced.end());
reduced.push_back (directory);
}
directories = StringArray (reduced.data(), (int) reduced.size());
}
void FileSearchPath::removeNonExistentPaths()
{
for (int i = directories.size(); --i >= 0;)
if (! File (directories[i]).isDirectory())
directories.remove (i);
}
Array<File> FileSearchPath::findChildFiles (int whatToLookFor, bool recurse, const String& wildcard) const
{
Array<File> results;
findChildFiles (results, whatToLookFor, recurse, wildcard);
return results;
}
int FileSearchPath::findChildFiles (Array<File>& results, int whatToLookFor,
bool recurse, const String& wildcard) const
{
int total = 0;
for (auto& d : directories)
total += File (d).findChildFiles (results, whatToLookFor, recurse, wildcard);
return total;
}
bool FileSearchPath::isFileInPath (const File& fileToCheck,
const bool checkRecursively) const
{
for (auto& d : directories)
{
if (checkRecursively)
{
if (fileToCheck.isAChildOf (File (d)))
return true;
}
else
{
if (fileToCheck.getParentDirectory() == File (d))
return true;
}
}
return false;
}
//==============================================================================
//==============================================================================
#if JUCE_UNIT_TESTS
class FileSearchPathTests final : public UnitTest
{
public:
FileSearchPathTests() : UnitTest ("FileSearchPath", UnitTestCategories::files) {}
void runTest() override
{
beginTest ("removeRedundantPaths");
{
#if JUCE_WINDOWS
const String prefix = "C:";
#else
const String prefix = "";
#endif
{
FileSearchPath fsp { prefix + "/a/b/c/d;" + prefix + "/a/b/c/e;" + prefix + "/a/b/c" };
fsp.removeRedundantPaths();
expectEquals (fsp.toString(), prefix + "/a/b/c");
}
{
FileSearchPath fsp { prefix + "/a/b/c;" + prefix + "/a/b/c/d;" + prefix + "/a/b/c/e" };
fsp.removeRedundantPaths();
expectEquals (fsp.toString(), prefix + "/a/b/c");
}
{
FileSearchPath fsp { prefix + "/a/b/c/d;" + prefix + "/a/b/c;" + prefix + "/a/b/c/e" };
fsp.removeRedundantPaths();
expectEquals (fsp.toString(), prefix + "/a/b/c");
}
{
FileSearchPath fsp { "%FOO%;" + prefix + "/a/b/c;%FOO%;" + prefix + "/a/b/c/d" };
fsp.removeRedundantPaths();
expectEquals (fsp.toString(), "%FOO%;" + prefix + "/a/b/c");
}
}
}
};
static FileSearchPathTests fileSearchPathTests;
#endif
} // namespace juce
juce::Array
Definition juce_Array.h:56
juce::FileSearchPath::isFileInPath
bool isFileInPath(const File &fileToCheck, bool checkRecursively) const
Definition juce_FileSearchPath.cpp:169
juce::FileSearchPath::add
void add(const File &directoryToAdd, int insertIndex=-1)
Definition juce_FileSearchPath.cpp:90
juce::FileSearchPath::remove
void remove(int indexToRemove)
Definition juce_FileSearchPath.cpp:105
juce::FileSearchPath::removeNonExistentPaths
void removeNonExistentPaths()
Definition juce_FileSearchPath.cpp:144
juce::FileSearchPath::operator=
FileSearchPath & operator=(const FileSearchPath &)
Definition juce_FileSearchPath.cpp:36
juce::FileSearchPath::addPath
void addPath(const FileSearchPath &)
Definition juce_FileSearchPath.cpp:110
juce::FileSearchPath::toString
String toString() const
Definition juce_FileSearchPath.cpp:74
juce::FileSearchPath::getNumPaths
int getNumPaths() const
Definition juce_FileSearchPath.cpp:59
juce::FileSearchPath::operator[]
File operator[](int index) const
Definition juce_FileSearchPath.cpp:64
juce::FileSearchPath::removeRedundantPaths
void removeRedundantPaths()
Definition juce_FileSearchPath.cpp:116
juce::FileSearchPath::FileSearchPath
FileSearchPath()=default
juce::FileSearchPath::addIfNotAlreadyThere
bool addIfNotAlreadyThere(const File &directoryToAdd)
Definition juce_FileSearchPath.cpp:95
juce::FileSearchPath::toStringWithSeparator
String toStringWithSeparator(StringRef separator) const
Definition juce_FileSearchPath.cpp:79
juce::FileSearchPath::findChildFiles
Array< File > findChildFiles(int whatToLookFor, bool searchRecursively, const String &wildCardPattern="*") const
Definition juce_FileSearchPath.cpp:151
juce::FileSearchPath::getRawString
String getRawString(int index) const
Definition juce_FileSearchPath.cpp:69
juce::File
Definition juce_File.h:45
juce::File::findChildFiles
Array< File > findChildFiles(int whatToLookFor, bool searchRecursively, const String &wildCardPattern="*", FollowSymlinks followSymlinks=FollowSymlinks::yes) const
Definition juce_File.cpp:572
juce::File::getFullPathName
const String & getFullPathName() const noexcept
Definition juce_File.h:153
juce::File::isAbsolutePath
static bool isAbsolutePath(StringRef path)
Definition juce_File.cpp:408
juce::File::getParentDirectory
File getParentDirectory() const
Definition juce_File.cpp:358
juce::File::isAChildOf
bool isAChildOf(const File &potentialParentDirectory) const
Definition juce_File.cpp:388
juce::StringArray
Definition juce_StringArray.h:35
juce::StringArray::removeEmptyStrings
void removeEmptyStrings(bool removeWhitespaceStrings=true)
Definition juce_StringArray.cpp:250
juce::StringArray::clear
void clear()
Definition juce_StringArray.cpp:107
juce::StringArray::trim
void trim()
Definition juce_StringArray.cpp:266
juce::StringArray::addTokens
int addTokens(StringRef stringToTokenise, bool preserveQuotedStrings)
Definition juce_StringArray.cpp:329
juce::StringRef
Definition juce_StringRef.h:62
juce::String
Definition juce_String.h:53
juce::String::quoted
String quoted(juce_wchar quoteCharacter='"') const
Definition juce_String.cpp:1624
juce::UnitTest
Definition juce_UnitTest.h:70