Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
//! A pass that annotates every item and method with its stability level,
|
|
|
|
//! propagating default levels lexically from parent to children ast nodes.
|
|
|
|
|
2015-10-12 22:01:31 -05:00
|
|
|
pub use self::StabilityLevel::*;
|
|
|
|
|
2019-03-16 16:33:15 -05:00
|
|
|
use crate::lint::{self, Lint, in_derive_expansion};
|
2019-02-05 11:20:45 -06:00
|
|
|
use crate::hir::{self, Item, Generics, StructField, Variant, HirId};
|
2019-04-20 11:36:05 -05:00
|
|
|
use crate::hir::def::{Res, DefKind};
|
2019-02-05 11:20:45 -06:00
|
|
|
use crate::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId, LOCAL_CRATE};
|
|
|
|
use crate::hir::intravisit::{self, Visitor, NestedVisitorMap};
|
|
|
|
use crate::ty::query::Providers;
|
|
|
|
use crate::middle::privacy::AccessLevels;
|
|
|
|
use crate::session::{DiagnosticMessageId, Session};
|
2019-05-07 22:21:18 -05:00
|
|
|
use syntax::symbol::{Symbol, sym};
|
2018-06-24 17:00:21 -05:00
|
|
|
use syntax_pos::{Span, MultiSpan};
|
2019-02-24 02:33:17 -06:00
|
|
|
use syntax::ast::Attribute;
|
2019-01-30 10:47:36 -06:00
|
|
|
use syntax::errors::Applicability;
|
2018-07-22 20:03:01 -05:00
|
|
|
use syntax::feature_gate::{GateIssue, emit_feature_err};
|
2016-08-22 22:54:53 -05:00
|
|
|
use syntax::attr::{self, Stability, Deprecation};
|
2019-02-05 11:20:45 -06:00
|
|
|
use crate::ty::{self, TyCtxt};
|
|
|
|
use crate::util::nodemap::{FxHashSet, FxHashMap};
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
|
2014-09-12 05:10:30 -05:00
|
|
|
use std::mem::replace;
|
2015-06-11 19:18:46 -05:00
|
|
|
use std::cmp::Ordering;
|
2014-09-12 05:10:30 -05:00
|
|
|
|
2015-10-12 22:01:31 -05:00
|
|
|
#[derive(RustcEncodable, RustcDecodable, PartialEq, PartialOrd, Clone, Copy, Debug, Eq, Hash)]
|
|
|
|
pub enum StabilityLevel {
|
|
|
|
Unstable,
|
|
|
|
Stable,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl StabilityLevel {
|
|
|
|
pub fn from_attr_level(level: &attr::StabilityLevel) -> Self {
|
|
|
|
if level.is_stable() { Stable } else { Unstable }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-16 10:53:41 -06:00
|
|
|
#[derive(PartialEq)]
|
|
|
|
enum AnnotationKind {
|
|
|
|
// Annotation is required if not inherited from unstable parents
|
2015-11-16 12:01:06 -06:00
|
|
|
Required,
|
2015-11-16 10:53:41 -06:00
|
|
|
// Annotation is useless, reject it
|
2015-11-16 12:01:06 -06:00
|
|
|
Prohibited,
|
2015-11-16 10:53:41 -06:00
|
|
|
// Annotation itself is useless, but it can be propagated to children
|
2015-11-16 12:01:06 -06:00
|
|
|
Container,
|
2015-11-16 10:53:41 -06:00
|
|
|
}
|
|
|
|
|
2016-08-04 08:18:36 -05:00
|
|
|
/// An entry in the `depr_map`.
|
|
|
|
#[derive(Clone)]
|
|
|
|
pub struct DeprecationEntry {
|
|
|
|
/// The metadata of the attribute associated with this entry.
|
|
|
|
pub attr: Deprecation,
|
2019-02-08 07:53:55 -06:00
|
|
|
/// The `DefId` where the attr was originally attached. `None` for non-local
|
2016-08-04 08:18:36 -05:00
|
|
|
/// `DefId`'s.
|
2017-08-31 17:08:34 -05:00
|
|
|
origin: Option<HirId>,
|
2016-08-04 08:18:36 -05:00
|
|
|
}
|
|
|
|
|
2017-09-12 10:07:09 -05:00
|
|
|
impl_stable_hash_for!(struct self::DeprecationEntry {
|
|
|
|
attr,
|
|
|
|
origin
|
|
|
|
});
|
|
|
|
|
2016-08-04 08:18:36 -05:00
|
|
|
impl DeprecationEntry {
|
2017-08-31 17:08:34 -05:00
|
|
|
fn local(attr: Deprecation, id: HirId) -> DeprecationEntry {
|
2016-08-04 08:18:36 -05:00
|
|
|
DeprecationEntry {
|
2017-07-03 13:19:51 -05:00
|
|
|
attr,
|
2017-08-31 17:08:34 -05:00
|
|
|
origin: Some(id),
|
2016-08-04 08:18:36 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-08-31 17:08:34 -05:00
|
|
|
pub fn external(attr: Deprecation) -> DeprecationEntry {
|
2016-08-04 08:18:36 -05:00
|
|
|
DeprecationEntry {
|
2017-07-03 13:19:51 -05:00
|
|
|
attr,
|
2016-08-04 08:18:36 -05:00
|
|
|
origin: None,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn same_origin(&self, other: &DeprecationEntry) -> bool {
|
|
|
|
match (self.origin, other.origin) {
|
|
|
|
(Some(o1), Some(o2)) => o1 == o2,
|
|
|
|
_ => false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
/// A stability index, giving the stability level for items and methods.
|
2015-05-25 16:41:27 -05:00
|
|
|
pub struct Index<'tcx> {
|
|
|
|
/// This is mostly a cache, except the stabilities of local items
|
|
|
|
/// are filled by the annotator.
|
2017-08-31 17:08:34 -05:00
|
|
|
stab_map: FxHashMap<HirId, &'tcx Stability>,
|
|
|
|
depr_map: FxHashMap<HirId, DeprecationEntry>,
|
2015-05-25 16:41:27 -05:00
|
|
|
|
|
|
|
/// Maps for each crate whether it is part of the staged API.
|
2016-11-10 11:08:21 -06:00
|
|
|
staged_api: FxHashMap<CrateNum, bool>,
|
|
|
|
|
|
|
|
/// Features enabled for this crate.
|
|
|
|
active_features: FxHashSet<Symbol>,
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
|
|
|
|
2017-09-12 10:07:09 -05:00
|
|
|
impl_stable_hash_for!(struct self::Index<'tcx> {
|
|
|
|
stab_map,
|
|
|
|
depr_map,
|
|
|
|
staged_api,
|
|
|
|
active_features
|
|
|
|
});
|
|
|
|
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
// A private tree-walker for producing an Index.
|
2015-05-25 16:41:27 -05:00
|
|
|
struct Annotator<'a, 'tcx: 'a> {
|
2016-05-02 21:23:22 -05:00
|
|
|
tcx: TyCtxt<'a, 'tcx, 'tcx>,
|
2015-05-25 16:41:27 -05:00
|
|
|
index: &'a mut Index<'tcx>,
|
2015-12-04 10:34:28 -06:00
|
|
|
parent_stab: Option<&'tcx Stability>,
|
2016-08-04 08:18:36 -05:00
|
|
|
parent_depr: Option<DeprecationEntry>,
|
2015-11-16 10:53:41 -06:00
|
|
|
in_trait_impl: bool,
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
|
|
|
|
2015-05-25 16:41:27 -05:00
|
|
|
impl<'a, 'tcx: 'a> Annotator<'a, 'tcx> {
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
// Determine the stability for a node based on its attributes and inherited
|
2014-09-12 05:10:30 -05:00
|
|
|
// stability. The stability is recorded in the index and used as the parent.
|
2019-02-18 08:35:20 -06:00
|
|
|
fn annotate<F>(&mut self, hir_id: HirId, attrs: &[Attribute],
|
2015-11-16 10:53:41 -06:00
|
|
|
item_sp: Span, kind: AnnotationKind, visit_children: F)
|
2016-11-09 15:45:26 -06:00
|
|
|
where F: FnOnce(&mut Self)
|
2014-12-08 19:26:43 -06:00
|
|
|
{
|
2018-02-14 09:11:02 -06:00
|
|
|
if self.tcx.features().staged_api {
|
2017-08-20 09:49:03 -05:00
|
|
|
// This crate explicitly wants staged API.
|
2019-02-18 08:35:20 -06:00
|
|
|
debug!("annotate(id = {:?}, attrs = {:?})", hir_id, attrs);
|
2018-10-09 06:49:18 -05:00
|
|
|
if let Some(..) = attr::find_deprecation(&self.tcx.sess.parse_sess, attrs, item_sp) {
|
2015-12-04 10:34:28 -06:00
|
|
|
self.tcx.sess.span_err(item_sp, "`#[deprecated]` cannot be used in staged api, \
|
|
|
|
use `#[rustc_deprecated]` instead");
|
|
|
|
}
|
2018-10-09 06:49:18 -05:00
|
|
|
if let Some(mut stab) = attr::find_stability(&self.tcx.sess.parse_sess,
|
2015-11-16 10:53:41 -06:00
|
|
|
attrs, item_sp) {
|
|
|
|
// Error if prohibited, or can't inherit anything from a container
|
2015-11-16 12:01:06 -06:00
|
|
|
if kind == AnnotationKind::Prohibited ||
|
|
|
|
(kind == AnnotationKind::Container &&
|
|
|
|
stab.level.is_stable() &&
|
2015-12-04 10:34:28 -06:00
|
|
|
stab.rustc_depr.is_none()) {
|
2015-11-16 10:53:41 -06:00
|
|
|
self.tcx.sess.span_err(item_sp, "This stability annotation is useless");
|
|
|
|
}
|
2015-06-06 17:52:28 -05:00
|
|
|
|
2015-11-16 10:53:41 -06:00
|
|
|
debug!("annotate: found {:?}", stab);
|
|
|
|
// If parent is deprecated and we're not, inherit this by merging
|
|
|
|
// deprecated_since and its reason.
|
2015-12-04 10:34:28 -06:00
|
|
|
if let Some(parent_stab) = self.parent_stab {
|
|
|
|
if parent_stab.rustc_depr.is_some() && stab.rustc_depr.is_none() {
|
|
|
|
stab.rustc_depr = parent_stab.rustc_depr.clone()
|
2015-11-16 10:53:41 -06:00
|
|
|
}
|
|
|
|
}
|
2015-06-11 19:18:46 -05:00
|
|
|
|
2015-11-16 10:53:41 -06:00
|
|
|
let stab = self.tcx.intern_stability(stab);
|
|
|
|
|
|
|
|
// Check if deprecated_since < stable_since. If it is,
|
|
|
|
// this is *almost surely* an accident.
|
2016-11-16 04:52:37 -06:00
|
|
|
if let (&Some(attr::RustcDeprecation {since: dep_since, ..}),
|
|
|
|
&attr::Stable {since: stab_since}) = (&stab.rustc_depr, &stab.level) {
|
2015-11-16 10:53:41 -06:00
|
|
|
// Explicit version of iter::order::lt to handle parse errors properly
|
2018-10-02 11:29:48 -05:00
|
|
|
for (dep_v, stab_v) in dep_since.as_str()
|
|
|
|
.split('.')
|
|
|
|
.zip(stab_since.as_str().split('.'))
|
|
|
|
{
|
2015-11-16 10:53:41 -06:00
|
|
|
if let (Ok(dep_v), Ok(stab_v)) = (dep_v.parse::<u64>(), stab_v.parse()) {
|
|
|
|
match dep_v.cmp(&stab_v) {
|
|
|
|
Ordering::Less => {
|
|
|
|
self.tcx.sess.span_err(item_sp, "An API can't be stabilized \
|
|
|
|
after it is deprecated");
|
|
|
|
break
|
2015-06-11 19:18:46 -05:00
|
|
|
}
|
2015-11-16 10:53:41 -06:00
|
|
|
Ordering::Equal => continue,
|
|
|
|
Ordering::Greater => break,
|
2015-06-11 19:18:46 -05:00
|
|
|
}
|
2015-11-16 10:53:41 -06:00
|
|
|
} else {
|
|
|
|
// Act like it isn't less because the question is now nonsensical,
|
|
|
|
// and this makes us not do anything else interesting.
|
|
|
|
self.tcx.sess.span_err(item_sp, "Invalid stability or deprecation \
|
|
|
|
version found");
|
|
|
|
break
|
|
|
|
}
|
2015-06-11 19:18:46 -05:00
|
|
|
}
|
2015-11-16 10:53:41 -06:00
|
|
|
}
|
2015-06-11 19:18:46 -05:00
|
|
|
|
2017-08-31 17:08:34 -05:00
|
|
|
self.index.stab_map.insert(hir_id, stab);
|
2015-11-16 10:53:41 -06:00
|
|
|
|
2015-12-04 10:34:28 -06:00
|
|
|
let orig_parent_stab = replace(&mut self.parent_stab, Some(stab));
|
2015-11-16 10:53:41 -06:00
|
|
|
visit_children(self);
|
2015-12-04 10:34:28 -06:00
|
|
|
self.parent_stab = orig_parent_stab;
|
2015-11-16 10:53:41 -06:00
|
|
|
} else {
|
2015-12-04 10:34:28 -06:00
|
|
|
debug!("annotate: not found, parent = {:?}", self.parent_stab);
|
|
|
|
if let Some(stab) = self.parent_stab {
|
2015-11-16 10:53:41 -06:00
|
|
|
if stab.level.is_unstable() {
|
2017-08-31 17:08:34 -05:00
|
|
|
self.index.stab_map.insert(hir_id, stab);
|
2015-04-13 20:42:24 -05:00
|
|
|
}
|
|
|
|
}
|
2015-11-16 10:53:41 -06:00
|
|
|
visit_children(self);
|
2014-09-12 05:10:30 -05:00
|
|
|
}
|
2015-04-13 20:42:24 -05:00
|
|
|
} else {
|
2015-11-16 10:53:41 -06:00
|
|
|
// Emit errors for non-staged-api crates.
|
2015-04-13 20:42:24 -05:00
|
|
|
for attr in attrs {
|
2019-03-17 06:17:47 -05:00
|
|
|
let name = attr.name_or_empty();
|
|
|
|
if ["unstable", "stable", "rustc_deprecated"].contains(&name.get()) {
|
|
|
|
attr::mark_used(attr);
|
|
|
|
self.tcx.sess.span_err(attr.span, "stability attributes may not be used \
|
|
|
|
outside of the standard library");
|
2014-12-17 22:12:41 -06:00
|
|
|
}
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
2015-12-04 10:34:28 -06:00
|
|
|
|
2017-08-20 09:49:03 -05:00
|
|
|
// Propagate unstability. This can happen even for non-staged-api crates in case
|
|
|
|
// -Zforce-unstable-if-unmarked is set.
|
|
|
|
if let Some(stab) = self.parent_stab {
|
|
|
|
if stab.level.is_unstable() {
|
2017-08-31 17:08:34 -05:00
|
|
|
self.index.stab_map.insert(hir_id, stab);
|
2017-08-20 09:49:03 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-10-09 06:49:18 -05:00
|
|
|
if let Some(depr) = attr::find_deprecation(&self.tcx.sess.parse_sess, attrs, item_sp) {
|
2015-12-04 10:34:28 -06:00
|
|
|
if kind == AnnotationKind::Prohibited {
|
|
|
|
self.tcx.sess.span_err(item_sp, "This deprecation annotation is useless");
|
|
|
|
}
|
|
|
|
|
|
|
|
// `Deprecation` is just two pointers, no need to intern it
|
2017-08-31 17:08:34 -05:00
|
|
|
let depr_entry = DeprecationEntry::local(depr, hir_id);
|
|
|
|
self.index.depr_map.insert(hir_id, depr_entry.clone());
|
2015-12-04 10:34:28 -06:00
|
|
|
|
2017-08-31 17:08:34 -05:00
|
|
|
let orig_parent_depr = replace(&mut self.parent_depr,
|
|
|
|
Some(depr_entry));
|
2015-12-04 10:34:28 -06:00
|
|
|
visit_children(self);
|
|
|
|
self.parent_depr = orig_parent_depr;
|
2017-08-31 17:08:34 -05:00
|
|
|
} else if let Some(parent_depr) = self.parent_depr.clone() {
|
|
|
|
self.index.depr_map.insert(hir_id, parent_depr);
|
2015-12-04 10:34:28 -06:00
|
|
|
visit_children(self);
|
|
|
|
} else {
|
|
|
|
visit_children(self);
|
|
|
|
}
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
impl<'a, 'tcx> Visitor<'tcx> for Annotator<'a, 'tcx> {
|
2015-11-17 17:56:13 -06:00
|
|
|
/// Because stability levels are scoped lexically, we want to walk
|
|
|
|
/// nested items in the context of the outer item, so enable
|
|
|
|
/// deep-walking.
|
2016-11-28 13:00:26 -06:00
|
|
|
fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
|
2018-12-04 06:45:36 -06:00
|
|
|
NestedVisitorMap::All(&self.tcx.hir())
|
2016-11-04 17:20:15 -05:00
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_item(&mut self, i: &'tcx Item) {
|
2015-11-16 10:53:41 -06:00
|
|
|
let orig_in_trait_impl = self.in_trait_impl;
|
2015-11-16 12:01:06 -06:00
|
|
|
let mut kind = AnnotationKind::Required;
|
2015-11-16 10:53:41 -06:00
|
|
|
match i.node {
|
|
|
|
// Inherent impls and foreign modules serve only as containers for other items,
|
|
|
|
// they don't have their own stability. They still can be annotated as unstable
|
|
|
|
// and propagate this unstability to children, but this annotation is completely
|
|
|
|
// optional. They inherit stability from their parents when unannotated.
|
2018-07-11 10:36:06 -05:00
|
|
|
hir::ItemKind::Impl(.., None, _, _) | hir::ItemKind::ForeignMod(..) => {
|
2015-11-16 10:53:41 -06:00
|
|
|
self.in_trait_impl = false;
|
2015-11-16 12:01:06 -06:00
|
|
|
kind = AnnotationKind::Container;
|
2015-11-16 10:53:41 -06:00
|
|
|
}
|
2018-07-11 10:36:06 -05:00
|
|
|
hir::ItemKind::Impl(.., Some(_), _, _) => {
|
2015-11-16 10:53:41 -06:00
|
|
|
self.in_trait_impl = true;
|
2015-10-01 19:53:28 -05:00
|
|
|
}
|
2018-07-11 10:36:06 -05:00
|
|
|
hir::ItemKind::Struct(ref sd, _) => {
|
2019-03-21 17:38:50 -05:00
|
|
|
if let Some(ctor_hir_id) = sd.ctor_hir_id() {
|
|
|
|
self.annotate(ctor_hir_id, &i.attrs, i.span, AnnotationKind::Required, |_| {})
|
2015-11-16 10:53:41 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
_ => {}
|
2014-11-11 14:46:47 -06:00
|
|
|
}
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
|
2019-02-18 08:35:20 -06:00
|
|
|
self.annotate(i.hir_id, &i.attrs, i.span, kind, |v| {
|
2015-11-17 17:56:13 -06:00
|
|
|
intravisit::walk_item(v, i)
|
2015-11-16 10:53:41 -06:00
|
|
|
});
|
|
|
|
self.in_trait_impl = orig_in_trait_impl;
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.annotate(ti.hir_id, &ti.attrs, ti.span, AnnotationKind::Required, |v| {
|
2015-11-17 17:56:13 -06:00
|
|
|
intravisit::walk_trait_item(v, ti);
|
2015-11-16 10:53:41 -06:00
|
|
|
});
|
2015-03-10 05:28:44 -05:00
|
|
|
}
|
2014-08-05 21:44:21 -05:00
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
|
2015-11-16 12:01:06 -06:00
|
|
|
let kind = if self.in_trait_impl {
|
|
|
|
AnnotationKind::Prohibited
|
|
|
|
} else {
|
|
|
|
AnnotationKind::Required
|
|
|
|
};
|
2019-02-18 08:35:20 -06:00
|
|
|
self.annotate(ii.hir_id, &ii.attrs, ii.span, kind, |v| {
|
2015-11-17 17:56:13 -06:00
|
|
|
intravisit::walk_impl_item(v, ii);
|
2015-11-16 10:53:41 -06:00
|
|
|
});
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
|
|
|
|
2019-02-06 07:16:11 -06:00
|
|
|
fn visit_variant(&mut self, var: &'tcx Variant, g: &'tcx Generics, item_id: HirId) {
|
2019-03-21 17:38:50 -05:00
|
|
|
self.annotate(var.node.id, &var.node.attrs, var.span, AnnotationKind::Required,
|
|
|
|
|v| {
|
|
|
|
if let Some(ctor_hir_id) = var.node.data.ctor_hir_id() {
|
|
|
|
v.annotate(ctor_hir_id, &var.node.attrs, var.span, AnnotationKind::Required,
|
|
|
|
|_| {});
|
|
|
|
}
|
|
|
|
|
|
|
|
intravisit::walk_variant(v, var, g, item_id)
|
|
|
|
})
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_struct_field(&mut self, s: &'tcx StructField) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.annotate(s.hir_id, &s.attrs, s.span, AnnotationKind::Required, |v| {
|
2015-11-17 17:56:13 -06:00
|
|
|
intravisit::walk_struct_field(v, s);
|
2015-11-16 10:53:41 -06:00
|
|
|
});
|
2014-07-10 13:17:40 -05:00
|
|
|
}
|
2014-12-20 12:08:16 -06:00
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_foreign_item(&mut self, i: &'tcx hir::ForeignItem) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.annotate(i.hir_id, &i.attrs, i.span, AnnotationKind::Required, |v| {
|
2015-11-17 17:56:13 -06:00
|
|
|
intravisit::walk_foreign_item(v, i);
|
2015-11-16 10:53:41 -06:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_macro_def(&mut self, md: &'tcx hir::MacroDef) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.annotate(md.hir_id, &md.attrs, md.span, AnnotationKind::Required, |_| {});
|
2014-12-20 12:08:16 -06:00
|
|
|
}
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
struct MissingStabilityAnnotations<'a, 'tcx: 'a> {
|
|
|
|
tcx: TyCtxt<'a, 'tcx, 'tcx>,
|
|
|
|
access_levels: &'a AccessLevels,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a, 'tcx: 'a> MissingStabilityAnnotations<'a, 'tcx> {
|
2019-02-18 08:35:20 -06:00
|
|
|
fn check_missing_stability(&self, hir_id: HirId, span: Span, name: &str) {
|
2017-08-31 17:08:34 -05:00
|
|
|
let stab = self.tcx.stability().local_stability(hir_id);
|
2016-11-10 11:08:21 -06:00
|
|
|
let is_error = !self.tcx.sess.opts.test &&
|
2017-08-31 17:08:34 -05:00
|
|
|
stab.is_none() &&
|
2019-03-11 05:03:19 -05:00
|
|
|
self.access_levels.is_reachable(hir_id);
|
2016-11-10 11:08:21 -06:00
|
|
|
if is_error {
|
2019-02-07 09:38:23 -06:00
|
|
|
self.tcx.sess.span_err(
|
|
|
|
span,
|
|
|
|
&format!("{} has missing stability attribute", name),
|
|
|
|
);
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-28 11:10:37 -06:00
|
|
|
impl<'a, 'tcx> Visitor<'tcx> for MissingStabilityAnnotations<'a, 'tcx> {
|
2016-11-28 13:00:26 -06:00
|
|
|
fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
|
2018-12-04 06:45:36 -06:00
|
|
|
NestedVisitorMap::OnlyBodies(&self.tcx.hir())
|
2016-11-28 11:10:37 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_item(&mut self, i: &'tcx Item) {
|
2016-11-10 11:08:21 -06:00
|
|
|
match i.node {
|
|
|
|
// Inherent impls and foreign modules serve only as containers for other items,
|
|
|
|
// they don't have their own stability. They still can be annotated as unstable
|
|
|
|
// and propagate this unstability to children, but this annotation is completely
|
|
|
|
// optional. They inherit stability from their parents when unannotated.
|
2018-07-11 10:36:06 -05:00
|
|
|
hir::ItemKind::Impl(.., None, _, _) | hir::ItemKind::ForeignMod(..) => {}
|
2016-11-10 11:08:21 -06:00
|
|
|
|
2019-02-18 08:35:20 -06:00
|
|
|
_ => self.check_missing_stability(i.hir_id, i.span, i.node.descriptive_variant())
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
intravisit::walk_item(self, i)
|
|
|
|
}
|
|
|
|
|
2016-11-28 11:10:37 -06:00
|
|
|
fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.check_missing_stability(ti.hir_id, ti.span, "item");
|
2016-11-10 11:08:21 -06:00
|
|
|
intravisit::walk_trait_item(self, ti);
|
|
|
|
}
|
|
|
|
|
2016-11-28 11:10:37 -06:00
|
|
|
fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
|
2019-02-26 08:11:59 -06:00
|
|
|
let impl_def_id = self.tcx.hir().local_def_id_from_hir_id(
|
|
|
|
self.tcx.hir().get_parent_item(ii.hir_id));
|
2016-11-10 11:08:21 -06:00
|
|
|
if self.tcx.impl_trait_ref(impl_def_id).is_none() {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.check_missing_stability(ii.hir_id, ii.span, "item");
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
intravisit::walk_impl_item(self, ii);
|
|
|
|
}
|
|
|
|
|
2019-02-06 07:16:11 -06:00
|
|
|
fn visit_variant(&mut self, var: &'tcx Variant, g: &'tcx Generics, item_id: HirId) {
|
2019-03-21 17:38:50 -05:00
|
|
|
self.check_missing_stability(var.node.id, var.span, "variant");
|
2016-11-10 11:08:21 -06:00
|
|
|
intravisit::walk_variant(self, var, g, item_id);
|
|
|
|
}
|
|
|
|
|
2016-11-28 11:10:37 -06:00
|
|
|
fn visit_struct_field(&mut self, s: &'tcx StructField) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.check_missing_stability(s.hir_id, s.span, "field");
|
2016-11-10 11:08:21 -06:00
|
|
|
intravisit::walk_struct_field(self, s);
|
|
|
|
}
|
|
|
|
|
2016-11-28 11:10:37 -06:00
|
|
|
fn visit_foreign_item(&mut self, i: &'tcx hir::ForeignItem) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.check_missing_stability(i.hir_id, i.span, i.node.descriptive_variant());
|
2016-11-10 11:08:21 -06:00
|
|
|
intravisit::walk_foreign_item(self, i);
|
|
|
|
}
|
|
|
|
|
2016-11-28 11:10:37 -06:00
|
|
|
fn visit_macro_def(&mut self, md: &'tcx hir::MacroDef) {
|
2019-02-18 08:35:20 -06:00
|
|
|
self.check_missing_stability(md.hir_id, md.span, "macro");
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-05-02 20:56:42 -05:00
|
|
|
impl<'a, 'tcx> Index<'tcx> {
|
2017-08-31 17:08:34 -05:00
|
|
|
pub fn new(tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Index<'tcx> {
|
|
|
|
let is_staged_api =
|
|
|
|
tcx.sess.opts.debugging_opts.force_unstable_if_unmarked ||
|
2018-02-14 09:11:02 -06:00
|
|
|
tcx.features().staged_api;
|
2018-10-16 03:44:26 -05:00
|
|
|
let mut staged_api = FxHashMap::default();
|
2017-08-31 17:08:34 -05:00
|
|
|
staged_api.insert(LOCAL_CRATE, is_staged_api);
|
|
|
|
let mut index = Index {
|
|
|
|
staged_api,
|
2018-10-16 09:57:53 -05:00
|
|
|
stab_map: Default::default(),
|
|
|
|
depr_map: Default::default(),
|
|
|
|
active_features: Default::default(),
|
2017-08-31 17:08:34 -05:00
|
|
|
};
|
|
|
|
|
2019-02-25 16:14:18 -06:00
|
|
|
let active_lib_features = &tcx.features().declared_lib_features;
|
|
|
|
let active_lang_features = &tcx.features().declared_lang_features;
|
|
|
|
|
|
|
|
// Put the active features into a map for quick lookup.
|
|
|
|
index.active_features =
|
|
|
|
active_lib_features.iter().map(|&(ref s, ..)| s.clone())
|
|
|
|
.chain(active_lang_features.iter().map(|&(ref s, ..)| s.clone()))
|
|
|
|
.collect();
|
2017-08-31 17:08:34 -05:00
|
|
|
|
|
|
|
{
|
2018-12-04 06:45:36 -06:00
|
|
|
let krate = tcx.hir().krate();
|
2017-08-31 17:08:34 -05:00
|
|
|
let mut annotator = Annotator {
|
|
|
|
tcx,
|
|
|
|
index: &mut index,
|
|
|
|
parent_stab: None,
|
|
|
|
parent_depr: None,
|
|
|
|
in_trait_impl: false,
|
|
|
|
};
|
2016-11-10 11:08:21 -06:00
|
|
|
|
2017-08-31 17:08:34 -05:00
|
|
|
// If the `-Z force-unstable-if-unmarked` flag is passed then we provide
|
|
|
|
// a parent stability annotation which indicates that this is private
|
|
|
|
// with the `rustc_private` feature. This is intended for use when
|
|
|
|
// compiling librustc crates themselves so we can leverage crates.io
|
|
|
|
// while maintaining the invariant that all sysroot crates are unstable
|
|
|
|
// by default and are unable to be used.
|
|
|
|
if tcx.sess.opts.debugging_opts.force_unstable_if_unmarked {
|
2017-10-05 20:31:59 -05:00
|
|
|
let reason = "this crate is being loaded from the sysroot, an \
|
2017-08-31 17:08:34 -05:00
|
|
|
unstable location; did you mean to load this crate \
|
|
|
|
from crates.io via `Cargo.toml` instead?";
|
|
|
|
let stability = tcx.intern_stability(Stability {
|
|
|
|
level: attr::StabilityLevel::Unstable {
|
|
|
|
reason: Some(Symbol::intern(reason)),
|
|
|
|
issue: 27812,
|
|
|
|
},
|
|
|
|
feature: Symbol::intern("rustc_private"),
|
|
|
|
rustc_depr: None,
|
2018-08-22 08:56:37 -05:00
|
|
|
const_stability: None,
|
2018-08-31 06:50:14 -05:00
|
|
|
promotable: false,
|
2019-04-05 16:13:44 -05:00
|
|
|
allow_const_fn_ptr: false,
|
2017-08-31 17:08:34 -05:00
|
|
|
});
|
|
|
|
annotator.parent_stab = Some(stability);
|
|
|
|
}
|
2017-05-08 15:36:26 -05:00
|
|
|
|
2019-02-18 08:35:20 -06:00
|
|
|
annotator.annotate(hir::CRATE_HIR_ID,
|
2017-08-31 17:08:34 -05:00
|
|
|
&krate.attrs,
|
|
|
|
krate.span,
|
|
|
|
AnnotationKind::Required,
|
|
|
|
|v| intravisit::walk_crate(v, krate));
|
2017-05-08 15:36:26 -05:00
|
|
|
}
|
2017-08-31 17:08:34 -05:00
|
|
|
return index
|
|
|
|
}
|
2017-05-08 15:36:26 -05:00
|
|
|
|
2017-08-31 17:08:34 -05:00
|
|
|
pub fn local_stability(&self, id: HirId) -> Option<&'tcx Stability> {
|
|
|
|
self.stab_map.get(&id).cloned()
|
2015-02-03 09:46:08 -06:00
|
|
|
}
|
|
|
|
|
2017-08-31 17:08:34 -05:00
|
|
|
pub fn local_deprecation_entry(&self, id: HirId) -> Option<DeprecationEntry> {
|
|
|
|
self.depr_map.get(&id).cloned()
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
2014-06-26 13:37:39 -05:00
|
|
|
}
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
|
2015-01-14 17:20:14 -06:00
|
|
|
/// Cross-references the feature names of unstable APIs with enabled
|
2016-11-10 11:08:21 -06:00
|
|
|
/// features and possibly prints errors.
|
2019-01-10 21:58:46 -06:00
|
|
|
fn check_mod_unstable_api_usage<'tcx>(tcx: TyCtxt<'_, 'tcx, 'tcx>, module_def_id: DefId) {
|
|
|
|
tcx.hir().visit_item_likes_in_module(module_def_id, &mut Checker { tcx }.as_deep_visitor());
|
2018-06-06 15:13:52 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
pub fn provide(providers: &mut Providers<'_>) {
|
|
|
|
*providers = Providers {
|
|
|
|
check_mod_unstable_api_usage,
|
|
|
|
..*providers
|
|
|
|
};
|
2015-01-14 17:20:14 -06:00
|
|
|
}
|
|
|
|
|
2019-02-08 07:53:55 -06:00
|
|
|
/// Checks whether an item marked with `deprecated(since="X")` is currently
|
2018-11-26 20:59:49 -06:00
|
|
|
/// deprecated (i.e., whether X is not greater than the current rustc version).
|
2018-03-19 10:51:11 -05:00
|
|
|
pub fn deprecation_in_effect(since: &str) -> bool {
|
|
|
|
fn parse_version(ver: &str) -> Vec<u32> {
|
2018-11-26 20:59:49 -06:00
|
|
|
// We ignore non-integer components of the version (e.g., "nightly").
|
2018-03-19 10:51:11 -05:00
|
|
|
ver.split(|c| c == '.' || c == '-').flat_map(|s| s.parse()).collect()
|
|
|
|
}
|
|
|
|
|
|
|
|
if let Some(rustc) = option_env!("CFG_RELEASE") {
|
|
|
|
let since: Vec<u32> = parse_version(since);
|
|
|
|
let rustc: Vec<u32> = parse_version(rustc);
|
|
|
|
// We simply treat invalid `since` attributes as relating to a previous
|
|
|
|
// Rust version, thus always displaying the warning.
|
|
|
|
if since.len() != 3 {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
since <= rustc
|
|
|
|
} else {
|
|
|
|
// By default, a deprecation warning applies to
|
|
|
|
// the current version of the compiler.
|
|
|
|
true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-14 17:20:14 -06:00
|
|
|
struct Checker<'a, 'tcx: 'a> {
|
2016-05-02 21:23:22 -05:00
|
|
|
tcx: TyCtxt<'a, 'tcx, 'tcx>,
|
2015-01-14 17:20:14 -06:00
|
|
|
}
|
|
|
|
|
2018-02-26 07:34:06 -06:00
|
|
|
/// Result of `TyCtxt::eval_stability`.
|
|
|
|
pub enum EvalResult {
|
|
|
|
/// We can use the item because it is stable or we provided the
|
|
|
|
/// corresponding feature gate.
|
|
|
|
Allow,
|
|
|
|
/// We cannot use the item because it is unstable and we did not provide the
|
|
|
|
/// corresponding feature gate.
|
|
|
|
Deny {
|
|
|
|
feature: Symbol,
|
|
|
|
reason: Option<Symbol>,
|
|
|
|
issue: u32,
|
|
|
|
},
|
|
|
|
/// The item does not have the `#[stable]` or `#[unstable]` marker assigned.
|
|
|
|
Unmarked,
|
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
|
2018-11-26 20:59:49 -06:00
|
|
|
// See issue #38412.
|
2016-09-28 18:30:53 -05:00
|
|
|
fn skip_stability_check_due_to_privacy(self, mut def_id: DefId) -> bool {
|
|
|
|
// Check if `def_id` is a trait method.
|
2019-04-20 11:46:19 -05:00
|
|
|
match self.def_kind(def_id) {
|
|
|
|
Some(DefKind::Method) |
|
|
|
|
Some(DefKind::AssociatedTy) |
|
|
|
|
Some(DefKind::AssociatedConst) => {
|
2018-10-02 11:05:06 -05:00
|
|
|
if let ty::TraitContainer(trait_def_id) = self.associated_item(def_id).container {
|
|
|
|
// Trait methods do not declare visibility (even
|
|
|
|
// for visibility info in cstore). Use containing
|
2018-11-26 20:59:49 -06:00
|
|
|
// trait instead, so methods of `pub` traits are
|
|
|
|
// themselves considered `pub`.
|
2018-10-02 11:05:06 -05:00
|
|
|
def_id = trait_def_id;
|
2016-12-29 15:00:53 -06:00
|
|
|
}
|
|
|
|
}
|
2016-09-28 18:30:53 -05:00
|
|
|
_ => {}
|
|
|
|
}
|
|
|
|
|
2017-08-31 10:07:39 -05:00
|
|
|
let visibility = self.visibility(def_id);
|
2016-12-29 15:00:53 -06:00
|
|
|
|
|
|
|
match visibility {
|
2018-11-26 20:59:49 -06:00
|
|
|
// Must check stability for `pub` items.
|
2016-12-29 15:00:53 -06:00
|
|
|
ty::Visibility::Public => false,
|
|
|
|
|
2018-11-26 20:59:49 -06:00
|
|
|
// These are not visible outside crate; therefore
|
2016-12-29 15:00:53 -06:00
|
|
|
// stability markers are irrelevant, if even present.
|
|
|
|
ty::Visibility::Restricted(..) |
|
|
|
|
ty::Visibility::Invisible => true,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-02-26 07:34:06 -06:00
|
|
|
/// Evaluates the stability of an item.
|
|
|
|
///
|
2018-03-03 03:02:01 -06:00
|
|
|
/// Returns `EvalResult::Allow` if the item is stable, or unstable but the corresponding
|
|
|
|
/// `#![feature]` has been provided. Returns `EvalResult::Deny` which describes the offending
|
|
|
|
/// unstable feature otherwise.
|
|
|
|
///
|
|
|
|
/// If `id` is `Some(_)`, this function will also check if the item at `def_id` has been
|
|
|
|
/// deprecated. If the item is indeed deprecated, we will emit a deprecation lint attached to
|
|
|
|
/// `id`.
|
2019-02-24 02:33:17 -06:00
|
|
|
pub fn eval_stability(self, def_id: DefId, id: Option<HirId>, span: Span) -> EvalResult {
|
2018-12-09 10:17:50 -06:00
|
|
|
let lint_deprecated = |def_id: DefId,
|
2019-02-24 02:33:17 -06:00
|
|
|
id: HirId,
|
2018-12-09 10:17:50 -06:00
|
|
|
note: Option<Symbol>,
|
2019-01-30 10:47:36 -06:00
|
|
|
suggestion: Option<Symbol>,
|
2018-12-09 10:17:50 -06:00
|
|
|
message: &str,
|
|
|
|
lint: &'static Lint| {
|
2019-03-16 16:33:15 -05:00
|
|
|
if in_derive_expansion(span) {
|
|
|
|
return;
|
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
let msg = if let Some(note) = note {
|
2018-12-09 10:17:50 -06:00
|
|
|
format!("{}: {}", message, note)
|
2016-11-10 11:08:21 -06:00
|
|
|
} else {
|
2018-12-09 10:17:50 -06:00
|
|
|
format!("{}", message)
|
2016-11-10 11:08:21 -06:00
|
|
|
};
|
|
|
|
|
2019-02-24 02:33:17 -06:00
|
|
|
let mut diag = self.struct_span_lint_hir(lint, id, span, &msg);
|
2019-01-30 10:47:36 -06:00
|
|
|
if let Some(suggestion) = suggestion {
|
2019-02-24 02:33:17 -06:00
|
|
|
if let hir::Node::Expr(_) = self.hir().get_by_hir_id(id) {
|
2019-01-30 10:47:36 -06:00
|
|
|
diag.span_suggestion(
|
|
|
|
span,
|
2019-03-23 20:13:57 -05:00
|
|
|
"replace the use of the deprecated item",
|
2019-01-30 10:47:36 -06:00
|
|
|
suggestion.to_string(),
|
|
|
|
Applicability::MachineApplicable,
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
diag.emit();
|
2019-02-24 02:33:17 -06:00
|
|
|
if id == hir::DUMMY_HIR_ID {
|
|
|
|
span_bug!(span, "emitted a {} lint with dummy HIR id: {:?}", lint.name, def_id);
|
2018-03-03 03:02:01 -06:00
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
// Deprecated attributes apply in-crate and cross-crate.
|
2018-03-03 03:02:01 -06:00
|
|
|
if let Some(id) = id {
|
|
|
|
if let Some(depr_entry) = self.lookup_deprecation_entry(def_id) {
|
2019-02-24 02:33:17 -06:00
|
|
|
let parent_def_id = self.hir().local_def_id_from_hir_id(
|
|
|
|
self.hir().get_parent_item(id));
|
2018-12-09 10:17:50 -06:00
|
|
|
let skip = self.lookup_deprecation_entry(parent_def_id)
|
2018-03-19 10:21:36 -05:00
|
|
|
.map_or(false, |parent_depr| parent_depr.same_origin(&depr_entry));
|
2018-12-09 10:17:50 -06:00
|
|
|
|
2019-02-05 15:50:44 -06:00
|
|
|
if !skip {
|
2018-12-19 04:31:35 -06:00
|
|
|
let path = self.def_path_str(def_id);
|
2018-12-09 10:17:50 -06:00
|
|
|
let message = format!("use of deprecated item '{}'", path);
|
|
|
|
lint_deprecated(def_id,
|
|
|
|
id,
|
|
|
|
depr_entry.attr.note,
|
2019-01-30 10:47:36 -06:00
|
|
|
None,
|
2018-12-09 10:17:50 -06:00
|
|
|
&message,
|
|
|
|
lint::builtin::DEPRECATED);
|
2018-03-03 03:02:01 -06:00
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2017-05-08 15:36:26 -05:00
|
|
|
let is_staged_api = self.lookup_stability(DefId {
|
|
|
|
index: CRATE_DEF_INDEX,
|
|
|
|
..def_id
|
|
|
|
}).is_some();
|
2016-11-10 11:08:21 -06:00
|
|
|
if !is_staged_api {
|
2018-02-26 07:34:06 -06:00
|
|
|
return EvalResult::Allow;
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
let stability = self.lookup_stability(def_id);
|
|
|
|
debug!("stability: \
|
|
|
|
inspecting def_id={:?} span={:?} of stability={:?}", def_id, span, stability);
|
|
|
|
|
2019-01-30 10:47:36 -06:00
|
|
|
if let Some(id) = id {
|
|
|
|
if let Some(stability) = stability {
|
|
|
|
if let Some(depr) = &stability.rustc_depr {
|
2018-12-19 04:31:35 -06:00
|
|
|
let path = self.def_path_str(def_id);
|
2019-01-30 10:47:36 -06:00
|
|
|
if deprecation_in_effect(&depr.since.as_str()) {
|
|
|
|
let message = format!("use of deprecated item '{}'", path);
|
|
|
|
lint_deprecated(def_id,
|
|
|
|
id,
|
|
|
|
Some(depr.reason),
|
|
|
|
depr.suggestion,
|
|
|
|
&message,
|
|
|
|
lint::builtin::DEPRECATED);
|
|
|
|
} else {
|
|
|
|
let message = format!("use of item '{}' \
|
|
|
|
that will be deprecated in future version {}",
|
|
|
|
path,
|
|
|
|
depr.since);
|
|
|
|
lint_deprecated(def_id,
|
|
|
|
id,
|
|
|
|
Some(depr.reason),
|
|
|
|
depr.suggestion,
|
|
|
|
&message,
|
|
|
|
lint::builtin::DEPRECATED_IN_FUTURE);
|
|
|
|
}
|
2018-06-21 08:37:35 -05:00
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-14 17:20:14 -06:00
|
|
|
// Only the cross-crate scenario matters when checking unstable APIs
|
2016-11-10 11:08:21 -06:00
|
|
|
let cross_crate = !def_id.is_local();
|
2015-09-28 19:46:01 -05:00
|
|
|
if !cross_crate {
|
2018-02-26 07:34:06 -06:00
|
|
|
return EvalResult::Allow;
|
2015-09-28 19:46:01 -05:00
|
|
|
}
|
|
|
|
|
2018-11-26 20:59:49 -06:00
|
|
|
// Issue #38412: private items lack stability markers.
|
2016-12-29 15:00:53 -06:00
|
|
|
if self.skip_stability_check_due_to_privacy(def_id) {
|
2018-02-26 07:34:06 -06:00
|
|
|
return EvalResult::Allow;
|
2016-12-29 15:00:53 -06:00
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
match stability {
|
2018-02-26 07:34:06 -06:00
|
|
|
Some(&Stability { level: attr::Unstable { reason, issue }, feature, .. }) => {
|
2019-05-07 22:21:18 -05:00
|
|
|
if span.allows_unstable(feature) {
|
2019-02-03 05:55:00 -06:00
|
|
|
debug!("stability: skipping span={:?} since it is internal", span);
|
|
|
|
return EvalResult::Allow;
|
|
|
|
}
|
2018-02-26 07:34:06 -06:00
|
|
|
if self.stability().active_features.contains(&feature) {
|
|
|
|
return EvalResult::Allow;
|
2015-01-14 17:20:14 -06:00
|
|
|
}
|
2017-05-08 15:36:26 -05:00
|
|
|
|
|
|
|
// When we're compiling the compiler itself we may pull in
|
|
|
|
// crates from crates.io, but those crates may depend on other
|
|
|
|
// crates also pulled in from crates.io. We want to ideally be
|
|
|
|
// able to compile everything without requiring upstream
|
|
|
|
// modifications, so in the case that this looks like a
|
2018-11-26 20:59:49 -06:00
|
|
|
// `rustc_private` crate (e.g., a compiler crate) and we also have
|
2017-05-08 15:36:26 -05:00
|
|
|
// the `-Z force-unstable-if-unmarked` flag present (we're
|
|
|
|
// compiling a compiler crate), then let this missing feature
|
|
|
|
// annotation slide.
|
2019-05-07 01:03:44 -05:00
|
|
|
if feature == sym::rustc_private && issue == 27812 {
|
2017-05-08 15:36:26 -05:00
|
|
|
if self.sess.opts.debugging_opts.force_unstable_if_unmarked {
|
2018-02-26 07:34:06 -06:00
|
|
|
return EvalResult::Allow;
|
2017-05-08 15:36:26 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-02-26 07:34:06 -06:00
|
|
|
EvalResult::Deny { feature, reason, issue }
|
|
|
|
}
|
|
|
|
Some(_) => {
|
|
|
|
// Stable APIs are always ok to call and deprecated APIs are
|
|
|
|
// handled by the lint emitting logic above.
|
|
|
|
EvalResult::Allow
|
|
|
|
}
|
|
|
|
None => {
|
|
|
|
EvalResult::Unmarked
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-03-03 03:02:01 -06:00
|
|
|
/// Checks if an item is stable or error out.
|
|
|
|
///
|
|
|
|
/// If the item defined by `def_id` is unstable and the corresponding `#![feature]` does not
|
|
|
|
/// exist, emits an error.
|
|
|
|
///
|
|
|
|
/// Additionally, this function will also check if the item is deprecated. If so, and `id` is
|
|
|
|
/// not `None`, a deprecated lint attached to `id` will be emitted.
|
2019-02-24 02:33:17 -06:00
|
|
|
pub fn check_stability(self, def_id: DefId, id: Option<HirId>, span: Span) {
|
2018-02-26 07:34:06 -06:00
|
|
|
match self.eval_stability(def_id, id, span) {
|
|
|
|
EvalResult::Allow => {}
|
|
|
|
EvalResult::Deny { feature, reason, issue } => {
|
|
|
|
let msg = match reason {
|
|
|
|
Some(r) => format!("use of unstable library feature '{}': {}", feature, r),
|
2017-05-08 15:36:26 -05:00
|
|
|
None => format!("use of unstable library feature '{}'", &feature)
|
|
|
|
};
|
2017-10-25 18:56:13 -05:00
|
|
|
|
|
|
|
let msp: MultiSpan = span.into();
|
2018-08-18 05:14:09 -05:00
|
|
|
let cm = &self.sess.parse_sess.source_map();
|
2017-10-28 12:39:00 -05:00
|
|
|
let span_key = msp.primary_span().and_then(|sp: Span|
|
2018-06-24 17:00:21 -05:00
|
|
|
if !sp.is_dummy() {
|
2017-10-28 12:39:00 -05:00
|
|
|
let file = cm.lookup_char_pos(sp.lo()).file;
|
2017-12-14 01:09:19 -06:00
|
|
|
if file.name.is_macros() {
|
2017-10-25 18:56:13 -05:00
|
|
|
None
|
2017-10-28 12:39:00 -05:00
|
|
|
} else {
|
|
|
|
Some(span)
|
2017-10-25 18:56:13 -05:00
|
|
|
}
|
2017-10-28 12:39:00 -05:00
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
);
|
2017-10-25 18:56:13 -05:00
|
|
|
|
2017-10-28 12:39:00 -05:00
|
|
|
let error_id = (DiagnosticMessageId::StabilityId(issue), span_key, msg.clone());
|
|
|
|
let fresh = self.sess.one_time_diagnostics.borrow_mut().insert(error_id);
|
2017-10-26 11:34:39 -05:00
|
|
|
if fresh {
|
2019-05-07 22:21:18 -05:00
|
|
|
emit_feature_err(&self.sess.parse_sess, feature, span,
|
2017-10-26 11:34:39 -05:00
|
|
|
GateIssue::Library(Some(issue)), &msg);
|
2017-10-25 18:56:13 -05:00
|
|
|
}
|
2015-01-14 17:20:14 -06:00
|
|
|
}
|
2018-02-26 07:34:06 -06:00
|
|
|
EvalResult::Unmarked => {
|
2019-02-04 03:04:33 -06:00
|
|
|
// The API could be uncallable for other reasons, for example when a private module
|
|
|
|
// was referenced.
|
|
|
|
self.sess.delay_span_bug(span, &format!("encountered unmarked API: {:?}", def_id));
|
2015-01-14 17:20:14 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
impl<'a, 'tcx> Visitor<'tcx> for Checker<'a, 'tcx> {
|
2016-11-28 13:00:26 -06:00
|
|
|
/// Because stability levels are scoped lexically, we want to walk
|
|
|
|
/// nested items in the context of the outer item, so enable
|
|
|
|
/// deep-walking.
|
|
|
|
fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
|
2018-12-04 06:45:36 -06:00
|
|
|
NestedVisitorMap::OnlyBodies(&self.tcx.hir())
|
2016-10-28 15:58:32 -05:00
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_item(&mut self, item: &'tcx hir::Item) {
|
2016-11-10 11:08:21 -06:00
|
|
|
match item.node {
|
2018-07-11 10:36:06 -05:00
|
|
|
hir::ItemKind::ExternCrate(_) => {
|
2016-11-10 11:08:21 -06:00
|
|
|
// compiler-generated `extern crate` items have a dummy span.
|
2018-06-24 17:00:21 -05:00
|
|
|
if item.span.is_dummy() { return }
|
2016-11-10 11:08:21 -06:00
|
|
|
|
2019-02-27 10:35:24 -06:00
|
|
|
let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
|
2017-09-08 15:51:57 -05:00
|
|
|
let cnum = match self.tcx.extern_mod_stmt_cnum(def_id) {
|
2016-11-10 11:08:21 -06:00
|
|
|
Some(cnum) => cnum,
|
|
|
|
None => return,
|
|
|
|
};
|
|
|
|
let def_id = DefId { krate: cnum, index: CRATE_DEF_INDEX };
|
2019-02-24 02:33:17 -06:00
|
|
|
self.tcx.check_stability(def_id, Some(item.hir_id), item.span);
|
2015-02-17 15:56:06 -06:00
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
// For implementations of traits, check the stability of each item
|
|
|
|
// individually as it's possible to have a stable trait with unstable
|
|
|
|
// items.
|
2018-07-11 10:36:06 -05:00
|
|
|
hir::ItemKind::Impl(.., Some(ref t), _, ref impl_item_refs) => {
|
2019-04-20 11:36:05 -05:00
|
|
|
if let Res::Def(DefKind::Trait, trait_did) = t.path.res {
|
2016-11-10 11:08:21 -06:00
|
|
|
for impl_item_ref in impl_item_refs {
|
2018-12-04 06:45:36 -06:00
|
|
|
let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
|
2016-11-10 11:08:21 -06:00
|
|
|
let trait_item_def_id = self.tcx.associated_items(trait_did)
|
2018-06-10 14:24:24 -05:00
|
|
|
.find(|item| item.ident.name == impl_item.ident.name)
|
|
|
|
.map(|item| item.def_id);
|
2016-11-10 11:08:21 -06:00
|
|
|
if let Some(def_id) = trait_item_def_id {
|
2018-03-03 03:02:01 -06:00
|
|
|
// Pass `None` to skip deprecation warnings.
|
|
|
|
self.tcx.check_stability(def_id, None, impl_item.span);
|
2016-09-05 17:26:02 -05:00
|
|
|
}
|
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
2015-02-25 05:34:21 -06:00
|
|
|
}
|
2015-01-14 17:20:14 -06:00
|
|
|
|
2017-05-17 16:22:52 -05:00
|
|
|
// There's no good place to insert stability check for non-Copy unions,
|
|
|
|
// so semi-randomly perform it here in stability.rs
|
2018-07-11 10:36:06 -05:00
|
|
|
hir::ItemKind::Union(..) if !self.tcx.features().untagged_unions => {
|
2019-02-27 10:35:24 -06:00
|
|
|
let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
|
2017-05-17 16:22:52 -05:00
|
|
|
let adt_def = self.tcx.adt_def(def_id);
|
|
|
|
let ty = self.tcx.type_of(def_id);
|
|
|
|
|
|
|
|
if adt_def.has_dtor(self.tcx) {
|
|
|
|
emit_feature_err(&self.tcx.sess.parse_sess,
|
2019-05-07 22:21:18 -05:00
|
|
|
sym::untagged_unions, item.span, GateIssue::Language,
|
2017-05-17 16:22:52 -05:00
|
|
|
"unions with `Drop` implementations are unstable");
|
|
|
|
} else {
|
|
|
|
let param_env = self.tcx.param_env(def_id);
|
2018-05-08 09:38:35 -05:00
|
|
|
if !param_env.can_type_implement_copy(self.tcx, ty).is_ok() {
|
2017-05-17 16:22:52 -05:00
|
|
|
emit_feature_err(&self.tcx.sess.parse_sess,
|
2019-05-07 22:21:18 -05:00
|
|
|
sym::untagged_unions, item.span, GateIssue::Language,
|
2018-10-02 11:29:48 -05:00
|
|
|
"unions with non-`Copy` fields are unstable");
|
2017-05-17 16:22:52 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
_ => (/* pass */)
|
2015-02-25 05:34:21 -06:00
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
intravisit::walk_item(self, item);
|
2015-02-25 05:34:21 -06:00
|
|
|
}
|
2016-10-26 21:17:42 -05:00
|
|
|
|
2018-07-31 11:43:51 -05:00
|
|
|
fn visit_path(&mut self, path: &'tcx hir::Path, id: hir::HirId) {
|
2019-04-20 11:36:05 -05:00
|
|
|
if let Some(def_id) = path.res.opt_def_id() {
|
2018-11-11 11:28:56 -06:00
|
|
|
self.tcx.check_stability(def_id, Some(id), path.span)
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
intravisit::walk_path(self, path)
|
2016-10-26 21:17:42 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
|
2016-05-11 00:48:12 -05:00
|
|
|
pub fn lookup_deprecation(self, id: DefId) -> Option<Deprecation> {
|
2016-08-04 08:18:36 -05:00
|
|
|
self.lookup_deprecation_entry(id).map(|depr| depr.attr)
|
|
|
|
}
|
Add stability inheritance
This commit makes several changes to the stability index infrastructure:
* Stability levels are now inherited lexically, i.e., each item's
stability level becomes the default for any nested items.
* The computed stability level for an item is stored as part of the
metadata. When using an item from an external crate, this data is
looked up and cached.
* The stability lint works from the computed stability level, rather
than manual stability attribute annotations. However, the lint still
checks only a limited set of item uses (e.g., it does not check every
component of a path on import). This will be addressed in a later PR,
as part of issue #8962.
* The stability lint only applies to items originating from external
crates, since the stability index is intended as a promise to
downstream crates.
* The "experimental" lint is now _allow_ by default. This is because
almost all existing crates have been marked "experimental", pending
library stabilization. With inheritance in place, this would generate
a massive explosion of warnings for every Rust program.
The lint should be changed back to deny-by-default after library
stabilization is complete.
* The "deprecated" lint still warns by default.
The net result: we can begin tracking stability index for the standard
libraries as we stabilize, without impacting most clients.
Closes #13540.
2014-06-11 19:23:11 -05:00
|
|
|
}
|
Preliminary feature staging
This partially implements the feature staging described in the
[release channel RFC][rc]. It does not yet fully conform to the RFC as
written, but does accomplish its goals sufficiently for the 1.0 alpha
release.
It has three primary user-visible effects:
* On the nightly channel, use of unstable APIs generates a warning.
* On the beta channel, use of unstable APIs generates a warning.
* On the beta channel, use of feature gates generates a warning.
Code that does not trigger these warnings is considered 'stable',
modulo pre-1.0 bugs.
Disabling the warnings for unstable APIs continues to be done in the
existing (i.e. old) style, via `#[allow(...)]`, not that specified in
the RFC. I deem this marginally acceptable since any code that must do
this is not using the stable dialect of Rust.
Use of feature gates is itself gated with the new 'unstable_features'
lint, on nightly set to 'allow', and on beta 'warn'.
The attribute scheme used here corresponds to an older version of the
RFC, with the `#[staged_api]` crate attribute toggling the staging
behavior of the stability attributes, but the user impact is only
in-tree so I'm not concerned about having to make design changes later
(and I may ultimately prefer the scheme here after all, with the
`#[staged_api]` crate attribute).
Since the Rust codebase itself makes use of unstable features the
compiler and build system to a midly elaborate dance to allow it to
bootstrap while disobeying these lints (which would otherwise be
errors because Rust builds with `-D warnings`).
This patch includes one significant hack that causes a
regression. Because the `format_args!` macro emits calls to unstable
APIs it would trigger the lint. I added a hack to the lint to make it
not trigger, but this in turn causes arguments to `println!` not to be
checked for feature gates. I don't presently understand macro
expansion well enough to fix. This is bug #20661.
Closes #16678
[rc]: https://github.com/rust-lang/rfcs/blob/master/text/0507-release-channels.md
2015-01-06 08:26:08 -06:00
|
|
|
|
2018-11-26 20:59:49 -06:00
|
|
|
/// Given the list of enabled features that were not language features (i.e., that
|
2015-01-14 17:20:14 -06:00
|
|
|
/// were expected to be library features), and the list of features used from
|
|
|
|
/// libraries, identify activated features that don't exist and error about them.
|
2017-03-23 14:13:29 -05:00
|
|
|
pub fn check_unused_or_stable_features<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) {
|
2017-04-24 09:23:36 -05:00
|
|
|
let access_levels = &tcx.privacy_access_levels(LOCAL_CRATE);
|
2017-03-23 14:13:29 -05:00
|
|
|
|
2017-08-31 17:08:34 -05:00
|
|
|
if tcx.stability().staged_api[&LOCAL_CRATE] {
|
2018-12-04 06:45:36 -06:00
|
|
|
let krate = tcx.hir().krate();
|
2016-11-10 11:08:21 -06:00
|
|
|
let mut missing = MissingStabilityAnnotations {
|
2017-07-03 13:19:51 -05:00
|
|
|
tcx,
|
|
|
|
access_levels,
|
2016-11-10 11:08:21 -06:00
|
|
|
};
|
2019-02-18 08:35:20 -06:00
|
|
|
missing.check_missing_stability(hir::CRATE_HIR_ID, krate.span, "crate");
|
2016-11-10 11:08:21 -06:00
|
|
|
intravisit::walk_crate(&mut missing, krate);
|
2016-11-28 13:00:26 -06:00
|
|
|
krate.visit_all_item_likes(&mut missing.as_deep_visitor());
|
2016-11-10 11:08:21 -06:00
|
|
|
}
|
|
|
|
|
2018-07-22 20:03:01 -05:00
|
|
|
let declared_lang_features = &tcx.features().declared_lang_features;
|
2018-10-16 03:44:26 -05:00
|
|
|
let mut lang_features = FxHashSet::default();
|
2018-07-23 11:34:04 -05:00
|
|
|
for &(feature, span, since) in declared_lang_features {
|
2018-07-22 20:03:01 -05:00
|
|
|
if let Some(since) = since {
|
|
|
|
// Warn if the user has enabled an already-stable lang feature.
|
2018-07-23 11:34:04 -05:00
|
|
|
unnecessary_stable_feature_lint(tcx, span, feature, since);
|
2018-07-22 20:03:01 -05:00
|
|
|
}
|
|
|
|
if lang_features.contains(&feature) {
|
|
|
|
// Warn if the user enables a lang feature multiple times.
|
2018-07-23 11:34:04 -05:00
|
|
|
duplicate_feature_err(tcx.sess, span, feature);
|
2018-07-22 20:03:01 -05:00
|
|
|
}
|
|
|
|
lang_features.insert(feature);
|
|
|
|
}
|
2018-07-22 19:20:33 -05:00
|
|
|
|
2018-07-22 20:03:01 -05:00
|
|
|
let declared_lib_features = &tcx.features().declared_lib_features;
|
2018-10-16 03:44:26 -05:00
|
|
|
let mut remaining_lib_features = FxHashMap::default();
|
2018-07-22 20:03:01 -05:00
|
|
|
for (feature, span) in declared_lib_features {
|
2018-07-22 19:22:01 -05:00
|
|
|
if remaining_lib_features.contains_key(&feature) {
|
2018-07-23 11:34:04 -05:00
|
|
|
// Warn if the user enables a lib feature multiple times.
|
|
|
|
duplicate_feature_err(tcx.sess, *span, *feature);
|
2018-07-22 19:22:01 -05:00
|
|
|
}
|
2018-07-22 20:03:01 -05:00
|
|
|
remaining_lib_features.insert(feature, span.clone());
|
2018-07-22 19:20:33 -05:00
|
|
|
}
|
2018-07-23 18:56:00 -05:00
|
|
|
// `stdbuild` has special handling for `libc`, so we need to
|
|
|
|
// recognise the feature when building std.
|
2018-08-06 10:46:08 -05:00
|
|
|
// Likewise, libtest is handled specially, so `test` isn't
|
|
|
|
// available as we'd like it to be.
|
2018-07-23 18:56:00 -05:00
|
|
|
// FIXME: only remove `libc` when `stdbuild` is active.
|
2018-08-06 10:46:08 -05:00
|
|
|
// FIXME: remove special casing for `test`.
|
2018-07-22 19:20:33 -05:00
|
|
|
remaining_lib_features.remove(&Symbol::intern("libc"));
|
2018-08-06 10:46:08 -05:00
|
|
|
remaining_lib_features.remove(&Symbol::intern("test"));
|
2018-07-22 19:20:33 -05:00
|
|
|
|
2018-08-20 19:39:48 -05:00
|
|
|
let check_features =
|
|
|
|
|remaining_lib_features: &mut FxHashMap<_, _>, defined_features: &Vec<_>| {
|
|
|
|
for &(feature, since) in defined_features {
|
|
|
|
if let Some(since) = since {
|
|
|
|
if let Some(span) = remaining_lib_features.get(&feature) {
|
|
|
|
// Warn if the user has enabled an already-stable lib feature.
|
|
|
|
unnecessary_stable_feature_lint(tcx, *span, feature, since);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
remaining_lib_features.remove(&feature);
|
|
|
|
if remaining_lib_features.is_empty() {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
// We always collect the lib features declared in the current crate, even if there are
|
|
|
|
// no unknown features, because the collection also does feature attribute validation.
|
|
|
|
let local_defined_features = tcx.lib_features().to_vec();
|
|
|
|
if !remaining_lib_features.is_empty() {
|
|
|
|
check_features(&mut remaining_lib_features, &local_defined_features);
|
|
|
|
|
|
|
|
for &cnum in &*tcx.crates() {
|
|
|
|
if remaining_lib_features.is_empty() {
|
|
|
|
break;
|
2018-07-22 19:21:35 -05:00
|
|
|
}
|
2018-08-20 19:39:48 -05:00
|
|
|
check_features(&mut remaining_lib_features, &tcx.defined_lib_features(cnum));
|
2018-07-22 19:21:35 -05:00
|
|
|
}
|
2018-07-22 19:20:33 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
for (feature, span) in remaining_lib_features {
|
2018-07-23 15:05:39 -05:00
|
|
|
struct_span_err!(tcx.sess, span, E0635, "unknown feature `{}`", feature).emit();
|
2018-07-22 19:20:33 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// FIXME(#44232): the `used_features` table no longer exists, so we
|
|
|
|
// don't lint about unused features. We should reenable this one day!
|
2017-08-31 17:08:34 -05:00
|
|
|
}
|
2015-01-16 12:25:16 -06:00
|
|
|
|
2018-07-23 11:34:04 -05:00
|
|
|
fn unnecessary_stable_feature_lint<'a, 'tcx>(
|
|
|
|
tcx: TyCtxt<'a, 'tcx, 'tcx>,
|
|
|
|
span: Span,
|
|
|
|
feature: Symbol,
|
|
|
|
since: Symbol
|
|
|
|
) {
|
2019-02-26 04:48:34 -06:00
|
|
|
tcx.lint_hir(lint::builtin::STABLE_FEATURES,
|
|
|
|
hir::CRATE_HIR_ID,
|
2018-07-23 11:34:04 -05:00
|
|
|
span,
|
|
|
|
&format!("the feature `{}` has been stable since {} and no longer requires \
|
|
|
|
an attribute to enable", feature, since));
|
|
|
|
}
|
|
|
|
|
|
|
|
fn duplicate_feature_err(sess: &Session, span: Span, feature: Symbol) {
|
|
|
|
struct_span_err!(sess, span, E0636, "the feature `{}` has already been declared", feature)
|
|
|
|
.emit();
|
Preliminary feature staging
This partially implements the feature staging described in the
[release channel RFC][rc]. It does not yet fully conform to the RFC as
written, but does accomplish its goals sufficiently for the 1.0 alpha
release.
It has three primary user-visible effects:
* On the nightly channel, use of unstable APIs generates a warning.
* On the beta channel, use of unstable APIs generates a warning.
* On the beta channel, use of feature gates generates a warning.
Code that does not trigger these warnings is considered 'stable',
modulo pre-1.0 bugs.
Disabling the warnings for unstable APIs continues to be done in the
existing (i.e. old) style, via `#[allow(...)]`, not that specified in
the RFC. I deem this marginally acceptable since any code that must do
this is not using the stable dialect of Rust.
Use of feature gates is itself gated with the new 'unstable_features'
lint, on nightly set to 'allow', and on beta 'warn'.
The attribute scheme used here corresponds to an older version of the
RFC, with the `#[staged_api]` crate attribute toggling the staging
behavior of the stability attributes, but the user impact is only
in-tree so I'm not concerned about having to make design changes later
(and I may ultimately prefer the scheme here after all, with the
`#[staged_api]` crate attribute).
Since the Rust codebase itself makes use of unstable features the
compiler and build system to a midly elaborate dance to allow it to
bootstrap while disobeying these lints (which would otherwise be
errors because Rust builds with `-D warnings`).
This patch includes one significant hack that causes a
regression. Because the `format_args!` macro emits calls to unstable
APIs it would trigger the lint. I added a hack to the lint to make it
not trigger, but this in turn causes arguments to `println!` not to be
checked for feature gates. I don't presently understand macro
expansion well enough to fix. This is bug #20661.
Closes #16678
[rc]: https://github.com/rust-lang/rfcs/blob/master/text/0507-release-channels.md
2015-01-06 08:26:08 -06:00
|
|
|
}
|