summaryrefslogtreecommitdiffstats
path: root/Source/cmFileLockPool.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmFileLockPool.h')
-rw-r--r--Source/cmFileLockPool.h92
1 files changed, 92 insertions, 0 deletions
diff --git a/Source/cmFileLockPool.h b/Source/cmFileLockPool.h
new file mode 100644
index 0000000..41203ba
--- /dev/null
+++ b/Source/cmFileLockPool.h
@@ -0,0 +1,92 @@
+/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
+ file Copyright.txt or https://cmake.org/licensing for details. */
+#ifndef cmFileLockPool_h
+#define cmFileLockPool_h
+
+#include "cmConfigure.h" // IWYU pragma: keep
+
+#include <string>
+#include <vector>
+
+class cmFileLock;
+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& operator=(ScopePool const&) = delete;
+
+ cmFileLockResult Lock(const std::string& filename,
+ unsigned long timeoutSec);
+ cmFileLockResult Release(const std::string& filename);
+ bool IsAlreadyLocked(const std::string& filename) const;
+
+ private:
+ typedef std::vector<cmFileLock*> List;
+ typedef List::iterator It;
+ typedef List::const_iterator CIt;
+
+ List Locks;
+ };
+
+ typedef std::vector<ScopePool*> List;
+
+ typedef List::iterator It;
+ typedef List::const_iterator CIt;
+
+ List FunctionScopes;
+ List FileScopes;
+ ScopePool ProcessScope;
+};
+
+#endif // cmFileLockPool_h