Skip to content

Commit 104ac7b

Browse files
borsbors
committed
Auto merge of #117148 - dtolnay:sinceversion, r=cjgillot
Store #[stable] attribute's `since` value in structured form Followup to #116773 (review). Prior to this PR, if you wrote an improper `since` version in a `stable` attribute, such as `#[stable(feature = "foo", since = "wat.0")]`, rustc would emit a diagnostic saying **_'since' must be a Rust version number, such as "1.31.0"_** and then throw out the whole `stable` attribute as if it weren't there. This strategy had 2 problems, both fixed in this PR: 1. If there was also a `#[deprecated]` attribute on the same item, rustc would want to enforce that the stabilization version is older than the deprecation version. This involved reparsing the `stable` attribute's `since` version, with a diagnostic **_invalid stability version found_** if it failed to parse. Of course this diagnostic was unreachable because an invalid `since` version would have already caused the `stable` attribute to be thrown out. This PR deletes that unreachable diagnostic. 2. By throwing out the `stable` attribute when `since` is invalid, you'd end up with a second diagnostic saying **_function has missing stability attribute_** even though your function is not missing a stability attribute. This PR preserves the `stable` attribute even when `since` cannot be parsed, avoiding the misleading second diagnostic. Followups I plan to try next: - Do the same for the `since` value of `#[deprecated]`. - See whether it makes sense to also preserve `stable` and/or `unstable` attributes when they contain an invalid `feature`. What redundant/misleading diagnostics can this eliminate? What problems arise from not having a usable feature name for some API, in the situation that we're already failing compilation, so not concerned about anything that happens in downstream code?
2 parents ccb160d + 1a9ea1f commit 104ac7b

File tree

12 files changed

+140
-121
lines changed

12 files changed

+140
-121
lines changed

‎compiler/rustc_attr/src/builtin.rs

+39-17
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ use rustc_session::parse::{feature_err, ParseSess};
1313
use rustc_session::Session;
1414
use rustc_span::hygiene::Transparency;
1515
use rustc_span::{symbol::sym, symbol::Symbol, Span};
16+
use std::fmt::{self, Display};
1617
use std::num::NonZeroU32;
1718

1819
use crate::session_diagnostics::{self, IncorrectReprFormatGenericCause};
@@ -23,9 +24,10 @@ use crate::session_diagnostics::{self, IncorrectReprFormatGenericCause};
2324
/// For more, see [this pull request](https://github.com/rust-lang/rust/pull/100591).
2425
pub const VERSION_PLACEHOLDER: &str = "CURRENT_RUSTC_VERSION";
2526

27+
pub const CURRENT_RUSTC_VERSION: &str = env!("CFG_RELEASE");
28+
2629
pub fn rust_version_symbol() -> Symbol {
27-
let version = option_env!("CFG_RELEASE").unwrap_or("<current>");
28-
Symbol::intern(&version)
30+
Symbol::intern(CURRENT_RUSTC_VERSION)
2931
}
3032

3133
pub fn is_builtin_attr(attr: &Attribute) -> bool {
@@ -144,13 +146,24 @@ pub enum StabilityLevel {
144146
/// `#[stable]`
145147
Stable {
146148
/// Rust release which stabilized this feature.
147-
since: Symbol,
149+
since: Since,
148150
/// Is this item allowed to be referred to on stable, despite being contained in unstable
149151
/// modules?
150152
allowed_through_unstable_modules: bool,
151153
},
152154
}
153155

156+
/// Rust release in which a feature is stabilized.
157+
#[derive(Encodable, Decodable, PartialEq, Copy, Clone, Debug, Eq, Hash)]
158+
#[derive(HashStable_Generic)]
159+
pub enum Since {
160+
Version(Version),
161+
/// Stabilized in the upcoming version, whatever number that is.
162+
Current,
163+
/// Failed to parse a stabilization version.
164+
Err,
165+
}
166+
154167
impl StabilityLevel {
155168
pub fn is_unstable(&self) -> bool {
156169
matches!(self, StabilityLevel::Unstable { .. })
@@ -372,22 +385,24 @@ fn parse_stability(sess: &Session, attr: &Attribute) -> Option<(Symbol, Stabilit
372385

373386
let since = if let Some(since) = since {
374387
if since.as_str() == VERSION_PLACEHOLDER {
375-
Ok(rust_version_symbol())
376-
} else if parse_version(since.as_str(), false).is_some() {
377-
Ok(since)
388+
Since::Current
389+
} else if let Some(version) = parse_version(since.as_str(), false) {
390+
Since::Version(version)
378391
} else {
379-
Err(sess.emit_err(session_diagnostics::InvalidSince { span: attr.span }))
392+
sess.emit_err(session_diagnostics::InvalidSince { span: attr.span });
393+
Since::Err
380394
}
381395
} else {
382-
Err(sess.emit_err(session_diagnostics::MissingSince { span: attr.span }))
396+
sess.emit_err(session_diagnostics::MissingSince { span: attr.span });
397+
Since::Err
383398
};
384399

385-
match (feature, since) {
386-
(Ok(feature), Ok(since)) => {
400+
match feature {
401+
Ok(feature) => {
387402
let level = StabilityLevel::Stable { since, allowed_through_unstable_modules: false };
388403
Some((feature, level))
389404
}
390-
(Err(ErrorGuaranteed { .. }), _) | (_, Err(ErrorGuaranteed { .. })) => None,
405+
Err(ErrorGuaranteed { .. }) => None,
391406
}
392407
}
393408

@@ -556,11 +571,12 @@ fn gate_cfg(gated_cfg: &GatedCfg, cfg_span: Span, sess: &ParseSess, features: &F
556571
}
557572
}
558573

559-
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
560-
struct Version {
561-
major: u16,
562-
minor: u16,
563-
patch: u16,
574+
#[derive(Encodable, Decodable, Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
575+
#[derive(HashStable_Generic)]
576+
pub struct Version {
577+
pub major: u16,
578+
pub minor: u16,
579+
pub patch: u16,
564580
}
565581

566582
fn parse_version(s: &str, allow_appendix: bool) -> Option<Version> {
@@ -576,6 +592,12 @@ fn parse_version(s: &str, allow_appendix: bool) -> Option<Version> {
576592
Some(Version { major, minor, patch })
577593
}
578594

595+
impl Display for Version {
596+
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
597+
write!(formatter, "{}.{}.{}", self.major, self.minor, self.patch)
598+
}
599+
}
600+
579601
/// Evaluate a cfg-like condition (with `any` and `all`), using `eval` to
580602
/// evaluate individual items.
581603
pub fn eval_condition(
@@ -609,7 +631,7 @@ pub fn eval_condition(
609631
sess.emit_warning(session_diagnostics::UnknownVersionLiteral { span: *span });
610632
return false;
611633
};
612-
let rustc_version = parse_version(env!("CFG_RELEASE"), true).unwrap();
634+
let rustc_version = parse_version(CURRENT_RUSTC_VERSION, true).unwrap();
613635

614636
// See https://github.com/rust-lang/rust/issues/64796#issuecomment-640851454 for details
615637
if sess.assume_incomplete_release {

‎compiler/rustc_passes/messages.ftl

-5
Original file line numberDiff line numberDiff line change
@@ -402,11 +402,6 @@ passes_invalid_macro_export_arguments = `{$name}` isn't a valid `#[macro_export]
402402
403403
passes_invalid_macro_export_arguments_too_many_items = `#[macro_export]` can only take 1 or 0 arguments
404404
405-
passes_invalid_stability =
406-
invalid stability version found
407-
.label = invalid stability version
408-
.item = the stability attribute annotates this item
409-
410405
passes_lang_item_fn_with_target_feature =
411406
`{$name}` language item function is not allowed to have `#[target_feature]`
412407
.label = `{$name}` language item function is not allowed to have `#[target_feature]`

‎compiler/rustc_passes/src/errors.rs

-10
Original file line numberDiff line numberDiff line change
@@ -1504,16 +1504,6 @@ pub struct UselessStability {
15041504
pub item_sp: Span,
15051505
}
15061506

1507-
#[derive(Diagnostic)]
1508-
#[diag(passes_invalid_stability)]
1509-
pub struct InvalidStability {
1510-
#[primary_span]
1511-
#[label]
1512-
pub span: Span,
1513-
#[label(passes_item)]
1514-
pub item_sp: Span,
1515-
}
1516-
15171507
#[derive(Diagnostic)]
15181508
#[diag(passes_cannot_stabilize_deprecated)]
15191509
pub struct CannotStabilizeDeprecated {

‎compiler/rustc_passes/src/stability.rs

+35-29
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
use crate::errors;
55
use rustc_attr::{
6-
self as attr, rust_version_symbol, ConstStability, Stability, StabilityLevel, Unstable,
6+
self as attr, rust_version_symbol, ConstStability, Since, Stability, StabilityLevel, Unstable,
77
UnstableReason, VERSION_PLACEHOLDER,
88
};
99
use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap};
@@ -226,37 +226,43 @@ impl<'a, 'tcx> Annotator<'a, 'tcx> {
226226
if let (&Some(dep_since), &attr::Stable { since: stab_since, .. }) =
227227
(&depr.as_ref().and_then(|(d, _)| d.since), &stab.level)
228228
{
229-
// Explicit version of iter::order::lt to handle parse errors properly
230-
for (dep_v, stab_v) in
231-
iter::zip(dep_since.as_str().split('.'), stab_since.as_str().split('.'))
232-
{
233-
match stab_v.parse::<u64>() {
234-
Err(_) => {
235-
self.tcx.sess.emit_err(errors::InvalidStability { span, item_sp });
236-
break;
237-
}
238-
Ok(stab_vp) => match dep_v.parse::<u64>() {
239-
Ok(dep_vp) => match dep_vp.cmp(&stab_vp) {
240-
Ordering::Less => {
241-
self.tcx.sess.emit_err(errors::CannotStabilizeDeprecated {
242-
span,
243-
item_sp,
244-
});
229+
match stab_since {
230+
Since::Current => {
231+
self.tcx.sess.emit_err(errors::CannotStabilizeDeprecated { span, item_sp });
232+
}
233+
Since::Version(stab_since) => {
234+
// Explicit version of iter::order::lt to handle parse errors properly
235+
for (dep_v, stab_v) in iter::zip(
236+
dep_since.as_str().split('.'),
237+
[stab_since.major, stab_since.minor, stab_since.patch],
238+
) {
239+
match dep_v.parse::<u64>() {
240+
Ok(dep_vp) => match dep_vp.cmp(&u64::from(stab_v)) {
241+
Ordering::Less => {
242+
self.tcx.sess.emit_err(errors::CannotStabilizeDeprecated {
243+
span,
244+
item_sp,
245+
});
246+
break;
247+
}
248+
Ordering::Equal => continue,
249+
Ordering::Greater => break,
250+
},
251+
Err(_) => {
252+
if dep_v != "TBD" {
253+
self.tcx.sess.emit_err(errors::InvalidDeprecationVersion {
254+
span,
255+
item_sp,
256+
});
257+
}
245258
break;
246259
}
247-
Ordering::Equal => continue,
248-
Ordering::Greater => break,
249-
},
250-
Err(_) => {
251-
if dep_v != "TBD" {
252-
self.tcx.sess.emit_err(errors::InvalidDeprecationVersion {
253-
span,
254-
item_sp,
255-
});
256-
}
257-
break;
258260
}
259-
},
261+
}
262+
}
263+
Since::Err => {
264+
// An error already reported. Assume the unparseable stabilization
265+
// version is older than the deprecation version.
260266
}
261267
}
262268
}

‎src/librustdoc/clean/types.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use thin_vec::ThinVec;
1212

1313
use rustc_ast as ast;
1414
use rustc_ast_pretty::pprust;
15-
use rustc_attr::{ConstStability, Deprecation, Stability, StabilityLevel};
15+
use rustc_attr::{ConstStability, Deprecation, Since, Stability, StabilityLevel};
1616
use rustc_const_eval::const_eval::is_unstable_const_fn;
1717
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
1818
use rustc_hir as hir;
@@ -585,14 +585,14 @@ impl Item {
585585
})
586586
}
587587

588-
pub(crate) fn stable_since(&self, tcx: TyCtxt<'_>) -> Option<Symbol> {
588+
pub(crate) fn stable_since(&self, tcx: TyCtxt<'_>) -> Option<Since> {
589589
match self.stability(tcx)?.level {
590590
StabilityLevel::Stable { since, .. } => Some(since),
591591
StabilityLevel::Unstable { .. } => None,
592592
}
593593
}
594594

595-
pub(crate) fn const_stable_since(&self, tcx: TyCtxt<'_>) -> Option<Symbol> {
595+
pub(crate) fn const_stable_since(&self, tcx: TyCtxt<'_>) -> Option<Since> {
596596
match self.const_stability(tcx)?.level {
597597
StabilityLevel::Stable { since, .. } => Some(since),
598598
StabilityLevel::Unstable { .. } => None,

‎src/librustdoc/html/render/mod.rs

+22-9
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ use std::str;
4848
use std::string::ToString;
4949

5050
use askama::Template;
51-
use rustc_attr::{ConstStability, Deprecation, StabilityLevel};
51+
use rustc_attr::{ConstStability, Deprecation, Since, StabilityLevel, CURRENT_RUSTC_VERSION};
5252
use rustc_data_structures::captures::Captures;
5353
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
5454
use rustc_hir::def_id::{DefId, DefIdSet};
@@ -911,13 +911,17 @@ fn assoc_method(
911911
/// consequence of the above rules.
912912
fn render_stability_since_raw_with_extra(
913913
w: &mut Buffer,
914-
ver: Option<Symbol>,
914+
ver: Option<Since>,
915915
const_stability: Option<ConstStability>,
916-
containing_ver: Option<Symbol>,
917-
containing_const_ver: Option<Symbol>,
916+
containing_ver: Option<Since>,
917+
containing_const_ver: Option<Since>,
918918
extra_class: &str,
919919
) -> bool {
920-
let stable_version = ver.filter(|inner| !inner.is_empty() && Some(*inner) != containing_ver);
920+
let stable_version = if ver != containing_ver && let Some(ver) = &ver {
921+
since_to_string(ver)
922+
} else {
923+
None
924+
};
921925

922926
let mut title = String::new();
923927
let mut stability = String::new();
@@ -931,7 +935,8 @@ fn render_stability_since_raw_with_extra(
931935
Some(ConstStability { level: StabilityLevel::Stable { since, .. }, .. })
932936
if Some(since) != containing_const_ver =>
933937
{
934-
Some((format!("const since {since}"), format!("const: {since}")))
938+
since_to_string(&since)
939+
.map(|since| (format!("const since {since}"), format!("const: {since}")))
935940
}
936941
Some(ConstStability { level: StabilityLevel::Unstable { issue, .. }, feature, .. }) => {
937942
let unstable = if let Some(n) = issue {
@@ -971,13 +976,21 @@ fn render_stability_since_raw_with_extra(
971976
!stability.is_empty()
972977
}
973978

979+
fn since_to_string(since: &Since) -> Option<String> {
980+
match since {
981+
Since::Version(since) => Some(since.to_string()),
982+
Since::Current => Some(CURRENT_RUSTC_VERSION.to_owned()),
983+
Since::Err => None,
984+
}
985+
}
986+
974987
#[inline]
975988
fn render_stability_since_raw(
976989
w: &mut Buffer,
977-
ver: Option<Symbol>,
990+
ver: Option<Since>,
978991
const_stability: Option<ConstStability>,
979-
containing_ver: Option<Symbol>,
980-
containing_const_ver: Option<Symbol>,
992+
containing_ver: Option<Since>,
993+
containing_const_ver: Option<Since>,
981994
) -> bool {
982995
render_stability_since_raw_with_extra(
983996
w,

‎src/tools/clippy/clippy_utils/src/qualify_min_const_fn.rs

+18-12
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
use crate::msrvs::Msrv;
77
use hir::LangItem;
8+
use rustc_attr::{Since, CURRENT_RUSTC_VERSION};
89
use rustc_const_eval::transform::check_consts::ConstCx;
910
use rustc_hir as hir;
1011
use rustc_hir::def_id::DefId;
@@ -370,19 +371,24 @@ fn is_const_fn(tcx: TyCtxt<'_>, def_id: DefId, msrv: &Msrv) -> bool {
370371
// function could be removed if `rustc` provided a MSRV-aware version of `is_const_fn`.
371372
// as a part of an unimplemented MSRV check https://github.com/rust-lang/rust/issues/65262.
372373

373-
// HACK(nilstrieb): CURRENT_RUSTC_VERSION can return versions like 1.66.0-dev. `rustc-semver`
374-
// doesn't accept the `-dev` version number so we have to strip it off.
375-
let short_version = since
376-
.as_str()
377-
.split('-')
378-
.next()
379-
.expect("rustc_attr::StabilityLevel::Stable::since` is empty");
374+
let const_stab_rust_version = match since {
375+
Since::Version(version) => RustcVersion::new(
376+
u32::from(version.major),
377+
u32::from(version.minor),
378+
u32::from(version.patch),
379+
),
380+
Since::Current => {
381+
// HACK(nilstrieb): CURRENT_RUSTC_VERSION can return versions like 1.66.0-dev.
382+
// `rustc-semver` doesn't accept the `-dev` version number so we have to strip it off.
383+
let short_version = CURRENT_RUSTC_VERSION.split('-').next().unwrap();
384+
RustcVersion::parse(short_version).unwrap_or_else(|err| {
385+
panic!("`rustc_attr::StabilityLevel::Stable::since` is ill-formatted: `{CURRENT_RUSTC_VERSION}`, {err:?}")
386+
})
387+
},
388+
Since::Err => return false,
389+
};
380390

381-
let since = rustc_span::Symbol::intern(short_version);
382-
383-
msrv.meets(RustcVersion::parse(since.as_str()).unwrap_or_else(|err| {
384-
panic!("`rustc_attr::StabilityLevel::Stable::since` is ill-formatted: `{since}`, {err:?}")
385-
}))
391+
msrv.meets(const_stab_rust_version)
386392
} else {
387393
// Unstable const fn with the feature enabled.
388394
msrv.current().is_none()

‎tests/rustdoc/html-no-source.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@
1111
// @files 'src/foo' '[]'
1212

1313
// @has foo/fn.foo.html
14-
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0 · '
15-
// @!has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0 · source · '
14+
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · '
15+
// @!has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
1616
#[stable(feature = "bar", since = "1.0")]
1717
pub fn foo() {}
1818

1919
// @has foo/struct.Bar.html
20-
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0 · '
21-
// @!has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0 · source · '
20+
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · '
21+
// @!has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
2222
#[stable(feature = "bar", since = "1.0")]
2323
pub struct Bar;
2424

2525
impl Bar {
26-
// @has - '//*[@id="method.bar"]/*[@class="since rightside"]' '2.0'
27-
// @!has - '//*[@id="method.bar"]/*[@class="rightside"]' '2.0 ·'
26+
// @has - '//*[@id="method.bar"]/*[@class="since rightside"]' '2.0.0'
27+
// @!has - '//*[@id="method.bar"]/*[@class="rightside"]' '2.0.0 ·'
2828
#[stable(feature = "foobar", since = "2.0")]
2929
pub fn bar() {}
3030
}

0 commit comments

Comments
 (0)