Application: gvSIG desktop » gvSIG scripting

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.scripting.lib.api</artifactId>

	<packaging>jar</packaging>

	<name>org.gvsig.scripting.lib.api</name>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.scripting.lib</artifactId>

		<version>2.3.220</version>

	</parent>

	<dependencies>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.lib</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.lib</artifactId>

			<type>test-jar</type>

			<scope>test</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.i18n</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>javax.help</groupId>

			<artifactId>javahelp</artifactId>

			<scope>compile</scope>

		</dependency>

	</dependencies>

	<build>

		<plugins>

			<plugin>

				<groupId>org.apache.maven.plugins</groupId>

				<artifactId>maven-jar-plugin</artifactId>

				<configuration>

				</configuration>

				<executions>

					<!--

						Generates a jar file only with the test classes

					-->

					<execution>

						<goals>

							<goal>test-jar</goal>

						</goals>

					</execution>

				</executions>

			</plugin>

		</plugins>

	</build>

</project>

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

Put into this folder the resources needed by your test classes.

This folder is added to the Tests classpath, so you can load any resources 

through the ClassLoader.

By default, in this folder you can find an example of log4j configuration,

prepared to log messages through the console, so logging works when you

run your tests classes.

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]\n  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	DefaultExampleManager class.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig.scripting.impl.DefaultExampleManager">

		<priority value="DEBUG" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

package org.gvsig.scripting;

import java.io.File;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestManager extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		manager = ScriptingLocator.getManager();

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public void testUserFolderPath(){

		setWorkingFolder();

		Assert.assertEquals(manager.getRootUserFolder().getAbsolutePath(), manager.getUserFolder().getFile().getAbsolutePath());

	}

	public void testExistsScriptId(){

		setWorkingFolder();

		manager.createUnit(ScriptingManager.UNIT_SCRIPT,manager.getUserFolder(),"test_script.py");

		Assert.assertEquals(false, manager.validateUnitId(manager.getUserFolder(),"test_script"));

		Assert.assertEquals(true, manager.validateUnitId(manager.getUserFolder(),"test_script2"));

		deleteWorkingFolderContent();

	}

	public void checkUnitValues(ScriptingUnit unit1, ScriptingUnit unit2){

		Assert.assertEquals(unit1.getId(),unit2.getId());

		Assert.assertEquals(unit1.getName(),unit2.getName());

	}

	public void testRegisteringSystemFolders(){

		ScriptingFolder folder_parent = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(), "test");

		ScriptingFolder folder = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,folder_parent, "test");

		ScriptingScript script = (ScriptingScript)manager.createUnit(ScriptingManager.UNIT_SCRIPT,folder, "test_script.py");

		manager.registerSystemFolder("test", folder.getFile());

		List<ScriptingUnit> units = manager.getSystemFolder().getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		ScriptingUnit unit = null;

		while(it.hasNext()){

			unit = it.next();

			checkUnitValues(unit, folder);

		}

		Assert.assertNotNull(unit);

		ScriptingScript script2 = (ScriptingScript) manager.getScript(new File(((ScriptingFolder)unit).getFile(),script.getId()+".py"));

		checkUnitValues(script,script2);

		deleteWorkingFolderContent();

	}

}

package org.gvsig.scripting;

import java.io.File;

import java.util.Iterator;

import java.util.List;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestFolder extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		manager = ScriptingLocator.getManager();

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

		if(file.exists()){

			file.mkdir();

		}

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public File getFile(ScriptingFolder folder, String name){

		return new File(folder.getFile(),name);

	}

	public void checkFolder(ScriptingFolder folder, String fName){

		File ffolder = getFile(folder, fName);

		Assert.assertTrue(ffolder.exists());

		Assert.assertTrue(ffolder.isDirectory());

	}

	public void checkScriptDefaultValues(ScriptingScript script){

		Assert.assertEquals("test_script", script.getId());

		Assert.assertEquals("test_script", script.getName());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

	}

	public void testCreation(){

		deleteWorkingFolderContent();

		ScriptingFolder folder = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(),"test_folder");

		checkFolder(manager.getUserFolder(),folder.getId());

	}

	public void testList(){

		testCreation();

		ScriptingFolder folder = manager.getFolder(getFile(manager.getUserFolder(),"test_folder"));

		ScriptingScript script = (ScriptingScript) manager.createUnit(ScriptingManager.UNIT_SCRIPT,folder, "test_script.py");

        List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			checkScriptDefaultValues((ScriptingScript) unit);

		}

		folder.remove(script);

		Assert.assertTrue(folder.getUnits().isEmpty());

	}

	public void testRename(){

		testCreation();

		ScriptingFolder folder = manager.getFolder(getFile(manager.getUserFolder(),"test_folder"));

		Assert.assertFalse(folder.rename("test_folder"));

		Assert.assertTrue(folder.rename("test_folder2"));

		Assert.assertEquals("test_folder2", folder.getName());

		deleteWorkingFolderContent();

	}

	public void testMove(){

		testCreation();

		ScriptingScript script = (ScriptingScript) manager.createUnit(ScriptingManager.UNIT_SCRIPT,manager.getUserFolder(), "test_script.py");	

		ScriptingFolder folder = manager.getFolder(getFile(manager.getUserFolder(),"test_folder"));

		Assert.assertEquals(script.getParent().getFile().getAbsolutePath(),manager.getUserFolder().getFile().getAbsolutePath());

		folder.add(script);

		Assert.assertEquals(script.getParent(),folder);

		deleteWorkingFolderContent();

	}

}

package org.gvsig.scripting;

import java.io.BufferedWriter;

import java.io.File;

import java.io.FileWriter;

import java.io.IOException;

import java.util.Iterator;

import java.util.List;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestDialog extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		manager = ScriptingLocator.getManager();

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public File getFile(String name){

		return new File(manager.getRootUserFolder()+File.separator+name);

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public void checkFile(String fName){

		File fscript = getFile(fName);

		Assert.assertTrue(fscript.exists());

	}

	public void checkScriptDefaultValues(ScriptingDialog script){

		Assert.assertEquals("test_dialog", script.getId());

		Assert.assertEquals("test_dialog", script.getName());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

	}

	public void checkScriptNewValues(ScriptingDialog script){

		Assert.assertEquals("test_dialog", script.getId());

		Assert.assertEquals("TestDialog", script.getName());

		Assert.assertEquals("Tests sobre dialogs", script.getDescription());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

		Assert.assertEquals("creator", script.getCreatedBy());

		Assert.assertEquals("v1.0", script.getVersion());

		Assert.assertEquals("def hola():\n  return 'hola mundo'\n",script.getCode());

	}

	public void testCreation(){

		deleteWorkingFolderContent();

		setWorkingFolder();

		ScriptingDialog script = (ScriptingDialog) manager.createUnit(ScriptingManager.UNIT_DIALOG,manager.getUserFolder(),"test_dialog.py");

		script.save();

		checkFile("test_dialog.py");

		checkFile("test_dialog.dlg");

		checkFile("test_dialog.inf");

		checkScriptDefaultValues(script);

	}

	public void testOpen(){

		testCreation();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		checkScriptDefaultValues(script);

		deleteWorkingFolderContent();

	}

	public void testSave(){

		testCreation();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		script.setName("TestDialog");

		script.setDescription("Tests sobre dialogs");

		script.setCode("def hola():\n  return 'hola mundo'\n");

		script.setCreatedBy("creator");

		script.setVersion("v1.0");

		script.save();

		File f = script.getDialogFile();

		try {

			BufferedWriter bw = new BufferedWriter(new FileWriter(f));

			bw.write("<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\n" + 

					"<panel columns=\"1\">\n" +

					"\t<button action=\"hola\" text=\"press\"/>\n" + 

					"</panel>");

		} catch (IOException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		}

		script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		checkScriptNewValues(script);

	}

	public void testRename(){

		deleteWorkingFolderContent();

		testCreation();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		Assert.assertFalse(script.rename("test_dialog"));

		Assert.assertTrue(script.rename("test_dialog2"));

		script = (ScriptingDialog) manager.getScript(getFile("test_dialog2.py"));

		Assert.assertEquals("test_dialog2", script.getId());

		File f = getFile("test_dialog.py");

		Assert.assertFalse(f.exists());

		f = getFile("test_dialog2.py");

		Assert.assertTrue(f.exists());

		deleteWorkingFolderContent();

	}

	public void testMove(){

		testCreation();

		ScriptingFolder folderDestination = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(), "other folder");

		checkFile("other folder");

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));	

		script.move(folderDestination);

		Assert.assertEquals(script.getParent().getFile().getAbsolutePath(),folderDestination.getFile().getAbsolutePath());

		deleteWorkingFolderContent();

	}

	public void testRun(){

	/*	testSave();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));		

		Assert.assertEquals("hola mundo", script.run());

		//setMainName

		//invokeMethod

		//invokeFunction

		deleteWorkingFolderContent();*/

	}

}

package org.gvsig.scripting;

import java.io.File;

import java.util.Iterator;

import java.util.List;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestScript extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		ScriptingLocator locator = new ScriptingLocator();

		Assert.assertNotNull(locator);

		manager = ScriptingLocator.getManager();

		Assert.assertNotNull(manager);

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

		if(file.exists()){

			file.mkdir();

		}

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public File getFile(ScriptingFolder folder, String name){

		return new File(folder.getFile(),name);

	}

	public void checkFile(ScriptingFolder folder, String fName){

		File fscript = getFile(folder, fName);

		Assert.assertTrue(fscript.exists());

	}

	public void checkScriptDefaultValues(ScriptingScript script){

		Assert.assertEquals(manager.getUserFolder().getFile().getAbsolutePath(), script.getParent().getFile().getAbsolutePath());

		Assert.assertEquals("test_script", script.getId());

		Assert.assertEquals("test_script", script.getName());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

	}

	public void checkScriptNewValues(ScriptingScript script){

		Assert.assertEquals("test_script", script.getId());

		Assert.assertEquals("TestScript", script.getName());

		Assert.assertEquals("Tests sobre scripts", script.getDescription());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

		Assert.assertEquals("creator", script.getCreatedBy());

		Assert.assertEquals("v1.0", script.getVersion());

		Assert.assertEquals("def main():\n  return 'hola mundo'\n",script.getCode());

	}

	public void testCreation(){

		setWorkingFolder();

		ScriptingScript previous = (ScriptingScript) manager.getScript(new File(manager.getRootUserFolder()+File.separator+"test_script.py"));

		if (previous!=null){

			manager.getUserFolder().remove(previous);

		}

		ScriptingScript script = (ScriptingScript) manager.createUnit(ScriptingManager.UNIT_SCRIPT,manager.getUserFolder(),"test_script.py");

		script.save();

		checkFile(manager.getUserFolder(),"test_script.py");

		checkFile(manager.getUserFolder(),"test_script.inf");

		checkScriptDefaultValues(script);

	}

	public void testOpen(){

		testCreation();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		checkScriptDefaultValues(script);

		deleteWorkingFolderContent();

	}

	public void testSave(){

		testCreation();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		script.setName("TestScript");

		script.setDescription("Tests sobre scripts");

		script.setCode("def main():\n  return 'hola mundo'\n");

		script.setCreatedBy("creator");

		script.setVersion("v1.0");

		script.save();

		script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		checkScriptNewValues(script);

	}

	public void testRename(){

		testSave();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		Assert.assertFalse(script.rename("test_script"));

		Assert.assertTrue(script.rename("test_script2"));

		script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script2.py"));

		Assert.assertEquals("test_script2", script.getId());

		deleteWorkingFolderContent();

	}

	public void testMove(){

		setWorkingFolder();

		ScriptingFolder folderDestination = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(), "other folder");

		checkFile(manager.getUserFolder(),"other folder");

		ScriptingScript previous = (ScriptingScript) manager.getScript(new File(folderDestination.getFile(),"test_script.py"));

		if (previous!=null){

			folderDestination.remove(previous);

		}

		testSave();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));	

		script.move(folderDestination);

		System.out.println(script.getParent() + " " + folderDestination);

		Assert.assertEquals(script.getParent(),folderDestination);

		deleteWorkingFolderContent();

	}

	public void testRun() throws NoSuchMethodException{

		testSave();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));		

		Assert.assertEquals("hola mundo", script.run());

		script.setCode("def hola():\n  return 'hola mundo'\n");

		//setMainName

		script.setMainName("hola");

		Assert.assertEquals("hola mundo", script.run());

		//invokeMethod

		//invokeFunction

		Assert.assertEquals("hola mundo", script.invokeFunction("hola", null));

		deleteWorkingFolderContent();

	}

}

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

For each class you are going to test, create one Test class with the same

name as the class to test, ending with Test.

For example, the unit tests of the "ExampleLibrary" class are performed

by the "ExampleLibraryTest" class.

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.scripting package documentation</title>

</head>

<body>

	<p>TODO: Example library overview.</p>

	<p>See the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overviewcomment">Javadoc Tool documentation about the overview file</a></p>

</body>

</html>

# Resource bundle texts for the Spanish language locale (es)

Example.returns_value=devuelve el valor

# Resource bundle texts for the English language locale (en)

Example.returns_value=returns value

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.scripting package documentation</title>

</head>

<body>

	<p>TODO: Example library overview.</p>

	<p>See the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overviewcomment">Javadoc Tool documentation about the overview file</a></p>

</body>

</html>

Put into this folder the resources needed by your library classes.

This folder is added to the runtime classpath, so you can load any resources 

through the ClassLoader.

By default, into this folder you can find some examples of resource bundle 

property files that may be used by your library classes.

org.gvsig.scripting.ScriptingLibrary

package org.gvsig.scripting;

import java.io.File;

import java.io.Writer;

import org.gvsig.tools.observer.WeakReferencingObservable;

/**

 * <p>

 * Interface that represents Scripting elements.</p>

 *

 * @see ScriptingUnit

 *

 * @see ScriptingScript

 * @see ScriptingDialog

 * @see ScriptingProject

 */

public interface ScriptingBaseScript extends ScriptingUnit, WeakReferencingObservable {

    public static final int ISOLATION_LOW = 0;

    public static final int ISOLATION_HIGH = 10;

    /**

     * Check if the script execution is enabled.

     *

     * @return if the script is enabled.

     */

    public boolean isEnabled();

    /**

     * Enable or disable the sript execution.

     *

     * @param enabled

     */

    public void setEnabled(boolean enabled);

    /**

     * Executes the code of a ScriptBaseScript.

     *

     * @return

     */

    public Object run();

    /**

     * Executes the code of a ScriptBaseScript.

     *

     * @param args Contains the input parameters to run the ScriptBaseScript.

     * @return

     */

    public Object run(Object args[]);

    /**

     * Executes the code of a ScriptBaseScript in a separated thread

     *

     * @param args Contains the input parameters to run the ScriptBaseScript.

     */

    public void runAsTask(Object args[]);

    public void compile() throws ScriptingRunningException;

    public void put(String name, Object value);

    /**

     * Return a resource File that is beside this script.

     *

     * @param filename

     * @return the file which is beside this script

     */

    public File getResource(String filename);

    public File getScriptFile();

    public String getLibrarySuffix();

    public void setLibrarySuffix(String librarySuffix);    

    public void addStdoutWriter(Writer out);

    public void addStderrWriter(Writer err);

    public void removeStdoutWriter(Writer out);

    public void removeStderrWriter(Writer err);

    public void setIsolationGroup(String group);

    public String getIsolationGroup();

}

package org.gvsig.scripting;

import java.io.File;

/**

 * <p> Interface that represents a single script with window dialog.</p>

 * 

 * @see ScriptingUnit

 * @see ScriptingBaseScript

 */

public interface ScriptingDialog extends ScriptingScript{

	public static final int MODE_DIALOG=1;

	public static final int MODE_WINDOW=2;

	public static final int MODE_TOOL=3;

	/**

	 * Returns the file where is the window dialog's gui.  

	 * 

	 * @return a File with the code of the window dialog.

	 */

	public File getDialogFile();

	/**

	 * Returns the type of the window dialog associated with the ScriptingDialog.  

	 * 

	 * @return an int with the window mode.

	 */

	public int getShowMode();

	/**

	 * Sets the window mode associated with a ScriptingDialog.

	 *

	 * @param mode

	 *            int that contains the window mode.

	 */

	public void setShowMode(int mode);

}

package org.gvsig.scripting;

public class ScriptingRunningException extends Exception {

	/**

	 * 

	 */

	private static final long serialVersionUID = 4327337186862453971L;

	private String message;

	private String fileName;

	private int lineNunber;

	private int columnNumber;

	public ScriptingRunningException(String message, String fileName,

			int lineNumber, int columnNumber) {

		this.message = message;

		this.fileName = fileName;

		this.lineNunber = lineNumber;

		this.columnNumber = columnNumber;

	}

	public ScriptingRunningException(String message, String fileName) {

		this(message, fileName, -1, -1);

	}

	public int getLineNumber() {

		return this.lineNunber;

	}

	public int getColumnNumber() {

		return this.columnNumber;

	}

	public String getFileName() {

		return this.fileName;

	}

	public String getMessage() {

		return this.message;

	}

}

package org.gvsig.scripting;

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

public class ScriptingLocator extends BaseLocator {

	private static final String LOCATOR_NAME = "ScriptingLocator";

	public static final String MANAGER_NAME = "scriptinglocator.manager";

	public static final String MANAGER_DESCRIPTION = "Scripting Manager";

	/**

	 * Unique instance.

	 */

	private static final ScriptingLocator instance = new ScriptingLocator();

	/**

	 * Return the singleton instance.

	 *

	 * @return the singleton instance

	 */

	public static ScriptingLocator getInstance() {

		return instance;

	}

	/**

	 * Return the Locator's name

	 *

	 * @return a String with the Locator's name

	 */

	@Override

    public String getLocatorName() {

		return LOCATOR_NAME;

	}

    /**

     * Return a reference to ScriptManager.

     * 

     * @return a reference to ScriptManager

     * @throws LocatorException

     *             if there is no access to the class or the class cannot be

     *             instantiated

     * @see Locator#get(String)

     */

	public static ScriptingManager getManager() throws LocatorException {

		return (ScriptingManager) getInstance().get(MANAGER_NAME);

	}

    /**

     * Registers the Class implementing the ScriptManager interface.

     * 

     * @param clazz

     *            implementing the ScriptManager interface

     */

    public static void registerManager(Class<? extends ScriptingManager> clazz) {

		getInstance().register(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

	}

}

package org.gvsig.scripting;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.locator.ReferenceNotRegisteredException;

public class ScriptingLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsAPI(ScriptingLibrary.class);

    }

    @Override

    protected void doInitialize() throws LibraryException {

        // Nothing to do

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        // Validate there is any implementation registered.

        ScriptingManager manager = ScriptingLocator.getManager();

        if (manager == null) {

            throw new ReferenceNotRegisteredException(

                ScriptingLocator.MANAGER_NAME, ScriptingLocator.getInstance());

        }

    }

}

package org.gvsig.scripting;

import org.gvsig.tools.script.Script;

/**

 * <p> Interface that represents a single script without window dialog.</p>

 * 

 * @see ScriptingUnit

 * @see ScriptingBaseScript

 */

public interface ScriptingScript 

        extends ScriptingText, ScriptingBaseScript, Script 

    {

	/**

	 * Returns the languange in which the ScriptingScript is written.

	 * 

	 * @return a String containing the name of the language

	 */

	public String getLangName();

	/**

	 * Returns the ScriptingScript's code.

	 * 

	 * @return a String with the code of the script.

	 */

        @Override

	public String getCode();

	/**

	 * Sets a the code associated with a ScriptingScript.

	 *

	 * @param code String that contains the new code.

	 */

        @Override

	public void setCode(String code);

	/**

	 * Returns the name of the main function in the ScriptingScript's code

	 * 

	 * @return a String with main function (default main name is 'main').

	 */

	public String getMainName();

	/**

	 * Stablishes a new main main function in the ScriptingScript's code.

	 *

	 * @param mainName

	 *            String that contains the new main function name.

	 */

	public void setMainName(String mainName);

	/**

	 * Persists the current status of a ScriptingScript with the content associated.

	 */

        @Override

	public void save();

	/**

	 * Executes a method from the Script's code

	 * 

	 * @param obj this Object represents the script's code

	 * @param name method's name to execute

	 * @param args input parameters of the method 

	 * 

	 * @return An Object that represents the execution

	 * 

	 * @throws NoSuchMethodException If there isn't a main function to begin the execution

	 */

	public Object invokeMethod(Object obj, String name, Object[] args) throws NoSuchMethodException;

	/**

	 * Executes a function from the Script's code

	 * 

	 * @param name method's name to execute

	 * @param args input parameters of the method 

	 * 

	 * @return An Object that represents the execution

	 * 

	 * @throws NoSuchMethodException If there isn't a main function to begin the execution

	 */

        @Override

	public Object invokeFunction(String name, Object[] args) throws NoSuchMethodException;

        @Override

        public String getMimeType();

        public void registerDataFolder(String id);

}

package org.gvsig.scripting;

import java.io.File;

public class ExecuteErrorException extends ScriptingErrorException {

	/**

	 * 

	 */

	private static final long serialVersionUID = 3733567933742742587L;

	public ExecuteErrorException(String msg, File name, int line, int column) {

		super(msg, name, line, column);

	}

	public ExecuteErrorException(String msg, File name, int line, int column, Throwable cause) {

		this(msg, name, line, column);

		this.initCause(cause);

	}

	public ExecuteErrorException(String msg, File name, Throwable cause) {

		this(msg, name, -1, -1);

		this.initCause(cause);

	}

}

/*

 * To change this license header, choose License Headers in Project Properties.

 * To change this template file, choose Tools | Templates

 * and open the template in the editor.

 */

package org.gvsig.scripting;

import java.io.File;

import org.apache.commons.io.FilenameUtils;

/**

 *

 * @author jjdelcerro

 */

public class ScriptingErrorException extends RuntimeException {

    private static final long serialVersionUID = -3489829775437358107L;

    private final File name;

    private final int line;

    private final int column;

    public ScriptingErrorException(String msg, File name, int line, int column) {

        super(msg);

        this.name = name;

        this.line = line;

        this.column = column;

    }

    public int getLineNumber() {

        return this.line;

    }

    public int getColumnNumber() {

        return this.column;

    }

    public String getScriptName() {

        return FilenameUtils.getBaseName(this.name.getName());

    }

    public File getScriptFile() {

        return this.name;

    }

}

package org.gvsig.scripting;

import java.io.File;

import java.util.List;

import java.util.Map;

import java.util.Set;

import org.gvsig.tools.packageutils.Version;

import org.gvsig.tools.service.spi.ProviderFactory;

import org.gvsig.tools.script.ScriptManager;

import org.gvsig.tools.util.FolderSet;

/**

 * There are two top level management roles within ScriptingFramework: logical

 * and User's Interface (UI) management.

 *

 * This class is responsible of the logical role. It provides all the services

 * to manage the information used in ScriptingFramework.

 */

public interface ScriptingManager extends ScriptManager {

    public static final String INSTALLER_PROVIDER_NAME = "Script";

    public static final String INSTALLER_PROVIDER_DESCRIPTION = "Provider to install scripts";

    public static final String PYTHON_LANGUAGE_NAME = "python";

//    public static final String SCALA_LANGUAGE_NAME = "scala";

    public static final String DEFAULT_ISOLATION_GROUP = "default";

    public static final String UNIT_SCRIPT = "Script";

    public static final String UNIT_DIALOG = "Dialog";

    public static final String UNIT_FOLDER = "Folder";

    public static final String UNIT_EXTERNALFILE = "ExternalFile";

    public void setHomeFolder(File home);

    public File getHomeFolder();

    public File getDataFolder(String id);

    public void registerDataFolder(ScriptingFolder folderScript, String id);

    public List<DataFolderFound> searchOldVersions(Version currentVersion, FolderSet folder);

    /**

     * Returns the System's Folder

     *

     * @return a {@link ScriptingFolder} with the System's Folder.

     */

    public ScriptingFolder getSystemFolder();

    /**

     * Returns the User's Folder

     *

     * @return a {@link ScriptingFolder} with the User's Folder.

     */

    public ScriptingFolder getUserFolder();

    public List<ScriptingFolder> getAlternativeUserFolders();

    public void addAlternativeUserFolder(File f, String name, String description);

    public ScriptingUnit createUnit(String unitType, ScriptingFolder folder, String id);

    public ScriptingUnit createUnit(String unitType, ScriptingFolder folder, String id, String language);

    public List<String> getUnitTypes();

    /**

     * Returns the {@link ScriptingBaseScript} associated with the file

     * specified

     *

     * @param file File where is contained the {@link ScriptingBaseScript}'s

     * information

     *

     * @return {@link ScriptingBaseScript}

     */

    public ScriptingBaseScript getScript(File file);

    public ScriptingBaseScript getScript(String name);

    /**

     * Returns the {@link ScriptingFolder} associated with the file specified

     *

     * @param file File where is contained the {@link ScriptingFolder}'s

     * information

     *

     * @return {@link ScriptingFolder}

     */

    public ScriptingFolder getFolder(File file);

    /**

     * Return the {@link ScriptingUnit} associated with the path specified.

     * 

     * the path should start with "User" or "System".

     * 

     * @param pathName

     * 

     * @return the required {@link ScriptingUnit}

     */

    public ScriptingUnit getUnit(String pathName);

    /**

     * Returns the path of the User's Folder

     *

     * @return a String with the path of the User's Folder

     */

//    public String getRootUserFolder();

    /**

     * Registers a File System with {@link ScriptingUnit}s in the SystemFolder

     *

     * @param name String with the identificator name of the File System

     * registered

     * @param folder File with the root of the File System to register

     */

    public void registerSystemFolder(String name, File folder);

    public List<String> getSupportedLanguages();

    public String getExtensionOfLanguage(String language);

    public String getEngineNameByLanguage(String langName);

    public Set<String> getEnginesIsolationGroups();

    /**

     * Checks if an id is unique in a determinate folder

     *

     * @param folder {

     * @ScriptingFolder} with the directory to verify the id

     * @param id String with the id to validate

     *

     * @return true if there isn't another {@link ScriptingUnit} with the same

     * id, and false in the other case

     */

    public boolean validateUnitId(ScriptingFolder folder, String id);

    /**

     * Sets a key/value pair in the state of the ScriptingManager that may

     * either create a Java Language Binding to be used in the execution of

     * scripts

     *

     * @param key The name of named value to add

     * @param value The value of named value to add.

     */

    public void put(String key, Object value);

    /**

     * Retrieves a value set in the state of this ScriptingManager

     *

     * @param key The key whose value is to be returned

     *

     * @return an Object with the value corresponding to the key

     */

    public Object get(String key);

    public void addLibFolder(File lib);

    public File getRootUserFolder();

    public ProviderFactory getInstallerFactory();

    /**

     * Devuelbe la carpeta en la que se encuentran los paquetes

     * de la aplicacion.

     * 

     * @return 

     */

    public File getPackagesFolder();

    /**

     * Establece la carpeta en la que se encuentran los paquetes

     * de la aplicacion.

     * @param folder 

     */

    public void setPackagesFolder(File folder);

    /**

     * Search the available engines and initialize the manager.

     */

    public void loadEngines();

    public List<File> getLibFolders();

    /**

     * Return a map with the label and suffix of the library versions.

     * 

     * For each value of map, the value is the name of the version (a label) and

     * the key is the suffix for that version.

     * 

     * @return a map with suffix and labels of library versions. 

     */

    public Map<String,String> getLibFoldersVersions();

    /**

     * <p>

     * Returns a reference to an object (property) associated to this layer.</p>

     *

     * <p>

     * For example, you can attach a network definition to key "network" and

     * check

     * if a layer has a network loaded using

     * <i>getAssociatedObject("network")</i> and

     * that it's not null.</p>

     *

     * @param key the key associated to the property

     *

     * @return <code>null</code> if key is not found

     *

     * @see #getExtendedProperties()

     * @see #setProperty(Object, Object)

     */

    public Object getProperty(Object key);

    /**

     * Inserts an object as a property to this layer.

     *

     * @param key the key associated to the property

     * @param obj the property

     *

     * @see #getProperty(Object)

     * @see #getExtendedProperties()

     */

    public void setProperty(Object key, Object obj);

    /**

     * Returns a hash map with all new properties associated to this layer.

     *

     * @return hash table with the added properties

     *

     * @see #getProperty(Object)

     * @see #setProperty(Object, Object)

     */

    public Map getExtendedProperties();   

    public ScriptingFolder createLink(String name, File link, String targetPathName);

    public ScriptingFolder createLink(String name, ScriptingFolder link, String targetPathName);

}

package org.gvsig.scripting;

import java.io.File;

import java.io.IOException;

import java.util.List;

import java.util.function.Predicate;

import org.gvsig.tools.exception.BaseException;