Skip to content

Commit 11909e3

Browse files
borsbors
committed
Auto merge of rust-lang#95096 - GuillaumeGomez:rm-header-fn-field, r=camelid
Remove header field from clean::Function Fixes rust-lang#89673. This is another take on rust-lang#89673 (compared to rust-lang#91217) but very different on the approach: I moved the header call in one place but still require to have the `clean::Item` so I can use the `DefId` to get what is missing. cc `@jyn514` (you reviewed the original so maybe you want to take a look?) r? `@camelid`
2 parents e2301ca + 8071332 commit 11909e3

File tree

7 files changed

+100
-113
lines changed

7 files changed

+100
-113
lines changed

Diff for: ‎src/librustdoc/clean/inline.rs

+1-8
Original file line numberDiff line numberDiff line change
@@ -221,21 +221,14 @@ crate fn build_external_trait(cx: &mut DocContext<'_>, did: DefId) -> clean::Tra
221221
fn build_external_function(cx: &mut DocContext<'_>, did: DefId) -> clean::Function {
222222
let sig = cx.tcx.fn_sig(did);
223223

224-
let constness =
225-
if cx.tcx.is_const_fn_raw(did) { hir::Constness::Const } else { hir::Constness::NotConst };
226-
let asyncness = cx.tcx.asyncness(did);
227224
let predicates = cx.tcx.predicates_of(did);
228225
let (generics, decl) = clean::enter_impl_trait(cx, |cx| {
229226
// NOTE: generics need to be cleaned before the decl!
230227
let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
231228
let decl = clean_fn_decl_from_did_and_sig(cx, Some(did), sig);
232229
(generics, decl)
233230
});
234-
clean::Function {
235-
decl,
236-
generics,
237-
header: hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness },
238-
}
231+
clean::Function { decl, generics }
239232
}
240233

241234
fn build_enum(cx: &mut DocContext<'_>, did: DefId) -> clean::Enum {

Diff for: ‎src/librustdoc/clean/mod.rs

+7-74
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ crate mod utils;
1212

1313
use rustc_ast as ast;
1414
use rustc_attr as attr;
15-
use rustc_const_eval::const_eval::is_unstable_const_fn;
1615
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
1716
use rustc_hir as hir;
1817
use rustc_hir::def::{CtorKind, DefKind, Res};
@@ -26,8 +25,6 @@ use rustc_middle::{bug, span_bug};
2625
use rustc_span::hygiene::{AstPass, MacroKind};
2726
use rustc_span::symbol::{kw, sym, Ident, Symbol};
2827
use rustc_span::{self, ExpnKind};
29-
use rustc_target::spec::abi::Abi;
30-
use rustc_typeck::check::intrinsic::intrinsic_operation_unsafety;
3128
use rustc_typeck::hir_ty_to_ty;
3229

3330
use std::assert_matches::assert_matches;
@@ -813,13 +810,6 @@ fn clean_fn_or_proc_macro(
813810
}
814811
None => {
815812
let mut func = clean_function(cx, sig, generics, body_id);
816-
let def_id = item.def_id.to_def_id();
817-
func.header.constness =
818-
if cx.tcx.is_const_fn(def_id) && is_unstable_const_fn(cx.tcx, def_id).is_none() {
819-
hir::Constness::Const
820-
} else {
821-
hir::Constness::NotConst
822-
};
823813
clean_fn_decl_legacy_const_generics(&mut func, attrs);
824814
FunctionItem(func)
825815
}
@@ -869,7 +859,7 @@ fn clean_function(
869859
let decl = clean_fn_decl_with_args(cx, sig.decl, args);
870860
(generics, decl)
871861
});
872-
Function { decl, generics, header: sig.header }
862+
Function { decl, generics }
873863
}
874864

875865
fn clean_args_from_types_and_names(
@@ -998,12 +988,7 @@ impl Clean<Item> for hir::TraitItem<'_> {
998988
AssocConstItem(ty.clean(cx), default)
999989
}
1000990
hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Provided(body)) => {
1001-
let mut m = clean_function(cx, sig, &self.generics, body);
1002-
if m.header.constness == hir::Constness::Const
1003-
&& is_unstable_const_fn(cx.tcx, local_did).is_some()
1004-
{
1005-
m.header.constness = hir::Constness::NotConst;
1006-
}
991+
let m = clean_function(cx, sig, &self.generics, body);
1007992
MethodItem(m, None)
1008993
}
1009994
hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Required(names)) => {
@@ -1014,13 +999,7 @@ impl Clean<Item> for hir::TraitItem<'_> {
1014999
let decl = clean_fn_decl_with_args(cx, sig.decl, args);
10151000
(generics, decl)
10161001
});
1017-
let mut t = Function { header: sig.header, decl, generics };
1018-
if t.header.constness == hir::Constness::Const
1019-
&& is_unstable_const_fn(cx.tcx, local_did).is_some()
1020-
{
1021-
t.header.constness = hir::Constness::NotConst;
1022-
}
1023-
TyMethodItem(t)
1002+
TyMethodItem(Function { decl, generics })
10241003
}
10251004
hir::TraitItemKind::Type(bounds, ref default) => {
10261005
let generics = enter_impl_trait(cx, |cx| self.generics.clean(cx));
@@ -1047,12 +1026,7 @@ impl Clean<Item> for hir::ImplItem<'_> {
10471026
AssocConstItem(ty.clean(cx), default)
10481027
}
10491028
hir::ImplItemKind::Fn(ref sig, body) => {
1050-
let mut m = clean_function(cx, sig, &self.generics, body);
1051-
if m.header.constness == hir::Constness::Const
1052-
&& is_unstable_const_fn(cx.tcx, local_did).is_some()
1053-
{
1054-
m.header.constness = hir::Constness::NotConst;
1055-
}
1029+
let m = clean_function(cx, sig, &self.generics, body);
10561030
let defaultness = cx.tcx.associated_item(self.def_id).defaultness;
10571031
MethodItem(m, Some(defaultness))
10581032
}
@@ -1127,40 +1101,13 @@ impl Clean<Item> for ty::AssocItem {
11271101
ty::TraitContainer(_) => self.defaultness.has_value(),
11281102
};
11291103
if provided {
1130-
let constness = if tcx.is_const_fn_raw(self.def_id) {
1131-
hir::Constness::Const
1132-
} else {
1133-
hir::Constness::NotConst
1134-
};
1135-
let asyncness = tcx.asyncness(self.def_id);
11361104
let defaultness = match self.container {
11371105
ty::ImplContainer(_) => Some(self.defaultness),
11381106
ty::TraitContainer(_) => None,
11391107
};
1140-
MethodItem(
1141-
Function {
1142-
generics,
1143-
decl,
1144-
header: hir::FnHeader {
1145-
unsafety: sig.unsafety(),
1146-
abi: sig.abi(),
1147-
constness,
1148-
asyncness,
1149-
},
1150-
},
1151-
defaultness,
1152-
)
1108+
MethodItem(Function { generics, decl }, defaultness)
11531109
} else {
1154-
TyMethodItem(Function {
1155-
generics,
1156-
decl,
1157-
header: hir::FnHeader {
1158-
unsafety: sig.unsafety(),
1159-
abi: sig.abi(),
1160-
constness: hir::Constness::NotConst,
1161-
asyncness: hir::IsAsync::NotAsync,
1162-
},
1163-
})
1110+
TyMethodItem(Function { generics, decl })
11641111
}
11651112
}
11661113
ty::AssocKind::Type => {
@@ -2192,28 +2139,14 @@ fn clean_maybe_renamed_foreign_item(
21922139
cx.with_param_env(def_id, |cx| {
21932140
let kind = match item.kind {
21942141
hir::ForeignItemKind::Fn(decl, names, ref generics) => {
2195-
let abi = cx.tcx.hir().get_foreign_abi(item.hir_id());
21962142
let (generics, decl) = enter_impl_trait(cx, |cx| {
21972143
// NOTE: generics must be cleaned before args
21982144
let generics = generics.clean(cx);
21992145
let args = clean_args_from_types_and_names(cx, decl.inputs, names);
22002146
let decl = clean_fn_decl_with_args(cx, decl, args);
22012147
(generics, decl)
22022148
});
2203-
ForeignFunctionItem(Function {
2204-
decl,
2205-
generics,
2206-
header: hir::FnHeader {
2207-
unsafety: if abi == Abi::RustIntrinsic {
2208-
intrinsic_operation_unsafety(item.ident.name)
2209-
} else {
2210-
hir::Unsafety::Unsafe
2211-
},
2212-
abi,
2213-
constness: hir::Constness::NotConst,
2214-
asyncness: hir::IsAsync::NotAsync,
2215-
},
2216-
})
2149+
ForeignFunctionItem(Function { decl, generics })
22172150
}
22182151
hir::ForeignItemKind::Static(ref ty, mutability) => {
22192152
ForeignStaticItem(Static { type_: ty.clean(cx), mutability, expr: None })

Diff for: ‎src/librustdoc/clean/types.rs

+44-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ use rustc_ast::attr;
1313
use rustc_ast::util::comments::beautify_doc_string;
1414
use rustc_ast::{self as ast, AttrStyle};
1515
use rustc_attr::{ConstStability, Deprecation, Stability, StabilityLevel};
16+
use rustc_const_eval::const_eval::is_unstable_const_fn;
1617
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
1718
use rustc_data_structures::thin_vec::ThinVec;
1819
use rustc_hir as hir;
@@ -29,6 +30,7 @@ use rustc_span::symbol::{kw, sym, Ident, Symbol};
2930
use rustc_span::{self, FileName, Loc};
3031
use rustc_target::abi::VariantIdx;
3132
use rustc_target::spec::abi::Abi;
33+
use rustc_typeck::check::intrinsic::intrinsic_operation_unsafety;
3234

3335
use crate::clean::cfg::Cfg;
3436
use crate::clean::external_path;
@@ -641,6 +643,48 @@ impl Item {
641643
_ => false,
642644
}
643645
}
646+
647+
/// Returns a `FnHeader` if `self` is a function item, otherwise returns `None`.
648+
crate fn fn_header(&self, tcx: TyCtxt<'_>) -> Option<hir::FnHeader> {
649+
fn build_fn_header(
650+
def_id: DefId,
651+
tcx: TyCtxt<'_>,
652+
asyncness: hir::IsAsync,
653+
) -> hir::FnHeader {
654+
let sig = tcx.fn_sig(def_id);
655+
let constness =
656+
if tcx.is_const_fn(def_id) && is_unstable_const_fn(tcx, def_id).is_none() {
657+
hir::Constness::Const
658+
} else {
659+
hir::Constness::NotConst
660+
};
661+
hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness }
662+
}
663+
let header = match *self.kind {
664+
ItemKind::ForeignFunctionItem(_) => {
665+
let abi = tcx.fn_sig(self.def_id.as_def_id().unwrap()).abi();
666+
hir::FnHeader {
667+
unsafety: if abi == Abi::RustIntrinsic {
668+
intrinsic_operation_unsafety(self.name.unwrap())
669+
} else {
670+
hir::Unsafety::Unsafe
671+
},
672+
abi,
673+
constness: hir::Constness::NotConst,
674+
asyncness: hir::IsAsync::NotAsync,
675+
}
676+
}
677+
ItemKind::FunctionItem(_) | ItemKind::MethodItem(_, _) => {
678+
let def_id = self.def_id.as_def_id().unwrap();
679+
build_fn_header(def_id, tcx, tcx.asyncness(def_id))
680+
}
681+
ItemKind::TyMethodItem(_) => {
682+
build_fn_header(self.def_id.as_def_id().unwrap(), tcx, hir::IsAsync::NotAsync)
683+
}
684+
_ => return None,
685+
};
686+
Some(header)
687+
}
644688
}
645689

646690
#[derive(Clone, Debug)]
@@ -1253,7 +1297,6 @@ crate struct Generics {
12531297
crate struct Function {
12541298
crate decl: FnDecl,
12551299
crate generics: Generics,
1256-
crate header: hir::FnHeader,
12571300
}
12581301

12591302
#[derive(Clone, PartialEq, Eq, Debug, Hash)]

Diff for: ‎src/librustdoc/html/render/mod.rs

+3-4
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ use std::string::ToString;
4848
use rustc_ast_pretty::pprust;
4949
use rustc_attr::{ConstStability, Deprecation, StabilityLevel};
5050
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
51-
use rustc_hir as hir;
5251
use rustc_hir::def::CtorKind;
5352
use rustc_hir::def_id::DefId;
5453
use rustc_hir::Mutability;
@@ -806,14 +805,14 @@ fn assoc_type(
806805
fn assoc_method(
807806
w: &mut Buffer,
808807
meth: &clean::Item,
809-
header: hir::FnHeader,
810808
g: &clean::Generics,
811809
d: &clean::FnDecl,
812810
link: AssocItemLink<'_>,
813811
parent: ItemType,
814812
cx: &Context<'_>,
815813
render_mode: RenderMode,
816814
) {
815+
let header = meth.fn_header(cx.tcx()).expect("Trying to get header from a non-function item");
817816
let name = meth.name.as_ref().unwrap();
818817
let href = match link {
819818
AssocItemLink::Anchor(Some(ref id)) => Some(format!("#{}", id)),
@@ -972,10 +971,10 @@ fn render_assoc_item(
972971
match *item.kind {
973972
clean::StrippedItem(..) => {}
974973
clean::TyMethodItem(ref m) => {
975-
assoc_method(w, item, m.header, &m.generics, &m.decl, link, parent, cx, render_mode)
974+
assoc_method(w, item, &m.generics, &m.decl, link, parent, cx, render_mode)
976975
}
977976
clean::MethodItem(ref m, _) => {
978-
assoc_method(w, item, m.header, &m.generics, &m.decl, link, parent, cx, render_mode)
977+
assoc_method(w, item, &m.generics, &m.decl, link, parent, cx, render_mode)
979978
}
980979
clean::AssocConstItem(ref ty, _) => {
981980
assoc_const(w, item, ty, link, if parent == ItemType::Trait { " " } else { "" }, cx)

Diff for: ‎src/librustdoc/html/render/print_item.rs

+12-10
Original file line numberDiff line numberDiff line change
@@ -365,8 +365,9 @@ fn item_module(w: &mut Buffer, cx: &Context<'_>, item: &clean::Item, items: &[cl
365365
}
366366

367367
let unsafety_flag = match *myitem.kind {
368-
clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
369-
if func.header.unsafety == hir::Unsafety::Unsafe =>
368+
clean::FunctionItem(_) | clean::ForeignFunctionItem(_)
369+
if myitem.fn_header(cx.tcx()).unwrap().unsafety
370+
== hir::Unsafety::Unsafe =>
370371
{
371372
"<a title=\"unsafe function\" href=\"#\"><sup>⚠</sup></a>"
372373
}
@@ -462,16 +463,17 @@ fn extra_info_tags(item: &clean::Item, parent: &clean::Item, tcx: TyCtxt<'_>) ->
462463
}
463464

464465
fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::Function) {
465-
let vis = it.visibility.print_with_space(it.def_id, cx).to_string();
466-
let constness = print_constness_with_space(&f.header.constness, it.const_stability(cx.tcx()));
467-
let asyncness = f.header.asyncness.print_with_space();
468-
let unsafety = f.header.unsafety.print_with_space();
469-
let abi = print_abi_with_space(f.header.abi).to_string();
466+
let header = it.fn_header(cx.tcx()).expect("printing a function which isn't a function");
467+
let constness = print_constness_with_space(&header.constness, it.const_stability(cx.tcx()));
468+
let unsafety = header.unsafety.print_with_space().to_string();
469+
let abi = print_abi_with_space(header.abi).to_string();
470+
let asyncness = header.asyncness.print_with_space();
471+
let visibility = it.visibility.print_with_space(it.def_id, cx).to_string();
470472
let name = it.name.unwrap();
471473

472474
let generics_len = format!("{:#}", f.generics.print(cx)).len();
473475
let header_len = "fn ".len()
474-
+ vis.len()
476+
+ visibility.len()
475477
+ constness.len()
476478
+ asyncness.len()
477479
+ unsafety.len()
@@ -487,15 +489,15 @@ fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::
487489
w,
488490
"{vis}{constness}{asyncness}{unsafety}{abi}fn \
489491
{name}{generics}{decl}{notable_traits}{where_clause}",
490-
vis = vis,
492+
vis = visibility,
491493
constness = constness,
492494
asyncness = asyncness,
493495
unsafety = unsafety,
494496
abi = abi,
495497
name = name,
496498
generics = f.generics.print(cx),
497499
where_clause = print_where_clause(&f.generics, cx, 0, true),
498-
decl = f.decl.full_print(header_len, 0, f.header.asyncness, cx),
500+
decl = f.decl.full_print(header_len, 0, header.asyncness, cx),
499501
notable_traits = notable_traits_decl(&f.decl, cx),
500502
);
501503
});

0 commit comments

Comments
 (0)