gcc/rust/typecheck/rust-hir-type-check.cc

// Copyright (C) 2020-2025 Free Software Foundation, Inc.

// This file is part of GCC.

// GCC 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 3, or (at your option) any later
// version.

// GCC 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 GCC; see the file COPYING3.  If not see
// <http://www.gnu.org/licenses/>.

#include "rust-hir-type-check.h"
#include "rust-hir-full.h"
#include "rust-hir-inherent-impl-overlap.h"
#include "rust-hir-pattern.h"
#include "rust-hir-type-check-expr.h"
#include "rust-hir-type-check-item.h"
#include "rust-hir-type-check-pattern.h"
#include "rust-hir-type-check-struct-field.h"
#include "rust-immutable-name-resolution-context.h"

extern bool saw_errors (void);

namespace Rust {
namespace Resolver {

tl::optional<TyTy::Region>
TypeCheckContext::LifetimeResolver::resolve (const Lifetime &placeholder) const
{
  if (placeholder.is_static ())
    return TyTy::Region::make_static ();

  if (placeholder == Lifetime::anonymous_lifetime ())
    return TyTy::Region::make_anonymous ();

  for (auto it = lifetime_lookup.rbegin (); it != lifetime_lookup.rend (); ++it)
    {
      if (it->first == placeholder)
	{
	  if (it->second.scope <= ITEM_SCOPE)
	    {
	      // It is useful to have the static lifetime and named
	      // lifetimed disjoint so we add the +1 here.
	      return (is_body)
		       ? TyTy::Region::make_named (it->second.index + 1)
		       : TyTy::Region::make_early_bound (it->second.index);
	    }
	  else
	    {
	      return TyTy::Region::make_late_bound (get_current_scope ()
						      - it->second.scope,
						    it->second.index);
	    }
	}
    }

  return tl::nullopt;
}

void
TypeResolution::Resolve (HIR::Crate &crate)
{
  for (auto &it : crate.get_items ())
    TypeCheckItem::Resolve (*it);

  if (saw_errors ())
    return;

  OverlappingImplItemPass::go ();
  if (saw_errors ())
    return;

  auto context = TypeCheckContext::get ();
  context->compute_inference_variables (true);
}

// rust-hir-trait-ref.h

TraitItemReference::TraitItemReference (
  std::string identifier, bool optional, TraitItemType type,
  HIR::TraitItem *hir_trait_item, TyTy::BaseType *self,
  std::vector<TyTy::SubstitutionParamMapping> substitutions, location_t locus)
  : identifier (identifier), optional_flag (optional), type (type),
    hir_trait_item (hir_trait_item),
    inherited_substitutions (std::move (substitutions)), locus (locus),
    self (self), context (TypeCheckContext::get ())
{}

TraitItemReference::TraitItemReference (TraitItemReference const &other)
  : identifier (other.identifier), optional_flag (other.optional_flag),
    type (other.type), hir_trait_item (other.hir_trait_item),
    locus (other.locus), self (other.self), context (TypeCheckContext::get ())
{
  inherited_substitutions.clear ();
  inherited_substitutions.reserve (other.inherited_substitutions.size ());
  for (size_t i = 0; i < other.inherited_substitutions.size (); i++)
    inherited_substitutions.push_back (
      other.inherited_substitutions.at (i).clone ());
}

TraitItemReference &
TraitItemReference::operator= (TraitItemReference const &other)
{
  identifier = other.identifier;
  optional_flag = other.optional_flag;
  type = other.type;
  hir_trait_item = other.hir_trait_item;
  self = other.self;
  locus = other.locus;
  context = other.context;

  inherited_substitutions.clear ();
  inherited_substitutions.reserve (other.inherited_substitutions.size ());
  for (size_t i = 0; i < other.inherited_substitutions.size (); i++)
    inherited_substitutions.push_back (
      other.inherited_substitutions.at (i).clone ());

  return *this;
}

TyTy::BaseType *
TraitItemReference::get_type_from_typealias (/*const*/
					     HIR::TraitItemType &type) const
{
  TyTy::TyVar var (get_mappings ().get_hirid ());
  return var.get_tyty ();
}

TyTy::BaseType *
TraitItemReference::get_type_from_constant (
  /*const*/ HIR::TraitItemConst &constant) const
{
  TyTy::BaseType *type = TypeCheckType::Resolve (constant.get_type ());
  if (constant.has_expr ())
    {
      TyTy::BaseType *expr = TypeCheckExpr::Resolve (constant.get_expr ());

      return unify_site (constant.get_mappings ().get_hirid (),
			 TyTy::TyWithLocation (type),
			 TyTy::TyWithLocation (expr), constant.get_locus ());
    }
  return type;
}

TyTy::BaseType *
TraitItemReference::get_type_from_fn (/*const*/ HIR::TraitItemFunc &fn) const
{
  auto binder_pin = context->push_clean_lifetime_resolver ();

  std::vector<TyTy::SubstitutionParamMapping> substitutions
    = inherited_substitutions;

  TyTy::RegionConstraints region_constraints;
  HIR::TraitFunctionDecl &function = fn.get_decl ();
  if (function.has_generics ())
    {
      TypeCheckBase::ResolveGenericParams (HIR::Item::ItemKind::Function,
					   fn.get_locus (),
					   function.get_generic_params (),
					   substitutions, false /*is_foreign*/,
					   ABI::RUST);
    }

  if (function.has_where_clause ())
    {
      for (auto &where_clause_item : function.get_where_clause ().get_items ())
	ResolveWhereClauseItem::Resolve (*where_clause_item,
					 region_constraints);
    }

  TyTy::BaseType *ret_type = nullptr;
  if (!function.has_return_type ())
    ret_type = TyTy::TupleType::get_unit_type ();
  else
    {
      auto resolved = TypeCheckType::Resolve (function.get_return_type ());
      if (resolved->get_kind () == TyTy::TypeKind::ERROR)
	{
	  rust_error_at (fn.get_locus (), "failed to resolve return type");
	  return get_error ();
	}

      ret_type = resolved->clone ();
      ret_type->set_ref (
	function.get_return_type ().get_mappings ().get_hirid ());
    }

  std::vector<TyTy::FnParam> params;

  if (function.is_method ())
    {
      // these are implicit mappings and not used
      auto &mappings = Analysis::Mappings::get ();
      auto crate_num = mappings.get_current_crate ();
      Analysis::NodeMapping mapping (crate_num, mappings.get_next_node_id (),
				     mappings.get_next_hir_id (crate_num),
				     UNKNOWN_LOCAL_DEFID);

      // add the synthetic self param at the front, this is a placeholder
      // for compilation to know parameter names. The types are ignored
      // but we reuse the HIR identifier pattern which requires it
      HIR::SelfParam &self_param = function.get_self_unchecked ();
      std::unique_ptr<HIR::Pattern> self_pattern
	= std::make_unique<HIR::IdentifierPattern> (HIR::IdentifierPattern (
	  mapping, {"self"}, self_param.get_locus (), self_param.is_ref (),
	  self_param.is_mut () ? Mutability::Mut : Mutability::Imm,
	  std::unique_ptr<HIR::Pattern> (nullptr)));
      // might have a specified type
      TyTy::BaseType *self_type = nullptr;
      if (self_param.has_type ())
	{
	  HIR::Type &specified_type = self_param.get_type ();
	  self_type = TypeCheckType::Resolve (specified_type);
	}
      else
	{
	  switch (self_param.get_self_kind ())
	    {
	    case HIR::SelfParam::IMM:
	    case HIR::SelfParam::MUT:
	      self_type = self->clone ();
	      break;

	    case HIR::SelfParam::IMM_REF:
	    case HIR::SelfParam::MUT_REF:
	      {
		auto mutability
		  = self_param.get_self_kind () == HIR::SelfParam::IMM_REF
		      ? Mutability::Imm
		      : Mutability::Mut;
		rust_assert (self_param.has_lifetime ());

		auto maybe_region = context->lookup_and_resolve_lifetime (
		  self_param.get_lifetime ());

		if (!maybe_region.has_value ())
		  {
		    rust_error_at (self_param.get_locus (),
				   "failed to resolve lifetime");
		    return get_error ();
		  }
		self_type = new TyTy::ReferenceType (
		  self_param.get_mappings ().get_hirid (),
		  TyTy::TyVar (self->get_ref ()), mutability,
		  maybe_region.value ());
	      }
	      break;

	    default:
	      rust_unreachable ();
	      return nullptr;
	    }
	}

      context->insert_type (self_param.get_mappings (), self_type);
      params.push_back (TyTy::FnParam (std::move (self_pattern), self_type));
    }

  for (auto &param : function.get_function_params ())
    {
      // get the name as well required for later on
      auto param_tyty = TypeCheckType::Resolve (param.get_type ());
      context->insert_type (param.get_mappings (), param_tyty);
      TypeCheckPattern::Resolve (param.get_param_name (), param_tyty);
      // FIXME: Should we take the name ? Use a shared pointer instead ?
      params.push_back (
	TyTy::FnParam (param.get_param_name ().clone_pattern (), param_tyty));
    }

  auto &nr_ctx
    = Resolver2_0::ImmutableNameResolutionContext::get ().resolver ();

  CanonicalPath canonical_path
    = nr_ctx.to_canonical_path (fn.get_mappings ().get_nodeid ());

  RustIdent ident{canonical_path, fn.get_locus ()};
  auto resolved = new TyTy::FnType (
    fn.get_mappings ().get_hirid (), fn.get_mappings ().get_defid (),
    function.get_function_name ().as_string (), ident,
    function.is_method () ? TyTy::FnType::FNTYPE_IS_METHOD_FLAG
			  : TyTy::FnType::FNTYPE_DEFAULT_FLAGS,
    ABI::RUST, std::move (params), ret_type, substitutions,
    TyTy::SubstitutionArgumentMappings::empty (
      context->get_lifetime_resolver ().get_num_bound_regions ()),
    region_constraints);
  context->insert_type (fn.get_mappings (), resolved);
  return resolved;
}

} // namespace Resolver
} // namespace Rust