1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-05-09 14:57:08 +08:00
CMake/Source/cmFileLockPool.h
Kitware Robot bdca8b01d2 Modernize: Use #pragma once in all header files
#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.
2020-09-03 09:30:21 -04:00

88 lines
2.0 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 <string>
#include <vector>
#include "cmFileLock.h"
class cmFileLockResult;
class cmFileLockPool
{
public:
cmFileLockPool();
~cmFileLockPool();
cmFileLockPool(cmFileLockPool const&) = delete;
cmFileLockPool& operator=(cmFileLockPool const&) = delete;
//@{
/**
* @brief Function scope control.
*/
void PushFunctionScope();
void PopFunctionScope();
//@}
//@{
/**
* @brief File scope control.
*/
void PushFileScope();
void PopFileScope();
//@}
//@{
/**
* @brief Lock the file in given scope.
* @param timeoutSec Lock timeout. If -1 try until success or fatal error.
*/
cmFileLockResult LockFunctionScope(const std::string& filename,
unsigned long timeoutSec);
cmFileLockResult LockFileScope(const std::string& filename,
unsigned long timeoutSec);
cmFileLockResult LockProcessScope(const std::string& filename,
unsigned long timeoutSec);
//@}
/**
* @brief Unlock the file explicitly.
*/
cmFileLockResult Release(const std::string& filename);
private:
bool IsAlreadyLocked(const std::string& filename) const;
class ScopePool
{
public:
ScopePool();
~ScopePool();
ScopePool(ScopePool const&) = delete;
ScopePool(ScopePool&&) noexcept;
ScopePool& operator=(ScopePool const&) = delete;
ScopePool& operator=(ScopePool&&) noexcept;
cmFileLockResult Lock(const std::string& filename,
unsigned long timeoutSec);
cmFileLockResult Release(const std::string& filename);
bool IsAlreadyLocked(const std::string& filename) const;
private:
using List = std::vector<cmFileLock>;
List Locks;
};
using List = std::vector<ScopePool>;
List FunctionScopes;
List FileScopes;
ScopePool ProcessScope;
};