001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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.nio.charset.Charset;
025
026import com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage;
027import com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus;
028import com.puppycrawl.tools.checkstyle.api.DetailAST;
029import com.puppycrawl.tools.checkstyle.api.DetailNode;
030import com.puppycrawl.tools.checkstyle.api.FileText;
031import com.puppycrawl.tools.checkstyle.api.JavadocCommentsTokenTypes;
032import com.puppycrawl.tools.checkstyle.utils.JavadocUtil;
033import com.puppycrawl.tools.checkstyle.utils.ParserUtil;
034
035/**
036 * Parses file as javadoc DetailNode tree and prints to system output stream.
037 */
038public final class DetailNodeTreeStringPrinter {
039
040    /** OS specific line separator. */
041    private static final String LINE_SEPARATOR = System.getProperty("line.separator");
042
043    /** Prevent instances. */
044    private DetailNodeTreeStringPrinter() {
045        // no code
046    }
047
048    /**
049     * Parse a file and print the parse tree.
050     *
051     * @param file the file to print.
052     * @return parse tree as a string
053     * @throws IOException if the file could not be read.
054     */
055    public static String printFileAst(File file) throws IOException {
056        return printTree(parseFile(file), "", "");
057    }
058
059    /**
060     * Parse block comment DetailAST as Javadoc DetailNode tree.
061     *
062     * @param blockComment DetailAST
063     * @return DetailNode tree
064     * @throws IllegalArgumentException if there is an error parsing the Javadoc.
065     */
066    public static DetailNode parseJavadocAsDetailNode(DetailAST blockComment) {
067        final JavadocDetailNodeParser parser = new JavadocDetailNodeParser();
068        final ParseStatus status = parser.parseJavadocComment(blockComment);
069        if (status.getParseErrorMessage() != null) {
070            throw new IllegalArgumentException(getParseErrorMessage(status.getParseErrorMessage()));
071        }
072        return status.getTree();
073    }
074
075    /**
076     * Builds violation base on ParseErrorMessage's violation key, its arguments, etc.
077     *
078     * @param parseErrorMessage ParseErrorMessage
079     * @return error violation
080     */
081    private static String getParseErrorMessage(ParseErrorMessage parseErrorMessage) {
082        final LocalizedMessage message = new LocalizedMessage(
083                "com.puppycrawl.tools.checkstyle.checks.javadoc.messages",
084                DetailNodeTreeStringPrinter.class,
085                parseErrorMessage.getMessageKey(),
086                parseErrorMessage.getMessageArguments());
087        return "[ERROR:" + parseErrorMessage.getLineNumber() + "] " + message.getMessage();
088    }
089
090    /**
091     * Print AST.
092     *
093     * @param ast the root AST node.
094     * @param rootPrefix prefix for the root node
095     * @param prefix prefix for other nodes
096     * @return string AST.
097     */
098    public static String printTree(DetailNode ast, String rootPrefix, String prefix) {
099        final StringBuilder messageBuilder = new StringBuilder(1024);
100        DetailNode node = ast;
101        while (node != null) {
102            if (node.getType() == JavadocCommentsTokenTypes.JAVADOC_CONTENT) {
103                messageBuilder.append(rootPrefix);
104            }
105            else {
106                messageBuilder.append(prefix);
107            }
108            messageBuilder.append(getIndentation(node))
109                    .append(JavadocUtil.getTokenName(node.getType())).append(" -> ")
110                    .append(JavadocUtil.escapeAllControlChars(node.getText())).append(" [")
111                    .append(node.getLineNumber()).append(':').append(node.getColumnNumber() + 1)
112                    .append(']').append(LINE_SEPARATOR)
113                    .append(printTree(node.getFirstChild(), rootPrefix, prefix));
114            node = node.getNextSibling();
115        }
116        return messageBuilder.toString();
117    }
118
119    /**
120     * Get indentation for a node.
121     *
122     * @param node the DetailNode to get the indentation for.
123     * @return the indentation in String format.
124     */
125    private static String getIndentation(DetailNode node) {
126        final boolean isLastChild = node.getNextSibling() == null;
127        DetailNode currentNode = node;
128        final StringBuilder indentation = new StringBuilder(1024);
129        while (currentNode.getParent() != null) {
130            currentNode = currentNode.getParent();
131            if (currentNode.getParent() == null) {
132                if (isLastChild) {
133                    // only ASCII symbols must be used due to
134                    // problems with running tests on Windows
135                    indentation.append("`--");
136                }
137                else {
138                    indentation.append("|--");
139                }
140            }
141            else {
142                if (currentNode.getNextSibling() == null) {
143                    indentation.insert(0, "    ");
144                }
145                else {
146                    indentation.insert(0, "|   ");
147                }
148            }
149        }
150        return indentation.toString();
151    }
152
153    /**
154     * Parse a file and return the parse tree.
155     *
156     * @param file the file to parse.
157     * @return the root node of the parse tree.
158     * @throws IOException if the file could not be read.
159     */
160    private static DetailNode parseFile(File file) throws IOException {
161        final FileText text = new FileText(file, Charset.defaultCharset().name());
162        final DetailAST comment = ParserUtil.createBlockCommentNode(text.getFullText().toString());
163        return parseJavadocAsDetailNode(comment);
164    }
165
166}