mirror of
https://github.com/Kitware/CMake.git
synced 2025-05-09 23:08:18 +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.
62 lines
1.9 KiB
C++
62 lines
1.9 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 <array>
|
|
#include <cstddef>
|
|
#include <string>
|
|
#include <utility>
|
|
|
|
class cmMakefile;
|
|
|
|
/** \class cmFilePathChecksum
|
|
* @brief Generates a checksum for the parent directory of a file
|
|
*
|
|
* The checksum is calculated from the relative file path to the
|
|
* closest known project directory. This guarantees reproducibility
|
|
* when source and build directory differ e.g. for different project
|
|
* build directories.
|
|
*/
|
|
class cmFilePathChecksum
|
|
{
|
|
public:
|
|
/// Maximum number of characters to use from the path checksum
|
|
static const size_t partLengthDefault = 10;
|
|
|
|
/// @brief Parent directories are empty
|
|
cmFilePathChecksum();
|
|
|
|
/// @brief Initializes the parent directories manually
|
|
cmFilePathChecksum(std::string const& currentSrcDir,
|
|
std::string const& currentBinDir,
|
|
std::string const& projectSrcDir,
|
|
std::string const& projectBinDir);
|
|
|
|
/// @brief Initializes the parent directories from a makefile
|
|
cmFilePathChecksum(cmMakefile* makefile);
|
|
|
|
/// @brief Allows parent directories setup after construction
|
|
///
|
|
void setupParentDirs(std::string const& currentSrcDir,
|
|
std::string const& currentBinDir,
|
|
std::string const& projectSrcDir,
|
|
std::string const& projectBinDir);
|
|
|
|
/* @brief Calculates the path checksum for the parent directory of a file
|
|
*
|
|
*/
|
|
std::string get(std::string const& filePath) const;
|
|
|
|
/* @brief Same as get() but returns only the first length characters
|
|
*
|
|
*/
|
|
std::string getPart(std::string const& filePath,
|
|
size_t length = partLengthDefault) const;
|
|
|
|
private:
|
|
/// List of (directory name, seed name) pairs
|
|
std::array<std::pair<std::string, std::string>, 4> parentDirs;
|
|
};
|