Merge branch 'libsigcplusplus:master' into zig-pkg

kassane · web-flow · commit ef0a113211b6 · 2023-09-03T09:33:55.000-03:00
diff --git a/.github/workflows/autotools-clang.yml b/.github/workflows/autotools-clang.yml
@@ -1,11 +1,11 @@
-name: "CI: autotools: clang 10"
+name: "Autotools: clang"
 
 on: [push]
 
 jobs:
   build:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
@@ -14,14 +14,14 @@ jobs:
         # Prevent blocking apt install on a question during configuring of tzdata.
         export ENV DEBIAN_FRONTEND=noninteractive
         sudo apt update
-        sudo apt install mm-common clang-10 make docbook-xsl --yes
-        export CC=clang-10 CXX=clang++-10
+        sudo apt install mm-common clang make docbook-xsl --yes
+        export CC=clang CXX=clang++
         ./autogen.sh --enable-warnings=fatal
         make
     - name: Test
       run: make check
     - name: Distcheck
       run: |
         # distcheck runs configure again so we need to specify CC and CXX again.
-        export CC=clang-10 CXX=clang++-10
+        export CC=clang CXX=clang++
         make distcheck
diff --git a/.github/workflows/autotools-gcc.yml b/.github/workflows/autotools-gcc.yml
@@ -1,25 +1,27 @@
-name: "CI: autotools: gcc 10"
+name: "Autotools: gcc"
 
 on: [push]
 
 jobs:
   build:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
     - name: Build
       run: |
+        # Prevent blocking apt install on a question during configuring of tzdata.
+        export ENV DEBIAN_FRONTEND=noninteractive
         sudo apt update
-        sudo apt install mm-common g++-10 docbook-xsl
-        export CXX=g++-10
+        sudo apt install mm-common g++ make docbook-xsl --yes
+        export CXX=g++
         ./autogen.sh --enable-warnings=fatal
         make
     - name: Test
       run: make check
     - name: Distcheck
       run: |
         # distcheck runs configure again so we need to specify CXX again.
-        export CXX=g++-10
+        export CXX=g++
         make distcheck
diff --git a/.github/workflows/clang-format-check.yml b/.github/workflows/clang-format-check.yml
@@ -1,6 +1,7 @@
-name: "CI: Check Code Formatting"
+name: "Check Code Formatting"
 
-on: [push]
+# Triggered manually
+on: [workflow_dispatch]
 
 jobs:
   build:
@@ -14,5 +15,5 @@ jobs:
         # Prevent blocking the install on a question during configuring of tzdata.
         export ENV DEBIAN_FRONTEND=noninteractive
         sudo apt update
-        sudo apt install clang-format-12 --yes
-        clang-format-12 --dry-run --Werror `find . -name "*.h" -or -name "*.cc"`
+        sudo apt install clang-format --yes
+        clang-format --dry-run --Werror `find . -name "*.h" -or -name "*.cc"`
diff --git a/.github/workflows/cmake-msvc.yml b/.github/workflows/cmake-msvc.yml
@@ -1,11 +1,12 @@
-name: "CI: cmake: msvc 2019"
+name: "CMake: MSVC"
 
-on: [push]
+# Triggered manually
+on: [workflow_dispatch]
 
 jobs:
   build:
 
-    runs-on: windows-2019
+    runs-on: windows-latest
 
     steps:
     - uses: actions/checkout@v1
diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
@@ -1,4 +1,4 @@
-name: "CI: cmake"
+name: "CMake: gcc"
 
 on: [push]
 
diff --git a/.github/workflows/meson-clang.yml b/.github/workflows/meson-clang.yml
@@ -1,11 +1,11 @@
-name: "meson: gcc 10"
+name: "Meson: clang"
 
 on: [push]
 
 jobs:
   build:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
@@ -14,11 +14,8 @@ jobs:
         # Prevent blocking apt install on a question during configuring of tzdata.
         export ENV DEBIAN_FRONTEND=noninteractive
         sudo apt update
-        sudo apt install libxml2-utils docbook5-xml docbook-xsl mm-common g++-10 ninja-build python3-setuptools python3-pip --yes
-        # Ubuntu 20.04 contains meson 0.53.2, but libsigc++ requires meson >= 0.55.0.
-        # Install it with pip3 instead of apt.
-        sudo pip3 install "meson>=0.55.0"
-        export CXX=g++-10
+        sudo apt install libxml2-utils docbook5-xml docbook-xsl mm-common clang meson ninja-build python3-setuptools --yes
+        export CXX=clang++
         meson setup -Dwarnings=fatal -Dwarning_level=3 -Dwerror=true _build
         cd _build
         meson compile
@@ -30,6 +27,6 @@ jobs:
       run: |
         sudo apt install git --yes
         # dist runs setup again so we need to specify CXX again.
-        export CXX=g++-10
+        export CXX=clang++
         cd _build
         meson dist
diff --git a/.github/workflows/meson-gcc.yml b/.github/workflows/meson-gcc.yml
@@ -1,11 +1,11 @@
-name: "meson: clang 10"
+name: "Meson: gcc"
 
 on: [push]
 
 jobs:
   build:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
@@ -14,11 +14,8 @@ jobs:
         # Prevent blocking apt install on a question during configuring of tzdata.
         export ENV DEBIAN_FRONTEND=noninteractive
         sudo apt update
-        sudo apt install libxml2-utils docbook5-xml docbook-xsl mm-common clang-10 ninja-build python3-setuptools python3-pip --yes
-        # Ubuntu 20.04 contains meson 0.53.2, but libsigc++ requires meson >= 0.55.0.
-        # Install it with pip3 instead of apt.
-        sudo pip3 install "meson>=0.55.0"
-        export CXX=clang++-10
+        sudo apt install libxml2-utils docbook5-xml docbook-xsl mm-common g++ meson ninja-build python3-setuptools --yes
+        export CXX=g++
         meson setup -Dwarnings=fatal -Dwarning_level=3 -Dwerror=true _build
         cd _build
         meson compile
@@ -30,6 +27,6 @@ jobs:
       run: |
         sudo apt install git --yes
         # dist runs setup again so we need to specify CXX again.
-        export CXX=clang++-10
+        export CXX=g++
         cd _build
         meson dist
diff --git a/.github/workflows/meson-msvc.yml b/.github/workflows/meson-msvc.yml
@@ -0,0 +1,35 @@
+name: "Meson: MSVC"
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - run: pip install meson ninja
+
+      - name: Prepare MSVC
+        uses: bus1/cabuild/action/msdevshell@v1
+        with:
+          architecture: x64
+
+      - name: Configure
+        # Don't use warning_level or werror. They are applied also to subprojects.
+        # 2023-07-28: Why is the documentation not built?
+        # With the latest fixes in mm-common and libsigc++ it's possible
+        # to build the reference documentation, but it's error-prone to build
+        # the manual. AFAIK there are no easily installable docbook5-xml and
+        # docbook-xsl packages for Windows.
+        run: meson setup -Dwarnings=fatal -Dmaintainer-mode=false -Dbuild-documentation=false _build
+
+      - name: Compile
+        run: meson compile -C _build
+
+      - name: Test
+        run: meson test -C _build
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -3,9 +3,9 @@
 # Copied from https://github.com/libsigcplusplus/libsigcplusplus/actions/new
 # and changed. Actions -> New workflow -> Pages -> GitHub Pages Jekyll
 
-name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+name: Publish docs
 
-# 2022-12-17: ubuntu-latest = ubuntu-22.04
+# 2023-07-28: ubuntu-latest = ubuntu-22.04
 on:
   # Runs on pushes targeting the default branch
   push:
diff --git a/configure.ac b/configure.ac
@@ -74,6 +74,8 @@ AS_IF([test "x$enable_benchmark" = xyes],[
 ])
 
 AC_SUBST(MSVC_STATIC_CXXFLAG, '')
+AC_SUBST(DOXYGEN_HAVE_DOT, [YES])
+AM_SUBST_NOTMAKE(DOXYGEN_HAVE_DOT)
 
 AC_CONFIG_FILES([Makefile
                  ${SIGCXX_MODULE_NAME}.pc:sigc++.pc.in
diff --git a/docs/docs/manual/libsigc_manual.xml b/docs/docs/manual/libsigc_manual.xml
@@ -258,13 +258,19 @@ int main()
 
 <section xml:id="sect-disconnecting">
 <info><title>Disconnecting</title></info>
-
 	<para>If you decide you no longer want your code to be called whenever a signal is
 	emitted, you must remember the return value of <literal remap="tt">connect()</literal>, which we've been
 	ignoring until now.</para>
 
 	<para><literal remap="tt">connect()</literal> returns a <literal remap="tt">sigc::connection</literal> object, which has a <literal remap="tt">disconnect()</literal> member method. This does just what you think it does.</para>
 
+	<para>Also, sigc++ 3.6 adds <literal remap="tt">sigc::scoped_connection</literal>.
+	A scoped connection can be constructed or assigned from a normal/unscoped <literal remap="tt">sigc::connection</literal>,
+	whereupon it effectively takes ownership of the connection, and will automatically <literal remap="tt">disconnect()</literal>
+	it when the <literal remap="tt">sigc::scoped_connection</literal> is destroyed (goes out of scope) or reassigned.
+	This lets you tie whether a slot is called to the lifetime of a scoped connection object, e.g. as a class member,
+	instead of having to manually disconnect. Scoped connections can be put in containers, or made ref-counted via <literal remap="tt">std::shared_ptr</literal>.
+	See the <literal remap="tt">sigc::scoped_connection</literal> class documentation for examples.</para>
 </section>
 </chapter>
 
@@ -431,7 +437,6 @@ asignal.connect( sigc::retype( sigc::ptr_fun(&amp;dostuff) ) );
 
 <chapter xml:id="chapter-reference">
 <info><title>Reference</title></info>
-
-	<para>See the reference documentation <link xlink:href="http://library.gnome.org/devel/libsigc++/unstable/">online</link></para>
+	<para>See the reference documentation <link xlink:href="https://libsigcplusplus.github.io/libsigcplusplus/reference/html/">online</link></para>
 </chapter>
 </book>
diff --git a/docs/docs/reference/Doxyfile.in b/docs/docs/reference/Doxyfile.in
@@ -296,7 +296,7 @@ EXTERNAL_PAGES         = YES
 #---------------------------------------------------------------------------
 DIA_PATH               =
 HIDE_UNDOC_RELATIONS   = NO
-HAVE_DOT               = YES
+HAVE_DOT               = @DOXYGEN_HAVE_DOT@
 DOT_NUM_THREADS        = 0
 DOT_FONTNAME           = Sans
 DOT_FONTSIZE           = 10
diff --git a/docs/docs/reference/meson.build b/docs/docs/reference/meson.build
@@ -3,7 +3,7 @@
 # Input: project_build_root, project_source_root, sigcxx_pcname,
 #        sigcxx_api_version, build_documentation, source_h_files,
 #        hg_ccg_basenames, install_datadir, python3, doc_reference,
-#        can_add_dist_script
+#        can_add_dist_script, dot
 # Output: install_docdir, install_devhelpdir, book_name,
 #         if build_documentation: tag_file
 
@@ -60,6 +60,7 @@ doc_conf_data.set('abs_top_builddir', project_build_root)
 doc_conf_data.set('abs_top_srcdir', project_source_root)
 doc_conf_data.set('SIGCXX_API_VERSION', sigcxx_api_version)
 doc_conf_data.set('DOXYGEN_TAGFILES', doxygen_tagfiles)
+doc_conf_data.set('DOXYGEN_HAVE_DOT', dot.found() ? 'YES' : 'NO')
 
 doxyfile = configure_file(
   input: 'Doxyfile.in',
diff --git a/meson.build b/meson.build
@@ -134,9 +134,14 @@ if maintainer_mode and not mm_common_get.found()
 endif
 
 doxygen = find_program('doxygen', required: build_documentation)
-dot = find_program('dot', required: build_documentation) # Used by Doxygen
+dot = find_program('dot', required: false) # Used by Doxygen, if found
 xsltproc = find_program('xsltproc', required: build_documentation)
 
+if build_documentation and not dot.found()
+  message('The \'dot\' command is not found.\n  ' + \
+          'This will affect the look of the inheritance diagrams in the documentation.')
+endif
+
 script_dir = project_source_root / 'untracked' / 'build_scripts'
 doc_reference = script_dir / 'doc-reference.py'
 dist_changelog = script_dir / 'dist-changelog.py'
diff --git a/sigc++/CMakeLists.txt b/sigc++/CMakeLists.txt
@@ -16,6 +16,7 @@
 
 set (SOURCE_FILES
 	connection.cc
+	scoped_connection.cc
 	signal_base.cc
 	trackable.cc
 	functors/slot_base.cc
diff --git a/sigc++/connection.h b/sigc++/connection.h
@@ -16,8 +16,10 @@
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  *
  */
+
 #ifndef SIGC_CONNECTION_HPP
 #define SIGC_CONNECTION_HPP
+
 #include <sigc++config.h>
 #include <sigc++/functors/slot_base.h>
 #include <sigc++/weak_raw_ptr.h>
@@ -30,13 +32,20 @@ namespace sigc
  * This may be used to disconnect the referred slot at any time (disconnect()).
  * @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()"
  * returns a %sigc::connection.
+ *
  * @code
  * sigc::connection conn = sig.connect(sigc::mem_fun(a, &A::foo));
  * @endcode
+ *
  * If the slot has already been destroyed, disconnect() does nothing. empty() or
  * operator bool() can be used to test whether the connection is
  * still active. The connection can be blocked (block(), unblock()).
  *
+ * sigc::connection doesnʼt disconnect the slot automatically upon destruction.
+ * You do not need to keep the sigc::connection object to retain the connection
+ * of the slot to the signal. See also @ref sigc::scoped_connection, which does
+ * disconnect automatically when the connection object is destroyed or replaced.
+ *
  * @ingroup signal
  */
 struct SIGC_API connection
diff --git a/sigc++/filelist.am b/sigc++/filelist.am
@@ -24,6 +24,7 @@ sigc_public_h =				\
 	member_method_trait.h \
 	reference_wrapper.h		\
 	retype_return.h			\
+	scoped_connection.h \
 	signal.h \
 	signal_base.h			\
 	slot.h			\
@@ -58,6 +59,7 @@ sigc_public_h =				\
 	functors/slot_base.h
 
 sigc_sources_cc =			\
+	scoped_connection.cc \
 	signal_base.cc			\
 	trackable.cc			\
 	connection.cc			\
diff --git a/sigc++/meson.build b/sigc++/meson.build
@@ -8,6 +8,7 @@
 
 source_cc_files = [
   'connection.cc',
+  'scoped_connection.cc',
   'signal_base.cc',
   'trackable.cc',
   'functors' / 'slot_base.cc',
@@ -21,6 +22,7 @@ sigc_h_files = [
   'member_method_trait.h',
   'reference_wrapper.h',
   'retype_return.h',
+  'scoped_connection.h',
   'signal.h',
   'signal_base.h',
   'slot.h',
diff --git a/sigc++/scoped_connection.cc b/sigc++/scoped_connection.cc
diff --git a/sigc++/scoped_connection.h b/sigc++/scoped_connection.h
diff --git a/sigc++/sigc++.h b/sigc++/sigc++.h
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
diff --git a/tests/Makefile.am b/tests/Makefile.am
diff --git a/tests/meson.build b/tests/meson.build
diff --git a/tests/test_scoped_connection.cc b/tests/test_scoped_connection.cc

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: "CI: cmake"`
	`1`	`+name: "CMake: gcc"`
`2`	`2`
`3`	`3`	`on: [push]`
`4`	`4`