bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Split JSON into separately versioned crate

Browse source
This commit is contained in:
Rune Tynan 2021-01-22 16:09:24 -05:00
parent a2f8f62818
commit c689b97fba
No known key found for this signature in database
GPG key ID: 7ECC932F8B2C731E
6 changed files with 72 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

1
Cargo.toml
View file

@ -4,6 +4,7 @@ members = [
"compiler/rustc", "compiler/rustc",
"library/std", "library/std",
"library/test", "library/test",
"src/librustdoc/json-types",
"src/tools/cargotest", "src/tools/cargotest",
"src/tools/clippy", "src/tools/clippy",
"src/tools/compiletest", "src/tools/compiletest",

1
src/librustdoc/Cargo.toml
View file

@ -17,6 +17,7 @@ smallvec = "1.0"
tempfile = "3" tempfile = "3"
itertools = "0.9" itertools = "0.9"
regex = "1" regex = "1"
json-types = { path = "./json-types" }
[dev-dependencies] [dev-dependencies]
expect-test = "1.0" expect-test = "1.0"

11
src/librustdoc/json-types/Cargo.toml Normal file
View file

@ -0,0 +1,11 @@
[package]
name = "json-types"
version = "0.1.0"
authors = ["The Rust Project Developers"]
edition = "2018"
[lib]
path = "lib.rs"
[dependencies]
serde = { version = "1.0", features = ["derive"] }

10
src/librustdoc/json/types.rs → src/librustdoc/json-types/lib.rs
View file

@ -3,9 +3,9 @@
//! These types are the public API exposed through the `--output-format json` flag. The [`Crate`] //! These types are the public API exposed through the `--output-format json` flag. The [`Crate`]
//! struct is the root of the JSON blob and all other items are contained within. //! struct is the root of the JSON blob and all other items are contained within.
use std::collections::HashMap;
use std::path::PathBuf; use std::path::PathBuf;
use rustc_data_structures::fx::FxHashMap;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
/// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information /// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information
@ -21,11 +21,11 @@ pub struct Crate {
pub includes_private: bool, pub includes_private: bool,
/// A collection of all items in the local crate as well as some external traits and their /// A collection of all items in the local crate as well as some external traits and their
/// items that are referenced locally. /// items that are referenced locally.
pub index: FxHashMap<Id, Item>, pub index: HashMap<Id, Item>,
/// Maps IDs to fully qualified paths and other info helpful for generating links. /// Maps IDs to fully qualified paths and other info helpful for generating links.
pub paths: FxHashMap<Id, ItemSummary>, pub paths: HashMap<Id, ItemSummary>,
/// Maps `crate_id` of items to a crate name and html_root_url if it exists. /// Maps `crate_id` of items to a crate name and html_root_url if it exists.
pub external_crates: FxHashMap<u32, ExternalCrate>, pub external_crates: HashMap<u32, ExternalCrate>,
/// A single version number to be used in the future when making backwards incompatible changes /// A single version number to be used in the future when making backwards incompatible changes
/// to the JSON output. /// to the JSON output.
pub format_version: u32, pub format_version: u32,
@ -72,7 +72,7 @@ pub struct Item {
/// Some("") if there is some documentation but it is empty (EG `#[doc = ""]`). /// Some("") if there is some documentation but it is empty (EG `#[doc = ""]`).
pub docs: Option<String>, pub docs: Option<String>,
/// This mapping resolves [intra-doc links](https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md) from the docstring to their IDs /// This mapping resolves [intra-doc links](https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md) from the docstring to their IDs
pub links: FxHashMap<String, Id>, pub links: HashMap<String, Id>,
/// Stringified versions of the attributes on this item (e.g. `"#[inline]"`) /// Stringified versions of the attributes on this item (e.g. `"#[inline]"`)
pub attrs: Vec<String>, pub attrs: Vec<String>,
pub deprecation: Option<Deprecation>, pub deprecation: Option<Deprecation>,

83
src/librustdoc/json/conversions.rs
View file

@ -9,9 +9,10 @@ use rustc_hir::def::CtorKind;
use rustc_span::def_id::{DefId, CRATE_DEF_INDEX}; use rustc_span::def_id::{DefId, CRATE_DEF_INDEX};
use rustc_span::Pos; use rustc_span::Pos;
use json_types::*;
use crate::clean; use crate::clean;
use crate::formats::item_type::ItemType; use crate::formats::item_type::ItemType;
use crate::json::types::*;
use crate::json::JsonRenderer; use crate::json::JsonRenderer;
impl JsonRenderer<'_> { impl JsonRenderer<'_> {
@ -22,7 +23,7 @@ impl JsonRenderer<'_> {
match *kind { match *kind {
clean::StrippedItem(_) => None, clean::StrippedItem(_) => None,
kind => Some(Item { kind => Some(Item {
id: def_id.into(), id: from_def_id(def_id),
crate_id: def_id.krate.as_u32(), crate_id: def_id.krate.as_u32(),
name: name.map(|sym| sym.to_string()), name: name.map(|sym| sym.to_string()),
source: self.convert_span(source), source: self.convert_span(source),
@ -32,7 +33,7 @@ impl JsonRenderer<'_> {
.links .links
.into_iter() .into_iter()
.filter_map(|clean::ItemLink { link, did, .. }| { .filter_map(|clean::ItemLink { link, did, .. }| {
did.map(|did| (link, did.into())) did.map(|did| (link, from_def_id(did)))
}) })
.collect(), .collect(),
attrs: attrs attrs: attrs
@ -40,7 +41,7 @@ impl JsonRenderer<'_> {
.iter() .iter()
.map(rustc_ast_pretty::pprust::attribute_to_string) .map(rustc_ast_pretty::pprust::attribute_to_string)
.collect(), .collect(),
deprecation: deprecation.map(Into::into), deprecation: deprecation.map(from_deprecation),
kind: item_type.into(), kind: item_type.into(),
inner: kind.into(), inner: kind.into(),
}), }),
@ -74,19 +75,17 @@ impl JsonRenderer<'_> {
Inherited => Visibility::Default, Inherited => Visibility::Default,
Restricted(did) if did.index == CRATE_DEF_INDEX => Visibility::Crate, Restricted(did) if did.index == CRATE_DEF_INDEX => Visibility::Crate,
Restricted(did) => Visibility::Restricted { Restricted(did) => Visibility::Restricted {
parent: did.into(), parent: from_def_id(did),
path: self.tcx.def_path(did).to_string_no_crate_verbose(), path: self.tcx.def_path(did).to_string_no_crate_verbose(),
}, },
} }
} }
} }
impl From<rustc_attr::Deprecation> for Deprecation { crate fn from_deprecation(deprecation: rustc_attr::Deprecation) -> Deprecation {
fn from(deprecation: rustc_attr::Deprecation) -> Self { #[rustfmt::skip]
#[rustfmt::skip] let rustc_attr::Deprecation { since, note, is_since_rustc_version: _, suggestion: _ } = deprecation;
let rustc_attr::Deprecation { since, note, is_since_rustc_version: _, suggestion: _ } = deprecation; Deprecation { since: since.map(|s| s.to_string()), note: note.map(|s| s.to_string()) }
Deprecation { since: since.map(|s| s.to_string()), note: note.map(|s| s.to_string()) }
}
} }
impl From<clean::GenericArgs> for GenericArgs { impl From<clean::GenericArgs> for GenericArgs {
@ -141,10 +140,8 @@ impl From<clean::TypeBindingKind> for TypeBindingKind {
} }
} }
impl From<DefId> for Id { crate fn from_def_id(did: DefId) -> Id {
fn from(did: DefId) -> Self { Id(format!("{}:{}", did.krate.as_u32(), u32::from(did.index)))
Id(format!("{}:{}", did.krate.as_u32(), u32::from(did.index)))
}
} }
impl From<clean::ItemKind> for ItemEnum { impl From<clean::ItemKind> for ItemEnum {
@ -199,7 +196,7 @@ impl From<clean::Struct> for Struct {
fn from(struct_: clean::Struct) -> Self { fn from(struct_: clean::Struct) -> Self {
let clean::Struct { struct_type, generics, fields, fields_stripped } = struct_; let clean::Struct { struct_type, generics, fields, fields_stripped } = struct_;
Struct { Struct {
struct_type: struct_type.into(), struct_type: from_ctor_kind(struct_type),
generics: generics.into(), generics: generics.into(),
fields_stripped, fields_stripped,
fields: ids(fields), fields: ids(fields),
@ -221,13 +218,11 @@ impl From<clean::Union> for Struct {
} }
} }
impl From<CtorKind> for StructType { crate fn from_ctor_kind(struct_type: CtorKind) -> StructType {
fn from(struct_type: CtorKind) -> Self { match struct_type {
match struct_type { CtorKind::Fictive => StructType::Plain,
CtorKind::Fictive => StructType::Plain, CtorKind::Fn => StructType::Tuple,
CtorKind::Fn => StructType::Tuple, CtorKind::Const => StructType::Unit,
CtorKind::Const => StructType::Unit,
}
} }
} }
@ -310,7 +305,7 @@ impl From<clean::GenericBound> for GenericBound {
GenericBound::TraitBound { GenericBound::TraitBound {
trait_: trait_.into(), trait_: trait_.into(),
generic_params: generic_params.into_iter().map(Into::into).collect(), generic_params: generic_params.into_iter().map(Into::into).collect(),
modifier: modifier.into(), modifier: from_trait_bound_modifier(modifier),
} }
} }
Outlives(lifetime) => GenericBound::Outlives(lifetime.0.to_string()), Outlives(lifetime) => GenericBound::Outlives(lifetime.0.to_string()),
@ -318,14 +313,12 @@ impl From<clean::GenericBound> for GenericBound {
} }
} }
impl From<rustc_hir::TraitBoundModifier> for TraitBoundModifier { crate fn from_trait_bound_modifier(modifier: rustc_hir::TraitBoundModifier) -> TraitBoundModifier {
fn from(modifier: rustc_hir::TraitBoundModifier) -> Self { use rustc_hir::TraitBoundModifier::*;
use rustc_hir::TraitBoundModifier::*; match modifier {
match modifier { None => TraitBoundModifier::None,
None => TraitBoundModifier::None, Maybe => TraitBoundModifier::Maybe,
Maybe => TraitBoundModifier::Maybe, MaybeConst => TraitBoundModifier::MaybeConst,
MaybeConst => TraitBoundModifier::MaybeConst,
}
} }
} }
@ -335,7 +328,7 @@ impl From<clean::Type> for Type {
match ty { match ty {
ResolvedPath { path, param_names, did, is_generic: _ } => Type::ResolvedPath { ResolvedPath { path, param_names, did, is_generic: _ } => Type::ResolvedPath {
name: path.whole_name(), name: path.whole_name(),
id: did.into(), id: from_def_id(did),
args: path.segments.last().map(|args| Box::new(args.clone().args.into())), args: path.segments.last().map(|args| Box::new(args.clone().args.into())),
param_names: param_names param_names: param_names
.map(|v| v.into_iter().map(Into::into).collect()) .map(|v| v.into_iter().map(Into::into).collect())
@ -470,7 +463,7 @@ impl From<clean::VariantStruct> for Struct {
fn from(struct_: clean::VariantStruct) -> Self { fn from(struct_: clean::VariantStruct) -> Self {
let clean::VariantStruct { struct_type, fields, fields_stripped } = struct_; let clean::VariantStruct { struct_type, fields, fields_stripped } = struct_;
Struct { Struct {
struct_type: struct_type.into(), struct_type: from_ctor_kind(struct_type),
generics: Default::default(), generics: Default::default(),
fields_stripped, fields_stripped,
fields: ids(fields), fields: ids(fields),
@ -497,13 +490,13 @@ impl From<clean::Import> for Import {
Simple(s) => Import { Simple(s) => Import {
span: import.source.path.whole_name(), span: import.source.path.whole_name(),
name: s.to_string(), name: s.to_string(),
id: import.source.did.map(Into::into), id: import.source.did.map(from_def_id),
glob: false, glob: false,
}, },
Glob => Import { Glob => Import {
span: import.source.path.whole_name(), span: import.source.path.whole_name(),
name: import.source.path.last_name().to_string(), name: import.source.path.last_name().to_string(),
id: import.source.did.map(Into::into), id: import.source.did.map(from_def_id),
glob: true, glob: true,
}, },
} }
@ -513,20 +506,18 @@ impl From<clean::Import> for Import {
impl From<clean::ProcMacro> for ProcMacro { impl From<clean::ProcMacro> for ProcMacro {
fn from(mac: clean::ProcMacro) -> Self { fn from(mac: clean::ProcMacro) -> Self {
ProcMacro { ProcMacro {
kind: mac.kind.into(), kind: from_macro_kind(mac.kind),
helpers: mac.helpers.iter().map(|x| x.to_string()).collect(), helpers: mac.helpers.iter().map(|x| x.to_string()).collect(),
} }
} }
} }
impl From<rustc_span::hygiene::MacroKind> for MacroKind { crate fn from_macro_kind(kind: rustc_span::hygiene::MacroKind) -> MacroKind {
fn from(kind: rustc_span::hygiene::MacroKind) -> Self { use rustc_span::hygiene::MacroKind::*;
use rustc_span::hygiene::MacroKind::*; match kind {
match kind { Bang => MacroKind::Bang,
Bang => MacroKind::Bang, Attr => MacroKind::Attr,
Attr => MacroKind::Attr, Derive => MacroKind::Derive,
Derive => MacroKind::Derive,
}
} }
} }
@ -599,5 +590,5 @@ impl From<ItemType> for ItemKind {
} }
fn ids(items: impl IntoIterator<Item = clean::Item>) -> Vec<Id> { fn ids(items: impl IntoIterator<Item = clean::Item>) -> Vec<Id> {
items.into_iter().filter(|x| !x.is_stripped()).map(|i| i.def_id.into()).collect() items.into_iter().filter(|x| !x.is_stripped()).map(|i| from_def_id(i.def_id)).collect()
} }

25
src/librustdoc/json/mod.rs
View file

@ -5,7 +5,6 @@
//! docs for usage and details. //! docs for usage and details.
mod conversions; mod conversions;
pub mod types;
use std::cell::RefCell; use std::cell::RefCell;
use std::fs::File; use std::fs::File;
@ -17,12 +16,15 @@ use rustc_middle::ty::TyCtxt;
use rustc_session::Session; use rustc_session::Session;
use rustc_span::edition::Edition; use rustc_span::edition::Edition;
use json_types as types;
use crate::clean; use crate::clean;
use crate::config::{RenderInfo, RenderOptions}; use crate::config::{RenderInfo, RenderOptions};
use crate::error::Error; use crate::error::Error;
use crate::formats::cache::Cache; use crate::formats::cache::Cache;
use crate::formats::FormatRenderer; use crate::formats::FormatRenderer;
use crate::html::render::cache::ExternalLocation; use crate::html::render::cache::ExternalLocation;
use crate::json::conversions::from_def_id;
#[derive(Clone)] #[derive(Clone)]
crate struct JsonRenderer<'tcx> { crate struct JsonRenderer<'tcx> {
@ -50,7 +52,7 @@ impl JsonRenderer<'_> {
.map(|i| { .map(|i| {
let item = &i.impl_item; let item = &i.impl_item;
self.item(item.clone()).unwrap(); self.item(item.clone()).unwrap();
item.def_id.into() from_def_id(item.def_id)
}) })
.collect() .collect()
}) })
@ -68,7 +70,7 @@ impl JsonRenderer<'_> {
let item = &i.impl_item; let item = &i.impl_item;
if item.def_id.is_local() { if item.def_id.is_local() {
self.item(item.clone()).unwrap(); self.item(item.clone()).unwrap();
Some(item.def_id.into()) Some(from_def_id(item.def_id))
} else { } else {
None None
} }
@ -87,9 +89,9 @@ impl JsonRenderer<'_> {
if !id.is_local() { if !id.is_local() {
trait_item.items.clone().into_iter().for_each(|i| self.item(i).unwrap()); trait_item.items.clone().into_iter().for_each(|i| self.item(i).unwrap());
Some(( Some((
id.into(), from_def_id(id),
types::Item { types::Item {
id: id.into(), id: from_def_id(id),
crate_id: id.krate.as_u32(), crate_id: id.krate.as_u32(),
name: self name: self
.cache .cache
@ -163,7 +165,7 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
} else if let types::ItemEnum::EnumItem(ref mut e) = new_item.inner { } else if let types::ItemEnum::EnumItem(ref mut e) = new_item.inner {
e.impls = self.get_impls(id) e.impls = self.get_impls(id)
} }
let removed = self.index.borrow_mut().insert(id.into(), new_item.clone()); let removed = self.index.borrow_mut().insert(from_def_id(id), new_item.clone());
// FIXME(adotinthevoid): Currently, the index is duplicated. This is a sanity check // FIXME(adotinthevoid): Currently, the index is duplicated. This is a sanity check
// to make sure the items are unique. // to make sure the items are unique.
if let Some(old_item) = removed { if let Some(old_item) = removed {
@ -203,11 +205,18 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
debug!("Done with crate"); debug!("Done with crate");
let mut index = (*self.index).clone().into_inner(); let mut index = (*self.index).clone().into_inner();
index.extend(self.get_trait_items()); index.extend(self.get_trait_items());
let len = index.len();
let output = types::Crate { let output = types::Crate {
root: types::Id(String::from("0:0")), root: types::Id(String::from("0:0")),
crate_version: krate.version.clone(), crate_version: krate.version.clone(),
includes_private: self.cache.document_private, includes_private: self.cache.document_private,
index, index: index.into_iter().fold(
std::collections::HashMap::with_capacity(len),
|mut acc, (key, val)| {
acc.insert(key, val);
acc
},
),
paths: self paths: self
.cache .cache
.paths .paths
@ -216,7 +225,7 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
.chain(self.cache.external_paths.clone().into_iter()) .chain(self.cache.external_paths.clone().into_iter())
.map(|(k, (path, kind))| { .map(|(k, (path, kind))| {
( (
k.into(), from_def_id(k),
types::ItemSummary { crate_id: k.krate.as_u32(), path, kind: kind.into() }, types::ItemSummary { crate_id: k.krate.as_u32(), path, kind: kind.into() },
) )
}) })