mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move StructType to clean, remove it from Unions, make JSON output whether something is a union

Browse Source
This commit is contained in:
Rune Tynan 2021-01-20 16:46:34 -05:00
parent a4cbb44ae2
commit 450c5eae1d
No known key found for this signature in database
GPG Key ID: 7ECC932F8B2C731E
7 changed files with 40 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/librustdoc/clean/inline.rs
View File

@ -15,9 +15,8 @@
use rustc_span::symbol::{kw, sym, Symbol};
use rustc_span::Span;
use crate::clean::{self, Attributes, GetDefId, ToSource, TypeKind};
use crate::clean::{self, Attributes, GetDefId, ToSource, TypeKind, StructType};
use crate::core::DocContext;
use crate::doctree;
use super::Clean;
@ -247,9 +246,9 @@ fn build_struct(cx: &DocContext<'_>, did: DefId) -> clean::Struct {
clean::Struct {
struct_type: match variant.ctor_kind {
CtorKind::Fictive => doctree::Plain,
CtorKind::Fn => doctree::Tuple,
CtorKind::Const => doctree::Unit,
CtorKind::Fictive => StructType::Plain,
CtorKind::Fn => StructType::Tuple,
CtorKind::Const => StructType::Unit,
},
generics: (cx.tcx.generics_of(did), predicates).clean(cx),
fields: variant.fields.clean(cx),
@ -262,7 +261,6 @@ fn build_union(cx: &DocContext<'_>, did: DefId) -> clean::Union {
let variant = cx.tcx.adt_def(did).non_enum_variant();
clean::Union {
struct_type: doctree::Plain,
generics: (cx.tcx.generics_of(did), predicates).clean(cx),
fields: variant.fields.clean(cx),
fields_stripped: false,

16
src/librustdoc/clean/mod.rs
View File

@ -1824,10 +1824,19 @@ fn clean(&self, _cx: &DocContext<'_>) -> Visibility {
}
}
crate fn struct_type_from_def(vdata: &hir::VariantData<'_>) -> StructType {
use StructType::*;
match *vdata {
hir::VariantData::Struct(..) => Plain,
hir::VariantData::Tuple(..) => Tuple,
hir::VariantData::Unit(..) => Unit,
}
}
impl Clean<VariantStruct> for rustc_hir::VariantData<'_> {
fn clean(&self, cx: &DocContext<'_>) -> VariantStruct {
VariantStruct {
struct_type: doctree::struct_type_from_def(self),
struct_type: struct_type_from_def(self),
fields: self.fields().iter().map(|x| x.clean(cx)).collect(),
fields_stripped: false,
}
@ -1842,7 +1851,7 @@ fn clean(&self, cx: &DocContext<'_>) -> Item {
self.fields.iter().map(|f| cx.tcx.type_of(f.did).clean(cx)).collect(),
),
CtorKind::Fictive => Variant::Struct(VariantStruct {
struct_type: doctree::Plain,
struct_type: StructType::Plain,
fields_stripped: false,
fields: self
.fields
@ -1996,13 +2005,12 @@ fn clean(&self, cx: &DocContext<'_>) -> Vec<Item> {
bounds: bounds.clean(cx),
}),
ItemKind::Union(ref variant_data, ref generics) => UnionItem(Union {
struct_type: doctree::struct_type_from_def(&variant_data),
generics: generics.clean(cx),
fields: variant_data.fields().clean(cx),
fields_stripped: false,
}),
ItemKind::Struct(ref variant_data, ref generics) => StructItem(Struct {
struct_type: doctree::struct_type_from_def(&variant_data),
struct_type: struct_type_from_def(&variant_data),
generics: generics.clean(cx),
fields: variant_data.fields().clean(cx),
fields_stripped: false,

16
src/librustdoc/clean/types.rs
View File

@ -37,7 +37,6 @@
use crate::clean::types::Type::{QPath, ResolvedPath};
use crate::clean::Clean;
use crate::core::DocContext;
use crate::doctree;
use crate::formats::cache::cache;
use crate::formats::item_type::ItemType;
use crate::html::render::cache::ExternalLocation;
@ -1683,9 +1682,19 @@ impl Visibility {
}
}
#[derive(Debug, Clone, Copy)]
crate enum StructType {
/// A braced struct
Plain,
/// A tuple struct
Tuple,
/// A unit struct
Unit,
}
#[derive(Clone, Debug)]
crate struct Struct {
crate struct_type: doctree::StructType,
crate struct_type: StructType,
crate generics: Generics,
crate fields: Vec<Item>,
crate fields_stripped: bool,
@ -1693,7 +1702,6 @@ impl Visibility {
#[derive(Clone, Debug)]
crate struct Union {
crate struct_type: doctree::StructType,
crate generics: Generics,
crate fields: Vec<Item>,
crate fields_stripped: bool,
@ -1704,7 +1712,7 @@ impl Visibility {
/// only as a variant in an enum.
#[derive(Clone, Debug)]
crate struct VariantStruct {
crate struct_type: doctree::StructType,
crate struct_type: StructType,
crate fields: Vec<Item>,
crate fields_stripped: bool,
}

20
src/librustdoc/doctree.rs
View File

@ -1,7 +1,5 @@
//! This module is used to store stuff from Rust's AST in a more convenient
//! manner (and with prettier names) before cleaning.
crate use self::StructType::*;
use rustc_span::{self, Span, Symbol};
use rustc_hir as hir;
@ -34,21 +32,3 @@ impl Module<'hir> {
}
}
}
#[derive(Debug, Clone, Copy)]
crate enum StructType {
/// A braced struct
Plain,
/// A tuple struct
Tuple,
/// A unit struct
Unit,
}
crate fn struct_type_from_def(vdata: &hir::VariantData<'_>) -> StructType {
match *vdata {
hir::VariantData::Struct(..) => Plain,
hir::VariantData::Tuple(..) => Tuple,
hir::VariantData::Unit(..) => Unit,
}
}

13
src/librustdoc/html/render/mod.rs
View File

@ -68,7 +68,6 @@
use crate::clean::{self, AttributesExt, GetDefId, RenderedLink, SelfTy, TypeKind};
use crate::config::{RenderInfo, RenderOptions};
use crate::docfs::{DocFS, PathError};
use crate::doctree;
use crate::error::Error;
use crate::formats::cache::{cache, Cache};
use crate::formats::item_type::ItemType;
@ -3101,7 +3100,7 @@ fn item_struct(
_ => None,
})
.peekable();
if let doctree::Plain = s.struct_type {
if let clean::StructType::Plain = s.struct_type {
if fields.peek().is_some() {
write!(
w,
@ -3351,7 +3350,7 @@ fn render_struct(
w: &mut Buffer,
it: &clean::Item,
g: Option<&clean::Generics>,
ty: doctree::StructType,
ty: clean::StructType,
fields: &[clean::Item],
tab: &str,
structhead: bool,
@ -3368,7 +3367,7 @@ fn render_struct(
write!(w, "{}", g.print())
}
match ty {
doctree::Plain => {
clean::StructType::Plain => {
if let Some(g) = g {
write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })
}
@ -3400,7 +3399,7 @@ fn render_struct(
}
write!(w, "}}");
}
doctree::Tuple => {
clean::StructType::Tuple => {
write!(w, "(");
for (i, field) in fields.iter().enumerate() {
if i > 0 {
@ -3425,7 +3424,7 @@ fn render_struct(
}
write!(w, ";");
}
doctree::Unit => {
clean::StructType::Unit => {
// Needed for PhantomData.
if let Some(g) = g {
write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })
@ -4460,7 +4459,7 @@ fn sidebar_struct(cx: &Context<'_>, buf: &mut Buffer, it: &clean::Item, s: &clea
let fields = get_struct_fields_name(&s.fields);
if !fields.is_empty() {
if let doctree::Plain = s.struct_type {
if let clean::StructType::Plain = s.struct_type {
sidebar.push_str(&format!(
"<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
<div class=\"sidebar-links\">{}</div>",

11
src/librustdoc/json/conversions.rs
View File

@ -9,7 +9,6 @@
use rustc_span::Pos;
use crate::clean;
use crate::doctree;
use crate::formats::item_type::ItemType;
use crate::json::types::*;
use crate::json::JsonRenderer;
@ -210,9 +209,9 @@ fn from(struct_: clean::Struct) -> Self {
impl From<clean::Union> for Struct {
fn from(struct_: clean::Union) -> Self {
let clean::Union { struct_type, generics, fields, fields_stripped } = struct_;
let clean::Union { generics, fields, fields_stripped } = struct_;
Struct {
struct_type: struct_type.into(),
struct_type: StructType::Union,
generics: generics.into(),
fields_stripped,
fields: ids(fields),
@ -221,9 +220,9 @@ fn from(struct_: clean::Union) -> Self {
}
}
impl From<doctree::StructType> for StructType {
fn from(struct_type: doctree::StructType) -> Self {
use doctree::StructType::*;
impl From<clean::StructType> for StructType {
fn from(struct_type: clean::StructType) -> Self {
use clean::StructType::*;
match struct_type {
Plain => StructType::Plain,
Tuple => StructType::Tuple,

1
src/librustdoc/json/types.rs
View File

@ -269,6 +269,7 @@ pub enum StructType {
Plain,
Tuple,
Unit,
Union,
}
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]