Skip to content

Commit

Permalink
rustdoc: Correctly name lifetimes in bounds
Browse files Browse the repository at this point in the history
Fix #16518
  • Loading branch information
tomjakubowski committed Oct 6, 2014
1 parent dfbe9eb commit 2f955c7
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 13 deletions.
4 changes: 3 additions & 1 deletion src/librustdoc/clean/inline.rs
Expand Up @@ -324,7 +324,9 @@ fn build_impl(cx: &DocContext, tcx: &ty::ctxt,
trait_: associated_trait.clean(cx).map(|bound| {
match bound {
clean::TraitBound(ty) => ty,
clean::RegionBound => unreachable!(),
clean::UnboxedFnBound => unimplemented!(),
clean::RegionBound(..) |
clean::UnknownBound => unreachable!(),
}
}),
for_: ty.ty.clean(cx),
Expand Down
25 changes: 16 additions & 9 deletions src/librustdoc/clean/mod.rs
Expand Up @@ -473,26 +473,29 @@ impl Clean<TyParam> for ty::TypeParameterDef {

#[deriving(Clone, Encodable, Decodable, PartialEq)]
pub enum TyParamBound {
RegionBound, // FIXME(#16518) -- need to include name of actual region
RegionBound(Lifetime),
UnboxedFnBound, // FIXME
UnknownBound,
TraitBound(Type)
}

impl Clean<TyParamBound> for ast::TyParamBound {
fn clean(&self, cx: &DocContext) -> TyParamBound {
match *self {
ast::RegionTyParamBound(_) => RegionBound,
ast::RegionTyParamBound(lt) => RegionBound(lt.clean(cx)),
ast::UnboxedFnTyParamBound(_) => {
// FIXME(pcwalton): Wrong.
RegionBound
}
UnboxedFnBound
},
ast::TraitTyParamBound(ref t) => TraitBound(t.clean(cx)),
}
}
}

impl Clean<Vec<TyParamBound>> for ty::ExistentialBounds {
fn clean(&self, cx: &DocContext) -> Vec<TyParamBound> {
let mut vec = vec!(RegionBound);
let mut vec = vec![];
self.region_bound.clean(cx).map(|b| vec.push(RegionBound(b)));
for bb in self.builtin_bounds.iter() {
vec.push(bb.clean(cx));
}
Expand Down Expand Up @@ -521,7 +524,7 @@ impl Clean<TyParamBound> for ty::BuiltinBound {
fn clean(&self, cx: &DocContext) -> TyParamBound {
let tcx = match cx.tcx_opt() {
Some(tcx) => tcx,
None => return RegionBound,
None => return UnknownBound
};
let empty = subst::Substs::empty();
let (did, path) = match *self {
Expand Down Expand Up @@ -554,7 +557,7 @@ impl Clean<TyParamBound> for ty::TraitRef {
fn clean(&self, cx: &DocContext) -> TyParamBound {
let tcx = match cx.tcx_opt() {
Some(tcx) => tcx,
None => return RegionBound,
None => return UnknownBound
};
let fqn = csearch::get_item_path(tcx, self.def_id);
let fqn = fqn.into_iter().map(|i| i.to_string())
Expand Down Expand Up @@ -589,7 +592,7 @@ impl Clean<Vec<TyParamBound>> for ty::ParamBounds {
impl Clean<Option<Vec<TyParamBound>>> for subst::Substs {
fn clean(&self, cx: &DocContext) -> Option<Vec<TyParamBound>> {
let mut v = Vec::new();
v.extend(self.regions().iter().map(|_| RegionBound));
v.extend(self.regions().iter().filter_map(|r| r.clean(cx)).map(RegionBound));
v.extend(self.types.iter().map(|t| TraitBound(t.clean(cx))));
if v.len() > 0 {Some(v)} else {None}
}
Expand All @@ -604,6 +607,10 @@ impl Lifetime {
let s: &'a str = s.as_slice();
return s;
}

pub fn statik() -> Lifetime {
Lifetime("'static".to_string())
}
}

impl Clean<Lifetime> for ast::Lifetime {
Expand All @@ -627,7 +634,7 @@ impl Clean<Lifetime> for ty::RegionParameterDef {
impl Clean<Option<Lifetime>> for ty::Region {
fn clean(&self, cx: &DocContext) -> Option<Lifetime> {
match *self {
ty::ReStatic => Some(Lifetime("'static".to_string())),
ty::ReStatic => Some(Lifetime::statik()),
ty::ReLateBound(_, ty::BrNamed(_, name)) =>
Some(Lifetime(token::get_name(name).get().to_string())),
ty::ReEarlyBound(_, _, _, name) => Some(Lifetime(name.clean(cx))),
Expand Down
14 changes: 11 additions & 3 deletions src/librustdoc/html/format.rs
Expand Up @@ -140,8 +140,14 @@ impl fmt::Show for clean::Lifetime {
impl fmt::Show for clean::TyParamBound {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
clean::RegionBound => {
f.write("'static".as_bytes())
clean::RegionBound(ref lt) => {
write!(f, "{}", *lt)
}
clean::UnboxedFnBound(..) => {
write!(f, "Fn(???)") // FIXME
}
clean::UnknownBound => {
write!(f, "'static")
}
clean::TraitBound(ref ty) => {
write!(f, "{}", *ty)
Expand Down Expand Up @@ -401,7 +407,9 @@ impl fmt::Show for clean::Type {
let mut ret = String::new();
for bound in decl.bounds.iter() {
match *bound {
clean::RegionBound => {}
clean::RegionBound(..) |
clean::UnboxedFnBound |
clean::UnknownBound => {}
clean::TraitBound(ref t) => {
if ret.len() == 0 {
ret.push_str(": ");
Expand Down

0 comments on commit 2f955c7

Please sign in to comment.