src/librustdoc/passes.rs

   1 // Copyright 2012-2014 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 rustc::middle::def_id::DefId;
  12 use rustc::middle::privacy::AccessLevels;
  13 use rustc::util::nodemap::DefIdSet;
  14 use std::cmp;
  15 use std::string::String;
  16 use std::usize;
  17 use rustc_front::hir;
  18
  19 use clean::{self, Attributes};
  20 use clean::Item;
  21 use plugins;
  22 use fold;
  23 use fold::DocFolder;
  24
  25 /// Strip items marked `#[doc(hidden)]`
  26 pub fn strip_hidden(krate: clean::Crate) -> plugins::PluginResult {
  27     let mut stripped = DefIdSet();
  28
  29     // strip all #[doc(hidden)] items
  30     let krate = {
  31         struct Stripper<'a> {
  32             stripped: &'a mut DefIdSet
  33         }
  34         impl<'a> fold::DocFolder for Stripper<'a> {
  35             fn fold_item(&mut self, i: Item) -> Option<Item> {
  36                 if i.attrs.list_def("doc").has_word("hidden") {
  37                     debug!("found one in strip_hidden; removing");
  38                     self.stripped.insert(i.def_id);
  39
  40                     // use a dedicated hidden item for given item type if any
  41                     match i.inner {
  42                         clean::StructFieldItem(..) => {
  43                             return Some(clean::Item {
  44                                 inner: clean::StructFieldItem(clean::HiddenStructField),
  45                                 ..i
  46                             });
  47                         }
  48                         _ => {
  49                             return None;
  50                         }
  51                     }
  52                 }
  53
  54                 self.fold_item_recur(i)
  55             }
  56         }
  57         let mut stripper = Stripper{ stripped: &mut stripped };
  58         stripper.fold_crate(krate)
  59     };
  60
  61     // strip any traits implemented on stripped items
  62     let krate = {
  63         struct ImplStripper<'a> {
  64             stripped: &'a mut DefIdSet
  65         }
  66         impl<'a> fold::DocFolder for ImplStripper<'a> {
  67             fn fold_item(&mut self, i: Item) -> Option<Item> {
  68                 if let clean::ImplItem(clean::Impl{
  69                            for_: clean::ResolvedPath{ did, .. },
  70                            ref trait_, ..
  71                 }) = i.inner {
  72                     // Impls for stripped types don't need to exist
  73                     if self.stripped.contains(&did) {
  74                         return None;
  75                     }
  76                     // Impls of stripped traits also don't need to exist
  77                     if let Some(clean::ResolvedPath { did, .. }) = *trait_ {
  78                         if self.stripped.contains(&did) {
  79                             return None;
  80                         }
  81                     }
  82                 }
  83                 self.fold_item_recur(i)
  84             }
  85         }
  86         let mut stripper = ImplStripper{ stripped: &mut stripped };
  87         stripper.fold_crate(krate)
  88     };
  89
  90     (krate, None)
  91 }
  92
  93 /// Strip private items from the point of view of a crate or externally from a
  94 /// crate, specified by the `xcrate` flag.
  95 pub fn strip_private(mut krate: clean::Crate) -> plugins::PluginResult {
  96     // This stripper collects all *retained* nodes.
  97     let mut retained = DefIdSet();
  98     let analysis = super::ANALYSISKEY.with(|a| a.clone());
  99     let analysis = analysis.borrow();
 100     let analysis = analysis.as_ref().unwrap();
 101     let access_levels = analysis.access_levels.clone();
 102
 103     // strip all private items
 104     {
 105         let mut stripper = Stripper {
 106             retained: &mut retained,
 107             access_levels: &access_levels,
 108         };
 109         krate = stripper.fold_crate(krate);
 110     }
 111
 112     // strip all private implementations of traits
 113     {
 114         let mut stripper = ImplStripper(&retained);
 115         krate = stripper.fold_crate(krate);
 116     }
 117     (krate, None)
 118 }
 119
 120 struct Stripper<'a> {
 121     retained: &'a mut DefIdSet,
 122     access_levels: &'a AccessLevels<DefId>,
 123 }
 124
 125 impl<'a> fold::DocFolder for Stripper<'a> {
 126     fn fold_item(&mut self, i: Item) -> Option<Item> {
 127         match i.inner {
 128             // These items can all get re-exported
 129             clean::TypedefItem(..) | clean::StaticItem(..) |
 130             clean::StructItem(..) | clean::EnumItem(..) |
 131             clean::TraitItem(..) | clean::FunctionItem(..) |
 132             clean::VariantItem(..) | clean::MethodItem(..) |
 133             clean::ForeignFunctionItem(..) | clean::ForeignStaticItem(..) => {
 134                 if i.def_id.is_local() {
 135                     if !self.access_levels.is_exported(i.def_id) {
 136                         return None;
 137                     }
 138                 }
 139             }
 140
 141             clean::ConstantItem(..) => {
 142                 if i.def_id.is_local() && !self.access_levels.is_exported(i.def_id) {
 143                     return None;
 144                 }
 145             }
 146
 147             clean::ExternCrateItem(..) | clean::ImportItem(_) => {
 148                 if i.visibility != Some(hir::Public) {
 149                     return None
 150                 }
 151             }
 152
 153             clean::StructFieldItem(..) => {
 154                 if i.visibility != Some(hir::Public) {
 155                     return Some(clean::Item {
 156                         inner: clean::StructFieldItem(clean::HiddenStructField),
 157                         ..i
 158                     })
 159                 }
 160             }
 161
 162             // handled below
 163             clean::ModuleItem(..) => {}
 164
 165             // trait impls for private items should be stripped
 166             clean::ImplItem(clean::Impl{
 167                 for_: clean::ResolvedPath{ did, .. }, ..
 168             }) => {
 169                 if did.is_local() && !self.access_levels.is_exported(did) {
 170                     return None;
 171                 }
 172             }
 173             clean::DefaultImplItem(..) | clean::ImplItem(..) => {}
 174
 175             // tymethods/macros have no control over privacy
 176             clean::MacroItem(..) | clean::TyMethodItem(..) => {}
 177
 178             // Primitives are never stripped
 179             clean::PrimitiveItem(..) => {}
 180
 181             // Associated consts and types are never stripped
 182             clean::AssociatedConstItem(..) |
 183             clean::AssociatedTypeItem(..) => {}
 184         }
 185
 186         let fastreturn = match i.inner {
 187             // nothing left to do for traits (don't want to filter their
 188             // methods out, visibility controlled by the trait)
 189             clean::TraitItem(..) => true,
 190
 191             // implementations of traits are always public.
 192             clean::ImplItem(ref imp) if imp.trait_.is_some() => true,
 193
 194             // Struct variant fields have inherited visibility
 195             clean::VariantItem(clean::Variant {
 196                 kind: clean::StructVariant(..)
 197             }) => true,
 198             _ => false,
 199         };
 200
 201         let i = if fastreturn {
 202             self.retained.insert(i.def_id);
 203             return Some(i);
 204         } else {
 205             self.fold_item_recur(i)
 206         };
 207
 208         i.and_then(|i| {
 209             match i.inner {
 210                 // emptied modules/impls have no need to exist
 211                 clean::ModuleItem(ref m)
 212                     if m.items.is_empty() &&
 213                        i.doc_value().is_none() => None,
 214                 clean::ImplItem(ref i) if i.items.is_empty() => None,
 215                 _ => {
 216                     self.retained.insert(i.def_id);
 217                     Some(i)
 218                 }
 219             }
 220         })
 221     }
 222 }
 223
 224 // This stripper discards all private impls of traits
 225 struct ImplStripper<'a>(&'a DefIdSet);
 226 impl<'a> fold::DocFolder for ImplStripper<'a> {
 227     fn fold_item(&mut self, i: Item) -> Option<Item> {
 228         if let clean::ImplItem(ref imp) = i.inner {
 229             match imp.trait_ {
 230                 Some(clean::ResolvedPath{ did, .. }) => {
 231                     if did.is_local() && !self.0.contains(&did) {
 232                         return None;
 233                     }
 234                 }
 235                 Some(..) | None => {}
 236             }
 237         }
 238         self.fold_item_recur(i)
 239     }
 240 }
 241
 242
 243 pub fn unindent_comments(krate: clean::Crate) -> plugins::PluginResult {
 244     struct CommentCleaner;
 245     impl fold::DocFolder for CommentCleaner {
 246         fn fold_item(&mut self, mut i: Item) -> Option<Item> {
 247             let mut avec: Vec<clean::Attribute> = Vec::new();
 248             for attr in &i.attrs {
 249                 match attr {
 250                     &clean::NameValue(ref x, ref s)
 251                             if "doc" == *x => {
 252                         avec.push(clean::NameValue("doc".to_string(),
 253                                                    unindent(s)))
 254                     }
 255                     x => avec.push(x.clone())
 256                 }
 257             }
 258             i.attrs = avec;
 259             self.fold_item_recur(i)
 260         }
 261     }
 262     let mut cleaner = CommentCleaner;
 263     let krate = cleaner.fold_crate(krate);
 264     (krate, None)
 265 }
 266
 267 pub fn collapse_docs(krate: clean::Crate) -> plugins::PluginResult {
 268     struct Collapser;
 269     impl fold::DocFolder for Collapser {
 270         fn fold_item(&mut self, mut i: Item) -> Option<Item> {
 271             let mut docstr = String::new();
 272             for attr in &i.attrs {
 273                 if let clean::NameValue(ref x, ref s) = *attr {
 274                     if "doc" == *x {
 275                         docstr.push_str(s);
 276                         docstr.push('\n');
 277                     }
 278                 }
 279             }
 280             let mut a: Vec<clean::Attribute> = i.attrs.iter().filter(|&a| match a {
 281                 &clean::NameValue(ref x, _) if "doc" == *x => false,
 282                 _ => true
 283             }).cloned().collect();
 284             if !docstr.is_empty() {
 285                 a.push(clean::NameValue("doc".to_string(), docstr));
 286             }
 287             i.attrs = a;
 288             self.fold_item_recur(i)
 289         }
 290     }
 291     let mut collapser = Collapser;
 292     let krate = collapser.fold_crate(krate);
 293     (krate, None)
 294 }
 295
 296 pub fn unindent(s: &str) -> String {
 297     let lines = s.lines().collect::<Vec<&str> >();
 298     let mut saw_first_line = false;
 299     let mut saw_second_line = false;
 300     let min_indent = lines.iter().fold(usize::MAX, |min_indent, line| {
 301
 302         // After we see the first non-whitespace line, look at
 303         // the line we have. If it is not whitespace, and therefore
 304         // part of the first paragraph, then ignore the indentation
 305         // level of the first line
 306         let ignore_previous_indents =
 307             saw_first_line &&
 308             !saw_second_line &&
 309             !line.chars().all(|c| c.is_whitespace());
 310
 311         let min_indent = if ignore_previous_indents {
 312             usize::MAX
 313         } else {
 314             min_indent
 315         };
 316
 317         if saw_first_line {
 318             saw_second_line = true;
 319         }
 320
 321         if line.chars().all(|c| c.is_whitespace()) {
 322             min_indent
 323         } else {
 324             saw_first_line = true;
 325             let mut whitespace = 0;
 326             line.chars().all(|char| {
 327                 // Compare against either space or tab, ignoring whether they
 328                 // are mixed or not
 329                 if char == ' ' || char == '\t' {
 330                     whitespace += 1;
 331                     true
 332                 } else {
 333                     false
 334                 }
 335             });
 336             cmp::min(min_indent, whitespace)
 337         }
 338     });
 339
 340     if !lines.is_empty() {
 341         let mut unindented = vec![ lines[0].trim().to_string() ];
 342         unindented.extend_from_slice(&lines[1..].iter().map(|&line| {
 343             if line.chars().all(|c| c.is_whitespace()) {
 344                 line.to_string()
 345             } else {
 346                 assert!(line.len() >= min_indent);
 347                 line[min_indent..].to_string()
 348             }
 349         }).collect::<Vec<_>>());
 350         unindented.join("\n")
 351     } else {
 352         s.to_string()
 353     }
 354 }
 355
 356 #[cfg(test)]
 357 mod unindent_tests {
 358     use super::unindent;
 359
 360     #[test]
 361     fn should_unindent() {
 362         let s = "    line1\n    line2".to_string();
 363         let r = unindent(&s);
 364         assert_eq!(r, "line1\nline2");
 365     }
 366
 367     #[test]
 368     fn should_unindent_multiple_paragraphs() {
 369         let s = "    line1\n\n    line2".to_string();
 370         let r = unindent(&s);
 371         assert_eq!(r, "line1\n\nline2");
 372     }
 373
 374     #[test]
 375     fn should_leave_multiple_indent_levels() {
 376         // Line 2 is indented another level beyond the
 377         // base indentation and should be preserved
 378         let s = "    line1\n\n        line2".to_string();
 379         let r = unindent(&s);
 380         assert_eq!(r, "line1\n\n    line2");
 381     }
 382
 383     #[test]
 384     fn should_ignore_first_line_indent() {
 385         // The first line of the first paragraph may not be indented as
 386         // far due to the way the doc string was written:
 387         //
 388         // #[doc = "Start way over here
 389         //          and continue here"]
 390         let s = "line1\n    line2".to_string();
 391         let r = unindent(&s);
 392         assert_eq!(r, "line1\nline2");
 393     }
 394
 395     #[test]
 396     fn should_not_ignore_first_line_indent_in_a_single_line_para() {
 397         let s = "line1\n\n    line2".to_string();
 398         let r = unindent(&s);
 399         assert_eq!(r, "line1\n\n    line2");
 400     }
 401
 402     #[test]
 403     fn should_unindent_tabs() {
 404         let s = "\tline1\n\tline2".to_string();
 405         let r = unindent(&s);
 406         assert_eq!(r, "line1\nline2");
 407     }
 408
 409     #[test]
 410     fn should_trim_mixed_indentation() {
 411         let s = "\t    line1\n\t    line2".to_string();
 412         let r = unindent(&s);
 413         assert_eq!(r, "line1\nline2");
 414
 415         let s = "    \tline1\n    \tline2".to_string();
 416         let r = unindent(&s);
 417         assert_eq!(r, "line1\nline2");
 418     }
 419 }