/usr/include/Wt/WSignal is in libwt-dev 3.3.6+dfsg-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WSIGNAL_H_
#define WSIGNAL_H_
#include <Wt/WObject>
#include <bitset>
#include <boost/bind.hpp>
#ifndef WT_NO_BOOST_INTRUSIVE
#include <boost/intrusive/list.hpp>
#endif
#include <boost/utility.hpp>
namespace Wt {
class JSlot;
class SlotLearnerInterface;
class WStatelessSlot;
class JavaScriptEvent;
#ifndef WT_NO_SLOT_MACROS
#define SLOT(x, y) x, &y
#define slots
#endif // WT_NO_SLOT_MACROS
/*! \defgroup signalslot Signal/slot system
\brief Support for event handling using signals and slots.
To respond to user-interactivity events, or in general to communicate
events from one widget to any other, %Wt uses a signal/slot system.
A slot is any method of any descendant of WObject. To connect a
signal with a slot, the only requirement is that the method
signature of the slot must be compatible with the signal
definition. In this way every method may be used as a slot, and it
is not necessary to explicitly indicate a particular method to be a
slot (as is needed in Qt), by putting them in a special section.
Nevertheless, you may still do that if you wish to emphasize that
these functions can be used as slots, or, if you have done extra
work to optimize the implementation of these methods as client-side
JavaScript code (see below).
A signal may be created by adding a \link Signal Signal<X,
...>\endlink object to your class. You may specify up to 6
arguments which may be of arbitrary types that are <i>Copyable</i>,
that may be passed through the signal to connected slots.
The library defines several user-event signals on various widgets,
and it is easy and convenient to add signals and slots to widget
classes to communicate events and trigger callbacks.
Event signals (\link EventSignal EventSignal<E>\endlink)
are signals that may be triggered internally by the library to
respond to user interactivity events. The abstract base classes
WInteractWidget and WFormWidget define most of these event
signals. To react to one of these events, the programmer connects a
self-defined or already existing slot to such a signal.
To connect a signal from multiple senders to a single slot, we
recommend the use of boost::bind() to identify the sender (or
otherwise the intention) of the signal. The use of class
\link WSignalMapper WSignalMapper<T> \endlink is discouraged.
\if cpp
Usage example:
\code
std::vector<Wt::WPushButton*> buttons = ...;
for(unsigned i = 0; i < buttons.size(); ++i) {
buttons[i]->clicked().connect(boost::bind(&Keyboard::handleClick, i));
}
void Keyboard::handleClick(int i) {
t->setText(WString("You pressed button {1}").args(i));
}
\endcode
\endif
*/
/*! \brief Abstract base class of a signal.
*
* Base class for all signals.
*
* \ingroup signalslot
*/
class WT_API SignalBase : boost::noncopyable
{
public:
virtual ~SignalBase();
/*! \brief Returns the sender.
*
* The sender usually corresponds to the owner, and is used by the
* WSignalMapper to associated sender-specific data.
*
* During a slot invocation, you can access the sender from WObject::sender().
*/
WObject *sender() const { return sender_; }
/*! \brief Returns whether this signal is connected.
*
* Returns true when the signal was connected to to at least one slot.
*/
virtual bool isConnected() const = 0;
void setBlocked(bool block);
bool isBlocked() const { return blocked_; }
/*! \brief Connects to a slot.
*
* Every signal can be connected to a slot which does not take any
* arguments (and may thus ignore signal arguments).
*/
virtual Wt::Signals::connection connect(WObject *target,
WObject::Method method) = 0;
/*! \brief Connects to a slot.
*
* Every signal can be connected to a slot which does not take any
* arguments (and may thus ignore signal arguments).
*/
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)());
protected:
SignalBase(WObject *sender);
static void pushSender(WObject *sender);
static void popSender();
virtual int argumentCount() const = 0;
private:
SignalBase(const SignalBase& other);
WObject *sender_;
bool blocked_;
static WObject *currentSender();
friend class WObject;
};
/*
* Normal signals wrap simply around boost signals
*/
/*! \class Signal Wt/WSignal Wt/WSignal
* \brief A signal that propagates events to listeners.
*
* Use Signal/slots to let one object (<i>A</i>) listen to events
* caused by another object (<i>B</i>). In this scenario, object
* <i>B</i> provides in its public interface access to a signal, to
* which object <i>A</i> connects one of its member function (which
* act as slot). Object <i>A</i> can then signal an event (which
* triggers the connected callback functions), by emitting the
* signal. Signal/slot is a generalization of the popular observer
* pattern used in GUIs.
*
* A signal can provide details of the event, using up to 6
* parameters. A slot must have a compatible signature to connect to
* a signal, based on its parameters. A compatible signature provides
* the same parameters in the member function, or less (leaving out
* parameters at the end).
*
* The signal automatically disconnects from the slot when the
* target is deleted. In addition, the signal may be deleted at any
* time, in particular also while it is being emitted.
*
* The %Signal objects integrate with WObject objects. A %Signal
* requires that the target of a connection, i.e. the object that
* listens for an event, is a %WObject. In addition, every signal may
* specify one %WObject to be the owner of the signal, and a target
* may find out the sender of a signal emission, using
* WObject::sender().
*
* \if cpp
* \code
* class MyWidget : public Wt::WContainerWidget
* {
* public:
* MyWidget(Wt::WContainerWidget *parent = 0)
* : Wt::WContainerWidget(parent),
* done_(this)
* {
* ...
* Wt::WPushButton *button = new Wt::WPushButton("Okay");
* button->clicked().connect(this, &MyWidget::process);
* }
*
* // provide an accessor for the signal
* Wt::Signal<int, std::string>& done() { return done_; }
*
* private:
* Wt::Signal<int, std::string> done_;
*
* void process() {
* ...
* done_.emit(42, "Totally done"); // emit the signal
* }
* };
* \endcode
* \endif
*
* This widget could then be used from another class:
* \if cpp
* \code
* class GUIClass : public Wt::WContainerWidget
* {
* ...
*
* private:
* void init() {
* MyWidget *widget = new MyWidget(this);
* widget->done().connect(this, &GUIClass::whenDone);
* }
*
* void whenDone(int result, const std::string& description) {
* ...
* }
* };
* \endcode
* \endif
*
* The WSignalMapper is a utility class that helps in situations where
* you want to connect multiple signals to a single slot, and still be
* identify the sender using some property.
*
* \sa WSignalMapper
*
* \ingroup signalslot
*/
template <typename A1 = NoClass, typename A2 = NoClass,
typename A3 = NoClass, typename A4 = NoClass,
typename A5 = NoClass, typename A6 = NoClass>
class Signal : public SignalBase
{
public:
/*! \brief Creates a signal.
*
* The \p sender is the object that will be identified as
* WObject::sender() when executing connected slots may be passed as
* an argument.
*
* The \p sender should not be \c 0 when you want to map the signal
* using the WSignalMapper.
*/
Signal(WObject *sender = 0);
/*! \brief Destructor.
*/
~Signal();
virtual Wt::Signals::connection connect(WObject *target,
WObject::Method method);
/*! \brief Connects to a function.
*
* This variant of the overloaded connect() method supports a
* template function object (which supports operator ()).
*
* When the receiver function is an object method, the signal will
* automatically be disconnected when the object is deleted, as long as the
* object inherits from WObject (or Wt::Signals::trackable).
*
* The function may leave up to <i>N</i> parameters unbound
* (e.g. using boost::bind placeholders _1 to _N) that may be bound
* to values passed by the signal.
*/
#ifndef WT_CNOR
template <class F> Wt::Signals::connection connect(const F& function);
#else
Wt::Signals::connection connect(const boost::bound& f);
#endif
/*! \brief Connects a slot that takes no arguments.
*
* This is always possible (even when the signal specifies a number
* of arguments).
*
* The slot is as a \p method of an object \p target of class \p T,
* which equals class \p V, or is a base class of class \p V. Thus,
* the following statement must return a non-null pointer:
*
* \code
* V *v = dynamic_cast<V *>(target);
* \endcode
*
* In practice, to facilitate automatic disconnects on deletion of
* the \p target, class \p T must be also be a descendant of WObject,
* but this is not enforced by the interface.
*/
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)());
/*! \brief Connects a slot that takes one argument.
*
* This is only possible for signals that take at least one argument.
*
* \sa connect(T *target, void (V::*method)())
*/
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(A1));
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(const A1&));
/*! \brief Connects a slot that takes two arguments.
*
* This is only possible for signals that take at least two arguments.
*
* \sa connect(T *target, void (V::*method)())
*/
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(A1, A2));
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(const A1&,
A2));
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(A1,
const A2&));
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(const A1&,
const A2&));
/*! \brief Connects a slot that takes three arguments.
*
* This is only possible for signals that take at least three arguments.
*
* \sa connect(T *target, void (V::*method)())
*/
template<class T, class V>
Wt::Signals::connection connect(T *target,
void (V::*method)(A1,A2,A3));
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(const A1&,
A2,A3));
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(const A1&,
const A2&,
A3));
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(const A1&,
const A2&,
const A3&));
/*! \brief Connects a slot that takes four arguments.
*
* This is only possible for signals that take at least four arguments.
*
* \sa connect(T *target, void (V::*method)())
*/
template<class T, class V>
Wt::Signals::connection connect(T *target,
void (V::*method)(A1,A2,A3,A4));
/*! \brief Connects a slot that takes five arguments.
*
* This is only possible for signals that take at least five arguments.
*
* \sa connect(T *target, void (V::*method)())
*/
template<class T, class V>
Wt::Signals::connection connect(T *target,
void (V::*method)(A1,A2,A3,A4,A5));
/*! \brief Connects a slot that takes six arguments.
*
* This is only possible for signals that take at least six arguments.
*
* \sa connect(T *target, void (V::*method)())
*/
template<class T, class V>
Wt::Signals::connection connect(T *target,
void (V::*method)(A1,A2,A3,A4,A5,A6));
/*! \brief Emits the signal.
*
* The arguments must exactly match the arguments of the target
* function.
*
* This will cause all connected slots to be triggered, with the given
* arguments.
*/
void emit(A1 a1 = NoClass::none, A2 a2 = NoClass::none,
A3 a3 = NoClass::none, A4 a4 = NoClass::none,
A5 a5 = NoClass::none, A6 a6 = NoClass::none) const;
/*! \brief Emits the signal.
*
* This is equivalent to emit().
*
* \sa emit
*/
void operator()(A1 a1 = NoClass::none, A2 a2 = NoClass::none,
A3 a3 = NoClass::none, A4 a4 = NoClass::none,
A5 a5 = NoClass::none, A6 a6 = NoClass::none) const;
virtual bool isConnected() const;
protected:
virtual int argumentCount() const;
private:
Signal(const Signal<A1, A2, A3, A4, A5, A6>&);
#ifdef WT_CNOR
typedef Wt::Signals::signal6<void, A1, A2, A3, A4, A5, A6> BoostSignalType;
#else
# if (_MSC_VER >= 1700) && defined(_VARIADIC_MAX) && (_VARIADIC_MAX < 6)
// MSVS 2012's std::bind implementation may support only 5 arguments
// http://blogs.msdn.com/b/vcblog/archive/2011/09/12/10209291.aspx
typedef Wt::Signals::signal<void(A1, A2, A3, A4, A5)> BoostSignalType;
# define A6_MUST_BE_NOCLASS
# else
typedef Wt::Signals::signal<void(A1, A2, A3, A4, A5, A6)> BoostSignalType;
# endif
#endif
BoostSignalType *impl_;
};
#ifndef WT_CNOR
/*
* Normal signal -- specialization for void
*/
template<>
class WT_API Signal<void> : public Signal<>
{
public:
Signal<void, NoClass, NoClass, NoClass, NoClass, NoClass>
(WObject *sender = 0);
};
#else // WT_CNOR
class WT_API Signal0 : public Signal<NoClass>
{
public:
Signal0(WObject *sender = 0);
void emit() const;
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)());
Wt::Signals::connection connect(const boost::bound& f);
};
#endif // WT_CNOR
/*! \brief Abstract base class of an event signal.
*
* An event signal is directly associated with a user-interface generated
* event.
*
* \ingroup signalslot
*/
class WT_API EventSignalBase : public SignalBase
#if !(defined(WT_TARGET_JAVA) || defined(WT_NO_BOOST_INTRUSIVE))
,public boost::intrusive::list_base_hook<>
#endif
{
public:
virtual ~EventSignalBase();
/*! \brief Returns the event name.
*
* The event name is implementation-defined.
*/
const char *name() const { return name_; }
bool needsUpdate(bool all) const;
void updateOk();
virtual bool isConnected() const;
virtual const std::string encodeCmd() const;
const std::string javaScript() const;
bool isExposedSignal() const;
bool canAutoLearn() const;
void setNotExposed();
void disconnect(Wt::Signals::connection& conn);
/*! \brief Disconnects a JSlot.
*/
void disconnect(JSlot& slot);
/*! \brief Prevents the default browser action.
*
* Use this method to prevent the default browser action associated
* with this event.
*
* \sa setPreventPropagation()
*/
void preventDefaultAction(bool prevent = true);
/*! \brief Returns whether the default browser action is prevented.
*
* \sa preventDefaultAction()
*/
bool defaultActionPrevented() const;
/*! \brief Prevents event propagation.
*
* Use this method to prevent that the event propagates further to
* its ancestors.
*
* \sa preventDefaultAction()
*/
void preventPropagation(bool prevent = true);
/*! \brief Returns whether event propagation is prevented.
*
* \sa preventPropagation()
*/
bool propagationPrevented() const;
const std::string createUserEventCall(const std::string& jsObject,
const std::string& jsEvent,
const std::string& eventName,
const std::string& arg1,
const std::string& arg2,
const std::string& arg3,
const std::string& arg4,
const std::string& arg5,
const std::string& arg6) const;
Wt::Signals::connection connectStateless(WObject::Method method,
WObject *target,
WStatelessSlot *slot);
using SignalBase::connect;
void connect(JSlot& slot);
void connect(const std::string& function);
void senderRepaint();
protected:
struct StatelessConnection {
Wt::Signals::connection connection;
WObject *target;
WStatelessSlot *slot;
bool ok() const;
StatelessConnection(const Wt::Signals::connection& c,
WObject *target, WStatelessSlot *slot);
};
static const int BIT_NEED_UPDATE = 0;
static const int BIT_SERVER_EVENT = 1;
static const int BIT_EXPOSED = 2;
static const int BIT_CAN_AUTOLEARN = 3;
static const int BIT_PREVENT_DEFAULT = 4;
static const int BIT_PREVENT_PROPAGATION = 5;
static const int BIT_SIGNAL_SERVER_ANYWAY = 6;
static int nextId_;
const char *name_;
const int id_;
std::vector<StatelessConnection> connections_;
std::bitset<7> flags_;
/*
* Dummy signal used for knowing if stateless connections are still
* connected.
*/
#ifndef WT_CNOR
Wt::Signals::signal<void()> dummy_;
#else
Wt::Signals::signal0<void> dummy_;
#endif
EventSignalBase(const char *name, WObject *sender, bool autoLearn);
void prepareDestruct();
void exposeSignal();
void processLearnedStateless() const;
void processNonLearnedStateless() const;
static void *alloc();
static void free(void *s);
private:
/*
* Our own list of connections to process them in a custom way.
*/
void removeSlot(WStatelessSlot *slot);
void processPreLearnStateless(SlotLearnerInterface *learner);
void processAutoLearnStateless(SlotLearnerInterface *learner);
virtual void processDynamic(const JavaScriptEvent& e) = 0;
friend class WStatelessSlot;
friend class WebRenderer;
friend class WebSession;
};
/*! \class EventSignal Wt/WSignal Wt/WSignal
* \brief A signal that conveys user-interface events.
*
* An %EventSignal is a special %Signal that may be triggered by user
* interface events such as a mouse click, key press, or focus change.
* They are made available through the library in widgets like
* WInteractWidget, and should not be instantiated directly.
*
* In addition to the behaviour of %Signal, they are capable of both
* executing client-side and server-side slot code. They may learn
* JavaScript from C++ code, through stateless slot learning, when
* connected to a slot that has a stateless implementation, using
* WObject::implementStateless(). Or they may be connected to a JSlot
* which provides manual JavaScript code.
*
* The typically relay UI event details, using event details objects
* like WKeyEvent or WMouseEvent.
*
* \sa Signal, JSignal
*
* \ingroup signalslot
*/
template<typename E = NoClass>
class EventSignal : public EventSignalBase
{
public:
#ifndef WT_TARGET_JAVA
#ifndef __clang__
// see bug: http://llvm.org/bugs/show_bug.cgi?id=6920
static void *operator new(std::size_t size);
static void operator delete(void *deletable, std::size_t size);
#endif // __clang__
EventSignal(const char *name, WObject *sender);
#else
EventSignal(const char *name, WObject *sender, const E& e);
#endif // WT_TARGET_JAVA
/*! \brief Returns whether the signal is connected.
*/
virtual bool isConnected() const;
/*! \brief Connects to a function.
*
* This variant of the overloaded connect() method supports a
* template function object (which supports operator ()).
*
* When the receiver function is an object method, the signal will
* automatically be disconnected when the object is deleted, as long as the
* object inherits from WObject (or Wt::Signals::trackable).
*
* The function may leave 1 parameters unbound (e.g. using
* boost::bind placeholders _1) that may be bound to the event
* detail object passed by the signal.
*/
#ifndef WT_CNOR
template <class F> Wt::Signals::connection connect(const F& function);
#else
Wt::Signals::connection connect(const boost::bound& function);
#endif
/*! \brief Connects a slot that takes no arguments.
*
* If a stateless implementation is specified for the slot, then
* the visual behaviour will be learned in terms of JavaScript, and
* will be cached on the client side for instant feed-back, in
* addition running the slot on the server.
*
* The slot is as a \p method of an object \p target of class \p T,
* which equals class \p V, or is a base class of class \p V. In
* addition, to check for stateless implementations, class \p T must
* be also be a descendant of WObject. Thus, the following statement
* must return a non-null pointer:
*
* \code
* WObject *o = dynamic_cast<WObject *>(dynamic_cast<V *>(target));
* \endcode
*/
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)());
/*! \brief Connects a slot that takes one argument.
*
* This is only possible for signals that take at least one argument.
*/
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(E));
/*! \brief Connects a slot that takes a 'const argument&'.
*
* This is only possible for signals that take at least one argument.
*/
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)(const E&));
/*! \brief Connects a JavaScript function.
*
* This will provide a client-side connection between the event and
* a JavaScript function. The argument must be a JavaScript function
* which optionally accepts two arguments (object and the event):
*
* \code
* function(object, event) {
* ...
* }
* \endcode
*
* Unlike a JSlot, there is no automatic connection management: the
* connection cannot be removed. If you need automatic connection
* management, you should use connect(JSlot&) instead.
*/
void connect(const std::string& function);
void connect(const char * function);
/*! \brief Connects a slot that is specified as JavaScript only.
*
* This will provide a client-side connection between the event and
* some JavaScript code as implemented by the slot. Unlike other
* connects, this does not cause the event to propagated to the
* application, and thus the state changes caused by the JavaScript
* slot are not tracked client-side.
*
* The connection is tracked, taking into account the life-time of
* the JSlot object, and can be updated by modifying the \p slot. If
* you do not need connection management (e.g. because the slot has
* the same life-time as the signal), then you can use connect(const
* std::string&) instead.
*/
void connect(JSlot& slot);
/*! \brief Emits the signal.
*
* This will cause all connected slots to be triggered, with the given
* argument.
*/
void emit(E e = NoClass::none) const;
/*! \brief Emits the signal.
*
* This is equivalent to emit().
*
* \sa emit()
*/
void operator()(E e) const;
virtual Wt::Signals::connection connect(WObject *target,
WObject::Method method);
protected:
virtual int argumentCount() const;
private:
#ifndef WT_CNOR
typedef Wt::Signals::signal<void(E)> BoostSignalType;
#else
typedef Wt::Signals::signal1<void, E> BoostSignalType;
#endif
BoostSignalType dynamic_;
void processDynamic(const JavaScriptEvent& e);
};
#ifdef WT_CNOR
class WT_API EventSignal0 : public EventSignalBase
{
public:
EventSignal0(const char *name, WObject *sender);
~EventSignal0();
virtual bool isConnected() const;
Wt::Signals::connection connect(const boost::bound& f);
void connect(const std::string& function);
void connect(JSlot& slot);
template<class T, class V>
Wt::Signals::connection connect(T *target, void (V::*method)());
void emit() const;
void operator()() const;
};
#endif // WT_CNOR
#ifndef WT_CNOR
template <class T, class V>
Wt::Signals::connection SignalBase::connect(T *target,
void (V::*method)())
{
WObject *o = dynamic_cast<WObject *>(dynamic_cast<V *>(target));
assert(o);
return connect(o, static_cast<WObject::Method>(method));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
Signal<A1, A2, A3, A4, A5, A6>::Signal(WObject *sender)
: SignalBase(sender),
impl_(0)
{
#ifdef A6_MUST_BE_NOCLASS
A6 YourMsvsOnlySupports5BindArguments = NoClass::none;
#endif
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
Signal<A1, A2, A3, A4, A5, A6>::~Signal()
{
delete impl_;
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class F>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(const F& function)
{
if (!impl_)
impl_ = new BoostSignalType;
return impl_->connect(function, Wt::Signals::at_front);
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(A1, A2, A3, A4, A5, A6))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2, ::_3, ::_4, ::_5, ::_6));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(A1, A2, A3, A4, A5))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2, ::_3, ::_4, ::_5));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(A1, A2, A3, A4))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2, ::_3, ::_4));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(const A1&, const A2&, const A3&))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2, ::_3));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(const A1&, const A2&, A3))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2, ::_3));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(const A1&, A2, A3))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2, ::_3));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(A1, A2, A3))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2, ::_3));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(const A1&, const A2&))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(const A1&, A2))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(A1, const A2&))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(A1, A2))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1, ::_2));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(const A1&))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, _1));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)(A1))
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target, ::_1));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(T *target, void (V::*method)())
{
assert(dynamic_cast<V *>(target));
return connect(boost::bind(method, target));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
Wt::Signals::connection Signal<A1, A2, A3, A4, A5, A6>
::connect(WObject *target, WObject::Method method)
{
return connect(boost::bind(method, target));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
void Signal<A1, A2, A3, A4, A5, A6>::emit(A1 a1, A2 a2, A3 a3,
A4 a4, A5 a5, A6 a6) const
{
if (impl_ && !isBlocked()) {
pushSender(sender());
#ifndef A6_MUST_BE_NOCLASS
(*impl_)(a1, a2, a3, a4, a5, a6);
#else
(*impl_)(a1, a2, a3, a4, a5);
#endif
popSender();
}
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
void Signal<A1, A2, A3, A4, A5, A6>::operator()(A1 a1, A2 a2, A3 a3,
A4 a4, A5 a5, A6 a6) const
{
emit(a1, a2, a3, a4, a5, a6);
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
bool Signal<A1, A2, A3, A4, A5, A6>::isConnected() const
{
return impl_ ? impl_->num_slots() > 0 : false;
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
int Signal<A1, A2, A3, A4, A5, A6>::argumentCount() const
{
if (typeid(A6) != typeid(NoClass))
return 6;
else if (typeid(A5) != typeid(NoClass))
return 5;
else if (typeid(A4) != typeid(NoClass))
return 4;
else if (typeid(A3) != typeid(NoClass))
return 3;
else if (typeid(A2) != typeid(NoClass))
return 2;
else if (typeid(A1) != typeid(NoClass))
return 1;
else
return 0;
}
#ifndef __clang__
template <typename E>
void *EventSignal<E>::operator new(std::size_t) {
return EventSignalBase::alloc();
}
template <typename E>
void EventSignal<E>::operator delete(void *deletable, std::size_t) {
EventSignalBase::free(deletable);
}
#endif // __clang__
template <typename E>
EventSignal<E>::EventSignal(const char *name, WObject *sender)
: EventSignalBase(name, sender, true)
{ }
template <typename E>
bool EventSignal<E>::isConnected() const
{
if (EventSignalBase::isConnected())
return true;
return dynamic_.num_slots() > 0;
}
template <typename E>
int EventSignal<E>::argumentCount() const
{
return 0; // excluding the event 'e'
}
template <typename E>
template <class F>
Wt::Signals::connection EventSignal<E>::connect(const F& function)
{
exposeSignal();
return dynamic_.connect(function, Wt::Signals::at_front);
}
template <typename E>
template <class T, class V>
Wt::Signals::connection EventSignal<E>::connect(T *target,
void (V::*method)())
{
exposeSignal();
WObject *o = dynamic_cast<WObject *>(dynamic_cast<V *>(target));
assert(o);
WStatelessSlot *s = o->isStateless(static_cast<WObject::Method>(method));
if (s)
return EventSignalBase::connectStateless
(static_cast<WObject::Method>(method), o, s);
else
return dynamic_.connect(boost::bind(method, target),
Wt::Signals::at_front);
}
template <typename E>
template <class T, class V>
Wt::Signals::connection EventSignal<E>::connect(T *target,
void (V::*method)(E))
{
exposeSignal();
assert(dynamic_cast<V *>(target));
return dynamic_.connect(boost::bind(method, target, ::_1),
Wt::Signals::at_front);
}
template <typename E>
template <class T, class V>
Wt::Signals::connection EventSignal<E>::connect(T *target,
void (V::*method)(const E&))
{
exposeSignal();
assert(dynamic_cast<V *>(target));
return dynamic_.connect(boost::bind(method, target, ::_1),
Wt::Signals::at_front);
}
template <typename E>
void EventSignal<E>::connect(const char *function)
{
EventSignalBase::connect(function);
}
template <typename E>
void EventSignal<E>::connect(const std::string& function)
{
EventSignalBase::connect(function);
}
template <typename E>
void EventSignal<E>::connect(JSlot& slot)
{
EventSignalBase::connect(slot);
}
template <typename E>
Wt::Signals::connection
EventSignal<E>::connect(WObject *target, WObject::Method method)
{
exposeSignal();
WStatelessSlot *s = target->isStateless(method);
if (s)
return EventSignalBase::connectStateless(method, target, s);
else
return dynamic_.connect(boost::bind(method, target),
Wt::Signals::at_front);
}
template <typename E>
void EventSignal<E>::emit(E e) const
{
if (isBlocked())
return;
pushSender(sender());
processLearnedStateless();
processNonLearnedStateless();
dynamic_(e);
popSender();
}
template <typename E>
void EventSignal<E>::operator()(E e) const
{
emit(e);
}
template <typename E>
void EventSignal<E>::processDynamic(const JavaScriptEvent& jse)
{
processNonLearnedStateless();
E event(jse);
if (dynamic_.num_slots()) {
pushSender(sender());
dynamic_(event);
popSender();
}
}
#endif // WT_CNOR
}
#endif // WSIGNAL_H_
|