File indexing completed on 2025-04-27 03:58:06
0001 /* ============================================================ 0002 * 0003 * This file is a part of digiKam project 0004 * https://www.digikam.org 0005 * 0006 * Date : 2012-01-29 0007 * Description : Intra-process file i/o lock 0008 * 0009 * SPDX-FileCopyrightText: 2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de> 0010 * 0011 * SPDX-License-Identifier: GPL-2.0-or-later 0012 * 0013 * ============================================================ */ 0014 0015 #ifndef DIGIKAM_FILE_READ_WRITE_LOCK_H 0016 #define DIGIKAM_FILE_READ_WRITE_LOCK_H 0017 0018 // Qt includes 0019 0020 #include <QString> 0021 #include <QTemporaryFile> 0022 0023 // Local includes 0024 0025 #include "digikam_export.h" 0026 0027 namespace Digikam 0028 { 0029 0030 class FileReadWriteLockPriv; 0031 0032 class DIGIKAM_EXPORT FileReadWriteLockKey 0033 { 0034 public: 0035 0036 explicit FileReadWriteLockKey(const QString& filePath); 0037 ~FileReadWriteLockKey(); 0038 0039 void lockForRead(); 0040 void lockForWrite(); 0041 bool tryLockForRead(); 0042 bool tryLockForRead(int timeout); 0043 bool tryLockForWrite(); 0044 bool tryLockForWrite(int timeout); 0045 void unlock(); 0046 0047 private: 0048 0049 FileReadWriteLockPriv* d; 0050 }; 0051 0052 // ---------------------------------------------------------------------- 0053 0054 class DIGIKAM_EXPORT FileReadLocker 0055 { 0056 public: 0057 0058 explicit FileReadLocker(const QString& filePath); 0059 ~FileReadLocker(); 0060 0061 private: 0062 0063 FileReadWriteLockPriv* d; 0064 }; 0065 0066 // ---------------------------------------------------------------------- 0067 0068 class DIGIKAM_EXPORT FileWriteLocker 0069 { 0070 public: 0071 0072 explicit FileWriteLocker(const QString& filePath); 0073 ~FileWriteLocker(); 0074 0075 private: 0076 0077 FileReadWriteLockPriv* d; 0078 }; 0079 0080 // ---------------------------------------------------------------------- 0081 0082 class DIGIKAM_EXPORT SafeTemporaryFile : public QTemporaryFile 0083 { 0084 Q_OBJECT 0085 0086 public: 0087 0088 explicit SafeTemporaryFile(const QString& templ); 0089 SafeTemporaryFile(); 0090 0091 bool open(); 0092 0093 QString safeFilePath() const; 0094 0095 protected: 0096 0097 bool open(QIODevice::OpenMode) override; 0098 0099 private: 0100 0101 // Disable 0102 SafeTemporaryFile(QObject*) = delete; 0103 0104 QString m_templ; 0105 }; 0106 0107 } // namespace Digikam 0108 0109 #endif // DIGIKAM_FILE_READ_WRITE_LOCK_H