webrtc/talk/base/sigslottester.h.pump
buildbot@webrtc.org f1adbeedb4 (Auto)update libjingle 68562943-> 68571194
git-svn-id: http://webrtc.googlecode.com/svn/trunk@6333 4adac7df-926f-26a2-2b94-8c16560cd09d
2014-06-04 21:57:16 +00:00

103 lines
3.6 KiB
Plaintext
Executable File

/*
* libjingle
* Copyright 2014 Google Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef TALK_BASE_SIGSLOTTESTER_H_
#define TALK_BASE_SIGSLOTTESTER_H_
// To generate sigslottester.h from sigslottester.h.pump, execute:
// /home/build/google3/third_party/gtest/scripts/pump.py sigslottester.h.pump
// SigslotTester(s) are utility classes to check if signals owned by an
// object are being invoked at the right time and with the right arguments.
// They are meant to be used in tests. Tests must provide "capture" pointers
// (i.e. address of variables) where the arguments from the signal callback
// can be stored.
//
// Example:
// /* Some signal */
// sigslot::signal1<const std::string&> foo;
//
// /* We want to monitor foo in some test. Note how signal argument is
// const std::string&, but capture-type is std::string. Capture type
// must be type that can be assigned to. */
// std::string capture;
// SigslotTester1<const std::string&, std::string> slot(&foo, &capture);
// foo.emit("hello");
// EXPECT_EQ(1, slot.callback_count());
// EXPECT_EQ("hello", capture);
// /* See unit-tests for more examples */
#include "talk/base/constructormagic.h"
#include "talk/base/sigslot.h"
namespace talk_base {
// For all the templates below:
// - A1-A5 is the type of the argument i in the callback. Signals may and often
// do use const-references here for efficiency.
// - C1-C5 is the type of the variable to capture argument i. These should be
// non-const value types suitable for use as lvalues.
$var n = 5
$range i 1..n
$for i [[
$range j 1..i
template <$for j , [[class A$j]], $for j , [[class C$j]]>
class SigslotTester$i : public sigslot::has_slots<> {
public:
SigslotTester$i(sigslot::signal$i<$for j , [[A$j]]>* signal,
$for j , [[C$j* capture$j]])
: callback_count_(0),
$for j , [[capture$j[[]]_(capture$j)]] {
signal->connect(this, &SigslotTester$i::OnSignalCallback);
}
int callback_count() const { return callback_count_; }
private:
void OnSignalCallback($for j , [[A$j arg$j]]) {
callback_count_++;$for j [[
*capture$j[[]]_ = arg$j;]]
}
int callback_count_;$for j [[
C$j* capture$j[[]]_;]]
DISALLOW_COPY_AND_ASSIGN(SigslotTester$i);
};
]]
} // namespace talk_base
#endif // TALK_BASE_SIGSLOTTESTER_H_