-;;;; strings.test --- test suite for Guile's string functions -*- scheme -*-
-;;;; Jim Blandy <jimb@red-bean.com> --- August 1999
-;;;;
-;;;; Copyright (C) 1999 Free Software Foundation, Inc.
-;;;;
-;;;; This program 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 2, 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 software; see the file COPYING. If not, write to
-;;;; the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
-;;;; Boston, MA 02111-1307 USA
-
-(use-modules (test-suite lib))
-
-(pass-if "string<? respects string length"
- (not (string<? "foo\0" "foo")))
-(pass-if "string-ci<? respects string length"
- (not (string-ci<? "foo\0" "foo")))
-(pass-if "substring-move! checks start and end correctly"
- (signals-error?
- 'out-of-range
- (substring-move! "sample" 3 0 "test" 3)))
+;;;; strings.test --- test suite for Guile's string functions -*- scheme -*-
+;;;; Jim Blandy <jimb@red-bean.com> --- August 1999
+;;;;
+;;;; Copyright (C) 1999, 2001, 2004, 2005, 2006, 2008, 2009 Free Software Foundation, Inc.
+;;;;
+;;;; This library is free software; you can redistribute it and/or
+;;;; modify it under the terms of the GNU Lesser General Public
+;;;; License as published by the Free Software Foundation; either
+;;;; version 3 of the License, or (at your option) any later version.
+;;;;
+;;;; This library 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
+;;;; Lesser General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU Lesser General Public
+;;;; License along with this library; if not, write to the Free Software
+;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+(define-module (test-strings)
+ #:use-module (test-suite lib))
+
+(define exception:read-only-string
+ (cons 'misc-error "^string is read-only"))
+(define exception:illegal-escape
+ (cons 'read-error "illegal character in escape sequence"))
+;; Wrong types may have either the 'wrong-type-arg key when
+;; interpreted or 'vm-error when compiled. This matches both.
+(define exception:wrong-type-arg
+ (cons #t "Wrong type"))
+
+;; Create a string from integer char values, eg. (string-ints 65) => "A"
+(define (string-ints . args)
+ (apply string (map integer->char args)))
+
+;;
+;; string internals
+;;
+
+;; Some abbreviations
+;; BMP - Basic Multilingual Plane (codepoints below U+FFFF)
+;; SMP - Suplementary Multilingual Plane (codebpoints from U+10000 to U+1FFFF)
+
+(with-test-prefix "string internals"
+
+ (pass-if "new string starts at 1st char in stringbuf"
+ (let ((s "abc"))
+ (= 0 (assq-ref (%string-dump s) 'start))))
+
+ (pass-if "length of new string same as stringbuf"
+ (let ((s "def"))
+ (= (string-length s) (assq-ref (%string-dump s) 'stringbuf-length))))
+
+ (pass-if "contents of new string same as stringbuf"
+ (let ((s "ghi"))
+ (string=? s (assq-ref (%string-dump s) 'stringbuf-chars))))
+
+ (pass-if "writable strings are not read-only"
+ (let ((s "zyx"))
+ (not (assq-ref (%string-dump s) 'read-only))))
+
+ (pass-if "read-only strings are read-only"
+ (let ((s (substring/read-only "zyx" 0)))
+ (assq-ref (%string-dump s) 'read-only)))
+
+ (pass-if "null strings are inlined"
+ (let ((s ""))
+ (assq-ref (%string-dump s) 'stringbuf-inline)))
+
+ (pass-if "short Latin-1 encoded strings are inlined"
+ (let ((s "m"))
+ (assq-ref (%string-dump s) 'stringbuf-inline)))
+
+ (pass-if "long Latin-1 encoded strings are not inlined"
+ (let ((s "0123456789012345678901234567890123456789"))
+ (not (assq-ref (%string-dump s) 'stringbuf-inline))))
+
+ (pass-if "short UCS-4 encoded strings are not inlined"
+ (let ((s "\u0100"))
+ (not (assq-ref (%string-dump s) 'stringbuf-inline))))
+
+ (pass-if "long UCS-4 encoded strings are not inlined"
+ (let ((s "\u010012345678901234567890123456789"))
+ (not (assq-ref (%string-dump s) 'stringbuf-inline))))
+
+ (pass-if "new Latin-1 encoded strings are not shared"
+ (let ((s "abc"))
+ (not (assq-ref (%string-dump s) 'stringbuf-shared))))
+
+ (pass-if "new UCS-4 encoded strings are not shared"
+ (let ((s "\u0100bc"))
+ (not (assq-ref (%string-dump s) 'stringbuf-shared))))
+
+ ;; Should this be true? It isn't currently true.
+ (pass-if "null shared substrings are shared"
+ (let* ((s1 "")
+ (s2 (substring/shared s1 0 0)))
+ (throw 'untested)
+ (eq? (assq-ref (%string-dump s2) 'shared)
+ s1)))
+
+ (pass-if "ASCII shared substrings are shared"
+ (let* ((s1 "foobar")
+ (s2 (substring/shared s1 0 3)))
+ (eq? (assq-ref (%string-dump s2) 'shared)
+ s1)))
+
+ (pass-if "BMP shared substrings are shared"
+ (let* ((s1 "\u0100\u0101\u0102\u0103\u0104\u0105")
+ (s2 (substring/shared s1 0 3)))
+ (eq? (assq-ref (%string-dump s2) 'shared)
+ s1)))
+
+ (pass-if "null substrings are not shared"
+ (let* ((s1 "")
+ (s2 (substring s1 0 0)))
+ (not (eq? (assq-ref (%string-dump s2) 'shared)
+ s1))))
+
+ (pass-if "ASCII substrings are not shared"
+ (let* ((s1 "foobar")
+ (s2 (substring s1 0 3)))
+ (not (eq? (assq-ref (%string-dump s2) 'shared)
+ s1))))
+
+ (pass-if "BMP substrings are not shared"
+ (let* ((s1 "\u0100\u0101\u0102\u0103\u0104\u0105")
+ (s2 (substring s1 0 3)))
+ (not (eq? (assq-ref (%string-dump s2) 'shared)
+ s1))))
+
+ (pass-if "ASCII substrings share stringbufs before copy-on-write"
+ (let* ((s1 "foobar")
+ (s2 (substring s1 0 3)))
+ (assq-ref (%string-dump s1) 'stringbuf-shared)))
+
+ (pass-if "BMP substrings share stringbufs before copy-on-write"
+ (let* ((s1 "\u0100\u0101\u0102\u0103\u0104\u0105")
+ (s2 (substring s1 0 3)))
+ (assq-ref (%string-dump s1) 'stringbuf-shared)))
+
+ (pass-if "ASCII substrings don't share stringbufs after copy-on-write"
+ (let* ((s1 "foobar")
+ (s2 (substring s1 0 3)))
+ (string-set! s2 0 #\F)
+ (not (assq-ref (%string-dump s2) 'stringbuf-shared))))
+
+ (pass-if "BMP substrings don't share stringbufs after copy-on-write"
+ (let* ((s1 "\u0100\u0101\u0102\u0103\u0104\u0105")
+ (s2 (substring s1 0 3)))
+ (string-set! s2 0 #\F)
+ (not (assq-ref (%string-dump s2) 'stringbuf-shared))))
+
+ (with-test-prefix "encodings"
+
+ (pass-if "null strings are Latin-1 encoded"
+ (let ((s ""))
+ (not (assq-ref (%string-dump s) 'stringbuf-wide))))
+
+ (pass-if "ASCII strings are Latin-1 encoded"
+ (let ((s "jkl"))
+ (not (assq-ref (%string-dump s) 'stringbuf-wide))))
+
+ (pass-if "Latin-1 strings are Latin-1 encoded"
+ (let ((s "\xC0\xC1\xC2"))
+ (not (assq-ref (%string-dump s) 'stringbuf-wide))))
+
+ (pass-if "BMP strings are UCS-4 encoded"
+ (let ((s "\u0100\u0101\x0102"))
+ (assq-ref (%string-dump s) 'stringbuf-wide)))
+
+ (pass-if "SMP strings are UCS-4 encoded"
+ (let ((s "\U010300\u010301\x010302"))
+ (assq-ref (%string-dump s) 'stringbuf-wide)))
+
+ (pass-if "null list->string is Latin-1 encoded"
+ (let ((s (string-ints)))
+ (not (assq-ref (%string-dump s) 'stringbuf-wide))))
+
+ (pass-if "ASCII list->string is Latin-1 encoded"
+ (let ((s (string-ints 65 66 67)))
+ (not (assq-ref (%string-dump s) 'stringbuf-wide))))
+
+ (pass-if "Latin-1 list->string is Latin-1 encoded"
+ (let ((s (string-ints #xc0 #xc1 #xc2)))
+ (not (assq-ref (%string-dump s) 'stringbuf-wide))))
+
+ (pass-if "BMP list->string is UCS-4 encoded"
+ (let ((s (string-ints #x0100 #x0101 #x0102)))
+ (assq-ref (%string-dump s) 'stringbuf-wide)))
+
+ (pass-if "SMP list->string is UCS-4 encoded"
+ (let ((s (string-ints #x010300 #x010301 #x010302)))
+ (assq-ref (%string-dump s) 'stringbuf-wide)))
+
+ (pass-if "encoding of string not based on escape style"
+ (let ((s "\U000040"))
+ (not (assq-ref (%string-dump s) 'stringbuf-wide))))))
+
+(with-test-prefix "hex escapes"
+
+ (pass-if-exception "non-hex char in two-digit hex-escape"
+ exception:illegal-escape
+ (with-input-from-string "\"\\x0g\"" read))
+
+ (pass-if-exception "non-hex char in four-digit hex-escape"
+ exception:illegal-escape
+ (with-input-from-string "\"\\u000g\"" read))
+
+ (pass-if-exception "non-hex char in six-digit hex-escape"
+ exception:illegal-escape
+ (with-input-from-string "\"\\U00000g\"" read))
+
+ (pass-if-exception "premature termination of two-digit hex-escape"
+ exception:illegal-escape
+ (with-input-from-string "\"\\x0\"" read))
+
+ (pass-if-exception "premature termination of four-digit hex-escape"
+ exception:illegal-escape
+ (with-input-from-string "\"\\u000\"" read))
+
+ (pass-if-exception "premature termination of six-digit hex-escape"
+ exception:illegal-escape
+ (with-input-from-string "\"\\U00000\"" read))
+
+ (pass-if "extra hex digits ignored for two-digit hex escape"
+ (eqv? (string-ref "--\xfff--" 2)
+ (integer->char #xff)))
+
+ (pass-if "extra hex digits ignored for four-digit hex escape"
+ (eqv? (string-ref "--\u0100f--" 2)
+ (integer->char #x0100)))
+
+ (pass-if "extra hex digits ignored for six-digit hex escape"
+ (eqv? (string-ref "--\U010300f--" 2)
+ (integer->char #x010300)))
+
+ (pass-if "escaped characters match non-escaped ASCII characters"
+ (string=? "ABC" "\x41\u0042\U000043")))
+
+;;
+;; string=?
+;;
+
+(with-test-prefix "string=?"
+
+ (pass-if "respects 1st parameter's string length"
+ (not (string=? "foo\0" "foo")))
+
+ (pass-if "respects 2nd paramter's string length"
+ (not (string=? "foo" "foo\0")))
+
+ (with-test-prefix "wrong argument type"
+
+ (pass-if-exception "1st argument symbol"
+ exception:wrong-type-arg
+ (string=? 'a "a"))
+
+ (pass-if-exception "2nd argument symbol"
+ exception:wrong-type-arg
+ (string=? "a" 'b))))
+
+;;
+;; string<?
+;;
+
+(with-test-prefix "string<?"
+
+ (pass-if "respects string length"
+ (and (not (string<? "foo\0a" "foo\0a"))
+ (string<? "foo\0a" "foo\0b")))
+
+ (with-test-prefix "wrong argument type"
+
+ (pass-if-exception "1st argument symbol"
+ exception:wrong-type-arg
+ (string<? 'a "a"))
+
+ (pass-if-exception "2nd argument symbol"
+ exception:wrong-type-arg
+ (string<? "a" 'b)))
+
+ (pass-if "same as char<?"
+ (eq? (char<? (integer->char 0) (integer->char 255))
+ (string<? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string-ci<?
+;;
+
+(with-test-prefix "string-ci<?"
+
+ (pass-if "respects string length"
+ (and (not (string-ci<? "foo\0a" "foo\0a"))
+ (string-ci<? "foo\0a" "foo\0b")))
+
+ (with-test-prefix "wrong argument type"
+
+ (pass-if-exception "1st argument symbol"
+ exception:wrong-type-arg
+ (string-ci<? 'a "a"))
+
+ (pass-if-exception "2nd argument symbol"
+ exception:wrong-type-arg
+ (string-ci<? "a" 'b)))
+
+ (pass-if "same as char-ci<?"
+ (eq? (char-ci<? (integer->char 0) (integer->char 255))
+ (string-ci<? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string<=?
+;;
+
+(with-test-prefix "string<=?"
+
+ (pass-if "same as char<=?"
+ (eq? (char<=? (integer->char 0) (integer->char 255))
+ (string<=? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string-ci<=?
+;;
+
+(with-test-prefix "string-ci<=?"
+
+ (pass-if "same as char-ci<=?"
+ (eq? (char-ci<=? (integer->char 0) (integer->char 255))
+ (string-ci<=? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string>?
+;;
+
+(with-test-prefix "string>?"
+
+ (pass-if "same as char>?"
+ (eq? (char>? (integer->char 0) (integer->char 255))
+ (string>? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string-ci>?
+;;
+
+(with-test-prefix "string-ci>?"
+
+ (pass-if "same as char-ci>?"
+ (eq? (char-ci>? (integer->char 0) (integer->char 255))
+ (string-ci>? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string>=?
+;;
+
+(with-test-prefix "string>=?"
+
+ (pass-if "same as char>=?"
+ (eq? (char>=? (integer->char 0) (integer->char 255))
+ (string>=? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string-ci>=?
+;;
+
+(with-test-prefix "string-ci>=?"
+
+ (pass-if "same as char-ci>=?"
+ (eq? (char-ci>=? (integer->char 0) (integer->char 255))
+ (string-ci>=? (string-ints 0) (string-ints 255)))))
+
+;;
+;; string-ref
+;;
+
+(with-test-prefix "string-ref"
+
+ (pass-if-exception "empty string"
+ exception:out-of-range
+ (string-ref "" 0))
+
+ (pass-if-exception "empty string and non-zero index"
+ exception:out-of-range
+ (string-ref "" 123))
+
+ (pass-if-exception "out of range"
+ exception:out-of-range
+ (string-ref "hello" 123))
+
+ (pass-if-exception "negative index"
+ exception:out-of-range
+ (string-ref "hello" -1))
+
+ (pass-if "regular string, ASCII char"
+ (char=? (string-ref "GNU Guile" 4) #\G))
+
+ (pass-if "regular string, hex escaped Latin-1 char"
+ (char=? (string-ref "--\xff--" 2)
+ (integer->char #xff)))
+
+ (pass-if "regular string, hex escaped BMP char"
+ (char=? (string-ref "--\u0100--" 2)
+ (integer->char #x0100)))
+
+ (pass-if "regular string, hex escaped SMP char"
+ (char=? (string-ref "--\U010300--" 2)
+ (integer->char #x010300))))
+
+;;
+;; string-set!
+;;
+
+(with-test-prefix "string-set!"
+
+ (pass-if-exception "empty string"
+ exception:out-of-range
+ (string-set! (string-copy "") 0 #\x))
+
+ (pass-if-exception "empty string and non-zero index"
+ exception:out-of-range
+ (string-set! (string-copy "") 123 #\x))
+
+ (pass-if-exception "out of range"
+ exception:out-of-range
+ (string-set! (string-copy "hello") 123 #\x))
+
+ (pass-if-exception "negative index"
+ exception:out-of-range
+ (string-set! (string-copy "hello") -1 #\x))
+
+ (pass-if-exception "read-only string"
+ exception:read-only-string
+ (string-set! (substring/read-only "abc" 0) 1 #\space))
+
+ (pass-if "regular string, ASCII char"
+ (let ((s (string-copy "GNU guile")))
+ (string-set! s 4 #\G)
+ (char=? (string-ref s 4) #\G)))
+
+ (pass-if "regular string, Latin-1 char"
+ (let ((s (string-copy "GNU guile")))
+ (string-set! s 4 (integer->char #xfe))
+ (char=? (string-ref s 4) (integer->char #xfe))))
+
+ (pass-if "regular string, BMP char"
+ (let ((s (string-copy "GNU guile")))
+ (string-set! s 4 (integer->char #x0100))
+ (char=? (string-ref s 4) (integer->char #x0100))))
+
+ (pass-if "regular string, SMP char"
+ (let ((s (string-copy "GNU guile")))
+ (string-set! s 4 (integer->char #x010300))
+ (char=? (string-ref s 4) (integer->char #x010300)))))
+
+;;
+;; list->string
+;;
+(with-test-prefix "string"
+
+ (pass-if-exception "convert circular list to string"
+ exception:wrong-type-arg
+ (let ((foo (list #\a #\b #\c)))
+ (set-cdr! (cddr foo) (cdr foo))
+ (apply string foo))))
+
+(with-test-prefix "string-split"
+
+ ;; in guile 1.6.7 and earlier, character >=128 wasn't matched in the string
+ (pass-if "char 255"
+ (equal? '("a" "b")
+ (string-split (string #\a (integer->char 255) #\b)
+ (integer->char 255)))))
+
+(with-test-prefix "substring-move!"
+
+ (pass-if-exception "substring-move! checks start and end correctly"
+ exception:out-of-range
+ (substring-move! "sample" 3 0 "test" 3)))
+
+(with-test-prefix "substring/shared"
+
+ (pass-if "modify indirectly"
+ (let ((str (string-copy "foofoofoo")))
+ (string-upcase! (substring/shared str 3 6))
+ (string=? str "fooFOOfoo")))
+
+ (pass-if "modify cow indirectly"
+ (let* ((str1 (string-copy "foofoofoo"))
+ (str2 (string-copy str1)))
+ (string-upcase! (substring/shared str2 3 6))
+ (and (string=? str1 "foofoofoo")
+ (string=? str2 "fooFOOfoo"))))
+
+ (pass-if "modify double indirectly"
+ (let* ((str1 (string-copy "foofoofoo"))
+ (str2 (substring/shared str1 2 7)))
+ (string-upcase! (substring/shared str2 1 4))
+ (string=? str1 "fooFOOfoo")))
+
+ (pass-if "modify cow double indirectly"
+ (let* ((str1 "foofoofoo")
+ (str2 (substring str1 2 7)))
+ (string-upcase! (substring/shared str2 1 4))
+ (and (string=? str1 "foofoofoo")
+ (string=? str2 "oFOOf")))))