mirror of
https://github.com/Kitware/CMake.git
synced 2025-06-13 22:30:25 +08:00
bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6 enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
83 lines
2.5 KiB
C++
83 lines
2.5 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <iosfwd>
|
|
#include <map>
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include "cmListFileCache.h"
|
|
|
|
/** \class cmGlobVerificationManager
|
|
* \brief Class for expressing build-time dependencies on glob expressions.
|
|
*
|
|
* Generates a CMake script which verifies glob outputs during prebuild.
|
|
*
|
|
*/
|
|
class cmGlobVerificationManager
|
|
{
|
|
protected:
|
|
//! Save verification script for given makefile.
|
|
//! Saves to output <path>/<CMakeFilesDirectory>/VerifyGlobs.cmake
|
|
bool SaveVerificationScript(const std::string& path);
|
|
|
|
//! Add an entry into the glob cache
|
|
void AddCacheEntry(bool recurse, bool listDirectories, bool followSymlinks,
|
|
const std::string& relative,
|
|
const std::string& expression,
|
|
const std::vector<std::string>& files,
|
|
const std::string& variable,
|
|
const cmListFileBacktrace& bt);
|
|
|
|
//! Clear the glob cache for state reset.
|
|
void Reset();
|
|
|
|
//! Check targets should be written in generated build system.
|
|
bool DoWriteVerifyTarget() const;
|
|
|
|
//! Get the paths to the generated script and stamp files
|
|
std::string const& GetVerifyScript() const { return this->VerifyScript; }
|
|
std::string const& GetVerifyStamp() const { return this->VerifyStamp; }
|
|
|
|
private:
|
|
struct CacheEntryKey
|
|
{
|
|
const bool Recurse;
|
|
const bool ListDirectories;
|
|
const bool FollowSymlinks;
|
|
const std::string Relative;
|
|
const std::string Expression;
|
|
CacheEntryKey(const bool rec, const bool l, const bool s, std::string rel,
|
|
std::string e)
|
|
: Recurse(rec)
|
|
, ListDirectories(l)
|
|
, FollowSymlinks(s)
|
|
, Relative(std::move(rel))
|
|
, Expression(std::move(e))
|
|
{
|
|
}
|
|
bool operator<(const CacheEntryKey& r) const;
|
|
void PrintGlobCommand(std::ostream& out, const std::string& cmdVar);
|
|
};
|
|
|
|
struct CacheEntryValue
|
|
{
|
|
bool Initialized = false;
|
|
std::vector<std::string> Files;
|
|
std::vector<std::pair<std::string, cmListFileBacktrace>> Backtraces;
|
|
};
|
|
|
|
using CacheEntryMap = std::map<CacheEntryKey, CacheEntryValue>;
|
|
CacheEntryMap Cache;
|
|
std::string VerifyScript;
|
|
std::string VerifyStamp;
|
|
|
|
// Only cmState should be able to add cache values.
|
|
// cmGlobVerificationManager should never be used directly.
|
|
friend class cmState; // allow access to add cache values
|
|
};
|