src/librustdoc/fold.rs

   1 use crate::clean::*;
   2
   3 pub(crate) fn strip_item(mut item: Item) -> Item {
   4     if !matches!(*item.kind, StrippedItem(..)) {
   5         item.kind = Box::new(StrippedItem(item.kind));
   6     }
   7     item
   8 }
   9
  10 pub(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                 i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  22                 StructItem(i)
  23             }
  24             UnionItem(mut i) => {
  25                 i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  26                 UnionItem(i)
  27             }
  28             EnumItem(mut i) => {
  29                 i.variants = i.variants.into_iter().filter_map(|x| self.fold_item(x)).collect();
  30                 EnumItem(i)
  31             }
  32             TraitItem(mut i) => {
  33                 i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
  34                 TraitItem(i)
  35             }
  36             ImplItem(mut i) => {
  37                 i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
  38                 ImplItem(i)
  39             }
  40             VariantItem(i) => match i {
  41                 Variant::Struct(mut j) => {
  42                     j.fields = j.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  43                     VariantItem(Variant::Struct(j))
  44                 }
  45                 Variant::Tuple(fields) => {
  46                     let fields = fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
  47                     VariantItem(Variant::Tuple(fields))
  48                 }
  49                 Variant::CLike(disr) => VariantItem(Variant::CLike(disr)),
  50             },
  51             ExternCrateItem { src: _ }
  52             | ImportItem(_)
  53             | FunctionItem(_)
  54             | TypedefItem(_)
  55             | OpaqueTyItem(_)
  56             | StaticItem(_)
  57             | ConstantItem(_)
  58             | TraitAliasItem(_)
  59             | TyMethodItem(_)
  60             | MethodItem(_, _)
  61             | StructFieldItem(_)
  62             | ForeignFunctionItem(_)
  63             | ForeignStaticItem(_)
  64             | ForeignTypeItem
  65             | MacroItem(_)
  66             | ProcMacroItem(_)
  67             | PrimitiveItem(_)
  68             | TyAssocConstItem(..)
  69             | AssocConstItem(..)
  70             | TyAssocTypeItem(..)
  71             | AssocTypeItem(..)
  72             | KeywordItem => kind,
  73         }
  74     }
  75
  76     /// don't override!
  77     fn fold_item_recur(&mut self, mut item: Item) -> Item {
  78         item.kind = Box::new(match *item.kind {
  79             StrippedItem(box i) => StrippedItem(Box::new(self.fold_inner_recur(i))),
  80             _ => self.fold_inner_recur(*item.kind),
  81         });
  82         item
  83     }
  84
  85     fn fold_mod(&mut self, m: Module) -> Module {
  86         Module {
  87             span: m.span,
  88             items: m.items.into_iter().filter_map(|i| self.fold_item(i)).collect(),
  89         }
  90     }
  91
  92     fn fold_crate(&mut self, mut c: Crate) -> Crate {
  93         c.module = self.fold_item(c.module).unwrap();
  94
  95         let external_traits = { std::mem::take(&mut *c.external_traits.borrow_mut()) };
  96         for (k, mut v) in external_traits {
  97             v.items = v.items.into_iter().filter_map(|i| self.fold_item(i)).collect();
  98             c.external_traits.borrow_mut().insert(k, v);
  99         }
 100
 101         c
 102     }
 103 }