[thirdparty/binutils-gdb.git] / binutils / testsuite / lib / binutils-common.exp

# Copyright (C) 1993-2016 Free Software Foundation, Inc.
#
# This file is part of the GNU Binutils.
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
# MA 02110-1301, USA.

# True if the object format is known to be ELF.
#
proc is_elf_format {} {
    # config.sub for these targets curiously transforms a target doublet
    # ending in -elf to -none.  eg. m68hc12-elf to m68hc12-unknown-none
    # They are always elf.
    if { [istarget m68hc1*-*] || [istarget xgate-*] } {
	return 1;
    }

    if {    ![istarget *-*-eabi*]
	 && ![istarget *-*-elf*]
	 && ![istarget *-*-freebsd*]
	 && ![istarget *-*-gnu*]
	 && ![istarget *-*-irix5*]
	 && ![istarget *-*-irix6*]
	 && ![istarget *-*-linux*]
	 && ![istarget *-*-nacl*]
	 && ![istarget *-*-netbsd*]
	 && ![istarget *-*-openbsd*]
	 && ![istarget *-*-rtems*]
	 && ![istarget *-*-solaris2*]
	 && ![istarget *-*-sysv4*]
	 && ![istarget *-*-unixware*]
	 && ![istarget avr-*-*]
	 && ![istarget bfin-*-uclinux]
	 && ![istarget frv-*-uclinux*]
	 && ![istarget hppa*64*-*-hpux*]
	 && ![istarget ia64-*-hpux*]
	 && ![istarget sh*-*-uclinux*]
	 && ![istarget tic6x*-*-uclinux*] } {
	return 0
    }

    if {    [istarget *-*-linux*aout*]
	 || [istarget *-*-linux*ecoff*]
	 || [istarget *-*-linux*oldld*]
	 || [istarget *-*-rtemscoff*]
	 || [istarget h8500-*-rtems*]
	 || [istarget i?86-*-freebsd\[12\].*]
	 || [istarget i960-*-rtems*] } {
	return 0
    }

    if { ![istarget *-*-netbsdelf*]
	 && (   [istarget *-*-netbsd*aout*]
	     || [istarget *-*-netbsdpe*]
	     || [istarget arm*-*-netbsd*]
	     || [istarget sparc-*-netbsd*]
	     || [istarget i*86-*-netbsd*]
	     || [istarget m68*-*-netbsd*]
	     || [istarget vax-*-netbsd*]
	     || [istarget ns32k-*-netbsd*]) } {
    	return 0
    }

    if {    [istarget arm-*-openbsd*]
	 || [istarget i386-*-openbsd\[0-2\].*]
	 || [istarget i386-*-openbsd3.\[0-2\]]
	 || [istarget m68*-*-openbsd*]
	 || [istarget ns32k-*-openbsd*]
	 || [istarget sparc-*-openbsd\[0-2\].*]
	 || [istarget sparc-*-openbsd3.\[0-1\]]
	 || [istarget vax-*-openbsd*] } {
	return 0
    }

    return 1
}

# True if the object format is known to be a.out.
#
proc is_aout_format {} {
    if { [istarget *-*-netbsdelf]
	 || [istarget sparc64-*-netbsd*]
	 || [istarget sparc64-*-openbsd*] } {
	return 0
    }
    if { [istarget *-*-*\[ab\]out*]
	 || [istarget *-*-linux*oldld*]
	 || [istarget *-*-bsd*]
	 || [istarget *-*-msdos*]
	 || [istarget arm-*-netbsd*]
	 || [istarget arm-*-openbsd*]
	 || [istarget arm-*-riscix*]
	 || [istarget i?86-*-freebsd\[12\].*]
	 || [istarget i?86-*-netbsd*]
	 || [istarget i?86-*-openbsd\[0-2\]*]
	 || [istarget i?86-*-openbsd3.\[0-2\]*]
	 || [istarget i?86-*-vsta]
	 || [istarget i?86-*-mach*]
	 || [istarget m68*-*-netbsd*]
	 || [istarget m68*-*-openbsd*]
	 || [istarget ns32k-*-*]
	 || [istarget pdp11-*-*]
	 || [istarget sparc*-*-sunos4*]
	 || [istarget sparc*-*-netbsd*]
	 || [istarget sparc*-*-openbsd\[0-2\]*]
	 || [istarget sparc*-*-openbsd3.\[0-1\]*]
	 || [istarget sparc*-fujitsu-none]
	 || [istarget vax-dec-ultrix*]
	 || [istarget vax-*-netbsd] } {
	return 1
    }
    return 0
}

# True if the object format is known to be PE COFF.
#
proc is_pecoff_format {} {
    if { ![istarget *-*-mingw*]
	 && ![istarget *-*-cygwin*]
	 && ![istarget *-*-cegcc*]
	 && ![istarget *-*-pe*] } {
	return 0
    }

    return 1
}

# True if the object format is known to be 64-bit ELF.
#
proc is_elf64 { binary_file } {
    global READELF
    global READELFFLAGS

    set readelf_size ""
    catch "exec $READELF $READELFFLAGS -h $binary_file > readelf.out" got

    if ![string match "" $got] then {
	return 0
    }

    if { ![regexp "\n\[ \]*Class:\[ \]*ELF(\[0-9\]+)\n" \
	   [file_contents readelf.out] nil readelf_size] } {
	return 0
    }

    if { $readelf_size == "64" } {
	return 1
    }

    return 0
}

# True if the ELF target supports STB_GNU_UNIQUE with the ELF header's
# OSABI field set to ELFOSABI_GNU.
#
# This generally depends on the target OS only, however there are a
# number of exceptions for bare metal targets as follows.  The MSP430
# and Visium targets set OSABI to ELFOSABI_STANDALONE and cannot
# support STB_GNU_UNIQUE.  Likewise non-EABI ARM targets set OSABI to
# ELFOSABI_ARM, and TI C6X targets to ELFOSABI_C6000_*.  Finally
# rather than `bfd_elf_final_link' AM33/2.0, D30V, DLX, i960, and
# picoJava targets use `_bfd_generic_final_link', which does not
# support STB_GNU_UNIQUE symbol binding causing assertion failures.
#
proc supports_gnu_unique {} {
    if { [istarget *-*-gnu*]
	 || [istarget *-*-linux*]
	 || [istarget *-*-nacl*] } {
	return 1
    }
    if { [istarget "arm*-*-*eabi*"] } {
	return 1
    }
    if { ![istarget "*-*-elf*"] } {
	return 0
    }
    if { [istarget "arm*-*-*"]
	 || [istarget "msp430-*-*"]
	 || [istarget "tic6x-*-*"]
	 || [istarget "visium-*-*"] } {
	return 0
    }
    if { [istarget "am33_2.0-*-*"]
	 || [istarget "d30v-*-*"]
	 || [istarget "dlx-*-*"]
	 || [istarget "i960-*-*"]
	 || [istarget "pj*-*-*"] } {
	return 0
    }
    return 1
}

# True for targets that do not sort .symtab as per the ELF standard.
# ie. any that have mips_elf32_be_vec, mips_elf32_le_vec,
# mips_elf32_n_be_vec or mips_elf32_n_le_vec as the primary bfd target
# vector in config.bfd.  When syncing with config.bfd, don't forget that
# earlier case-matches trump later ones.
proc is_bad_symtab {} {
    if { ![istarget "mips*-*-*"] } {
	return 0;
    }
    if { [istarget "*-*-chorus*"]
	 || [istarget "*-*-irix5*"]
	 || [istarget "*-*-irix6*"]
	 || [istarget "*-*-none"]
	 || [istarget "*-*-rtems*"]
	 || [istarget "*-*-windiss"] } {
	return 1;
    }
    if { [istarget "*-*-elf*"]
	 && ![istarget "*-sde-*"]
	 && ![istarget "*-mti-*"]
	 && ![istarget "*-img-*"] } {
	return 1;
    }
    if { [istarget "*-*-openbsd*"]
	 && ![istarget "mips64*-*-*"] } {
	return 1;
    }
    return 0;
}

# Compare two files line-by-line.  FILE_1 is the actual output and FILE_2
# is the expected output.  Ignore blank lines in either file.
#
# FILE_2 is a series of regexps, comments and # directives.  The directives
# are:
#
#    #pass
#        Treat the test as a PASS if everything up till this point has
#        matched.  Ignore any remaining lines in either FILE_1 or FILE_2.
#
#    #failif
#        Reverse the sense of the test: expect differences to exist.
#
#    #...
#    REGEXP
#        Skip all lines in FILE_1 until the first that matches REGEXP.
#
# Other # lines are comments.  Regexp lines starting with the `!' character
# specify inverse matching (use `\!' for literal matching against a leading
# `!').  Skip empty lines in both files.
#
# The first optional argument is a list of regexp substitutions of the form:
#
#    EXP1 SUBSPEC1 EXP2 SUBSPEC2 ...
#
# This tells the function to apply each regexp substitution EXPi->SUBSPECi
# in order to every line of FILE_2.
#
# Return nonzero if differences exist.
proc regexp_diff { file_1 file_2 args } {
    set eof -1
    set end_1 0
    set end_2 0
    set differences 0
    set diff_pass 0
    set fail_if_match 0
    set ref_subst ""
    if { [llength $args] > 0 } {
	set ref_subst [lindex $args 0]
    }
    if { [llength $args] > 1 } {
	perror "Too many arguments to regexp_diff"
	return 1
    }

    if [file exists $file_1] then {
	set file_a [open $file_1 r]
    } else {
	perror "$file_1 doesn't exist"
	return 1
    }

    if [file exists $file_2] then {
	set file_b [open $file_2 r]
    } else {
	perror "$file_2 doesn't exist"
	close $file_a
	return 1
    }

    verbose " Regexp-diff'ing: $file_1 $file_2" 2

    while { 1 } {
	set line_a ""
	set line_b ""
	while { [string length $line_a] == 0 } {
	    # Ignore blank line in FILE_1.
	    if { [gets $file_a line_a] == $eof } {
		set end_1 1
		break
	    }
	}
	while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
	    if { [string match "#pass" $line_b] } {
		set end_2 1
		set diff_pass 1
		break
	    } elseif { [string match "#failif" $line_b] } {
		send_log "fail if no difference\n"
		verbose "fail if no difference" 3
		set fail_if_match 1
	    } elseif { [string match "#..." $line_b] } {
		if { [gets $file_b line_b] == $eof } {
		    set end_2 1
		    set diff_pass 1
		    break
		}
		set negated [expr { [string index $line_b 0] == "!" }]
		set line_bx [string range $line_b $negated end]
		set n [expr { $negated ? "! " : "" }]
		# Substitute on the reference.
		foreach {name value} $ref_subst {
		    regsub -- $name $line_bx $value line_bx
		}
		verbose "looking for $n\"^$line_bx$\"" 3
		while { [expr [regexp "^$line_bx$" "$line_a"] == $negated] } {
		    verbose "skipping    \"$line_a\"" 3
		    if { [gets $file_a line_a] == $eof } {
			set end_1 1
			break
		    }
		}
		break
	    }
	    if { [gets $file_b line_b] == $eof } {
		set end_2 1
		break
	    }
	}

	if { $diff_pass } {
	    break
	} elseif { $end_1 && $end_2 } {
	    break
	} elseif { $end_1 } {
	    send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
	    verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
	    set differences 1
	    break
	} elseif { $end_2 } {
	    send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
	    verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
	    set differences 1
	    break
	} else {
	    set negated [expr { [string index $line_b 0] == "!" }]
	    set line_bx [string range $line_b $negated end]
	    set n [expr { $negated ? "! " : "" }]
	    set s [expr { $negated ? "  " : "" }]
	    # Substitute on the reference.
	    foreach {name value} $ref_subst {
		regsub -- $name $line_bx $value line_bx
	    }
	    verbose "regexp $n\"^$line_bx$\"\nline   \"$line_a\"" 3
	    if { [expr [regexp "^$line_bx$" "$line_a"] == $negated] } {
		send_log "regexp_diff match failure\n"
		send_log "regexp $n\"^$line_bx$\"\nline   $s\"$line_a\"\n"
		verbose "regexp_diff match failure\n" 3
		set differences 1
	    }
	}
    }

    if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
	send_log "$file_1 and $file_2 are different lengths\n"
	verbose "$file_1 and $file_2 are different lengths" 3
	set differences 1
    }

    if { $fail_if_match } {
	if { $differences == 0 } {
	    set differences 1
	} else {
	    set differences 0
	}
    }

    close $file_a
    close $file_b

    return $differences
}
Commit	Line	Data
6f2750fe	1	# Copyright (C) 1993-2016 Free Software Foundation, Inc.
f3097f33 RS	2	#
	3	# This file is part of the GNU Binutils.
	4	#
	5	# This file is free software; you can redistribute it and/or modify
	6	# it under the terms of the GNU General Public License as published by
	7	# the Free Software Foundation; either version 3 of the License, or
	8	# (at your option) any later version.
	9	#
	10	# This program is distributed in the hope that it will be useful,
	11	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	# GNU General Public License for more details.
	14	#
	15	# You should have received a copy of the GNU General Public License
	16	# along with this program; if not, write to the Free Software
	17	# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
	18	# MA 02110-1301, USA.
	19
	20	# True if the object format is known to be ELF.
	21	#
	22	proc is_elf_format {} {
b3066ae8 AM	23	# config.sub for these targets curiously transforms a target doublet
	24	# ending in -elf to -none. eg. m68hc12-elf to m68hc12-unknown-none
	25	# They are always elf.
	26	if { [istarget m68hc1-] \|\| [istarget xgate-*] } {
	27	return 1;
	28	}
	29
4a85cc09	30	if { ![istarget --eabi*]
f3097f33	31	&& ![istarget --elf*]
4a85cc09	32	&& ![istarget --freebsd*]
f3097f33	33	&& ![istarget --gnu*]
f3097f33 RS	34	&& ![istarget --irix5*]
f3097f33 RS	35	&& ![istarget --irix6*]
4a85cc09 SKS	36	&& ![istarget --linux*]
4a85cc09 SKS	37	&& ![istarget --nacl*]
f3097f33 RS	38	&& ![istarget --netbsd*]
f3097f33 RS	39	&& ![istarget --openbsd*]
4a85cc09 SKS	40	&& ![istarget --rtems*]
	41	&& ![istarget --solaris2*]
	42	&& ![istarget --sysv4*]
	43	&& ![istarget --unixware*]
	44	&& ![istarget avr--]
	45	&& ![istarget bfin-*-uclinux]
	46	&& ![istarget frv--uclinux]
	47	&& ![istarget hppa64--hpux]
	48	&& ![istarget ia64--hpux]
	49	&& ![istarget sh--uclinux*]
	50	&& ![istarget tic6x--uclinux*] } {
f3097f33 RS	51	return 0
	52	}
	53
4a85cc09	54	if { [istarget --linuxaout]
df26367c	55	\|\| [istarget --linuxecoff]
f3097f33	56	\|\| [istarget --linuxoldld]
4a85cc09	57	\|\| [istarget --rtemscoff*]
f3097f33	58	\|\| [istarget h8500--rtems]
4a85cc09 SKS	59	\|\| [istarget i?86--freebsd\[12\].]
4a85cc09 SKS	60	\|\| [istarget i960--rtems] } {
f3097f33 RS	61	return 0
	62	}
	63
	64	if { ![istarget --netbsdelf*]
4a85cc09	65	&& ( [istarget --netbsdaout]
f3097f33 RS	66	\|\| [istarget --netbsdpe*]
	67	\|\| [istarget arm--netbsd*]
	68	\|\| [istarget sparc--netbsd]
	69	\|\| [istarget i86--netbsd*]
	70	\|\| [istarget m68--netbsd*]
	71	\|\| [istarget vax--netbsd]
	72	\|\| [istarget ns32k--netbsd]) } {
	73	return 0
	74	}
	75
4a85cc09	76	if { [istarget arm--openbsd]
f3097f33 RS	77	\|\| [istarget i386--openbsd\[0-2\].]
	78	\|\| [istarget i386-*-openbsd3.\[0-2\]]
	79	\|\| [istarget m68--openbsd*]
	80	\|\| [istarget ns32k--openbsd]
	81	\|\| [istarget sparc--openbsd\[0-2\].]
	82	\|\| [istarget sparc-*-openbsd3.\[0-1\]]
	83	\|\| [istarget vax--openbsd] } {
	84	return 0
	85	}
	86
	87	return 1
	88	}
	89
	90	# True if the object format is known to be a.out.
	91	#
	92	proc is_aout_format {} {
	93	if { [istarget --netbsdelf]
	94	\|\| [istarget sparc64--netbsd]
	95	\|\| [istarget sparc64--openbsd] } {
	96	return 0
	97	}
	98	if { [istarget --\[ab\]out]
	99	\|\| [istarget --linuxoldld]
	100	\|\| [istarget --bsd*]
	101	\|\| [istarget --msdos*]
	102	\|\| [istarget arm--netbsd]
	103	\|\| [istarget arm--openbsd]
	104	\|\| [istarget arm--riscix]
7e16ef34	105	\|\| [istarget i?86--freebsd\[12\].]
f3097f33 RS	106	\|\| [istarget i?86--netbsd]
	107	\|\| [istarget i?86--openbsd\[0-2\]]
	108	\|\| [istarget i?86--openbsd3.\[0-2\]]
	109	\|\| [istarget i?86-*-vsta]
	110	\|\| [istarget i?86--mach]
	111	\|\| [istarget m68--netbsd*]
	112	\|\| [istarget m68--openbsd*]
	113	\|\| [istarget ns32k--]
	114	\|\| [istarget pdp11--]
	115	\|\| [istarget sparc--sunos4*]
	116	\|\| [istarget sparc--netbsd*]
	117	\|\| [istarget sparc--openbsd\[0-2\]*]
	118	\|\| [istarget sparc--openbsd3.\[0-1\]*]
	119	\|\| [istarget sparc*-fujitsu-none]
	120	\|\| [istarget vax-dec-ultrix*]
	121	\|\| [istarget vax-*-netbsd] } {
	122	return 1
	123	}
	124	return 0
	125	}
	126
	127	# True if the object format is known to be PE COFF.
	128	#
	129	proc is_pecoff_format {} {
	130	if { ![istarget --mingw*]
	131	&& ![istarget --cygwin*]
	132	&& ![istarget --cegcc*]
	133	&& ![istarget --pe*] } {
	134	return 0
	135	}
	136
	137	return 1
	138	}
	139
	140	# True if the object format is known to be 64-bit ELF.
	141	#
	142	proc is_elf64 { binary_file } {
	143	global READELF
	144	global READELFFLAGS
	145
	146	set readelf_size ""
	147	catch "exec $READELF $READELFFLAGS -h $binary_file > readelf.out" got
	148
	149	if ![string match "" $got] then {
	150	return 0
	151	}
	152
	153	if { ![regexp "\n\[ \]Class:\[ \]ELF(\[0-9\]+)\n" \
	154	[file_contents readelf.out] nil readelf_size] } {
	155	return 0
	156	}
	157
	158	if { $readelf_size == "64" } {
	159	return 1
	160	}
	161
	162	return 0
	163	}
eb22018c	164
a43942db MR	165	# True if the ELF target supports STB_GNU_UNIQUE with the ELF header's
	166	# OSABI field set to ELFOSABI_GNU.
	167	#
	168	# This generally depends on the target OS only, however there are a
	169	# number of exceptions for bare metal targets as follows. The MSP430
	170	# and Visium targets set OSABI to ELFOSABI_STANDALONE and cannot
	171	# support STB_GNU_UNIQUE. Likewise non-EABI ARM targets set OSABI to
	172	# ELFOSABI_ARM, and TI C6X targets to ELFOSABI_C6000_*. Finally
	173	# rather than `bfd_elf_final_link' AM33/2.0, D30V, DLX, i960, and
	174	# picoJava targets use `_bfd_generic_final_link', which does not
	175	# support STB_GNU_UNIQUE symbol binding causing assertion failures.
	176	#
	177	proc supports_gnu_unique {} {
	178	if { [istarget --gnu*]
	179	\|\| [istarget --linux*]
	180	\|\| [istarget --nacl*] } {
	181	return 1
	182	}
	183	if { [istarget "arm--eabi"] } {
	184	return 1
	185	}
	186	if { ![istarget "--elf*"] } {
	187	return 0
	188	}
	189	if { [istarget "arm--*"]
	190	\|\| [istarget "msp430--"]
	191	\|\| [istarget "tic6x--"]
	192	\|\| [istarget "visium--"] } {
	193	return 0
	194	}
	195	if { [istarget "am33_2.0--"]
	196	\|\| [istarget "d30v--"]
	197	\|\| [istarget "dlx--"]
	198	\|\| [istarget "i960--"]
	199	\|\| [istarget "pj--*"] } {
	200	return 0
	201	}
	202	return 1
	203	}
	204
9cc0123f AM	205	# True for targets that do not sort .symtab as per the ELF standard.
	206	# ie. any that have mips_elf32_be_vec, mips_elf32_le_vec,
	207	# mips_elf32_n_be_vec or mips_elf32_n_le_vec as the primary bfd target
	208	# vector in config.bfd. When syncing with config.bfd, don't forget that
	209	# earlier case-matches trump later ones.
	210	proc is_bad_symtab {} {
	211	if { ![istarget "mips--*"] } {
	212	return 0;
	213	}
	214	if { [istarget "--chorus*"]
	215	\|\| [istarget "--irix5*"]
	216	\|\| [istarget "--irix6*"]
	217	\|\| [istarget "--none"]
	218	\|\| [istarget "--rtems*"]
	219	\|\| [istarget "--windiss"] } {
	220	return 1;
	221	}
	222	if { [istarget "--elf*"]
	223	&& ![istarget "-sde-"]
	224	&& ![istarget "-mti-"]
	225	&& ![istarget "-img-"] } {
	226	return 1;
	227	}
	228	if { [istarget "--openbsd*"]
	229	&& ![istarget "mips64--*"] } {
	230	return 1;
	231	}
	232	return 0;
	233	}
	234
eb22018c RS	235	# Compare two files line-by-line. FILE_1 is the actual output and FILE_2
	236	# is the expected output. Ignore blank lines in either file.
	237	#
	238	# FILE_2 is a series of regexps, comments and # directives. The directives
	239	# are:
	240	#
	241	# #pass
	242	# Treat the test as a PASS if everything up till this point has
	243	# matched. Ignore any remaining lines in either FILE_1 or FILE_2.
	244	#
	245	# #failif
	246	# Reverse the sense of the test: expect differences to exist.
	247	#
	248	# #...
	249	# REGEXP
	250	# Skip all lines in FILE_1 until the first that matches REGEXP.
	251	#
738f4d98 MR	252	# Other # lines are comments. Regexp lines starting with the `!' character
	253	# specify inverse matching (use `\!' for literal matching against a leading
	254	# `!'). Skip empty lines in both files.
eb22018c RS	255	#
	256	# The first optional argument is a list of regexp substitutions of the form:
	257	#
	258	# EXP1 SUBSPEC1 EXP2 SUBSPEC2 ...
	259	#
	260	# This tells the function to apply each regexp substitution EXPi->SUBSPECi
	261	# in order to every line of FILE_2.
	262	#
	263	# Return nonzero if differences exist.
	264	proc regexp_diff { file_1 file_2 args } {
	265	set eof -1
	266	set end_1 0
	267	set end_2 0
	268	set differences 0
	269	set diff_pass 0
	270	set fail_if_match 0
	271	set ref_subst ""
	272	if { [llength $args] > 0 } {
	273	set ref_subst [lindex $args 0]
	274	}
	275	if { [llength $args] > 1 } {
	276	perror "Too many arguments to regexp_diff"
	277	return 1
	278	}
	279
	280	if [file exists $file_1] then {
	281	set file_a [open $file_1 r]
	282	} else {
	283	perror "$file_1 doesn't exist"
	284	return 1
	285	}
	286
	287	if [file exists $file_2] then {
	288	set file_b [open $file_2 r]
	289	} else {
	290	perror "$file_2 doesn't exist"
	291	close $file_a
	292	return 1
	293	}
	294
	295	verbose " Regexp-diff'ing: $file_1 $file_2" 2
	296
	297	while { 1 } {
	298	set line_a ""
	299	set line_b ""
	300	while { [string length $line_a] == 0 } {
	301	# Ignore blank line in FILE_1.
	302	if { [gets $file_a line_a] == $eof } {
	303	set end_1 1
	304	break
	305	}
	306	}
	307	while { [string length $line_b] == 0 \|\| [string match "#*" $line_b] } {
	308	if { [string match "#pass" $line_b] } {
	309	set end_2 1
	310	set diff_pass 1
	311	break
	312	} elseif { [string match "#failif" $line_b] } {
	313	send_log "fail if no difference\n"
	314	verbose "fail if no difference" 3
	315	set fail_if_match 1
	316	} elseif { [string match "#..." $line_b] } {
	317	if { [gets $file_b line_b] == $eof } {
	318	set end_2 1
319	set diff_pass 1
320	break
321	}
47a50e5b	322	set negated [expr { [string index $line_b 0] == "!" }]
738f4d98 MR	323	set line_bx [string range $line_b $negated end]
738f4d98 MR	324	set n [expr { $negated ? "! " : "" }]
eb22018c RS	325	# Substitute on the reference.
eb22018c RS	326	foreach {name value} $ref_subst {
738f4d98	327	regsub -- $name $line_bx $value line_bx
eb22018c	328	}
738f4d98 MR	329	verbose "looking for $n\"^$line_bx$\"" 3
738f4d98 MR	330	while { [expr [regexp "^$line_bx$" "$line_a"] == $negated] } {
eb22018c RS	331	verbose "skipping \"$line_a\"" 3
	332	if { [gets $file_a line_a] == $eof } {
	333	set end_1 1
	334	break
	335	}
	336	}
	337	break
	338	}
	339	if { [gets $file_b line_b] == $eof } {
	340	set end_2 1
	341	break
	342	}
	343	}
	344
	345	if { $diff_pass } {
	346	break
	347	} elseif { $end_1 && $end_2 } {
	348	break
	349	} elseif { $end_1 } {
	350	send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
	351	verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
	352	set differences 1
	353	break
	354	} elseif { $end_2 } {
	355	send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
	356	verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
	357	set differences 1
	358	break
	359	} else {
47a50e5b	360	set negated [expr { [string index $line_b 0] == "!" }]
738f4d98 MR	361	set line_bx [string range $line_b $negated end]
	362	set n [expr { $negated ? "! " : "" }]
	363	set s [expr { $negated ? " " : "" }]
eb22018c RS	364	# Substitute on the reference.
eb22018c RS	365	foreach {name value} $ref_subst {
738f4d98	366	regsub -- $name $line_bx $value line_bx
eb22018c	367	}
738f4d98 MR	368	verbose "regexp $n\"^$line_bx$\"\nline \"$line_a\"" 3
738f4d98 MR	369	if { [expr [regexp "^$line_bx$" "$line_a"] == $negated] } {
eb22018c	370	send_log "regexp_diff match failure\n"
738f4d98	371	send_log "regexp $n\"^$line_bx$\"\nline $s\"$line_a\"\n"
eb22018c RS	372	verbose "regexp_diff match failure\n" 3
	373	set differences 1
	374	}
	375	}
	376	}
	377
	378	if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
	379	send_log "$file_1 and $file_2 are different lengths\n"
	380	verbose "$file_1 and $file_2 are different lengths" 3
	381	set differences 1
	382	}
	383
	384	if { $fail_if_match } {
	385	if { $differences == 0 } {
	386	set differences 1
	387	} else {
	388	set differences 0
	389	}
	390	}
	391
	392	close $file_a
	393	close $file_b
	394
	395	return $differences
	396	}