Merge branch 'th/hash-steal-extended-set' into 'main'

ghash: fix g_hash_table_steal_extended() when requesting key and value of a set See merge request GNOME/glib!2980
Merge branch 'traverse-diagrams' into 'main'
2024-08-23 01:36:15 +02:00 · 2024-07-15 21:24:18 +00:00 · 2024-07-15 15:58:45 +00:00 · 2024-07-15 15:58:45 +00:00 · 2024-02-26 08:15:46 +01:00 · 2024-02-26 08:15:46 +01:00
12 changed files with 2703 additions and 200 deletions
--- a/docs/reference/glib/Sorted_binary_tree_breadth-first_traversal-dark.svg
+++ b/docs/reference/glib/Sorted_binary_tree_breadth-first_traversal-dark.svg
@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 
+  SPDX-License-Identifier: CC0-1.0
+  SPDX-FileCopyrightText: Rory O'Kane at Wikimedia Commons 
+                          <https://commons.wikimedia.org/wiki/File:Sorted_binary_tree_breadth-first_traversal.svg>
+  SPDX-FileCopyrightText: 2024 Frank Dana
+-->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="266px" height="212px" viewBox="0 0 266 212" enable-background="new 0 0 266 212" xml:space="preserve">
+<g>
+	<g>
+		<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" x1="27.23" y1="23.192" x2="29.23" y2="23.192"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9562,3.9562" x1="33.187" y1="23.192" x2="236.932" y2="23.192"/>
+		<polyline fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" points="238.91,23.192 240.91,23.192 
+			238.97,23.677 		"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="24.646" x2="27.971" y2="76.427"/>
+		<polyline fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" points="26.035,76.912 24.095,77.396 
+			26.095,77.396 		"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0154,4.0154" x1="30.11" y1="77.396" x2="236.902" y2="77.396"/>
+		<polyline fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" points="238.91,77.396 240.91,77.396 
+			238.97,77.881 		"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="78.85" x2="27.971" y2="130.631"/>
+		<polyline fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" points="26.035,131.114 24.095,131.6 
+			26.095,131.6 		"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0154,4.0154" x1="30.11" y1="131.6" x2="236.902" y2="131.6"/>
+		<polyline fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" points="238.91,131.6 240.91,131.6 
+			238.97,132.085 		"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="133.053" x2="27.971" y2="184.835"/>
+		<polyline fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" points="26.035,185.318 24.095,185.804 
+			26.095,185.804 		"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0086,4.0086" x1="30.104" y1="185.804" x2="228.53" y2="185.804"/>
+		
+			<line fill="none" stroke="#90c2ff" stroke-width="2" stroke-miterlimit="10" x1="230.534" y1="185.804" x2="232.534" y2="185.804"/>
+		<g>
+			<rect fill="#90c2ff" x="24.095" y="19.892" width="6.602" height="6.602"/>
+		</g>
+		<g>
+			<path fill="#90c2ff" d="M238.569,185.804c-2.84,1.054-6.363,2.852-8.548,4.756l1.721-4.756l-1.721-4.755
+				C232.206,182.953,235.729,184.751,238.569,185.804z"/>
+		</g>
+	</g>
+</g>
+<g id="graph0">
+	<title>sorted_binary_tree</title>
+	<g id="node1">
+		<title>C</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="60.23" cy="185.804" rx="18.067" ry="18.067"/>
+		<text transform="matrix(1 0 0 1 55.5435 190.8223)" font-family="'Times-Roman'" font-size="14.0528">C</text>
+	</g>
+	<g id="node2">
+		<title>E</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="132.502" cy="185.804" rx="18.067" ry="18.067"/>
+		<text transform="matrix(1 0 0 1 128.21 190.8223)" font-family="'Times-Roman'" font-size="14.0528">E</text>
+	</g>
+	<g id="node3">
+		<title>H</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="204.773" cy="185.804" rx="17.064" ry="18.067"/>
+		<text transform="matrix(1 0 0 1 199.6992 190.8223)" font-family="'Times-Roman'" font-size="14.0528">H</text>
+	</g>
+	<g id="node4">
+		<title>A</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="24.094" cy="131.6" rx="17.064" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 19.02 136.6191)" font-family="'Times-Roman'" font-size="14.0528">A</text>
+	</g>
+	<g id="node5">
+		<title>D</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="96.366" cy="131.6" rx="17.064" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 91.292 136.6191)" font-family="'Times-Roman'" font-size="14.0528">D</text>
+	</g>
+	<g id="edge6">
+		<title>D-&gt;C</title>
+		<path fill="none" stroke="#ffffff" d="M86.328,147.66c-3.011,4.016-7.026,9.034-10.038,14.053"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="78.298,164.725 70.268,170.747 73.279,160.709 		"/>
+	</g>
+	<g id="edge8">
+		<title>D-&gt;E</title>
+		<path fill="none" stroke="#ffffff" d="M106.404,147.66c3.011,4.016,7.026,9.034,10.038,14.053"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="119.453,160.709 122.464,170.747 114.434,164.725 		"/>
+	</g>
+	<g id="node6">
+		<title>I</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="240.909" cy="131.6" rx="18.068" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 238.5693 136.6191)" font-family="'Times-Roman'" font-size="14.0528">I</text>
+	</g>
+	<g id="edge12">
+		<title>I-&gt;H</title>
+		<path fill="none" stroke="#ffffff" d="M230.871,146.656c-3.011,5.02-6.021,10.038-10.037,15.057"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="223.846,163.721 214.812,169.743 217.822,159.705 		"/>
+	</g>
+	<g id="node7">
+		<title>B</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="60.23" cy="77.396" rx="18.068" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 55.5435 82.415)" font-family="'Times-Roman'" font-size="14.0528">B</text>
+	</g>
+	<g id="edge3">
+		<title>B-&gt;A</title>
+		<path fill="none" stroke="#ffffff" d="M50.192,92.453c-3.011,5.019-6.022,10.038-10.038,15.057"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="43.166,109.518 34.132,115.539 37.144,105.502 		"/>
+	</g>
+	<g id="edge5">
+		<title>B-&gt;D</title>
+		<path fill="none" stroke="#ffffff" d="M70.268,92.453c3.011,5.019,6.022,10.038,10.038,15.057"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="83.317,105.502 86.328,115.539 77.294,109.518 		"/>
+	</g>
+	<g id="node8">
+		<title>G</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="204.773" cy="77.396" rx="17.064" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 199.6992 82.415)" font-family="'Times-Roman'" font-size="14.0528">G</text>
+	</g>
+	<g id="edge11">
+		<title>G-&gt;I</title>
+		<path fill="none" stroke="#ffffff" d="M214.812,93.457c3.011,4.015,7.026,9.034,10.038,14.053"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="227.86,106.506 230.871,116.543 222.842,110.521 		"/>
+	</g>
+	<g id="node9">
+		<title>F</title>
+		<ellipse fill="#FFFFFF" stroke="#ffffff" cx="132.502" cy="23.192" rx="18.068" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 128.5942 28.2109)" font-family="'Times-Roman'" font-size="14.0528">F</text>
+	</g>
+	<g id="edge2">
+		<title>F-&gt;B</title>
+		<path fill="none" stroke="#ffffff" d="M117.445,34.234c-11.042,8.03-23.087,17.064-34.128,26.098"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="85.325,63.343 75.287,66.354 81.31,57.321 		"/>
+	</g>
+	<g id="edge10">
+		<title>F-&gt;G</title>
+		<path fill="none" stroke="#ffffff" d="M147.559,34.234c11.041,8.03,23.087,17.064,34.129,26.098"/>
+		<polygon fill="#ffffff" stroke="#ffffff" points="183.694,57.321 189.717,66.354 179.68,63.343 		"/>
+	</g>
+</g>
+</svg>
--- a/docs/reference/glib/Sorted_binary_tree_breadth-first_traversal.svg
+++ b/docs/reference/glib/Sorted_binary_tree_breadth-first_traversal.svg
@ -1,134 +1,138 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 16.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 width="266px" height="212px" viewBox="0 0 266 212" enable-background="new 0 0 266 212" xml:space="preserve">
-<g>
-	<g>
-		<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="27.23" y1="23.192" x2="29.23" y2="23.192"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9562,3.9562" x1="33.187" y1="23.192" x2="236.932" y2="23.192"/>
-		<polyline fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" points="238.91,23.192 240.91,23.192 
-			238.97,23.677 		"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="24.646" x2="27.971" y2="76.427"/>
-		<polyline fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" points="26.035,76.912 24.095,77.396 
-			26.095,77.396 		"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0154,4.0154" x1="30.11" y1="77.396" x2="236.902" y2="77.396"/>
-		<polyline fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" points="238.91,77.396 240.91,77.396 
-			238.97,77.881 		"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="78.85" x2="27.971" y2="130.631"/>
-		<polyline fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" points="26.035,131.114 24.095,131.6 
-			26.095,131.6 		"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0154,4.0154" x1="30.11" y1="131.6" x2="236.902" y2="131.6"/>
-		<polyline fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" points="238.91,131.6 240.91,131.6 
-			238.97,132.085 		"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="133.053" x2="27.971" y2="184.835"/>
-		<polyline fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" points="26.035,185.318 24.095,185.804 
-			26.095,185.804 		"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0086,4.0086" x1="30.104" y1="185.804" x2="228.53" y2="185.804"/>
-		
-			<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="230.534" y1="185.804" x2="232.534" y2="185.804"/>
-		<g>
-			<rect x="24.095" y="19.892" width="6.602" height="6.602"/>
-		</g>
-		<g>
-			<path d="M238.569,185.804c-2.84,1.054-6.363,2.852-8.548,4.756l1.721-4.756l-1.721-4.755
-				C232.206,182.953,235.729,184.751,238.569,185.804z"/>
-		</g>
-	</g>
-</g>
-<g id="graph0">
-	<title>sorted_binary_tree</title>
-	<g id="node1">
-		<title>C</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="60.23" cy="185.804" rx="18.067" ry="18.067"/>
-		<text transform="matrix(1 0 0 1 55.5435 190.8223)" font-family="'Times-Roman'" font-size="14.0528">C</text>
-	</g>
-	<g id="node2">
-		<title>E</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="132.502" cy="185.804" rx="18.067" ry="18.067"/>
-		<text transform="matrix(1 0 0 1 128.21 190.8223)" font-family="'Times-Roman'" font-size="14.0528">E</text>
-	</g>
-	<g id="node3">
-		<title>H</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="204.773" cy="185.804" rx="17.064" ry="18.067"/>
-		<text transform="matrix(1 0 0 1 199.6992 190.8223)" font-family="'Times-Roman'" font-size="14.0528">H</text>
-	</g>
-	<g id="node4">
-		<title>A</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="24.094" cy="131.6" rx="17.064" ry="18.068"/>
-		<text transform="matrix(1 0 0 1 19.02 136.6191)" font-family="'Times-Roman'" font-size="14.0528">A</text>
-	</g>
-	<g id="node5">
-		<title>D</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="96.366" cy="131.6" rx="17.064" ry="18.068"/>
-		<text transform="matrix(1 0 0 1 91.292 136.6191)" font-family="'Times-Roman'" font-size="14.0528">D</text>
-	</g>
-	<g id="edge6">
-		<title>D-&gt;C</title>
-		<path fill="none" stroke="#000000" d="M86.328,147.66c-3.011,4.016-7.026,9.034-10.038,14.053"/>
-		<polygon stroke="#000000" points="78.298,164.725 70.268,170.747 73.279,160.709 		"/>
-	</g>
-	<g id="edge8">
-		<title>D-&gt;E</title>
-		<path fill="none" stroke="#000000" d="M106.404,147.66c3.011,4.016,7.026,9.034,10.038,14.053"/>
-		<polygon stroke="#000000" points="119.453,160.709 122.464,170.747 114.434,164.725 		"/>
-	</g>
-	<g id="node6">
-		<title>I</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="240.909" cy="131.6" rx="18.068" ry="18.068"/>
-		<text transform="matrix(1 0 0 1 238.5693 136.6191)" font-family="'Times-Roman'" font-size="14.0528">I</text>
-	</g>
-	<g id="edge12">
-		<title>I-&gt;H</title>
-		<path fill="none" stroke="#000000" d="M230.871,146.656c-3.011,5.02-6.021,10.038-10.037,15.057"/>
-		<polygon stroke="#000000" points="223.846,163.721 214.812,169.743 217.822,159.705 		"/>
-	</g>
-	<g id="node7">
-		<title>B</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="60.23" cy="77.396" rx="18.068" ry="18.068"/>
-		<text transform="matrix(1 0 0 1 55.5435 82.415)" font-family="'Times-Roman'" font-size="14.0528">B</text>
-	</g>
-	<g id="edge3">
-		<title>B-&gt;A</title>
-		<path fill="none" stroke="#000000" d="M50.192,92.453c-3.011,5.019-6.022,10.038-10.038,15.057"/>
-		<polygon stroke="#000000" points="43.166,109.518 34.132,115.539 37.144,105.502 		"/>
-	</g>
-	<g id="edge5">
-		<title>B-&gt;D</title>
-		<path fill="none" stroke="#000000" d="M70.268,92.453c3.011,5.019,6.022,10.038,10.038,15.057"/>
-		<polygon stroke="#000000" points="83.317,105.502 86.328,115.539 77.294,109.518 		"/>
-	</g>
-	<g id="node8">
-		<title>G</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="204.773" cy="77.396" rx="17.064" ry="18.068"/>
-		<text transform="matrix(1 0 0 1 199.6992 82.415)" font-family="'Times-Roman'" font-size="14.0528">G</text>
-	</g>
-	<g id="edge11">
-		<title>G-&gt;I</title>
-		<path fill="none" stroke="#000000" d="M214.812,93.457c3.011,4.015,7.026,9.034,10.038,14.053"/>
-		<polygon stroke="#000000" points="227.86,106.506 230.871,116.543 222.842,110.521 		"/>
-	</g>
-	<g id="node9">
-		<title>F</title>
-		<ellipse fill="#FFFFFF" stroke="#000000" cx="132.502" cy="23.192" rx="18.068" ry="18.068"/>
-		<text transform="matrix(1 0 0 1 128.5942 28.2109)" font-family="'Times-Roman'" font-size="14.0528">F</text>
-	</g>
-	<g id="edge2">
-		<title>F-&gt;B</title>
-		<path fill="none" stroke="#000000" d="M117.445,34.234c-11.042,8.03-23.087,17.064-34.128,26.098"/>
-		<polygon stroke="#000000" points="85.325,63.343 75.287,66.354 81.31,57.321 		"/>
-	</g>
-	<g id="edge10">
-		<title>F-&gt;G</title>
-		<path fill="none" stroke="#000000" d="M147.559,34.234c11.041,8.03,23.087,17.064,34.129,26.098"/>
-		<polygon stroke="#000000" points="183.694,57.321 189.717,66.354 179.68,63.343 		"/>
-	</g>
-</g>
-</svg>
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 
+  SPDX-License-Identifier: CC0-1.0
+  SPDX-FileCopyrightText: Rory O'Kane at Wikimedia Commons 
+                          <https://commons.wikimedia.org/wiki/File:Sorted_binary_tree_breadth-first_traversal.svg>
+  SPDX-FileCopyrightText: 2024 Frank Dana
+-->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="266px" height="212px" viewBox="0 0 266 212" enable-background="new 0 0 266 212" xml:space="preserve">
+<g>
+	<g>
+		<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" x1="27.23" y1="23.192" x2="29.23" y2="23.192"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9562,3.9562" x1="33.187" y1="23.192" x2="236.932" y2="23.192"/>
+		<polyline fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" points="238.91,23.192 240.91,23.192 
+			238.97,23.677 		"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="24.646" x2="27.971" y2="76.427"/>
+		<polyline fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" points="26.035,76.912 24.095,77.396 
+			26.095,77.396 		"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0154,4.0154" x1="30.11" y1="77.396" x2="236.902" y2="77.396"/>
+		<polyline fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" points="238.91,77.396 240.91,77.396 
+			238.97,77.881 		"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="78.85" x2="27.971" y2="130.631"/>
+		<polyline fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" points="26.035,131.114 24.095,131.6 
+			26.095,131.6 		"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0154,4.0154" x1="30.11" y1="131.6" x2="236.902" y2="131.6"/>
+		<polyline fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" points="238.91,131.6 240.91,131.6 
+			238.97,132.085 		"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="3.9907,3.9907" x1="235.099" y1="133.053" x2="27.971" y2="184.835"/>
+		<polyline fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" points="26.035,185.318 24.095,185.804 
+			26.095,185.804 		"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="4.0086,4.0086" x1="30.104" y1="185.804" x2="228.53" y2="185.804"/>
+		
+			<line fill="none" stroke="#1c76e4" stroke-width="2" stroke-miterlimit="10" x1="230.534" y1="185.804" x2="232.534" y2="185.804"/>
+		<g>
+			<rect fill="#1c76e4" x="24.095" y="19.892" width="6.602" height="6.602"/>
+		</g>
+		<g>
+			<path fill="#1c76e4" d="M238.569,185.804c-2.84,1.054-6.363,2.852-8.548,4.756l1.721-4.756l-1.721-4.755
+				C232.206,182.953,235.729,184.751,238.569,185.804z"/>
+		</g>
+	</g>
+</g>
+<g id="graph0">
+	<title>sorted_binary_tree</title>
+	<g id="node1">
+		<title>C</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="60.23" cy="185.804" rx="18.067" ry="18.067"/>
+		<text transform="matrix(1 0 0 1 55.5435 190.8223)" font-family="'Times-Roman'" font-size="14.0528">C</text>
+	</g>
+	<g id="node2">
+		<title>E</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="132.502" cy="185.804" rx="18.067" ry="18.067"/>
+		<text transform="matrix(1 0 0 1 128.21 190.8223)" font-family="'Times-Roman'" font-size="14.0528">E</text>
+	</g>
+	<g id="node3">
+		<title>H</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="204.773" cy="185.804" rx="17.064" ry="18.067"/>
+		<text transform="matrix(1 0 0 1 199.6992 190.8223)" font-family="'Times-Roman'" font-size="14.0528">H</text>
+	</g>
+	<g id="node4">
+		<title>A</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="24.094" cy="131.6" rx="17.064" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 19.02 136.6191)" font-family="'Times-Roman'" font-size="14.0528">A</text>
+	</g>
+	<g id="node5">
+		<title>D</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="96.366" cy="131.6" rx="17.064" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 91.292 136.6191)" font-family="'Times-Roman'" font-size="14.0528">D</text>
+	</g>
+	<g id="edge6">
+		<title>D-&gt;C</title>
+		<path fill="none" stroke="#000000" d="M86.328,147.66c-3.011,4.016-7.026,9.034-10.038,14.053"/>
+		<polygon stroke="#000000" points="78.298,164.725 70.268,170.747 73.279,160.709 		"/>
+	</g>
+	<g id="edge8">
+		<title>D-&gt;E</title>
+		<path fill="none" stroke="#000000" d="M106.404,147.66c3.011,4.016,7.026,9.034,10.038,14.053"/>
+		<polygon stroke="#000000" points="119.453,160.709 122.464,170.747 114.434,164.725 		"/>
+	</g>
+	<g id="node6">
+		<title>I</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="240.909" cy="131.6" rx="18.068" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 238.5693 136.6191)" font-family="'Times-Roman'" font-size="14.0528">I</text>
+	</g>
+	<g id="edge12">
+		<title>I-&gt;H</title>
+		<path fill="none" stroke="#000000" d="M230.871,146.656c-3.011,5.02-6.021,10.038-10.037,15.057"/>
+		<polygon stroke="#000000" points="223.846,163.721 214.812,169.743 217.822,159.705 		"/>
+	</g>
+	<g id="node7">
+		<title>B</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="60.23" cy="77.396" rx="18.068" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 55.5435 82.415)" font-family="'Times-Roman'" font-size="14.0528">B</text>
+	</g>
+	<g id="edge3">
+		<title>B-&gt;A</title>
+		<path fill="none" stroke="#000000" d="M50.192,92.453c-3.011,5.019-6.022,10.038-10.038,15.057"/>
+		<polygon stroke="#000000" points="43.166,109.518 34.132,115.539 37.144,105.502 		"/>
+	</g>
+	<g id="edge5">
+		<title>B-&gt;D</title>
+		<path fill="none" stroke="#000000" d="M70.268,92.453c3.011,5.019,6.022,10.038,10.038,15.057"/>
+		<polygon stroke="#000000" points="83.317,105.502 86.328,115.539 77.294,109.518 		"/>
+	</g>
+	<g id="node8">
+		<title>G</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="204.773" cy="77.396" rx="17.064" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 199.6992 82.415)" font-family="'Times-Roman'" font-size="14.0528">G</text>
+	</g>
+	<g id="edge11">
+		<title>G-&gt;I</title>
+		<path fill="none" stroke="#000000" d="M214.812,93.457c3.011,4.015,7.026,9.034,10.038,14.053"/>
+		<polygon stroke="#000000" points="227.86,106.506 230.871,116.543 222.842,110.521 		"/>
+	</g>
+	<g id="node9">
+		<title>F</title>
+		<ellipse fill="#FFFFFF" stroke="#000000" cx="132.502" cy="23.192" rx="18.068" ry="18.068"/>
+		<text transform="matrix(1 0 0 1 128.5942 28.2109)" font-family="'Times-Roman'" font-size="14.0528">F</text>
+	</g>
+	<g id="edge2">
+		<title>F-&gt;B</title>
+		<path fill="none" stroke="#000000" d="M117.445,34.234c-11.042,8.03-23.087,17.064-34.128,26.098"/>
+		<polygon stroke="#000000" points="85.325,63.343 75.287,66.354 81.31,57.321 		"/>
+	</g>
+	<g id="edge10">
+		<title>F-&gt;G</title>
+		<path fill="none" stroke="#000000" d="M147.559,34.234c11.041,8.03,23.087,17.064,34.129,26.098"/>
+		<polygon stroke="#000000" points="183.694,57.321 189.717,66.354 179.68,63.343 		"/>
+	</g>
+</g>
+</svg>
--- a/docs/reference/glib/Sorted_binary_tree_inorder-dark.svg
+++ b/docs/reference/glib/Sorted_binary_tree_inorder-dark.svg
--- a/docs/reference/glib/Sorted_binary_tree_inorder.svg
+++ b/docs/reference/glib/Sorted_binary_tree_inorder.svg
--- a/docs/reference/glib/Sorted_binary_tree_postorder-dark.svg
+++ b/docs/reference/glib/Sorted_binary_tree_postorder-dark.svg
--- a/docs/reference/glib/Sorted_binary_tree_postorder.svg
+++ b/docs/reference/glib/Sorted_binary_tree_postorder.svg
--- a/docs/reference/glib/Sorted_binary_tree_preorder-dark.svg
+++ b/docs/reference/glib/Sorted_binary_tree_preorder-dark.svg
--- a/docs/reference/glib/Sorted_binary_tree_preorder.svg
+++ b/docs/reference/glib/Sorted_binary_tree_preorder.svg
--- a/docs/reference/glib/glib.toml.in
+++ b/docs/reference/glib/glib.toml.in
@ -99,6 +99,10 @@ content_images = [
  "Sorted_binary_tree_inorder.svg",
  "Sorted_binary_tree_postorder.svg",
  "Sorted_binary_tree_preorder.svg",
+  "Sorted_binary_tree_breadth-first_traversal-dark.svg",
+  "Sorted_binary_tree_inorder-dark.svg",
+  "Sorted_binary_tree_postorder-dark.svg",
+  "Sorted_binary_tree_preorder-dark.svg",
 ]

 [[object]]
--- a/glib/ghash.c
+++ b/glib/ghash.c
@ -1785,8 +1785,9 @@ g_hash_table_steal (GHashTable    *hash_table,
 * of @hash_table are %NULL-safe.
 *
 * The dictionary implementation optimizes for having all values identical to
- * their keys, for example by using g_hash_table_add(). When stealing both the
- * key and the value from such a dictionary, the value will be %NULL.
+ * their keys, for example by using g_hash_table_add(). Before 2.78, when
+ * stealing both the key and the value from such a dictionary, the value was
+ * %NULL.  Now the returned value and the key will be the same.
 *
 * Returns: %TRUE if the key was found in the #GHashTable
 * Since: 2.58
@ -1820,10 +1821,15 @@ g_hash_table_steal_extended (GHashTable    *hash_table,
  }

  if (stolen_value != NULL)
-  {
-    *stolen_value = g_hash_table_fetch_key_or_value (hash_table->values, node_index, hash_table->have_big_values);
-    g_hash_table_assign_key_or_value (hash_table->values, node_index, hash_table->have_big_values, NULL);
-  }
+    {
+      if (stolen_key && hash_table->keys == hash_table->values)
+        *stolen_value = *stolen_key;
+      else
+        {
+          *stolen_value = g_hash_table_fetch_key_or_value (hash_table->values, node_index, hash_table->have_big_values);
+          g_hash_table_assign_key_or_value (hash_table->values, node_index, hash_table->have_big_values, NULL);
+        }
+    }

  g_hash_table_remove_node (hash_table, node_index, FALSE);
  g_hash_table_maybe_resize (hash_table);
--- a/glib/gnode.c
+++ b/glib/gnode.c
@ -800,16 +800,38 @@ g_node_depth_traverse_level (GNode             *node,
 *              efficient than the other orders.
 *
 * Specifies the type of traversal performed by g_tree_traverse(),
- * g_node_traverse() and g_node_find(). The different orders are
- * illustrated here:
+ * g_node_traverse() and g_node_find().
+ *
+ * The different orders are illustrated here:
+ *
 * - In order: A, B, C, D, E, F, G, H, I
- *   ![](Sorted_binary_tree_inorder.svg)
+ *   <picture>
+ *     <source srcset="Sorted_binary_tree_inorder-dark.svg"
+ *      media="(prefers-color-scheme: dark)">
+ *     <img src="Sorted_binary_tree_inorder.svg"
+ *      alt="Sorted binary tree, in-order traversal">
+ *   </picture>
 * - Pre order: F, B, A, D, C, E, G, I, H
- *   ![](Sorted_binary_tree_preorder.svg)
+ *   <picture>
+ *     <source srcset="Sorted_binary_tree_preorder-dark.svg"
+ *      media="(prefers-color-scheme: dark)">
+ *     <img src="Sorted_binary_tree_preorder.svg"
+ *      alt="Sorted binary tree, pre-order traversal">
+ *   </picture>
 * - Post order: A, C, E, D, B, H, I, G, F
- *   ![](Sorted_binary_tree_postorder.svg)
+ *   <picture>
+ *     <source srcset="Sorted_binary_tree_postorder-dark.svg"
+ *      media="(prefers-color-scheme: dark)">
+ *     <img src="Sorted_binary_tree_postorder.svg"
+ *      alt="Sorted binary tree, post-order traversal">
+ *   </picture>
 * - Level order: F, B, G, A, D, I, C, E, H
- *   ![](Sorted_binary_tree_breadth-first_traversal.svg)
+ *   <picture>
+ *     <source srcset="Sorted_binary_tree_breadth-first_traversal-dark.svg"
+ *      media="(prefers-color-scheme: dark)">
+ *     <img src="Sorted_binary_tree_breadth-first_traversal.svg"
+ *      alt="Sorted binary tree, breadth-first level order traversal">
+ *   </picture>
 */

 /**
--- a/glib/tests/hash.c
+++ b/glib/tests/hash.c
@ -1271,6 +1271,52 @@ test_steal_extended (void)
  g_assert_cmpuint (g_hash_table_size (hash), ==, 5);

  g_hash_table_unref (hash);
+
+  hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
+
+  g_hash_table_add (hash, g_strdup ("a"));
+  g_hash_table_add (hash, g_strdup ("b"));
+  g_hash_table_add (hash, g_strdup ("c"));
+  g_hash_table_add (hash, g_strdup ("d"));
+  g_hash_table_add (hash, g_strdup ("e"));
+
+  g_assert_true (g_hash_table_steal_extended (hash, "a", (gpointer *) &stolen_key,
+                                              (gpointer *) &stolen_value));
+  g_assert_cmpstr (stolen_key, ==, "a");
+  g_assert_cmpstr (stolen_value, ==, "a");
+  g_clear_pointer (&stolen_key, g_free);
+  stolen_value = NULL;
+
+  g_assert_true (g_hash_table_steal_extended (hash, "b", (gpointer *) &stolen_key,
+                                              NULL));
+  g_assert_cmpstr (stolen_key, ==, "b");
+  g_clear_pointer (&stolen_key, g_free);
+
+  g_assert_true (g_hash_table_steal_extended (hash, "c", NULL,
+                                              (gpointer *) &stolen_value));
+  g_assert_cmpstr (stolen_value, ==, "c");
+  g_clear_pointer (&stolen_value, g_free);
+
+  g_assert_true (g_hash_table_steal_extended (hash, "d", (gpointer *) &stolen_key,
+                                              (gpointer *) &stolen_value));
+  g_assert_cmpstr (stolen_key, ==, "d");
+  g_assert_cmpstr (stolen_value, ==, "d");
+  g_clear_pointer (&stolen_key, g_free);
+  stolen_value = NULL;
+
+  /* So far, the GHashTable was used like a set (g_hash_table_add()), where all key/values were
+   * identical. Adding one entry where key/value differs, blows the internal representation
+   * up, and the hash table tracks two separate key/value arrays. */
+  g_hash_table_replace (hash, g_strdup ("x"), NULL);
+
+  g_assert_true (g_hash_table_steal_extended (hash, "e", (gpointer *) &stolen_key,
+                                              (gpointer *) &stolen_value));
+  g_assert_cmpstr (stolen_key, ==, "e");
+  g_assert_cmpstr (stolen_value, ==, "e");
+  g_clear_pointer (&stolen_key, g_free);
+  stolen_value = NULL;
+
+  g_hash_table_unref (hash);
 }

 /* Test that passing %NULL to the optional g_hash_table_steal_extended()
Author	SHA1	Message	Date
Thomas Haller	459d4c9085	Merge branch 'th/hash-steal-extended-set' into 'main' ghash: fix g_hash_table_steal_extended() when requesting key and value of a set See merge request GNOME/glib!2980	2024-07-15 21:24:18 +00:00
Philip Withnall	d3cb9d638d	Merge branch 'traverse-diagrams' into 'main' docs(GNode): Traversal diagrams, color & dark-mode See merge request GNOME/glib!4157	2024-07-15 15:58:45 +00:00
Philip Withnall	a931a75c4f	docs(GNode): Traversal diagrams, color & dark-mode * Create a dark-mode variant of each traversal diagram, with the traversal path colorized `--primary` blue, instead of the original black. * Apply the same colorizations to the light-mode diagrams, but using the light-theme `--primary` blue. * Add SPDX license/copyright comments to all eight SVG files. * Add new files to documentation configs in `glib.toml.in`. * Update documentation comment in `gnode.c` to embed both color variants via picture tags, instead of markdown image embeds. * Add alt text to all four images. * Add additional blank lines to documentation comment, so that a. First item in bulleted list does not get folded into preceding intro paragraph b. Intro paragraph and diagrams are not part of first paragraph in documentation. (This also gets them out of the top-level table-of-contents/index list, where they previously appeared in full.) * (Accidental change I didn't realize I was making): Convert line endings in breadth-first diagram from CRLF to LF.	2024-07-15 15:58:45 +00:00
Thomas Haller	2407d46f06	ghash: fix g_hash_table_steal_extended() when requesting key and value of a set GHashTable optimizes for the "set" case, where key and value are the same. See g_hash_table_add(). A user cannot see from outside, whether a GHashTable internally is a set and shares the keys and values array. Adding one key/value pair with differing key and value, will expand the GHashTable. In all other cases, the GHashTable API hides this implementation detail correctly. Except with g_hash_table_steal_extended(), when stealing both the key and the value. Fix that. This bug fix is obviously a change in behavior. In practice, it's unlikely that somebody would notice, because GHashTable contains opaque pointers and the user must know what the keys/values are and be aware of their ownership semantics when stealing them. That means, the change in behavior only affects instances that are internally a set, of what the user most likely is aware and fills the table with g_hash_table_add(). Such a user would not steal both the key and values at the same time. Even if they do, then previously stealing the value was pointless and would not give them what they wanted. It would not have meaningfully worked, and since nobody reported a bug about this yet, it's unlikely somebody noticed. The more problematic case when the user exhibits the bug is when the dictionary is unexpected a set internally. Imagine a mapping from numbers to numbers (e.g. a permutation). If "unexpectedly" the dictionary contains the identity permutation, steal-extended gives always NULL for the target number. The example is far fetched. In practice, it's unlikely that somebody is gonna notice either way. That is not an argument for fixing anything. The argument for fixing this, is that the bug breaks the illusion that the set is only an internal optimization. That is ugly and inconsistent.	2024-02-26 08:15:46 +01:00
Thomas Haller	c962e0d7cc	ghash/tests: add test cases for g_hash_table_steal_extended() for a set	2024-02-26 08:15:46 +01:00