Skip to content
281 changes: 281 additions & 0 deletions compiler/rustc_hir_typeck/src/_if.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
use rustc_errors::Diag;
use rustc_hir::{self as hir, HirId};
use rustc_infer::traits;
use rustc_middle::ty::{Ty, TypeVisitableExt};
use rustc_span::{ErrorGuaranteed, Span};
use smallvec::SmallVec;

use crate::coercion::{CoerceMany, DynamicCoerceMany};
use crate::{Diverges, Expectation, FnCtxt, bug};

#[derive(Clone, Debug)]
struct BranchBody<'tcx> {
expr: &'tcx hir::Expr<'tcx>,
ty: Ty<'tcx>,
diverges: Diverges,
span: Span,
}

#[derive(Clone, Debug)]
struct IfGuardedBranch<'tcx> {
if_expr: &'tcx hir::Expr<'tcx>,
cond_diverges: Diverges,
body: BranchBody<'tcx>,
}

#[derive(Default, Debug)]
struct IfGuardedBranches<'tcx> {
branches: SmallVec<[IfGuardedBranch<'tcx>; 4]>,
cond_error: Option<ErrorGuaranteed>,
}

#[derive(Clone, Debug)]
enum IfChainTail<'tcx> {
FinalElse(BranchBody<'tcx>),
Missing(&'tcx hir::Expr<'tcx>),
}

impl<'tcx> IfChainTail<'tcx> {
fn expr(&self) -> &'tcx hir::Expr<'tcx> {
match &self {
IfChainTail::FinalElse(else_branch) => else_branch.expr,
IfChainTail::Missing(last_if_expr) => *last_if_expr,
}
}

fn diverges(&self) -> Diverges {
match &self {
IfChainTail::FinalElse(else_branch) => else_branch.diverges,
IfChainTail::Missing(_) => Diverges::Maybe,
}
}
}

impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
pub(crate) fn check_expr_if(
&self,
expr_id: HirId,
sp: Span,
orig_expected: Expectation<'tcx>,
) -> Ty<'tcx> {
let root_if_expr = self.tcx.hir_expect_expr(expr_id);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't particularly like the change to not take in the fields of ExprKind::If - and I think that these fields should be passed through too (to avoid the bug! path in collect_if_branch.

Instead of passing the fields separately, could just make a new struct in this module to keep things clean.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a struct to avoid the bug! in collect_if_branch

refactor: pass cond, then, else to reduce use of

let expected = orig_expected.try_structurally_resolve_and_adjust_for_branches(self, sp);

let initial_diverges = self.diverges.get();

let (guarded, tail) = self.collect_if_chain(root_if_expr, expected);

let coerce_to_ty = expected.coercion_target_type(self, sp);
let mut coerce: DynamicCoerceMany<'_> = CoerceMany::new(coerce_to_ty);

let tail_defines_return_position_impl_trait =
self.return_position_impl_trait_from_match_expectation(orig_expected);

for (idx, branch) in guarded.branches.iter().enumerate() {
if idx > 0 {
let merged_ty = coerce.merged_ty();
self.ensure_if_branch_type(branch.if_expr.hir_id, merged_ty);
}

let branch_body = &branch.body;
let next_else_expr =
guarded.branches.get(idx + 1).map(|next| next.if_expr).or(tail.expr().into());
let opt_prev_branch = if idx > 0 { guarded.branches.get(idx - 1) } else { None };
let mut branch_cause = if let Some(next_else_expr) = next_else_expr {
self.if_cause(
opt_prev_branch.unwrap_or(branch).if_expr.hir_id,
next_else_expr,
tail_defines_return_position_impl_trait,
)
} else {
self.misc(branch_body.span)
};
let cause_span =
if idx == 0 { Some(root_if_expr.span) } else { Some(branch_body.span) };

self.coerce_if_arm(
&mut coerce,
&mut branch_cause,
branch_body.expr,
branch_body.ty,
cause_span,
opt_prev_branch.and_then(|b| b.body.span.into()),
);
}

match &tail {
IfChainTail::FinalElse(else_branch) => {
let mut else_cause = self.if_cause(
expr_id,
else_branch.expr,
tail_defines_return_position_impl_trait,
);
self.coerce_if_arm(
&mut coerce,
&mut else_cause,
else_branch.expr,
else_branch.ty,
None,
guarded.branches.last().and_then(|b| b.body.span.into()),
);
}
IfChainTail::Missing(last_if_expr) => {
let hir::ExprKind::If(tail_cond, tail_then, _) = last_if_expr.kind else {
bug!("expected `if` expression, found {:#?}", last_if_expr);
};
self.if_fallback_coercion(last_if_expr.span, tail_cond, tail_then, &mut coerce);
}
}

self.set_diverges(initial_diverges, &guarded, &tail);

let result_ty = coerce.complete(self);

let final_ty = if let Some(guar) = guarded.cond_error {
Ty::new_error(self.tcx, guar)
} else {
result_ty
};

for branch in guarded.branches.iter().skip(1) {
self.overwrite_if_branch_type(branch.if_expr.hir_id, final_ty);
}
if let Err(guar) = final_ty.error_reported() {
self.set_tainted_by_errors(guar);
}

final_ty
}

fn coerce_if_arm(
&self,
coerce: &mut DynamicCoerceMany<'tcx>,
cause: &mut traits::ObligationCause<'tcx>,
expr: &'tcx hir::Expr<'tcx>,
ty: Ty<'tcx>,
cause_span: Option<Span>,
prev_branch_span: Option<Span>,
) {
if let Some(span) = cause_span {
cause.span = span;
}
coerce.coerce_inner(
self,
cause,
Some(expr),
ty,
move |err| self.explain_if_branch_mismatch(err, prev_branch_span),
false,
);
}

fn check_if_condition(
&self,
cond_expr: &'tcx hir::Expr<'tcx>,
then_span: Span,
) -> (Ty<'tcx>, Diverges) {
let cond_ty = self.check_expr_has_type_or_error(cond_expr, self.tcx.types.bool, |_| {});
self.warn_if_unreachable(
cond_expr.hir_id,
then_span,
"block in `if` or `while` expression",
);
let cond_diverges = self.take_diverges();
(cond_ty, cond_diverges)
}

fn collect_if_chain(
&self,
mut current_if: &'tcx hir::Expr<'tcx>,
expected: Expectation<'tcx>,
) -> (IfGuardedBranches<'tcx>, IfChainTail<'tcx>) {
let mut chain: IfGuardedBranches<'tcx> = IfGuardedBranches::default();

loop {
let Some(else_expr) = self.collect_if_branch(current_if, expected, &mut chain) else {
return (chain, IfChainTail::Missing(current_if));
};

if let hir::ExprKind::If(..) = else_expr.kind {
current_if = else_expr;
continue;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something seems weird to me...what is there both an optional return in collect_if_branch and a check for ExprKind::If for the kind?

I guess, perhaps, I could see some duplicate logic here - you should be able to maintain all the state in chain, I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed duplicate logics and added some extra refactorings(sorry it if is hard to check diffs....)

refactor: remove duplicate logic for checking Expr content. and some …


return (chain, IfChainTail::FinalElse(self.check_branch_body(else_expr, expected)));
}
}

fn collect_if_branch(
&self,
if_expr: &'tcx hir::Expr<'tcx>,
expected: Expectation<'tcx>,
chain: &mut IfGuardedBranches<'tcx>,
) -> Option<&'tcx hir::Expr<'tcx>> {
let hir::ExprKind::If(cond_expr, then_expr, opt_else_expr) = if_expr.kind else {
bug!("expected `if` expression, found {:#?}", if_expr);
};

let (cond_ty, cond_diverges) = self.check_if_condition(cond_expr, then_expr.span);
if let Err(guar) = cond_ty.error_reported() {
chain.cond_error.get_or_insert(guar);
}
let branch_body = self.check_branch_body(then_expr, expected);

chain.branches.push(IfGuardedBranch { if_expr, cond_diverges, body: branch_body });

opt_else_expr
}

fn reset_diverges_to_maybe(&self) {
self.diverges.set(Diverges::Maybe);
}

fn take_diverges(&self) -> Diverges {
let diverges = self.diverges.get();
self.reset_diverges_to_maybe();
diverges
}

fn ensure_if_branch_type(&self, hir_id: HirId, ty: Ty<'tcx>) {
let mut typeck = self.typeck_results.borrow_mut();
let mut node_ty = typeck.node_types_mut();
node_ty.entry(hir_id).or_insert(ty);
}

fn overwrite_if_branch_type(&self, hir_id: HirId, ty: Ty<'tcx>) {
let mut typeck = self.typeck_results.borrow_mut();
let mut node_ty = typeck.node_types_mut();
node_ty.insert(hir_id, ty);
}

fn check_branch_body(
&self,
expr: &'tcx hir::Expr<'tcx>,
expected: Expectation<'tcx>,
) -> BranchBody<'tcx> {
self.reset_diverges_to_maybe();
let ty = self.check_expr_with_expectation(expr, expected);
let diverges = self.take_diverges();
let span = self.find_block_span_from_hir_id(expr.hir_id);
BranchBody { expr, ty, diverges, span }
}

fn explain_if_branch_mismatch(&self, err: &mut Diag<'_>, prev_branch_span: Option<Span>) {
if let Some(prev_branch_span) = prev_branch_span {
err.span_label(prev_branch_span, "expected because of this");
}
}

fn set_diverges(
&self,
initial_diverges: Diverges,
guarded: &IfGuardedBranches<'tcx>,
tail: &IfChainTail<'tcx>,
) {
let mut tail_diverges = tail.diverges();
for branch in guarded.branches.iter().rev() {
tail_diverges = branch.cond_diverges | (branch.body.diverges & tail_diverges);
}
self.diverges.set(initial_diverges | tail_diverges);
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm actually not a fan of splitting this (along with reset_diverges_to_maybe and take_diverges) into separate functions.

I guess, the more I look over this, I also am not a huge fan of explain_if_branch_mismatch either.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will check other comments tomorrow 🙇

72 changes: 2 additions & 70 deletions compiler/rustc_hir_typeck/src/expr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ use tracing::{debug, instrument, trace};
use {rustc_ast as ast, rustc_hir as hir};

use crate::Expectation::{self, ExpectCastableToType, ExpectHasType, NoExpectation};
use crate::coercion::{CoerceMany, DynamicCoerceMany};
use crate::coercion::CoerceMany;
use crate::errors::{
AddressOfTemporaryTaken, BaseExpressionDoubleDot, BaseExpressionDoubleDotAddExpr,
BaseExpressionDoubleDotRemove, CantDereference, FieldMultiplySpecifiedInInitializer,
Expand Down Expand Up @@ -584,9 +584,7 @@ impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
self.demand_eqtype(e.span, ascribed_ty, ty);
ascribed_ty
}
ExprKind::If(cond, then_expr, opt_else_expr) => {
self.check_expr_if(expr.hir_id, cond, then_expr, opt_else_expr, expr.span, expected)
}
ExprKind::If(..) => self.check_expr_if(expr.hir_id, expr.span, expected),
ExprKind::DropTemps(e) => self.check_expr_with_expectation(e, expected),
ExprKind::Array(args) => self.check_expr_array(args, expected, expr),
ExprKind::ConstBlock(ref block) => self.check_expr_const_block(block, expected),
Expand Down Expand Up @@ -1341,72 +1339,6 @@ impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
}
}

// A generic function for checking the 'then' and 'else' clauses in an 'if'
// or 'if-else' expression.
fn check_expr_if(
&self,
expr_id: HirId,
cond_expr: &'tcx hir::Expr<'tcx>,
then_expr: &'tcx hir::Expr<'tcx>,
opt_else_expr: Option<&'tcx hir::Expr<'tcx>>,
sp: Span,
orig_expected: Expectation<'tcx>,
) -> Ty<'tcx> {
let cond_ty = self.check_expr_has_type_or_error(cond_expr, self.tcx.types.bool, |_| {});

self.warn_if_unreachable(
cond_expr.hir_id,
then_expr.span,
"block in `if` or `while` expression",
);

let cond_diverges = self.diverges.get();
self.diverges.set(Diverges::Maybe);

let expected = orig_expected.try_structurally_resolve_and_adjust_for_branches(self, sp);
let then_ty = self.check_expr_with_expectation(then_expr, expected);
let then_diverges = self.diverges.get();
self.diverges.set(Diverges::Maybe);

// We've already taken the expected type's preferences
// into account when typing the `then` branch. To figure
// out the initial shot at a LUB, we thus only consider
// `expected` if it represents a *hard* constraint
// (`only_has_type`); otherwise, we just go with a
// fresh type variable.
let coerce_to_ty = expected.coercion_target_type(self, sp);
let mut coerce: DynamicCoerceMany<'_> = CoerceMany::new(coerce_to_ty);

coerce.coerce(self, &self.misc(sp), then_expr, then_ty);

if let Some(else_expr) = opt_else_expr {
let else_ty = self.check_expr_with_expectation(else_expr, expected);
let else_diverges = self.diverges.get();

let tail_defines_return_position_impl_trait =
self.return_position_impl_trait_from_match_expectation(orig_expected);
let if_cause =
self.if_cause(expr_id, else_expr, tail_defines_return_position_impl_trait);

coerce.coerce(self, &if_cause, else_expr, else_ty);

// We won't diverge unless both branches do (or the condition does).
self.diverges.set(cond_diverges | then_diverges & else_diverges);
} else {
self.if_fallback_coercion(sp, cond_expr, then_expr, &mut coerce);

// If the condition is false we can't diverge.
self.diverges.set(cond_diverges);
}

let result_ty = coerce.complete(self);
if let Err(guar) = cond_ty.error_reported() {
Ty::new_error(self.tcx, guar)
} else {
result_ty
}
}

/// Type check assignment expression `expr` of form `lhs = rhs`.
/// The expected type is `()` and is passed to the function for the purposes of diagnostics.
fn check_expr_assign(
Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_hir_typeck/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#![feature(never_type)]
// tidy-alphabetical-end

mod _if;
mod _match;
mod autoderef;
mod callee;
Expand Down
Loading
Loading