aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/utils/guard.h
blob: 7a0ddbf5c530ecdedb52e87eefb8d6e33a4d363c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "utils_global.h"

#include <QtGlobal>

namespace Utils {

class QTCREATOR_UTILS_EXPORT Guard
{
    Q_DISABLE_COPY(Guard)
public:
    Guard();
    ~Guard();
    bool isLocked() const;

    // Prefer using GuardLocker when possible. These two methods are provided only for cases
    // when locking and unlocking are done in separate methods, so that GuardLocker can't be
    // used.
    void lock();
    void unlock();
private:
    int m_lockCount = 0;
    friend class GuardLocker;
};

class QTCREATOR_UTILS_EXPORT GuardLocker
{
    Q_DISABLE_COPY(GuardLocker)
public:
    GuardLocker(Guard &guard);
    ~GuardLocker();

private:
    Guard &m_guard;
};

} // namespace Utils