rustdoc: Cleanup ABI rendering
Use a common method for rendering `extern "<abi>"`. This now consistently shows `extern "C" fn` rather than just `extern fn`.
This commit is contained in:
parent
887e947178
commit
2b1e35ec12
7 changed files with 48 additions and 21 deletions
|
|
@ -1721,7 +1721,7 @@ impl<'tcx> Clean<Type> for ty::Ty<'tcx> {
|
|||
where_predicates: Vec::new()
|
||||
},
|
||||
decl: (cx.map.local_def_id(0), &fty.sig).clean(cx),
|
||||
abi: fty.abi.to_string(),
|
||||
abi: fty.abi,
|
||||
}),
|
||||
ty::TyStruct(def, substs) |
|
||||
ty::TyEnum(def, substs) => {
|
||||
|
|
@ -2143,7 +2143,7 @@ pub struct BareFunctionDecl {
|
|||
pub unsafety: hir::Unsafety,
|
||||
pub generics: Generics,
|
||||
pub decl: FnDecl,
|
||||
pub abi: String,
|
||||
pub abi: Abi,
|
||||
}
|
||||
|
||||
impl Clean<BareFunctionDecl> for hir::BareFnTy {
|
||||
|
|
@ -2156,7 +2156,7 @@ impl Clean<BareFunctionDecl> for hir::BareFnTy {
|
|||
where_predicates: Vec::new()
|
||||
},
|
||||
decl: self.decl.clean(cx),
|
||||
abi: self.abi.to_string(),
|
||||
abi: self.abi,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -451,11 +451,7 @@ impl fmt::Display for clean::Type {
|
|||
clean::BareFunction(ref decl) => {
|
||||
write!(f, "{}{}fn{}{}",
|
||||
UnsafetySpace(decl.unsafety),
|
||||
match &*decl.abi {
|
||||
"" => " extern ".to_string(),
|
||||
"\"Rust\"" => "".to_string(),
|
||||
s => format!(" extern {} ", s)
|
||||
},
|
||||
AbiSpace(decl.abi),
|
||||
decl.generics,
|
||||
decl.decl)
|
||||
}
|
||||
|
|
@ -770,8 +766,7 @@ impl fmt::Display for AbiSpace {
|
|||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
match self.0 {
|
||||
Abi::Rust => Ok(()),
|
||||
Abi::C => write!(f, "extern "),
|
||||
abi => write!(f, "extern {} ", abi),
|
||||
abi => write!(f, "extern "{}" ", abi.name()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2129,8 +2129,6 @@ fn render_assoc_item(w: &mut fmt::Formatter,
|
|||
d: &clean::FnDecl,
|
||||
link: AssocItemLink)
|
||||
-> fmt::Result {
|
||||
use syntax::abi::Abi;
|
||||
|
||||
let name = meth.name.as_ref().unwrap();
|
||||
let anchor = format!("#{}.{}", shortty(meth), name);
|
||||
let href = match link {
|
||||
|
|
@ -2157,10 +2155,7 @@ fn render_assoc_item(w: &mut fmt::Formatter,
|
|||
{generics}{decl}{where_clause}",
|
||||
ConstnessSpace(vis_constness),
|
||||
UnsafetySpace(unsafety),
|
||||
match abi {
|
||||
Abi::Rust => String::new(),
|
||||
a => format!("extern {} ", a.to_string())
|
||||
},
|
||||
AbiSpace(abi),
|
||||
href = href,
|
||||
name = name,
|
||||
generics = *g,
|
||||
|
|
|
|||
37
src/test/rustdoc/extern-impl.rs
Normal file
37
src/test/rustdoc/extern-impl.rs
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
// Copyright 2016 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.
|
||||
|
||||
#![crate_name = "foo"]
|
||||
|
||||
// @has foo/struct.Foo.html
|
||||
pub struct Foo;
|
||||
|
||||
impl Foo {
|
||||
// @has - '//code' 'fn rust0()'
|
||||
pub fn rust0() {}
|
||||
// @has - '//code' 'fn rust1()'
|
||||
pub extern "Rust" fn rust1() {}
|
||||
// @has - '//code' 'extern "C" fn c0()'
|
||||
pub extern fn c0() {}
|
||||
// @has - '//code' 'extern "C" fn c1()'
|
||||
pub extern "C" fn c1() {}
|
||||
// @has - '//code' 'extern "system" fn system0()'
|
||||
pub extern "system" fn system0() {}
|
||||
}
|
||||
|
||||
// @has foo/trait.Bar.html
|
||||
pub trait Bar {}
|
||||
|
||||
// @has - '//code' 'impl Bar for fn()'
|
||||
impl Bar for fn() {}
|
||||
// @has - '//code' 'impl Bar for extern "C" fn()'
|
||||
impl Bar for extern fn() {}
|
||||
// @has - '//code' 'impl Bar for extern "system" fn()'
|
||||
impl Bar for extern "system" fn() {}
|
||||
|
|
@ -13,10 +13,10 @@
|
|||
|
||||
extern crate rustdoc_ffi as lib;
|
||||
|
||||
// @has ffi/fn.foreigner.html //pre 'pub unsafe extern fn foreigner(cold_as_ice: u32)'
|
||||
// @has ffi/fn.foreigner.html //pre 'pub unsafe extern "C" fn foreigner(cold_as_ice: u32)'
|
||||
pub use lib::foreigner;
|
||||
|
||||
extern "C" {
|
||||
// @has ffi/fn.another.html //pre 'pub unsafe extern fn another(cold_as_ice: u32)'
|
||||
// @has ffi/fn.another.html //pre 'pub unsafe extern "C" fn another(cold_as_ice: u32)'
|
||||
pub fn another(cold_as_ice: u32);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
|
||||
extern {
|
||||
// @has issue_22038/fn.foo1.html \
|
||||
// '//*[@class="rust fn"]' 'pub unsafe extern fn foo1()'
|
||||
// '//*[@class="rust fn"]' 'pub unsafe extern "C" fn foo1()'
|
||||
pub fn foo1();
|
||||
}
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ extern "system" {
|
|||
}
|
||||
|
||||
// @has issue_22038/fn.bar.html \
|
||||
// '//*[@class="rust fn"]' 'pub extern fn bar()'
|
||||
// '//*[@class="rust fn"]' 'pub extern "C" fn bar()'
|
||||
pub extern fn bar() {}
|
||||
|
||||
// @has issue_22038/fn.baz.html \
|
||||
|
|
|
|||
|
|
@ -9,6 +9,6 @@
|
|||
// except according to those terms.
|
||||
|
||||
extern "C" {
|
||||
// @has variadic/fn.foo.html //pre 'pub unsafe extern fn foo(x: i32, ...)'
|
||||
// @has variadic/fn.foo.html //pre 'pub unsafe extern "C" fn foo(x: i32, ...)'
|
||||
pub fn foo(x: i32, ...);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue