jolie.lang.parse.module.Modules Maven / Gradle / Ivy

Go to download
package jolie.lang.parse.module;

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

import jolie.lang.parse.ParserException;
import jolie.lang.parse.Scanner;
import jolie.lang.parse.ast.Program;

public class Modules {
	public static class ModuleParsedResult {

		/**
		 * An ast program of root program
		 */
		private final Program mainProgram;

		/**
		 * Collection of symbol table reference for main program execution
		 */
		private final Map< URI, SymbolTable > symbolTables;

		private ModuleParsedResult( Program mainProgram, Map< URI, SymbolTable > symbolTables ) {
			this.mainProgram = mainProgram;
			this.symbolTables = symbolTables;
		}

		public Program mainProgram() {
			return mainProgram;
		}

		public Map< URI, SymbolTable > symbolTables() {
			return symbolTables;
		}
	}

	/**
	 * Global module record cache
	 * 
	 */
	protected static final ModuleRecordCache CACHE = new ModuleRecordCache();

	/**
	 * parses jolie's code stream to ModuleParsedResult, which contains executable ast and it's
	 * symbolTables.
	 * 
	 * Note: this method is meant to be used through the execution of jolie program, as it calls static
	 * crawl method that cache the result
	 * 
	 * @param configuration
	 * @param stream jolie code Inputstream
	 * @param programURI resource URI
	 * @return
	 * @throws ParserException
	 * @throws IOException
	 * @throws ModuleException
	 */
	public static ModuleParsedResult parseModule( ModuleParsingConfiguration configuration, InputStream stream,
		URI programURI )
		throws ParserException, IOException, ModuleException {
		ModuleParser parser = new ModuleParser( configuration );
		ModuleRecord mainRecord = parser.parse(
			new Scanner( stream, programURI, configuration.charset(), configuration.includeDocumentation() ) );
		ModuleFinder finder;

		// TODO: This is a hack for Windows. Re-evaluate in the future.
		if( programURI.toString().contains( "jap:" ) ) {
			finder = new ModuleFinderDummy();
		} else {
			finder = new ModuleFinderImpl( programURI, configuration.packagePaths() );
		}

		ModuleCrawler.CrawlerResult crawlResult = ModuleCrawler.crawl( mainRecord, configuration, finder );

		SymbolReferenceResolver.resolve( crawlResult );

		return new ModuleParsedResult( mainRecord.program(), crawlResult.symbolTables() );
	}



	/**
	 * parses jolie's code stream to ModuleParsedResult, which contains executable ast and it's
	 * symbolTables.
	 * 
	 * Note: this method is meant to be used to parse jolie code, no cache will be store in memory
	 * 
	 * @param configuration
	 * @param stream jolie code Inputstream
	 * @param programURI resource URI
	 * @return
	 * @throws ParserException
	 * @throws IOException
	 * @throws ModuleException
	 */
	public static ModuleParsedResult parseModuleLocal( ModuleParsingConfiguration configuration, InputStream stream,
		URI programURI )
		throws ParserException, IOException, ModuleException {
		ModuleParser parser = new ModuleParser( configuration );
		ModuleRecord mainRecord = parser.parse(
			new Scanner( stream, programURI, configuration.charset(), configuration.includeDocumentation() ) );
		ModuleFinder finder;

		// TODO: This is a hack for Windows. Re-evaluate in the future.
		if( programURI.toString().contains( "jap:" ) ) {
			finder = new ModuleFinderDummy();
		} else {
			finder = new ModuleFinderImpl( programURI, configuration.packagePaths() );
		}

		ModuleCrawler.CrawlerResult crawlResult = ModuleCrawler.crawl( mainRecord, configuration, finder );

		SymbolReferenceResolver.resolve( crawlResult );

		return new ModuleParsedResult( mainRecord.program(), crawlResult.symbolTables() );
	}


	/**
	 * Clear the module cache entry
	 * 
	 * @param source source of module
	 */
	public static void freeCache( URI source ) {
		Modules.CACHE.remove( source );
	}
}