]> git.lizzy.rs Git - rust.git/blobdiff - src/visitor.rs
Merge pull request #128 from marcusklaas/subexpr
[rust.git] / src / visitor.rs
index c15b3c34af061cc5c926e83dc9aa5e46680e5bc1..1b1fd9d17c64a13bd34039a327a47be94e3d569a 100644 (file)
 use syntax::ast;
 use syntax::codemap::{self, CodeMap, Span, BytePos};
 use syntax::visit;
+use syntax::parse::token;
+use syntax::attr;
+use std::path::PathBuf;
 
 use utils;
+use config::Config;
+use comment::FindUncommented;
 
-use SKIP_ANNOTATION;
 use changes::ChangeSet;
+use rewrite::{Rewrite, RewriteContext};
 
 pub struct FmtVisitor<'a> {
     pub codemap: &'a CodeMap,
@@ -23,6 +28,7 @@ pub struct FmtVisitor<'a> {
     pub last_pos: BytePos,
     // TODO RAII util for indenting
     pub block_indent: usize,
+    pub config: &'a Config,
 }
 
 impl<'a, 'v> visit::Visitor<'v> for FmtVisitor<'a> {
@@ -32,9 +38,15 @@ fn visit_expr(&mut self, ex: &'v ast::Expr) {
                self.codemap.lookup_char_pos(ex.span.hi));
         self.format_missing(ex.span.lo);
         let offset = self.changes.cur_offset_span(ex.span);
-        let new_str = self.rewrite_expr(ex, config!(max_width) - offset, offset);
-        self.changes.push_str_span(ex.span, &new_str);
-        self.last_pos = ex.span.hi;
+        let context = RewriteContext { codemap: self.codemap,
+                                       config: self.config,
+                                       block_indent: self.block_indent, };
+        let rewrite = ex.rewrite(&context, self.config.max_width - offset, offset);
+
+        if let Some(new_str) = rewrite {
+            self.changes.push_str_span(ex.span, &new_str);
+            self.last_pos = ex.span.hi;
+        }
     }
 
     fn visit_stmt(&mut self, stmt: &'v ast::Stmt) {
@@ -65,7 +77,7 @@ fn visit_block(&mut self, b: &'v ast::Block) {
 
         self.changes.push_str_span(b.span, "{");
         self.last_pos = self.last_pos + BytePos(1);
-        self.block_indent += config!(tab_spaces);
+        self.block_indent += self.config.tab_spaces;
 
         for stmt in &b.stmts {
             self.visit_stmt(&stmt)
@@ -78,7 +90,7 @@ fn visit_block(&mut self, b: &'v ast::Block) {
             None => {}
         }
 
-        self.block_indent -= config!(tab_spaces);
+        self.block_indent -= self.config.tab_spaces;
         // TODO we should compress any newlines here to just one
         self.format_missing_with_indent(b.span.hi - BytePos(1));
         self.changes.push_str_span(b.span, "}");
@@ -113,7 +125,7 @@ fn visit_fn(&mut self,
                                              constness,
                                              abi,
                                              vis,
-                                             b.span.lo);
+                                             codemap::mk_sp(s.lo, b.span.lo));
                 self.changes.push_str_span(s, &new_fn);
             }
             visit::FkMethod(ident, ref sig, vis) => {
@@ -126,7 +138,7 @@ fn visit_fn(&mut self,
                                              &sig.constness,
                                              &sig.abi,
                                              vis.unwrap_or(ast::Visibility::Inherited),
-                                             b.span.lo);
+                                             codemap::mk_sp(s.lo, b.span.lo));
                 self.changes.push_str_span(s, &new_fn);
             }
             visit::FkFnBlock(..) => {}
@@ -152,34 +164,49 @@ fn visit_item(&mut self, item: &'v ast::Item) {
 
         match item.node {
             ast::Item_::ItemUse(ref vp) => {
-                self.format_missing_with_indent(item.span.lo);
                 match vp.node {
                     ast::ViewPath_::ViewPathList(ref path, ref path_list) => {
                         let block_indent = self.block_indent;
-                        let one_line_budget = config!(max_width) - block_indent;
-                        let multi_line_budget = config!(ideal_width) - block_indent;
-                        let new_str = self.rewrite_use_list(block_indent,
-                                                            one_line_budget,
-                                                            multi_line_budget,
-                                                            path,
-                                                            path_list,
-                                                            item.vis);
-                        self.changes.push_str_span(item.span, &new_str);
+                        let one_line_budget = self.config.max_width - block_indent;
+                        let multi_line_budget = self.config.ideal_width - block_indent;
+                        let formatted = self.rewrite_use_list(block_indent,
+                                                              one_line_budget,
+                                                              multi_line_budget,
+                                                              path,
+                                                              path_list,
+                                                              item.vis,
+                                                              item.span);
+
+                        if let Some(new_str) = formatted {
+                            self.format_missing_with_indent(item.span.lo);
+                            self.changes.push_str_span(item.span, &new_str);
+                        } else {
+                            // Format up to last newline
+                            let span = codemap::mk_sp(self.last_pos, item.span.lo);
+                            let span_end = match self.snippet(span).rfind('\n') {
+                                Some(offset) => self.last_pos + BytePos(offset as u32),
+                                None => item.span.lo
+                            };
+                            self.format_missing(span_end);
+                        }
+
                         self.last_pos = item.span.hi;
                     }
                     ast::ViewPath_::ViewPathGlob(_) => {
+                        self.format_missing_with_indent(item.span.lo);
                         // FIXME convert to list?
                     }
-                    ast::ViewPath_::ViewPathSimple(_,_) => {}
+                    ast::ViewPath_::ViewPathSimple(_,_) => {
+                        self.format_missing_with_indent(item.span.lo);
+                    }
                 }
                 visit::walk_item(self, item);
             }
             ast::Item_::ItemImpl(..) |
-            ast::Item_::ItemMod(_) |
             ast::Item_::ItemTrait(..) => {
-                self.block_indent += config!(tab_spaces);
+                self.block_indent += self.config.tab_spaces;
                 visit::walk_item(self, item);
-                self.block_indent -= config!(tab_spaces);
+                self.block_indent -= self.config.tab_spaces;
             }
             ast::Item_::ItemExternCrate(_) => {
                 self.format_missing_with_indent(item.span.lo);
@@ -196,6 +223,19 @@ fn visit_item(&mut self, item: &'v ast::Item) {
                                   item.span);
                 self.last_pos = item.span.hi;
             }
+            ast::Item_::ItemEnum(ref def, ref generics) => {
+                self.format_missing_with_indent(item.span.lo);
+                self.visit_enum(item.ident,
+                                item.vis,
+                                def,
+                                generics,
+                                item.span);
+                self.last_pos = item.span.hi;
+            }
+            ast::Item_::ItemMod(ref module) => {
+                self.format_missing_with_indent(item.span.lo);
+                self.format_mod(module, item.span, item.ident, &item.attrs);
+            }
             _ => {
                 visit::walk_item(self, item);
             }
@@ -236,23 +276,19 @@ fn visit_mac(&mut self, mac: &'v ast::Mac) {
     }
 
     fn visit_mod(&mut self, m: &'v ast::Mod, s: Span, _: ast::NodeId) {
-        // Only visit inline mods here.
-        if self.codemap.lookup_char_pos(s.lo).file.name !=
-           self.codemap.lookup_char_pos(m.inner.lo).file.name {
-            return;
-        }
-        visit::walk_mod(self, m);
+        // This is only called for the root module
+        let filename = self.codemap.span_to_filename(s);
+        self.format_separate_mod(m, &filename);
     }
 }
 
 impl<'a> FmtVisitor<'a> {
-    pub fn from_codemap<'b>(codemap: &'b CodeMap) -> FmtVisitor<'b> {
-        FmtVisitor {
-            codemap: codemap,
-            changes: ChangeSet::from_codemap(codemap),
-            last_pos: BytePos(0),
-            block_indent: 0,
-        }
+    pub fn from_codemap<'b>(codemap: &'b CodeMap, config: &'b Config) -> FmtVisitor<'b> {
+        FmtVisitor { codemap: codemap,
+                     changes: ChangeSet::from_codemap(codemap),
+                     last_pos: BytePos(0),
+                     block_indent: 0,
+                     config: config, }
     }
 
     pub fn snippet(&self, span: Span) -> String {
@@ -276,26 +312,22 @@ pub fn visit_attrs(&mut self, attrs: &[ast::Attribute]) -> bool {
         let first = &attrs[0];
         self.format_missing_with_indent(first.span.lo);
 
-        match self.rewrite_attrs(attrs, self.block_indent) {
-            Some(s) => {
-                self.changes.push_str_span(first.span, &s);
-                let last = attrs.last().unwrap();
-                self.last_pos = last.span.hi;
-                false
-            }
-            None => true
+        if utils::contains_skip(attrs) {
+            true
+        } else {
+            let rewrite = self.rewrite_attrs(attrs, self.block_indent);
+            self.changes.push_str_span(first.span, &rewrite);
+            let last = attrs.last().unwrap();
+            self.last_pos = last.span.hi;
+            false
         }
     }
 
-    fn rewrite_attrs(&self, attrs: &[ast::Attribute], indent: usize) -> Option<String> {
+    pub fn rewrite_attrs(&self, attrs: &[ast::Attribute], indent: usize) -> String {
         let mut result = String::new();
         let indent = utils::make_indent(indent);
 
         for (i, a) in attrs.iter().enumerate() {
-            if is_skip(&a.node.value) {
-                return None;
-            }
-
             let a_str = self.snippet(a.span);
 
             if i > 0 {
@@ -322,13 +354,84 @@ fn rewrite_attrs(&self, attrs: &[ast::Attribute], indent: usize) -> Option<Strin
             }
         }
 
-        Some(result)
+        result
+    }
+
+    fn format_mod(&mut self, m: &ast::Mod, s: Span, ident: ast::Ident, attrs: &[ast::Attribute]) {
+        debug!("FmtVisitor::format_mod: ident: {:?}, span: {:?}", ident, s);
+        // Decide whether this is an inline mod or an external mod.
+        // There isn't any difference between inline and external mod in AST,
+        // so we use the trick of searching for an opening brace.
+        // We can't use the inner span of the mod since it is weird when it
+        // is empty (no items).
+        // FIXME Use the inner span once rust-lang/rust#26755 is fixed.
+        let open_brace = self.codemap.span_to_snippet(s).unwrap().find_uncommented("{");
+        match open_brace {
+            None => {
+                debug!("FmtVisitor::format_mod: external mod");
+                let file_path = self.module_file(ident, attrs, s);
+                let filename = file_path.to_str().unwrap();
+                if self.changes.is_changed(filename) {
+                    // The file has already been reformatted, do nothing
+                } else {
+                    self.format_separate_mod(m, filename);
+                }
+                // TODO Should rewrite properly `mod X;`
+            }
+            Some(open_brace) => {
+                debug!("FmtVisitor::format_mod: internal mod");
+                debug!("... open_brace: {}, str: {:?}", open_brace, self.codemap.span_to_snippet(s));
+                // Format everything until opening brace
+                // TODO Shoud rewrite properly
+                self.format_missing(s.lo + BytePos(open_brace as u32));
+                self.block_indent += self.config.tab_spaces;
+                visit::walk_mod(self, m);
+                debug!("... last_pos after: {:?}", self.last_pos);
+                self.block_indent -= self.config.tab_spaces;
+            }
+        }
+        self.format_missing(s.hi);
+        debug!("FmtVisitor::format_mod: exit");
     }
-}
 
-fn is_skip(meta_item: &ast::MetaItem) -> bool {
-    match meta_item.node {
-        ast::MetaItem_::MetaWord(ref s) => *s == SKIP_ANNOTATION,
-        _ => false,
+    /// Find the file corresponding to an external mod
+    /// Same algorithm as syntax::parse::eval_src_mod
+    fn module_file(&self, id: ast::Ident, outer_attrs: &[ast::Attribute], id_sp: Span) -> PathBuf {
+        // FIXME use libsyntax once rust-lang/rust#26750 is merged
+        let mut prefix = PathBuf::from(&self.codemap.span_to_filename(id_sp));
+        prefix.pop();
+        let mod_string = token::get_ident(id);
+        match attr::first_attr_value_str_by_name(outer_attrs, "path") {
+            Some(d) => prefix.join(&*d),
+            None => {
+                let default_path_str = format!("{}.rs", mod_string);
+                let secondary_path_str = format!("{}/mod.rs", mod_string);
+                let default_path = prefix.join(&default_path_str);
+                let secondary_path = prefix.join(&secondary_path_str);
+                let default_exists = self.codemap.file_exists(&default_path);
+                let secondary_exists = self.codemap.file_exists(&secondary_path);
+                if default_exists {
+                    default_path
+                } else if secondary_exists {
+                    secondary_path
+                } else {
+                    // Should never appens since rustc parsed everything sucessfully
+                    panic!("Didn't found module {}", mod_string);
+                }
+            }
+        }
+    }
+
+    /// Format the content of a module into a separate file
+    fn format_separate_mod(&mut self, m: &ast::Mod, filename: &str) {
+        let last_pos = self.last_pos;
+        let block_indent = self.block_indent;
+        let filemap = self.codemap.get_filemap(filename);
+        self.last_pos = filemap.start_pos;
+        self.block_indent = 0;
+        visit::walk_mod(self, m);
+        self.format_missing(filemap.end_pos);
+        self.last_pos = last_pos;
+        self.block_indent = block_indent;
     }
 }