src/tools/clippy/clippy_lints/src/tabs_in_doc_comments.rs

   1 use clippy_utils::diagnostics::span_lint_and_sugg;
   2 use rustc_ast::ast;
   3 use rustc_errors::Applicability;
   4 use rustc_lint::{EarlyContext, EarlyLintPass};
   5 use rustc_session::{declare_lint_pass, declare_tool_lint};
   6 use rustc_span::source_map::{BytePos, Span};
   7 use std::convert::TryFrom;
   8
   9 declare_clippy_lint! {
  10     /// **What it does:** Checks doc comments for usage of tab characters.
  11     ///
  12     /// **Why is this bad?** The rust style-guide promotes spaces instead of tabs for indentation.
  13     /// To keep a consistent view on the source, also doc comments should not have tabs.
  14     /// Also, explaining ascii-diagrams containing tabs can get displayed incorrectly when the
  15     /// display settings of the author and reader differ.
  16     ///
  17     /// **Known problems:** None.
  18     ///
  19     /// **Example:**
  20     /// ```rust
  21     /// ///
  22     /// /// Struct to hold two strings:
  23     /// ///     - first         one
  24     /// ///     - second        one
  25     /// pub struct DoubleString {
  26     ///    ///
  27     ///    ///  - First String:
  28     ///    ///          - needs to be inside here
  29     ///    first_string: String,
  30     ///    ///
  31     ///    ///  - Second String:
  32     ///    ///          - needs to be inside here
  33     ///    second_string: String,
  34     ///}
  35     /// ```
  36     ///
  37     /// Will be converted to:
  38     /// ```rust
  39     /// ///
  40     /// /// Struct to hold two strings:
  41     /// ///     - first        one
  42     /// ///     - second    one
  43     /// pub struct DoubleString {
  44     ///    ///
  45     ///    ///     - First String:
  46     ///    ///         - needs to be inside here
  47     ///    first_string: String,
  48     ///    ///
  49     ///    ///     - Second String:
  50     ///    ///         - needs to be inside here
  51     ///    second_string: String,
  52     ///}
  53     /// ```
  54     pub TABS_IN_DOC_COMMENTS,
  55     style,
  56     "using tabs in doc comments is not recommended"
  57 }
  58
  59 declare_lint_pass!(TabsInDocComments => [TABS_IN_DOC_COMMENTS]);
  60
  61 impl TabsInDocComments {
  62     fn warn_if_tabs_in_doc(cx: &EarlyContext<'_>, attr: &ast::Attribute) {
  63         if let ast::AttrKind::DocComment(_, comment) = attr.kind {
  64             let comment = comment.as_str();
  65
  66             for (lo, hi) in get_chunks_of_tabs(&comment) {
  67                 // +3 skips the opening delimiter
  68                 let new_span = Span::new(
  69                     attr.span.lo() + BytePos(3 + lo),
  70                     attr.span.lo() + BytePos(3 + hi),
  71                     attr.span.ctxt(),
  72                 );
  73                 span_lint_and_sugg(
  74                     cx,
  75                     TABS_IN_DOC_COMMENTS,
  76                     new_span,
  77                     "using tabs in doc comments is not recommended",
  78                     "consider using four spaces per tab",
  79                     "    ".repeat((hi - lo) as usize),
  80                     Applicability::MaybeIncorrect,
  81                 );
  82             }
  83         }
  84     }
  85 }
  86
  87 impl EarlyLintPass for TabsInDocComments {
  88     fn check_attribute(&mut self, cx: &EarlyContext<'_>, attribute: &ast::Attribute) {
  89         Self::warn_if_tabs_in_doc(cx, attribute);
  90     }
  91 }
  92
  93 ///
  94 /// scans the string for groups of tabs and returns the start(inclusive) and end positions
  95 /// (exclusive) of all groups
  96 /// e.g. "sd\tasd\t\taa" will be converted to [(2, 3), (6, 8)] as
  97 ///       012 3456 7 89
  98 ///         ^-^  ^---^
  99 fn get_chunks_of_tabs(the_str: &str) -> Vec<(u32, u32)> {
 100     let line_length_way_to_long = "doc comment longer than 2^32 chars";
 101     let mut spans: Vec<(u32, u32)> = vec![];
 102     let mut current_start: u32 = 0;
 103
 104     // tracker to decide if the last group of tabs is not closed by a non-tab character
 105     let mut is_active = false;
 106
 107     // Note that we specifically need the char _byte_ indices here, not the positional indexes
 108     // within the char array to deal with multi-byte characters properly. `char_indices` does
 109     // exactly that. It provides an iterator over tuples of the form `(byte position, char)`.
 110     let char_indices: Vec<_> = the_str.char_indices().collect();
 111
 112     if let [(_, '\t')] = char_indices.as_slice() {
 113         return vec![(0, 1)];
 114     }
 115
 116     for entry in char_indices.windows(2) {
 117         match entry {
 118             [(_, '\t'), (_, '\t')] => {
 119                 // either string starts with double tab, then we have to set it active,
 120                 // otherwise is_active is true anyway
 121                 is_active = true;
 122             },
 123             [(_, _), (index_b, '\t')] => {
 124                 // as ['\t', '\t'] is excluded, this has to be a start of a tab group,
 125                 // set indices accordingly
 126                 is_active = true;
 127                 current_start = u32::try_from(*index_b).unwrap();
 128             },
 129             [(_, '\t'), (index_b, _)] => {
 130                 // this now has to be an end of the group, hence we have to push a new tuple
 131                 is_active = false;
 132                 spans.push((current_start, u32::try_from(*index_b).unwrap()));
 133             },
 134             _ => {},
 135         }
 136     }
 137
 138     // only possible when tabs are at the end, insert last group
 139     if is_active {
 140         spans.push((
 141             current_start,
 142             u32::try_from(char_indices.last().unwrap().0 + 1).expect(line_length_way_to_long),
 143         ));
 144     }
 145
 146     spans
 147 }
 148
 149 #[cfg(test)]
 150 mod tests_for_get_chunks_of_tabs {
 151     use super::get_chunks_of_tabs;
 152
 153     #[test]
 154     fn test_unicode_han_string() {
 155         let res = get_chunks_of_tabs(" \u{4f4d}\t");
 156
 157         assert_eq!(res, vec![(4, 5)]);
 158     }
 159
 160     #[test]
 161     fn test_empty_string() {
 162         let res = get_chunks_of_tabs("");
 163
 164         assert_eq!(res, vec![]);
 165     }
 166
 167     #[test]
 168     fn test_simple() {
 169         let res = get_chunks_of_tabs("sd\t\t\taa");
 170
 171         assert_eq!(res, vec![(2, 5)]);
 172     }
 173
 174     #[test]
 175     fn test_only_t() {
 176         let res = get_chunks_of_tabs("\t\t");
 177
 178         assert_eq!(res, vec![(0, 2)]);
 179     }
 180
 181     #[test]
 182     fn test_only_one_t() {
 183         let res = get_chunks_of_tabs("\t");
 184
 185         assert_eq!(res, vec![(0, 1)]);
 186     }
 187
 188     #[test]
 189     fn test_double() {
 190         let res = get_chunks_of_tabs("sd\tasd\t\taa");
 191
 192         assert_eq!(res, vec![(2, 3), (6, 8)]);
 193     }
 194
 195     #[test]
 196     fn test_start() {
 197         let res = get_chunks_of_tabs("\t\taa");
 198
 199         assert_eq!(res, vec![(0, 2)]);
 200     }
 201
 202     #[test]
 203     fn test_end() {
 204         let res = get_chunks_of_tabs("aa\t\t");
 205
 206         assert_eq!(res, vec![(2, 4)]);
 207     }
 208
 209     #[test]
 210     fn test_start_single() {
 211         let res = get_chunks_of_tabs("\taa");
 212
 213         assert_eq!(res, vec![(0, 1)]);
 214     }
 215
 216     #[test]
 217     fn test_end_single() {
 218         let res = get_chunks_of_tabs("aa\t");
 219
 220         assert_eq!(res, vec![(2, 3)]);
 221     }
 222
 223     #[test]
 224     fn test_no_tabs() {
 225         let res = get_chunks_of_tabs("dsfs");
 226
 227         assert_eq!(res, vec![]);
 228     }
 229 }