AutomatedIndenting support class provides regex-based
+ automatic re-indentation of lines as user types. This is a replacement for
+ the deprecated ExtFormatter.getReformatBlock and INDENT_HOT_CHARS_ACCEPTOR
+ setting.
+ int Indent.indentNewLine(int) was added as
+ a replacement for the old int Formatter.indentNewLine(BaseDocument, int).
+ offset and reindents it.
+ *
+ * This method will insert a line break (ie EOL character) at the specified + * offset and then reindent the newly created line. The method will return the + * offset of the indented beginning of the new line. That is the offset where + * the new text should appear when typing in the document. + * + * @param offset The document offset where the new line will be created. + * + * @return The offset of the first non-white character (or the EOL character) + * on the new line. This is basically where the caret should be moved to. + * @throws javax.swing.text.BadLocationException + * @since 1.10 + */ + public int indentNewLine(int offset) throws BadLocationException { + return impl.reindent(offset, offset, offset, true); + } + } --- a/editor.indent/src/org/netbeans/modules/editor/indent/spi/support/AutomatedIndenting.java +++ a/editor.indent/src/org/netbeans/modules/editor/indent/spi/support/AutomatedIndenting.java @@ -0,0 +1,238 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2008 Sun Microsystems, Inc. All rights reserved. + * + * The contents of this file are subject to the terms of either the GNU + * General Public License Version 2 only ("GPL") or the Common + * Development and Distribution License("CDDL") (collectively, the + * "License"). You may not use this file except in compliance with the + * License. You can obtain a copy of the License at + * http://www.netbeans.org/cddl-gplv2.html + * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the + * specific language governing permissions and limitations under the + * License. When distributing the software, include this License Header + * Notice in each file and include the License file at + * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun in the GPL Version 2 section of the License file that + * accompanied this code. If applicable, add the following below the + * License Header, with the fields enclosed by brackets [] replaced by + * your own identifying information: + * "Portions Copyrighted [year] [name of copyright owner]" + * + * If you wish your version of this file to be governed by only the CDDL + * or only the GPL Version 2, indicate your decision by adding + * "[Contributor] elects to include this software in this distribution + * under the [CDDL or GPL Version 2] license." If you do not indicate a + * single choice of license, a recipient has the option to distribute + * your version of this file under either the CDDL, the GPL Version 2 or + * to extend the choice of license to its licensees as provided above. + * However, if you add GPL Version 2 code and therefore, elected the GPL + * Version 2 license, then the option applies only if the new code is + * made subject to such option by the copyright holder. + * + * Contributor(s): + * + * Portions Copyrighted 2008 Sun Microsystems, Inc. + */ + +package org.netbeans.modules.editor.indent.spi.support; + +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.Map; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; +import javax.swing.text.BadLocationException; +import javax.swing.text.Document; +import javax.swing.text.Element; +import org.netbeans.api.editor.mimelookup.MimePath; +import org.netbeans.lib.editor.util.swing.DocumentUtilities; +import org.netbeans.modules.editor.indent.api.Indent; +import org.netbeans.spi.editor.typinghooks.TypedTextInterceptor; + +/** + * This class contains factory methods for typing interceptor implementations + * that can be used for automated text indenting. + * + *
The interceptors provided by this class are implementations of Typing Hooks SPI
+ * interfaces that can be registered in MimeLookup. Typically there are
+ * two factory methods for each interceptor implementation. One factory method creates
+ * the implementated interceptor and is suitable for direct use from java code. The
+ * other factory method creates a factory object that can be registred in an XML layer
+ * as an .instance file.
+ *
+ * @author Vita Stejskal
+ * @since 1.11
+ */
+public final class AutomatedIndenting {
+
+ /**
+ * Creates TypedTextInterceptor that automatically
+ * indents a line depending on text typed on that line.
+ *
+ *
The text patterns recognized by the intercetor are defined in form
+ * of regular expressions passed to this method. The interceptor will match
+ * all text before the caret on the line where a user is typing (including
+ * the last typed character) against the regular expression patterns. If the text
+ * matches at least one pattern the interceptor will reindent the line by
+ * calling {@link Indent#reindent(int)} method.
+ *
+ * @param linePatterns The regular expressions that will be used for matching
+ * text typed on a line. Any matching pattern will trigger the line reindentation.
+ *
+ * @return The interceptor that checks text typed on a line and reindents the line
+ * if it matches any of the linePatterns.
+ *
+ * @since 1.11
+ */
+ public static TypedTextInterceptor createHotCharsIndenter(Pattern... linePatterns) {
+ return new RegExBasedIndenter(linePatterns);
+ }
+
+ /**
+ * This is a version of {@link #createHotCharsIndenter(java.util.regex.Pattern[])} method suitable
+ * for XML layers registration.
+ *
+ *
Here is an example of an XML layer registration done
+ * for text/x-java mime type. The registered interceptor will indent
+ * any line that contains whitespace followed by 'else'. The ending 'e' character is
+ * the last character typed on the line.
+ *
+ *
+ * <folder name="Editors"> + * <folder name="text"> + * <folder name="x-java"> + * <file name="org-something-AutoIndenter.instance"> + * <attr name="instanceOf" stringvalue="org.netbeans.spi.editor.typinghooks.TypedTextInterceptor"/> + * <attr name="instanceCreate" + * methodvalue="org.netbeans.modules.editor.indent.spi.support.AutomatedIndenting.createHotCharsIndenter"/> + * <attr name="regex1" stringvalue="\s*else"/> + * </file> + * </folder> + * </folder> + * </folder> + *+ *
FileObject attributes. This method
+ * will recognize any attributes, which name starts with regex and will
+ * try to interpret their value as a regular expression. These regular expressions
+ * will then be used as linePatterns when calling createHotCharsIndenter(Pattern...) method.
+ *
+ * @return The interceptor factory that will provide a regular expressions based
+ * automated indenter returned from the {@link #createHotCharsIndenter(java.util.regex.Pattern[])} method.
+ * The list of line patterns will be recovered from the fileAttributes.
+ *
+ * @since 1.11
+ */
+ public static TypedTextInterceptor.Factory createHotCharsIndenter(Map
+ The old formatting API (org.netbeans.editor.Formatter & co.)
+ has been deprecated and moved to editor.deprecated.pre65formatting module.
+
The exact API changes are listed in the sigtest report below.
++-sigtest-init: + [echo] sigtest check: editor.lib; cnb: org-netbeans-modules-editor-lib; email: api-changes@netbeans.org; type: check + +check-sigtest: + [mkdir] Created dir: /work/netbeans/main2m/editor.lib/build/test/sigtest/results + [sigtest] /work/netbeans/main2m/editor.lib/build/test/sigtest/results/org.netbeans.modules.editor.lib + [sigtest] Packages: org.netbeans.editor.*, org.netbeans.editor.ext.*, org.netbeans.editor.view.spi.*, org.netbeans.lib.editor.hyperlink.spi.*, org.netbeans.lib.editor.view.* + [sigtest] Missing /System/Library/Frameworks/JavaVM.framework/Versions/1.6.0/Home/lib/rt.jar + [sigtest] + [sigtest] email: api-changes@netbeans.org + [sigtest] SignatureTest report + [sigtest] Base version: 2.11.0 + [sigtest] Tested version: 2.11.0 + [sigtest] Check mode: bin [throws removed] + [sigtest] Constant checking: on + [sigtest] + [sigtest] + [sigtest] Class org.netbeans.editor.BaseDocument + [sigtest] "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getFormatter() + [sigtest] "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getLegacyFormatter() + [sigtest] + [sigtest] Class org.netbeans.editor.BaseKit + [sigtest] "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseKit.createFormatter() + [sigtest] + [sigtest] Class org.netbeans.editor.BaseKit$PasteAction + [sigtest] "E1.2 - API type removed" : method public static void org.netbeans.editor.BaseKit$PasteAction.indentBlock(org.netbeans.editor.BaseDocument,int,int) + [sigtest] + [sigtest] Class org.netbeans.editor.Formatter + [sigtest] "E1.2 - API type removed" : CLASS public org.netbeans.editor.Formatter + [sigtest] + [sigtest] Class org.netbeans.editor.GuardedDocument + [sigtest] "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getFormatter() + [sigtest] "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getLegacyFormatter() + [sigtest] + [sigtest] Class org.netbeans.editor.ext.AbstractFormatLayer + [sigtest] "E1.2 - API type removed" : CLASS public abstract org.netbeans.editor.ext.AbstractFormatLayer + [sigtest] + [sigtest] Class org.netbeans.editor.ext.ExtFormatSupport + [sigtest] "E1.2 - API type removed" : CLASS public org.netbeans.editor.ext.ExtFormatSupport + [sigtest] + [sigtest] Class org.netbeans.editor.ext.ExtFormatter + [sigtest] "E1.2 - API type removed" : CLASS public org.netbeans.editor.ext.ExtFormatter + [sigtest] + [sigtest] Class org.netbeans.editor.ext.ExtFormatter$Simple + [sigtest] "E1.2 - API type removed" : CLASS public static org.netbeans.editor.ext.ExtFormatter$Simple + [sigtest] + [sigtest] Class org.netbeans.editor.ext.ExtKit + [sigtest] "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseKit.createFormatter() + [sigtest] + [sigtest] Class org.netbeans.editor.ext.FormatLayer + [sigtest] "E1.2 - API type removed" : CLASS public abstract interface org.netbeans.editor.ext.FormatLayer + [sigtest] + [sigtest] Class org.netbeans.editor.ext.FormatSupport + [sigtest] "E1.2 - API type removed" : CLASS public org.netbeans.editor.ext.FormatSupport + [sigtest] + [sigtest] Class org.netbeans.editor.ext.FormatTokenPosition + [sigtest] "E1.2 - API type removed" : CLASS public abstract interface org.netbeans.editor.ext.FormatTokenPosition + [sigtest] + [sigtest] Class org.netbeans.editor.ext.FormatWriter + [sigtest] "E1.2 - API type removed" : CLASS public final org.netbeans.editor.ext.FormatWriter + [sigtest] + [sigtest] /work/netbeans/main2m/editor.lib/build/test/sigtest/results/org-netbeans-modules-editor-lib.xml: 1 failures in /work/netbeans/main2m/editor.lib/nbproject/org-netbeans-modules-editor-lib.sig + +BUILD FAILED +Signature tests return code is wrong (1), check the messages above ++
formatter.getSpacesPerTab().
*
* @see getTabSize()
- * @see Formatter.getSpacesPerTab()
+ * @deprecated Please use Editor Indentation API instead, for details see
+ * Editor Indentation.
*/
public int getShiftWidth() {
- if (shiftWidth != null) {
- return shiftWidth.intValue();
-
- } else {
- return getFormatter().getSpacesPerTab();
- }
+ return shiftWidth;
}
/**
--- a/editor.lib/src/org/netbeans/editor/BaseKit.java
+++ a/editor.lib/src/org/netbeans/editor/BaseKit.java
@@ -67,10 +67,8 @@
import javax.swing.text.ViewFactory;
import javax.swing.text.Caret;
import javax.swing.text.JTextComponent;
-import java.io.CharArrayWriter;
import java.lang.reflect.Method;
import java.util.Set;
-import java.util.Vector;
import java.util.WeakHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -87,14 +85,23 @@
import org.netbeans.api.editor.mimelookup.MimeLookup;
import org.netbeans.api.editor.mimelookup.MimePath;
import org.netbeans.api.editor.settings.KeyBindingSettings;
+import org.netbeans.api.editor.settings.SimpleValueNames;
+import org.netbeans.lib.editor.util.CharSequenceUtilities;
import org.netbeans.lib.editor.util.ListenerList;
import org.netbeans.lib.editor.util.swing.DocumentUtilities;
+import org.netbeans.modules.editor.indent.api.Indent;
+import org.netbeans.modules.editor.indent.api.IndentUtils;
+import org.netbeans.modules.editor.indent.api.Reformat;
+import org.netbeans.modules.editor.indent.spi.CodeStylePreferences;
import org.netbeans.modules.editor.lib2.EditorPreferencesDefaults;
import org.netbeans.modules.editor.lib2.EditorPreferencesKeys;
import org.netbeans.modules.editor.lib.KitsTracker;
import org.netbeans.modules.editor.lib.NavigationHistory;
import org.netbeans.modules.editor.lib.SettingsConversions;
import org.netbeans.modules.editor.lib2.highlighting.HighlightingManager;
+import org.netbeans.modules.editor.lib2.typinghooks.DeletedTextInterceptorsManager;
+import org.netbeans.modules.editor.lib2.typinghooks.TypedBreakInterceptorsManager;
+import org.netbeans.modules.editor.lib2.typinghooks.TypedTextInterceptorsManager;
import org.openide.awt.StatusDisplayer;
import org.openide.util.HelpCtx;
import org.openide.util.Lookup;
@@ -616,14 +623,15 @@
return new SyntaxSupport(doc);
}
- /**
- * Create the formatter appropriate for this kit
- * @deprecated Please use Editor Indentation API instead, for details see
- * Editor Indentation.
- */
- public Formatter createFormatter() {
- return new Formatter(this.getClass());
- }
+// XXX: formatting cleanup
+// /**
+// * Create the formatter appropriate for this kit
+// * @deprecated Please use Editor Indentation API instead, for details see
+// * Editor Indentation.
+// */
+// public Formatter createFormatter() {
+// return new Formatter(this.getClass());
+// }
/** Create text UI */
protected BaseTextUI createTextUI() {
@@ -1020,11 +1028,16 @@
- /** Default typed action */
+ /**
+ * Default typed action
+ *
+ * @deprecated Please do not subclass this class. Use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
// @EditorActionRegistration(name = defaultKeyTypedAction)
public static class DefaultKeyTypedAction extends LocalBaseAction {
- static final long serialVersionUID =3069164318144463899L;
+ static final long serialVersionUID = 3069164318144463899L;
public DefaultKeyTypedAction() {
// Construct with defaultKeyTypedAction name to retain full compatibility for extending actions
@@ -1033,8 +1046,6 @@
LOG.fine("DefaultKeyTypedAction with enhanced logging, see issue #145306"); //NOI18N
}
- private static final boolean isMac = System.getProperty("mrj.version") != null; //NOI18N
-
public void actionPerformed (final ActionEvent evt, final JTextComponent target) {
if ((target != null) && (evt != null)) {
@@ -1043,7 +1054,7 @@
boolean ctrl = ((mod & ActionEvent.CTRL_MASK) != 0);
// On the mac, norwegian and french keyboards use Alt to do bracket characters.
// This replicates Apple's modification DefaultEditorKit.DefaultKeyTypedAction
- boolean alt = isMac ? ((mod & ActionEvent.META_MASK) != 0) :
+ boolean alt = org.openide.util.Utilities.isMac() ? ((mod & ActionEvent.META_MASK) != 0) :
((mod & ActionEvent.ALT_MASK) != 0);
@@ -1057,67 +1068,50 @@
return;
}
- final Caret caret = target.getCaret();
- final BaseDocument doc = (BaseDocument)target.getDocument();
- final EditorUI editorUI = Utilities.getEditorUI(target);
// determine if typed char is valid
final String cmd = evt.getActionCommand();
- if ((cmd != null) && (cmd.length() == 1)) {
- // Utilities.clearStatusText(target);
+ if (cmd != null && cmd.length() == 1 && cmd.charAt(0) >= 0x20 && cmd.charAt(0) != 0x7F) {
+ if (LOG.isLoggable(Level.FINE)) {
+ LOG.log(Level.FINE, "Processing command char: {0}", Integer.toHexString(cmd.charAt(0))); //NOI18N
+ }
+ final BaseDocument doc = (BaseDocument)target.getDocument();
+ final int insertionOffset = computeInsertionOffset(target.getCaret());
+ final TypedTextInterceptorsManager.Transaction transaction = TypedTextInterceptorsManager.getInstance().openTransaction(
+ target, insertionOffset, cmd);
+
try {
- NavigationHistory.getEdits().markWaypoint(target, caret.getDot(), false, true);
- } catch (BadLocationException e) {
- LOG.log(Level.WARNING, "Can't add position to the history of edits.", e); //NOI18N
- }
-
- doc.runAtomicAsUser (new Runnable () {
- public void run () {
- DocumentUtilities.setTypingModification(doc, true);
- try {
- char ch = cmd.charAt(0);
- if ((ch >= 0x20) && (ch != 0x7F)) { // valid character
- LOG.fine("Processing command char: " + Integer.toHexString(ch)); //NOI18N
-
- editorUI.getWordMatch().clear(); // reset word matching
- Boolean overwriteMode = (Boolean)editorUI.getProperty(
- EditorUI.OVERWRITE_MODE_PROPERTY);
+ if (!transaction.beforeInsertion()) {
+ final Object [] result = new Object [] { Boolean.FALSE, "" }; //NOI18N
+ doc.runAtomicAsUser (new Runnable () {
+ public void run () {
+ Object [] r = transaction.textTyped();
+ String insertionText = r == null ? cmd : (String) r[0];
+ int caretPosition = r == null ? -1 : (Integer) r[1];
+
try {
- boolean doInsert = true; // editorUI.getAbbrev().checkAndExpand(ch, evt);
- if (doInsert) {
- if (Utilities.isSelectionShowing(caret)) { // valid selection
- boolean ovr = (overwriteMode != null && overwriteMode.booleanValue());
- try {
- doc.putProperty(DOC_REPLACE_SELECTION_PROPERTY, true);
- replaceSelection(target, caret.getDot(), caret, cmd, ovr);
- } finally {
- doc.putProperty(DOC_REPLACE_SELECTION_PROPERTY, null);
- }
- } else { // no selection
- int dotPos = caret.getDot();
- if (overwriteMode != null && overwriteMode.booleanValue()
- && dotPos < doc.getLength() && doc.getChars(dotPos, 1)[0] != '\n'
- ) { // overwrite current char
- insertString(doc, dotPos, caret, cmd, true);
- } else { // insert mode
- insertString(doc, dotPos, caret, cmd, false);
- }
- }
- }
- } catch (BadLocationException e) {
- LOG.log(Level.FINE, null, e);
+ performTextInsertion(target, insertionOffset, insertionText, caretPosition);
+ result[0] = Boolean.TRUE;
+ result[1] = insertionText;
+ } catch (BadLocationException ble) {
+ LOG.log(Level.FINE, null, ble);
target.getToolkit().beep();
}
- } else {
- LOG.fine("Invalid command char: " + Integer.toHexString(ch)); //NOI18N
}
+ });
+
+ if (((Boolean)result[0]).booleanValue()) {
+ transaction.afterInsertion();
- checkIndent(target, cmd);
- } finally {
- DocumentUtilities.setTypingModification(doc, false);
- }
+ // XXX: this is potentially wrong and we may need to call this with
+ // the original cmd; or maybe only if insertionText == cmd; but maybe
+ // it does not matter, because nobody seems to be overwriting this method anyway
+ checkIndent(target, (String)result[1]);
+ } // else text insertion failed
}
- });
+ } finally {
+ transaction.close();
+ }
} else {
if (LOG.isLoggable(Level.FINE)) {
StringBuilder sb = new StringBuilder();
@@ -1128,54 +1122,127 @@
sb.append(" ");
}
}
- LOG.fine("Invalid command: '" + sb + "'"); //NOI18N
+ LOG.log(Level.FINE, "Invalid command: {0}", sb); //NOI18N
}
}
}
}
- /**
- * Hook to insert the given string at the given position into
- * the given document in insert-mode, no selection, writeable
- * document. Designed to be overridden by subclasses that want
- * to intercept inserted characters.
- */
- protected void insertString(BaseDocument doc,
+ // --------------------------------------------------------------------
+ // SPI
+ // --------------------------------------------------------------------
+
+ /**
+ * Hook to insert the given string at the given position into
+ * the given document in insert-mode, no selection, writeable
+ * document. Designed to be overridden by subclasses that want
+ * to intercept inserted characters.
+ *
+ * @deprecated Please use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
+ protected void insertString(BaseDocument doc,
int dotPos,
Caret caret,
String str,
- boolean overwrite)
- throws BadLocationException
- {
- if (overwrite) doc.remove(dotPos, 1);
- doc.insertString(dotPos, str, null);
- }
+ boolean overwrite) throws BadLocationException
+ {
+ if (overwrite) {
+ doc.remove(dotPos, 1);
+ }
+
+ doc.insertString(dotPos, str, null);
+ }
- /**
- * Hook to insert the given string at the given position into
- * the given document in insert-mode with selection visible
- * Designed to be overridden by subclasses that want
- * to intercept inserted characters.
- */
- protected void replaceSelection(JTextComponent target,
- int dotPos,
- Caret caret,
- String str,
- boolean overwrite)
- throws BadLocationException
- {
- target.replaceSelection(str);
- }
+ /**
+ * Hook to insert the given string at the given position into
+ * the given document in insert-mode with selection visible
+ * Designed to be overridden by subclasses that want
+ * to intercept inserted characters.
+ *
+ * @deprecated Please use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
+ protected void replaceSelection(
+ JTextComponent target,
+ int dotPos,
+ Caret caret,
+ String str,
+ boolean overwrite) throws BadLocationException
+ {
+ target.replaceSelection(str);
+ }
-
- /** Check whether there was any important character typed
- * so that the line should be possibly reformatted.
- */
+ /**
+ * Check whether there was any important character typed
+ * so that the line should be possibly reformatted.
+ *
+ * @deprecated Please use AutomatedIndentig
+ * or Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
protected void checkIndent(JTextComponent target, String typedText) {
}
- }
+ // --------------------------------------------------------------------
+ // Private implementation
+ // --------------------------------------------------------------------
+ private void performTextInsertion(JTextComponent target, int insertionOffset, String insertionText, int caretPosition) throws BadLocationException {
+ final BaseDocument doc = (BaseDocument)target.getDocument();
+
+ try {
+ NavigationHistory.getEdits().markWaypoint(target, insertionOffset, false, true);
+ } catch (BadLocationException e) {
+ LOG.log(Level.WARNING, "Can't add position to the history of edits.", e); //NOI18N
+ }
+
+ DocumentUtilities.setTypingModification(doc, true);
+ try {
+ EditorUI editorUI = Utilities.getEditorUI(target);
+ Caret caret = target.getCaret();
+
+ editorUI.getWordMatch().clear(); // reset word matching
+ Boolean overwriteMode = (Boolean)editorUI.getProperty(EditorUI.OVERWRITE_MODE_PROPERTY);
+ boolean ovr = (overwriteMode != null && overwriteMode.booleanValue());
+ if (Utilities.isSelectionShowing(caret)) { // valid selection
+ try {
+ doc.putProperty(DOC_REPLACE_SELECTION_PROPERTY, true);
+ replaceSelection(target, insertionOffset, caret, insertionText, ovr);
+ } finally {
+ doc.putProperty(DOC_REPLACE_SELECTION_PROPERTY, null);
+ }
+ } else { // no selection
+ if (ovr && insertionOffset < doc.getLength() && doc.getChars(insertionOffset, 1)[0] != '\n') { //NOI18N
+ // overwrite current char
+ insertString(doc, insertionOffset, caret, insertionText, true);
+ } else { // insert mode
+ insertString(doc, insertionOffset, caret, insertionText, false);
+ }
+ }
+
+ if (caretPosition != -1) {
+ assert caretPosition >= 0 && caretPosition < insertionText.length();
+ caret.setDot(insertionOffset + caretPosition);
+ }
+ } finally {
+ DocumentUtilities.setTypingModification(doc, false);
+ }
+ }
+
+ private int computeInsertionOffset(Caret caret) {
+ if (Utilities.isSelectionShowing(caret)) {
+ return Math.min(caret.getMark(), caret.getDot());
+ } else {
+ return caret.getDot();
+ }
+ }
+ } // End of DefaultKeyTypedAction class
+
+ /**
+ * @deprecated Please do not subclass this class. Use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
public static class InsertBreakAction extends LocalBaseAction {
static final long serialVersionUID =7966576342334158659L;
@@ -1192,51 +1259,140 @@
}
final BaseDocument doc = (BaseDocument)target.getDocument();
- final Formatter formatter = doc.getFormatter();
- formatter.indentLock();
+ final int insertionOffset = computeInsertionOffset(target.getCaret());
+ final TypedBreakInterceptorsManager.Transaction transaction = TypedBreakInterceptorsManager.getInstance().openTransaction(
+ target, insertionOffset, insertionOffset);
+
try {
- doc.runAtomicAsUser (new Runnable () {
- public void run () {
- DocumentUtilities.setTypingModification(doc, true);
- try {
- target.replaceSelection("");
- Caret caret = target.getCaret();
- Object cookie = beforeBreak(target, doc, caret);
+ if (!transaction.beforeInsertion()) {
+ final Boolean [] result = new Boolean [] { Boolean.FALSE }; //NOI18N
+ final Indent indenter = Indent.get(doc);
+ indenter.lock();
+ try {
+ doc.runAtomicAsUser (new Runnable () {
+ public void run () {
+ Object [] r = transaction.textTyped();
+ String insertionText = r == null ? "\n" : (String) r[0]; //NOI18N
+ int breakInsertPosition = r == null ? -1 : (Integer) r[1];
+ int caretPosition = r == null ? -1 : (Integer) r[2];
+ int [] reindentBlocks = r == null ? null : (int []) r[3];
- int dotPos = caret.getDot();
- int newDotPos = formatter.indentNewLine(doc, dotPos);
- caret.setDot(newDotPos);
-
- afterBreak(target, doc, caret, cookie);
- } finally {
- DocumentUtilities.setTypingModification(doc, false);
- }
+ try {
+ performLineBreakInsertion(target, insertionOffset, insertionText, breakInsertPosition, caretPosition, reindentBlocks, indenter);
+ result[0] = Boolean.TRUE;
+ } catch (BadLocationException ble) {
+ LOG.log(Level.FINE, null, ble);
+ target.getToolkit().beep();
+ }
+ }
+ });
+ } finally {
+ indenter.unlock();
}
- });
+
+ if (result[0].booleanValue()) {
+ transaction.afterInsertion();
+ } // else line-break insertion failed
+
+ }
} finally {
- formatter.indentUnlock();
+ transaction.close();
}
+
}
}
- /**
- * Hook called before any changes to the document. The value
- * returned is passed intact to the other hook.
- */
- protected Object beforeBreak(JTextComponent target, BaseDocument doc, Caret caret) {
- return null;
- }
+ // --------------------------------------------------------------------
+ // SPI
+ // --------------------------------------------------------------------
- /**
- * Hook called after the enter was inserted and cursor
- * repositioned. *data* is the object returned previously by
- * *beforeBreak* hook. By default null.
- */
- protected void afterBreak(JTextComponent target, BaseDocument doc, Caret caret, Object data) {
- }
- }
+ /**
+ * Hook called before any changes to the document. The value
+ * returned is passed intact to the other hook.
+ *
+ * @deprecated Please use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
+ protected Object beforeBreak(JTextComponent target, BaseDocument doc, Caret caret) {
+ return null;
+ }
- @EditorActionRegistration(name = splitLineAction)
+ /**
+ * Hook called after the enter was inserted and cursor
+ * repositioned.
+ *
+ * @param data the object returned from previously called
+ * {@link #beforeBreak(javax.swing.text.JTextComponent, org.netbeans.editor.BaseDocument, javax.swing.text.Caret)} hook.
+ * By default null.
+ *
+ * @deprecated Please use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
+ protected void afterBreak(JTextComponent target, BaseDocument doc, Caret caret, Object data) {
+ }
+
+ // --------------------------------------------------------------------
+ // Private implementation
+ // --------------------------------------------------------------------
+
+ private void performLineBreakInsertion(
+ JTextComponent target,
+ int insertionOffset,
+ String insertionText,
+ int breakInsertPosition,
+ int caretPosition,
+ int [] reindentBlocks,
+ Indent indenter) throws BadLocationException
+ {
+ BaseDocument doc = (BaseDocument) target.getDocument();
+ DocumentUtilities.setTypingModification(doc, true);
+ try {
+ target.replaceSelection(""); // NOI18N
+ Caret caret = target.getCaret();
+ Object cookie = beforeBreak(target, doc, caret);
+
+ // insert new line, caret moves to the new line
+ int dotPos = caret.getDot();
+ assert dotPos == insertionOffset : "dotPos=" + dotPos + " != " + "insertionOffset=" + insertionOffset; //NOI18N
+// doc.insertString(dotPos, "\n", null); //NOI18N
+// dotPos++;
+ doc.insertString(dotPos, insertionText, null);
+ dotPos += caretPosition != -1 ? caretPosition :
+ breakInsertPosition != -1 ? breakInsertPosition + 1 :
+ insertionText.indexOf('\n') + 1; //NOI18N
+
+ // reindent the new line
+ Position newDotPos = doc.createPosition(dotPos);
+ if (reindentBlocks != null && reindentBlocks.length > 0) {
+ for(int i = 0; i < reindentBlocks.length / 2; i++) {
+ int startOffset = insertionOffset + reindentBlocks[2 * i];
+ int endOffset = insertionOffset + reindentBlocks[2 * i + 1];
+ indenter.reindent(startOffset, endOffset);
+ }
+ } else {
+ indenter.reindent(dotPos);
+ }
+
+ // adjust the caret
+ caret.setDot(newDotPos.getOffset());
+
+ afterBreak(target, doc, caret, cookie);
+ } finally {
+ DocumentUtilities.setTypingModification(doc, false);
+ }
+ }
+
+ private int computeInsertionOffset(Caret caret) {
+ if (Utilities.isSelectionShowing(caret)) {
+ return Math.min(caret.getMark(), caret.getDot());
+ } else {
+ return caret.getDot();
+ }
+ }
+
+ } // End of InsertBreakAction class
+
+ @EditorActionRegistration(name = splitLineAction)
public static class SplitLineAction extends LocalBaseAction {
static final long serialVersionUID =7966576342334158659L;
@@ -1255,24 +1411,33 @@
final BaseDocument doc = (BaseDocument)target.getDocument();
final Caret caret = target.getCaret();
- final Formatter formatter = doc.getFormatter();
- formatter.indentLock();
+ final Indent formatter = Indent.get(doc);
+ formatter.lock();
try {
doc.runAtomicAsUser (new Runnable () {
public void run () {
DocumentUtilities.setTypingModification(doc, true);
try{
- target.replaceSelection("");
- final int dotPos = caret.getDot(); // dot stays where it was
- formatter.indentNewLine(doc, dotPos); // newline
+ target.replaceSelection(""); //NOI18N
+
+ // insert new line, caret stays where it is
+ int dotPos = caret.getDot();
+ doc.insertString(dotPos, "\n", null); //NOI18N
+
+ // reindent the new line
+ formatter.reindent(dotPos + 1); // newline
+
+ // make sure the caret stays on its original position
caret.setDot(dotPos);
+ } catch (BadLocationException ble) {
+ LOG.log(Level.WARNING, null, ble);
} finally {
DocumentUtilities.setTypingModification(doc, false);
}
}
});
} finally {
- formatter.indentUnlock();
+ formatter.unlock();
}
}
}
@@ -1300,12 +1465,10 @@
doc.runAtomicAsUser (new Runnable () {
public void run () {
DocumentUtilities.setTypingModification(doc, true);
- Formatter.pushFormattingContextDocument(doc);
try {
if (Utilities.isSelectionShowing(caret)) { // block selected
try {
- doc.getFormatter().changeBlockIndent(doc,
- target.getSelectionStart(), target.getSelectionEnd(), +1);
+ changeBlockIndent(doc, target.getSelectionStart(), target.getSelectionEnd(), +1);
} catch (GuardedException e) {
target.getToolkit().beep();
} catch (BadLocationException e) {
@@ -1341,7 +1504,7 @@
// Fix of #32240 - #1 of 2
int rowStart = Utilities.getRowStart(doc, dotPos);
- doc.getFormatter().changeRowIndent(doc, dotPos, indent);
+ changeRowIndent(doc, dotPos, indent);
// Fix of #32240 - #2 of 2
int newDotPos = doc.getOffsetFromVisCol(indent, rowStart);
@@ -1350,7 +1513,7 @@
}
} else { // already chars on the line
- doc.getFormatter().insertTabString(doc, dotPos);
+ insertTabString(doc, dotPos);
}
} catch (BadLocationException e) {
@@ -1358,7 +1521,6 @@
}
}
} finally {
- Formatter.popFormattingContextDocument(doc);
DocumentUtilities.setTypingModification(doc, false);
}
}
@@ -1507,7 +1669,10 @@
}
}
- /** Remove previous or next character */
+ /**
+ * @deprecated Please do not subclass this class. Use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
public static class DeleteCharAction extends LocalBaseAction {
protected boolean nextChar;
@@ -1531,44 +1696,90 @@
final int dot = caret.getDot();
final int mark = caret.getMark();
- doc.runAtomicAsUser (new Runnable () {
- public void run () {
- DocumentUtilities.setTypingModification(doc, true);
-
- try {
- if (dot != mark) { // remove selection
- doc.remove(Math.min(dot, mark), Math.abs(dot - mark));
- } else {
- if (nextChar) { // remove next char
- char ch = doc.getChars(dot, 1)[0];
- doc.remove(dot, 1);
- charDeleted(doc, dot, caret, ch);
- } else { // remove previous char
- char ch = doc.getChars(dot-1, 1)[0];
- doc.remove(dot - 1, 1);
- charBackspaced(doc, dot-1, caret, ch);
+ if (dot != mark) {
+ // remove selection
+ doc.runAtomicAsUser (new Runnable () {
+ public void run () {
+ DocumentUtilities.setTypingModification(doc, true);
+ try {
+ doc.remove(Math.min(dot, mark), Math.abs(dot - mark));
+ } catch (BadLocationException e) {
+ target.getToolkit().beep();
+ } finally {
+ DocumentUtilities.setTypingModification(doc, false);
}
}
- } catch (BadLocationException e) {
+ });
+ } else {
+ char [] removedChar = null;
+
+ try {
+ removedChar = nextChar ?
+ dot < doc.getLength() - 1 ? doc.getChars(dot, 1) : null :
+ dot > 0 ? doc.getChars(dot - 1, 1) : null;
+ } catch (BadLocationException ble) {
target.getToolkit().beep();
- } finally {
- DocumentUtilities.setTypingModification(doc, false);
}
+
+ if (removedChar != null) {
+ final String removedText = String.valueOf(removedChar);
+ final DeletedTextInterceptorsManager.Transaction t = DeletedTextInterceptorsManager.getInstance().openTransaction(target, dot, removedText, !nextChar);
+ try {
+ if (!t.beforeRemove()) {
+ final boolean [] result = new boolean [] { false };
+ doc.runAtomicAsUser (new Runnable () {
+ public void run () {
+ DocumentUtilities.setTypingModification(doc, true);
+ try {
+ if (nextChar) { // remove next char
+ doc.remove(dot, 1);
+ } else { // remove previous char
+ doc.remove(dot - 1, 1);
+ }
+
+ t.textDeleted();
+
+ if (nextChar) {
+ charDeleted(doc, dot, caret, removedText.charAt(0));
+ } else {
+ charBackspaced(doc, dot - 1, caret, removedText.charAt(0));
+ }
+
+ result[0] = true;
+ } catch (BadLocationException e) {
+ target.getToolkit().beep();
+ } finally {
+ DocumentUtilities.setTypingModification(doc, false);
+ }
+ }
+ });
+
+ if (result[0]) {
+ t.afterRemove();
+ }
+ }
+ } finally {
+ t.close();
+ }
}
- });
+ }
}
}
- protected void charBackspaced(BaseDocument doc, int dotPos, Caret caret, char ch)
- throws BadLocationException
- {
- }
-
- protected void charDeleted(BaseDocument doc, int dotPos, Caret caret, char ch)
- throws BadLocationException
- {
- }
- }
+ /**
+ * @deprecated Please use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
+ protected void charBackspaced(BaseDocument doc, int dotPos, Caret caret, char ch) throws BadLocationException {
+ }
+
+ /**
+ * @deprecated Please use Typing Hooks instead, for details see
+ * Editor Library 2.
+ */
+ protected void charDeleted(BaseDocument doc, int dotPos, Caret caret, char ch) throws BadLocationException {
+ }
+ } // End of DeleteCharAction class
/**
* @deprecated this action is no longer used. It is reimplemented in editor.actions module.
@@ -1734,10 +1945,10 @@
LOG.log(Level.WARNING, "Can't add position to the history of edits.", e); //NOI18N
}
- final Formatter formatter = doc.getFormatter();
+ final Reformat formatter = Reformat.get(doc);
final boolean formatted = pasteFormatedAction.equals(getValue(Action.NAME));
if (formatted) {
- formatter.reformatLock();
+ formatter.lock();
}
try {
doc.runAtomicAsUser (new Runnable () {
@@ -1758,7 +1969,7 @@
}
int endOffset = caret.getDot();
if (formatted) {
- formatter.reformat(doc, startOffset, endOffset);
+ formatter.reformat(startOffset, endOffset);
}
} catch (Exception e) {
target.getToolkit().beep();
@@ -1769,72 +1980,72 @@
});
} finally {
if (formatted) {
- formatter.reformatUnlock();
+ formatter.unlock();
}
}
}
}
- public static void indentBlock(BaseDocument doc, int startOffset, int endOffset)
- throws BadLocationException
- {
- char [] text = doc.getChars(startOffset, endOffset-startOffset);
- String [] lines = toLines(new String(text));
-
- doc.remove(startOffset, endOffset - startOffset);
- // System.out.println("Lines:\n"); // NOI18N
- // for (int j = 0 ; j < lines.length; j++) System.out.println(lines[j] + "<"); // NOI18N
-
- int offset = startOffset;
- // handle the full lines
- for (int i = 0; i < lines.length - 1; i++) {
- String indent = getIndentString(doc, offset, lines[i]);
- String fragment = indent + lines[i].trim() + '\n';
- // System.out.println(fragment + "|"); // NOI18N
- doc.insertString(offset, fragment, null);
- offset += fragment.length();
- }
-
- // the rest just paste without indenting
- doc.insertString(offset, lines[lines.length-1], null);
-
- }
-
- /** Break string to lines */
- private static String [] toLines(String str) {
- Vector v = new Vector();
- int p=0 , p0=0;
- for (; p < str.length() ; p++) {
- if (str.charAt(p) == '\n') {
- v.add(str.substring(p0, p+1));
- p0 = p+1;
- }
- }
- if (p0 < str.length()) v.add(str.substring(p0, str.length())); else v.add("");
-
- return (String [])v.toArray(new String [0]);
- }
-
- private static String getIndentString(BaseDocument doc, int startOffset, String str) {
- try {
- Formatter f = doc.getFormatter();
- CharArrayWriter cw = new CharArrayWriter();
- Writer w = f.createWriter(doc, startOffset, cw);
- w.write(str, 0, str.length());
- w.close();
- String out = new String(cw.toCharArray());
- int i = 0;
- for (; i < out.length(); i++) {
- if (out.charAt(i) != ' ' && out.charAt(i) != '\t') break;
- }
- // System.out.println(out+"|"); // NOI18N
- // System.out.println(out.substring(0,i)+"^"); // NOI18N
-
- return out.substring(0, i);
- } catch (java.io.IOException e) {
- return "";
- }
- }
+// public static void indentBlock(BaseDocument doc, int startOffset, int endOffset)
+// throws BadLocationException
+// {
+// char [] text = doc.getChars(startOffset, endOffset-startOffset);
+// String [] lines = toLines(new String(text));
+//
+// doc.remove(startOffset, endOffset - startOffset);
+// // System.out.println("Lines:\n"); // NOI18N
+// // for (int j = 0 ; j < lines.length; j++) System.out.println(lines[j] + "<"); // NOI18N
+//
+// int offset = startOffset;
+// // handle the full lines
+// for (int i = 0; i < lines.length - 1; i++) {
+// String indent = getIndentString(doc, offset, lines[i]);
+// String fragment = indent + lines[i].trim() + '\n';
+// // System.out.println(fragment + "|"); // NOI18N
+// doc.insertString(offset, fragment, null);
+// offset += fragment.length();
+// }
+//
+// // the rest just paste without indenting
+// doc.insertString(offset, lines[lines.length-1], null);
+//
+// }
+//
+// /** Break string to lines */
+// private static String [] toLines(String str) {
+// Vector v = new Vector();
+// int p=0 , p0=0;
+// for (; p < str.length() ; p++) {
+// if (str.charAt(p) == '\n') {
+// v.add(str.substring(p0, p+1));
+// p0 = p+1;
+// }
+// }
+// if (p0 < str.length()) v.add(str.substring(p0, str.length())); else v.add("");
+//
+// return (String [])v.toArray(new String [0]);
+// }
+//
+// private static String getIndentString(BaseDocument doc, int startOffset, String str) {
+// try {
+// Formatter f = doc.getFormatter();
+// CharArrayWriter cw = new CharArrayWriter();
+// Writer w = f.createWriter(doc, startOffset, cw);
+// w.write(str, 0, str.length());
+// w.close();
+// String out = new String(cw.toCharArray());
+// int i = 0;
+// for (; i < out.length(); i++) {
+// if (out.charAt(i) != ' ' && out.charAt(i) != '\t') break;
+// }
+// // System.out.println(out+"|"); // NOI18N
+// // System.out.println(out.substring(0,i)+"^"); // NOI18N
+//
+// return out.substring(0, i);
+// } catch (java.io.IOException e) {
+// return "";
+// }
+// }
}
@@ -2875,4 +3086,154 @@
}
+
+ /** Modify the line to move the text starting at dotPos one tab
+ * column to the right. Whitespace preceeding dotPos may be
+ * replaced by a TAB character if tabs expanding is on.
+ * @param doc document to operate on
+ * @param dotPos insertion point
+ */
+ static void insertTabString (final BaseDocument doc, final int dotPos) throws BadLocationException {
+ final BadLocationException[] badLocationExceptions = new BadLocationException [1];
+ doc.runAtomic (new Runnable () {
+ public void run () {
+ try {
+ // Determine first white char before dotPos
+ int rsPos = Utilities.getRowStart(doc, dotPos);
+ int startPos = Utilities.getFirstNonWhiteBwd(doc, dotPos, rsPos);
+ startPos = (startPos >= 0) ? (startPos + 1) : rsPos;
+
+ int startCol = Utilities.getVisualColumn(doc, startPos);
+ int endCol = Utilities.getNextTabColumn(doc, dotPos);
+ Preferences prefs = CodeStylePreferences.get(doc).getPreferences();
+ String tabStr = Analyzer.getWhitespaceString(
+ startCol, endCol,
+ prefs.getBoolean(SimpleValueNames.EXPAND_TABS, EditorPreferencesDefaults.defaultExpandTabs),
+ prefs.getInt(SimpleValueNames.TAB_SIZE, EditorPreferencesDefaults.defaultTabSize));
+
+ // Search for the first non-common char
+ char[] removeChars = doc.getChars(startPos, dotPos - startPos);
+ int ind = 0;
+ while (ind < removeChars.length && removeChars[ind] == tabStr.charAt(ind)) {
+ ind++;
+ }
+
+ startPos += ind;
+ doc.remove(startPos, dotPos - startPos);
+ doc.insertString(startPos, tabStr.substring(ind), null);
+ } catch (BadLocationException ex) {
+ badLocationExceptions [0] = ex;
+ }
+ }
+ });
+ if (badLocationExceptions[0] != null)
+ throw badLocationExceptions [0];
+ }
+
+ /** Change the indent of the given row. Document is atomically locked
+ * during this operation.
+ */
+ static void changeRowIndent (final BaseDocument doc, final int pos, final int newIndent) throws BadLocationException {
+ final BadLocationException[] badLocationExceptions = new BadLocationException [1];
+ doc.runAtomic (new Runnable () {
+ public void run () {
+ try {
+ int indent = newIndent < 0 ? 0 : newIndent;
+ int firstNW = Utilities.getRowFirstNonWhite(doc, pos);
+ if (firstNW == -1) { // valid first non-blank
+ firstNW = Utilities.getRowEnd(doc, pos);
+ }
+ int replacePos = Utilities.getRowStart(doc, pos);
+ int removeLen = firstNW - replacePos;
+ CharSequence removeText = DocumentUtilities.getText(doc, replacePos, removeLen);
+ String newIndentText = IndentUtils.createIndentString(doc, indent);
+ if (CharSequenceUtilities.startsWith(newIndentText, removeText)) {
+ // Skip removeLen chars at start
+ newIndentText = newIndentText.substring(removeLen);
+ replacePos += removeLen;
+ removeLen = 0;
+ } else if (CharSequenceUtilities.endsWith(newIndentText, removeText)) {
+ // Skip removeLen chars at the end
+ newIndentText = newIndentText.substring(0, newIndentText.length() - removeLen);
+ removeLen = 0;
+ }
+
+ if (removeLen != 0) {
+ doc.remove(replacePos, removeLen);
+ }
+
+ doc.insertString(replacePos, newIndentText, null);
+ } catch (BadLocationException ex) {
+ badLocationExceptions [0] = ex;
+ }
+ }
+ });
+ if (badLocationExceptions[0] != null)
+ throw badLocationExceptions [0];
+ }
+
+ /** Increase/decrease indentation of the block of the code. Document
+ * is atomically locked during the operation.
+ * @param doc document to operate on
+ * @param startPos starting line position
+ * @param endPos ending line position
+ * @param shiftCnt positive/negative count of shiftwidths by which indentation
+ * should be shifted right/left
+ */
+ static void changeBlockIndent (final BaseDocument doc, final int startPos, final int endPos,
+ final int shiftCnt) throws BadLocationException {
+ GuardedDocument gdoc = (doc instanceof GuardedDocument)
+ ? (GuardedDocument)doc : null;
+ if (gdoc != null){
+ for (int i = startPos; iDefaultKeyTypedAction,
+ InsertBreakAction, etc.
+ org.netbeans.spi.editor.highlighting package
- overview.
+ At the moment the Editor Library 2 module contains three distinct SPIs. Each SPI lives
+ in its own package and the usecases can be found in the packages overview.
+ TBD
+