Script.java

/*
 * Scriptographer
 *
 * This file is part of Scriptographer, a Scripting Plugin for Adobe Illustrator
 * http://scriptographer.org/
 *
 * Copyright (c) 2002-2010, Juerg Lehni
 * http://scratchdisk.com/
 *
 * All rights reserved. See LICENSE file for details.
 * 
 * File created on Apr 22, 2007.
 */

package com.scriptographer.sg;

import java.io.File;

import com.scriptographer.ScriptographerEngine;
import com.scriptographer.ai.ToolHandler;

/**
 * @author lehni
 *
 */
public class Script {
	private File file;
	private Preferences prefs = null;
	private boolean keepAlive = false;
	private boolean showProgress = true;
	private CoordinateSystem system = CoordinateSystem.DEFAULT;
	private AngleUnits angleUnits = AngleUnits.DEFAULT;
	protected boolean coreScript = false;
	private Script parent = null;
	private ToolHandler toolHandler;

	/**
	 * @jshide
	 */
	public Script(File file, boolean coreScript) {
		this.file = file;
		this.coreScript = coreScript;
	}

	/**
	 * @jshide
	 */
	public Script(File file, Script parent) {
		this(file, parent.coreScript);
		this.parent = parent;
	}

	/**
	 * Returns the script file.
	 */
	public File getFile() {
		return file;
	}

	/**
	 * Returns the directory in which the script is stored in.
	 */
	public File getDirectory() {
		return file.getParentFile();
	}

	/**
	 * Returns the script's preferences, as an object in which data
	 * can be stored and retrieved from:
	 * <code>
	 * script.preferences.value = 10;
	 * </code>
	 */
	public Preferences getPreferences() {
		// Share preferences with the parent, as this will also be the script
		// object used in callback functions (the child script is only used
		// during compile time of include).
		if (parent != null)
			return parent.getPreferences();
		if (prefs == null)
			prefs = new Preferences(ScriptographerEngine.getPreferences(this));
		return prefs;
	}

	/**
	 * Determines whether the scripts wants to display the progress bar
	 * or not. {@code true} by default.
	 */
	public boolean getShowProgress() {
		return showProgress;
	}

	public void setShowProgress(boolean show) {
		showProgress = show;
		if (show)
			ScriptographerEngine.showProgress();
		else
			ScriptographerEngine.closeProgress();
	}

	/**
	 * Specifies whether the script will be kept alive after the user executes
	 * another script.
	 * 
	 * @return {@true if the script will be kept alive}
	 */
	public boolean getKeepAlive() {
		return keepAlive;
	}

	public void setKeepAlive(boolean keepAlive) {
		this.keepAlive  = keepAlive;
	}

	/*
	 * Redirect to parent script for both CoordinateSystem and AngleUnits, so
	 * there can only be one standard within one 'inlcude' chain...
	 */

	/**
	 * The coordinate system orientation that all coordinates in the current
	 * script are specified in, {@code 'top-down' } by default.
	 * 
	 * Set to {@code 'bottom-up' } for backward compatibility with scripts
	 * written for Scriptographer 2.8 / CS4 and below, where the bottom-up
	 * orientation was default.
	 * 
	 * Note that angles are oriented clockwise in the {@code 'top-down' }
	 * coordinate system, and counter-clockwise in the {@code 'bottom-up' }
	 * system.
	 */
	public CoordinateSystem getCoordinateSystem() {
		if (parent != null)
			return parent.getCoordinateSystem();
		return system;
	}

	public void setCoordinateSystem(CoordinateSystem system) {
		if (parent != null) {
			parent.setCoordinateSystem(system);
		} else {
			this.system = system != null ? system : CoordinateSystem.DEFAULT;
			ScriptographerEngine.setCoordinateSystem(this.system);
		}
	}

	/**
	 * The angle units that all angles in the current script are measured in,
	 * {@code 'degrees' } by default.
	 */
	public AngleUnits getAngleUnits() {
		if (parent != null)
			return parent.getAngleUnits();
		return angleUnits;
	}

	public void setAngleUnits(AngleUnits units) {
		if (parent != null) {
			parent.setAngleUnits(units);
		} else {
			this.angleUnits = units != null ? units : AngleUnits.DEFAULT;
			ScriptographerEngine.setAngleUnits(this.angleUnits);
		}
	}

	/**
	 * @jshide
	 */
	public boolean canRemove(boolean ignoreKeepAlive) {
		return !coreScript && (ignoreKeepAlive || !keepAlive);
	}

	/**
	 * @jshide
	 */
	public boolean isCoreScript() {
		return coreScript;
	}

	/**
	 * @jshide
	 */
	public void setToolHandler(ToolHandler handler) {
		toolHandler = handler;
	}

	/**
	 * @jshide
	 */
	public ToolHandler getToolHandler() {
		return toolHandler;
	}

	/**
	 * @jshide
	 */
	public boolean isToolScript() {
		return toolHandler != null;
	}
}