/*
* AbstractInputHandler.java - Manages key bindings and executes actions
* :tabSize=4:indentSize=4:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 2006 Matthieu Casanova
*
* 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.input;
import org.gjt.sp.jedit.gui.KeyEventTranslator;
import org.gjt.sp.jedit.Debug;
import org.gjt.sp.util.Log;
import java.awt.event.KeyListener;
import java.awt.event.KeyEvent;
import java.util.Hashtable;
import java.util.StringTokenizer;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.gjt.sp.jedit.JEditAbstractEditAction;
import org.gjt.sp.jedit.gui.ShortcutPrefixActiveEvent;
/**
* The abstract input handler manage the keyboard handling.
* The entry point is
* {@link #processKeyEvent(java.awt.event.KeyEvent, int, boolean)}
*
* @author Matthieu Casanova
* @version $Id: FoldHandler.java 5568 2006-07-10 20:52:23Z kpouer $
*/
public abstract class AbstractInputHandler<E extends JEditAbstractEditAction>
{
protected int lastActionCount;
/** This listener will receive keyboard events if it is not null. */
protected KeyListener keyEventInterceptor;
protected String readNextChar;
protected int repeatCount;
protected E lastAction;
protected static final int REPEAT_COUNT_THRESHOLD = 20;
//{{{ AbstractInputHandler constructor
public AbstractInputHandler()
{
repeatCount = 1;
} //}}}
//{{{ addKeyBinding() method
/**
* Adds a key binding to this input handler. The key binding is
* a list of white space separated key strokes of the form
* <i>[modifiers+]key</i> where modifier is C for Control, A for Alt,
* or S for Shift, and key is either a character (a-z) or a field
* name in the KeyEvent class prefixed with VK_ (e.g., BACK_SPACE)
* @param keyBinding The key binding
* @param action The action
* @since jEdit 4.2pre1
*/
public void addKeyBinding(String keyBinding, String action)
{
addKeyBinding(keyBinding,(Object)action);
} //}}}
//{{{ addKeyBinding() method
/**
* Adds a key binding to this input handler. The key binding is
* a list of white space separated key strokes of the form
* <i>[modifiers+]key</i> where modifier is C for Control, A for Alt,
* or S for Shift, and key is either a character (a-z) or a field
* name in the KeyEvent class prefixed with VK_ (e.g., BACK_SPACE)
* @param keyBinding The key binding
* @param action The action
*/
public void addKeyBinding(String keyBinding, E action)
{
addKeyBinding(keyBinding,(Object)action);
} //}}}
//{{{ addKeyBinding() method
/**
* Adds a key binding to this input handler. The key binding is
* a list of white space separated key strokes of the form
* <i>[modifiers+]key</i> where modifier is C for Control, A for Alt,
* or S for Shift, and key is either a character (a-z) or a field
* name in the KeyEvent class prefixed with VK_ (e.g., BACK_SPACE)
* @param keyBinding The key binding
* @param action The action
* @since jEdit 4.3pre1
*/
public void addKeyBinding(String keyBinding, Object action)
{
Hashtable current = bindings;
String prefixStr = null;
StringTokenizer st = new StringTokenizer(keyBinding);
while(st.hasMoreTokens())
{
String keyCodeStr = st.nextToken();
if(prefixStr == null)
prefixStr = keyCodeStr;
else
prefixStr = prefixStr + " " + keyCodeStr;
KeyEventTranslator.Key keyStroke = KeyEventTranslator.parseKey(keyCodeStr);
if(keyStroke == null)
return;
if(st.hasMoreTokens())
{
Object o = current.get(keyStroke);
if(o instanceof Hashtable)
current = (Hashtable)o;
else
{
Hashtable hash = new Hashtable();
hash.put(PREFIX_STR,prefixStr);
o = hash;
current.put(keyStroke,o);
current = (Hashtable)o;
}
}
else
current.put(keyStroke,action);
}
} //}}}
//{{{ removeKeyBinding() method
/**
* Removes a key binding from this input handler.
*
* @param keyBinding The key binding
*/
public void removeKeyBinding(String keyBinding)
{
Hashtable current = bindings;
StringTokenizer st = new StringTokenizer(keyBinding);
while(st.hasMoreTokens())
{
String keyCodeStr = st.nextToken();
KeyEventTranslator.Key keyStroke = KeyEventTranslator.parseKey(keyCodeStr);
if(keyStroke == null)
return;
if(st.hasMoreTokens())
{
Object o = current.get(keyStroke);
if(o instanceof Hashtable)
current = ((Hashtable)o);
else if(o != null)
{
// we have binding foo
// but user asks to remove foo bar?
current.remove(keyStroke);
return;
}
else
{
// user asks to remove non-existent
return;
}
}
else
current.remove(keyStroke);
}
} //}}}
//{{{ removeAllKeyBindings() method
/**
* Removes all key bindings from this input handler.
*/
public void removeAllKeyBindings()
{
bindings.clear();
} //}}}
//{{{ getKeyBinding() method
/**
* Returns either an edit action, or a hashtable if the specified key
* is a prefix.
* @param keyBinding The key binding
* @since jEdit 3.2pre5
*/
@Nullable
public Object getKeyBinding(@Nonnull String keyBinding)
{
Hashtable current = bindings;
StringTokenizer st = new StringTokenizer(keyBinding);
while(st.hasMoreTokens())
{
KeyEventTranslator.Key keyStroke = KeyEventTranslator.parseKey(
st.nextToken());
if(keyStroke == null)
return null;
if(st.hasMoreTokens())
{
Object o = current.get(keyStroke);
if(o instanceof Hashtable)
{
if(!st.hasMoreTokens())
return o;
else
current = (Hashtable)o;
}
else
return o;
}
else
{
return current.get(keyStroke);
}
}
return null;
} //}}}
//{{{ getLastActionCount() method
/**
* Returns the number of times the last action was executed.
* It can be used with smartHome and smartEnd
* @return the number of times the last action was executed
* @since jEdit 2.5pre5
*/
public int getLastActionCount()
{
return lastActionCount;
} //}}}
//{{{ resetLastActionCount() method
/**
* Resets the last action count. This should be called when an
* editing operation that is not an action is invoked, for example
* a mouse click.
* @since jEdit 4.0pre1
*/
public void resetLastActionCount()
{
lastActionCount = 0;
} //}}}
//{{{ getKeyEventInterceptor() method
public KeyListener getKeyEventInterceptor()
{
return keyEventInterceptor;
} //}}}
//{{{ setKeyEventInterceptor() method
/**
* Sets the listener that will handle all key events in this
* view. For example, the complete word command uses this so
* that all key events are passed to the word list popup while
* it is visible.
* @param keyEventInterceptor the KeyListener that will receive the events
*/
public void setKeyEventInterceptor(KeyListener keyEventInterceptor)
{
this.keyEventInterceptor = keyEventInterceptor;
} //}}}
//{{{ isPrefixActive() method
/**
* Returns if a prefix key has been pressed.
*/
public boolean isPrefixActive()
{
return readNextChar != null;
} //}}}
//{{{ setBindings() method
/**
* Replace the set of key bindings.
* @since jEdit 4.3pre1
*/
public void setBindings(Hashtable bindings)
{
this.bindings = this.currentBindings = bindings;
} //}}}
//{{{ setCurrentBindings() method
public void setCurrentBindings(Hashtable bindings)
{
currentBindings = bindings;
} //}}}
//{{{ handleKey() method
/**
* Handles a keystroke.
* @param keyStroke The key stroke.
* @param dryRun only calculate the return value, do not have any other effect
* @return true if the input could be handled.
* @since jEdit 4.3pre7
*/
public abstract boolean handleKey(KeyEventTranslator.Key keyStroke,boolean dryRun);
//}}}
//{{{ processKeyEvent() method
/**
* Process a keyboard event.
* This is the entry point of the keyboard handling
*
* @param evt the keyboard event
* @param from the source, it can be {@link org.gjt.sp.jedit.View#VIEW},
* {@link org.gjt.sp.jedit.View#ACTION_BAR} or {@link org.gjt.sp.jedit.View#TEXT_AREA}
* @param global tell if the event comes from the DefaultKeyboardFocusManager or not
*/
public abstract void processKeyEvent(KeyEvent evt, int from, boolean global);
//}}}
//{{{ sendShortcutPrefixOff() method
protected void sendShortcutPrefixOff()
{
if(shortcutOn)
{
ShortcutPrefixActiveEvent.firePrefixStateChange(null, false);
shortcutOn = false;
}
} //}}}
public abstract void invokeAction(String action);
public abstract void invokeAction(E action);
//{{{ toString() method
/**
* Return a String representation of the keyboard event for
* debugging purpose.
*
* @param evt the keyboard event
* @return a String representation for this keyboard event
* @since jEdit 4.3pre15
*/
public static String toString(KeyEvent evt)
{
String id;
switch(evt.getID())
{
case KeyEvent.KEY_PRESSED:
id = "KEY_PRESSED";
break;
case KeyEvent.KEY_RELEASED:
id = "KEY_RELEASED";
break;
case KeyEvent.KEY_TYPED:
id = "KEY_TYPED";
break;
default:
id = "unknown type";
break;
}
StringBuilder b = new StringBuilder(50);
b.append(id);
b.append(",keyCode=0x").append(Integer.toString(evt.getKeyCode(), 16));
b.append(",keyChar=0x").append(Integer.toString(evt.getKeyChar(), 16));
b.append(",modifiers=0x").append(Integer.toString(evt.getModifiers(), 16));
b.append(",consumed=");
b.append(evt.isConsumed()?'1':'0');
return b.toString();
} //}}}
//{{{ processKeyEventKeyStrokeHandling() method
/**
*
* @param evt the keyboard event
* @param from the source, it can be {@link org.gjt.sp.jedit.View#VIEW},
* {@link org.gjt.sp.jedit.View#ACTION_BAR} or {@link org.gjt.sp.jedit.View#TEXT_AREA}
* @param mode the mode is "press" or "type" and is used for debug only
* @param global tell if the event comes from the DefaultKeyboardFocusManager or not
*/
protected void processKeyEventKeyStrokeHandling(KeyEvent evt, int from, String mode, boolean global)
{
KeyEventTranslator.Key keyStroke = KeyEventTranslator.translateKeyEvent(evt);
if(keyStroke != null)
{
keyStroke.setIsFromGlobalContext(global);
if(Debug.DUMP_KEY_EVENTS)
{
Log.log(Log.DEBUG,this,"Translated (key "+mode+"): "+keyStroke+" from "+from);
}
boolean consumed = false;
if(handleKey(keyStroke, false))
{
evt.consume();
consumed = true;
}
if(Debug.DUMP_KEY_EVENTS)
{
Log.log(Log.DEBUG,this,"Translated (key "+mode+"): "+keyStroke+" from "+from+": consumed="+consumed+'.');
}
}
} //}}}
//{{{ Private members
// Stores prefix name in bindings hashtable
public static Object PREFIX_STR = "PREFIX_STR";
protected boolean shortcutOn = false;
protected Hashtable bindings;
protected Hashtable currentBindings;
//}}}
}