src/imports.rs

   1 // Copyright 2015 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 Indent;
  12 use utils;
  13 use syntax::codemap::{self, BytePos, Span};
  14 use codemap::SpanUtils;
  15 use lists::{write_list, itemize_list, ListItem, ListFormatting, SeparatorTactic, definitive_tactic};
  16 use types::rewrite_path;
  17 use rewrite::{Rewrite, RewriteContext};
  18 use visitor::FmtVisitor;
  19 use std::cmp::Ordering;
  20
  21 use syntax::{ast, ptr};
  22
  23 fn path_of(a: &ast::ViewPath_) -> &ast::Path {
  24     match a {
  25         &ast::ViewPath_::ViewPathSimple(_, ref p) => p,
  26         &ast::ViewPath_::ViewPathGlob(ref p) => p,
  27         &ast::ViewPath_::ViewPathList(ref p, _) => p,
  28     }
  29 }
  30
  31 fn compare_path_segments(a: &ast::PathSegment, b: &ast::PathSegment) -> Ordering {
  32     a.identifier.name.as_str().cmp(&b.identifier.name.as_str())
  33 }
  34
  35 fn compare_paths(a: &ast::Path, b: &ast::Path) -> Ordering {
  36     for segment in a.segments.iter().zip(b.segments.iter()) {
  37         let ord = compare_path_segments(segment.0, segment.1);
  38         if ord != Ordering::Equal {
  39             return ord;
  40         }
  41     }
  42     a.segments.len().cmp(&b.segments.len())
  43 }
  44
  45 fn compare_path_list_items(a: &ast::PathListItem, b: &ast::PathListItem) -> Ordering {
  46     let name_ordering = match a.node.name() {
  47         Some(a_name) => {
  48             match b.node.name() {
  49                 Some(b_name) => a_name.name.as_str().cmp(&b_name.name.as_str()),
  50                 None => Ordering::Greater,
  51             }
  52         }
  53         None => {
  54             match b.node.name() {
  55                 Some(_) => Ordering::Less,
  56                 None => Ordering::Equal,
  57             }
  58         }
  59     };
  60     if name_ordering == Ordering::Equal {
  61         match a.node.rename() {
  62             Some(a_rename) => {
  63                 match b.node.rename() {
  64                     Some(b_rename) => a_rename.name.as_str().cmp(&b_rename.name.as_str()),
  65                     None => Ordering::Greater,
  66                 }
  67             }
  68             None => {
  69                 match b.node.name() {
  70                     Some(_) => Ordering::Less,
  71                     None => Ordering::Equal,
  72                 }
  73             }
  74         }
  75     } else {
  76         name_ordering
  77     }
  78 }
  79
  80 fn compare_path_list_item_lists(a_items: &Vec<ast::PathListItem>,
  81                                 b_items: &Vec<ast::PathListItem>)
  82                                 -> Ordering {
  83     let mut a = a_items.clone();
  84     let mut b = b_items.clone();
  85     a.sort_by(|a, b| compare_path_list_items(a, b));
  86     b.sort_by(|a, b| compare_path_list_items(a, b));
  87     for comparison_pair in a.iter().zip(b.iter()) {
  88         let ord = compare_path_list_items(comparison_pair.0, comparison_pair.1);
  89         if ord != Ordering::Equal {
  90             return ord;
  91         }
  92     }
  93     a.len().cmp(&b.len())
  94 }
  95
  96 fn compare_view_path_types(a: &ast::ViewPath_, b: &ast::ViewPath_) -> Ordering {
  97     use syntax::ast::ViewPath_::*;
  98     match (a, b) {
  99         (&ViewPathSimple(..), &ViewPathSimple(..)) => Ordering::Equal,
 100         (&ViewPathSimple(..), _) => Ordering::Less,
 101         (&ViewPathGlob(_), &ViewPathSimple(..)) => Ordering::Greater,
 102         (&ViewPathGlob(_), &ViewPathGlob(_)) => Ordering::Equal,
 103         (&ViewPathGlob(_), &ViewPathList(..)) => Ordering::Less,
 104         (&ViewPathList(_, ref a_items), &ViewPathList(_, ref b_items)) => {
 105             compare_path_list_item_lists(a_items, b_items)
 106         }
 107         (&ViewPathList(..), _) => Ordering::Greater,
 108     }
 109 }
 110
 111 fn compare_view_paths(a: &ast::ViewPath_, b: &ast::ViewPath_) -> Ordering {
 112     match compare_paths(path_of(a), path_of(b)) {
 113         Ordering::Equal => compare_view_path_types(a, b),
 114         cmp => cmp,
 115     }
 116 }
 117
 118 fn compare_use_items(a: &ast::Item, b: &ast::Item) -> Option<Ordering> {
 119     match (&a.node, &b.node) {
 120         (&ast::ItemKind::Use(ref a_vp), &ast::ItemKind::Use(ref b_vp)) => {
 121             Some(compare_view_paths(&a_vp.node, &b_vp.node))
 122         }
 123         _ => None,
 124     }
 125 }
 126
 127 // TODO (some day) remove unused imports, expand globs, compress many single
 128 // imports into a list import.
 129
 130 impl Rewrite for ast::ViewPath {
 131     // Returns an empty string when the ViewPath is empty (like foo::bar::{})
 132     fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
 133         match self.node {
 134             ast::ViewPath_::ViewPathList(_, ref path_list) if path_list.is_empty() => {
 135                 Some(String::new())
 136             }
 137             ast::ViewPath_::ViewPathList(ref path, ref path_list) => {
 138                 rewrite_use_list(width, offset, path, path_list, self.span, context)
 139             }
 140             ast::ViewPath_::ViewPathGlob(_) => {
 141                 // FIXME convert to list?
 142                 None
 143             }
 144             ast::ViewPath_::ViewPathSimple(ident, ref path) => {
 145                 let ident_str = ident.to_string();
 146                 // 4 = " as ".len()
 147                 let budget = try_opt!(width.checked_sub(ident_str.len() + 4));
 148                 let path_str = try_opt!(rewrite_path(context, false, None, path, budget, offset));
 149
 150                 Some(if path.segments.last().unwrap().identifier == ident {
 151                     path_str
 152                 } else {
 153                     format!("{} as {}", path_str, ident_str)
 154                 })
 155             }
 156         }
 157     }
 158 }
 159
 160 impl<'a> FmtVisitor<'a> {
 161     pub fn format_imports(&mut self, use_items: &[ptr::P<ast::Item>]) {
 162         let mut last_pos =
 163             use_items.first().map(|p_i| p_i.span.lo - BytePos(1)).unwrap_or(self.last_pos);
 164         let prefix = codemap::mk_sp(self.last_pos, last_pos);
 165         let mut ordered_use_items = use_items.iter()
 166             .map(|p_i| {
 167                 let new_item = (&*p_i, last_pos);
 168                 last_pos = p_i.span.hi;
 169                 new_item
 170             })
 171             .collect::<Vec<_>>();
 172         // Order the imports by view-path & other import path properties
 173         ordered_use_items.sort_by(|a, b| compare_use_items(a.0, b.0).unwrap());
 174         // First, output the span before the first import
 175         self.format_missing(prefix.hi);
 176         for ordered in ordered_use_items {
 177             // Fake out the formatter by setting `self.last_pos` to the appropriate location before
 178             // each item before visiting it.
 179             self.last_pos = ordered.1;
 180             self.visit_item(&ordered.0);
 181         }
 182         self.last_pos = last_pos;
 183     }
 184
 185     pub fn format_import(&mut self, vis: &ast::Visibility, vp: &ast::ViewPath, span: Span) {
 186         let vis = utils::format_visibility(vis);
 187         let mut offset = self.block_indent;
 188         offset.alignment += vis.len() + "use ".len();
 189         // 1 = ";"
 190         match vp.rewrite(&self.get_context(),
 191                          self.config.max_width - offset.width() - 1,
 192                          offset) {
 193             Some(ref s) if s.is_empty() => {
 194                 // Format up to last newline
 195                 let prev_span = codemap::mk_sp(self.last_pos, source!(self, span).lo);
 196                 let span_end = match self.snippet(prev_span).rfind('\n') {
 197                     Some(offset) => self.last_pos + BytePos(offset as u32),
 198                     None => source!(self, span).lo,
 199                 };
 200                 self.format_missing(span_end);
 201                 self.last_pos = source!(self, span).hi;
 202             }
 203             Some(ref s) => {
 204                 let s = format!("{}use {};", vis, s);
 205                 self.format_missing_with_indent(source!(self, span).lo);
 206                 self.buffer.push_str(&s);
 207                 self.last_pos = source!(self, span).hi;
 208             }
 209             None => {
 210                 self.format_missing_with_indent(source!(self, span).lo);
 211                 self.format_missing(source!(self, span).hi);
 212             }
 213         }
 214     }
 215 }
 216
 217 fn rewrite_single_use_list(path_str: Option<String>, vpi: &ast::PathListItem) -> String {
 218     let path_item_str = if let ast::PathListItemKind::Ident { name, .. } = vpi.node {
 219         // A name.
 220         match path_str {
 221             Some(path_str) => format!("{}::{}", path_str, name),
 222             None => name.to_string(),
 223         }
 224     } else {
 225         // `self`.
 226         match path_str {
 227             Some(path_str) => path_str,
 228             // This catches the import: use {self}, which is a compiler error, so we just
 229             // leave it alone.
 230             None => "{self}".to_owned(),
 231         }
 232     };
 233
 234     append_alias(path_item_str, vpi)
 235 }
 236
 237 fn rewrite_path_item(vpi: &&ast::PathListItem) -> Option<String> {
 238     let path_item_str = match vpi.node {
 239         ast::PathListItemKind::Ident { name, .. } => name.to_string(),
 240         ast::PathListItemKind::Mod { .. } => "self".to_owned(),
 241     };
 242
 243     Some(append_alias(path_item_str, vpi))
 244 }
 245
 246 fn append_alias(path_item_str: String, vpi: &ast::PathListItem) -> String {
 247     match vpi.node {
 248         ast::PathListItemKind::Ident { rename: Some(rename), .. } |
 249         ast::PathListItemKind::Mod { rename: Some(rename), .. } => {
 250             format!("{} as {}", path_item_str, rename)
 251         }
 252         _ => path_item_str,
 253     }
 254 }
 255
 256 // Pretty prints a multi-item import.
 257 // Assumes that path_list.len() > 0.
 258 pub fn rewrite_use_list(width: usize,
 259                         offset: Indent,
 260                         path: &ast::Path,
 261                         path_list: &[ast::PathListItem],
 262                         span: Span,
 263                         context: &RewriteContext)
 264                         -> Option<String> {
 265     // Returns a different option to distinguish `::foo` and `foo`
 266     let opt_path_str = if !path.to_string().is_empty() {
 267         Some(path.to_string())
 268     } else if path.global {
 269         // path is absolute, we return an empty String to avoid a double `::`
 270         Some(String::new())
 271     } else {
 272         None
 273     };
 274
 275     match path_list.len() {
 276         0 => unreachable!(),
 277         1 => return Some(rewrite_single_use_list(opt_path_str, &path_list[0])),
 278         _ => (),
 279     }
 280
 281     // 2 = ::
 282     let path_separation_w = if opt_path_str.is_some() { 2 } else { 0 };
 283     // 1 = {
 284     let supp_indent = path.to_string().len() + path_separation_w + 1;
 285     // 1 = }
 286     let remaining_width = width.checked_sub(supp_indent + 1).unwrap_or(0);
 287
 288     let mut items = {
 289         // Dummy value, see explanation below.
 290         let mut items = vec![ListItem::from_str("")];
 291         let iter = itemize_list(context.codemap,
 292                                 path_list.iter(),
 293                                 "}",
 294                                 |vpi| vpi.span.lo,
 295                                 |vpi| vpi.span.hi,
 296                                 rewrite_path_item,
 297                                 context.codemap.span_after(span, "{"),
 298                                 span.hi);
 299         items.extend(iter);
 300         items
 301     };
 302
 303     // We prefixed the item list with a dummy value so that we can
 304     // potentially move "self" to the front of the vector without touching
 305     // the rest of the items.
 306     let has_self = move_self_to_front(&mut items);
 307     let first_index = if has_self { 0 } else { 1 };
 308
 309     if context.config.reorder_imported_names {
 310         items[1..].sort_by(|a, b| a.item.cmp(&b.item));
 311     }
 312
 313     let tactic = definitive_tactic(&items[first_index..],
 314                                    ::lists::ListTactic::Mixed,
 315                                    remaining_width);
 316     let fmt = ListFormatting {
 317         tactic: tactic,
 318         separator: ",",
 319         trailing_separator: SeparatorTactic::Never,
 320         indent: offset + supp_indent,
 321         // FIXME This is too conservative, and will not use all width
 322         // available
 323         // (loose 1 column (";"))
 324         width: remaining_width,
 325         ends_with_newline: false,
 326         config: context.config,
 327     };
 328     let list_str = try_opt!(write_list(&items[first_index..], &fmt));
 329
 330     Some(match opt_path_str {
 331         Some(opt_path_str) => format!("{}::{{{}}}", opt_path_str, list_str),
 332         None => format!("{{{}}}", list_str),
 333     })
 334 }
 335
 336 // Returns true when self item was found.
 337 fn move_self_to_front(items: &mut Vec<ListItem>) -> bool {
 338     match items.iter().position(|item| item.item.as_ref().map(|x| &x[..]) == Some("self")) {
 339         Some(pos) => {
 340             items[0] = items.remove(pos);
 341             true
 342         }
 343         None => false,
 344     }
 345 }