Menu
▾
▴
[ jEdit-commits ] plugins/TextAutocomplete/net/jakubholy/jedit/autocomplete PreferencesManager.java, 1.4, 1.5
|
From: Jakub H. <mal...@us...> - 2006-10-22 16:53:50
|
Update of /cvsroot/jedit/plugins/TextAutocomplete/net/jakubholy/jedit/autocomplete In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv28788/net/jakubholy/jedit/autocomplete Modified Files: PreferencesManager.java Log Message: + preferences log level, isSelectionByNumberEnabled and selectionByNumberModifierMask. better comments Index: PreferencesManager.java =================================================================== RCS file: /cvsroot/jedit/plugins/TextAutocomplete/net/jakubholy/jedit/autocomplete/PreferencesManager.java,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- PreferencesManager.java 5 Apr 2006 19:22:10 -0000 1.4 +++ PreferencesManager.java 22 Oct 2006 16:53:45 -0000 1.5 @@ -1,10 +1,11 @@ -/* +/* * PreferencesManager.java * Created on 6.2.2005 by aja * $id */ package net.jakubholy.jedit.autocomplete; +import java.awt.event.InputEvent; import java.awt.event.KeyEvent; import java.lang.reflect.Field; import java.util.List; @@ -24,14 +25,35 @@ /** - * @author aja + * Makes user settings available for other classes so that they don't + * need to deal with properties directly, calling PreferencesManager's + * methods instead. + * <p> + * An instance of this class keeps values of the various settings and makes them + * availabe through getter methods. The settings are also stored as jEdit + * properties (see {@link jEdit#setProperty}). To change a setting, modify the + * appropriate jEdit property and call aPreferencesManager.{@link #optionsChanged()}. + * </p><p> + * Most settings can be changed via the menu Plugins > Plugins Options... > + * TextAutocomplete. See {@link TextAutocompletePane}. + * </p> * + * @author Jakub Holy */ public class PreferencesManager { - + + /** Do not log anything but errors and warnings. */ + static final int LOG_NONE = 0; + + /** Log only AT_END events */ + static final int LOG_WORD = 1; + + /** Log all events. */ + static final int LOG_ALL = 2; + /** Single instance */ private static PreferencesManager thePreferencesManager = null; - + /** Precompiled BeanShell codes for some of the methods. */ BshMethod[] cachedCodes = new BshMethod[]{null, null}; /** Index into the array cachedCodes. */ @@ -40,10 +62,10 @@ int IS_WORD_TO_REMEMBER = 1; //** Index into the array cachedCodes. */ //int IS_WORD_ELEMENT = 2; - + /** NameSpace used to pass parameters to the BeanShell snippets. */ NameSpace bsNameSpace = new NameSpace(BeanShell.getNameSpace(), "PreferencesManager"); - + /** List of keys used to accept the selected completion. */ List acceptKeys = null; List disposeKeys = null; @@ -53,72 +75,72 @@ ///////////////////////////////////////////////////////////////////////////////////// // getPreferencesManager {{{ /** Create a new Pref.Manager or return the existing one if exists. */ - synchronized public static PreferencesManager + synchronized public static PreferencesManager getPreferencesManager() { if ( thePreferencesManager == null ) { thePreferencesManager = new PreferencesManager(); } return thePreferencesManager; } // }}} getPreferencesManager - + // getPreferencesManager {{{ /* * Destroy (forget) the existing Pref.Manager. if there is one. * / - synchronized public static void + synchronized public static void unsetPreferencesManager() { thePreferencesManager = null; } // }}} getPreferencesManager */ - + /** Create the PrefMngr and read saved options. Private; other use getPreferencesManager(). */ - private PreferencesManager() + private PreferencesManager() { optionsChanged(); } ///////////////////////////////////////////////////////////////////////////////////// // getPreferencesManager {{{ /** Called to notify the PreferencesManager that preferences have changed. */ - synchronized public void + synchronized public void optionsChanged() { - // Reset cached blocks of code - for (int i = 0; i < this.cachedCodes.length; i++) + // Reset cached blocks of code + for (int i = 0; i < this.cachedCodes.length; i++) { cachedCodes[i] = null; } - + // Precompile and cache the codes; precompileCode notifies the user of any error String code = null; code = jEdit.getProperty(TextAutocompletePlugin.PROPS_PREFIX + "isWord-code"); precompileCode(code, "isWord", IS_WORD); code = jEdit.getProperty(TextAutocompletePlugin.PROPS_PREFIX + "isWordToRemember-code"); precompileCode( code, "isWordToRemember", IS_WORD_TO_REMEMBER); - + // (Re)set key codes - acceptKeys = propertyToKeyCodes(TextAutocompletePlugin.PROPS_PREFIX + "acceptKey"); + acceptKeys = propertyToKeyCodes(TextAutocompletePlugin.PROPS_PREFIX + "acceptKey"); disposeKeys = propertyToKeyCodes(TextAutocompletePlugin.PROPS_PREFIX + "disposeKey"); selectionUpKeys = propertyToKeyCodes(TextAutocompletePlugin.PROPS_PREFIX + "selectionUpKey"); selectionDownKeys = propertyToKeyCodes(TextAutocompletePlugin.PROPS_PREFIX + "selectionDownKey"); } // }}} getPreferencesManager - + ///////////////////////////////////////////////////////////////////////////////////// - // isWordFilter + // isWordFilter ///////////////////////////////////////////////////////////////////////////////////// /** Used to check whether an insertion appended to a word is still a word. */ protected Filter isWordFilter = new Filter() { /** Return true if the insertion appended to the word is still a word (to remember/to complete...). */ - public boolean + public boolean accept(StringBuffer word, char insertion) { if(word == null) { word = new StringBuffer();} - + final int cachedCodeIndex = IS_WORD; if(cachedCodes[cachedCodeIndex] != null) { - try - { - bsNameSpace.setTypedVariable("prefix", String.class, word.toString(), null); + try + { + bsNameSpace.setTypedVariable("prefix", String.class, word.toString(), null); bsNameSpace.setTypedVariable("insertion", Character.class, new Character(insertion), null); } catch (UtilEvalError e) { throw new RuntimeException(e); } - + boolean isWord = executeCachedCode("isWord", cachedCodeIndex, bsNameSpace); bsNameSpace.unsetVariable("prefix"); // clean up for better robustness bsNameSpace.unsetVariable("insertion"); @@ -128,27 +150,27 @@ { return Character.isLetter( insertion ); } } }; - + ///////////////////////////////////////////////////////////////////////////////////// - // METHODS + // METHODS ///////////////////////////////////////////////////////////////////////////////////// - + /////////////////////////////////////////////////////////////////// // {{{ isWordElement - /* * - * Return true if the character is a letter or digit or is not word separator (is e.g. '_') + /* * + * Return true if the character is a letter or digit or is not word separator (is e.g. '_') * Modify this function to change what is considered to be a part of a word. * / - public boolean + public boolean isWordElement( char ch ) { String code = jEdit.getProperty(TextAutocompletePlugin.PROPS_PREFIX + "isWordElement-code"); if(code != null) { - try + try { bsNameSpace.setTypedVariable("character", Character.class, new Character(ch), null); } catch (UtilEvalError e) { throw new RuntimeException(e); } - return evaluateCode(code, "isWordElement", IS_WORD_ELEMENT, bsNameSpace); + return evaluateCode(code, "isWordElement", IS_WORD_ELEMENT, bsNameSpace); } else { @@ -157,24 +179,24 @@ } } // isWordElement }}} */ - - /** + + /** * Checker that determines what is a word separator and what is not. * The filter's method boolean accept(StringBuffer word, char insertion) - * is used for that. + * is used for that. */ - public Filter getIsWordFilter() { + public Filter getIsWordFilter() { return this.isWordFilter; } - + // {{{ minPrefixLength - /** + /** * Return the minimal length the word being typed must have for the list of completions - * to be displayed. At least minPrefixLength characters must be typed before the pop-up + * to be displayed. At least minPrefixLength characters must be typed before the pop-up * window appears. * It can be set to any value >= 1. */ - public int + public int minPrefixLength() { return jEdit.getIntegerProperty(TextAutocompletePlugin.PROPS_PREFIX + "minPrefixLength", 2); } // minPrefixLength }}} @@ -189,10 +211,10 @@ { if(acceptKeys != null) { return acceptKeys.contains(new Integer( evt.getKeyCode() )); } - else + else { return (evt.getKeyCode() == KeyEvent.VK_TAB) || (evt.getKeyCode() == KeyEvent.VK_ENTER); } } // isAcceptKey }}} - + ///////////////////////////////////////////////////////////////////////////////////// // {{{ isDisposeKey /** Return true for keys used to dispose (hide) the popup window. */ @@ -201,10 +223,10 @@ { if(disposeKeys != null) { return disposeKeys.contains(new Integer( evt.getKeyCode() )); } - else + else { return evt.getKeyCode() == KeyEvent.VK_ESCAPE; } } // isDisposeKey }}} - + ///////////////////////////////////////////////////////////////////////////////////// // {{{ isSelectionUpKey /** Return true for keys used to move up in the popup list of completitions. */ @@ -213,11 +235,11 @@ { if(selectionUpKeys != null) { return selectionUpKeys.contains(new Integer( evt.getKeyCode() )); } - else + else { return evt.getKeyCode() == KeyEvent.VK_UP; } - + } // isSelectionUpKey }}} - + ///////////////////////////////////////////////////////////////////////////////////// // {{{ isSelectionDownKey /** Return true for keys used to move down in the popup list of completitions. */ @@ -226,13 +248,13 @@ { if(selectionDownKeys != null) { return selectionDownKeys.contains(new Integer( evt.getKeyCode() )); } - else + else { return evt.getKeyCode() == KeyEvent.VK_DOWN; } } // isSelectionDownKey }}} - + ///////////////////////////////////////////////////////////////////////////////////// // COMPLETION WORDS LIST - // + // ///////////////////////////////////////////////////////////////////////////////////// // {{{ isWordToRemember /** Return true if the word shall be rememberd i.e. added to the completion word list. */ @@ -243,59 +265,72 @@ final int cachedCodeIndex = IS_WORD_TO_REMEMBER; if(cachedCodes[cachedCodeIndex] != null) { - try + try { bsNameSpace.setTypedVariable("word", String.class, word.toString(), null); } catch (UtilEvalError e) { throw new RuntimeException(e); } - + doRemember = executeCachedCode("isWordToRemember", cachedCodeIndex, bsNameSpace); bsNameSpace.unsetVariable("word"); } - + // Check length if the word has been accepted so far if(doRemember) { return word.length() >= jEdit.getIntegerProperty(TextAutocompletePlugin.PROPS_PREFIX + "minWordToRememberLength", 5); } else { return false; } } // isWordToRemember }}} - + ///////////////////////////////////////////////////////////////////////////////////// // {{{ getMaxCountOfWords - /** + /** * The maximal number of words that we do remeber for a given buffer. - * Additional words that would otherwise be remembered are ignored. + * Additional words that would otherwise be remembered are ignored. */ public int getMaxCountOfWords() - { return jEdit.getIntegerProperty(TextAutocompletePlugin.PROPS_PREFIX + "maxCountOfWords", 1000); } + { return jEdit.getIntegerProperty(TextAutocompletePlugin.PROPS_PREFIX + "maxCountOfWords", 1000); } // getMaxCountOfWords }}} - + ///////////////////////////////////////////////////////////////////////////////////// // {{{ isStartForBuffers - /** - * True if the autocompletion should be started automatically for + /** + * True if the autocompletion should be started automatically for * new buffers. * TODO: Make it possible to start only for buffers matching some condition * (edit mode, file name extension, ...) */ public boolean isStartForBuffers() - { return jEdit.getBooleanProperty(TextAutocompletePlugin.PROPS_PREFIX + "isStartForBuffers", false); } + { return jEdit.getBooleanProperty(TextAutocompletePlugin.PROPS_PREFIX + "isStartForBuffers", false); } // getMaxCountOfWords }}} - - + + ///////////////////////////////////////////////////////////////////////////////////// + // {{{ getLogLevel + /** + * True if the autocompletion should be started automatically for + * new buffers. + * TODO: Make it possible to start only for buffers matching some condition + * (edit mode, file name extension, ...) + */ + public int + getLogLevel() + { return jEdit.getIntegerProperty(TextAutocompletePlugin.PROPS_PREFIX + "logLevel", LOG_NONE); } + // getLogLevel }}} + + ///////////////////////////////////////////////////////////////////////////////////// /** - * Read a list of keys from the given property and return a list of their key codes. - * @param propertyName Name of the plugin's property that contains a list of names of + * Read a list of keys from the given property and return a list of their key codes. + * @param propertyName Name of the plugin's property that contains a list of names of * KeyEvent's constants separated by a space or a comma. Ex.: "VK_ESCAPE VK_ENTER". - * @return List of Integers holding key codes of the keys or null if the property isn't + * @return List of Integers holding key codes of the keys or null if the property isn't * set or contains no valid keys. * @see KeyEvent */ - private java.util.ArrayList - propertyToKeyCodes(String propertyName) + private java.util.ArrayList + propertyToKeyCodes(String propertyName) { java.util.ArrayList keyCodes = null; String acceptkeysProp = jEdit.getProperty(propertyName); @@ -308,39 +343,102 @@ { // Get the Field corresponding to the given constant name String tokenValue = token.nextToken(); - try + try { key = KeyEvent.class.getDeclaredField(tokenValue); } // does a constant of the given name exist? catch (SecurityException e) { throw new RuntimeException(e); } - catch (NoSuchFieldException e) + catch (NoSuchFieldException e) { - GUIUtilities.error(null, TextAutocompletePlugin.PROPS_PREFIX + "errorMessage", - new Object[]{ "Invalid key '"+tokenValue+"' in the property " + propertyName }); + GUIUtilities.error(null, TextAutocompletePlugin.PROPS_PREFIX + "errorMessage", + new Object[]{ "Invalid key '"+tokenValue+"' in the property " + propertyName }); continue; // go to the next token (key) } - + // Store the Field's value for later use - try + try { keyCodes.add(new Integer( key.getInt(KeyEvent.class) )); } - catch (IllegalArgumentException e) + catch (IllegalArgumentException e) {} // this cannot occur - catch (IllegalAccessException e) + catch (IllegalAccessException e) {} // this cannot occur - + } // while more keys - + // If no (valid) keys => use the default if(keyCodes.size() == 0) { keyCodes = null; } } return keyCodes; } - + + /** + * Do we allow to select an entry in the completion popup by typing its + * number? + * <p> + * Returnes true by default. The corrseponding property is + * {@link TextAutocompletePlugin#PROPS_PREFIX} + "isSelectionByNumberEnabled". + * </P> + * + * @return True if a number key selects an entry in the completion popup win., + * false if the number should be just inserted into the buffer. + */ + public boolean isSelectionByNumberEnabled() + { return jEdit.getBooleanProperty(TextAutocompletePlugin.PROPS_PREFIX + "isSelectionByNumberEnabled", true); } + + /** + * Returns the mask for the special key that must be pressed together with a number N + * to select the Nth completion in the popup. Returns 0 if no modifier key + * is required and the number on itself selects the entry. + * <p>The corresponding property is {@link TextAutocompletePlugin#PROPS_PREFIX} + 'selectionByNumberModifierMask'.</p> + * <p> + * Valid values: InputEvent.CTRL_MASK, InputEvent.ALT_MASK, InputEvent.ALT_GRAPH_MASK. + * </p> + * + * @return 0 = no modifier [default] or a mask defined in {@link InputEvent} such as + * {@link InputEvent#CTRL_DOWN_MASK}. + */ + public int getSelectionByNumberModifier() { + return jEdit.getIntegerProperty( + TextAutocompletePlugin.PROPS_PREFIX + "selectionByNumberModifierMask", + 0); + } + //////////////////////////////////////////////////////////////////////////// + + /** + * Set the String jEdit property named {@link TextAutocompletePlugin#PROPS_PREFIX} + 'name' + * to the value 'value'. + */ + public void setProperty(String name, String value) + { + jEdit.setProperty(TextAutocompletePlugin.PROPS_PREFIX + name, value); + optionsChanged(); + } + + /** + * Set the boolean jEdit property named {@link TextAutocompletePlugin#PROPS_PREFIX} + 'name' + * to the value 'value'. + */ + public void setBooleanProperty(String name, boolean value) + { + jEdit.setBooleanProperty(TextAutocompletePlugin.PROPS_PREFIX + name, value); + optionsChanged(); + } + + /** + * Set the int jEdit property named {@link TextAutocompletePlugin#PROPS_PREFIX} + 'name' + * to the value 'value'. + */ + public void setIntegerProperty(String name, int value) + { + jEdit.setIntegerProperty(TextAutocompletePlugin.PROPS_PREFIX + name, value); + optionsChanged(); + } + //////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Evaluate the BeanShell code and return its return value. Show an error dialog if - * its return value doesn't evaluate to a boolean and clear the cached code to prevent + * Evaluate the BeanShell code and return its return value. Show an error dialog if + * its return value doesn't evaluate to a boolean and clear the cached code to prevent * repetitions of this error. * Warning: cachedCodes[cachedCodeIndex] must not be null. * @param codeName A name identifying the code such as "isWordElement" - used in an error message. @@ -348,15 +446,15 @@ * @param nameSpace NameSpace containing arguments for the code to be invoked. * @return Return value of the code */ - private boolean - executeCachedCode(String codeName, int cachedCodeIndex, NameSpace nameSpace) + private boolean + executeCachedCode(String codeName, int cachedCodeIndex, NameSpace nameSpace) { - - try + + try { Object retVal = BeanShell.runCachedBlock(cachedCodes[cachedCodeIndex], null, nameSpace); - - if (retVal instanceof Boolean) + + if (retVal instanceof Boolean) { return ((Boolean) retVal).booleanValue(); } else { @@ -366,7 +464,7 @@ Log.log(Log.ERROR, TextAutocompletePlugin.class, msg); throw new IllegalArgumentException(msg); } - + } catch(Throwable e) { @@ -376,54 +474,54 @@ return false; } } - + /** * Try to precompile and cache the BeanShell code. The result is stored into {@link #cachedCodes}. - * If the compilation fails, a graphical notification is presented to the user. + * If the compilation fails, a graphical notification is presented to the user. * @param code The code to compile - if null or empty, nothing is done * @param codeName Calling method and code name such as "isWordElement". Must be valid java identifier. * @param cachedCodeIndex One of IS_WORD, IS_WORD_ELEMENT, ... * @return True if the code has been compiled */ - private boolean + private boolean precompileCode(String code, String codeName, int cachedCodeIndex) { // Make sure that tha code ends with ';' == that it is a valid java statement if(code == null || code.trim().length() == 0) { return false; } - + code = sanitizeCode(code); - - try + + try { - if (cachedCodes[cachedCodeIndex] == null) + if (cachedCodes[cachedCodeIndex] == null) { cachedCodes[cachedCodeIndex] = BeanShell.cacheBlock( "textautocomplete_" + codeName, code, true); } - } - catch (Exception e) + } + catch (Exception e) { String msg = "PreferencesManager: Failed to precompile BeanShell code for '" + codeName + "';"; Log.log(Log.ERROR, TextAutocompletePlugin.class, msg + " cause: " + e); - GUIUtilities.error(null, TextAutocompletePlugin.PROPS_PREFIX + "errorMessage", + GUIUtilities.error(null, TextAutocompletePlugin.PROPS_PREFIX + "errorMessage", new Object[]{ msg + "\nCause:" + e }); return false; } - + return true; } /** Make sure that the code ends with ';' i.e. that it is a valid java statement */ - public static String - sanitizeCode(final String code) + public static String + sanitizeCode(final String code) { String sanitizedCode = code.trim(); if( !sanitizedCode.endsWith(";") && !sanitizedCode.endsWith("}") ) { sanitizedCode += ";"; } return sanitizedCode; } - + ///////////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////////// |