src/shared/qtlockedfile/qtlockedfile.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef QTLOCKEDFILE_H
  35 #define QTLOCKEDFILE_H
  36
  37 #include <QtCore/QFile>
  38
  39 #if defined(Q_OS_WIN)
  40 #  if !defined(QT_QTLOCKEDFILE_EXPORT) && !defined(QT_QTLOCKEDFILE_IMPORT)
  41 #    define QT_QTLOCKEDFILE_EXPORT
  42 #  elif defined(QT_QTLOCKEDFILE_IMPORT)
  43 #    if defined(QT_QTLOCKEDFILE_EXPORT)
  44 #      undef QT_QTLOCKEDFILE_EXPORT
  45 #    endif
  46 #    define QT_QTLOCKEDFILE_EXPORT __declspec(dllimport)
  47 #  elif defined(QT_QTLOCKEDFILE_EXPORT)
  48 #    undef QT_QTLOCKEDFILE_EXPORT
  49 #    define QT_QTLOCKEDFILE_EXPORT __declspec(dllexport)
  50 #  endif
  51 #else
  52 #  define QT_QTLOCKEDFILE_EXPORT
  53 #endif
  54
  55 namespace SharedTools {
  56
  57 class QT_QTLOCKEDFILE_EXPORT QtLockedFile : public QFile
  58 {
  59 public:
  60     enum LockMode { NoLock = 0, ReadLock, WriteLock };
  61
  62     QtLockedFile();
  63     QtLockedFile(const QString &name);
  64     ~QtLockedFile();
  65
  66     bool lock(LockMode mode, bool block = true);
  67     bool unlock();
  68     bool isLocked() const;
  69     LockMode lockMode() const;
  70
  71 private:
  72 #ifdef Q_OS_WIN
  73     Qt::HANDLE m_semaphore_hnd;
  74     Qt::HANDLE m_mutex_hnd;
  75 #endif
  76     LockMode m_lock_mode;
  77 };
  78
  79 } // namespace SharedTools
  80
  81 #endif // QTLOCKEDFILE_H