carbon-lang/explorer/ast/expression.h

// 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

#ifndef CARBON_EXPLORER_AST_EXPRESSION_H_
#define CARBON_EXPLORER_AST_EXPRESSION_H_

#include <map>
#include <optional>
#include <string>
#include <utility>
#include <variant>
#include <vector>

#include "common/ostream.h"
#include "explorer/ast/ast_node.h"
#include "explorer/ast/bindings.h"
#include "explorer/ast/element.h"
#include "explorer/ast/expression_category.h"
#include "explorer/ast/paren_contents.h"
#include "explorer/ast/value_node.h"
#include "explorer/common/arena.h"
#include "explorer/common/source_location.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/Support/Compiler.h"

namespace Carbon {

class Value;
class Witness;
class MemberName;
class VariableType;
class InterfaceType;
class ImplBinding;
class GenericBinding;

class Expression : public AstNode {
 public:
  ~Expression() override = 0;

  void Print(llvm::raw_ostream& out) const override;
  void PrintID(llvm::raw_ostream& out) const override;

  static auto classof(const AstNode* node) {
    return InheritsFromExpression(node->kind());
  }

  // Returns the enumerator corresponding to the most-derived type of this
  // object.
  auto kind() const -> ExpressionKind {
    return static_cast<ExpressionKind>(root_kind());
  }

  // The static type of this expression. Cannot be called before typechecking.
  auto static_type() const -> const Value& {
    CARBON_CHECK(static_type_.has_value());
    return **static_type_;
  }

  // Sets the static type of this expression. Can only be called once, during
  // typechecking.
  void set_static_type(Nonnull<const Value*> type) {
    CARBON_CHECK(!static_type_.has_value());
    static_type_ = type;
  }

  // The value category of this expression. Cannot be called before
  // typechecking.
  auto expression_category() const -> ExpressionCategory {
    return *expression_category_;
  }

  // Sets the value category of this expression. Can be called multiple times,
  // but the argument must have the same value each time.
  void set_expression_category(ExpressionCategory expression_category) {
    CARBON_CHECK(!expression_category_.has_value() ||
                 expression_category == *expression_category_);
    expression_category_ = expression_category;
  }

  // Determines whether the expression has already been type-checked. Should
  // only be used by type-checking.
  auto is_type_checked() const -> bool {
    return static_type_.has_value() && expression_category_.has_value();
  }

 protected:
  // Constructs an Expression representing syntax at the given line number.
  // `kind` must be the enumerator corresponding to the most-derived type being
  // constructed.
  Expression(AstNodeKind kind, SourceLocation source_loc)
      : AstNode(kind, source_loc) {}

  explicit Expression(CloneContext& context, const Expression& other)
      : AstNode(context, other) {}

 private:
  std::optional<Nonnull<const Value*>> static_type_;
  std::optional<ExpressionCategory> expression_category_;
};

// A mixin for expressions that can be rewritten to a different expression by
// type-checking.
template <typename Base>
class RewritableMixin : public Base {
 public:
  using Base::Base;

  explicit RewritableMixin(CloneContext& context, const RewritableMixin& other)
      : Base(context, other),
        rewritten_form_(context.Clone(other.rewritten_form_)) {}

  // Set the rewritten form of this expression. Can only be called during type
  // checking.
  auto set_rewritten_form(Nonnull<const Expression*> rewritten_form) -> void {
    CARBON_CHECK(!rewritten_form_.has_value()) << "rewritten form set twice";
    rewritten_form_ = rewritten_form;
    this->set_static_type(&rewritten_form->static_type());
    this->set_expression_category(rewritten_form->expression_category());
  }

  // Get the rewritten form of this expression. A rewritten form is used when
  // the expression is rewritten as a function call on an interface. A
  // rewritten form is not used when providing built-in operator semantics.
  auto rewritten_form() const -> std::optional<Nonnull<const Expression*>> {
    return rewritten_form_;
  }

 private:
  std::optional<Nonnull<const Expression*>> rewritten_form_;
};

// A FieldInitializer represents the initialization of a single struct field.
class FieldInitializer {
 public:
  FieldInitializer(std::string name, Nonnull<Expression*> expression)
      : name_(std::move(name)), expression_(expression) {}

  explicit FieldInitializer(CloneContext& context,
                            const FieldInitializer& other)
      : name_(other.name_), expression_(context.Clone(other.expression_)) {}

  auto name() const -> const std::string& { return name_; }

  auto expression() const -> const Expression& { return *expression_; }
  auto expression() -> Expression& { return *expression_; }

 private:
  // The field name. Cannot be empty.
  std::string name_;

  // The expression that initializes the field.
  Nonnull<Expression*> expression_;
};

enum class Operator {
  Add,
  AddressOf,
  And,
  As,
  BitwiseAnd,
  BitwiseOr,
  BitwiseXor,
  BitShiftLeft,
  BitShiftRight,
  Complement,
  Deref,
  Div,
  Eq,
  Less,
  LessEq,
  Greater,
  GreaterEq,
  Mul,
  Mod,
  Neg,
  Not,
  NotEq,
  Or,
  Sub,
  Ptr,
};

// Returns the lexical representation of `op`, such as "+" for `Add`.
auto OperatorToString(Operator op) -> std::string_view;

class IdentifierExpression : public Expression {
 public:
  explicit IdentifierExpression(SourceLocation source_loc, std::string name)
      : Expression(AstNodeKind::IdentifierExpression, source_loc),
        name_(std::move(name)) {}

  explicit IdentifierExpression(CloneContext& context,
                                const IdentifierExpression& other)
      : Expression(context, other),
        name_(other.name_),
        value_node_(context.Clone(other.value_node_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromIdentifierExpression(node->kind());
  }

  auto name() const -> const std::string& { return name_; }

  // Returns the ValueNodeView this identifier refers to. Cannot be called
  // before name resolution.
  auto value_node() const -> const ValueNodeView& { return *value_node_; }

  // Sets the value returned by value_node. Can be called only during name
  // resolution.
  void set_value_node(ValueNodeView value_node) {
    CARBON_CHECK(!value_node_.has_value() || value_node_ == value_node);
    value_node_ = std::move(value_node);
  }

 private:
  std::string name_;
  std::optional<ValueNodeView> value_node_;
};

// A `.Self` expression within either a `:!` binding or a standalone `where`
// expression.
//
// In a `:!` binding, the type of `.Self` is always `type`. For example, in
// `A:! AddableWith(.Self)`, the expression `.Self` refers to the same type as
// `A`, but with type `type`.
//
// In a `where` binding, the type of `.Self` is the constraint preceding the
// `where` keyword. For example, in `Foo where .Result impls Bar(.Self)`, the
// type of `.Self` is `Foo`.
class DotSelfExpression : public Expression {
 public:
  explicit DotSelfExpression(SourceLocation source_loc)
      : Expression(AstNodeKind::DotSelfExpression, source_loc) {}

  explicit DotSelfExpression(CloneContext& context,
                             const DotSelfExpression& other);

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromDotSelfExpression(node->kind());
  }

  // The self binding. Cannot be called before name resolution.
  auto self_binding() const -> const GenericBinding& { return **self_binding_; }
  auto self_binding() -> GenericBinding& { return **self_binding_; }

  // Sets the self binding. Called only during name resolution.
  void set_self_binding(Nonnull<GenericBinding*> self_binding) {
    CARBON_CHECK(!self_binding_.has_value() || self_binding_ == self_binding);
    self_binding_ = self_binding;
  }

 private:
  std::string name_;
  std::optional<Nonnull<GenericBinding*>> self_binding_;
};

class MemberAccessExpression : public Expression {
 public:
  explicit MemberAccessExpression(AstNodeKind kind, SourceLocation source_loc,
                                  Nonnull<Expression*> object)
      : Expression(kind, source_loc), object_(object) {}

  explicit MemberAccessExpression(CloneContext& context,
                                  const MemberAccessExpression& other);

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromMemberAccessExpression(node->kind());
  }

  auto object() const -> const Expression& { return *object_; }
  auto object() -> Expression& { return *object_; }

  // Can only be called by type-checking, if a conversion was required.
  void set_object(Nonnull<Expression*> object) { object_ = object; }

  // Returns true if this is an access of a member of the type of the object,
  // rather than an access of a member of the object itself. In this case, the
  // value of the object expression is ignored, and the type is accessed
  // instead.
  //
  // For example, given `x: Class`, `x.StaticFunction` is a type access
  // equivalent to `T.StaticFunction`, and given `T:! Interface` and `y: T`,
  // `y.AssociatedConstant` is a type access equivalent to
  // `T.AssociatedConstant`.
  auto is_type_access() const -> bool { return is_type_access_; }

  // Can only be called once, during typechecking.
  void set_is_type_access(bool type_access) { is_type_access_ = type_access; }

  // Returns true if the member is a method that has a "self" declaration in an
  // AddrPattern.
  auto is_addr_me_method() const -> bool { return is_addr_me_method_; }

  // Can only be called once, during typechecking.
  void set_is_addr_me_method() { is_addr_me_method_ = true; }

  // If `object` has a generic type, returns the witness value, which might be
  // either concrete or symbolic. Otherwise, returns `std::nullopt`. Should not
  // be called before typechecking.
  auto impl() const -> std::optional<Nonnull<const Witness*>> { return impl_; }

  // Can only be called once, during typechecking.
  void set_impl(Nonnull<const Witness*> impl) {
    CARBON_CHECK(!impl_.has_value());
    impl_ = impl;
  }

  // Returns the constant value of this expression, if one has been set. This
  // value will be used instead of accessing a member. Even if this is present,
  // the operand of the member access expression must still be evaluated, in
  // case it has side effects.
  auto constant_value() const -> std::optional<Nonnull<const Value*>> {
    return constant_value_;
  }

  // Sets the value returned by constant_value(). Can only be called once,
  // during typechecking.
  void set_constant_value(Nonnull<const Value*> value) {
    CARBON_CHECK(!constant_value_.has_value());
    constant_value_ = value;
  }

 private:
  Nonnull<Expression*> object_;
  bool is_type_access_ = false;
  bool is_addr_me_method_ = false;
  std::optional<Nonnull<const Witness*>> impl_;
  std::optional<Nonnull<const Value*>> constant_value_;
};

class SimpleMemberAccessExpression
    : public RewritableMixin<MemberAccessExpression> {
 public:
  explicit SimpleMemberAccessExpression(SourceLocation source_loc,
                                        Nonnull<Expression*> object,
                                        std::string member_name)
      : RewritableMixin(AstNodeKind::SimpleMemberAccessExpression, source_loc,
                        object),
        member_name_(std::move(member_name)) {}

  explicit SimpleMemberAccessExpression(
      CloneContext& context, const SimpleMemberAccessExpression& other);

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromSimpleMemberAccessExpression(node->kind());
  }

  auto member_name() const -> const std::string& { return member_name_; }

  // Returns the `NamedElement` that the member name resolved to.
  // Should not be called before typechecking.
  auto member() const -> const NamedElement& {
    CARBON_CHECK(member_.has_value());
    return *member_.value();
  }

  // Can only be called once, during typechecking.
  void set_member(Nonnull<const NamedElement*> member) { member_ = member; }

  // If `object` is a constrained type parameter and `member` was found in an
  // interface, returns that interface. Should not be called before
  // typechecking.
  auto found_in_interface() const
      -> std::optional<Nonnull<const InterfaceType*>> {
    return found_in_interface_;
  }

  // Can only be called once, during typechecking.
  void set_found_in_interface(Nonnull<const InterfaceType*> interface) {
    CARBON_CHECK(!found_in_interface_.has_value());
    found_in_interface_ = interface;
  }

  // Returns the ValueNodeView this identifier refers to, if this was
  // determined by name resolution. Cannot be called before name resolution.
  auto value_node() const -> std::optional<ValueNodeView> {
    return value_node_;
  }

  // Sets the value returned by value_node. Can be called only during name
  // resolution.
  void set_value_node(ValueNodeView value_node) {
    CARBON_CHECK(!value_node_.has_value() || value_node_ == value_node);
    value_node_ = std::move(value_node);
  }

 private:
  std::string member_name_;
  std::optional<Nonnull<const NamedElement*>> member_;
  std::optional<Nonnull<const InterfaceType*>> found_in_interface_;
  std::optional<ValueNodeView> value_node_;
};

// A compound member access expression of the form `object.(path)`.
//
// `path` is required to have `TypeOfMemberName` type, and describes the member
// being accessed, which is one of:
//
// -   An instance member of a type: `object.(Type.member)`.
// -   A non-instance member of an interface: `Type.(Interface.member)` or
//     `object.(Interface.member)`.
// -   An instance member of an interface: `object.(Interface.member)` or
//     `object.(Type.(Interface.member))`.
//
// Note that the `path` is evaluated during type-checking, not at runtime, so
// the corresponding `member` is determined statically.
class CompoundMemberAccessExpression : public MemberAccessExpression {
 public:
  explicit CompoundMemberAccessExpression(SourceLocation source_loc,
                                          Nonnull<Expression*> object,
                                          Nonnull<Expression*> path)
      : MemberAccessExpression(AstNodeKind::CompoundMemberAccessExpression,
                               source_loc, object),
        path_(path) {}

  explicit CompoundMemberAccessExpression(
      CloneContext& context, const CompoundMemberAccessExpression& other);

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromCompoundMemberAccessExpression(node->kind());
  }

  auto path() const -> const Expression& { return *path_; }
  auto path() -> Expression& { return *path_; }

  // Returns the `MemberName` value that evaluation of the path produced.
  // Should not be called before typechecking.
  auto member() const -> const MemberName& {
    CARBON_CHECK(member_.has_value());
    return **member_;
  }

  // Can only be called once, during typechecking.
  void set_member(Nonnull<const MemberName*> member) {
    CARBON_CHECK(!member_.has_value());
    member_ = member;
  }

 private:
  Nonnull<Expression*> path_;
  std::optional<Nonnull<const MemberName*>> member_;
};

class IndexExpression : public Expression {
 public:
  explicit IndexExpression(SourceLocation source_loc,
                           Nonnull<Expression*> object,
                           Nonnull<Expression*> offset)
      : Expression(AstNodeKind::IndexExpression, source_loc),
        object_(object),
        offset_(offset) {}

  explicit IndexExpression(CloneContext& context, const IndexExpression& other)
      : Expression(context, other),
        object_(context.Clone(other.object_)),
        offset_(context.Clone(other.offset_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromIndexExpression(node->kind());
  }

  auto object() const -> const Expression& { return *object_; }
  auto object() -> Expression& { return *object_; }
  auto offset() const -> const Expression& { return *offset_; }
  auto offset() -> Expression& { return *offset_; }

 private:
  Nonnull<Expression*> object_;
  Nonnull<Expression*> offset_;
};

class BaseAccessExpression : public MemberAccessExpression {
 public:
  explicit BaseAccessExpression(SourceLocation source_loc,
                                Nonnull<Expression*> object,
                                Nonnull<const BaseElement*> base)
      : MemberAccessExpression(AstNodeKind::BaseAccessExpression, source_loc,
                               object),
        base_(base) {
    set_static_type(&base->type());
    set_expression_category(ExpressionCategory::Value);
  }

  explicit BaseAccessExpression(CloneContext& context,
                                const BaseAccessExpression& other)
      : MemberAccessExpression(context, other),
        base_(context.Clone(other.base_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromBaseAccessExpression(node->kind());
  }

  auto element() const -> const BaseElement& { return *base_; }

 private:
  const Nonnull<const BaseElement*> base_;
};

class IntLiteral : public Expression {
 public:
  explicit IntLiteral(SourceLocation source_loc, int value)
      : Expression(AstNodeKind::IntLiteral, source_loc), value_(value) {}

  explicit IntLiteral(CloneContext& context, const IntLiteral& other)
      : Expression(context, other), value_(other.value_) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromIntLiteral(node->kind());
  }

  auto value() const -> int { return value_; }

 private:
  int value_;
};

class BoolLiteral : public Expression {
 public:
  explicit BoolLiteral(SourceLocation source_loc, bool value)
      : Expression(AstNodeKind::BoolLiteral, source_loc), value_(value) {}

  explicit BoolLiteral(CloneContext& context, const BoolLiteral& other)
      : Expression(context, other), value_(other.value_) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromBoolLiteral(node->kind());
  }

  auto value() const -> bool { return value_; }

 private:
  bool value_;
};

class StringLiteral : public Expression {
 public:
  explicit StringLiteral(SourceLocation source_loc, std::string value)
      : Expression(AstNodeKind::StringLiteral, source_loc),
        value_(std::move(value)) {}

  explicit StringLiteral(CloneContext& context, const StringLiteral& other)
      : Expression(context, other), value_(other.value_) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromStringLiteral(node->kind());
  }

  auto value() const -> const std::string& { return value_; }

 private:
  std::string value_;
};

class StringTypeLiteral : public Expression {
 public:
  explicit StringTypeLiteral(SourceLocation source_loc)
      : Expression(AstNodeKind::StringTypeLiteral, source_loc) {}

  explicit StringTypeLiteral(CloneContext& context,
                             const StringTypeLiteral& other)
      : Expression(context, other) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromStringTypeLiteral(node->kind());
  }
};

class TupleLiteral : public Expression {
 public:
  explicit TupleLiteral(SourceLocation source_loc)
      : TupleLiteral(source_loc, {}) {}

  explicit TupleLiteral(SourceLocation source_loc,
                        std::vector<Nonnull<Expression*>> fields)
      : Expression(AstNodeKind::TupleLiteral, source_loc),
        fields_(std::move(fields)) {}

  explicit TupleLiteral(CloneContext& context, const TupleLiteral& other)
      : Expression(context, other), fields_(context.Clone(other.fields_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromTupleLiteral(node->kind());
  }

  auto fields() const -> llvm::ArrayRef<Nonnull<const Expression*>> {
    return fields_;
  }
  auto fields() -> llvm::ArrayRef<Nonnull<Expression*>> { return fields_; }

 private:
  std::vector<Nonnull<Expression*>> fields_;
};

// A literal value of a struct type.
class StructLiteral : public Expression {
 public:
  explicit StructLiteral(SourceLocation loc) : StructLiteral(loc, {}) {}

  explicit StructLiteral(SourceLocation loc,
                         std::vector<FieldInitializer> fields)
      : Expression(AstNodeKind::StructLiteral, loc),
        fields_(std::move(fields)) {}

  explicit StructLiteral(CloneContext& context, const StructLiteral& other)
      : Expression(context, other), fields_(context.Clone(other.fields_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromStructLiteral(node->kind());
  }

  auto fields() const -> llvm::ArrayRef<FieldInitializer> { return fields_; }
  auto fields() -> llvm::MutableArrayRef<FieldInitializer> { return fields_; }

 private:
  std::vector<FieldInitializer> fields_;
};

// A base class for literals with a constant value determined by type-checking.
class ConstantValueLiteral : public Expression {
 public:
  explicit ConstantValueLiteral(
      AstNodeKind kind, SourceLocation source_loc,
      std::optional<Nonnull<const Value*>> constant_value = std::nullopt)
      : Expression(kind, source_loc), constant_value_(constant_value) {}

  explicit ConstantValueLiteral(CloneContext& context,
                                const ConstantValueLiteral& other)
      : Expression(context, other),
        constant_value_(context.Clone(other.constant_value_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromConstantValueLiteral(node->kind());
  }

  // Returns the constant value of this expression.
  auto constant_value() const -> const Value& {
    CARBON_CHECK(constant_value_);
    return **constant_value_;
  }

  // Sets the value returned by constant_value(). Can only be called once,
  // during typechecking.
  void set_constant_value(Nonnull<const Value*> value) {
    CARBON_CHECK(!constant_value_.has_value());
    constant_value_ = value;
  }

 private:
  std::optional<Nonnull<const Value*>> constant_value_;
};

// A literal representing a struct type.
//
// Note that a struct type literal can't be empty because `{}` is a struct
// value. However, that value implicitly converts to a type.
class StructTypeLiteral : public ConstantValueLiteral {
 public:
  explicit StructTypeLiteral(SourceLocation loc,
                             std::vector<FieldInitializer> fields)
      : ConstantValueLiteral(AstNodeKind::StructTypeLiteral, loc),
        fields_(std::move(fields)) {
    CARBON_CHECK(!fields_.empty())
        << "`{}` is represented as a StructLiteral, not a StructTypeLiteral.";
  }

  explicit StructTypeLiteral(CloneContext& context,
                             const StructTypeLiteral& other)
      : ConstantValueLiteral(context, other),
        fields_(context.Clone(other.fields_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromStructTypeLiteral(node->kind());
  }

  auto fields() const -> llvm::ArrayRef<FieldInitializer> { return fields_; }
  auto fields() -> llvm::MutableArrayRef<FieldInitializer> { return fields_; }

 private:
  std::vector<FieldInitializer> fields_;
};

class OperatorExpression : public RewritableMixin<Expression> {
 public:
  explicit OperatorExpression(SourceLocation source_loc, Operator op,
                              std::vector<Nonnull<Expression*>> arguments)
      : RewritableMixin(AstNodeKind::OperatorExpression, source_loc),
        op_(op),
        arguments_(std::move(arguments)) {}

  explicit OperatorExpression(CloneContext& context,
                              const OperatorExpression& other)
      : RewritableMixin(context, other),
        op_(other.op_),
        arguments_(context.Clone(other.arguments_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromOperatorExpression(node->kind());
  }

  auto op() const -> Operator { return op_; }
  auto arguments() const -> llvm::ArrayRef<Nonnull<Expression*>> {
    return arguments_;
  }
  auto arguments() -> llvm::MutableArrayRef<Nonnull<Expression*>> {
    return arguments_;
  }

 private:
  Operator op_;
  std::vector<Nonnull<Expression*>> arguments_;
};

class CallExpression : public Expression {
 public:
  explicit CallExpression(SourceLocation source_loc,
                          Nonnull<Expression*> function,
                          Nonnull<Expression*> argument)
      : Expression(AstNodeKind::CallExpression, source_loc),
        function_(function),
        argument_(argument),
        bindings_({}, {}) {}

  explicit CallExpression(CloneContext& context, const CallExpression& other)
      : Expression(context, other),
        function_(context.Clone(other.function_)),
        argument_(context.Clone(other.argument_)),
        bindings_(context.Clone(other.bindings_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromCallExpression(node->kind());
  }

  auto function() const -> const Expression& { return *function_; }
  auto function() -> Expression& { return *function_; }
  auto argument() const -> const Expression& { return *argument_; }
  auto argument() -> Expression& { return *argument_; }

  auto bindings() -> const Bindings& { return bindings_; }

  // Can only be called once, during typechecking.
  void set_bindings(Bindings bindings) {
    CARBON_CHECK(bindings_.args().empty() && bindings_.witnesses().empty());
    bindings_ = std::move(bindings);
  }

  auto deduced_args() const -> const BindingMap& { return bindings_.args(); }

  // Maps each of `function`'s impl bindings to a witness.
  // Should not be called before typechecking, or if `function` is not
  // a generic function.
  auto witnesses() const -> const ImplWitnessMap& {
    return bindings_.witnesses();
  }

  // Can only be called by type-checking, if a conversion was required.
  void set_argument(Nonnull<Expression*> argument) { argument_ = argument; }

 private:
  Nonnull<Expression*> function_;
  Nonnull<Expression*> argument_;
  Bindings bindings_;
};

class FunctionTypeLiteral : public ConstantValueLiteral {
 public:
  explicit FunctionTypeLiteral(SourceLocation source_loc,
                               Nonnull<TupleLiteral*> parameter,
                               Nonnull<Expression*> return_type)
      : ConstantValueLiteral(AstNodeKind::FunctionTypeLiteral, source_loc),
        parameter_(parameter),
        return_type_(return_type) {}

  explicit FunctionTypeLiteral(CloneContext& context,
                               const FunctionTypeLiteral& other)
      : ConstantValueLiteral(context, other),
        parameter_(context.Clone(other.parameter_)),
        return_type_(context.Clone(other.return_type_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromFunctionTypeLiteral(node->kind());
  }

  auto parameter() const -> const TupleLiteral& { return *parameter_; }
  auto parameter() -> TupleLiteral& { return *parameter_; }
  auto return_type() const -> const Expression& { return *return_type_; }
  auto return_type() -> Expression& { return *return_type_; }

 private:
  Nonnull<TupleLiteral*> parameter_;
  Nonnull<Expression*> return_type_;
};

class BoolTypeLiteral : public Expression {
 public:
  explicit BoolTypeLiteral(SourceLocation source_loc)
      : Expression(AstNodeKind::BoolTypeLiteral, source_loc) {}

  explicit BoolTypeLiteral(CloneContext& context, const BoolTypeLiteral& other)
      : Expression(context, other) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromBoolTypeLiteral(node->kind());
  }
};

class IntTypeLiteral : public Expression {
 public:
  explicit IntTypeLiteral(SourceLocation source_loc)
      : Expression(AstNodeKind::IntTypeLiteral, source_loc) {}

  explicit IntTypeLiteral(CloneContext& context, const IntTypeLiteral& other)
      : Expression(context, other) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromIntTypeLiteral(node->kind());
  }
};

class TypeTypeLiteral : public Expression {
 public:
  explicit TypeTypeLiteral(SourceLocation source_loc)
      : Expression(AstNodeKind::TypeTypeLiteral, source_loc) {}

  explicit TypeTypeLiteral(CloneContext& context, const TypeTypeLiteral& other)
      : Expression(context, other) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromTypeTypeLiteral(node->kind());
  }
};

// A literal value. This is used in desugaring, and can't be expressed in
// source syntax.
class ValueLiteral : public ConstantValueLiteral {
 public:
  // Value literals are created by type-checking, and so are created with their
  // type and value category already known.
  ValueLiteral(SourceLocation source_loc, Nonnull<const Value*> value,
               Nonnull<const Value*> type,
               ExpressionCategory expression_category)
      : ConstantValueLiteral(AstNodeKind::ValueLiteral, source_loc, value) {
    set_static_type(type);
    set_expression_category(expression_category);
  }

  explicit ValueLiteral(CloneContext& context, const ValueLiteral& other)
      : ConstantValueLiteral(context, other) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromValueLiteral(node->kind());
  }
};

class IntrinsicExpression : public Expression {
 public:
  enum class Intrinsic {
    Print,
    Alloc,
    Dealloc,
    Rand,
    ImplicitAs,
    ImplicitAsConvert,
    IntEq,
    StrEq,
    StrCompare,
    IntCompare,
    IntBitAnd,
    IntBitOr,
    IntBitXor,
    IntBitComplement,
    IntLeftShift,
    IntRightShift,
    Assert,
  };

  // Returns the enumerator corresponding to the intrinsic named `name`,
  // or raises a fatal compile error if there is no such enumerator.
  static auto FindIntrinsic(std::string_view name, SourceLocation source_loc)
      -> ErrorOr<Intrinsic>;

  explicit IntrinsicExpression(Intrinsic intrinsic, Nonnull<TupleLiteral*> args,
                               SourceLocation source_loc)
      : Expression(AstNodeKind::IntrinsicExpression, source_loc),
        intrinsic_(intrinsic),
        args_(args) {}

  explicit IntrinsicExpression(CloneContext& context,
                               const IntrinsicExpression& other)
      : Expression(context, other),
        intrinsic_(other.intrinsic_),
        args_(context.Clone(other.args_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromIntrinsicExpression(node->kind());
  }

  auto intrinsic() const -> Intrinsic { return intrinsic_; }
  auto name() const -> std::string_view;
  auto args() const -> const TupleLiteral& { return *args_; }
  auto args() -> TupleLiteral& { return *args_; }

 private:
  Intrinsic intrinsic_;
  Nonnull<TupleLiteral*> args_;
};

class IfExpression : public Expression {
 public:
  explicit IfExpression(SourceLocation source_loc,
                        Nonnull<Expression*> condition,
                        Nonnull<Expression*> then_expression,
                        Nonnull<Expression*> else_expression)
      : Expression(AstNodeKind::IfExpression, source_loc),
        condition_(condition),
        then_expression_(then_expression),
        else_expression_(else_expression) {}

  explicit IfExpression(CloneContext& context, const IfExpression& other)
      : Expression(context, other),
        condition_(context.Clone(other.condition_)),
        then_expression_(context.Clone(other.then_expression_)),
        else_expression_(context.Clone(other.else_expression_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromIfExpression(node->kind());
  }

  auto condition() const -> const Expression& { return *condition_; }
  auto condition() -> Expression& { return *condition_; }

  auto then_expression() const -> const Expression& {
    return *then_expression_;
  }
  auto then_expression() -> Expression& { return *then_expression_; }

  auto else_expression() const -> const Expression& {
    return *else_expression_;
  }
  auto else_expression() -> Expression& { return *else_expression_; }

  // Can only be called by type-checking, if a conversion was required.
  void set_condition(Nonnull<Expression*> condition) { condition_ = condition; }

 private:
  Nonnull<Expression*> condition_;
  Nonnull<Expression*> then_expression_;
  Nonnull<Expression*> else_expression_;
};

// A clause appearing on the right-hand side of a `where` operator that forms a
// more precise constraint from a more general one.
class WhereClause : public AstNode {
 public:
  ~WhereClause() override = 0;

  void Print(llvm::raw_ostream& out) const override;
  void PrintID(llvm::raw_ostream& out) const override;

  static auto classof(const AstNode* node) {
    return InheritsFromWhereClause(node->kind());
  }

  auto kind() const -> WhereClauseKind {
    return static_cast<WhereClauseKind>(root_kind());
  }

 protected:
  explicit WhereClause(WhereClauseKind kind, SourceLocation source_loc)
      : AstNode(static_cast<AstNodeKind>(kind), source_loc) {}

  explicit WhereClause(CloneContext& context, const WhereClause& other)
      : AstNode(context, other) {}
};

// An `impls` where clause.
//
// For example, `ConstraintA where .Type impls ConstraintB` requires that the
// associated type `.Type` implements the constraint `ConstraintB`.
class ImplsWhereClause : public WhereClause {
 public:
  explicit ImplsWhereClause(SourceLocation source_loc,
                            Nonnull<Expression*> type,
                            Nonnull<Expression*> constraint)
      : WhereClause(WhereClauseKind::ImplsWhereClause, source_loc),
        type_(type),
        constraint_(constraint) {}

  explicit ImplsWhereClause(CloneContext& context,
                            const ImplsWhereClause& other)
      : WhereClause(context, other),
        type_(context.Clone(other.type_)),
        constraint_(context.Clone(other.constraint_)) {}

  static auto classof(const AstNode* node) {
    return InheritsFromImplsWhereClause(node->kind());
  }

  auto type() const -> const Expression& { return *type_; }
  auto type() -> Expression& { return *type_; }

  auto constraint() const -> const Expression& { return *constraint_; }
  auto constraint() -> Expression& { return *constraint_; }

 private:
  Nonnull<Expression*> type_;
  Nonnull<Expression*> constraint_;
};

// An `==` where clause.
//
// For example, `Constraint where .Type == i32` requires that the associated
// type `.Type` is `i32`.
class EqualsWhereClause : public WhereClause {
 public:
  explicit EqualsWhereClause(SourceLocation source_loc,
                             Nonnull<Expression*> lhs, Nonnull<Expression*> rhs)
      : WhereClause(WhereClauseKind::EqualsWhereClause, source_loc),
        lhs_(lhs),
        rhs_(rhs) {}

  explicit EqualsWhereClause(CloneContext& context,
                             const EqualsWhereClause& other)
      : WhereClause(context, other),
        lhs_(context.Clone(other.lhs_)),
        rhs_(context.Clone(other.rhs_)) {}

  static auto classof(const AstNode* node) {
    return InheritsFromEqualsWhereClause(node->kind());
  }

  auto lhs() const -> const Expression& { return *lhs_; }
  auto lhs() -> Expression& { return *lhs_; }

  auto rhs() const -> const Expression& { return *rhs_; }
  auto rhs() -> Expression& { return *rhs_; }

 private:
  Nonnull<Expression*> lhs_;
  Nonnull<Expression*> rhs_;
};

// An `=` where clause.
//
// For example, `Constraint where .Type = i32` specifies that the associated
// type `.Type` is rewritten to `i32` whenever used.
class RewriteWhereClause : public WhereClause {
 public:
  explicit RewriteWhereClause(SourceLocation source_loc,
                              std::string member_name,
                              Nonnull<Expression*> replacement)
      : WhereClause(WhereClauseKind::RewriteWhereClause, source_loc),
        member_name_(std::move(member_name)),
        replacement_(replacement) {}

  explicit RewriteWhereClause(CloneContext& context,
                              const RewriteWhereClause& other)
      : WhereClause(context, other),
        member_name_(other.member_name_),
        replacement_(context.Clone(other.replacement_)) {}

  static auto classof(const AstNode* node) {
    return InheritsFromRewriteWhereClause(node->kind());
  }

  auto member_name() const -> std::string_view { return member_name_; }

  auto replacement() const -> const Expression& { return *replacement_; }
  auto replacement() -> Expression& { return *replacement_; }

 private:
  std::string member_name_;
  Nonnull<Expression*> replacement_;
};

// A `where` expression: `AddableWith(i32) where .Result == i32`.
//
// The first operand is rewritten to a generic binding, for example
// `.Self:! AddableWith(i32)`, which may be used in the clauses.
class WhereExpression : public RewritableMixin<Expression> {
 public:
  explicit WhereExpression(SourceLocation source_loc,
                           Nonnull<GenericBinding*> self_binding,
                           std::vector<Nonnull<WhereClause*>> clauses)
      : RewritableMixin(AstNodeKind::WhereExpression, source_loc),
        self_binding_(self_binding),
        clauses_(std::move(clauses)) {}

  explicit WhereExpression(CloneContext& context, const WhereExpression& other);

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromWhereExpression(node->kind());
  }

  auto self_binding() const -> const GenericBinding& { return *self_binding_; }
  auto self_binding() -> GenericBinding& { return *self_binding_; }

  auto enclosing_dot_self() const
      -> std::optional<Nonnull<const GenericBinding*>> {
    return enclosing_dot_self_;
  }
  // Sets the enclosing value of `.Self`. Can only be called during name
  // resolution.
  void set_enclosing_dot_self(Nonnull<const GenericBinding*> dot_self) {
    CARBON_CHECK(!enclosing_dot_self_ || enclosing_dot_self_ == dot_self);
    enclosing_dot_self_ = dot_self;
  }

  auto clauses() const -> llvm::ArrayRef<Nonnull<const WhereClause*>> {
    return clauses_;
  }
  auto clauses() -> llvm::ArrayRef<Nonnull<WhereClause*>> { return clauses_; }

 private:
  Nonnull<GenericBinding*> self_binding_;
  std::vector<Nonnull<WhereClause*>> clauses_;
  std::optional<Nonnull<const GenericBinding*>> enclosing_dot_self_;
};

// A builtin conversion to a type determined by type-checking. These are
// created by type-checking when a type conversion is found to be necessary but
// that conversion is implemented directly rather than by an `ImplicitAs`
// implementation.
class BuiltinConvertExpression : public Expression {
 public:
  BuiltinConvertExpression(Nonnull<Expression*> source_expression,
                           Nonnull<const Value*> destination_type)
      : Expression(AstNodeKind::BuiltinConvertExpression,
                   source_expression->source_loc()),
        source_expression_(source_expression) {
    set_static_type(destination_type);
    set_expression_category(ExpressionCategory::Value);
  }

  explicit BuiltinConvertExpression(CloneContext& context,
                                    const BuiltinConvertExpression& other)
      : Expression(context, other),
        source_expression_(context.Clone(other.source_expression_)),
        rewritten_form_(context.Clone(other.rewritten_form_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromBuiltinConvertExpression(node->kind());
  }

  auto source_expression() -> Nonnull<Expression*> {
    return source_expression_;
  }
  auto source_expression() const -> Nonnull<const Expression*> {
    return source_expression_;
  }

  // Set the rewritten form of this expression. Can only be called during type
  // checking.
  auto set_rewritten_form(Nonnull<const Expression*> rewritten_form) -> void {
    CARBON_CHECK(!rewritten_form_.has_value()) << "rewritten form set twice";
    rewritten_form_ = rewritten_form;
  }

  // Get the rewritten form of this expression. A rewritten form can be used to
  // prepare the conversion during type checking.
  auto rewritten_form() const -> std::optional<Nonnull<const Expression*>> {
    return rewritten_form_;
  }

 private:
  Nonnull<Expression*> source_expression_;
  std::optional<Nonnull<const Expression*>> rewritten_form_;
};

// An expression whose semantics have not been implemented. This can be used
// as a placeholder during development, in order to implement and test parsing
// of a new expression syntax without having to implement its semantics.
class UnimplementedExpression : public Expression {
 public:
  // Constructs an UnimplementedExpression with the given label and the given
  // children, which must all be convertible to Nonnull<AstNode*>. The label
  // should correspond roughly to the name of the class that will eventually
  // replace this usage of UnimplementedExpression.
  template <typename... Children>
  UnimplementedExpression(SourceLocation source_loc, std::string label,
                          Children... children)
      : Expression(AstNodeKind::UnimplementedExpression, source_loc),
        label_(std::move(label)) {
    AddChildren(children...);
  }

  explicit UnimplementedExpression(CloneContext& context,
                                   const UnimplementedExpression& other)
      : Expression(context, other),
        label_(other.label_),
        children_(context.Clone(other.children_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromUnimplementedExpression(node->kind());
  }

  auto label() const -> std::string_view { return label_; }
  auto children() const -> llvm::ArrayRef<Nonnull<const AstNode*>> {
    return children_;
  }

 private:
  void AddChildren() {}

  template <typename... Children>
  void AddChildren(Nonnull<AstNode*> child, Children... children) {
    children_.push_back(child);
    AddChildren(children...);
  }

  std::string label_;
  std::vector<Nonnull<AstNode*>> children_;
};

// A literal representing a statically-sized array type.
class ArrayTypeLiteral : public ConstantValueLiteral {
 public:
  // Constructs an array type literal which uses the given expressions to
  // represent the element type and size.
  explicit ArrayTypeLiteral(SourceLocation source_loc,
                            Nonnull<Expression*> element_type_expression,
                            Nonnull<Expression*> size_expression)
      : ConstantValueLiteral(AstNodeKind::ArrayTypeLiteral, source_loc),
        element_type_expression_(element_type_expression),
        size_expression_(size_expression) {}

  explicit ArrayTypeLiteral(CloneContext& context,
                            const ArrayTypeLiteral& other)
      : ConstantValueLiteral(context, other),
        element_type_expression_(context.Clone(other.element_type_expression_)),
        size_expression_(context.Clone(other.size_expression_)) {}

  static auto classof(const AstNode* node) -> bool {
    return InheritsFromArrayTypeLiteral(node->kind());
  }

  auto element_type_expression() const -> const Expression& {
    return *element_type_expression_;
  }
  auto element_type_expression() -> Expression& {
    return *element_type_expression_;
  }

  auto size_expression() const -> const Expression& {
    return *size_expression_;
  }
  auto size_expression() -> Expression& { return *size_expression_; }

 private:
  Nonnull<Expression*> element_type_expression_;
  Nonnull<Expression*> size_expression_;
};

// Converts paren_contents to an Expression, interpreting the parentheses as
// grouping if their contents permit that interpretation, or as forming a
// tuple otherwise.
auto ExpressionFromParenContents(
    Nonnull<Arena*> arena, SourceLocation source_loc,
    const ParenContents<Expression>& paren_contents) -> Nonnull<Expression*>;

// Converts paren_contents to an Expression, interpreting the parentheses as
// forming a tuple.
auto TupleExpressionFromParenContents(
    Nonnull<Arena*> arena, SourceLocation source_loc,
    const ParenContents<Expression>& paren_contents) -> Nonnull<TupleLiteral*>;

}  // namespace Carbon

#endif  // CARBON_EXPLORER_AST_EXPRESSION_H_