src/librustdoc/fold.rs

   1 use crate::clean::*;
   2
   3 crate fn strip_item(mut item: Item) -> Item {
   4     if !matches!(*item.kind, StrippedItem(..)) {
   5         item.kind = box StrippedItem(item.kind);
   6     }
   7     item
   8 }
   9
  10 crate trait DocFolder: Sized {
  11     fn fold_item(&mut self, item: Item) -> Option<Item> {
  12         Some(self.fold_item_recur(item))
  13     }
  14
  15     /// don't override!
  16     fn fold_inner_recur(&mut self, kind: ItemKind) -> ItemKind {
  17         match kind {
  18             StrippedItem(..) => unreachable!(),
  19             ModuleItem(i) => ModuleItem(self.fold_mod(i)),
  20             StructItem(mut i) => {
  21                 let num_fields = i.fields.len();
  22                 i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  23                 i.fields_stripped |=
  24                     num_fields != i.fields.len() || i.fields.iter().any(|f| f.is_stripped());
  25                 StructItem(i)
  26             }
  27             UnionItem(mut i) => {
  28                 let num_fields = i.fields.len();
  29                 i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  30                 i.fields_stripped |=
  31                     num_fields != i.fields.len() || i.fields.iter().any(|f| f.is_stripped());
  32                 UnionItem(i)
  33             }
  34             EnumItem(mut i) => {
  35                 let num_variants = i.variants.len();
  36                 i.variants = i.variants.into_iter().filter_map(|x| self.fold_item(x)).collect();
  37                 i.variants_stripped |=
  38                     num_variants != i.variants.len() || i.variants.iter().any(|f| f.is_stripped());
  39                 EnumItem(i)
  40             }
  41             TraitItem(mut i) => {
  42                 i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
  43                 TraitItem(i)
  44             }
  45             ImplItem(mut i) => {
  46                 i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
  47                 ImplItem(i)
  48             }
  49             VariantItem(i) => {
  50                 match i {
  51                     Variant::Struct(mut j) => {
  52                         let num_fields = j.fields.len();
  53                         j.fields = j.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  54                         j.fields_stripped |= num_fields != j.fields.len()
  55                             || j.fields.iter().any(|f| f.is_stripped());
  56                         VariantItem(Variant::Struct(j))
  57                     }
  58                     Variant::Tuple(fields) => {
  59                         let fields = fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  60                         VariantItem(Variant::Tuple(fields))
  61                     }
  62                     Variant::CLike => VariantItem(Variant::CLike),
  63                 }
  64             }
  65             x => x,
  66         }
  67     }
  68
  69     /// don't override!
  70     fn fold_item_recur(&mut self, mut item: Item) -> Item {
  71         item.kind = box match *item.kind {
  72             StrippedItem(box i) => StrippedItem(box self.fold_inner_recur(i)),
  73             _ => self.fold_inner_recur(*item.kind),
  74         };
  75         item
  76     }
  77
  78     fn fold_mod(&mut self, m: Module) -> Module {
  79         Module {
  80             span: m.span,
  81             items: m.items.into_iter().filter_map(|i| self.fold_item(i)).collect(),
  82         }
  83     }
  84
  85     fn fold_crate(&mut self, mut c: Crate) -> Crate {
  86         c.module = self.fold_item(c.module).unwrap();
  87
  88         {
  89             let external_traits = { std::mem::take(&mut *c.external_traits.borrow_mut()) };
  90             for (k, mut v) in external_traits {
  91                 v.trait_.items =
  92                     v.trait_.items.into_iter().filter_map(|i| self.fold_item(i)).collect();
  93                 c.external_traits.borrow_mut().insert(k, v);
  94             }
  95         }
  96         c
  97     }
  98 }