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
18 use syntax::attr::AttributeMethods;
19 use syntax::codemap::Pos;
20 use syntax::parse::token::InternedString;
21 use syntax::parse::token;
23 use rustc::metadata::cstore;
24 use rustc::metadata::csearch;
25 use rustc::metadata::decoder;
28 use std::strbuf::StrBuf;
39 impl<T: Clean<U>, U> Clean<Vec<U>> for Vec<T> {
40 fn clean(&self) -> Vec<U> {
41 self.iter().map(|x| x.clean()).collect()
45 impl<T: Clean<U>, U> Clean<U> for @T {
46 fn clean(&self) -> U {
51 impl<T: Clean<U>, U> Clean<Option<U>> for Option<T> {
52 fn clean(&self) -> Option<U> {
55 &Some(ref v) => Some(v.clean())
60 impl<T: Clean<U>, U> Clean<Vec<U>> for syntax::owned_slice::OwnedSlice<T> {
61 fn clean(&self) -> Vec<U> {
62 self.iter().map(|x| x.clean()).collect()
66 #[deriving(Clone, Encodable, Decodable)]
69 pub module: Option<Item>,
70 pub externs: Vec<(ast::CrateNum, ExternalCrate)>,
73 impl<'a> Clean<Crate> for visit_ast::RustdocVisitor<'a> {
74 fn clean(&self) -> Crate {
75 use syntax::attr::find_crateid;
76 let cx = local_data::get(super::ctxtkey, |x| *x.unwrap());
78 let mut externs = Vec::new();
79 cx.sess().cstore.iter_crate_data(|n, meta| {
80 externs.push((n, meta.clean()));
84 name: match find_crateid(self.attrs.as_slice()) {
86 None => fail!("rustdoc requires a `crate_id` crate attribute"),
88 module: Some(self.module.clean()),
94 #[deriving(Clone, Encodable, Decodable)]
95 pub struct ExternalCrate {
97 pub attrs: Vec<Attribute>,
100 impl Clean<ExternalCrate> for cstore::crate_metadata {
101 fn clean(&self) -> ExternalCrate {
103 name: self.name.to_owned(),
104 attrs: decoder::get_crate_attributes(self.data()).clean()
111 /// Anything with a source location and set of attributes and, optionally, a
112 /// name. That is, anything that can be documented. This doesn't correspond
113 /// directly to the AST's concept of an item; it's a strict superset.
114 #[deriving(Clone, Encodable, Decodable)]
118 /// Not everything has a name. E.g., impls
119 pub name: Option<~str>,
120 pub attrs: Vec<Attribute> ,
122 pub visibility: Option<Visibility>,
127 /// Finds the `doc` attribute as a List and returns the list of attributes
129 pub fn doc_list<'a>(&'a self) -> Option<&'a [Attribute]> {
130 for attr in self.attrs.iter() {
132 List(ref x, ref list) if "doc" == *x => { return Some(list.as_slice()); }
139 /// Finds the `doc` attribute as a NameValue and returns the corresponding
141 pub fn doc_value<'a>(&'a self) -> Option<&'a str> {
142 for attr in self.attrs.iter() {
144 NameValue(ref x, ref v) if "doc" == *x => { return Some(v.as_slice()); }
151 pub fn is_mod(&self) -> bool {
152 match self.inner { ModuleItem(..) => true, _ => false }
154 pub fn is_trait(&self) -> bool {
155 match self.inner { TraitItem(..) => true, _ => false }
157 pub fn is_struct(&self) -> bool {
158 match self.inner { StructItem(..) => true, _ => false }
160 pub fn is_enum(&self) -> bool {
161 match self.inner { EnumItem(..) => true, _ => false }
163 pub fn is_fn(&self) -> bool {
164 match self.inner { FunctionItem(..) => true, _ => false }
168 #[deriving(Clone, Encodable, Decodable)]
172 FunctionItem(Function),
174 TypedefItem(Typedef),
178 /// `use` and `extern crate`
179 ViewItemItem(ViewItem),
180 /// A method signature only. Used for required methods in traits (ie,
181 /// non-default-methods).
182 TyMethodItem(TyMethod),
183 /// A method with a body.
185 StructFieldItem(StructField),
186 VariantItem(Variant),
187 /// `fn`s from an extern block
188 ForeignFunctionItem(Function),
189 /// `static`s from an extern block
190 ForeignStaticItem(Static),
194 #[deriving(Clone, Encodable, Decodable)]
196 pub items: Vec<Item>,
200 impl Clean<Item> for doctree::Module {
201 fn clean(&self) -> Item {
202 let name = if self.name.is_some() {
203 self.name.unwrap().clean()
207 let mut foreigns = Vec::new();
208 for subforeigns in self.foreigns.clean().move_iter() {
209 for foreign in subforeigns.move_iter() {
210 foreigns.push(foreign)
213 let items: Vec<Vec<Item> > = vec!(
214 self.structs.clean().move_iter().collect(),
215 self.enums.clean().move_iter().collect(),
216 self.fns.clean().move_iter().collect(),
218 self.mods.clean().move_iter().collect(),
219 self.typedefs.clean().move_iter().collect(),
220 self.statics.clean().move_iter().collect(),
221 self.traits.clean().move_iter().collect(),
222 self.impls.clean().move_iter().collect(),
223 self.view_items.clean().move_iter().collect(),
224 self.macros.clean().move_iter().collect()
228 attrs: self.attrs.clean(),
229 source: self.where.clean(),
230 visibility: self.vis.clean(),
232 inner: ModuleItem(Module {
233 is_crate: self.is_crate,
235 .flat_map(|x| x.iter().map(|x| (*x).clone()))
242 #[deriving(Clone, Encodable, Decodable)]
245 List(~str, Vec<Attribute> ),
246 NameValue(~str, ~str)
249 impl Clean<Attribute> for ast::MetaItem {
250 fn clean(&self) -> Attribute {
252 ast::MetaWord(ref s) => Word(s.get().to_owned()),
253 ast::MetaList(ref s, ref l) => {
254 List(s.get().to_owned(), l.clean().move_iter().collect())
256 ast::MetaNameValue(ref s, ref v) => {
257 NameValue(s.get().to_owned(), lit_to_str(v))
263 impl Clean<Attribute> for ast::Attribute {
264 fn clean(&self) -> Attribute {
265 self.desugar_doc().node.value.clean()
269 // This is a rough approximation that gets us what we want.
270 impl<'a> attr::AttrMetaMethods for &'a Attribute {
271 fn name(&self) -> InternedString {
273 Word(ref n) | List(ref n, _) | NameValue(ref n, _) => {
274 token::intern_and_get_ident(*n)
279 fn value_str(&self) -> Option<InternedString> {
281 NameValue(_, ref v) => Some(token::intern_and_get_ident(*v)),
285 fn meta_item_list<'a>(&'a self) -> Option<&'a [@ast::MetaItem]> { None }
286 fn name_str_pair(&self) -> Option<(InternedString, InternedString)> {
291 #[deriving(Clone, Encodable, Decodable)]
295 pub bounds: Vec<TyParamBound>,
298 impl Clean<TyParam> for ast::TyParam {
299 fn clean(&self) -> TyParam {
301 name: self.ident.clean(),
303 bounds: self.bounds.clean().move_iter().collect(),
308 #[deriving(Clone, Encodable, Decodable)]
309 pub enum TyParamBound {
314 impl Clean<TyParamBound> for ast::TyParamBound {
315 fn clean(&self) -> TyParamBound {
317 ast::RegionTyParamBound => RegionBound,
318 ast::TraitTyParamBound(ref t) => TraitBound(t.clean()),
323 #[deriving(Clone, Encodable, Decodable)]
324 pub struct Lifetime(~str);
327 pub fn get_ref<'a>(&'a self) -> &'a str {
328 let Lifetime(ref s) = *self;
334 impl Clean<Lifetime> for ast::Lifetime {
335 fn clean(&self) -> Lifetime {
336 Lifetime(token::get_name(self.name).get().to_owned())
340 // maybe use a Generic enum and use ~[Generic]?
341 #[deriving(Clone, Encodable, Decodable)]
342 pub struct Generics {
343 pub lifetimes: Vec<Lifetime>,
344 pub type_params: Vec<TyParam>,
347 impl Clean<Generics> for ast::Generics {
348 fn clean(&self) -> Generics {
350 lifetimes: self.lifetimes.clean().move_iter().collect(),
351 type_params: self.ty_params.clean().move_iter().collect(),
356 #[deriving(Clone, Encodable, Decodable)]
358 pub generics: Generics,
360 pub purity: ast::Purity,
364 impl Clean<Item> for ast::Method {
365 fn clean(&self) -> Item {
366 let inputs = match self.explicit_self.node {
367 ast::SelfStatic => self.decl.inputs.as_slice(),
368 _ => self.decl.inputs.slice_from(1)
372 values: inputs.iter().map(|x| x.clean()).collect(),
374 output: (self.decl.output.clean()),
375 cf: self.decl.cf.clean(),
379 name: Some(self.ident.clean()),
380 attrs: self.attrs.clean().move_iter().collect(),
381 source: self.span.clean(),
383 visibility: self.vis.clean(),
384 inner: MethodItem(Method {
385 generics: self.generics.clean(),
386 self_: self.explicit_self.clean(),
387 purity: self.purity.clone(),
394 #[deriving(Clone, Encodable, Decodable)]
395 pub struct TyMethod {
396 pub purity: ast::Purity,
398 pub generics: Generics,
402 impl Clean<Item> for ast::TypeMethod {
403 fn clean(&self) -> Item {
404 let inputs = match self.explicit_self.node {
405 ast::SelfStatic => self.decl.inputs.as_slice(),
406 _ => self.decl.inputs.slice_from(1)
410 values: inputs.iter().map(|x| x.clean()).collect(),
412 output: (self.decl.output.clean()),
413 cf: self.decl.cf.clean(),
417 name: Some(self.ident.clean()),
418 attrs: self.attrs.clean().move_iter().collect(),
419 source: self.span.clean(),
422 inner: TyMethodItem(TyMethod {
423 purity: self.purity.clone(),
425 self_: self.explicit_self.clean(),
426 generics: self.generics.clean(),
432 #[deriving(Clone, Encodable, Decodable)]
436 SelfBorrowed(Option<Lifetime>, Mutability),
440 impl Clean<SelfTy> for ast::ExplicitSelf {
441 fn clean(&self) -> SelfTy {
443 ast::SelfStatic => SelfStatic,
444 ast::SelfValue => SelfValue,
445 ast::SelfUniq => SelfOwned,
446 ast::SelfRegion(lt, mt) => SelfBorrowed(lt.clean(), mt.clean()),
451 #[deriving(Clone, Encodable, Decodable)]
452 pub struct Function {
454 pub generics: Generics,
455 pub purity: ast::Purity,
458 impl Clean<Item> for doctree::Function {
459 fn clean(&self) -> Item {
461 name: Some(self.name.clean()),
462 attrs: self.attrs.clean(),
463 source: self.where.clean(),
464 visibility: self.vis.clean(),
466 inner: FunctionItem(Function {
467 decl: self.decl.clean(),
468 generics: self.generics.clean(),
475 #[deriving(Clone, Encodable, Decodable)]
476 pub struct ClosureDecl {
477 pub sigil: ast::Sigil,
478 pub region: Option<Lifetime>,
479 pub lifetimes: Vec<Lifetime>,
481 pub onceness: ast::Onceness,
482 pub purity: ast::Purity,
483 pub bounds: Vec<TyParamBound>,
486 impl Clean<ClosureDecl> for ast::ClosureTy {
487 fn clean(&self) -> ClosureDecl {
490 region: self.region.clean(),
491 lifetimes: self.lifetimes.clean().move_iter().collect(),
492 decl: self.decl.clean(),
493 onceness: self.onceness,
495 bounds: match self.bounds {
496 Some(ref x) => x.clean().move_iter().collect(),
503 #[deriving(Clone, Encodable, Decodable)]
505 pub inputs: Arguments,
508 pub attrs: Vec<Attribute>,
511 #[deriving(Clone, Encodable, Decodable)]
512 pub struct Arguments {
513 pub values: Vec<Argument>,
516 impl Clean<FnDecl> for ast::FnDecl {
517 fn clean(&self) -> FnDecl {
520 values: self.inputs.iter().map(|x| x.clean()).collect(),
522 output: (self.output.clean()),
529 #[deriving(Clone, Encodable, Decodable)]
530 pub struct Argument {
536 impl Clean<Argument> for ast::Arg {
537 fn clean(&self) -> Argument {
539 name: name_from_pat(self.pat),
540 type_: (self.ty.clean()),
546 #[deriving(Clone, Encodable, Decodable)]
552 impl Clean<RetStyle> for ast::RetStyle {
553 fn clean(&self) -> RetStyle {
555 ast::Return => Return,
556 ast::NoReturn => NoReturn
561 #[deriving(Clone, Encodable, Decodable)]
563 pub methods: Vec<TraitMethod>,
564 pub generics: Generics,
565 pub parents: Vec<Type>,
568 impl Clean<Item> for doctree::Trait {
569 fn clean(&self) -> Item {
571 name: Some(self.name.clean()),
572 attrs: self.attrs.clean(),
573 source: self.where.clean(),
575 visibility: self.vis.clean(),
576 inner: TraitItem(Trait {
577 methods: self.methods.clean(),
578 generics: self.generics.clean(),
579 parents: self.parents.clean(),
585 impl Clean<Type> for ast::TraitRef {
586 fn clean(&self) -> Type {
587 resolve_type(self.path.clean(), None, self.ref_id)
591 #[deriving(Clone, Encodable, Decodable)]
592 pub enum TraitMethod {
598 pub fn is_req(&self) -> bool {
600 &Required(..) => true,
604 pub fn is_def(&self) -> bool {
606 &Provided(..) => true,
610 pub fn item<'a>(&'a self) -> &'a Item {
612 Required(ref item) => item,
613 Provided(ref item) => item,
618 impl Clean<TraitMethod> for ast::TraitMethod {
619 fn clean(&self) -> TraitMethod {
621 &ast::Required(ref t) => Required(t.clean()),
622 &ast::Provided(ref t) => Provided(t.clean()),
627 /// A representation of a Type suitable for hyperlinking purposes. Ideally one can get the original
628 /// type out of the AST/ty::ctxt given one of these, if more information is needed. Most importantly
629 /// it does not preserve mutability or boxes.
630 #[deriving(Clone, Encodable, Decodable)]
632 /// structs/enums/traits (anything that'd be an ast::TyPath)
635 pub typarams: Option<Vec<TyParamBound>>,
638 /// Same as above, but only external variants
641 pub typarams: Option<Vec<TyParamBound>>,
644 pub krate: ast::CrateNum,
646 // I have no idea how to usefully use this.
647 TyParamBinder(ast::NodeId),
648 /// For parameterized types, so the consumer of the JSON don't go looking
649 /// for types which don't exist anywhere.
650 Generic(ast::NodeId),
651 /// For references to self
653 /// Primitives are just the fixed-size numeric types (plus int/uint/float), and char.
654 Primitive(ast::PrimTy),
655 Closure(~ClosureDecl),
657 BareFunction(~BareFunctionDecl),
660 FixedVector(~Type, ~str),
669 RawPointer(Mutability, ~Type),
671 pub lifetime: Option<Lifetime>,
672 pub mutability: Mutability,
675 // region, raw, other boxes, mutable
678 #[deriving(Clone, Encodable, Decodable)]
686 impl Clean<Type> for ast::Ty {
687 fn clean(&self) -> Type {
689 debug!("cleaning type `{:?}`", self);
690 let codemap = local_data::get(super::ctxtkey, |x| *x.unwrap()).sess().codemap();
691 debug!("span corresponds to `{}`", codemap.span_to_str(self.span));
694 TyPtr(ref m) => RawPointer(m.mutbl.clean(), ~m.ty.clean()),
695 TyRptr(ref l, ref m) =>
696 BorrowedRef {lifetime: l.clean(), mutability: m.mutbl.clean(),
697 type_: ~m.ty.clean()},
698 TyBox(ty) => Managed(~ty.clean()),
699 TyUniq(ty) => Unique(~ty.clean()),
700 TyVec(ty) => Vector(~ty.clean()),
701 TyFixedLengthVec(ty, ref e) => FixedVector(~ty.clean(),
703 TyTup(ref tys) => Tuple(tys.iter().map(|x| x.clean()).collect()),
704 TyPath(ref p, ref tpbs, id) => {
705 resolve_type(p.clean(),
706 tpbs.clean().map(|x| x.move_iter().collect()),
709 TyClosure(ref c) => Closure(~c.clean()),
710 TyBareFn(ref barefn) => BareFunction(~barefn.clean()),
712 ref x => fail!("Unimplemented type {:?}", x),
717 #[deriving(Clone, Encodable, Decodable)]
718 pub struct StructField {
722 impl Clean<Item> for ast::StructField {
723 fn clean(&self) -> Item {
724 let (name, vis) = match self.node.kind {
725 ast::NamedField(id, vis) => (Some(id), Some(vis)),
730 attrs: self.node.attrs.clean().move_iter().collect(),
731 source: self.span.clean(),
734 inner: StructFieldItem(StructField {
735 type_: self.node.ty.clean(),
741 pub type Visibility = ast::Visibility;
743 impl Clean<Option<Visibility>> for ast::Visibility {
744 fn clean(&self) -> Option<Visibility> {
749 #[deriving(Clone, Encodable, Decodable)]
751 pub struct_type: doctree::StructType,
752 pub generics: Generics,
753 pub fields: Vec<Item>,
754 pub fields_stripped: bool,
757 impl Clean<Item> for doctree::Struct {
758 fn clean(&self) -> Item {
760 name: Some(self.name.clean()),
761 attrs: self.attrs.clean(),
762 source: self.where.clean(),
764 visibility: self.vis.clean(),
765 inner: StructItem(Struct {
766 struct_type: self.struct_type,
767 generics: self.generics.clean(),
768 fields: self.fields.clean(),
769 fields_stripped: false,
775 /// This is a more limited form of the standard Struct, different in that
776 /// it lacks the things most items have (name, id, parameterization). Found
777 /// only as a variant in an enum.
778 #[deriving(Clone, Encodable, Decodable)]
779 pub struct VariantStruct {
780 pub struct_type: doctree::StructType,
781 pub fields: Vec<Item>,
782 pub fields_stripped: bool,
785 impl Clean<VariantStruct> for syntax::ast::StructDef {
786 fn clean(&self) -> VariantStruct {
788 struct_type: doctree::struct_type_from_def(self),
789 fields: self.fields.clean().move_iter().collect(),
790 fields_stripped: false,
795 #[deriving(Clone, Encodable, Decodable)]
797 pub variants: Vec<Item>,
798 pub generics: Generics,
799 pub variants_stripped: bool,
802 impl Clean<Item> for doctree::Enum {
803 fn clean(&self) -> Item {
805 name: Some(self.name.clean()),
806 attrs: self.attrs.clean(),
807 source: self.where.clean(),
809 visibility: self.vis.clean(),
810 inner: EnumItem(Enum {
811 variants: self.variants.clean(),
812 generics: self.generics.clean(),
813 variants_stripped: false,
819 #[deriving(Clone, Encodable, Decodable)]
821 pub kind: VariantKind,
824 impl Clean<Item> for doctree::Variant {
825 fn clean(&self) -> Item {
827 name: Some(self.name.clean()),
828 attrs: self.attrs.clean(),
829 source: self.where.clean(),
830 visibility: self.vis.clean(),
832 inner: VariantItem(Variant {
833 kind: self.kind.clean(),
839 #[deriving(Clone, Encodable, Decodable)]
840 pub enum VariantKind {
842 TupleVariant(Vec<Type> ),
843 StructVariant(VariantStruct),
846 impl Clean<VariantKind> for ast::VariantKind {
847 fn clean(&self) -> VariantKind {
849 &ast::TupleVariantKind(ref args) => {
853 TupleVariant(args.iter().map(|x| x.ty.clean()).collect())
856 &ast::StructVariantKind(ref sd) => StructVariant(sd.clean()),
861 #[deriving(Clone, Encodable, Decodable)]
870 impl Clean<Span> for syntax::codemap::Span {
871 fn clean(&self) -> Span {
872 let cm = local_data::get(super::ctxtkey, |x| *x.unwrap()).sess().codemap();
873 let filename = cm.span_to_filename(*self);
874 let lo = cm.lookup_char_pos(self.lo);
875 let hi = cm.lookup_char_pos(self.hi);
877 filename: filename.to_owned(),
879 locol: lo.col.to_uint(),
881 hicol: hi.col.to_uint(),
886 #[deriving(Clone, Encodable, Decodable)]
889 pub segments: Vec<PathSegment>,
892 impl Clean<Path> for ast::Path {
893 fn clean(&self) -> Path {
896 segments: self.segments.clean().move_iter().collect(),
901 #[deriving(Clone, Encodable, Decodable)]
902 pub struct PathSegment {
904 pub lifetimes: Vec<Lifetime>,
905 pub types: Vec<Type>,
908 impl Clean<PathSegment> for ast::PathSegment {
909 fn clean(&self) -> PathSegment {
911 name: self.identifier.clean(),
912 lifetimes: self.lifetimes.clean().move_iter().collect(),
913 types: self.types.clean().move_iter().collect()
918 fn path_to_str(p: &ast::Path) -> ~str {
919 use syntax::parse::token;
921 let mut s = StrBuf::new();
922 let mut first = true;
923 for i in p.segments.iter().map(|x| token::get_ident(x.identifier)) {
924 if !first || p.global {
934 impl Clean<~str> for ast::Ident {
935 fn clean(&self) -> ~str {
936 token::get_ident(*self).get().to_owned()
940 #[deriving(Clone, Encodable, Decodable)]
943 pub generics: Generics,
946 impl Clean<Item> for doctree::Typedef {
947 fn clean(&self) -> Item {
949 name: Some(self.name.clean()),
950 attrs: self.attrs.clean(),
951 source: self.where.clean(),
953 visibility: self.vis.clean(),
954 inner: TypedefItem(Typedef {
955 type_: self.ty.clean(),
956 generics: self.gen.clean(),
962 #[deriving(Clone, Encodable, Decodable)]
963 pub struct BareFunctionDecl {
964 pub purity: ast::Purity,
965 pub generics: Generics,
970 impl Clean<BareFunctionDecl> for ast::BareFnTy {
971 fn clean(&self) -> BareFunctionDecl {
975 lifetimes: self.lifetimes.clean().move_iter().collect(),
976 type_params: Vec::new(),
978 decl: self.decl.clean(),
979 abi: self.abi.to_str(),
984 #[deriving(Clone, Encodable, Decodable)]
987 pub mutability: Mutability,
988 /// It's useful to have the value of a static documented, but I have no
989 /// desire to represent expressions (that'd basically be all of the AST,
990 /// which is huge!). So, have a string.
994 impl Clean<Item> for doctree::Static {
995 fn clean(&self) -> Item {
996 debug!("claning static {}: {:?}", self.name.clean(), self);
998 name: Some(self.name.clean()),
999 attrs: self.attrs.clean(),
1000 source: self.where.clean(),
1002 visibility: self.vis.clean(),
1003 inner: StaticItem(Static {
1004 type_: self.type_.clean(),
1005 mutability: self.mutability.clean(),
1006 expr: self.expr.span.to_src(),
1012 #[deriving(Show, Clone, Encodable, Decodable)]
1013 pub enum Mutability {
1018 impl Clean<Mutability> for ast::Mutability {
1019 fn clean(&self) -> Mutability {
1021 &ast::MutMutable => Mutable,
1022 &ast::MutImmutable => Immutable,
1027 #[deriving(Clone, Encodable, Decodable)]
1029 pub generics: Generics,
1030 pub trait_: Option<Type>,
1032 pub methods: Vec<Item>,
1036 impl Clean<Item> for doctree::Impl {
1037 fn clean(&self) -> Item {
1038 let mut derived = false;
1039 for attr in self.attrs.iter() {
1040 match attr.node.value.node {
1041 ast::MetaWord(ref s) => {
1042 if s.get() == "automatically_derived" {
1051 attrs: self.attrs.clean(),
1052 source: self.where.clean(),
1054 visibility: self.vis.clean(),
1055 inner: ImplItem(Impl {
1056 generics: self.generics.clean(),
1057 trait_: self.trait_.clean(),
1058 for_: self.for_.clean(),
1059 methods: self.methods.clean(),
1066 #[deriving(Clone, Encodable, Decodable)]
1067 pub struct ViewItem {
1068 pub inner: ViewItemInner,
1071 impl Clean<Item> for ast::ViewItem {
1072 fn clean(&self) -> Item {
1075 attrs: self.attrs.clean().move_iter().collect(),
1076 source: self.span.clean(),
1078 visibility: self.vis.clean(),
1079 inner: ViewItemItem(ViewItem {
1080 inner: self.node.clean()
1086 #[deriving(Clone, Encodable, Decodable)]
1087 pub enum ViewItemInner {
1088 ExternCrate(~str, Option<~str>, ast::NodeId),
1089 Import(Vec<ViewPath>)
1092 impl Clean<ViewItemInner> for ast::ViewItem_ {
1093 fn clean(&self) -> ViewItemInner {
1095 &ast::ViewItemExternCrate(ref i, ref p, ref id) => {
1096 let string = match *p {
1098 Some((ref x, _)) => Some(x.get().to_owned()),
1100 ExternCrate(i.clean(), string, *id)
1102 &ast::ViewItemUse(ref vp) => {
1103 Import(vp.clean().move_iter().collect())
1109 #[deriving(Clone, Encodable, Decodable)]
1111 // use str = source;
1112 SimpleImport(~str, ImportSource),
1114 GlobImport(ImportSource),
1115 // use source::{a, b, c};
1116 ImportList(ImportSource, Vec<ViewListIdent> ),
1119 #[deriving(Clone, Encodable, Decodable)]
1120 pub struct ImportSource {
1122 pub did: Option<ast::DefId>,
1125 impl Clean<ViewPath> for ast::ViewPath {
1126 fn clean(&self) -> ViewPath {
1128 ast::ViewPathSimple(ref i, ref p, id) =>
1129 SimpleImport(i.clean(), resolve_use_source(p.clean(), id)),
1130 ast::ViewPathGlob(ref p, id) =>
1131 GlobImport(resolve_use_source(p.clean(), id)),
1132 ast::ViewPathList(ref p, ref pl, id) => {
1133 ImportList(resolve_use_source(p.clean(), id),
1134 pl.clean().move_iter().collect())
1140 #[deriving(Clone, Encodable, Decodable)]
1141 pub struct ViewListIdent {
1143 pub source: Option<ast::DefId>,
1146 impl Clean<ViewListIdent> for ast::PathListIdent {
1147 fn clean(&self) -> ViewListIdent {
1149 name: self.node.name.clean(),
1150 source: resolve_def(self.node.id),
1155 impl Clean<Vec<Item>> for ast::ForeignMod {
1156 fn clean(&self) -> Vec<Item> {
1161 impl Clean<Item> for ast::ForeignItem {
1162 fn clean(&self) -> Item {
1163 let inner = match self.node {
1164 ast::ForeignItemFn(ref decl, ref generics) => {
1165 ForeignFunctionItem(Function {
1167 generics: generics.clean(),
1168 purity: ast::ExternFn,
1171 ast::ForeignItemStatic(ref ty, mutbl) => {
1172 ForeignStaticItem(Static {
1174 mutability: if mutbl {Mutable} else {Immutable},
1180 name: Some(self.ident.clean()),
1181 attrs: self.attrs.clean().move_iter().collect(),
1182 source: self.span.clean(),
1184 visibility: self.vis.clean(),
1193 fn to_src(&self) -> ~str;
1196 impl ToSource for syntax::codemap::Span {
1197 fn to_src(&self) -> ~str {
1198 debug!("converting span {:?} to snippet", self.clean());
1199 let cm = local_data::get(super::ctxtkey, |x| x.unwrap().clone()).sess().codemap().clone();
1200 let sn = match cm.span_to_snippet(*self) {
1204 debug!("got snippet {}", sn);
1209 fn lit_to_str(lit: &ast::Lit) -> ~str {
1211 ast::LitStr(ref st, _) => st.get().to_owned(),
1212 ast::LitBinary(ref data) => format!("{:?}", data.as_slice()),
1213 ast::LitChar(c) => ~"'" + std::char::from_u32(c).unwrap().to_str() + "'",
1214 ast::LitInt(i, _t) => i.to_str(),
1215 ast::LitUint(u, _t) => u.to_str(),
1216 ast::LitIntUnsuffixed(i) => i.to_str(),
1217 ast::LitFloat(ref f, _t) => f.get().to_str(),
1218 ast::LitFloatUnsuffixed(ref f) => f.get().to_str(),
1219 ast::LitBool(b) => b.to_str(),
1224 fn name_from_pat(p: &ast::Pat) -> ~str {
1226 debug!("Trying to get a name from pattern: {:?}", p);
1230 PatWildMulti => ~"..",
1231 PatIdent(_, ref p, _) => path_to_str(p),
1232 PatEnum(ref p, _) => path_to_str(p),
1233 PatStruct(..) => fail!("tried to get argument name from pat_struct, \
1234 which is not allowed in function arguments"),
1235 PatTup(..) => ~"(tuple arg NYI)",
1236 PatUniq(p) => name_from_pat(p),
1237 PatRegion(p) => name_from_pat(p),
1239 warn!("tried to get argument name from PatLit, \
1240 which is silly in function arguments");
1243 PatRange(..) => fail!("tried to get argument name from PatRange, \
1244 which is not allowed in function arguments"),
1245 PatVec(..) => fail!("tried to get argument name from pat_vec, \
1246 which is not allowed in function arguments")
1250 /// Given a Type, resolve it using the def_map
1251 fn resolve_type(path: Path, tpbs: Option<Vec<TyParamBound> >,
1252 id: ast::NodeId) -> Type {
1253 let cx = local_data::get(super::ctxtkey, |x| *x.unwrap());
1254 let tycx = match cx.maybe_typed {
1255 core::Typed(ref tycx) => tycx,
1256 // If we're extracting tests, this return value doesn't matter.
1257 core::NotTyped(_) => return Bool
1259 debug!("searching for {:?} in defmap", id);
1260 let d = match tycx.def_map.borrow().find(&id) {
1263 debug!("could not find {:?} in defmap (`{}`)", id, tycx.map.node_to_str(id));
1264 fail!("Unexpected failure: unresolved id not in defmap (this is a bug!)")
1268 let (def_id, kind) = match d {
1269 ast::DefFn(i, _) => (i, TypeFunction),
1270 ast::DefSelfTy(i) => return Self(i),
1271 ast::DefTy(i) => (i, TypeEnum),
1272 ast::DefTrait(i) => {
1273 debug!("saw DefTrait in def_to_id");
1276 ast::DefPrimTy(p) => match p {
1277 ast::TyStr => return String,
1278 ast::TyBool => return Bool,
1279 _ => return Primitive(p)
1281 ast::DefTyParam(i, _) => return Generic(i.node),
1282 ast::DefStruct(i) => (i, TypeStruct),
1283 ast::DefTyParamBinder(i) => {
1284 debug!("found a typaram_binder, what is it? {}", i);
1285 return TyParamBinder(i);
1287 x => fail!("resolved type maps to a weird def {:?}", x),
1289 if ast_util::is_local(def_id) {
1290 ResolvedPath{ path: path, typarams: tpbs, id: def_id.node }
1292 let fqn = csearch::get_item_path(tycx, def_id);
1293 let fqn = fqn.move_iter().map(|i| i.to_str()).collect();
1299 krate: def_id.krate,
1304 fn resolve_use_source(path: Path, id: ast::NodeId) -> ImportSource {
1307 did: resolve_def(id),
1311 fn resolve_def(id: ast::NodeId) -> Option<ast::DefId> {
1312 let cx = local_data::get(super::ctxtkey, |x| *x.unwrap());
1313 match cx.maybe_typed {
1314 core::Typed(ref tcx) => {
1315 tcx.def_map.borrow().find(&id).map(|&d| ast_util::def_id_of_def(d))
1317 core::NotTyped(_) => None
1321 #[deriving(Clone, Encodable, Decodable)]
1326 impl Clean<Item> for doctree::Macro {
1327 fn clean(&self) -> Item {
1329 name: Some(self.name.clean()),
1330 attrs: self.attrs.clean(),
1331 source: self.where.clean(),
1332 visibility: ast::Public.clean(),
1334 inner: MacroItem(Macro {
1335 source: self.where.to_src(),