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