/*
* ActionSet.java - A set of actions
* :tabSize=4:indentSize=4:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 2001, 2003 Slava Pestov
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or 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 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.
*/
package org.gjt.sp.jedit;
//{{{ imports
import java.net.URL;
import java.util.*;
import org.gjt.sp.jedit.input.AbstractInputHandler;
import org.jedit.keymap.Keymap;
import org.gjt.sp.util.Log;
//}}}
/**
* A set of actions, either loaded from an XML file, or constructed at runtime
* by a plugin. <p>
*
* <h3>Action sets loaded from XML files</h3>
*
* Action sets are read from these files inside the plugin JAR:
* <ul>
* <li><code>actions.xml</code> - actions made available for use in jEdit views,
* including the view's <b>Plugins</b> menu, the tool bar, etc.</li>
* <li><code>browser.actions.xml</code> - actions for the file system browser's
* <b>Plugins</b> menu.</li>
* </ul>
*
* An action definition file has the following form:
*
* <pre><?xml version="1.0"?>
*<!DOCTYPE ACTIONS SYSTEM "actions.dtd">
*<ACTIONS>
* <ACTION NAME="some-action">
* <CODE>
* // BeanShell code evaluated when the action is invoked
* </CODE>
* </ACTION>
* <ACTION NAME="some-toggle-action">
* <CODE>
* // BeanShell code evaluated when the action is invoked
* </CODE>
* <IS_SELECTED>
* // BeanShell code that should evaluate to true or false
* </IS_SELECTED>
* </ACTION>
*</ACTIONS></pre>
*
* The following elements are valid:
*
* <ul>
* <li>
* <code>ACTIONS</code> is the top-level element and refers
* to the set of actions used by the plugin.
* </li>
* <li>
* An <code>ACTION</code> contains the data for a particular action.
* It has three attributes: a required <code>NAME</code>;
* an optional <code>NO_REPEAT</code>, which is a flag
* indicating whether the action should not be repeated with the
* <b>C+ENTER</b> command; and an optional
* <code>NO_RECORD</code> which is a a flag indicating whether the
* action should be recorded if it is invoked while the user is recording a
* macro. The two flag attributes
* can have two possible values, "TRUE" or
* "FALSE". In both cases, "FALSE" is the
* default if the attribute is not specified.
* </li>
* <li>
* An <code>ACTION</code> can have two child elements
* within it: a required <code>CODE</code> element which
* specifies the
* BeanShell code that will be executed when the action is invoked,
* and an optional <code>IS_SELECTED</code> element, used for
* checkbox
* menu items. The <code>IS_SELECTED</code> element contains
* BeanShell code that returns a boolean flag that will
* determine the state of the checkbox.
* </li>
* </ul>
*
* Each action must have a property <code><i>name</i>.label</code> containing
* the action's menu item label.
*
* <h3>View actions</h3>
*
* Actions defined in <code>actions.xml</code> can be added to the view's
* <b>Plugins</b> menu; see {@link EditPlugin}.
* The action code may use any standard predefined
* BeanShell variable; see {@link BeanShell}.
*
* <h3>File system browser actions</h3>
*
* Actions defined in <code>actions.xml</code> can be added to the file
* system browser's <b>Plugins</b> menu; see {@link EditPlugin}.
* The action code may use any standard predefined
* BeanShell variable, in addition to a variable <code>browser</code> which
* contains a reference to the current
* {@link org.gjt.sp.jedit.browser.VFSBrowser} instance.<p>
*
* File system browser actions should not define
* <code><IS_SELECTED></code> blocks.
*
* <h3>Custom action sets</h3>
*
* Call {@link jEdit#addActionSet(ActionSet)} to add a custom action set to
* jEdit's action context. You must also call {@link #initKeyBindings()} for new
* action sets. Don't forget to call {@link jEdit#removeActionSet(ActionSet)}
* before your plugin is unloaded, too.
*
* @see jEdit#getActionContext()
* @see org.gjt.sp.jedit.browser.VFSBrowser#getActionContext()
* @see ActionContext#getActionNames()
* @see ActionContext#getAction(String)
* @see jEdit#addActionSet(ActionSet)
* @see jEdit#removeActionSet(ActionSet)
* @see PluginJAR#getActionSet()
* @see BeanShell
* @see View
*
* @author Slava Pestov
* @author John Gellene (API documentation)
* @version $Id: ActionSet.java 21831 2012-06-18 22:54:17Z ezust $
* @since jEdit 4.0pre1
*/
public class ActionSet extends JEditActionSet<EditAction> implements Comparable
{
//{{{ ActionSet constructor
/**
* Creates a new action set.
* @since jEdit 4.0pre1
*/
public ActionSet()
{
label = "<no label set; plugin bug>";
} //}}}
//{{{ ActionSet constructor
/**
* Creates a new action set.
* @param plugin The plugin
* @param cachedActionNames The list of cached action names
* @param cachedActionToggleFlags The list of cached action toggle flags
* @param uri The actions.xml URI
* @since jEdit 4.2pre2
*/
public ActionSet(PluginJAR plugin, String[] cachedActionNames,
boolean[] cachedActionToggleFlags, URL uri)
{
this();
this.plugin = plugin;
this.uri = uri;
if(cachedActionNames != null)
{
for(int i = 0; i < cachedActionNames.length; i++)
{
actions.put(cachedActionNames[i],placeholder);
jEdit.setTemporaryProperty(cachedActionNames[i]
+ ".toggle",cachedActionToggleFlags[i]
? "true" : "false");
}
}
loaded = false;
} //}}}
//{{{ addAction() method
/**
* Adds an action to the action set.
* It exists for binary compatibility issues
* @param action The action
* @since jEdit 4.0pre1
*/
@Override
public void addAction(EditAction action)
{
super.addAction(action);
} //}}}
//{{{ getArray() method
protected EditAction[] getArray(int size)
{
return new EditAction[size];
} //}}}
//{{{ getActions() method
/**
* Returns an array of all actions in this action set.<p>
*
* <b>Deferred loading:</b> this will load the action set if necessary.
*
* @since jEdit 4.0pre1
*/
@Override
public EditAction[] getActions()
{
return super.getActions();
} //}}}
//{{{ ActionSet constructor
/**
* Creates a new action set.
* @param label The label, shown in the shortcuts option pane
* @since jEdit 4.0pre1
*/
public ActionSet(String label)
{
this();
setLabel(label);
} //}}}
//{{{ getLabel() method
/**
* Return the action source label.
* @since jEdit 4.0pre1
*/
public String getLabel()
{
return label;
} //}}}
//{{{ setLabel() method
/**
* Sets the action source label.
* @param label The label
* @since jEdit 4.0pre1
*/
public void setLabel(String label)
{
if(label == null)
throw new NullPointerException();
this.label = label;
} //}}}
//{{{ getPluginJAR() method
/**
* Return the plugin this action set was loaded from, or null.
* @since jEdit 4.2pre13
*/
public PluginJAR getPluginJAR()
{
return plugin;
} //}}}
//{{{ getCacheableActionNames() method
/**
* Returns an array of all action names in this action set that should
* be cached; namely, <code>BeanShellAction</code>s.
* @since jEdit 4.2pre1
*/
@Override
public String[] getCacheableActionNames()
{
LinkedList<String> retVal = new LinkedList<String>();
Enumeration e = actions.elements();
while(e.hasMoreElements())
{
Object obj = e.nextElement();
if(obj == placeholder)
{
// ??? this should only be called with
// fully loaded action set
Log.log(Log.WARNING,this,"Action set not up "
+ "to date");
}
else if(obj instanceof BeanShellAction)
retVal.add(((BeanShellAction)obj).getName());
}
return retVal.toArray(new String[retVal.size()]);
} //}}}
//{{{ getProperty() method
protected String getProperty(String name)
{
Keymap keymap = jEdit.getKeymapManager().getKeymap();
return keymap.getShortcut(name);
} //}}}
//{{{ getInputHandler() method
public AbstractInputHandler getInputHandler()
{
return jEdit.getInputHandler();
} //}}}
//{{{ compareTo() method
public int compareTo(Object o)
{
return label.compareTo(((ActionSet)o).label);
}//}}}
//{{{ toString() method
@Override
public String toString()
{
return label;
} //}}}
//{{{ createBeanShellAction() method
/**
* Creates a BeanShellAction.
* @since 4.3pre13
*/
protected EditAction createBeanShellAction(String actionName,
String code,
String selected,
boolean noRepeat,
boolean noRecord,
boolean noRememberLast)
{
return new BeanShellAction(actionName,code,selected,noRepeat,noRecord,noRememberLast);
}
//}}}
//{{{ Private members
private String label;
private PluginJAR plugin;
//}}}
}