PathSearch.h

Go to the documentation of this file.

 
#ifndef ELEMENTSKERNEL_ELEMENTSKERNEL_PATHSEARCH_H_
#define ELEMENTSKERNEL_ELEMENTSKERNEL_PATHSEARCH_H_
 
#include <string>
#include <vector>
 
#include "ElementsKernel/Export.h"  // ELEMENTS_API
#include "ElementsKernel/Path.h"    // for Path::Item
 
namespace Elements {
inline namespace Kernel {
 
enum class SearchType { Local, Recursive };
 
template <typename T>
ELEMENTS_API std::vector<T> pathSearch(const std::string& searched_name, T directory, SearchType search_type);
 
// template instantiations of the most common types
extern template ELEMENTS_API std::vector<Path::Item> pathSearch(const std::string& searched_name, Path::Item directory,
                                                                SearchType search_type);
extern template ELEMENTS_API std::vector<std::string> pathSearch(const std::string& searched_name,
                                                                 std::string directory, SearchType search_type);
 
ELEMENTS_API
std::vector<Path::Item> pathSearchInEnvVariable(const std::string& file_name, const std::string& path_like_env_variable,
                                                SearchType search_type = SearchType::Recursive);
}  // namespace Kernel
}  // namespace Elements
 
#define ELEMENTSKERNEL_ELEMENTSKERNEL_PATHSEARCH_IMPL_
#include "ElementsKernel/_impl/PathSearch.tpp"
#undef ELEMENTSKERNEL_ELEMENTSKERNEL_PATHSEARCH_IMPL_
 
#endif  // ELEMENTSKERNEL_ELEMENTSKERNEL_PATHSEARCH_H_