diff options
| author | Nixon Enraght-Moony <nixon.emoony@gmail.com> | 2022-02-18 21:58:49 +0000 |
|---|---|---|
| committer | Nixon Enraght-Moony <nixon.emoony@gmail.com> | 2022-02-18 23:31:33 +0000 |
| commit | aa601574a5fe861bffd641beccf59c7be3ed16c9 (patch) | |
| tree | 82bf50fbe2a858a5649a90afad4ad84e9c8c5903 | |
| parent | b8c56fa8c30821129b0960180f528d4a1a4f9316 (diff) | |
| download | rust-aa601574a5fe861bffd641beccf59c7be3ed16c9.tar.gz rust-aa601574a5fe861bffd641beccf59c7be3ed16c9.zip | |
rustdoc-json: Better Header Type
- Make ABI an enum, instead of being stringly typed - Replace Qualifier HashSet with 3 bools - Merge ABI field into header, as they always occor together
| -rw-r--r-- | compiler/rustc_hir/src/hir.rs | 4 | ||||
| -rw-r--r-- | src/librustdoc/json/conversions.rs | 48 | ||||
| -rw-r--r-- | src/rustdoc-json-types/lib.rs | 43 |
3 files changed, 58 insertions, 37 deletions
diff --git a/compiler/rustc_hir/src/hir.rs b/compiler/rustc_hir/src/hir.rs index 0961d0131d0..5087bdd37e8 100644 --- a/compiler/rustc_hir/src/hir.rs +++ b/compiler/rustc_hir/src/hir.rs @@ -2777,6 +2777,10 @@ impl FnHeader { pub fn is_const(&self) -> bool { matches!(&self.constness, Constness::Const) } + + pub fn is_unsafe(&self) -> bool { + matches!(&self.unsafety, Unsafety::Unsafe) + } } #[derive(Debug, HashStable_Generic)] diff --git a/src/librustdoc/json/conversions.rs b/src/librustdoc/json/conversions.rs index e77bd5c9223..d4aedb41ddb 100644 --- a/src/librustdoc/json/conversions.rs +++ b/src/librustdoc/json/conversions.rs @@ -12,6 +12,7 @@ use rustc_hir::{def::CtorKind, def_id::DefId}; use rustc_middle::ty::{self, TyCtxt}; use rustc_span::def_id::CRATE_DEF_INDEX; use rustc_span::Pos; +use rustc_target::spec::abi::Abi as RustcAbi; use rustdoc_json_types::*; @@ -19,7 +20,6 @@ use crate::clean::utils::print_const_expr; use crate::clean::{self, ItemId}; use crate::formats::item_type::ItemType; use crate::json::JsonRenderer; -use std::collections::HashSet; impl JsonRenderer<'_> { pub(super) fn convert_item(&self, item: clean::Item) -> Option<Item> { @@ -271,22 +271,28 @@ crate fn from_ctor_kind(struct_type: CtorKind) -> StructType { } } -crate fn from_fn_header(header: &rustc_hir::FnHeader) -> HashSet<Qualifiers> { - let mut v = HashSet::new(); - - if let rustc_hir::Unsafety::Unsafe = header.unsafety { - v.insert(Qualifiers::Unsafe); - } - - if let rustc_hir::IsAsync::Async = header.asyncness { - v.insert(Qualifiers::Async); +crate fn from_fn_header(header: &rustc_hir::FnHeader) -> Header { + Header { + async_: header.is_async(), + const_: header.is_const(), + unsafe_: header.is_unsafe(), + abi: convert_abi(header.abi), } +} - if let rustc_hir::Constness::Const = header.constness { - v.insert(Qualifiers::Const); +fn convert_abi(a: RustcAbi) -> Abi { + match a { + RustcAbi::Rust => Abi::Rust, + RustcAbi::C { unwind } => Abi::C { unwind }, + RustcAbi::Cdecl { unwind } => Abi::Cdecl { unwind }, + RustcAbi::Stdcall { unwind } => Abi::Stdcall { unwind }, + RustcAbi::Fastcall { unwind } => Abi::Fastcall { unwind }, + RustcAbi::Aapcs { unwind } => Abi::Aapcs { unwind }, + RustcAbi::Win64 { unwind } => Abi::Win64 { unwind }, + RustcAbi::SysV64 { unwind } => Abi::SysV64 { unwind }, + RustcAbi::System { unwind } => Abi::System { unwind }, + _ => Abi::Other(a.to_string()), } - - v } impl FromWithTcx<clean::Function> for Function { @@ -296,7 +302,6 @@ impl FromWithTcx<clean::Function> for Function { decl: decl.into_tcx(tcx), generics: generics.into_tcx(tcx), header: from_fn_header(&header), - abi: header.abi.to_string(), } } } @@ -465,16 +470,14 @@ impl FromWithTcx<clean::BareFunctionDecl> for FunctionPointer { fn from_tcx(bare_decl: clean::BareFunctionDecl, tcx: TyCtxt<'_>) -> Self { let clean::BareFunctionDecl { unsafety, generic_params, decl, abi } = bare_decl; FunctionPointer { - header: if let rustc_hir::Unsafety::Unsafe = unsafety { - let mut hs = HashSet::new(); - hs.insert(Qualifiers::Unsafe); - hs - } else { - HashSet::new() + header: Header { + unsafe_: matches!(unsafety, rustc_hir::Unsafety::Unsafe), + const_: false, + async_: false, + abi: convert_abi(abi), }, generic_params: generic_params.into_iter().map(|x| x.into_tcx(tcx)).collect(), decl: decl.into_tcx(tcx), - abi: abi.to_string(), } } } @@ -554,7 +557,6 @@ crate fn from_function_method( decl: decl.into_tcx(tcx), generics: generics.into_tcx(tcx), header: from_fn_header(&header), - abi: header.abi.to_string(), has_body, } } diff --git a/src/rustdoc-json-types/lib.rs b/src/rustdoc-json-types/lib.rs index 600833664be..be9bbc7391d 100644 --- a/src/rustdoc-json-types/lib.rs +++ b/src/rustdoc-json-types/lib.rs @@ -3,13 +3,13 @@ //! 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. -use std::collections::{HashMap, HashSet}; +use std::collections::HashMap; use std::path::PathBuf; use serde::{Deserialize, Serialize}; /// rustdoc format-version. -pub const FORMAT_VERSION: u32 = 10; +pub const FORMAT_VERSION: u32 = 11; /// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information /// about the language items in the local crate, as well as info about external items to allow @@ -287,29 +287,45 @@ pub enum StructType { Unit, } -#[non_exhaustive] #[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Hash)] -#[serde(rename_all = "snake_case")] -pub enum Qualifiers { - Const, - Unsafe, - Async, +pub struct Header { + #[serde(rename = "const")] + pub const_: bool, + #[serde(rename = "unsafe")] + pub unsafe_: bool, + #[serde(rename = "async")] + pub async_: bool, + pub abi: Abi, +} + +#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Hash)] +pub enum Abi { + // We only have a concrete listing here for stable ABI's because their are so many + // See rustc_ast_passes::feature_gate::PostExpansionVisitor::check_abi for the list + Rust, + C { unwind: bool }, + Cdecl { unwind: bool }, + Stdcall { unwind: bool }, + Fastcall { unwind: bool }, + Aapcs { unwind: bool }, + Win64 { unwind: bool }, + SysV64 { unwind: bool }, + System { unwind: bool }, + Other(String), } #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)] pub struct Function { pub decl: FnDecl, pub generics: Generics, - pub header: HashSet<Qualifiers>, - pub abi: String, + pub header: Header, } #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)] pub struct Method { pub decl: FnDecl, pub generics: Generics, - pub header: HashSet<Qualifiers>, - pub abi: String, + pub header: Header, pub has_body: bool, } @@ -426,8 +442,7 @@ pub enum Type { pub struct FunctionPointer { pub decl: FnDecl, pub generic_params: Vec<GenericParamDef>, - pub header: HashSet<Qualifiers>, - pub abi: String, + pub header: Header, } #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)] |
