jolie.lang.parse.util.ParsingUtils Maven / Gradle / Ivy

Go to download
/***************************************************************************
 *   Copyright 2010 (C) by Fabrizio Montesi 		   *
 *   Copyright (C) 2021-2022 Vicki Mixen 	     	       *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Library General Public License as       *
 *   published by the Free Software Foundation; either version 2 of the    *
 *   License, or (at your option) any later version.                       *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 *                                                                         *
 *   For details about the authors of this software, see the AUTHORS file. *
 ***************************************************************************/

package jolie.lang.parse.util;

import jolie.lang.CodeCheckException;
import jolie.lang.parse.ParserException;
import jolie.lang.parse.Scanner;
import jolie.lang.parse.SemanticVerifier;
import jolie.lang.parse.ast.Program;
import jolie.lang.parse.module.ModuleException;
import jolie.lang.parse.module.ModuleParsingConfiguration;
import jolie.lang.parse.module.Modules;
import jolie.lang.parse.module.Modules.ModuleParsedResult;
import jolie.lang.parse.util.impl.ProgramInspectorCreatorVisitor;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.Map;

/**
 * Utility class for accessing the functionalities of the JOLIE parsing library without having to
 * worry about correctly instantiating all the related objects (parser, scanner, etc.).
 * 
 * @author Fabrizio Montesi
 */
public class ParsingUtils {
	private ParsingUtils() {}

	public static Program parseProgram(
		InputStream inputStream,
		URI source,
		String charset,
		String[] includePaths,
		String[] packagePaths,
		ClassLoader classLoader,
		Map< String, Scanner.Token > definedConstants,
		SemanticVerifier.Configuration semanticConfiguration,
		boolean includeDocumentation )
		throws IOException, ParserException, CodeCheckException, ModuleException {

		ModuleParsingConfiguration configuration = new ModuleParsingConfiguration(
			charset,
			includePaths,
			packagePaths,
			classLoader,
			definedConstants,
			includeDocumentation,
			false );

		ModuleParsedResult parseResult = Modules.parseModule( configuration, inputStream, source );

		SemanticVerifier semanticVerifier = new SemanticVerifier( parseResult.mainProgram(),
			parseResult.symbolTables(), semanticConfiguration );
		semanticVerifier.validate();
		return parseResult.mainProgram();
	}

	public static Program parseProgram(
		InputStream inputStream,
		URI source,
		String charset,
		String[] includePaths,
		String[] packagePaths,
		ClassLoader classLoader,
		Map< String, Scanner.Token > definedConstants,
		String executionTarget,
		boolean includeDocumentation )
		throws IOException, ParserException, CodeCheckException, ModuleException {
		return parseProgram(
			inputStream,
			source,
			charset,
			includePaths,
			packagePaths,
			classLoader,
			definedConstants,
			new SemanticVerifier.Configuration( executionTarget ),
			includeDocumentation );
	}

	/**
	 * Works just like parseProgram, but returns the SemanticVerifier instead. Is used by the
	 * languageserver for the vscode extension
	 * 
	 * @param inputStream
	 * @param source
	 * @param charset
	 * @param includePaths
	 * @param packagePaths
	 * @param classLoader
	 * @param definedConstants
	 * @param semanticConfiguration
	 * @param includeDocumentation
	 * @return the SemanticVerifier
	 * @throws IOException
	 * @throws ParserException
	 * @throws CodeCheckException
	 * @throws ModuleException
	 */
	public static SemanticVerifier parseProgramModule(
		InputStream inputStream,
		URI source,
		String charset,
		String[] includePaths,
		String[] packagePaths,
		ClassLoader classLoader,
		Map< String, Scanner.Token > definedConstants,
		SemanticVerifier.Configuration semanticConfiguration,
		boolean includeDocumentation )
		throws IOException, ParserException, CodeCheckException, ModuleException {
		ModuleParsingConfiguration configuration = new ModuleParsingConfiguration(
			charset,
			includePaths,
			packagePaths,
			classLoader,
			definedConstants,
			includeDocumentation, false );

		ModuleParsedResult parseResult = Modules.parseModule( configuration, inputStream, source );
		SemanticVerifier semanticVerifier = new SemanticVerifier( parseResult.mainProgram(),
			parseResult.symbolTables(), semanticConfiguration );
		semanticVerifier.validate();
		return semanticVerifier;
	}

	/**
	 * Creates a {@link ProgramInspector} for the specified {@link jolie.lang.parse.ast.Program}.
	 * 
	 * @param program the {@link jolie.lang.parse.ast.Program} to inspect
	 * @return a {@link ProgramInspector} for the specified {@link jolie.lang.parse.ast.Program}
	 * @see ProgramInspector
	 */
	public static ProgramInspector createInspector( Program program ) {
		return new ProgramInspectorCreatorVisitor( program ).createInspector();
	}
}