summaryrefslogtreecommitdiffstats
path: root/src/util/signal-blocker.h
blob: 8fb62569a05072a2f3be5c10cebf6a3a5e6f41de (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
64
65
66
67
68
69
70
71
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Base RAII blocker for sgic++ signals.
 *
 * Authors:
 *   Jon A. Cruz <jon@joncruz.org>
 *
 * Copyright (C) 2014 Authors
 *
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */

#ifndef SEEN_INKSCAPE_UTIL_SIGNAL_BLOCKER_H
#define SEEN_INKSCAPE_UTIL_SIGNAL_BLOCKER_H

#include <string>
#include <sigc++/connection.h>

/**
 * Base RAII blocker for sgic++ signals.
 */
class SignalBlocker
{
public:
    /**
     * Creates a new instance that if the signal is currently unblocked will block
     * it until this instance is destructed and then will unblock it.
     */
    SignalBlocker( sigc::connection *connection ) :
        _connection(connection),
        _wasBlocked(_connection->blocked())
    {
        if (!_wasBlocked)
        {
            _connection->block();
        }
    }

    /**
     * Destructor that will unblock the signal if it was blocked initially by this
     * instance.
     */
    ~SignalBlocker()
    {
        if (!_wasBlocked)
        {
            _connection->block(false);
        }
    }

private:
    // noncopyable, nonassignable
    SignalBlocker(SignalBlocker const &other) = delete;
    SignalBlocker& operator=(SignalBlocker const &other) = delete;
    
    sigc::connection *_connection;
    bool _wasBlocked;
};

#endif // SEEN_INKSCAPE_UTIL_SIGNAL_BLOCKER_H

/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :