Source code

001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2020 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle;
021
022import java.io.File;
023import java.io.IOException;
024import java.io.PrintWriter;
025import java.nio.charset.StandardCharsets;
026import java.util.function.Consumer;
027import java.util.regex.Matcher;
028import java.util.regex.Pattern;
029
030import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
031import com.puppycrawl.tools.checkstyle.api.DetailAST;
032import com.puppycrawl.tools.checkstyle.api.DetailNode;
033import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes;
034import com.puppycrawl.tools.checkstyle.api.TokenTypes;
035import com.puppycrawl.tools.checkstyle.utils.JavadocUtil;
036import picocli.CommandLine;
037import picocli.CommandLine.Command;
038import picocli.CommandLine.Option;
039import picocli.CommandLine.ParameterException;
040import picocli.CommandLine.Parameters;
041import picocli.CommandLine.ParseResult;
042
043/**
044 * This class is used internally in the build process to write a property file
045 * with short descriptions (the first sentences) of TokenTypes constants.
046 * Request: 724871
047 * For IDE plugins (like the eclipse plugin) it would be useful to have
048 * a programmatic access to the first sentence of the TokenType constants,
049 * so they can use them in their configuration gui.
050 *
051 * @noinspection UseOfSystemOutOrSystemErr, unused, ClassIndependentOfModule
052 */
053public final class JavadocPropertiesGenerator {
054
055    /**
056     * This regexp is used to extract the first sentence from the text.
057     * The end of the sentence is determined by the symbol "period", "exclamation mark" or
058     * "question mark", followed by a space or the end of the text.
059     */
060    private static final Pattern END_OF_SENTENCE_PATTERN = Pattern.compile("(.*?[.?!])(\\s|$)");
061
062    /** Max width of the usage help message for this command. */
063    private static final int USAGE_HELP_WIDTH = 100;
064
065    /**
066     * Don't create instance of this class, use the {@link #main(String[])} method instead.
067     */
068    private JavadocPropertiesGenerator() {
069    }
070
071    /**
072     * TokenTypes.properties generator entry point.
073     *
074     * @param args the command line arguments
075     * @throws CheckstyleException if parser or lexer failed or if there is an IO problem
076     **/
077    public static void main(String... args) throws CheckstyleException {
078        final CliOptions cliOptions = new CliOptions();
079        final CommandLine cmd = new CommandLine(cliOptions).setUsageHelpWidth(USAGE_HELP_WIDTH);
080        try {
081            final ParseResult parseResult = cmd.parseArgs(args);
082            if (parseResult.isUsageHelpRequested()) {
083                cmd.usage(System.out);
084            }
085            else {
086                writePropertiesFile(cliOptions);
087            }
088        }
089        catch (ParameterException ex) {
090            System.err.println(ex.getMessage());
091            ex.getCommandLine().usage(System.err);
092        }
093    }
094
095    /**
096     * Creates the .properties file from a .java file.
097     *
098     * @param options the user-specified options
099     * @throws CheckstyleException if a javadoc comment can not be parsed
100     */
101    private static void writePropertiesFile(CliOptions options) throws CheckstyleException {
102        try (PrintWriter writer = new PrintWriter(options.outputFile,
103                StandardCharsets.UTF_8.name())) {
104            final DetailAST top = JavaParser.parseFile(options.inputFile,
105                    JavaParser.Options.WITH_COMMENTS);
106            final DetailAST objBlock = getClassBody(top);
107            if (objBlock != null) {
108                iteratePublicStaticIntFields(objBlock, writer::println);
109            }
110        }
111        catch (IOException ex) {
112            throw new CheckstyleException("Failed to write javadoc properties of '"
113                    + options.inputFile + "' to '" + options.outputFile + "'", ex);
114        }
115    }
116
117    /**
118     * Walks over the type members and push the first javadoc sentence of every
119     * {@code public} {@code static} {@code int} field to the consumer.
120     *
121     * @param objBlock the OBJBLOCK of a class to iterate over its members
122     * @param consumer first javadoc sentence consumer
123     * @throws CheckstyleException if failed to parse a javadoc comment
124     */
125    private static void iteratePublicStaticIntFields(DetailAST objBlock, Consumer<String> consumer)
126            throws CheckstyleException {
127        for (DetailAST member = objBlock.getFirstChild(); member != null;
128                member = member.getNextSibling()) {
129            if (isPublicStaticFinalIntField(member)) {
130                final DetailAST modifiers = member.findFirstToken(TokenTypes.MODIFIERS);
131                final String firstJavadocSentence = getFirstJavadocSentence(modifiers);
132                if (firstJavadocSentence != null) {
133                    consumer.accept(getName(member) + "=" + firstJavadocSentence.trim());
134                }
135            }
136        }
137    }
138
139    /**
140     * Finds the class body of the first class in the DetailAST.
141     *
142     * @param top AST to find the class body
143     * @return OBJBLOCK token if found; {@code null} otherwise
144     */
145    private static DetailAST getClassBody(DetailAST top) {
146        DetailAST ast = top;
147        while (ast != null && ast.getType() != TokenTypes.CLASS_DEF) {
148            ast = ast.getNextSibling();
149        }
150        DetailAST objBlock = null;
151        if (ast != null) {
152            objBlock = ast.findFirstToken(TokenTypes.OBJBLOCK);
153        }
154        return objBlock;
155    }
156
157    /**
158     * Checks that the DetailAST is a {@code public} {@code static} {@code final} {@code int} field.
159     *
160     * @param ast to process
161     * @return {@code true} if matches; {@code false} otherwise
162     */
163    private static boolean isPublicStaticFinalIntField(DetailAST ast) {
164        boolean result = ast.getType() == TokenTypes.VARIABLE_DEF;
165        if (result) {
166            final DetailAST type = ast.findFirstToken(TokenTypes.TYPE);
167            result = type.getFirstChild().getType() == TokenTypes.LITERAL_INT;
168            if (result) {
169                final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
170                result = modifiers.findFirstToken(TokenTypes.LITERAL_PUBLIC) != null
171                    && modifiers.findFirstToken(TokenTypes.LITERAL_STATIC) != null
172                    && modifiers.findFirstToken(TokenTypes.FINAL) != null;
173            }
174        }
175        return result;
176    }
177
178    /**
179     * Extracts the name of an ast.
180     *
181     * @param ast to extract the name
182     * @return the text content of the inner {@code TokenTypes.IDENT} node
183     */
184    private static String getName(DetailAST ast) {
185        return ast.findFirstToken(TokenTypes.IDENT).getText();
186    }
187
188    /**
189     * Extracts the first sentence as HTML formatted text from the comment of an DetailAST.
190     * The end of the sentence is determined by the symbol "period", "exclamation mark" or
191     * "question mark", followed by a space or the end of the text. Inline tags @code and @literal
192     * are converted to HTML code.
193     *
194     * @param ast to extract the first sentence
195     * @return the first sentence of the inner {@code TokenTypes.BLOCK_COMMENT_BEGIN} node
196     *      or {@code null} if the first sentence is absent or malformed (does not end with period)
197     * @throws CheckstyleException if a javadoc comment can not be parsed or an unsupported inline
198     *      tag found
199     */
200    private static String getFirstJavadocSentence(DetailAST ast) throws CheckstyleException {
201        String firstSentence = null;
202        for (DetailAST child = ast.getFirstChild(); child != null && firstSentence == null;
203                child = child.getNextSibling()) {
204            // If there is an annotation, the javadoc comment will be a child of it.
205            if (child.getType() == TokenTypes.ANNOTATION) {
206                firstSentence = getFirstJavadocSentence(child);
207            }
208            // Otherwise, the javadoc comment will be right here.
209            else if (child.getType() == TokenTypes.BLOCK_COMMENT_BEGIN
210                    && JavadocUtil.isJavadocComment(child)) {
211                final DetailNode tree = DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(child);
212                firstSentence = getFirstJavadocSentence(tree);
213            }
214        }
215        return firstSentence;
216    }
217
218    /**
219     * Extracts the first sentence as HTML formatted text from a DetailNode.
220     * The end of the sentence is determined by the symbol "period", "exclamation mark" or
221     * "question mark", followed by a space or the end of the text. Inline tags @code and @literal
222     * are converted to HTML code.
223     *
224     * @param tree to extract the first sentence
225     * @return the first sentence of the node or {@code null} if the first sentence is absent or
226     *      malformed (does not end with any of the end-of-sentence markers)
227     * @throws CheckstyleException if an unsupported inline tag found
228     */
229    private static String getFirstJavadocSentence(DetailNode tree) throws CheckstyleException {
230        String firstSentence = null;
231        final StringBuilder builder = new StringBuilder(128);
232        for (DetailNode node : tree.getChildren()) {
233            if (node.getType() == JavadocTokenTypes.TEXT) {
234                final Matcher matcher = END_OF_SENTENCE_PATTERN.matcher(node.getText());
235                if (matcher.find()) {
236                    // Commit the sentence if an end-of-sentence marker is found.
237                    firstSentence = builder.append(matcher.group(1)).toString();
238                    break;
239                }
240                // Otherwise append the whole line and look for an end-of-sentence marker
241                // on the next line.
242                builder.append(node.getText());
243            }
244            else if (node.getType() == JavadocTokenTypes.JAVADOC_INLINE_TAG) {
245                formatInlineCodeTag(builder, node);
246            }
247            else {
248                formatHtmlElement(builder, node);
249            }
250        }
251        return firstSentence;
252    }
253
254    /**
255     * Converts inline code tag into HTML form.
256     *
257     * @param builder to append
258     * @param inlineTag to format
259     * @throws CheckstyleException if the inline javadoc tag is not a literal nor a code tag
260     */
261    private static void formatInlineCodeTag(StringBuilder builder, DetailNode inlineTag)
262            throws CheckstyleException {
263        boolean wrapWithCodeTag = false;
264        for (DetailNode node : inlineTag.getChildren()) {
265            switch (node.getType()) {
266                case JavadocTokenTypes.CODE_LITERAL:
267                    wrapWithCodeTag = true;
268                    break;
269                // The text to append.
270                case JavadocTokenTypes.TEXT:
271                    if (wrapWithCodeTag) {
272                        builder.append("<code>").append(node.getText()).append("</code>");
273                    }
274                    else {
275                        builder.append(node.getText());
276                    }
277                    break;
278                // Empty content tags.
279                case JavadocTokenTypes.LITERAL_LITERAL:
280                case JavadocTokenTypes.JAVADOC_INLINE_TAG_START:
281                case JavadocTokenTypes.JAVADOC_INLINE_TAG_END:
282                case JavadocTokenTypes.WS:
283                    break;
284                default:
285                    throw new CheckstyleException("Unsupported inline tag "
286                        + JavadocUtil.getTokenName(node.getType()));
287            }
288        }
289    }
290
291    /**
292     * Concatenates the HTML text from AST of a JavadocTokenTypes.HTML_ELEMENT.
293     *
294     * @param builder to append
295     * @param node to format
296     */
297    private static void formatHtmlElement(StringBuilder builder, DetailNode node) {
298        switch (node.getType()) {
299            case JavadocTokenTypes.START:
300            case JavadocTokenTypes.HTML_TAG_NAME:
301            case JavadocTokenTypes.END:
302            case JavadocTokenTypes.TEXT:
303            case JavadocTokenTypes.SLASH:
304                builder.append(node.getText());
305                break;
306            default:
307                for (DetailNode child : node.getChildren()) {
308                    formatHtmlElement(builder, child);
309                }
310                break;
311        }
312    }
313
314    /**
315     * Helper class encapsulating the command line options and positional parameters.
316     */
317    @Command(name = "java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator",
318            mixinStandardHelpOptions = true)
319    private static class CliOptions {
320
321        /**
322         * The command line option to specify the output file.
323         */
324        @Option(names = "--destfile", required = true, description = "The output file.")
325        private File outputFile;
326
327        /**
328         * The command line positional parameter to specify the input file.
329         */
330        @Parameters(index = "0", description = "The input file.")
331        private File inputFile;
332    }
333}