OpenShot Audio Library | OpenShotAudio: juce_FileSearchPath.h Source File

OpenShot Audio Library | OpenShotAudio 0.4.0 |

Loading...
Searching...
No Matches
juce_FileSearchPath.h
1/*
2 ==============================================================================
3
4 This file is part of the JUCE library.
5 Copyright (c) 2022 - Raw Material Software Limited
6
7 JUCE is an open source library subject to commercial or open-source
8 licensing.
9
10 The code included in this file is provided under the terms of the ISC license
11 http://www.isc.org/downloads/software-support-policy/isc-license. Permission
12 To use, copy, modify, and/or distribute this software for any purpose with or
13 without fee is hereby granted provided that the above copyright notice and
14 this permission notice appear in all copies.
15
16 JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
17 EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
18 DISCLAIMED.
19
20 ==============================================================================
21*/
22
23namespace juce
24{
25
26//==============================================================================
34 class JUCE_API FileSearchPath
35{
36public:
37 //==============================================================================
39 FileSearchPath() = default;
40
42 ~FileSearchPath() = default;
43
51 FileSearchPath (const String& path);
52
54 FileSearchPath (const FileSearchPath&);
55
57 FileSearchPath& operator= (const FileSearchPath&);
58
64 FileSearchPath& operator= (const String& path);
65
66 //==============================================================================
70 int getNumPaths() const;
71
76 File operator[] (int index) const;
77
87 String getRawString (int index) const;
88
90 String toString() const;
91
93 String toStringWithSeparator (StringRef separator) const;
94
95 //==============================================================================
101 void add (const File& directoryToAdd,
102 int insertIndex = -1);
103
108 bool addIfNotAlreadyThere (const File& directoryToAdd);
109
111 void remove (int indexToRemove);
112
116 void addPath (const FileSearchPath&);
117
125 void removeRedundantPaths();
126
128 void removeNonExistentPaths();
129
130 //==============================================================================
143 Array<File> findChildFiles (int whatToLookFor,
144 bool searchRecursively,
145 const String& wildCardPattern = "*") const;
146
152 int findChildFiles (Array<File>& results,
153 int whatToLookFor,
154 bool searchRecursively,
155 const String& wildCardPattern = "*") const;
156
157 //==============================================================================
173 bool isFileInPath (const File& fileToCheck,
174 bool checkRecursively) const;
175
176private:
177 //==============================================================================
178 StringArray directories;
179
180 void init (const String&);
181
182 JUCE_LEAK_DETECTOR (FileSearchPath)
183};
184
185} // 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::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::~FileSearchPath
~FileSearchPath()=default
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::StringArray
Definition juce_StringArray.h:35
juce::StringRef
Definition juce_StringRef.h:62
juce::String
Definition juce_String.h:53