Files
carbon-lang/toolchain/check/testdata/primitives/string_literals.carbon
T
Richard Smith 41ed82e033 Add basic support for strings to core, check, and lower. (#5963)
Add a `Core.String` class to the prelude representing a string view, and
rename the `String` keyword to `str` and make it evaluate to
`Core.String`.

`Core.String` is represented as a pair of a pointer to a character
(actually, to the first character of a string, but we don't have a way
of modeling that yet) and a size (which should be pointer-width, but is
currently always a `u64` as we don't have a `usize` equivalent yet).
`Core.String` values are generated directly by the toolchain for string
literal expressions.

This follows the direction established at the recent summit, but the
design implemented here has not been through the proposal process yet.
2025-08-20 00:18:50 +00:00

174 lines
6.0 KiB
Plaintext

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
// INCLUDE-FILE: toolchain/testing/testdata/min_prelude/uint.carbon
//
// AUTOUPDATE
// TIP: To test this file alone, run:
// TIP: bazel test //toolchain/testing:file_test --test_arg=--file_tests=toolchain/check/testdata/primitives/string_literals.carbon
// TIP: To dump output, run:
// TIP: bazel run //toolchain/testing:file_test -- --dump_output --file_tests=toolchain/check/testdata/primitives/string_literals.carbon
// --- fail_no_string.carbon
library "[[@TEST_NAME]]";
fn F() {
// CHECK:STDERR: fail_no_string.carbon:[[@LINE+4]]:3: error: name `Core.String` implicitly referenced here, but not found [CoreNameNotFound]
// CHECK:STDERR: "hello";
// CHECK:STDERR: ^~~~~~~
// CHECK:STDERR:
"hello";
}
// --- unusual_string.carbon
package Core library "[[@TEST_NAME]]";
import library "prelude/parts/uint";
class String {
var begin: u8*;
var end: u8*;
}
// --- fail_use_unusual_string.carbon
import Core library "unusual_string";
// CHECK:STDERR: fail_use_unusual_string.carbon:[[@LINE+4]]:14: error: unexpected representation for type `Core.String` [StringLiteralTypeUnexpected]
// CHECK:STDERR: let x: str = "hello";
// CHECK:STDERR: ^~~~~~~
// CHECK:STDERR:
let x: str = "hello";
// --- incomplete_string.carbon
package Core library "[[@TEST_NAME]]";
class String;
// --- fail_use_incomplete_string.carbon
library "[[@TEST_NAME]]";
import Core library "incomplete_string";
fn F() {
// CHECK:STDERR: fail_use_incomplete_string.carbon:[[@LINE+7]]:3: error: type `Core.String` is incomplete [StringLiteralTypeIncomplete]
// CHECK:STDERR: "hello";
// CHECK:STDERR: ^~~~~~~
// CHECK:STDERR: incomplete_string.carbon:4:1: note: class was forward declared here [ClassForwardDeclaredHere]
// CHECK:STDERR: class String;
// CHECK:STDERR: ^~~~~~~~~~~~~
// CHECK:STDERR:
"hello";
}
// --- small_string.carbon
package Core library "[[@TEST_NAME]]";
import library "prelude/parts/uint";
class String {
var ptr: u8*;
// An intentionally small `size` field to test the behavior when a string
// literal is large enough that its size can't be represented.
var size: u8;
}
// --- use_small_string.carbon
library "[[@TEST_NAME]]";
import Core library "small_string";
//@dump-sem-ir-begin
let x: str = "hello";
//@dump-sem-ir-end
// --- fail_overfill_small_string.carbon
library "[[@TEST_NAME]]";
import Core library "small_string";
//@dump-sem-ir-begin
// CHECK:STDERR: fail_overfill_small_string.carbon:[[@LINE+4]]:14: error: string literal is too long [StringLiteralTooLong]
// CHECK:STDERR: let x: str = '''
// CHECK:STDERR: ^~~
// CHECK:STDERR:
let x: str = '''
A string so long its size does not fit in `u8`. This results in an error,
because we can't form a `Core.String` value that describes this string.
This string contains 256 characters. Among them are:
* 6 `g`s,
* 21 `s`s,
* 9 newlines,
* and only one `p`.
''';
//@dump-sem-ir-end
// CHECK:STDOUT: --- use_small_string.carbon
// CHECK:STDOUT:
// CHECK:STDOUT: constants {
// CHECK:STDOUT: %String: type = class_type @String [concrete]
// CHECK:STDOUT: %int_8: Core.IntLiteral = int_value 8 [concrete]
// CHECK:STDOUT: %u8: type = class_type @UInt, @UInt(%int_8) [concrete]
// CHECK:STDOUT: %ptr.3e8: type = ptr_type %u8 [concrete]
// CHECK:STDOUT: %pattern_type.461: type = pattern_type %String [concrete]
// CHECK:STDOUT: %str: %ptr.3e8 = string_literal "hello" [concrete]
// CHECK:STDOUT: %int_5: %u8 = int_value 5 [concrete]
// CHECK:STDOUT: %String.val: %String = struct_value (%str, %int_5) [concrete]
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: imports {
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: file {
// CHECK:STDOUT: name_binding_decl {
// CHECK:STDOUT: %x.patt: %pattern_type.461 = binding_pattern x [concrete]
// CHECK:STDOUT: }
// CHECK:STDOUT: %x: %String = bind_name x, @__global_init.%String.val
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: fn @__global_init() {
// CHECK:STDOUT: !entry:
// CHECK:STDOUT: %str: %ptr.3e8 = string_literal "hello" [concrete = constants.%str]
// CHECK:STDOUT: %int_5: %u8 = int_value 5 [concrete = constants.%int_5]
// CHECK:STDOUT: %String.val: %String = struct_value (%str, %int_5) [concrete = constants.%String.val]
// CHECK:STDOUT: <elided>
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: --- fail_overfill_small_string.carbon
// CHECK:STDOUT:
// CHECK:STDOUT: constants {
// CHECK:STDOUT: %String: type = class_type @String [concrete]
// CHECK:STDOUT: %int_8: Core.IntLiteral = int_value 8 [concrete]
// CHECK:STDOUT: %u8: type = class_type @UInt, @UInt(%int_8) [concrete]
// CHECK:STDOUT: %ptr.3e8: type = ptr_type %u8 [concrete]
// CHECK:STDOUT: %pattern_type.461: type = pattern_type %String [concrete]
// CHECK:STDOUT: %str: %ptr.3e8 = string_literal "A string so long its size does not fit in `u8`. This results in an error,\nbecause we can't form a `Core.String` value that describes this string.\n\nThis string contains 256 characters. Among them are:\n\n* 6 `g`s,\n* 21 `s`s,\n* 9 newlines,\n* and only one `p`.\n" [concrete]
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: imports {
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: file {
// CHECK:STDOUT: name_binding_decl {
// CHECK:STDOUT: %x.patt: %pattern_type.461 = binding_pattern x [concrete]
// CHECK:STDOUT: }
// CHECK:STDOUT: %x: %String = bind_name x, <error> [concrete = <error>]
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: fn @__global_init() {
// CHECK:STDOUT: !entry:
// CHECK:STDOUT: %str: %ptr.3e8 = string_literal "A string so long its size does not fit in `u8`. This results in an error,\nbecause we can't form a `Core.String` value that describes this string.\n\nThis string contains 256 characters. Among them are:\n\n* 6 `g`s,\n* 21 `s`s,\n* 9 newlines,\n* and only one `p`.\n" [concrete = constants.%str]
// CHECK:STDOUT: <elided>
// CHECK:STDOUT: }
// CHECK:STDOUT: