/usr/include/Wt/WJavaScript is in libwt-dev 3.1.10-1ubuntu2.
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 | // 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 WJAVASCRIPT_H_
#define WJAVASCRIPT_H_
#include <Wt/WSignal>
#include <Wt/WEvent>
#include <Wt/WJavaScriptSlot>
#include <Wt/WString>
#include <boost/lexical_cast.hpp>
namespace Wt {
/*! \class JSignal Wt/WJavaScript Wt/WJavaScript
* \brief A signal to relay JavaScript to C++ calls.
*
* A JSignal, like an EventSignal, provides communicates events from
* JavaScript to C++ code. However, it not tied to a built-in
* event. Instead, it can be emitted from within custom JavaScript
* code using the JavaScript Wt.emit() function.
*
* The signal is identified by a unique name within the scope of a
* WObject, or a unique global name (when declaring the signal in your
* WApplication).
*
* The signal supports up to 6 arguments. Values for these arguments
* may be specified in the JavaScript Wt.emit() (or the deprecated
* global function WtSignalEmit()).
*
* Example code:
* \code
* class MyWidget : public WCompositeWidget
* {
* public:
* MyWidget()
* : doSome_(this, "doSome")
* {
* ...
* }
*
* JSignal<std::string, int>& doSome() { return doSome_; }
*
* private:
* JSignal<std::string, int> doSome_;
*
* ...
* };
*
* \endcode
*
* The following JavaScript statement will emit the signal for a DOM
* element <i>element</i> that corresponds to a widget of class
* <tt>MyWidget</tt>:
*
* \code
* Wt.emit(element, 'dosome', 'foo', 42);
* \endcode
*
* The <i>element</i> can be a \link WWidget::jsRef() DOM
* element\endlink, or the \link WObject::id() object ID\endlink of a
* WObject, or the constant 'Wt' which is an alias for
* 'Wt::WApplication::instance()->id()'. The conversion between the
* JavaScript arguments (ax) and the C++ type Ax uses
* <tt>boost::lexical_cast<Ax>(ax)</tt>.
*
* You can use the methods createCall() to let the signal itself
* generate this JavaScript call for you:
* \code
* doSome_.createCall("'foo'", "42");
* \endcode
*
* The JavaScript generated by createCall() is possibly affected by every
* connect or disconnect to the signal. In practice, you will use JSignal
* internally within a widget and call createCall() only after you connected
* internal slots to signal.
*
* It is also possible to propagate an original JavaScript event as a
* last argument, of type WMouseEvent or WKeyEvent. In that case, the
* second argument in <tt>Wt.emit()</tt> must be an object which
* indicates also the JavaScript event and event target.
*
* Consider a signal declaration:
* \code
* JSignal<std::string, int, WMouseEvent> doSome();
* \endcode
*
* Then, the following would be a suitable JavaScript call:
*
* \code
* Wt.emit(Wt, {name: 'dosome', event: event, eventObject: object}, 'foo', 42);
* \endcode
*
* The method createEventCall() may be used this variation for the JavaScript
* method call.
*
* Since the conversion from JavaScript to C++ uses
* <tt>boost::lexical_cast<T>(arg)</tt>, you may provide support for
* custom types by implementing the c++ input stream operator
* <tt>operator<< (std::istream&, T& t)</tt> for your type.
*
* \sa WWidget::jsRef(), WObject::id()
*
* \ingroup signalslot
*/
template <typename A1 = NoClass, typename A2 = NoClass,
typename A3 = NoClass, typename A4 = NoClass,
typename A5 = NoClass, typename A6 = NoClass>
class JSignal : public EventSignalBase
{
public:
/*! \brief Construct a signal for the given object, and name.
*
* The given \p name must be unique for all user signals
* specified for the object \p object. Ownership of the signal
* is not transferred to the object.
*
* If \p collectSlotJavaScript is \c true, then javascript specified
* for connected slots (using JSlot) or learned by stateless slot
* learning, is collected to client-side JavaScript.
*
* Use the utility methods createCall() or createEventCall() to
* create the appropriate JavaScript statements that invoke the
* signal, which take into account possible other client-side
* JavaScript handling associated with the signal.
*
* \sa \link WObject::implementStateless() stateless slot learning\endlink
*/
JSignal(WObject *object, const std::string& name,
bool collectSlotJavaScript = false);
/*! \brief Destructor.
*/
~JSignal();
/*! \brief Returns the signal name.
*/
const std::string& name() const { return name_; }
virtual const std::string encodeCmd() const;
/*! \brief Returns a JavaScript call that triggers the signal.
*
* This is:
* \code
Wt.emit([element], [name], arg1, ...);
* \endcode
*
* When the signal was constructed with \p collectSlotJavaScript ==
* \c true, the inline JavaScript from slots defined as JavaScript
* or from learned stateless slots is included as well.
*
* \sa createEventCall()
*/
const std::string createCall(const std::string& arg1 = std::string(),
const std::string& arg2 = std::string(),
const std::string& arg3 = std::string(),
const std::string& arg4 = std::string(),
const std::string& arg5 = std::string(),
const std::string& arg6 = std::string()) const;
/*! \brief Returns a JavaScript call that triggers the signal, passing
* the original event too.
*
* Similar to createCall(), the following JavaScript is returned:
* \code
Wt.emit([element], { name: [name], eventObject: [jsObject], event: [jsEvent]},
arg1, ...);
* \endcode
*
* In addition to information identifying the signal (\p element
* and \p name) and the arguments, also information on the original
* JavaScript event is transferred. In this way, you can propagate the
* corresponding event class (WMouseEvent or WKeyEvent) as an additional
* last argument in the slot.
*/
const std::string createEventCall(const std::string& jsObject,
const std::string& jsEvent,
const std::string& arg1 = std::string(),
const std::string& arg2 = std::string(),
const std::string& arg3 = std::string(),
const std::string& arg4 = std::string(),
const std::string& arg5 = std::string())
const;
/*! \brief Returns whether the signal is connected to at least one slot.
*/
virtual bool isConnected() const;
/*! \brief Connect 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 boost::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.
*/
template<class F>
boost::signals::connection connect(const F& function);
/*! \brief Connect a slot that takes no arguments.
*
* The slot is specified as a 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
*
* 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.
*/
template<class T, class V>
boost::signals::connection connect(T *target, void (V::*method)());
/*! \brief Connect 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>
boost::signals::connection connect(T *target, void (V::*method)(A1));
template<class T, class V>
boost::signals::connection connect(T *target, void (V::*method)(const A1&));
/*! \brief Connect 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>
boost::signals::connection connect(T *target, void (V::*method)(A1, A2));
/*! \brief Connect 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>
boost::signals::connection connect(T *target,
void (V::*method)(A1,A2,A3));
/*! \brief Connect 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>
boost::signals::connection connect(T *target,
void (V::*method)(A1,A2,A3,A4));
/*! \brief Connect 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>
boost::signals::connection connect(T *target,
void (V::*method)(A1,A2,A3,A4,A5));
/*! \brief Connect 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>
boost::signals::connection connect(T *target,
void (V::*method)(A1,A2,A3,A4,A5,A6));
/*! \brief Connect 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 induced by the
* \p slot are invisible to the server-side.
*/
void connect(JSlot& slot);
/*! \brief Emit 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);
/*! \brief Emit 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);
virtual boost::signals::connection connect(WObject *target,
void (WObject::*method)());
private:
JSignal(const JSignal<A1, A2, A3, A4, A5, A6>&);
std::string name_;
bool collectSlotJavaScript_;
void processDynamic(const JavaScriptEvent& e);
boost::signal6<void, A1, A2, A3, A4, A5, A6> *impl_;
};
#ifndef WT_CNOR
/*
* JSignal -- specialization for void
*/
template<>
class WT_API JSignal<void> : public JSignal<>
{
public:
JSignal(WObject *object, const std::string& name,
bool collectSlotJavaScript = false);
};
#else // WT_CNOR
class WT_API JSignal0 : public JSignal<NoClass>
{
public:
JSignal0(WObject *object, const std::string& name,
bool collectSlotJavaScript = false);
template<class T, class V>
boost::signals::connection connect(T *target, void (V::*method)());
void emit();
};
#endif // WT_CNOR
#ifndef WT_CNOR
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
JSignal<A1, A2, A3, A4, A5, A6>::JSignal(WObject *object,
const std::string& name,
bool collectSlotJavaScript)
: EventSignalBase(0, object),
name_(name),
collectSlotJavaScript_(collectSlotJavaScript),
impl_(0)
{ }
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
JSignal<A1, A2, A3, A4, A5, A6>::~JSignal()
{
prepareDestruct();
delete impl_;
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
const std::string JSignal<A1, A2, A3, A4, A5, A6>::encodeCmd() const
{
return sender()->id() + "." + name_;
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
const std::string JSignal<A1, A2, A3, A4, A5, A6>
::createCall(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
{
return EventSignalBase::createUserEventCall(std::string(), std::string(),
name_, arg1, arg2, arg3,
arg4, arg5, arg6);
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
const std::string JSignal<A1, A2, A3, A4, A5, A6>
::createEventCall(const std::string& jsObject, const std::string& jsEvent,
const std::string& arg1, const std::string& arg2,
const std::string& arg3, const std::string& arg4,
const std::string& arg5) const
{
return EventSignalBase::createUserEventCall(jsObject, jsEvent,
name_, arg1, arg2, arg3,
arg4, arg5, "");
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class F>
boost::signals::connection JSignal<A1, A2, A3, A4, A5, A6>
::connect(const F& function)
{
exposeSignal();
if (!impl_)
impl_ = new boost::signal6<void, A1, A2, A3, A4, A5, A6>;
return impl_->connect(function);
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
template <class T, class V>
boost::signals::connection JSignal<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>
boost::signals::connection JSignal<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>
boost::signals::connection JSignal<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>
boost::signals::connection JSignal<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>
boost::signals::connection JSignal<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>
boost::signals::connection JSignal<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>
boost::signals::connection JSignal<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>
boost::signals::connection JSignal<A1, A2, A3, A4, A5, A6>
::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 (collectSlotJavaScript_ && s)
return EventSignalBase::connectStateless
(static_cast<WObject::Method>(method), o, s);
else
return connect(boost::bind(method, target));
}
extern void WT_API throwWtException(const std::string& msg);
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
void JSignal<A1, A2, A3, A4, A5, A6>::connect(JSlot& slot)
{
if (!collectSlotJavaScript_)
throwWtException("JSignal::connect(JSlot) only makes sense for a JSignal "
"which collects JavaScript from slots");
EventSignalBase::connect(slot);
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
boost::signals::connection JSignal<A1, A2, A3, A4, A5, A6>
::connect(WObject *target, void (WObject::*method)())
{
exposeSignal();
WStatelessSlot *s = target->isStateless(method);
if (collectSlotJavaScript_ && s)
return EventSignalBase::connectStateless(method, target, s);
else
return connect(boost::bind(method, target));
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
void JSignal<A1, A2, A3, A4, A5, A6>::emit(A1 a1, A2 a2, A3 a3,
A4 a4, A5 a5, A6 a6)
{
if (impl_) {
pushSender(sender());
(*impl_)(a1, a2, a3, a4, a5, a6);
popSender();
}
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
void JSignal<A1, A2, A3, A4, A5, A6>::operator()(A1 a1, A2 a2, A3 a3,
A4 a4, A5 a5, A6 a6)
{
emit(a1, a2, a3, a4, a5, a6);
}
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
bool JSignal<A1, A2, A3, A4, A5, A6>::isConnected() const
{
return impl_ ? impl_->num_slots() > 0 : EventSignalBase::isConnected();
}
template <typename T>
struct SignalArgTraits
{
static T unMarshal(const JavaScriptEvent& jse, int argi) {
if ((unsigned)argi >= jse.userEventArgs.size())
throwWtException("Missing JavaScript argument: "
+ boost::lexical_cast<std::string>(argi));
try {
std::string v = jse.userEventArgs[argi];
WString::checkUTF8Encoding(v);
return boost::lexical_cast<T>(v);
} catch (boost::bad_lexical_cast) {
throwWtException("Bad argument format: '"
+ jse.userEventArgs[argi] + "' for C++ type '"
+ typeid(T).name() + "'");
return T();
}
}
};
template<>
struct SignalArgTraits<WString>
{
static WString unMarshal(const JavaScriptEvent& jse, int argi) {
if ((unsigned)argi >= jse.userEventArgs.size())
throwWtException("Missing JavaScript argument: "
+ boost::lexical_cast<std::string>(argi));
std::string v = jse.userEventArgs[argi];
return WString::fromUTF8(v);
}
};
template<>
struct SignalArgTraits<NoClass>
{
static NoClass unMarshal(const JavaScriptEvent& jse, int argi) {
if ((unsigned)argi < jse.userEventArgs.size())
throwWtException("Redundant JavaScript argument: '"
+ jse.userEventArgs[argi] + "'");
return NoClass::none;
}
};
template<>
struct SignalArgTraits<WMouseEvent>
{
static WMouseEvent unMarshal(const JavaScriptEvent& jse, int) {
return WMouseEvent(jse);
}
};
template<>
struct SignalArgTraits<WKeyEvent>
{
static WKeyEvent unMarshal(const JavaScriptEvent& jse, int) {
return WKeyEvent(jse);
}
};
template <typename A1, typename A2, typename A3,
typename A4, typename A5, typename A6>
void JSignal<A1, A2, A3, A4, A5, A6>::processDynamic(const JavaScriptEvent& jse)
{
emit(SignalArgTraits<A1>::unMarshal(jse, 0),
SignalArgTraits<A2>::unMarshal(jse, 1),
SignalArgTraits<A3>::unMarshal(jse, 2),
SignalArgTraits<A4>::unMarshal(jse, 3),
SignalArgTraits<A5>::unMarshal(jse, 4),
SignalArgTraits<A6>::unMarshal(jse, 5));
}
#endif // WT_CNOR
}
#endif // WUSER_SIGNAL_H_
|