summaryrefslogtreecommitdiff
path: root/src/FbTk/Slot.hh
blob: 23be19796c4d3822e309fd14e182a5204ca2c565 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
// Slot.hh for FbTk, Fluxbox Toolkit
// Copyright (c) 2008 Henrik Kinnunen (fluxgen at fluxbox dot org)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

#ifndef FBTK_SLOT_HH
#define FBTK_SLOT_HH

#include "NotCopyable.hh"

namespace FbTk {

/// \namespace Implementation details for signals, do not use anything in this namespace
namespace SigImpl {

struct EmptyArg {};

/** A base class for all slots. It's purpose is to provide a virtual destructor and to enable the
 * Signal class to hold a pointer to a generic slot.
 */
class SlotBase: private FbTk::NotCopyable {
public:
    virtual ~SlotBase() {}
};

} // namespace SigImpl

/** Declares a pure virtual function call operator with a specific number of arguments (depending
 * on the template specialization). This allows us to "call" any functor in an opaque way.
 */
template<typename ReturnType, typename Arg1 = SigImpl::EmptyArg,
         typename Arg2 = SigImpl::EmptyArg, typename Arg3 = SigImpl::EmptyArg>
class Slot: public SigImpl::SlotBase {
public:
    virtual ReturnType operator()(Arg1, Arg2, Arg3) = 0;
};

/// Specialization for two arguments
template<typename ReturnType, typename Arg1, typename Arg2>
class Slot<ReturnType, Arg1, Arg2, SigImpl::EmptyArg>: public SigImpl::SlotBase {
public:
    virtual ReturnType operator()(Arg1, Arg2) = 0;
};

/// Specialization for one argument
template<typename ReturnType, typename Arg1>
class Slot<ReturnType, Arg1, SigImpl::EmptyArg, SigImpl::EmptyArg>: public SigImpl::SlotBase {
public:
    virtual ReturnType operator()(Arg1) = 0;
};

/// Specialization for no arguments
template<typename ReturnType>
class Slot<ReturnType, SigImpl::EmptyArg, SigImpl::EmptyArg, SigImpl::EmptyArg>: public SigImpl::SlotBase {
public:
    virtual ReturnType operator()() = 0;
};

/** A class which knows how to call a specific functor. It inherits from Slot and implemetents
 * the function call operator
 */
template<typename Functor, typename ReturnType, typename Arg1 = SigImpl::EmptyArg,
         typename Arg2 = SigImpl::EmptyArg, typename Arg3 = SigImpl::EmptyArg>
class SlotImpl: public Slot<ReturnType, Arg1, Arg2, Arg3> {
public:
    virtual ReturnType operator()(Arg1 arg1, Arg2 arg2, Arg3 arg3)
    { return static_cast<ReturnType>(m_functor(arg1, arg2, arg3)); }

    SlotImpl(Functor functor) : m_functor(functor) {}

private:
    Functor m_functor;
};

/// Specialization for two arguments
template<typename Functor, typename ReturnType, typename Arg1, typename Arg2>
class SlotImpl<Functor, ReturnType, Arg1, Arg2, SigImpl::EmptyArg>: public Slot<ReturnType, Arg1, Arg2> {
public:
    virtual ReturnType operator()(Arg1 arg1, Arg2 arg2)
    { return static_cast<ReturnType>(m_functor(arg1, arg2)); }

    SlotImpl(Functor functor) : m_functor(functor) {}

private:
    Functor m_functor;
};

/// Specialization for one argument
template<typename Functor, typename ReturnType, typename Arg1>
class SlotImpl<Functor, ReturnType, Arg1, SigImpl::EmptyArg, SigImpl::EmptyArg>: public Slot<ReturnType, Arg1> {
public:
    virtual ReturnType operator()(Arg1 arg1) { return static_cast<ReturnType>(m_functor(arg1)); }

    SlotImpl(Functor functor) : m_functor(functor) {}

private:
    Functor m_functor;
};

/// Specialization for no arguments
template<typename Functor, typename ReturnType>
class SlotImpl<Functor, ReturnType, SigImpl::EmptyArg, SigImpl::EmptyArg, SigImpl::EmptyArg>: public Slot<ReturnType> {
public:
    virtual ReturnType operator()() { return static_cast<ReturnType>(m_functor()); }

    SlotImpl(Functor functor) : m_functor(functor) {}

private:
    Functor m_functor;
};

} // namespace FbTk

#endif // FBTK_SLOT_H