1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! This module contains the "cleaned" pieces of the AST, and the functions
14 pub use self::ImplMethod::*;
15 pub use self::Type::*;
16 pub use self::PrimitiveType::*;
17 pub use self::TypeKind::*;
18 pub use self::StructField::*;
19 pub use self::VariantKind::*;
20 pub use self::Mutability::*;
21 pub use self::ViewItemInner::*;
22 pub use self::ViewPath::*;
23 pub use self::ItemEnum::*;
24 pub use self::Attribute::*;
25 pub use self::TyParamBound::*;
26 pub use self::SelfTy::*;
27 pub use self::FunctionRetTy::*;
28 pub use self::TraitMethod::*;
33 use syntax::ast_util::PostExpansionMethod;
35 use syntax::attr::{AttributeMethods, AttrMetaMethods};
36 use syntax::codemap::{DUMMY_SP, Pos, Spanned};
37 use syntax::parse::token::{self, InternedString, special_idents};
40 use rustc_trans::back::link;
41 use rustc::metadata::cstore;
42 use rustc::metadata::csearch;
43 use rustc::metadata::decoder;
44 use rustc::middle::def;
45 use rustc::middle::subst::{self, ParamSpace, VecPerParamSpace};
46 use rustc::middle::ty;
47 use rustc::middle::stability;
48 use rustc::session::config;
52 use std::str::Str as StrTrait; // Conflicts with Str variant
53 use std::path::Path as FsPath; // Conflicts with Path struct
59 /// A stable identifier to the particular version of JSON output.
60 /// Increment this when the `Crate` and related structures change.
61 pub static SCHEMA_VERSION: &'static str = "0.8.3";
65 // extract the stability index for a node from tcx, if possible
66 fn get_stability(cx: &DocContext, def_id: ast::DefId) -> Option<Stability> {
67 cx.tcx_opt().and_then(|tcx| stability::lookup(tcx, def_id)).clean(cx)
71 fn clean(&self, cx: &DocContext) -> T;
74 impl<T: Clean<U>, U> Clean<Vec<U>> for Vec<T> {
75 fn clean(&self, cx: &DocContext) -> Vec<U> {
76 self.iter().map(|x| x.clean(cx)).collect()
80 impl<T: Clean<U>, U> Clean<VecPerParamSpace<U>> for VecPerParamSpace<T> {
81 fn clean(&self, cx: &DocContext) -> VecPerParamSpace<U> {
82 self.map(|x| x.clean(cx))
86 impl<T: Clean<U>, U> Clean<U> for P<T> {
87 fn clean(&self, cx: &DocContext) -> U {
92 impl<T: Clean<U>, U> Clean<U> for Rc<T> {
93 fn clean(&self, cx: &DocContext) -> U {
98 impl<T: Clean<U>, U> Clean<Option<U>> for Option<T> {
99 fn clean(&self, cx: &DocContext) -> Option<U> {
102 &Some(ref v) => Some(v.clean(cx))
107 impl<T: Clean<U>, U> Clean<Vec<U>> for syntax::owned_slice::OwnedSlice<T> {
108 fn clean(&self, cx: &DocContext) -> Vec<U> {
109 self.iter().map(|x| x.clean(cx)).collect()
113 #[derive(Clone, RustcEncodable, RustcDecodable)]
117 pub module: Option<Item>,
118 pub externs: Vec<(ast::CrateNum, ExternalCrate)>,
119 pub primitives: Vec<PrimitiveType>,
122 impl<'a, 'tcx> Clean<Crate> for visit_ast::RustdocVisitor<'a, 'tcx> {
123 fn clean(&self, cx: &DocContext) -> Crate {
124 let mut externs = Vec::new();
125 cx.sess().cstore.iter_crate_data(|n, meta| {
126 externs.push((n, meta.clean(cx)));
128 externs.sort_by(|&(a, _), &(b, _)| a.cmp(&b));
130 // Figure out the name of this crate
131 let input = config::Input::File(cx.src.clone());
132 let name = link::find_crate_name(None, self.attrs.as_slice(), &input);
134 // Clean the crate, translating the entire libsyntax AST to one that is
135 // understood by rustdoc.
136 let mut module = self.module.clean(cx);
138 // Collect all inner modules which are tagged as implementations of
141 // Note that this loop only searches the top-level items of the crate,
142 // and this is intentional. If we were to search the entire crate for an
143 // item tagged with `#[doc(primitive)]` then we we would also have to
144 // search the entirety of external modules for items tagged
145 // `#[doc(primitive)]`, which is a pretty inefficient process (decoding
146 // all that metadata unconditionally).
148 // In order to keep the metadata load under control, the
149 // `#[doc(primitive)]` feature is explicitly designed to only allow the
150 // primitive tags to show up as the top level items in a crate.
152 // Also note that this does not attempt to deal with modules tagged
153 // duplicately for the same primitive. This is handled later on when
154 // rendering by delegating everything to a hash map.
155 let mut primitives = Vec::new();
157 let m = match module.inner {
158 ModuleItem(ref mut m) => m,
161 let mut tmp = Vec::new();
162 for child in m.items.iter_mut() {
167 let prim = match PrimitiveType::find(child.attrs.as_slice()) {
171 primitives.push(prim);
173 source: Span::empty(),
174 name: Some(prim.to_url_str().to_string()),
175 attrs: child.attrs.clone(),
176 visibility: Some(ast::Public),
178 def_id: ast_util::local_def(prim.to_node_id()),
179 inner: PrimitiveItem(prim),
182 m.items.extend(tmp.into_iter());
186 name: name.to_string(),
188 module: Some(module),
190 primitives: primitives,
195 #[derive(Clone, RustcEncodable, RustcDecodable)]
196 pub struct ExternalCrate {
198 pub attrs: Vec<Attribute>,
199 pub primitives: Vec<PrimitiveType>,
202 impl Clean<ExternalCrate> for cstore::crate_metadata {
203 fn clean(&self, cx: &DocContext) -> ExternalCrate {
204 let mut primitives = Vec::new();
205 cx.tcx_opt().map(|tcx| {
206 csearch::each_top_level_item_of_crate(&tcx.sess.cstore,
209 let did = match def {
210 decoder::DlDef(def::DefMod(did)) => did,
213 let attrs = inline::load_attrs(cx, tcx, did);
214 PrimitiveType::find(attrs.as_slice()).map(|prim| primitives.push(prim));
218 name: self.name.to_string(),
219 attrs: decoder::get_crate_attributes(self.data()).clean(cx),
220 primitives: primitives,
225 /// Anything with a source location and set of attributes and, optionally, a
226 /// name. That is, anything that can be documented. This doesn't correspond
227 /// directly to the AST's concept of an item; it's a strict superset.
228 #[derive(Clone, RustcEncodable, RustcDecodable)]
232 /// Not everything has a name. E.g., impls
233 pub name: Option<String>,
234 pub attrs: Vec<Attribute> ,
236 pub visibility: Option<Visibility>,
237 pub def_id: ast::DefId,
238 pub stability: Option<Stability>,
242 /// Finds the `doc` attribute as a List and returns the list of attributes
244 pub fn doc_list<'a>(&'a self) -> Option<&'a [Attribute]> {
245 for attr in self.attrs.iter() {
247 List(ref x, ref list) if "doc" == *x => {
248 return Some(list.as_slice());
256 /// Finds the `doc` attribute as a NameValue and returns the corresponding
258 pub fn doc_value<'a>(&'a self) -> Option<&'a str> {
259 for attr in self.attrs.iter() {
261 NameValue(ref x, ref v) if "doc" == *x => {
262 return Some(v.as_slice());
270 pub fn is_hidden_from_doc(&self) -> bool {
271 match self.doc_list() {
273 for innerattr in l.iter() {
275 Word(ref s) if "hidden" == *s => {
287 pub fn is_mod(&self) -> bool {
288 match self.inner { ModuleItem(..) => true, _ => false }
290 pub fn is_trait(&self) -> bool {
291 match self.inner { TraitItem(..) => true, _ => false }
293 pub fn is_struct(&self) -> bool {
294 match self.inner { StructItem(..) => true, _ => false }
296 pub fn is_enum(&self) -> bool {
297 match self.inner { EnumItem(..) => true, _ => false }
299 pub fn is_fn(&self) -> bool {
300 match self.inner { FunctionItem(..) => true, _ => false }
304 #[derive(Clone, RustcEncodable, RustcDecodable)]
308 FunctionItem(Function),
310 TypedefItem(Typedef),
312 ConstantItem(Constant),
315 /// `use` and `extern crate`
316 ViewItemItem(ViewItem),
317 /// A method signature only. Used for required methods in traits (ie,
318 /// non-default-methods).
319 TyMethodItem(TyMethod),
320 /// A method with a body.
322 StructFieldItem(StructField),
323 VariantItem(Variant),
324 /// `fn`s from an extern block
325 ForeignFunctionItem(Function),
326 /// `static`s from an extern block
327 ForeignStaticItem(Static),
329 PrimitiveItem(PrimitiveType),
330 AssociatedTypeItem(TyParam),
333 #[derive(Clone, RustcEncodable, RustcDecodable)]
335 pub items: Vec<Item>,
339 impl Clean<Item> for doctree::Module {
340 fn clean(&self, cx: &DocContext) -> Item {
341 let name = if self.name.is_some() {
342 self.name.unwrap().clean(cx)
346 let mut foreigns = Vec::new();
347 for subforeigns in self.foreigns.clean(cx).into_iter() {
348 for foreign in subforeigns.into_iter() {
349 foreigns.push(foreign)
352 let items: Vec<Vec<Item> > = vec!(
353 self.structs.clean(cx),
354 self.enums.clean(cx),
358 self.typedefs.clean(cx),
359 self.statics.clean(cx),
360 self.constants.clean(cx),
361 self.traits.clean(cx),
362 self.impls.clean(cx),
363 self.view_items.clean(cx).into_iter()
364 .flat_map(|s| s.into_iter()).collect(),
365 self.macros.clean(cx),
368 // determine if we should display the inner contents or
369 // the outer `mod` item for the source code.
371 let cm = cx.sess().codemap();
372 let outer = cm.lookup_char_pos(self.where_outer.lo);
373 let inner = cm.lookup_char_pos(self.where_inner.lo);
374 if outer.file.start_pos == inner.file.start_pos {
378 // mod foo; (and a separate FileMap for the contents)
385 attrs: self.attrs.clean(cx),
386 source: whence.clean(cx),
387 visibility: self.vis.clean(cx),
388 stability: self.stab.clean(cx),
389 def_id: ast_util::local_def(self.id),
390 inner: ModuleItem(Module {
391 is_crate: self.is_crate,
393 .flat_map(|x| x.iter().map(|x| (*x).clone()))
400 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
403 List(String, Vec<Attribute> ),
404 NameValue(String, String)
407 impl Clean<Attribute> for ast::MetaItem {
408 fn clean(&self, cx: &DocContext) -> Attribute {
410 ast::MetaWord(ref s) => Word(s.get().to_string()),
411 ast::MetaList(ref s, ref l) => {
412 List(s.get().to_string(), l.clean(cx))
414 ast::MetaNameValue(ref s, ref v) => {
415 NameValue(s.get().to_string(), lit_to_string(v))
421 impl Clean<Attribute> for ast::Attribute {
422 fn clean(&self, cx: &DocContext) -> Attribute {
423 self.with_desugared_doc(|a| a.node.value.clean(cx))
427 // This is a rough approximation that gets us what we want.
428 impl attr::AttrMetaMethods for Attribute {
429 fn name(&self) -> InternedString {
431 Word(ref n) | List(ref n, _) | NameValue(ref n, _) => {
432 token::intern_and_get_ident(n.as_slice())
437 fn value_str(&self) -> Option<InternedString> {
439 NameValue(_, ref v) => {
440 Some(token::intern_and_get_ident(v.as_slice()))
445 fn meta_item_list<'a>(&'a self) -> Option<&'a [P<ast::MetaItem>]> { None }
447 impl<'a> attr::AttrMetaMethods for &'a Attribute {
448 fn name(&self) -> InternedString { (**self).name() }
449 fn value_str(&self) -> Option<InternedString> { (**self).value_str() }
450 fn meta_item_list(&self) -> Option<&[P<ast::MetaItem>]> { None }
453 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
457 pub bounds: Vec<TyParamBound>,
458 pub default: Option<Type>,
461 impl Clean<TyParam> for ast::TyParam {
462 fn clean(&self, cx: &DocContext) -> TyParam {
464 name: self.ident.clean(cx),
465 did: ast::DefId { krate: ast::LOCAL_CRATE, node: self.id },
466 bounds: self.bounds.clean(cx),
467 default: self.default.clean(cx),
472 impl<'tcx> Clean<TyParam> for ty::TypeParameterDef<'tcx> {
473 fn clean(&self, cx: &DocContext) -> TyParam {
474 cx.external_typarams.borrow_mut().as_mut().unwrap()
475 .insert(self.def_id, self.name.clean(cx));
476 let bounds = self.bounds.clean(cx);
478 name: self.name.clean(cx),
481 default: self.default.clean(cx),
486 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
487 pub enum TyParamBound {
488 RegionBound(Lifetime),
489 TraitBound(PolyTrait, ast::TraitBoundModifier)
492 impl Clean<TyParamBound> for ast::TyParamBound {
493 fn clean(&self, cx: &DocContext) -> TyParamBound {
495 ast::RegionTyParamBound(lt) => RegionBound(lt.clean(cx)),
496 ast::TraitTyParamBound(ref t, modifier) => TraitBound(t.clean(cx), modifier),
501 impl<'tcx> Clean<Vec<TyParamBound>> for ty::ExistentialBounds<'tcx> {
502 fn clean(&self, cx: &DocContext) -> Vec<TyParamBound> {
503 let mut vec = vec![];
504 self.region_bound.clean(cx).map(|b| vec.push(RegionBound(b)));
505 for bb in self.builtin_bounds.iter() {
506 vec.push(bb.clean(cx));
509 // FIXME(#20299) -- should do something with projection bounds
515 fn external_path_params(cx: &DocContext, trait_did: Option<ast::DefId>,
516 substs: &subst::Substs) -> PathParameters {
517 use rustc::middle::ty::sty;
518 let lifetimes = substs.regions().get_slice(subst::TypeSpace)
520 .filter_map(|v| v.clean(cx))
522 let types = substs.types.get_slice(subst::TypeSpace).to_vec();
524 match (trait_did, cx.tcx_opt()) {
525 // Attempt to sugar an external path like Fn<(A, B,), C> to Fn(A, B) -> C
526 (Some(did), Some(ref tcx)) if tcx.lang_items.fn_trait_kind(did).is_some() => {
527 assert_eq!(types.len(), 2);
528 let inputs = match types[0].sty {
529 sty::ty_tup(ref tys) => tys.iter().map(|t| t.clean(cx)).collect(),
531 return PathParameters::AngleBracketed {
532 lifetimes: lifetimes,
533 types: types.clean(cx),
538 let output = match types[1].sty {
539 sty::ty_tup(ref v) if v.is_empty() => None, // -> ()
540 _ => Some(types[1].clean(cx))
542 PathParameters::Parenthesized {
548 PathParameters::AngleBracketed {
549 lifetimes: lifetimes,
550 types: types.clean(cx),
551 bindings: vec![] // FIXME(#20646)
557 // trait_did should be set to a trait's DefId if called on a TraitRef, in order to sugar
558 // from Fn<(A, B,), C> to Fn(A, B) -> C
559 fn external_path(cx: &DocContext, name: &str, trait_did: Option<ast::DefId>,
560 substs: &subst::Substs) -> Path {
563 segments: vec![PathSegment {
564 name: name.to_string(),
565 params: external_path_params(cx, trait_did, substs)
570 impl Clean<TyParamBound> for ty::BuiltinBound {
571 fn clean(&self, cx: &DocContext) -> TyParamBound {
572 let tcx = match cx.tcx_opt() {
574 None => return RegionBound(Lifetime::statik())
576 let empty = subst::Substs::empty();
577 let (did, path) = match *self {
579 (tcx.lang_items.send_trait().unwrap(),
580 external_path(cx, "Send", None, &empty)),
582 (tcx.lang_items.sized_trait().unwrap(),
583 external_path(cx, "Sized", None, &empty)),
585 (tcx.lang_items.copy_trait().unwrap(),
586 external_path(cx, "Copy", None, &empty)),
588 (tcx.lang_items.sync_trait().unwrap(),
589 external_path(cx, "Sync", None, &empty)),
591 let fqn = csearch::get_item_path(tcx, did);
592 let fqn = fqn.into_iter().map(|i| i.to_string()).collect();
593 cx.external_paths.borrow_mut().as_mut().unwrap().insert(did,
595 TraitBound(PolyTrait {
596 trait_: ResolvedPath {
602 }, ast::TraitBoundModifier::None)
606 impl<'tcx> Clean<TyParamBound> for ty::PolyTraitRef<'tcx> {
607 fn clean(&self, cx: &DocContext) -> TyParamBound {
612 impl<'tcx> Clean<TyParamBound> for ty::TraitRef<'tcx> {
613 fn clean(&self, cx: &DocContext) -> TyParamBound {
614 let tcx = match cx.tcx_opt() {
616 None => return RegionBound(Lifetime::statik())
618 let fqn = csearch::get_item_path(tcx, self.def_id);
619 let fqn = fqn.into_iter().map(|i| i.to_string())
620 .collect::<Vec<String>>();
621 let path = external_path(cx, fqn.last().unwrap().as_slice(),
622 Some(self.def_id), self.substs);
623 cx.external_paths.borrow_mut().as_mut().unwrap().insert(self.def_id,
626 debug!("ty::TraitRef\n substs.types(TypeSpace): {:?}\n",
627 self.substs.types.get_slice(ParamSpace::TypeSpace));
629 // collect any late bound regions
630 let mut late_bounds = vec![];
631 for &ty_s in self.substs.types.get_slice(ParamSpace::TypeSpace).iter() {
632 use rustc::middle::ty::{Region, sty};
633 if let sty::ty_tup(ref ts) = ty_s.sty {
634 for &ty_s in ts.iter() {
635 if let sty::ty_rptr(ref reg, _) = ty_s.sty {
636 if let &Region::ReLateBound(_, _) = *reg {
637 debug!(" hit an ReLateBound {:?}", reg);
638 if let Some(lt) = reg.clean(cx) {
647 TraitBound(PolyTrait {
648 trait_: ResolvedPath { path: path, typarams: None, did: self.def_id, },
649 lifetimes: late_bounds
650 }, ast::TraitBoundModifier::None)
654 impl<'tcx> Clean<Vec<TyParamBound>> for ty::ParamBounds<'tcx> {
655 fn clean(&self, cx: &DocContext) -> Vec<TyParamBound> {
656 let mut v = Vec::new();
657 for t in self.trait_bounds.iter() {
660 for r in self.region_bounds.iter().filter_map(|r| r.clean(cx)) {
661 v.push(RegionBound(r));
667 impl<'tcx> Clean<Option<Vec<TyParamBound>>> for subst::Substs<'tcx> {
668 fn clean(&self, cx: &DocContext) -> Option<Vec<TyParamBound>> {
669 let mut v = Vec::new();
670 v.extend(self.regions().iter().filter_map(|r| r.clean(cx)).map(RegionBound));
671 v.extend(self.types.iter().map(|t| TraitBound(PolyTrait {
674 }, ast::TraitBoundModifier::None)));
675 if v.len() > 0 {Some(v)} else {None}
679 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
680 pub struct Lifetime(String);
683 pub fn get_ref<'a>(&'a self) -> &'a str {
684 let Lifetime(ref s) = *self;
685 let s: &'a str = s.as_slice();
689 pub fn statik() -> Lifetime {
690 Lifetime("'static".to_string())
694 impl Clean<Lifetime> for ast::Lifetime {
695 fn clean(&self, _: &DocContext) -> Lifetime {
696 Lifetime(token::get_name(self.name).get().to_string())
700 impl Clean<Lifetime> for ast::LifetimeDef {
701 fn clean(&self, _: &DocContext) -> Lifetime {
702 Lifetime(token::get_name(self.lifetime.name).get().to_string())
706 impl Clean<Lifetime> for ty::RegionParameterDef {
707 fn clean(&self, _: &DocContext) -> Lifetime {
708 Lifetime(token::get_name(self.name).get().to_string())
712 impl Clean<Option<Lifetime>> for ty::Region {
713 fn clean(&self, cx: &DocContext) -> Option<Lifetime> {
715 ty::ReStatic => Some(Lifetime::statik()),
716 ty::ReLateBound(_, ty::BrNamed(_, name)) =>
717 Some(Lifetime(token::get_name(name).get().to_string())),
718 ty::ReEarlyBound(_, _, _, name) => Some(Lifetime(name.clean(cx))),
720 ty::ReLateBound(..) |
724 ty::ReEmpty(..) => None
729 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
730 pub enum WherePredicate {
731 BoundPredicate { ty: Type, bounds: Vec<TyParamBound> },
732 RegionPredicate { lifetime: Lifetime, bounds: Vec<Lifetime>},
737 impl Clean<WherePredicate> for ast::WherePredicate {
738 fn clean(&self, cx: &DocContext) -> WherePredicate {
740 ast::WherePredicate::BoundPredicate(ref wbp) => {
741 WherePredicate::BoundPredicate {
742 ty: wbp.bounded_ty.clean(cx),
743 bounds: wbp.bounds.clean(cx)
747 ast::WherePredicate::RegionPredicate(ref wrp) => {
748 WherePredicate::RegionPredicate {
749 lifetime: wrp.lifetime.clean(cx),
750 bounds: wrp.bounds.clean(cx)
754 ast::WherePredicate::EqPredicate(_) => {
755 WherePredicate::EqPredicate
761 // maybe use a Generic enum and use ~[Generic]?
762 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
763 pub struct Generics {
764 pub lifetimes: Vec<Lifetime>,
765 pub type_params: Vec<TyParam>,
766 pub where_predicates: Vec<WherePredicate>
769 impl Clean<Generics> for ast::Generics {
770 fn clean(&self, cx: &DocContext) -> Generics {
772 lifetimes: self.lifetimes.clean(cx),
773 type_params: self.ty_params.clean(cx),
774 where_predicates: self.where_clause.predicates.clean(cx)
779 impl<'a, 'tcx> Clean<Generics> for (&'a ty::Generics<'tcx>, subst::ParamSpace) {
780 fn clean(&self, cx: &DocContext) -> Generics {
781 let (me, space) = *self;
783 type_params: me.types.get_slice(space).to_vec().clean(cx),
784 lifetimes: me.regions.get_slice(space).to_vec().clean(cx),
785 where_predicates: vec![]
790 #[derive(Clone, RustcEncodable, RustcDecodable)]
792 pub generics: Generics,
794 pub unsafety: ast::Unsafety,
798 impl Clean<Item> for ast::Method {
799 fn clean(&self, cx: &DocContext) -> Item {
800 let all_inputs = &self.pe_fn_decl().inputs;
801 let inputs = match self.pe_explicit_self().node {
802 ast::SelfStatic => all_inputs.as_slice(),
803 _ => &all_inputs[1..]
807 values: inputs.iter().map(|x| x.clean(cx)).collect(),
809 output: self.pe_fn_decl().output.clean(cx),
813 name: Some(self.pe_ident().clean(cx)),
814 attrs: self.attrs.clean(cx),
815 source: self.span.clean(cx),
816 def_id: ast_util::local_def(self.id),
817 visibility: self.pe_vis().clean(cx),
818 stability: get_stability(cx, ast_util::local_def(self.id)),
819 inner: MethodItem(Method {
820 generics: self.pe_generics().clean(cx),
821 self_: self.pe_explicit_self().node.clean(cx),
822 unsafety: self.pe_unsafety().clone(),
829 #[derive(Clone, RustcEncodable, RustcDecodable)]
830 pub struct TyMethod {
831 pub unsafety: ast::Unsafety,
833 pub generics: Generics,
837 impl Clean<Item> for ast::TypeMethod {
838 fn clean(&self, cx: &DocContext) -> Item {
839 let inputs = match self.explicit_self.node {
840 ast::SelfStatic => self.decl.inputs.as_slice(),
841 _ => &self.decl.inputs[1..]
845 values: inputs.iter().map(|x| x.clean(cx)).collect(),
847 output: self.decl.output.clean(cx),
851 name: Some(self.ident.clean(cx)),
852 attrs: self.attrs.clean(cx),
853 source: self.span.clean(cx),
854 def_id: ast_util::local_def(self.id),
856 stability: get_stability(cx, ast_util::local_def(self.id)),
857 inner: TyMethodItem(TyMethod {
858 unsafety: self.unsafety.clone(),
860 self_: self.explicit_self.node.clean(cx),
861 generics: self.generics.clean(cx),
867 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq)]
871 SelfBorrowed(Option<Lifetime>, Mutability),
875 impl Clean<SelfTy> for ast::ExplicitSelf_ {
876 fn clean(&self, cx: &DocContext) -> SelfTy {
878 ast::SelfStatic => SelfStatic,
879 ast::SelfValue(_) => SelfValue,
880 ast::SelfRegion(ref lt, ref mt, _) => {
881 SelfBorrowed(lt.clean(cx), mt.clean(cx))
883 ast::SelfExplicit(ref typ, _) => SelfExplicit(typ.clean(cx)),
888 #[derive(Clone, RustcEncodable, RustcDecodable)]
889 pub struct Function {
891 pub generics: Generics,
892 pub unsafety: ast::Unsafety,
895 impl Clean<Item> for doctree::Function {
896 fn clean(&self, cx: &DocContext) -> Item {
898 name: Some(self.name.clean(cx)),
899 attrs: self.attrs.clean(cx),
900 source: self.whence.clean(cx),
901 visibility: self.vis.clean(cx),
902 stability: self.stab.clean(cx),
903 def_id: ast_util::local_def(self.id),
904 inner: FunctionItem(Function {
905 decl: self.decl.clean(cx),
906 generics: self.generics.clean(cx),
907 unsafety: self.unsafety,
913 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
914 pub struct ClosureDecl {
915 pub lifetimes: Vec<Lifetime>,
917 pub onceness: ast::Onceness,
918 pub unsafety: ast::Unsafety,
919 pub bounds: Vec<TyParamBound>,
922 impl Clean<ClosureDecl> for ast::ClosureTy {
923 fn clean(&self, cx: &DocContext) -> ClosureDecl {
925 lifetimes: self.lifetimes.clean(cx),
926 decl: self.decl.clean(cx),
927 onceness: self.onceness,
928 unsafety: self.unsafety,
929 bounds: self.bounds.clean(cx)
934 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
936 pub inputs: Arguments,
937 pub output: FunctionRetTy,
938 pub attrs: Vec<Attribute>,
941 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
942 pub struct Arguments {
943 pub values: Vec<Argument>,
946 impl Clean<FnDecl> for ast::FnDecl {
947 fn clean(&self, cx: &DocContext) -> FnDecl {
950 values: self.inputs.clean(cx),
952 output: self.output.clean(cx),
958 impl<'tcx> Clean<Type> for ty::FnOutput<'tcx> {
959 fn clean(&self, cx: &DocContext) -> Type {
961 ty::FnConverging(ty) => ty.clean(cx),
962 ty::FnDiverging => Bottom
967 impl<'a, 'tcx> Clean<FnDecl> for (ast::DefId, &'a ty::PolyFnSig<'tcx>) {
968 fn clean(&self, cx: &DocContext) -> FnDecl {
969 let (did, sig) = *self;
970 let mut names = if did.node != 0 {
971 csearch::get_method_arg_names(&cx.tcx().sess.cstore, did).into_iter()
973 Vec::new().into_iter()
975 if names.peek().map(|s| s.as_slice()) == Some("self") {
976 let _ = names.next();
979 output: Return(sig.0.output.clean(cx)),
982 values: sig.0.inputs.iter().map(|t| {
986 name: names.next().unwrap_or("".to_string()),
994 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
995 pub struct Argument {
1001 impl Clean<Argument> for ast::Arg {
1002 fn clean(&self, cx: &DocContext) -> Argument {
1004 name: name_from_pat(&*self.pat),
1005 type_: (self.ty.clean(cx)),
1011 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
1012 pub enum FunctionRetTy {
1017 impl Clean<FunctionRetTy> for ast::FunctionRetTy {
1018 fn clean(&self, cx: &DocContext) -> FunctionRetTy {
1020 ast::Return(ref typ) => Return(typ.clean(cx)),
1021 ast::NoReturn(_) => NoReturn
1026 #[derive(Clone, RustcEncodable, RustcDecodable)]
1028 pub unsafety: ast::Unsafety,
1029 pub items: Vec<TraitMethod>,
1030 pub generics: Generics,
1031 pub bounds: Vec<TyParamBound>,
1034 impl Clean<Item> for doctree::Trait {
1035 fn clean(&self, cx: &DocContext) -> Item {
1037 name: Some(self.name.clean(cx)),
1038 attrs: self.attrs.clean(cx),
1039 source: self.whence.clean(cx),
1040 def_id: ast_util::local_def(self.id),
1041 visibility: self.vis.clean(cx),
1042 stability: self.stab.clean(cx),
1043 inner: TraitItem(Trait {
1044 unsafety: self.unsafety,
1045 items: self.items.clean(cx),
1046 generics: self.generics.clean(cx),
1047 bounds: self.bounds.clean(cx),
1053 impl Clean<Type> for ast::TraitRef {
1054 fn clean(&self, cx: &DocContext) -> Type {
1055 resolve_type(cx, self.path.clean(cx), self.ref_id)
1059 impl Clean<PolyTrait> for ast::PolyTraitRef {
1060 fn clean(&self, cx: &DocContext) -> PolyTrait {
1062 trait_: self.trait_ref.clean(cx),
1063 lifetimes: self.bound_lifetimes.clean(cx)
1068 /// An item belonging to a trait, whether a method or associated. Could be named
1069 /// TraitItem except that's already taken by an exported enum variant.
1070 #[derive(Clone, RustcEncodable, RustcDecodable)]
1071 pub enum TraitMethod {
1072 RequiredMethod(Item),
1073 ProvidedMethod(Item),
1074 TypeTraitItem(Item),
1078 pub fn is_req(&self) -> bool {
1080 &RequiredMethod(..) => true,
1084 pub fn is_def(&self) -> bool {
1086 &ProvidedMethod(..) => true,
1090 pub fn is_type(&self) -> bool {
1092 &TypeTraitItem(..) => true,
1096 pub fn item<'a>(&'a self) -> &'a Item {
1098 RequiredMethod(ref item) => item,
1099 ProvidedMethod(ref item) => item,
1100 TypeTraitItem(ref item) => item,
1105 impl Clean<TraitMethod> for ast::TraitItem {
1106 fn clean(&self, cx: &DocContext) -> TraitMethod {
1108 &ast::RequiredMethod(ref t) => RequiredMethod(t.clean(cx)),
1109 &ast::ProvidedMethod(ref t) => ProvidedMethod(t.clean(cx)),
1110 &ast::TypeTraitItem(ref t) => TypeTraitItem(t.clean(cx)),
1115 #[derive(Clone, RustcEncodable, RustcDecodable)]
1116 pub enum ImplMethod {
1117 MethodImplItem(Item),
1121 impl Clean<ImplMethod> for ast::ImplItem {
1122 fn clean(&self, cx: &DocContext) -> ImplMethod {
1124 &ast::MethodImplItem(ref t) => MethodImplItem(t.clean(cx)),
1125 &ast::TypeImplItem(ref t) => TypeImplItem(t.clean(cx)),
1130 impl<'tcx> Clean<Item> for ty::Method<'tcx> {
1131 fn clean(&self, cx: &DocContext) -> Item {
1132 let (self_, sig) = match self.explicit_self {
1133 ty::StaticExplicitSelfCategory => (ast::SelfStatic.clean(cx),
1134 self.fty.sig.clone()),
1136 let sig = ty::Binder(ty::FnSig {
1137 inputs: self.fty.sig.0.inputs[1..].to_vec(),
1138 ..self.fty.sig.0.clone()
1141 ty::ByValueExplicitSelfCategory => SelfValue,
1142 ty::ByReferenceExplicitSelfCategory(..) => {
1143 match self.fty.sig.0.inputs[0].sty {
1144 ty::ty_rptr(r, mt) => {
1145 SelfBorrowed(r.clean(cx), mt.mutbl.clean(cx))
1147 _ => unreachable!(),
1150 ty::ByBoxExplicitSelfCategory => {
1151 SelfExplicit(self.fty.sig.0.inputs[0].clean(cx))
1153 ty::StaticExplicitSelfCategory => unreachable!(),
1160 name: Some(self.name.clean(cx)),
1161 visibility: Some(ast::Inherited),
1162 stability: get_stability(cx, self.def_id),
1163 def_id: self.def_id,
1164 attrs: inline::load_attrs(cx, cx.tcx(), self.def_id),
1165 source: Span::empty(),
1166 inner: TyMethodItem(TyMethod {
1167 unsafety: self.fty.unsafety,
1168 generics: (&self.generics, subst::FnSpace).clean(cx),
1170 decl: (self.def_id, &sig).clean(cx),
1176 impl<'tcx> Clean<Item> for ty::ImplOrTraitItem<'tcx> {
1177 fn clean(&self, cx: &DocContext) -> Item {
1179 ty::MethodTraitItem(ref mti) => mti.clean(cx),
1180 ty::TypeTraitItem(ref tti) => tti.clean(cx),
1185 /// A trait reference, which may have higher ranked lifetimes.
1186 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
1187 pub struct PolyTrait {
1189 pub lifetimes: Vec<Lifetime>
1192 /// A representation of a Type suitable for hyperlinking purposes. Ideally one can get the original
1193 /// type out of the AST/ty::ctxt given one of these, if more information is needed. Most importantly
1194 /// it does not preserve mutability or boxes.
1195 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
1197 /// structs/enums/traits (anything that'd be an ast::TyPath)
1200 typarams: Option<Vec<TyParamBound>>,
1203 // I have no idea how to usefully use this.
1204 TyParamBinder(ast::NodeId),
1205 /// For parameterized types, so the consumer of the JSON don't go
1206 /// looking for types which don't exist anywhere.
1208 /// Primitives are just the fixed-size numeric types (plus int/uint/float), and char.
1209 Primitive(PrimitiveType),
1210 Closure(Box<ClosureDecl>),
1211 Proc(Box<ClosureDecl>),
1213 BareFunction(Box<BareFunctionDecl>),
1216 FixedVector(Box<Type>, String),
1220 RawPointer(Mutability, Box<Type>),
1222 lifetime: Option<Lifetime>,
1223 mutability: Mutability,
1227 // <Type as Trait>::Name
1230 self_type: Box<Type>,
1238 PolyTraitRef(Vec<TyParamBound>),
1241 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Eq, Hash, Copy, Show)]
1242 pub enum PrimitiveType {
1243 Isize, I8, I16, I32, I64,
1244 Usize, U8, U16, U32, U64,
1253 #[derive(Clone, RustcEncodable, RustcDecodable, Copy)]
1266 impl PrimitiveType {
1267 fn from_str(s: &str) -> Option<PrimitiveType> {
1268 match s.as_slice() {
1269 "isize" | "int" => Some(Isize),
1274 "usize" | "uint" => Some(Usize),
1279 "bool" => Some(Bool),
1280 "char" => Some(Char),
1284 "slice" => Some(Slice),
1285 "tuple" => Some(PrimitiveTuple),
1290 fn find(attrs: &[Attribute]) -> Option<PrimitiveType> {
1291 for attr in attrs.iter() {
1292 let list = match *attr {
1293 List(ref k, ref l) if *k == "doc" => l,
1296 for sub_attr in list.iter() {
1297 let value = match *sub_attr {
1298 NameValue(ref k, ref v)
1299 if *k == "primitive" => v.as_slice(),
1302 match PrimitiveType::from_str(value) {
1303 Some(p) => return Some(p),
1311 pub fn to_string(&self) -> &'static str {
1329 PrimitiveTuple => "tuple",
1333 pub fn to_url_str(&self) -> &'static str {
1337 /// Creates a rustdoc-specific node id for primitive types.
1339 /// These node ids are generally never used by the AST itself.
1340 pub fn to_node_id(&self) -> ast::NodeId {
1341 u32::MAX - 1 - (*self as u32)
1345 impl Clean<Type> for ast::Ty {
1346 fn clean(&self, cx: &DocContext) -> Type {
1349 TyPtr(ref m) => RawPointer(m.mutbl.clean(cx), box m.ty.clean(cx)),
1350 TyRptr(ref l, ref m) =>
1351 BorrowedRef {lifetime: l.clean(cx), mutability: m.mutbl.clean(cx),
1352 type_: box m.ty.clean(cx)},
1353 TyVec(ref ty) => Vector(box ty.clean(cx)),
1354 TyFixedLengthVec(ref ty, ref e) => FixedVector(box ty.clean(cx),
1356 TyTup(ref tys) => Tuple(tys.clean(cx)),
1357 TyPath(ref p, id) => {
1358 resolve_type(cx, p.clean(cx), id)
1360 TyObjectSum(ref lhs, ref bounds) => {
1361 let lhs_ty = lhs.clean(cx);
1363 ResolvedPath { path, typarams: None, did } => {
1364 ResolvedPath { path: path, typarams: Some(bounds.clean(cx)), did: did}
1367 lhs_ty // shouldn't happen
1371 TyBareFn(ref barefn) => BareFunction(box barefn.clean(cx)),
1372 TyParen(ref ty) => ty.clean(cx),
1373 TyQPath(ref qp) => qp.clean(cx),
1374 TyPolyTraitRef(ref bounds) => {
1375 PolyTraitRef(bounds.clean(cx))
1381 panic!("Unimplemented type {:?}", self.node)
1387 impl<'tcx> Clean<Type> for ty::Ty<'tcx> {
1388 fn clean(&self, cx: &DocContext) -> Type {
1390 ty::ty_bool => Primitive(Bool),
1391 ty::ty_char => Primitive(Char),
1392 ty::ty_int(ast::TyIs(_)) => Primitive(Isize),
1393 ty::ty_int(ast::TyI8) => Primitive(I8),
1394 ty::ty_int(ast::TyI16) => Primitive(I16),
1395 ty::ty_int(ast::TyI32) => Primitive(I32),
1396 ty::ty_int(ast::TyI64) => Primitive(I64),
1397 ty::ty_uint(ast::TyUs(_)) => Primitive(Usize),
1398 ty::ty_uint(ast::TyU8) => Primitive(U8),
1399 ty::ty_uint(ast::TyU16) => Primitive(U16),
1400 ty::ty_uint(ast::TyU32) => Primitive(U32),
1401 ty::ty_uint(ast::TyU64) => Primitive(U64),
1402 ty::ty_float(ast::TyF32) => Primitive(F32),
1403 ty::ty_float(ast::TyF64) => Primitive(F64),
1404 ty::ty_str => Primitive(Str),
1406 let box_did = cx.tcx_opt().and_then(|tcx| {
1407 tcx.lang_items.owned_box()
1409 lang_struct(cx, box_did, t, "Box", Unique)
1411 ty::ty_vec(ty, None) => Vector(box ty.clean(cx)),
1412 ty::ty_vec(ty, Some(i)) => FixedVector(box ty.clean(cx),
1414 ty::ty_ptr(mt) => RawPointer(mt.mutbl.clean(cx), box mt.ty.clean(cx)),
1415 ty::ty_rptr(r, mt) => BorrowedRef {
1416 lifetime: r.clean(cx),
1417 mutability: mt.mutbl.clean(cx),
1418 type_: box mt.ty.clean(cx),
1420 ty::ty_bare_fn(_, ref fty) => BareFunction(box BareFunctionDecl {
1421 unsafety: fty.unsafety,
1422 generics: Generics {
1423 lifetimes: Vec::new(),
1424 type_params: Vec::new(),
1425 where_predicates: Vec::new()
1427 decl: (ast_util::local_def(0), &fty.sig).clean(cx),
1428 abi: fty.abi.to_string(),
1430 ty::ty_struct(did, substs) |
1431 ty::ty_enum(did, substs) => {
1432 let fqn = csearch::get_item_path(cx.tcx(), did);
1433 let fqn: Vec<_> = fqn.into_iter().map(|i| i.to_string()).collect();
1434 let kind = match self.sty {
1435 ty::ty_struct(..) => TypeStruct,
1438 let path = external_path(cx, fqn.last().unwrap().to_string().as_slice(),
1440 cx.external_paths.borrow_mut().as_mut().unwrap().insert(did, (fqn, kind));
1447 ty::ty_trait(box ty::TyTrait { ref principal, ref bounds }) => {
1448 let did = principal.def_id();
1449 let fqn = csearch::get_item_path(cx.tcx(), did);
1450 let fqn: Vec<_> = fqn.into_iter().map(|i| i.to_string()).collect();
1451 let path = external_path(cx, fqn.last().unwrap().to_string().as_slice(),
1452 Some(did), principal.substs());
1453 cx.external_paths.borrow_mut().as_mut().unwrap().insert(did, (fqn, TypeTrait));
1456 typarams: Some(bounds.clean(cx)),
1460 ty::ty_tup(ref t) => Tuple(t.clean(cx)),
1462 ty::ty_projection(ref data) => {
1463 let trait_ref = match data.trait_ref.clean(cx) {
1464 TyParamBound::TraitBound(t, _) => t.trait_,
1465 TyParamBound::RegionBound(_) => panic!("cleaning a trait got a region??"),
1468 name: data.item_name.clean(cx),
1469 self_type: box data.trait_ref.self_ty().clean(cx),
1470 trait_: box trait_ref,
1474 ty::ty_param(ref p) => Generic(token::get_name(p.name).to_string()),
1476 ty::ty_unboxed_closure(..) => Tuple(vec![]), // FIXME(pcwalton)
1478 ty::ty_infer(..) => panic!("ty_infer"),
1479 ty::ty_open(..) => panic!("ty_open"),
1480 ty::ty_err => panic!("ty_err"),
1485 impl Clean<Type> for ast::QPath {
1486 fn clean(&self, cx: &DocContext) -> Type {
1488 name: self.item_name.clean(cx),
1489 self_type: box self.self_type.clean(cx),
1490 trait_: box self.trait_ref.clean(cx)
1495 #[derive(Clone, RustcEncodable, RustcDecodable)]
1496 pub enum StructField {
1497 HiddenStructField, // inserted later by strip passes
1498 TypedStructField(Type),
1501 impl Clean<Item> for ast::StructField {
1502 fn clean(&self, cx: &DocContext) -> Item {
1503 let (name, vis) = match self.node.kind {
1504 ast::NamedField(id, vis) => (Some(id), vis),
1505 ast::UnnamedField(vis) => (None, vis)
1508 name: name.clean(cx),
1509 attrs: self.node.attrs.clean(cx),
1510 source: self.span.clean(cx),
1511 visibility: Some(vis),
1512 stability: get_stability(cx, ast_util::local_def(self.node.id)),
1513 def_id: ast_util::local_def(self.node.id),
1514 inner: StructFieldItem(TypedStructField(self.node.ty.clean(cx))),
1519 impl Clean<Item> for ty::field_ty {
1520 fn clean(&self, cx: &DocContext) -> Item {
1521 use syntax::parse::token::special_idents::unnamed_field;
1522 use rustc::metadata::csearch;
1524 let attr_map = csearch::get_struct_field_attrs(&cx.tcx().sess.cstore, self.id);
1526 let (name, attrs) = if self.name == unnamed_field.name {
1529 (Some(self.name), Some(attr_map.get(&self.id.node).unwrap()))
1532 let ty = ty::lookup_item_type(cx.tcx(), self.id);
1535 name: name.clean(cx),
1536 attrs: attrs.unwrap_or(&Vec::new()).clean(cx),
1537 source: Span::empty(),
1538 visibility: Some(self.vis),
1539 stability: get_stability(cx, self.id),
1541 inner: StructFieldItem(TypedStructField(ty.ty.clean(cx))),
1546 pub type Visibility = ast::Visibility;
1548 impl Clean<Option<Visibility>> for ast::Visibility {
1549 fn clean(&self, _: &DocContext) -> Option<Visibility> {
1554 #[derive(Clone, RustcEncodable, RustcDecodable)]
1556 pub struct_type: doctree::StructType,
1557 pub generics: Generics,
1558 pub fields: Vec<Item>,
1559 pub fields_stripped: bool,
1562 impl Clean<Item> for doctree::Struct {
1563 fn clean(&self, cx: &DocContext) -> Item {
1565 name: Some(self.name.clean(cx)),
1566 attrs: self.attrs.clean(cx),
1567 source: self.whence.clean(cx),
1568 def_id: ast_util::local_def(self.id),
1569 visibility: self.vis.clean(cx),
1570 stability: self.stab.clean(cx),
1571 inner: StructItem(Struct {
1572 struct_type: self.struct_type,
1573 generics: self.generics.clean(cx),
1574 fields: self.fields.clean(cx),
1575 fields_stripped: false,
1581 /// This is a more limited form of the standard Struct, different in that
1582 /// it lacks the things most items have (name, id, parameterization). Found
1583 /// only as a variant in an enum.
1584 #[derive(Clone, RustcEncodable, RustcDecodable)]
1585 pub struct VariantStruct {
1586 pub struct_type: doctree::StructType,
1587 pub fields: Vec<Item>,
1588 pub fields_stripped: bool,
1591 impl Clean<VariantStruct> for syntax::ast::StructDef {
1592 fn clean(&self, cx: &DocContext) -> VariantStruct {
1594 struct_type: doctree::struct_type_from_def(self),
1595 fields: self.fields.clean(cx),
1596 fields_stripped: false,
1601 #[derive(Clone, RustcEncodable, RustcDecodable)]
1603 pub variants: Vec<Item>,
1604 pub generics: Generics,
1605 pub variants_stripped: bool,
1608 impl Clean<Item> for doctree::Enum {
1609 fn clean(&self, cx: &DocContext) -> Item {
1611 name: Some(self.name.clean(cx)),
1612 attrs: self.attrs.clean(cx),
1613 source: self.whence.clean(cx),
1614 def_id: ast_util::local_def(self.id),
1615 visibility: self.vis.clean(cx),
1616 stability: self.stab.clean(cx),
1617 inner: EnumItem(Enum {
1618 variants: self.variants.clean(cx),
1619 generics: self.generics.clean(cx),
1620 variants_stripped: false,
1626 #[derive(Clone, RustcEncodable, RustcDecodable)]
1627 pub struct Variant {
1628 pub kind: VariantKind,
1631 impl Clean<Item> for doctree::Variant {
1632 fn clean(&self, cx: &DocContext) -> Item {
1634 name: Some(self.name.clean(cx)),
1635 attrs: self.attrs.clean(cx),
1636 source: self.whence.clean(cx),
1637 visibility: self.vis.clean(cx),
1638 stability: self.stab.clean(cx),
1639 def_id: ast_util::local_def(self.id),
1640 inner: VariantItem(Variant {
1641 kind: self.kind.clean(cx),
1647 impl<'tcx> Clean<Item> for ty::VariantInfo<'tcx> {
1648 fn clean(&self, cx: &DocContext) -> Item {
1649 // use syntax::parse::token::special_idents::unnamed_field;
1650 let kind = match self.arg_names.as_ref().map(|s| s.as_slice()) {
1651 None | Some([]) if self.args.len() == 0 => CLikeVariant,
1652 None | Some([]) => {
1653 TupleVariant(self.args.clean(cx))
1656 StructVariant(VariantStruct {
1657 struct_type: doctree::Plain,
1658 fields_stripped: false,
1659 fields: s.iter().zip(self.args.iter()).map(|(name, ty)| {
1661 source: Span::empty(),
1662 name: Some(name.clean(cx)),
1664 visibility: Some(ast::Public),
1665 // FIXME: this is not accurate, we need an id for
1666 // the specific field but we're using the id
1667 // for the whole variant. Thus we read the
1668 // stability from the whole variant as well.
1669 // Struct variants are experimental and need
1670 // more infrastructure work before we can get
1671 // at the needed information here.
1673 stability: get_stability(cx, self.id),
1674 inner: StructFieldItem(
1675 TypedStructField(ty.clean(cx))
1683 name: Some(self.name.clean(cx)),
1684 attrs: inline::load_attrs(cx, cx.tcx(), self.id),
1685 source: Span::empty(),
1686 visibility: Some(ast::Public),
1688 inner: VariantItem(Variant { kind: kind }),
1689 stability: get_stability(cx, self.id),
1694 #[derive(Clone, RustcEncodable, RustcDecodable)]
1695 pub enum VariantKind {
1697 TupleVariant(Vec<Type>),
1698 StructVariant(VariantStruct),
1701 impl Clean<VariantKind> for ast::VariantKind {
1702 fn clean(&self, cx: &DocContext) -> VariantKind {
1704 &ast::TupleVariantKind(ref args) => {
1705 if args.len() == 0 {
1708 TupleVariant(args.iter().map(|x| x.ty.clean(cx)).collect())
1711 &ast::StructVariantKind(ref sd) => StructVariant(sd.clean(cx)),
1716 #[derive(Clone, RustcEncodable, RustcDecodable, Show)]
1718 pub filename: String,
1726 fn empty() -> Span {
1728 filename: "".to_string(),
1729 loline: 0, locol: 0,
1730 hiline: 0, hicol: 0,
1735 impl Clean<Span> for syntax::codemap::Span {
1736 fn clean(&self, cx: &DocContext) -> Span {
1737 let cm = cx.sess().codemap();
1738 let filename = cm.span_to_filename(*self);
1739 let lo = cm.lookup_char_pos(self.lo);
1740 let hi = cm.lookup_char_pos(self.hi);
1742 filename: filename.to_string(),
1744 locol: lo.col.to_uint(),
1746 hicol: hi.col.to_uint(),
1751 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
1754 pub segments: Vec<PathSegment>,
1757 impl Clean<Path> for ast::Path {
1758 fn clean(&self, cx: &DocContext) -> Path {
1760 global: self.global,
1761 segments: self.segments.clean(cx),
1766 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
1767 pub enum PathParameters {
1769 lifetimes: Vec<Lifetime>,
1771 bindings: Vec<TypeBinding>
1775 output: Option<Type>
1779 impl Clean<PathParameters> for ast::PathParameters {
1780 fn clean(&self, cx: &DocContext) -> PathParameters {
1782 ast::AngleBracketedParameters(ref data) => {
1783 PathParameters::AngleBracketed {
1784 lifetimes: data.lifetimes.clean(cx),
1785 types: data.types.clean(cx),
1786 bindings: data.bindings.clean(cx)
1790 ast::ParenthesizedParameters(ref data) => {
1791 PathParameters::Parenthesized {
1792 inputs: data.inputs.clean(cx),
1793 output: data.output.clean(cx)
1800 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
1801 pub struct PathSegment {
1803 pub params: PathParameters
1806 impl Clean<PathSegment> for ast::PathSegment {
1807 fn clean(&self, cx: &DocContext) -> PathSegment {
1809 name: self.identifier.clean(cx),
1810 params: self.parameters.clean(cx)
1815 fn path_to_string(p: &ast::Path) -> String {
1816 let mut s = String::new();
1817 let mut first = true;
1818 for i in p.segments.iter().map(|x| token::get_ident(x.identifier)) {
1819 if !first || p.global {
1824 s.push_str(i.get());
1829 impl Clean<String> for ast::Ident {
1830 fn clean(&self, _: &DocContext) -> String {
1831 token::get_ident(*self).get().to_string()
1835 impl Clean<String> for ast::Name {
1836 fn clean(&self, _: &DocContext) -> String {
1837 token::get_name(*self).get().to_string()
1841 #[derive(Clone, RustcEncodable, RustcDecodable)]
1842 pub struct Typedef {
1844 pub generics: Generics,
1847 impl Clean<Item> for doctree::Typedef {
1848 fn clean(&self, cx: &DocContext) -> Item {
1850 name: Some(self.name.clean(cx)),
1851 attrs: self.attrs.clean(cx),
1852 source: self.whence.clean(cx),
1853 def_id: ast_util::local_def(self.id.clone()),
1854 visibility: self.vis.clean(cx),
1855 stability: self.stab.clean(cx),
1856 inner: TypedefItem(Typedef {
1857 type_: self.ty.clean(cx),
1858 generics: self.gen.clean(cx),
1864 #[derive(Clone, RustcEncodable, RustcDecodable, PartialEq, Show)]
1865 pub struct BareFunctionDecl {
1866 pub unsafety: ast::Unsafety,
1867 pub generics: Generics,
1872 impl Clean<BareFunctionDecl> for ast::BareFnTy {
1873 fn clean(&self, cx: &DocContext) -> BareFunctionDecl {
1875 unsafety: self.unsafety,
1876 generics: Generics {
1877 lifetimes: self.lifetimes.clean(cx),
1878 type_params: Vec::new(),
1879 where_predicates: Vec::new()
1881 decl: self.decl.clean(cx),
1882 abi: self.abi.to_string(),
1887 #[derive(Clone, RustcEncodable, RustcDecodable, Show)]
1890 pub mutability: Mutability,
1891 /// It's useful to have the value of a static documented, but I have no
1892 /// desire to represent expressions (that'd basically be all of the AST,
1893 /// which is huge!). So, have a string.
1897 impl Clean<Item> for doctree::Static {
1898 fn clean(&self, cx: &DocContext) -> Item {
1899 debug!("cleaning static {}: {:?}", self.name.clean(cx), self);
1901 name: Some(self.name.clean(cx)),
1902 attrs: self.attrs.clean(cx),
1903 source: self.whence.clean(cx),
1904 def_id: ast_util::local_def(self.id),
1905 visibility: self.vis.clean(cx),
1906 stability: self.stab.clean(cx),
1907 inner: StaticItem(Static {
1908 type_: self.type_.clean(cx),
1909 mutability: self.mutability.clean(cx),
1910 expr: self.expr.span.to_src(cx),
1916 #[derive(Clone, RustcEncodable, RustcDecodable, Show)]
1917 pub struct Constant {
1922 impl Clean<Item> for doctree::Constant {
1923 fn clean(&self, cx: &DocContext) -> Item {
1925 name: Some(self.name.clean(cx)),
1926 attrs: self.attrs.clean(cx),
1927 source: self.whence.clean(cx),
1928 def_id: ast_util::local_def(self.id),
1929 visibility: self.vis.clean(cx),
1930 stability: self.stab.clean(cx),
1931 inner: ConstantItem(Constant {
1932 type_: self.type_.clean(cx),
1933 expr: self.expr.span.to_src(cx),
1939 #[derive(Show, Clone, RustcEncodable, RustcDecodable, PartialEq, Copy)]
1940 pub enum Mutability {
1945 impl Clean<Mutability> for ast::Mutability {
1946 fn clean(&self, _: &DocContext) -> Mutability {
1948 &ast::MutMutable => Mutable,
1949 &ast::MutImmutable => Immutable,
1954 #[derive(Clone, RustcEncodable, RustcDecodable)]
1956 pub generics: Generics,
1957 pub trait_: Option<Type>,
1959 pub items: Vec<Item>,
1963 fn detect_derived<M: AttrMetaMethods>(attrs: &[M]) -> bool {
1964 attr::contains_name(attrs, "automatically_derived")
1967 impl Clean<Item> for doctree::Impl {
1968 fn clean(&self, cx: &DocContext) -> Item {
1971 attrs: self.attrs.clean(cx),
1972 source: self.whence.clean(cx),
1973 def_id: ast_util::local_def(self.id),
1974 visibility: self.vis.clean(cx),
1975 stability: self.stab.clean(cx),
1976 inner: ImplItem(Impl {
1977 generics: self.generics.clean(cx),
1978 trait_: self.trait_.clean(cx),
1979 for_: self.for_.clean(cx),
1980 items: self.items.clean(cx).into_iter().map(|ti| {
1982 MethodImplItem(i) => i,
1983 TypeImplItem(i) => i,
1986 derived: detect_derived(self.attrs.as_slice()),
1992 #[derive(Clone, RustcEncodable, RustcDecodable)]
1993 pub struct ViewItem {
1994 pub inner: ViewItemInner,
1997 impl Clean<Vec<Item>> for ast::ViewItem {
1998 fn clean(&self, cx: &DocContext) -> Vec<Item> {
1999 // We consider inlining the documentation of `pub use` statements, but we
2000 // forcefully don't inline if this is not public or if the
2001 // #[doc(no_inline)] attribute is present.
2002 let denied = self.vis != ast::Public || self.attrs.iter().any(|a| {
2003 a.name().get() == "doc" && match a.meta_item_list() {
2004 Some(l) => attr::contains_name(l, "no_inline"),
2008 let convert = |&: node: &ast::ViewItem_| {
2011 attrs: self.attrs.clean(cx),
2012 source: self.span.clean(cx),
2013 def_id: ast_util::local_def(0),
2014 visibility: self.vis.clean(cx),
2016 inner: ViewItemItem(ViewItem { inner: node.clean(cx) }),
2019 let mut ret = Vec::new();
2021 ast::ViewItemUse(ref path) if !denied => {
2023 ast::ViewPathGlob(..) => ret.push(convert(&self.node)),
2024 ast::ViewPathList(ref a, ref list, ref b) => {
2025 // Attempt to inline all reexported items, but be sure
2026 // to keep any non-inlineable reexports so they can be
2027 // listed in the documentation.
2028 let remaining = list.iter().filter(|path| {
2029 match inline::try_inline(cx, path.node.id(), None) {
2031 ret.extend(items.into_iter()); false
2035 }).map(|a| a.clone()).collect::<Vec<ast::PathListItem>>();
2036 if remaining.len() > 0 {
2037 let path = ast::ViewPathList(a.clone(),
2040 let path = syntax::codemap::dummy_spanned(path);
2041 ret.push(convert(&ast::ViewItemUse(P(path))));
2044 ast::ViewPathSimple(ident, _, id) => {
2045 match inline::try_inline(cx, id, Some(ident)) {
2046 Some(items) => ret.extend(items.into_iter()),
2047 None => ret.push(convert(&self.node)),
2052 ref n => ret.push(convert(n)),
2058 #[derive(Clone, RustcEncodable, RustcDecodable)]
2059 pub enum ViewItemInner {
2060 ExternCrate(String, Option<String>, ast::NodeId),
2064 impl Clean<ViewItemInner> for ast::ViewItem_ {
2065 fn clean(&self, cx: &DocContext) -> ViewItemInner {
2067 &ast::ViewItemExternCrate(ref i, ref p, ref id) => {
2068 let string = match *p {
2070 Some((ref x, _)) => Some(x.get().to_string()),
2072 ExternCrate(i.clean(cx), string, *id)
2074 &ast::ViewItemUse(ref vp) => {
2075 Import(vp.clean(cx))
2081 #[derive(Clone, RustcEncodable, RustcDecodable)]
2083 // use source as str;
2084 SimpleImport(String, ImportSource),
2086 GlobImport(ImportSource),
2087 // use source::{a, b, c};
2088 ImportList(ImportSource, Vec<ViewListIdent>),
2091 #[derive(Clone, RustcEncodable, RustcDecodable)]
2092 pub struct ImportSource {
2094 pub did: Option<ast::DefId>,
2097 impl Clean<ViewPath> for ast::ViewPath {
2098 fn clean(&self, cx: &DocContext) -> ViewPath {
2100 ast::ViewPathSimple(ref i, ref p, id) =>
2101 SimpleImport(i.clean(cx), resolve_use_source(cx, p.clean(cx), id)),
2102 ast::ViewPathGlob(ref p, id) =>
2103 GlobImport(resolve_use_source(cx, p.clean(cx), id)),
2104 ast::ViewPathList(ref p, ref pl, id) => {
2105 ImportList(resolve_use_source(cx, p.clean(cx), id),
2112 #[derive(Clone, RustcEncodable, RustcDecodable)]
2113 pub struct ViewListIdent {
2115 pub source: Option<ast::DefId>,
2118 impl Clean<ViewListIdent> for ast::PathListItem {
2119 fn clean(&self, cx: &DocContext) -> ViewListIdent {
2121 ast::PathListIdent { id, name } => ViewListIdent {
2122 name: name.clean(cx),
2123 source: resolve_def(cx, id)
2125 ast::PathListMod { id } => ViewListIdent {
2126 name: "mod".to_string(),
2127 source: resolve_def(cx, id)
2133 impl Clean<Vec<Item>> for ast::ForeignMod {
2134 fn clean(&self, cx: &DocContext) -> Vec<Item> {
2135 self.items.clean(cx)
2139 impl Clean<Item> for ast::ForeignItem {
2140 fn clean(&self, cx: &DocContext) -> Item {
2141 let inner = match self.node {
2142 ast::ForeignItemFn(ref decl, ref generics) => {
2143 ForeignFunctionItem(Function {
2144 decl: decl.clean(cx),
2145 generics: generics.clean(cx),
2146 unsafety: ast::Unsafety::Unsafe,
2149 ast::ForeignItemStatic(ref ty, mutbl) => {
2150 ForeignStaticItem(Static {
2151 type_: ty.clean(cx),
2152 mutability: if mutbl {Mutable} else {Immutable},
2153 expr: "".to_string(),
2158 name: Some(self.ident.clean(cx)),
2159 attrs: self.attrs.clean(cx),
2160 source: self.span.clean(cx),
2161 def_id: ast_util::local_def(self.id),
2162 visibility: self.vis.clean(cx),
2163 stability: get_stability(cx, ast_util::local_def(self.id)),
2172 fn to_src(&self, cx: &DocContext) -> String;
2175 impl ToSource for syntax::codemap::Span {
2176 fn to_src(&self, cx: &DocContext) -> String {
2177 debug!("converting span {:?} to snippet", self.clean(cx));
2178 let sn = match cx.sess().codemap().span_to_snippet(*self) {
2179 Some(x) => x.to_string(),
2180 None => "".to_string()
2182 debug!("got snippet {}", sn);
2187 fn lit_to_string(lit: &ast::Lit) -> String {
2189 ast::LitStr(ref st, _) => st.get().to_string(),
2190 ast::LitBinary(ref data) => format!("{:?}", data),
2191 ast::LitByte(b) => {
2192 let mut res = String::from_str("b'");
2193 for c in (b as char).escape_default() {
2199 ast::LitChar(c) => format!("'{}'", c),
2200 ast::LitInt(i, _t) => i.to_string(),
2201 ast::LitFloat(ref f, _t) => f.get().to_string(),
2202 ast::LitFloatUnsuffixed(ref f) => f.get().to_string(),
2203 ast::LitBool(b) => b.to_string(),
2207 fn name_from_pat(p: &ast::Pat) -> String {
2209 debug!("Trying to get a name from pattern: {:?}", p);
2212 PatWild(PatWildSingle) => "_".to_string(),
2213 PatWild(PatWildMulti) => "..".to_string(),
2214 PatIdent(_, ref p, _) => token::get_ident(p.node).get().to_string(),
2215 PatEnum(ref p, _) => path_to_string(p),
2216 PatStruct(ref name, ref fields, etc) => {
2217 format!("{} {{ {}{} }}", path_to_string(name),
2218 fields.iter().map(|&Spanned { node: ref fp, .. }|
2219 format!("{}: {}", fp.ident.as_str(), name_from_pat(&*fp.pat)))
2220 .collect::<Vec<String>>().connect(", "),
2221 if etc { ", ..." } else { "" }
2224 PatTup(ref elts) => format!("({})", elts.iter().map(|p| name_from_pat(&**p))
2225 .collect::<Vec<String>>().connect(", ")),
2226 PatBox(ref p) => name_from_pat(&**p),
2227 PatRegion(ref p, _) => name_from_pat(&**p),
2229 warn!("tried to get argument name from PatLit, \
2230 which is silly in function arguments");
2233 PatRange(..) => panic!("tried to get argument name from PatRange, \
2234 which is not allowed in function arguments"),
2235 PatVec(ref begin, ref mid, ref end) => {
2236 let begin = begin.iter().map(|p| name_from_pat(&**p));
2237 let mid = mid.as_ref().map(|p| format!("..{}", name_from_pat(&**p))).into_iter();
2238 let end = end.iter().map(|p| name_from_pat(&**p));
2239 format!("[{}]", begin.chain(mid).chain(end).collect::<Vec<_>>().connect(", "))
2242 warn!("can't document the name of a function argument \
2243 produced by a pattern macro");
2244 "(argument produced by macro)".to_string()
2249 /// Given a Type, resolve it using the def_map
2250 fn resolve_type(cx: &DocContext,
2252 id: ast::NodeId) -> Type {
2253 let tcx = match cx.tcx_opt() {
2255 // If we're extracting tests, this return value doesn't matter.
2256 None => return Primitive(Bool),
2258 debug!("searching for {} in defmap", id);
2259 let def = match tcx.def_map.borrow().get(&id) {
2261 None => panic!("unresolved id not in defmap")
2265 def::DefSelfTy(..) => {
2266 return Generic(token::get_name(special_idents::type_self.name).to_string());
2268 def::DefPrimTy(p) => match p {
2269 ast::TyStr => return Primitive(Str),
2270 ast::TyBool => return Primitive(Bool),
2271 ast::TyChar => return Primitive(Char),
2272 ast::TyInt(ast::TyIs(_)) => return Primitive(Isize),
2273 ast::TyInt(ast::TyI8) => return Primitive(I8),
2274 ast::TyInt(ast::TyI16) => return Primitive(I16),
2275 ast::TyInt(ast::TyI32) => return Primitive(I32),
2276 ast::TyInt(ast::TyI64) => return Primitive(I64),
2277 ast::TyUint(ast::TyUs(_)) => return Primitive(Usize),
2278 ast::TyUint(ast::TyU8) => return Primitive(U8),
2279 ast::TyUint(ast::TyU16) => return Primitive(U16),
2280 ast::TyUint(ast::TyU32) => return Primitive(U32),
2281 ast::TyUint(ast::TyU64) => return Primitive(U64),
2282 ast::TyFloat(ast::TyF32) => return Primitive(F32),
2283 ast::TyFloat(ast::TyF64) => return Primitive(F64),
2285 def::DefTyParam(_, _, _, n) => return Generic(token::get_name(n).to_string()),
2286 def::DefTyParamBinder(i) => return TyParamBinder(i),
2289 let did = register_def(&*cx, def);
2290 ResolvedPath { path: path, typarams: None, did: did }
2293 fn register_def(cx: &DocContext, def: def::Def) -> ast::DefId {
2294 let (did, kind) = match def {
2295 def::DefFn(i, _) => (i, TypeFunction),
2296 def::DefTy(i, false) => (i, TypeTypedef),
2297 def::DefTy(i, true) => (i, TypeEnum),
2298 def::DefTrait(i) => (i, TypeTrait),
2299 def::DefStruct(i) => (i, TypeStruct),
2300 def::DefMod(i) => (i, TypeModule),
2301 def::DefStatic(i, _) => (i, TypeStatic),
2302 def::DefVariant(i, _, _) => (i, TypeEnum),
2303 _ => return def.def_id()
2305 if ast_util::is_local(did) { return did }
2306 let tcx = match cx.tcx_opt() {
2310 inline::record_extern_fqn(cx, did, kind);
2311 if let TypeTrait = kind {
2312 let t = inline::build_external_trait(cx, tcx, did);
2313 cx.external_traits.borrow_mut().as_mut().unwrap().insert(did, t);
2318 fn resolve_use_source(cx: &DocContext, path: Path, id: ast::NodeId) -> ImportSource {
2321 did: resolve_def(cx, id),
2325 fn resolve_def(cx: &DocContext, id: ast::NodeId) -> Option<ast::DefId> {
2326 cx.tcx_opt().and_then(|tcx| {
2327 tcx.def_map.borrow().get(&id).map(|&def| register_def(cx, def))
2331 #[derive(Clone, RustcEncodable, RustcDecodable)]
2336 impl Clean<Item> for doctree::Macro {
2337 fn clean(&self, cx: &DocContext) -> Item {
2339 name: Some(format!("{}!", self.name.clean(cx))),
2340 attrs: self.attrs.clean(cx),
2341 source: self.whence.clean(cx),
2342 visibility: ast::Public.clean(cx),
2343 stability: self.stab.clean(cx),
2344 def_id: ast_util::local_def(self.id),
2345 inner: MacroItem(Macro {
2346 source: self.whence.to_src(cx),
2352 #[derive(Clone, RustcEncodable, RustcDecodable)]
2353 pub struct Stability {
2354 pub level: attr::StabilityLevel,
2358 impl Clean<Stability> for attr::Stability {
2359 fn clean(&self, _: &DocContext) -> Stability {
2362 text: self.text.as_ref().map_or("".to_string(),
2363 |interned| interned.get().to_string()),
2368 impl Clean<Item> for ast::AssociatedType {
2369 fn clean(&self, cx: &DocContext) -> Item {
2371 source: self.ty_param.span.clean(cx),
2372 name: Some(self.ty_param.ident.clean(cx)),
2373 attrs: self.attrs.clean(cx),
2374 inner: AssociatedTypeItem(self.ty_param.clean(cx)),
2376 def_id: ast_util::local_def(self.ty_param.id),
2382 impl Clean<Item> for ty::AssociatedType {
2383 fn clean(&self, cx: &DocContext) -> Item {
2385 source: DUMMY_SP.clean(cx),
2386 name: Some(self.name.clean(cx)),
2388 // FIXME(#18048): this is wrong, but cross-crate associated types are broken
2389 // anyway, for the time being.
2390 inner: AssociatedTypeItem(TyParam {
2391 name: self.name.clean(cx),
2394 node: ast::DUMMY_NODE_ID
2400 def_id: self.def_id,
2406 impl Clean<Item> for ast::Typedef {
2407 fn clean(&self, cx: &DocContext) -> Item {
2409 source: self.span.clean(cx),
2410 name: Some(self.ident.clean(cx)),
2411 attrs: self.attrs.clean(cx),
2412 inner: TypedefItem(Typedef {
2413 type_: self.typ.clean(cx),
2414 generics: Generics {
2415 lifetimes: Vec::new(),
2416 type_params: Vec::new(),
2417 where_predicates: Vec::new()
2421 def_id: ast_util::local_def(self.id),
2427 fn lang_struct(cx: &DocContext, did: Option<ast::DefId>,
2428 t: ty::Ty, name: &str,
2429 fallback: fn(Box<Type>) -> Type) -> Type {
2430 let did = match did {
2432 None => return fallback(box t.clean(cx)),
2434 let fqn = csearch::get_item_path(cx.tcx(), did);
2435 let fqn: Vec<String> = fqn.into_iter().map(|i| {
2438 cx.external_paths.borrow_mut().as_mut().unwrap().insert(did, (fqn, TypeStruct));
2444 segments: vec![PathSegment {
2445 name: name.to_string(),
2446 params: PathParameters::AngleBracketed {
2448 types: vec![t.clean(cx)],
2456 /// An equality constraint on an associated type, e.g. `A=Bar` in `Foo<A=Bar>`
2457 #[derive(Clone, PartialEq, RustcDecodable, RustcEncodable, Show)]
2458 pub struct TypeBinding {
2463 impl Clean<TypeBinding> for ast::TypeBinding {
2464 fn clean(&self, cx: &DocContext) -> TypeBinding {
2466 name: self.ident.clean(cx),
2467 ty: self.ty.clean(cx)