mirror of
https://github.com/Kitware/CMake.git
synced 2026-05-03 04:40:18 -05:00
KWSys Upstream
ca03a9be6c
Code extracted from:
https://gitlab.kitware.com/utils/kwsys.git
at commit 16e180ad8ae26f896adf1c30929b1d53b3e13dac (master).
Upstream Shortlog
-----------------
Brad King (2):
929b6c6c Glob: Revert "Optimize directory/symlink checks on Windows"
4b552447 Directory: Replace FileData with methods accepting file index
Clemens Wasser (5):
43ce7a20 SystemTools: Factor out FileIsSymlinkWithAttr helper
d078f9e6 Directory: Store FIND_DATA for files in Directory
7573b0fd Directory: Add Is{Directory,Symlink} to FileData
99c7831e Glob: Optimize directory/symlink checks on Windows
d4c5ed92 Glob: Optimize directory/symlink checks on Windows
Markus87 (1):
5f2dcc13 SystemTools: Fix FilesDiffer 32-bit signed integer overflow on Windows
97 lines
2.4 KiB
Plaintext
97 lines
2.4 KiB
Plaintext
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing#kwsys for details. */
|
|
#ifndef @KWSYS_NAMESPACE@_Directory_hxx
|
|
#define @KWSYS_NAMESPACE@_Directory_hxx
|
|
|
|
#include <@KWSYS_NAMESPACE@/Configure.h>
|
|
#include <@KWSYS_NAMESPACE@/Status.hxx>
|
|
|
|
#include <cstddef>
|
|
#include <string>
|
|
|
|
namespace @KWSYS_NAMESPACE@ {
|
|
|
|
class DirectoryInternals;
|
|
|
|
/** \class Directory
|
|
* \brief Portable directory/filename traversal.
|
|
*
|
|
* Directory provides a portable way of finding the names of the files
|
|
* in a system directory.
|
|
*
|
|
* Directory currently works with Windows and Unix operating systems.
|
|
*/
|
|
class @KWSYS_NAMESPACE@_EXPORT Directory
|
|
{
|
|
public:
|
|
Directory();
|
|
Directory(Directory&& other);
|
|
Directory(const Directory&) = delete;
|
|
Directory& operator=(const Directory&) = delete;
|
|
Directory& operator=(Directory&& other);
|
|
bool operator==(const Directory&) = delete;
|
|
~Directory();
|
|
|
|
/**
|
|
* Load the specified directory and load the names of the files
|
|
* in that directory.
|
|
*/
|
|
Status Load(std::string const&, std::string* errorMessage = nullptr);
|
|
|
|
/**
|
|
* Return the number of files in the current directory.
|
|
*/
|
|
unsigned long GetNumberOfFiles() const;
|
|
|
|
/**
|
|
* Return the number of files in the specified directory.
|
|
* A higher performance static method.
|
|
*/
|
|
static unsigned long GetNumberOfFilesInDirectory(
|
|
const std::string&, std::string* errorMessage = nullptr);
|
|
|
|
/**
|
|
* Return the file at the given index, the indexing is 0 based
|
|
*/
|
|
const char* GetFile(unsigned long) const;
|
|
|
|
/**
|
|
* Return the name of the file at the given 0-based index.
|
|
*/
|
|
std::string const& GetFileName(std::size_t i) const;
|
|
|
|
/**
|
|
* Return the absolute path to the file at the given 0-based index.
|
|
*/
|
|
std::string GetFilePath(std::size_t i) const;
|
|
|
|
/**
|
|
* Return whether the file at the given 0-based index is a directory.
|
|
*/
|
|
bool FileIsDirectory(std::size_t i) const;
|
|
|
|
/**
|
|
* Return whether the file at the given 0-based index is a symlink.
|
|
*/
|
|
bool FileIsSymlink(std::size_t i) const;
|
|
|
|
/**
|
|
* Return the path to Open'ed directory
|
|
*/
|
|
const char* GetPath() const;
|
|
|
|
/**
|
|
* Clear the internal structure. Used internally at beginning of Load(...)
|
|
* to clear the cache.
|
|
*/
|
|
void Clear();
|
|
|
|
private:
|
|
// Private implementation details.
|
|
DirectoryInternals* Internal;
|
|
}; // End Class: Directory
|
|
|
|
} // namespace @KWSYS_NAMESPACE@
|
|
|
|
#endif
|