directorylock.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_DIRECTORYLOCK_H
#define LIBREPCB_CORE_DIRECTORYLOCK_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "filepath.h"
 
#include <QtCore>
 
#include <functional>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
/*******************************************************************************
 *  Class DirectoryLock
 ******************************************************************************/
 
class DirectoryLock final {
  Q_DECLARE_TR_FUNCTIONS(DirectoryLock)
 
public:
  // Types
 
  enum class LockStatus {
    Unlocked,
    StaleLock,
    LockedByThisApp,
    LockedByOtherApp,
    LockedByOtherUser,
    LockedByUnknownApp,
  };
 
  typedef std::function<bool(const FilePath& dir, LockStatus status,
                             const QString& user)>
      LockHandlerCallback;
 
  // Constructors / Destructor
 
  DirectoryLock() noexcept;
 
  DirectoryLock(const DirectoryLock& other) = delete;
 
  explicit DirectoryLock(const FilePath& dir) noexcept;
 
  ~DirectoryLock() noexcept;
 
  // Setters
 
  void setDirToLock(const FilePath& dir) noexcept;
 
  // Getters
 
  const FilePath& getDirToLock() const noexcept { return mDirToLock; }
 
  const FilePath& getLockFilepath() const noexcept { return mLockFilePath; }
 
  LockStatus getStatus(QString* lockedByUser = nullptr) const;
 
  // General Methods
 
  void tryLock(LockHandlerCallback lockHandler = nullptr);
 
  bool unlockIfLocked();
 
  void lock();
 
  void unlock();
 
  // Operator Overloadings
  DirectoryLock& operator=(const DirectoryLock& rhs) = delete;
 
private:  // Methods
  static QSet<FilePath>& dirsLockedByThisAppInstance() noexcept;
 
private:  // Data
  FilePath mDirToLock;
 
  FilePath mLockFilePath;
 
  bool mLockedByThisObject;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif