javaparser-symbol-solver-testing/src/test/test_sourcecode/javaparser_new_src/javaparser-core/com/github/javaparser/JavaParser.java

/*
 * Copyright (C) 2007-2010 Júlio Vilmar Gesser.
 * Copyright (C) 2011, 2013-2016 The JavaParser Team.
 *
 * This file is part of JavaParser.
 * 
 * JavaParser can be used either under the terms of
 * a) the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * b) the terms of the Apache License 
 *
 * You should have received a copy of both licenses in LICENCE.LGPL and
 * LICENCE.APACHE. Please refer to those files for details.
 *
 * JavaParser is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 */

package com.github.javaparser;

import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.ImportDeclaration;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.body.BodyDeclaration;
import com.github.javaparser.ast.comments.CommentsCollection;
import com.github.javaparser.ast.expr.AnnotationExpr;
import com.github.javaparser.ast.expr.Expression;
import com.github.javaparser.ast.stmt.BlockStmt;
import com.github.javaparser.ast.stmt.Statement;

import java.io.*;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.util.Optional;

import static com.github.javaparser.ParseStart.*;
import static com.github.javaparser.Providers.UTF8;
import static com.github.javaparser.Providers.provider;

/**
 * Parse Java source code and creates Abstract Syntax Trees.
 *
 * @author Júlio Vilmar Gesser
 */
public final class JavaParser {
	private final CommentsInserter commentsInserter;

	private ASTParser astParser = null;

	/**
	 * Instantiate the parser with default configuration. Note that parsing can also be done with the static methods on this class.
	 * Creating an instance will reduce setup time between parsing files.
	 */
	public JavaParser() {
		this(new ParserConfiguration());
	}

	/**
	 * Instantiate the parser. Note that parsing can also be done with the static methods on this class.
	 * Creating an instance will reduce setup time between parsing files.
	 */
	public JavaParser(ParserConfiguration configuration) {
		commentsInserter = new CommentsInserter(configuration);
	}

	private ASTParser getParserForProvider(Provider provider) {
		if (astParser == null) {
			astParser = new ASTParser(provider);
		} else {
			astParser.ReInit(provider);
		}
		return astParser;
	}

	/**
	 * Parses source code.
	 * It takes the source code from a Provider.
	 * The start indicates what can be found in the source code (compilation unit, block, import...)
	 *
     * @param start    refer to the constants in ParseStart to see what can be parsed.
     * @param provider refer to Providers to see how you can read source.
     * @param <N>      the subclass of Node that is the result of parsing in the start.
     * @return the parse result, a collection of encountered problems, and some extra data.
     */
	public <N extends Node> ParseResult<N> parse(ParseStart<N> start, Provider provider) {
		try {
            final ASTParser parser = getParserForProvider(provider);
			N resultNode = start.parse(parser);
            final CommentsCollection comments = astParser.getCommentsCollection();
            commentsInserter.insertComments(resultNode, comments.copy().getComments());
            
			return new ParseResult<>(Optional.of(resultNode), parser.problems, Optional.of(astParser.getTokens()), Optional.of(astParser.getCommentsCollection()));
		} catch (ParseException e) {
			return new ParseResult<>(e);
        } catch (TokenMgrException e) {
            return new ParseResult<>(e);
		} finally {
			try {
				provider.close();
			} catch (IOException e) {
				// Since we're done parsing and have our result, we don't care about any errors.
			}
		}
	}

	/**
	 * Parses the Java code contained in the {@link InputStream} and returns a
	 * {@link CompilationUnit} that represents it.
	 *
	 * @param in       {@link InputStream} containing Java source code
	 * @param encoding encoding of the source code
	 * @return CompilationUnit representing the Java source code
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static CompilationUnit parse(final InputStream in, Charset encoding) {
		return simplifiedParse(COMPILATION_UNIT, provider(in, encoding));
	}

	/**
	 * Parses the Java code contained in the {@link InputStream} and returns a
	 * {@link CompilationUnit} that represents it.<br>
	 * Note: Uses UTF-8 encoding
	 *
	 * @param in {@link InputStream} containing Java source code
	 * @return CompilationUnit representing the Java source code
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static CompilationUnit parse(final InputStream in) {
		return parse(in, UTF8);
	}

	/**
	 * Parses the Java code contained in a {@link File} and returns a
	 * {@link CompilationUnit} that represents it.
	 *
	 * @param file     {@link File} containing Java source code
	 * @param encoding encoding of the source code
	 * @return CompilationUnit representing the Java source code
	 * @throws ParseProblemException if the source code has parser errors
     * @throws FileNotFoundException the file was not found
	 */
	public static CompilationUnit parse(final File file, final Charset encoding) throws FileNotFoundException {
		return simplifiedParse(COMPILATION_UNIT, provider(file, encoding));
	}

	/**
	 * Parses the Java code contained in a {@link File} and returns a
	 * {@link CompilationUnit} that represents it.<br>
	 * Note: Uses UTF-8 encoding
	 *
	 * @param file {@link File} containing Java source code
	 * @return CompilationUnit representing the Java source code
	 * @throws ParseProblemException if the source code has parser errors
	 * @throws FileNotFoundException the file was not found
	 */
	public static CompilationUnit parse(final File file) throws FileNotFoundException {
		return simplifiedParse(COMPILATION_UNIT, provider(file));
	}

	/**
	 * Parses the Java code contained in a file and returns a
	 * {@link CompilationUnit} that represents it.
	 *
	 * @param path     path to a file containing Java source code
	 * @param encoding encoding of the source code
	 * @return CompilationUnit representing the Java source code
	 * @throws IOException the path could not be accessed
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static CompilationUnit parse(final Path path, final Charset encoding) throws IOException {
		return simplifiedParse(COMPILATION_UNIT, provider(path, encoding));
	}

	/**
	 * Parses the Java code contained in a file and returns a
	 * {@link CompilationUnit} that represents it.<br>
	 * Note: Uses UTF-8 encoding
	 *
	 * @param path     path to a file containing Java source code
	 * @return CompilationUnit representing the Java source code
	 * @throws ParseProblemException if the source code has parser errors
	 * @throws IOException the path could not be accessed
	 */
	public static CompilationUnit parse(final Path path) throws IOException {
		return simplifiedParse(COMPILATION_UNIT, provider(path));
	}

    /**
     * Parses Java code from a Reader and returns a
     * {@link CompilationUnit} that represents it.<br>
     *
     * @param reader the reader containing Java source code
     * @return CompilationUnit representing the Java source code
     * @throws ParseProblemException if the source code has parser errors
     */
	public static CompilationUnit parse(final Reader reader) {
		return simplifiedParse(COMPILATION_UNIT, provider(reader));
	}

	/**
	 * Parses the Java code contained in code and returns a
	 * {@link CompilationUnit} that represents it.
	 *
	 * @param code             Java source code
	 * @return CompilationUnit representing the Java source code
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static CompilationUnit parse(String code) {
		return simplifiedParse(COMPILATION_UNIT, provider(code));
	}

	/**
	 * Parses the Java block contained in a {@link String} and returns a
	 * {@link BlockStmt} that represents it.
	 *
	 * @param blockStatement {@link String} containing Java block code
	 * @return BlockStmt representing the Java block
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static BlockStmt parseBlock(final String blockStatement) {
		return simplifiedParse(BLOCK, provider(blockStatement));
	}

	/**
	 * Parses the Java statement contained in a {@link String} and returns a
	 * {@link Statement} that represents it.
	 *
	 * @param statement {@link String} containing Java statement code
	 * @return Statement representing the Java statement
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static Statement parseStatement(final String statement) {
		return simplifiedParse(STATEMENT, provider(statement));
	}

	private static <T extends Node> T simplifiedParse(ParseStart<T> context, Provider provider) {
		ParseResult<T> result = new JavaParser(new ParserConfiguration()).parse(context, provider);
		if (result.isSuccessful()) {
			return result.getResult().get();
		}
		throw new ParseProblemException(result.getProblems());
	}

	/**
	 * Parses the Java import contained in a {@link String} and returns a
	 * {@link ImportDeclaration} that represents it.
	 *
	 * @param importDeclaration {@link String} containing Java import code
	 * @return ImportDeclaration representing the Java import declaration
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static ImportDeclaration parseImport(final String importDeclaration) {
		return simplifiedParse(IMPORT_DECLARATION, provider(importDeclaration));
	}

	/**
	 * Parses the Java expression contained in a {@link String} and returns a
	 * {@link Expression} that represents it.
	 *
	 * @param expression {@link String} containing Java expression
	 * @return Expression representing the Java expression
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static Expression parseExpression(final String expression) {
		return simplifiedParse(EXPRESSION, provider(expression));
	}

	/**
	 * Parses the Java annotation contained in a {@link String} and returns a
	 * {@link AnnotationExpr} that represents it.
	 *
	 * @param annotation {@link String} containing Java annotation
	 * @return AnnotationExpr representing the Java annotation
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static AnnotationExpr parseAnnotation(final String annotation) {
		return simplifiedParse(ANNOTATION, provider(annotation));
	}

	/**
	 * Parses the Java annotation body declaration(e.g fields or methods) contained in a
	 * {@link String} and returns a {@link BodyDeclaration} that represents it.
	 *
	 * @param body {@link String} containing Java body declaration
	 * @return BodyDeclaration representing the Java annotation
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static BodyDeclaration<?> parseAnnotationBodyDeclaration(final String body) {
		return simplifiedParse(ANNOTATION_BODY, provider(body));
	}

	/**
	 * Parses a Java class body declaration(e.g fields or methods) and returns a
	 * {@link BodyDeclaration} that represents it.
	 *
	 * @param body the body of a class
	 * @return BodyDeclaration representing the Java class body
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static BodyDeclaration<?> parseClassBodyDeclaration(String body) {
		return simplifiedParse(CLASS_BODY, provider(body));
	}

	/**
	 * Parses a Java interface body declaration(e.g fields or methods) and returns a
	 * {@link BodyDeclaration} that represents it.
	 *
	 * @param body the body of an interface
	 * @return BodyDeclaration representing the Java interface body
	 * @throws ParseProblemException if the source code has parser errors
	 */
	public static BodyDeclaration parseInterfaceBodyDeclaration(String body) {
		return simplifiedParse(INTERFACE_BODY, provider(body));
	}
}