NetLogoLink.java

package netLogoLink;


// partly based on the work of Uri Wilensky's Mathematica link:
//(C) 2007 Uri Wilensky. This code may be freely copied, distributed,
//altered, or otherwise used by anyone for any legal purpose.


import org.nlogo.headless.HeadlessWorkspace;
import org.nlogo.core.CompilerException;
import org.nlogo.api.LogoException;
import org.nlogo.app.App;
import java.awt.EventQueue;
import java.awt.Frame;

import javax.swing.JOptionPane;

import java.lang.Thread;


public class NetLogoLink {
	private org.nlogo.workspace.Controllable workspace = null;
	private java.io.IOException caughtEx = null;
	private boolean isGUIworkspace;
	private static boolean blockExit = true;

	public NetLogoLink(Boolean isGUImode, Boolean is3d)
	{
		/**
		 * Instantiates a link to netlogo
		 * 
		 * @param isGuiMode	boolean indicated whether netlogo should be run
		 * 		  			with gui or in headless mode
		 * @param is3d      boolean indicated whether to run netlogo in 2d or 
		 * 				   	in 3d mode.
		 * 
		 */
		
		try
		{
			System.setProperty("org.nlogo.is3d", is3d.toString());
			isGUIworkspace = isGUImode.booleanValue();
			if( isGUIworkspace ) {
				App.main( new String[] { } ) ;
				workspace = App.app();
				org.nlogo.api.Exceptions.setHandler
					( new org.nlogo.api.Exceptions.Handler() {
							public void handle( Throwable t ) {
								throw new RuntimeException(t.getMessage());
							} } );
			}
			else
				workspace = HeadlessWorkspace.newInstance() ;
		}
		catch (Exception ex) {
			JOptionPane.showMessageDialog(null, "Error in Constructor NLink:"+ex, "Error", JOptionPane.OK_CANCEL_OPTION);			
		}
	}	
	
	public void killWorkspace()
	{
		/**
		 * 	it is not possible to close NetLogo by its own closing method, 
		 *  because it is based on System.exit(0) which will result in a 
		 *  termination of the JVM, jpype and finally python. Therefore, we 
		 *  only dispose the thread, we can find. This is the identical to
		 *  how it is done in RNetLogo.
		 */
		
		try
		{
			NetLogoLink.blockExit = false;

			if (isGUIworkspace) {
				for (int i=0; i<((App)workspace).frame().getFrames().length; i++) {
					((App)workspace).frame();
					java.awt.Frame frame = Frame.getFrames()[i];
					
					frame.dispose();
				}
				Thread.currentThread().interrupt();
			}
			else {
				((HeadlessWorkspace)workspace).dispose();
			}
		}
		catch (Exception ex) {
			JOptionPane.showMessageDialog(null, "Error in killing workspace:"+ex, "Error", JOptionPane.OK_CANCEL_OPTION);
		}
		workspace = null;
		System.gc();
	}


	public void loadModel(final String path)
		throws java.io.IOException, LogoException, InterruptedException, CompilerException, Exception
	{
		/**
		 * load a model
		 * 
		 * @param path	a string with the absolute path of the model
		 * @throws IOException, LogoException, CompilerException, InterruptedException
		 * 
		 */
			caughtEx = null;
			if ( isGUIworkspace ) {
				try {
					EventQueue.invokeAndWait ( 
						new Runnable() {
							public void run() {
								try {
									/* netlogo 6.1*/
									App.app().open(path, true);
								} catch( java.io.IOException ex) {
									{caughtEx = ex; }
								}
							} } );
				}
				catch( java.lang.reflect.InvocationTargetException ex ) {
					JOptionPane.showMessageDialog(null, "Error in loading model:"+ex, "Error", JOptionPane.OK_CANCEL_OPTION);
					throw new RuntimeException(ex.getMessage());
				}
				if( caughtEx != null ) {
					throw caughtEx;
				}
			}
			else {
				try {
					if (workspace != null)
						((HeadlessWorkspace)workspace).dispose();
					workspace = HeadlessWorkspace.newInstance() ;
					workspace.open(path, true);
				}
				catch( java.io.IOException ex) {
					JOptionPane.showMessageDialog(null, "Error in loading model:"+ex, "Error", JOptionPane.OK_CANCEL_OPTION);

					if (workspace != null)
						((HeadlessWorkspace)workspace).dispose();
					workspace = HeadlessWorkspace.newInstance() ;
					throw ex;
				}
			}
	}

	public void command(final String s)
		throws Exception, LogoException, CompilerException
	{
		/**
		 * execute the supplied command in netlogo. This method
		 * is a wrapper around netlogo's command.
		 * 
		 * @param s	a valid netlogo command
		 * @throws LogoException, CompilerException
		 * 
		 */
		
		workspace.command(s);
	}

	/* returns the value of a reporter.  if it is a LogoList, it will be
	recursively converted to an array of Objects */
	public Object report(String s)
		throws Exception, LogoException, CompilerException
	{
		/** 
		 * Every reporter (commands which return a value) that can be called 
		 * in the NetLogo Command Center can be called with this method. 
		 * Like command, it is essentially a wrapper around netlogo's report
		 * 
		 * @param s	a valid netlogo reporter
		 * 
		 */		
		
		NLResult result = new NLResult();
		result.setResultValue(workspace.report(s));
		return result;
	}

    public void sourceFromString(final String source, final Boolean addProcedure)
	throws java.io.IOException, LogoException, CompilerException, InterruptedException
	{
		caughtEx = null;
		if ( isGUIworkspace ) {
			try {
				EventQueue.invokeAndWait (
					new Runnable() {
						public void run() {
							try
							{
								if (addProcedure)
								{
									App.app().setProcedures(App.app().getProcedures()+"\n"+source);
								}
								else
								{
									App.app().setProcedures(source);
								}

								App.app().compile();
							}
							catch( Exception ex)
							{
								//System.out.println("Error: "+ex);
							}
						}
					}
				);
			}
			catch( java.lang.reflect.InvocationTargetException ex ) {
				JOptionPane.showMessageDialog(null, "Error in model from source:"+ex, "Error", JOptionPane.OK_CANCEL_OPTION);
				throw new RuntimeException(ex.getMessage());
			}
			if( caughtEx != null ) {
				throw caughtEx;
			}
		}
	}

	public void doCommandWhile(final String s, final String cond, Integer maxMinutes) throws LogoException, CompilerException
	{
		if (maxMinutes > 0) {
			long startTime = System.currentTimeMillis();
			while (((Boolean)workspace.report(cond)).booleanValue())
			{
				workspace.command(s);
				// max. time exceeded
				if ((System.currentTimeMillis() - startTime) / 60000 >= maxMinutes) {
					//break;
					throw new RuntimeException("Maximum time for NLDoCommandWhile reached. Process stopped.");
				}
			}
		}
		else {
			while (((Boolean)workspace.report(cond)).booleanValue())
			{
				workspace.command(s);
			}
		}
	}

	@SuppressWarnings("unused")
	public Object[] doReportWhile(final String s, final String var, final String condition, Integer maxMinutes)
		throws LogoException, CompilerException, Exception
	{
		java.util.ArrayList<Object> varList = new java.util.ArrayList<Object>();
		if (maxMinutes > 0) {
			long startTime = System.currentTimeMillis();
			for(int i=0; ((Boolean)workspace.report(condition)).booleanValue(); i++) {
				workspace.command(s);
				varList.add(report(var));
				// max. time exceeded
				if ((System.currentTimeMillis() - startTime) / 60000 >= maxMinutes) {
					//break;
					throw new RuntimeException("Maximum time for NLDoReportWhile reached. Process stopped.");
				}
			}
		}
		else {
			for(int i=0; ((Boolean)workspace.report(condition)).booleanValue(); i++) {
				workspace.command(s);
				varList.add(report(var));
			}
		}
		Object[] objArray = varList.toArray();
		return objArray;
	}

	/*
	source from string to add procedures to netlogo
	commandWhile
	reportWhile
	*/
	
}