struct::list - EF - equal extended with new option -simple.

Version bumped to 1.9.

struct::set  - B  - Fix mishandling of method shorthands in the Tcl implementation.
Version bumped to 2.2.5
Thanks to Emiliano for the patch providing most of the fix.

Author: andreas-kupries

embedded/md/tcllib/files/modules/struct/struct_list.md

@@ -3,7 +3,7 @@
 [//000000002]: # (Generated from file 'struct\_list\.man' by tcllib/doctools with format 'markdown')
 [//000000003]: # (Copyright © 2003\-2005 by Kevin B\. Kenny\. All rights reserved)
 [//000000004]: # (Copyright &copy; 2003\-2012 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>)
-[//000000005]: # (struct::list\(n\) 1\.8\.6 tcllib "Tcl Data Structures")
+[//000000005]: # (struct::list\(n\) 1\.9 tcllib "Tcl Data Structures")
 
 <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> &#124; <a
 href="../../../toc.md">Table Of Contents</a> &#124; <a
@@ -43,7 +43,7 @@ struct::list \- Procedures for manipulating lists
 # <a name='synopsis'></a>SYNOPSIS
 
 package require Tcl 8\.5 9  
-package require struct::list ?1\.8\.6?  
+package require struct::list ?1\.9?  
 
 [__::struct::list__ __longestCommonSubsequence__ *sequence1* *sequence2* ?*maxOccurs*?](#1)  
 [__::struct::list__ __longestCommonSubsequence2__ *sequence1 sequence2* ?*maxOccurs*?](#2)  
@@ -63,7 +63,7 @@ package require struct::list ?1\.8\.6?
 [__::struct::list__ __fold__ *sequence* *initialvalue* *cmdprefix*](#16)  
 [__::struct::list__ __shift__ *listvar*](#17)  
 [__::struct::list__ __iota__ *n*](#18)  
-[__::struct::list__ __equal__ *a* *b*](#19)  
+[__::struct::list__ __equal__ ?__\-simple__? ?__\-\-__? *a* *b*](#19)  
 [__::struct::list__ __repeat__ *size* *element1* ?*element2* *element3*\.\.\.?](#20)  
 [__::struct::list__ __repeatn__ *value* *size*\.\.\.](#21)  
 [__::struct::list__ __dbJoin__ ?__\-inner__&#124;__\-left__&#124;__\-right__&#124;__\-full__? ?__\-keys__ *varname*? \{*keycol* *table*\}\.\.\.](#22)  
@@ -419,12 +419,18 @@ provided here can be reached through a subcommand of this command\.
 
     For "*n* == __0__" an empty list will be returned\.
 
-  - <a name='19'></a>__::struct::list__ __equal__ *a* *b*
+  - <a name='19'></a>__::struct::list__ __equal__ ?__\-simple__? ?__\-\-__? *a* *b*
 
     The subcommand compares the two lists *a* and *b* for equality\. In other
     words, they have to be of the same length and have to contain the same
-    elements in the same order\. If an element is a list the same definition of
-    equality applies recursively\.
+    elements in the same order\.
+
+    By default equality checks are applied recursively to list elements which
+    are lists themselves\. This behaviour is disabled when specifying the option
+    __\-simple__\.
+
+    The option __\-\-__ disables option processing even if the following
+    argument looks like such\.
 
     A boolean value will be returned as the result of the command\. This value
     will be __true__ if the two lists are equal, and __false__ else\.

embedded/md/tcllib/files/modules/struct/struct_set.md

@@ -2,7 +2,7 @@
 [//000000001]: # (struct::set \- Tcl Data Structures)
 [//000000002]: # (Generated from file 'struct\_set\.man' by tcllib/doctools with format 'markdown')
 [//000000003]: # (Copyright &copy; 2004\-2008 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>)
-[//000000004]: # (struct::set\(n\) 2\.2\.4 tcllib "Tcl Data Structures")
+[//000000004]: # (struct::set\(n\) 2\.2\.5 tcllib "Tcl Data Structures")
 
 <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> &#124; <a
 href="../../../toc.md">Table Of Contents</a> &#124; <a

idoc/man/files/modules/struct/struct_list.n

@@ -3,7 +3,7 @@
 '\" Copyright (c) 2003-2005 by Kevin B\&. Kenny\&. All rights reserved
 '\" Copyright (c) 2003-2012 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>
 '\"
-.TH "struct::list" n 1\&.8\&.6 tcllib "Tcl Data Structures"
+.TH "struct::list" n 1\&.9 tcllib "Tcl Data Structures"
 .\" The -*- nroff -*- definitions below are for supplemental macros used
 .\" in Tcl/Tk manual entries.
 .\"
@@ -277,7 +277,7 @@ struct::list \- Procedures for manipulating lists
 .SH SYNOPSIS
 package require \fBTcl 8\&.5 9\fR
 .sp
-package require \fBstruct::list ?1\&.8\&.6?\fR
+package require \fBstruct::list ?1\&.9?\fR
 .sp
 \fB::struct::list\fR \fBlongestCommonSubsequence\fR \fIsequence1\fR \fIsequence2\fR ?\fImaxOccurs\fR?
 .sp
@@ -315,7 +315,7 @@ package require \fBstruct::list ?1\&.8\&.6?\fR
 .sp
 \fB::struct::list\fR \fBiota\fR \fIn\fR
 .sp
-\fB::struct::list\fR \fBequal\fR \fIa\fR \fIb\fR
+\fB::struct::list\fR \fBequal\fR ?\fB-simple\fR? ?\fB--\fR? \fIa\fR \fIb\fR
 .sp
 \fB::struct::list\fR \fBrepeat\fR \fIsize\fR \fIelement1\fR ?\fIelement2\fR \fIelement3\fR\&.\&.\&.?
 .sp
@@ -723,11 +723,15 @@ of the list contain the number \fBi\fR\&.
 .sp
 For "\fIn\fR == \fB0\fR" an empty list will be returned\&.
 .TP
-\fB::struct::list\fR \fBequal\fR \fIa\fR \fIb\fR
+\fB::struct::list\fR \fBequal\fR ?\fB-simple\fR? ?\fB--\fR? \fIa\fR \fIb\fR
 The subcommand compares the two lists \fIa\fR and \fIb\fR for
 equality\&. In other words, they have to be of the same length and have
-to contain the same elements in the same order\&. If an element is a
-list the same definition of equality applies recursively\&.
+to contain the same elements in the same order\&.
+.sp
+By default equality checks are applied recursively to list elements which are lists themselves\&.
+This behaviour is disabled when specifying the option \fB-simple\fR\&.
+.sp
+The option \fB--\fR disables option processing even if the following argument looks like such\&.
 .sp
 A boolean value will be returned as the result of the command\&.
 This value will be \fBtrue\fR if the two lists are equal, and

idoc/man/files/modules/struct/struct_set.n

@@ -2,7 +2,7 @@
 '\" Generated from file 'struct_set\&.man' by tcllib/doctools with format 'nroff'
 '\" Copyright (c) 2004-2008 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>
 '\"
-.TH "struct::set" n 2\&.2\&.4 tcllib "Tcl Data Structures"
+.TH "struct::set" n 2\&.2\&.5 tcllib "Tcl Data Structures"
 .\" The -*- nroff -*- definitions below are for supplemental macros used
 .\" in Tcl/Tk manual entries.
 .\"

idoc/www/tcllib/files/modules/struct/struct_list.html

@@ -109,7 +109,7 @@
 &#124; <a href="../../../../toc2.html">Applications</a>
  ] <hr>
 <div class="doctools">
-<h1 class="doctools_title">struct::list(n) 1.8.6 tcllib &quot;Tcl Data Structures&quot;</h1>
+<h1 class="doctools_title">struct::list(n) 1.9 tcllib &quot;Tcl Data Structures&quot;</h1>
 <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
 <p>struct::list - Procedures for manipulating lists</p>
 </div>
@@ -132,7 +132,7 @@ <h1 class="doctools_title">struct::list(n) 1.8.6 tcllib &quot;Tcl Data Structure
 <div class="doctools_synopsis">
 <ul class="doctools_requirements">
 <li>package require <b class="pkgname">Tcl 8.5 9</b></li>
-<li>package require <b class="pkgname">struct::list <span class="opt">?1.8.6?</span></b></li>
+<li>package require <b class="pkgname">struct::list <span class="opt">?1.9?</span></b></li>
 </ul>
 <ul class="doctools_syntax">
 <li><a href="#1"><b class="cmd">::struct::list</b> <b class="method">longestCommonSubsequence</b> <i class="arg">sequence1</i> <i class="arg">sequence2</i> <span class="opt">?<i class="arg">maxOccurs</i>?</span></a></li>
@@ -153,7 +153,7 @@ <h1 class="doctools_title">struct::list(n) 1.8.6 tcllib &quot;Tcl Data Structure
 <li><a href="#16"><b class="cmd">::struct::list</b> <b class="method">fold</b> <i class="arg">sequence</i> <i class="arg">initialvalue</i> <i class="arg">cmdprefix</i></a></li>
 <li><a href="#17"><b class="cmd">::struct::list</b> <b class="method">shift</b> <i class="arg">listvar</i></a></li>
 <li><a href="#18"><b class="cmd">::struct::list</b> <b class="method">iota</b> <i class="arg">n</i></a></li>
-<li><a href="#19"><b class="cmd">::struct::list</b> <b class="method">equal</b> <i class="arg">a</i> <i class="arg">b</i></a></li>
+<li><a href="#19"><b class="cmd">::struct::list</b> <b class="method">equal</b> <span class="opt">?<b class="option">-simple</b>?</span> <span class="opt">?<b class="option">--</b>?</span> <i class="arg">a</i> <i class="arg">b</i></a></li>
 <li><a href="#20"><b class="cmd">::struct::list</b> <b class="method">repeat</b> <i class="arg">size</i> <i class="arg">element1</i> <span class="opt">?<i class="arg">element2</i> <i class="arg">element3</i>...?</span></a></li>
 <li><a href="#21"><b class="cmd">::struct::list</b> <b class="method">repeatn</b> <i class="arg">value</i> <i class="arg">size</i>...</a></li>
 <li><a href="#22"><b class="cmd">::struct::list</b> <b class="method">dbJoin</b> <span class="opt">?<b class="option">-inner</b>|<b class="option">-left</b>|<b class="option">-right</b>|<b class="option">-full</b>?</span> <span class="opt">?<b class="option">-keys</b> <i class="arg">varname</i>?</span> {<i class="arg">keycol</i> <i class="arg">table</i>}...</a></li>
@@ -468,11 +468,13 @@ <h1 class="doctools_title">struct::list(n) 1.8.6 tcllib &quot;Tcl Data Structure
 in the range <b class="const">[0,n)</b>. The element at index <b class="variable">i</b>
 of the list contain the number <b class="const">i</b>.</p>
 <p>For &quot;<i class="arg">n</i> == <b class="const">0</b>&quot; an empty list will be returned.</p></dd>
-<dt><a name="19"><b class="cmd">::struct::list</b> <b class="method">equal</b> <i class="arg">a</i> <i class="arg">b</i></a></dt>
+<dt><a name="19"><b class="cmd">::struct::list</b> <b class="method">equal</b> <span class="opt">?<b class="option">-simple</b>?</span> <span class="opt">?<b class="option">--</b>?</span> <i class="arg">a</i> <i class="arg">b</i></a></dt>
 <dd><p>The subcommand compares the two lists <i class="arg">a</i> and <i class="arg">b</i> for
 equality. In other words, they have to be of the same length and have
-to contain the same elements in the same order. If an element is a
-list the same definition of equality applies recursively.</p>
+to contain the same elements in the same order.</p>
+<p>By default equality checks are applied recursively to list elements which are lists themselves.
+This behaviour is disabled when specifying the option <b class="option">-simple</b>.</p>
+<p>The option <b class="option">--</b> disables option processing even if the following argument looks like such.</p>
 <p>A boolean value will be returned as the result of the command.
 This value will be <b class="const">true</b> if the two lists are equal, and
 <b class="const">false</b> else.</p></dd>

idoc/www/tcllib/files/modules/struct/struct_set.html

@@ -109,7 +109,7 @@
 &#124; <a href="../../../../toc2.html">Applications</a>
  ] <hr>
 <div class="doctools">
-<h1 class="doctools_title">struct::set(n) 2.2.4 tcllib &quot;Tcl Data Structures&quot;</h1>
+<h1 class="doctools_title">struct::set(n) 2.2.5 tcllib &quot;Tcl Data Structures&quot;</h1>
 <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
 <p>struct::set - Procedures for manipulating sets</p>
 </div>

modules/struct/list.tcl

@@ -9,8 +9,6 @@
 # See the file "license.terms" for information on usage and redistribution
 # of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 #
-# RCS: @(#) $Id: list.tcl,v 1.27 2011/09/17 14:35:36 mic42 Exp $
-#
 #----------------------------------------------------------------------
 
 package require Tcl 8.5 9
@@ -944,12 +942,39 @@ proc ::struct::list::Ldelete {var item} {
 # Side effects:
 #       None
 
-proc ::struct::list::Lequal {a b} {
+proc ::struct::list::Lequal {a b args} {
+    # Author of this command is "Richard Suchenwirth"
+
+    set args [::lreverse [::lassign [::lreverse [::list $a $b {*}$args]] a b]]
+    # a b args --> args a b
+    set recurse 1
+    while {[string match -* [set o [::lindex $args 0]]]} {
+	set args [::lrange $args 1 end]
+	switch -exact -- $o {
+	    --      break
+	    -simple { set recurse 0 }
+	    default {
+		return -code error "Bad option \"$o\", expected -simple, or --"
+	    }
+	}
+    }
+    if {[::llength $args]} {
+	return -code error "too many arguments after options"
+    }
+    return [EqualCore $recurse $a $b]
+}
+
+proc ::struct::list::EqualCore {recurse a b} {
     # Author of this command is "Richard Suchenwirth"
 
     if {[::llength $a] != [::llength $b]} {return 0}
     if {[::lindex $a 0] == $a && [::lindex $b 0] == $b} {return [string equal $a $b]}
-    foreach i $a j $b {if {![Lequal $i $j]} {return 0}}
+
+    if {$recurse} {
+	foreach i $a j $b {if {![EqualCore $recurse $i $j]} {return 0}}
+    } else {
+	foreach i $a j $b {if {$i ne $j} {return 0}}
+    }
     return 1
 }
 
@@ -1832,4 +1857,4 @@ namespace eval ::struct {
     namespace import -force list::list
     namespace export list
 }
-package provide struct::list 1.8.6
+package provide struct::list 1.9

modules/struct/list.test.tcl

@@ -731,6 +731,26 @@ proc ::struct::list::test::main {} {
 		expr {[equal $a $b] == [equal $b $a]}
 	} 1
 
+	test equal-4.10 {equal command, -simple} {
+		equal -simple [list [list a]] {{a}}
+	} 1
+
+	test equal-4.11 {equal command, too many arguments} -body {
+	    equal -simple a b c
+	} -returnCodes error -result {too many arguments after options}
+
+	test equal-4.12 {equal command, too many arguments} -body {
+	    equal a b c
+	} -returnCodes error -result {too many arguments after options}
+
+	test equal-4.13 {equal command, bad option} -body {
+	    equal -x a a
+	} -returnCodes error -result {Bad option "-x", expected -simple, or --}
+
+	test equal-4.14 {equal command, option break} -body {
+	    equal -- -a -a
+	} -result 1
+
 	#----------------------------------------------------------------------
 
 	interp alias {} delete {} ::struct::list::list delete

modules/struct/pkgIndex.tcl

@@ -7,17 +7,17 @@ package ifneeded struct::stack     1.5.4 [list source [file join $dir stack.tcl]
 package ifneeded struct::tree      2.1.3 [list source [file join $dir tree.tcl]]
 package ifneeded struct::pool      1.2.4 [list source [file join $dir pool.tcl]]
 package ifneeded struct::record    1.2.4 [list source [file join $dir record.tcl]]
-package ifneeded struct::set       2.2.4 [list source [file join $dir sets.tcl]]
+package ifneeded struct::set       2.2.5 [list source [file join $dir sets.tcl]]
 package ifneeded struct::prioqueue 1.5   [list source [file join $dir prioqueue.tcl]]
 package ifneeded struct::skiplist  1.4   [list source [file join $dir skiplist.tcl]]
 
 package ifneeded struct::graph     1.2.2 [list source [file join $dir graph1.tcl]]
 package ifneeded struct::tree      1.2.3 [list source [file join $dir tree1.tcl]]
 
-package ifneeded struct::list        1.8.6  [list source [file join $dir list.tcl]]
-package ifneeded struct::list::test  1.8.5  [list source [file join $dir list.test.tcl]]
-package ifneeded struct::graph     2.4.4  [list source [file join $dir graph.tcl]]
-package ifneeded struct::map       1.1    [list source [file join $dir map.tcl]]
+package ifneeded struct::list       1.89   [list source [file join $dir list.tcl]]
+package ifneeded struct::list::test 1.8.5  [list source [file join $dir list.test.tcl]]
+package ifneeded struct::graph      2.4.4  [list source [file join $dir graph.tcl]]
+package ifneeded struct::map        1.1    [list source [file join $dir map.tcl]]
 
 package ifneeded struct::matrix    2.2 [list source [file join $dir matrix.tcl]]
 

modules/struct/sets.tcl

@@ -9,8 +9,6 @@
 # See the file "license.terms" for information on usage and redistribution
 # of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 #
-# RCS: @(#) $Id: sets.tcl,v 1.17 2008/03/09 04:24:37 andreas_kupries Exp $
-#
 #----------------------------------------------------------------------
 
 # @mdgen EXCLUDE: sets_c.tcl
@@ -184,4 +182,4 @@ namespace eval ::struct {
     namespace export set
 }
 
-package provide struct::set 2.2.4
+package provide struct::set 2.2.5