GNOME.org
 

[glibmm] Glib::SignalProxy: use variadic templates

commit f6e46c68fd2b7289964e6e0d446b11658187b68d
Author: Marcin Kolny <marcin kolny gmail com>
Date:   Fri Sep 25 13:10:09 2015 +0000

    Glib::SignalProxy: use variadic templates
    
        * .gitignore: signalproxy.h file is no more generated, so it has been
          removed from ignored list.
        * gio/src/application.{ccg|hg}: don't use old-style SignalProxy class.
        * glib/glibmm/filelist.am: add signalproxy.h file to distributed files
          list.
        * gio/glibmm/signalproxy.h: add implementation of SignalProxy and
          SignalProxyDetailedAnyType.
        * glib/src/filelist.am:
        * glib/src/signalproxy.h.m4: signalproxy.h is not generated, thus
          remove m4 file.
        * tools/m4/signal.m4: use new SignalProxy class instead of
          SignalProxy*.

 .gitignore                                         |    1 -
 gio/src/application.ccg                            |    4 +-
 gio/src/application.hg                             |    2 +-
 glib/glibmm/filelist.am                            |    1 +
 .../{src/signalproxy.h.m4 => glibmm/signalproxy.h} |  193 +++++++++++++-------
 glib/src/filelist.am                               |    2 +-
 tools/m4/signal.m4                                 |   24 ++--
 7 files changed, 141 insertions(+), 86 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index b4604f3..6eb41c0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -135,7 +135,6 @@ giommconfig.h
 /glib/glibmm/regex.h
 /glib/glibmm/shell.cc
 /glib/glibmm/shell.h
-/glib/glibmm/signalproxy.h
 /glib/glibmm/spawn.cc
 /glib/glibmm/spawn.h
 /glib/glibmm/thread.cc
diff --git a/gio/src/application.ccg b/gio/src/application.ccg
index 5331887..4c98dd5 100644
--- a/gio/src/application.ccg
+++ b/gio/src/application.ccg
@@ -347,9 +347,9 @@ void Application_Class::open_callback(GApplication* self, GFile** files,
     (*base->open)(self, files, n_files, hint);
 }
 
-Glib::SignalProxy2< void, const Application::type_vec_files&, const Glib::ustring& > 
Application::signal_open()
+Glib::SignalProxy< void, const Application::type_vec_files&, const Glib::ustring& > 
Application::signal_open()
 {
-  return Glib::SignalProxy2< void, const Application::type_vec_files&, const Glib::ustring& >(this, 
&Application_signal_open_info);
+  return Glib::SignalProxy< void, const Application::type_vec_files&, const Glib::ustring& >(this, 
&Application_signal_open_info);
 }
 
 void Gio::Application::on_open(const Application::type_vec_files& files, const Glib::ustring& hint)
diff --git a/gio/src/application.hg b/gio/src/application.hg
index d87efc3..a72ba68 100644
--- a/gio/src/application.hg
+++ b/gio/src/application.hg
@@ -380,7 +380,7 @@ public:
 
   //We wrap the open signal without _WRAP_SIGNAL(), because we need to change its parameters.
   //See bug https://bugzilla.gnome.org/show_bug.cgi?id=637457
-  Glib::SignalProxy2< void,  const type_vec_files&, const Glib::ustring& > signal_open();
+  Glib::SignalProxy< void,  const type_vec_files&, const Glib::ustring& > signal_open();
   _IGNORE_SIGNAL(open)
 
 #m4 _CONVERSION(`GApplicationCommandLine*', `const Glib::RefPtr<ApplicationCommandLine>&',`Glib::wrap($3, 
true)')
diff --git a/glib/glibmm/filelist.am b/glib/glibmm/filelist.am
index 352a132..dc6615f 100644
--- a/glib/glibmm/filelist.am
+++ b/glib/glibmm/filelist.am
@@ -69,6 +69,7 @@ glibmm_files_extra_h =                        \
        random.h                        \
        refptr.h                        \
        sarray.h                        \
+       signalproxy.h                   \
        signalproxy_connectionnode.h    \
        slisthandle.h                   \
        streamiochannel.h               \
diff --git a/glib/src/signalproxy.h.m4 b/glib/glibmm/signalproxy.h
similarity index 54%
rename from glib/src/signalproxy.h.m4
rename to glib/glibmm/signalproxy.h
index 8752624..a4d4fee 100644
--- a/glib/src/signalproxy.h.m4
+++ b/glib/glibmm/signalproxy.h
@@ -1,26 +1,24 @@
-dnl Glib SignalProxy Templates
-dnl 
-dnl  Copyright 2001 Free Software Foundation
-dnl  Copyright 1999 Karl Nelson <kenelson ece ucdavis edu>
-dnl 
-dnl  This library is free software; you can redistribute it and/or
-dnl  modify it under the terms of the GNU Lesser General Public
-dnl  License as published by the Free Software Foundation; either
-dnl  version 2.1 of the License, or (at your option) any later version.
-dnl 
-dnl  This library is distributed in the hope that it will be useful,
-dnl  but WITHOUT ANY WARRANTY; without even the implied warranty of
-dnl  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-dnl  Lesser General Public License for more details.
-dnl 
-dnl  You should have received a copy of the GNU Lesser General Public
-dnl  License along with this library; if not, write to the Free
-dnl  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-dnl 
-/* This is a generated file, do not edit.  Generated from __file__ */
-include(template.macros.m4)
-#ifndef __header__
-#define __header__
+#ifndef _GLIBMM_SIGNALPROXY_H
+#define _GLIBMM_SIGNALPROXY_H
+
+/* signalproxy.h
+ *
+ * Copyright (C) 2015 The gtkmm Development Team
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free
+ * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
 
 extern "C"
 {
@@ -60,7 +58,7 @@ public:
   {
     const auto pConnectionNode = static_cast<SignalProxyConnectionNode*>(data);
 
-    // Return nullptr if the connection is blocked.
+    // Return null pointer if the connection is blocked.
     return (!pConnectionNode->slot_.blocked()) ? &pConnectionNode->slot_ : nullptr;
   }
 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
@@ -93,7 +91,7 @@ public:
   void emission_stop();
 
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
-  // This callback for SignalProxy0<void>
+  // This callback for SignalProxy<void>
   // is defined here to avoid code duplication.
   static void slot0_void_callback(GObject*, void* data);
 #endif
@@ -135,6 +133,77 @@ private:
   SignalProxyNormal& operator=(const SignalProxyNormal&);
 };
 
+/**** Glib::SignalProxy ***************************************************/
+
+/** Proxy for signals with any number of arguments.
+ * Use the connect() or connect_notify() method, with sigc::mem_fun() or sigc::ptr_fun()
+ * to connect signal handlers to signals.
+ */
+template <class R, class ...T>
+class SignalProxy : public SignalProxyNormal
+{
+public:
+  typedef sigc::slot<R, T...>    SlotType;
+  typedef sigc::slot<void, T...> VoidSlotType;
+
+  SignalProxy(ObjectBase* obj, const SignalProxyInfo* info)
+    : SignalProxyNormal(obj, info) {}
+
+  /** Connects a signal handler to a signal.
+   *
+   * For instance, connect( sigc::mem_fun(*this, &TheClass::on_something) );
+   *
+   * @param slot The signal handler, usually created with sigc::mem_fun() or sigc::ptr_fun().
+   * @param after Whether this signal handler should be called before or after the default signal handler.
+   */
+  sigc::connection connect(const SlotType& slot, bool after = true)
+    { return sigc::connection(connect_(slot, after)); }
+
+  /** Connects a signal handler without a return value to a signal.
+   * By default, the signal handler will be called before the default signal handler.
+   *
+   * For instance, connect_notify( sigc::mem_fun(*this, &TheClass::on_something) );
+   *
+   * If the signal requires signal handlers with a @c void return type,
+   * the only difference between connect() and connect_notify() is the default
+   * value of @a after.
+   *
+   * If the signal requires signal handlers with a return value of type T,
+   * connect_notify() binds <tt>return T()</tt> to the connected signal handler.
+   * For instance, if the return type is @c bool, the following two calls are equivalent.
+   * @code
+   * connect_notify( sigc::mem_fun(*this, &TheClass::on_something) );
+   * connect( sigc::bind_return<bool>(sigc::mem_fun(*this, &TheClass::on_something), false), false );
+   * @endcode
+   *
+   * @param slot The signal handler, which should have a @c void return type,
+   *        usually created with sigc::mem_fun() or sigc::ptr_fun().
+   * @param after Whether this signal handler should be called before or after the default signal handler.
+   */
+  sigc::connection connect_notify(const VoidSlotType& slot, bool after = false)
+    { return sigc::connection(connect_notify_(slot, after)); }
+};
+
+/* Templates below has been added to avoid API break, and should not be
+ * used in a newly created code. SignalProxy class should be used instead
+ * of SignalProxy# class.
+ */
+template <typename R>
+using SignalProxy0 = SignalProxy<R>;
+template <typename R, typename T1>
+using SignalProxy1 = SignalProxy<R, T1>;
+template <typename R, typename T1, typename T2>
+using SignalProxy2 = SignalProxy<R, T1, T2>;
+template <typename R, typename T1, typename T2, typename T3>
+using SignalProxy3 = SignalProxy<R, T1, T2, T3>;
+template <typename R, typename T1, typename T2, typename T3, typename T4>
+using SignalProxy4 = SignalProxy<R, T1, T2, T3, T4>;
+template <typename R, typename T1, typename T2, typename T3, typename T4, typename T5>
+using SignalProxy5 = SignalProxy<R, T1, T2, T3, T4, T5>;
+template <typename R, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
+using SignalProxy6 = SignalProxy<R, T1, T2, T3, T4, T5, T6>;
+
+ 
 // Shared portion of a Signal with detail
 /** The SignalProxy provides an API similar to sigc::signal that can be used to
  * connect sigc::slots to glib signals.
@@ -173,39 +242,25 @@ protected:
 
 private:
   const SignalProxyInfo* info_; // Pointer to statically allocated structure.
-  const Glib::ustring detailed_name_; // signal_name[[::detail_name]]dnl one pair of [] in the generated .h 
file
-
+  const Glib::ustring detailed_name_; // signal_name[::detail_name]
 
   // no copy assignment
   SignalProxyDetailed& operator=(const SignalProxyDetailed&);
 };
 
-dnl
-dnl GLIB_SIGNAL_PROXY([P1, P2, ...], Normal or Detailed)
-dnl
-define([GLIB_SIGNAL_PROXY],[dnl
-LINE(]__line__[)dnl
-
-/**** Glib::[SignalProxy]ifelse($2,Normal,,$2)[]NUM($1) ***************************************************/
-
-/** Proxy for signals with NUM($1) arguments[]ifelse($2,Normal,,[ and possibly a detailed name]).
+/** Proxy for signals with any number of arguments and possibly a detailed name.
  * Use the connect() or connect_notify() method, with sigc::mem_fun() or sigc::ptr_fun()
  * to connect signal handlers to signals.
  */
-template <LIST(class R,ARG_CLASS($1))>
-class [SignalProxy]ifelse($2,Normal,,$2)[]NUM($1) : public SignalProxy$2
+template <class R,class ...T>
+class SignalProxyDetailedAnyType : public SignalProxyDetailed
 {
 public:
-  typedef sigc::slot<LIST(R,ARG_TYPE($1))>    SlotType;
-  typedef sigc::slot<LIST(void,ARG_TYPE($1))> VoidSlotType;
+  typedef sigc::slot<R,T...>    SlotType;
+  typedef sigc::slot<void,T...> VoidSlotType;
 
-ifelse($2,Normal,dnl
-  [SignalProxy]NUM($1)[(ObjectBase* obj, const SignalProxyInfo* info)
-    : SignalProxyNormal(obj, info) {}
-],dnl Detailed
-  [SignalProxyDetailed]NUM($1)[(ObjectBase* obj, const SignalProxyInfo* info, const Glib::ustring& 
detail_name)
+  SignalProxyDetailedAnyType(ObjectBase* obj, const SignalProxyInfo* info, const Glib::ustring& detail_name)
     : SignalProxyDetailed(obj, info, detail_name) {}
-])dnl
 
   /** Connects a signal handler to a signal.
    *
@@ -215,7 +270,7 @@ ifelse($2,Normal,dnl
    * @param after Whether this signal handler should be called before or after the default signal handler.
    */
   sigc::connection connect(const SlotType& slot, bool after = true)
-    { return sigc::connection(ifelse($2,Normal,[connect_(slot, after)],[connect_impl_(false, slot, 
after)])); }
+    { return sigc::connection(connect_impl_(false, slot, after)); }
 
   /** Connects a signal handler without a return value to a signal.
    * By default, the signal handler will be called before the default signal handler.
@@ -239,29 +294,29 @@ ifelse($2,Normal,dnl
    * @param after Whether this signal handler should be called before or after the default signal handler.
    */
   sigc::connection connect_notify(const VoidSlotType& slot, bool after = false)
-    { return sigc::connection(ifelse($2,Normal,[connect_notify_(slot, after)],[connect_impl_(true, slot, 
after)])); }
+    { return sigc::connection(connect_impl_(true, slot, after)); }
 };
-])dnl
-dnl
-dnl Template forms of SignalProxy
-dnl
-GLIB_SIGNAL_PROXY(ARGS(P,0), Normal)
-GLIB_SIGNAL_PROXY(ARGS(P,1), Normal)
-GLIB_SIGNAL_PROXY(ARGS(P,2), Normal)
-GLIB_SIGNAL_PROXY(ARGS(P,3), Normal)
-GLIB_SIGNAL_PROXY(ARGS(P,4), Normal)
-GLIB_SIGNAL_PROXY(ARGS(P,5), Normal)
-GLIB_SIGNAL_PROXY(ARGS(P,6), Normal)
-dnl
-GLIB_SIGNAL_PROXY(ARGS(P,0), Detailed)
-GLIB_SIGNAL_PROXY(ARGS(P,1), Detailed)
-GLIB_SIGNAL_PROXY(ARGS(P,2), Detailed)
-GLIB_SIGNAL_PROXY(ARGS(P,3), Detailed)
-GLIB_SIGNAL_PROXY(ARGS(P,4), Detailed)
-GLIB_SIGNAL_PROXY(ARGS(P,5), Detailed)
-GLIB_SIGNAL_PROXY(ARGS(P,6), Detailed)
-dnl
+
+/* Templates below has been added to avoid API break, and should not be
+ * used in a newly created code. SignalProxyDetailedAnyType class should be
+ * used instead of SignalProxyDetailed# class.
+ */
+template <typename R>
+using SignalProxyDetailed0 = SignalProxyDetailedAnyType<R>;
+template <typename R, typename T1>
+using SignalProxyDetailed1 = SignalProxyDetailedAnyType<R, T1>;
+template <typename R, typename T1, typename T2>
+using SignalProxyDetailed2 = SignalProxyDetailedAnyType<R, T1, T2>;
+template <typename R, typename T1, typename T2, typename T3>
+using SignalProxyDetailed3 = SignalProxyDetailedAnyType<R, T1, T2, T3>;
+template <typename R, typename T1, typename T2, typename T3, typename T4>
+using SignalProxyDetailed4 = SignalProxyDetailedAnyType<R, T1, T2, T3, T4>;
+template <typename R, typename T1, typename T2, typename T3, typename T4, typename T5>
+using SignalProxyDetailed5 = SignalProxyDetailedAnyType<R, T1, T2, T3, T4, T5>;
+template <typename R, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
+using SignalProxyDetailed6 = SignalProxyDetailedAnyType<R, T1, T2, T3, T4, T5, T6>;
+ 
 } // namespace Glib
 
-#endif /* __header__ */
+#endif /* _GLIBMM_SIGNALPROXY_H */
 
diff --git a/glib/src/filelist.am b/glib/src/filelist.am
index a35ffdc..f76c8bd 100644
--- a/glib/src/filelist.am
+++ b/glib/src/filelist.am
@@ -57,5 +57,5 @@ glibmm_files_hg = $(glibmm_files_any_hg)
 glibmm_files_ccg = $(glibmm_files_hg:.hg=.ccg)
 
 glibmm_files_cc_m4 = value_basictypes.cc.m4 variant_basictypes.cc.m4
-glibmm_files_h_m4  = signalproxy.h.m4 value_basictypes.h.m4 \
+glibmm_files_h_m4  = value_basictypes.h.m4 \
        variant_basictypes.h.m4
diff --git a/tools/m4/signal.m4 b/tools/m4/signal.m4
index d85f93c..f62e316 100644
--- a/tools/m4/signal.m4
+++ b/tools/m4/signal.m4
@@ -24,17 +24,17 @@ ifelse(`$9',,,`_DEPRECATE_IFDEF_START
 ')dnl
 ifelse($13,,`dnl no detail_name
 $10
-  Glib::SignalProxy`'_NUM($6)< $5`'_COMMA_PREFIX($6) > signal_$4`'();
+  Glib::SignalProxy< $5`'_COMMA_PREFIX($6) > signal_$4`'();
 ',dnl detail_name
 $14,0,`dnl
 $10
-  Glib::SignalProxyDetailed`'_NUM($6)< $5`'_COMMA_PREFIX($6) > signal_$4`'(const Glib::ustring& $13 = 
Glib::ustring());
+  Glib::SignalProxyDetailedAnyType< $5`'_COMMA_PREFIX($6) > signal_$4`'(const Glib::ustring& $13 = 
Glib::ustring());
 ',`dnl detail_name and two_signal_methods
 $10
-  Glib::SignalProxy`'_NUM($6)< $5`'_COMMA_PREFIX($6) > signal_$4`'();
+  Glib::SignalProxy< $5`'_COMMA_PREFIX($6) > signal_$4`'();
 
 $10
-  Glib::SignalProxyDetailed`'_NUM($6)< $5`'_COMMA_PREFIX($6) > signal_$4`'(const Glib::ustring& $13);
+  Glib::SignalProxyDetailedAnyType< $5`'_COMMA_PREFIX($6) > signal_$4`'(const Glib::ustring& $13);
 ')dnl end detail_name
 ifelse(`$9',,,`_DEPRECATE_IFDEF_END
 ')dnl
@@ -161,25 +161,25 @@ ifelse(`$11',,,`#ifdef $11'
 ifelse(`$9',,,`_DEPRECATE_IFDEF_START
 ')dnl
 ifelse($13,,`dnl no detail_name
-Glib::SignalProxy`'_NUM($6)< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'()
+Glib::SignalProxy< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'()
 {
-  return Glib::SignalProxy`'_NUM($6)< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info);
+  return Glib::SignalProxy< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info);
 }
 ',dnl detail_name
 $14,0,`dnl
-Glib::SignalProxyDetailed`'_NUM($6)< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'(const Glib::ustring& 
$13)
+Glib::SignalProxyDetailedAnyType< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'(const Glib::ustring& $13)
 {
-  return Glib::SignalProxyDetailed`'_NUM($6)< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info, 
$13);
+  return Glib::SignalProxyDetailedAnyType< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info, $13);
 }
 ',`dnl detail_name and two_signal_methods
-Glib::SignalProxy`'_NUM($6)< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'()
+Glib::SignalProxy< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'()
 {
-  return Glib::SignalProxy`'_NUM($6)< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info);
+  return Glib::SignalProxy< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info);
 }
 
-Glib::SignalProxyDetailed`'_NUM($6)< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'(const Glib::ustring& 
$13)
+Glib::SignalProxyDetailedAnyType< $5`'_COMMA_PREFIX($6) > __CPPNAME__::signal_$4`'(const Glib::ustring& $13)
 {
-  return Glib::SignalProxyDetailed`'_NUM($6)< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info, 
$13);
+  return Glib::SignalProxyDetailedAnyType< $5`'_COMMA_PREFIX($6) >(this, &__CPPNAME__`'_signal_$4_info, $13);
 }
 ')dnl end detail_name
 ifelse(`$9',,,`_DEPRECATE_IFDEF_END
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]