Testsuite: Support a list of possible compare files

The 'compare_file' procedure could be updated to check whether the
'expected' argument is a list, but in the meantime, this adds a new
'compare_file_list' procedure that takes a list argument and passes
if any one in the list matches.

This is used in one test where BSC built with GHC 9.12.1 has _tcdict
defs in a different order.  The test now compares against both
possible outputs.

Author: quark17

testsuite/bsc.typechecker/dontcare/DummyInDeflQual.bs.bsc-out.expected testsuite/bsc.typechecker/dontcare/DummyInDeflQual.bs.bsc-out.0.expected

@@ -0,0 +1,49 @@
+checking package dependencies
+compiling DummyInDeflQual.bs
+Warning: "DummyInDeflQual.bs", line 5, column 10: (P0223)
+  Definition of `x' is not used.
+=== internal:
+IPackage DummyInDeflQual
+  --linked packages
+
+  --pragmas 
+
+  --idefs 
+DummyInDeflQual.dummyInDeflQual :: Prelude.Bit 12
+DummyInDeflQual.dummyInDeflQual =
+  let _tcdict1072 :: Prelude.Literal (Prelude.Bit 12)
+      _tcdict1072 = Prelude.Prelude.Literal~Prelude.Bit~n= ·12
+      -- IdProp: _tcdict1072[IdP_bad_name,IdPDict]
+  in  let f ::
+	    \/(_tctyvar1063 :: *) .
+	    \/(_tctyvar1064 :: *) . Prelude.Literal _tctyvar1063 -> _tctyvar1064 -> _tctyvar1063
+	  f =
+	    /\ (_tctyvar1063 :: *) .
+	    /\ (_tctyvar1064 :: *) .
+	    \ (_tcdict1050 :: Prelude.Literal _tctyvar1063) .
+	    let _tcdict1032 :: Prelude.Eq (Prelude.Bit 2)
+		_tcdict1032 = Prelude.Prelude.Eq~Prelude.Bit~n= ·2
+		-- IdProp: _tcdict1032[IdP_bad_name,IdPDict]
+	    in  let _tcdict1042 :: Prelude.Literal (Prelude.Bit 2)
+		    _tcdict1042 = Prelude.Prelude.Literal~Prelude.Bit~n= ·2
+		    -- IdProp: _tcdict1042[IdP_bad_name,IdPDict]
+		in  \ (x :: _tctyvar1064) .
+		    PrimIf
+		      ·_tctyvar1063
+		      (PrimOrd
+			 ·Prelude.Bool
+			 ·1
+			 (.(Prelude.==)
+			    ·(Prelude.Bit 2)
+			    _tcdict1032
+			    (PrimBuildUndefined ·(Prelude.Bit 2) _ 1)
+			    (.Prelude.fromInteger ·(Prelude.Bit 2) _tcdict1042 0b11)))
+		      (.Prelude.fromInteger ·_tctyvar1063 _tcdict1050 0)
+		      (PrimBuildUndefined ·_tctyvar1063 (PrimGetEvalPosition ·_tctyvar1064 x) 2)
+      in  f ·(Prelude.Bit 12) ·Prelude.Bool _tcdict1072 (Prelude.True Prelude.PrimUnit)
+next def..........................................................
+
+
+-----
+
+All packages are up to date.

testsuite/bsc.typechecker/dontcare/DummyInDeflQual.bs.bsc-out.1.expected

@@ -45,8 +45,12 @@ compare_file DummyInDef.bs.bsc-out
 compile_pass DummyInDefOp.bs "-dinternal"
 compare_file DummyInDefOp.bs.bsc-out
 
+# The order of _tcdict<n> defs changed in GHC 9.12.1
+# Test that the output matches one of the possible outputs
 compile_pass DummyInDeflQual.bs "-dinternal"
-compare_file DummyInDeflQual.bs.bsc-out
+compare_file_list DummyInDeflQual.bs.bsc-out \
+    {DummyInDeflQual.bs.bsc-out.0.expected \
+     DummyInDeflQual.bs.bsc-out.1.expected}
 
 if {$vtest == 1} {
 compile_verilog_pass DummyInRuleQual.bs sysDummyInRuleQual "-dATS"

testsuite/bsc.typechecker/dontcare/dontcare.exp

@@ -930,8 +930,12 @@ proc make_bsc_sched_output_name { source } {
     return $filename
 }
 
-proc make_diff_output_name { source } {
-    set filename "$source.diff-out"
+proc make_diff_output_name { source {tag ""} } {
+    if {[string compare $tag ""] == 0} {
+        set filename "$source.diff-out"
+    } else {
+        set filename "$source.$tag.diff-out"
+    }
     return $filename
 }
 
@@ -2124,14 +2128,7 @@ proc compare_file { filename {expected ""} {stat "compare_file"}} {
     }
     set output [make_diff_output_name $filename]
 
-    set diff_flags "-u"
-
-    set ignore_pattern [format "-I \"SystemC\" -I \"dumpfile parameter\"" ]
-
-    set cmd "diff $diff_flags -b $ignore_pattern $expected $filename >& $output"
-    verbose "Diffing: $cmd" 2
-
-    set diff_status [catch "exec $cmd"]
+    set diff_status [compare_file_core $filename $expected $output]
 
     if { $diff_status == 0 } {
         set status 0
@@ -2146,6 +2143,55 @@ proc compare_file { filename {expected ""} {stat "compare_file"}} {
     return $status
 }
 
+proc compare_file_list { filename expected_list {stat "compare_file_list"}} {
+    global srcdir
+    global subdir
+
+    incr_stat $stat
+
+    set here [absolute $srcdir]
+    cd [file join $here $subdir]
+
+    set status 1
+    set n 0
+    foreach expected $expected_list {
+
+        set output [make_diff_output_name $filename "option$n"]
+
+        set diff_status [compare_file_core $filename $expected $output]
+
+        if { $diff_status == 0 } {
+            set status 0
+            pass "`$filename' identical to `$expected'"
+            file delete -force $output
+            # Exit the foreach loop
+            break
+        }
+
+        incr n
+    }
+
+    if { $status == 1 } {
+        fail "`$filename' differs from list of possible expected files"
+        set output_pat [make_diff_output_name $filename {*}]
+        verbose -log "(Differences written to `[file join $subdir $output_pat]')" 1
+    }
+
+    cd $here
+    return $status
+}
+
+proc compare_file_core { filename expected output } {
+
+    set diff_flags "-u"
+    set ignore_pattern [format "-I \"SystemC\" -I \"dumpfile parameter\"" ]
+
+    set cmd "diff $diff_flags -b $ignore_pattern $expected $filename >& $output"
+    verbose "Diffing: $cmd" 2
+
+    return [catch "exec $cmd"]
+}
+
 # compare 2 files, first filtering through a sed script
 proc compare_file_filtered { output {expected ""} {bre_options ""} {ere_options ""} } {