src/librustdoc/fold.rs

   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.
   4 //
   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.
  10
  11 use std::mem;
  12
  13 use clean::*;
  14
  15 pub struct StripItem(pub Item);
  16
  17 impl StripItem {
  18     pub fn strip(self) -> Option<Item> {
  19         match self.0 {
  20             Item { inner: StrippedItem(..), .. } => Some(self.0),
  21             mut i => {
  22                 i.inner = StrippedItem(box i.inner);
  23                 Some(i)
  24             }
  25         }
  26     }
  27 }
  28
  29 pub trait DocFolder : Sized {
  30     fn fold_item(&mut self, item: Item) -> Option<Item> {
  31         self.fold_item_recur(item)
  32     }
  33
  34     /// don't override!
  35     fn fold_inner_recur(&mut self, inner: ItemEnum) -> ItemEnum {
  36         match inner {
  37             StrippedItem(..) => unreachable!(),
  38             ModuleItem(i) => {
  39                 ModuleItem(self.fold_mod(i))
  40             },
  41             StructItem(mut i) => {
  42                 let num_fields = i.fields.len();
  43                 i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  44                 i.fields_stripped |= num_fields != i.fields.len() ||
  45                                      i.fields.iter().any(|f| f.is_stripped());
  46                 StructItem(i)
  47             },
  48             UnionItem(mut i) => {
  49                 let num_fields = i.fields.len();
  50                 i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  51                 i.fields_stripped |= num_fields != i.fields.len() ||
  52                                      i.fields.iter().any(|f| f.is_stripped());
  53                 UnionItem(i)
  54             },
  55             EnumItem(mut i) => {
  56                 let num_variants = i.variants.len();
  57                 i.variants = i.variants.into_iter().filter_map(|x| self.fold_item(x)).collect();
  58                 i.variants_stripped |= num_variants != i.variants.len() ||
  59                                        i.variants.iter().any(|f| f.is_stripped());
  60                 EnumItem(i)
  61             },
  62             TraitItem(mut i) => {
  63                 i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
  64                 TraitItem(i)
  65             },
  66             ImplItem(mut i) => {
  67                 i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
  68                 ImplItem(i)
  69             },
  70             VariantItem(i) => {
  71                 let i2 = i.clone(); // this clone is small
  72                 match i.kind {
  73                     VariantKind::Struct(mut j) => {
  74                         let num_fields = j.fields.len();
  75                         j.fields = j.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  76                         j.fields_stripped |= num_fields != j.fields.len() ||
  77                                              j.fields.iter().any(|f| f.is_stripped());
  78                         VariantItem(Variant {kind: VariantKind::Struct(j), ..i2})
  79                     },
  80                     _ => VariantItem(i2)
  81                 }
  82             },
  83             x => x
  84         }
  85     }
  86
  87     /// don't override!
  88     fn fold_item_recur(&mut self, item: Item) -> Option<Item> {
  89         let Item {
  90             attrs,
  91             name,
  92             source,
  93             visibility,
  94             def_id,
  95             inner,
  96             stability,
  97             deprecation,
  98         } = item;
  99
 100         let inner = match inner {
 101             StrippedItem(box i) => StrippedItem(box self.fold_inner_recur(i)),
 102             _ => self.fold_inner_recur(inner),
 103         };
 104
 105         Some(Item { attrs, name, source, inner, visibility,
 106                     stability, deprecation, def_id })
 107     }
 108
 109     fn fold_mod(&mut self, m: Module) -> Module {
 110         Module {
 111             is_crate: m.is_crate,
 112             items: m.items.into_iter().filter_map(|i| self.fold_item(i)).collect()
 113         }
 114     }
 115
 116     fn fold_crate(&mut self, mut c: Crate) -> Crate {
 117         c.module = c.module.take().and_then(|module| self.fold_item(module));
 118
 119         let traits = mem::replace(&mut c.external_traits, Default::default());
 120         c.external_traits.extend(traits.into_iter().map(|(k, mut v)| {
 121             v.items = v.items.into_iter().filter_map(|i| self.fold_item(i)).collect();
 122             (k, v)
 123         }));
 124         c
 125     }
 126 }