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
|
|
|
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
|
|
|
//! 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::*;
|
|
|
|
|
2015-12-22 15:35:02 -06:00
|
|
|
use dep_graph::DepNode;
|
2016-03-29 00:50:44 -05:00
|
|
|
use hir::map as hir_map;
|
2015-01-16 12:25:16 -06:00
|
|
|
use lint;
|
2016-03-29 04:54:26 -05:00
|
|
|
use hir::def::Def;
|
2016-08-31 06:00:29 -05:00
|
|
|
use hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId, DefIndex, LOCAL_CRATE};
|
2016-11-10 11:08:21 -06:00
|
|
|
use ty::TyCtxt;
|
2015-11-19 05:16:35 -06:00
|
|
|
use middle::privacy::AccessLevels;
|
2016-11-16 04:52:37 -06:00
|
|
|
use syntax::symbol::Symbol;
|
2016-06-21 17:08:13 -05:00
|
|
|
use syntax_pos::{Span, DUMMY_SP};
|
2014-07-10 13:17:40 -05:00
|
|
|
use syntax::ast;
|
2015-09-14 04:58:20 -05:00
|
|
|
use syntax::ast::{NodeId, Attribute};
|
2016-05-30 15:55:12 -05:00
|
|
|
use syntax::feature_gate::{GateIssue, emit_feature_err, find_lang_feature_accepted_version};
|
2016-08-22 22:54:53 -05:00
|
|
|
use syntax::attr::{self, Stability, Deprecation};
|
2016-11-07 21:02:55 -06:00
|
|
|
use util::nodemap::{DefIdMap, 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
|
|
|
|
2016-03-29 00:50:44 -05:00
|
|
|
use hir;
|
2016-11-10 11:08:21 -06:00
|
|
|
use hir::{Item, Generics, StructField, Variant};
|
2016-03-29 00:50:44 -05:00
|
|
|
use hir::intravisit::{self, Visitor};
|
2016-11-10 11:08:21 -06:00
|
|
|
use hir::itemlikevisit::DeepVisitor;
|
2015-07-31 02:04:06 -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,
|
|
|
|
/// The def id where the attr was originally attached. `None` for non-local
|
|
|
|
/// `DefId`'s.
|
|
|
|
origin: Option<DefIndex>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl DeprecationEntry {
|
|
|
|
fn local(attr: Deprecation, id: DefId) -> DeprecationEntry {
|
|
|
|
assert!(id.is_local());
|
|
|
|
DeprecationEntry {
|
|
|
|
attr: attr,
|
|
|
|
origin: Some(id.index),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
fn external(attr: Deprecation) -> DeprecationEntry {
|
|
|
|
DeprecationEntry {
|
|
|
|
attr: attr,
|
|
|
|
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.
|
2015-12-04 10:34:28 -06:00
|
|
|
stab_map: DefIdMap<Option<&'tcx Stability>>,
|
2016-08-04 08:18:36 -05:00
|
|
|
depr_map: DefIdMap<Option<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>,
|
|
|
|
|
|
|
|
/// Features used by this crate. Updated before and during typeck.
|
|
|
|
used_features: FxHashMap<Symbol, attr::StabilityLevel>
|
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.
|
2015-12-17 11:41:28 -06:00
|
|
|
fn annotate<F>(&mut self, id: NodeId, 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
|
|
|
{
|
2015-11-25 15:15:46 -06:00
|
|
|
if self.index.staged_api[&LOCAL_CRATE] && self.tcx.sess.features.borrow().staged_api {
|
2015-04-13 20:42:24 -05:00
|
|
|
debug!("annotate(id = {:?}, attrs = {:?})", id, attrs);
|
2015-12-04 10:34:28 -06:00
|
|
|
if let Some(..) = attr::find_deprecation(self.tcx.sess.diagnostic(), attrs, item_sp) {
|
|
|
|
self.tcx.sess.span_err(item_sp, "`#[deprecated]` cannot be used in staged api, \
|
|
|
|
use `#[rustc_deprecated]` instead");
|
|
|
|
}
|
2015-11-16 10:53:41 -06:00
|
|
|
if let Some(mut stab) = attr::find_stability(self.tcx.sess.diagnostic(),
|
|
|
|
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
|
2016-11-16 04:52:37 -06: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
|
|
|
|
2015-11-16 10:53:41 -06:00
|
|
|
let def_id = self.tcx.map.local_def_id(id);
|
2015-12-04 10:34:28 -06:00
|
|
|
self.index.stab_map.insert(def_id, Some(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() {
|
|
|
|
let def_id = self.tcx.map.local_def_id(id);
|
2015-12-04 10:34:28 -06:00
|
|
|
self.index.stab_map.insert(def_id, Some(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 {
|
|
|
|
let tag = attr.name();
|
2015-11-20 07:11:20 -06:00
|
|
|
if tag == "unstable" || tag == "stable" || tag == "rustc_deprecated" {
|
2015-04-13 20:42:24 -05:00
|
|
|
attr::mark_used(attr);
|
2015-11-16 10:53:41 -06:00
|
|
|
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
|
|
|
|
|
|
|
if let Some(depr) = attr::find_deprecation(self.tcx.sess.diagnostic(), attrs, item_sp) {
|
|
|
|
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
|
|
|
|
let def_id = self.tcx.map.local_def_id(id);
|
2016-08-04 08:18:36 -05:00
|
|
|
let depr_entry = Some(DeprecationEntry::local(depr, def_id));
|
|
|
|
self.index.depr_map.insert(def_id, depr_entry.clone());
|
2015-12-04 10:34:28 -06:00
|
|
|
|
2016-08-04 08:18:36 -05:00
|
|
|
let orig_parent_depr = replace(&mut self.parent_depr, depr_entry);
|
2015-12-04 10:34:28 -06:00
|
|
|
visit_children(self);
|
|
|
|
self.parent_depr = orig_parent_depr;
|
2016-08-04 08:18:36 -05:00
|
|
|
} else if let parent_depr @ Some(_) = self.parent_depr.clone() {
|
2015-12-04 10:34:28 -06:00
|
|
|
let def_id = self.tcx.map.local_def_id(id);
|
2016-08-04 08:18:36 -05:00
|
|
|
self.index.depr_map.insert(def_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-09 15:45:26 -06:00
|
|
|
fn nested_visit_map(&mut self) -> Option<&hir::map::Map<'tcx>> {
|
|
|
|
Some(&self.tcx.map)
|
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.
|
2016-08-26 11:23:42 -05:00
|
|
|
hir::ItemImpl(.., None, _, _) | hir::ItemForeignMod(..) => {
|
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
|
|
|
}
|
2016-08-26 11:23:42 -05:00
|
|
|
hir::ItemImpl(.., Some(_), _, _) => {
|
2015-11-16 10:53:41 -06:00
|
|
|
self.in_trait_impl = true;
|
2015-10-01 19:53:28 -05:00
|
|
|
}
|
2015-11-16 10:53:41 -06:00
|
|
|
hir::ItemStruct(ref sd, _) => {
|
|
|
|
if !sd.is_struct() {
|
2015-11-16 12:01:06 -06:00
|
|
|
self.annotate(sd.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
|
|
|
|
2015-11-16 10:53:41 -06:00
|
|
|
self.annotate(i.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) {
|
2015-11-16 12:01:06 -06:00
|
|
|
self.annotate(ti.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
|
|
|
|
};
|
2015-11-16 10:53:41 -06:00
|
|
|
self.annotate(ii.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
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_variant(&mut self, var: &'tcx Variant, g: &'tcx Generics, item_id: NodeId) {
|
2015-11-16 12:01:06 -06:00
|
|
|
self.annotate(var.node.data.id(), &var.node.attrs, var.span, AnnotationKind::Required, |v| {
|
2015-11-17 17:56:13 -06:00
|
|
|
intravisit::walk_variant(v, var, g, item_id);
|
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
|
|
|
}
|
|
|
|
|
2016-11-09 15:45:26 -06:00
|
|
|
fn visit_struct_field(&mut self, s: &'tcx StructField) {
|
2016-02-27 02:34:29 -06:00
|
|
|
self.annotate(s.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) {
|
2015-11-16 12:01:06 -06:00
|
|
|
self.annotate(i.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) {
|
2015-11-16 10:53:41 -06:00
|
|
|
if md.imported_from.is_none() {
|
2015-11-16 12:01:06 -06:00
|
|
|
self.annotate(md.id, &md.attrs, md.span, AnnotationKind::Required, |_| {});
|
2015-11-16 10:53:41 -06:00
|
|
|
}
|
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> {
|
|
|
|
fn check_missing_stability(&self, id: NodeId, span: Span) {
|
|
|
|
let def_id = self.tcx.map.local_def_id(id);
|
|
|
|
let is_error = !self.tcx.sess.opts.test &&
|
|
|
|
!self.tcx.stability.borrow().stab_map.contains_key(&def_id) &&
|
|
|
|
self.access_levels.is_reachable(id);
|
|
|
|
if is_error {
|
|
|
|
self.tcx.sess.span_err(span, "This node does not have a stability attribute");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a, 'tcx, 'v> Visitor<'v> for MissingStabilityAnnotations<'a, 'tcx> {
|
|
|
|
fn visit_item(&mut self, i: &Item) {
|
|
|
|
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.
|
|
|
|
hir::ItemImpl(.., None, _, _) | hir::ItemForeignMod(..) => {}
|
|
|
|
|
|
|
|
_ => self.check_missing_stability(i.id, i.span)
|
|
|
|
}
|
|
|
|
|
|
|
|
intravisit::walk_item(self, i)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_trait_item(&mut self, ti: &hir::TraitItem) {
|
|
|
|
self.check_missing_stability(ti.id, ti.span);
|
|
|
|
intravisit::walk_trait_item(self, ti);
|
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_impl_item(&mut self, ii: &hir::ImplItem) {
|
|
|
|
let impl_def_id = self.tcx.map.local_def_id(self.tcx.map.get_parent(ii.id));
|
|
|
|
if self.tcx.impl_trait_ref(impl_def_id).is_none() {
|
|
|
|
self.check_missing_stability(ii.id, ii.span);
|
|
|
|
}
|
|
|
|
intravisit::walk_impl_item(self, ii);
|
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_variant(&mut self, var: &Variant, g: &Generics, item_id: NodeId) {
|
|
|
|
self.check_missing_stability(var.node.data.id(), var.span);
|
|
|
|
intravisit::walk_variant(self, var, g, item_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_struct_field(&mut self, s: &StructField) {
|
|
|
|
self.check_missing_stability(s.id, s.span);
|
|
|
|
intravisit::walk_struct_field(self, s);
|
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_foreign_item(&mut self, i: &hir::ForeignItem) {
|
|
|
|
self.check_missing_stability(i.id, i.span);
|
|
|
|
intravisit::walk_foreign_item(self, i);
|
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_macro_def(&mut self, md: &hir::MacroDef) {
|
|
|
|
if md.imported_from.is_none() {
|
|
|
|
self.check_missing_stability(md.id, md.span);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-05-02 20:56:42 -05:00
|
|
|
impl<'a, 'tcx> Index<'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
|
|
|
/// Construct the stability index for a crate being compiled.
|
2016-11-10 11:08:21 -06:00
|
|
|
pub fn build(&mut self, tcx: TyCtxt<'a, 'tcx, 'tcx>) {
|
|
|
|
let ref active_lib_features = tcx.sess.features.borrow().declared_lib_features;
|
|
|
|
|
|
|
|
// Put the active features into a map for quick lookup
|
|
|
|
self.active_features = active_lib_features.iter().map(|&(ref s, _)| s.clone()).collect();
|
|
|
|
|
2016-01-29 14:04:07 -06:00
|
|
|
let _task = tcx.dep_graph.in_task(DepNode::StabilityIndex);
|
|
|
|
let krate = tcx.map.krate();
|
2015-02-03 09:46:08 -06:00
|
|
|
let mut annotator = Annotator {
|
2015-05-25 16:41:27 -05:00
|
|
|
tcx: tcx,
|
2015-02-03 09:46:08 -06:00
|
|
|
index: self,
|
2015-12-04 10:34:28 -06:00
|
|
|
parent_stab: None,
|
|
|
|
parent_depr: None,
|
2015-11-16 10:53:41 -06:00
|
|
|
in_trait_impl: false,
|
2015-02-03 09:46:08 -06:00
|
|
|
};
|
2015-11-16 12:01:06 -06:00
|
|
|
annotator.annotate(ast::CRATE_NODE_ID, &krate.attrs, krate.span, AnnotationKind::Required,
|
2015-11-17 17:56:13 -06:00
|
|
|
|v| intravisit::walk_crate(v, krate));
|
2015-02-03 09:46:08 -06:00
|
|
|
}
|
|
|
|
|
2016-01-29 14:04:07 -06:00
|
|
|
pub fn new(hir_map: &hir_map::Map) -> Index<'tcx> {
|
|
|
|
let _task = hir_map.dep_graph.in_task(DepNode::StabilityIndex);
|
|
|
|
let krate = hir_map.krate();
|
|
|
|
|
2015-11-25 15:15:46 -06:00
|
|
|
let mut is_staged_api = false;
|
|
|
|
for attr in &krate.attrs {
|
|
|
|
if attr.name() == "stable" || attr.name() == "unstable" {
|
|
|
|
is_staged_api = true;
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-07 21:02:55 -06:00
|
|
|
let mut staged_api = FxHashMap();
|
2015-11-25 15:15:46 -06:00
|
|
|
staged_api.insert(LOCAL_CRATE, is_staged_api);
|
2015-02-03 09:46:08 -06:00
|
|
|
Index {
|
2015-01-12 20:40:19 -06:00
|
|
|
staged_api: staged_api,
|
2015-12-04 10:34:28 -06:00
|
|
|
stab_map: DefIdMap(),
|
|
|
|
depr_map: DefIdMap(),
|
2016-11-10 11:08:21 -06:00
|
|
|
active_features: FxHashSet(),
|
|
|
|
used_features: FxHashMap(),
|
2015-01-12 20:40:19 -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
|
|
|
}
|
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.
|
|
|
|
pub fn check_unstable_api_usage<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) {
|
|
|
|
let mut checker = Checker { tcx: tcx };
|
|
|
|
tcx.visit_all_item_likes_in_krate(DepNode::StabilityCheck,
|
|
|
|
&mut DeepVisitor::new(&mut checker));
|
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
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
|
|
|
|
pub fn check_stability(self, def_id: DefId, id: NodeId, span: Span) {
|
|
|
|
if self.sess.codemap().span_allows_unstable(span) {
|
|
|
|
debug!("stability: \
|
|
|
|
skipping span={:?} since it is internal", span);
|
2015-12-04 10:34:28 -06:00
|
|
|
return;
|
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
|
|
|
|
let lint_deprecated = |note: Option<Symbol>| {
|
|
|
|
let msg = if let Some(note) = note {
|
|
|
|
format!("use of deprecated item: {}", note)
|
|
|
|
} else {
|
|
|
|
format!("use of deprecated item")
|
|
|
|
};
|
|
|
|
|
|
|
|
self.sess.add_lint(lint::builtin::DEPRECATED, id, span, msg);
|
|
|
|
};
|
|
|
|
|
|
|
|
// Deprecated attributes apply in-crate and cross-crate.
|
|
|
|
if let Some(depr_entry) = self.lookup_deprecation_entry(def_id) {
|
|
|
|
let skip = if id == ast::DUMMY_NODE_ID {
|
|
|
|
true
|
|
|
|
} else {
|
|
|
|
let parent_def_id = self.map.local_def_id(self.map.get_parent(id));
|
|
|
|
self.lookup_deprecation_entry(parent_def_id).map_or(false, |parent_depr| {
|
|
|
|
parent_depr.same_origin(&depr_entry)
|
|
|
|
})
|
|
|
|
};
|
|
|
|
|
|
|
|
if !skip {
|
|
|
|
lint_deprecated(depr_entry.attr.note);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
let is_staged_api = *self.stability.borrow_mut().staged_api.entry(def_id.krate)
|
|
|
|
.or_insert_with(|| self.sess.cstore.is_staged_api(def_id.krate));
|
|
|
|
if !is_staged_api {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
let stability = self.lookup_stability(def_id);
|
|
|
|
debug!("stability: \
|
|
|
|
inspecting def_id={:?} span={:?} of stability={:?}", def_id, span, stability);
|
|
|
|
|
|
|
|
if let Some(&Stability{rustc_depr: Some(attr::RustcDeprecation { reason, .. }), ..})
|
|
|
|
= stability {
|
|
|
|
if id != ast::DUMMY_NODE_ID {
|
|
|
|
lint_deprecated(Some(reason));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
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 {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
if let Some(&Stability { ref level, ref feature, .. }) = stability {
|
|
|
|
self.stability.borrow_mut().used_features.insert(feature.clone(), level.clone());
|
|
|
|
}
|
2015-01-14 17:20:14 -06:00
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
match stability {
|
|
|
|
Some(&Stability { level: attr::Unstable {ref reason, issue}, ref feature, .. }) => {
|
|
|
|
if !self.stability.borrow().active_features.contains(feature) {
|
2015-09-04 18:37:22 -05:00
|
|
|
let msg = match *reason {
|
2015-01-14 17:20:14 -06:00
|
|
|
Some(ref r) => format!("use of unstable library feature '{}': {}",
|
2016-11-16 04:52:37 -06:00
|
|
|
&feature.as_str(), &r),
|
2015-02-04 14:48:12 -06:00
|
|
|
None => format!("use of unstable library feature '{}'", &feature)
|
2015-01-14 17:20:14 -06:00
|
|
|
};
|
2016-11-10 11:08:21 -06:00
|
|
|
emit_feature_err(&self.sess.parse_sess, &feature.as_str(), span,
|
2016-09-24 11:42:54 -05:00
|
|
|
GateIssue::Library(Some(issue)), &msg);
|
2015-01-14 17:20:14 -06:00
|
|
|
}
|
|
|
|
}
|
2016-11-10 11:08:21 -06:00
|
|
|
Some(_) => {
|
2015-01-14 17:20:14 -06:00
|
|
|
// Stable APIs are always ok to call and deprecated APIs are
|
2016-11-10 11:08:21 -06:00
|
|
|
// handled by the lint emitting logic above.
|
2015-01-14 17:20:14 -06:00
|
|
|
}
|
|
|
|
None => {
|
|
|
|
// This is an 'unmarked' API, which should not exist
|
|
|
|
// in the standard library.
|
2016-11-10 11:08:21 -06:00
|
|
|
if self.sess.features.borrow().unmarked_api {
|
|
|
|
self.sess.struct_span_warn(span, "use of unmarked library feature")
|
|
|
|
.span_note(span, "this is either a bug in the library you are \
|
|
|
|
using or a bug in the compiler - please \
|
|
|
|
report it in both places")
|
|
|
|
.emit()
|
2015-02-03 13:51:26 -06:00
|
|
|
} else {
|
2016-11-10 11:08:21 -06:00
|
|
|
self.sess.struct_span_err(span, "use of unmarked library feature")
|
|
|
|
.span_note(span, "this is either a bug in the library you are \
|
|
|
|
using or a bug in the compiler - please \
|
|
|
|
report it in both places")
|
|
|
|
.span_note(span, "use #![feature(unmarked_api)] in the \
|
|
|
|
crate attributes to override this")
|
|
|
|
.emit()
|
2015-02-03 13:51:26 -06:00
|
|
|
}
|
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> {
|
|
|
|
fn visit_item(&mut self, item: &'tcx hir::Item) {
|
2016-11-10 11:08:21 -06:00
|
|
|
match item.node {
|
|
|
|
hir::ItemExternCrate(_) => {
|
|
|
|
// compiler-generated `extern crate` items have a dummy span.
|
|
|
|
if item.span == DUMMY_SP { return }
|
|
|
|
|
|
|
|
let cnum = match self.tcx.sess.cstore.extern_mod_stmt_cnum(item.id) {
|
|
|
|
Some(cnum) => cnum,
|
|
|
|
None => return,
|
|
|
|
};
|
|
|
|
let def_id = DefId { krate: cnum, index: CRATE_DEF_INDEX };
|
|
|
|
self.tcx.check_stability(def_id, item.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.
|
|
|
|
hir::ItemImpl(.., Some(ref t), _, ref impl_item_refs) => {
|
|
|
|
if let Def::Trait(trait_did) = t.path.def {
|
|
|
|
for impl_item_ref in impl_item_refs {
|
|
|
|
let impl_item = self.tcx.map.impl_item(impl_item_ref.id);
|
|
|
|
let trait_item_def_id = self.tcx.associated_items(trait_did)
|
|
|
|
.find(|item| item.name == impl_item.name).map(|item| item.def_id);
|
|
|
|
if let Some(def_id) = trait_item_def_id {
|
|
|
|
// Pass `DUMMY_NODE_ID` to skip deprecation warnings.
|
|
|
|
self.tcx.check_stability(def_id, ast::DUMMY_NODE_ID, 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
|
|
|
|
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
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
fn visit_path(&mut self, path: &'tcx hir::Path, id: ast::NodeId) {
|
|
|
|
match path.def {
|
|
|
|
Def::PrimTy(..) | Def::SelfTy(..) | Def::Err => {}
|
|
|
|
_ => self.tcx.check_stability(path.def.def_id(), id, path.span)
|
|
|
|
}
|
|
|
|
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
|
|
|
/// Lookup the stability for a node, loading external crate
|
|
|
|
/// metadata as necessary.
|
2016-11-10 11:08:21 -06:00
|
|
|
pub fn lookup_stability(self, id: DefId) -> Option<&'gcx Stability> {
|
2016-05-11 00:48:12 -05:00
|
|
|
if let Some(st) = self.stability.borrow().stab_map.get(&id) {
|
|
|
|
return *st;
|
|
|
|
}
|
|
|
|
|
|
|
|
let st = self.lookup_stability_uncached(id);
|
|
|
|
self.stability.borrow_mut().stab_map.insert(id, st);
|
|
|
|
st
|
2015-05-25 16:41:27 -05:00
|
|
|
}
|
|
|
|
|
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)
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn lookup_deprecation_entry(self, id: DefId) -> Option<DeprecationEntry> {
|
2016-05-11 00:48:12 -05:00
|
|
|
if let Some(depr) = self.stability.borrow().depr_map.get(&id) {
|
|
|
|
return depr.clone();
|
|
|
|
}
|
2015-05-25 16:41:27 -05:00
|
|
|
|
2016-05-11 00:48:12 -05:00
|
|
|
let depr = self.lookup_deprecation_uncached(id);
|
|
|
|
self.stability.borrow_mut().depr_map.insert(id, depr.clone());
|
|
|
|
depr
|
2015-12-04 10:34:28 -06:00
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
fn lookup_stability_uncached(self, id: DefId) -> Option<&'gcx Stability> {
|
2016-05-11 00:48:12 -05:00
|
|
|
debug!("lookup(id={:?})", id);
|
|
|
|
if id.is_local() {
|
|
|
|
None // The stability cache is filled partially lazily
|
|
|
|
} else {
|
|
|
|
self.sess.cstore.stability(id).map(|st| self.intern_stability(st))
|
|
|
|
}
|
2015-12-12 12:40:45 -06:00
|
|
|
}
|
2015-12-04 10:34:28 -06:00
|
|
|
|
2016-08-04 08:18:36 -05:00
|
|
|
fn lookup_deprecation_uncached(self, id: DefId) -> Option<DeprecationEntry> {
|
2016-05-11 00:48:12 -05:00
|
|
|
debug!("lookup(id={:?})", id);
|
|
|
|
if id.is_local() {
|
|
|
|
None // The stability cache is filled partially lazily
|
|
|
|
} else {
|
2016-08-04 08:18:36 -05:00
|
|
|
self.sess.cstore.deprecation(id).map(DeprecationEntry::external)
|
2016-05-11 00:48:12 -05:00
|
|
|
}
|
2015-12-12 12:40:45 -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
|
|
|
}
|
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
|
|
|
|
2015-01-14 17:20:14 -06:00
|
|
|
/// Given the list of enabled features that were not language features (i.e. that
|
|
|
|
/// 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.
|
2016-11-10 11:08:21 -06:00
|
|
|
pub fn check_unused_or_stable_features<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
|
|
|
|
access_levels: &AccessLevels) {
|
|
|
|
let sess = &tcx.sess;
|
|
|
|
|
|
|
|
if tcx.stability.borrow().staged_api[&LOCAL_CRATE] && tcx.sess.features.borrow().staged_api {
|
|
|
|
let _task = tcx.dep_graph.in_task(DepNode::StabilityIndex);
|
|
|
|
let krate = tcx.map.krate();
|
|
|
|
let mut missing = MissingStabilityAnnotations {
|
|
|
|
tcx: tcx,
|
|
|
|
access_levels: access_levels,
|
|
|
|
};
|
|
|
|
missing.check_missing_stability(ast::CRATE_NODE_ID, krate.span);
|
|
|
|
intravisit::walk_crate(&mut missing, krate);
|
|
|
|
krate.visit_all_item_likes(&mut DeepVisitor::new(&mut missing));
|
|
|
|
}
|
|
|
|
|
2015-02-02 22:25:42 -06:00
|
|
|
let ref declared_lib_features = sess.features.borrow().declared_lib_features;
|
2016-11-16 04:52:37 -06:00
|
|
|
let mut remaining_lib_features: FxHashMap<Symbol, Span>
|
2015-02-02 22:25:42 -06:00
|
|
|
= declared_lib_features.clone().into_iter().collect();
|
|
|
|
|
2016-05-30 15:55:12 -05:00
|
|
|
fn format_stable_since_msg(version: &str) -> String {
|
|
|
|
format!("this feature has been stable since {}. Attribute no longer needed", version)
|
|
|
|
}
|
2015-02-02 22:25:42 -06:00
|
|
|
|
2016-05-30 15:55:12 -05:00
|
|
|
for &(ref stable_lang_feature, span) in &sess.features.borrow().declared_stable_lang_features {
|
2016-11-16 04:52:37 -06:00
|
|
|
let version = find_lang_feature_accepted_version(&stable_lang_feature.as_str())
|
2016-05-30 15:55:12 -05:00
|
|
|
.expect("unexpectedly couldn't find version feature was stabilized");
|
2015-02-02 22:25:42 -06:00
|
|
|
sess.add_lint(lint::builtin::STABLE_FEATURES,
|
|
|
|
ast::CRATE_NODE_ID,
|
|
|
|
span,
|
2016-05-30 15:55:12 -05:00
|
|
|
format_stable_since_msg(version));
|
2015-02-02 22:25:42 -06:00
|
|
|
}
|
|
|
|
|
2016-11-10 11:08:21 -06:00
|
|
|
let index = tcx.stability.borrow();
|
|
|
|
for (used_lib_feature, level) in &index.used_features {
|
2015-02-02 22:25:42 -06:00
|
|
|
match remaining_lib_features.remove(used_lib_feature) {
|
|
|
|
Some(span) => {
|
2016-05-30 15:55:12 -05:00
|
|
|
if let &attr::StabilityLevel::Stable { since: ref version } = level {
|
2015-02-02 22:25:42 -06:00
|
|
|
sess.add_lint(lint::builtin::STABLE_FEATURES,
|
|
|
|
ast::CRATE_NODE_ID,
|
|
|
|
span,
|
2016-11-16 04:52:37 -06:00
|
|
|
format_stable_since_msg(&version.as_str()));
|
2015-02-02 22:25:42 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
None => ( /* used but undeclared, handled during the previous ast visit */ )
|
|
|
|
}
|
2015-01-16 12:25:16 -06:00
|
|
|
}
|
|
|
|
|
2015-06-10 11:22:20 -05:00
|
|
|
for &span in remaining_lib_features.values() {
|
2015-01-16 12:25:16 -06:00
|
|
|
sess.add_lint(lint::builtin::UNUSED_FEATURES,
|
|
|
|
ast::CRATE_NODE_ID,
|
|
|
|
span,
|
|
|
|
"unused or unknown feature".to_string());
|
|
|
|
}
|
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
|
|
|
}
|