Files
carbon-lang/toolchain/check/operator.cpp
T
Boaz Brickner ef488f00fa Overload resolution for C++ operators (#6092)
Multiple overloads for the same operator are now resolved using overload
resolution.
This change doesn't try to solve all issues with operator lookup.

Moved the operator lookup logic from `import` to `operators` and changed
it to take the args into account.
Use `Sema::LookupOverloadedBinOp()` (with ADL) when looking up operator
functions to create an overload set.

Verified all demos in #6017, #6020 and #6024 still work.

C++ Interop Demo:

```c++
// my_number.h

class MyNumber {
 public:
  explicit MyNumber(int value) : value_(value) {}
  auto value() const -> int { return value_; }

 private:
  int value_;
};

class NotMyNumber {};

auto operator+(MyNumber lhs, MyNumber rhs) -> MyNumber;
auto operator+(NotMyNumber lhs, NotMyNumber rhs) -> NotMyNumber;
```

```c++
// my_number.cpp

#include "my_number.h"

auto operator+(MyNumber lhs, MyNumber rhs) -> MyNumber {
  return MyNumber(lhs.value() + rhs.value());
}

auto operator+(NotMyNumber lhs, NotMyNumber /*rhs*/) -> NotMyNumber {
  return lhs;
}
```

```carbon
// main.carbon

library "Main";

import Core library "io";
import Cpp library "my_number.h";

fn Run() -> i32 {
  // Arithmetic
  var num1: Cpp.MyNumber = Cpp.MyNumber.MyNumber(14);
  var num2: Cpp.MyNumber = Cpp.MyNumber.MyNumber(5);
  Core.Print(num1.value());
  Core.Print(num2.value());
  Core.Print((num1 + num2).value());

  return 0;
}
```

**After this change:**

```shell
$ clang -c my_number.cpp
$ bazel-bin/toolchain/carbon compile main.carbon
$ bazel-bin/toolchain/carbon link my_number.o main.o --output=demo
$ ./demo
14
5
19
```

**Before this change**

```shell
$ bazel-bin/toolchain/carbon compile main.carbon
main.carbon:14:15: error: semantics TODO: `Unsupported: Lookup succeeded but couldn't find a single result; LookupResultKind: 3`
  Core.Print((num1 + num2).value());
              ^~~~~~~~~~~
main.carbon:14:15: note: in `Cpp` operator `AddWith` lookup
  Core.Print((num1 + num2).value());
              ^~~~~~~~~~~
```

Part of https://github.com/carbon-language/carbon-lang/issues/5995.
2025-09-19 16:42:46 +00:00

121 lines
4.8 KiB
C++

// 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 "toolchain/check/operator.h"
#include <optional>
#include "toolchain/check/call.h"
#include "toolchain/check/context.h"
#include "toolchain/check/cpp/operators.h"
#include "toolchain/check/generic.h"
#include "toolchain/check/member_access.h"
#include "toolchain/check/name_lookup.h"
#include "toolchain/sem_ir/class.h"
#include "toolchain/sem_ir/ids.h"
#include "toolchain/sem_ir/name_scope.h"
#include "toolchain/sem_ir/typed_insts.h"
namespace Carbon::Check {
// Returns the `Op` function for the specified operator.
static auto GetOperatorOpFunction(Context& context, SemIR::LocId loc_id,
Operator op) -> SemIR::InstId {
auto implicit_loc_id = context.insts().GetLocIdForDesugaring(loc_id);
// Look up the interface, and pass it any generic arguments.
auto interface_id =
LookupNameInCore(context, implicit_loc_id, op.interface_name);
if (!op.interface_args_ref.empty()) {
interface_id = PerformCall(context, implicit_loc_id, interface_id,
op.interface_args_ref);
}
// Look up the interface member.
auto op_name_id =
SemIR::NameId::ForIdentifier(context.identifiers().Add(op.op_name));
return PerformMemberAccess(context, implicit_loc_id, interface_id,
op_name_id);
}
// Returns whether the instruction is a C++ class.
static auto IsCppClassType(Context& context, SemIR::InstId inst_id) -> bool {
auto class_type = context.insts().TryGetAs<SemIR::ClassType>(
context.types().GetInstId(context.insts().Get(inst_id).type_id()));
if (!class_type) {
// Not a class.
return false;
}
const SemIR::Class& class_info = context.classes().Get(class_type->class_id);
return class_info.is_complete() &&
context.name_scopes().Get(class_info.scope_id).is_cpp_scope();
}
auto BuildUnaryOperator(Context& context, SemIR::LocId loc_id, Operator op,
SemIR::InstId operand_id,
MakeDiagnosticBuilderFn missing_impl_diagnoser)
-> SemIR::InstId {
// For unary operators with a C++ class as the operand, try to import and call
// the C++ operator.
// TODO: Change impl lookup instead. See
// https://github.com/carbon-language/carbon-lang/blob/db0a00d713015436844c55e7ac190a0f95556499/toolchain/check/operator.cpp#L76
if (IsCppClassType(context, operand_id)) {
SemIR::InstId cpp_inst_id =
LookupCppOperator(context, loc_id, op, {operand_id});
if (cpp_inst_id.has_value() && cpp_inst_id != SemIR::ErrorInst::InstId) {
return PerformCall(context, loc_id, cpp_inst_id, {operand_id});
}
}
// Look up the operator function.
auto op_fn = GetOperatorOpFunction(context, loc_id, op);
// Form `operand.(Op)`.
auto bound_op_id = PerformCompoundMemberAccess(context, loc_id, operand_id,
op_fn, missing_impl_diagnoser);
if (bound_op_id == SemIR::ErrorInst::InstId) {
return SemIR::ErrorInst::InstId;
}
// Form `bound_op()`.
return PerformCall(context, loc_id, bound_op_id, {});
}
auto BuildBinaryOperator(Context& context, SemIR::LocId loc_id, Operator op,
SemIR::InstId lhs_id, SemIR::InstId rhs_id,
MakeDiagnosticBuilderFn missing_impl_diagnoser)
-> SemIR::InstId {
// For binary operators with a C++ class as at least one of the operands, try
// to import and call the C++ operator.
// TODO: Instead of hooking this here, change impl lookup, so that a generic
// constraint such as `T:! Core.Add` is satisfied by C++ class types that are
// addable. See
// https://github.com/carbon-language/carbon-lang/pull/5996/files/5d01fa69511b76f87efbc0387f5e40abcf4c911a#r2308666348
// and
// https://github.com/carbon-language/carbon-lang/pull/5996/files/5d01fa69511b76f87efbc0387f5e40abcf4c911a#r2308664536
if (IsCppClassType(context, lhs_id) || IsCppClassType(context, rhs_id)) {
SemIR::InstId cpp_inst_id =
LookupCppOperator(context, loc_id, op, {lhs_id, rhs_id});
if (cpp_inst_id.has_value() && cpp_inst_id != SemIR::ErrorInst::InstId) {
return PerformCall(context, loc_id, cpp_inst_id, {lhs_id, rhs_id});
}
}
// Look up the operator function.
auto op_fn = GetOperatorOpFunction(context, loc_id, op);
// Form `lhs.(Op)`.
auto bound_op_id = PerformCompoundMemberAccess(context, loc_id, lhs_id, op_fn,
missing_impl_diagnoser);
if (bound_op_id == SemIR::ErrorInst::InstId) {
return SemIR::ErrorInst::InstId;
}
// Form `bound_op(rhs)`.
return PerformCall(context, loc_id, bound_op_id, {rhs_id});
}
} // namespace Carbon::Check