xref: /freebsd/contrib/llvm-project/clang/lib/DirectoryWatcher/DirectoryScanner.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 //===- DirectoryScanner.h - Utility functions for DirectoryWatcher --------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "clang/DirectoryWatcher/DirectoryWatcher.h"
10 #include "llvm/Support/FileSystem.h"
11 #include <string>
12 #include <vector>
13 
14 namespace clang {
15 
16 /// Gets names (filenames) of items in directory at \p Path.
17 /// \returns empty vector if \p Path is not a directory, doesn't exist or can't
18 /// be read from.
19 std::vector<std::string> scanDirectory(llvm::StringRef Path);
20 
21 /// Create event with EventKind::Added for every element in \p Scan.
22 std::vector<DirectoryWatcher::Event>
23 getAsFileEvents(const std::vector<std::string> &Scan);
24 
25 /// Gets status of file (or directory) at \p Path.
26 /// \returns llvm::None if \p Path doesn't exist or can't get the status.
27 llvm::Optional<llvm::sys::fs::file_status> getFileStatus(llvm::StringRef Path);
28 
29 } // namespace clang
30