Add support for enum comparisons and bitwise operators (#7356)

If C++ overload resolution selects a builtin operator candidate for an
enum comparison or bitwise operator, provide support for that operator
by generating a corresponding Carbon builtin function. This is
structured to be easily extensible to other C++ builtin overload
candidates if we so choose, but for now the operators defined in the
prelude are doing what we want in most cases.

Bitwise operators on enums produce the same enum type as a result. This
intentionally deviates from C++, where they produce a promoted integral
type.

Assisted-by: Gemini via Antigravity
This commit is contained in:
Richard Smith
2026-06-16 19:51:11 +00:00
committed by GitHub
parent 30b6c22444
commit 1106d967df
7 changed files with 1070 additions and 29 deletions
-2
View File
@@ -99,7 +99,5 @@ fn F() {
// CHECK:STDOUT: return
// CHECK:STDOUT: }
// CHECK:STDOUT:
// CHECK:STDOUT: fn @Enum.Op(%self.param: %Enum) -> out %return.param: %Enum = "primitive_copy";
// CHECK:STDOUT:
// CHECK:STDOUT: fn @Destroy.Op(%self.param: ref %Enum) = "no_op";
// CHECK:STDOUT:
+87
View File
@@ -0,0 +1,87 @@
// 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/full.carbon
//
// AUTOUPDATE
// TIP: To test this file alone, run:
// TIP: bazel test //toolchain/testing:file_test --test_arg=--file_tests=toolchain/check/testdata/interop/cpp/enum/eq.carbon
// TIP: To dump output, run:
// TIP: bazel run //toolchain/testing:file_test -- --dump_output --file_tests=toolchain/check/testdata/interop/cpp/enum/eq.carbon
// --- enum.h
enum Unscoped { A, B };
enum class Scoped { X, Y };
// --- overloaded.h
enum CustomEnum { X, Y };
auto operator==(CustomEnum lhs, CustomEnum rhs) -> bool;
auto operator!=(CustomEnum lhs, CustomEnum rhs) -> bool;
enum HeterogeneousUnscoped { A, B };
enum class HeterogeneousScoped { X, Y };
auto operator==(HeterogeneousScoped lhs, HeterogeneousUnscoped rhs) -> bool;
auto operator!=(HeterogeneousScoped lhs, HeterogeneousUnscoped rhs) -> bool;
// --- eq.carbon
library "[[@TEST_NAME]]";
import Cpp library "enum.h";
fn CompareGeneric[U:! type, T:! Core.EqWith(U)](x: T, y: U) -> bool {
return x == y;
}
fn CompareUnscoped(x: Cpp.Unscoped, y: Cpp.Unscoped) -> bool {
return x == y;
}
fn CompareScoped(x: Cpp.Scoped, y: Cpp.Scoped) -> bool {
return x == y;
}
fn CallCompareGeneric(x: Cpp.Unscoped, y: Cpp.Unscoped) -> bool {
return CompareGeneric(x, y);
}
// --- overloaded_op.carbon
library "[[@TEST_NAME]]";
import Cpp library "overloaded.h";
fn CompareGeneric[U:! type, T:! Core.EqWith(U)](x: T, y: U) -> bool {
return x == y;
}
fn CompareCustom(x: Cpp.CustomEnum, y: Cpp.CustomEnum) -> bool {
return x == y;
}
fn CompareHeterogeneous(x: Cpp.HeterogeneousScoped, y: Cpp.HeterogeneousUnscoped) -> bool {
return CompareGeneric(x, y);
}
// --- fail_heterogeneous.carbon
library "[[@TEST_NAME]]";
import Cpp library "enum.h";
fn CompareGeneric[U:! type, T:! Core.EqWith(U)](x: T, y: U) -> bool {
return x == y;
}
fn CompareHeterogeneousFail(x: Cpp.Scoped, y: Cpp.Unscoped) -> bool {
// CHECK:STDERR: fail_heterogeneous.carbon:[[@LINE+7]]:10: error: cannot convert type `Cpp.Scoped` into type implementing `Core.EqWith(Cpp.Unscoped)` [ConversionFailureTypeToFacet]
// CHECK:STDERR: return CompareGeneric(x, y);
// CHECK:STDERR: ^~~~~~~~~~~~~~~~~~~~
// CHECK:STDERR: fail_heterogeneous.carbon:[[@LINE-8]]:1: note: while deducing parameters of generic declared here [DeductionGenericHere]
// CHECK:STDERR: fn CompareGeneric[U:! type, T:! Core.EqWith(U)](x: T, y: U) -> bool {
// CHECK:STDERR: ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// CHECK:STDERR:
return CompareGeneric(x, y);
}
@@ -0,0 +1,307 @@
// 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/full.carbon
//
// AUTOUPDATE
// TIP: To test this file alone, run:
// TIP: bazel test //toolchain/testing:file_test --test_arg=--file_tests=toolchain/check/testdata/interop/cpp/operators/builtin_candidates.carbon
// TIP: To dump output, run:
// TIP: bazel run //toolchain/testing:file_test -- --dump_output --file_tests=toolchain/check/testdata/interop/cpp/operators/builtin_candidates.carbon
// --- enum_operators.carbon
library "[[@TEST_NAME]]";
import Cpp inline '''c++
enum E { e1, e2, e3 };
enum class EC { e1, e2, e3 };
''';
fn TestEnum(a: Cpp.E, b: Cpp.E) {
let _: Cpp.E = a & b;
let _: Cpp.E = a | b;
let _: Cpp.E = a ^ b;
let _: Cpp.E = ^a;
let _: bool = a == b;
let _: bool = a != b;
let _: bool = a < b;
let _: bool = a <= b;
let _: bool = a > b;
let _: bool = a >= b;
}
fn TestEnumClass(a: Cpp.EC, b: Cpp.EC) {
let _: bool = a == b;
let _: bool = a != b;
let _: bool = a < b;
let _: bool = a <= b;
let _: bool = a > b;
let _: bool = a >= b;
}
// --- fail_enum_class_bitwise_operators.carbon
library "[[@TEST_NAME]]";
import Cpp inline '''c++
enum class EC { e1, e2, e3 };
''';
fn TestEnumClass(a: Cpp.EC, b: Cpp.EC) {
// CHECK:STDERR: fail_enum_class_bitwise_operators.carbon:[[@LINE+4]]:19: error: cannot access member of interface `Core.BitAndWith(Cpp.EC)` in type `Cpp.EC` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: Cpp.EC = a & b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: Cpp.EC = a & b;
// CHECK:STDERR: fail_enum_class_bitwise_operators.carbon:[[@LINE+4]]:19: error: cannot access member of interface `Core.BitOrWith(Cpp.EC)` in type `Cpp.EC` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: Cpp.EC = a | b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: Cpp.EC = a | b;
// CHECK:STDERR: fail_enum_class_bitwise_operators.carbon:[[@LINE+4]]:19: error: cannot access member of interface `Core.BitXorWith(Cpp.EC)` in type `Cpp.EC` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: Cpp.EC = a ^ b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: Cpp.EC = a ^ b;
// CHECK:STDERR: fail_enum_class_bitwise_operators.carbon:[[@LINE+4]]:19: error: cannot access member of interface `Core.BitComplement` in type `Cpp.EC` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: Cpp.EC = ^a;
// CHECK:STDERR: ^~
// CHECK:STDERR:
let _: Cpp.EC = ^a;
}
// --- enum_operators_with_conversion.carbon
import Cpp inline '''c++
enum E {};
struct ConvertibleToEnum {
operator E() const;
};
''';
fn TestEnumVsConvertibleToEnum(a: Cpp.E, b: Cpp.ConvertibleToEnum) {
let _: Cpp.E = a & b;
let _: Cpp.E = a | b;
let _: Cpp.E = a ^ b;
let _: Cpp.E = ^a;
let _: bool = a == b;
let _: bool = a != b;
let _: bool = a < b;
let _: bool = a <= b;
let _: bool = a > b;
let _: bool = a >= b;
}
fn TestConvertibleToEnumVsEnum(a: Cpp.ConvertibleToEnum, b: Cpp.E) {
let _: Cpp.E = a & b;
let _: Cpp.E = a | b;
let _: Cpp.E = a ^ b;
let _: Cpp.E = ^a;
let _: bool = a == b;
let _: bool = a != b;
let _: bool = a < b;
let _: bool = a <= b;
let _: bool = a > b;
let _: bool = a >= b;
}
// TODO: Should we allow these? For consistency with the cases in the next
// split, we should not, but we currently do.
fn TestConversionOnBothOperands(a: Cpp.ConvertibleToEnum, b: Cpp.E) {
let _: Cpp.E = a & b;
let _: Cpp.E = a | b;
let _: Cpp.E = a ^ b;
let _: Cpp.E = ^a;
let _: bool = a == b;
let _: bool = a != b;
let _: bool = a < b;
let _: bool = a <= b;
let _: bool = a > b;
let _: bool = a >= b;
}
// --- fail_convert_all_operands.carbon
// We do not currently support calls to builtin candidates where all operands
// are converted from class type to a primitive type. This is done to match
// Carbon rules.
library "[[@TEST_NAME]]";
import Cpp inline '''c++
struct ConvertibleToInt {
operator int() const;
};
struct ConvertibleToFloat {
operator float() const;
};
''';
fn TestInteger(a: Cpp.ConvertibleToInt, b: Cpp.ConvertibleToInt) {
// Test arithmetic.
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.AddWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a + b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a + b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.SubWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a - b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a - b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.MulWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a * b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a * b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.DivWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a / b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a / b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.ModWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a % b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a % b;
// Test bitwise.
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.BitAndWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a & b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a & b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.BitOrWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a | b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a | b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.BitXorWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a ^ b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: i32 = a ^ b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.LeftShiftWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a << b;
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: i32 = a << b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.RightShiftWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = a >> b;
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: i32 = a >> b;
// Test comparison.
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.EqWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a == b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a == b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.EqWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a != b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a != b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a < b);
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: bool = (a < b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a <= b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a <= b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a > b);
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: bool = (a > b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToInt)` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a >= b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a >= b);
// Test unary.
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.Negate` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = -a;
// CHECK:STDERR: ^~
// CHECK:STDERR:
let _: i32 = -a;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.BitComplement` in type `Cpp.ConvertibleToInt` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: i32 = ^a;
// CHECK:STDERR: ^~
// CHECK:STDERR:
let _: i32 = ^a;
}
fn TestFloat(a: Cpp.ConvertibleToFloat, b: Cpp.ConvertibleToFloat) {
// Test arithmetic.
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.AddWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: f32 = a + b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: f32 = a + b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.SubWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: f32 = a - b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: f32 = a - b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.MulWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: f32 = a * b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: f32 = a * b;
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.DivWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: f32 = a / b;
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: f32 = a / b;
// Test comparison.
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.EqWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a == b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a == b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.EqWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a != b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a != b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a < b);
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: bool = (a < b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a <= b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a <= b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a > b);
// CHECK:STDERR: ^~~~~
// CHECK:STDERR:
let _: bool = (a > b);
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:18: error: cannot access member of interface `Core.OrderedWith(Cpp.ConvertibleToFloat)` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: bool = (a >= b);
// CHECK:STDERR: ^~~~~~
// CHECK:STDERR:
let _: bool = (a >= b);
// Test unary.
// CHECK:STDERR: fail_convert_all_operands.carbon:[[@LINE+4]]:16: error: cannot access member of interface `Core.Negate` in type `Cpp.ConvertibleToFloat` that does not implement that interface [MissingImplInMemberAccess]
// CHECK:STDERR: let _: f32 = -a;
// CHECK:STDERR: ^~
// CHECK:STDERR:
let _: f32 = -a;
}