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.
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.
11 use config::WriteMode;
12 use visitor::FmtVisitor;
13 use syntax::codemap::{self, BytePos, Span, Pos};
14 use comment::{CodeCharKind, CommentCodeSlices, rewrite_comment};
17 impl<'a> FmtVisitor<'a> {
18 fn output_at_start(&self) -> bool {
22 // TODO these format_missing methods are ugly. Refactor and add unit tests
23 // for the central whitespace stripping loop.
24 pub fn format_missing(&mut self, end: BytePos) {
25 self.format_missing_inner(end,
26 |this, last_snippet, _| this.buffer.push_str(last_snippet))
29 pub fn format_missing_with_indent(&mut self, end: BytePos) {
30 let config = self.config;
31 self.format_missing_inner(end, |this, last_snippet, snippet| {
32 this.buffer.push_str(last_snippet.trim_right());
33 if last_snippet == snippet && !this.output_at_start() {
34 // No new lines in the snippet.
35 this.buffer.push_str("\n");
37 let indent = this.block_indent.to_string(config);
38 this.buffer.push_str(&indent);
42 pub fn format_missing_no_indent(&mut self, end: BytePos) {
43 self.format_missing_inner(end, |this, last_snippet, _| {
44 this.buffer.push_str(last_snippet.trim_right());
48 fn format_missing_inner<F: Fn(&mut FmtVisitor, &str, &str)>(&mut self,
50 process_last_snippet: F) {
51 let start = self.last_pos;
54 // Do nothing if this is the beginning of the file.
55 if !self.output_at_start() {
56 process_last_snippet(self, "", "");
62 "Request to format inverted span: {:?} to {:?}",
63 self.codemap.lookup_char_pos(start),
64 self.codemap.lookup_char_pos(end));
67 let span = codemap::mk_sp(start, end);
69 self.write_snippet(span, &process_last_snippet);
72 fn write_snippet<F>(&mut self, span: Span, process_last_snippet: F)
73 where F: Fn(&mut FmtVisitor, &str, &str)
75 // Get a snippet from the file start to the span's hi without allocating.
76 // We need it to determine what precedes the current comment. If the comment
77 // follows code on the same line, we won't touch it.
78 let big_span_lo = self.codemap.lookup_char_pos(span.lo).file.start_pos;
79 let local_begin = self.codemap.lookup_byte_offset(big_span_lo);
80 let local_end = self.codemap.lookup_byte_offset(span.hi);
81 let start_index = local_begin.pos.to_usize();
82 let end_index = local_end.pos.to_usize();
83 let big_snippet = &local_begin.fm.src.as_ref().unwrap()[start_index..end_index];
85 let big_diff = (span.lo - big_span_lo).to_usize();
86 let snippet = self.snippet(span.clone());
88 debug!("write_snippet `{}`", snippet);
90 self.write_snippet_inner(big_snippet, big_diff, &snippet, span, process_last_snippet);
93 fn write_snippet_inner<F>(&mut self,
98 process_last_snippet: F)
99 where F: Fn(&mut FmtVisitor, &str, &str)
101 // Trim whitespace from the right hand side of each line.
102 // Annoyingly, the library functions for splitting by lines etc. are not
103 // quite right, so we must do it ourselves.
104 let mut line_start = 0;
105 let mut last_wspace = None;
106 let mut rewrite_next_comment = true;
108 let char_pos = self.codemap.lookup_char_pos(span.lo);
109 let file_name = &char_pos.file.name;
110 let mut cur_line = char_pos.line;
112 fn replace_chars(string: &str) -> String {
115 .map(|ch| if ch.is_whitespace() { ch } else { 'X' })
119 let replaced = match self.config.write_mode {
120 WriteMode::Coverage => replace_chars(old_snippet),
121 _ => old_snippet.to_owned(),
123 let snippet = &*replaced;
125 for (kind, offset, subslice) in CommentCodeSlices::new(snippet) {
126 debug!("{:?}: {:?}", kind, subslice);
128 if let CodeCharKind::Comment = kind {
129 let last_char = big_snippet[..(offset + big_diff)]
132 .skip_while(|rev_c| [' ', '\t'].contains(rev_c))
135 let fix_indent = last_char.map_or(true, |rev_c| ['{', '\n'].contains(&rev_c));
137 let subslice_num_lines = subslice.chars().filter(|c| *c == '\n').count();
139 if rewrite_next_comment &&
142 .intersects_range(file_name, cur_line, cur_line + subslice_num_lines) {
143 rewrite_next_comment = false;
146 if rewrite_next_comment {
148 if let Some('{') = last_char {
149 self.buffer.push_str("\n");
152 .push_str(&self.block_indent.to_string(self.config));
154 self.buffer.push_str(" ");
157 let comment_width = ::std::cmp::min(self.config.comment_width,
158 self.config.max_width -
159 self.block_indent.width());
161 self.buffer.push_str(&rewrite_comment(subslice,
163 Shape::legacy(comment_width,
169 line_start = offset + subslice.len();
171 if let Some('/') = subslice.chars().skip(1).next() {
172 // check that there are no contained block comments
175 .map(|s| s.trim_left())
176 .any(|s| s.len() > 2 && &s[0..2] == "/*") {
177 // Add a newline after line comments
178 self.buffer.push_str("\n");
180 } else if line_start <= snippet.len() {
181 // For other comments add a newline if there isn't one at the end already
182 match snippet[line_start..].chars().next() {
183 Some('\n') | Some('\r') => (),
184 _ => self.buffer.push_str("\n"),
188 cur_line += subslice_num_lines;
191 rewrite_next_comment = false;
195 for (mut i, c) in subslice.char_indices() {
199 if !self.config.file_lines.contains_line(file_name, cur_line) {
203 if let Some(lw) = last_wspace {
204 self.buffer.push_str(&snippet[line_start..lw]);
205 self.buffer.push_str("\n");
207 self.buffer.push_str(&snippet[line_start..i + 1]);
213 rewrite_next_comment = rewrite_next_comment || kind == CodeCharKind::Normal;
214 } else if c.is_whitespace() {
215 if last_wspace.is_none() {
216 last_wspace = Some(i);
219 if last_wspace.is_some() {
223 rewrite_next_comment = rewrite_next_comment || kind == CodeCharKind::Normal;
226 rewrite_next_comment = rewrite_next_comment || kind == CodeCharKind::Normal;
231 let remaining = snippet[line_start..subslice.len() + offset].trim();
232 if !remaining.is_empty() {
233 self.buffer.push_str(remaining);
234 line_start = subslice.len() + offset;
235 rewrite_next_comment = rewrite_next_comment || kind == CodeCharKind::Normal;
239 process_last_snippet(self, &snippet[line_start..], snippet);