1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.sizes;
21
22 import java.io.File;
23 import java.util.regex.Pattern;
24
25 import com.puppycrawl.tools.checkstyle.StatelessCheck;
26 import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
27 import com.puppycrawl.tools.checkstyle.api.FileText;
28 import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
29
30 /**
31 * <div>
32 * Checks for long lines.
33 * </div>
34 *
35 * <p>
36 * Rationale: Long lines are hard to read in printouts or if developers
37 * have limited screen space for the source code, e.g. if the IDE displays
38 * additional information like project tree, class hierarchy, etc.
39 * </p>
40 * <ul>
41 * <li>
42 * The calculation of the length of a line takes into account the number of
43 * expanded spaces for a tab character ({@code '\t'}). The default number of spaces is {@code 8}.
44 * To specify a different number of spaces, the user can set
45 * <a href="https://checkstyle.org/config.html#Checker">{@code Checker}</a>
46 * property {@code tabWidth} which applies to all Checks, including {@code LineLength};
47 * or can set property {@code tabWidth} for {@code LineLength} alone.
48 * </li>
49 * <li>
50 * By default, package and import statements (lines matching pattern {@code ^(package|import) .*})
51 * are not verified by this check.
52 * </li>
53 * <li>
54 * Trailing comments are taken into consideration while calculating the line length.
55 * <pre>
56 * import java.util.regex.Pattern; // The length of this comment will be taken into consideration
57 * </pre>
58 * In the example above the length of the import statement is just 31 characters but total length
59 * will be 94 characters.
60 * </li>
61 * </ul>
62 * <ul>
63 * <li>
64 * Property {@code fileExtensions} - Specify the file extensions of the files to process.
65 * Type is {@code java.lang.String[]}.
66 * Default value is {@code ""}.
67 * </li>
68 * <li>
69 * Property {@code ignorePattern} - Specify pattern for lines to ignore.
70 * Type is {@code java.util.regex.Pattern}.
71 * Default value is {@code "^(package|import) .*"}.
72 * </li>
73 * <li>
74 * Property {@code max} - Specify the maximum line length allowed.
75 * Type is {@code int}.
76 * Default value is {@code 80}.
77 * </li>
78 * </ul>
79 *
80 * <p>
81 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
82 * </p>
83 *
84 * <p>
85 * Violation Message Keys:
86 * </p>
87 * <ul>
88 * <li>
89 * {@code maxLineLen}
90 * </li>
91 * </ul>
92 *
93 * @since 3.0
94 */
95 @StatelessCheck
96 public class LineLengthCheck extends AbstractFileSetCheck {
97
98 /**
99 * A key is pointing to the warning message text in "messages.properties"
100 * file.
101 */
102 public static final String MSG_KEY = "maxLineLen";
103
104 /** Default maximum number of columns in a line. */
105 private static final int DEFAULT_MAX_COLUMNS = 80;
106
107 /** Specify the maximum line length allowed. */
108 private int max = DEFAULT_MAX_COLUMNS;
109
110 /** Specify pattern for lines to ignore. */
111 private Pattern ignorePattern = Pattern.compile("^(package|import) .*");
112
113 @Override
114 protected void processFiltered(File file, FileText fileText) {
115 for (int i = 0; i < fileText.size(); i++) {
116 final String line = fileText.get(i);
117 final int realLength = CommonUtil.lengthExpandedTabs(
118 line, line.codePointCount(0, line.length()), getTabWidth());
119
120 if (realLength > max && !ignorePattern.matcher(line).find()) {
121 log(i + 1, MSG_KEY, max, realLength);
122 }
123 }
124 }
125
126 /**
127 * Setter to specify the maximum line length allowed.
128 *
129 * @param length the maximum length of a line
130 * @since 3.0
131 */
132 public void setMax(int length) {
133 max = length;
134 }
135
136 /**
137 * Setter to specify pattern for lines to ignore.
138 *
139 * @param pattern a pattern.
140 * @since 3.0
141 */
142 public final void setIgnorePattern(Pattern pattern) {
143 ignorePattern = pattern;
144 }
145
146 }