From 08c1e93fa36a49f49325a07fe91ff92c964c2b6c Mon Sep 17 00:00:00 2001 From: Chanho Park Date: Thu, 11 Dec 2014 18:55:56 +0900 Subject: Imported Upstream version 1.57.0 --- doc/html/signals/reference.html | 10 +- doc/html/signals/s04.html | 47 +++++++--- doc/html/signals/s05.html | 28 +++--- doc/html/signals/s06.html | 76 ++++++++-------- doc/html/signals/tests.html | 10 +- doc/html/signals/tutorial.html | 196 ++++++++++++++++++++-------------------- 6 files changed, 192 insertions(+), 175 deletions(-) (limited to 'doc/html/signals') diff --git a/doc/html/signals/reference.html b/doc/html/signals/reference.html index d3039e9f95..6e6776b67f 100644 --- a/doc/html/signals/reference.html +++ b/doc/html/signals/reference.html @@ -3,9 +3,9 @@ Reference - + - + @@ -25,7 +25,7 @@

Reference

-
+
Header <boost/signal.hpp>
Header <boost/signals/slot.hpp>
Header <boost/signals/trackable.hpp>
@@ -74,7 +74,7 @@ 
namespace boost {
   namespace signals {
     class connection;
-    void swap(connection&, connection&);
+    void swap(connection&, connection&);
     class scoped_connection;
   }
 }
@@ -93,7 +93,7 @@ 
namespace boost {
   template<typename T> class last_value;
 
-  template<> class last_value<void>;
+  template<> class last_value<void>;
 }
diff --git a/doc/html/signals/s04.html b/doc/html/signals/s04.html index 3ae3d02730..e0e825137a 100644 --- a/doc/html/signals/s04.html +++ b/doc/html/signals/s04.html @@ -3,10 +3,10 @@ Frequently Asked Questions - + - - + + @@ -20,28 +20,45 @@
-PrevUpHomeNext +PrevUpHomeNext

-Frequently Asked Questions

+Frequently Asked Questions
-
-
1. Don't noncopyable signal semantics mean that a class +
+
1. Is Boost.Signals being actively maintained? +
+
2. Don't noncopyable signal semantics mean that a class with a signal member will be noncopyable as well?
-
2. Is Boost.Signals thread-safe? +
3. Is Boost.Signals thread-safe?
-
3. How do I get Boost.Signals to work with Qt? +
4. How do I get Boost.Signals to work with Qt?
- +
++ + + + + + + + + @@ -56,7 +73,7 @@ @@ -69,7 +86,7 @@ @@ -160,7 +177,7 @@ namespace boost
-

1.

+

1.

+

Is Boost.Signals being actively maintained?

No. Please migrate to Boost.Signals2. + There is a + porting guide + in the Signals2 documentation.

+

2.

Don't noncopyable signal semantics mean that a class with a signal member will be noncopyable as well?

-

2.

+

3.

Is Boost.Signals thread-safe?
-

3.

+

4.

How do I get Boost.Signals to work with Qt?
- +

Last revised: May 21, 2008 at 21:57:05 +0100
Copyright © 2001-2004 Douglas Gregor

Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

@@ -168,7 +185,7 @@ namespace boost
-PrevUpHomeNext +PrevUpHomeNext
diff --git a/doc/html/signals/s05.html b/doc/html/signals/s05.html index 096deec7d5..79adeea5ee 100644 --- a/doc/html/signals/s05.html +++ b/doc/html/signals/s05.html @@ -3,9 +3,9 @@ Design Overview - + - + @@ -24,16 +24,16 @@

-Design Overview

-
-
Type Erasure
-
connection class
-
Slot Call Iterator
-
visit_each function template
+Design Overview
+
+
Type Erasure
+
connection class
+
Slot Call Iterator
+
visit_each function template

-Type Erasure

+Type Erasure

"Type erasure", where static type information is eliminated by the use of dynamically dispatched interfaces, is used extensively within the Boost.Signals library to reduce the amount @@ -59,7 +59,7 @@

-connection class

+connection class

The connection class is central to the behavior of the Boost.Signals library. It is the only entity within the Boost.Signals system that has knowledge of @@ -84,7 +84,7 @@

-Slot Call Iterator

+Slot Call Iterator

The slot call iterator is conceptually a stack of iterator adaptors that modify the behavior of the underlying iterator through the list of slots. The following table describes the type @@ -130,7 +130,7 @@

Transform Iterator Adaptor

This transform iterator adaptor performs an - any_cast to + any_cast to extract a reference to the slot function with the appropriate slot function type.

@@ -160,7 +160,7 @@

-visit_each function template

+visit_each function template

The visit_each function template is a mechanism for discovering objects that are stored within another object. Function template @@ -198,7 +198,7 @@ foo(at, 0); - +

Last revised: November 25, 2007 at 18:38:02 +0000
Copyright © 2001-2004 Douglas Gregor

Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

diff --git a/doc/html/signals/s06.html b/doc/html/signals/s06.html index 0075c3a78e..b157aeccbb 100644 --- a/doc/html/signals/s06.html +++ b/doc/html/signals/s06.html @@ -3,9 +3,9 @@ Design Rationale - + - + @@ -24,18 +24,18 @@

-Design Rationale

-
-
Choice of Slot Definitions
-
User-level Connection Management
-
Combiner Interface
-
Connection Interfaces: += operator
-
trackable rationale
-
Comparison with other Signal/Slot implementations
+Design Rationale
+
+
Choice of Slot Definitions
+
User-level Connection Management
+
Combiner Interface
+
Connection Interfaces: += operator
+
trackable rationale
+
Comparison with other Signal/Slot implementations

-Choice of Slot Definitions

+Choice of Slot Definitions

The definition of a slot differs amongst signals and slots libraries. Within Boost.Signals, a slot is defined in a very loose manner: it can be any function object that is callable given @@ -44,7 +44,7 @@ signal. However, alternative definitions have associated pros and cons that were considered prior to the construction of Boost.Signals.

-
    +

    • Slots derive from a specific base class: generally a scheme such as this will require @@ -85,7 +85,7 @@

    -User-level Connection Management

    +User-level Connection Management

Users need to have fine control over the connection of signals to slots and their eventual disconnection. The approach taken by Boost.Signals is to return a @@ -93,13 +93,13 @@ connected/disconnected query, manual disconnection, and an automatic disconnection on destruction mode. Some other possible interfaces include:

-
    +

    • Pass slot to disconnect: in this interface model, the disconnection of a slot connected with - sig.connect(slot) is + sig.connect(slot) is performed via - sig.disconnect(slot). Internally, + sig.disconnect(slot). Internally, a linear search using slot comparison is performed and the slot, if found, is removed from the list. Unfortunately, querying connectedness will generally also end up as @@ -108,7 +108,7 @@ simple function pointers, member function pointers and a limited set of compositions and argument binders: to match the slot given in the call to - disconnect with an + disconnect with an existing slot we would need to be able to compare arbitrary function objects, which is not feasible.

    • @@ -118,7 +118,7 @@ slots to be arbitrary function objects. While this approach is essentially equivalent to the approach taken by Boost.Signals, it is possibly more error-prone for several reasons:

      -
        +

        • Connections and disconnections must be paired, so the problem becomes similar to the problems incurred when pairing new and delete for @@ -147,7 +147,7 @@

        -Combiner Interface

        +Combiner Interface

    The Combiner interface was chosen to mimic a call to an algorithm in the C++ standard library. It is felt that by viewing slot call results as merely a sequence of values accessed by input @@ -275,14 +275,14 @@ private:

-Connection Interfaces: += operator

+Connection Interfaces: += operator

Boost.Signals supports a connection syntax with the form - sig.connect(slot), but a + sig.connect(slot), but a more terse syntax sig += slot has been suggested (and has been used by other signals & slots implementations). There are several reasons as to why this syntax has been rejected:

-
+
+
trackable copying behavior
+
Why derivation from trackable?

The trackable class is the primary user interface to automatic connection @@ -329,7 +329,7 @@ private: participate in automatic connection management.

-trackable copying behavior

+trackable copying behavior

The copying behavior of trackable is essentially that trackable subobjects @@ -347,10 +347,10 @@ private:

-Why derivation from trackable?

+Why derivation from trackable?

For trackable to work properly, there are two constraints:

-
    +

    • trackable must have storage space to keep track of all connections made to this object.

      • @@ -365,14 +365,14 @@ private:

    -Comparison with other Signal/Slot implementations

    -
    -
    libsigc++
    -
    .NET delegates
    +Comparison with other Signal/Slot implementations
+
+
libsigc++
+
.NET delegates

-libsigc++

+libsigc++

libsigc++ is a C++ signals & slots library that originally started as part of an initiative to wrap the C interfaces to GTK libraries in C++, and has @@ -384,7 +384,7 @@ private: connections and automatic connection lifetime management. There are some major differences in design that separate these libraries:

-
    +

    • Slot definitions: slots in libsigc++ are created using a set of primitives defined by the library. These primitives allow binding of @@ -404,14 +404,14 @@ private:

    -.NET delegates

    +.NET delegates

Microsoft has introduced the .NET Framework and an associated set of languages and language extensions, one of which is the delegate. Delegates are similar to signals and slots, but they are more limited than most C++ signals and slots implementations in that they:

-
    +

    • Require exact type matches between a delegate and what it is calling.

    • Only return the result of the last target called, with no option for customization.

      • @@ -422,7 +422,7 @@ private:
- +

Last revised: November 25, 2007 at 18:38:02 +0000
Copyright © 2001-2004 Douglas Gregor

Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

diff --git a/doc/html/signals/tests.html b/doc/html/signals/tests.html index ee67a71fa9..832538d4dd 100644 --- a/doc/html/signals/tests.html +++ b/doc/html/signals/tests.html @@ -3,11 +3,11 @@ Testsuite - + - + - + @@ -25,10 +25,10 @@

Testsuite

-
Acceptance tests
+
Acceptance tests

-Acceptance tests

+Acceptance tests
diff --git a/doc/html/signals/tutorial.html b/doc/html/signals/tutorial.html index 7648eeabf1..bb9536e2a1 100644 --- a/doc/html/signals/tutorial.html +++ b/doc/html/signals/tutorial.html @@ -3,10 +3,10 @@ Tutorial - + - - + + @@ -25,19 +25,19 @@

Tutorial

-
-
How to Read this Tutorial
-
Compatibility Note
-
Hello, World! (Beginner)
-
Calling multiple slots
-
Passing values to and from slots
-
Connection Management
-
Example: Document-View
-
Linking against the Signals library
+
+
How to Read this Tutorial
+
Compatibility Note
+
Hello, World! (Beginner)
+
Calling multiple slots
+
Passing values to and from slots
+
Connection Management
+
Example: Document-View
+
Linking against the Signals library

-How to Read this Tutorial

+How to Read this Tutorial

This tutorial is not meant to be read linearly. Its top-level structure roughly separates different concepts in the library (e.g., handling calling multiple slots, passing values to and from @@ -57,7 +57,7 @@ will not need to read the Advanced sectio

-Compatibility Note

+Compatibility Note

Boost.Signals has two syntactical forms: the preferred form and the compatibility form. The preferred form fits more closely with the C++ language and reduces the number of separate template parameters @@ -82,7 +82,7 @@ we can keep this table up-to-date.

@@ -302,7 +302,7 @@ group parameter and those that don't? The "unnamed" slots (i.e., those that have been connected without specifying a group name) can be placed at the front or back of the slot list (by passing boost::signals::at_front or boost::signals::at_back -as the last parameter to connect, respectively), and defaults to the end of the list. When +as the last parameter to connect, respectively), and defaults to the end of the list. When a group is specified, the final parameter describes where the slot will be placed within the group ordering. If we add a new slot to our example like this:

@@ -315,7 +315,7 @@ struct GoodMorning } }; -sig.connect(GoodMorning()); +sig.connect(GoodMorning());

... we will get the result we wanted:

@@ -326,14 +326,14 @@ Hello, World!
 
 

 

-Passing values to and from slots

-

-
Slot Arguments (Beginner)

-
Signal Return Values (Advanced)

+Passing values to and from slots

+

+
Slot Arguments (Beginner)

+
Signal Return Values (Advanced)

 

 

 

-Slot Arguments (Beginner)

+Slot Arguments (Beginner)

 
Signals can propagate arguments to each of the slots they call.
 For instance, a signal that propagates mouse motion events might
 want to pass along the new mouse coordinates and whether the mouse
@@ -377,10 +377,10 @@ void print_quotient(float x, float y)
 
 boost::signal<void (float, float)> sig;
 
-sig.connect(&print_sum);
-sig.connect(&print_product);
-sig.connect(&print_difference);
-sig.connect(&print_quotient);
+sig.connect(&print_sum);
+sig.connect(&print_product);
+sig.connect(&print_difference);
+sig.connect(&print_quotient);
 
 sig(5, 3);
 

@@ -389,10 +389,10 @@ sig(5, 3);
 
 boost::signal2<void, float, float> sig;
 
-sig.connect(&print_sum);
-sig.connect(&print_product);
-sig.connect(&print_difference);
-sig.connect(&print_quotient);
+sig.connect(&print_sum);
+sig.connect(&print_product);
+sig.connect(&print_difference);
+sig.connect(&print_quotient);
 
 sig(5, 3);
 

@@ -417,7 +417,7 @@ connected to sig must therefore be able to t
 
 

 

-Signal Return Values (Advanced)

+Signal Return Values (Advanced)

 
Just as slots can receive arguments, they can also return
 values. These values can then be returned back to the caller of the
 signal through a combiner. The combiner is a mechanism
@@ -451,10 +451,10 @@ float difference(float x, float y) { return x-y; }
 
 boost::signal<float (float x, float y)> sig;
 
-sig.connect(&product);
-sig.connect(&quotient);
-sig.connect(&sum);
-sig.connect(&difference);
+sig.connect(&product);
+sig.connect(&quotient);
+sig.connect(&sum);
+sig.connect(&difference);
 
 std::cout << sig(5, 3) << std::endl;
@@ -468,10 +468,10 @@ float difference(float x, float y) { return x-y; } boost::signal2<float, float, float> sig; -sig.connect(&product); -sig.connect(&quotient); -sig.connect(&sum); -sig.connect(&difference); +sig.connect(&product); +sig.connect(&quotient); +sig.connect(&sum); +sig.connect(&difference); std::cout << sig(5, 3) << std::endl; @@ -553,10 +553,10 @@ follows the signal's calling signature:

Now we can connect slots that perform arithmetic functions and use the signal:

-sig.connect(&quotient);
-sig.connect(&product);
-sig.connect(&sum);
-sig.connect(&difference);
+sig.connect(&quotient);
+sig.connect(&product);
+sig.connect(&sum);
+sig.connect(&difference);
 
 std::cout << sig(5, 3) << std::endl;
@@ -598,10 +598,10 @@ Again, we can create a signal with this new combiner: boost::signal<float (float, float), aggregate_values<std::vector<float> > > sig; -sig.connect(&quotient); -sig.connect(&product); -sig.connect(&sum); -sig.connect(&difference); +sig.connect(&quotient); +sig.connect(&product); +sig.connect(&sum); +sig.connect(&difference); std::vector<float> results = sig(5, 3); std::copy(results.begin(), results.end(), @@ -613,10 +613,10 @@ std::copy(results.begin(), results.end(), boost::signal2<float, float, float, aggregate_values<std::vector<float> > > sig; -sig.connect(&quotient); -sig.connect(&product); -sig.connect(&sum); -sig.connect(&difference); +sig.connect(&quotient); +sig.connect(&product); +sig.connect(&sum); +sig.connect(&difference); std::vector<float> results = sig(5, 3); std::copy(results.begin(), results.end(), @@ -667,19 +667,19 @@ struct DistributeRequest {

-Connection Management

-
-
Disconnecting Slots (Beginner)
-
Blocking Slots (Beginner)
-
Scoped connections (Intermediate)
-
Disconnecting equivalent slots (Intermediate)
-
Automatic connection management (Intermediate)
-
When can disconnections occur? (Intermediate)
-
Passing slots (Intermediate)
+Connection Management
+
+
Disconnecting Slots (Beginner)
+
Blocking Slots (Beginner)
+
Scoped connections (Intermediate)
+
Disconnecting equivalent slots (Intermediate)
+
Automatic connection management (Intermediate)
+
When can disconnections occur? (Intermediate)
+
Passing slots (Intermediate)

-Disconnecting Slots (Beginner)

+Disconnecting Slots (Beginner)

Slots aren't expected to exist indefinately after they are connected. Often slots are only used to receive a few events and are then disconnected, and the programmer needs control to decide @@ -688,14 +688,14 @@ when a slot should no longer be connected.

boost::signals::connection class. The connection class uniquely represents the connection between a particular signal and a particular slot. The -connected() method checks if the signal and slot are -still connected, and the disconnect() method +connected() method checks if the signal and slot are +still connected, and the disconnect() method disconnects the signal and slot if they are connected before it is called. Each call to the signal's connect() method returns a connection object, which can be used to determine if the connection still exists or to disconnect the signal and slot.

-boost::signals::connection c = sig.connect(HelloWorld());
+boost::signals::connection c = sig.connect(HelloWorld());
 if (c.connected()) {
 // c is still connected to the signal
   sig(); // Prints "Hello, World!"
@@ -709,7 +709,7 @@ sig(); // Does nothing: there are no connected slots<
 
 

 

-Blocking Slots (Beginner)

+Blocking Slots (Beginner)

 
Slots can be temporarily "blocked", meaning that they will be
 ignored when the signal is invoked but have not been disconnected. The
 block member function
@@ -717,7 +717,7 @@ temporarily blocks a slot, which can be unblocked via
 unblock. Here is an example of
 blocking/unblocking slots:

 
-boost::signals::connection c = sig.connect(HelloWorld());
+boost::signals::connection c = sig.connect(HelloWorld());
 sig(); // Prints "Hello, World!"
 
 c.block(); // block the slot
@@ -730,7 +730,7 @@ sig(); // Prints "Hello, World!"
 
 

 

-Scoped connections (Intermediate)

+Scoped connections (Intermediate)

 
The boost::signals::scoped_connection class
 references a signal/slot connection that will be disconnected when
 the scoped_connection class goes out of scope. This
@@ -738,7 +738,7 @@ ability is useful when a connection need only be temporary,
 e.g.,

 
 {
-  boost::signals::scoped_connection c = sig.connect(ShortLived());
+  boost::signals::scoped_connection c = sig.connect(ShortLived());
   sig(); // will call ShortLived function object
 }
 sig(); // ShortLived function object no longer connected to sig
@@ -746,10 +746,10 @@ sig(); // ShortLived function object no longer connec
 
 

 

-Disconnecting equivalent slots (Intermediate)

+Disconnecting equivalent slots (Intermediate)

 
One can disconnect slots that are equivalent to a given function
 object using a form of the
-disconnect method, so long as
+disconnect method, so long as
 the type of the function object has an accessible ==
 operator. For instance:
 
@@ -797,7 +797,7 @@ sig.disconnect(&foo);
 
 

 

-Automatic connection management (Intermediate)

+Automatic connection management (Intermediate)

 
Boost.Signals can automatically track the lifetime of objects
 involved in signal/slot connections, including automatic
 disconnection of slots when objects involved in the slot call are
@@ -852,7 +852,7 @@ public:
 // ...
 NewsMessageArea newsMessageArea = new NewsMessageArea(/* ... */);
 // ...
-deliverNews.connect(boost::bind(&NewsMessageArea::displayNews, 
+deliverNews.connect(boost::bind(&NewsMessageArea::displayNews, 
                                 newsMessageArea, _1));
 

 
However, what if the user closes the news message area,
@@ -885,10 +885,10 @@ this limitation.

 
 

 

-When can disconnections occur? (Intermediate)

+When can disconnections occur? (Intermediate)

 
Signal/slot disconnections occur when any of these conditions
 occur:

-
    
+
      
 
    • The connection is explicitly disconnected via the connection's
 disconnect method directly, or indirectly via the
 signal's disconnect method or
@@ -912,7 +912,7 @@ signal.
      
 
    
 
    
 
    
-Passing slots (Intermediate)
    
+Passing slots (Intermediate)

 
Slots in the Boost.Signals library are created from arbitrary
 function objects, and therefore have no fixed type. However, it is
 commonplace to require that slots be passed through interfaces that
@@ -947,7 +947,7 @@ void Button::doOnClick(
       const OnClick::slot_type& slot
     )
 {
-  onClick.connect(slot);
+  onClick.connect(slot);
 }
 
 void printCoordinates(long x, long y)
@@ -978,7 +978,7 @@ void Button::doOnClick(
       const OnClick::slot_type& slot
     )
 {
-  onClick.connect(slot);
+  onClick.connect(slot);
 }
 
 void printCoordinates(long x, long y)
@@ -1002,7 +1002,7 @@ hidden in an implementation detail file.

 
 

 

-Example: Document-View

+Example: Document-View

 
Signals can be used to implement flexible Document-View
   architectures. The document will contain a signal to which each of
   the views can connect. The following Document class
@@ -1127,7 +1127,7 @@ public:
 
 

 

-Linking against the Signals library

+Linking against the Signals library

 
Part of the Boost.Signals library is compiled into a binary
   library that must be linked into your application to use
   Signals. Please refer to
@@ -1137,7 +1137,7 @@ public:
-
    +

    • GNU C++ 2.95.x, 3.0.x, 3.1.x

    • Comeau C++ 4.2.45.2

    • SGI MIPSpro 7.3.0

      • @@ -92,7 +92,7 @@ we can keep this table up-to-date.

 -
    +

    • Any compiler supporting the preferred syntax

    • Microsoft Visual C++ 6.0, 7.0

    • Borland C++ 5.5.1

      • @@ -105,7 +105,7 @@ we can keep this table up-to-date.

    -Hello, World! (Beginner)

    +Hello, World! (Beginner)

The following example writes "Hello, World!" using signals and slots. First, we create a signal sig, a signal that takes no arguments and has a void return value. Next, we connect @@ -141,7 +141,7 @@ struct HelloWorld // Connect a HelloWorld slot HelloWorld hello; -sig.connect(hello); +sig.connect(hello); // Call all of the slots sig(); @@ -164,7 +164,7 @@ struct HelloWorld // Connect a HelloWorld slot HelloWorld hello; -sig.connect(hello); +sig.connect(hello); // Call all of the slots sig(); @@ -175,14 +175,14 @@ sig();

-Calling multiple slots

-
-
Connecting multiple slots (Beginner)
-
Ordering slot call groups (Intermediate)
+Calling multiple slots
+
+
Connecting multiple slots (Beginner)
+
Ordering slot call groups (Intermediate)

-Connecting multiple slots (Beginner)

+Connecting multiple slots (Beginner)

Calling a single slot from a signal isn't very interesting, so we can make the Hello, World program more interesting by splitting the work of printing "Hello, World!" into two completely separate @@ -227,8 +227,8 @@ signal, and when we call the signal both slots will be called.

 boost::signal<void ()> sig;
 
-sig.connect(Hello());
-sig.connect(World());
+sig.connect(Hello());
+sig.connect(World());
 
 sig();
@@ -237,8 +237,8 @@ sig(); 
 boost::signal0<void> sig;
 
-sig.connect(Hello());
-sig.connect(World());
+sig.connect(Hello());
+sig.connect(World());
 
 sig();
@@ -253,7 +253,7 @@ Hello, World!

-Ordering slot call groups (Intermediate)

+Ordering slot call groups (Intermediate)

Slots are free to have side effects, and that can mean that some slots will have to be called before others even if they are not connected in that order. The Boost.Signals library allows slots to be placed into groups that are ordered in @@ -277,16 +277,16 @@ are, by default, ints, and are ordered by th 

 boost::signal<void ()> sig;
-sig.connect(1, World());
-sig.connect(0, Hello());
+sig.connect(1, World());
+sig.connect(0, Hello());
 sig();
 
 boost::signal0<void> sig;
-sig.connect(1, World());
-sig.connect(0, Hello());
+sig.connect(1, World());
+sig.connect(0, Hello());
 sig();
- +

Last revised: January 29, 2007 at 20:05:29 +0000
Copyright © 2001-2004 Douglas Gregor

Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

-- cgit v1.2.3